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
22
Note: This module has a lot of ``open`` functions/methods that return
23
references to in-memory objects. As a rule, there are no matching ``close``
24
methods. To free any associated resources, simply stop referencing the
28
# TODO: Move old formats into a plugin to make this file smaller.
30
from cStringIO import StringIO
34
from bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
36
from stat import S_ISDIR
38
from warnings import warn
48
revision as _mod_revision,
58
from bzrlib.osutils import (
62
from bzrlib.smart.client import _SmartClient
63
from bzrlib.smart import protocol
64
from bzrlib.store.revision.text import TextRevisionStore
65
from bzrlib.store.text import TextStore
66
from bzrlib.store.versioned import WeaveStore
67
from bzrlib.transactions import WriteTransaction
68
from bzrlib.transport import (
69
do_catching_redirections,
72
from bzrlib.weave import Weave
75
from bzrlib.trace import (
79
from bzrlib.transport.local import LocalTransport
80
from bzrlib.symbol_versioning import (
88
"""A .bzr control diretory.
90
BzrDir instances let you create or open any of the things that can be
91
found within .bzr - checkouts, branches and repositories.
94
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
96
a transport connected to the directory this bzr was opened from
97
(i.e. the parent directory holding the .bzr directory).
100
def break_lock(self):
101
"""Invoke break_lock on the first object in the bzrdir.
103
If there is a tree, the tree is opened and break_lock() called.
104
Otherwise, branch is tried, and finally repository.
106
# XXX: This seems more like a UI function than something that really
107
# belongs in this class.
109
thing_to_unlock = self.open_workingtree()
110
except (errors.NotLocalUrl, errors.NoWorkingTree):
112
thing_to_unlock = self.open_branch()
113
except errors.NotBranchError:
115
thing_to_unlock = self.open_repository()
116
except errors.NoRepositoryPresent:
118
thing_to_unlock.break_lock()
120
def can_convert_format(self):
121
"""Return true if this bzrdir is one whose format we can convert from."""
124
def check_conversion_target(self, target_format):
125
target_repo_format = target_format.repository_format
126
source_repo_format = self._format.repository_format
127
source_repo_format.check_conversion_target(target_repo_format)
130
def _check_supported(format, allow_unsupported,
131
recommend_upgrade=True,
133
"""Give an error or warning on old formats.
135
:param format: may be any kind of format - workingtree, branch,
138
:param allow_unsupported: If true, allow opening
139
formats that are strongly deprecated, and which may
140
have limited functionality.
142
:param recommend_upgrade: If true (default), warn
143
the user through the ui object that they may wish
144
to upgrade the object.
146
# TODO: perhaps move this into a base Format class; it's not BzrDir
147
# specific. mbp 20070323
148
if not allow_unsupported and not format.is_supported():
149
# see open_downlevel to open legacy branches.
150
raise errors.UnsupportedFormatError(format=format)
151
if recommend_upgrade \
152
and getattr(format, 'upgrade_recommended', False):
153
ui.ui_factory.recommend_upgrade(
154
format.get_format_description(),
157
def clone(self, url, revision_id=None, force_new_repo=False):
158
"""Clone this bzrdir and its contents to url verbatim.
160
If url's last component does not exist, it will be created.
162
if revision_id is not None, then the clone operation may tune
163
itself to download less data.
164
:param force_new_repo: Do not use a shared repository for the target
165
even if one is available.
167
return self.clone_on_transport(get_transport(url),
168
revision_id=revision_id,
169
force_new_repo=force_new_repo)
171
def clone_on_transport(self, transport, revision_id=None,
172
force_new_repo=False):
173
"""Clone this bzrdir and its contents to transport verbatim.
175
If the target directory does not exist, it will be created.
177
if revision_id is not None, then the clone operation may tune
178
itself to download less data.
179
:param force_new_repo: Do not use a shared repository for the target
180
even if one is available.
182
transport.ensure_base()
183
result = self._format.initialize_on_transport(transport)
185
local_repo = self.find_repository()
186
except errors.NoRepositoryPresent:
189
# may need to copy content in
191
result_repo = local_repo.clone(
193
revision_id=revision_id)
194
result_repo.set_make_working_trees(local_repo.make_working_trees())
197
result_repo = result.find_repository()
198
# fetch content this dir needs.
199
result_repo.fetch(local_repo, revision_id=revision_id)
200
except errors.NoRepositoryPresent:
201
# needed to make one anyway.
202
result_repo = local_repo.clone(
204
revision_id=revision_id)
205
result_repo.set_make_working_trees(local_repo.make_working_trees())
206
# 1 if there is a branch present
207
# make sure its content is available in the target repository
210
self.open_branch().clone(result, revision_id=revision_id)
211
except errors.NotBranchError:
214
result_repo = result.find_repository()
215
except errors.NoRepositoryPresent:
217
if result_repo is None or result_repo.make_working_trees():
219
self.open_workingtree().clone(result)
220
except (errors.NoWorkingTree, errors.NotLocalUrl):
224
# TODO: This should be given a Transport, and should chdir up; otherwise
225
# this will open a new connection.
226
def _make_tail(self, url):
227
t = get_transport(url)
231
def create(cls, base, format=None, possible_transports=None):
232
"""Create a new BzrDir at the url 'base'.
234
:param format: If supplied, the format of branch to create. If not
235
supplied, the default is used.
236
:param possible_transports: If supplied, a list of transports that
237
can be reused to share a remote connection.
239
if cls is not BzrDir:
240
raise AssertionError("BzrDir.create always creates the default"
241
" format, not one of %r" % cls)
242
t = get_transport(base, possible_transports)
245
format = BzrDirFormat.get_default_format()
246
return format.initialize_on_transport(t)
248
def destroy_repository(self):
249
"""Destroy the repository in this BzrDir"""
250
raise NotImplementedError(self.destroy_repository)
252
def create_branch(self):
253
"""Create a branch in this BzrDir.
255
The bzrdir's format will control what branch format is created.
256
For more control see BranchFormatXX.create(a_bzrdir).
258
raise NotImplementedError(self.create_branch)
260
def destroy_branch(self):
261
"""Destroy the branch in this BzrDir"""
262
raise NotImplementedError(self.destroy_branch)
265
def create_branch_and_repo(base, force_new_repo=False, format=None):
266
"""Create a new BzrDir, Branch and Repository at the url 'base'.
268
This will use the current default BzrDirFormat unless one is
269
specified, and use whatever
270
repository format that that uses via bzrdir.create_branch and
271
create_repository. If a shared repository is available that is used
274
The created Branch object is returned.
276
:param base: The URL to create the branch at.
277
:param force_new_repo: If True a new repository is always created.
278
:param format: If supplied, the format of branch to create. If not
279
supplied, the default is used.
281
bzrdir = BzrDir.create(base, format)
282
bzrdir._find_or_create_repository(force_new_repo)
283
return bzrdir.create_branch()
285
def _find_or_create_repository(self, force_new_repo):
286
"""Create a new repository if needed, returning the repository."""
288
return self.create_repository()
290
return self.find_repository()
291
except errors.NoRepositoryPresent:
292
return self.create_repository()
295
def create_branch_convenience(base, force_new_repo=False,
296
force_new_tree=None, format=None,
297
possible_transports=None):
298
"""Create a new BzrDir, Branch and Repository at the url 'base'.
300
This is a convenience function - it will use an existing repository
301
if possible, can be told explicitly whether to create a working tree or
304
This will use the current default BzrDirFormat unless one is
305
specified, and use whatever
306
repository format that that uses via bzrdir.create_branch and
307
create_repository. If a shared repository is available that is used
308
preferentially. Whatever repository is used, its tree creation policy
311
The created Branch object is returned.
312
If a working tree cannot be made due to base not being a file:// url,
313
no error is raised unless force_new_tree is True, in which case no
314
data is created on disk and NotLocalUrl is raised.
316
:param base: The URL to create the branch at.
317
:param force_new_repo: If True a new repository is always created.
318
:param force_new_tree: If True or False force creation of a tree or
319
prevent such creation respectively.
320
:param format: Override for the bzrdir format to create.
321
:param possible_transports: An optional reusable transports list.
324
# check for non local urls
325
t = get_transport(base, possible_transports)
326
if not isinstance(t, LocalTransport):
327
raise errors.NotLocalUrl(base)
328
bzrdir = BzrDir.create(base, format, possible_transports)
329
repo = bzrdir._find_or_create_repository(force_new_repo)
330
result = bzrdir.create_branch()
331
if force_new_tree or (repo.make_working_trees() and
332
force_new_tree is None):
334
bzrdir.create_workingtree()
335
except errors.NotLocalUrl:
340
@deprecated_function(zero_ninetyone)
341
def create_repository(base, shared=False, format=None):
342
"""Create a new BzrDir and Repository at the url 'base'.
344
If no format is supplied, this will default to the current default
345
BzrDirFormat by default, and use whatever repository format that that
346
uses for bzrdirformat.create_repository.
348
:param shared: Create a shared repository rather than a standalone
350
The Repository object is returned.
352
This must be overridden as an instance method in child classes, where
353
it should take no parameters and construct whatever repository format
354
that child class desires.
356
This method is deprecated, please call create_repository on a bzrdir
359
bzrdir = BzrDir.create(base, format)
360
return bzrdir.create_repository(shared)
363
def create_standalone_workingtree(base, format=None):
364
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
366
'base' must be a local path or a file:// url.
368
This will use the current default BzrDirFormat unless one is
369
specified, and use whatever
370
repository format that that uses for bzrdirformat.create_workingtree,
371
create_branch and create_repository.
373
:param format: Override for the bzrdir format to create.
374
:return: The WorkingTree object.
376
t = get_transport(base)
377
if not isinstance(t, LocalTransport):
378
raise errors.NotLocalUrl(base)
379
bzrdir = BzrDir.create_branch_and_repo(base,
381
format=format).bzrdir
382
return bzrdir.create_workingtree()
384
def create_workingtree(self, revision_id=None, from_branch=None):
385
"""Create a working tree at this BzrDir.
387
:param revision_id: create it as of this revision id.
388
:param from_branch: override bzrdir branch (for lightweight checkouts)
390
raise NotImplementedError(self.create_workingtree)
392
def retire_bzrdir(self, limit=10000):
393
"""Permanently disable the bzrdir.
395
This is done by renaming it to give the user some ability to recover
396
if there was a problem.
398
This will have horrible consequences if anyone has anything locked or
400
:param limit: number of times to retry
405
to_path = '.bzr.retired.%d' % i
406
self.root_transport.rename('.bzr', to_path)
407
note("renamed %s to %s"
408
% (self.root_transport.abspath('.bzr'), to_path))
410
except (errors.TransportError, IOError, errors.PathError):
417
def destroy_workingtree(self):
418
"""Destroy the working tree at this BzrDir.
420
Formats that do not support this may raise UnsupportedOperation.
422
raise NotImplementedError(self.destroy_workingtree)
424
def destroy_workingtree_metadata(self):
425
"""Destroy the control files for the working tree at this BzrDir.
427
The contents of working tree files are not affected.
428
Formats that do not support this may raise UnsupportedOperation.
430
raise NotImplementedError(self.destroy_workingtree_metadata)
432
def find_repository(self):
433
"""Find the repository that should be used.
435
This does not require a branch as we use it to find the repo for
436
new branches as well as to hook existing branches up to their
440
return self.open_repository()
441
except errors.NoRepositoryPresent:
443
next_transport = self.root_transport.clone('..')
445
# find the next containing bzrdir
447
found_bzrdir = BzrDir.open_containing_from_transport(
449
except errors.NotBranchError:
451
raise errors.NoRepositoryPresent(self)
452
# does it have a repository ?
454
repository = found_bzrdir.open_repository()
455
except errors.NoRepositoryPresent:
456
next_transport = found_bzrdir.root_transport.clone('..')
457
if (found_bzrdir.root_transport.base == next_transport.base):
458
# top of the file system
462
if ((found_bzrdir.root_transport.base ==
463
self.root_transport.base) or repository.is_shared()):
466
raise errors.NoRepositoryPresent(self)
467
raise errors.NoRepositoryPresent(self)
469
def get_branch_reference(self):
470
"""Return the referenced URL for the branch in this bzrdir.
472
:raises NotBranchError: If there is no Branch.
473
:return: The URL the branch in this bzrdir references if it is a
474
reference branch, or None for regular branches.
478
def get_branch_transport(self, branch_format):
479
"""Get the transport for use by branch format in this BzrDir.
481
Note that bzr dirs that do not support format strings will raise
482
IncompatibleFormat if the branch format they are given has
483
a format string, and vice versa.
485
If branch_format is None, the transport is returned with no
486
checking. If it is not None, then the returned transport is
487
guaranteed to point to an existing directory ready for use.
489
raise NotImplementedError(self.get_branch_transport)
491
def get_repository_transport(self, repository_format):
492
"""Get the transport for use by repository format in this BzrDir.
494
Note that bzr dirs that do not support format strings will raise
495
IncompatibleFormat if the repository format they are given has
496
a format string, and vice versa.
498
If repository_format is None, the transport is returned with no
499
checking. If it is not None, then the returned transport is
500
guaranteed to point to an existing directory ready for use.
502
raise NotImplementedError(self.get_repository_transport)
504
def get_workingtree_transport(self, tree_format):
505
"""Get the transport for use by workingtree format in this BzrDir.
507
Note that bzr dirs that do not support format strings will raise
508
IncompatibleFormat if the workingtree format they are given has a
509
format string, and vice versa.
511
If workingtree_format is None, the transport is returned with no
512
checking. If it is not None, then the returned transport is
513
guaranteed to point to an existing directory ready for use.
515
raise NotImplementedError(self.get_workingtree_transport)
517
def __init__(self, _transport, _format):
518
"""Initialize a Bzr control dir object.
520
Only really common logic should reside here, concrete classes should be
521
made with varying behaviours.
523
:param _format: the format that is creating this BzrDir instance.
524
:param _transport: the transport this dir is based at.
526
self._format = _format
527
self.transport = _transport.clone('.bzr')
528
self.root_transport = _transport
530
def is_control_filename(self, filename):
531
"""True if filename is the name of a path which is reserved for bzrdir's.
533
:param filename: A filename within the root transport of this bzrdir.
535
This is true IF and ONLY IF the filename is part of the namespace reserved
536
for bzr control dirs. Currently this is the '.bzr' directory in the root
537
of the root_transport. it is expected that plugins will need to extend
538
this in the future - for instance to make bzr talk with svn working
541
# this might be better on the BzrDirFormat class because it refers to
542
# all the possible bzrdir disk formats.
543
# This method is tested via the workingtree is_control_filename tests-
544
# it was extracted from WorkingTree.is_control_filename. If the method's
545
# contract is extended beyond the current trivial implementation, please
546
# add new tests for it to the appropriate place.
547
return filename == '.bzr' or filename.startswith('.bzr/')
549
def needs_format_conversion(self, format=None):
550
"""Return true if this bzrdir needs convert_format run on it.
552
For instance, if the repository format is out of date but the
553
branch and working tree are not, this should return True.
555
:param format: Optional parameter indicating a specific desired
556
format we plan to arrive at.
558
raise NotImplementedError(self.needs_format_conversion)
561
def open_unsupported(base):
562
"""Open a branch which is not supported."""
563
return BzrDir.open(base, _unsupported=True)
566
def open(base, _unsupported=False, possible_transports=None):
567
"""Open an existing bzrdir, rooted at 'base' (url).
569
:param _unsupported: a private parameter to the BzrDir class.
571
t = get_transport(base, possible_transports=possible_transports)
572
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
575
def open_from_transport(transport, _unsupported=False,
576
_server_formats=True):
577
"""Open a bzrdir within a particular directory.
579
:param transport: Transport containing the bzrdir.
580
:param _unsupported: private.
582
base = transport.base
584
def find_format(transport):
585
return transport, BzrDirFormat.find_format(
586
transport, _server_formats=_server_formats)
588
def redirected(transport, e, redirection_notice):
589
qualified_source = e.get_source_url()
590
relpath = transport.relpath(qualified_source)
591
if not e.target.endswith(relpath):
592
# Not redirected to a branch-format, not a branch
593
raise errors.NotBranchError(path=e.target)
594
target = e.target[:-len(relpath)]
595
note('%s is%s redirected to %s',
596
transport.base, e.permanently, target)
597
# Let's try with a new transport
598
# FIXME: If 'transport' has a qualifier, this should
599
# be applied again to the new transport *iff* the
600
# schemes used are the same. Uncomment this code
601
# once the function (and tests) exist.
603
#target = urlutils.copy_url_qualifiers(original, target)
604
return get_transport(target)
607
transport, format = do_catching_redirections(find_format,
610
except errors.TooManyRedirections:
611
raise errors.NotBranchError(base)
613
BzrDir._check_supported(format, _unsupported)
614
return format.open(transport, _found=True)
616
def open_branch(self, unsupported=False):
617
"""Open the branch object at this BzrDir if one is present.
619
If unsupported is True, then no longer supported branch formats can
622
TODO: static convenience version of this?
624
raise NotImplementedError(self.open_branch)
627
def open_containing(url, possible_transports=None):
628
"""Open an existing branch which contains url.
630
:param url: url to search from.
631
See open_containing_from_transport for more detail.
633
transport = get_transport(url, possible_transports)
634
return BzrDir.open_containing_from_transport(transport)
637
def open_containing_from_transport(a_transport):
638
"""Open an existing branch which contains a_transport.base.
640
This probes for a branch at a_transport, and searches upwards from there.
642
Basically we keep looking up until we find the control directory or
643
run into the root. If there isn't one, raises NotBranchError.
644
If there is one and it is either an unrecognised format or an unsupported
645
format, UnknownFormatError or UnsupportedFormatError are raised.
646
If there is one, it is returned, along with the unused portion of url.
648
:return: The BzrDir that contains the path, and a Unicode path
649
for the rest of the URL.
651
# this gets the normalised url back. I.e. '.' -> the full path.
652
url = a_transport.base
655
result = BzrDir.open_from_transport(a_transport)
656
return result, urlutils.unescape(a_transport.relpath(url))
657
except errors.NotBranchError, e:
660
new_t = a_transport.clone('..')
661
except errors.InvalidURLJoin:
662
# reached the root, whatever that may be
663
raise errors.NotBranchError(path=url)
664
if new_t.base == a_transport.base:
665
# reached the root, whatever that may be
666
raise errors.NotBranchError(path=url)
669
def _get_tree_branch(self):
670
"""Return the branch and tree, if any, for this bzrdir.
672
Return None for tree if not present.
673
Raise NotBranchError if no branch is present.
674
:return: (tree, branch)
677
tree = self.open_workingtree()
678
except (errors.NoWorkingTree, errors.NotLocalUrl):
680
branch = self.open_branch()
686
def open_tree_or_branch(klass, location):
687
"""Return the branch and working tree at a location.
689
If there is no tree at the location, tree will be None.
690
If there is no branch at the location, an exception will be
692
:return: (tree, branch)
694
bzrdir = klass.open(location)
695
return bzrdir._get_tree_branch()
698
def open_containing_tree_or_branch(klass, location):
699
"""Return the branch and working tree contained by a location.
701
Returns (tree, branch, relpath).
702
If there is no tree at containing the location, tree will be None.
703
If there is no branch containing the location, an exception will be
705
relpath is the portion of the path that is contained by the branch.
707
bzrdir, relpath = klass.open_containing(location)
708
tree, branch = bzrdir._get_tree_branch()
709
return tree, branch, relpath
711
def open_repository(self, _unsupported=False):
712
"""Open the repository object at this BzrDir if one is present.
714
This will not follow the Branch object pointer - it's strictly a direct
715
open facility. Most client code should use open_branch().repository to
718
:param _unsupported: a private parameter, not part of the api.
719
TODO: static convenience version of this?
721
raise NotImplementedError(self.open_repository)
723
def open_workingtree(self, _unsupported=False,
724
recommend_upgrade=True, from_branch=None):
725
"""Open the workingtree object at this BzrDir if one is present.
727
:param recommend_upgrade: Optional keyword parameter, when True (the
728
default), emit through the ui module a recommendation that the user
729
upgrade the working tree when the workingtree being opened is old
730
(but still fully supported).
731
:param from_branch: override bzrdir branch (for lightweight checkouts)
733
raise NotImplementedError(self.open_workingtree)
735
def has_branch(self):
736
"""Tell if this bzrdir contains a branch.
738
Note: if you're going to open the branch, you should just go ahead
739
and try, and not ask permission first. (This method just opens the
740
branch and discards it, and that's somewhat expensive.)
745
except errors.NotBranchError:
748
def has_workingtree(self):
749
"""Tell if this bzrdir contains a working tree.
751
This will still raise an exception if the bzrdir has a workingtree that
752
is remote & inaccessible.
754
Note: if you're going to open the working tree, you should just go ahead
755
and try, and not ask permission first. (This method just opens the
756
workingtree and discards it, and that's somewhat expensive.)
759
self.open_workingtree(recommend_upgrade=False)
761
except errors.NoWorkingTree:
764
def _cloning_metadir(self):
765
"""Produce a metadir suitable for cloning with."""
766
result_format = self._format.__class__()
769
branch = self.open_branch()
770
source_repository = branch.repository
771
except errors.NotBranchError:
773
source_repository = self.open_repository()
774
except errors.NoRepositoryPresent:
775
source_repository = None
777
# XXX TODO: This isinstance is here because we have not implemented
778
# the fix recommended in bug # 103195 - to delegate this choice the
780
repo_format = source_repository._format
781
if not isinstance(repo_format, remote.RemoteRepositoryFormat):
782
result_format.repository_format = repo_format
784
# TODO: Couldn't we just probe for the format in these cases,
785
# rather than opening the whole tree? It would be a little
786
# faster. mbp 20070401
787
tree = self.open_workingtree(recommend_upgrade=False)
788
except (errors.NoWorkingTree, errors.NotLocalUrl):
789
result_format.workingtree_format = None
791
result_format.workingtree_format = tree._format.__class__()
792
return result_format, source_repository
794
def cloning_metadir(self):
795
"""Produce a metadir suitable for cloning or sprouting with.
797
These operations may produce workingtrees (yes, even though they're
798
"cloning" something that doesn't have a tree), so a viable workingtree
799
format must be selected.
801
format, repository = self._cloning_metadir()
802
if format._workingtree_format is None:
803
if repository is None:
805
tree_format = repository._format._matchingbzrdir.workingtree_format
806
format.workingtree_format = tree_format.__class__()
809
def checkout_metadir(self):
810
return self.cloning_metadir()
812
def sprout(self, url, revision_id=None, force_new_repo=False,
813
recurse='down', possible_transports=None,
814
accelerator_tree=None):
815
"""Create a copy of this bzrdir prepared for use as a new line of
818
If url's last component does not exist, it will be created.
820
Attributes related to the identity of the source branch like
821
branch nickname will be cleaned, a working tree is created
822
whether one existed before or not; and a local branch is always
825
if revision_id is not None, then the clone operation may tune
826
itself to download less data.
828
target_transport = get_transport(url, possible_transports)
829
target_transport.ensure_base()
830
cloning_format = self.cloning_metadir()
831
result = cloning_format.initialize_on_transport(target_transport)
833
source_branch = self.open_branch()
834
source_repository = source_branch.repository
835
except errors.NotBranchError:
838
source_repository = self.open_repository()
839
except errors.NoRepositoryPresent:
840
source_repository = None
845
result_repo = result.find_repository()
846
except errors.NoRepositoryPresent:
848
if source_repository is None and result_repo is not None:
850
elif source_repository is None and result_repo is None:
851
# no repo available, make a new one
852
result.create_repository()
853
elif source_repository is not None and result_repo is None:
854
# have source, and want to make a new target repo
855
result_repo = source_repository.sprout(result,
856
revision_id=revision_id)
858
# fetch needed content into target.
859
if source_repository is not None:
861
# source_repository.copy_content_into(result_repo,
862
# revision_id=revision_id)
863
# so we can override the copy method
864
result_repo.fetch(source_repository, revision_id=revision_id)
865
if source_branch is not None:
866
source_branch.sprout(result, revision_id=revision_id)
868
result.create_branch()
869
if isinstance(target_transport, LocalTransport) and (
870
result_repo is None or result_repo.make_working_trees()):
871
wt = result.create_workingtree(accelerator_tree=accelerator_tree)
874
if wt.path2id('') is None:
876
wt.set_root_id(self.open_workingtree.get_root_id())
877
except errors.NoWorkingTree:
883
if recurse == 'down':
885
basis = wt.basis_tree()
887
subtrees = basis.iter_references()
888
recurse_branch = wt.branch
889
elif source_branch is not None:
890
basis = source_branch.basis_tree()
892
subtrees = basis.iter_references()
893
recurse_branch = source_branch
898
for path, file_id in subtrees:
899
target = urlutils.join(url, urlutils.escape(path))
900
sublocation = source_branch.reference_parent(file_id, path)
901
sublocation.bzrdir.sprout(target,
902
basis.get_reference_revision(file_id, path),
903
force_new_repo=force_new_repo, recurse=recurse)
905
if basis is not None:
910
class BzrDirPreSplitOut(BzrDir):
911
"""A common class for the all-in-one formats."""
913
def __init__(self, _transport, _format):
914
"""See BzrDir.__init__."""
915
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
916
assert self._format._lock_class == lockable_files.TransportLock
917
assert self._format._lock_file_name == 'branch-lock'
918
self._control_files = lockable_files.LockableFiles(
919
self.get_branch_transport(None),
920
self._format._lock_file_name,
921
self._format._lock_class)
923
def break_lock(self):
924
"""Pre-splitout bzrdirs do not suffer from stale locks."""
925
raise NotImplementedError(self.break_lock)
927
def clone(self, url, revision_id=None, force_new_repo=False):
928
"""See BzrDir.clone()."""
929
from bzrlib.workingtree import WorkingTreeFormat2
931
result = self._format._initialize_for_clone(url)
932
self.open_repository().clone(result, revision_id=revision_id)
933
from_branch = self.open_branch()
934
from_branch.clone(result, revision_id=revision_id)
936
self.open_workingtree().clone(result)
937
except errors.NotLocalUrl:
938
# make a new one, this format always has to have one.
940
WorkingTreeFormat2().initialize(result)
941
except errors.NotLocalUrl:
942
# but we cannot do it for remote trees.
943
to_branch = result.open_branch()
944
WorkingTreeFormat2().stub_initialize_remote(to_branch.control_files)
947
def create_branch(self):
948
"""See BzrDir.create_branch."""
949
return self.open_branch()
951
def destroy_branch(self):
952
"""See BzrDir.destroy_branch."""
953
raise errors.UnsupportedOperation(self.destroy_branch, self)
955
def create_repository(self, shared=False):
956
"""See BzrDir.create_repository."""
958
raise errors.IncompatibleFormat('shared repository', self._format)
959
return self.open_repository()
961
def destroy_repository(self):
962
"""See BzrDir.destroy_repository."""
963
raise errors.UnsupportedOperation(self.destroy_repository, self)
965
def create_workingtree(self, revision_id=None, from_branch=None,
966
accelerator_tree=None):
967
"""See BzrDir.create_workingtree."""
968
# this looks buggy but is not -really-
969
# because this format creates the workingtree when the bzrdir is
971
# clone and sprout will have set the revision_id
972
# and that will have set it for us, its only
973
# specific uses of create_workingtree in isolation
974
# that can do wonky stuff here, and that only
975
# happens for creating checkouts, which cannot be
976
# done on this format anyway. So - acceptable wart.
977
result = self.open_workingtree(recommend_upgrade=False)
978
if revision_id is not None:
979
if revision_id == _mod_revision.NULL_REVISION:
980
result.set_parent_ids([])
982
result.set_parent_ids([revision_id])
985
def destroy_workingtree(self):
986
"""See BzrDir.destroy_workingtree."""
987
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
989
def destroy_workingtree_metadata(self):
990
"""See BzrDir.destroy_workingtree_metadata."""
991
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
994
def get_branch_transport(self, branch_format):
995
"""See BzrDir.get_branch_transport()."""
996
if branch_format is None:
997
return self.transport
999
branch_format.get_format_string()
1000
except NotImplementedError:
1001
return self.transport
1002
raise errors.IncompatibleFormat(branch_format, self._format)
1004
def get_repository_transport(self, repository_format):
1005
"""See BzrDir.get_repository_transport()."""
1006
if repository_format is None:
1007
return self.transport
1009
repository_format.get_format_string()
1010
except NotImplementedError:
1011
return self.transport
1012
raise errors.IncompatibleFormat(repository_format, self._format)
1014
def get_workingtree_transport(self, workingtree_format):
1015
"""See BzrDir.get_workingtree_transport()."""
1016
if workingtree_format is None:
1017
return self.transport
1019
workingtree_format.get_format_string()
1020
except NotImplementedError:
1021
return self.transport
1022
raise errors.IncompatibleFormat(workingtree_format, self._format)
1024
def needs_format_conversion(self, format=None):
1025
"""See BzrDir.needs_format_conversion()."""
1026
# if the format is not the same as the system default,
1027
# an upgrade is needed.
1029
format = BzrDirFormat.get_default_format()
1030
return not isinstance(self._format, format.__class__)
1032
def open_branch(self, unsupported=False):
1033
"""See BzrDir.open_branch."""
1034
from bzrlib.branch import BzrBranchFormat4
1035
format = BzrBranchFormat4()
1036
self._check_supported(format, unsupported)
1037
return format.open(self, _found=True)
1039
def sprout(self, url, revision_id=None, force_new_repo=False,
1040
possible_transports=None, accelerator_tree=None):
1041
"""See BzrDir.sprout()."""
1042
from bzrlib.workingtree import WorkingTreeFormat2
1043
self._make_tail(url)
1044
result = self._format._initialize_for_clone(url)
1046
self.open_repository().clone(result, revision_id=revision_id)
1047
except errors.NoRepositoryPresent:
1050
self.open_branch().sprout(result, revision_id=revision_id)
1051
except errors.NotBranchError:
1053
# we always want a working tree
1054
WorkingTreeFormat2().initialize(result,
1055
accelerator_tree=accelerator_tree)
1059
class BzrDir4(BzrDirPreSplitOut):
1060
"""A .bzr version 4 control object.
1062
This is a deprecated format and may be removed after sept 2006.
1065
def create_repository(self, shared=False):
1066
"""See BzrDir.create_repository."""
1067
return self._format.repository_format.initialize(self, shared)
1069
def needs_format_conversion(self, format=None):
1070
"""Format 4 dirs are always in need of conversion."""
1073
def open_repository(self):
1074
"""See BzrDir.open_repository."""
1075
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1076
return RepositoryFormat4().open(self, _found=True)
1079
class BzrDir5(BzrDirPreSplitOut):
1080
"""A .bzr version 5 control object.
1082
This is a deprecated format and may be removed after sept 2006.
1085
def open_repository(self):
1086
"""See BzrDir.open_repository."""
1087
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1088
return RepositoryFormat5().open(self, _found=True)
1090
def open_workingtree(self, _unsupported=False,
1091
recommend_upgrade=True):
1092
"""See BzrDir.create_workingtree."""
1093
from bzrlib.workingtree import WorkingTreeFormat2
1094
wt_format = WorkingTreeFormat2()
1095
# we don't warn here about upgrades; that ought to be handled for the
1097
return wt_format.open(self, _found=True)
1100
class BzrDir6(BzrDirPreSplitOut):
1101
"""A .bzr version 6 control object.
1103
This is a deprecated format and may be removed after sept 2006.
1106
def open_repository(self):
1107
"""See BzrDir.open_repository."""
1108
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1109
return RepositoryFormat6().open(self, _found=True)
1111
def open_workingtree(self, _unsupported=False,
1112
recommend_upgrade=True):
1113
"""See BzrDir.create_workingtree."""
1114
# we don't warn here about upgrades; that ought to be handled for the
1116
from bzrlib.workingtree import WorkingTreeFormat2
1117
return WorkingTreeFormat2().open(self, _found=True)
1120
class BzrDirMeta1(BzrDir):
1121
"""A .bzr meta version 1 control object.
1123
This is the first control object where the
1124
individual aspects are really split out: there are separate repository,
1125
workingtree and branch subdirectories and any subset of the three can be
1126
present within a BzrDir.
1129
def can_convert_format(self):
1130
"""See BzrDir.can_convert_format()."""
1133
def create_branch(self):
1134
"""See BzrDir.create_branch."""
1135
return self._format.get_branch_format().initialize(self)
1137
def destroy_branch(self):
1138
"""See BzrDir.create_branch."""
1139
self.transport.delete_tree('branch')
1141
def create_repository(self, shared=False):
1142
"""See BzrDir.create_repository."""
1143
return self._format.repository_format.initialize(self, shared)
1145
def destroy_repository(self):
1146
"""See BzrDir.destroy_repository."""
1147
self.transport.delete_tree('repository')
1149
def create_workingtree(self, revision_id=None, from_branch=None,
1150
accelerator_tree=None):
1151
"""See BzrDir.create_workingtree."""
1152
return self._format.workingtree_format.initialize(
1153
self, revision_id, from_branch=from_branch,
1154
accelerator_tree=accelerator_tree)
1156
def destroy_workingtree(self):
1157
"""See BzrDir.destroy_workingtree."""
1158
wt = self.open_workingtree(recommend_upgrade=False)
1159
repository = wt.branch.repository
1160
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1161
wt.revert(old_tree=empty)
1162
self.destroy_workingtree_metadata()
1164
def destroy_workingtree_metadata(self):
1165
self.transport.delete_tree('checkout')
1167
def find_branch_format(self):
1168
"""Find the branch 'format' for this bzrdir.
1170
This might be a synthetic object for e.g. RemoteBranch and SVN.
1172
from bzrlib.branch import BranchFormat
1173
return BranchFormat.find_format(self)
1175
def _get_mkdir_mode(self):
1176
"""Figure out the mode to use when creating a bzrdir subdir."""
1177
temp_control = lockable_files.LockableFiles(self.transport, '',
1178
lockable_files.TransportLock)
1179
return temp_control._dir_mode
1181
def get_branch_reference(self):
1182
"""See BzrDir.get_branch_reference()."""
1183
from bzrlib.branch import BranchFormat
1184
format = BranchFormat.find_format(self)
1185
return format.get_reference(self)
1187
def get_branch_transport(self, branch_format):
1188
"""See BzrDir.get_branch_transport()."""
1189
if branch_format is None:
1190
return self.transport.clone('branch')
1192
branch_format.get_format_string()
1193
except NotImplementedError:
1194
raise errors.IncompatibleFormat(branch_format, self._format)
1196
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1197
except errors.FileExists:
1199
return self.transport.clone('branch')
1201
def get_repository_transport(self, repository_format):
1202
"""See BzrDir.get_repository_transport()."""
1203
if repository_format is None:
1204
return self.transport.clone('repository')
1206
repository_format.get_format_string()
1207
except NotImplementedError:
1208
raise errors.IncompatibleFormat(repository_format, self._format)
1210
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1211
except errors.FileExists:
1213
return self.transport.clone('repository')
1215
def get_workingtree_transport(self, workingtree_format):
1216
"""See BzrDir.get_workingtree_transport()."""
1217
if workingtree_format is None:
1218
return self.transport.clone('checkout')
1220
workingtree_format.get_format_string()
1221
except NotImplementedError:
1222
raise errors.IncompatibleFormat(workingtree_format, self._format)
1224
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1225
except errors.FileExists:
1227
return self.transport.clone('checkout')
1229
def needs_format_conversion(self, format=None):
1230
"""See BzrDir.needs_format_conversion()."""
1232
format = BzrDirFormat.get_default_format()
1233
if not isinstance(self._format, format.__class__):
1234
# it is not a meta dir format, conversion is needed.
1236
# we might want to push this down to the repository?
1238
if not isinstance(self.open_repository()._format,
1239
format.repository_format.__class__):
1240
# the repository needs an upgrade.
1242
except errors.NoRepositoryPresent:
1245
if not isinstance(self.open_branch()._format,
1246
format.get_branch_format().__class__):
1247
# the branch needs an upgrade.
1249
except errors.NotBranchError:
1252
my_wt = self.open_workingtree(recommend_upgrade=False)
1253
if not isinstance(my_wt._format,
1254
format.workingtree_format.__class__):
1255
# the workingtree needs an upgrade.
1257
except (errors.NoWorkingTree, errors.NotLocalUrl):
1261
def open_branch(self, unsupported=False):
1262
"""See BzrDir.open_branch."""
1263
format = self.find_branch_format()
1264
self._check_supported(format, unsupported)
1265
return format.open(self, _found=True)
1267
def open_repository(self, unsupported=False):
1268
"""See BzrDir.open_repository."""
1269
from bzrlib.repository import RepositoryFormat
1270
format = RepositoryFormat.find_format(self)
1271
self._check_supported(format, unsupported)
1272
return format.open(self, _found=True)
1274
def open_workingtree(self, unsupported=False,
1275
recommend_upgrade=True):
1276
"""See BzrDir.open_workingtree."""
1277
from bzrlib.workingtree import WorkingTreeFormat
1278
format = WorkingTreeFormat.find_format(self)
1279
self._check_supported(format, unsupported,
1281
basedir=self.root_transport.base)
1282
return format.open(self, _found=True)
1285
class BzrDirFormat(object):
1286
"""An encapsulation of the initialization and open routines for a format.
1288
Formats provide three things:
1289
* An initialization routine,
1293
Formats are placed in a dict by their format string for reference
1294
during bzrdir opening. These should be subclasses of BzrDirFormat
1297
Once a format is deprecated, just deprecate the initialize and open
1298
methods on the format class. Do not deprecate the object, as the
1299
object will be created every system load.
1302
_default_format = None
1303
"""The default format used for new .bzr dirs."""
1306
"""The known formats."""
1308
_control_formats = []
1309
"""The registered control formats - .bzr, ....
1311
This is a list of BzrDirFormat objects.
1314
_control_server_formats = []
1315
"""The registered control server formats, e.g. RemoteBzrDirs.
1317
This is a list of BzrDirFormat objects.
1320
_lock_file_name = 'branch-lock'
1322
# _lock_class must be set in subclasses to the lock type, typ.
1323
# TransportLock or LockDir
1326
def find_format(klass, transport, _server_formats=True):
1327
"""Return the format present at transport."""
1329
formats = klass._control_server_formats + klass._control_formats
1331
formats = klass._control_formats
1332
for format in formats:
1334
return format.probe_transport(transport)
1335
except errors.NotBranchError:
1336
# this format does not find a control dir here.
1338
raise errors.NotBranchError(path=transport.base)
1341
def probe_transport(klass, transport):
1342
"""Return the .bzrdir style format present in a directory."""
1344
format_string = transport.get(".bzr/branch-format").read()
1345
except errors.NoSuchFile:
1346
raise errors.NotBranchError(path=transport.base)
1349
return klass._formats[format_string]
1351
raise errors.UnknownFormatError(format=format_string)
1354
def get_default_format(klass):
1355
"""Return the current default format."""
1356
return klass._default_format
1358
def get_format_string(self):
1359
"""Return the ASCII format string that identifies this format."""
1360
raise NotImplementedError(self.get_format_string)
1362
def get_format_description(self):
1363
"""Return the short description for this format."""
1364
raise NotImplementedError(self.get_format_description)
1366
def get_converter(self, format=None):
1367
"""Return the converter to use to convert bzrdirs needing converts.
1369
This returns a bzrlib.bzrdir.Converter object.
1371
This should return the best upgrader to step this format towards the
1372
current default format. In the case of plugins we can/should provide
1373
some means for them to extend the range of returnable converters.
1375
:param format: Optional format to override the default format of the
1378
raise NotImplementedError(self.get_converter)
1380
def initialize(self, url, possible_transports=None):
1381
"""Create a bzr control dir at this url and return an opened copy.
1383
Subclasses should typically override initialize_on_transport
1384
instead of this method.
1386
return self.initialize_on_transport(get_transport(url,
1387
possible_transports))
1389
def initialize_on_transport(self, transport):
1390
"""Initialize a new bzrdir in the base directory of a Transport."""
1391
# Since we don't have a .bzr directory, inherit the
1392
# mode from the root directory
1393
temp_control = lockable_files.LockableFiles(transport,
1394
'', lockable_files.TransportLock)
1395
temp_control._transport.mkdir('.bzr',
1396
# FIXME: RBC 20060121 don't peek under
1398
mode=temp_control._dir_mode)
1399
if sys.platform == 'win32' and isinstance(transport, LocalTransport):
1400
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1401
file_mode = temp_control._file_mode
1403
mutter('created control directory in ' + transport.base)
1404
control = transport.clone('.bzr')
1405
utf8_files = [('README',
1406
"This is a Bazaar-NG control directory.\n"
1407
"Do not change any files in this directory.\n"),
1408
('branch-format', self.get_format_string()),
1410
# NB: no need to escape relative paths that are url safe.
1411
control_files = lockable_files.LockableFiles(control,
1412
self._lock_file_name, self._lock_class)
1413
control_files.create_lock()
1414
control_files.lock_write()
1416
for file, content in utf8_files:
1417
control_files.put_utf8(file, content)
1419
control_files.unlock()
1420
return self.open(transport, _found=True)
1422
def is_supported(self):
1423
"""Is this format supported?
1425
Supported formats must be initializable and openable.
1426
Unsupported formats may not support initialization or committing or
1427
some other features depending on the reason for not being supported.
1431
def same_model(self, target_format):
1432
return (self.repository_format.rich_root_data ==
1433
target_format.rich_root_data)
1436
def known_formats(klass):
1437
"""Return all the known formats.
1439
Concrete formats should override _known_formats.
1441
# There is double indirection here to make sure that control
1442
# formats used by more than one dir format will only be probed
1443
# once. This can otherwise be quite expensive for remote connections.
1445
for format in klass._control_formats:
1446
result.update(format._known_formats())
1450
def _known_formats(klass):
1451
"""Return the known format instances for this control format."""
1452
return set(klass._formats.values())
1454
def open(self, transport, _found=False):
1455
"""Return an instance of this format for the dir transport points at.
1457
_found is a private parameter, do not use it.
1460
found_format = BzrDirFormat.find_format(transport)
1461
if not isinstance(found_format, self.__class__):
1462
raise AssertionError("%s was asked to open %s, but it seems to need "
1464
% (self, transport, found_format))
1465
return self._open(transport)
1467
def _open(self, transport):
1468
"""Template method helper for opening BzrDirectories.
1470
This performs the actual open and any additional logic or parameter
1473
raise NotImplementedError(self._open)
1476
def register_format(klass, format):
1477
klass._formats[format.get_format_string()] = format
1480
def register_control_format(klass, format):
1481
"""Register a format that does not use '.bzr' for its control dir.
1483
TODO: This should be pulled up into a 'ControlDirFormat' base class
1484
which BzrDirFormat can inherit from, and renamed to register_format
1485
there. It has been done without that for now for simplicity of
1488
klass._control_formats.append(format)
1491
def register_control_server_format(klass, format):
1492
"""Register a control format for client-server environments.
1494
These formats will be tried before ones registered with
1495
register_control_format. This gives implementations that decide to the
1496
chance to grab it before anything looks at the contents of the format
1499
klass._control_server_formats.append(format)
1502
@symbol_versioning.deprecated_method(symbol_versioning.zero_fourteen)
1503
def set_default_format(klass, format):
1504
klass._set_default_format(format)
1507
def _set_default_format(klass, format):
1508
"""Set default format (for testing behavior of defaults only)"""
1509
klass._default_format = format
1513
return self.get_format_string().rstrip()
1516
def unregister_format(klass, format):
1517
assert klass._formats[format.get_format_string()] is format
1518
del klass._formats[format.get_format_string()]
1521
def unregister_control_format(klass, format):
1522
klass._control_formats.remove(format)
1525
class BzrDirFormat4(BzrDirFormat):
1526
"""Bzr dir format 4.
1528
This format is a combined format for working tree, branch and repository.
1530
- Format 1 working trees [always]
1531
- Format 4 branches [always]
1532
- Format 4 repositories [always]
1534
This format is deprecated: it indexes texts using a text it which is
1535
removed in format 5; write support for this format has been removed.
1538
_lock_class = lockable_files.TransportLock
1540
def get_format_string(self):
1541
"""See BzrDirFormat.get_format_string()."""
1542
return "Bazaar-NG branch, format 0.0.4\n"
1544
def get_format_description(self):
1545
"""See BzrDirFormat.get_format_description()."""
1546
return "All-in-one format 4"
1548
def get_converter(self, format=None):
1549
"""See BzrDirFormat.get_converter()."""
1550
# there is one and only one upgrade path here.
1551
return ConvertBzrDir4To5()
1553
def initialize_on_transport(self, transport):
1554
"""Format 4 branches cannot be created."""
1555
raise errors.UninitializableFormat(self)
1557
def is_supported(self):
1558
"""Format 4 is not supported.
1560
It is not supported because the model changed from 4 to 5 and the
1561
conversion logic is expensive - so doing it on the fly was not
1566
def _open(self, transport):
1567
"""See BzrDirFormat._open."""
1568
return BzrDir4(transport, self)
1570
def __return_repository_format(self):
1571
"""Circular import protection."""
1572
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1573
return RepositoryFormat4()
1574
repository_format = property(__return_repository_format)
1577
class BzrDirFormat5(BzrDirFormat):
1578
"""Bzr control format 5.
1580
This format is a combined format for working tree, branch and repository.
1582
- Format 2 working trees [always]
1583
- Format 4 branches [always]
1584
- Format 5 repositories [always]
1585
Unhashed stores in the repository.
1588
_lock_class = lockable_files.TransportLock
1590
def get_format_string(self):
1591
"""See BzrDirFormat.get_format_string()."""
1592
return "Bazaar-NG branch, format 5\n"
1594
def get_format_description(self):
1595
"""See BzrDirFormat.get_format_description()."""
1596
return "All-in-one format 5"
1598
def get_converter(self, format=None):
1599
"""See BzrDirFormat.get_converter()."""
1600
# there is one and only one upgrade path here.
1601
return ConvertBzrDir5To6()
1603
def _initialize_for_clone(self, url):
1604
return self.initialize_on_transport(get_transport(url), _cloning=True)
1606
def initialize_on_transport(self, transport, _cloning=False):
1607
"""Format 5 dirs always have working tree, branch and repository.
1609
Except when they are being cloned.
1611
from bzrlib.branch import BzrBranchFormat4
1612
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1613
from bzrlib.workingtree import WorkingTreeFormat2
1614
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1615
RepositoryFormat5().initialize(result, _internal=True)
1617
branch = BzrBranchFormat4().initialize(result)
1619
WorkingTreeFormat2().initialize(result)
1620
except errors.NotLocalUrl:
1621
# Even though we can't access the working tree, we need to
1622
# create its control files.
1623
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1626
def _open(self, transport):
1627
"""See BzrDirFormat._open."""
1628
return BzrDir5(transport, self)
1630
def __return_repository_format(self):
1631
"""Circular import protection."""
1632
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1633
return RepositoryFormat5()
1634
repository_format = property(__return_repository_format)
1637
class BzrDirFormat6(BzrDirFormat):
1638
"""Bzr control format 6.
1640
This format is a combined format for working tree, branch and repository.
1642
- Format 2 working trees [always]
1643
- Format 4 branches [always]
1644
- Format 6 repositories [always]
1647
_lock_class = lockable_files.TransportLock
1649
def get_format_string(self):
1650
"""See BzrDirFormat.get_format_string()."""
1651
return "Bazaar-NG branch, format 6\n"
1653
def get_format_description(self):
1654
"""See BzrDirFormat.get_format_description()."""
1655
return "All-in-one format 6"
1657
def get_converter(self, format=None):
1658
"""See BzrDirFormat.get_converter()."""
1659
# there is one and only one upgrade path here.
1660
return ConvertBzrDir6ToMeta()
1662
def _initialize_for_clone(self, url):
1663
return self.initialize_on_transport(get_transport(url), _cloning=True)
1665
def initialize_on_transport(self, transport, _cloning=False):
1666
"""Format 6 dirs always have working tree, branch and repository.
1668
Except when they are being cloned.
1670
from bzrlib.branch import BzrBranchFormat4
1671
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1672
from bzrlib.workingtree import WorkingTreeFormat2
1673
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1674
RepositoryFormat6().initialize(result, _internal=True)
1676
branch = BzrBranchFormat4().initialize(result)
1678
WorkingTreeFormat2().initialize(result)
1679
except errors.NotLocalUrl:
1680
# Even though we can't access the working tree, we need to
1681
# create its control files.
1682
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1685
def _open(self, transport):
1686
"""See BzrDirFormat._open."""
1687
return BzrDir6(transport, self)
1689
def __return_repository_format(self):
1690
"""Circular import protection."""
1691
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1692
return RepositoryFormat6()
1693
repository_format = property(__return_repository_format)
1696
class BzrDirMetaFormat1(BzrDirFormat):
1697
"""Bzr meta control format 1
1699
This is the first format with split out working tree, branch and repository
1702
- Format 3 working trees [optional]
1703
- Format 5 branches [optional]
1704
- Format 7 repositories [optional]
1707
_lock_class = lockdir.LockDir
1710
self._workingtree_format = None
1711
self._branch_format = None
1713
def __eq__(self, other):
1714
if other.__class__ is not self.__class__:
1716
if other.repository_format != self.repository_format:
1718
if other.workingtree_format != self.workingtree_format:
1722
def __ne__(self, other):
1723
return not self == other
1725
def get_branch_format(self):
1726
if self._branch_format is None:
1727
from bzrlib.branch import BranchFormat
1728
self._branch_format = BranchFormat.get_default_format()
1729
return self._branch_format
1731
def set_branch_format(self, format):
1732
self._branch_format = format
1734
def get_converter(self, format=None):
1735
"""See BzrDirFormat.get_converter()."""
1737
format = BzrDirFormat.get_default_format()
1738
if not isinstance(self, format.__class__):
1739
# converting away from metadir is not implemented
1740
raise NotImplementedError(self.get_converter)
1741
return ConvertMetaToMeta(format)
1743
def get_format_string(self):
1744
"""See BzrDirFormat.get_format_string()."""
1745
return "Bazaar-NG meta directory, format 1\n"
1747
def get_format_description(self):
1748
"""See BzrDirFormat.get_format_description()."""
1749
return "Meta directory format 1"
1751
def _open(self, transport):
1752
"""See BzrDirFormat._open."""
1753
return BzrDirMeta1(transport, self)
1755
def __return_repository_format(self):
1756
"""Circular import protection."""
1757
if getattr(self, '_repository_format', None):
1758
return self._repository_format
1759
from bzrlib.repository import RepositoryFormat
1760
return RepositoryFormat.get_default_format()
1762
def __set_repository_format(self, value):
1763
"""Allow changing the repository format for metadir formats."""
1764
self._repository_format = value
1766
repository_format = property(__return_repository_format, __set_repository_format)
1768
def __get_workingtree_format(self):
1769
if self._workingtree_format is None:
1770
from bzrlib.workingtree import WorkingTreeFormat
1771
self._workingtree_format = WorkingTreeFormat.get_default_format()
1772
return self._workingtree_format
1774
def __set_workingtree_format(self, wt_format):
1775
self._workingtree_format = wt_format
1777
workingtree_format = property(__get_workingtree_format,
1778
__set_workingtree_format)
1781
# Register bzr control format
1782
BzrDirFormat.register_control_format(BzrDirFormat)
1784
# Register bzr formats
1785
BzrDirFormat.register_format(BzrDirFormat4())
1786
BzrDirFormat.register_format(BzrDirFormat5())
1787
BzrDirFormat.register_format(BzrDirFormat6())
1788
__default_format = BzrDirMetaFormat1()
1789
BzrDirFormat.register_format(__default_format)
1790
BzrDirFormat._default_format = __default_format
1793
class Converter(object):
1794
"""Converts a disk format object from one format to another."""
1796
def convert(self, to_convert, pb):
1797
"""Perform the conversion of to_convert, giving feedback via pb.
1799
:param to_convert: The disk object to convert.
1800
:param pb: a progress bar to use for progress information.
1803
def step(self, message):
1804
"""Update the pb by a step."""
1806
self.pb.update(message, self.count, self.total)
1809
class ConvertBzrDir4To5(Converter):
1810
"""Converts format 4 bzr dirs to format 5."""
1813
super(ConvertBzrDir4To5, self).__init__()
1814
self.converted_revs = set()
1815
self.absent_revisions = set()
1819
def convert(self, to_convert, pb):
1820
"""See Converter.convert()."""
1821
self.bzrdir = to_convert
1823
self.pb.note('starting upgrade from format 4 to 5')
1824
if isinstance(self.bzrdir.transport, LocalTransport):
1825
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
1826
self._convert_to_weaves()
1827
return BzrDir.open(self.bzrdir.root_transport.base)
1829
def _convert_to_weaves(self):
1830
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
1833
stat = self.bzrdir.transport.stat('weaves')
1834
if not S_ISDIR(stat.st_mode):
1835
self.bzrdir.transport.delete('weaves')
1836
self.bzrdir.transport.mkdir('weaves')
1837
except errors.NoSuchFile:
1838
self.bzrdir.transport.mkdir('weaves')
1839
# deliberately not a WeaveFile as we want to build it up slowly.
1840
self.inv_weave = Weave('inventory')
1841
# holds in-memory weaves for all files
1842
self.text_weaves = {}
1843
self.bzrdir.transport.delete('branch-format')
1844
self.branch = self.bzrdir.open_branch()
1845
self._convert_working_inv()
1846
rev_history = self.branch.revision_history()
1847
# to_read is a stack holding the revisions we still need to process;
1848
# appending to it adds new highest-priority revisions
1849
self.known_revisions = set(rev_history)
1850
self.to_read = rev_history[-1:]
1852
rev_id = self.to_read.pop()
1853
if (rev_id not in self.revisions
1854
and rev_id not in self.absent_revisions):
1855
self._load_one_rev(rev_id)
1857
to_import = self._make_order()
1858
for i, rev_id in enumerate(to_import):
1859
self.pb.update('converting revision', i, len(to_import))
1860
self._convert_one_rev(rev_id)
1862
self._write_all_weaves()
1863
self._write_all_revs()
1864
self.pb.note('upgraded to weaves:')
1865
self.pb.note(' %6d revisions and inventories', len(self.revisions))
1866
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
1867
self.pb.note(' %6d texts', self.text_count)
1868
self._cleanup_spare_files_after_format4()
1869
self.branch.control_files.put_utf8('branch-format', BzrDirFormat5().get_format_string())
1871
def _cleanup_spare_files_after_format4(self):
1872
# FIXME working tree upgrade foo.
1873
for n in 'merged-patches', 'pending-merged-patches':
1875
## assert os.path.getsize(p) == 0
1876
self.bzrdir.transport.delete(n)
1877
except errors.NoSuchFile:
1879
self.bzrdir.transport.delete_tree('inventory-store')
1880
self.bzrdir.transport.delete_tree('text-store')
1882
def _convert_working_inv(self):
1883
inv = xml4.serializer_v4.read_inventory(
1884
self.branch.control_files.get('inventory'))
1885
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
1886
# FIXME inventory is a working tree change.
1887
self.branch.control_files.put('inventory', StringIO(new_inv_xml))
1889
def _write_all_weaves(self):
1890
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
1891
weave_transport = self.bzrdir.transport.clone('weaves')
1892
weaves = WeaveStore(weave_transport, prefixed=False)
1893
transaction = WriteTransaction()
1897
for file_id, file_weave in self.text_weaves.items():
1898
self.pb.update('writing weave', i, len(self.text_weaves))
1899
weaves._put_weave(file_id, file_weave, transaction)
1901
self.pb.update('inventory', 0, 1)
1902
controlweaves._put_weave('inventory', self.inv_weave, transaction)
1903
self.pb.update('inventory', 1, 1)
1907
def _write_all_revs(self):
1908
"""Write all revisions out in new form."""
1909
self.bzrdir.transport.delete_tree('revision-store')
1910
self.bzrdir.transport.mkdir('revision-store')
1911
revision_transport = self.bzrdir.transport.clone('revision-store')
1913
_revision_store = TextRevisionStore(TextStore(revision_transport,
1917
transaction = WriteTransaction()
1918
for i, rev_id in enumerate(self.converted_revs):
1919
self.pb.update('write revision', i, len(self.converted_revs))
1920
_revision_store.add_revision(self.revisions[rev_id], transaction)
1924
def _load_one_rev(self, rev_id):
1925
"""Load a revision object into memory.
1927
Any parents not either loaded or abandoned get queued to be
1929
self.pb.update('loading revision',
1930
len(self.revisions),
1931
len(self.known_revisions))
1932
if not self.branch.repository.has_revision(rev_id):
1934
self.pb.note('revision {%s} not present in branch; '
1935
'will be converted as a ghost',
1937
self.absent_revisions.add(rev_id)
1939
rev = self.branch.repository._revision_store.get_revision(rev_id,
1940
self.branch.repository.get_transaction())
1941
for parent_id in rev.parent_ids:
1942
self.known_revisions.add(parent_id)
1943
self.to_read.append(parent_id)
1944
self.revisions[rev_id] = rev
1946
def _load_old_inventory(self, rev_id):
1947
assert rev_id not in self.converted_revs
1948
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
1949
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
1950
inv.revision_id = rev_id
1951
rev = self.revisions[rev_id]
1952
if rev.inventory_sha1:
1953
assert rev.inventory_sha1 == sha_string(old_inv_xml), \
1954
'inventory sha mismatch for {%s}' % rev_id
1957
def _load_updated_inventory(self, rev_id):
1958
assert rev_id in self.converted_revs
1959
inv_xml = self.inv_weave.get_text(rev_id)
1960
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml)
1963
def _convert_one_rev(self, rev_id):
1964
"""Convert revision and all referenced objects to new format."""
1965
rev = self.revisions[rev_id]
1966
inv = self._load_old_inventory(rev_id)
1967
present_parents = [p for p in rev.parent_ids
1968
if p not in self.absent_revisions]
1969
self._convert_revision_contents(rev, inv, present_parents)
1970
self._store_new_inv(rev, inv, present_parents)
1971
self.converted_revs.add(rev_id)
1973
def _store_new_inv(self, rev, inv, present_parents):
1974
# the XML is now updated with text versions
1976
entries = inv.iter_entries()
1978
for path, ie in entries:
1979
assert getattr(ie, 'revision', None) is not None, \
1980
'no revision on {%s} in {%s}' % \
1981
(file_id, rev.revision_id)
1982
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
1983
new_inv_sha1 = sha_string(new_inv_xml)
1984
self.inv_weave.add_lines(rev.revision_id,
1986
new_inv_xml.splitlines(True))
1987
rev.inventory_sha1 = new_inv_sha1
1989
def _convert_revision_contents(self, rev, inv, present_parents):
1990
"""Convert all the files within a revision.
1992
Also upgrade the inventory to refer to the text revision ids."""
1993
rev_id = rev.revision_id
1994
mutter('converting texts of revision {%s}',
1996
parent_invs = map(self._load_updated_inventory, present_parents)
1997
entries = inv.iter_entries()
1999
for path, ie in entries:
2000
self._convert_file_version(rev, ie, parent_invs)
2002
def _convert_file_version(self, rev, ie, parent_invs):
2003
"""Convert one version of one file.
2005
The file needs to be added into the weave if it is a merge
2006
of >=2 parents or if it's changed from its parent.
2008
file_id = ie.file_id
2009
rev_id = rev.revision_id
2010
w = self.text_weaves.get(file_id)
2013
self.text_weaves[file_id] = w
2014
text_changed = False
2015
parent_candiate_entries = ie.parent_candidates(parent_invs)
2016
for old_revision in parent_candiate_entries.keys():
2017
# if this fails, its a ghost ?
2018
assert old_revision in self.converted_revs, \
2019
"Revision {%s} not in converted_revs" % old_revision
2020
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2021
# XXX: Note that this is unordered - and this is tolerable because
2022
# the previous code was also unordered.
2023
previous_entries = dict((head, parent_candiate_entries[head]) for head
2025
self.snapshot_ie(previous_entries, ie, w, rev_id)
2027
assert getattr(ie, 'revision', None) is not None
2029
def get_parents(self, revision_ids):
2030
for revision_id in revision_ids:
2031
yield self.revisions[revision_id].parent_ids
2033
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2034
# TODO: convert this logic, which is ~= snapshot to
2035
# a call to:. This needs the path figured out. rather than a work_tree
2036
# a v4 revision_tree can be given, or something that looks enough like
2037
# one to give the file content to the entry if it needs it.
2038
# and we need something that looks like a weave store for snapshot to
2040
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2041
if len(previous_revisions) == 1:
2042
previous_ie = previous_revisions.values()[0]
2043
if ie._unchanged(previous_ie):
2044
ie.revision = previous_ie.revision
2047
text = self.branch.repository.weave_store.get(ie.text_id)
2048
file_lines = text.readlines()
2049
assert sha_strings(file_lines) == ie.text_sha1
2050
assert sum(map(len, file_lines)) == ie.text_size
2051
w.add_lines(rev_id, previous_revisions, file_lines)
2052
self.text_count += 1
2054
w.add_lines(rev_id, previous_revisions, [])
2055
ie.revision = rev_id
2057
def _make_order(self):
2058
"""Return a suitable order for importing revisions.
2060
The order must be such that an revision is imported after all
2061
its (present) parents.
2063
todo = set(self.revisions.keys())
2064
done = self.absent_revisions.copy()
2067
# scan through looking for a revision whose parents
2069
for rev_id in sorted(list(todo)):
2070
rev = self.revisions[rev_id]
2071
parent_ids = set(rev.parent_ids)
2072
if parent_ids.issubset(done):
2073
# can take this one now
2074
order.append(rev_id)
2080
class ConvertBzrDir5To6(Converter):
2081
"""Converts format 5 bzr dirs to format 6."""
2083
def convert(self, to_convert, pb):
2084
"""See Converter.convert()."""
2085
self.bzrdir = to_convert
2087
self.pb.note('starting upgrade from format 5 to 6')
2088
self._convert_to_prefixed()
2089
return BzrDir.open(self.bzrdir.root_transport.base)
2091
def _convert_to_prefixed(self):
2092
from bzrlib.store import TransportStore
2093
self.bzrdir.transport.delete('branch-format')
2094
for store_name in ["weaves", "revision-store"]:
2095
self.pb.note("adding prefixes to %s" % store_name)
2096
store_transport = self.bzrdir.transport.clone(store_name)
2097
store = TransportStore(store_transport, prefixed=True)
2098
for urlfilename in store_transport.list_dir('.'):
2099
filename = urlutils.unescape(urlfilename)
2100
if (filename.endswith(".weave") or
2101
filename.endswith(".gz") or
2102
filename.endswith(".sig")):
2103
file_id = os.path.splitext(filename)[0]
2106
prefix_dir = store.hash_prefix(file_id)
2107
# FIXME keep track of the dirs made RBC 20060121
2109
store_transport.move(filename, prefix_dir + '/' + filename)
2110
except errors.NoSuchFile: # catches missing dirs strangely enough
2111
store_transport.mkdir(prefix_dir)
2112
store_transport.move(filename, prefix_dir + '/' + filename)
2113
self.bzrdir._control_files.put_utf8('branch-format', BzrDirFormat6().get_format_string())
2116
class ConvertBzrDir6ToMeta(Converter):
2117
"""Converts format 6 bzr dirs to metadirs."""
2119
def convert(self, to_convert, pb):
2120
"""See Converter.convert()."""
2121
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2122
from bzrlib.branch import BzrBranchFormat5
2123
self.bzrdir = to_convert
2126
self.total = 20 # the steps we know about
2127
self.garbage_inventories = []
2129
self.pb.note('starting upgrade from format 6 to metadir')
2130
self.bzrdir._control_files.put_utf8('branch-format', "Converting to format 6")
2131
# its faster to move specific files around than to open and use the apis...
2132
# first off, nuke ancestry.weave, it was never used.
2134
self.step('Removing ancestry.weave')
2135
self.bzrdir.transport.delete('ancestry.weave')
2136
except errors.NoSuchFile:
2138
# find out whats there
2139
self.step('Finding branch files')
2140
last_revision = self.bzrdir.open_branch().last_revision()
2141
bzrcontents = self.bzrdir.transport.list_dir('.')
2142
for name in bzrcontents:
2143
if name.startswith('basis-inventory.'):
2144
self.garbage_inventories.append(name)
2145
# create new directories for repository, working tree and branch
2146
self.dir_mode = self.bzrdir._control_files._dir_mode
2147
self.file_mode = self.bzrdir._control_files._file_mode
2148
repository_names = [('inventory.weave', True),
2149
('revision-store', True),
2151
self.step('Upgrading repository ')
2152
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2153
self.make_lock('repository')
2154
# we hard code the formats here because we are converting into
2155
# the meta format. The meta format upgrader can take this to a
2156
# future format within each component.
2157
self.put_format('repository', RepositoryFormat7())
2158
for entry in repository_names:
2159
self.move_entry('repository', entry)
2161
self.step('Upgrading branch ')
2162
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2163
self.make_lock('branch')
2164
self.put_format('branch', BzrBranchFormat5())
2165
branch_files = [('revision-history', True),
2166
('branch-name', True),
2168
for entry in branch_files:
2169
self.move_entry('branch', entry)
2171
checkout_files = [('pending-merges', True),
2172
('inventory', True),
2173
('stat-cache', False)]
2174
# If a mandatory checkout file is not present, the branch does not have
2175
# a functional checkout. Do not create a checkout in the converted
2177
for name, mandatory in checkout_files:
2178
if mandatory and name not in bzrcontents:
2179
has_checkout = False
2183
if not has_checkout:
2184
self.pb.note('No working tree.')
2185
# If some checkout files are there, we may as well get rid of them.
2186
for name, mandatory in checkout_files:
2187
if name in bzrcontents:
2188
self.bzrdir.transport.delete(name)
2190
from bzrlib.workingtree import WorkingTreeFormat3
2191
self.step('Upgrading working tree')
2192
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2193
self.make_lock('checkout')
2195
'checkout', WorkingTreeFormat3())
2196
self.bzrdir.transport.delete_multi(
2197
self.garbage_inventories, self.pb)
2198
for entry in checkout_files:
2199
self.move_entry('checkout', entry)
2200
if last_revision is not None:
2201
self.bzrdir._control_files.put_utf8(
2202
'checkout/last-revision', last_revision)
2203
self.bzrdir._control_files.put_utf8(
2204
'branch-format', BzrDirMetaFormat1().get_format_string())
2205
return BzrDir.open(self.bzrdir.root_transport.base)
2207
def make_lock(self, name):
2208
"""Make a lock for the new control dir name."""
2209
self.step('Make %s lock' % name)
2210
ld = lockdir.LockDir(self.bzrdir.transport,
2212
file_modebits=self.file_mode,
2213
dir_modebits=self.dir_mode)
2216
def move_entry(self, new_dir, entry):
2217
"""Move then entry name into new_dir."""
2219
mandatory = entry[1]
2220
self.step('Moving %s' % name)
2222
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2223
except errors.NoSuchFile:
2227
def put_format(self, dirname, format):
2228
self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
2231
class ConvertMetaToMeta(Converter):
2232
"""Converts the components of metadirs."""
2234
def __init__(self, target_format):
2235
"""Create a metadir to metadir converter.
2237
:param target_format: The final metadir format that is desired.
2239
self.target_format = target_format
2241
def convert(self, to_convert, pb):
2242
"""See Converter.convert()."""
2243
self.bzrdir = to_convert
2247
self.step('checking repository format')
2249
repo = self.bzrdir.open_repository()
2250
except errors.NoRepositoryPresent:
2253
if not isinstance(repo._format, self.target_format.repository_format.__class__):
2254
from bzrlib.repository import CopyConverter
2255
self.pb.note('starting repository conversion')
2256
converter = CopyConverter(self.target_format.repository_format)
2257
converter.convert(repo, pb)
2259
branch = self.bzrdir.open_branch()
2260
except errors.NotBranchError:
2263
# TODO: conversions of Branch and Tree should be done by
2264
# InterXFormat lookups
2265
# Avoid circular imports
2266
from bzrlib import branch as _mod_branch
2267
if (branch._format.__class__ is _mod_branch.BzrBranchFormat5 and
2268
self.target_format.get_branch_format().__class__ is
2269
_mod_branch.BzrBranchFormat6):
2270
branch_converter = _mod_branch.Converter5to6()
2271
branch_converter.convert(branch)
2273
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
2274
except (errors.NoWorkingTree, errors.NotLocalUrl):
2277
# TODO: conversions of Branch and Tree should be done by
2278
# InterXFormat lookups
2279
if (isinstance(tree, workingtree.WorkingTree3) and
2280
not isinstance(tree, workingtree_4.WorkingTree4) and
2281
isinstance(self.target_format.workingtree_format,
2282
workingtree_4.WorkingTreeFormat4)):
2283
workingtree_4.Converter3to4().convert(tree)
2287
# This is not in remote.py because it's small, and needs to be registered.
2288
# Putting it in remote.py creates a circular import problem.
2289
# we can make it a lazy object if the control formats is turned into something
2291
class RemoteBzrDirFormat(BzrDirMetaFormat1):
2292
"""Format representing bzrdirs accessed via a smart server"""
2294
def get_format_description(self):
2295
return 'bzr remote bzrdir'
2298
def probe_transport(klass, transport):
2299
"""Return a RemoteBzrDirFormat object if it looks possible."""
2301
client = transport.get_smart_client()
2302
except (NotImplementedError, AttributeError,
2303
errors.TransportNotPossible):
2304
# no smart server, so not a branch for this format type.
2305
raise errors.NotBranchError(path=transport.base)
2307
# Send a 'hello' request in protocol version one, and decline to
2308
# open it if the server doesn't support our required version (2) so
2309
# that the VFS-based transport will do it.
2310
request = client.get_request()
2311
smart_protocol = protocol.SmartClientRequestProtocolOne(request)
2312
server_version = smart_protocol.query_version()
2313
if server_version != 2:
2314
raise errors.NotBranchError(path=transport.base)
2317
def initialize_on_transport(self, transport):
2319
# hand off the request to the smart server
2320
shared_medium = transport.get_shared_medium()
2321
except errors.NoSmartMedium:
2322
# TODO: lookup the local format from a server hint.
2323
local_dir_format = BzrDirMetaFormat1()
2324
return local_dir_format.initialize_on_transport(transport)
2325
client = _SmartClient(shared_medium)
2326
path = client.remote_path_from_transport(transport)
2327
response = _SmartClient(shared_medium).call('BzrDirFormat.initialize',
2329
assert response[0] in ('ok', ), 'unexpected response code %s' % (response,)
2330
return remote.RemoteBzrDir(transport)
2332
def _open(self, transport):
2333
return remote.RemoteBzrDir(transport)
2335
def __eq__(self, other):
2336
if not isinstance(other, RemoteBzrDirFormat):
2338
return self.get_format_description() == other.get_format_description()
2341
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
2344
class BzrDirFormatInfo(object):
2346
def __init__(self, native, deprecated, hidden, experimental):
2347
self.deprecated = deprecated
2348
self.native = native
2349
self.hidden = hidden
2350
self.experimental = experimental
2353
class BzrDirFormatRegistry(registry.Registry):
2354
"""Registry of user-selectable BzrDir subformats.
2356
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
2357
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
2360
def register_metadir(self, key,
2361
repository_format, help, native=True, deprecated=False,
2365
experimental=False):
2366
"""Register a metadir subformat.
2368
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
2369
by the Repository format.
2371
:param repository_format: The fully-qualified repository format class
2373
:param branch_format: Fully-qualified branch format class name as
2375
:param tree_format: Fully-qualified tree format class name as
2378
# This should be expanded to support setting WorkingTree and Branch
2379
# formats, once BzrDirMetaFormat1 supports that.
2380
def _load(full_name):
2381
mod_name, factory_name = full_name.rsplit('.', 1)
2383
mod = __import__(mod_name, globals(), locals(),
2385
except ImportError, e:
2386
raise ImportError('failed to load %s: %s' % (full_name, e))
2388
factory = getattr(mod, factory_name)
2389
except AttributeError:
2390
raise AttributeError('no factory %s in module %r'
2395
bd = BzrDirMetaFormat1()
2396
if branch_format is not None:
2397
bd.set_branch_format(_load(branch_format))
2398
if tree_format is not None:
2399
bd.workingtree_format = _load(tree_format)
2400
if repository_format is not None:
2401
bd.repository_format = _load(repository_format)
2403
self.register(key, helper, help, native, deprecated, hidden,
2406
def register(self, key, factory, help, native=True, deprecated=False,
2407
hidden=False, experimental=False):
2408
"""Register a BzrDirFormat factory.
2410
The factory must be a callable that takes one parameter: the key.
2411
It must produce an instance of the BzrDirFormat when called.
2413
This function mainly exists to prevent the info object from being
2416
registry.Registry.register(self, key, factory, help,
2417
BzrDirFormatInfo(native, deprecated, hidden, experimental))
2419
def register_lazy(self, key, module_name, member_name, help, native=True,
2420
deprecated=False, hidden=False, experimental=False):
2421
registry.Registry.register_lazy(self, key, module_name, member_name,
2422
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
2424
def set_default(self, key):
2425
"""Set the 'default' key to be a clone of the supplied key.
2427
This method must be called once and only once.
2429
registry.Registry.register(self, 'default', self.get(key),
2430
self.get_help(key), info=self.get_info(key))
2432
def set_default_repository(self, key):
2433
"""Set the FormatRegistry default and Repository default.
2435
This is a transitional method while Repository.set_default_format
2438
if 'default' in self:
2439
self.remove('default')
2440
self.set_default(key)
2441
format = self.get('default')()
2442
assert isinstance(format, BzrDirMetaFormat1)
2444
def make_bzrdir(self, key):
2445
return self.get(key)()
2447
def help_topic(self, topic):
2448
output = textwrap.dedent("""\
2449
These formats can be used for creating branches, working trees, and
2453
default_realkey = None
2454
default_help = self.get_help('default')
2456
for key in self.keys():
2457
if key == 'default':
2459
help = self.get_help(key)
2460
if help == default_help:
2461
default_realkey = key
2463
help_pairs.append((key, help))
2465
def wrapped(key, help, info):
2467
help = '(native) ' + help
2468
return ':%s:\n%s\n\n' % (key,
2469
textwrap.fill(help, initial_indent=' ',
2470
subsequent_indent=' '))
2471
if default_realkey is not None:
2472
output += wrapped(default_realkey, '(default) %s' % default_help,
2473
self.get_info('default'))
2474
deprecated_pairs = []
2475
experimental_pairs = []
2476
for key, help in help_pairs:
2477
info = self.get_info(key)
2480
elif info.deprecated:
2481
deprecated_pairs.append((key, help))
2482
elif info.experimental:
2483
experimental_pairs.append((key, help))
2485
output += wrapped(key, help, info)
2486
if len(experimental_pairs) > 0:
2487
output += "Experimental formats are shown below.\n\n"
2488
for key, help in experimental_pairs:
2489
info = self.get_info(key)
2490
output += wrapped(key, help, info)
2491
if len(deprecated_pairs) > 0:
2492
output += "Deprecated formats are shown below.\n\n"
2493
for key, help in deprecated_pairs:
2494
info = self.get_info(key)
2495
output += wrapped(key, help, info)
2500
format_registry = BzrDirFormatRegistry()
2501
format_registry.register('weave', BzrDirFormat6,
2502
'Pre-0.8 format. Slower than knit and does not'
2503
' support checkouts or shared repositories.',
2505
format_registry.register_metadir('knit',
2506
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2507
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
2508
branch_format='bzrlib.branch.BzrBranchFormat5',
2509
tree_format='bzrlib.workingtree.WorkingTreeFormat3')
2510
format_registry.register_metadir('metaweave',
2511
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
2512
'Transitional format in 0.8. Slower than knit.',
2513
branch_format='bzrlib.branch.BzrBranchFormat5',
2514
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2516
format_registry.register_metadir('dirstate',
2517
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2518
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2519
'above when accessed over the network.',
2520
branch_format='bzrlib.branch.BzrBranchFormat5',
2521
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
2522
# directly from workingtree_4 triggers a circular import.
2523
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2525
format_registry.register_metadir('dirstate-tags',
2526
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2527
help='New in 0.15: Fast local operations and improved scaling for '
2528
'network operations. Additionally adds support for tags.'
2529
' Incompatible with bzr < 0.15.',
2530
branch_format='bzrlib.branch.BzrBranchFormat6',
2531
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2533
format_registry.register_metadir('rich-root',
2534
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
2535
help='New in 1.0. Better handling of tree roots. Incompatible with'
2537
branch_format='bzrlib.branch.BzrBranchFormat6',
2538
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2541
format_registry.register_metadir('dirstate-with-subtree',
2542
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2543
help='New in 0.15: Fast local operations and improved scaling for '
2544
'network operations. Additionally adds support for versioning nested '
2545
'bzr branches. Incompatible with bzr < 0.15.',
2546
branch_format='bzrlib.branch.BzrBranchFormat6',
2547
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2550
format_registry.register_metadir('pack-0.92',
2551
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
2552
help='New in 0.92: Pack-based format with data compatible with '
2553
'dirstate-tags format repositories. Interoperates with '
2554
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2555
'Previously called knitpack-experimental. '
2556
'For more information, see '
2557
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2558
branch_format='bzrlib.branch.BzrBranchFormat6',
2559
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2562
format_registry.register_metadir('pack-0.92-subtree',
2563
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
2564
help='New in 0.92: Pack-based format with data compatible with '
2565
'dirstate-with-subtree format repositories. Interoperates with '
2566
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2567
'Previously called knitpack-experimental. '
2568
'For more information, see '
2569
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2570
branch_format='bzrlib.branch.BzrBranchFormat6',
2571
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2575
format_registry.register_metadir('rich-root-pack',
2576
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
2577
help='New in 1.0: Pack-based format with data compatible with '
2578
'rich-root format repositories. Interoperates with '
2579
'bzr repositories before 0.92 but cannot be read by bzr < 1.0. '
2580
'NOTE: This format is experimental. Before using it, please read '
2581
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2582
branch_format='bzrlib.branch.BzrBranchFormat6',
2583
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2587
format_registry.set_default('pack-0.92')
added
removed
bzrlib/bzrdir.py
