1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""BzrDir logic. The BzrDir is the basic control directory used by bzr.
19
At format 7 this was split out into Branch, Repository and Checkout control
22
Note: This module has a lot of ``open`` functions/methods that return
23
references to in-memory objects. As a rule, there are no matching ``close``
24
methods. To free any associated resources, simply stop referencing the
28
# TODO: Move old formats into a plugin to make this file smaller.
30
from cStringIO import StringIO
34
from bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
36
from stat import S_ISDIR
38
from warnings import warn
48
revision as _mod_revision,
58
from bzrlib.osutils import (
62
from bzrlib.smart.client import _SmartClient
63
from bzrlib.smart import protocol
64
from bzrlib.store.revision.text import TextRevisionStore
65
from bzrlib.store.text import TextStore
66
from bzrlib.store.versioned import WeaveStore
67
from bzrlib.transactions import WriteTransaction
68
from bzrlib.transport import (
69
do_catching_redirections,
72
from bzrlib.weave import Weave
75
from bzrlib.trace import (
79
from bzrlib.transport.local import LocalTransport
80
from bzrlib.symbol_versioning import (
88
"""A .bzr control diretory.
90
BzrDir instances let you create or open any of the things that can be
91
found within .bzr - checkouts, branches and repositories.
94
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
96
a transport connected to the directory this bzr was opened from
97
(i.e. the parent directory holding the .bzr directory).
100
def break_lock(self):
101
"""Invoke break_lock on the first object in the bzrdir.
103
If there is a tree, the tree is opened and break_lock() called.
104
Otherwise, branch is tried, and finally repository.
106
# XXX: This seems more like a UI function than something that really
107
# belongs in this class.
109
thing_to_unlock = self.open_workingtree()
110
except (errors.NotLocalUrl, errors.NoWorkingTree):
112
thing_to_unlock = self.open_branch()
113
except errors.NotBranchError:
115
thing_to_unlock = self.open_repository()
116
except errors.NoRepositoryPresent:
118
thing_to_unlock.break_lock()
120
def can_convert_format(self):
121
"""Return true if this bzrdir is one whose format we can convert from."""
124
def check_conversion_target(self, target_format):
125
target_repo_format = target_format.repository_format
126
source_repo_format = self._format.repository_format
127
source_repo_format.check_conversion_target(target_repo_format)
130
def _check_supported(format, allow_unsupported,
131
recommend_upgrade=True,
133
"""Give an error or warning on old formats.
135
:param format: may be any kind of format - workingtree, branch,
138
:param allow_unsupported: If true, allow opening
139
formats that are strongly deprecated, and which may
140
have limited functionality.
142
:param recommend_upgrade: If true (default), warn
143
the user through the ui object that they may wish
144
to upgrade the object.
146
# TODO: perhaps move this into a base Format class; it's not BzrDir
147
# specific. mbp 20070323
148
if not allow_unsupported and not format.is_supported():
149
# see open_downlevel to open legacy branches.
150
raise errors.UnsupportedFormatError(format=format)
151
if recommend_upgrade \
152
and getattr(format, 'upgrade_recommended', False):
153
ui.ui_factory.recommend_upgrade(
154
format.get_format_description(),
157
def clone(self, url, revision_id=None, force_new_repo=False):
158
"""Clone this bzrdir and its contents to url verbatim.
160
If url's last component does not exist, it will be created.
162
if revision_id is not None, then the clone operation may tune
163
itself to download less data.
164
:param force_new_repo: Do not use a shared repository for the target
165
even if one is available.
167
return self.clone_on_transport(get_transport(url),
168
revision_id=revision_id,
169
force_new_repo=force_new_repo)
171
def clone_on_transport(self, transport, revision_id=None,
172
force_new_repo=False):
173
"""Clone this bzrdir and its contents to transport verbatim.
175
If the target directory does not exist, it will be created.
177
if revision_id is not None, then the clone operation may tune
178
itself to download less data.
179
:param force_new_repo: Do not use a shared repository for the target
180
even if one is available.
182
transport.ensure_base()
183
result = self._format.initialize_on_transport(transport)
185
local_repo = self.find_repository()
186
except errors.NoRepositoryPresent:
189
# may need to copy content in
191
result_repo = local_repo.clone(
193
revision_id=revision_id)
194
result_repo.set_make_working_trees(local_repo.make_working_trees())
197
result_repo = result.find_repository()
198
# fetch content this dir needs.
199
result_repo.fetch(local_repo, revision_id=revision_id)
200
except errors.NoRepositoryPresent:
201
# needed to make one anyway.
202
result_repo = local_repo.clone(
204
revision_id=revision_id)
205
result_repo.set_make_working_trees(local_repo.make_working_trees())
206
# 1 if there is a branch present
207
# make sure its content is available in the target repository
210
self.open_branch().clone(result, revision_id=revision_id)
211
except errors.NotBranchError:
214
result_repo = result.find_repository()
215
except errors.NoRepositoryPresent:
217
if result_repo is None or result_repo.make_working_trees():
219
self.open_workingtree().clone(result)
220
except (errors.NoWorkingTree, errors.NotLocalUrl):
224
# TODO: This should be given a Transport, and should chdir up; otherwise
225
# this will open a new connection.
226
def _make_tail(self, url):
227
t = get_transport(url)
231
def create(cls, base, format=None, possible_transports=None):
232
"""Create a new BzrDir at the url 'base'.
234
:param format: If supplied, the format of branch to create. If not
235
supplied, the default is used.
236
:param possible_transports: If supplied, a list of transports that
237
can be reused to share a remote connection.
239
if cls is not BzrDir:
240
raise AssertionError("BzrDir.create always creates the default"
241
" format, not one of %r" % cls)
242
t = get_transport(base, possible_transports)
245
format = BzrDirFormat.get_default_format()
246
return format.initialize_on_transport(t)
249
def find_bzrdirs(transport, evaluate=None, list_current=None):
250
"""Find bzrdirs recursively from current location.
252
This is intended primarily as a building block for more sophisticated
253
functionality, like finding trees under a directory, or finding
254
branches that use a given repository.
255
:param evaluate: An optional callable that yields recurse, value,
256
where recurse controls whether this bzrdir is recursed into
257
and value is the value to yield. By default, all bzrdirs
258
are recursed into, and the return value is the bzrdir.
259
:param list_current: if supplied, use this function to list the current
260
directory, instead of Transport.list_dir
261
:return: a generator of found bzrdirs, or whatever evaluate returns.
263
if list_current is None:
264
def list_current(transport):
265
return transport.list_dir('')
267
def evaluate(bzrdir):
270
pending = [transport]
271
while len(pending) > 0:
272
current_transport = pending.pop()
275
bzrdir = BzrDir.open_from_transport(current_transport)
276
except errors.NotBranchError:
279
recurse, value = evaluate(bzrdir)
282
subdirs = list_current(current_transport)
283
except errors.NoSuchFile:
286
for subdir in sorted(subdirs, reverse=True):
287
pending.append(current_transport.clone(subdir))
290
def find_branches(transport):
291
"""Find all branches under a transport.
293
This will find all branches below the transport, including branches
294
inside other branches. Where possible, it will use
295
Repository.find_branches.
297
To list all the branches that use a particular Repository, see
298
Repository.find_branches
300
def evaluate(bzrdir):
302
repository = bzrdir.open_repository()
303
except errors.NoRepositoryPresent:
306
return False, (None, repository)
308
branch = bzrdir.open_branch()
309
except errors.NotBranchError:
310
return True, (None, None)
312
return True, (branch, None)
314
for branch, repo in BzrDir.find_bzrdirs(transport, evaluate=evaluate):
316
branches.extend(repo.find_branches())
317
if branch is not None:
318
branches.append(branch)
322
def destroy_repository(self):
323
"""Destroy the repository in this BzrDir"""
324
raise NotImplementedError(self.destroy_repository)
326
def create_branch(self):
327
"""Create a branch in this BzrDir.
329
The bzrdir's format will control what branch format is created.
330
For more control see BranchFormatXX.create(a_bzrdir).
332
raise NotImplementedError(self.create_branch)
334
def destroy_branch(self):
335
"""Destroy the branch in this BzrDir"""
336
raise NotImplementedError(self.destroy_branch)
339
def create_branch_and_repo(base, force_new_repo=False, format=None):
340
"""Create a new BzrDir, Branch and Repository at the url 'base'.
342
This will use the current default BzrDirFormat unless one is
343
specified, and use whatever
344
repository format that that uses via bzrdir.create_branch and
345
create_repository. If a shared repository is available that is used
348
The created Branch object is returned.
350
:param base: The URL to create the branch at.
351
:param force_new_repo: If True a new repository is always created.
352
:param format: If supplied, the format of branch to create. If not
353
supplied, the default is used.
355
bzrdir = BzrDir.create(base, format)
356
bzrdir._find_or_create_repository(force_new_repo)
357
return bzrdir.create_branch()
359
def _find_or_create_repository(self, force_new_repo):
360
"""Create a new repository if needed, returning the repository."""
362
return self.create_repository()
364
return self.find_repository()
365
except errors.NoRepositoryPresent:
366
return self.create_repository()
369
def create_branch_convenience(base, force_new_repo=False,
370
force_new_tree=None, format=None,
371
possible_transports=None):
372
"""Create a new BzrDir, Branch and Repository at the url 'base'.
374
This is a convenience function - it will use an existing repository
375
if possible, can be told explicitly whether to create a working tree or
378
This will use the current default BzrDirFormat unless one is
379
specified, and use whatever
380
repository format that that uses via bzrdir.create_branch and
381
create_repository. If a shared repository is available that is used
382
preferentially. Whatever repository is used, its tree creation policy
385
The created Branch object is returned.
386
If a working tree cannot be made due to base not being a file:// url,
387
no error is raised unless force_new_tree is True, in which case no
388
data is created on disk and NotLocalUrl is raised.
390
:param base: The URL to create the branch at.
391
:param force_new_repo: If True a new repository is always created.
392
:param force_new_tree: If True or False force creation of a tree or
393
prevent such creation respectively.
394
:param format: Override for the bzrdir format to create.
395
:param possible_transports: An optional reusable transports list.
398
# check for non local urls
399
t = get_transport(base, possible_transports)
400
if not isinstance(t, LocalTransport):
401
raise errors.NotLocalUrl(base)
402
bzrdir = BzrDir.create(base, format, possible_transports)
403
repo = bzrdir._find_or_create_repository(force_new_repo)
404
result = bzrdir.create_branch()
405
if force_new_tree or (repo.make_working_trees() and
406
force_new_tree is None):
408
bzrdir.create_workingtree()
409
except errors.NotLocalUrl:
414
@deprecated_function(zero_ninetyone)
415
def create_repository(base, shared=False, format=None):
416
"""Create a new BzrDir and Repository at the url 'base'.
418
If no format is supplied, this will default to the current default
419
BzrDirFormat by default, and use whatever repository format that that
420
uses for bzrdirformat.create_repository.
422
:param shared: Create a shared repository rather than a standalone
424
The Repository object is returned.
426
This must be overridden as an instance method in child classes, where
427
it should take no parameters and construct whatever repository format
428
that child class desires.
430
This method is deprecated, please call create_repository on a bzrdir
433
bzrdir = BzrDir.create(base, format)
434
return bzrdir.create_repository(shared)
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_repository(self):
512
"""Find the repository that should be used.
514
This does not require a branch as we use it to find the repo for
515
new branches as well as to hook existing branches up to their
519
return self.open_repository()
520
except errors.NoRepositoryPresent:
522
next_transport = self.root_transport.clone('..')
524
# find the next containing bzrdir
526
found_bzrdir = BzrDir.open_containing_from_transport(
528
except errors.NotBranchError:
530
raise errors.NoRepositoryPresent(self)
531
# does it have a repository ?
533
repository = found_bzrdir.open_repository()
534
except errors.NoRepositoryPresent:
535
next_transport = found_bzrdir.root_transport.clone('..')
536
if (found_bzrdir.root_transport.base == next_transport.base):
537
# top of the file system
541
if ((found_bzrdir.root_transport.base ==
542
self.root_transport.base) or repository.is_shared()):
545
raise errors.NoRepositoryPresent(self)
546
raise errors.NoRepositoryPresent(self)
548
def get_branch_reference(self):
549
"""Return the referenced URL for the branch in this bzrdir.
551
:raises NotBranchError: If there is no Branch.
552
:return: The URL the branch in this bzrdir references if it is a
553
reference branch, or None for regular branches.
557
def get_branch_transport(self, branch_format):
558
"""Get the transport for use by branch format in this BzrDir.
560
Note that bzr dirs that do not support format strings will raise
561
IncompatibleFormat if the branch format they are given has
562
a format string, and vice versa.
564
If branch_format is None, the transport is returned with no
565
checking. If it is not None, then the returned transport is
566
guaranteed to point to an existing directory ready for use.
568
raise NotImplementedError(self.get_branch_transport)
570
def get_repository_transport(self, repository_format):
571
"""Get the transport for use by repository format in this BzrDir.
573
Note that bzr dirs that do not support format strings will raise
574
IncompatibleFormat if the repository format they are given has
575
a format string, and vice versa.
577
If repository_format is None, the transport is returned with no
578
checking. If it is not None, then the returned transport is
579
guaranteed to point to an existing directory ready for use.
581
raise NotImplementedError(self.get_repository_transport)
583
def get_workingtree_transport(self, tree_format):
584
"""Get the transport for use by workingtree format in this BzrDir.
586
Note that bzr dirs that do not support format strings will raise
587
IncompatibleFormat if the workingtree format they are given has a
588
format string, and vice versa.
590
If workingtree_format is None, the transport is returned with no
591
checking. If it is not None, then the returned transport is
592
guaranteed to point to an existing directory ready for use.
594
raise NotImplementedError(self.get_workingtree_transport)
596
def __init__(self, _transport, _format):
597
"""Initialize a Bzr control dir object.
599
Only really common logic should reside here, concrete classes should be
600
made with varying behaviours.
602
:param _format: the format that is creating this BzrDir instance.
603
:param _transport: the transport this dir is based at.
605
self._format = _format
606
self.transport = _transport.clone('.bzr')
607
self.root_transport = _transport
609
def is_control_filename(self, filename):
610
"""True if filename is the name of a path which is reserved for bzrdir's.
612
:param filename: A filename within the root transport of this bzrdir.
614
This is true IF and ONLY IF the filename is part of the namespace reserved
615
for bzr control dirs. Currently this is the '.bzr' directory in the root
616
of the root_transport. it is expected that plugins will need to extend
617
this in the future - for instance to make bzr talk with svn working
620
# this might be better on the BzrDirFormat class because it refers to
621
# all the possible bzrdir disk formats.
622
# This method is tested via the workingtree is_control_filename tests-
623
# it was extracted from WorkingTree.is_control_filename. If the method's
624
# contract is extended beyond the current trivial implementation, please
625
# add new tests for it to the appropriate place.
626
return filename == '.bzr' or filename.startswith('.bzr/')
628
def needs_format_conversion(self, format=None):
629
"""Return true if this bzrdir needs convert_format run on it.
631
For instance, if the repository format is out of date but the
632
branch and working tree are not, this should return True.
634
:param format: Optional parameter indicating a specific desired
635
format we plan to arrive at.
637
raise NotImplementedError(self.needs_format_conversion)
640
def open_unsupported(base):
641
"""Open a branch which is not supported."""
642
return BzrDir.open(base, _unsupported=True)
645
def open(base, _unsupported=False, possible_transports=None):
646
"""Open an existing bzrdir, rooted at 'base' (url).
648
:param _unsupported: a private parameter to the BzrDir class.
650
t = get_transport(base, possible_transports=possible_transports)
651
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
654
def open_from_transport(transport, _unsupported=False,
655
_server_formats=True):
656
"""Open a bzrdir within a particular directory.
658
:param transport: Transport containing the bzrdir.
659
:param _unsupported: private.
661
base = transport.base
663
def find_format(transport):
664
return transport, BzrDirFormat.find_format(
665
transport, _server_formats=_server_formats)
667
def redirected(transport, e, redirection_notice):
668
qualified_source = e.get_source_url()
669
relpath = transport.relpath(qualified_source)
670
if not e.target.endswith(relpath):
671
# Not redirected to a branch-format, not a branch
672
raise errors.NotBranchError(path=e.target)
673
target = e.target[:-len(relpath)]
674
note('%s is%s redirected to %s',
675
transport.base, e.permanently, target)
676
# Let's try with a new transport
677
# FIXME: If 'transport' has a qualifier, this should
678
# be applied again to the new transport *iff* the
679
# schemes used are the same. Uncomment this code
680
# once the function (and tests) exist.
682
#target = urlutils.copy_url_qualifiers(original, target)
683
return get_transport(target)
686
transport, format = do_catching_redirections(find_format,
689
except errors.TooManyRedirections:
690
raise errors.NotBranchError(base)
692
BzrDir._check_supported(format, _unsupported)
693
return format.open(transport, _found=True)
695
def open_branch(self, unsupported=False):
696
"""Open the branch object at this BzrDir if one is present.
698
If unsupported is True, then no longer supported branch formats can
701
TODO: static convenience version of this?
703
raise NotImplementedError(self.open_branch)
706
def open_containing(url, possible_transports=None):
707
"""Open an existing branch which contains url.
709
:param url: url to search from.
710
See open_containing_from_transport for more detail.
712
transport = get_transport(url, possible_transports)
713
return BzrDir.open_containing_from_transport(transport)
716
def open_containing_from_transport(a_transport):
717
"""Open an existing branch which contains a_transport.base.
719
This probes for a branch at a_transport, and searches upwards from there.
721
Basically we keep looking up until we find the control directory or
722
run into the root. If there isn't one, raises NotBranchError.
723
If there is one and it is either an unrecognised format or an unsupported
724
format, UnknownFormatError or UnsupportedFormatError are raised.
725
If there is one, it is returned, along with the unused portion of url.
727
:return: The BzrDir that contains the path, and a Unicode path
728
for the rest of the URL.
730
# this gets the normalised url back. I.e. '.' -> the full path.
731
url = a_transport.base
734
result = BzrDir.open_from_transport(a_transport)
735
return result, urlutils.unescape(a_transport.relpath(url))
736
except errors.NotBranchError, e:
739
new_t = a_transport.clone('..')
740
except errors.InvalidURLJoin:
741
# reached the root, whatever that may be
742
raise errors.NotBranchError(path=url)
743
if new_t.base == a_transport.base:
744
# reached the root, whatever that may be
745
raise errors.NotBranchError(path=url)
748
def _get_tree_branch(self):
749
"""Return the branch and tree, if any, for this bzrdir.
751
Return None for tree if not present or inaccessible.
752
Raise NotBranchError if no branch is present.
753
:return: (tree, branch)
756
tree = self.open_workingtree()
757
except (errors.NoWorkingTree, errors.NotLocalUrl):
759
branch = self.open_branch()
765
def open_tree_or_branch(klass, location):
766
"""Return the branch and working tree at a location.
768
If there is no tree at the location, tree will be None.
769
If there is no branch at the location, an exception will be
771
:return: (tree, branch)
773
bzrdir = klass.open(location)
774
return bzrdir._get_tree_branch()
777
def open_containing_tree_or_branch(klass, location):
778
"""Return the branch and working tree contained by a location.
780
Returns (tree, branch, relpath).
781
If there is no tree at containing the location, tree will be None.
782
If there is no branch containing the location, an exception will be
784
relpath is the portion of the path that is contained by the branch.
786
bzrdir, relpath = klass.open_containing(location)
787
tree, branch = bzrdir._get_tree_branch()
788
return tree, branch, relpath
790
def open_repository(self, _unsupported=False):
791
"""Open the repository object at this BzrDir if one is present.
793
This will not follow the Branch object pointer - it's strictly a direct
794
open facility. Most client code should use open_branch().repository to
797
:param _unsupported: a private parameter, not part of the api.
798
TODO: static convenience version of this?
800
raise NotImplementedError(self.open_repository)
802
def open_workingtree(self, _unsupported=False,
803
recommend_upgrade=True, from_branch=None):
804
"""Open the workingtree object at this BzrDir if one is present.
806
:param recommend_upgrade: Optional keyword parameter, when True (the
807
default), emit through the ui module a recommendation that the user
808
upgrade the working tree when the workingtree being opened is old
809
(but still fully supported).
810
:param from_branch: override bzrdir branch (for lightweight checkouts)
812
raise NotImplementedError(self.open_workingtree)
814
def has_branch(self):
815
"""Tell if this bzrdir contains a branch.
817
Note: if you're going to open the branch, you should just go ahead
818
and try, and not ask permission first. (This method just opens the
819
branch and discards it, and that's somewhat expensive.)
824
except errors.NotBranchError:
827
def has_workingtree(self):
828
"""Tell if this bzrdir contains a working tree.
830
This will still raise an exception if the bzrdir has a workingtree that
831
is remote & inaccessible.
833
Note: if you're going to open the working tree, you should just go ahead
834
and try, and not ask permission first. (This method just opens the
835
workingtree and discards it, and that's somewhat expensive.)
838
self.open_workingtree(recommend_upgrade=False)
840
except errors.NoWorkingTree:
843
def _cloning_metadir(self):
844
"""Produce a metadir suitable for cloning with."""
845
result_format = self._format.__class__()
848
branch = self.open_branch()
849
source_repository = branch.repository
850
except errors.NotBranchError:
852
source_repository = self.open_repository()
853
except errors.NoRepositoryPresent:
854
source_repository = None
856
# XXX TODO: This isinstance is here because we have not implemented
857
# the fix recommended in bug # 103195 - to delegate this choice the
859
repo_format = source_repository._format
860
if not isinstance(repo_format, remote.RemoteRepositoryFormat):
861
result_format.repository_format = repo_format
863
# TODO: Couldn't we just probe for the format in these cases,
864
# rather than opening the whole tree? It would be a little
865
# faster. mbp 20070401
866
tree = self.open_workingtree(recommend_upgrade=False)
867
except (errors.NoWorkingTree, errors.NotLocalUrl):
868
result_format.workingtree_format = None
870
result_format.workingtree_format = tree._format.__class__()
871
return result_format, source_repository
873
def cloning_metadir(self):
874
"""Produce a metadir suitable for cloning or sprouting with.
876
These operations may produce workingtrees (yes, even though they're
877
"cloning" something that doesn't have a tree), so a viable workingtree
878
format must be selected.
880
format, repository = self._cloning_metadir()
881
if format._workingtree_format is None:
882
if repository is None:
884
tree_format = repository._format._matchingbzrdir.workingtree_format
885
format.workingtree_format = tree_format.__class__()
888
def checkout_metadir(self):
889
return self.cloning_metadir()
891
def sprout(self, url, revision_id=None, force_new_repo=False,
892
recurse='down', possible_transports=None,
893
accelerator_tree=None, hardlink=False):
894
"""Create a copy of this bzrdir prepared for use as a new line of
897
If url's last component does not exist, it will be created.
899
Attributes related to the identity of the source branch like
900
branch nickname will be cleaned, a working tree is created
901
whether one existed before or not; and a local branch is always
904
if revision_id is not None, then the clone operation may tune
905
itself to download less data.
906
:param accelerator_tree: A tree which can be used for retrieving file
907
contents more quickly than the revision tree, i.e. a workingtree.
908
The revision tree will be used for cases where accelerator_tree's
909
content is different.
910
:param hardlink: If true, hard-link files from accelerator_tree,
913
target_transport = get_transport(url, possible_transports)
914
target_transport.ensure_base()
915
cloning_format = self.cloning_metadir()
916
result = cloning_format.initialize_on_transport(target_transport)
918
source_branch = self.open_branch()
919
source_repository = source_branch.repository
920
except errors.NotBranchError:
923
source_repository = self.open_repository()
924
except errors.NoRepositoryPresent:
925
source_repository = None
930
result_repo = result.find_repository()
931
except errors.NoRepositoryPresent:
933
if source_repository is None and result_repo is not None:
935
elif source_repository is None and result_repo is None:
936
# no repo available, make a new one
937
result.create_repository()
938
elif source_repository is not None and result_repo is None:
939
# have source, and want to make a new target repo
940
result_repo = source_repository.sprout(result,
941
revision_id=revision_id)
943
# fetch needed content into target.
944
if source_repository is not None:
946
# source_repository.copy_content_into(result_repo,
947
# revision_id=revision_id)
948
# so we can override the copy method
949
result_repo.fetch(source_repository, revision_id=revision_id)
950
if source_branch is not None:
951
source_branch.sprout(result, revision_id=revision_id)
953
result.create_branch()
954
if isinstance(target_transport, LocalTransport) and (
955
result_repo is None or result_repo.make_working_trees()):
956
wt = result.create_workingtree(accelerator_tree=accelerator_tree,
960
if wt.path2id('') is None:
962
wt.set_root_id(self.open_workingtree.get_root_id())
963
except errors.NoWorkingTree:
969
if recurse == 'down':
971
basis = wt.basis_tree()
973
subtrees = basis.iter_references()
974
recurse_branch = wt.branch
975
elif source_branch is not None:
976
basis = source_branch.basis_tree()
978
subtrees = basis.iter_references()
979
recurse_branch = source_branch
984
for path, file_id in subtrees:
985
target = urlutils.join(url, urlutils.escape(path))
986
sublocation = source_branch.reference_parent(file_id, path)
987
sublocation.bzrdir.sprout(target,
988
basis.get_reference_revision(file_id, path),
989
force_new_repo=force_new_repo, recurse=recurse)
991
if basis is not None:
996
class BzrDirPreSplitOut(BzrDir):
997
"""A common class for the all-in-one formats."""
999
def __init__(self, _transport, _format):
1000
"""See BzrDir.__init__."""
1001
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
1002
assert self._format._lock_class == lockable_files.TransportLock
1003
assert self._format._lock_file_name == 'branch-lock'
1004
self._control_files = lockable_files.LockableFiles(
1005
self.get_branch_transport(None),
1006
self._format._lock_file_name,
1007
self._format._lock_class)
1009
def break_lock(self):
1010
"""Pre-splitout bzrdirs do not suffer from stale locks."""
1011
raise NotImplementedError(self.break_lock)
1013
def clone(self, url, revision_id=None, force_new_repo=False):
1014
"""See BzrDir.clone()."""
1015
from bzrlib.workingtree import WorkingTreeFormat2
1016
self._make_tail(url)
1017
result = self._format._initialize_for_clone(url)
1018
self.open_repository().clone(result, revision_id=revision_id)
1019
from_branch = self.open_branch()
1020
from_branch.clone(result, revision_id=revision_id)
1022
self.open_workingtree().clone(result)
1023
except errors.NotLocalUrl:
1024
# make a new one, this format always has to have one.
1026
WorkingTreeFormat2().initialize(result)
1027
except errors.NotLocalUrl:
1028
# but we cannot do it for remote trees.
1029
to_branch = result.open_branch()
1030
WorkingTreeFormat2().stub_initialize_remote(to_branch.control_files)
1033
def create_branch(self):
1034
"""See BzrDir.create_branch."""
1035
return self.open_branch()
1037
def destroy_branch(self):
1038
"""See BzrDir.destroy_branch."""
1039
raise errors.UnsupportedOperation(self.destroy_branch, self)
1041
def create_repository(self, shared=False):
1042
"""See BzrDir.create_repository."""
1044
raise errors.IncompatibleFormat('shared repository', self._format)
1045
return self.open_repository()
1047
def destroy_repository(self):
1048
"""See BzrDir.destroy_repository."""
1049
raise errors.UnsupportedOperation(self.destroy_repository, self)
1051
def create_workingtree(self, revision_id=None, from_branch=None,
1052
accelerator_tree=None, hardlink=False):
1053
"""See BzrDir.create_workingtree."""
1054
# this looks buggy but is not -really-
1055
# because this format creates the workingtree when the bzrdir is
1057
# clone and sprout will have set the revision_id
1058
# and that will have set it for us, its only
1059
# specific uses of create_workingtree in isolation
1060
# that can do wonky stuff here, and that only
1061
# happens for creating checkouts, which cannot be
1062
# done on this format anyway. So - acceptable wart.
1063
result = self.open_workingtree(recommend_upgrade=False)
1064
if revision_id is not None:
1065
if revision_id == _mod_revision.NULL_REVISION:
1066
result.set_parent_ids([])
1068
result.set_parent_ids([revision_id])
1071
def destroy_workingtree(self):
1072
"""See BzrDir.destroy_workingtree."""
1073
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
1075
def destroy_workingtree_metadata(self):
1076
"""See BzrDir.destroy_workingtree_metadata."""
1077
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
1080
def get_branch_transport(self, branch_format):
1081
"""See BzrDir.get_branch_transport()."""
1082
if branch_format is None:
1083
return self.transport
1085
branch_format.get_format_string()
1086
except NotImplementedError:
1087
return self.transport
1088
raise errors.IncompatibleFormat(branch_format, self._format)
1090
def get_repository_transport(self, repository_format):
1091
"""See BzrDir.get_repository_transport()."""
1092
if repository_format is None:
1093
return self.transport
1095
repository_format.get_format_string()
1096
except NotImplementedError:
1097
return self.transport
1098
raise errors.IncompatibleFormat(repository_format, self._format)
1100
def get_workingtree_transport(self, workingtree_format):
1101
"""See BzrDir.get_workingtree_transport()."""
1102
if workingtree_format is None:
1103
return self.transport
1105
workingtree_format.get_format_string()
1106
except NotImplementedError:
1107
return self.transport
1108
raise errors.IncompatibleFormat(workingtree_format, self._format)
1110
def needs_format_conversion(self, format=None):
1111
"""See BzrDir.needs_format_conversion()."""
1112
# if the format is not the same as the system default,
1113
# an upgrade is needed.
1115
format = BzrDirFormat.get_default_format()
1116
return not isinstance(self._format, format.__class__)
1118
def open_branch(self, unsupported=False):
1119
"""See BzrDir.open_branch."""
1120
from bzrlib.branch import BzrBranchFormat4
1121
format = BzrBranchFormat4()
1122
self._check_supported(format, unsupported)
1123
return format.open(self, _found=True)
1125
def sprout(self, url, revision_id=None, force_new_repo=False,
1126
possible_transports=None, accelerator_tree=None,
1128
"""See BzrDir.sprout()."""
1129
from bzrlib.workingtree import WorkingTreeFormat2
1130
self._make_tail(url)
1131
result = self._format._initialize_for_clone(url)
1133
self.open_repository().clone(result, revision_id=revision_id)
1134
except errors.NoRepositoryPresent:
1137
self.open_branch().sprout(result, revision_id=revision_id)
1138
except errors.NotBranchError:
1140
# we always want a working tree
1141
WorkingTreeFormat2().initialize(result,
1142
accelerator_tree=accelerator_tree,
1147
class BzrDir4(BzrDirPreSplitOut):
1148
"""A .bzr version 4 control object.
1150
This is a deprecated format and may be removed after sept 2006.
1153
def create_repository(self, shared=False):
1154
"""See BzrDir.create_repository."""
1155
return self._format.repository_format.initialize(self, shared)
1157
def needs_format_conversion(self, format=None):
1158
"""Format 4 dirs are always in need of conversion."""
1161
def open_repository(self):
1162
"""See BzrDir.open_repository."""
1163
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1164
return RepositoryFormat4().open(self, _found=True)
1167
class BzrDir5(BzrDirPreSplitOut):
1168
"""A .bzr version 5 control object.
1170
This is a deprecated format and may be removed after sept 2006.
1173
def open_repository(self):
1174
"""See BzrDir.open_repository."""
1175
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1176
return RepositoryFormat5().open(self, _found=True)
1178
def open_workingtree(self, _unsupported=False,
1179
recommend_upgrade=True):
1180
"""See BzrDir.create_workingtree."""
1181
from bzrlib.workingtree import WorkingTreeFormat2
1182
wt_format = WorkingTreeFormat2()
1183
# we don't warn here about upgrades; that ought to be handled for the
1185
return wt_format.open(self, _found=True)
1188
class BzrDir6(BzrDirPreSplitOut):
1189
"""A .bzr version 6 control object.
1191
This is a deprecated format and may be removed after sept 2006.
1194
def open_repository(self):
1195
"""See BzrDir.open_repository."""
1196
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1197
return RepositoryFormat6().open(self, _found=True)
1199
def open_workingtree(self, _unsupported=False,
1200
recommend_upgrade=True):
1201
"""See BzrDir.create_workingtree."""
1202
# we don't warn here about upgrades; that ought to be handled for the
1204
from bzrlib.workingtree import WorkingTreeFormat2
1205
return WorkingTreeFormat2().open(self, _found=True)
1208
class BzrDirMeta1(BzrDir):
1209
"""A .bzr meta version 1 control object.
1211
This is the first control object where the
1212
individual aspects are really split out: there are separate repository,
1213
workingtree and branch subdirectories and any subset of the three can be
1214
present within a BzrDir.
1217
def can_convert_format(self):
1218
"""See BzrDir.can_convert_format()."""
1221
def create_branch(self):
1222
"""See BzrDir.create_branch."""
1223
return self._format.get_branch_format().initialize(self)
1225
def destroy_branch(self):
1226
"""See BzrDir.create_branch."""
1227
self.transport.delete_tree('branch')
1229
def create_repository(self, shared=False):
1230
"""See BzrDir.create_repository."""
1231
return self._format.repository_format.initialize(self, shared)
1233
def destroy_repository(self):
1234
"""See BzrDir.destroy_repository."""
1235
self.transport.delete_tree('repository')
1237
def create_workingtree(self, revision_id=None, from_branch=None,
1238
accelerator_tree=None, hardlink=False):
1239
"""See BzrDir.create_workingtree."""
1240
return self._format.workingtree_format.initialize(
1241
self, revision_id, from_branch=from_branch,
1242
accelerator_tree=accelerator_tree, hardlink=hardlink)
1244
def destroy_workingtree(self):
1245
"""See BzrDir.destroy_workingtree."""
1246
wt = self.open_workingtree(recommend_upgrade=False)
1247
repository = wt.branch.repository
1248
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
1249
wt.revert(old_tree=empty)
1250
self.destroy_workingtree_metadata()
1252
def destroy_workingtree_metadata(self):
1253
self.transport.delete_tree('checkout')
1255
def find_branch_format(self):
1256
"""Find the branch 'format' for this bzrdir.
1258
This might be a synthetic object for e.g. RemoteBranch and SVN.
1260
from bzrlib.branch import BranchFormat
1261
return BranchFormat.find_format(self)
1263
def _get_mkdir_mode(self):
1264
"""Figure out the mode to use when creating a bzrdir subdir."""
1265
temp_control = lockable_files.LockableFiles(self.transport, '',
1266
lockable_files.TransportLock)
1267
return temp_control._dir_mode
1269
def get_branch_reference(self):
1270
"""See BzrDir.get_branch_reference()."""
1271
from bzrlib.branch import BranchFormat
1272
format = BranchFormat.find_format(self)
1273
return format.get_reference(self)
1275
def get_branch_transport(self, branch_format):
1276
"""See BzrDir.get_branch_transport()."""
1277
if branch_format is None:
1278
return self.transport.clone('branch')
1280
branch_format.get_format_string()
1281
except NotImplementedError:
1282
raise errors.IncompatibleFormat(branch_format, self._format)
1284
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
1285
except errors.FileExists:
1287
return self.transport.clone('branch')
1289
def get_repository_transport(self, repository_format):
1290
"""See BzrDir.get_repository_transport()."""
1291
if repository_format is None:
1292
return self.transport.clone('repository')
1294
repository_format.get_format_string()
1295
except NotImplementedError:
1296
raise errors.IncompatibleFormat(repository_format, self._format)
1298
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
1299
except errors.FileExists:
1301
return self.transport.clone('repository')
1303
def get_workingtree_transport(self, workingtree_format):
1304
"""See BzrDir.get_workingtree_transport()."""
1305
if workingtree_format is None:
1306
return self.transport.clone('checkout')
1308
workingtree_format.get_format_string()
1309
except NotImplementedError:
1310
raise errors.IncompatibleFormat(workingtree_format, self._format)
1312
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
1313
except errors.FileExists:
1315
return self.transport.clone('checkout')
1317
def needs_format_conversion(self, format=None):
1318
"""See BzrDir.needs_format_conversion()."""
1320
format = BzrDirFormat.get_default_format()
1321
if not isinstance(self._format, format.__class__):
1322
# it is not a meta dir format, conversion is needed.
1324
# we might want to push this down to the repository?
1326
if not isinstance(self.open_repository()._format,
1327
format.repository_format.__class__):
1328
# the repository needs an upgrade.
1330
except errors.NoRepositoryPresent:
1333
if not isinstance(self.open_branch()._format,
1334
format.get_branch_format().__class__):
1335
# the branch needs an upgrade.
1337
except errors.NotBranchError:
1340
my_wt = self.open_workingtree(recommend_upgrade=False)
1341
if not isinstance(my_wt._format,
1342
format.workingtree_format.__class__):
1343
# the workingtree needs an upgrade.
1345
except (errors.NoWorkingTree, errors.NotLocalUrl):
1349
def open_branch(self, unsupported=False):
1350
"""See BzrDir.open_branch."""
1351
format = self.find_branch_format()
1352
self._check_supported(format, unsupported)
1353
return format.open(self, _found=True)
1355
def open_repository(self, unsupported=False):
1356
"""See BzrDir.open_repository."""
1357
from bzrlib.repository import RepositoryFormat
1358
format = RepositoryFormat.find_format(self)
1359
self._check_supported(format, unsupported)
1360
return format.open(self, _found=True)
1362
def open_workingtree(self, unsupported=False,
1363
recommend_upgrade=True):
1364
"""See BzrDir.open_workingtree."""
1365
from bzrlib.workingtree import WorkingTreeFormat
1366
format = WorkingTreeFormat.find_format(self)
1367
self._check_supported(format, unsupported,
1369
basedir=self.root_transport.base)
1370
return format.open(self, _found=True)
1373
class BzrDirFormat(object):
1374
"""An encapsulation of the initialization and open routines for a format.
1376
Formats provide three things:
1377
* An initialization routine,
1381
Formats are placed in a dict by their format string for reference
1382
during bzrdir opening. These should be subclasses of BzrDirFormat
1385
Once a format is deprecated, just deprecate the initialize and open
1386
methods on the format class. Do not deprecate the object, as the
1387
object will be created every system load.
1390
_default_format = None
1391
"""The default format used for new .bzr dirs."""
1394
"""The known formats."""
1396
_control_formats = []
1397
"""The registered control formats - .bzr, ....
1399
This is a list of BzrDirFormat objects.
1402
_control_server_formats = []
1403
"""The registered control server formats, e.g. RemoteBzrDirs.
1405
This is a list of BzrDirFormat objects.
1408
_lock_file_name = 'branch-lock'
1410
# _lock_class must be set in subclasses to the lock type, typ.
1411
# TransportLock or LockDir
1414
def find_format(klass, transport, _server_formats=True):
1415
"""Return the format present at transport."""
1417
formats = klass._control_server_formats + klass._control_formats
1419
formats = klass._control_formats
1420
for format in formats:
1422
return format.probe_transport(transport)
1423
except errors.NotBranchError:
1424
# this format does not find a control dir here.
1426
raise errors.NotBranchError(path=transport.base)
1429
def probe_transport(klass, transport):
1430
"""Return the .bzrdir style format present in a directory."""
1432
format_string = transport.get(".bzr/branch-format").read()
1433
except errors.NoSuchFile:
1434
raise errors.NotBranchError(path=transport.base)
1437
return klass._formats[format_string]
1439
raise errors.UnknownFormatError(format=format_string, kind='bzrdir')
1442
def get_default_format(klass):
1443
"""Return the current default format."""
1444
return klass._default_format
1446
def get_format_string(self):
1447
"""Return the ASCII format string that identifies this format."""
1448
raise NotImplementedError(self.get_format_string)
1450
def get_format_description(self):
1451
"""Return the short description for this format."""
1452
raise NotImplementedError(self.get_format_description)
1454
def get_converter(self, format=None):
1455
"""Return the converter to use to convert bzrdirs needing converts.
1457
This returns a bzrlib.bzrdir.Converter object.
1459
This should return the best upgrader to step this format towards the
1460
current default format. In the case of plugins we can/should provide
1461
some means for them to extend the range of returnable converters.
1463
:param format: Optional format to override the default format of the
1466
raise NotImplementedError(self.get_converter)
1468
def initialize(self, url, possible_transports=None):
1469
"""Create a bzr control dir at this url and return an opened copy.
1471
Subclasses should typically override initialize_on_transport
1472
instead of this method.
1474
return self.initialize_on_transport(get_transport(url,
1475
possible_transports))
1477
def initialize_on_transport(self, transport):
1478
"""Initialize a new bzrdir in the base directory of a Transport."""
1479
# Since we don't have a .bzr directory, inherit the
1480
# mode from the root directory
1481
temp_control = lockable_files.LockableFiles(transport,
1482
'', lockable_files.TransportLock)
1483
temp_control._transport.mkdir('.bzr',
1484
# FIXME: RBC 20060121 don't peek under
1486
mode=temp_control._dir_mode)
1487
if sys.platform == 'win32' and isinstance(transport, LocalTransport):
1488
win32utils.set_file_attr_hidden(transport._abspath('.bzr'))
1489
file_mode = temp_control._file_mode
1491
mutter('created control directory in ' + transport.base)
1492
control = transport.clone('.bzr')
1493
utf8_files = [('README',
1494
"This is a Bazaar control directory.\n"
1495
"Do not change any files in this directory.\n"
1496
"See http://bazaar-vcs.org/ for more information about Bazaar.\n"),
1497
('branch-format', self.get_format_string()),
1499
# NB: no need to escape relative paths that are url safe.
1500
control_files = lockable_files.LockableFiles(control,
1501
self._lock_file_name, self._lock_class)
1502
control_files.create_lock()
1503
control_files.lock_write()
1505
for file, content in utf8_files:
1506
control_files.put_utf8(file, content)
1508
control_files.unlock()
1509
return self.open(transport, _found=True)
1511
def is_supported(self):
1512
"""Is this format supported?
1514
Supported formats must be initializable and openable.
1515
Unsupported formats may not support initialization or committing or
1516
some other features depending on the reason for not being supported.
1520
def same_model(self, target_format):
1521
return (self.repository_format.rich_root_data ==
1522
target_format.rich_root_data)
1525
def known_formats(klass):
1526
"""Return all the known formats.
1528
Concrete formats should override _known_formats.
1530
# There is double indirection here to make sure that control
1531
# formats used by more than one dir format will only be probed
1532
# once. This can otherwise be quite expensive for remote connections.
1534
for format in klass._control_formats:
1535
result.update(format._known_formats())
1539
def _known_formats(klass):
1540
"""Return the known format instances for this control format."""
1541
return set(klass._formats.values())
1543
def open(self, transport, _found=False):
1544
"""Return an instance of this format for the dir transport points at.
1546
_found is a private parameter, do not use it.
1549
found_format = BzrDirFormat.find_format(transport)
1550
if not isinstance(found_format, self.__class__):
1551
raise AssertionError("%s was asked to open %s, but it seems to need "
1553
% (self, transport, found_format))
1554
return self._open(transport)
1556
def _open(self, transport):
1557
"""Template method helper for opening BzrDirectories.
1559
This performs the actual open and any additional logic or parameter
1562
raise NotImplementedError(self._open)
1565
def register_format(klass, format):
1566
klass._formats[format.get_format_string()] = format
1569
def register_control_format(klass, format):
1570
"""Register a format that does not use '.bzr' for its control dir.
1572
TODO: This should be pulled up into a 'ControlDirFormat' base class
1573
which BzrDirFormat can inherit from, and renamed to register_format
1574
there. It has been done without that for now for simplicity of
1577
klass._control_formats.append(format)
1580
def register_control_server_format(klass, format):
1581
"""Register a control format for client-server environments.
1583
These formats will be tried before ones registered with
1584
register_control_format. This gives implementations that decide to the
1585
chance to grab it before anything looks at the contents of the format
1588
klass._control_server_formats.append(format)
1591
@symbol_versioning.deprecated_method(symbol_versioning.zero_fourteen)
1592
def set_default_format(klass, format):
1593
klass._set_default_format(format)
1596
def _set_default_format(klass, format):
1597
"""Set default format (for testing behavior of defaults only)"""
1598
klass._default_format = format
1602
return self.get_format_string().rstrip()
1605
def unregister_format(klass, format):
1606
assert klass._formats[format.get_format_string()] is format
1607
del klass._formats[format.get_format_string()]
1610
def unregister_control_format(klass, format):
1611
klass._control_formats.remove(format)
1614
class BzrDirFormat4(BzrDirFormat):
1615
"""Bzr dir format 4.
1617
This format is a combined format for working tree, branch and repository.
1619
- Format 1 working trees [always]
1620
- Format 4 branches [always]
1621
- Format 4 repositories [always]
1623
This format is deprecated: it indexes texts using a text it which is
1624
removed in format 5; write support for this format has been removed.
1627
_lock_class = lockable_files.TransportLock
1629
def get_format_string(self):
1630
"""See BzrDirFormat.get_format_string()."""
1631
return "Bazaar-NG branch, format 0.0.4\n"
1633
def get_format_description(self):
1634
"""See BzrDirFormat.get_format_description()."""
1635
return "All-in-one format 4"
1637
def get_converter(self, format=None):
1638
"""See BzrDirFormat.get_converter()."""
1639
# there is one and only one upgrade path here.
1640
return ConvertBzrDir4To5()
1642
def initialize_on_transport(self, transport):
1643
"""Format 4 branches cannot be created."""
1644
raise errors.UninitializableFormat(self)
1646
def is_supported(self):
1647
"""Format 4 is not supported.
1649
It is not supported because the model changed from 4 to 5 and the
1650
conversion logic is expensive - so doing it on the fly was not
1655
def _open(self, transport):
1656
"""See BzrDirFormat._open."""
1657
return BzrDir4(transport, self)
1659
def __return_repository_format(self):
1660
"""Circular import protection."""
1661
from bzrlib.repofmt.weaverepo import RepositoryFormat4
1662
return RepositoryFormat4()
1663
repository_format = property(__return_repository_format)
1666
class BzrDirFormat5(BzrDirFormat):
1667
"""Bzr control format 5.
1669
This format is a combined format for working tree, branch and repository.
1671
- Format 2 working trees [always]
1672
- Format 4 branches [always]
1673
- Format 5 repositories [always]
1674
Unhashed stores in the repository.
1677
_lock_class = lockable_files.TransportLock
1679
def get_format_string(self):
1680
"""See BzrDirFormat.get_format_string()."""
1681
return "Bazaar-NG branch, format 5\n"
1683
def get_format_description(self):
1684
"""See BzrDirFormat.get_format_description()."""
1685
return "All-in-one format 5"
1687
def get_converter(self, format=None):
1688
"""See BzrDirFormat.get_converter()."""
1689
# there is one and only one upgrade path here.
1690
return ConvertBzrDir5To6()
1692
def _initialize_for_clone(self, url):
1693
return self.initialize_on_transport(get_transport(url), _cloning=True)
1695
def initialize_on_transport(self, transport, _cloning=False):
1696
"""Format 5 dirs always have working tree, branch and repository.
1698
Except when they are being cloned.
1700
from bzrlib.branch import BzrBranchFormat4
1701
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1702
from bzrlib.workingtree import WorkingTreeFormat2
1703
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1704
RepositoryFormat5().initialize(result, _internal=True)
1706
branch = BzrBranchFormat4().initialize(result)
1708
WorkingTreeFormat2().initialize(result)
1709
except errors.NotLocalUrl:
1710
# Even though we can't access the working tree, we need to
1711
# create its control files.
1712
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1715
def _open(self, transport):
1716
"""See BzrDirFormat._open."""
1717
return BzrDir5(transport, self)
1719
def __return_repository_format(self):
1720
"""Circular import protection."""
1721
from bzrlib.repofmt.weaverepo import RepositoryFormat5
1722
return RepositoryFormat5()
1723
repository_format = property(__return_repository_format)
1726
class BzrDirFormat6(BzrDirFormat):
1727
"""Bzr control format 6.
1729
This format is a combined format for working tree, branch and repository.
1731
- Format 2 working trees [always]
1732
- Format 4 branches [always]
1733
- Format 6 repositories [always]
1736
_lock_class = lockable_files.TransportLock
1738
def get_format_string(self):
1739
"""See BzrDirFormat.get_format_string()."""
1740
return "Bazaar-NG branch, format 6\n"
1742
def get_format_description(self):
1743
"""See BzrDirFormat.get_format_description()."""
1744
return "All-in-one format 6"
1746
def get_converter(self, format=None):
1747
"""See BzrDirFormat.get_converter()."""
1748
# there is one and only one upgrade path here.
1749
return ConvertBzrDir6ToMeta()
1751
def _initialize_for_clone(self, url):
1752
return self.initialize_on_transport(get_transport(url), _cloning=True)
1754
def initialize_on_transport(self, transport, _cloning=False):
1755
"""Format 6 dirs always have working tree, branch and repository.
1757
Except when they are being cloned.
1759
from bzrlib.branch import BzrBranchFormat4
1760
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1761
from bzrlib.workingtree import WorkingTreeFormat2
1762
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1763
RepositoryFormat6().initialize(result, _internal=True)
1765
branch = BzrBranchFormat4().initialize(result)
1767
WorkingTreeFormat2().initialize(result)
1768
except errors.NotLocalUrl:
1769
# Even though we can't access the working tree, we need to
1770
# create its control files.
1771
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1774
def _open(self, transport):
1775
"""See BzrDirFormat._open."""
1776
return BzrDir6(transport, self)
1778
def __return_repository_format(self):
1779
"""Circular import protection."""
1780
from bzrlib.repofmt.weaverepo import RepositoryFormat6
1781
return RepositoryFormat6()
1782
repository_format = property(__return_repository_format)
1785
class BzrDirMetaFormat1(BzrDirFormat):
1786
"""Bzr meta control format 1
1788
This is the first format with split out working tree, branch and repository
1791
- Format 3 working trees [optional]
1792
- Format 5 branches [optional]
1793
- Format 7 repositories [optional]
1796
_lock_class = lockdir.LockDir
1799
self._workingtree_format = None
1800
self._branch_format = None
1802
def __eq__(self, other):
1803
if other.__class__ is not self.__class__:
1805
if other.repository_format != self.repository_format:
1807
if other.workingtree_format != self.workingtree_format:
1811
def __ne__(self, other):
1812
return not self == other
1814
def get_branch_format(self):
1815
if self._branch_format is None:
1816
from bzrlib.branch import BranchFormat
1817
self._branch_format = BranchFormat.get_default_format()
1818
return self._branch_format
1820
def set_branch_format(self, format):
1821
self._branch_format = format
1823
def get_converter(self, format=None):
1824
"""See BzrDirFormat.get_converter()."""
1826
format = BzrDirFormat.get_default_format()
1827
if not isinstance(self, format.__class__):
1828
# converting away from metadir is not implemented
1829
raise NotImplementedError(self.get_converter)
1830
return ConvertMetaToMeta(format)
1832
def get_format_string(self):
1833
"""See BzrDirFormat.get_format_string()."""
1834
return "Bazaar-NG meta directory, format 1\n"
1836
def get_format_description(self):
1837
"""See BzrDirFormat.get_format_description()."""
1838
return "Meta directory format 1"
1840
def _open(self, transport):
1841
"""See BzrDirFormat._open."""
1842
return BzrDirMeta1(transport, self)
1844
def __return_repository_format(self):
1845
"""Circular import protection."""
1846
if getattr(self, '_repository_format', None):
1847
return self._repository_format
1848
from bzrlib.repository import RepositoryFormat
1849
return RepositoryFormat.get_default_format()
1851
def __set_repository_format(self, value):
1852
"""Allow changing the repository format for metadir formats."""
1853
self._repository_format = value
1855
repository_format = property(__return_repository_format, __set_repository_format)
1857
def __get_workingtree_format(self):
1858
if self._workingtree_format is None:
1859
from bzrlib.workingtree import WorkingTreeFormat
1860
self._workingtree_format = WorkingTreeFormat.get_default_format()
1861
return self._workingtree_format
1863
def __set_workingtree_format(self, wt_format):
1864
self._workingtree_format = wt_format
1866
workingtree_format = property(__get_workingtree_format,
1867
__set_workingtree_format)
1870
# Register bzr control format
1871
BzrDirFormat.register_control_format(BzrDirFormat)
1873
# Register bzr formats
1874
BzrDirFormat.register_format(BzrDirFormat4())
1875
BzrDirFormat.register_format(BzrDirFormat5())
1876
BzrDirFormat.register_format(BzrDirFormat6())
1877
__default_format = BzrDirMetaFormat1()
1878
BzrDirFormat.register_format(__default_format)
1879
BzrDirFormat._default_format = __default_format
1882
class Converter(object):
1883
"""Converts a disk format object from one format to another."""
1885
def convert(self, to_convert, pb):
1886
"""Perform the conversion of to_convert, giving feedback via pb.
1888
:param to_convert: The disk object to convert.
1889
:param pb: a progress bar to use for progress information.
1892
def step(self, message):
1893
"""Update the pb by a step."""
1895
self.pb.update(message, self.count, self.total)
1898
class ConvertBzrDir4To5(Converter):
1899
"""Converts format 4 bzr dirs to format 5."""
1902
super(ConvertBzrDir4To5, self).__init__()
1903
self.converted_revs = set()
1904
self.absent_revisions = set()
1908
def convert(self, to_convert, pb):
1909
"""See Converter.convert()."""
1910
self.bzrdir = to_convert
1912
self.pb.note('starting upgrade from format 4 to 5')
1913
if isinstance(self.bzrdir.transport, LocalTransport):
1914
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
1915
self._convert_to_weaves()
1916
return BzrDir.open(self.bzrdir.root_transport.base)
1918
def _convert_to_weaves(self):
1919
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
1922
stat = self.bzrdir.transport.stat('weaves')
1923
if not S_ISDIR(stat.st_mode):
1924
self.bzrdir.transport.delete('weaves')
1925
self.bzrdir.transport.mkdir('weaves')
1926
except errors.NoSuchFile:
1927
self.bzrdir.transport.mkdir('weaves')
1928
# deliberately not a WeaveFile as we want to build it up slowly.
1929
self.inv_weave = Weave('inventory')
1930
# holds in-memory weaves for all files
1931
self.text_weaves = {}
1932
self.bzrdir.transport.delete('branch-format')
1933
self.branch = self.bzrdir.open_branch()
1934
self._convert_working_inv()
1935
rev_history = self.branch.revision_history()
1936
# to_read is a stack holding the revisions we still need to process;
1937
# appending to it adds new highest-priority revisions
1938
self.known_revisions = set(rev_history)
1939
self.to_read = rev_history[-1:]
1941
rev_id = self.to_read.pop()
1942
if (rev_id not in self.revisions
1943
and rev_id not in self.absent_revisions):
1944
self._load_one_rev(rev_id)
1946
to_import = self._make_order()
1947
for i, rev_id in enumerate(to_import):
1948
self.pb.update('converting revision', i, len(to_import))
1949
self._convert_one_rev(rev_id)
1951
self._write_all_weaves()
1952
self._write_all_revs()
1953
self.pb.note('upgraded to weaves:')
1954
self.pb.note(' %6d revisions and inventories', len(self.revisions))
1955
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
1956
self.pb.note(' %6d texts', self.text_count)
1957
self._cleanup_spare_files_after_format4()
1958
self.branch.control_files.put_utf8('branch-format', BzrDirFormat5().get_format_string())
1960
def _cleanup_spare_files_after_format4(self):
1961
# FIXME working tree upgrade foo.
1962
for n in 'merged-patches', 'pending-merged-patches':
1964
## assert os.path.getsize(p) == 0
1965
self.bzrdir.transport.delete(n)
1966
except errors.NoSuchFile:
1968
self.bzrdir.transport.delete_tree('inventory-store')
1969
self.bzrdir.transport.delete_tree('text-store')
1971
def _convert_working_inv(self):
1972
inv = xml4.serializer_v4.read_inventory(
1973
self.branch.control_files.get('inventory'))
1974
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv, working=True)
1975
# FIXME inventory is a working tree change.
1976
self.branch.control_files.put('inventory', StringIO(new_inv_xml))
1978
def _write_all_weaves(self):
1979
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
1980
weave_transport = self.bzrdir.transport.clone('weaves')
1981
weaves = WeaveStore(weave_transport, prefixed=False)
1982
transaction = WriteTransaction()
1986
for file_id, file_weave in self.text_weaves.items():
1987
self.pb.update('writing weave', i, len(self.text_weaves))
1988
weaves._put_weave(file_id, file_weave, transaction)
1990
self.pb.update('inventory', 0, 1)
1991
controlweaves._put_weave('inventory', self.inv_weave, transaction)
1992
self.pb.update('inventory', 1, 1)
1996
def _write_all_revs(self):
1997
"""Write all revisions out in new form."""
1998
self.bzrdir.transport.delete_tree('revision-store')
1999
self.bzrdir.transport.mkdir('revision-store')
2000
revision_transport = self.bzrdir.transport.clone('revision-store')
2002
_revision_store = TextRevisionStore(TextStore(revision_transport,
2006
transaction = WriteTransaction()
2007
for i, rev_id in enumerate(self.converted_revs):
2008
self.pb.update('write revision', i, len(self.converted_revs))
2009
_revision_store.add_revision(self.revisions[rev_id], transaction)
2013
def _load_one_rev(self, rev_id):
2014
"""Load a revision object into memory.
2016
Any parents not either loaded or abandoned get queued to be
2018
self.pb.update('loading revision',
2019
len(self.revisions),
2020
len(self.known_revisions))
2021
if not self.branch.repository.has_revision(rev_id):
2023
self.pb.note('revision {%s} not present in branch; '
2024
'will be converted as a ghost',
2026
self.absent_revisions.add(rev_id)
2028
rev = self.branch.repository._revision_store.get_revision(rev_id,
2029
self.branch.repository.get_transaction())
2030
for parent_id in rev.parent_ids:
2031
self.known_revisions.add(parent_id)
2032
self.to_read.append(parent_id)
2033
self.revisions[rev_id] = rev
2035
def _load_old_inventory(self, rev_id):
2036
assert rev_id not in self.converted_revs
2037
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
2038
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
2039
inv.revision_id = rev_id
2040
rev = self.revisions[rev_id]
2041
if rev.inventory_sha1:
2042
assert rev.inventory_sha1 == sha_string(old_inv_xml), \
2043
'inventory sha mismatch for {%s}' % rev_id
2046
def _load_updated_inventory(self, rev_id):
2047
assert rev_id in self.converted_revs
2048
inv_xml = self.inv_weave.get_text(rev_id)
2049
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml, rev_id)
2052
def _convert_one_rev(self, rev_id):
2053
"""Convert revision and all referenced objects to new format."""
2054
rev = self.revisions[rev_id]
2055
inv = self._load_old_inventory(rev_id)
2056
present_parents = [p for p in rev.parent_ids
2057
if p not in self.absent_revisions]
2058
self._convert_revision_contents(rev, inv, present_parents)
2059
self._store_new_inv(rev, inv, present_parents)
2060
self.converted_revs.add(rev_id)
2062
def _store_new_inv(self, rev, inv, present_parents):
2063
# the XML is now updated with text versions
2065
entries = inv.iter_entries()
2067
for path, ie in entries:
2068
assert getattr(ie, 'revision', None) is not None, \
2069
'no revision on {%s} in {%s}' % \
2070
(file_id, rev.revision_id)
2071
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
2072
new_inv_sha1 = sha_string(new_inv_xml)
2073
self.inv_weave.add_lines(rev.revision_id,
2075
new_inv_xml.splitlines(True))
2076
rev.inventory_sha1 = new_inv_sha1
2078
def _convert_revision_contents(self, rev, inv, present_parents):
2079
"""Convert all the files within a revision.
2081
Also upgrade the inventory to refer to the text revision ids."""
2082
rev_id = rev.revision_id
2083
mutter('converting texts of revision {%s}',
2085
parent_invs = map(self._load_updated_inventory, present_parents)
2086
entries = inv.iter_entries()
2088
for path, ie in entries:
2089
self._convert_file_version(rev, ie, parent_invs)
2091
def _convert_file_version(self, rev, ie, parent_invs):
2092
"""Convert one version of one file.
2094
The file needs to be added into the weave if it is a merge
2095
of >=2 parents or if it's changed from its parent.
2097
file_id = ie.file_id
2098
rev_id = rev.revision_id
2099
w = self.text_weaves.get(file_id)
2102
self.text_weaves[file_id] = w
2103
text_changed = False
2104
parent_candiate_entries = ie.parent_candidates(parent_invs)
2105
for old_revision in parent_candiate_entries.keys():
2106
# if this fails, its a ghost ?
2107
assert old_revision in self.converted_revs, \
2108
"Revision {%s} not in converted_revs" % old_revision
2109
heads = graph.Graph(self).heads(parent_candiate_entries.keys())
2110
# XXX: Note that this is unordered - and this is tolerable because
2111
# the previous code was also unordered.
2112
previous_entries = dict((head, parent_candiate_entries[head]) for head
2114
self.snapshot_ie(previous_entries, ie, w, rev_id)
2116
assert getattr(ie, 'revision', None) is not None
2118
@symbol_versioning.deprecated_method(symbol_versioning.one_one)
2119
def get_parents(self, revision_ids):
2120
for revision_id in revision_ids:
2121
yield self.revisions[revision_id].parent_ids
2123
def get_parent_map(self, revision_ids):
2124
"""See graph._StackedParentsProvider.get_parent_map"""
2125
return dict((revision_id, self.revisions[revision_id])
2126
for revision_id in revision_ids
2127
if revision_id in self.revisions)
2129
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
2130
# TODO: convert this logic, which is ~= snapshot to
2131
# a call to:. This needs the path figured out. rather than a work_tree
2132
# a v4 revision_tree can be given, or something that looks enough like
2133
# one to give the file content to the entry if it needs it.
2134
# and we need something that looks like a weave store for snapshot to
2136
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
2137
if len(previous_revisions) == 1:
2138
previous_ie = previous_revisions.values()[0]
2139
if ie._unchanged(previous_ie):
2140
ie.revision = previous_ie.revision
2143
text = self.branch.repository.weave_store.get(ie.text_id)
2144
file_lines = text.readlines()
2145
assert sha_strings(file_lines) == ie.text_sha1
2146
assert sum(map(len, file_lines)) == ie.text_size
2147
w.add_lines(rev_id, previous_revisions, file_lines)
2148
self.text_count += 1
2150
w.add_lines(rev_id, previous_revisions, [])
2151
ie.revision = rev_id
2153
def _make_order(self):
2154
"""Return a suitable order for importing revisions.
2156
The order must be such that an revision is imported after all
2157
its (present) parents.
2159
todo = set(self.revisions.keys())
2160
done = self.absent_revisions.copy()
2163
# scan through looking for a revision whose parents
2165
for rev_id in sorted(list(todo)):
2166
rev = self.revisions[rev_id]
2167
parent_ids = set(rev.parent_ids)
2168
if parent_ids.issubset(done):
2169
# can take this one now
2170
order.append(rev_id)
2176
class ConvertBzrDir5To6(Converter):
2177
"""Converts format 5 bzr dirs to format 6."""
2179
def convert(self, to_convert, pb):
2180
"""See Converter.convert()."""
2181
self.bzrdir = to_convert
2183
self.pb.note('starting upgrade from format 5 to 6')
2184
self._convert_to_prefixed()
2185
return BzrDir.open(self.bzrdir.root_transport.base)
2187
def _convert_to_prefixed(self):
2188
from bzrlib.store import TransportStore
2189
self.bzrdir.transport.delete('branch-format')
2190
for store_name in ["weaves", "revision-store"]:
2191
self.pb.note("adding prefixes to %s" % store_name)
2192
store_transport = self.bzrdir.transport.clone(store_name)
2193
store = TransportStore(store_transport, prefixed=True)
2194
for urlfilename in store_transport.list_dir('.'):
2195
filename = urlutils.unescape(urlfilename)
2196
if (filename.endswith(".weave") or
2197
filename.endswith(".gz") or
2198
filename.endswith(".sig")):
2199
file_id = os.path.splitext(filename)[0]
2202
prefix_dir = store.hash_prefix(file_id)
2203
# FIXME keep track of the dirs made RBC 20060121
2205
store_transport.move(filename, prefix_dir + '/' + filename)
2206
except errors.NoSuchFile: # catches missing dirs strangely enough
2207
store_transport.mkdir(prefix_dir)
2208
store_transport.move(filename, prefix_dir + '/' + filename)
2209
self.bzrdir._control_files.put_utf8('branch-format', BzrDirFormat6().get_format_string())
2212
class ConvertBzrDir6ToMeta(Converter):
2213
"""Converts format 6 bzr dirs to metadirs."""
2215
def convert(self, to_convert, pb):
2216
"""See Converter.convert()."""
2217
from bzrlib.repofmt.weaverepo import RepositoryFormat7
2218
from bzrlib.branch import BzrBranchFormat5
2219
self.bzrdir = to_convert
2222
self.total = 20 # the steps we know about
2223
self.garbage_inventories = []
2225
self.pb.note('starting upgrade from format 6 to metadir')
2226
self.bzrdir._control_files.put_utf8('branch-format', "Converting to format 6")
2227
# its faster to move specific files around than to open and use the apis...
2228
# first off, nuke ancestry.weave, it was never used.
2230
self.step('Removing ancestry.weave')
2231
self.bzrdir.transport.delete('ancestry.weave')
2232
except errors.NoSuchFile:
2234
# find out whats there
2235
self.step('Finding branch files')
2236
last_revision = self.bzrdir.open_branch().last_revision()
2237
bzrcontents = self.bzrdir.transport.list_dir('.')
2238
for name in bzrcontents:
2239
if name.startswith('basis-inventory.'):
2240
self.garbage_inventories.append(name)
2241
# create new directories for repository, working tree and branch
2242
self.dir_mode = self.bzrdir._control_files._dir_mode
2243
self.file_mode = self.bzrdir._control_files._file_mode
2244
repository_names = [('inventory.weave', True),
2245
('revision-store', True),
2247
self.step('Upgrading repository ')
2248
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
2249
self.make_lock('repository')
2250
# we hard code the formats here because we are converting into
2251
# the meta format. The meta format upgrader can take this to a
2252
# future format within each component.
2253
self.put_format('repository', RepositoryFormat7())
2254
for entry in repository_names:
2255
self.move_entry('repository', entry)
2257
self.step('Upgrading branch ')
2258
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
2259
self.make_lock('branch')
2260
self.put_format('branch', BzrBranchFormat5())
2261
branch_files = [('revision-history', True),
2262
('branch-name', True),
2264
for entry in branch_files:
2265
self.move_entry('branch', entry)
2267
checkout_files = [('pending-merges', True),
2268
('inventory', True),
2269
('stat-cache', False)]
2270
# If a mandatory checkout file is not present, the branch does not have
2271
# a functional checkout. Do not create a checkout in the converted
2273
for name, mandatory in checkout_files:
2274
if mandatory and name not in bzrcontents:
2275
has_checkout = False
2279
if not has_checkout:
2280
self.pb.note('No working tree.')
2281
# If some checkout files are there, we may as well get rid of them.
2282
for name, mandatory in checkout_files:
2283
if name in bzrcontents:
2284
self.bzrdir.transport.delete(name)
2286
from bzrlib.workingtree import WorkingTreeFormat3
2287
self.step('Upgrading working tree')
2288
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
2289
self.make_lock('checkout')
2291
'checkout', WorkingTreeFormat3())
2292
self.bzrdir.transport.delete_multi(
2293
self.garbage_inventories, self.pb)
2294
for entry in checkout_files:
2295
self.move_entry('checkout', entry)
2296
if last_revision is not None:
2297
self.bzrdir._control_files.put_utf8(
2298
'checkout/last-revision', last_revision)
2299
self.bzrdir._control_files.put_utf8(
2300
'branch-format', BzrDirMetaFormat1().get_format_string())
2301
return BzrDir.open(self.bzrdir.root_transport.base)
2303
def make_lock(self, name):
2304
"""Make a lock for the new control dir name."""
2305
self.step('Make %s lock' % name)
2306
ld = lockdir.LockDir(self.bzrdir.transport,
2308
file_modebits=self.file_mode,
2309
dir_modebits=self.dir_mode)
2312
def move_entry(self, new_dir, entry):
2313
"""Move then entry name into new_dir."""
2315
mandatory = entry[1]
2316
self.step('Moving %s' % name)
2318
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
2319
except errors.NoSuchFile:
2323
def put_format(self, dirname, format):
2324
self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
2327
class ConvertMetaToMeta(Converter):
2328
"""Converts the components of metadirs."""
2330
def __init__(self, target_format):
2331
"""Create a metadir to metadir converter.
2333
:param target_format: The final metadir format that is desired.
2335
self.target_format = target_format
2337
def convert(self, to_convert, pb):
2338
"""See Converter.convert()."""
2339
self.bzrdir = to_convert
2343
self.step('checking repository format')
2345
repo = self.bzrdir.open_repository()
2346
except errors.NoRepositoryPresent:
2349
if not isinstance(repo._format, self.target_format.repository_format.__class__):
2350
from bzrlib.repository import CopyConverter
2351
self.pb.note('starting repository conversion')
2352
converter = CopyConverter(self.target_format.repository_format)
2353
converter.convert(repo, pb)
2355
branch = self.bzrdir.open_branch()
2356
except errors.NotBranchError:
2359
# TODO: conversions of Branch and Tree should be done by
2360
# InterXFormat lookups
2361
# Avoid circular imports
2362
from bzrlib import branch as _mod_branch
2363
if (branch._format.__class__ is _mod_branch.BzrBranchFormat5 and
2364
self.target_format.get_branch_format().__class__ is
2365
_mod_branch.BzrBranchFormat6):
2366
branch_converter = _mod_branch.Converter5to6()
2367
branch_converter.convert(branch)
2369
tree = self.bzrdir.open_workingtree(recommend_upgrade=False)
2370
except (errors.NoWorkingTree, errors.NotLocalUrl):
2373
# TODO: conversions of Branch and Tree should be done by
2374
# InterXFormat lookups
2375
if (isinstance(tree, workingtree.WorkingTree3) and
2376
not isinstance(tree, workingtree_4.WorkingTree4) and
2377
isinstance(self.target_format.workingtree_format,
2378
workingtree_4.WorkingTreeFormat4)):
2379
workingtree_4.Converter3to4().convert(tree)
2383
# This is not in remote.py because it's small, and needs to be registered.
2384
# Putting it in remote.py creates a circular import problem.
2385
# we can make it a lazy object if the control formats is turned into something
2387
class RemoteBzrDirFormat(BzrDirMetaFormat1):
2388
"""Format representing bzrdirs accessed via a smart server"""
2390
def get_format_description(self):
2391
return 'bzr remote bzrdir'
2394
def probe_transport(klass, transport):
2395
"""Return a RemoteBzrDirFormat object if it looks possible."""
2397
client = transport.get_smart_client()
2398
except (NotImplementedError, AttributeError,
2399
errors.TransportNotPossible):
2400
# no smart server, so not a branch for this format type.
2401
raise errors.NotBranchError(path=transport.base)
2403
# Send a 'hello' request in protocol version one, and decline to
2404
# open it if the server doesn't support our required version (2) so
2405
# that the VFS-based transport will do it.
2406
request = client.get_request()
2407
smart_protocol = protocol.SmartClientRequestProtocolOne(request)
2408
server_version = smart_protocol.query_version()
2409
if server_version != 2:
2410
raise errors.NotBranchError(path=transport.base)
2413
def initialize_on_transport(self, transport):
2415
# hand off the request to the smart server
2416
shared_medium = transport.get_shared_medium()
2417
except errors.NoSmartMedium:
2418
# TODO: lookup the local format from a server hint.
2419
local_dir_format = BzrDirMetaFormat1()
2420
return local_dir_format.initialize_on_transport(transport)
2421
client = _SmartClient(shared_medium)
2422
path = client.remote_path_from_transport(transport)
2423
response = _SmartClient(shared_medium).call('BzrDirFormat.initialize',
2425
assert response[0] in ('ok', ), 'unexpected response code %s' % (response,)
2426
return remote.RemoteBzrDir(transport)
2428
def _open(self, transport):
2429
return remote.RemoteBzrDir(transport)
2431
def __eq__(self, other):
2432
if not isinstance(other, RemoteBzrDirFormat):
2434
return self.get_format_description() == other.get_format_description()
2437
BzrDirFormat.register_control_server_format(RemoteBzrDirFormat)
2440
class BzrDirFormatInfo(object):
2442
def __init__(self, native, deprecated, hidden, experimental):
2443
self.deprecated = deprecated
2444
self.native = native
2445
self.hidden = hidden
2446
self.experimental = experimental
2449
class BzrDirFormatRegistry(registry.Registry):
2450
"""Registry of user-selectable BzrDir subformats.
2452
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
2453
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
2457
"""Create a BzrDirFormatRegistry."""
2458
self._aliases = set()
2459
super(BzrDirFormatRegistry, self).__init__()
2462
"""Return a set of the format names which are aliases."""
2463
return frozenset(self._aliases)
2465
def register_metadir(self, key,
2466
repository_format, help, native=True, deprecated=False,
2472
"""Register a metadir subformat.
2474
These all use a BzrDirMetaFormat1 bzrdir, but can be parameterized
2475
by the Repository format.
2477
:param repository_format: The fully-qualified repository format class
2479
:param branch_format: Fully-qualified branch format class name as
2481
:param tree_format: Fully-qualified tree format class name as
2484
# This should be expanded to support setting WorkingTree and Branch
2485
# formats, once BzrDirMetaFormat1 supports that.
2486
def _load(full_name):
2487
mod_name, factory_name = full_name.rsplit('.', 1)
2489
mod = __import__(mod_name, globals(), locals(),
2491
except ImportError, e:
2492
raise ImportError('failed to load %s: %s' % (full_name, e))
2494
factory = getattr(mod, factory_name)
2495
except AttributeError:
2496
raise AttributeError('no factory %s in module %r'
2501
bd = BzrDirMetaFormat1()
2502
if branch_format is not None:
2503
bd.set_branch_format(_load(branch_format))
2504
if tree_format is not None:
2505
bd.workingtree_format = _load(tree_format)
2506
if repository_format is not None:
2507
bd.repository_format = _load(repository_format)
2509
self.register(key, helper, help, native, deprecated, hidden,
2510
experimental, alias)
2512
def register(self, key, factory, help, native=True, deprecated=False,
2513
hidden=False, experimental=False, alias=False):
2514
"""Register a BzrDirFormat factory.
2516
The factory must be a callable that takes one parameter: the key.
2517
It must produce an instance of the BzrDirFormat when called.
2519
This function mainly exists to prevent the info object from being
2522
registry.Registry.register(self, key, factory, help,
2523
BzrDirFormatInfo(native, deprecated, hidden, experimental))
2525
self._aliases.add(key)
2527
def register_lazy(self, key, module_name, member_name, help, native=True,
2528
deprecated=False, hidden=False, experimental=False, alias=False):
2529
registry.Registry.register_lazy(self, key, module_name, member_name,
2530
help, BzrDirFormatInfo(native, deprecated, hidden, experimental))
2532
self._aliases.add(key)
2534
def set_default(self, key):
2535
"""Set the 'default' key to be a clone of the supplied key.
2537
This method must be called once and only once.
2539
registry.Registry.register(self, 'default', self.get(key),
2540
self.get_help(key), info=self.get_info(key))
2541
self._aliases.add('default')
2543
def set_default_repository(self, key):
2544
"""Set the FormatRegistry default and Repository default.
2546
This is a transitional method while Repository.set_default_format
2549
if 'default' in self:
2550
self.remove('default')
2551
self.set_default(key)
2552
format = self.get('default')()
2553
assert isinstance(format, BzrDirMetaFormat1)
2555
def make_bzrdir(self, key):
2556
return self.get(key)()
2558
def help_topic(self, topic):
2559
output = textwrap.dedent("""\
2560
These formats can be used for creating branches, working trees, and
2564
default_realkey = None
2565
default_help = self.get_help('default')
2567
for key in self.keys():
2568
if key == 'default':
2570
help = self.get_help(key)
2571
if help == default_help:
2572
default_realkey = key
2574
help_pairs.append((key, help))
2576
def wrapped(key, help, info):
2578
help = '(native) ' + help
2579
return ':%s:\n%s\n\n' % (key,
2580
textwrap.fill(help, initial_indent=' ',
2581
subsequent_indent=' '))
2582
if default_realkey is not None:
2583
output += wrapped(default_realkey, '(default) %s' % default_help,
2584
self.get_info('default'))
2585
deprecated_pairs = []
2586
experimental_pairs = []
2587
for key, help in help_pairs:
2588
info = self.get_info(key)
2591
elif info.deprecated:
2592
deprecated_pairs.append((key, help))
2593
elif info.experimental:
2594
experimental_pairs.append((key, help))
2596
output += wrapped(key, help, info)
2597
if len(experimental_pairs) > 0:
2598
output += "Experimental formats are shown below.\n\n"
2599
for key, help in experimental_pairs:
2600
info = self.get_info(key)
2601
output += wrapped(key, help, info)
2602
if len(deprecated_pairs) > 0:
2603
output += "Deprecated formats are shown below.\n\n"
2604
for key, help in deprecated_pairs:
2605
info = self.get_info(key)
2606
output += wrapped(key, help, info)
2611
format_registry = BzrDirFormatRegistry()
2612
format_registry.register('weave', BzrDirFormat6,
2613
'Pre-0.8 format. Slower than knit and does not'
2614
' support checkouts or shared repositories.',
2616
format_registry.register_metadir('knit',
2617
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2618
'Format using knits. Recommended for interoperation with bzr <= 0.14.',
2619
branch_format='bzrlib.branch.BzrBranchFormat5',
2620
tree_format='bzrlib.workingtree.WorkingTreeFormat3')
2621
format_registry.register_metadir('metaweave',
2622
'bzrlib.repofmt.weaverepo.RepositoryFormat7',
2623
'Transitional format in 0.8. Slower than knit.',
2624
branch_format='bzrlib.branch.BzrBranchFormat5',
2625
tree_format='bzrlib.workingtree.WorkingTreeFormat3',
2627
format_registry.register_metadir('dirstate',
2628
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2629
help='New in 0.15: Fast local operations. Compatible with bzr 0.8 and '
2630
'above when accessed over the network.',
2631
branch_format='bzrlib.branch.BzrBranchFormat5',
2632
# this uses bzrlib.workingtree.WorkingTreeFormat4 because importing
2633
# directly from workingtree_4 triggers a circular import.
2634
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2636
format_registry.register_metadir('dirstate-tags',
2637
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit1',
2638
help='New in 0.15: Fast local operations and improved scaling for '
2639
'network operations. Additionally adds support for tags.'
2640
' Incompatible with bzr < 0.15.',
2641
branch_format='bzrlib.branch.BzrBranchFormat6',
2642
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2644
format_registry.register_metadir('rich-root',
2645
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit4',
2646
help='New in 1.0. Better handling of tree roots. Incompatible with'
2648
branch_format='bzrlib.branch.BzrBranchFormat6',
2649
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2651
format_registry.register_metadir('dirstate-with-subtree',
2652
'bzrlib.repofmt.knitrepo.RepositoryFormatKnit3',
2653
help='New in 0.15: Fast local operations and improved scaling for '
2654
'network operations. Additionally adds support for versioning nested '
2655
'bzr branches. Incompatible with bzr < 0.15.',
2656
branch_format='bzrlib.branch.BzrBranchFormat6',
2657
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2661
format_registry.register_metadir('pack-0.92',
2662
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack1',
2663
help='New in 0.92: Pack-based format with data compatible with '
2664
'dirstate-tags format repositories. Interoperates with '
2665
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2666
'Previously called knitpack-experimental. '
2667
'For more information, see '
2668
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2669
branch_format='bzrlib.branch.BzrBranchFormat6',
2670
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2672
format_registry.register_metadir('pack-0.92-subtree',
2673
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack3',
2674
help='New in 0.92: Pack-based format with data compatible with '
2675
'dirstate-with-subtree format repositories. Interoperates with '
2676
'bzr repositories before 0.92 but cannot be read by bzr < 0.92. '
2677
'Previously called knitpack-experimental. '
2678
'For more information, see '
2679
'http://doc.bazaar-vcs.org/latest/developers/packrepo.html.',
2680
branch_format='bzrlib.branch.BzrBranchFormat6',
2681
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2685
format_registry.register_metadir('rich-root-pack',
2686
'bzrlib.repofmt.pack_repo.RepositoryFormatKnitPack4',
2687
help='New in 1.0: Pack-based format with data compatible with '
2688
'rich-root format repositories. Incompatible with'
2690
branch_format='bzrlib.branch.BzrBranchFormat6',
2691
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2693
# The following two formats should always just be aliases.
2694
format_registry.register_metadir('development',
2695
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
2696
help='Current development format. Can convert data to and from pack-0.92 '
2697
'(and anything compatible with pack-0.92) format repositories. '
2698
'Repositories in this format can only be read by bzr.dev. '
2700
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2702
branch_format='bzrlib.branch.BzrBranchFormat6',
2703
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2707
format_registry.register_metadir('development-subtree',
2708
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
2709
help='Current development format, subtree variant. Can convert data to and '
2710
'from pack-0.92 (and anything compatible with pack-0.92) format '
2711
'repositories. Repositories in this format can only be read by '
2712
'bzr.dev. Please read '
2713
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2715
branch_format='bzrlib.branch.BzrBranchFormat6',
2716
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2720
# And the development formats which the will have aliased one of follow:
2721
format_registry.register_metadir('development0',
2722
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0',
2723
help='Trivial rename of pack-0.92 to provide a development format. '
2725
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2727
branch_format='bzrlib.branch.BzrBranchFormat6',
2728
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2732
format_registry.register_metadir('development0-subtree',
2733
'bzrlib.repofmt.pack_repo.RepositoryFormatPackDevelopment0Subtree',
2734
help='Trivial rename of pack-0.92-subtree to provide a development format. '
2736
'http://doc.bazaar-vcs.org/latest/developers/development-repo.html '
2738
branch_format='bzrlib.branch.BzrBranchFormat6',
2739
tree_format='bzrlib.workingtree.WorkingTreeFormat4',
2743
format_registry.set_default('pack-0.92')
added
removed
bzrlib/bzrdir.py
