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
49
revision as _mod_revision,
60
from bzrlib.osutils import (
64
from bzrlib.smart.client import _SmartClient
65
from bzrlib.smart import protocol
66
from bzrlib.repofmt.weaverepo import TextRevisionStore, RevisionTextStore
67
from bzrlib.store.versioned import WeaveStore
68
from bzrlib.transactions import WriteTransaction
69
from bzrlib.transport import (
70
do_catching_redirections,
73
from bzrlib.weave import Weave
76
from bzrlib.trace import (
80
from bzrlib.transport.local import LocalTransport
81
from bzrlib.symbol_versioning import (
88
"""A .bzr control diretory.
90
BzrDir instances let you create or open any of the things that can be
91
found within .bzr - checkouts, branches and repositories.
94
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
96
a transport connected to the directory this bzr was opened from
97
(i.e. the parent directory holding the .bzr directory).
99
Everything in the bzrdir should have the same file permissions.
102
def break_lock(self):
103
"""Invoke break_lock on the first object in the bzrdir.
105
If there is a tree, the tree is opened and break_lock() called.
106
Otherwise, branch is tried, and finally repository.
108
# XXX: This seems more like a UI function than something that really
109
# belongs in this class.
111
thing_to_unlock = self.open_workingtree()
112
except (errors.NotLocalUrl, errors.NoWorkingTree):
114
thing_to_unlock = self.open_branch()
115
except errors.NotBranchError:
117
thing_to_unlock = self.open_repository()
118
except errors.NoRepositoryPresent:
120
thing_to_unlock.break_lock()
122
def can_convert_format(self):
123
"""Return true if this bzrdir is one whose format we can convert from."""
126
def check_conversion_target(self, target_format):
127
target_repo_format = target_format.repository_format
128
source_repo_format = self._format.repository_format
129
source_repo_format.check_conversion_target(target_repo_format)
132
def _check_supported(format, allow_unsupported,
133
recommend_upgrade=True,
135
"""Give an error or warning on old formats.
137
:param format: may be any kind of format - workingtree, branch,
140
:param allow_unsupported: If true, allow opening
141
formats that are strongly deprecated, and which may
142
have limited functionality.
144
:param recommend_upgrade: If true (default), warn
145
the user through the ui object that they may wish
146
to upgrade the object.
148
# TODO: perhaps move this into a base Format class; it's not BzrDir
149
# specific. mbp 20070323
150
if not allow_unsupported and not format.is_supported():
151
# see open_downlevel to open legacy branches.
152
raise errors.UnsupportedFormatError(format=format)
153
if recommend_upgrade \
154
and getattr(format, 'upgrade_recommended', False):
155
ui.ui_factory.recommend_upgrade(
156
format.get_format_description(),
159
def clone(self, url, revision_id=None, force_new_repo=False):
160
"""Clone this bzrdir and its contents to url verbatim.
162
If url's last component does not exist, it will be created.
164
if revision_id is not None, then the clone operation may tune
165
itself to download less data.
166
:param force_new_repo: Do not use a shared repository for the target
167
even if one is available.
169
return self.clone_on_transport(get_transport(url),
170
revision_id=revision_id,
171
force_new_repo=force_new_repo)
173
def clone_on_transport(self, transport, revision_id=None,
174
force_new_repo=False):
175
"""Clone this bzrdir and its contents to transport verbatim.
177
If the target directory does not exist, it will be created.
179
if revision_id is not None, then the clone operation may tune
180
itself to download less data.
181
:param force_new_repo: Do not use a shared repository for the target
182
even if one is available.
184
transport.ensure_base()
185
result = self.cloning_metadir().initialize_on_transport(transport)
186
repository_policy = None
188
local_repo = self.find_repository()
189
except errors.NoRepositoryPresent:
192
# may need to copy content in
193
repository_policy = result.determine_repository_policy(
195
make_working_trees = local_repo.make_working_trees()
196
result_repo = repository_policy.acquire_repository(
197
make_working_trees, local_repo.is_shared())
198
result_repo.fetch(local_repo, revision_id=revision_id)
199
# 1 if there is a branch present
200
# make sure its content is available in the target repository
203
local_branch = self.open_branch()
204
except errors.NotBranchError:
207
result_branch = local_branch.clone(result, revision_id=revision_id)
208
if repository_policy is not None:
209
repository_policy.configure_branch(result_branch)
211
result_repo = result.find_repository()
212
except errors.NoRepositoryPresent:
214
if result_repo is None or result_repo.make_working_trees():
216
self.open_workingtree().clone(result)
217
except (errors.NoWorkingTree, errors.NotLocalUrl):
221
# TODO: This should be given a Transport, and should chdir up; otherwise
222
# this will open a new connection.
223
def _make_tail(self, url):
224
t = get_transport(url)
228
def create(cls, base, format=None, possible_transports=None):
229
"""Create a new BzrDir at the url 'base'.
231
:param format: If supplied, the format of branch to create. If not
232
supplied, the default is used.
233
:param possible_transports: If supplied, a list of transports that
234
can be reused to share a remote connection.
236
if cls is not BzrDir:
237
raise AssertionError("BzrDir.create always creates the default"
238
" format, not one of %r" % cls)
239
t = get_transport(base, possible_transports)
242
format = BzrDirFormat.get_default_format()
243
return format.initialize_on_transport(t)
246
def find_bzrdirs(transport, evaluate=None, list_current=None):
247
"""Find bzrdirs recursively from current location.
249
This is intended primarily as a building block for more sophisticated
250
functionality, like finding trees under a directory, or finding
251
branches that use a given repository.
252
:param evaluate: An optional callable that yields recurse, value,
253
where recurse controls whether this bzrdir is recursed into
254
and value is the value to yield. By default, all bzrdirs
255
are recursed into, and the return value is the bzrdir.
256
:param list_current: if supplied, use this function to list the current
257
directory, instead of Transport.list_dir
258
:return: a generator of found bzrdirs, or whatever evaluate returns.
260
if list_current is None:
261
def list_current(transport):
262
return transport.list_dir('')
264
def evaluate(bzrdir):
267
pending = [transport]
268
while len(pending) > 0:
269
current_transport = pending.pop()
272
bzrdir = BzrDir.open_from_transport(current_transport)
273
except errors.NotBranchError:
276
recurse, value = evaluate(bzrdir)
279
subdirs = list_current(current_transport)
280
except errors.NoSuchFile:
283
for subdir in sorted(subdirs, reverse=True):
284
pending.append(current_transport.clone(subdir))
287
def find_branches(transport):
288
"""Find all branches under a transport.
290
This will find all branches below the transport, including branches
291
inside other branches. Where possible, it will use
292
Repository.find_branches.
294
To list all the branches that use a particular Repository, see
295
Repository.find_branches
297
def evaluate(bzrdir):
299
repository = bzrdir.open_repository()
300
except errors.NoRepositoryPresent:
303
return False, (None, repository)
305
branch = bzrdir.open_branch()
306
except errors.NotBranchError:
307
return True, (None, None)
309
return True, (branch, None)
311
for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
313
branches.extend(repo.find_branches())
314
if branch is not None:
315
branches.append(branch)
318
def destroy_repository(self):
319
"""Destroy the repository in this BzrDir"""
320
raise NotImplementedError(self.destroy_repository)
322
def create_branch(self):
323
"""Create a branch in this BzrDir.
325
The bzrdir's format will control what branch format is created.
326
For more control see BranchFormatXX.create(a_bzrdir).
328
raise NotImplementedError(self.create_branch)
330
def destroy_branch(self):
331
"""Destroy the branch in this BzrDir"""
332
raise NotImplementedError(self.destroy_branch)
335
def create_branch_and_repo(base, force_new_repo=False, format=None):
336
"""Create a new BzrDir, Branch and Repository at the url 'base'.
338
This will use the current default BzrDirFormat unless one is
339
specified, and use whatever
340
repository format that that uses via bzrdir.create_branch and
341
create_repository. If a shared repository is available that is used
344
The created Branch object is returned.
346
:param base: The URL to create the branch at.
347
:param force_new_repo: If True a new repository is always created.
348
:param format: If supplied, the format of branch to create. If not
349
supplied, the default is used.
351
bzrdir = BzrDir.create(base, format)
352
bzrdir._find_or_create_repository(force_new_repo)
353
return bzrdir.create_branch()
355
def determine_repository_policy(self, force_new_repo=False):
356
"""Return an object representing a policy to use.
358
This controls whether a new repository is created, or a shared
359
repository used instead.
361
def repository_policy(found_bzrdir):
363
# does it have a repository ?
365
repository = found_bzrdir.open_repository()
366
except errors.NoRepositoryPresent:
369
if ((found_bzrdir.root_transport.base !=
370
self.root_transport.base) and not repository.is_shared()):
377
return UseExistingRepository(repository), True
379
return CreateRepository(self), True
381
if not force_new_repo:
382
policy = self._find_containing(repository_policy)
383
if policy is not None:
385
return CreateRepository(self)
387
def _find_or_create_repository(self, force_new_repo):
388
"""Create a new repository if needed, returning the repository."""
389
policy = self.determine_repository_policy(force_new_repo)
390
return policy.acquire_repository()
393
def create_branch_convenience(base, force_new_repo=False,
394
force_new_tree=None, format=None,
395
possible_transports=None):
396
"""Create a new BzrDir, Branch and Repository at the url 'base'.
398
This is a convenience function - it will use an existing repository
399
if possible, can be told explicitly whether to create a working tree or
402
This will use the current default BzrDirFormat unless one is
403
specified, and use whatever
404
repository format that that uses via bzrdir.create_branch and
405
create_repository. If a shared repository is available that is used
406
preferentially. Whatever repository is used, its tree creation policy
409
The created Branch object is returned.
410
If a working tree cannot be made due to base not being a file:// url,
411
no error is raised unless force_new_tree is True, in which case no
412
data is created on disk and NotLocalUrl is raised.
414
:param base: The URL to create the branch at.
415
:param force_new_repo: If True a new repository is always created.
416
:param force_new_tree: If True or False force creation of a tree or
417
prevent such creation respectively.
418
:param format: Override for the bzrdir format to create.
419
:param possible_transports: An optional reusable transports list.
422
# check for non local urls
423
t = get_transport(base, possible_transports)
424
if not isinstance(t, LocalTransport):
425
raise errors.NotLocalUrl(base)
426
bzrdir = BzrDir.create(base, format, possible_transports)
427
repo = bzrdir._find_or_create_repository(force_new_repo)
428
result = bzrdir.create_branch()
429
if force_new_tree or (repo.make_working_trees() and
430
force_new_tree is None):
432
bzrdir.create_workingtree()
433
except errors.NotLocalUrl:
438
def create_standalone_workingtree(base, format=None):
439
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
441
'base' must be a local path or a file:// url.
443
This will use the current default BzrDirFormat unless one is
444
specified, and use whatever
445
repository format that that uses for bzrdirformat.create_workingtree,
446
create_branch and create_repository.
448
:param format: Override for the bzrdir format to create.
449
:return: The WorkingTree object.
451
t = get_transport(base)
452
if not isinstance(t, LocalTransport):
453
raise errors.NotLocalUrl(base)
454
bzrdir = BzrDir.create_branch_and_repo(base,
456
format=format).bzrdir
457
return bzrdir.create_workingtree()
459
def create_workingtree(self, revision_id=None, from_branch=None,
460
accelerator_tree=None, hardlink=False):
461
"""Create a working tree at this BzrDir.
463
:param revision_id: create it as of this revision id.
464
:param from_branch: override bzrdir branch (for lightweight checkouts)
465
:param accelerator_tree: A tree which can be used for retrieving file
466
contents more quickly than the revision tree, i.e. a workingtree.
467
The revision tree will be used for cases where accelerator_tree's
468
content is different.
470
raise NotImplementedError(self.create_workingtree)
472
def retire_bzrdir(self, limit=10000):
473
"""Permanently disable the bzrdir.
475
This is done by renaming it to give the user some ability to recover
476
if there was a problem.
478
This will have horrible consequences if anyone has anything locked or
480
:param limit: number of times to retry
485
to_path = '.bzr.retired.%d' % i
486
self.root_transport.rename('.bzr', to_path)
487
note("renamed %s to %s"
488
% (self.root_transport.abspath('.bzr'), to_path))
490
except (errors.TransportError, IOError, errors.PathError):
497
def destroy_workingtree(self):
498
"""Destroy the working tree at this BzrDir.
500
Formats that do not support this may raise UnsupportedOperation.
502
raise NotImplementedError(self.destroy_workingtree)
504
def destroy_workingtree_metadata(self):
505
"""Destroy the control files for the working tree at this BzrDir.
507
The contents of working tree files are not affected.
508
Formats that do not support this may raise UnsupportedOperation.
510
raise NotImplementedError(self.destroy_workingtree_metadata)
512
def _find_containing(self, evaluate):
513
"""Find something in a containing control directory.
515
This method will scan containing control dirs, until it finds what
516
it is looking for, decides that it will never find it, or runs out
517
of containing control directories to check.
519
It is used to implement find_repository and
520
determine_repository_policy.
522
:param evaluate: A function returning (value, stop). If stop is True,
523
the value will be returned.
527
result, stop = evaluate(found_bzrdir)
530
next_transport = found_bzrdir.root_transport.clone('..')
531
if (found_bzrdir.root_transport.base == next_transport.base):
532
# top of the file system
534
# find the next containing bzrdir
536
found_bzrdir = BzrDir.open_containing_from_transport(
538
except errors.NotBranchError:
541
def find_repository(self):
542
"""Find the repository that should be used.
544
This does not require a branch as we use it to find the repo for
545
new branches as well as to hook existing branches up to their
548
def usable_repository(found_bzrdir):
549
# does it have a repository ?
551
repository = found_bzrdir.open_repository()
552
except errors.NoRepositoryPresent:
554
if found_bzrdir.root_transport.base == self.root_transport.base:
555
return repository, True
556
elif repository.is_shared():
557
return repository, True
561
found_repo = self._find_containing(usable_repository)
562
if found_repo is None:
563
raise errors.NoRepositoryPresent(self)
566
def get_branch_reference(self):
567
"""Return the referenced URL for the branch in this bzrdir.
569
:raises NotBranchError: If there is no Branch.
570
:return: The URL the branch in this bzrdir references if it is a
571
reference branch, or None for regular branches.
575
def get_branch_transport(self, branch_format):
576
"""Get the transport for use by branch format in this BzrDir.
578
Note that bzr dirs that do not support format strings will raise
579
IncompatibleFormat if the branch format they are given has
580
a format string, and vice versa.
582
If branch_format is None, the transport is returned with no
583
checking. If it is not None, then the returned transport is
584
guaranteed to point to an existing directory ready for use.
586
raise NotImplementedError(self.get_branch_transport)
588
def _find_creation_modes(self):
589
"""Determine the appropriate modes for files and directories.
591
They're always set to be consistent with the base directory,
592
assuming that this transport allows setting modes.
594
# TODO: Do we need or want an option (maybe a config setting) to turn
595
# this off or override it for particular locations? -- mbp 20080512
596
if self._mode_check_done:
598
self._mode_check_done = True
600
st = self.transport.stat('.')
601
except errors.TransportNotPossible:
602
self._dir_mode = None
603
self._file_mode = None
605
# Check the directory mode, but also make sure the created
606
# directories and files are read-write for this user. This is
607
# mostly a workaround for filesystems which lie about being able to
608
# write to a directory (cygwin & win32)
609
self._dir_mode = (st.st_mode & 07777) | 00700
610
# Remove the sticky and execute bits for files
611
self._file_mode = self._dir_mode & ~07111
613
def _get_file_mode(self):
614
"""Return Unix mode for newly created files, or None.
616
if not self._mode_check_done:
617
self._find_creation_modes()
618
return self._file_mode
620
def _get_dir_mode(self):
621
"""Return Unix mode for newly created directories, or None.
623
if not self._mode_check_done:
624
self._find_creation_modes()
625
return self._dir_mode
627
def get_repository_transport(self, repository_format):
628
"""Get the transport for use by repository format in this BzrDir.
630
Note that bzr dirs that do not support format strings will raise
631
IncompatibleFormat if the repository format they are given has
632
a format string, and vice versa.
634
If repository_format is None, the transport is returned with no
635
checking. If it is not None, then the returned transport is
636
guaranteed to point to an existing directory ready for use.
638
raise NotImplementedError(self.get_repository_transport)
640
def get_workingtree_transport(self, tree_format):
641
"""Get the transport for use by workingtree format in this BzrDir.
643
Note that bzr dirs that do not support format strings will raise
644
IncompatibleFormat if the workingtree format they are given has a
645
format string, and vice versa.
647
If workingtree_format is None, the transport is returned with no
648
checking. If it is not None, then the returned transport is
649
guaranteed to point to an existing directory ready for use.
651
raise NotImplementedError(self.get_workingtree_transport)
653
def __init__(self, _transport, _format):
654
"""Initialize a Bzr control dir object.
656
Only really common logic should reside here, concrete classes should be
657
made with varying behaviours.
659
:param _format: the format that is creating this BzrDir instance.
660
:param _transport: the transport this dir is based at.
662
self._format = _format
663
self.transport = _transport.clone('.bzr')
664
self.root_transport = _transport
665
self._mode_check_done = False
667
def is_control_filename(self, filename):
668
"""True if filename is the name of a path which is reserved for bzrdir's.
670
:param filename: A filename within the root transport of this bzrdir.
672
This is true IF and ONLY IF the filename is part of the namespace reserved
673
for bzr control dirs. Currently this is the '.bzr' directory in the root
674
of the root_transport. it is expected that plugins will need to extend
675
this in the future - for instance to make bzr talk with svn working
678
# this might be better on the BzrDirFormat class because it refers to
679
# all the possible bzrdir disk formats.
680
# This method is tested via the workingtree is_control_filename tests-
681
# it was extracted from WorkingTree.is_control_filename. If the method's
682
# contract is extended beyond the current trivial implementation, please
683
# add new tests for it to the appropriate place.
684
return filename == '.bzr' or filename.startswith('.bzr/')
686
def needs_format_conversion(self, format=None):
687
"""Return true if this bzrdir needs convert_format run on it.
689
For instance, if the repository format is out of date but the
690
branch and working tree are not, this should return True.
692
:param format: Optional parameter indicating a specific desired
693
format we plan to arrive at.
695
raise NotImplementedError(self.needs_format_conversion)
698
def open_unsupported(base):
699
"""Open a branch which is not supported."""
700
return BzrDir.open(base, _unsupported=True)
703
def open(base, _unsupported=False, possible_transports=None):
704
"""Open an existing bzrdir, rooted at 'base' (url).
706
:param _unsupported: a private parameter to the BzrDir class.
708
t = get_transport(base, possible_transports=possible_transports)
709
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
712
def open_from_transport(transport, _unsupported=False,
713
_server_formats=True):
714
"""Open a bzrdir within a particular directory.
716
:param transport: Transport containing the bzrdir.
717
:param _unsupported: private.
719
base = transport.base
721
def find_format(transport):
722
return transport, BzrDirFormat.find_format(
723
transport, _server_formats=_server_formats)
725
def redirected(transport, e, redirection_notice):
726
qualified_source = e.get_source_url()
727
relpath = transport.relpath(qualified_source)
728
if not e.target.endswith(relpath):
729
# Not redirected to a branch-format, not a branch
730
raise errors.NotBranchError(path=e.target)
731
target = e.target[:-len(relpath)]
732
note('%s is%s redirected to %s',
733
transport.base, e.permanently, target)
734
# Let's try with a new transport
735
# FIXME: If 'transport' has a qualifier, this should
736
# be applied again to the new transport *iff* the
737
# schemes used are the same. Uncomment this code
738
# once the function (and tests) exist.
740
#target = urlutils.copy_url_qualifiers(original, target)
741
return get_transport(target)
744
transport, format = do_catching_redirections(find_format,
747
except errors.TooManyRedirections:
748
raise errors.NotBranchError(base)
750
BzrDir._check_supported(format, _unsupported)
751
return format.open(transport, _found=True)
753
def open_branch(self, unsupported=False):
754
"""Open the branch object at this BzrDir if one is present.
756
If unsupported is True, then no longer supported branch formats can
759
TODO: static convenience version of this?
761
raise NotImplementedError(self.open_branch)
764
def open_containing(url, possible_transports=None):
765
"""Open an existing branch which contains url.
767
:param url: url to search from.
768
See open_containing_from_transport for more detail.
770
transport = get_transport(url, possible_transports)
771
return BzrDir.open_containing_from_transport(transport)
774
def open_containing_from_transport(a_transport):
775
"""Open an existing branch which contains a_transport.base.
777
This probes for a branch at a_transport, and searches upwards from there.
779
Basically we keep looking up until we find the control directory or
780
run into the root. If there isn't one, raises NotBranchError.
781
If there is one and it is either an unrecognised format or an unsupported
782
format, UnknownFormatError or UnsupportedFormatError are raised.
783
If there is one, it is returned, along with the unused portion of url.
785
:return: The BzrDir that contains the path, and a Unicode path
786
for the rest of the URL.
788
# this gets the normalised url back. I.e. '.' -> the full path.
789
url = a_transport.base
792
result = BzrDir.open_from_transport(a_transport)
793
return result, urlutils.unescape(a_transport.relpath(url))
794
except errors.NotBranchError, e:
797
new_t = a_transport.clone('..')
798
except errors.InvalidURLJoin:
799
# reached the root, whatever that may be
800
raise errors.NotBranchError(path=url)
801
if new_t.base == a_transport.base:
802
# reached the root, whatever that may be
803
raise errors.NotBranchError(path=url)
806
def _get_tree_branch(self):
807
"""Return the branch and tree, if any, for this bzrdir.
809
Return None for tree if not present or inaccessible.
810
Raise NotBranchError if no branch is present.
811
:return: (tree, branch)
814
tree = self.open_workingtree()
815
except (errors.NoWorkingTree, errors.NotLocalUrl):
817
branch = self.open_branch()
823
def open_tree_or_branch(klass, location):
824
"""Return the branch and working tree at a location.
826
If there is no tree at the location, tree will be None.
827
If there is no branch at the location, an exception will be
829
:return: (tree, branch)
831
bzrdir = klass.open(location)
832
return bzrdir._get_tree_branch()
835
def open_containing_tree_or_branch(klass, location):
836
"""Return the branch and working tree contained by a location.
838
Returns (tree, branch, relpath).
839
If there is no tree at containing the location, tree will be None.
840
If there is no branch containing the location, an exception will be
842
relpath is the portion of the path that is contained by the branch.
844
bzrdir, relpath = klass.open_containing(location)
845
tree, branch = bzrdir._get_tree_branch()
846
return tree, branch, relpath
848
def open_repository(self, _unsupported=False):
849
"""Open the repository object at this BzrDir if one is present.
851
This will not follow the Branch object pointer - it's strictly a direct
852
open facility. Most client code should use open_branch().repository to
855
:param _unsupported: a private parameter, not part of the api.
856
TODO: static convenience version of this?
858
raise NotImplementedError(self.open_repository)
860
def open_workingtree(self, _unsupported=False,
861
recommend_upgrade=True, from_branch=None):
862
"""Open the workingtree object at this BzrDir if one is present.
864
:param recommend_upgrade: Optional keyword parameter, when True (the
865
default), emit through the ui module a recommendation that the user
866
upgrade the working tree when the workingtree being opened is old
867
(but still fully supported).
868
:param from_branch: override bzrdir branch (for lightweight checkouts)
870
raise NotImplementedError(self.open_workingtree)
872
def has_branch(self):
873
"""Tell if this bzrdir contains a branch.
875
Note: if you're going to open the branch, you should just go ahead
876
and try, and not ask permission first. (This method just opens the
877
branch and discards it, and that's somewhat expensive.)
882
except errors.NotBranchError:
885
def has_workingtree(self):
886
"""Tell if this bzrdir contains a working tree.
888
This will still raise an exception if the bzrdir has a workingtree that
889
is remote & inaccessible.
891
Note: if you're going to open the working tree, you should just go ahead
892
and try, and not ask permission first. (This method just opens the
893
workingtree and discards it, and that's somewhat expensive.)
896
self.open_workingtree(recommend_upgrade=False)
898
except errors.NoWorkingTree:
901
def _cloning_metadir(self):
902
"""Produce a metadir suitable for cloning with."""
903
result_format = self._format.__class__()
906
branch = self.open_branch()
907
source_repository = branch.repository
908
except errors.NotBranchError:
910
source_repository = self.open_repository()
911
except errors.NoRepositoryPresent:
912
source_repository = None
914
# XXX TODO: This isinstance is here because we have not implemented
915
# the fix recommended in bug # 103195 - to delegate this choice the
917
repo_format = source_repository._format
918
if not isinstance(repo_format, remote.RemoteRepositoryFormat):
919
result_format.repository_format = repo_format
921
# TODO: Couldn't we just probe for the format in these cases,
922
# rather than opening the whole tree? It would be a little
923
# faster. mbp 20070401
924
tree = self.open_workingtree(recommend_upgrade=False)
925
except (errors.NoWorkingTree, errors.NotLocalUrl):
926
result_format.workingtree_format = None
928
result_format.workingtree_format = tree._format.__class__()
929
return result_format, source_repository
931
def cloning_metadir(self):
932
"""Produce a metadir suitable for cloning or sprouting with.
934
These operations may produce workingtrees (yes, even though they're
935
"cloning" something that doesn't have a tree), so a viable workingtree
936
format must be selected.
938
format, repository = self._cloning_metadir()
939
if format._workingtree_format is None:
940
if repository is None:
942
tree_format = repository._format._matchingbzrdir.workingtree_format
943
format.workingtree_format = tree_format.__class__()
946
def checkout_metadir(self):
947
return self.cloning_metadir()
949
def sprout(self, url, revision_id=None, force_new_repo=False,
950
recurse='down', possible_transports=None,
951
accelerator_tree=None, hardlink=False):
952
"""Create a copy of this bzrdir prepared for use as a new line of
955
If url's last component does not exist, it will be created.
957
Attributes related to the identity of the source branch like
958
branch nickname will be cleaned, a working tree is created
959
whether one existed before or not; and a local branch is always
962
if revision_id is not None, then the clone operation may tune
963
itself to download less data.
964
:param accelerator_tree: A tree which can be used for retrieving file
965
contents more quickly than the revision tree, i.e. a workingtree.
966
The revision tree will be used for cases where accelerator_tree's
967
content is different.
968
:param hardlink: If true, hard-link files from accelerator_tree,
971
target_transport = get_transport(url, possible_transports)
972
target_transport.ensure_base()
973
cloning_format = self.cloning_metadir()
974
result = cloning_format.initialize_on_transport(target_transport)
976
source_branch = self.open_branch()
977
source_repository = source_branch.repository
978
except errors.NotBranchError:
981
source_repository = self.open_repository()
982
except errors.NoRepositoryPresent:
983
source_repository = None
988
result_repo = result.find_repository()
989
except errors.NoRepositoryPresent:
991
if source_repository is None and result_repo is not None:
993
elif source_repository is None and result_repo is None:
994
# no repo available, make a new one
995
result.create_repository()
996
elif source_repository is not None and result_repo is None:
997
# have source, and want to make a new target repo
998
result_repo = source_repository.sprout(result,
999
revision_id=revision_id)
1001
# fetch needed content into target.
1002
if source_repository is not None:
1004
# source_repository.copy_content_into(result_repo,
1005
# revision_id=revision_id)
1006
# so we can override the copy method
1007
result_repo.fetch(source_repository, revision_id=revision_id)
1008
if source_branch is not None:
1009
source_branch.sprout(result, revision_id=revision_id)
1011
result.create_branch()
1012
if isinstance(target_transport, LocalTransport) and (
1013
result_repo is None or result_repo.make_working_trees()):
1014
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1018
if wt.path2id('') is None:
1020
wt.set_root_id(self.open_workingtree.get_root_id())
1021
except errors.NoWorkingTree:
1027
if recurse == 'down':
1029
basis = wt.basis_tree()
1031
subtrees = basis.iter_references()
1032
recurse_branch = wt.branch
1033
elif source_branch is not None:
1034
basis = source_branch.basis_tree()
1036
subtrees = basis.iter_references()
1037
recurse_branch = source_branch
1042
for path, file_id in subtrees:
1043
target = urlutils.join(url, urlutils.escape(path))
1044
sublocation = source_branch.reference_parent(file_id, path)
1045
sublocation.bzrdir.sprout(target,
1046
basis.get_reference_revision(file_id, path),
1047
force_new_repo=force_new_repo, recurse=recurse)
1049
if basis is not None:
1054
class BzrDirPreSplitOut(BzrDir):
1055
"""A common class for the all-in-one formats."""
1057
def __init__(self, _transport, _format):
1058
"""See BzrDir.__init__."""
1059
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1060
self._control_files = lockable_files.LockableFiles(
1061
self.get_branch_transport(None),
1062
self._format._lock_file_name,
1063
self._format._lock_class)
1065
def break_lock(self):
1066
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1067
raise NotImplementedError(self.break_lock)
1069
def cloning_metadir(self):
1070
"""Produce a metadir suitable for cloning with."""
1071
return self._format.__class__()
1073
def clone(self, url, revision_id=None, force_new_repo=False):
1074
"""See BzrDir.clone()."""
1075
from bzrlib.workingtree import WorkingTreeFormat2
1076
self._make_tail(url)
1077
result = self._format._initialize_for_clone(url)
1078
self.open_repository().clone(result, revision_id=revision_id)
1079
from_branch = self.open_branch()
1080
from_branch.clone(result, revision_id=revision_id)
1082
self.open_workingtree().clone(result)
1083
except errors.NotLocalUrl:
1084
# make a new one, this format always has to have one.
1086
WorkingTreeFormat2().initialize(result)
1087
except errors.NotLocalUrl:
1088
# but we cannot do it for remote trees.
1089
to_branch = result.open_branch()
1090
WorkingTreeFormat2()._stub_initialize_remote(to_branch)
1093
def create_branch(self):
1094
"""See BzrDir.create_branch."""
1095
return self.open_branch()
1097
def destroy_branch(self):
1098
"""See BzrDir.destroy_branch."""
1099
raise errors.UnsupportedOperation(self.destroy_branch, self)
1101
def create_repository(self, shared=False):
1102
"""See BzrDir.create_repository."""
1104
raise errors.IncompatibleFormat('shared repository', self._format)
1105
return self.open_repository()
1107
def destroy_repository(self):
1108
"""See BzrDir.destroy_repository."""
1109
raise errors.UnsupportedOperation(self.destroy_repository, self)
1111
def create_workingtree(self, revision_id=None, from_branch=None,
1112
accelerator_tree=None, hardlink=False):
1113
"""See BzrDir.create_workingtree."""
1114
# this looks buggy but is not -really-
1115
# because this format creates the workingtree when the bzrdir is
1117
# clone and sprout will have set the revision_id
1118
# and that will have set it for us, its only
1119
# specific uses of create_workingtree in isolation
1120
# that can do wonky stuff here, and that only
1121
# happens for creating checkouts, which cannot be
1122
# done on this format anyway. So - acceptable wart.
1123
result = self.open_workingtree(recommend_upgrade=False)
1124
if revision_id is not None:
1125
if revision_id == _mod_revision.NULL_REVISION:
1126
result.set_parent_ids([])
1128
result.set_parent_ids([revision_id])
1131
def destroy_workingtree(self):
1132
"""See BzrDir.destroy_workingtree."""
1133
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1135
def destroy_workingtree_metadata(self):
1136
"""See BzrDir.destroy_workingtree_metadata."""
1137
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1140
def get_branch_transport(self, branch_format):
1141
"""See BzrDir.get_branch_transport()."""
1142
if branch_format is None:
1143
return self.transport
1145
branch_format.get_format_string()
1146
except NotImplementedError:
1147
return self.transport
1148
raise errors.IncompatibleFormat(branch_format, self._format)
1150
def get_repository_transport(self, repository_format):
1151
"""See BzrDir.get_repository_transport()."""
1152
if repository_format is None:
1153
return self.transport
1155
repository_format.get_format_string()
1156
except NotImplementedError:
1157
return self.transport
1158
raise errors.IncompatibleFormat(repository_format, self._format)
1160
def get_workingtree_transport(self, workingtree_format):
1161
"""See BzrDir.get_workingtree_transport()."""
1162
if workingtree_format is None:
1163
return self.transport
1165
workingtree_format.get_format_string()
1166
except NotImplementedError:
1167
return self.transport
1168
raise errors.IncompatibleFormat(workingtree_format, self._format)
1170
def needs_format_conversion(self, format=None):
1171
"""See BzrDir.needs_format_conversion()."""
1172
# if the format is not the same as the system default,
1173
# an upgrade is needed.
1175
format = BzrDirFormat.get_default_format()
1176
return not isinstance(self._format, format.__class__)
1178
def open_branch(self, unsupported=False):
1179
"""See BzrDir.open_branch."""
1180
from bzrlib.branch import BzrBranchFormat4
1181
format = BzrBranchFormat4()
1182
self._check_supported(format, unsupported)
1183
return format.open(self, _found=True)
1185
def sprout(self, url, revision_id=None, force_new_repo=False,
1186
possible_transports=None, accelerator_tree=None,
1188
"""See BzrDir.sprout()."""
1189
from bzrlib.workingtree import WorkingTreeFormat2
1190
self._make_tail(url)
1191
result = self._format._initialize_for_clone(url)
1193
self.open_repository().clone(result, revision_id=revision_id)
1194
except errors.NoRepositoryPresent:
1197
self.open_branch().sprout(result, revision_id=revision_id)
1198
except errors.NotBranchError:
1200
# we always want a working tree
1201
WorkingTreeFormat2().initialize(result,
1202
accelerator_tree=accelerator_tree,
1207
class BzrDir4(BzrDirPreSplitOut):
1208
"""A .bzr version 4 control object.
1210
This is a deprecated format and may be removed after sept 2006.
1213
def create_repository(self, shared=False):
1214
"""See BzrDir.create_repository."""
1215
return self._format.repository_format.initialize(self, shared)
1217
def needs_format_conversion(self, format=None):
1218
"""Format 4 dirs are always in need of conversion."""
1221
def open_repository(self):
1222
"""See BzrDir.open_repository."""
1223
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1224
return RepositoryFormat4().open(self, _found=True)
1227
class BzrDir5(BzrDirPreSplitOut):
1228
"""A .bzr version 5 control object.
1230
This is a deprecated format and may be removed after sept 2006.
1233
def open_repository(self):
1234
"""See BzrDir.open_repository."""
1235
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1236
return RepositoryFormat5().open(self, _found=True)
1238
def open_workingtree(self, _unsupported=False,
1239
recommend_upgrade=True):
1240
"""See BzrDir.create_workingtree."""
1241
from bzrlib.workingtree import WorkingTreeFormat2
1242
wt_format = WorkingTreeFormat2()
1243
# we don't warn here about upgrades; that ought to be handled for the
1245
return wt_format.open(self, _found=True)
1248
class BzrDir6(BzrDirPreSplitOut):
1249
"""A .bzr version 6 control object.
1251
This is a deprecated format and may be removed after sept 2006.
1254
def open_repository(self):
1255
"""See BzrDir.open_repository."""
1256
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1257
return RepositoryFormat6().open(self, _found=True)
1259
def open_workingtree(self, _unsupported=False,
1260
recommend_upgrade=True):
1261
"""See BzrDir.create_workingtree."""
1262
# we don't warn here about upgrades; that ought to be handled for the
1264
from bzrlib.workingtree import WorkingTreeFormat2
1265
return WorkingTreeFormat2().open(self, _found=True)
1268
class BzrDirMeta1(BzrDir):
1269
"""A .bzr meta version 1 control object.
1271
This is the first control object where the
1272
individual aspects are really split out: there are separate repository,
1273
workingtree and branch subdirectories and any subset of the three can be
1274
present within a BzrDir.
1277
def can_convert_format(self):
1278
"""See BzrDir.can_convert_format()."""
1281
def create_branch(self):
1282
"""See BzrDir.create_branch."""
1283
return self._format.get_branch_format().initialize(self)
1285
def destroy_branch(self):
1286
"""See BzrDir.create_branch."""
1287
self.transport.delete_tree('branch')
1289
def create_repository(self, shared=False):
1290
"""See BzrDir.create_repository."""
1291
return self._format.repository_format.initialize(self, shared)
1293
def destroy_repository(self):
1294
"""See BzrDir.destroy_repository."""
1295
self.transport.delete_tree('repository')
1297
def create_workingtree(self, revision_id=None, from_branch=None,
1298
accelerator_tree=None, hardlink=False):
1299
"""See BzrDir.create_workingtree."""
1300
return self._format.workingtree_format.initialize(
1301
self, revision_id, from_branch=from_branch,
1302
accelerator_tree=accelerator_tree, hardlink=hardlink)
1304
def destroy_workingtree(self):
1305
"""See BzrDir.destroy_workingtree."""
1306
wt = self.open_workingtree(recommend_upgrade=False)
1307
repository = wt.branch.repository
1308
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1309
wt.revert(old_tree=empty)
1310
self.destroy_workingtree_metadata()
1312
def destroy_workingtree_metadata(self):
1313
self.transport.delete_tree('checkout')
1315
def find_branch_format(self):
1316
"""Find the branch 'format' for this bzrdir.
1318
This might be a synthetic object for e.g. RemoteBranch and SVN.
1320
from bzrlib.branch import BranchFormat
1321
return BranchFormat.find_format(self)
1323
def _get_mkdir_mode(self):
1324
"""Figure out the mode to use when creating a bzrdir subdir."""
1325
temp_control = lockable_files.LockableFiles(self.transport, '',
1326
lockable_files.TransportLock)
1327
return temp_control._dir_mode
1329
def get_branch_reference(self):
1330
"""See BzrDir.get_branch_reference()."""
1331
from bzrlib.branch import BranchFormat
1332
format = BranchFormat.find_format(self)
1333
return format.get_reference(self)
1335
def get_branch_transport(self, branch_format):
1336
"""See BzrDir.get_branch_transport()."""
1337
if branch_format is None:
1338
return self.transport.clone('branch')
1340
branch_format.get_format_string()
1341
except NotImplementedError:
1342
raise errors.IncompatibleFormat(branch_format, self._format)
1344
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1345
except errors.FileExists:
1347
return self.transport.clone('branch')
1349
def get_repository_transport(self, repository_format):
1350
"""See BzrDir.get_repository_transport()."""
1351
if repository_format is None:
1352
return self.transport.clone('repository')
1354
repository_format.get_format_string()
1355
except NotImplementedError:
1356
raise errors.IncompatibleFormat(repository_format, self._format)
1358
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1359
except errors.FileExists:
1361
return self.transport.clone('repository')
1363
def get_workingtree_transport(self, workingtree_format):
1364
"""See BzrDir.get_workingtree_transport()."""
1365
if workingtree_format is None:
1366
return self.transport.clone('checkout')
1368
workingtree_format.get_format_string()
1369
except NotImplementedError:
1370
raise errors.IncompatibleFormat(workingtree_format, self._format)
1372
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1373
except errors.FileExists:
1375
return self.transport.clone('checkout')
1377
def needs_format_conversion(self, format=None):
1378
"""See BzrDir.needs_format_conversion()."""
1380
format = BzrDirFormat.get_default_format()
1381
if not isinstance(self._format, format.__class__):
1382
# it is not a meta dir format, conversion is needed.
1384
# we might want to push this down to the repository?
1386
if not isinstance(self.open_repository()._format,
1387
format.repository_format.__class__):
1388
# the repository needs an upgrade.
1390
except errors.NoRepositoryPresent:
1393
if not isinstance(self.open_branch()._format,
1394
format.get_branch_format().__class__):
1395
# the branch needs an upgrade.
1397
except errors.NotBranchError:
1400
my_wt = self.open_workingtree(recommend_upgrade=False)
1401
if not isinstance(my_wt._format,
1402
format.workingtree_format.__class__):
1403
# the workingtree needs an upgrade.
1405
except (errors.NoWorkingTree, errors.NotLocalUrl):
1409
def open_branch(self, unsupported=False):
1410
"""See BzrDir.open_branch."""
1411
format = self.find_branch_format()
1412
self._check_supported(format, unsupported)
1413
return format.open(self, _found=True)
1415
def open_repository(self, unsupported=False):
1416
"""See BzrDir.open_repository."""
1417
from bzrlib.repository import RepositoryFormat
1418
format = RepositoryFormat.find_format(self)
1419
self._check_supported(format, unsupported)
1420
return format.open(self, _found=True)
1422
def open_workingtree(self, unsupported=False,
1423
recommend_upgrade=True):
1424
"""See BzrDir.open_workingtree."""
1425
from bzrlib.workingtree import WorkingTreeFormat
1426
format = WorkingTreeFormat.find_format(self)
1427
self._check_supported(format, unsupported,
1429
basedir=self.root_transport.base)
1430
return format.open(self, _found=True)
1433
class BzrDirFormat(object):
1434
"""An encapsulation of the initialization and open routines for a format.
1436
Formats provide three things:
1437
* An initialization routine,
1441
Formats are placed in a dict by their format string for reference
1442
during bzrdir opening. These should be subclasses of BzrDirFormat
1445
Once a format is deprecated, just deprecate the initialize and open
1446
methods on the format class. Do not deprecate the object, as the
1447
object will be created every system load.
1450
_default_format = None
1451
"""The default format used for new .bzr dirs."""
1454
"""The known formats."""
1456
_control_formats = []
1457
"""The registered control formats - .bzr, ....
1459
This is a list of BzrDirFormat objects.
1462
_control_server_formats = []
1463
"""The registered control server formats, e.g. RemoteBzrDirs.
1465
This is a list of BzrDirFormat objects.
1468
_lock_file_name = 'branch-lock'
1470
# _lock_class must be set in subclasses to the lock type, typ.
1471
# TransportLock or LockDir
1474
def find_format(klass, transport, _server_formats=True):
1475
"""Return the format present at transport."""
1477
formats = klass._control_server_formats + klass._control_formats
1479
formats = klass._control_formats
1480
for format in formats:
1482
return format.probe_transport(transport)
1483
except errors.NotBranchError:
1484
# this format does not find a control dir here.
1486
raise errors.NotBranchError(path=transport.base)
1489
def probe_transport(klass, transport):
1490
"""Return the .bzrdir style format present in a directory."""
1492
format_string = transport.get(".bzr/branch-format").read()
1493
except errors.NoSuchFile:
1494
raise errors.NotBranchError(path=transport.base)
1497
return klass._formats[format_string]
1499
raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1502
def get_default_format(klass):
1503
"""Return the current default format."""
1504
return klass._default_format
1506
def get_format_string(self):
1507
"""Return the ASCII format string that identifies this format."""
1508
raise NotImplementedError(self.get_format_string)
1510
def get_format_description(self):
1511
"""Return the short description for this format."""
1512
raise NotImplementedError(self.get_format_description)
1514
def get_converter(self, format=None):
1515
"""Return the converter to use to convert bzrdirs needing converts.
1517
This returns a bzrlib.bzrdir.Converter object.
1519
This should return the best upgrader to step this format towards the
1520
current default format. In the case of plugins we can/should provide
1521
some means for them to extend the range of returnable converters.
1523
:param format: Optional format to override the default format of the
1526
raise NotImplementedError(self.get_converter)
1528
def initialize(self, url, possible_transports=None):
1529
"""Create a bzr control dir at this url and return an opened copy.
1531
Subclasses should typically override initialize_on_transport
1532
instead of this method.
1534
return self.initialize_on_transport(get_transport(url,
1535
possible_transports))
1537
def initialize_on_transport(self, transport):
1538
"""Initialize a new bzrdir in the base directory of a Transport."""
1539
# Since we don't have a .bzr directory, inherit the
1540
# mode from the root directory
1541
temp_control = lockable_files.LockableFiles(transport,
1542
'', lockable_files.TransportLock)
1543
temp_control._transport.mkdir('.bzr',
1544
# FIXME: RBC 20060121 don't peek under
1546
mode=temp_control._dir_mode)
1547
if sys.platform == 'win32' and isinstance(transport, LocalTransport):
1548
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1549
file_mode = temp_control._file_mode
1551
bzrdir_transport = 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(bzrdir_transport,
1560
self._lock_file_name, self._lock_class)
1561
control_files.create_lock()
1562
control_files.lock_write()
1564
for (filename, content) in utf8_files:
1565
bzrdir_transport.put_bytes(filename, content,
1568
control_files.unlock()
1569
return self.open(transport, _found=True)
1571
def is_supported(self):
1572
"""Is this format supported?
1574
Supported formats must be initializable and openable.
1575
Unsupported formats may not support initialization or committing or
1576
some other features depending on the reason for not being supported.
1580
def same_model(self, target_format):
1581
return (self.repository_format.rich_root_data ==
1582
target_format.rich_root_data)
1585
def known_formats(klass):
1586
"""Return all the known formats.
1588
Concrete formats should override _known_formats.
1590
# There is double indirection here to make sure that control
1591
# formats used by more than one dir format will only be probed
1592
# once. This can otherwise be quite expensive for remote connections.
1594
for format in klass._control_formats:
1595
result.update(format._known_formats())
1599
def _known_formats(klass):
1600
"""Return the known format instances for this control format."""
1601
return set(klass._formats.values())
1603
def open(self, transport, _found=False):
1604
"""Return an instance of this format for the dir transport points at.
1606
_found is a private parameter, do not use it.
1609
found_format = BzrDirFormat.find_format(transport)
1610
if not isinstance(found_format, self.__class__):
1611
raise AssertionError("%s was asked to open %s, but it seems to need "
1613
% (self, transport, found_format))
1614
return self._open(transport)
1616
def _open(self, transport):
1617
"""Template method helper for opening BzrDirectories.
1619
This performs the actual open and any additional logic or parameter
1622
raise NotImplementedError(self._open)
1625
def register_format(klass, format):
1626
klass._formats[format.get_format_string()] = format
1629
def register_control_format(klass, format):
1630
"""Register a format that does not use '.bzr' for its control dir.
1632
TODO: This should be pulled up into a 'ControlDirFormat' base class
1633
which BzrDirFormat can inherit from, and renamed to register_format
1634
there. It has been done without that for now for simplicity of
1637
klass._control_formats.append(format)
1640
def register_control_server_format(klass, format):
1641
"""Register a control format for client-server environments.
1643
These formats will be tried before ones registered with
1644
register_control_format. This gives implementations that decide to the
1645
chance to grab it before anything looks at the contents of the format
1648
klass._control_server_formats.append(format)
1651
def _set_default_format(klass, format):
1652
"""Set default format (for testing behavior of defaults only)"""
1653
klass._default_format = format
1657
return self.get_format_string().rstrip()
1660
def unregister_format(klass, format):
1661
del klass._formats[format.get_format_string()]
1664
def unregister_control_format(klass, format):
1665
klass._control_formats.remove(format)
1668
class BzrDirFormat4(BzrDirFormat):
1669
"""Bzr dir format 4.
1671
This format is a combined format for working tree, branch and repository.
1673
- Format 1 working trees [always]
1674
- Format 4 branches [always]
1675
- Format 4 repositories [always]
1677
This format is deprecated: it indexes texts using a text it which is
1678
removed in format 5; write support for this format has been removed.
1681
_lock_class = lockable_files.TransportLock
1683
def get_format_string(self):
1684
"""See BzrDirFormat.get_format_string()."""
1685
return "Bazaar-NG branch, format 0.0.4\n"
1687
def get_format_description(self):
1688
"""See BzrDirFormat.get_format_description()."""
1689
return "All-in-one format 4"
1691
def get_converter(self, format=None):
1692
"""See BzrDirFormat.get_converter()."""
1693
# there is one and only one upgrade path here.
1694
return ConvertBzrDir4To5()
1696
def initialize_on_transport(self, transport):
1697
"""Format 4 branches cannot be created."""
1698
raise errors.UninitializableFormat(self)
1700
def is_supported(self):
1701
"""Format 4 is not supported.
1703
It is not supported because the model changed from 4 to 5 and the
1704
conversion logic is expensive - so doing it on the fly was not
1709
def _open(self, transport):
1710
"""See BzrDirFormat._open."""
1711
return BzrDir4(transport, self)
1713
def __return_repository_format(self):
1714
"""Circular import protection."""
1715
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1716
return RepositoryFormat4()
1717
repository_format = property(__return_repository_format)
1720
class BzrDirFormat5(BzrDirFormat):
1721
"""Bzr control format 5.
1723
This format is a combined format for working tree, branch and repository.
1725
- Format 2 working trees [always]
1726
- Format 4 branches [always]
1727
- Format 5 repositories [always]
1728
Unhashed stores in the repository.
1731
_lock_class = lockable_files.TransportLock
1733
def get_format_string(self):
1734
"""See BzrDirFormat.get_format_string()."""
1735
return "Bazaar-NG branch, format 5\n"
1737
def get_format_description(self):
1738
"""See BzrDirFormat.get_format_description()."""
1739
return "All-in-one format 5"
1741
def get_converter(self, format=None):
1742
"""See BzrDirFormat.get_converter()."""
1743
# there is one and only one upgrade path here.
1744
return ConvertBzrDir5To6()
1746
def _initialize_for_clone(self, url):
1747
return self.initialize_on_transport(get_transport(url), _cloning=True)
1749
def initialize_on_transport(self, transport, _cloning=False):
1750
"""Format 5 dirs always have working tree, branch and repository.
1752
Except when they are being cloned.
1754
from bzrlib.branch import BzrBranchFormat4
1755
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1756
from bzrlib.workingtree import WorkingTreeFormat2
1757
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1758
RepositoryFormat5().initialize(result, _internal=True)
1760
branch = BzrBranchFormat4().initialize(result)
1762
WorkingTreeFormat2().initialize(result)
1763
except errors.NotLocalUrl:
1764
# Even though we can't access the working tree, we need to
1765
# create its control files.
1766
WorkingTreeFormat2()._stub_initialize_remote(branch)
1769
def _open(self, transport):
1770
"""See BzrDirFormat._open."""
1771
return BzrDir5(transport, self)
1773
def __return_repository_format(self):
1774
"""Circular import protection."""
1775
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1776
return RepositoryFormat5()
1777
repository_format = property(__return_repository_format)
1780
class BzrDirFormat6(BzrDirFormat):
1781
"""Bzr control format 6.
1783
This format is a combined format for working tree, branch and repository.
1785
- Format 2 working trees [always]
1786
- Format 4 branches [always]
1787
- Format 6 repositories [always]
1790
_lock_class = lockable_files.TransportLock
1792
def get_format_string(self):
1793
"""See BzrDirFormat.get_format_string()."""
1794
return "Bazaar-NG branch, format 6\n"
1796
def get_format_description(self):
1797
"""See BzrDirFormat.get_format_description()."""
1798
return "All-in-one format 6"
1800
def get_converter(self, format=None):
1801
"""See BzrDirFormat.get_converter()."""
1802
# there is one and only one upgrade path here.
1803
return ConvertBzrDir6ToMeta()
1805
def _initialize_for_clone(self, url):
1806
return self.initialize_on_transport(get_transport(url), _cloning=True)
1808
def initialize_on_transport(self, transport, _cloning=False):
1809
"""Format 6 dirs always have working tree, branch and repository.
1811
Except when they are being cloned.
1813
from bzrlib.branch import BzrBranchFormat4
1814
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1815
from bzrlib.workingtree import WorkingTreeFormat2
1816
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1817
RepositoryFormat6().initialize(result, _internal=True)
1819
branch = BzrBranchFormat4().initialize(result)
1821
WorkingTreeFormat2().initialize(result)
1822
except errors.NotLocalUrl:
1823
# Even though we can't access the working tree, we need to
1824
# create its control files.
1825
WorkingTreeFormat2()._stub_initialize_remote(branch)
1828
def _open(self, transport):
1829
"""See BzrDirFormat._open."""
1830
return BzrDir6(transport, self)
1832
def __return_repository_format(self):
1833
"""Circular import protection."""
1834
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1835
return RepositoryFormat6()
1836
repository_format = property(__return_repository_format)
1839
class BzrDirMetaFormat1(BzrDirFormat):
1840
"""Bzr meta control format 1
1842
This is the first format with split out working tree, branch and repository
1845
- Format 3 working trees [optional]
1846
- Format 5 branches [optional]
1847
- Format 7 repositories [optional]
1850
_lock_class = lockdir.LockDir
1853
self._workingtree_format = None
1854
self._branch_format = None
1856
def __eq__(self, other):
1857
if other.__class__ is not self.__class__:
1859
if other.repository_format != self.repository_format:
1861
if other.workingtree_format != self.workingtree_format:
1865
def __ne__(self, other):
1866
return not self == other
1868
def get_branch_format(self):
1869
if self._branch_format is None:
1870
from bzrlib.branch import BranchFormat
1871
self._branch_format = BranchFormat.get_default_format()
1872
return self._branch_format
1874
def set_branch_format(self, format):
1875
self._branch_format = format
1877
def get_converter(self, format=None):
1878
"""See BzrDirFormat.get_converter()."""
1880
format = BzrDirFormat.get_default_format()
1881
if not isinstance(self, format.__class__):
1882
# converting away from metadir is not implemented
1883
raise NotImplementedError(self.get_converter)
1884
return ConvertMetaToMeta(format)
1886
def get_format_string(self):
1887
"""See BzrDirFormat.get_format_string()."""
1888
return "Bazaar-NG meta directory, format 1\n"
1890
def get_format_description(self):
1891
"""See BzrDirFormat.get_format_description()."""
1892
return "Meta directory format 1"
1894
def _open(self, transport):
1895
"""See BzrDirFormat._open."""
1896
return BzrDirMeta1(transport, self)
1898
def __return_repository_format(self):
1899
"""Circular import protection."""
1900
if getattr(self, '_repository_format', None):
1901
return self._repository_format
1902
from bzrlib.repository import RepositoryFormat
1903
return RepositoryFormat.get_default_format()
1905
def __set_repository_format(self, value):
1906
"""Allow changing the repository format for metadir formats."""
1907
self._repository_format = value
1909
repository_format = property(__return_repository_format, __set_repository_format)
1911
def __get_workingtree_format(self):
1912
if self._workingtree_format is None:
1913
from bzrlib.workingtree import WorkingTreeFormat
1914
self._workingtree_format = WorkingTreeFormat.get_default_format()
1915
return self._workingtree_format
1917
def __set_workingtree_format(self, wt_format):
1918
self._workingtree_format = wt_format
1920
workingtree_format = property(__get_workingtree_format,
1921
__set_workingtree_format)
1924
# Register bzr control format
1925
BzrDirFormat.register_control_format(BzrDirFormat)
1927
# Register bzr formats
1928
BzrDirFormat.register_format(BzrDirFormat4())
1929
BzrDirFormat.register_format(BzrDirFormat5())
1930
BzrDirFormat.register_format(BzrDirFormat6())
1931
__default_format = BzrDirMetaFormat1()
1932
BzrDirFormat.register_format(__default_format)
1933
BzrDirFormat._default_format = __default_format
1936
class Converter(object):
1937
"""Converts a disk format object from one format to another."""
1939
def convert(self, to_convert, pb):
1940
"""Perform the conversion of to_convert, giving feedback via pb.
1942
:param to_convert: The disk object to convert.
1943
:param pb: a progress bar to use for progress information.
1946
def step(self, message):
1947
"""Update the pb by a step."""
1949
self.pb.update(message, self.count, self.total)
1952
class ConvertBzrDir4To5(Converter):
1953
"""Converts format 4 bzr dirs to format 5."""
1956
super(ConvertBzrDir4To5, self).__init__()
1957
self.converted_revs = set()
1958
self.absent_revisions = set()
1962
def convert(self, to_convert, pb):
1963
"""See Converter.convert()."""
1964
self.bzrdir = to_convert
1966
self.pb.note('starting upgrade from format 4 to 5')
1967
if isinstance(self.bzrdir.transport, LocalTransport):
1968
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
1969
self._convert_to_weaves()
1970
return BzrDir.open(self.bzrdir.root_transport.base)
1972
def _convert_to_weaves(self):
1973
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
1976
stat = self.bzrdir.transport.stat('weaves')
1977
if not S_ISDIR(stat.st_mode):
1978
self.bzrdir.transport.delete('weaves')
1979
self.bzrdir.transport.mkdir('weaves')
1980
except errors.NoSuchFile:
1981
self.bzrdir.transport.mkdir('weaves')
1982
# deliberately not a WeaveFile as we want to build it up slowly.
1983
self.inv_weave = Weave('inventory')
1984
# holds in-memory weaves for all files
1985
self.text_weaves = {}
1986
self.bzrdir.transport.delete('branch-format')
1987
self.branch = self.bzrdir.open_branch()
1988
self._convert_working_inv()
1989
rev_history = self.branch.revision_history()
1990
# to_read is a stack holding the revisions we still need to process;
1991
# appending to it adds new highest-priority revisions
1992
self.known_revisions = set(rev_history)
1993
self.to_read = rev_history[-1:]
1995
rev_id = self.to_read.pop()
1996
if (rev_id not in self.revisions
1997
and rev_id not in self.absent_revisions):
1998
self._load_one_rev(rev_id)
2000
to_import = self._make_order()
2001
for i, rev_id in enumerate(to_import):
2002
self.pb.update('converting revision', i, len(to_import))
2003
self._convert_one_rev(rev_id)
2005
self._write_all_weaves()
2006
self._write_all_revs()
2007
self.pb.note('upgraded to weaves:')
2008
self.pb.note(' %6d revisions and inventories', len(self.revisions))
2009
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
2010
self.pb.note(' %6d texts', self.text_count)
2011
self._cleanup_spare_files_after_format4()
2012
self.branch._transport.put_bytes(
2014
BzrDirFormat5().get_format_string(),
2015
mode=self.bzrdir._get_file_mode())
2017
def _cleanup_spare_files_after_format4(self):
2018
# FIXME working tree upgrade foo.
2019
for n in 'merged-patches', 'pending-merged-patches':
2021
## assert os.path.getsize(p) == 0
2022
self.bzrdir.transport.delete(n)
2023
except errors.NoSuchFile:
2025
self.bzrdir.transport.delete_tree('inventory-store')
2026
self.bzrdir.transport.delete_tree('text-store')
2028
def _convert_working_inv(self):
2029
inv = xml4.serializer_v4.read_inventory(
2030
self.branch._transport.get('inventory'))
2031
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2032
self.branch._transport.put_bytes('inventory', new_inv_xml,
2033
mode=self.bzrdir._get_file_mode())
2035
def _write_all_weaves(self):
2036
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2037
weave_transport = self.bzrdir.transport.clone('weaves')
2038
weaves = WeaveStore(weave_transport, prefixed=False)
2039
transaction = WriteTransaction()
2043
for file_id, file_weave in self.text_weaves.items():
2044
self.pb.update('writing weave', i, len(self.text_weaves))
2045
weaves._put_weave(file_id, file_weave, transaction)
2047
self.pb.update('inventory', 0, 1)
2048
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2049
self.pb.update('inventory', 1, 1)
2053
def _write_all_revs(self):
2054
"""Write all revisions out in new form."""
2055
self.bzrdir.transport.delete_tree('revision-store')
2056
self.bzrdir.transport.mkdir('revision-store')
2057
revision_transport = self.bzrdir.transport.clone('revision-store')
2059
from bzrlib.xml5 import serializer_v5
2060
revision_store = RevisionTextStore(revision_transport,
2061
serializer_v5, False, versionedfile.PrefixMapper(),
2062
lambda:True, lambda:True)
2064
for i, rev_id in enumerate(self.converted_revs):
2065
self.pb.update('write revision', i, len(self.converted_revs))
2066
text = serializer_v5.write_revision_to_string(
2067
self.revisions[rev_id])
2069
revision_store.add_lines(key, None, osutils.split_lines(text))
2073
def _load_one_rev(self, rev_id):
2074
"""Load a revision object into memory.
2076
Any parents not either loaded or abandoned get queued to be
2078
self.pb.update('loading revision',
2079
len(self.revisions),
2080
len(self.known_revisions))
2081
if not self.branch.repository.has_revision(rev_id):
2083
self.pb.note('revision {%s} not present in branch; '
2084
'will be converted as a ghost',
2086
self.absent_revisions.add(rev_id)
2088
rev = self.branch.repository.get_revision(rev_id)
2089
for parent_id in rev.parent_ids:
2090
self.known_revisions.add(parent_id)
2091
self.to_read.append(parent_id)
2092
self.revisions[rev_id] = rev
2094
def _load_old_inventory(self, rev_id):
2095
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2096
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2097
inv.revision_id = rev_id
2098
rev = self.revisions[rev_id]
2101
def _load_updated_inventory(self, rev_id):
2102
inv_xml = self.inv_weave.get_text(rev_id)
2103
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2106
def _convert_one_rev(self, rev_id):
2107
"""Convert revision and all referenced objects to new format."""
2108
rev = self.revisions[rev_id]
2109
inv = self._load_old_inventory(rev_id)
2110
present_parents = [p for p in rev.parent_ids
2111
if p not in self.absent_revisions]
2112
self._convert_revision_contents(rev, inv, present_parents)
2113
self._store_new_inv(rev, inv, present_parents)
2114
self.converted_revs.add(rev_id)
2116
def _store_new_inv(self, rev, inv, present_parents):
2117
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2118
new_inv_sha1 = sha_string(new_inv_xml)
2119
self.inv_weave.add_lines(rev.revision_id,
2121
new_inv_xml.splitlines(True))
2122
rev.inventory_sha1 = new_inv_sha1
2124
def _convert_revision_contents(self, rev, inv, present_parents):
2125
"""Convert all the files within a revision.
2127
Also upgrade the inventory to refer to the text revision ids."""
2128
rev_id = rev.revision_id
2129
mutter('converting texts of revision {%s}',
2131
parent_invs = map(self._load_updated_inventory, present_parents)
2132
entries = inv.iter_entries()
2134
for path, ie in entries:
2135
self._convert_file_version(rev, ie, parent_invs)
2137
def _convert_file_version(self, rev, ie, parent_invs):
2138
"""Convert one version of one file.
2140
The file needs to be added into the weave if it is a merge
2141
of >=2 parents or if it's changed from its parent.
2143
file_id = ie.file_id
2144
rev_id = rev.revision_id
2145
w = self.text_weaves.get(file_id)
2148
self.text_weaves[file_id] = w
2149
text_changed = False
2150
parent_candiate_entries = ie.parent_candidates(parent_invs)
2151
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2152
# XXX: Note that this is unordered - and this is tolerable because
2153
# the previous code was also unordered.
2154
previous_entries = dict((head, parent_candiate_entries[head]) for head
2156
self.snapshot_ie(previous_entries, ie, w, rev_id)
2159
@symbol_versioning.deprecated_method(symbol_versioning.one_one)
2160
def get_parents(self, revision_ids):
2161
for revision_id in revision_ids:
2162
yield self.revisions[revision_id].parent_ids
2164
def get_parent_map(self, revision_ids):
2165
"""See graph._StackedParentsProvider.get_parent_map"""
2166
return dict((revision_id, self.revisions[revision_id])
2167
for revision_id in revision_ids
2168
if revision_id in self.revisions)
2170
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2171
# TODO: convert this logic, which is ~= snapshot to
2172
# a call to:. This needs the path figured out. rather than a work_tree
2173
# a v4 revision_tree can be given, or something that looks enough like
2174
# one to give the file content to the entry if it needs it.
2175
# and we need something that looks like a weave store for snapshot to
2177
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2178
if len(previous_revisions) == 1:
2179
previous_ie = previous_revisions.values()[0]
2180
if ie._unchanged(previous_ie):
2181
ie.revision = previous_ie.revision
2184
text = self.branch.repository._text_store.get(ie.text_id)
2185
file_lines = text.readlines()
2186
w.add_lines(rev_id, previous_revisions, file_lines)
2187
self.text_count += 1
2189
w.add_lines(rev_id, previous_revisions, [])
2190
ie.revision = rev_id
2192
def _make_order(self):
2193
"""Return a suitable order for importing revisions.
2195
The order must be such that an revision is imported after all
2196
its (present) parents.
2198
todo = set(self.revisions.keys())
2199
done = self.absent_revisions.copy()
2202
# scan through looking for a revision whose parents
2204
for rev_id in sorted(list(todo)):
2205
rev = self.revisions[rev_id]
2206
parent_ids = set(rev.parent_ids)
2207
if parent_ids.issubset(done):
2208
# can take this one now
2209
order.append(rev_id)
2215
class ConvertBzrDir5To6(Converter):
2216
"""Converts format 5 bzr dirs to format 6."""
2218
def convert(self, to_convert, pb):
2219
"""See Converter.convert()."""
2220
self.bzrdir = to_convert
2222
self.pb.note('starting upgrade from format 5 to 6')
2223
self._convert_to_prefixed()
2224
return BzrDir.open(self.bzrdir.root_transport.base)
2226
def _convert_to_prefixed(self):
2227
from bzrlib.store import TransportStore
2228
self.bzrdir.transport.delete('branch-format')
2229
for store_name in ["weaves", "revision-store"]:
2230
self.pb.note("adding prefixes to %s" % store_name)
2231
store_transport = self.bzrdir.transport.clone(store_name)
2232
store = TransportStore(store_transport, prefixed=True)
2233
for urlfilename in store_transport.list_dir('.'):
2234
filename = urlutils.unescape(urlfilename)
2235
if (filename.endswith(".weave") or
2236
filename.endswith(".gz") or
2237
filename.endswith(".sig")):
2238
file_id, suffix = os.path.splitext(filename)
2242
new_name = store._mapper.map((file_id,)) + suffix
2243
# FIXME keep track of the dirs made RBC 20060121
2245
store_transport.move(filename, new_name)
2246
except errors.NoSuchFile: # catches missing dirs strangely enough
2247
store_transport.mkdir(osutils.dirname(new_name))
2248
store_transport.move(filename, new_name)
2249
self.bzrdir.transport.put_bytes(
2251
BzrDirFormat6().get_format_string(),
2252
mode=self.bzrdir._get_file_mode())
2255
class ConvertBzrDir6ToMeta(Converter):
2256
"""Converts format 6 bzr dirs to metadirs."""
2258
def convert(self, to_convert, pb):
2259
"""See Converter.convert()."""
2260
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2261
from bzrlib.branch import BzrBranchFormat5
2262
self.bzrdir = to_convert
2265
self.total = 20 # the steps we know about
2266
self.garbage_inventories = []
2267
self.dir_mode = self.bzrdir._get_dir_mode()
2268
self.file_mode = self.bzrdir._get_file_mode()
2270
self.pb.note('starting upgrade from format 6 to metadir')
2271
self.bzrdir.transport.put_bytes(
2273
"Converting to format 6",
2274
mode=self.file_mode)
2275
# its faster to move specific files around than to open and use the apis...
2276
# first off, nuke ancestry.weave, it was never used.
2278
self.step('Removing ancestry.weave')
2279
self.bzrdir.transport.delete('ancestry.weave')
2280
except errors.NoSuchFile:
2282
# find out whats there
2283
self.step('Finding branch files')
2284
last_revision = self.bzrdir.open_branch().last_revision()
2285
bzrcontents = self.bzrdir.transport.list_dir('.')
2286
for name in bzrcontents:
2287
if name.startswith('basis-inventory.'):
2288
self.garbage_inventories.append(name)
2289
# create new directories for repository, working tree and branch
2290
repository_names = [('inventory.weave', True),
2291
('revision-store', True),
2293
self.step('Upgrading repository ')
2294
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2295
self.make_lock('repository')
2296
# we hard code the formats here because we are converting into
2297
# the meta format. The meta format upgrader can take this to a
2298
# future format within each component.
2299
self.put_format('repository', RepositoryFormat7())
2300
for entry in repository_names:
2301
self.move_entry('repository', entry)
2303
self.step('Upgrading branch ')
2304
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2305
self.make_lock('branch')
2306
self.put_format('branch', BzrBranchFormat5())
2307
branch_files = [('revision-history', True),
2308
('branch-name', True),
2310
for entry in branch_files:
2311
self.move_entry('branch', entry)
2313
checkout_files = [('pending-merges', True),
2314
('inventory', True),
2315
('stat-cache', False)]
2316
# If a mandatory checkout file is not present, the branch does not have
2317
# a functional checkout. Do not create a checkout in the converted
2319
for name, mandatory in checkout_files:
2320
if mandatory and name not in bzrcontents:
2321
has_checkout = False
2325
if not has_checkout:
2326
self.pb.note('No working tree.')
2327
# If some checkout files are there, we may as well get rid of them.
2328
for name, mandatory in checkout_files:
2329
if name in bzrcontents:
2330
self.bzrdir.transport.delete(name)
2332
from bzrlib.workingtree import WorkingTreeFormat3
2333
self.step('Upgrading working tree')
2334
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2335
self.make_lock('checkout')
2337
'checkout', WorkingTreeFormat3())
2338
self.bzrdir.transport.delete_multi(
2339
self.garbage_inventories, self.pb)
2340
for entry in checkout_files:
2341
self.move_entry('checkout', entry)
2342
if last_revision is not None:
2343
self.bzrdir.transport.put_bytes(
2344
'checkout/last-revision', last_revision)
2345
self.bzrdir.transport.put_bytes(
2347
BzrDirMetaFormat1().get_format_string(),
2348
mode=self.file_mode)
2349
return BzrDir.open(self.bzrdir.root_transport.base)
2351
def make_lock(self, name):
2352
"""Make a lock for the new control dir name."""
2353
self.step('Make %s lock' % name)
2354
ld = lockdir.LockDir(self.bzrdir.transport,
2356
file_modebits=self.file_mode,
2357
dir_modebits=self.dir_mode)
2360
def move_entry(self, new_dir, entry):
2361
"""Move then entry name into new_dir."""
2363
mandatory = entry[1]
2364
self.step('Moving %s' % name)
2366
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2367
except errors.NoSuchFile:
2371
def put_format(self, dirname, format):
2372
self.bzrdir.transport.put_bytes('%s/format' % dirname,
2373
format.get_format_string(),
2377
class ConvertMetaToMeta(Converter):
2378
"""Converts the components of metadirs."""
2380
def __init__(self, target_format):
2381
"""Create a metadir to metadir converter.
2383
:param target_format: The final metadir format that is desired.
2385
self.target_format = target_format
2387
def convert(self, to_convert, pb):
2388
"""See Converter.convert()."""
2389
self.bzrdir = to_convert
2393
self.step('checking repository format')
2395
repo = self.bzrdir.open_repository()
2396
except errors.NoRepositoryPresent:
2399
if not isinstance(repo._format, self.target_format.repository_format.__class__):
2400
from bzrlib.repository import CopyConverter
2401
self.pb.note('starting repository conversion')
2402
converter = CopyConverter(self.target_format.repository_format)
2403
converter.convert(repo, pb)
2405
branch = self.bzrdir.open_branch()
2406
except errors.NotBranchError:
2409
# TODO: conversions of Branch and Tree should be done by
2410
# InterXFormat lookups
2411
# Avoid circular imports
2412
from bzrlib import branch as _mod_branch
2413
if (branch._format.__class__ is _mod_branch.BzrBranchFormat5 and
2414
self.target_format.get_branch_format().__class__ is
2415
_mod_branch.BzrBranchFormat6):
2416
branch_converter = _mod_branch.Converter5to6()
2417
branch_converter.convert(branch)
2419
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
2420
except (errors.NoWorkingTree, errors.NotLocalUrl):
2423
# TODO: conversions of Branch and Tree should be done by
2424
# InterXFormat lookups
2425
if (isinstance(tree, workingtree.WorkingTree3) and
2426
not isinstance(tree, workingtree_4.WorkingTree4) and
2427
isinstance(self.target_format.workingtree_format,
2428
workingtree_4.WorkingTreeFormat4)):
2429
workingtree_4.Converter3to4().convert(tree)
2433
# This is not in remote.py because it's small, and needs to be registered.
2434
# Putting it in remote.py creates a circular import problem.
2435
# we can make it a lazy object if the control formats is turned into something
2437
class RemoteBzrDirFormat(BzrDirMetaFormat1):
2438
"""Format representing bzrdirs accessed via a smart server"""
2440
def get_format_description(self):
2441
return 'bzr remote bzrdir'
2444
def probe_transport(klass, transport):
2445
"""Return a RemoteBzrDirFormat object if it looks possible."""
2447
medium = transport.get_smart_medium()
2448
except (NotImplementedError, AttributeError,
2449
errors.TransportNotPossible, errors.NoSmartMedium,
2450
errors.SmartProtocolError):
2451
# no smart server, so not a branch for this format type.
2452
raise errors.NotBranchError(path=transport.base)
2454
# Decline to open it if the server doesn't support our required
2455
# version (3) so that the VFS-based transport will do it.
2456
if medium.should_probe():
2458
server_version = medium.protocol_version()
2459
except errors.SmartProtocolError:
2460
# Apparently there's no usable smart server there, even though
2461
# the medium supports the smart protocol.
2462
raise errors.NotBranchError(path=transport.base)
2463
if server_version != '2':
2464
raise errors.NotBranchError(path=transport.base)
2467
def initialize_on_transport(self, transport):
2469
# hand off the request to the smart server
2470
client_medium = transport.get_smart_medium()
2471
except errors.NoSmartMedium:
2472
# TODO: lookup the local format from a server hint.
2473
local_dir_format = BzrDirMetaFormat1()
2474
return local_dir_format.initialize_on_transport(transport)
2475
client = _SmartClient(client_medium)
2476
path = client.remote_path_from_transport(transport)
2477
response = client.call('BzrDirFormat.initialize', path)
2478
if response[0] != 'ok':
2479
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
2480
return remote.RemoteBzrDir(transport)
2482
def _open(self, transport):
2483
return remote.RemoteBzrDir(transport)
2485
def __eq__(self, other):
2486
if not isinstance(other, RemoteBzrDirFormat):
2488
return self.get_format_description() == other.get_format_description()
2491
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
2494
class BzrDirFormatInfo(object):
2496
def __init__(self, native, deprecated, hidden, experimental):
2497
self.deprecated = deprecated
2498
self.native = native
2499
self.hidden = hidden
2500
self.experimental = experimental
2503
class BzrDirFormatRegistry(registry.Registry):
2504
"""Registry of user-selectable BzrDir subformats.
2506
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
2507
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
2511
"""Create a BzrDirFormatRegistry."""
2512
self._aliases = set()
2513
super(BzrDirFormatRegistry, self).__init__()
2516
"""Return a set of the format names which are aliases."""
2517
return frozenset(self._aliases)
2519
def register_metadir(self, key,
2520
repository_format, help, native=True, deprecated=False,
2526
"""Register a metadir subformat.
2528
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
2529
by the Repository format.
2531
:param repository_format: The fully-qualified repository format class
2533
:param branch_format: Fully-qualified branch format class name as
2535
:param tree_format: Fully-qualified tree format class name as
2538
# This should be expanded to support setting WorkingTree and Branch
2539
# formats, once BzrDirMetaFormat1 supports that.
2540
def _load(full_name):
2541
mod_name, factory_name = full_name.rsplit('.', 1)
2543
mod = __import__(mod_name, globals(), locals(),
2545
except ImportError, e:
2546
raise ImportError('failed to load %s: %s' % (full_name, e))
2548
factory = getattr(mod, factory_name)
2549
except AttributeError:
2550
raise AttributeError('no factory %s in module %r'
2555
bd = BzrDirMetaFormat1()
2556
if branch_format is not None:
2557
bd.set_branch_format(_load(branch_format))
2558
if tree_format is not None:
2559
bd.workingtree_format = _load(tree_format)
2560
if repository_format is not None:
2561
bd.repository_format = _load(repository_format)
2563
self.register(key, helper, help, native, deprecated, hidden,
2564
experimental, alias)
2566
def register(self, key, factory, help, native=True, deprecated=False,
2567
hidden=False, experimental=False, alias=False):
2568
"""Register a BzrDirFormat factory.
2570
The factory must be a callable that takes one parameter: the key.
2571
It must produce an instance of the BzrDirFormat when called.
2573
This function mainly exists to prevent the info object from being
2576
registry.Registry.register(self, key, factory, help,
2577
BzrDirFormatInfo(native, deprecated, hidden, experimental))
2579
self._aliases.add(key)
2581
def register_lazy(self, key, module_name, member_name, help, native=True,
2582
deprecated=False, hidden=False, experimental=False, alias=False):
2583
registry.Registry.register_lazy(self, key, module_name, member_name,
2584
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
2586
self._aliases.add(key)
2588
def set_default(self, key):
2589
"""Set the 'default' key to be a clone of the supplied key.
2591
This method must be called once and only once.
2593
registry.Registry.register(self, 'default', self.get(key),
2594
self.get_help(key), info=self.get_info(key))
2595
self._aliases.add('default')
2597
def set_default_repository(self, key):
2598
"""Set the FormatRegistry default and Repository default.
2600
This is a transitional method while Repository.set_default_format
2603
if 'default' in self:
2604
self.remove('default')
2605
self.set_default(key)
2606
format = self.get('default')()
2608
def make_bzrdir(self, key):
2609
return self.get(key)()
2611
def help_topic(self, topic):
2612
output = textwrap.dedent("""\
2613
These formats can be used for creating branches, working trees, and
2617
default_realkey = None
2618
default_help = self.get_help('default')
2620
for key in self.keys():
2621
if key == 'default':
2623
help = self.get_help(key)
2624
if help == default_help:
2625
default_realkey = key
2627
help_pairs.append((key, help))
2629
def wrapped(key, help, info):
2631
help = '(native) ' + help
2632
return ':%s:\n%s\n\n' % (key,
2633
textwrap.fill(help, initial_indent=' ',
2634
subsequent_indent=' '))
2635
if default_realkey is not None:
2636
output += wrapped(default_realkey, '(default) %s' % default_help,
2637
self.get_info('default'))
2638
deprecated_pairs = []
2639
experimental_pairs = []
2640
for key, help in help_pairs:
2641
info = self.get_info(key)
2644
elif info.deprecated:
2645
deprecated_pairs.append((key, help))
2646
elif info.experimental:
2647
experimental_pairs.append((key, help))
2649
output += wrapped(key, help, info)
2650
if len(experimental_pairs) > 0:
2651
output += "Experimental formats are shown below.\n\n"
2652
for key, help in experimental_pairs:
2653
info = self.get_info(key)
2654
output += wrapped(key, help, info)
2655
if len(deprecated_pairs) > 0:
2656
output += "Deprecated formats are shown below.\n\n"
2657
for key, help in deprecated_pairs:
2658
info = self.get_info(key)
2659
output += wrapped(key, help, info)
2664
class RepositoryAcquisitionPolicy(object):
2665
"""Abstract base class for repository acquisition policies.
2667
A repository acquisition policy decides how a BzrDir acquires a repository
2668
for a branch that is being created. The most basic policy decision is
2669
whether to create a new repository or use an existing one.
2672
def configure_branch(self, branch):
2673
"""Apply any configuration data from this policy to the branch.
2675
Default implementation does nothing.
2679
def acquire_repository(self, make_working_trees=None, shared=False):
2680
"""Acquire a repository for this bzrdir.
2682
Implementations may create a new repository or use a pre-exising
2684
:param make_working_trees: If creating a repository, set
2685
make_working_trees to this value (if non-None)
2686
:param shared: If creating a repository, make it shared if True
2687
:return: A repository
2689
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
2692
class CreateRepository(RepositoryAcquisitionPolicy):
2693
"""A policy of creating a new repository"""
2695
def __init__(self, bzrdir):
2696
RepositoryAcquisitionPolicy.__init__(self)
2697
self._bzrdir = bzrdir
2699
def acquire_repository(self, make_working_trees=None, shared=False):
2700
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
2702
Creates the desired repository in the bzrdir we already have.
2704
repository = self._bzrdir.create_repository(shared=shared)
2705
if make_working_trees is not None:
2706
repository.set_make_working_trees(make_working_trees)
2710
class UseExistingRepository(RepositoryAcquisitionPolicy):
2711
"""A policy of reusing an existing repository"""
2713
def __init__(self, repository):
2714
RepositoryAcquisitionPolicy.__init__(self)
2715
self._repository = repository
2717
def acquire_repository(self, make_working_trees=None, shared=False):
2718
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
2720
Returns an existing repository to use
2722
return self._repository
2725
format_registry = BzrDirFormatRegistry()
2726
format_registry.register('weave', BzrDirFormat6,
2727
'Pre-0.8 format. Slower than knit and does not'
2728
' support checkouts or shared repositories.',
2730
format_registry.register_metadir('knit',
2731
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2732
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
2733
branch_format='bzrlib.branch.BzrBranchFormat5',
2734
tree_format='bzrlib.workingtree.WorkingTreeFormat3')
2735
format_registry.register_metadir('metaweave',
2736
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
2737
'Transitional format in 0.8. Slower than knit.',
2738
branch_format='bzrlib.branch.BzrBranchFormat5',
2739
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2741
format_registry.register_metadir('dirstate',
2742
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2743
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2744
'above when accessed over the network.',
2745
branch_format='bzrlib.branch.BzrBranchFormat5',
2746
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
2747
# directly from workingtree_4 triggers a circular import.
2748
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2750
format_registry.register_metadir('dirstate-tags',
2751
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2752
help='New in 0.15: Fast local operations and improved scaling for '
2753
'network operations. Additionally adds support for tags.'
2754
' Incompatible with bzr < 0.15.',
2755
branch_format='bzrlib.branch.BzrBranchFormat6',
2756
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2758
format_registry.register_metadir('rich-root',
2759
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
2760
help='New in 1.0. Better handling of tree roots. Incompatible with'
2762
branch_format='bzrlib.branch.BzrBranchFormat6',
2763
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2765
format_registry.register_metadir('dirstate-with-subtree',
2766
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2767
help='New in 0.15: Fast local operations and improved scaling for '
2768
'network operations. Additionally adds support for versioning nested '
2769
'bzr branches. Incompatible with bzr < 0.15.',
2770
branch_format='bzrlib.branch.BzrBranchFormat6',
2771
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2775
format_registry.register_metadir('pack-0.92',
2776
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
2777
help='New in 0.92: Pack-based format with data compatible with '
2778
'dirstate-tags format repositories. Interoperates with '
2779
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2780
'Previously called knitpack-experimental. '
2781
'For more information, see '
2782
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2783
branch_format='bzrlib.branch.BzrBranchFormat6',
2784
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2786
format_registry.register_metadir('pack-0.92-subtree',
2787
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
2788
help='New in 0.92: Pack-based format with data compatible with '
2789
'dirstate-with-subtree format repositories. Interoperates with '
2790
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2791
'Previously called knitpack-experimental. '
2792
'For more information, see '
2793
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2794
branch_format='bzrlib.branch.BzrBranchFormat6',
2795
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2799
format_registry.register_metadir('rich-root-pack',
2800
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
2801
help='New in 1.0: Pack-based format with data compatible with '
2802
'rich-root format repositories. Incompatible with'
2804
branch_format='bzrlib.branch.BzrBranchFormat6',
2805
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2807
# The following two formats should always just be aliases.
2808
format_registry.register_metadir('development',
2809
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
2810
help='Current development format. Can convert data to and from pack-0.92 '
2811
'(and anything compatible with pack-0.92) format repositories. '
2812
'Repositories in this format can only be read by bzr.dev. '
2814
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2816
branch_format='bzrlib.branch.BzrBranchFormat6',
2817
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2821
format_registry.register_metadir('development-subtree',
2822
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
2823
help='Current development format, subtree variant. Can convert data to and '
2824
'from pack-0.92 (and anything compatible with pack-0.92) format '
2825
'repositories. Repositories in this format can only be read by '
2826
'bzr.dev. Please read '
2827
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2829
branch_format='bzrlib.branch.BzrBranchFormat6',
2830
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2834
# And the development formats which the will have aliased one of follow:
2835
format_registry.register_metadir('development0',
2836
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
2837
help='Trivial rename of pack-0.92 to provide a development format. '
2839
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2841
branch_format='bzrlib.branch.BzrBranchFormat6',
2842
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2846
format_registry.register_metadir('development0-subtree',
2847
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
2848
help='Trivial rename of pack-0.92-subtree to provide a development format. '
2850
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2852
branch_format='bzrlib.branch.BzrBranchFormat6',
2853
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2857
format_registry.set_default('pack-0.92')
added
removed
bzrlib/bzrdir.py
