1
# Copyright (C) 2005-2011 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
21
from cStringIO import StringIO
23
from bzrlib.lazy_import import lazy_import
24
lazy_import(globals(), """
31
config as _mod_config,
40
revision as _mod_revision,
48
from bzrlib.i18n import gettext, ngettext
51
# Explicitly import bzrlib.bzrdir so that the BzrProber
52
# is guaranteed to be registered.
59
from bzrlib.decorators import (
64
from bzrlib.hooks import Hooks
65
from bzrlib.inter import InterObject
66
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
67
from bzrlib import registry
68
from bzrlib.symbol_versioning import (
72
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
75
class Branch(controldir.ControlComponent):
76
"""Branch holding a history of revisions.
79
Base directory/url of the branch; using control_url and
80
control_transport is more standardized.
81
:ivar hooks: An instance of BranchHooks.
82
:ivar _master_branch_cache: cached result of get_master_branch, see
85
# this is really an instance variable - FIXME move it there
90
def control_transport(self):
91
return self._transport
94
def user_transport(self):
95
return self.bzrdir.user_transport
97
def __init__(self, possible_transports=None):
98
self.tags = self._format.make_tags(self)
99
self._revision_history_cache = None
100
self._revision_id_to_revno_cache = None
101
self._partial_revision_id_to_revno_cache = {}
102
self._partial_revision_history_cache = []
103
self._tags_bytes = None
104
self._last_revision_info_cache = None
105
self._master_branch_cache = None
106
self._merge_sorted_revisions_cache = None
107
self._open_hook(possible_transports)
108
hooks = Branch.hooks['open']
112
def _open_hook(self, possible_transports):
113
"""Called by init to allow simpler extension of the base class."""
115
def _activate_fallback_location(self, url, possible_transports):
116
"""Activate the branch/repository from url as a fallback repository."""
117
for existing_fallback_repo in self.repository._fallback_repositories:
118
if existing_fallback_repo.user_url == url:
119
# This fallback is already configured. This probably only
120
# happens because ControlDir.sprout is a horrible mess. To avoid
121
# confusing _unstack we don't add this a second time.
122
mutter('duplicate activation of fallback %r on %r', url, self)
124
repo = self._get_fallback_repository(url, possible_transports)
125
if repo.has_same_location(self.repository):
126
raise errors.UnstackableLocationError(self.user_url, url)
127
self.repository.add_fallback_repository(repo)
129
def break_lock(self):
130
"""Break a lock if one is present from another instance.
132
Uses the ui factory to ask for confirmation if the lock may be from
135
This will probe the repository for its lock as well.
137
self.control_files.break_lock()
138
self.repository.break_lock()
139
master = self.get_master_branch()
140
if master is not None:
143
def _check_stackable_repo(self):
144
if not self.repository._format.supports_external_lookups:
145
raise errors.UnstackableRepositoryFormat(self.repository._format,
146
self.repository.base)
148
def _extend_partial_history(self, stop_index=None, stop_revision=None):
149
"""Extend the partial history to include a given index
151
If a stop_index is supplied, stop when that index has been reached.
152
If a stop_revision is supplied, stop when that revision is
153
encountered. Otherwise, stop when the beginning of history is
156
:param stop_index: The index which should be present. When it is
157
present, history extension will stop.
158
:param stop_revision: The revision id which should be present. When
159
it is encountered, history extension will stop.
161
if len(self._partial_revision_history_cache) == 0:
162
self._partial_revision_history_cache = [self.last_revision()]
163
repository._iter_for_revno(
164
self.repository, self._partial_revision_history_cache,
165
stop_index=stop_index, stop_revision=stop_revision)
166
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
167
self._partial_revision_history_cache.pop()
169
def _get_check_refs(self):
170
"""Get the references needed for check().
174
revid = self.last_revision()
175
return [('revision-existence', revid), ('lefthand-distance', revid)]
178
def open(base, _unsupported=False, possible_transports=None):
179
"""Open the branch rooted at base.
181
For instance, if the branch is at URL/.bzr/branch,
182
Branch.open(URL) -> a Branch instance.
184
control = controldir.ControlDir.open(base,
185
possible_transports=possible_transports, _unsupported=_unsupported)
186
return control.open_branch(unsupported=_unsupported,
187
possible_transports=possible_transports)
190
def open_from_transport(transport, name=None, _unsupported=False,
191
possible_transports=None):
192
"""Open the branch rooted at transport"""
193
control = controldir.ControlDir.open_from_transport(transport, _unsupported)
194
return control.open_branch(name=name, unsupported=_unsupported,
195
possible_transports=possible_transports)
198
def open_containing(url, possible_transports=None):
199
"""Open an existing branch which contains url.
201
This probes for a branch at url, and searches upwards from there.
203
Basically we keep looking up until we find the control directory or
204
run into the root. If there isn't one, raises NotBranchError.
205
If there is one and it is either an unrecognised format or an unsupported
206
format, UnknownFormatError or UnsupportedFormatError are raised.
207
If there is one, it is returned, along with the unused portion of url.
209
control, relpath = controldir.ControlDir.open_containing(url,
211
branch = control.open_branch(possible_transports=possible_transports)
212
return (branch, relpath)
214
def _push_should_merge_tags(self):
215
"""Should _basic_push merge this branch's tags into the target?
217
The default implementation returns False if this branch has no tags,
218
and True the rest of the time. Subclasses may override this.
220
return self.supports_tags() and self.tags.get_tag_dict()
222
def get_config(self):
223
"""Get a bzrlib.config.BranchConfig for this Branch.
225
This can then be used to get and set configuration options for the
228
:return: A bzrlib.config.BranchConfig.
230
return _mod_config.BranchConfig(self)
232
def get_config_stack(self):
233
"""Get a bzrlib.config.BranchStack for this Branch.
235
This can then be used to get and set configuration options for the
238
:return: A bzrlib.config.BranchStack.
240
return _mod_config.BranchStack(self)
242
def _get_config(self):
243
"""Get the concrete config for just the config in this branch.
245
This is not intended for client use; see Branch.get_config for the
250
:return: An object supporting get_option and set_option.
252
raise NotImplementedError(self._get_config)
254
def _get_fallback_repository(self, url, possible_transports):
255
"""Get the repository we fallback to at url."""
256
url = urlutils.join(self.base, url)
257
a_branch = Branch.open(url, possible_transports=possible_transports)
258
return a_branch.repository
261
def _get_tags_bytes(self):
262
"""Get the bytes of a serialised tags dict.
264
Note that not all branches support tags, nor do all use the same tags
265
logic: this method is specific to BasicTags. Other tag implementations
266
may use the same method name and behave differently, safely, because
267
of the double-dispatch via
268
format.make_tags->tags_instance->get_tags_dict.
270
:return: The bytes of the tags file.
271
:seealso: Branch._set_tags_bytes.
273
if self._tags_bytes is None:
274
self._tags_bytes = self._transport.get_bytes('tags')
275
return self._tags_bytes
277
def _get_nick(self, local=False, possible_transports=None):
278
config = self.get_config()
279
# explicit overrides master, but don't look for master if local is True
280
if not local and not config.has_explicit_nickname():
282
master = self.get_master_branch(possible_transports)
283
if master and self.user_url == master.user_url:
284
raise errors.RecursiveBind(self.user_url)
285
if master is not None:
286
# return the master branch value
288
except errors.RecursiveBind, e:
290
except errors.BzrError, e:
291
# Silently fall back to local implicit nick if the master is
293
mutter("Could not connect to bound branch, "
294
"falling back to local nick.\n " + str(e))
295
return config.get_nickname()
297
def _set_nick(self, nick):
298
self.get_config().set_user_option('nickname', nick, warn_masked=True)
300
nick = property(_get_nick, _set_nick)
303
raise NotImplementedError(self.is_locked)
305
def _lefthand_history(self, revision_id, last_rev=None,
307
if 'evil' in debug.debug_flags:
308
mutter_callsite(4, "_lefthand_history scales with history.")
309
# stop_revision must be a descendant of last_revision
310
graph = self.repository.get_graph()
311
if last_rev is not None:
312
if not graph.is_ancestor(last_rev, revision_id):
313
# our previous tip is not merged into stop_revision
314
raise errors.DivergedBranches(self, other_branch)
315
# make a new revision history from the graph
316
parents_map = graph.get_parent_map([revision_id])
317
if revision_id not in parents_map:
318
raise errors.NoSuchRevision(self, revision_id)
319
current_rev_id = revision_id
321
check_not_reserved_id = _mod_revision.check_not_reserved_id
322
# Do not include ghosts or graph origin in revision_history
323
while (current_rev_id in parents_map and
324
len(parents_map[current_rev_id]) > 0):
325
check_not_reserved_id(current_rev_id)
326
new_history.append(current_rev_id)
327
current_rev_id = parents_map[current_rev_id][0]
328
parents_map = graph.get_parent_map([current_rev_id])
329
new_history.reverse()
332
def lock_write(self, token=None):
333
"""Lock the branch for write operations.
335
:param token: A token to permit reacquiring a previously held and
337
:return: A BranchWriteLockResult.
339
raise NotImplementedError(self.lock_write)
342
"""Lock the branch for read operations.
344
:return: A bzrlib.lock.LogicalLockResult.
346
raise NotImplementedError(self.lock_read)
349
raise NotImplementedError(self.unlock)
351
def peek_lock_mode(self):
352
"""Return lock mode for the Branch: 'r', 'w' or None"""
353
raise NotImplementedError(self.peek_lock_mode)
355
def get_physical_lock_status(self):
356
raise NotImplementedError(self.get_physical_lock_status)
359
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
360
"""Return the revision_id for a dotted revno.
362
:param revno: a tuple like (1,) or (1,1,2)
363
:param _cache_reverse: a private parameter enabling storage
364
of the reverse mapping in a top level cache. (This should
365
only be done in selective circumstances as we want to
366
avoid having the mapping cached multiple times.)
367
:return: the revision_id
368
:raises errors.NoSuchRevision: if the revno doesn't exist
370
rev_id = self._do_dotted_revno_to_revision_id(revno)
372
self._partial_revision_id_to_revno_cache[rev_id] = revno
375
def _do_dotted_revno_to_revision_id(self, revno):
376
"""Worker function for dotted_revno_to_revision_id.
378
Subclasses should override this if they wish to
379
provide a more efficient implementation.
382
return self.get_rev_id(revno[0])
383
revision_id_to_revno = self.get_revision_id_to_revno_map()
384
revision_ids = [revision_id for revision_id, this_revno
385
in revision_id_to_revno.iteritems()
386
if revno == this_revno]
387
if len(revision_ids) == 1:
388
return revision_ids[0]
390
revno_str = '.'.join(map(str, revno))
391
raise errors.NoSuchRevision(self, revno_str)
394
def revision_id_to_dotted_revno(self, revision_id):
395
"""Given a revision id, return its dotted revno.
397
:return: a tuple like (1,) or (400,1,3).
399
return self._do_revision_id_to_dotted_revno(revision_id)
401
def _do_revision_id_to_dotted_revno(self, revision_id):
402
"""Worker function for revision_id_to_revno."""
403
# Try the caches if they are loaded
404
result = self._partial_revision_id_to_revno_cache.get(revision_id)
405
if result is not None:
407
if self._revision_id_to_revno_cache:
408
result = self._revision_id_to_revno_cache.get(revision_id)
410
raise errors.NoSuchRevision(self, revision_id)
411
# Try the mainline as it's optimised
413
revno = self.revision_id_to_revno(revision_id)
415
except errors.NoSuchRevision:
416
# We need to load and use the full revno map after all
417
result = self.get_revision_id_to_revno_map().get(revision_id)
419
raise errors.NoSuchRevision(self, revision_id)
423
def get_revision_id_to_revno_map(self):
424
"""Return the revision_id => dotted revno map.
426
This will be regenerated on demand, but will be cached.
428
:return: A dictionary mapping revision_id => dotted revno.
429
This dictionary should not be modified by the caller.
431
if self._revision_id_to_revno_cache is not None:
432
mapping = self._revision_id_to_revno_cache
434
mapping = self._gen_revno_map()
435
self._cache_revision_id_to_revno(mapping)
436
# TODO: jam 20070417 Since this is being cached, should we be returning
438
# I would rather not, and instead just declare that users should not
439
# modify the return value.
442
def _gen_revno_map(self):
443
"""Create a new mapping from revision ids to dotted revnos.
445
Dotted revnos are generated based on the current tip in the revision
447
This is the worker function for get_revision_id_to_revno_map, which
448
just caches the return value.
450
:return: A dictionary mapping revision_id => dotted revno.
452
revision_id_to_revno = dict((rev_id, revno)
453
for rev_id, depth, revno, end_of_merge
454
in self.iter_merge_sorted_revisions())
455
return revision_id_to_revno
458
def iter_merge_sorted_revisions(self, start_revision_id=None,
459
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
460
"""Walk the revisions for a branch in merge sorted order.
462
Merge sorted order is the output from a merge-aware,
463
topological sort, i.e. all parents come before their
464
children going forward; the opposite for reverse.
466
:param start_revision_id: the revision_id to begin walking from.
467
If None, the branch tip is used.
468
:param stop_revision_id: the revision_id to terminate the walk
469
after. If None, the rest of history is included.
470
:param stop_rule: if stop_revision_id is not None, the precise rule
471
to use for termination:
473
* 'exclude' - leave the stop revision out of the result (default)
474
* 'include' - the stop revision is the last item in the result
475
* 'with-merges' - include the stop revision and all of its
476
merged revisions in the result
477
* 'with-merges-without-common-ancestry' - filter out revisions
478
that are in both ancestries
479
:param direction: either 'reverse' or 'forward':
481
* reverse means return the start_revision_id first, i.e.
482
start at the most recent revision and go backwards in history
483
* forward returns tuples in the opposite order to reverse.
484
Note in particular that forward does *not* do any intelligent
485
ordering w.r.t. depth as some clients of this API may like.
486
(If required, that ought to be done at higher layers.)
488
:return: an iterator over (revision_id, depth, revno, end_of_merge)
491
* revision_id: the unique id of the revision
492
* depth: How many levels of merging deep this node has been
494
* revno_sequence: This field provides a sequence of
495
revision numbers for all revisions. The format is:
496
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
497
branch that the revno is on. From left to right the REVNO numbers
498
are the sequence numbers within that branch of the revision.
499
* end_of_merge: When True the next node (earlier in history) is
500
part of a different merge.
502
# Note: depth and revno values are in the context of the branch so
503
# we need the full graph to get stable numbers, regardless of the
505
if self._merge_sorted_revisions_cache is None:
506
last_revision = self.last_revision()
507
known_graph = self.repository.get_known_graph_ancestry(
509
self._merge_sorted_revisions_cache = known_graph.merge_sort(
511
filtered = self._filter_merge_sorted_revisions(
512
self._merge_sorted_revisions_cache, start_revision_id,
513
stop_revision_id, stop_rule)
514
# Make sure we don't return revisions that are not part of the
515
# start_revision_id ancestry.
516
filtered = self._filter_start_non_ancestors(filtered)
517
if direction == 'reverse':
519
if direction == 'forward':
520
return reversed(list(filtered))
522
raise ValueError('invalid direction %r' % direction)
524
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
525
start_revision_id, stop_revision_id, stop_rule):
526
"""Iterate over an inclusive range of sorted revisions."""
527
rev_iter = iter(merge_sorted_revisions)
528
if start_revision_id is not None:
529
for node in rev_iter:
531
if rev_id != start_revision_id:
534
# The decision to include the start or not
535
# depends on the stop_rule if a stop is provided
536
# so pop this node back into the iterator
537
rev_iter = itertools.chain(iter([node]), rev_iter)
539
if stop_revision_id is None:
541
for node in rev_iter:
543
yield (rev_id, node.merge_depth, node.revno,
545
elif stop_rule == 'exclude':
546
for node in rev_iter:
548
if rev_id == stop_revision_id:
550
yield (rev_id, node.merge_depth, node.revno,
552
elif stop_rule == 'include':
553
for node in rev_iter:
555
yield (rev_id, node.merge_depth, node.revno,
557
if rev_id == stop_revision_id:
559
elif stop_rule == 'with-merges-without-common-ancestry':
560
# We want to exclude all revisions that are already part of the
561
# stop_revision_id ancestry.
562
graph = self.repository.get_graph()
563
ancestors = graph.find_unique_ancestors(start_revision_id,
565
for node in rev_iter:
567
if rev_id not in ancestors:
569
yield (rev_id, node.merge_depth, node.revno,
571
elif stop_rule == 'with-merges':
572
stop_rev = self.repository.get_revision(stop_revision_id)
573
if stop_rev.parent_ids:
574
left_parent = stop_rev.parent_ids[0]
576
left_parent = _mod_revision.NULL_REVISION
577
# left_parent is the actual revision we want to stop logging at,
578
# since we want to show the merged revisions after the stop_rev too
579
reached_stop_revision_id = False
580
revision_id_whitelist = []
581
for node in rev_iter:
583
if rev_id == left_parent:
584
# reached the left parent after the stop_revision
586
if (not reached_stop_revision_id or
587
rev_id in revision_id_whitelist):
588
yield (rev_id, node.merge_depth, node.revno,
590
if reached_stop_revision_id or rev_id == stop_revision_id:
591
# only do the merged revs of rev_id from now on
592
rev = self.repository.get_revision(rev_id)
594
reached_stop_revision_id = True
595
revision_id_whitelist.extend(rev.parent_ids)
597
raise ValueError('invalid stop_rule %r' % stop_rule)
599
def _filter_start_non_ancestors(self, rev_iter):
600
# If we started from a dotted revno, we want to consider it as a tip
601
# and don't want to yield revisions that are not part of its
602
# ancestry. Given the order guaranteed by the merge sort, we will see
603
# uninteresting descendants of the first parent of our tip before the
605
first = rev_iter.next()
606
(rev_id, merge_depth, revno, end_of_merge) = first
609
# We start at a mainline revision so by definition, all others
610
# revisions in rev_iter are ancestors
611
for node in rev_iter:
616
pmap = self.repository.get_parent_map([rev_id])
617
parents = pmap.get(rev_id, [])
619
whitelist.update(parents)
621
# If there is no parents, there is nothing of interest left
623
# FIXME: It's hard to test this scenario here as this code is never
624
# called in that case. -- vila 20100322
627
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
629
if rev_id in whitelist:
630
pmap = self.repository.get_parent_map([rev_id])
631
parents = pmap.get(rev_id, [])
632
whitelist.remove(rev_id)
633
whitelist.update(parents)
635
# We've reached the mainline, there is nothing left to
639
# A revision that is not part of the ancestry of our
642
yield (rev_id, merge_depth, revno, end_of_merge)
644
def leave_lock_in_place(self):
645
"""Tell this branch object not to release the physical lock when this
648
If lock_write doesn't return a token, then this method is not supported.
650
self.control_files.leave_in_place()
652
def dont_leave_lock_in_place(self):
653
"""Tell this branch object to release the physical lock when this
654
object is unlocked, even if it didn't originally acquire it.
656
If lock_write doesn't return a token, then this method is not supported.
658
self.control_files.dont_leave_in_place()
660
def bind(self, other):
661
"""Bind the local branch the other branch.
663
:param other: The branch to bind to
666
raise errors.UpgradeRequired(self.user_url)
668
def get_append_revisions_only(self):
669
"""Whether it is only possible to append revisions to the history.
671
if not self._format.supports_set_append_revisions_only():
673
return self.get_config_stack().get('append_revisions_only')
675
def set_append_revisions_only(self, enabled):
676
if not self._format.supports_set_append_revisions_only():
677
raise errors.UpgradeRequired(self.user_url)
678
self.get_config_stack().set('append_revisions_only', enabled)
680
def set_reference_info(self, file_id, tree_path, branch_location):
681
"""Set the branch location to use for a tree reference."""
682
raise errors.UnsupportedOperation(self.set_reference_info, self)
684
def get_reference_info(self, file_id):
685
"""Get the tree_path and branch_location for a tree reference."""
686
raise errors.UnsupportedOperation(self.get_reference_info, self)
689
def fetch(self, from_branch, last_revision=None, limit=None):
690
"""Copy revisions from from_branch into this branch.
692
:param from_branch: Where to copy from.
693
:param last_revision: What revision to stop at (None for at the end
695
:param limit: Optional rough limit of revisions to fetch
698
return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
700
def get_bound_location(self):
701
"""Return the URL of the branch we are bound to.
703
Older format branches cannot bind, please be sure to use a metadir
708
def get_old_bound_location(self):
709
"""Return the URL of the branch we used to be bound to
711
raise errors.UpgradeRequired(self.user_url)
713
def get_commit_builder(self, parents, config_stack=None, timestamp=None,
714
timezone=None, committer=None, revprops=None,
715
revision_id=None, lossy=False):
716
"""Obtain a CommitBuilder for this branch.
718
:param parents: Revision ids of the parents of the new revision.
719
:param config: Optional configuration to use.
720
:param timestamp: Optional timestamp recorded for commit.
721
:param timezone: Optional timezone for timestamp.
722
:param committer: Optional committer to set for commit.
723
:param revprops: Optional dictionary of revision properties.
724
:param revision_id: Optional revision id.
725
:param lossy: Whether to discard data that can not be natively
726
represented, when pushing to a foreign VCS
729
if config_stack is None:
730
config_stack = self.get_config_stack()
732
return self.repository.get_commit_builder(self, parents, config_stack,
733
timestamp, timezone, committer, revprops, revision_id,
736
def get_master_branch(self, possible_transports=None):
737
"""Return the branch we are bound to.
739
:return: Either a Branch, or None
743
@deprecated_method(deprecated_in((2, 5, 0)))
744
def get_revision_delta(self, revno):
745
"""Return the delta for one revision.
747
The delta is relative to its mainline predecessor, or the
748
empty tree for revision 1.
751
revid = self.get_rev_id(revno)
752
except errors.NoSuchRevision:
753
raise errors.InvalidRevisionNumber(revno)
754
return self.repository.get_revision_delta(revid)
756
def get_stacked_on_url(self):
757
"""Get the URL this branch is stacked against.
759
:raises NotStacked: If the branch is not stacked.
760
:raises UnstackableBranchFormat: If the branch does not support
763
raise NotImplementedError(self.get_stacked_on_url)
765
def print_file(self, file, revision_id):
766
"""Print `file` to stdout."""
767
raise NotImplementedError(self.print_file)
769
@deprecated_method(deprecated_in((2, 4, 0)))
770
def set_revision_history(self, rev_history):
771
"""See Branch.set_revision_history."""
772
self._set_revision_history(rev_history)
775
def _set_revision_history(self, rev_history):
776
if len(rev_history) == 0:
777
revid = _mod_revision.NULL_REVISION
779
revid = rev_history[-1]
780
if rev_history != self._lefthand_history(revid):
781
raise errors.NotLefthandHistory(rev_history)
782
self.set_last_revision_info(len(rev_history), revid)
783
self._cache_revision_history(rev_history)
784
for hook in Branch.hooks['set_rh']:
785
hook(self, rev_history)
788
def set_last_revision_info(self, revno, revision_id):
789
"""Set the last revision of this branch.
791
The caller is responsible for checking that the revno is correct
792
for this revision id.
794
It may be possible to set the branch last revision to an id not
795
present in the repository. However, branches can also be
796
configured to check constraints on history, in which case this may not
799
raise NotImplementedError(self.set_last_revision_info)
802
def generate_revision_history(self, revision_id, last_rev=None,
804
"""See Branch.generate_revision_history"""
805
graph = self.repository.get_graph()
806
(last_revno, last_revid) = self.last_revision_info()
807
known_revision_ids = [
808
(last_revid, last_revno),
809
(_mod_revision.NULL_REVISION, 0),
811
if last_rev is not None:
812
if not graph.is_ancestor(last_rev, revision_id):
813
# our previous tip is not merged into stop_revision
814
raise errors.DivergedBranches(self, other_branch)
815
revno = graph.find_distance_to_null(revision_id, known_revision_ids)
816
self.set_last_revision_info(revno, revision_id)
819
def set_parent(self, url):
820
"""See Branch.set_parent."""
821
# TODO: Maybe delete old location files?
822
# URLs should never be unicode, even on the local fs,
823
# FIXUP this and get_parent in a future branch format bump:
824
# read and rewrite the file. RBC 20060125
826
if isinstance(url, unicode):
828
url = url.encode('ascii')
829
except UnicodeEncodeError:
830
raise errors.InvalidURL(url,
831
"Urls must be 7-bit ascii, "
832
"use bzrlib.urlutils.escape")
833
url = urlutils.relative_url(self.base, url)
834
self._set_parent_location(url)
837
def set_stacked_on_url(self, url):
838
"""Set the URL this branch is stacked against.
840
:raises UnstackableBranchFormat: If the branch does not support
842
:raises UnstackableRepositoryFormat: If the repository does not support
845
if not self._format.supports_stacking():
846
raise errors.UnstackableBranchFormat(self._format, self.user_url)
847
# XXX: Changing from one fallback repository to another does not check
848
# that all the data you need is present in the new fallback.
849
# Possibly it should.
850
self._check_stackable_repo()
853
old_url = self.get_stacked_on_url()
854
except (errors.NotStacked, errors.UnstackableBranchFormat,
855
errors.UnstackableRepositoryFormat):
859
self._activate_fallback_location(url,
860
possible_transports=[self.bzrdir.root_transport])
861
# write this out after the repository is stacked to avoid setting a
862
# stacked config that doesn't work.
863
self._set_config_location('stacked_on_location', url)
866
"""Change a branch to be unstacked, copying data as needed.
868
Don't call this directly, use set_stacked_on_url(None).
870
pb = ui.ui_factory.nested_progress_bar()
872
pb.update(gettext("Unstacking"))
873
# The basic approach here is to fetch the tip of the branch,
874
# including all available ghosts, from the existing stacked
875
# repository into a new repository object without the fallbacks.
877
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
878
# correct for CHKMap repostiories
879
old_repository = self.repository
880
if len(old_repository._fallback_repositories) != 1:
881
raise AssertionError("can't cope with fallback repositories "
882
"of %r (fallbacks: %r)" % (old_repository,
883
old_repository._fallback_repositories))
884
# Open the new repository object.
885
# Repositories don't offer an interface to remove fallback
886
# repositories today; take the conceptually simpler option and just
887
# reopen it. We reopen it starting from the URL so that we
888
# get a separate connection for RemoteRepositories and can
889
# stream from one of them to the other. This does mean doing
890
# separate SSH connection setup, but unstacking is not a
891
# common operation so it's tolerable.
892
new_bzrdir = controldir.ControlDir.open(
893
self.bzrdir.root_transport.base)
894
new_repository = new_bzrdir.find_repository()
895
if new_repository._fallback_repositories:
896
raise AssertionError("didn't expect %r to have "
897
"fallback_repositories"
898
% (self.repository,))
899
# Replace self.repository with the new repository.
900
# Do our best to transfer the lock state (i.e. lock-tokens and
901
# lock count) of self.repository to the new repository.
902
lock_token = old_repository.lock_write().repository_token
903
self.repository = new_repository
904
if isinstance(self, remote.RemoteBranch):
905
# Remote branches can have a second reference to the old
906
# repository that need to be replaced.
907
if self._real_branch is not None:
908
self._real_branch.repository = new_repository
909
self.repository.lock_write(token=lock_token)
910
if lock_token is not None:
911
old_repository.leave_lock_in_place()
912
old_repository.unlock()
913
if lock_token is not None:
914
# XXX: self.repository.leave_lock_in_place() before this
915
# function will not be preserved. Fortunately that doesn't
916
# affect the current default format (2a), and would be a
917
# corner-case anyway.
918
# - Andrew Bennetts, 2010/06/30
919
self.repository.dont_leave_lock_in_place()
923
old_repository.unlock()
924
except errors.LockNotHeld:
927
if old_lock_count == 0:
928
raise AssertionError(
929
'old_repository should have been locked at least once.')
930
for i in range(old_lock_count-1):
931
self.repository.lock_write()
932
# Fetch from the old repository into the new.
933
old_repository.lock_read()
935
# XXX: If you unstack a branch while it has a working tree
936
# with a pending merge, the pending-merged revisions will no
937
# longer be present. You can (probably) revert and remerge.
939
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
940
except errors.TagsNotSupported:
941
tags_to_fetch = set()
942
fetch_spec = vf_search.NotInOtherForRevs(self.repository,
943
old_repository, required_ids=[self.last_revision()],
944
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
945
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
947
old_repository.unlock()
951
def _set_tags_bytes(self, bytes):
952
"""Mirror method for _get_tags_bytes.
954
:seealso: Branch._get_tags_bytes.
956
op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
957
op.add_cleanup(self.lock_write().unlock)
958
return op.run_simple(bytes)
960
def _set_tags_bytes_locked(self, bytes):
961
self._tags_bytes = bytes
962
return self._transport.put_bytes('tags', bytes)
964
def _cache_revision_history(self, rev_history):
965
"""Set the cached revision history to rev_history.
967
The revision_history method will use this cache to avoid regenerating
968
the revision history.
970
This API is semi-public; it only for use by subclasses, all other code
971
should consider it to be private.
973
self._revision_history_cache = rev_history
975
def _cache_revision_id_to_revno(self, revision_id_to_revno):
976
"""Set the cached revision_id => revno map to revision_id_to_revno.
978
This API is semi-public; it only for use by subclasses, all other code
979
should consider it to be private.
981
self._revision_id_to_revno_cache = revision_id_to_revno
983
def _clear_cached_state(self):
984
"""Clear any cached data on this branch, e.g. cached revision history.
986
This means the next call to revision_history will need to call
987
_gen_revision_history.
989
This API is semi-public; it only for use by subclasses, all other code
990
should consider it to be private.
992
self._revision_history_cache = None
993
self._revision_id_to_revno_cache = None
994
self._last_revision_info_cache = None
995
self._master_branch_cache = None
996
self._merge_sorted_revisions_cache = None
997
self._partial_revision_history_cache = []
998
self._partial_revision_id_to_revno_cache = {}
999
self._tags_bytes = None
1001
def _gen_revision_history(self):
1002
"""Return sequence of revision hashes on to this branch.
1004
Unlike revision_history, this method always regenerates or rereads the
1005
revision history, i.e. it does not cache the result, so repeated calls
1008
Concrete subclasses should override this instead of revision_history so
1009
that subclasses do not need to deal with caching logic.
1011
This API is semi-public; it only for use by subclasses, all other code
1012
should consider it to be private.
1014
raise NotImplementedError(self._gen_revision_history)
1016
@deprecated_method(deprecated_in((2, 5, 0)))
1018
def revision_history(self):
1019
"""Return sequence of revision ids on this branch.
1021
This method will cache the revision history for as long as it is safe to
1024
return self._revision_history()
1026
def _revision_history(self):
1027
if 'evil' in debug.debug_flags:
1028
mutter_callsite(3, "revision_history scales with history.")
1029
if self._revision_history_cache is not None:
1030
history = self._revision_history_cache
1032
history = self._gen_revision_history()
1033
self._cache_revision_history(history)
1034
return list(history)
1037
"""Return current revision number for this branch.
1039
That is equivalent to the number of revisions committed to
1042
return self.last_revision_info()[0]
1045
"""Older format branches cannot bind or unbind."""
1046
raise errors.UpgradeRequired(self.user_url)
1048
def last_revision(self):
1049
"""Return last revision id, or NULL_REVISION."""
1050
return self.last_revision_info()[1]
1053
def last_revision_info(self):
1054
"""Return information about the last revision.
1056
:return: A tuple (revno, revision_id).
1058
if self._last_revision_info_cache is None:
1059
self._last_revision_info_cache = self._read_last_revision_info()
1060
return self._last_revision_info_cache
1062
def _read_last_revision_info(self):
1063
raise NotImplementedError(self._read_last_revision_info)
1065
@deprecated_method(deprecated_in((2, 4, 0)))
1066
def import_last_revision_info(self, source_repo, revno, revid):
1067
"""Set the last revision info, importing from another repo if necessary.
1069
:param source_repo: Source repository to optionally fetch from
1070
:param revno: Revision number of the new tip
1071
:param revid: Revision id of the new tip
1073
if not self.repository.has_same_location(source_repo):
1074
self.repository.fetch(source_repo, revision_id=revid)
1075
self.set_last_revision_info(revno, revid)
1077
def import_last_revision_info_and_tags(self, source, revno, revid,
1079
"""Set the last revision info, importing from another repo if necessary.
1081
This is used by the bound branch code to upload a revision to
1082
the master branch first before updating the tip of the local branch.
1083
Revisions referenced by source's tags are also transferred.
1085
:param source: Source branch to optionally fetch from
1086
:param revno: Revision number of the new tip
1087
:param revid: Revision id of the new tip
1088
:param lossy: Whether to discard metadata that can not be
1089
natively represented
1090
:return: Tuple with the new revision number and revision id
1091
(should only be different from the arguments when lossy=True)
1093
if not self.repository.has_same_location(source.repository):
1094
self.fetch(source, revid)
1095
self.set_last_revision_info(revno, revid)
1096
return (revno, revid)
1098
def revision_id_to_revno(self, revision_id):
1099
"""Given a revision id, return its revno"""
1100
if _mod_revision.is_null(revision_id):
1102
history = self._revision_history()
1104
return history.index(revision_id) + 1
1106
raise errors.NoSuchRevision(self, revision_id)
1109
def get_rev_id(self, revno, history=None):
1110
"""Find the revision id of the specified revno."""
1112
return _mod_revision.NULL_REVISION
1113
last_revno, last_revid = self.last_revision_info()
1114
if revno == last_revno:
1116
if revno <= 0 or revno > last_revno:
1117
raise errors.NoSuchRevision(self, revno)
1118
distance_from_last = last_revno - revno
1119
if len(self._partial_revision_history_cache) <= distance_from_last:
1120
self._extend_partial_history(distance_from_last)
1121
return self._partial_revision_history_cache[distance_from_last]
1123
def pull(self, source, overwrite=False, stop_revision=None,
1124
possible_transports=None, *args, **kwargs):
1125
"""Mirror source into this branch.
1127
This branch is considered to be 'local', having low latency.
1129
:returns: PullResult instance
1131
return InterBranch.get(source, self).pull(overwrite=overwrite,
1132
stop_revision=stop_revision,
1133
possible_transports=possible_transports, *args, **kwargs)
1135
def push(self, target, overwrite=False, stop_revision=None, lossy=False,
1137
"""Mirror this branch into target.
1139
This branch is considered to be 'local', having low latency.
1141
return InterBranch.get(self, target).push(overwrite, stop_revision,
1142
lossy, *args, **kwargs)
1144
def basis_tree(self):
1145
"""Return `Tree` object for last revision."""
1146
return self.repository.revision_tree(self.last_revision())
1148
def get_parent(self):
1149
"""Return the parent location of the branch.
1151
This is the default location for pull/missing. The usual
1152
pattern is that the user can override it by specifying a
1155
parent = self._get_parent_location()
1158
# This is an old-format absolute path to a local branch
1159
# turn it into a url
1160
if parent.startswith('/'):
1161
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1163
return urlutils.join(self.base[:-1], parent)
1164
except errors.InvalidURLJoin, e:
1165
raise errors.InaccessibleParent(parent, self.user_url)
1167
def _get_parent_location(self):
1168
raise NotImplementedError(self._get_parent_location)
1170
def _set_config_location(self, name, url, config=None,
1171
make_relative=False):
1173
config = self.get_config_stack()
1177
url = urlutils.relative_url(self.base, url)
1178
config.set(name, url)
1180
def _get_config_location(self, name, config=None):
1182
config = self.get_config_stack()
1183
location = config.get(name)
1188
def get_child_submit_format(self):
1189
"""Return the preferred format of submissions to this branch."""
1190
return self.get_config_stack().get('child_submit_format')
1192
def get_submit_branch(self):
1193
"""Return the submit location of the branch.
1195
This is the default location for bundle. The usual
1196
pattern is that the user can override it by specifying a
1199
return self.get_config_stack().get('submit_branch')
1201
def set_submit_branch(self, location):
1202
"""Return the submit location of the branch.
1204
This is the default location for bundle. The usual
1205
pattern is that the user can override it by specifying a
1208
self.get_config_stack().set('submit_branch', location)
1210
def get_public_branch(self):
1211
"""Return the public location of the branch.
1213
This is used by merge directives.
1215
return self._get_config_location('public_branch')
1217
def set_public_branch(self, location):
1218
"""Return the submit location of the branch.
1220
This is the default location for bundle. The usual
1221
pattern is that the user can override it by specifying a
1224
self._set_config_location('public_branch', location)
1226
def get_push_location(self):
1227
"""Return None or the location to push this branch to."""
1228
return self.get_config_stack().get('push_location')
1230
def set_push_location(self, location):
1231
"""Set a new push location for this branch."""
1232
raise NotImplementedError(self.set_push_location)
1234
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1235
"""Run the post_change_branch_tip hooks."""
1236
hooks = Branch.hooks['post_change_branch_tip']
1239
new_revno, new_revid = self.last_revision_info()
1240
params = ChangeBranchTipParams(
1241
self, old_revno, new_revno, old_revid, new_revid)
1245
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1246
"""Run the pre_change_branch_tip hooks."""
1247
hooks = Branch.hooks['pre_change_branch_tip']
1250
old_revno, old_revid = self.last_revision_info()
1251
params = ChangeBranchTipParams(
1252
self, old_revno, new_revno, old_revid, new_revid)
1258
"""Synchronise this branch with the master branch if any.
1260
:return: None or the last_revision pivoted out during the update.
1264
def check_revno(self, revno):
1266
Check whether a revno corresponds to any revision.
1267
Zero (the NULL revision) is considered valid.
1270
self.check_real_revno(revno)
1272
def check_real_revno(self, revno):
1274
Check whether a revno corresponds to a real revision.
1275
Zero (the NULL revision) is considered invalid
1277
if revno < 1 or revno > self.revno():
1278
raise errors.InvalidRevisionNumber(revno)
1281
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1282
"""Clone this branch into to_bzrdir preserving all semantic values.
1284
Most API users will want 'create_clone_on_transport', which creates a
1285
new bzrdir and branch on the fly.
1287
revision_id: if not None, the revision history in the new branch will
1288
be truncated to end with revision_id.
1290
result = to_bzrdir.create_branch()
1293
if repository_policy is not None:
1294
repository_policy.configure_branch(result)
1295
self.copy_content_into(result, revision_id=revision_id)
1301
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
1303
"""Create a new line of development from the branch, into to_bzrdir.
1305
to_bzrdir controls the branch format.
1307
revision_id: if not None, the revision history in the new branch will
1308
be truncated to end with revision_id.
1310
if (repository_policy is not None and
1311
repository_policy.requires_stacking()):
1312
to_bzrdir._format.require_stacking(_skip_repo=True)
1313
result = to_bzrdir.create_branch(repository=repository)
1316
if repository_policy is not None:
1317
repository_policy.configure_branch(result)
1318
self.copy_content_into(result, revision_id=revision_id)
1319
master_url = self.get_bound_location()
1320
if master_url is None:
1321
result.set_parent(self.bzrdir.root_transport.base)
1323
result.set_parent(master_url)
1328
def _synchronize_history(self, destination, revision_id):
1329
"""Synchronize last revision and revision history between branches.
1331
This version is most efficient when the destination is also a
1332
BzrBranch6, but works for BzrBranch5, as long as the destination's
1333
repository contains all the lefthand ancestors of the intended
1334
last_revision. If not, set_last_revision_info will fail.
1336
:param destination: The branch to copy the history into
1337
:param revision_id: The revision-id to truncate history at. May
1338
be None to copy complete history.
1340
source_revno, source_revision_id = self.last_revision_info()
1341
if revision_id is None:
1342
revno, revision_id = source_revno, source_revision_id
1344
graph = self.repository.get_graph()
1346
revno = graph.find_distance_to_null(revision_id,
1347
[(source_revision_id, source_revno)])
1348
except errors.GhostRevisionsHaveNoRevno:
1349
# Default to 1, if we can't find anything else
1351
destination.set_last_revision_info(revno, revision_id)
1353
def copy_content_into(self, destination, revision_id=None):
1354
"""Copy the content of self into destination.
1356
revision_id: if not None, the revision history in the new branch will
1357
be truncated to end with revision_id.
1359
return InterBranch.get(self, destination).copy_content_into(
1360
revision_id=revision_id)
1362
def update_references(self, target):
1363
if not getattr(self._format, 'supports_reference_locations', False):
1365
reference_dict = self._get_all_reference_info()
1366
if len(reference_dict) == 0:
1368
old_base = self.base
1369
new_base = target.base
1370
target_reference_dict = target._get_all_reference_info()
1371
for file_id, (tree_path, branch_location) in (
1372
reference_dict.items()):
1373
branch_location = urlutils.rebase_url(branch_location,
1375
target_reference_dict.setdefault(
1376
file_id, (tree_path, branch_location))
1377
target._set_all_reference_info(target_reference_dict)
1380
def check(self, refs):
1381
"""Check consistency of the branch.
1383
In particular this checks that revisions given in the revision-history
1384
do actually match up in the revision graph, and that they're all
1385
present in the repository.
1387
Callers will typically also want to check the repository.
1389
:param refs: Calculated refs for this branch as specified by
1390
branch._get_check_refs()
1391
:return: A BranchCheckResult.
1393
result = BranchCheckResult(self)
1394
last_revno, last_revision_id = self.last_revision_info()
1395
actual_revno = refs[('lefthand-distance', last_revision_id)]
1396
if actual_revno != last_revno:
1397
result.errors.append(errors.BzrCheckError(
1398
'revno does not match len(mainline) %s != %s' % (
1399
last_revno, actual_revno)))
1400
# TODO: We should probably also check that self.revision_history
1401
# matches the repository for older branch formats.
1402
# If looking for the code that cross-checks repository parents against
1403
# the Graph.iter_lefthand_ancestry output, that is now a repository
1407
def _get_checkout_format(self, lightweight=False):
1408
"""Return the most suitable metadir for a checkout of this branch.
1409
Weaves are used if this branch's repository uses weaves.
1411
format = self.repository.bzrdir.checkout_metadir()
1412
format.set_branch_format(self._format)
1415
def create_clone_on_transport(self, to_transport, revision_id=None,
1416
stacked_on=None, create_prefix=False, use_existing_dir=False,
1418
"""Create a clone of this branch and its bzrdir.
1420
:param to_transport: The transport to clone onto.
1421
:param revision_id: The revision id to use as tip in the new branch.
1422
If None the tip is obtained from this branch.
1423
:param stacked_on: An optional URL to stack the clone on.
1424
:param create_prefix: Create any missing directories leading up to
1426
:param use_existing_dir: Use an existing directory if one exists.
1428
# XXX: Fix the bzrdir API to allow getting the branch back from the
1429
# clone call. Or something. 20090224 RBC/spiv.
1430
# XXX: Should this perhaps clone colocated branches as well,
1431
# rather than just the default branch? 20100319 JRV
1432
if revision_id is None:
1433
revision_id = self.last_revision()
1434
dir_to = self.bzrdir.clone_on_transport(to_transport,
1435
revision_id=revision_id, stacked_on=stacked_on,
1436
create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1438
return dir_to.open_branch()
1440
def create_checkout(self, to_location, revision_id=None,
1441
lightweight=False, accelerator_tree=None,
1443
"""Create a checkout of a branch.
1445
:param to_location: The url to produce the checkout at
1446
:param revision_id: The revision to check out
1447
:param lightweight: If True, produce a lightweight checkout, otherwise,
1448
produce a bound branch (heavyweight checkout)
1449
:param accelerator_tree: A tree which can be used for retrieving file
1450
contents more quickly than the revision tree, i.e. a workingtree.
1451
The revision tree will be used for cases where accelerator_tree's
1452
content is different.
1453
:param hardlink: If true, hard-link files from accelerator_tree,
1455
:return: The tree of the created checkout
1457
t = transport.get_transport(to_location)
1459
format = self._get_checkout_format(lightweight=lightweight)
1461
checkout = format.initialize_on_transport(t)
1462
except errors.AlreadyControlDirError:
1463
# It's fine if the control directory already exists,
1464
# as long as there is no existing branch and working tree.
1465
checkout = controldir.ControlDir.open_from_transport(t)
1467
checkout.open_branch()
1468
except errors.NotBranchError:
1471
raise errors.AlreadyControlDirError(t.base)
1474
from_branch = checkout.set_branch_reference(target_branch=self)
1476
policy = checkout.determine_repository_policy()
1477
repo = policy.acquire_repository()[0]
1478
checkout_branch = checkout.create_branch()
1479
checkout_branch.bind(self)
1480
# pull up to the specified revision_id to set the initial
1481
# branch tip correctly, and seed it with history.
1482
checkout_branch.pull(self, stop_revision=revision_id)
1484
tree = checkout.create_workingtree(revision_id,
1485
from_branch=from_branch,
1486
accelerator_tree=accelerator_tree,
1488
basis_tree = tree.basis_tree()
1489
basis_tree.lock_read()
1491
for path, file_id in basis_tree.iter_references():
1492
reference_parent = self.reference_parent(file_id, path)
1493
reference_parent.create_checkout(tree.abspath(path),
1494
basis_tree.get_reference_revision(file_id, path),
1501
def reconcile(self, thorough=True):
1502
"""Make sure the data stored in this branch is consistent."""
1503
from bzrlib.reconcile import BranchReconciler
1504
reconciler = BranchReconciler(self, thorough=thorough)
1505
reconciler.reconcile()
1508
def reference_parent(self, file_id, path, possible_transports=None):
1509
"""Return the parent branch for a tree-reference file_id
1511
:param file_id: The file_id of the tree reference
1512
:param path: The path of the file_id in the tree
1513
:return: A branch associated with the file_id
1515
# FIXME should provide multiple branches, based on config
1516
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1517
possible_transports=possible_transports)
1519
def supports_tags(self):
1520
return self._format.supports_tags()
1522
def automatic_tag_name(self, revision_id):
1523
"""Try to automatically find the tag name for a revision.
1525
:param revision_id: Revision id of the revision.
1526
:return: A tag name or None if no tag name could be determined.
1528
for hook in Branch.hooks['automatic_tag_name']:
1529
ret = hook(self, revision_id)
1534
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1536
"""Ensure that revision_b is a descendant of revision_a.
1538
This is a helper function for update_revisions.
1540
:raises: DivergedBranches if revision_b has diverged from revision_a.
1541
:returns: True if revision_b is a descendant of revision_a.
1543
relation = self._revision_relations(revision_a, revision_b, graph)
1544
if relation == 'b_descends_from_a':
1546
elif relation == 'diverged':
1547
raise errors.DivergedBranches(self, other_branch)
1548
elif relation == 'a_descends_from_b':
1551
raise AssertionError("invalid relation: %r" % (relation,))
1553
def _revision_relations(self, revision_a, revision_b, graph):
1554
"""Determine the relationship between two revisions.
1556
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1558
heads = graph.heads([revision_a, revision_b])
1559
if heads == set([revision_b]):
1560
return 'b_descends_from_a'
1561
elif heads == set([revision_a, revision_b]):
1562
# These branches have diverged
1564
elif heads == set([revision_a]):
1565
return 'a_descends_from_b'
1567
raise AssertionError("invalid heads: %r" % (heads,))
1569
def heads_to_fetch(self):
1570
"""Return the heads that must and that should be fetched to copy this
1571
branch into another repo.
1573
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1574
set of heads that must be fetched. if_present_fetch is a set of
1575
heads that must be fetched if present, but no error is necessary if
1576
they are not present.
1578
# For bzr native formats must_fetch is just the tip, and
1579
# if_present_fetch are the tags.
1580
must_fetch = set([self.last_revision()])
1581
if_present_fetch = set()
1582
if self.get_config_stack().get('branch.fetch_tags'):
1584
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1585
except errors.TagsNotSupported:
1587
must_fetch.discard(_mod_revision.NULL_REVISION)
1588
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1589
return must_fetch, if_present_fetch
1592
class BranchFormat(controldir.ControlComponentFormat):
1593
"""An encapsulation of the initialization and open routines for a format.
1595
Formats provide three things:
1596
* An initialization routine,
1597
* a format description
1600
Formats are placed in an dict by their format string for reference
1601
during branch opening. It's not required that these be instances, they
1602
can be classes themselves with class methods - it simply depends on
1603
whether state is needed for a given format or not.
1605
Once a format is deprecated, just deprecate the initialize and open
1606
methods on the format class. Do not deprecate the object, as the
1607
object will be created every time regardless.
1610
def __eq__(self, other):
1611
return self.__class__ is other.__class__
1613
def __ne__(self, other):
1614
return not (self == other)
1617
@deprecated_method(deprecated_in((2, 4, 0)))
1618
def get_default_format(klass):
1619
"""Return the current default format."""
1620
return format_registry.get_default()
1623
@deprecated_method(deprecated_in((2, 4, 0)))
1624
def get_formats(klass):
1625
"""Get all the known formats.
1627
Warning: This triggers a load of all lazy registered formats: do not
1628
use except when that is desireed.
1630
return format_registry._get_all()
1632
def get_reference(self, controldir, name=None):
1633
"""Get the target reference of the branch in controldir.
1635
format probing must have been completed before calling
1636
this method - it is assumed that the format of the branch
1637
in controldir is correct.
1639
:param controldir: The controldir to get the branch data from.
1640
:param name: Name of the colocated branch to fetch
1641
:return: None if the branch is not a reference branch.
1646
def set_reference(self, controldir, name, to_branch):
1647
"""Set the target reference of the branch in controldir.
1649
format probing must have been completed before calling
1650
this method - it is assumed that the format of the branch
1651
in controldir is correct.
1653
:param controldir: The controldir to set the branch reference for.
1654
:param name: Name of colocated branch to set, None for default
1655
:param to_branch: branch that the checkout is to reference
1657
raise NotImplementedError(self.set_reference)
1659
def get_format_description(self):
1660
"""Return the short format description for this format."""
1661
raise NotImplementedError(self.get_format_description)
1663
def _run_post_branch_init_hooks(self, controldir, name, branch):
1664
hooks = Branch.hooks['post_branch_init']
1667
params = BranchInitHookParams(self, controldir, name, branch)
1671
def initialize(self, controldir, name=None, repository=None,
1672
append_revisions_only=None):
1673
"""Create a branch of this format in controldir.
1675
:param name: Name of the colocated branch to create.
1677
raise NotImplementedError(self.initialize)
1679
def is_supported(self):
1680
"""Is this format supported?
1682
Supported formats can be initialized and opened.
1683
Unsupported formats may not support initialization or committing or
1684
some other features depending on the reason for not being supported.
1688
def make_tags(self, branch):
1689
"""Create a tags object for branch.
1691
This method is on BranchFormat, because BranchFormats are reflected
1692
over the wire via network_name(), whereas full Branch instances require
1693
multiple VFS method calls to operate at all.
1695
The default implementation returns a disabled-tags instance.
1697
Note that it is normal for branch to be a RemoteBranch when using tags
1700
return _mod_tag.DisabledTags(branch)
1702
def network_name(self):
1703
"""A simple byte string uniquely identifying this format for RPC calls.
1705
MetaDir branch formats use their disk format string to identify the
1706
repository over the wire. All in one formats such as bzr < 0.8, and
1707
foreign formats like svn/git and hg should use some marker which is
1708
unique and immutable.
1710
raise NotImplementedError(self.network_name)
1712
def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
1713
found_repository=None, possible_transports=None):
1714
"""Return the branch object for controldir.
1716
:param controldir: A ControlDir that contains a branch.
1717
:param name: Name of colocated branch to open
1718
:param _found: a private parameter, do not use it. It is used to
1719
indicate if format probing has already be done.
1720
:param ignore_fallbacks: when set, no fallback branches will be opened
1721
(if there are any). Default is to open fallbacks.
1723
raise NotImplementedError(self.open)
1726
@deprecated_method(deprecated_in((2, 4, 0)))
1727
def register_format(klass, format):
1728
"""Register a metadir format.
1730
See MetaDirBranchFormatFactory for the ability to register a format
1731
without loading the code the format needs until it is actually used.
1733
format_registry.register(format)
1736
@deprecated_method(deprecated_in((2, 4, 0)))
1737
def set_default_format(klass, format):
1738
format_registry.set_default(format)
1740
def supports_set_append_revisions_only(self):
1741
"""True if this format supports set_append_revisions_only."""
1744
def supports_stacking(self):
1745
"""True if this format records a stacked-on branch."""
1748
def supports_leaving_lock(self):
1749
"""True if this format supports leaving locks in place."""
1750
return False # by default
1753
@deprecated_method(deprecated_in((2, 4, 0)))
1754
def unregister_format(klass, format):
1755
format_registry.remove(format)
1758
return self.get_format_description().rstrip()
1760
def supports_tags(self):
1761
"""True if this format supports tags stored in the branch"""
1762
return False # by default
1764
def tags_are_versioned(self):
1765
"""Whether the tag container for this branch versions tags."""
1768
def supports_tags_referencing_ghosts(self):
1769
"""True if tags can reference ghost revisions."""
1773
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1774
"""A factory for a BranchFormat object, permitting simple lazy registration.
1776
While none of the built in BranchFormats are lazy registered yet,
1777
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1778
use it, and the bzr-loom plugin uses it as well (see
1779
bzrlib.plugins.loom.formats).
1782
def __init__(self, format_string, module_name, member_name):
1783
"""Create a MetaDirBranchFormatFactory.
1785
:param format_string: The format string the format has.
1786
:param module_name: Module to load the format class from.
1787
:param member_name: Attribute name within the module for the format class.
1789
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1790
self._format_string = format_string
1792
def get_format_string(self):
1793
"""See BranchFormat.get_format_string."""
1794
return self._format_string
1797
"""Used for network_format_registry support."""
1798
return self.get_obj()()
1801
class BranchHooks(Hooks):
1802
"""A dictionary mapping hook name to a list of callables for branch hooks.
1804
e.g. ['set_rh'] Is the list of items to be called when the
1805
set_revision_history function is invoked.
1809
"""Create the default hooks.
1811
These are all empty initially, because by default nothing should get
1814
Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1815
self.add_hook('set_rh',
1816
"Invoked whenever the revision history has been set via "
1817
"set_revision_history. The api signature is (branch, "
1818
"revision_history), and the branch will be write-locked. "
1819
"The set_rh hook can be expensive for bzr to trigger, a better "
1820
"hook to use is Branch.post_change_branch_tip.", (0, 15))
1821
self.add_hook('open',
1822
"Called with the Branch object that has been opened after a "
1823
"branch is opened.", (1, 8))
1824
self.add_hook('post_push',
1825
"Called after a push operation completes. post_push is called "
1826
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1827
"bzr client.", (0, 15))
1828
self.add_hook('post_pull',
1829
"Called after a pull operation completes. post_pull is called "
1830
"with a bzrlib.branch.PullResult object and only runs in the "
1831
"bzr client.", (0, 15))
1832
self.add_hook('pre_commit',
1833
"Called after a commit is calculated but before it is "
1834
"completed. pre_commit is called with (local, master, old_revno, "
1835
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1836
"). old_revid is NULL_REVISION for the first commit to a branch, "
1837
"tree_delta is a TreeDelta object describing changes from the "
1838
"basis revision. hooks MUST NOT modify this delta. "
1839
" future_tree is an in-memory tree obtained from "
1840
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1842
self.add_hook('post_commit',
1843
"Called in the bzr client after a commit has completed. "
1844
"post_commit is called with (local, master, old_revno, old_revid, "
1845
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1846
"commit to a branch.", (0, 15))
1847
self.add_hook('post_uncommit',
1848
"Called in the bzr client after an uncommit completes. "
1849
"post_uncommit is called with (local, master, old_revno, "
1850
"old_revid, new_revno, new_revid) where local is the local branch "
1851
"or None, master is the target branch, and an empty branch "
1852
"receives new_revno of 0, new_revid of None.", (0, 15))
1853
self.add_hook('pre_change_branch_tip',
1854
"Called in bzr client and server before a change to the tip of a "
1855
"branch is made. pre_change_branch_tip is called with a "
1856
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1857
"commit, uncommit will all trigger this hook.", (1, 6))
1858
self.add_hook('post_change_branch_tip',
1859
"Called in bzr client and server after a change to the tip of a "
1860
"branch is made. post_change_branch_tip is called with a "
1861
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1862
"commit, uncommit will all trigger this hook.", (1, 4))
1863
self.add_hook('transform_fallback_location',
1864
"Called when a stacked branch is activating its fallback "
1865
"locations. transform_fallback_location is called with (branch, "
1866
"url), and should return a new url. Returning the same url "
1867
"allows it to be used as-is, returning a different one can be "
1868
"used to cause the branch to stack on a closer copy of that "
1869
"fallback_location. Note that the branch cannot have history "
1870
"accessing methods called on it during this hook because the "
1871
"fallback locations have not been activated. When there are "
1872
"multiple hooks installed for transform_fallback_location, "
1873
"all are called with the url returned from the previous hook."
1874
"The order is however undefined.", (1, 9))
1875
self.add_hook('automatic_tag_name',
1876
"Called to determine an automatic tag name for a revision. "
1877
"automatic_tag_name is called with (branch, revision_id) and "
1878
"should return a tag name or None if no tag name could be "
1879
"determined. The first non-None tag name returned will be used.",
1881
self.add_hook('post_branch_init',
1882
"Called after new branch initialization completes. "
1883
"post_branch_init is called with a "
1884
"bzrlib.branch.BranchInitHookParams. "
1885
"Note that init, branch and checkout (both heavyweight and "
1886
"lightweight) will all trigger this hook.", (2, 2))
1887
self.add_hook('post_switch',
1888
"Called after a checkout switches branch. "
1889
"post_switch is called with a "
1890
"bzrlib.branch.SwitchHookParams.", (2, 2))
1894
# install the default hooks into the Branch class.
1895
Branch.hooks = BranchHooks()
1898
class ChangeBranchTipParams(object):
1899
"""Object holding parameters passed to `*_change_branch_tip` hooks.
1901
There are 5 fields that hooks may wish to access:
1903
:ivar branch: the branch being changed
1904
:ivar old_revno: revision number before the change
1905
:ivar new_revno: revision number after the change
1906
:ivar old_revid: revision id before the change
1907
:ivar new_revid: revision id after the change
1909
The revid fields are strings. The revno fields are integers.
1912
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1913
"""Create a group of ChangeBranchTip parameters.
1915
:param branch: The branch being changed.
1916
:param old_revno: Revision number before the change.
1917
:param new_revno: Revision number after the change.
1918
:param old_revid: Tip revision id before the change.
1919
:param new_revid: Tip revision id after the change.
1921
self.branch = branch
1922
self.old_revno = old_revno
1923
self.new_revno = new_revno
1924
self.old_revid = old_revid
1925
self.new_revid = new_revid
1927
def __eq__(self, other):
1928
return self.__dict__ == other.__dict__
1931
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1932
self.__class__.__name__, self.branch,
1933
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1936
class BranchInitHookParams(object):
1937
"""Object holding parameters passed to `*_branch_init` hooks.
1939
There are 4 fields that hooks may wish to access:
1941
:ivar format: the branch format
1942
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1943
:ivar name: name of colocated branch, if any (or None)
1944
:ivar branch: the branch created
1946
Note that for lightweight checkouts, the bzrdir and format fields refer to
1947
the checkout, hence they are different from the corresponding fields in
1948
branch, which refer to the original branch.
1951
def __init__(self, format, controldir, name, branch):
1952
"""Create a group of BranchInitHook parameters.
1954
:param format: the branch format
1955
:param controldir: the ControlDir where the branch will be/has been
1957
:param name: name of colocated branch, if any (or None)
1958
:param branch: the branch created
1960
Note that for lightweight checkouts, the bzrdir and format fields refer
1961
to the checkout, hence they are different from the corresponding fields
1962
in branch, which refer to the original branch.
1964
self.format = format
1965
self.bzrdir = controldir
1967
self.branch = branch
1969
def __eq__(self, other):
1970
return self.__dict__ == other.__dict__
1973
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1976
class SwitchHookParams(object):
1977
"""Object holding parameters passed to `*_switch` hooks.
1979
There are 4 fields that hooks may wish to access:
1981
:ivar control_dir: ControlDir of the checkout to change
1982
:ivar to_branch: branch that the checkout is to reference
1983
:ivar force: skip the check for local commits in a heavy checkout
1984
:ivar revision_id: revision ID to switch to (or None)
1987
def __init__(self, control_dir, to_branch, force, revision_id):
1988
"""Create a group of SwitchHook parameters.
1990
:param control_dir: ControlDir of the checkout to change
1991
:param to_branch: branch that the checkout is to reference
1992
:param force: skip the check for local commits in a heavy checkout
1993
:param revision_id: revision ID to switch to (or None)
1995
self.control_dir = control_dir
1996
self.to_branch = to_branch
1998
self.revision_id = revision_id
2000
def __eq__(self, other):
2001
return self.__dict__ == other.__dict__
2004
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
2005
self.control_dir, self.to_branch,
2009
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
2010
"""Base class for branch formats that live in meta directories.
2014
BranchFormat.__init__(self)
2015
bzrdir.BzrFormat.__init__(self)
2018
def find_format(klass, controldir, name=None):
2019
"""Return the format for the branch object in controldir."""
2021
transport = controldir.get_branch_transport(None, name=name)
2022
except errors.NoSuchFile:
2023
raise errors.NotBranchError(path=name, bzrdir=controldir)
2025
format_string = transport.get_bytes("format")
2026
except errors.NoSuchFile:
2027
raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
2028
return klass._find_format(format_registry, 'branch', format_string)
2030
def _branch_class(self):
2031
"""What class to instantiate on open calls."""
2032
raise NotImplementedError(self._branch_class)
2034
def _get_initial_config(self, append_revisions_only=None):
2035
if append_revisions_only:
2036
return "append_revisions_only = True\n"
2038
# Avoid writing anything if append_revisions_only is disabled,
2039
# as that is the default.
2042
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
2044
"""Initialize a branch in a bzrdir, with specified files
2046
:param a_bzrdir: The bzrdir to initialize the branch in
2047
:param utf8_files: The files to create as a list of
2048
(filename, content) tuples
2049
:param name: Name of colocated branch to create, if any
2050
:return: a branch in this format
2053
name = a_bzrdir._get_selected_branch()
2054
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2055
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2056
control_files = lockable_files.LockableFiles(branch_transport,
2057
'lock', lockdir.LockDir)
2058
control_files.create_lock()
2059
control_files.lock_write()
2061
utf8_files += [('format', self.as_string())]
2062
for (filename, content) in utf8_files:
2063
branch_transport.put_bytes(
2065
mode=a_bzrdir._get_file_mode())
2067
control_files.unlock()
2068
branch = self.open(a_bzrdir, name, _found=True,
2069
found_repository=repository)
2070
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2073
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2074
found_repository=None, possible_transports=None):
2075
"""See BranchFormat.open()."""
2077
name = a_bzrdir._get_selected_branch()
2079
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2080
if format.__class__ != self.__class__:
2081
raise AssertionError("wrong format %r found for %r" %
2083
transport = a_bzrdir.get_branch_transport(None, name=name)
2085
control_files = lockable_files.LockableFiles(transport, 'lock',
2087
if found_repository is None:
2088
found_repository = a_bzrdir.find_repository()
2089
return self._branch_class()(_format=self,
2090
_control_files=control_files,
2093
_repository=found_repository,
2094
ignore_fallbacks=ignore_fallbacks,
2095
possible_transports=possible_transports)
2096
except errors.NoSuchFile:
2097
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2100
def _matchingbzrdir(self):
2101
ret = bzrdir.BzrDirMetaFormat1()
2102
ret.set_branch_format(self)
2105
def supports_tags(self):
2108
def supports_leaving_lock(self):
2111
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
2113
BranchFormat.check_support_status(self,
2114
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
2116
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
2117
recommend_upgrade=recommend_upgrade, basedir=basedir)
2120
class BzrBranchFormat5(BranchFormatMetadir):
2121
"""Bzr branch format 5.
2124
- a revision-history file.
2126
- a lock dir guarding the branch itself
2127
- all of this stored in a branch/ subdirectory
2128
- works with shared repositories.
2130
This format is new in bzr 0.8.
2133
def _branch_class(self):
2137
def get_format_string(cls):
2138
"""See BranchFormat.get_format_string()."""
2139
return "Bazaar-NG branch format 5\n"
2141
def get_format_description(self):
2142
"""See BranchFormat.get_format_description()."""
2143
return "Branch format 5"
2145
def initialize(self, a_bzrdir, name=None, repository=None,
2146
append_revisions_only=None):
2147
"""Create a branch of this format in a_bzrdir."""
2148
if append_revisions_only:
2149
raise errors.UpgradeRequired(a_bzrdir.user_url)
2150
utf8_files = [('revision-history', ''),
2151
('branch-name', ''),
2153
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2155
def supports_tags(self):
2159
class BzrBranchFormat6(BranchFormatMetadir):
2160
"""Branch format with last-revision and tags.
2162
Unlike previous formats, this has no explicit revision history. Instead,
2163
this just stores the last-revision, and the left-hand history leading
2164
up to there is the history.
2166
This format was introduced in bzr 0.15
2167
and became the default in 0.91.
2170
def _branch_class(self):
2174
def get_format_string(cls):
2175
"""See BranchFormat.get_format_string()."""
2176
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2178
def get_format_description(self):
2179
"""See BranchFormat.get_format_description()."""
2180
return "Branch format 6"
2182
def initialize(self, a_bzrdir, name=None, repository=None,
2183
append_revisions_only=None):
2184
"""Create a branch of this format in a_bzrdir."""
2185
utf8_files = [('last-revision', '0 null:\n'),
2187
self._get_initial_config(append_revisions_only)),
2190
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2192
def make_tags(self, branch):
2193
"""See bzrlib.branch.BranchFormat.make_tags()."""
2194
return _mod_tag.BasicTags(branch)
2196
def supports_set_append_revisions_only(self):
2200
class BzrBranchFormat8(BranchFormatMetadir):
2201
"""Metadir format supporting storing locations of subtree branches."""
2203
def _branch_class(self):
2207
def get_format_string(cls):
2208
"""See BranchFormat.get_format_string()."""
2209
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2211
def get_format_description(self):
2212
"""See BranchFormat.get_format_description()."""
2213
return "Branch format 8"
2215
def initialize(self, a_bzrdir, name=None, repository=None,
2216
append_revisions_only=None):
2217
"""Create a branch of this format in a_bzrdir."""
2218
utf8_files = [('last-revision', '0 null:\n'),
2220
self._get_initial_config(append_revisions_only)),
2224
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2226
def make_tags(self, branch):
2227
"""See bzrlib.branch.BranchFormat.make_tags()."""
2228
return _mod_tag.BasicTags(branch)
2230
def supports_set_append_revisions_only(self):
2233
def supports_stacking(self):
2236
supports_reference_locations = True
2239
class BzrBranchFormat7(BranchFormatMetadir):
2240
"""Branch format with last-revision, tags, and a stacked location pointer.
2242
The stacked location pointer is passed down to the repository and requires
2243
a repository format with supports_external_lookups = True.
2245
This format was introduced in bzr 1.6.
2248
def initialize(self, a_bzrdir, name=None, repository=None,
2249
append_revisions_only=None):
2250
"""Create a branch of this format in a_bzrdir."""
2251
utf8_files = [('last-revision', '0 null:\n'),
2253
self._get_initial_config(append_revisions_only)),
2256
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2258
def _branch_class(self):
2262
def get_format_string(cls):
2263
"""See BranchFormat.get_format_string()."""
2264
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2266
def get_format_description(self):
2267
"""See BranchFormat.get_format_description()."""
2268
return "Branch format 7"
2270
def supports_set_append_revisions_only(self):
2273
def supports_stacking(self):
2276
def make_tags(self, branch):
2277
"""See bzrlib.branch.BranchFormat.make_tags()."""
2278
return _mod_tag.BasicTags(branch)
2280
supports_reference_locations = False
2283
class BranchReferenceFormat(BranchFormatMetadir):
2284
"""Bzr branch reference format.
2286
Branch references are used in implementing checkouts, they
2287
act as an alias to the real branch which is at some other url.
2295
def get_format_string(cls):
2296
"""See BranchFormat.get_format_string()."""
2297
return "Bazaar-NG Branch Reference Format 1\n"
2299
def get_format_description(self):
2300
"""See BranchFormat.get_format_description()."""
2301
return "Checkout reference format 1"
2303
def get_reference(self, a_bzrdir, name=None):
2304
"""See BranchFormat.get_reference()."""
2305
transport = a_bzrdir.get_branch_transport(None, name=name)
2306
return transport.get_bytes('location')
2308
def set_reference(self, a_bzrdir, name, to_branch):
2309
"""See BranchFormat.set_reference()."""
2310
transport = a_bzrdir.get_branch_transport(None, name=name)
2311
location = transport.put_bytes('location', to_branch.base)
2313
def initialize(self, a_bzrdir, name=None, target_branch=None,
2314
repository=None, append_revisions_only=None):
2315
"""Create a branch of this format in a_bzrdir."""
2316
if target_branch is None:
2317
# this format does not implement branch itself, thus the implicit
2318
# creation contract must see it as uninitializable
2319
raise errors.UninitializableFormat(self)
2320
mutter('creating branch reference in %s', a_bzrdir.user_url)
2321
if a_bzrdir._format.fixed_components:
2322
raise errors.IncompatibleFormat(self, a_bzrdir._format)
2324
name = a_bzrdir._get_selected_branch()
2325
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2326
branch_transport.put_bytes('location',
2327
target_branch.user_url)
2328
branch_transport.put_bytes('format', self.as_string())
2329
branch = self.open(a_bzrdir, name, _found=True,
2330
possible_transports=[target_branch.bzrdir.root_transport])
2331
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2334
def _make_reference_clone_function(format, a_branch):
2335
"""Create a clone() routine for a branch dynamically."""
2336
def clone(to_bzrdir, revision_id=None,
2337
repository_policy=None):
2338
"""See Branch.clone()."""
2339
return format.initialize(to_bzrdir, target_branch=a_branch)
2340
# cannot obey revision_id limits when cloning a reference ...
2341
# FIXME RBC 20060210 either nuke revision_id for clone, or
2342
# emit some sort of warning/error to the caller ?!
2345
def open(self, a_bzrdir, name=None, _found=False, location=None,
2346
possible_transports=None, ignore_fallbacks=False,
2347
found_repository=None):
2348
"""Return the branch that the branch reference in a_bzrdir points at.
2350
:param a_bzrdir: A BzrDir that contains a branch.
2351
:param name: Name of colocated branch to open, if any
2352
:param _found: a private parameter, do not use it. It is used to
2353
indicate if format probing has already be done.
2354
:param ignore_fallbacks: when set, no fallback branches will be opened
2355
(if there are any). Default is to open fallbacks.
2356
:param location: The location of the referenced branch. If
2357
unspecified, this will be determined from the branch reference in
2359
:param possible_transports: An optional reusable transports list.
2362
name = a_bzrdir._get_selected_branch()
2364
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2365
if format.__class__ != self.__class__:
2366
raise AssertionError("wrong format %r found for %r" %
2368
if location is None:
2369
location = self.get_reference(a_bzrdir, name)
2370
real_bzrdir = controldir.ControlDir.open(
2371
location, possible_transports=possible_transports)
2372
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks,
2373
possible_transports=possible_transports)
2374
# this changes the behaviour of result.clone to create a new reference
2375
# rather than a copy of the content of the branch.
2376
# I did not use a proxy object because that needs much more extensive
2377
# testing, and we are only changing one behaviour at the moment.
2378
# If we decide to alter more behaviours - i.e. the implicit nickname
2379
# then this should be refactored to introduce a tested proxy branch
2380
# and a subclass of that for use in overriding clone() and ....
2382
result.clone = self._make_reference_clone_function(result)
2386
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2387
"""Branch format registry."""
2389
def __init__(self, other_registry=None):
2390
super(BranchFormatRegistry, self).__init__(other_registry)
2391
self._default_format = None
2393
def set_default(self, format):
2394
self._default_format = format
2396
def get_default(self):
2397
return self._default_format
2400
network_format_registry = registry.FormatRegistry()
2401
"""Registry of formats indexed by their network name.
2403
The network name for a branch format is an identifier that can be used when
2404
referring to formats with smart server operations. See
2405
BranchFormat.network_name() for more detail.
2408
format_registry = BranchFormatRegistry(network_format_registry)
2411
# formats which have no format string are not discoverable
2412
# and not independently creatable, so are not registered.
2413
__format5 = BzrBranchFormat5()
2414
__format6 = BzrBranchFormat6()
2415
__format7 = BzrBranchFormat7()
2416
__format8 = BzrBranchFormat8()
2417
format_registry.register(__format5)
2418
format_registry.register(BranchReferenceFormat())
2419
format_registry.register(__format6)
2420
format_registry.register(__format7)
2421
format_registry.register(__format8)
2422
format_registry.set_default(__format7)
2425
class BranchWriteLockResult(LogicalLockResult):
2426
"""The result of write locking a branch.
2428
:ivar branch_token: The token obtained from the underlying branch lock, or
2430
:ivar unlock: A callable which will unlock the lock.
2433
def __init__(self, unlock, branch_token):
2434
LogicalLockResult.__init__(self, unlock)
2435
self.branch_token = branch_token
2438
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2442
class BzrBranch(Branch, _RelockDebugMixin):
2443
"""A branch stored in the actual filesystem.
2445
Note that it's "local" in the context of the filesystem; it doesn't
2446
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2447
it's writable, and can be accessed via the normal filesystem API.
2449
:ivar _transport: Transport for file operations on this branch's
2450
control files, typically pointing to the .bzr/branch directory.
2451
:ivar repository: Repository for this branch.
2452
:ivar base: The url of the base directory for this branch; the one
2453
containing the .bzr directory.
2454
:ivar name: Optional colocated branch name as it exists in the control
2458
def __init__(self, _format=None,
2459
_control_files=None, a_bzrdir=None, name=None,
2460
_repository=None, ignore_fallbacks=False,
2461
possible_transports=None):
2462
"""Create new branch object at a particular location."""
2463
if a_bzrdir is None:
2464
raise ValueError('a_bzrdir must be supplied')
2466
raise ValueError('name must be supplied')
2467
self.bzrdir = a_bzrdir
2468
self._user_transport = self.bzrdir.transport.clone('..')
2470
self._user_transport.set_segment_parameter(
2471
"branch", urlutils.escape(name))
2472
self._base = self._user_transport.base
2474
self._format = _format
2475
if _control_files is None:
2476
raise ValueError('BzrBranch _control_files is None')
2477
self.control_files = _control_files
2478
self._transport = _control_files._transport
2479
self.repository = _repository
2480
Branch.__init__(self, possible_transports)
2483
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2487
def _get_base(self):
2488
"""Returns the directory containing the control directory."""
2491
base = property(_get_base, doc="The URL for the root of this branch.")
2494
def user_transport(self):
2495
return self._user_transport
2497
def _get_config(self):
2498
return _mod_config.TransportConfig(self._transport, 'branch.conf')
2500
def _get_config_store(self):
2501
return _mod_config.BranchStore(self)
2503
def is_locked(self):
2504
return self.control_files.is_locked()
2506
def lock_write(self, token=None):
2507
"""Lock the branch for write operations.
2509
:param token: A token to permit reacquiring a previously held and
2511
:return: A BranchWriteLockResult.
2513
if not self.is_locked():
2514
self._note_lock('w')
2515
# All-in-one needs to always unlock/lock.
2516
repo_control = getattr(self.repository, 'control_files', None)
2517
if self.control_files == repo_control or not self.is_locked():
2518
self.repository._warn_if_deprecated(self)
2519
self.repository.lock_write()
2524
return BranchWriteLockResult(self.unlock,
2525
self.control_files.lock_write(token=token))
2528
self.repository.unlock()
2531
def lock_read(self):
2532
"""Lock the branch for read operations.
2534
:return: A bzrlib.lock.LogicalLockResult.
2536
if not self.is_locked():
2537
self._note_lock('r')
2538
# All-in-one needs to always unlock/lock.
2539
repo_control = getattr(self.repository, 'control_files', None)
2540
if self.control_files == repo_control or not self.is_locked():
2541
self.repository._warn_if_deprecated(self)
2542
self.repository.lock_read()
2547
self.control_files.lock_read()
2548
return LogicalLockResult(self.unlock)
2551
self.repository.unlock()
2554
@only_raises(errors.LockNotHeld, errors.LockBroken)
2557
self.control_files.unlock()
2559
# All-in-one needs to always unlock/lock.
2560
repo_control = getattr(self.repository, 'control_files', None)
2561
if (self.control_files == repo_control or
2562
not self.control_files.is_locked()):
2563
self.repository.unlock()
2564
if not self.control_files.is_locked():
2565
# we just released the lock
2566
self._clear_cached_state()
2568
def peek_lock_mode(self):
2569
if self.control_files._lock_count == 0:
2572
return self.control_files._lock_mode
2574
def get_physical_lock_status(self):
2575
return self.control_files.get_physical_lock_status()
2578
def print_file(self, file, revision_id):
2579
"""See Branch.print_file."""
2580
return self.repository.print_file(file, revision_id)
2583
def set_last_revision_info(self, revno, revision_id):
2584
if not revision_id or not isinstance(revision_id, basestring):
2585
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2586
revision_id = _mod_revision.ensure_null(revision_id)
2587
old_revno, old_revid = self.last_revision_info()
2588
if self.get_append_revisions_only():
2589
self._check_history_violation(revision_id)
2590
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2591
self._write_last_revision_info(revno, revision_id)
2592
self._clear_cached_state()
2593
self._last_revision_info_cache = revno, revision_id
2594
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2596
def basis_tree(self):
2597
"""See Branch.basis_tree."""
2598
return self.repository.revision_tree(self.last_revision())
2600
def _get_parent_location(self):
2601
_locs = ['parent', 'pull', 'x-pull']
2604
return self._transport.get_bytes(l).strip('\n')
2605
except errors.NoSuchFile:
2609
def get_stacked_on_url(self):
2610
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2612
def set_push_location(self, location):
2613
"""See Branch.set_push_location."""
2614
self.get_config().set_user_option(
2615
'push_location', location,
2616
store=_mod_config.STORE_LOCATION_NORECURSE)
2618
def _set_parent_location(self, url):
2620
self._transport.delete('parent')
2622
self._transport.put_bytes('parent', url + '\n',
2623
mode=self.bzrdir._get_file_mode())
2627
"""If bound, unbind"""
2628
return self.set_bound_location(None)
2631
def bind(self, other):
2632
"""Bind this branch to the branch other.
2634
This does not push or pull data between the branches, though it does
2635
check for divergence to raise an error when the branches are not
2636
either the same, or one a prefix of the other. That behaviour may not
2637
be useful, so that check may be removed in future.
2639
:param other: The branch to bind to
2642
# TODO: jam 20051230 Consider checking if the target is bound
2643
# It is debatable whether you should be able to bind to
2644
# a branch which is itself bound.
2645
# Committing is obviously forbidden,
2646
# but binding itself may not be.
2647
# Since we *have* to check at commit time, we don't
2648
# *need* to check here
2650
# we want to raise diverged if:
2651
# last_rev is not in the other_last_rev history, AND
2652
# other_last_rev is not in our history, and do it without pulling
2654
self.set_bound_location(other.base)
2656
def get_bound_location(self):
2658
return self._transport.get_bytes('bound')[:-1]
2659
except errors.NoSuchFile:
2663
def get_master_branch(self, possible_transports=None):
2664
"""Return the branch we are bound to.
2666
:return: Either a Branch, or None
2668
if self._master_branch_cache is None:
2669
self._master_branch_cache = self._get_master_branch(
2670
possible_transports)
2671
return self._master_branch_cache
2673
def _get_master_branch(self, possible_transports):
2674
bound_loc = self.get_bound_location()
2678
return Branch.open(bound_loc,
2679
possible_transports=possible_transports)
2680
except (errors.NotBranchError, errors.ConnectionError), e:
2681
raise errors.BoundBranchConnectionFailure(
2685
def set_bound_location(self, location):
2686
"""Set the target where this branch is bound to.
2688
:param location: URL to the target branch
2690
self._master_branch_cache = None
2692
self._transport.put_bytes('bound', location+'\n',
2693
mode=self.bzrdir._get_file_mode())
2696
self._transport.delete('bound')
2697
except errors.NoSuchFile:
2702
def update(self, possible_transports=None):
2703
"""Synchronise this branch with the master branch if any.
2705
:return: None or the last_revision that was pivoted out during the
2708
master = self.get_master_branch(possible_transports)
2709
if master is not None:
2710
old_tip = _mod_revision.ensure_null(self.last_revision())
2711
self.pull(master, overwrite=True)
2712
if self.repository.get_graph().is_ancestor(old_tip,
2713
_mod_revision.ensure_null(self.last_revision())):
2718
def _read_last_revision_info(self):
2719
revision_string = self._transport.get_bytes('last-revision')
2720
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2721
revision_id = cache_utf8.get_cached_utf8(revision_id)
2723
return revno, revision_id
2725
def _write_last_revision_info(self, revno, revision_id):
2726
"""Simply write out the revision id, with no checks.
2728
Use set_last_revision_info to perform this safely.
2730
Does not update the revision_history cache.
2732
revision_id = _mod_revision.ensure_null(revision_id)
2733
out_string = '%d %s\n' % (revno, revision_id)
2734
self._transport.put_bytes('last-revision', out_string,
2735
mode=self.bzrdir._get_file_mode())
2738
def update_feature_flags(self, updated_flags):
2739
"""Update the feature flags for this branch.
2741
:param updated_flags: Dictionary mapping feature names to necessities
2742
A necessity can be None to indicate the feature should be removed
2744
self._format._update_feature_flags(updated_flags)
2745
self.control_transport.put_bytes('format', self._format.as_string())
2748
class FullHistoryBzrBranch(BzrBranch):
2749
"""Bzr branch which contains the full revision history."""
2752
def set_last_revision_info(self, revno, revision_id):
2753
if not revision_id or not isinstance(revision_id, basestring):
2754
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2755
revision_id = _mod_revision.ensure_null(revision_id)
2756
# this old format stores the full history, but this api doesn't
2757
# provide it, so we must generate, and might as well check it's
2759
history = self._lefthand_history(revision_id)
2760
if len(history) != revno:
2761
raise AssertionError('%d != %d' % (len(history), revno))
2762
self._set_revision_history(history)
2764
def _read_last_revision_info(self):
2765
rh = self._revision_history()
2768
return (revno, rh[-1])
2770
return (0, _mod_revision.NULL_REVISION)
2772
@deprecated_method(deprecated_in((2, 4, 0)))
2774
def set_revision_history(self, rev_history):
2775
"""See Branch.set_revision_history."""
2776
self._set_revision_history(rev_history)
2778
def _set_revision_history(self, rev_history):
2779
if 'evil' in debug.debug_flags:
2780
mutter_callsite(3, "set_revision_history scales with history.")
2781
check_not_reserved_id = _mod_revision.check_not_reserved_id
2782
for rev_id in rev_history:
2783
check_not_reserved_id(rev_id)
2784
if Branch.hooks['post_change_branch_tip']:
2785
# Don't calculate the last_revision_info() if there are no hooks
2787
old_revno, old_revid = self.last_revision_info()
2788
if len(rev_history) == 0:
2789
revid = _mod_revision.NULL_REVISION
2791
revid = rev_history[-1]
2792
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2793
self._write_revision_history(rev_history)
2794
self._clear_cached_state()
2795
self._cache_revision_history(rev_history)
2796
for hook in Branch.hooks['set_rh']:
2797
hook(self, rev_history)
2798
if Branch.hooks['post_change_branch_tip']:
2799
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2801
def _write_revision_history(self, history):
2802
"""Factored out of set_revision_history.
2804
This performs the actual writing to disk.
2805
It is intended to be called by set_revision_history."""
2806
self._transport.put_bytes(
2807
'revision-history', '\n'.join(history),
2808
mode=self.bzrdir._get_file_mode())
2810
def _gen_revision_history(self):
2811
history = self._transport.get_bytes('revision-history').split('\n')
2812
if history[-1:] == ['']:
2813
# There shouldn't be a trailing newline, but just in case.
2817
def _synchronize_history(self, destination, revision_id):
2818
if not isinstance(destination, FullHistoryBzrBranch):
2819
super(BzrBranch, self)._synchronize_history(
2820
destination, revision_id)
2822
if revision_id == _mod_revision.NULL_REVISION:
2825
new_history = self._revision_history()
2826
if revision_id is not None and new_history != []:
2828
new_history = new_history[:new_history.index(revision_id) + 1]
2830
rev = self.repository.get_revision(revision_id)
2831
new_history = rev.get_history(self.repository)[1:]
2832
destination._set_revision_history(new_history)
2835
def generate_revision_history(self, revision_id, last_rev=None,
2837
"""Create a new revision history that will finish with revision_id.
2839
:param revision_id: the new tip to use.
2840
:param last_rev: The previous last_revision. If not None, then this
2841
must be a ancestory of revision_id, or DivergedBranches is raised.
2842
:param other_branch: The other branch that DivergedBranches should
2843
raise with respect to.
2845
self._set_revision_history(self._lefthand_history(revision_id,
2846
last_rev, other_branch))
2849
class BzrBranch5(FullHistoryBzrBranch):
2850
"""A format 5 branch. This supports new features over plain branches.
2852
It has support for a master_branch which is the data for bound branches.
2856
class BzrBranch8(BzrBranch):
2857
"""A branch that stores tree-reference locations."""
2859
def _open_hook(self, possible_transports=None):
2860
if self._ignore_fallbacks:
2862
if possible_transports is None:
2863
possible_transports = [self.bzrdir.root_transport]
2865
url = self.get_stacked_on_url()
2866
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2867
errors.UnstackableBranchFormat):
2870
for hook in Branch.hooks['transform_fallback_location']:
2871
url = hook(self, url)
2873
hook_name = Branch.hooks.get_hook_name(hook)
2874
raise AssertionError(
2875
"'transform_fallback_location' hook %s returned "
2876
"None, not a URL." % hook_name)
2877
self._activate_fallback_location(url,
2878
possible_transports=possible_transports)
2880
def __init__(self, *args, **kwargs):
2881
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2882
super(BzrBranch8, self).__init__(*args, **kwargs)
2883
self._last_revision_info_cache = None
2884
self._reference_info = None
2886
def _clear_cached_state(self):
2887
super(BzrBranch8, self)._clear_cached_state()
2888
self._last_revision_info_cache = None
2889
self._reference_info = None
2891
def _check_history_violation(self, revision_id):
2892
current_revid = self.last_revision()
2893
last_revision = _mod_revision.ensure_null(current_revid)
2894
if _mod_revision.is_null(last_revision):
2896
graph = self.repository.get_graph()
2897
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2898
if lh_ancestor == current_revid:
2900
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2902
def _gen_revision_history(self):
2903
"""Generate the revision history from last revision
2905
last_revno, last_revision = self.last_revision_info()
2906
self._extend_partial_history(stop_index=last_revno-1)
2907
return list(reversed(self._partial_revision_history_cache))
2910
def _set_parent_location(self, url):
2911
"""Set the parent branch"""
2912
self._set_config_location('parent_location', url, make_relative=True)
2915
def _get_parent_location(self):
2916
"""Set the parent branch"""
2917
return self._get_config_location('parent_location')
2920
def _set_all_reference_info(self, info_dict):
2921
"""Replace all reference info stored in a branch.
2923
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2926
writer = rio.RioWriter(s)
2927
for key, (tree_path, branch_location) in info_dict.iteritems():
2928
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2929
branch_location=branch_location)
2930
writer.write_stanza(stanza)
2931
self._transport.put_bytes('references', s.getvalue())
2932
self._reference_info = info_dict
2935
def _get_all_reference_info(self):
2936
"""Return all the reference info stored in a branch.
2938
:return: A dict of {file_id: (tree_path, branch_location)}
2940
if self._reference_info is not None:
2941
return self._reference_info
2942
rio_file = self._transport.get('references')
2944
stanzas = rio.read_stanzas(rio_file)
2945
info_dict = dict((s['file_id'], (s['tree_path'],
2946
s['branch_location'])) for s in stanzas)
2949
self._reference_info = info_dict
2952
def set_reference_info(self, file_id, tree_path, branch_location):
2953
"""Set the branch location to use for a tree reference.
2955
:param file_id: The file-id of the tree reference.
2956
:param tree_path: The path of the tree reference in the tree.
2957
:param branch_location: The location of the branch to retrieve tree
2960
info_dict = self._get_all_reference_info()
2961
info_dict[file_id] = (tree_path, branch_location)
2962
if None in (tree_path, branch_location):
2963
if tree_path is not None:
2964
raise ValueError('tree_path must be None when branch_location'
2966
if branch_location is not None:
2967
raise ValueError('branch_location must be None when tree_path'
2969
del info_dict[file_id]
2970
self._set_all_reference_info(info_dict)
2972
def get_reference_info(self, file_id):
2973
"""Get the tree_path and branch_location for a tree reference.
2975
:return: a tuple of (tree_path, branch_location)
2977
return self._get_all_reference_info().get(file_id, (None, None))
2979
def reference_parent(self, file_id, path, possible_transports=None):
2980
"""Return the parent branch for a tree-reference file_id.
2982
:param file_id: The file_id of the tree reference
2983
:param path: The path of the file_id in the tree
2984
:return: A branch associated with the file_id
2986
branch_location = self.get_reference_info(file_id)[1]
2987
if branch_location is None:
2988
return Branch.reference_parent(self, file_id, path,
2989
possible_transports)
2990
branch_location = urlutils.join(self.user_url, branch_location)
2991
return Branch.open(branch_location,
2992
possible_transports=possible_transports)
2994
def set_push_location(self, location):
2995
"""See Branch.set_push_location."""
2996
self._set_config_location('push_location', location)
2998
def set_bound_location(self, location):
2999
"""See Branch.set_push_location."""
3000
self._master_branch_cache = None
3002
conf = self.get_config_stack()
3003
if location is None:
3004
if not conf.get('bound'):
3007
conf.set('bound', 'False')
3010
self._set_config_location('bound_location', location,
3012
conf.set('bound', 'True')
3015
def _get_bound_location(self, bound):
3016
"""Return the bound location in the config file.
3018
Return None if the bound parameter does not match"""
3019
conf = self.get_config_stack()
3020
if conf.get('bound') != bound:
3022
return self._get_config_location('bound_location', config=conf)
3024
def get_bound_location(self):
3025
"""See Branch.get_bound_location."""
3026
return self._get_bound_location(True)
3028
def get_old_bound_location(self):
3029
"""See Branch.get_old_bound_location"""
3030
return self._get_bound_location(False)
3032
def get_stacked_on_url(self):
3033
# you can always ask for the URL; but you might not be able to use it
3034
# if the repo can't support stacking.
3035
## self._check_stackable_repo()
3036
# stacked_on_location is only ever defined in branch.conf, so don't
3037
# waste effort reading the whole stack of config files.
3038
conf = _mod_config.BranchOnlyStack(self)
3039
stacked_url = self._get_config_location('stacked_on_location',
3041
if stacked_url is None:
3042
raise errors.NotStacked(self)
3043
return stacked_url.encode('utf-8')
3046
def get_rev_id(self, revno, history=None):
3047
"""Find the revision id of the specified revno."""
3049
return _mod_revision.NULL_REVISION
3051
last_revno, last_revision_id = self.last_revision_info()
3052
if revno <= 0 or revno > last_revno:
3053
raise errors.NoSuchRevision(self, revno)
3055
if history is not None:
3056
return history[revno - 1]
3058
index = last_revno - revno
3059
if len(self._partial_revision_history_cache) <= index:
3060
self._extend_partial_history(stop_index=index)
3061
if len(self._partial_revision_history_cache) > index:
3062
return self._partial_revision_history_cache[index]
3064
raise errors.NoSuchRevision(self, revno)
3067
def revision_id_to_revno(self, revision_id):
3068
"""Given a revision id, return its revno"""
3069
if _mod_revision.is_null(revision_id):
3072
index = self._partial_revision_history_cache.index(revision_id)
3075
self._extend_partial_history(stop_revision=revision_id)
3076
except errors.RevisionNotPresent, e:
3077
raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
3078
index = len(self._partial_revision_history_cache) - 1
3080
raise errors.NoSuchRevision(self, revision_id)
3081
if self._partial_revision_history_cache[index] != revision_id:
3082
raise errors.NoSuchRevision(self, revision_id)
3083
return self.revno() - index
3086
class BzrBranch7(BzrBranch8):
3087
"""A branch with support for a fallback repository."""
3089
def set_reference_info(self, file_id, tree_path, branch_location):
3090
Branch.set_reference_info(self, file_id, tree_path, branch_location)
3092
def get_reference_info(self, file_id):
3093
Branch.get_reference_info(self, file_id)
3095
def reference_parent(self, file_id, path, possible_transports=None):
3096
return Branch.reference_parent(self, file_id, path,
3097
possible_transports)
3100
class BzrBranch6(BzrBranch7):
3101
"""See BzrBranchFormat6 for the capabilities of this branch.
3103
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
3107
def get_stacked_on_url(self):
3108
raise errors.UnstackableBranchFormat(self._format, self.user_url)
3111
######################################################################
3112
# results of operations
3115
class _Result(object):
3117
def _show_tag_conficts(self, to_file):
3118
if not getattr(self, 'tag_conflicts', None):
3120
to_file.write('Conflicting tags:\n')
3121
for name, value1, value2 in self.tag_conflicts:
3122
to_file.write(' %s\n' % (name, ))
3125
class PullResult(_Result):
3126
"""Result of a Branch.pull operation.
3128
:ivar old_revno: Revision number before pull.
3129
:ivar new_revno: Revision number after pull.
3130
:ivar old_revid: Tip revision id before pull.
3131
:ivar new_revid: Tip revision id after pull.
3132
:ivar source_branch: Source (local) branch object. (read locked)
3133
:ivar master_branch: Master branch of the target, or the target if no
3135
:ivar local_branch: target branch if there is a Master, else None
3136
:ivar target_branch: Target/destination branch object. (write locked)
3137
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3138
:ivar tag_updates: A dict with new tags, see BasicTags.merge_to
3141
@deprecated_method(deprecated_in((2, 3, 0)))
3143
"""Return the relative change in revno.
3145
:deprecated: Use `new_revno` and `old_revno` instead.
3147
return self.new_revno - self.old_revno
3149
def report(self, to_file):
3150
tag_conflicts = getattr(self, "tag_conflicts", None)
3151
tag_updates = getattr(self, "tag_updates", None)
3153
if self.old_revid != self.new_revid:
3154
to_file.write('Now on revision %d.\n' % self.new_revno)
3156
to_file.write('%d tag(s) updated.\n' % len(tag_updates))
3157
if self.old_revid == self.new_revid and not tag_updates:
3158
if not tag_conflicts:
3159
to_file.write('No revisions or tags to pull.\n')
3161
to_file.write('No revisions to pull.\n')
3162
self._show_tag_conficts(to_file)
3165
class BranchPushResult(_Result):
3166
"""Result of a Branch.push operation.
3168
:ivar old_revno: Revision number (eg 10) of the target before push.
3169
:ivar new_revno: Revision number (eg 12) of the target after push.
3170
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3172
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3174
:ivar source_branch: Source branch object that the push was from. This is
3175
read locked, and generally is a local (and thus low latency) branch.
3176
:ivar master_branch: If target is a bound branch, the master branch of
3177
target, or target itself. Always write locked.
3178
:ivar target_branch: The direct Branch where data is being sent (write
3180
:ivar local_branch: If the target is a bound branch this will be the
3181
target, otherwise it will be None.
3184
@deprecated_method(deprecated_in((2, 3, 0)))
3186
"""Return the relative change in revno.
3188
:deprecated: Use `new_revno` and `old_revno` instead.
3190
return self.new_revno - self.old_revno
3192
def report(self, to_file):
3193
# TODO: This function gets passed a to_file, but then
3194
# ignores it and calls note() instead. This is also
3195
# inconsistent with PullResult(), which writes to stdout.
3196
# -- JRV20110901, bug #838853
3197
tag_conflicts = getattr(self, "tag_conflicts", None)
3198
tag_updates = getattr(self, "tag_updates", None)
3200
if self.old_revid != self.new_revid:
3201
note(gettext('Pushed up to revision %d.') % self.new_revno)
3203
note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
3204
if self.old_revid == self.new_revid and not tag_updates:
3205
if not tag_conflicts:
3206
note(gettext('No new revisions or tags to push.'))
3208
note(gettext('No new revisions to push.'))
3209
self._show_tag_conficts(to_file)
3212
class BranchCheckResult(object):
3213
"""Results of checking branch consistency.
3218
def __init__(self, branch):
3219
self.branch = branch
3222
def report_results(self, verbose):
3223
"""Report the check results via trace.note.
3225
:param verbose: Requests more detailed display of what was checked,
3228
note(gettext('checked branch {0} format {1}').format(
3229
self.branch.user_url, self.branch._format))
3230
for error in self.errors:
3231
note(gettext('found error:%s'), error)
3234
class Converter5to6(object):
3235
"""Perform an in-place upgrade of format 5 to format 6"""
3237
def convert(self, branch):
3238
# Data for 5 and 6 can peacefully coexist.
3239
format = BzrBranchFormat6()
3240
new_branch = format.open(branch.bzrdir, _found=True)
3242
# Copy source data into target
3243
new_branch._write_last_revision_info(*branch.last_revision_info())
3244
new_branch.set_parent(branch.get_parent())
3245
new_branch.set_bound_location(branch.get_bound_location())
3246
new_branch.set_push_location(branch.get_push_location())
3248
# New branch has no tags by default
3249
new_branch.tags._set_tag_dict({})
3251
# Copying done; now update target format
3252
new_branch._transport.put_bytes('format',
3254
mode=new_branch.bzrdir._get_file_mode())
3256
# Clean up old files
3257
new_branch._transport.delete('revision-history')
3259
branch.set_parent(None)
3260
except errors.NoSuchFile:
3262
branch.set_bound_location(None)
3265
class Converter6to7(object):
3266
"""Perform an in-place upgrade of format 6 to format 7"""
3268
def convert(self, branch):
3269
format = BzrBranchFormat7()
3270
branch._set_config_location('stacked_on_location', '')
3271
# update target format
3272
branch._transport.put_bytes('format', format.as_string())
3275
class Converter7to8(object):
3276
"""Perform an in-place upgrade of format 7 to format 8"""
3278
def convert(self, branch):
3279
format = BzrBranchFormat8()
3280
branch._transport.put_bytes('references', '')
3281
# update target format
3282
branch._transport.put_bytes('format', format.as_string())
3285
class InterBranch(InterObject):
3286
"""This class represents operations taking place between two branches.
3288
Its instances have methods like pull() and push() and contain
3289
references to the source and target repositories these operations
3290
can be carried out on.
3294
"""The available optimised InterBranch types."""
3297
def _get_branch_formats_to_test(klass):
3298
"""Return an iterable of format tuples for testing.
3300
:return: An iterable of (from_format, to_format) to use when testing
3301
this InterBranch class. Each InterBranch class should define this
3304
raise NotImplementedError(klass._get_branch_formats_to_test)
3307
def pull(self, overwrite=False, stop_revision=None,
3308
possible_transports=None, local=False):
3309
"""Mirror source into target branch.
3311
The target branch is considered to be 'local', having low latency.
3313
:returns: PullResult instance
3315
raise NotImplementedError(self.pull)
3318
def push(self, overwrite=False, stop_revision=None, lossy=False,
3319
_override_hook_source_branch=None):
3320
"""Mirror the source branch into the target branch.
3322
The source branch is considered to be 'local', having low latency.
3324
raise NotImplementedError(self.push)
3327
def copy_content_into(self, revision_id=None):
3328
"""Copy the content of source into target
3330
revision_id: if not None, the revision history in the new branch will
3331
be truncated to end with revision_id.
3333
raise NotImplementedError(self.copy_content_into)
3336
def fetch(self, stop_revision=None, limit=None):
3339
:param stop_revision: Last revision to fetch
3340
:param limit: Optional rough limit of revisions to fetch
3342
raise NotImplementedError(self.fetch)
3345
class GenericInterBranch(InterBranch):
3346
"""InterBranch implementation that uses public Branch functions."""
3349
def is_compatible(klass, source, target):
3350
# GenericBranch uses the public API, so always compatible
3354
def _get_branch_formats_to_test(klass):
3355
return [(format_registry.get_default(), format_registry.get_default())]
3358
def unwrap_format(klass, format):
3359
if isinstance(format, remote.RemoteBranchFormat):
3360
format._ensure_real()
3361
return format._custom_format
3365
def copy_content_into(self, revision_id=None):
3366
"""Copy the content of source into target
3368
revision_id: if not None, the revision history in the new branch will
3369
be truncated to end with revision_id.
3371
self.source.update_references(self.target)
3372
self.source._synchronize_history(self.target, revision_id)
3374
parent = self.source.get_parent()
3375
except errors.InaccessibleParent, e:
3376
mutter('parent was not accessible to copy: %s', e)
3379
self.target.set_parent(parent)
3380
if self.source._push_should_merge_tags():
3381
self.source.tags.merge_to(self.target.tags)
3384
def fetch(self, stop_revision=None, limit=None):
3385
if self.target.base == self.source.base:
3387
self.source.lock_read()
3389
fetch_spec_factory = fetch.FetchSpecFactory()
3390
fetch_spec_factory.source_branch = self.source
3391
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3392
fetch_spec_factory.source_repo = self.source.repository
3393
fetch_spec_factory.target_repo = self.target.repository
3394
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3395
fetch_spec_factory.limit = limit
3396
fetch_spec = fetch_spec_factory.make_fetch_spec()
3397
return self.target.repository.fetch(self.source.repository,
3398
fetch_spec=fetch_spec)
3400
self.source.unlock()
3403
def _update_revisions(self, stop_revision=None, overwrite=False,
3405
other_revno, other_last_revision = self.source.last_revision_info()
3406
stop_revno = None # unknown
3407
if stop_revision is None:
3408
stop_revision = other_last_revision
3409
if _mod_revision.is_null(stop_revision):
3410
# if there are no commits, we're done.
3412
stop_revno = other_revno
3414
# what's the current last revision, before we fetch [and change it
3416
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3417
# we fetch here so that we don't process data twice in the common
3418
# case of having something to pull, and so that the check for
3419
# already merged can operate on the just fetched graph, which will
3420
# be cached in memory.
3421
self.fetch(stop_revision=stop_revision)
3422
# Check to see if one is an ancestor of the other
3425
graph = self.target.repository.get_graph()
3426
if self.target._check_if_descendant_or_diverged(
3427
stop_revision, last_rev, graph, self.source):
3428
# stop_revision is a descendant of last_rev, but we aren't
3429
# overwriting, so we're done.
3431
if stop_revno is None:
3433
graph = self.target.repository.get_graph()
3434
this_revno, this_last_revision = \
3435
self.target.last_revision_info()
3436
stop_revno = graph.find_distance_to_null(stop_revision,
3437
[(other_last_revision, other_revno),
3438
(this_last_revision, this_revno)])
3439
self.target.set_last_revision_info(stop_revno, stop_revision)
3442
def pull(self, overwrite=False, stop_revision=None,
3443
possible_transports=None, run_hooks=True,
3444
_override_hook_target=None, local=False):
3445
"""Pull from source into self, updating my master if any.
3447
:param run_hooks: Private parameter - if false, this branch
3448
is being called because it's the master of the primary branch,
3449
so it should not run its hooks.
3451
bound_location = self.target.get_bound_location()
3452
if local and not bound_location:
3453
raise errors.LocalRequiresBoundBranch()
3454
master_branch = None
3455
source_is_master = False
3457
# bound_location comes from a config file, some care has to be
3458
# taken to relate it to source.user_url
3459
normalized = urlutils.normalize_url(bound_location)
3461
relpath = self.source.user_transport.relpath(normalized)
3462
source_is_master = (relpath == '')
3463
except (errors.PathNotChild, errors.InvalidURL):
3464
source_is_master = False
3465
if not local and bound_location and not source_is_master:
3466
# not pulling from master, so we need to update master.
3467
master_branch = self.target.get_master_branch(possible_transports)
3468
master_branch.lock_write()
3471
# pull from source into master.
3472
master_branch.pull(self.source, overwrite, stop_revision,
3474
return self._pull(overwrite,
3475
stop_revision, _hook_master=master_branch,
3476
run_hooks=run_hooks,
3477
_override_hook_target=_override_hook_target,
3478
merge_tags_to_master=not source_is_master)
3481
master_branch.unlock()
3483
def push(self, overwrite=False, stop_revision=None, lossy=False,
3484
_override_hook_source_branch=None):
3485
"""See InterBranch.push.
3487
This is the basic concrete implementation of push()
3489
:param _override_hook_source_branch: If specified, run the hooks
3490
passing this Branch as the source, rather than self. This is for
3491
use of RemoteBranch, where push is delegated to the underlying
3495
raise errors.LossyPushToSameVCS(self.source, self.target)
3496
# TODO: Public option to disable running hooks - should be trivial but
3499
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3500
op.add_cleanup(self.source.lock_read().unlock)
3501
op.add_cleanup(self.target.lock_write().unlock)
3502
return op.run(overwrite, stop_revision,
3503
_override_hook_source_branch=_override_hook_source_branch)
3505
def _basic_push(self, overwrite, stop_revision):
3506
"""Basic implementation of push without bound branches or hooks.
3508
Must be called with source read locked and target write locked.
3510
result = BranchPushResult()
3511
result.source_branch = self.source
3512
result.target_branch = self.target
3513
result.old_revno, result.old_revid = self.target.last_revision_info()
3514
self.source.update_references(self.target)
3515
if result.old_revid != stop_revision:
3516
# We assume that during 'push' this repository is closer than
3518
graph = self.source.repository.get_graph(self.target.repository)
3519
self._update_revisions(stop_revision, overwrite=overwrite,
3521
if self.source._push_should_merge_tags():
3522
result.tag_updates, result.tag_conflicts = (
3523
self.source.tags.merge_to(self.target.tags, overwrite))
3524
result.new_revno, result.new_revid = self.target.last_revision_info()
3527
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3528
_override_hook_source_branch=None):
3529
"""Push from source into target, and into target's master if any.
3532
if _override_hook_source_branch:
3533
result.source_branch = _override_hook_source_branch
3534
for hook in Branch.hooks['post_push']:
3537
bound_location = self.target.get_bound_location()
3538
if bound_location and self.target.base != bound_location:
3539
# there is a master branch.
3541
# XXX: Why the second check? Is it even supported for a branch to
3542
# be bound to itself? -- mbp 20070507
3543
master_branch = self.target.get_master_branch()
3544
master_branch.lock_write()
3545
operation.add_cleanup(master_branch.unlock)
3546
# push into the master from the source branch.
3547
master_inter = InterBranch.get(self.source, master_branch)
3548
master_inter._basic_push(overwrite, stop_revision)
3549
# and push into the target branch from the source. Note that
3550
# we push from the source branch again, because it's considered
3551
# the highest bandwidth repository.
3552
result = self._basic_push(overwrite, stop_revision)
3553
result.master_branch = master_branch
3554
result.local_branch = self.target
3556
master_branch = None
3558
result = self._basic_push(overwrite, stop_revision)
3559
# TODO: Why set master_branch and local_branch if there's no
3560
# binding? Maybe cleaner to just leave them unset? -- mbp
3562
result.master_branch = self.target
3563
result.local_branch = None
3567
def _pull(self, overwrite=False, stop_revision=None,
3568
possible_transports=None, _hook_master=None, run_hooks=True,
3569
_override_hook_target=None, local=False,
3570
merge_tags_to_master=True):
3573
This function is the core worker, used by GenericInterBranch.pull to
3574
avoid duplication when pulling source->master and source->local.
3576
:param _hook_master: Private parameter - set the branch to
3577
be supplied as the master to pull hooks.
3578
:param run_hooks: Private parameter - if false, this branch
3579
is being called because it's the master of the primary branch,
3580
so it should not run its hooks.
3581
is being called because it's the master of the primary branch,
3582
so it should not run its hooks.
3583
:param _override_hook_target: Private parameter - set the branch to be
3584
supplied as the target_branch to pull hooks.
3585
:param local: Only update the local branch, and not the bound branch.
3587
# This type of branch can't be bound.
3589
raise errors.LocalRequiresBoundBranch()
3590
result = PullResult()
3591
result.source_branch = self.source
3592
if _override_hook_target is None:
3593
result.target_branch = self.target
3595
result.target_branch = _override_hook_target
3596
self.source.lock_read()
3598
# We assume that during 'pull' the target repository is closer than
3600
self.source.update_references(self.target)
3601
graph = self.target.repository.get_graph(self.source.repository)
3602
# TODO: Branch formats should have a flag that indicates
3603
# that revno's are expensive, and pull() should honor that flag.
3605
result.old_revno, result.old_revid = \
3606
self.target.last_revision_info()
3607
self._update_revisions(stop_revision, overwrite=overwrite,
3609
# TODO: The old revid should be specified when merging tags,
3610
# so a tags implementation that versions tags can only
3611
# pull in the most recent changes. -- JRV20090506
3612
result.tag_updates, result.tag_conflicts = (
3613
self.source.tags.merge_to(self.target.tags, overwrite,
3614
ignore_master=not merge_tags_to_master))
3615
result.new_revno, result.new_revid = self.target.last_revision_info()
3617
result.master_branch = _hook_master
3618
result.local_branch = result.target_branch
3620
result.master_branch = result.target_branch
3621
result.local_branch = None
3623
for hook in Branch.hooks['post_pull']:
3626
self.source.unlock()
3630
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
