1
# Copyright (C) 2005, 2006 Canonical Ltd
1
# Copyright (C) 2005 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22
from warnings import warn
18
23
from cStringIO import StringIO
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
22
from copy import deepcopy
23
from unittest import TestSuite
24
from warnings import warn
30
config as _mod_config,
35
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TreeConfig
42
from bzrlib.lockable_files import LockableFiles, TransportLock
45
from bzrlib.decorators import needs_read_lock, needs_write_lock
46
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
47
HistoryMissing, InvalidRevisionId,
48
InvalidRevisionNumber, LockError, NoSuchFile,
49
NoSuchRevision, NoWorkingTree, NotVersionedError,
50
NotBranchError, UninitializableFormat,
51
UnlistableStore, UnlistableBranch,
53
from bzrlib.symbol_versioning import (deprecated_function,
57
zero_eight, zero_nine,
27
import bzrlib.inventory as inventory
59
28
from bzrlib.trace import mutter, note
29
from bzrlib.osutils import (isdir, quotefn,
30
rename, splitpath, sha_file, appendpath,
32
import bzrlib.errors as errors
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
34
NoSuchRevision, HistoryMissing, NotBranchError,
35
DivergedBranches, LockError, UnlistableStore,
36
UnlistableBranch, NoSuchFile, NotVersionedError,
38
from bzrlib.textui import show_status
39
from bzrlib.revision import (Revision, is_ancestor, get_intervening_revisions,
42
from bzrlib.delta import compare_trees
43
from bzrlib.tree import EmptyTree, RevisionTree
44
from bzrlib.inventory import Inventory
45
from bzrlib.store import copy_all
46
from bzrlib.store.text import TextStore
47
from bzrlib.store.weave import WeaveStore
48
from bzrlib.testament import Testament
49
import bzrlib.transactions as transactions
50
from bzrlib.transport import Transport, get_transport
53
from config import TreeConfig
62
56
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
63
57
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
64
58
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
67
# TODO: Maybe include checks for common corruption of newlines, etc?
59
## TODO: Maybe include checks for common corruption of newlines, etc?
69
62
# TODO: Some operations like log might retrieve the same revisions
70
63
# repeatedly to calculate deltas. We could perhaps have a weakref
71
64
# cache in memory to make this faster. In general anything can be
72
# cached in memory between lock and unlock operations. .. nb thats
73
# what the transaction identity map provides
65
# cached in memory between lock and unlock operations.
67
def find_branch(*ignored, **ignored_too):
68
# XXX: leave this here for about one release, then remove it
69
raise NotImplementedError('find_branch() is not supported anymore, '
70
'please use one of the new branch constructors')
73
def needs_read_lock(unbound):
74
"""Decorate unbound to take out and release a read lock."""
75
def decorated(self, *args, **kwargs):
78
return unbound(self, *args, **kwargs)
84
def needs_write_lock(unbound):
85
"""Decorate unbound to take out and release a write lock."""
86
def decorated(self, *args, **kwargs):
89
return unbound(self, *args, **kwargs)
76
94
######################################################################
189
191
XXX: Robert Collins 20051017 what is this used for? why is it a branch
190
192
method and not a tree method.
192
raise NotImplementedError(self.abspath)
194
def bind(self, other):
195
"""Bind the local branch the other branch.
197
:param other: The branch to bind to
200
raise errors.UpgradeRequired(self.base)
203
def fetch(self, from_branch, last_revision=None, pb=None):
204
"""Copy revisions from from_branch into this branch.
206
:param from_branch: Where to copy from.
207
:param last_revision: What revision to stop at (None for at the end
209
:param pb: An optional progress bar to use.
211
Returns the copied revision count and the failed revisions in a tuple:
214
if self.base == from_branch.base:
217
nested_pb = ui.ui_factory.nested_progress_bar()
222
from_branch.lock_read()
224
if last_revision is None:
225
pb.update('get source history')
226
from_history = from_branch.revision_history()
228
last_revision = from_history[-1]
230
# no history in the source branch
231
last_revision = _mod_revision.NULL_REVISION
232
return self.repository.fetch(from_branch.repository,
233
revision_id=last_revision,
236
if nested_pb is not None:
240
def get_bound_location(self):
241
"""Return the URL of the branch we are bound to.
243
Older format branches cannot bind, please be sure to use a metadir
248
def get_commit_builder(self, parents, config=None, timestamp=None,
249
timezone=None, committer=None, revprops=None,
251
"""Obtain a CommitBuilder for this branch.
253
:param parents: Revision ids of the parents of the new revision.
254
:param config: Optional configuration to use.
255
:param timestamp: Optional timestamp recorded for commit.
256
:param timezone: Optional timezone for timestamp.
257
:param committer: Optional committer to set for commit.
258
:param revprops: Optional dictionary of revision properties.
259
:param revision_id: Optional revision id.
263
config = self.get_config()
265
return self.repository.get_commit_builder(self, parents, config,
266
timestamp, timezone, committer, revprops, revision_id)
268
def get_master_branch(self):
269
"""Return the branch we are bound to.
271
:return: Either a Branch, or None
194
raise NotImplementedError('abspath is abstract')
196
def controlfilename(self, file_or_path):
197
"""Return location relative to branch."""
198
raise NotImplementedError('controlfilename is abstract')
200
def controlfile(self, file_or_path, mode='r'):
201
"""Open a control file for this branch.
203
There are two classes of file in the control directory: text
204
and binary. binary files are untranslated byte streams. Text
205
control files are stored with Unix newlines and in UTF-8, even
206
if the platform or locale defaults are different.
208
Controlfiles should almost never be opened in write mode but
209
rather should be atomically copied and replaced using atomicfile.
211
raise NotImplementedError('controlfile is abstract')
213
def put_controlfile(self, path, f, encode=True):
214
"""Write an entry as a controlfile.
216
:param path: The path to put the file, relative to the .bzr control
218
:param f: A file-like or string object whose contents should be copied.
219
:param encode: If true, encode the contents as utf-8
221
raise NotImplementedError('put_controlfile is abstract')
223
def put_controlfiles(self, files, encode=True):
224
"""Write several entries as controlfiles.
226
:param files: A list of [(path, file)] pairs, where the path is the directory
227
underneath the bzr control directory
228
:param encode: If true, encode the contents as utf-8
230
raise NotImplementedError('put_controlfiles is abstract')
232
def get_root_id(self):
233
"""Return the id of this branches root"""
234
raise NotImplementedError('get_root_id is abstract')
236
def set_root_id(self, file_id):
237
raise NotImplementedError('set_root_id is abstract')
239
def print_file(self, file, revno):
240
"""Print `file` to stdout."""
241
raise NotImplementedError('print_file is abstract')
243
def append_revision(self, *revision_ids):
244
raise NotImplementedError('append_revision is abstract')
246
def set_revision_history(self, rev_history):
247
raise NotImplementedError('set_revision_history is abstract')
249
def has_revision(self, revision_id):
250
"""True if this branch has a copy of the revision.
252
This does not necessarily imply the revision is merge
253
or on the mainline."""
254
raise NotImplementedError('has_revision is abstract')
256
def get_revision_xml(self, revision_id):
257
raise NotImplementedError('get_revision_xml is abstract')
259
def get_revision(self, revision_id):
260
"""Return the Revision object for a named revision"""
261
raise NotImplementedError('get_revision is abstract')
275
263
def get_revision_delta(self, revno):
276
264
"""Return the delta for one revision.
466
481
if revno < 1 or revno > self.revno():
467
482
raise InvalidRevisionNumber(revno)
470
def clone(self, *args, **kwargs):
471
"""Clone this branch into to_bzrdir preserving all semantic values.
473
revision_id: if not None, the revision history in the new branch will
474
be truncated to end with revision_id.
476
# for API compatibility, until 0.8 releases we provide the old api:
477
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
478
# after 0.8 releases, the *args and **kwargs should be changed:
479
# def clone(self, to_bzrdir, revision_id=None):
480
if (kwargs.get('to_location', None) or
481
kwargs.get('revision', None) or
482
kwargs.get('basis_branch', None) or
483
(len(args) and isinstance(args[0], basestring))):
484
# backwards compatibility api:
485
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
486
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
489
basis_branch = args[2]
491
basis_branch = kwargs.get('basis_branch', None)
493
basis = basis_branch.bzrdir
498
revision_id = args[1]
500
revision_id = kwargs.get('revision', None)
505
# no default to raise if not provided.
506
url = kwargs.get('to_location')
507
return self.bzrdir.clone(url,
508
revision_id=revision_id,
509
basis=basis).open_branch()
511
# generate args by hand
513
revision_id = args[1]
515
revision_id = kwargs.get('revision_id', None)
519
# no default to raise if not provided.
520
to_bzrdir = kwargs.get('to_bzrdir')
521
result = self._format.initialize(to_bzrdir)
522
self.copy_content_into(result, revision_id=revision_id)
526
def sprout(self, to_bzrdir, revision_id=None):
527
"""Create a new line of development from the branch, into to_bzrdir.
529
revision_id: if not None, the revision history in the new branch will
530
be truncated to end with revision_id.
532
result = self._format.initialize(to_bzrdir)
533
self.copy_content_into(result, revision_id=revision_id)
534
result.set_parent(self.bzrdir.root_transport.base)
538
def copy_content_into(self, destination, revision_id=None):
539
"""Copy the content of self into destination.
541
revision_id: if not None, the revision history in the new branch will
542
be truncated to end with revision_id.
544
new_history = self.revision_history()
545
if revision_id is not None:
547
new_history = new_history[:new_history.index(revision_id) + 1]
549
rev = self.repository.get_revision(revision_id)
550
new_history = rev.get_history(self.repository)[1:]
551
destination.set_revision_history(new_history)
553
parent = self.get_parent()
554
except errors.InaccessibleParent, e:
555
mutter('parent was not accessible to copy: %s', e)
558
destination.set_parent(parent)
562
"""Check consistency of the branch.
564
In particular this checks that revisions given in the revision-history
565
do actually match up in the revision graph, and that they're all
566
present in the repository.
568
Callers will typically also want to check the repository.
570
:return: A BranchCheckResult.
572
mainline_parent_id = None
573
for revision_id in self.revision_history():
575
revision = self.repository.get_revision(revision_id)
576
except errors.NoSuchRevision, e:
577
raise errors.BzrCheckError("mainline revision {%s} not in repository"
579
# In general the first entry on the revision history has no parents.
580
# But it's not illegal for it to have parents listed; this can happen
581
# in imports from Arch when the parents weren't reachable.
582
if mainline_parent_id is not None:
583
if mainline_parent_id not in revision.parent_ids:
584
raise errors.BzrCheckError("previous revision {%s} not listed among "
586
% (mainline_parent_id, revision_id))
587
mainline_parent_id = revision_id
588
return BranchCheckResult(self)
590
def _get_checkout_format(self):
591
"""Return the most suitable metadir for a checkout of this branch.
592
Weaves are used if this branch's repostory uses weaves.
594
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
595
from bzrlib import repository
596
format = bzrdir.BzrDirMetaFormat1()
597
format.repository_format = repository.RepositoryFormat7()
599
format = self.repository.bzrdir.cloning_metadir()
602
def create_checkout(self, to_location, revision_id=None,
604
"""Create a checkout of a branch.
606
:param to_location: The url to produce the checkout at
607
:param revision_id: The revision to check out
608
:param lightweight: If True, produce a lightweight checkout, otherwise,
609
produce a bound branch (heavyweight checkout)
610
:return: The tree of the created checkout
612
t = transport.get_transport(to_location)
615
except errors.FileExists:
618
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
619
BranchReferenceFormat().initialize(checkout, self)
621
format = self._get_checkout_format()
622
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
623
to_location, force_new_tree=False, format=format)
624
checkout = checkout_branch.bzrdir
625
checkout_branch.bind(self)
626
# pull up to the specified revision_id to set the initial
627
# branch tip correctly, and seed it with history.
628
checkout_branch.pull(self, stop_revision=revision_id)
629
return checkout.create_workingtree(revision_id)
632
class BranchFormat(object):
633
"""An encapsulation of the initialization and open routines for a format.
635
Formats provide three things:
636
* An initialization routine,
640
Formats are placed in an dict by their format string for reference
641
during branch opening. Its not required that these be instances, they
642
can be classes themselves with class methods - it simply depends on
643
whether state is needed for a given format or not.
645
Once a format is deprecated, just deprecate the initialize and open
646
methods on the format class. Do not deprecate the object, as the
647
object will be created every time regardless.
650
_default_format = None
651
"""The default format used for new branches."""
654
"""The known formats."""
657
def find_format(klass, a_bzrdir):
658
"""Return the format for the branch object in a_bzrdir."""
660
transport = a_bzrdir.get_branch_transport(None)
661
format_string = transport.get("format").read()
662
return klass._formats[format_string]
664
raise NotBranchError(path=transport.base)
666
raise errors.UnknownFormatError(format=format_string)
669
def get_default_format(klass):
670
"""Return the current default format."""
671
return klass._default_format
673
def get_format_string(self):
674
"""Return the ASCII format string that identifies this format."""
675
raise NotImplementedError(self.get_format_string)
677
def get_format_description(self):
678
"""Return the short format description for this format."""
679
raise NotImplementedError(self.get_format_string)
681
def initialize(self, a_bzrdir):
682
"""Create a branch of this format in a_bzrdir."""
683
raise NotImplementedError(self.initialize)
685
def is_supported(self):
686
"""Is this format supported?
688
Supported formats can be initialized and opened.
689
Unsupported formats may not support initialization or committing or
690
some other features depending on the reason for not being supported.
694
def open(self, a_bzrdir, _found=False):
695
"""Return the branch object for a_bzrdir
697
_found is a private parameter, do not use it. It is used to indicate
698
if format probing has already be done.
700
raise NotImplementedError(self.open)
703
def register_format(klass, format):
704
klass._formats[format.get_format_string()] = format
707
def set_default_format(klass, format):
708
klass._default_format = format
711
def unregister_format(klass, format):
712
assert klass._formats[format.get_format_string()] is format
713
del klass._formats[format.get_format_string()]
716
return self.get_format_string().rstrip()
719
class BzrBranchFormat4(BranchFormat):
720
"""Bzr branch format 4.
723
- a revision-history file.
724
- a branch-lock lock file [ to be shared with the bzrdir ]
727
def get_format_description(self):
728
"""See BranchFormat.get_format_description()."""
729
return "Branch format 4"
731
def initialize(self, a_bzrdir):
732
"""Create a branch of this format in a_bzrdir."""
733
mutter('creating branch in %s', a_bzrdir.transport.base)
734
branch_transport = a_bzrdir.get_branch_transport(self)
735
utf8_files = [('revision-history', ''),
738
control_files = lockable_files.LockableFiles(branch_transport,
739
'branch-lock', lockable_files.TransportLock)
740
control_files.create_lock()
741
control_files.lock_write()
743
for file, content in utf8_files:
744
control_files.put_utf8(file, content)
746
control_files.unlock()
747
return self.open(a_bzrdir, _found=True)
750
super(BzrBranchFormat4, self).__init__()
751
self._matchingbzrdir = bzrdir.BzrDirFormat6()
753
def open(self, a_bzrdir, _found=False):
754
"""Return the branch object for a_bzrdir
756
_found is a private parameter, do not use it. It is used to indicate
757
if format probing has already be done.
760
# we are being called directly and must probe.
761
raise NotImplementedError
762
return BzrBranch(_format=self,
763
_control_files=a_bzrdir._control_files,
765
_repository=a_bzrdir.open_repository())
768
return "Bazaar-NG branch format 4"
771
class BzrBranchFormat5(BranchFormat):
772
"""Bzr branch format 5.
775
- a revision-history file.
777
- a lock dir guarding the branch itself
778
- all of this stored in a branch/ subdirectory
779
- works with shared repositories.
781
This format is new in bzr 0.8.
784
def get_format_string(self):
785
"""See BranchFormat.get_format_string()."""
786
return "Bazaar-NG branch format 5\n"
788
def get_format_description(self):
789
"""See BranchFormat.get_format_description()."""
790
return "Branch format 5"
792
def initialize(self, a_bzrdir):
793
"""Create a branch of this format in a_bzrdir."""
794
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
795
branch_transport = a_bzrdir.get_branch_transport(self)
796
utf8_files = [('revision-history', ''),
799
control_files = lockable_files.LockableFiles(branch_transport, 'lock',
801
control_files.create_lock()
802
control_files.lock_write()
803
control_files.put_utf8('format', self.get_format_string())
805
for file, content in utf8_files:
806
control_files.put_utf8(file, content)
808
control_files.unlock()
809
return self.open(a_bzrdir, _found=True, )
812
super(BzrBranchFormat5, self).__init__()
813
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
815
def open(self, a_bzrdir, _found=False):
816
"""Return the branch object for a_bzrdir
818
_found is a private parameter, do not use it. It is used to indicate
819
if format probing has already be done.
822
format = BranchFormat.find_format(a_bzrdir)
823
assert format.__class__ == self.__class__
824
transport = a_bzrdir.get_branch_transport(None)
825
control_files = lockable_files.LockableFiles(transport, 'lock',
827
return BzrBranch5(_format=self,
828
_control_files=control_files,
830
_repository=a_bzrdir.find_repository())
833
return "Bazaar-NG Metadir branch format 5"
836
class BranchReferenceFormat(BranchFormat):
837
"""Bzr branch reference format.
839
Branch references are used in implementing checkouts, they
840
act as an alias to the real branch which is at some other url.
847
def get_format_string(self):
848
"""See BranchFormat.get_format_string()."""
849
return "Bazaar-NG Branch Reference Format 1\n"
851
def get_format_description(self):
852
"""See BranchFormat.get_format_description()."""
853
return "Checkout reference format 1"
855
def initialize(self, a_bzrdir, target_branch=None):
856
"""Create a branch of this format in a_bzrdir."""
857
if target_branch is None:
858
# this format does not implement branch itself, thus the implicit
859
# creation contract must see it as uninitializable
860
raise errors.UninitializableFormat(self)
861
mutter('creating branch reference in %s', a_bzrdir.transport.base)
862
branch_transport = a_bzrdir.get_branch_transport(self)
863
branch_transport.put_bytes('location',
864
target_branch.bzrdir.root_transport.base)
865
branch_transport.put_bytes('format', self.get_format_string())
866
return self.open(a_bzrdir, _found=True)
869
super(BranchReferenceFormat, self).__init__()
870
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
872
def _make_reference_clone_function(format, a_branch):
873
"""Create a clone() routine for a branch dynamically."""
874
def clone(to_bzrdir, revision_id=None):
875
"""See Branch.clone()."""
876
return format.initialize(to_bzrdir, a_branch)
877
# cannot obey revision_id limits when cloning a reference ...
878
# FIXME RBC 20060210 either nuke revision_id for clone, or
879
# emit some sort of warning/error to the caller ?!
882
def open(self, a_bzrdir, _found=False):
883
"""Return the branch that the branch reference in a_bzrdir points at.
885
_found is a private parameter, do not use it. It is used to indicate
886
if format probing has already be done.
889
format = BranchFormat.find_format(a_bzrdir)
890
assert format.__class__ == self.__class__
891
transport = a_bzrdir.get_branch_transport(None)
892
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
893
result = real_bzrdir.open_branch()
894
# this changes the behaviour of result.clone to create a new reference
895
# rather than a copy of the content of the branch.
896
# I did not use a proxy object because that needs much more extensive
897
# testing, and we are only changing one behaviour at the moment.
898
# If we decide to alter more behaviours - i.e. the implicit nickname
899
# then this should be refactored to introduce a tested proxy branch
900
# and a subclass of that for use in overriding clone() and ....
902
result.clone = self._make_reference_clone_function(result)
906
# formats which have no format string are not discoverable
907
# and not independently creatable, so are not registered.
908
__default_format = BzrBranchFormat5()
909
BranchFormat.register_format(__default_format)
910
BranchFormat.register_format(BranchReferenceFormat())
911
BranchFormat.set_default_format(__default_format)
912
_legacy_formats = [BzrBranchFormat4(),
484
def sign_revision(self, revision_id, gpg_strategy):
485
raise NotImplementedError('sign_revision is abstract')
487
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
488
raise NotImplementedError('store_revision_signature is abstract')
915
490
class BzrBranch(Branch):
916
491
"""A branch stored in the actual filesystem.
935
552
version is not applied. This is intended only for
936
553
upgrade/recovery type use; it's not guaranteed that
937
554
all operations will work on old format branches.
556
In the test suite, creation of new trees is tested using the
557
`ScratchBranch` class.
940
self.bzrdir = bzrdir.BzrDir.open(transport.base)
942
self.bzrdir = a_bzrdir
943
self._transport = self.bzrdir.transport.clone('..')
944
self._base = self._transport.base
945
self._format = _format
946
if _control_files is None:
947
raise ValueError('BzrBranch _control_files is None')
948
self.control_files = _control_files
949
if deprecated_passed(init):
950
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
951
"deprecated as of bzr 0.8. Please use Branch.create().",
955
# this is slower than before deprecation, oh well never mind.
957
self._initialize(transport.base)
958
self._check_format(_format)
959
if deprecated_passed(relax_version_check):
960
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
961
"relax_version_check parameter is deprecated as of bzr 0.8. "
962
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
966
if (not relax_version_check
967
and not self._format.is_supported()):
968
raise errors.UnsupportedFormatError(format=fmt)
969
if deprecated_passed(transport):
970
warn("BzrBranch.__init__(transport=XXX...): The transport "
971
"parameter is deprecated as of bzr 0.8. "
972
"Please use Branch.open, or bzrdir.open_branch().",
975
self.repository = _repository
559
assert isinstance(transport, Transport), \
560
"%r is not a Transport" % transport
561
self._transport = transport
564
self._check_format(relax_version_check)
566
def get_store(name, compressed=True, prefixed=False):
567
# FIXME: This approach of assuming stores are all entirely compressed
568
# or entirely uncompressed is tidy, but breaks upgrade from
569
# some existing branches where there's a mixture; we probably
570
# still want the option to look for both.
571
relpath = self._rel_controlfilename(name)
572
store = TextStore(self._transport.clone(relpath),
574
compressed=compressed)
575
#if self._transport.should_cache():
576
# cache_path = os.path.join(self.cache_root, name)
577
# os.mkdir(cache_path)
578
# store = bzrlib.store.CachedStore(store, cache_path)
580
def get_weave(name, prefixed=False):
581
relpath = self._rel_controlfilename(name)
582
ws = WeaveStore(self._transport.clone(relpath), prefixed=prefixed)
583
if self._transport.should_cache():
584
ws.enable_cache = True
587
if self._branch_format == 4:
588
self.inventory_store = get_store('inventory-store')
589
self.text_store = get_store('text-store')
590
self.revision_store = get_store('revision-store')
591
elif self._branch_format == 5:
592
self.control_weaves = get_weave('')
593
self.weave_store = get_weave('weaves')
594
self.revision_store = get_store('revision-store', compressed=False)
595
elif self._branch_format == 6:
596
self.control_weaves = get_weave('')
597
self.weave_store = get_weave('weaves', prefixed=True)
598
self.revision_store = get_store('revision-store', compressed=False,
600
self.revision_store.register_suffix('sig')
601
self._transaction = None
977
603
def __str__(self):
978
return '%s(%r)' % (self.__class__.__name__, self.base)
604
return '%s(%r)' % (self.__class__.__name__, self._transport.base)
980
606
__repr__ = __str__
609
if self._lock_mode or self._lock:
610
# XXX: This should show something every time, and be suitable for
611
# headless operation and embedding
612
warn("branch %r was not explicitly unlocked" % self)
615
# TODO: It might be best to do this somewhere else,
616
# but it is nice for a Branch object to automatically
617
# cache it's information.
618
# Alternatively, we could have the Transport objects cache requests
619
# See the earlier discussion about how major objects (like Branch)
620
# should never expect their __del__ function to run.
621
if hasattr(self, 'cache_root') and self.cache_root is not None:
623
shutil.rmtree(self.cache_root)
626
self.cache_root = None
982
628
def _get_base(self):
630
return self._transport.base
985
633
base = property(_get_base, doc="The URL for the root of this branch.")
987
635
def _finish_transaction(self):
988
636
"""Exit the current transaction."""
989
return self.control_files._finish_transaction()
637
if self._transaction is None:
638
raise errors.LockError('Branch %s is not in a transaction' %
640
transaction = self._transaction
641
self._transaction = None
991
644
def get_transaction(self):
992
"""Return the current active transaction.
994
If no transaction is active, this returns a passthrough object
995
for which all data is immediately flushed and no caching happens.
997
# this is an explicit function so that we can do tricky stuff
998
# when the storage in rev_storage is elsewhere.
999
# we probably need to hook the two 'lock a location' and
1000
# 'have a transaction' together more delicately, so that
1001
# we can have two locks (branch and storage) and one transaction
1002
# ... and finishing the transaction unlocks both, but unlocking
1003
# does not. - RBC 20051121
1004
return self.control_files.get_transaction()
1006
def _set_transaction(self, transaction):
645
"""See Branch.get_transaction."""
646
if self._transaction is None:
647
return transactions.PassThroughTransaction()
649
return self._transaction
651
def _set_transaction(self, new_transaction):
1007
652
"""Set a new active transaction."""
1008
return self.control_files._set_transaction(transaction)
653
if self._transaction is not None:
654
raise errors.LockError('Branch %s is in a transaction already.' %
656
self._transaction = new_transaction
658
def lock_write(self):
659
mutter("lock write: %s (%s)", self, self._lock_count)
660
# TODO: Upgrade locking to support using a Transport,
661
# and potentially a remote locking protocol
663
if self._lock_mode != 'w':
664
raise LockError("can't upgrade to a write lock from %r" %
666
self._lock_count += 1
668
self._lock = self._transport.lock_write(
669
self._rel_controlfilename('branch-lock'))
670
self._lock_mode = 'w'
672
self._set_transaction(transactions.PassThroughTransaction())
675
mutter("lock read: %s (%s)", self, self._lock_count)
677
assert self._lock_mode in ('r', 'w'), \
678
"invalid lock mode %r" % self._lock_mode
679
self._lock_count += 1
681
self._lock = self._transport.lock_read(
682
self._rel_controlfilename('branch-lock'))
683
self._lock_mode = 'r'
685
self._set_transaction(transactions.ReadOnlyTransaction())
686
# 5K may be excessive, but hey, its a knob.
687
self.get_transaction().set_cache_size(5000)
690
mutter("unlock: %s (%s)", self, self._lock_count)
691
if not self._lock_mode:
692
raise LockError('branch %r is not locked' % (self))
694
if self._lock_count > 1:
695
self._lock_count -= 1
697
self._finish_transaction()
700
self._lock_mode = self._lock_count = None
1010
702
def abspath(self, name):
1011
703
"""See Branch.abspath."""
1012
return self.control_files._transport.abspath(name)
1014
def _check_format(self, format):
1015
"""Identify the branch format if needed.
1017
The format is stored as a reference to the format object in
1018
self._format for code that needs to check it later.
1020
The format parameter is either None or the branch format class
1021
used to open this branch.
1023
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
704
return self._transport.abspath(name)
706
def _rel_controlfilename(self, file_or_path):
707
if not isinstance(file_or_path, basestring):
708
file_or_path = '/'.join(file_or_path)
709
if file_or_path == '':
711
return bzrlib.transport.urlescape(bzrlib.BZRDIR + '/' + file_or_path)
713
def controlfilename(self, file_or_path):
714
"""See Branch.controlfilename."""
715
return self._transport.abspath(self._rel_controlfilename(file_or_path))
717
def controlfile(self, file_or_path, mode='r'):
718
"""See Branch.controlfile."""
721
relpath = self._rel_controlfilename(file_or_path)
722
#TODO: codecs.open() buffers linewise, so it was overloaded with
723
# a much larger buffer, do we need to do the same for getreader/getwriter?
725
return self._transport.get(relpath)
727
raise BzrError("Branch.controlfile(mode='wb') is not supported, use put_controlfiles")
729
# XXX: Do we really want errors='replace'? Perhaps it should be
730
# an error, or at least reported, if there's incorrectly-encoded
731
# data inside a file.
732
# <https://launchpad.net/products/bzr/+bug/3823>
733
return codecs.getreader('utf-8')(self._transport.get(relpath), errors='replace')
735
raise BzrError("Branch.controlfile(mode='w') is not supported, use put_controlfiles")
737
raise BzrError("invalid controlfile mode %r" % mode)
739
def put_controlfile(self, path, f, encode=True):
740
"""See Branch.put_controlfile."""
741
self.put_controlfiles([(path, f)], encode=encode)
743
def put_controlfiles(self, files, encode=True):
744
"""See Branch.put_controlfiles."""
747
for path, f in files:
749
if isinstance(f, basestring):
750
f = f.encode('utf-8', 'replace')
752
f = codecs.getwriter('utf-8')(f, errors='replace')
753
path = self._rel_controlfilename(path)
754
ctrl_files.append((path, f))
755
self._transport.put_multi(ctrl_files)
757
def _make_control(self):
758
from bzrlib.inventory import Inventory
759
from bzrlib.weavefile import write_weave_v5
760
from bzrlib.weave import Weave
762
# Create an empty inventory
764
# if we want per-tree root ids then this is the place to set
765
# them; they're not needed for now and so ommitted for
767
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), sio)
768
empty_inv = sio.getvalue()
770
bzrlib.weavefile.write_weave_v5(Weave(), sio)
771
empty_weave = sio.getvalue()
773
dirs = [[], 'revision-store', 'weaves']
775
"This is a Bazaar-NG control directory.\n"
776
"Do not change any files in this directory.\n"),
777
('branch-format', BZR_BRANCH_FORMAT_6),
778
('revision-history', ''),
781
('pending-merges', ''),
782
('inventory', empty_inv),
783
('inventory.weave', empty_weave),
784
('ancestry.weave', empty_weave)
786
cfn = self._rel_controlfilename
787
self._transport.mkdir_multi([cfn(d) for d in dirs])
788
self.put_controlfiles(files)
789
mutter('created control directory in ' + self._transport.base)
791
def _check_format(self, relax_version_check):
792
"""Check this branch format is supported.
794
The format level is stored, as an integer, in
795
self._branch_format for code that needs to check it later.
797
In the future, we might need different in-memory Branch
798
classes to support downlevel branches. But not yet.
1026
format = BranchFormat.find_format(self.bzrdir)
1027
self._format = format
1028
mutter("got branch format %s", self._format)
801
fmt = self.controlfile('branch-format', 'r').read()
803
raise NotBranchError(path=self.base)
804
mutter("got branch format %r", fmt)
805
if fmt == BZR_BRANCH_FORMAT_6:
806
self._branch_format = 6
807
elif fmt == BZR_BRANCH_FORMAT_5:
808
self._branch_format = 5
809
elif fmt == BZR_BRANCH_FORMAT_4:
810
self._branch_format = 4
812
if (not relax_version_check
813
and self._branch_format not in (5, 6)):
814
raise errors.UnsupportedFormatError(
815
'sorry, branch format %r not supported' % fmt,
816
['use a different bzr version',
817
'or remove the .bzr directory'
818
' and "bzr init" again'])
1030
820
@needs_read_lock
1031
821
def get_root_id(self):
1032
822
"""See Branch.get_root_id."""
1033
tree = self.repository.revision_tree(self.last_revision())
1034
return tree.inventory.root.file_id
1036
def is_locked(self):
1037
return self.control_files.is_locked()
1039
def lock_write(self):
1040
self.repository.lock_write()
1042
self.control_files.lock_write()
1044
self.repository.unlock()
1047
def lock_read(self):
1048
self.repository.lock_read()
1050
self.control_files.lock_read()
1052
self.repository.unlock()
1056
# TODO: test for failed two phase locks. This is known broken.
1058
self.control_files.unlock()
1060
self.repository.unlock()
1062
def peek_lock_mode(self):
1063
if self.control_files._lock_count == 0:
1066
return self.control_files._lock_mode
1068
def get_physical_lock_status(self):
1069
return self.control_files.get_physical_lock_status()
823
inv = self.get_inventory(self.last_revision())
824
return inv.root.file_id
1071
826
@needs_read_lock
1072
def print_file(self, file, revision_id):
827
def print_file(self, file, revno):
1073
828
"""See Branch.print_file."""
1074
return self.repository.print_file(file, revision_id)
829
tree = self.revision_tree(self.get_rev_id(revno))
830
# use inventory as it was in that revision
831
file_id = tree.inventory.path2id(file)
833
raise BzrError("%r is not present in revision %s" % (file, revno))
834
tree.print_file(file_id)
1076
836
@needs_write_lock
1077
837
def append_revision(self, *revision_ids):
1085
845
@needs_write_lock
1086
846
def set_revision_history(self, rev_history):
1087
847
"""See Branch.set_revision_history."""
1088
self.control_files.put_utf8(
1089
'revision-history', '\n'.join(rev_history))
1090
transaction = self.get_transaction()
1091
history = transaction.map.find_revision_history()
1092
if history is not None:
1093
# update the revision history in the identity map.
1094
history[:] = list(rev_history)
1095
# this call is disabled because revision_history is
1096
# not really an object yet, and the transaction is for objects.
1097
# transaction.register_dirty(history)
848
self.put_controlfile('revision-history', '\n'.join(rev_history))
850
def has_revision(self, revision_id):
851
"""See Branch.has_revision."""
852
return (revision_id is None
853
or self.revision_store.has_id(revision_id))
856
def _get_revision_xml_file(self, revision_id):
857
if not revision_id or not isinstance(revision_id, basestring):
858
raise InvalidRevisionId(revision_id=revision_id, branch=self)
860
return self.revision_store.get(revision_id)
861
except (IndexError, KeyError):
862
raise bzrlib.errors.NoSuchRevision(self, revision_id)
864
def get_revision_xml(self, revision_id):
865
"""See Branch.get_revision_xml."""
866
return self._get_revision_xml_file(revision_id).read()
868
def get_revision(self, revision_id):
869
"""See Branch.get_revision."""
870
xml_file = self._get_revision_xml_file(revision_id)
873
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
874
except SyntaxError, e:
875
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
879
assert r.revision_id == revision_id
882
def get_revision_sha1(self, revision_id):
883
"""See Branch.get_revision_sha1."""
884
# In the future, revision entries will be signed. At that
885
# point, it is probably best *not* to include the signature
886
# in the revision hash. Because that lets you re-sign
887
# the revision, (add signatures/remove signatures) and still
888
# have all hash pointers stay consistent.
889
# But for now, just hash the contents.
890
return bzrlib.osutils.sha_file(self.get_revision_xml_file(revision_id))
892
def get_ancestry(self, revision_id):
893
"""See Branch.get_ancestry."""
894
if revision_id is None:
896
w = self._get_inventory_weave()
897
return [None] + map(w.idx_to_name,
898
w.inclusions([w.lookup(revision_id)]))
900
def _get_inventory_weave(self):
901
return self.control_weaves.get_weave('inventory',
902
self.get_transaction())
904
def get_inventory(self, revision_id):
905
"""See Branch.get_inventory."""
906
xml = self.get_inventory_xml(revision_id)
907
return bzrlib.xml5.serializer_v5.read_inventory_from_string(xml)
909
def get_inventory_xml(self, revision_id):
910
"""See Branch.get_inventory_xml."""
912
assert isinstance(revision_id, basestring), type(revision_id)
913
iw = self._get_inventory_weave()
914
return iw.get_text(iw.lookup(revision_id))
916
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
918
def get_inventory_sha1(self, revision_id):
919
"""See Branch.get_inventory_sha1."""
920
return self.get_revision(revision_id).inventory_sha1
922
def get_revision_inventory(self, revision_id):
923
"""See Branch.get_revision_inventory."""
924
# TODO: Unify this with get_inventory()
925
# bzr 0.0.6 and later imposes the constraint that the inventory_id
926
# must be the same as its revision, so this is trivial.
927
if revision_id == None:
928
# This does not make sense: if there is no revision,
929
# then it is the current tree inventory surely ?!
930
# and thus get_root_id() is something that looks at the last
931
# commit on the branch, and the get_root_id is an inventory check.
932
raise NotImplementedError
933
# return Inventory(self.get_root_id())
1099
transaction.map.add_revision_history(rev_history)
1100
# this call is disabled because revision_history is
1101
# not really an object yet, and the transaction is for objects.
1102
# transaction.register_clean(history)
935
return self.get_inventory(revision_id)
1104
937
@needs_read_lock
1105
938
def revision_history(self):
1107
940
transaction = self.get_transaction()
1108
941
history = transaction.map.find_revision_history()
1109
942
if history is not None:
1110
# mutter("cache hit for revision-history in %s", self)
943
mutter("cache hit for revision-history in %s", self)
1111
944
return list(history)
1112
decode_utf8 = cache_utf8.decode
1113
history = [decode_utf8(l.rstrip('\r\n')) for l in
1114
self.control_files.get('revision-history').readlines()]
945
history = [l.rstrip('\r\n') for l in
946
self.controlfile('revision-history', 'r').readlines()]
1115
947
transaction.map.add_revision_history(history)
1116
948
# this call is disabled because revision_history is
1117
949
# not really an object yet, and the transaction is for objects.
1118
950
# transaction.register_clean(history, precious=True)
1119
951
return list(history)
1122
def generate_revision_history(self, revision_id, last_rev=None,
1124
"""Create a new revision history that will finish with revision_id.
1126
:param revision_id: the new tip to use.
1127
:param last_rev: The previous last_revision. If not None, then this
1128
must be a ancestory of revision_id, or DivergedBranches is raised.
1129
:param other_branch: The other branch that DivergedBranches should
1130
raise with respect to.
1132
# stop_revision must be a descendant of last_revision
1133
stop_graph = self.repository.get_revision_graph(revision_id)
1134
if last_rev is not None and last_rev not in stop_graph:
1135
# our previous tip is not merged into stop_revision
1136
raise errors.DivergedBranches(self, other_branch)
1137
# make a new revision history from the graph
1138
current_rev_id = revision_id
1140
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1141
new_history.append(current_rev_id)
1142
current_rev_id_parents = stop_graph[current_rev_id]
1144
current_rev_id = current_rev_id_parents[0]
1146
current_rev_id = None
1147
new_history.reverse()
1148
self.set_revision_history(new_history)
1151
953
def update_revisions(self, other, stop_revision=None):
1152
954
"""See Branch.update_revisions."""
955
from bzrlib.fetch import greedy_fetch
956
if stop_revision is None:
957
stop_revision = other.last_revision()
958
### Should this be checking is_ancestor instead of revision_history?
959
if (stop_revision is not None and
960
stop_revision in self.revision_history()):
962
greedy_fetch(to_branch=self, from_branch=other,
963
revision=stop_revision)
964
pullable_revs = self.pullable_revisions(other, stop_revision)
965
if len(pullable_revs) > 0:
966
self.append_revision(*pullable_revs)
968
def pullable_revisions(self, other, stop_revision):
969
"""See Branch.pullable_revisions."""
970
other_revno = other.revision_id_to_revno(stop_revision)
1155
if stop_revision is None:
1156
stop_revision = other.last_revision()
1157
if stop_revision is None:
1158
# if there are no commits, we're done.
1160
# whats the current last revision, before we fetch [and change it
1162
last_rev = self.last_revision()
1163
# we fetch here regardless of whether we need to so that we pickup
1165
self.fetch(other, stop_revision)
1166
my_ancestry = self.repository.get_ancestry(last_rev)
1167
if stop_revision in my_ancestry:
1168
# last_revision is a descendant of stop_revision
1170
self.generate_revision_history(stop_revision, last_rev=last_rev,
1175
def basis_tree(self):
1176
"""See Branch.basis_tree."""
1177
return self.repository.revision_tree(self.last_revision())
1179
@deprecated_method(zero_eight)
972
return self.missing_revisions(other, other_revno)
973
except DivergedBranches, e:
975
pullable_revs = get_intervening_revisions(self.last_revision(),
977
assert self.last_revision() not in pullable_revs
979
except bzrlib.errors.NotAncestor:
980
if is_ancestor(self.last_revision(), stop_revision, self):
985
def revision_tree(self, revision_id):
986
"""See Branch.revision_tree."""
987
# TODO: refactor this to use an existing revision object
988
# so we don't need to read it in twice.
989
if revision_id == None or revision_id == NULL_REVISION:
992
inv = self.get_revision_inventory(revision_id)
993
return RevisionTree(self.weave_store, inv, revision_id)
1180
995
def working_tree(self):
1181
"""Create a Working tree object for this branch."""
1183
from bzrlib.transport.local import LocalTransport
1184
if (self.base.find('://') != -1 or
1185
not isinstance(self._transport, LocalTransport)):
996
"""See Branch.working_tree."""
997
from bzrlib.workingtree import WorkingTree
998
if self._transport.base.find('://') != -1:
1186
999
raise NoWorkingTree(self.base)
1187
return self.bzrdir.open_workingtree()
1000
return WorkingTree(self.base, branch=self)
1189
1002
@needs_write_lock
1190
def pull(self, source, overwrite=False, stop_revision=None):
1003
def pull(self, source, overwrite=False):
1191
1004
"""See Branch.pull."""
1192
1005
source.lock_read()
1194
1007
old_count = len(self.revision_history())
1196
self.update_revisions(source, stop_revision)
1009
self.update_revisions(source)
1197
1010
except DivergedBranches:
1198
1011
if not overwrite:
1201
1013
self.set_revision_history(source.revision_history())
1202
1014
new_count = len(self.revision_history())
1203
1015
return new_count - old_count
1207
1019
def get_parent(self):
1208
1020
"""See Branch.get_parent."""
1210
1022
_locs = ['parent', 'pull', 'x-pull']
1211
assert self.base[-1] == '/'
1212
1023
for l in _locs:
1214
parent = self.control_files.get(l).read().strip('\n')
1217
# This is an old-format absolute path to a local branch
1218
# turn it into a url
1219
if parent.startswith('/'):
1220
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1222
return urlutils.join(self.base[:-1], parent)
1223
except errors.InvalidURLJoin, e:
1224
raise errors.InaccessibleParent(parent, self.base)
1025
return self.controlfile(l, 'r').read().strip('\n')
1027
if e.errno != errno.ENOENT:
1227
1031
def get_push_location(self):
1228
1032
"""See Branch.get_push_location."""
1229
push_loc = self.get_config().get_user_option('push_location')
1033
config = bzrlib.config.BranchConfig(self)
1034
push_loc = config.get_user_option('push_location')
1230
1035
return push_loc
1232
1037
def set_push_location(self, location):
1233
1038
"""See Branch.set_push_location."""
1234
self.get_config().set_user_option(
1235
'push_location', location,
1236
store=_mod_config.STORE_LOCATION_NORECURSE)
1039
config = bzrlib.config.LocationConfig(self.base)
1040
config.set_user_option('push_location', location)
1238
1042
@needs_write_lock
1239
1043
def set_parent(self, url):
1240
1044
"""See Branch.set_parent."""
1241
1045
# TODO: Maybe delete old location files?
1242
# URLs should never be unicode, even on the local fs,
1243
# FIXUP this and get_parent in a future branch format bump:
1244
# read and rewrite the file, and have the new format code read
1245
# using .get not .get_utf8. RBC 20060125
1247
self.control_files._transport.delete('parent')
1249
if isinstance(url, unicode):
1251
url = url.encode('ascii')
1252
except UnicodeEncodeError:
1253
raise bzrlib.errors.InvalidURL(url,
1254
"Urls must be 7-bit ascii, "
1255
"use bzrlib.urlutils.escape")
1257
url = urlutils.relative_url(self.base, url)
1258
self.control_files.put('parent', StringIO(url + '\n'))
1046
from bzrlib.atomicfile import AtomicFile
1047
f = AtomicFile(self.controlfilename('parent'))
1260
@deprecated_function(zero_nine)
1261
1054
def tree_config(self):
1262
"""DEPRECATED; call get_config instead.
1263
TreeConfig has become part of BranchConfig."""
1264
1055
return TreeConfig(self)
1267
class BzrBranch5(BzrBranch):
1268
"""A format 5 branch. This supports new features over plan branches.
1270
It has support for a master_branch which is the data for bound branches.
1057
def sign_revision(self, revision_id, gpg_strategy):
1058
"""See Branch.sign_revision."""
1059
plaintext = Testament.from_revision(self, revision_id).as_short_text()
1060
self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1063
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1064
"""See Branch.store_revision_signature."""
1065
self.revision_store.add(StringIO(gpg_strategy.sign(plaintext)),
1069
class ScratchBranch(BzrBranch):
1070
"""Special test class: a branch that cleans up after itself.
1072
>>> b = ScratchBranch()
1076
>>> b._transport.__del__()
1278
super(BzrBranch5, self).__init__(_format=_format,
1279
_control_files=_control_files,
1281
_repository=_repository)
1284
def pull(self, source, overwrite=False, stop_revision=None):
1285
"""Updates branch.pull to be bound branch aware."""
1286
bound_location = self.get_bound_location()
1287
if source.base != bound_location:
1288
# not pulling from master, so we need to update master.
1289
master_branch = self.get_master_branch()
1291
master_branch.pull(source)
1292
source = master_branch
1293
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1295
def get_bound_location(self):
1297
return self.control_files.get_utf8('bound').read()[:-1]
1298
except errors.NoSuchFile:
1302
def get_master_branch(self):
1303
"""Return the branch we are bound to.
1305
:return: Either a Branch, or None
1307
This could memoise the branch, but if thats done
1308
it must be revalidated on each new lock.
1309
So for now we just don't memoise it.
1310
# RBC 20060304 review this decision.
1312
bound_loc = self.get_bound_location()
1316
return Branch.open(bound_loc)
1317
except (errors.NotBranchError, errors.ConnectionError), e:
1318
raise errors.BoundBranchConnectionFailure(
1322
def set_bound_location(self, location):
1323
"""Set the target where this branch is bound to.
1325
:param location: URL to the target branch
1328
self.control_files.put_utf8('bound', location+'\n')
1081
def __init__(self, files=[], dirs=[], transport=None):
1082
"""Make a test branch.
1084
This creates a temporary directory and runs init-tree in it.
1086
If any files are listed, they are created in the working copy.
1088
if transport is None:
1089
transport = bzrlib.transport.local.ScratchTransport()
1090
super(ScratchBranch, self).__init__(transport, init=True)
1331
self.control_files._transport.delete('bound')
1092
super(ScratchBranch, self).__init__(transport)
1095
self._transport.mkdir(d)
1098
self._transport.put(f, 'content of %s' % f)
1103
>>> orig = ScratchBranch(files=["file1", "file2"])
1104
>>> clone = orig.clone()
1105
>>> if os.name != 'nt':
1106
... os.path.samefile(orig.base, clone.base)
1108
... orig.base == clone.base
1111
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1114
from shutil import copytree
1115
from tempfile import mkdtemp
1118
copytree(self.base, base, symlinks=True)
1119
return ScratchBranch(
1120
transport=bzrlib.transport.local.ScratchTransport(base))
1123
######################################################################
1127
def is_control_file(filename):
1128
## FIXME: better check
1129
filename = os.path.normpath(filename)
1130
while filename != '':
1131
head, tail = os.path.split(filename)
1132
## mutter('check %r for control file' % ((head, tail), ))
1133
if tail == bzrlib.BZRDIR:
1337
def bind(self, other):
1338
"""Bind this branch to the branch other.
1340
This does not push or pull data between the branches, though it does
1341
check for divergence to raise an error when the branches are not
1342
either the same, or one a prefix of the other. That behaviour may not
1343
be useful, so that check may be removed in future.
1345
:param other: The branch to bind to
1348
# TODO: jam 20051230 Consider checking if the target is bound
1349
# It is debatable whether you should be able to bind to
1350
# a branch which is itself bound.
1351
# Committing is obviously forbidden,
1352
# but binding itself may not be.
1353
# Since we *have* to check at commit time, we don't
1354
# *need* to check here
1356
# we want to raise diverged if:
1357
# last_rev is not in the other_last_rev history, AND
1358
# other_last_rev is not in our history, and do it without pulling
1360
last_rev = self.last_revision()
1361
if last_rev is not None:
1364
other_last_rev = other.last_revision()
1365
if other_last_rev is not None:
1366
# neither branch is new, we have to do some work to
1367
# ascertain diversion.
1368
remote_graph = other.repository.get_revision_graph(
1370
local_graph = self.repository.get_revision_graph(last_rev)
1371
if (last_rev not in remote_graph and
1372
other_last_rev not in local_graph):
1373
raise errors.DivergedBranches(self, other)
1376
self.set_bound_location(other.base)
1380
"""If bound, unbind"""
1381
return self.set_bound_location(None)
1385
"""Synchronise this branch with the master branch if any.
1387
:return: None or the last_revision that was pivoted out during the
1390
master = self.get_master_branch()
1391
if master is not None:
1392
old_tip = self.last_revision()
1393
self.pull(master, overwrite=True)
1394
if old_tip in self.repository.get_ancestry(self.last_revision()):
1400
class BranchTestProviderAdapter(object):
1401
"""A tool to generate a suite testing multiple branch formats at once.
1403
This is done by copying the test once for each transport and injecting
1404
the transport_server, transport_readonly_server, and branch_format
1405
classes into each copy. Each copy is also given a new id() to make it
1409
def __init__(self, transport_server, transport_readonly_server, formats):
1410
self._transport_server = transport_server
1411
self._transport_readonly_server = transport_readonly_server
1412
self._formats = formats
1414
def adapt(self, test):
1415
result = TestSuite()
1416
for branch_format, bzrdir_format in self._formats:
1417
new_test = deepcopy(test)
1418
new_test.transport_server = self._transport_server
1419
new_test.transport_readonly_server = self._transport_readonly_server
1420
new_test.bzrdir_format = bzrdir_format
1421
new_test.branch_format = branch_format
1422
def make_new_test_id():
1423
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1424
return lambda: new_id
1425
new_test.id = make_new_test_id()
1426
result.addTest(new_test)
1430
class BranchCheckResult(object):
1431
"""Results of checking branch consistency.
1436
def __init__(self, branch):
1437
self.branch = branch
1439
def report_results(self, verbose):
1440
"""Report the check results via trace.note.
1442
:param verbose: Requests more detailed display of what was checked,
1445
note('checked branch %s format %s',
1447
self.branch._format)
1450
######################################################################
1454
@deprecated_function(zero_eight)
1455
def is_control_file(*args, **kwargs):
1456
"""See bzrlib.workingtree.is_control_file."""
1457
from bzrlib import workingtree
1458
return workingtree.is_control_file(*args, **kwargs)
1135
if filename == head:
added
removed
bzrlib/branch.py
