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,
49
from bzrlib.textui import show_status
50
from bzrlib.trace import mutter, note
51
from bzrlib.tree import EmptyTree, RevisionTree
52
from bzrlib.repository import Repository
53
from bzrlib.revision import (
54
get_intervening_revisions,
59
from bzrlib.store import copy_all
60
from bzrlib.symbol_versioning import *
61
import bzrlib.transactions as transactions
62
from bzrlib.transport import Transport, get_transport
63
from bzrlib.tree import EmptyTree, RevisionTree
68
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
69
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
70
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
73
# TODO: Maybe include checks for common corruption of newlines, etc?
75
# TODO: Some operations like log might retrieve the same revisions
76
# repeatedly to calculate deltas. We could perhaps have a weakref
77
# cache in memory to make this faster. In general anything can be
78
# cached in memory between lock and unlock operations. .. nb thats
79
# what the transaction identity map provides
82
######################################################################
86
"""Branch holding a history of revisions.
89
Base directory/url of the branch.
91
# this is really an instance variable - FIXME move it there
95
def __init__(self, *ignored, **ignored_too):
96
raise NotImplementedError('The Branch class is abstract')
99
@deprecated_method(zero_eight)
100
def open_downlevel(base):
101
"""Open a branch which may be of an old format."""
102
return Branch.open(base, _unsupported=True)
105
def open(base, _unsupported=False):
106
"""Open the repository rooted at base.
108
For instance, if the repository is at URL/.bzr/repository,
109
Repository.open(URL) -> a Repository instance.
111
control = bzrdir.BzrDir.open(base, _unsupported)
112
return control.open_branch(_unsupported)
115
def open_containing(url):
116
"""Open an existing branch which contains url.
118
This probes for a branch at url, and searches upwards from there.
120
Basically we keep looking up until we find the control directory or
121
run into the root. If there isn't one, raises NotBranchError.
122
If there is one and it is either an unrecognised format or an unsupported
123
format, UnknownFormatError or UnsupportedFormatError are raised.
124
If there is one, it is returned, along with the unused portion of url.
126
control, relpath = bzrdir.BzrDir.open_containing(url)
127
return control.open_branch(), relpath
130
@deprecated_function(zero_eight)
131
def initialize(base):
132
"""Create a new working tree and branch, rooted at 'base' (url)
134
NOTE: This will soon be deprecated in favour of creation
137
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
139
def setup_caching(self, cache_root):
140
"""Subclasses that care about caching should override this, and set
141
up cached stores located under cache_root.
143
# seems to be unused, 2006-01-13 mbp
144
warn('%s is deprecated' % self.setup_caching)
145
self.cache_root = cache_root
148
cfg = self.tree_config()
149
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
151
def _set_nick(self, nick):
152
cfg = self.tree_config()
153
cfg.set_option(nick, "nickname")
154
assert cfg.get_option("nickname") == nick
156
nick = property(_get_nick, _set_nick)
158
def lock_write(self):
159
raise NotImplementedError('lock_write is abstract')
162
raise NotImplementedError('lock_read is abstract')
165
raise NotImplementedError('unlock is abstract')
167
def peek_lock_mode(self):
168
"""Return lock mode for the Branch: 'r', 'w' or None"""
169
raise NotImplementedError(self.peek_lock_mode)
171
def abspath(self, name):
172
"""Return absolute filename for something in the branch
174
XXX: Robert Collins 20051017 what is this used for? why is it a branch
175
method and not a tree method.
177
raise NotImplementedError('abspath is abstract')
179
def bind(self, other):
180
"""Bind the local branch the other branch.
182
:param other: The branch to bind to
185
raise errors.UpgradeRequired(self.base)
188
def fetch(self, from_branch, last_revision=None, pb=None):
189
"""Copy revisions from from_branch into this branch.
191
:param from_branch: Where to copy from.
192
:param last_revision: What revision to stop at (None for at the end
194
:param pb: An optional progress bar to use.
196
Returns the copied revision count and the failed revisions in a tuple:
199
if self.base == from_branch.base:
200
raise Exception("can't fetch from a branch to itself %s, %s" %
201
(self.base, to_branch.base))
203
nested_pb = bzrlib.ui.ui_factory.nested_progress_bar()
208
from_branch.lock_read()
210
if last_revision is None:
211
pb.update('get source history')
212
from_history = from_branch.revision_history()
214
last_revision = from_history[-1]
216
# no history in the source branch
217
last_revision = NULL_REVISION
218
return self.repository.fetch(from_branch.repository,
219
revision_id=last_revision,
222
if nested_pb is not None:
226
def get_bound_location(self):
227
"""Return the URL of the rbanch we are bound to.
229
Older format branches cannot bind, please be sure to use a metadir
234
def get_master_branch(self):
235
"""Return the branch we are bound to.
237
:return: Either a Branch, or None
241
def get_root_id(self):
242
"""Return the id of this branches root"""
243
raise NotImplementedError('get_root_id is abstract')
245
def print_file(self, file, revision_id):
246
"""Print `file` to stdout."""
247
raise NotImplementedError('print_file is abstract')
249
def append_revision(self, *revision_ids):
250
raise NotImplementedError('append_revision is abstract')
252
def set_revision_history(self, rev_history):
253
raise NotImplementedError('set_revision_history is abstract')
255
def revision_history(self):
256
"""Return sequence of revision hashes on to this branch."""
257
raise NotImplementedError('revision_history is abstract')
260
"""Return current revision number for this branch.
262
That is equivalent to the number of revisions committed to
265
return len(self.revision_history())
268
"""Older format branches cannot bind or unbind."""
269
raise errors.UpgradeRequired(self.base)
271
def last_revision(self):
272
"""Return last patch hash, or None if no history."""
273
ph = self.revision_history()
279
def missing_revisions(self, other, stop_revision=None):
280
"""Return a list of new revisions that would perfectly fit.
282
If self and other have not diverged, return a list of the revisions
283
present in other, but missing from self.
285
>>> from bzrlib.workingtree import WorkingTree
286
>>> bzrlib.trace.silent = True
287
>>> d1 = bzrdir.ScratchDir()
288
>>> br1 = d1.open_branch()
289
>>> wt1 = d1.open_workingtree()
290
>>> d2 = bzrdir.ScratchDir()
291
>>> br2 = d2.open_branch()
292
>>> wt2 = d2.open_workingtree()
293
>>> br1.missing_revisions(br2)
295
>>> wt2.commit("lala!", rev_id="REVISION-ID-1")
296
>>> br1.missing_revisions(br2)
298
>>> br2.missing_revisions(br1)
300
>>> wt1.commit("lala!", rev_id="REVISION-ID-1")
301
>>> br1.missing_revisions(br2)
303
>>> wt2.commit("lala!", rev_id="REVISION-ID-2A")
304
>>> br1.missing_revisions(br2)
306
>>> wt1.commit("lala!", rev_id="REVISION-ID-2B")
307
>>> br1.missing_revisions(br2)
308
Traceback (most recent call last):
309
DivergedBranches: These branches have diverged. Try merge.
311
self_history = self.revision_history()
312
self_len = len(self_history)
313
other_history = other.revision_history()
314
other_len = len(other_history)
315
common_index = min(self_len, other_len) -1
316
if common_index >= 0 and \
317
self_history[common_index] != other_history[common_index]:
318
raise DivergedBranches(self, other)
320
if stop_revision is None:
321
stop_revision = other_len
323
assert isinstance(stop_revision, int)
324
if stop_revision > other_len:
325
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
326
return other_history[self_len:stop_revision]
328
def update_revisions(self, other, stop_revision=None):
329
"""Pull in new perfect-fit revisions.
331
:param other: Another Branch to pull from
332
:param stop_revision: Updated until the given revision
335
raise NotImplementedError('update_revisions is abstract')
337
def pullable_revisions(self, other, stop_revision):
338
raise NotImplementedError('pullable_revisions is abstract')
340
def revision_id_to_revno(self, revision_id):
341
"""Given a revision id, return its revno"""
342
if revision_id is None:
344
history = self.revision_history()
346
return history.index(revision_id) + 1
348
raise bzrlib.errors.NoSuchRevision(self, revision_id)
350
def get_rev_id(self, revno, history=None):
351
"""Find the revision id of the specified revno."""
355
history = self.revision_history()
356
elif revno <= 0 or revno > len(history):
357
raise bzrlib.errors.NoSuchRevision(self, revno)
358
return history[revno - 1]
360
def pull(self, source, overwrite=False, stop_revision=None):
361
raise NotImplementedError('pull is abstract')
363
def basis_tree(self):
364
"""Return `Tree` object for last revision.
366
If there are no revisions yet, return an `EmptyTree`.
368
return self.repository.revision_tree(self.last_revision())
370
def rename_one(self, from_rel, to_rel):
373
This can change the directory or the filename or both.
375
raise NotImplementedError('rename_one is abstract')
377
def move(self, from_paths, to_name):
380
to_name must exist as a versioned directory.
382
If to_name exists and is a directory, the files are moved into
383
it, keeping their old names. If it is a directory,
385
Note that to_name is only the last component of the new name;
386
this doesn't change the directory.
388
This returns a list of (from_path, to_path) pairs for each
391
raise NotImplementedError('move is abstract')
393
def get_parent(self):
394
"""Return the parent location of the branch.
396
This is the default location for push/pull/missing. The usual
397
pattern is that the user can override it by specifying a
400
raise NotImplementedError('get_parent is abstract')
402
def get_push_location(self):
403
"""Return the None or the location to push this branch to."""
404
raise NotImplementedError('get_push_location is abstract')
406
def set_push_location(self, location):
407
"""Set a new push location for this branch."""
408
raise NotImplementedError('set_push_location is abstract')
410
def set_parent(self, url):
411
raise NotImplementedError('set_parent is abstract')
415
"""Synchronise this branch with the master branch if any.
417
:return: None or the last_revision pivoted out during the update.
421
def check_revno(self, revno):
423
Check whether a revno corresponds to any revision.
424
Zero (the NULL revision) is considered valid.
427
self.check_real_revno(revno)
429
def check_real_revno(self, revno):
431
Check whether a revno corresponds to a real revision.
432
Zero (the NULL revision) is considered invalid
434
if revno < 1 or revno > self.revno():
435
raise InvalidRevisionNumber(revno)
438
def clone(self, *args, **kwargs):
439
"""Clone this branch into to_bzrdir preserving all semantic values.
441
revision_id: if not None, the revision history in the new branch will
442
be truncated to end with revision_id.
444
# for API compatability, until 0.8 releases we provide the old api:
445
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
446
# after 0.8 releases, the *args and **kwargs should be changed:
447
# def clone(self, to_bzrdir, revision_id=None):
448
if (kwargs.get('to_location', None) or
449
kwargs.get('revision', None) or
450
kwargs.get('basis_branch', None) or
451
(len(args) and isinstance(args[0], basestring))):
452
# backwards compatability api:
453
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
454
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
457
basis_branch = args[2]
459
basis_branch = kwargs.get('basis_branch', None)
461
basis = basis_branch.bzrdir
466
revision_id = args[1]
468
revision_id = kwargs.get('revision', None)
473
# no default to raise if not provided.
474
url = kwargs.get('to_location')
475
return self.bzrdir.clone(url,
476
revision_id=revision_id,
477
basis=basis).open_branch()
479
# generate args by hand
481
revision_id = args[1]
483
revision_id = kwargs.get('revision_id', None)
487
# no default to raise if not provided.
488
to_bzrdir = kwargs.get('to_bzrdir')
489
result = self._format.initialize(to_bzrdir)
490
self.copy_content_into(result, revision_id=revision_id)
494
def sprout(self, to_bzrdir, revision_id=None):
495
"""Create a new line of development from the branch, into to_bzrdir.
497
revision_id: if not None, the revision history in the new branch will
498
be truncated to end with revision_id.
500
result = self._format.initialize(to_bzrdir)
501
self.copy_content_into(result, revision_id=revision_id)
502
result.set_parent(self.bzrdir.root_transport.base)
506
def copy_content_into(self, destination, revision_id=None):
507
"""Copy the content of self into destination.
509
revision_id: if not None, the revision history in the new branch will
510
be truncated to end with revision_id.
512
new_history = self.revision_history()
513
if revision_id is not None:
515
new_history = new_history[:new_history.index(revision_id) + 1]
517
rev = self.repository.get_revision(revision_id)
518
new_history = rev.get_history(self.repository)[1:]
519
destination.set_revision_history(new_history)
520
parent = self.get_parent()
522
destination.set_parent(parent)
525
class BranchFormat(object):
526
"""An encapsulation of the initialization and open routines for a format.
528
Formats provide three things:
529
* An initialization routine,
533
Formats are placed in an dict by their format string for reference
534
during branch opening. Its not required that these be instances, they
535
can be classes themselves with class methods - it simply depends on
536
whether state is needed for a given format or not.
538
Once a format is deprecated, just deprecate the initialize and open
539
methods on the format class. Do not deprecate the object, as the
540
object will be created every time regardless.
543
_default_format = None
544
"""The default format used for new branches."""
547
"""The known formats."""
550
def find_format(klass, a_bzrdir):
551
"""Return the format for the branch object in a_bzrdir."""
553
transport = a_bzrdir.get_branch_transport(None)
554
format_string = transport.get("format").read()
555
return klass._formats[format_string]
557
raise NotBranchError(path=transport.base)
559
raise errors.UnknownFormatError(format_string)
562
def get_default_format(klass):
563
"""Return the current default format."""
564
return klass._default_format
566
def get_format_string(self):
567
"""Return the ASCII format string that identifies this format."""
568
raise NotImplementedError(self.get_format_string)
570
def initialize(self, a_bzrdir):
571
"""Create a branch of this format in a_bzrdir."""
572
raise NotImplementedError(self.initialized)
574
def is_supported(self):
575
"""Is this format supported?
577
Supported formats can be initialized and opened.
578
Unsupported formats may not support initialization or committing or
579
some other features depending on the reason for not being supported.
583
def open(self, a_bzrdir, _found=False):
584
"""Return the branch object for a_bzrdir
586
_found is a private parameter, do not use it. It is used to indicate
587
if format probing has already be done.
589
raise NotImplementedError(self.open)
592
def register_format(klass, format):
593
klass._formats[format.get_format_string()] = format
596
def set_default_format(klass, format):
597
klass._default_format = format
600
def unregister_format(klass, format):
601
assert klass._formats[format.get_format_string()] is format
602
del klass._formats[format.get_format_string()]
605
class BzrBranchFormat4(BranchFormat):
606
"""Bzr branch format 4.
609
- a revision-history file.
610
- a branch-lock lock file [ to be shared with the bzrdir ]
613
def initialize(self, a_bzrdir):
614
"""Create a branch of this format in a_bzrdir."""
615
mutter('creating branch in %s', a_bzrdir.transport.base)
616
branch_transport = a_bzrdir.get_branch_transport(self)
617
utf8_files = [('revision-history', ''),
620
control_files = LockableFiles(branch_transport, 'branch-lock',
622
control_files.create_lock()
623
control_files.lock_write()
625
for file, content in utf8_files:
626
control_files.put_utf8(file, content)
628
control_files.unlock()
629
return self.open(a_bzrdir, _found=True)
632
super(BzrBranchFormat4, self).__init__()
633
self._matchingbzrdir = bzrdir.BzrDirFormat6()
635
def open(self, a_bzrdir, _found=False):
636
"""Return the branch object for a_bzrdir
638
_found is a private parameter, do not use it. It is used to indicate
639
if format probing has already be done.
642
# we are being called directly and must probe.
643
raise NotImplementedError
644
return BzrBranch(_format=self,
645
_control_files=a_bzrdir._control_files,
647
_repository=a_bzrdir.open_repository())
650
class BzrBranchFormat5(BranchFormat):
651
"""Bzr branch format 5.
654
- a revision-history file.
656
- a lock dir guarding the branch itself
657
- all of this stored in a branch/ subdirectory
658
- works with shared repositories.
660
This format is new in bzr 0.8.
663
def get_format_string(self):
664
"""See BranchFormat.get_format_string()."""
665
return "Bazaar-NG branch format 5\n"
667
def initialize(self, a_bzrdir):
668
"""Create a branch of this format in a_bzrdir."""
669
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
670
branch_transport = a_bzrdir.get_branch_transport(self)
671
utf8_files = [('revision-history', ''),
674
control_files = LockableFiles(branch_transport, 'lock', LockDir)
675
control_files.create_lock()
676
control_files.lock_write()
677
control_files.put_utf8('format', self.get_format_string())
679
for file, content in utf8_files:
680
control_files.put_utf8(file, content)
682
control_files.unlock()
683
return self.open(a_bzrdir, _found=True, )
686
super(BzrBranchFormat5, self).__init__()
687
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
689
def open(self, a_bzrdir, _found=False):
690
"""Return the branch object for a_bzrdir
692
_found is a private parameter, do not use it. It is used to indicate
693
if format probing has already be done.
696
format = BranchFormat.find_format(a_bzrdir)
697
assert format.__class__ == self.__class__
698
transport = a_bzrdir.get_branch_transport(None)
699
control_files = LockableFiles(transport, 'lock', LockDir)
700
return BzrBranch5(_format=self,
701
_control_files=control_files,
703
_repository=a_bzrdir.find_repository())
706
return "Bazaar-NG Metadir branch format 5"
709
class BranchReferenceFormat(BranchFormat):
710
"""Bzr branch reference format.
712
Branch references are used in implementing checkouts, they
713
act as an alias to the real branch which is at some other url.
720
def get_format_string(self):
721
"""See BranchFormat.get_format_string()."""
722
return "Bazaar-NG Branch Reference Format 1\n"
724
def initialize(self, a_bzrdir, target_branch=None):
725
"""Create a branch of this format in a_bzrdir."""
726
if target_branch is None:
727
# this format does not implement branch itself, thus the implicit
728
# creation contract must see it as uninitializable
729
raise errors.UninitializableFormat(self)
730
mutter('creating branch reference in %s', a_bzrdir.transport.base)
731
branch_transport = a_bzrdir.get_branch_transport(self)
732
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
733
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
734
branch_transport.put('format', StringIO(self.get_format_string()))
735
return self.open(a_bzrdir, _found=True)
738
super(BranchReferenceFormat, self).__init__()
739
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
741
def _make_reference_clone_function(format, a_branch):
742
"""Create a clone() routine for a branch dynamically."""
743
def clone(to_bzrdir, revision_id=None):
744
"""See Branch.clone()."""
745
return format.initialize(to_bzrdir, a_branch)
746
# cannot obey revision_id limits when cloning a reference ...
747
# FIXME RBC 20060210 either nuke revision_id for clone, or
748
# emit some sort of warning/error to the caller ?!
751
def open(self, a_bzrdir, _found=False):
752
"""Return the branch that the branch reference in a_bzrdir points at.
754
_found is a private parameter, do not use it. It is used to indicate
755
if format probing has already be done.
758
format = BranchFormat.find_format(a_bzrdir)
759
assert format.__class__ == self.__class__
760
transport = a_bzrdir.get_branch_transport(None)
761
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
762
result = real_bzrdir.open_branch()
763
# this changes the behaviour of result.clone to create a new reference
764
# rather than a copy of the content of the branch.
765
# I did not use a proxy object because that needs much more extensive
766
# testing, and we are only changing one behaviour at the moment.
767
# If we decide to alter more behaviours - i.e. the implicit nickname
768
# then this should be refactored to introduce a tested proxy branch
769
# and a subclass of that for use in overriding clone() and ....
771
result.clone = self._make_reference_clone_function(result)
775
# formats which have no format string are not discoverable
776
# and not independently creatable, so are not registered.
777
__default_format = BzrBranchFormat5()
778
BranchFormat.register_format(__default_format)
779
BranchFormat.register_format(BranchReferenceFormat())
780
BranchFormat.set_default_format(__default_format)
781
_legacy_formats = [BzrBranchFormat4(),
784
class BzrBranch(Branch):
785
"""A branch stored in the actual filesystem.
787
Note that it's "local" in the context of the filesystem; it doesn't
788
really matter if it's on an nfs/smb/afs/coda/... share, as long as
789
it's writable, and can be accessed via the normal filesystem API.
792
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
793
relax_version_check=DEPRECATED_PARAMETER, _format=None,
794
_control_files=None, a_bzrdir=None, _repository=None):
795
"""Create new branch object at a particular location.
797
transport -- A Transport object, defining how to access files.
799
init -- If True, create new control files in a previously
800
unversioned directory. If False, the branch must already
803
relax_version_check -- If true, the usual check for the branch
804
version is not applied. This is intended only for
805
upgrade/recovery type use; it's not guaranteed that
806
all operations will work on old format branches.
809
self.bzrdir = bzrdir.BzrDir.open(transport.base)
811
self.bzrdir = a_bzrdir
812
self._transport = self.bzrdir.transport.clone('..')
813
self._base = self._transport.base
814
self._format = _format
815
if _control_files is None:
816
raise BzrBadParameterMissing('_control_files')
817
self.control_files = _control_files
818
if deprecated_passed(init):
819
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
820
"deprecated as of bzr 0.8. Please use Branch.create().",
824
# this is slower than before deprecation, oh well never mind.
826
self._initialize(transport.base)
827
self._check_format(_format)
828
if deprecated_passed(relax_version_check):
829
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
830
"relax_version_check parameter is deprecated as of bzr 0.8. "
831
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
835
if (not relax_version_check
836
and not self._format.is_supported()):
837
raise errors.UnsupportedFormatError(
838
'sorry, branch format %r not supported' % fmt,
839
['use a different bzr version',
840
'or remove the .bzr directory'
841
' and "bzr init" again'])
842
if deprecated_passed(transport):
843
warn("BzrBranch.__init__(transport=XXX...): The transport "
844
"parameter is deprecated as of bzr 0.8. "
845
"Please use Branch.open, or bzrdir.open_branch().",
848
self.repository = _repository
851
return '%s(%r)' % (self.__class__.__name__, self.base)
856
# TODO: It might be best to do this somewhere else,
857
# but it is nice for a Branch object to automatically
858
# cache it's information.
859
# Alternatively, we could have the Transport objects cache requests
860
# See the earlier discussion about how major objects (like Branch)
861
# should never expect their __del__ function to run.
862
# XXX: cache_root seems to be unused, 2006-01-13 mbp
863
if hasattr(self, 'cache_root') and self.cache_root is not None:
865
shutil.rmtree(self.cache_root)
868
self.cache_root = None
873
base = property(_get_base, doc="The URL for the root of this branch.")
875
def _finish_transaction(self):
876
"""Exit the current transaction."""
877
return self.control_files._finish_transaction()
879
def get_transaction(self):
880
"""Return the current active transaction.
882
If no transaction is active, this returns a passthrough object
883
for which all data is immediately flushed and no caching happens.
885
# this is an explicit function so that we can do tricky stuff
886
# when the storage in rev_storage is elsewhere.
887
# we probably need to hook the two 'lock a location' and
888
# 'have a transaction' together more delicately, so that
889
# we can have two locks (branch and storage) and one transaction
890
# ... and finishing the transaction unlocks both, but unlocking
891
# does not. - RBC 20051121
892
return self.control_files.get_transaction()
894
def _set_transaction(self, transaction):
895
"""Set a new active transaction."""
896
return self.control_files._set_transaction(transaction)
898
def abspath(self, name):
899
"""See Branch.abspath."""
900
return self.control_files._transport.abspath(name)
902
def _check_format(self, format):
903
"""Identify the branch format if needed.
905
The format is stored as a reference to the format object in
906
self._format for code that needs to check it later.
908
The format parameter is either None or the branch format class
909
used to open this branch.
911
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
914
format = BzrBranchFormat.find_format(self.bzrdir)
915
self._format = format
916
mutter("got branch format %s", self._format)
919
def get_root_id(self):
920
"""See Branch.get_root_id."""
921
tree = self.repository.revision_tree(self.last_revision())
922
return tree.inventory.root.file_id
924
def lock_write(self):
925
# TODO: test for failed two phase locks. This is known broken.
926
self.control_files.lock_write()
927
self.repository.lock_write()
930
# TODO: test for failed two phase locks. This is known broken.
931
self.control_files.lock_read()
932
self.repository.lock_read()
935
# TODO: test for failed two phase locks. This is known broken.
936
self.repository.unlock()
937
self.control_files.unlock()
939
def peek_lock_mode(self):
940
if self.control_files._lock_count == 0:
943
return self.control_files._lock_mode
946
def print_file(self, file, revision_id):
947
"""See Branch.print_file."""
948
return self.repository.print_file(file, revision_id)
951
def append_revision(self, *revision_ids):
952
"""See Branch.append_revision."""
953
for revision_id in revision_ids:
954
mutter("add {%s} to revision-history" % revision_id)
955
rev_history = self.revision_history()
956
rev_history.extend(revision_ids)
957
self.set_revision_history(rev_history)
960
def set_revision_history(self, rev_history):
961
"""See Branch.set_revision_history."""
962
self.control_files.put_utf8(
963
'revision-history', '\n'.join(rev_history))
964
transaction = self.get_transaction()
965
history = transaction.map.find_revision_history()
966
if history is not None:
967
# update the revision history in the identity map.
968
history[:] = list(rev_history)
969
# this call is disabled because revision_history is
970
# not really an object yet, and the transaction is for objects.
971
# transaction.register_dirty(history)
973
transaction.map.add_revision_history(rev_history)
974
# this call is disabled because revision_history is
975
# not really an object yet, and the transaction is for objects.
976
# transaction.register_clean(history)
978
def get_revision_delta(self, revno):
979
"""Return the delta for one revision.
981
The delta is relative to its mainline predecessor, or the
982
empty tree for revision 1.
984
assert isinstance(revno, int)
985
rh = self.revision_history()
986
if not (1 <= revno <= len(rh)):
987
raise InvalidRevisionNumber(revno)
989
# revno is 1-based; list is 0-based
991
new_tree = self.repository.revision_tree(rh[revno-1])
993
old_tree = EmptyTree()
995
old_tree = self.repository.revision_tree(rh[revno-2])
996
return compare_trees(old_tree, new_tree)
999
def revision_history(self):
1000
"""See Branch.revision_history."""
1001
transaction = self.get_transaction()
1002
history = transaction.map.find_revision_history()
1003
if history is not None:
1004
mutter("cache hit for revision-history in %s", self)
1005
return list(history)
1006
history = [l.rstrip('\r\n') for l in
1007
self.control_files.get_utf8('revision-history').readlines()]
1008
transaction.map.add_revision_history(history)
1009
# this call is disabled because revision_history is
1010
# not really an object yet, and the transaction is for objects.
1011
# transaction.register_clean(history, precious=True)
1012
return list(history)
1014
def update_revisions(self, other, stop_revision=None):
1015
"""See Branch.update_revisions."""
1016
if stop_revision is None:
1017
stop_revision = other.last_revision()
1018
### Should this be checking is_ancestor instead of revision_history?
1019
if (stop_revision is not None and
1020
stop_revision in self.revision_history()):
1022
self.fetch(other, stop_revision)
1023
pullable_revs = self.pullable_revisions(other, stop_revision)
1024
if len(pullable_revs) > 0:
1025
self.append_revision(*pullable_revs)
1027
def pullable_revisions(self, other, stop_revision):
1028
other_revno = other.revision_id_to_revno(stop_revision)
1030
return self.missing_revisions(other, other_revno)
1031
except DivergedBranches, e:
1033
pullable_revs = get_intervening_revisions(self.last_revision(),
1036
assert self.last_revision() not in pullable_revs
1037
return pullable_revs
1038
except bzrlib.errors.NotAncestor:
1039
if is_ancestor(self.last_revision(), stop_revision, self):
1044
def basis_tree(self):
1045
"""See Branch.basis_tree."""
1046
return self.repository.revision_tree(self.last_revision())
1048
@deprecated_method(zero_eight)
1049
def working_tree(self):
1050
"""Create a Working tree object for this branch."""
1051
from bzrlib.workingtree import WorkingTree
1052
from bzrlib.transport.local import LocalTransport
1053
if (self.base.find('://') != -1 or
1054
not isinstance(self._transport, LocalTransport)):
1055
raise NoWorkingTree(self.base)
1056
return self.bzrdir.open_workingtree()
1059
def pull(self, source, overwrite=False, stop_revision=None):
1060
"""See Branch.pull."""
1063
old_count = len(self.revision_history())
1065
self.update_revisions(source,stop_revision)
1066
except DivergedBranches:
1070
self.set_revision_history(source.revision_history())
1071
new_count = len(self.revision_history())
1072
return new_count - old_count
1076
def get_parent(self):
1077
"""See Branch.get_parent."""
1079
_locs = ['parent', 'pull', 'x-pull']
1082
return self.control_files.get_utf8(l).read().strip('\n')
1087
def get_push_location(self):
1088
"""See Branch.get_push_location."""
1089
config = bzrlib.config.BranchConfig(self)
1090
push_loc = config.get_user_option('push_location')
1093
def set_push_location(self, location):
1094
"""See Branch.set_push_location."""
1095
config = bzrlib.config.LocationConfig(self.base)
1096
config.set_user_option('push_location', location)
1099
def set_parent(self, url):
1100
"""See Branch.set_parent."""
1101
# TODO: Maybe delete old location files?
1102
# URLs should never be unicode, even on the local fs,
1103
# FIXUP this and get_parent in a future branch format bump:
1104
# read and rewrite the file, and have the new format code read
1105
# using .get not .get_utf8. RBC 20060125
1106
self.control_files.put_utf8('parent', url + '\n')
1108
def tree_config(self):
1109
return TreeConfig(self)
1112
class BzrBranch5(BzrBranch):
1113
"""A format 5 branch. This supports new features over plan branches.
1115
It has support for a master_branch which is the data for bound branches.
1123
super(BzrBranch5, self).__init__(_format=_format,
1124
_control_files=_control_files,
1126
_repository=_repository)
1129
def pull(self, source, overwrite=False, stop_revision=None):
1130
"""Updates branch.pull to be bound branch aware."""
1131
bound_location = self.get_bound_location()
1132
if source.base != bound_location:
1133
# not pulling from master, so we need to update master.
1134
master_branch = self.get_master_branch()
1136
master_branch.pull(source)
1137
source = master_branch
1138
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1140
def get_bound_location(self):
1142
return self.control_files.get_utf8('bound').read()[:-1]
1143
except errors.NoSuchFile:
1147
def get_master_branch(self):
1148
"""Return the branch we are bound to.
1150
:return: Either a Branch, or None
1152
This could memoise the branch, but if thats done
1153
it must be revalidated on each new lock.
1154
So for now we just dont memoise it.
1155
# RBC 20060304 review this decision.
1157
bound_loc = self.get_bound_location()
1161
return Branch.open(bound_loc)
1162
except (errors.NotBranchError, errors.ConnectionError), e:
1163
raise errors.BoundBranchConnectionFailure(
1167
def set_bound_location(self, location):
1168
"""Set the target where this branch is bound to.
1170
:param location: URL to the target branch
1173
self.control_files.put_utf8('bound', location+'\n')
1176
self.control_files._transport.delete('bound')
1182
def bind(self, other):
1183
"""Bind the local branch the other branch.
1185
:param other: The branch to bind to
1188
# TODO: jam 20051230 Consider checking if the target is bound
1189
# It is debatable whether you should be able to bind to
1190
# a branch which is itself bound.
1191
# Committing is obviously forbidden,
1192
# but binding itself may not be.
1193
# Since we *have* to check at commit time, we don't
1194
# *need* to check here
1197
# we are now equal to or a suffix of other.
1199
# Since we have 'pulled' from the remote location,
1200
# now we should try to pull in the opposite direction
1201
# in case the local tree has more revisions than the
1203
# There may be a different check you could do here
1204
# rather than actually trying to install revisions remotely.
1205
# TODO: capture an exception which indicates the remote branch
1207
# If it is up-to-date, this probably should not be a failure
1209
# lock other for write so the revision-history syncing cannot race
1213
# if this does not error, other now has the same last rev we do
1214
# it can only error if the pull from other was concurrent with
1215
# a commit to other from someone else.
1217
# until we ditch revision-history, we need to sync them up:
1218
self.set_revision_history(other.revision_history())
1219
# now other and self are up to date with each other and have the
1220
# same revision-history.
1224
self.set_bound_location(other.base)
1228
"""If bound, unbind"""
1229
return self.set_bound_location(None)
1233
"""Synchronise this branch with the master branch if any.
1235
:return: None or the last_revision that was pivoted out during the
1238
master = self.get_master_branch()
1239
if master is not None:
1240
old_tip = self.last_revision()
1241
self.pull(master, overwrite=True)
1242
if old_tip in self.repository.get_ancestry(self.last_revision()):
1248
class BranchTestProviderAdapter(object):
1249
"""A tool to generate a suite testing multiple branch formats at once.
1251
This is done by copying the test once for each transport and injecting
1252
the transport_server, transport_readonly_server, and branch_format
1253
classes into each copy. Each copy is also given a new id() to make it
1257
def __init__(self, transport_server, transport_readonly_server, formats):
1258
self._transport_server = transport_server
1259
self._transport_readonly_server = transport_readonly_server
1260
self._formats = formats
1262
def adapt(self, test):
1263
result = TestSuite()
1264
for branch_format, bzrdir_format in self._formats:
1265
new_test = deepcopy(test)
1266
new_test.transport_server = self._transport_server
1267
new_test.transport_readonly_server = self._transport_readonly_server
1268
new_test.bzrdir_format = bzrdir_format
1269
new_test.branch_format = branch_format
1270
def make_new_test_id():
1271
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1272
return lambda: new_id
1273
new_test.id = make_new_test_id()
1274
result.addTest(new_test)
1278
######################################################################
1282
@deprecated_function(zero_eight)
1283
def ScratchBranch(*args, **kwargs):
1284
"""See bzrlib.bzrdir.ScratchDir."""
1285
d = ScratchDir(*args, **kwargs)
1286
return d.open_branch()
1289
@deprecated_function(zero_eight)
1290
def is_control_file(*args, **kwargs):
1291
"""See bzrlib.workingtree.is_control_file."""
1292
return bzrlib.workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
