1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""BzrDir logic. The BzrDir is the basic control directory used by bzr.
19
At format 7 this was split out into Branch, Repository and Checkout control
22
Note: This module has a lot of ``open`` functions/methods that return
23
references to in-memory objects. As a rule, there are no matching ``close``
24
methods. To free any associated resources, simply stop referencing the
28
# TODO: Move old formats into a plugin to make this file smaller.
33
from bzrlib.lazy_import import lazy_import
34
lazy_import(globals(), """
35
from stat import S_ISDIR
47
revision as _mod_revision,
57
from bzrlib.osutils import (
60
from bzrlib.smart.client import _SmartClient
61
from bzrlib.store.versioned import WeaveStore
62
from bzrlib.transactions import WriteTransaction
63
from bzrlib.transport import (
64
do_catching_redirections,
67
remote as remote_transport,
69
from bzrlib.weave import Weave
72
from bzrlib.trace import (
84
"""A .bzr control diretory.
86
BzrDir instances let you create or open any of the things that can be
87
found within .bzr - checkouts, branches and repositories.
90
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
92
a transport connected to the directory this bzr was opened from
93
(i.e. the parent directory holding the .bzr directory).
95
Everything in the bzrdir should have the same file permissions.
99
"""Invoke break_lock on the first object in the bzrdir.
101
If there is a tree, the tree is opened and break_lock() called.
102
Otherwise, branch is tried, and finally repository.
104
# XXX: This seems more like a UI function than something that really
105
# belongs in this class.
107
thing_to_unlock = self.open_workingtree()
108
except (errors.NotLocalUrl, errors.NoWorkingTree):
110
thing_to_unlock = self.open_branch()
111
except errors.NotBranchError:
113
thing_to_unlock = self.open_repository()
114
except errors.NoRepositoryPresent:
116
thing_to_unlock.break_lock()
118
def can_convert_format(self):
119
"""Return true if this bzrdir is one whose format we can convert from."""
122
def check_conversion_target(self, target_format):
123
target_repo_format = target_format.repository_format
124
source_repo_format = self._format.repository_format
125
source_repo_format.check_conversion_target(target_repo_format)
128
def _check_supported(format, allow_unsupported,
129
recommend_upgrade=True,
131
"""Give an error or warning on old formats.
133
:param format: may be any kind of format - workingtree, branch,
136
:param allow_unsupported: If true, allow opening
137
formats that are strongly deprecated, and which may
138
have limited functionality.
140
:param recommend_upgrade: If true (default), warn
141
the user through the ui object that they may wish
142
to upgrade the object.
144
# TODO: perhaps move this into a base Format class; it's not BzrDir
145
# specific. mbp 20070323
146
if not allow_unsupported and not format.is_supported():
147
# see open_downlevel to open legacy branches.
148
raise errors.UnsupportedFormatError(format=format)
149
if recommend_upgrade \
150
and getattr(format, 'upgrade_recommended', False):
151
ui.ui_factory.recommend_upgrade(
152
format.get_format_description(),
155
def clone(self, url, revision_id=None, force_new_repo=False,
156
preserve_stacking=False):
157
"""Clone this bzrdir and its contents to url verbatim.
159
:param url: The url create the clone at. If url's last component does
160
not exist, it will be created.
161
:param revision_id: The tip revision-id to use for any branch or
162
working tree. If not None, then the clone operation may tune
163
itself to download less data.
164
:param force_new_repo: Do not use a shared repository for the target
165
even if one is available.
166
:param preserve_stacking: When cloning a stacked branch, stack the
167
new branch on top of the other branch's stacked-on branch.
169
return self.clone_on_transport(get_transport(url),
170
revision_id=revision_id,
171
force_new_repo=force_new_repo,
172
preserve_stacking=preserve_stacking)
174
def clone_on_transport(self, transport, revision_id=None,
175
force_new_repo=False, preserve_stacking=False,
177
"""Clone this bzrdir and its contents to transport verbatim.
179
:param transport: The transport for the location to produce the clone
180
at. If the target directory does not exist, it will be created.
181
:param revision_id: The tip revision-id to use for any branch or
182
working tree. If not None, then the clone operation may tune
183
itself to download less data.
184
:param force_new_repo: Do not use a shared repository for the target,
185
even if one is available.
186
:param preserve_stacking: When cloning a stacked branch, stack the
187
new branch on top of the other branch's stacked-on branch.
189
transport.ensure_base()
190
require_stacking = (stacked_on is not None)
191
format = self.cloning_metadir(require_stacking)
192
result = format.initialize_on_transport(transport)
193
repository_policy = None
195
local_repo = self.find_repository()
196
except errors.NoRepositoryPresent:
199
local_branch = self.open_branch()
200
except errors.NotBranchError:
203
# enable fallbacks when branch is not a branch reference
204
if local_branch.repository.has_same_location(local_repo):
205
local_repo = local_branch.repository
206
if preserve_stacking:
208
stacked_on = local_branch.get_stacked_on_url()
209
except (errors.UnstackableBranchFormat,
210
errors.UnstackableRepositoryFormat,
215
# may need to copy content in
216
repository_policy = result.determine_repository_policy(
217
force_new_repo, stacked_on, self.root_transport.base,
218
require_stacking=require_stacking)
219
make_working_trees = local_repo.make_working_trees()
220
result_repo = repository_policy.acquire_repository(
221
make_working_trees, local_repo.is_shared())
222
if not require_stacking and repository_policy._require_stacking:
223
require_stacking = True
224
result._format.require_stacking()
225
result_repo.fetch(local_repo, revision_id=revision_id)
228
# 1 if there is a branch present
229
# make sure its content is available in the target repository
231
if local_branch is not None:
232
result_branch = local_branch.clone(result, revision_id=revision_id,
233
repository_policy=repository_policy)
235
# Cheaper to check if the target is not local, than to try making
237
result.root_transport.local_abspath('.')
238
if result_repo is None or result_repo.make_working_trees():
239
self.open_workingtree().clone(result)
240
except (errors.NoWorkingTree, errors.NotLocalUrl):
244
# TODO: This should be given a Transport, and should chdir up; otherwise
245
# this will open a new connection.
246
def _make_tail(self, url):
247
t = get_transport(url)
251
def create(cls, base, format=None, possible_transports=None):
252
"""Create a new BzrDir at the url 'base'.
254
:param format: If supplied, the format of branch to create. If not
255
supplied, the default is used.
256
:param possible_transports: If supplied, a list of transports that
257
can be reused to share a remote connection.
259
if cls is not BzrDir:
260
raise AssertionError("BzrDir.create always creates the default"
261
" format, not one of %r" % cls)
262
t = get_transport(base, possible_transports)
265
format = BzrDirFormat.get_default_format()
266
return format.initialize_on_transport(t)
269
def find_bzrdirs(transport, evaluate=None, list_current=None):
270
"""Find bzrdirs recursively from current location.
272
This is intended primarily as a building block for more sophisticated
273
functionality, like finding trees under a directory, or finding
274
branches that use a given repository.
275
:param evaluate: An optional callable that yields recurse, value,
276
where recurse controls whether this bzrdir is recursed into
277
and value is the value to yield. By default, all bzrdirs
278
are recursed into, and the return value is the bzrdir.
279
:param list_current: if supplied, use this function to list the current
280
directory, instead of Transport.list_dir
281
:return: a generator of found bzrdirs, or whatever evaluate returns.
283
if list_current is None:
284
def list_current(transport):
285
return transport.list_dir('')
287
def evaluate(bzrdir):
290
pending = [transport]
291
while len(pending) > 0:
292
current_transport = pending.pop()
295
bzrdir = BzrDir.open_from_transport(current_transport)
296
except errors.NotBranchError:
299
recurse, value = evaluate(bzrdir)
302
subdirs = list_current(current_transport)
303
except errors.NoSuchFile:
306
for subdir in sorted(subdirs, reverse=True):
307
pending.append(current_transport.clone(subdir))
310
def find_branches(transport):
311
"""Find all branches under a transport.
313
This will find all branches below the transport, including branches
314
inside other branches. Where possible, it will use
315
Repository.find_branches.
317
To list all the branches that use a particular Repository, see
318
Repository.find_branches
320
def evaluate(bzrdir):
322
repository = bzrdir.open_repository()
323
except errors.NoRepositoryPresent:
326
return False, (None, repository)
328
branch = bzrdir.open_branch()
329
except errors.NotBranchError:
330
return True, (None, None)
332
return True, (branch, None)
334
for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
336
branches.extend(repo.find_branches())
337
if branch is not None:
338
branches.append(branch)
341
def destroy_repository(self):
342
"""Destroy the repository in this BzrDir"""
343
raise NotImplementedError(self.destroy_repository)
345
def create_branch(self):
346
"""Create a branch in this BzrDir.
348
The bzrdir's format will control what branch format is created.
349
For more control see BranchFormatXX.create(a_bzrdir).
351
raise NotImplementedError(self.create_branch)
353
def destroy_branch(self):
354
"""Destroy the branch in this BzrDir"""
355
raise NotImplementedError(self.destroy_branch)
358
def create_branch_and_repo(base, force_new_repo=False, format=None):
359
"""Create a new BzrDir, Branch and Repository at the url 'base'.
361
This will use the current default BzrDirFormat unless one is
362
specified, and use whatever
363
repository format that that uses via bzrdir.create_branch and
364
create_repository. If a shared repository is available that is used
367
The created Branch object is returned.
369
:param base: The URL to create the branch at.
370
:param force_new_repo: If True a new repository is always created.
371
:param format: If supplied, the format of branch to create. If not
372
supplied, the default is used.
374
bzrdir = BzrDir.create(base, format)
375
bzrdir._find_or_create_repository(force_new_repo)
376
return bzrdir.create_branch()
378
def determine_repository_policy(self, force_new_repo=False, stack_on=None,
379
stack_on_pwd=None, require_stacking=False):
380
"""Return an object representing a policy to use.
382
This controls whether a new repository is created, or a shared
383
repository used instead.
385
If stack_on is supplied, will not seek a containing shared repo.
387
:param force_new_repo: If True, require a new repository to be created.
388
:param stack_on: If supplied, the location to stack on. If not
389
supplied, a default_stack_on location may be used.
390
:param stack_on_pwd: If stack_on is relative, the location it is
393
def repository_policy(found_bzrdir):
396
config = found_bzrdir.get_config()
398
if config is not None:
399
stack_on = config.get_default_stack_on()
400
if stack_on is not None:
401
stack_on_pwd = found_bzrdir.root_transport.base
403
note('Using default stacking branch %s at %s', stack_on,
405
# does it have a repository ?
407
repository = found_bzrdir.open_repository()
408
except errors.NoRepositoryPresent:
411
if ((found_bzrdir.root_transport.base !=
412
self.root_transport.base) and not repository.is_shared()):
419
return UseExistingRepository(repository, stack_on,
420
stack_on_pwd, require_stacking=require_stacking), True
422
return CreateRepository(self, stack_on, stack_on_pwd,
423
require_stacking=require_stacking), True
425
if not force_new_repo:
427
policy = self._find_containing(repository_policy)
428
if policy is not None:
432
return UseExistingRepository(self.open_repository(),
433
stack_on, stack_on_pwd,
434
require_stacking=require_stacking)
435
except errors.NoRepositoryPresent:
437
return CreateRepository(self, stack_on, stack_on_pwd,
438
require_stacking=require_stacking)
440
def _find_or_create_repository(self, force_new_repo):
441
"""Create a new repository if needed, returning the repository."""
442
policy = self.determine_repository_policy(force_new_repo)
443
return policy.acquire_repository()
446
def create_branch_convenience(base, force_new_repo=False,
447
force_new_tree=None, format=None,
448
possible_transports=None):
449
"""Create a new BzrDir, Branch and Repository at the url 'base'.
451
This is a convenience function - it will use an existing repository
452
if possible, can be told explicitly whether to create a working tree or
455
This will use the current default BzrDirFormat unless one is
456
specified, and use whatever
457
repository format that that uses via bzrdir.create_branch and
458
create_repository. If a shared repository is available that is used
459
preferentially. Whatever repository is used, its tree creation policy
462
The created Branch object is returned.
463
If a working tree cannot be made due to base not being a file:// url,
464
no error is raised unless force_new_tree is True, in which case no
465
data is created on disk and NotLocalUrl is raised.
467
:param base: The URL to create the branch at.
468
:param force_new_repo: If True a new repository is always created.
469
:param force_new_tree: If True or False force creation of a tree or
470
prevent such creation respectively.
471
:param format: Override for the bzrdir format to create.
472
:param possible_transports: An optional reusable transports list.
475
# check for non local urls
476
t = get_transport(base, possible_transports)
477
if not isinstance(t, local.LocalTransport):
478
raise errors.NotLocalUrl(base)
479
bzrdir = BzrDir.create(base, format, possible_transports)
480
repo = bzrdir._find_or_create_repository(force_new_repo)
481
result = bzrdir.create_branch()
482
if force_new_tree or (repo.make_working_trees() and
483
force_new_tree is None):
485
bzrdir.create_workingtree()
486
except errors.NotLocalUrl:
491
def create_standalone_workingtree(base, format=None):
492
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
494
'base' must be a local path or a file:// url.
496
This will use the current default BzrDirFormat unless one is
497
specified, and use whatever
498
repository format that that uses for bzrdirformat.create_workingtree,
499
create_branch and create_repository.
501
:param format: Override for the bzrdir format to create.
502
:return: The WorkingTree object.
504
t = get_transport(base)
505
if not isinstance(t, local.LocalTransport):
506
raise errors.NotLocalUrl(base)
507
bzrdir = BzrDir.create_branch_and_repo(base,
509
format=format).bzrdir
510
return bzrdir.create_workingtree()
512
def create_workingtree(self, revision_id=None, from_branch=None,
513
accelerator_tree=None, hardlink=False):
514
"""Create a working tree at this BzrDir.
516
:param revision_id: create it as of this revision id.
517
:param from_branch: override bzrdir branch (for lightweight checkouts)
518
:param accelerator_tree: A tree which can be used for retrieving file
519
contents more quickly than the revision tree, i.e. a workingtree.
520
The revision tree will be used for cases where accelerator_tree's
521
content is different.
523
raise NotImplementedError(self.create_workingtree)
525
def backup_bzrdir(self):
526
"""Backup this bzr control directory.
528
:return: Tuple with old path name and new path name
530
pb = ui.ui_factory.nested_progress_bar()
532
# FIXME: bug 300001 -- the backup fails if the backup directory
533
# already exists, but it should instead either remove it or make
534
# a new backup directory.
536
# FIXME: bug 262450 -- the backup directory should have the same
537
# permissions as the .bzr directory (probably a bug in copy_tree)
538
old_path = self.root_transport.abspath('.bzr')
539
new_path = self.root_transport.abspath('backup.bzr')
540
pb.note('making backup of %s' % (old_path,))
541
pb.note(' to %s' % (new_path,))
542
self.root_transport.copy_tree('.bzr', 'backup.bzr')
543
return (old_path, new_path)
547
def retire_bzrdir(self, limit=10000):
548
"""Permanently disable the bzrdir.
550
This is done by renaming it to give the user some ability to recover
551
if there was a problem.
553
This will have horrible consequences if anyone has anything locked or
555
:param limit: number of times to retry
560
to_path = '.bzr.retired.%d' % i
561
self.root_transport.rename('.bzr', to_path)
562
note("renamed %s to %s"
563
% (self.root_transport.abspath('.bzr'), to_path))
565
except (errors.TransportError, IOError, errors.PathError):
572
def destroy_workingtree(self):
573
"""Destroy the working tree at this BzrDir.
575
Formats that do not support this may raise UnsupportedOperation.
577
raise NotImplementedError(self.destroy_workingtree)
579
def destroy_workingtree_metadata(self):
580
"""Destroy the control files for the working tree at this BzrDir.
582
The contents of working tree files are not affected.
583
Formats that do not support this may raise UnsupportedOperation.
585
raise NotImplementedError(self.destroy_workingtree_metadata)
587
def _find_containing(self, evaluate):
588
"""Find something in a containing control directory.
590
This method will scan containing control dirs, until it finds what
591
it is looking for, decides that it will never find it, or runs out
592
of containing control directories to check.
594
It is used to implement find_repository and
595
determine_repository_policy.
597
:param evaluate: A function returning (value, stop). If stop is True,
598
the value will be returned.
602
result, stop = evaluate(found_bzrdir)
605
next_transport = found_bzrdir.root_transport.clone('..')
606
if (found_bzrdir.root_transport.base == next_transport.base):
607
# top of the file system
609
# find the next containing bzrdir
611
found_bzrdir = BzrDir.open_containing_from_transport(
613
except errors.NotBranchError:
616
def find_repository(self):
617
"""Find the repository that should be used.
619
This does not require a branch as we use it to find the repo for
620
new branches as well as to hook existing branches up to their
623
def usable_repository(found_bzrdir):
624
# does it have a repository ?
626
repository = found_bzrdir.open_repository()
627
except errors.NoRepositoryPresent:
629
if found_bzrdir.root_transport.base == self.root_transport.base:
630
return repository, True
631
elif repository.is_shared():
632
return repository, True
636
found_repo = self._find_containing(usable_repository)
637
if found_repo is None:
638
raise errors.NoRepositoryPresent(self)
641
def get_branch_reference(self):
642
"""Return the referenced URL for the branch in this bzrdir.
644
:raises NotBranchError: If there is no Branch.
645
:return: The URL the branch in this bzrdir references if it is a
646
reference branch, or None for regular branches.
650
def get_branch_transport(self, branch_format):
651
"""Get the transport for use by branch format in this BzrDir.
653
Note that bzr dirs that do not support format strings will raise
654
IncompatibleFormat if the branch format they are given has
655
a format string, and vice versa.
657
If branch_format is None, the transport is returned with no
658
checking. If it is not None, then the returned transport is
659
guaranteed to point to an existing directory ready for use.
661
raise NotImplementedError(self.get_branch_transport)
663
def _find_creation_modes(self):
664
"""Determine the appropriate modes for files and directories.
666
They're always set to be consistent with the base directory,
667
assuming that this transport allows setting modes.
669
# TODO: Do we need or want an option (maybe a config setting) to turn
670
# this off or override it for particular locations? -- mbp 20080512
671
if self._mode_check_done:
673
self._mode_check_done = True
675
st = self.transport.stat('.')
676
except errors.TransportNotPossible:
677
self._dir_mode = None
678
self._file_mode = None
680
# Check the directory mode, but also make sure the created
681
# directories and files are read-write for this user. This is
682
# mostly a workaround for filesystems which lie about being able to
683
# write to a directory (cygwin & win32)
684
if (st.st_mode & 07777 == 00000):
685
# FTP allows stat but does not return dir/file modes
686
self._dir_mode = None
687
self._file_mode = None
689
self._dir_mode = (st.st_mode & 07777) | 00700
690
# Remove the sticky and execute bits for files
691
self._file_mode = self._dir_mode & ~07111
693
def _get_file_mode(self):
694
"""Return Unix mode for newly created files, or None.
696
if not self._mode_check_done:
697
self._find_creation_modes()
698
return self._file_mode
700
def _get_dir_mode(self):
701
"""Return Unix mode for newly created directories, or None.
703
if not self._mode_check_done:
704
self._find_creation_modes()
705
return self._dir_mode
707
def get_repository_transport(self, repository_format):
708
"""Get the transport for use by repository format in this BzrDir.
710
Note that bzr dirs that do not support format strings will raise
711
IncompatibleFormat if the repository format they are given has
712
a format string, and vice versa.
714
If repository_format is None, the transport is returned with no
715
checking. If it is not None, then the returned transport is
716
guaranteed to point to an existing directory ready for use.
718
raise NotImplementedError(self.get_repository_transport)
720
def get_workingtree_transport(self, tree_format):
721
"""Get the transport for use by workingtree format in this BzrDir.
723
Note that bzr dirs that do not support format strings will raise
724
IncompatibleFormat if the workingtree format they are given has a
725
format string, and vice versa.
727
If workingtree_format is None, the transport is returned with no
728
checking. If it is not None, then the returned transport is
729
guaranteed to point to an existing directory ready for use.
731
raise NotImplementedError(self.get_workingtree_transport)
733
def get_config(self):
734
if getattr(self, '_get_config', None) is None:
736
return self._get_config()
738
def __init__(self, _transport, _format):
739
"""Initialize a Bzr control dir object.
741
Only really common logic should reside here, concrete classes should be
742
made with varying behaviours.
744
:param _format: the format that is creating this BzrDir instance.
745
:param _transport: the transport this dir is based at.
747
self._format = _format
748
self.transport = _transport.clone('.bzr')
749
self.root_transport = _transport
750
self._mode_check_done = False
752
def is_control_filename(self, filename):
753
"""True if filename is the name of a path which is reserved for bzrdir's.
755
:param filename: A filename within the root transport of this bzrdir.
757
This is true IF and ONLY IF the filename is part of the namespace reserved
758
for bzr control dirs. Currently this is the '.bzr' directory in the root
759
of the root_transport. it is expected that plugins will need to extend
760
this in the future - for instance to make bzr talk with svn working
763
# this might be better on the BzrDirFormat class because it refers to
764
# all the possible bzrdir disk formats.
765
# This method is tested via the workingtree is_control_filename tests-
766
# it was extracted from WorkingTree.is_control_filename. If the method's
767
# contract is extended beyond the current trivial implementation, please
768
# add new tests for it to the appropriate place.
769
return filename == '.bzr' or filename.startswith('.bzr/')
771
def needs_format_conversion(self, format=None):
772
"""Return true if this bzrdir needs convert_format run on it.
774
For instance, if the repository format is out of date but the
775
branch and working tree are not, this should return True.
777
:param format: Optional parameter indicating a specific desired
778
format we plan to arrive at.
780
raise NotImplementedError(self.needs_format_conversion)
783
def open_unsupported(base):
784
"""Open a branch which is not supported."""
785
return BzrDir.open(base, _unsupported=True)
788
def open(base, _unsupported=False, possible_transports=None):
789
"""Open an existing bzrdir, rooted at 'base' (url).
791
:param _unsupported: a private parameter to the BzrDir class.
793
t = get_transport(base, possible_transports=possible_transports)
794
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
797
def open_from_transport(transport, _unsupported=False,
798
_server_formats=True):
799
"""Open a bzrdir within a particular directory.
801
:param transport: Transport containing the bzrdir.
802
:param _unsupported: private.
804
# Keep initial base since 'transport' may be modified while following
806
base = transport.base
807
def find_format(transport):
808
return transport, BzrDirFormat.find_format(
809
transport, _server_formats=_server_formats)
811
def redirected(transport, e, redirection_notice):
812
redirected_transport = transport._redirected_to(e.source, e.target)
813
if redirected_transport is None:
814
raise errors.NotBranchError(base)
815
note('%s is%s redirected to %s',
816
transport.base, e.permanently, redirected_transport.base)
817
return redirected_transport
820
transport, format = do_catching_redirections(find_format,
823
except errors.TooManyRedirections:
824
raise errors.NotBranchError(base)
826
BzrDir._check_supported(format, _unsupported)
827
return format.open(transport, _found=True)
829
def open_branch(self, unsupported=False):
830
"""Open the branch object at this BzrDir if one is present.
832
If unsupported is True, then no longer supported branch formats can
835
TODO: static convenience version of this?
837
raise NotImplementedError(self.open_branch)
840
def open_containing(url, possible_transports=None):
841
"""Open an existing branch which contains url.
843
:param url: url to search from.
844
See open_containing_from_transport for more detail.
846
transport = get_transport(url, possible_transports)
847
return BzrDir.open_containing_from_transport(transport)
850
def open_containing_from_transport(a_transport):
851
"""Open an existing branch which contains a_transport.base.
853
This probes for a branch at a_transport, and searches upwards from there.
855
Basically we keep looking up until we find the control directory or
856
run into the root. If there isn't one, raises NotBranchError.
857
If there is one and it is either an unrecognised format or an unsupported
858
format, UnknownFormatError or UnsupportedFormatError are raised.
859
If there is one, it is returned, along with the unused portion of url.
861
:return: The BzrDir that contains the path, and a Unicode path
862
for the rest of the URL.
864
# this gets the normalised url back. I.e. '.' -> the full path.
865
url = a_transport.base
868
result = BzrDir.open_from_transport(a_transport)
869
return result, urlutils.unescape(a_transport.relpath(url))
870
except errors.NotBranchError, e:
873
new_t = a_transport.clone('..')
874
except errors.InvalidURLJoin:
875
# reached the root, whatever that may be
876
raise errors.NotBranchError(path=url)
877
if new_t.base == a_transport.base:
878
# reached the root, whatever that may be
879
raise errors.NotBranchError(path=url)
882
def _get_tree_branch(self):
883
"""Return the branch and tree, if any, for this bzrdir.
885
Return None for tree if not present or inaccessible.
886
Raise NotBranchError if no branch is present.
887
:return: (tree, branch)
890
tree = self.open_workingtree()
891
except (errors.NoWorkingTree, errors.NotLocalUrl):
893
branch = self.open_branch()
899
def open_tree_or_branch(klass, location):
900
"""Return the branch and working tree at a location.
902
If there is no tree at the location, tree will be None.
903
If there is no branch at the location, an exception will be
905
:return: (tree, branch)
907
bzrdir = klass.open(location)
908
return bzrdir._get_tree_branch()
911
def open_containing_tree_or_branch(klass, location):
912
"""Return the branch and working tree contained by a location.
914
Returns (tree, branch, relpath).
915
If there is no tree at containing the location, tree will be None.
916
If there is no branch containing the location, an exception will be
918
relpath is the portion of the path that is contained by the branch.
920
bzrdir, relpath = klass.open_containing(location)
921
tree, branch = bzrdir._get_tree_branch()
922
return tree, branch, relpath
925
def open_containing_tree_branch_or_repository(klass, location):
926
"""Return the working tree, branch and repo contained by a location.
928
Returns (tree, branch, repository, relpath).
929
If there is no tree containing the location, tree will be None.
930
If there is no branch containing the location, branch will be None.
931
If there is no repository containing the location, repository will be
933
relpath is the portion of the path that is contained by the innermost
936
If no tree, branch or repository is found, a NotBranchError is raised.
938
bzrdir, relpath = klass.open_containing(location)
940
tree, branch = bzrdir._get_tree_branch()
941
except errors.NotBranchError:
943
repo = bzrdir.find_repository()
944
return None, None, repo, relpath
945
except (errors.NoRepositoryPresent):
946
raise errors.NotBranchError(location)
947
return tree, branch, branch.repository, relpath
949
def open_repository(self, _unsupported=False):
950
"""Open the repository object at this BzrDir if one is present.
952
This will not follow the Branch object pointer - it's strictly a direct
953
open facility. Most client code should use open_branch().repository to
956
:param _unsupported: a private parameter, not part of the api.
957
TODO: static convenience version of this?
959
raise NotImplementedError(self.open_repository)
961
def open_workingtree(self, _unsupported=False,
962
recommend_upgrade=True, from_branch=None):
963
"""Open the workingtree object at this BzrDir if one is present.
965
:param recommend_upgrade: Optional keyword parameter, when True (the
966
default), emit through the ui module a recommendation that the user
967
upgrade the working tree when the workingtree being opened is old
968
(but still fully supported).
969
:param from_branch: override bzrdir branch (for lightweight checkouts)
971
raise NotImplementedError(self.open_workingtree)
973
def has_branch(self):
974
"""Tell if this bzrdir contains a branch.
976
Note: if you're going to open the branch, you should just go ahead
977
and try, and not ask permission first. (This method just opens the
978
branch and discards it, and that's somewhat expensive.)
983
except errors.NotBranchError:
986
def has_workingtree(self):
987
"""Tell if this bzrdir contains a working tree.
989
This will still raise an exception if the bzrdir has a workingtree that
990
is remote & inaccessible.
992
Note: if you're going to open the working tree, you should just go ahead
993
and try, and not ask permission first. (This method just opens the
994
workingtree and discards it, and that's somewhat expensive.)
997
self.open_workingtree(recommend_upgrade=False)
999
except errors.NoWorkingTree:
1002
def _cloning_metadir(self):
1003
"""Produce a metadir suitable for cloning with.
1005
:returns: (destination_bzrdir_format, source_repository)
1007
result_format = self._format.__class__()
1010
branch = self.open_branch()
1011
source_repository = branch.repository
1012
result_format._branch_format = branch._format
1013
except errors.NotBranchError:
1014
source_branch = None
1015
source_repository = self.open_repository()
1016
except errors.NoRepositoryPresent:
1017
source_repository = None
1019
# XXX TODO: This isinstance is here because we have not implemented
1020
# the fix recommended in bug # 103195 - to delegate this choice the
1021
# repository itself.
1022
repo_format = source_repository._format
1023
if isinstance(repo_format, remote.RemoteRepositoryFormat):
1024
source_repository._ensure_real()
1025
repo_format = source_repository._real_repository._format
1026
result_format.repository_format = repo_format
1028
# TODO: Couldn't we just probe for the format in these cases,
1029
# rather than opening the whole tree? It would be a little
1030
# faster. mbp 20070401
1031
tree = self.open_workingtree(recommend_upgrade=False)
1032
except (errors.NoWorkingTree, errors.NotLocalUrl):
1033
result_format.workingtree_format = None
1035
result_format.workingtree_format = tree._format.__class__()
1036
return result_format, source_repository
1038
def cloning_metadir(self, require_stacking=False):
1039
"""Produce a metadir suitable for cloning or sprouting with.
1041
These operations may produce workingtrees (yes, even though they're
1042
"cloning" something that doesn't have a tree), so a viable workingtree
1043
format must be selected.
1045
:require_stacking: If True, non-stackable formats will be upgraded
1046
to similar stackable formats.
1047
:returns: a BzrDirFormat with all component formats either set
1048
appropriately or set to None if that component should not be
1051
format, repository = self._cloning_metadir()
1052
if format._workingtree_format is None:
1053
if repository is None:
1055
tree_format = repository._format._matchingbzrdir.workingtree_format
1056
format.workingtree_format = tree_format.__class__()
1057
if require_stacking:
1058
format.require_stacking()
1061
def checkout_metadir(self):
1062
return self.cloning_metadir()
1064
def sprout(self, url, revision_id=None, force_new_repo=False,
1065
recurse='down', possible_transports=None,
1066
accelerator_tree=None, hardlink=False, stacked=False,
1067
source_branch=None, create_tree_if_local=True):
1068
"""Create a copy of this bzrdir prepared for use as a new line of
1071
If url's last component does not exist, it will be created.
1073
Attributes related to the identity of the source branch like
1074
branch nickname will be cleaned, a working tree is created
1075
whether one existed before or not; and a local branch is always
1078
if revision_id is not None, then the clone operation may tune
1079
itself to download less data.
1080
:param accelerator_tree: A tree which can be used for retrieving file
1081
contents more quickly than the revision tree, i.e. a workingtree.
1082
The revision tree will be used for cases where accelerator_tree's
1083
content is different.
1084
:param hardlink: If true, hard-link files from accelerator_tree,
1086
:param stacked: If true, create a stacked branch referring to the
1087
location of this control directory.
1088
:param create_tree_if_local: If true, a working-tree will be created
1089
when working locally.
1091
target_transport = get_transport(url, possible_transports)
1092
target_transport.ensure_base()
1093
cloning_format = self.cloning_metadir(stacked)
1094
# Create/update the result branch
1095
result = cloning_format.initialize_on_transport(target_transport)
1096
# if a stacked branch wasn't requested, we don't create one
1097
# even if the origin was stacked
1098
stacked_branch_url = None
1099
if source_branch is not None:
1101
stacked_branch_url = self.root_transport.base
1102
source_repository = source_branch.repository
1105
source_branch = self.open_branch()
1106
source_repository = source_branch.repository
1108
stacked_branch_url = self.root_transport.base
1109
except errors.NotBranchError:
1110
source_branch = None
1112
source_repository = self.open_repository()
1113
except errors.NoRepositoryPresent:
1114
source_repository = None
1115
repository_policy = result.determine_repository_policy(
1116
force_new_repo, stacked_branch_url, require_stacking=stacked)
1117
result_repo = repository_policy.acquire_repository()
1118
if source_repository is not None:
1119
# Fetch while stacked to prevent unstacked fetch from
1121
result_repo.fetch(source_repository, revision_id=revision_id)
1123
if source_branch is None:
1124
# this is for sprouting a bzrdir without a branch; is that
1126
# Not especially, but it's part of the contract.
1127
result_branch = result.create_branch()
1129
# Force NULL revision to avoid using repository before stacking
1131
result_branch = source_branch.sprout(
1132
result, revision_id=_mod_revision.NULL_REVISION)
1133
parent_location = result_branch.get_parent()
1134
mutter("created new branch %r" % (result_branch,))
1135
repository_policy.configure_branch(result_branch)
1136
if source_branch is not None:
1137
source_branch.copy_content_into(result_branch, revision_id)
1138
# Override copy_content_into
1139
result_branch.set_parent(parent_location)
1141
# Create/update the result working tree
1142
if (create_tree_if_local and
1143
isinstance(target_transport, local.LocalTransport) and
1144
(result_repo is None or result_repo.make_working_trees())):
1145
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1149
if wt.path2id('') is None:
1151
wt.set_root_id(self.open_workingtree.get_root_id())
1152
except errors.NoWorkingTree:
1158
if recurse == 'down':
1160
basis = wt.basis_tree()
1162
subtrees = basis.iter_references()
1163
elif result_branch is not None:
1164
basis = result_branch.basis_tree()
1166
subtrees = basis.iter_references()
1167
elif source_branch is not None:
1168
basis = source_branch.basis_tree()
1170
subtrees = basis.iter_references()
1175
for path, file_id in subtrees:
1176
target = urlutils.join(url, urlutils.escape(path))
1177
sublocation = source_branch.reference_parent(file_id, path)
1178
sublocation.bzrdir.sprout(target,
1179
basis.get_reference_revision(file_id, path),
1180
force_new_repo=force_new_repo, recurse=recurse,
1183
if basis is not None:
1188
class BzrDirPreSplitOut(BzrDir):
1189
"""A common class for the all-in-one formats."""
1191
def __init__(self, _transport, _format):
1192
"""See BzrDir.__init__."""
1193
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1194
self._control_files = lockable_files.LockableFiles(
1195
self.get_branch_transport(None),
1196
self._format._lock_file_name,
1197
self._format._lock_class)
1199
def break_lock(self):
1200
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1201
raise NotImplementedError(self.break_lock)
1203
def cloning_metadir(self, require_stacking=False):
1204
"""Produce a metadir suitable for cloning with."""
1205
if require_stacking:
1206
return format_registry.make_bzrdir('1.6')
1207
return self._format.__class__()
1209
def clone(self, url, revision_id=None, force_new_repo=False,
1210
preserve_stacking=False):
1211
"""See BzrDir.clone().
1213
force_new_repo has no effect, since this family of formats always
1214
require a new repository.
1215
preserve_stacking has no effect, since no source branch using this
1216
family of formats can be stacked, so there is no stacking to preserve.
1218
self._make_tail(url)
1219
result = self._format._initialize_for_clone(url)
1220
self.open_repository().clone(result, revision_id=revision_id)
1221
from_branch = self.open_branch()
1222
from_branch.clone(result, revision_id=revision_id)
1224
tree = self.open_workingtree()
1225
except errors.NotLocalUrl:
1226
# make a new one, this format always has to have one.
1227
result._init_workingtree()
1232
def create_branch(self):
1233
"""See BzrDir.create_branch."""
1234
return self._format.get_branch_format().initialize(self)
1236
def destroy_branch(self):
1237
"""See BzrDir.destroy_branch."""
1238
raise errors.UnsupportedOperation(self.destroy_branch, self)
1240
def create_repository(self, shared=False):
1241
"""See BzrDir.create_repository."""
1243
raise errors.IncompatibleFormat('shared repository', self._format)
1244
return self.open_repository()
1246
def destroy_repository(self):
1247
"""See BzrDir.destroy_repository."""
1248
raise errors.UnsupportedOperation(self.destroy_repository, self)
1250
def create_workingtree(self, revision_id=None, from_branch=None,
1251
accelerator_tree=None, hardlink=False):
1252
"""See BzrDir.create_workingtree."""
1253
# The workingtree is sometimes created when the bzrdir is created,
1254
# but not when cloning.
1256
# this looks buggy but is not -really-
1257
# because this format creates the workingtree when the bzrdir is
1259
# clone and sprout will have set the revision_id
1260
# and that will have set it for us, its only
1261
# specific uses of create_workingtree in isolation
1262
# that can do wonky stuff here, and that only
1263
# happens for creating checkouts, which cannot be
1264
# done on this format anyway. So - acceptable wart.
1266
result = self.open_workingtree(recommend_upgrade=False)
1267
except errors.NoSuchFile:
1268
result = self._init_workingtree()
1269
if revision_id is not None:
1270
if revision_id == _mod_revision.NULL_REVISION:
1271
result.set_parent_ids([])
1273
result.set_parent_ids([revision_id])
1276
def _init_workingtree(self):
1277
from bzrlib.workingtree import WorkingTreeFormat2
1279
return WorkingTreeFormat2().initialize(self)
1280
except errors.NotLocalUrl:
1281
# Even though we can't access the working tree, we need to
1282
# create its control files.
1283
return WorkingTreeFormat2()._stub_initialize_on_transport(
1284
self.transport, self._control_files._file_mode)
1286
def destroy_workingtree(self):
1287
"""See BzrDir.destroy_workingtree."""
1288
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1290
def destroy_workingtree_metadata(self):
1291
"""See BzrDir.destroy_workingtree_metadata."""
1292
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1295
def get_branch_transport(self, branch_format):
1296
"""See BzrDir.get_branch_transport()."""
1297
if branch_format is None:
1298
return self.transport
1300
branch_format.get_format_string()
1301
except NotImplementedError:
1302
return self.transport
1303
raise errors.IncompatibleFormat(branch_format, self._format)
1305
def get_repository_transport(self, repository_format):
1306
"""See BzrDir.get_repository_transport()."""
1307
if repository_format is None:
1308
return self.transport
1310
repository_format.get_format_string()
1311
except NotImplementedError:
1312
return self.transport
1313
raise errors.IncompatibleFormat(repository_format, self._format)
1315
def get_workingtree_transport(self, workingtree_format):
1316
"""See BzrDir.get_workingtree_transport()."""
1317
if workingtree_format is None:
1318
return self.transport
1320
workingtree_format.get_format_string()
1321
except NotImplementedError:
1322
return self.transport
1323
raise errors.IncompatibleFormat(workingtree_format, self._format)
1325
def needs_format_conversion(self, format=None):
1326
"""See BzrDir.needs_format_conversion()."""
1327
# if the format is not the same as the system default,
1328
# an upgrade is needed.
1330
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1331
% 'needs_format_conversion(format=None)')
1332
format = BzrDirFormat.get_default_format()
1333
return not isinstance(self._format, format.__class__)
1335
def open_branch(self, unsupported=False):
1336
"""See BzrDir.open_branch."""
1337
from bzrlib.branch import BzrBranchFormat4
1338
format = BzrBranchFormat4()
1339
self._check_supported(format, unsupported)
1340
return format.open(self, _found=True)
1342
def sprout(self, url, revision_id=None, force_new_repo=False,
1343
possible_transports=None, accelerator_tree=None,
1344
hardlink=False, stacked=False, create_tree_if_local=True):
1345
"""See BzrDir.sprout()."""
1347
raise errors.UnstackableBranchFormat(
1348
self._format, self.root_transport.base)
1349
if not create_tree_if_local:
1350
raise errors.MustHaveWorkingTree(
1351
self._format, self.root_transport.base)
1352
from bzrlib.workingtree import WorkingTreeFormat2
1353
self._make_tail(url)
1354
result = self._format._initialize_for_clone(url)
1356
self.open_repository().clone(result, revision_id=revision_id)
1357
except errors.NoRepositoryPresent:
1360
self.open_branch().sprout(result, revision_id=revision_id)
1361
except errors.NotBranchError:
1364
# we always want a working tree
1365
WorkingTreeFormat2().initialize(result,
1366
accelerator_tree=accelerator_tree,
1371
class BzrDir4(BzrDirPreSplitOut):
1372
"""A .bzr version 4 control object.
1374
This is a deprecated format and may be removed after sept 2006.
1377
def create_repository(self, shared=False):
1378
"""See BzrDir.create_repository."""
1379
return self._format.repository_format.initialize(self, shared)
1381
def needs_format_conversion(self, format=None):
1382
"""Format 4 dirs are always in need of conversion."""
1384
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1385
% 'needs_format_conversion(format=None)')
1388
def open_repository(self):
1389
"""See BzrDir.open_repository."""
1390
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1391
return RepositoryFormat4().open(self, _found=True)
1394
class BzrDir5(BzrDirPreSplitOut):
1395
"""A .bzr version 5 control object.
1397
This is a deprecated format and may be removed after sept 2006.
1400
def open_repository(self):
1401
"""See BzrDir.open_repository."""
1402
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1403
return RepositoryFormat5().open(self, _found=True)
1405
def open_workingtree(self, _unsupported=False,
1406
recommend_upgrade=True):
1407
"""See BzrDir.create_workingtree."""
1408
from bzrlib.workingtree import WorkingTreeFormat2
1409
wt_format = WorkingTreeFormat2()
1410
# we don't warn here about upgrades; that ought to be handled for the
1412
return wt_format.open(self, _found=True)
1415
class BzrDir6(BzrDirPreSplitOut):
1416
"""A .bzr version 6 control object.
1418
This is a deprecated format and may be removed after sept 2006.
1421
def open_repository(self):
1422
"""See BzrDir.open_repository."""
1423
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1424
return RepositoryFormat6().open(self, _found=True)
1426
def open_workingtree(self, _unsupported=False,
1427
recommend_upgrade=True):
1428
"""See BzrDir.create_workingtree."""
1429
# we don't warn here about upgrades; that ought to be handled for the
1431
from bzrlib.workingtree import WorkingTreeFormat2
1432
return WorkingTreeFormat2().open(self, _found=True)
1435
class BzrDirMeta1(BzrDir):
1436
"""A .bzr meta version 1 control object.
1438
This is the first control object where the
1439
individual aspects are really split out: there are separate repository,
1440
workingtree and branch subdirectories and any subset of the three can be
1441
present within a BzrDir.
1444
def can_convert_format(self):
1445
"""See BzrDir.can_convert_format()."""
1448
def create_branch(self):
1449
"""See BzrDir.create_branch."""
1450
return self._format.get_branch_format().initialize(self)
1452
def destroy_branch(self):
1453
"""See BzrDir.create_branch."""
1454
self.transport.delete_tree('branch')
1456
def create_repository(self, shared=False):
1457
"""See BzrDir.create_repository."""
1458
return self._format.repository_format.initialize(self, shared)
1460
def destroy_repository(self):
1461
"""See BzrDir.destroy_repository."""
1462
self.transport.delete_tree('repository')
1464
def create_workingtree(self, revision_id=None, from_branch=None,
1465
accelerator_tree=None, hardlink=False):
1466
"""See BzrDir.create_workingtree."""
1467
return self._format.workingtree_format.initialize(
1468
self, revision_id, from_branch=from_branch,
1469
accelerator_tree=accelerator_tree, hardlink=hardlink)
1471
def destroy_workingtree(self):
1472
"""See BzrDir.destroy_workingtree."""
1473
wt = self.open_workingtree(recommend_upgrade=False)
1474
repository = wt.branch.repository
1475
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1476
wt.revert(old_tree=empty)
1477
self.destroy_workingtree_metadata()
1479
def destroy_workingtree_metadata(self):
1480
self.transport.delete_tree('checkout')
1482
def find_branch_format(self):
1483
"""Find the branch 'format' for this bzrdir.
1485
This might be a synthetic object for e.g. RemoteBranch and SVN.
1487
from bzrlib.branch import BranchFormat
1488
return BranchFormat.find_format(self)
1490
def _get_mkdir_mode(self):
1491
"""Figure out the mode to use when creating a bzrdir subdir."""
1492
temp_control = lockable_files.LockableFiles(self.transport, '',
1493
lockable_files.TransportLock)
1494
return temp_control._dir_mode
1496
def get_branch_reference(self):
1497
"""See BzrDir.get_branch_reference()."""
1498
from bzrlib.branch import BranchFormat
1499
format = BranchFormat.find_format(self)
1500
return format.get_reference(self)
1502
def get_branch_transport(self, branch_format):
1503
"""See BzrDir.get_branch_transport()."""
1504
if branch_format is None:
1505
return self.transport.clone('branch')
1507
branch_format.get_format_string()
1508
except NotImplementedError:
1509
raise errors.IncompatibleFormat(branch_format, self._format)
1511
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1512
except errors.FileExists:
1514
return self.transport.clone('branch')
1516
def get_repository_transport(self, repository_format):
1517
"""See BzrDir.get_repository_transport()."""
1518
if repository_format is None:
1519
return self.transport.clone('repository')
1521
repository_format.get_format_string()
1522
except NotImplementedError:
1523
raise errors.IncompatibleFormat(repository_format, self._format)
1525
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1526
except errors.FileExists:
1528
return self.transport.clone('repository')
1530
def get_workingtree_transport(self, workingtree_format):
1531
"""See BzrDir.get_workingtree_transport()."""
1532
if workingtree_format is None:
1533
return self.transport.clone('checkout')
1535
workingtree_format.get_format_string()
1536
except NotImplementedError:
1537
raise errors.IncompatibleFormat(workingtree_format, self._format)
1539
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1540
except errors.FileExists:
1542
return self.transport.clone('checkout')
1544
def needs_format_conversion(self, format=None):
1545
"""See BzrDir.needs_format_conversion()."""
1547
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
1548
% 'needs_format_conversion(format=None)')
1550
format = BzrDirFormat.get_default_format()
1551
if not isinstance(self._format, format.__class__):
1552
# it is not a meta dir format, conversion is needed.
1554
# we might want to push this down to the repository?
1556
if not isinstance(self.open_repository()._format,
1557
format.repository_format.__class__):
1558
# the repository needs an upgrade.
1560
except errors.NoRepositoryPresent:
1563
if not isinstance(self.open_branch()._format,
1564
format.get_branch_format().__class__):
1565
# the branch needs an upgrade.
1567
except errors.NotBranchError:
1570
my_wt = self.open_workingtree(recommend_upgrade=False)
1571
if not isinstance(my_wt._format,
1572
format.workingtree_format.__class__):
1573
# the workingtree needs an upgrade.
1575
except (errors.NoWorkingTree, errors.NotLocalUrl):
1579
def open_branch(self, unsupported=False):
1580
"""See BzrDir.open_branch."""
1581
format = self.find_branch_format()
1582
self._check_supported(format, unsupported)
1583
return format.open(self, _found=True)
1585
def open_repository(self, unsupported=False):
1586
"""See BzrDir.open_repository."""
1587
from bzrlib.repository import RepositoryFormat
1588
format = RepositoryFormat.find_format(self)
1589
self._check_supported(format, unsupported)
1590
return format.open(self, _found=True)
1592
def open_workingtree(self, unsupported=False,
1593
recommend_upgrade=True):
1594
"""See BzrDir.open_workingtree."""
1595
from bzrlib.workingtree import WorkingTreeFormat
1596
format = WorkingTreeFormat.find_format(self)
1597
self._check_supported(format, unsupported,
1599
basedir=self.root_transport.base)
1600
return format.open(self, _found=True)
1602
def _get_config(self):
1603
return config.BzrDirConfig(self.transport)
1606
class BzrDirFormat(object):
1607
"""An encapsulation of the initialization and open routines for a format.
1609
Formats provide three things:
1610
* An initialization routine,
1614
Formats are placed in a dict by their format string for reference
1615
during bzrdir opening. These should be subclasses of BzrDirFormat
1618
Once a format is deprecated, just deprecate the initialize and open
1619
methods on the format class. Do not deprecate the object, as the
1620
object will be created every system load.
1623
_default_format = None
1624
"""The default format used for new .bzr dirs."""
1627
"""The known formats."""
1629
_control_formats = []
1630
"""The registered control formats - .bzr, ....
1632
This is a list of BzrDirFormat objects.
1635
_control_server_formats = []
1636
"""The registered control server formats, e.g. RemoteBzrDirs.
1638
This is a list of BzrDirFormat objects.
1641
_lock_file_name = 'branch-lock'
1643
# _lock_class must be set in subclasses to the lock type, typ.
1644
# TransportLock or LockDir
1647
def find_format(klass, transport, _server_formats=True):
1648
"""Return the format present at transport."""
1650
formats = klass._control_server_formats + klass._control_formats
1652
formats = klass._control_formats
1653
for format in formats:
1655
return format.probe_transport(transport)
1656
except errors.NotBranchError:
1657
# this format does not find a control dir here.
1659
raise errors.NotBranchError(path=transport.base)
1662
def probe_transport(klass, transport):
1663
"""Return the .bzrdir style format present in a directory."""
1665
format_string = transport.get(".bzr/branch-format").read()
1666
except errors.NoSuchFile:
1667
raise errors.NotBranchError(path=transport.base)
1670
return klass._formats[format_string]
1672
raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1675
def get_default_format(klass):
1676
"""Return the current default format."""
1677
return klass._default_format
1679
def get_format_string(self):
1680
"""Return the ASCII format string that identifies this format."""
1681
raise NotImplementedError(self.get_format_string)
1683
def get_format_description(self):
1684
"""Return the short description for this format."""
1685
raise NotImplementedError(self.get_format_description)
1687
def get_converter(self, format=None):
1688
"""Return the converter to use to convert bzrdirs needing converts.
1690
This returns a bzrlib.bzrdir.Converter object.
1692
This should return the best upgrader to step this format towards the
1693
current default format. In the case of plugins we can/should provide
1694
some means for them to extend the range of returnable converters.
1696
:param format: Optional format to override the default format of the
1699
raise NotImplementedError(self.get_converter)
1701
def initialize(self, url, possible_transports=None):
1702
"""Create a bzr control dir at this url and return an opened copy.
1704
Subclasses should typically override initialize_on_transport
1705
instead of this method.
1707
return self.initialize_on_transport(get_transport(url,
1708
possible_transports))
1710
def initialize_on_transport(self, transport):
1711
"""Initialize a new bzrdir in the base directory of a Transport."""
1713
# can we hand off the request to the smart server rather than using
1715
client_medium = transport.get_smart_medium()
1716
except errors.NoSmartMedium:
1717
return self._initialize_on_transport_vfs(transport)
1719
# Current RPC's only know how to create bzr metadir1 instances, so
1720
# we still delegate to vfs methods if the requested format is not a
1722
if type(self) != BzrDirMetaFormat1:
1723
return self._initialize_on_transport_vfs(transport)
1724
remote_format = RemoteBzrDirFormat()
1725
self._supply_sub_formats_to(remote_format)
1726
return remote_format.initialize_on_transport(transport)
1728
def _initialize_on_transport_vfs(self, transport):
1729
"""Initialize a new bzrdir using VFS calls.
1731
:param transport: The transport to create the .bzr directory in.
1734
# Since we are creating a .bzr directory, inherit the
1735
# mode from the root directory
1736
temp_control = lockable_files.LockableFiles(transport,
1737
'', lockable_files.TransportLock)
1738
temp_control._transport.mkdir('.bzr',
1739
# FIXME: RBC 20060121 don't peek under
1741
mode=temp_control._dir_mode)
1742
if sys.platform == 'win32' and isinstance(transport, local.LocalTransport):
1743
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1744
file_mode = temp_control._file_mode
1746
bzrdir_transport = transport.clone('.bzr')
1747
utf8_files = [('README',
1748
"This is a Bazaar control directory.\n"
1749
"Do not change any files in this directory.\n"
1750
"See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
1751
('branch-format', self.get_format_string()),
1753
# NB: no need to escape relative paths that are url safe.
1754
control_files = lockable_files.LockableFiles(bzrdir_transport,
1755
self._lock_file_name, self._lock_class)
1756
control_files.create_lock()
1757
control_files.lock_write()
1759
for (filename, content) in utf8_files:
1760
bzrdir_transport.put_bytes(filename, content,
1763
control_files.unlock()
1764
return self.open(transport, _found=True)
1766
def is_supported(self):
1767
"""Is this format supported?
1769
Supported formats must be initializable and openable.
1770
Unsupported formats may not support initialization or committing or
1771
some other features depending on the reason for not being supported.
1775
def same_model(self, target_format):
1776
return (self.repository_format.rich_root_data ==
1777
target_format.rich_root_data)
1780
def known_formats(klass):
1781
"""Return all the known formats.
1783
Concrete formats should override _known_formats.
1785
# There is double indirection here to make sure that control
1786
# formats used by more than one dir format will only be probed
1787
# once. This can otherwise be quite expensive for remote connections.
1789
for format in klass._control_formats:
1790
result.update(format._known_formats())
1794
def _known_formats(klass):
1795
"""Return the known format instances for this control format."""
1796
return set(klass._formats.values())
1798
def open(self, transport, _found=False):
1799
"""Return an instance of this format for the dir transport points at.
1801
_found is a private parameter, do not use it.
1804
found_format = BzrDirFormat.find_format(transport)
1805
if not isinstance(found_format, self.__class__):
1806
raise AssertionError("%s was asked to open %s, but it seems to need "
1808
% (self, transport, found_format))
1809
# Allow subclasses - use the found format.
1810
self._supply_sub_formats_to(found_format)
1811
return found_format._open(transport)
1812
return self._open(transport)
1814
def _open(self, transport):
1815
"""Template method helper for opening BzrDirectories.
1817
This performs the actual open and any additional logic or parameter
1820
raise NotImplementedError(self._open)
1823
def register_format(klass, format):
1824
klass._formats[format.get_format_string()] = format
1827
def register_control_format(klass, format):
1828
"""Register a format that does not use '.bzr' for its control dir.
1830
TODO: This should be pulled up into a 'ControlDirFormat' base class
1831
which BzrDirFormat can inherit from, and renamed to register_format
1832
there. It has been done without that for now for simplicity of
1835
klass._control_formats.append(format)
1838
def register_control_server_format(klass, format):
1839
"""Register a control format for client-server environments.
1841
These formats will be tried before ones registered with
1842
register_control_format. This gives implementations that decide to the
1843
chance to grab it before anything looks at the contents of the format
1846
klass._control_server_formats.append(format)
1849
def _set_default_format(klass, format):
1850
"""Set default format (for testing behavior of defaults only)"""
1851
klass._default_format = format
1855
return self.get_format_description().rstrip()
1857
def _supply_sub_formats_to(self, other_format):
1858
"""Give other_format the same values for sub formats as this has.
1860
This method is expected to be used when parameterising a
1861
RemoteBzrDirFormat instance with the parameters from a
1862
BzrDirMetaFormat1 instance.
1864
:param other_format: other_format is a format which should be
1865
compatible with whatever sub formats are supported by self.
1870
def unregister_format(klass, format):
1871
del klass._formats[format.get_format_string()]
1874
def unregister_control_format(klass, format):
1875
klass._control_formats.remove(format)
1878
class BzrDirFormat4(BzrDirFormat):
1879
"""Bzr dir format 4.
1881
This format is a combined format for working tree, branch and repository.
1883
- Format 1 working trees [always]
1884
- Format 4 branches [always]
1885
- Format 4 repositories [always]
1887
This format is deprecated: it indexes texts using a text it which is
1888
removed in format 5; write support for this format has been removed.
1891
_lock_class = lockable_files.TransportLock
1893
def get_format_string(self):
1894
"""See BzrDirFormat.get_format_string()."""
1895
return "Bazaar-NG branch, format 0.0.4\n"
1897
def get_format_description(self):
1898
"""See BzrDirFormat.get_format_description()."""
1899
return "All-in-one format 4"
1901
def get_converter(self, format=None):
1902
"""See BzrDirFormat.get_converter()."""
1903
# there is one and only one upgrade path here.
1904
return ConvertBzrDir4To5()
1906
def initialize_on_transport(self, transport):
1907
"""Format 4 branches cannot be created."""
1908
raise errors.UninitializableFormat(self)
1910
def is_supported(self):
1911
"""Format 4 is not supported.
1913
It is not supported because the model changed from 4 to 5 and the
1914
conversion logic is expensive - so doing it on the fly was not
1919
def _open(self, transport):
1920
"""See BzrDirFormat._open."""
1921
return BzrDir4(transport, self)
1923
def __return_repository_format(self):
1924
"""Circular import protection."""
1925
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1926
return RepositoryFormat4()
1927
repository_format = property(__return_repository_format)
1930
class BzrDirFormat5(BzrDirFormat):
1931
"""Bzr control format 5.
1933
This format is a combined format for working tree, branch and repository.
1935
- Format 2 working trees [always]
1936
- Format 4 branches [always]
1937
- Format 5 repositories [always]
1938
Unhashed stores in the repository.
1941
_lock_class = lockable_files.TransportLock
1943
def get_format_string(self):
1944
"""See BzrDirFormat.get_format_string()."""
1945
return "Bazaar-NG branch, format 5\n"
1947
def get_branch_format(self):
1948
from bzrlib import branch
1949
return branch.BzrBranchFormat4()
1951
def get_format_description(self):
1952
"""See BzrDirFormat.get_format_description()."""
1953
return "All-in-one format 5"
1955
def get_converter(self, format=None):
1956
"""See BzrDirFormat.get_converter()."""
1957
# there is one and only one upgrade path here.
1958
return ConvertBzrDir5To6()
1960
def _initialize_for_clone(self, url):
1961
return self.initialize_on_transport(get_transport(url), _cloning=True)
1963
def initialize_on_transport(self, transport, _cloning=False):
1964
"""Format 5 dirs always have working tree, branch and repository.
1966
Except when they are being cloned.
1968
from bzrlib.branch import BzrBranchFormat4
1969
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1970
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1971
RepositoryFormat5().initialize(result, _internal=True)
1973
branch = BzrBranchFormat4().initialize(result)
1974
result._init_workingtree()
1977
def _open(self, transport):
1978
"""See BzrDirFormat._open."""
1979
return BzrDir5(transport, self)
1981
def __return_repository_format(self):
1982
"""Circular import protection."""
1983
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1984
return RepositoryFormat5()
1985
repository_format = property(__return_repository_format)
1988
class BzrDirFormat6(BzrDirFormat):
1989
"""Bzr control format 6.
1991
This format is a combined format for working tree, branch and repository.
1993
- Format 2 working trees [always]
1994
- Format 4 branches [always]
1995
- Format 6 repositories [always]
1998
_lock_class = lockable_files.TransportLock
2000
def get_format_string(self):
2001
"""See BzrDirFormat.get_format_string()."""
2002
return "Bazaar-NG branch, format 6\n"
2004
def get_format_description(self):
2005
"""See BzrDirFormat.get_format_description()."""
2006
return "All-in-one format 6"
2008
def get_branch_format(self):
2009
from bzrlib import branch
2010
return branch.BzrBranchFormat4()
2012
def get_converter(self, format=None):
2013
"""See BzrDirFormat.get_converter()."""
2014
# there is one and only one upgrade path here.
2015
return ConvertBzrDir6ToMeta()
2017
def _initialize_for_clone(self, url):
2018
return self.initialize_on_transport(get_transport(url), _cloning=True)
2020
def initialize_on_transport(self, transport, _cloning=False):
2021
"""Format 6 dirs always have working tree, branch and repository.
2023
Except when they are being cloned.
2025
from bzrlib.branch import BzrBranchFormat4
2026
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2027
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
2028
RepositoryFormat6().initialize(result, _internal=True)
2030
branch = BzrBranchFormat4().initialize(result)
2031
result._init_workingtree()
2034
def _open(self, transport):
2035
"""See BzrDirFormat._open."""
2036
return BzrDir6(transport, self)
2038
def __return_repository_format(self):
2039
"""Circular import protection."""
2040
from bzrlib.repofmt.weaverepo import RepositoryFormat6
2041
return RepositoryFormat6()
2042
repository_format = property(__return_repository_format)
2045
class BzrDirMetaFormat1(BzrDirFormat):
2046
"""Bzr meta control format 1
2048
This is the first format with split out working tree, branch and repository
2051
- Format 3 working trees [optional]
2052
- Format 5 branches [optional]
2053
- Format 7 repositories [optional]
2056
_lock_class = lockdir.LockDir
2059
self._workingtree_format = None
2060
self._branch_format = None
2062
def __eq__(self, other):
2063
if other.__class__ is not self.__class__:
2065
if other.repository_format != self.repository_format:
2067
if other.workingtree_format != self.workingtree_format:
2071
def __ne__(self, other):
2072
return not self == other
2074
def get_branch_format(self):
2075
if self._branch_format is None:
2076
from bzrlib.branch import BranchFormat
2077
self._branch_format = BranchFormat.get_default_format()
2078
return self._branch_format
2080
def set_branch_format(self, format):
2081
self._branch_format = format
2083
def require_stacking(self):
2084
if not self.get_branch_format().supports_stacking():
2085
# We need to make a stacked branch, but the default format for the
2086
# target doesn't support stacking. So force a branch that *can*
2088
from bzrlib.branch import BzrBranchFormat7
2089
branch_format = BzrBranchFormat7()
2090
self.set_branch_format(branch_format)
2091
mutter("using %r for stacking" % (branch_format,))
2092
from bzrlib.repofmt import pack_repo
2093
if self.repository_format.rich_root_data:
2094
bzrdir_format_name = '1.6.1-rich-root'
2095
repo_format = pack_repo.RepositoryFormatKnitPack5RichRoot()
2097
bzrdir_format_name = '1.6'
2098
repo_format = pack_repo.RepositoryFormatKnitPack5()
2099
note('Source format does not support stacking, using format:'
2101
bzrdir_format_name, repo_format.get_format_description())
2102
self.repository_format = repo_format
2104
def get_converter(self, format=None):
2105
"""See BzrDirFormat.get_converter()."""
2107
format = BzrDirFormat.get_default_format()
2108
if not isinstance(self, format.__class__):
2109
# converting away from metadir is not implemented
2110
raise NotImplementedError(self.get_converter)
2111
return ConvertMetaToMeta(format)
2113
def get_format_string(self):
2114
"""See BzrDirFormat.get_format_string()."""
2115
return "Bazaar-NG meta directory, format 1\n"
2117
def get_format_description(self):
2118
"""See BzrDirFormat.get_format_description()."""
2119
return "Meta directory format 1"
2121
def _open(self, transport):
2122
"""See BzrDirFormat._open."""
2123
return BzrDirMeta1(transport, self)
2125
def __return_repository_format(self):
2126
"""Circular import protection."""
2127
if getattr(self, '_repository_format', None):
2128
return self._repository_format
2129
from bzrlib.repository import RepositoryFormat
2130
return RepositoryFormat.get_default_format()
2132
def _set_repository_format(self, value):
2133
"""Allow changing the repository format for metadir formats."""
2134
self._repository_format = value
2136
repository_format = property(__return_repository_format,
2137
_set_repository_format)
2139
def _supply_sub_formats_to(self, other_format):
2140
"""Give other_format the same values for sub formats as this has.
2142
This method is expected to be used when parameterising a
2143
RemoteBzrDirFormat instance with the parameters from a
2144
BzrDirMetaFormat1 instance.
2146
:param other_format: other_format is a format which should be
2147
compatible with whatever sub formats are supported by self.
2150
if getattr(self, '_repository_format', None) is not None:
2151
other_format.repository_format = self.repository_format
2152
if self._branch_format is not None:
2153
other_format._branch_format = self._branch_format
2154
if self._workingtree_format is not None:
2155
other_format.workingtree_format = self.workingtree_format
2157
def __get_workingtree_format(self):
2158
if self._workingtree_format is None:
2159
from bzrlib.workingtree import WorkingTreeFormat
2160
self._workingtree_format = WorkingTreeFormat.get_default_format()
2161
return self._workingtree_format
2163
def __set_workingtree_format(self, wt_format):
2164
self._workingtree_format = wt_format
2166
workingtree_format = property(__get_workingtree_format,
2167
__set_workingtree_format)
2170
# Register bzr control format
2171
BzrDirFormat.register_control_format(BzrDirFormat)
2173
# Register bzr formats
2174
BzrDirFormat.register_format(BzrDirFormat4())
2175
BzrDirFormat.register_format(BzrDirFormat5())
2176
BzrDirFormat.register_format(BzrDirFormat6())
2177
__default_format = BzrDirMetaFormat1()
2178
BzrDirFormat.register_format(__default_format)
2179
BzrDirFormat._default_format = __default_format
2182
class Converter(object):
2183
"""Converts a disk format object from one format to another."""
2185
def convert(self, to_convert, pb):
2186
"""Perform the conversion of to_convert, giving feedback via pb.
2188
:param to_convert: The disk object to convert.
2189
:param pb: a progress bar to use for progress information.
2192
def step(self, message):
2193
"""Update the pb by a step."""
2195
self.pb.update(message, self.count, self.total)
2198
class ConvertBzrDir4To5(Converter):
2199
"""Converts format 4 bzr dirs to format 5."""
2202
super(ConvertBzrDir4To5, self).__init__()
2203
self.converted_revs = set()
2204
self.absent_revisions = set()
2208
def convert(self, to_convert, pb):
2209
"""See Converter.convert()."""
2210
self.bzrdir = to_convert
2212
self.pb.note('starting upgrade from format 4 to 5')
2213
if isinstance(self.bzrdir.transport, local.LocalTransport):
2214
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
2215
self._convert_to_weaves()
2216
return BzrDir.open(self.bzrdir.root_transport.base)
2218
def _convert_to_weaves(self):
2219
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2222
stat = self.bzrdir.transport.stat('weaves')
2223
if not S_ISDIR(stat.st_mode):
2224
self.bzrdir.transport.delete('weaves')
2225
self.bzrdir.transport.mkdir('weaves')
2226
except errors.NoSuchFile:
2227
self.bzrdir.transport.mkdir('weaves')
2228
# deliberately not a WeaveFile as we want to build it up slowly.
2229
self.inv_weave = Weave('inventory')
2230
# holds in-memory weaves for all files
2231
self.text_weaves = {}
2232
self.bzrdir.transport.delete('branch-format')
2233
self.branch = self.bzrdir.open_branch()
2234
self._convert_working_inv()
2235
rev_history = self.branch.revision_history()
2236
# to_read is a stack holding the revisions we still need to process;
2237
# appending to it adds new highest-priority revisions
2238
self.known_revisions = set(rev_history)
2239
self.to_read = rev_history[-1:]
2241
rev_id = self.to_read.pop()
2242
if (rev_id not in self.revisions
2243
and rev_id not in self.absent_revisions):
2244
self._load_one_rev(rev_id)
2246
to_import = self._make_order()
2247
for i, rev_id in enumerate(to_import):
2248
self.pb.update('converting revision', i, len(to_import))
2249
self._convert_one_rev(rev_id)
2251
self._write_all_weaves()
2252
self._write_all_revs()
2253
self.pb.note('upgraded to weaves:')
2254
self.pb.note(' %6d revisions and inventories', len(self.revisions))
2255
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
2256
self.pb.note(' %6d texts', self.text_count)
2257
self._cleanup_spare_files_after_format4()
2258
self.branch._transport.put_bytes(
2260
BzrDirFormat5().get_format_string(),
2261
mode=self.bzrdir._get_file_mode())
2263
def _cleanup_spare_files_after_format4(self):
2264
# FIXME working tree upgrade foo.
2265
for n in 'merged-patches', 'pending-merged-patches':
2267
## assert os.path.getsize(p) == 0
2268
self.bzrdir.transport.delete(n)
2269
except errors.NoSuchFile:
2271
self.bzrdir.transport.delete_tree('inventory-store')
2272
self.bzrdir.transport.delete_tree('text-store')
2274
def _convert_working_inv(self):
2275
inv = xml4.serializer_v4.read_inventory(
2276
self.branch._transport.get('inventory'))
2277
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2278
self.branch._transport.put_bytes('inventory', new_inv_xml,
2279
mode=self.bzrdir._get_file_mode())
2281
def _write_all_weaves(self):
2282
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2283
weave_transport = self.bzrdir.transport.clone('weaves')
2284
weaves = WeaveStore(weave_transport, prefixed=False)
2285
transaction = WriteTransaction()
2289
for file_id, file_weave in self.text_weaves.items():
2290
self.pb.update('writing weave', i, len(self.text_weaves))
2291
weaves._put_weave(file_id, file_weave, transaction)
2293
self.pb.update('inventory', 0, 1)
2294
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2295
self.pb.update('inventory', 1, 1)
2299
def _write_all_revs(self):
2300
"""Write all revisions out in new form."""
2301
self.bzrdir.transport.delete_tree('revision-store')
2302
self.bzrdir.transport.mkdir('revision-store')
2303
revision_transport = self.bzrdir.transport.clone('revision-store')
2305
from bzrlib.xml5 import serializer_v5
2306
from bzrlib.repofmt.weaverepo import RevisionTextStore
2307
revision_store = RevisionTextStore(revision_transport,
2308
serializer_v5, False, versionedfile.PrefixMapper(),
2309
lambda:True, lambda:True)
2311
for i, rev_id in enumerate(self.converted_revs):
2312
self.pb.update('write revision', i, len(self.converted_revs))
2313
text = serializer_v5.write_revision_to_string(
2314
self.revisions[rev_id])
2316
revision_store.add_lines(key, None, osutils.split_lines(text))
2320
def _load_one_rev(self, rev_id):
2321
"""Load a revision object into memory.
2323
Any parents not either loaded or abandoned get queued to be
2325
self.pb.update('loading revision',
2326
len(self.revisions),
2327
len(self.known_revisions))
2328
if not self.branch.repository.has_revision(rev_id):
2330
self.pb.note('revision {%s} not present in branch; '
2331
'will be converted as a ghost',
2333
self.absent_revisions.add(rev_id)
2335
rev = self.branch.repository.get_revision(rev_id)
2336
for parent_id in rev.parent_ids:
2337
self.known_revisions.add(parent_id)
2338
self.to_read.append(parent_id)
2339
self.revisions[rev_id] = rev
2341
def _load_old_inventory(self, rev_id):
2342
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2343
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2344
inv.revision_id = rev_id
2345
rev = self.revisions[rev_id]
2348
def _load_updated_inventory(self, rev_id):
2349
inv_xml = self.inv_weave.get_text(rev_id)
2350
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2353
def _convert_one_rev(self, rev_id):
2354
"""Convert revision and all referenced objects to new format."""
2355
rev = self.revisions[rev_id]
2356
inv = self._load_old_inventory(rev_id)
2357
present_parents = [p for p in rev.parent_ids
2358
if p not in self.absent_revisions]
2359
self._convert_revision_contents(rev, inv, present_parents)
2360
self._store_new_inv(rev, inv, present_parents)
2361
self.converted_revs.add(rev_id)
2363
def _store_new_inv(self, rev, inv, present_parents):
2364
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2365
new_inv_sha1 = sha_string(new_inv_xml)
2366
self.inv_weave.add_lines(rev.revision_id,
2368
new_inv_xml.splitlines(True))
2369
rev.inventory_sha1 = new_inv_sha1
2371
def _convert_revision_contents(self, rev, inv, present_parents):
2372
"""Convert all the files within a revision.
2374
Also upgrade the inventory to refer to the text revision ids."""
2375
rev_id = rev.revision_id
2376
mutter('converting texts of revision {%s}',
2378
parent_invs = map(self._load_updated_inventory, present_parents)
2379
entries = inv.iter_entries()
2381
for path, ie in entries:
2382
self._convert_file_version(rev, ie, parent_invs)
2384
def _convert_file_version(self, rev, ie, parent_invs):
2385
"""Convert one version of one file.
2387
The file needs to be added into the weave if it is a merge
2388
of >=2 parents or if it's changed from its parent.
2390
file_id = ie.file_id
2391
rev_id = rev.revision_id
2392
w = self.text_weaves.get(file_id)
2395
self.text_weaves[file_id] = w
2396
text_changed = False
2397
parent_candiate_entries = ie.parent_candidates(parent_invs)
2398
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2399
# XXX: Note that this is unordered - and this is tolerable because
2400
# the previous code was also unordered.
2401
previous_entries = dict((head, parent_candiate_entries[head]) for head
2403
self.snapshot_ie(previous_entries, ie, w, rev_id)
2406
@symbol_versioning.deprecated_method(symbol_versioning.one_one)
2407
def get_parents(self, revision_ids):
2408
for revision_id in revision_ids:
2409
yield self.revisions[revision_id].parent_ids
2411
def get_parent_map(self, revision_ids):
2412
"""See graph._StackedParentsProvider.get_parent_map"""
2413
return dict((revision_id, self.revisions[revision_id])
2414
for revision_id in revision_ids
2415
if revision_id in self.revisions)
2417
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2418
# TODO: convert this logic, which is ~= snapshot to
2419
# a call to:. This needs the path figured out. rather than a work_tree
2420
# a v4 revision_tree can be given, or something that looks enough like
2421
# one to give the file content to the entry if it needs it.
2422
# and we need something that looks like a weave store for snapshot to
2424
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2425
if len(previous_revisions) == 1:
2426
previous_ie = previous_revisions.values()[0]
2427
if ie._unchanged(previous_ie):
2428
ie.revision = previous_ie.revision
2431
text = self.branch.repository._text_store.get(ie.text_id)
2432
file_lines = text.readlines()
2433
w.add_lines(rev_id, previous_revisions, file_lines)
2434
self.text_count += 1
2436
w.add_lines(rev_id, previous_revisions, [])
2437
ie.revision = rev_id
2439
def _make_order(self):
2440
"""Return a suitable order for importing revisions.
2442
The order must be such that an revision is imported after all
2443
its (present) parents.
2445
todo = set(self.revisions.keys())
2446
done = self.absent_revisions.copy()
2449
# scan through looking for a revision whose parents
2451
for rev_id in sorted(list(todo)):
2452
rev = self.revisions[rev_id]
2453
parent_ids = set(rev.parent_ids)
2454
if parent_ids.issubset(done):
2455
# can take this one now
2456
order.append(rev_id)
2462
class ConvertBzrDir5To6(Converter):
2463
"""Converts format 5 bzr dirs to format 6."""
2465
def convert(self, to_convert, pb):
2466
"""See Converter.convert()."""
2467
self.bzrdir = to_convert
2469
self.pb.note('starting upgrade from format 5 to 6')
2470
self._convert_to_prefixed()
2471
return BzrDir.open(self.bzrdir.root_transport.base)
2473
def _convert_to_prefixed(self):
2474
from bzrlib.store import TransportStore
2475
self.bzrdir.transport.delete('branch-format')
2476
for store_name in ["weaves", "revision-store"]:
2477
self.pb.note("adding prefixes to %s" % store_name)
2478
store_transport = self.bzrdir.transport.clone(store_name)
2479
store = TransportStore(store_transport, prefixed=True)
2480
for urlfilename in store_transport.list_dir('.'):
2481
filename = urlutils.unescape(urlfilename)
2482
if (filename.endswith(".weave") or
2483
filename.endswith(".gz") or
2484
filename.endswith(".sig")):
2485
file_id, suffix = os.path.splitext(filename)
2489
new_name = store._mapper.map((file_id,)) + suffix
2490
# FIXME keep track of the dirs made RBC 20060121
2492
store_transport.move(filename, new_name)
2493
except errors.NoSuchFile: # catches missing dirs strangely enough
2494
store_transport.mkdir(osutils.dirname(new_name))
2495
store_transport.move(filename, new_name)
2496
self.bzrdir.transport.put_bytes(
2498
BzrDirFormat6().get_format_string(),
2499
mode=self.bzrdir._get_file_mode())
2502
class ConvertBzrDir6ToMeta(Converter):
2503
"""Converts format 6 bzr dirs to metadirs."""
2505
def convert(self, to_convert, pb):
2506
"""See Converter.convert()."""
2507
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2508
from bzrlib.branch import BzrBranchFormat5
2509
self.bzrdir = to_convert
2512
self.total = 20 # the steps we know about
2513
self.garbage_inventories = []
2514
self.dir_mode = self.bzrdir._get_dir_mode()
2515
self.file_mode = self.bzrdir._get_file_mode()
2517
self.pb.note('starting upgrade from format 6 to metadir')
2518
self.bzrdir.transport.put_bytes(
2520
"Converting to format 6",
2521
mode=self.file_mode)
2522
# its faster to move specific files around than to open and use the apis...
2523
# first off, nuke ancestry.weave, it was never used.
2525
self.step('Removing ancestry.weave')
2526
self.bzrdir.transport.delete('ancestry.weave')
2527
except errors.NoSuchFile:
2529
# find out whats there
2530
self.step('Finding branch files')
2531
last_revision = self.bzrdir.open_branch().last_revision()
2532
bzrcontents = self.bzrdir.transport.list_dir('.')
2533
for name in bzrcontents:
2534
if name.startswith('basis-inventory.'):
2535
self.garbage_inventories.append(name)
2536
# create new directories for repository, working tree and branch
2537
repository_names = [('inventory.weave', True),
2538
('revision-store', True),
2540
self.step('Upgrading repository ')
2541
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2542
self.make_lock('repository')
2543
# we hard code the formats here because we are converting into
2544
# the meta format. The meta format upgrader can take this to a
2545
# future format within each component.
2546
self.put_format('repository', RepositoryFormat7())
2547
for entry in repository_names:
2548
self.move_entry('repository', entry)
2550
self.step('Upgrading branch ')
2551
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2552
self.make_lock('branch')
2553
self.put_format('branch', BzrBranchFormat5())
2554
branch_files = [('revision-history', True),
2555
('branch-name', True),
2557
for entry in branch_files:
2558
self.move_entry('branch', entry)
2560
checkout_files = [('pending-merges', True),
2561
('inventory', True),
2562
('stat-cache', False)]
2563
# If a mandatory checkout file is not present, the branch does not have
2564
# a functional checkout. Do not create a checkout in the converted
2566
for name, mandatory in checkout_files:
2567
if mandatory and name not in bzrcontents:
2568
has_checkout = False
2572
if not has_checkout:
2573
self.pb.note('No working tree.')
2574
# If some checkout files are there, we may as well get rid of them.
2575
for name, mandatory in checkout_files:
2576
if name in bzrcontents:
2577
self.bzrdir.transport.delete(name)
2579
from bzrlib.workingtree import WorkingTreeFormat3
2580
self.step('Upgrading working tree')
2581
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2582
self.make_lock('checkout')
2584
'checkout', WorkingTreeFormat3())
2585
self.bzrdir.transport.delete_multi(
2586
self.garbage_inventories, self.pb)
2587
for entry in checkout_files:
2588
self.move_entry('checkout', entry)
2589
if last_revision is not None:
2590
self.bzrdir.transport.put_bytes(
2591
'checkout/last-revision', last_revision)
2592
self.bzrdir.transport.put_bytes(
2594
BzrDirMetaFormat1().get_format_string(),
2595
mode=self.file_mode)
2596
return BzrDir.open(self.bzrdir.root_transport.base)
2598
def make_lock(self, name):
2599
"""Make a lock for the new control dir name."""
2600
self.step('Make %s lock' % name)
2601
ld = lockdir.LockDir(self.bzrdir.transport,
2603
file_modebits=self.file_mode,
2604
dir_modebits=self.dir_mode)
2607
def move_entry(self, new_dir, entry):
2608
"""Move then entry name into new_dir."""
2610
mandatory = entry[1]
2611
self.step('Moving %s' % name)
2613
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2614
except errors.NoSuchFile:
2618
def put_format(self, dirname, format):
2619
self.bzrdir.transport.put_bytes('%s/format' % dirname,
2620
format.get_format_string(),
2624
class ConvertMetaToMeta(Converter):
2625
"""Converts the components of metadirs."""
2627
def __init__(self, target_format):
2628
"""Create a metadir to metadir converter.
2630
:param target_format: The final metadir format that is desired.
2632
self.target_format = target_format
2634
def convert(self, to_convert, pb):
2635
"""See Converter.convert()."""
2636
self.bzrdir = to_convert
2640
self.step('checking repository format')
2642
repo = self.bzrdir.open_repository()
2643
except errors.NoRepositoryPresent:
2646
if not isinstance(repo._format, self.target_format.repository_format.__class__):
2647
from bzrlib.repository import CopyConverter
2648
self.pb.note('starting repository conversion')
2649
converter = CopyConverter(self.target_format.repository_format)
2650
converter.convert(repo, pb)
2652
branch = self.bzrdir.open_branch()
2653
except errors.NotBranchError:
2656
# TODO: conversions of Branch and Tree should be done by
2657
# InterXFormat lookups/some sort of registry.
2658
# Avoid circular imports
2659
from bzrlib import branch as _mod_branch
2660
old = branch._format.__class__
2661
new = self.target_format.get_branch_format().__class__
2663
if (old == _mod_branch.BzrBranchFormat5 and
2664
new in (_mod_branch.BzrBranchFormat6,
2665
_mod_branch.BzrBranchFormat7)):
2666
branch_converter = _mod_branch.Converter5to6()
2667
elif (old == _mod_branch.BzrBranchFormat6 and
2668
new == _mod_branch.BzrBranchFormat7):
2669
branch_converter = _mod_branch.Converter6to7()
2671
raise errors.BadConversionTarget("No converter", new)
2672
branch_converter.convert(branch)
2673
branch = self.bzrdir.open_branch()
2674
old = branch._format.__class__
2676
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
2677
except (errors.NoWorkingTree, errors.NotLocalUrl):
2680
# TODO: conversions of Branch and Tree should be done by
2681
# InterXFormat lookups
2682
if (isinstance(tree, workingtree.WorkingTree3) and
2683
not isinstance(tree, workingtree_4.DirStateWorkingTree) and
2684
isinstance(self.target_format.workingtree_format,
2685
workingtree_4.DirStateWorkingTreeFormat)):
2686
workingtree_4.Converter3to4().convert(tree)
2687
if (isinstance(tree, workingtree_4.DirStateWorkingTree) and
2688
not isinstance(tree, workingtree_4.WorkingTree5) and
2689
isinstance(self.target_format.workingtree_format,
2690
workingtree_4.WorkingTreeFormat5)):
2691
workingtree_4.Converter4to5().convert(tree)
2695
# This is not in remote.py because it's small, and needs to be registered.
2696
# Putting it in remote.py creates a circular import problem.
2697
# we can make it a lazy object if the control formats is turned into something
2699
class RemoteBzrDirFormat(BzrDirMetaFormat1):
2700
"""Format representing bzrdirs accessed via a smart server"""
2702
def get_format_description(self):
2703
return 'bzr remote bzrdir'
2705
def get_format_string(self):
2706
raise NotImplementedError(self.get_format_string)
2709
def probe_transport(klass, transport):
2710
"""Return a RemoteBzrDirFormat object if it looks possible."""
2712
medium = transport.get_smart_medium()
2713
except (NotImplementedError, AttributeError,
2714
errors.TransportNotPossible, errors.NoSmartMedium,
2715
errors.SmartProtocolError):
2716
# no smart server, so not a branch for this format type.
2717
raise errors.NotBranchError(path=transport.base)
2719
# Decline to open it if the server doesn't support our required
2720
# version (3) so that the VFS-based transport will do it.
2721
if medium.should_probe():
2723
server_version = medium.protocol_version()
2724
except errors.SmartProtocolError:
2725
# Apparently there's no usable smart server there, even though
2726
# the medium supports the smart protocol.
2727
raise errors.NotBranchError(path=transport.base)
2728
if server_version != '2':
2729
raise errors.NotBranchError(path=transport.base)
2732
def initialize_on_transport(self, transport):
2734
# hand off the request to the smart server
2735
client_medium = transport.get_smart_medium()
2736
except errors.NoSmartMedium:
2737
# TODO: lookup the local format from a server hint.
2738
local_dir_format = BzrDirMetaFormat1()
2739
return local_dir_format.initialize_on_transport(transport)
2740
client = _SmartClient(client_medium)
2741
path = client.remote_path_from_transport(transport)
2742
response = client.call('BzrDirFormat.initialize', path)
2743
if response[0] != 'ok':
2744
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
2745
format = RemoteBzrDirFormat()
2746
self._supply_sub_formats_to(format)
2747
return remote.RemoteBzrDir(transport, format)
2749
def _open(self, transport):
2750
return remote.RemoteBzrDir(transport, self)
2752
def __eq__(self, other):
2753
if not isinstance(other, RemoteBzrDirFormat):
2755
return self.get_format_description() == other.get_format_description()
2757
def __return_repository_format(self):
2758
# Always return a RemoteRepositoryFormat object, but if a specific bzr
2759
# repository format has been asked for, tell the RemoteRepositoryFormat
2760
# that it should use that for init() etc.
2761
result = remote.RemoteRepositoryFormat()
2762
custom_format = getattr(self, '_repository_format', None)
2764
# We will use the custom format to create repositories over the
2765
# wire; expose its details like rich_root_data for code to query
2766
if isinstance(custom_format, remote.RemoteRepositoryFormat):
2767
result._custom_format = custom_format._custom_format
2769
result._custom_format = custom_format
2770
result.rich_root_data = custom_format.rich_root_data
2773
def get_branch_format(self):
2774
result = BzrDirMetaFormat1.get_branch_format(self)
2775
if not isinstance(result, remote.RemoteBranchFormat):
2776
new_result = remote.RemoteBranchFormat()
2777
new_result._custom_format = result
2779
self.set_branch_format(new_result)
2783
repository_format = property(__return_repository_format,
2784
BzrDirMetaFormat1._set_repository_format) #.im_func)
2787
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
2790
class BzrDirFormatInfo(object):
2792
def __init__(self, native, deprecated, hidden, experimental):
2793
self.deprecated = deprecated
2794
self.native = native
2795
self.hidden = hidden
2796
self.experimental = experimental
2799
class BzrDirFormatRegistry(registry.Registry):
2800
"""Registry of user-selectable BzrDir subformats.
2802
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
2803
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
2807
"""Create a BzrDirFormatRegistry."""
2808
self._aliases = set()
2809
self._registration_order = list()
2810
super(BzrDirFormatRegistry, self).__init__()
2813
"""Return a set of the format names which are aliases."""
2814
return frozenset(self._aliases)
2816
def register_metadir(self, key,
2817
repository_format, help, native=True, deprecated=False,
2823
"""Register a metadir subformat.
2825
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
2826
by the Repository format.
2828
:param repository_format: The fully-qualified repository format class
2830
:param branch_format: Fully-qualified branch format class name as
2832
:param tree_format: Fully-qualified tree format class name as
2835
# This should be expanded to support setting WorkingTree and Branch
2836
# formats, once BzrDirMetaFormat1 supports that.
2837
def _load(full_name):
2838
mod_name, factory_name = full_name.rsplit('.', 1)
2840
mod = __import__(mod_name, globals(), locals(),
2842
except ImportError, e:
2843
raise ImportError('failed to load %s: %s' % (full_name, e))
2845
factory = getattr(mod, factory_name)
2846
except AttributeError:
2847
raise AttributeError('no factory %s in module %r'
2852
bd = BzrDirMetaFormat1()
2853
if branch_format is not None:
2854
bd.set_branch_format(_load(branch_format))
2855
if tree_format is not None:
2856
bd.workingtree_format = _load(tree_format)
2857
if repository_format is not None:
2858
bd.repository_format = _load(repository_format)
2860
self.register(key, helper, help, native, deprecated, hidden,
2861
experimental, alias)
2863
def register(self, key, factory, help, native=True, deprecated=False,
2864
hidden=False, experimental=False, alias=False):
2865
"""Register a BzrDirFormat factory.
2867
The factory must be a callable that takes one parameter: the key.
2868
It must produce an instance of the BzrDirFormat when called.
2870
This function mainly exists to prevent the info object from being
2873
registry.Registry.register(self, key, factory, help,
2874
BzrDirFormatInfo(native, deprecated, hidden, experimental))
2876
self._aliases.add(key)
2877
self._registration_order.append(key)
2879
def register_lazy(self, key, module_name, member_name, help, native=True,
2880
deprecated=False, hidden=False, experimental=False, alias=False):
2881
registry.Registry.register_lazy(self, key, module_name, member_name,
2882
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
2884
self._aliases.add(key)
2885
self._registration_order.append(key)
2887
def set_default(self, key):
2888
"""Set the 'default' key to be a clone of the supplied key.
2890
This method must be called once and only once.
2892
registry.Registry.register(self, 'default', self.get(key),
2893
self.get_help(key), info=self.get_info(key))
2894
self._aliases.add('default')
2896
def set_default_repository(self, key):
2897
"""Set the FormatRegistry default and Repository default.
2899
This is a transitional method while Repository.set_default_format
2902
if 'default' in self:
2903
self.remove('default')
2904
self.set_default(key)
2905
format = self.get('default')()
2907
def make_bzrdir(self, key):
2908
return self.get(key)()
2910
def help_topic(self, topic):
2912
default_realkey = None
2913
default_help = self.get_help('default')
2915
for key in self._registration_order:
2916
if key == 'default':
2918
help = self.get_help(key)
2919
if help == default_help:
2920
default_realkey = key
2922
help_pairs.append((key, help))
2924
def wrapped(key, help, info):
2926
help = '(native) ' + help
2927
return ':%s:\n%s\n\n' % (key,
2928
textwrap.fill(help, initial_indent=' ',
2929
subsequent_indent=' '))
2930
if default_realkey is not None:
2931
output += wrapped(default_realkey, '(default) %s' % default_help,
2932
self.get_info('default'))
2933
deprecated_pairs = []
2934
experimental_pairs = []
2935
for key, help in help_pairs:
2936
info = self.get_info(key)
2939
elif info.deprecated:
2940
deprecated_pairs.append((key, help))
2941
elif info.experimental:
2942
experimental_pairs.append((key, help))
2944
output += wrapped(key, help, info)
2945
output += "\nSee ``bzr help formats`` for more about storage formats."
2947
if len(experimental_pairs) > 0:
2948
other_output += "Experimental formats are shown below.\n\n"
2949
for key, help in experimental_pairs:
2950
info = self.get_info(key)
2951
other_output += wrapped(key, help, info)
2954
"No experimental formats are available.\n\n"
2955
if len(deprecated_pairs) > 0:
2956
other_output += "\nDeprecated formats are shown below.\n\n"
2957
for key, help in deprecated_pairs:
2958
info = self.get_info(key)
2959
other_output += wrapped(key, help, info)
2962
"\nNo deprecated formats are available.\n\n"
2964
"\nSee ``bzr help formats`` for more about storage formats."
2966
if topic == 'other-formats':
2972
class RepositoryAcquisitionPolicy(object):
2973
"""Abstract base class for repository acquisition policies.
2975
A repository acquisition policy decides how a BzrDir acquires a repository
2976
for a branch that is being created. The most basic policy decision is
2977
whether to create a new repository or use an existing one.
2979
def __init__(self, stack_on, stack_on_pwd, require_stacking):
2982
:param stack_on: A location to stack on
2983
:param stack_on_pwd: If stack_on is relative, the location it is
2985
:param require_stacking: If True, it is a failure to not stack.
2987
self._stack_on = stack_on
2988
self._stack_on_pwd = stack_on_pwd
2989
self._require_stacking = require_stacking
2991
def configure_branch(self, branch):
2992
"""Apply any configuration data from this policy to the branch.
2994
Default implementation sets repository stacking.
2996
if self._stack_on is None:
2998
if self._stack_on_pwd is None:
2999
stack_on = self._stack_on
3002
stack_on = urlutils.rebase_url(self._stack_on,
3004
branch.bzrdir.root_transport.base)
3005
except errors.InvalidRebaseURLs:
3006
stack_on = self._get_full_stack_on()
3008
branch.set_stacked_on_url(stack_on)
3009
except errors.UnstackableBranchFormat:
3010
if self._require_stacking:
3013
def _get_full_stack_on(self):
3014
"""Get a fully-qualified URL for the stack_on location."""
3015
if self._stack_on is None:
3017
if self._stack_on_pwd is None:
3018
return self._stack_on
3020
return urlutils.join(self._stack_on_pwd, self._stack_on)
3022
def _add_fallback(self, repository, possible_transports=None):
3023
"""Add a fallback to the supplied repository, if stacking is set."""
3024
stack_on = self._get_full_stack_on()
3025
if stack_on is None:
3027
stacked_dir = BzrDir.open(stack_on,
3028
possible_transports=possible_transports)
3030
stacked_repo = stacked_dir.open_branch().repository
3031
except errors.NotBranchError:
3032
stacked_repo = stacked_dir.open_repository()
3034
repository.add_fallback_repository(stacked_repo)
3035
except errors.UnstackableRepositoryFormat:
3036
if self._require_stacking:
3039
self._require_stacking = True
3041
def acquire_repository(self, make_working_trees=None, shared=False):
3042
"""Acquire a repository for this bzrdir.
3044
Implementations may create a new repository or use a pre-exising
3046
:param make_working_trees: If creating a repository, set
3047
make_working_trees to this value (if non-None)
3048
:param shared: If creating a repository, make it shared if True
3049
:return: A repository
3051
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
3054
class CreateRepository(RepositoryAcquisitionPolicy):
3055
"""A policy of creating a new repository"""
3057
def __init__(self, bzrdir, stack_on=None, stack_on_pwd=None,
3058
require_stacking=False):
3061
:param bzrdir: The bzrdir to create the repository on.
3062
:param stack_on: A location to stack on
3063
:param stack_on_pwd: If stack_on is relative, the location it is
3066
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3068
self._bzrdir = bzrdir
3070
def acquire_repository(self, make_working_trees=None, shared=False):
3071
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3073
Creates the desired repository in the bzrdir we already have.
3075
repository = self._bzrdir.create_repository(shared=shared)
3076
self._add_fallback(repository,
3077
possible_transports=[self._bzrdir.transport])
3078
if make_working_trees is not None:
3079
repository.set_make_working_trees(make_working_trees)
3083
class UseExistingRepository(RepositoryAcquisitionPolicy):
3084
"""A policy of reusing an existing repository"""
3086
def __init__(self, repository, stack_on=None, stack_on_pwd=None,
3087
require_stacking=False):
3090
:param repository: The repository to use.
3091
:param stack_on: A location to stack on
3092
:param stack_on_pwd: If stack_on is relative, the location it is
3095
RepositoryAcquisitionPolicy.__init__(self, stack_on, stack_on_pwd,
3097
self._repository = repository
3099
def acquire_repository(self, make_working_trees=None, shared=False):
3100
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
3102
Returns an existing repository to use
3104
self._add_fallback(self._repository,
3105
possible_transports=[self._repository.bzrdir.transport])
3106
return self._repository
3109
# Please register new formats after old formats so that formats
3110
# appear in chronological order and format descriptions can build
3112
format_registry = BzrDirFormatRegistry()
3113
# The pre-0.8 formats have their repository format network name registered in
3114
# repository.py. MetaDir formats have their repository format network name
3115
# inferred from their disk format string.
3116
format_registry.register('weave', BzrDirFormat6,
3117
'Pre-0.8 format. Slower than knit and does not'
3118
' support checkouts or shared repositories.',
3120
format_registry.register_metadir('metaweave',
3121
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
3122
'Transitional format in 0.8. Slower than knit.',
3123
branch_format='bzrlib.branch.BzrBranchFormat5',
3124
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3126
format_registry.register_metadir('knit',
3127
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3128
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
3129
branch_format='bzrlib.branch.BzrBranchFormat5',
3130
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
3132
format_registry.register_metadir('dirstate',
3133
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3134
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
3135
'above when accessed over the network.',
3136
branch_format='bzrlib.branch.BzrBranchFormat5',
3137
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
3138
# directly from workingtree_4 triggers a circular import.
3139
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3141
format_registry.register_metadir('dirstate-tags',
3142
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
3143
help='New in 0.15: Fast local operations and improved scaling for '
3144
'network operations. Additionally adds support for tags.'
3145
' Incompatible with bzr < 0.15.',
3146
branch_format='bzrlib.branch.BzrBranchFormat6',
3147
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3149
format_registry.register_metadir('rich-root',
3150
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
3151
help='New in 1.0. Better handling of tree roots. Incompatible with'
3153
branch_format='bzrlib.branch.BzrBranchFormat6',
3154
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3156
format_registry.register_metadir('dirstate-with-subtree',
3157
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
3158
help='New in 0.15: Fast local operations and improved scaling for '
3159
'network operations. Additionally adds support for versioning nested '
3160
'bzr branches. Incompatible with bzr < 0.15.',
3161
branch_format='bzrlib.branch.BzrBranchFormat6',
3162
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3166
format_registry.register_metadir('pack-0.92',
3167
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
3168
help='New in 0.92: Pack-based format with data compatible with '
3169
'dirstate-tags format repositories. Interoperates with '
3170
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3171
'Previously called knitpack-experimental. '
3172
'For more information, see '
3173
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3174
branch_format='bzrlib.branch.BzrBranchFormat6',
3175
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3177
format_registry.register_metadir('pack-0.92-subtree',
3178
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
3179
help='New in 0.92: Pack-based format with data compatible with '
3180
'dirstate-with-subtree format repositories. Interoperates with '
3181
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
3182
'Previously called knitpack-experimental. '
3183
'For more information, see '
3184
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
3185
branch_format='bzrlib.branch.BzrBranchFormat6',
3186
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3190
format_registry.register_metadir('rich-root-pack',
3191
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
3192
help='New in 1.0: A variant of pack-0.92 that supports rich-root data '
3193
'(needed for bzr-svn).',
3194
branch_format='bzrlib.branch.BzrBranchFormat6',
3195
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3197
format_registry.register_metadir('1.6',
3198
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5',
3199
help='A format that allows a branch to indicate that there is another '
3200
'(stacked) repository that should be used to access data that is '
3201
'not present locally.',
3202
branch_format='bzrlib.branch.BzrBranchFormat7',
3203
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3205
format_registry.register_metadir('1.6.1-rich-root',
3206
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack5RichRoot',
3207
help='A variant of 1.6 that supports rich-root data '
3208
'(needed for bzr-svn).',
3209
branch_format='bzrlib.branch.BzrBranchFormat7',
3210
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3212
format_registry.register_metadir('1.9',
3213
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3214
help='A repository format using B+tree indexes. These indexes '
3215
'are smaller in size, have smarter caching and provide faster '
3216
'performance for most operations.',
3217
branch_format='bzrlib.branch.BzrBranchFormat7',
3218
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3220
format_registry.register_metadir('1.9-rich-root',
3221
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3222
help='A variant of 1.9 that supports rich-root data '
3223
'(needed for bzr-svn).',
3224
branch_format='bzrlib.branch.BzrBranchFormat7',
3225
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3227
format_registry.register_metadir('development-wt5',
3228
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6',
3229
help='A working-tree format that supports views and content filtering.',
3230
branch_format='bzrlib.branch.BzrBranchFormat7',
3231
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3234
format_registry.register_metadir('development-wt5-rich-root',
3235
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack6RichRoot',
3236
help='A variant of development-wt5 that supports rich-root data '
3237
'(needed for bzr-svn).',
3238
branch_format='bzrlib.branch.BzrBranchFormat7',
3239
tree_format='bzrlib.workingtree.WorkingTreeFormat5',
3242
# The following two formats should always just be aliases.
3243
format_registry.register_metadir('development',
3244
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2',
3245
help='Current development format. Can convert data to and from pack-0.92 '
3246
'(and anything compatible with pack-0.92) format repositories. '
3247
'Repositories and branches in this format can only be read by bzr.dev. '
3249
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3251
branch_format='bzrlib.branch.BzrBranchFormat7',
3252
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3256
format_registry.register_metadir('development-subtree',
3257
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3258
help='Current development format, subtree variant. Can convert data to and '
3259
'from pack-0.92-subtree (and anything compatible with '
3260
'pack-0.92-subtree) format repositories. Repositories and branches in '
3261
'this format can only be read by bzr.dev. Please read '
3262
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3264
branch_format='bzrlib.branch.BzrBranchFormat7',
3265
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3269
# And the development formats above will have aliased one of the following:
3270
format_registry.register_metadir('development2',
3271
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2',
3272
help='1.6.1 with B+Tree based index. '
3274
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3276
branch_format='bzrlib.branch.BzrBranchFormat7',
3277
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3281
format_registry.register_metadir('development2-subtree',
3282
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment2Subtree',
3283
help='1.6.1-subtree with B+Tree based index. '
3285
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
3287
branch_format='bzrlib.branch.BzrBranchFormat7',
3288
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
3292
# The current format that is made on 'bzr init'.
3293
format_registry.set_default('pack-0.92')
added
removed
bzrlib/bzrdir.py
