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
import bzrlib.errors as errors
32
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
33
HistoryMissing, InvalidRevisionId,
34
InvalidRevisionNumber, LockError, NoSuchFile,
35
NoSuchRevision, NoWorkingTree, NotVersionedError,
36
NotBranchError, UninitializableFormat,
37
UnlistableStore, UnlistableBranch,
39
import bzrlib.inventory as inventory
40
from bzrlib.inventory import Inventory
41
from bzrlib.lockable_files import LockableFiles, TransportLock
42
from bzrlib.lockdir import LockDir
43
from bzrlib.osutils import (isdir, quotefn,
44
rename, splitpath, sha_file,
45
file_kind, abspath, normpath, pathjoin,
49
from bzrlib.repository import Repository
50
from bzrlib.revision import (
55
from bzrlib.store import copy_all
56
from bzrlib.symbol_versioning import *
57
from bzrlib.textui import show_status
58
from bzrlib.trace import mutter, note
59
import bzrlib.transactions as transactions
60
from bzrlib.transport import Transport, get_transport
62
import bzrlib.urlutils as urlutils
66
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
67
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
68
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
71
# TODO: Maybe include checks for common corruption of newlines, etc?
73
# TODO: Some operations like log might retrieve the same revisions
74
# repeatedly to calculate deltas. We could perhaps have a weakref
75
# cache in memory to make this faster. In general anything can be
76
# cached in memory between lock and unlock operations. .. nb thats
77
# what the transaction identity map provides
80
######################################################################
84
"""Branch holding a history of revisions.
87
Base directory/url of the branch.
89
# this is really an instance variable - FIXME move it there
93
def __init__(self, *ignored, **ignored_too):
94
raise NotImplementedError('The Branch class is abstract')
97
"""Break a lock if one is present from another instance.
99
Uses the ui factory to ask for confirmation if the lock may be from
102
This will probe the repository for its lock as well.
104
self.control_files.break_lock()
105
self.repository.break_lock()
106
master = self.get_master_branch()
107
if master is not None:
111
@deprecated_method(zero_eight)
112
def open_downlevel(base):
113
"""Open a branch which may be of an old format."""
114
return Branch.open(base, _unsupported=True)
117
def open(base, _unsupported=False):
118
"""Open the repository rooted at base.
120
For instance, if the repository is at URL/.bzr/repository,
121
Repository.open(URL) -> a Repository instance.
123
control = bzrdir.BzrDir.open(base, _unsupported)
124
return control.open_branch(_unsupported)
127
def open_containing(url):
128
"""Open an existing branch which contains url.
130
This probes for a branch at url, and searches upwards from there.
132
Basically we keep looking up until we find the control directory or
133
run into the root. If there isn't one, raises NotBranchError.
134
If there is one and it is either an unrecognised format or an unsupported
135
format, UnknownFormatError or UnsupportedFormatError are raised.
136
If there is one, it is returned, along with the unused portion of url.
138
control, relpath = bzrdir.BzrDir.open_containing(url)
139
return control.open_branch(), relpath
142
@deprecated_function(zero_eight)
143
def initialize(base):
144
"""Create a new working tree and branch, rooted at 'base' (url)
146
NOTE: This will soon be deprecated in favour of creation
149
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
151
def setup_caching(self, cache_root):
152
"""Subclasses that care about caching should override this, and set
153
up cached stores located under cache_root.
155
# seems to be unused, 2006-01-13 mbp
156
warn('%s is deprecated' % self.setup_caching)
157
self.cache_root = cache_root
160
cfg = self.tree_config()
161
return cfg.get_option(u"nickname", default=self.base.split('/')[-2])
163
def _set_nick(self, nick):
164
cfg = self.tree_config()
165
cfg.set_option(nick, "nickname")
166
assert cfg.get_option("nickname") == nick
168
nick = property(_get_nick, _set_nick)
171
raise NotImplementedError('is_locked is abstract')
173
def lock_write(self):
174
raise NotImplementedError('lock_write is abstract')
177
raise NotImplementedError('lock_read is abstract')
180
raise NotImplementedError('unlock is abstract')
182
def peek_lock_mode(self):
183
"""Return lock mode for the Branch: 'r', 'w' or None"""
184
raise NotImplementedError(self.peek_lock_mode)
186
def get_physical_lock_status(self):
187
raise NotImplementedError('get_physical_lock_status is abstract')
189
def abspath(self, name):
190
"""Return absolute filename for something in the branch
192
XXX: Robert Collins 20051017 what is this used for? why is it a branch
193
method and not a tree method.
195
raise NotImplementedError('abspath is abstract')
197
def bind(self, other):
198
"""Bind the local branch the other branch.
200
:param other: The branch to bind to
203
raise errors.UpgradeRequired(self.base)
206
def fetch(self, from_branch, last_revision=None, pb=None):
207
"""Copy revisions from from_branch into this branch.
209
:param from_branch: Where to copy from.
210
:param last_revision: What revision to stop at (None for at the end
212
:param pb: An optional progress bar to use.
214
Returns the copied revision count and the failed revisions in a tuple:
217
if self.base == from_branch.base:
220
nested_pb = bzrlib.ui.ui_factory.nested_progress_bar()
225
from_branch.lock_read()
227
if last_revision is None:
228
pb.update('get source history')
229
from_history = from_branch.revision_history()
231
last_revision = from_history[-1]
233
# no history in the source branch
234
last_revision = NULL_REVISION
235
return self.repository.fetch(from_branch.repository,
236
revision_id=last_revision,
239
if nested_pb is not None:
243
def get_bound_location(self):
244
"""Return the URL of the branch we are bound to.
246
Older format branches cannot bind, please be sure to use a metadir
251
def get_commit_builder(self, parents, config=None, timestamp=None,
252
timezone=None, committer=None, revprops=None,
254
"""Obtain a CommitBuilder for this branch.
256
:param parents: Revision ids of the parents of the new revision.
257
:param config: Optional configuration to use.
258
:param timestamp: Optional timestamp recorded for commit.
259
:param timezone: Optional timezone for timestamp.
260
:param committer: Optional committer to set for commit.
261
:param revprops: Optional dictionary of revision properties.
262
:param revision_id: Optional revision id.
266
config = bzrlib.config.BranchConfig(self)
268
return self.repository.get_commit_builder(self, parents, config,
269
timestamp, timezone, committer, revprops, revision_id)
271
def get_master_branch(self):
272
"""Return the branch we are bound to.
274
:return: Either a Branch, or None
278
def get_revision_delta(self, revno):
279
"""Return the delta for one revision.
281
The delta is relative to its mainline predecessor, or the
282
empty tree for revision 1.
284
assert isinstance(revno, int)
285
rh = self.revision_history()
286
if not (1 <= revno <= len(rh)):
287
raise InvalidRevisionNumber(revno)
288
return self.repository.get_revision_delta(rh[revno-1])
290
def get_root_id(self):
291
"""Return the id of this branches root"""
292
raise NotImplementedError('get_root_id is abstract')
294
def print_file(self, file, revision_id):
295
"""Print `file` to stdout."""
296
raise NotImplementedError('print_file is abstract')
298
def append_revision(self, *revision_ids):
299
raise NotImplementedError('append_revision is abstract')
301
def set_revision_history(self, rev_history):
302
raise NotImplementedError('set_revision_history is abstract')
304
def revision_history(self):
305
"""Return sequence of revision hashes on to this branch."""
306
raise NotImplementedError('revision_history is abstract')
309
"""Return current revision number for this branch.
311
That is equivalent to the number of revisions committed to
314
return len(self.revision_history())
317
"""Older format branches cannot bind or unbind."""
318
raise errors.UpgradeRequired(self.base)
320
def last_revision(self):
321
"""Return last patch hash, or None if no history."""
322
ph = self.revision_history()
328
def missing_revisions(self, other, stop_revision=None):
329
"""Return a list of new revisions that would perfectly fit.
331
If self and other have not diverged, return a list of the revisions
332
present in other, but missing from self.
334
self_history = self.revision_history()
335
self_len = len(self_history)
336
other_history = other.revision_history()
337
other_len = len(other_history)
338
common_index = min(self_len, other_len) -1
339
if common_index >= 0 and \
340
self_history[common_index] != other_history[common_index]:
341
raise DivergedBranches(self, other)
343
if stop_revision is None:
344
stop_revision = other_len
346
assert isinstance(stop_revision, int)
347
if stop_revision > other_len:
348
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
349
return other_history[self_len:stop_revision]
351
def update_revisions(self, other, stop_revision=None):
352
"""Pull in new perfect-fit revisions.
354
:param other: Another Branch to pull from
355
:param stop_revision: Updated until the given revision
358
raise NotImplementedError('update_revisions is abstract')
360
def revision_id_to_revno(self, revision_id):
361
"""Given a revision id, return its revno"""
362
if revision_id is None:
364
history = self.revision_history()
366
return history.index(revision_id) + 1
368
raise bzrlib.errors.NoSuchRevision(self, revision_id)
370
def get_rev_id(self, revno, history=None):
371
"""Find the revision id of the specified revno."""
375
history = self.revision_history()
376
elif revno <= 0 or revno > len(history):
377
raise bzrlib.errors.NoSuchRevision(self, revno)
378
return history[revno - 1]
380
def pull(self, source, overwrite=False, stop_revision=None):
381
raise NotImplementedError('pull is abstract')
383
def basis_tree(self):
384
"""Return `Tree` object for last revision.
386
If there are no revisions yet, return an `EmptyTree`.
388
return self.repository.revision_tree(self.last_revision())
390
def rename_one(self, from_rel, to_rel):
393
This can change the directory or the filename or both.
395
raise NotImplementedError('rename_one is abstract')
397
def move(self, from_paths, to_name):
400
to_name must exist as a versioned directory.
402
If to_name exists and is a directory, the files are moved into
403
it, keeping their old names. If it is a directory,
405
Note that to_name is only the last component of the new name;
406
this doesn't change the directory.
408
This returns a list of (from_path, to_path) pairs for each
411
raise NotImplementedError('move is abstract')
413
def get_parent(self):
414
"""Return the parent location of the branch.
416
This is the default location for push/pull/missing. The usual
417
pattern is that the user can override it by specifying a
420
raise NotImplementedError('get_parent is abstract')
422
def get_push_location(self):
423
"""Return the None or the location to push this branch to."""
424
raise NotImplementedError('get_push_location is abstract')
426
def set_push_location(self, location):
427
"""Set a new push location for this branch."""
428
raise NotImplementedError('set_push_location is abstract')
430
def set_parent(self, url):
431
raise NotImplementedError('set_parent is abstract')
435
"""Synchronise this branch with the master branch if any.
437
:return: None or the last_revision pivoted out during the update.
441
def check_revno(self, revno):
443
Check whether a revno corresponds to any revision.
444
Zero (the NULL revision) is considered valid.
447
self.check_real_revno(revno)
449
def check_real_revno(self, revno):
451
Check whether a revno corresponds to a real revision.
452
Zero (the NULL revision) is considered invalid
454
if revno < 1 or revno > self.revno():
455
raise InvalidRevisionNumber(revno)
458
def clone(self, *args, **kwargs):
459
"""Clone this branch into to_bzrdir preserving all semantic values.
461
revision_id: if not None, the revision history in the new branch will
462
be truncated to end with revision_id.
464
# for API compatibility, until 0.8 releases we provide the old api:
465
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
466
# after 0.8 releases, the *args and **kwargs should be changed:
467
# def clone(self, to_bzrdir, revision_id=None):
468
if (kwargs.get('to_location', None) or
469
kwargs.get('revision', None) or
470
kwargs.get('basis_branch', None) or
471
(len(args) and isinstance(args[0], basestring))):
472
# backwards compatibility api:
473
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
474
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
477
basis_branch = args[2]
479
basis_branch = kwargs.get('basis_branch', None)
481
basis = basis_branch.bzrdir
486
revision_id = args[1]
488
revision_id = kwargs.get('revision', None)
493
# no default to raise if not provided.
494
url = kwargs.get('to_location')
495
return self.bzrdir.clone(url,
496
revision_id=revision_id,
497
basis=basis).open_branch()
499
# generate args by hand
501
revision_id = args[1]
503
revision_id = kwargs.get('revision_id', None)
507
# no default to raise if not provided.
508
to_bzrdir = kwargs.get('to_bzrdir')
509
result = self._format.initialize(to_bzrdir)
510
self.copy_content_into(result, revision_id=revision_id)
514
def sprout(self, to_bzrdir, revision_id=None):
515
"""Create a new line of development from the branch, into to_bzrdir.
517
revision_id: if not None, the revision history in the new branch will
518
be truncated to end with revision_id.
520
result = self._format.initialize(to_bzrdir)
521
self.copy_content_into(result, revision_id=revision_id)
522
result.set_parent(self.bzrdir.root_transport.base)
526
def copy_content_into(self, destination, revision_id=None):
527
"""Copy the content of self into destination.
529
revision_id: if not None, the revision history in the new branch will
530
be truncated to end with revision_id.
532
new_history = self.revision_history()
533
if revision_id is not None:
535
new_history = new_history[:new_history.index(revision_id) + 1]
537
rev = self.repository.get_revision(revision_id)
538
new_history = rev.get_history(self.repository)[1:]
539
destination.set_revision_history(new_history)
540
parent = self.get_parent()
542
destination.set_parent(parent)
546
"""Check consistency of the branch.
548
In particular this checks that revisions given in the revision-history
549
do actually match up in the revision graph, and that they're all
550
present in the repository.
552
:return: A BranchCheckResult.
554
mainline_parent_id = None
555
for revision_id in self.revision_history():
557
revision = self.repository.get_revision(revision_id)
558
except errors.NoSuchRevision, e:
559
raise BzrCheckError("mainline revision {%s} not in repository"
561
# In general the first entry on the revision history has no parents.
562
# But it's not illegal for it to have parents listed; this can happen
563
# in imports from Arch when the parents weren't reachable.
564
if mainline_parent_id is not None:
565
if mainline_parent_id not in revision.parent_ids:
566
raise BzrCheckError("previous revision {%s} not listed among "
568
% (mainline_parent_id, revision_id))
569
mainline_parent_id = revision_id
570
return BranchCheckResult(self)
573
class BranchFormat(object):
574
"""An encapsulation of the initialization and open routines for a format.
576
Formats provide three things:
577
* An initialization routine,
581
Formats are placed in an dict by their format string for reference
582
during branch opening. Its not required that these be instances, they
583
can be classes themselves with class methods - it simply depends on
584
whether state is needed for a given format or not.
586
Once a format is deprecated, just deprecate the initialize and open
587
methods on the format class. Do not deprecate the object, as the
588
object will be created every time regardless.
591
_default_format = None
592
"""The default format used for new branches."""
595
"""The known formats."""
598
def find_format(klass, a_bzrdir):
599
"""Return the format for the branch object in a_bzrdir."""
601
transport = a_bzrdir.get_branch_transport(None)
602
format_string = transport.get("format").read()
603
return klass._formats[format_string]
605
raise NotBranchError(path=transport.base)
607
raise errors.UnknownFormatError(format=format_string)
610
def get_default_format(klass):
611
"""Return the current default format."""
612
return klass._default_format
614
def get_format_string(self):
615
"""Return the ASCII format string that identifies this format."""
616
raise NotImplementedError(self.get_format_string)
618
def get_format_description(self):
619
"""Return the short format description for this format."""
620
raise NotImplementedError(self.get_format_string)
622
def initialize(self, a_bzrdir):
623
"""Create a branch of this format in a_bzrdir."""
624
raise NotImplementedError(self.initialize)
626
def is_supported(self):
627
"""Is this format supported?
629
Supported formats can be initialized and opened.
630
Unsupported formats may not support initialization or committing or
631
some other features depending on the reason for not being supported.
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.
641
raise NotImplementedError(self.open)
644
def register_format(klass, format):
645
klass._formats[format.get_format_string()] = format
648
def set_default_format(klass, format):
649
klass._default_format = format
652
def unregister_format(klass, format):
653
assert klass._formats[format.get_format_string()] is format
654
del klass._formats[format.get_format_string()]
657
return self.get_format_string().rstrip()
660
class BzrBranchFormat4(BranchFormat):
661
"""Bzr branch format 4.
664
- a revision-history file.
665
- a branch-lock lock file [ to be shared with the bzrdir ]
668
def get_format_description(self):
669
"""See BranchFormat.get_format_description()."""
670
return "Branch format 4"
672
def initialize(self, a_bzrdir):
673
"""Create a branch of this format in a_bzrdir."""
674
mutter('creating branch in %s', a_bzrdir.transport.base)
675
branch_transport = a_bzrdir.get_branch_transport(self)
676
utf8_files = [('revision-history', ''),
679
control_files = LockableFiles(branch_transport, 'branch-lock',
681
control_files.create_lock()
682
control_files.lock_write()
684
for file, content in utf8_files:
685
control_files.put_utf8(file, content)
687
control_files.unlock()
688
return self.open(a_bzrdir, _found=True)
691
super(BzrBranchFormat4, self).__init__()
692
self._matchingbzrdir = bzrdir.BzrDirFormat6()
694
def open(self, a_bzrdir, _found=False):
695
"""Return the branch object for a_bzrdir
697
_found is a private parameter, do not use it. It is used to indicate
698
if format probing has already be done.
701
# we are being called directly and must probe.
702
raise NotImplementedError
703
return BzrBranch(_format=self,
704
_control_files=a_bzrdir._control_files,
706
_repository=a_bzrdir.open_repository())
709
return "Bazaar-NG branch format 4"
712
class BzrBranchFormat5(BranchFormat):
713
"""Bzr branch format 5.
716
- a revision-history file.
718
- a lock dir guarding the branch itself
719
- all of this stored in a branch/ subdirectory
720
- works with shared repositories.
722
This format is new in bzr 0.8.
725
def get_format_string(self):
726
"""See BranchFormat.get_format_string()."""
727
return "Bazaar-NG branch format 5\n"
729
def get_format_description(self):
730
"""See BranchFormat.get_format_description()."""
731
return "Branch format 5"
733
def initialize(self, a_bzrdir):
734
"""Create a branch of this format in a_bzrdir."""
735
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
736
branch_transport = a_bzrdir.get_branch_transport(self)
737
utf8_files = [('revision-history', ''),
740
control_files = LockableFiles(branch_transport, 'lock', LockDir)
741
control_files.create_lock()
742
control_files.lock_write()
743
control_files.put_utf8('format', self.get_format_string())
745
for file, content in utf8_files:
746
control_files.put_utf8(file, content)
748
control_files.unlock()
749
return self.open(a_bzrdir, _found=True, )
752
super(BzrBranchFormat5, self).__init__()
753
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
755
def open(self, a_bzrdir, _found=False):
756
"""Return the branch object for a_bzrdir
758
_found is a private parameter, do not use it. It is used to indicate
759
if format probing has already be done.
762
format = BranchFormat.find_format(a_bzrdir)
763
assert format.__class__ == self.__class__
764
transport = a_bzrdir.get_branch_transport(None)
765
control_files = LockableFiles(transport, 'lock', LockDir)
766
return BzrBranch5(_format=self,
767
_control_files=control_files,
769
_repository=a_bzrdir.find_repository())
772
return "Bazaar-NG Metadir branch format 5"
775
class BranchReferenceFormat(BranchFormat):
776
"""Bzr branch reference format.
778
Branch references are used in implementing checkouts, they
779
act as an alias to the real branch which is at some other url.
786
def get_format_string(self):
787
"""See BranchFormat.get_format_string()."""
788
return "Bazaar-NG Branch Reference Format 1\n"
790
def get_format_description(self):
791
"""See BranchFormat.get_format_description()."""
792
return "Checkout reference format 1"
794
def initialize(self, a_bzrdir, target_branch=None):
795
"""Create a branch of this format in a_bzrdir."""
796
if target_branch is None:
797
# this format does not implement branch itself, thus the implicit
798
# creation contract must see it as uninitializable
799
raise errors.UninitializableFormat(self)
800
mutter('creating branch reference in %s', a_bzrdir.transport.base)
801
branch_transport = a_bzrdir.get_branch_transport(self)
802
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
803
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
804
branch_transport.put('format', StringIO(self.get_format_string()))
805
return self.open(a_bzrdir, _found=True)
808
super(BranchReferenceFormat, self).__init__()
809
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
811
def _make_reference_clone_function(format, a_branch):
812
"""Create a clone() routine for a branch dynamically."""
813
def clone(to_bzrdir, revision_id=None):
814
"""See Branch.clone()."""
815
return format.initialize(to_bzrdir, a_branch)
816
# cannot obey revision_id limits when cloning a reference ...
817
# FIXME RBC 20060210 either nuke revision_id for clone, or
818
# emit some sort of warning/error to the caller ?!
821
def open(self, a_bzrdir, _found=False):
822
"""Return the branch that the branch reference in a_bzrdir points at.
824
_found is a private parameter, do not use it. It is used to indicate
825
if format probing has already be done.
828
format = BranchFormat.find_format(a_bzrdir)
829
assert format.__class__ == self.__class__
830
transport = a_bzrdir.get_branch_transport(None)
831
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
832
result = real_bzrdir.open_branch()
833
# this changes the behaviour of result.clone to create a new reference
834
# rather than a copy of the content of the branch.
835
# I did not use a proxy object because that needs much more extensive
836
# testing, and we are only changing one behaviour at the moment.
837
# If we decide to alter more behaviours - i.e. the implicit nickname
838
# then this should be refactored to introduce a tested proxy branch
839
# and a subclass of that for use in overriding clone() and ....
841
result.clone = self._make_reference_clone_function(result)
845
# formats which have no format string are not discoverable
846
# and not independently creatable, so are not registered.
847
__default_format = BzrBranchFormat5()
848
BranchFormat.register_format(__default_format)
849
BranchFormat.register_format(BranchReferenceFormat())
850
BranchFormat.set_default_format(__default_format)
851
_legacy_formats = [BzrBranchFormat4(),
854
class BzrBranch(Branch):
855
"""A branch stored in the actual filesystem.
857
Note that it's "local" in the context of the filesystem; it doesn't
858
really matter if it's on an nfs/smb/afs/coda/... share, as long as
859
it's writable, and can be accessed via the normal filesystem API.
862
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
863
relax_version_check=DEPRECATED_PARAMETER, _format=None,
864
_control_files=None, a_bzrdir=None, _repository=None):
865
"""Create new branch object at a particular location.
867
transport -- A Transport object, defining how to access files.
869
init -- If True, create new control files in a previously
870
unversioned directory. If False, the branch must already
873
relax_version_check -- If true, the usual check for the branch
874
version is not applied. This is intended only for
875
upgrade/recovery type use; it's not guaranteed that
876
all operations will work on old format branches.
879
self.bzrdir = bzrdir.BzrDir.open(transport.base)
881
self.bzrdir = a_bzrdir
882
self._transport = self.bzrdir.transport.clone('..')
883
self._base = self._transport.base
884
self._format = _format
885
if _control_files is None:
886
raise BzrBadParameterMissing('_control_files')
887
self.control_files = _control_files
888
if deprecated_passed(init):
889
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
890
"deprecated as of bzr 0.8. Please use Branch.create().",
894
# this is slower than before deprecation, oh well never mind.
896
self._initialize(transport.base)
897
self._check_format(_format)
898
if deprecated_passed(relax_version_check):
899
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
900
"relax_version_check parameter is deprecated as of bzr 0.8. "
901
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
905
if (not relax_version_check
906
and not self._format.is_supported()):
907
raise errors.UnsupportedFormatError(format=fmt)
908
if deprecated_passed(transport):
909
warn("BzrBranch.__init__(transport=XXX...): The transport "
910
"parameter is deprecated as of bzr 0.8. "
911
"Please use Branch.open, or bzrdir.open_branch().",
914
self.repository = _repository
917
return '%s(%r)' % (self.__class__.__name__, self.base)
922
# TODO: It might be best to do this somewhere else,
923
# but it is nice for a Branch object to automatically
924
# cache it's information.
925
# Alternatively, we could have the Transport objects cache requests
926
# See the earlier discussion about how major objects (like Branch)
927
# should never expect their __del__ function to run.
928
# XXX: cache_root seems to be unused, 2006-01-13 mbp
929
if hasattr(self, 'cache_root') and self.cache_root is not None:
931
rmtree(self.cache_root)
934
self.cache_root = None
939
base = property(_get_base, doc="The URL for the root of this branch.")
941
def _finish_transaction(self):
942
"""Exit the current transaction."""
943
return self.control_files._finish_transaction()
945
def get_transaction(self):
946
"""Return the current active transaction.
948
If no transaction is active, this returns a passthrough object
949
for which all data is immediately flushed and no caching happens.
951
# this is an explicit function so that we can do tricky stuff
952
# when the storage in rev_storage is elsewhere.
953
# we probably need to hook the two 'lock a location' and
954
# 'have a transaction' together more delicately, so that
955
# we can have two locks (branch and storage) and one transaction
956
# ... and finishing the transaction unlocks both, but unlocking
957
# does not. - RBC 20051121
958
return self.control_files.get_transaction()
960
def _set_transaction(self, transaction):
961
"""Set a new active transaction."""
962
return self.control_files._set_transaction(transaction)
964
def abspath(self, name):
965
"""See Branch.abspath."""
966
return self.control_files._transport.abspath(name)
968
def _check_format(self, format):
969
"""Identify the branch format if needed.
971
The format is stored as a reference to the format object in
972
self._format for code that needs to check it later.
974
The format parameter is either None or the branch format class
975
used to open this branch.
977
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
980
format = BzrBranchFormat.find_format(self.bzrdir)
981
self._format = format
982
mutter("got branch format %s", self._format)
985
def get_root_id(self):
986
"""See Branch.get_root_id."""
987
tree = self.repository.revision_tree(self.last_revision())
988
return tree.inventory.root.file_id
991
return self.control_files.is_locked()
993
def lock_write(self):
994
# TODO: test for failed two phase locks. This is known broken.
995
self.control_files.lock_write()
996
self.repository.lock_write()
999
# TODO: test for failed two phase locks. This is known broken.
1000
self.control_files.lock_read()
1001
self.repository.lock_read()
1004
# TODO: test for failed two phase locks. This is known broken.
1006
self.repository.unlock()
1008
self.control_files.unlock()
1010
def peek_lock_mode(self):
1011
if self.control_files._lock_count == 0:
1014
return self.control_files._lock_mode
1016
def get_physical_lock_status(self):
1017
return self.control_files.get_physical_lock_status()
1020
def print_file(self, file, revision_id):
1021
"""See Branch.print_file."""
1022
return self.repository.print_file(file, revision_id)
1025
def append_revision(self, *revision_ids):
1026
"""See Branch.append_revision."""
1027
for revision_id in revision_ids:
1028
mutter("add {%s} to revision-history" % revision_id)
1029
rev_history = self.revision_history()
1030
rev_history.extend(revision_ids)
1031
self.set_revision_history(rev_history)
1034
def set_revision_history(self, rev_history):
1035
"""See Branch.set_revision_history."""
1036
self.control_files.put_utf8(
1037
'revision-history', '\n'.join(rev_history))
1038
transaction = self.get_transaction()
1039
history = transaction.map.find_revision_history()
1040
if history is not None:
1041
# update the revision history in the identity map.
1042
history[:] = list(rev_history)
1043
# this call is disabled because revision_history is
1044
# not really an object yet, and the transaction is for objects.
1045
# transaction.register_dirty(history)
1047
transaction.map.add_revision_history(rev_history)
1048
# this call is disabled because revision_history is
1049
# not really an object yet, and the transaction is for objects.
1050
# transaction.register_clean(history)
1053
def revision_history(self):
1054
"""See Branch.revision_history."""
1055
transaction = self.get_transaction()
1056
history = transaction.map.find_revision_history()
1057
if history is not None:
1058
mutter("cache hit for revision-history in %s", self)
1059
return list(history)
1060
history = [l.rstrip('\r\n') for l in
1061
self.control_files.get_utf8('revision-history').readlines()]
1062
transaction.map.add_revision_history(history)
1063
# this call is disabled because revision_history is
1064
# not really an object yet, and the transaction is for objects.
1065
# transaction.register_clean(history, precious=True)
1066
return list(history)
1069
def update_revisions(self, other, stop_revision=None):
1070
"""See Branch.update_revisions."""
1073
if stop_revision is None:
1074
stop_revision = other.last_revision()
1075
if stop_revision is None:
1076
# if there are no commits, we're done.
1078
# whats the current last revision, before we fetch [and change it
1080
last_rev = self.last_revision()
1081
# we fetch here regardless of whether we need to so that we pickup
1083
self.fetch(other, stop_revision)
1084
my_ancestry = self.repository.get_ancestry(last_rev)
1085
if stop_revision in my_ancestry:
1086
# last_revision is a descendant of stop_revision
1088
# stop_revision must be a descendant of last_revision
1089
stop_graph = self.repository.get_revision_graph(stop_revision)
1090
if last_rev is not None and last_rev not in stop_graph:
1091
# our previous tip is not merged into stop_revision
1092
raise errors.DivergedBranches(self, other)
1093
# make a new revision history from the graph
1094
current_rev_id = stop_revision
1096
while current_rev_id not in (None, NULL_REVISION):
1097
new_history.append(current_rev_id)
1098
current_rev_id_parents = stop_graph[current_rev_id]
1100
current_rev_id = current_rev_id_parents[0]
1102
current_rev_id = None
1103
new_history.reverse()
1104
self.set_revision_history(new_history)
1108
def basis_tree(self):
1109
"""See Branch.basis_tree."""
1110
return self.repository.revision_tree(self.last_revision())
1112
@deprecated_method(zero_eight)
1113
def working_tree(self):
1114
"""Create a Working tree object for this branch."""
1115
from bzrlib.workingtree import WorkingTree
1116
from bzrlib.transport.local import LocalTransport
1117
if (self.base.find('://') != -1 or
1118
not isinstance(self._transport, LocalTransport)):
1119
raise NoWorkingTree(self.base)
1120
return self.bzrdir.open_workingtree()
1123
def pull(self, source, overwrite=False, stop_revision=None):
1124
"""See Branch.pull."""
1127
old_count = len(self.revision_history())
1129
self.update_revisions(source,stop_revision)
1130
except DivergedBranches:
1134
self.set_revision_history(source.revision_history())
1135
new_count = len(self.revision_history())
1136
return new_count - old_count
1140
def get_parent(self):
1141
"""See Branch.get_parent."""
1143
_locs = ['parent', 'pull', 'x-pull']
1144
assert self.base[-1] == '/'
1147
parent = self.control_files.get(l).read().strip('\n')
1150
# This is an old-format absolute path to a local branch
1151
# turn it into a url
1152
if parent.startswith('/'):
1153
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1154
return urlutils.join(self.base[:-1], parent)
1157
def get_push_location(self):
1158
"""See Branch.get_push_location."""
1159
config = bzrlib.config.BranchConfig(self)
1160
push_loc = config.get_user_option('push_location')
1163
def set_push_location(self, location):
1164
"""See Branch.set_push_location."""
1165
config = bzrlib.config.LocationConfig(self.base)
1166
config.set_user_option('push_location', location)
1169
def set_parent(self, url):
1170
"""See Branch.set_parent."""
1171
# TODO: Maybe delete old location files?
1172
# URLs should never be unicode, even on the local fs,
1173
# FIXUP this and get_parent in a future branch format bump:
1174
# read and rewrite the file, and have the new format code read
1175
# using .get not .get_utf8. RBC 20060125
1177
self.control_files._transport.delete('parent')
1179
if isinstance(url, unicode):
1181
url = url.encode('ascii')
1182
except UnicodeEncodeError:
1183
raise bzrlib.errors.InvalidURL(url,
1184
"Urls must be 7-bit ascii, "
1185
"use bzrlib.urlutils.escape")
1187
url = urlutils.relative_url(self.base, url)
1188
self.control_files.put('parent', url + '\n')
1190
def tree_config(self):
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 ScratchBranch(*args, **kwargs):
1386
"""See bzrlib.bzrdir.ScratchDir."""
1387
d = ScratchDir(*args, **kwargs)
1388
return d.open_branch()
1391
@deprecated_function(zero_eight)
1392
def is_control_file(*args, **kwargs):
1393
"""See bzrlib.workingtree.is_control_file."""
1394
return bzrlib.workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
