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: Can we move specific formats into separate modules to make this file
26
from cStringIO import StringIO
29
from bzrlib.lazy_import import lazy_import
30
lazy_import(globals(), """
31
from stat import S_ISDIR
33
from warnings import warn
42
revision as _mod_revision,
51
from bzrlib.osutils import (
55
from bzrlib.smart.client import _SmartClient
56
from bzrlib.smart import protocol
57
from bzrlib.store.revision.text import TextRevisionStore
58
from bzrlib.store.text import TextStore
59
from bzrlib.store.versioned import WeaveStore
60
from bzrlib.transactions import WriteTransaction
61
from bzrlib.transport import (
62
do_catching_redirections,
65
from bzrlib.weave import Weave
68
from bzrlib.trace import (
72
from bzrlib.transport.local import LocalTransport
73
from bzrlib.symbol_versioning import (
81
"""A .bzr control diretory.
83
BzrDir instances let you create or open any of the things that can be
84
found within .bzr - checkouts, branches and repositories.
87
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
89
a transport connected to the directory this bzr was opened from.
93
"""Invoke break_lock on the first object in the bzrdir.
95
If there is a tree, the tree is opened and break_lock() called.
96
Otherwise, branch is tried, and finally repository.
98
# XXX: This seems more like a UI function than something that really
99
# belongs in this class.
101
thing_to_unlock = self.open_workingtree()
102
except (errors.NotLocalUrl, errors.NoWorkingTree):
104
thing_to_unlock = self.open_branch()
105
except errors.NotBranchError:
107
thing_to_unlock = self.open_repository()
108
except errors.NoRepositoryPresent:
110
thing_to_unlock.break_lock()
112
def can_convert_format(self):
113
"""Return true if this bzrdir is one whose format we can convert from."""
116
def check_conversion_target(self, target_format):
117
target_repo_format = target_format.repository_format
118
source_repo_format = self._format.repository_format
119
source_repo_format.check_conversion_target(target_repo_format)
122
def _check_supported(format, allow_unsupported,
123
recommend_upgrade=True,
125
"""Give an error or warning on old formats.
127
:param format: may be any kind of format - workingtree, branch,
130
:param allow_unsupported: If true, allow opening
131
formats that are strongly deprecated, and which may
132
have limited functionality.
134
:param recommend_upgrade: If true (default), warn
135
the user through the ui object that they may wish
136
to upgrade the object.
138
# TODO: perhaps move this into a base Format class; it's not BzrDir
139
# specific. mbp 20070323
140
if not allow_unsupported and not format.is_supported():
141
# see open_downlevel to open legacy branches.
142
raise errors.UnsupportedFormatError(format=format)
143
if recommend_upgrade \
144
and getattr(format, 'upgrade_recommended', False):
145
ui.ui_factory.recommend_upgrade(
146
format.get_format_description(),
149
def clone(self, url, revision_id=None, force_new_repo=False):
150
"""Clone this bzrdir and its contents to url verbatim.
152
If urls last component does not exist, it will be created.
154
if revision_id is not None, then the clone operation may tune
155
itself to download less data.
156
:param force_new_repo: Do not use a shared repository for the target
157
even if one is available.
159
return self.clone_on_transport(get_transport(url),
160
revision_id=revision_id,
161
force_new_repo=force_new_repo)
163
def clone_on_transport(self, transport, revision_id=None,
164
force_new_repo=False):
165
"""Clone this bzrdir and its contents to transport verbatim.
167
If the target directory does not exist, it will be created.
169
if revision_id is not None, then the clone operation may tune
170
itself to download less data.
171
:param force_new_repo: Do not use a shared repository for the target
172
even if one is available.
174
transport.ensure_base()
175
result = self._format.initialize_on_transport(transport)
177
local_repo = self.find_repository()
178
except errors.NoRepositoryPresent:
181
# may need to copy content in
183
result_repo = local_repo.clone(
185
revision_id=revision_id)
186
result_repo.set_make_working_trees(local_repo.make_working_trees())
189
result_repo = result.find_repository()
190
# fetch content this dir needs.
191
result_repo.fetch(local_repo, revision_id=revision_id)
192
except errors.NoRepositoryPresent:
193
# needed to make one anyway.
194
result_repo = local_repo.clone(
196
revision_id=revision_id)
197
result_repo.set_make_working_trees(local_repo.make_working_trees())
198
# 1 if there is a branch present
199
# make sure its content is available in the target repository
202
self.open_branch().clone(result, revision_id=revision_id)
203
except errors.NotBranchError:
206
self.open_workingtree().clone(result)
207
except (errors.NoWorkingTree, errors.NotLocalUrl):
211
# TODO: This should be given a Transport, and should chdir up; otherwise
212
# this will open a new connection.
213
def _make_tail(self, url):
214
t = get_transport(url)
218
def create(cls, base, format=None, possible_transports=None):
219
"""Create a new BzrDir at the url 'base'.
221
This will call the current default formats initialize with base
222
as the only parameter.
224
:param format: If supplied, the format of branch to create. If not
225
supplied, the default is used.
226
:param possible_transports: If supplied, a list of transports that
227
can be reused to share a remote connection.
229
if cls is not BzrDir:
230
raise AssertionError("BzrDir.create always creates the default"
231
" format, not one of %r" % cls)
232
t = get_transport(base, possible_transports)
235
format = BzrDirFormat.get_default_format()
236
return format.initialize(base, possible_transports)
238
def create_branch(self):
239
"""Create a branch in this BzrDir.
241
The bzrdirs format will control what branch format is created.
242
For more control see BranchFormatXX.create(a_bzrdir).
244
raise NotImplementedError(self.create_branch)
247
def create_branch_and_repo(base, force_new_repo=False, format=None):
248
"""Create a new BzrDir, Branch and Repository at the url 'base'.
250
This will use the current default BzrDirFormat, and use whatever
251
repository format that that uses via bzrdir.create_branch and
252
create_repository. If a shared repository is available that is used
255
The created Branch object is returned.
257
:param base: The URL to create the branch at.
258
:param force_new_repo: If True a new repository is always created.
260
bzrdir = BzrDir.create(base, format)
261
bzrdir._find_or_create_repository(force_new_repo)
262
return bzrdir.create_branch()
264
def _find_or_create_repository(self, force_new_repo):
265
"""Create a new repository if needed, returning the repository."""
267
return self.create_repository()
269
return self.find_repository()
270
except errors.NoRepositoryPresent:
271
return self.create_repository()
274
def create_branch_convenience(base, force_new_repo=False,
275
force_new_tree=None, format=None,
276
possible_transports=None):
277
"""Create a new BzrDir, Branch and Repository at the url 'base'.
279
This is a convenience function - it will use an existing repository
280
if possible, can be told explicitly whether to create a working tree or
283
This will use the current default BzrDirFormat, and use whatever
284
repository format that that uses via bzrdir.create_branch and
285
create_repository. If a shared repository is available that is used
286
preferentially. Whatever repository is used, its tree creation policy
289
The created Branch object is returned.
290
If a working tree cannot be made due to base not being a file:// url,
291
no error is raised unless force_new_tree is True, in which case no
292
data is created on disk and NotLocalUrl is raised.
294
:param base: The URL to create the branch at.
295
:param force_new_repo: If True a new repository is always created.
296
:param force_new_tree: If True or False force creation of a tree or
297
prevent such creation respectively.
298
:param format: Override for the for the bzrdir format to create.
299
:param possible_transports: An optional reusable transports list.
302
# check for non local urls
303
t = get_transport(base, possible_transports)
304
if not isinstance(t, LocalTransport):
305
raise errors.NotLocalUrl(base)
306
bzrdir = BzrDir.create(base, format, possible_transports)
307
repo = bzrdir._find_or_create_repository(force_new_repo)
308
result = bzrdir.create_branch()
309
if force_new_tree or (repo.make_working_trees() and
310
force_new_tree is None):
312
bzrdir.create_workingtree()
313
except errors.NotLocalUrl:
318
@deprecated_function(zero_ninetyone)
319
def create_repository(base, shared=False, format=None):
320
"""Create a new BzrDir and Repository at the url 'base'.
322
If no format is supplied, this will default to the current default
323
BzrDirFormat by default, and use whatever repository format that that
324
uses for bzrdirformat.create_repository.
326
:param shared: Create a shared repository rather than a standalone
328
The Repository object is returned.
330
This must be overridden as an instance method in child classes, where
331
it should take no parameters and construct whatever repository format
332
that child class desires.
334
This method is deprecated, please call create_repository on a bzrdir
337
bzrdir = BzrDir.create(base, format)
338
return bzrdir.create_repository(shared)
341
def create_standalone_workingtree(base, format=None):
342
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
344
'base' must be a local path or a file:// url.
346
This will use the current default BzrDirFormat, and use whatever
347
repository format that that uses for bzrdirformat.create_workingtree,
348
create_branch and create_repository.
350
:return: The WorkingTree object.
352
t = get_transport(base)
353
if not isinstance(t, LocalTransport):
354
raise errors.NotLocalUrl(base)
355
bzrdir = BzrDir.create_branch_and_repo(base,
357
format=format).bzrdir
358
return bzrdir.create_workingtree()
360
def create_workingtree(self, revision_id=None):
361
"""Create a working tree at this BzrDir.
363
revision_id: create it as of this revision id.
365
raise NotImplementedError(self.create_workingtree)
367
def retire_bzrdir(self):
368
"""Permanently disable the bzrdir.
370
This is done by renaming it to give the user some ability to recover
371
if there was a problem.
373
This will have horrible consequences if anyone has anything locked or
376
for i in xrange(10000):
378
to_path = '.bzr.retired.%d' % i
379
self.root_transport.rename('.bzr', to_path)
380
note("renamed %s to %s"
381
% (self.root_transport.abspath('.bzr'), to_path))
383
except (errors.TransportError, IOError, errors.PathError):
386
def destroy_workingtree(self):
387
"""Destroy the working tree at this BzrDir.
389
Formats that do not support this may raise UnsupportedOperation.
391
raise NotImplementedError(self.destroy_workingtree)
393
def destroy_workingtree_metadata(self):
394
"""Destroy the control files for the working tree at this BzrDir.
396
The contents of working tree files are not affected.
397
Formats that do not support this may raise UnsupportedOperation.
399
raise NotImplementedError(self.destroy_workingtree_metadata)
401
def find_repository(self):
402
"""Find the repository that should be used for a_bzrdir.
404
This does not require a branch as we use it to find the repo for
405
new branches as well as to hook existing branches up to their
409
return self.open_repository()
410
except errors.NoRepositoryPresent:
412
next_transport = self.root_transport.clone('..')
414
# find the next containing bzrdir
416
found_bzrdir = BzrDir.open_containing_from_transport(
418
except errors.NotBranchError:
420
raise errors.NoRepositoryPresent(self)
421
# does it have a repository ?
423
repository = found_bzrdir.open_repository()
424
except errors.NoRepositoryPresent:
425
next_transport = found_bzrdir.root_transport.clone('..')
426
if (found_bzrdir.root_transport.base == next_transport.base):
427
# top of the file system
431
if ((found_bzrdir.root_transport.base ==
432
self.root_transport.base) or repository.is_shared()):
435
raise errors.NoRepositoryPresent(self)
436
raise errors.NoRepositoryPresent(self)
438
def get_branch_reference(self):
439
"""Return the referenced URL for the branch in this bzrdir.
441
:raises NotBranchError: If there is no Branch.
442
:return: The URL the branch in this bzrdir references if it is a
443
reference branch, or None for regular branches.
447
def get_branch_transport(self, branch_format):
448
"""Get the transport for use by branch format in this BzrDir.
450
Note that bzr dirs that do not support format strings will raise
451
IncompatibleFormat if the branch format they are given has
452
a format string, and vice versa.
454
If branch_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_branch_transport)
460
def get_repository_transport(self, repository_format):
461
"""Get the transport for use by repository format in this BzrDir.
463
Note that bzr dirs that do not support format strings will raise
464
IncompatibleFormat if the repository format they are given has
465
a format string, and vice versa.
467
If repository_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_repository_transport)
473
def get_workingtree_transport(self, tree_format):
474
"""Get the transport for use by workingtree format in this BzrDir.
476
Note that bzr dirs that do not support format strings will raise
477
IncompatibleFormat if the workingtree format they are given has a
478
format string, and vice versa.
480
If workingtree_format is None, the transport is returned with no
481
checking. if it is not None, then the returned transport is
482
guaranteed to point to an existing directory ready for use.
484
raise NotImplementedError(self.get_workingtree_transport)
486
def __init__(self, _transport, _format):
487
"""Initialize a Bzr control dir object.
489
Only really common logic should reside here, concrete classes should be
490
made with varying behaviours.
492
:param _format: the format that is creating this BzrDir instance.
493
:param _transport: the transport this dir is based at.
495
self._format = _format
496
self.transport = _transport.clone('.bzr')
497
self.root_transport = _transport
499
def is_control_filename(self, filename):
500
"""True if filename is the name of a path which is reserved for bzrdir's.
502
:param filename: A filename within the root transport of this bzrdir.
504
This is true IF and ONLY IF the filename is part of the namespace reserved
505
for bzr control dirs. Currently this is the '.bzr' directory in the root
506
of the root_transport. it is expected that plugins will need to extend
507
this in the future - for instance to make bzr talk with svn working
510
# this might be better on the BzrDirFormat class because it refers to
511
# all the possible bzrdir disk formats.
512
# This method is tested via the workingtree is_control_filename tests-
513
# it was extracted from WorkingTree.is_control_filename. If the methods
514
# contract is extended beyond the current trivial implementation please
515
# add new tests for it to the appropriate place.
516
return filename == '.bzr' or filename.startswith('.bzr/')
518
def needs_format_conversion(self, format=None):
519
"""Return true if this bzrdir needs convert_format run on it.
521
For instance, if the repository format is out of date but the
522
branch and working tree are not, this should return True.
524
:param format: Optional parameter indicating a specific desired
525
format we plan to arrive at.
527
raise NotImplementedError(self.needs_format_conversion)
530
def open_unsupported(base):
531
"""Open a branch which is not supported."""
532
return BzrDir.open(base, _unsupported=True)
535
def open(base, _unsupported=False):
536
"""Open an existing bzrdir, rooted at 'base' (url)
538
_unsupported is a private parameter to the BzrDir class.
540
t = get_transport(base)
541
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
544
def open_from_transport(transport, _unsupported=False,
545
_server_formats=True):
546
"""Open a bzrdir within a particular directory.
548
:param transport: Transport containing the bzrdir.
549
:param _unsupported: private.
551
base = transport.base
553
def find_format(transport):
554
return transport, BzrDirFormat.find_format(
555
transport, _server_formats=_server_formats)
557
def redirected(transport, e, redirection_notice):
558
qualified_source = e.get_source_url()
559
relpath = transport.relpath(qualified_source)
560
if not e.target.endswith(relpath):
561
# Not redirected to a branch-format, not a branch
562
raise errors.NotBranchError(path=e.target)
563
target = e.target[:-len(relpath)]
564
note('%s is%s redirected to %s',
565
transport.base, e.permanently, target)
566
# Let's try with a new transport
567
qualified_target = e.get_target_url()[:-len(relpath)]
568
# FIXME: If 'transport' has a qualifier, this should
569
# be applied again to the new transport *iff* the
570
# schemes used are the same. It's a bit tricky to
571
# verify, so I'll punt for now
573
return get_transport(target)
576
transport, format = do_catching_redirections(find_format,
579
except errors.TooManyRedirections:
580
raise errors.NotBranchError(base)
582
BzrDir._check_supported(format, _unsupported)
583
return format.open(transport, _found=True)
585
def open_branch(self, unsupported=False):
586
"""Open the branch object at this BzrDir if one is present.
588
If unsupported is True, then no longer supported branch formats can
591
TODO: static convenience version of this?
593
raise NotImplementedError(self.open_branch)
596
def open_containing(url, possible_transports=None):
597
"""Open an existing branch which contains url.
599
:param url: url to search from.
600
See open_containing_from_transport for more detail.
602
transport = get_transport(url, possible_transports)
603
return BzrDir.open_containing_from_transport(transport)
606
def open_containing_from_transport(a_transport):
607
"""Open an existing branch which contains a_transport.base
609
This probes for a branch at a_transport, and searches upwards from there.
611
Basically we keep looking up until we find the control directory or
612
run into the root. If there isn't one, raises NotBranchError.
613
If there is one and it is either an unrecognised format or an unsupported
614
format, UnknownFormatError or UnsupportedFormatError are raised.
615
If there is one, it is returned, along with the unused portion of url.
617
:return: The BzrDir that contains the path, and a Unicode path
618
for the rest of the URL.
620
# this gets the normalised url back. I.e. '.' -> the full path.
621
url = a_transport.base
624
result = BzrDir.open_from_transport(a_transport)
625
return result, urlutils.unescape(a_transport.relpath(url))
626
except errors.NotBranchError, e:
629
new_t = a_transport.clone('..')
630
except errors.InvalidURLJoin:
631
# reached the root, whatever that may be
632
raise errors.NotBranchError(path=url)
633
if new_t.base == a_transport.base:
634
# reached the root, whatever that may be
635
raise errors.NotBranchError(path=url)
639
def open_containing_tree_or_branch(klass, location):
640
"""Return the branch and working tree contained by a location.
642
Returns (tree, branch, relpath).
643
If there is no tree at containing the location, tree will be None.
644
If there is no branch containing the location, an exception will be
646
relpath is the portion of the path that is contained by the branch.
648
bzrdir, relpath = klass.open_containing(location)
650
tree = bzrdir.open_workingtree()
651
except (errors.NoWorkingTree, errors.NotLocalUrl):
653
branch = bzrdir.open_branch()
656
return tree, branch, relpath
658
def open_repository(self, _unsupported=False):
659
"""Open the repository object at this BzrDir if one is present.
661
This will not follow the Branch object pointer - its strictly a direct
662
open facility. Most client code should use open_branch().repository to
665
_unsupported is a private parameter, not part of the api.
666
TODO: static convenience version of this?
668
raise NotImplementedError(self.open_repository)
670
def open_workingtree(self, _unsupported=False,
671
recommend_upgrade=True):
672
"""Open the workingtree object at this BzrDir if one is present.
674
:param recommend_upgrade: Optional keyword parameter, when True (the
675
default), emit through the ui module a recommendation that the user
676
upgrade the working tree when the workingtree being opened is old
677
(but still fully supported).
679
raise NotImplementedError(self.open_workingtree)
681
def has_branch(self):
682
"""Tell if this bzrdir contains a branch.
684
Note: if you're going to open the branch, you should just go ahead
685
and try, and not ask permission first. (This method just opens the
686
branch and discards it, and that's somewhat expensive.)
691
except errors.NotBranchError:
694
def has_workingtree(self):
695
"""Tell if this bzrdir contains a working tree.
697
This will still raise an exception if the bzrdir has a workingtree that
698
is remote & inaccessible.
700
Note: if you're going to open the working tree, you should just go ahead
701
and try, and not ask permission first. (This method just opens the
702
workingtree and discards it, and that's somewhat expensive.)
705
self.open_workingtree(recommend_upgrade=False)
707
except errors.NoWorkingTree:
710
def _cloning_metadir(self):
711
"""Produce a metadir suitable for cloning with"""
712
result_format = self._format.__class__()
715
branch = self.open_branch()
716
source_repository = branch.repository
717
except errors.NotBranchError:
719
source_repository = self.open_repository()
720
except errors.NoRepositoryPresent:
721
source_repository = None
723
# XXX TODO: This isinstance is here because we have not implemented
724
# the fix recommended in bug # 103195 - to delegate this choice the
726
repo_format = source_repository._format
727
if not isinstance(repo_format, remote.RemoteRepositoryFormat):
728
result_format.repository_format = repo_format
730
# TODO: Couldn't we just probe for the format in these cases,
731
# rather than opening the whole tree? It would be a little
732
# faster. mbp 20070401
733
tree = self.open_workingtree(recommend_upgrade=False)
734
except (errors.NoWorkingTree, errors.NotLocalUrl):
735
result_format.workingtree_format = None
737
result_format.workingtree_format = tree._format.__class__()
738
return result_format, source_repository
740
def cloning_metadir(self):
741
"""Produce a metadir suitable for cloning or sprouting with.
743
These operations may produce workingtrees (yes, even though they're
744
"cloning" something that doesn't have a tree, so a viable workingtree
745
format must be selected.
747
format, repository = self._cloning_metadir()
748
if format._workingtree_format is None:
749
if repository is None:
751
tree_format = repository._format._matchingbzrdir.workingtree_format
752
format.workingtree_format = tree_format.__class__()
755
def checkout_metadir(self):
756
return self.cloning_metadir()
758
def sprout(self, url, revision_id=None, force_new_repo=False,
759
recurse='down', possible_transports=None):
760
"""Create a copy of this bzrdir prepared for use as a new line of
763
If urls last component does not exist, it will be created.
765
Attributes related to the identity of the source branch like
766
branch nickname will be cleaned, a working tree is created
767
whether one existed before or not; and a local branch is always
770
if revision_id is not None, then the clone operation may tune
771
itself to download less data.
773
target_transport = get_transport(url, possible_transports)
774
target_transport.ensure_base()
775
cloning_format = self.cloning_metadir()
776
result = cloning_format.initialize_on_transport(target_transport)
778
source_branch = self.open_branch()
779
source_repository = source_branch.repository
780
except errors.NotBranchError:
783
source_repository = self.open_repository()
784
except errors.NoRepositoryPresent:
785
source_repository = None
790
result_repo = result.find_repository()
791
except errors.NoRepositoryPresent:
793
if source_repository is None and result_repo is not None:
795
elif source_repository is None and result_repo is None:
796
# no repo available, make a new one
797
result.create_repository()
798
elif source_repository is not None and result_repo is None:
799
# have source, and want to make a new target repo
800
result_repo = source_repository.sprout(result,
801
revision_id=revision_id)
803
# fetch needed content into target.
804
if source_repository is not None:
806
# source_repository.copy_content_into(result_repo,
807
# revision_id=revision_id)
808
# so we can override the copy method
809
result_repo.fetch(source_repository, revision_id=revision_id)
810
if source_branch is not None:
811
source_branch.sprout(result, revision_id=revision_id)
813
result.create_branch()
814
if isinstance(target_transport, LocalTransport) and (
815
result_repo is None or result_repo.make_working_trees()):
816
wt = result.create_workingtree()
819
if wt.path2id('') is None:
821
wt.set_root_id(self.open_workingtree.get_root_id())
822
except errors.NoWorkingTree:
828
if recurse == 'down':
830
basis = wt.basis_tree()
832
subtrees = basis.iter_references()
833
recurse_branch = wt.branch
834
elif source_branch is not None:
835
basis = source_branch.basis_tree()
837
subtrees = basis.iter_references()
838
recurse_branch = source_branch
843
for path, file_id in subtrees:
844
target = urlutils.join(url, urlutils.escape(path))
845
sublocation = source_branch.reference_parent(file_id, path)
846
sublocation.bzrdir.sprout(target,
847
basis.get_reference_revision(file_id, path),
848
force_new_repo=force_new_repo, recurse=recurse)
850
if basis is not None:
855
class BzrDirPreSplitOut(BzrDir):
856
"""A common class for the all-in-one formats."""
858
def __init__(self, _transport, _format):
859
"""See BzrDir.__init__."""
860
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
861
assert self._format._lock_class == lockable_files.TransportLock
862
assert self._format._lock_file_name == 'branch-lock'
863
self._control_files = lockable_files.LockableFiles(
864
self.get_branch_transport(None),
865
self._format._lock_file_name,
866
self._format._lock_class)
868
def break_lock(self):
869
"""Pre-splitout bzrdirs do not suffer from stale locks."""
870
raise NotImplementedError(self.break_lock)
872
def clone(self, url, revision_id=None, force_new_repo=False):
873
"""See BzrDir.clone()."""
874
from bzrlib.workingtree import WorkingTreeFormat2
876
result = self._format._initialize_for_clone(url)
877
self.open_repository().clone(result, revision_id=revision_id)
878
from_branch = self.open_branch()
879
from_branch.clone(result, revision_id=revision_id)
881
self.open_workingtree().clone(result)
882
except errors.NotLocalUrl:
883
# make a new one, this format always has to have one.
885
WorkingTreeFormat2().initialize(result)
886
except errors.NotLocalUrl:
887
# but we cannot do it for remote trees.
888
to_branch = result.open_branch()
889
WorkingTreeFormat2().stub_initialize_remote(to_branch.control_files)
892
def create_branch(self):
893
"""See BzrDir.create_branch."""
894
return self.open_branch()
896
def create_repository(self, shared=False):
897
"""See BzrDir.create_repository."""
899
raise errors.IncompatibleFormat('shared repository', self._format)
900
return self.open_repository()
902
def create_workingtree(self, revision_id=None):
903
"""See BzrDir.create_workingtree."""
904
# this looks buggy but is not -really-
905
# because this format creates the workingtree when the bzrdir is
907
# clone and sprout will have set the revision_id
908
# and that will have set it for us, its only
909
# specific uses of create_workingtree in isolation
910
# that can do wonky stuff here, and that only
911
# happens for creating checkouts, which cannot be
912
# done on this format anyway. So - acceptable wart.
913
result = self.open_workingtree(recommend_upgrade=False)
914
if revision_id is not None:
915
if revision_id == _mod_revision.NULL_REVISION:
916
result.set_parent_ids([])
918
result.set_parent_ids([revision_id])
921
def destroy_workingtree(self):
922
"""See BzrDir.destroy_workingtree."""
923
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
925
def destroy_workingtree_metadata(self):
926
"""See BzrDir.destroy_workingtree_metadata."""
927
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
930
def get_branch_transport(self, branch_format):
931
"""See BzrDir.get_branch_transport()."""
932
if branch_format is None:
933
return self.transport
935
branch_format.get_format_string()
936
except NotImplementedError:
937
return self.transport
938
raise errors.IncompatibleFormat(branch_format, self._format)
940
def get_repository_transport(self, repository_format):
941
"""See BzrDir.get_repository_transport()."""
942
if repository_format is None:
943
return self.transport
945
repository_format.get_format_string()
946
except NotImplementedError:
947
return self.transport
948
raise errors.IncompatibleFormat(repository_format, self._format)
950
def get_workingtree_transport(self, workingtree_format):
951
"""See BzrDir.get_workingtree_transport()."""
952
if workingtree_format is None:
953
return self.transport
955
workingtree_format.get_format_string()
956
except NotImplementedError:
957
return self.transport
958
raise errors.IncompatibleFormat(workingtree_format, self._format)
960
def needs_format_conversion(self, format=None):
961
"""See BzrDir.needs_format_conversion()."""
962
# if the format is not the same as the system default,
963
# an upgrade is needed.
965
format = BzrDirFormat.get_default_format()
966
return not isinstance(self._format, format.__class__)
968
def open_branch(self, unsupported=False):
969
"""See BzrDir.open_branch."""
970
from bzrlib.branch import BzrBranchFormat4
971
format = BzrBranchFormat4()
972
self._check_supported(format, unsupported)
973
return format.open(self, _found=True)
975
def sprout(self, url, revision_id=None, force_new_repo=False,
976
possible_transports=None):
977
"""See BzrDir.sprout()."""
978
from bzrlib.workingtree import WorkingTreeFormat2
980
result = self._format._initialize_for_clone(url)
982
self.open_repository().clone(result, revision_id=revision_id)
983
except errors.NoRepositoryPresent:
986
self.open_branch().sprout(result, revision_id=revision_id)
987
except errors.NotBranchError:
989
# we always want a working tree
990
WorkingTreeFormat2().initialize(result)
994
class BzrDir4(BzrDirPreSplitOut):
995
"""A .bzr version 4 control object.
997
This is a deprecated format and may be removed after sept 2006.
1000
def create_repository(self, shared=False):
1001
"""See BzrDir.create_repository."""
1002
return self._format.repository_format.initialize(self, shared)
1004
def needs_format_conversion(self, format=None):
1005
"""Format 4 dirs are always in need of conversion."""
1008
def open_repository(self):
1009
"""See BzrDir.open_repository."""
1010
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1011
return RepositoryFormat4().open(self, _found=True)
1014
class BzrDir5(BzrDirPreSplitOut):
1015
"""A .bzr version 5 control object.
1017
This is a deprecated format and may be removed after sept 2006.
1020
def open_repository(self):
1021
"""See BzrDir.open_repository."""
1022
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1023
return RepositoryFormat5().open(self, _found=True)
1025
def open_workingtree(self, _unsupported=False,
1026
recommend_upgrade=True):
1027
"""See BzrDir.create_workingtree."""
1028
from bzrlib.workingtree import WorkingTreeFormat2
1029
wt_format = WorkingTreeFormat2()
1030
# we don't warn here about upgrades; that ought to be handled for the
1032
return wt_format.open(self, _found=True)
1035
class BzrDir6(BzrDirPreSplitOut):
1036
"""A .bzr version 6 control object.
1038
This is a deprecated format and may be removed after sept 2006.
1041
def open_repository(self):
1042
"""See BzrDir.open_repository."""
1043
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1044
return RepositoryFormat6().open(self, _found=True)
1046
def open_workingtree(self, _unsupported=False,
1047
recommend_upgrade=True):
1048
"""See BzrDir.create_workingtree."""
1049
# we don't warn here about upgrades; that ought to be handled for the
1051
from bzrlib.workingtree import WorkingTreeFormat2
1052
return WorkingTreeFormat2().open(self, _found=True)
1055
class BzrDirMeta1(BzrDir):
1056
"""A .bzr meta version 1 control object.
1058
This is the first control object where the
1059
individual aspects are really split out: there are separate repository,
1060
workingtree and branch subdirectories and any subset of the three can be
1061
present within a BzrDir.
1064
def can_convert_format(self):
1065
"""See BzrDir.can_convert_format()."""
1068
def create_branch(self):
1069
"""See BzrDir.create_branch."""
1070
return self._format.get_branch_format().initialize(self)
1072
def create_repository(self, shared=False):
1073
"""See BzrDir.create_repository."""
1074
return self._format.repository_format.initialize(self, shared)
1076
def create_workingtree(self, revision_id=None):
1077
"""See BzrDir.create_workingtree."""
1078
from bzrlib.workingtree import WorkingTreeFormat
1079
return self._format.workingtree_format.initialize(self, revision_id)
1081
def destroy_workingtree(self):
1082
"""See BzrDir.destroy_workingtree."""
1083
wt = self.open_workingtree(recommend_upgrade=False)
1084
repository = wt.branch.repository
1085
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1086
wt.revert([], old_tree=empty)
1087
self.destroy_workingtree_metadata()
1089
def destroy_workingtree_metadata(self):
1090
self.transport.delete_tree('checkout')
1092
def find_branch_format(self):
1093
"""Find the branch 'format' for this bzrdir.
1095
This might be a synthetic object for e.g. RemoteBranch and SVN.
1097
from bzrlib.branch import BranchFormat
1098
return BranchFormat.find_format(self)
1100
def _get_mkdir_mode(self):
1101
"""Figure out the mode to use when creating a bzrdir subdir."""
1102
temp_control = lockable_files.LockableFiles(self.transport, '',
1103
lockable_files.TransportLock)
1104
return temp_control._dir_mode
1106
def get_branch_reference(self):
1107
"""See BzrDir.get_branch_reference()."""
1108
from bzrlib.branch import BranchFormat
1109
format = BranchFormat.find_format(self)
1110
return format.get_reference(self)
1112
def get_branch_transport(self, branch_format):
1113
"""See BzrDir.get_branch_transport()."""
1114
if branch_format is None:
1115
return self.transport.clone('branch')
1117
branch_format.get_format_string()
1118
except NotImplementedError:
1119
raise errors.IncompatibleFormat(branch_format, self._format)
1121
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1122
except errors.FileExists:
1124
return self.transport.clone('branch')
1126
def get_repository_transport(self, repository_format):
1127
"""See BzrDir.get_repository_transport()."""
1128
if repository_format is None:
1129
return self.transport.clone('repository')
1131
repository_format.get_format_string()
1132
except NotImplementedError:
1133
raise errors.IncompatibleFormat(repository_format, self._format)
1135
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1136
except errors.FileExists:
1138
return self.transport.clone('repository')
1140
def get_workingtree_transport(self, workingtree_format):
1141
"""See BzrDir.get_workingtree_transport()."""
1142
if workingtree_format is None:
1143
return self.transport.clone('checkout')
1145
workingtree_format.get_format_string()
1146
except NotImplementedError:
1147
raise errors.IncompatibleFormat(workingtree_format, self._format)
1149
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1150
except errors.FileExists:
1152
return self.transport.clone('checkout')
1154
def needs_format_conversion(self, format=None):
1155
"""See BzrDir.needs_format_conversion()."""
1157
format = BzrDirFormat.get_default_format()
1158
if not isinstance(self._format, format.__class__):
1159
# it is not a meta dir format, conversion is needed.
1161
# we might want to push this down to the repository?
1163
if not isinstance(self.open_repository()._format,
1164
format.repository_format.__class__):
1165
# the repository needs an upgrade.
1167
except errors.NoRepositoryPresent:
1170
if not isinstance(self.open_branch()._format,
1171
format.get_branch_format().__class__):
1172
# the branch needs an upgrade.
1174
except errors.NotBranchError:
1177
my_wt = self.open_workingtree(recommend_upgrade=False)
1178
if not isinstance(my_wt._format,
1179
format.workingtree_format.__class__):
1180
# the workingtree needs an upgrade.
1182
except (errors.NoWorkingTree, errors.NotLocalUrl):
1186
def open_branch(self, unsupported=False):
1187
"""See BzrDir.open_branch."""
1188
format = self.find_branch_format()
1189
self._check_supported(format, unsupported)
1190
return format.open(self, _found=True)
1192
def open_repository(self, unsupported=False):
1193
"""See BzrDir.open_repository."""
1194
from bzrlib.repository import RepositoryFormat
1195
format = RepositoryFormat.find_format(self)
1196
self._check_supported(format, unsupported)
1197
return format.open(self, _found=True)
1199
def open_workingtree(self, unsupported=False,
1200
recommend_upgrade=True):
1201
"""See BzrDir.open_workingtree."""
1202
from bzrlib.workingtree import WorkingTreeFormat
1203
format = WorkingTreeFormat.find_format(self)
1204
self._check_supported(format, unsupported,
1206
basedir=self.root_transport.base)
1207
return format.open(self, _found=True)
1210
class BzrDirFormat(object):
1211
"""An encapsulation of the initialization and open routines for a format.
1213
Formats provide three things:
1214
* An initialization routine,
1218
Formats are placed in an dict by their format string for reference
1219
during bzrdir opening. These should be subclasses of BzrDirFormat
1222
Once a format is deprecated, just deprecate the initialize and open
1223
methods on the format class. Do not deprecate the object, as the
1224
object will be created every system load.
1227
_default_format = None
1228
"""The default format used for new .bzr dirs."""
1231
"""The known formats."""
1233
_control_formats = []
1234
"""The registered control formats - .bzr, ....
1236
This is a list of BzrDirFormat objects.
1239
_control_server_formats = []
1240
"""The registered control server formats, e.g. RemoteBzrDirs.
1242
This is a list of BzrDirFormat objects.
1245
_lock_file_name = 'branch-lock'
1247
# _lock_class must be set in subclasses to the lock type, typ.
1248
# TransportLock or LockDir
1251
def find_format(klass, transport, _server_formats=True):
1252
"""Return the format present at transport."""
1254
formats = klass._control_server_formats + klass._control_formats
1256
formats = klass._control_formats
1257
for format in formats:
1259
return format.probe_transport(transport)
1260
except errors.NotBranchError:
1261
# this format does not find a control dir here.
1263
raise errors.NotBranchError(path=transport.base)
1266
def probe_transport(klass, transport):
1267
"""Return the .bzrdir style format present in a directory."""
1269
format_string = transport.get(".bzr/branch-format").read()
1270
except errors.NoSuchFile:
1271
raise errors.NotBranchError(path=transport.base)
1274
return klass._formats[format_string]
1276
raise errors.UnknownFormatError(format=format_string)
1279
def get_default_format(klass):
1280
"""Return the current default format."""
1281
return klass._default_format
1283
def get_format_string(self):
1284
"""Return the ASCII format string that identifies this format."""
1285
raise NotImplementedError(self.get_format_string)
1287
def get_format_description(self):
1288
"""Return the short description for this format."""
1289
raise NotImplementedError(self.get_format_description)
1291
def get_converter(self, format=None):
1292
"""Return the converter to use to convert bzrdirs needing converts.
1294
This returns a bzrlib.bzrdir.Converter object.
1296
This should return the best upgrader to step this format towards the
1297
current default format. In the case of plugins we can/should provide
1298
some means for them to extend the range of returnable converters.
1300
:param format: Optional format to override the default format of the
1303
raise NotImplementedError(self.get_converter)
1305
def initialize(self, url, possible_transports=None):
1306
"""Create a bzr control dir at this url and return an opened copy.
1308
Subclasses should typically override initialize_on_transport
1309
instead of this method.
1311
return self.initialize_on_transport(get_transport(url,
1312
possible_transports))
1314
def initialize_on_transport(self, transport):
1315
"""Initialize a new bzrdir in the base directory of a Transport."""
1316
# Since we don't have a .bzr directory, inherit the
1317
# mode from the root directory
1318
temp_control = lockable_files.LockableFiles(transport,
1319
'', lockable_files.TransportLock)
1320
temp_control._transport.mkdir('.bzr',
1321
# FIXME: RBC 20060121 don't peek under
1323
mode=temp_control._dir_mode)
1324
file_mode = temp_control._file_mode
1326
mutter('created control directory in ' + transport.base)
1327
control = transport.clone('.bzr')
1328
utf8_files = [('README',
1329
"This is a Bazaar-NG control directory.\n"
1330
"Do not change any files in this directory.\n"),
1331
('branch-format', self.get_format_string()),
1333
# NB: no need to escape relative paths that are url safe.
1334
control_files = lockable_files.LockableFiles(control,
1335
self._lock_file_name, self._lock_class)
1336
control_files.create_lock()
1337
control_files.lock_write()
1339
for file, content in utf8_files:
1340
control_files.put_utf8(file, content)
1342
control_files.unlock()
1343
return self.open(transport, _found=True)
1345
def is_supported(self):
1346
"""Is this format supported?
1348
Supported formats must be initializable and openable.
1349
Unsupported formats may not support initialization or committing or
1350
some other features depending on the reason for not being supported.
1354
def same_model(self, target_format):
1355
return (self.repository_format.rich_root_data ==
1356
target_format.rich_root_data)
1359
def known_formats(klass):
1360
"""Return all the known formats.
1362
Concrete formats should override _known_formats.
1364
# There is double indirection here to make sure that control
1365
# formats used by more than one dir format will only be probed
1366
# once. This can otherwise be quite expensive for remote connections.
1368
for format in klass._control_formats:
1369
result.update(format._known_formats())
1373
def _known_formats(klass):
1374
"""Return the known format instances for this control format."""
1375
return set(klass._formats.values())
1377
def open(self, transport, _found=False):
1378
"""Return an instance of this format for the dir transport points at.
1380
_found is a private parameter, do not use it.
1383
found_format = BzrDirFormat.find_format(transport)
1384
if not isinstance(found_format, self.__class__):
1385
raise AssertionError("%s was asked to open %s, but it seems to need "
1387
% (self, transport, found_format))
1388
return self._open(transport)
1390
def _open(self, transport):
1391
"""Template method helper for opening BzrDirectories.
1393
This performs the actual open and any additional logic or parameter
1396
raise NotImplementedError(self._open)
1399
def register_format(klass, format):
1400
klass._formats[format.get_format_string()] = format
1403
def register_control_format(klass, format):
1404
"""Register a format that does not use '.bzr' for its control dir.
1406
TODO: This should be pulled up into a 'ControlDirFormat' base class
1407
which BzrDirFormat can inherit from, and renamed to register_format
1408
there. It has been done without that for now for simplicity of
1411
klass._control_formats.append(format)
1414
def register_control_server_format(klass, format):
1415
"""Register a control format for client-server environments.
1417
These formats will be tried before ones registered with
1418
register_control_format. This gives implementations that decide to the
1419
chance to grab it before anything looks at the contents of the format
1422
klass._control_server_formats.append(format)
1425
@symbol_versioning.deprecated_method(symbol_versioning.zero_fourteen)
1426
def set_default_format(klass, format):
1427
klass._set_default_format(format)
1430
def _set_default_format(klass, format):
1431
"""Set default format (for testing behavior of defaults only)"""
1432
klass._default_format = format
1435
return self.get_format_string()[:-1]
1438
def unregister_format(klass, format):
1439
assert klass._formats[format.get_format_string()] is format
1440
del klass._formats[format.get_format_string()]
1443
def unregister_control_format(klass, format):
1444
klass._control_formats.remove(format)
1447
class BzrDirFormat4(BzrDirFormat):
1448
"""Bzr dir format 4.
1450
This format is a combined format for working tree, branch and repository.
1452
- Format 1 working trees [always]
1453
- Format 4 branches [always]
1454
- Format 4 repositories [always]
1456
This format is deprecated: it indexes texts using a text it which is
1457
removed in format 5; write support for this format has been removed.
1460
_lock_class = lockable_files.TransportLock
1462
def get_format_string(self):
1463
"""See BzrDirFormat.get_format_string()."""
1464
return "Bazaar-NG branch, format 0.0.4\n"
1466
def get_format_description(self):
1467
"""See BzrDirFormat.get_format_description()."""
1468
return "All-in-one format 4"
1470
def get_converter(self, format=None):
1471
"""See BzrDirFormat.get_converter()."""
1472
# there is one and only one upgrade path here.
1473
return ConvertBzrDir4To5()
1475
def initialize_on_transport(self, transport):
1476
"""Format 4 branches cannot be created."""
1477
raise errors.UninitializableFormat(self)
1479
def is_supported(self):
1480
"""Format 4 is not supported.
1482
It is not supported because the model changed from 4 to 5 and the
1483
conversion logic is expensive - so doing it on the fly was not
1488
def _open(self, transport):
1489
"""See BzrDirFormat._open."""
1490
return BzrDir4(transport, self)
1492
def __return_repository_format(self):
1493
"""Circular import protection."""
1494
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1495
return RepositoryFormat4()
1496
repository_format = property(__return_repository_format)
1499
class BzrDirFormat5(BzrDirFormat):
1500
"""Bzr control format 5.
1502
This format is a combined format for working tree, branch and repository.
1504
- Format 2 working trees [always]
1505
- Format 4 branches [always]
1506
- Format 5 repositories [always]
1507
Unhashed stores in the repository.
1510
_lock_class = lockable_files.TransportLock
1512
def get_format_string(self):
1513
"""See BzrDirFormat.get_format_string()."""
1514
return "Bazaar-NG branch, format 5\n"
1516
def get_format_description(self):
1517
"""See BzrDirFormat.get_format_description()."""
1518
return "All-in-one format 5"
1520
def get_converter(self, format=None):
1521
"""See BzrDirFormat.get_converter()."""
1522
# there is one and only one upgrade path here.
1523
return ConvertBzrDir5To6()
1525
def _initialize_for_clone(self, url):
1526
return self.initialize_on_transport(get_transport(url), _cloning=True)
1528
def initialize_on_transport(self, transport, _cloning=False):
1529
"""Format 5 dirs always have working tree, branch and repository.
1531
Except when they are being cloned.
1533
from bzrlib.branch import BzrBranchFormat4
1534
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1535
from bzrlib.workingtree import WorkingTreeFormat2
1536
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1537
RepositoryFormat5().initialize(result, _internal=True)
1539
branch = BzrBranchFormat4().initialize(result)
1541
WorkingTreeFormat2().initialize(result)
1542
except errors.NotLocalUrl:
1543
# Even though we can't access the working tree, we need to
1544
# create its control files.
1545
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1548
def _open(self, transport):
1549
"""See BzrDirFormat._open."""
1550
return BzrDir5(transport, self)
1552
def __return_repository_format(self):
1553
"""Circular import protection."""
1554
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1555
return RepositoryFormat5()
1556
repository_format = property(__return_repository_format)
1559
class BzrDirFormat6(BzrDirFormat):
1560
"""Bzr control format 6.
1562
This format is a combined format for working tree, branch and repository.
1564
- Format 2 working trees [always]
1565
- Format 4 branches [always]
1566
- Format 6 repositories [always]
1569
_lock_class = lockable_files.TransportLock
1571
def get_format_string(self):
1572
"""See BzrDirFormat.get_format_string()."""
1573
return "Bazaar-NG branch, format 6\n"
1575
def get_format_description(self):
1576
"""See BzrDirFormat.get_format_description()."""
1577
return "All-in-one format 6"
1579
def get_converter(self, format=None):
1580
"""See BzrDirFormat.get_converter()."""
1581
# there is one and only one upgrade path here.
1582
return ConvertBzrDir6ToMeta()
1584
def _initialize_for_clone(self, url):
1585
return self.initialize_on_transport(get_transport(url), _cloning=True)
1587
def initialize_on_transport(self, transport, _cloning=False):
1588
"""Format 6 dirs always have working tree, branch and repository.
1590
Except when they are being cloned.
1592
from bzrlib.branch import BzrBranchFormat4
1593
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1594
from bzrlib.workingtree import WorkingTreeFormat2
1595
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1596
RepositoryFormat6().initialize(result, _internal=True)
1598
branch = BzrBranchFormat4().initialize(result)
1600
WorkingTreeFormat2().initialize(result)
1601
except errors.NotLocalUrl:
1602
# Even though we can't access the working tree, we need to
1603
# create its control files.
1604
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1607
def _open(self, transport):
1608
"""See BzrDirFormat._open."""
1609
return BzrDir6(transport, self)
1611
def __return_repository_format(self):
1612
"""Circular import protection."""
1613
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1614
return RepositoryFormat6()
1615
repository_format = property(__return_repository_format)
1618
class BzrDirMetaFormat1(BzrDirFormat):
1619
"""Bzr meta control format 1
1621
This is the first format with split out working tree, branch and repository
1624
- Format 3 working trees [optional]
1625
- Format 5 branches [optional]
1626
- Format 7 repositories [optional]
1629
_lock_class = lockdir.LockDir
1632
self._workingtree_format = None
1633
self._branch_format = None
1635
def __eq__(self, other):
1636
if other.__class__ is not self.__class__:
1638
if other.repository_format != self.repository_format:
1640
if other.workingtree_format != self.workingtree_format:
1644
def __ne__(self, other):
1645
return not self == other
1647
def get_branch_format(self):
1648
if self._branch_format is None:
1649
from bzrlib.branch import BranchFormat
1650
self._branch_format = BranchFormat.get_default_format()
1651
return self._branch_format
1653
def set_branch_format(self, format):
1654
self._branch_format = format
1656
def get_converter(self, format=None):
1657
"""See BzrDirFormat.get_converter()."""
1659
format = BzrDirFormat.get_default_format()
1660
if not isinstance(self, format.__class__):
1661
# converting away from metadir is not implemented
1662
raise NotImplementedError(self.get_converter)
1663
return ConvertMetaToMeta(format)
1665
def get_format_string(self):
1666
"""See BzrDirFormat.get_format_string()."""
1667
return "Bazaar-NG meta directory, format 1\n"
1669
def get_format_description(self):
1670
"""See BzrDirFormat.get_format_description()."""
1671
return "Meta directory format 1"
1673
def _open(self, transport):
1674
"""See BzrDirFormat._open."""
1675
return BzrDirMeta1(transport, self)
1677
def __return_repository_format(self):
1678
"""Circular import protection."""
1679
if getattr(self, '_repository_format', None):
1680
return self._repository_format
1681
from bzrlib.repository import RepositoryFormat
1682
return RepositoryFormat.get_default_format()
1684
def __set_repository_format(self, value):
1685
"""Allow changint the repository format for metadir formats."""
1686
self._repository_format = value
1688
repository_format = property(__return_repository_format, __set_repository_format)
1690
def __get_workingtree_format(self):
1691
if self._workingtree_format is None:
1692
from bzrlib.workingtree import WorkingTreeFormat
1693
self._workingtree_format = WorkingTreeFormat.get_default_format()
1694
return self._workingtree_format
1696
def __set_workingtree_format(self, wt_format):
1697
self._workingtree_format = wt_format
1699
workingtree_format = property(__get_workingtree_format,
1700
__set_workingtree_format)
1703
# Register bzr control format
1704
BzrDirFormat.register_control_format(BzrDirFormat)
1706
# Register bzr formats
1707
BzrDirFormat.register_format(BzrDirFormat4())
1708
BzrDirFormat.register_format(BzrDirFormat5())
1709
BzrDirFormat.register_format(BzrDirFormat6())
1710
__default_format = BzrDirMetaFormat1()
1711
BzrDirFormat.register_format(__default_format)
1712
BzrDirFormat._default_format = __default_format
1715
class Converter(object):
1716
"""Converts a disk format object from one format to another."""
1718
def convert(self, to_convert, pb):
1719
"""Perform the conversion of to_convert, giving feedback via pb.
1721
:param to_convert: The disk object to convert.
1722
:param pb: a progress bar to use for progress information.
1725
def step(self, message):
1726
"""Update the pb by a step."""
1728
self.pb.update(message, self.count, self.total)
1731
class ConvertBzrDir4To5(Converter):
1732
"""Converts format 4 bzr dirs to format 5."""
1735
super(ConvertBzrDir4To5, self).__init__()
1736
self.converted_revs = set()
1737
self.absent_revisions = set()
1741
def convert(self, to_convert, pb):
1742
"""See Converter.convert()."""
1743
self.bzrdir = to_convert
1745
self.pb.note('starting upgrade from format 4 to 5')
1746
if isinstance(self.bzrdir.transport, LocalTransport):
1747
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
1748
self._convert_to_weaves()
1749
return BzrDir.open(self.bzrdir.root_transport.base)
1751
def _convert_to_weaves(self):
1752
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
1755
stat = self.bzrdir.transport.stat('weaves')
1756
if not S_ISDIR(stat.st_mode):
1757
self.bzrdir.transport.delete('weaves')
1758
self.bzrdir.transport.mkdir('weaves')
1759
except errors.NoSuchFile:
1760
self.bzrdir.transport.mkdir('weaves')
1761
# deliberately not a WeaveFile as we want to build it up slowly.
1762
self.inv_weave = Weave('inventory')
1763
# holds in-memory weaves for all files
1764
self.text_weaves = {}
1765
self.bzrdir.transport.delete('branch-format')
1766
self.branch = self.bzrdir.open_branch()
1767
self._convert_working_inv()
1768
rev_history = self.branch.revision_history()
1769
# to_read is a stack holding the revisions we still need to process;
1770
# appending to it adds new highest-priority revisions
1771
self.known_revisions = set(rev_history)
1772
self.to_read = rev_history[-1:]
1774
rev_id = self.to_read.pop()
1775
if (rev_id not in self.revisions
1776
and rev_id not in self.absent_revisions):
1777
self._load_one_rev(rev_id)
1779
to_import = self._make_order()
1780
for i, rev_id in enumerate(to_import):
1781
self.pb.update('converting revision', i, len(to_import))
1782
self._convert_one_rev(rev_id)
1784
self._write_all_weaves()
1785
self._write_all_revs()
1786
self.pb.note('upgraded to weaves:')
1787
self.pb.note(' %6d revisions and inventories', len(self.revisions))
1788
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
1789
self.pb.note(' %6d texts', self.text_count)
1790
self._cleanup_spare_files_after_format4()
1791
self.branch.control_files.put_utf8('branch-format', BzrDirFormat5().get_format_string())
1793
def _cleanup_spare_files_after_format4(self):
1794
# FIXME working tree upgrade foo.
1795
for n in 'merged-patches', 'pending-merged-patches':
1797
## assert os.path.getsize(p) == 0
1798
self.bzrdir.transport.delete(n)
1799
except errors.NoSuchFile:
1801
self.bzrdir.transport.delete_tree('inventory-store')
1802
self.bzrdir.transport.delete_tree('text-store')
1804
def _convert_working_inv(self):
1805
inv = xml4.serializer_v4.read_inventory(
1806
self.branch.control_files.get('inventory'))
1807
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
1808
# FIXME inventory is a working tree change.
1809
self.branch.control_files.put('inventory', StringIO(new_inv_xml))
1811
def _write_all_weaves(self):
1812
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
1813
weave_transport = self.bzrdir.transport.clone('weaves')
1814
weaves = WeaveStore(weave_transport, prefixed=False)
1815
transaction = WriteTransaction()
1819
for file_id, file_weave in self.text_weaves.items():
1820
self.pb.update('writing weave', i, len(self.text_weaves))
1821
weaves._put_weave(file_id, file_weave, transaction)
1823
self.pb.update('inventory', 0, 1)
1824
controlweaves._put_weave('inventory', self.inv_weave, transaction)
1825
self.pb.update('inventory', 1, 1)
1829
def _write_all_revs(self):
1830
"""Write all revisions out in new form."""
1831
self.bzrdir.transport.delete_tree('revision-store')
1832
self.bzrdir.transport.mkdir('revision-store')
1833
revision_transport = self.bzrdir.transport.clone('revision-store')
1835
_revision_store = TextRevisionStore(TextStore(revision_transport,
1839
transaction = WriteTransaction()
1840
for i, rev_id in enumerate(self.converted_revs):
1841
self.pb.update('write revision', i, len(self.converted_revs))
1842
_revision_store.add_revision(self.revisions[rev_id], transaction)
1846
def _load_one_rev(self, rev_id):
1847
"""Load a revision object into memory.
1849
Any parents not either loaded or abandoned get queued to be
1851
self.pb.update('loading revision',
1852
len(self.revisions),
1853
len(self.known_revisions))
1854
if not self.branch.repository.has_revision(rev_id):
1856
self.pb.note('revision {%s} not present in branch; '
1857
'will be converted as a ghost',
1859
self.absent_revisions.add(rev_id)
1861
rev = self.branch.repository._revision_store.get_revision(rev_id,
1862
self.branch.repository.get_transaction())
1863
for parent_id in rev.parent_ids:
1864
self.known_revisions.add(parent_id)
1865
self.to_read.append(parent_id)
1866
self.revisions[rev_id] = rev
1868
def _load_old_inventory(self, rev_id):
1869
assert rev_id not in self.converted_revs
1870
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
1871
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
1872
inv.revision_id = rev_id
1873
rev = self.revisions[rev_id]
1874
if rev.inventory_sha1:
1875
assert rev.inventory_sha1 == sha_string(old_inv_xml), \
1876
'inventory sha mismatch for {%s}' % rev_id
1879
def _load_updated_inventory(self, rev_id):
1880
assert rev_id in self.converted_revs
1881
inv_xml = self.inv_weave.get_text(rev_id)
1882
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml)
1885
def _convert_one_rev(self, rev_id):
1886
"""Convert revision and all referenced objects to new format."""
1887
rev = self.revisions[rev_id]
1888
inv = self._load_old_inventory(rev_id)
1889
present_parents = [p for p in rev.parent_ids
1890
if p not in self.absent_revisions]
1891
self._convert_revision_contents(rev, inv, present_parents)
1892
self._store_new_weave(rev, inv, present_parents)
1893
self.converted_revs.add(rev_id)
1895
def _store_new_weave(self, rev, inv, present_parents):
1896
# the XML is now updated with text versions
1898
entries = inv.iter_entries()
1900
for path, ie in entries:
1901
assert getattr(ie, 'revision', None) is not None, \
1902
'no revision on {%s} in {%s}' % \
1903
(file_id, rev.revision_id)
1904
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
1905
new_inv_sha1 = sha_string(new_inv_xml)
1906
self.inv_weave.add_lines(rev.revision_id,
1908
new_inv_xml.splitlines(True))
1909
rev.inventory_sha1 = new_inv_sha1
1911
def _convert_revision_contents(self, rev, inv, present_parents):
1912
"""Convert all the files within a revision.
1914
Also upgrade the inventory to refer to the text revision ids."""
1915
rev_id = rev.revision_id
1916
mutter('converting texts of revision {%s}',
1918
parent_invs = map(self._load_updated_inventory, present_parents)
1919
entries = inv.iter_entries()
1921
for path, ie in entries:
1922
self._convert_file_version(rev, ie, parent_invs)
1924
def _convert_file_version(self, rev, ie, parent_invs):
1925
"""Convert one version of one file.
1927
The file needs to be added into the weave if it is a merge
1928
of >=2 parents or if it's changed from its parent.
1930
file_id = ie.file_id
1931
rev_id = rev.revision_id
1932
w = self.text_weaves.get(file_id)
1935
self.text_weaves[file_id] = w
1936
text_changed = False
1937
previous_entries = ie.find_previous_heads(parent_invs,
1941
for old_revision in previous_entries:
1942
# if this fails, its a ghost ?
1943
assert old_revision in self.converted_revs, \
1944
"Revision {%s} not in converted_revs" % old_revision
1945
self.snapshot_ie(previous_entries, ie, w, rev_id)
1947
assert getattr(ie, 'revision', None) is not None
1949
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
1950
# TODO: convert this logic, which is ~= snapshot to
1951
# a call to:. This needs the path figured out. rather than a work_tree
1952
# a v4 revision_tree can be given, or something that looks enough like
1953
# one to give the file content to the entry if it needs it.
1954
# and we need something that looks like a weave store for snapshot to
1956
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
1957
if len(previous_revisions) == 1:
1958
previous_ie = previous_revisions.values()[0]
1959
if ie._unchanged(previous_ie):
1960
ie.revision = previous_ie.revision
1963
text = self.branch.repository.weave_store.get(ie.text_id)
1964
file_lines = text.readlines()
1965
assert sha_strings(file_lines) == ie.text_sha1
1966
assert sum(map(len, file_lines)) == ie.text_size
1967
w.add_lines(rev_id, previous_revisions, file_lines)
1968
self.text_count += 1
1970
w.add_lines(rev_id, previous_revisions, [])
1971
ie.revision = rev_id
1973
def _make_order(self):
1974
"""Return a suitable order for importing revisions.
1976
The order must be such that an revision is imported after all
1977
its (present) parents.
1979
todo = set(self.revisions.keys())
1980
done = self.absent_revisions.copy()
1983
# scan through looking for a revision whose parents
1985
for rev_id in sorted(list(todo)):
1986
rev = self.revisions[rev_id]
1987
parent_ids = set(rev.parent_ids)
1988
if parent_ids.issubset(done):
1989
# can take this one now
1990
order.append(rev_id)
1996
class ConvertBzrDir5To6(Converter):
1997
"""Converts format 5 bzr dirs to format 6."""
1999
def convert(self, to_convert, pb):
2000
"""See Converter.convert()."""
2001
self.bzrdir = to_convert
2003
self.pb.note('starting upgrade from format 5 to 6')
2004
self._convert_to_prefixed()
2005
return BzrDir.open(self.bzrdir.root_transport.base)
2007
def _convert_to_prefixed(self):
2008
from bzrlib.store import TransportStore
2009
self.bzrdir.transport.delete('branch-format')
2010
for store_name in ["weaves", "revision-store"]:
2011
self.pb.note("adding prefixes to %s" % store_name)
2012
store_transport = self.bzrdir.transport.clone(store_name)
2013
store = TransportStore(store_transport, prefixed=True)
2014
for urlfilename in store_transport.list_dir('.'):
2015
filename = urlutils.unescape(urlfilename)
2016
if (filename.endswith(".weave") or
2017
filename.endswith(".gz") or
2018
filename.endswith(".sig")):
2019
file_id = os.path.splitext(filename)[0]
2022
prefix_dir = store.hash_prefix(file_id)
2023
# FIXME keep track of the dirs made RBC 20060121
2025
store_transport.move(filename, prefix_dir + '/' + filename)
2026
except errors.NoSuchFile: # catches missing dirs strangely enough
2027
store_transport.mkdir(prefix_dir)
2028
store_transport.move(filename, prefix_dir + '/' + filename)
2029
self.bzrdir._control_files.put_utf8('branch-format', BzrDirFormat6().get_format_string())
2032
class ConvertBzrDir6ToMeta(Converter):
2033
"""Converts format 6 bzr dirs to metadirs."""
2035
def convert(self, to_convert, pb):
2036
"""See Converter.convert()."""
2037
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2038
from bzrlib.branch import BzrBranchFormat5
2039
self.bzrdir = to_convert
2042
self.total = 20 # the steps we know about
2043
self.garbage_inventories = []
2045
self.pb.note('starting upgrade from format 6 to metadir')
2046
self.bzrdir._control_files.put_utf8('branch-format', "Converting to format 6")
2047
# its faster to move specific files around than to open and use the apis...
2048
# first off, nuke ancestry.weave, it was never used.
2050
self.step('Removing ancestry.weave')
2051
self.bzrdir.transport.delete('ancestry.weave')
2052
except errors.NoSuchFile:
2054
# find out whats there
2055
self.step('Finding branch files')
2056
last_revision = self.bzrdir.open_branch().last_revision()
2057
bzrcontents = self.bzrdir.transport.list_dir('.')
2058
for name in bzrcontents:
2059
if name.startswith('basis-inventory.'):
2060
self.garbage_inventories.append(name)
2061
# create new directories for repository, working tree and branch
2062
self.dir_mode = self.bzrdir._control_files._dir_mode
2063
self.file_mode = self.bzrdir._control_files._file_mode
2064
repository_names = [('inventory.weave', True),
2065
('revision-store', True),
2067
self.step('Upgrading repository ')
2068
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2069
self.make_lock('repository')
2070
# we hard code the formats here because we are converting into
2071
# the meta format. The meta format upgrader can take this to a
2072
# future format within each component.
2073
self.put_format('repository', RepositoryFormat7())
2074
for entry in repository_names:
2075
self.move_entry('repository', entry)
2077
self.step('Upgrading branch ')
2078
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2079
self.make_lock('branch')
2080
self.put_format('branch', BzrBranchFormat5())
2081
branch_files = [('revision-history', True),
2082
('branch-name', True),
2084
for entry in branch_files:
2085
self.move_entry('branch', entry)
2087
checkout_files = [('pending-merges', True),
2088
('inventory', True),
2089
('stat-cache', False)]
2090
# If a mandatory checkout file is not present, the branch does not have
2091
# a functional checkout. Do not create a checkout in the converted
2093
for name, mandatory in checkout_files:
2094
if mandatory and name not in bzrcontents:
2095
has_checkout = False
2099
if not has_checkout:
2100
self.pb.note('No working tree.')
2101
# If some checkout files are there, we may as well get rid of them.
2102
for name, mandatory in checkout_files:
2103
if name in bzrcontents:
2104
self.bzrdir.transport.delete(name)
2106
from bzrlib.workingtree import WorkingTreeFormat3
2107
self.step('Upgrading working tree')
2108
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2109
self.make_lock('checkout')
2111
'checkout', WorkingTreeFormat3())
2112
self.bzrdir.transport.delete_multi(
2113
self.garbage_inventories, self.pb)
2114
for entry in checkout_files:
2115
self.move_entry('checkout', entry)
2116
if last_revision is not None:
2117
self.bzrdir._control_files.put_utf8(
2118
'checkout/last-revision', last_revision)
2119
self.bzrdir._control_files.put_utf8(
2120
'branch-format', BzrDirMetaFormat1().get_format_string())
2121
return BzrDir.open(self.bzrdir.root_transport.base)
2123
def make_lock(self, name):
2124
"""Make a lock for the new control dir name."""
2125
self.step('Make %s lock' % name)
2126
ld = lockdir.LockDir(self.bzrdir.transport,
2128
file_modebits=self.file_mode,
2129
dir_modebits=self.dir_mode)
2132
def move_entry(self, new_dir, entry):
2133
"""Move then entry name into new_dir."""
2135
mandatory = entry[1]
2136
self.step('Moving %s' % name)
2138
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2139
except errors.NoSuchFile:
2143
def put_format(self, dirname, format):
2144
self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
2147
class ConvertMetaToMeta(Converter):
2148
"""Converts the components of metadirs."""
2150
def __init__(self, target_format):
2151
"""Create a metadir to metadir converter.
2153
:param target_format: The final metadir format that is desired.
2155
self.target_format = target_format
2157
def convert(self, to_convert, pb):
2158
"""See Converter.convert()."""
2159
self.bzrdir = to_convert
2163
self.step('checking repository format')
2165
repo = self.bzrdir.open_repository()
2166
except errors.NoRepositoryPresent:
2169
if not isinstance(repo._format, self.target_format.repository_format.__class__):
2170
from bzrlib.repository import CopyConverter
2171
self.pb.note('starting repository conversion')
2172
converter = CopyConverter(self.target_format.repository_format)
2173
converter.convert(repo, pb)
2175
branch = self.bzrdir.open_branch()
2176
except errors.NotBranchError:
2179
# TODO: conversions of Branch and Tree should be done by
2180
# InterXFormat lookups
2181
# Avoid circular imports
2182
from bzrlib import branch as _mod_branch
2183
if (branch._format.__class__ is _mod_branch.BzrBranchFormat5 and
2184
self.target_format.get_branch_format().__class__ is
2185
_mod_branch.BzrBranchFormat6):
2186
branch_converter = _mod_branch.Converter5to6()
2187
branch_converter.convert(branch)
2189
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
2190
except (errors.NoWorkingTree, errors.NotLocalUrl):
2193
# TODO: conversions of Branch and Tree should be done by
2194
# InterXFormat lookups
2195
if (isinstance(tree, workingtree.WorkingTree3) and
2196
not isinstance(tree, workingtree_4.WorkingTree4) and
2197
isinstance(self.target_format.workingtree_format,
2198
workingtree_4.WorkingTreeFormat4)):
2199
workingtree_4.Converter3to4().convert(tree)
2203
# This is not in remote.py because it's small, and needs to be registered.
2204
# Putting it in remote.py creates a circular import problem.
2205
# we can make it a lazy object if the control formats is turned into something
2207
class RemoteBzrDirFormat(BzrDirMetaFormat1):
2208
"""Format representing bzrdirs accessed via a smart server"""
2210
def get_format_description(self):
2211
return 'bzr remote bzrdir'
2214
def probe_transport(klass, transport):
2215
"""Return a RemoteBzrDirFormat object if it looks possible."""
2217
client = transport.get_smart_client()
2218
except (NotImplementedError, AttributeError,
2219
errors.TransportNotPossible):
2220
# no smart server, so not a branch for this format type.
2221
raise errors.NotBranchError(path=transport.base)
2223
# Send a 'hello' request in protocol version one, and decline to
2224
# open it if the server doesn't support our required version (2) so
2225
# that the VFS-based transport will do it.
2226
request = client.get_request()
2227
smart_protocol = protocol.SmartClientRequestProtocolOne(request)
2228
server_version = smart_protocol.query_version()
2229
if server_version != 2:
2230
raise errors.NotBranchError(path=transport.base)
2233
def initialize_on_transport(self, transport):
2235
# hand off the request to the smart server
2236
shared_medium = transport.get_shared_medium()
2237
except errors.NoSmartMedium:
2238
# TODO: lookup the local format from a server hint.
2239
local_dir_format = BzrDirMetaFormat1()
2240
return local_dir_format.initialize_on_transport(transport)
2241
client = _SmartClient(shared_medium)
2242
path = client.remote_path_from_transport(transport)
2243
response = _SmartClient(shared_medium).call('BzrDirFormat.initialize',
2245
assert response[0] in ('ok', ), 'unexpected response code %s' % (response,)
2246
return remote.RemoteBzrDir(transport)
2248
def _open(self, transport):
2249
return remote.RemoteBzrDir(transport)
2251
def __eq__(self, other):
2252
if not isinstance(other, RemoteBzrDirFormat):
2254
return self.get_format_description() == other.get_format_description()
2257
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
2260
class BzrDirFormatInfo(object):
2262
def __init__(self, native, deprecated, hidden):
2263
self.deprecated = deprecated
2264
self.native = native
2265
self.hidden = hidden
2268
class BzrDirFormatRegistry(registry.Registry):
2269
"""Registry of user-selectable BzrDir subformats.
2271
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
2272
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
2275
def register_metadir(self, key,
2276
repository_format, help, native=True, deprecated=False,
2280
"""Register a metadir subformat.
2282
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
2283
by the Repository format.
2285
:param repository_format: The fully-qualified repository format class
2287
:param branch_format: Fully-qualified branch format class name as
2289
:param tree_format: Fully-qualified tree format class name as
2292
# This should be expanded to support setting WorkingTree and Branch
2293
# formats, once BzrDirMetaFormat1 supports that.
2294
def _load(full_name):
2295
mod_name, factory_name = full_name.rsplit('.', 1)
2297
mod = __import__(mod_name, globals(), locals(),
2299
except ImportError, e:
2300
raise ImportError('failed to load %s: %s' % (full_name, e))
2302
factory = getattr(mod, factory_name)
2303
except AttributeError:
2304
raise AttributeError('no factory %s in module %r'
2309
bd = BzrDirMetaFormat1()
2310
if branch_format is not None:
2311
bd.set_branch_format(_load(branch_format))
2312
if tree_format is not None:
2313
bd.workingtree_format = _load(tree_format)
2314
if repository_format is not None:
2315
bd.repository_format = _load(repository_format)
2317
self.register(key, helper, help, native, deprecated, hidden)
2319
def register(self, key, factory, help, native=True, deprecated=False,
2321
"""Register a BzrDirFormat factory.
2323
The factory must be a callable that takes one parameter: the key.
2324
It must produce an instance of the BzrDirFormat when called.
2326
This function mainly exists to prevent the info object from being
2329
registry.Registry.register(self, key, factory, help,
2330
BzrDirFormatInfo(native, deprecated, hidden))
2332
def register_lazy(self, key, module_name, member_name, help, native=True,
2333
deprecated=False, hidden=False):
2334
registry.Registry.register_lazy(self, key, module_name, member_name,
2335
help, BzrDirFormatInfo(native, deprecated, hidden))
2337
def set_default(self, key):
2338
"""Set the 'default' key to be a clone of the supplied key.
2340
This method must be called once and only once.
2342
registry.Registry.register(self, 'default', self.get(key),
2343
self.get_help(key), info=self.get_info(key))
2345
def set_default_repository(self, key):
2346
"""Set the FormatRegistry default and Repository default.
2348
This is a transitional method while Repository.set_default_format
2351
if 'default' in self:
2352
self.remove('default')
2353
self.set_default(key)
2354
format = self.get('default')()
2355
assert isinstance(format, BzrDirMetaFormat1)
2357
def make_bzrdir(self, key):
2358
return self.get(key)()
2360
def help_topic(self, topic):
2361
output = textwrap.dedent("""\
2362
These formats can be used for creating branches, working trees, and
2366
default_realkey = None
2367
default_help = self.get_help('default')
2369
for key in self.keys():
2370
if key == 'default':
2372
help = self.get_help(key)
2373
if help == default_help:
2374
default_realkey = key
2376
help_pairs.append((key, help))
2378
def wrapped(key, help, info):
2380
help = '(native) ' + help
2381
return ':%s:\n%s\n\n' % (key,
2382
textwrap.fill(help, initial_indent=' ',
2383
subsequent_indent=' '))
2384
if default_realkey is not None:
2385
output += wrapped(default_realkey, '(default) %s' % default_help,
2386
self.get_info('default'))
2387
deprecated_pairs = []
2388
for key, help in help_pairs:
2389
info = self.get_info(key)
2392
elif info.deprecated:
2393
deprecated_pairs.append((key, help))
2395
output += wrapped(key, help, info)
2396
if len(deprecated_pairs) > 0:
2397
output += "Deprecated formats are shown below.\n\n"
2398
for key, help in deprecated_pairs:
2399
info = self.get_info(key)
2400
output += wrapped(key, help, info)
2405
format_registry = BzrDirFormatRegistry()
2406
format_registry.register('weave', BzrDirFormat6,
2407
'Pre-0.8 format. Slower than knit and does not'
2408
' support checkouts or shared repositories.',
2410
format_registry.register_metadir('knit',
2411
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2412
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
2413
branch_format='bzrlib.branch.BzrBranchFormat5',
2414
tree_format='bzrlib.workingtree.WorkingTreeFormat3')
2415
format_registry.register_metadir('metaweave',
2416
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
2417
'Transitional format in 0.8. Slower than knit.',
2418
branch_format='bzrlib.branch.BzrBranchFormat5',
2419
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2421
format_registry.register_metadir('dirstate',
2422
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2423
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2424
'above when accessed over the network.',
2425
branch_format='bzrlib.branch.BzrBranchFormat5',
2426
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
2427
# directly from workingtree_4 triggers a circular import.
2428
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2430
format_registry.register_metadir('dirstate-tags',
2431
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2432
help='New in 0.15: Fast local operations and improved scaling for '
2433
'network operations. Additionally adds support for tags.'
2434
' Incompatible with bzr < 0.15.',
2435
branch_format='bzrlib.branch.BzrBranchFormat6',
2436
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2438
format_registry.register_metadir('dirstate-with-subtree',
2439
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2440
help='New in 0.15: Fast local operations and improved scaling for '
2441
'network operations. Additionally adds support for versioning nested '
2442
'bzr branches. Incompatible with bzr < 0.15.',
2443
branch_format='bzrlib.branch.BzrBranchFormat6',
2444
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2447
format_registry.set_default('dirstate-tags')
added
removed
bzrlib/bzrdir.py
