1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from copy import deepcopy
19
from cStringIO import StringIO
24
from unittest import TestSuite
25
from warnings import warn
28
import bzrlib.bzrdir as bzrdir
29
from bzrlib.config import TreeConfig
30
from bzrlib.decorators import needs_read_lock, needs_write_lock
31
from bzrlib.delta import compare_trees
32
import bzrlib.errors as errors
33
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
34
NoSuchRevision, HistoryMissing, NotBranchError,
35
DivergedBranches, LockError,
36
UninitializableFormat,
38
UnlistableBranch, NoSuchFile, NotVersionedError,
40
import bzrlib.inventory as inventory
41
from bzrlib.inventory import Inventory
42
from bzrlib.lockable_files import LockableFiles, TransportLock
43
from bzrlib.lockdir import LockDir
44
from bzrlib.osutils import (isdir, quotefn,
45
rename, splitpath, sha_file,
46
file_kind, abspath, normpath, pathjoin,
50
from bzrlib.textui import show_status
51
from bzrlib.trace import mutter, note
52
from bzrlib.tree import EmptyTree, RevisionTree
53
from bzrlib.repository import Repository
54
from bzrlib.revision import (
55
get_intervening_revisions,
60
from bzrlib.store import copy_all
61
from bzrlib.symbol_versioning import *
62
import bzrlib.transactions as transactions
63
from bzrlib.transport import Transport, get_transport
64
from bzrlib.tree import EmptyTree, RevisionTree
69
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
70
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
71
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
74
# TODO: Maybe include checks for common corruption of newlines, etc?
76
# TODO: Some operations like log might retrieve the same revisions
77
# repeatedly to calculate deltas. We could perhaps have a weakref
78
# cache in memory to make this faster. In general anything can be
79
# cached in memory between lock and unlock operations. .. nb thats
80
# what the transaction identity map provides
83
######################################################################
87
"""Branch holding a history of revisions.
90
Base directory/url of the branch.
92
# this is really an instance variable - FIXME move it there
96
def __init__(self, *ignored, **ignored_too):
97
raise NotImplementedError('The Branch class is abstract')
100
@deprecated_method(zero_eight)
101
def open_downlevel(base):
102
"""Open a branch which may be of an old format."""
103
return Branch.open(base, _unsupported=True)
106
def open(base, _unsupported=False):
107
"""Open the repository rooted at base.
109
For instance, if the repository is at URL/.bzr/repository,
110
Repository.open(URL) -> a Repository instance.
112
control = bzrdir.BzrDir.open(base, _unsupported)
113
return control.open_branch(_unsupported)
116
def open_containing(url):
117
"""Open an existing branch which contains url.
119
This probes for a branch at url, and searches upwards from there.
121
Basically we keep looking up until we find the control directory or
122
run into the root. If there isn't one, raises NotBranchError.
123
If there is one and it is either an unrecognised format or an unsupported
124
format, UnknownFormatError or UnsupportedFormatError are raised.
125
If there is one, it is returned, along with the unused portion of url.
127
control, relpath = bzrdir.BzrDir.open_containing(url)
128
return control.open_branch(), relpath
131
@deprecated_function(zero_eight)
132
def initialize(base):
133
"""Create a new working tree and branch, rooted at 'base' (url)
135
NOTE: This will soon be deprecated in favour of creation
138
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
140
def setup_caching(self, cache_root):
141
"""Subclasses that care about caching should override this, and set
142
up cached stores located under cache_root.
144
# seems to be unused, 2006-01-13 mbp
145
warn('%s is deprecated' % self.setup_caching)
146
self.cache_root = cache_root
149
cfg = self.tree_config()
150
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
152
def _set_nick(self, nick):
153
cfg = self.tree_config()
154
cfg.set_option(nick, "nickname")
155
assert cfg.get_option("nickname") == nick
157
nick = property(_get_nick, _set_nick)
160
raise NotImplementedError('is_locked is abstract')
162
def lock_write(self):
163
raise NotImplementedError('lock_write is abstract')
166
raise NotImplementedError('lock_read is abstract')
169
raise NotImplementedError('unlock is abstract')
171
def peek_lock_mode(self):
172
"""Return lock mode for the Branch: 'r', 'w' or None"""
173
raise NotImplementedError(self.peek_lock_mode)
175
def get_physical_lock_status(self):
176
raise NotImplementedError('get_physical_lock_status is abstract')
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:
209
nested_pb = bzrlib.ui.ui_factory.nested_progress_bar()
214
from_branch.lock_read()
216
if last_revision is None:
217
pb.update('get source history')
218
from_history = from_branch.revision_history()
220
last_revision = from_history[-1]
222
# no history in the source branch
223
last_revision = NULL_REVISION
224
return self.repository.fetch(from_branch.repository,
225
revision_id=last_revision,
228
if nested_pb is not None:
232
def get_bound_location(self):
233
"""Return the URL of the branch we are bound to.
235
Older format branches cannot bind, please be sure to use a metadir
240
def get_master_branch(self):
241
"""Return the branch we are bound to.
243
:return: Either a Branch, or None
247
def get_root_id(self):
248
"""Return the id of this branches root"""
249
raise NotImplementedError('get_root_id is abstract')
251
def print_file(self, file, revision_id):
252
"""Print `file` to stdout."""
253
raise NotImplementedError('print_file is abstract')
255
def append_revision(self, *revision_ids):
256
raise NotImplementedError('append_revision is abstract')
258
def set_revision_history(self, rev_history):
259
raise NotImplementedError('set_revision_history is abstract')
261
def revision_history(self):
262
"""Return sequence of revision hashes on to this branch."""
263
raise NotImplementedError('revision_history is abstract')
266
"""Return current revision number for this branch.
268
That is equivalent to the number of revisions committed to
271
return len(self.revision_history())
274
"""Older format branches cannot bind or unbind."""
275
raise errors.UpgradeRequired(self.base)
277
def last_revision(self):
278
"""Return last patch hash, or None if no history."""
279
ph = self.revision_history()
285
def missing_revisions(self, other, stop_revision=None):
286
"""Return a list of new revisions that would perfectly fit.
288
If self and other have not diverged, return a list of the revisions
289
present in other, but missing from self.
291
>>> from bzrlib.workingtree import WorkingTree
292
>>> bzrlib.trace.silent = True
293
>>> d1 = bzrdir.ScratchDir()
294
>>> br1 = d1.open_branch()
295
>>> wt1 = d1.open_workingtree()
296
>>> d2 = bzrdir.ScratchDir()
297
>>> br2 = d2.open_branch()
298
>>> wt2 = d2.open_workingtree()
299
>>> br1.missing_revisions(br2)
301
>>> wt2.commit("lala!", rev_id="REVISION-ID-1")
302
>>> br1.missing_revisions(br2)
304
>>> br2.missing_revisions(br1)
306
>>> wt1.commit("lala!", rev_id="REVISION-ID-1")
307
>>> br1.missing_revisions(br2)
309
>>> wt2.commit("lala!", rev_id="REVISION-ID-2A")
310
>>> br1.missing_revisions(br2)
312
>>> wt1.commit("lala!", rev_id="REVISION-ID-2B")
313
>>> br1.missing_revisions(br2)
314
Traceback (most recent call last):
315
DivergedBranches: These branches have diverged. Try merge.
317
self_history = self.revision_history()
318
self_len = len(self_history)
319
other_history = other.revision_history()
320
other_len = len(other_history)
321
common_index = min(self_len, other_len) -1
322
if common_index >= 0 and \
323
self_history[common_index] != other_history[common_index]:
324
raise DivergedBranches(self, other)
326
if stop_revision is None:
327
stop_revision = other_len
329
assert isinstance(stop_revision, int)
330
if stop_revision > other_len:
331
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
332
return other_history[self_len:stop_revision]
334
def update_revisions(self, other, stop_revision=None):
335
"""Pull in new perfect-fit revisions.
337
:param other: Another Branch to pull from
338
:param stop_revision: Updated until the given revision
341
raise NotImplementedError('update_revisions is abstract')
343
def revision_id_to_revno(self, revision_id):
344
"""Given a revision id, return its revno"""
345
if revision_id is None:
347
history = self.revision_history()
349
return history.index(revision_id) + 1
351
raise bzrlib.errors.NoSuchRevision(self, revision_id)
353
def get_rev_id(self, revno, history=None):
354
"""Find the revision id of the specified revno."""
358
history = self.revision_history()
359
elif revno <= 0 or revno > len(history):
360
raise bzrlib.errors.NoSuchRevision(self, revno)
361
return history[revno - 1]
363
def pull(self, source, overwrite=False, stop_revision=None):
364
raise NotImplementedError('pull is abstract')
366
def basis_tree(self):
367
"""Return `Tree` object for last revision.
369
If there are no revisions yet, return an `EmptyTree`.
371
return self.repository.revision_tree(self.last_revision())
373
def rename_one(self, from_rel, to_rel):
376
This can change the directory or the filename or both.
378
raise NotImplementedError('rename_one is abstract')
380
def move(self, from_paths, to_name):
383
to_name must exist as a versioned directory.
385
If to_name exists and is a directory, the files are moved into
386
it, keeping their old names. If it is a directory,
388
Note that to_name is only the last component of the new name;
389
this doesn't change the directory.
391
This returns a list of (from_path, to_path) pairs for each
394
raise NotImplementedError('move is abstract')
396
def get_parent(self):
397
"""Return the parent location of the branch.
399
This is the default location for push/pull/missing. The usual
400
pattern is that the user can override it by specifying a
403
raise NotImplementedError('get_parent is abstract')
405
def get_push_location(self):
406
"""Return the None or the location to push this branch to."""
407
raise NotImplementedError('get_push_location is abstract')
409
def set_push_location(self, location):
410
"""Set a new push location for this branch."""
411
raise NotImplementedError('set_push_location is abstract')
413
def set_parent(self, url):
414
raise NotImplementedError('set_parent is abstract')
418
"""Synchronise this branch with the master branch if any.
420
:return: None or the last_revision pivoted out during the update.
424
def check_revno(self, revno):
426
Check whether a revno corresponds to any revision.
427
Zero (the NULL revision) is considered valid.
430
self.check_real_revno(revno)
432
def check_real_revno(self, revno):
434
Check whether a revno corresponds to a real revision.
435
Zero (the NULL revision) is considered invalid
437
if revno < 1 or revno > self.revno():
438
raise InvalidRevisionNumber(revno)
441
def clone(self, *args, **kwargs):
442
"""Clone this branch into to_bzrdir preserving all semantic values.
444
revision_id: if not None, the revision history in the new branch will
445
be truncated to end with revision_id.
447
# for API compatability, until 0.8 releases we provide the old api:
448
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
449
# after 0.8 releases, the *args and **kwargs should be changed:
450
# def clone(self, to_bzrdir, revision_id=None):
451
if (kwargs.get('to_location', None) or
452
kwargs.get('revision', None) or
453
kwargs.get('basis_branch', None) or
454
(len(args) and isinstance(args[0], basestring))):
455
# backwards compatability api:
456
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
457
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
460
basis_branch = args[2]
462
basis_branch = kwargs.get('basis_branch', None)
464
basis = basis_branch.bzrdir
469
revision_id = args[1]
471
revision_id = kwargs.get('revision', None)
476
# no default to raise if not provided.
477
url = kwargs.get('to_location')
478
return self.bzrdir.clone(url,
479
revision_id=revision_id,
480
basis=basis).open_branch()
482
# generate args by hand
484
revision_id = args[1]
486
revision_id = kwargs.get('revision_id', None)
490
# no default to raise if not provided.
491
to_bzrdir = kwargs.get('to_bzrdir')
492
result = self._format.initialize(to_bzrdir)
493
self.copy_content_into(result, revision_id=revision_id)
497
def sprout(self, to_bzrdir, revision_id=None):
498
"""Create a new line of development from the branch, into to_bzrdir.
500
revision_id: if not None, the revision history in the new branch will
501
be truncated to end with revision_id.
503
result = self._format.initialize(to_bzrdir)
504
self.copy_content_into(result, revision_id=revision_id)
505
result.set_parent(self.bzrdir.root_transport.base)
509
def copy_content_into(self, destination, revision_id=None):
510
"""Copy the content of self into destination.
512
revision_id: if not None, the revision history in the new branch will
513
be truncated to end with revision_id.
515
new_history = self.revision_history()
516
if revision_id is not None:
518
new_history = new_history[:new_history.index(revision_id) + 1]
520
rev = self.repository.get_revision(revision_id)
521
new_history = rev.get_history(self.repository)[1:]
522
destination.set_revision_history(new_history)
523
parent = self.get_parent()
525
destination.set_parent(parent)
528
class BranchFormat(object):
529
"""An encapsulation of the initialization and open routines for a format.
531
Formats provide three things:
532
* An initialization routine,
536
Formats are placed in an dict by their format string for reference
537
during branch opening. Its not required that these be instances, they
538
can be classes themselves with class methods - it simply depends on
539
whether state is needed for a given format or not.
541
Once a format is deprecated, just deprecate the initialize and open
542
methods on the format class. Do not deprecate the object, as the
543
object will be created every time regardless.
546
_default_format = None
547
"""The default format used for new branches."""
550
"""The known formats."""
553
def find_format(klass, a_bzrdir):
554
"""Return the format for the branch object in a_bzrdir."""
556
transport = a_bzrdir.get_branch_transport(None)
557
format_string = transport.get("format").read()
558
return klass._formats[format_string]
560
raise NotBranchError(path=transport.base)
562
raise errors.UnknownFormatError(format_string)
565
def get_default_format(klass):
566
"""Return the current default format."""
567
return klass._default_format
569
def get_format_string(self):
570
"""Return the ASCII format string that identifies this format."""
571
raise NotImplementedError(self.get_format_string)
573
def get_format_description(self):
574
"""Return the short format description for this format."""
575
raise NotImplementedError(self.get_format_string)
577
def initialize(self, a_bzrdir):
578
"""Create a branch of this format in a_bzrdir."""
579
raise NotImplementedError(self.initialized)
581
def is_supported(self):
582
"""Is this format supported?
584
Supported formats can be initialized and opened.
585
Unsupported formats may not support initialization or committing or
586
some other features depending on the reason for not being supported.
590
def open(self, a_bzrdir, _found=False):
591
"""Return the branch object for a_bzrdir
593
_found is a private parameter, do not use it. It is used to indicate
594
if format probing has already be done.
596
raise NotImplementedError(self.open)
599
def register_format(klass, format):
600
klass._formats[format.get_format_string()] = format
603
def set_default_format(klass, format):
604
klass._default_format = format
607
def unregister_format(klass, format):
608
assert klass._formats[format.get_format_string()] is format
609
del klass._formats[format.get_format_string()]
612
return self.get_format_string().rstrip()
615
class BzrBranchFormat4(BranchFormat):
616
"""Bzr branch format 4.
619
- a revision-history file.
620
- a branch-lock lock file [ to be shared with the bzrdir ]
623
def get_format_description(self):
624
"""See BranchFormat.get_format_description()."""
625
return "Branch format 4"
627
def initialize(self, a_bzrdir):
628
"""Create a branch of this format in a_bzrdir."""
629
mutter('creating branch in %s', a_bzrdir.transport.base)
630
branch_transport = a_bzrdir.get_branch_transport(self)
631
utf8_files = [('revision-history', ''),
634
control_files = LockableFiles(branch_transport, 'branch-lock',
636
control_files.create_lock()
637
control_files.lock_write()
639
for file, content in utf8_files:
640
control_files.put_utf8(file, content)
642
control_files.unlock()
643
return self.open(a_bzrdir, _found=True)
646
super(BzrBranchFormat4, self).__init__()
647
self._matchingbzrdir = bzrdir.BzrDirFormat6()
649
def open(self, a_bzrdir, _found=False):
650
"""Return the branch object for a_bzrdir
652
_found is a private parameter, do not use it. It is used to indicate
653
if format probing has already be done.
656
# we are being called directly and must probe.
657
raise NotImplementedError
658
return BzrBranch(_format=self,
659
_control_files=a_bzrdir._control_files,
661
_repository=a_bzrdir.open_repository())
664
return "Bazaar-NG branch format 4"
667
class BzrBranchFormat5(BranchFormat):
668
"""Bzr branch format 5.
671
- a revision-history file.
673
- a lock dir guarding the branch itself
674
- all of this stored in a branch/ subdirectory
675
- works with shared repositories.
677
This format is new in bzr 0.8.
680
def get_format_string(self):
681
"""See BranchFormat.get_format_string()."""
682
return "Bazaar-NG branch format 5\n"
684
def get_format_description(self):
685
"""See BranchFormat.get_format_description()."""
686
return "Branch format 5"
688
def initialize(self, a_bzrdir):
689
"""Create a branch of this format in a_bzrdir."""
690
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
691
branch_transport = a_bzrdir.get_branch_transport(self)
692
utf8_files = [('revision-history', ''),
695
control_files = LockableFiles(branch_transport, 'lock', LockDir)
696
control_files.create_lock()
697
control_files.lock_write()
698
control_files.put_utf8('format', self.get_format_string())
700
for file, content in utf8_files:
701
control_files.put_utf8(file, content)
703
control_files.unlock()
704
return self.open(a_bzrdir, _found=True, )
707
super(BzrBranchFormat5, self).__init__()
708
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
710
def open(self, a_bzrdir, _found=False):
711
"""Return the branch object for a_bzrdir
713
_found is a private parameter, do not use it. It is used to indicate
714
if format probing has already be done.
717
format = BranchFormat.find_format(a_bzrdir)
718
assert format.__class__ == self.__class__
719
transport = a_bzrdir.get_branch_transport(None)
720
control_files = LockableFiles(transport, 'lock', LockDir)
721
return BzrBranch5(_format=self,
722
_control_files=control_files,
724
_repository=a_bzrdir.find_repository())
727
return "Bazaar-NG Metadir branch format 5"
730
class BranchReferenceFormat(BranchFormat):
731
"""Bzr branch reference format.
733
Branch references are used in implementing checkouts, they
734
act as an alias to the real branch which is at some other url.
741
def get_format_string(self):
742
"""See BranchFormat.get_format_string()."""
743
return "Bazaar-NG Branch Reference Format 1\n"
745
def get_format_description(self):
746
"""See BranchFormat.get_format_description()."""
747
return "Checkout reference format 1"
749
def initialize(self, a_bzrdir, target_branch=None):
750
"""Create a branch of this format in a_bzrdir."""
751
if target_branch is None:
752
# this format does not implement branch itself, thus the implicit
753
# creation contract must see it as uninitializable
754
raise errors.UninitializableFormat(self)
755
mutter('creating branch reference in %s', a_bzrdir.transport.base)
756
branch_transport = a_bzrdir.get_branch_transport(self)
757
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
758
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
759
branch_transport.put('format', StringIO(self.get_format_string()))
760
return self.open(a_bzrdir, _found=True)
763
super(BranchReferenceFormat, self).__init__()
764
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
766
def _make_reference_clone_function(format, a_branch):
767
"""Create a clone() routine for a branch dynamically."""
768
def clone(to_bzrdir, revision_id=None):
769
"""See Branch.clone()."""
770
return format.initialize(to_bzrdir, a_branch)
771
# cannot obey revision_id limits when cloning a reference ...
772
# FIXME RBC 20060210 either nuke revision_id for clone, or
773
# emit some sort of warning/error to the caller ?!
776
def open(self, a_bzrdir, _found=False):
777
"""Return the branch that the branch reference in a_bzrdir points at.
779
_found is a private parameter, do not use it. It is used to indicate
780
if format probing has already be done.
783
format = BranchFormat.find_format(a_bzrdir)
784
assert format.__class__ == self.__class__
785
transport = a_bzrdir.get_branch_transport(None)
786
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
787
result = real_bzrdir.open_branch()
788
# this changes the behaviour of result.clone to create a new reference
789
# rather than a copy of the content of the branch.
790
# I did not use a proxy object because that needs much more extensive
791
# testing, and we are only changing one behaviour at the moment.
792
# If we decide to alter more behaviours - i.e. the implicit nickname
793
# then this should be refactored to introduce a tested proxy branch
794
# and a subclass of that for use in overriding clone() and ....
796
result.clone = self._make_reference_clone_function(result)
800
# formats which have no format string are not discoverable
801
# and not independently creatable, so are not registered.
802
__default_format = BzrBranchFormat5()
803
BranchFormat.register_format(__default_format)
804
BranchFormat.register_format(BranchReferenceFormat())
805
BranchFormat.set_default_format(__default_format)
806
_legacy_formats = [BzrBranchFormat4(),
809
class BzrBranch(Branch):
810
"""A branch stored in the actual filesystem.
812
Note that it's "local" in the context of the filesystem; it doesn't
813
really matter if it's on an nfs/smb/afs/coda/... share, as long as
814
it's writable, and can be accessed via the normal filesystem API.
817
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
818
relax_version_check=DEPRECATED_PARAMETER, _format=None,
819
_control_files=None, a_bzrdir=None, _repository=None):
820
"""Create new branch object at a particular location.
822
transport -- A Transport object, defining how to access files.
824
init -- If True, create new control files in a previously
825
unversioned directory. If False, the branch must already
828
relax_version_check -- If true, the usual check for the branch
829
version is not applied. This is intended only for
830
upgrade/recovery type use; it's not guaranteed that
831
all operations will work on old format branches.
834
self.bzrdir = bzrdir.BzrDir.open(transport.base)
836
self.bzrdir = a_bzrdir
837
self._transport = self.bzrdir.transport.clone('..')
838
self._base = self._transport.base
839
self._format = _format
840
if _control_files is None:
841
raise BzrBadParameterMissing('_control_files')
842
self.control_files = _control_files
843
if deprecated_passed(init):
844
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
845
"deprecated as of bzr 0.8. Please use Branch.create().",
849
# this is slower than before deprecation, oh well never mind.
851
self._initialize(transport.base)
852
self._check_format(_format)
853
if deprecated_passed(relax_version_check):
854
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
855
"relax_version_check parameter is deprecated as of bzr 0.8. "
856
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
860
if (not relax_version_check
861
and not self._format.is_supported()):
862
raise errors.UnsupportedFormatError(
863
'sorry, branch format %r not supported' % fmt,
864
['use a different bzr version',
865
'or remove the .bzr directory'
866
' and "bzr init" again'])
867
if deprecated_passed(transport):
868
warn("BzrBranch.__init__(transport=XXX...): The transport "
869
"parameter is deprecated as of bzr 0.8. "
870
"Please use Branch.open, or bzrdir.open_branch().",
873
self.repository = _repository
876
return '%s(%r)' % (self.__class__.__name__, self.base)
881
# TODO: It might be best to do this somewhere else,
882
# but it is nice for a Branch object to automatically
883
# cache it's information.
884
# Alternatively, we could have the Transport objects cache requests
885
# See the earlier discussion about how major objects (like Branch)
886
# should never expect their __del__ function to run.
887
# XXX: cache_root seems to be unused, 2006-01-13 mbp
888
if hasattr(self, 'cache_root') and self.cache_root is not None:
890
rmtree(self.cache_root)
893
self.cache_root = None
898
base = property(_get_base, doc="The URL for the root of this branch.")
900
def _finish_transaction(self):
901
"""Exit the current transaction."""
902
return self.control_files._finish_transaction()
904
def get_transaction(self):
905
"""Return the current active transaction.
907
If no transaction is active, this returns a passthrough object
908
for which all data is immediately flushed and no caching happens.
910
# this is an explicit function so that we can do tricky stuff
911
# when the storage in rev_storage is elsewhere.
912
# we probably need to hook the two 'lock a location' and
913
# 'have a transaction' together more delicately, so that
914
# we can have two locks (branch and storage) and one transaction
915
# ... and finishing the transaction unlocks both, but unlocking
916
# does not. - RBC 20051121
917
return self.control_files.get_transaction()
919
def _set_transaction(self, transaction):
920
"""Set a new active transaction."""
921
return self.control_files._set_transaction(transaction)
923
def abspath(self, name):
924
"""See Branch.abspath."""
925
return self.control_files._transport.abspath(name)
927
def _check_format(self, format):
928
"""Identify the branch format if needed.
930
The format is stored as a reference to the format object in
931
self._format for code that needs to check it later.
933
The format parameter is either None or the branch format class
934
used to open this branch.
936
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
939
format = BzrBranchFormat.find_format(self.bzrdir)
940
self._format = format
941
mutter("got branch format %s", self._format)
944
def get_root_id(self):
945
"""See Branch.get_root_id."""
946
tree = self.repository.revision_tree(self.last_revision())
947
return tree.inventory.root.file_id
950
return self.control_files.is_locked()
952
def lock_write(self):
953
# TODO: test for failed two phase locks. This is known broken.
954
self.control_files.lock_write()
955
self.repository.lock_write()
958
# TODO: test for failed two phase locks. This is known broken.
959
self.control_files.lock_read()
960
self.repository.lock_read()
963
# TODO: test for failed two phase locks. This is known broken.
964
self.repository.unlock()
965
self.control_files.unlock()
967
def peek_lock_mode(self):
968
if self.control_files._lock_count == 0:
971
return self.control_files._lock_mode
973
def get_physical_lock_status(self):
974
return self.control_files.get_physical_lock_status()
977
def print_file(self, file, revision_id):
978
"""See Branch.print_file."""
979
return self.repository.print_file(file, revision_id)
982
def append_revision(self, *revision_ids):
983
"""See Branch.append_revision."""
984
for revision_id in revision_ids:
985
mutter("add {%s} to revision-history" % revision_id)
986
rev_history = self.revision_history()
987
rev_history.extend(revision_ids)
988
self.set_revision_history(rev_history)
991
def set_revision_history(self, rev_history):
992
"""See Branch.set_revision_history."""
993
self.control_files.put_utf8(
994
'revision-history', '\n'.join(rev_history))
995
transaction = self.get_transaction()
996
history = transaction.map.find_revision_history()
997
if history is not None:
998
# update the revision history in the identity map.
999
history[:] = list(rev_history)
1000
# this call is disabled because revision_history is
1001
# not really an object yet, and the transaction is for objects.
1002
# transaction.register_dirty(history)
1004
transaction.map.add_revision_history(rev_history)
1005
# this call is disabled because revision_history is
1006
# not really an object yet, and the transaction is for objects.
1007
# transaction.register_clean(history)
1009
def get_revision_delta(self, revno):
1010
"""Return the delta for one revision.
1012
The delta is relative to its mainline predecessor, or the
1013
empty tree for revision 1.
1015
assert isinstance(revno, int)
1016
rh = self.revision_history()
1017
if not (1 <= revno <= len(rh)):
1018
raise InvalidRevisionNumber(revno)
1020
# revno is 1-based; list is 0-based
1022
new_tree = self.repository.revision_tree(rh[revno-1])
1024
old_tree = EmptyTree()
1026
old_tree = self.repository.revision_tree(rh[revno-2])
1027
return compare_trees(old_tree, new_tree)
1030
def revision_history(self):
1031
"""See Branch.revision_history."""
1032
transaction = self.get_transaction()
1033
history = transaction.map.find_revision_history()
1034
if history is not None:
1035
mutter("cache hit for revision-history in %s", self)
1036
return list(history)
1037
history = [l.rstrip('\r\n') for l in
1038
self.control_files.get_utf8('revision-history').readlines()]
1039
transaction.map.add_revision_history(history)
1040
# this call is disabled because revision_history is
1041
# not really an object yet, and the transaction is for objects.
1042
# transaction.register_clean(history, precious=True)
1043
return list(history)
1046
def update_revisions(self, other, stop_revision=None):
1047
"""See Branch.update_revisions."""
1050
if stop_revision is None:
1051
stop_revision = other.last_revision()
1052
if stop_revision is None:
1053
# if there are no commits, we're done.
1055
# whats the current last revision, before we fetch [and change it
1057
last_rev = self.last_revision()
1058
# we fetch here regardless of whether we need to so that we pickup
1060
self.fetch(other, stop_revision)
1061
my_ancestry = self.repository.get_ancestry(last_rev)
1062
if stop_revision in my_ancestry:
1063
# last_revision is a descendant of stop_revision
1065
# stop_revision must be a descendant of last_revision
1066
stop_graph = self.repository.get_revision_graph(stop_revision)
1067
if last_rev is not None and last_rev not in stop_graph:
1068
# our previous tip is not merged into stop_revision
1069
raise errors.DivergedBranches(self, other)
1070
# make a new revision history from the graph
1071
current_rev_id = stop_revision
1073
while current_rev_id not in (None, NULL_REVISION):
1074
new_history.append(current_rev_id)
1075
current_rev_id_parents = stop_graph[current_rev_id]
1077
current_rev_id = current_rev_id_parents[0]
1079
current_rev_id = None
1080
new_history.reverse()
1081
self.set_revision_history(new_history)
1085
@deprecated_method(zero_eight)
1086
def pullable_revisions(self, other, stop_revision):
1087
"""Please use bzrlib.missing instead."""
1088
other_revno = other.revision_id_to_revno(stop_revision)
1090
return self.missing_revisions(other, other_revno)
1091
except DivergedBranches, e:
1093
pullable_revs = get_intervening_revisions(self.last_revision(),
1096
assert self.last_revision() not in pullable_revs
1097
return pullable_revs
1098
except bzrlib.errors.NotAncestor:
1099
if is_ancestor(self.last_revision(), stop_revision, self):
1104
def basis_tree(self):
1105
"""See Branch.basis_tree."""
1106
return self.repository.revision_tree(self.last_revision())
1108
@deprecated_method(zero_eight)
1109
def working_tree(self):
1110
"""Create a Working tree object for this branch."""
1111
from bzrlib.workingtree import WorkingTree
1112
from bzrlib.transport.local import LocalTransport
1113
if (self.base.find('://') != -1 or
1114
not isinstance(self._transport, LocalTransport)):
1115
raise NoWorkingTree(self.base)
1116
return self.bzrdir.open_workingtree()
1119
def pull(self, source, overwrite=False, stop_revision=None):
1120
"""See Branch.pull."""
1123
old_count = len(self.revision_history())
1125
self.update_revisions(source,stop_revision)
1126
except DivergedBranches:
1130
self.set_revision_history(source.revision_history())
1131
new_count = len(self.revision_history())
1132
return new_count - old_count
1136
def get_parent(self):
1137
"""See Branch.get_parent."""
1139
_locs = ['parent', 'pull', 'x-pull']
1142
return self.control_files.get_utf8(l).read().strip('\n')
1147
def get_push_location(self):
1148
"""See Branch.get_push_location."""
1149
config = bzrlib.config.BranchConfig(self)
1150
push_loc = config.get_user_option('push_location')
1153
def set_push_location(self, location):
1154
"""See Branch.set_push_location."""
1155
config = bzrlib.config.LocationConfig(self.base)
1156
config.set_user_option('push_location', location)
1159
def set_parent(self, url):
1160
"""See Branch.set_parent."""
1161
# TODO: Maybe delete old location files?
1162
# URLs should never be unicode, even on the local fs,
1163
# FIXUP this and get_parent in a future branch format bump:
1164
# read and rewrite the file, and have the new format code read
1165
# using .get not .get_utf8. RBC 20060125
1167
self.control_files._transport.delete('parent')
1169
self.control_files.put_utf8('parent', url + '\n')
1171
def tree_config(self):
1172
return TreeConfig(self)
1175
class BzrBranch5(BzrBranch):
1176
"""A format 5 branch. This supports new features over plan branches.
1178
It has support for a master_branch which is the data for bound branches.
1186
super(BzrBranch5, self).__init__(_format=_format,
1187
_control_files=_control_files,
1189
_repository=_repository)
1192
def pull(self, source, overwrite=False, stop_revision=None):
1193
"""Updates branch.pull to be bound branch aware."""
1194
bound_location = self.get_bound_location()
1195
if source.base != bound_location:
1196
# not pulling from master, so we need to update master.
1197
master_branch = self.get_master_branch()
1199
master_branch.pull(source)
1200
source = master_branch
1201
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1203
def get_bound_location(self):
1205
return self.control_files.get_utf8('bound').read()[:-1]
1206
except errors.NoSuchFile:
1210
def get_master_branch(self):
1211
"""Return the branch we are bound to.
1213
:return: Either a Branch, or None
1215
This could memoise the branch, but if thats done
1216
it must be revalidated on each new lock.
1217
So for now we just dont memoise it.
1218
# RBC 20060304 review this decision.
1220
bound_loc = self.get_bound_location()
1224
return Branch.open(bound_loc)
1225
except (errors.NotBranchError, errors.ConnectionError), e:
1226
raise errors.BoundBranchConnectionFailure(
1230
def set_bound_location(self, location):
1231
"""Set the target where this branch is bound to.
1233
:param location: URL to the target branch
1236
self.control_files.put_utf8('bound', location+'\n')
1239
self.control_files._transport.delete('bound')
1245
def bind(self, other):
1246
"""Bind the local branch the other branch.
1248
:param other: The branch to bind to
1251
# TODO: jam 20051230 Consider checking if the target is bound
1252
# It is debatable whether you should be able to bind to
1253
# a branch which is itself bound.
1254
# Committing is obviously forbidden,
1255
# but binding itself may not be.
1256
# Since we *have* to check at commit time, we don't
1257
# *need* to check here
1260
# we are now equal to or a suffix of other.
1262
# Since we have 'pulled' from the remote location,
1263
# now we should try to pull in the opposite direction
1264
# in case the local tree has more revisions than the
1266
# There may be a different check you could do here
1267
# rather than actually trying to install revisions remotely.
1268
# TODO: capture an exception which indicates the remote branch
1270
# If it is up-to-date, this probably should not be a failure
1272
# lock other for write so the revision-history syncing cannot race
1276
# if this does not error, other now has the same last rev we do
1277
# it can only error if the pull from other was concurrent with
1278
# a commit to other from someone else.
1280
# until we ditch revision-history, we need to sync them up:
1281
self.set_revision_history(other.revision_history())
1282
# now other and self are up to date with each other and have the
1283
# same revision-history.
1287
self.set_bound_location(other.base)
1291
"""If bound, unbind"""
1292
return self.set_bound_location(None)
1296
"""Synchronise this branch with the master branch if any.
1298
:return: None or the last_revision that was pivoted out during the
1301
master = self.get_master_branch()
1302
if master is not None:
1303
old_tip = self.last_revision()
1304
self.pull(master, overwrite=True)
1305
if old_tip in self.repository.get_ancestry(self.last_revision()):
1311
class BranchTestProviderAdapter(object):
1312
"""A tool to generate a suite testing multiple branch formats at once.
1314
This is done by copying the test once for each transport and injecting
1315
the transport_server, transport_readonly_server, and branch_format
1316
classes into each copy. Each copy is also given a new id() to make it
1320
def __init__(self, transport_server, transport_readonly_server, formats):
1321
self._transport_server = transport_server
1322
self._transport_readonly_server = transport_readonly_server
1323
self._formats = formats
1325
def adapt(self, test):
1326
result = TestSuite()
1327
for branch_format, bzrdir_format in self._formats:
1328
new_test = deepcopy(test)
1329
new_test.transport_server = self._transport_server
1330
new_test.transport_readonly_server = self._transport_readonly_server
1331
new_test.bzrdir_format = bzrdir_format
1332
new_test.branch_format = branch_format
1333
def make_new_test_id():
1334
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1335
return lambda: new_id
1336
new_test.id = make_new_test_id()
1337
result.addTest(new_test)
1341
######################################################################
1345
@deprecated_function(zero_eight)
1346
def ScratchBranch(*args, **kwargs):
1347
"""See bzrlib.bzrdir.ScratchDir."""
1348
d = ScratchDir(*args, **kwargs)
1349
return d.open_branch()
1352
@deprecated_function(zero_eight)
1353
def is_control_file(*args, **kwargs):
1354
"""See bzrlib.workingtree.is_control_file."""
1355
return bzrlib.workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
