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 (
87
"""A .bzr control diretory.
89
BzrDir instances let you create or open any of the things that can be
90
found within .bzr - checkouts, branches and repositories.
93
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
95
a transport connected to the directory this bzr was opened from
96
(i.e. the parent directory holding the .bzr directory).
100
"""Invoke break_lock on the first object in the bzrdir.
102
If there is a tree, the tree is opened and break_lock() called.
103
Otherwise, branch is tried, and finally repository.
105
# XXX: This seems more like a UI function than something that really
106
# belongs in this class.
108
thing_to_unlock = self.open_workingtree()
109
except (errors.NotLocalUrl, errors.NoWorkingTree):
111
thing_to_unlock = self.open_branch()
112
except errors.NotBranchError:
114
thing_to_unlock = self.open_repository()
115
except errors.NoRepositoryPresent:
117
thing_to_unlock.break_lock()
119
def can_convert_format(self):
120
"""Return true if this bzrdir is one whose format we can convert from."""
123
def check_conversion_target(self, target_format):
124
target_repo_format = target_format.repository_format
125
source_repo_format = self._format.repository_format
126
source_repo_format.check_conversion_target(target_repo_format)
129
def _check_supported(format, allow_unsupported,
130
recommend_upgrade=True,
132
"""Give an error or warning on old formats.
134
:param format: may be any kind of format - workingtree, branch,
137
:param allow_unsupported: If true, allow opening
138
formats that are strongly deprecated, and which may
139
have limited functionality.
141
:param recommend_upgrade: If true (default), warn
142
the user through the ui object that they may wish
143
to upgrade the object.
145
# TODO: perhaps move this into a base Format class; it's not BzrDir
146
# specific. mbp 20070323
147
if not allow_unsupported and not format.is_supported():
148
# see open_downlevel to open legacy branches.
149
raise errors.UnsupportedFormatError(format=format)
150
if recommend_upgrade \
151
and getattr(format, 'upgrade_recommended', False):
152
ui.ui_factory.recommend_upgrade(
153
format.get_format_description(),
156
def clone(self, url, revision_id=None, force_new_repo=False):
157
"""Clone this bzrdir and its contents to url verbatim.
159
If url's last component does not exist, it will be created.
161
if revision_id is not None, then the clone operation may tune
162
itself to download less data.
163
:param force_new_repo: Do not use a shared repository for the target
164
even if one is available.
166
return self.clone_on_transport(get_transport(url),
167
revision_id=revision_id,
168
force_new_repo=force_new_repo)
170
def clone_on_transport(self, transport, revision_id=None,
171
force_new_repo=False):
172
"""Clone this bzrdir and its contents to transport verbatim.
174
If the target directory does not exist, it will be created.
176
if revision_id is not None, then the clone operation may tune
177
itself to download less data.
178
:param force_new_repo: Do not use a shared repository for the target
179
even if one is available.
181
transport.ensure_base()
182
result = self.cloning_metadir().initialize_on_transport(transport)
183
repository_policy = None
185
local_repo = self.find_repository()
186
except errors.NoRepositoryPresent:
189
# may need to copy content in
190
repository_policy = result.determine_repository_policy(
192
make_working_trees = local_repo.make_working_trees()
193
result_repo = repository_policy.acquire_repository(
194
make_working_trees, local_repo.is_shared())
195
result_repo.fetch(local_repo, revision_id=revision_id)
196
# 1 if there is a branch present
197
# make sure its content is available in the target repository
200
local_branch = self.open_branch()
201
except errors.NotBranchError:
204
result_branch = local_branch.clone(result, revision_id=revision_id)
205
if repository_policy is not None:
206
repository_policy.configure_branch(result_branch)
208
result_repo = result.find_repository()
209
except errors.NoRepositoryPresent:
211
if result_repo is None or result_repo.make_working_trees():
213
self.open_workingtree().clone(result)
214
except (errors.NoWorkingTree, errors.NotLocalUrl):
218
# TODO: This should be given a Transport, and should chdir up; otherwise
219
# this will open a new connection.
220
def _make_tail(self, url):
221
t = get_transport(url)
225
def create(cls, base, format=None, possible_transports=None):
226
"""Create a new BzrDir at the url 'base'.
228
:param format: If supplied, the format of branch to create. If not
229
supplied, the default is used.
230
:param possible_transports: If supplied, a list of transports that
231
can be reused to share a remote connection.
233
if cls is not BzrDir:
234
raise AssertionError("BzrDir.create always creates the default"
235
" format, not one of %r" % cls)
236
t = get_transport(base, possible_transports)
239
format = BzrDirFormat.get_default_format()
240
return format.initialize_on_transport(t)
243
def find_bzrdirs(transport, evaluate=None, list_current=None):
244
"""Find bzrdirs recursively from current location.
246
This is intended primarily as a building block for more sophisticated
247
functionality, like finding trees under a directory, or finding
248
branches that use a given repository.
249
:param evaluate: An optional callable that yields recurse, value,
250
where recurse controls whether this bzrdir is recursed into
251
and value is the value to yield. By default, all bzrdirs
252
are recursed into, and the return value is the bzrdir.
253
:param list_current: if supplied, use this function to list the current
254
directory, instead of Transport.list_dir
255
:return: a generator of found bzrdirs, or whatever evaluate returns.
257
if list_current is None:
258
def list_current(transport):
259
return transport.list_dir('')
261
def evaluate(bzrdir):
264
pending = [transport]
265
while len(pending) > 0:
266
current_transport = pending.pop()
269
bzrdir = BzrDir.open_from_transport(current_transport)
270
except errors.NotBranchError:
273
recurse, value = evaluate(bzrdir)
276
subdirs = list_current(current_transport)
277
except errors.NoSuchFile:
280
for subdir in sorted(subdirs, reverse=True):
281
pending.append(current_transport.clone(subdir))
284
def find_branches(transport):
285
"""Find all branches under a transport.
287
This will find all branches below the transport, including branches
288
inside other branches. Where possible, it will use
289
Repository.find_branches.
291
To list all the branches that use a particular Repository, see
292
Repository.find_branches
294
def evaluate(bzrdir):
296
repository = bzrdir.open_repository()
297
except errors.NoRepositoryPresent:
300
return False, (None, repository)
302
branch = bzrdir.open_branch()
303
except errors.NotBranchError:
304
return True, (None, None)
306
return True, (branch, None)
308
for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
310
branches.extend(repo.find_branches())
311
if branch is not None:
312
branches.append(branch)
316
def destroy_repository(self):
317
"""Destroy the repository in this BzrDir"""
318
raise NotImplementedError(self.destroy_repository)
320
def create_branch(self):
321
"""Create a branch in this BzrDir.
323
The bzrdir's format will control what branch format is created.
324
For more control see BranchFormatXX.create(a_bzrdir).
326
raise NotImplementedError(self.create_branch)
328
def destroy_branch(self):
329
"""Destroy the branch in this BzrDir"""
330
raise NotImplementedError(self.destroy_branch)
333
def create_branch_and_repo(base, force_new_repo=False, format=None):
334
"""Create a new BzrDir, Branch and Repository at the url 'base'.
336
This will use the current default BzrDirFormat unless one is
337
specified, and use whatever
338
repository format that that uses via bzrdir.create_branch and
339
create_repository. If a shared repository is available that is used
342
The created Branch object is returned.
344
:param base: The URL to create the branch at.
345
:param force_new_repo: If True a new repository is always created.
346
:param format: If supplied, the format of branch to create. If not
347
supplied, the default is used.
349
bzrdir = BzrDir.create(base, format)
350
bzrdir._find_or_create_repository(force_new_repo)
351
return bzrdir.create_branch()
353
def determine_repository_policy(self, force_new_repo=False):
354
"""Return an object representing a policy to use.
356
This controls whether a new repository is created, or a shared
357
repository used instead.
359
def repository_policy(found_bzrdir):
361
# does it have a repository ?
363
repository = found_bzrdir.open_repository()
364
except errors.NoRepositoryPresent:
367
if ((found_bzrdir.root_transport.base !=
368
self.root_transport.base) and not repository.is_shared()):
375
return UseExistingRepository(repository), True
377
return CreateRepository(self), True
379
if not force_new_repo:
380
policy = self._find_containing(repository_policy)
381
if policy is not None:
383
return CreateRepository(self)
385
def _find_or_create_repository(self, force_new_repo):
386
"""Create a new repository if needed, returning the repository."""
387
policy = self.determine_repository_policy(force_new_repo)
388
return policy.acquire_repository()
391
def create_branch_convenience(base, force_new_repo=False,
392
force_new_tree=None, format=None,
393
possible_transports=None):
394
"""Create a new BzrDir, Branch and Repository at the url 'base'.
396
This is a convenience function - it will use an existing repository
397
if possible, can be told explicitly whether to create a working tree or
400
This will use the current default BzrDirFormat unless one is
401
specified, and use whatever
402
repository format that that uses via bzrdir.create_branch and
403
create_repository. If a shared repository is available that is used
404
preferentially. Whatever repository is used, its tree creation policy
407
The created Branch object is returned.
408
If a working tree cannot be made due to base not being a file:// url,
409
no error is raised unless force_new_tree is True, in which case no
410
data is created on disk and NotLocalUrl is raised.
412
:param base: The URL to create the branch at.
413
:param force_new_repo: If True a new repository is always created.
414
:param force_new_tree: If True or False force creation of a tree or
415
prevent such creation respectively.
416
:param format: Override for the bzrdir format to create.
417
:param possible_transports: An optional reusable transports list.
420
# check for non local urls
421
t = get_transport(base, possible_transports)
422
if not isinstance(t, LocalTransport):
423
raise errors.NotLocalUrl(base)
424
bzrdir = BzrDir.create(base, format, possible_transports)
425
repo = bzrdir._find_or_create_repository(force_new_repo)
426
result = bzrdir.create_branch()
427
if force_new_tree or (repo.make_working_trees() and
428
force_new_tree is None):
430
bzrdir.create_workingtree()
431
except errors.NotLocalUrl:
436
def create_standalone_workingtree(base, format=None):
437
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
439
'base' must be a local path or a file:// url.
441
This will use the current default BzrDirFormat unless one is
442
specified, and use whatever
443
repository format that that uses for bzrdirformat.create_workingtree,
444
create_branch and create_repository.
446
:param format: Override for the bzrdir format to create.
447
:return: The WorkingTree object.
449
t = get_transport(base)
450
if not isinstance(t, LocalTransport):
451
raise errors.NotLocalUrl(base)
452
bzrdir = BzrDir.create_branch_and_repo(base,
454
format=format).bzrdir
455
return bzrdir.create_workingtree()
457
def create_workingtree(self, revision_id=None, from_branch=None,
458
accelerator_tree=None, hardlink=False):
459
"""Create a working tree at this BzrDir.
461
:param revision_id: create it as of this revision id.
462
:param from_branch: override bzrdir branch (for lightweight checkouts)
463
:param accelerator_tree: A tree which can be used for retrieving file
464
contents more quickly than the revision tree, i.e. a workingtree.
465
The revision tree will be used for cases where accelerator_tree's
466
content is different.
468
raise NotImplementedError(self.create_workingtree)
470
def retire_bzrdir(self, limit=10000):
471
"""Permanently disable the bzrdir.
473
This is done by renaming it to give the user some ability to recover
474
if there was a problem.
476
This will have horrible consequences if anyone has anything locked or
478
:param limit: number of times to retry
483
to_path = '.bzr.retired.%d' % i
484
self.root_transport.rename('.bzr', to_path)
485
note("renamed %s to %s"
486
% (self.root_transport.abspath('.bzr'), to_path))
488
except (errors.TransportError, IOError, errors.PathError):
495
def destroy_workingtree(self):
496
"""Destroy the working tree at this BzrDir.
498
Formats that do not support this may raise UnsupportedOperation.
500
raise NotImplementedError(self.destroy_workingtree)
502
def destroy_workingtree_metadata(self):
503
"""Destroy the control files for the working tree at this BzrDir.
505
The contents of working tree files are not affected.
506
Formats that do not support this may raise UnsupportedOperation.
508
raise NotImplementedError(self.destroy_workingtree_metadata)
510
def _find_containing(self, evaluate):
511
"""Find something in a containing control directory.
513
This method will scan containing control dirs, until it finds what
514
it is looking for, decides that it will never find it, or runs out
515
of containing control directories to check.
517
It is used to implement find_repository and
518
determine_repository_policy.
520
:param evaluate: A function returning (value, stop). If stop is True,
521
the value will be returned.
525
result, stop = evaluate(found_bzrdir)
528
next_transport = found_bzrdir.root_transport.clone('..')
529
if (found_bzrdir.root_transport.base == next_transport.base):
530
# top of the file system
532
# find the next containing bzrdir
534
found_bzrdir = BzrDir.open_containing_from_transport(
536
except errors.NotBranchError:
539
def find_repository(self):
540
"""Find the repository that should be used.
542
This does not require a branch as we use it to find the repo for
543
new branches as well as to hook existing branches up to their
546
def usable_repository(found_bzrdir):
547
# does it have a repository ?
549
repository = found_bzrdir.open_repository()
550
except errors.NoRepositoryPresent:
552
if found_bzrdir.root_transport.base == self.root_transport.base:
553
return repository, True
554
elif repository.is_shared():
555
return repository, True
559
found_repo = self._find_containing(usable_repository)
560
if found_repo is None:
561
raise errors.NoRepositoryPresent(self)
564
def get_branch_reference(self):
565
"""Return the referenced URL for the branch in this bzrdir.
567
:raises NotBranchError: If there is no Branch.
568
:return: The URL the branch in this bzrdir references if it is a
569
reference branch, or None for regular branches.
573
def get_branch_transport(self, branch_format):
574
"""Get the transport for use by branch format in this BzrDir.
576
Note that bzr dirs that do not support format strings will raise
577
IncompatibleFormat if the branch format they are given has
578
a format string, and vice versa.
580
If branch_format is None, the transport is returned with no
581
checking. If it is not None, then the returned transport is
582
guaranteed to point to an existing directory ready for use.
584
raise NotImplementedError(self.get_branch_transport)
586
def get_repository_transport(self, repository_format):
587
"""Get the transport for use by repository format in this BzrDir.
589
Note that bzr dirs that do not support format strings will raise
590
IncompatibleFormat if the repository format they are given has
591
a format string, and vice versa.
593
If repository_format is None, the transport is returned with no
594
checking. If it is not None, then the returned transport is
595
guaranteed to point to an existing directory ready for use.
597
raise NotImplementedError(self.get_repository_transport)
599
def get_workingtree_transport(self, tree_format):
600
"""Get the transport for use by workingtree format in this BzrDir.
602
Note that bzr dirs that do not support format strings will raise
603
IncompatibleFormat if the workingtree format they are given has a
604
format string, and vice versa.
606
If workingtree_format is None, the transport is returned with no
607
checking. If it is not None, then the returned transport is
608
guaranteed to point to an existing directory ready for use.
610
raise NotImplementedError(self.get_workingtree_transport)
612
def __init__(self, _transport, _format):
613
"""Initialize a Bzr control dir object.
615
Only really common logic should reside here, concrete classes should be
616
made with varying behaviours.
618
:param _format: the format that is creating this BzrDir instance.
619
:param _transport: the transport this dir is based at.
621
self._format = _format
622
self.transport = _transport.clone('.bzr')
623
self.root_transport = _transport
625
def is_control_filename(self, filename):
626
"""True if filename is the name of a path which is reserved for bzrdir's.
628
:param filename: A filename within the root transport of this bzrdir.
630
This is true IF and ONLY IF the filename is part of the namespace reserved
631
for bzr control dirs. Currently this is the '.bzr' directory in the root
632
of the root_transport. it is expected that plugins will need to extend
633
this in the future - for instance to make bzr talk with svn working
636
# this might be better on the BzrDirFormat class because it refers to
637
# all the possible bzrdir disk formats.
638
# This method is tested via the workingtree is_control_filename tests-
639
# it was extracted from WorkingTree.is_control_filename. If the method's
640
# contract is extended beyond the current trivial implementation, please
641
# add new tests for it to the appropriate place.
642
return filename == '.bzr' or filename.startswith('.bzr/')
644
def needs_format_conversion(self, format=None):
645
"""Return true if this bzrdir needs convert_format run on it.
647
For instance, if the repository format is out of date but the
648
branch and working tree are not, this should return True.
650
:param format: Optional parameter indicating a specific desired
651
format we plan to arrive at.
653
raise NotImplementedError(self.needs_format_conversion)
656
def open_unsupported(base):
657
"""Open a branch which is not supported."""
658
return BzrDir.open(base, _unsupported=True)
661
def open(base, _unsupported=False, possible_transports=None):
662
"""Open an existing bzrdir, rooted at 'base' (url).
664
:param _unsupported: a private parameter to the BzrDir class.
666
t = get_transport(base, possible_transports=possible_transports)
667
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
670
def open_from_transport(transport, _unsupported=False,
671
_server_formats=True):
672
"""Open a bzrdir within a particular directory.
674
:param transport: Transport containing the bzrdir.
675
:param _unsupported: private.
677
base = transport.base
679
def find_format(transport):
680
return transport, BzrDirFormat.find_format(
681
transport, _server_formats=_server_formats)
683
def redirected(transport, e, redirection_notice):
684
qualified_source = e.get_source_url()
685
relpath = transport.relpath(qualified_source)
686
if not e.target.endswith(relpath):
687
# Not redirected to a branch-format, not a branch
688
raise errors.NotBranchError(path=e.target)
689
target = e.target[:-len(relpath)]
690
note('%s is%s redirected to %s',
691
transport.base, e.permanently, target)
692
# Let's try with a new transport
693
# FIXME: If 'transport' has a qualifier, this should
694
# be applied again to the new transport *iff* the
695
# schemes used are the same. Uncomment this code
696
# once the function (and tests) exist.
698
#target = urlutils.copy_url_qualifiers(original, target)
699
return get_transport(target)
702
transport, format = do_catching_redirections(find_format,
705
except errors.TooManyRedirections:
706
raise errors.NotBranchError(base)
708
BzrDir._check_supported(format, _unsupported)
709
return format.open(transport, _found=True)
711
def open_branch(self, unsupported=False):
712
"""Open the branch object at this BzrDir if one is present.
714
If unsupported is True, then no longer supported branch formats can
717
TODO: static convenience version of this?
719
raise NotImplementedError(self.open_branch)
722
def open_containing(url, possible_transports=None):
723
"""Open an existing branch which contains url.
725
:param url: url to search from.
726
See open_containing_from_transport for more detail.
728
transport = get_transport(url, possible_transports)
729
return BzrDir.open_containing_from_transport(transport)
732
def open_containing_from_transport(a_transport):
733
"""Open an existing branch which contains a_transport.base.
735
This probes for a branch at a_transport, and searches upwards from there.
737
Basically we keep looking up until we find the control directory or
738
run into the root. If there isn't one, raises NotBranchError.
739
If there is one and it is either an unrecognised format or an unsupported
740
format, UnknownFormatError or UnsupportedFormatError are raised.
741
If there is one, it is returned, along with the unused portion of url.
743
:return: The BzrDir that contains the path, and a Unicode path
744
for the rest of the URL.
746
# this gets the normalised url back. I.e. '.' -> the full path.
747
url = a_transport.base
750
result = BzrDir.open_from_transport(a_transport)
751
return result, urlutils.unescape(a_transport.relpath(url))
752
except errors.NotBranchError, e:
755
new_t = a_transport.clone('..')
756
except errors.InvalidURLJoin:
757
# reached the root, whatever that may be
758
raise errors.NotBranchError(path=url)
759
if new_t.base == a_transport.base:
760
# reached the root, whatever that may be
761
raise errors.NotBranchError(path=url)
764
def _get_tree_branch(self):
765
"""Return the branch and tree, if any, for this bzrdir.
767
Return None for tree if not present or inaccessible.
768
Raise NotBranchError if no branch is present.
769
:return: (tree, branch)
772
tree = self.open_workingtree()
773
except (errors.NoWorkingTree, errors.NotLocalUrl):
775
branch = self.open_branch()
781
def open_tree_or_branch(klass, location):
782
"""Return the branch and working tree at a location.
784
If there is no tree at the location, tree will be None.
785
If there is no branch at the location, an exception will be
787
:return: (tree, branch)
789
bzrdir = klass.open(location)
790
return bzrdir._get_tree_branch()
793
def open_containing_tree_or_branch(klass, location):
794
"""Return the branch and working tree contained by a location.
796
Returns (tree, branch, relpath).
797
If there is no tree at containing the location, tree will be None.
798
If there is no branch containing the location, an exception will be
800
relpath is the portion of the path that is contained by the branch.
802
bzrdir, relpath = klass.open_containing(location)
803
tree, branch = bzrdir._get_tree_branch()
804
return tree, branch, relpath
806
def open_repository(self, _unsupported=False):
807
"""Open the repository object at this BzrDir if one is present.
809
This will not follow the Branch object pointer - it's strictly a direct
810
open facility. Most client code should use open_branch().repository to
813
:param _unsupported: a private parameter, not part of the api.
814
TODO: static convenience version of this?
816
raise NotImplementedError(self.open_repository)
818
def open_workingtree(self, _unsupported=False,
819
recommend_upgrade=True, from_branch=None):
820
"""Open the workingtree object at this BzrDir if one is present.
822
:param recommend_upgrade: Optional keyword parameter, when True (the
823
default), emit through the ui module a recommendation that the user
824
upgrade the working tree when the workingtree being opened is old
825
(but still fully supported).
826
:param from_branch: override bzrdir branch (for lightweight checkouts)
828
raise NotImplementedError(self.open_workingtree)
830
def has_branch(self):
831
"""Tell if this bzrdir contains a branch.
833
Note: if you're going to open the branch, you should just go ahead
834
and try, and not ask permission first. (This method just opens the
835
branch and discards it, and that's somewhat expensive.)
840
except errors.NotBranchError:
843
def has_workingtree(self):
844
"""Tell if this bzrdir contains a working tree.
846
This will still raise an exception if the bzrdir has a workingtree that
847
is remote & inaccessible.
849
Note: if you're going to open the working tree, you should just go ahead
850
and try, and not ask permission first. (This method just opens the
851
workingtree and discards it, and that's somewhat expensive.)
854
self.open_workingtree(recommend_upgrade=False)
856
except errors.NoWorkingTree:
859
def _cloning_metadir(self):
860
"""Produce a metadir suitable for cloning with."""
861
result_format = self._format.__class__()
864
branch = self.open_branch()
865
source_repository = branch.repository
866
except errors.NotBranchError:
868
source_repository = self.open_repository()
869
except errors.NoRepositoryPresent:
870
source_repository = None
872
# XXX TODO: This isinstance is here because we have not implemented
873
# the fix recommended in bug # 103195 - to delegate this choice the
875
repo_format = source_repository._format
876
if not isinstance(repo_format, remote.RemoteRepositoryFormat):
877
result_format.repository_format = repo_format
879
# TODO: Couldn't we just probe for the format in these cases,
880
# rather than opening the whole tree? It would be a little
881
# faster. mbp 20070401
882
tree = self.open_workingtree(recommend_upgrade=False)
883
except (errors.NoWorkingTree, errors.NotLocalUrl):
884
result_format.workingtree_format = None
886
result_format.workingtree_format = tree._format.__class__()
887
return result_format, source_repository
889
def cloning_metadir(self):
890
"""Produce a metadir suitable for cloning or sprouting with.
892
These operations may produce workingtrees (yes, even though they're
893
"cloning" something that doesn't have a tree), so a viable workingtree
894
format must be selected.
896
format, repository = self._cloning_metadir()
897
if format._workingtree_format is None:
898
if repository is None:
900
tree_format = repository._format._matchingbzrdir.workingtree_format
901
format.workingtree_format = tree_format.__class__()
904
def checkout_metadir(self):
905
return self.cloning_metadir()
907
def sprout(self, url, revision_id=None, force_new_repo=False,
908
recurse='down', possible_transports=None,
909
accelerator_tree=None, hardlink=False):
910
"""Create a copy of this bzrdir prepared for use as a new line of
913
If url's last component does not exist, it will be created.
915
Attributes related to the identity of the source branch like
916
branch nickname will be cleaned, a working tree is created
917
whether one existed before or not; and a local branch is always
920
if revision_id is not None, then the clone operation may tune
921
itself to download less data.
922
:param accelerator_tree: A tree which can be used for retrieving file
923
contents more quickly than the revision tree, i.e. a workingtree.
924
The revision tree will be used for cases where accelerator_tree's
925
content is different.
926
:param hardlink: If true, hard-link files from accelerator_tree,
929
target_transport = get_transport(url, possible_transports)
930
target_transport.ensure_base()
931
cloning_format = self.cloning_metadir()
932
result = cloning_format.initialize_on_transport(target_transport)
934
source_branch = self.open_branch()
935
source_repository = source_branch.repository
936
except errors.NotBranchError:
939
source_repository = self.open_repository()
940
except errors.NoRepositoryPresent:
941
source_repository = None
946
result_repo = result.find_repository()
947
except errors.NoRepositoryPresent:
949
if source_repository is None and result_repo is not None:
951
elif source_repository is None and result_repo is None:
952
# no repo available, make a new one
953
result.create_repository()
954
elif source_repository is not None and result_repo is None:
955
# have source, and want to make a new target repo
956
result_repo = source_repository.sprout(result,
957
revision_id=revision_id)
959
# fetch needed content into target.
960
if source_repository is not None:
962
# source_repository.copy_content_into(result_repo,
963
# revision_id=revision_id)
964
# so we can override the copy method
965
result_repo.fetch(source_repository, revision_id=revision_id)
966
if source_branch is not None:
967
source_branch.sprout(result, revision_id=revision_id)
969
result.create_branch()
970
if isinstance(target_transport, LocalTransport) and (
971
result_repo is None or result_repo.make_working_trees()):
972
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
976
if wt.path2id('') is None:
978
wt.set_root_id(self.open_workingtree.get_root_id())
979
except errors.NoWorkingTree:
985
if recurse == 'down':
987
basis = wt.basis_tree()
989
subtrees = basis.iter_references()
990
recurse_branch = wt.branch
991
elif source_branch is not None:
992
basis = source_branch.basis_tree()
994
subtrees = basis.iter_references()
995
recurse_branch = source_branch
1000
for path, file_id in subtrees:
1001
target = urlutils.join(url, urlutils.escape(path))
1002
sublocation = source_branch.reference_parent(file_id, path)
1003
sublocation.bzrdir.sprout(target,
1004
basis.get_reference_revision(file_id, path),
1005
force_new_repo=force_new_repo, recurse=recurse)
1007
if basis is not None:
1012
class BzrDirPreSplitOut(BzrDir):
1013
"""A common class for the all-in-one formats."""
1015
def __init__(self, _transport, _format):
1016
"""See BzrDir.__init__."""
1017
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1018
self._control_files = lockable_files.LockableFiles(
1019
self.get_branch_transport(None),
1020
self._format._lock_file_name,
1021
self._format._lock_class)
1023
def break_lock(self):
1024
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1025
raise NotImplementedError(self.break_lock)
1027
def cloning_metadir(self):
1028
"""Produce a metadir suitable for cloning with."""
1029
return self._format.__class__()
1031
def clone(self, url, revision_id=None, force_new_repo=False):
1032
"""See BzrDir.clone()."""
1033
from bzrlib.workingtree import WorkingTreeFormat2
1034
self._make_tail(url)
1035
result = self._format._initialize_for_clone(url)
1036
self.open_repository().clone(result, revision_id=revision_id)
1037
from_branch = self.open_branch()
1038
from_branch.clone(result, revision_id=revision_id)
1040
self.open_workingtree().clone(result)
1041
except errors.NotLocalUrl:
1042
# make a new one, this format always has to have one.
1044
WorkingTreeFormat2().initialize(result)
1045
except errors.NotLocalUrl:
1046
# but we cannot do it for remote trees.
1047
to_branch = result.open_branch()
1048
WorkingTreeFormat2().stub_initialize_remote(to_branch.control_files)
1051
def create_branch(self):
1052
"""See BzrDir.create_branch."""
1053
return self.open_branch()
1055
def destroy_branch(self):
1056
"""See BzrDir.destroy_branch."""
1057
raise errors.UnsupportedOperation(self.destroy_branch, self)
1059
def create_repository(self, shared=False):
1060
"""See BzrDir.create_repository."""
1062
raise errors.IncompatibleFormat('shared repository', self._format)
1063
return self.open_repository()
1065
def destroy_repository(self):
1066
"""See BzrDir.destroy_repository."""
1067
raise errors.UnsupportedOperation(self.destroy_repository, self)
1069
def create_workingtree(self, revision_id=None, from_branch=None,
1070
accelerator_tree=None, hardlink=False):
1071
"""See BzrDir.create_workingtree."""
1072
# this looks buggy but is not -really-
1073
# because this format creates the workingtree when the bzrdir is
1075
# clone and sprout will have set the revision_id
1076
# and that will have set it for us, its only
1077
# specific uses of create_workingtree in isolation
1078
# that can do wonky stuff here, and that only
1079
# happens for creating checkouts, which cannot be
1080
# done on this format anyway. So - acceptable wart.
1081
result = self.open_workingtree(recommend_upgrade=False)
1082
if revision_id is not None:
1083
if revision_id == _mod_revision.NULL_REVISION:
1084
result.set_parent_ids([])
1086
result.set_parent_ids([revision_id])
1089
def destroy_workingtree(self):
1090
"""See BzrDir.destroy_workingtree."""
1091
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1093
def destroy_workingtree_metadata(self):
1094
"""See BzrDir.destroy_workingtree_metadata."""
1095
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1098
def get_branch_transport(self, branch_format):
1099
"""See BzrDir.get_branch_transport()."""
1100
if branch_format is None:
1101
return self.transport
1103
branch_format.get_format_string()
1104
except NotImplementedError:
1105
return self.transport
1106
raise errors.IncompatibleFormat(branch_format, self._format)
1108
def get_repository_transport(self, repository_format):
1109
"""See BzrDir.get_repository_transport()."""
1110
if repository_format is None:
1111
return self.transport
1113
repository_format.get_format_string()
1114
except NotImplementedError:
1115
return self.transport
1116
raise errors.IncompatibleFormat(repository_format, self._format)
1118
def get_workingtree_transport(self, workingtree_format):
1119
"""See BzrDir.get_workingtree_transport()."""
1120
if workingtree_format is None:
1121
return self.transport
1123
workingtree_format.get_format_string()
1124
except NotImplementedError:
1125
return self.transport
1126
raise errors.IncompatibleFormat(workingtree_format, self._format)
1128
def needs_format_conversion(self, format=None):
1129
"""See BzrDir.needs_format_conversion()."""
1130
# if the format is not the same as the system default,
1131
# an upgrade is needed.
1133
format = BzrDirFormat.get_default_format()
1134
return not isinstance(self._format, format.__class__)
1136
def open_branch(self, unsupported=False):
1137
"""See BzrDir.open_branch."""
1138
from bzrlib.branch import BzrBranchFormat4
1139
format = BzrBranchFormat4()
1140
self._check_supported(format, unsupported)
1141
return format.open(self, _found=True)
1143
def sprout(self, url, revision_id=None, force_new_repo=False,
1144
possible_transports=None, accelerator_tree=None,
1146
"""See BzrDir.sprout()."""
1147
from bzrlib.workingtree import WorkingTreeFormat2
1148
self._make_tail(url)
1149
result = self._format._initialize_for_clone(url)
1151
self.open_repository().clone(result, revision_id=revision_id)
1152
except errors.NoRepositoryPresent:
1155
self.open_branch().sprout(result, revision_id=revision_id)
1156
except errors.NotBranchError:
1158
# we always want a working tree
1159
WorkingTreeFormat2().initialize(result,
1160
accelerator_tree=accelerator_tree,
1165
class BzrDir4(BzrDirPreSplitOut):
1166
"""A .bzr version 4 control object.
1168
This is a deprecated format and may be removed after sept 2006.
1171
def create_repository(self, shared=False):
1172
"""See BzrDir.create_repository."""
1173
return self._format.repository_format.initialize(self, shared)
1175
def needs_format_conversion(self, format=None):
1176
"""Format 4 dirs are always in need of conversion."""
1179
def open_repository(self):
1180
"""See BzrDir.open_repository."""
1181
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1182
return RepositoryFormat4().open(self, _found=True)
1185
class BzrDir5(BzrDirPreSplitOut):
1186
"""A .bzr version 5 control object.
1188
This is a deprecated format and may be removed after sept 2006.
1191
def open_repository(self):
1192
"""See BzrDir.open_repository."""
1193
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1194
return RepositoryFormat5().open(self, _found=True)
1196
def open_workingtree(self, _unsupported=False,
1197
recommend_upgrade=True):
1198
"""See BzrDir.create_workingtree."""
1199
from bzrlib.workingtree import WorkingTreeFormat2
1200
wt_format = WorkingTreeFormat2()
1201
# we don't warn here about upgrades; that ought to be handled for the
1203
return wt_format.open(self, _found=True)
1206
class BzrDir6(BzrDirPreSplitOut):
1207
"""A .bzr version 6 control object.
1209
This is a deprecated format and may be removed after sept 2006.
1212
def open_repository(self):
1213
"""See BzrDir.open_repository."""
1214
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1215
return RepositoryFormat6().open(self, _found=True)
1217
def open_workingtree(self, _unsupported=False,
1218
recommend_upgrade=True):
1219
"""See BzrDir.create_workingtree."""
1220
# we don't warn here about upgrades; that ought to be handled for the
1222
from bzrlib.workingtree import WorkingTreeFormat2
1223
return WorkingTreeFormat2().open(self, _found=True)
1226
class BzrDirMeta1(BzrDir):
1227
"""A .bzr meta version 1 control object.
1229
This is the first control object where the
1230
individual aspects are really split out: there are separate repository,
1231
workingtree and branch subdirectories and any subset of the three can be
1232
present within a BzrDir.
1235
def can_convert_format(self):
1236
"""See BzrDir.can_convert_format()."""
1239
def create_branch(self):
1240
"""See BzrDir.create_branch."""
1241
return self._format.get_branch_format().initialize(self)
1243
def destroy_branch(self):
1244
"""See BzrDir.create_branch."""
1245
self.transport.delete_tree('branch')
1247
def create_repository(self, shared=False):
1248
"""See BzrDir.create_repository."""
1249
return self._format.repository_format.initialize(self, shared)
1251
def destroy_repository(self):
1252
"""See BzrDir.destroy_repository."""
1253
self.transport.delete_tree('repository')
1255
def create_workingtree(self, revision_id=None, from_branch=None,
1256
accelerator_tree=None, hardlink=False):
1257
"""See BzrDir.create_workingtree."""
1258
return self._format.workingtree_format.initialize(
1259
self, revision_id, from_branch=from_branch,
1260
accelerator_tree=accelerator_tree, hardlink=hardlink)
1262
def destroy_workingtree(self):
1263
"""See BzrDir.destroy_workingtree."""
1264
wt = self.open_workingtree(recommend_upgrade=False)
1265
repository = wt.branch.repository
1266
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1267
wt.revert(old_tree=empty)
1268
self.destroy_workingtree_metadata()
1270
def destroy_workingtree_metadata(self):
1271
self.transport.delete_tree('checkout')
1273
def find_branch_format(self):
1274
"""Find the branch 'format' for this bzrdir.
1276
This might be a synthetic object for e.g. RemoteBranch and SVN.
1278
from bzrlib.branch import BranchFormat
1279
return BranchFormat.find_format(self)
1281
def _get_mkdir_mode(self):
1282
"""Figure out the mode to use when creating a bzrdir subdir."""
1283
temp_control = lockable_files.LockableFiles(self.transport, '',
1284
lockable_files.TransportLock)
1285
return temp_control._dir_mode
1287
def get_branch_reference(self):
1288
"""See BzrDir.get_branch_reference()."""
1289
from bzrlib.branch import BranchFormat
1290
format = BranchFormat.find_format(self)
1291
return format.get_reference(self)
1293
def get_branch_transport(self, branch_format):
1294
"""See BzrDir.get_branch_transport()."""
1295
if branch_format is None:
1296
return self.transport.clone('branch')
1298
branch_format.get_format_string()
1299
except NotImplementedError:
1300
raise errors.IncompatibleFormat(branch_format, self._format)
1302
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1303
except errors.FileExists:
1305
return self.transport.clone('branch')
1307
def get_repository_transport(self, repository_format):
1308
"""See BzrDir.get_repository_transport()."""
1309
if repository_format is None:
1310
return self.transport.clone('repository')
1312
repository_format.get_format_string()
1313
except NotImplementedError:
1314
raise errors.IncompatibleFormat(repository_format, self._format)
1316
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1317
except errors.FileExists:
1319
return self.transport.clone('repository')
1321
def get_workingtree_transport(self, workingtree_format):
1322
"""See BzrDir.get_workingtree_transport()."""
1323
if workingtree_format is None:
1324
return self.transport.clone('checkout')
1326
workingtree_format.get_format_string()
1327
except NotImplementedError:
1328
raise errors.IncompatibleFormat(workingtree_format, self._format)
1330
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1331
except errors.FileExists:
1333
return self.transport.clone('checkout')
1335
def needs_format_conversion(self, format=None):
1336
"""See BzrDir.needs_format_conversion()."""
1338
format = BzrDirFormat.get_default_format()
1339
if not isinstance(self._format, format.__class__):
1340
# it is not a meta dir format, conversion is needed.
1342
# we might want to push this down to the repository?
1344
if not isinstance(self.open_repository()._format,
1345
format.repository_format.__class__):
1346
# the repository needs an upgrade.
1348
except errors.NoRepositoryPresent:
1351
if not isinstance(self.open_branch()._format,
1352
format.get_branch_format().__class__):
1353
# the branch needs an upgrade.
1355
except errors.NotBranchError:
1358
my_wt = self.open_workingtree(recommend_upgrade=False)
1359
if not isinstance(my_wt._format,
1360
format.workingtree_format.__class__):
1361
# the workingtree needs an upgrade.
1363
except (errors.NoWorkingTree, errors.NotLocalUrl):
1367
def open_branch(self, unsupported=False):
1368
"""See BzrDir.open_branch."""
1369
format = self.find_branch_format()
1370
self._check_supported(format, unsupported)
1371
return format.open(self, _found=True)
1373
def open_repository(self, unsupported=False):
1374
"""See BzrDir.open_repository."""
1375
from bzrlib.repository import RepositoryFormat
1376
format = RepositoryFormat.find_format(self)
1377
self._check_supported(format, unsupported)
1378
return format.open(self, _found=True)
1380
def open_workingtree(self, unsupported=False,
1381
recommend_upgrade=True):
1382
"""See BzrDir.open_workingtree."""
1383
from bzrlib.workingtree import WorkingTreeFormat
1384
format = WorkingTreeFormat.find_format(self)
1385
self._check_supported(format, unsupported,
1387
basedir=self.root_transport.base)
1388
return format.open(self, _found=True)
1391
class BzrDirFormat(object):
1392
"""An encapsulation of the initialization and open routines for a format.
1394
Formats provide three things:
1395
* An initialization routine,
1399
Formats are placed in a dict by their format string for reference
1400
during bzrdir opening. These should be subclasses of BzrDirFormat
1403
Once a format is deprecated, just deprecate the initialize and open
1404
methods on the format class. Do not deprecate the object, as the
1405
object will be created every system load.
1408
_default_format = None
1409
"""The default format used for new .bzr dirs."""
1412
"""The known formats."""
1414
_control_formats = []
1415
"""The registered control formats - .bzr, ....
1417
This is a list of BzrDirFormat objects.
1420
_control_server_formats = []
1421
"""The registered control server formats, e.g. RemoteBzrDirs.
1423
This is a list of BzrDirFormat objects.
1426
_lock_file_name = 'branch-lock'
1428
# _lock_class must be set in subclasses to the lock type, typ.
1429
# TransportLock or LockDir
1432
def find_format(klass, transport, _server_formats=True):
1433
"""Return the format present at transport."""
1435
formats = klass._control_server_formats + klass._control_formats
1437
formats = klass._control_formats
1438
for format in formats:
1440
return format.probe_transport(transport)
1441
except errors.NotBranchError:
1442
# this format does not find a control dir here.
1444
raise errors.NotBranchError(path=transport.base)
1447
def probe_transport(klass, transport):
1448
"""Return the .bzrdir style format present in a directory."""
1450
format_string = transport.get(".bzr/branch-format").read()
1451
except errors.NoSuchFile:
1452
raise errors.NotBranchError(path=transport.base)
1455
return klass._formats[format_string]
1457
raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1460
def get_default_format(klass):
1461
"""Return the current default format."""
1462
return klass._default_format
1464
def get_format_string(self):
1465
"""Return the ASCII format string that identifies this format."""
1466
raise NotImplementedError(self.get_format_string)
1468
def get_format_description(self):
1469
"""Return the short description for this format."""
1470
raise NotImplementedError(self.get_format_description)
1472
def get_converter(self, format=None):
1473
"""Return the converter to use to convert bzrdirs needing converts.
1475
This returns a bzrlib.bzrdir.Converter object.
1477
This should return the best upgrader to step this format towards the
1478
current default format. In the case of plugins we can/should provide
1479
some means for them to extend the range of returnable converters.
1481
:param format: Optional format to override the default format of the
1484
raise NotImplementedError(self.get_converter)
1486
def initialize(self, url, possible_transports=None):
1487
"""Create a bzr control dir at this url and return an opened copy.
1489
Subclasses should typically override initialize_on_transport
1490
instead of this method.
1492
return self.initialize_on_transport(get_transport(url,
1493
possible_transports))
1495
def initialize_on_transport(self, transport):
1496
"""Initialize a new bzrdir in the base directory of a Transport."""
1497
# Since we don't have a .bzr directory, inherit the
1498
# mode from the root directory
1499
temp_control = lockable_files.LockableFiles(transport,
1500
'', lockable_files.TransportLock)
1501
temp_control._transport.mkdir('.bzr',
1502
# FIXME: RBC 20060121 don't peek under
1504
mode=temp_control._dir_mode)
1505
if sys.platform == 'win32' and isinstance(transport, LocalTransport):
1506
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1507
file_mode = temp_control._file_mode
1509
mutter('created control directory in ' + transport.base)
1510
control = transport.clone('.bzr')
1511
utf8_files = [('README',
1512
"This is a Bazaar control directory.\n"
1513
"Do not change any files in this directory.\n"
1514
"See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
1515
('branch-format', self.get_format_string()),
1517
# NB: no need to escape relative paths that are url safe.
1518
control_files = lockable_files.LockableFiles(control,
1519
self._lock_file_name, self._lock_class)
1520
control_files.create_lock()
1521
control_files.lock_write()
1523
for file, content in utf8_files:
1524
control_files.put_utf8(file, content)
1526
control_files.unlock()
1527
return self.open(transport, _found=True)
1529
def is_supported(self):
1530
"""Is this format supported?
1532
Supported formats must be initializable and openable.
1533
Unsupported formats may not support initialization or committing or
1534
some other features depending on the reason for not being supported.
1538
def same_model(self, target_format):
1539
return (self.repository_format.rich_root_data ==
1540
target_format.rich_root_data)
1543
def known_formats(klass):
1544
"""Return all the known formats.
1546
Concrete formats should override _known_formats.
1548
# There is double indirection here to make sure that control
1549
# formats used by more than one dir format will only be probed
1550
# once. This can otherwise be quite expensive for remote connections.
1552
for format in klass._control_formats:
1553
result.update(format._known_formats())
1557
def _known_formats(klass):
1558
"""Return the known format instances for this control format."""
1559
return set(klass._formats.values())
1561
def open(self, transport, _found=False):
1562
"""Return an instance of this format for the dir transport points at.
1564
_found is a private parameter, do not use it.
1567
found_format = BzrDirFormat.find_format(transport)
1568
if not isinstance(found_format, self.__class__):
1569
raise AssertionError("%s was asked to open %s, but it seems to need "
1571
% (self, transport, found_format))
1572
return self._open(transport)
1574
def _open(self, transport):
1575
"""Template method helper for opening BzrDirectories.
1577
This performs the actual open and any additional logic or parameter
1580
raise NotImplementedError(self._open)
1583
def register_format(klass, format):
1584
klass._formats[format.get_format_string()] = format
1587
def register_control_format(klass, format):
1588
"""Register a format that does not use '.bzr' for its control dir.
1590
TODO: This should be pulled up into a 'ControlDirFormat' base class
1591
which BzrDirFormat can inherit from, and renamed to register_format
1592
there. It has been done without that for now for simplicity of
1595
klass._control_formats.append(format)
1598
def register_control_server_format(klass, format):
1599
"""Register a control format for client-server environments.
1601
These formats will be tried before ones registered with
1602
register_control_format. This gives implementations that decide to the
1603
chance to grab it before anything looks at the contents of the format
1606
klass._control_server_formats.append(format)
1609
def _set_default_format(klass, format):
1610
"""Set default format (for testing behavior of defaults only)"""
1611
klass._default_format = format
1615
return self.get_format_string().rstrip()
1618
def unregister_format(klass, format):
1619
del klass._formats[format.get_format_string()]
1622
def unregister_control_format(klass, format):
1623
klass._control_formats.remove(format)
1626
class BzrDirFormat4(BzrDirFormat):
1627
"""Bzr dir format 4.
1629
This format is a combined format for working tree, branch and repository.
1631
- Format 1 working trees [always]
1632
- Format 4 branches [always]
1633
- Format 4 repositories [always]
1635
This format is deprecated: it indexes texts using a text it which is
1636
removed in format 5; write support for this format has been removed.
1639
_lock_class = lockable_files.TransportLock
1641
def get_format_string(self):
1642
"""See BzrDirFormat.get_format_string()."""
1643
return "Bazaar-NG branch, format 0.0.4\n"
1645
def get_format_description(self):
1646
"""See BzrDirFormat.get_format_description()."""
1647
return "All-in-one format 4"
1649
def get_converter(self, format=None):
1650
"""See BzrDirFormat.get_converter()."""
1651
# there is one and only one upgrade path here.
1652
return ConvertBzrDir4To5()
1654
def initialize_on_transport(self, transport):
1655
"""Format 4 branches cannot be created."""
1656
raise errors.UninitializableFormat(self)
1658
def is_supported(self):
1659
"""Format 4 is not supported.
1661
It is not supported because the model changed from 4 to 5 and the
1662
conversion logic is expensive - so doing it on the fly was not
1667
def _open(self, transport):
1668
"""See BzrDirFormat._open."""
1669
return BzrDir4(transport, self)
1671
def __return_repository_format(self):
1672
"""Circular import protection."""
1673
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1674
return RepositoryFormat4()
1675
repository_format = property(__return_repository_format)
1678
class BzrDirFormat5(BzrDirFormat):
1679
"""Bzr control format 5.
1681
This format is a combined format for working tree, branch and repository.
1683
- Format 2 working trees [always]
1684
- Format 4 branches [always]
1685
- Format 5 repositories [always]
1686
Unhashed stores in the repository.
1689
_lock_class = lockable_files.TransportLock
1691
def get_format_string(self):
1692
"""See BzrDirFormat.get_format_string()."""
1693
return "Bazaar-NG branch, format 5\n"
1695
def get_format_description(self):
1696
"""See BzrDirFormat.get_format_description()."""
1697
return "All-in-one format 5"
1699
def get_converter(self, format=None):
1700
"""See BzrDirFormat.get_converter()."""
1701
# there is one and only one upgrade path here.
1702
return ConvertBzrDir5To6()
1704
def _initialize_for_clone(self, url):
1705
return self.initialize_on_transport(get_transport(url), _cloning=True)
1707
def initialize_on_transport(self, transport, _cloning=False):
1708
"""Format 5 dirs always have working tree, branch and repository.
1710
Except when they are being cloned.
1712
from bzrlib.branch import BzrBranchFormat4
1713
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1714
from bzrlib.workingtree import WorkingTreeFormat2
1715
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1716
RepositoryFormat5().initialize(result, _internal=True)
1718
branch = BzrBranchFormat4().initialize(result)
1720
WorkingTreeFormat2().initialize(result)
1721
except errors.NotLocalUrl:
1722
# Even though we can't access the working tree, we need to
1723
# create its control files.
1724
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1727
def _open(self, transport):
1728
"""See BzrDirFormat._open."""
1729
return BzrDir5(transport, self)
1731
def __return_repository_format(self):
1732
"""Circular import protection."""
1733
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1734
return RepositoryFormat5()
1735
repository_format = property(__return_repository_format)
1738
class BzrDirFormat6(BzrDirFormat):
1739
"""Bzr control format 6.
1741
This format is a combined format for working tree, branch and repository.
1743
- Format 2 working trees [always]
1744
- Format 4 branches [always]
1745
- Format 6 repositories [always]
1748
_lock_class = lockable_files.TransportLock
1750
def get_format_string(self):
1751
"""See BzrDirFormat.get_format_string()."""
1752
return "Bazaar-NG branch, format 6\n"
1754
def get_format_description(self):
1755
"""See BzrDirFormat.get_format_description()."""
1756
return "All-in-one format 6"
1758
def get_converter(self, format=None):
1759
"""See BzrDirFormat.get_converter()."""
1760
# there is one and only one upgrade path here.
1761
return ConvertBzrDir6ToMeta()
1763
def _initialize_for_clone(self, url):
1764
return self.initialize_on_transport(get_transport(url), _cloning=True)
1766
def initialize_on_transport(self, transport, _cloning=False):
1767
"""Format 6 dirs always have working tree, branch and repository.
1769
Except when they are being cloned.
1771
from bzrlib.branch import BzrBranchFormat4
1772
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1773
from bzrlib.workingtree import WorkingTreeFormat2
1774
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1775
RepositoryFormat6().initialize(result, _internal=True)
1777
branch = BzrBranchFormat4().initialize(result)
1779
WorkingTreeFormat2().initialize(result)
1780
except errors.NotLocalUrl:
1781
# Even though we can't access the working tree, we need to
1782
# create its control files.
1783
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1786
def _open(self, transport):
1787
"""See BzrDirFormat._open."""
1788
return BzrDir6(transport, self)
1790
def __return_repository_format(self):
1791
"""Circular import protection."""
1792
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1793
return RepositoryFormat6()
1794
repository_format = property(__return_repository_format)
1797
class BzrDirMetaFormat1(BzrDirFormat):
1798
"""Bzr meta control format 1
1800
This is the first format with split out working tree, branch and repository
1803
- Format 3 working trees [optional]
1804
- Format 5 branches [optional]
1805
- Format 7 repositories [optional]
1808
_lock_class = lockdir.LockDir
1811
self._workingtree_format = None
1812
self._branch_format = None
1814
def __eq__(self, other):
1815
if other.__class__ is not self.__class__:
1817
if other.repository_format != self.repository_format:
1819
if other.workingtree_format != self.workingtree_format:
1823
def __ne__(self, other):
1824
return not self == other
1826
def get_branch_format(self):
1827
if self._branch_format is None:
1828
from bzrlib.branch import BranchFormat
1829
self._branch_format = BranchFormat.get_default_format()
1830
return self._branch_format
1832
def set_branch_format(self, format):
1833
self._branch_format = format
1835
def get_converter(self, format=None):
1836
"""See BzrDirFormat.get_converter()."""
1838
format = BzrDirFormat.get_default_format()
1839
if not isinstance(self, format.__class__):
1840
# converting away from metadir is not implemented
1841
raise NotImplementedError(self.get_converter)
1842
return ConvertMetaToMeta(format)
1844
def get_format_string(self):
1845
"""See BzrDirFormat.get_format_string()."""
1846
return "Bazaar-NG meta directory, format 1\n"
1848
def get_format_description(self):
1849
"""See BzrDirFormat.get_format_description()."""
1850
return "Meta directory format 1"
1852
def _open(self, transport):
1853
"""See BzrDirFormat._open."""
1854
return BzrDirMeta1(transport, self)
1856
def __return_repository_format(self):
1857
"""Circular import protection."""
1858
if getattr(self, '_repository_format', None):
1859
return self._repository_format
1860
from bzrlib.repository import RepositoryFormat
1861
return RepositoryFormat.get_default_format()
1863
def __set_repository_format(self, value):
1864
"""Allow changing the repository format for metadir formats."""
1865
self._repository_format = value
1867
repository_format = property(__return_repository_format, __set_repository_format)
1869
def __get_workingtree_format(self):
1870
if self._workingtree_format is None:
1871
from bzrlib.workingtree import WorkingTreeFormat
1872
self._workingtree_format = WorkingTreeFormat.get_default_format()
1873
return self._workingtree_format
1875
def __set_workingtree_format(self, wt_format):
1876
self._workingtree_format = wt_format
1878
workingtree_format = property(__get_workingtree_format,
1879
__set_workingtree_format)
1882
# Register bzr control format
1883
BzrDirFormat.register_control_format(BzrDirFormat)
1885
# Register bzr formats
1886
BzrDirFormat.register_format(BzrDirFormat4())
1887
BzrDirFormat.register_format(BzrDirFormat5())
1888
BzrDirFormat.register_format(BzrDirFormat6())
1889
__default_format = BzrDirMetaFormat1()
1890
BzrDirFormat.register_format(__default_format)
1891
BzrDirFormat._default_format = __default_format
1894
class Converter(object):
1895
"""Converts a disk format object from one format to another."""
1897
def convert(self, to_convert, pb):
1898
"""Perform the conversion of to_convert, giving feedback via pb.
1900
:param to_convert: The disk object to convert.
1901
:param pb: a progress bar to use for progress information.
1904
def step(self, message):
1905
"""Update the pb by a step."""
1907
self.pb.update(message, self.count, self.total)
1910
class ConvertBzrDir4To5(Converter):
1911
"""Converts format 4 bzr dirs to format 5."""
1914
super(ConvertBzrDir4To5, self).__init__()
1915
self.converted_revs = set()
1916
self.absent_revisions = set()
1920
def convert(self, to_convert, pb):
1921
"""See Converter.convert()."""
1922
self.bzrdir = to_convert
1924
self.pb.note('starting upgrade from format 4 to 5')
1925
if isinstance(self.bzrdir.transport, LocalTransport):
1926
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
1927
self._convert_to_weaves()
1928
return BzrDir.open(self.bzrdir.root_transport.base)
1930
def _convert_to_weaves(self):
1931
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
1934
stat = self.bzrdir.transport.stat('weaves')
1935
if not S_ISDIR(stat.st_mode):
1936
self.bzrdir.transport.delete('weaves')
1937
self.bzrdir.transport.mkdir('weaves')
1938
except errors.NoSuchFile:
1939
self.bzrdir.transport.mkdir('weaves')
1940
# deliberately not a WeaveFile as we want to build it up slowly.
1941
self.inv_weave = Weave('inventory')
1942
# holds in-memory weaves for all files
1943
self.text_weaves = {}
1944
self.bzrdir.transport.delete('branch-format')
1945
self.branch = self.bzrdir.open_branch()
1946
self._convert_working_inv()
1947
rev_history = self.branch.revision_history()
1948
# to_read is a stack holding the revisions we still need to process;
1949
# appending to it adds new highest-priority revisions
1950
self.known_revisions = set(rev_history)
1951
self.to_read = rev_history[-1:]
1953
rev_id = self.to_read.pop()
1954
if (rev_id not in self.revisions
1955
and rev_id not in self.absent_revisions):
1956
self._load_one_rev(rev_id)
1958
to_import = self._make_order()
1959
for i, rev_id in enumerate(to_import):
1960
self.pb.update('converting revision', i, len(to_import))
1961
self._convert_one_rev(rev_id)
1963
self._write_all_weaves()
1964
self._write_all_revs()
1965
self.pb.note('upgraded to weaves:')
1966
self.pb.note(' %6d revisions and inventories', len(self.revisions))
1967
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
1968
self.pb.note(' %6d texts', self.text_count)
1969
self._cleanup_spare_files_after_format4()
1970
self.branch.control_files.put_utf8('branch-format', BzrDirFormat5().get_format_string())
1972
def _cleanup_spare_files_after_format4(self):
1973
# FIXME working tree upgrade foo.
1974
for n in 'merged-patches', 'pending-merged-patches':
1976
## assert os.path.getsize(p) == 0
1977
self.bzrdir.transport.delete(n)
1978
except errors.NoSuchFile:
1980
self.bzrdir.transport.delete_tree('inventory-store')
1981
self.bzrdir.transport.delete_tree('text-store')
1983
def _convert_working_inv(self):
1984
inv = xml4.serializer_v4.read_inventory(
1985
self.branch.control_files.get('inventory'))
1986
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
1987
# FIXME inventory is a working tree change.
1988
self.branch.control_files.put('inventory', StringIO(new_inv_xml))
1990
def _write_all_weaves(self):
1991
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
1992
weave_transport = self.bzrdir.transport.clone('weaves')
1993
weaves = WeaveStore(weave_transport, prefixed=False)
1994
transaction = WriteTransaction()
1998
for file_id, file_weave in self.text_weaves.items():
1999
self.pb.update('writing weave', i, len(self.text_weaves))
2000
weaves._put_weave(file_id, file_weave, transaction)
2002
self.pb.update('inventory', 0, 1)
2003
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2004
self.pb.update('inventory', 1, 1)
2008
def _write_all_revs(self):
2009
"""Write all revisions out in new form."""
2010
self.bzrdir.transport.delete_tree('revision-store')
2011
self.bzrdir.transport.mkdir('revision-store')
2012
revision_transport = self.bzrdir.transport.clone('revision-store')
2014
_revision_store = TextRevisionStore(TextStore(revision_transport,
2018
transaction = WriteTransaction()
2019
for i, rev_id in enumerate(self.converted_revs):
2020
self.pb.update('write revision', i, len(self.converted_revs))
2021
_revision_store.add_revision(self.revisions[rev_id], transaction)
2025
def _load_one_rev(self, rev_id):
2026
"""Load a revision object into memory.
2028
Any parents not either loaded or abandoned get queued to be
2030
self.pb.update('loading revision',
2031
len(self.revisions),
2032
len(self.known_revisions))
2033
if not self.branch.repository.has_revision(rev_id):
2035
self.pb.note('revision {%s} not present in branch; '
2036
'will be converted as a ghost',
2038
self.absent_revisions.add(rev_id)
2040
rev = self.branch.repository._revision_store.get_revision(rev_id,
2041
self.branch.repository.get_transaction())
2042
for parent_id in rev.parent_ids:
2043
self.known_revisions.add(parent_id)
2044
self.to_read.append(parent_id)
2045
self.revisions[rev_id] = rev
2047
def _load_old_inventory(self, rev_id):
2048
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2049
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2050
inv.revision_id = rev_id
2051
rev = self.revisions[rev_id]
2054
def _load_updated_inventory(self, rev_id):
2055
inv_xml = self.inv_weave.get_text(rev_id)
2056
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2059
def _convert_one_rev(self, rev_id):
2060
"""Convert revision and all referenced objects to new format."""
2061
rev = self.revisions[rev_id]
2062
inv = self._load_old_inventory(rev_id)
2063
present_parents = [p for p in rev.parent_ids
2064
if p not in self.absent_revisions]
2065
self._convert_revision_contents(rev, inv, present_parents)
2066
self._store_new_inv(rev, inv, present_parents)
2067
self.converted_revs.add(rev_id)
2069
def _store_new_inv(self, rev, inv, present_parents):
2070
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2071
new_inv_sha1 = sha_string(new_inv_xml)
2072
self.inv_weave.add_lines(rev.revision_id,
2074
new_inv_xml.splitlines(True))
2075
rev.inventory_sha1 = new_inv_sha1
2077
def _convert_revision_contents(self, rev, inv, present_parents):
2078
"""Convert all the files within a revision.
2080
Also upgrade the inventory to refer to the text revision ids."""
2081
rev_id = rev.revision_id
2082
mutter('converting texts of revision {%s}',
2084
parent_invs = map(self._load_updated_inventory, present_parents)
2085
entries = inv.iter_entries()
2087
for path, ie in entries:
2088
self._convert_file_version(rev, ie, parent_invs)
2090
def _convert_file_version(self, rev, ie, parent_invs):
2091
"""Convert one version of one file.
2093
The file needs to be added into the weave if it is a merge
2094
of >=2 parents or if it's changed from its parent.
2096
file_id = ie.file_id
2097
rev_id = rev.revision_id
2098
w = self.text_weaves.get(file_id)
2101
self.text_weaves[file_id] = w
2102
text_changed = False
2103
parent_candiate_entries = ie.parent_candidates(parent_invs)
2104
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2105
# XXX: Note that this is unordered - and this is tolerable because
2106
# the previous code was also unordered.
2107
previous_entries = dict((head, parent_candiate_entries[head]) for head
2109
self.snapshot_ie(previous_entries, ie, w, rev_id)
2112
@symbol_versioning.deprecated_method(symbol_versioning.one_one)
2113
def get_parents(self, revision_ids):
2114
for revision_id in revision_ids:
2115
yield self.revisions[revision_id].parent_ids
2117
def get_parent_map(self, revision_ids):
2118
"""See graph._StackedParentsProvider.get_parent_map"""
2119
return dict((revision_id, self.revisions[revision_id])
2120
for revision_id in revision_ids
2121
if revision_id in self.revisions)
2123
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2124
# TODO: convert this logic, which is ~= snapshot to
2125
# a call to:. This needs the path figured out. rather than a work_tree
2126
# a v4 revision_tree can be given, or something that looks enough like
2127
# one to give the file content to the entry if it needs it.
2128
# and we need something that looks like a weave store for snapshot to
2130
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2131
if len(previous_revisions) == 1:
2132
previous_ie = previous_revisions.values()[0]
2133
if ie._unchanged(previous_ie):
2134
ie.revision = previous_ie.revision
2137
text = self.branch.repository.weave_store.get(ie.text_id)
2138
file_lines = text.readlines()
2139
w.add_lines(rev_id, previous_revisions, file_lines)
2140
self.text_count += 1
2142
w.add_lines(rev_id, previous_revisions, [])
2143
ie.revision = rev_id
2145
def _make_order(self):
2146
"""Return a suitable order for importing revisions.
2148
The order must be such that an revision is imported after all
2149
its (present) parents.
2151
todo = set(self.revisions.keys())
2152
done = self.absent_revisions.copy()
2155
# scan through looking for a revision whose parents
2157
for rev_id in sorted(list(todo)):
2158
rev = self.revisions[rev_id]
2159
parent_ids = set(rev.parent_ids)
2160
if parent_ids.issubset(done):
2161
# can take this one now
2162
order.append(rev_id)
2168
class ConvertBzrDir5To6(Converter):
2169
"""Converts format 5 bzr dirs to format 6."""
2171
def convert(self, to_convert, pb):
2172
"""See Converter.convert()."""
2173
self.bzrdir = to_convert
2175
self.pb.note('starting upgrade from format 5 to 6')
2176
self._convert_to_prefixed()
2177
return BzrDir.open(self.bzrdir.root_transport.base)
2179
def _convert_to_prefixed(self):
2180
from bzrlib.store import TransportStore
2181
self.bzrdir.transport.delete('branch-format')
2182
for store_name in ["weaves", "revision-store"]:
2183
self.pb.note("adding prefixes to %s" % store_name)
2184
store_transport = self.bzrdir.transport.clone(store_name)
2185
store = TransportStore(store_transport, prefixed=True)
2186
for urlfilename in store_transport.list_dir('.'):
2187
filename = urlutils.unescape(urlfilename)
2188
if (filename.endswith(".weave") or
2189
filename.endswith(".gz") or
2190
filename.endswith(".sig")):
2191
file_id = os.path.splitext(filename)[0]
2194
prefix_dir = store.hash_prefix(file_id)
2195
# FIXME keep track of the dirs made RBC 20060121
2197
store_transport.move(filename, prefix_dir + '/' + filename)
2198
except errors.NoSuchFile: # catches missing dirs strangely enough
2199
store_transport.mkdir(prefix_dir)
2200
store_transport.move(filename, prefix_dir + '/' + filename)
2201
self.bzrdir._control_files.put_utf8('branch-format', BzrDirFormat6().get_format_string())
2204
class ConvertBzrDir6ToMeta(Converter):
2205
"""Converts format 6 bzr dirs to metadirs."""
2207
def convert(self, to_convert, pb):
2208
"""See Converter.convert()."""
2209
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2210
from bzrlib.branch import BzrBranchFormat5
2211
self.bzrdir = to_convert
2214
self.total = 20 # the steps we know about
2215
self.garbage_inventories = []
2217
self.pb.note('starting upgrade from format 6 to metadir')
2218
self.bzrdir._control_files.put_utf8('branch-format', "Converting to format 6")
2219
# its faster to move specific files around than to open and use the apis...
2220
# first off, nuke ancestry.weave, it was never used.
2222
self.step('Removing ancestry.weave')
2223
self.bzrdir.transport.delete('ancestry.weave')
2224
except errors.NoSuchFile:
2226
# find out whats there
2227
self.step('Finding branch files')
2228
last_revision = self.bzrdir.open_branch().last_revision()
2229
bzrcontents = self.bzrdir.transport.list_dir('.')
2230
for name in bzrcontents:
2231
if name.startswith('basis-inventory.'):
2232
self.garbage_inventories.append(name)
2233
# create new directories for repository, working tree and branch
2234
self.dir_mode = self.bzrdir._control_files._dir_mode
2235
self.file_mode = self.bzrdir._control_files._file_mode
2236
repository_names = [('inventory.weave', True),
2237
('revision-store', True),
2239
self.step('Upgrading repository ')
2240
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2241
self.make_lock('repository')
2242
# we hard code the formats here because we are converting into
2243
# the meta format. The meta format upgrader can take this to a
2244
# future format within each component.
2245
self.put_format('repository', RepositoryFormat7())
2246
for entry in repository_names:
2247
self.move_entry('repository', entry)
2249
self.step('Upgrading branch ')
2250
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2251
self.make_lock('branch')
2252
self.put_format('branch', BzrBranchFormat5())
2253
branch_files = [('revision-history', True),
2254
('branch-name', True),
2256
for entry in branch_files:
2257
self.move_entry('branch', entry)
2259
checkout_files = [('pending-merges', True),
2260
('inventory', True),
2261
('stat-cache', False)]
2262
# If a mandatory checkout file is not present, the branch does not have
2263
# a functional checkout. Do not create a checkout in the converted
2265
for name, mandatory in checkout_files:
2266
if mandatory and name not in bzrcontents:
2267
has_checkout = False
2271
if not has_checkout:
2272
self.pb.note('No working tree.')
2273
# If some checkout files are there, we may as well get rid of them.
2274
for name, mandatory in checkout_files:
2275
if name in bzrcontents:
2276
self.bzrdir.transport.delete(name)
2278
from bzrlib.workingtree import WorkingTreeFormat3
2279
self.step('Upgrading working tree')
2280
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2281
self.make_lock('checkout')
2283
'checkout', WorkingTreeFormat3())
2284
self.bzrdir.transport.delete_multi(
2285
self.garbage_inventories, self.pb)
2286
for entry in checkout_files:
2287
self.move_entry('checkout', entry)
2288
if last_revision is not None:
2289
self.bzrdir._control_files.put_utf8(
2290
'checkout/last-revision', last_revision)
2291
self.bzrdir._control_files.put_utf8(
2292
'branch-format', BzrDirMetaFormat1().get_format_string())
2293
return BzrDir.open(self.bzrdir.root_transport.base)
2295
def make_lock(self, name):
2296
"""Make a lock for the new control dir name."""
2297
self.step('Make %s lock' % name)
2298
ld = lockdir.LockDir(self.bzrdir.transport,
2300
file_modebits=self.file_mode,
2301
dir_modebits=self.dir_mode)
2304
def move_entry(self, new_dir, entry):
2305
"""Move then entry name into new_dir."""
2307
mandatory = entry[1]
2308
self.step('Moving %s' % name)
2310
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2311
except errors.NoSuchFile:
2315
def put_format(self, dirname, format):
2316
self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
2319
class ConvertMetaToMeta(Converter):
2320
"""Converts the components of metadirs."""
2322
def __init__(self, target_format):
2323
"""Create a metadir to metadir converter.
2325
:param target_format: The final metadir format that is desired.
2327
self.target_format = target_format
2329
def convert(self, to_convert, pb):
2330
"""See Converter.convert()."""
2331
self.bzrdir = to_convert
2335
self.step('checking repository format')
2337
repo = self.bzrdir.open_repository()
2338
except errors.NoRepositoryPresent:
2341
if not isinstance(repo._format, self.target_format.repository_format.__class__):
2342
from bzrlib.repository import CopyConverter
2343
self.pb.note('starting repository conversion')
2344
converter = CopyConverter(self.target_format.repository_format)
2345
converter.convert(repo, pb)
2347
branch = self.bzrdir.open_branch()
2348
except errors.NotBranchError:
2351
# TODO: conversions of Branch and Tree should be done by
2352
# InterXFormat lookups
2353
# Avoid circular imports
2354
from bzrlib import branch as _mod_branch
2355
if (branch._format.__class__ is _mod_branch.BzrBranchFormat5 and
2356
self.target_format.get_branch_format().__class__ is
2357
_mod_branch.BzrBranchFormat6):
2358
branch_converter = _mod_branch.Converter5to6()
2359
branch_converter.convert(branch)
2361
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
2362
except (errors.NoWorkingTree, errors.NotLocalUrl):
2365
# TODO: conversions of Branch and Tree should be done by
2366
# InterXFormat lookups
2367
if (isinstance(tree, workingtree.WorkingTree3) and
2368
not isinstance(tree, workingtree_4.WorkingTree4) and
2369
isinstance(self.target_format.workingtree_format,
2370
workingtree_4.WorkingTreeFormat4)):
2371
workingtree_4.Converter3to4().convert(tree)
2375
# This is not in remote.py because it's small, and needs to be registered.
2376
# Putting it in remote.py creates a circular import problem.
2377
# we can make it a lazy object if the control formats is turned into something
2379
class RemoteBzrDirFormat(BzrDirMetaFormat1):
2380
"""Format representing bzrdirs accessed via a smart server"""
2382
def get_format_description(self):
2383
return 'bzr remote bzrdir'
2386
def probe_transport(klass, transport):
2387
"""Return a RemoteBzrDirFormat object if it looks possible."""
2389
medium = transport.get_smart_medium()
2390
except (NotImplementedError, AttributeError,
2391
errors.TransportNotPossible, errors.NoSmartMedium,
2392
errors.SmartProtocolError):
2393
# no smart server, so not a branch for this format type.
2394
raise errors.NotBranchError(path=transport.base)
2396
# Decline to open it if the server doesn't support our required
2397
# version (3) so that the VFS-based transport will do it.
2398
if medium.should_probe():
2400
server_version = medium.protocol_version()
2401
except errors.SmartProtocolError:
2402
# Apparently there's no usable smart server there, even though
2403
# the medium supports the smart protocol.
2404
raise errors.NotBranchError(path=transport.base)
2405
if server_version != '2':
2406
raise errors.NotBranchError(path=transport.base)
2409
def initialize_on_transport(self, transport):
2411
# hand off the request to the smart server
2412
client_medium = transport.get_smart_medium()
2413
except errors.NoSmartMedium:
2414
# TODO: lookup the local format from a server hint.
2415
local_dir_format = BzrDirMetaFormat1()
2416
return local_dir_format.initialize_on_transport(transport)
2417
client = _SmartClient(client_medium, transport.base)
2418
path = client.remote_path_from_transport(transport)
2419
response = client.call('BzrDirFormat.initialize', path)
2420
if response[0] != 'ok':
2421
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
2422
return remote.RemoteBzrDir(transport)
2424
def _open(self, transport):
2425
return remote.RemoteBzrDir(transport)
2427
def __eq__(self, other):
2428
if not isinstance(other, RemoteBzrDirFormat):
2430
return self.get_format_description() == other.get_format_description()
2433
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
2436
class BzrDirFormatInfo(object):
2438
def __init__(self, native, deprecated, hidden, experimental):
2439
self.deprecated = deprecated
2440
self.native = native
2441
self.hidden = hidden
2442
self.experimental = experimental
2445
class BzrDirFormatRegistry(registry.Registry):
2446
"""Registry of user-selectable BzrDir subformats.
2448
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
2449
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
2453
"""Create a BzrDirFormatRegistry."""
2454
self._aliases = set()
2455
super(BzrDirFormatRegistry, self).__init__()
2458
"""Return a set of the format names which are aliases."""
2459
return frozenset(self._aliases)
2461
def register_metadir(self, key,
2462
repository_format, help, native=True, deprecated=False,
2468
"""Register a metadir subformat.
2470
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
2471
by the Repository format.
2473
:param repository_format: The fully-qualified repository format class
2475
:param branch_format: Fully-qualified branch format class name as
2477
:param tree_format: Fully-qualified tree format class name as
2480
# This should be expanded to support setting WorkingTree and Branch
2481
# formats, once BzrDirMetaFormat1 supports that.
2482
def _load(full_name):
2483
mod_name, factory_name = full_name.rsplit('.', 1)
2485
mod = __import__(mod_name, globals(), locals(),
2487
except ImportError, e:
2488
raise ImportError('failed to load %s: %s' % (full_name, e))
2490
factory = getattr(mod, factory_name)
2491
except AttributeError:
2492
raise AttributeError('no factory %s in module %r'
2497
bd = BzrDirMetaFormat1()
2498
if branch_format is not None:
2499
bd.set_branch_format(_load(branch_format))
2500
if tree_format is not None:
2501
bd.workingtree_format = _load(tree_format)
2502
if repository_format is not None:
2503
bd.repository_format = _load(repository_format)
2505
self.register(key, helper, help, native, deprecated, hidden,
2506
experimental, alias)
2508
def register(self, key, factory, help, native=True, deprecated=False,
2509
hidden=False, experimental=False, alias=False):
2510
"""Register a BzrDirFormat factory.
2512
The factory must be a callable that takes one parameter: the key.
2513
It must produce an instance of the BzrDirFormat when called.
2515
This function mainly exists to prevent the info object from being
2518
registry.Registry.register(self, key, factory, help,
2519
BzrDirFormatInfo(native, deprecated, hidden, experimental))
2521
self._aliases.add(key)
2523
def register_lazy(self, key, module_name, member_name, help, native=True,
2524
deprecated=False, hidden=False, experimental=False, alias=False):
2525
registry.Registry.register_lazy(self, key, module_name, member_name,
2526
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
2528
self._aliases.add(key)
2530
def set_default(self, key):
2531
"""Set the 'default' key to be a clone of the supplied key.
2533
This method must be called once and only once.
2535
registry.Registry.register(self, 'default', self.get(key),
2536
self.get_help(key), info=self.get_info(key))
2537
self._aliases.add('default')
2539
def set_default_repository(self, key):
2540
"""Set the FormatRegistry default and Repository default.
2542
This is a transitional method while Repository.set_default_format
2545
if 'default' in self:
2546
self.remove('default')
2547
self.set_default(key)
2548
format = self.get('default')()
2550
def make_bzrdir(self, key):
2551
return self.get(key)()
2553
def help_topic(self, topic):
2554
output = textwrap.dedent("""\
2555
These formats can be used for creating branches, working trees, and
2559
default_realkey = None
2560
default_help = self.get_help('default')
2562
for key in self.keys():
2563
if key == 'default':
2565
help = self.get_help(key)
2566
if help == default_help:
2567
default_realkey = key
2569
help_pairs.append((key, help))
2571
def wrapped(key, help, info):
2573
help = '(native) ' + help
2574
return ':%s:\n%s\n\n' % (key,
2575
textwrap.fill(help, initial_indent=' ',
2576
subsequent_indent=' '))
2577
if default_realkey is not None:
2578
output += wrapped(default_realkey, '(default) %s' % default_help,
2579
self.get_info('default'))
2580
deprecated_pairs = []
2581
experimental_pairs = []
2582
for key, help in help_pairs:
2583
info = self.get_info(key)
2586
elif info.deprecated:
2587
deprecated_pairs.append((key, help))
2588
elif info.experimental:
2589
experimental_pairs.append((key, help))
2591
output += wrapped(key, help, info)
2592
if len(experimental_pairs) > 0:
2593
output += "Experimental formats are shown below.\n\n"
2594
for key, help in experimental_pairs:
2595
info = self.get_info(key)
2596
output += wrapped(key, help, info)
2597
if len(deprecated_pairs) > 0:
2598
output += "Deprecated formats are shown below.\n\n"
2599
for key, help in deprecated_pairs:
2600
info = self.get_info(key)
2601
output += wrapped(key, help, info)
2606
class RepositoryAcquisitionPolicy(object):
2607
"""Abstract base class for repository acquisition policies.
2609
A repository acquisition policy decides how a BzrDir acquires a repository
2610
for a branch that is being created. The most basic policy decision is
2611
whether to create a new repository or use an existing one.
2614
def configure_branch(self, branch):
2615
"""Apply any configuration data from this policy to the branch.
2617
Default implementation does nothing.
2621
def acquire_repository(self, make_working_trees=None, shared=False):
2622
"""Acquire a repository for this bzrdir.
2624
Implementations may create a new repository or use a pre-exising
2626
:param make_working_trees: If creating a repository, set
2627
make_working_trees to this value (if non-None)
2628
:param shared: If creating a repository, make it shared if True
2629
:return: A repository
2631
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
2634
class CreateRepository(RepositoryAcquisitionPolicy):
2635
"""A policy of creating a new repository"""
2637
def __init__(self, bzrdir):
2638
RepositoryAcquisitionPolicy.__init__(self)
2639
self._bzrdir = bzrdir
2641
def acquire_repository(self, make_working_trees=None, shared=False):
2642
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
2644
Creates the desired repository in the bzrdir we already have.
2646
repository = self._bzrdir.create_repository(shared=shared)
2647
if make_working_trees is not None:
2648
repository.set_make_working_trees(make_working_trees)
2652
class UseExistingRepository(RepositoryAcquisitionPolicy):
2653
"""A policy of reusing an existing repository"""
2655
def __init__(self, repository):
2656
RepositoryAcquisitionPolicy.__init__(self)
2657
self._repository = repository
2659
def acquire_repository(self, make_working_trees=None, shared=False):
2660
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
2662
Returns an existing repository to use
2664
return self._repository
2667
format_registry = BzrDirFormatRegistry()
2668
format_registry.register('weave', BzrDirFormat6,
2669
'Pre-0.8 format. Slower than knit and does not'
2670
' support checkouts or shared repositories.',
2672
format_registry.register_metadir('knit',
2673
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2674
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
2675
branch_format='bzrlib.branch.BzrBranchFormat5',
2676
tree_format='bzrlib.workingtree.WorkingTreeFormat3')
2677
format_registry.register_metadir('metaweave',
2678
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
2679
'Transitional format in 0.8. Slower than knit.',
2680
branch_format='bzrlib.branch.BzrBranchFormat5',
2681
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2683
format_registry.register_metadir('dirstate',
2684
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2685
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2686
'above when accessed over the network.',
2687
branch_format='bzrlib.branch.BzrBranchFormat5',
2688
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
2689
# directly from workingtree_4 triggers a circular import.
2690
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2692
format_registry.register_metadir('dirstate-tags',
2693
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2694
help='New in 0.15: Fast local operations and improved scaling for '
2695
'network operations. Additionally adds support for tags.'
2696
' Incompatible with bzr < 0.15.',
2697
branch_format='bzrlib.branch.BzrBranchFormat6',
2698
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2700
format_registry.register_metadir('rich-root',
2701
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
2702
help='New in 1.0. Better handling of tree roots. Incompatible with'
2704
branch_format='bzrlib.branch.BzrBranchFormat6',
2705
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2707
format_registry.register_metadir('dirstate-with-subtree',
2708
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2709
help='New in 0.15: Fast local operations and improved scaling for '
2710
'network operations. Additionally adds support for versioning nested '
2711
'bzr branches. Incompatible with bzr < 0.15.',
2712
branch_format='bzrlib.branch.BzrBranchFormat6',
2713
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2717
format_registry.register_metadir('pack-0.92',
2718
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
2719
help='New in 0.92: Pack-based format with data compatible with '
2720
'dirstate-tags format repositories. Interoperates with '
2721
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2722
'Previously called knitpack-experimental. '
2723
'For more information, see '
2724
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2725
branch_format='bzrlib.branch.BzrBranchFormat6',
2726
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2728
format_registry.register_metadir('pack-0.92-subtree',
2729
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
2730
help='New in 0.92: Pack-based format with data compatible with '
2731
'dirstate-with-subtree format repositories. Interoperates with '
2732
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2733
'Previously called knitpack-experimental. '
2734
'For more information, see '
2735
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2736
branch_format='bzrlib.branch.BzrBranchFormat6',
2737
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2741
format_registry.register_metadir('rich-root-pack',
2742
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
2743
help='New in 1.0: Pack-based format with data compatible with '
2744
'rich-root format repositories. Incompatible with'
2746
branch_format='bzrlib.branch.BzrBranchFormat6',
2747
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2749
# The following two formats should always just be aliases.
2750
format_registry.register_metadir('development',
2751
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
2752
help='Current development format. Can convert data to and from pack-0.92 '
2753
'(and anything compatible with pack-0.92) format repositories. '
2754
'Repositories in this format can only be read by bzr.dev. '
2756
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2758
branch_format='bzrlib.branch.BzrBranchFormat6',
2759
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2763
format_registry.register_metadir('development-subtree',
2764
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
2765
help='Current development format, subtree variant. Can convert data to and '
2766
'from pack-0.92 (and anything compatible with pack-0.92) format '
2767
'repositories. Repositories in this format can only be read by '
2768
'bzr.dev. Please read '
2769
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2771
branch_format='bzrlib.branch.BzrBranchFormat6',
2772
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2776
# And the development formats which the will have aliased one of follow:
2777
format_registry.register_metadir('development0',
2778
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
2779
help='Trivial rename of pack-0.92 to provide a development format. '
2781
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2783
branch_format='bzrlib.branch.BzrBranchFormat6',
2784
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2788
format_registry.register_metadir('development0-subtree',
2789
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
2790
help='Trivial rename of pack-0.92-subtree to provide a development format. '
2792
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2794
branch_format='bzrlib.branch.BzrBranchFormat6',
2795
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2799
format_registry.set_default('pack-0.92')
added
removed
bzrlib/bzrdir.py
