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
assert self._format._lock_class == lockable_files.TransportLock
1019
assert self._format._lock_file_name == 'branch-lock'
1020
self._control_files = lockable_files.LockableFiles(
1021
self.get_branch_transport(None),
1022
self._format._lock_file_name,
1023
self._format._lock_class)
1025
def break_lock(self):
1026
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1027
raise NotImplementedError(self.break_lock)
1029
def cloning_metadir(self):
1030
"""Produce a metadir suitable for cloning with."""
1031
return self._format.__class__()
1033
def clone(self, url, revision_id=None, force_new_repo=False):
1034
"""See BzrDir.clone()."""
1035
from bzrlib.workingtree import WorkingTreeFormat2
1036
self._make_tail(url)
1037
result = self._format._initialize_for_clone(url)
1038
self.open_repository().clone(result, revision_id=revision_id)
1039
from_branch = self.open_branch()
1040
from_branch.clone(result, revision_id=revision_id)
1042
self.open_workingtree().clone(result)
1043
except errors.NotLocalUrl:
1044
# make a new one, this format always has to have one.
1046
WorkingTreeFormat2().initialize(result)
1047
except errors.NotLocalUrl:
1048
# but we cannot do it for remote trees.
1049
to_branch = result.open_branch()
1050
WorkingTreeFormat2().stub_initialize_remote(to_branch.control_files)
1053
def create_branch(self):
1054
"""See BzrDir.create_branch."""
1055
return self.open_branch()
1057
def destroy_branch(self):
1058
"""See BzrDir.destroy_branch."""
1059
raise errors.UnsupportedOperation(self.destroy_branch, self)
1061
def create_repository(self, shared=False):
1062
"""See BzrDir.create_repository."""
1064
raise errors.IncompatibleFormat('shared repository', self._format)
1065
return self.open_repository()
1067
def destroy_repository(self):
1068
"""See BzrDir.destroy_repository."""
1069
raise errors.UnsupportedOperation(self.destroy_repository, self)
1071
def create_workingtree(self, revision_id=None, from_branch=None,
1072
accelerator_tree=None, hardlink=False):
1073
"""See BzrDir.create_workingtree."""
1074
# this looks buggy but is not -really-
1075
# because this format creates the workingtree when the bzrdir is
1077
# clone and sprout will have set the revision_id
1078
# and that will have set it for us, its only
1079
# specific uses of create_workingtree in isolation
1080
# that can do wonky stuff here, and that only
1081
# happens for creating checkouts, which cannot be
1082
# done on this format anyway. So - acceptable wart.
1083
result = self.open_workingtree(recommend_upgrade=False)
1084
if revision_id is not None:
1085
if revision_id == _mod_revision.NULL_REVISION:
1086
result.set_parent_ids([])
1088
result.set_parent_ids([revision_id])
1091
def destroy_workingtree(self):
1092
"""See BzrDir.destroy_workingtree."""
1093
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1095
def destroy_workingtree_metadata(self):
1096
"""See BzrDir.destroy_workingtree_metadata."""
1097
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1100
def get_branch_transport(self, branch_format):
1101
"""See BzrDir.get_branch_transport()."""
1102
if branch_format is None:
1103
return self.transport
1105
branch_format.get_format_string()
1106
except NotImplementedError:
1107
return self.transport
1108
raise errors.IncompatibleFormat(branch_format, self._format)
1110
def get_repository_transport(self, repository_format):
1111
"""See BzrDir.get_repository_transport()."""
1112
if repository_format is None:
1113
return self.transport
1115
repository_format.get_format_string()
1116
except NotImplementedError:
1117
return self.transport
1118
raise errors.IncompatibleFormat(repository_format, self._format)
1120
def get_workingtree_transport(self, workingtree_format):
1121
"""See BzrDir.get_workingtree_transport()."""
1122
if workingtree_format is None:
1123
return self.transport
1125
workingtree_format.get_format_string()
1126
except NotImplementedError:
1127
return self.transport
1128
raise errors.IncompatibleFormat(workingtree_format, self._format)
1130
def needs_format_conversion(self, format=None):
1131
"""See BzrDir.needs_format_conversion()."""
1132
# if the format is not the same as the system default,
1133
# an upgrade is needed.
1135
format = BzrDirFormat.get_default_format()
1136
return not isinstance(self._format, format.__class__)
1138
def open_branch(self, unsupported=False):
1139
"""See BzrDir.open_branch."""
1140
from bzrlib.branch import BzrBranchFormat4
1141
format = BzrBranchFormat4()
1142
self._check_supported(format, unsupported)
1143
return format.open(self, _found=True)
1145
def sprout(self, url, revision_id=None, force_new_repo=False,
1146
possible_transports=None, accelerator_tree=None,
1148
"""See BzrDir.sprout()."""
1149
from bzrlib.workingtree import WorkingTreeFormat2
1150
self._make_tail(url)
1151
result = self._format._initialize_for_clone(url)
1153
self.open_repository().clone(result, revision_id=revision_id)
1154
except errors.NoRepositoryPresent:
1157
self.open_branch().sprout(result, revision_id=revision_id)
1158
except errors.NotBranchError:
1160
# we always want a working tree
1161
WorkingTreeFormat2().initialize(result,
1162
accelerator_tree=accelerator_tree,
1167
class BzrDir4(BzrDirPreSplitOut):
1168
"""A .bzr version 4 control object.
1170
This is a deprecated format and may be removed after sept 2006.
1173
def create_repository(self, shared=False):
1174
"""See BzrDir.create_repository."""
1175
return self._format.repository_format.initialize(self, shared)
1177
def needs_format_conversion(self, format=None):
1178
"""Format 4 dirs are always in need of conversion."""
1181
def open_repository(self):
1182
"""See BzrDir.open_repository."""
1183
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1184
return RepositoryFormat4().open(self, _found=True)
1187
class BzrDir5(BzrDirPreSplitOut):
1188
"""A .bzr version 5 control object.
1190
This is a deprecated format and may be removed after sept 2006.
1193
def open_repository(self):
1194
"""See BzrDir.open_repository."""
1195
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1196
return RepositoryFormat5().open(self, _found=True)
1198
def open_workingtree(self, _unsupported=False,
1199
recommend_upgrade=True):
1200
"""See BzrDir.create_workingtree."""
1201
from bzrlib.workingtree import WorkingTreeFormat2
1202
wt_format = WorkingTreeFormat2()
1203
# we don't warn here about upgrades; that ought to be handled for the
1205
return wt_format.open(self, _found=True)
1208
class BzrDir6(BzrDirPreSplitOut):
1209
"""A .bzr version 6 control object.
1211
This is a deprecated format and may be removed after sept 2006.
1214
def open_repository(self):
1215
"""See BzrDir.open_repository."""
1216
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1217
return RepositoryFormat6().open(self, _found=True)
1219
def open_workingtree(self, _unsupported=False,
1220
recommend_upgrade=True):
1221
"""See BzrDir.create_workingtree."""
1222
# we don't warn here about upgrades; that ought to be handled for the
1224
from bzrlib.workingtree import WorkingTreeFormat2
1225
return WorkingTreeFormat2().open(self, _found=True)
1228
class BzrDirMeta1(BzrDir):
1229
"""A .bzr meta version 1 control object.
1231
This is the first control object where the
1232
individual aspects are really split out: there are separate repository,
1233
workingtree and branch subdirectories and any subset of the three can be
1234
present within a BzrDir.
1237
def can_convert_format(self):
1238
"""See BzrDir.can_convert_format()."""
1241
def create_branch(self):
1242
"""See BzrDir.create_branch."""
1243
return self._format.get_branch_format().initialize(self)
1245
def destroy_branch(self):
1246
"""See BzrDir.create_branch."""
1247
self.transport.delete_tree('branch')
1249
def create_repository(self, shared=False):
1250
"""See BzrDir.create_repository."""
1251
return self._format.repository_format.initialize(self, shared)
1253
def destroy_repository(self):
1254
"""See BzrDir.destroy_repository."""
1255
self.transport.delete_tree('repository')
1257
def create_workingtree(self, revision_id=None, from_branch=None,
1258
accelerator_tree=None, hardlink=False):
1259
"""See BzrDir.create_workingtree."""
1260
return self._format.workingtree_format.initialize(
1261
self, revision_id, from_branch=from_branch,
1262
accelerator_tree=accelerator_tree, hardlink=hardlink)
1264
def destroy_workingtree(self):
1265
"""See BzrDir.destroy_workingtree."""
1266
wt = self.open_workingtree(recommend_upgrade=False)
1267
repository = wt.branch.repository
1268
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1269
wt.revert(old_tree=empty)
1270
self.destroy_workingtree_metadata()
1272
def destroy_workingtree_metadata(self):
1273
self.transport.delete_tree('checkout')
1275
def find_branch_format(self):
1276
"""Find the branch 'format' for this bzrdir.
1278
This might be a synthetic object for e.g. RemoteBranch and SVN.
1280
from bzrlib.branch import BranchFormat
1281
return BranchFormat.find_format(self)
1283
def _get_mkdir_mode(self):
1284
"""Figure out the mode to use when creating a bzrdir subdir."""
1285
temp_control = lockable_files.LockableFiles(self.transport, '',
1286
lockable_files.TransportLock)
1287
return temp_control._dir_mode
1289
def get_branch_reference(self):
1290
"""See BzrDir.get_branch_reference()."""
1291
from bzrlib.branch import BranchFormat
1292
format = BranchFormat.find_format(self)
1293
return format.get_reference(self)
1295
def get_branch_transport(self, branch_format):
1296
"""See BzrDir.get_branch_transport()."""
1297
if branch_format is None:
1298
return self.transport.clone('branch')
1300
branch_format.get_format_string()
1301
except NotImplementedError:
1302
raise errors.IncompatibleFormat(branch_format, self._format)
1304
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1305
except errors.FileExists:
1307
return self.transport.clone('branch')
1309
def get_repository_transport(self, repository_format):
1310
"""See BzrDir.get_repository_transport()."""
1311
if repository_format is None:
1312
return self.transport.clone('repository')
1314
repository_format.get_format_string()
1315
except NotImplementedError:
1316
raise errors.IncompatibleFormat(repository_format, self._format)
1318
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1319
except errors.FileExists:
1321
return self.transport.clone('repository')
1323
def get_workingtree_transport(self, workingtree_format):
1324
"""See BzrDir.get_workingtree_transport()."""
1325
if workingtree_format is None:
1326
return self.transport.clone('checkout')
1328
workingtree_format.get_format_string()
1329
except NotImplementedError:
1330
raise errors.IncompatibleFormat(workingtree_format, self._format)
1332
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1333
except errors.FileExists:
1335
return self.transport.clone('checkout')
1337
def needs_format_conversion(self, format=None):
1338
"""See BzrDir.needs_format_conversion()."""
1340
format = BzrDirFormat.get_default_format()
1341
if not isinstance(self._format, format.__class__):
1342
# it is not a meta dir format, conversion is needed.
1344
# we might want to push this down to the repository?
1346
if not isinstance(self.open_repository()._format,
1347
format.repository_format.__class__):
1348
# the repository needs an upgrade.
1350
except errors.NoRepositoryPresent:
1353
if not isinstance(self.open_branch()._format,
1354
format.get_branch_format().__class__):
1355
# the branch needs an upgrade.
1357
except errors.NotBranchError:
1360
my_wt = self.open_workingtree(recommend_upgrade=False)
1361
if not isinstance(my_wt._format,
1362
format.workingtree_format.__class__):
1363
# the workingtree needs an upgrade.
1365
except (errors.NoWorkingTree, errors.NotLocalUrl):
1369
def open_branch(self, unsupported=False):
1370
"""See BzrDir.open_branch."""
1371
format = self.find_branch_format()
1372
self._check_supported(format, unsupported)
1373
return format.open(self, _found=True)
1375
def open_repository(self, unsupported=False):
1376
"""See BzrDir.open_repository."""
1377
from bzrlib.repository import RepositoryFormat
1378
format = RepositoryFormat.find_format(self)
1379
self._check_supported(format, unsupported)
1380
return format.open(self, _found=True)
1382
def open_workingtree(self, unsupported=False,
1383
recommend_upgrade=True):
1384
"""See BzrDir.open_workingtree."""
1385
from bzrlib.workingtree import WorkingTreeFormat
1386
format = WorkingTreeFormat.find_format(self)
1387
self._check_supported(format, unsupported,
1389
basedir=self.root_transport.base)
1390
return format.open(self, _found=True)
1393
class BzrDirFormat(object):
1394
"""An encapsulation of the initialization and open routines for a format.
1396
Formats provide three things:
1397
* An initialization routine,
1401
Formats are placed in a dict by their format string for reference
1402
during bzrdir opening. These should be subclasses of BzrDirFormat
1405
Once a format is deprecated, just deprecate the initialize and open
1406
methods on the format class. Do not deprecate the object, as the
1407
object will be created every system load.
1410
_default_format = None
1411
"""The default format used for new .bzr dirs."""
1414
"""The known formats."""
1416
_control_formats = []
1417
"""The registered control formats - .bzr, ....
1419
This is a list of BzrDirFormat objects.
1422
_control_server_formats = []
1423
"""The registered control server formats, e.g. RemoteBzrDirs.
1425
This is a list of BzrDirFormat objects.
1428
_lock_file_name = 'branch-lock'
1430
# _lock_class must be set in subclasses to the lock type, typ.
1431
# TransportLock or LockDir
1434
def find_format(klass, transport, _server_formats=True):
1435
"""Return the format present at transport."""
1437
formats = klass._control_server_formats + klass._control_formats
1439
formats = klass._control_formats
1440
for format in formats:
1442
return format.probe_transport(transport)
1443
except errors.NotBranchError:
1444
# this format does not find a control dir here.
1446
raise errors.NotBranchError(path=transport.base)
1449
def probe_transport(klass, transport):
1450
"""Return the .bzrdir style format present in a directory."""
1452
format_string = transport.get(".bzr/branch-format").read()
1453
except errors.NoSuchFile:
1454
raise errors.NotBranchError(path=transport.base)
1457
return klass._formats[format_string]
1459
raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1462
def get_default_format(klass):
1463
"""Return the current default format."""
1464
return klass._default_format
1466
def get_format_string(self):
1467
"""Return the ASCII format string that identifies this format."""
1468
raise NotImplementedError(self.get_format_string)
1470
def get_format_description(self):
1471
"""Return the short description for this format."""
1472
raise NotImplementedError(self.get_format_description)
1474
def get_converter(self, format=None):
1475
"""Return the converter to use to convert bzrdirs needing converts.
1477
This returns a bzrlib.bzrdir.Converter object.
1479
This should return the best upgrader to step this format towards the
1480
current default format. In the case of plugins we can/should provide
1481
some means for them to extend the range of returnable converters.
1483
:param format: Optional format to override the default format of the
1486
raise NotImplementedError(self.get_converter)
1488
def initialize(self, url, possible_transports=None):
1489
"""Create a bzr control dir at this url and return an opened copy.
1491
Subclasses should typically override initialize_on_transport
1492
instead of this method.
1494
return self.initialize_on_transport(get_transport(url,
1495
possible_transports))
1497
def initialize_on_transport(self, transport):
1498
"""Initialize a new bzrdir in the base directory of a Transport."""
1499
# Since we don't have a .bzr directory, inherit the
1500
# mode from the root directory
1501
temp_control = lockable_files.LockableFiles(transport,
1502
'', lockable_files.TransportLock)
1503
temp_control._transport.mkdir('.bzr',
1504
# FIXME: RBC 20060121 don't peek under
1506
mode=temp_control._dir_mode)
1507
if sys.platform == 'win32' and isinstance(transport, LocalTransport):
1508
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1509
file_mode = temp_control._file_mode
1511
mutter('created control directory in ' + transport.base)
1512
control = transport.clone('.bzr')
1513
utf8_files = [('README',
1514
"This is a Bazaar control directory.\n"
1515
"Do not change any files in this directory.\n"
1516
"See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
1517
('branch-format', self.get_format_string()),
1519
# NB: no need to escape relative paths that are url safe.
1520
control_files = lockable_files.LockableFiles(control,
1521
self._lock_file_name, self._lock_class)
1522
control_files.create_lock()
1523
control_files.lock_write()
1525
for file, content in utf8_files:
1526
control_files.put_utf8(file, content)
1528
control_files.unlock()
1529
return self.open(transport, _found=True)
1531
def is_supported(self):
1532
"""Is this format supported?
1534
Supported formats must be initializable and openable.
1535
Unsupported formats may not support initialization or committing or
1536
some other features depending on the reason for not being supported.
1540
def same_model(self, target_format):
1541
return (self.repository_format.rich_root_data ==
1542
target_format.rich_root_data)
1545
def known_formats(klass):
1546
"""Return all the known formats.
1548
Concrete formats should override _known_formats.
1550
# There is double indirection here to make sure that control
1551
# formats used by more than one dir format will only be probed
1552
# once. This can otherwise be quite expensive for remote connections.
1554
for format in klass._control_formats:
1555
result.update(format._known_formats())
1559
def _known_formats(klass):
1560
"""Return the known format instances for this control format."""
1561
return set(klass._formats.values())
1563
def open(self, transport, _found=False):
1564
"""Return an instance of this format for the dir transport points at.
1566
_found is a private parameter, do not use it.
1569
found_format = BzrDirFormat.find_format(transport)
1570
if not isinstance(found_format, self.__class__):
1571
raise AssertionError("%s was asked to open %s, but it seems to need "
1573
% (self, transport, found_format))
1574
return self._open(transport)
1576
def _open(self, transport):
1577
"""Template method helper for opening BzrDirectories.
1579
This performs the actual open and any additional logic or parameter
1582
raise NotImplementedError(self._open)
1585
def register_format(klass, format):
1586
klass._formats[format.get_format_string()] = format
1589
def register_control_format(klass, format):
1590
"""Register a format that does not use '.bzr' for its control dir.
1592
TODO: This should be pulled up into a 'ControlDirFormat' base class
1593
which BzrDirFormat can inherit from, and renamed to register_format
1594
there. It has been done without that for now for simplicity of
1597
klass._control_formats.append(format)
1600
def register_control_server_format(klass, format):
1601
"""Register a control format for client-server environments.
1603
These formats will be tried before ones registered with
1604
register_control_format. This gives implementations that decide to the
1605
chance to grab it before anything looks at the contents of the format
1608
klass._control_server_formats.append(format)
1611
def _set_default_format(klass, format):
1612
"""Set default format (for testing behavior of defaults only)"""
1613
klass._default_format = format
1617
return self.get_format_string().rstrip()
1620
def unregister_format(klass, format):
1621
assert klass._formats[format.get_format_string()] is format
1622
del klass._formats[format.get_format_string()]
1625
def unregister_control_format(klass, format):
1626
klass._control_formats.remove(format)
1629
class BzrDirFormat4(BzrDirFormat):
1630
"""Bzr dir format 4.
1632
This format is a combined format for working tree, branch and repository.
1634
- Format 1 working trees [always]
1635
- Format 4 branches [always]
1636
- Format 4 repositories [always]
1638
This format is deprecated: it indexes texts using a text it which is
1639
removed in format 5; write support for this format has been removed.
1642
_lock_class = lockable_files.TransportLock
1644
def get_format_string(self):
1645
"""See BzrDirFormat.get_format_string()."""
1646
return "Bazaar-NG branch, format 0.0.4\n"
1648
def get_format_description(self):
1649
"""See BzrDirFormat.get_format_description()."""
1650
return "All-in-one format 4"
1652
def get_converter(self, format=None):
1653
"""See BzrDirFormat.get_converter()."""
1654
# there is one and only one upgrade path here.
1655
return ConvertBzrDir4To5()
1657
def initialize_on_transport(self, transport):
1658
"""Format 4 branches cannot be created."""
1659
raise errors.UninitializableFormat(self)
1661
def is_supported(self):
1662
"""Format 4 is not supported.
1664
It is not supported because the model changed from 4 to 5 and the
1665
conversion logic is expensive - so doing it on the fly was not
1670
def _open(self, transport):
1671
"""See BzrDirFormat._open."""
1672
return BzrDir4(transport, self)
1674
def __return_repository_format(self):
1675
"""Circular import protection."""
1676
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1677
return RepositoryFormat4()
1678
repository_format = property(__return_repository_format)
1681
class BzrDirFormat5(BzrDirFormat):
1682
"""Bzr control format 5.
1684
This format is a combined format for working tree, branch and repository.
1686
- Format 2 working trees [always]
1687
- Format 4 branches [always]
1688
- Format 5 repositories [always]
1689
Unhashed stores in the repository.
1692
_lock_class = lockable_files.TransportLock
1694
def get_format_string(self):
1695
"""See BzrDirFormat.get_format_string()."""
1696
return "Bazaar-NG branch, format 5\n"
1698
def get_format_description(self):
1699
"""See BzrDirFormat.get_format_description()."""
1700
return "All-in-one format 5"
1702
def get_converter(self, format=None):
1703
"""See BzrDirFormat.get_converter()."""
1704
# there is one and only one upgrade path here.
1705
return ConvertBzrDir5To6()
1707
def _initialize_for_clone(self, url):
1708
return self.initialize_on_transport(get_transport(url), _cloning=True)
1710
def initialize_on_transport(self, transport, _cloning=False):
1711
"""Format 5 dirs always have working tree, branch and repository.
1713
Except when they are being cloned.
1715
from bzrlib.branch import BzrBranchFormat4
1716
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1717
from bzrlib.workingtree import WorkingTreeFormat2
1718
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1719
RepositoryFormat5().initialize(result, _internal=True)
1721
branch = BzrBranchFormat4().initialize(result)
1723
WorkingTreeFormat2().initialize(result)
1724
except errors.NotLocalUrl:
1725
# Even though we can't access the working tree, we need to
1726
# create its control files.
1727
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1730
def _open(self, transport):
1731
"""See BzrDirFormat._open."""
1732
return BzrDir5(transport, self)
1734
def __return_repository_format(self):
1735
"""Circular import protection."""
1736
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1737
return RepositoryFormat5()
1738
repository_format = property(__return_repository_format)
1741
class BzrDirFormat6(BzrDirFormat):
1742
"""Bzr control format 6.
1744
This format is a combined format for working tree, branch and repository.
1746
- Format 2 working trees [always]
1747
- Format 4 branches [always]
1748
- Format 6 repositories [always]
1751
_lock_class = lockable_files.TransportLock
1753
def get_format_string(self):
1754
"""See BzrDirFormat.get_format_string()."""
1755
return "Bazaar-NG branch, format 6\n"
1757
def get_format_description(self):
1758
"""See BzrDirFormat.get_format_description()."""
1759
return "All-in-one format 6"
1761
def get_converter(self, format=None):
1762
"""See BzrDirFormat.get_converter()."""
1763
# there is one and only one upgrade path here.
1764
return ConvertBzrDir6ToMeta()
1766
def _initialize_for_clone(self, url):
1767
return self.initialize_on_transport(get_transport(url), _cloning=True)
1769
def initialize_on_transport(self, transport, _cloning=False):
1770
"""Format 6 dirs always have working tree, branch and repository.
1772
Except when they are being cloned.
1774
from bzrlib.branch import BzrBranchFormat4
1775
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1776
from bzrlib.workingtree import WorkingTreeFormat2
1777
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1778
RepositoryFormat6().initialize(result, _internal=True)
1780
branch = BzrBranchFormat4().initialize(result)
1782
WorkingTreeFormat2().initialize(result)
1783
except errors.NotLocalUrl:
1784
# Even though we can't access the working tree, we need to
1785
# create its control files.
1786
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1789
def _open(self, transport):
1790
"""See BzrDirFormat._open."""
1791
return BzrDir6(transport, self)
1793
def __return_repository_format(self):
1794
"""Circular import protection."""
1795
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1796
return RepositoryFormat6()
1797
repository_format = property(__return_repository_format)
1800
class BzrDirMetaFormat1(BzrDirFormat):
1801
"""Bzr meta control format 1
1803
This is the first format with split out working tree, branch and repository
1806
- Format 3 working trees [optional]
1807
- Format 5 branches [optional]
1808
- Format 7 repositories [optional]
1811
_lock_class = lockdir.LockDir
1814
self._workingtree_format = None
1815
self._branch_format = None
1817
def __eq__(self, other):
1818
if other.__class__ is not self.__class__:
1820
if other.repository_format != self.repository_format:
1822
if other.workingtree_format != self.workingtree_format:
1826
def __ne__(self, other):
1827
return not self == other
1829
def get_branch_format(self):
1830
if self._branch_format is None:
1831
from bzrlib.branch import BranchFormat
1832
self._branch_format = BranchFormat.get_default_format()
1833
return self._branch_format
1835
def set_branch_format(self, format):
1836
self._branch_format = format
1838
def get_converter(self, format=None):
1839
"""See BzrDirFormat.get_converter()."""
1841
format = BzrDirFormat.get_default_format()
1842
if not isinstance(self, format.__class__):
1843
# converting away from metadir is not implemented
1844
raise NotImplementedError(self.get_converter)
1845
return ConvertMetaToMeta(format)
1847
def get_format_string(self):
1848
"""See BzrDirFormat.get_format_string()."""
1849
return "Bazaar-NG meta directory, format 1\n"
1851
def get_format_description(self):
1852
"""See BzrDirFormat.get_format_description()."""
1853
return "Meta directory format 1"
1855
def _open(self, transport):
1856
"""See BzrDirFormat._open."""
1857
return BzrDirMeta1(transport, self)
1859
def __return_repository_format(self):
1860
"""Circular import protection."""
1861
if getattr(self, '_repository_format', None):
1862
return self._repository_format
1863
from bzrlib.repository import RepositoryFormat
1864
return RepositoryFormat.get_default_format()
1866
def __set_repository_format(self, value):
1867
"""Allow changing the repository format for metadir formats."""
1868
self._repository_format = value
1870
repository_format = property(__return_repository_format, __set_repository_format)
1872
def __get_workingtree_format(self):
1873
if self._workingtree_format is None:
1874
from bzrlib.workingtree import WorkingTreeFormat
1875
self._workingtree_format = WorkingTreeFormat.get_default_format()
1876
return self._workingtree_format
1878
def __set_workingtree_format(self, wt_format):
1879
self._workingtree_format = wt_format
1881
workingtree_format = property(__get_workingtree_format,
1882
__set_workingtree_format)
1885
# Register bzr control format
1886
BzrDirFormat.register_control_format(BzrDirFormat)
1888
# Register bzr formats
1889
BzrDirFormat.register_format(BzrDirFormat4())
1890
BzrDirFormat.register_format(BzrDirFormat5())
1891
BzrDirFormat.register_format(BzrDirFormat6())
1892
__default_format = BzrDirMetaFormat1()
1893
BzrDirFormat.register_format(__default_format)
1894
BzrDirFormat._default_format = __default_format
1897
class Converter(object):
1898
"""Converts a disk format object from one format to another."""
1900
def convert(self, to_convert, pb):
1901
"""Perform the conversion of to_convert, giving feedback via pb.
1903
:param to_convert: The disk object to convert.
1904
:param pb: a progress bar to use for progress information.
1907
def step(self, message):
1908
"""Update the pb by a step."""
1910
self.pb.update(message, self.count, self.total)
1913
class ConvertBzrDir4To5(Converter):
1914
"""Converts format 4 bzr dirs to format 5."""
1917
super(ConvertBzrDir4To5, self).__init__()
1918
self.converted_revs = set()
1919
self.absent_revisions = set()
1923
def convert(self, to_convert, pb):
1924
"""See Converter.convert()."""
1925
self.bzrdir = to_convert
1927
self.pb.note('starting upgrade from format 4 to 5')
1928
if isinstance(self.bzrdir.transport, LocalTransport):
1929
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
1930
self._convert_to_weaves()
1931
return BzrDir.open(self.bzrdir.root_transport.base)
1933
def _convert_to_weaves(self):
1934
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
1937
stat = self.bzrdir.transport.stat('weaves')
1938
if not S_ISDIR(stat.st_mode):
1939
self.bzrdir.transport.delete('weaves')
1940
self.bzrdir.transport.mkdir('weaves')
1941
except errors.NoSuchFile:
1942
self.bzrdir.transport.mkdir('weaves')
1943
# deliberately not a WeaveFile as we want to build it up slowly.
1944
self.inv_weave = Weave('inventory')
1945
# holds in-memory weaves for all files
1946
self.text_weaves = {}
1947
self.bzrdir.transport.delete('branch-format')
1948
self.branch = self.bzrdir.open_branch()
1949
self._convert_working_inv()
1950
rev_history = self.branch.revision_history()
1951
# to_read is a stack holding the revisions we still need to process;
1952
# appending to it adds new highest-priority revisions
1953
self.known_revisions = set(rev_history)
1954
self.to_read = rev_history[-1:]
1956
rev_id = self.to_read.pop()
1957
if (rev_id not in self.revisions
1958
and rev_id not in self.absent_revisions):
1959
self._load_one_rev(rev_id)
1961
to_import = self._make_order()
1962
for i, rev_id in enumerate(to_import):
1963
self.pb.update('converting revision', i, len(to_import))
1964
self._convert_one_rev(rev_id)
1966
self._write_all_weaves()
1967
self._write_all_revs()
1968
self.pb.note('upgraded to weaves:')
1969
self.pb.note(' %6d revisions and inventories', len(self.revisions))
1970
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
1971
self.pb.note(' %6d texts', self.text_count)
1972
self._cleanup_spare_files_after_format4()
1973
self.branch.control_files.put_utf8('branch-format', BzrDirFormat5().get_format_string())
1975
def _cleanup_spare_files_after_format4(self):
1976
# FIXME working tree upgrade foo.
1977
for n in 'merged-patches', 'pending-merged-patches':
1979
## assert os.path.getsize(p) == 0
1980
self.bzrdir.transport.delete(n)
1981
except errors.NoSuchFile:
1983
self.bzrdir.transport.delete_tree('inventory-store')
1984
self.bzrdir.transport.delete_tree('text-store')
1986
def _convert_working_inv(self):
1987
inv = xml4.serializer_v4.read_inventory(
1988
self.branch.control_files.get('inventory'))
1989
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
1990
# FIXME inventory is a working tree change.
1991
self.branch.control_files.put('inventory', StringIO(new_inv_xml))
1993
def _write_all_weaves(self):
1994
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
1995
weave_transport = self.bzrdir.transport.clone('weaves')
1996
weaves = WeaveStore(weave_transport, prefixed=False)
1997
transaction = WriteTransaction()
2001
for file_id, file_weave in self.text_weaves.items():
2002
self.pb.update('writing weave', i, len(self.text_weaves))
2003
weaves._put_weave(file_id, file_weave, transaction)
2005
self.pb.update('inventory', 0, 1)
2006
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2007
self.pb.update('inventory', 1, 1)
2011
def _write_all_revs(self):
2012
"""Write all revisions out in new form."""
2013
self.bzrdir.transport.delete_tree('revision-store')
2014
self.bzrdir.transport.mkdir('revision-store')
2015
revision_transport = self.bzrdir.transport.clone('revision-store')
2017
_revision_store = TextRevisionStore(TextStore(revision_transport,
2021
transaction = WriteTransaction()
2022
for i, rev_id in enumerate(self.converted_revs):
2023
self.pb.update('write revision', i, len(self.converted_revs))
2024
_revision_store.add_revision(self.revisions[rev_id], transaction)
2028
def _load_one_rev(self, rev_id):
2029
"""Load a revision object into memory.
2031
Any parents not either loaded or abandoned get queued to be
2033
self.pb.update('loading revision',
2034
len(self.revisions),
2035
len(self.known_revisions))
2036
if not self.branch.repository.has_revision(rev_id):
2038
self.pb.note('revision {%s} not present in branch; '
2039
'will be converted as a ghost',
2041
self.absent_revisions.add(rev_id)
2043
rev = self.branch.repository._revision_store.get_revision(rev_id,
2044
self.branch.repository.get_transaction())
2045
for parent_id in rev.parent_ids:
2046
self.known_revisions.add(parent_id)
2047
self.to_read.append(parent_id)
2048
self.revisions[rev_id] = rev
2050
def _load_old_inventory(self, rev_id):
2051
assert rev_id not in self.converted_revs
2052
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2053
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2054
inv.revision_id = rev_id
2055
rev = self.revisions[rev_id]
2056
if rev.inventory_sha1:
2057
assert rev.inventory_sha1 == sha_string(old_inv_xml), \
2058
'inventory sha mismatch for {%s}' % rev_id
2061
def _load_updated_inventory(self, rev_id):
2062
assert rev_id in self.converted_revs
2063
inv_xml = self.inv_weave.get_text(rev_id)
2064
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2067
def _convert_one_rev(self, rev_id):
2068
"""Convert revision and all referenced objects to new format."""
2069
rev = self.revisions[rev_id]
2070
inv = self._load_old_inventory(rev_id)
2071
present_parents = [p for p in rev.parent_ids
2072
if p not in self.absent_revisions]
2073
self._convert_revision_contents(rev, inv, present_parents)
2074
self._store_new_inv(rev, inv, present_parents)
2075
self.converted_revs.add(rev_id)
2077
def _store_new_inv(self, rev, inv, present_parents):
2078
# the XML is now updated with text versions
2080
entries = inv.iter_entries()
2082
for path, ie in entries:
2083
assert getattr(ie, 'revision', None) is not None, \
2084
'no revision on {%s} in {%s}' % \
2085
(file_id, rev.revision_id)
2086
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2087
new_inv_sha1 = sha_string(new_inv_xml)
2088
self.inv_weave.add_lines(rev.revision_id,
2090
new_inv_xml.splitlines(True))
2091
rev.inventory_sha1 = new_inv_sha1
2093
def _convert_revision_contents(self, rev, inv, present_parents):
2094
"""Convert all the files within a revision.
2096
Also upgrade the inventory to refer to the text revision ids."""
2097
rev_id = rev.revision_id
2098
mutter('converting texts of revision {%s}',
2100
parent_invs = map(self._load_updated_inventory, present_parents)
2101
entries = inv.iter_entries()
2103
for path, ie in entries:
2104
self._convert_file_version(rev, ie, parent_invs)
2106
def _convert_file_version(self, rev, ie, parent_invs):
2107
"""Convert one version of one file.
2109
The file needs to be added into the weave if it is a merge
2110
of >=2 parents or if it's changed from its parent.
2112
file_id = ie.file_id
2113
rev_id = rev.revision_id
2114
w = self.text_weaves.get(file_id)
2117
self.text_weaves[file_id] = w
2118
text_changed = False
2119
parent_candiate_entries = ie.parent_candidates(parent_invs)
2120
for old_revision in parent_candiate_entries.keys():
2121
# if this fails, its a ghost ?
2122
assert old_revision in self.converted_revs, \
2123
"Revision {%s} not in converted_revs" % old_revision
2124
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2125
# XXX: Note that this is unordered - and this is tolerable because
2126
# the previous code was also unordered.
2127
previous_entries = dict((head, parent_candiate_entries[head]) for head
2129
self.snapshot_ie(previous_entries, ie, w, rev_id)
2131
assert getattr(ie, 'revision', None) is not None
2133
@symbol_versioning.deprecated_method(symbol_versioning.one_one)
2134
def get_parents(self, revision_ids):
2135
for revision_id in revision_ids:
2136
yield self.revisions[revision_id].parent_ids
2138
def get_parent_map(self, revision_ids):
2139
"""See graph._StackedParentsProvider.get_parent_map"""
2140
return dict((revision_id, self.revisions[revision_id])
2141
for revision_id in revision_ids
2142
if revision_id in self.revisions)
2144
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2145
# TODO: convert this logic, which is ~= snapshot to
2146
# a call to:. This needs the path figured out. rather than a work_tree
2147
# a v4 revision_tree can be given, or something that looks enough like
2148
# one to give the file content to the entry if it needs it.
2149
# and we need something that looks like a weave store for snapshot to
2151
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2152
if len(previous_revisions) == 1:
2153
previous_ie = previous_revisions.values()[0]
2154
if ie._unchanged(previous_ie):
2155
ie.revision = previous_ie.revision
2158
text = self.branch.repository.weave_store.get(ie.text_id)
2159
file_lines = text.readlines()
2160
assert sha_strings(file_lines) == ie.text_sha1
2161
assert sum(map(len, file_lines)) == ie.text_size
2162
w.add_lines(rev_id, previous_revisions, file_lines)
2163
self.text_count += 1
2165
w.add_lines(rev_id, previous_revisions, [])
2166
ie.revision = rev_id
2168
def _make_order(self):
2169
"""Return a suitable order for importing revisions.
2171
The order must be such that an revision is imported after all
2172
its (present) parents.
2174
todo = set(self.revisions.keys())
2175
done = self.absent_revisions.copy()
2178
# scan through looking for a revision whose parents
2180
for rev_id in sorted(list(todo)):
2181
rev = self.revisions[rev_id]
2182
parent_ids = set(rev.parent_ids)
2183
if parent_ids.issubset(done):
2184
# can take this one now
2185
order.append(rev_id)
2191
class ConvertBzrDir5To6(Converter):
2192
"""Converts format 5 bzr dirs to format 6."""
2194
def convert(self, to_convert, pb):
2195
"""See Converter.convert()."""
2196
self.bzrdir = to_convert
2198
self.pb.note('starting upgrade from format 5 to 6')
2199
self._convert_to_prefixed()
2200
return BzrDir.open(self.bzrdir.root_transport.base)
2202
def _convert_to_prefixed(self):
2203
from bzrlib.store import TransportStore
2204
self.bzrdir.transport.delete('branch-format')
2205
for store_name in ["weaves", "revision-store"]:
2206
self.pb.note("adding prefixes to %s" % store_name)
2207
store_transport = self.bzrdir.transport.clone(store_name)
2208
store = TransportStore(store_transport, prefixed=True)
2209
for urlfilename in store_transport.list_dir('.'):
2210
filename = urlutils.unescape(urlfilename)
2211
if (filename.endswith(".weave") or
2212
filename.endswith(".gz") or
2213
filename.endswith(".sig")):
2214
file_id = os.path.splitext(filename)[0]
2217
prefix_dir = store.hash_prefix(file_id)
2218
# FIXME keep track of the dirs made RBC 20060121
2220
store_transport.move(filename, prefix_dir + '/' + filename)
2221
except errors.NoSuchFile: # catches missing dirs strangely enough
2222
store_transport.mkdir(prefix_dir)
2223
store_transport.move(filename, prefix_dir + '/' + filename)
2224
self.bzrdir._control_files.put_utf8('branch-format', BzrDirFormat6().get_format_string())
2227
class ConvertBzrDir6ToMeta(Converter):
2228
"""Converts format 6 bzr dirs to metadirs."""
2230
def convert(self, to_convert, pb):
2231
"""See Converter.convert()."""
2232
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2233
from bzrlib.branch import BzrBranchFormat5
2234
self.bzrdir = to_convert
2237
self.total = 20 # the steps we know about
2238
self.garbage_inventories = []
2240
self.pb.note('starting upgrade from format 6 to metadir')
2241
self.bzrdir._control_files.put_utf8('branch-format', "Converting to format 6")
2242
# its faster to move specific files around than to open and use the apis...
2243
# first off, nuke ancestry.weave, it was never used.
2245
self.step('Removing ancestry.weave')
2246
self.bzrdir.transport.delete('ancestry.weave')
2247
except errors.NoSuchFile:
2249
# find out whats there
2250
self.step('Finding branch files')
2251
last_revision = self.bzrdir.open_branch().last_revision()
2252
bzrcontents = self.bzrdir.transport.list_dir('.')
2253
for name in bzrcontents:
2254
if name.startswith('basis-inventory.'):
2255
self.garbage_inventories.append(name)
2256
# create new directories for repository, working tree and branch
2257
self.dir_mode = self.bzrdir._control_files._dir_mode
2258
self.file_mode = self.bzrdir._control_files._file_mode
2259
repository_names = [('inventory.weave', True),
2260
('revision-store', True),
2262
self.step('Upgrading repository ')
2263
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2264
self.make_lock('repository')
2265
# we hard code the formats here because we are converting into
2266
# the meta format. The meta format upgrader can take this to a
2267
# future format within each component.
2268
self.put_format('repository', RepositoryFormat7())
2269
for entry in repository_names:
2270
self.move_entry('repository', entry)
2272
self.step('Upgrading branch ')
2273
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2274
self.make_lock('branch')
2275
self.put_format('branch', BzrBranchFormat5())
2276
branch_files = [('revision-history', True),
2277
('branch-name', True),
2279
for entry in branch_files:
2280
self.move_entry('branch', entry)
2282
checkout_files = [('pending-merges', True),
2283
('inventory', True),
2284
('stat-cache', False)]
2285
# If a mandatory checkout file is not present, the branch does not have
2286
# a functional checkout. Do not create a checkout in the converted
2288
for name, mandatory in checkout_files:
2289
if mandatory and name not in bzrcontents:
2290
has_checkout = False
2294
if not has_checkout:
2295
self.pb.note('No working tree.')
2296
# If some checkout files are there, we may as well get rid of them.
2297
for name, mandatory in checkout_files:
2298
if name in bzrcontents:
2299
self.bzrdir.transport.delete(name)
2301
from bzrlib.workingtree import WorkingTreeFormat3
2302
self.step('Upgrading working tree')
2303
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2304
self.make_lock('checkout')
2306
'checkout', WorkingTreeFormat3())
2307
self.bzrdir.transport.delete_multi(
2308
self.garbage_inventories, self.pb)
2309
for entry in checkout_files:
2310
self.move_entry('checkout', entry)
2311
if last_revision is not None:
2312
self.bzrdir._control_files.put_utf8(
2313
'checkout/last-revision', last_revision)
2314
self.bzrdir._control_files.put_utf8(
2315
'branch-format', BzrDirMetaFormat1().get_format_string())
2316
return BzrDir.open(self.bzrdir.root_transport.base)
2318
def make_lock(self, name):
2319
"""Make a lock for the new control dir name."""
2320
self.step('Make %s lock' % name)
2321
ld = lockdir.LockDir(self.bzrdir.transport,
2323
file_modebits=self.file_mode,
2324
dir_modebits=self.dir_mode)
2327
def move_entry(self, new_dir, entry):
2328
"""Move then entry name into new_dir."""
2330
mandatory = entry[1]
2331
self.step('Moving %s' % name)
2333
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2334
except errors.NoSuchFile:
2338
def put_format(self, dirname, format):
2339
self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
2342
class ConvertMetaToMeta(Converter):
2343
"""Converts the components of metadirs."""
2345
def __init__(self, target_format):
2346
"""Create a metadir to metadir converter.
2348
:param target_format: The final metadir format that is desired.
2350
self.target_format = target_format
2352
def convert(self, to_convert, pb):
2353
"""See Converter.convert()."""
2354
self.bzrdir = to_convert
2358
self.step('checking repository format')
2360
repo = self.bzrdir.open_repository()
2361
except errors.NoRepositoryPresent:
2364
if not isinstance(repo._format, self.target_format.repository_format.__class__):
2365
from bzrlib.repository import CopyConverter
2366
self.pb.note('starting repository conversion')
2367
converter = CopyConverter(self.target_format.repository_format)
2368
converter.convert(repo, pb)
2370
branch = self.bzrdir.open_branch()
2371
except errors.NotBranchError:
2374
# TODO: conversions of Branch and Tree should be done by
2375
# InterXFormat lookups
2376
# Avoid circular imports
2377
from bzrlib import branch as _mod_branch
2378
if (branch._format.__class__ is _mod_branch.BzrBranchFormat5 and
2379
self.target_format.get_branch_format().__class__ is
2380
_mod_branch.BzrBranchFormat6):
2381
branch_converter = _mod_branch.Converter5to6()
2382
branch_converter.convert(branch)
2384
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
2385
except (errors.NoWorkingTree, errors.NotLocalUrl):
2388
# TODO: conversions of Branch and Tree should be done by
2389
# InterXFormat lookups
2390
if (isinstance(tree, workingtree.WorkingTree3) and
2391
not isinstance(tree, workingtree_4.WorkingTree4) and
2392
isinstance(self.target_format.workingtree_format,
2393
workingtree_4.WorkingTreeFormat4)):
2394
workingtree_4.Converter3to4().convert(tree)
2398
# This is not in remote.py because it's small, and needs to be registered.
2399
# Putting it in remote.py creates a circular import problem.
2400
# we can make it a lazy object if the control formats is turned into something
2402
class RemoteBzrDirFormat(BzrDirMetaFormat1):
2403
"""Format representing bzrdirs accessed via a smart server"""
2405
def get_format_description(self):
2406
return 'bzr remote bzrdir'
2409
def probe_transport(klass, transport):
2410
"""Return a RemoteBzrDirFormat object if it looks possible."""
2412
medium = transport.get_smart_medium()
2413
except (NotImplementedError, AttributeError,
2414
errors.TransportNotPossible, errors.NoSmartMedium):
2415
# no smart server, so not a branch for this format type.
2416
raise errors.NotBranchError(path=transport.base)
2418
# Decline to open it if the server doesn't support our required
2419
# version (2) so that the VFS-based transport will do it.
2421
server_version = medium.protocol_version()
2422
except errors.SmartProtocolError:
2423
# Apparently there's no usable smart server there, even though
2424
# the medium supports the smart protocol.
2425
raise errors.NotBranchError(path=transport.base)
2426
if server_version != 2:
2427
raise errors.NotBranchError(path=transport.base)
2430
def initialize_on_transport(self, transport):
2432
# hand off the request to the smart server
2433
client_medium = transport.get_smart_medium()
2434
except errors.NoSmartMedium:
2435
# TODO: lookup the local format from a server hint.
2436
local_dir_format = BzrDirMetaFormat1()
2437
return local_dir_format.initialize_on_transport(transport)
2438
client = _SmartClient(client_medium, transport.base)
2439
path = client.remote_path_from_transport(transport)
2440
response = client.call('BzrDirFormat.initialize', path)
2441
assert response[0] in ('ok', ), 'unexpected response code %s' % (response,)
2442
return remote.RemoteBzrDir(transport)
2444
def _open(self, transport):
2445
return remote.RemoteBzrDir(transport)
2447
def __eq__(self, other):
2448
if not isinstance(other, RemoteBzrDirFormat):
2450
return self.get_format_description() == other.get_format_description()
2453
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
2456
class BzrDirFormatInfo(object):
2458
def __init__(self, native, deprecated, hidden, experimental):
2459
self.deprecated = deprecated
2460
self.native = native
2461
self.hidden = hidden
2462
self.experimental = experimental
2465
class BzrDirFormatRegistry(registry.Registry):
2466
"""Registry of user-selectable BzrDir subformats.
2468
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
2469
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
2473
"""Create a BzrDirFormatRegistry."""
2474
self._aliases = set()
2475
super(BzrDirFormatRegistry, self).__init__()
2478
"""Return a set of the format names which are aliases."""
2479
return frozenset(self._aliases)
2481
def register_metadir(self, key,
2482
repository_format, help, native=True, deprecated=False,
2488
"""Register a metadir subformat.
2490
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
2491
by the Repository format.
2493
:param repository_format: The fully-qualified repository format class
2495
:param branch_format: Fully-qualified branch format class name as
2497
:param tree_format: Fully-qualified tree format class name as
2500
# This should be expanded to support setting WorkingTree and Branch
2501
# formats, once BzrDirMetaFormat1 supports that.
2502
def _load(full_name):
2503
mod_name, factory_name = full_name.rsplit('.', 1)
2505
mod = __import__(mod_name, globals(), locals(),
2507
except ImportError, e:
2508
raise ImportError('failed to load %s: %s' % (full_name, e))
2510
factory = getattr(mod, factory_name)
2511
except AttributeError:
2512
raise AttributeError('no factory %s in module %r'
2517
bd = BzrDirMetaFormat1()
2518
if branch_format is not None:
2519
bd.set_branch_format(_load(branch_format))
2520
if tree_format is not None:
2521
bd.workingtree_format = _load(tree_format)
2522
if repository_format is not None:
2523
bd.repository_format = _load(repository_format)
2525
self.register(key, helper, help, native, deprecated, hidden,
2526
experimental, alias)
2528
def register(self, key, factory, help, native=True, deprecated=False,
2529
hidden=False, experimental=False, alias=False):
2530
"""Register a BzrDirFormat factory.
2532
The factory must be a callable that takes one parameter: the key.
2533
It must produce an instance of the BzrDirFormat when called.
2535
This function mainly exists to prevent the info object from being
2538
registry.Registry.register(self, key, factory, help,
2539
BzrDirFormatInfo(native, deprecated, hidden, experimental))
2541
self._aliases.add(key)
2543
def register_lazy(self, key, module_name, member_name, help, native=True,
2544
deprecated=False, hidden=False, experimental=False, alias=False):
2545
registry.Registry.register_lazy(self, key, module_name, member_name,
2546
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
2548
self._aliases.add(key)
2550
def set_default(self, key):
2551
"""Set the 'default' key to be a clone of the supplied key.
2553
This method must be called once and only once.
2555
registry.Registry.register(self, 'default', self.get(key),
2556
self.get_help(key), info=self.get_info(key))
2557
self._aliases.add('default')
2559
def set_default_repository(self, key):
2560
"""Set the FormatRegistry default and Repository default.
2562
This is a transitional method while Repository.set_default_format
2565
if 'default' in self:
2566
self.remove('default')
2567
self.set_default(key)
2568
format = self.get('default')()
2569
assert isinstance(format, BzrDirMetaFormat1)
2571
def make_bzrdir(self, key):
2572
return self.get(key)()
2574
def help_topic(self, topic):
2575
output = textwrap.dedent("""\
2576
These formats can be used for creating branches, working trees, and
2580
default_realkey = None
2581
default_help = self.get_help('default')
2583
for key in self.keys():
2584
if key == 'default':
2586
help = self.get_help(key)
2587
if help == default_help:
2588
default_realkey = key
2590
help_pairs.append((key, help))
2592
def wrapped(key, help, info):
2594
help = '(native) ' + help
2595
return ':%s:\n%s\n\n' % (key,
2596
textwrap.fill(help, initial_indent=' ',
2597
subsequent_indent=' '))
2598
if default_realkey is not None:
2599
output += wrapped(default_realkey, '(default) %s' % default_help,
2600
self.get_info('default'))
2601
deprecated_pairs = []
2602
experimental_pairs = []
2603
for key, help in help_pairs:
2604
info = self.get_info(key)
2607
elif info.deprecated:
2608
deprecated_pairs.append((key, help))
2609
elif info.experimental:
2610
experimental_pairs.append((key, help))
2612
output += wrapped(key, help, info)
2613
if len(experimental_pairs) > 0:
2614
output += "Experimental formats are shown below.\n\n"
2615
for key, help in experimental_pairs:
2616
info = self.get_info(key)
2617
output += wrapped(key, help, info)
2618
if len(deprecated_pairs) > 0:
2619
output += "Deprecated formats are shown below.\n\n"
2620
for key, help in deprecated_pairs:
2621
info = self.get_info(key)
2622
output += wrapped(key, help, info)
2627
class RepositoryAcquisitionPolicy(object):
2628
"""Abstract base class for repository acquisition policies.
2630
A repository acquisition policy decides how a BzrDir acquires a repository
2631
for a branch that is being created. The most basic policy decision is
2632
whether to create a new repository or use an existing one.
2635
def configure_branch(self, branch):
2636
"""Apply any configuration data from this policy to the branch.
2638
Default implementation does nothing.
2642
def acquire_repository(self, make_working_trees=None, shared=False):
2643
"""Acquire a repository for this bzrdir.
2645
Implementations may create a new repository or use a pre-exising
2647
:param make_working_trees: If creating a repository, set
2648
make_working_trees to this value (if non-None)
2649
:param shared: If creating a repository, make it shared if True
2650
:return: A repository
2652
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
2655
class CreateRepository(RepositoryAcquisitionPolicy):
2656
"""A policy of creating a new repository"""
2658
def __init__(self, bzrdir):
2659
RepositoryAcquisitionPolicy.__init__(self)
2660
self._bzrdir = bzrdir
2662
def acquire_repository(self, make_working_trees=None, shared=False):
2663
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
2665
Creates the desired repository in the bzrdir we already have.
2667
repository = self._bzrdir.create_repository(shared=shared)
2668
if make_working_trees is not None:
2669
repository.set_make_working_trees(make_working_trees)
2673
class UseExistingRepository(RepositoryAcquisitionPolicy):
2674
"""A policy of reusing an existing repository"""
2676
def __init__(self, repository):
2677
RepositoryAcquisitionPolicy.__init__(self)
2678
self._repository = repository
2680
def acquire_repository(self, make_working_trees=None, shared=False):
2681
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
2683
Returns an existing repository to use
2685
return self._repository
2688
format_registry = BzrDirFormatRegistry()
2689
format_registry.register('weave', BzrDirFormat6,
2690
'Pre-0.8 format. Slower than knit and does not'
2691
' support checkouts or shared repositories.',
2693
format_registry.register_metadir('knit',
2694
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2695
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
2696
branch_format='bzrlib.branch.BzrBranchFormat5',
2697
tree_format='bzrlib.workingtree.WorkingTreeFormat3')
2698
format_registry.register_metadir('metaweave',
2699
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
2700
'Transitional format in 0.8. Slower than knit.',
2701
branch_format='bzrlib.branch.BzrBranchFormat5',
2702
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2704
format_registry.register_metadir('dirstate',
2705
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2706
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2707
'above when accessed over the network.',
2708
branch_format='bzrlib.branch.BzrBranchFormat5',
2709
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
2710
# directly from workingtree_4 triggers a circular import.
2711
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2713
format_registry.register_metadir('dirstate-tags',
2714
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2715
help='New in 0.15: Fast local operations and improved scaling for '
2716
'network operations. Additionally adds support for tags.'
2717
' Incompatible with bzr < 0.15.',
2718
branch_format='bzrlib.branch.BzrBranchFormat6',
2719
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2721
format_registry.register_metadir('rich-root',
2722
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
2723
help='New in 1.0. Better handling of tree roots. Incompatible with'
2725
branch_format='bzrlib.branch.BzrBranchFormat6',
2726
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2728
format_registry.register_metadir('dirstate-with-subtree',
2729
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2730
help='New in 0.15: Fast local operations and improved scaling for '
2731
'network operations. Additionally adds support for versioning nested '
2732
'bzr branches. Incompatible with bzr < 0.15.',
2733
branch_format='bzrlib.branch.BzrBranchFormat6',
2734
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2738
format_registry.register_metadir('pack-0.92',
2739
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
2740
help='New in 0.92: Pack-based format with data compatible with '
2741
'dirstate-tags format repositories. Interoperates with '
2742
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2743
'Previously called knitpack-experimental. '
2744
'For more information, see '
2745
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2746
branch_format='bzrlib.branch.BzrBranchFormat6',
2747
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2749
format_registry.register_metadir('pack-0.92-subtree',
2750
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
2751
help='New in 0.92: Pack-based format with data compatible with '
2752
'dirstate-with-subtree format repositories. Interoperates with '
2753
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2754
'Previously called knitpack-experimental. '
2755
'For more information, see '
2756
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2757
branch_format='bzrlib.branch.BzrBranchFormat6',
2758
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2762
format_registry.register_metadir('rich-root-pack',
2763
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
2764
help='New in 1.0: Pack-based format with data compatible with '
2765
'rich-root format repositories. Incompatible with'
2767
branch_format='bzrlib.branch.BzrBranchFormat6',
2768
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2770
# The following two formats should always just be aliases.
2771
format_registry.register_metadir('development',
2772
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
2773
help='Current development format. Can convert data to and from pack-0.92 '
2774
'(and anything compatible with pack-0.92) format repositories. '
2775
'Repositories in this format can only be read by bzr.dev. '
2777
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2779
branch_format='bzrlib.branch.BzrBranchFormat6',
2780
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2784
format_registry.register_metadir('development-subtree',
2785
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
2786
help='Current development format, subtree variant. Can convert data to and '
2787
'from pack-0.92 (and anything compatible with pack-0.92) format '
2788
'repositories. Repositories in this format can only be read by '
2789
'bzr.dev. Please read '
2790
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2792
branch_format='bzrlib.branch.BzrBranchFormat6',
2793
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2797
# And the development formats which the will have aliased one of follow:
2798
format_registry.register_metadir('development0',
2799
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
2800
help='Trivial rename of pack-0.92 to provide a development format. '
2802
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2804
branch_format='bzrlib.branch.BzrBranchFormat6',
2805
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2809
format_registry.register_metadir('development0-subtree',
2810
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
2811
help='Trivial rename of pack-0.92-subtree to provide a development format. '
2813
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2815
branch_format='bzrlib.branch.BzrBranchFormat6',
2816
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2820
format_registry.set_default('pack-0.92')
added
removed
bzrlib/bzrdir.py
