1
# Copyright (C) 2005, 2006, 2007 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
23
# TODO: remove unittest dependency; put that stuff inside the test suite
25
# TODO: Can we move specific formats into separate modules to make this file
28
from cStringIO import StringIO
32
from bzrlib.lazy_import import lazy_import
33
lazy_import(globals(), """
34
from copy import deepcopy
35
from stat import S_ISDIR
45
revision as _mod_revision,
54
from bzrlib.osutils import (
59
from bzrlib.smart.client import _SmartClient
60
from bzrlib.smart import protocol
61
from bzrlib.store.revision.text import TextRevisionStore
62
from bzrlib.store.text import TextStore
63
from bzrlib.store.versioned import WeaveStore
64
from bzrlib.transactions import WriteTransaction
65
from bzrlib.transport import (
66
do_catching_redirections,
69
from bzrlib.weave import Weave
72
from bzrlib.trace import (
76
from bzrlib.transport.local import LocalTransport
80
"""A .bzr control diretory.
82
BzrDir instances let you create or open any of the things that can be
83
found within .bzr - checkouts, branches and repositories.
86
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
88
a transport connected to the directory this bzr was opened from.
92
"""Invoke break_lock on the first object in the bzrdir.
94
If there is a tree, the tree is opened and break_lock() called.
95
Otherwise, branch is tried, and finally repository.
97
# XXX: This seems more like a UI function than something that really
98
# belongs in this class.
100
thing_to_unlock = self.open_workingtree()
101
except (errors.NotLocalUrl, errors.NoWorkingTree):
103
thing_to_unlock = self.open_branch()
104
except errors.NotBranchError:
106
thing_to_unlock = self.open_repository()
107
except errors.NoRepositoryPresent:
109
thing_to_unlock.break_lock()
111
def can_convert_format(self):
112
"""Return true if this bzrdir is one whose format we can convert from."""
115
def check_conversion_target(self, target_format):
116
target_repo_format = target_format.repository_format
117
source_repo_format = self._format.repository_format
118
source_repo_format.check_conversion_target(target_repo_format)
121
def _check_supported(format, allow_unsupported,
122
recommend_upgrade=True,
124
"""Give an error or warning on old formats.
126
:param format: may be any kind of format - workingtree, branch,
129
:param allow_unsupported: If true, allow opening
130
formats that are strongly deprecated, and which may
131
have limited functionality.
133
:param recommend_upgrade: If true (default), warn
134
the user through the ui object that they may wish
135
to upgrade the object.
137
# TODO: perhaps move this into a base Format class; it's not BzrDir
138
# specific. mbp 20070323
139
if not allow_unsupported and not format.is_supported():
140
# see open_downlevel to open legacy branches.
141
raise errors.UnsupportedFormatError(format=format)
142
if recommend_upgrade \
143
and getattr(format, 'upgrade_recommended', False):
144
ui.ui_factory.recommend_upgrade(
145
format.get_format_description(),
148
def clone(self, url, revision_id=None, force_new_repo=False):
149
"""Clone this bzrdir and its contents to url verbatim.
151
If urls last component does not exist, it will be created.
153
if revision_id is not None, then the clone operation may tune
154
itself to download less data.
155
:param force_new_repo: Do not use a shared repository for the target
156
even if one is available.
159
result = self._format.initialize(url)
161
local_repo = self.find_repository()
162
except errors.NoRepositoryPresent:
165
# may need to copy content in
167
result_repo = local_repo.clone(
169
revision_id=revision_id)
170
result_repo.set_make_working_trees(local_repo.make_working_trees())
173
result_repo = result.find_repository()
174
# fetch content this dir needs.
175
result_repo.fetch(local_repo, revision_id=revision_id)
176
except errors.NoRepositoryPresent:
177
# needed to make one anyway.
178
result_repo = local_repo.clone(
180
revision_id=revision_id)
181
result_repo.set_make_working_trees(local_repo.make_working_trees())
182
# 1 if there is a branch present
183
# make sure its content is available in the target repository
186
self.open_branch().clone(result, revision_id=revision_id)
187
except errors.NotBranchError:
190
self.open_workingtree().clone(result)
191
except (errors.NoWorkingTree, errors.NotLocalUrl):
195
# TODO: This should be given a Transport, and should chdir up; otherwise
196
# this will open a new connection.
197
def _make_tail(self, url):
198
head, tail = urlutils.split(url)
199
if tail and tail != '.':
200
t = get_transport(head)
203
except errors.FileExists:
206
# TODO: Should take a Transport
208
def create(cls, base, format=None):
209
"""Create a new BzrDir at the url 'base'.
211
This will call the current default formats initialize with base
212
as the only parameter.
214
:param format: If supplied, the format of branch to create. If not
215
supplied, the default is used.
217
if cls is not BzrDir:
218
raise AssertionError("BzrDir.create always creates the default"
219
" format, not one of %r" % cls)
220
head, tail = urlutils.split(base)
221
if tail and tail != '.':
222
t = get_transport(head)
225
except errors.FileExists:
228
format = BzrDirFormat.get_default_format()
229
return format.initialize(safe_unicode(base))
231
def create_branch(self):
232
"""Create a branch in this BzrDir.
234
The bzrdirs format will control what branch format is created.
235
For more control see BranchFormatXX.create(a_bzrdir).
237
raise NotImplementedError(self.create_branch)
240
def create_branch_and_repo(base, force_new_repo=False, format=None):
241
"""Create a new BzrDir, Branch and Repository at the url 'base'.
243
This will use the current default BzrDirFormat, and use whatever
244
repository format that that uses via bzrdir.create_branch and
245
create_repository. If a shared repository is available that is used
248
The created Branch object is returned.
250
:param base: The URL to create the branch at.
251
:param force_new_repo: If True a new repository is always created.
253
bzrdir = BzrDir.create(base, format)
254
bzrdir._find_or_create_repository(force_new_repo)
255
return bzrdir.create_branch()
257
def _find_or_create_repository(self, force_new_repo):
258
"""Create a new repository if needed, returning the repository."""
260
return self.create_repository()
262
return self.find_repository()
263
except errors.NoRepositoryPresent:
264
return self.create_repository()
267
def create_branch_convenience(base, force_new_repo=False,
268
force_new_tree=None, format=None):
269
"""Create a new BzrDir, Branch and Repository at the url 'base'.
271
This is a convenience function - it will use an existing repository
272
if possible, can be told explicitly whether to create a working tree or
275
This will use the current default BzrDirFormat, and use whatever
276
repository format that that uses via bzrdir.create_branch and
277
create_repository. If a shared repository is available that is used
278
preferentially. Whatever repository is used, its tree creation policy
281
The created Branch object is returned.
282
If a working tree cannot be made due to base not being a file:// url,
283
no error is raised unless force_new_tree is True, in which case no
284
data is created on disk and NotLocalUrl is raised.
286
:param base: The URL to create the branch at.
287
:param force_new_repo: If True a new repository is always created.
288
:param force_new_tree: If True or False force creation of a tree or
289
prevent such creation respectively.
290
:param format: Override for the for the bzrdir format to create
293
# check for non local urls
294
t = get_transport(safe_unicode(base))
295
if not isinstance(t, LocalTransport):
296
raise errors.NotLocalUrl(base)
297
bzrdir = BzrDir.create(base, format)
298
repo = bzrdir._find_or_create_repository(force_new_repo)
299
result = bzrdir.create_branch()
300
if force_new_tree or (repo.make_working_trees() and
301
force_new_tree is None):
303
bzrdir.create_workingtree()
304
except errors.NotLocalUrl:
309
def create_repository(base, shared=False, format=None):
310
"""Create a new BzrDir and Repository at the url 'base'.
312
If no format is supplied, this will default to the current default
313
BzrDirFormat by default, and use whatever repository format that that
314
uses for bzrdirformat.create_repository.
316
:param shared: Create a shared repository rather than a standalone
318
The Repository object is returned.
320
This must be overridden as an instance method in child classes, where
321
it should take no parameters and construct whatever repository format
322
that child class desires.
324
bzrdir = BzrDir.create(base, format)
325
return bzrdir.create_repository(shared)
328
def create_standalone_workingtree(base, format=None):
329
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
331
'base' must be a local path or a file:// url.
333
This will use the current default BzrDirFormat, and use whatever
334
repository format that that uses for bzrdirformat.create_workingtree,
335
create_branch and create_repository.
337
:return: The WorkingTree object.
339
t = get_transport(safe_unicode(base))
340
if not isinstance(t, LocalTransport):
341
raise errors.NotLocalUrl(base)
342
bzrdir = BzrDir.create_branch_and_repo(safe_unicode(base),
344
format=format).bzrdir
345
return bzrdir.create_workingtree()
347
def create_workingtree(self, revision_id=None):
348
"""Create a working tree at this BzrDir.
350
revision_id: create it as of this revision id.
352
raise NotImplementedError(self.create_workingtree)
354
def retire_bzrdir(self):
355
"""Permanently disable the bzrdir.
357
This is done by renaming it to give the user some ability to recover
358
if there was a problem.
360
This will have horrible consequences if anyone has anything locked or
363
for i in xrange(10000):
365
to_path = '.bzr.retired.%d' % i
366
self.root_transport.rename('.bzr', to_path)
367
note("renamed %s to %s"
368
% (self.root_transport.abspath('.bzr'), to_path))
370
except (errors.TransportError, IOError, errors.PathError):
373
def destroy_workingtree(self):
374
"""Destroy the working tree at this BzrDir.
376
Formats that do not support this may raise UnsupportedOperation.
378
raise NotImplementedError(self.destroy_workingtree)
380
def destroy_workingtree_metadata(self):
381
"""Destroy the control files for the working tree at this BzrDir.
383
The contents of working tree files are not affected.
384
Formats that do not support this may raise UnsupportedOperation.
386
raise NotImplementedError(self.destroy_workingtree_metadata)
388
def find_repository(self):
389
"""Find the repository that should be used for a_bzrdir.
391
This does not require a branch as we use it to find the repo for
392
new branches as well as to hook existing branches up to their
396
return self.open_repository()
397
except errors.NoRepositoryPresent:
399
next_transport = self.root_transport.clone('..')
401
# find the next containing bzrdir
403
found_bzrdir = BzrDir.open_containing_from_transport(
405
except errors.NotBranchError:
407
raise errors.NoRepositoryPresent(self)
408
# does it have a repository ?
410
repository = found_bzrdir.open_repository()
411
except errors.NoRepositoryPresent:
412
next_transport = found_bzrdir.root_transport.clone('..')
413
if (found_bzrdir.root_transport.base == next_transport.base):
414
# top of the file system
418
if ((found_bzrdir.root_transport.base ==
419
self.root_transport.base) or repository.is_shared()):
422
raise errors.NoRepositoryPresent(self)
423
raise errors.NoRepositoryPresent(self)
425
def get_branch_reference(self):
426
"""Return the referenced URL for the branch in this bzrdir.
428
:raises NotBranchError: If there is no Branch.
429
:return: The URL the branch in this bzrdir references if it is a
430
reference branch, or None for regular branches.
434
def get_branch_transport(self, branch_format):
435
"""Get the transport for use by branch format in this BzrDir.
437
Note that bzr dirs that do not support format strings will raise
438
IncompatibleFormat if the branch format they are given has
439
a format string, and vice versa.
441
If branch_format is None, the transport is returned with no
442
checking. if it is not None, then the returned transport is
443
guaranteed to point to an existing directory ready for use.
445
raise NotImplementedError(self.get_branch_transport)
447
def get_repository_transport(self, repository_format):
448
"""Get the transport for use by repository format in this BzrDir.
450
Note that bzr dirs that do not support format strings will raise
451
IncompatibleFormat if the repository format they are given has
452
a format string, and vice versa.
454
If repository_format is None, the transport is returned with no
455
checking. if it is not None, then the returned transport is
456
guaranteed to point to an existing directory ready for use.
458
raise NotImplementedError(self.get_repository_transport)
460
def get_workingtree_transport(self, tree_format):
461
"""Get the transport for use by workingtree format in this BzrDir.
463
Note that bzr dirs that do not support format strings will raise
464
IncompatibleFormat if the workingtree format they are given has a
465
format string, and vice versa.
467
If workingtree_format is None, the transport is returned with no
468
checking. if it is not None, then the returned transport is
469
guaranteed to point to an existing directory ready for use.
471
raise NotImplementedError(self.get_workingtree_transport)
473
def __init__(self, _transport, _format):
474
"""Initialize a Bzr control dir object.
476
Only really common logic should reside here, concrete classes should be
477
made with varying behaviours.
479
:param _format: the format that is creating this BzrDir instance.
480
:param _transport: the transport this dir is based at.
482
self._format = _format
483
self.transport = _transport.clone('.bzr')
484
self.root_transport = _transport
486
def is_control_filename(self, filename):
487
"""True if filename is the name of a path which is reserved for bzrdir's.
489
:param filename: A filename within the root transport of this bzrdir.
491
This is true IF and ONLY IF the filename is part of the namespace reserved
492
for bzr control dirs. Currently this is the '.bzr' directory in the root
493
of the root_transport. it is expected that plugins will need to extend
494
this in the future - for instance to make bzr talk with svn working
497
# this might be better on the BzrDirFormat class because it refers to
498
# all the possible bzrdir disk formats.
499
# This method is tested via the workingtree is_control_filename tests-
500
# it was extracted from WorkingTree.is_control_filename. If the methods
501
# contract is extended beyond the current trivial implementation please
502
# add new tests for it to the appropriate place.
503
return filename == '.bzr' or filename.startswith('.bzr/')
505
def needs_format_conversion(self, format=None):
506
"""Return true if this bzrdir needs convert_format run on it.
508
For instance, if the repository format is out of date but the
509
branch and working tree are not, this should return True.
511
:param format: Optional parameter indicating a specific desired
512
format we plan to arrive at.
514
raise NotImplementedError(self.needs_format_conversion)
517
def open_unsupported(base):
518
"""Open a branch which is not supported."""
519
return BzrDir.open(base, _unsupported=True)
522
def open(base, _unsupported=False):
523
"""Open an existing bzrdir, rooted at 'base' (url)
525
_unsupported is a private parameter to the BzrDir class.
527
t = get_transport(base)
528
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
531
def open_from_transport(transport, _unsupported=False,
532
_server_formats=True):
533
"""Open a bzrdir within a particular directory.
535
:param transport: Transport containing the bzrdir.
536
:param _unsupported: private.
538
base = transport.base
540
def find_format(transport):
541
return transport, BzrDirFormat.find_format(
542
transport, _server_formats=_server_formats)
544
def redirected(transport, e, redirection_notice):
545
qualified_source = e.get_source_url()
546
relpath = transport.relpath(qualified_source)
547
if not e.target.endswith(relpath):
548
# Not redirected to a branch-format, not a branch
549
raise errors.NotBranchError(path=e.target)
550
target = e.target[:-len(relpath)]
551
note('%s is%s redirected to %s',
552
transport.base, e.permanently, target)
553
# Let's try with a new transport
554
qualified_target = e.get_target_url()[:-len(relpath)]
555
# FIXME: If 'transport' has a qualifier, this should
556
# be applied again to the new transport *iff* the
557
# schemes used are the same. It's a bit tricky to
558
# verify, so I'll punt for now
560
return get_transport(target)
563
transport, format = do_catching_redirections(find_format,
566
except errors.TooManyRedirections:
567
raise errors.NotBranchError(base)
569
BzrDir._check_supported(format, _unsupported)
570
return format.open(transport, _found=True)
572
def open_branch(self, unsupported=False):
573
"""Open the branch object at this BzrDir if one is present.
575
If unsupported is True, then no longer supported branch formats can
578
TODO: static convenience version of this?
580
raise NotImplementedError(self.open_branch)
583
def open_containing(url):
584
"""Open an existing branch which contains url.
586
:param url: url to search from.
587
See open_containing_from_transport for more detail.
589
return BzrDir.open_containing_from_transport(get_transport(url))
592
def open_containing_from_transport(a_transport):
593
"""Open an existing branch which contains a_transport.base
595
This probes for a branch at a_transport, and searches upwards from there.
597
Basically we keep looking up until we find the control directory or
598
run into the root. If there isn't one, raises NotBranchError.
599
If there is one and it is either an unrecognised format or an unsupported
600
format, UnknownFormatError or UnsupportedFormatError are raised.
601
If there is one, it is returned, along with the unused portion of url.
603
:return: The BzrDir that contains the path, and a Unicode path
604
for the rest of the URL.
606
# this gets the normalised url back. I.e. '.' -> the full path.
607
url = a_transport.base
610
result = BzrDir.open_from_transport(a_transport)
611
return result, urlutils.unescape(a_transport.relpath(url))
612
except errors.NotBranchError, e:
615
new_t = a_transport.clone('..')
616
except errors.InvalidURLJoin:
617
# reached the root, whatever that may be
618
raise errors.NotBranchError(path=url)
619
if new_t.base == a_transport.base:
620
# reached the root, whatever that may be
621
raise errors.NotBranchError(path=url)
625
def open_containing_tree_or_branch(klass, location):
626
"""Return the branch and working tree contained by a location.
628
Returns (tree, branch, relpath).
629
If there is no tree at containing the location, tree will be None.
630
If there is no branch containing the location, an exception will be
632
relpath is the portion of the path that is contained by the branch.
634
bzrdir, relpath = klass.open_containing(location)
636
tree = bzrdir.open_workingtree()
637
except (errors.NoWorkingTree, errors.NotLocalUrl):
639
branch = bzrdir.open_branch()
642
return tree, branch, relpath
644
def open_repository(self, _unsupported=False):
645
"""Open the repository object at this BzrDir if one is present.
647
This will not follow the Branch object pointer - its strictly a direct
648
open facility. Most client code should use open_branch().repository to
651
_unsupported is a private parameter, not part of the api.
652
TODO: static convenience version of this?
654
raise NotImplementedError(self.open_repository)
656
def open_workingtree(self, _unsupported=False,
657
recommend_upgrade=True):
658
"""Open the workingtree object at this BzrDir if one is present.
660
:param recommend_upgrade: Optional keyword parameter, when True (the
661
default), emit through the ui module a recommendation that the user
662
upgrade the working tree when the workingtree being opened is old
663
(but still fully supported).
665
raise NotImplementedError(self.open_workingtree)
667
def has_branch(self):
668
"""Tell if this bzrdir contains a branch.
670
Note: if you're going to open the branch, you should just go ahead
671
and try, and not ask permission first. (This method just opens the
672
branch and discards it, and that's somewhat expensive.)
677
except errors.NotBranchError:
680
def has_workingtree(self):
681
"""Tell if this bzrdir contains a working tree.
683
This will still raise an exception if the bzrdir has a workingtree that
684
is remote & inaccessible.
686
Note: if you're going to open the working tree, you should just go ahead
687
and try, and not ask permission first. (This method just opens the
688
workingtree and discards it, and that's somewhat expensive.)
691
self.open_workingtree(recommend_upgrade=False)
693
except errors.NoWorkingTree:
696
def _cloning_metadir(self):
697
"""Produce a metadir suitable for cloning with"""
698
result_format = self._format.__class__()
701
branch = self.open_branch()
702
source_repository = branch.repository
703
except errors.NotBranchError:
705
source_repository = self.open_repository()
706
except errors.NoRepositoryPresent:
707
source_repository = None
709
# XXX TODO: This isinstance is here because we have not implemented
710
# the fix recommended in bug # 103195 - to delegate this choice the
712
repo_format = source_repository._format
713
if not isinstance(repo_format, remote.RemoteRepositoryFormat):
714
result_format.repository_format = repo_format
716
# TODO: Couldn't we just probe for the format in these cases,
717
# rather than opening the whole tree? It would be a little
718
# faster. mbp 20070401
719
tree = self.open_workingtree(recommend_upgrade=False)
720
except (errors.NoWorkingTree, errors.NotLocalUrl):
721
result_format.workingtree_format = None
723
result_format.workingtree_format = tree._format.__class__()
724
return result_format, source_repository
726
def cloning_metadir(self):
727
"""Produce a metadir suitable for cloning or sprouting with.
729
These operations may produce workingtrees (yes, even though they're
730
"cloning" something that doesn't have a tree, so a viable workingtree
731
format must be selected.
733
format, repository = self._cloning_metadir()
734
if format._workingtree_format is None:
735
if repository is None:
737
tree_format = repository._format._matchingbzrdir.workingtree_format
738
format.workingtree_format = tree_format.__class__()
741
def checkout_metadir(self):
742
return self.cloning_metadir()
744
def sprout(self, url, revision_id=None, force_new_repo=False,
746
"""Create a copy of this bzrdir prepared for use as a new line of
749
If urls last component does not exist, it will be created.
751
Attributes related to the identity of the source branch like
752
branch nickname will be cleaned, a working tree is created
753
whether one existed before or not; and a local branch is always
756
if revision_id is not None, then the clone operation may tune
757
itself to download less data.
760
cloning_format = self.cloning_metadir()
761
result = cloning_format.initialize(url)
763
source_branch = self.open_branch()
764
source_repository = source_branch.repository
765
except errors.NotBranchError:
768
source_repository = self.open_repository()
769
except errors.NoRepositoryPresent:
770
source_repository = None
775
result_repo = result.find_repository()
776
except errors.NoRepositoryPresent:
778
if source_repository is None and result_repo is not None:
780
elif source_repository is None and result_repo is None:
781
# no repo available, make a new one
782
result.create_repository()
783
elif source_repository is not None and result_repo is None:
784
# have source, and want to make a new target repo
785
result_repo = source_repository.sprout(result, revision_id=revision_id)
787
# fetch needed content into target.
788
if source_repository is not None:
790
# source_repository.copy_content_into(result_repo, revision_id=revision_id)
791
# so we can override the copy method
792
result_repo.fetch(source_repository, revision_id=revision_id)
793
if source_branch is not None:
794
source_branch.sprout(result, revision_id=revision_id)
796
result.create_branch()
797
# TODO: jam 20060426 we probably need a test in here in the
798
# case that the newly sprouted branch is a remote one
799
if result_repo is None or result_repo.make_working_trees():
800
wt = result.create_workingtree()
803
if wt.path2id('') is None:
805
wt.set_root_id(self.open_workingtree.get_root_id())
806
except errors.NoWorkingTree:
812
if recurse == 'down':
814
basis = wt.basis_tree()
816
subtrees = basis.iter_references()
817
recurse_branch = wt.branch
818
elif source_branch is not None:
819
basis = source_branch.basis_tree()
821
subtrees = basis.iter_references()
822
recurse_branch = source_branch
827
for path, file_id in subtrees:
828
target = urlutils.join(url, urlutils.escape(path))
829
sublocation = source_branch.reference_parent(file_id, path)
830
sublocation.bzrdir.sprout(target,
831
basis.get_reference_revision(file_id, path),
832
force_new_repo=force_new_repo, recurse=recurse)
834
if basis is not None:
839
class BzrDirPreSplitOut(BzrDir):
840
"""A common class for the all-in-one formats."""
842
def __init__(self, _transport, _format):
843
"""See BzrDir.__init__."""
844
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
845
assert self._format._lock_class == lockable_files.TransportLock
846
assert self._format._lock_file_name == 'branch-lock'
847
self._control_files = lockable_files.LockableFiles(
848
self.get_branch_transport(None),
849
self._format._lock_file_name,
850
self._format._lock_class)
852
def break_lock(self):
853
"""Pre-splitout bzrdirs do not suffer from stale locks."""
854
raise NotImplementedError(self.break_lock)
856
def clone(self, url, revision_id=None, force_new_repo=False):
857
"""See BzrDir.clone()."""
858
from bzrlib.workingtree import WorkingTreeFormat2
860
result = self._format._initialize_for_clone(url)
861
self.open_repository().clone(result, revision_id=revision_id)
862
from_branch = self.open_branch()
863
from_branch.clone(result, revision_id=revision_id)
865
self.open_workingtree().clone(result)
866
except errors.NotLocalUrl:
867
# make a new one, this format always has to have one.
869
WorkingTreeFormat2().initialize(result)
870
except errors.NotLocalUrl:
871
# but we cannot do it for remote trees.
872
to_branch = result.open_branch()
873
WorkingTreeFormat2().stub_initialize_remote(to_branch.control_files)
876
def create_branch(self):
877
"""See BzrDir.create_branch."""
878
return self.open_branch()
880
def create_repository(self, shared=False):
881
"""See BzrDir.create_repository."""
883
raise errors.IncompatibleFormat('shared repository', self._format)
884
return self.open_repository()
886
def create_workingtree(self, revision_id=None):
887
"""See BzrDir.create_workingtree."""
888
# this looks buggy but is not -really-
889
# because this format creates the workingtree when the bzrdir is
891
# clone and sprout will have set the revision_id
892
# and that will have set it for us, its only
893
# specific uses of create_workingtree in isolation
894
# that can do wonky stuff here, and that only
895
# happens for creating checkouts, which cannot be
896
# done on this format anyway. So - acceptable wart.
897
result = self.open_workingtree(recommend_upgrade=False)
898
if revision_id is not None:
899
if revision_id == _mod_revision.NULL_REVISION:
900
result.set_parent_ids([])
902
result.set_parent_ids([revision_id])
905
def destroy_workingtree(self):
906
"""See BzrDir.destroy_workingtree."""
907
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
909
def destroy_workingtree_metadata(self):
910
"""See BzrDir.destroy_workingtree_metadata."""
911
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
914
def get_branch_transport(self, branch_format):
915
"""See BzrDir.get_branch_transport()."""
916
if branch_format is None:
917
return self.transport
919
branch_format.get_format_string()
920
except NotImplementedError:
921
return self.transport
922
raise errors.IncompatibleFormat(branch_format, self._format)
924
def get_repository_transport(self, repository_format):
925
"""See BzrDir.get_repository_transport()."""
926
if repository_format is None:
927
return self.transport
929
repository_format.get_format_string()
930
except NotImplementedError:
931
return self.transport
932
raise errors.IncompatibleFormat(repository_format, self._format)
934
def get_workingtree_transport(self, workingtree_format):
935
"""See BzrDir.get_workingtree_transport()."""
936
if workingtree_format is None:
937
return self.transport
939
workingtree_format.get_format_string()
940
except NotImplementedError:
941
return self.transport
942
raise errors.IncompatibleFormat(workingtree_format, self._format)
944
def needs_format_conversion(self, format=None):
945
"""See BzrDir.needs_format_conversion()."""
946
# if the format is not the same as the system default,
947
# an upgrade is needed.
949
format = BzrDirFormat.get_default_format()
950
return not isinstance(self._format, format.__class__)
952
def open_branch(self, unsupported=False):
953
"""See BzrDir.open_branch."""
954
from bzrlib.branch import BzrBranchFormat4
955
format = BzrBranchFormat4()
956
self._check_supported(format, unsupported)
957
return format.open(self, _found=True)
959
def sprout(self, url, revision_id=None, force_new_repo=False):
960
"""See BzrDir.sprout()."""
961
from bzrlib.workingtree import WorkingTreeFormat2
963
result = self._format._initialize_for_clone(url)
965
self.open_repository().clone(result, revision_id=revision_id)
966
except errors.NoRepositoryPresent:
969
self.open_branch().sprout(result, revision_id=revision_id)
970
except errors.NotBranchError:
972
# we always want a working tree
973
WorkingTreeFormat2().initialize(result)
977
class BzrDir4(BzrDirPreSplitOut):
978
"""A .bzr version 4 control object.
980
This is a deprecated format and may be removed after sept 2006.
983
def create_repository(self, shared=False):
984
"""See BzrDir.create_repository."""
985
return self._format.repository_format.initialize(self, shared)
987
def needs_format_conversion(self, format=None):
988
"""Format 4 dirs are always in need of conversion."""
991
def open_repository(self):
992
"""See BzrDir.open_repository."""
993
from bzrlib.repofmt.weaverepo import RepositoryFormat4
994
return RepositoryFormat4().open(self, _found=True)
997
class BzrDir5(BzrDirPreSplitOut):
998
"""A .bzr version 5 control object.
1000
This is a deprecated format and may be removed after sept 2006.
1003
def open_repository(self):
1004
"""See BzrDir.open_repository."""
1005
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1006
return RepositoryFormat5().open(self, _found=True)
1008
def open_workingtree(self, _unsupported=False,
1009
recommend_upgrade=True):
1010
"""See BzrDir.create_workingtree."""
1011
from bzrlib.workingtree import WorkingTreeFormat2
1012
wt_format = WorkingTreeFormat2()
1013
# we don't warn here about upgrades; that ought to be handled for the
1015
return wt_format.open(self, _found=True)
1018
class BzrDir6(BzrDirPreSplitOut):
1019
"""A .bzr version 6 control object.
1021
This is a deprecated format and may be removed after sept 2006.
1024
def open_repository(self):
1025
"""See BzrDir.open_repository."""
1026
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1027
return RepositoryFormat6().open(self, _found=True)
1029
def open_workingtree(self, _unsupported=False,
1030
recommend_upgrade=True):
1031
"""See BzrDir.create_workingtree."""
1032
# we don't warn here about upgrades; that ought to be handled for the
1034
from bzrlib.workingtree import WorkingTreeFormat2
1035
return WorkingTreeFormat2().open(self, _found=True)
1038
class BzrDirMeta1(BzrDir):
1039
"""A .bzr meta version 1 control object.
1041
This is the first control object where the
1042
individual aspects are really split out: there are separate repository,
1043
workingtree and branch subdirectories and any subset of the three can be
1044
present within a BzrDir.
1047
def can_convert_format(self):
1048
"""See BzrDir.can_convert_format()."""
1051
def create_branch(self):
1052
"""See BzrDir.create_branch."""
1053
return self._format.get_branch_format().initialize(self)
1055
def create_repository(self, shared=False):
1056
"""See BzrDir.create_repository."""
1057
return self._format.repository_format.initialize(self, shared)
1059
def create_workingtree(self, revision_id=None):
1060
"""See BzrDir.create_workingtree."""
1061
from bzrlib.workingtree import WorkingTreeFormat
1062
return self._format.workingtree_format.initialize(self, revision_id)
1064
def destroy_workingtree(self):
1065
"""See BzrDir.destroy_workingtree."""
1066
wt = self.open_workingtree(recommend_upgrade=False)
1067
repository = wt.branch.repository
1068
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1069
wt.revert([], old_tree=empty)
1070
self.destroy_workingtree_metadata()
1072
def destroy_workingtree_metadata(self):
1073
self.transport.delete_tree('checkout')
1075
def find_branch_format(self):
1076
"""Find the branch 'format' for this bzrdir.
1078
This might be a synthetic object for e.g. RemoteBranch and SVN.
1080
from bzrlib.branch import BranchFormat
1081
return BranchFormat.find_format(self)
1083
def _get_mkdir_mode(self):
1084
"""Figure out the mode to use when creating a bzrdir subdir."""
1085
temp_control = lockable_files.LockableFiles(self.transport, '',
1086
lockable_files.TransportLock)
1087
return temp_control._dir_mode
1089
def get_branch_reference(self):
1090
"""See BzrDir.get_branch_reference()."""
1091
from bzrlib.branch import BranchFormat
1092
format = BranchFormat.find_format(self)
1093
return format.get_reference(self)
1095
def get_branch_transport(self, branch_format):
1096
"""See BzrDir.get_branch_transport()."""
1097
if branch_format is None:
1098
return self.transport.clone('branch')
1100
branch_format.get_format_string()
1101
except NotImplementedError:
1102
raise errors.IncompatibleFormat(branch_format, self._format)
1104
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1105
except errors.FileExists:
1107
return self.transport.clone('branch')
1109
def get_repository_transport(self, repository_format):
1110
"""See BzrDir.get_repository_transport()."""
1111
if repository_format is None:
1112
return self.transport.clone('repository')
1114
repository_format.get_format_string()
1115
except NotImplementedError:
1116
raise errors.IncompatibleFormat(repository_format, self._format)
1118
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1119
except errors.FileExists:
1121
return self.transport.clone('repository')
1123
def get_workingtree_transport(self, workingtree_format):
1124
"""See BzrDir.get_workingtree_transport()."""
1125
if workingtree_format is None:
1126
return self.transport.clone('checkout')
1128
workingtree_format.get_format_string()
1129
except NotImplementedError:
1130
raise errors.IncompatibleFormat(workingtree_format, self._format)
1132
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1133
except errors.FileExists:
1135
return self.transport.clone('checkout')
1137
def needs_format_conversion(self, format=None):
1138
"""See BzrDir.needs_format_conversion()."""
1140
format = BzrDirFormat.get_default_format()
1141
if not isinstance(self._format, format.__class__):
1142
# it is not a meta dir format, conversion is needed.
1144
# we might want to push this down to the repository?
1146
if not isinstance(self.open_repository()._format,
1147
format.repository_format.__class__):
1148
# the repository needs an upgrade.
1150
except errors.NoRepositoryPresent:
1153
if not isinstance(self.open_branch()._format,
1154
format.get_branch_format().__class__):
1155
# the branch needs an upgrade.
1157
except errors.NotBranchError:
1160
my_wt = self.open_workingtree(recommend_upgrade=False)
1161
if not isinstance(my_wt._format,
1162
format.workingtree_format.__class__):
1163
# the workingtree needs an upgrade.
1165
except (errors.NoWorkingTree, errors.NotLocalUrl):
1169
def open_branch(self, unsupported=False):
1170
"""See BzrDir.open_branch."""
1171
format = self.find_branch_format()
1172
self._check_supported(format, unsupported)
1173
return format.open(self, _found=True)
1175
def open_repository(self, unsupported=False):
1176
"""See BzrDir.open_repository."""
1177
from bzrlib.repository import RepositoryFormat
1178
format = RepositoryFormat.find_format(self)
1179
self._check_supported(format, unsupported)
1180
return format.open(self, _found=True)
1182
def open_workingtree(self, unsupported=False,
1183
recommend_upgrade=True):
1184
"""See BzrDir.open_workingtree."""
1185
from bzrlib.workingtree import WorkingTreeFormat
1186
format = WorkingTreeFormat.find_format(self)
1187
self._check_supported(format, unsupported,
1189
basedir=self.root_transport.base)
1190
return format.open(self, _found=True)
1193
class BzrDirFormat(object):
1194
"""An encapsulation of the initialization and open routines for a format.
1196
Formats provide three things:
1197
* An initialization routine,
1201
Formats are placed in an dict by their format string for reference
1202
during bzrdir opening. These should be subclasses of BzrDirFormat
1205
Once a format is deprecated, just deprecate the initialize and open
1206
methods on the format class. Do not deprecate the object, as the
1207
object will be created every system load.
1210
_default_format = None
1211
"""The default format used for new .bzr dirs."""
1214
"""The known formats."""
1216
_control_formats = []
1217
"""The registered control formats - .bzr, ....
1219
This is a list of BzrDirFormat objects.
1222
_control_server_formats = []
1223
"""The registered control server formats, e.g. RemoteBzrDirs.
1225
This is a list of BzrDirFormat objects.
1228
_lock_file_name = 'branch-lock'
1230
# _lock_class must be set in subclasses to the lock type, typ.
1231
# TransportLock or LockDir
1234
def find_format(klass, transport, _server_formats=True):
1235
"""Return the format present at transport."""
1237
formats = klass._control_server_formats + klass._control_formats
1239
formats = klass._control_formats
1240
for format in formats:
1242
return format.probe_transport(transport)
1243
except errors.NotBranchError:
1244
# this format does not find a control dir here.
1246
raise errors.NotBranchError(path=transport.base)
1249
def probe_transport(klass, transport):
1250
"""Return the .bzrdir style format present in a directory."""
1252
format_string = transport.get(".bzr/branch-format").read()
1253
except errors.NoSuchFile:
1254
raise errors.NotBranchError(path=transport.base)
1257
return klass._formats[format_string]
1259
raise errors.UnknownFormatError(format=format_string)
1262
def get_default_format(klass):
1263
"""Return the current default format."""
1264
return klass._default_format
1266
def get_format_string(self):
1267
"""Return the ASCII format string that identifies this format."""
1268
raise NotImplementedError(self.get_format_string)
1270
def get_format_description(self):
1271
"""Return the short description for this format."""
1272
raise NotImplementedError(self.get_format_description)
1274
def get_converter(self, format=None):
1275
"""Return the converter to use to convert bzrdirs needing converts.
1277
This returns a bzrlib.bzrdir.Converter object.
1279
This should return the best upgrader to step this format towards the
1280
current default format. In the case of plugins we can/should provide
1281
some means for them to extend the range of returnable converters.
1283
:param format: Optional format to override the default format of the
1286
raise NotImplementedError(self.get_converter)
1288
def initialize(self, url):
1289
"""Create a bzr control dir at this url and return an opened copy.
1291
Subclasses should typically override initialize_on_transport
1292
instead of this method.
1294
return self.initialize_on_transport(get_transport(url))
1296
def initialize_on_transport(self, transport):
1297
"""Initialize a new bzrdir in the base directory of a Transport."""
1298
# Since we don't have a .bzr directory, inherit the
1299
# mode from the root directory
1300
temp_control = lockable_files.LockableFiles(transport,
1301
'', lockable_files.TransportLock)
1302
temp_control._transport.mkdir('.bzr',
1303
# FIXME: RBC 20060121 don't peek under
1305
mode=temp_control._dir_mode)
1306
file_mode = temp_control._file_mode
1308
mutter('created control directory in ' + transport.base)
1309
control = transport.clone('.bzr')
1310
utf8_files = [('README',
1311
"This is a Bazaar-NG control directory.\n"
1312
"Do not change any files in this directory.\n"),
1313
('branch-format', self.get_format_string()),
1315
# NB: no need to escape relative paths that are url safe.
1316
control_files = lockable_files.LockableFiles(control,
1317
self._lock_file_name, self._lock_class)
1318
control_files.create_lock()
1319
control_files.lock_write()
1321
for file, content in utf8_files:
1322
control_files.put_utf8(file, content)
1324
control_files.unlock()
1325
return self.open(transport, _found=True)
1327
def is_supported(self):
1328
"""Is this format supported?
1330
Supported formats must be initializable and openable.
1331
Unsupported formats may not support initialization or committing or
1332
some other features depending on the reason for not being supported.
1336
def same_model(self, target_format):
1337
return (self.repository_format.rich_root_data ==
1338
target_format.rich_root_data)
1341
def known_formats(klass):
1342
"""Return all the known formats.
1344
Concrete formats should override _known_formats.
1346
# There is double indirection here to make sure that control
1347
# formats used by more than one dir format will only be probed
1348
# once. This can otherwise be quite expensive for remote connections.
1350
for format in klass._control_formats:
1351
result.update(format._known_formats())
1355
def _known_formats(klass):
1356
"""Return the known format instances for this control format."""
1357
return set(klass._formats.values())
1359
def open(self, transport, _found=False):
1360
"""Return an instance of this format for the dir transport points at.
1362
_found is a private parameter, do not use it.
1365
found_format = BzrDirFormat.find_format(transport)
1366
if not isinstance(found_format, self.__class__):
1367
raise AssertionError("%s was asked to open %s, but it seems to need "
1369
% (self, transport, found_format))
1370
return self._open(transport)
1372
def _open(self, transport):
1373
"""Template method helper for opening BzrDirectories.
1375
This performs the actual open and any additional logic or parameter
1378
raise NotImplementedError(self._open)
1381
def register_format(klass, format):
1382
klass._formats[format.get_format_string()] = format
1385
def register_control_format(klass, format):
1386
"""Register a format that does not use '.bzr' for its control dir.
1388
TODO: This should be pulled up into a 'ControlDirFormat' base class
1389
which BzrDirFormat can inherit from, and renamed to register_format
1390
there. It has been done without that for now for simplicity of
1393
klass._control_formats.append(format)
1396
def register_control_server_format(klass, format):
1397
"""Register a control format for client-server environments.
1399
These formats will be tried before ones registered with
1400
register_control_format. This gives implementations that decide to the
1401
chance to grab it before anything looks at the contents of the format
1404
klass._control_server_formats.append(format)
1407
@symbol_versioning.deprecated_method(symbol_versioning.zero_fourteen)
1408
def set_default_format(klass, format):
1409
klass._set_default_format(format)
1412
def _set_default_format(klass, format):
1413
"""Set default format (for testing behavior of defaults only)"""
1414
klass._default_format = format
1417
return self.get_format_string()[:-1]
1420
def unregister_format(klass, format):
1421
assert klass._formats[format.get_format_string()] is format
1422
del klass._formats[format.get_format_string()]
1425
def unregister_control_format(klass, format):
1426
klass._control_formats.remove(format)
1429
class BzrDirFormat4(BzrDirFormat):
1430
"""Bzr dir format 4.
1432
This format is a combined format for working tree, branch and repository.
1434
- Format 1 working trees [always]
1435
- Format 4 branches [always]
1436
- Format 4 repositories [always]
1438
This format is deprecated: it indexes texts using a text it which is
1439
removed in format 5; write support for this format has been removed.
1442
_lock_class = lockable_files.TransportLock
1444
def get_format_string(self):
1445
"""See BzrDirFormat.get_format_string()."""
1446
return "Bazaar-NG branch, format 0.0.4\n"
1448
def get_format_description(self):
1449
"""See BzrDirFormat.get_format_description()."""
1450
return "All-in-one format 4"
1452
def get_converter(self, format=None):
1453
"""See BzrDirFormat.get_converter()."""
1454
# there is one and only one upgrade path here.
1455
return ConvertBzrDir4To5()
1457
def initialize_on_transport(self, transport):
1458
"""Format 4 branches cannot be created."""
1459
raise errors.UninitializableFormat(self)
1461
def is_supported(self):
1462
"""Format 4 is not supported.
1464
It is not supported because the model changed from 4 to 5 and the
1465
conversion logic is expensive - so doing it on the fly was not
1470
def _open(self, transport):
1471
"""See BzrDirFormat._open."""
1472
return BzrDir4(transport, self)
1474
def __return_repository_format(self):
1475
"""Circular import protection."""
1476
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1477
return RepositoryFormat4()
1478
repository_format = property(__return_repository_format)
1481
class BzrDirFormat5(BzrDirFormat):
1482
"""Bzr control format 5.
1484
This format is a combined format for working tree, branch and repository.
1486
- Format 2 working trees [always]
1487
- Format 4 branches [always]
1488
- Format 5 repositories [always]
1489
Unhashed stores in the repository.
1492
_lock_class = lockable_files.TransportLock
1494
def get_format_string(self):
1495
"""See BzrDirFormat.get_format_string()."""
1496
return "Bazaar-NG branch, format 5\n"
1498
def get_format_description(self):
1499
"""See BzrDirFormat.get_format_description()."""
1500
return "All-in-one format 5"
1502
def get_converter(self, format=None):
1503
"""See BzrDirFormat.get_converter()."""
1504
# there is one and only one upgrade path here.
1505
return ConvertBzrDir5To6()
1507
def _initialize_for_clone(self, url):
1508
return self.initialize_on_transport(get_transport(url), _cloning=True)
1510
def initialize_on_transport(self, transport, _cloning=False):
1511
"""Format 5 dirs always have working tree, branch and repository.
1513
Except when they are being cloned.
1515
from bzrlib.branch import BzrBranchFormat4
1516
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1517
from bzrlib.workingtree import WorkingTreeFormat2
1518
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1519
RepositoryFormat5().initialize(result, _internal=True)
1521
branch = BzrBranchFormat4().initialize(result)
1523
WorkingTreeFormat2().initialize(result)
1524
except errors.NotLocalUrl:
1525
# Even though we can't access the working tree, we need to
1526
# create its control files.
1527
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1530
def _open(self, transport):
1531
"""See BzrDirFormat._open."""
1532
return BzrDir5(transport, self)
1534
def __return_repository_format(self):
1535
"""Circular import protection."""
1536
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1537
return RepositoryFormat5()
1538
repository_format = property(__return_repository_format)
1541
class BzrDirFormat6(BzrDirFormat):
1542
"""Bzr control format 6.
1544
This format is a combined format for working tree, branch and repository.
1546
- Format 2 working trees [always]
1547
- Format 4 branches [always]
1548
- Format 6 repositories [always]
1551
_lock_class = lockable_files.TransportLock
1553
def get_format_string(self):
1554
"""See BzrDirFormat.get_format_string()."""
1555
return "Bazaar-NG branch, format 6\n"
1557
def get_format_description(self):
1558
"""See BzrDirFormat.get_format_description()."""
1559
return "All-in-one format 6"
1561
def get_converter(self, format=None):
1562
"""See BzrDirFormat.get_converter()."""
1563
# there is one and only one upgrade path here.
1564
return ConvertBzrDir6ToMeta()
1566
def _initialize_for_clone(self, url):
1567
return self.initialize_on_transport(get_transport(url), _cloning=True)
1569
def initialize_on_transport(self, transport, _cloning=False):
1570
"""Format 6 dirs always have working tree, branch and repository.
1572
Except when they are being cloned.
1574
from bzrlib.branch import BzrBranchFormat4
1575
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1576
from bzrlib.workingtree import WorkingTreeFormat2
1577
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1578
RepositoryFormat6().initialize(result, _internal=True)
1580
branch = BzrBranchFormat4().initialize(result)
1582
WorkingTreeFormat2().initialize(result)
1583
except errors.NotLocalUrl:
1584
# Even though we can't access the working tree, we need to
1585
# create its control files.
1586
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1589
def _open(self, transport):
1590
"""See BzrDirFormat._open."""
1591
return BzrDir6(transport, self)
1593
def __return_repository_format(self):
1594
"""Circular import protection."""
1595
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1596
return RepositoryFormat6()
1597
repository_format = property(__return_repository_format)
1600
class BzrDirMetaFormat1(BzrDirFormat):
1601
"""Bzr meta control format 1
1603
This is the first format with split out working tree, branch and repository
1606
- Format 3 working trees [optional]
1607
- Format 5 branches [optional]
1608
- Format 7 repositories [optional]
1611
_lock_class = lockdir.LockDir
1614
self._workingtree_format = None
1615
self._branch_format = None
1617
def __eq__(self, other):
1618
if other.__class__ is not self.__class__:
1620
if other.repository_format != self.repository_format:
1622
if other.workingtree_format != self.workingtree_format:
1626
def __ne__(self, other):
1627
return not self == other
1629
def get_branch_format(self):
1630
if self._branch_format is None:
1631
from bzrlib.branch import BranchFormat
1632
self._branch_format = BranchFormat.get_default_format()
1633
return self._branch_format
1635
def set_branch_format(self, format):
1636
self._branch_format = format
1638
def get_converter(self, format=None):
1639
"""See BzrDirFormat.get_converter()."""
1641
format = BzrDirFormat.get_default_format()
1642
if not isinstance(self, format.__class__):
1643
# converting away from metadir is not implemented
1644
raise NotImplementedError(self.get_converter)
1645
return ConvertMetaToMeta(format)
1647
def get_format_string(self):
1648
"""See BzrDirFormat.get_format_string()."""
1649
return "Bazaar-NG meta directory, format 1\n"
1651
def get_format_description(self):
1652
"""See BzrDirFormat.get_format_description()."""
1653
return "Meta directory format 1"
1655
def _open(self, transport):
1656
"""See BzrDirFormat._open."""
1657
return BzrDirMeta1(transport, self)
1659
def __return_repository_format(self):
1660
"""Circular import protection."""
1661
if getattr(self, '_repository_format', None):
1662
return self._repository_format
1663
from bzrlib.repository import RepositoryFormat
1664
return RepositoryFormat.get_default_format()
1666
def __set_repository_format(self, value):
1667
"""Allow changint the repository format for metadir formats."""
1668
self._repository_format = value
1670
repository_format = property(__return_repository_format, __set_repository_format)
1672
def __get_workingtree_format(self):
1673
if self._workingtree_format is None:
1674
from bzrlib.workingtree import WorkingTreeFormat
1675
self._workingtree_format = WorkingTreeFormat.get_default_format()
1676
return self._workingtree_format
1678
def __set_workingtree_format(self, wt_format):
1679
self._workingtree_format = wt_format
1681
workingtree_format = property(__get_workingtree_format,
1682
__set_workingtree_format)
1685
# Register bzr control format
1686
BzrDirFormat.register_control_format(BzrDirFormat)
1688
# Register bzr formats
1689
BzrDirFormat.register_format(BzrDirFormat4())
1690
BzrDirFormat.register_format(BzrDirFormat5())
1691
BzrDirFormat.register_format(BzrDirFormat6())
1692
__default_format = BzrDirMetaFormat1()
1693
BzrDirFormat.register_format(__default_format)
1694
BzrDirFormat._default_format = __default_format
1697
class BzrDirTestProviderAdapter(object):
1698
"""A tool to generate a suite testing multiple bzrdir formats at once.
1700
This is done by copying the test once for each transport and injecting
1701
the transport_server, transport_readonly_server, and bzrdir_format
1702
classes into each copy. Each copy is also given a new id() to make it
1706
def __init__(self, vfs_factory, transport_server, transport_readonly_server,
1708
"""Create an object to adapt tests.
1710
:param vfs_server: A factory to create a Transport Server which has
1711
all the VFS methods working, and is writable.
1713
self._vfs_factory = vfs_factory
1714
self._transport_server = transport_server
1715
self._transport_readonly_server = transport_readonly_server
1716
self._formats = formats
1718
def adapt(self, test):
1719
result = unittest.TestSuite()
1720
for format in self._formats:
1721
new_test = deepcopy(test)
1722
new_test.vfs_transport_factory = self._vfs_factory
1723
new_test.transport_server = self._transport_server
1724
new_test.transport_readonly_server = self._transport_readonly_server
1725
new_test.bzrdir_format = format
1726
def make_new_test_id():
1727
new_id = "%s(%s)" % (new_test.id(), format.__class__.__name__)
1728
return lambda: new_id
1729
new_test.id = make_new_test_id()
1730
result.addTest(new_test)
1734
class Converter(object):
1735
"""Converts a disk format object from one format to another."""
1737
def convert(self, to_convert, pb):
1738
"""Perform the conversion of to_convert, giving feedback via pb.
1740
:param to_convert: The disk object to convert.
1741
:param pb: a progress bar to use for progress information.
1744
def step(self, message):
1745
"""Update the pb by a step."""
1747
self.pb.update(message, self.count, self.total)
1750
class ConvertBzrDir4To5(Converter):
1751
"""Converts format 4 bzr dirs to format 5."""
1754
super(ConvertBzrDir4To5, self).__init__()
1755
self.converted_revs = set()
1756
self.absent_revisions = set()
1760
def convert(self, to_convert, pb):
1761
"""See Converter.convert()."""
1762
self.bzrdir = to_convert
1764
self.pb.note('starting upgrade from format 4 to 5')
1765
if isinstance(self.bzrdir.transport, LocalTransport):
1766
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
1767
self._convert_to_weaves()
1768
return BzrDir.open(self.bzrdir.root_transport.base)
1770
def _convert_to_weaves(self):
1771
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
1774
stat = self.bzrdir.transport.stat('weaves')
1775
if not S_ISDIR(stat.st_mode):
1776
self.bzrdir.transport.delete('weaves')
1777
self.bzrdir.transport.mkdir('weaves')
1778
except errors.NoSuchFile:
1779
self.bzrdir.transport.mkdir('weaves')
1780
# deliberately not a WeaveFile as we want to build it up slowly.
1781
self.inv_weave = Weave('inventory')
1782
# holds in-memory weaves for all files
1783
self.text_weaves = {}
1784
self.bzrdir.transport.delete('branch-format')
1785
self.branch = self.bzrdir.open_branch()
1786
self._convert_working_inv()
1787
rev_history = self.branch.revision_history()
1788
# to_read is a stack holding the revisions we still need to process;
1789
# appending to it adds new highest-priority revisions
1790
self.known_revisions = set(rev_history)
1791
self.to_read = rev_history[-1:]
1793
rev_id = self.to_read.pop()
1794
if (rev_id not in self.revisions
1795
and rev_id not in self.absent_revisions):
1796
self._load_one_rev(rev_id)
1798
to_import = self._make_order()
1799
for i, rev_id in enumerate(to_import):
1800
self.pb.update('converting revision', i, len(to_import))
1801
self._convert_one_rev(rev_id)
1803
self._write_all_weaves()
1804
self._write_all_revs()
1805
self.pb.note('upgraded to weaves:')
1806
self.pb.note(' %6d revisions and inventories', len(self.revisions))
1807
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
1808
self.pb.note(' %6d texts', self.text_count)
1809
self._cleanup_spare_files_after_format4()
1810
self.branch.control_files.put_utf8('branch-format', BzrDirFormat5().get_format_string())
1812
def _cleanup_spare_files_after_format4(self):
1813
# FIXME working tree upgrade foo.
1814
for n in 'merged-patches', 'pending-merged-patches':
1816
## assert os.path.getsize(p) == 0
1817
self.bzrdir.transport.delete(n)
1818
except errors.NoSuchFile:
1820
self.bzrdir.transport.delete_tree('inventory-store')
1821
self.bzrdir.transport.delete_tree('text-store')
1823
def _convert_working_inv(self):
1824
inv = xml4.serializer_v4.read_inventory(
1825
self.branch.control_files.get('inventory'))
1826
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
1827
# FIXME inventory is a working tree change.
1828
self.branch.control_files.put('inventory', StringIO(new_inv_xml))
1830
def _write_all_weaves(self):
1831
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
1832
weave_transport = self.bzrdir.transport.clone('weaves')
1833
weaves = WeaveStore(weave_transport, prefixed=False)
1834
transaction = WriteTransaction()
1838
for file_id, file_weave in self.text_weaves.items():
1839
self.pb.update('writing weave', i, len(self.text_weaves))
1840
weaves._put_weave(file_id, file_weave, transaction)
1842
self.pb.update('inventory', 0, 1)
1843
controlweaves._put_weave('inventory', self.inv_weave, transaction)
1844
self.pb.update('inventory', 1, 1)
1848
def _write_all_revs(self):
1849
"""Write all revisions out in new form."""
1850
self.bzrdir.transport.delete_tree('revision-store')
1851
self.bzrdir.transport.mkdir('revision-store')
1852
revision_transport = self.bzrdir.transport.clone('revision-store')
1854
_revision_store = TextRevisionStore(TextStore(revision_transport,
1858
transaction = WriteTransaction()
1859
for i, rev_id in enumerate(self.converted_revs):
1860
self.pb.update('write revision', i, len(self.converted_revs))
1861
_revision_store.add_revision(self.revisions[rev_id], transaction)
1865
def _load_one_rev(self, rev_id):
1866
"""Load a revision object into memory.
1868
Any parents not either loaded or abandoned get queued to be
1870
self.pb.update('loading revision',
1871
len(self.revisions),
1872
len(self.known_revisions))
1873
if not self.branch.repository.has_revision(rev_id):
1875
self.pb.note('revision {%s} not present in branch; '
1876
'will be converted as a ghost',
1878
self.absent_revisions.add(rev_id)
1880
rev = self.branch.repository._revision_store.get_revision(rev_id,
1881
self.branch.repository.get_transaction())
1882
for parent_id in rev.parent_ids:
1883
self.known_revisions.add(parent_id)
1884
self.to_read.append(parent_id)
1885
self.revisions[rev_id] = rev
1887
def _load_old_inventory(self, rev_id):
1888
assert rev_id not in self.converted_revs
1889
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
1890
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
1891
inv.revision_id = rev_id
1892
rev = self.revisions[rev_id]
1893
if rev.inventory_sha1:
1894
assert rev.inventory_sha1 == sha_string(old_inv_xml), \
1895
'inventory sha mismatch for {%s}' % rev_id
1898
def _load_updated_inventory(self, rev_id):
1899
assert rev_id in self.converted_revs
1900
inv_xml = self.inv_weave.get_text(rev_id)
1901
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml)
1904
def _convert_one_rev(self, rev_id):
1905
"""Convert revision and all referenced objects to new format."""
1906
rev = self.revisions[rev_id]
1907
inv = self._load_old_inventory(rev_id)
1908
present_parents = [p for p in rev.parent_ids
1909
if p not in self.absent_revisions]
1910
self._convert_revision_contents(rev, inv, present_parents)
1911
self._store_new_weave(rev, inv, present_parents)
1912
self.converted_revs.add(rev_id)
1914
def _store_new_weave(self, rev, inv, present_parents):
1915
# the XML is now updated with text versions
1917
entries = inv.iter_entries()
1919
for path, ie in entries:
1920
assert getattr(ie, 'revision', None) is not None, \
1921
'no revision on {%s} in {%s}' % \
1922
(file_id, rev.revision_id)
1923
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
1924
new_inv_sha1 = sha_string(new_inv_xml)
1925
self.inv_weave.add_lines(rev.revision_id,
1927
new_inv_xml.splitlines(True))
1928
rev.inventory_sha1 = new_inv_sha1
1930
def _convert_revision_contents(self, rev, inv, present_parents):
1931
"""Convert all the files within a revision.
1933
Also upgrade the inventory to refer to the text revision ids."""
1934
rev_id = rev.revision_id
1935
mutter('converting texts of revision {%s}',
1937
parent_invs = map(self._load_updated_inventory, present_parents)
1938
entries = inv.iter_entries()
1940
for path, ie in entries:
1941
self._convert_file_version(rev, ie, parent_invs)
1943
def _convert_file_version(self, rev, ie, parent_invs):
1944
"""Convert one version of one file.
1946
The file needs to be added into the weave if it is a merge
1947
of >=2 parents or if it's changed from its parent.
1949
file_id = ie.file_id
1950
rev_id = rev.revision_id
1951
w = self.text_weaves.get(file_id)
1954
self.text_weaves[file_id] = w
1955
text_changed = False
1956
previous_entries = ie.find_previous_heads(parent_invs,
1960
for old_revision in previous_entries:
1961
# if this fails, its a ghost ?
1962
assert old_revision in self.converted_revs, \
1963
"Revision {%s} not in converted_revs" % old_revision
1964
self.snapshot_ie(previous_entries, ie, w, rev_id)
1966
assert getattr(ie, 'revision', None) is not None
1968
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
1969
# TODO: convert this logic, which is ~= snapshot to
1970
# a call to:. This needs the path figured out. rather than a work_tree
1971
# a v4 revision_tree can be given, or something that looks enough like
1972
# one to give the file content to the entry if it needs it.
1973
# and we need something that looks like a weave store for snapshot to
1975
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
1976
if len(previous_revisions) == 1:
1977
previous_ie = previous_revisions.values()[0]
1978
if ie._unchanged(previous_ie):
1979
ie.revision = previous_ie.revision
1982
text = self.branch.repository.text_store.get(ie.text_id)
1983
file_lines = text.readlines()
1984
assert sha_strings(file_lines) == ie.text_sha1
1985
assert sum(map(len, file_lines)) == ie.text_size
1986
w.add_lines(rev_id, previous_revisions, file_lines)
1987
self.text_count += 1
1989
w.add_lines(rev_id, previous_revisions, [])
1990
ie.revision = rev_id
1992
def _make_order(self):
1993
"""Return a suitable order for importing revisions.
1995
The order must be such that an revision is imported after all
1996
its (present) parents.
1998
todo = set(self.revisions.keys())
1999
done = self.absent_revisions.copy()
2002
# scan through looking for a revision whose parents
2004
for rev_id in sorted(list(todo)):
2005
rev = self.revisions[rev_id]
2006
parent_ids = set(rev.parent_ids)
2007
if parent_ids.issubset(done):
2008
# can take this one now
2009
order.append(rev_id)
2015
class ConvertBzrDir5To6(Converter):
2016
"""Converts format 5 bzr dirs to format 6."""
2018
def convert(self, to_convert, pb):
2019
"""See Converter.convert()."""
2020
self.bzrdir = to_convert
2022
self.pb.note('starting upgrade from format 5 to 6')
2023
self._convert_to_prefixed()
2024
return BzrDir.open(self.bzrdir.root_transport.base)
2026
def _convert_to_prefixed(self):
2027
from bzrlib.store import TransportStore
2028
self.bzrdir.transport.delete('branch-format')
2029
for store_name in ["weaves", "revision-store"]:
2030
self.pb.note("adding prefixes to %s" % store_name)
2031
store_transport = self.bzrdir.transport.clone(store_name)
2032
store = TransportStore(store_transport, prefixed=True)
2033
for urlfilename in store_transport.list_dir('.'):
2034
filename = urlutils.unescape(urlfilename)
2035
if (filename.endswith(".weave") or
2036
filename.endswith(".gz") or
2037
filename.endswith(".sig")):
2038
file_id = os.path.splitext(filename)[0]
2041
prefix_dir = store.hash_prefix(file_id)
2042
# FIXME keep track of the dirs made RBC 20060121
2044
store_transport.move(filename, prefix_dir + '/' + filename)
2045
except errors.NoSuchFile: # catches missing dirs strangely enough
2046
store_transport.mkdir(prefix_dir)
2047
store_transport.move(filename, prefix_dir + '/' + filename)
2048
self.bzrdir._control_files.put_utf8('branch-format', BzrDirFormat6().get_format_string())
2051
class ConvertBzrDir6ToMeta(Converter):
2052
"""Converts format 6 bzr dirs to metadirs."""
2054
def convert(self, to_convert, pb):
2055
"""See Converter.convert()."""
2056
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2057
from bzrlib.branch import BzrBranchFormat5
2058
self.bzrdir = to_convert
2061
self.total = 20 # the steps we know about
2062
self.garbage_inventories = []
2064
self.pb.note('starting upgrade from format 6 to metadir')
2065
self.bzrdir._control_files.put_utf8('branch-format', "Converting to format 6")
2066
# its faster to move specific files around than to open and use the apis...
2067
# first off, nuke ancestry.weave, it was never used.
2069
self.step('Removing ancestry.weave')
2070
self.bzrdir.transport.delete('ancestry.weave')
2071
except errors.NoSuchFile:
2073
# find out whats there
2074
self.step('Finding branch files')
2075
last_revision = self.bzrdir.open_branch().last_revision()
2076
bzrcontents = self.bzrdir.transport.list_dir('.')
2077
for name in bzrcontents:
2078
if name.startswith('basis-inventory.'):
2079
self.garbage_inventories.append(name)
2080
# create new directories for repository, working tree and branch
2081
self.dir_mode = self.bzrdir._control_files._dir_mode
2082
self.file_mode = self.bzrdir._control_files._file_mode
2083
repository_names = [('inventory.weave', True),
2084
('revision-store', True),
2086
self.step('Upgrading repository ')
2087
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2088
self.make_lock('repository')
2089
# we hard code the formats here because we are converting into
2090
# the meta format. The meta format upgrader can take this to a
2091
# future format within each component.
2092
self.put_format('repository', RepositoryFormat7())
2093
for entry in repository_names:
2094
self.move_entry('repository', entry)
2096
self.step('Upgrading branch ')
2097
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2098
self.make_lock('branch')
2099
self.put_format('branch', BzrBranchFormat5())
2100
branch_files = [('revision-history', True),
2101
('branch-name', True),
2103
for entry in branch_files:
2104
self.move_entry('branch', entry)
2106
checkout_files = [('pending-merges', True),
2107
('inventory', True),
2108
('stat-cache', False)]
2109
# If a mandatory checkout file is not present, the branch does not have
2110
# a functional checkout. Do not create a checkout in the converted
2112
for name, mandatory in checkout_files:
2113
if mandatory and name not in bzrcontents:
2114
has_checkout = False
2118
if not has_checkout:
2119
self.pb.note('No working tree.')
2120
# If some checkout files are there, we may as well get rid of them.
2121
for name, mandatory in checkout_files:
2122
if name in bzrcontents:
2123
self.bzrdir.transport.delete(name)
2125
from bzrlib.workingtree import WorkingTreeFormat3
2126
self.step('Upgrading working tree')
2127
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2128
self.make_lock('checkout')
2130
'checkout', WorkingTreeFormat3())
2131
self.bzrdir.transport.delete_multi(
2132
self.garbage_inventories, self.pb)
2133
for entry in checkout_files:
2134
self.move_entry('checkout', entry)
2135
if last_revision is not None:
2136
self.bzrdir._control_files.put_utf8(
2137
'checkout/last-revision', last_revision)
2138
self.bzrdir._control_files.put_utf8(
2139
'branch-format', BzrDirMetaFormat1().get_format_string())
2140
return BzrDir.open(self.bzrdir.root_transport.base)
2142
def make_lock(self, name):
2143
"""Make a lock for the new control dir name."""
2144
self.step('Make %s lock' % name)
2145
ld = lockdir.LockDir(self.bzrdir.transport,
2147
file_modebits=self.file_mode,
2148
dir_modebits=self.dir_mode)
2151
def move_entry(self, new_dir, entry):
2152
"""Move then entry name into new_dir."""
2154
mandatory = entry[1]
2155
self.step('Moving %s' % name)
2157
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2158
except errors.NoSuchFile:
2162
def put_format(self, dirname, format):
2163
self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
2166
class ConvertMetaToMeta(Converter):
2167
"""Converts the components of metadirs."""
2169
def __init__(self, target_format):
2170
"""Create a metadir to metadir converter.
2172
:param target_format: The final metadir format that is desired.
2174
self.target_format = target_format
2176
def convert(self, to_convert, pb):
2177
"""See Converter.convert()."""
2178
self.bzrdir = to_convert
2182
self.step('checking repository format')
2184
repo = self.bzrdir.open_repository()
2185
except errors.NoRepositoryPresent:
2188
if not isinstance(repo._format, self.target_format.repository_format.__class__):
2189
from bzrlib.repository import CopyConverter
2190
self.pb.note('starting repository conversion')
2191
converter = CopyConverter(self.target_format.repository_format)
2192
converter.convert(repo, pb)
2194
branch = self.bzrdir.open_branch()
2195
except errors.NotBranchError:
2198
# TODO: conversions of Branch and Tree should be done by
2199
# InterXFormat lookups
2200
# Avoid circular imports
2201
from bzrlib import branch as _mod_branch
2202
if (branch._format.__class__ is _mod_branch.BzrBranchFormat5 and
2203
self.target_format.get_branch_format().__class__ is
2204
_mod_branch.BzrBranchFormat6):
2205
branch_converter = _mod_branch.Converter5to6()
2206
branch_converter.convert(branch)
2208
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
2209
except (errors.NoWorkingTree, errors.NotLocalUrl):
2212
# TODO: conversions of Branch and Tree should be done by
2213
# InterXFormat lookups
2214
if (isinstance(tree, workingtree.WorkingTree3) and
2215
not isinstance(tree, workingtree_4.WorkingTree4) and
2216
isinstance(self.target_format.workingtree_format,
2217
workingtree_4.WorkingTreeFormat4)):
2218
workingtree_4.Converter3to4().convert(tree)
2222
# This is not in remote.py because it's small, and needs to be registered.
2223
# Putting it in remote.py creates a circular import problem.
2224
# we can make it a lazy object if the control formats is turned into something
2226
class RemoteBzrDirFormat(BzrDirMetaFormat1):
2227
"""Format representing bzrdirs accessed via a smart server"""
2229
def get_format_description(self):
2230
return 'bzr remote bzrdir'
2233
def probe_transport(klass, transport):
2234
"""Return a RemoteBzrDirFormat object if it looks possible."""
2236
client = transport.get_smart_client()
2237
except (NotImplementedError, AttributeError,
2238
errors.TransportNotPossible):
2239
# no smart server, so not a branch for this format type.
2240
raise errors.NotBranchError(path=transport.base)
2242
# Send a 'hello' request in protocol version one, and decline to
2243
# open it if the server doesn't support our required version (2) so
2244
# that the VFS-based transport will do it.
2245
request = client.get_request()
2246
smart_protocol = protocol.SmartClientRequestProtocolOne(request)
2247
server_version = smart_protocol.query_version()
2248
if server_version != 2:
2249
raise errors.NotBranchError(path=transport.base)
2252
def initialize_on_transport(self, transport):
2254
# hand off the request to the smart server
2255
medium = transport.get_smart_medium()
2256
except errors.NoSmartMedium:
2257
# TODO: lookup the local format from a server hint.
2258
local_dir_format = BzrDirMetaFormat1()
2259
return local_dir_format.initialize_on_transport(transport)
2260
client = _SmartClient(medium)
2261
path = client.remote_path_from_transport(transport)
2262
response = _SmartClient(medium).call('BzrDirFormat.initialize', path)
2263
assert response[0] in ('ok', ), 'unexpected response code %s' % (response,)
2264
return remote.RemoteBzrDir(transport)
2266
def _open(self, transport):
2267
return remote.RemoteBzrDir(transport)
2269
def __eq__(self, other):
2270
if not isinstance(other, RemoteBzrDirFormat):
2272
return self.get_format_description() == other.get_format_description()
2275
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
2278
class BzrDirFormatInfo(object):
2280
def __init__(self, native, deprecated, hidden):
2281
self.deprecated = deprecated
2282
self.native = native
2283
self.hidden = hidden
2286
class BzrDirFormatRegistry(registry.Registry):
2287
"""Registry of user-selectable BzrDir subformats.
2289
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
2290
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
2293
def register_metadir(self, key,
2294
repository_format, help, native=True, deprecated=False,
2298
"""Register a metadir subformat.
2300
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
2301
by the Repository format.
2303
:param repository_format: The fully-qualified repository format class
2305
:param branch_format: Fully-qualified branch format class name as
2307
:param tree_format: Fully-qualified tree format class name as
2310
# This should be expanded to support setting WorkingTree and Branch
2311
# formats, once BzrDirMetaFormat1 supports that.
2312
def _load(full_name):
2313
mod_name, factory_name = full_name.rsplit('.', 1)
2315
mod = __import__(mod_name, globals(), locals(),
2317
except ImportError, e:
2318
raise ImportError('failed to load %s: %s' % (full_name, e))
2320
factory = getattr(mod, factory_name)
2321
except AttributeError:
2322
raise AttributeError('no factory %s in module %r'
2327
bd = BzrDirMetaFormat1()
2328
if branch_format is not None:
2329
bd.set_branch_format(_load(branch_format))
2330
if tree_format is not None:
2331
bd.workingtree_format = _load(tree_format)
2332
if repository_format is not None:
2333
bd.repository_format = _load(repository_format)
2335
self.register(key, helper, help, native, deprecated, hidden)
2337
def register(self, key, factory, help, native=True, deprecated=False,
2339
"""Register a BzrDirFormat factory.
2341
The factory must be a callable that takes one parameter: the key.
2342
It must produce an instance of the BzrDirFormat when called.
2344
This function mainly exists to prevent the info object from being
2347
registry.Registry.register(self, key, factory, help,
2348
BzrDirFormatInfo(native, deprecated, hidden))
2350
def register_lazy(self, key, module_name, member_name, help, native=True,
2351
deprecated=False, hidden=False):
2352
registry.Registry.register_lazy(self, key, module_name, member_name,
2353
help, BzrDirFormatInfo(native, deprecated, hidden))
2355
def set_default(self, key):
2356
"""Set the 'default' key to be a clone of the supplied key.
2358
This method must be called once and only once.
2360
registry.Registry.register(self, 'default', self.get(key),
2361
self.get_help(key), info=self.get_info(key))
2363
def set_default_repository(self, key):
2364
"""Set the FormatRegistry default and Repository default.
2366
This is a transitional method while Repository.set_default_format
2369
if 'default' in self:
2370
self.remove('default')
2371
self.set_default(key)
2372
format = self.get('default')()
2373
assert isinstance(format, BzrDirMetaFormat1)
2375
def make_bzrdir(self, key):
2376
return self.get(key)()
2378
def help_topic(self, topic):
2379
output = textwrap.dedent("""\
2380
Bazaar directory formats
2381
------------------------
2383
These formats can be used for creating branches, working trees, and
2387
default_help = self.get_help('default')
2389
for key in self.keys():
2390
if key == 'default':
2392
help = self.get_help(key)
2393
if help == default_help:
2394
default_realkey = key
2396
help_pairs.append((key, help))
2398
def wrapped(key, help, info):
2400
help = '(native) ' + help
2401
return ' %s:\n%s\n\n' % (key,
2402
textwrap.fill(help, initial_indent=' ',
2403
subsequent_indent=' '))
2404
output += wrapped('%s/default' % default_realkey, default_help,
2405
self.get_info('default'))
2406
deprecated_pairs = []
2407
for key, help in help_pairs:
2408
info = self.get_info(key)
2411
elif info.deprecated:
2412
deprecated_pairs.append((key, help))
2414
output += wrapped(key, help, info)
2415
if len(deprecated_pairs) > 0:
2416
output += "Deprecated formats\n------------------\n\n"
2417
for key, help in deprecated_pairs:
2418
info = self.get_info(key)
2419
output += wrapped(key, help, info)
2424
format_registry = BzrDirFormatRegistry()
2425
format_registry.register('weave', BzrDirFormat6,
2426
'Pre-0.8 format. Slower than knit and does not'
2427
' support checkouts or shared repositories.',
2429
format_registry.register_metadir('knit',
2430
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2431
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
2432
branch_format='bzrlib.branch.BzrBranchFormat5',
2433
tree_format='bzrlib.workingtree.WorkingTreeFormat3')
2434
format_registry.register_metadir('metaweave',
2435
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
2436
'Transitional format in 0.8. Slower than knit.',
2437
branch_format='bzrlib.branch.BzrBranchFormat5',
2438
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2440
format_registry.register_metadir('dirstate',
2441
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2442
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2443
'above when accessed over the network.',
2444
branch_format='bzrlib.branch.BzrBranchFormat5',
2445
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
2446
# directly from workingtree_4 triggers a circular import.
2447
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2449
format_registry.register_metadir('dirstate-tags',
2450
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2451
help='New in 0.15: Fast local operations and improved scaling for '
2452
'network operations. Additionally adds support for tags.'
2453
' Incompatible with bzr < 0.15.',
2454
branch_format='bzrlib.branch.BzrBranchFormat6',
2455
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2457
format_registry.register_metadir('dirstate-with-subtree',
2458
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2459
help='New in 0.15: Fast local operations and improved scaling for '
2460
'network operations. Additionally adds support for versioning nested '
2461
'bzr branches. Incompatible with bzr < 0.15.',
2462
branch_format='bzrlib.branch.BzrBranchFormat6',
2463
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2466
format_registry.set_default('dirstate')
added
removed
bzrlib/bzrdir.py
