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
from bzrlib.branch import BranchFormat
930
return BranchFormat.get_default_format().initialize(self)
932
def create_repository(self, shared=False):
933
"""See BzrDir.create_repository."""
934
return self._format.repository_format.initialize(self, shared)
936
def create_workingtree(self, revision_id=None):
937
"""See BzrDir.create_workingtree."""
938
from bzrlib.workingtree import WorkingTreeFormat
939
return WorkingTreeFormat.get_default_format().initialize(self, revision_id)
941
def destroy_workingtree(self):
942
"""See BzrDir.destroy_workingtree."""
943
wt = self.open_workingtree()
944
repository = wt.branch.repository
945
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
946
wt.revert([], old_tree=empty)
947
self.destroy_workingtree_metadata()
949
def destroy_workingtree_metadata(self):
950
self.transport.delete_tree('checkout')
952
def _get_mkdir_mode(self):
953
"""Figure out the mode to use when creating a bzrdir subdir."""
954
temp_control = lockable_files.LockableFiles(self.transport, '',
955
lockable_files.TransportLock)
956
return temp_control._dir_mode
958
def get_branch_transport(self, branch_format):
959
"""See BzrDir.get_branch_transport()."""
960
if branch_format is None:
961
return self.transport.clone('branch')
963
branch_format.get_format_string()
964
except NotImplementedError:
965
raise errors.IncompatibleFormat(branch_format, self._format)
967
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
968
except errors.FileExists:
970
return self.transport.clone('branch')
972
def get_repository_transport(self, repository_format):
973
"""See BzrDir.get_repository_transport()."""
974
if repository_format is None:
975
return self.transport.clone('repository')
977
repository_format.get_format_string()
978
except NotImplementedError:
979
raise errors.IncompatibleFormat(repository_format, self._format)
981
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
982
except errors.FileExists:
984
return self.transport.clone('repository')
986
def get_workingtree_transport(self, workingtree_format):
987
"""See BzrDir.get_workingtree_transport()."""
988
if workingtree_format is None:
989
return self.transport.clone('checkout')
991
workingtree_format.get_format_string()
992
except NotImplementedError:
993
raise errors.IncompatibleFormat(workingtree_format, self._format)
995
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
996
except errors.FileExists:
998
return self.transport.clone('checkout')
1000
def needs_format_conversion(self, format=None):
1001
"""See BzrDir.needs_format_conversion()."""
1003
format = BzrDirFormat.get_default_format()
1004
if not isinstance(self._format, format.__class__):
1005
# it is not a meta dir format, conversion is needed.
1007
# we might want to push this down to the repository?
1009
if not isinstance(self.open_repository()._format,
1010
format.repository_format.__class__):
1011
# the repository needs an upgrade.
1013
except errors.NoRepositoryPresent:
1015
# currently there are no other possible conversions for meta1 formats.
1018
def open_branch(self, unsupported=False):
1019
"""See BzrDir.open_branch."""
1020
from bzrlib.branch import BranchFormat
1021
format = BranchFormat.find_format(self)
1022
self._check_supported(format, unsupported)
1023
return format.open(self, _found=True)
1025
def open_repository(self, unsupported=False):
1026
"""See BzrDir.open_repository."""
1027
from bzrlib.repository import RepositoryFormat
1028
format = RepositoryFormat.find_format(self)
1029
self._check_supported(format, unsupported)
1030
return format.open(self, _found=True)
1032
def open_workingtree(self, unsupported=False):
1033
"""See BzrDir.open_workingtree."""
1034
from bzrlib.workingtree import WorkingTreeFormat
1035
format = WorkingTreeFormat.find_format(self)
1036
self._check_supported(format, unsupported)
1037
return format.open(self, _found=True)
1040
class BzrDirFormat(object):
1041
"""An encapsulation of the initialization and open routines for a format.
1043
Formats provide three things:
1044
* An initialization routine,
1048
Formats are placed in an dict by their format string for reference
1049
during bzrdir opening. These should be subclasses of BzrDirFormat
1052
Once a format is deprecated, just deprecate the initialize and open
1053
methods on the format class. Do not deprecate the object, as the
1054
object will be created every system load.
1057
_default_format = None
1058
"""The default format used for new .bzr dirs."""
1061
"""The known formats."""
1063
_control_formats = []
1064
"""The registered control formats - .bzr, ....
1066
This is a list of BzrDirFormat objects.
1069
_lock_file_name = 'branch-lock'
1071
# _lock_class must be set in subclasses to the lock type, typ.
1072
# TransportLock or LockDir
1075
def find_format(klass, transport):
1076
"""Return the format present at transport."""
1077
for format in klass._control_formats:
1079
return format.probe_transport(transport)
1080
except errors.NotBranchError:
1081
# this format does not find a control dir here.
1083
raise errors.NotBranchError(path=transport.base)
1086
def probe_transport(klass, transport):
1087
"""Return the .bzrdir style transport present at URL."""
1089
format_string = transport.get(".bzr/branch-format").read()
1090
except errors.NoSuchFile:
1091
raise errors.NotBranchError(path=transport.base)
1094
return klass._formats[format_string]
1096
raise errors.UnknownFormatError(format=format_string)
1099
def get_default_format(klass):
1100
"""Return the current default format."""
1101
return klass._default_format
1103
def get_format_string(self):
1104
"""Return the ASCII format string that identifies this format."""
1105
raise NotImplementedError(self.get_format_string)
1107
def get_format_description(self):
1108
"""Return the short description for this format."""
1109
raise NotImplementedError(self.get_format_description)
1111
def get_converter(self, format=None):
1112
"""Return the converter to use to convert bzrdirs needing converts.
1114
This returns a bzrlib.bzrdir.Converter object.
1116
This should return the best upgrader to step this format towards the
1117
current default format. In the case of plugins we can/should provide
1118
some means for them to extend the range of returnable converters.
1120
:param format: Optional format to override the default format of the
1123
raise NotImplementedError(self.get_converter)
1125
def initialize(self, url):
1126
"""Create a bzr control dir at this url and return an opened copy.
1128
Subclasses should typically override initialize_on_transport
1129
instead of this method.
1131
return self.initialize_on_transport(get_transport(url))
1133
def initialize_on_transport(self, transport):
1134
"""Initialize a new bzrdir in the base directory of a Transport."""
1135
# Since we don't have a .bzr directory, inherit the
1136
# mode from the root directory
1137
temp_control = lockable_files.LockableFiles(transport,
1138
'', lockable_files.TransportLock)
1139
temp_control._transport.mkdir('.bzr',
1140
# FIXME: RBC 20060121 don't peek under
1142
mode=temp_control._dir_mode)
1143
file_mode = temp_control._file_mode
1145
mutter('created control directory in ' + transport.base)
1146
control = transport.clone('.bzr')
1147
utf8_files = [('README',
1148
"This is a Bazaar-NG control directory.\n"
1149
"Do not change any files in this directory.\n"),
1150
('branch-format', self.get_format_string()),
1152
# NB: no need to escape relative paths that are url safe.
1153
control_files = lockable_files.LockableFiles(control,
1154
self._lock_file_name, self._lock_class)
1155
control_files.create_lock()
1156
control_files.lock_write()
1158
for file, content in utf8_files:
1159
control_files.put_utf8(file, content)
1161
control_files.unlock()
1162
return self.open(transport, _found=True)
1164
def is_supported(self):
1165
"""Is this format supported?
1167
Supported formats must be initializable and openable.
1168
Unsupported formats may not support initialization or committing or
1169
some other features depending on the reason for not being supported.
1173
def same_model(self, target_format):
1174
return (self.repository_format.rich_root_data ==
1175
target_format.rich_root_data)
1178
def known_formats(klass):
1179
"""Return all the known formats.
1181
Concrete formats should override _known_formats.
1183
# There is double indirection here to make sure that control
1184
# formats used by more than one dir format will only be probed
1185
# once. This can otherwise be quite expensive for remote connections.
1187
for format in klass._control_formats:
1188
result.update(format._known_formats())
1192
def _known_formats(klass):
1193
"""Return the known format instances for this control format."""
1194
return set(klass._formats.values())
1196
def open(self, transport, _found=False):
1197
"""Return an instance of this format for the dir transport points at.
1199
_found is a private parameter, do not use it.
1202
found_format = BzrDirFormat.find_format(transport)
1203
if not isinstance(found_format, self.__class__):
1204
raise AssertionError("%s was asked to open %s, but it seems to need "
1206
% (self, transport, found_format))
1207
return self._open(transport)
1209
def _open(self, transport):
1210
"""Template method helper for opening BzrDirectories.
1212
This performs the actual open and any additional logic or parameter
1215
raise NotImplementedError(self._open)
1218
def register_format(klass, format):
1219
klass._formats[format.get_format_string()] = format
1222
def register_control_format(klass, format):
1223
"""Register a format that does not use '.bzrdir' for its control dir.
1225
TODO: This should be pulled up into a 'ControlDirFormat' base class
1226
which BzrDirFormat can inherit from, and renamed to register_format
1227
there. It has been done without that for now for simplicity of
1230
klass._control_formats.append(format)
1233
@symbol_versioning.deprecated_method(symbol_versioning.zero_fourteen)
1234
def set_default_format(klass, format):
1235
klass._set_default_format(format)
1238
def _set_default_format(klass, format):
1239
"""Set default format (for testing behavior of defaults only)"""
1240
klass._default_format = format
1243
return self.get_format_string()[:-1]
1246
def unregister_format(klass, format):
1247
assert klass._formats[format.get_format_string()] is format
1248
del klass._formats[format.get_format_string()]
1251
def unregister_control_format(klass, format):
1252
klass._control_formats.remove(format)
1255
# register BzrDirFormat as a control format
1256
BzrDirFormat.register_control_format(BzrDirFormat)
1259
class BzrDirFormat4(BzrDirFormat):
1260
"""Bzr dir format 4.
1262
This format is a combined format for working tree, branch and repository.
1264
- Format 1 working trees [always]
1265
- Format 4 branches [always]
1266
- Format 4 repositories [always]
1268
This format is deprecated: it indexes texts using a text it which is
1269
removed in format 5; write support for this format has been removed.
1272
_lock_class = lockable_files.TransportLock
1274
def get_format_string(self):
1275
"""See BzrDirFormat.get_format_string()."""
1276
return "Bazaar-NG branch, format 0.0.4\n"
1278
def get_format_description(self):
1279
"""See BzrDirFormat.get_format_description()."""
1280
return "All-in-one format 4"
1282
def get_converter(self, format=None):
1283
"""See BzrDirFormat.get_converter()."""
1284
# there is one and only one upgrade path here.
1285
return ConvertBzrDir4To5()
1287
def initialize_on_transport(self, transport):
1288
"""Format 4 branches cannot be created."""
1289
raise errors.UninitializableFormat(self)
1291
def is_supported(self):
1292
"""Format 4 is not supported.
1294
It is not supported because the model changed from 4 to 5 and the
1295
conversion logic is expensive - so doing it on the fly was not
1300
def _open(self, transport):
1301
"""See BzrDirFormat._open."""
1302
return BzrDir4(transport, self)
1304
def __return_repository_format(self):
1305
"""Circular import protection."""
1306
from bzrlib.repository import RepositoryFormat4
1307
return RepositoryFormat4()
1308
repository_format = property(__return_repository_format)
1311
class BzrDirFormat5(BzrDirFormat):
1312
"""Bzr control format 5.
1314
This format is a combined format for working tree, branch and repository.
1316
- Format 2 working trees [always]
1317
- Format 4 branches [always]
1318
- Format 5 repositories [always]
1319
Unhashed stores in the repository.
1322
_lock_class = lockable_files.TransportLock
1324
def get_format_string(self):
1325
"""See BzrDirFormat.get_format_string()."""
1326
return "Bazaar-NG branch, format 5\n"
1328
def get_format_description(self):
1329
"""See BzrDirFormat.get_format_description()."""
1330
return "All-in-one format 5"
1332
def get_converter(self, format=None):
1333
"""See BzrDirFormat.get_converter()."""
1334
# there is one and only one upgrade path here.
1335
return ConvertBzrDir5To6()
1337
def _initialize_for_clone(self, url):
1338
return self.initialize_on_transport(get_transport(url), _cloning=True)
1340
def initialize_on_transport(self, transport, _cloning=False):
1341
"""Format 5 dirs always have working tree, branch and repository.
1343
Except when they are being cloned.
1345
from bzrlib.branch import BzrBranchFormat4
1346
from bzrlib.repository import RepositoryFormat5
1347
from bzrlib.workingtree import WorkingTreeFormat2
1348
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1349
RepositoryFormat5().initialize(result, _internal=True)
1351
branch = BzrBranchFormat4().initialize(result)
1353
WorkingTreeFormat2().initialize(result)
1354
except errors.NotLocalUrl:
1355
# Even though we can't access the working tree, we need to
1356
# create its control files.
1357
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1360
def _open(self, transport):
1361
"""See BzrDirFormat._open."""
1362
return BzrDir5(transport, self)
1364
def __return_repository_format(self):
1365
"""Circular import protection."""
1366
from bzrlib.repository import RepositoryFormat5
1367
return RepositoryFormat5()
1368
repository_format = property(__return_repository_format)
1371
class BzrDirFormat6(BzrDirFormat):
1372
"""Bzr control format 6.
1374
This format is a combined format for working tree, branch and repository.
1376
- Format 2 working trees [always]
1377
- Format 4 branches [always]
1378
- Format 6 repositories [always]
1381
_lock_class = lockable_files.TransportLock
1383
def get_format_string(self):
1384
"""See BzrDirFormat.get_format_string()."""
1385
return "Bazaar-NG branch, format 6\n"
1387
def get_format_description(self):
1388
"""See BzrDirFormat.get_format_description()."""
1389
return "All-in-one format 6"
1391
def get_converter(self, format=None):
1392
"""See BzrDirFormat.get_converter()."""
1393
# there is one and only one upgrade path here.
1394
return ConvertBzrDir6ToMeta()
1396
def _initialize_for_clone(self, url):
1397
return self.initialize_on_transport(get_transport(url), _cloning=True)
1399
def initialize_on_transport(self, transport, _cloning=False):
1400
"""Format 6 dirs always have working tree, branch and repository.
1402
Except when they are being cloned.
1404
from bzrlib.branch import BzrBranchFormat4
1405
from bzrlib.repository import RepositoryFormat6
1406
from bzrlib.workingtree import WorkingTreeFormat2
1407
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1408
RepositoryFormat6().initialize(result, _internal=True)
1410
branch = BzrBranchFormat4().initialize(result)
1412
WorkingTreeFormat2().initialize(result)
1413
except errors.NotLocalUrl:
1414
# Even though we can't access the working tree, we need to
1415
# create its control files.
1416
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1419
def _open(self, transport):
1420
"""See BzrDirFormat._open."""
1421
return BzrDir6(transport, self)
1423
def __return_repository_format(self):
1424
"""Circular import protection."""
1425
from bzrlib.repository import RepositoryFormat6
1426
return RepositoryFormat6()
1427
repository_format = property(__return_repository_format)
1430
class BzrDirMetaFormat1(BzrDirFormat):
1431
"""Bzr meta control format 1
1433
This is the first format with split out working tree, branch and repository
1436
- Format 3 working trees [optional]
1437
- Format 5 branches [optional]
1438
- Format 7 repositories [optional]
1441
_lock_class = lockdir.LockDir
1443
def get_converter(self, format=None):
1444
"""See BzrDirFormat.get_converter()."""
1446
format = BzrDirFormat.get_default_format()
1447
if not isinstance(self, format.__class__):
1448
# converting away from metadir is not implemented
1449
raise NotImplementedError(self.get_converter)
1450
return ConvertMetaToMeta(format)
1452
def get_format_string(self):
1453
"""See BzrDirFormat.get_format_string()."""
1454
return "Bazaar-NG meta directory, format 1\n"
1456
def get_format_description(self):
1457
"""See BzrDirFormat.get_format_description()."""
1458
return "Meta directory format 1"
1460
def _open(self, transport):
1461
"""See BzrDirFormat._open."""
1462
return BzrDirMeta1(transport, self)
1464
def __return_repository_format(self):
1465
"""Circular import protection."""
1466
if getattr(self, '_repository_format', None):
1467
return self._repository_format
1468
from bzrlib.repository import RepositoryFormat
1469
return RepositoryFormat.get_default_format()
1471
def __set_repository_format(self, value):
1472
"""Allow changint the repository format for metadir formats."""
1473
self._repository_format = value
1475
repository_format = property(__return_repository_format, __set_repository_format)
1478
BzrDirFormat.register_format(BzrDirFormat4())
1479
BzrDirFormat.register_format(BzrDirFormat5())
1480
BzrDirFormat.register_format(BzrDirFormat6())
1481
__default_format = BzrDirMetaFormat1()
1482
BzrDirFormat.register_format(__default_format)
1483
BzrDirFormat._default_format = __default_format
1486
class BzrDirTestProviderAdapter(object):
1487
"""A tool to generate a suite testing multiple bzrdir formats at once.
1489
This is done by copying the test once for each transport and injecting
1490
the transport_server, transport_readonly_server, and bzrdir_format
1491
classes into each copy. Each copy is also given a new id() to make it
1495
def __init__(self, transport_server, transport_readonly_server, formats):
1496
self._transport_server = transport_server
1497
self._transport_readonly_server = transport_readonly_server
1498
self._formats = formats
1500
def adapt(self, test):
1501
result = unittest.TestSuite()
1502
for format in self._formats:
1503
new_test = deepcopy(test)
1504
new_test.transport_server = self._transport_server
1505
new_test.transport_readonly_server = self._transport_readonly_server
1506
new_test.bzrdir_format = format
1507
def make_new_test_id():
1508
new_id = "%s(%s)" % (new_test.id(), format.__class__.__name__)
1509
return lambda: new_id
1510
new_test.id = make_new_test_id()
1511
result.addTest(new_test)
1515
class Converter(object):
1516
"""Converts a disk format object from one format to another."""
1518
def convert(self, to_convert, pb):
1519
"""Perform the conversion of to_convert, giving feedback via pb.
1521
:param to_convert: The disk object to convert.
1522
:param pb: a progress bar to use for progress information.
1525
def step(self, message):
1526
"""Update the pb by a step."""
1528
self.pb.update(message, self.count, self.total)
1531
class ConvertBzrDir4To5(Converter):
1532
"""Converts format 4 bzr dirs to format 5."""
1535
super(ConvertBzrDir4To5, self).__init__()
1536
self.converted_revs = set()
1537
self.absent_revisions = set()
1541
def convert(self, to_convert, pb):
1542
"""See Converter.convert()."""
1543
self.bzrdir = to_convert
1545
self.pb.note('starting upgrade from format 4 to 5')
1546
if isinstance(self.bzrdir.transport, LocalTransport):
1547
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
1548
self._convert_to_weaves()
1549
return BzrDir.open(self.bzrdir.root_transport.base)
1551
def _convert_to_weaves(self):
1552
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
1555
stat = self.bzrdir.transport.stat('weaves')
1556
if not S_ISDIR(stat.st_mode):
1557
self.bzrdir.transport.delete('weaves')
1558
self.bzrdir.transport.mkdir('weaves')
1559
except errors.NoSuchFile:
1560
self.bzrdir.transport.mkdir('weaves')
1561
# deliberately not a WeaveFile as we want to build it up slowly.
1562
self.inv_weave = Weave('inventory')
1563
# holds in-memory weaves for all files
1564
self.text_weaves = {}
1565
self.bzrdir.transport.delete('branch-format')
1566
self.branch = self.bzrdir.open_branch()
1567
self._convert_working_inv()
1568
rev_history = self.branch.revision_history()
1569
# to_read is a stack holding the revisions we still need to process;
1570
# appending to it adds new highest-priority revisions
1571
self.known_revisions = set(rev_history)
1572
self.to_read = rev_history[-1:]
1574
rev_id = self.to_read.pop()
1575
if (rev_id not in self.revisions
1576
and rev_id not in self.absent_revisions):
1577
self._load_one_rev(rev_id)
1579
to_import = self._make_order()
1580
for i, rev_id in enumerate(to_import):
1581
self.pb.update('converting revision', i, len(to_import))
1582
self._convert_one_rev(rev_id)
1584
self._write_all_weaves()
1585
self._write_all_revs()
1586
self.pb.note('upgraded to weaves:')
1587
self.pb.note(' %6d revisions and inventories', len(self.revisions))
1588
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
1589
self.pb.note(' %6d texts', self.text_count)
1590
self._cleanup_spare_files_after_format4()
1591
self.branch.control_files.put_utf8('branch-format', BzrDirFormat5().get_format_string())
1593
def _cleanup_spare_files_after_format4(self):
1594
# FIXME working tree upgrade foo.
1595
for n in 'merged-patches', 'pending-merged-patches':
1597
## assert os.path.getsize(p) == 0
1598
self.bzrdir.transport.delete(n)
1599
except errors.NoSuchFile:
1601
self.bzrdir.transport.delete_tree('inventory-store')
1602
self.bzrdir.transport.delete_tree('text-store')
1604
def _convert_working_inv(self):
1605
inv = xml4.serializer_v4.read_inventory(
1606
self.branch.control_files.get('inventory'))
1607
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
1608
# FIXME inventory is a working tree change.
1609
self.branch.control_files.put('inventory', StringIO(new_inv_xml))
1611
def _write_all_weaves(self):
1612
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
1613
weave_transport = self.bzrdir.transport.clone('weaves')
1614
weaves = WeaveStore(weave_transport, prefixed=False)
1615
transaction = WriteTransaction()
1619
for file_id, file_weave in self.text_weaves.items():
1620
self.pb.update('writing weave', i, len(self.text_weaves))
1621
weaves._put_weave(file_id, file_weave, transaction)
1623
self.pb.update('inventory', 0, 1)
1624
controlweaves._put_weave('inventory', self.inv_weave, transaction)
1625
self.pb.update('inventory', 1, 1)
1629
def _write_all_revs(self):
1630
"""Write all revisions out in new form."""
1631
self.bzrdir.transport.delete_tree('revision-store')
1632
self.bzrdir.transport.mkdir('revision-store')
1633
revision_transport = self.bzrdir.transport.clone('revision-store')
1635
_revision_store = TextRevisionStore(TextStore(revision_transport,
1639
transaction = WriteTransaction()
1640
for i, rev_id in enumerate(self.converted_revs):
1641
self.pb.update('write revision', i, len(self.converted_revs))
1642
_revision_store.add_revision(self.revisions[rev_id], transaction)
1646
def _load_one_rev(self, rev_id):
1647
"""Load a revision object into memory.
1649
Any parents not either loaded or abandoned get queued to be
1651
self.pb.update('loading revision',
1652
len(self.revisions),
1653
len(self.known_revisions))
1654
if not self.branch.repository.has_revision(rev_id):
1656
self.pb.note('revision {%s} not present in branch; '
1657
'will be converted as a ghost',
1659
self.absent_revisions.add(rev_id)
1661
rev = self.branch.repository._revision_store.get_revision(rev_id,
1662
self.branch.repository.get_transaction())
1663
for parent_id in rev.parent_ids:
1664
self.known_revisions.add(parent_id)
1665
self.to_read.append(parent_id)
1666
self.revisions[rev_id] = rev
1668
def _load_old_inventory(self, rev_id):
1669
assert rev_id not in self.converted_revs
1670
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
1671
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
1672
inv.revision_id = rev_id
1673
rev = self.revisions[rev_id]
1674
if rev.inventory_sha1:
1675
assert rev.inventory_sha1 == sha_string(old_inv_xml), \
1676
'inventory sha mismatch for {%s}' % rev_id
1679
def _load_updated_inventory(self, rev_id):
1680
assert rev_id in self.converted_revs
1681
inv_xml = self.inv_weave.get_text(rev_id)
1682
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml)
1685
def _convert_one_rev(self, rev_id):
1686
"""Convert revision and all referenced objects to new format."""
1687
rev = self.revisions[rev_id]
1688
inv = self._load_old_inventory(rev_id)
1689
present_parents = [p for p in rev.parent_ids
1690
if p not in self.absent_revisions]
1691
self._convert_revision_contents(rev, inv, present_parents)
1692
self._store_new_weave(rev, inv, present_parents)
1693
self.converted_revs.add(rev_id)
1695
def _store_new_weave(self, rev, inv, present_parents):
1696
# the XML is now updated with text versions
1698
entries = inv.iter_entries()
1700
for path, ie in entries:
1701
assert getattr(ie, 'revision', None) is not None, \
1702
'no revision on {%s} in {%s}' % \
1703
(file_id, rev.revision_id)
1704
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
1705
new_inv_sha1 = sha_string(new_inv_xml)
1706
self.inv_weave.add_lines(rev.revision_id,
1708
new_inv_xml.splitlines(True))
1709
rev.inventory_sha1 = new_inv_sha1
1711
def _convert_revision_contents(self, rev, inv, present_parents):
1712
"""Convert all the files within a revision.
1714
Also upgrade the inventory to refer to the text revision ids."""
1715
rev_id = rev.revision_id
1716
mutter('converting texts of revision {%s}',
1718
parent_invs = map(self._load_updated_inventory, present_parents)
1719
entries = inv.iter_entries()
1721
for path, ie in entries:
1722
self._convert_file_version(rev, ie, parent_invs)
1724
def _convert_file_version(self, rev, ie, parent_invs):
1725
"""Convert one version of one file.
1727
The file needs to be added into the weave if it is a merge
1728
of >=2 parents or if it's changed from its parent.
1730
file_id = ie.file_id
1731
rev_id = rev.revision_id
1732
w = self.text_weaves.get(file_id)
1735
self.text_weaves[file_id] = w
1736
text_changed = False
1737
previous_entries = ie.find_previous_heads(parent_invs,
1741
for old_revision in previous_entries:
1742
# if this fails, its a ghost ?
1743
assert old_revision in self.converted_revs, \
1744
"Revision {%s} not in converted_revs" % old_revision
1745
self.snapshot_ie(previous_entries, ie, w, rev_id)
1747
assert getattr(ie, 'revision', None) is not None
1749
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
1750
# TODO: convert this logic, which is ~= snapshot to
1751
# a call to:. This needs the path figured out. rather than a work_tree
1752
# a v4 revision_tree can be given, or something that looks enough like
1753
# one to give the file content to the entry if it needs it.
1754
# and we need something that looks like a weave store for snapshot to
1756
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
1757
if len(previous_revisions) == 1:
1758
previous_ie = previous_revisions.values()[0]
1759
if ie._unchanged(previous_ie):
1760
ie.revision = previous_ie.revision
1763
text = self.branch.repository.text_store.get(ie.text_id)
1764
file_lines = text.readlines()
1765
assert sha_strings(file_lines) == ie.text_sha1
1766
assert sum(map(len, file_lines)) == ie.text_size
1767
w.add_lines(rev_id, previous_revisions, file_lines)
1768
self.text_count += 1
1770
w.add_lines(rev_id, previous_revisions, [])
1771
ie.revision = rev_id
1773
def _make_order(self):
1774
"""Return a suitable order for importing revisions.
1776
The order must be such that an revision is imported after all
1777
its (present) parents.
1779
todo = set(self.revisions.keys())
1780
done = self.absent_revisions.copy()
1783
# scan through looking for a revision whose parents
1785
for rev_id in sorted(list(todo)):
1786
rev = self.revisions[rev_id]
1787
parent_ids = set(rev.parent_ids)
1788
if parent_ids.issubset(done):
1789
# can take this one now
1790
order.append(rev_id)
1796
class ConvertBzrDir5To6(Converter):
1797
"""Converts format 5 bzr dirs to format 6."""
1799
def convert(self, to_convert, pb):
1800
"""See Converter.convert()."""
1801
self.bzrdir = to_convert
1803
self.pb.note('starting upgrade from format 5 to 6')
1804
self._convert_to_prefixed()
1805
return BzrDir.open(self.bzrdir.root_transport.base)
1807
def _convert_to_prefixed(self):
1808
from bzrlib.store import TransportStore
1809
self.bzrdir.transport.delete('branch-format')
1810
for store_name in ["weaves", "revision-store"]:
1811
self.pb.note("adding prefixes to %s" % store_name)
1812
store_transport = self.bzrdir.transport.clone(store_name)
1813
store = TransportStore(store_transport, prefixed=True)
1814
for urlfilename in store_transport.list_dir('.'):
1815
filename = urlutils.unescape(urlfilename)
1816
if (filename.endswith(".weave") or
1817
filename.endswith(".gz") or
1818
filename.endswith(".sig")):
1819
file_id = os.path.splitext(filename)[0]
1822
prefix_dir = store.hash_prefix(file_id)
1823
# FIXME keep track of the dirs made RBC 20060121
1825
store_transport.move(filename, prefix_dir + '/' + filename)
1826
except errors.NoSuchFile: # catches missing dirs strangely enough
1827
store_transport.mkdir(prefix_dir)
1828
store_transport.move(filename, prefix_dir + '/' + filename)
1829
self.bzrdir._control_files.put_utf8('branch-format', BzrDirFormat6().get_format_string())
1832
class ConvertBzrDir6ToMeta(Converter):
1833
"""Converts format 6 bzr dirs to metadirs."""
1835
def convert(self, to_convert, pb):
1836
"""See Converter.convert()."""
1837
from bzrlib.branch import BzrBranchFormat5
1838
self.bzrdir = to_convert
1841
self.total = 20 # the steps we know about
1842
self.garbage_inventories = []
1844
self.pb.note('starting upgrade from format 6 to metadir')
1845
self.bzrdir._control_files.put_utf8('branch-format', "Converting to format 6")
1846
# its faster to move specific files around than to open and use the apis...
1847
# first off, nuke ancestry.weave, it was never used.
1849
self.step('Removing ancestry.weave')
1850
self.bzrdir.transport.delete('ancestry.weave')
1851
except errors.NoSuchFile:
1853
# find out whats there
1854
self.step('Finding branch files')
1855
last_revision = self.bzrdir.open_branch().last_revision()
1856
bzrcontents = self.bzrdir.transport.list_dir('.')
1857
for name in bzrcontents:
1858
if name.startswith('basis-inventory.'):
1859
self.garbage_inventories.append(name)
1860
# create new directories for repository, working tree and branch
1861
self.dir_mode = self.bzrdir._control_files._dir_mode
1862
self.file_mode = self.bzrdir._control_files._file_mode
1863
repository_names = [('inventory.weave', True),
1864
('revision-store', True),
1866
self.step('Upgrading repository ')
1867
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
1868
self.make_lock('repository')
1869
# we hard code the formats here because we are converting into
1870
# the meta format. The meta format upgrader can take this to a
1871
# future format within each component.
1872
self.put_format('repository', _mod_repository.RepositoryFormat7())
1873
for entry in repository_names:
1874
self.move_entry('repository', entry)
1876
self.step('Upgrading branch ')
1877
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
1878
self.make_lock('branch')
1879
self.put_format('branch', BzrBranchFormat5())
1880
branch_files = [('revision-history', True),
1881
('branch-name', True),
1883
for entry in branch_files:
1884
self.move_entry('branch', entry)
1886
checkout_files = [('pending-merges', True),
1887
('inventory', True),
1888
('stat-cache', False)]
1889
# If a mandatory checkout file is not present, the branch does not have
1890
# a functional checkout. Do not create a checkout in the converted
1892
for name, mandatory in checkout_files:
1893
if mandatory and name not in bzrcontents:
1894
has_checkout = False
1898
if not has_checkout:
1899
self.pb.note('No working tree.')
1900
# If some checkout files are there, we may as well get rid of them.
1901
for name, mandatory in checkout_files:
1902
if name in bzrcontents:
1903
self.bzrdir.transport.delete(name)
1905
from bzrlib.workingtree import WorkingTreeFormat3
1906
self.step('Upgrading working tree')
1907
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
1908
self.make_lock('checkout')
1910
'checkout', WorkingTreeFormat3())
1911
self.bzrdir.transport.delete_multi(
1912
self.garbage_inventories, self.pb)
1913
for entry in checkout_files:
1914
self.move_entry('checkout', entry)
1915
if last_revision is not None:
1916
self.bzrdir._control_files.put_utf8(
1917
'checkout/last-revision', last_revision)
1918
self.bzrdir._control_files.put_utf8(
1919
'branch-format', BzrDirMetaFormat1().get_format_string())
1920
return BzrDir.open(self.bzrdir.root_transport.base)
1922
def make_lock(self, name):
1923
"""Make a lock for the new control dir name."""
1924
self.step('Make %s lock' % name)
1925
ld = lockdir.LockDir(self.bzrdir.transport,
1927
file_modebits=self.file_mode,
1928
dir_modebits=self.dir_mode)
1931
def move_entry(self, new_dir, entry):
1932
"""Move then entry name into new_dir."""
1934
mandatory = entry[1]
1935
self.step('Moving %s' % name)
1937
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
1938
except errors.NoSuchFile:
1942
def put_format(self, dirname, format):
1943
self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
1946
class ConvertMetaToMeta(Converter):
1947
"""Converts the components of metadirs."""
1949
def __init__(self, target_format):
1950
"""Create a metadir to metadir converter.
1952
:param target_format: The final metadir format that is desired.
1954
self.target_format = target_format
1956
def convert(self, to_convert, pb):
1957
"""See Converter.convert()."""
1958
self.bzrdir = to_convert
1962
self.step('checking repository format')
1964
repo = self.bzrdir.open_repository()
1965
except errors.NoRepositoryPresent:
1968
if not isinstance(repo._format, self.target_format.repository_format.__class__):
1969
from bzrlib.repository import CopyConverter
1970
self.pb.note('starting repository conversion')
1971
converter = CopyConverter(self.target_format.repository_format)
1972
converter.convert(repo, pb)
1976
class BzrDirFormatInfo(object):
1978
def __init__(self, native, deprecated):
1979
self.deprecated = deprecated
1980
self.native = native
1983
class BzrDirFormatRegistry(registry.Registry):
1984
"""Registry of user-selectable BzrDir subformats.
1986
Differs from BzrDirFormat._control_formats in that it provides sub-formats,
1987
e.g. BzrDirMeta1 with weave repository. Also, it's more user-oriented.
1990
def register_metadir(self, key, repo, help, native=True, deprecated=False):
1991
"""Register a metadir subformat.
1993
repo is the repository format name as a string.
1995
# This should be expanded to support setting WorkingTree and Branch
1996
# formats, once BzrDirMetaFormat1 supports that.
1998
import bzrlib.repository
1999
repo_format = getattr(bzrlib.repository, repo)
2000
bd = BzrDirMetaFormat1()
2001
bd.repository_format = repo_format()
2003
self.register(key, helper, help, native, deprecated)
2005
def register(self, key, factory, help, native=True, deprecated=False):
2006
"""Register a BzrDirFormat factory.
2008
The factory must be a callable that takes one parameter: the key.
2009
It must produce an instance of the BzrDirFormat when called.
2011
This function mainly exists to prevent the info object from being
2014
registry.Registry.register(self, key, factory, help,
2015
BzrDirFormatInfo(native, deprecated))
2017
def register_lazy(self, key, module_name, member_name, help, native=True,
2019
registry.Registry.register_lazy(self, key, module_name, member_name,
2020
help, BzrDirFormatInfo(native, deprecated))
2022
def set_default(self, key):
2023
"""Set the 'default' key to be a clone of the supplied key.
2025
This method must be called once and only once.
2027
registry.Registry.register(self, 'default', self.get(key),
2028
self.get_help(key), info=self.get_info(key))
2030
def set_default_repository(self, key):
2031
"""Set the FormatRegistry default and Repository default.
2033
This is a transitional method while Repository.set_default_format
2036
if 'default' in self:
2037
self.remove('default')
2038
self.set_default(key)
2039
format = self.get('default')()
2040
assert isinstance(format, BzrDirMetaFormat1)
2041
from bzrlib import repository
2042
repository.RepositoryFormat._set_default_format(
2043
format.repository_format)
2045
def make_bzrdir(self, key):
2046
return self.get(key)()
2048
def help_topic(self, topic):
2049
output = textwrap.dedent("""\
2050
Bazaar directory formats
2051
------------------------
2053
These formats can be used for creating branches, working trees, and
2057
default_help = self.get_help('default')
2059
for key in self.keys():
2060
if key == 'default':
2062
help = self.get_help(key)
2063
if help == default_help:
2064
default_realkey = key
2066
help_pairs.append((key, help))
2068
def wrapped(key, help, info):
2070
help = '(native) ' + help
2071
return ' %s:\n%s\n\n' % (key,
2072
textwrap.fill(help, initial_indent=' ',
2073
subsequent_indent=' '))
2074
output += wrapped('%s/default' % default_realkey, default_help,
2075
self.get_info('default'))
2076
deprecated_pairs = []
2077
for key, help in help_pairs:
2078
info = self.get_info(key)
2080
deprecated_pairs.append((key, help))
2082
output += wrapped(key, help, info)
2083
if len(deprecated_pairs) > 0:
2084
output += "Deprecated formats\n------------------\n\n"
2085
for key, help in deprecated_pairs:
2086
info = self.get_info(key)
2087
output += wrapped(key, help, info)
2092
format_registry = BzrDirFormatRegistry()
2093
format_registry.register('weave', BzrDirFormat6,
2094
'Pre-0.8 format. Slower than knit and does not'
2095
' support checkouts or shared repositories.', deprecated=True)
2096
format_registry.register_metadir('knit', 'RepositoryFormatKnit1',
2097
'Format using knits. Recommended.')
2098
format_registry.set_default('knit')
2099
format_registry.register_metadir('metaweave', 'RepositoryFormat7',
2100
'Transitional format in 0.8. Slower than knit.',
2102
format_registry.register_metadir('experimental-knit2', 'RepositoryFormatKnit2',
2103
'Experimental successor to knit. Use at your own risk.')
added
removed
bzrlib/bzrdir.py
