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.osutils import (isdir, quotefn,
44
rename, splitpath, sha_file,
45
file_kind, abspath, normpath, pathjoin,
48
from bzrlib.textui import show_status
49
from bzrlib.trace import mutter, note
50
from bzrlib.tree import EmptyTree, RevisionTree
51
from bzrlib.repository import Repository
52
from bzrlib.revision import (
53
get_intervening_revisions,
58
from bzrlib.store import copy_all
59
from bzrlib.symbol_versioning import *
60
import bzrlib.transactions as transactions
61
from bzrlib.transport import Transport, get_transport
62
from bzrlib.tree import EmptyTree, RevisionTree
67
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
68
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
69
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
72
# TODO: Maybe include checks for common corruption of newlines, etc?
74
# TODO: Some operations like log might retrieve the same revisions
75
# repeatedly to calculate deltas. We could perhaps have a weakref
76
# cache in memory to make this faster. In general anything can be
77
# cached in memory between lock and unlock operations. .. nb thats
78
# what the transaction identity map provides
81
######################################################################
85
"""Branch holding a history of revisions.
88
Base directory/url of the branch.
90
# this is really an instance variable - FIXME move it there
94
def __init__(self, *ignored, **ignored_too):
95
raise NotImplementedError('The Branch class is abstract')
98
@deprecated_method(zero_eight)
99
def open_downlevel(base):
100
"""Open a branch which may be of an old format."""
101
return Branch.open(base, _unsupported=True)
104
def open(base, _unsupported=False):
105
"""Open the repository rooted at base.
107
For instance, if the repository is at URL/.bzr/repository,
108
Repository.open(URL) -> a Repository instance.
110
control = bzrdir.BzrDir.open(base, _unsupported)
111
return control.open_branch(_unsupported)
114
def open_containing(url):
115
"""Open an existing branch which contains url.
117
This probes for a branch at url, and searches upwards from there.
119
Basically we keep looking up until we find the control directory or
120
run into the root. If there isn't one, raises NotBranchError.
121
If there is one and it is either an unrecognised format or an unsupported
122
format, UnknownFormatError or UnsupportedFormatError are raised.
123
If there is one, it is returned, along with the unused portion of url.
125
control, relpath = bzrdir.BzrDir.open_containing(url)
126
return control.open_branch(), relpath
129
@deprecated_function(zero_eight)
130
def initialize(base):
131
"""Create a new working tree and branch, rooted at 'base' (url)
133
NOTE: This will soon be deprecated in favour of creation
136
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
138
def setup_caching(self, cache_root):
139
"""Subclasses that care about caching should override this, and set
140
up cached stores located under cache_root.
142
# seems to be unused, 2006-01-13 mbp
143
warn('%s is deprecated' % self.setup_caching)
144
self.cache_root = cache_root
147
cfg = self.tree_config()
148
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
150
def _set_nick(self, nick):
151
cfg = self.tree_config()
152
cfg.set_option(nick, "nickname")
153
assert cfg.get_option("nickname") == nick
155
nick = property(_get_nick, _set_nick)
157
def lock_write(self):
158
raise NotImplementedError('lock_write is abstract')
161
raise NotImplementedError('lock_read is abstract')
164
raise NotImplementedError('unlock is abstract')
166
def peek_lock_mode(self):
167
"""Return lock mode for the Branch: 'r', 'w' or None"""
168
raise NotImplementedError(self.peek_lock_mode)
170
def abspath(self, name):
171
"""Return absolute filename for something in the branch
173
XXX: Robert Collins 20051017 what is this used for? why is it a branch
174
method and not a tree method.
176
raise NotImplementedError('abspath is abstract')
178
def bind(self, other):
179
"""Bind the local branch the other branch.
181
:param other: The branch to bind to
184
raise errors.UpgradeRequired(self.base)
187
def fetch(self, from_branch, last_revision=None, pb=None):
188
"""Copy revisions from from_branch into this branch.
190
:param from_branch: Where to copy from.
191
:param last_revision: What revision to stop at (None for at the end
193
:param pb: An optional progress bar to use.
195
Returns the copied revision count and the failed revisions in a tuple:
198
if self.base == from_branch.base:
199
raise Exception("can't fetch from a branch to itself %s, %s" %
200
(self.base, to_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 rbanch 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 initialize(self, a_bzrdir):
570
"""Create a branch of this format in a_bzrdir."""
571
raise NotImplementedError(self.initialized)
573
def is_supported(self):
574
"""Is this format supported?
576
Supported formats can be initialized and opened.
577
Unsupported formats may not support initialization or committing or
578
some other features depending on the reason for not being supported.
582
def open(self, a_bzrdir, _found=False):
583
"""Return the branch object for a_bzrdir
585
_found is a private parameter, do not use it. It is used to indicate
586
if format probing has already be done.
588
raise NotImplementedError(self.open)
591
def register_format(klass, format):
592
klass._formats[format.get_format_string()] = format
595
def set_default_format(klass, format):
596
klass._default_format = format
599
def unregister_format(klass, format):
600
assert klass._formats[format.get_format_string()] is format
601
del klass._formats[format.get_format_string()]
604
class BzrBranchFormat4(BranchFormat):
605
"""Bzr branch format 4.
608
- a revision-history file.
609
- a branch-lock lock file [ to be shared with the bzrdir ]
612
def initialize(self, a_bzrdir):
613
"""Create a branch of this format in a_bzrdir."""
614
mutter('creating branch in %s', a_bzrdir.transport.base)
615
branch_transport = a_bzrdir.get_branch_transport(self)
616
utf8_files = [('revision-history', ''),
619
control_files = LockableFiles(branch_transport, 'branch-lock',
621
control_files.create_lock()
622
control_files.lock_write()
624
for file, content in utf8_files:
625
control_files.put_utf8(file, content)
627
control_files.unlock()
628
return self.open(a_bzrdir, _found=True)
631
super(BzrBranchFormat4, self).__init__()
632
self._matchingbzrdir = bzrdir.BzrDirFormat6()
634
def open(self, a_bzrdir, _found=False):
635
"""Return the branch object for a_bzrdir
637
_found is a private parameter, do not use it. It is used to indicate
638
if format probing has already be done.
641
# we are being called directly and must probe.
642
raise NotImplementedError
643
return BzrBranch(_format=self,
644
_control_files=a_bzrdir._control_files,
646
_repository=a_bzrdir.open_repository())
649
class BzrBranchFormat5(BranchFormat):
650
"""Bzr branch format 5.
653
- a revision-history file.
656
- works with shared repositories.
659
def get_format_string(self):
660
"""See BranchFormat.get_format_string()."""
661
return "Bazaar-NG branch format 5\n"
663
def initialize(self, a_bzrdir):
664
"""Create a branch of this format in a_bzrdir."""
665
mutter('creating branch in %s', a_bzrdir.transport.base)
666
branch_transport = a_bzrdir.get_branch_transport(self)
668
utf8_files = [('revision-history', ''),
671
control_files = LockableFiles(branch_transport, 'lock', TransportLock)
672
control_files.create_lock()
673
control_files.lock_write()
674
control_files.put_utf8('format', self.get_format_string())
676
for file, content in utf8_files:
677
control_files.put_utf8(file, content)
679
control_files.unlock()
680
return self.open(a_bzrdir, _found=True, )
683
super(BzrBranchFormat5, self).__init__()
684
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
686
def open(self, a_bzrdir, _found=False):
687
"""Return the branch object for a_bzrdir
689
_found is a private parameter, do not use it. It is used to indicate
690
if format probing has already be done.
693
format = BranchFormat.find_format(a_bzrdir)
694
assert format.__class__ == self.__class__
695
transport = a_bzrdir.get_branch_transport(None)
696
control_files = LockableFiles(transport, 'lock', TransportLock)
697
return BzrBranch5(_format=self,
698
_control_files=control_files,
700
_repository=a_bzrdir.find_repository())
703
return "Bazaar-NG Metadir branch format 5"
706
class BranchReferenceFormat(BranchFormat):
707
"""Bzr branch reference format.
709
Branch references are used in implementing checkouts, they
710
act as an alias to the real branch which is at some other url.
717
def get_format_string(self):
718
"""See BranchFormat.get_format_string()."""
719
return "Bazaar-NG Branch Reference Format 1\n"
721
def initialize(self, a_bzrdir, target_branch=None):
722
"""Create a branch of this format in a_bzrdir."""
723
if target_branch is None:
724
# this format does not implement branch itself, thus the implicit
725
# creation contract must see it as uninitializable
726
raise errors.UninitializableFormat(self)
727
mutter('creating branch reference in %s', a_bzrdir.transport.base)
728
branch_transport = a_bzrdir.get_branch_transport(self)
729
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
730
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
731
branch_transport.put('format', StringIO(self.get_format_string()))
732
return self.open(a_bzrdir, _found=True)
735
super(BranchReferenceFormat, self).__init__()
736
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
738
def _make_reference_clone_function(format, a_branch):
739
"""Create a clone() routine for a branch dynamically."""
740
def clone(to_bzrdir, revision_id=None):
741
"""See Branch.clone()."""
742
return format.initialize(to_bzrdir, a_branch)
743
# cannot obey revision_id limits when cloning a reference ...
744
# FIXME RBC 20060210 either nuke revision_id for clone, or
745
# emit some sort of warning/error to the caller ?!
748
def open(self, a_bzrdir, _found=False):
749
"""Return the branch that the branch reference in a_bzrdir points at.
751
_found is a private parameter, do not use it. It is used to indicate
752
if format probing has already be done.
755
format = BranchFormat.find_format(a_bzrdir)
756
assert format.__class__ == self.__class__
757
transport = a_bzrdir.get_branch_transport(None)
758
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
759
result = real_bzrdir.open_branch()
760
# this changes the behaviour of result.clone to create a new reference
761
# rather than a copy of the content of the branch.
762
# I did not use a proxy object because that needs much more extensive
763
# testing, and we are only changing one behaviour at the moment.
764
# If we decide to alter more behaviours - i.e. the implicit nickname
765
# then this should be refactored to introduce a tested proxy branch
766
# and a subclass of that for use in overriding clone() and ....
768
result.clone = self._make_reference_clone_function(result)
772
# formats which have no format string are not discoverable
773
# and not independently creatable, so are not registered.
774
__default_format = BzrBranchFormat5()
775
BranchFormat.register_format(__default_format)
776
BranchFormat.register_format(BranchReferenceFormat())
777
BranchFormat.set_default_format(__default_format)
778
_legacy_formats = [BzrBranchFormat4(),
781
class BzrBranch(Branch):
782
"""A branch stored in the actual filesystem.
784
Note that it's "local" in the context of the filesystem; it doesn't
785
really matter if it's on an nfs/smb/afs/coda/... share, as long as
786
it's writable, and can be accessed via the normal filesystem API.
789
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
790
relax_version_check=DEPRECATED_PARAMETER, _format=None,
791
_control_files=None, a_bzrdir=None, _repository=None):
792
"""Create new branch object at a particular location.
794
transport -- A Transport object, defining how to access files.
796
init -- If True, create new control files in a previously
797
unversioned directory. If False, the branch must already
800
relax_version_check -- If true, the usual check for the branch
801
version is not applied. This is intended only for
802
upgrade/recovery type use; it's not guaranteed that
803
all operations will work on old format branches.
806
self.bzrdir = bzrdir.BzrDir.open(transport.base)
808
self.bzrdir = a_bzrdir
809
self._transport = self.bzrdir.transport.clone('..')
810
self._base = self._transport.base
811
self._format = _format
812
if _control_files is None:
813
raise BzrBadParameterMissing('_control_files')
814
self.control_files = _control_files
815
if deprecated_passed(init):
816
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
817
"deprecated as of bzr 0.8. Please use Branch.create().",
821
# this is slower than before deprecation, oh well never mind.
823
self._initialize(transport.base)
824
self._check_format(_format)
825
if deprecated_passed(relax_version_check):
826
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
827
"relax_version_check parameter is deprecated as of bzr 0.8. "
828
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
832
if (not relax_version_check
833
and not self._format.is_supported()):
834
raise errors.UnsupportedFormatError(
835
'sorry, branch format %r not supported' % fmt,
836
['use a different bzr version',
837
'or remove the .bzr directory'
838
' and "bzr init" again'])
839
if deprecated_passed(transport):
840
warn("BzrBranch.__init__(transport=XXX...): The transport "
841
"parameter is deprecated as of bzr 0.8. "
842
"Please use Branch.open, or bzrdir.open_branch().",
845
self.repository = _repository
848
return '%s(%r)' % (self.__class__.__name__, self.base)
853
# TODO: It might be best to do this somewhere else,
854
# but it is nice for a Branch object to automatically
855
# cache it's information.
856
# Alternatively, we could have the Transport objects cache requests
857
# See the earlier discussion about how major objects (like Branch)
858
# should never expect their __del__ function to run.
859
# XXX: cache_root seems to be unused, 2006-01-13 mbp
860
if hasattr(self, 'cache_root') and self.cache_root is not None:
862
shutil.rmtree(self.cache_root)
865
self.cache_root = None
870
base = property(_get_base, doc="The URL for the root of this branch.")
872
def _finish_transaction(self):
873
"""Exit the current transaction."""
874
return self.control_files._finish_transaction()
876
def get_transaction(self):
877
"""Return the current active transaction.
879
If no transaction is active, this returns a passthrough object
880
for which all data is immediately flushed and no caching happens.
882
# this is an explicit function so that we can do tricky stuff
883
# when the storage in rev_storage is elsewhere.
884
# we probably need to hook the two 'lock a location' and
885
# 'have a transaction' together more delicately, so that
886
# we can have two locks (branch and storage) and one transaction
887
# ... and finishing the transaction unlocks both, but unlocking
888
# does not. - RBC 20051121
889
return self.control_files.get_transaction()
891
def _set_transaction(self, transaction):
892
"""Set a new active transaction."""
893
return self.control_files._set_transaction(transaction)
895
def abspath(self, name):
896
"""See Branch.abspath."""
897
return self.control_files._transport.abspath(name)
899
def _check_format(self, format):
900
"""Identify the branch format if needed.
902
The format is stored as a reference to the format object in
903
self._format for code that needs to check it later.
905
The format parameter is either None or the branch format class
906
used to open this branch.
908
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
911
format = BzrBranchFormat.find_format(self.bzrdir)
912
self._format = format
913
mutter("got branch format %s", self._format)
916
def get_root_id(self):
917
"""See Branch.get_root_id."""
918
tree = self.repository.revision_tree(self.last_revision())
919
return tree.inventory.root.file_id
921
def lock_write(self):
922
# TODO: test for failed two phase locks. This is known broken.
923
self.control_files.lock_write()
924
self.repository.lock_write()
927
# TODO: test for failed two phase locks. This is known broken.
928
self.control_files.lock_read()
929
self.repository.lock_read()
932
# TODO: test for failed two phase locks. This is known broken.
933
self.repository.unlock()
934
self.control_files.unlock()
936
def peek_lock_mode(self):
937
if self.control_files._lock_count == 0:
940
return self.control_files._lock_mode
943
def print_file(self, file, revision_id):
944
"""See Branch.print_file."""
945
return self.repository.print_file(file, revision_id)
948
def append_revision(self, *revision_ids):
949
"""See Branch.append_revision."""
950
for revision_id in revision_ids:
951
mutter("add {%s} to revision-history" % revision_id)
952
rev_history = self.revision_history()
953
rev_history.extend(revision_ids)
954
self.set_revision_history(rev_history)
957
def set_revision_history(self, rev_history):
958
"""See Branch.set_revision_history."""
959
self.control_files.put_utf8(
960
'revision-history', '\n'.join(rev_history))
961
transaction = self.get_transaction()
962
history = transaction.map.find_revision_history()
963
if history is not None:
964
# update the revision history in the identity map.
965
history[:] = list(rev_history)
966
# this call is disabled because revision_history is
967
# not really an object yet, and the transaction is for objects.
968
# transaction.register_dirty(history)
970
transaction.map.add_revision_history(rev_history)
971
# this call is disabled because revision_history is
972
# not really an object yet, and the transaction is for objects.
973
# transaction.register_clean(history)
975
def get_revision_delta(self, revno):
976
"""Return the delta for one revision.
978
The delta is relative to its mainline predecessor, or the
979
empty tree for revision 1.
981
assert isinstance(revno, int)
982
rh = self.revision_history()
983
if not (1 <= revno <= len(rh)):
984
raise InvalidRevisionNumber(revno)
986
# revno is 1-based; list is 0-based
988
new_tree = self.repository.revision_tree(rh[revno-1])
990
old_tree = EmptyTree()
992
old_tree = self.repository.revision_tree(rh[revno-2])
993
return compare_trees(old_tree, new_tree)
996
def revision_history(self):
997
"""See Branch.revision_history."""
998
transaction = self.get_transaction()
999
history = transaction.map.find_revision_history()
1000
if history is not None:
1001
mutter("cache hit for revision-history in %s", self)
1002
return list(history)
1003
history = [l.rstrip('\r\n') for l in
1004
self.control_files.get_utf8('revision-history').readlines()]
1005
transaction.map.add_revision_history(history)
1006
# this call is disabled because revision_history is
1007
# not really an object yet, and the transaction is for objects.
1008
# transaction.register_clean(history, precious=True)
1009
return list(history)
1011
def update_revisions(self, other, stop_revision=None):
1012
"""See Branch.update_revisions."""
1013
if stop_revision is None:
1014
stop_revision = other.last_revision()
1015
### Should this be checking is_ancestor instead of revision_history?
1016
if (stop_revision is not None and
1017
stop_revision in self.revision_history()):
1019
self.fetch(other, stop_revision)
1020
pullable_revs = self.pullable_revisions(other, stop_revision)
1021
if len(pullable_revs) > 0:
1022
self.append_revision(*pullable_revs)
1024
def pullable_revisions(self, other, stop_revision):
1025
other_revno = other.revision_id_to_revno(stop_revision)
1027
return self.missing_revisions(other, other_revno)
1028
except DivergedBranches, e:
1030
pullable_revs = get_intervening_revisions(self.last_revision(),
1033
assert self.last_revision() not in pullable_revs
1034
return pullable_revs
1035
except bzrlib.errors.NotAncestor:
1036
if is_ancestor(self.last_revision(), stop_revision, self):
1041
def basis_tree(self):
1042
"""See Branch.basis_tree."""
1043
return self.repository.revision_tree(self.last_revision())
1045
@deprecated_method(zero_eight)
1046
def working_tree(self):
1047
"""Create a Working tree object for this branch."""
1048
from bzrlib.workingtree import WorkingTree
1049
from bzrlib.transport.local import LocalTransport
1050
if (self.base.find('://') != -1 or
1051
not isinstance(self._transport, LocalTransport)):
1052
raise NoWorkingTree(self.base)
1053
return self.bzrdir.open_workingtree()
1056
def pull(self, source, overwrite=False, stop_revision=None):
1057
"""See Branch.pull."""
1060
old_count = len(self.revision_history())
1062
self.update_revisions(source,stop_revision)
1063
except DivergedBranches:
1067
self.set_revision_history(source.revision_history())
1068
new_count = len(self.revision_history())
1069
return new_count - old_count
1073
def get_parent(self):
1074
"""See Branch.get_parent."""
1076
_locs = ['parent', 'pull', 'x-pull']
1079
return self.control_files.get_utf8(l).read().strip('\n')
1084
def get_push_location(self):
1085
"""See Branch.get_push_location."""
1086
config = bzrlib.config.BranchConfig(self)
1087
push_loc = config.get_user_option('push_location')
1090
def set_push_location(self, location):
1091
"""See Branch.set_push_location."""
1092
config = bzrlib.config.LocationConfig(self.base)
1093
config.set_user_option('push_location', location)
1096
def set_parent(self, url):
1097
"""See Branch.set_parent."""
1098
# TODO: Maybe delete old location files?
1099
# URLs should never be unicode, even on the local fs,
1100
# FIXUP this and get_parent in a future branch format bump:
1101
# read and rewrite the file, and have the new format code read
1102
# using .get not .get_utf8. RBC 20060125
1103
self.control_files.put_utf8('parent', url + '\n')
1105
def tree_config(self):
1106
return TreeConfig(self)
1109
class BzrBranch5(BzrBranch):
1110
"""A format 5 branch. This supports new features over plan branches.
1112
It has support for a master_branch which is the data for bound branches.
1120
super(BzrBranch5, self).__init__(_format=_format,
1121
_control_files=_control_files,
1123
_repository=_repository)
1126
def pull(self, source, overwrite=False, stop_revision=None):
1127
"""Updates branch.pull to be bound branch aware."""
1128
bound_location = self.get_bound_location()
1129
if source.base != bound_location:
1130
# not pulling from master, so we need to update master.
1131
master_branch = self.get_master_branch()
1133
master_branch.pull(source)
1134
source = master_branch
1135
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1137
def get_bound_location(self):
1139
return self.control_files.get_utf8('bound').read()[:-1]
1140
except errors.NoSuchFile:
1144
def get_master_branch(self):
1145
"""Return the branch we are bound to.
1147
:return: Either a Branch, or None
1149
This could memoise the branch, but if thats done
1150
it must be revalidated on each new lock.
1151
So for now we just dont memoise it.
1152
# RBC 20060304 review this decision.
1154
bound_loc = self.get_bound_location()
1158
return Branch.open(bound_loc)
1159
except (errors.NotBranchError, errors.ConnectionError), e:
1160
raise errors.BoundBranchConnectionFailure(
1164
def set_bound_location(self, location):
1165
"""Set the target where this branch is bound to.
1167
:param location: URL to the target branch
1170
self.control_files.put_utf8('bound', location+'\n')
1173
self.control_files._transport.delete('bound')
1179
def bind(self, other):
1180
"""Bind the local branch the other branch.
1182
:param other: The branch to bind to
1185
# TODO: jam 20051230 Consider checking if the target is bound
1186
# It is debatable whether you should be able to bind to
1187
# a branch which is itself bound.
1188
# Committing is obviously forbidden,
1189
# but binding itself may not be.
1190
# Since we *have* to check at commit time, we don't
1191
# *need* to check here
1194
# we are now equal to or a suffix of other.
1196
# Since we have 'pulled' from the remote location,
1197
# now we should try to pull in the opposite direction
1198
# in case the local tree has more revisions than the
1200
# There may be a different check you could do here
1201
# rather than actually trying to install revisions remotely.
1202
# TODO: capture an exception which indicates the remote branch
1204
# If it is up-to-date, this probably should not be a failure
1206
# lock other for write so the revision-history syncing cannot race
1210
# if this does not error, other now has the same last rev we do
1211
# it can only error if the pull from other was concurrent with
1212
# a commit to other from someone else.
1214
# until we ditch revision-history, we need to sync them up:
1215
self.set_revision_history(other.revision_history())
1216
# now other and self are up to date with each other and have the
1217
# same revision-history.
1221
self.set_bound_location(other.base)
1225
"""If bound, unbind"""
1226
return self.set_bound_location(None)
1230
"""Synchronise this branch with the master branch if any.
1232
:return: None or the last_revision that was pivoted out during the
1235
master = self.get_master_branch()
1236
if master is not None:
1237
old_tip = self.last_revision()
1238
self.pull(master, overwrite=True)
1239
if old_tip in self.repository.get_ancestry(self.last_revision()):
1245
class BranchTestProviderAdapter(object):
1246
"""A tool to generate a suite testing multiple branch formats at once.
1248
This is done by copying the test once for each transport and injecting
1249
the transport_server, transport_readonly_server, and branch_format
1250
classes into each copy. Each copy is also given a new id() to make it
1254
def __init__(self, transport_server, transport_readonly_server, formats):
1255
self._transport_server = transport_server
1256
self._transport_readonly_server = transport_readonly_server
1257
self._formats = formats
1259
def adapt(self, test):
1260
result = TestSuite()
1261
for branch_format, bzrdir_format in self._formats:
1262
new_test = deepcopy(test)
1263
new_test.transport_server = self._transport_server
1264
new_test.transport_readonly_server = self._transport_readonly_server
1265
new_test.bzrdir_format = bzrdir_format
1266
new_test.branch_format = branch_format
1267
def make_new_test_id():
1268
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1269
return lambda: new_id
1270
new_test.id = make_new_test_id()
1271
result.addTest(new_test)
1275
######################################################################
1279
@deprecated_function(zero_eight)
1280
def ScratchBranch(*args, **kwargs):
1281
"""See bzrlib.bzrdir.ScratchDir."""
1282
d = ScratchDir(*args, **kwargs)
1283
return d.open_branch()
1286
@deprecated_function(zero_eight)
1287
def is_control_file(*args, **kwargs):
1288
"""See bzrlib.workingtree.is_control_file."""
1289
return bzrlib.workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
