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
20
from unittest import TestSuite
21
from warnings import warn
24
from bzrlib import bzrdir, errors, lockdir, osutils, revision, \
28
from bzrlib.config import TreeConfig
29
from bzrlib.decorators import needs_read_lock, needs_write_lock
30
import bzrlib.errors as errors
31
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
32
HistoryMissing, InvalidRevisionId,
33
InvalidRevisionNumber, LockError, NoSuchFile,
34
NoSuchRevision, NoWorkingTree, NotVersionedError,
35
NotBranchError, UninitializableFormat,
36
UnlistableStore, UnlistableBranch,
38
from bzrlib.lockable_files import LockableFiles, TransportLock
39
from bzrlib.symbol_versioning import (deprecated_function,
43
zero_eight, zero_nine,
45
from bzrlib.trace import mutter, note
48
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
49
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
50
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
53
# TODO: Maybe include checks for common corruption of newlines, etc?
55
# TODO: Some operations like log might retrieve the same revisions
56
# repeatedly to calculate deltas. We could perhaps have a weakref
57
# cache in memory to make this faster. In general anything can be
58
# cached in memory between lock and unlock operations. .. nb thats
59
# what the transaction identity map provides
62
######################################################################
66
"""Branch holding a history of revisions.
69
Base directory/url of the branch.
71
# this is really an instance variable - FIXME move it there
75
def __init__(self, *ignored, **ignored_too):
76
raise NotImplementedError('The Branch class is abstract')
79
"""Break a lock if one is present from another instance.
81
Uses the ui factory to ask for confirmation if the lock may be from
84
This will probe the repository for its lock as well.
86
self.control_files.break_lock()
87
self.repository.break_lock()
88
master = self.get_master_branch()
89
if master is not None:
93
@deprecated_method(zero_eight)
94
def open_downlevel(base):
95
"""Open a branch which may be of an old format."""
96
return Branch.open(base, _unsupported=True)
99
def open(base, _unsupported=False):
100
"""Open the repository rooted at base.
102
For instance, if the repository is at URL/.bzr/repository,
103
Repository.open(URL) -> a Repository instance.
105
control = bzrdir.BzrDir.open(base, _unsupported)
106
return control.open_branch(_unsupported)
109
def open_containing(url):
110
"""Open an existing branch which contains url.
112
This probes for a branch at url, and searches upwards from there.
114
Basically we keep looking up until we find the control directory or
115
run into the root. If there isn't one, raises NotBranchError.
116
If there is one and it is either an unrecognised format or an unsupported
117
format, UnknownFormatError or UnsupportedFormatError are raised.
118
If there is one, it is returned, along with the unused portion of url.
120
control, relpath = bzrdir.BzrDir.open_containing(url)
121
return control.open_branch(), relpath
124
@deprecated_function(zero_eight)
125
def initialize(base):
126
"""Create a new working tree and branch, rooted at 'base' (url)
128
NOTE: This will soon be deprecated in favour of creation
131
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
133
def setup_caching(self, cache_root):
134
"""Subclasses that care about caching should override this, and set
135
up cached stores located under cache_root.
137
# seems to be unused, 2006-01-13 mbp
138
warn('%s is deprecated' % self.setup_caching)
139
self.cache_root = cache_root
141
def get_config(self):
142
return bzrlib.config.BranchConfig(self)
145
return self.get_config().get_nickname()
147
def _set_nick(self, nick):
148
self.get_config().set_user_option('nickname', nick)
150
nick = property(_get_nick, _set_nick)
153
raise NotImplementedError('is_locked is abstract')
155
def lock_write(self):
156
raise NotImplementedError('lock_write is abstract')
159
raise NotImplementedError('lock_read is abstract')
162
raise NotImplementedError('unlock is abstract')
164
def peek_lock_mode(self):
165
"""Return lock mode for the Branch: 'r', 'w' or None"""
166
raise NotImplementedError(self.peek_lock_mode)
168
def get_physical_lock_status(self):
169
raise NotImplementedError('get_physical_lock_status is abstract')
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:
202
nested_pb = ui.ui_factory.nested_progress_bar()
207
from_branch.lock_read()
209
if last_revision is None:
210
pb.update('get source history')
211
from_history = from_branch.revision_history()
213
last_revision = from_history[-1]
215
# no history in the source branch
216
last_revision = revision.NULL_REVISION
217
return self.repository.fetch(from_branch.repository,
218
revision_id=last_revision,
221
if nested_pb is not None:
225
def get_bound_location(self):
226
"""Return the URL of the branch we are bound to.
228
Older format branches cannot bind, please be sure to use a metadir
233
def get_commit_builder(self, parents, config=None, timestamp=None,
234
timezone=None, committer=None, revprops=None,
236
"""Obtain a CommitBuilder for this branch.
238
:param parents: Revision ids of the parents of the new revision.
239
:param config: Optional configuration to use.
240
:param timestamp: Optional timestamp recorded for commit.
241
:param timezone: Optional timezone for timestamp.
242
:param committer: Optional committer to set for commit.
243
:param revprops: Optional dictionary of revision properties.
244
:param revision_id: Optional revision id.
248
config = self.get_config()
250
return self.repository.get_commit_builder(self, parents, config,
251
timestamp, timezone, committer, revprops, revision_id)
253
def get_master_branch(self):
254
"""Return the branch we are bound to.
256
:return: Either a Branch, or None
260
def get_revision_delta(self, revno):
261
"""Return the delta for one revision.
263
The delta is relative to its mainline predecessor, or the
264
empty tree for revision 1.
266
assert isinstance(revno, int)
267
rh = self.revision_history()
268
if not (1 <= revno <= len(rh)):
269
raise InvalidRevisionNumber(revno)
270
return self.repository.get_revision_delta(rh[revno-1])
272
def get_root_id(self):
273
"""Return the id of this branches root"""
274
raise NotImplementedError('get_root_id is abstract')
276
def print_file(self, file, revision_id):
277
"""Print `file` to stdout."""
278
raise NotImplementedError('print_file is abstract')
280
def append_revision(self, *revision_ids):
281
raise NotImplementedError('append_revision is abstract')
283
def set_revision_history(self, rev_history):
284
raise NotImplementedError('set_revision_history is abstract')
286
def revision_history(self):
287
"""Return sequence of revision hashes on to this branch."""
288
raise NotImplementedError('revision_history is abstract')
291
"""Return current revision number for this branch.
293
That is equivalent to the number of revisions committed to
296
return len(self.revision_history())
299
"""Older format branches cannot bind or unbind."""
300
raise errors.UpgradeRequired(self.base)
302
def last_revision(self):
303
"""Return last patch hash, or None if no history."""
304
ph = self.revision_history()
310
def missing_revisions(self, other, stop_revision=None):
311
"""Return a list of new revisions that would perfectly fit.
313
If self and other have not diverged, return a list of the revisions
314
present in other, but missing from self.
316
self_history = self.revision_history()
317
self_len = len(self_history)
318
other_history = other.revision_history()
319
other_len = len(other_history)
320
common_index = min(self_len, other_len) -1
321
if common_index >= 0 and \
322
self_history[common_index] != other_history[common_index]:
323
raise DivergedBranches(self, other)
325
if stop_revision is None:
326
stop_revision = other_len
328
assert isinstance(stop_revision, int)
329
if stop_revision > other_len:
330
raise errors.NoSuchRevision(self, stop_revision)
331
return other_history[self_len:stop_revision]
333
def update_revisions(self, other, stop_revision=None):
334
"""Pull in new perfect-fit revisions.
336
:param other: Another Branch to pull from
337
:param stop_revision: Updated until the given revision
340
raise NotImplementedError('update_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 compatibility, 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 compatibility 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)
528
"""Check consistency of the branch.
530
In particular this checks that revisions given in the revision-history
531
do actually match up in the revision graph, and that they're all
532
present in the repository.
534
Callers will typically also want to check the repository.
536
:return: A BranchCheckResult.
538
mainline_parent_id = None
539
for revision_id in self.revision_history():
541
revision = self.repository.get_revision(revision_id)
542
except errors.NoSuchRevision, e:
543
raise errors.BzrCheckError("mainline revision {%s} not in repository"
545
# In general the first entry on the revision history has no parents.
546
# But it's not illegal for it to have parents listed; this can happen
547
# in imports from Arch when the parents weren't reachable.
548
if mainline_parent_id is not None:
549
if mainline_parent_id not in revision.parent_ids:
550
raise errors.BzrCheckError("previous revision {%s} not listed among "
552
% (mainline_parent_id, revision_id))
553
mainline_parent_id = revision_id
554
return BranchCheckResult(self)
557
class BranchFormat(object):
558
"""An encapsulation of the initialization and open routines for a format.
560
Formats provide three things:
561
* An initialization routine,
565
Formats are placed in an dict by their format string for reference
566
during branch opening. Its not required that these be instances, they
567
can be classes themselves with class methods - it simply depends on
568
whether state is needed for a given format or not.
570
Once a format is deprecated, just deprecate the initialize and open
571
methods on the format class. Do not deprecate the object, as the
572
object will be created every time regardless.
575
_default_format = None
576
"""The default format used for new branches."""
579
"""The known formats."""
582
def find_format(klass, a_bzrdir):
583
"""Return the format for the branch object in a_bzrdir."""
585
transport = a_bzrdir.get_branch_transport(None)
586
format_string = transport.get("format").read()
587
return klass._formats[format_string]
589
raise NotBranchError(path=transport.base)
591
raise errors.UnknownFormatError(format=format_string)
594
def get_default_format(klass):
595
"""Return the current default format."""
596
return klass._default_format
598
def get_format_string(self):
599
"""Return the ASCII format string that identifies this format."""
600
raise NotImplementedError(self.get_format_string)
602
def get_format_description(self):
603
"""Return the short format description for this format."""
604
raise NotImplementedError(self.get_format_string)
606
def initialize(self, a_bzrdir):
607
"""Create a branch of this format in a_bzrdir."""
608
raise NotImplementedError(self.initialize)
610
def is_supported(self):
611
"""Is this format supported?
613
Supported formats can be initialized and opened.
614
Unsupported formats may not support initialization or committing or
615
some other features depending on the reason for not being supported.
619
def open(self, a_bzrdir, _found=False):
620
"""Return the branch object for a_bzrdir
622
_found is a private parameter, do not use it. It is used to indicate
623
if format probing has already be done.
625
raise NotImplementedError(self.open)
628
def register_format(klass, format):
629
klass._formats[format.get_format_string()] = format
632
def set_default_format(klass, format):
633
klass._default_format = format
636
def unregister_format(klass, format):
637
assert klass._formats[format.get_format_string()] is format
638
del klass._formats[format.get_format_string()]
641
return self.get_format_string().rstrip()
644
class BzrBranchFormat4(BranchFormat):
645
"""Bzr branch format 4.
648
- a revision-history file.
649
- a branch-lock lock file [ to be shared with the bzrdir ]
652
def get_format_description(self):
653
"""See BranchFormat.get_format_description()."""
654
return "Branch format 4"
656
def initialize(self, a_bzrdir):
657
"""Create a branch of this format in a_bzrdir."""
658
mutter('creating branch in %s', a_bzrdir.transport.base)
659
branch_transport = a_bzrdir.get_branch_transport(self)
660
utf8_files = [('revision-history', ''),
663
control_files = LockableFiles(branch_transport, 'branch-lock',
665
control_files.create_lock()
666
control_files.lock_write()
668
for file, content in utf8_files:
669
control_files.put_utf8(file, content)
671
control_files.unlock()
672
return self.open(a_bzrdir, _found=True)
675
super(BzrBranchFormat4, self).__init__()
676
self._matchingbzrdir = bzrdir.BzrDirFormat6()
678
def open(self, a_bzrdir, _found=False):
679
"""Return the branch object for a_bzrdir
681
_found is a private parameter, do not use it. It is used to indicate
682
if format probing has already be done.
685
# we are being called directly and must probe.
686
raise NotImplementedError
687
return BzrBranch(_format=self,
688
_control_files=a_bzrdir._control_files,
690
_repository=a_bzrdir.open_repository())
693
return "Bazaar-NG branch format 4"
696
class BzrBranchFormat5(BranchFormat):
697
"""Bzr branch format 5.
700
- a revision-history file.
702
- a lock dir guarding the branch itself
703
- all of this stored in a branch/ subdirectory
704
- works with shared repositories.
706
This format is new in bzr 0.8.
709
def get_format_string(self):
710
"""See BranchFormat.get_format_string()."""
711
return "Bazaar-NG branch format 5\n"
713
def get_format_description(self):
714
"""See BranchFormat.get_format_description()."""
715
return "Branch format 5"
717
def initialize(self, a_bzrdir):
718
"""Create a branch of this format in a_bzrdir."""
719
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
720
branch_transport = a_bzrdir.get_branch_transport(self)
721
utf8_files = [('revision-history', ''),
724
control_files = LockableFiles(branch_transport, 'lock', lockdir.LockDir)
725
control_files.create_lock()
726
control_files.lock_write()
727
control_files.put_utf8('format', self.get_format_string())
729
for file, content in utf8_files:
730
control_files.put_utf8(file, content)
732
control_files.unlock()
733
return self.open(a_bzrdir, _found=True, )
736
super(BzrBranchFormat5, self).__init__()
737
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
739
def open(self, a_bzrdir, _found=False):
740
"""Return the branch object for a_bzrdir
742
_found is a private parameter, do not use it. It is used to indicate
743
if format probing has already be done.
746
format = BranchFormat.find_format(a_bzrdir)
747
assert format.__class__ == self.__class__
748
transport = a_bzrdir.get_branch_transport(None)
749
control_files = LockableFiles(transport, 'lock', lockdir.LockDir)
750
return BzrBranch5(_format=self,
751
_control_files=control_files,
753
_repository=a_bzrdir.find_repository())
756
return "Bazaar-NG Metadir branch format 5"
759
class BranchReferenceFormat(BranchFormat):
760
"""Bzr branch reference format.
762
Branch references are used in implementing checkouts, they
763
act as an alias to the real branch which is at some other url.
770
def get_format_string(self):
771
"""See BranchFormat.get_format_string()."""
772
return "Bazaar-NG Branch Reference Format 1\n"
774
def get_format_description(self):
775
"""See BranchFormat.get_format_description()."""
776
return "Checkout reference format 1"
778
def initialize(self, a_bzrdir, target_branch=None):
779
"""Create a branch of this format in a_bzrdir."""
780
if target_branch is None:
781
# this format does not implement branch itself, thus the implicit
782
# creation contract must see it as uninitializable
783
raise errors.UninitializableFormat(self)
784
mutter('creating branch reference in %s', a_bzrdir.transport.base)
785
branch_transport = a_bzrdir.get_branch_transport(self)
786
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
787
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
788
branch_transport.put('format', StringIO(self.get_format_string()))
789
return self.open(a_bzrdir, _found=True)
792
super(BranchReferenceFormat, self).__init__()
793
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
795
def _make_reference_clone_function(format, a_branch):
796
"""Create a clone() routine for a branch dynamically."""
797
def clone(to_bzrdir, revision_id=None):
798
"""See Branch.clone()."""
799
return format.initialize(to_bzrdir, a_branch)
800
# cannot obey revision_id limits when cloning a reference ...
801
# FIXME RBC 20060210 either nuke revision_id for clone, or
802
# emit some sort of warning/error to the caller ?!
805
def open(self, a_bzrdir, _found=False):
806
"""Return the branch that the branch reference in a_bzrdir points at.
808
_found is a private parameter, do not use it. It is used to indicate
809
if format probing has already be done.
812
format = BranchFormat.find_format(a_bzrdir)
813
assert format.__class__ == self.__class__
814
transport = a_bzrdir.get_branch_transport(None)
815
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
816
result = real_bzrdir.open_branch()
817
# this changes the behaviour of result.clone to create a new reference
818
# rather than a copy of the content of the branch.
819
# I did not use a proxy object because that needs much more extensive
820
# testing, and we are only changing one behaviour at the moment.
821
# If we decide to alter more behaviours - i.e. the implicit nickname
822
# then this should be refactored to introduce a tested proxy branch
823
# and a subclass of that for use in overriding clone() and ....
825
result.clone = self._make_reference_clone_function(result)
829
# formats which have no format string are not discoverable
830
# and not independently creatable, so are not registered.
831
__default_format = BzrBranchFormat5()
832
BranchFormat.register_format(__default_format)
833
BranchFormat.register_format(BranchReferenceFormat())
834
BranchFormat.set_default_format(__default_format)
835
_legacy_formats = [BzrBranchFormat4(),
838
class BzrBranch(Branch):
839
"""A branch stored in the actual filesystem.
841
Note that it's "local" in the context of the filesystem; it doesn't
842
really matter if it's on an nfs/smb/afs/coda/... share, as long as
843
it's writable, and can be accessed via the normal filesystem API.
846
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
847
relax_version_check=DEPRECATED_PARAMETER, _format=None,
848
_control_files=None, a_bzrdir=None, _repository=None):
849
"""Create new branch object at a particular location.
851
transport -- A Transport object, defining how to access files.
853
init -- If True, create new control files in a previously
854
unversioned directory. If False, the branch must already
857
relax_version_check -- If true, the usual check for the branch
858
version is not applied. This is intended only for
859
upgrade/recovery type use; it's not guaranteed that
860
all operations will work on old format branches.
863
self.bzrdir = bzrdir.BzrDir.open(transport.base)
865
self.bzrdir = a_bzrdir
866
self._transport = self.bzrdir.transport.clone('..')
867
self._base = self._transport.base
868
self._format = _format
869
if _control_files is None:
870
raise ValueError('BzrBranch _control_files is None')
871
self.control_files = _control_files
872
if deprecated_passed(init):
873
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
874
"deprecated as of bzr 0.8. Please use Branch.create().",
878
# this is slower than before deprecation, oh well never mind.
880
self._initialize(transport.base)
881
self._check_format(_format)
882
if deprecated_passed(relax_version_check):
883
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
884
"relax_version_check parameter is deprecated as of bzr 0.8. "
885
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
889
if (not relax_version_check
890
and not self._format.is_supported()):
891
raise errors.UnsupportedFormatError(format=fmt)
892
if deprecated_passed(transport):
893
warn("BzrBranch.__init__(transport=XXX...): The transport "
894
"parameter is deprecated as of bzr 0.8. "
895
"Please use Branch.open, or bzrdir.open_branch().",
898
self.repository = _repository
901
return '%s(%r)' % (self.__class__.__name__, self.base)
906
# TODO: It might be best to do this somewhere else,
907
# but it is nice for a Branch object to automatically
908
# cache it's information.
909
# Alternatively, we could have the Transport objects cache requests
910
# See the earlier discussion about how major objects (like Branch)
911
# should never expect their __del__ function to run.
912
# XXX: cache_root seems to be unused, 2006-01-13 mbp
913
if hasattr(self, 'cache_root') and self.cache_root is not None:
915
osutils.rmtree(self.cache_root)
918
self.cache_root = None
923
base = property(_get_base, doc="The URL for the root of this branch.")
925
def _finish_transaction(self):
926
"""Exit the current transaction."""
927
return self.control_files._finish_transaction()
929
def get_transaction(self):
930
"""Return the current active transaction.
932
If no transaction is active, this returns a passthrough object
933
for which all data is immediately flushed and no caching happens.
935
# this is an explicit function so that we can do tricky stuff
936
# when the storage in rev_storage is elsewhere.
937
# we probably need to hook the two 'lock a location' and
938
# 'have a transaction' together more delicately, so that
939
# we can have two locks (branch and storage) and one transaction
940
# ... and finishing the transaction unlocks both, but unlocking
941
# does not. - RBC 20051121
942
return self.control_files.get_transaction()
944
def _set_transaction(self, transaction):
945
"""Set a new active transaction."""
946
return self.control_files._set_transaction(transaction)
948
def abspath(self, name):
949
"""See Branch.abspath."""
950
return self.control_files._transport.abspath(name)
952
def _check_format(self, format):
953
"""Identify the branch format if needed.
955
The format is stored as a reference to the format object in
956
self._format for code that needs to check it later.
958
The format parameter is either None or the branch format class
959
used to open this branch.
961
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
964
format = BranchFormat.find_format(self.bzrdir)
965
self._format = format
966
mutter("got branch format %s", self._format)
969
def get_root_id(self):
970
"""See Branch.get_root_id."""
971
tree = self.repository.revision_tree(self.last_revision())
972
return tree.inventory.root.file_id
975
return self.control_files.is_locked()
977
def lock_write(self):
978
# TODO: test for failed two phase locks. This is known broken.
979
self.control_files.lock_write()
980
self.repository.lock_write()
983
# TODO: test for failed two phase locks. This is known broken.
984
self.control_files.lock_read()
985
self.repository.lock_read()
988
# TODO: test for failed two phase locks. This is known broken.
990
self.repository.unlock()
992
self.control_files.unlock()
994
def peek_lock_mode(self):
995
if self.control_files._lock_count == 0:
998
return self.control_files._lock_mode
1000
def get_physical_lock_status(self):
1001
return self.control_files.get_physical_lock_status()
1004
def print_file(self, file, revision_id):
1005
"""See Branch.print_file."""
1006
return self.repository.print_file(file, revision_id)
1009
def append_revision(self, *revision_ids):
1010
"""See Branch.append_revision."""
1011
for revision_id in revision_ids:
1012
mutter("add {%s} to revision-history" % revision_id)
1013
rev_history = self.revision_history()
1014
rev_history.extend(revision_ids)
1015
self.set_revision_history(rev_history)
1018
def set_revision_history(self, rev_history):
1019
"""See Branch.set_revision_history."""
1020
self.control_files.put_utf8(
1021
'revision-history', '\n'.join(rev_history))
1022
transaction = self.get_transaction()
1023
history = transaction.map.find_revision_history()
1024
if history is not None:
1025
# update the revision history in the identity map.
1026
history[:] = list(rev_history)
1027
# this call is disabled because revision_history is
1028
# not really an object yet, and the transaction is for objects.
1029
# transaction.register_dirty(history)
1031
transaction.map.add_revision_history(rev_history)
1032
# this call is disabled because revision_history is
1033
# not really an object yet, and the transaction is for objects.
1034
# transaction.register_clean(history)
1037
def revision_history(self):
1038
"""See Branch.revision_history."""
1039
transaction = self.get_transaction()
1040
history = transaction.map.find_revision_history()
1041
if history is not None:
1042
mutter("cache hit for revision-history in %s", self)
1043
return list(history)
1044
history = [l.rstrip('\r\n') for l in
1045
self.control_files.get_utf8('revision-history').readlines()]
1046
transaction.map.add_revision_history(history)
1047
# this call is disabled because revision_history is
1048
# not really an object yet, and the transaction is for objects.
1049
# transaction.register_clean(history, precious=True)
1050
return list(history)
1053
def generate_revision_history(self, revision_id, last_rev=None,
1055
"""Create a new revision history that will finish with revision_id.
1057
:param revision_id: the new tip to use.
1058
:param last_rev: The previous last_revision. If not None, then this
1059
must be a ancestory of revision_id, or DivergedBranches is raised.
1060
:param other_branch: The other branch that DivergedBranches should
1061
raise with respect to.
1063
# stop_revision must be a descendant of last_revision
1064
stop_graph = self.repository.get_revision_graph(revision_id)
1065
if last_rev is not None and last_rev not in stop_graph:
1066
# our previous tip is not merged into stop_revision
1067
raise errors.DivergedBranches(self, other_branch)
1068
# make a new revision history from the graph
1069
current_rev_id = revision_id
1071
while current_rev_id not in (None, revision.NULL_REVISION):
1072
new_history.append(current_rev_id)
1073
current_rev_id_parents = stop_graph[current_rev_id]
1075
current_rev_id = current_rev_id_parents[0]
1077
current_rev_id = None
1078
new_history.reverse()
1079
self.set_revision_history(new_history)
1082
def update_revisions(self, other, stop_revision=None):
1083
"""See Branch.update_revisions."""
1086
if stop_revision is None:
1087
stop_revision = other.last_revision()
1088
if stop_revision is None:
1089
# if there are no commits, we're done.
1091
# whats the current last revision, before we fetch [and change it
1093
last_rev = self.last_revision()
1094
# we fetch here regardless of whether we need to so that we pickup
1096
self.fetch(other, stop_revision)
1097
my_ancestry = self.repository.get_ancestry(last_rev)
1098
if stop_revision in my_ancestry:
1099
# last_revision is a descendant of stop_revision
1101
self.generate_revision_history(stop_revision, last_rev=last_rev,
1106
def basis_tree(self):
1107
"""See Branch.basis_tree."""
1108
return self.repository.revision_tree(self.last_revision())
1110
@deprecated_method(zero_eight)
1111
def working_tree(self):
1112
"""Create a Working tree object for this branch."""
1114
from bzrlib.transport.local import LocalTransport
1115
if (self.base.find('://') != -1 or
1116
not isinstance(self._transport, LocalTransport)):
1117
raise NoWorkingTree(self.base)
1118
return self.bzrdir.open_workingtree()
1121
def pull(self, source, overwrite=False, stop_revision=None):
1122
"""See Branch.pull."""
1125
old_count = len(self.revision_history())
1127
self.update_revisions(source,stop_revision)
1128
except DivergedBranches:
1132
self.set_revision_history(source.revision_history())
1133
new_count = len(self.revision_history())
1134
return new_count - old_count
1138
def get_parent(self):
1139
"""See Branch.get_parent."""
1141
_locs = ['parent', 'pull', 'x-pull']
1142
assert self.base[-1] == '/'
1145
parent = self.control_files.get(l).read().strip('\n')
1148
# This is an old-format absolute path to a local branch
1149
# turn it into a url
1150
if parent.startswith('/'):
1151
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1152
return urlutils.join(self.base[:-1], parent)
1155
def get_push_location(self):
1156
"""See Branch.get_push_location."""
1157
push_loc = self.get_config().get_user_option('push_location')
1160
def set_push_location(self, location):
1161
"""See Branch.set_push_location."""
1162
self.get_config().set_user_option('push_location', location,
1166
def set_parent(self, url):
1167
"""See Branch.set_parent."""
1168
# TODO: Maybe delete old location files?
1169
# URLs should never be unicode, even on the local fs,
1170
# FIXUP this and get_parent in a future branch format bump:
1171
# read and rewrite the file, and have the new format code read
1172
# using .get not .get_utf8. RBC 20060125
1174
self.control_files._transport.delete('parent')
1176
if isinstance(url, unicode):
1178
url = url.encode('ascii')
1179
except UnicodeEncodeError:
1180
raise bzrlib.errors.InvalidURL(url,
1181
"Urls must be 7-bit ascii, "
1182
"use bzrlib.urlutils.escape")
1184
url = urlutils.relative_url(self.base, url)
1185
self.control_files.put('parent', url + '\n')
1187
@deprecated_function(zero_nine)
1188
def tree_config(self):
1189
"""DEPRECATED; call get_config instead.
1190
TreeConfig has become part of BranchConfig."""
1191
return TreeConfig(self)
1194
class BzrBranch5(BzrBranch):
1195
"""A format 5 branch. This supports new features over plan branches.
1197
It has support for a master_branch which is the data for bound branches.
1205
super(BzrBranch5, self).__init__(_format=_format,
1206
_control_files=_control_files,
1208
_repository=_repository)
1211
def pull(self, source, overwrite=False, stop_revision=None):
1212
"""Updates branch.pull to be bound branch aware."""
1213
bound_location = self.get_bound_location()
1214
if source.base != bound_location:
1215
# not pulling from master, so we need to update master.
1216
master_branch = self.get_master_branch()
1218
master_branch.pull(source)
1219
source = master_branch
1220
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1222
def get_bound_location(self):
1224
return self.control_files.get_utf8('bound').read()[:-1]
1225
except errors.NoSuchFile:
1229
def get_master_branch(self):
1230
"""Return the branch we are bound to.
1232
:return: Either a Branch, or None
1234
This could memoise the branch, but if thats done
1235
it must be revalidated on each new lock.
1236
So for now we just don't memoise it.
1237
# RBC 20060304 review this decision.
1239
bound_loc = self.get_bound_location()
1243
return Branch.open(bound_loc)
1244
except (errors.NotBranchError, errors.ConnectionError), e:
1245
raise errors.BoundBranchConnectionFailure(
1249
def set_bound_location(self, location):
1250
"""Set the target where this branch is bound to.
1252
:param location: URL to the target branch
1255
self.control_files.put_utf8('bound', location+'\n')
1258
self.control_files._transport.delete('bound')
1264
def bind(self, other):
1265
"""Bind the local branch the other branch.
1267
:param other: The branch to bind to
1270
# TODO: jam 20051230 Consider checking if the target is bound
1271
# It is debatable whether you should be able to bind to
1272
# a branch which is itself bound.
1273
# Committing is obviously forbidden,
1274
# but binding itself may not be.
1275
# Since we *have* to check at commit time, we don't
1276
# *need* to check here
1279
# we are now equal to or a suffix of other.
1281
# Since we have 'pulled' from the remote location,
1282
# now we should try to pull in the opposite direction
1283
# in case the local tree has more revisions than the
1285
# There may be a different check you could do here
1286
# rather than actually trying to install revisions remotely.
1287
# TODO: capture an exception which indicates the remote branch
1289
# If it is up-to-date, this probably should not be a failure
1291
# lock other for write so the revision-history syncing cannot race
1295
# if this does not error, other now has the same last rev we do
1296
# it can only error if the pull from other was concurrent with
1297
# a commit to other from someone else.
1299
# until we ditch revision-history, we need to sync them up:
1300
self.set_revision_history(other.revision_history())
1301
# now other and self are up to date with each other and have the
1302
# same revision-history.
1306
self.set_bound_location(other.base)
1310
"""If bound, unbind"""
1311
return self.set_bound_location(None)
1315
"""Synchronise this branch with the master branch if any.
1317
:return: None or the last_revision that was pivoted out during the
1320
master = self.get_master_branch()
1321
if master is not None:
1322
old_tip = self.last_revision()
1323
self.pull(master, overwrite=True)
1324
if old_tip in self.repository.get_ancestry(self.last_revision()):
1330
class BranchTestProviderAdapter(object):
1331
"""A tool to generate a suite testing multiple branch formats at once.
1333
This is done by copying the test once for each transport and injecting
1334
the transport_server, transport_readonly_server, and branch_format
1335
classes into each copy. Each copy is also given a new id() to make it
1339
def __init__(self, transport_server, transport_readonly_server, formats):
1340
self._transport_server = transport_server
1341
self._transport_readonly_server = transport_readonly_server
1342
self._formats = formats
1344
def adapt(self, test):
1345
result = TestSuite()
1346
for branch_format, bzrdir_format in self._formats:
1347
new_test = deepcopy(test)
1348
new_test.transport_server = self._transport_server
1349
new_test.transport_readonly_server = self._transport_readonly_server
1350
new_test.bzrdir_format = bzrdir_format
1351
new_test.branch_format = branch_format
1352
def make_new_test_id():
1353
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1354
return lambda: new_id
1355
new_test.id = make_new_test_id()
1356
result.addTest(new_test)
1360
class BranchCheckResult(object):
1361
"""Results of checking branch consistency.
1366
def __init__(self, branch):
1367
self.branch = branch
1369
def report_results(self, verbose):
1370
"""Report the check results via trace.note.
1372
:param verbose: Requests more detailed display of what was checked,
1375
note('checked branch %s format %s',
1377
self.branch._format)
1380
######################################################################
1384
@deprecated_function(zero_eight)
1385
def is_control_file(*args, **kwargs):
1386
"""See bzrlib.workingtree.is_control_file."""
1387
return bzrlib.workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
