1
# Copyright (C) 2005, 2006 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
23
# TODO: remove unittest dependency; put that stuff inside the test suite
25
# TODO: The Format probe_transport seems a bit redundant with just trying to
26
# open the bzrdir. -- mbp
28
# TODO: Can we move specific formats into separate modules to make this file
31
from cStringIO import StringIO
35
from bzrlib.lazy_import import lazy_import
36
lazy_import(globals(), """
37
from copy import deepcopy
38
from stat import S_ISDIR
47
revision as _mod_revision,
48
repository as _mod_repository,
54
from bzrlib.osutils import (
59
from bzrlib.store.revision.text import TextRevisionStore
60
from bzrlib.store.text import TextStore
61
from bzrlib.store.versioned import WeaveStore
62
from bzrlib.transactions import WriteTransaction
63
from bzrlib.transport import get_transport
64
from bzrlib.weave import Weave
67
from bzrlib.trace import mutter
68
from bzrlib.transport.local import LocalTransport
72
"""A .bzr control diretory.
74
BzrDir instances let you create or open any of the things that can be
75
found within .bzr - checkouts, branches and repositories.
78
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
80
a transport connected to the directory this bzr was opened from.
84
"""Invoke break_lock on the first object in the bzrdir.
86
If there is a tree, the tree is opened and break_lock() called.
87
Otherwise, branch is tried, and finally repository.
90
thing_to_unlock = self.open_workingtree()
91
except (errors.NotLocalUrl, errors.NoWorkingTree):
93
thing_to_unlock = self.open_branch()
94
except errors.NotBranchError:
96
thing_to_unlock = self.open_repository()
97
except errors.NoRepositoryPresent:
99
thing_to_unlock.break_lock()
101
def can_convert_format(self):
102
"""Return true if this bzrdir is one whose format we can convert from."""
105
def check_conversion_target(self, target_format):
106
target_repo_format = target_format.repository_format
107
source_repo_format = self._format.repository_format
108
source_repo_format.check_conversion_target(target_repo_format)
111
def _check_supported(format, allow_unsupported):
112
"""Check whether format is a supported format.
114
If allow_unsupported is True, this is a no-op.
116
if not allow_unsupported and not format.is_supported():
117
# see open_downlevel to open legacy branches.
118
raise errors.UnsupportedFormatError(format=format)
120
def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
121
"""Clone this bzrdir and its contents to url verbatim.
123
If urls last component does not exist, it will be created.
125
if revision_id is not None, then the clone operation may tune
126
itself to download less data.
127
:param force_new_repo: Do not use a shared repository for the target
128
even if one is available.
131
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
132
result = self._format.initialize(url)
134
local_repo = self.find_repository()
135
except errors.NoRepositoryPresent:
138
# may need to copy content in
140
result_repo = local_repo.clone(
142
revision_id=revision_id,
144
result_repo.set_make_working_trees(local_repo.make_working_trees())
147
result_repo = result.find_repository()
148
# fetch content this dir needs.
150
# XXX FIXME RBC 20060214 need tests for this when the basis
152
result_repo.fetch(basis_repo, revision_id=revision_id)
153
result_repo.fetch(local_repo, revision_id=revision_id)
154
except errors.NoRepositoryPresent:
155
# needed to make one anyway.
156
result_repo = local_repo.clone(
158
revision_id=revision_id,
160
result_repo.set_make_working_trees(local_repo.make_working_trees())
161
# 1 if there is a branch present
162
# make sure its content is available in the target repository
165
self.open_branch().clone(result, revision_id=revision_id)
166
except errors.NotBranchError:
169
self.open_workingtree().clone(result, basis=basis_tree)
170
except (errors.NoWorkingTree, errors.NotLocalUrl):
174
def _get_basis_components(self, basis):
175
"""Retrieve the basis components that are available at basis."""
177
return None, None, None
179
basis_tree = basis.open_workingtree()
180
basis_branch = basis_tree.branch
181
basis_repo = basis_branch.repository
182
except (errors.NoWorkingTree, errors.NotLocalUrl):
185
basis_branch = basis.open_branch()
186
basis_repo = basis_branch.repository
187
except errors.NotBranchError:
190
basis_repo = basis.open_repository()
191
except errors.NoRepositoryPresent:
193
return basis_repo, basis_branch, basis_tree
195
# TODO: This should be given a Transport, and should chdir up; otherwise
196
# this will open a new connection.
197
def _make_tail(self, url):
198
head, tail = urlutils.split(url)
199
if tail and tail != '.':
200
t = get_transport(head)
203
except errors.FileExists:
206
# TODO: Should take a Transport
208
def create(cls, base, format=None):
209
"""Create a new BzrDir at the url 'base'.
211
This will call the current default formats initialize with base
212
as the only parameter.
214
:param format: If supplied, the format of branch to create. If not
215
supplied, the default is used.
217
if cls is not BzrDir:
218
raise AssertionError("BzrDir.create always creates the default"
219
" format, not one of %r" % cls)
220
head, tail = urlutils.split(base)
221
if tail and tail != '.':
222
t = get_transport(head)
225
except errors.FileExists:
228
format = BzrDirFormat.get_default_format()
229
return format.initialize(safe_unicode(base))
231
def create_branch(self):
232
"""Create a branch in this BzrDir.
234
The bzrdirs format will control what branch format is created.
235
For more control see BranchFormatXX.create(a_bzrdir).
237
raise NotImplementedError(self.create_branch)
240
def create_branch_and_repo(base, force_new_repo=False, format=None):
241
"""Create a new BzrDir, Branch and Repository at the url 'base'.
243
This will use the current default BzrDirFormat, and use whatever
244
repository format that that uses via bzrdir.create_branch and
245
create_repository. If a shared repository is available that is used
248
The created Branch object is returned.
250
:param base: The URL to create the branch at.
251
:param force_new_repo: If True a new repository is always created.
253
bzrdir = BzrDir.create(base, format)
254
bzrdir._find_or_create_repository(force_new_repo)
255
return bzrdir.create_branch()
257
def _find_or_create_repository(self, force_new_repo):
258
"""Create a new repository if needed, returning the repository."""
260
return self.create_repository()
262
return self.find_repository()
263
except errors.NoRepositoryPresent:
264
return self.create_repository()
267
def create_branch_convenience(base, force_new_repo=False,
268
force_new_tree=None, format=None):
269
"""Create a new BzrDir, Branch and Repository at the url 'base'.
271
This is a convenience function - it will use an existing repository
272
if possible, can be told explicitly whether to create a working tree or
275
This will use the current default BzrDirFormat, and use whatever
276
repository format that that uses via bzrdir.create_branch and
277
create_repository. If a shared repository is available that is used
278
preferentially. Whatever repository is used, its tree creation policy
281
The created Branch object is returned.
282
If a working tree cannot be made due to base not being a file:// url,
283
no error is raised unless force_new_tree is True, in which case no
284
data is created on disk and NotLocalUrl is raised.
286
:param base: The URL to create the branch at.
287
:param force_new_repo: If True a new repository is always created.
288
:param force_new_tree: If True or False force creation of a tree or
289
prevent such creation respectively.
290
:param format: Override for the for the bzrdir format to create
293
# check for non local urls
294
t = get_transport(safe_unicode(base))
295
if not isinstance(t, LocalTransport):
296
raise errors.NotLocalUrl(base)
297
bzrdir = BzrDir.create(base, format)
298
repo = bzrdir._find_or_create_repository(force_new_repo)
299
result = bzrdir.create_branch()
300
if force_new_tree or (repo.make_working_trees() and
301
force_new_tree is None):
303
bzrdir.create_workingtree()
304
except errors.NotLocalUrl:
309
def create_repository(base, shared=False, format=None):
310
"""Create a new BzrDir and Repository at the url 'base'.
312
If no format is supplied, this will default to the current default
313
BzrDirFormat by default, and use whatever repository format that that
314
uses for bzrdirformat.create_repository.
316
:param shared: Create a shared repository rather than a standalone
318
The Repository object is returned.
320
This must be overridden as an instance method in child classes, where
321
it should take no parameters and construct whatever repository format
322
that child class desires.
324
bzrdir = BzrDir.create(base, format)
325
return bzrdir.create_repository(shared)
328
def create_standalone_workingtree(base, format=None):
329
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
331
'base' must be a local path or a file:// url.
333
This will use the current default BzrDirFormat, and use whatever
334
repository format that that uses for bzrdirformat.create_workingtree,
335
create_branch and create_repository.
337
:return: The WorkingTree object.
339
t = get_transport(safe_unicode(base))
340
if not isinstance(t, LocalTransport):
341
raise errors.NotLocalUrl(base)
342
bzrdir = BzrDir.create_branch_and_repo(safe_unicode(base),
344
format=format).bzrdir
345
return bzrdir.create_workingtree()
347
def create_workingtree(self, revision_id=None):
348
"""Create a working tree at this BzrDir.
350
revision_id: create it as of this revision id.
352
raise NotImplementedError(self.create_workingtree)
354
def destroy_workingtree(self):
355
"""Destroy the working tree at this BzrDir.
357
Formats that do not support this may raise UnsupportedOperation.
359
raise NotImplementedError(self.destroy_workingtree)
361
def destroy_workingtree_metadata(self):
362
"""Destroy the control files for the working tree at this BzrDir.
364
The contents of working tree files are not affected.
365
Formats that do not support this may raise UnsupportedOperation.
367
raise NotImplementedError(self.destroy_workingtree_metadata)
369
def find_repository(self):
370
"""Find the repository that should be used for a_bzrdir.
372
This does not require a branch as we use it to find the repo for
373
new branches as well as to hook existing branches up to their
377
return self.open_repository()
378
except errors.NoRepositoryPresent:
380
next_transport = self.root_transport.clone('..')
382
# find the next containing bzrdir
384
found_bzrdir = BzrDir.open_containing_from_transport(
386
except errors.NotBranchError:
388
raise errors.NoRepositoryPresent(self)
389
# does it have a repository ?
391
repository = found_bzrdir.open_repository()
392
except errors.NoRepositoryPresent:
393
next_transport = found_bzrdir.root_transport.clone('..')
394
if (found_bzrdir.root_transport.base == next_transport.base):
395
# top of the file system
399
if ((found_bzrdir.root_transport.base ==
400
self.root_transport.base) or repository.is_shared()):
403
raise errors.NoRepositoryPresent(self)
404
raise errors.NoRepositoryPresent(self)
406
def get_branch_transport(self, branch_format):
407
"""Get the transport for use by branch format in this BzrDir.
409
Note that bzr dirs that do not support format strings will raise
410
IncompatibleFormat if the branch format they are given has
411
a format string, and vice versa.
413
If branch_format is None, the transport is returned with no
414
checking. if it is not None, then the returned transport is
415
guaranteed to point to an existing directory ready for use.
417
raise NotImplementedError(self.get_branch_transport)
419
def get_repository_transport(self, repository_format):
420
"""Get the transport for use by repository format in this BzrDir.
422
Note that bzr dirs that do not support format strings will raise
423
IncompatibleFormat if the repository format they are given has
424
a format string, and vice versa.
426
If repository_format is None, the transport is returned with no
427
checking. if it is not None, then the returned transport is
428
guaranteed to point to an existing directory ready for use.
430
raise NotImplementedError(self.get_repository_transport)
432
def get_workingtree_transport(self, tree_format):
433
"""Get the transport for use by workingtree format in this BzrDir.
435
Note that bzr dirs that do not support format strings will raise
436
IncompatibleFormat if the workingtree format they are given has
437
a format string, and vice versa.
439
If workingtree_format is None, the transport is returned with no
440
checking. if it is not None, then the returned transport is
441
guaranteed to point to an existing directory ready for use.
443
raise NotImplementedError(self.get_workingtree_transport)
445
def __init__(self, _transport, _format):
446
"""Initialize a Bzr control dir object.
448
Only really common logic should reside here, concrete classes should be
449
made with varying behaviours.
451
:param _format: the format that is creating this BzrDir instance.
452
:param _transport: the transport this dir is based at.
454
self._format = _format
455
self.transport = _transport.clone('.bzr')
456
self.root_transport = _transport
458
def is_control_filename(self, filename):
459
"""True if filename is the name of a path which is reserved for bzrdir's.
461
:param filename: A filename within the root transport of this bzrdir.
463
This is true IF and ONLY IF the filename is part of the namespace reserved
464
for bzr control dirs. Currently this is the '.bzr' directory in the root
465
of the root_transport. it is expected that plugins will need to extend
466
this in the future - for instance to make bzr talk with svn working
469
# this might be better on the BzrDirFormat class because it refers to
470
# all the possible bzrdir disk formats.
471
# This method is tested via the workingtree is_control_filename tests-
472
# it was extracted from WorkingTree.is_control_filename. If the methods
473
# contract is extended beyond the current trivial implementation please
474
# add new tests for it to the appropriate place.
475
return filename == '.bzr' or filename.startswith('.bzr/')
477
def needs_format_conversion(self, format=None):
478
"""Return true if this bzrdir needs convert_format run on it.
480
For instance, if the repository format is out of date but the
481
branch and working tree are not, this should return True.
483
:param format: Optional parameter indicating a specific desired
484
format we plan to arrive at.
486
raise NotImplementedError(self.needs_format_conversion)
489
def open_unsupported(base):
490
"""Open a branch which is not supported."""
491
return BzrDir.open(base, _unsupported=True)
494
def open(base, _unsupported=False):
495
"""Open an existing bzrdir, rooted at 'base' (url)
497
_unsupported is a private parameter to the BzrDir class.
499
t = get_transport(base)
500
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
503
def open_from_transport(transport, _unsupported=False):
504
"""Open a bzrdir within a particular directory.
506
:param transport: Transport containing the bzrdir.
507
:param _unsupported: private.
509
format = BzrDirFormat.find_format(transport)
510
BzrDir._check_supported(format, _unsupported)
511
return format.open(transport, _found=True)
513
def open_branch(self, unsupported=False):
514
"""Open the branch object at this BzrDir if one is present.
516
If unsupported is True, then no longer supported branch formats can
519
TODO: static convenience version of this?
521
raise NotImplementedError(self.open_branch)
524
def open_containing(url):
525
"""Open an existing branch which contains url.
527
:param url: url to search from.
528
See open_containing_from_transport for more detail.
530
return BzrDir.open_containing_from_transport(get_transport(url))
533
def open_containing_from_transport(a_transport):
534
"""Open an existing branch which contains a_transport.base
536
This probes for a branch at a_transport, and searches upwards from there.
538
Basically we keep looking up until we find the control directory or
539
run into the root. If there isn't one, raises NotBranchError.
540
If there is one and it is either an unrecognised format or an unsupported
541
format, UnknownFormatError or UnsupportedFormatError are raised.
542
If there is one, it is returned, along with the unused portion of url.
544
:return: The BzrDir that contains the path, and a Unicode path
545
for the rest of the URL.
547
# this gets the normalised url back. I.e. '.' -> the full path.
548
url = a_transport.base
551
result = BzrDir.open_from_transport(a_transport)
552
return result, urlutils.unescape(a_transport.relpath(url))
553
except errors.NotBranchError, e:
555
new_t = a_transport.clone('..')
556
if new_t.base == a_transport.base:
557
# reached the root, whatever that may be
558
raise errors.NotBranchError(path=url)
562
def open_containing_tree_or_branch(klass, location):
563
"""Return the branch and working tree contained by a location.
565
Returns (tree, branch, relpath).
566
If there is no tree at containing the location, tree will be None.
567
If there is no branch containing the location, an exception will be
569
relpath is the portion of the path that is contained by the branch.
571
bzrdir, relpath = klass.open_containing(location)
573
tree = bzrdir.open_workingtree()
574
except (errors.NoWorkingTree, errors.NotLocalUrl):
576
branch = bzrdir.open_branch()
579
return tree, branch, relpath
581
def open_repository(self, _unsupported=False):
582
"""Open the repository object at this BzrDir if one is present.
584
This will not follow the Branch object pointer - its strictly a direct
585
open facility. Most client code should use open_branch().repository to
588
_unsupported is a private parameter, not part of the api.
589
TODO: static convenience version of this?
591
raise NotImplementedError(self.open_repository)
593
def open_workingtree(self, _unsupported=False):
594
"""Open the workingtree object at this BzrDir if one is present.
596
TODO: static convenience version of this?
598
raise NotImplementedError(self.open_workingtree)
600
def has_branch(self):
601
"""Tell if this bzrdir contains a branch.
603
Note: if you're going to open the branch, you should just go ahead
604
and try, and not ask permission first. (This method just opens the
605
branch and discards it, and that's somewhat expensive.)
610
except errors.NotBranchError:
613
def has_workingtree(self):
614
"""Tell if this bzrdir contains a working tree.
616
This will still raise an exception if the bzrdir has a workingtree that
617
is remote & inaccessible.
619
Note: if you're going to open the working tree, you should just go ahead
620
and try, and not ask permission first. (This method just opens the
621
workingtree and discards it, and that's somewhat expensive.)
624
self.open_workingtree()
626
except errors.NoWorkingTree:
629
def cloning_metadir(self, basis=None):
630
"""Produce a metadir suitable for cloning with"""
631
def related_repository(bzrdir):
633
branch = bzrdir.open_branch()
634
return branch.repository
635
except errors.NotBranchError:
637
return bzrdir.open_repository()
638
result_format = self._format.__class__()
641
source_repository = related_repository(self)
642
except errors.NoRepositoryPresent:
645
source_repository = related_repository(self)
646
result_format.repository_format = source_repository._format
647
except errors.NoRepositoryPresent:
651
def sprout(self, url, revision_id=None, basis=None, force_new_repo=False):
652
"""Create a copy of this bzrdir prepared for use as a new line of
655
If urls last component does not exist, it will be created.
657
Attributes related to the identity of the source branch like
658
branch nickname will be cleaned, a working tree is created
659
whether one existed before or not; and a local branch is always
662
if revision_id is not None, then the clone operation may tune
663
itself to download less data.
666
cloning_format = self.cloning_metadir(basis)
667
result = cloning_format.initialize(url)
668
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
670
source_branch = self.open_branch()
671
source_repository = source_branch.repository
672
except errors.NotBranchError:
675
source_repository = self.open_repository()
676
except errors.NoRepositoryPresent:
677
# copy the entire basis one if there is one
678
# but there is no repository.
679
source_repository = basis_repo
684
result_repo = result.find_repository()
685
except errors.NoRepositoryPresent:
687
if source_repository is None and result_repo is not None:
689
elif source_repository is None and result_repo is None:
690
# no repo available, make a new one
691
result.create_repository()
692
elif source_repository is not None and result_repo is None:
693
# have source, and want to make a new target repo
694
# we don't clone the repo because that preserves attributes
695
# like is_shared(), and we have not yet implemented a
696
# repository sprout().
697
result_repo = result.create_repository()
698
if result_repo is not None:
699
# fetch needed content into target.
701
# XXX FIXME RBC 20060214 need tests for this when the basis
703
result_repo.fetch(basis_repo, revision_id=revision_id)
704
if source_repository is not None:
705
result_repo.fetch(source_repository, revision_id=revision_id)
706
if source_branch is not None:
707
source_branch.sprout(result, revision_id=revision_id)
709
result.create_branch()
710
# TODO: jam 20060426 we probably need a test in here in the
711
# case that the newly sprouted branch is a remote one
712
if result_repo is None or result_repo.make_working_trees():
713
wt = result.create_workingtree()
714
if wt.inventory.root is None:
716
wt.set_root_id(self.open_workingtree.get_root_id())
717
except errors.NoWorkingTree:
722
class BzrDirPreSplitOut(BzrDir):
723
"""A common class for the all-in-one formats."""
725
def __init__(self, _transport, _format):
726
"""See BzrDir.__init__."""
727
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
728
assert self._format._lock_class == lockable_files.TransportLock
729
assert self._format._lock_file_name == 'branch-lock'
730
self._control_files = lockable_files.LockableFiles(
731
self.get_branch_transport(None),
732
self._format._lock_file_name,
733
self._format._lock_class)
735
def break_lock(self):
736
"""Pre-splitout bzrdirs do not suffer from stale locks."""
737
raise NotImplementedError(self.break_lock)
739
def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
740
"""See BzrDir.clone()."""
741
from bzrlib.workingtree import WorkingTreeFormat2
743
result = self._format._initialize_for_clone(url)
744
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
745
self.open_repository().clone(result, revision_id=revision_id, basis=basis_repo)
746
from_branch = self.open_branch()
747
from_branch.clone(result, revision_id=revision_id)
749
self.open_workingtree().clone(result, basis=basis_tree)
750
except errors.NotLocalUrl:
751
# make a new one, this format always has to have one.
753
WorkingTreeFormat2().initialize(result)
754
except errors.NotLocalUrl:
755
# but we cannot do it for remote trees.
756
to_branch = result.open_branch()
757
WorkingTreeFormat2().stub_initialize_remote(to_branch.control_files)
760
def create_branch(self):
761
"""See BzrDir.create_branch."""
762
return self.open_branch()
764
def create_repository(self, shared=False):
765
"""See BzrDir.create_repository."""
767
raise errors.IncompatibleFormat('shared repository', self._format)
768
return self.open_repository()
770
def create_workingtree(self, revision_id=None):
771
"""See BzrDir.create_workingtree."""
772
# this looks buggy but is not -really-
773
# clone and sprout will have set the revision_id
774
# and that will have set it for us, its only
775
# specific uses of create_workingtree in isolation
776
# that can do wonky stuff here, and that only
777
# happens for creating checkouts, which cannot be
778
# done on this format anyway. So - acceptable wart.
779
result = self.open_workingtree()
780
if revision_id is not None:
781
if revision_id == _mod_revision.NULL_REVISION:
782
result.set_parent_ids([])
784
result.set_parent_ids([revision_id])
787
def destroy_workingtree(self):
788
"""See BzrDir.destroy_workingtree."""
789
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
791
def destroy_workingtree_metadata(self):
792
"""See BzrDir.destroy_workingtree_metadata."""
793
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
796
def get_branch_transport(self, branch_format):
797
"""See BzrDir.get_branch_transport()."""
798
if branch_format is None:
799
return self.transport
801
branch_format.get_format_string()
802
except NotImplementedError:
803
return self.transport
804
raise errors.IncompatibleFormat(branch_format, self._format)
806
def get_repository_transport(self, repository_format):
807
"""See BzrDir.get_repository_transport()."""
808
if repository_format is None:
809
return self.transport
811
repository_format.get_format_string()
812
except NotImplementedError:
813
return self.transport
814
raise errors.IncompatibleFormat(repository_format, self._format)
816
def get_workingtree_transport(self, workingtree_format):
817
"""See BzrDir.get_workingtree_transport()."""
818
if workingtree_format is None:
819
return self.transport
821
workingtree_format.get_format_string()
822
except NotImplementedError:
823
return self.transport
824
raise errors.IncompatibleFormat(workingtree_format, self._format)
826
def needs_format_conversion(self, format=None):
827
"""See BzrDir.needs_format_conversion()."""
828
# if the format is not the same as the system default,
829
# an upgrade is needed.
831
format = BzrDirFormat.get_default_format()
832
return not isinstance(self._format, format.__class__)
834
def open_branch(self, unsupported=False):
835
"""See BzrDir.open_branch."""
836
from bzrlib.branch import BzrBranchFormat4
837
format = BzrBranchFormat4()
838
self._check_supported(format, unsupported)
839
return format.open(self, _found=True)
841
def sprout(self, url, revision_id=None, basis=None, force_new_repo=False):
842
"""See BzrDir.sprout()."""
843
from bzrlib.workingtree import WorkingTreeFormat2
845
result = self._format._initialize_for_clone(url)
846
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
848
self.open_repository().clone(result, revision_id=revision_id, basis=basis_repo)
849
except errors.NoRepositoryPresent:
852
self.open_branch().sprout(result, revision_id=revision_id)
853
except errors.NotBranchError:
855
# we always want a working tree
856
WorkingTreeFormat2().initialize(result)
860
class BzrDir4(BzrDirPreSplitOut):
861
"""A .bzr version 4 control object.
863
This is a deprecated format and may be removed after sept 2006.
866
def create_repository(self, shared=False):
867
"""See BzrDir.create_repository."""
868
return self._format.repository_format.initialize(self, shared)
870
def needs_format_conversion(self, format=None):
871
"""Format 4 dirs are always in need of conversion."""
874
def open_repository(self):
875
"""See BzrDir.open_repository."""
876
from bzrlib.repository import RepositoryFormat4
877
return RepositoryFormat4().open(self, _found=True)
880
class BzrDir5(BzrDirPreSplitOut):
881
"""A .bzr version 5 control object.
883
This is a deprecated format and may be removed after sept 2006.
886
def open_repository(self):
887
"""See BzrDir.open_repository."""
888
from bzrlib.repository import RepositoryFormat5
889
return RepositoryFormat5().open(self, _found=True)
891
def open_workingtree(self, _unsupported=False):
892
"""See BzrDir.create_workingtree."""
893
from bzrlib.workingtree import WorkingTreeFormat2
894
return WorkingTreeFormat2().open(self, _found=True)
897
class BzrDir6(BzrDirPreSplitOut):
898
"""A .bzr version 6 control object.
900
This is a deprecated format and may be removed after sept 2006.
903
def open_repository(self):
904
"""See BzrDir.open_repository."""
905
from bzrlib.repository import RepositoryFormat6
906
return RepositoryFormat6().open(self, _found=True)
908
def open_workingtree(self, _unsupported=False):
909
"""See BzrDir.create_workingtree."""
910
from bzrlib.workingtree import WorkingTreeFormat2
911
return WorkingTreeFormat2().open(self, _found=True)
914
class BzrDirMeta1(BzrDir):
915
"""A .bzr meta version 1 control object.
917
This is the first control object where the
918
individual aspects are really split out: there are separate repository,
919
workingtree and branch subdirectories and any subset of the three can be
920
present within a BzrDir.
923
def can_convert_format(self):
924
"""See BzrDir.can_convert_format()."""
927
def create_branch(self):
928
"""See BzrDir.create_branch."""
929
return self._format.branch_format.initialize(self)
931
def create_repository(self, shared=False):
932
"""See BzrDir.create_repository."""
933
return self._format.repository_format.initialize(self, shared)
935
def create_workingtree(self, revision_id=None):
936
"""See BzrDir.create_workingtree."""
937
from bzrlib.workingtree import WorkingTreeFormat
938
return WorkingTreeFormat.get_default_format().initialize(self, revision_id)
940
def destroy_workingtree(self):
941
"""See BzrDir.destroy_workingtree."""
942
wt = self.open_workingtree()
943
repository = wt.branch.repository
944
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
945
wt.revert([], old_tree=empty)
946
self.destroy_workingtree_metadata()
948
def destroy_workingtree_metadata(self):
949
self.transport.delete_tree('checkout')
951
def _get_mkdir_mode(self):
952
"""Figure out the mode to use when creating a bzrdir subdir."""
953
temp_control = lockable_files.LockableFiles(self.transport, '',
954
lockable_files.TransportLock)
955
return temp_control._dir_mode
957
def get_branch_transport(self, branch_format):
958
"""See BzrDir.get_branch_transport()."""
959
if branch_format is None:
960
return self.transport.clone('branch')
962
branch_format.get_format_string()
963
except NotImplementedError:
964
raise errors.IncompatibleFormat(branch_format, self._format)
966
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
967
except errors.FileExists:
969
return self.transport.clone('branch')
971
def get_repository_transport(self, repository_format):
972
"""See BzrDir.get_repository_transport()."""
973
if repository_format is None:
974
return self.transport.clone('repository')
976
repository_format.get_format_string()
977
except NotImplementedError:
978
raise errors.IncompatibleFormat(repository_format, self._format)
980
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
981
except errors.FileExists:
983
return self.transport.clone('repository')
985
def get_workingtree_transport(self, workingtree_format):
986
"""See BzrDir.get_workingtree_transport()."""
987
if workingtree_format is None:
988
return self.transport.clone('checkout')
990
workingtree_format.get_format_string()
991
except NotImplementedError:
992
raise errors.IncompatibleFormat(workingtree_format, self._format)
994
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
995
except errors.FileExists:
997
return self.transport.clone('checkout')
999
def needs_format_conversion(self, format=None):
1000
"""See BzrDir.needs_format_conversion()."""
1002
format = BzrDirFormat.get_default_format()
1003
if not isinstance(self._format, format.__class__):
1004
# it is not a meta dir format, conversion is needed.
1006
# we might want to push this down to the repository?
1008
if not isinstance(self.open_repository()._format,
1009
format.repository_format.__class__):
1010
# the repository needs an upgrade.
1012
except errors.NoRepositoryPresent:
1014
# currently there are no other possible conversions for meta1 formats.
1017
def open_branch(self, unsupported=False):
1018
"""See BzrDir.open_branch."""
1019
from bzrlib.branch import BranchFormat
1020
format = BranchFormat.find_format(self)
1021
self._check_supported(format, unsupported)
1022
return format.open(self, _found=True)
1024
def open_repository(self, unsupported=False):
1025
"""See BzrDir.open_repository."""
1026
from bzrlib.repository import RepositoryFormat
1027
format = RepositoryFormat.find_format(self)
1028
self._check_supported(format, unsupported)
1029
return format.open(self, _found=True)
1031
def open_workingtree(self, unsupported=False):
1032
"""See BzrDir.open_workingtree."""
1033
from bzrlib.workingtree import WorkingTreeFormat
1034
format = WorkingTreeFormat.find_format(self)
1035
self._check_supported(format, unsupported)
1036
return format.open(self, _found=True)
1039
class BzrDirFormat(object):
1040
"""An encapsulation of the initialization and open routines for a format.
1042
Formats provide three things:
1043
* An initialization routine,
1047
Formats are placed in an dict by their format string for reference
1048
during bzrdir opening. These should be subclasses of BzrDirFormat
1051
Once a format is deprecated, just deprecate the initialize and open
1052
methods on the format class. Do not deprecate the object, as the
1053
object will be created every system load.
1056
_default_format = None
1057
"""The default format used for new .bzr dirs."""
1060
"""The known formats."""
1062
_control_formats = []
1063
"""The registered control formats - .bzr, ....
1065
This is a list of BzrDirFormat objects.
1068
_lock_file_name = 'branch-lock'
1070
# _lock_class must be set in subclasses to the lock type, typ.
1071
# TransportLock or LockDir
1074
def find_format(klass, transport):
1075
"""Return the format present at transport."""
1076
for format in klass._control_formats:
1078
return format.probe_transport(transport)
1079
except errors.NotBranchError:
1080
# this format does not find a control dir here.
1082
raise errors.NotBranchError(path=transport.base)
1085
def probe_transport(klass, transport):
1086
"""Return the .bzrdir style transport present at URL."""
1088
format_string = transport.get(".bzr/branch-format").read()
1089
except errors.NoSuchFile:
1090
raise errors.NotBranchError(path=transport.base)
1093
return klass._formats[format_string]
1095
raise errors.UnknownFormatError(format=format_string)
1098
def get_default_format(klass):
1099
"""Return the current default format."""
1100
return klass._default_format
1102
def get_format_string(self):
1103
"""Return the ASCII format string that identifies this format."""
1104
raise NotImplementedError(self.get_format_string)
1106
def get_format_description(self):
1107
"""Return the short description for this format."""
1108
raise NotImplementedError(self.get_format_description)
1110
def get_converter(self, format=None):
1111
"""Return the converter to use to convert bzrdirs needing converts.
1113
This returns a bzrlib.bzrdir.Converter object.
1115
This should return the best upgrader to step this format towards the
1116
current default format. In the case of plugins we can/should provide
1117
some means for them to extend the range of returnable converters.
1119
:param format: Optional format to override the default format of the
1122
raise NotImplementedError(self.get_converter)
1124
def initialize(self, url):
1125
"""Create a bzr control dir at this url and return an opened copy.
1127
Subclasses should typically override initialize_on_transport
1128
instead of this method.
1130
return self.initialize_on_transport(get_transport(url))
1132
def initialize_on_transport(self, transport):
1133
"""Initialize a new bzrdir in the base directory of a Transport."""
1134
# Since we don't have a .bzr directory, inherit the
1135
# mode from the root directory
1136
temp_control = lockable_files.LockableFiles(transport,
1137
'', lockable_files.TransportLock)
1138
temp_control._transport.mkdir('.bzr',
1139
# FIXME: RBC 20060121 don't peek under
1141
mode=temp_control._dir_mode)
1142
file_mode = temp_control._file_mode
1144
mutter('created control directory in ' + transport.base)
1145
control = transport.clone('.bzr')
1146
utf8_files = [('README',
1147
"This is a Bazaar-NG control directory.\n"
1148
"Do not change any files in this directory.\n"),
1149
('branch-format', self.get_format_string()),
1151
# NB: no need to escape relative paths that are url safe.
1152
control_files = lockable_files.LockableFiles(control,
1153
self._lock_file_name, self._lock_class)
1154
control_files.create_lock()
1155
control_files.lock_write()
1157
for file, content in utf8_files:
1158
control_files.put_utf8(file, content)
1160
control_files.unlock()
1161
return self.open(transport, _found=True)
1163
def is_supported(self):
1164
"""Is this format supported?
1166
Supported formats must be initializable and openable.
1167
Unsupported formats may not support initialization or committing or
1168
some other features depending on the reason for not being supported.
1172
def same_model(self, target_format):
1173
return (self.repository_format.rich_root_data ==
1174
target_format.rich_root_data)
1177
def known_formats(klass):
1178
"""Return all the known formats.
1180
Concrete formats should override _known_formats.
1182
# There is double indirection here to make sure that control
1183
# formats used by more than one dir format will only be probed
1184
# once. This can otherwise be quite expensive for remote connections.
1186
for format in klass._control_formats:
1187
result.update(format._known_formats())
1191
def _known_formats(klass):
1192
"""Return the known format instances for this control format."""
1193
return set(klass._formats.values())
1195
def open(self, transport, _found=False):
1196
"""Return an instance of this format for the dir transport points at.
1198
_found is a private parameter, do not use it.
1201
found_format = BzrDirFormat.find_format(transport)
1202
if not isinstance(found_format, self.__class__):
1203
raise AssertionError("%s was asked to open %s, but it seems to need "
1205
% (self, transport, found_format))
1206
return self._open(transport)
1208
def _open(self, transport):
1209
"""Template method helper for opening BzrDirectories.
1211
This performs the actual open and any additional logic or parameter
1214
raise NotImplementedError(self._open)
1217
def register_format(klass, format):
1218
klass._formats[format.get_format_string()] = format
1221
def register_control_format(klass, format):
1222
"""Register a format that does not use '.bzrdir' for its control dir.
1224
TODO: This should be pulled up into a 'ControlDirFormat' base class
1225
which BzrDirFormat can inherit from, and renamed to register_format
1226
there. It has been done without that for now for simplicity of
1229
klass._control_formats.append(format)
1232
@symbol_versioning.deprecated_method(symbol_versioning.zero_fourteen)
1233
def set_default_format(klass, format):
1234
klass._set_default_format(format)
1237
def _set_default_format(klass, format):
1238
"""Set default format (for testing behavior of defaults only)"""
1239
klass._default_format = format
1242
return self.get_format_string()[:-1]
1245
def unregister_format(klass, format):
1246
assert klass._formats[format.get_format_string()] is format
1247
del klass._formats[format.get_format_string()]
1250
def unregister_control_format(klass, format):
1251
klass._control_formats.remove(format)
1254
# register BzrDirFormat as a control format
1255
BzrDirFormat.register_control_format(BzrDirFormat)
1258
class BzrDirFormat4(BzrDirFormat):
1259
"""Bzr dir format 4.
1261
This format is a combined format for working tree, branch and repository.
1263
- Format 1 working trees [always]
1264
- Format 4 branches [always]
1265
- Format 4 repositories [always]
1267
This format is deprecated: it indexes texts using a text it which is
1268
removed in format 5; write support for this format has been removed.
1271
_lock_class = lockable_files.TransportLock
1273
def get_format_string(self):
1274
"""See BzrDirFormat.get_format_string()."""
1275
return "Bazaar-NG branch, format 0.0.4\n"
1277
def get_format_description(self):
1278
"""See BzrDirFormat.get_format_description()."""
1279
return "All-in-one format 4"
1281
def get_converter(self, format=None):
1282
"""See BzrDirFormat.get_converter()."""
1283
# there is one and only one upgrade path here.
1284
return ConvertBzrDir4To5()
1286
def initialize_on_transport(self, transport):
1287
"""Format 4 branches cannot be created."""
1288
raise errors.UninitializableFormat(self)
1290
def is_supported(self):
1291
"""Format 4 is not supported.
1293
It is not supported because the model changed from 4 to 5 and the
1294
conversion logic is expensive - so doing it on the fly was not
1299
def _open(self, transport):
1300
"""See BzrDirFormat._open."""
1301
return BzrDir4(transport, self)
1303
def __return_repository_format(self):
1304
"""Circular import protection."""
1305
from bzrlib.repository import RepositoryFormat4
1306
return RepositoryFormat4()
1307
repository_format = property(__return_repository_format)
1310
class BzrDirFormat5(BzrDirFormat):
1311
"""Bzr control format 5.
1313
This format is a combined format for working tree, branch and repository.
1315
- Format 2 working trees [always]
1316
- Format 4 branches [always]
1317
- Format 5 repositories [always]
1318
Unhashed stores in the repository.
1321
_lock_class = lockable_files.TransportLock
1323
def get_format_string(self):
1324
"""See BzrDirFormat.get_format_string()."""
1325
return "Bazaar-NG branch, format 5\n"
1327
def get_format_description(self):
1328
"""See BzrDirFormat.get_format_description()."""
1329
return "All-in-one format 5"
1331
def get_converter(self, format=None):
1332
"""See BzrDirFormat.get_converter()."""
1333
# there is one and only one upgrade path here.
1334
return ConvertBzrDir5To6()
1336
def _initialize_for_clone(self, url):
1337
return self.initialize_on_transport(get_transport(url), _cloning=True)
1339
def initialize_on_transport(self, transport, _cloning=False):
1340
"""Format 5 dirs always have working tree, branch and repository.
1342
Except when they are being cloned.
1344
from bzrlib.branch import BzrBranchFormat4
1345
from bzrlib.repository import RepositoryFormat5
1346
from bzrlib.workingtree import WorkingTreeFormat2
1347
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1348
RepositoryFormat5().initialize(result, _internal=True)
1350
branch = BzrBranchFormat4().initialize(result)
1352
WorkingTreeFormat2().initialize(result)
1353
except errors.NotLocalUrl:
1354
# Even though we can't access the working tree, we need to
1355
# create its control files.
1356
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1359
def _open(self, transport):
1360
"""See BzrDirFormat._open."""
1361
return BzrDir5(transport, self)
1363
def __return_repository_format(self):
1364
"""Circular import protection."""
1365
from bzrlib.repository import RepositoryFormat5
1366
return RepositoryFormat5()
1367
repository_format = property(__return_repository_format)
1370
class BzrDirFormat6(BzrDirFormat):
1371
"""Bzr control format 6.
1373
This format is a combined format for working tree, branch and repository.
1375
- Format 2 working trees [always]
1376
- Format 4 branches [always]
1377
- Format 6 repositories [always]
1380
_lock_class = lockable_files.TransportLock
1382
def get_format_string(self):
1383
"""See BzrDirFormat.get_format_string()."""
1384
return "Bazaar-NG branch, format 6\n"
1386
def get_format_description(self):
1387
"""See BzrDirFormat.get_format_description()."""
1388
return "All-in-one format 6"
1390
def get_converter(self, format=None):
1391
"""See BzrDirFormat.get_converter()."""
1392
# there is one and only one upgrade path here.
1393
return ConvertBzrDir6ToMeta()
1395
def _initialize_for_clone(self, url):
1396
return self.initialize_on_transport(get_transport(url), _cloning=True)
1398
def initialize_on_transport(self, transport, _cloning=False):
1399
"""Format 6 dirs always have working tree, branch and repository.
1401
Except when they are being cloned.
1403
from bzrlib.branch import BzrBranchFormat4
1404
from bzrlib.repository import RepositoryFormat6
1405
from bzrlib.workingtree import WorkingTreeFormat2
1406
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1407
RepositoryFormat6().initialize(result, _internal=True)
1409
branch = BzrBranchFormat4().initialize(result)
1411
WorkingTreeFormat2().initialize(result)
1412
except errors.NotLocalUrl:
1413
# Even though we can't access the working tree, we need to
1414
# create its control files.
1415
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1418
def _open(self, transport):
1419
"""See BzrDirFormat._open."""
1420
return BzrDir6(transport, self)
1422
def __return_repository_format(self):
1423
"""Circular import protection."""
1424
from bzrlib.repository import RepositoryFormat6
1425
return RepositoryFormat6()
1426
repository_format = property(__return_repository_format)
1429
class BzrDirMetaFormat1(BzrDirFormat):
1430
"""Bzr meta control format 1
1432
This is the first format with split out working tree, branch and repository
1435
- Format 3 working trees [optional]
1436
- Format 5 branches [optional]
1437
- Format 7 repositories [optional]
1440
_lock_class = lockdir.LockDir
1443
self._branch_format = None
1445
def _get_branch_format(self):
1446
if self._branch_format is None:
1447
from bzrlib.branch import BranchFormat
1448
self._branch_format = BranchFormat.get_default_format()
1449
return self._branch_format
1451
def _set_branch_format(self, format):
1452
self._branch_format = format
1454
branch_format = property(_get_branch_format, _set_branch_format)
1456
def get_converter(self, format=None):
1457
"""See BzrDirFormat.get_converter()."""
1459
format = BzrDirFormat.get_default_format()
1460
if not isinstance(self, format.__class__):
1461
# converting away from metadir is not implemented
1462
raise NotImplementedError(self.get_converter)
1463
return ConvertMetaToMeta(format)
1465
def get_format_string(self):
1466
"""See BzrDirFormat.get_format_string()."""
1467
return "Bazaar-NG meta directory, format 1\n"
1469
def get_format_description(self):
1470
"""See BzrDirFormat.get_format_description()."""
1471
return "Meta directory format 1"
1473
def _open(self, transport):
1474
"""See BzrDirFormat._open."""
1475
return BzrDirMeta1(transport, self)
1477
def __return_repository_format(self):
1478
"""Circular import protection."""
1479
if getattr(self, '_repository_format', None):
1480
return self._repository_format
1481
from bzrlib.repository import RepositoryFormat
1482
return RepositoryFormat.get_default_format()
1484
def __set_repository_format(self, value):
1485
"""Allow changint the repository format for metadir formats."""
1486
self._repository_format = value
1488
repository_format = property(__return_repository_format, __set_repository_format)
1491
BzrDirFormat.register_format(BzrDirFormat4())
1492
BzrDirFormat.register_format(BzrDirFormat5())
1493
BzrDirFormat.register_format(BzrDirFormat6())
1494
__default_format = BzrDirMetaFormat1()
1495
BzrDirFormat.register_format(__default_format)
1496
BzrDirFormat._default_format = __default_format
1499
class BzrDirTestProviderAdapter(object):
1500
"""A tool to generate a suite testing multiple bzrdir formats at once.
1502
This is done by copying the test once for each transport and injecting
1503
the transport_server, transport_readonly_server, and bzrdir_format
1504
classes into each copy. Each copy is also given a new id() to make it
1508
def __init__(self, transport_server, transport_readonly_server, formats):
1509
self._transport_server = transport_server
1510
self._transport_readonly_server = transport_readonly_server
1511
self._formats = formats
1513
def adapt(self, test):
1514
result = unittest.TestSuite()
1515
for format in self._formats:
1516
new_test = deepcopy(test)
1517
new_test.transport_server = self._transport_server
1518
new_test.transport_readonly_server = self._transport_readonly_server
1519
new_test.bzrdir_format = format
1520
def make_new_test_id():
1521
new_id = "%s(%s)" % (new_test.id(), format.__class__.__name__)
1522
return lambda: new_id
1523
new_test.id = make_new_test_id()
1524
result.addTest(new_test)
1528
class Converter(object):
1529
"""Converts a disk format object from one format to another."""
1531
def convert(self, to_convert, pb):
1532
"""Perform the conversion of to_convert, giving feedback via pb.
1534
:param to_convert: The disk object to convert.
1535
:param pb: a progress bar to use for progress information.
1538
def step(self, message):
1539
"""Update the pb by a step."""
1541
self.pb.update(message, self.count, self.total)
1544
class ConvertBzrDir4To5(Converter):
1545
"""Converts format 4 bzr dirs to format 5."""
1548
super(ConvertBzrDir4To5, self).__init__()
1549
self.converted_revs = set()
1550
self.absent_revisions = set()
1554
def convert(self, to_convert, pb):
1555
"""See Converter.convert()."""
1556
self.bzrdir = to_convert
1558
self.pb.note('starting upgrade from format 4 to 5')
1559
if isinstance(self.bzrdir.transport, LocalTransport):
1560
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
1561
self._convert_to_weaves()
1562
return BzrDir.open(self.bzrdir.root_transport.base)
1564
def _convert_to_weaves(self):
1565
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
1568
stat = self.bzrdir.transport.stat('weaves')
1569
if not S_ISDIR(stat.st_mode):
1570
self.bzrdir.transport.delete('weaves')
1571
self.bzrdir.transport.mkdir('weaves')
1572
except errors.NoSuchFile:
1573
self.bzrdir.transport.mkdir('weaves')
1574
# deliberately not a WeaveFile as we want to build it up slowly.
1575
self.inv_weave = Weave('inventory')
1576
# holds in-memory weaves for all files
1577
self.text_weaves = {}
1578
self.bzrdir.transport.delete('branch-format')
1579
self.branch = self.bzrdir.open_branch()
1580
self._convert_working_inv()
1581
rev_history = self.branch.revision_history()
1582
# to_read is a stack holding the revisions we still need to process;
1583
# appending to it adds new highest-priority revisions
1584
self.known_revisions = set(rev_history)
1585
self.to_read = rev_history[-1:]
1587
rev_id = self.to_read.pop()
1588
if (rev_id not in self.revisions
1589
and rev_id not in self.absent_revisions):
1590
self._load_one_rev(rev_id)
1592
to_import = self._make_order()
1593
for i, rev_id in enumerate(to_import):
1594
self.pb.update('converting revision', i, len(to_import))
1595
self._convert_one_rev(rev_id)
1597
self._write_all_weaves()
1598
self._write_all_revs()
1599
self.pb.note('upgraded to weaves:')
1600
self.pb.note(' %6d revisions and inventories', len(self.revisions))
1601
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
1602
self.pb.note(' %6d texts', self.text_count)
1603
self._cleanup_spare_files_after_format4()
1604
self.branch.control_files.put_utf8('branch-format', BzrDirFormat5().get_format_string())
1606
def _cleanup_spare_files_after_format4(self):
1607
# FIXME working tree upgrade foo.
1608
for n in 'merged-patches', 'pending-merged-patches':
1610
## assert os.path.getsize(p) == 0
1611
self.bzrdir.transport.delete(n)
1612
except errors.NoSuchFile:
1614
self.bzrdir.transport.delete_tree('inventory-store')
1615
self.bzrdir.transport.delete_tree('text-store')
1617
def _convert_working_inv(self):
1618
inv = xml4.serializer_v4.read_inventory(
1619
self.branch.control_files.get('inventory'))
1620
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
1621
# FIXME inventory is a working tree change.
1622
self.branch.control_files.put('inventory', StringIO(new_inv_xml))
1624
def _write_all_weaves(self):
1625
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
1626
weave_transport = self.bzrdir.transport.clone('weaves')
1627
weaves = WeaveStore(weave_transport, prefixed=False)
1628
transaction = WriteTransaction()
1632
for file_id, file_weave in self.text_weaves.items():
1633
self.pb.update('writing weave', i, len(self.text_weaves))
1634
weaves._put_weave(file_id, file_weave, transaction)
1636
self.pb.update('inventory', 0, 1)
1637
controlweaves._put_weave('inventory', self.inv_weave, transaction)
1638
self.pb.update('inventory', 1, 1)
1642
def _write_all_revs(self):
1643
"""Write all revisions out in new form."""
1644
self.bzrdir.transport.delete_tree('revision-store')
1645
self.bzrdir.transport.mkdir('revision-store')
1646
revision_transport = self.bzrdir.transport.clone('revision-store')
1648
_revision_store = TextRevisionStore(TextStore(revision_transport,
1652
transaction = WriteTransaction()
1653
for i, rev_id in enumerate(self.converted_revs):
1654
self.pb.update('write revision', i, len(self.converted_revs))
1655
_revision_store.add_revision(self.revisions[rev_id], transaction)
1659
def _load_one_rev(self, rev_id):
1660
"""Load a revision object into memory.
1662
Any parents not either loaded or abandoned get queued to be
1664
self.pb.update('loading revision',
1665
len(self.revisions),
1666
len(self.known_revisions))
1667
if not self.branch.repository.has_revision(rev_id):
1669
self.pb.note('revision {%s} not present in branch; '
1670
'will be converted as a ghost',
1672
self.absent_revisions.add(rev_id)
1674
rev = self.branch.repository._revision_store.get_revision(rev_id,
1675
self.branch.repository.get_transaction())
1676
for parent_id in rev.parent_ids:
1677
self.known_revisions.add(parent_id)
1678
self.to_read.append(parent_id)
1679
self.revisions[rev_id] = rev
1681
def _load_old_inventory(self, rev_id):
1682
assert rev_id not in self.converted_revs
1683
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
1684
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
1685
inv.revision_id = rev_id
1686
rev = self.revisions[rev_id]
1687
if rev.inventory_sha1:
1688
assert rev.inventory_sha1 == sha_string(old_inv_xml), \
1689
'inventory sha mismatch for {%s}' % rev_id
1692
def _load_updated_inventory(self, rev_id):
1693
assert rev_id in self.converted_revs
1694
inv_xml = self.inv_weave.get_text(rev_id)
1695
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml)
1698
def _convert_one_rev(self, rev_id):
1699
"""Convert revision and all referenced objects to new format."""
1700
rev = self.revisions[rev_id]
1701
inv = self._load_old_inventory(rev_id)
1702
present_parents = [p for p in rev.parent_ids
1703
if p not in self.absent_revisions]
1704
self._convert_revision_contents(rev, inv, present_parents)
1705
self._store_new_weave(rev, inv, present_parents)
1706
self.converted_revs.add(rev_id)
1708
def _store_new_weave(self, rev, inv, present_parents):
1709
# the XML is now updated with text versions
1711
entries = inv.iter_entries()
1713
for path, ie in entries:
1714
assert getattr(ie, 'revision', None) is not None, \
1715
'no revision on {%s} in {%s}' % \
1716
(file_id, rev.revision_id)
1717
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
1718
new_inv_sha1 = sha_string(new_inv_xml)
1719
self.inv_weave.add_lines(rev.revision_id,
1721
new_inv_xml.splitlines(True))
1722
rev.inventory_sha1 = new_inv_sha1
1724
def _convert_revision_contents(self, rev, inv, present_parents):
1725
"""Convert all the files within a revision.
1727
Also upgrade the inventory to refer to the text revision ids."""
1728
rev_id = rev.revision_id
1729
mutter('converting texts of revision {%s}',
1731
parent_invs = map(self._load_updated_inventory, present_parents)
1732
entries = inv.iter_entries()
1734
for path, ie in entries:
1735
self._convert_file_version(rev, ie, parent_invs)
1737
def _convert_file_version(self, rev, ie, parent_invs):
1738
"""Convert one version of one file.
1740
The file needs to be added into the weave if it is a merge
1741
of >=2 parents or if it's changed from its parent.
1743
file_id = ie.file_id
1744
rev_id = rev.revision_id
1745
w = self.text_weaves.get(file_id)
1748
self.text_weaves[file_id] = w
1749
text_changed = False
1750
previous_entries = ie.find_previous_heads(parent_invs,
1754
for old_revision in previous_entries:
1755
# if this fails, its a ghost ?
1756
assert old_revision in self.converted_revs, \
1757
"Revision {%s} not in converted_revs" % old_revision
1758
self.snapshot_ie(previous_entries, ie, w, rev_id)
1760
assert getattr(ie, 'revision', None) is not None
1762
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
1763
# TODO: convert this logic, which is ~= snapshot to
1764
# a call to:. This needs the path figured out. rather than a work_tree
1765
# a v4 revision_tree can be given, or something that looks enough like
1766
# one to give the file content to the entry if it needs it.
1767
# and we need something that looks like a weave store for snapshot to
1769
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
1770
if len(previous_revisions) == 1:
1771
previous_ie = previous_revisions.values()[0]
1772
if ie._unchanged(previous_ie):
1773
ie.revision = previous_ie.revision
1776
text = self.branch.repository.text_store.get(ie.text_id)
1777
file_lines = text.readlines()
1778
assert sha_strings(file_lines) == ie.text_sha1
1779
assert sum(map(len, file_lines)) == ie.text_size
1780
w.add_lines(rev_id, previous_revisions, file_lines)
1781
self.text_count += 1
1783
w.add_lines(rev_id, previous_revisions, [])
1784
ie.revision = rev_id
1786
def _make_order(self):
1787
"""Return a suitable order for importing revisions.
1789
The order must be such that an revision is imported after all
1790
its (present) parents.
1792
todo = set(self.revisions.keys())
1793
done = self.absent_revisions.copy()
1796
# scan through looking for a revision whose parents
1798
for rev_id in sorted(list(todo)):
1799
rev = self.revisions[rev_id]
1800
parent_ids = set(rev.parent_ids)
1801
if parent_ids.issubset(done):
1802
# can take this one now
1803
order.append(rev_id)
1809
class ConvertBzrDir5To6(Converter):
1810
"""Converts format 5 bzr dirs to format 6."""
1812
def convert(self, to_convert, pb):
1813
"""See Converter.convert()."""
1814
self.bzrdir = to_convert
1816
self.pb.note('starting upgrade from format 5 to 6')
1817
self._convert_to_prefixed()
1818
return BzrDir.open(self.bzrdir.root_transport.base)
1820
def _convert_to_prefixed(self):
1821
from bzrlib.store import TransportStore
1822
self.bzrdir.transport.delete('branch-format')
1823
for store_name in ["weaves", "revision-store"]:
1824
self.pb.note("adding prefixes to %s" % store_name)
1825
store_transport = self.bzrdir.transport.clone(store_name)
1826
store = TransportStore(store_transport, prefixed=True)
1827
for urlfilename in store_transport.list_dir('.'):
1828
filename = urlutils.unescape(urlfilename)
1829
if (filename.endswith(".weave") or
1830
filename.endswith(".gz") or
1831
filename.endswith(".sig")):
1832
file_id = os.path.splitext(filename)[0]
1835
prefix_dir = store.hash_prefix(file_id)
1836
# FIXME keep track of the dirs made RBC 20060121
1838
store_transport.move(filename, prefix_dir + '/' + filename)
1839
except errors.NoSuchFile: # catches missing dirs strangely enough
1840
store_transport.mkdir(prefix_dir)
1841
store_transport.move(filename, prefix_dir + '/' + filename)
1842
self.bzrdir._control_files.put_utf8('branch-format', BzrDirFormat6().get_format_string())
1845
class ConvertBzrDir6ToMeta(Converter):
1846
"""Converts format 6 bzr dirs to metadirs."""
1848
def convert(self, to_convert, pb):
1849
"""See Converter.convert()."""
1850
from bzrlib.branch import BzrBranchFormat5
1851
self.bzrdir = to_convert
1854
self.total = 20 # the steps we know about
1855
self.garbage_inventories = []
1857
self.pb.note('starting upgrade from format 6 to metadir')
1858
self.bzrdir._control_files.put_utf8('branch-format', "Converting to format 6")
1859
# its faster to move specific files around than to open and use the apis...
1860
# first off, nuke ancestry.weave, it was never used.
1862
self.step('Removing ancestry.weave')
1863
self.bzrdir.transport.delete('ancestry.weave')
1864
except errors.NoSuchFile:
1866
# find out whats there
1867
self.step('Finding branch files')
1868
last_revision = self.bzrdir.open_branch().last_revision()
1869
bzrcontents = self.bzrdir.transport.list_dir('.')
1870
for name in bzrcontents:
1871
if name.startswith('basis-inventory.'):
1872
self.garbage_inventories.append(name)
1873
# create new directories for repository, working tree and branch
1874
self.dir_mode = self.bzrdir._control_files._dir_mode
1875
self.file_mode = self.bzrdir._control_files._file_mode
1876
repository_names = [('inventory.weave', True),
1877
('revision-store', True),
1879
self.step('Upgrading repository ')
1880
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
1881
self.make_lock('repository')
1882
# we hard code the formats here because we are converting into
1883
# the meta format. The meta format upgrader can take this to a
1884
# future format within each component.
1885
self.put_format('repository', _mod_repository.RepositoryFormat7())
1886
for entry in repository_names:
1887
self.move_entry('repository', entry)
1889
self.step('Upgrading branch ')
1890
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
1891
self.make_lock('branch')
1892
self.put_format('branch', BzrBranchFormat5())
1893
branch_files = [('revision-history', True),
1894
('branch-name', True),
1896
for entry in branch_files:
1897
self.move_entry('branch', entry)
1899
checkout_files = [('pending-merges', True),
1900
('inventory', True),
1901
('stat-cache', False)]
1902
# If a mandatory checkout file is not present, the branch does not have
1903
# a functional checkout. Do not create a checkout in the converted
1905
for name, mandatory in checkout_files:
1906
if mandatory and name not in bzrcontents:
1907
has_checkout = False
1911
if not has_checkout:
1912
self.pb.note('No working tree.')
1913
# If some checkout files are there, we may as well get rid of them.
1914
for name, mandatory in checkout_files:
1915
if name in bzrcontents:
1916
self.bzrdir.transport.delete(name)
1918
from bzrlib.workingtree import WorkingTreeFormat3
1919
self.step('Upgrading working tree')
1920
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
1921
self.make_lock('checkout')
1923
'checkout', WorkingTreeFormat3())
1924
self.bzrdir.transport.delete_multi(
1925
self.garbage_inventories, self.pb)
1926
for entry in checkout_files:
1927
self.move_entry('checkout', entry)
1928
if last_revision is not None:
1929
self.bzrdir._control_files.put_utf8(
1930
'checkout/last-revision', last_revision)
1931
self.bzrdir._control_files.put_utf8(
1932
'branch-format', BzrDirMetaFormat1().get_format_string())
1933
return BzrDir.open(self.bzrdir.root_transport.base)
1935
def make_lock(self, name):
1936
"""Make a lock for the new control dir name."""
1937
self.step('Make %s lock' % name)
1938
ld = lockdir.LockDir(self.bzrdir.transport,
1940
file_modebits=self.file_mode,
1941
dir_modebits=self.dir_mode)
1944
def move_entry(self, new_dir, entry):
1945
"""Move then entry name into new_dir."""
1947
mandatory = entry[1]
1948
self.step('Moving %s' % name)
1950
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
1951
except errors.NoSuchFile:
1955
def put_format(self, dirname, format):
1956
self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
1959
class ConvertMetaToMeta(Converter):
1960
"""Converts the components of metadirs."""
1962
def __init__(self, target_format):
1963
"""Create a metadir to metadir converter.
1965
:param target_format: The final metadir format that is desired.
1967
self.target_format = target_format
1969
def convert(self, to_convert, pb):
1970
"""See Converter.convert()."""
1971
self.bzrdir = to_convert
1975
self.step('checking repository format')
1977
repo = self.bzrdir.open_repository()
1978
except errors.NoRepositoryPresent:
1981
if not isinstance(repo._format, self.target_format.repository_format.__class__):
1982
from bzrlib.repository import CopyConverter
1983
self.pb.note('starting repository conversion')
1984
converter = CopyConverter(self.target_format.repository_format)
1985
converter.convert(repo, pb)
1989
class BzrDirFormatInfo(object):
1991
def __init__(self, native, deprecated):
1992
self.deprecated = deprecated
1993
self.native = native
1996
class BzrDirFormatRegistry(registry.Registry):
1997
"""Registry of user-selectable BzrDir subformats.
1999
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
2000
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
2003
def register_metadir(self, key, repo, help, native=True, deprecated=False,
2004
branch_format=None):
2005
"""Register a metadir subformat.
2007
repo is the repository format name as a string.
2009
# This should be expanded to support setting WorkingTree and Branch
2010
# formats, once BzrDirMetaFormat1 supports that.
2012
import bzrlib.repository
2013
import bzrlib.branch
2014
repo_format = getattr(bzrlib.repository, repo)
2015
bd = BzrDirMetaFormat1()
2016
bd.repository_format = repo_format()
2017
if branch_format is not None:
2018
bd.branch_format = getattr(bzrlib.branch, branch_format)()
2020
self.register(key, helper, help, native, deprecated)
2022
def register(self, key, factory, help, native=True, deprecated=False):
2023
"""Register a BzrDirFormat factory.
2025
The factory must be a callable that takes one parameter: the key.
2026
It must produce an instance of the BzrDirFormat when called.
2028
This function mainly exists to prevent the info object from being
2031
registry.Registry.register(self, key, factory, help,
2032
BzrDirFormatInfo(native, deprecated))
2034
def register_lazy(self, key, module_name, member_name, help, native=True,
2036
registry.Registry.register_lazy(self, key, module_name, member_name,
2037
help, BzrDirFormatInfo(native, deprecated))
2039
def set_default(self, key):
2040
"""Set the 'default' key to be a clone of the supplied key.
2042
This method must be called once and only once.
2044
registry.Registry.register(self, 'default', self.get(key),
2045
self.get_help(key), info=self.get_info(key))
2047
def set_default_repository(self, key):
2048
"""Set the FormatRegistry default and Repository default.
2050
This is a transitional method while Repository.set_default_format
2053
if 'default' in self:
2054
self.remove('default')
2055
self.set_default(key)
2056
format = self.get('default')()
2057
assert isinstance(format, BzrDirMetaFormat1)
2059
def make_bzrdir(self, key):
2060
return self.get(key)()
2062
def help_topic(self, topic):
2063
output = textwrap.dedent("""\
2064
Bazaar directory formats
2065
------------------------
2067
These formats can be used for creating branches, working trees, and
2071
default_help = self.get_help('default')
2073
for key in self.keys():
2074
if key == 'default':
2076
help = self.get_help(key)
2077
if help == default_help:
2078
default_realkey = key
2080
help_pairs.append((key, help))
2082
def wrapped(key, help, info):
2084
help = '(native) ' + help
2085
return ' %s:\n%s\n\n' % (key,
2086
textwrap.fill(help, initial_indent=' ',
2087
subsequent_indent=' '))
2088
output += wrapped('%s/default' % default_realkey, default_help,
2089
self.get_info('default'))
2090
deprecated_pairs = []
2091
for key, help in help_pairs:
2092
info = self.get_info(key)
2094
deprecated_pairs.append((key, help))
2096
output += wrapped(key, help, info)
2097
if len(deprecated_pairs) > 0:
2098
output += "Deprecated formats\n------------------\n\n"
2099
for key, help in deprecated_pairs:
2100
info = self.get_info(key)
2101
output += wrapped(key, help, info)
2106
format_registry = BzrDirFormatRegistry()
2107
format_registry.register('weave', BzrDirFormat6,
2108
'Pre-0.8 format. Slower than knit and does not'
2109
' support checkouts or shared repositories.', deprecated=True)
2110
format_registry.register_metadir('knit', 'RepositoryFormatKnit1',
2111
'Format using knits. Recommended.', branch_format='BzrBranchFormat5')
2112
format_registry.register_metadir('metaweave', 'RepositoryFormat7',
2113
'Transitional format in 0.8. Slower than knit.',
2114
branch_format='BzrBranchFormat5',
2116
format_registry.register_metadir('experimental-knit2', 'RepositoryFormatKnit2',
2117
'Experimental successor to knit. Use at your own risk.',
2118
branch_format='BzrBranchFormat5')
2119
format_registry.register_metadir('experimental-branch6',
2120
'RepositoryFormatKnit2',
2121
'Experimental successor to knit. Use at your own risk.',
2122
branch_format='BzrBranchFormat6')
2123
format_registry.set_default('experimental-branch6')
added
removed
bzrlib/bzrdir.py
