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 RepositoryFormatPackDevelopment1Subtree
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
96
"""Called by init to allow simpler extension of the base class."""
99
"""Break a lock if one is present from another instance.
101
Uses the ui factory to ask for confirmation if the lock may be from
104
This will probe the repository for its lock as well.
106
self.control_files.break_lock()
107
self.repository.break_lock()
108
master = self.get_master_branch()
109
if master is not None:
113
def open(base, _unsupported=False, possible_transports=None):
114
"""Open the branch rooted at base.
116
For instance, if the branch is at URL/.bzr/branch,
117
Branch.open(URL) -> a Branch instance.
119
control = bzrdir.BzrDir.open(base, _unsupported,
120
possible_transports=possible_transports)
121
return control.open_branch(_unsupported)
124
def open_from_transport(transport, _unsupported=False):
125
"""Open the branch rooted at transport"""
126
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
127
return control.open_branch(_unsupported)
130
def open_containing(url, possible_transports=None):
131
"""Open an existing branch which contains url.
133
This probes for a branch at url, and searches upwards from there.
135
Basically we keep looking up until we find the control directory or
136
run into the root. If there isn't one, raises NotBranchError.
137
If there is one and it is either an unrecognised format or an unsupported
138
format, UnknownFormatError or UnsupportedFormatError are raised.
139
If there is one, it is returned, along with the unused portion of url.
141
control, relpath = bzrdir.BzrDir.open_containing(url,
143
return control.open_branch(), relpath
145
def get_config(self):
146
return BranchConfig(self)
149
return self.get_config().get_nickname()
151
def _set_nick(self, nick):
152
self.get_config().set_user_option('nickname', nick, warn_masked=True)
154
nick = property(_get_nick, _set_nick)
157
raise NotImplementedError(self.is_locked)
159
def lock_write(self):
160
raise NotImplementedError(self.lock_write)
163
raise NotImplementedError(self.lock_read)
166
raise NotImplementedError(self.unlock)
168
def peek_lock_mode(self):
169
"""Return lock mode for the Branch: 'r', 'w' or None"""
170
raise NotImplementedError(self.peek_lock_mode)
172
def get_physical_lock_status(self):
173
raise NotImplementedError(self.get_physical_lock_status)
176
def get_revision_id_to_revno_map(self):
177
"""Return the revision_id => dotted revno map.
179
This will be regenerated on demand, but will be cached.
181
:return: A dictionary mapping revision_id => dotted revno.
182
This dictionary should not be modified by the caller.
184
if self._revision_id_to_revno_cache is not None:
185
mapping = self._revision_id_to_revno_cache
187
mapping = self._gen_revno_map()
188
self._cache_revision_id_to_revno(mapping)
189
# TODO: jam 20070417 Since this is being cached, should we be returning
191
# I would rather not, and instead just declare that users should not
192
# modify the return value.
195
def _gen_revno_map(self):
196
"""Create a new mapping from revision ids to dotted revnos.
198
Dotted revnos are generated based on the current tip in the revision
200
This is the worker function for get_revision_id_to_revno_map, which
201
just caches the return value.
203
:return: A dictionary mapping revision_id => dotted revno.
205
last_revision = self.last_revision()
206
revision_graph = repository._old_get_graph(self.repository,
208
merge_sorted_revisions = tsort.merge_sort(
213
revision_id_to_revno = dict((rev_id, revno)
214
for seq_num, rev_id, depth, revno, end_of_merge
215
in merge_sorted_revisions)
216
return revision_id_to_revno
218
def leave_lock_in_place(self):
219
"""Tell this branch object not to release the physical lock when this
222
If lock_write doesn't return a token, then this method is not supported.
224
self.control_files.leave_in_place()
226
def dont_leave_lock_in_place(self):
227
"""Tell this branch object to release the physical lock when this
228
object is unlocked, even if it didn't originally acquire it.
230
If lock_write doesn't return a token, then this method is not supported.
232
self.control_files.dont_leave_in_place()
234
def bind(self, other):
235
"""Bind the local branch the other branch.
237
:param other: The branch to bind to
240
raise errors.UpgradeRequired(self.base)
243
def fetch(self, from_branch, last_revision=None, pb=None):
244
"""Copy revisions from from_branch into this branch.
246
:param from_branch: Where to copy from.
247
:param last_revision: What revision to stop at (None for at the end
249
:param pb: An optional progress bar to use.
251
Returns the copied revision count and the failed revisions in a tuple:
254
if self.base == from_branch.base:
257
nested_pb = ui.ui_factory.nested_progress_bar()
262
from_branch.lock_read()
264
if last_revision is None:
265
pb.update('get source history')
266
last_revision = from_branch.last_revision()
267
last_revision = _mod_revision.ensure_null(last_revision)
268
return self.repository.fetch(from_branch.repository,
269
revision_id=last_revision,
272
if nested_pb is not None:
276
def get_bound_location(self):
277
"""Return the URL of the branch we are bound to.
279
Older format branches cannot bind, please be sure to use a metadir
284
def get_old_bound_location(self):
285
"""Return the URL of the branch we used to be bound to
287
raise errors.UpgradeRequired(self.base)
289
def get_commit_builder(self, parents, config=None, timestamp=None,
290
timezone=None, committer=None, revprops=None,
292
"""Obtain a CommitBuilder for this branch.
294
:param parents: Revision ids of the parents of the new revision.
295
:param config: Optional configuration to use.
296
:param timestamp: Optional timestamp recorded for commit.
297
:param timezone: Optional timezone for timestamp.
298
:param committer: Optional committer to set for commit.
299
:param revprops: Optional dictionary of revision properties.
300
:param revision_id: Optional revision id.
304
config = self.get_config()
306
return self.repository.get_commit_builder(self, parents, config,
307
timestamp, timezone, committer, revprops, revision_id)
309
def get_master_branch(self, possible_transports=None):
310
"""Return the branch we are bound to.
312
:return: Either a Branch, or None
316
def get_revision_delta(self, revno):
317
"""Return the delta for one revision.
319
The delta is relative to its mainline predecessor, or the
320
empty tree for revision 1.
322
rh = self.revision_history()
323
if not (1 <= revno <= len(rh)):
324
raise errors.InvalidRevisionNumber(revno)
325
return self.repository.get_revision_delta(rh[revno-1])
327
def get_stacked_on_url(self):
328
"""Get the URL this branch is stacked against.
330
:raises NotStacked: If the branch is not stacked.
331
:raises UnstackableBranchFormat: If the branch does not support
334
raise NotImplementedError(self.get_stacked_on_url)
336
def print_file(self, file, revision_id):
337
"""Print `file` to stdout."""
338
raise NotImplementedError(self.print_file)
340
def set_revision_history(self, rev_history):
341
raise NotImplementedError(self.set_revision_history)
343
def set_stacked_on_url(self, url):
344
"""Set the URL this branch is stacked against.
346
:raises UnstackableBranchFormat: If the branch does not support
348
:raises UnstackableRepositoryFormat: If the repository does not support
351
raise NotImplementedError(self.set_stacked_on_url)
353
def _cache_revision_history(self, rev_history):
354
"""Set the cached revision history to rev_history.
356
The revision_history method will use this cache to avoid regenerating
357
the revision history.
359
This API is semi-public; it only for use by subclasses, all other code
360
should consider it to be private.
362
self._revision_history_cache = rev_history
364
def _cache_revision_id_to_revno(self, revision_id_to_revno):
365
"""Set the cached revision_id => revno map to revision_id_to_revno.
367
This API is semi-public; it only for use by subclasses, all other code
368
should consider it to be private.
370
self._revision_id_to_revno_cache = revision_id_to_revno
372
def _clear_cached_state(self):
373
"""Clear any cached data on this branch, e.g. cached revision history.
375
This means the next call to revision_history will need to call
376
_gen_revision_history.
378
This API is semi-public; it only for use by subclasses, all other code
379
should consider it to be private.
381
self._revision_history_cache = None
382
self._revision_id_to_revno_cache = None
383
self._last_revision_info_cache = None
385
def _gen_revision_history(self):
386
"""Return sequence of revision hashes on to this branch.
388
Unlike revision_history, this method always regenerates or rereads the
389
revision history, i.e. it does not cache the result, so repeated calls
392
Concrete subclasses should override this instead of revision_history so
393
that subclasses do not need to deal with caching logic.
395
This API is semi-public; it only for use by subclasses, all other code
396
should consider it to be private.
398
raise NotImplementedError(self._gen_revision_history)
401
def revision_history(self):
402
"""Return sequence of revision ids on this branch.
404
This method will cache the revision history for as long as it is safe to
407
if 'evil' in debug.debug_flags:
408
mutter_callsite(3, "revision_history scales with history.")
409
if self._revision_history_cache is not None:
410
history = self._revision_history_cache
412
history = self._gen_revision_history()
413
self._cache_revision_history(history)
417
"""Return current revision number for this branch.
419
That is equivalent to the number of revisions committed to
422
return self.last_revision_info()[0]
425
"""Older format branches cannot bind or unbind."""
426
raise errors.UpgradeRequired(self.base)
428
def set_append_revisions_only(self, enabled):
429
"""Older format branches are never restricted to append-only"""
430
raise errors.UpgradeRequired(self.base)
432
def last_revision(self):
433
"""Return last revision id, or NULL_REVISION."""
434
return self.last_revision_info()[1]
437
def last_revision_info(self):
438
"""Return information about the last revision.
440
:return: A tuple (revno, revision_id).
442
if self._last_revision_info_cache is None:
443
self._last_revision_info_cache = self._last_revision_info()
444
return self._last_revision_info_cache
446
def _last_revision_info(self):
447
rh = self.revision_history()
450
return (revno, rh[-1])
452
return (0, _mod_revision.NULL_REVISION)
454
@deprecated_method(deprecated_in((1, 6, 0)))
455
def missing_revisions(self, other, stop_revision=None):
456
"""Return a list of new revisions that would perfectly fit.
458
If self and other have not diverged, return a list of the revisions
459
present in other, but missing from self.
461
self_history = self.revision_history()
462
self_len = len(self_history)
463
other_history = other.revision_history()
464
other_len = len(other_history)
465
common_index = min(self_len, other_len) -1
466
if common_index >= 0 and \
467
self_history[common_index] != other_history[common_index]:
468
raise errors.DivergedBranches(self, other)
470
if stop_revision is None:
471
stop_revision = other_len
473
if stop_revision > other_len:
474
raise errors.NoSuchRevision(self, stop_revision)
475
return other_history[self_len:stop_revision]
478
def update_revisions(self, other, stop_revision=None, overwrite=False,
480
"""Pull in new perfect-fit revisions.
482
:param other: Another Branch to pull from
483
:param stop_revision: Updated until the given revision
484
:param overwrite: Always set the branch pointer, rather than checking
485
to see if it is a proper descendant.
486
:param graph: A Graph object that can be used to query history
487
information. This can be None.
492
other_revno, other_last_revision = other.last_revision_info()
493
stop_revno = None # unknown
494
if stop_revision is None:
495
stop_revision = other_last_revision
496
if _mod_revision.is_null(stop_revision):
497
# if there are no commits, we're done.
499
stop_revno = other_revno
501
# what's the current last revision, before we fetch [and change it
503
last_rev = _mod_revision.ensure_null(self.last_revision())
504
# we fetch here so that we don't process data twice in the common
505
# case of having something to pull, and so that the check for
506
# already merged can operate on the just fetched graph, which will
507
# be cached in memory.
508
self.fetch(other, stop_revision)
509
# Check to see if one is an ancestor of the other
512
graph = self.repository.get_graph()
513
if self._check_if_descendant_or_diverged(
514
stop_revision, last_rev, graph, other):
515
# stop_revision is a descendant of last_rev, but we aren't
516
# overwriting, so we're done.
518
if stop_revno is None:
520
graph = self.repository.get_graph()
521
this_revno, this_last_revision = self.last_revision_info()
522
stop_revno = graph.find_distance_to_null(stop_revision,
523
[(other_last_revision, other_revno),
524
(this_last_revision, this_revno)])
525
self.set_last_revision_info(stop_revno, stop_revision)
529
def revision_id_to_revno(self, revision_id):
530
"""Given a revision id, return its revno"""
531
if _mod_revision.is_null(revision_id):
533
history = self.revision_history()
535
return history.index(revision_id) + 1
537
raise errors.NoSuchRevision(self, revision_id)
539
def get_rev_id(self, revno, history=None):
540
"""Find the revision id of the specified revno."""
542
return _mod_revision.NULL_REVISION
544
history = self.revision_history()
545
if revno <= 0 or revno > len(history):
546
raise errors.NoSuchRevision(self, revno)
547
return history[revno - 1]
549
def pull(self, source, overwrite=False, stop_revision=None,
550
possible_transports=None, _override_hook_target=None):
551
"""Mirror source into this branch.
553
This branch is considered to be 'local', having low latency.
555
:returns: PullResult instance
557
raise NotImplementedError(self.pull)
559
def push(self, target, overwrite=False, stop_revision=None):
560
"""Mirror this branch into target.
562
This branch is considered to be 'local', having low latency.
564
raise NotImplementedError(self.push)
566
def basis_tree(self):
567
"""Return `Tree` object for last revision."""
568
return self.repository.revision_tree(self.last_revision())
570
def get_parent(self):
571
"""Return the parent location of the branch.
573
This is the default location for push/pull/missing. The usual
574
pattern is that the user can override it by specifying a
577
raise NotImplementedError(self.get_parent)
579
def _set_config_location(self, name, url, config=None,
580
make_relative=False):
582
config = self.get_config()
586
url = urlutils.relative_url(self.base, url)
587
config.set_user_option(name, url, warn_masked=True)
589
def _get_config_location(self, name, config=None):
591
config = self.get_config()
592
location = config.get_user_option(name)
597
def get_submit_branch(self):
598
"""Return the submit location of the branch.
600
This is the default location for bundle. The usual
601
pattern is that the user can override it by specifying a
604
return self.get_config().get_user_option('submit_branch')
606
def set_submit_branch(self, location):
607
"""Return the submit location of the branch.
609
This is the default location for bundle. The usual
610
pattern is that the user can override it by specifying a
613
self.get_config().set_user_option('submit_branch', location,
616
def get_public_branch(self):
617
"""Return the public location of the branch.
619
This is is used by merge directives.
621
return self._get_config_location('public_branch')
623
def set_public_branch(self, location):
624
"""Return the submit location of the branch.
626
This is the default location for bundle. The usual
627
pattern is that the user can override it by specifying a
630
self._set_config_location('public_branch', location)
632
def get_push_location(self):
633
"""Return the None or the location to push this branch to."""
634
push_loc = self.get_config().get_user_option('push_location')
637
def set_push_location(self, location):
638
"""Set a new push location for this branch."""
639
raise NotImplementedError(self.set_push_location)
641
def set_parent(self, url):
642
raise NotImplementedError(self.set_parent)
646
"""Synchronise this branch with the master branch if any.
648
:return: None or the last_revision pivoted out during the update.
652
def check_revno(self, revno):
654
Check whether a revno corresponds to any revision.
655
Zero (the NULL revision) is considered valid.
658
self.check_real_revno(revno)
660
def check_real_revno(self, revno):
662
Check whether a revno corresponds to a real revision.
663
Zero (the NULL revision) is considered invalid
665
if revno < 1 or revno > self.revno():
666
raise errors.InvalidRevisionNumber(revno)
669
def clone(self, to_bzrdir, revision_id=None):
670
"""Clone this branch into to_bzrdir preserving all semantic values.
672
revision_id: if not None, the revision history in the new branch will
673
be truncated to end with revision_id.
675
result = self._format.initialize(to_bzrdir)
676
self.copy_content_into(result, revision_id=revision_id)
680
def sprout(self, to_bzrdir, revision_id=None):
681
"""Create a new line of development from the branch, into to_bzrdir.
683
revision_id: if not None, the revision history in the new branch will
684
be truncated to end with revision_id.
686
result = self._format.initialize(to_bzrdir)
687
self.copy_content_into(result, revision_id=revision_id)
688
result.set_parent(self.bzrdir.root_transport.base)
691
def _synchronize_history(self, destination, revision_id):
692
"""Synchronize last revision and revision history between branches.
694
This version is most efficient when the destination is also a
695
BzrBranch5, but works for BzrBranch6 as long as the revision
696
history is the true lefthand parent history, and all of the revisions
697
are in the destination's repository. If not, set_revision_history
700
:param destination: The branch to copy the history into
701
:param revision_id: The revision-id to truncate history at. May
702
be None to copy complete history.
704
if revision_id == _mod_revision.NULL_REVISION:
706
new_history = self.revision_history()
707
if revision_id is not None and new_history != []:
709
new_history = new_history[:new_history.index(revision_id) + 1]
711
rev = self.repository.get_revision(revision_id)
712
new_history = rev.get_history(self.repository)[1:]
713
destination.set_revision_history(new_history)
716
def copy_content_into(self, destination, revision_id=None):
717
"""Copy the content of self into destination.
719
revision_id: if not None, the revision history in the new branch will
720
be truncated to end with revision_id.
722
self._synchronize_history(destination, revision_id)
724
parent = self.get_parent()
725
except errors.InaccessibleParent, e:
726
mutter('parent was not accessible to copy: %s', e)
729
destination.set_parent(parent)
730
self.tags.merge_to(destination.tags)
734
"""Check consistency of the branch.
736
In particular this checks that revisions given in the revision-history
737
do actually match up in the revision graph, and that they're all
738
present in the repository.
740
Callers will typically also want to check the repository.
742
:return: A BranchCheckResult.
744
mainline_parent_id = None
745
last_revno, last_revision_id = self.last_revision_info()
746
real_rev_history = list(self.repository.iter_reverse_revision_history(
748
real_rev_history.reverse()
749
if len(real_rev_history) != last_revno:
750
raise errors.BzrCheckError('revno does not match len(mainline)'
751
' %s != %s' % (last_revno, len(real_rev_history)))
752
# TODO: We should probably also check that real_rev_history actually
753
# matches self.revision_history()
754
for revision_id in real_rev_history:
756
revision = self.repository.get_revision(revision_id)
757
except errors.NoSuchRevision, e:
758
raise errors.BzrCheckError("mainline revision {%s} not in repository"
760
# In general the first entry on the revision history has no parents.
761
# But it's not illegal for it to have parents listed; this can happen
762
# in imports from Arch when the parents weren't reachable.
763
if mainline_parent_id is not None:
764
if mainline_parent_id not in revision.parent_ids:
765
raise errors.BzrCheckError("previous revision {%s} not listed among "
767
% (mainline_parent_id, revision_id))
768
mainline_parent_id = revision_id
769
return BranchCheckResult(self)
771
def _get_checkout_format(self):
772
"""Return the most suitable metadir for a checkout of this branch.
773
Weaves are used if this branch's repository uses weaves.
775
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
776
from bzrlib.repofmt import weaverepo
777
format = bzrdir.BzrDirMetaFormat1()
778
format.repository_format = weaverepo.RepositoryFormat7()
780
format = self.repository.bzrdir.checkout_metadir()
781
format.set_branch_format(self._format)
784
def create_checkout(self, to_location, revision_id=None,
785
lightweight=False, accelerator_tree=None,
787
"""Create a checkout of a branch.
789
:param to_location: The url to produce the checkout at
790
:param revision_id: The revision to check out
791
:param lightweight: If True, produce a lightweight checkout, otherwise,
792
produce a bound branch (heavyweight checkout)
793
:param accelerator_tree: A tree which can be used for retrieving file
794
contents more quickly than the revision tree, i.e. a workingtree.
795
The revision tree will be used for cases where accelerator_tree's
796
content is different.
797
:param hardlink: If true, hard-link files from accelerator_tree,
799
:return: The tree of the created checkout
801
t = transport.get_transport(to_location)
804
format = self._get_checkout_format()
805
checkout = format.initialize_on_transport(t)
806
from_branch = BranchReferenceFormat().initialize(checkout, self)
808
format = self._get_checkout_format()
809
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
810
to_location, force_new_tree=False, format=format)
811
checkout = checkout_branch.bzrdir
812
checkout_branch.bind(self)
813
# pull up to the specified revision_id to set the initial
814
# branch tip correctly, and seed it with history.
815
checkout_branch.pull(self, stop_revision=revision_id)
817
tree = checkout.create_workingtree(revision_id,
818
from_branch=from_branch,
819
accelerator_tree=accelerator_tree,
821
basis_tree = tree.basis_tree()
822
basis_tree.lock_read()
824
for path, file_id in basis_tree.iter_references():
825
reference_parent = self.reference_parent(file_id, path)
826
reference_parent.create_checkout(tree.abspath(path),
827
basis_tree.get_reference_revision(file_id, path),
834
def reconcile(self, thorough=True):
835
"""Make sure the data stored in this branch is consistent."""
836
from bzrlib.reconcile import BranchReconciler
837
reconciler = BranchReconciler(self, thorough=thorough)
838
reconciler.reconcile()
841
def reference_parent(self, file_id, path):
842
"""Return the parent branch for a tree-reference file_id
843
:param file_id: The file_id of the tree reference
844
:param path: The path of the file_id in the tree
845
:return: A branch associated with the file_id
847
# FIXME should provide multiple branches, based on config
848
return Branch.open(self.bzrdir.root_transport.clone(path).base)
850
def supports_tags(self):
851
return self._format.supports_tags()
853
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
855
"""Ensure that revision_b is a descendant of revision_a.
857
This is a helper function for update_revisions.
859
:raises: DivergedBranches if revision_b has diverged from revision_a.
860
:returns: True if revision_b is a descendant of revision_a.
862
relation = self._revision_relations(revision_a, revision_b, graph)
863
if relation == 'b_descends_from_a':
865
elif relation == 'diverged':
866
raise errors.DivergedBranches(self, other_branch)
867
elif relation == 'a_descends_from_b':
870
raise AssertionError("invalid relation: %r" % (relation,))
872
def _revision_relations(self, revision_a, revision_b, graph):
873
"""Determine the relationship between two revisions.
875
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
877
heads = graph.heads([revision_a, revision_b])
878
if heads == set([revision_b]):
879
return 'b_descends_from_a'
880
elif heads == set([revision_a, revision_b]):
881
# These branches have diverged
883
elif heads == set([revision_a]):
884
return 'a_descends_from_b'
886
raise AssertionError("invalid heads: %r" % (heads,))
889
class BranchFormat(object):
890
"""An encapsulation of the initialization and open routines for a format.
892
Formats provide three things:
893
* An initialization routine,
897
Formats are placed in an dict by their format string for reference
898
during branch opening. Its not required that these be instances, they
899
can be classes themselves with class methods - it simply depends on
900
whether state is needed for a given format or not.
902
Once a format is deprecated, just deprecate the initialize and open
903
methods on the format class. Do not deprecate the object, as the
904
object will be created every time regardless.
907
_default_format = None
908
"""The default format used for new branches."""
911
"""The known formats."""
913
def __eq__(self, other):
914
return self.__class__ is other.__class__
916
def __ne__(self, other):
917
return not (self == other)
920
def find_format(klass, a_bzrdir):
921
"""Return the format for the branch object in a_bzrdir."""
923
transport = a_bzrdir.get_branch_transport(None)
924
format_string = transport.get("format").read()
925
return klass._formats[format_string]
926
except errors.NoSuchFile:
927
raise errors.NotBranchError(path=transport.base)
929
raise errors.UnknownFormatError(format=format_string, kind='branch')
932
def get_default_format(klass):
933
"""Return the current default format."""
934
return klass._default_format
936
def get_reference(self, a_bzrdir):
937
"""Get the target reference of the branch in a_bzrdir.
939
format probing must have been completed before calling
940
this method - it is assumed that the format of the branch
941
in a_bzrdir is correct.
943
:param a_bzrdir: The bzrdir to get the branch data from.
944
:return: None if the branch is not a reference branch.
949
def set_reference(self, a_bzrdir, to_branch):
950
"""Set the target reference of the branch in a_bzrdir.
952
format probing must have been completed before calling
953
this method - it is assumed that the format of the branch
954
in a_bzrdir is correct.
956
:param a_bzrdir: The bzrdir to set the branch reference for.
957
:param to_branch: branch that the checkout is to reference
959
raise NotImplementedError(self.set_reference)
961
def get_format_string(self):
962
"""Return the ASCII format string that identifies this format."""
963
raise NotImplementedError(self.get_format_string)
965
def get_format_description(self):
966
"""Return the short format description for this format."""
967
raise NotImplementedError(self.get_format_description)
969
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
971
"""Initialize a branch in a bzrdir, with specified files
973
:param a_bzrdir: The bzrdir to initialize the branch in
974
:param utf8_files: The files to create as a list of
975
(filename, content) tuples
976
:param set_format: If True, set the format with
977
self.get_format_string. (BzrBranch4 has its format set
979
:return: a branch in this format
981
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
982
branch_transport = a_bzrdir.get_branch_transport(self)
984
'metadir': ('lock', lockdir.LockDir),
985
'branch4': ('branch-lock', lockable_files.TransportLock),
987
lock_name, lock_class = lock_map[lock_type]
988
control_files = lockable_files.LockableFiles(branch_transport,
989
lock_name, lock_class)
990
control_files.create_lock()
991
control_files.lock_write()
993
utf8_files += [('format', self.get_format_string())]
995
for (filename, content) in utf8_files:
996
branch_transport.put_bytes(
998
mode=a_bzrdir._get_file_mode())
1000
control_files.unlock()
1001
return self.open(a_bzrdir, _found=True)
1003
def initialize(self, a_bzrdir):
1004
"""Create a branch of this format in a_bzrdir."""
1005
raise NotImplementedError(self.initialize)
1007
def is_supported(self):
1008
"""Is this format supported?
1010
Supported formats can be initialized and opened.
1011
Unsupported formats may not support initialization or committing or
1012
some other features depending on the reason for not being supported.
1016
def open(self, a_bzrdir, _found=False):
1017
"""Return the branch object for a_bzrdir
1019
_found is a private parameter, do not use it. It is used to indicate
1020
if format probing has already be done.
1022
raise NotImplementedError(self.open)
1025
def register_format(klass, format):
1026
klass._formats[format.get_format_string()] = format
1029
def set_default_format(klass, format):
1030
klass._default_format = format
1032
def supports_stacking(self):
1033
"""True if this format records a stacked-on branch."""
1037
def unregister_format(klass, format):
1038
del klass._formats[format.get_format_string()]
1041
return self.get_format_string().rstrip()
1043
def supports_tags(self):
1044
"""True if this format supports tags stored in the branch"""
1045
return False # by default
1048
class BranchHooks(Hooks):
1049
"""A dictionary mapping hook name to a list of callables for branch hooks.
1051
e.g. ['set_rh'] Is the list of items to be called when the
1052
set_revision_history function is invoked.
1056
"""Create the default hooks.
1058
These are all empty initially, because by default nothing should get
1061
Hooks.__init__(self)
1062
# Introduced in 0.15:
1063
# invoked whenever the revision history has been set
1064
# with set_revision_history. The api signature is
1065
# (branch, revision_history), and the branch will
1068
# invoked after a push operation completes.
1069
# the api signature is
1071
# containing the members
1072
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1073
# where local is the local target branch or None, master is the target
1074
# master branch, and the rest should be self explanatory. The source
1075
# is read locked and the target branches write locked. Source will
1076
# be the local low-latency branch.
1077
self['post_push'] = []
1078
# invoked after a pull operation completes.
1079
# the api signature is
1081
# containing the members
1082
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1083
# where local is the local branch or None, master is the target
1084
# master branch, and the rest should be self explanatory. The source
1085
# is read locked and the target branches write locked. The local
1086
# branch is the low-latency branch.
1087
self['post_pull'] = []
1088
# invoked before a commit operation takes place.
1089
# the api signature is
1090
# (local, master, old_revno, old_revid, future_revno, future_revid,
1091
# tree_delta, future_tree).
1092
# old_revid is NULL_REVISION for the first commit to a branch
1093
# tree_delta is a TreeDelta object describing changes from the basis
1094
# revision, hooks MUST NOT modify this delta
1095
# future_tree is an in-memory tree obtained from
1096
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1097
self['pre_commit'] = []
1098
# invoked after a commit operation completes.
1099
# the api signature is
1100
# (local, master, old_revno, old_revid, new_revno, new_revid)
1101
# old_revid is NULL_REVISION for the first commit to a branch.
1102
self['post_commit'] = []
1103
# invoked after a uncommit operation completes.
1104
# the api signature is
1105
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1106
# local is the local branch or None, master is the target branch,
1107
# and an empty branch recieves new_revno of 0, new_revid of None.
1108
self['post_uncommit'] = []
1110
# Invoked before the tip of a branch changes.
1111
# the api signature is
1112
# (params) where params is a ChangeBranchTipParams with the members
1113
# (branch, old_revno, new_revno, old_revid, new_revid)
1114
self['pre_change_branch_tip'] = []
1116
# Invoked after the tip of a branch changes.
1117
# the api signature is
1118
# (params) where params is a ChangeBranchTipParams with the members
1119
# (branch, old_revno, new_revno, old_revid, new_revid)
1120
self['post_change_branch_tip'] = []
1123
# install the default hooks into the Branch class.
1124
Branch.hooks = BranchHooks()
1127
class ChangeBranchTipParams(object):
1128
"""Object holding parameters passed to *_change_branch_tip hooks.
1130
There are 5 fields that hooks may wish to access:
1132
:ivar branch: the branch being changed
1133
:ivar old_revno: revision number before the change
1134
:ivar new_revno: revision number after the change
1135
:ivar old_revid: revision id before the change
1136
:ivar new_revid: revision id after the change
1138
The revid fields are strings. The revno fields are integers.
1141
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1142
"""Create a group of ChangeBranchTip parameters.
1144
:param branch: The branch being changed.
1145
:param old_revno: Revision number before the change.
1146
:param new_revno: Revision number after the change.
1147
:param old_revid: Tip revision id before the change.
1148
:param new_revid: Tip revision id after the change.
1150
self.branch = branch
1151
self.old_revno = old_revno
1152
self.new_revno = new_revno
1153
self.old_revid = old_revid
1154
self.new_revid = new_revid
1156
def __eq__(self, other):
1157
return self.__dict__ == other.__dict__
1160
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1161
self.__class__.__name__, self.branch,
1162
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1165
class BzrBranchFormat4(BranchFormat):
1166
"""Bzr branch format 4.
1169
- a revision-history file.
1170
- a branch-lock lock file [ to be shared with the bzrdir ]
1173
def get_format_description(self):
1174
"""See BranchFormat.get_format_description()."""
1175
return "Branch format 4"
1177
def initialize(self, a_bzrdir):
1178
"""Create a branch of this format in a_bzrdir."""
1179
utf8_files = [('revision-history', ''),
1180
('branch-name', ''),
1182
return self._initialize_helper(a_bzrdir, utf8_files,
1183
lock_type='branch4', set_format=False)
1186
super(BzrBranchFormat4, self).__init__()
1187
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1189
def open(self, a_bzrdir, _found=False):
1190
"""Return the branch object for a_bzrdir
1192
_found is a private parameter, do not use it. It is used to indicate
1193
if format probing has already be done.
1196
# we are being called directly and must probe.
1197
raise NotImplementedError
1198
return BzrBranch(_format=self,
1199
_control_files=a_bzrdir._control_files,
1201
_repository=a_bzrdir.open_repository())
1204
return "Bazaar-NG branch format 4"
1207
class BranchFormatMetadir(BranchFormat):
1208
"""Common logic for meta-dir based branch formats."""
1210
def _branch_class(self):
1211
"""What class to instantiate on open calls."""
1212
raise NotImplementedError(self._branch_class)
1214
def open(self, a_bzrdir, _found=False):
1215
"""Return the branch object for a_bzrdir.
1217
_found is a private parameter, do not use it. It is used to indicate
1218
if format probing has already be done.
1221
format = BranchFormat.find_format(a_bzrdir)
1222
if format.__class__ != self.__class__:
1223
raise AssertionError("wrong format %r found for %r" %
1226
transport = a_bzrdir.get_branch_transport(None)
1227
control_files = lockable_files.LockableFiles(transport, 'lock',
1229
return self._branch_class()(_format=self,
1230
_control_files=control_files,
1232
_repository=a_bzrdir.find_repository())
1233
except errors.NoSuchFile:
1234
raise errors.NotBranchError(path=transport.base)
1237
super(BranchFormatMetadir, self).__init__()
1238
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1240
def supports_tags(self):
1244
class BzrBranchFormat5(BranchFormatMetadir):
1245
"""Bzr branch format 5.
1248
- a revision-history file.
1250
- a lock dir guarding the branch itself
1251
- all of this stored in a branch/ subdirectory
1252
- works with shared repositories.
1254
This format is new in bzr 0.8.
1257
def _branch_class(self):
1260
def get_format_string(self):
1261
"""See BranchFormat.get_format_string()."""
1262
return "Bazaar-NG branch format 5\n"
1264
def get_format_description(self):
1265
"""See BranchFormat.get_format_description()."""
1266
return "Branch format 5"
1268
def initialize(self, a_bzrdir):
1269
"""Create a branch of this format in a_bzrdir."""
1270
utf8_files = [('revision-history', ''),
1271
('branch-name', ''),
1273
return self._initialize_helper(a_bzrdir, utf8_files)
1275
def supports_tags(self):
1279
class BzrBranchFormat6(BranchFormatMetadir):
1280
"""Branch format with last-revision and tags.
1282
Unlike previous formats, this has no explicit revision history. Instead,
1283
this just stores the last-revision, and the left-hand history leading
1284
up to there is the history.
1286
This format was introduced in bzr 0.15
1287
and became the default in 0.91.
1290
def _branch_class(self):
1293
def get_format_string(self):
1294
"""See BranchFormat.get_format_string()."""
1295
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1297
def get_format_description(self):
1298
"""See BranchFormat.get_format_description()."""
1299
return "Branch format 6"
1301
def initialize(self, a_bzrdir):
1302
"""Create a branch of this format in a_bzrdir."""
1303
utf8_files = [('last-revision', '0 null:\n'),
1304
('branch.conf', ''),
1307
return self._initialize_helper(a_bzrdir, utf8_files)
1310
class BzrBranchFormat7(BranchFormatMetadir):
1311
"""Branch format with last-revision, tags, and a stacked location pointer.
1313
The stacked location pointer is passed down to the repository and requires
1314
a repository format with supports_external_lookups = True.
1316
This format was introduced in bzr 1.6.
1319
def _branch_class(self):
1322
def get_format_string(self):
1323
"""See BranchFormat.get_format_string()."""
1324
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1326
def get_format_description(self):
1327
"""See BranchFormat.get_format_description()."""
1328
return "Branch format 7"
1330
def initialize(self, a_bzrdir):
1331
"""Create a branch of this format in a_bzrdir."""
1332
utf8_files = [('last-revision', '0 null:\n'),
1333
('branch.conf', ''),
1336
return self._initialize_helper(a_bzrdir, utf8_files)
1339
super(BzrBranchFormat7, self).__init__()
1340
self._matchingbzrdir.repository_format = \
1341
RepositoryFormatPackDevelopment1Subtree()
1343
def supports_stacking(self):
1347
class BranchReferenceFormat(BranchFormat):
1348
"""Bzr branch reference format.
1350
Branch references are used in implementing checkouts, they
1351
act as an alias to the real branch which is at some other url.
1358
def get_format_string(self):
1359
"""See BranchFormat.get_format_string()."""
1360
return "Bazaar-NG Branch Reference Format 1\n"
1362
def get_format_description(self):
1363
"""See BranchFormat.get_format_description()."""
1364
return "Checkout reference format 1"
1366
def get_reference(self, a_bzrdir):
1367
"""See BranchFormat.get_reference()."""
1368
transport = a_bzrdir.get_branch_transport(None)
1369
return transport.get('location').read()
1371
def set_reference(self, a_bzrdir, to_branch):
1372
"""See BranchFormat.set_reference()."""
1373
transport = a_bzrdir.get_branch_transport(None)
1374
location = transport.put_bytes('location', to_branch.base)
1376
def initialize(self, a_bzrdir, target_branch=None):
1377
"""Create a branch of this format in a_bzrdir."""
1378
if target_branch is None:
1379
# this format does not implement branch itself, thus the implicit
1380
# creation contract must see it as uninitializable
1381
raise errors.UninitializableFormat(self)
1382
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1383
branch_transport = a_bzrdir.get_branch_transport(self)
1384
branch_transport.put_bytes('location',
1385
target_branch.bzrdir.root_transport.base)
1386
branch_transport.put_bytes('format', self.get_format_string())
1388
a_bzrdir, _found=True,
1389
possible_transports=[target_branch.bzrdir.root_transport])
1392
super(BranchReferenceFormat, self).__init__()
1393
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1395
def _make_reference_clone_function(format, a_branch):
1396
"""Create a clone() routine for a branch dynamically."""
1397
def clone(to_bzrdir, revision_id=None):
1398
"""See Branch.clone()."""
1399
return format.initialize(to_bzrdir, a_branch)
1400
# cannot obey revision_id limits when cloning a reference ...
1401
# FIXME RBC 20060210 either nuke revision_id for clone, or
1402
# emit some sort of warning/error to the caller ?!
1405
def open(self, a_bzrdir, _found=False, location=None,
1406
possible_transports=None):
1407
"""Return the branch that the branch reference in a_bzrdir points at.
1409
_found is a private parameter, do not use it. It is used to indicate
1410
if format probing has already be done.
1413
format = BranchFormat.find_format(a_bzrdir)
1414
if format.__class__ != self.__class__:
1415
raise AssertionError("wrong format %r found for %r" %
1417
if location is None:
1418
location = self.get_reference(a_bzrdir)
1419
real_bzrdir = bzrdir.BzrDir.open(
1420
location, possible_transports=possible_transports)
1421
result = real_bzrdir.open_branch()
1422
# this changes the behaviour of result.clone to create a new reference
1423
# rather than a copy of the content of the branch.
1424
# I did not use a proxy object because that needs much more extensive
1425
# testing, and we are only changing one behaviour at the moment.
1426
# If we decide to alter more behaviours - i.e. the implicit nickname
1427
# then this should be refactored to introduce a tested proxy branch
1428
# and a subclass of that for use in overriding clone() and ....
1430
result.clone = self._make_reference_clone_function(result)
1434
# formats which have no format string are not discoverable
1435
# and not independently creatable, so are not registered.
1436
__format5 = BzrBranchFormat5()
1437
__format6 = BzrBranchFormat6()
1438
__format7 = BzrBranchFormat7()
1439
BranchFormat.register_format(__format5)
1440
BranchFormat.register_format(BranchReferenceFormat())
1441
BranchFormat.register_format(__format6)
1442
BranchFormat.register_format(__format7)
1443
BranchFormat.set_default_format(__format6)
1444
_legacy_formats = [BzrBranchFormat4(),
1447
class BzrBranch(Branch):
1448
"""A branch stored in the actual filesystem.
1450
Note that it's "local" in the context of the filesystem; it doesn't
1451
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1452
it's writable, and can be accessed via the normal filesystem API.
1454
:ivar _transport: Transport for file operations on this branch's
1455
control files, typically pointing to the .bzr/branch directory.
1456
:ivar repository: Repository for this branch.
1457
:ivar base: The url of the base directory for this branch; the one
1458
containing the .bzr directory.
1461
def __init__(self, _format=None,
1462
_control_files=None, a_bzrdir=None, _repository=None):
1463
"""Create new branch object at a particular location."""
1464
if a_bzrdir is None:
1465
raise ValueError('a_bzrdir must be supplied')
1467
self.bzrdir = a_bzrdir
1468
self._base = self.bzrdir.transport.clone('..').base
1469
# XXX: We should be able to just do
1470
# self.base = self.bzrdir.root_transport.base
1471
# but this does not quite work yet -- mbp 20080522
1472
self._format = _format
1473
if _control_files is None:
1474
raise ValueError('BzrBranch _control_files is None')
1475
self.control_files = _control_files
1476
self._transport = _control_files._transport
1477
self.repository = _repository
1478
Branch.__init__(self)
1481
return '%s(%r)' % (self.__class__.__name__, self.base)
1485
def _get_base(self):
1486
"""Returns the directory containing the control directory."""
1489
base = property(_get_base, doc="The URL for the root of this branch.")
1491
def is_locked(self):
1492
return self.control_files.is_locked()
1494
def lock_write(self, token=None):
1495
repo_token = self.repository.lock_write()
1497
token = self.control_files.lock_write(token=token)
1499
self.repository.unlock()
1503
def lock_read(self):
1504
self.repository.lock_read()
1506
self.control_files.lock_read()
1508
self.repository.unlock()
1512
# TODO: test for failed two phase locks. This is known broken.
1514
self.control_files.unlock()
1516
self.repository.unlock()
1517
if not self.control_files.is_locked():
1518
# we just released the lock
1519
self._clear_cached_state()
1521
def peek_lock_mode(self):
1522
if self.control_files._lock_count == 0:
1525
return self.control_files._lock_mode
1527
def get_physical_lock_status(self):
1528
return self.control_files.get_physical_lock_status()
1531
def print_file(self, file, revision_id):
1532
"""See Branch.print_file."""
1533
return self.repository.print_file(file, revision_id)
1535
def _write_revision_history(self, history):
1536
"""Factored out of set_revision_history.
1538
This performs the actual writing to disk.
1539
It is intended to be called by BzrBranch5.set_revision_history."""
1540
self._transport.put_bytes(
1541
'revision-history', '\n'.join(history),
1542
mode=self.bzrdir._get_file_mode())
1545
def set_revision_history(self, rev_history):
1546
"""See Branch.set_revision_history."""
1547
if 'evil' in debug.debug_flags:
1548
mutter_callsite(3, "set_revision_history scales with history.")
1549
check_not_reserved_id = _mod_revision.check_not_reserved_id
1550
for rev_id in rev_history:
1551
check_not_reserved_id(rev_id)
1552
if Branch.hooks['post_change_branch_tip']:
1553
# Don't calculate the last_revision_info() if there are no hooks
1555
old_revno, old_revid = self.last_revision_info()
1556
if len(rev_history) == 0:
1557
revid = _mod_revision.NULL_REVISION
1559
revid = rev_history[-1]
1560
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1561
self._write_revision_history(rev_history)
1562
self._clear_cached_state()
1563
self._cache_revision_history(rev_history)
1564
for hook in Branch.hooks['set_rh']:
1565
hook(self, rev_history)
1566
if Branch.hooks['post_change_branch_tip']:
1567
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1569
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1570
"""Run the pre_change_branch_tip hooks."""
1571
hooks = Branch.hooks['pre_change_branch_tip']
1574
old_revno, old_revid = self.last_revision_info()
1575
params = ChangeBranchTipParams(
1576
self, old_revno, new_revno, old_revid, new_revid)
1580
except errors.TipChangeRejected:
1583
exc_info = sys.exc_info()
1584
hook_name = Branch.hooks.get_hook_name(hook)
1585
raise errors.HookFailed(
1586
'pre_change_branch_tip', hook_name, exc_info)
1588
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1589
"""Run the post_change_branch_tip hooks."""
1590
hooks = Branch.hooks['post_change_branch_tip']
1593
new_revno, new_revid = self.last_revision_info()
1594
params = ChangeBranchTipParams(
1595
self, old_revno, new_revno, old_revid, new_revid)
1600
def set_last_revision_info(self, revno, revision_id):
1601
"""Set the last revision of this branch.
1603
The caller is responsible for checking that the revno is correct
1604
for this revision id.
1606
It may be possible to set the branch last revision to an id not
1607
present in the repository. However, branches can also be
1608
configured to check constraints on history, in which case this may not
1611
revision_id = _mod_revision.ensure_null(revision_id)
1612
# this old format stores the full history, but this api doesn't
1613
# provide it, so we must generate, and might as well check it's
1615
history = self._lefthand_history(revision_id)
1616
if len(history) != revno:
1617
raise AssertionError('%d != %d' % (len(history), revno))
1618
self.set_revision_history(history)
1620
def _gen_revision_history(self):
1621
history = self._transport.get_bytes('revision-history').split('\n')
1622
if history[-1:] == ['']:
1623
# There shouldn't be a trailing newline, but just in case.
1627
def _lefthand_history(self, revision_id, last_rev=None,
1629
if 'evil' in debug.debug_flags:
1630
mutter_callsite(4, "_lefthand_history scales with history.")
1631
# stop_revision must be a descendant of last_revision
1632
graph = self.repository.get_graph()
1633
if last_rev is not None:
1634
if not graph.is_ancestor(last_rev, revision_id):
1635
# our previous tip is not merged into stop_revision
1636
raise errors.DivergedBranches(self, other_branch)
1637
# make a new revision history from the graph
1638
parents_map = graph.get_parent_map([revision_id])
1639
if revision_id not in parents_map:
1640
raise errors.NoSuchRevision(self, revision_id)
1641
current_rev_id = revision_id
1643
check_not_reserved_id = _mod_revision.check_not_reserved_id
1644
# Do not include ghosts or graph origin in revision_history
1645
while (current_rev_id in parents_map and
1646
len(parents_map[current_rev_id]) > 0):
1647
check_not_reserved_id(current_rev_id)
1648
new_history.append(current_rev_id)
1649
current_rev_id = parents_map[current_rev_id][0]
1650
parents_map = graph.get_parent_map([current_rev_id])
1651
new_history.reverse()
1655
def generate_revision_history(self, revision_id, last_rev=None,
1657
"""Create a new revision history that will finish with revision_id.
1659
:param revision_id: the new tip to use.
1660
:param last_rev: The previous last_revision. If not None, then this
1661
must be a ancestory of revision_id, or DivergedBranches is raised.
1662
:param other_branch: The other branch that DivergedBranches should
1663
raise with respect to.
1665
self.set_revision_history(self._lefthand_history(revision_id,
1666
last_rev, other_branch))
1668
def basis_tree(self):
1669
"""See Branch.basis_tree."""
1670
return self.repository.revision_tree(self.last_revision())
1673
def pull(self, source, overwrite=False, stop_revision=None,
1674
_hook_master=None, run_hooks=True, possible_transports=None,
1675
_override_hook_target=None):
1678
:param _hook_master: Private parameter - set the branch to
1679
be supplied as the master to pull hooks.
1680
:param run_hooks: Private parameter - if false, this branch
1681
is being called because it's the master of the primary branch,
1682
so it should not run its hooks.
1683
:param _override_hook_target: Private parameter - set the branch to be
1684
supplied as the target_branch to pull hooks.
1686
result = PullResult()
1687
result.source_branch = source
1688
if _override_hook_target is None:
1689
result.target_branch = self
1691
result.target_branch = _override_hook_target
1694
# We assume that during 'pull' the local repository is closer than
1696
graph = self.repository.get_graph(source.repository)
1697
result.old_revno, result.old_revid = self.last_revision_info()
1698
self.update_revisions(source, stop_revision, overwrite=overwrite,
1700
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1701
result.new_revno, result.new_revid = self.last_revision_info()
1703
result.master_branch = _hook_master
1704
result.local_branch = result.target_branch
1706
result.master_branch = result.target_branch
1707
result.local_branch = None
1709
for hook in Branch.hooks['post_pull']:
1715
def _get_parent_location(self):
1716
_locs = ['parent', 'pull', 'x-pull']
1719
return self._transport.get_bytes(l).strip('\n')
1720
except errors.NoSuchFile:
1725
def push(self, target, overwrite=False, stop_revision=None,
1726
_override_hook_source_branch=None):
1729
This is the basic concrete implementation of push()
1731
:param _override_hook_source_branch: If specified, run
1732
the hooks passing this Branch as the source, rather than self.
1733
This is for use of RemoteBranch, where push is delegated to the
1734
underlying vfs-based Branch.
1736
# TODO: Public option to disable running hooks - should be trivial but
1740
result = self._push_with_bound_branches(target, overwrite,
1742
_override_hook_source_branch=_override_hook_source_branch)
1747
def _push_with_bound_branches(self, target, overwrite,
1749
_override_hook_source_branch=None):
1750
"""Push from self into target, and into target's master if any.
1752
This is on the base BzrBranch class even though it doesn't support
1753
bound branches because the *target* might be bound.
1756
if _override_hook_source_branch:
1757
result.source_branch = _override_hook_source_branch
1758
for hook in Branch.hooks['post_push']:
1761
bound_location = target.get_bound_location()
1762
if bound_location and target.base != bound_location:
1763
# there is a master branch.
1765
# XXX: Why the second check? Is it even supported for a branch to
1766
# be bound to itself? -- mbp 20070507
1767
master_branch = target.get_master_branch()
1768
master_branch.lock_write()
1770
# push into the master from this branch.
1771
self._basic_push(master_branch, overwrite, stop_revision)
1772
# and push into the target branch from this. Note that we push from
1773
# this branch again, because its considered the highest bandwidth
1775
result = self._basic_push(target, overwrite, stop_revision)
1776
result.master_branch = master_branch
1777
result.local_branch = target
1781
master_branch.unlock()
1784
result = self._basic_push(target, overwrite, stop_revision)
1785
# TODO: Why set master_branch and local_branch if there's no
1786
# binding? Maybe cleaner to just leave them unset? -- mbp
1788
result.master_branch = target
1789
result.local_branch = None
1793
def _basic_push(self, target, overwrite, stop_revision):
1794
"""Basic implementation of push without bound branches or hooks.
1796
Must be called with self read locked and target write locked.
1798
result = PushResult()
1799
result.source_branch = self
1800
result.target_branch = target
1801
result.old_revno, result.old_revid = target.last_revision_info()
1803
# We assume that during 'push' this repository is closer than
1805
graph = self.repository.get_graph(target.repository)
1806
target.update_revisions(self, stop_revision, overwrite=overwrite,
1808
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1809
result.new_revno, result.new_revid = target.last_revision_info()
1812
def get_parent(self):
1813
"""See Branch.get_parent."""
1814
parent = self._get_parent_location()
1817
# This is an old-format absolute path to a local branch
1818
# turn it into a url
1819
if parent.startswith('/'):
1820
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1822
return urlutils.join(self.base[:-1], parent)
1823
except errors.InvalidURLJoin, e:
1824
raise errors.InaccessibleParent(parent, self.base)
1826
def get_stacked_on_url(self):
1827
raise errors.UnstackableBranchFormat(self._format, self.base)
1829
def set_push_location(self, location):
1830
"""See Branch.set_push_location."""
1831
self.get_config().set_user_option(
1832
'push_location', location,
1833
store=_mod_config.STORE_LOCATION_NORECURSE)
1836
def set_parent(self, url):
1837
"""See Branch.set_parent."""
1838
# TODO: Maybe delete old location files?
1839
# URLs should never be unicode, even on the local fs,
1840
# FIXUP this and get_parent in a future branch format bump:
1841
# read and rewrite the file. RBC 20060125
1843
if isinstance(url, unicode):
1845
url = url.encode('ascii')
1846
except UnicodeEncodeError:
1847
raise errors.InvalidURL(url,
1848
"Urls must be 7-bit ascii, "
1849
"use bzrlib.urlutils.escape")
1850
url = urlutils.relative_url(self.base, url)
1851
self._set_parent_location(url)
1853
def _set_parent_location(self, url):
1855
self._transport.delete('parent')
1857
self._transport.put_bytes('parent', url + '\n',
1858
mode=self.bzrdir._get_file_mode())
1860
def set_stacked_on_url(self, url):
1861
raise errors.UnstackableBranchFormat(self._format, self.base)
1864
class BzrBranch5(BzrBranch):
1865
"""A format 5 branch. This supports new features over plain branches.
1867
It has support for a master_branch which is the data for bound branches.
1871
def pull(self, source, overwrite=False, stop_revision=None,
1872
run_hooks=True, possible_transports=None,
1873
_override_hook_target=None):
1874
"""Pull from source into self, updating my master if any.
1876
:param run_hooks: Private parameter - if false, this branch
1877
is being called because it's the master of the primary branch,
1878
so it should not run its hooks.
1880
bound_location = self.get_bound_location()
1881
master_branch = None
1882
if bound_location and source.base != bound_location:
1883
# not pulling from master, so we need to update master.
1884
master_branch = self.get_master_branch(possible_transports)
1885
master_branch.lock_write()
1888
# pull from source into master.
1889
master_branch.pull(source, overwrite, stop_revision,
1891
return super(BzrBranch5, self).pull(source, overwrite,
1892
stop_revision, _hook_master=master_branch,
1893
run_hooks=run_hooks,
1894
_override_hook_target=_override_hook_target)
1897
master_branch.unlock()
1899
def get_bound_location(self):
1901
return self._transport.get_bytes('bound')[:-1]
1902
except errors.NoSuchFile:
1906
def get_master_branch(self, possible_transports=None):
1907
"""Return the branch we are bound to.
1909
:return: Either a Branch, or None
1911
This could memoise the branch, but if thats done
1912
it must be revalidated on each new lock.
1913
So for now we just don't memoise it.
1914
# RBC 20060304 review this decision.
1916
bound_loc = self.get_bound_location()
1920
return Branch.open(bound_loc,
1921
possible_transports=possible_transports)
1922
except (errors.NotBranchError, errors.ConnectionError), e:
1923
raise errors.BoundBranchConnectionFailure(
1927
def set_bound_location(self, location):
1928
"""Set the target where this branch is bound to.
1930
:param location: URL to the target branch
1933
self._transport.put_bytes('bound', location+'\n',
1934
mode=self.bzrdir._get_file_mode())
1937
self._transport.delete('bound')
1938
except errors.NoSuchFile:
1943
def bind(self, other):
1944
"""Bind this branch to the branch other.
1946
This does not push or pull data between the branches, though it does
1947
check for divergence to raise an error when the branches are not
1948
either the same, or one a prefix of the other. That behaviour may not
1949
be useful, so that check may be removed in future.
1951
:param other: The branch to bind to
1954
# TODO: jam 20051230 Consider checking if the target is bound
1955
# It is debatable whether you should be able to bind to
1956
# a branch which is itself bound.
1957
# Committing is obviously forbidden,
1958
# but binding itself may not be.
1959
# Since we *have* to check at commit time, we don't
1960
# *need* to check here
1962
# we want to raise diverged if:
1963
# last_rev is not in the other_last_rev history, AND
1964
# other_last_rev is not in our history, and do it without pulling
1966
self.set_bound_location(other.base)
1970
"""If bound, unbind"""
1971
return self.set_bound_location(None)
1974
def update(self, possible_transports=None):
1975
"""Synchronise this branch with the master branch if any.
1977
:return: None or the last_revision that was pivoted out during the
1980
master = self.get_master_branch(possible_transports)
1981
if master is not None:
1982
old_tip = _mod_revision.ensure_null(self.last_revision())
1983
self.pull(master, overwrite=True)
1984
if self.repository.get_graph().is_ancestor(old_tip,
1985
_mod_revision.ensure_null(self.last_revision())):
1991
class BzrBranch7(BzrBranch5):
1992
"""A branch with support for a fallback repository."""
1994
def _get_fallback_repository(self, url):
1995
"""Get the repository we fallback to at url."""
1996
url = urlutils.join(self.base, url)
1997
return bzrdir.BzrDir.open(url).open_branch().repository
1999
def _activate_fallback_location(self, url):
2000
"""Activate the branch/repository from url as a fallback repository."""
2001
self.repository.add_fallback_repository(
2002
self._get_fallback_repository(url))
2004
def _open_hook(self):
2006
url = self.get_stacked_on_url()
2007
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2008
errors.UnstackableBranchFormat):
2011
self._activate_fallback_location(url)
2013
def _check_stackable_repo(self):
2014
if not self.repository._format.supports_external_lookups:
2015
raise errors.UnstackableRepositoryFormat(self.repository._format,
2016
self.repository.base)
2018
def __init__(self, *args, **kwargs):
2019
super(BzrBranch7, self).__init__(*args, **kwargs)
2020
self._last_revision_info_cache = None
2021
self._partial_revision_history_cache = []
2023
def _clear_cached_state(self):
2024
super(BzrBranch7, self)._clear_cached_state()
2025
self._last_revision_info_cache = None
2026
self._partial_revision_history_cache = []
2028
def _last_revision_info(self):
2029
revision_string = self._transport.get_bytes('last-revision')
2030
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2031
revision_id = cache_utf8.get_cached_utf8(revision_id)
2033
return revno, revision_id
2035
def _write_last_revision_info(self, revno, revision_id):
2036
"""Simply write out the revision id, with no checks.
2038
Use set_last_revision_info to perform this safely.
2040
Does not update the revision_history cache.
2041
Intended to be called by set_last_revision_info and
2042
_write_revision_history.
2044
revision_id = _mod_revision.ensure_null(revision_id)
2045
out_string = '%d %s\n' % (revno, revision_id)
2046
self._transport.put_bytes('last-revision', out_string,
2047
mode=self.bzrdir._get_file_mode())
2050
def set_last_revision_info(self, revno, revision_id):
2051
revision_id = _mod_revision.ensure_null(revision_id)
2052
old_revno, old_revid = self.last_revision_info()
2053
if self._get_append_revisions_only():
2054
self._check_history_violation(revision_id)
2055
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2056
self._write_last_revision_info(revno, revision_id)
2057
self._clear_cached_state()
2058
self._last_revision_info_cache = revno, revision_id
2059
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2061
def _check_history_violation(self, revision_id):
2062
last_revision = _mod_revision.ensure_null(self.last_revision())
2063
if _mod_revision.is_null(last_revision):
2065
if last_revision not in self._lefthand_history(revision_id):
2066
raise errors.AppendRevisionsOnlyViolation(self.base)
2068
def _gen_revision_history(self):
2069
"""Generate the revision history from last revision
2071
last_revno, last_revision = self.last_revision_info()
2072
self._extend_partial_history(stop_index=last_revno-1)
2073
return list(reversed(self._partial_revision_history_cache))
2075
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2076
"""Extend the partial history to include a given index
2078
If a stop_index is supplied, stop when that index has been reached.
2079
If a stop_revision is supplied, stop when that revision is
2080
encountered. Otherwise, stop when the beginning of history is
2083
:param stop_index: The index which should be present. When it is
2084
present, history extension will stop.
2085
:param revision_id: The revision id which should be present. When
2086
it is encountered, history extension will stop.
2088
repo = self.repository
2089
if len(self._partial_revision_history_cache) == 0:
2090
iterator = repo.iter_reverse_revision_history(self.last_revision())
2092
start_revision = self._partial_revision_history_cache[-1]
2093
iterator = repo.iter_reverse_revision_history(start_revision)
2094
#skip the last revision in the list
2095
next_revision = iterator.next()
2096
for revision_id in iterator:
2097
self._partial_revision_history_cache.append(revision_id)
2098
if (stop_index is not None and
2099
len(self._partial_revision_history_cache) > stop_index):
2101
if revision_id == stop_revision:
2104
def _write_revision_history(self, history):
2105
"""Factored out of set_revision_history.
2107
This performs the actual writing to disk, with format-specific checks.
2108
It is intended to be called by BzrBranch5.set_revision_history.
2110
if len(history) == 0:
2111
last_revision = 'null:'
2113
if history != self._lefthand_history(history[-1]):
2114
raise errors.NotLefthandHistory(history)
2115
last_revision = history[-1]
2116
if self._get_append_revisions_only():
2117
self._check_history_violation(last_revision)
2118
self._write_last_revision_info(len(history), last_revision)
2121
def _set_parent_location(self, url):
2122
"""Set the parent branch"""
2123
self._set_config_location('parent_location', url, make_relative=True)
2126
def _get_parent_location(self):
2127
"""Set the parent branch"""
2128
return self._get_config_location('parent_location')
2130
def set_push_location(self, location):
2131
"""See Branch.set_push_location."""
2132
self._set_config_location('push_location', location)
2134
def set_bound_location(self, location):
2135
"""See Branch.set_push_location."""
2137
config = self.get_config()
2138
if location is None:
2139
if config.get_user_option('bound') != 'True':
2142
config.set_user_option('bound', 'False', warn_masked=True)
2145
self._set_config_location('bound_location', location,
2147
config.set_user_option('bound', 'True', warn_masked=True)
2150
def _get_bound_location(self, bound):
2151
"""Return the bound location in the config file.
2153
Return None if the bound parameter does not match"""
2154
config = self.get_config()
2155
config_bound = (config.get_user_option('bound') == 'True')
2156
if config_bound != bound:
2158
return self._get_config_location('bound_location', config=config)
2160
def get_bound_location(self):
2161
"""See Branch.set_push_location."""
2162
return self._get_bound_location(True)
2164
def get_old_bound_location(self):
2165
"""See Branch.get_old_bound_location"""
2166
return self._get_bound_location(False)
2168
def get_stacked_on_url(self):
2169
self._check_stackable_repo()
2170
stacked_url = self._get_config_location('stacked_on_location')
2171
if stacked_url is None:
2172
raise errors.NotStacked(self)
2175
def set_append_revisions_only(self, enabled):
2180
self.get_config().set_user_option('append_revisions_only', value,
2183
def set_stacked_on_url(self, url):
2184
self._check_stackable_repo()
2187
old_url = self.get_stacked_on_url()
2188
except (errors.NotStacked, errors.UnstackableBranchFormat,
2189
errors.UnstackableRepositoryFormat):
2192
# repositories don't offer an interface to remove fallback
2193
# repositories today; take the conceptually simpler option and just
2195
self.repository = self.bzrdir.find_repository()
2196
# for every revision reference the branch has, ensure it is pulled
2198
source_repository = self._get_fallback_repository(old_url)
2199
for revision_id in chain([self.last_revision()],
2200
self.tags.get_reverse_tag_dict()):
2201
self.repository.fetch(source_repository, revision_id,
2204
self._activate_fallback_location(url)
2205
# write this out after the repository is stacked to avoid setting a
2206
# stacked config that doesn't work.
2207
self._set_config_location('stacked_on_location', url)
2209
def _get_append_revisions_only(self):
2210
value = self.get_config().get_user_option('append_revisions_only')
2211
return value == 'True'
2213
def _synchronize_history(self, destination, revision_id):
2214
"""Synchronize last revision and revision history between branches.
2216
This version is most efficient when the destination is also a
2217
BzrBranch6, but works for BzrBranch5, as long as the destination's
2218
repository contains all the lefthand ancestors of the intended
2219
last_revision. If not, set_last_revision_info will fail.
2221
:param destination: The branch to copy the history into
2222
:param revision_id: The revision-id to truncate history at. May
2223
be None to copy complete history.
2225
source_revno, source_revision_id = self.last_revision_info()
2226
if revision_id is None:
2227
revno, revision_id = source_revno, source_revision_id
2228
elif source_revision_id == revision_id:
2229
# we know the revno without needing to walk all of history
2230
revno = source_revno
2232
# To figure out the revno for a random revision, we need to build
2233
# the revision history, and count its length.
2234
# We don't care about the order, just how long it is.
2235
# Alternatively, we could start at the current location, and count
2236
# backwards. But there is no guarantee that we will find it since
2237
# it may be a merged revision.
2238
revno = len(list(self.repository.iter_reverse_revision_history(
2240
destination.set_last_revision_info(revno, revision_id)
2242
def _make_tags(self):
2243
return BasicTags(self)
2246
def generate_revision_history(self, revision_id, last_rev=None,
2248
"""See BzrBranch5.generate_revision_history"""
2249
history = self._lefthand_history(revision_id, last_rev, other_branch)
2250
revno = len(history)
2251
self.set_last_revision_info(revno, revision_id)
2254
def get_rev_id(self, revno, history=None):
2255
"""Find the revision id of the specified revno."""
2257
return _mod_revision.NULL_REVISION
2259
last_revno, last_revision_id = self.last_revision_info()
2260
if revno <= 0 or revno > last_revno:
2261
raise errors.NoSuchRevision(self, revno)
2263
if history is not None:
2264
return history[revno - 1]
2266
index = last_revno - revno
2267
if len(self._partial_revision_history_cache) <= index:
2268
self._extend_partial_history(stop_index=index)
2269
if len(self._partial_revision_history_cache) > index:
2270
return self._partial_revision_history_cache[index]
2272
raise errors.NoSuchRevision(self, revno)
2275
def revision_id_to_revno(self, revision_id):
2276
"""Given a revision id, return its revno"""
2277
if _mod_revision.is_null(revision_id):
2280
index = self._partial_revision_history_cache.index(revision_id)
2282
self._extend_partial_history(stop_revision=revision_id)
2283
index = len(self._partial_revision_history_cache) - 1
2284
if self._partial_revision_history_cache[index] != revision_id:
2285
raise errors.NoSuchRevision(self, revision_id)
2286
return self.revno() - index
2289
class BzrBranch6(BzrBranch7):
2290
"""See BzrBranchFormat6 for the capabilities of this branch.
2292
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2296
def get_stacked_on_url(self):
2297
raise errors.UnstackableBranchFormat(self._format, self.base)
2299
def set_stacked_on_url(self, url):
2300
raise errors.UnstackableBranchFormat(self._format, self.base)
2303
######################################################################
2304
# results of operations
2307
class _Result(object):
2309
def _show_tag_conficts(self, to_file):
2310
if not getattr(self, 'tag_conflicts', None):
2312
to_file.write('Conflicting tags:\n')
2313
for name, value1, value2 in self.tag_conflicts:
2314
to_file.write(' %s\n' % (name, ))
2317
class PullResult(_Result):
2318
"""Result of a Branch.pull operation.
2320
:ivar old_revno: Revision number before pull.
2321
:ivar new_revno: Revision number after pull.
2322
:ivar old_revid: Tip revision id before pull.
2323
:ivar new_revid: Tip revision id after pull.
2324
:ivar source_branch: Source (local) branch object.
2325
:ivar master_branch: Master branch of the target, or the target if no
2327
:ivar local_branch: target branch if there is a Master, else None
2328
:ivar target_branch: Target/destination branch object.
2329
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2333
# DEPRECATED: pull used to return the change in revno
2334
return self.new_revno - self.old_revno
2336
def report(self, to_file):
2338
if self.old_revid == self.new_revid:
2339
to_file.write('No revisions to pull.\n')
2341
to_file.write('Now on revision %d.\n' % self.new_revno)
2342
self._show_tag_conficts(to_file)
2345
class PushResult(_Result):
2346
"""Result of a Branch.push operation.
2348
:ivar old_revno: Revision number before push.
2349
:ivar new_revno: Revision number after push.
2350
:ivar old_revid: Tip revision id before push.
2351
:ivar new_revid: Tip revision id after push.
2352
:ivar source_branch: Source branch object.
2353
:ivar master_branch: Master branch of the target, or None.
2354
:ivar target_branch: Target/destination branch object.
2358
# DEPRECATED: push used to return the change in revno
2359
return self.new_revno - self.old_revno
2361
def report(self, to_file):
2362
"""Write a human-readable description of the result."""
2363
if self.old_revid == self.new_revid:
2364
to_file.write('No new revisions to push.\n')
2366
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
2367
self._show_tag_conficts(to_file)
2370
class BranchCheckResult(object):
2371
"""Results of checking branch consistency.
2376
def __init__(self, branch):
2377
self.branch = branch
2379
def report_results(self, verbose):
2380
"""Report the check results via trace.note.
2382
:param verbose: Requests more detailed display of what was checked,
2385
note('checked branch %s format %s',
2387
self.branch._format)
2390
class Converter5to6(object):
2391
"""Perform an in-place upgrade of format 5 to format 6"""
2393
def convert(self, branch):
2394
# Data for 5 and 6 can peacefully coexist.
2395
format = BzrBranchFormat6()
2396
new_branch = format.open(branch.bzrdir, _found=True)
2398
# Copy source data into target
2399
new_branch._write_last_revision_info(*branch.last_revision_info())
2400
new_branch.set_parent(branch.get_parent())
2401
new_branch.set_bound_location(branch.get_bound_location())
2402
new_branch.set_push_location(branch.get_push_location())
2404
# New branch has no tags by default
2405
new_branch.tags._set_tag_dict({})
2407
# Copying done; now update target format
2408
new_branch._transport.put_bytes('format',
2409
format.get_format_string(),
2410
mode=new_branch.bzrdir._get_file_mode())
2412
# Clean up old files
2413
new_branch._transport.delete('revision-history')
2415
branch.set_parent(None)
2416
except errors.NoSuchFile:
2418
branch.set_bound_location(None)
2421
class Converter6to7(object):
2422
"""Perform an in-place upgrade of format 6 to format 7"""
2424
def convert(self, branch):
2425
format = BzrBranchFormat7()
2426
branch._set_config_location('stacked_on_location', '')
2427
# update target format
2428
branch._transport.put_bytes('format', format.get_format_string())
added
removed
bzrlib/branch.py
