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
18
from copy import deepcopy
19
from cStringIO import StringIO
24
from unittest import TestSuite
25
from warnings import warn
28
import bzrlib.bzrdir as bzrdir
29
from bzrlib.config import TreeConfig
30
from bzrlib.decorators import needs_read_lock, needs_write_lock
31
from bzrlib.delta import compare_trees
32
import bzrlib.errors as errors
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
34
NoSuchRevision, HistoryMissing, NotBranchError,
35
DivergedBranches, LockError,
36
UninitializableFormat,
38
UnlistableBranch, NoSuchFile, NotVersionedError,
40
import bzrlib.inventory as inventory
41
from bzrlib.inventory import Inventory
42
from bzrlib.lockable_files import LockableFiles, TransportLock
43
from bzrlib.lockdir import LockDir
44
from bzrlib.osutils import (isdir, quotefn,
45
rename, splitpath, sha_file,
46
file_kind, abspath, normpath, pathjoin,
49
from bzrlib.textui import show_status
50
from bzrlib.trace import mutter, note
51
from bzrlib.tree import EmptyTree, RevisionTree
52
from bzrlib.repository import Repository
53
from bzrlib.revision import (
54
get_intervening_revisions,
59
from bzrlib.store import copy_all
60
from bzrlib.symbol_versioning import *
61
import bzrlib.transactions as transactions
62
from bzrlib.transport import Transport, get_transport
63
from bzrlib.tree import EmptyTree, RevisionTree
68
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
69
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
70
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
73
# TODO: Maybe include checks for common corruption of newlines, etc?
75
# TODO: Some operations like log might retrieve the same revisions
76
# repeatedly to calculate deltas. We could perhaps have a weakref
77
# cache in memory to make this faster. In general anything can be
78
# cached in memory between lock and unlock operations. .. nb thats
79
# what the transaction identity map provides
82
######################################################################
86
"""Branch holding a history of revisions.
89
Base directory/url of the branch.
91
# this is really an instance variable - FIXME move it there
95
def __init__(self, *ignored, **ignored_too):
96
raise NotImplementedError('The Branch class is abstract')
99
@deprecated_method(zero_eight)
100
def open_downlevel(base):
101
"""Open a branch which may be of an old format."""
102
return Branch.open(base, _unsupported=True)
105
def open(base, _unsupported=False):
106
"""Open the repository rooted at base.
108
For instance, if the repository is at URL/.bzr/repository,
109
Repository.open(URL) -> a Repository instance.
111
control = bzrdir.BzrDir.open(base, _unsupported)
112
return control.open_branch(_unsupported)
115
def open_containing(url):
116
"""Open an existing branch which contains url.
118
This probes for a branch at url, and searches upwards from there.
120
Basically we keep looking up until we find the control directory or
121
run into the root. If there isn't one, raises NotBranchError.
122
If there is one and it is either an unrecognised format or an unsupported
123
format, UnknownFormatError or UnsupportedFormatError are raised.
124
If there is one, it is returned, along with the unused portion of url.
126
control, relpath = bzrdir.BzrDir.open_containing(url)
127
return control.open_branch(), relpath
130
@deprecated_function(zero_eight)
131
def initialize(base):
132
"""Create a new working tree and branch, rooted at 'base' (url)
134
NOTE: This will soon be deprecated in favour of creation
137
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
139
def setup_caching(self, cache_root):
140
"""Subclasses that care about caching should override this, and set
141
up cached stores located under cache_root.
143
# seems to be unused, 2006-01-13 mbp
144
warn('%s is deprecated' % self.setup_caching)
145
self.cache_root = cache_root
148
cfg = self.tree_config()
149
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
151
def _set_nick(self, nick):
152
cfg = self.tree_config()
153
cfg.set_option(nick, "nickname")
154
assert cfg.get_option("nickname") == nick
156
nick = property(_get_nick, _set_nick)
158
def lock_write(self):
159
raise NotImplementedError('lock_write is abstract')
162
raise NotImplementedError('lock_read is abstract')
165
raise NotImplementedError('unlock is abstract')
167
def peek_lock_mode(self):
168
"""Return lock mode for the Branch: 'r', 'w' or None"""
169
raise NotImplementedError(self.peek_lock_mode)
171
def abspath(self, name):
172
"""Return absolute filename for something in the branch
174
XXX: Robert Collins 20051017 what is this used for? why is it a branch
175
method and not a tree method.
177
raise NotImplementedError('abspath is abstract')
179
def bind(self, other):
180
"""Bind the local branch the other branch.
182
:param other: The branch to bind to
185
raise errors.UpgradeRequired(self.base)
188
def fetch(self, from_branch, last_revision=None, pb=None):
189
"""Copy revisions from from_branch into this branch.
191
:param from_branch: Where to copy from.
192
:param last_revision: What revision to stop at (None for at the end
194
:param pb: An optional progress bar to use.
196
Returns the copied revision count and the failed revisions in a tuple:
199
if self.base == from_branch.base:
202
nested_pb = bzrlib.ui.ui_factory.nested_progress_bar()
207
from_branch.lock_read()
209
if last_revision is None:
210
pb.update('get source history')
211
from_history = from_branch.revision_history()
213
last_revision = from_history[-1]
215
# no history in the source branch
216
last_revision = NULL_REVISION
217
return self.repository.fetch(from_branch.repository,
218
revision_id=last_revision,
221
if nested_pb is not None:
225
def get_bound_location(self):
226
"""Return the URL of the branch we are bound to.
228
Older format branches cannot bind, please be sure to use a metadir
233
def get_master_branch(self):
234
"""Return the branch we are bound to.
236
:return: Either a Branch, or None
240
def get_root_id(self):
241
"""Return the id of this branches root"""
242
raise NotImplementedError('get_root_id is abstract')
244
def print_file(self, file, revision_id):
245
"""Print `file` to stdout."""
246
raise NotImplementedError('print_file is abstract')
248
def append_revision(self, *revision_ids):
249
raise NotImplementedError('append_revision is abstract')
251
def set_revision_history(self, rev_history):
252
raise NotImplementedError('set_revision_history is abstract')
254
def revision_history(self):
255
"""Return sequence of revision hashes on to this branch."""
256
raise NotImplementedError('revision_history is abstract')
259
"""Return current revision number for this branch.
261
That is equivalent to the number of revisions committed to
264
return len(self.revision_history())
267
"""Older format branches cannot bind or unbind."""
268
raise errors.UpgradeRequired(self.base)
270
def last_revision(self):
271
"""Return last patch hash, or None if no history."""
272
ph = self.revision_history()
278
def missing_revisions(self, other, stop_revision=None):
279
"""Return a list of new revisions that would perfectly fit.
281
If self and other have not diverged, return a list of the revisions
282
present in other, but missing from self.
284
>>> from bzrlib.workingtree import WorkingTree
285
>>> bzrlib.trace.silent = True
286
>>> d1 = bzrdir.ScratchDir()
287
>>> br1 = d1.open_branch()
288
>>> wt1 = d1.open_workingtree()
289
>>> d2 = bzrdir.ScratchDir()
290
>>> br2 = d2.open_branch()
291
>>> wt2 = d2.open_workingtree()
292
>>> br1.missing_revisions(br2)
294
>>> wt2.commit("lala!", rev_id="REVISION-ID-1")
295
>>> br1.missing_revisions(br2)
297
>>> br2.missing_revisions(br1)
299
>>> wt1.commit("lala!", rev_id="REVISION-ID-1")
300
>>> br1.missing_revisions(br2)
302
>>> wt2.commit("lala!", rev_id="REVISION-ID-2A")
303
>>> br1.missing_revisions(br2)
305
>>> wt1.commit("lala!", rev_id="REVISION-ID-2B")
306
>>> br1.missing_revisions(br2)
307
Traceback (most recent call last):
308
DivergedBranches: These branches have diverged. Try merge.
310
self_history = self.revision_history()
311
self_len = len(self_history)
312
other_history = other.revision_history()
313
other_len = len(other_history)
314
common_index = min(self_len, other_len) -1
315
if common_index >= 0 and \
316
self_history[common_index] != other_history[common_index]:
317
raise DivergedBranches(self, other)
319
if stop_revision is None:
320
stop_revision = other_len
322
assert isinstance(stop_revision, int)
323
if stop_revision > other_len:
324
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
325
return other_history[self_len:stop_revision]
327
def update_revisions(self, other, stop_revision=None):
328
"""Pull in new perfect-fit revisions.
330
:param other: Another Branch to pull from
331
:param stop_revision: Updated until the given revision
334
raise NotImplementedError('update_revisions is abstract')
336
def pullable_revisions(self, other, stop_revision):
337
raise NotImplementedError('pullable_revisions is abstract')
339
def revision_id_to_revno(self, revision_id):
340
"""Given a revision id, return its revno"""
341
if revision_id is None:
343
history = self.revision_history()
345
return history.index(revision_id) + 1
347
raise bzrlib.errors.NoSuchRevision(self, revision_id)
349
def get_rev_id(self, revno, history=None):
350
"""Find the revision id of the specified revno."""
354
history = self.revision_history()
355
elif revno <= 0 or revno > len(history):
356
raise bzrlib.errors.NoSuchRevision(self, revno)
357
return history[revno - 1]
359
def pull(self, source, overwrite=False, stop_revision=None):
360
raise NotImplementedError('pull is abstract')
362
def basis_tree(self):
363
"""Return `Tree` object for last revision.
365
If there are no revisions yet, return an `EmptyTree`.
367
return self.repository.revision_tree(self.last_revision())
369
def rename_one(self, from_rel, to_rel):
372
This can change the directory or the filename or both.
374
raise NotImplementedError('rename_one is abstract')
376
def move(self, from_paths, to_name):
379
to_name must exist as a versioned directory.
381
If to_name exists and is a directory, the files are moved into
382
it, keeping their old names. If it is a directory,
384
Note that to_name is only the last component of the new name;
385
this doesn't change the directory.
387
This returns a list of (from_path, to_path) pairs for each
390
raise NotImplementedError('move is abstract')
392
def get_parent(self):
393
"""Return the parent location of the branch.
395
This is the default location for push/pull/missing. The usual
396
pattern is that the user can override it by specifying a
399
raise NotImplementedError('get_parent is abstract')
401
def get_push_location(self):
402
"""Return the None or the location to push this branch to."""
403
raise NotImplementedError('get_push_location is abstract')
405
def set_push_location(self, location):
406
"""Set a new push location for this branch."""
407
raise NotImplementedError('set_push_location is abstract')
409
def set_parent(self, url):
410
raise NotImplementedError('set_parent is abstract')
414
"""Synchronise this branch with the master branch if any.
416
:return: None or the last_revision pivoted out during the update.
420
def check_revno(self, revno):
422
Check whether a revno corresponds to any revision.
423
Zero (the NULL revision) is considered valid.
426
self.check_real_revno(revno)
428
def check_real_revno(self, revno):
430
Check whether a revno corresponds to a real revision.
431
Zero (the NULL revision) is considered invalid
433
if revno < 1 or revno > self.revno():
434
raise InvalidRevisionNumber(revno)
437
def clone(self, *args, **kwargs):
438
"""Clone this branch into to_bzrdir preserving all semantic values.
440
revision_id: if not None, the revision history in the new branch will
441
be truncated to end with revision_id.
443
# for API compatability, until 0.8 releases we provide the old api:
444
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
445
# after 0.8 releases, the *args and **kwargs should be changed:
446
# def clone(self, to_bzrdir, revision_id=None):
447
if (kwargs.get('to_location', None) or
448
kwargs.get('revision', None) or
449
kwargs.get('basis_branch', None) or
450
(len(args) and isinstance(args[0], basestring))):
451
# backwards compatability api:
452
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
453
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
456
basis_branch = args[2]
458
basis_branch = kwargs.get('basis_branch', None)
460
basis = basis_branch.bzrdir
465
revision_id = args[1]
467
revision_id = kwargs.get('revision', None)
472
# no default to raise if not provided.
473
url = kwargs.get('to_location')
474
return self.bzrdir.clone(url,
475
revision_id=revision_id,
476
basis=basis).open_branch()
478
# generate args by hand
480
revision_id = args[1]
482
revision_id = kwargs.get('revision_id', None)
486
# no default to raise if not provided.
487
to_bzrdir = kwargs.get('to_bzrdir')
488
result = self._format.initialize(to_bzrdir)
489
self.copy_content_into(result, revision_id=revision_id)
493
def sprout(self, to_bzrdir, revision_id=None):
494
"""Create a new line of development from the branch, into to_bzrdir.
496
revision_id: if not None, the revision history in the new branch will
497
be truncated to end with revision_id.
499
result = self._format.initialize(to_bzrdir)
500
self.copy_content_into(result, revision_id=revision_id)
501
result.set_parent(self.bzrdir.root_transport.base)
505
def copy_content_into(self, destination, revision_id=None):
506
"""Copy the content of self into destination.
508
revision_id: if not None, the revision history in the new branch will
509
be truncated to end with revision_id.
511
new_history = self.revision_history()
512
if revision_id is not None:
514
new_history = new_history[:new_history.index(revision_id) + 1]
516
rev = self.repository.get_revision(revision_id)
517
new_history = rev.get_history(self.repository)[1:]
518
destination.set_revision_history(new_history)
519
parent = self.get_parent()
521
destination.set_parent(parent)
524
class BranchFormat(object):
525
"""An encapsulation of the initialization and open routines for a format.
527
Formats provide three things:
528
* An initialization routine,
532
Formats are placed in an dict by their format string for reference
533
during branch opening. Its not required that these be instances, they
534
can be classes themselves with class methods - it simply depends on
535
whether state is needed for a given format or not.
537
Once a format is deprecated, just deprecate the initialize and open
538
methods on the format class. Do not deprecate the object, as the
539
object will be created every time regardless.
542
_default_format = None
543
"""The default format used for new branches."""
546
"""The known formats."""
549
def find_format(klass, a_bzrdir):
550
"""Return the format for the branch object in a_bzrdir."""
552
transport = a_bzrdir.get_branch_transport(None)
553
format_string = transport.get("format").read()
554
return klass._formats[format_string]
556
raise NotBranchError(path=transport.base)
558
raise errors.UnknownFormatError(format_string)
561
def get_default_format(klass):
562
"""Return the current default format."""
563
return klass._default_format
565
def get_format_string(self):
566
"""Return the ASCII format string that identifies this format."""
567
raise NotImplementedError(self.get_format_string)
569
def get_format_description(self):
570
"""Return the short format description for this format."""
571
raise NotImplementedError(self.get_format_string)
573
def initialize(self, a_bzrdir):
574
"""Create a branch of this format in a_bzrdir."""
575
raise NotImplementedError(self.initialized)
577
def is_supported(self):
578
"""Is this format supported?
580
Supported formats can be initialized and opened.
581
Unsupported formats may not support initialization or committing or
582
some other features depending on the reason for not being supported.
586
def open(self, a_bzrdir, _found=False):
587
"""Return the branch object for a_bzrdir
589
_found is a private parameter, do not use it. It is used to indicate
590
if format probing has already be done.
592
raise NotImplementedError(self.open)
595
def register_format(klass, format):
596
klass._formats[format.get_format_string()] = format
599
def set_default_format(klass, format):
600
klass._default_format = format
603
def unregister_format(klass, format):
604
assert klass._formats[format.get_format_string()] is format
605
del klass._formats[format.get_format_string()]
608
return self.get_format_string().rstrip()
611
class BzrBranchFormat4(BranchFormat):
612
"""Bzr branch format 4.
615
- a revision-history file.
616
- a branch-lock lock file [ to be shared with the bzrdir ]
619
def get_format_description(self):
620
"""See BranchFormat.get_format_description()."""
621
return "Branch format 4"
623
def initialize(self, a_bzrdir):
624
"""Create a branch of this format in a_bzrdir."""
625
mutter('creating branch in %s', a_bzrdir.transport.base)
626
branch_transport = a_bzrdir.get_branch_transport(self)
627
utf8_files = [('revision-history', ''),
630
control_files = LockableFiles(branch_transport, 'branch-lock',
632
control_files.create_lock()
633
control_files.lock_write()
635
for file, content in utf8_files:
636
control_files.put_utf8(file, content)
638
control_files.unlock()
639
return self.open(a_bzrdir, _found=True)
642
super(BzrBranchFormat4, self).__init__()
643
self._matchingbzrdir = bzrdir.BzrDirFormat6()
645
def open(self, a_bzrdir, _found=False):
646
"""Return the branch object for a_bzrdir
648
_found is a private parameter, do not use it. It is used to indicate
649
if format probing has already be done.
652
# we are being called directly and must probe.
653
raise NotImplementedError
654
return BzrBranch(_format=self,
655
_control_files=a_bzrdir._control_files,
657
_repository=a_bzrdir.open_repository())
660
return "Bazaar-NG branch format 4"
663
class BzrBranchFormat5(BranchFormat):
664
"""Bzr branch format 5.
667
- a revision-history file.
669
- a lock dir guarding the branch itself
670
- all of this stored in a branch/ subdirectory
671
- works with shared repositories.
673
This format is new in bzr 0.8.
676
def get_format_string(self):
677
"""See BranchFormat.get_format_string()."""
678
return "Bazaar-NG branch format 5\n"
680
def get_format_description(self):
681
"""See BranchFormat.get_format_description()."""
682
return "Branch format 5"
684
def initialize(self, a_bzrdir):
685
"""Create a branch of this format in a_bzrdir."""
686
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
687
branch_transport = a_bzrdir.get_branch_transport(self)
688
utf8_files = [('revision-history', ''),
691
control_files = LockableFiles(branch_transport, 'lock', LockDir)
692
control_files.create_lock()
693
control_files.lock_write()
694
control_files.put_utf8('format', self.get_format_string())
696
for file, content in utf8_files:
697
control_files.put_utf8(file, content)
699
control_files.unlock()
700
return self.open(a_bzrdir, _found=True, )
703
super(BzrBranchFormat5, self).__init__()
704
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
706
def open(self, a_bzrdir, _found=False):
707
"""Return the branch object for a_bzrdir
709
_found is a private parameter, do not use it. It is used to indicate
710
if format probing has already be done.
713
format = BranchFormat.find_format(a_bzrdir)
714
assert format.__class__ == self.__class__
715
transport = a_bzrdir.get_branch_transport(None)
716
control_files = LockableFiles(transport, 'lock', LockDir)
717
return BzrBranch5(_format=self,
718
_control_files=control_files,
720
_repository=a_bzrdir.find_repository())
723
return "Bazaar-NG Metadir branch format 5"
726
class BranchReferenceFormat(BranchFormat):
727
"""Bzr branch reference format.
729
Branch references are used in implementing checkouts, they
730
act as an alias to the real branch which is at some other url.
737
def get_format_string(self):
738
"""See BranchFormat.get_format_string()."""
739
return "Bazaar-NG Branch Reference Format 1\n"
741
def get_format_description(self):
742
"""See BranchFormat.get_format_description()."""
743
return "Checkout reference format 1"
745
def initialize(self, a_bzrdir, target_branch=None):
746
"""Create a branch of this format in a_bzrdir."""
747
if target_branch is None:
748
# this format does not implement branch itself, thus the implicit
749
# creation contract must see it as uninitializable
750
raise errors.UninitializableFormat(self)
751
mutter('creating branch reference in %s', a_bzrdir.transport.base)
752
branch_transport = a_bzrdir.get_branch_transport(self)
753
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
754
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
755
branch_transport.put('format', StringIO(self.get_format_string()))
756
return self.open(a_bzrdir, _found=True)
759
super(BranchReferenceFormat, self).__init__()
760
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
762
def _make_reference_clone_function(format, a_branch):
763
"""Create a clone() routine for a branch dynamically."""
764
def clone(to_bzrdir, revision_id=None):
765
"""See Branch.clone()."""
766
return format.initialize(to_bzrdir, a_branch)
767
# cannot obey revision_id limits when cloning a reference ...
768
# FIXME RBC 20060210 either nuke revision_id for clone, or
769
# emit some sort of warning/error to the caller ?!
772
def open(self, a_bzrdir, _found=False):
773
"""Return the branch that the branch reference in a_bzrdir points at.
775
_found is a private parameter, do not use it. It is used to indicate
776
if format probing has already be done.
779
format = BranchFormat.find_format(a_bzrdir)
780
assert format.__class__ == self.__class__
781
transport = a_bzrdir.get_branch_transport(None)
782
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
783
result = real_bzrdir.open_branch()
784
# this changes the behaviour of result.clone to create a new reference
785
# rather than a copy of the content of the branch.
786
# I did not use a proxy object because that needs much more extensive
787
# testing, and we are only changing one behaviour at the moment.
788
# If we decide to alter more behaviours - i.e. the implicit nickname
789
# then this should be refactored to introduce a tested proxy branch
790
# and a subclass of that for use in overriding clone() and ....
792
result.clone = self._make_reference_clone_function(result)
796
# formats which have no format string are not discoverable
797
# and not independently creatable, so are not registered.
798
__default_format = BzrBranchFormat5()
799
BranchFormat.register_format(__default_format)
800
BranchFormat.register_format(BranchReferenceFormat())
801
BranchFormat.set_default_format(__default_format)
802
_legacy_formats = [BzrBranchFormat4(),
805
class BzrBranch(Branch):
806
"""A branch stored in the actual filesystem.
808
Note that it's "local" in the context of the filesystem; it doesn't
809
really matter if it's on an nfs/smb/afs/coda/... share, as long as
810
it's writable, and can be accessed via the normal filesystem API.
813
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
814
relax_version_check=DEPRECATED_PARAMETER, _format=None,
815
_control_files=None, a_bzrdir=None, _repository=None):
816
"""Create new branch object at a particular location.
818
transport -- A Transport object, defining how to access files.
820
init -- If True, create new control files in a previously
821
unversioned directory. If False, the branch must already
824
relax_version_check -- If true, the usual check for the branch
825
version is not applied. This is intended only for
826
upgrade/recovery type use; it's not guaranteed that
827
all operations will work on old format branches.
830
self.bzrdir = bzrdir.BzrDir.open(transport.base)
832
self.bzrdir = a_bzrdir
833
self._transport = self.bzrdir.transport.clone('..')
834
self._base = self._transport.base
835
self._format = _format
836
if _control_files is None:
837
raise BzrBadParameterMissing('_control_files')
838
self.control_files = _control_files
839
if deprecated_passed(init):
840
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
841
"deprecated as of bzr 0.8. Please use Branch.create().",
845
# this is slower than before deprecation, oh well never mind.
847
self._initialize(transport.base)
848
self._check_format(_format)
849
if deprecated_passed(relax_version_check):
850
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
851
"relax_version_check parameter is deprecated as of bzr 0.8. "
852
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
856
if (not relax_version_check
857
and not self._format.is_supported()):
858
raise errors.UnsupportedFormatError(
859
'sorry, branch format %r not supported' % fmt,
860
['use a different bzr version',
861
'or remove the .bzr directory'
862
' and "bzr init" again'])
863
if deprecated_passed(transport):
864
warn("BzrBranch.__init__(transport=XXX...): The transport "
865
"parameter is deprecated as of bzr 0.8. "
866
"Please use Branch.open, or bzrdir.open_branch().",
869
self.repository = _repository
872
return '%s(%r)' % (self.__class__.__name__, self.base)
877
# TODO: It might be best to do this somewhere else,
878
# but it is nice for a Branch object to automatically
879
# cache it's information.
880
# Alternatively, we could have the Transport objects cache requests
881
# See the earlier discussion about how major objects (like Branch)
882
# should never expect their __del__ function to run.
883
# XXX: cache_root seems to be unused, 2006-01-13 mbp
884
if hasattr(self, 'cache_root') and self.cache_root is not None:
886
shutil.rmtree(self.cache_root)
889
self.cache_root = None
894
base = property(_get_base, doc="The URL for the root of this branch.")
896
def _finish_transaction(self):
897
"""Exit the current transaction."""
898
return self.control_files._finish_transaction()
900
def get_transaction(self):
901
"""Return the current active transaction.
903
If no transaction is active, this returns a passthrough object
904
for which all data is immediately flushed and no caching happens.
906
# this is an explicit function so that we can do tricky stuff
907
# when the storage in rev_storage is elsewhere.
908
# we probably need to hook the two 'lock a location' and
909
# 'have a transaction' together more delicately, so that
910
# we can have two locks (branch and storage) and one transaction
911
# ... and finishing the transaction unlocks both, but unlocking
912
# does not. - RBC 20051121
913
return self.control_files.get_transaction()
915
def _set_transaction(self, transaction):
916
"""Set a new active transaction."""
917
return self.control_files._set_transaction(transaction)
919
def abspath(self, name):
920
"""See Branch.abspath."""
921
return self.control_files._transport.abspath(name)
923
def _check_format(self, format):
924
"""Identify the branch format if needed.
926
The format is stored as a reference to the format object in
927
self._format for code that needs to check it later.
929
The format parameter is either None or the branch format class
930
used to open this branch.
932
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
935
format = BzrBranchFormat.find_format(self.bzrdir)
936
self._format = format
937
mutter("got branch format %s", self._format)
940
def get_root_id(self):
941
"""See Branch.get_root_id."""
942
tree = self.repository.revision_tree(self.last_revision())
943
return tree.inventory.root.file_id
945
def lock_write(self):
946
# TODO: test for failed two phase locks. This is known broken.
947
self.control_files.lock_write()
948
self.repository.lock_write()
951
# TODO: test for failed two phase locks. This is known broken.
952
self.control_files.lock_read()
953
self.repository.lock_read()
956
# TODO: test for failed two phase locks. This is known broken.
957
self.repository.unlock()
958
self.control_files.unlock()
960
def peek_lock_mode(self):
961
if self.control_files._lock_count == 0:
964
return self.control_files._lock_mode
967
def print_file(self, file, revision_id):
968
"""See Branch.print_file."""
969
return self.repository.print_file(file, revision_id)
972
def append_revision(self, *revision_ids):
973
"""See Branch.append_revision."""
974
for revision_id in revision_ids:
975
mutter("add {%s} to revision-history" % revision_id)
976
rev_history = self.revision_history()
977
rev_history.extend(revision_ids)
978
self.set_revision_history(rev_history)
981
def set_revision_history(self, rev_history):
982
"""See Branch.set_revision_history."""
983
self.control_files.put_utf8(
984
'revision-history', '\n'.join(rev_history))
985
transaction = self.get_transaction()
986
history = transaction.map.find_revision_history()
987
if history is not None:
988
# update the revision history in the identity map.
989
history[:] = list(rev_history)
990
# this call is disabled because revision_history is
991
# not really an object yet, and the transaction is for objects.
992
# transaction.register_dirty(history)
994
transaction.map.add_revision_history(rev_history)
995
# this call is disabled because revision_history is
996
# not really an object yet, and the transaction is for objects.
997
# transaction.register_clean(history)
999
def get_revision_delta(self, revno):
1000
"""Return the delta for one revision.
1002
The delta is relative to its mainline predecessor, or the
1003
empty tree for revision 1.
1005
assert isinstance(revno, int)
1006
rh = self.revision_history()
1007
if not (1 <= revno <= len(rh)):
1008
raise InvalidRevisionNumber(revno)
1010
# revno is 1-based; list is 0-based
1012
new_tree = self.repository.revision_tree(rh[revno-1])
1014
old_tree = EmptyTree()
1016
old_tree = self.repository.revision_tree(rh[revno-2])
1017
return compare_trees(old_tree, new_tree)
1020
def revision_history(self):
1021
"""See Branch.revision_history."""
1022
transaction = self.get_transaction()
1023
history = transaction.map.find_revision_history()
1024
if history is not None:
1025
mutter("cache hit for revision-history in %s", self)
1026
return list(history)
1027
history = [l.rstrip('\r\n') for l in
1028
self.control_files.get_utf8('revision-history').readlines()]
1029
transaction.map.add_revision_history(history)
1030
# this call is disabled because revision_history is
1031
# not really an object yet, and the transaction is for objects.
1032
# transaction.register_clean(history, precious=True)
1033
return list(history)
1035
def update_revisions(self, other, stop_revision=None):
1036
"""See Branch.update_revisions."""
1037
if stop_revision is None:
1038
stop_revision = other.last_revision()
1039
### Should this be checking is_ancestor instead of revision_history?
1040
if (stop_revision is not None and
1041
stop_revision in self.revision_history()):
1043
self.fetch(other, stop_revision)
1044
pullable_revs = self.pullable_revisions(other, stop_revision)
1045
if len(pullable_revs) > 0:
1046
self.append_revision(*pullable_revs)
1048
def pullable_revisions(self, other, stop_revision):
1049
other_revno = other.revision_id_to_revno(stop_revision)
1051
return self.missing_revisions(other, other_revno)
1052
except DivergedBranches, e:
1054
pullable_revs = get_intervening_revisions(self.last_revision(),
1057
assert self.last_revision() not in pullable_revs
1058
return pullable_revs
1059
except bzrlib.errors.NotAncestor:
1060
if is_ancestor(self.last_revision(), stop_revision, self):
1065
def basis_tree(self):
1066
"""See Branch.basis_tree."""
1067
return self.repository.revision_tree(self.last_revision())
1069
@deprecated_method(zero_eight)
1070
def working_tree(self):
1071
"""Create a Working tree object for this branch."""
1072
from bzrlib.workingtree import WorkingTree
1073
from bzrlib.transport.local import LocalTransport
1074
if (self.base.find('://') != -1 or
1075
not isinstance(self._transport, LocalTransport)):
1076
raise NoWorkingTree(self.base)
1077
return self.bzrdir.open_workingtree()
1080
def pull(self, source, overwrite=False, stop_revision=None):
1081
"""See Branch.pull."""
1084
old_count = len(self.revision_history())
1086
self.update_revisions(source,stop_revision)
1087
except DivergedBranches:
1091
self.set_revision_history(source.revision_history())
1092
new_count = len(self.revision_history())
1093
return new_count - old_count
1097
def get_parent(self):
1098
"""See Branch.get_parent."""
1100
_locs = ['parent', 'pull', 'x-pull']
1103
return self.control_files.get_utf8(l).read().strip('\n')
1108
def get_push_location(self):
1109
"""See Branch.get_push_location."""
1110
config = bzrlib.config.BranchConfig(self)
1111
push_loc = config.get_user_option('push_location')
1114
def set_push_location(self, location):
1115
"""See Branch.set_push_location."""
1116
config = bzrlib.config.LocationConfig(self.base)
1117
config.set_user_option('push_location', location)
1120
def set_parent(self, url):
1121
"""See Branch.set_parent."""
1122
# TODO: Maybe delete old location files?
1123
# URLs should never be unicode, even on the local fs,
1124
# FIXUP this and get_parent in a future branch format bump:
1125
# read and rewrite the file, and have the new format code read
1126
# using .get not .get_utf8. RBC 20060125
1127
self.control_files.put_utf8('parent', url + '\n')
1129
def tree_config(self):
1130
return TreeConfig(self)
1133
class BzrBranch5(BzrBranch):
1134
"""A format 5 branch. This supports new features over plan branches.
1136
It has support for a master_branch which is the data for bound branches.
1144
super(BzrBranch5, self).__init__(_format=_format,
1145
_control_files=_control_files,
1147
_repository=_repository)
1150
def pull(self, source, overwrite=False, stop_revision=None):
1151
"""Updates branch.pull to be bound branch aware."""
1152
bound_location = self.get_bound_location()
1153
if source.base != bound_location:
1154
# not pulling from master, so we need to update master.
1155
master_branch = self.get_master_branch()
1157
master_branch.pull(source)
1158
source = master_branch
1159
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1161
def get_bound_location(self):
1163
return self.control_files.get_utf8('bound').read()[:-1]
1164
except errors.NoSuchFile:
1168
def get_master_branch(self):
1169
"""Return the branch we are bound to.
1171
:return: Either a Branch, or None
1173
This could memoise the branch, but if thats done
1174
it must be revalidated on each new lock.
1175
So for now we just dont memoise it.
1176
# RBC 20060304 review this decision.
1178
bound_loc = self.get_bound_location()
1182
return Branch.open(bound_loc)
1183
except (errors.NotBranchError, errors.ConnectionError), e:
1184
raise errors.BoundBranchConnectionFailure(
1188
def set_bound_location(self, location):
1189
"""Set the target where this branch is bound to.
1191
:param location: URL to the target branch
1194
self.control_files.put_utf8('bound', location+'\n')
1197
self.control_files._transport.delete('bound')
1203
def bind(self, other):
1204
"""Bind the local branch the other branch.
1206
:param other: The branch to bind to
1209
# TODO: jam 20051230 Consider checking if the target is bound
1210
# It is debatable whether you should be able to bind to
1211
# a branch which is itself bound.
1212
# Committing is obviously forbidden,
1213
# but binding itself may not be.
1214
# Since we *have* to check at commit time, we don't
1215
# *need* to check here
1218
# we are now equal to or a suffix of other.
1220
# Since we have 'pulled' from the remote location,
1221
# now we should try to pull in the opposite direction
1222
# in case the local tree has more revisions than the
1224
# There may be a different check you could do here
1225
# rather than actually trying to install revisions remotely.
1226
# TODO: capture an exception which indicates the remote branch
1228
# If it is up-to-date, this probably should not be a failure
1230
# lock other for write so the revision-history syncing cannot race
1234
# if this does not error, other now has the same last rev we do
1235
# it can only error if the pull from other was concurrent with
1236
# a commit to other from someone else.
1238
# until we ditch revision-history, we need to sync them up:
1239
self.set_revision_history(other.revision_history())
1240
# now other and self are up to date with each other and have the
1241
# same revision-history.
1245
self.set_bound_location(other.base)
1249
"""If bound, unbind"""
1250
return self.set_bound_location(None)
1254
"""Synchronise this branch with the master branch if any.
1256
:return: None or the last_revision that was pivoted out during the
1259
master = self.get_master_branch()
1260
if master is not None:
1261
old_tip = self.last_revision()
1262
self.pull(master, overwrite=True)
1263
if old_tip in self.repository.get_ancestry(self.last_revision()):
1269
class BranchTestProviderAdapter(object):
1270
"""A tool to generate a suite testing multiple branch formats at once.
1272
This is done by copying the test once for each transport and injecting
1273
the transport_server, transport_readonly_server, and branch_format
1274
classes into each copy. Each copy is also given a new id() to make it
1278
def __init__(self, transport_server, transport_readonly_server, formats):
1279
self._transport_server = transport_server
1280
self._transport_readonly_server = transport_readonly_server
1281
self._formats = formats
1283
def adapt(self, test):
1284
result = TestSuite()
1285
for branch_format, bzrdir_format in self._formats:
1286
new_test = deepcopy(test)
1287
new_test.transport_server = self._transport_server
1288
new_test.transport_readonly_server = self._transport_readonly_server
1289
new_test.bzrdir_format = bzrdir_format
1290
new_test.branch_format = branch_format
1291
def make_new_test_id():
1292
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1293
return lambda: new_id
1294
new_test.id = make_new_test_id()
1295
result.addTest(new_test)
1299
######################################################################
1303
@deprecated_function(zero_eight)
1304
def ScratchBranch(*args, **kwargs):
1305
"""See bzrlib.bzrdir.ScratchDir."""
1306
d = ScratchDir(*args, **kwargs)
1307
return d.open_branch()
1310
@deprecated_function(zero_eight)
1311
def is_control_file(*args, **kwargs):
1312
"""See bzrlib.workingtree.is_control_file."""
1313
return bzrlib.workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
