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,
46
repository as _mod_repository,
51
from bzrlib.osutils import (
56
from bzrlib.store.revision.text import TextRevisionStore
57
from bzrlib.store.text import TextStore
58
from bzrlib.store.versioned import WeaveStore
59
from bzrlib.transactions import WriteTransaction
60
from bzrlib.transport import get_transport
61
from bzrlib.weave import Weave
64
from bzrlib.trace import mutter
65
from bzrlib.transport.local import LocalTransport
69
"""A .bzr control diretory.
71
BzrDir instances let you create or open any of the things that can be
72
found within .bzr - checkouts, branches and repositories.
75
the transport which this bzr dir is rooted at (i.e. file:///.../.bzr/)
77
a transport connected to the directory this bzr was opened from.
81
"""Invoke break_lock on the first object in the bzrdir.
83
If there is a tree, the tree is opened and break_lock() called.
84
Otherwise, branch is tried, and finally repository.
87
thing_to_unlock = self.open_workingtree()
88
except (errors.NotLocalUrl, errors.NoWorkingTree):
90
thing_to_unlock = self.open_branch()
91
except errors.NotBranchError:
93
thing_to_unlock = self.open_repository()
94
except errors.NoRepositoryPresent:
96
thing_to_unlock.break_lock()
98
def can_convert_format(self):
99
"""Return true if this bzrdir is one whose format we can convert from."""
102
def check_conversion_target(self, target_format):
103
target_repo_format = target_format.repository_format
104
source_repo_format = self._format.repository_format
105
source_repo_format.check_conversion_target(target_repo_format)
108
def _check_supported(format, allow_unsupported):
109
"""Check whether format is a supported format.
111
If allow_unsupported is True, this is a no-op.
113
if not allow_unsupported and not format.is_supported():
114
# see open_downlevel to open legacy branches.
115
raise errors.UnsupportedFormatError(format=format)
117
def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
118
"""Clone this bzrdir and its contents to url verbatim.
120
If urls last component does not exist, it will be created.
122
if revision_id is not None, then the clone operation may tune
123
itself to download less data.
124
:param force_new_repo: Do not use a shared repository for the target
125
even if one is available.
128
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
129
result = self._format.initialize(url)
131
local_repo = self.find_repository()
132
except errors.NoRepositoryPresent:
135
# may need to copy content in
137
result_repo = local_repo.clone(
139
revision_id=revision_id,
141
result_repo.set_make_working_trees(local_repo.make_working_trees())
144
result_repo = result.find_repository()
145
# fetch content this dir needs.
147
# XXX FIXME RBC 20060214 need tests for this when the basis
149
result_repo.fetch(basis_repo, revision_id=revision_id)
150
result_repo.fetch(local_repo, revision_id=revision_id)
151
except errors.NoRepositoryPresent:
152
# needed to make one anyway.
153
result_repo = local_repo.clone(
155
revision_id=revision_id,
157
result_repo.set_make_working_trees(local_repo.make_working_trees())
158
# 1 if there is a branch present
159
# make sure its content is available in the target repository
162
self.open_branch().clone(result, revision_id=revision_id)
163
except errors.NotBranchError:
166
self.open_workingtree().clone(result, basis=basis_tree)
167
except (errors.NoWorkingTree, errors.NotLocalUrl):
171
def _get_basis_components(self, basis):
172
"""Retrieve the basis components that are available at basis."""
174
return None, None, None
176
basis_tree = basis.open_workingtree()
177
basis_branch = basis_tree.branch
178
basis_repo = basis_branch.repository
179
except (errors.NoWorkingTree, errors.NotLocalUrl):
182
basis_branch = basis.open_branch()
183
basis_repo = basis_branch.repository
184
except errors.NotBranchError:
187
basis_repo = basis.open_repository()
188
except errors.NoRepositoryPresent:
190
return basis_repo, basis_branch, basis_tree
192
# TODO: This should be given a Transport, and should chdir up; otherwise
193
# this will open a new connection.
194
def _make_tail(self, url):
195
head, tail = urlutils.split(url)
196
if tail and tail != '.':
197
t = get_transport(head)
200
except errors.FileExists:
203
# TODO: Should take a Transport
205
def create(cls, base):
206
"""Create a new BzrDir at the url 'base'.
208
This will call the current default formats initialize with base
209
as the only parameter.
211
If you need a specific format, consider creating an instance
212
of that and calling initialize().
214
if cls is not BzrDir:
215
raise AssertionError("BzrDir.create always creates the default format, "
216
"not one of %r" % cls)
217
head, tail = urlutils.split(base)
218
if tail and tail != '.':
219
t = get_transport(head)
222
except errors.FileExists:
224
return BzrDirFormat.get_default_format().initialize(safe_unicode(base))
226
def create_branch(self):
227
"""Create a branch in this BzrDir.
229
The bzrdirs format will control what branch format is created.
230
For more control see BranchFormatXX.create(a_bzrdir).
232
raise NotImplementedError(self.create_branch)
235
def create_branch_and_repo(base, force_new_repo=False):
236
"""Create a new BzrDir, Branch and Repository at the url 'base'.
238
This will use the current default BzrDirFormat, and use whatever
239
repository format that that uses via bzrdir.create_branch and
240
create_repository. If a shared repository is available that is used
243
The created Branch object is returned.
245
:param base: The URL to create the branch at.
246
:param force_new_repo: If True a new repository is always created.
248
bzrdir = BzrDir.create(base)
249
bzrdir._find_or_create_repository(force_new_repo)
250
return bzrdir.create_branch()
252
def _find_or_create_repository(self, force_new_repo):
253
"""Create a new repository if needed, returning the repository."""
255
return self.create_repository()
257
return self.find_repository()
258
except errors.NoRepositoryPresent:
259
return self.create_repository()
262
def create_branch_convenience(base, force_new_repo=False,
263
force_new_tree=None, format=None):
264
"""Create a new BzrDir, Branch and Repository at the url 'base'.
266
This is a convenience function - it will use an existing repository
267
if possible, can be told explicitly whether to create a working tree or
270
This will use the current default BzrDirFormat, and use whatever
271
repository format that that uses via bzrdir.create_branch and
272
create_repository. If a shared repository is available that is used
273
preferentially. Whatever repository is used, its tree creation policy
276
The created Branch object is returned.
277
If a working tree cannot be made due to base not being a file:// url,
278
no error is raised unless force_new_tree is True, in which case no
279
data is created on disk and NotLocalUrl is raised.
281
:param base: The URL to create the branch at.
282
:param force_new_repo: If True a new repository is always created.
283
:param force_new_tree: If True or False force creation of a tree or
284
prevent such creation respectively.
285
:param format: Override for the for the bzrdir format to create
288
# check for non local urls
289
t = get_transport(safe_unicode(base))
290
if not isinstance(t, LocalTransport):
291
raise errors.NotLocalUrl(base)
293
bzrdir = BzrDir.create(base)
295
bzrdir = format.initialize(base)
296
repo = bzrdir._find_or_create_repository(force_new_repo)
297
result = bzrdir.create_branch()
298
if force_new_tree or (repo.make_working_trees() and
299
force_new_tree is None):
301
bzrdir.create_workingtree()
302
except errors.NotLocalUrl:
307
def create_repository(base, shared=False):
308
"""Create a new BzrDir and Repository at the url 'base'.
310
This will use the current default BzrDirFormat, and use whatever
311
repository format that that uses for bzrdirformat.create_repository.
313
:param shared: Create a shared repository rather than a standalone
315
The Repository object is returned.
317
This must be overridden as an instance method in child classes, where
318
it should take no parameters and construct whatever repository format
319
that child class desires.
321
bzrdir = BzrDir.create(base)
322
return bzrdir.create_repository(shared)
325
def create_standalone_workingtree(base):
326
"""Create a new BzrDir, WorkingTree, Branch and Repository at 'base'.
328
'base' must be a local path or a file:// url.
330
This will use the current default BzrDirFormat, and use whatever
331
repository format that that uses for bzrdirformat.create_workingtree,
332
create_branch and create_repository.
334
:return: The WorkingTree object.
336
t = get_transport(safe_unicode(base))
337
if not isinstance(t, LocalTransport):
338
raise errors.NotLocalUrl(base)
339
bzrdir = BzrDir.create_branch_and_repo(safe_unicode(base),
340
force_new_repo=True).bzrdir
341
return bzrdir.create_workingtree()
343
def create_workingtree(self, revision_id=None):
344
"""Create a working tree at this BzrDir.
346
revision_id: create it as of this revision id.
348
raise NotImplementedError(self.create_workingtree)
350
def destroy_workingtree(self):
351
"""Destroy the working tree at this BzrDir.
353
Formats that do not support this may raise UnsupportedOperation.
355
raise NotImplementedError(self.destroy_workingtree)
357
def destroy_workingtree_metadata(self):
358
"""Destroy the control files for the working tree at this BzrDir.
360
The contents of working tree files are not affected.
361
Formats that do not support this may raise UnsupportedOperation.
363
raise NotImplementedError(self.destroy_workingtree_metadata)
365
def find_repository(self):
366
"""Find the repository that should be used for a_bzrdir.
368
This does not require a branch as we use it to find the repo for
369
new branches as well as to hook existing branches up to their
373
return self.open_repository()
374
except errors.NoRepositoryPresent:
376
next_transport = self.root_transport.clone('..')
378
# find the next containing bzrdir
380
found_bzrdir = BzrDir.open_containing_from_transport(
382
except errors.NotBranchError:
384
raise errors.NoRepositoryPresent(self)
385
# does it have a repository ?
387
repository = found_bzrdir.open_repository()
388
except errors.NoRepositoryPresent:
389
next_transport = found_bzrdir.root_transport.clone('..')
390
if (found_bzrdir.root_transport.base == next_transport.base):
391
# top of the file system
395
if ((found_bzrdir.root_transport.base ==
396
self.root_transport.base) or repository.is_shared()):
399
raise errors.NoRepositoryPresent(self)
400
raise errors.NoRepositoryPresent(self)
402
def get_branch_transport(self, branch_format):
403
"""Get the transport for use by branch format in this BzrDir.
405
Note that bzr dirs that do not support format strings will raise
406
IncompatibleFormat if the branch format they are given has
407
a format string, and vice versa.
409
If branch_format is None, the transport is returned with no
410
checking. if it is not None, then the returned transport is
411
guaranteed to point to an existing directory ready for use.
413
raise NotImplementedError(self.get_branch_transport)
415
def get_repository_transport(self, repository_format):
416
"""Get the transport for use by repository format in this BzrDir.
418
Note that bzr dirs that do not support format strings will raise
419
IncompatibleFormat if the repository format they are given has
420
a format string, and vice versa.
422
If repository_format is None, the transport is returned with no
423
checking. if it is not None, then the returned transport is
424
guaranteed to point to an existing directory ready for use.
426
raise NotImplementedError(self.get_repository_transport)
428
def get_workingtree_transport(self, tree_format):
429
"""Get the transport for use by workingtree format in this BzrDir.
431
Note that bzr dirs that do not support format strings will raise
432
IncompatibleFormat if the workingtree format they are given has
433
a format string, and vice versa.
435
If workingtree_format is None, the transport is returned with no
436
checking. if it is not None, then the returned transport is
437
guaranteed to point to an existing directory ready for use.
439
raise NotImplementedError(self.get_workingtree_transport)
441
def __init__(self, _transport, _format):
442
"""Initialize a Bzr control dir object.
444
Only really common logic should reside here, concrete classes should be
445
made with varying behaviours.
447
:param _format: the format that is creating this BzrDir instance.
448
:param _transport: the transport this dir is based at.
450
self._format = _format
451
self.transport = _transport.clone('.bzr')
452
self.root_transport = _transport
454
def is_control_filename(self, filename):
455
"""True if filename is the name of a path which is reserved for bzrdir's.
457
:param filename: A filename within the root transport of this bzrdir.
459
This is true IF and ONLY IF the filename is part of the namespace reserved
460
for bzr control dirs. Currently this is the '.bzr' directory in the root
461
of the root_transport. it is expected that plugins will need to extend
462
this in the future - for instance to make bzr talk with svn working
465
# this might be better on the BzrDirFormat class because it refers to
466
# all the possible bzrdir disk formats.
467
# This method is tested via the workingtree is_control_filename tests-
468
# it was extracted from WorkingTree.is_control_filename. If the methods
469
# contract is extended beyond the current trivial implementation please
470
# add new tests for it to the appropriate place.
471
return filename == '.bzr' or filename.startswith('.bzr/')
473
def needs_format_conversion(self, format=None):
474
"""Return true if this bzrdir needs convert_format run on it.
476
For instance, if the repository format is out of date but the
477
branch and working tree are not, this should return True.
479
:param format: Optional parameter indicating a specific desired
480
format we plan to arrive at.
482
raise NotImplementedError(self.needs_format_conversion)
485
def open_unsupported(base):
486
"""Open a branch which is not supported."""
487
return BzrDir.open(base, _unsupported=True)
490
def open(base, _unsupported=False):
491
"""Open an existing bzrdir, rooted at 'base' (url)
493
_unsupported is a private parameter to the BzrDir class.
495
t = get_transport(base)
496
return BzrDir.open_from_transport(t, _unsupported=_unsupported)
499
def open_from_transport(transport, _unsupported=False):
500
"""Open a bzrdir within a particular directory.
502
:param transport: Transport containing the bzrdir.
503
:param _unsupported: private.
505
format = BzrDirFormat.find_format(transport)
506
BzrDir._check_supported(format, _unsupported)
507
return format.open(transport, _found=True)
509
def open_branch(self, unsupported=False):
510
"""Open the branch object at this BzrDir if one is present.
512
If unsupported is True, then no longer supported branch formats can
515
TODO: static convenience version of this?
517
raise NotImplementedError(self.open_branch)
520
def open_containing(url):
521
"""Open an existing branch which contains url.
523
:param url: url to search from.
524
See open_containing_from_transport for more detail.
526
return BzrDir.open_containing_from_transport(get_transport(url))
529
def open_containing_from_transport(a_transport):
530
"""Open an existing branch which contains a_transport.base
532
This probes for a branch at a_transport, and searches upwards from there.
534
Basically we keep looking up until we find the control directory or
535
run into the root. If there isn't one, raises NotBranchError.
536
If there is one and it is either an unrecognised format or an unsupported
537
format, UnknownFormatError or UnsupportedFormatError are raised.
538
If there is one, it is returned, along with the unused portion of url.
540
:return: The BzrDir that contains the path, and a Unicode path
541
for the rest of the URL.
543
# this gets the normalised url back. I.e. '.' -> the full path.
544
url = a_transport.base
547
result = BzrDir.open_from_transport(a_transport)
548
return result, urlutils.unescape(a_transport.relpath(url))
549
except errors.NotBranchError, e:
551
new_t = a_transport.clone('..')
552
if new_t.base == a_transport.base:
553
# reached the root, whatever that may be
554
raise errors.NotBranchError(path=url)
557
def open_repository(self, _unsupported=False):
558
"""Open the repository object at this BzrDir if one is present.
560
This will not follow the Branch object pointer - its strictly a direct
561
open facility. Most client code should use open_branch().repository to
564
_unsupported is a private parameter, not part of the api.
565
TODO: static convenience version of this?
567
raise NotImplementedError(self.open_repository)
569
def open_workingtree(self, _unsupported=False):
570
"""Open the workingtree object at this BzrDir if one is present.
572
TODO: static convenience version of this?
574
raise NotImplementedError(self.open_workingtree)
576
def has_branch(self):
577
"""Tell if this bzrdir contains a branch.
579
Note: if you're going to open the branch, you should just go ahead
580
and try, and not ask permission first. (This method just opens the
581
branch and discards it, and that's somewhat expensive.)
586
except errors.NotBranchError:
589
def has_workingtree(self):
590
"""Tell if this bzrdir contains a working tree.
592
This will still raise an exception if the bzrdir has a workingtree that
593
is remote & inaccessible.
595
Note: if you're going to open the working tree, you should just go ahead
596
and try, and not ask permission first. (This method just opens the
597
workingtree and discards it, and that's somewhat expensive.)
600
self.open_workingtree()
602
except errors.NoWorkingTree:
605
def cloning_metadir(self, basis=None):
606
"""Produce a metadir suitable for cloning with"""
607
def related_repository(bzrdir):
609
branch = bzrdir.open_branch()
610
return branch.repository
611
except errors.NotBranchError:
613
return bzrdir.open_repository()
614
result_format = self._format.__class__()
617
source_repository = related_repository(self)
618
except errors.NoRepositoryPresent:
621
source_repository = related_repository(self)
622
result_format.repository_format = source_repository._format
623
except errors.NoRepositoryPresent:
627
def sprout(self, url, revision_id=None, basis=None, force_new_repo=False):
628
"""Create a copy of this bzrdir prepared for use as a new line of
631
If urls last component does not exist, it will be created.
633
Attributes related to the identity of the source branch like
634
branch nickname will be cleaned, a working tree is created
635
whether one existed before or not; and a local branch is always
638
if revision_id is not None, then the clone operation may tune
639
itself to download less data.
642
cloning_format = self.cloning_metadir(basis)
643
result = cloning_format.initialize(url)
644
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
646
source_branch = self.open_branch()
647
source_repository = source_branch.repository
648
except errors.NotBranchError:
651
source_repository = self.open_repository()
652
except errors.NoRepositoryPresent:
653
# copy the entire basis one if there is one
654
# but there is no repository.
655
source_repository = basis_repo
660
result_repo = result.find_repository()
661
except errors.NoRepositoryPresent:
663
if source_repository is None and result_repo is not None:
665
elif source_repository is None and result_repo is None:
666
# no repo available, make a new one
667
result.create_repository()
668
elif source_repository is not None and result_repo is None:
669
# have source, and want to make a new target repo
670
# we don't clone the repo because that preserves attributes
671
# like is_shared(), and we have not yet implemented a
672
# repository sprout().
673
result_repo = result.create_repository()
674
if result_repo is not None:
675
# fetch needed content into target.
677
# XXX FIXME RBC 20060214 need tests for this when the basis
679
result_repo.fetch(basis_repo, revision_id=revision_id)
680
if source_repository is not None:
681
result_repo.fetch(source_repository, revision_id=revision_id)
682
if source_branch is not None:
683
source_branch.sprout(result, revision_id=revision_id)
685
result.create_branch()
686
# TODO: jam 20060426 we probably need a test in here in the
687
# case that the newly sprouted branch is a remote one
688
if result_repo is None or result_repo.make_working_trees():
689
wt = result.create_workingtree()
690
if wt.inventory.root is None:
692
wt.set_root_id(self.open_workingtree.get_root_id())
693
except errors.NoWorkingTree:
698
class BzrDirPreSplitOut(BzrDir):
699
"""A common class for the all-in-one formats."""
701
def __init__(self, _transport, _format):
702
"""See BzrDir.__init__."""
703
super(BzrDirPreSplitOut, self).__init__(_transport, _format)
704
assert self._format._lock_class == lockable_files.TransportLock
705
assert self._format._lock_file_name == 'branch-lock'
706
self._control_files = lockable_files.LockableFiles(
707
self.get_branch_transport(None),
708
self._format._lock_file_name,
709
self._format._lock_class)
711
def break_lock(self):
712
"""Pre-splitout bzrdirs do not suffer from stale locks."""
713
raise NotImplementedError(self.break_lock)
715
def clone(self, url, revision_id=None, basis=None, force_new_repo=False):
716
"""See BzrDir.clone()."""
717
from bzrlib.workingtree import WorkingTreeFormat2
719
result = self._format._initialize_for_clone(url)
720
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
721
self.open_repository().clone(result, revision_id=revision_id, basis=basis_repo)
722
from_branch = self.open_branch()
723
from_branch.clone(result, revision_id=revision_id)
725
self.open_workingtree().clone(result, basis=basis_tree)
726
except errors.NotLocalUrl:
727
# make a new one, this format always has to have one.
729
WorkingTreeFormat2().initialize(result)
730
except errors.NotLocalUrl:
731
# but we cannot do it for remote trees.
732
to_branch = result.open_branch()
733
WorkingTreeFormat2().stub_initialize_remote(to_branch.control_files)
736
def create_branch(self):
737
"""See BzrDir.create_branch."""
738
return self.open_branch()
740
def create_repository(self, shared=False):
741
"""See BzrDir.create_repository."""
743
raise errors.IncompatibleFormat('shared repository', self._format)
744
return self.open_repository()
746
def create_workingtree(self, revision_id=None):
747
"""See BzrDir.create_workingtree."""
748
# this looks buggy but is not -really-
749
# clone and sprout will have set the revision_id
750
# and that will have set it for us, its only
751
# specific uses of create_workingtree in isolation
752
# that can do wonky stuff here, and that only
753
# happens for creating checkouts, which cannot be
754
# done on this format anyway. So - acceptable wart.
755
result = self.open_workingtree()
756
if revision_id is not None:
757
if revision_id == _mod_revision.NULL_REVISION:
758
result.set_parent_ids([])
760
result.set_parent_ids([revision_id])
763
def destroy_workingtree(self):
764
"""See BzrDir.destroy_workingtree."""
765
raise errors.UnsupportedOperation(self.destroy_workingtree, self)
767
def destroy_workingtree_metadata(self):
768
"""See BzrDir.destroy_workingtree_metadata."""
769
raise errors.UnsupportedOperation(self.destroy_workingtree_metadata,
772
def get_branch_transport(self, branch_format):
773
"""See BzrDir.get_branch_transport()."""
774
if branch_format is None:
775
return self.transport
777
branch_format.get_format_string()
778
except NotImplementedError:
779
return self.transport
780
raise errors.IncompatibleFormat(branch_format, self._format)
782
def get_repository_transport(self, repository_format):
783
"""See BzrDir.get_repository_transport()."""
784
if repository_format is None:
785
return self.transport
787
repository_format.get_format_string()
788
except NotImplementedError:
789
return self.transport
790
raise errors.IncompatibleFormat(repository_format, self._format)
792
def get_workingtree_transport(self, workingtree_format):
793
"""See BzrDir.get_workingtree_transport()."""
794
if workingtree_format is None:
795
return self.transport
797
workingtree_format.get_format_string()
798
except NotImplementedError:
799
return self.transport
800
raise errors.IncompatibleFormat(workingtree_format, self._format)
802
def needs_format_conversion(self, format=None):
803
"""See BzrDir.needs_format_conversion()."""
804
# if the format is not the same as the system default,
805
# an upgrade is needed.
807
format = BzrDirFormat.get_default_format()
808
return not isinstance(self._format, format.__class__)
810
def open_branch(self, unsupported=False):
811
"""See BzrDir.open_branch."""
812
from bzrlib.branch import BzrBranchFormat4
813
format = BzrBranchFormat4()
814
self._check_supported(format, unsupported)
815
return format.open(self, _found=True)
817
def sprout(self, url, revision_id=None, basis=None, force_new_repo=False):
818
"""See BzrDir.sprout()."""
819
from bzrlib.workingtree import WorkingTreeFormat2
821
result = self._format._initialize_for_clone(url)
822
basis_repo, basis_branch, basis_tree = self._get_basis_components(basis)
824
self.open_repository().clone(result, revision_id=revision_id, basis=basis_repo)
825
except errors.NoRepositoryPresent:
828
self.open_branch().sprout(result, revision_id=revision_id)
829
except errors.NotBranchError:
831
# we always want a working tree
832
WorkingTreeFormat2().initialize(result)
836
class BzrDir4(BzrDirPreSplitOut):
837
"""A .bzr version 4 control object.
839
This is a deprecated format and may be removed after sept 2006.
842
def create_repository(self, shared=False):
843
"""See BzrDir.create_repository."""
844
return self._format.repository_format.initialize(self, shared)
846
def needs_format_conversion(self, format=None):
847
"""Format 4 dirs are always in need of conversion."""
850
def open_repository(self):
851
"""See BzrDir.open_repository."""
852
from bzrlib.repository import RepositoryFormat4
853
return RepositoryFormat4().open(self, _found=True)
856
class BzrDir5(BzrDirPreSplitOut):
857
"""A .bzr version 5 control object.
859
This is a deprecated format and may be removed after sept 2006.
862
def open_repository(self):
863
"""See BzrDir.open_repository."""
864
from bzrlib.repository import RepositoryFormat5
865
return RepositoryFormat5().open(self, _found=True)
867
def open_workingtree(self, _unsupported=False):
868
"""See BzrDir.create_workingtree."""
869
from bzrlib.workingtree import WorkingTreeFormat2
870
return WorkingTreeFormat2().open(self, _found=True)
873
class BzrDir6(BzrDirPreSplitOut):
874
"""A .bzr version 6 control object.
876
This is a deprecated format and may be removed after sept 2006.
879
def open_repository(self):
880
"""See BzrDir.open_repository."""
881
from bzrlib.repository import RepositoryFormat6
882
return RepositoryFormat6().open(self, _found=True)
884
def open_workingtree(self, _unsupported=False):
885
"""See BzrDir.create_workingtree."""
886
from bzrlib.workingtree import WorkingTreeFormat2
887
return WorkingTreeFormat2().open(self, _found=True)
890
class BzrDirMeta1(BzrDir):
891
"""A .bzr meta version 1 control object.
893
This is the first control object where the
894
individual aspects are really split out: there are separate repository,
895
workingtree and branch subdirectories and any subset of the three can be
896
present within a BzrDir.
899
def can_convert_format(self):
900
"""See BzrDir.can_convert_format()."""
903
def create_branch(self):
904
"""See BzrDir.create_branch."""
905
from bzrlib.branch import BranchFormat
906
return BranchFormat.get_default_format().initialize(self)
908
def create_repository(self, shared=False):
909
"""See BzrDir.create_repository."""
910
return self._format.repository_format.initialize(self, shared)
912
def create_workingtree(self, revision_id=None):
913
"""See BzrDir.create_workingtree."""
914
from bzrlib.workingtree import WorkingTreeFormat
915
return WorkingTreeFormat.get_default_format().initialize(self, revision_id)
917
def destroy_workingtree(self):
918
"""See BzrDir.destroy_workingtree."""
919
wt = self.open_workingtree()
920
repository = wt.branch.repository
921
empty = repository.revision_tree(_mod_revision.NULL_REVISION)
922
wt.revert([], old_tree=empty)
923
self.destroy_workingtree_metadata()
925
def destroy_workingtree_metadata(self):
926
self.transport.delete_tree('checkout')
928
def _get_mkdir_mode(self):
929
"""Figure out the mode to use when creating a bzrdir subdir."""
930
temp_control = lockable_files.LockableFiles(self.transport, '',
931
lockable_files.TransportLock)
932
return temp_control._dir_mode
934
def get_branch_transport(self, branch_format):
935
"""See BzrDir.get_branch_transport()."""
936
if branch_format is None:
937
return self.transport.clone('branch')
939
branch_format.get_format_string()
940
except NotImplementedError:
941
raise errors.IncompatibleFormat(branch_format, self._format)
943
self.transport.mkdir('branch', mode=self._get_mkdir_mode())
944
except errors.FileExists:
946
return self.transport.clone('branch')
948
def get_repository_transport(self, repository_format):
949
"""See BzrDir.get_repository_transport()."""
950
if repository_format is None:
951
return self.transport.clone('repository')
953
repository_format.get_format_string()
954
except NotImplementedError:
955
raise errors.IncompatibleFormat(repository_format, self._format)
957
self.transport.mkdir('repository', mode=self._get_mkdir_mode())
958
except errors.FileExists:
960
return self.transport.clone('repository')
962
def get_workingtree_transport(self, workingtree_format):
963
"""See BzrDir.get_workingtree_transport()."""
964
if workingtree_format is None:
965
return self.transport.clone('checkout')
967
workingtree_format.get_format_string()
968
except NotImplementedError:
969
raise errors.IncompatibleFormat(workingtree_format, self._format)
971
self.transport.mkdir('checkout', mode=self._get_mkdir_mode())
972
except errors.FileExists:
974
return self.transport.clone('checkout')
976
def needs_format_conversion(self, format=None):
977
"""See BzrDir.needs_format_conversion()."""
979
format = BzrDirFormat.get_default_format()
980
if not isinstance(self._format, format.__class__):
981
# it is not a meta dir format, conversion is needed.
983
# we might want to push this down to the repository?
985
if not isinstance(self.open_repository()._format,
986
format.repository_format.__class__):
987
# the repository needs an upgrade.
989
except errors.NoRepositoryPresent:
991
# currently there are no other possible conversions for meta1 formats.
994
def open_branch(self, unsupported=False):
995
"""See BzrDir.open_branch."""
996
from bzrlib.branch import BranchFormat
997
format = BranchFormat.find_format(self)
998
self._check_supported(format, unsupported)
999
return format.open(self, _found=True)
1001
def open_repository(self, unsupported=False):
1002
"""See BzrDir.open_repository."""
1003
from bzrlib.repository import RepositoryFormat
1004
format = RepositoryFormat.find_format(self)
1005
self._check_supported(format, unsupported)
1006
return format.open(self, _found=True)
1008
def open_workingtree(self, unsupported=False):
1009
"""See BzrDir.open_workingtree."""
1010
from bzrlib.workingtree import WorkingTreeFormat
1011
format = WorkingTreeFormat.find_format(self)
1012
self._check_supported(format, unsupported)
1013
return format.open(self, _found=True)
1016
class BzrDirFormat(object):
1017
"""An encapsulation of the initialization and open routines for a format.
1019
Formats provide three things:
1020
* An initialization routine,
1024
Formats are placed in an dict by their format string for reference
1025
during bzrdir opening. These should be subclasses of BzrDirFormat
1028
Once a format is deprecated, just deprecate the initialize and open
1029
methods on the format class. Do not deprecate the object, as the
1030
object will be created every system load.
1033
_default_format = None
1034
"""The default format used for new .bzr dirs."""
1037
"""The known formats."""
1039
_control_formats = []
1040
"""The registered control formats - .bzr, ....
1042
This is a list of BzrDirFormat objects.
1045
_lock_file_name = 'branch-lock'
1047
# _lock_class must be set in subclasses to the lock type, typ.
1048
# TransportLock or LockDir
1051
def find_format(klass, transport):
1052
"""Return the format present at transport."""
1053
for format in klass._control_formats:
1055
return format.probe_transport(transport)
1056
except errors.NotBranchError:
1057
# this format does not find a control dir here.
1059
raise errors.NotBranchError(path=transport.base)
1062
def probe_transport(klass, transport):
1063
"""Return the .bzrdir style transport present at URL."""
1065
format_string = transport.get(".bzr/branch-format").read()
1066
except errors.NoSuchFile:
1067
raise errors.NotBranchError(path=transport.base)
1070
return klass._formats[format_string]
1072
raise errors.UnknownFormatError(format=format_string)
1075
def get_default_format(klass):
1076
"""Return the current default format."""
1077
return klass._default_format
1079
def get_format_string(self):
1080
"""Return the ASCII format string that identifies this format."""
1081
raise NotImplementedError(self.get_format_string)
1083
def get_format_description(self):
1084
"""Return the short description for this format."""
1085
raise NotImplementedError(self.get_format_description)
1087
def get_converter(self, format=None):
1088
"""Return the converter to use to convert bzrdirs needing converts.
1090
This returns a bzrlib.bzrdir.Converter object.
1092
This should return the best upgrader to step this format towards the
1093
current default format. In the case of plugins we can/should provide
1094
some means for them to extend the range of returnable converters.
1096
:param format: Optional format to override the default format of the
1099
raise NotImplementedError(self.get_converter)
1101
def initialize(self, url):
1102
"""Create a bzr control dir at this url and return an opened copy.
1104
Subclasses should typically override initialize_on_transport
1105
instead of this method.
1107
return self.initialize_on_transport(get_transport(url))
1109
def initialize_on_transport(self, transport):
1110
"""Initialize a new bzrdir in the base directory of a Transport."""
1111
# Since we don't have a .bzr directory, inherit the
1112
# mode from the root directory
1113
temp_control = lockable_files.LockableFiles(transport,
1114
'', lockable_files.TransportLock)
1115
temp_control._transport.mkdir('.bzr',
1116
# FIXME: RBC 20060121 don't peek under
1118
mode=temp_control._dir_mode)
1119
file_mode = temp_control._file_mode
1121
mutter('created control directory in ' + transport.base)
1122
control = transport.clone('.bzr')
1123
utf8_files = [('README',
1124
"This is a Bazaar-NG control directory.\n"
1125
"Do not change any files in this directory.\n"),
1126
('branch-format', self.get_format_string()),
1128
# NB: no need to escape relative paths that are url safe.
1129
control_files = lockable_files.LockableFiles(control,
1130
self._lock_file_name, self._lock_class)
1131
control_files.create_lock()
1132
control_files.lock_write()
1134
for file, content in utf8_files:
1135
control_files.put_utf8(file, content)
1137
control_files.unlock()
1138
return self.open(transport, _found=True)
1140
def is_supported(self):
1141
"""Is this format supported?
1143
Supported formats must be initializable and openable.
1144
Unsupported formats may not support initialization or committing or
1145
some other features depending on the reason for not being supported.
1149
def same_model(self, target_format):
1150
return (self.repository_format.rich_root_data ==
1151
target_format.rich_root_data)
1154
def known_formats(klass):
1155
"""Return all the known formats.
1157
Concrete formats should override _known_formats.
1159
# There is double indirection here to make sure that control
1160
# formats used by more than one dir format will only be probed
1161
# once. This can otherwise be quite expensive for remote connections.
1163
for format in klass._control_formats:
1164
result.update(format._known_formats())
1168
def _known_formats(klass):
1169
"""Return the known format instances for this control format."""
1170
return set(klass._formats.values())
1172
def open(self, transport, _found=False):
1173
"""Return an instance of this format for the dir transport points at.
1175
_found is a private parameter, do not use it.
1178
found_format = BzrDirFormat.find_format(transport)
1179
if not isinstance(found_format, self.__class__):
1180
raise AssertionError("%s was asked to open %s, but it seems to need "
1182
% (self, transport, found_format))
1183
return self._open(transport)
1185
def _open(self, transport):
1186
"""Template method helper for opening BzrDirectories.
1188
This performs the actual open and any additional logic or parameter
1191
raise NotImplementedError(self._open)
1194
def register_format(klass, format):
1195
klass._formats[format.get_format_string()] = format
1198
def register_control_format(klass, format):
1199
"""Register a format that does not use '.bzrdir' for its control dir.
1201
TODO: This should be pulled up into a 'ControlDirFormat' base class
1202
which BzrDirFormat can inherit from, and renamed to register_format
1203
there. It has been done without that for now for simplicity of
1206
klass._control_formats.append(format)
1209
def set_default_format(klass, format):
1210
klass._default_format = format
1213
return self.get_format_string()[:-1]
1216
def unregister_format(klass, format):
1217
assert klass._formats[format.get_format_string()] is format
1218
del klass._formats[format.get_format_string()]
1221
def unregister_control_format(klass, format):
1222
klass._control_formats.remove(format)
1225
# register BzrDirFormat as a control format
1226
BzrDirFormat.register_control_format(BzrDirFormat)
1229
class BzrDirFormat4(BzrDirFormat):
1230
"""Bzr dir format 4.
1232
This format is a combined format for working tree, branch and repository.
1234
- Format 1 working trees [always]
1235
- Format 4 branches [always]
1236
- Format 4 repositories [always]
1238
This format is deprecated: it indexes texts using a text it which is
1239
removed in format 5; write support for this format has been removed.
1242
_lock_class = lockable_files.TransportLock
1244
def get_format_string(self):
1245
"""See BzrDirFormat.get_format_string()."""
1246
return "Bazaar-NG branch, format 0.0.4\n"
1248
def get_format_description(self):
1249
"""See BzrDirFormat.get_format_description()."""
1250
return "All-in-one format 4"
1252
def get_converter(self, format=None):
1253
"""See BzrDirFormat.get_converter()."""
1254
# there is one and only one upgrade path here.
1255
return ConvertBzrDir4To5()
1257
def initialize_on_transport(self, transport):
1258
"""Format 4 branches cannot be created."""
1259
raise errors.UninitializableFormat(self)
1261
def is_supported(self):
1262
"""Format 4 is not supported.
1264
It is not supported because the model changed from 4 to 5 and the
1265
conversion logic is expensive - so doing it on the fly was not
1270
def _open(self, transport):
1271
"""See BzrDirFormat._open."""
1272
return BzrDir4(transport, self)
1274
def __return_repository_format(self):
1275
"""Circular import protection."""
1276
from bzrlib.repository import RepositoryFormat4
1277
return RepositoryFormat4()
1278
repository_format = property(__return_repository_format)
1281
class BzrDirFormat5(BzrDirFormat):
1282
"""Bzr control format 5.
1284
This format is a combined format for working tree, branch and repository.
1286
- Format 2 working trees [always]
1287
- Format 4 branches [always]
1288
- Format 5 repositories [always]
1289
Unhashed stores in the repository.
1292
_lock_class = lockable_files.TransportLock
1294
def get_format_string(self):
1295
"""See BzrDirFormat.get_format_string()."""
1296
return "Bazaar-NG branch, format 5\n"
1298
def get_format_description(self):
1299
"""See BzrDirFormat.get_format_description()."""
1300
return "All-in-one format 5"
1302
def get_converter(self, format=None):
1303
"""See BzrDirFormat.get_converter()."""
1304
# there is one and only one upgrade path here.
1305
return ConvertBzrDir5To6()
1307
def _initialize_for_clone(self, url):
1308
return self.initialize_on_transport(get_transport(url), _cloning=True)
1310
def initialize_on_transport(self, transport, _cloning=False):
1311
"""Format 5 dirs always have working tree, branch and repository.
1313
Except when they are being cloned.
1315
from bzrlib.branch import BzrBranchFormat4
1316
from bzrlib.repository import RepositoryFormat5
1317
from bzrlib.workingtree import WorkingTreeFormat2
1318
result = (super(BzrDirFormat5, self).initialize_on_transport(transport))
1319
RepositoryFormat5().initialize(result, _internal=True)
1321
branch = BzrBranchFormat4().initialize(result)
1323
WorkingTreeFormat2().initialize(result)
1324
except errors.NotLocalUrl:
1325
# Even though we can't access the working tree, we need to
1326
# create its control files.
1327
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1330
def _open(self, transport):
1331
"""See BzrDirFormat._open."""
1332
return BzrDir5(transport, self)
1334
def __return_repository_format(self):
1335
"""Circular import protection."""
1336
from bzrlib.repository import RepositoryFormat5
1337
return RepositoryFormat5()
1338
repository_format = property(__return_repository_format)
1341
class BzrDirFormat6(BzrDirFormat):
1342
"""Bzr control format 6.
1344
This format is a combined format for working tree, branch and repository.
1346
- Format 2 working trees [always]
1347
- Format 4 branches [always]
1348
- Format 6 repositories [always]
1351
_lock_class = lockable_files.TransportLock
1353
def get_format_string(self):
1354
"""See BzrDirFormat.get_format_string()."""
1355
return "Bazaar-NG branch, format 6\n"
1357
def get_format_description(self):
1358
"""See BzrDirFormat.get_format_description()."""
1359
return "All-in-one format 6"
1361
def get_converter(self, format=None):
1362
"""See BzrDirFormat.get_converter()."""
1363
# there is one and only one upgrade path here.
1364
return ConvertBzrDir6ToMeta()
1366
def _initialize_for_clone(self, url):
1367
return self.initialize_on_transport(get_transport(url), _cloning=True)
1369
def initialize_on_transport(self, transport, _cloning=False):
1370
"""Format 6 dirs always have working tree, branch and repository.
1372
Except when they are being cloned.
1374
from bzrlib.branch import BzrBranchFormat4
1375
from bzrlib.repository import RepositoryFormat6
1376
from bzrlib.workingtree import WorkingTreeFormat2
1377
result = super(BzrDirFormat6, self).initialize_on_transport(transport)
1378
RepositoryFormat6().initialize(result, _internal=True)
1380
branch = BzrBranchFormat4().initialize(result)
1382
WorkingTreeFormat2().initialize(result)
1383
except errors.NotLocalUrl:
1384
# Even though we can't access the working tree, we need to
1385
# create its control files.
1386
WorkingTreeFormat2().stub_initialize_remote(branch.control_files)
1389
def _open(self, transport):
1390
"""See BzrDirFormat._open."""
1391
return BzrDir6(transport, self)
1393
def __return_repository_format(self):
1394
"""Circular import protection."""
1395
from bzrlib.repository import RepositoryFormat6
1396
return RepositoryFormat6()
1397
repository_format = property(__return_repository_format)
1400
class BzrDirMetaFormat1(BzrDirFormat):
1401
"""Bzr meta control format 1
1403
This is the first format with split out working tree, branch and repository
1406
- Format 3 working trees [optional]
1407
- Format 5 branches [optional]
1408
- Format 7 repositories [optional]
1411
_lock_class = lockdir.LockDir
1413
def get_converter(self, format=None):
1414
"""See BzrDirFormat.get_converter()."""
1416
format = BzrDirFormat.get_default_format()
1417
if not isinstance(self, format.__class__):
1418
# converting away from metadir is not implemented
1419
raise NotImplementedError(self.get_converter)
1420
return ConvertMetaToMeta(format)
1422
def get_format_string(self):
1423
"""See BzrDirFormat.get_format_string()."""
1424
return "Bazaar-NG meta directory, format 1\n"
1426
def get_format_description(self):
1427
"""See BzrDirFormat.get_format_description()."""
1428
return "Meta directory format 1"
1430
def _open(self, transport):
1431
"""See BzrDirFormat._open."""
1432
return BzrDirMeta1(transport, self)
1434
def __return_repository_format(self):
1435
"""Circular import protection."""
1436
if getattr(self, '_repository_format', None):
1437
return self._repository_format
1438
from bzrlib.repository import RepositoryFormat
1439
return RepositoryFormat.get_default_format()
1441
def __set_repository_format(self, value):
1442
"""Allow changint the repository format for metadir formats."""
1443
self._repository_format = value
1445
repository_format = property(__return_repository_format, __set_repository_format)
1448
BzrDirFormat.register_format(BzrDirFormat4())
1449
BzrDirFormat.register_format(BzrDirFormat5())
1450
BzrDirFormat.register_format(BzrDirFormat6())
1451
__default_format = BzrDirMetaFormat1()
1452
BzrDirFormat.register_format(__default_format)
1453
BzrDirFormat.set_default_format(__default_format)
1456
class BzrDirTestProviderAdapter(object):
1457
"""A tool to generate a suite testing multiple bzrdir formats at once.
1459
This is done by copying the test once for each transport and injecting
1460
the transport_server, transport_readonly_server, and bzrdir_format
1461
classes into each copy. Each copy is also given a new id() to make it
1465
def __init__(self, transport_server, transport_readonly_server, formats):
1466
self._transport_server = transport_server
1467
self._transport_readonly_server = transport_readonly_server
1468
self._formats = formats
1470
def adapt(self, test):
1471
result = unittest.TestSuite()
1472
for format in self._formats:
1473
new_test = deepcopy(test)
1474
new_test.transport_server = self._transport_server
1475
new_test.transport_readonly_server = self._transport_readonly_server
1476
new_test.bzrdir_format = format
1477
def make_new_test_id():
1478
new_id = "%s(%s)" % (new_test.id(), format.__class__.__name__)
1479
return lambda: new_id
1480
new_test.id = make_new_test_id()
1481
result.addTest(new_test)
1485
class Converter(object):
1486
"""Converts a disk format object from one format to another."""
1488
def convert(self, to_convert, pb):
1489
"""Perform the conversion of to_convert, giving feedback via pb.
1491
:param to_convert: The disk object to convert.
1492
:param pb: a progress bar to use for progress information.
1495
def step(self, message):
1496
"""Update the pb by a step."""
1498
self.pb.update(message, self.count, self.total)
1501
class ConvertBzrDir4To5(Converter):
1502
"""Converts format 4 bzr dirs to format 5."""
1505
super(ConvertBzrDir4To5, self).__init__()
1506
self.converted_revs = set()
1507
self.absent_revisions = set()
1511
def convert(self, to_convert, pb):
1512
"""See Converter.convert()."""
1513
self.bzrdir = to_convert
1515
self.pb.note('starting upgrade from format 4 to 5')
1516
if isinstance(self.bzrdir.transport, LocalTransport):
1517
self.bzrdir.get_workingtree_transport(None).delete('stat-cache')
1518
self._convert_to_weaves()
1519
return BzrDir.open(self.bzrdir.root_transport.base)
1521
def _convert_to_weaves(self):
1522
self.pb.note('note: upgrade may be faster if all store files are ungzipped first')
1525
stat = self.bzrdir.transport.stat('weaves')
1526
if not S_ISDIR(stat.st_mode):
1527
self.bzrdir.transport.delete('weaves')
1528
self.bzrdir.transport.mkdir('weaves')
1529
except errors.NoSuchFile:
1530
self.bzrdir.transport.mkdir('weaves')
1531
# deliberately not a WeaveFile as we want to build it up slowly.
1532
self.inv_weave = Weave('inventory')
1533
# holds in-memory weaves for all files
1534
self.text_weaves = {}
1535
self.bzrdir.transport.delete('branch-format')
1536
self.branch = self.bzrdir.open_branch()
1537
self._convert_working_inv()
1538
rev_history = self.branch.revision_history()
1539
# to_read is a stack holding the revisions we still need to process;
1540
# appending to it adds new highest-priority revisions
1541
self.known_revisions = set(rev_history)
1542
self.to_read = rev_history[-1:]
1544
rev_id = self.to_read.pop()
1545
if (rev_id not in self.revisions
1546
and rev_id not in self.absent_revisions):
1547
self._load_one_rev(rev_id)
1549
to_import = self._make_order()
1550
for i, rev_id in enumerate(to_import):
1551
self.pb.update('converting revision', i, len(to_import))
1552
self._convert_one_rev(rev_id)
1554
self._write_all_weaves()
1555
self._write_all_revs()
1556
self.pb.note('upgraded to weaves:')
1557
self.pb.note(' %6d revisions and inventories', len(self.revisions))
1558
self.pb.note(' %6d revisions not present', len(self.absent_revisions))
1559
self.pb.note(' %6d texts', self.text_count)
1560
self._cleanup_spare_files_after_format4()
1561
self.branch.control_files.put_utf8('branch-format', BzrDirFormat5().get_format_string())
1563
def _cleanup_spare_files_after_format4(self):
1564
# FIXME working tree upgrade foo.
1565
for n in 'merged-patches', 'pending-merged-patches':
1567
## assert os.path.getsize(p) == 0
1568
self.bzrdir.transport.delete(n)
1569
except errors.NoSuchFile:
1571
self.bzrdir.transport.delete_tree('inventory-store')
1572
self.bzrdir.transport.delete_tree('text-store')
1574
def _convert_working_inv(self):
1575
inv = xml4.serializer_v4.read_inventory(
1576
self.branch.control_files.get('inventory'))
1577
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
1578
# FIXME inventory is a working tree change.
1579
self.branch.control_files.put('inventory', StringIO(new_inv_xml))
1581
def _write_all_weaves(self):
1582
controlweaves = WeaveStore(self.bzrdir.transport, prefixed=False)
1583
weave_transport = self.bzrdir.transport.clone('weaves')
1584
weaves = WeaveStore(weave_transport, prefixed=False)
1585
transaction = WriteTransaction()
1589
for file_id, file_weave in self.text_weaves.items():
1590
self.pb.update('writing weave', i, len(self.text_weaves))
1591
weaves._put_weave(file_id, file_weave, transaction)
1593
self.pb.update('inventory', 0, 1)
1594
controlweaves._put_weave('inventory', self.inv_weave, transaction)
1595
self.pb.update('inventory', 1, 1)
1599
def _write_all_revs(self):
1600
"""Write all revisions out in new form."""
1601
self.bzrdir.transport.delete_tree('revision-store')
1602
self.bzrdir.transport.mkdir('revision-store')
1603
revision_transport = self.bzrdir.transport.clone('revision-store')
1605
_revision_store = TextRevisionStore(TextStore(revision_transport,
1609
transaction = WriteTransaction()
1610
for i, rev_id in enumerate(self.converted_revs):
1611
self.pb.update('write revision', i, len(self.converted_revs))
1612
_revision_store.add_revision(self.revisions[rev_id], transaction)
1616
def _load_one_rev(self, rev_id):
1617
"""Load a revision object into memory.
1619
Any parents not either loaded or abandoned get queued to be
1621
self.pb.update('loading revision',
1622
len(self.revisions),
1623
len(self.known_revisions))
1624
if not self.branch.repository.has_revision(rev_id):
1626
self.pb.note('revision {%s} not present in branch; '
1627
'will be converted as a ghost',
1629
self.absent_revisions.add(rev_id)
1631
rev = self.branch.repository._revision_store.get_revision(rev_id,
1632
self.branch.repository.get_transaction())
1633
for parent_id in rev.parent_ids:
1634
self.known_revisions.add(parent_id)
1635
self.to_read.append(parent_id)
1636
self.revisions[rev_id] = rev
1638
def _load_old_inventory(self, rev_id):
1639
assert rev_id not in self.converted_revs
1640
old_inv_xml = self.branch.repository.inventory_store.get(rev_id).read()
1641
inv = xml4.serializer_v4.read_inventory_from_string(old_inv_xml)
1642
inv.revision_id = rev_id
1643
rev = self.revisions[rev_id]
1644
if rev.inventory_sha1:
1645
assert rev.inventory_sha1 == sha_string(old_inv_xml), \
1646
'inventory sha mismatch for {%s}' % rev_id
1649
def _load_updated_inventory(self, rev_id):
1650
assert rev_id in self.converted_revs
1651
inv_xml = self.inv_weave.get_text(rev_id)
1652
inv = xml5.serializer_v5.read_inventory_from_string(inv_xml)
1655
def _convert_one_rev(self, rev_id):
1656
"""Convert revision and all referenced objects to new format."""
1657
rev = self.revisions[rev_id]
1658
inv = self._load_old_inventory(rev_id)
1659
present_parents = [p for p in rev.parent_ids
1660
if p not in self.absent_revisions]
1661
self._convert_revision_contents(rev, inv, present_parents)
1662
self._store_new_weave(rev, inv, present_parents)
1663
self.converted_revs.add(rev_id)
1665
def _store_new_weave(self, rev, inv, present_parents):
1666
# the XML is now updated with text versions
1668
entries = inv.iter_entries()
1670
for path, ie in entries:
1671
assert getattr(ie, 'revision', None) is not None, \
1672
'no revision on {%s} in {%s}' % \
1673
(file_id, rev.revision_id)
1674
new_inv_xml = xml5.serializer_v5.write_inventory_to_string(inv)
1675
new_inv_sha1 = sha_string(new_inv_xml)
1676
self.inv_weave.add_lines(rev.revision_id,
1678
new_inv_xml.splitlines(True))
1679
rev.inventory_sha1 = new_inv_sha1
1681
def _convert_revision_contents(self, rev, inv, present_parents):
1682
"""Convert all the files within a revision.
1684
Also upgrade the inventory to refer to the text revision ids."""
1685
rev_id = rev.revision_id
1686
mutter('converting texts of revision {%s}',
1688
parent_invs = map(self._load_updated_inventory, present_parents)
1689
entries = inv.iter_entries()
1691
for path, ie in entries:
1692
self._convert_file_version(rev, ie, parent_invs)
1694
def _convert_file_version(self, rev, ie, parent_invs):
1695
"""Convert one version of one file.
1697
The file needs to be added into the weave if it is a merge
1698
of >=2 parents or if it's changed from its parent.
1700
file_id = ie.file_id
1701
rev_id = rev.revision_id
1702
w = self.text_weaves.get(file_id)
1705
self.text_weaves[file_id] = w
1706
text_changed = False
1707
previous_entries = ie.find_previous_heads(parent_invs,
1711
for old_revision in previous_entries:
1712
# if this fails, its a ghost ?
1713
assert old_revision in self.converted_revs, \
1714
"Revision {%s} not in converted_revs" % old_revision
1715
self.snapshot_ie(previous_entries, ie, w, rev_id)
1717
assert getattr(ie, 'revision', None) is not None
1719
def snapshot_ie(self, previous_revisions, ie, w, rev_id):
1720
# TODO: convert this logic, which is ~= snapshot to
1721
# a call to:. This needs the path figured out. rather than a work_tree
1722
# a v4 revision_tree can be given, or something that looks enough like
1723
# one to give the file content to the entry if it needs it.
1724
# and we need something that looks like a weave store for snapshot to
1726
#ie.snapshot(rev, PATH, previous_revisions, REVISION_TREE, InMemoryWeaveStore(self.text_weaves))
1727
if len(previous_revisions) == 1:
1728
previous_ie = previous_revisions.values()[0]
1729
if ie._unchanged(previous_ie):
1730
ie.revision = previous_ie.revision
1733
text = self.branch.repository.text_store.get(ie.text_id)
1734
file_lines = text.readlines()
1735
assert sha_strings(file_lines) == ie.text_sha1
1736
assert sum(map(len, file_lines)) == ie.text_size
1737
w.add_lines(rev_id, previous_revisions, file_lines)
1738
self.text_count += 1
1740
w.add_lines(rev_id, previous_revisions, [])
1741
ie.revision = rev_id
1743
def _make_order(self):
1744
"""Return a suitable order for importing revisions.
1746
The order must be such that an revision is imported after all
1747
its (present) parents.
1749
todo = set(self.revisions.keys())
1750
done = self.absent_revisions.copy()
1753
# scan through looking for a revision whose parents
1755
for rev_id in sorted(list(todo)):
1756
rev = self.revisions[rev_id]
1757
parent_ids = set(rev.parent_ids)
1758
if parent_ids.issubset(done):
1759
# can take this one now
1760
order.append(rev_id)
1766
class ConvertBzrDir5To6(Converter):
1767
"""Converts format 5 bzr dirs to format 6."""
1769
def convert(self, to_convert, pb):
1770
"""See Converter.convert()."""
1771
self.bzrdir = to_convert
1773
self.pb.note('starting upgrade from format 5 to 6')
1774
self._convert_to_prefixed()
1775
return BzrDir.open(self.bzrdir.root_transport.base)
1777
def _convert_to_prefixed(self):
1778
from bzrlib.store import TransportStore
1779
self.bzrdir.transport.delete('branch-format')
1780
for store_name in ["weaves", "revision-store"]:
1781
self.pb.note("adding prefixes to %s" % store_name)
1782
store_transport = self.bzrdir.transport.clone(store_name)
1783
store = TransportStore(store_transport, prefixed=True)
1784
for urlfilename in store_transport.list_dir('.'):
1785
filename = urlutils.unescape(urlfilename)
1786
if (filename.endswith(".weave") or
1787
filename.endswith(".gz") or
1788
filename.endswith(".sig")):
1789
file_id = os.path.splitext(filename)[0]
1792
prefix_dir = store.hash_prefix(file_id)
1793
# FIXME keep track of the dirs made RBC 20060121
1795
store_transport.move(filename, prefix_dir + '/' + filename)
1796
except errors.NoSuchFile: # catches missing dirs strangely enough
1797
store_transport.mkdir(prefix_dir)
1798
store_transport.move(filename, prefix_dir + '/' + filename)
1799
self.bzrdir._control_files.put_utf8('branch-format', BzrDirFormat6().get_format_string())
1802
class ConvertBzrDir6ToMeta(Converter):
1803
"""Converts format 6 bzr dirs to metadirs."""
1805
def convert(self, to_convert, pb):
1806
"""See Converter.convert()."""
1807
from bzrlib.branch import BzrBranchFormat5
1808
self.bzrdir = to_convert
1811
self.total = 20 # the steps we know about
1812
self.garbage_inventories = []
1814
self.pb.note('starting upgrade from format 6 to metadir')
1815
self.bzrdir._control_files.put_utf8('branch-format', "Converting to format 6")
1816
# its faster to move specific files around than to open and use the apis...
1817
# first off, nuke ancestry.weave, it was never used.
1819
self.step('Removing ancestry.weave')
1820
self.bzrdir.transport.delete('ancestry.weave')
1821
except errors.NoSuchFile:
1823
# find out whats there
1824
self.step('Finding branch files')
1825
last_revision = self.bzrdir.open_branch().last_revision()
1826
bzrcontents = self.bzrdir.transport.list_dir('.')
1827
for name in bzrcontents:
1828
if name.startswith('basis-inventory.'):
1829
self.garbage_inventories.append(name)
1830
# create new directories for repository, working tree and branch
1831
self.dir_mode = self.bzrdir._control_files._dir_mode
1832
self.file_mode = self.bzrdir._control_files._file_mode
1833
repository_names = [('inventory.weave', True),
1834
('revision-store', True),
1836
self.step('Upgrading repository ')
1837
self.bzrdir.transport.mkdir('repository', mode=self.dir_mode)
1838
self.make_lock('repository')
1839
# we hard code the formats here because we are converting into
1840
# the meta format. The meta format upgrader can take this to a
1841
# future format within each component.
1842
self.put_format('repository', _mod_repository.RepositoryFormat7())
1843
for entry in repository_names:
1844
self.move_entry('repository', entry)
1846
self.step('Upgrading branch ')
1847
self.bzrdir.transport.mkdir('branch', mode=self.dir_mode)
1848
self.make_lock('branch')
1849
self.put_format('branch', BzrBranchFormat5())
1850
branch_files = [('revision-history', True),
1851
('branch-name', True),
1853
for entry in branch_files:
1854
self.move_entry('branch', entry)
1856
checkout_files = [('pending-merges', True),
1857
('inventory', True),
1858
('stat-cache', False)]
1859
# If a mandatory checkout file is not present, the branch does not have
1860
# a functional checkout. Do not create a checkout in the converted
1862
for name, mandatory in checkout_files:
1863
if mandatory and name not in bzrcontents:
1864
has_checkout = False
1868
if not has_checkout:
1869
self.pb.note('No working tree.')
1870
# If some checkout files are there, we may as well get rid of them.
1871
for name, mandatory in checkout_files:
1872
if name in bzrcontents:
1873
self.bzrdir.transport.delete(name)
1875
from bzrlib.workingtree import WorkingTreeFormat3
1876
self.step('Upgrading working tree')
1877
self.bzrdir.transport.mkdir('checkout', mode=self.dir_mode)
1878
self.make_lock('checkout')
1880
'checkout', WorkingTreeFormat3())
1881
self.bzrdir.transport.delete_multi(
1882
self.garbage_inventories, self.pb)
1883
for entry in checkout_files:
1884
self.move_entry('checkout', entry)
1885
if last_revision is not None:
1886
self.bzrdir._control_files.put_utf8(
1887
'checkout/last-revision', last_revision)
1888
self.bzrdir._control_files.put_utf8(
1889
'branch-format', BzrDirMetaFormat1().get_format_string())
1890
return BzrDir.open(self.bzrdir.root_transport.base)
1892
def make_lock(self, name):
1893
"""Make a lock for the new control dir name."""
1894
self.step('Make %s lock' % name)
1895
ld = lockdir.LockDir(self.bzrdir.transport,
1897
file_modebits=self.file_mode,
1898
dir_modebits=self.dir_mode)
1901
def move_entry(self, new_dir, entry):
1902
"""Move then entry name into new_dir."""
1904
mandatory = entry[1]
1905
self.step('Moving %s' % name)
1907
self.bzrdir.transport.move(name, '%s/%s' % (new_dir, name))
1908
except errors.NoSuchFile:
1912
def put_format(self, dirname, format):
1913
self.bzrdir._control_files.put_utf8('%s/format' % dirname, format.get_format_string())
1916
class ConvertMetaToMeta(Converter):
1917
"""Converts the components of metadirs."""
1919
def __init__(self, target_format):
1920
"""Create a metadir to metadir converter.
1922
:param target_format: The final metadir format that is desired.
1924
self.target_format = target_format
1926
def convert(self, to_convert, pb):
1927
"""See Converter.convert()."""
1928
self.bzrdir = to_convert
1932
self.step('checking repository format')
1934
repo = self.bzrdir.open_repository()
1935
except errors.NoRepositoryPresent:
1938
if not isinstance(repo._format, self.target_format.repository_format.__class__):
1939
from bzrlib.repository import CopyConverter
1940
self.pb.note('starting repository conversion')
1941
converter = CopyConverter(self.target_format.repository_format)
1942
converter.convert(repo, pb)
added
removed
bzrlib/bzrdir.py
