1
# Copyright (C) 2005, 2006, 2007 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 cStringIO import StringIO
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
22
from copy import deepcopy
23
from unittest import TestSuite
24
from warnings import warn
30
config as _mod_config,
35
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TreeConfig
42
from bzrlib.lockable_files import LockableFiles, TransportLock
43
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
51
HistoryMissing, InvalidRevisionId,
52
InvalidRevisionNumber, LockError, NoSuchFile,
53
NoSuchRevision, NoWorkingTree, NotVersionedError,
54
NotBranchError, UninitializableFormat,
55
UnlistableStore, UnlistableBranch,
57
from bzrlib.symbol_versioning import (deprecated_function,
61
zero_eight, zero_nine,
63
from bzrlib.trace import mutter, note
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 Branch Format 6 (bzr 0.15)\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
hooks: An instance of BranchHooks.
91
# this is really an instance variable - FIXME move it there
95
# override this to set the strategy for storing tags
97
return DisabledTags(self)
99
def __init__(self, *ignored, **ignored_too):
100
self.tags = self._make_tags()
102
def break_lock(self):
103
"""Break a lock if one is present from another instance.
105
Uses the ui factory to ask for confirmation if the lock may be from
108
This will probe the repository for its lock as well.
110
self.control_files.break_lock()
111
self.repository.break_lock()
112
master = self.get_master_branch()
113
if master is not None:
117
@deprecated_method(zero_eight)
118
def open_downlevel(base):
119
"""Open a branch which may be of an old format."""
120
return Branch.open(base, _unsupported=True)
123
def open(base, _unsupported=False):
124
"""Open the branch rooted at base.
126
For instance, if the branch is at URL/.bzr/branch,
127
Branch.open(URL) -> a Branch instance.
129
control = bzrdir.BzrDir.open(base, _unsupported)
130
return control.open_branch(_unsupported)
133
def open_containing(url):
134
"""Open an existing branch which contains url.
136
This probes for a branch at url, and searches upwards from there.
138
Basically we keep looking up until we find the control directory or
139
run into the root. If there isn't one, raises NotBranchError.
140
If there is one and it is either an unrecognised format or an unsupported
141
format, UnknownFormatError or UnsupportedFormatError are raised.
142
If there is one, it is returned, along with the unused portion of url.
144
control, relpath = bzrdir.BzrDir.open_containing(url)
145
return control.open_branch(), relpath
148
@deprecated_function(zero_eight)
149
def initialize(base):
150
"""Create a new working tree and branch, rooted at 'base' (url)
152
NOTE: This will soon be deprecated in favour of creation
155
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
157
@deprecated_function(zero_eight)
158
def setup_caching(self, cache_root):
159
"""Subclasses that care about caching should override this, and set
160
up cached stores located under cache_root.
162
NOTE: This is unused.
166
def get_config(self):
167
return BranchConfig(self)
170
return self.get_config().get_nickname()
172
def _set_nick(self, nick):
173
self.get_config().set_user_option('nickname', nick)
175
nick = property(_get_nick, _set_nick)
178
raise NotImplementedError(self.is_locked)
180
def lock_write(self):
181
raise NotImplementedError(self.lock_write)
184
raise NotImplementedError(self.lock_read)
187
raise NotImplementedError(self.unlock)
189
def peek_lock_mode(self):
190
"""Return lock mode for the Branch: 'r', 'w' or None"""
191
raise NotImplementedError(self.peek_lock_mode)
193
def get_physical_lock_status(self):
194
raise NotImplementedError(self.get_physical_lock_status)
196
def abspath(self, name):
197
"""Return absolute filename for something in the branch
199
XXX: Robert Collins 20051017 what is this used for? why is it a branch
200
method and not a tree method.
202
raise NotImplementedError(self.abspath)
204
def bind(self, other):
205
"""Bind the local branch the other branch.
207
:param other: The branch to bind to
210
raise errors.UpgradeRequired(self.base)
213
def fetch(self, from_branch, last_revision=None, pb=None):
214
"""Copy revisions from from_branch into this branch.
216
:param from_branch: Where to copy from.
217
:param last_revision: What revision to stop at (None for at the end
219
:param pb: An optional progress bar to use.
221
Returns the copied revision count and the failed revisions in a tuple:
224
if self.base == from_branch.base:
227
nested_pb = ui.ui_factory.nested_progress_bar()
232
from_branch.lock_read()
234
if last_revision is None:
235
pb.update('get source history')
236
last_revision = from_branch.last_revision()
237
if last_revision is None:
238
last_revision = _mod_revision.NULL_REVISION
239
return self.repository.fetch(from_branch.repository,
240
revision_id=last_revision,
243
if nested_pb is not None:
247
def get_bound_location(self):
248
"""Return the URL of the branch we are bound to.
250
Older format branches cannot bind, please be sure to use a metadir
255
def get_old_bound_location(self):
256
"""Return the URL of the branch we used to be bound to
258
raise errors.UpgradeRequired(self.base)
260
def get_commit_builder(self, parents, config=None, timestamp=None,
261
timezone=None, committer=None, revprops=None,
263
"""Obtain a CommitBuilder for this branch.
265
:param parents: Revision ids of the parents of the new revision.
266
:param config: Optional configuration to use.
267
:param timestamp: Optional timestamp recorded for commit.
268
:param timezone: Optional timezone for timestamp.
269
:param committer: Optional committer to set for commit.
270
:param revprops: Optional dictionary of revision properties.
271
:param revision_id: Optional revision id.
275
config = self.get_config()
277
return self.repository.get_commit_builder(self, parents, config,
278
timestamp, timezone, committer, revprops, revision_id)
280
def get_master_branch(self):
281
"""Return the branch we are bound to.
283
:return: Either a Branch, or None
287
def get_revision_delta(self, revno):
288
"""Return the delta for one revision.
290
The delta is relative to its mainline predecessor, or the
291
empty tree for revision 1.
293
assert isinstance(revno, int)
294
rh = self.revision_history()
295
if not (1 <= revno <= len(rh)):
296
raise InvalidRevisionNumber(revno)
297
return self.repository.get_revision_delta(rh[revno-1])
299
def get_root_id(self):
300
"""Return the id of this branches root"""
301
raise NotImplementedError(self.get_root_id)
303
def print_file(self, file, revision_id):
304
"""Print `file` to stdout."""
305
raise NotImplementedError(self.print_file)
307
def append_revision(self, *revision_ids):
308
raise NotImplementedError(self.append_revision)
310
def set_revision_history(self, rev_history):
311
raise NotImplementedError(self.set_revision_history)
313
def revision_history(self):
314
"""Return sequence of revision hashes on to this branch."""
315
raise NotImplementedError(self.revision_history)
318
"""Return current revision number for this branch.
320
That is equivalent to the number of revisions committed to
323
return len(self.revision_history())
326
"""Older format branches cannot bind or unbind."""
327
raise errors.UpgradeRequired(self.base)
329
def set_append_revisions_only(self, enabled):
330
"""Older format branches are never restricted to append-only"""
331
raise errors.UpgradeRequired(self.base)
333
def last_revision(self):
334
"""Return last revision id, or None"""
335
ph = self.revision_history()
341
def last_revision_info(self):
342
"""Return information about the last revision.
344
:return: A tuple (revno, last_revision_id).
346
rh = self.revision_history()
349
return (revno, rh[-1])
351
return (0, _mod_revision.NULL_REVISION)
353
def missing_revisions(self, other, stop_revision=None):
354
"""Return a list of new revisions that would perfectly fit.
356
If self and other have not diverged, return a list of the revisions
357
present in other, but missing from self.
359
self_history = self.revision_history()
360
self_len = len(self_history)
361
other_history = other.revision_history()
362
other_len = len(other_history)
363
common_index = min(self_len, other_len) -1
364
if common_index >= 0 and \
365
self_history[common_index] != other_history[common_index]:
366
raise DivergedBranches(self, other)
368
if stop_revision is None:
369
stop_revision = other_len
371
assert isinstance(stop_revision, int)
372
if stop_revision > other_len:
373
raise errors.NoSuchRevision(self, stop_revision)
374
return other_history[self_len:stop_revision]
376
def update_revisions(self, other, stop_revision=None):
377
"""Pull in new perfect-fit revisions.
379
:param other: Another Branch to pull from
380
:param stop_revision: Updated until the given revision
383
raise NotImplementedError(self.update_revisions)
385
def revision_id_to_revno(self, revision_id):
386
"""Given a revision id, return its revno"""
387
if revision_id is None:
389
revision_id = osutils.safe_revision_id(revision_id)
390
history = self.revision_history()
392
return history.index(revision_id) + 1
394
raise bzrlib.errors.NoSuchRevision(self, revision_id)
396
def get_rev_id(self, revno, history=None):
397
"""Find the revision id of the specified revno."""
401
history = self.revision_history()
402
if revno <= 0 or revno > len(history):
403
raise bzrlib.errors.NoSuchRevision(self, revno)
404
return history[revno - 1]
406
def pull(self, source, overwrite=False, stop_revision=None):
407
"""Mirror source into this branch.
409
This branch is considered to be 'local', having low latency.
411
:returns: PullResult instance
413
raise NotImplementedError(self.pull)
415
def push(self, target, overwrite=False, stop_revision=None):
416
"""Mirror this branch into target.
418
This branch is considered to be 'local', having low latency.
420
raise NotImplementedError(self.push)
422
def basis_tree(self):
423
"""Return `Tree` object for last revision."""
424
return self.repository.revision_tree(self.last_revision())
426
def rename_one(self, from_rel, to_rel):
429
This can change the directory or the filename or both.
431
raise NotImplementedError(self.rename_one)
433
def move(self, from_paths, to_name):
436
to_name must exist as a versioned directory.
438
If to_name exists and is a directory, the files are moved into
439
it, keeping their old names. If it is a directory,
441
Note that to_name is only the last component of the new name;
442
this doesn't change the directory.
444
This returns a list of (from_path, to_path) pairs for each
447
raise NotImplementedError(self.move)
449
def get_parent(self):
450
"""Return the parent location of the branch.
452
This is the default location for push/pull/missing. The usual
453
pattern is that the user can override it by specifying a
456
raise NotImplementedError(self.get_parent)
458
def get_submit_branch(self):
459
"""Return the submit location of the branch.
461
This is the default location for bundle. The usual
462
pattern is that the user can override it by specifying a
465
return self.get_config().get_user_option('submit_branch')
467
def set_submit_branch(self, location):
468
"""Return the submit location of the branch.
470
This is the default location for bundle. The usual
471
pattern is that the user can override it by specifying a
474
self.get_config().set_user_option('submit_branch', location)
476
def get_push_location(self):
477
"""Return the None or the location to push this branch to."""
478
raise NotImplementedError(self.get_push_location)
480
def set_push_location(self, location):
481
"""Set a new push location for this branch."""
482
raise NotImplementedError(self.set_push_location)
484
def set_parent(self, url):
485
raise NotImplementedError(self.set_parent)
489
"""Synchronise this branch with the master branch if any.
491
:return: None or the last_revision pivoted out during the update.
495
def check_revno(self, revno):
497
Check whether a revno corresponds to any revision.
498
Zero (the NULL revision) is considered valid.
501
self.check_real_revno(revno)
503
def check_real_revno(self, revno):
505
Check whether a revno corresponds to a real revision.
506
Zero (the NULL revision) is considered invalid
508
if revno < 1 or revno > self.revno():
509
raise InvalidRevisionNumber(revno)
512
def clone(self, *args, **kwargs):
513
"""Clone this branch into to_bzrdir preserving all semantic values.
515
revision_id: if not None, the revision history in the new branch will
516
be truncated to end with revision_id.
518
# for API compatibility, until 0.8 releases we provide the old api:
519
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
520
# after 0.8 releases, the *args and **kwargs should be changed:
521
# def clone(self, to_bzrdir, revision_id=None):
522
if (kwargs.get('to_location', None) or
523
kwargs.get('revision', None) or
524
kwargs.get('basis_branch', None) or
525
(len(args) and isinstance(args[0], basestring))):
526
# backwards compatibility api:
527
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
528
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
531
basis_branch = args[2]
533
basis_branch = kwargs.get('basis_branch', None)
535
basis = basis_branch.bzrdir
540
revision_id = args[1]
542
revision_id = kwargs.get('revision', None)
547
# no default to raise if not provided.
548
url = kwargs.get('to_location')
549
return self.bzrdir.clone(url,
550
revision_id=revision_id,
551
basis=basis).open_branch()
553
# generate args by hand
555
revision_id = args[1]
557
revision_id = kwargs.get('revision_id', None)
561
# no default to raise if not provided.
562
to_bzrdir = kwargs.get('to_bzrdir')
563
result = self._format.initialize(to_bzrdir)
564
self.copy_content_into(result, revision_id=revision_id)
568
def sprout(self, to_bzrdir, revision_id=None):
569
"""Create a new line of development from the branch, into to_bzrdir.
571
revision_id: if not None, the revision history in the new branch will
572
be truncated to end with revision_id.
574
result = self._format.initialize(to_bzrdir)
575
self.copy_content_into(result, revision_id=revision_id)
576
result.set_parent(self.bzrdir.root_transport.base)
579
def _synchronize_history(self, destination, revision_id):
580
"""Synchronize last revision and revision history between branches.
582
This version is most efficient when the destination is also a
583
BzrBranch5, but works for BzrBranch6 as long as the revision
584
history is the true lefthand parent history, and all of the revisions
585
are in the destination's repository. If not, set_revision_history
588
:param destination: The branch to copy the history into
589
:param revision_id: The revision-id to truncate history at. May
590
be None to copy complete history.
592
new_history = self.revision_history()
593
if revision_id is not None:
594
revision_id = osutils.safe_revision_id(revision_id)
596
new_history = new_history[:new_history.index(revision_id) + 1]
598
rev = self.repository.get_revision(revision_id)
599
new_history = rev.get_history(self.repository)[1:]
600
destination.set_revision_history(new_history)
603
def copy_content_into(self, destination, revision_id=None):
604
"""Copy the content of self into destination.
606
revision_id: if not None, the revision history in the new branch will
607
be truncated to end with revision_id.
609
self._synchronize_history(destination, revision_id)
611
parent = self.get_parent()
612
except errors.InaccessibleParent, e:
613
mutter('parent was not accessible to copy: %s', e)
616
destination.set_parent(parent)
620
"""Check consistency of the branch.
622
In particular this checks that revisions given in the revision-history
623
do actually match up in the revision graph, and that they're all
624
present in the repository.
626
Callers will typically also want to check the repository.
628
:return: A BranchCheckResult.
630
mainline_parent_id = None
631
for revision_id in self.revision_history():
633
revision = self.repository.get_revision(revision_id)
634
except errors.NoSuchRevision, e:
635
raise errors.BzrCheckError("mainline revision {%s} not in repository"
637
# In general the first entry on the revision history has no parents.
638
# But it's not illegal for it to have parents listed; this can happen
639
# in imports from Arch when the parents weren't reachable.
640
if mainline_parent_id is not None:
641
if mainline_parent_id not in revision.parent_ids:
642
raise errors.BzrCheckError("previous revision {%s} not listed among "
644
% (mainline_parent_id, revision_id))
645
mainline_parent_id = revision_id
646
return BranchCheckResult(self)
648
def _get_checkout_format(self):
649
"""Return the most suitable metadir for a checkout of this branch.
650
Weaves are used if this branch's repostory uses weaves.
652
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
653
from bzrlib.repofmt import weaverepo
654
format = bzrdir.BzrDirMetaFormat1()
655
format.repository_format = weaverepo.RepositoryFormat7()
657
format = self.repository.bzrdir.checkout_metadir()
658
format.branch_format = self._format
661
def create_checkout(self, to_location, revision_id=None,
663
"""Create a checkout of a branch.
665
:param to_location: The url to produce the checkout at
666
:param revision_id: The revision to check out
667
:param lightweight: If True, produce a lightweight checkout, otherwise,
668
produce a bound branch (heavyweight checkout)
669
:return: The tree of the created checkout
671
t = transport.get_transport(to_location)
674
except errors.FileExists:
677
format = self._get_checkout_format()
678
checkout = format.initialize_on_transport(t)
679
BranchReferenceFormat().initialize(checkout, self)
681
format = self._get_checkout_format()
682
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
683
to_location, force_new_tree=False, format=format)
684
checkout = checkout_branch.bzrdir
685
checkout_branch.bind(self)
686
# pull up to the specified revision_id to set the initial
687
# branch tip correctly, and seed it with history.
688
checkout_branch.pull(self, stop_revision=revision_id)
689
tree = checkout.create_workingtree(revision_id)
690
basis_tree = tree.basis_tree()
691
basis_tree.lock_read()
693
for path, file_id in basis_tree.iter_references():
694
reference_parent = self.reference_parent(file_id, path)
695
reference_parent.create_checkout(tree.abspath(path),
696
basis_tree.get_reference_revision(file_id, path),
702
def reference_parent(self, file_id, path):
703
"""Return the parent branch for a tree-reference file_id
704
:param file_id: The file_id of the tree reference
705
:param path: The path of the file_id in the tree
706
:return: A branch associated with the file_id
708
# FIXME should provide multiple branches, based on config
709
return Branch.open(self.bzrdir.root_transport.clone(path).base)
711
def supports_tags(self):
712
return self._format.supports_tags()
715
class BranchFormat(object):
716
"""An encapsulation of the initialization and open routines for a format.
718
Formats provide three things:
719
* An initialization routine,
723
Formats are placed in an dict by their format string for reference
724
during branch opening. Its not required that these be instances, they
725
can be classes themselves with class methods - it simply depends on
726
whether state is needed for a given format or not.
728
Once a format is deprecated, just deprecate the initialize and open
729
methods on the format class. Do not deprecate the object, as the
730
object will be created every time regardless.
733
_default_format = None
734
"""The default format used for new branches."""
737
"""The known formats."""
740
def find_format(klass, a_bzrdir):
741
"""Return the format for the branch object in a_bzrdir."""
743
transport = a_bzrdir.get_branch_transport(None)
744
format_string = transport.get("format").read()
745
return klass._formats[format_string]
747
raise NotBranchError(path=transport.base)
749
raise errors.UnknownFormatError(format=format_string)
752
def get_default_format(klass):
753
"""Return the current default format."""
754
return klass._default_format
756
def get_format_string(self):
757
"""Return the ASCII format string that identifies this format."""
758
raise NotImplementedError(self.get_format_string)
760
def get_format_description(self):
761
"""Return the short format description for this format."""
762
raise NotImplementedError(self.get_format_description)
764
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
766
"""Initialize a branch in a bzrdir, with specified files
768
:param a_bzrdir: The bzrdir to initialize the branch in
769
:param utf8_files: The files to create as a list of
770
(filename, content) tuples
771
:param set_format: If True, set the format with
772
self.get_format_string. (BzrBranch4 has its format set
774
:return: a branch in this format
776
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
777
branch_transport = a_bzrdir.get_branch_transport(self)
779
'metadir': ('lock', lockdir.LockDir),
780
'branch4': ('branch-lock', lockable_files.TransportLock),
782
lock_name, lock_class = lock_map[lock_type]
783
control_files = lockable_files.LockableFiles(branch_transport,
784
lock_name, lock_class)
785
control_files.create_lock()
786
control_files.lock_write()
788
control_files.put_utf8('format', self.get_format_string())
790
for file, content in utf8_files:
791
control_files.put_utf8(file, content)
793
control_files.unlock()
794
return self.open(a_bzrdir, _found=True)
796
def initialize(self, a_bzrdir):
797
"""Create a branch of this format in a_bzrdir."""
798
raise NotImplementedError(self.initialize)
800
def is_supported(self):
801
"""Is this format supported?
803
Supported formats can be initialized and opened.
804
Unsupported formats may not support initialization or committing or
805
some other features depending on the reason for not being supported.
809
def open(self, a_bzrdir, _found=False):
810
"""Return the branch object for a_bzrdir
812
_found is a private parameter, do not use it. It is used to indicate
813
if format probing has already be done.
815
raise NotImplementedError(self.open)
818
def register_format(klass, format):
819
klass._formats[format.get_format_string()] = format
822
def set_default_format(klass, format):
823
klass._default_format = format
826
def unregister_format(klass, format):
827
assert klass._formats[format.get_format_string()] is format
828
del klass._formats[format.get_format_string()]
831
return self.get_format_string().rstrip()
833
def supports_tags(self):
834
"""True if this format supports tags stored in the branch"""
835
return False # by default
837
# XXX: Probably doesn't really belong here -- mbp 20070212
838
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
840
branch_transport = a_bzrdir.get_branch_transport(self)
841
control_files = lockable_files.LockableFiles(branch_transport,
842
lock_filename, lock_class)
843
control_files.create_lock()
844
control_files.lock_write()
846
for filename, content in utf8_files:
847
control_files.put_utf8(filename, content)
849
control_files.unlock()
852
class BranchHooks(dict):
853
"""A dictionary mapping hook name to a list of callables for branch hooks.
855
e.g. ['set_rh'] Is the list of items to be called when the
856
set_revision_history function is invoked.
860
"""Create the default hooks.
862
These are all empty initially, because by default nothing should get
866
# Introduced in 0.15:
867
# invoked whenever the revision history has been set
868
# with set_revision_history. The api signature is
869
# (branch, revision_history), and the branch will
872
# invoked after a push operation completes.
873
# the api signature is
875
# containing the members
876
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
877
# where local is the local branch or None, master is the target
878
# master branch, and the rest should be self explanatory. The source
879
# is read locked and the target branches write locked. Source will
880
# be the local low-latency branch.
881
self['post_push'] = []
882
# invoked after a pull operation completes.
883
# the api signature is
885
# containing the members
886
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
887
# where local is the local branch or None, master is the target
888
# master branch, and the rest should be self explanatory. The source
889
# is read locked and the target branches write locked. The local
890
# branch is the low-latency branch.
891
self['post_pull'] = []
892
# invoked after a commit operation completes.
893
# the api signature is
894
# (local, master, old_revno, old_revid, new_revno, new_revid)
895
# old_revid is NULL_REVISION for the first commit to a branch.
896
self['post_commit'] = []
897
# invoked after a uncommit operation completes.
898
# the api signature is
899
# (local, master, old_revno, old_revid, new_revno, new_revid) where
900
# local is the local branch or None, master is the target branch,
901
# and an empty branch recieves new_revno of 0, new_revid of None.
902
self['post_uncommit'] = []
904
def install_hook(self, hook_name, a_callable):
905
"""Install a_callable in to the hook hook_name.
907
:param hook_name: A hook name. See the __init__ method of BranchHooks
908
for the complete list of hooks.
909
:param a_callable: The callable to be invoked when the hook triggers.
910
The exact signature will depend on the hook - see the __init__
911
method of BranchHooks for details on each hook.
914
self[hook_name].append(a_callable)
916
raise errors.UnknownHook('branch', hook_name)
919
# install the default hooks into the Branch class.
920
Branch.hooks = BranchHooks()
923
class BzrBranchFormat4(BranchFormat):
924
"""Bzr branch format 4.
927
- a revision-history file.
928
- a branch-lock lock file [ to be shared with the bzrdir ]
931
def get_format_description(self):
932
"""See BranchFormat.get_format_description()."""
933
return "Branch format 4"
935
def initialize(self, a_bzrdir):
936
"""Create a branch of this format in a_bzrdir."""
937
utf8_files = [('revision-history', ''),
940
return self._initialize_helper(a_bzrdir, utf8_files,
941
lock_type='branch4', set_format=False)
944
super(BzrBranchFormat4, self).__init__()
945
self._matchingbzrdir = bzrdir.BzrDirFormat6()
947
def open(self, a_bzrdir, _found=False):
948
"""Return the branch object for a_bzrdir
950
_found is a private parameter, do not use it. It is used to indicate
951
if format probing has already be done.
954
# we are being called directly and must probe.
955
raise NotImplementedError
956
return BzrBranch(_format=self,
957
_control_files=a_bzrdir._control_files,
959
_repository=a_bzrdir.open_repository())
962
return "Bazaar-NG branch format 4"
965
class BzrBranchFormat5(BranchFormat):
966
"""Bzr branch format 5.
969
- a revision-history file.
971
- a lock dir guarding the branch itself
972
- all of this stored in a branch/ subdirectory
973
- works with shared repositories.
975
This format is new in bzr 0.8.
978
def get_format_string(self):
979
"""See BranchFormat.get_format_string()."""
980
return "Bazaar-NG branch format 5\n"
982
def get_format_description(self):
983
"""See BranchFormat.get_format_description()."""
984
return "Branch format 5"
986
def initialize(self, a_bzrdir):
987
"""Create a branch of this format in a_bzrdir."""
988
utf8_files = [('revision-history', ''),
991
return self._initialize_helper(a_bzrdir, utf8_files)
994
super(BzrBranchFormat5, self).__init__()
995
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
997
def open(self, a_bzrdir, _found=False):
998
"""Return the branch object for a_bzrdir
1000
_found is a private parameter, do not use it. It is used to indicate
1001
if format probing has already be done.
1004
format = BranchFormat.find_format(a_bzrdir)
1005
assert format.__class__ == self.__class__
1006
transport = a_bzrdir.get_branch_transport(None)
1007
control_files = lockable_files.LockableFiles(transport, 'lock',
1009
return BzrBranch5(_format=self,
1010
_control_files=control_files,
1012
_repository=a_bzrdir.find_repository())
1015
class BzrBranchFormat6(BzrBranchFormat5):
1016
"""Branch format with last-revision
1018
Unlike previous formats, this has no explicit revision history. Instead,
1019
this just stores the last-revision, and the left-hand history leading
1020
up to there is the history.
1022
This format was introduced in bzr 0.15
1025
def get_format_string(self):
1026
"""See BranchFormat.get_format_string()."""
1027
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1029
def get_format_description(self):
1030
"""See BranchFormat.get_format_description()."""
1031
return "Branch format 6"
1033
def initialize(self, a_bzrdir):
1034
"""Create a branch of this format in a_bzrdir."""
1035
utf8_files = [('last-revision', '0 null:\n'),
1036
('branch-name', ''),
1037
('branch.conf', ''),
1040
return self._initialize_helper(a_bzrdir, utf8_files)
1042
def open(self, a_bzrdir, _found=False):
1043
"""Return the branch object for a_bzrdir
1045
_found is a private parameter, do not use it. It is used to indicate
1046
if format probing has already be done.
1049
format = BranchFormat.find_format(a_bzrdir)
1050
assert format.__class__ == self.__class__
1051
transport = a_bzrdir.get_branch_transport(None)
1052
control_files = lockable_files.LockableFiles(transport, 'lock',
1054
return BzrBranch6(_format=self,
1055
_control_files=control_files,
1057
_repository=a_bzrdir.find_repository())
1059
def supports_tags(self):
1063
class BranchReferenceFormat(BranchFormat):
1064
"""Bzr branch reference format.
1066
Branch references are used in implementing checkouts, they
1067
act as an alias to the real branch which is at some other url.
1074
def get_format_string(self):
1075
"""See BranchFormat.get_format_string()."""
1076
return "Bazaar-NG Branch Reference Format 1\n"
1078
def get_format_description(self):
1079
"""See BranchFormat.get_format_description()."""
1080
return "Checkout reference format 1"
1082
def initialize(self, a_bzrdir, target_branch=None):
1083
"""Create a branch of this format in a_bzrdir."""
1084
if target_branch is None:
1085
# this format does not implement branch itself, thus the implicit
1086
# creation contract must see it as uninitializable
1087
raise errors.UninitializableFormat(self)
1088
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1089
branch_transport = a_bzrdir.get_branch_transport(self)
1090
branch_transport.put_bytes('location',
1091
target_branch.bzrdir.root_transport.base)
1092
branch_transport.put_bytes('format', self.get_format_string())
1093
return self.open(a_bzrdir, _found=True)
1096
super(BranchReferenceFormat, self).__init__()
1097
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1099
def _make_reference_clone_function(format, a_branch):
1100
"""Create a clone() routine for a branch dynamically."""
1101
def clone(to_bzrdir, revision_id=None):
1102
"""See Branch.clone()."""
1103
return format.initialize(to_bzrdir, a_branch)
1104
# cannot obey revision_id limits when cloning a reference ...
1105
# FIXME RBC 20060210 either nuke revision_id for clone, or
1106
# emit some sort of warning/error to the caller ?!
1109
def open(self, a_bzrdir, _found=False):
1110
"""Return the branch that the branch reference in a_bzrdir points at.
1112
_found is a private parameter, do not use it. It is used to indicate
1113
if format probing has already be done.
1116
format = BranchFormat.find_format(a_bzrdir)
1117
assert format.__class__ == self.__class__
1118
transport = a_bzrdir.get_branch_transport(None)
1119
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
1120
result = real_bzrdir.open_branch()
1121
# this changes the behaviour of result.clone to create a new reference
1122
# rather than a copy of the content of the branch.
1123
# I did not use a proxy object because that needs much more extensive
1124
# testing, and we are only changing one behaviour at the moment.
1125
# If we decide to alter more behaviours - i.e. the implicit nickname
1126
# then this should be refactored to introduce a tested proxy branch
1127
# and a subclass of that for use in overriding clone() and ....
1129
result.clone = self._make_reference_clone_function(result)
1133
# formats which have no format string are not discoverable
1134
# and not independently creatable, so are not registered.
1135
__default_format = BzrBranchFormat5()
1136
BranchFormat.register_format(__default_format)
1137
BranchFormat.register_format(BranchReferenceFormat())
1138
BranchFormat.register_format(BzrBranchFormat6())
1139
BranchFormat.set_default_format(__default_format)
1140
_legacy_formats = [BzrBranchFormat4(),
1143
class BzrBranch(Branch):
1144
"""A branch stored in the actual filesystem.
1146
Note that it's "local" in the context of the filesystem; it doesn't
1147
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1148
it's writable, and can be accessed via the normal filesystem API.
1151
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
1152
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1153
_control_files=None, a_bzrdir=None, _repository=None):
1154
"""Create new branch object at a particular location.
1156
transport -- A Transport object, defining how to access files.
1158
init -- If True, create new control files in a previously
1159
unversioned directory. If False, the branch must already
1162
relax_version_check -- If true, the usual check for the branch
1163
version is not applied. This is intended only for
1164
upgrade/recovery type use; it's not guaranteed that
1165
all operations will work on old format branches.
1167
Branch.__init__(self)
1168
if a_bzrdir is None:
1169
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1171
self.bzrdir = a_bzrdir
1172
# self._transport used to point to the directory containing the
1173
# control directory, but was not used - now it's just the transport
1174
# for the branch control files. mbp 20070212
1175
self._base = self.bzrdir.transport.clone('..').base
1176
self._format = _format
1177
if _control_files is None:
1178
raise ValueError('BzrBranch _control_files is None')
1179
self.control_files = _control_files
1180
self._transport = _control_files._transport
1181
if deprecated_passed(init):
1182
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
1183
"deprecated as of bzr 0.8. Please use Branch.create().",
1187
# this is slower than before deprecation, oh well never mind.
1188
# -> its deprecated.
1189
self._initialize(transport.base)
1190
self._check_format(_format)
1191
if deprecated_passed(relax_version_check):
1192
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
1193
"relax_version_check parameter is deprecated as of bzr 0.8. "
1194
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
1198
if (not relax_version_check
1199
and not self._format.is_supported()):
1200
raise errors.UnsupportedFormatError(format=fmt)
1201
if deprecated_passed(transport):
1202
warn("BzrBranch.__init__(transport=XXX...): The transport "
1203
"parameter is deprecated as of bzr 0.8. "
1204
"Please use Branch.open, or bzrdir.open_branch().",
1207
self.repository = _repository
1210
return '%s(%r)' % (self.__class__.__name__, self.base)
1214
def _get_base(self):
1215
"""Returns the directory containing the control directory."""
1218
base = property(_get_base, doc="The URL for the root of this branch.")
1220
def _finish_transaction(self):
1221
"""Exit the current transaction."""
1222
return self.control_files._finish_transaction()
1224
def get_transaction(self):
1225
"""Return the current active transaction.
1227
If no transaction is active, this returns a passthrough object
1228
for which all data is immediately flushed and no caching happens.
1230
# this is an explicit function so that we can do tricky stuff
1231
# when the storage in rev_storage is elsewhere.
1232
# we probably need to hook the two 'lock a location' and
1233
# 'have a transaction' together more delicately, so that
1234
# we can have two locks (branch and storage) and one transaction
1235
# ... and finishing the transaction unlocks both, but unlocking
1236
# does not. - RBC 20051121
1237
return self.control_files.get_transaction()
1239
def _set_transaction(self, transaction):
1240
"""Set a new active transaction."""
1241
return self.control_files._set_transaction(transaction)
1243
def abspath(self, name):
1244
"""See Branch.abspath."""
1245
return self.control_files._transport.abspath(name)
1247
def _check_format(self, format):
1248
"""Identify the branch format if needed.
1250
The format is stored as a reference to the format object in
1251
self._format for code that needs to check it later.
1253
The format parameter is either None or the branch format class
1254
used to open this branch.
1256
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1259
format = BranchFormat.find_format(self.bzrdir)
1260
self._format = format
1261
mutter("got branch format %s", self._format)
1264
def get_root_id(self):
1265
"""See Branch.get_root_id."""
1266
tree = self.repository.revision_tree(self.last_revision())
1267
return tree.inventory.root.file_id
1269
def is_locked(self):
1270
return self.control_files.is_locked()
1272
def lock_write(self):
1273
self.repository.lock_write()
1275
self.control_files.lock_write()
1277
self.repository.unlock()
1280
def lock_read(self):
1281
self.repository.lock_read()
1283
self.control_files.lock_read()
1285
self.repository.unlock()
1289
# TODO: test for failed two phase locks. This is known broken.
1291
self.control_files.unlock()
1293
self.repository.unlock()
1295
def peek_lock_mode(self):
1296
if self.control_files._lock_count == 0:
1299
return self.control_files._lock_mode
1301
def get_physical_lock_status(self):
1302
return self.control_files.get_physical_lock_status()
1305
def print_file(self, file, revision_id):
1306
"""See Branch.print_file."""
1307
return self.repository.print_file(file, revision_id)
1310
def append_revision(self, *revision_ids):
1311
"""See Branch.append_revision."""
1312
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1313
for revision_id in revision_ids:
1314
_mod_revision.check_not_reserved_id(revision_id)
1315
mutter("add {%s} to revision-history" % revision_id)
1316
rev_history = self.revision_history()
1317
rev_history.extend(revision_ids)
1318
self.set_revision_history(rev_history)
1320
def _write_revision_history(self, history):
1321
"""Factored out of set_revision_history.
1323
This performs the actual writing to disk.
1324
It is intended to be called by BzrBranch5.set_revision_history."""
1325
self.control_files.put_bytes(
1326
'revision-history', '\n'.join(history))
1329
def set_revision_history(self, rev_history):
1330
"""See Branch.set_revision_history."""
1331
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1332
self._write_revision_history(rev_history)
1333
transaction = self.get_transaction()
1334
history = transaction.map.find_revision_history()
1335
if history is not None:
1336
# update the revision history in the identity map.
1337
history[:] = list(rev_history)
1338
# this call is disabled because revision_history is
1339
# not really an object yet, and the transaction is for objects.
1340
# transaction.register_dirty(history)
1342
transaction.map.add_revision_history(rev_history)
1343
# this call is disabled because revision_history is
1344
# not really an object yet, and the transaction is for objects.
1345
# transaction.register_clean(history)
1346
for hook in Branch.hooks['set_rh']:
1347
hook(self, rev_history)
1350
def set_last_revision_info(self, revno, revision_id):
1351
revision_id = osutils.safe_revision_id(revision_id)
1352
history = self._lefthand_history(revision_id)
1353
assert len(history) == revno, '%d != %d' % (len(history), revno)
1354
self.set_revision_history(history)
1356
def _gen_revision_history(self):
1357
history = self.control_files.get('revision-history').read().split('\n')
1358
if history[-1:] == ['']:
1359
# There shouldn't be a trailing newline, but just in case.
1364
def revision_history(self):
1365
"""See Branch.revision_history."""
1366
transaction = self.get_transaction()
1367
history = transaction.map.find_revision_history()
1368
if history is not None:
1369
# mutter("cache hit for revision-history in %s", self)
1370
return list(history)
1371
history = self._gen_revision_history()
1372
transaction.map.add_revision_history(history)
1373
# this call is disabled because revision_history is
1374
# not really an object yet, and the transaction is for objects.
1375
# transaction.register_clean(history, precious=True)
1376
return list(history)
1378
def _lefthand_history(self, revision_id, last_rev=None,
1380
# stop_revision must be a descendant of last_revision
1381
stop_graph = self.repository.get_revision_graph(revision_id)
1382
if last_rev is not None and last_rev not in stop_graph:
1383
# our previous tip is not merged into stop_revision
1384
raise errors.DivergedBranches(self, other_branch)
1385
# make a new revision history from the graph
1386
current_rev_id = revision_id
1388
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1389
new_history.append(current_rev_id)
1390
current_rev_id_parents = stop_graph[current_rev_id]
1392
current_rev_id = current_rev_id_parents[0]
1394
current_rev_id = None
1395
new_history.reverse()
1399
def generate_revision_history(self, revision_id, last_rev=None,
1401
"""Create a new revision history that will finish with revision_id.
1403
:param revision_id: the new tip to use.
1404
:param last_rev: The previous last_revision. If not None, then this
1405
must be a ancestory of revision_id, or DivergedBranches is raised.
1406
:param other_branch: The other branch that DivergedBranches should
1407
raise with respect to.
1409
revision_id = osutils.safe_revision_id(revision_id)
1410
self.set_revision_history(self._lefthand_history(revision_id,
1411
last_rev, other_branch))
1414
def update_revisions(self, other, stop_revision=None):
1415
"""See Branch.update_revisions."""
1418
if stop_revision is None:
1419
stop_revision = other.last_revision()
1420
if stop_revision is None:
1421
# if there are no commits, we're done.
1424
stop_revision = osutils.safe_revision_id(stop_revision)
1425
# whats the current last revision, before we fetch [and change it
1427
last_rev = self.last_revision()
1428
# we fetch here regardless of whether we need to so that we pickup
1430
self.fetch(other, stop_revision)
1431
my_ancestry = self.repository.get_ancestry(last_rev)
1432
if stop_revision in my_ancestry:
1433
# last_revision is a descendant of stop_revision
1435
self.generate_revision_history(stop_revision, last_rev=last_rev,
1440
def basis_tree(self):
1441
"""See Branch.basis_tree."""
1442
return self.repository.revision_tree(self.last_revision())
1444
@deprecated_method(zero_eight)
1445
def working_tree(self):
1446
"""Create a Working tree object for this branch."""
1448
from bzrlib.transport.local import LocalTransport
1449
if (self.base.find('://') != -1 or
1450
not isinstance(self._transport, LocalTransport)):
1451
raise NoWorkingTree(self.base)
1452
return self.bzrdir.open_workingtree()
1455
def pull(self, source, overwrite=False, stop_revision=None,
1456
_hook_master=None, _run_hooks=True):
1459
:param _hook_master: Private parameter - set the branch to
1460
be supplied as the master to push hooks.
1461
:param _run_hooks: Private parameter - allow disabling of
1462
hooks, used when pushing to a master branch.
1464
result = PullResult()
1465
result.source_branch = source
1466
result.target_branch = self
1469
result.old_revno, result.old_revid = self.last_revision_info()
1471
self.update_revisions(source, stop_revision)
1472
except DivergedBranches:
1476
if stop_revision is None:
1477
stop_revision = source.last_revision()
1478
self.generate_revision_history(stop_revision)
1479
result.tag_conflicts = source.tags.merge_to(self.tags)
1480
result.new_revno, result.new_revid = self.last_revision_info()
1482
result.master_branch = _hook_master
1483
result.local_branch = self
1485
result.master_branch = self
1486
result.local_branch = None
1488
for hook in Branch.hooks['post_pull']:
1494
def _get_parent_location(self):
1495
_locs = ['parent', 'pull', 'x-pull']
1498
return self.control_files.get(l).read().strip('\n')
1504
def push(self, target, overwrite=False, stop_revision=None,
1505
_hook_master=None, _run_hooks=True):
1508
:param _hook_master: Private parameter - set the branch to
1509
be supplied as the master to push hooks.
1510
:param _run_hooks: Private parameter - allow disabling of
1511
hooks, used when pushing to a master branch.
1513
result = PushResult()
1514
result.source_branch = self
1515
result.target_branch = target
1518
result.old_revno, result.old_revid = target.last_revision_info()
1520
target.update_revisions(self, stop_revision)
1521
except DivergedBranches:
1525
target.set_revision_history(self.revision_history())
1526
result.tag_conflicts = self.tags.merge_to(target.tags)
1527
result.new_revno, result.new_revid = target.last_revision_info()
1529
result.master_branch = _hook_master
1530
result.local_branch = target
1532
result.master_branch = target
1533
result.local_branch = None
1535
for hook in Branch.hooks['post_push']:
1541
def get_parent(self):
1542
"""See Branch.get_parent."""
1544
assert self.base[-1] == '/'
1545
parent = self._get_parent_location()
1548
# This is an old-format absolute path to a local branch
1549
# turn it into a url
1550
if parent.startswith('/'):
1551
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1553
return urlutils.join(self.base[:-1], parent)
1554
except errors.InvalidURLJoin, e:
1555
raise errors.InaccessibleParent(parent, self.base)
1557
def get_push_location(self):
1558
"""See Branch.get_push_location."""
1559
push_loc = self.get_config().get_user_option('push_location')
1562
def set_push_location(self, location):
1563
"""See Branch.set_push_location."""
1564
self.get_config().set_user_option(
1565
'push_location', location,
1566
store=_mod_config.STORE_LOCATION_NORECURSE)
1569
def set_parent(self, url):
1570
"""See Branch.set_parent."""
1571
# TODO: Maybe delete old location files?
1572
# URLs should never be unicode, even on the local fs,
1573
# FIXUP this and get_parent in a future branch format bump:
1574
# read and rewrite the file, and have the new format code read
1575
# using .get not .get_utf8. RBC 20060125
1577
if isinstance(url, unicode):
1579
url = url.encode('ascii')
1580
except UnicodeEncodeError:
1581
raise bzrlib.errors.InvalidURL(url,
1582
"Urls must be 7-bit ascii, "
1583
"use bzrlib.urlutils.escape")
1584
url = urlutils.relative_url(self.base, url)
1585
self._set_parent_location(url)
1587
def _set_parent_location(self, url):
1589
self.control_files._transport.delete('parent')
1591
assert isinstance(url, str)
1592
self.control_files.put_bytes('parent', url + '\n')
1594
@deprecated_function(zero_nine)
1595
def tree_config(self):
1596
"""DEPRECATED; call get_config instead.
1597
TreeConfig has become part of BranchConfig."""
1598
return TreeConfig(self)
1601
class BzrBranch5(BzrBranch):
1602
"""A format 5 branch. This supports new features over plan branches.
1604
It has support for a master_branch which is the data for bound branches.
1612
super(BzrBranch5, self).__init__(_format=_format,
1613
_control_files=_control_files,
1615
_repository=_repository)
1618
def pull(self, source, overwrite=False, stop_revision=None,
1620
"""Extends branch.pull to be bound branch aware.
1622
:param _run_hooks: Private parameter used to force hook running
1623
off during bound branch double-pushing.
1625
bound_location = self.get_bound_location()
1626
master_branch = None
1627
if bound_location and source.base != bound_location:
1628
# not pulling from master, so we need to update master.
1629
master_branch = self.get_master_branch()
1630
master_branch.lock_write()
1633
# pull from source into master.
1634
master_branch.pull(source, overwrite, stop_revision,
1636
return super(BzrBranch5, self).pull(source, overwrite,
1637
stop_revision, _hook_master=master_branch,
1638
_run_hooks=_run_hooks)
1641
master_branch.unlock()
1644
def push(self, target, overwrite=False, stop_revision=None):
1645
"""Updates branch.push to be bound branch aware."""
1646
bound_location = target.get_bound_location()
1647
master_branch = None
1648
if bound_location and target.base != bound_location:
1649
# not pushing to master, so we need to update master.
1650
master_branch = target.get_master_branch()
1651
master_branch.lock_write()
1654
# push into the master from this branch.
1655
super(BzrBranch5, self).push(master_branch, overwrite,
1656
stop_revision, _run_hooks=False)
1657
# and push into the target branch from this. Note that we push from
1658
# this branch again, because its considered the highest bandwidth
1660
return super(BzrBranch5, self).push(target, overwrite,
1661
stop_revision, _hook_master=master_branch)
1664
master_branch.unlock()
1666
def get_bound_location(self):
1668
return self.control_files.get_utf8('bound').read()[:-1]
1669
except errors.NoSuchFile:
1673
def get_master_branch(self):
1674
"""Return the branch we are bound to.
1676
:return: Either a Branch, or None
1678
This could memoise the branch, but if thats done
1679
it must be revalidated on each new lock.
1680
So for now we just don't memoise it.
1681
# RBC 20060304 review this decision.
1683
bound_loc = self.get_bound_location()
1687
return Branch.open(bound_loc)
1688
except (errors.NotBranchError, errors.ConnectionError), e:
1689
raise errors.BoundBranchConnectionFailure(
1693
def set_bound_location(self, location):
1694
"""Set the target where this branch is bound to.
1696
:param location: URL to the target branch
1699
self.control_files.put_utf8('bound', location+'\n')
1702
self.control_files._transport.delete('bound')
1708
def bind(self, other):
1709
"""Bind this branch to the branch other.
1711
This does not push or pull data between the branches, though it does
1712
check for divergence to raise an error when the branches are not
1713
either the same, or one a prefix of the other. That behaviour may not
1714
be useful, so that check may be removed in future.
1716
:param other: The branch to bind to
1719
# TODO: jam 20051230 Consider checking if the target is bound
1720
# It is debatable whether you should be able to bind to
1721
# a branch which is itself bound.
1722
# Committing is obviously forbidden,
1723
# but binding itself may not be.
1724
# Since we *have* to check at commit time, we don't
1725
# *need* to check here
1727
# we want to raise diverged if:
1728
# last_rev is not in the other_last_rev history, AND
1729
# other_last_rev is not in our history, and do it without pulling
1731
last_rev = self.last_revision()
1732
if last_rev is not None:
1735
other_last_rev = other.last_revision()
1736
if other_last_rev is not None:
1737
# neither branch is new, we have to do some work to
1738
# ascertain diversion.
1739
remote_graph = other.repository.get_revision_graph(
1741
local_graph = self.repository.get_revision_graph(last_rev)
1742
if (last_rev not in remote_graph and
1743
other_last_rev not in local_graph):
1744
raise errors.DivergedBranches(self, other)
1747
self.set_bound_location(other.base)
1751
"""If bound, unbind"""
1752
return self.set_bound_location(None)
1756
"""Synchronise this branch with the master branch if any.
1758
:return: None or the last_revision that was pivoted out during the
1761
master = self.get_master_branch()
1762
if master is not None:
1763
old_tip = self.last_revision()
1764
self.pull(master, overwrite=True)
1765
if old_tip in self.repository.get_ancestry(self.last_revision()):
1771
class BzrBranchExperimental(BzrBranch5):
1772
"""Bzr experimental branch format
1775
- a revision-history file.
1777
- a lock dir guarding the branch itself
1778
- all of this stored in a branch/ subdirectory
1779
- works with shared repositories.
1780
- a tag dictionary in the branch
1782
This format is new in bzr 0.15, but shouldn't be used for real data,
1785
This class acts as it's own BranchFormat.
1788
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1791
def get_format_string(cls):
1792
"""See BranchFormat.get_format_string()."""
1793
return "Bazaar-NG branch format experimental\n"
1796
def get_format_description(cls):
1797
"""See BranchFormat.get_format_description()."""
1798
return "Experimental branch format"
1801
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1803
branch_transport = a_bzrdir.get_branch_transport(cls)
1804
control_files = lockable_files.LockableFiles(branch_transport,
1805
lock_filename, lock_class)
1806
control_files.create_lock()
1807
control_files.lock_write()
1809
for filename, content in utf8_files:
1810
control_files.put_utf8(filename, content)
1812
control_files.unlock()
1815
def initialize(cls, a_bzrdir):
1816
"""Create a branch of this format in a_bzrdir."""
1817
utf8_files = [('format', cls.get_format_string()),
1818
('revision-history', ''),
1819
('branch-name', ''),
1822
cls._initialize_control_files(a_bzrdir, utf8_files,
1823
'lock', lockdir.LockDir)
1824
return cls.open(a_bzrdir, _found=True)
1827
def open(cls, a_bzrdir, _found=False):
1828
"""Return the branch object for a_bzrdir
1830
_found is a private parameter, do not use it. It is used to indicate
1831
if format probing has already be done.
1834
format = BranchFormat.find_format(a_bzrdir)
1835
assert format.__class__ == cls
1836
transport = a_bzrdir.get_branch_transport(None)
1837
control_files = lockable_files.LockableFiles(transport, 'lock',
1839
return cls(_format=cls,
1840
_control_files=control_files,
1842
_repository=a_bzrdir.find_repository())
1845
def is_supported(cls):
1848
def _make_tags(self):
1849
return BasicTags(self)
1852
def supports_tags(cls):
1856
BranchFormat.register_format(BzrBranchExperimental)
1859
class BzrBranch6(BzrBranch5):
1862
def last_revision_info(self):
1863
revision_string = self.control_files.get('last-revision').read()
1864
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1865
revision_id = cache_utf8.get_cached_utf8(revision_id)
1867
return revno, revision_id
1869
def last_revision(self):
1870
"""Return last revision id, or None"""
1871
revision_id = self.last_revision_info()[1]
1872
if revision_id == _mod_revision.NULL_REVISION:
1876
def _write_last_revision_info(self, revno, revision_id):
1877
"""Simply write out the revision id, with no checks.
1879
Use set_last_revision_info to perform this safely.
1881
Does not update the revision_history cache.
1882
Intended to be called by set_last_revision_info and
1883
_write_revision_history.
1885
if revision_id is None:
1886
revision_id = 'null:'
1887
out_string = '%d %s\n' % (revno, revision_id)
1888
self.control_files.put_bytes('last-revision', out_string)
1891
def set_last_revision_info(self, revno, revision_id):
1892
revision_id = osutils.safe_revision_id(revision_id)
1893
if self._get_append_revisions_only():
1894
self._check_history_violation(revision_id)
1895
self._write_last_revision_info(revno, revision_id)
1896
transaction = self.get_transaction()
1897
cached_history = transaction.map.find_revision_history()
1898
if cached_history is not None:
1899
transaction.map.remove_object(cached_history)
1901
def _check_history_violation(self, revision_id):
1902
last_revision = self.last_revision()
1903
if last_revision is None:
1905
if last_revision not in self._lefthand_history(revision_id):
1906
raise errors.AppendRevisionsOnlyViolation(self.base)
1908
def _gen_revision_history(self):
1909
"""Generate the revision history from last revision
1911
history = list(self.repository.iter_reverse_revision_history(
1912
self.last_revision()))
1916
def _write_revision_history(self, history):
1917
"""Factored out of set_revision_history.
1919
This performs the actual writing to disk, with format-specific checks.
1920
It is intended to be called by BzrBranch5.set_revision_history.
1922
if len(history) == 0:
1923
last_revision = 'null:'
1925
if history != self._lefthand_history(history[-1]):
1926
raise errors.NotLefthandHistory(history)
1927
last_revision = history[-1]
1928
if self._get_append_revisions_only():
1929
self._check_history_violation(last_revision)
1930
self._write_last_revision_info(len(history), last_revision)
1933
def append_revision(self, *revision_ids):
1934
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1935
if len(revision_ids) == 0:
1937
prev_revno, prev_revision = self.last_revision_info()
1938
for revision in self.repository.get_revisions(revision_ids):
1939
if prev_revision == _mod_revision.NULL_REVISION:
1940
if revision.parent_ids != []:
1941
raise errors.NotLeftParentDescendant(self, prev_revision,
1942
revision.revision_id)
1944
if revision.parent_ids[0] != prev_revision:
1945
raise errors.NotLeftParentDescendant(self, prev_revision,
1946
revision.revision_id)
1947
prev_revision = revision.revision_id
1948
self.set_last_revision_info(prev_revno + len(revision_ids),
1951
def _set_config_location(self, name, url, config=None,
1952
make_relative=False):
1954
config = self.get_config()
1958
url = urlutils.relative_url(self.base, url)
1959
config.set_user_option(name, url)
1962
def _get_config_location(self, name, config=None):
1964
config = self.get_config()
1965
location = config.get_user_option(name)
1971
def _set_parent_location(self, url):
1972
"""Set the parent branch"""
1973
self._set_config_location('parent_location', url, make_relative=True)
1976
def _get_parent_location(self):
1977
"""Set the parent branch"""
1978
return self._get_config_location('parent_location')
1980
def set_push_location(self, location):
1981
"""See Branch.set_push_location."""
1982
self._set_config_location('push_location', location)
1984
def set_bound_location(self, location):
1985
"""See Branch.set_push_location."""
1987
config = self.get_config()
1988
if location is None:
1989
if config.get_user_option('bound') != 'True':
1992
config.set_user_option('bound', 'False')
1995
self._set_config_location('bound_location', location,
1997
config.set_user_option('bound', 'True')
2000
def _get_bound_location(self, bound):
2001
"""Return the bound location in the config file.
2003
Return None if the bound parameter does not match"""
2004
config = self.get_config()
2005
config_bound = (config.get_user_option('bound') == 'True')
2006
if config_bound != bound:
2008
return self._get_config_location('bound_location', config=config)
2010
def get_bound_location(self):
2011
"""See Branch.set_push_location."""
2012
return self._get_bound_location(True)
2014
def get_old_bound_location(self):
2015
"""See Branch.get_old_bound_location"""
2016
return self._get_bound_location(False)
2018
def set_append_revisions_only(self, enabled):
2023
self.get_config().set_user_option('append_revisions_only', value)
2025
def _get_append_revisions_only(self):
2026
value = self.get_config().get_user_option('append_revisions_only')
2027
return value == 'True'
2029
def _synchronize_history(self, destination, revision_id):
2030
"""Synchronize last revision and revision history between branches.
2032
This version is most efficient when the destination is also a
2033
BzrBranch6, but works for BzrBranch5, as long as the destination's
2034
repository contains all the lefthand ancestors of the intended
2035
last_revision. If not, set_last_revision_info will fail.
2037
:param destination: The branch to copy the history into
2038
:param revision_id: The revision-id to truncate history at. May
2039
be None to copy complete history.
2041
if revision_id is None:
2042
revno, revision_id = self.last_revision_info()
2044
revno = self.revision_id_to_revno(revision_id)
2045
destination.set_last_revision_info(revno, revision_id)
2047
def _make_tags(self):
2048
return BasicTags(self)
2051
class BranchTestProviderAdapter(object):
2052
"""A tool to generate a suite testing multiple branch formats at once.
2054
This is done by copying the test once for each transport and injecting
2055
the transport_server, transport_readonly_server, and branch_format
2056
classes into each copy. Each copy is also given a new id() to make it
2060
def __init__(self, transport_server, transport_readonly_server, formats):
2061
self._transport_server = transport_server
2062
self._transport_readonly_server = transport_readonly_server
2063
self._formats = formats
2065
def adapt(self, test):
2066
result = TestSuite()
2067
for branch_format, bzrdir_format in self._formats:
2068
new_test = deepcopy(test)
2069
new_test.transport_server = self._transport_server
2070
new_test.transport_readonly_server = self._transport_readonly_server
2071
new_test.bzrdir_format = bzrdir_format
2072
new_test.branch_format = branch_format
2073
def make_new_test_id():
2074
# the format can be either a class or an instance
2075
name = getattr(branch_format, '__name__',
2076
branch_format.__class__.__name__)
2077
new_id = "%s(%s)" % (new_test.id(), name)
2078
return lambda: new_id
2079
new_test.id = make_new_test_id()
2080
result.addTest(new_test)
2084
######################################################################
2085
# results of operations
2088
class _Result(object):
2090
def _show_tag_conficts(self, to_file):
2091
if not getattr(self, 'tag_conflicts', None):
2093
to_file.write('Conflicting tags:\n')
2094
for name, value1, value2 in self.tag_conflicts:
2095
to_file.write(' %s\n' % (name, ))
2098
class PullResult(_Result):
2099
"""Result of a Branch.pull operation.
2101
:ivar old_revno: Revision number before pull.
2102
:ivar new_revno: Revision number after pull.
2103
:ivar old_revid: Tip revision id before pull.
2104
:ivar new_revid: Tip revision id after pull.
2105
:ivar source_branch: Source (local) branch object.
2106
:ivar master_branch: Master branch of the target, or None.
2107
:ivar target_branch: Target/destination branch object.
2111
# DEPRECATED: pull used to return the change in revno
2112
return self.new_revno - self.old_revno
2114
def report(self, to_file):
2115
if self.old_revid == self.new_revid:
2116
to_file.write('No revisions to pull.\n')
2118
to_file.write('Now on revision %d.\n' % self.new_revno)
2119
self._show_tag_conficts(to_file)
2122
class PushResult(_Result):
2123
"""Result of a Branch.push operation.
2125
:ivar old_revno: Revision number before push.
2126
:ivar new_revno: Revision number after push.
2127
:ivar old_revid: Tip revision id before push.
2128
:ivar new_revid: Tip revision id after push.
2129
:ivar source_branch: Source branch object.
2130
:ivar master_branch: Master branch of the target, or None.
2131
:ivar target_branch: Target/destination branch object.
2135
# DEPRECATED: push used to return the change in revno
2136
return self.new_revno - self.old_revno
2138
def report(self, to_file):
2139
"""Write a human-readable description of the result."""
2140
if self.old_revid == self.new_revid:
2141
to_file.write('No new revisions to push.\n')
2143
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2144
self._show_tag_conficts(to_file)
2147
class BranchCheckResult(object):
2148
"""Results of checking branch consistency.
2153
def __init__(self, branch):
2154
self.branch = branch
2156
def report_results(self, verbose):
2157
"""Report the check results via trace.note.
2159
:param verbose: Requests more detailed display of what was checked,
2162
note('checked branch %s format %s',
2164
self.branch._format)
2167
class Converter5to6(object):
2168
"""Perform an in-place upgrade of format 5 to format 6"""
2170
def convert(self, branch):
2171
# Data for 5 and 6 can peacefully coexist.
2172
format = BzrBranchFormat6()
2173
new_branch = format.open(branch.bzrdir, _found=True)
2175
# Copy source data into target
2176
new_branch.set_last_revision_info(*branch.last_revision_info())
2177
new_branch.set_parent(branch.get_parent())
2178
new_branch.set_bound_location(branch.get_bound_location())
2179
new_branch.set_push_location(branch.get_push_location())
2181
# New branch has no tags by default
2182
new_branch.tags._set_tag_dict({})
2184
# Copying done; now update target format
2185
new_branch.control_files.put_utf8('format',
2186
format.get_format_string())
2188
# Clean up old files
2189
new_branch.control_files._transport.delete('revision-history')
2191
branch.set_parent(None)
2194
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
