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.store.versioned import WeaveStore
67
from bzrlib.transactions import WriteTransaction
68
from bzrlib.transport import (
69
do_catching_redirections,
72
from bzrlib.weave import Weave
75
from bzrlib.trace import (
79
from bzrlib.transport.local import LocalTransport
80
from bzrlib.symbol_versioning import (
87
"""A .bzr control diretory.
89
BzrDir instances let you create or open any of the things that can be
90
found within .bzr - checkouts, branches and repositories.
93
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
95
a transport connected to the directory this bzr was opened from
96
(i.e. the parent directory holding the .bzr directory).
98
Everything in the bzrdir should have the same file permissions.
101
def break_lock(self):
102
"""Invoke break_lock on the first object in the bzrdir.
104
If there is a tree, the tree is opened and break_lock() called.
105
Otherwise, branch is tried, and finally repository.
107
# XXX: This seems more like a UI function than something that really
108
# belongs in this class.
110
thing_to_unlock = self.open_workingtree()
111
except (errors.NotLocalUrl, errors.NoWorkingTree):
113
thing_to_unlock = self.open_branch()
114
except errors.NotBranchError:
116
thing_to_unlock = self.open_repository()
117
except errors.NoRepositoryPresent:
119
thing_to_unlock.break_lock()
121
def can_convert_format(self):
122
"""Return true if this bzrdir is one whose format we can convert from."""
125
def check_conversion_target(self, target_format):
126
target_repo_format = target_format.repository_format
127
source_repo_format = self._format.repository_format
128
source_repo_format.check_conversion_target(target_repo_format)
131
def _check_supported(format, allow_unsupported,
132
recommend_upgrade=True,
134
"""Give an error or warning on old formats.
136
:param format: may be any kind of format - workingtree, branch,
139
:param allow_unsupported: If true, allow opening
140
formats that are strongly deprecated, and which may
141
have limited functionality.
143
:param recommend_upgrade: If true (default), warn
144
the user through the ui object that they may wish
145
to upgrade the object.
147
# TODO: perhaps move this into a base Format class; it's not BzrDir
148
# specific. mbp 20070323
149
if not allow_unsupported and not format.is_supported():
150
# see open_downlevel to open legacy branches.
151
raise errors.UnsupportedFormatError(format=format)
152
if recommend_upgrade \
153
and getattr(format, 'upgrade_recommended', False):
154
ui.ui_factory.recommend_upgrade(
155
format.get_format_description(),
158
def clone(self, url, revision_id=None, force_new_repo=False):
159
"""Clone this bzrdir and its contents to url verbatim.
161
If url's last component does not exist, it will be created.
163
if revision_id is not None, then the clone operation may tune
164
itself to download less data.
165
:param force_new_repo: Do not use a shared repository for the target
166
even if one is available.
168
return self.clone_on_transport(get_transport(url),
169
revision_id=revision_id,
170
force_new_repo=force_new_repo)
172
def clone_on_transport(self, transport, revision_id=None,
173
force_new_repo=False):
174
"""Clone this bzrdir and its contents to transport verbatim.
176
If the target directory does not exist, it will be created.
178
if revision_id is not None, then the clone operation may tune
179
itself to download less data.
180
:param force_new_repo: Do not use a shared repository for the target
181
even if one is available.
183
transport.ensure_base()
184
result = self.cloning_metadir().initialize_on_transport(transport)
185
repository_policy = None
187
local_repo = self.find_repository()
188
except errors.NoRepositoryPresent:
191
# may need to copy content in
192
repository_policy = result.determine_repository_policy(
194
make_working_trees = local_repo.make_working_trees()
195
result_repo = repository_policy.acquire_repository(
196
make_working_trees, local_repo.is_shared())
197
result_repo.fetch(local_repo, revision_id=revision_id)
198
# 1 if there is a branch present
199
# make sure its content is available in the target repository
202
local_branch = self.open_branch()
203
except errors.NotBranchError:
206
result_branch = local_branch.clone(result, revision_id=revision_id)
207
if repository_policy is not None:
208
repository_policy.configure_branch(result_branch)
210
result_repo = result.find_repository()
211
except errors.NoRepositoryPresent:
213
if result_repo is None or result_repo.make_working_trees():
215
self.open_workingtree().clone(result)
216
except (errors.NoWorkingTree, errors.NotLocalUrl):
220
# TODO: This should be given a Transport, and should chdir up; otherwise
221
# this will open a new connection.
222
def _make_tail(self, url):
223
t = get_transport(url)
227
def create(cls, base, format=None, possible_transports=None):
228
"""Create a new BzrDir at the url 'base'.
230
:param format: If supplied, the format of branch to create. If not
231
supplied, the default is used.
232
:param possible_transports: If supplied, a list of transports that
233
can be reused to share a remote connection.
235
if cls is not BzrDir:
236
raise AssertionError("BzrDir.create always creates the default"
237
" format, not one of %r" % cls)
238
t = get_transport(base, possible_transports)
241
format = BzrDirFormat.get_default_format()
242
return format.initialize_on_transport(t)
245
def find_bzrdirs(transport, evaluate=None, list_current=None):
246
"""Find bzrdirs recursively from current location.
248
This is intended primarily as a building block for more sophisticated
249
functionality, like finding trees under a directory, or finding
250
branches that use a given repository.
251
:param evaluate: An optional callable that yields recurse, value,
252
where recurse controls whether this bzrdir is recursed into
253
and value is the value to yield. By default, all bzrdirs
254
are recursed into, and the return value is the bzrdir.
255
:param list_current: if supplied, use this function to list the current
256
directory, instead of Transport.list_dir
257
:return: a generator of found bzrdirs, or whatever evaluate returns.
259
if list_current is None:
260
def list_current(transport):
261
return transport.list_dir('')
263
def evaluate(bzrdir):
266
pending = [transport]
267
while len(pending) > 0:
268
current_transport = pending.pop()
271
bzrdir = BzrDir.open_from_transport(current_transport)
272
except errors.NotBranchError:
275
recurse, value = evaluate(bzrdir)
278
subdirs = list_current(current_transport)
279
except errors.NoSuchFile:
282
for subdir in sorted(subdirs, reverse=True):
283
pending.append(current_transport.clone(subdir))
286
def find_branches(transport):
287
"""Find all branches under a transport.
289
This will find all branches below the transport, including branches
290
inside other branches. Where possible, it will use
291
Repository.find_branches.
293
To list all the branches that use a particular Repository, see
294
Repository.find_branches
296
def evaluate(bzrdir):
298
repository = bzrdir.open_repository()
299
except errors.NoRepositoryPresent:
302
return False, (None, repository)
304
branch = bzrdir.open_branch()
305
except errors.NotBranchError:
306
return True, (None, None)
308
return True, (branch, None)
310
for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
312
branches.extend(repo.find_branches())
313
if branch is not None:
314
branches.append(branch)
317
def destroy_repository(self):
318
"""Destroy the repository in this BzrDir"""
319
raise NotImplementedError(self.destroy_repository)
321
def create_branch(self):
322
"""Create a branch in this BzrDir.
324
The bzrdir's format will control what branch format is created.
325
For more control see BranchFormatXX.create(a_bzrdir).
327
raise NotImplementedError(self.create_branch)
329
def destroy_branch(self):
330
"""Destroy the branch in this BzrDir"""
331
raise NotImplementedError(self.destroy_branch)
334
def create_branch_and_repo(base, force_new_repo=False, format=None):
335
"""Create a new BzrDir, Branch and Repository at the url 'base'.
337
This will use the current default BzrDirFormat unless one is
338
specified, and use whatever
339
repository format that that uses via bzrdir.create_branch and
340
create_repository. If a shared repository is available that is used
343
The created Branch object is returned.
345
:param base: The URL to create the branch at.
346
:param force_new_repo: If True a new repository is always created.
347
:param format: If supplied, the format of branch to create. If not
348
supplied, the default is used.
350
bzrdir = BzrDir.create(base, format)
351
bzrdir._find_or_create_repository(force_new_repo)
352
return bzrdir.create_branch()
354
def determine_repository_policy(self, force_new_repo=False):
355
"""Return an object representing a policy to use.
357
This controls whether a new repository is created, or a shared
358
repository used instead.
360
def repository_policy(found_bzrdir):
362
# does it have a repository ?
364
repository = found_bzrdir.open_repository()
365
except errors.NoRepositoryPresent:
368
if ((found_bzrdir.root_transport.base !=
369
self.root_transport.base) and not repository.is_shared()):
376
return UseExistingRepository(repository), True
378
return CreateRepository(self), True
380
if not force_new_repo:
381
policy = self._find_containing(repository_policy)
382
if policy is not None:
384
return CreateRepository(self)
386
def _find_or_create_repository(self, force_new_repo):
387
"""Create a new repository if needed, returning the repository."""
388
policy = self.determine_repository_policy(force_new_repo)
389
return policy.acquire_repository()
392
def create_branch_convenience(base, force_new_repo=False,
393
force_new_tree=None, format=None,
394
possible_transports=None):
395
"""Create a new BzrDir, Branch and Repository at the url 'base'.
397
This is a convenience function - it will use an existing repository
398
if possible, can be told explicitly whether to create a working tree or
401
This will use the current default BzrDirFormat unless one is
402
specified, and use whatever
403
repository format that that uses via bzrdir.create_branch and
404
create_repository. If a shared repository is available that is used
405
preferentially. Whatever repository is used, its tree creation policy
408
The created Branch object is returned.
409
If a working tree cannot be made due to base not being a file:// url,
410
no error is raised unless force_new_tree is True, in which case no
411
data is created on disk and NotLocalUrl is raised.
413
:param base: The URL to create the branch at.
414
:param force_new_repo: If True a new repository is always created.
415
:param force_new_tree: If True or False force creation of a tree or
416
prevent such creation respectively.
417
:param format: Override for the bzrdir format to create.
418
:param possible_transports: An optional reusable transports list.
421
# check for non local urls
422
t = get_transport(base, possible_transports)
423
if not isinstance(t, LocalTransport):
424
raise errors.NotLocalUrl(base)
425
bzrdir = BzrDir.create(base, format, possible_transports)
426
repo = bzrdir._find_or_create_repository(force_new_repo)
427
result = bzrdir.create_branch()
428
if force_new_tree or (repo.make_working_trees() and
429
force_new_tree is None):
431
bzrdir.create_workingtree()
432
except errors.NotLocalUrl:
437
def create_standalone_workingtree(base, format=None):
438
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
440
'base' must be a local path or a file:// url.
442
This will use the current default BzrDirFormat unless one is
443
specified, and use whatever
444
repository format that that uses for bzrdirformat.create_workingtree,
445
create_branch and create_repository.
447
:param format: Override for the bzrdir format to create.
448
:return: The WorkingTree object.
450
t = get_transport(base)
451
if not isinstance(t, LocalTransport):
452
raise errors.NotLocalUrl(base)
453
bzrdir = BzrDir.create_branch_and_repo(base,
455
format=format).bzrdir
456
return bzrdir.create_workingtree()
458
def create_workingtree(self, revision_id=None, from_branch=None,
459
accelerator_tree=None, hardlink=False):
460
"""Create a working tree at this BzrDir.
462
:param revision_id: create it as of this revision id.
463
:param from_branch: override bzrdir branch (for lightweight checkouts)
464
:param accelerator_tree: A tree which can be used for retrieving file
465
contents more quickly than the revision tree, i.e. a workingtree.
466
The revision tree will be used for cases where accelerator_tree's
467
content is different.
469
raise NotImplementedError(self.create_workingtree)
471
def retire_bzrdir(self, limit=10000):
472
"""Permanently disable the bzrdir.
474
This is done by renaming it to give the user some ability to recover
475
if there was a problem.
477
This will have horrible consequences if anyone has anything locked or
479
:param limit: number of times to retry
484
to_path = '.bzr.retired.%d' % i
485
self.root_transport.rename('.bzr', to_path)
486
note("renamed %s to %s"
487
% (self.root_transport.abspath('.bzr'), to_path))
489
except (errors.TransportError, IOError, errors.PathError):
496
def destroy_workingtree(self):
497
"""Destroy the working tree at this BzrDir.
499
Formats that do not support this may raise UnsupportedOperation.
501
raise NotImplementedError(self.destroy_workingtree)
503
def destroy_workingtree_metadata(self):
504
"""Destroy the control files for the working tree at this BzrDir.
506
The contents of working tree files are not affected.
507
Formats that do not support this may raise UnsupportedOperation.
509
raise NotImplementedError(self.destroy_workingtree_metadata)
511
def _find_containing(self, evaluate):
512
"""Find something in a containing control directory.
514
This method will scan containing control dirs, until it finds what
515
it is looking for, decides that it will never find it, or runs out
516
of containing control directories to check.
518
It is used to implement find_repository and
519
determine_repository_policy.
521
:param evaluate: A function returning (value, stop). If stop is True,
522
the value will be returned.
526
result, stop = evaluate(found_bzrdir)
529
next_transport = found_bzrdir.root_transport.clone('..')
530
if (found_bzrdir.root_transport.base == next_transport.base):
531
# top of the file system
533
# find the next containing bzrdir
535
found_bzrdir = BzrDir.open_containing_from_transport(
537
except errors.NotBranchError:
540
def find_repository(self):
541
"""Find the repository that should be used.
543
This does not require a branch as we use it to find the repo for
544
new branches as well as to hook existing branches up to their
547
def usable_repository(found_bzrdir):
548
# does it have a repository ?
550
repository = found_bzrdir.open_repository()
551
except errors.NoRepositoryPresent:
553
if found_bzrdir.root_transport.base == self.root_transport.base:
554
return repository, True
555
elif repository.is_shared():
556
return repository, True
560
found_repo = self._find_containing(usable_repository)
561
if found_repo is None:
562
raise errors.NoRepositoryPresent(self)
565
def get_branch_reference(self):
566
"""Return the referenced URL for the branch in this bzrdir.
568
:raises NotBranchError: If there is no Branch.
569
:return: The URL the branch in this bzrdir references if it is a
570
reference branch, or None for regular branches.
574
def get_branch_transport(self, branch_format):
575
"""Get the transport for use by branch format in this BzrDir.
577
Note that bzr dirs that do not support format strings will raise
578
IncompatibleFormat if the branch format they are given has
579
a format string, and vice versa.
581
If branch_format is None, the transport is returned with no
582
checking. If it is not None, then the returned transport is
583
guaranteed to point to an existing directory ready for use.
585
raise NotImplementedError(self.get_branch_transport)
587
def _find_creation_modes(self):
588
"""Determine the appropriate modes for files and directories.
590
They're always set to be consistent with the base directory,
591
assuming that this transport allows setting modes.
593
# TODO: Do we need or want an option (maybe a config setting) to turn
594
# this off or override it for particular locations? -- mbp 20080512
595
if self._mode_check_done:
597
self._mode_check_done = True
599
st = self.transport.stat('.')
600
except errors.TransportNotPossible:
601
self._dir_mode = None
602
self._file_mode = None
604
# Check the directory mode, but also make sure the created
605
# directories and files are read-write for this user. This is
606
# mostly a workaround for filesystems which lie about being able to
607
# write to a directory (cygwin & win32)
608
self._dir_mode = (st.st_mode & 07777) | 00700
609
# Remove the sticky and execute bits for files
610
self._file_mode = self._dir_mode & ~07111
612
def _get_file_mode(self):
613
"""Return Unix mode for newly created files, or None.
615
if not self._mode_check_done:
616
self._find_creation_modes()
617
return self._file_mode
619
def _get_dir_mode(self):
620
"""Return Unix mode for newly created directories, or None.
622
if not self._mode_check_done:
623
self._find_creation_modes()
624
return self._dir_mode
626
def get_repository_transport(self, repository_format):
627
"""Get the transport for use by repository format in this BzrDir.
629
Note that bzr dirs that do not support format strings will raise
630
IncompatibleFormat if the repository format they are given has
631
a format string, and vice versa.
633
If repository_format is None, the transport is returned with no
634
checking. If it is not None, then the returned transport is
635
guaranteed to point to an existing directory ready for use.
637
raise NotImplementedError(self.get_repository_transport)
639
def get_workingtree_transport(self, tree_format):
640
"""Get the transport for use by workingtree format in this BzrDir.
642
Note that bzr dirs that do not support format strings will raise
643
IncompatibleFormat if the workingtree format they are given has a
644
format string, and vice versa.
646
If workingtree_format is None, the transport is returned with no
647
checking. If it is not None, then the returned transport is
648
guaranteed to point to an existing directory ready for use.
650
raise NotImplementedError(self.get_workingtree_transport)
652
def __init__(self, _transport, _format):
653
"""Initialize a Bzr control dir object.
655
Only really common logic should reside here, concrete classes should be
656
made with varying behaviours.
658
:param _format: the format that is creating this BzrDir instance.
659
:param _transport: the transport this dir is based at.
661
self._format = _format
662
self.transport = _transport.clone('.bzr')
663
self.root_transport = _transport
664
self._mode_check_done = False
666
def is_control_filename(self, filename):
667
"""True if filename is the name of a path which is reserved for bzrdir's.
669
:param filename: A filename within the root transport of this bzrdir.
671
This is true IF and ONLY IF the filename is part of the namespace reserved
672
for bzr control dirs. Currently this is the '.bzr' directory in the root
673
of the root_transport. it is expected that plugins will need to extend
674
this in the future - for instance to make bzr talk with svn working
677
# this might be better on the BzrDirFormat class because it refers to
678
# all the possible bzrdir disk formats.
679
# This method is tested via the workingtree is_control_filename tests-
680
# it was extracted from WorkingTree.is_control_filename. If the method's
681
# contract is extended beyond the current trivial implementation, please
682
# add new tests for it to the appropriate place.
683
return filename == '.bzr' or filename.startswith('.bzr/')
685
def needs_format_conversion(self, format=None):
686
"""Return true if this bzrdir needs convert_format run on it.
688
For instance, if the repository format is out of date but the
689
branch and working tree are not, this should return True.
691
:param format: Optional parameter indicating a specific desired
692
format we plan to arrive at.
694
raise NotImplementedError(self.needs_format_conversion)
697
def open_unsupported(base):
698
"""Open a branch which is not supported."""
699
return BzrDir.open(base, _unsupported=True)
702
def open(base, _unsupported=False, possible_transports=None):
703
"""Open an existing bzrdir, rooted at 'base' (url).
705
:param _unsupported: a private parameter to the BzrDir class.
707
t = get_transport(base, possible_transports=possible_transports)
708
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
711
def open_from_transport(transport, _unsupported=False,
712
_server_formats=True):
713
"""Open a bzrdir within a particular directory.
715
:param transport: Transport containing the bzrdir.
716
:param _unsupported: private.
718
base = transport.base
720
def find_format(transport):
721
return transport, BzrDirFormat.find_format(
722
transport, _server_formats=_server_formats)
724
def redirected(transport, e, redirection_notice):
725
qualified_source = e.get_source_url()
726
relpath = transport.relpath(qualified_source)
727
if not e.target.endswith(relpath):
728
# Not redirected to a branch-format, not a branch
729
raise errors.NotBranchError(path=e.target)
730
target = e.target[:-len(relpath)]
731
note('%s is%s redirected to %s',
732
transport.base, e.permanently, target)
733
# Let's try with a new transport
734
# FIXME: If 'transport' has a qualifier, this should
735
# be applied again to the new transport *iff* the
736
# schemes used are the same. Uncomment this code
737
# once the function (and tests) exist.
739
#target = urlutils.copy_url_qualifiers(original, target)
740
return get_transport(target)
743
transport, format = do_catching_redirections(find_format,
746
except errors.TooManyRedirections:
747
raise errors.NotBranchError(base)
749
BzrDir._check_supported(format, _unsupported)
750
return format.open(transport, _found=True)
752
def open_branch(self, unsupported=False):
753
"""Open the branch object at this BzrDir if one is present.
755
If unsupported is True, then no longer supported branch formats can
758
TODO: static convenience version of this?
760
raise NotImplementedError(self.open_branch)
763
def open_containing(url, possible_transports=None):
764
"""Open an existing branch which contains url.
766
:param url: url to search from.
767
See open_containing_from_transport for more detail.
769
transport = get_transport(url, possible_transports)
770
return BzrDir.open_containing_from_transport(transport)
773
def open_containing_from_transport(a_transport):
774
"""Open an existing branch which contains a_transport.base.
776
This probes for a branch at a_transport, and searches upwards from there.
778
Basically we keep looking up until we find the control directory or
779
run into the root. If there isn't one, raises NotBranchError.
780
If there is one and it is either an unrecognised format or an unsupported
781
format, UnknownFormatError or UnsupportedFormatError are raised.
782
If there is one, it is returned, along with the unused portion of url.
784
:return: The BzrDir that contains the path, and a Unicode path
785
for the rest of the URL.
787
# this gets the normalised url back. I.e. '.' -> the full path.
788
url = a_transport.base
791
result = BzrDir.open_from_transport(a_transport)
792
return result, urlutils.unescape(a_transport.relpath(url))
793
except errors.NotBranchError, e:
796
new_t = a_transport.clone('..')
797
except errors.InvalidURLJoin:
798
# reached the root, whatever that may be
799
raise errors.NotBranchError(path=url)
800
if new_t.base == a_transport.base:
801
# reached the root, whatever that may be
802
raise errors.NotBranchError(path=url)
805
def _get_tree_branch(self):
806
"""Return the branch and tree, if any, for this bzrdir.
808
Return None for tree if not present or inaccessible.
809
Raise NotBranchError if no branch is present.
810
:return: (tree, branch)
813
tree = self.open_workingtree()
814
except (errors.NoWorkingTree, errors.NotLocalUrl):
816
branch = self.open_branch()
822
def open_tree_or_branch(klass, location):
823
"""Return the branch and working tree at a location.
825
If there is no tree at the location, tree will be None.
826
If there is no branch at the location, an exception will be
828
:return: (tree, branch)
830
bzrdir = klass.open(location)
831
return bzrdir._get_tree_branch()
834
def open_containing_tree_or_branch(klass, location):
835
"""Return the branch and working tree contained by a location.
837
Returns (tree, branch, relpath).
838
If there is no tree at containing the location, tree will be None.
839
If there is no branch containing the location, an exception will be
841
relpath is the portion of the path that is contained by the branch.
843
bzrdir, relpath = klass.open_containing(location)
844
tree, branch = bzrdir._get_tree_branch()
845
return tree, branch, relpath
847
def open_repository(self, _unsupported=False):
848
"""Open the repository object at this BzrDir if one is present.
850
This will not follow the Branch object pointer - it's strictly a direct
851
open facility. Most client code should use open_branch().repository to
854
:param _unsupported: a private parameter, not part of the api.
855
TODO: static convenience version of this?
857
raise NotImplementedError(self.open_repository)
859
def open_workingtree(self, _unsupported=False,
860
recommend_upgrade=True, from_branch=None):
861
"""Open the workingtree object at this BzrDir if one is present.
863
:param recommend_upgrade: Optional keyword parameter, when True (the
864
default), emit through the ui module a recommendation that the user
865
upgrade the working tree when the workingtree being opened is old
866
(but still fully supported).
867
:param from_branch: override bzrdir branch (for lightweight checkouts)
869
raise NotImplementedError(self.open_workingtree)
871
def has_branch(self):
872
"""Tell if this bzrdir contains a branch.
874
Note: if you're going to open the branch, you should just go ahead
875
and try, and not ask permission first. (This method just opens the
876
branch and discards it, and that's somewhat expensive.)
881
except errors.NotBranchError:
884
def has_workingtree(self):
885
"""Tell if this bzrdir contains a working tree.
887
This will still raise an exception if the bzrdir has a workingtree that
888
is remote & inaccessible.
890
Note: if you're going to open the working tree, you should just go ahead
891
and try, and not ask permission first. (This method just opens the
892
workingtree and discards it, and that's somewhat expensive.)
895
self.open_workingtree(recommend_upgrade=False)
897
except errors.NoWorkingTree:
900
def _cloning_metadir(self):
901
"""Produce a metadir suitable for cloning with."""
902
result_format = self._format.__class__()
905
branch = self.open_branch()
906
source_repository = branch.repository
907
except errors.NotBranchError:
909
source_repository = self.open_repository()
910
except errors.NoRepositoryPresent:
911
source_repository = None
913
# XXX TODO: This isinstance is here because we have not implemented
914
# the fix recommended in bug # 103195 - to delegate this choice the
916
repo_format = source_repository._format
917
if not isinstance(repo_format, remote.RemoteRepositoryFormat):
918
result_format.repository_format = repo_format
920
# TODO: Couldn't we just probe for the format in these cases,
921
# rather than opening the whole tree? It would be a little
922
# faster. mbp 20070401
923
tree = self.open_workingtree(recommend_upgrade=False)
924
except (errors.NoWorkingTree, errors.NotLocalUrl):
925
result_format.workingtree_format = None
927
result_format.workingtree_format = tree._format.__class__()
928
return result_format, source_repository
930
def cloning_metadir(self):
931
"""Produce a metadir suitable for cloning or sprouting with.
933
These operations may produce workingtrees (yes, even though they're
934
"cloning" something that doesn't have a tree), so a viable workingtree
935
format must be selected.
937
format, repository = self._cloning_metadir()
938
if format._workingtree_format is None:
939
if repository is None:
941
tree_format = repository._format._matchingbzrdir.workingtree_format
942
format.workingtree_format = tree_format.__class__()
945
def checkout_metadir(self):
946
return self.cloning_metadir()
948
def sprout(self, url, revision_id=None, force_new_repo=False,
949
recurse='down', possible_transports=None,
950
accelerator_tree=None, hardlink=False, stacked=False):
951
"""Create a copy of this bzrdir prepared for use as a new line of
954
If url's last component does not exist, it will be created.
956
Attributes related to the identity of the source branch like
957
branch nickname will be cleaned, a working tree is created
958
whether one existed before or not; and a local branch is always
961
if revision_id is not None, then the clone operation may tune
962
itself to download less data.
963
:param accelerator_tree: A tree which can be used for retrieving file
964
contents more quickly than the revision tree, i.e. a workingtree.
965
The revision tree will be used for cases where accelerator_tree's
966
content is different.
967
:param hardlink: If true, hard-link files from accelerator_tree,
969
:param stacked: If true, create a stacked branch referring to the
970
location of this control directory.
972
target_transport = get_transport(url, possible_transports)
973
target_transport.ensure_base()
974
cloning_format = self.cloning_metadir()
975
result = cloning_format.initialize_on_transport(target_transport)
977
source_branch = self.open_branch()
978
source_repository = source_branch.repository
980
stacked_branch_url = self.root_transport.base
983
stacked_branch_url = source_branch.get_stacked_on()
984
except (errors.NotStacked, errors.UnstackableBranchFormat,
985
errors.UnstackableRepositoryFormat):
986
stacked_branch_url = None
987
except errors.NotBranchError:
990
source_repository = self.open_repository()
991
except errors.NoRepositoryPresent:
992
source_repository = None
993
stacked_branch_url = None
998
result_repo = result.find_repository()
999
except errors.NoRepositoryPresent:
1002
# Create/update the result repository as required
1003
if source_repository is None:
1004
if result_repo is None:
1005
# no repo available, make a new one
1006
result.create_repository()
1007
elif stacked_branch_url is not None:
1008
if result_repo is None:
1009
result_repo = source_repository._format.initialize(result)
1010
stacked_dir = BzrDir.open(stacked_branch_url)
1012
stacked_repo = stacked_dir.open_branch().repository
1013
except errors.NotBranchError:
1014
stacked_repo = stacked_dir.open_repository()
1015
result_repo.add_fallback_repository(stacked_repo)
1016
result_repo.fetch(source_repository, revision_id=revision_id)
1017
elif result_repo is None:
1018
# have source, and want to make a new target repo
1019
result_repo = source_repository.sprout(result,
1020
revision_id=revision_id)
1022
# Fetch needed content into target.
1023
# Would rather do it this way ...
1024
# source_repository.copy_content_into(result_repo,
1025
# revision_id=revision_id)
1026
# so we can override the copy method
1027
result_repo.fetch(source_repository, revision_id=revision_id)
1029
# Create/update the result branch
1030
if source_branch is not None:
1031
result_branch = source_branch.sprout(result,
1032
revision_id=revision_id)
1034
result_branch = result.create_branch()
1035
if stacked_branch_url is not None:
1036
result_branch.set_stacked_on(stacked_branch_url)
1038
# Create/update the result working tree
1039
if isinstance(target_transport, LocalTransport) and (
1040
result_repo is None or result_repo.make_working_trees()):
1041
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
1045
if wt.path2id('') is None:
1047
wt.set_root_id(self.open_workingtree.get_root_id())
1048
except errors.NoWorkingTree:
1054
if recurse == 'down':
1056
basis = wt.basis_tree()
1058
subtrees = basis.iter_references()
1059
elif source_branch is not None:
1060
basis = source_branch.basis_tree()
1062
subtrees = basis.iter_references()
1067
for path, file_id in subtrees:
1068
target = urlutils.join(url, urlutils.escape(path))
1069
sublocation = source_branch.reference_parent(file_id, path)
1070
sublocation.bzrdir.sprout(target,
1071
basis.get_reference_revision(file_id, path),
1072
force_new_repo=force_new_repo, recurse=recurse,
1075
if basis is not None:
1080
class BzrDirPreSplitOut(BzrDir):
1081
"""A common class for the all-in-one formats."""
1083
def __init__(self, _transport, _format):
1084
"""See BzrDir.__init__."""
1085
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1086
self._control_files = lockable_files.LockableFiles(
1087
self.get_branch_transport(None),
1088
self._format._lock_file_name,
1089
self._format._lock_class)
1091
def break_lock(self):
1092
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1093
raise NotImplementedError(self.break_lock)
1095
def cloning_metadir(self):
1096
"""Produce a metadir suitable for cloning with."""
1097
return self._format.__class__()
1099
def clone(self, url, revision_id=None, force_new_repo=False):
1100
"""See BzrDir.clone()."""
1101
from bzrlib.workingtree import WorkingTreeFormat2
1102
self._make_tail(url)
1103
result = self._format._initialize_for_clone(url)
1104
self.open_repository().clone(result, revision_id=revision_id)
1105
from_branch = self.open_branch()
1106
from_branch.clone(result, revision_id=revision_id)
1108
self.open_workingtree().clone(result)
1109
except errors.NotLocalUrl:
1110
# make a new one, this format always has to have one.
1112
WorkingTreeFormat2().initialize(result)
1113
except errors.NotLocalUrl:
1114
# but we cannot do it for remote trees.
1115
to_branch = result.open_branch()
1116
WorkingTreeFormat2()._stub_initialize_remote(to_branch)
1119
def create_branch(self):
1120
"""See BzrDir.create_branch."""
1121
return self.open_branch()
1123
def destroy_branch(self):
1124
"""See BzrDir.destroy_branch."""
1125
raise errors.UnsupportedOperation(self.destroy_branch, self)
1127
def create_repository(self, shared=False):
1128
"""See BzrDir.create_repository."""
1130
raise errors.IncompatibleFormat('shared repository', self._format)
1131
return self.open_repository()
1133
def destroy_repository(self):
1134
"""See BzrDir.destroy_repository."""
1135
raise errors.UnsupportedOperation(self.destroy_repository, self)
1137
def create_workingtree(self, revision_id=None, from_branch=None,
1138
accelerator_tree=None, hardlink=False):
1139
"""See BzrDir.create_workingtree."""
1140
# this looks buggy but is not -really-
1141
# because this format creates the workingtree when the bzrdir is
1143
# clone and sprout will have set the revision_id
1144
# and that will have set it for us, its only
1145
# specific uses of create_workingtree in isolation
1146
# that can do wonky stuff here, and that only
1147
# happens for creating checkouts, which cannot be
1148
# done on this format anyway. So - acceptable wart.
1149
result = self.open_workingtree(recommend_upgrade=False)
1150
if revision_id is not None:
1151
if revision_id == _mod_revision.NULL_REVISION:
1152
result.set_parent_ids([])
1154
result.set_parent_ids([revision_id])
1157
def destroy_workingtree(self):
1158
"""See BzrDir.destroy_workingtree."""
1159
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1161
def destroy_workingtree_metadata(self):
1162
"""See BzrDir.destroy_workingtree_metadata."""
1163
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1166
def get_branch_transport(self, branch_format):
1167
"""See BzrDir.get_branch_transport()."""
1168
if branch_format is None:
1169
return self.transport
1171
branch_format.get_format_string()
1172
except NotImplementedError:
1173
return self.transport
1174
raise errors.IncompatibleFormat(branch_format, self._format)
1176
def get_repository_transport(self, repository_format):
1177
"""See BzrDir.get_repository_transport()."""
1178
if repository_format is None:
1179
return self.transport
1181
repository_format.get_format_string()
1182
except NotImplementedError:
1183
return self.transport
1184
raise errors.IncompatibleFormat(repository_format, self._format)
1186
def get_workingtree_transport(self, workingtree_format):
1187
"""See BzrDir.get_workingtree_transport()."""
1188
if workingtree_format is None:
1189
return self.transport
1191
workingtree_format.get_format_string()
1192
except NotImplementedError:
1193
return self.transport
1194
raise errors.IncompatibleFormat(workingtree_format, self._format)
1196
def needs_format_conversion(self, format=None):
1197
"""See BzrDir.needs_format_conversion()."""
1198
# if the format is not the same as the system default,
1199
# an upgrade is needed.
1201
format = BzrDirFormat.get_default_format()
1202
return not isinstance(self._format, format.__class__)
1204
def open_branch(self, unsupported=False):
1205
"""See BzrDir.open_branch."""
1206
from bzrlib.branch import BzrBranchFormat4
1207
format = BzrBranchFormat4()
1208
self._check_supported(format, unsupported)
1209
return format.open(self, _found=True)
1211
def sprout(self, url, revision_id=None, force_new_repo=False,
1212
possible_transports=None, accelerator_tree=None,
1213
hardlink=False, stacked=False):
1214
"""See BzrDir.sprout()."""
1216
raise errors.UnstackableBranchFormat(
1217
self._format, self.root_transport.base)
1218
from bzrlib.workingtree import WorkingTreeFormat2
1219
self._make_tail(url)
1220
result = self._format._initialize_for_clone(url)
1222
self.open_repository().clone(result, revision_id=revision_id)
1223
except errors.NoRepositoryPresent:
1226
self.open_branch().sprout(result, revision_id=revision_id)
1227
except errors.NotBranchError:
1229
# we always want a working tree
1230
WorkingTreeFormat2().initialize(result,
1231
accelerator_tree=accelerator_tree,
1236
class BzrDir4(BzrDirPreSplitOut):
1237
"""A .bzr version 4 control object.
1239
This is a deprecated format and may be removed after sept 2006.
1242
def create_repository(self, shared=False):
1243
"""See BzrDir.create_repository."""
1244
return self._format.repository_format.initialize(self, shared)
1246
def needs_format_conversion(self, format=None):
1247
"""Format 4 dirs are always in need of conversion."""
1250
def open_repository(self):
1251
"""See BzrDir.open_repository."""
1252
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1253
return RepositoryFormat4().open(self, _found=True)
1256
class BzrDir5(BzrDirPreSplitOut):
1257
"""A .bzr version 5 control object.
1259
This is a deprecated format and may be removed after sept 2006.
1262
def open_repository(self):
1263
"""See BzrDir.open_repository."""
1264
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1265
return RepositoryFormat5().open(self, _found=True)
1267
def open_workingtree(self, _unsupported=False,
1268
recommend_upgrade=True):
1269
"""See BzrDir.create_workingtree."""
1270
from bzrlib.workingtree import WorkingTreeFormat2
1271
wt_format = WorkingTreeFormat2()
1272
# we don't warn here about upgrades; that ought to be handled for the
1274
return wt_format.open(self, _found=True)
1277
class BzrDir6(BzrDirPreSplitOut):
1278
"""A .bzr version 6 control object.
1280
This is a deprecated format and may be removed after sept 2006.
1283
def open_repository(self):
1284
"""See BzrDir.open_repository."""
1285
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1286
return RepositoryFormat6().open(self, _found=True)
1288
def open_workingtree(self, _unsupported=False,
1289
recommend_upgrade=True):
1290
"""See BzrDir.create_workingtree."""
1291
# we don't warn here about upgrades; that ought to be handled for the
1293
from bzrlib.workingtree import WorkingTreeFormat2
1294
return WorkingTreeFormat2().open(self, _found=True)
1297
class BzrDirMeta1(BzrDir):
1298
"""A .bzr meta version 1 control object.
1300
This is the first control object where the
1301
individual aspects are really split out: there are separate repository,
1302
workingtree and branch subdirectories and any subset of the three can be
1303
present within a BzrDir.
1306
def can_convert_format(self):
1307
"""See BzrDir.can_convert_format()."""
1310
def create_branch(self):
1311
"""See BzrDir.create_branch."""
1312
return self._format.get_branch_format().initialize(self)
1314
def destroy_branch(self):
1315
"""See BzrDir.create_branch."""
1316
self.transport.delete_tree('branch')
1318
def create_repository(self, shared=False):
1319
"""See BzrDir.create_repository."""
1320
return self._format.repository_format.initialize(self, shared)
1322
def destroy_repository(self):
1323
"""See BzrDir.destroy_repository."""
1324
self.transport.delete_tree('repository')
1326
def create_workingtree(self, revision_id=None, from_branch=None,
1327
accelerator_tree=None, hardlink=False):
1328
"""See BzrDir.create_workingtree."""
1329
return self._format.workingtree_format.initialize(
1330
self, revision_id, from_branch=from_branch,
1331
accelerator_tree=accelerator_tree, hardlink=hardlink)
1333
def destroy_workingtree(self):
1334
"""See BzrDir.destroy_workingtree."""
1335
wt = self.open_workingtree(recommend_upgrade=False)
1336
repository = wt.branch.repository
1337
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1338
wt.revert(old_tree=empty)
1339
self.destroy_workingtree_metadata()
1341
def destroy_workingtree_metadata(self):
1342
self.transport.delete_tree('checkout')
1344
def find_branch_format(self):
1345
"""Find the branch 'format' for this bzrdir.
1347
This might be a synthetic object for e.g. RemoteBranch and SVN.
1349
from bzrlib.branch import BranchFormat
1350
return BranchFormat.find_format(self)
1352
def _get_mkdir_mode(self):
1353
"""Figure out the mode to use when creating a bzrdir subdir."""
1354
temp_control = lockable_files.LockableFiles(self.transport, '',
1355
lockable_files.TransportLock)
1356
return temp_control._dir_mode
1358
def get_branch_reference(self):
1359
"""See BzrDir.get_branch_reference()."""
1360
from bzrlib.branch import BranchFormat
1361
format = BranchFormat.find_format(self)
1362
return format.get_reference(self)
1364
def get_branch_transport(self, branch_format):
1365
"""See BzrDir.get_branch_transport()."""
1366
if branch_format is None:
1367
return self.transport.clone('branch')
1369
branch_format.get_format_string()
1370
except NotImplementedError:
1371
raise errors.IncompatibleFormat(branch_format, self._format)
1373
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1374
except errors.FileExists:
1376
return self.transport.clone('branch')
1378
def get_repository_transport(self, repository_format):
1379
"""See BzrDir.get_repository_transport()."""
1380
if repository_format is None:
1381
return self.transport.clone('repository')
1383
repository_format.get_format_string()
1384
except NotImplementedError:
1385
raise errors.IncompatibleFormat(repository_format, self._format)
1387
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1388
except errors.FileExists:
1390
return self.transport.clone('repository')
1392
def get_workingtree_transport(self, workingtree_format):
1393
"""See BzrDir.get_workingtree_transport()."""
1394
if workingtree_format is None:
1395
return self.transport.clone('checkout')
1397
workingtree_format.get_format_string()
1398
except NotImplementedError:
1399
raise errors.IncompatibleFormat(workingtree_format, self._format)
1401
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1402
except errors.FileExists:
1404
return self.transport.clone('checkout')
1406
def needs_format_conversion(self, format=None):
1407
"""See BzrDir.needs_format_conversion()."""
1409
format = BzrDirFormat.get_default_format()
1410
if not isinstance(self._format, format.__class__):
1411
# it is not a meta dir format, conversion is needed.
1413
# we might want to push this down to the repository?
1415
if not isinstance(self.open_repository()._format,
1416
format.repository_format.__class__):
1417
# the repository needs an upgrade.
1419
except errors.NoRepositoryPresent:
1422
if not isinstance(self.open_branch()._format,
1423
format.get_branch_format().__class__):
1424
# the branch needs an upgrade.
1426
except errors.NotBranchError:
1429
my_wt = self.open_workingtree(recommend_upgrade=False)
1430
if not isinstance(my_wt._format,
1431
format.workingtree_format.__class__):
1432
# the workingtree needs an upgrade.
1434
except (errors.NoWorkingTree, errors.NotLocalUrl):
1438
def open_branch(self, unsupported=False):
1439
"""See BzrDir.open_branch."""
1440
format = self.find_branch_format()
1441
self._check_supported(format, unsupported)
1442
return format.open(self, _found=True)
1444
def open_repository(self, unsupported=False):
1445
"""See BzrDir.open_repository."""
1446
from bzrlib.repository import RepositoryFormat
1447
format = RepositoryFormat.find_format(self)
1448
self._check_supported(format, unsupported)
1449
return format.open(self, _found=True)
1451
def open_workingtree(self, unsupported=False,
1452
recommend_upgrade=True):
1453
"""See BzrDir.open_workingtree."""
1454
from bzrlib.workingtree import WorkingTreeFormat
1455
format = WorkingTreeFormat.find_format(self)
1456
self._check_supported(format, unsupported,
1458
basedir=self.root_transport.base)
1459
return format.open(self, _found=True)
1462
class BzrDirFormat(object):
1463
"""An encapsulation of the initialization and open routines for a format.
1465
Formats provide three things:
1466
* An initialization routine,
1470
Formats are placed in a dict by their format string for reference
1471
during bzrdir opening. These should be subclasses of BzrDirFormat
1474
Once a format is deprecated, just deprecate the initialize and open
1475
methods on the format class. Do not deprecate the object, as the
1476
object will be created every system load.
1479
_default_format = None
1480
"""The default format used for new .bzr dirs."""
1483
"""The known formats."""
1485
_control_formats = []
1486
"""The registered control formats - .bzr, ....
1488
This is a list of BzrDirFormat objects.
1491
_control_server_formats = []
1492
"""The registered control server formats, e.g. RemoteBzrDirs.
1494
This is a list of BzrDirFormat objects.
1497
_lock_file_name = 'branch-lock'
1499
# _lock_class must be set in subclasses to the lock type, typ.
1500
# TransportLock or LockDir
1503
def find_format(klass, transport, _server_formats=True):
1504
"""Return the format present at transport."""
1506
formats = klass._control_server_formats + klass._control_formats
1508
formats = klass._control_formats
1509
for format in formats:
1511
return format.probe_transport(transport)
1512
except errors.NotBranchError:
1513
# this format does not find a control dir here.
1515
raise errors.NotBranchError(path=transport.base)
1518
def probe_transport(klass, transport):
1519
"""Return the .bzrdir style format present in a directory."""
1521
format_string = transport.get(".bzr/branch-format").read()
1522
except errors.NoSuchFile:
1523
raise errors.NotBranchError(path=transport.base)
1526
return klass._formats[format_string]
1528
raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1531
def get_default_format(klass):
1532
"""Return the current default format."""
1533
return klass._default_format
1535
def get_format_string(self):
1536
"""Return the ASCII format string that identifies this format."""
1537
raise NotImplementedError(self.get_format_string)
1539
def get_format_description(self):
1540
"""Return the short description for this format."""
1541
raise NotImplementedError(self.get_format_description)
1543
def get_converter(self, format=None):
1544
"""Return the converter to use to convert bzrdirs needing converts.
1546
This returns a bzrlib.bzrdir.Converter object.
1548
This should return the best upgrader to step this format towards the
1549
current default format. In the case of plugins we can/should provide
1550
some means for them to extend the range of returnable converters.
1552
:param format: Optional format to override the default format of the
1555
raise NotImplementedError(self.get_converter)
1557
def initialize(self, url, possible_transports=None):
1558
"""Create a bzr control dir at this url and return an opened copy.
1560
Subclasses should typically override initialize_on_transport
1561
instead of this method.
1563
return self.initialize_on_transport(get_transport(url,
1564
possible_transports))
1566
def initialize_on_transport(self, transport):
1567
"""Initialize a new bzrdir in the base directory of a Transport."""
1568
# Since we don't have a .bzr directory, inherit the
1569
# mode from the root directory
1570
temp_control = lockable_files.LockableFiles(transport,
1571
'', lockable_files.TransportLock)
1572
temp_control._transport.mkdir('.bzr',
1573
# FIXME: RBC 20060121 don't peek under
1575
mode=temp_control._dir_mode)
1576
if sys.platform == 'win32' and isinstance(transport, LocalTransport):
1577
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1578
file_mode = temp_control._file_mode
1580
bzrdir_transport = transport.clone('.bzr')
1581
utf8_files = [('README',
1582
"This is a Bazaar control directory.\n"
1583
"Do not change any files in this directory.\n"
1584
"See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
1585
('branch-format', self.get_format_string()),
1587
# NB: no need to escape relative paths that are url safe.
1588
control_files = lockable_files.LockableFiles(bzrdir_transport,
1589
self._lock_file_name, self._lock_class)
1590
control_files.create_lock()
1591
control_files.lock_write()
1593
for (filename, content) in utf8_files:
1594
bzrdir_transport.put_bytes(filename, content,
1597
control_files.unlock()
1598
return self.open(transport, _found=True)
1600
def is_supported(self):
1601
"""Is this format supported?
1603
Supported formats must be initializable and openable.
1604
Unsupported formats may not support initialization or committing or
1605
some other features depending on the reason for not being supported.
1609
def same_model(self, target_format):
1610
return (self.repository_format.rich_root_data ==
1611
target_format.rich_root_data)
1614
def known_formats(klass):
1615
"""Return all the known formats.
1617
Concrete formats should override _known_formats.
1619
# There is double indirection here to make sure that control
1620
# formats used by more than one dir format will only be probed
1621
# once. This can otherwise be quite expensive for remote connections.
1623
for format in klass._control_formats:
1624
result.update(format._known_formats())
1628
def _known_formats(klass):
1629
"""Return the known format instances for this control format."""
1630
return set(klass._formats.values())
1632
def open(self, transport, _found=False):
1633
"""Return an instance of this format for the dir transport points at.
1635
_found is a private parameter, do not use it.
1638
found_format = BzrDirFormat.find_format(transport)
1639
if not isinstance(found_format, self.__class__):
1640
raise AssertionError("%s was asked to open %s, but it seems to need "
1642
% (self, transport, found_format))
1643
return self._open(transport)
1645
def _open(self, transport):
1646
"""Template method helper for opening BzrDirectories.
1648
This performs the actual open and any additional logic or parameter
1651
raise NotImplementedError(self._open)
1654
def register_format(klass, format):
1655
klass._formats[format.get_format_string()] = format
1658
def register_control_format(klass, format):
1659
"""Register a format that does not use '.bzr' for its control dir.
1661
TODO: This should be pulled up into a 'ControlDirFormat' base class
1662
which BzrDirFormat can inherit from, and renamed to register_format
1663
there. It has been done without that for now for simplicity of
1666
klass._control_formats.append(format)
1669
def register_control_server_format(klass, format):
1670
"""Register a control format for client-server environments.
1672
These formats will be tried before ones registered with
1673
register_control_format. This gives implementations that decide to the
1674
chance to grab it before anything looks at the contents of the format
1677
klass._control_server_formats.append(format)
1680
def _set_default_format(klass, format):
1681
"""Set default format (for testing behavior of defaults only)"""
1682
klass._default_format = format
1686
return self.get_format_string().rstrip()
1689
def unregister_format(klass, format):
1690
del klass._formats[format.get_format_string()]
1693
def unregister_control_format(klass, format):
1694
klass._control_formats.remove(format)
1697
class BzrDirFormat4(BzrDirFormat):
1698
"""Bzr dir format 4.
1700
This format is a combined format for working tree, branch and repository.
1702
- Format 1 working trees [always]
1703
- Format 4 branches [always]
1704
- Format 4 repositories [always]
1706
This format is deprecated: it indexes texts using a text it which is
1707
removed in format 5; write support for this format has been removed.
1710
_lock_class = lockable_files.TransportLock
1712
def get_format_string(self):
1713
"""See BzrDirFormat.get_format_string()."""
1714
return "Bazaar-NG branch, format 0.0.4\n"
1716
def get_format_description(self):
1717
"""See BzrDirFormat.get_format_description()."""
1718
return "All-in-one format 4"
1720
def get_converter(self, format=None):
1721
"""See BzrDirFormat.get_converter()."""
1722
# there is one and only one upgrade path here.
1723
return ConvertBzrDir4To5()
1725
def initialize_on_transport(self, transport):
1726
"""Format 4 branches cannot be created."""
1727
raise errors.UninitializableFormat(self)
1729
def is_supported(self):
1730
"""Format 4 is not supported.
1732
It is not supported because the model changed from 4 to 5 and the
1733
conversion logic is expensive - so doing it on the fly was not
1738
def _open(self, transport):
1739
"""See BzrDirFormat._open."""
1740
return BzrDir4(transport, self)
1742
def __return_repository_format(self):
1743
"""Circular import protection."""
1744
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1745
return RepositoryFormat4()
1746
repository_format = property(__return_repository_format)
1749
class BzrDirFormat5(BzrDirFormat):
1750
"""Bzr control format 5.
1752
This format is a combined format for working tree, branch and repository.
1754
- Format 2 working trees [always]
1755
- Format 4 branches [always]
1756
- Format 5 repositories [always]
1757
Unhashed stores in the repository.
1760
_lock_class = lockable_files.TransportLock
1762
def get_format_string(self):
1763
"""See BzrDirFormat.get_format_string()."""
1764
return "Bazaar-NG branch, format 5\n"
1766
def get_format_description(self):
1767
"""See BzrDirFormat.get_format_description()."""
1768
return "All-in-one format 5"
1770
def get_converter(self, format=None):
1771
"""See BzrDirFormat.get_converter()."""
1772
# there is one and only one upgrade path here.
1773
return ConvertBzrDir5To6()
1775
def _initialize_for_clone(self, url):
1776
return self.initialize_on_transport(get_transport(url), _cloning=True)
1778
def initialize_on_transport(self, transport, _cloning=False):
1779
"""Format 5 dirs always have working tree, branch and repository.
1781
Except when they are being cloned.
1783
from bzrlib.branch import BzrBranchFormat4
1784
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1785
from bzrlib.workingtree import WorkingTreeFormat2
1786
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1787
RepositoryFormat5().initialize(result, _internal=True)
1789
branch = BzrBranchFormat4().initialize(result)
1791
WorkingTreeFormat2().initialize(result)
1792
except errors.NotLocalUrl:
1793
# Even though we can't access the working tree, we need to
1794
# create its control files.
1795
WorkingTreeFormat2()._stub_initialize_remote(branch)
1798
def _open(self, transport):
1799
"""See BzrDirFormat._open."""
1800
return BzrDir5(transport, self)
1802
def __return_repository_format(self):
1803
"""Circular import protection."""
1804
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1805
return RepositoryFormat5()
1806
repository_format = property(__return_repository_format)
1809
class BzrDirFormat6(BzrDirFormat):
1810
"""Bzr control format 6.
1812
This format is a combined format for working tree, branch and repository.
1814
- Format 2 working trees [always]
1815
- Format 4 branches [always]
1816
- Format 6 repositories [always]
1819
_lock_class = lockable_files.TransportLock
1821
def get_format_string(self):
1822
"""See BzrDirFormat.get_format_string()."""
1823
return "Bazaar-NG branch, format 6\n"
1825
def get_format_description(self):
1826
"""See BzrDirFormat.get_format_description()."""
1827
return "All-in-one format 6"
1829
def get_converter(self, format=None):
1830
"""See BzrDirFormat.get_converter()."""
1831
# there is one and only one upgrade path here.
1832
return ConvertBzrDir6ToMeta()
1834
def _initialize_for_clone(self, url):
1835
return self.initialize_on_transport(get_transport(url), _cloning=True)
1837
def initialize_on_transport(self, transport, _cloning=False):
1838
"""Format 6 dirs always have working tree, branch and repository.
1840
Except when they are being cloned.
1842
from bzrlib.branch import BzrBranchFormat4
1843
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1844
from bzrlib.workingtree import WorkingTreeFormat2
1845
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1846
RepositoryFormat6().initialize(result, _internal=True)
1848
branch = BzrBranchFormat4().initialize(result)
1850
WorkingTreeFormat2().initialize(result)
1851
except errors.NotLocalUrl:
1852
# Even though we can't access the working tree, we need to
1853
# create its control files.
1854
WorkingTreeFormat2()._stub_initialize_remote(branch)
1857
def _open(self, transport):
1858
"""See BzrDirFormat._open."""
1859
return BzrDir6(transport, self)
1861
def __return_repository_format(self):
1862
"""Circular import protection."""
1863
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1864
return RepositoryFormat6()
1865
repository_format = property(__return_repository_format)
1868
class BzrDirMetaFormat1(BzrDirFormat):
1869
"""Bzr meta control format 1
1871
This is the first format with split out working tree, branch and repository
1874
- Format 3 working trees [optional]
1875
- Format 5 branches [optional]
1876
- Format 7 repositories [optional]
1879
_lock_class = lockdir.LockDir
1882
self._workingtree_format = None
1883
self._branch_format = None
1885
def __eq__(self, other):
1886
if other.__class__ is not self.__class__:
1888
if other.repository_format != self.repository_format:
1890
if other.workingtree_format != self.workingtree_format:
1894
def __ne__(self, other):
1895
return not self == other
1897
def get_branch_format(self):
1898
if self._branch_format is None:
1899
from bzrlib.branch import BranchFormat
1900
self._branch_format = BranchFormat.get_default_format()
1901
return self._branch_format
1903
def set_branch_format(self, format):
1904
self._branch_format = format
1906
def get_converter(self, format=None):
1907
"""See BzrDirFormat.get_converter()."""
1909
format = BzrDirFormat.get_default_format()
1910
if not isinstance(self, format.__class__):
1911
# converting away from metadir is not implemented
1912
raise NotImplementedError(self.get_converter)
1913
return ConvertMetaToMeta(format)
1915
def get_format_string(self):
1916
"""See BzrDirFormat.get_format_string()."""
1917
return "Bazaar-NG meta directory, format 1\n"
1919
def get_format_description(self):
1920
"""See BzrDirFormat.get_format_description()."""
1921
return "Meta directory format 1"
1923
def _open(self, transport):
1924
"""See BzrDirFormat._open."""
1925
return BzrDirMeta1(transport, self)
1927
def __return_repository_format(self):
1928
"""Circular import protection."""
1929
if getattr(self, '_repository_format', None):
1930
return self._repository_format
1931
from bzrlib.repository import RepositoryFormat
1932
return RepositoryFormat.get_default_format()
1934
def __set_repository_format(self, value):
1935
"""Allow changing the repository format for metadir formats."""
1936
self._repository_format = value
1938
repository_format = property(__return_repository_format, __set_repository_format)
1940
def __get_workingtree_format(self):
1941
if self._workingtree_format is None:
1942
from bzrlib.workingtree import WorkingTreeFormat
1943
self._workingtree_format = WorkingTreeFormat.get_default_format()
1944
return self._workingtree_format
1946
def __set_workingtree_format(self, wt_format):
1947
self._workingtree_format = wt_format
1949
workingtree_format = property(__get_workingtree_format,
1950
__set_workingtree_format)
1953
# Register bzr control format
1954
BzrDirFormat.register_control_format(BzrDirFormat)
1956
# Register bzr formats
1957
BzrDirFormat.register_format(BzrDirFormat4())
1958
BzrDirFormat.register_format(BzrDirFormat5())
1959
BzrDirFormat.register_format(BzrDirFormat6())
1960
__default_format = BzrDirMetaFormat1()
1961
BzrDirFormat.register_format(__default_format)
1962
BzrDirFormat._default_format = __default_format
1965
class Converter(object):
1966
"""Converts a disk format object from one format to another."""
1968
def convert(self, to_convert, pb):
1969
"""Perform the conversion of to_convert, giving feedback via pb.
1971
:param to_convert: The disk object to convert.
1972
:param pb: a progress bar to use for progress information.
1975
def step(self, message):
1976
"""Update the pb by a step."""
1978
self.pb.update(message, self.count, self.total)
1981
class ConvertBzrDir4To5(Converter):
1982
"""Converts format 4 bzr dirs to format 5."""
1985
super(ConvertBzrDir4To5, self).__init__()
1986
self.converted_revs = set()
1987
self.absent_revisions = set()
1991
def convert(self, to_convert, pb):
1992
"""See Converter.convert()."""
1993
self.bzrdir = to_convert
1995
self.pb.note('starting upgrade from format 4 to 5')
1996
if isinstance(self.bzrdir.transport, LocalTransport):
1997
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
1998
self._convert_to_weaves()
1999
return BzrDir.open(self.bzrdir.root_transport.base)
2001
def _convert_to_weaves(self):
2002
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
2005
stat = self.bzrdir.transport.stat('weaves')
2006
if not S_ISDIR(stat.st_mode):
2007
self.bzrdir.transport.delete('weaves')
2008
self.bzrdir.transport.mkdir('weaves')
2009
except errors.NoSuchFile:
2010
self.bzrdir.transport.mkdir('weaves')
2011
# deliberately not a WeaveFile as we want to build it up slowly.
2012
self.inv_weave = Weave('inventory')
2013
# holds in-memory weaves for all files
2014
self.text_weaves = {}
2015
self.bzrdir.transport.delete('branch-format')
2016
self.branch = self.bzrdir.open_branch()
2017
self._convert_working_inv()
2018
rev_history = self.branch.revision_history()
2019
# to_read is a stack holding the revisions we still need to process;
2020
# appending to it adds new highest-priority revisions
2021
self.known_revisions = set(rev_history)
2022
self.to_read = rev_history[-1:]
2024
rev_id = self.to_read.pop()
2025
if (rev_id not in self.revisions
2026
and rev_id not in self.absent_revisions):
2027
self._load_one_rev(rev_id)
2029
to_import = self._make_order()
2030
for i, rev_id in enumerate(to_import):
2031
self.pb.update('converting revision', i, len(to_import))
2032
self._convert_one_rev(rev_id)
2034
self._write_all_weaves()
2035
self._write_all_revs()
2036
self.pb.note('upgraded to weaves:')
2037
self.pb.note(' %6d revisions and inventories', len(self.revisions))
2038
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
2039
self.pb.note(' %6d texts', self.text_count)
2040
self._cleanup_spare_files_after_format4()
2041
self.branch._transport.put_bytes(
2043
BzrDirFormat5().get_format_string(),
2044
mode=self.bzrdir._get_file_mode())
2046
def _cleanup_spare_files_after_format4(self):
2047
# FIXME working tree upgrade foo.
2048
for n in 'merged-patches', 'pending-merged-patches':
2050
## assert os.path.getsize(p) == 0
2051
self.bzrdir.transport.delete(n)
2052
except errors.NoSuchFile:
2054
self.bzrdir.transport.delete_tree('inventory-store')
2055
self.bzrdir.transport.delete_tree('text-store')
2057
def _convert_working_inv(self):
2058
inv = xml4.serializer_v4.read_inventory(
2059
self.branch._transport.get('inventory'))
2060
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
2061
self.branch._transport.put_bytes('inventory', new_inv_xml,
2062
mode=self.bzrdir._get_file_mode())
2064
def _write_all_weaves(self):
2065
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
2066
weave_transport = self.bzrdir.transport.clone('weaves')
2067
weaves = WeaveStore(weave_transport, prefixed=False)
2068
transaction = WriteTransaction()
2072
for file_id, file_weave in self.text_weaves.items():
2073
self.pb.update('writing weave', i, len(self.text_weaves))
2074
weaves._put_weave(file_id, file_weave, transaction)
2076
self.pb.update('inventory', 0, 1)
2077
controlweaves._put_weave('inventory', self.inv_weave, transaction)
2078
self.pb.update('inventory', 1, 1)
2082
def _write_all_revs(self):
2083
"""Write all revisions out in new form."""
2084
self.bzrdir.transport.delete_tree('revision-store')
2085
self.bzrdir.transport.mkdir('revision-store')
2086
revision_transport = self.bzrdir.transport.clone('revision-store')
2088
from bzrlib.xml5 import serializer_v5
2089
from bzrlib.repofmt.weaverepo import RevisionTextStore
2090
revision_store = RevisionTextStore(revision_transport,
2091
serializer_v5, False, versionedfile.PrefixMapper(),
2092
lambda:True, lambda:True)
2094
for i, rev_id in enumerate(self.converted_revs):
2095
self.pb.update('write revision', i, len(self.converted_revs))
2096
text = serializer_v5.write_revision_to_string(
2097
self.revisions[rev_id])
2099
revision_store.add_lines(key, None, osutils.split_lines(text))
2103
def _load_one_rev(self, rev_id):
2104
"""Load a revision object into memory.
2106
Any parents not either loaded or abandoned get queued to be
2108
self.pb.update('loading revision',
2109
len(self.revisions),
2110
len(self.known_revisions))
2111
if not self.branch.repository.has_revision(rev_id):
2113
self.pb.note('revision {%s} not present in branch; '
2114
'will be converted as a ghost',
2116
self.absent_revisions.add(rev_id)
2118
rev = self.branch.repository.get_revision(rev_id)
2119
for parent_id in rev.parent_ids:
2120
self.known_revisions.add(parent_id)
2121
self.to_read.append(parent_id)
2122
self.revisions[rev_id] = rev
2124
def _load_old_inventory(self, rev_id):
2125
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2126
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2127
inv.revision_id = rev_id
2128
rev = self.revisions[rev_id]
2131
def _load_updated_inventory(self, rev_id):
2132
inv_xml = self.inv_weave.get_text(rev_id)
2133
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2136
def _convert_one_rev(self, rev_id):
2137
"""Convert revision and all referenced objects to new format."""
2138
rev = self.revisions[rev_id]
2139
inv = self._load_old_inventory(rev_id)
2140
present_parents = [p for p in rev.parent_ids
2141
if p not in self.absent_revisions]
2142
self._convert_revision_contents(rev, inv, present_parents)
2143
self._store_new_inv(rev, inv, present_parents)
2144
self.converted_revs.add(rev_id)
2146
def _store_new_inv(self, rev, inv, present_parents):
2147
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2148
new_inv_sha1 = sha_string(new_inv_xml)
2149
self.inv_weave.add_lines(rev.revision_id,
2151
new_inv_xml.splitlines(True))
2152
rev.inventory_sha1 = new_inv_sha1
2154
def _convert_revision_contents(self, rev, inv, present_parents):
2155
"""Convert all the files within a revision.
2157
Also upgrade the inventory to refer to the text revision ids."""
2158
rev_id = rev.revision_id
2159
mutter('converting texts of revision {%s}',
2161
parent_invs = map(self._load_updated_inventory, present_parents)
2162
entries = inv.iter_entries()
2164
for path, ie in entries:
2165
self._convert_file_version(rev, ie, parent_invs)
2167
def _convert_file_version(self, rev, ie, parent_invs):
2168
"""Convert one version of one file.
2170
The file needs to be added into the weave if it is a merge
2171
of >=2 parents or if it's changed from its parent.
2173
file_id = ie.file_id
2174
rev_id = rev.revision_id
2175
w = self.text_weaves.get(file_id)
2178
self.text_weaves[file_id] = w
2179
text_changed = False
2180
parent_candiate_entries = ie.parent_candidates(parent_invs)
2181
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2182
# XXX: Note that this is unordered - and this is tolerable because
2183
# the previous code was also unordered.
2184
previous_entries = dict((head, parent_candiate_entries[head]) for head
2186
self.snapshot_ie(previous_entries, ie, w, rev_id)
2189
@symbol_versioning.deprecated_method(symbol_versioning.one_one)
2190
def get_parents(self, revision_ids):
2191
for revision_id in revision_ids:
2192
yield self.revisions[revision_id].parent_ids
2194
def get_parent_map(self, revision_ids):
2195
"""See graph._StackedParentsProvider.get_parent_map"""
2196
return dict((revision_id, self.revisions[revision_id])
2197
for revision_id in revision_ids
2198
if revision_id in self.revisions)
2200
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2201
# TODO: convert this logic, which is ~= snapshot to
2202
# a call to:. This needs the path figured out. rather than a work_tree
2203
# a v4 revision_tree can be given, or something that looks enough like
2204
# one to give the file content to the entry if it needs it.
2205
# and we need something that looks like a weave store for snapshot to
2207
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2208
if len(previous_revisions) == 1:
2209
previous_ie = previous_revisions.values()[0]
2210
if ie._unchanged(previous_ie):
2211
ie.revision = previous_ie.revision
2214
text = self.branch.repository._text_store.get(ie.text_id)
2215
file_lines = text.readlines()
2216
w.add_lines(rev_id, previous_revisions, file_lines)
2217
self.text_count += 1
2219
w.add_lines(rev_id, previous_revisions, [])
2220
ie.revision = rev_id
2222
def _make_order(self):
2223
"""Return a suitable order for importing revisions.
2225
The order must be such that an revision is imported after all
2226
its (present) parents.
2228
todo = set(self.revisions.keys())
2229
done = self.absent_revisions.copy()
2232
# scan through looking for a revision whose parents
2234
for rev_id in sorted(list(todo)):
2235
rev = self.revisions[rev_id]
2236
parent_ids = set(rev.parent_ids)
2237
if parent_ids.issubset(done):
2238
# can take this one now
2239
order.append(rev_id)
2245
class ConvertBzrDir5To6(Converter):
2246
"""Converts format 5 bzr dirs to format 6."""
2248
def convert(self, to_convert, pb):
2249
"""See Converter.convert()."""
2250
self.bzrdir = to_convert
2252
self.pb.note('starting upgrade from format 5 to 6')
2253
self._convert_to_prefixed()
2254
return BzrDir.open(self.bzrdir.root_transport.base)
2256
def _convert_to_prefixed(self):
2257
from bzrlib.store import TransportStore
2258
self.bzrdir.transport.delete('branch-format')
2259
for store_name in ["weaves", "revision-store"]:
2260
self.pb.note("adding prefixes to %s" % store_name)
2261
store_transport = self.bzrdir.transport.clone(store_name)
2262
store = TransportStore(store_transport, prefixed=True)
2263
for urlfilename in store_transport.list_dir('.'):
2264
filename = urlutils.unescape(urlfilename)
2265
if (filename.endswith(".weave") or
2266
filename.endswith(".gz") or
2267
filename.endswith(".sig")):
2268
file_id, suffix = os.path.splitext(filename)
2272
new_name = store._mapper.map((file_id,)) + suffix
2273
# FIXME keep track of the dirs made RBC 20060121
2275
store_transport.move(filename, new_name)
2276
except errors.NoSuchFile: # catches missing dirs strangely enough
2277
store_transport.mkdir(osutils.dirname(new_name))
2278
store_transport.move(filename, new_name)
2279
self.bzrdir.transport.put_bytes(
2281
BzrDirFormat6().get_format_string(),
2282
mode=self.bzrdir._get_file_mode())
2285
class ConvertBzrDir6ToMeta(Converter):
2286
"""Converts format 6 bzr dirs to metadirs."""
2288
def convert(self, to_convert, pb):
2289
"""See Converter.convert()."""
2290
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2291
from bzrlib.branch import BzrBranchFormat5
2292
self.bzrdir = to_convert
2295
self.total = 20 # the steps we know about
2296
self.garbage_inventories = []
2297
self.dir_mode = self.bzrdir._get_dir_mode()
2298
self.file_mode = self.bzrdir._get_file_mode()
2300
self.pb.note('starting upgrade from format 6 to metadir')
2301
self.bzrdir.transport.put_bytes(
2303
"Converting to format 6",
2304
mode=self.file_mode)
2305
# its faster to move specific files around than to open and use the apis...
2306
# first off, nuke ancestry.weave, it was never used.
2308
self.step('Removing ancestry.weave')
2309
self.bzrdir.transport.delete('ancestry.weave')
2310
except errors.NoSuchFile:
2312
# find out whats there
2313
self.step('Finding branch files')
2314
last_revision = self.bzrdir.open_branch().last_revision()
2315
bzrcontents = self.bzrdir.transport.list_dir('.')
2316
for name in bzrcontents:
2317
if name.startswith('basis-inventory.'):
2318
self.garbage_inventories.append(name)
2319
# create new directories for repository, working tree and branch
2320
repository_names = [('inventory.weave', True),
2321
('revision-store', True),
2323
self.step('Upgrading repository ')
2324
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2325
self.make_lock('repository')
2326
# we hard code the formats here because we are converting into
2327
# the meta format. The meta format upgrader can take this to a
2328
# future format within each component.
2329
self.put_format('repository', RepositoryFormat7())
2330
for entry in repository_names:
2331
self.move_entry('repository', entry)
2333
self.step('Upgrading branch ')
2334
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2335
self.make_lock('branch')
2336
self.put_format('branch', BzrBranchFormat5())
2337
branch_files = [('revision-history', True),
2338
('branch-name', True),
2340
for entry in branch_files:
2341
self.move_entry('branch', entry)
2343
checkout_files = [('pending-merges', True),
2344
('inventory', True),
2345
('stat-cache', False)]
2346
# If a mandatory checkout file is not present, the branch does not have
2347
# a functional checkout. Do not create a checkout in the converted
2349
for name, mandatory in checkout_files:
2350
if mandatory and name not in bzrcontents:
2351
has_checkout = False
2355
if not has_checkout:
2356
self.pb.note('No working tree.')
2357
# If some checkout files are there, we may as well get rid of them.
2358
for name, mandatory in checkout_files:
2359
if name in bzrcontents:
2360
self.bzrdir.transport.delete(name)
2362
from bzrlib.workingtree import WorkingTreeFormat3
2363
self.step('Upgrading working tree')
2364
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2365
self.make_lock('checkout')
2367
'checkout', WorkingTreeFormat3())
2368
self.bzrdir.transport.delete_multi(
2369
self.garbage_inventories, self.pb)
2370
for entry in checkout_files:
2371
self.move_entry('checkout', entry)
2372
if last_revision is not None:
2373
self.bzrdir.transport.put_bytes(
2374
'checkout/last-revision', last_revision)
2375
self.bzrdir.transport.put_bytes(
2377
BzrDirMetaFormat1().get_format_string(),
2378
mode=self.file_mode)
2379
return BzrDir.open(self.bzrdir.root_transport.base)
2381
def make_lock(self, name):
2382
"""Make a lock for the new control dir name."""
2383
self.step('Make %s lock' % name)
2384
ld = lockdir.LockDir(self.bzrdir.transport,
2386
file_modebits=self.file_mode,
2387
dir_modebits=self.dir_mode)
2390
def move_entry(self, new_dir, entry):
2391
"""Move then entry name into new_dir."""
2393
mandatory = entry[1]
2394
self.step('Moving %s' % name)
2396
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2397
except errors.NoSuchFile:
2401
def put_format(self, dirname, format):
2402
self.bzrdir.transport.put_bytes('%s/format' % dirname,
2403
format.get_format_string(),
2407
class ConvertMetaToMeta(Converter):
2408
"""Converts the components of metadirs."""
2410
def __init__(self, target_format):
2411
"""Create a metadir to metadir converter.
2413
:param target_format: The final metadir format that is desired.
2415
self.target_format = target_format
2417
def convert(self, to_convert, pb):
2418
"""See Converter.convert()."""
2419
self.bzrdir = to_convert
2423
self.step('checking repository format')
2425
repo = self.bzrdir.open_repository()
2426
except errors.NoRepositoryPresent:
2429
if not isinstance(repo._format, self.target_format.repository_format.__class__):
2430
from bzrlib.repository import CopyConverter
2431
self.pb.note('starting repository conversion')
2432
converter = CopyConverter(self.target_format.repository_format)
2433
converter.convert(repo, pb)
2435
branch = self.bzrdir.open_branch()
2436
except errors.NotBranchError:
2439
# TODO: conversions of Branch and Tree should be done by
2440
# InterXFormat lookups/some sort of registry.
2441
# Avoid circular imports
2442
from bzrlib import branch as _mod_branch
2443
old = branch._format.__class__
2444
new = self.target_format.get_branch_format().__class__
2446
if (old == _mod_branch.BzrBranchFormat5 and
2447
new in (_mod_branch.BzrBranchFormat6,
2448
_mod_branch.BzrBranchFormat7)):
2449
branch_converter = _mod_branch.Converter5to6()
2450
elif (old == _mod_branch.BzrBranchFormat6 and
2451
new == _mod_branch.BzrBranchFormat7):
2452
branch_converter = _mod_branch.Converter6to7()
2454
raise errors.BadConversionTarget("No converter", new)
2455
branch_converter.convert(branch)
2456
branch = self.bzrdir.open_branch()
2457
old = branch._format.__class__
2459
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
2460
except (errors.NoWorkingTree, errors.NotLocalUrl):
2463
# TODO: conversions of Branch and Tree should be done by
2464
# InterXFormat lookups
2465
if (isinstance(tree, workingtree.WorkingTree3) and
2466
not isinstance(tree, workingtree_4.WorkingTree4) and
2467
isinstance(self.target_format.workingtree_format,
2468
workingtree_4.WorkingTreeFormat4)):
2469
workingtree_4.Converter3to4().convert(tree)
2473
# This is not in remote.py because it's small, and needs to be registered.
2474
# Putting it in remote.py creates a circular import problem.
2475
# we can make it a lazy object if the control formats is turned into something
2477
class RemoteBzrDirFormat(BzrDirMetaFormat1):
2478
"""Format representing bzrdirs accessed via a smart server"""
2480
def get_format_description(self):
2481
return 'bzr remote bzrdir'
2484
def probe_transport(klass, transport):
2485
"""Return a RemoteBzrDirFormat object if it looks possible."""
2487
medium = transport.get_smart_medium()
2488
except (NotImplementedError, AttributeError,
2489
errors.TransportNotPossible, errors.NoSmartMedium,
2490
errors.SmartProtocolError):
2491
# no smart server, so not a branch for this format type.
2492
raise errors.NotBranchError(path=transport.base)
2494
# Decline to open it if the server doesn't support our required
2495
# version (3) so that the VFS-based transport will do it.
2496
if medium.should_probe():
2498
server_version = medium.protocol_version()
2499
except errors.SmartProtocolError:
2500
# Apparently there's no usable smart server there, even though
2501
# the medium supports the smart protocol.
2502
raise errors.NotBranchError(path=transport.base)
2503
if server_version != '2':
2504
raise errors.NotBranchError(path=transport.base)
2507
def initialize_on_transport(self, transport):
2509
# hand off the request to the smart server
2510
client_medium = transport.get_smart_medium()
2511
except errors.NoSmartMedium:
2512
# TODO: lookup the local format from a server hint.
2513
local_dir_format = BzrDirMetaFormat1()
2514
return local_dir_format.initialize_on_transport(transport)
2515
client = _SmartClient(client_medium)
2516
path = client.remote_path_from_transport(transport)
2517
response = client.call('BzrDirFormat.initialize', path)
2518
if response[0] != 'ok':
2519
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
2520
return remote.RemoteBzrDir(transport)
2522
def _open(self, transport):
2523
return remote.RemoteBzrDir(transport)
2525
def __eq__(self, other):
2526
if not isinstance(other, RemoteBzrDirFormat):
2528
return self.get_format_description() == other.get_format_description()
2531
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
2534
class BzrDirFormatInfo(object):
2536
def __init__(self, native, deprecated, hidden, experimental):
2537
self.deprecated = deprecated
2538
self.native = native
2539
self.hidden = hidden
2540
self.experimental = experimental
2543
class BzrDirFormatRegistry(registry.Registry):
2544
"""Registry of user-selectable BzrDir subformats.
2546
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
2547
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
2551
"""Create a BzrDirFormatRegistry."""
2552
self._aliases = set()
2553
super(BzrDirFormatRegistry, self).__init__()
2556
"""Return a set of the format names which are aliases."""
2557
return frozenset(self._aliases)
2559
def register_metadir(self, key,
2560
repository_format, help, native=True, deprecated=False,
2566
"""Register a metadir subformat.
2568
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
2569
by the Repository format.
2571
:param repository_format: The fully-qualified repository format class
2573
:param branch_format: Fully-qualified branch format class name as
2575
:param tree_format: Fully-qualified tree format class name as
2578
# This should be expanded to support setting WorkingTree and Branch
2579
# formats, once BzrDirMetaFormat1 supports that.
2580
def _load(full_name):
2581
mod_name, factory_name = full_name.rsplit('.', 1)
2583
mod = __import__(mod_name, globals(), locals(),
2585
except ImportError, e:
2586
raise ImportError('failed to load %s: %s' % (full_name, e))
2588
factory = getattr(mod, factory_name)
2589
except AttributeError:
2590
raise AttributeError('no factory %s in module %r'
2595
bd = BzrDirMetaFormat1()
2596
if branch_format is not None:
2597
bd.set_branch_format(_load(branch_format))
2598
if tree_format is not None:
2599
bd.workingtree_format = _load(tree_format)
2600
if repository_format is not None:
2601
bd.repository_format = _load(repository_format)
2603
self.register(key, helper, help, native, deprecated, hidden,
2604
experimental, alias)
2606
def register(self, key, factory, help, native=True, deprecated=False,
2607
hidden=False, experimental=False, alias=False):
2608
"""Register a BzrDirFormat factory.
2610
The factory must be a callable that takes one parameter: the key.
2611
It must produce an instance of the BzrDirFormat when called.
2613
This function mainly exists to prevent the info object from being
2616
registry.Registry.register(self, key, factory, help,
2617
BzrDirFormatInfo(native, deprecated, hidden, experimental))
2619
self._aliases.add(key)
2621
def register_lazy(self, key, module_name, member_name, help, native=True,
2622
deprecated=False, hidden=False, experimental=False, alias=False):
2623
registry.Registry.register_lazy(self, key, module_name, member_name,
2624
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
2626
self._aliases.add(key)
2628
def set_default(self, key):
2629
"""Set the 'default' key to be a clone of the supplied key.
2631
This method must be called once and only once.
2633
registry.Registry.register(self, 'default', self.get(key),
2634
self.get_help(key), info=self.get_info(key))
2635
self._aliases.add('default')
2637
def set_default_repository(self, key):
2638
"""Set the FormatRegistry default and Repository default.
2640
This is a transitional method while Repository.set_default_format
2643
if 'default' in self:
2644
self.remove('default')
2645
self.set_default(key)
2646
format = self.get('default')()
2648
def make_bzrdir(self, key):
2649
return self.get(key)()
2651
def help_topic(self, topic):
2652
output = textwrap.dedent("""\
2653
These formats can be used for creating branches, working trees, and
2657
default_realkey = None
2658
default_help = self.get_help('default')
2660
for key in self.keys():
2661
if key == 'default':
2663
help = self.get_help(key)
2664
if help == default_help:
2665
default_realkey = key
2667
help_pairs.append((key, help))
2669
def wrapped(key, help, info):
2671
help = '(native) ' + help
2672
return ':%s:\n%s\n\n' % (key,
2673
textwrap.fill(help, initial_indent=' ',
2674
subsequent_indent=' '))
2675
if default_realkey is not None:
2676
output += wrapped(default_realkey, '(default) %s' % default_help,
2677
self.get_info('default'))
2678
deprecated_pairs = []
2679
experimental_pairs = []
2680
for key, help in help_pairs:
2681
info = self.get_info(key)
2684
elif info.deprecated:
2685
deprecated_pairs.append((key, help))
2686
elif info.experimental:
2687
experimental_pairs.append((key, help))
2689
output += wrapped(key, help, info)
2690
if len(experimental_pairs) > 0:
2691
output += "Experimental formats are shown below.\n\n"
2692
for key, help in experimental_pairs:
2693
info = self.get_info(key)
2694
output += wrapped(key, help, info)
2695
if len(deprecated_pairs) > 0:
2696
output += "Deprecated formats are shown below.\n\n"
2697
for key, help in deprecated_pairs:
2698
info = self.get_info(key)
2699
output += wrapped(key, help, info)
2704
class RepositoryAcquisitionPolicy(object):
2705
"""Abstract base class for repository acquisition policies.
2707
A repository acquisition policy decides how a BzrDir acquires a repository
2708
for a branch that is being created. The most basic policy decision is
2709
whether to create a new repository or use an existing one.
2712
def configure_branch(self, branch):
2713
"""Apply any configuration data from this policy to the branch.
2715
Default implementation does nothing.
2719
def acquire_repository(self, make_working_trees=None, shared=False):
2720
"""Acquire a repository for this bzrdir.
2722
Implementations may create a new repository or use a pre-exising
2724
:param make_working_trees: If creating a repository, set
2725
make_working_trees to this value (if non-None)
2726
:param shared: If creating a repository, make it shared if True
2727
:return: A repository
2729
raise NotImplemented(RepositoryAcquisitionPolicy.acquire_repository)
2732
class CreateRepository(RepositoryAcquisitionPolicy):
2733
"""A policy of creating a new repository"""
2735
def __init__(self, bzrdir):
2736
RepositoryAcquisitionPolicy.__init__(self)
2737
self._bzrdir = bzrdir
2739
def acquire_repository(self, make_working_trees=None, shared=False):
2740
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
2742
Creates the desired repository in the bzrdir we already have.
2744
repository = self._bzrdir.create_repository(shared=shared)
2745
if make_working_trees is not None:
2746
repository.set_make_working_trees(make_working_trees)
2750
class UseExistingRepository(RepositoryAcquisitionPolicy):
2751
"""A policy of reusing an existing repository"""
2753
def __init__(self, repository):
2754
RepositoryAcquisitionPolicy.__init__(self)
2755
self._repository = repository
2757
def acquire_repository(self, make_working_trees=None, shared=False):
2758
"""Implementation of RepositoryAcquisitionPolicy.acquire_repository
2760
Returns an existing repository to use
2762
return self._repository
2765
format_registry = BzrDirFormatRegistry()
2766
format_registry.register('weave', BzrDirFormat6,
2767
'Pre-0.8 format. Slower than knit and does not'
2768
' support checkouts or shared repositories.',
2770
format_registry.register_metadir('knit',
2771
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2772
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
2773
branch_format='bzrlib.branch.BzrBranchFormat5',
2774
tree_format='bzrlib.workingtree.WorkingTreeFormat3')
2775
format_registry.register_metadir('metaweave',
2776
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
2777
'Transitional format in 0.8. Slower than knit.',
2778
branch_format='bzrlib.branch.BzrBranchFormat5',
2779
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2781
format_registry.register_metadir('dirstate',
2782
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2783
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2784
'above when accessed over the network.',
2785
branch_format='bzrlib.branch.BzrBranchFormat5',
2786
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
2787
# directly from workingtree_4 triggers a circular import.
2788
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2790
format_registry.register_metadir('dirstate-tags',
2791
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2792
help='New in 0.15: Fast local operations and improved scaling for '
2793
'network operations. Additionally adds support for tags.'
2794
' Incompatible with bzr < 0.15.',
2795
branch_format='bzrlib.branch.BzrBranchFormat6',
2796
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2798
format_registry.register_metadir('rich-root',
2799
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
2800
help='New in 1.0. Better handling of tree roots. Incompatible with'
2802
branch_format='bzrlib.branch.BzrBranchFormat6',
2803
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2805
format_registry.register_metadir('dirstate-with-subtree',
2806
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2807
help='New in 0.15: Fast local operations and improved scaling for '
2808
'network operations. Additionally adds support for versioning nested '
2809
'bzr branches. Incompatible with bzr < 0.15.',
2810
branch_format='bzrlib.branch.BzrBranchFormat6',
2811
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2815
format_registry.register_metadir('pack-0.92',
2816
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
2817
help='New in 0.92: Pack-based format with data compatible with '
2818
'dirstate-tags format repositories. Interoperates with '
2819
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2820
'Previously called knitpack-experimental. '
2821
'For more information, see '
2822
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2823
branch_format='bzrlib.branch.BzrBranchFormat6',
2824
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2826
format_registry.register_metadir('pack-0.92-subtree',
2827
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
2828
help='New in 0.92: Pack-based format with data compatible with '
2829
'dirstate-with-subtree format repositories. Interoperates with '
2830
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2831
'Previously called knitpack-experimental. '
2832
'For more information, see '
2833
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2834
branch_format='bzrlib.branch.BzrBranchFormat6',
2835
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2839
format_registry.register_metadir('rich-root-pack',
2840
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
2841
help='New in 1.0: Pack-based format with data compatible with '
2842
'rich-root format repositories. Incompatible with'
2844
branch_format='bzrlib.branch.BzrBranchFormat6',
2845
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2847
# The following two formats should always just be aliases.
2848
format_registry.register_metadir('development',
2849
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1',
2850
help='Current development format. Can convert data to and from pack-0.92 '
2851
'(and anything compatible with pack-0.92) format repositories. '
2852
'Repositories and branches in this format can only be read by bzr.dev. '
2854
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2856
branch_format='bzrlib.branch.BzrBranchFormat7',
2857
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2861
format_registry.register_metadir('development-subtree',
2862
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1Subtree',
2863
help='Current development format, subtree variant. Can convert data to and '
2864
'from pack-0.92-subtree (and anything compatible with '
2865
'pack-0.92-subtree) format repositories. Repositories and branches in '
2866
'this format can only be read by bzr.dev. Please read '
2867
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2869
branch_format='bzrlib.branch.BzrBranchFormat7',
2870
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2874
# And the development formats which the will have aliased one of follow:
2875
format_registry.register_metadir('development0',
2876
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
2877
help='Trivial rename of pack-0.92 to provide a development format. '
2879
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2881
branch_format='bzrlib.branch.BzrBranchFormat6',
2882
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2886
format_registry.register_metadir('development0-subtree',
2887
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
2888
help='Trivial rename of pack-0.92-subtree to provide a development format. '
2890
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2892
branch_format='bzrlib.branch.BzrBranchFormat6',
2893
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2897
format_registry.register_metadir('development1',
2898
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1',
2899
help='A branch and pack based repository that supports stacking. '
2901
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2903
branch_format='bzrlib.branch.BzrBranchFormat7',
2904
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2908
format_registry.register_metadir('development1-subtree',
2909
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment1Subtree',
2910
help='A branch and pack based repository that supports stacking. '
2912
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2914
branch_format='bzrlib.branch.BzrBranchFormat7',
2915
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2919
# The current format that is made on 'bzr init'.
2920
format_registry.set_default('pack-0.92')
added
removed
bzrlib/bzrdir.py
