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
34
from bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
36
from copy import deepcopy
37
from stat import S_ISDIR
45
revision as _mod_revision,
50
from bzrlib.osutils import (
55
from bzrlib.store.revision.text import TextRevisionStore
56
from bzrlib.store.text import TextStore
57
from bzrlib.store.versioned import WeaveStore
58
from bzrlib.transactions import WriteTransaction
59
from bzrlib.transport import get_transport
60
from bzrlib.weave import Weave
63
from bzrlib.trace import mutter
64
from bzrlib.transport.local import LocalTransport
68
"""A .bzr control diretory.
70
BzrDir instances let you create or open any of the things that can be
71
found within .bzr - checkouts, branches and repositories.
74
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
76
a transport connected to the directory this bzr was opened from.
80
"""Invoke break_lock on the first object in the bzrdir.
82
If there is a tree, the tree is opened and break_lock() called.
83
Otherwise, branch is tried, and finally repository.
86
thing_to_unlock = self.open_workingtree()
87
except (errors.NotLocalUrl, errors.NoWorkingTree):
89
thing_to_unlock = self.open_branch()
90
except errors.NotBranchError:
92
thing_to_unlock = self.open_repository()
93
except errors.NoRepositoryPresent:
95
thing_to_unlock.break_lock()
97
def can_convert_format(self):
98
"""Return true if this bzrdir is one whose format we can convert from."""
101
def check_conversion_target(self, target_format):
102
target_repo_format = target_format.repository_format
103
source_repo_format = self._format.repository_format
104
source_repo_format.check_conversion_target(target_repo_format)
107
def _check_supported(format, allow_unsupported):
108
"""Check whether format is a supported format.
110
If allow_unsupported is True, this is a no-op.
112
if not allow_unsupported and not format.is_supported():
113
# see open_downlevel to open legacy branches.
114
raise errors.UnsupportedFormatError(format=format)
116
def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
117
"""Clone this bzrdir and its contents to url verbatim.
119
If urls last component does not exist, it will be created.
121
if revision_id is not None, then the clone operation may tune
122
itself to download less data.
123
:param force_new_repo: Do not use a shared repository for the target
124
even if one is available.
127
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
128
result = self._format.initialize(url)
130
local_repo = self.find_repository()
131
except errors.NoRepositoryPresent:
134
# may need to copy content in
136
result_repo = local_repo.clone(
138
revision_id=revision_id,
140
result_repo.set_make_working_trees(local_repo.make_working_trees())
143
result_repo = result.find_repository()
144
# fetch content this dir needs.
146
# XXX FIXME RBC 20060214 need tests for this when the basis
148
result_repo.fetch(basis_repo, revision_id=revision_id)
149
result_repo.fetch(local_repo, revision_id=revision_id)
150
except errors.NoRepositoryPresent:
151
# needed to make one anyway.
152
result_repo = local_repo.clone(
154
revision_id=revision_id,
156
result_repo.set_make_working_trees(local_repo.make_working_trees())
157
# 1 if there is a branch present
158
# make sure its content is available in the target repository
161
self.open_branch().clone(result, revision_id=revision_id)
162
except errors.NotBranchError:
165
self.open_workingtree().clone(result, basis=basis_tree)
166
except (errors.NoWorkingTree, errors.NotLocalUrl):
170
def _get_basis_components(self, basis):
171
"""Retrieve the basis components that are available at basis."""
173
return None, None, None
175
basis_tree = basis.open_workingtree()
176
basis_branch = basis_tree.branch
177
basis_repo = basis_branch.repository
178
except (errors.NoWorkingTree, errors.NotLocalUrl):
181
basis_branch = basis.open_branch()
182
basis_repo = basis_branch.repository
183
except errors.NotBranchError:
186
basis_repo = basis.open_repository()
187
except errors.NoRepositoryPresent:
189
return basis_repo, basis_branch, basis_tree
191
# TODO: This should be given a Transport, and should chdir up; otherwise
192
# this will open a new connection.
193
def _make_tail(self, url):
194
head, tail = urlutils.split(url)
195
if tail and tail != '.':
196
t = get_transport(head)
199
except errors.FileExists:
202
# TODO: Should take a Transport
204
def create(cls, base):
205
"""Create a new BzrDir at the url 'base'.
207
This will call the current default formats initialize with base
208
as the only parameter.
210
If you need a specific format, consider creating an instance
211
of that and calling initialize().
213
if cls is not BzrDir:
214
raise AssertionError("BzrDir.create always creates the default format, "
215
"not one of %r" % cls)
216
head, tail = urlutils.split(base)
217
if tail and tail != '.':
218
t = get_transport(head)
221
except errors.FileExists:
223
return BzrDirFormat.get_default_format().initialize(safe_unicode(base))
225
def create_branch(self):
226
"""Create a branch in this BzrDir.
228
The bzrdirs format will control what branch format is created.
229
For more control see BranchFormatXX.create(a_bzrdir).
231
raise NotImplementedError(self.create_branch)
234
def create_branch_and_repo(base, force_new_repo=False):
235
"""Create a new BzrDir, Branch and Repository at the url 'base'.
237
This will use the current default BzrDirFormat, and use whatever
238
repository format that that uses via bzrdir.create_branch and
239
create_repository. If a shared repository is available that is used
242
The created Branch object is returned.
244
:param base: The URL to create the branch at.
245
:param force_new_repo: If True a new repository is always created.
247
bzrdir = BzrDir.create(base)
248
bzrdir._find_or_create_repository(force_new_repo)
249
return bzrdir.create_branch()
251
def _find_or_create_repository(self, force_new_repo):
252
"""Create a new repository if needed, returning the repository."""
254
return self.create_repository()
256
return self.find_repository()
257
except errors.NoRepositoryPresent:
258
return self.create_repository()
261
def create_branch_convenience(base, force_new_repo=False,
262
force_new_tree=None, format=None):
263
"""Create a new BzrDir, Branch and Repository at the url 'base'.
265
This is a convenience function - it will use an existing repository
266
if possible, can be told explicitly whether to create a working tree or
269
This will use the current default BzrDirFormat, and use whatever
270
repository format that that uses via bzrdir.create_branch and
271
create_repository. If a shared repository is available that is used
272
preferentially. Whatever repository is used, its tree creation policy
275
The created Branch object is returned.
276
If a working tree cannot be made due to base not being a file:// url,
277
no error is raised unless force_new_tree is True, in which case no
278
data is created on disk and NotLocalUrl is raised.
280
:param base: The URL to create the branch at.
281
:param force_new_repo: If True a new repository is always created.
282
:param force_new_tree: If True or False force creation of a tree or
283
prevent such creation respectively.
284
:param format: Override for the for the bzrdir format to create
287
# check for non local urls
288
t = get_transport(safe_unicode(base))
289
if not isinstance(t, LocalTransport):
290
raise errors.NotLocalUrl(base)
292
bzrdir = BzrDir.create(base)
294
bzrdir = format.initialize(base)
295
repo = bzrdir._find_or_create_repository(force_new_repo)
296
result = bzrdir.create_branch()
297
if force_new_tree or (repo.make_working_trees() and
298
force_new_tree is None):
300
bzrdir.create_workingtree()
301
except errors.NotLocalUrl:
306
def create_repository(base, shared=False):
307
"""Create a new BzrDir and Repository at the url 'base'.
309
This will use the current default BzrDirFormat, and use whatever
310
repository format that that uses for bzrdirformat.create_repository.
312
:param shared: Create a shared repository rather than a standalone
314
The Repository object is returned.
316
This must be overridden as an instance method in child classes, where
317
it should take no parameters and construct whatever repository format
318
that child class desires.
320
bzrdir = BzrDir.create(base)
321
return bzrdir.create_repository(shared)
324
def create_standalone_workingtree(base):
325
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
327
'base' must be a local path or a file:// url.
329
This will use the current default BzrDirFormat, and use whatever
330
repository format that that uses for bzrdirformat.create_workingtree,
331
create_branch and create_repository.
333
:return: The WorkingTree object.
335
t = get_transport(safe_unicode(base))
336
if not isinstance(t, LocalTransport):
337
raise errors.NotLocalUrl(base)
338
bzrdir = BzrDir.create_branch_and_repo(safe_unicode(base),
339
force_new_repo=True).bzrdir
340
return bzrdir.create_workingtree()
342
def create_workingtree(self, revision_id=None):
343
"""Create a working tree at this BzrDir.
345
revision_id: create it as of this revision id.
347
raise NotImplementedError(self.create_workingtree)
349
def destroy_workingtree(self):
350
"""Destroy the working tree at this BzrDir.
352
Formats that do not support this may raise UnsupportedOperation.
354
raise NotImplementedError(self.destroy_workingtree)
356
def destroy_workingtree_metadata(self):
357
"""Destroy the control files for the working tree at this BzrDir.
359
The contents of working tree files are not affected.
360
Formats that do not support this may raise UnsupportedOperation.
362
raise NotImplementedError(self.destroy_workingtree_metadata)
364
def find_repository(self):
365
"""Find the repository that should be used for a_bzrdir.
367
This does not require a branch as we use it to find the repo for
368
new branches as well as to hook existing branches up to their
372
return self.open_repository()
373
except errors.NoRepositoryPresent:
375
next_transport = self.root_transport.clone('..')
377
# find the next containing bzrdir
379
found_bzrdir = BzrDir.open_containing_from_transport(
381
except errors.NotBranchError:
383
raise errors.NoRepositoryPresent(self)
384
# does it have a repository ?
386
repository = found_bzrdir.open_repository()
387
except errors.NoRepositoryPresent:
388
next_transport = found_bzrdir.root_transport.clone('..')
389
if (found_bzrdir.root_transport.base == next_transport.base):
390
# top of the file system
394
if ((found_bzrdir.root_transport.base ==
395
self.root_transport.base) or repository.is_shared()):
398
raise errors.NoRepositoryPresent(self)
399
raise errors.NoRepositoryPresent(self)
401
def get_branch_transport(self, branch_format):
402
"""Get the transport for use by branch format in this BzrDir.
404
Note that bzr dirs that do not support format strings will raise
405
IncompatibleFormat if the branch format they are given has
406
a format string, and vice versa.
408
If branch_format is None, the transport is returned with no
409
checking. if it is not None, then the returned transport is
410
guaranteed to point to an existing directory ready for use.
412
raise NotImplementedError(self.get_branch_transport)
414
def get_repository_transport(self, repository_format):
415
"""Get the transport for use by repository format in this BzrDir.
417
Note that bzr dirs that do not support format strings will raise
418
IncompatibleFormat if the repository format they are given has
419
a format string, and vice versa.
421
If repository_format is None, the transport is returned with no
422
checking. if it is not None, then the returned transport is
423
guaranteed to point to an existing directory ready for use.
425
raise NotImplementedError(self.get_repository_transport)
427
def get_workingtree_transport(self, tree_format):
428
"""Get the transport for use by workingtree format in this BzrDir.
430
Note that bzr dirs that do not support format strings will raise
431
IncompatibleFormat if the workingtree format they are given has
432
a format string, and vice versa.
434
If workingtree_format is None, the transport is returned with no
435
checking. if it is not None, then the returned transport is
436
guaranteed to point to an existing directory ready for use.
438
raise NotImplementedError(self.get_workingtree_transport)
440
def __init__(self, _transport, _format):
441
"""Initialize a Bzr control dir object.
443
Only really common logic should reside here, concrete classes should be
444
made with varying behaviours.
446
:param _format: the format that is creating this BzrDir instance.
447
:param _transport: the transport this dir is based at.
449
self._format = _format
450
self.transport = _transport.clone('.bzr')
451
self.root_transport = _transport
453
def is_control_filename(self, filename):
454
"""True if filename is the name of a path which is reserved for bzrdir's.
456
:param filename: A filename within the root transport of this bzrdir.
458
This is true IF and ONLY IF the filename is part of the namespace reserved
459
for bzr control dirs. Currently this is the '.bzr' directory in the root
460
of the root_transport. it is expected that plugins will need to extend
461
this in the future - for instance to make bzr talk with svn working
464
# this might be better on the BzrDirFormat class because it refers to
465
# all the possible bzrdir disk formats.
466
# This method is tested via the workingtree is_control_filename tests-
467
# it was extracted from WorkingTree.is_control_filename. If the methods
468
# contract is extended beyond the current trivial implementation please
469
# add new tests for it to the appropriate place.
470
return filename == '.bzr' or filename.startswith('.bzr/')
472
def needs_format_conversion(self, format=None):
473
"""Return true if this bzrdir needs convert_format run on it.
475
For instance, if the repository format is out of date but the
476
branch and working tree are not, this should return True.
478
:param format: Optional parameter indicating a specific desired
479
format we plan to arrive at.
481
raise NotImplementedError(self.needs_format_conversion)
484
def open_unsupported(base):
485
"""Open a branch which is not supported."""
486
return BzrDir.open(base, _unsupported=True)
489
def open(base, _unsupported=False):
490
"""Open an existing bzrdir, rooted at 'base' (url)
492
_unsupported is a private parameter to the BzrDir class.
494
t = get_transport(base)
495
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
498
def open_from_transport(transport, _unsupported=False):
499
"""Open a bzrdir within a particular directory.
501
:param transport: Transport containing the bzrdir.
502
:param _unsupported: private.
504
format = BzrDirFormat.find_format(transport)
505
BzrDir._check_supported(format, _unsupported)
506
return format.open(transport, _found=True)
508
def open_branch(self, unsupported=False):
509
"""Open the branch object at this BzrDir if one is present.
511
If unsupported is True, then no longer supported branch formats can
514
TODO: static convenience version of this?
516
raise NotImplementedError(self.open_branch)
519
def open_containing(url):
520
"""Open an existing branch which contains url.
522
:param url: url to search from.
523
See open_containing_from_transport for more detail.
525
return BzrDir.open_containing_from_transport(get_transport(url))
528
def open_containing_from_transport(a_transport):
529
"""Open an existing branch which contains a_transport.base
531
This probes for a branch at a_transport, and searches upwards from there.
533
Basically we keep looking up until we find the control directory or
534
run into the root. If there isn't one, raises NotBranchError.
535
If there is one and it is either an unrecognised format or an unsupported
536
format, UnknownFormatError or UnsupportedFormatError are raised.
537
If there is one, it is returned, along with the unused portion of url.
539
:return: The BzrDir that contains the path, and a Unicode path
540
for the rest of the URL.
542
# this gets the normalised url back. I.e. '.' -> the full path.
543
url = a_transport.base
546
result = BzrDir.open_from_transport(a_transport)
547
return result, urlutils.unescape(a_transport.relpath(url))
548
except errors.NotBranchError, e:
550
new_t = a_transport.clone('..')
551
if new_t.base == a_transport.base:
552
# reached the root, whatever that may be
553
raise errors.NotBranchError(path=url)
556
def open_repository(self, _unsupported=False):
557
"""Open the repository object at this BzrDir if one is present.
559
This will not follow the Branch object pointer - its strictly a direct
560
open facility. Most client code should use open_branch().repository to
563
_unsupported is a private parameter, not part of the api.
564
TODO: static convenience version of this?
566
raise NotImplementedError(self.open_repository)
568
def open_workingtree(self, _unsupported=False):
569
"""Open the workingtree object at this BzrDir if one is present.
571
TODO: static convenience version of this?
573
raise NotImplementedError(self.open_workingtree)
575
def has_branch(self):
576
"""Tell if this bzrdir contains a branch.
578
Note: if you're going to open the branch, you should just go ahead
579
and try, and not ask permission first. (This method just opens the
580
branch and discards it, and that's somewhat expensive.)
585
except errors.NotBranchError:
588
def has_workingtree(self):
589
"""Tell if this bzrdir contains a working tree.
591
This will still raise an exception if the bzrdir has a workingtree that
592
is remote & inaccessible.
594
Note: if you're going to open the working tree, you should just go ahead
595
and try, and not ask permission first. (This method just opens the
596
workingtree and discards it, and that's somewhat expensive.)
599
self.open_workingtree()
601
except errors.NoWorkingTree:
604
def cloning_metadir(self, basis=None):
605
"""Produce a metadir suitable for cloning with"""
606
def related_repository(bzrdir):
608
branch = bzrdir.open_branch()
609
return branch.repository
610
except errors.NotBranchError:
612
return bzrdir.open_repository()
613
result_format = self._format.__class__()
616
source_repository = related_repository(self)
617
except errors.NoRepositoryPresent:
620
source_repository = related_repository(self)
621
result_format.repository_format = source_repository._format
622
except errors.NoRepositoryPresent:
626
def sprout(self, url, revision_id=None, basis=None, force_new_repo=False):
627
"""Create a copy of this bzrdir prepared for use as a new line of
630
If urls last component does not exist, it will be created.
632
Attributes related to the identity of the source branch like
633
branch nickname will be cleaned, a working tree is created
634
whether one existed before or not; and a local branch is always
637
if revision_id is not None, then the clone operation may tune
638
itself to download less data.
641
cloning_format = self.cloning_metadir(basis)
642
result = cloning_format.initialize(url)
643
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
645
source_branch = self.open_branch()
646
source_repository = source_branch.repository
647
except errors.NotBranchError:
650
source_repository = self.open_repository()
651
except errors.NoRepositoryPresent:
652
# copy the entire basis one if there is one
653
# but there is no repository.
654
source_repository = basis_repo
659
result_repo = result.find_repository()
660
except errors.NoRepositoryPresent:
662
if source_repository is None and result_repo is not None:
664
elif source_repository is None and result_repo is None:
665
# no repo available, make a new one
666
result.create_repository()
667
elif source_repository is not None and result_repo is None:
668
# have source, and want to make a new target repo
669
# we don't clone the repo because that preserves attributes
670
# like is_shared(), and we have not yet implemented a
671
# repository sprout().
672
result_repo = result.create_repository()
673
if result_repo is not None:
674
# fetch needed content into target.
676
# XXX FIXME RBC 20060214 need tests for this when the basis
678
result_repo.fetch(basis_repo, revision_id=revision_id)
679
if source_repository is not None:
680
result_repo.fetch(source_repository, revision_id=revision_id)
681
if source_branch is not None:
682
source_branch.sprout(result, revision_id=revision_id)
684
result.create_branch()
685
# TODO: jam 20060426 we probably need a test in here in the
686
# case that the newly sprouted branch is a remote one
687
if result_repo is None or result_repo.make_working_trees():
688
result.create_workingtree()
692
class BzrDirPreSplitOut(BzrDir):
693
"""A common class for the all-in-one formats."""
695
def __init__(self, _transport, _format):
696
"""See BzrDir.__init__."""
697
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
698
assert self._format._lock_class == lockable_files.TransportLock
699
assert self._format._lock_file_name == 'branch-lock'
700
self._control_files = lockable_files.LockableFiles(
701
self.get_branch_transport(None),
702
self._format._lock_file_name,
703
self._format._lock_class)
705
def break_lock(self):
706
"""Pre-splitout bzrdirs do not suffer from stale locks."""
707
raise NotImplementedError(self.break_lock)
709
def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
710
"""See BzrDir.clone()."""
711
from bzrlib.workingtree import WorkingTreeFormat2
713
result = self._format._initialize_for_clone(url)
714
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
715
self.open_repository().clone(result, revision_id=revision_id, basis=basis_repo)
716
from_branch = self.open_branch()
717
from_branch.clone(result, revision_id=revision_id)
719
self.open_workingtree().clone(result, basis=basis_tree)
720
except errors.NotLocalUrl:
721
# make a new one, this format always has to have one.
723
WorkingTreeFormat2().initialize(result)
724
except errors.NotLocalUrl:
725
# but we cannot do it for remote trees.
726
to_branch = result.open_branch()
727
WorkingTreeFormat2().stub_initialize_remote(to_branch.control_files)
730
def create_branch(self):
731
"""See BzrDir.create_branch."""
732
return self.open_branch()
734
def create_repository(self, shared=False):
735
"""See BzrDir.create_repository."""
737
raise errors.IncompatibleFormat('shared repository', self._format)
738
return self.open_repository()
740
def create_workingtree(self, revision_id=None):
741
"""See BzrDir.create_workingtree."""
742
# this looks buggy but is not -really-
743
# clone and sprout will have set the revision_id
744
# and that will have set it for us, its only
745
# specific uses of create_workingtree in isolation
746
# that can do wonky stuff here, and that only
747
# happens for creating checkouts, which cannot be
748
# done on this format anyway. So - acceptable wart.
749
result = self.open_workingtree()
750
if revision_id is not None:
751
if revision_id == _mod_revision.NULL_REVISION:
752
result.set_parent_ids([])
754
result.set_parent_ids([revision_id])
757
def destroy_workingtree(self):
758
"""See BzrDir.destroy_workingtree."""
759
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
761
def destroy_workingtree_metadata(self):
762
"""See BzrDir.destroy_workingtree_metadata."""
763
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
766
def get_branch_transport(self, branch_format):
767
"""See BzrDir.get_branch_transport()."""
768
if branch_format is None:
769
return self.transport
771
branch_format.get_format_string()
772
except NotImplementedError:
773
return self.transport
774
raise errors.IncompatibleFormat(branch_format, self._format)
776
def get_repository_transport(self, repository_format):
777
"""See BzrDir.get_repository_transport()."""
778
if repository_format is None:
779
return self.transport
781
repository_format.get_format_string()
782
except NotImplementedError:
783
return self.transport
784
raise errors.IncompatibleFormat(repository_format, self._format)
786
def get_workingtree_transport(self, workingtree_format):
787
"""See BzrDir.get_workingtree_transport()."""
788
if workingtree_format is None:
789
return self.transport
791
workingtree_format.get_format_string()
792
except NotImplementedError:
793
return self.transport
794
raise errors.IncompatibleFormat(workingtree_format, self._format)
796
def needs_format_conversion(self, format=None):
797
"""See BzrDir.needs_format_conversion()."""
798
# if the format is not the same as the system default,
799
# an upgrade is needed.
801
format = BzrDirFormat.get_default_format()
802
return not isinstance(self._format, format.__class__)
804
def open_branch(self, unsupported=False):
805
"""See BzrDir.open_branch."""
806
from bzrlib.branch import BzrBranchFormat4
807
format = BzrBranchFormat4()
808
self._check_supported(format, unsupported)
809
return format.open(self, _found=True)
811
def sprout(self, url, revision_id=None, basis=None, force_new_repo=False):
812
"""See BzrDir.sprout()."""
813
from bzrlib.workingtree import WorkingTreeFormat2
815
result = self._format._initialize_for_clone(url)
816
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
818
self.open_repository().clone(result, revision_id=revision_id, basis=basis_repo)
819
except errors.NoRepositoryPresent:
822
self.open_branch().sprout(result, revision_id=revision_id)
823
except errors.NotBranchError:
825
# we always want a working tree
826
WorkingTreeFormat2().initialize(result)
830
class BzrDir4(BzrDirPreSplitOut):
831
"""A .bzr version 4 control object.
833
This is a deprecated format and may be removed after sept 2006.
836
def create_repository(self, shared=False):
837
"""See BzrDir.create_repository."""
838
return self._format.repository_format.initialize(self, shared)
840
def needs_format_conversion(self, format=None):
841
"""Format 4 dirs are always in need of conversion."""
844
def open_repository(self):
845
"""See BzrDir.open_repository."""
846
from bzrlib.repository import RepositoryFormat4
847
return RepositoryFormat4().open(self, _found=True)
850
class BzrDir5(BzrDirPreSplitOut):
851
"""A .bzr version 5 control object.
853
This is a deprecated format and may be removed after sept 2006.
856
def open_repository(self):
857
"""See BzrDir.open_repository."""
858
from bzrlib.repository import RepositoryFormat5
859
return RepositoryFormat5().open(self, _found=True)
861
def open_workingtree(self, _unsupported=False):
862
"""See BzrDir.create_workingtree."""
863
from bzrlib.workingtree import WorkingTreeFormat2
864
return WorkingTreeFormat2().open(self, _found=True)
867
class BzrDir6(BzrDirPreSplitOut):
868
"""A .bzr version 6 control object.
870
This is a deprecated format and may be removed after sept 2006.
873
def open_repository(self):
874
"""See BzrDir.open_repository."""
875
from bzrlib.repository import RepositoryFormat6
876
return RepositoryFormat6().open(self, _found=True)
878
def open_workingtree(self, _unsupported=False):
879
"""See BzrDir.create_workingtree."""
880
from bzrlib.workingtree import WorkingTreeFormat2
881
return WorkingTreeFormat2().open(self, _found=True)
884
class BzrDirMeta1(BzrDir):
885
"""A .bzr meta version 1 control object.
887
This is the first control object where the
888
individual aspects are really split out: there are separate repository,
889
workingtree and branch subdirectories and any subset of the three can be
890
present within a BzrDir.
893
def can_convert_format(self):
894
"""See BzrDir.can_convert_format()."""
897
def create_branch(self):
898
"""See BzrDir.create_branch."""
899
from bzrlib.branch import BranchFormat
900
return BranchFormat.get_default_format().initialize(self)
902
def create_repository(self, shared=False):
903
"""See BzrDir.create_repository."""
904
return self._format.repository_format.initialize(self, shared)
906
def create_workingtree(self, revision_id=None):
907
"""See BzrDir.create_workingtree."""
908
from bzrlib.workingtree import WorkingTreeFormat
909
return WorkingTreeFormat.get_default_format().initialize(self, revision_id)
911
def destroy_workingtree(self):
912
"""See BzrDir.destroy_workingtree."""
913
wt = self.open_workingtree()
914
repository = wt.branch.repository
915
empty = repository.revision_tree(bzrlib.revision.NULL_REVISION)
916
wt.revert([], old_tree=empty)
917
self.destroy_workingtree_metadata()
919
def destroy_workingtree_metadata(self):
920
self.transport.delete_tree('checkout')
922
def _get_mkdir_mode(self):
923
"""Figure out the mode to use when creating a bzrdir subdir."""
924
temp_control = lockable_files.LockableFiles(self.transport, '',
925
lockable_files.TransportLock)
926
return temp_control._dir_mode
928
def get_branch_transport(self, branch_format):
929
"""See BzrDir.get_branch_transport()."""
930
if branch_format is None:
931
return self.transport.clone('branch')
933
branch_format.get_format_string()
934
except NotImplementedError:
935
raise errors.IncompatibleFormat(branch_format, self._format)
937
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
938
except errors.FileExists:
940
return self.transport.clone('branch')
942
def get_repository_transport(self, repository_format):
943
"""See BzrDir.get_repository_transport()."""
944
if repository_format is None:
945
return self.transport.clone('repository')
947
repository_format.get_format_string()
948
except NotImplementedError:
949
raise errors.IncompatibleFormat(repository_format, self._format)
951
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
952
except errors.FileExists:
954
return self.transport.clone('repository')
956
def get_workingtree_transport(self, workingtree_format):
957
"""See BzrDir.get_workingtree_transport()."""
958
if workingtree_format is None:
959
return self.transport.clone('checkout')
961
workingtree_format.get_format_string()
962
except NotImplementedError:
963
raise errors.IncompatibleFormat(workingtree_format, self._format)
965
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
966
except errors.FileExists:
968
return self.transport.clone('checkout')
970
def needs_format_conversion(self, format=None):
971
"""See BzrDir.needs_format_conversion()."""
973
format = BzrDirFormat.get_default_format()
974
if not isinstance(self._format, format.__class__):
975
# it is not a meta dir format, conversion is needed.
977
# we might want to push this down to the repository?
979
if not isinstance(self.open_repository()._format,
980
format.repository_format.__class__):
981
# the repository needs an upgrade.
983
except errors.NoRepositoryPresent:
985
# currently there are no other possible conversions for meta1 formats.
988
def open_branch(self, unsupported=False):
989
"""See BzrDir.open_branch."""
990
from bzrlib.branch import BranchFormat
991
format = BranchFormat.find_format(self)
992
self._check_supported(format, unsupported)
993
return format.open(self, _found=True)
995
def open_repository(self, unsupported=False):
996
"""See BzrDir.open_repository."""
997
from bzrlib.repository import RepositoryFormat
998
format = RepositoryFormat.find_format(self)
999
self._check_supported(format, unsupported)
1000
return format.open(self, _found=True)
1002
def open_workingtree(self, unsupported=False):
1003
"""See BzrDir.open_workingtree."""
1004
from bzrlib.workingtree import WorkingTreeFormat
1005
format = WorkingTreeFormat.find_format(self)
1006
self._check_supported(format, unsupported)
1007
return format.open(self, _found=True)
1010
class BzrDirFormat(object):
1011
"""An encapsulation of the initialization and open routines for a format.
1013
Formats provide three things:
1014
* An initialization routine,
1018
Formats are placed in an dict by their format string for reference
1019
during bzrdir opening. These should be subclasses of BzrDirFormat
1022
Once a format is deprecated, just deprecate the initialize and open
1023
methods on the format class. Do not deprecate the object, as the
1024
object will be created every system load.
1027
_default_format = None
1028
"""The default format used for new .bzr dirs."""
1031
"""The known formats."""
1033
_control_formats = []
1034
"""The registered control formats - .bzr, ....
1036
This is a list of BzrDirFormat objects.
1039
_lock_file_name = 'branch-lock'
1041
# _lock_class must be set in subclasses to the lock type, typ.
1042
# TransportLock or LockDir
1045
def find_format(klass, transport):
1046
"""Return the format present at transport."""
1047
for format in klass._control_formats:
1049
return format.probe_transport(transport)
1050
except errors.NotBranchError:
1051
# this format does not find a control dir here.
1053
raise errors.NotBranchError(path=transport.base)
1056
def probe_transport(klass, transport):
1057
"""Return the .bzrdir style transport present at URL."""
1059
format_string = transport.get(".bzr/branch-format").read()
1060
except errors.NoSuchFile:
1061
raise errors.NotBranchError(path=transport.base)
1064
return klass._formats[format_string]
1066
raise errors.UnknownFormatError(format=format_string)
1069
def get_default_format(klass):
1070
"""Return the current default format."""
1071
return klass._default_format
1073
def get_format_string(self):
1074
"""Return the ASCII format string that identifies this format."""
1075
raise NotImplementedError(self.get_format_string)
1077
def get_format_description(self):
1078
"""Return the short description for this format."""
1079
raise NotImplementedError(self.get_format_description)
1081
def get_converter(self, format=None):
1082
"""Return the converter to use to convert bzrdirs needing converts.
1084
This returns a bzrlib.bzrdir.Converter object.
1086
This should return the best upgrader to step this format towards the
1087
current default format. In the case of plugins we can/should provide
1088
some means for them to extend the range of returnable converters.
1090
:param format: Optional format to override the default format of the
1093
raise NotImplementedError(self.get_converter)
1095
def initialize(self, url):
1096
"""Create a bzr control dir at this url and return an opened copy.
1098
Subclasses should typically override initialize_on_transport
1099
instead of this method.
1101
return self.initialize_on_transport(get_transport(url))
1103
def initialize_on_transport(self, transport):
1104
"""Initialize a new bzrdir in the base directory of a Transport."""
1105
# Since we don't have a .bzr directory, inherit the
1106
# mode from the root directory
1107
temp_control = lockable_files.LockableFiles(transport,
1108
'', lockable_files.TransportLock)
1109
temp_control._transport.mkdir('.bzr',
1110
# FIXME: RBC 20060121 don't peek under
1112
mode=temp_control._dir_mode)
1113
file_mode = temp_control._file_mode
1115
mutter('created control directory in ' + transport.base)
1116
control = transport.clone('.bzr')
1117
utf8_files = [('README',
1118
"This is a Bazaar-NG control directory.\n"
1119
"Do not change any files in this directory.\n"),
1120
('branch-format', self.get_format_string()),
1122
# NB: no need to escape relative paths that are url safe.
1123
control_files = lockable_files.LockableFiles(control,
1124
self._lock_file_name, self._lock_class)
1125
control_files.create_lock()
1126
control_files.lock_write()
1128
for file, content in utf8_files:
1129
control_files.put_utf8(file, content)
1131
control_files.unlock()
1132
return self.open(transport, _found=True)
1134
def is_supported(self):
1135
"""Is this format supported?
1137
Supported formats must be initializable and openable.
1138
Unsupported formats may not support initialization or committing or
1139
some other features depending on the reason for not being supported.
1143
def same_model(self, target_format):
1144
return (self.repository_format.rich_root_data ==
1145
target_format.rich_root_data)
1148
def known_formats(klass):
1149
"""Return all the known formats.
1151
Concrete formats should override _known_formats.
1153
# There is double indirection here to make sure that control
1154
# formats used by more than one dir format will only be probed
1155
# once. This can otherwise be quite expensive for remote connections.
1157
for format in klass._control_formats:
1158
result.update(format._known_formats())
1162
def _known_formats(klass):
1163
"""Return the known format instances for this control format."""
1164
return set(klass._formats.values())
1166
def open(self, transport, _found=False):
1167
"""Return an instance of this format for the dir transport points at.
1169
_found is a private parameter, do not use it.
1172
assert isinstance(BzrDirFormat.find_format(transport),
1174
return self._open(transport)
1176
def _open(self, transport):
1177
"""Template method helper for opening BzrDirectories.
1179
This performs the actual open and any additional logic or parameter
1182
raise NotImplementedError(self._open)
1185
def register_format(klass, format):
1186
klass._formats[format.get_format_string()] = format
1189
def register_control_format(klass, format):
1190
"""Register a format that does not use '.bzrdir' for its control dir.
1192
TODO: This should be pulled up into a 'ControlDirFormat' base class
1193
which BzrDirFormat can inherit from, and renamed to register_format
1194
there. It has been done without that for now for simplicity of
1197
klass._control_formats.append(format)
1200
def set_default_format(klass, format):
1201
klass._default_format = format
1204
return self.get_format_string()[:-1]
1207
def unregister_format(klass, format):
1208
assert klass._formats[format.get_format_string()] is format
1209
del klass._formats[format.get_format_string()]
1212
def unregister_control_format(klass, format):
1213
klass._control_formats.remove(format)
1216
# register BzrDirFormat as a control format
1217
BzrDirFormat.register_control_format(BzrDirFormat)
1220
class BzrDirFormat4(BzrDirFormat):
1221
"""Bzr dir format 4.
1223
This format is a combined format for working tree, branch and repository.
1225
- Format 1 working trees [always]
1226
- Format 4 branches [always]
1227
- Format 4 repositories [always]
1229
This format is deprecated: it indexes texts using a text it which is
1230
removed in format 5; write support for this format has been removed.
1233
_lock_class = lockable_files.TransportLock
1235
def get_format_string(self):
1236
"""See BzrDirFormat.get_format_string()."""
1237
return "Bazaar-NG branch, format 0.0.4\n"
1239
def get_format_description(self):
1240
"""See BzrDirFormat.get_format_description()."""
1241
return "All-in-one format 4"
1243
def get_converter(self, format=None):
1244
"""See BzrDirFormat.get_converter()."""
1245
# there is one and only one upgrade path here.
1246
return ConvertBzrDir4To5()
1248
def initialize_on_transport(self, transport):
1249
"""Format 4 branches cannot be created."""
1250
raise errors.UninitializableFormat(self)
1252
def is_supported(self):
1253
"""Format 4 is not supported.
1255
It is not supported because the model changed from 4 to 5 and the
1256
conversion logic is expensive - so doing it on the fly was not
1261
def _open(self, transport):
1262
"""See BzrDirFormat._open."""
1263
return BzrDir4(transport, self)
1265
def __return_repository_format(self):
1266
"""Circular import protection."""
1267
from bzrlib.repository import RepositoryFormat4
1268
return RepositoryFormat4()
1269
repository_format = property(__return_repository_format)
1272
class BzrDirFormat5(BzrDirFormat):
1273
"""Bzr control format 5.
1275
This format is a combined format for working tree, branch and repository.
1277
- Format 2 working trees [always]
1278
- Format 4 branches [always]
1279
- Format 5 repositories [always]
1280
Unhashed stores in the repository.
1283
_lock_class = lockable_files.TransportLock
1285
def get_format_string(self):
1286
"""See BzrDirFormat.get_format_string()."""
1287
return "Bazaar-NG branch, format 5\n"
1289
def get_format_description(self):
1290
"""See BzrDirFormat.get_format_description()."""
1291
return "All-in-one format 5"
1293
def get_converter(self, format=None):
1294
"""See BzrDirFormat.get_converter()."""
1295
# there is one and only one upgrade path here.
1296
return ConvertBzrDir5To6()
1298
def _initialize_for_clone(self, url):
1299
return self.initialize_on_transport(get_transport(url), _cloning=True)
1301
def initialize_on_transport(self, transport, _cloning=False):
1302
"""Format 5 dirs always have working tree, branch and repository.
1304
Except when they are being cloned.
1306
from bzrlib.branch import BzrBranchFormat4
1307
from bzrlib.repository import RepositoryFormat5
1308
from bzrlib.workingtree import WorkingTreeFormat2
1309
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1310
RepositoryFormat5().initialize(result, _internal=True)
1312
branch = BzrBranchFormat4().initialize(result)
1314
WorkingTreeFormat2().initialize(result)
1315
except errors.NotLocalUrl:
1316
# Even though we can't access the working tree, we need to
1317
# create its control files.
1318
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1321
def _open(self, transport):
1322
"""See BzrDirFormat._open."""
1323
return BzrDir5(transport, self)
1325
def __return_repository_format(self):
1326
"""Circular import protection."""
1327
from bzrlib.repository import RepositoryFormat5
1328
return RepositoryFormat5()
1329
repository_format = property(__return_repository_format)
1332
class BzrDirFormat6(BzrDirFormat):
1333
"""Bzr control format 6.
1335
This format is a combined format for working tree, branch and repository.
1337
- Format 2 working trees [always]
1338
- Format 4 branches [always]
1339
- Format 6 repositories [always]
1342
_lock_class = lockable_files.TransportLock
1344
def get_format_string(self):
1345
"""See BzrDirFormat.get_format_string()."""
1346
return "Bazaar-NG branch, format 6\n"
1348
def get_format_description(self):
1349
"""See BzrDirFormat.get_format_description()."""
1350
return "All-in-one format 6"
1352
def get_converter(self, format=None):
1353
"""See BzrDirFormat.get_converter()."""
1354
# there is one and only one upgrade path here.
1355
return ConvertBzrDir6ToMeta()
1357
def _initialize_for_clone(self, url):
1358
return self.initialize_on_transport(get_transport(url), _cloning=True)
1360
def initialize_on_transport(self, transport, _cloning=False):
1361
"""Format 6 dirs always have working tree, branch and repository.
1363
Except when they are being cloned.
1365
from bzrlib.branch import BzrBranchFormat4
1366
from bzrlib.repository import RepositoryFormat6
1367
from bzrlib.workingtree import WorkingTreeFormat2
1368
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1369
RepositoryFormat6().initialize(result, _internal=True)
1371
branch = BzrBranchFormat4().initialize(result)
1373
WorkingTreeFormat2().initialize(result)
1374
except errors.NotLocalUrl:
1375
# Even though we can't access the working tree, we need to
1376
# create its control files.
1377
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1380
def _open(self, transport):
1381
"""See BzrDirFormat._open."""
1382
return BzrDir6(transport, self)
1384
def __return_repository_format(self):
1385
"""Circular import protection."""
1386
from bzrlib.repository import RepositoryFormat6
1387
return RepositoryFormat6()
1388
repository_format = property(__return_repository_format)
1391
class BzrDirMetaFormat1(BzrDirFormat):
1392
"""Bzr meta control format 1
1394
This is the first format with split out working tree, branch and repository
1397
- Format 3 working trees [optional]
1398
- Format 5 branches [optional]
1399
- Format 7 repositories [optional]
1402
_lock_class = lockdir.LockDir
1404
def get_converter(self, format=None):
1405
"""See BzrDirFormat.get_converter()."""
1407
format = BzrDirFormat.get_default_format()
1408
if not isinstance(self, format.__class__):
1409
# converting away from metadir is not implemented
1410
raise NotImplementedError(self.get_converter)
1411
return ConvertMetaToMeta(format)
1413
def get_format_string(self):
1414
"""See BzrDirFormat.get_format_string()."""
1415
return "Bazaar-NG meta directory, format 1\n"
1417
def get_format_description(self):
1418
"""See BzrDirFormat.get_format_description()."""
1419
return "Meta directory format 1"
1421
def _open(self, transport):
1422
"""See BzrDirFormat._open."""
1423
return BzrDirMeta1(transport, self)
1425
def __return_repository_format(self):
1426
"""Circular import protection."""
1427
if getattr(self, '_repository_format', None):
1428
return self._repository_format
1429
from bzrlib.repository import RepositoryFormat
1430
return RepositoryFormat.get_default_format()
1432
def __set_repository_format(self, value):
1433
"""Allow changint the repository format for metadir formats."""
1434
self._repository_format = value
1436
repository_format = property(__return_repository_format, __set_repository_format)
1439
BzrDirFormat.register_format(BzrDirFormat4())
1440
BzrDirFormat.register_format(BzrDirFormat5())
1441
BzrDirFormat.register_format(BzrDirFormat6())
1442
__default_format = BzrDirMetaFormat1()
1443
BzrDirFormat.register_format(__default_format)
1444
BzrDirFormat.set_default_format(__default_format)
1447
class BzrDirTestProviderAdapter(object):
1448
"""A tool to generate a suite testing multiple bzrdir formats at once.
1450
This is done by copying the test once for each transport and injecting
1451
the transport_server, transport_readonly_server, and bzrdir_format
1452
classes into each copy. Each copy is also given a new id() to make it
1456
def __init__(self, transport_server, transport_readonly_server, formats):
1457
self._transport_server = transport_server
1458
self._transport_readonly_server = transport_readonly_server
1459
self._formats = formats
1461
def adapt(self, test):
1462
result = unittest.TestSuite()
1463
for format in self._formats:
1464
new_test = deepcopy(test)
1465
new_test.transport_server = self._transport_server
1466
new_test.transport_readonly_server = self._transport_readonly_server
1467
new_test.bzrdir_format = format
1468
def make_new_test_id():
1469
new_id = "%s(%s)" % (new_test.id(), format.__class__.__name__)
1470
return lambda: new_id
1471
new_test.id = make_new_test_id()
1472
result.addTest(new_test)
1476
class Converter(object):
1477
"""Converts a disk format object from one format to another."""
1479
def convert(self, to_convert, pb):
1480
"""Perform the conversion of to_convert, giving feedback via pb.
1482
:param to_convert: The disk object to convert.
1483
:param pb: a progress bar to use for progress information.
1486
def step(self, message):
1487
"""Update the pb by a step."""
1489
self.pb.update(message, self.count, self.total)
1492
class ConvertBzrDir4To5(Converter):
1493
"""Converts format 4 bzr dirs to format 5."""
1496
super(ConvertBzrDir4To5, self).__init__()
1497
self.converted_revs = set()
1498
self.absent_revisions = set()
1502
def convert(self, to_convert, pb):
1503
"""See Converter.convert()."""
1504
self.bzrdir = to_convert
1506
self.pb.note('starting upgrade from format 4 to 5')
1507
if isinstance(self.bzrdir.transport, LocalTransport):
1508
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
1509
self._convert_to_weaves()
1510
return BzrDir.open(self.bzrdir.root_transport.base)
1512
def _convert_to_weaves(self):
1513
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
1516
stat = self.bzrdir.transport.stat('weaves')
1517
if not S_ISDIR(stat.st_mode):
1518
self.bzrdir.transport.delete('weaves')
1519
self.bzrdir.transport.mkdir('weaves')
1520
except errors.NoSuchFile:
1521
self.bzrdir.transport.mkdir('weaves')
1522
# deliberately not a WeaveFile as we want to build it up slowly.
1523
self.inv_weave = Weave('inventory')
1524
# holds in-memory weaves for all files
1525
self.text_weaves = {}
1526
self.bzrdir.transport.delete('branch-format')
1527
self.branch = self.bzrdir.open_branch()
1528
self._convert_working_inv()
1529
rev_history = self.branch.revision_history()
1530
# to_read is a stack holding the revisions we still need to process;
1531
# appending to it adds new highest-priority revisions
1532
self.known_revisions = set(rev_history)
1533
self.to_read = rev_history[-1:]
1535
rev_id = self.to_read.pop()
1536
if (rev_id not in self.revisions
1537
and rev_id not in self.absent_revisions):
1538
self._load_one_rev(rev_id)
1540
to_import = self._make_order()
1541
for i, rev_id in enumerate(to_import):
1542
self.pb.update('converting revision', i, len(to_import))
1543
self._convert_one_rev(rev_id)
1545
self._write_all_weaves()
1546
self._write_all_revs()
1547
self.pb.note('upgraded to weaves:')
1548
self.pb.note(' %6d revisions and inventories', len(self.revisions))
1549
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
1550
self.pb.note(' %6d texts', self.text_count)
1551
self._cleanup_spare_files_after_format4()
1552
self.branch.control_files.put_utf8('branch-format', BzrDirFormat5().get_format_string())
1554
def _cleanup_spare_files_after_format4(self):
1555
# FIXME working tree upgrade foo.
1556
for n in 'merged-patches', 'pending-merged-patches':
1558
## assert os.path.getsize(p) == 0
1559
self.bzrdir.transport.delete(n)
1560
except errors.NoSuchFile:
1562
self.bzrdir.transport.delete_tree('inventory-store')
1563
self.bzrdir.transport.delete_tree('text-store')
1565
def _convert_working_inv(self):
1566
inv = xml4.serializer_v4.read_inventory(
1567
self.branch.control_files.get('inventory'))
1568
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
1569
# FIXME inventory is a working tree change.
1570
self.branch.control_files.put('inventory', StringIO(new_inv_xml))
1572
def _write_all_weaves(self):
1573
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
1574
weave_transport = self.bzrdir.transport.clone('weaves')
1575
weaves = WeaveStore(weave_transport, prefixed=False)
1576
transaction = WriteTransaction()
1580
for file_id, file_weave in self.text_weaves.items():
1581
self.pb.update('writing weave', i, len(self.text_weaves))
1582
weaves._put_weave(file_id, file_weave, transaction)
1584
self.pb.update('inventory', 0, 1)
1585
controlweaves._put_weave('inventory', self.inv_weave, transaction)
1586
self.pb.update('inventory', 1, 1)
1590
def _write_all_revs(self):
1591
"""Write all revisions out in new form."""
1592
self.bzrdir.transport.delete_tree('revision-store')
1593
self.bzrdir.transport.mkdir('revision-store')
1594
revision_transport = self.bzrdir.transport.clone('revision-store')
1596
_revision_store = TextRevisionStore(TextStore(revision_transport,
1600
transaction = WriteTransaction()
1601
for i, rev_id in enumerate(self.converted_revs):
1602
self.pb.update('write revision', i, len(self.converted_revs))
1603
_revision_store.add_revision(self.revisions[rev_id], transaction)
1607
def _load_one_rev(self, rev_id):
1608
"""Load a revision object into memory.
1610
Any parents not either loaded or abandoned get queued to be
1612
self.pb.update('loading revision',
1613
len(self.revisions),
1614
len(self.known_revisions))
1615
if not self.branch.repository.has_revision(rev_id):
1617
self.pb.note('revision {%s} not present in branch; '
1618
'will be converted as a ghost',
1620
self.absent_revisions.add(rev_id)
1622
rev = self.branch.repository._revision_store.get_revision(rev_id,
1623
self.branch.repository.get_transaction())
1624
for parent_id in rev.parent_ids:
1625
self.known_revisions.add(parent_id)
1626
self.to_read.append(parent_id)
1627
self.revisions[rev_id] = rev
1629
def _load_old_inventory(self, rev_id):
1630
assert rev_id not in self.converted_revs
1631
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
1632
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
1633
inv.revision_id = rev_id
1634
rev = self.revisions[rev_id]
1635
if rev.inventory_sha1:
1636
assert rev.inventory_sha1 == sha_string(old_inv_xml), \
1637
'inventory sha mismatch for {%s}' % rev_id
1640
def _load_updated_inventory(self, rev_id):
1641
assert rev_id in self.converted_revs
1642
inv_xml = self.inv_weave.get_text(rev_id)
1643
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml)
1646
def _convert_one_rev(self, rev_id):
1647
"""Convert revision and all referenced objects to new format."""
1648
rev = self.revisions[rev_id]
1649
inv = self._load_old_inventory(rev_id)
1650
present_parents = [p for p in rev.parent_ids
1651
if p not in self.absent_revisions]
1652
self._convert_revision_contents(rev, inv, present_parents)
1653
self._store_new_weave(rev, inv, present_parents)
1654
self.converted_revs.add(rev_id)
1656
def _store_new_weave(self, rev, inv, present_parents):
1657
# the XML is now updated with text versions
1659
entries = inv.iter_entries()
1661
for path, ie in entries:
1662
assert getattr(ie, 'revision', None) is not None, \
1663
'no revision on {%s} in {%s}' % \
1664
(file_id, rev.revision_id)
1665
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
1666
new_inv_sha1 = sha_string(new_inv_xml)
1667
self.inv_weave.add_lines(rev.revision_id,
1669
new_inv_xml.splitlines(True))
1670
rev.inventory_sha1 = new_inv_sha1
1672
def _convert_revision_contents(self, rev, inv, present_parents):
1673
"""Convert all the files within a revision.
1675
Also upgrade the inventory to refer to the text revision ids."""
1676
rev_id = rev.revision_id
1677
mutter('converting texts of revision {%s}',
1679
parent_invs = map(self._load_updated_inventory, present_parents)
1680
entries = inv.iter_entries()
1682
for path, ie in entries:
1683
self._convert_file_version(rev, ie, parent_invs)
1685
def _convert_file_version(self, rev, ie, parent_invs):
1686
"""Convert one version of one file.
1688
The file needs to be added into the weave if it is a merge
1689
of >=2 parents or if it's changed from its parent.
1691
file_id = ie.file_id
1692
rev_id = rev.revision_id
1693
w = self.text_weaves.get(file_id)
1696
self.text_weaves[file_id] = w
1697
text_changed = False
1698
previous_entries = ie.find_previous_heads(parent_invs,
1702
for old_revision in previous_entries:
1703
# if this fails, its a ghost ?
1704
assert old_revision in self.converted_revs
1705
self.snapshot_ie(previous_entries, ie, w, rev_id)
1707
assert getattr(ie, 'revision', None) is not None
1709
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
1710
# TODO: convert this logic, which is ~= snapshot to
1711
# a call to:. This needs the path figured out. rather than a work_tree
1712
# a v4 revision_tree can be given, or something that looks enough like
1713
# one to give the file content to the entry if it needs it.
1714
# and we need something that looks like a weave store for snapshot to
1716
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
1717
if len(previous_revisions) == 1:
1718
previous_ie = previous_revisions.values()[0]
1719
if ie._unchanged(previous_ie):
1720
ie.revision = previous_ie.revision
1723
text = self.branch.repository.text_store.get(ie.text_id)
1724
file_lines = text.readlines()
1725
assert sha_strings(file_lines) == ie.text_sha1
1726
assert sum(map(len, file_lines)) == ie.text_size
1727
w.add_lines(rev_id, previous_revisions, file_lines)
1728
self.text_count += 1
1730
w.add_lines(rev_id, previous_revisions, [])
1731
ie.revision = rev_id
1733
def _make_order(self):
1734
"""Return a suitable order for importing revisions.
1736
The order must be such that an revision is imported after all
1737
its (present) parents.
1739
todo = set(self.revisions.keys())
1740
done = self.absent_revisions.copy()
1743
# scan through looking for a revision whose parents
1745
for rev_id in sorted(list(todo)):
1746
rev = self.revisions[rev_id]
1747
parent_ids = set(rev.parent_ids)
1748
if parent_ids.issubset(done):
1749
# can take this one now
1750
order.append(rev_id)
1756
class ConvertBzrDir5To6(Converter):
1757
"""Converts format 5 bzr dirs to format 6."""
1759
def convert(self, to_convert, pb):
1760
"""See Converter.convert()."""
1761
self.bzrdir = to_convert
1763
self.pb.note('starting upgrade from format 5 to 6')
1764
self._convert_to_prefixed()
1765
return BzrDir.open(self.bzrdir.root_transport.base)
1767
def _convert_to_prefixed(self):
1768
from bzrlib.store import TransportStore
1769
self.bzrdir.transport.delete('branch-format')
1770
for store_name in ["weaves", "revision-store"]:
1771
self.pb.note("adding prefixes to %s" % store_name)
1772
store_transport = self.bzrdir.transport.clone(store_name)
1773
store = TransportStore(store_transport, prefixed=True)
1774
for urlfilename in store_transport.list_dir('.'):
1775
filename = urlutils.unescape(urlfilename)
1776
if (filename.endswith(".weave") or
1777
filename.endswith(".gz") or
1778
filename.endswith(".sig")):
1779
file_id = os.path.splitext(filename)[0]
1782
prefix_dir = store.hash_prefix(file_id)
1783
# FIXME keep track of the dirs made RBC 20060121
1785
store_transport.move(filename, prefix_dir + '/' + filename)
1786
except errors.NoSuchFile: # catches missing dirs strangely enough
1787
store_transport.mkdir(prefix_dir)
1788
store_transport.move(filename, prefix_dir + '/' + filename)
1789
self.bzrdir._control_files.put_utf8('branch-format', BzrDirFormat6().get_format_string())
1792
class ConvertBzrDir6ToMeta(Converter):
1793
"""Converts format 6 bzr dirs to metadirs."""
1795
def convert(self, to_convert, pb):
1796
"""See Converter.convert()."""
1797
self.bzrdir = to_convert
1800
self.total = 20 # the steps we know about
1801
self.garbage_inventories = []
1803
self.pb.note('starting upgrade from format 6 to metadir')
1804
self.bzrdir._control_files.put_utf8('branch-format', "Converting to format 6")
1805
# its faster to move specific files around than to open and use the apis...
1806
# first off, nuke ancestry.weave, it was never used.
1808
self.step('Removing ancestry.weave')
1809
self.bzrdir.transport.delete('ancestry.weave')
1810
except errors.NoSuchFile:
1812
# find out whats there
1813
self.step('Finding branch files')
1814
last_revision = self.bzrdir.open_branch().last_revision()
1815
bzrcontents = self.bzrdir.transport.list_dir('.')
1816
for name in bzrcontents:
1817
if name.startswith('basis-inventory.'):
1818
self.garbage_inventories.append(name)
1819
# create new directories for repository, working tree and branch
1820
self.dir_mode = self.bzrdir._control_files._dir_mode
1821
self.file_mode = self.bzrdir._control_files._file_mode
1822
repository_names = [('inventory.weave', True),
1823
('revision-store', True),
1825
self.step('Upgrading repository ')
1826
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
1827
self.make_lock('repository')
1828
# we hard code the formats here because we are converting into
1829
# the meta format. The meta format upgrader can take this to a
1830
# future format within each component.
1831
self.put_format('repository', bzrlib.repository.RepositoryFormat7())
1832
for entry in repository_names:
1833
self.move_entry('repository', entry)
1835
self.step('Upgrading branch ')
1836
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
1837
self.make_lock('branch')
1838
self.put_format('branch', bzrlib.branch.BzrBranchFormat5())
1839
branch_files = [('revision-history', True),
1840
('branch-name', True),
1842
for entry in branch_files:
1843
self.move_entry('branch', entry)
1845
checkout_files = [('pending-merges', True),
1846
('inventory', True),
1847
('stat-cache', False)]
1848
# If a mandatory checkout file is not present, the branch does not have
1849
# a functional checkout. Do not create a checkout in the converted
1851
for name, mandatory in checkout_files:
1852
if mandatory and name not in bzrcontents:
1853
has_checkout = False
1857
if not has_checkout:
1858
self.pb.note('No working tree.')
1859
# If some checkout files are there, we may as well get rid of them.
1860
for name, mandatory in checkout_files:
1861
if name in bzrcontents:
1862
self.bzrdir.transport.delete(name)
1864
self.step('Upgrading working tree')
1865
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
1866
self.make_lock('checkout')
1868
'checkout', bzrlib.workingtree.WorkingTreeFormat3())
1869
self.bzrdir.transport.delete_multi(
1870
self.garbage_inventories, self.pb)
1871
for entry in checkout_files:
1872
self.move_entry('checkout', entry)
1873
if last_revision is not None:
1874
self.bzrdir._control_files.put_utf8(
1875
'checkout/last-revision', last_revision)
1876
self.bzrdir._control_files.put_utf8(
1877
'branch-format', BzrDirMetaFormat1().get_format_string())
1878
return BzrDir.open(self.bzrdir.root_transport.base)
1880
def make_lock(self, name):
1881
"""Make a lock for the new control dir name."""
1882
self.step('Make %s lock' % name)
1883
ld = lockdir.LockDir(self.bzrdir.transport,
1885
file_modebits=self.file_mode,
1886
dir_modebits=self.dir_mode)
1889
def move_entry(self, new_dir, entry):
1890
"""Move then entry name into new_dir."""
1892
mandatory = entry[1]
1893
self.step('Moving %s' % name)
1895
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
1896
except errors.NoSuchFile:
1900
def put_format(self, dirname, format):
1901
self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
1904
class ConvertMetaToMeta(Converter):
1905
"""Converts the components of metadirs."""
1907
def __init__(self, target_format):
1908
"""Create a metadir to metadir converter.
1910
:param target_format: The final metadir format that is desired.
1912
self.target_format = target_format
1914
def convert(self, to_convert, pb):
1915
"""See Converter.convert()."""
1916
self.bzrdir = to_convert
1920
self.step('checking repository format')
1922
repo = self.bzrdir.open_repository()
1923
except errors.NoRepositoryPresent:
1926
if not isinstance(repo._format, self.target_format.repository_format.__class__):
1927
from bzrlib.repository import CopyConverter
1928
self.pb.note('starting repository conversion')
1929
converter = CopyConverter(self.target_format.repository_format)
1930
converter.convert(repo, pb)
added
removed
bzrlib/bzrdir.py
