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
accelerator_tree=None):
386
"""Create a working tree at this BzrDir.
388
:param revision_id: create it as of this revision id.
389
:param from_branch: override bzrdir branch (for lightweight checkouts)
390
:param accelerator_tree: A tree which can be used for retrieving file
391
contents more quickly than the revision tree, i.e. a workingtree.
392
The revision tree will be used for cases where accelerator_tree's
393
content is different.
395
raise NotImplementedError(self.create_workingtree)
397
def retire_bzrdir(self, limit=10000):
398
"""Permanently disable the bzrdir.
400
This is done by renaming it to give the user some ability to recover
401
if there was a problem.
403
This will have horrible consequences if anyone has anything locked or
405
:param limit: number of times to retry
410
to_path = '.bzr.retired.%d' % i
411
self.root_transport.rename('.bzr', to_path)
412
note("renamed %s to %s"
413
% (self.root_transport.abspath('.bzr'), to_path))
415
except (errors.TransportError, IOError, errors.PathError):
422
def destroy_workingtree(self):
423
"""Destroy the working tree at this BzrDir.
425
Formats that do not support this may raise UnsupportedOperation.
427
raise NotImplementedError(self.destroy_workingtree)
429
def destroy_workingtree_metadata(self):
430
"""Destroy the control files for the working tree at this BzrDir.
432
The contents of working tree files are not affected.
433
Formats that do not support this may raise UnsupportedOperation.
435
raise NotImplementedError(self.destroy_workingtree_metadata)
437
def find_repository(self):
438
"""Find the repository that should be used.
440
This does not require a branch as we use it to find the repo for
441
new branches as well as to hook existing branches up to their
445
return self.open_repository()
446
except errors.NoRepositoryPresent:
448
next_transport = self.root_transport.clone('..')
450
# find the next containing bzrdir
452
found_bzrdir = BzrDir.open_containing_from_transport(
454
except errors.NotBranchError:
456
raise errors.NoRepositoryPresent(self)
457
# does it have a repository ?
459
repository = found_bzrdir.open_repository()
460
except errors.NoRepositoryPresent:
461
next_transport = found_bzrdir.root_transport.clone('..')
462
if (found_bzrdir.root_transport.base == next_transport.base):
463
# top of the file system
467
if ((found_bzrdir.root_transport.base ==
468
self.root_transport.base) or repository.is_shared()):
471
raise errors.NoRepositoryPresent(self)
472
raise errors.NoRepositoryPresent(self)
474
def get_branch_reference(self):
475
"""Return the referenced URL for the branch in this bzrdir.
477
:raises NotBranchError: If there is no Branch.
478
:return: The URL the branch in this bzrdir references if it is a
479
reference branch, or None for regular branches.
483
def get_branch_transport(self, branch_format):
484
"""Get the transport for use by branch format in this BzrDir.
486
Note that bzr dirs that do not support format strings will raise
487
IncompatibleFormat if the branch format they are given has
488
a format string, and vice versa.
490
If branch_format is None, the transport is returned with no
491
checking. If it is not None, then the returned transport is
492
guaranteed to point to an existing directory ready for use.
494
raise NotImplementedError(self.get_branch_transport)
496
def get_repository_transport(self, repository_format):
497
"""Get the transport for use by repository format in this BzrDir.
499
Note that bzr dirs that do not support format strings will raise
500
IncompatibleFormat if the repository format they are given has
501
a format string, and vice versa.
503
If repository_format is None, the transport is returned with no
504
checking. If it is not None, then the returned transport is
505
guaranteed to point to an existing directory ready for use.
507
raise NotImplementedError(self.get_repository_transport)
509
def get_workingtree_transport(self, tree_format):
510
"""Get the transport for use by workingtree format in this BzrDir.
512
Note that bzr dirs that do not support format strings will raise
513
IncompatibleFormat if the workingtree format they are given has a
514
format string, and vice versa.
516
If workingtree_format is None, the transport is returned with no
517
checking. If it is not None, then the returned transport is
518
guaranteed to point to an existing directory ready for use.
520
raise NotImplementedError(self.get_workingtree_transport)
522
def __init__(self, _transport, _format):
523
"""Initialize a Bzr control dir object.
525
Only really common logic should reside here, concrete classes should be
526
made with varying behaviours.
528
:param _format: the format that is creating this BzrDir instance.
529
:param _transport: the transport this dir is based at.
531
self._format = _format
532
self.transport = _transport.clone('.bzr')
533
self.root_transport = _transport
535
def is_control_filename(self, filename):
536
"""True if filename is the name of a path which is reserved for bzrdir's.
538
:param filename: A filename within the root transport of this bzrdir.
540
This is true IF and ONLY IF the filename is part of the namespace reserved
541
for bzr control dirs. Currently this is the '.bzr' directory in the root
542
of the root_transport. it is expected that plugins will need to extend
543
this in the future - for instance to make bzr talk with svn working
546
# this might be better on the BzrDirFormat class because it refers to
547
# all the possible bzrdir disk formats.
548
# This method is tested via the workingtree is_control_filename tests-
549
# it was extracted from WorkingTree.is_control_filename. If the method's
550
# contract is extended beyond the current trivial implementation, please
551
# add new tests for it to the appropriate place.
552
return filename == '.bzr' or filename.startswith('.bzr/')
554
def needs_format_conversion(self, format=None):
555
"""Return true if this bzrdir needs convert_format run on it.
557
For instance, if the repository format is out of date but the
558
branch and working tree are not, this should return True.
560
:param format: Optional parameter indicating a specific desired
561
format we plan to arrive at.
563
raise NotImplementedError(self.needs_format_conversion)
566
def open_unsupported(base):
567
"""Open a branch which is not supported."""
568
return BzrDir.open(base, _unsupported=True)
571
def open(base, _unsupported=False, possible_transports=None):
572
"""Open an existing bzrdir, rooted at 'base' (url).
574
:param _unsupported: a private parameter to the BzrDir class.
576
t = get_transport(base, possible_transports=possible_transports)
577
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
580
def open_from_transport(transport, _unsupported=False,
581
_server_formats=True):
582
"""Open a bzrdir within a particular directory.
584
:param transport: Transport containing the bzrdir.
585
:param _unsupported: private.
587
base = transport.base
589
def find_format(transport):
590
return transport, BzrDirFormat.find_format(
591
transport, _server_formats=_server_formats)
593
def redirected(transport, e, redirection_notice):
594
qualified_source = e.get_source_url()
595
relpath = transport.relpath(qualified_source)
596
if not e.target.endswith(relpath):
597
# Not redirected to a branch-format, not a branch
598
raise errors.NotBranchError(path=e.target)
599
target = e.target[:-len(relpath)]
600
note('%s is%s redirected to %s',
601
transport.base, e.permanently, target)
602
# Let's try with a new transport
603
# FIXME: If 'transport' has a qualifier, this should
604
# be applied again to the new transport *iff* the
605
# schemes used are the same. Uncomment this code
606
# once the function (and tests) exist.
608
#target = urlutils.copy_url_qualifiers(original, target)
609
return get_transport(target)
612
transport, format = do_catching_redirections(find_format,
615
except errors.TooManyRedirections:
616
raise errors.NotBranchError(base)
618
BzrDir._check_supported(format, _unsupported)
619
return format.open(transport, _found=True)
621
def open_branch(self, unsupported=False):
622
"""Open the branch object at this BzrDir if one is present.
624
If unsupported is True, then no longer supported branch formats can
627
TODO: static convenience version of this?
629
raise NotImplementedError(self.open_branch)
632
def open_containing(url, possible_transports=None):
633
"""Open an existing branch which contains url.
635
:param url: url to search from.
636
See open_containing_from_transport for more detail.
638
transport = get_transport(url, possible_transports)
639
return BzrDir.open_containing_from_transport(transport)
642
def open_containing_from_transport(a_transport):
643
"""Open an existing branch which contains a_transport.base.
645
This probes for a branch at a_transport, and searches upwards from there.
647
Basically we keep looking up until we find the control directory or
648
run into the root. If there isn't one, raises NotBranchError.
649
If there is one and it is either an unrecognised format or an unsupported
650
format, UnknownFormatError or UnsupportedFormatError are raised.
651
If there is one, it is returned, along with the unused portion of url.
653
:return: The BzrDir that contains the path, and a Unicode path
654
for the rest of the URL.
656
# this gets the normalised url back. I.e. '.' -> the full path.
657
url = a_transport.base
660
result = BzrDir.open_from_transport(a_transport)
661
return result, urlutils.unescape(a_transport.relpath(url))
662
except errors.NotBranchError, e:
665
new_t = a_transport.clone('..')
666
except errors.InvalidURLJoin:
667
# reached the root, whatever that may be
668
raise errors.NotBranchError(path=url)
669
if new_t.base == a_transport.base:
670
# reached the root, whatever that may be
671
raise errors.NotBranchError(path=url)
674
def _get_tree_branch(self):
675
"""Return the branch and tree, if any, for this bzrdir.
677
Return None for tree if not present.
678
Raise NotBranchError if no branch is present.
679
:return: (tree, branch)
682
tree = self.open_workingtree()
683
except (errors.NoWorkingTree, errors.NotLocalUrl):
685
branch = self.open_branch()
691
def open_tree_or_branch(klass, location):
692
"""Return the branch and working tree at a location.
694
If there is no tree at the location, tree will be None.
695
If there is no branch at the location, an exception will be
697
:return: (tree, branch)
699
bzrdir = klass.open(location)
700
return bzrdir._get_tree_branch()
703
def open_containing_tree_or_branch(klass, location):
704
"""Return the branch and working tree contained by a location.
706
Returns (tree, branch, relpath).
707
If there is no tree at containing the location, tree will be None.
708
If there is no branch containing the location, an exception will be
710
relpath is the portion of the path that is contained by the branch.
712
bzrdir, relpath = klass.open_containing(location)
713
tree, branch = bzrdir._get_tree_branch()
714
return tree, branch, relpath
716
def open_repository(self, _unsupported=False):
717
"""Open the repository object at this BzrDir if one is present.
719
This will not follow the Branch object pointer - it's strictly a direct
720
open facility. Most client code should use open_branch().repository to
723
:param _unsupported: a private parameter, not part of the api.
724
TODO: static convenience version of this?
726
raise NotImplementedError(self.open_repository)
728
def open_workingtree(self, _unsupported=False,
729
recommend_upgrade=True, from_branch=None):
730
"""Open the workingtree object at this BzrDir if one is present.
732
:param recommend_upgrade: Optional keyword parameter, when True (the
733
default), emit through the ui module a recommendation that the user
734
upgrade the working tree when the workingtree being opened is old
735
(but still fully supported).
736
:param from_branch: override bzrdir branch (for lightweight checkouts)
738
raise NotImplementedError(self.open_workingtree)
740
def has_branch(self):
741
"""Tell if this bzrdir contains a branch.
743
Note: if you're going to open the branch, you should just go ahead
744
and try, and not ask permission first. (This method just opens the
745
branch and discards it, and that's somewhat expensive.)
750
except errors.NotBranchError:
753
def has_workingtree(self):
754
"""Tell if this bzrdir contains a working tree.
756
This will still raise an exception if the bzrdir has a workingtree that
757
is remote & inaccessible.
759
Note: if you're going to open the working tree, you should just go ahead
760
and try, and not ask permission first. (This method just opens the
761
workingtree and discards it, and that's somewhat expensive.)
764
self.open_workingtree(recommend_upgrade=False)
766
except errors.NoWorkingTree:
769
def _cloning_metadir(self):
770
"""Produce a metadir suitable for cloning with."""
771
result_format = self._format.__class__()
774
branch = self.open_branch()
775
source_repository = branch.repository
776
except errors.NotBranchError:
778
source_repository = self.open_repository()
779
except errors.NoRepositoryPresent:
780
source_repository = None
782
# XXX TODO: This isinstance is here because we have not implemented
783
# the fix recommended in bug # 103195 - to delegate this choice the
785
repo_format = source_repository._format
786
if not isinstance(repo_format, remote.RemoteRepositoryFormat):
787
result_format.repository_format = repo_format
789
# TODO: Couldn't we just probe for the format in these cases,
790
# rather than opening the whole tree? It would be a little
791
# faster. mbp 20070401
792
tree = self.open_workingtree(recommend_upgrade=False)
793
except (errors.NoWorkingTree, errors.NotLocalUrl):
794
result_format.workingtree_format = None
796
result_format.workingtree_format = tree._format.__class__()
797
return result_format, source_repository
799
def cloning_metadir(self):
800
"""Produce a metadir suitable for cloning or sprouting with.
802
These operations may produce workingtrees (yes, even though they're
803
"cloning" something that doesn't have a tree), so a viable workingtree
804
format must be selected.
806
format, repository = self._cloning_metadir()
807
if format._workingtree_format is None:
808
if repository is None:
810
tree_format = repository._format._matchingbzrdir.workingtree_format
811
format.workingtree_format = tree_format.__class__()
814
def checkout_metadir(self):
815
return self.cloning_metadir()
817
def sprout(self, url, revision_id=None, force_new_repo=False,
818
recurse='down', possible_transports=None,
819
accelerator_tree=None):
820
"""Create a copy of this bzrdir prepared for use as a new line of
823
If url's last component does not exist, it will be created.
825
Attributes related to the identity of the source branch like
826
branch nickname will be cleaned, a working tree is created
827
whether one existed before or not; and a local branch is always
830
if revision_id is not None, then the clone operation may tune
831
itself to download less data.
832
:param accelerator_tree: A tree which can be used for retrieving file
833
contents more quickly than the revision tree, i.e. a workingtree.
834
The revision tree will be used for cases where accelerator_tree's
835
content is different.
837
target_transport = get_transport(url, possible_transports)
838
target_transport.ensure_base()
839
cloning_format = self.cloning_metadir()
840
result = cloning_format.initialize_on_transport(target_transport)
842
source_branch = self.open_branch()
843
source_repository = source_branch.repository
844
except errors.NotBranchError:
847
source_repository = self.open_repository()
848
except errors.NoRepositoryPresent:
849
source_repository = None
854
result_repo = result.find_repository()
855
except errors.NoRepositoryPresent:
857
if source_repository is None and result_repo is not None:
859
elif source_repository is None and result_repo is None:
860
# no repo available, make a new one
861
result.create_repository()
862
elif source_repository is not None and result_repo is None:
863
# have source, and want to make a new target repo
864
result_repo = source_repository.sprout(result,
865
revision_id=revision_id)
867
# fetch needed content into target.
868
if source_repository is not None:
870
# source_repository.copy_content_into(result_repo,
871
# revision_id=revision_id)
872
# so we can override the copy method
873
result_repo.fetch(source_repository, revision_id=revision_id)
874
if source_branch is not None:
875
source_branch.sprout(result, revision_id=revision_id)
877
result.create_branch()
878
if isinstance(target_transport, LocalTransport) and (
879
result_repo is None or result_repo.make_working_trees()):
880
wt = result.create_workingtree(accelerator_tree=accelerator_tree)
883
if wt.path2id('') is None:
885
wt.set_root_id(self.open_workingtree.get_root_id())
886
except errors.NoWorkingTree:
892
if recurse == 'down':
894
basis = wt.basis_tree()
896
subtrees = basis.iter_references()
897
recurse_branch = wt.branch
898
elif source_branch is not None:
899
basis = source_branch.basis_tree()
901
subtrees = basis.iter_references()
902
recurse_branch = source_branch
907
for path, file_id in subtrees:
908
target = urlutils.join(url, urlutils.escape(path))
909
sublocation = source_branch.reference_parent(file_id, path)
910
sublocation.bzrdir.sprout(target,
911
basis.get_reference_revision(file_id, path),
912
force_new_repo=force_new_repo, recurse=recurse)
914
if basis is not None:
919
class BzrDirPreSplitOut(BzrDir):
920
"""A common class for the all-in-one formats."""
922
def __init__(self, _transport, _format):
923
"""See BzrDir.__init__."""
924
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
925
assert self._format._lock_class == lockable_files.TransportLock
926
assert self._format._lock_file_name == 'branch-lock'
927
self._control_files = lockable_files.LockableFiles(
928
self.get_branch_transport(None),
929
self._format._lock_file_name,
930
self._format._lock_class)
932
def break_lock(self):
933
"""Pre-splitout bzrdirs do not suffer from stale locks."""
934
raise NotImplementedError(self.break_lock)
936
def clone(self, url, revision_id=None, force_new_repo=False):
937
"""See BzrDir.clone()."""
938
from bzrlib.workingtree import WorkingTreeFormat2
940
result = self._format._initialize_for_clone(url)
941
self.open_repository().clone(result, revision_id=revision_id)
942
from_branch = self.open_branch()
943
from_branch.clone(result, revision_id=revision_id)
945
self.open_workingtree().clone(result)
946
except errors.NotLocalUrl:
947
# make a new one, this format always has to have one.
949
WorkingTreeFormat2().initialize(result)
950
except errors.NotLocalUrl:
951
# but we cannot do it for remote trees.
952
to_branch = result.open_branch()
953
WorkingTreeFormat2().stub_initialize_remote(to_branch.control_files)
956
def create_branch(self):
957
"""See BzrDir.create_branch."""
958
return self.open_branch()
960
def destroy_branch(self):
961
"""See BzrDir.destroy_branch."""
962
raise errors.UnsupportedOperation(self.destroy_branch, self)
964
def create_repository(self, shared=False):
965
"""See BzrDir.create_repository."""
967
raise errors.IncompatibleFormat('shared repository', self._format)
968
return self.open_repository()
970
def destroy_repository(self):
971
"""See BzrDir.destroy_repository."""
972
raise errors.UnsupportedOperation(self.destroy_repository, self)
974
def create_workingtree(self, revision_id=None, from_branch=None,
975
accelerator_tree=None):
976
"""See BzrDir.create_workingtree."""
977
# this looks buggy but is not -really-
978
# because this format creates the workingtree when the bzrdir is
980
# clone and sprout will have set the revision_id
981
# and that will have set it for us, its only
982
# specific uses of create_workingtree in isolation
983
# that can do wonky stuff here, and that only
984
# happens for creating checkouts, which cannot be
985
# done on this format anyway. So - acceptable wart.
986
result = self.open_workingtree(recommend_upgrade=False)
987
if revision_id is not None:
988
if revision_id == _mod_revision.NULL_REVISION:
989
result.set_parent_ids([])
991
result.set_parent_ids([revision_id])
994
def destroy_workingtree(self):
995
"""See BzrDir.destroy_workingtree."""
996
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
998
def destroy_workingtree_metadata(self):
999
"""See BzrDir.destroy_workingtree_metadata."""
1000
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1003
def get_branch_transport(self, branch_format):
1004
"""See BzrDir.get_branch_transport()."""
1005
if branch_format is None:
1006
return self.transport
1008
branch_format.get_format_string()
1009
except NotImplementedError:
1010
return self.transport
1011
raise errors.IncompatibleFormat(branch_format, self._format)
1013
def get_repository_transport(self, repository_format):
1014
"""See BzrDir.get_repository_transport()."""
1015
if repository_format is None:
1016
return self.transport
1018
repository_format.get_format_string()
1019
except NotImplementedError:
1020
return self.transport
1021
raise errors.IncompatibleFormat(repository_format, self._format)
1023
def get_workingtree_transport(self, workingtree_format):
1024
"""See BzrDir.get_workingtree_transport()."""
1025
if workingtree_format is None:
1026
return self.transport
1028
workingtree_format.get_format_string()
1029
except NotImplementedError:
1030
return self.transport
1031
raise errors.IncompatibleFormat(workingtree_format, self._format)
1033
def needs_format_conversion(self, format=None):
1034
"""See BzrDir.needs_format_conversion()."""
1035
# if the format is not the same as the system default,
1036
# an upgrade is needed.
1038
format = BzrDirFormat.get_default_format()
1039
return not isinstance(self._format, format.__class__)
1041
def open_branch(self, unsupported=False):
1042
"""See BzrDir.open_branch."""
1043
from bzrlib.branch import BzrBranchFormat4
1044
format = BzrBranchFormat4()
1045
self._check_supported(format, unsupported)
1046
return format.open(self, _found=True)
1048
def sprout(self, url, revision_id=None, force_new_repo=False,
1049
possible_transports=None, accelerator_tree=None):
1050
"""See BzrDir.sprout()."""
1051
from bzrlib.workingtree import WorkingTreeFormat2
1052
self._make_tail(url)
1053
result = self._format._initialize_for_clone(url)
1055
self.open_repository().clone(result, revision_id=revision_id)
1056
except errors.NoRepositoryPresent:
1059
self.open_branch().sprout(result, revision_id=revision_id)
1060
except errors.NotBranchError:
1062
# we always want a working tree
1063
WorkingTreeFormat2().initialize(result,
1064
accelerator_tree=accelerator_tree)
1068
class BzrDir4(BzrDirPreSplitOut):
1069
"""A .bzr version 4 control object.
1071
This is a deprecated format and may be removed after sept 2006.
1074
def create_repository(self, shared=False):
1075
"""See BzrDir.create_repository."""
1076
return self._format.repository_format.initialize(self, shared)
1078
def needs_format_conversion(self, format=None):
1079
"""Format 4 dirs are always in need of conversion."""
1082
def open_repository(self):
1083
"""See BzrDir.open_repository."""
1084
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1085
return RepositoryFormat4().open(self, _found=True)
1088
class BzrDir5(BzrDirPreSplitOut):
1089
"""A .bzr version 5 control object.
1091
This is a deprecated format and may be removed after sept 2006.
1094
def open_repository(self):
1095
"""See BzrDir.open_repository."""
1096
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1097
return RepositoryFormat5().open(self, _found=True)
1099
def open_workingtree(self, _unsupported=False,
1100
recommend_upgrade=True):
1101
"""See BzrDir.create_workingtree."""
1102
from bzrlib.workingtree import WorkingTreeFormat2
1103
wt_format = WorkingTreeFormat2()
1104
# we don't warn here about upgrades; that ought to be handled for the
1106
return wt_format.open(self, _found=True)
1109
class BzrDir6(BzrDirPreSplitOut):
1110
"""A .bzr version 6 control object.
1112
This is a deprecated format and may be removed after sept 2006.
1115
def open_repository(self):
1116
"""See BzrDir.open_repository."""
1117
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1118
return RepositoryFormat6().open(self, _found=True)
1120
def open_workingtree(self, _unsupported=False,
1121
recommend_upgrade=True):
1122
"""See BzrDir.create_workingtree."""
1123
# we don't warn here about upgrades; that ought to be handled for the
1125
from bzrlib.workingtree import WorkingTreeFormat2
1126
return WorkingTreeFormat2().open(self, _found=True)
1129
class BzrDirMeta1(BzrDir):
1130
"""A .bzr meta version 1 control object.
1132
This is the first control object where the
1133
individual aspects are really split out: there are separate repository,
1134
workingtree and branch subdirectories and any subset of the three can be
1135
present within a BzrDir.
1138
def can_convert_format(self):
1139
"""See BzrDir.can_convert_format()."""
1142
def create_branch(self):
1143
"""See BzrDir.create_branch."""
1144
return self._format.get_branch_format().initialize(self)
1146
def destroy_branch(self):
1147
"""See BzrDir.create_branch."""
1148
self.transport.delete_tree('branch')
1150
def create_repository(self, shared=False):
1151
"""See BzrDir.create_repository."""
1152
return self._format.repository_format.initialize(self, shared)
1154
def destroy_repository(self):
1155
"""See BzrDir.destroy_repository."""
1156
self.transport.delete_tree('repository')
1158
def create_workingtree(self, revision_id=None, from_branch=None,
1159
accelerator_tree=None):
1160
"""See BzrDir.create_workingtree."""
1161
return self._format.workingtree_format.initialize(
1162
self, revision_id, from_branch=from_branch,
1163
accelerator_tree=accelerator_tree)
1165
def destroy_workingtree(self):
1166
"""See BzrDir.destroy_workingtree."""
1167
wt = self.open_workingtree(recommend_upgrade=False)
1168
repository = wt.branch.repository
1169
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1170
wt.revert(old_tree=empty)
1171
self.destroy_workingtree_metadata()
1173
def destroy_workingtree_metadata(self):
1174
self.transport.delete_tree('checkout')
1176
def find_branch_format(self):
1177
"""Find the branch 'format' for this bzrdir.
1179
This might be a synthetic object for e.g. RemoteBranch and SVN.
1181
from bzrlib.branch import BranchFormat
1182
return BranchFormat.find_format(self)
1184
def _get_mkdir_mode(self):
1185
"""Figure out the mode to use when creating a bzrdir subdir."""
1186
temp_control = lockable_files.LockableFiles(self.transport, '',
1187
lockable_files.TransportLock)
1188
return temp_control._dir_mode
1190
def get_branch_reference(self):
1191
"""See BzrDir.get_branch_reference()."""
1192
from bzrlib.branch import BranchFormat
1193
format = BranchFormat.find_format(self)
1194
return format.get_reference(self)
1196
def get_branch_transport(self, branch_format):
1197
"""See BzrDir.get_branch_transport()."""
1198
if branch_format is None:
1199
return self.transport.clone('branch')
1201
branch_format.get_format_string()
1202
except NotImplementedError:
1203
raise errors.IncompatibleFormat(branch_format, self._format)
1205
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1206
except errors.FileExists:
1208
return self.transport.clone('branch')
1210
def get_repository_transport(self, repository_format):
1211
"""See BzrDir.get_repository_transport()."""
1212
if repository_format is None:
1213
return self.transport.clone('repository')
1215
repository_format.get_format_string()
1216
except NotImplementedError:
1217
raise errors.IncompatibleFormat(repository_format, self._format)
1219
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1220
except errors.FileExists:
1222
return self.transport.clone('repository')
1224
def get_workingtree_transport(self, workingtree_format):
1225
"""See BzrDir.get_workingtree_transport()."""
1226
if workingtree_format is None:
1227
return self.transport.clone('checkout')
1229
workingtree_format.get_format_string()
1230
except NotImplementedError:
1231
raise errors.IncompatibleFormat(workingtree_format, self._format)
1233
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1234
except errors.FileExists:
1236
return self.transport.clone('checkout')
1238
def needs_format_conversion(self, format=None):
1239
"""See BzrDir.needs_format_conversion()."""
1241
format = BzrDirFormat.get_default_format()
1242
if not isinstance(self._format, format.__class__):
1243
# it is not a meta dir format, conversion is needed.
1245
# we might want to push this down to the repository?
1247
if not isinstance(self.open_repository()._format,
1248
format.repository_format.__class__):
1249
# the repository needs an upgrade.
1251
except errors.NoRepositoryPresent:
1254
if not isinstance(self.open_branch()._format,
1255
format.get_branch_format().__class__):
1256
# the branch needs an upgrade.
1258
except errors.NotBranchError:
1261
my_wt = self.open_workingtree(recommend_upgrade=False)
1262
if not isinstance(my_wt._format,
1263
format.workingtree_format.__class__):
1264
# the workingtree needs an upgrade.
1266
except (errors.NoWorkingTree, errors.NotLocalUrl):
1270
def open_branch(self, unsupported=False):
1271
"""See BzrDir.open_branch."""
1272
format = self.find_branch_format()
1273
self._check_supported(format, unsupported)
1274
return format.open(self, _found=True)
1276
def open_repository(self, unsupported=False):
1277
"""See BzrDir.open_repository."""
1278
from bzrlib.repository import RepositoryFormat
1279
format = RepositoryFormat.find_format(self)
1280
self._check_supported(format, unsupported)
1281
return format.open(self, _found=True)
1283
def open_workingtree(self, unsupported=False,
1284
recommend_upgrade=True):
1285
"""See BzrDir.open_workingtree."""
1286
from bzrlib.workingtree import WorkingTreeFormat
1287
format = WorkingTreeFormat.find_format(self)
1288
self._check_supported(format, unsupported,
1290
basedir=self.root_transport.base)
1291
return format.open(self, _found=True)
1294
class BzrDirFormat(object):
1295
"""An encapsulation of the initialization and open routines for a format.
1297
Formats provide three things:
1298
* An initialization routine,
1302
Formats are placed in a dict by their format string for reference
1303
during bzrdir opening. These should be subclasses of BzrDirFormat
1306
Once a format is deprecated, just deprecate the initialize and open
1307
methods on the format class. Do not deprecate the object, as the
1308
object will be created every system load.
1311
_default_format = None
1312
"""The default format used for new .bzr dirs."""
1315
"""The known formats."""
1317
_control_formats = []
1318
"""The registered control formats - .bzr, ....
1320
This is a list of BzrDirFormat objects.
1323
_control_server_formats = []
1324
"""The registered control server formats, e.g. RemoteBzrDirs.
1326
This is a list of BzrDirFormat objects.
1329
_lock_file_name = 'branch-lock'
1331
# _lock_class must be set in subclasses to the lock type, typ.
1332
# TransportLock or LockDir
1335
def find_format(klass, transport, _server_formats=True):
1336
"""Return the format present at transport."""
1338
formats = klass._control_server_formats + klass._control_formats
1340
formats = klass._control_formats
1341
for format in formats:
1343
return format.probe_transport(transport)
1344
except errors.NotBranchError:
1345
# this format does not find a control dir here.
1347
raise errors.NotBranchError(path=transport.base)
1350
def probe_transport(klass, transport):
1351
"""Return the .bzrdir style format present in a directory."""
1353
format_string = transport.get(".bzr/branch-format").read()
1354
except errors.NoSuchFile:
1355
raise errors.NotBranchError(path=transport.base)
1358
return klass._formats[format_string]
1360
raise errors.UnknownFormatError(format=format_string)
1363
def get_default_format(klass):
1364
"""Return the current default format."""
1365
return klass._default_format
1367
def get_format_string(self):
1368
"""Return the ASCII format string that identifies this format."""
1369
raise NotImplementedError(self.get_format_string)
1371
def get_format_description(self):
1372
"""Return the short description for this format."""
1373
raise NotImplementedError(self.get_format_description)
1375
def get_converter(self, format=None):
1376
"""Return the converter to use to convert bzrdirs needing converts.
1378
This returns a bzrlib.bzrdir.Converter object.
1380
This should return the best upgrader to step this format towards the
1381
current default format. In the case of plugins we can/should provide
1382
some means for them to extend the range of returnable converters.
1384
:param format: Optional format to override the default format of the
1387
raise NotImplementedError(self.get_converter)
1389
def initialize(self, url, possible_transports=None):
1390
"""Create a bzr control dir at this url and return an opened copy.
1392
Subclasses should typically override initialize_on_transport
1393
instead of this method.
1395
return self.initialize_on_transport(get_transport(url,
1396
possible_transports))
1398
def initialize_on_transport(self, transport):
1399
"""Initialize a new bzrdir in the base directory of a Transport."""
1400
# Since we don't have a .bzr directory, inherit the
1401
# mode from the root directory
1402
temp_control = lockable_files.LockableFiles(transport,
1403
'', lockable_files.TransportLock)
1404
temp_control._transport.mkdir('.bzr',
1405
# FIXME: RBC 20060121 don't peek under
1407
mode=temp_control._dir_mode)
1408
if sys.platform == 'win32' and isinstance(transport, LocalTransport):
1409
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1410
file_mode = temp_control._file_mode
1412
mutter('created control directory in ' + transport.base)
1413
control = transport.clone('.bzr')
1414
utf8_files = [('README',
1415
"This is a Bazaar-NG control directory.\n"
1416
"Do not change any files in this directory.\n"),
1417
('branch-format', self.get_format_string()),
1419
# NB: no need to escape relative paths that are url safe.
1420
control_files = lockable_files.LockableFiles(control,
1421
self._lock_file_name, self._lock_class)
1422
control_files.create_lock()
1423
control_files.lock_write()
1425
for file, content in utf8_files:
1426
control_files.put_utf8(file, content)
1428
control_files.unlock()
1429
return self.open(transport, _found=True)
1431
def is_supported(self):
1432
"""Is this format supported?
1434
Supported formats must be initializable and openable.
1435
Unsupported formats may not support initialization or committing or
1436
some other features depending on the reason for not being supported.
1440
def same_model(self, target_format):
1441
return (self.repository_format.rich_root_data ==
1442
target_format.rich_root_data)
1445
def known_formats(klass):
1446
"""Return all the known formats.
1448
Concrete formats should override _known_formats.
1450
# There is double indirection here to make sure that control
1451
# formats used by more than one dir format will only be probed
1452
# once. This can otherwise be quite expensive for remote connections.
1454
for format in klass._control_formats:
1455
result.update(format._known_formats())
1459
def _known_formats(klass):
1460
"""Return the known format instances for this control format."""
1461
return set(klass._formats.values())
1463
def open(self, transport, _found=False):
1464
"""Return an instance of this format for the dir transport points at.
1466
_found is a private parameter, do not use it.
1469
found_format = BzrDirFormat.find_format(transport)
1470
if not isinstance(found_format, self.__class__):
1471
raise AssertionError("%s was asked to open %s, but it seems to need "
1473
% (self, transport, found_format))
1474
return self._open(transport)
1476
def _open(self, transport):
1477
"""Template method helper for opening BzrDirectories.
1479
This performs the actual open and any additional logic or parameter
1482
raise NotImplementedError(self._open)
1485
def register_format(klass, format):
1486
klass._formats[format.get_format_string()] = format
1489
def register_control_format(klass, format):
1490
"""Register a format that does not use '.bzr' for its control dir.
1492
TODO: This should be pulled up into a 'ControlDirFormat' base class
1493
which BzrDirFormat can inherit from, and renamed to register_format
1494
there. It has been done without that for now for simplicity of
1497
klass._control_formats.append(format)
1500
def register_control_server_format(klass, format):
1501
"""Register a control format for client-server environments.
1503
These formats will be tried before ones registered with
1504
register_control_format. This gives implementations that decide to the
1505
chance to grab it before anything looks at the contents of the format
1508
klass._control_server_formats.append(format)
1511
@symbol_versioning.deprecated_method(symbol_versioning.zero_fourteen)
1512
def set_default_format(klass, format):
1513
klass._set_default_format(format)
1516
def _set_default_format(klass, format):
1517
"""Set default format (for testing behavior of defaults only)"""
1518
klass._default_format = format
1522
return self.get_format_string().rstrip()
1525
def unregister_format(klass, format):
1526
assert klass._formats[format.get_format_string()] is format
1527
del klass._formats[format.get_format_string()]
1530
def unregister_control_format(klass, format):
1531
klass._control_formats.remove(format)
1534
class BzrDirFormat4(BzrDirFormat):
1535
"""Bzr dir format 4.
1537
This format is a combined format for working tree, branch and repository.
1539
- Format 1 working trees [always]
1540
- Format 4 branches [always]
1541
- Format 4 repositories [always]
1543
This format is deprecated: it indexes texts using a text it which is
1544
removed in format 5; write support for this format has been removed.
1547
_lock_class = lockable_files.TransportLock
1549
def get_format_string(self):
1550
"""See BzrDirFormat.get_format_string()."""
1551
return "Bazaar-NG branch, format 0.0.4\n"
1553
def get_format_description(self):
1554
"""See BzrDirFormat.get_format_description()."""
1555
return "All-in-one format 4"
1557
def get_converter(self, format=None):
1558
"""See BzrDirFormat.get_converter()."""
1559
# there is one and only one upgrade path here.
1560
return ConvertBzrDir4To5()
1562
def initialize_on_transport(self, transport):
1563
"""Format 4 branches cannot be created."""
1564
raise errors.UninitializableFormat(self)
1566
def is_supported(self):
1567
"""Format 4 is not supported.
1569
It is not supported because the model changed from 4 to 5 and the
1570
conversion logic is expensive - so doing it on the fly was not
1575
def _open(self, transport):
1576
"""See BzrDirFormat._open."""
1577
return BzrDir4(transport, self)
1579
def __return_repository_format(self):
1580
"""Circular import protection."""
1581
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1582
return RepositoryFormat4()
1583
repository_format = property(__return_repository_format)
1586
class BzrDirFormat5(BzrDirFormat):
1587
"""Bzr control format 5.
1589
This format is a combined format for working tree, branch and repository.
1591
- Format 2 working trees [always]
1592
- Format 4 branches [always]
1593
- Format 5 repositories [always]
1594
Unhashed stores in the repository.
1597
_lock_class = lockable_files.TransportLock
1599
def get_format_string(self):
1600
"""See BzrDirFormat.get_format_string()."""
1601
return "Bazaar-NG branch, format 5\n"
1603
def get_format_description(self):
1604
"""See BzrDirFormat.get_format_description()."""
1605
return "All-in-one format 5"
1607
def get_converter(self, format=None):
1608
"""See BzrDirFormat.get_converter()."""
1609
# there is one and only one upgrade path here.
1610
return ConvertBzrDir5To6()
1612
def _initialize_for_clone(self, url):
1613
return self.initialize_on_transport(get_transport(url), _cloning=True)
1615
def initialize_on_transport(self, transport, _cloning=False):
1616
"""Format 5 dirs always have working tree, branch and repository.
1618
Except when they are being cloned.
1620
from bzrlib.branch import BzrBranchFormat4
1621
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1622
from bzrlib.workingtree import WorkingTreeFormat2
1623
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1624
RepositoryFormat5().initialize(result, _internal=True)
1626
branch = BzrBranchFormat4().initialize(result)
1628
WorkingTreeFormat2().initialize(result)
1629
except errors.NotLocalUrl:
1630
# Even though we can't access the working tree, we need to
1631
# create its control files.
1632
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1635
def _open(self, transport):
1636
"""See BzrDirFormat._open."""
1637
return BzrDir5(transport, self)
1639
def __return_repository_format(self):
1640
"""Circular import protection."""
1641
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1642
return RepositoryFormat5()
1643
repository_format = property(__return_repository_format)
1646
class BzrDirFormat6(BzrDirFormat):
1647
"""Bzr control format 6.
1649
This format is a combined format for working tree, branch and repository.
1651
- Format 2 working trees [always]
1652
- Format 4 branches [always]
1653
- Format 6 repositories [always]
1656
_lock_class = lockable_files.TransportLock
1658
def get_format_string(self):
1659
"""See BzrDirFormat.get_format_string()."""
1660
return "Bazaar-NG branch, format 6\n"
1662
def get_format_description(self):
1663
"""See BzrDirFormat.get_format_description()."""
1664
return "All-in-one format 6"
1666
def get_converter(self, format=None):
1667
"""See BzrDirFormat.get_converter()."""
1668
# there is one and only one upgrade path here.
1669
return ConvertBzrDir6ToMeta()
1671
def _initialize_for_clone(self, url):
1672
return self.initialize_on_transport(get_transport(url), _cloning=True)
1674
def initialize_on_transport(self, transport, _cloning=False):
1675
"""Format 6 dirs always have working tree, branch and repository.
1677
Except when they are being cloned.
1679
from bzrlib.branch import BzrBranchFormat4
1680
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1681
from bzrlib.workingtree import WorkingTreeFormat2
1682
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1683
RepositoryFormat6().initialize(result, _internal=True)
1685
branch = BzrBranchFormat4().initialize(result)
1687
WorkingTreeFormat2().initialize(result)
1688
except errors.NotLocalUrl:
1689
# Even though we can't access the working tree, we need to
1690
# create its control files.
1691
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1694
def _open(self, transport):
1695
"""See BzrDirFormat._open."""
1696
return BzrDir6(transport, self)
1698
def __return_repository_format(self):
1699
"""Circular import protection."""
1700
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1701
return RepositoryFormat6()
1702
repository_format = property(__return_repository_format)
1705
class BzrDirMetaFormat1(BzrDirFormat):
1706
"""Bzr meta control format 1
1708
This is the first format with split out working tree, branch and repository
1711
- Format 3 working trees [optional]
1712
- Format 5 branches [optional]
1713
- Format 7 repositories [optional]
1716
_lock_class = lockdir.LockDir
1719
self._workingtree_format = None
1720
self._branch_format = None
1722
def __eq__(self, other):
1723
if other.__class__ is not self.__class__:
1725
if other.repository_format != self.repository_format:
1727
if other.workingtree_format != self.workingtree_format:
1731
def __ne__(self, other):
1732
return not self == other
1734
def get_branch_format(self):
1735
if self._branch_format is None:
1736
from bzrlib.branch import BranchFormat
1737
self._branch_format = BranchFormat.get_default_format()
1738
return self._branch_format
1740
def set_branch_format(self, format):
1741
self._branch_format = format
1743
def get_converter(self, format=None):
1744
"""See BzrDirFormat.get_converter()."""
1746
format = BzrDirFormat.get_default_format()
1747
if not isinstance(self, format.__class__):
1748
# converting away from metadir is not implemented
1749
raise NotImplementedError(self.get_converter)
1750
return ConvertMetaToMeta(format)
1752
def get_format_string(self):
1753
"""See BzrDirFormat.get_format_string()."""
1754
return "Bazaar-NG meta directory, format 1\n"
1756
def get_format_description(self):
1757
"""See BzrDirFormat.get_format_description()."""
1758
return "Meta directory format 1"
1760
def _open(self, transport):
1761
"""See BzrDirFormat._open."""
1762
return BzrDirMeta1(transport, self)
1764
def __return_repository_format(self):
1765
"""Circular import protection."""
1766
if getattr(self, '_repository_format', None):
1767
return self._repository_format
1768
from bzrlib.repository import RepositoryFormat
1769
return RepositoryFormat.get_default_format()
1771
def __set_repository_format(self, value):
1772
"""Allow changing the repository format for metadir formats."""
1773
self._repository_format = value
1775
repository_format = property(__return_repository_format, __set_repository_format)
1777
def __get_workingtree_format(self):
1778
if self._workingtree_format is None:
1779
from bzrlib.workingtree import WorkingTreeFormat
1780
self._workingtree_format = WorkingTreeFormat.get_default_format()
1781
return self._workingtree_format
1783
def __set_workingtree_format(self, wt_format):
1784
self._workingtree_format = wt_format
1786
workingtree_format = property(__get_workingtree_format,
1787
__set_workingtree_format)
1790
# Register bzr control format
1791
BzrDirFormat.register_control_format(BzrDirFormat)
1793
# Register bzr formats
1794
BzrDirFormat.register_format(BzrDirFormat4())
1795
BzrDirFormat.register_format(BzrDirFormat5())
1796
BzrDirFormat.register_format(BzrDirFormat6())
1797
__default_format = BzrDirMetaFormat1()
1798
BzrDirFormat.register_format(__default_format)
1799
BzrDirFormat._default_format = __default_format
1802
class Converter(object):
1803
"""Converts a disk format object from one format to another."""
1805
def convert(self, to_convert, pb):
1806
"""Perform the conversion of to_convert, giving feedback via pb.
1808
:param to_convert: The disk object to convert.
1809
:param pb: a progress bar to use for progress information.
1812
def step(self, message):
1813
"""Update the pb by a step."""
1815
self.pb.update(message, self.count, self.total)
1818
class ConvertBzrDir4To5(Converter):
1819
"""Converts format 4 bzr dirs to format 5."""
1822
super(ConvertBzrDir4To5, self).__init__()
1823
self.converted_revs = set()
1824
self.absent_revisions = set()
1828
def convert(self, to_convert, pb):
1829
"""See Converter.convert()."""
1830
self.bzrdir = to_convert
1832
self.pb.note('starting upgrade from format 4 to 5')
1833
if isinstance(self.bzrdir.transport, LocalTransport):
1834
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
1835
self._convert_to_weaves()
1836
return BzrDir.open(self.bzrdir.root_transport.base)
1838
def _convert_to_weaves(self):
1839
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
1842
stat = self.bzrdir.transport.stat('weaves')
1843
if not S_ISDIR(stat.st_mode):
1844
self.bzrdir.transport.delete('weaves')
1845
self.bzrdir.transport.mkdir('weaves')
1846
except errors.NoSuchFile:
1847
self.bzrdir.transport.mkdir('weaves')
1848
# deliberately not a WeaveFile as we want to build it up slowly.
1849
self.inv_weave = Weave('inventory')
1850
# holds in-memory weaves for all files
1851
self.text_weaves = {}
1852
self.bzrdir.transport.delete('branch-format')
1853
self.branch = self.bzrdir.open_branch()
1854
self._convert_working_inv()
1855
rev_history = self.branch.revision_history()
1856
# to_read is a stack holding the revisions we still need to process;
1857
# appending to it adds new highest-priority revisions
1858
self.known_revisions = set(rev_history)
1859
self.to_read = rev_history[-1:]
1861
rev_id = self.to_read.pop()
1862
if (rev_id not in self.revisions
1863
and rev_id not in self.absent_revisions):
1864
self._load_one_rev(rev_id)
1866
to_import = self._make_order()
1867
for i, rev_id in enumerate(to_import):
1868
self.pb.update('converting revision', i, len(to_import))
1869
self._convert_one_rev(rev_id)
1871
self._write_all_weaves()
1872
self._write_all_revs()
1873
self.pb.note('upgraded to weaves:')
1874
self.pb.note(' %6d revisions and inventories', len(self.revisions))
1875
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
1876
self.pb.note(' %6d texts', self.text_count)
1877
self._cleanup_spare_files_after_format4()
1878
self.branch.control_files.put_utf8('branch-format', BzrDirFormat5().get_format_string())
1880
def _cleanup_spare_files_after_format4(self):
1881
# FIXME working tree upgrade foo.
1882
for n in 'merged-patches', 'pending-merged-patches':
1884
## assert os.path.getsize(p) == 0
1885
self.bzrdir.transport.delete(n)
1886
except errors.NoSuchFile:
1888
self.bzrdir.transport.delete_tree('inventory-store')
1889
self.bzrdir.transport.delete_tree('text-store')
1891
def _convert_working_inv(self):
1892
inv = xml4.serializer_v4.read_inventory(
1893
self.branch.control_files.get('inventory'))
1894
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
1895
# FIXME inventory is a working tree change.
1896
self.branch.control_files.put('inventory', StringIO(new_inv_xml))
1898
def _write_all_weaves(self):
1899
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
1900
weave_transport = self.bzrdir.transport.clone('weaves')
1901
weaves = WeaveStore(weave_transport, prefixed=False)
1902
transaction = WriteTransaction()
1906
for file_id, file_weave in self.text_weaves.items():
1907
self.pb.update('writing weave', i, len(self.text_weaves))
1908
weaves._put_weave(file_id, file_weave, transaction)
1910
self.pb.update('inventory', 0, 1)
1911
controlweaves._put_weave('inventory', self.inv_weave, transaction)
1912
self.pb.update('inventory', 1, 1)
1916
def _write_all_revs(self):
1917
"""Write all revisions out in new form."""
1918
self.bzrdir.transport.delete_tree('revision-store')
1919
self.bzrdir.transport.mkdir('revision-store')
1920
revision_transport = self.bzrdir.transport.clone('revision-store')
1922
_revision_store = TextRevisionStore(TextStore(revision_transport,
1926
transaction = WriteTransaction()
1927
for i, rev_id in enumerate(self.converted_revs):
1928
self.pb.update('write revision', i, len(self.converted_revs))
1929
_revision_store.add_revision(self.revisions[rev_id], transaction)
1933
def _load_one_rev(self, rev_id):
1934
"""Load a revision object into memory.
1936
Any parents not either loaded or abandoned get queued to be
1938
self.pb.update('loading revision',
1939
len(self.revisions),
1940
len(self.known_revisions))
1941
if not self.branch.repository.has_revision(rev_id):
1943
self.pb.note('revision {%s} not present in branch; '
1944
'will be converted as a ghost',
1946
self.absent_revisions.add(rev_id)
1948
rev = self.branch.repository._revision_store.get_revision(rev_id,
1949
self.branch.repository.get_transaction())
1950
for parent_id in rev.parent_ids:
1951
self.known_revisions.add(parent_id)
1952
self.to_read.append(parent_id)
1953
self.revisions[rev_id] = rev
1955
def _load_old_inventory(self, rev_id):
1956
assert rev_id not in self.converted_revs
1957
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
1958
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
1959
inv.revision_id = rev_id
1960
rev = self.revisions[rev_id]
1961
if rev.inventory_sha1:
1962
assert rev.inventory_sha1 == sha_string(old_inv_xml), \
1963
'inventory sha mismatch for {%s}' % rev_id
1966
def _load_updated_inventory(self, rev_id):
1967
assert rev_id in self.converted_revs
1968
inv_xml = self.inv_weave.get_text(rev_id)
1969
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml)
1972
def _convert_one_rev(self, rev_id):
1973
"""Convert revision and all referenced objects to new format."""
1974
rev = self.revisions[rev_id]
1975
inv = self._load_old_inventory(rev_id)
1976
present_parents = [p for p in rev.parent_ids
1977
if p not in self.absent_revisions]
1978
self._convert_revision_contents(rev, inv, present_parents)
1979
self._store_new_inv(rev, inv, present_parents)
1980
self.converted_revs.add(rev_id)
1982
def _store_new_inv(self, rev, inv, present_parents):
1983
# the XML is now updated with text versions
1985
entries = inv.iter_entries()
1987
for path, ie in entries:
1988
assert getattr(ie, 'revision', None) is not None, \
1989
'no revision on {%s} in {%s}' % \
1990
(file_id, rev.revision_id)
1991
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
1992
new_inv_sha1 = sha_string(new_inv_xml)
1993
self.inv_weave.add_lines(rev.revision_id,
1995
new_inv_xml.splitlines(True))
1996
rev.inventory_sha1 = new_inv_sha1
1998
def _convert_revision_contents(self, rev, inv, present_parents):
1999
"""Convert all the files within a revision.
2001
Also upgrade the inventory to refer to the text revision ids."""
2002
rev_id = rev.revision_id
2003
mutter('converting texts of revision {%s}',
2005
parent_invs = map(self._load_updated_inventory, present_parents)
2006
entries = inv.iter_entries()
2008
for path, ie in entries:
2009
self._convert_file_version(rev, ie, parent_invs)
2011
def _convert_file_version(self, rev, ie, parent_invs):
2012
"""Convert one version of one file.
2014
The file needs to be added into the weave if it is a merge
2015
of >=2 parents or if it's changed from its parent.
2017
file_id = ie.file_id
2018
rev_id = rev.revision_id
2019
w = self.text_weaves.get(file_id)
2022
self.text_weaves[file_id] = w
2023
text_changed = False
2024
parent_candiate_entries = ie.parent_candidates(parent_invs)
2025
for old_revision in parent_candiate_entries.keys():
2026
# if this fails, its a ghost ?
2027
assert old_revision in self.converted_revs, \
2028
"Revision {%s} not in converted_revs" % old_revision
2029
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2030
# XXX: Note that this is unordered - and this is tolerable because
2031
# the previous code was also unordered.
2032
previous_entries = dict((head, parent_candiate_entries[head]) for head
2034
self.snapshot_ie(previous_entries, ie, w, rev_id)
2036
assert getattr(ie, 'revision', None) is not None
2038
@symbol_versioning.deprecated_method(symbol_versioning.one_one)
2039
def get_parents(self, revision_ids):
2040
for revision_id in revision_ids:
2041
yield self.revisions[revision_id].parent_ids
2043
def get_parent_map(self, revision_ids):
2044
"""See graph._StackedParentsProvider.get_parent_map"""
2045
return dict((revision_id, self.revisions[revision_id])
2046
for revision_id in revision_ids
2047
if revision_id in self.revisions)
2049
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2050
# TODO: convert this logic, which is ~= snapshot to
2051
# a call to:. This needs the path figured out. rather than a work_tree
2052
# a v4 revision_tree can be given, or something that looks enough like
2053
# one to give the file content to the entry if it needs it.
2054
# and we need something that looks like a weave store for snapshot to
2056
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2057
if len(previous_revisions) == 1:
2058
previous_ie = previous_revisions.values()[0]
2059
if ie._unchanged(previous_ie):
2060
ie.revision = previous_ie.revision
2063
text = self.branch.repository.weave_store.get(ie.text_id)
2064
file_lines = text.readlines()
2065
assert sha_strings(file_lines) == ie.text_sha1
2066
assert sum(map(len, file_lines)) == ie.text_size
2067
w.add_lines(rev_id, previous_revisions, file_lines)
2068
self.text_count += 1
2070
w.add_lines(rev_id, previous_revisions, [])
2071
ie.revision = rev_id
2073
def _make_order(self):
2074
"""Return a suitable order for importing revisions.
2076
The order must be such that an revision is imported after all
2077
its (present) parents.
2079
todo = set(self.revisions.keys())
2080
done = self.absent_revisions.copy()
2083
# scan through looking for a revision whose parents
2085
for rev_id in sorted(list(todo)):
2086
rev = self.revisions[rev_id]
2087
parent_ids = set(rev.parent_ids)
2088
if parent_ids.issubset(done):
2089
# can take this one now
2090
order.append(rev_id)
2096
class ConvertBzrDir5To6(Converter):
2097
"""Converts format 5 bzr dirs to format 6."""
2099
def convert(self, to_convert, pb):
2100
"""See Converter.convert()."""
2101
self.bzrdir = to_convert
2103
self.pb.note('starting upgrade from format 5 to 6')
2104
self._convert_to_prefixed()
2105
return BzrDir.open(self.bzrdir.root_transport.base)
2107
def _convert_to_prefixed(self):
2108
from bzrlib.store import TransportStore
2109
self.bzrdir.transport.delete('branch-format')
2110
for store_name in ["weaves", "revision-store"]:
2111
self.pb.note("adding prefixes to %s" % store_name)
2112
store_transport = self.bzrdir.transport.clone(store_name)
2113
store = TransportStore(store_transport, prefixed=True)
2114
for urlfilename in store_transport.list_dir('.'):
2115
filename = urlutils.unescape(urlfilename)
2116
if (filename.endswith(".weave") or
2117
filename.endswith(".gz") or
2118
filename.endswith(".sig")):
2119
file_id = os.path.splitext(filename)[0]
2122
prefix_dir = store.hash_prefix(file_id)
2123
# FIXME keep track of the dirs made RBC 20060121
2125
store_transport.move(filename, prefix_dir + '/' + filename)
2126
except errors.NoSuchFile: # catches missing dirs strangely enough
2127
store_transport.mkdir(prefix_dir)
2128
store_transport.move(filename, prefix_dir + '/' + filename)
2129
self.bzrdir._control_files.put_utf8('branch-format', BzrDirFormat6().get_format_string())
2132
class ConvertBzrDir6ToMeta(Converter):
2133
"""Converts format 6 bzr dirs to metadirs."""
2135
def convert(self, to_convert, pb):
2136
"""See Converter.convert()."""
2137
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2138
from bzrlib.branch import BzrBranchFormat5
2139
self.bzrdir = to_convert
2142
self.total = 20 # the steps we know about
2143
self.garbage_inventories = []
2145
self.pb.note('starting upgrade from format 6 to metadir')
2146
self.bzrdir._control_files.put_utf8('branch-format', "Converting to format 6")
2147
# its faster to move specific files around than to open and use the apis...
2148
# first off, nuke ancestry.weave, it was never used.
2150
self.step('Removing ancestry.weave')
2151
self.bzrdir.transport.delete('ancestry.weave')
2152
except errors.NoSuchFile:
2154
# find out whats there
2155
self.step('Finding branch files')
2156
last_revision = self.bzrdir.open_branch().last_revision()
2157
bzrcontents = self.bzrdir.transport.list_dir('.')
2158
for name in bzrcontents:
2159
if name.startswith('basis-inventory.'):
2160
self.garbage_inventories.append(name)
2161
# create new directories for repository, working tree and branch
2162
self.dir_mode = self.bzrdir._control_files._dir_mode
2163
self.file_mode = self.bzrdir._control_files._file_mode
2164
repository_names = [('inventory.weave', True),
2165
('revision-store', True),
2167
self.step('Upgrading repository ')
2168
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2169
self.make_lock('repository')
2170
# we hard code the formats here because we are converting into
2171
# the meta format. The meta format upgrader can take this to a
2172
# future format within each component.
2173
self.put_format('repository', RepositoryFormat7())
2174
for entry in repository_names:
2175
self.move_entry('repository', entry)
2177
self.step('Upgrading branch ')
2178
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2179
self.make_lock('branch')
2180
self.put_format('branch', BzrBranchFormat5())
2181
branch_files = [('revision-history', True),
2182
('branch-name', True),
2184
for entry in branch_files:
2185
self.move_entry('branch', entry)
2187
checkout_files = [('pending-merges', True),
2188
('inventory', True),
2189
('stat-cache', False)]
2190
# If a mandatory checkout file is not present, the branch does not have
2191
# a functional checkout. Do not create a checkout in the converted
2193
for name, mandatory in checkout_files:
2194
if mandatory and name not in bzrcontents:
2195
has_checkout = False
2199
if not has_checkout:
2200
self.pb.note('No working tree.')
2201
# If some checkout files are there, we may as well get rid of them.
2202
for name, mandatory in checkout_files:
2203
if name in bzrcontents:
2204
self.bzrdir.transport.delete(name)
2206
from bzrlib.workingtree import WorkingTreeFormat3
2207
self.step('Upgrading working tree')
2208
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2209
self.make_lock('checkout')
2211
'checkout', WorkingTreeFormat3())
2212
self.bzrdir.transport.delete_multi(
2213
self.garbage_inventories, self.pb)
2214
for entry in checkout_files:
2215
self.move_entry('checkout', entry)
2216
if last_revision is not None:
2217
self.bzrdir._control_files.put_utf8(
2218
'checkout/last-revision', last_revision)
2219
self.bzrdir._control_files.put_utf8(
2220
'branch-format', BzrDirMetaFormat1().get_format_string())
2221
return BzrDir.open(self.bzrdir.root_transport.base)
2223
def make_lock(self, name):
2224
"""Make a lock for the new control dir name."""
2225
self.step('Make %s lock' % name)
2226
ld = lockdir.LockDir(self.bzrdir.transport,
2228
file_modebits=self.file_mode,
2229
dir_modebits=self.dir_mode)
2232
def move_entry(self, new_dir, entry):
2233
"""Move then entry name into new_dir."""
2235
mandatory = entry[1]
2236
self.step('Moving %s' % name)
2238
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2239
except errors.NoSuchFile:
2243
def put_format(self, dirname, format):
2244
self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
2247
class ConvertMetaToMeta(Converter):
2248
"""Converts the components of metadirs."""
2250
def __init__(self, target_format):
2251
"""Create a metadir to metadir converter.
2253
:param target_format: The final metadir format that is desired.
2255
self.target_format = target_format
2257
def convert(self, to_convert, pb):
2258
"""See Converter.convert()."""
2259
self.bzrdir = to_convert
2263
self.step('checking repository format')
2265
repo = self.bzrdir.open_repository()
2266
except errors.NoRepositoryPresent:
2269
if not isinstance(repo._format, self.target_format.repository_format.__class__):
2270
from bzrlib.repository import CopyConverter
2271
self.pb.note('starting repository conversion')
2272
converter = CopyConverter(self.target_format.repository_format)
2273
converter.convert(repo, pb)
2275
branch = self.bzrdir.open_branch()
2276
except errors.NotBranchError:
2279
# TODO: conversions of Branch and Tree should be done by
2280
# InterXFormat lookups
2281
# Avoid circular imports
2282
from bzrlib import branch as _mod_branch
2283
if (branch._format.__class__ is _mod_branch.BzrBranchFormat5 and
2284
self.target_format.get_branch_format().__class__ is
2285
_mod_branch.BzrBranchFormat6):
2286
branch_converter = _mod_branch.Converter5to6()
2287
branch_converter.convert(branch)
2289
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
2290
except (errors.NoWorkingTree, errors.NotLocalUrl):
2293
# TODO: conversions of Branch and Tree should be done by
2294
# InterXFormat lookups
2295
if (isinstance(tree, workingtree.WorkingTree3) and
2296
not isinstance(tree, workingtree_4.WorkingTree4) and
2297
isinstance(self.target_format.workingtree_format,
2298
workingtree_4.WorkingTreeFormat4)):
2299
workingtree_4.Converter3to4().convert(tree)
2303
# This is not in remote.py because it's small, and needs to be registered.
2304
# Putting it in remote.py creates a circular import problem.
2305
# we can make it a lazy object if the control formats is turned into something
2307
class RemoteBzrDirFormat(BzrDirMetaFormat1):
2308
"""Format representing bzrdirs accessed via a smart server"""
2310
def get_format_description(self):
2311
return 'bzr remote bzrdir'
2314
def probe_transport(klass, transport):
2315
"""Return a RemoteBzrDirFormat object if it looks possible."""
2317
client = transport.get_smart_client()
2318
except (NotImplementedError, AttributeError,
2319
errors.TransportNotPossible):
2320
# no smart server, so not a branch for this format type.
2321
raise errors.NotBranchError(path=transport.base)
2323
# Send a 'hello' request in protocol version one, and decline to
2324
# open it if the server doesn't support our required version (2) so
2325
# that the VFS-based transport will do it.
2326
request = client.get_request()
2327
smart_protocol = protocol.SmartClientRequestProtocolOne(request)
2328
server_version = smart_protocol.query_version()
2329
if server_version != 2:
2330
raise errors.NotBranchError(path=transport.base)
2333
def initialize_on_transport(self, transport):
2335
# hand off the request to the smart server
2336
shared_medium = transport.get_shared_medium()
2337
except errors.NoSmartMedium:
2338
# TODO: lookup the local format from a server hint.
2339
local_dir_format = BzrDirMetaFormat1()
2340
return local_dir_format.initialize_on_transport(transport)
2341
client = _SmartClient(shared_medium)
2342
path = client.remote_path_from_transport(transport)
2343
response = _SmartClient(shared_medium).call('BzrDirFormat.initialize',
2345
assert response[0] in ('ok', ), 'unexpected response code %s' % (response,)
2346
return remote.RemoteBzrDir(transport)
2348
def _open(self, transport):
2349
return remote.RemoteBzrDir(transport)
2351
def __eq__(self, other):
2352
if not isinstance(other, RemoteBzrDirFormat):
2354
return self.get_format_description() == other.get_format_description()
2357
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
2360
class BzrDirFormatInfo(object):
2362
def __init__(self, native, deprecated, hidden, experimental):
2363
self.deprecated = deprecated
2364
self.native = native
2365
self.hidden = hidden
2366
self.experimental = experimental
2369
class BzrDirFormatRegistry(registry.Registry):
2370
"""Registry of user-selectable BzrDir subformats.
2372
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
2373
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
2376
def register_metadir(self, key,
2377
repository_format, help, native=True, deprecated=False,
2381
experimental=False):
2382
"""Register a metadir subformat.
2384
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
2385
by the Repository format.
2387
:param repository_format: The fully-qualified repository format class
2389
:param branch_format: Fully-qualified branch format class name as
2391
:param tree_format: Fully-qualified tree format class name as
2394
# This should be expanded to support setting WorkingTree and Branch
2395
# formats, once BzrDirMetaFormat1 supports that.
2396
def _load(full_name):
2397
mod_name, factory_name = full_name.rsplit('.', 1)
2399
mod = __import__(mod_name, globals(), locals(),
2401
except ImportError, e:
2402
raise ImportError('failed to load %s: %s' % (full_name, e))
2404
factory = getattr(mod, factory_name)
2405
except AttributeError:
2406
raise AttributeError('no factory %s in module %r'
2411
bd = BzrDirMetaFormat1()
2412
if branch_format is not None:
2413
bd.set_branch_format(_load(branch_format))
2414
if tree_format is not None:
2415
bd.workingtree_format = _load(tree_format)
2416
if repository_format is not None:
2417
bd.repository_format = _load(repository_format)
2419
self.register(key, helper, help, native, deprecated, hidden,
2422
def register(self, key, factory, help, native=True, deprecated=False,
2423
hidden=False, experimental=False):
2424
"""Register a BzrDirFormat factory.
2426
The factory must be a callable that takes one parameter: the key.
2427
It must produce an instance of the BzrDirFormat when called.
2429
This function mainly exists to prevent the info object from being
2432
registry.Registry.register(self, key, factory, help,
2433
BzrDirFormatInfo(native, deprecated, hidden, experimental))
2435
def register_lazy(self, key, module_name, member_name, help, native=True,
2436
deprecated=False, hidden=False, experimental=False):
2437
registry.Registry.register_lazy(self, key, module_name, member_name,
2438
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
2440
def set_default(self, key):
2441
"""Set the 'default' key to be a clone of the supplied key.
2443
This method must be called once and only once.
2445
registry.Registry.register(self, 'default', self.get(key),
2446
self.get_help(key), info=self.get_info(key))
2448
def set_default_repository(self, key):
2449
"""Set the FormatRegistry default and Repository default.
2451
This is a transitional method while Repository.set_default_format
2454
if 'default' in self:
2455
self.remove('default')
2456
self.set_default(key)
2457
format = self.get('default')()
2458
assert isinstance(format, BzrDirMetaFormat1)
2460
def make_bzrdir(self, key):
2461
return self.get(key)()
2463
def help_topic(self, topic):
2464
output = textwrap.dedent("""\
2465
These formats can be used for creating branches, working trees, and
2469
default_realkey = None
2470
default_help = self.get_help('default')
2472
for key in self.keys():
2473
if key == 'default':
2475
help = self.get_help(key)
2476
if help == default_help:
2477
default_realkey = key
2479
help_pairs.append((key, help))
2481
def wrapped(key, help, info):
2483
help = '(native) ' + help
2484
return ':%s:\n%s\n\n' % (key,
2485
textwrap.fill(help, initial_indent=' ',
2486
subsequent_indent=' '))
2487
if default_realkey is not None:
2488
output += wrapped(default_realkey, '(default) %s' % default_help,
2489
self.get_info('default'))
2490
deprecated_pairs = []
2491
experimental_pairs = []
2492
for key, help in help_pairs:
2493
info = self.get_info(key)
2496
elif info.deprecated:
2497
deprecated_pairs.append((key, help))
2498
elif info.experimental:
2499
experimental_pairs.append((key, help))
2501
output += wrapped(key, help, info)
2502
if len(experimental_pairs) > 0:
2503
output += "Experimental formats are shown below.\n\n"
2504
for key, help in experimental_pairs:
2505
info = self.get_info(key)
2506
output += wrapped(key, help, info)
2507
if len(deprecated_pairs) > 0:
2508
output += "Deprecated formats are shown below.\n\n"
2509
for key, help in deprecated_pairs:
2510
info = self.get_info(key)
2511
output += wrapped(key, help, info)
2516
format_registry = BzrDirFormatRegistry()
2517
format_registry.register('weave', BzrDirFormat6,
2518
'Pre-0.8 format. Slower than knit and does not'
2519
' support checkouts or shared repositories.',
2521
format_registry.register_metadir('knit',
2522
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2523
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
2524
branch_format='bzrlib.branch.BzrBranchFormat5',
2525
tree_format='bzrlib.workingtree.WorkingTreeFormat3')
2526
format_registry.register_metadir('metaweave',
2527
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
2528
'Transitional format in 0.8. Slower than knit.',
2529
branch_format='bzrlib.branch.BzrBranchFormat5',
2530
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2532
format_registry.register_metadir('dirstate',
2533
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2534
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2535
'above when accessed over the network.',
2536
branch_format='bzrlib.branch.BzrBranchFormat5',
2537
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
2538
# directly from workingtree_4 triggers a circular import.
2539
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2541
format_registry.register_metadir('dirstate-tags',
2542
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2543
help='New in 0.15: Fast local operations and improved scaling for '
2544
'network operations. Additionally adds support for tags.'
2545
' Incompatible with bzr < 0.15.',
2546
branch_format='bzrlib.branch.BzrBranchFormat6',
2547
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2549
format_registry.register_metadir('rich-root',
2550
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
2551
help='New in 1.0. Better handling of tree roots. Incompatible with'
2553
branch_format='bzrlib.branch.BzrBranchFormat6',
2554
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2557
format_registry.register_metadir('dirstate-with-subtree',
2558
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2559
help='New in 0.15: Fast local operations and improved scaling for '
2560
'network operations. Additionally adds support for versioning nested '
2561
'bzr branches. Incompatible with bzr < 0.15.',
2562
branch_format='bzrlib.branch.BzrBranchFormat6',
2563
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2566
format_registry.register_metadir('pack-0.92',
2567
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
2568
help='New in 0.92: Pack-based format with data compatible with '
2569
'dirstate-tags format repositories. Interoperates with '
2570
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2571
'Previously called knitpack-experimental. '
2572
'For more information, see '
2573
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2574
branch_format='bzrlib.branch.BzrBranchFormat6',
2575
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2578
format_registry.register_metadir('pack-0.92-subtree',
2579
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
2580
help='New in 0.92: Pack-based format with data compatible with '
2581
'dirstate-with-subtree format repositories. Interoperates with '
2582
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2583
'Previously called knitpack-experimental. '
2584
'For more information, see '
2585
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2586
branch_format='bzrlib.branch.BzrBranchFormat6',
2587
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2591
format_registry.register_metadir('rich-root-pack',
2592
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
2593
help='New in 1.0: Pack-based format with data compatible with '
2594
'rich-root format repositories. Interoperates with '
2595
'bzr repositories before 0.92 but cannot be read by bzr < 1.0. '
2596
'NOTE: This format is experimental. Before using it, please read '
2597
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2598
branch_format='bzrlib.branch.BzrBranchFormat6',
2599
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2603
format_registry.set_default('pack-0.92')
added
removed
bzrlib/bzrdir.py
