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
from copy import deepcopy
26
from cStringIO import StringIO
28
from stat import S_ISDIR
29
from unittest import TestSuite
32
import bzrlib.errors as errors
33
from bzrlib.lockable_files import LockableFiles, TransportLock
34
from bzrlib.lockdir import LockDir
35
from bzrlib.osutils import (
42
from bzrlib.store.revision.text import TextRevisionStore
43
from bzrlib.store.text import TextStore
44
from bzrlib.store.versioned import WeaveStore
45
from bzrlib.trace import mutter
46
from bzrlib.transactions import WriteTransaction
47
from bzrlib.transport import get_transport
48
from bzrlib.transport.local import LocalTransport
49
import bzrlib.urlutils as urlutils
50
from bzrlib.weave import Weave
51
from bzrlib.xml4 import serializer_v4
56
"""A .bzr control diretory.
58
BzrDir instances let you create or open any of the things that can be
59
found within .bzr - checkouts, branches and repositories.
62
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
64
a transport connected to the directory this bzr was opened from.
68
"""Invoke break_lock on the first object in the bzrdir.
70
If there is a tree, the tree is opened and break_lock() called.
71
Otherwise, branch is tried, and finally repository.
74
thing_to_unlock = self.open_workingtree()
75
except (errors.NotLocalUrl, errors.NoWorkingTree):
77
thing_to_unlock = self.open_branch()
78
except errors.NotBranchError:
80
thing_to_unlock = self.open_repository()
81
except errors.NoRepositoryPresent:
83
thing_to_unlock.break_lock()
85
def can_convert_format(self):
86
"""Return true if this bzrdir is one whose format we can convert from."""
90
def _check_supported(format, allow_unsupported):
91
"""Check whether format is a supported format.
93
If allow_unsupported is True, this is a no-op.
95
if not allow_unsupported and not format.is_supported():
96
# see open_downlevel to open legacy branches.
97
raise errors.UnsupportedFormatError(format=format)
99
def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
100
"""Clone this bzrdir and its contents to url verbatim.
102
If urls last component does not exist, it will be created.
104
if revision_id is not None, then the clone operation may tune
105
itself to download less data.
106
:param force_new_repo: Do not use a shared repository for the target
107
even if one is available.
110
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
111
result = self._format.initialize(url)
113
local_repo = self.find_repository()
114
except errors.NoRepositoryPresent:
117
# may need to copy content in
119
result_repo = local_repo.clone(
121
revision_id=revision_id,
123
result_repo.set_make_working_trees(local_repo.make_working_trees())
126
result_repo = result.find_repository()
127
# fetch content this dir needs.
129
# XXX FIXME RBC 20060214 need tests for this when the basis
131
result_repo.fetch(basis_repo, revision_id=revision_id)
132
result_repo.fetch(local_repo, revision_id=revision_id)
133
except errors.NoRepositoryPresent:
134
# needed to make one anyway.
135
result_repo = local_repo.clone(
137
revision_id=revision_id,
139
result_repo.set_make_working_trees(local_repo.make_working_trees())
140
# 1 if there is a branch present
141
# make sure its content is available in the target repository
144
self.open_branch().clone(result, revision_id=revision_id)
145
except errors.NotBranchError:
148
self.open_workingtree().clone(result, basis=basis_tree)
149
except (errors.NoWorkingTree, errors.NotLocalUrl):
153
def _get_basis_components(self, basis):
154
"""Retrieve the basis components that are available at basis."""
156
return None, None, None
158
basis_tree = basis.open_workingtree()
159
basis_branch = basis_tree.branch
160
basis_repo = basis_branch.repository
161
except (errors.NoWorkingTree, errors.NotLocalUrl):
164
basis_branch = basis.open_branch()
165
basis_repo = basis_branch.repository
166
except errors.NotBranchError:
169
basis_repo = basis.open_repository()
170
except errors.NoRepositoryPresent:
172
return basis_repo, basis_branch, basis_tree
174
# TODO: This should be given a Transport, and should chdir up; otherwise
175
# this will open a new connection.
176
def _make_tail(self, url):
177
head, tail = urlutils.split(url)
178
if tail and tail != '.':
179
t = bzrlib.transport.get_transport(head)
182
except errors.FileExists:
185
# TODO: Should take a Transport
187
def create(cls, base):
188
"""Create a new BzrDir at the url 'base'.
190
This will call the current default formats initialize with base
191
as the only parameter.
193
If you need a specific format, consider creating an instance
194
of that and calling initialize().
196
if cls is not BzrDir:
197
raise AssertionError("BzrDir.create always creates the default format, "
198
"not one of %r" % cls)
199
head, tail = urlutils.split(base)
200
if tail and tail != '.':
201
t = bzrlib.transport.get_transport(head)
204
except errors.FileExists:
206
return BzrDirFormat.get_default_format().initialize(safe_unicode(base))
208
def create_branch(self):
209
"""Create a branch in this BzrDir.
211
The bzrdirs format will control what branch format is created.
212
For more control see BranchFormatXX.create(a_bzrdir).
214
raise NotImplementedError(self.create_branch)
217
def create_branch_and_repo(base, force_new_repo=False):
218
"""Create a new BzrDir, Branch and Repository at the url 'base'.
220
This will use the current default BzrDirFormat, and use whatever
221
repository format that that uses via bzrdir.create_branch and
222
create_repository. If a shared repository is available that is used
225
The created Branch object is returned.
227
:param base: The URL to create the branch at.
228
:param force_new_repo: If True a new repository is always created.
230
bzrdir = BzrDir.create(base)
231
bzrdir._find_or_create_repository(force_new_repo)
232
return bzrdir.create_branch()
234
def _find_or_create_repository(self, force_new_repo):
235
"""Create a new repository if needed, returning the repository."""
237
return self.create_repository()
239
return self.find_repository()
240
except errors.NoRepositoryPresent:
241
return self.create_repository()
244
def create_branch_convenience(base, force_new_repo=False,
245
force_new_tree=None, format=None):
246
"""Create a new BzrDir, Branch and Repository at the url 'base'.
248
This is a convenience function - it will use an existing repository
249
if possible, can be told explicitly whether to create a working tree or
252
This will use the current default BzrDirFormat, and use whatever
253
repository format that that uses via bzrdir.create_branch and
254
create_repository. If a shared repository is available that is used
255
preferentially. Whatever repository is used, its tree creation policy
258
The created Branch object is returned.
259
If a working tree cannot be made due to base not being a file:// url,
260
no error is raised unless force_new_tree is True, in which case no
261
data is created on disk and NotLocalUrl is raised.
263
:param base: The URL to create the branch at.
264
:param force_new_repo: If True a new repository is always created.
265
:param force_new_tree: If True or False force creation of a tree or
266
prevent such creation respectively.
267
:param format: Override for the for the bzrdir format to create
270
# check for non local urls
271
t = get_transport(safe_unicode(base))
272
if not isinstance(t, LocalTransport):
273
raise errors.NotLocalUrl(base)
275
bzrdir = BzrDir.create(base)
277
bzrdir = format.initialize(base)
278
repo = bzrdir._find_or_create_repository(force_new_repo)
279
result = bzrdir.create_branch()
280
if force_new_tree or (repo.make_working_trees() and
281
force_new_tree is None):
283
bzrdir.create_workingtree()
284
except errors.NotLocalUrl:
289
def create_repository(base, shared=False):
290
"""Create a new BzrDir and Repository at the url 'base'.
292
This will use the current default BzrDirFormat, and use whatever
293
repository format that that uses for bzrdirformat.create_repository.
295
;param shared: Create a shared repository rather than a standalone
297
The Repository object is returned.
299
This must be overridden as an instance method in child classes, where
300
it should take no parameters and construct whatever repository format
301
that child class desires.
303
bzrdir = BzrDir.create(base)
304
return bzrdir.create_repository()
307
def create_standalone_workingtree(base):
308
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
310
'base' must be a local path or a file:// url.
312
This will use the current default BzrDirFormat, and use whatever
313
repository format that that uses for bzrdirformat.create_workingtree,
314
create_branch and create_repository.
316
The WorkingTree object is returned.
318
t = get_transport(safe_unicode(base))
319
if not isinstance(t, LocalTransport):
320
raise errors.NotLocalUrl(base)
321
bzrdir = BzrDir.create_branch_and_repo(safe_unicode(base),
322
force_new_repo=True).bzrdir
323
return bzrdir.create_workingtree()
325
def create_workingtree(self, revision_id=None):
326
"""Create a working tree at this BzrDir.
328
revision_id: create it as of this revision id.
330
raise NotImplementedError(self.create_workingtree)
332
def find_repository(self):
333
"""Find the repository that should be used for a_bzrdir.
335
This does not require a branch as we use it to find the repo for
336
new branches as well as to hook existing branches up to their
340
return self.open_repository()
341
except errors.NoRepositoryPresent:
343
next_transport = self.root_transport.clone('..')
345
# find the next containing bzrdir
347
found_bzrdir = BzrDir.open_containing_from_transport(
349
except errors.NotBranchError:
351
raise errors.NoRepositoryPresent(self)
352
# does it have a repository ?
354
repository = found_bzrdir.open_repository()
355
except errors.NoRepositoryPresent:
356
next_transport = found_bzrdir.root_transport.clone('..')
357
if (found_bzrdir.root_transport.base == next_transport.base):
358
# top of the file system
362
if ((found_bzrdir.root_transport.base ==
363
self.root_transport.base) or repository.is_shared()):
366
raise errors.NoRepositoryPresent(self)
367
raise errors.NoRepositoryPresent(self)
369
def get_branch_transport(self, branch_format):
370
"""Get the transport for use by branch format in this BzrDir.
372
Note that bzr dirs that do not support format strings will raise
373
IncompatibleFormat if the branch format they are given has
374
a format string, and vice versa.
376
If branch_format is None, the transport is returned with no
377
checking. if it is not None, then the returned transport is
378
guaranteed to point to an existing directory ready for use.
380
raise NotImplementedError(self.get_branch_transport)
382
def get_repository_transport(self, repository_format):
383
"""Get the transport for use by repository format in this BzrDir.
385
Note that bzr dirs that do not support format strings will raise
386
IncompatibleFormat if the repository format they are given has
387
a format string, and vice versa.
389
If repository_format is None, the transport is returned with no
390
checking. if it is not None, then the returned transport is
391
guaranteed to point to an existing directory ready for use.
393
raise NotImplementedError(self.get_repository_transport)
395
def get_workingtree_transport(self, tree_format):
396
"""Get the transport for use by workingtree format in this BzrDir.
398
Note that bzr dirs that do not support format strings will raise
399
IncompatibleFormat if the workingtree format they are given has
400
a format string, and vice versa.
402
If workingtree_format is None, the transport is returned with no
403
checking. if it is not None, then the returned transport is
404
guaranteed to point to an existing directory ready for use.
406
raise NotImplementedError(self.get_workingtree_transport)
408
def __init__(self, _transport, _format):
409
"""Initialize a Bzr control dir object.
411
Only really common logic should reside here, concrete classes should be
412
made with varying behaviours.
414
:param _format: the format that is creating this BzrDir instance.
415
:param _transport: the transport this dir is based at.
417
self._format = _format
418
self.transport = _transport.clone('.bzr')
419
self.root_transport = _transport
421
def is_control_filename(self, filename):
422
"""True if filename is the name of a path which is reserved for bzrdir's.
424
:param filename: A filename within the root transport of this bzrdir.
426
This is true IF and ONLY IF the filename is part of the namespace reserved
427
for bzr control dirs. Currently this is the '.bzr' directory in the root
428
of the root_transport. it is expected that plugins will need to extend
429
this in the future - for instance to make bzr talk with svn working
432
# this might be better on the BzrDirFormat class because it refers to
433
# all the possible bzrdir disk formats.
434
# This method is tested via the workingtree is_control_filename tests-
435
# it was extracted from WorkingTree.is_control_filename. If the methods
436
# contract is extended beyond the current trivial implementation please
437
# add new tests for it to the appropriate place.
438
return filename == '.bzr' or filename.startswith('.bzr/')
440
def needs_format_conversion(self, format=None):
441
"""Return true if this bzrdir needs convert_format run on it.
443
For instance, if the repository format is out of date but the
444
branch and working tree are not, this should return True.
446
:param format: Optional parameter indicating a specific desired
447
format we plan to arrive at.
449
raise NotImplementedError(self.needs_format_conversion)
452
def open_unsupported(base):
453
"""Open a branch which is not supported."""
454
return BzrDir.open(base, _unsupported=True)
457
def open(base, _unsupported=False):
458
"""Open an existing bzrdir, rooted at 'base' (url)
460
_unsupported is a private parameter to the BzrDir class.
462
t = get_transport(base)
463
mutter("trying to open %r with transport %r", base, t)
464
format = BzrDirFormat.find_format(t)
465
BzrDir._check_supported(format, _unsupported)
466
return format.open(t, _found=True)
468
def open_branch(self, unsupported=False):
469
"""Open the branch object at this BzrDir if one is present.
471
If unsupported is True, then no longer supported branch formats can
474
TODO: static convenience version of this?
476
raise NotImplementedError(self.open_branch)
479
def open_containing(url):
480
"""Open an existing branch which contains url.
482
:param url: url to search from.
483
See open_containing_from_transport for more detail.
485
return BzrDir.open_containing_from_transport(get_transport(url))
488
def open_containing_from_transport(a_transport):
489
"""Open an existing branch which contains a_transport.base
491
This probes for a branch at a_transport, and searches upwards from there.
493
Basically we keep looking up until we find the control directory or
494
run into the root. If there isn't one, raises NotBranchError.
495
If there is one and it is either an unrecognised format or an unsupported
496
format, UnknownFormatError or UnsupportedFormatError are raised.
497
If there is one, it is returned, along with the unused portion of url.
499
:return: The BzrDir that contains the path, and a Unicode path
500
for the rest of the URL.
502
# this gets the normalised url back. I.e. '.' -> the full path.
503
url = a_transport.base
506
format = BzrDirFormat.find_format(a_transport)
507
BzrDir._check_supported(format, False)
508
return format.open(a_transport), urlutils.unescape(a_transport.relpath(url))
509
except errors.NotBranchError, e:
510
## mutter('not a branch in: %r %s', a_transport.base, e)
512
new_t = a_transport.clone('..')
513
if new_t.base == a_transport.base:
514
# reached the root, whatever that may be
515
raise errors.NotBranchError(path=url)
518
def open_repository(self, _unsupported=False):
519
"""Open the repository object at this BzrDir if one is present.
521
This will not follow the Branch object pointer - its strictly a direct
522
open facility. Most client code should use open_branch().repository to
525
_unsupported is a private parameter, not part of the api.
526
TODO: static convenience version of this?
528
raise NotImplementedError(self.open_repository)
530
def open_workingtree(self, _unsupported=False):
531
"""Open the workingtree object at this BzrDir if one is present.
533
TODO: static convenience version of this?
535
raise NotImplementedError(self.open_workingtree)
537
def has_branch(self):
538
"""Tell if this bzrdir contains a branch.
540
Note: if you're going to open the branch, you should just go ahead
541
and try, and not ask permission first. (This method just opens the
542
branch and discards it, and that's somewhat expensive.)
547
except errors.NotBranchError:
550
def has_workingtree(self):
551
"""Tell if this bzrdir contains a working tree.
553
This will still raise an exception if the bzrdir has a workingtree that
554
is remote & inaccessible.
556
Note: if you're going to open the working tree, you should just go ahead
557
and try, and not ask permission first. (This method just opens the
558
workingtree and discards it, and that's somewhat expensive.)
561
self.open_workingtree()
563
except errors.NoWorkingTree:
566
def sprout(self, url, revision_id=None, basis=None, force_new_repo=False):
567
"""Create a copy of this bzrdir prepared for use as a new line of
570
If urls last component does not exist, it will be created.
572
Attributes related to the identity of the source branch like
573
branch nickname will be cleaned, a working tree is created
574
whether one existed before or not; and a local branch is always
577
if revision_id is not None, then the clone operation may tune
578
itself to download less data.
581
result = self._format.initialize(url)
582
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
584
source_branch = self.open_branch()
585
source_repository = source_branch.repository
586
except errors.NotBranchError:
589
source_repository = self.open_repository()
590
except errors.NoRepositoryPresent:
591
# copy the entire basis one if there is one
592
# but there is no repository.
593
source_repository = basis_repo
598
result_repo = result.find_repository()
599
except errors.NoRepositoryPresent:
601
if source_repository is None and result_repo is not None:
603
elif source_repository is None and result_repo is None:
604
# no repo available, make a new one
605
result.create_repository()
606
elif source_repository is not None and result_repo is None:
607
# have source, and want to make a new target repo
608
# we don't clone the repo because that preserves attributes
609
# like is_shared(), and we have not yet implemented a
610
# repository sprout().
611
result_repo = result.create_repository()
612
if result_repo is not None:
613
# fetch needed content into target.
615
# XXX FIXME RBC 20060214 need tests for this when the basis
617
result_repo.fetch(basis_repo, revision_id=revision_id)
618
result_repo.fetch(source_repository, revision_id=revision_id)
619
if source_branch is not None:
620
source_branch.sprout(result, revision_id=revision_id)
622
result.create_branch()
623
# TODO: jam 20060426 we probably need a test in here in the
624
# case that the newly sprouted branch is a remote one
625
if result_repo is None or result_repo.make_working_trees():
626
result.create_workingtree()
630
class BzrDirPreSplitOut(BzrDir):
631
"""A common class for the all-in-one formats."""
633
def __init__(self, _transport, _format):
634
"""See BzrDir.__init__."""
635
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
636
assert self._format._lock_class == TransportLock
637
assert self._format._lock_file_name == 'branch-lock'
638
self._control_files = LockableFiles(self.get_branch_transport(None),
639
self._format._lock_file_name,
640
self._format._lock_class)
642
def break_lock(self):
643
"""Pre-splitout bzrdirs do not suffer from stale locks."""
644
raise NotImplementedError(self.break_lock)
646
def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
647
"""See BzrDir.clone()."""
648
from bzrlib.workingtree import WorkingTreeFormat2
650
result = self._format._initialize_for_clone(url)
651
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
652
self.open_repository().clone(result, revision_id=revision_id, basis=basis_repo)
653
from_branch = self.open_branch()
654
from_branch.clone(result, revision_id=revision_id)
656
self.open_workingtree().clone(result, basis=basis_tree)
657
except errors.NotLocalUrl:
658
# make a new one, this format always has to have one.
660
WorkingTreeFormat2().initialize(result)
661
except errors.NotLocalUrl:
662
# but we cannot do it for remote trees.
663
to_branch = result.open_branch()
664
WorkingTreeFormat2().stub_initialize_remote(to_branch.control_files)
667
def create_branch(self):
668
"""See BzrDir.create_branch."""
669
return self.open_branch()
671
def create_repository(self, shared=False):
672
"""See BzrDir.create_repository."""
674
raise errors.IncompatibleFormat('shared repository', self._format)
675
return self.open_repository()
677
def create_workingtree(self, revision_id=None):
678
"""See BzrDir.create_workingtree."""
679
# this looks buggy but is not -really-
680
# clone and sprout will have set the revision_id
681
# and that will have set it for us, its only
682
# specific uses of create_workingtree in isolation
683
# that can do wonky stuff here, and that only
684
# happens for creating checkouts, which cannot be
685
# done on this format anyway. So - acceptable wart.
686
result = self.open_workingtree()
687
if revision_id is not None:
688
result.set_last_revision(revision_id)
691
def get_branch_transport(self, branch_format):
692
"""See BzrDir.get_branch_transport()."""
693
if branch_format is None:
694
return self.transport
696
branch_format.get_format_string()
697
except NotImplementedError:
698
return self.transport
699
raise errors.IncompatibleFormat(branch_format, self._format)
701
def get_repository_transport(self, repository_format):
702
"""See BzrDir.get_repository_transport()."""
703
if repository_format is None:
704
return self.transport
706
repository_format.get_format_string()
707
except NotImplementedError:
708
return self.transport
709
raise errors.IncompatibleFormat(repository_format, self._format)
711
def get_workingtree_transport(self, workingtree_format):
712
"""See BzrDir.get_workingtree_transport()."""
713
if workingtree_format is None:
714
return self.transport
716
workingtree_format.get_format_string()
717
except NotImplementedError:
718
return self.transport
719
raise errors.IncompatibleFormat(workingtree_format, self._format)
721
def needs_format_conversion(self, format=None):
722
"""See BzrDir.needs_format_conversion()."""
723
# if the format is not the same as the system default,
724
# an upgrade is needed.
726
format = BzrDirFormat.get_default_format()
727
return not isinstance(self._format, format.__class__)
729
def open_branch(self, unsupported=False):
730
"""See BzrDir.open_branch."""
731
from bzrlib.branch import BzrBranchFormat4
732
format = BzrBranchFormat4()
733
self._check_supported(format, unsupported)
734
return format.open(self, _found=True)
736
def sprout(self, url, revision_id=None, basis=None):
737
"""See BzrDir.sprout()."""
738
from bzrlib.workingtree import WorkingTreeFormat2
740
result = self._format._initialize_for_clone(url)
741
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
743
self.open_repository().clone(result, revision_id=revision_id, basis=basis_repo)
744
except errors.NoRepositoryPresent:
747
self.open_branch().sprout(result, revision_id=revision_id)
748
except errors.NotBranchError:
750
# we always want a working tree
751
WorkingTreeFormat2().initialize(result)
755
class BzrDir4(BzrDirPreSplitOut):
756
"""A .bzr version 4 control object.
758
This is a deprecated format and may be removed after sept 2006.
761
def create_repository(self, shared=False):
762
"""See BzrDir.create_repository."""
763
return self._format.repository_format.initialize(self, shared)
765
def needs_format_conversion(self, format=None):
766
"""Format 4 dirs are always in need of conversion."""
769
def open_repository(self):
770
"""See BzrDir.open_repository."""
771
from bzrlib.repository import RepositoryFormat4
772
return RepositoryFormat4().open(self, _found=True)
775
class BzrDir5(BzrDirPreSplitOut):
776
"""A .bzr version 5 control object.
778
This is a deprecated format and may be removed after sept 2006.
781
def open_repository(self):
782
"""See BzrDir.open_repository."""
783
from bzrlib.repository import RepositoryFormat5
784
return RepositoryFormat5().open(self, _found=True)
786
def open_workingtree(self, _unsupported=False):
787
"""See BzrDir.create_workingtree."""
788
from bzrlib.workingtree import WorkingTreeFormat2
789
return WorkingTreeFormat2().open(self, _found=True)
792
class BzrDir6(BzrDirPreSplitOut):
793
"""A .bzr version 6 control object.
795
This is a deprecated format and may be removed after sept 2006.
798
def open_repository(self):
799
"""See BzrDir.open_repository."""
800
from bzrlib.repository import RepositoryFormat6
801
return RepositoryFormat6().open(self, _found=True)
803
def open_workingtree(self, _unsupported=False):
804
"""See BzrDir.create_workingtree."""
805
from bzrlib.workingtree import WorkingTreeFormat2
806
return WorkingTreeFormat2().open(self, _found=True)
809
class BzrDirMeta1(BzrDir):
810
"""A .bzr meta version 1 control object.
812
This is the first control object where the
813
individual aspects are really split out: there are separate repository,
814
workingtree and branch subdirectories and any subset of the three can be
815
present within a BzrDir.
818
def can_convert_format(self):
819
"""See BzrDir.can_convert_format()."""
822
def create_branch(self):
823
"""See BzrDir.create_branch."""
824
from bzrlib.branch import BranchFormat
825
return BranchFormat.get_default_format().initialize(self)
827
def create_repository(self, shared=False):
828
"""See BzrDir.create_repository."""
829
return self._format.repository_format.initialize(self, shared)
831
def create_workingtree(self, revision_id=None):
832
"""See BzrDir.create_workingtree."""
833
from bzrlib.workingtree import WorkingTreeFormat
834
return WorkingTreeFormat.get_default_format().initialize(self, revision_id)
836
def _get_mkdir_mode(self):
837
"""Figure out the mode to use when creating a bzrdir subdir."""
838
temp_control = LockableFiles(self.transport, '', TransportLock)
839
return temp_control._dir_mode
841
def get_branch_transport(self, branch_format):
842
"""See BzrDir.get_branch_transport()."""
843
if branch_format is None:
844
return self.transport.clone('branch')
846
branch_format.get_format_string()
847
except NotImplementedError:
848
raise errors.IncompatibleFormat(branch_format, self._format)
850
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
851
except errors.FileExists:
853
return self.transport.clone('branch')
855
def get_repository_transport(self, repository_format):
856
"""See BzrDir.get_repository_transport()."""
857
if repository_format is None:
858
return self.transport.clone('repository')
860
repository_format.get_format_string()
861
except NotImplementedError:
862
raise errors.IncompatibleFormat(repository_format, self._format)
864
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
865
except errors.FileExists:
867
return self.transport.clone('repository')
869
def get_workingtree_transport(self, workingtree_format):
870
"""See BzrDir.get_workingtree_transport()."""
871
if workingtree_format is None:
872
return self.transport.clone('checkout')
874
workingtree_format.get_format_string()
875
except NotImplementedError:
876
raise errors.IncompatibleFormat(workingtree_format, self._format)
878
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
879
except errors.FileExists:
881
return self.transport.clone('checkout')
883
def needs_format_conversion(self, format=None):
884
"""See BzrDir.needs_format_conversion()."""
886
format = BzrDirFormat.get_default_format()
887
if not isinstance(self._format, format.__class__):
888
# it is not a meta dir format, conversion is needed.
890
# we might want to push this down to the repository?
892
if not isinstance(self.open_repository()._format,
893
format.repository_format.__class__):
894
# the repository needs an upgrade.
896
except errors.NoRepositoryPresent:
898
# currently there are no other possible conversions for meta1 formats.
901
def open_branch(self, unsupported=False):
902
"""See BzrDir.open_branch."""
903
from bzrlib.branch import BranchFormat
904
format = BranchFormat.find_format(self)
905
self._check_supported(format, unsupported)
906
return format.open(self, _found=True)
908
def open_repository(self, unsupported=False):
909
"""See BzrDir.open_repository."""
910
from bzrlib.repository import RepositoryFormat
911
format = RepositoryFormat.find_format(self)
912
self._check_supported(format, unsupported)
913
return format.open(self, _found=True)
915
def open_workingtree(self, unsupported=False):
916
"""See BzrDir.open_workingtree."""
917
from bzrlib.workingtree import WorkingTreeFormat
918
format = WorkingTreeFormat.find_format(self)
919
self._check_supported(format, unsupported)
920
return format.open(self, _found=True)
923
class BzrDirFormat(object):
924
"""An encapsulation of the initialization and open routines for a format.
926
Formats provide three things:
927
* An initialization routine,
931
Formats are placed in an dict by their format string for reference
932
during bzrdir opening. These should be subclasses of BzrDirFormat
935
Once a format is deprecated, just deprecate the initialize and open
936
methods on the format class. Do not deprecate the object, as the
937
object will be created every system load.
940
_default_format = None
941
"""The default format used for new .bzr dirs."""
944
"""The known formats."""
946
_control_formats = []
947
"""The registered control formats - .bzr, ....
949
This is a list of BzrDirFormat objects.
952
_lock_file_name = 'branch-lock'
954
# _lock_class must be set in subclasses to the lock type, typ.
955
# TransportLock or LockDir
958
def find_format(klass, transport):
959
"""Return the format present at transport."""
960
for format in klass._control_formats:
962
return format.probe_transport(transport)
963
except errors.NotBranchError:
964
# this format does not find a control dir here.
966
raise errors.NotBranchError(path=transport.base)
969
def probe_transport(klass, transport):
970
"""Return the .bzrdir style transport present at URL."""
972
format_string = transport.get(".bzr/branch-format").read()
973
except errors.NoSuchFile:
974
raise errors.NotBranchError(path=transport.base)
977
return klass._formats[format_string]
979
raise errors.UnknownFormatError(format=format_string)
982
def get_default_format(klass):
983
"""Return the current default format."""
984
return klass._default_format
986
def get_format_string(self):
987
"""Return the ASCII format string that identifies this format."""
988
raise NotImplementedError(self.get_format_string)
990
def get_format_description(self):
991
"""Return the short description for this format."""
992
raise NotImplementedError(self.get_format_description)
994
def get_converter(self, format=None):
995
"""Return the converter to use to convert bzrdirs needing converts.
997
This returns a bzrlib.bzrdir.Converter object.
999
This should return the best upgrader to step this format towards the
1000
current default format. In the case of plugins we can/should provide
1001
some means for them to extend the range of returnable converters.
1003
:param format: Optional format to override the default format of the
1006
raise NotImplementedError(self.get_converter)
1008
def initialize(self, url):
1009
"""Create a bzr control dir at this url and return an opened copy.
1011
Subclasses should typically override initialize_on_transport
1012
instead of this method.
1014
return self.initialize_on_transport(get_transport(url))
1016
def initialize_on_transport(self, transport):
1017
"""Initialize a new bzrdir in the base directory of a Transport."""
1018
# Since we don't have a .bzr directory, inherit the
1019
# mode from the root directory
1020
temp_control = LockableFiles(transport, '', TransportLock)
1021
temp_control._transport.mkdir('.bzr',
1022
# FIXME: RBC 20060121 don't peek under
1024
mode=temp_control._dir_mode)
1025
file_mode = temp_control._file_mode
1027
mutter('created control directory in ' + transport.base)
1028
control = transport.clone('.bzr')
1029
utf8_files = [('README',
1030
"This is a Bazaar-NG control directory.\n"
1031
"Do not change any files in this directory.\n"),
1032
('branch-format', self.get_format_string()),
1034
# NB: no need to escape relative paths that are url safe.
1035
control_files = LockableFiles(control, self._lock_file_name,
1037
control_files.create_lock()
1038
control_files.lock_write()
1040
for file, content in utf8_files:
1041
control_files.put_utf8(file, content)
1043
control_files.unlock()
1044
return self.open(transport, _found=True)
1046
def is_supported(self):
1047
"""Is this format supported?
1049
Supported formats must be initializable and openable.
1050
Unsupported formats may not support initialization or committing or
1051
some other features depending on the reason for not being supported.
1056
def known_formats(klass):
1057
"""Return all the known formats.
1059
Concrete formats should override _known_formats.
1061
# There is double indirection here to make sure that control
1062
# formats used by more than one dir format will only be probed
1063
# once. This can otherwise be quite expensive for remote connections.
1065
for format in klass._control_formats:
1066
result.update(format._known_formats())
1070
def _known_formats(klass):
1071
"""Return the known format instances for this control format."""
1072
return set(klass._formats.values())
1074
def open(self, transport, _found=False):
1075
"""Return an instance of this format for the dir transport points at.
1077
_found is a private parameter, do not use it.
1080
assert isinstance(BzrDirFormat.find_format(transport),
1082
return self._open(transport)
1084
def _open(self, transport):
1085
"""Template method helper for opening BzrDirectories.
1087
This performs the actual open and any additional logic or parameter
1090
raise NotImplementedError(self._open)
1093
def register_format(klass, format):
1094
klass._formats[format.get_format_string()] = format
1097
def register_control_format(klass, format):
1098
"""Register a format that does not use '.bzrdir' for its control dir.
1100
TODO: This should be pulled up into a 'ControlDirFormat' base class
1101
which BzrDirFormat can inherit from, and renamed to register_format
1102
there. It has been done without that for now for simplicity of
1105
klass._control_formats.append(format)
1108
def set_default_format(klass, format):
1109
klass._default_format = format
1112
return self.get_format_string()[:-1]
1115
def unregister_format(klass, format):
1116
assert klass._formats[format.get_format_string()] is format
1117
del klass._formats[format.get_format_string()]
1120
def unregister_control_format(klass, format):
1121
klass._control_formats.remove(format)
1124
# register BzrDirFormat as a control format
1125
BzrDirFormat.register_control_format(BzrDirFormat)
1128
class BzrDirFormat4(BzrDirFormat):
1129
"""Bzr dir format 4.
1131
This format is a combined format for working tree, branch and repository.
1133
- Format 1 working trees [always]
1134
- Format 4 branches [always]
1135
- Format 4 repositories [always]
1137
This format is deprecated: it indexes texts using a text it which is
1138
removed in format 5; write support for this format has been removed.
1141
_lock_class = TransportLock
1143
def get_format_string(self):
1144
"""See BzrDirFormat.get_format_string()."""
1145
return "Bazaar-NG branch, format 0.0.4\n"
1147
def get_format_description(self):
1148
"""See BzrDirFormat.get_format_description()."""
1149
return "All-in-one format 4"
1151
def get_converter(self, format=None):
1152
"""See BzrDirFormat.get_converter()."""
1153
# there is one and only one upgrade path here.
1154
return ConvertBzrDir4To5()
1156
def initialize_on_transport(self, transport):
1157
"""Format 4 branches cannot be created."""
1158
raise errors.UninitializableFormat(self)
1160
def is_supported(self):
1161
"""Format 4 is not supported.
1163
It is not supported because the model changed from 4 to 5 and the
1164
conversion logic is expensive - so doing it on the fly was not
1169
def _open(self, transport):
1170
"""See BzrDirFormat._open."""
1171
return BzrDir4(transport, self)
1173
def __return_repository_format(self):
1174
"""Circular import protection."""
1175
from bzrlib.repository import RepositoryFormat4
1176
return RepositoryFormat4(self)
1177
repository_format = property(__return_repository_format)
1180
class BzrDirFormat5(BzrDirFormat):
1181
"""Bzr control format 5.
1183
This format is a combined format for working tree, branch and repository.
1185
- Format 2 working trees [always]
1186
- Format 4 branches [always]
1187
- Format 5 repositories [always]
1188
Unhashed stores in the repository.
1191
_lock_class = TransportLock
1193
def get_format_string(self):
1194
"""See BzrDirFormat.get_format_string()."""
1195
return "Bazaar-NG branch, format 5\n"
1197
def get_format_description(self):
1198
"""See BzrDirFormat.get_format_description()."""
1199
return "All-in-one format 5"
1201
def get_converter(self, format=None):
1202
"""See BzrDirFormat.get_converter()."""
1203
# there is one and only one upgrade path here.
1204
return ConvertBzrDir5To6()
1206
def _initialize_for_clone(self, url):
1207
return self.initialize_on_transport(get_transport(url), _cloning=True)
1209
def initialize_on_transport(self, transport, _cloning=False):
1210
"""Format 5 dirs always have working tree, branch and repository.
1212
Except when they are being cloned.
1214
from bzrlib.branch import BzrBranchFormat4
1215
from bzrlib.repository import RepositoryFormat5
1216
from bzrlib.workingtree import WorkingTreeFormat2
1217
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1218
RepositoryFormat5().initialize(result, _internal=True)
1220
BzrBranchFormat4().initialize(result)
1221
WorkingTreeFormat2().initialize(result)
1224
def _open(self, transport):
1225
"""See BzrDirFormat._open."""
1226
return BzrDir5(transport, self)
1228
def __return_repository_format(self):
1229
"""Circular import protection."""
1230
from bzrlib.repository import RepositoryFormat5
1231
return RepositoryFormat5(self)
1232
repository_format = property(__return_repository_format)
1235
class BzrDirFormat6(BzrDirFormat):
1236
"""Bzr control format 6.
1238
This format is a combined format for working tree, branch and repository.
1240
- Format 2 working trees [always]
1241
- Format 4 branches [always]
1242
- Format 6 repositories [always]
1245
_lock_class = TransportLock
1247
def get_format_string(self):
1248
"""See BzrDirFormat.get_format_string()."""
1249
return "Bazaar-NG branch, format 6\n"
1251
def get_format_description(self):
1252
"""See BzrDirFormat.get_format_description()."""
1253
return "All-in-one format 6"
1255
def get_converter(self, format=None):
1256
"""See BzrDirFormat.get_converter()."""
1257
# there is one and only one upgrade path here.
1258
return ConvertBzrDir6ToMeta()
1260
def _initialize_for_clone(self, url):
1261
return self.initialize_on_transport(get_transport(url), _cloning=True)
1263
def initialize_on_transport(self, transport, _cloning=False):
1264
"""Format 6 dirs always have working tree, branch and repository.
1266
Except when they are being cloned.
1268
from bzrlib.branch import BzrBranchFormat4
1269
from bzrlib.repository import RepositoryFormat6
1270
from bzrlib.workingtree import WorkingTreeFormat2
1271
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1272
RepositoryFormat6().initialize(result, _internal=True)
1274
BzrBranchFormat4().initialize(result)
1276
WorkingTreeFormat2().initialize(result)
1277
except errors.NotLocalUrl:
1278
# emulate pre-check behaviour for working tree and silently
1283
def _open(self, transport):
1284
"""See BzrDirFormat._open."""
1285
return BzrDir6(transport, self)
1287
def __return_repository_format(self):
1288
"""Circular import protection."""
1289
from bzrlib.repository import RepositoryFormat6
1290
return RepositoryFormat6(self)
1291
repository_format = property(__return_repository_format)
1294
class BzrDirMetaFormat1(BzrDirFormat):
1295
"""Bzr meta control format 1
1297
This is the first format with split out working tree, branch and repository
1300
- Format 3 working trees [optional]
1301
- Format 5 branches [optional]
1302
- Format 7 repositories [optional]
1305
_lock_class = LockDir
1307
def get_converter(self, format=None):
1308
"""See BzrDirFormat.get_converter()."""
1310
format = BzrDirFormat.get_default_format()
1311
if not isinstance(self, format.__class__):
1312
# converting away from metadir is not implemented
1313
raise NotImplementedError(self.get_converter)
1314
return ConvertMetaToMeta(format)
1316
def get_format_string(self):
1317
"""See BzrDirFormat.get_format_string()."""
1318
return "Bazaar-NG meta directory, format 1\n"
1320
def get_format_description(self):
1321
"""See BzrDirFormat.get_format_description()."""
1322
return "Meta directory format 1"
1324
def _open(self, transport):
1325
"""See BzrDirFormat._open."""
1326
return BzrDirMeta1(transport, self)
1328
def __return_repository_format(self):
1329
"""Circular import protection."""
1330
if getattr(self, '_repository_format', None):
1331
return self._repository_format
1332
from bzrlib.repository import RepositoryFormat
1333
return RepositoryFormat.get_default_format()
1335
def __set_repository_format(self, value):
1336
"""Allow changint the repository format for metadir formats."""
1337
self._repository_format = value
1339
repository_format = property(__return_repository_format, __set_repository_format)
1342
BzrDirFormat.register_format(BzrDirFormat4())
1343
BzrDirFormat.register_format(BzrDirFormat5())
1344
BzrDirFormat.register_format(BzrDirFormat6())
1345
__default_format = BzrDirMetaFormat1()
1346
BzrDirFormat.register_format(__default_format)
1347
BzrDirFormat.set_default_format(__default_format)
1350
class BzrDirTestProviderAdapter(object):
1351
"""A tool to generate a suite testing multiple bzrdir formats at once.
1353
This is done by copying the test once for each transport and injecting
1354
the transport_server, transport_readonly_server, and bzrdir_format
1355
classes into each copy. Each copy is also given a new id() to make it
1359
def __init__(self, transport_server, transport_readonly_server, formats):
1360
self._transport_server = transport_server
1361
self._transport_readonly_server = transport_readonly_server
1362
self._formats = formats
1364
def adapt(self, test):
1365
result = TestSuite()
1366
for format in self._formats:
1367
new_test = deepcopy(test)
1368
new_test.transport_server = self._transport_server
1369
new_test.transport_readonly_server = self._transport_readonly_server
1370
new_test.bzrdir_format = format
1371
def make_new_test_id():
1372
new_id = "%s(%s)" % (new_test.id(), format.__class__.__name__)
1373
return lambda: new_id
1374
new_test.id = make_new_test_id()
1375
result.addTest(new_test)
1379
class ScratchDir(BzrDir6):
1380
"""Special test class: a bzrdir that cleans up itself..
1382
>>> d = ScratchDir()
1383
>>> base = d.transport.base
1386
>>> b.transport.__del__()
1391
def __init__(self, files=[], dirs=[], transport=None):
1392
"""Make a test branch.
1394
This creates a temporary directory and runs init-tree in it.
1396
If any files are listed, they are created in the working copy.
1398
if transport is None:
1399
transport = bzrlib.transport.local.ScratchTransport()
1400
# local import for scope restriction
1401
BzrDirFormat6().initialize(transport.base)
1402
super(ScratchDir, self).__init__(transport, BzrDirFormat6())
1403
self.create_repository()
1404
self.create_branch()
1405
self.create_workingtree()
1407
super(ScratchDir, self).__init__(transport, BzrDirFormat6())
1409
# BzrBranch creates a clone to .bzr and then forgets about the
1410
# original transport. A ScratchTransport() deletes itself and
1411
# everything underneath it when it goes away, so we need to
1412
# grab a local copy to prevent that from happening
1413
self._transport = transport
1416
self._transport.mkdir(d)
1419
self._transport.put(f, 'content of %s' % f)
1423
>>> orig = ScratchDir(files=["file1", "file2"])
1424
>>> os.listdir(orig.base)
1425
[u'.bzr', u'file1', u'file2']
1426
>>> clone = orig.clone()
1427
>>> if os.name != 'nt':
1428
... os.path.samefile(orig.base, clone.base)
1430
... orig.base == clone.base
1433
>>> os.listdir(clone.base)
1434
[u'.bzr', u'file1', u'file2']
1436
from shutil import copytree
1437
from bzrlib.osutils import mkdtemp
1440
copytree(self.base, base, symlinks=True)
1442
transport=bzrlib.transport.local.ScratchTransport(base))
1445
class Converter(object):
1446
"""Converts a disk format object from one format to another."""
1448
def convert(self, to_convert, pb):
1449
"""Perform the conversion of to_convert, giving feedback via pb.
1451
:param to_convert: The disk object to convert.
1452
:param pb: a progress bar to use for progress information.
1455
def step(self, message):
1456
"""Update the pb by a step."""
1458
self.pb.update(message, self.count, self.total)
1461
class ConvertBzrDir4To5(Converter):
1462
"""Converts format 4 bzr dirs to format 5."""
1465
super(ConvertBzrDir4To5, self).__init__()
1466
self.converted_revs = set()
1467
self.absent_revisions = set()
1471
def convert(self, to_convert, pb):
1472
"""See Converter.convert()."""
1473
self.bzrdir = to_convert
1475
self.pb.note('starting upgrade from format 4 to 5')
1476
if isinstance(self.bzrdir.transport, LocalTransport):
1477
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
1478
self._convert_to_weaves()
1479
return BzrDir.open(self.bzrdir.root_transport.base)
1481
def _convert_to_weaves(self):
1482
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
1485
stat = self.bzrdir.transport.stat('weaves')
1486
if not S_ISDIR(stat.st_mode):
1487
self.bzrdir.transport.delete('weaves')
1488
self.bzrdir.transport.mkdir('weaves')
1489
except errors.NoSuchFile:
1490
self.bzrdir.transport.mkdir('weaves')
1491
# deliberately not a WeaveFile as we want to build it up slowly.
1492
self.inv_weave = Weave('inventory')
1493
# holds in-memory weaves for all files
1494
self.text_weaves = {}
1495
self.bzrdir.transport.delete('branch-format')
1496
self.branch = self.bzrdir.open_branch()
1497
self._convert_working_inv()
1498
rev_history = self.branch.revision_history()
1499
# to_read is a stack holding the revisions we still need to process;
1500
# appending to it adds new highest-priority revisions
1501
self.known_revisions = set(rev_history)
1502
self.to_read = rev_history[-1:]
1504
rev_id = self.to_read.pop()
1505
if (rev_id not in self.revisions
1506
and rev_id not in self.absent_revisions):
1507
self._load_one_rev(rev_id)
1509
to_import = self._make_order()
1510
for i, rev_id in enumerate(to_import):
1511
self.pb.update('converting revision', i, len(to_import))
1512
self._convert_one_rev(rev_id)
1514
self._write_all_weaves()
1515
self._write_all_revs()
1516
self.pb.note('upgraded to weaves:')
1517
self.pb.note(' %6d revisions and inventories', len(self.revisions))
1518
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
1519
self.pb.note(' %6d texts', self.text_count)
1520
self._cleanup_spare_files_after_format4()
1521
self.branch.control_files.put_utf8('branch-format', BzrDirFormat5().get_format_string())
1523
def _cleanup_spare_files_after_format4(self):
1524
# FIXME working tree upgrade foo.
1525
for n in 'merged-patches', 'pending-merged-patches':
1527
## assert os.path.getsize(p) == 0
1528
self.bzrdir.transport.delete(n)
1529
except errors.NoSuchFile:
1531
self.bzrdir.transport.delete_tree('inventory-store')
1532
self.bzrdir.transport.delete_tree('text-store')
1534
def _convert_working_inv(self):
1535
inv = serializer_v4.read_inventory(self.branch.control_files.get('inventory'))
1536
new_inv_xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1537
# FIXME inventory is a working tree change.
1538
self.branch.control_files.put('inventory', new_inv_xml)
1540
def _write_all_weaves(self):
1541
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
1542
weave_transport = self.bzrdir.transport.clone('weaves')
1543
weaves = WeaveStore(weave_transport, prefixed=False)
1544
transaction = WriteTransaction()
1548
for file_id, file_weave in self.text_weaves.items():
1549
self.pb.update('writing weave', i, len(self.text_weaves))
1550
weaves._put_weave(file_id, file_weave, transaction)
1552
self.pb.update('inventory', 0, 1)
1553
controlweaves._put_weave('inventory', self.inv_weave, transaction)
1554
self.pb.update('inventory', 1, 1)
1558
def _write_all_revs(self):
1559
"""Write all revisions out in new form."""
1560
self.bzrdir.transport.delete_tree('revision-store')
1561
self.bzrdir.transport.mkdir('revision-store')
1562
revision_transport = self.bzrdir.transport.clone('revision-store')
1564
_revision_store = TextRevisionStore(TextStore(revision_transport,
1568
transaction = bzrlib.transactions.WriteTransaction()
1569
for i, rev_id in enumerate(self.converted_revs):
1570
self.pb.update('write revision', i, len(self.converted_revs))
1571
_revision_store.add_revision(self.revisions[rev_id], transaction)
1575
def _load_one_rev(self, rev_id):
1576
"""Load a revision object into memory.
1578
Any parents not either loaded or abandoned get queued to be
1580
self.pb.update('loading revision',
1581
len(self.revisions),
1582
len(self.known_revisions))
1583
if not self.branch.repository.has_revision(rev_id):
1585
self.pb.note('revision {%s} not present in branch; '
1586
'will be converted as a ghost',
1588
self.absent_revisions.add(rev_id)
1590
rev = self.branch.repository._revision_store.get_revision(rev_id,
1591
self.branch.repository.get_transaction())
1592
for parent_id in rev.parent_ids:
1593
self.known_revisions.add(parent_id)
1594
self.to_read.append(parent_id)
1595
self.revisions[rev_id] = rev
1597
def _load_old_inventory(self, rev_id):
1598
assert rev_id not in self.converted_revs
1599
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
1600
inv = serializer_v4.read_inventory_from_string(old_inv_xml)
1601
rev = self.revisions[rev_id]
1602
if rev.inventory_sha1:
1603
assert rev.inventory_sha1 == sha_string(old_inv_xml), \
1604
'inventory sha mismatch for {%s}' % rev_id
1607
def _load_updated_inventory(self, rev_id):
1608
assert rev_id in self.converted_revs
1609
inv_xml = self.inv_weave.get_text(rev_id)
1610
inv = bzrlib.xml5.serializer_v5.read_inventory_from_string(inv_xml)
1613
def _convert_one_rev(self, rev_id):
1614
"""Convert revision and all referenced objects to new format."""
1615
rev = self.revisions[rev_id]
1616
inv = self._load_old_inventory(rev_id)
1617
present_parents = [p for p in rev.parent_ids
1618
if p not in self.absent_revisions]
1619
self._convert_revision_contents(rev, inv, present_parents)
1620
self._store_new_weave(rev, inv, present_parents)
1621
self.converted_revs.add(rev_id)
1623
def _store_new_weave(self, rev, inv, present_parents):
1624
# the XML is now updated with text versions
1628
if ie.kind == 'root_directory':
1630
assert hasattr(ie, 'revision'), \
1631
'no revision on {%s} in {%s}' % \
1632
(file_id, rev.revision_id)
1633
new_inv_xml = bzrlib.xml5.serializer_v5.write_inventory_to_string(inv)
1634
new_inv_sha1 = sha_string(new_inv_xml)
1635
self.inv_weave.add_lines(rev.revision_id,
1637
new_inv_xml.splitlines(True))
1638
rev.inventory_sha1 = new_inv_sha1
1640
def _convert_revision_contents(self, rev, inv, present_parents):
1641
"""Convert all the files within a revision.
1643
Also upgrade the inventory to refer to the text revision ids."""
1644
rev_id = rev.revision_id
1645
mutter('converting texts of revision {%s}',
1647
parent_invs = map(self._load_updated_inventory, present_parents)
1650
self._convert_file_version(rev, ie, parent_invs)
1652
def _convert_file_version(self, rev, ie, parent_invs):
1653
"""Convert one version of one file.
1655
The file needs to be added into the weave if it is a merge
1656
of >=2 parents or if it's changed from its parent.
1658
if ie.kind == 'root_directory':
1660
file_id = ie.file_id
1661
rev_id = rev.revision_id
1662
w = self.text_weaves.get(file_id)
1665
self.text_weaves[file_id] = w
1666
text_changed = False
1667
previous_entries = ie.find_previous_heads(parent_invs,
1671
for old_revision in previous_entries:
1672
# if this fails, its a ghost ?
1673
assert old_revision in self.converted_revs
1674
self.snapshot_ie(previous_entries, ie, w, rev_id)
1676
assert getattr(ie, 'revision', None) is not None
1678
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
1679
# TODO: convert this logic, which is ~= snapshot to
1680
# a call to:. This needs the path figured out. rather than a work_tree
1681
# a v4 revision_tree can be given, or something that looks enough like
1682
# one to give the file content to the entry if it needs it.
1683
# and we need something that looks like a weave store for snapshot to
1685
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
1686
if len(previous_revisions) == 1:
1687
previous_ie = previous_revisions.values()[0]
1688
if ie._unchanged(previous_ie):
1689
ie.revision = previous_ie.revision
1692
text = self.branch.repository.text_store.get(ie.text_id)
1693
file_lines = text.readlines()
1694
assert sha_strings(file_lines) == ie.text_sha1
1695
assert sum(map(len, file_lines)) == ie.text_size
1696
w.add_lines(rev_id, previous_revisions, file_lines)
1697
self.text_count += 1
1699
w.add_lines(rev_id, previous_revisions, [])
1700
ie.revision = rev_id
1702
def _make_order(self):
1703
"""Return a suitable order for importing revisions.
1705
The order must be such that an revision is imported after all
1706
its (present) parents.
1708
todo = set(self.revisions.keys())
1709
done = self.absent_revisions.copy()
1712
# scan through looking for a revision whose parents
1714
for rev_id in sorted(list(todo)):
1715
rev = self.revisions[rev_id]
1716
parent_ids = set(rev.parent_ids)
1717
if parent_ids.issubset(done):
1718
# can take this one now
1719
order.append(rev_id)
1725
class ConvertBzrDir5To6(Converter):
1726
"""Converts format 5 bzr dirs to format 6."""
1728
def convert(self, to_convert, pb):
1729
"""See Converter.convert()."""
1730
self.bzrdir = to_convert
1732
self.pb.note('starting upgrade from format 5 to 6')
1733
self._convert_to_prefixed()
1734
return BzrDir.open(self.bzrdir.root_transport.base)
1736
def _convert_to_prefixed(self):
1737
from bzrlib.store import TransportStore
1738
self.bzrdir.transport.delete('branch-format')
1739
for store_name in ["weaves", "revision-store"]:
1740
self.pb.note("adding prefixes to %s" % store_name)
1741
store_transport = self.bzrdir.transport.clone(store_name)
1742
store = TransportStore(store_transport, prefixed=True)
1743
for urlfilename in store_transport.list_dir('.'):
1744
filename = urlutils.unescape(urlfilename)
1745
if (filename.endswith(".weave") or
1746
filename.endswith(".gz") or
1747
filename.endswith(".sig")):
1748
file_id = os.path.splitext(filename)[0]
1751
prefix_dir = store.hash_prefix(file_id)
1752
# FIXME keep track of the dirs made RBC 20060121
1754
store_transport.move(filename, prefix_dir + '/' + filename)
1755
except errors.NoSuchFile: # catches missing dirs strangely enough
1756
store_transport.mkdir(prefix_dir)
1757
store_transport.move(filename, prefix_dir + '/' + filename)
1758
self.bzrdir._control_files.put_utf8('branch-format', BzrDirFormat6().get_format_string())
1761
class ConvertBzrDir6ToMeta(Converter):
1762
"""Converts format 6 bzr dirs to metadirs."""
1764
def convert(self, to_convert, pb):
1765
"""See Converter.convert()."""
1766
self.bzrdir = to_convert
1769
self.total = 20 # the steps we know about
1770
self.garbage_inventories = []
1772
self.pb.note('starting upgrade from format 6 to metadir')
1773
self.bzrdir._control_files.put_utf8('branch-format', "Converting to format 6")
1774
# its faster to move specific files around than to open and use the apis...
1775
# first off, nuke ancestry.weave, it was never used.
1777
self.step('Removing ancestry.weave')
1778
self.bzrdir.transport.delete('ancestry.weave')
1779
except errors.NoSuchFile:
1781
# find out whats there
1782
self.step('Finding branch files')
1783
last_revision = self.bzrdir.open_branch().last_revision()
1784
bzrcontents = self.bzrdir.transport.list_dir('.')
1785
for name in bzrcontents:
1786
if name.startswith('basis-inventory.'):
1787
self.garbage_inventories.append(name)
1788
# create new directories for repository, working tree and branch
1789
self.dir_mode = self.bzrdir._control_files._dir_mode
1790
self.file_mode = self.bzrdir._control_files._file_mode
1791
repository_names = [('inventory.weave', True),
1792
('revision-store', True),
1794
self.step('Upgrading repository ')
1795
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
1796
self.make_lock('repository')
1797
# we hard code the formats here because we are converting into
1798
# the meta format. The meta format upgrader can take this to a
1799
# future format within each component.
1800
self.put_format('repository', bzrlib.repository.RepositoryFormat7())
1801
for entry in repository_names:
1802
self.move_entry('repository', entry)
1804
self.step('Upgrading branch ')
1805
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
1806
self.make_lock('branch')
1807
self.put_format('branch', bzrlib.branch.BzrBranchFormat5())
1808
branch_files = [('revision-history', True),
1809
('branch-name', True),
1811
for entry in branch_files:
1812
self.move_entry('branch', entry)
1814
self.step('Upgrading working tree')
1815
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
1816
self.make_lock('checkout')
1817
self.put_format('checkout', bzrlib.workingtree.WorkingTreeFormat3())
1818
self.bzrdir.transport.delete_multi(self.garbage_inventories, self.pb)
1819
checkout_files = [('pending-merges', True),
1820
('inventory', True),
1821
('stat-cache', False)]
1822
for entry in checkout_files:
1823
self.move_entry('checkout', entry)
1824
if last_revision is not None:
1825
self.bzrdir._control_files.put_utf8('checkout/last-revision',
1827
self.bzrdir._control_files.put_utf8('branch-format', BzrDirMetaFormat1().get_format_string())
1828
return BzrDir.open(self.bzrdir.root_transport.base)
1830
def make_lock(self, name):
1831
"""Make a lock for the new control dir name."""
1832
self.step('Make %s lock' % name)
1833
ld = LockDir(self.bzrdir.transport,
1835
file_modebits=self.file_mode,
1836
dir_modebits=self.dir_mode)
1839
def move_entry(self, new_dir, entry):
1840
"""Move then entry name into new_dir."""
1842
mandatory = entry[1]
1843
self.step('Moving %s' % name)
1845
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
1846
except errors.NoSuchFile:
1850
def put_format(self, dirname, format):
1851
self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
1854
class ConvertMetaToMeta(Converter):
1855
"""Converts the components of metadirs."""
1857
def __init__(self, target_format):
1858
"""Create a metadir to metadir converter.
1860
:param target_format: The final metadir format that is desired.
1862
self.target_format = target_format
1864
def convert(self, to_convert, pb):
1865
"""See Converter.convert()."""
1866
self.bzrdir = to_convert
1870
self.step('checking repository format')
1872
repo = self.bzrdir.open_repository()
1873
except errors.NoRepositoryPresent:
1876
if not isinstance(repo._format, self.target_format.repository_format.__class__):
1877
from bzrlib.repository import CopyConverter
1878
self.pb.note('starting repository conversion')
1879
converter = CopyConverter(self.target_format.repository_format)
1880
converter.convert(repo, pb)
added
removed
bzrlib/bzrdir.py
