1
# Copyright (C) 2005, 2006, 2007, 2008 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).
98
Everything in the bzrdir should have the same file permissions.
101
def break_lock(self):
102
"""Invoke break_lock on the first object in the bzrdir.
104
If there is a tree, the tree is opened and break_lock() called.
105
Otherwise, branch is tried, and finally repository.
107
# XXX: This seems more like a UI function than something that really
108
# belongs in this class.
110
thing_to_unlock = self.open_workingtree()
111
except (errors.NotLocalUrl, errors.NoWorkingTree):
113
thing_to_unlock = self.open_branch()
114
except errors.NotBranchError:
116
thing_to_unlock = self.open_repository()
117
except errors.NoRepositoryPresent:
119
thing_to_unlock.break_lock()
121
def can_convert_format(self):
122
"""Return true if this bzrdir is one whose format we can convert from."""
125
def check_conversion_target(self, target_format):
126
target_repo_format = target_format.repository_format
127
source_repo_format = self._format.repository_format
128
source_repo_format.check_conversion_target(target_repo_format)
131
def _check_supported(format, allow_unsupported,
132
recommend_upgrade=True,
134
"""Give an error or warning on old formats.
136
:param format: may be any kind of format - workingtree, branch,
139
:param allow_unsupported: If true, allow opening
140
formats that are strongly deprecated, and which may
141
have limited functionality.
143
:param recommend_upgrade: If true (default), warn
144
the user through the ui object that they may wish
145
to upgrade the object.
147
# TODO: perhaps move this into a base Format class; it's not BzrDir
148
# specific. mbp 20070323
149
if not allow_unsupported and not format.is_supported():
150
# see open_downlevel to open legacy branches.
151
raise errors.UnsupportedFormatError(format=format)
152
if recommend_upgrade \
153
and getattr(format, 'upgrade_recommended', False):
154
ui.ui_factory.recommend_upgrade(
155
format.get_format_description(),
158
def clone(self, url, revision_id=None, force_new_repo=False):
159
"""Clone this bzrdir and its contents to url verbatim.
161
If url's last component does not exist, it will be created.
163
if revision_id is not None, then the clone operation may tune
164
itself to download less data.
165
:param force_new_repo: Do not use a shared repository for the target
166
even if one is available.
168
return self.clone_on_transport(get_transport(url),
169
revision_id=revision_id,
170
force_new_repo=force_new_repo)
172
def clone_on_transport(self, transport, revision_id=None,
173
force_new_repo=False):
174
"""Clone this bzrdir and its contents to transport verbatim.
176
If the target directory does not exist, it will be created.
178
if revision_id is not None, then the clone operation may tune
179
itself to download less data.
180
:param force_new_repo: Do not use a shared repository for the target
181
even if one is available.
183
transport.ensure_base()
184
result = self.cloning_metadir().initialize_on_transport(transport)
185
repository_policy = None
187
local_repo = self.find_repository()
188
except errors.NoRepositoryPresent:
191
# may need to copy content in
192
repository_policy = result.determine_repository_policy(
194
make_working_trees = local_repo.make_working_trees()
195
result_repo = repository_policy.acquire_repository(
196
make_working_trees, local_repo.is_shared())
197
result_repo.fetch(local_repo, revision_id=revision_id)
198
# 1 if there is a branch present
199
# make sure its content is available in the target repository
202
local_branch = self.open_branch()
203
except errors.NotBranchError:
206
result_branch = local_branch.clone(result, revision_id=revision_id)
207
if repository_policy is not None:
208
repository_policy.configure_branch(result_branch)
210
result_repo = result.find_repository()
211
except errors.NoRepositoryPresent:
213
if result_repo is None or result_repo.make_working_trees():
215
self.open_workingtree().clone(result)
216
except (errors.NoWorkingTree, errors.NotLocalUrl):
220
# TODO: This should be given a Transport, and should chdir up; otherwise
221
# this will open a new connection.
222
def _make_tail(self, url):
223
t = get_transport(url)
227
def create(cls, base, format=None, possible_transports=None):
228
"""Create a new BzrDir at the url 'base'.
230
:param format: If supplied, the format of branch to create. If not
231
supplied, the default is used.
232
:param possible_transports: If supplied, a list of transports that
233
can be reused to share a remote connection.
235
if cls is not BzrDir:
236
raise AssertionError("BzrDir.create always creates the default"
237
" format, not one of %r" % cls)
238
t = get_transport(base, possible_transports)
241
format = BzrDirFormat.get_default_format()
242
return format.initialize_on_transport(t)
245
def find_bzrdirs(transport, evaluate=None, list_current=None):
246
"""Find bzrdirs recursively from current location.
248
This is intended primarily as a building block for more sophisticated
249
functionality, like finding trees under a directory, or finding
250
branches that use a given repository.
251
:param evaluate: An optional callable that yields recurse, value,
252
where recurse controls whether this bzrdir is recursed into
253
and value is the value to yield. By default, all bzrdirs
254
are recursed into, and the return value is the bzrdir.
255
:param list_current: if supplied, use this function to list the current
256
directory, instead of Transport.list_dir
257
:return: a generator of found bzrdirs, or whatever evaluate returns.
259
if list_current is None:
260
def list_current(transport):
261
return transport.list_dir('')
263
def evaluate(bzrdir):
266
pending = [transport]
267
while len(pending) > 0:
268
current_transport = pending.pop()
271
bzrdir = BzrDir.open_from_transport(current_transport)
272
except errors.NotBranchError:
275
recurse, value = evaluate(bzrdir)
278
subdirs = list_current(current_transport)
279
except errors.NoSuchFile:
282
for subdir in sorted(subdirs, reverse=True):
283
pending.append(current_transport.clone(subdir))
286
def find_branches(transport):
287
"""Find all branches under a transport.
289
This will find all branches below the transport, including branches
290
inside other branches. Where possible, it will use
291
Repository.find_branches.
293
To list all the branches that use a particular Repository, see
294
Repository.find_branches
296
def evaluate(bzrdir):
298
repository = bzrdir.open_repository()
299
except errors.NoRepositoryPresent:
302
return False, (None, repository)
304
branch = bzrdir.open_branch()
305
except errors.NotBranchError:
306
return True, (None, None)
308
return True, (branch, None)
310
for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
312
branches.extend(repo.find_branches())
313
if branch is not None:
314
branches.append(branch)
317
def destroy_repository(self):
318
"""Destroy the repository in this BzrDir"""
319
raise NotImplementedError(self.destroy_repository)
321
def create_branch(self):
322
"""Create a branch in this BzrDir.
324
The bzrdir's format will control what branch format is created.
325
For more control see BranchFormatXX.create(a_bzrdir).
327
raise NotImplementedError(self.create_branch)
329
def destroy_branch(self):
330
"""Destroy the branch in this BzrDir"""
331
raise NotImplementedError(self.destroy_branch)
334
def create_branch_and_repo(base, force_new_repo=False, format=None):
335
"""Create a new BzrDir, Branch and Repository at the url 'base'.
337
This will use the current default BzrDirFormat unless one is
338
specified, and use whatever
339
repository format that that uses via bzrdir.create_branch and
340
create_repository. If a shared repository is available that is used
343
The created Branch object is returned.
345
:param base: The URL to create the branch at.
346
:param force_new_repo: If True a new repository is always created.
347
:param format: If supplied, the format of branch to create. If not
348
supplied, the default is used.
350
bzrdir = BzrDir.create(base, format)
351
bzrdir._find_or_create_repository(force_new_repo)
352
return bzrdir.create_branch()
354
def determine_repository_policy(self, force_new_repo=False):
355
"""Return an object representing a policy to use.
357
This controls whether a new repository is created, or a shared
358
repository used instead.
360
def repository_policy(found_bzrdir):
362
# does it have a repository ?
364
repository = found_bzrdir.open_repository()
365
except errors.NoRepositoryPresent:
368
if ((found_bzrdir.root_transport.base !=
369
self.root_transport.base) and not repository.is_shared()):
376
return UseExistingRepository(repository), True
378
return CreateRepository(self), True
380
if not force_new_repo:
381
policy = self._find_containing(repository_policy)
382
if policy is not None:
384
return CreateRepository(self)
386
def _find_or_create_repository(self, force_new_repo):
387
"""Create a new repository if needed, returning the repository."""
388
policy = self.determine_repository_policy(force_new_repo)
389
return policy.acquire_repository()
392
def create_branch_convenience(base, force_new_repo=False,
393
force_new_tree=None, format=None,
394
possible_transports=None):
395
"""Create a new BzrDir, Branch and Repository at the url 'base'.
397
This is a convenience function - it will use an existing repository
398
if possible, can be told explicitly whether to create a working tree or
401
This will use the current default BzrDirFormat unless one is
402
specified, and use whatever
403
repository format that that uses via bzrdir.create_branch and
404
create_repository. If a shared repository is available that is used
405
preferentially. Whatever repository is used, its tree creation policy
408
The created Branch object is returned.
409
If a working tree cannot be made due to base not being a file:// url,
410
no error is raised unless force_new_tree is True, in which case no
411
data is created on disk and NotLocalUrl is raised.
413
:param base: The URL to create the branch at.
414
:param force_new_repo: If True a new repository is always created.
415
:param force_new_tree: If True or False force creation of a tree or
416
prevent such creation respectively.
417
:param format: Override for the bzrdir format to create.
418
:param possible_transports: An optional reusable transports list.
421
# check for non local urls
422
t = get_transport(base, possible_transports)
423
if not isinstance(t, LocalTransport):
424
raise errors.NotLocalUrl(base)
425
bzrdir = BzrDir.create(base, format, possible_transports)
426
repo = bzrdir._find_or_create_repository(force_new_repo)
427
result = bzrdir.create_branch()
428
if force_new_tree or (repo.make_working_trees() and
429
force_new_tree is None):
431
bzrdir.create_workingtree()
432
except errors.NotLocalUrl:
437
def create_standalone_workingtree(base, format=None):
438
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
440
'base' must be a local path or a file:// url.
442
This will use the current default BzrDirFormat unless one is
443
specified, and use whatever
444
repository format that that uses for bzrdirformat.create_workingtree,
445
create_branch and create_repository.
447
:param format: Override for the bzrdir format to create.
448
:return: The WorkingTree object.
450
t = get_transport(base)
451
if not isinstance(t, LocalTransport):
452
raise errors.NotLocalUrl(base)
453
bzrdir = BzrDir.create_branch_and_repo(base,
455
format=format).bzrdir
456
return bzrdir.create_workingtree()
458
def create_workingtree(self, revision_id=None, from_branch=None,
459
accelerator_tree=None, hardlink=False):
460
"""Create a working tree at this BzrDir.
462
:param revision_id: create it as of this revision id.
463
:param from_branch: override bzrdir branch (for lightweight checkouts)
464
:param accelerator_tree: A tree which can be used for retrieving file
465
contents more quickly than the revision tree, i.e. a workingtree.
466
The revision tree will be used for cases where accelerator_tree's
467
content is different.
469
raise NotImplementedError(self.create_workingtree)
471
def retire_bzrdir(self, limit=10000):
472
"""Permanently disable the bzrdir.
474
This is done by renaming it to give the user some ability to recover
475
if there was a problem.
477
This will have horrible consequences if anyone has anything locked or
479
:param limit: number of times to retry
484
to_path = '.bzr.retired.%d' % i
485
self.root_transport.rename('.bzr', to_path)
486
note("renamed %s to %s"
487
% (self.root_transport.abspath('.bzr'), to_path))
489
except (errors.TransportError, IOError, errors.PathError):
496
def destroy_workingtree(self):
497
"""Destroy the working tree at this BzrDir.
499
Formats that do not support this may raise UnsupportedOperation.
501
raise NotImplementedError(self.destroy_workingtree)
503
def destroy_workingtree_metadata(self):
504
"""Destroy the control files for the working tree at this BzrDir.
506
The contents of working tree files are not affected.
507
Formats that do not support this may raise UnsupportedOperation.
509
raise NotImplementedError(self.destroy_workingtree_metadata)
511
def _find_containing(self, evaluate):
512
"""Find something in a containing control directory.
514
This method will scan containing control dirs, until it finds what
515
it is looking for, decides that it will never find it, or runs out
516
of containing control directories to check.
518
It is used to implement find_repository and
519
determine_repository_policy.
521
:param evaluate: A function returning (value, stop). If stop is True,
522
the value will be returned.
526
result, stop = evaluate(found_bzrdir)
529
next_transport = found_bzrdir.root_transport.clone('..')
530
if (found_bzrdir.root_transport.base == next_transport.base):
531
# top of the file system
533
# find the next containing bzrdir
535
found_bzrdir = BzrDir.open_containing_from_transport(
537
except errors.NotBranchError:
540
def find_repository(self):
541
"""Find the repository that should be used.
543
This does not require a branch as we use it to find the repo for
544
new branches as well as to hook existing branches up to their
547
def usable_repository(found_bzrdir):
548
# does it have a repository ?
550
repository = found_bzrdir.open_repository()
551
except errors.NoRepositoryPresent:
553
if found_bzrdir.root_transport.base == self.root_transport.base:
554
return repository, True
555
elif repository.is_shared():
556
return repository, True
560
found_repo = self._find_containing(usable_repository)
561
if found_repo is None:
562
raise errors.NoRepositoryPresent(self)
565
def get_branch_reference(self):
566
"""Return the referenced URL for the branch in this bzrdir.
568
:raises NotBranchError: If there is no Branch.
569
:return: The URL the branch in this bzrdir references if it is a
570
reference branch, or None for regular branches.
574
def get_branch_transport(self, branch_format):
575
"""Get the transport for use by branch format in this BzrDir.
577
Note that bzr dirs that do not support format strings will raise
578
IncompatibleFormat if the branch format they are given has
579
a format string, and vice versa.
581
If branch_format is None, the transport is returned with no
582
checking. If it is not None, then the returned transport is
583
guaranteed to point to an existing directory ready for use.
585
raise NotImplementedError(self.get_branch_transport)
587
def _find_creation_modes(self):
588
"""Determine the appropriate modes for files and directories.
590
They're always set to be consistent with the base directory,
591
assuming that this transport allows setting modes.
593
# TODO: Do we need or want an option (maybe a config setting) to turn
594
# this off or override it for particular locations? -- mbp 20080512
595
if self._mode_check_done:
597
self._mode_check_done = True
599
st = self.transport.stat('.')
600
except errors.TransportNotPossible:
601
self._dir_mode = None
602
self._file_mode = None
604
# Check the directory mode, but also make sure the created
605
# directories and files are read-write for this user. This is
606
# mostly a workaround for filesystems which lie about being able to
607
# write to a directory (cygwin & win32)
608
self._dir_mode = (st.st_mode & 07777) | 00700
609
# Remove the sticky and execute bits for files
610
self._file_mode = self._dir_mode & ~07111
612
def _get_file_mode(self):
613
"""Return Unix mode for newly created files, or None.
615
if not self._mode_check_done:
616
self._find_creation_modes()
617
return self._file_mode
619
def _get_dir_mode(self):
620
"""Return Unix mode for newly created directories, or None.
622
if not self._mode_check_done:
623
self._find_creation_modes()
624
return self._dir_mode
626
def get_repository_transport(self, repository_format):
627
"""Get the transport for use by repository format in this BzrDir.
629
Note that bzr dirs that do not support format strings will raise
630
IncompatibleFormat if the repository format they are given has
631
a format string, and vice versa.
633
If repository_format is None, the transport is returned with no
634
checking. If it is not None, then the returned transport is
635
guaranteed to point to an existing directory ready for use.
637
raise NotImplementedError(self.get_repository_transport)
639
def get_workingtree_transport(self, tree_format):
640
"""Get the transport for use by workingtree format in this BzrDir.
642
Note that bzr dirs that do not support format strings will raise
643
IncompatibleFormat if the workingtree format they are given has a
644
format string, and vice versa.
646
If workingtree_format is None, the transport is returned with no
647
checking. If it is not None, then the returned transport is
648
guaranteed to point to an existing directory ready for use.
650
raise NotImplementedError(self.get_workingtree_transport)
652
def __init__(self, _transport, _format):
653
"""Initialize a Bzr control dir object.
655
Only really common logic should reside here, concrete classes should be
656
made with varying behaviours.
658
:param _format: the format that is creating this BzrDir instance.
659
:param _transport: the transport this dir is based at.
661
self._format = _format
662
self.transport = _transport.clone('.bzr')
663
self.root_transport = _transport
664
self._mode_check_done = False
666
def is_control_filename(self, filename):
667
"""True if filename is the name of a path which is reserved for bzrdir's.
669
:param filename: A filename within the root transport of this bzrdir.
671
This is true IF and ONLY IF the filename is part of the namespace reserved
672
for bzr control dirs. Currently this is the '.bzr' directory in the root
673
of the root_transport. it is expected that plugins will need to extend
674
this in the future - for instance to make bzr talk with svn working
677
# this might be better on the BzrDirFormat class because it refers to
678
# all the possible bzrdir disk formats.
679
# This method is tested via the workingtree is_control_filename tests-
680
# it was extracted from WorkingTree.is_control_filename. If the method's
681
# contract is extended beyond the current trivial implementation, please
682
# add new tests for it to the appropriate place.
683
return filename == '.bzr' or filename.startswith('.bzr/')
685
def needs_format_conversion(self, format=None):
686
"""Return true if this bzrdir needs convert_format run on it.
688
For instance, if the repository format is out of date but the
689
branch and working tree are not, this should return True.
691
:param format: Optional parameter indicating a specific desired
692
format we plan to arrive at.
694
raise NotImplementedError(self.needs_format_conversion)
697
def open_unsupported(base):
698
"""Open a branch which is not supported."""
699
return BzrDir.open(base, _unsupported=True)
702
def open(base, _unsupported=False, possible_transports=None):
703
"""Open an existing bzrdir, rooted at 'base' (url).
705
:param _unsupported: a private parameter to the BzrDir class.
707
t = get_transport(base, possible_transports=possible_transports)
708
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
711
def open_from_transport(transport, _unsupported=False,
712
_server_formats=True):
713
"""Open a bzrdir within a particular directory.
715
:param transport: Transport containing the bzrdir.
716
:param _unsupported: private.
718
base = transport.base
720
def find_format(transport):
721
return transport, BzrDirFormat.find_format(
722
transport, _server_formats=_server_formats)
724
def redirected(transport, e, redirection_notice):
725
qualified_source = e.get_source_url()
726
relpath = transport.relpath(qualified_source)
727
if not e.target.endswith(relpath):
728
# Not redirected to a branch-format, not a branch
729
raise errors.NotBranchError(path=e.target)
730
target = e.target[:-len(relpath)]
731
note('%s is%s redirected to %s',
732
transport.base, e.permanently, target)
733
# Let's try with a new transport
734
# FIXME: If 'transport' has a qualifier, this should
735
# be applied again to the new transport *iff* the
736
# schemes used are the same. Uncomment this code
737
# once the function (and tests) exist.
739
#target = urlutils.copy_url_qualifiers(original, target)
740
return get_transport(target)
743
transport, format = do_catching_redirections(find_format,
746
except errors.TooManyRedirections:
747
raise errors.NotBranchError(base)
749
BzrDir._check_supported(format, _unsupported)
750
return format.open(transport, _found=True)
752
def open_branch(self, unsupported=False):
753
"""Open the branch object at this BzrDir if one is present.
755
If unsupported is True, then no longer supported branch formats can
758
TODO: static convenience version of this?
760
raise NotImplementedError(self.open_branch)
763
def open_containing(url, possible_transports=None):
764
"""Open an existing branch which contains url.
766
:param url: url to search from.
767
See open_containing_from_transport for more detail.
769
transport = get_transport(url, possible_transports)
770
return BzrDir.open_containing_from_transport(transport)
773
def open_containing_from_transport(a_transport):
774
"""Open an existing branch which contains a_transport.base.
776
This probes for a branch at a_transport, and searches upwards from there.
778
Basically we keep looking up until we find the control directory or
779
run into the root. If there isn't one, raises NotBranchError.
780
If there is one and it is either an unrecognised format or an unsupported
781
format, UnknownFormatError or UnsupportedFormatError are raised.
782
If there is one, it is returned, along with the unused portion of url.
784
:return: The BzrDir that contains the path, and a Unicode path
785
for the rest of the URL.
787
# this gets the normalised url back. I.e. '.' -> the full path.
788
url = a_transport.base
791
result = BzrDir.open_from_transport(a_transport)
792
return result, urlutils.unescape(a_transport.relpath(url))
793
except errors.NotBranchError, e:
796
new_t = a_transport.clone('..')
797
except errors.InvalidURLJoin:
798
# reached the root, whatever that may be
799
raise errors.NotBranchError(path=url)
800
if new_t.base == a_transport.base:
801
# reached the root, whatever that may be
802
raise errors.NotBranchError(path=url)
805
def _get_tree_branch(self):
806
"""Return the branch and tree, if any, for this bzrdir.
808
Return None for tree if not present or inaccessible.
809
Raise NotBranchError if no branch is present.
810
:return: (tree, branch)
813
tree = self.open_workingtree()
814
except (errors.NoWorkingTree, errors.NotLocalUrl):
816
branch = self.open_branch()
822
def open_tree_or_branch(klass, location):
823
"""Return the branch and working tree at a location.
825
If there is no tree at the location, tree will be None.
826
If there is no branch at the location, an exception will be
828
:return: (tree, branch)
830
bzrdir = klass.open(location)
831
return bzrdir._get_tree_branch()
834
def open_containing_tree_or_branch(klass, location):
835
"""Return the branch and working tree contained by a location.
837
Returns (tree, branch, relpath).
838
If there is no tree at containing the location, tree will be None.
839
If there is no branch containing the location, an exception will be
841
relpath is the portion of the path that is contained by the branch.
843
bzrdir, relpath = klass.open_containing(location)
844
tree, branch = bzrdir._get_tree_branch()
845
return tree, branch, relpath
847
def open_repository(self, _unsupported=False):
848
"""Open the repository object at this BzrDir if one is present.
850
This will not follow the Branch object pointer - it's strictly a direct
851
open facility. Most client code should use open_branch().repository to
854
:param _unsupported: a private parameter, not part of the api.
855
TODO: static convenience version of this?
857
raise NotImplementedError(self.open_repository)
859
def open_workingtree(self, _unsupported=False,
860
recommend_upgrade=True, from_branch=None):
861
"""Open the workingtree object at this BzrDir if one is present.
863
:param recommend_upgrade: Optional keyword parameter, when True (the
864
default), emit through the ui module a recommendation that the user
865
upgrade the working tree when the workingtree being opened is old
866
(but still fully supported).
867
:param from_branch: override bzrdir branch (for lightweight checkouts)
869
raise NotImplementedError(self.open_workingtree)
871
def has_branch(self):
872
"""Tell if this bzrdir contains a branch.
874
Note: if you're going to open the branch, you should just go ahead
875
and try, and not ask permission first. (This method just opens the
876
branch and discards it, and that's somewhat expensive.)
881
except errors.NotBranchError:
884
def has_workingtree(self):
885
"""Tell if this bzrdir contains a working tree.
887
This will still raise an exception if the bzrdir has a workingtree that
888
is remote & inaccessible.
890
Note: if you're going to open the working tree, you should just go ahead
891
and try, and not ask permission first. (This method just opens the
892
workingtree and discards it, and that's somewhat expensive.)
895
self.open_workingtree(recommend_upgrade=False)
897
except errors.NoWorkingTree:
900
def _cloning_metadir(self):
901
"""Produce a metadir suitable for cloning with."""
902
result_format = self._format.__class__()
905
branch = self.open_branch()
906
source_repository = branch.repository
907
except errors.NotBranchError:
909
source_repository = self.open_repository()
910
except errors.NoRepositoryPresent:
911
source_repository = None
913
# XXX TODO: This isinstance is here because we have not implemented
914
# the fix recommended in bug # 103195 - to delegate this choice the
916
repo_format = source_repository._format
917
if not isinstance(repo_format, remote.RemoteRepositoryFormat):
918
result_format.repository_format = repo_format
920
# TODO: Couldn't we just probe for the format in these cases,
921
# rather than opening the whole tree? It would be a little
922
# faster. mbp 20070401
923
tree = self.open_workingtree(recommend_upgrade=False)
924
except (errors.NoWorkingTree, errors.NotLocalUrl):
925
result_format.workingtree_format = None
927
result_format.workingtree_format = tree._format.__class__()
928
return result_format, source_repository
930
def cloning_metadir(self):
931
"""Produce a metadir suitable for cloning or sprouting with.
933
These operations may produce workingtrees (yes, even though they're
934
"cloning" something that doesn't have a tree), so a viable workingtree
935
format must be selected.
937
format, repository = self._cloning_metadir()
938
if format._workingtree_format is None:
939
if repository is None:
941
tree_format = repository._format._matchingbzrdir.workingtree_format
942
format.workingtree_format = tree_format.__class__()
945
def checkout_metadir(self):
946
return self.cloning_metadir()
948
def sprout(self, url, revision_id=None, force_new_repo=False,
949
recurse='down', possible_transports=None,
950
accelerator_tree=None, hardlink=False):
951
"""Create a copy of this bzrdir prepared for use as a new line of
954
If url's last component does not exist, it will be created.
956
Attributes related to the identity of the source branch like
957
branch nickname will be cleaned, a working tree is created
958
whether one existed before or not; and a local branch is always
961
if revision_id is not None, then the clone operation may tune
962
itself to download less data.
963
:param accelerator_tree: A tree which can be used for retrieving file
964
contents more quickly than the revision tree, i.e. a workingtree.
965
The revision tree will be used for cases where accelerator_tree's
966
content is different.
967
:param hardlink: If true, hard-link files from accelerator_tree,
970
target_transport = get_transport(url, possible_transports)
971
target_transport.ensure_base()
972
cloning_format = self.cloning_metadir()
973
result = cloning_format.initialize_on_transport(target_transport)
975
source_branch = self.open_branch()
976
source_repository = source_branch.repository
977
except errors.NotBranchError:
980
source_repository = self.open_repository()
981
except errors.NoRepositoryPresent:
982
source_repository = None
987
result_repo = result.find_repository()
988
except errors.NoRepositoryPresent:
990
if source_repository is None and result_repo is not None:
992
elif source_repository is None and result_repo is None:
993
# no repo available, make a new one
994
result.create_repository()
995
elif source_repository is not None and result_repo is None:
996
# have source, and want to make a new target repo
997
result_repo = source_repository.sprout(result,
998
revision_id=revision_id)
1000
# fetch needed content into target.
1001
if source_repository is not None:
1003
# source_repository.copy_content_into(result_repo,
1004
# revision_id=revision_id)
1005
# so we can override the copy method
1006
result_repo.fetch(source_repository, revision_id=revision_id)
1007
if source_branch is not None:
1008
source_branch.sprout(result, revision_id=revision_id)
1010
result.create_branch()
1011
if isinstance(target_transport, LocalTransport) and (
1012
result_repo is None or result_repo.make_working_trees()):
1013
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1017
if wt.path2id('') is None:
1019
wt.set_root_id(self.open_workingtree.get_root_id())
1020
except errors.NoWorkingTree:
1026
if recurse == 'down':
1028
basis = wt.basis_tree()
1030
subtrees = basis.iter_references()
1031
recurse_branch = wt.branch
1032
elif source_branch is not None:
1033
basis = source_branch.basis_tree()
1035
subtrees = basis.iter_references()
1036
recurse_branch = source_branch
1041
for path, file_id in subtrees:
1042
target = urlutils.join(url, urlutils.escape(path))
1043
sublocation = source_branch.reference_parent(file_id, path)
1044
sublocation.bzrdir.sprout(target,
1045
basis.get_reference_revision(file_id, path),
1046
force_new_repo=force_new_repo, recurse=recurse)
1048
if basis is not None:
1053
class BzrDirPreSplitOut(BzrDir):
1054
"""A common class for the all-in-one formats."""
1056
def __init__(self, _transport, _format):
1057
"""See BzrDir.__init__."""
1058
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1059
self._control_files = lockable_files.LockableFiles(
1060
self.get_branch_transport(None),
1061
self._format._lock_file_name,
1062
self._format._lock_class)
1064
def break_lock(self):
1065
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1066
raise NotImplementedError(self.break_lock)
1068
def cloning_metadir(self):
1069
"""Produce a metadir suitable for cloning with."""
1070
return self._format.__class__()
1072
def clone(self, url, revision_id=None, force_new_repo=False):
1073
"""See BzrDir.clone()."""
1074
from bzrlib.workingtree import WorkingTreeFormat2
1075
self._make_tail(url)
1076
result = self._format._initialize_for_clone(url)
1077
self.open_repository().clone(result, revision_id=revision_id)
1078
from_branch = self.open_branch()
1079
from_branch.clone(result, revision_id=revision_id)
1081
self.open_workingtree().clone(result)
1082
except errors.NotLocalUrl:
1083
# make a new one, this format always has to have one.
1085
WorkingTreeFormat2().initialize(result)
1086
except errors.NotLocalUrl:
1087
# but we cannot do it for remote trees.
1088
to_branch = result.open_branch()
1089
WorkingTreeFormat2().stub_initialize_remote(to_branch.control_files)
1092
def create_branch(self):
1093
"""See BzrDir.create_branch."""
1094
return self.open_branch()
1096
def destroy_branch(self):
1097
"""See BzrDir.destroy_branch."""
1098
raise errors.UnsupportedOperation(self.destroy_branch, self)
1100
def create_repository(self, shared=False):
1101
"""See BzrDir.create_repository."""
1103
raise errors.IncompatibleFormat('shared repository', self._format)
1104
return self.open_repository()
1106
def destroy_repository(self):
1107
"""See BzrDir.destroy_repository."""
1108
raise errors.UnsupportedOperation(self.destroy_repository, self)
1110
def create_workingtree(self, revision_id=None, from_branch=None,
1111
accelerator_tree=None, hardlink=False):
1112
"""See BzrDir.create_workingtree."""
1113
# this looks buggy but is not -really-
1114
# because this format creates the workingtree when the bzrdir is
1116
# clone and sprout will have set the revision_id
1117
# and that will have set it for us, its only
1118
# specific uses of create_workingtree in isolation
1119
# that can do wonky stuff here, and that only
1120
# happens for creating checkouts, which cannot be
1121
# done on this format anyway. So - acceptable wart.
1122
result = self.open_workingtree(recommend_upgrade=False)
1123
if revision_id is not None:
1124
if revision_id == _mod_revision.NULL_REVISION:
1125
result.set_parent_ids([])
1127
result.set_parent_ids([revision_id])
1130
def destroy_workingtree(self):
1131
"""See BzrDir.destroy_workingtree."""
1132
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1134
def destroy_workingtree_metadata(self):
1135
"""See BzrDir.destroy_workingtree_metadata."""
1136
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1139
def get_branch_transport(self, branch_format):
1140
"""See BzrDir.get_branch_transport()."""
1141
if branch_format is None:
1142
return self.transport
1144
branch_format.get_format_string()
1145
except NotImplementedError:
1146
return self.transport
1147
raise errors.IncompatibleFormat(branch_format, self._format)
1149
def get_repository_transport(self, repository_format):
1150
"""See BzrDir.get_repository_transport()."""
1151
if repository_format is None:
1152
return self.transport
1154
repository_format.get_format_string()
1155
except NotImplementedError:
1156
return self.transport
1157
raise errors.IncompatibleFormat(repository_format, self._format)
1159
def get_workingtree_transport(self, workingtree_format):
1160
"""See BzrDir.get_workingtree_transport()."""
1161
if workingtree_format is None:
1162
return self.transport
1164
workingtree_format.get_format_string()
1165
except NotImplementedError:
1166
return self.transport
1167
raise errors.IncompatibleFormat(workingtree_format, self._format)
1169
def needs_format_conversion(self, format=None):
1170
"""See BzrDir.needs_format_conversion()."""
1171
# if the format is not the same as the system default,
1172
# an upgrade is needed.
1174
format = BzrDirFormat.get_default_format()
1175
return not isinstance(self._format, format.__class__)
1177
def open_branch(self, unsupported=False):
1178
"""See BzrDir.open_branch."""
1179
from bzrlib.branch import BzrBranchFormat4
1180
format = BzrBranchFormat4()
1181
self._check_supported(format, unsupported)
1182
return format.open(self, _found=True)
1184
def sprout(self, url, revision_id=None, force_new_repo=False,
1185
possible_transports=None, accelerator_tree=None,
1187
"""See BzrDir.sprout()."""
1188
from bzrlib.workingtree import WorkingTreeFormat2
1189
self._make_tail(url)
1190
result = self._format._initialize_for_clone(url)
1192
self.open_repository().clone(result, revision_id=revision_id)
1193
except errors.NoRepositoryPresent:
1196
self.open_branch().sprout(result, revision_id=revision_id)
1197
except errors.NotBranchError:
1199
# we always want a working tree
1200
WorkingTreeFormat2().initialize(result,
1201
accelerator_tree=accelerator_tree,
1206
class BzrDir4(BzrDirPreSplitOut):
1207
"""A .bzr version 4 control object.
1209
This is a deprecated format and may be removed after sept 2006.
1212
def create_repository(self, shared=False):
1213
"""See BzrDir.create_repository."""
1214
return self._format.repository_format.initialize(self, shared)
1216
def needs_format_conversion(self, format=None):
1217
"""Format 4 dirs are always in need of conversion."""
1220
def open_repository(self):
1221
"""See BzrDir.open_repository."""
1222
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1223
return RepositoryFormat4().open(self, _found=True)
1226
class BzrDir5(BzrDirPreSplitOut):
1227
"""A .bzr version 5 control object.
1229
This is a deprecated format and may be removed after sept 2006.
1232
def open_repository(self):
1233
"""See BzrDir.open_repository."""
1234
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1235
return RepositoryFormat5().open(self, _found=True)
1237
def open_workingtree(self, _unsupported=False,
1238
recommend_upgrade=True):
1239
"""See BzrDir.create_workingtree."""
1240
from bzrlib.workingtree import WorkingTreeFormat2
1241
wt_format = WorkingTreeFormat2()
1242
# we don't warn here about upgrades; that ought to be handled for the
1244
return wt_format.open(self, _found=True)
1247
class BzrDir6(BzrDirPreSplitOut):
1248
"""A .bzr version 6 control object.
1250
This is a deprecated format and may be removed after sept 2006.
1253
def open_repository(self):
1254
"""See BzrDir.open_repository."""
1255
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1256
return RepositoryFormat6().open(self, _found=True)
1258
def open_workingtree(self, _unsupported=False,
1259
recommend_upgrade=True):
1260
"""See BzrDir.create_workingtree."""
1261
# we don't warn here about upgrades; that ought to be handled for the
1263
from bzrlib.workingtree import WorkingTreeFormat2
1264
return WorkingTreeFormat2().open(self, _found=True)
1267
class BzrDirMeta1(BzrDir):
1268
"""A .bzr meta version 1 control object.
1270
This is the first control object where the
1271
individual aspects are really split out: there are separate repository,
1272
workingtree and branch subdirectories and any subset of the three can be
1273
present within a BzrDir.
1276
def can_convert_format(self):
1277
"""See BzrDir.can_convert_format()."""
1280
def create_branch(self):
1281
"""See BzrDir.create_branch."""
1282
return self._format.get_branch_format().initialize(self)
1284
def destroy_branch(self):
1285
"""See BzrDir.create_branch."""
1286
self.transport.delete_tree('branch')
1288
def create_repository(self, shared=False):
1289
"""See BzrDir.create_repository."""
1290
return self._format.repository_format.initialize(self, shared)
1292
def destroy_repository(self):
1293
"""See BzrDir.destroy_repository."""
1294
self.transport.delete_tree('repository')
1296
def create_workingtree(self, revision_id=None, from_branch=None,
1297
accelerator_tree=None, hardlink=False):
1298
"""See BzrDir.create_workingtree."""
1299
return self._format.workingtree_format.initialize(
1300
self, revision_id, from_branch=from_branch,
1301
accelerator_tree=accelerator_tree, hardlink=hardlink)
1303
def destroy_workingtree(self):
1304
"""See BzrDir.destroy_workingtree."""
1305
wt = self.open_workingtree(recommend_upgrade=False)
1306
repository = wt.branch.repository
1307
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1308
wt.revert(old_tree=empty)
1309
self.destroy_workingtree_metadata()
1311
def destroy_workingtree_metadata(self):
1312
self.transport.delete_tree('checkout')
1314
def find_branch_format(self):
1315
"""Find the branch 'format' for this bzrdir.
1317
This might be a synthetic object for e.g. RemoteBranch and SVN.
1319
from bzrlib.branch import BranchFormat
1320
return BranchFormat.find_format(self)
1322
def _get_mkdir_mode(self):
1323
"""Figure out the mode to use when creating a bzrdir subdir."""
1324
temp_control = lockable_files.LockableFiles(self.transport, '',
1325
lockable_files.TransportLock)
1326
return temp_control._dir_mode
1328
def get_branch_reference(self):
1329
"""See BzrDir.get_branch_reference()."""
1330
from bzrlib.branch import BranchFormat
1331
format = BranchFormat.find_format(self)
1332
return format.get_reference(self)
1334
def get_branch_transport(self, branch_format):
1335
"""See BzrDir.get_branch_transport()."""
1336
if branch_format is None:
1337
return self.transport.clone('branch')
1339
branch_format.get_format_string()
1340
except NotImplementedError:
1341
raise errors.IncompatibleFormat(branch_format, self._format)
1343
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1344
except errors.FileExists:
1346
return self.transport.clone('branch')
1348
def get_repository_transport(self, repository_format):
1349
"""See BzrDir.get_repository_transport()."""
1350
if repository_format is None:
1351
return self.transport.clone('repository')
1353
repository_format.get_format_string()
1354
except NotImplementedError:
1355
raise errors.IncompatibleFormat(repository_format, self._format)
1357
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1358
except errors.FileExists:
1360
return self.transport.clone('repository')
1362
def get_workingtree_transport(self, workingtree_format):
1363
"""See BzrDir.get_workingtree_transport()."""
1364
if workingtree_format is None:
1365
return self.transport.clone('checkout')
1367
workingtree_format.get_format_string()
1368
except NotImplementedError:
1369
raise errors.IncompatibleFormat(workingtree_format, self._format)
1371
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1372
except errors.FileExists:
1374
return self.transport.clone('checkout')
1376
def needs_format_conversion(self, format=None):
1377
"""See BzrDir.needs_format_conversion()."""
1379
format = BzrDirFormat.get_default_format()
1380
if not isinstance(self._format, format.__class__):
1381
# it is not a meta dir format, conversion is needed.
1383
# we might want to push this down to the repository?
1385
if not isinstance(self.open_repository()._format,
1386
format.repository_format.__class__):
1387
# the repository needs an upgrade.
1389
except errors.NoRepositoryPresent:
1392
if not isinstance(self.open_branch()._format,
1393
format.get_branch_format().__class__):
1394
# the branch needs an upgrade.
1396
except errors.NotBranchError:
1399
my_wt = self.open_workingtree(recommend_upgrade=False)
1400
if not isinstance(my_wt._format,
1401
format.workingtree_format.__class__):
1402
# the workingtree needs an upgrade.
1404
except (errors.NoWorkingTree, errors.NotLocalUrl):
1408
def open_branch(self, unsupported=False):
1409
"""See BzrDir.open_branch."""
1410
format = self.find_branch_format()
1411
self._check_supported(format, unsupported)
1412
return format.open(self, _found=True)
1414
def open_repository(self, unsupported=False):
1415
"""See BzrDir.open_repository."""
1416
from bzrlib.repository import RepositoryFormat
1417
format = RepositoryFormat.find_format(self)
1418
self._check_supported(format, unsupported)
1419
return format.open(self, _found=True)
1421
def open_workingtree(self, unsupported=False,
1422
recommend_upgrade=True):
1423
"""See BzrDir.open_workingtree."""
1424
from bzrlib.workingtree import WorkingTreeFormat
1425
format = WorkingTreeFormat.find_format(self)
1426
self._check_supported(format, unsupported,
1428
basedir=self.root_transport.base)
1429
return format.open(self, _found=True)
1432
class BzrDirFormat(object):
1433
"""An encapsulation of the initialization and open routines for a format.
1435
Formats provide three things:
1436
* An initialization routine,
1440
Formats are placed in a dict by their format string for reference
1441
during bzrdir opening. These should be subclasses of BzrDirFormat
1444
Once a format is deprecated, just deprecate the initialize and open
1445
methods on the format class. Do not deprecate the object, as the
1446
object will be created every system load.
1449
_default_format = None
1450
"""The default format used for new .bzr dirs."""
1453
"""The known formats."""
1455
_control_formats = []
1456
"""The registered control formats - .bzr, ....
1458
This is a list of BzrDirFormat objects.
1461
_control_server_formats = []
1462
"""The registered control server formats, e.g. RemoteBzrDirs.
1464
This is a list of BzrDirFormat objects.
1467
_lock_file_name = 'branch-lock'
1469
# _lock_class must be set in subclasses to the lock type, typ.
1470
# TransportLock or LockDir
1473
def find_format(klass, transport, _server_formats=True):
1474
"""Return the format present at transport."""
1476
formats = klass._control_server_formats + klass._control_formats
1478
formats = klass._control_formats
1479
for format in formats:
1481
return format.probe_transport(transport)
1482
except errors.NotBranchError:
1483
# this format does not find a control dir here.
1485
raise errors.NotBranchError(path=transport.base)
1488
def probe_transport(klass, transport):
1489
"""Return the .bzrdir style format present in a directory."""
1491
format_string = transport.get(".bzr/branch-format").read()
1492
except errors.NoSuchFile:
1493
raise errors.NotBranchError(path=transport.base)
1496
return klass._formats[format_string]
1498
raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1501
def get_default_format(klass):
1502
"""Return the current default format."""
1503
return klass._default_format
1505
def get_format_string(self):
1506
"""Return the ASCII format string that identifies this format."""
1507
raise NotImplementedError(self.get_format_string)
1509
def get_format_description(self):
1510
"""Return the short description for this format."""
1511
raise NotImplementedError(self.get_format_description)
1513
def get_converter(self, format=None):
1514
"""Return the converter to use to convert bzrdirs needing converts.
1516
This returns a bzrlib.bzrdir.Converter object.
1518
This should return the best upgrader to step this format towards the
1519
current default format. In the case of plugins we can/should provide
1520
some means for them to extend the range of returnable converters.
1522
:param format: Optional format to override the default format of the
1525
raise NotImplementedError(self.get_converter)
1527
def initialize(self, url, possible_transports=None):
1528
"""Create a bzr control dir at this url and return an opened copy.
1530
Subclasses should typically override initialize_on_transport
1531
instead of this method.
1533
return self.initialize_on_transport(get_transport(url,
1534
possible_transports))
1536
def initialize_on_transport(self, transport):
1537
"""Initialize a new bzrdir in the base directory of a Transport."""
1538
# Since we don't have a .bzr directory, inherit the
1539
# mode from the root directory
1540
temp_control = lockable_files.LockableFiles(transport,
1541
'', lockable_files.TransportLock)
1542
temp_control._transport.mkdir('.bzr',
1543
# FIXME: RBC 20060121 don't peek under
1545
mode=temp_control._dir_mode)
1546
if sys.platform == 'win32' and isinstance(transport, LocalTransport):
1547
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1548
file_mode = temp_control._file_mode
1550
mutter('created control directory in ' + transport.base)
1551
control = transport.clone('.bzr')
1552
utf8_files = [('README',
1553
"This is a Bazaar control directory.\n"
1554
"Do not change any files in this directory.\n"
1555
"See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
1556
('branch-format', self.get_format_string()),
1558
# NB: no need to escape relative paths that are url safe.
1559
control_files = lockable_files.LockableFiles(control,
1560
self._lock_file_name, self._lock_class)
1561
control_files.create_lock()
1562
control_files.lock_write()
1564
for file, content in utf8_files:
1565
control_files.put_utf8(file, content)
1567
control_files.unlock()
1568
return self.open(transport, _found=True)
1570
def is_supported(self):
1571
"""Is this format supported?
1573
Supported formats must be initializable and openable.
1574
Unsupported formats may not support initialization or committing or
1575
some other features depending on the reason for not being supported.
1579
def same_model(self, target_format):
1580
return (self.repository_format.rich_root_data ==
1581
target_format.rich_root_data)
1584
def known_formats(klass):
1585
"""Return all the known formats.
1587
Concrete formats should override _known_formats.
1589
# There is double indirection here to make sure that control
1590
# formats used by more than one dir format will only be probed
1591
# once. This can otherwise be quite expensive for remote connections.
1593
for format in klass._control_formats:
1594
result.update(format._known_formats())
1598
def _known_formats(klass):
1599
"""Return the known format instances for this control format."""
1600
return set(klass._formats.values())
1602
def open(self, transport, _found=False):
1603
"""Return an instance of this format for the dir transport points at.
1605
_found is a private parameter, do not use it.
1608
found_format = BzrDirFormat.find_format(transport)
1609
if not isinstance(found_format, self.__class__):
1610
raise AssertionError("%s was asked to open %s, but it seems to need "
1612
% (self, transport, found_format))
1613
return self._open(transport)
1615
def _open(self, transport):
1616
"""Template method helper for opening BzrDirectories.
1618
This performs the actual open and any additional logic or parameter
1621
raise NotImplementedError(self._open)
1624
def register_format(klass, format):
1625
klass._formats[format.get_format_string()] = format
1628
def register_control_format(klass, format):
1629
"""Register a format that does not use '.bzr' for its control dir.
1631
TODO: This should be pulled up into a 'ControlDirFormat' base class
1632
which BzrDirFormat can inherit from, and renamed to register_format
1633
there. It has been done without that for now for simplicity of
1636
klass._control_formats.append(format)
1639
def register_control_server_format(klass, format):
1640
"""Register a control format for client-server environments.
1642
These formats will be tried before ones registered with
1643
register_control_format. This gives implementations that decide to the
1644
chance to grab it before anything looks at the contents of the format
1647
klass._control_server_formats.append(format)
1650
def _set_default_format(klass, format):
1651
"""Set default format (for testing behavior of defaults only)"""
1652
klass._default_format = format
1656
return self.get_format_string().rstrip()
1659
def unregister_format(klass, format):
1660
del klass._formats[format.get_format_string()]
1663
def unregister_control_format(klass, format):
1664
klass._control_formats.remove(format)
1667
class BzrDirFormat4(BzrDirFormat):
1668
"""Bzr dir format 4.
1670
This format is a combined format for working tree, branch and repository.
1672
- Format 1 working trees [always]
1673
- Format 4 branches [always]
1674
- Format 4 repositories [always]
1676
This format is deprecated: it indexes texts using a text it which is
1677
removed in format 5; write support for this format has been removed.
1680
_lock_class = lockable_files.TransportLock
1682
def get_format_string(self):
1683
"""See BzrDirFormat.get_format_string()."""
1684
return "Bazaar-NG branch, format 0.0.4\n"
1686
def get_format_description(self):
1687
"""See BzrDirFormat.get_format_description()."""
1688
return "All-in-one format 4"
1690
def get_converter(self, format=None):
1691
"""See BzrDirFormat.get_converter()."""
1692
# there is one and only one upgrade path here.
1693
return ConvertBzrDir4To5()
1695
def initialize_on_transport(self, transport):
1696
"""Format 4 branches cannot be created."""
1697
raise errors.UninitializableFormat(self)
1699
def is_supported(self):
1700
"""Format 4 is not supported.
1702
It is not supported because the model changed from 4 to 5 and the
1703
conversion logic is expensive - so doing it on the fly was not
1708
def _open(self, transport):
1709
"""See BzrDirFormat._open."""
1710
return BzrDir4(transport, self)
1712
def __return_repository_format(self):
1713
"""Circular import protection."""
1714
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1715
return RepositoryFormat4()
1716
repository_format = property(__return_repository_format)
1719
class BzrDirFormat5(BzrDirFormat):
1720
"""Bzr control format 5.
1722
This format is a combined format for working tree, branch and repository.
1724
- Format 2 working trees [always]
1725
- Format 4 branches [always]
1726
- Format 5 repositories [always]
1727
Unhashed stores in the repository.
1730
_lock_class = lockable_files.TransportLock
1732
def get_format_string(self):
1733
"""See BzrDirFormat.get_format_string()."""
1734
return "Bazaar-NG branch, format 5\n"
1736
def get_format_description(self):
1737
"""See BzrDirFormat.get_format_description()."""
1738
return "All-in-one format 5"
1740
def get_converter(self, format=None):
1741
"""See BzrDirFormat.get_converter()."""
1742
# there is one and only one upgrade path here.
1743
return ConvertBzrDir5To6()
1745
def _initialize_for_clone(self, url):
1746
return self.initialize_on_transport(get_transport(url), _cloning=True)
1748
def initialize_on_transport(self, transport, _cloning=False):
1749
"""Format 5 dirs always have working tree, branch and repository.
1751
Except when they are being cloned.
1753
from bzrlib.branch import BzrBranchFormat4
1754
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1755
from bzrlib.workingtree import WorkingTreeFormat2
1756
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1757
RepositoryFormat5().initialize(result, _internal=True)
1759
branch = BzrBranchFormat4().initialize(result)
1761
WorkingTreeFormat2().initialize(result)
1762
except errors.NotLocalUrl:
1763
# Even though we can't access the working tree, we need to
1764
# create its control files.
1765
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1768
def _open(self, transport):
1769
"""See BzrDirFormat._open."""
1770
return BzrDir5(transport, self)
1772
def __return_repository_format(self):
1773
"""Circular import protection."""
1774
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1775
return RepositoryFormat5()
1776
repository_format = property(__return_repository_format)
1779
class BzrDirFormat6(BzrDirFormat):
1780
"""Bzr control format 6.
1782
This format is a combined format for working tree, branch and repository.
1784
- Format 2 working trees [always]
1785
- Format 4 branches [always]
1786
- Format 6 repositories [always]
1789
_lock_class = lockable_files.TransportLock
1791
def get_format_string(self):
1792
"""See BzrDirFormat.get_format_string()."""
1793
return "Bazaar-NG branch, format 6\n"
1795
def get_format_description(self):
1796
"""See BzrDirFormat.get_format_description()."""
1797
return "All-in-one format 6"
1799
def get_converter(self, format=None):
1800
"""See BzrDirFormat.get_converter()."""
1801
# there is one and only one upgrade path here.
1802
return ConvertBzrDir6ToMeta()
1804
def _initialize_for_clone(self, url):
1805
return self.initialize_on_transport(get_transport(url), _cloning=True)
1807
def initialize_on_transport(self, transport, _cloning=False):
1808
"""Format 6 dirs always have working tree, branch and repository.
1810
Except when they are being cloned.
1812
from bzrlib.branch import BzrBranchFormat4
1813
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1814
from bzrlib.workingtree import WorkingTreeFormat2
1815
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1816
RepositoryFormat6().initialize(result, _internal=True)
1818
branch = BzrBranchFormat4().initialize(result)
1820
WorkingTreeFormat2().initialize(result)
1821
except errors.NotLocalUrl:
1822
# Even though we can't access the working tree, we need to
1823
# create its control files.
1824
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1827
def _open(self, transport):
1828
"""See BzrDirFormat._open."""
1829
return BzrDir6(transport, self)
1831
def __return_repository_format(self):
1832
"""Circular import protection."""
1833
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1834
return RepositoryFormat6()
1835
repository_format = property(__return_repository_format)
1838
class BzrDirMetaFormat1(BzrDirFormat):
1839
"""Bzr meta control format 1
1841
This is the first format with split out working tree, branch and repository
1844
- Format 3 working trees [optional]
1845
- Format 5 branches [optional]
1846
- Format 7 repositories [optional]
1849
_lock_class = lockdir.LockDir
1852
self._workingtree_format = None
1853
self._branch_format = None
1855
def __eq__(self, other):
1856
if other.__class__ is not self.__class__:
1858
if other.repository_format != self.repository_format:
1860
if other.workingtree_format != self.workingtree_format:
1864
def __ne__(self, other):
1865
return not self == other
1867
def get_branch_format(self):
1868
if self._branch_format is None:
1869
from bzrlib.branch import BranchFormat
1870
self._branch_format = BranchFormat.get_default_format()
1871
return self._branch_format
1873
def set_branch_format(self, format):
1874
self._branch_format = format
1876
def get_converter(self, format=None):
1877
"""See BzrDirFormat.get_converter()."""
1879
format = BzrDirFormat.get_default_format()
1880
if not isinstance(self, format.__class__):
1881
# converting away from metadir is not implemented
1882
raise NotImplementedError(self.get_converter)
1883
return ConvertMetaToMeta(format)
1885
def get_format_string(self):
1886
"""See BzrDirFormat.get_format_string()."""
1887
return "Bazaar-NG meta directory, format 1\n"
1889
def get_format_description(self):
1890
"""See BzrDirFormat.get_format_description()."""
1891
return "Meta directory format 1"
1893
def _open(self, transport):
1894
"""See BzrDirFormat._open."""
1895
return BzrDirMeta1(transport, self)
1897
def __return_repository_format(self):
1898
"""Circular import protection."""
1899
if getattr(self, '_repository_format', None):
1900
return self._repository_format
1901
from bzrlib.repository import RepositoryFormat
1902
return RepositoryFormat.get_default_format()
1904
def __set_repository_format(self, value):
1905
"""Allow changing the repository format for metadir formats."""
1906
self._repository_format = value
1908
repository_format = property(__return_repository_format, __set_repository_format)
1910
def __get_workingtree_format(self):
1911
if self._workingtree_format is None:
1912
from bzrlib.workingtree import WorkingTreeFormat
1913
self._workingtree_format = WorkingTreeFormat.get_default_format()
1914
return self._workingtree_format
1916
def __set_workingtree_format(self, wt_format):
1917
self._workingtree_format = wt_format
1919
workingtree_format = property(__get_workingtree_format,
1920
__set_workingtree_format)
1923
# Register bzr control format
1924
BzrDirFormat.register_control_format(BzrDirFormat)
1926
# Register bzr formats
1927
BzrDirFormat.register_format(BzrDirFormat4())
1928
BzrDirFormat.register_format(BzrDirFormat5())
1929
BzrDirFormat.register_format(BzrDirFormat6())
1930
__default_format = BzrDirMetaFormat1()
1931
BzrDirFormat.register_format(__default_format)
1932
BzrDirFormat._default_format = __default_format
1935
class Converter(object):
1936
"""Converts a disk format object from one format to another."""
1938
def convert(self, to_convert, pb):
1939
"""Perform the conversion of to_convert, giving feedback via pb.
1941
:param to_convert: The disk object to convert.
1942
:param pb: a progress bar to use for progress information.
1945
def step(self, message):
1946
"""Update the pb by a step."""
1948
self.pb.update(message, self.count, self.total)
1951
class ConvertBzrDir4To5(Converter):
1952
"""Converts format 4 bzr dirs to format 5."""
1955
super(ConvertBzrDir4To5, self).__init__()
1956
self.converted_revs = set()
1957
self.absent_revisions = set()
1961
def convert(self, to_convert, pb):
1962
"""See Converter.convert()."""
1963
self.bzrdir = to_convert
1965
self.pb.note('starting upgrade from format 4 to 5')
1966
if isinstance(self.bzrdir.transport, LocalTransport):
1967
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
1968
self._convert_to_weaves()
1969
return BzrDir.open(self.bzrdir.root_transport.base)
1971
def _convert_to_weaves(self):
1972
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
1975
stat = self.bzrdir.transport.stat('weaves')
1976
if not S_ISDIR(stat.st_mode):
1977
self.bzrdir.transport.delete('weaves')
1978
self.bzrdir.transport.mkdir('weaves')
1979
except errors.NoSuchFile:
1980
self.bzrdir.transport.mkdir('weaves')
1981
# deliberately not a WeaveFile as we want to build it up slowly.
1982
self.inv_weave = Weave('inventory')
1983
# holds in-memory weaves for all files
1984
self.text_weaves = {}
1985
self.bzrdir.transport.delete('branch-format')
1986
self.branch = self.bzrdir.open_branch()
1987
self._convert_working_inv()
1988
rev_history = self.branch.revision_history()
1989
# to_read is a stack holding the revisions we still need to process;
1990
# appending to it adds new highest-priority revisions
1991
self.known_revisions = set(rev_history)
1992
self.to_read = rev_history[-1:]
1994
rev_id = self.to_read.pop()
1995
if (rev_id not in self.revisions
1996
and rev_id not in self.absent_revisions):
1997
self._load_one_rev(rev_id)
1999
to_import = self._make_order()
2000
for i, rev_id in enumerate(to_import):
2001
self.pb.update('converting revision', i, len(to_import))
2002
self._convert_one_rev(rev_id)
2004
self._write_all_weaves()
2005
self._write_all_revs()
2006
self.pb.note('upgraded to weaves:')
2007
self.pb.note(' %6d revisions and inventories', len(self.revisions))
2008
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
2009
self.pb.note(' %6d texts', self.text_count)
2010
self._cleanup_spare_files_after_format4()
2011
self.branch.control_files.put_utf8('branch-format', BzrDirFormat5().get_format_string())
2013
def _cleanup_spare_files_after_format4(self):
2014
# FIXME working tree upgrade foo.
2015
for n in 'merged-patches', 'pending-merged-patches':
2017
## assert os.path.getsize(p) == 0
2018
self.bzrdir.transport.delete(n)
2019
except errors.NoSuchFile:
2021
self.bzrdir.transport.delete_tree('inventory-store')
2022
self.bzrdir.transport.delete_tree('text-store')
2024
def _convert_working_inv(self):
2025
inv = xml4.serializer_v4.read_inventory(
2026
self.branch.control_files.get('inventory'))
2027
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2028
# FIXME inventory is a working tree change.
2029
self.branch.control_files.put('inventory', StringIO(new_inv_xml))
2031
def _write_all_weaves(self):
2032
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2033
weave_transport = self.bzrdir.transport.clone('weaves')
2034
weaves = WeaveStore(weave_transport, prefixed=False)
2035
transaction = WriteTransaction()
2039
for file_id, file_weave in self.text_weaves.items():
2040
self.pb.update('writing weave', i, len(self.text_weaves))
2041
weaves._put_weave(file_id, file_weave, transaction)
2043
self.pb.update('inventory', 0, 1)
2044
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2045
self.pb.update('inventory', 1, 1)
2049
def _write_all_revs(self):
2050
"""Write all revisions out in new form."""
2051
self.bzrdir.transport.delete_tree('revision-store')
2052
self.bzrdir.transport.mkdir('revision-store')
2053
revision_transport = self.bzrdir.transport.clone('revision-store')
2055
_revision_store = TextRevisionStore(TextStore(revision_transport,
2059
transaction = WriteTransaction()
2060
for i, rev_id in enumerate(self.converted_revs):
2061
self.pb.update('write revision', i, len(self.converted_revs))
2062
_revision_store.add_revision(self.revisions[rev_id], transaction)
2066
def _load_one_rev(self, rev_id):
2067
"""Load a revision object into memory.
2069
Any parents not either loaded or abandoned get queued to be
2071
self.pb.update('loading revision',
2072
len(self.revisions),
2073
len(self.known_revisions))
2074
if not self.branch.repository.has_revision(rev_id):
2076
self.pb.note('revision {%s} not present in branch; '
2077
'will be converted as a ghost',
2079
self.absent_revisions.add(rev_id)
2081
rev = self.branch.repository._revision_store.get_revision(rev_id,
2082
self.branch.repository.get_transaction())
2083
for parent_id in rev.parent_ids:
2084
self.known_revisions.add(parent_id)
2085
self.to_read.append(parent_id)
2086
self.revisions[rev_id] = rev
2088
def _load_old_inventory(self, rev_id):
2089
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2090
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2091
inv.revision_id = rev_id
2092
rev = self.revisions[rev_id]
2095
def _load_updated_inventory(self, rev_id):
2096
inv_xml = self.inv_weave.get_text(rev_id)
2097
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2100
def _convert_one_rev(self, rev_id):
2101
"""Convert revision and all referenced objects to new format."""
2102
rev = self.revisions[rev_id]
2103
inv = self._load_old_inventory(rev_id)
2104
present_parents = [p for p in rev.parent_ids
2105
if p not in self.absent_revisions]
2106
self._convert_revision_contents(rev, inv, present_parents)
2107
self._store_new_inv(rev, inv, present_parents)
2108
self.converted_revs.add(rev_id)
2110
def _store_new_inv(self, rev, inv, present_parents):
2111
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2112
new_inv_sha1 = sha_string(new_inv_xml)
2113
self.inv_weave.add_lines(rev.revision_id,
2115
new_inv_xml.splitlines(True))
2116
rev.inventory_sha1 = new_inv_sha1
2118
def _convert_revision_contents(self, rev, inv, present_parents):
2119
"""Convert all the files within a revision.
2121
Also upgrade the inventory to refer to the text revision ids."""
2122
rev_id = rev.revision_id
2123
mutter('converting texts of revision {%s}',
2125
parent_invs = map(self._load_updated_inventory, present_parents)
2126
entries = inv.iter_entries()
2128
for path, ie in entries:
2129
self._convert_file_version(rev, ie, parent_invs)
2131
def _convert_file_version(self, rev, ie, parent_invs):
2132
"""Convert one version of one file.
2134
The file needs to be added into the weave if it is a merge
2135
of >=2 parents or if it's changed from its parent.
2137
file_id = ie.file_id
2138
rev_id = rev.revision_id
2139
w = self.text_weaves.get(file_id)
2142
self.text_weaves[file_id] = w
2143
text_changed = False
2144
parent_candiate_entries = ie.parent_candidates(parent_invs)
2145
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2146
# XXX: Note that this is unordered - and this is tolerable because
2147
# the previous code was also unordered.
2148
previous_entries = dict((head, parent_candiate_entries[head]) for head
2150
self.snapshot_ie(previous_entries, ie, w, rev_id)
2153
@symbol_versioning.deprecated_method(symbol_versioning.one_one)
2154
def get_parents(self, revision_ids):
2155
for revision_id in revision_ids:
2156
yield self.revisions[revision_id].parent_ids
2158
def get_parent_map(self, revision_ids):
2159
"""See graph._StackedParentsProvider.get_parent_map"""
2160
return dict((revision_id, self.revisions[revision_id])
2161
for revision_id in revision_ids
2162
if revision_id in self.revisions)
2164
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2165
# TODO: convert this logic, which is ~= snapshot to
2166
# a call to:. This needs the path figured out. rather than a work_tree
2167
# a v4 revision_tree can be given, or something that looks enough like
2168
# one to give the file content to the entry if it needs it.
2169
# and we need something that looks like a weave store for snapshot to
2171
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2172
if len(previous_revisions) == 1:
2173
previous_ie = previous_revisions.values()[0]
2174
if ie._unchanged(previous_ie):
2175
ie.revision = previous_ie.revision
2178
text = self.branch.repository.weave_store.get(ie.text_id)
2179
file_lines = text.readlines()
2180
w.add_lines(rev_id, previous_revisions, file_lines)
2181
self.text_count += 1
2183
w.add_lines(rev_id, previous_revisions, [])
2184
ie.revision = rev_id
2186
def _make_order(self):
2187
"""Return a suitable order for importing revisions.
2189
The order must be such that an revision is imported after all
2190
its (present) parents.
2192
todo = set(self.revisions.keys())
2193
done = self.absent_revisions.copy()
2196
# scan through looking for a revision whose parents
2198
for rev_id in sorted(list(todo)):
2199
rev = self.revisions[rev_id]
2200
parent_ids = set(rev.parent_ids)
2201
if parent_ids.issubset(done):
2202
# can take this one now
2203
order.append(rev_id)
2209
class ConvertBzrDir5To6(Converter):
2210
"""Converts format 5 bzr dirs to format 6."""
2212
def convert(self, to_convert, pb):
2213
"""See Converter.convert()."""
2214
self.bzrdir = to_convert
2216
self.pb.note('starting upgrade from format 5 to 6')
2217
self._convert_to_prefixed()
2218
return BzrDir.open(self.bzrdir.root_transport.base)
2220
def _convert_to_prefixed(self):
2221
from bzrlib.store import TransportStore
2222
self.bzrdir.transport.delete('branch-format')
2223
for store_name in ["weaves", "revision-store"]:
2224
self.pb.note("adding prefixes to %s" % store_name)
2225
store_transport = self.bzrdir.transport.clone(store_name)
2226
store = TransportStore(store_transport, prefixed=True)
2227
for urlfilename in store_transport.list_dir('.'):
2228
filename = urlutils.unescape(urlfilename)
2229
if (filename.endswith(".weave") or
2230
filename.endswith(".gz") or
2231
filename.endswith(".sig")):
2232
file_id = os.path.splitext(filename)[0]
2235
prefix_dir = store.hash_prefix(file_id)
2236
# FIXME keep track of the dirs made RBC 20060121
2238
store_transport.move(filename, prefix_dir + '/' + filename)
2239
except errors.NoSuchFile: # catches missing dirs strangely enough
2240
store_transport.mkdir(prefix_dir)
2241
store_transport.move(filename, prefix_dir + '/' + filename)
2242
self.bzrdir._control_files.put_utf8('branch-format', BzrDirFormat6().get_format_string())
2245
class ConvertBzrDir6ToMeta(Converter):
2246
"""Converts format 6 bzr dirs to metadirs."""
2248
def convert(self, to_convert, pb):
2249
"""See Converter.convert()."""
2250
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2251
from bzrlib.branch import BzrBranchFormat5
2252
self.bzrdir = to_convert
2255
self.total = 20 # the steps we know about
2256
self.garbage_inventories = []
2258
self.pb.note('starting upgrade from format 6 to metadir')
2259
self.bzrdir._control_files.put_utf8('branch-format', "Converting to format 6")
2260
# its faster to move specific files around than to open and use the apis...
2261
# first off, nuke ancestry.weave, it was never used.
2263
self.step('Removing ancestry.weave')
2264
self.bzrdir.transport.delete('ancestry.weave')
2265
except errors.NoSuchFile:
2267
# find out whats there
2268
self.step('Finding branch files')
2269
last_revision = self.bzrdir.open_branch().last_revision()
2270
bzrcontents = self.bzrdir.transport.list_dir('.')
2271
for name in bzrcontents:
2272
if name.startswith('basis-inventory.'):
2273
self.garbage_inventories.append(name)
2274
# create new directories for repository, working tree and branch
2275
self.dir_mode = self.bzrdir._get_dir_mode()
2276
self.file_mode = self.bzrdir._get_file_mode()
2277
repository_names = [('inventory.weave', True),
2278
('revision-store', True),
2280
self.step('Upgrading repository ')
2281
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2282
self.make_lock('repository')
2283
# we hard code the formats here because we are converting into
2284
# the meta format. The meta format upgrader can take this to a
2285
# future format within each component.
2286
self.put_format('repository', RepositoryFormat7())
2287
for entry in repository_names:
2288
self.move_entry('repository', entry)
2290
self.step('Upgrading branch ')
2291
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2292
self.make_lock('branch')
2293
self.put_format('branch', BzrBranchFormat5())
2294
branch_files = [('revision-history', True),
2295
('branch-name', True),
2297
for entry in branch_files:
2298
self.move_entry('branch', entry)
2300
checkout_files = [('pending-merges', True),
2301
('inventory', True),
2302
('stat-cache', False)]
2303
# If a mandatory checkout file is not present, the branch does not have
2304
# a functional checkout. Do not create a checkout in the converted
2306
for name, mandatory in checkout_files:
2307
if mandatory and name not in bzrcontents:
2308
has_checkout = False
2312
if not has_checkout:
2313
self.pb.note('No working tree.')
2314
# If some checkout files are there, we may as well get rid of them.
2315
for name, mandatory in checkout_files:
2316
if name in bzrcontents:
2317
self.bzrdir.transport.delete(name)
2319
from bzrlib.workingtree import WorkingTreeFormat3
2320
self.step('Upgrading working tree')
2321
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2322
self.make_lock('checkout')
2324
'checkout', WorkingTreeFormat3())
2325
self.bzrdir.transport.delete_multi(
2326
self.garbage_inventories, self.pb)
2327
for entry in checkout_files:
2328
self.move_entry('checkout', entry)
2329
if last_revision is not None:
2330
self.bzrdir._control_files.put_utf8(
2331
'checkout/last-revision', last_revision)
2332
self.bzrdir._control_files.put_utf8(
2333
'branch-format', BzrDirMetaFormat1().get_format_string())
2334
return BzrDir.open(self.bzrdir.root_transport.base)
2336
def make_lock(self, name):
2337
"""Make a lock for the new control dir name."""
2338
self.step('Make %s lock' % name)
2339
ld = lockdir.LockDir(self.bzrdir.transport,
2341
file_modebits=self.file_mode,
2342
dir_modebits=self.dir_mode)
2345
def move_entry(self, new_dir, entry):
2346
"""Move then entry name into new_dir."""
2348
mandatory = entry[1]
2349
self.step('Moving %s' % name)
2351
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2352
except errors.NoSuchFile:
2356
def put_format(self, dirname, format):
2357
self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
2360
class ConvertMetaToMeta(Converter):
2361
"""Converts the components of metadirs."""
2363
def __init__(self, target_format):
2364
"""Create a metadir to metadir converter.
2366
:param target_format: The final metadir format that is desired.
2368
self.target_format = target_format
2370
def convert(self, to_convert, pb):
2371
"""See Converter.convert()."""
2372
self.bzrdir = to_convert
2376
self.step('checking repository format')
2378
repo = self.bzrdir.open_repository()
2379
except errors.NoRepositoryPresent:
2382
if not isinstance(repo._format, self.target_format.repository_format.__class__):
2383
from bzrlib.repository import CopyConverter
2384
self.pb.note('starting repository conversion')
2385
converter = CopyConverter(self.target_format.repository_format)
2386
converter.convert(repo, pb)
2388
branch = self.bzrdir.open_branch()
2389
except errors.NotBranchError:
2392
# TODO: conversions of Branch and Tree should be done by
2393
# InterXFormat lookups
2394
# Avoid circular imports
2395
from bzrlib import branch as _mod_branch
2396
if (branch._format.__class__ is _mod_branch.BzrBranchFormat5 and
2397
self.target_format.get_branch_format().__class__ is
2398
_mod_branch.BzrBranchFormat6):
2399
branch_converter = _mod_branch.Converter5to6()
2400
branch_converter.convert(branch)
2402
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
2403
except (errors.NoWorkingTree, errors.NotLocalUrl):
2406
# TODO: conversions of Branch and Tree should be done by
2407
# InterXFormat lookups
2408
if (isinstance(tree, workingtree.WorkingTree3) and
2409
not isinstance(tree, workingtree_4.WorkingTree4) and
2410
isinstance(self.target_format.workingtree_format,
2411
workingtree_4.WorkingTreeFormat4)):
2412
workingtree_4.Converter3to4().convert(tree)
2416
# This is not in remote.py because it's small, and needs to be registered.
2417
# Putting it in remote.py creates a circular import problem.
2418
# we can make it a lazy object if the control formats is turned into something
2420
class RemoteBzrDirFormat(BzrDirMetaFormat1):
2421
"""Format representing bzrdirs accessed via a smart server"""
2423
def get_format_description(self):
2424
return 'bzr remote bzrdir'
2427
def probe_transport(klass, transport):
2428
"""Return a RemoteBzrDirFormat object if it looks possible."""
2430
medium = transport.get_smart_medium()
2431
except (NotImplementedError, AttributeError,
2432
errors.TransportNotPossible, errors.NoSmartMedium,
2433
errors.SmartProtocolError):
2434
# no smart server, so not a branch for this format type.
2435
raise errors.NotBranchError(path=transport.base)
2437
# Decline to open it if the server doesn't support our required
2438
# version (3) so that the VFS-based transport will do it.
2439
if medium.should_probe():
2441
server_version = medium.protocol_version()
2442
except errors.SmartProtocolError:
2443
# Apparently there's no usable smart server there, even though
2444
# the medium supports the smart protocol.
2445
raise errors.NotBranchError(path=transport.base)
2446
if server_version != '2':
2447
raise errors.NotBranchError(path=transport.base)
2450
def initialize_on_transport(self, transport):
2452
# hand off the request to the smart server
2453
client_medium = transport.get_smart_medium()
2454
except errors.NoSmartMedium:
2455
# TODO: lookup the local format from a server hint.
2456
local_dir_format = BzrDirMetaFormat1()
2457
return local_dir_format.initialize_on_transport(transport)
2458
client = _SmartClient(client_medium)
2459
path = client.remote_path_from_transport(transport)
2460
response = client.call('BzrDirFormat.initialize', path)
2461
if response[0] != 'ok':
2462
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
2463
return remote.RemoteBzrDir(transport)
2465
def _open(self, transport):
2466
return remote.RemoteBzrDir(transport)
2468
def __eq__(self, other):
2469
if not isinstance(other, RemoteBzrDirFormat):
2471
return self.get_format_description() == other.get_format_description()
2474
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
2477
class BzrDirFormatInfo(object):
2479
def __init__(self, native, deprecated, hidden, experimental):
2480
self.deprecated = deprecated
2481
self.native = native
2482
self.hidden = hidden
2483
self.experimental = experimental
2486
class BzrDirFormatRegistry(registry.Registry):
2487
"""Registry of user-selectable BzrDir subformats.
2489
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
2490
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
2494
"""Create a BzrDirFormatRegistry."""
2495
self._aliases = set()
2496
super(BzrDirFormatRegistry, self).__init__()
2499
"""Return a set of the format names which are aliases."""
2500
return frozenset(self._aliases)
2502
def register_metadir(self, key,
2503
repository_format, help, native=True, deprecated=False,
2509
"""Register a metadir subformat.
2511
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
2512
by the Repository format.
2514
:param repository_format: The fully-qualified repository format class
2516
:param branch_format: Fully-qualified branch format class name as
2518
:param tree_format: Fully-qualified tree format class name as
2521
# This should be expanded to support setting WorkingTree and Branch
2522
# formats, once BzrDirMetaFormat1 supports that.
2523
def _load(full_name):
2524
mod_name, factory_name = full_name.rsplit('.', 1)
2526
mod = __import__(mod_name, globals(), locals(),
2528
except ImportError, e:
2529
raise ImportError('failed to load %s: %s' % (full_name, e))
2531
factory = getattr(mod, factory_name)
2532
except AttributeError:
2533
raise AttributeError('no factory %s in module %r'
2538
bd = BzrDirMetaFormat1()
2539
if branch_format is not None:
2540
bd.set_branch_format(_load(branch_format))
2541
if tree_format is not None:
2542
bd.workingtree_format = _load(tree_format)
2543
if repository_format is not None:
2544
bd.repository_format = _load(repository_format)
2546
self.register(key, helper, help, native, deprecated, hidden,
2547
experimental, alias)
2549
def register(self, key, factory, help, native=True, deprecated=False,
2550
hidden=False, experimental=False, alias=False):
2551
"""Register a BzrDirFormat factory.
2553
The factory must be a callable that takes one parameter: the key.
2554
It must produce an instance of the BzrDirFormat when called.
2556
This function mainly exists to prevent the info object from being
2559
registry.Registry.register(self, key, factory, help,
2560
BzrDirFormatInfo(native, deprecated, hidden, experimental))
2562
self._aliases.add(key)
2564
def register_lazy(self, key, module_name, member_name, help, native=True,
2565
deprecated=False, hidden=False, experimental=False, alias=False):
2566
registry.Registry.register_lazy(self, key, module_name, member_name,
2567
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
2569
self._aliases.add(key)
2571
def set_default(self, key):
2572
"""Set the 'default' key to be a clone of the supplied key.
2574
This method must be called once and only once.
2576
registry.Registry.register(self, 'default', self.get(key),
2577
self.get_help(key), info=self.get_info(key))
2578
self._aliases.add('default')
2580
def set_default_repository(self, key):
2581
"""Set the FormatRegistry default and Repository default.
2583
This is a transitional method while Repository.set_default_format
2586
if 'default' in self:
2587
self.remove('default')
2588
self.set_default(key)
2589
format = self.get('default')()
2591
def make_bzrdir(self, key):
2592
return self.get(key)()
2594
def help_topic(self, topic):
2595
output = textwrap.dedent("""\
2596
These formats can be used for creating branches, working trees, and
2600
default_realkey = None
2601
default_help = self.get_help('default')
2603
for key in self.keys():
2604
if key == 'default':
2606
help = self.get_help(key)
2607
if help == default_help:
2608
default_realkey = key
2610
help_pairs.append((key, help))
2612
def wrapped(key, help, info):
2614
help = '(native) ' + help
2615
return ':%s:\n%s\n\n' % (key,
2616
textwrap.fill(help, initial_indent=' ',
2617
subsequent_indent=' '))
2618
if default_realkey is not None:
2619
output += wrapped(default_realkey, '(default) %s' % default_help,
2620
self.get_info('default'))
2621
deprecated_pairs = []
2622
experimental_pairs = []
2623
for key, help in help_pairs:
2624
info = self.get_info(key)
2627
elif info.deprecated:
2628
deprecated_pairs.append((key, help))
2629
elif info.experimental:
2630
experimental_pairs.append((key, help))
2632
output += wrapped(key, help, info)
2633
if len(experimental_pairs) > 0:
2634
output += "Experimental formats are shown below.\n\n"
2635
for key, help in experimental_pairs:
2636
info = self.get_info(key)
2637
output += wrapped(key, help, info)
2638
if len(deprecated_pairs) > 0:
2639
output += "Deprecated formats are shown below.\n\n"
2640
for key, help in deprecated_pairs:
2641
info = self.get_info(key)
2642
output += wrapped(key, help, info)
2647
class RepositoryAcquisitionPolicy(object):
2648
"""Abstract base class for repository acquisition policies.
2650
A repository acquisition policy decides how a BzrDir acquires a repository
2651
for a branch that is being created. The most basic policy decision is
2652
whether to create a new repository or use an existing one.
2655
def configure_branch(self, branch):
2656
"""Apply any configuration data from this policy to the branch.
2658
Default implementation does nothing.
2662
def acquire_repository(self, make_working_trees=None, shared=False):
2663
"""Acquire a repository for this bzrdir.
2665
Implementations may create a new repository or use a pre-exising
2667
:param make_working_trees: If creating a repository, set
2668
make_working_trees to this value (if non-None)
2669
:param shared: If creating a repository, make it shared if True
2670
:return: A repository
2672
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
2675
class CreateRepository(RepositoryAcquisitionPolicy):
2676
"""A policy of creating a new repository"""
2678
def __init__(self, bzrdir):
2679
RepositoryAcquisitionPolicy.__init__(self)
2680
self._bzrdir = bzrdir
2682
def acquire_repository(self, make_working_trees=None, shared=False):
2683
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
2685
Creates the desired repository in the bzrdir we already have.
2687
repository = self._bzrdir.create_repository(shared=shared)
2688
if make_working_trees is not None:
2689
repository.set_make_working_trees(make_working_trees)
2693
class UseExistingRepository(RepositoryAcquisitionPolicy):
2694
"""A policy of reusing an existing repository"""
2696
def __init__(self, repository):
2697
RepositoryAcquisitionPolicy.__init__(self)
2698
self._repository = repository
2700
def acquire_repository(self, make_working_trees=None, shared=False):
2701
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
2703
Returns an existing repository to use
2705
return self._repository
2708
format_registry = BzrDirFormatRegistry()
2709
format_registry.register('weave', BzrDirFormat6,
2710
'Pre-0.8 format. Slower than knit and does not'
2711
' support checkouts or shared repositories.',
2713
format_registry.register_metadir('knit',
2714
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2715
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
2716
branch_format='bzrlib.branch.BzrBranchFormat5',
2717
tree_format='bzrlib.workingtree.WorkingTreeFormat3')
2718
format_registry.register_metadir('metaweave',
2719
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
2720
'Transitional format in 0.8. Slower than knit.',
2721
branch_format='bzrlib.branch.BzrBranchFormat5',
2722
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2724
format_registry.register_metadir('dirstate',
2725
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2726
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2727
'above when accessed over the network.',
2728
branch_format='bzrlib.branch.BzrBranchFormat5',
2729
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
2730
# directly from workingtree_4 triggers a circular import.
2731
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2733
format_registry.register_metadir('dirstate-tags',
2734
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2735
help='New in 0.15: Fast local operations and improved scaling for '
2736
'network operations. Additionally adds support for tags.'
2737
' Incompatible with bzr < 0.15.',
2738
branch_format='bzrlib.branch.BzrBranchFormat6',
2739
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2741
format_registry.register_metadir('rich-root',
2742
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
2743
help='New in 1.0. Better handling of tree roots. Incompatible with'
2745
branch_format='bzrlib.branch.BzrBranchFormat6',
2746
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2748
format_registry.register_metadir('dirstate-with-subtree',
2749
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2750
help='New in 0.15: Fast local operations and improved scaling for '
2751
'network operations. Additionally adds support for versioning nested '
2752
'bzr branches. Incompatible with bzr < 0.15.',
2753
branch_format='bzrlib.branch.BzrBranchFormat6',
2754
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2758
format_registry.register_metadir('pack-0.92',
2759
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
2760
help='New in 0.92: Pack-based format with data compatible with '
2761
'dirstate-tags format repositories. Interoperates with '
2762
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2763
'Previously called knitpack-experimental. '
2764
'For more information, see '
2765
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2766
branch_format='bzrlib.branch.BzrBranchFormat6',
2767
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2769
format_registry.register_metadir('pack-0.92-subtree',
2770
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
2771
help='New in 0.92: Pack-based format with data compatible with '
2772
'dirstate-with-subtree format repositories. Interoperates with '
2773
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2774
'Previously called knitpack-experimental. '
2775
'For more information, see '
2776
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2777
branch_format='bzrlib.branch.BzrBranchFormat6',
2778
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2782
format_registry.register_metadir('rich-root-pack',
2783
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
2784
help='New in 1.0: Pack-based format with data compatible with '
2785
'rich-root format repositories. Incompatible with'
2787
branch_format='bzrlib.branch.BzrBranchFormat6',
2788
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2790
# The following two formats should always just be aliases.
2791
format_registry.register_metadir('development',
2792
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
2793
help='Current development format. Can convert data to and from pack-0.92 '
2794
'(and anything compatible with pack-0.92) format repositories. '
2795
'Repositories in this format can only be read by bzr.dev. '
2797
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2799
branch_format='bzrlib.branch.BzrBranchFormat6',
2800
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2804
format_registry.register_metadir('development-subtree',
2805
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
2806
help='Current development format, subtree variant. Can convert data to and '
2807
'from pack-0.92 (and anything compatible with pack-0.92) format '
2808
'repositories. Repositories in this format can only be read by '
2809
'bzr.dev. Please read '
2810
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2812
branch_format='bzrlib.branch.BzrBranchFormat6',
2813
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2817
# And the development formats which the will have aliased one of follow:
2818
format_registry.register_metadir('development0',
2819
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
2820
help='Trivial rename of pack-0.92 to provide a development format. '
2822
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2824
branch_format='bzrlib.branch.BzrBranchFormat6',
2825
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2829
format_registry.register_metadir('development0-subtree',
2830
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
2831
help='Trivial rename of pack-0.92-subtree to provide a development format. '
2833
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2835
branch_format='bzrlib.branch.BzrBranchFormat6',
2836
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2840
format_registry.set_default('pack-0.92')
added
removed
bzrlib/bzrdir.py
