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, TransportLock
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
return self.get_format_string().rstrip()
610
class BzrBranchFormat4(BranchFormat):
611
"""Bzr branch format 4.
614
- a revision-history file.
615
- a branch-lock lock file [ to be shared with the bzrdir ]
618
def initialize(self, a_bzrdir):
619
"""Create a branch of this format in a_bzrdir."""
620
mutter('creating branch in %s', a_bzrdir.transport.base)
621
branch_transport = a_bzrdir.get_branch_transport(self)
622
utf8_files = [('revision-history', ''),
625
control_files = LockableFiles(branch_transport, 'branch-lock',
627
control_files.create_lock()
628
control_files.lock_write()
630
for file, content in utf8_files:
631
control_files.put_utf8(file, content)
633
control_files.unlock()
634
return self.open(a_bzrdir, _found=True)
637
super(BzrBranchFormat4, self).__init__()
638
self._matchingbzrdir = bzrdir.BzrDirFormat6()
640
def open(self, a_bzrdir, _found=False):
641
"""Return the branch object for a_bzrdir
643
_found is a private parameter, do not use it. It is used to indicate
644
if format probing has already be done.
647
# we are being called directly and must probe.
648
raise NotImplementedError
649
return BzrBranch(_format=self,
650
_control_files=a_bzrdir._control_files,
652
_repository=a_bzrdir.open_repository())
655
return "Bazaar-NG branch format 4"
658
class BzrBranchFormat5(BranchFormat):
659
"""Bzr branch format 5.
662
- a revision-history file.
665
- works with shared repositories.
668
def get_format_string(self):
669
"""See BranchFormat.get_format_string()."""
670
return "Bazaar-NG branch format 5\n"
672
def initialize(self, a_bzrdir):
673
"""Create a branch of this format in a_bzrdir."""
674
mutter('creating branch in %s', a_bzrdir.transport.base)
675
branch_transport = a_bzrdir.get_branch_transport(self)
677
utf8_files = [('revision-history', ''),
680
control_files = LockableFiles(branch_transport, 'lock', TransportLock)
681
control_files.create_lock()
682
control_files.lock_write()
683
control_files.put_utf8('format', self.get_format_string())
685
for file, content in utf8_files:
686
control_files.put_utf8(file, content)
688
control_files.unlock()
689
return self.open(a_bzrdir, _found=True, )
692
super(BzrBranchFormat5, self).__init__()
693
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
695
def open(self, a_bzrdir, _found=False):
696
"""Return the branch object for a_bzrdir
698
_found is a private parameter, do not use it. It is used to indicate
699
if format probing has already be done.
702
format = BranchFormat.find_format(a_bzrdir)
703
assert format.__class__ == self.__class__
704
transport = a_bzrdir.get_branch_transport(None)
705
control_files = LockableFiles(transport, 'lock', TransportLock)
706
return BzrBranch5(_format=self,
707
_control_files=control_files,
709
_repository=a_bzrdir.find_repository())
712
return "Bazaar-NG Metadir branch format 5"
715
class BranchReferenceFormat(BranchFormat):
716
"""Bzr branch reference format.
718
Branch references are used in implementing checkouts, they
719
act as an alias to the real branch which is at some other url.
726
def get_format_string(self):
727
"""See BranchFormat.get_format_string()."""
728
return "Bazaar-NG Branch Reference Format 1\n"
730
def initialize(self, a_bzrdir, target_branch=None):
731
"""Create a branch of this format in a_bzrdir."""
732
if target_branch is None:
733
# this format does not implement branch itself, thus the implicit
734
# creation contract must see it as uninitializable
735
raise errors.UninitializableFormat(self)
736
mutter('creating branch reference in %s', a_bzrdir.transport.base)
737
branch_transport = a_bzrdir.get_branch_transport(self)
738
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
739
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
740
branch_transport.put('format', StringIO(self.get_format_string()))
741
return self.open(a_bzrdir, _found=True)
744
super(BranchReferenceFormat, self).__init__()
745
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
747
def _make_reference_clone_function(format, a_branch):
748
"""Create a clone() routine for a branch dynamically."""
749
def clone(to_bzrdir, revision_id=None):
750
"""See Branch.clone()."""
751
return format.initialize(to_bzrdir, a_branch)
752
# cannot obey revision_id limits when cloning a reference ...
753
# FIXME RBC 20060210 either nuke revision_id for clone, or
754
# emit some sort of warning/error to the caller ?!
757
def open(self, a_bzrdir, _found=False):
758
"""Return the branch that the branch reference in a_bzrdir points at.
760
_found is a private parameter, do not use it. It is used to indicate
761
if format probing has already be done.
764
format = BranchFormat.find_format(a_bzrdir)
765
assert format.__class__ == self.__class__
766
transport = a_bzrdir.get_branch_transport(None)
767
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
768
result = real_bzrdir.open_branch()
769
# this changes the behaviour of result.clone to create a new reference
770
# rather than a copy of the content of the branch.
771
# I did not use a proxy object because that needs much more extensive
772
# testing, and we are only changing one behaviour at the moment.
773
# If we decide to alter more behaviours - i.e. the implicit nickname
774
# then this should be refactored to introduce a tested proxy branch
775
# and a subclass of that for use in overriding clone() and ....
777
result.clone = self._make_reference_clone_function(result)
781
# formats which have no format string are not discoverable
782
# and not independently creatable, so are not registered.
783
__default_format = BzrBranchFormat5()
784
BranchFormat.register_format(__default_format)
785
BranchFormat.register_format(BranchReferenceFormat())
786
BranchFormat.set_default_format(__default_format)
787
_legacy_formats = [BzrBranchFormat4(),
790
class BzrBranch(Branch):
791
"""A branch stored in the actual filesystem.
793
Note that it's "local" in the context of the filesystem; it doesn't
794
really matter if it's on an nfs/smb/afs/coda/... share, as long as
795
it's writable, and can be accessed via the normal filesystem API.
798
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
799
relax_version_check=DEPRECATED_PARAMETER, _format=None,
800
_control_files=None, a_bzrdir=None, _repository=None):
801
"""Create new branch object at a particular location.
803
transport -- A Transport object, defining how to access files.
805
init -- If True, create new control files in a previously
806
unversioned directory. If False, the branch must already
809
relax_version_check -- If true, the usual check for the branch
810
version is not applied. This is intended only for
811
upgrade/recovery type use; it's not guaranteed that
812
all operations will work on old format branches.
815
self.bzrdir = bzrdir.BzrDir.open(transport.base)
817
self.bzrdir = a_bzrdir
818
self._transport = self.bzrdir.transport.clone('..')
819
self._base = self._transport.base
820
self._format = _format
821
if _control_files is None:
822
raise BzrBadParameterMissing('_control_files')
823
self.control_files = _control_files
824
if deprecated_passed(init):
825
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
826
"deprecated as of bzr 0.8. Please use Branch.create().",
830
# this is slower than before deprecation, oh well never mind.
832
self._initialize(transport.base)
833
self._check_format(_format)
834
if deprecated_passed(relax_version_check):
835
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
836
"relax_version_check parameter is deprecated as of bzr 0.8. "
837
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
841
if (not relax_version_check
842
and not self._format.is_supported()):
843
raise errors.UnsupportedFormatError(
844
'sorry, branch format %r not supported' % fmt,
845
['use a different bzr version',
846
'or remove the .bzr directory'
847
' and "bzr init" again'])
848
if deprecated_passed(transport):
849
warn("BzrBranch.__init__(transport=XXX...): The transport "
850
"parameter is deprecated as of bzr 0.8. "
851
"Please use Branch.open, or bzrdir.open_branch().",
854
self.repository = _repository
857
return '%s(%r)' % (self.__class__.__name__, self.base)
862
# TODO: It might be best to do this somewhere else,
863
# but it is nice for a Branch object to automatically
864
# cache it's information.
865
# Alternatively, we could have the Transport objects cache requests
866
# See the earlier discussion about how major objects (like Branch)
867
# should never expect their __del__ function to run.
868
# XXX: cache_root seems to be unused, 2006-01-13 mbp
869
if hasattr(self, 'cache_root') and self.cache_root is not None:
871
shutil.rmtree(self.cache_root)
874
self.cache_root = None
879
base = property(_get_base, doc="The URL for the root of this branch.")
881
def _finish_transaction(self):
882
"""Exit the current transaction."""
883
return self.control_files._finish_transaction()
885
def get_transaction(self):
886
"""Return the current active transaction.
888
If no transaction is active, this returns a passthrough object
889
for which all data is immediately flushed and no caching happens.
891
# this is an explicit function so that we can do tricky stuff
892
# when the storage in rev_storage is elsewhere.
893
# we probably need to hook the two 'lock a location' and
894
# 'have a transaction' together more delicately, so that
895
# we can have two locks (branch and storage) and one transaction
896
# ... and finishing the transaction unlocks both, but unlocking
897
# does not. - RBC 20051121
898
return self.control_files.get_transaction()
900
def _set_transaction(self, transaction):
901
"""Set a new active transaction."""
902
return self.control_files._set_transaction(transaction)
904
def abspath(self, name):
905
"""See Branch.abspath."""
906
return self.control_files._transport.abspath(name)
908
def _check_format(self, format):
909
"""Identify the branch format if needed.
911
The format is stored as a reference to the format object in
912
self._format for code that needs to check it later.
914
The format parameter is either None or the branch format class
915
used to open this branch.
917
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
920
format = BzrBranchFormat.find_format(self.bzrdir)
921
self._format = format
922
mutter("got branch format %s", self._format)
925
def get_root_id(self):
926
"""See Branch.get_root_id."""
927
tree = self.repository.revision_tree(self.last_revision())
928
return tree.inventory.root.file_id
930
def lock_write(self):
931
# TODO: test for failed two phase locks. This is known broken.
932
self.control_files.lock_write()
933
self.repository.lock_write()
936
# TODO: test for failed two phase locks. This is known broken.
937
self.control_files.lock_read()
938
self.repository.lock_read()
941
# TODO: test for failed two phase locks. This is known broken.
942
self.repository.unlock()
943
self.control_files.unlock()
945
def peek_lock_mode(self):
946
if self.control_files._lock_count == 0:
949
return self.control_files._lock_mode
952
def print_file(self, file, revision_id):
953
"""See Branch.print_file."""
954
return self.repository.print_file(file, revision_id)
957
def append_revision(self, *revision_ids):
958
"""See Branch.append_revision."""
959
for revision_id in revision_ids:
960
mutter("add {%s} to revision-history" % revision_id)
961
rev_history = self.revision_history()
962
rev_history.extend(revision_ids)
963
self.set_revision_history(rev_history)
966
def set_revision_history(self, rev_history):
967
"""See Branch.set_revision_history."""
968
self.control_files.put_utf8(
969
'revision-history', '\n'.join(rev_history))
971
def get_revision_delta(self, revno):
972
"""Return the delta for one revision.
974
The delta is relative to its mainline predecessor, or the
975
empty tree for revision 1.
977
assert isinstance(revno, int)
978
rh = self.revision_history()
979
if not (1 <= revno <= len(rh)):
980
raise InvalidRevisionNumber(revno)
982
# revno is 1-based; list is 0-based
984
new_tree = self.repository.revision_tree(rh[revno-1])
986
old_tree = EmptyTree()
988
old_tree = self.repository.revision_tree(rh[revno-2])
989
return compare_trees(old_tree, new_tree)
992
def revision_history(self):
993
"""See Branch.revision_history."""
994
# FIXME are transactions bound to control files ? RBC 20051121
995
transaction = self.get_transaction()
996
history = transaction.map.find_revision_history()
997
if history is not None:
998
mutter("cache hit for revision-history in %s", self)
1000
history = [l.rstrip('\r\n') for l in
1001
self.control_files.get_utf8('revision-history').readlines()]
1002
transaction.map.add_revision_history(history)
1003
# this call is disabled because revision_history is
1004
# not really an object yet, and the transaction is for objects.
1005
# transaction.register_clean(history, precious=True)
1006
return list(history)
1008
def update_revisions(self, other, stop_revision=None):
1009
"""See Branch.update_revisions."""
1010
if stop_revision is None:
1011
stop_revision = other.last_revision()
1012
### Should this be checking is_ancestor instead of revision_history?
1013
if (stop_revision is not None and
1014
stop_revision in self.revision_history()):
1016
self.fetch(other, stop_revision)
1017
pullable_revs = self.pullable_revisions(other, stop_revision)
1018
if len(pullable_revs) > 0:
1019
self.append_revision(*pullable_revs)
1021
def pullable_revisions(self, other, stop_revision):
1022
other_revno = other.revision_id_to_revno(stop_revision)
1024
return self.missing_revisions(other, other_revno)
1025
except DivergedBranches, e:
1027
pullable_revs = get_intervening_revisions(self.last_revision(),
1030
assert self.last_revision() not in pullable_revs
1031
return pullable_revs
1032
except bzrlib.errors.NotAncestor:
1033
if is_ancestor(self.last_revision(), stop_revision, self):
1038
def basis_tree(self):
1039
"""See Branch.basis_tree."""
1040
return self.repository.revision_tree(self.last_revision())
1042
@deprecated_method(zero_eight)
1043
def working_tree(self):
1044
"""Create a Working tree object for this branch."""
1045
from bzrlib.workingtree import WorkingTree
1046
from bzrlib.transport.local import LocalTransport
1047
if (self.base.find('://') != -1 or
1048
not isinstance(self._transport, LocalTransport)):
1049
raise NoWorkingTree(self.base)
1050
return self.bzrdir.open_workingtree()
1053
def pull(self, source, overwrite=False, stop_revision=None):
1054
"""See Branch.pull."""
1057
old_count = len(self.revision_history())
1059
self.update_revisions(source,stop_revision)
1060
except DivergedBranches:
1064
self.set_revision_history(source.revision_history())
1065
new_count = len(self.revision_history())
1066
return new_count - old_count
1070
def get_parent(self):
1071
"""See Branch.get_parent."""
1073
_locs = ['parent', 'pull', 'x-pull']
1076
return self.control_files.get_utf8(l).read().strip('\n')
1081
def get_push_location(self):
1082
"""See Branch.get_push_location."""
1083
config = bzrlib.config.BranchConfig(self)
1084
push_loc = config.get_user_option('push_location')
1087
def set_push_location(self, location):
1088
"""See Branch.set_push_location."""
1089
config = bzrlib.config.LocationConfig(self.base)
1090
config.set_user_option('push_location', location)
1093
def set_parent(self, url):
1094
"""See Branch.set_parent."""
1095
# TODO: Maybe delete old location files?
1096
# URLs should never be unicode, even on the local fs,
1097
# FIXUP this and get_parent in a future branch format bump:
1098
# read and rewrite the file, and have the new format code read
1099
# using .get not .get_utf8. RBC 20060125
1100
self.control_files.put_utf8('parent', url + '\n')
1102
def tree_config(self):
1103
return TreeConfig(self)
1106
class BzrBranch5(BzrBranch):
1107
"""A format 5 branch. This supports new features over plan branches.
1109
It has support for a master_branch which is the data for bound branches.
1117
super(BzrBranch5, self).__init__(_format=_format,
1118
_control_files=_control_files,
1120
_repository=_repository)
1123
def pull(self, source, overwrite=False, stop_revision=None):
1124
"""Updates branch.pull to be bound branch aware."""
1125
bound_location = self.get_bound_location()
1126
if source.base != bound_location:
1127
# not pulling from master, so we need to update master.
1128
master_branch = self.get_master_branch()
1130
master_branch.pull(source)
1131
source = master_branch
1132
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1134
def get_bound_location(self):
1136
return self.control_files.get_utf8('bound').read()[:-1]
1137
except errors.NoSuchFile:
1141
def get_master_branch(self):
1142
"""Return the branch we are bound to.
1144
:return: Either a Branch, or None
1146
This could memoise the branch, but if thats done
1147
it must be revalidated on each new lock.
1148
So for now we just dont memoise it.
1149
# RBC 20060304 review this decision.
1151
bound_loc = self.get_bound_location()
1155
return Branch.open(bound_loc)
1156
except (errors.NotBranchError, errors.ConnectionError), e:
1157
raise errors.BoundBranchConnectionFailure(
1161
def set_bound_location(self, location):
1162
"""Set the target where this branch is bound to.
1164
:param location: URL to the target branch
1167
self.control_files.put_utf8('bound', location+'\n')
1170
self.control_files._transport.delete('bound')
1176
def bind(self, other):
1177
"""Bind the local branch the other branch.
1179
:param other: The branch to bind to
1182
# TODO: jam 20051230 Consider checking if the target is bound
1183
# It is debatable whether you should be able to bind to
1184
# a branch which is itself bound.
1185
# Committing is obviously forbidden,
1186
# but binding itself may not be.
1187
# Since we *have* to check at commit time, we don't
1188
# *need* to check here
1191
# we are now equal to or a suffix of other.
1193
# Since we have 'pulled' from the remote location,
1194
# now we should try to pull in the opposite direction
1195
# in case the local tree has more revisions than the
1197
# There may be a different check you could do here
1198
# rather than actually trying to install revisions remotely.
1199
# TODO: capture an exception which indicates the remote branch
1201
# If it is up-to-date, this probably should not be a failure
1203
# lock other for write so the revision-history syncing cannot race
1207
# if this does not error, other now has the same last rev we do
1208
# it can only error if the pull from other was concurrent with
1209
# a commit to other from someone else.
1211
# until we ditch revision-history, we need to sync them up:
1212
self.set_revision_history(other.revision_history())
1213
# now other and self are up to date with each other and have the
1214
# same revision-history.
1218
self.set_bound_location(other.base)
1222
"""If bound, unbind"""
1223
return self.set_bound_location(None)
1227
"""Synchronise this branch with the master branch if any.
1229
:return: None or the last_revision that was pivoted out during the
1232
master = self.get_master_branch()
1233
if master is not None:
1234
old_tip = self.last_revision()
1235
self.pull(master, overwrite=True)
1236
if old_tip in self.repository.get_ancestry(self.last_revision()):
1242
class BranchTestProviderAdapter(object):
1243
"""A tool to generate a suite testing multiple branch formats at once.
1245
This is done by copying the test once for each transport and injecting
1246
the transport_server, transport_readonly_server, and branch_format
1247
classes into each copy. Each copy is also given a new id() to make it
1251
def __init__(self, transport_server, transport_readonly_server, formats):
1252
self._transport_server = transport_server
1253
self._transport_readonly_server = transport_readonly_server
1254
self._formats = formats
1256
def adapt(self, test):
1257
result = TestSuite()
1258
for branch_format, bzrdir_format in self._formats:
1259
new_test = deepcopy(test)
1260
new_test.transport_server = self._transport_server
1261
new_test.transport_readonly_server = self._transport_readonly_server
1262
new_test.bzrdir_format = bzrdir_format
1263
new_test.branch_format = branch_format
1264
def make_new_test_id():
1265
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1266
return lambda: new_id
1267
new_test.id = make_new_test_id()
1268
result.addTest(new_test)
1272
######################################################################
1276
@deprecated_function(zero_eight)
1277
def ScratchBranch(*args, **kwargs):
1278
"""See bzrlib.bzrdir.ScratchDir."""
1279
d = ScratchDir(*args, **kwargs)
1280
return d.open_branch()
1283
@deprecated_function(zero_eight)
1284
def is_control_file(*args, **kwargs):
1285
"""See bzrlib.workingtree.is_control_file."""
1286
return bzrlib.workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
