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
36
from bzrlib.config import TreeConfig
37
from bzrlib.decorators import needs_read_lock, needs_write_lock
38
import bzrlib.errors as errors
39
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
40
HistoryMissing, InvalidRevisionId,
41
InvalidRevisionNumber, LockError, NoSuchFile,
42
NoSuchRevision, NoWorkingTree, NotVersionedError,
43
NotBranchError, UninitializableFormat,
44
UnlistableStore, UnlistableBranch,
46
from bzrlib.lockable_files import LockableFiles, TransportLock
47
from bzrlib.symbol_versioning import (deprecated_function,
51
zero_eight, zero_nine,
53
from bzrlib.trace import mutter, note
56
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
57
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
58
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
61
# TODO: Maybe include checks for common corruption of newlines, etc?
63
# TODO: Some operations like log might retrieve the same revisions
64
# repeatedly to calculate deltas. We could perhaps have a weakref
65
# cache in memory to make this faster. In general anything can be
66
# cached in memory between lock and unlock operations. .. nb thats
67
# what the transaction identity map provides
70
######################################################################
74
"""Branch holding a history of revisions.
77
Base directory/url of the branch.
79
# this is really an instance variable - FIXME move it there
83
def __init__(self, *ignored, **ignored_too):
84
raise NotImplementedError('The Branch class is abstract')
87
"""Break a lock if one is present from another instance.
89
Uses the ui factory to ask for confirmation if the lock may be from
92
This will probe the repository for its lock as well.
94
self.control_files.break_lock()
95
self.repository.break_lock()
96
master = self.get_master_branch()
97
if master is not None:
101
@deprecated_method(zero_eight)
102
def open_downlevel(base):
103
"""Open a branch which may be of an old format."""
104
return Branch.open(base, _unsupported=True)
107
def open(base, _unsupported=False):
108
"""Open the branch rooted at base.
110
For instance, if the branch is at URL/.bzr/branch,
111
Branch.open(URL) -> a Branch instance.
113
control = bzrdir.BzrDir.open(base, _unsupported)
114
return control.open_branch(_unsupported)
117
def open_containing(url):
118
"""Open an existing branch which contains url.
120
This probes for a branch at url, and searches upwards from there.
122
Basically we keep looking up until we find the control directory or
123
run into the root. If there isn't one, raises NotBranchError.
124
If there is one and it is either an unrecognised format or an unsupported
125
format, UnknownFormatError or UnsupportedFormatError are raised.
126
If there is one, it is returned, along with the unused portion of url.
128
control, relpath = bzrdir.BzrDir.open_containing(url)
129
return control.open_branch(), relpath
132
@deprecated_function(zero_eight)
133
def initialize(base):
134
"""Create a new working tree and branch, rooted at 'base' (url)
136
NOTE: This will soon be deprecated in favour of creation
139
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
141
def setup_caching(self, cache_root):
142
"""Subclasses that care about caching should override this, and set
143
up cached stores located under cache_root.
145
# seems to be unused, 2006-01-13 mbp
146
warn('%s is deprecated' % self.setup_caching)
147
self.cache_root = cache_root
149
def get_config(self):
150
return bzrlib.config.BranchConfig(self)
153
return self.get_config().get_nickname()
155
def _set_nick(self, nick):
156
self.get_config().set_user_option('nickname', nick)
158
nick = property(_get_nick, _set_nick)
161
raise NotImplementedError(self.is_locked)
163
def lock_write(self):
164
raise NotImplementedError(self.lock_write)
167
raise NotImplementedError(self.lock_read)
170
raise NotImplementedError(self.unlock)
172
def peek_lock_mode(self):
173
"""Return lock mode for the Branch: 'r', 'w' or None"""
174
raise NotImplementedError(self.peek_lock_mode)
176
def get_physical_lock_status(self):
177
raise NotImplementedError(self.get_physical_lock_status)
179
def abspath(self, name):
180
"""Return absolute filename for something in the branch
182
XXX: Robert Collins 20051017 what is this used for? why is it a branch
183
method and not a tree method.
185
raise NotImplementedError(self.abspath)
187
def bind(self, other):
188
"""Bind the local branch the other branch.
190
:param other: The branch to bind to
193
raise errors.UpgradeRequired(self.base)
196
def fetch(self, from_branch, last_revision=None, pb=None):
197
"""Copy revisions from from_branch into this branch.
199
:param from_branch: Where to copy from.
200
:param last_revision: What revision to stop at (None for at the end
202
:param pb: An optional progress bar to use.
204
Returns the copied revision count and the failed revisions in a tuple:
207
if self.base == from_branch.base:
210
nested_pb = ui.ui_factory.nested_progress_bar()
215
from_branch.lock_read()
217
if last_revision is None:
218
pb.update('get source history')
219
from_history = from_branch.revision_history()
221
last_revision = from_history[-1]
223
# no history in the source branch
224
last_revision = revision.NULL_REVISION
225
return self.repository.fetch(from_branch.repository,
226
revision_id=last_revision,
229
if nested_pb is not None:
233
def get_bound_location(self):
234
"""Return the URL of the branch we are bound to.
236
Older format branches cannot bind, please be sure to use a metadir
241
def get_commit_builder(self, parents, config=None, timestamp=None,
242
timezone=None, committer=None, revprops=None,
244
"""Obtain a CommitBuilder for this branch.
246
:param parents: Revision ids of the parents of the new revision.
247
:param config: Optional configuration to use.
248
:param timestamp: Optional timestamp recorded for commit.
249
:param timezone: Optional timezone for timestamp.
250
:param committer: Optional committer to set for commit.
251
:param revprops: Optional dictionary of revision properties.
252
:param revision_id: Optional revision id.
256
config = self.get_config()
258
return self.repository.get_commit_builder(self, parents, config,
259
timestamp, timezone, committer, revprops, revision_id)
261
def get_master_branch(self):
262
"""Return the branch we are bound to.
264
:return: Either a Branch, or None
268
def get_revision_delta(self, revno):
269
"""Return the delta for one revision.
271
The delta is relative to its mainline predecessor, or the
272
empty tree for revision 1.
274
assert isinstance(revno, int)
275
rh = self.revision_history()
276
if not (1 <= revno <= len(rh)):
277
raise InvalidRevisionNumber(revno)
278
return self.repository.get_revision_delta(rh[revno-1])
280
def get_root_id(self):
281
"""Return the id of this branches root"""
282
raise NotImplementedError(self.get_root_id)
284
def print_file(self, file, revision_id):
285
"""Print `file` to stdout."""
286
raise NotImplementedError(self.print_file)
288
def append_revision(self, *revision_ids):
289
raise NotImplementedError(self.append_revision)
291
def set_revision_history(self, rev_history):
292
raise NotImplementedError(self.set_revision_history)
294
def revision_history(self):
295
"""Return sequence of revision hashes on to this branch."""
296
raise NotImplementedError('revision_history is abstract')
299
"""Return current revision number for this branch.
301
That is equivalent to the number of revisions committed to
304
return len(self.revision_history())
307
"""Older format branches cannot bind or unbind."""
308
raise errors.UpgradeRequired(self.base)
310
def last_revision(self):
311
"""Return last revision id, or None"""
312
ph = self.revision_history()
318
def missing_revisions(self, other, stop_revision=None):
319
"""Return a list of new revisions that would perfectly fit.
321
If self and other have not diverged, return a list of the revisions
322
present in other, but missing from self.
324
self_history = self.revision_history()
325
self_len = len(self_history)
326
other_history = other.revision_history()
327
other_len = len(other_history)
328
common_index = min(self_len, other_len) -1
329
if common_index >= 0 and \
330
self_history[common_index] != other_history[common_index]:
331
raise DivergedBranches(self, other)
333
if stop_revision is None:
334
stop_revision = other_len
336
assert isinstance(stop_revision, int)
337
if stop_revision > other_len:
338
raise errors.NoSuchRevision(self, stop_revision)
339
return other_history[self_len:stop_revision]
341
def update_revisions(self, other, stop_revision=None):
342
"""Pull in new perfect-fit revisions.
344
:param other: Another Branch to pull from
345
:param stop_revision: Updated until the given revision
348
raise NotImplementedError(self.update_revisions)
350
def revision_id_to_revno(self, revision_id):
351
"""Given a revision id, return its revno"""
352
if revision_id is None:
354
history = self.revision_history()
356
return history.index(revision_id) + 1
358
raise bzrlib.errors.NoSuchRevision(self, revision_id)
360
def get_rev_id(self, revno, history=None):
361
"""Find the revision id of the specified revno."""
365
history = self.revision_history()
366
if revno <= 0 or revno > len(history):
367
raise bzrlib.errors.NoSuchRevision(self, revno)
368
return history[revno - 1]
370
def pull(self, source, overwrite=False, stop_revision=None):
371
raise NotImplementedError(self.pull)
373
def basis_tree(self):
374
"""Return `Tree` object for last revision."""
375
return self.repository.revision_tree(self.last_revision())
377
def rename_one(self, from_rel, to_rel):
380
This can change the directory or the filename or both.
382
raise NotImplementedError(self.rename_one)
384
def move(self, from_paths, to_name):
387
to_name must exist as a versioned directory.
389
If to_name exists and is a directory, the files are moved into
390
it, keeping their old names. If it is a directory,
392
Note that to_name is only the last component of the new name;
393
this doesn't change the directory.
395
This returns a list of (from_path, to_path) pairs for each
398
raise NotImplementedError(self.move)
400
def get_parent(self):
401
"""Return the parent location of the branch.
403
This is the default location for push/pull/missing. The usual
404
pattern is that the user can override it by specifying a
407
raise NotImplementedError(self.get_parent)
409
def get_submit_branch(self):
410
"""Return the submit location of the branch.
412
This is the default location for bundle. The usual
413
pattern is that the user can override it by specifying a
416
return self.get_config().get_user_option('submit_branch')
418
def set_submit_branch(self, location):
419
"""Return the submit location of the branch.
421
This is the default location for bundle. The usual
422
pattern is that the user can override it by specifying a
425
self.get_config().set_user_option('submit_branch', location)
427
def get_push_location(self):
428
"""Return the None or the location to push this branch to."""
429
raise NotImplementedError(self.get_push_location)
431
def set_push_location(self, location):
432
"""Set a new push location for this branch."""
433
raise NotImplementedError(self.set_push_location)
435
def set_parent(self, url):
436
raise NotImplementedError(self.set_parent)
440
"""Synchronise this branch with the master branch if any.
442
:return: None or the last_revision pivoted out during the update.
446
def check_revno(self, revno):
448
Check whether a revno corresponds to any revision.
449
Zero (the NULL revision) is considered valid.
452
self.check_real_revno(revno)
454
def check_real_revno(self, revno):
456
Check whether a revno corresponds to a real revision.
457
Zero (the NULL revision) is considered invalid
459
if revno < 1 or revno > self.revno():
460
raise InvalidRevisionNumber(revno)
463
def clone(self, *args, **kwargs):
464
"""Clone this branch into to_bzrdir preserving all semantic values.
466
revision_id: if not None, the revision history in the new branch will
467
be truncated to end with revision_id.
469
# for API compatibility, until 0.8 releases we provide the old api:
470
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
471
# after 0.8 releases, the *args and **kwargs should be changed:
472
# def clone(self, to_bzrdir, revision_id=None):
473
if (kwargs.get('to_location', None) or
474
kwargs.get('revision', None) or
475
kwargs.get('basis_branch', None) or
476
(len(args) and isinstance(args[0], basestring))):
477
# backwards compatibility api:
478
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
479
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
482
basis_branch = args[2]
484
basis_branch = kwargs.get('basis_branch', None)
486
basis = basis_branch.bzrdir
491
revision_id = args[1]
493
revision_id = kwargs.get('revision', None)
498
# no default to raise if not provided.
499
url = kwargs.get('to_location')
500
return self.bzrdir.clone(url,
501
revision_id=revision_id,
502
basis=basis).open_branch()
504
# generate args by hand
506
revision_id = args[1]
508
revision_id = kwargs.get('revision_id', None)
512
# no default to raise if not provided.
513
to_bzrdir = kwargs.get('to_bzrdir')
514
result = self._format.initialize(to_bzrdir)
515
self.copy_content_into(result, revision_id=revision_id)
519
def sprout(self, to_bzrdir, revision_id=None):
520
"""Create a new line of development from the branch, into to_bzrdir.
522
revision_id: if not None, the revision history in the new branch will
523
be truncated to end with revision_id.
525
result = self._format.initialize(to_bzrdir)
526
self.copy_content_into(result, revision_id=revision_id)
527
result.set_parent(self.bzrdir.root_transport.base)
531
def copy_content_into(self, destination, revision_id=None):
532
"""Copy the content of self into destination.
534
revision_id: if not None, the revision history in the new branch will
535
be truncated to end with revision_id.
537
new_history = self.revision_history()
538
if revision_id is not None:
540
new_history = new_history[:new_history.index(revision_id) + 1]
542
rev = self.repository.get_revision(revision_id)
543
new_history = rev.get_history(self.repository)[1:]
544
destination.set_revision_history(new_history)
546
parent = self.get_parent()
547
except errors.InaccessibleParent, e:
548
mutter('parent was not accessible to copy: %s', e)
551
destination.set_parent(parent)
555
"""Check consistency of the branch.
557
In particular this checks that revisions given in the revision-history
558
do actually match up in the revision graph, and that they're all
559
present in the repository.
561
Callers will typically also want to check the repository.
563
:return: A BranchCheckResult.
565
mainline_parent_id = None
566
for revision_id in self.revision_history():
568
revision = self.repository.get_revision(revision_id)
569
except errors.NoSuchRevision, e:
570
raise errors.BzrCheckError("mainline revision {%s} not in repository"
572
# In general the first entry on the revision history has no parents.
573
# But it's not illegal for it to have parents listed; this can happen
574
# in imports from Arch when the parents weren't reachable.
575
if mainline_parent_id is not None:
576
if mainline_parent_id not in revision.parent_ids:
577
raise errors.BzrCheckError("previous revision {%s} not listed among "
579
% (mainline_parent_id, revision_id))
580
mainline_parent_id = revision_id
581
return BranchCheckResult(self)
583
def create_checkout(self, to_location, revision_id=None,
585
"""Create a checkout of a branch.
587
:param to_location: The url to produce the checkout at
588
:param revision_id: The revision to check out
589
:param lightweight: If True, produce a lightweight checkout, otherwise,
590
produce a bound branch (heavyweight checkout)
591
:return: The tree of the created checkout
594
t = transport.get_transport(to_location)
597
except errors.FileExists:
599
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
600
BranchReferenceFormat().initialize(checkout, self)
602
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
603
to_location, force_new_tree=False)
604
checkout = checkout_branch.bzrdir
605
checkout_branch.bind(self)
606
if revision_id is not None:
607
rh = checkout_branch.revision_history()
608
new_rh = rh[:rh.index(revision_id) + 1]
609
checkout_branch.set_revision_history(new_rh)
610
return checkout.create_workingtree(revision_id)
613
class BranchFormat(object):
614
"""An encapsulation of the initialization and open routines for a format.
616
Formats provide three things:
617
* An initialization routine,
621
Formats are placed in an dict by their format string for reference
622
during branch opening. Its not required that these be instances, they
623
can be classes themselves with class methods - it simply depends on
624
whether state is needed for a given format or not.
626
Once a format is deprecated, just deprecate the initialize and open
627
methods on the format class. Do not deprecate the object, as the
628
object will be created every time regardless.
631
_default_format = None
632
"""The default format used for new branches."""
635
"""The known formats."""
638
def find_format(klass, a_bzrdir):
639
"""Return the format for the branch object in a_bzrdir."""
641
transport = a_bzrdir.get_branch_transport(None)
642
format_string = transport.get("format").read()
643
return klass._formats[format_string]
645
raise NotBranchError(path=transport.base)
647
raise errors.UnknownFormatError(format=format_string)
650
def get_default_format(klass):
651
"""Return the current default format."""
652
return klass._default_format
654
def get_format_string(self):
655
"""Return the ASCII format string that identifies this format."""
656
raise NotImplementedError(self.get_format_string)
658
def get_format_description(self):
659
"""Return the short format description for this format."""
660
raise NotImplementedError(self.get_format_string)
662
def initialize(self, a_bzrdir):
663
"""Create a branch of this format in a_bzrdir."""
664
raise NotImplementedError(self.initialize)
666
def is_supported(self):
667
"""Is this format supported?
669
Supported formats can be initialized and opened.
670
Unsupported formats may not support initialization or committing or
671
some other features depending on the reason for not being supported.
675
def open(self, a_bzrdir, _found=False):
676
"""Return the branch object for a_bzrdir
678
_found is a private parameter, do not use it. It is used to indicate
679
if format probing has already be done.
681
raise NotImplementedError(self.open)
684
def register_format(klass, format):
685
klass._formats[format.get_format_string()] = format
688
def set_default_format(klass, format):
689
klass._default_format = format
692
def unregister_format(klass, format):
693
assert klass._formats[format.get_format_string()] is format
694
del klass._formats[format.get_format_string()]
697
return self.get_format_string().rstrip()
700
class BzrBranchFormat4(BranchFormat):
701
"""Bzr branch format 4.
704
- a revision-history file.
705
- a branch-lock lock file [ to be shared with the bzrdir ]
708
def get_format_description(self):
709
"""See BranchFormat.get_format_description()."""
710
return "Branch format 4"
712
def initialize(self, a_bzrdir):
713
"""Create a branch of this format in a_bzrdir."""
714
mutter('creating branch in %s', a_bzrdir.transport.base)
715
branch_transport = a_bzrdir.get_branch_transport(self)
716
utf8_files = [('revision-history', ''),
719
control_files = LockableFiles(branch_transport, 'branch-lock',
721
control_files.create_lock()
722
control_files.lock_write()
724
for file, content in utf8_files:
725
control_files.put_utf8(file, content)
727
control_files.unlock()
728
return self.open(a_bzrdir, _found=True)
731
super(BzrBranchFormat4, self).__init__()
732
self._matchingbzrdir = bzrdir.BzrDirFormat6()
734
def open(self, a_bzrdir, _found=False):
735
"""Return the branch object for a_bzrdir
737
_found is a private parameter, do not use it. It is used to indicate
738
if format probing has already be done.
741
# we are being called directly and must probe.
742
raise NotImplementedError
743
return BzrBranch(_format=self,
744
_control_files=a_bzrdir._control_files,
746
_repository=a_bzrdir.open_repository())
749
return "Bazaar-NG branch format 4"
752
class BzrBranchFormat5(BranchFormat):
753
"""Bzr branch format 5.
756
- a revision-history file.
758
- a lock dir guarding the branch itself
759
- all of this stored in a branch/ subdirectory
760
- works with shared repositories.
762
This format is new in bzr 0.8.
765
def get_format_string(self):
766
"""See BranchFormat.get_format_string()."""
767
return "Bazaar-NG branch format 5\n"
769
def get_format_description(self):
770
"""See BranchFormat.get_format_description()."""
771
return "Branch format 5"
773
def initialize(self, a_bzrdir):
774
"""Create a branch of this format in a_bzrdir."""
775
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
776
branch_transport = a_bzrdir.get_branch_transport(self)
777
utf8_files = [('revision-history', ''),
780
control_files = LockableFiles(branch_transport, 'lock', lockdir.LockDir)
781
control_files.create_lock()
782
control_files.lock_write()
783
control_files.put_utf8('format', self.get_format_string())
785
for file, content in utf8_files:
786
control_files.put_utf8(file, content)
788
control_files.unlock()
789
return self.open(a_bzrdir, _found=True, )
792
super(BzrBranchFormat5, self).__init__()
793
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
795
def open(self, a_bzrdir, _found=False):
796
"""Return the branch object for a_bzrdir
798
_found is a private parameter, do not use it. It is used to indicate
799
if format probing has already be done.
802
format = BranchFormat.find_format(a_bzrdir)
803
assert format.__class__ == self.__class__
804
transport = a_bzrdir.get_branch_transport(None)
805
control_files = LockableFiles(transport, 'lock', lockdir.LockDir)
806
return BzrBranch5(_format=self,
807
_control_files=control_files,
809
_repository=a_bzrdir.find_repository())
812
return "Bazaar-NG Metadir branch format 5"
815
class BranchReferenceFormat(BranchFormat):
816
"""Bzr branch reference format.
818
Branch references are used in implementing checkouts, they
819
act as an alias to the real branch which is at some other url.
826
def get_format_string(self):
827
"""See BranchFormat.get_format_string()."""
828
return "Bazaar-NG Branch Reference Format 1\n"
830
def get_format_description(self):
831
"""See BranchFormat.get_format_description()."""
832
return "Checkout reference format 1"
834
def initialize(self, a_bzrdir, target_branch=None):
835
"""Create a branch of this format in a_bzrdir."""
836
if target_branch is None:
837
# this format does not implement branch itself, thus the implicit
838
# creation contract must see it as uninitializable
839
raise errors.UninitializableFormat(self)
840
mutter('creating branch reference in %s', a_bzrdir.transport.base)
841
branch_transport = a_bzrdir.get_branch_transport(self)
842
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
843
branch_transport.put_bytes('location',
844
str(target_branch.bzrdir.root_transport.base))
845
branch_transport.put_bytes('format', self.get_format_string())
846
return self.open(a_bzrdir, _found=True)
849
super(BranchReferenceFormat, self).__init__()
850
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
852
def _make_reference_clone_function(format, a_branch):
853
"""Create a clone() routine for a branch dynamically."""
854
def clone(to_bzrdir, revision_id=None):
855
"""See Branch.clone()."""
856
return format.initialize(to_bzrdir, a_branch)
857
# cannot obey revision_id limits when cloning a reference ...
858
# FIXME RBC 20060210 either nuke revision_id for clone, or
859
# emit some sort of warning/error to the caller ?!
862
def open(self, a_bzrdir, _found=False):
863
"""Return the branch that the branch reference in a_bzrdir points at.
865
_found is a private parameter, do not use it. It is used to indicate
866
if format probing has already be done.
869
format = BranchFormat.find_format(a_bzrdir)
870
assert format.__class__ == self.__class__
871
transport = a_bzrdir.get_branch_transport(None)
872
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
873
result = real_bzrdir.open_branch()
874
# this changes the behaviour of result.clone to create a new reference
875
# rather than a copy of the content of the branch.
876
# I did not use a proxy object because that needs much more extensive
877
# testing, and we are only changing one behaviour at the moment.
878
# If we decide to alter more behaviours - i.e. the implicit nickname
879
# then this should be refactored to introduce a tested proxy branch
880
# and a subclass of that for use in overriding clone() and ....
882
result.clone = self._make_reference_clone_function(result)
886
# formats which have no format string are not discoverable
887
# and not independently creatable, so are not registered.
888
__default_format = BzrBranchFormat5()
889
BranchFormat.register_format(__default_format)
890
BranchFormat.register_format(BranchReferenceFormat())
891
BranchFormat.set_default_format(__default_format)
892
_legacy_formats = [BzrBranchFormat4(),
895
class BzrBranch(Branch):
896
"""A branch stored in the actual filesystem.
898
Note that it's "local" in the context of the filesystem; it doesn't
899
really matter if it's on an nfs/smb/afs/coda/... share, as long as
900
it's writable, and can be accessed via the normal filesystem API.
903
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
904
relax_version_check=DEPRECATED_PARAMETER, _format=None,
905
_control_files=None, a_bzrdir=None, _repository=None):
906
"""Create new branch object at a particular location.
908
transport -- A Transport object, defining how to access files.
910
init -- If True, create new control files in a previously
911
unversioned directory. If False, the branch must already
914
relax_version_check -- If true, the usual check for the branch
915
version is not applied. This is intended only for
916
upgrade/recovery type use; it's not guaranteed that
917
all operations will work on old format branches.
920
self.bzrdir = bzrdir.BzrDir.open(transport.base)
922
self.bzrdir = a_bzrdir
923
self._transport = self.bzrdir.transport.clone('..')
924
self._base = self._transport.base
925
self._format = _format
926
if _control_files is None:
927
raise ValueError('BzrBranch _control_files is None')
928
self.control_files = _control_files
929
if deprecated_passed(init):
930
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
931
"deprecated as of bzr 0.8. Please use Branch.create().",
935
# this is slower than before deprecation, oh well never mind.
937
self._initialize(transport.base)
938
self._check_format(_format)
939
if deprecated_passed(relax_version_check):
940
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
941
"relax_version_check parameter is deprecated as of bzr 0.8. "
942
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
946
if (not relax_version_check
947
and not self._format.is_supported()):
948
raise errors.UnsupportedFormatError(format=fmt)
949
if deprecated_passed(transport):
950
warn("BzrBranch.__init__(transport=XXX...): The transport "
951
"parameter is deprecated as of bzr 0.8. "
952
"Please use Branch.open, or bzrdir.open_branch().",
955
self.repository = _repository
958
return '%s(%r)' % (self.__class__.__name__, self.base)
963
# TODO: It might be best to do this somewhere else,
964
# but it is nice for a Branch object to automatically
965
# cache it's information.
966
# Alternatively, we could have the Transport objects cache requests
967
# See the earlier discussion about how major objects (like Branch)
968
# should never expect their __del__ function to run.
969
# XXX: cache_root seems to be unused, 2006-01-13 mbp
970
if hasattr(self, 'cache_root') and self.cache_root is not None:
972
osutils.rmtree(self.cache_root)
975
self.cache_root = None
980
base = property(_get_base, doc="The URL for the root of this branch.")
982
def _finish_transaction(self):
983
"""Exit the current transaction."""
984
return self.control_files._finish_transaction()
986
def get_transaction(self):
987
"""Return the current active transaction.
989
If no transaction is active, this returns a passthrough object
990
for which all data is immediately flushed and no caching happens.
992
# this is an explicit function so that we can do tricky stuff
993
# when the storage in rev_storage is elsewhere.
994
# we probably need to hook the two 'lock a location' and
995
# 'have a transaction' together more delicately, so that
996
# we can have two locks (branch and storage) and one transaction
997
# ... and finishing the transaction unlocks both, but unlocking
998
# does not. - RBC 20051121
999
return self.control_files.get_transaction()
1001
def _set_transaction(self, transaction):
1002
"""Set a new active transaction."""
1003
return self.control_files._set_transaction(transaction)
1005
def abspath(self, name):
1006
"""See Branch.abspath."""
1007
return self.control_files._transport.abspath(name)
1009
def _check_format(self, format):
1010
"""Identify the branch format if needed.
1012
The format is stored as a reference to the format object in
1013
self._format for code that needs to check it later.
1015
The format parameter is either None or the branch format class
1016
used to open this branch.
1018
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1021
format = BranchFormat.find_format(self.bzrdir)
1022
self._format = format
1023
mutter("got branch format %s", self._format)
1026
def get_root_id(self):
1027
"""See Branch.get_root_id."""
1028
tree = self.repository.revision_tree(self.last_revision())
1029
return tree.inventory.root.file_id
1031
def is_locked(self):
1032
return self.control_files.is_locked()
1034
def lock_write(self):
1035
self.repository.lock_write()
1037
self.control_files.lock_write()
1039
self.repository.unlock()
1042
def lock_read(self):
1043
self.repository.lock_read()
1045
self.control_files.lock_read()
1047
self.repository.unlock()
1051
# TODO: test for failed two phase locks. This is known broken.
1053
self.control_files.unlock()
1055
self.repository.unlock()
1057
def peek_lock_mode(self):
1058
if self.control_files._lock_count == 0:
1061
return self.control_files._lock_mode
1063
def get_physical_lock_status(self):
1064
return self.control_files.get_physical_lock_status()
1067
def print_file(self, file, revision_id):
1068
"""See Branch.print_file."""
1069
return self.repository.print_file(file, revision_id)
1072
def append_revision(self, *revision_ids):
1073
"""See Branch.append_revision."""
1074
for revision_id in revision_ids:
1075
mutter("add {%s} to revision-history" % revision_id)
1076
rev_history = self.revision_history()
1077
rev_history.extend(revision_ids)
1078
self.set_revision_history(rev_history)
1081
def set_revision_history(self, rev_history):
1082
"""See Branch.set_revision_history."""
1083
self.control_files.put_utf8(
1084
'revision-history', '\n'.join(rev_history))
1085
transaction = self.get_transaction()
1086
history = transaction.map.find_revision_history()
1087
if history is not None:
1088
# update the revision history in the identity map.
1089
history[:] = list(rev_history)
1090
# this call is disabled because revision_history is
1091
# not really an object yet, and the transaction is for objects.
1092
# transaction.register_dirty(history)
1094
transaction.map.add_revision_history(rev_history)
1095
# this call is disabled because revision_history is
1096
# not really an object yet, and the transaction is for objects.
1097
# transaction.register_clean(history)
1100
def revision_history(self):
1101
"""See Branch.revision_history."""
1102
transaction = self.get_transaction()
1103
history = transaction.map.find_revision_history()
1104
if history is not None:
1105
# mutter("cache hit for revision-history in %s", self)
1106
return list(history)
1107
decode_utf8 = cache_utf8.decode
1108
history = [decode_utf8(l.rstrip('\r\n')) for l in
1109
self.control_files.get('revision-history').readlines()]
1110
transaction.map.add_revision_history(history)
1111
# this call is disabled because revision_history is
1112
# not really an object yet, and the transaction is for objects.
1113
# transaction.register_clean(history, precious=True)
1114
return list(history)
1117
def generate_revision_history(self, revision_id, last_rev=None,
1119
"""Create a new revision history that will finish with revision_id.
1121
:param revision_id: the new tip to use.
1122
:param last_rev: The previous last_revision. If not None, then this
1123
must be a ancestory of revision_id, or DivergedBranches is raised.
1124
:param other_branch: The other branch that DivergedBranches should
1125
raise with respect to.
1127
# stop_revision must be a descendant of last_revision
1128
stop_graph = self.repository.get_revision_graph(revision_id)
1129
if last_rev is not None and last_rev not in stop_graph:
1130
# our previous tip is not merged into stop_revision
1131
raise errors.DivergedBranches(self, other_branch)
1132
# make a new revision history from the graph
1133
current_rev_id = revision_id
1135
while current_rev_id not in (None, revision.NULL_REVISION):
1136
new_history.append(current_rev_id)
1137
current_rev_id_parents = stop_graph[current_rev_id]
1139
current_rev_id = current_rev_id_parents[0]
1141
current_rev_id = None
1142
new_history.reverse()
1143
self.set_revision_history(new_history)
1146
def update_revisions(self, other, stop_revision=None):
1147
"""See Branch.update_revisions."""
1150
if stop_revision is None:
1151
stop_revision = other.last_revision()
1152
if stop_revision is None:
1153
# if there are no commits, we're done.
1155
# whats the current last revision, before we fetch [and change it
1157
last_rev = self.last_revision()
1158
# we fetch here regardless of whether we need to so that we pickup
1160
self.fetch(other, stop_revision)
1161
my_ancestry = self.repository.get_ancestry(last_rev)
1162
if stop_revision in my_ancestry:
1163
# last_revision is a descendant of stop_revision
1165
self.generate_revision_history(stop_revision, last_rev=last_rev,
1170
def basis_tree(self):
1171
"""See Branch.basis_tree."""
1172
return self.repository.revision_tree(self.last_revision())
1174
@deprecated_method(zero_eight)
1175
def working_tree(self):
1176
"""Create a Working tree object for this branch."""
1178
from bzrlib.transport.local import LocalTransport
1179
if (self.base.find('://') != -1 or
1180
not isinstance(self._transport, LocalTransport)):
1181
raise NoWorkingTree(self.base)
1182
return self.bzrdir.open_workingtree()
1185
def pull(self, source, overwrite=False, stop_revision=None):
1186
"""See Branch.pull."""
1189
old_count = len(self.revision_history())
1191
self.update_revisions(source,stop_revision)
1192
except DivergedBranches:
1196
self.set_revision_history(source.revision_history())
1197
new_count = len(self.revision_history())
1198
return new_count - old_count
1202
def get_parent(self):
1203
"""See Branch.get_parent."""
1205
_locs = ['parent', 'pull', 'x-pull']
1206
assert self.base[-1] == '/'
1209
parent = self.control_files.get(l).read().strip('\n')
1212
# This is an old-format absolute path to a local branch
1213
# turn it into a url
1214
if parent.startswith('/'):
1215
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1217
return urlutils.join(self.base[:-1], parent)
1218
except errors.InvalidURLJoin, e:
1219
raise errors.InaccessibleParent(parent, self.base)
1222
def get_push_location(self):
1223
"""See Branch.get_push_location."""
1224
push_loc = self.get_config().get_user_option('push_location')
1227
def set_push_location(self, location):
1228
"""See Branch.set_push_location."""
1229
self.get_config().set_user_option('push_location', location,
1233
def set_parent(self, url):
1234
"""See Branch.set_parent."""
1235
# TODO: Maybe delete old location files?
1236
# URLs should never be unicode, even on the local fs,
1237
# FIXUP this and get_parent in a future branch format bump:
1238
# read and rewrite the file, and have the new format code read
1239
# using .get not .get_utf8. RBC 20060125
1241
self.control_files._transport.delete('parent')
1243
if isinstance(url, unicode):
1245
url = url.encode('ascii')
1246
except UnicodeEncodeError:
1247
raise bzrlib.errors.InvalidURL(url,
1248
"Urls must be 7-bit ascii, "
1249
"use bzrlib.urlutils.escape")
1251
url = urlutils.relative_url(self.base, url)
1252
self.control_files.put('parent', StringIO(url + '\n'))
1254
@deprecated_function(zero_nine)
1255
def tree_config(self):
1256
"""DEPRECATED; call get_config instead.
1257
TreeConfig has become part of BranchConfig."""
1258
return TreeConfig(self)
1261
class BzrBranch5(BzrBranch):
1262
"""A format 5 branch. This supports new features over plan branches.
1264
It has support for a master_branch which is the data for bound branches.
1272
super(BzrBranch5, self).__init__(_format=_format,
1273
_control_files=_control_files,
1275
_repository=_repository)
1278
def pull(self, source, overwrite=False, stop_revision=None):
1279
"""Updates branch.pull to be bound branch aware."""
1280
bound_location = self.get_bound_location()
1281
if source.base != bound_location:
1282
# not pulling from master, so we need to update master.
1283
master_branch = self.get_master_branch()
1285
master_branch.pull(source)
1286
source = master_branch
1287
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
1289
def get_bound_location(self):
1291
return self.control_files.get_utf8('bound').read()[:-1]
1292
except errors.NoSuchFile:
1296
def get_master_branch(self):
1297
"""Return the branch we are bound to.
1299
:return: Either a Branch, or None
1301
This could memoise the branch, but if thats done
1302
it must be revalidated on each new lock.
1303
So for now we just don't memoise it.
1304
# RBC 20060304 review this decision.
1306
bound_loc = self.get_bound_location()
1310
return Branch.open(bound_loc)
1311
except (errors.NotBranchError, errors.ConnectionError), e:
1312
raise errors.BoundBranchConnectionFailure(
1316
def set_bound_location(self, location):
1317
"""Set the target where this branch is bound to.
1319
:param location: URL to the target branch
1322
self.control_files.put_utf8('bound', location+'\n')
1325
self.control_files._transport.delete('bound')
1331
def bind(self, other):
1332
"""Bind the local branch the other branch.
1334
:param other: The branch to bind to
1337
# TODO: jam 20051230 Consider checking if the target is bound
1338
# It is debatable whether you should be able to bind to
1339
# a branch which is itself bound.
1340
# Committing is obviously forbidden,
1341
# but binding itself may not be.
1342
# Since we *have* to check at commit time, we don't
1343
# *need* to check here
1346
# we are now equal to or a suffix of other.
1348
# Since we have 'pulled' from the remote location,
1349
# now we should try to pull in the opposite direction
1350
# in case the local tree has more revisions than the
1352
# There may be a different check you could do here
1353
# rather than actually trying to install revisions remotely.
1354
# TODO: capture an exception which indicates the remote branch
1356
# If it is up-to-date, this probably should not be a failure
1358
# lock other for write so the revision-history syncing cannot race
1362
# if this does not error, other now has the same last rev we do
1363
# it can only error if the pull from other was concurrent with
1364
# a commit to other from someone else.
1366
# until we ditch revision-history, we need to sync them up:
1367
self.set_revision_history(other.revision_history())
1368
# now other and self are up to date with each other and have the
1369
# same revision-history.
1373
self.set_bound_location(other.base)
1377
"""If bound, unbind"""
1378
return self.set_bound_location(None)
1382
"""Synchronise this branch with the master branch if any.
1384
:return: None or the last_revision that was pivoted out during the
1387
master = self.get_master_branch()
1388
if master is not None:
1389
old_tip = self.last_revision()
1390
self.pull(master, overwrite=True)
1391
if old_tip in self.repository.get_ancestry(self.last_revision()):
1397
class BranchTestProviderAdapter(object):
1398
"""A tool to generate a suite testing multiple branch formats at once.
1400
This is done by copying the test once for each transport and injecting
1401
the transport_server, transport_readonly_server, and branch_format
1402
classes into each copy. Each copy is also given a new id() to make it
1406
def __init__(self, transport_server, transport_readonly_server, formats):
1407
self._transport_server = transport_server
1408
self._transport_readonly_server = transport_readonly_server
1409
self._formats = formats
1411
def adapt(self, test):
1412
result = TestSuite()
1413
for branch_format, bzrdir_format in self._formats:
1414
new_test = deepcopy(test)
1415
new_test.transport_server = self._transport_server
1416
new_test.transport_readonly_server = self._transport_readonly_server
1417
new_test.bzrdir_format = bzrdir_format
1418
new_test.branch_format = branch_format
1419
def make_new_test_id():
1420
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1421
return lambda: new_id
1422
new_test.id = make_new_test_id()
1423
result.addTest(new_test)
1427
class BranchCheckResult(object):
1428
"""Results of checking branch consistency.
1433
def __init__(self, branch):
1434
self.branch = branch
1436
def report_results(self, verbose):
1437
"""Report the check results via trace.note.
1439
:param verbose: Requests more detailed display of what was checked,
1442
note('checked branch %s format %s',
1444
self.branch._format)
1447
######################################################################
1451
@deprecated_function(zero_eight)
1452
def is_control_file(*args, **kwargs):
1453
"""See bzrlib.workingtree.is_control_file."""
1454
return bzrlib.workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
