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
27
import xml.sax.saxutils
29
raise ImportError("We were unable to import 'xml.sax.saxutils',"
30
" most likely you have an xml.pyc or xml.pyo file"
31
" lying around in your bzrlib directory."
36
import bzrlib.bzrdir as bzrdir
37
from bzrlib.config import TreeConfig
38
from bzrlib.decorators import needs_read_lock, needs_write_lock
39
from bzrlib.delta import compare_trees
40
import bzrlib.errors as errors
41
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
42
NoSuchRevision, HistoryMissing, NotBranchError,
43
DivergedBranches, LockError,
44
UninitializableFormat,
46
UnlistableBranch, NoSuchFile, NotVersionedError,
48
import bzrlib.inventory as inventory
49
from bzrlib.inventory import Inventory
50
from bzrlib.lockable_files import LockableFiles
51
from bzrlib.osutils import (isdir, quotefn,
52
rename, splitpath, sha_file,
53
file_kind, abspath, normpath, pathjoin,
56
from bzrlib.textui import show_status
57
from bzrlib.trace import mutter, note
58
from bzrlib.tree import EmptyTree, RevisionTree
59
from bzrlib.repository import Repository
60
from bzrlib.revision import (
61
get_intervening_revisions,
66
from bzrlib.store import copy_all
67
from bzrlib.symbol_versioning import *
68
import bzrlib.transactions as transactions
69
from bzrlib.transport import Transport, get_transport
70
from bzrlib.tree import EmptyTree, RevisionTree
75
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
76
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
77
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
80
# TODO: Maybe include checks for common corruption of newlines, etc?
82
# TODO: Some operations like log might retrieve the same revisions
83
# repeatedly to calculate deltas. We could perhaps have a weakref
84
# cache in memory to make this faster. In general anything can be
85
# cached in memory between lock and unlock operations. .. nb thats
86
# what the transaction identity map provides
89
######################################################################
93
"""Branch holding a history of revisions.
96
Base directory/url of the branch.
98
# this is really an instance variable - FIXME move it there
102
def __init__(self, *ignored, **ignored_too):
103
raise NotImplementedError('The Branch class is abstract')
106
@deprecated_method(zero_eight)
107
def open_downlevel(base):
108
"""Open a branch which may be of an old format."""
109
return Branch.open(base, _unsupported=True)
112
def open(base, _unsupported=False):
113
"""Open the repository rooted at base.
115
For instance, if the repository is at URL/.bzr/repository,
116
Repository.open(URL) -> a Repository instance.
118
control = bzrdir.BzrDir.open(base, _unsupported)
119
return control.open_branch(_unsupported)
122
def open_containing(url):
123
"""Open an existing branch which contains url.
125
This probes for a branch at url, and searches upwards from there.
127
Basically we keep looking up until we find the control directory or
128
run into the root. If there isn't one, raises NotBranchError.
129
If there is one and it is either an unrecognised format or an unsupported
130
format, UnknownFormatError or UnsupportedFormatError are raised.
131
If there is one, it is returned, along with the unused portion of url.
133
control, relpath = bzrdir.BzrDir.open_containing(url)
134
return control.open_branch(), relpath
137
@deprecated_function(zero_eight)
138
def initialize(base):
139
"""Create a new working tree and branch, rooted at 'base' (url)
141
NOTE: This will soon be deprecated in favour of creation
144
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
146
def setup_caching(self, cache_root):
147
"""Subclasses that care about caching should override this, and set
148
up cached stores located under cache_root.
150
# seems to be unused, 2006-01-13 mbp
151
warn('%s is deprecated' % self.setup_caching)
152
self.cache_root = cache_root
155
cfg = self.tree_config()
156
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
158
def _set_nick(self, nick):
159
cfg = self.tree_config()
160
cfg.set_option(nick, "nickname")
161
assert cfg.get_option("nickname") == nick
163
nick = property(_get_nick, _set_nick)
165
def lock_write(self):
166
raise NotImplementedError('lock_write is abstract')
169
raise NotImplementedError('lock_read is abstract')
172
raise NotImplementedError('unlock is abstract')
174
def peek_lock_mode(self):
175
"""Return lock mode for the Branch: 'r', 'w' or None"""
176
raise NotImplementedError(self.peek_lock_mode)
178
def abspath(self, name):
179
"""Return absolute filename for something in the branch
181
XXX: Robert Collins 20051017 what is this used for? why is it a branch
182
method and not a tree method.
184
raise NotImplementedError('abspath is abstract')
186
def bind(self, other):
187
"""Bind the local branch the other branch.
189
:param other: The branch to bind to
192
raise errors.UpgradeRequired(self.base)
195
def fetch(self, from_branch, last_revision=None, pb=None):
196
"""Copy revisions from from_branch into this branch.
198
:param from_branch: Where to copy from.
199
:param last_revision: What revision to stop at (None for at the end
201
:param pb: An optional progress bar to use.
203
Returns the copied revision count and the failed revisions in a tuple:
206
if self.base == from_branch.base:
207
raise Exception("can't fetch from a branch to itself %s, %s" %
208
(self.base, to_branch.base))
210
pb = bzrlib.ui.ui_factory.progress_bar()
212
from_branch.lock_read()
214
if last_revision is None:
215
pb.update('get source history')
216
from_history = from_branch.revision_history()
218
last_revision = from_history[-1]
220
# no history in the source branch
221
last_revision = NULL_REVISION
222
return self.repository.fetch(from_branch.repository,
223
revision_id=last_revision,
228
def get_bound_location(self):
229
"""Return the URL of the rbanch we are bound to.
231
Older format branches cannot bind, please be sure to use a metadir
236
def get_master_branch(self):
237
"""Return the branch we are bound to.
239
:return: Either a Branch, or None
243
def get_root_id(self):
244
"""Return the id of this branches root"""
245
raise NotImplementedError('get_root_id is abstract')
247
def print_file(self, file, revision_id):
248
"""Print `file` to stdout."""
249
raise NotImplementedError('print_file is abstract')
251
def append_revision(self, *revision_ids):
252
raise NotImplementedError('append_revision is abstract')
254
def set_revision_history(self, rev_history):
255
raise NotImplementedError('set_revision_history is abstract')
257
def revision_history(self):
258
"""Return sequence of revision hashes on to this branch."""
259
raise NotImplementedError('revision_history is abstract')
262
"""Return current revision number for this branch.
264
That is equivalent to the number of revisions committed to
267
return len(self.revision_history())
270
"""Older format branches cannot bind or unbind."""
271
raise errors.UpgradeRequired(self.base)
273
def last_revision(self):
274
"""Return last patch hash, or None if no history."""
275
ph = self.revision_history()
281
def missing_revisions(self, other, stop_revision=None):
282
"""Return a list of new revisions that would perfectly fit.
284
If self and other have not diverged, return a list of the revisions
285
present in other, but missing from self.
287
>>> from bzrlib.workingtree import WorkingTree
288
>>> bzrlib.trace.silent = True
289
>>> d1 = bzrdir.ScratchDir()
290
>>> br1 = d1.open_branch()
291
>>> wt1 = d1.open_workingtree()
292
>>> d2 = bzrdir.ScratchDir()
293
>>> br2 = d2.open_branch()
294
>>> wt2 = d2.open_workingtree()
295
>>> br1.missing_revisions(br2)
297
>>> wt2.commit("lala!", rev_id="REVISION-ID-1")
298
>>> br1.missing_revisions(br2)
300
>>> br2.missing_revisions(br1)
302
>>> wt1.commit("lala!", rev_id="REVISION-ID-1")
303
>>> br1.missing_revisions(br2)
305
>>> wt2.commit("lala!", rev_id="REVISION-ID-2A")
306
>>> br1.missing_revisions(br2)
308
>>> wt1.commit("lala!", rev_id="REVISION-ID-2B")
309
>>> br1.missing_revisions(br2)
310
Traceback (most recent call last):
311
DivergedBranches: These branches have diverged. Try merge.
313
self_history = self.revision_history()
314
self_len = len(self_history)
315
other_history = other.revision_history()
316
other_len = len(other_history)
317
common_index = min(self_len, other_len) -1
318
if common_index >= 0 and \
319
self_history[common_index] != other_history[common_index]:
320
raise DivergedBranches(self, other)
322
if stop_revision is None:
323
stop_revision = other_len
325
assert isinstance(stop_revision, int)
326
if stop_revision > other_len:
327
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
328
return other_history[self_len:stop_revision]
330
def update_revisions(self, other, stop_revision=None):
331
"""Pull in new perfect-fit revisions.
333
:param other: Another Branch to pull from
334
:param stop_revision: Updated until the given revision
337
raise NotImplementedError('update_revisions is abstract')
339
def pullable_revisions(self, other, stop_revision):
340
raise NotImplementedError('pullable_revisions is abstract')
342
def revision_id_to_revno(self, revision_id):
343
"""Given a revision id, return its revno"""
344
if revision_id is None:
346
history = self.revision_history()
348
return history.index(revision_id) + 1
350
raise bzrlib.errors.NoSuchRevision(self, revision_id)
352
def get_rev_id(self, revno, history=None):
353
"""Find the revision id of the specified revno."""
357
history = self.revision_history()
358
elif revno <= 0 or revno > len(history):
359
raise bzrlib.errors.NoSuchRevision(self, revno)
360
return history[revno - 1]
362
def pull(self, source, overwrite=False, stop_revision=None):
363
raise NotImplementedError('pull is abstract')
365
def basis_tree(self):
366
"""Return `Tree` object for last revision.
368
If there are no revisions yet, return an `EmptyTree`.
370
return self.repository.revision_tree(self.last_revision())
372
def rename_one(self, from_rel, to_rel):
375
This can change the directory or the filename or both.
377
raise NotImplementedError('rename_one is abstract')
379
def move(self, from_paths, to_name):
382
to_name must exist as a versioned directory.
384
If to_name exists and is a directory, the files are moved into
385
it, keeping their old names. If it is a directory,
387
Note that to_name is only the last component of the new name;
388
this doesn't change the directory.
390
This returns a list of (from_path, to_path) pairs for each
393
raise NotImplementedError('move is abstract')
395
def get_parent(self):
396
"""Return the parent location of the branch.
398
This is the default location for push/pull/missing. The usual
399
pattern is that the user can override it by specifying a
402
raise NotImplementedError('get_parent is abstract')
404
def get_push_location(self):
405
"""Return the None or the location to push this branch to."""
406
raise NotImplementedError('get_push_location is abstract')
408
def set_push_location(self, location):
409
"""Set a new push location for this branch."""
410
raise NotImplementedError('set_push_location is abstract')
412
def set_parent(self, url):
413
raise NotImplementedError('set_parent is abstract')
417
"""Synchronise this branch with the master branch if any.
419
:return: None or the last_revision pivoted out during the update.
423
def check_revno(self, revno):
425
Check whether a revno corresponds to any revision.
426
Zero (the NULL revision) is considered valid.
429
self.check_real_revno(revno)
431
def check_real_revno(self, revno):
433
Check whether a revno corresponds to a real revision.
434
Zero (the NULL revision) is considered invalid
436
if revno < 1 or revno > self.revno():
437
raise InvalidRevisionNumber(revno)
440
def clone(self, *args, **kwargs):
441
"""Clone this branch into to_bzrdir preserving all semantic values.
443
revision_id: if not None, the revision history in the new branch will
444
be truncated to end with revision_id.
446
# for API compatability, until 0.8 releases we provide the old api:
447
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
448
# after 0.8 releases, the *args and **kwargs should be changed:
449
# def clone(self, to_bzrdir, revision_id=None):
450
if (kwargs.get('to_location', None) or
451
kwargs.get('revision', None) or
452
kwargs.get('basis_branch', None) or
453
(len(args) and isinstance(args[0], basestring))):
454
# backwards compatability api:
455
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
456
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
459
basis_branch = args[2]
461
basis_branch = kwargs.get('basis_branch', None)
463
basis = basis_branch.bzrdir
468
revision_id = args[1]
470
revision_id = kwargs.get('revision', None)
475
# no default to raise if not provided.
476
url = kwargs.get('to_location')
477
return self.bzrdir.clone(url,
478
revision_id=revision_id,
479
basis=basis).open_branch()
481
# generate args by hand
483
revision_id = args[1]
485
revision_id = kwargs.get('revision_id', None)
489
# no default to raise if not provided.
490
to_bzrdir = kwargs.get('to_bzrdir')
491
result = self._format.initialize(to_bzrdir)
492
self.copy_content_into(result, revision_id=revision_id)
496
def sprout(self, to_bzrdir, revision_id=None):
497
"""Create a new line of development from the branch, into to_bzrdir.
499
revision_id: if not None, the revision history in the new branch will
500
be truncated to end with revision_id.
502
result = self._format.initialize(to_bzrdir)
503
self.copy_content_into(result, revision_id=revision_id)
504
result.set_parent(self.bzrdir.root_transport.base)
508
def copy_content_into(self, destination, revision_id=None):
509
"""Copy the content of self into destination.
511
revision_id: if not None, the revision history in the new branch will
512
be truncated to end with revision_id.
514
new_history = self.revision_history()
515
if revision_id is not None:
517
new_history = new_history[:new_history.index(revision_id) + 1]
519
rev = self.repository.get_revision(revision_id)
520
new_history = rev.get_history(self.repository)[1:]
521
destination.set_revision_history(new_history)
522
parent = self.get_parent()
524
destination.set_parent(parent)
527
class BranchFormat(object):
528
"""An encapsulation of the initialization and open routines for a format.
530
Formats provide three things:
531
* An initialization routine,
535
Formats are placed in an dict by their format string for reference
536
during branch opening. Its not required that these be instances, they
537
can be classes themselves with class methods - it simply depends on
538
whether state is needed for a given format or not.
540
Once a format is deprecated, just deprecate the initialize and open
541
methods on the format class. Do not deprecate the object, as the
542
object will be created every time regardless.
545
_default_format = None
546
"""The default format used for new branches."""
549
"""The known formats."""
552
def find_format(klass, a_bzrdir):
553
"""Return the format for the branch object in a_bzrdir."""
555
transport = a_bzrdir.get_branch_transport(None)
556
format_string = transport.get("format").read()
557
return klass._formats[format_string]
559
raise NotBranchError(path=transport.base)
561
raise errors.UnknownFormatError(format_string)
564
def get_default_format(klass):
565
"""Return the current default format."""
566
return klass._default_format
568
def get_format_string(self):
569
"""Return the ASCII format string that identifies this format."""
570
raise NotImplementedError(self.get_format_string)
572
def initialize(self, a_bzrdir):
573
"""Create a branch of this format in a_bzrdir."""
574
raise NotImplementedError(self.initialized)
576
def is_supported(self):
577
"""Is this format supported?
579
Supported formats can be initialized and opened.
580
Unsupported formats may not support initialization or committing or
581
some other features depending on the reason for not being supported.
585
def open(self, a_bzrdir, _found=False):
586
"""Return the branch object for a_bzrdir
588
_found is a private parameter, do not use it. It is used to indicate
589
if format probing has already be done.
591
raise NotImplementedError(self.open)
594
def register_format(klass, format):
595
klass._formats[format.get_format_string()] = format
598
def set_default_format(klass, format):
599
klass._default_format = format
602
def unregister_format(klass, format):
603
assert klass._formats[format.get_format_string()] is format
604
del klass._formats[format.get_format_string()]
607
class BzrBranchFormat4(BranchFormat):
608
"""Bzr branch format 4.
611
- a revision-history file.
612
- a branch-lock lock file [ to be shared with the bzrdir ]
615
def initialize(self, a_bzrdir):
616
"""Create a branch of this format in a_bzrdir."""
617
mutter('creating branch in %s', a_bzrdir.transport.base)
618
branch_transport = a_bzrdir.get_branch_transport(self)
619
utf8_files = [('revision-history', ''),
622
control_files = LockableFiles(branch_transport, 'branch-lock')
623
control_files.lock_write()
625
for file, content in utf8_files:
626
control_files.put_utf8(file, content)
628
control_files.unlock()
629
return self.open(a_bzrdir, _found=True)
632
super(BzrBranchFormat4, self).__init__()
633
self._matchingbzrdir = bzrdir.BzrDirFormat6()
635
def open(self, a_bzrdir, _found=False):
636
"""Return the branch object for a_bzrdir
638
_found is a private parameter, do not use it. It is used to indicate
639
if format probing has already be done.
642
# we are being called directly and must probe.
643
raise NotImplementedError
644
return BzrBranch(_format=self,
645
_control_files=a_bzrdir._control_files,
647
_repository=a_bzrdir.open_repository())
650
class BzrBranchFormat5(BranchFormat):
651
"""Bzr branch format 5.
654
- a revision-history file.
657
- works with shared repositories.
660
def get_format_string(self):
661
"""See BranchFormat.get_format_string()."""
662
return "Bazaar-NG branch format 5\n"
664
def initialize(self, a_bzrdir):
665
"""Create a branch of this format in a_bzrdir."""
666
mutter('creating branch in %s', a_bzrdir.transport.base)
667
branch_transport = a_bzrdir.get_branch_transport(self)
669
utf8_files = [('revision-history', ''),
673
branch_transport.put(lock_file, StringIO()) # TODO get the file mode from the bzrdir lock files., mode=file_mode)
674
control_files = LockableFiles(branch_transport, 'lock')
675
control_files.lock_write()
676
control_files.put_utf8('format', self.get_format_string())
678
for file, content in utf8_files:
679
control_files.put_utf8(file, content)
681
control_files.unlock()
682
return self.open(a_bzrdir, _found=True, )
685
super(BzrBranchFormat5, self).__init__()
686
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
688
def open(self, a_bzrdir, _found=False):
689
"""Return the branch object for a_bzrdir
691
_found is a private parameter, do not use it. It is used to indicate
692
if format probing has already be done.
695
format = BranchFormat.find_format(a_bzrdir)
696
assert format.__class__ == self.__class__
697
transport = a_bzrdir.get_branch_transport(None)
698
control_files = LockableFiles(transport, 'lock')
699
return BzrBranch5(_format=self,
700
_control_files=control_files,
702
_repository=a_bzrdir.find_repository())
705
return "Bazaar-NG Metadir branch format 5"
708
class BranchReferenceFormat(BranchFormat):
709
"""Bzr branch reference format.
711
Branch references are used in implementing checkouts, they
712
act as an alias to the real branch which is at some other url.
719
def get_format_string(self):
720
"""See BranchFormat.get_format_string()."""
721
return "Bazaar-NG Branch Reference Format 1\n"
723
def initialize(self, a_bzrdir, target_branch=None):
724
"""Create a branch of this format in a_bzrdir."""
725
if target_branch is None:
726
# this format does not implement branch itself, thus the implicit
727
# creation contract must see it as uninitializable
728
raise errors.UninitializableFormat(self)
729
mutter('creating branch reference in %s', a_bzrdir.transport.base)
730
branch_transport = a_bzrdir.get_branch_transport(self)
731
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
732
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
733
branch_transport.put('format', StringIO(self.get_format_string()))
734
return self.open(a_bzrdir, _found=True)
737
super(BranchReferenceFormat, self).__init__()
738
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
740
def _make_reference_clone_function(format, a_branch):
741
"""Create a clone() routine for a branch dynamically."""
742
def clone(to_bzrdir, revision_id=None):
743
"""See Branch.clone()."""
744
return format.initialize(to_bzrdir, a_branch)
745
# cannot obey revision_id limits when cloning a reference ...
746
# FIXME RBC 20060210 either nuke revision_id for clone, or
747
# emit some sort of warning/error to the caller ?!
750
def open(self, a_bzrdir, _found=False):
751
"""Return the branch that the branch reference in a_bzrdir points at.
753
_found is a private parameter, do not use it. It is used to indicate
754
if format probing has already be done.
757
format = BranchFormat.find_format(a_bzrdir)
758
assert format.__class__ == self.__class__
759
transport = a_bzrdir.get_branch_transport(None)
760
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
761
result = real_bzrdir.open_branch()
762
# this changes the behaviour of result.clone to create a new reference
763
# rather than a copy of the content of the branch.
764
# I did not use a proxy object because that needs much more extensive
765
# testing, and we are only changing one behaviour at the moment.
766
# If we decide to alter more behaviours - i.e. the implicit nickname
767
# then this should be refactored to introduce a tested proxy branch
768
# and a subclass of that for use in overriding clone() and ....
770
result.clone = self._make_reference_clone_function(result)
774
# formats which have no format string are not discoverable
775
# and not independently creatable, so are not registered.
776
__default_format = BzrBranchFormat5()
777
BranchFormat.register_format(__default_format)
778
BranchFormat.register_format(BranchReferenceFormat())
779
BranchFormat.set_default_format(__default_format)
780
_legacy_formats = [BzrBranchFormat4(),
783
class BzrBranch(Branch):
784
"""A branch stored in the actual filesystem.
786
Note that it's "local" in the context of the filesystem; it doesn't
787
really matter if it's on an nfs/smb/afs/coda/... share, as long as
788
it's writable, and can be accessed via the normal filesystem API.
791
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
792
relax_version_check=DEPRECATED_PARAMETER, _format=None,
793
_control_files=None, a_bzrdir=None, _repository=None):
794
"""Create new branch object at a particular location.
796
transport -- A Transport object, defining how to access files.
798
init -- If True, create new control files in a previously
799
unversioned directory. If False, the branch must already
802
relax_version_check -- If true, the usual check for the branch
803
version is not applied. This is intended only for
804
upgrade/recovery type use; it's not guaranteed that
805
all operations will work on old format branches.
808
self.bzrdir = bzrdir.BzrDir.open(transport.base)
810
self.bzrdir = a_bzrdir
811
self._transport = self.bzrdir.transport.clone('..')
812
self._base = self._transport.base
813
self._format = _format
814
if _control_files is None:
815
raise BzrBadParameterMissing('_control_files')
816
self.control_files = _control_files
817
if deprecated_passed(init):
818
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
819
"deprecated as of bzr 0.8. Please use Branch.create().",
823
# this is slower than before deprecation, oh well never mind.
825
self._initialize(transport.base)
826
self._check_format(_format)
827
if deprecated_passed(relax_version_check):
828
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
829
"relax_version_check parameter is deprecated as of bzr 0.8. "
830
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
834
if (not relax_version_check
835
and not self._format.is_supported()):
836
raise errors.UnsupportedFormatError(
837
'sorry, branch format %r not supported' % fmt,
838
['use a different bzr version',
839
'or remove the .bzr directory'
840
' and "bzr init" again'])
841
if deprecated_passed(transport):
842
warn("BzrBranch.__init__(transport=XXX...): The transport "
843
"parameter is deprecated as of bzr 0.8. "
844
"Please use Branch.open, or bzrdir.open_branch().",
847
self.repository = _repository
850
return '%s(%r)' % (self.__class__.__name__, self.base)
855
# TODO: It might be best to do this somewhere else,
856
# but it is nice for a Branch object to automatically
857
# cache it's information.
858
# Alternatively, we could have the Transport objects cache requests
859
# See the earlier discussion about how major objects (like Branch)
860
# should never expect their __del__ function to run.
861
# XXX: cache_root seems to be unused, 2006-01-13 mbp
862
if hasattr(self, 'cache_root') and self.cache_root is not None:
864
shutil.rmtree(self.cache_root)
867
self.cache_root = None
872
base = property(_get_base, doc="The URL for the root of this branch.")
874
def _finish_transaction(self):
875
"""Exit the current transaction."""
876
return self.control_files._finish_transaction()
878
def get_transaction(self):
879
"""Return the current active transaction.
881
If no transaction is active, this returns a passthrough object
882
for which all data is immediately flushed and no caching happens.
884
# this is an explicit function so that we can do tricky stuff
885
# when the storage in rev_storage is elsewhere.
886
# we probably need to hook the two 'lock a location' and
887
# 'have a transaction' together more delicately, so that
888
# we can have two locks (branch and storage) and one transaction
889
# ... and finishing the transaction unlocks both, but unlocking
890
# does not. - RBC 20051121
891
return self.control_files.get_transaction()
893
def _set_transaction(self, transaction):
894
"""Set a new active transaction."""
895
return self.control_files._set_transaction(transaction)
897
def abspath(self, name):
898
"""See Branch.abspath."""
899
return self.control_files._transport.abspath(name)
901
def _check_format(self, format):
902
"""Identify the branch format if needed.
904
The format is stored as a reference to the format object in
905
self._format for code that needs to check it later.
907
The format parameter is either None or the branch format class
908
used to open this branch.
910
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
913
format = BzrBranchFormat.find_format(self.bzrdir)
914
self._format = format
915
mutter("got branch format %s", self._format)
918
def get_root_id(self):
919
"""See Branch.get_root_id."""
920
tree = self.repository.revision_tree(self.last_revision())
921
return tree.inventory.root.file_id
923
def lock_write(self):
924
# TODO: test for failed two phase locks. This is known broken.
925
self.control_files.lock_write()
926
self.repository.lock_write()
929
# TODO: test for failed two phase locks. This is known broken.
930
self.control_files.lock_read()
931
self.repository.lock_read()
934
# TODO: test for failed two phase locks. This is known broken.
935
self.repository.unlock()
936
self.control_files.unlock()
938
def peek_lock_mode(self):
939
if self.control_files._lock_count == 0:
942
return self.control_files._lock_mode
945
def print_file(self, file, revision_id):
946
"""See Branch.print_file."""
947
return self.repository.print_file(file, revision_id)
950
def append_revision(self, *revision_ids):
951
"""See Branch.append_revision."""
952
for revision_id in revision_ids:
953
mutter("add {%s} to revision-history" % revision_id)
954
rev_history = self.revision_history()
955
rev_history.extend(revision_ids)
956
self.set_revision_history(rev_history)
959
def set_revision_history(self, rev_history):
960
"""See Branch.set_revision_history."""
961
self.control_files.put_utf8(
962
'revision-history', '\n'.join(rev_history))
964
def get_revision_delta(self, revno):
965
"""Return the delta for one revision.
967
The delta is relative to its mainline predecessor, or the
968
empty tree for revision 1.
970
assert isinstance(revno, int)
971
rh = self.revision_history()
972
if not (1 <= revno <= len(rh)):
973
raise InvalidRevisionNumber(revno)
975
# revno is 1-based; list is 0-based
977
new_tree = self.repository.revision_tree(rh[revno-1])
979
old_tree = EmptyTree()
981
old_tree = self.repository.revision_tree(rh[revno-2])
982
return compare_trees(old_tree, new_tree)
985
def revision_history(self):
986
"""See Branch.revision_history."""
987
# FIXME are transactions bound to control files ? RBC 20051121
988
transaction = self.get_transaction()
989
history = transaction.map.find_revision_history()
990
if history is not None:
991
mutter("cache hit for revision-history in %s", self)
993
history = [l.rstrip('\r\n') for l in
994
self.control_files.get_utf8('revision-history').readlines()]
995
transaction.map.add_revision_history(history)
996
# this call is disabled because revision_history is
997
# not really an object yet, and the transaction is for objects.
998
# transaction.register_clean(history, precious=True)
1001
def update_revisions(self, other, stop_revision=None):
1002
"""See Branch.update_revisions."""
1003
if stop_revision is None:
1004
stop_revision = other.last_revision()
1005
### Should this be checking is_ancestor instead of revision_history?
1006
if (stop_revision is not None and
1007
stop_revision in self.revision_history()):
1009
self.fetch(other, stop_revision)
1010
pullable_revs = self.pullable_revisions(other, stop_revision)
1011
if len(pullable_revs) > 0:
1012
self.append_revision(*pullable_revs)
1014
def pullable_revisions(self, other, stop_revision):
1015
other_revno = other.revision_id_to_revno(stop_revision)
1017
return self.missing_revisions(other, other_revno)
1018
except DivergedBranches, e:
1020
pullable_revs = get_intervening_revisions(self.last_revision(),
1023
assert self.last_revision() not in pullable_revs
1024
return pullable_revs
1025
except bzrlib.errors.NotAncestor:
1026
if is_ancestor(self.last_revision(), stop_revision, self):
1031
def basis_tree(self):
1032
"""See Branch.basis_tree."""
1033
return self.repository.revision_tree(self.last_revision())
1035
@deprecated_method(zero_eight)
1036
def working_tree(self):
1037
"""Create a Working tree object for this branch."""
1038
from bzrlib.workingtree import WorkingTree
1039
from bzrlib.transport.local import LocalTransport
1040
if (self.base.find('://') != -1 or
1041
not isinstance(self._transport, LocalTransport)):
1042
raise NoWorkingTree(self.base)
1043
return self.bzrdir.open_workingtree()
1046
def pull(self, source, overwrite=False, stop_revision=None):
1047
"""See Branch.pull."""
1050
old_count = len(self.revision_history())
1052
self.update_revisions(source,stop_revision)
1053
except DivergedBranches:
1057
self.set_revision_history(source.revision_history())
1058
new_count = len(self.revision_history())
1059
return new_count - old_count
1063
def get_parent(self):
1064
"""See Branch.get_parent."""
1066
_locs = ['parent', 'pull', 'x-pull']
1069
return self.control_files.get_utf8(l).read().strip('\n')
1074
def get_push_location(self):
1075
"""See Branch.get_push_location."""
1076
config = bzrlib.config.BranchConfig(self)
1077
push_loc = config.get_user_option('push_location')
1080
def set_push_location(self, location):
1081
"""See Branch.set_push_location."""
1082
config = bzrlib.config.LocationConfig(self.base)
1083
config.set_user_option('push_location', location)
1086
def set_parent(self, url):
1087
"""See Branch.set_parent."""
1088
# TODO: Maybe delete old location files?
1089
# URLs should never be unicode, even on the local fs,
1090
# FIXUP this and get_parent in a future branch format bump:
1091
# read and rewrite the file, and have the new format code read
1092
# using .get not .get_utf8. RBC 20060125
1093
self.control_files.put_utf8('parent', url + '\n')
1095
def tree_config(self):
1096
return TreeConfig(self)
1099
class BzrBranch5(BzrBranch):
1100
"""A format 5 branch. This supports new features over plan branches.
1102
It has support for a master_branch which is the data for bound branches.
1110
super(BzrBranch5, self).__init__(_format=_format,
1111
_control_files=_control_files,
1113
_repository=_repository)
1116
def pull(self, source, overwrite=False, stop_revision=None):
1117
"""Updates branch.pull to be bound branch aware."""
1118
bound_location = self.get_bound_location()
1119
if source.base != bound_location:
1120
# not pulling from master, so we need to update master.
1121
master_branch = self.get_master_branch()
1123
master_branch.pull(source)
1124
source = master_branch
1125
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1127
def get_bound_location(self):
1129
return self.control_files.get_utf8('bound').read()[:-1]
1130
except errors.NoSuchFile:
1134
def get_master_branch(self):
1135
"""Return the branch we are bound to.
1137
:return: Either a Branch, or None
1139
This could memoise the branch, but if thats done
1140
it must be revalidated on each new lock.
1141
So for now we just dont memoise it.
1142
# RBC 20060304 review this decision.
1144
bound_loc = self.get_bound_location()
1148
return Branch.open(bound_loc)
1149
except (errors.NotBranchError, errors.ConnectionError), e:
1150
raise errors.BoundBranchConnectionFailure(
1154
def set_bound_location(self, location):
1155
"""Set the target where this branch is bound to.
1157
:param location: URL to the target branch
1160
self.control_files.put_utf8('bound', location+'\n')
1163
self.control_files._transport.delete('bound')
1169
def bind(self, other):
1170
"""Bind the local branch the other branch.
1172
:param other: The branch to bind to
1175
# TODO: jam 20051230 Consider checking if the target is bound
1176
# It is debatable whether you should be able to bind to
1177
# a branch which is itself bound.
1178
# Committing is obviously forbidden,
1179
# but binding itself may not be.
1180
# Since we *have* to check at commit time, we don't
1181
# *need* to check here
1184
# we are now equal to or a suffix of other.
1186
# Since we have 'pulled' from the remote location,
1187
# now we should try to pull in the opposite direction
1188
# in case the local tree has more revisions than the
1190
# There may be a different check you could do here
1191
# rather than actually trying to install revisions remotely.
1192
# TODO: capture an exception which indicates the remote branch
1194
# If it is up-to-date, this probably should not be a failure
1196
# lock other for write so the revision-history syncing cannot race
1200
# if this does not error, other now has the same last rev we do
1201
# it can only error if the pull from other was concurrent with
1202
# a commit to other from someone else.
1204
# until we ditch revision-history, we need to sync them up:
1205
self.set_revision_history(other.revision_history())
1206
# now other and self are up to date with each other and have the
1207
# same revision-history.
1211
self.set_bound_location(other.base)
1215
"""If bound, unbind"""
1216
return self.set_bound_location(None)
1220
"""Synchronise this branch with the master branch if any.
1222
:return: None or the last_revision that was pivoted out during the
1225
master = self.get_master_branch()
1226
if master is not None:
1227
old_tip = self.last_revision()
1228
self.pull(master, overwrite=True)
1229
if old_tip in self.repository.get_ancestry(self.last_revision()):
1235
class BranchTestProviderAdapter(object):
1236
"""A tool to generate a suite testing multiple branch formats at once.
1238
This is done by copying the test once for each transport and injecting
1239
the transport_server, transport_readonly_server, and branch_format
1240
classes into each copy. Each copy is also given a new id() to make it
1244
def __init__(self, transport_server, transport_readonly_server, formats):
1245
self._transport_server = transport_server
1246
self._transport_readonly_server = transport_readonly_server
1247
self._formats = formats
1249
def adapt(self, test):
1250
result = TestSuite()
1251
for branch_format, bzrdir_format in self._formats:
1252
new_test = deepcopy(test)
1253
new_test.transport_server = self._transport_server
1254
new_test.transport_readonly_server = self._transport_readonly_server
1255
new_test.bzrdir_format = bzrdir_format
1256
new_test.branch_format = branch_format
1257
def make_new_test_id():
1258
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1259
return lambda: new_id
1260
new_test.id = make_new_test_id()
1261
result.addTest(new_test)
1265
######################################################################
1269
@deprecated_function(zero_eight)
1270
def ScratchBranch(*args, **kwargs):
1271
"""See bzrlib.bzrdir.ScratchDir."""
1272
d = ScratchDir(*args, **kwargs)
1273
return d.open_branch()
1276
@deprecated_function(zero_eight)
1277
def is_control_file(*args, **kwargs):
1278
"""See bzrlib.workingtree.is_control_file."""
1279
return bzrlib.workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
