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')
415
def check_revno(self, revno):
417
Check whether a revno corresponds to any revision.
418
Zero (the NULL revision) is considered valid.
421
self.check_real_revno(revno)
423
def check_real_revno(self, revno):
425
Check whether a revno corresponds to a real revision.
426
Zero (the NULL revision) is considered invalid
428
if revno < 1 or revno > self.revno():
429
raise InvalidRevisionNumber(revno)
432
def clone(self, *args, **kwargs):
433
"""Clone this branch into to_bzrdir preserving all semantic values.
435
revision_id: if not None, the revision history in the new branch will
436
be truncated to end with revision_id.
438
# for API compatability, until 0.8 releases we provide the old api:
439
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
440
# after 0.8 releases, the *args and **kwargs should be changed:
441
# def clone(self, to_bzrdir, revision_id=None):
442
if (kwargs.get('to_location', None) or
443
kwargs.get('revision', None) or
444
kwargs.get('basis_branch', None) or
445
(len(args) and isinstance(args[0], basestring))):
446
# backwards compatability api:
447
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
448
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
451
basis_branch = args[2]
453
basis_branch = kwargs.get('basis_branch', None)
455
basis = basis_branch.bzrdir
460
revision_id = args[1]
462
revision_id = kwargs.get('revision', None)
467
# no default to raise if not provided.
468
url = kwargs.get('to_location')
469
return self.bzrdir.clone(url,
470
revision_id=revision_id,
471
basis=basis).open_branch()
473
# generate args by hand
475
revision_id = args[1]
477
revision_id = kwargs.get('revision_id', None)
481
# no default to raise if not provided.
482
to_bzrdir = kwargs.get('to_bzrdir')
483
result = self._format.initialize(to_bzrdir)
484
self.copy_content_into(result, revision_id=revision_id)
488
def sprout(self, to_bzrdir, revision_id=None):
489
"""Create a new line of development from the branch, into to_bzrdir.
491
revision_id: if not None, the revision history in the new branch will
492
be truncated to end with revision_id.
494
result = self._format.initialize(to_bzrdir)
495
self.copy_content_into(result, revision_id=revision_id)
496
result.set_parent(self.bzrdir.root_transport.base)
500
def copy_content_into(self, destination, revision_id=None):
501
"""Copy the content of self into destination.
503
revision_id: if not None, the revision history in the new branch will
504
be truncated to end with revision_id.
506
new_history = self.revision_history()
507
if revision_id is not None:
509
new_history = new_history[:new_history.index(revision_id) + 1]
511
rev = self.repository.get_revision(revision_id)
512
new_history = rev.get_history(self.repository)[1:]
513
destination.set_revision_history(new_history)
514
parent = self.get_parent()
516
destination.set_parent(parent)
519
class BranchFormat(object):
520
"""An encapsulation of the initialization and open routines for a format.
522
Formats provide three things:
523
* An initialization routine,
527
Formats are placed in an dict by their format string for reference
528
during branch opening. Its not required that these be instances, they
529
can be classes themselves with class methods - it simply depends on
530
whether state is needed for a given format or not.
532
Once a format is deprecated, just deprecate the initialize and open
533
methods on the format class. Do not deprecate the object, as the
534
object will be created every time regardless.
537
_default_format = None
538
"""The default format used for new branches."""
541
"""The known formats."""
544
def find_format(klass, a_bzrdir):
545
"""Return the format for the branch object in a_bzrdir."""
547
transport = a_bzrdir.get_branch_transport(None)
548
format_string = transport.get("format").read()
549
return klass._formats[format_string]
551
raise NotBranchError(path=transport.base)
553
raise errors.UnknownFormatError(format_string)
556
def get_default_format(klass):
557
"""Return the current default format."""
558
return klass._default_format
560
def get_format_string(self):
561
"""Return the ASCII format string that identifies this format."""
562
raise NotImplementedError(self.get_format_string)
564
def initialize(self, a_bzrdir):
565
"""Create a branch of this format in a_bzrdir."""
566
raise NotImplementedError(self.initialized)
568
def is_supported(self):
569
"""Is this format supported?
571
Supported formats can be initialized and opened.
572
Unsupported formats may not support initialization or committing or
573
some other features depending on the reason for not being supported.
577
def open(self, a_bzrdir, _found=False):
578
"""Return the branch object for a_bzrdir
580
_found is a private parameter, do not use it. It is used to indicate
581
if format probing has already be done.
583
raise NotImplementedError(self.open)
586
def register_format(klass, format):
587
klass._formats[format.get_format_string()] = format
590
def set_default_format(klass, format):
591
klass._default_format = format
594
def unregister_format(klass, format):
595
assert klass._formats[format.get_format_string()] is format
596
del klass._formats[format.get_format_string()]
599
class BzrBranchFormat4(BranchFormat):
600
"""Bzr branch format 4.
603
- a revision-history file.
604
- a branch-lock lock file [ to be shared with the bzrdir ]
607
def initialize(self, a_bzrdir):
608
"""Create a branch of this format in a_bzrdir."""
609
mutter('creating branch in %s', a_bzrdir.transport.base)
610
branch_transport = a_bzrdir.get_branch_transport(self)
611
utf8_files = [('revision-history', ''),
614
control_files = LockableFiles(branch_transport, 'branch-lock')
615
control_files.lock_write()
617
for file, content in utf8_files:
618
control_files.put_utf8(file, content)
620
control_files.unlock()
621
return self.open(a_bzrdir, _found=True)
624
super(BzrBranchFormat4, self).__init__()
625
self._matchingbzrdir = bzrdir.BzrDirFormat6()
627
def open(self, a_bzrdir, _found=False):
628
"""Return the branch object for a_bzrdir
630
_found is a private parameter, do not use it. It is used to indicate
631
if format probing has already be done.
634
# we are being called directly and must probe.
635
raise NotImplementedError
636
return BzrBranch(_format=self,
637
_control_files=a_bzrdir._control_files,
639
_repository=a_bzrdir.open_repository())
642
class BzrBranchFormat5(BranchFormat):
643
"""Bzr branch format 5.
646
- a revision-history file.
649
- works with shared repositories.
652
def get_format_string(self):
653
"""See BranchFormat.get_format_string()."""
654
return "Bazaar-NG branch format 5\n"
656
def initialize(self, a_bzrdir):
657
"""Create a branch of this format in a_bzrdir."""
658
mutter('creating branch in %s', a_bzrdir.transport.base)
659
branch_transport = a_bzrdir.get_branch_transport(self)
661
utf8_files = [('revision-history', ''),
665
branch_transport.put(lock_file, StringIO()) # TODO get the file mode from the bzrdir lock files., mode=file_mode)
666
control_files = LockableFiles(branch_transport, 'lock')
667
control_files.lock_write()
668
control_files.put_utf8('format', self.get_format_string())
670
for file, content in utf8_files:
671
control_files.put_utf8(file, content)
673
control_files.unlock()
674
return self.open(a_bzrdir, _found=True, )
677
super(BzrBranchFormat5, self).__init__()
678
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
680
def open(self, a_bzrdir, _found=False):
681
"""Return the branch object for a_bzrdir
683
_found is a private parameter, do not use it. It is used to indicate
684
if format probing has already be done.
687
format = BranchFormat.find_format(a_bzrdir)
688
assert format.__class__ == self.__class__
689
transport = a_bzrdir.get_branch_transport(None)
690
control_files = LockableFiles(transport, 'lock')
691
return BzrBranch5(_format=self,
692
_control_files=control_files,
694
_repository=a_bzrdir.find_repository())
697
class BranchReferenceFormat(BranchFormat):
698
"""Bzr branch reference format.
700
Branch references are used in implementing checkouts, they
701
act as an alias to the real branch which is at some other url.
708
def get_format_string(self):
709
"""See BranchFormat.get_format_string()."""
710
return "Bazaar-NG Branch Reference Format 1\n"
712
def initialize(self, a_bzrdir, target_branch=None):
713
"""Create a branch of this format in a_bzrdir."""
714
if target_branch is None:
715
# this format does not implement branch itself, thus the implicit
716
# creation contract must see it as uninitializable
717
raise errors.UninitializableFormat(self)
718
mutter('creating branch reference in %s', a_bzrdir.transport.base)
719
branch_transport = a_bzrdir.get_branch_transport(self)
720
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
721
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
722
branch_transport.put('format', StringIO(self.get_format_string()))
723
return self.open(a_bzrdir, _found=True)
726
super(BranchReferenceFormat, self).__init__()
727
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
729
def _make_reference_clone_function(format, a_branch):
730
"""Create a clone() routine for a branch dynamically."""
731
def clone(to_bzrdir, revision_id=None):
732
"""See Branch.clone()."""
733
return format.initialize(to_bzrdir, a_branch)
734
# cannot obey revision_id limits when cloning a reference ...
735
# FIXME RBC 20060210 either nuke revision_id for clone, or
736
# emit some sort of warning/error to the caller ?!
739
def open(self, a_bzrdir, _found=False):
740
"""Return the branch that the branch reference in a_bzrdir points at.
742
_found is a private parameter, do not use it. It is used to indicate
743
if format probing has already be done.
746
format = BranchFormat.find_format(a_bzrdir)
747
assert format.__class__ == self.__class__
748
transport = a_bzrdir.get_branch_transport(None)
749
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
750
result = real_bzrdir.open_branch()
751
# this changes the behaviour of result.clone to create a new reference
752
# rather than a copy of the content of the branch.
753
# I did not use a proxy object because that needs much more extensive
754
# testing, and we are only changing one behaviour at the moment.
755
# If we decide to alter more behaviours - i.e. the implicit nickname
756
# then this should be refactored to introduce a tested proxy branch
757
# and a subclass of that for use in overriding clone() and ....
759
result.clone = self._make_reference_clone_function(result)
763
# formats which have no format string are not discoverable
764
# and not independently creatable, so are not registered.
765
__default_format = BzrBranchFormat5()
766
BranchFormat.register_format(__default_format)
767
BranchFormat.register_format(BranchReferenceFormat())
768
BranchFormat.set_default_format(__default_format)
769
_legacy_formats = [BzrBranchFormat4(),
772
class BzrBranch(Branch):
773
"""A branch stored in the actual filesystem.
775
Note that it's "local" in the context of the filesystem; it doesn't
776
really matter if it's on an nfs/smb/afs/coda/... share, as long as
777
it's writable, and can be accessed via the normal filesystem API.
780
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
781
relax_version_check=DEPRECATED_PARAMETER, _format=None,
782
_control_files=None, a_bzrdir=None, _repository=None):
783
"""Create new branch object at a particular location.
785
transport -- A Transport object, defining how to access files.
787
init -- If True, create new control files in a previously
788
unversioned directory. If False, the branch must already
791
relax_version_check -- If true, the usual check for the branch
792
version is not applied. This is intended only for
793
upgrade/recovery type use; it's not guaranteed that
794
all operations will work on old format branches.
797
self.bzrdir = bzrdir.BzrDir.open(transport.base)
799
self.bzrdir = a_bzrdir
800
self._transport = self.bzrdir.transport.clone('..')
801
self._base = self._transport.base
802
self._format = _format
803
if _control_files is None:
804
raise BzrBadParameterMissing('_control_files')
805
self.control_files = _control_files
806
if deprecated_passed(init):
807
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
808
"deprecated as of bzr 0.8. Please use Branch.create().",
812
# this is slower than before deprecation, oh well never mind.
814
self._initialize(transport.base)
815
self._check_format(_format)
816
if deprecated_passed(relax_version_check):
817
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
818
"relax_version_check parameter is deprecated as of bzr 0.8. "
819
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
823
if (not relax_version_check
824
and not self._format.is_supported()):
825
raise errors.UnsupportedFormatError(
826
'sorry, branch format %r not supported' % fmt,
827
['use a different bzr version',
828
'or remove the .bzr directory'
829
' and "bzr init" again'])
830
if deprecated_passed(transport):
831
warn("BzrBranch.__init__(transport=XXX...): The transport "
832
"parameter is deprecated as of bzr 0.8. "
833
"Please use Branch.open, or bzrdir.open_branch().",
836
self.repository = _repository
839
return '%s(%r)' % (self.__class__.__name__, self.base)
844
# TODO: It might be best to do this somewhere else,
845
# but it is nice for a Branch object to automatically
846
# cache it's information.
847
# Alternatively, we could have the Transport objects cache requests
848
# See the earlier discussion about how major objects (like Branch)
849
# should never expect their __del__ function to run.
850
# XXX: cache_root seems to be unused, 2006-01-13 mbp
851
if hasattr(self, 'cache_root') and self.cache_root is not None:
853
shutil.rmtree(self.cache_root)
856
self.cache_root = None
861
base = property(_get_base, doc="The URL for the root of this branch.")
863
def _finish_transaction(self):
864
"""Exit the current transaction."""
865
return self.control_files._finish_transaction()
867
def get_transaction(self):
868
"""Return the current active transaction.
870
If no transaction is active, this returns a passthrough object
871
for which all data is immediately flushed and no caching happens.
873
# this is an explicit function so that we can do tricky stuff
874
# when the storage in rev_storage is elsewhere.
875
# we probably need to hook the two 'lock a location' and
876
# 'have a transaction' together more delicately, so that
877
# we can have two locks (branch and storage) and one transaction
878
# ... and finishing the transaction unlocks both, but unlocking
879
# does not. - RBC 20051121
880
return self.control_files.get_transaction()
882
def _set_transaction(self, transaction):
883
"""Set a new active transaction."""
884
return self.control_files._set_transaction(transaction)
886
def abspath(self, name):
887
"""See Branch.abspath."""
888
return self.control_files._transport.abspath(name)
890
def _check_format(self, format):
891
"""Identify the branch format if needed.
893
The format is stored as a reference to the format object in
894
self._format for code that needs to check it later.
896
The format parameter is either None or the branch format class
897
used to open this branch.
899
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
902
format = BzrBranchFormat.find_format(self.bzrdir)
903
self._format = format
904
mutter("got branch format %s", self._format)
907
def get_root_id(self):
908
"""See Branch.get_root_id."""
909
tree = self.repository.revision_tree(self.last_revision())
910
return tree.inventory.root.file_id
912
def lock_write(self):
913
# TODO: test for failed two phase locks. This is known broken.
914
self.control_files.lock_write()
915
self.repository.lock_write()
918
# TODO: test for failed two phase locks. This is known broken.
919
self.control_files.lock_read()
920
self.repository.lock_read()
923
# TODO: test for failed two phase locks. This is known broken.
924
self.repository.unlock()
925
self.control_files.unlock()
927
def peek_lock_mode(self):
928
if self.control_files._lock_count == 0:
931
return self.control_files._lock_mode
934
def print_file(self, file, revision_id):
935
"""See Branch.print_file."""
936
return self.repository.print_file(file, revision_id)
939
def append_revision(self, *revision_ids):
940
"""See Branch.append_revision."""
941
for revision_id in revision_ids:
942
mutter("add {%s} to revision-history" % revision_id)
943
rev_history = self.revision_history()
944
rev_history.extend(revision_ids)
945
self.set_revision_history(rev_history)
948
def set_revision_history(self, rev_history):
949
"""See Branch.set_revision_history."""
950
self.control_files.put_utf8(
951
'revision-history', '\n'.join(rev_history))
953
def get_revision_delta(self, revno):
954
"""Return the delta for one revision.
956
The delta is relative to its mainline predecessor, or the
957
empty tree for revision 1.
959
assert isinstance(revno, int)
960
rh = self.revision_history()
961
if not (1 <= revno <= len(rh)):
962
raise InvalidRevisionNumber(revno)
964
# revno is 1-based; list is 0-based
966
new_tree = self.repository.revision_tree(rh[revno-1])
968
old_tree = EmptyTree()
970
old_tree = self.repository.revision_tree(rh[revno-2])
971
return compare_trees(old_tree, new_tree)
974
def revision_history(self):
975
"""See Branch.revision_history."""
976
# FIXME are transactions bound to control files ? RBC 20051121
977
transaction = self.get_transaction()
978
history = transaction.map.find_revision_history()
979
if history is not None:
980
mutter("cache hit for revision-history in %s", self)
982
history = [l.rstrip('\r\n') for l in
983
self.control_files.get_utf8('revision-history').readlines()]
984
transaction.map.add_revision_history(history)
985
# this call is disabled because revision_history is
986
# not really an object yet, and the transaction is for objects.
987
# transaction.register_clean(history, precious=True)
990
def update_revisions(self, other, stop_revision=None):
991
"""See Branch.update_revisions."""
992
if stop_revision is None:
993
stop_revision = other.last_revision()
994
### Should this be checking is_ancestor instead of revision_history?
995
if (stop_revision is not None and
996
stop_revision in self.revision_history()):
998
self.fetch(other, stop_revision)
999
pullable_revs = self.pullable_revisions(other, stop_revision)
1000
if len(pullable_revs) > 0:
1001
self.append_revision(*pullable_revs)
1003
def pullable_revisions(self, other, stop_revision):
1004
other_revno = other.revision_id_to_revno(stop_revision)
1006
return self.missing_revisions(other, other_revno)
1007
except DivergedBranches, e:
1009
pullable_revs = get_intervening_revisions(self.last_revision(),
1012
assert self.last_revision() not in pullable_revs
1013
return pullable_revs
1014
except bzrlib.errors.NotAncestor:
1015
if is_ancestor(self.last_revision(), stop_revision, self):
1020
def basis_tree(self):
1021
"""See Branch.basis_tree."""
1022
return self.repository.revision_tree(self.last_revision())
1024
@deprecated_method(zero_eight)
1025
def working_tree(self):
1026
"""Create a Working tree object for this branch."""
1027
from bzrlib.workingtree import WorkingTree
1028
from bzrlib.transport.local import LocalTransport
1029
if (self.base.find('://') != -1 or
1030
not isinstance(self._transport, LocalTransport)):
1031
raise NoWorkingTree(self.base)
1032
return self.bzrdir.open_workingtree()
1035
def pull(self, source, overwrite=False, stop_revision=None):
1036
"""See Branch.pull."""
1039
old_count = len(self.revision_history())
1041
self.update_revisions(source,stop_revision)
1042
except DivergedBranches:
1046
self.set_revision_history(source.revision_history())
1047
new_count = len(self.revision_history())
1048
return new_count - old_count
1052
def get_parent(self):
1053
"""See Branch.get_parent."""
1055
_locs = ['parent', 'pull', 'x-pull']
1058
return self.control_files.get_utf8(l).read().strip('\n')
1063
def get_push_location(self):
1064
"""See Branch.get_push_location."""
1065
config = bzrlib.config.BranchConfig(self)
1066
push_loc = config.get_user_option('push_location')
1069
def set_push_location(self, location):
1070
"""See Branch.set_push_location."""
1071
config = bzrlib.config.LocationConfig(self.base)
1072
config.set_user_option('push_location', location)
1075
def set_parent(self, url):
1076
"""See Branch.set_parent."""
1077
# TODO: Maybe delete old location files?
1078
# URLs should never be unicode, even on the local fs,
1079
# FIXUP this and get_parent in a future branch format bump:
1080
# read and rewrite the file, and have the new format code read
1081
# using .get not .get_utf8. RBC 20060125
1082
self.control_files.put_utf8('parent', url + '\n')
1084
def tree_config(self):
1085
return TreeConfig(self)
1088
class BzrBranch5(BzrBranch):
1089
"""A format 5 branch. This supports new features over plan branches.
1091
It has support for a master_branch which is the data for bound branches.
1099
super(BzrBranch5, self).__init__(_format=_format,
1100
_control_files=_control_files,
1102
_repository=_repository)
1105
def pull(self, source, overwrite=False, stop_revision=None):
1106
"""Updates branch.pull to be bound branch aware."""
1107
# TODO: jam 20051230 This does work, in that 'bzr pull'
1108
# will update the master branch before updating the
1109
# local branch. However, 'source' can also already
1110
# be the master branch. Which means that we are
1111
# asking it to update from itself, before we continue.
1112
# This probably causes double downloads, etc.
1113
# So we probably want to put in an explicit check
1114
# of whether source is already the master branch.
1115
bound_location = self.get_bound_location()
1116
if source.base != bound_location:
1117
# not pulling from master, so we need to update master.
1118
master_branch = self.get_master_branch()
1120
master_branch.pull(source)
1121
source = master_branch
1122
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1124
def get_bound_location(self):
1126
return self.control_files.get_utf8('bound').read()[:-1]
1127
except errors.NoSuchFile:
1131
def get_master_branch(self):
1132
"""Return the branch we are bound to.
1134
:return: Either a Branch, or None
1136
This could memoise the branch, but if thats done
1137
it must be revalidated on each new lock.
1138
So for now we just dont memoise it.
1139
# RBC 20060304 review this decision.
1141
bound_loc = self.get_bound_location()
1145
return Branch.open(bound_loc)
1146
except (errors.NotBranchError, errors.ConnectionError), e:
1147
raise errors.BoundBranchConnectionFailure(
1151
def set_bound_location(self, location):
1152
"""Set the target where this branch is bound to.
1154
:param location: URL to the target branch
1157
self.control_files.put_utf8('bound', location+'\n')
1160
self.control_files._transport.delete('bound')
1166
def bind(self, other):
1167
"""Bind the local branch the other branch.
1169
:param other: The branch to bind to
1172
# TODO: jam 20051230 Consider checking if the target is bound
1173
# It is debatable whether you should be able to bind to
1174
# a branch which is itself bound.
1175
# Committing is obviously forbidden,
1176
# but binding itself may not be.
1177
# Since we *have* to check at commit time, we don't
1178
# *need* to check here
1181
# we are now equal to or a suffix of other.
1183
# Since we have 'pulled' from the remote location,
1184
# now we should try to pull in the opposite direction
1185
# in case the local tree has more revisions than the
1187
# There may be a different check you could do here
1188
# rather than actually trying to install revisions remotely.
1189
# TODO: capture an exception which indicates the remote branch
1191
# If it is up-to-date, this probably should not be a failure
1193
# lock other for write so the revision-history syncing cannot race
1197
# if this does not error, other now has the same last rev we do
1198
# it can only error if the pull from other was concurrent with
1199
# a commit to other from someone else.
1201
# until we ditch revision-history, we need to sync them up:
1202
self.set_revision_history(other.revision_history())
1203
# now other and self are up to date with each other and have the
1204
# same revision-history.
1208
self.set_bound_location(other.base)
1212
"""If bound, unbind"""
1213
return self.set_bound_location(None)
1216
class BranchTestProviderAdapter(object):
1217
"""A tool to generate a suite testing multiple branch formats at once.
1219
This is done by copying the test once for each transport and injecting
1220
the transport_server, transport_readonly_server, and branch_format
1221
classes into each copy. Each copy is also given a new id() to make it
1225
def __init__(self, transport_server, transport_readonly_server, formats):
1226
self._transport_server = transport_server
1227
self._transport_readonly_server = transport_readonly_server
1228
self._formats = formats
1230
def adapt(self, test):
1231
result = TestSuite()
1232
for branch_format, bzrdir_format in self._formats:
1233
new_test = deepcopy(test)
1234
new_test.transport_server = self._transport_server
1235
new_test.transport_readonly_server = self._transport_readonly_server
1236
new_test.bzrdir_format = bzrdir_format
1237
new_test.branch_format = branch_format
1238
def make_new_test_id():
1239
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1240
return lambda: new_id
1241
new_test.id = make_new_test_id()
1242
result.addTest(new_test)
1246
######################################################################
1250
@deprecated_function(zero_eight)
1251
def ScratchBranch(*args, **kwargs):
1252
"""See bzrlib.bzrdir.ScratchDir."""
1253
d = ScratchDir(*args, **kwargs)
1254
return d.open_branch()
1257
@deprecated_function(zero_eight)
1258
def is_control_file(*args, **kwargs):
1259
"""See bzrlib.workingtree.is_control_file."""
1260
return bzrlib.workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
