1
# Copyright (C) 2005, 2006, 2007, 2008 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
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
22
from itertools import chain
26
config as _mod_config,
32
revision as _mod_revision,
38
from bzrlib.config import BranchConfig
39
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
40
from bzrlib.tag import (
46
from bzrlib.decorators import needs_read_lock, needs_write_lock
47
from bzrlib.hooks import Hooks
48
from bzrlib.symbol_versioning import (
52
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
55
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
56
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
57
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
60
# TODO: Maybe include checks for common corruption of newlines, etc?
62
# TODO: Some operations like log might retrieve the same revisions
63
# repeatedly to calculate deltas. We could perhaps have a weakref
64
# cache in memory to make this faster. In general anything can be
65
# cached in memory between lock and unlock operations. .. nb thats
66
# what the transaction identity map provides
69
######################################################################
73
"""Branch holding a history of revisions.
76
Base directory/url of the branch.
78
hooks: An instance of BranchHooks.
80
# this is really an instance variable - FIXME move it there
84
# override this to set the strategy for storing tags
86
return DisabledTags(self)
88
def __init__(self, *ignored, **ignored_too):
89
self.tags = self._make_tags()
90
self._revision_history_cache = None
91
self._revision_id_to_revno_cache = None
92
self._last_revision_info_cache = None
94
hooks = Branch.hooks['open']
99
"""Called by init to allow simpler extension of the base class."""
101
def break_lock(self):
102
"""Break a lock if one is present from another instance.
104
Uses the ui factory to ask for confirmation if the lock may be from
107
This will probe the repository for its lock as well.
109
self.control_files.break_lock()
110
self.repository.break_lock()
111
master = self.get_master_branch()
112
if master is not None:
116
def open(base, _unsupported=False, possible_transports=None):
117
"""Open the branch rooted at base.
119
For instance, if the branch is at URL/.bzr/branch,
120
Branch.open(URL) -> a Branch instance.
122
control = bzrdir.BzrDir.open(base, _unsupported,
123
possible_transports=possible_transports)
124
return control.open_branch(_unsupported)
127
def open_from_transport(transport, _unsupported=False):
128
"""Open the branch rooted at transport"""
129
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
130
return control.open_branch(_unsupported)
133
def open_containing(url, possible_transports=None):
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,
146
return control.open_branch(), relpath
148
def get_config(self):
149
return BranchConfig(self)
152
return self.get_config().get_nickname()
154
def _set_nick(self, nick):
155
self.get_config().set_user_option('nickname', nick, warn_masked=True)
157
nick = property(_get_nick, _set_nick)
160
raise NotImplementedError(self.is_locked)
162
def lock_write(self):
163
raise NotImplementedError(self.lock_write)
166
raise NotImplementedError(self.lock_read)
169
raise NotImplementedError(self.unlock)
171
def peek_lock_mode(self):
172
"""Return lock mode for the Branch: 'r', 'w' or None"""
173
raise NotImplementedError(self.peek_lock_mode)
175
def get_physical_lock_status(self):
176
raise NotImplementedError(self.get_physical_lock_status)
179
def get_revision_id_to_revno_map(self):
180
"""Return the revision_id => dotted revno map.
182
This will be regenerated on demand, but will be cached.
184
:return: A dictionary mapping revision_id => dotted revno.
185
This dictionary should not be modified by the caller.
187
if self._revision_id_to_revno_cache is not None:
188
mapping = self._revision_id_to_revno_cache
190
mapping = self._gen_revno_map()
191
self._cache_revision_id_to_revno(mapping)
192
# TODO: jam 20070417 Since this is being cached, should we be returning
194
# I would rather not, and instead just declare that users should not
195
# modify the return value.
198
def _gen_revno_map(self):
199
"""Create a new mapping from revision ids to dotted revnos.
201
Dotted revnos are generated based on the current tip in the revision
203
This is the worker function for get_revision_id_to_revno_map, which
204
just caches the return value.
206
:return: A dictionary mapping revision_id => dotted revno.
208
last_revision = self.last_revision()
209
revision_graph = repository._old_get_graph(self.repository,
211
merge_sorted_revisions = tsort.merge_sort(
216
revision_id_to_revno = dict((rev_id, revno)
217
for seq_num, rev_id, depth, revno, end_of_merge
218
in merge_sorted_revisions)
219
return revision_id_to_revno
221
def leave_lock_in_place(self):
222
"""Tell this branch object not to release the physical lock when this
225
If lock_write doesn't return a token, then this method is not supported.
227
self.control_files.leave_in_place()
229
def dont_leave_lock_in_place(self):
230
"""Tell this branch object to release the physical lock when this
231
object is unlocked, even if it didn't originally acquire it.
233
If lock_write doesn't return a token, then this method is not supported.
235
self.control_files.dont_leave_in_place()
237
def bind(self, other):
238
"""Bind the local branch the other branch.
240
:param other: The branch to bind to
243
raise errors.UpgradeRequired(self.base)
246
def fetch(self, from_branch, last_revision=None, pb=None):
247
"""Copy revisions from from_branch into this branch.
249
:param from_branch: Where to copy from.
250
:param last_revision: What revision to stop at (None for at the end
252
:param pb: An optional progress bar to use.
254
Returns the copied revision count and the failed revisions in a tuple:
257
if self.base == from_branch.base:
260
nested_pb = ui.ui_factory.nested_progress_bar()
265
from_branch.lock_read()
267
if last_revision is None:
268
pb.update('get source history')
269
last_revision = from_branch.last_revision()
270
last_revision = _mod_revision.ensure_null(last_revision)
271
return self.repository.fetch(from_branch.repository,
272
revision_id=last_revision,
275
if nested_pb is not None:
279
def get_bound_location(self):
280
"""Return the URL of the branch we are bound to.
282
Older format branches cannot bind, please be sure to use a metadir
287
def get_old_bound_location(self):
288
"""Return the URL of the branch we used to be bound to
290
raise errors.UpgradeRequired(self.base)
292
def get_commit_builder(self, parents, config=None, timestamp=None,
293
timezone=None, committer=None, revprops=None,
295
"""Obtain a CommitBuilder for this branch.
297
:param parents: Revision ids of the parents of the new revision.
298
:param config: Optional configuration to use.
299
:param timestamp: Optional timestamp recorded for commit.
300
:param timezone: Optional timezone for timestamp.
301
:param committer: Optional committer to set for commit.
302
:param revprops: Optional dictionary of revision properties.
303
:param revision_id: Optional revision id.
307
config = self.get_config()
309
return self.repository.get_commit_builder(self, parents, config,
310
timestamp, timezone, committer, revprops, revision_id)
312
def get_master_branch(self, possible_transports=None):
313
"""Return the branch we are bound to.
315
:return: Either a Branch, or None
319
def get_revision_delta(self, revno):
320
"""Return the delta for one revision.
322
The delta is relative to its mainline predecessor, or the
323
empty tree for revision 1.
325
rh = self.revision_history()
326
if not (1 <= revno <= len(rh)):
327
raise errors.InvalidRevisionNumber(revno)
328
return self.repository.get_revision_delta(rh[revno-1])
330
def get_stacked_on_url(self):
331
"""Get the URL this branch is stacked against.
333
:raises NotStacked: If the branch is not stacked.
334
:raises UnstackableBranchFormat: If the branch does not support
337
raise NotImplementedError(self.get_stacked_on_url)
339
def print_file(self, file, revision_id):
340
"""Print `file` to stdout."""
341
raise NotImplementedError(self.print_file)
343
def set_revision_history(self, rev_history):
344
raise NotImplementedError(self.set_revision_history)
346
def set_stacked_on_url(self, url):
347
"""Set the URL this branch is stacked against.
349
:raises UnstackableBranchFormat: If the branch does not support
351
:raises UnstackableRepositoryFormat: If the repository does not support
354
raise NotImplementedError(self.set_stacked_on_url)
356
def _cache_revision_history(self, rev_history):
357
"""Set the cached revision history to rev_history.
359
The revision_history method will use this cache to avoid regenerating
360
the revision history.
362
This API is semi-public; it only for use by subclasses, all other code
363
should consider it to be private.
365
self._revision_history_cache = rev_history
367
def _cache_revision_id_to_revno(self, revision_id_to_revno):
368
"""Set the cached revision_id => revno map to revision_id_to_revno.
370
This API is semi-public; it only for use by subclasses, all other code
371
should consider it to be private.
373
self._revision_id_to_revno_cache = revision_id_to_revno
375
def _clear_cached_state(self):
376
"""Clear any cached data on this branch, e.g. cached revision history.
378
This means the next call to revision_history will need to call
379
_gen_revision_history.
381
This API is semi-public; it only for use by subclasses, all other code
382
should consider it to be private.
384
self._revision_history_cache = None
385
self._revision_id_to_revno_cache = None
386
self._last_revision_info_cache = None
388
def _gen_revision_history(self):
389
"""Return sequence of revision hashes on to this branch.
391
Unlike revision_history, this method always regenerates or rereads the
392
revision history, i.e. it does not cache the result, so repeated calls
395
Concrete subclasses should override this instead of revision_history so
396
that subclasses do not need to deal with caching logic.
398
This API is semi-public; it only for use by subclasses, all other code
399
should consider it to be private.
401
raise NotImplementedError(self._gen_revision_history)
404
def revision_history(self):
405
"""Return sequence of revision ids on this branch.
407
This method will cache the revision history for as long as it is safe to
410
if 'evil' in debug.debug_flags:
411
mutter_callsite(3, "revision_history scales with history.")
412
if self._revision_history_cache is not None:
413
history = self._revision_history_cache
415
history = self._gen_revision_history()
416
self._cache_revision_history(history)
420
"""Return current revision number for this branch.
422
That is equivalent to the number of revisions committed to
425
return self.last_revision_info()[0]
428
"""Older format branches cannot bind or unbind."""
429
raise errors.UpgradeRequired(self.base)
431
def set_append_revisions_only(self, enabled):
432
"""Older format branches are never restricted to append-only"""
433
raise errors.UpgradeRequired(self.base)
435
def last_revision(self):
436
"""Return last revision id, or NULL_REVISION."""
437
return self.last_revision_info()[1]
440
def last_revision_info(self):
441
"""Return information about the last revision.
443
:return: A tuple (revno, revision_id).
445
if self._last_revision_info_cache is None:
446
self._last_revision_info_cache = self._last_revision_info()
447
return self._last_revision_info_cache
449
def _last_revision_info(self):
450
rh = self.revision_history()
453
return (revno, rh[-1])
455
return (0, _mod_revision.NULL_REVISION)
457
@deprecated_method(deprecated_in((1, 6, 0)))
458
def missing_revisions(self, other, stop_revision=None):
459
"""Return a list of new revisions that would perfectly fit.
461
If self and other have not diverged, return a list of the revisions
462
present in other, but missing from self.
464
self_history = self.revision_history()
465
self_len = len(self_history)
466
other_history = other.revision_history()
467
other_len = len(other_history)
468
common_index = min(self_len, other_len) -1
469
if common_index >= 0 and \
470
self_history[common_index] != other_history[common_index]:
471
raise errors.DivergedBranches(self, other)
473
if stop_revision is None:
474
stop_revision = other_len
476
if stop_revision > other_len:
477
raise errors.NoSuchRevision(self, stop_revision)
478
return other_history[self_len:stop_revision]
481
def update_revisions(self, other, stop_revision=None, overwrite=False,
483
"""Pull in new perfect-fit revisions.
485
:param other: Another Branch to pull from
486
:param stop_revision: Updated until the given revision
487
:param overwrite: Always set the branch pointer, rather than checking
488
to see if it is a proper descendant.
489
:param graph: A Graph object that can be used to query history
490
information. This can be None.
495
other_revno, other_last_revision = other.last_revision_info()
496
stop_revno = None # unknown
497
if stop_revision is None:
498
stop_revision = other_last_revision
499
if _mod_revision.is_null(stop_revision):
500
# if there are no commits, we're done.
502
stop_revno = other_revno
504
# what's the current last revision, before we fetch [and change it
506
last_rev = _mod_revision.ensure_null(self.last_revision())
507
# we fetch here so that we don't process data twice in the common
508
# case of having something to pull, and so that the check for
509
# already merged can operate on the just fetched graph, which will
510
# be cached in memory.
511
self.fetch(other, stop_revision)
512
# Check to see if one is an ancestor of the other
515
graph = self.repository.get_graph()
516
if self._check_if_descendant_or_diverged(
517
stop_revision, last_rev, graph, other):
518
# stop_revision is a descendant of last_rev, but we aren't
519
# overwriting, so we're done.
521
if stop_revno is None:
523
graph = self.repository.get_graph()
524
this_revno, this_last_revision = self.last_revision_info()
525
stop_revno = graph.find_distance_to_null(stop_revision,
526
[(other_last_revision, other_revno),
527
(this_last_revision, this_revno)])
528
self.set_last_revision_info(stop_revno, stop_revision)
532
def revision_id_to_revno(self, revision_id):
533
"""Given a revision id, return its revno"""
534
if _mod_revision.is_null(revision_id):
536
history = self.revision_history()
538
return history.index(revision_id) + 1
540
raise errors.NoSuchRevision(self, revision_id)
542
def get_rev_id(self, revno, history=None):
543
"""Find the revision id of the specified revno."""
545
return _mod_revision.NULL_REVISION
547
history = self.revision_history()
548
if revno <= 0 or revno > len(history):
549
raise errors.NoSuchRevision(self, revno)
550
return history[revno - 1]
552
def pull(self, source, overwrite=False, stop_revision=None,
553
possible_transports=None, _override_hook_target=None):
554
"""Mirror source into this branch.
556
This branch is considered to be 'local', having low latency.
558
:returns: PullResult instance
560
raise NotImplementedError(self.pull)
562
def push(self, target, overwrite=False, stop_revision=None):
563
"""Mirror this branch into target.
565
This branch is considered to be 'local', having low latency.
567
raise NotImplementedError(self.push)
569
def basis_tree(self):
570
"""Return `Tree` object for last revision."""
571
return self.repository.revision_tree(self.last_revision())
573
def get_parent(self):
574
"""Return the parent location of the branch.
576
This is the default location for push/pull/missing. The usual
577
pattern is that the user can override it by specifying a
580
raise NotImplementedError(self.get_parent)
582
def _set_config_location(self, name, url, config=None,
583
make_relative=False):
585
config = self.get_config()
589
url = urlutils.relative_url(self.base, url)
590
config.set_user_option(name, url, warn_masked=True)
592
def _get_config_location(self, name, config=None):
594
config = self.get_config()
595
location = config.get_user_option(name)
600
def get_submit_branch(self):
601
"""Return the submit location of the branch.
603
This is the default location for bundle. The usual
604
pattern is that the user can override it by specifying a
607
return self.get_config().get_user_option('submit_branch')
609
def set_submit_branch(self, location):
610
"""Return the submit location of the branch.
612
This is the default location for bundle. The usual
613
pattern is that the user can override it by specifying a
616
self.get_config().set_user_option('submit_branch', location,
619
def get_public_branch(self):
620
"""Return the public location of the branch.
622
This is is used by merge directives.
624
return self._get_config_location('public_branch')
626
def set_public_branch(self, location):
627
"""Return the submit location of the branch.
629
This is the default location for bundle. The usual
630
pattern is that the user can override it by specifying a
633
self._set_config_location('public_branch', location)
635
def get_push_location(self):
636
"""Return the None or the location to push this branch to."""
637
push_loc = self.get_config().get_user_option('push_location')
640
def set_push_location(self, location):
641
"""Set a new push location for this branch."""
642
raise NotImplementedError(self.set_push_location)
644
def set_parent(self, url):
645
raise NotImplementedError(self.set_parent)
649
"""Synchronise this branch with the master branch if any.
651
:return: None or the last_revision pivoted out during the update.
655
def check_revno(self, revno):
657
Check whether a revno corresponds to any revision.
658
Zero (the NULL revision) is considered valid.
661
self.check_real_revno(revno)
663
def check_real_revno(self, revno):
665
Check whether a revno corresponds to a real revision.
666
Zero (the NULL revision) is considered invalid
668
if revno < 1 or revno > self.revno():
669
raise errors.InvalidRevisionNumber(revno)
672
def clone(self, to_bzrdir, revision_id=None):
673
"""Clone this branch into to_bzrdir preserving all semantic values.
675
revision_id: if not None, the revision history in the new branch will
676
be truncated to end with revision_id.
678
result = to_bzrdir.create_branch()
679
self.copy_content_into(result, revision_id=revision_id)
683
def sprout(self, to_bzrdir, revision_id=None):
684
"""Create a new line of development from the branch, into to_bzrdir.
686
to_bzrdir controls the branch format.
688
revision_id: if not None, the revision history in the new branch will
689
be truncated to end with revision_id.
691
result = to_bzrdir.create_branch()
692
self.copy_content_into(result, revision_id=revision_id)
693
result.set_parent(self.bzrdir.root_transport.base)
696
def _synchronize_history(self, destination, revision_id):
697
"""Synchronize last revision and revision history between branches.
699
This version is most efficient when the destination is also a
700
BzrBranch5, but works for BzrBranch6 as long as the revision
701
history is the true lefthand parent history, and all of the revisions
702
are in the destination's repository. If not, set_revision_history
705
:param destination: The branch to copy the history into
706
:param revision_id: The revision-id to truncate history at. May
707
be None to copy complete history.
709
if revision_id == _mod_revision.NULL_REVISION:
712
new_history = self.revision_history()
713
if revision_id is not None and new_history != []:
715
new_history = new_history[:new_history.index(revision_id) + 1]
717
rev = self.repository.get_revision(revision_id)
718
new_history = rev.get_history(self.repository)[1:]
719
destination.set_revision_history(new_history)
722
def copy_content_into(self, destination, revision_id=None):
723
"""Copy the content of self into destination.
725
revision_id: if not None, the revision history in the new branch will
726
be truncated to end with revision_id.
728
self._synchronize_history(destination, revision_id)
730
parent = self.get_parent()
731
except errors.InaccessibleParent, e:
732
mutter('parent was not accessible to copy: %s', e)
735
destination.set_parent(parent)
736
self.tags.merge_to(destination.tags)
740
"""Check consistency of the branch.
742
In particular this checks that revisions given in the revision-history
743
do actually match up in the revision graph, and that they're all
744
present in the repository.
746
Callers will typically also want to check the repository.
748
:return: A BranchCheckResult.
750
mainline_parent_id = None
751
last_revno, last_revision_id = self.last_revision_info()
752
real_rev_history = list(self.repository.iter_reverse_revision_history(
754
real_rev_history.reverse()
755
if len(real_rev_history) != last_revno:
756
raise errors.BzrCheckError('revno does not match len(mainline)'
757
' %s != %s' % (last_revno, len(real_rev_history)))
758
# TODO: We should probably also check that real_rev_history actually
759
# matches self.revision_history()
760
for revision_id in real_rev_history:
762
revision = self.repository.get_revision(revision_id)
763
except errors.NoSuchRevision, e:
764
raise errors.BzrCheckError("mainline revision {%s} not in repository"
766
# In general the first entry on the revision history has no parents.
767
# But it's not illegal for it to have parents listed; this can happen
768
# in imports from Arch when the parents weren't reachable.
769
if mainline_parent_id is not None:
770
if mainline_parent_id not in revision.parent_ids:
771
raise errors.BzrCheckError("previous revision {%s} not listed among "
773
% (mainline_parent_id, revision_id))
774
mainline_parent_id = revision_id
775
return BranchCheckResult(self)
777
def _get_checkout_format(self):
778
"""Return the most suitable metadir for a checkout of this branch.
779
Weaves are used if this branch's repository uses weaves.
781
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
782
from bzrlib.repofmt import weaverepo
783
format = bzrdir.BzrDirMetaFormat1()
784
format.repository_format = weaverepo.RepositoryFormat7()
786
format = self.repository.bzrdir.checkout_metadir()
787
format.set_branch_format(self._format)
790
def create_checkout(self, to_location, revision_id=None,
791
lightweight=False, accelerator_tree=None,
793
"""Create a checkout of a branch.
795
:param to_location: The url to produce the checkout at
796
:param revision_id: The revision to check out
797
:param lightweight: If True, produce a lightweight checkout, otherwise,
798
produce a bound branch (heavyweight checkout)
799
:param accelerator_tree: A tree which can be used for retrieving file
800
contents more quickly than the revision tree, i.e. a workingtree.
801
The revision tree will be used for cases where accelerator_tree's
802
content is different.
803
:param hardlink: If true, hard-link files from accelerator_tree,
805
:return: The tree of the created checkout
807
t = transport.get_transport(to_location)
810
format = self._get_checkout_format()
811
checkout = format.initialize_on_transport(t)
812
from_branch = BranchReferenceFormat().initialize(checkout, self)
814
format = self._get_checkout_format()
815
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
816
to_location, force_new_tree=False, format=format)
817
checkout = checkout_branch.bzrdir
818
checkout_branch.bind(self)
819
# pull up to the specified revision_id to set the initial
820
# branch tip correctly, and seed it with history.
821
checkout_branch.pull(self, stop_revision=revision_id)
823
tree = checkout.create_workingtree(revision_id,
824
from_branch=from_branch,
825
accelerator_tree=accelerator_tree,
827
basis_tree = tree.basis_tree()
828
basis_tree.lock_read()
830
for path, file_id in basis_tree.iter_references():
831
reference_parent = self.reference_parent(file_id, path)
832
reference_parent.create_checkout(tree.abspath(path),
833
basis_tree.get_reference_revision(file_id, path),
840
def reconcile(self, thorough=True):
841
"""Make sure the data stored in this branch is consistent."""
842
from bzrlib.reconcile import BranchReconciler
843
reconciler = BranchReconciler(self, thorough=thorough)
844
reconciler.reconcile()
847
def reference_parent(self, file_id, path):
848
"""Return the parent branch for a tree-reference file_id
849
:param file_id: The file_id of the tree reference
850
:param path: The path of the file_id in the tree
851
:return: A branch associated with the file_id
853
# FIXME should provide multiple branches, based on config
854
return Branch.open(self.bzrdir.root_transport.clone(path).base)
856
def supports_tags(self):
857
return self._format.supports_tags()
859
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
861
"""Ensure that revision_b is a descendant of revision_a.
863
This is a helper function for update_revisions.
865
:raises: DivergedBranches if revision_b has diverged from revision_a.
866
:returns: True if revision_b is a descendant of revision_a.
868
relation = self._revision_relations(revision_a, revision_b, graph)
869
if relation == 'b_descends_from_a':
871
elif relation == 'diverged':
872
raise errors.DivergedBranches(self, other_branch)
873
elif relation == 'a_descends_from_b':
876
raise AssertionError("invalid relation: %r" % (relation,))
878
def _revision_relations(self, revision_a, revision_b, graph):
879
"""Determine the relationship between two revisions.
881
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
883
heads = graph.heads([revision_a, revision_b])
884
if heads == set([revision_b]):
885
return 'b_descends_from_a'
886
elif heads == set([revision_a, revision_b]):
887
# These branches have diverged
889
elif heads == set([revision_a]):
890
return 'a_descends_from_b'
892
raise AssertionError("invalid heads: %r" % (heads,))
895
class BranchFormat(object):
896
"""An encapsulation of the initialization and open routines for a format.
898
Formats provide three things:
899
* An initialization routine,
903
Formats are placed in an dict by their format string for reference
904
during branch opening. Its not required that these be instances, they
905
can be classes themselves with class methods - it simply depends on
906
whether state is needed for a given format or not.
908
Once a format is deprecated, just deprecate the initialize and open
909
methods on the format class. Do not deprecate the object, as the
910
object will be created every time regardless.
913
_default_format = None
914
"""The default format used for new branches."""
917
"""The known formats."""
919
def __eq__(self, other):
920
return self.__class__ is other.__class__
922
def __ne__(self, other):
923
return not (self == other)
926
def find_format(klass, a_bzrdir):
927
"""Return the format for the branch object in a_bzrdir."""
929
transport = a_bzrdir.get_branch_transport(None)
930
format_string = transport.get("format").read()
931
return klass._formats[format_string]
932
except errors.NoSuchFile:
933
raise errors.NotBranchError(path=transport.base)
935
raise errors.UnknownFormatError(format=format_string, kind='branch')
938
def get_default_format(klass):
939
"""Return the current default format."""
940
return klass._default_format
942
def get_reference(self, a_bzrdir):
943
"""Get the target reference of the branch in a_bzrdir.
945
format probing must have been completed before calling
946
this method - it is assumed that the format of the branch
947
in a_bzrdir is correct.
949
:param a_bzrdir: The bzrdir to get the branch data from.
950
:return: None if the branch is not a reference branch.
955
def set_reference(self, a_bzrdir, to_branch):
956
"""Set the target reference of the branch in a_bzrdir.
958
format probing must have been completed before calling
959
this method - it is assumed that the format of the branch
960
in a_bzrdir is correct.
962
:param a_bzrdir: The bzrdir to set the branch reference for.
963
:param to_branch: branch that the checkout is to reference
965
raise NotImplementedError(self.set_reference)
967
def get_format_string(self):
968
"""Return the ASCII format string that identifies this format."""
969
raise NotImplementedError(self.get_format_string)
971
def get_format_description(self):
972
"""Return the short format description for this format."""
973
raise NotImplementedError(self.get_format_description)
975
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
977
"""Initialize a branch in a bzrdir, with specified files
979
:param a_bzrdir: The bzrdir to initialize the branch in
980
:param utf8_files: The files to create as a list of
981
(filename, content) tuples
982
:param set_format: If True, set the format with
983
self.get_format_string. (BzrBranch4 has its format set
985
:return: a branch in this format
987
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
988
branch_transport = a_bzrdir.get_branch_transport(self)
990
'metadir': ('lock', lockdir.LockDir),
991
'branch4': ('branch-lock', lockable_files.TransportLock),
993
lock_name, lock_class = lock_map[lock_type]
994
control_files = lockable_files.LockableFiles(branch_transport,
995
lock_name, lock_class)
996
control_files.create_lock()
997
control_files.lock_write()
999
utf8_files += [('format', self.get_format_string())]
1001
for (filename, content) in utf8_files:
1002
branch_transport.put_bytes(
1004
mode=a_bzrdir._get_file_mode())
1006
control_files.unlock()
1007
return self.open(a_bzrdir, _found=True)
1009
def initialize(self, a_bzrdir):
1010
"""Create a branch of this format in a_bzrdir."""
1011
raise NotImplementedError(self.initialize)
1013
def is_supported(self):
1014
"""Is this format supported?
1016
Supported formats can be initialized and opened.
1017
Unsupported formats may not support initialization or committing or
1018
some other features depending on the reason for not being supported.
1022
def open(self, a_bzrdir, _found=False):
1023
"""Return the branch object for a_bzrdir
1025
_found is a private parameter, do not use it. It is used to indicate
1026
if format probing has already be done.
1028
raise NotImplementedError(self.open)
1031
def register_format(klass, format):
1032
klass._formats[format.get_format_string()] = format
1035
def set_default_format(klass, format):
1036
klass._default_format = format
1038
def supports_stacking(self):
1039
"""True if this format records a stacked-on branch."""
1043
def unregister_format(klass, format):
1044
del klass._formats[format.get_format_string()]
1047
return self.get_format_string().rstrip()
1049
def supports_tags(self):
1050
"""True if this format supports tags stored in the branch"""
1051
return False # by default
1054
class BranchHooks(Hooks):
1055
"""A dictionary mapping hook name to a list of callables for branch hooks.
1057
e.g. ['set_rh'] Is the list of items to be called when the
1058
set_revision_history function is invoked.
1062
"""Create the default hooks.
1064
These are all empty initially, because by default nothing should get
1067
Hooks.__init__(self)
1068
# Introduced in 0.15:
1069
# invoked whenever the revision history has been set
1070
# with set_revision_history. The api signature is
1071
# (branch, revision_history), and the branch will
1074
# Invoked after a branch is opened. The api signature is (branch).
1076
# invoked after a push operation completes.
1077
# the api signature is
1079
# containing the members
1080
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1081
# where local is the local target branch or None, master is the target
1082
# master branch, and the rest should be self explanatory. The source
1083
# is read locked and the target branches write locked. Source will
1084
# be the local low-latency branch.
1085
self['post_push'] = []
1086
# invoked after a pull operation completes.
1087
# the api signature is
1089
# containing the members
1090
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1091
# where local is the local branch or None, master is the target
1092
# master branch, and the rest should be self explanatory. The source
1093
# is read locked and the target branches write locked. The local
1094
# branch is the low-latency branch.
1095
self['post_pull'] = []
1096
# invoked before a commit operation takes place.
1097
# the api signature is
1098
# (local, master, old_revno, old_revid, future_revno, future_revid,
1099
# tree_delta, future_tree).
1100
# old_revid is NULL_REVISION for the first commit to a branch
1101
# tree_delta is a TreeDelta object describing changes from the basis
1102
# revision, hooks MUST NOT modify this delta
1103
# future_tree is an in-memory tree obtained from
1104
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1105
self['pre_commit'] = []
1106
# invoked after a commit operation completes.
1107
# the api signature is
1108
# (local, master, old_revno, old_revid, new_revno, new_revid)
1109
# old_revid is NULL_REVISION for the first commit to a branch.
1110
self['post_commit'] = []
1111
# invoked after a uncommit operation completes.
1112
# the api signature is
1113
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1114
# local is the local branch or None, master is the target branch,
1115
# and an empty branch recieves new_revno of 0, new_revid of None.
1116
self['post_uncommit'] = []
1118
# Invoked before the tip of a branch changes.
1119
# the api signature is
1120
# (params) where params is a ChangeBranchTipParams with the members
1121
# (branch, old_revno, new_revno, old_revid, new_revid)
1122
self['pre_change_branch_tip'] = []
1124
# Invoked after the tip of a branch changes.
1125
# the api signature is
1126
# (params) where params is a ChangeBranchTipParams with the members
1127
# (branch, old_revno, new_revno, old_revid, new_revid)
1128
self['post_change_branch_tip'] = []
1131
# install the default hooks into the Branch class.
1132
Branch.hooks = BranchHooks()
1135
class ChangeBranchTipParams(object):
1136
"""Object holding parameters passed to *_change_branch_tip hooks.
1138
There are 5 fields that hooks may wish to access:
1140
:ivar branch: the branch being changed
1141
:ivar old_revno: revision number before the change
1142
:ivar new_revno: revision number after the change
1143
:ivar old_revid: revision id before the change
1144
:ivar new_revid: revision id after the change
1146
The revid fields are strings. The revno fields are integers.
1149
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1150
"""Create a group of ChangeBranchTip parameters.
1152
:param branch: The branch being changed.
1153
:param old_revno: Revision number before the change.
1154
:param new_revno: Revision number after the change.
1155
:param old_revid: Tip revision id before the change.
1156
:param new_revid: Tip revision id after the change.
1158
self.branch = branch
1159
self.old_revno = old_revno
1160
self.new_revno = new_revno
1161
self.old_revid = old_revid
1162
self.new_revid = new_revid
1164
def __eq__(self, other):
1165
return self.__dict__ == other.__dict__
1168
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1169
self.__class__.__name__, self.branch,
1170
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1173
class BzrBranchFormat4(BranchFormat):
1174
"""Bzr branch format 4.
1177
- a revision-history file.
1178
- a branch-lock lock file [ to be shared with the bzrdir ]
1181
def get_format_description(self):
1182
"""See BranchFormat.get_format_description()."""
1183
return "Branch format 4"
1185
def initialize(self, a_bzrdir):
1186
"""Create a branch of this format in a_bzrdir."""
1187
utf8_files = [('revision-history', ''),
1188
('branch-name', ''),
1190
return self._initialize_helper(a_bzrdir, utf8_files,
1191
lock_type='branch4', set_format=False)
1194
super(BzrBranchFormat4, self).__init__()
1195
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1197
def open(self, a_bzrdir, _found=False):
1198
"""Return the branch object for a_bzrdir
1200
_found is a private parameter, do not use it. It is used to indicate
1201
if format probing has already be done.
1204
# we are being called directly and must probe.
1205
raise NotImplementedError
1206
return BzrBranch(_format=self,
1207
_control_files=a_bzrdir._control_files,
1209
_repository=a_bzrdir.open_repository())
1212
return "Bazaar-NG branch format 4"
1215
class BranchFormatMetadir(BranchFormat):
1216
"""Common logic for meta-dir based branch formats."""
1218
def _branch_class(self):
1219
"""What class to instantiate on open calls."""
1220
raise NotImplementedError(self._branch_class)
1222
def open(self, a_bzrdir, _found=False):
1223
"""Return the branch object for a_bzrdir.
1225
_found is a private parameter, do not use it. It is used to indicate
1226
if format probing has already be done.
1229
format = BranchFormat.find_format(a_bzrdir)
1230
if format.__class__ != self.__class__:
1231
raise AssertionError("wrong format %r found for %r" %
1234
transport = a_bzrdir.get_branch_transport(None)
1235
control_files = lockable_files.LockableFiles(transport, 'lock',
1237
return self._branch_class()(_format=self,
1238
_control_files=control_files,
1240
_repository=a_bzrdir.find_repository())
1241
except errors.NoSuchFile:
1242
raise errors.NotBranchError(path=transport.base)
1245
super(BranchFormatMetadir, self).__init__()
1246
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1248
def supports_tags(self):
1252
class BzrBranchFormat5(BranchFormatMetadir):
1253
"""Bzr branch format 5.
1256
- a revision-history file.
1258
- a lock dir guarding the branch itself
1259
- all of this stored in a branch/ subdirectory
1260
- works with shared repositories.
1262
This format is new in bzr 0.8.
1265
def _branch_class(self):
1268
def get_format_string(self):
1269
"""See BranchFormat.get_format_string()."""
1270
return "Bazaar-NG branch format 5\n"
1272
def get_format_description(self):
1273
"""See BranchFormat.get_format_description()."""
1274
return "Branch format 5"
1276
def initialize(self, a_bzrdir):
1277
"""Create a branch of this format in a_bzrdir."""
1278
utf8_files = [('revision-history', ''),
1279
('branch-name', ''),
1281
return self._initialize_helper(a_bzrdir, utf8_files)
1283
def supports_tags(self):
1287
class BzrBranchFormat6(BranchFormatMetadir):
1288
"""Branch format with last-revision and tags.
1290
Unlike previous formats, this has no explicit revision history. Instead,
1291
this just stores the last-revision, and the left-hand history leading
1292
up to there is the history.
1294
This format was introduced in bzr 0.15
1295
and became the default in 0.91.
1298
def _branch_class(self):
1301
def get_format_string(self):
1302
"""See BranchFormat.get_format_string()."""
1303
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1305
def get_format_description(self):
1306
"""See BranchFormat.get_format_description()."""
1307
return "Branch format 6"
1309
def initialize(self, a_bzrdir):
1310
"""Create a branch of this format in a_bzrdir."""
1311
utf8_files = [('last-revision', '0 null:\n'),
1312
('branch.conf', ''),
1315
return self._initialize_helper(a_bzrdir, utf8_files)
1318
class BzrBranchFormat7(BranchFormatMetadir):
1319
"""Branch format with last-revision, tags, and a stacked location pointer.
1321
The stacked location pointer is passed down to the repository and requires
1322
a repository format with supports_external_lookups = True.
1324
This format was introduced in bzr 1.6.
1327
def _branch_class(self):
1330
def get_format_string(self):
1331
"""See BranchFormat.get_format_string()."""
1332
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1334
def get_format_description(self):
1335
"""See BranchFormat.get_format_description()."""
1336
return "Branch format 7"
1338
def initialize(self, a_bzrdir):
1339
"""Create a branch of this format in a_bzrdir."""
1340
utf8_files = [('last-revision', '0 null:\n'),
1341
('branch.conf', ''),
1344
return self._initialize_helper(a_bzrdir, utf8_files)
1347
super(BzrBranchFormat7, self).__init__()
1348
self._matchingbzrdir.repository_format = \
1349
RepositoryFormatKnitPack5RichRoot()
1351
def supports_stacking(self):
1355
class BranchReferenceFormat(BranchFormat):
1356
"""Bzr branch reference format.
1358
Branch references are used in implementing checkouts, they
1359
act as an alias to the real branch which is at some other url.
1366
def get_format_string(self):
1367
"""See BranchFormat.get_format_string()."""
1368
return "Bazaar-NG Branch Reference Format 1\n"
1370
def get_format_description(self):
1371
"""See BranchFormat.get_format_description()."""
1372
return "Checkout reference format 1"
1374
def get_reference(self, a_bzrdir):
1375
"""See BranchFormat.get_reference()."""
1376
transport = a_bzrdir.get_branch_transport(None)
1377
return transport.get('location').read()
1379
def set_reference(self, a_bzrdir, to_branch):
1380
"""See BranchFormat.set_reference()."""
1381
transport = a_bzrdir.get_branch_transport(None)
1382
location = transport.put_bytes('location', to_branch.base)
1384
def initialize(self, a_bzrdir, target_branch=None):
1385
"""Create a branch of this format in a_bzrdir."""
1386
if target_branch is None:
1387
# this format does not implement branch itself, thus the implicit
1388
# creation contract must see it as uninitializable
1389
raise errors.UninitializableFormat(self)
1390
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1391
branch_transport = a_bzrdir.get_branch_transport(self)
1392
branch_transport.put_bytes('location',
1393
target_branch.bzrdir.root_transport.base)
1394
branch_transport.put_bytes('format', self.get_format_string())
1396
a_bzrdir, _found=True,
1397
possible_transports=[target_branch.bzrdir.root_transport])
1400
super(BranchReferenceFormat, self).__init__()
1401
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1403
def _make_reference_clone_function(format, a_branch):
1404
"""Create a clone() routine for a branch dynamically."""
1405
def clone(to_bzrdir, revision_id=None):
1406
"""See Branch.clone()."""
1407
return format.initialize(to_bzrdir, a_branch)
1408
# cannot obey revision_id limits when cloning a reference ...
1409
# FIXME RBC 20060210 either nuke revision_id for clone, or
1410
# emit some sort of warning/error to the caller ?!
1413
def open(self, a_bzrdir, _found=False, location=None,
1414
possible_transports=None):
1415
"""Return the branch that the branch reference in a_bzrdir points at.
1417
_found is a private parameter, do not use it. It is used to indicate
1418
if format probing has already be done.
1421
format = BranchFormat.find_format(a_bzrdir)
1422
if format.__class__ != self.__class__:
1423
raise AssertionError("wrong format %r found for %r" %
1425
if location is None:
1426
location = self.get_reference(a_bzrdir)
1427
real_bzrdir = bzrdir.BzrDir.open(
1428
location, possible_transports=possible_transports)
1429
result = real_bzrdir.open_branch()
1430
# this changes the behaviour of result.clone to create a new reference
1431
# rather than a copy of the content of the branch.
1432
# I did not use a proxy object because that needs much more extensive
1433
# testing, and we are only changing one behaviour at the moment.
1434
# If we decide to alter more behaviours - i.e. the implicit nickname
1435
# then this should be refactored to introduce a tested proxy branch
1436
# and a subclass of that for use in overriding clone() and ....
1438
result.clone = self._make_reference_clone_function(result)
1442
# formats which have no format string are not discoverable
1443
# and not independently creatable, so are not registered.
1444
__format5 = BzrBranchFormat5()
1445
__format6 = BzrBranchFormat6()
1446
__format7 = BzrBranchFormat7()
1447
BranchFormat.register_format(__format5)
1448
BranchFormat.register_format(BranchReferenceFormat())
1449
BranchFormat.register_format(__format6)
1450
BranchFormat.register_format(__format7)
1451
BranchFormat.set_default_format(__format6)
1452
_legacy_formats = [BzrBranchFormat4(),
1455
class BzrBranch(Branch):
1456
"""A branch stored in the actual filesystem.
1458
Note that it's "local" in the context of the filesystem; it doesn't
1459
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1460
it's writable, and can be accessed via the normal filesystem API.
1462
:ivar _transport: Transport for file operations on this branch's
1463
control files, typically pointing to the .bzr/branch directory.
1464
:ivar repository: Repository for this branch.
1465
:ivar base: The url of the base directory for this branch; the one
1466
containing the .bzr directory.
1469
def __init__(self, _format=None,
1470
_control_files=None, a_bzrdir=None, _repository=None):
1471
"""Create new branch object at a particular location."""
1472
if a_bzrdir is None:
1473
raise ValueError('a_bzrdir must be supplied')
1475
self.bzrdir = a_bzrdir
1476
self._base = self.bzrdir.transport.clone('..').base
1477
# XXX: We should be able to just do
1478
# self.base = self.bzrdir.root_transport.base
1479
# but this does not quite work yet -- mbp 20080522
1480
self._format = _format
1481
if _control_files is None:
1482
raise ValueError('BzrBranch _control_files is None')
1483
self.control_files = _control_files
1484
self._transport = _control_files._transport
1485
self.repository = _repository
1486
Branch.__init__(self)
1489
return '%s(%r)' % (self.__class__.__name__, self.base)
1493
def _get_base(self):
1494
"""Returns the directory containing the control directory."""
1497
base = property(_get_base, doc="The URL for the root of this branch.")
1499
def is_locked(self):
1500
return self.control_files.is_locked()
1502
def lock_write(self, token=None):
1503
repo_token = self.repository.lock_write()
1505
token = self.control_files.lock_write(token=token)
1507
self.repository.unlock()
1511
def lock_read(self):
1512
self.repository.lock_read()
1514
self.control_files.lock_read()
1516
self.repository.unlock()
1520
# TODO: test for failed two phase locks. This is known broken.
1522
self.control_files.unlock()
1524
self.repository.unlock()
1525
if not self.control_files.is_locked():
1526
# we just released the lock
1527
self._clear_cached_state()
1529
def peek_lock_mode(self):
1530
if self.control_files._lock_count == 0:
1533
return self.control_files._lock_mode
1535
def get_physical_lock_status(self):
1536
return self.control_files.get_physical_lock_status()
1539
def print_file(self, file, revision_id):
1540
"""See Branch.print_file."""
1541
return self.repository.print_file(file, revision_id)
1543
def _write_revision_history(self, history):
1544
"""Factored out of set_revision_history.
1546
This performs the actual writing to disk.
1547
It is intended to be called by BzrBranch5.set_revision_history."""
1548
self._transport.put_bytes(
1549
'revision-history', '\n'.join(history),
1550
mode=self.bzrdir._get_file_mode())
1553
def set_revision_history(self, rev_history):
1554
"""See Branch.set_revision_history."""
1555
if 'evil' in debug.debug_flags:
1556
mutter_callsite(3, "set_revision_history scales with history.")
1557
check_not_reserved_id = _mod_revision.check_not_reserved_id
1558
for rev_id in rev_history:
1559
check_not_reserved_id(rev_id)
1560
if Branch.hooks['post_change_branch_tip']:
1561
# Don't calculate the last_revision_info() if there are no hooks
1563
old_revno, old_revid = self.last_revision_info()
1564
if len(rev_history) == 0:
1565
revid = _mod_revision.NULL_REVISION
1567
revid = rev_history[-1]
1568
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1569
self._write_revision_history(rev_history)
1570
self._clear_cached_state()
1571
self._cache_revision_history(rev_history)
1572
for hook in Branch.hooks['set_rh']:
1573
hook(self, rev_history)
1574
if Branch.hooks['post_change_branch_tip']:
1575
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1577
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1578
"""Run the pre_change_branch_tip hooks."""
1579
hooks = Branch.hooks['pre_change_branch_tip']
1582
old_revno, old_revid = self.last_revision_info()
1583
params = ChangeBranchTipParams(
1584
self, old_revno, new_revno, old_revid, new_revid)
1588
except errors.TipChangeRejected:
1591
exc_info = sys.exc_info()
1592
hook_name = Branch.hooks.get_hook_name(hook)
1593
raise errors.HookFailed(
1594
'pre_change_branch_tip', hook_name, exc_info)
1596
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1597
"""Run the post_change_branch_tip hooks."""
1598
hooks = Branch.hooks['post_change_branch_tip']
1601
new_revno, new_revid = self.last_revision_info()
1602
params = ChangeBranchTipParams(
1603
self, old_revno, new_revno, old_revid, new_revid)
1608
def set_last_revision_info(self, revno, revision_id):
1609
"""Set the last revision of this branch.
1611
The caller is responsible for checking that the revno is correct
1612
for this revision id.
1614
It may be possible to set the branch last revision to an id not
1615
present in the repository. However, branches can also be
1616
configured to check constraints on history, in which case this may not
1619
revision_id = _mod_revision.ensure_null(revision_id)
1620
# this old format stores the full history, but this api doesn't
1621
# provide it, so we must generate, and might as well check it's
1623
history = self._lefthand_history(revision_id)
1624
if len(history) != revno:
1625
raise AssertionError('%d != %d' % (len(history), revno))
1626
self.set_revision_history(history)
1628
def _gen_revision_history(self):
1629
history = self._transport.get_bytes('revision-history').split('\n')
1630
if history[-1:] == ['']:
1631
# There shouldn't be a trailing newline, but just in case.
1635
def _lefthand_history(self, revision_id, last_rev=None,
1637
if 'evil' in debug.debug_flags:
1638
mutter_callsite(4, "_lefthand_history scales with history.")
1639
# stop_revision must be a descendant of last_revision
1640
graph = self.repository.get_graph()
1641
if last_rev is not None:
1642
if not graph.is_ancestor(last_rev, revision_id):
1643
# our previous tip is not merged into stop_revision
1644
raise errors.DivergedBranches(self, other_branch)
1645
# make a new revision history from the graph
1646
parents_map = graph.get_parent_map([revision_id])
1647
if revision_id not in parents_map:
1648
raise errors.NoSuchRevision(self, revision_id)
1649
current_rev_id = revision_id
1651
check_not_reserved_id = _mod_revision.check_not_reserved_id
1652
# Do not include ghosts or graph origin in revision_history
1653
while (current_rev_id in parents_map and
1654
len(parents_map[current_rev_id]) > 0):
1655
check_not_reserved_id(current_rev_id)
1656
new_history.append(current_rev_id)
1657
current_rev_id = parents_map[current_rev_id][0]
1658
parents_map = graph.get_parent_map([current_rev_id])
1659
new_history.reverse()
1663
def generate_revision_history(self, revision_id, last_rev=None,
1665
"""Create a new revision history that will finish with revision_id.
1667
:param revision_id: the new tip to use.
1668
:param last_rev: The previous last_revision. If not None, then this
1669
must be a ancestory of revision_id, or DivergedBranches is raised.
1670
:param other_branch: The other branch that DivergedBranches should
1671
raise with respect to.
1673
self.set_revision_history(self._lefthand_history(revision_id,
1674
last_rev, other_branch))
1676
def basis_tree(self):
1677
"""See Branch.basis_tree."""
1678
return self.repository.revision_tree(self.last_revision())
1681
def pull(self, source, overwrite=False, stop_revision=None,
1682
_hook_master=None, run_hooks=True, possible_transports=None,
1683
_override_hook_target=None):
1686
:param _hook_master: Private parameter - set the branch to
1687
be supplied as the master to pull hooks.
1688
:param run_hooks: Private parameter - if false, this branch
1689
is being called because it's the master of the primary branch,
1690
so it should not run its hooks.
1691
:param _override_hook_target: Private parameter - set the branch to be
1692
supplied as the target_branch to pull hooks.
1694
result = PullResult()
1695
result.source_branch = source
1696
if _override_hook_target is None:
1697
result.target_branch = self
1699
result.target_branch = _override_hook_target
1702
# We assume that during 'pull' the local repository is closer than
1704
graph = self.repository.get_graph(source.repository)
1705
result.old_revno, result.old_revid = self.last_revision_info()
1706
self.update_revisions(source, stop_revision, overwrite=overwrite,
1708
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1709
result.new_revno, result.new_revid = self.last_revision_info()
1711
result.master_branch = _hook_master
1712
result.local_branch = result.target_branch
1714
result.master_branch = result.target_branch
1715
result.local_branch = None
1717
for hook in Branch.hooks['post_pull']:
1723
def _get_parent_location(self):
1724
_locs = ['parent', 'pull', 'x-pull']
1727
return self._transport.get_bytes(l).strip('\n')
1728
except errors.NoSuchFile:
1733
def push(self, target, overwrite=False, stop_revision=None,
1734
_override_hook_source_branch=None):
1737
This is the basic concrete implementation of push()
1739
:param _override_hook_source_branch: If specified, run
1740
the hooks passing this Branch as the source, rather than self.
1741
This is for use of RemoteBranch, where push is delegated to the
1742
underlying vfs-based Branch.
1744
# TODO: Public option to disable running hooks - should be trivial but
1748
result = self._push_with_bound_branches(target, overwrite,
1750
_override_hook_source_branch=_override_hook_source_branch)
1755
def _push_with_bound_branches(self, target, overwrite,
1757
_override_hook_source_branch=None):
1758
"""Push from self into target, and into target's master if any.
1760
This is on the base BzrBranch class even though it doesn't support
1761
bound branches because the *target* might be bound.
1764
if _override_hook_source_branch:
1765
result.source_branch = _override_hook_source_branch
1766
for hook in Branch.hooks['post_push']:
1769
bound_location = target.get_bound_location()
1770
if bound_location and target.base != bound_location:
1771
# there is a master branch.
1773
# XXX: Why the second check? Is it even supported for a branch to
1774
# be bound to itself? -- mbp 20070507
1775
master_branch = target.get_master_branch()
1776
master_branch.lock_write()
1778
# push into the master from this branch.
1779
self._basic_push(master_branch, overwrite, stop_revision)
1780
# and push into the target branch from this. Note that we push from
1781
# this branch again, because its considered the highest bandwidth
1783
result = self._basic_push(target, overwrite, stop_revision)
1784
result.master_branch = master_branch
1785
result.local_branch = target
1789
master_branch.unlock()
1792
result = self._basic_push(target, overwrite, stop_revision)
1793
# TODO: Why set master_branch and local_branch if there's no
1794
# binding? Maybe cleaner to just leave them unset? -- mbp
1796
result.master_branch = target
1797
result.local_branch = None
1801
def _basic_push(self, target, overwrite, stop_revision):
1802
"""Basic implementation of push without bound branches or hooks.
1804
Must be called with self read locked and target write locked.
1806
result = PushResult()
1807
result.source_branch = self
1808
result.target_branch = target
1809
result.old_revno, result.old_revid = target.last_revision_info()
1810
if result.old_revid != self.last_revision():
1811
# We assume that during 'push' this repository is closer than
1813
graph = self.repository.get_graph(target.repository)
1814
target.update_revisions(self, stop_revision, overwrite=overwrite,
1816
if self._push_should_merge_tags():
1817
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1818
result.new_revno, result.new_revid = target.last_revision_info()
1821
def _push_should_merge_tags(self):
1822
"""Should _basic_push merge this branch's tags into the target?
1824
The default implementation returns False if this branch has no tags,
1825
and True the rest of the time. Subclasses may override this.
1827
return self.tags.supports_tags() and self.tags.get_tag_dict()
1829
def get_parent(self):
1830
"""See Branch.get_parent."""
1831
parent = self._get_parent_location()
1834
# This is an old-format absolute path to a local branch
1835
# turn it into a url
1836
if parent.startswith('/'):
1837
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1839
return urlutils.join(self.base[:-1], parent)
1840
except errors.InvalidURLJoin, e:
1841
raise errors.InaccessibleParent(parent, self.base)
1843
def get_stacked_on_url(self):
1844
raise errors.UnstackableBranchFormat(self._format, self.base)
1846
def set_push_location(self, location):
1847
"""See Branch.set_push_location."""
1848
self.get_config().set_user_option(
1849
'push_location', location,
1850
store=_mod_config.STORE_LOCATION_NORECURSE)
1853
def set_parent(self, url):
1854
"""See Branch.set_parent."""
1855
# TODO: Maybe delete old location files?
1856
# URLs should never be unicode, even on the local fs,
1857
# FIXUP this and get_parent in a future branch format bump:
1858
# read and rewrite the file. RBC 20060125
1860
if isinstance(url, unicode):
1862
url = url.encode('ascii')
1863
except UnicodeEncodeError:
1864
raise errors.InvalidURL(url,
1865
"Urls must be 7-bit ascii, "
1866
"use bzrlib.urlutils.escape")
1867
url = urlutils.relative_url(self.base, url)
1868
self._set_parent_location(url)
1870
def _set_parent_location(self, url):
1872
self._transport.delete('parent')
1874
self._transport.put_bytes('parent', url + '\n',
1875
mode=self.bzrdir._get_file_mode())
1877
def set_stacked_on_url(self, url):
1878
raise errors.UnstackableBranchFormat(self._format, self.base)
1881
class BzrBranch5(BzrBranch):
1882
"""A format 5 branch. This supports new features over plain branches.
1884
It has support for a master_branch which is the data for bound branches.
1888
def pull(self, source, overwrite=False, stop_revision=None,
1889
run_hooks=True, possible_transports=None,
1890
_override_hook_target=None):
1891
"""Pull from source into self, updating my master if any.
1893
:param run_hooks: Private parameter - if false, this branch
1894
is being called because it's the master of the primary branch,
1895
so it should not run its hooks.
1897
bound_location = self.get_bound_location()
1898
master_branch = None
1899
if bound_location and source.base != bound_location:
1900
# not pulling from master, so we need to update master.
1901
master_branch = self.get_master_branch(possible_transports)
1902
master_branch.lock_write()
1905
# pull from source into master.
1906
master_branch.pull(source, overwrite, stop_revision,
1908
return super(BzrBranch5, self).pull(source, overwrite,
1909
stop_revision, _hook_master=master_branch,
1910
run_hooks=run_hooks,
1911
_override_hook_target=_override_hook_target)
1914
master_branch.unlock()
1916
def get_bound_location(self):
1918
return self._transport.get_bytes('bound')[:-1]
1919
except errors.NoSuchFile:
1923
def get_master_branch(self, possible_transports=None):
1924
"""Return the branch we are bound to.
1926
:return: Either a Branch, or None
1928
This could memoise the branch, but if thats done
1929
it must be revalidated on each new lock.
1930
So for now we just don't memoise it.
1931
# RBC 20060304 review this decision.
1933
bound_loc = self.get_bound_location()
1937
return Branch.open(bound_loc,
1938
possible_transports=possible_transports)
1939
except (errors.NotBranchError, errors.ConnectionError), e:
1940
raise errors.BoundBranchConnectionFailure(
1944
def set_bound_location(self, location):
1945
"""Set the target where this branch is bound to.
1947
:param location: URL to the target branch
1950
self._transport.put_bytes('bound', location+'\n',
1951
mode=self.bzrdir._get_file_mode())
1954
self._transport.delete('bound')
1955
except errors.NoSuchFile:
1960
def bind(self, other):
1961
"""Bind this branch to the branch other.
1963
This does not push or pull data between the branches, though it does
1964
check for divergence to raise an error when the branches are not
1965
either the same, or one a prefix of the other. That behaviour may not
1966
be useful, so that check may be removed in future.
1968
:param other: The branch to bind to
1971
# TODO: jam 20051230 Consider checking if the target is bound
1972
# It is debatable whether you should be able to bind to
1973
# a branch which is itself bound.
1974
# Committing is obviously forbidden,
1975
# but binding itself may not be.
1976
# Since we *have* to check at commit time, we don't
1977
# *need* to check here
1979
# we want to raise diverged if:
1980
# last_rev is not in the other_last_rev history, AND
1981
# other_last_rev is not in our history, and do it without pulling
1983
self.set_bound_location(other.base)
1987
"""If bound, unbind"""
1988
return self.set_bound_location(None)
1991
def update(self, possible_transports=None):
1992
"""Synchronise this branch with the master branch if any.
1994
:return: None or the last_revision that was pivoted out during the
1997
master = self.get_master_branch(possible_transports)
1998
if master is not None:
1999
old_tip = _mod_revision.ensure_null(self.last_revision())
2000
self.pull(master, overwrite=True)
2001
if self.repository.get_graph().is_ancestor(old_tip,
2002
_mod_revision.ensure_null(self.last_revision())):
2008
class BzrBranch7(BzrBranch5):
2009
"""A branch with support for a fallback repository."""
2011
def _get_fallback_repository(self, url):
2012
"""Get the repository we fallback to at url."""
2013
url = urlutils.join(self.base, url)
2014
return bzrdir.BzrDir.open(url).open_branch().repository
2016
def _activate_fallback_location(self, url):
2017
"""Activate the branch/repository from url as a fallback repository."""
2018
self.repository.add_fallback_repository(
2019
self._get_fallback_repository(url))
2021
def _open_hook(self):
2023
url = self.get_stacked_on_url()
2024
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2025
errors.UnstackableBranchFormat):
2028
self._activate_fallback_location(url)
2030
def _check_stackable_repo(self):
2031
if not self.repository._format.supports_external_lookups:
2032
raise errors.UnstackableRepositoryFormat(self.repository._format,
2033
self.repository.base)
2035
def __init__(self, *args, **kwargs):
2036
super(BzrBranch7, self).__init__(*args, **kwargs)
2037
self._last_revision_info_cache = None
2038
self._partial_revision_history_cache = []
2040
def _clear_cached_state(self):
2041
super(BzrBranch7, self)._clear_cached_state()
2042
self._last_revision_info_cache = None
2043
self._partial_revision_history_cache = []
2045
def _last_revision_info(self):
2046
revision_string = self._transport.get_bytes('last-revision')
2047
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2048
revision_id = cache_utf8.get_cached_utf8(revision_id)
2050
return revno, revision_id
2052
def _write_last_revision_info(self, revno, revision_id):
2053
"""Simply write out the revision id, with no checks.
2055
Use set_last_revision_info to perform this safely.
2057
Does not update the revision_history cache.
2058
Intended to be called by set_last_revision_info and
2059
_write_revision_history.
2061
revision_id = _mod_revision.ensure_null(revision_id)
2062
out_string = '%d %s\n' % (revno, revision_id)
2063
self._transport.put_bytes('last-revision', out_string,
2064
mode=self.bzrdir._get_file_mode())
2067
def set_last_revision_info(self, revno, revision_id):
2068
revision_id = _mod_revision.ensure_null(revision_id)
2069
old_revno, old_revid = self.last_revision_info()
2070
if self._get_append_revisions_only():
2071
self._check_history_violation(revision_id)
2072
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2073
self._write_last_revision_info(revno, revision_id)
2074
self._clear_cached_state()
2075
self._last_revision_info_cache = revno, revision_id
2076
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2078
def _check_history_violation(self, revision_id):
2079
last_revision = _mod_revision.ensure_null(self.last_revision())
2080
if _mod_revision.is_null(last_revision):
2082
if last_revision not in self._lefthand_history(revision_id):
2083
raise errors.AppendRevisionsOnlyViolation(self.base)
2085
def _gen_revision_history(self):
2086
"""Generate the revision history from last revision
2088
last_revno, last_revision = self.last_revision_info()
2089
self._extend_partial_history(stop_index=last_revno-1)
2090
return list(reversed(self._partial_revision_history_cache))
2092
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2093
"""Extend the partial history to include a given index
2095
If a stop_index is supplied, stop when that index has been reached.
2096
If a stop_revision is supplied, stop when that revision is
2097
encountered. Otherwise, stop when the beginning of history is
2100
:param stop_index: The index which should be present. When it is
2101
present, history extension will stop.
2102
:param revision_id: The revision id which should be present. When
2103
it is encountered, history extension will stop.
2105
repo = self.repository
2106
if len(self._partial_revision_history_cache) == 0:
2107
iterator = repo.iter_reverse_revision_history(self.last_revision())
2109
start_revision = self._partial_revision_history_cache[-1]
2110
iterator = repo.iter_reverse_revision_history(start_revision)
2111
#skip the last revision in the list
2112
next_revision = iterator.next()
2113
for revision_id in iterator:
2114
self._partial_revision_history_cache.append(revision_id)
2115
if (stop_index is not None and
2116
len(self._partial_revision_history_cache) > stop_index):
2118
if revision_id == stop_revision:
2121
def _write_revision_history(self, history):
2122
"""Factored out of set_revision_history.
2124
This performs the actual writing to disk, with format-specific checks.
2125
It is intended to be called by BzrBranch5.set_revision_history.
2127
if len(history) == 0:
2128
last_revision = 'null:'
2130
if history != self._lefthand_history(history[-1]):
2131
raise errors.NotLefthandHistory(history)
2132
last_revision = history[-1]
2133
if self._get_append_revisions_only():
2134
self._check_history_violation(last_revision)
2135
self._write_last_revision_info(len(history), last_revision)
2138
def _set_parent_location(self, url):
2139
"""Set the parent branch"""
2140
self._set_config_location('parent_location', url, make_relative=True)
2143
def _get_parent_location(self):
2144
"""Set the parent branch"""
2145
return self._get_config_location('parent_location')
2147
def set_push_location(self, location):
2148
"""See Branch.set_push_location."""
2149
self._set_config_location('push_location', location)
2151
def set_bound_location(self, location):
2152
"""See Branch.set_push_location."""
2154
config = self.get_config()
2155
if location is None:
2156
if config.get_user_option('bound') != 'True':
2159
config.set_user_option('bound', 'False', warn_masked=True)
2162
self._set_config_location('bound_location', location,
2164
config.set_user_option('bound', 'True', warn_masked=True)
2167
def _get_bound_location(self, bound):
2168
"""Return the bound location in the config file.
2170
Return None if the bound parameter does not match"""
2171
config = self.get_config()
2172
config_bound = (config.get_user_option('bound') == 'True')
2173
if config_bound != bound:
2175
return self._get_config_location('bound_location', config=config)
2177
def get_bound_location(self):
2178
"""See Branch.set_push_location."""
2179
return self._get_bound_location(True)
2181
def get_old_bound_location(self):
2182
"""See Branch.get_old_bound_location"""
2183
return self._get_bound_location(False)
2185
def get_stacked_on_url(self):
2186
# you can always ask for the URL; but you might not be able to use it
2187
# if the repo can't support stacking.
2188
## self._check_stackable_repo()
2189
stacked_url = self._get_config_location('stacked_on_location')
2190
if stacked_url is None:
2191
raise errors.NotStacked(self)
2194
def set_append_revisions_only(self, enabled):
2199
self.get_config().set_user_option('append_revisions_only', value,
2202
def set_stacked_on_url(self, url):
2203
self._check_stackable_repo()
2206
old_url = self.get_stacked_on_url()
2207
except (errors.NotStacked, errors.UnstackableBranchFormat,
2208
errors.UnstackableRepositoryFormat):
2211
# repositories don't offer an interface to remove fallback
2212
# repositories today; take the conceptually simpler option and just
2214
self.repository = self.bzrdir.find_repository()
2215
# for every revision reference the branch has, ensure it is pulled
2217
source_repository = self._get_fallback_repository(old_url)
2218
for revision_id in chain([self.last_revision()],
2219
self.tags.get_reverse_tag_dict()):
2220
self.repository.fetch(source_repository, revision_id,
2223
self._activate_fallback_location(url)
2224
# write this out after the repository is stacked to avoid setting a
2225
# stacked config that doesn't work.
2226
self._set_config_location('stacked_on_location', url)
2228
def _get_append_revisions_only(self):
2229
value = self.get_config().get_user_option('append_revisions_only')
2230
return value == 'True'
2232
def _synchronize_history(self, destination, revision_id):
2233
"""Synchronize last revision and revision history between branches.
2235
This version is most efficient when the destination is also a
2236
BzrBranch6, but works for BzrBranch5, as long as the destination's
2237
repository contains all the lefthand ancestors of the intended
2238
last_revision. If not, set_last_revision_info will fail.
2240
:param destination: The branch to copy the history into
2241
:param revision_id: The revision-id to truncate history at. May
2242
be None to copy complete history.
2244
source_revno, source_revision_id = self.last_revision_info()
2245
if revision_id is None:
2246
revno, revision_id = source_revno, source_revision_id
2247
elif source_revision_id == revision_id:
2248
# we know the revno without needing to walk all of history
2249
revno = source_revno
2251
# To figure out the revno for a random revision, we need to build
2252
# the revision history, and count its length.
2253
# We don't care about the order, just how long it is.
2254
# Alternatively, we could start at the current location, and count
2255
# backwards. But there is no guarantee that we will find it since
2256
# it may be a merged revision.
2257
revno = len(list(self.repository.iter_reverse_revision_history(
2259
destination.set_last_revision_info(revno, revision_id)
2261
def _make_tags(self):
2262
return BasicTags(self)
2265
def generate_revision_history(self, revision_id, last_rev=None,
2267
"""See BzrBranch5.generate_revision_history"""
2268
history = self._lefthand_history(revision_id, last_rev, other_branch)
2269
revno = len(history)
2270
self.set_last_revision_info(revno, revision_id)
2273
def get_rev_id(self, revno, history=None):
2274
"""Find the revision id of the specified revno."""
2276
return _mod_revision.NULL_REVISION
2278
last_revno, last_revision_id = self.last_revision_info()
2279
if revno <= 0 or revno > last_revno:
2280
raise errors.NoSuchRevision(self, revno)
2282
if history is not None:
2283
return history[revno - 1]
2285
index = last_revno - revno
2286
if len(self._partial_revision_history_cache) <= index:
2287
self._extend_partial_history(stop_index=index)
2288
if len(self._partial_revision_history_cache) > index:
2289
return self._partial_revision_history_cache[index]
2291
raise errors.NoSuchRevision(self, revno)
2294
def revision_id_to_revno(self, revision_id):
2295
"""Given a revision id, return its revno"""
2296
if _mod_revision.is_null(revision_id):
2299
index = self._partial_revision_history_cache.index(revision_id)
2301
self._extend_partial_history(stop_revision=revision_id)
2302
index = len(self._partial_revision_history_cache) - 1
2303
if self._partial_revision_history_cache[index] != revision_id:
2304
raise errors.NoSuchRevision(self, revision_id)
2305
return self.revno() - index
2308
class BzrBranch6(BzrBranch7):
2309
"""See BzrBranchFormat6 for the capabilities of this branch.
2311
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2315
def get_stacked_on_url(self):
2316
raise errors.UnstackableBranchFormat(self._format, self.base)
2318
def set_stacked_on_url(self, url):
2319
raise errors.UnstackableBranchFormat(self._format, self.base)
2322
######################################################################
2323
# results of operations
2326
class _Result(object):
2328
def _show_tag_conficts(self, to_file):
2329
if not getattr(self, 'tag_conflicts', None):
2331
to_file.write('Conflicting tags:\n')
2332
for name, value1, value2 in self.tag_conflicts:
2333
to_file.write(' %s\n' % (name, ))
2336
class PullResult(_Result):
2337
"""Result of a Branch.pull operation.
2339
:ivar old_revno: Revision number before pull.
2340
:ivar new_revno: Revision number after pull.
2341
:ivar old_revid: Tip revision id before pull.
2342
:ivar new_revid: Tip revision id after pull.
2343
:ivar source_branch: Source (local) branch object.
2344
:ivar master_branch: Master branch of the target, or the target if no
2346
:ivar local_branch: target branch if there is a Master, else None
2347
:ivar target_branch: Target/destination branch object.
2348
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2352
# DEPRECATED: pull used to return the change in revno
2353
return self.new_revno - self.old_revno
2355
def report(self, to_file):
2357
if self.old_revid == self.new_revid:
2358
to_file.write('No revisions to pull.\n')
2360
to_file.write('Now on revision %d.\n' % self.new_revno)
2361
self._show_tag_conficts(to_file)
2364
class PushResult(_Result):
2365
"""Result of a Branch.push operation.
2367
:ivar old_revno: Revision number before push.
2368
:ivar new_revno: Revision number after push.
2369
:ivar old_revid: Tip revision id before push.
2370
:ivar new_revid: Tip revision id after push.
2371
:ivar source_branch: Source branch object.
2372
:ivar master_branch: Master branch of the target, or None.
2373
:ivar target_branch: Target/destination branch object.
2377
# DEPRECATED: push used to return the change in revno
2378
return self.new_revno - self.old_revno
2380
def report(self, to_file):
2381
"""Write a human-readable description of the result."""
2382
if self.old_revid == self.new_revid:
2383
to_file.write('No new revisions to push.\n')
2385
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2386
self._show_tag_conficts(to_file)
2389
class BranchCheckResult(object):
2390
"""Results of checking branch consistency.
2395
def __init__(self, branch):
2396
self.branch = branch
2398
def report_results(self, verbose):
2399
"""Report the check results via trace.note.
2401
:param verbose: Requests more detailed display of what was checked,
2404
note('checked branch %s format %s',
2406
self.branch._format)
2409
class Converter5to6(object):
2410
"""Perform an in-place upgrade of format 5 to format 6"""
2412
def convert(self, branch):
2413
# Data for 5 and 6 can peacefully coexist.
2414
format = BzrBranchFormat6()
2415
new_branch = format.open(branch.bzrdir, _found=True)
2417
# Copy source data into target
2418
new_branch._write_last_revision_info(*branch.last_revision_info())
2419
new_branch.set_parent(branch.get_parent())
2420
new_branch.set_bound_location(branch.get_bound_location())
2421
new_branch.set_push_location(branch.get_push_location())
2423
# New branch has no tags by default
2424
new_branch.tags._set_tag_dict({})
2426
# Copying done; now update target format
2427
new_branch._transport.put_bytes('format',
2428
format.get_format_string(),
2429
mode=new_branch.bzrdir._get_file_mode())
2431
# Clean up old files
2432
new_branch._transport.delete('revision-history')
2434
branch.set_parent(None)
2435
except errors.NoSuchFile:
2437
branch.set_bound_location(None)
2440
class Converter6to7(object):
2441
"""Perform an in-place upgrade of format 6 to format 7"""
2443
def convert(self, branch):
2444
format = BzrBranchFormat7()
2445
branch._set_config_location('stacked_on_location', '')
2446
# update target format
2447
branch._transport.put_bytes('format', format.get_format_string())
added
removed
bzrlib/branch.py
