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
from_branch = BranchReferenceFormat().initialize(checkout,
1465
checkout_branch = controldir.ControlDir.create_branch_convenience(
1466
to_location, force_new_tree=False, format=format)
1467
checkout = checkout_branch.bzrdir
1468
checkout_branch.bind(self)
1469
# pull up to the specified revision_id to set the initial
1470
# branch tip correctly, and seed it with history.
1471
checkout_branch.pull(self, stop_revision=revision_id)
1473
tree = checkout.create_workingtree(revision_id,
1474
from_branch=from_branch,
1475
accelerator_tree=accelerator_tree,
1477
basis_tree = tree.basis_tree()
1478
basis_tree.lock_read()
1480
for path, file_id in basis_tree.iter_references():
1481
reference_parent = self.reference_parent(file_id, path)
1482
reference_parent.create_checkout(tree.abspath(path),
1483
basis_tree.get_reference_revision(file_id, path),
1490
def reconcile(self, thorough=True):
1491
"""Make sure the data stored in this branch is consistent."""
1492
from bzrlib.reconcile import BranchReconciler
1493
reconciler = BranchReconciler(self, thorough=thorough)
1494
reconciler.reconcile()
1497
def reference_parent(self, file_id, path, possible_transports=None):
1498
"""Return the parent branch for a tree-reference file_id
1500
:param file_id: The file_id of the tree reference
1501
:param path: The path of the file_id in the tree
1502
:return: A branch associated with the file_id
1504
# FIXME should provide multiple branches, based on config
1505
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1506
possible_transports=possible_transports)
1508
def supports_tags(self):
1509
return self._format.supports_tags()
1511
def automatic_tag_name(self, revision_id):
1512
"""Try to automatically find the tag name for a revision.
1514
:param revision_id: Revision id of the revision.
1515
:return: A tag name or None if no tag name could be determined.
1517
for hook in Branch.hooks['automatic_tag_name']:
1518
ret = hook(self, revision_id)
1523
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1525
"""Ensure that revision_b is a descendant of revision_a.
1527
This is a helper function for update_revisions.
1529
:raises: DivergedBranches if revision_b has diverged from revision_a.
1530
:returns: True if revision_b is a descendant of revision_a.
1532
relation = self._revision_relations(revision_a, revision_b, graph)
1533
if relation == 'b_descends_from_a':
1535
elif relation == 'diverged':
1536
raise errors.DivergedBranches(self, other_branch)
1537
elif relation == 'a_descends_from_b':
1540
raise AssertionError("invalid relation: %r" % (relation,))
1542
def _revision_relations(self, revision_a, revision_b, graph):
1543
"""Determine the relationship between two revisions.
1545
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1547
heads = graph.heads([revision_a, revision_b])
1548
if heads == set([revision_b]):
1549
return 'b_descends_from_a'
1550
elif heads == set([revision_a, revision_b]):
1551
# These branches have diverged
1553
elif heads == set([revision_a]):
1554
return 'a_descends_from_b'
1556
raise AssertionError("invalid heads: %r" % (heads,))
1558
def heads_to_fetch(self):
1559
"""Return the heads that must and that should be fetched to copy this
1560
branch into another repo.
1562
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1563
set of heads that must be fetched. if_present_fetch is a set of
1564
heads that must be fetched if present, but no error is necessary if
1565
they are not present.
1567
# For bzr native formats must_fetch is just the tip, and
1568
# if_present_fetch are the tags.
1569
must_fetch = set([self.last_revision()])
1570
if_present_fetch = set()
1571
if self.get_config_stack().get('branch.fetch_tags'):
1573
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1574
except errors.TagsNotSupported:
1576
must_fetch.discard(_mod_revision.NULL_REVISION)
1577
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1578
return must_fetch, if_present_fetch
1581
class BranchFormat(controldir.ControlComponentFormat):
1582
"""An encapsulation of the initialization and open routines for a format.
1584
Formats provide three things:
1585
* An initialization routine,
1586
* a format description
1589
Formats are placed in an dict by their format string for reference
1590
during branch opening. It's not required that these be instances, they
1591
can be classes themselves with class methods - it simply depends on
1592
whether state is needed for a given format or not.
1594
Once a format is deprecated, just deprecate the initialize and open
1595
methods on the format class. Do not deprecate the object, as the
1596
object will be created every time regardless.
1599
def __eq__(self, other):
1600
return self.__class__ is other.__class__
1602
def __ne__(self, other):
1603
return not (self == other)
1606
@deprecated_method(deprecated_in((2, 4, 0)))
1607
def get_default_format(klass):
1608
"""Return the current default format."""
1609
return format_registry.get_default()
1612
@deprecated_method(deprecated_in((2, 4, 0)))
1613
def get_formats(klass):
1614
"""Get all the known formats.
1616
Warning: This triggers a load of all lazy registered formats: do not
1617
use except when that is desireed.
1619
return format_registry._get_all()
1621
def get_reference(self, controldir, name=None):
1622
"""Get the target reference of the branch in controldir.
1624
format probing must have been completed before calling
1625
this method - it is assumed that the format of the branch
1626
in controldir is correct.
1628
:param controldir: The controldir to get the branch data from.
1629
:param name: Name of the colocated branch to fetch
1630
:return: None if the branch is not a reference branch.
1635
def set_reference(self, controldir, name, to_branch):
1636
"""Set the target reference of the branch in controldir.
1638
format probing must have been completed before calling
1639
this method - it is assumed that the format of the branch
1640
in controldir is correct.
1642
:param controldir: The controldir to set the branch reference for.
1643
:param name: Name of colocated branch to set, None for default
1644
:param to_branch: branch that the checkout is to reference
1646
raise NotImplementedError(self.set_reference)
1648
def get_format_description(self):
1649
"""Return the short format description for this format."""
1650
raise NotImplementedError(self.get_format_description)
1652
def _run_post_branch_init_hooks(self, controldir, name, branch):
1653
hooks = Branch.hooks['post_branch_init']
1656
params = BranchInitHookParams(self, controldir, name, branch)
1660
def initialize(self, controldir, name=None, repository=None,
1661
append_revisions_only=None):
1662
"""Create a branch of this format in controldir.
1664
:param name: Name of the colocated branch to create.
1666
raise NotImplementedError(self.initialize)
1668
def is_supported(self):
1669
"""Is this format supported?
1671
Supported formats can be initialized and opened.
1672
Unsupported formats may not support initialization or committing or
1673
some other features depending on the reason for not being supported.
1677
def make_tags(self, branch):
1678
"""Create a tags object for branch.
1680
This method is on BranchFormat, because BranchFormats are reflected
1681
over the wire via network_name(), whereas full Branch instances require
1682
multiple VFS method calls to operate at all.
1684
The default implementation returns a disabled-tags instance.
1686
Note that it is normal for branch to be a RemoteBranch when using tags
1689
return _mod_tag.DisabledTags(branch)
1691
def network_name(self):
1692
"""A simple byte string uniquely identifying this format for RPC calls.
1694
MetaDir branch formats use their disk format string to identify the
1695
repository over the wire. All in one formats such as bzr < 0.8, and
1696
foreign formats like svn/git and hg should use some marker which is
1697
unique and immutable.
1699
raise NotImplementedError(self.network_name)
1701
def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
1702
found_repository=None, possible_transports=None):
1703
"""Return the branch object for controldir.
1705
:param controldir: A ControlDir that contains a branch.
1706
:param name: Name of colocated branch to open
1707
:param _found: a private parameter, do not use it. It is used to
1708
indicate if format probing has already be done.
1709
:param ignore_fallbacks: when set, no fallback branches will be opened
1710
(if there are any). Default is to open fallbacks.
1712
raise NotImplementedError(self.open)
1715
@deprecated_method(deprecated_in((2, 4, 0)))
1716
def register_format(klass, format):
1717
"""Register a metadir format.
1719
See MetaDirBranchFormatFactory for the ability to register a format
1720
without loading the code the format needs until it is actually used.
1722
format_registry.register(format)
1725
@deprecated_method(deprecated_in((2, 4, 0)))
1726
def set_default_format(klass, format):
1727
format_registry.set_default(format)
1729
def supports_set_append_revisions_only(self):
1730
"""True if this format supports set_append_revisions_only."""
1733
def supports_stacking(self):
1734
"""True if this format records a stacked-on branch."""
1737
def supports_leaving_lock(self):
1738
"""True if this format supports leaving locks in place."""
1739
return False # by default
1742
@deprecated_method(deprecated_in((2, 4, 0)))
1743
def unregister_format(klass, format):
1744
format_registry.remove(format)
1747
return self.get_format_description().rstrip()
1749
def supports_tags(self):
1750
"""True if this format supports tags stored in the branch"""
1751
return False # by default
1753
def tags_are_versioned(self):
1754
"""Whether the tag container for this branch versions tags."""
1757
def supports_tags_referencing_ghosts(self):
1758
"""True if tags can reference ghost revisions."""
1762
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1763
"""A factory for a BranchFormat object, permitting simple lazy registration.
1765
While none of the built in BranchFormats are lazy registered yet,
1766
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1767
use it, and the bzr-loom plugin uses it as well (see
1768
bzrlib.plugins.loom.formats).
1771
def __init__(self, format_string, module_name, member_name):
1772
"""Create a MetaDirBranchFormatFactory.
1774
:param format_string: The format string the format has.
1775
:param module_name: Module to load the format class from.
1776
:param member_name: Attribute name within the module for the format class.
1778
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1779
self._format_string = format_string
1781
def get_format_string(self):
1782
"""See BranchFormat.get_format_string."""
1783
return self._format_string
1786
"""Used for network_format_registry support."""
1787
return self.get_obj()()
1790
class BranchHooks(Hooks):
1791
"""A dictionary mapping hook name to a list of callables for branch hooks.
1793
e.g. ['set_rh'] Is the list of items to be called when the
1794
set_revision_history function is invoked.
1798
"""Create the default hooks.
1800
These are all empty initially, because by default nothing should get
1803
Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1804
self.add_hook('set_rh',
1805
"Invoked whenever the revision history has been set via "
1806
"set_revision_history. The api signature is (branch, "
1807
"revision_history), and the branch will be write-locked. "
1808
"The set_rh hook can be expensive for bzr to trigger, a better "
1809
"hook to use is Branch.post_change_branch_tip.", (0, 15))
1810
self.add_hook('open',
1811
"Called with the Branch object that has been opened after a "
1812
"branch is opened.", (1, 8))
1813
self.add_hook('post_push',
1814
"Called after a push operation completes. post_push is called "
1815
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1816
"bzr client.", (0, 15))
1817
self.add_hook('post_pull',
1818
"Called after a pull operation completes. post_pull is called "
1819
"with a bzrlib.branch.PullResult object and only runs in the "
1820
"bzr client.", (0, 15))
1821
self.add_hook('pre_commit',
1822
"Called after a commit is calculated but before it is "
1823
"completed. pre_commit is called with (local, master, old_revno, "
1824
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1825
"). old_revid is NULL_REVISION for the first commit to a branch, "
1826
"tree_delta is a TreeDelta object describing changes from the "
1827
"basis revision. hooks MUST NOT modify this delta. "
1828
" future_tree is an in-memory tree obtained from "
1829
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1831
self.add_hook('post_commit',
1832
"Called in the bzr client after a commit has completed. "
1833
"post_commit is called with (local, master, old_revno, old_revid, "
1834
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1835
"commit to a branch.", (0, 15))
1836
self.add_hook('post_uncommit',
1837
"Called in the bzr client after an uncommit completes. "
1838
"post_uncommit is called with (local, master, old_revno, "
1839
"old_revid, new_revno, new_revid) where local is the local branch "
1840
"or None, master is the target branch, and an empty branch "
1841
"receives new_revno of 0, new_revid of None.", (0, 15))
1842
self.add_hook('pre_change_branch_tip',
1843
"Called in bzr client and server before a change to the tip of a "
1844
"branch is made. pre_change_branch_tip is called with a "
1845
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1846
"commit, uncommit will all trigger this hook.", (1, 6))
1847
self.add_hook('post_change_branch_tip',
1848
"Called in bzr client and server after a change to the tip of a "
1849
"branch is made. post_change_branch_tip is called with a "
1850
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1851
"commit, uncommit will all trigger this hook.", (1, 4))
1852
self.add_hook('transform_fallback_location',
1853
"Called when a stacked branch is activating its fallback "
1854
"locations. transform_fallback_location is called with (branch, "
1855
"url), and should return a new url. Returning the same url "
1856
"allows it to be used as-is, returning a different one can be "
1857
"used to cause the branch to stack on a closer copy of that "
1858
"fallback_location. Note that the branch cannot have history "
1859
"accessing methods called on it during this hook because the "
1860
"fallback locations have not been activated. When there are "
1861
"multiple hooks installed for transform_fallback_location, "
1862
"all are called with the url returned from the previous hook."
1863
"The order is however undefined.", (1, 9))
1864
self.add_hook('automatic_tag_name',
1865
"Called to determine an automatic tag name for a revision. "
1866
"automatic_tag_name is called with (branch, revision_id) and "
1867
"should return a tag name or None if no tag name could be "
1868
"determined. The first non-None tag name returned will be used.",
1870
self.add_hook('post_branch_init',
1871
"Called after new branch initialization completes. "
1872
"post_branch_init is called with a "
1873
"bzrlib.branch.BranchInitHookParams. "
1874
"Note that init, branch and checkout (both heavyweight and "
1875
"lightweight) will all trigger this hook.", (2, 2))
1876
self.add_hook('post_switch',
1877
"Called after a checkout switches branch. "
1878
"post_switch is called with a "
1879
"bzrlib.branch.SwitchHookParams.", (2, 2))
1883
# install the default hooks into the Branch class.
1884
Branch.hooks = BranchHooks()
1887
class ChangeBranchTipParams(object):
1888
"""Object holding parameters passed to `*_change_branch_tip` hooks.
1890
There are 5 fields that hooks may wish to access:
1892
:ivar branch: the branch being changed
1893
:ivar old_revno: revision number before the change
1894
:ivar new_revno: revision number after the change
1895
:ivar old_revid: revision id before the change
1896
:ivar new_revid: revision id after the change
1898
The revid fields are strings. The revno fields are integers.
1901
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1902
"""Create a group of ChangeBranchTip parameters.
1904
:param branch: The branch being changed.
1905
:param old_revno: Revision number before the change.
1906
:param new_revno: Revision number after the change.
1907
:param old_revid: Tip revision id before the change.
1908
:param new_revid: Tip revision id after the change.
1910
self.branch = branch
1911
self.old_revno = old_revno
1912
self.new_revno = new_revno
1913
self.old_revid = old_revid
1914
self.new_revid = new_revid
1916
def __eq__(self, other):
1917
return self.__dict__ == other.__dict__
1920
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1921
self.__class__.__name__, self.branch,
1922
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1925
class BranchInitHookParams(object):
1926
"""Object holding parameters passed to `*_branch_init` hooks.
1928
There are 4 fields that hooks may wish to access:
1930
:ivar format: the branch format
1931
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1932
:ivar name: name of colocated branch, if any (or None)
1933
:ivar branch: the branch created
1935
Note that for lightweight checkouts, the bzrdir and format fields refer to
1936
the checkout, hence they are different from the corresponding fields in
1937
branch, which refer to the original branch.
1940
def __init__(self, format, controldir, name, branch):
1941
"""Create a group of BranchInitHook parameters.
1943
:param format: the branch format
1944
:param controldir: the ControlDir where the branch will be/has been
1946
:param name: name of colocated branch, if any (or None)
1947
:param branch: the branch created
1949
Note that for lightweight checkouts, the bzrdir and format fields refer
1950
to the checkout, hence they are different from the corresponding fields
1951
in branch, which refer to the original branch.
1953
self.format = format
1954
self.bzrdir = controldir
1956
self.branch = branch
1958
def __eq__(self, other):
1959
return self.__dict__ == other.__dict__
1962
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1965
class SwitchHookParams(object):
1966
"""Object holding parameters passed to `*_switch` hooks.
1968
There are 4 fields that hooks may wish to access:
1970
:ivar control_dir: ControlDir of the checkout to change
1971
:ivar to_branch: branch that the checkout is to reference
1972
:ivar force: skip the check for local commits in a heavy checkout
1973
:ivar revision_id: revision ID to switch to (or None)
1976
def __init__(self, control_dir, to_branch, force, revision_id):
1977
"""Create a group of SwitchHook parameters.
1979
:param control_dir: ControlDir of the checkout to change
1980
:param to_branch: branch that the checkout is to reference
1981
:param force: skip the check for local commits in a heavy checkout
1982
:param revision_id: revision ID to switch to (or None)
1984
self.control_dir = control_dir
1985
self.to_branch = to_branch
1987
self.revision_id = revision_id
1989
def __eq__(self, other):
1990
return self.__dict__ == other.__dict__
1993
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1994
self.control_dir, self.to_branch,
1998
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
1999
"""Base class for branch formats that live in meta directories.
2003
BranchFormat.__init__(self)
2004
bzrdir.BzrFormat.__init__(self)
2007
def find_format(klass, controldir, name=None):
2008
"""Return the format for the branch object in controldir."""
2010
transport = controldir.get_branch_transport(None, name=name)
2011
except errors.NoSuchFile:
2012
raise errors.NotBranchError(path=name, bzrdir=controldir)
2014
format_string = transport.get_bytes("format")
2015
except errors.NoSuchFile:
2016
raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
2017
return klass._find_format(format_registry, 'branch', format_string)
2019
def _branch_class(self):
2020
"""What class to instantiate on open calls."""
2021
raise NotImplementedError(self._branch_class)
2023
def _get_initial_config(self, append_revisions_only=None):
2024
if append_revisions_only:
2025
return "append_revisions_only = True\n"
2027
# Avoid writing anything if append_revisions_only is disabled,
2028
# as that is the default.
2031
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
2033
"""Initialize a branch in a bzrdir, with specified files
2035
:param a_bzrdir: The bzrdir to initialize the branch in
2036
:param utf8_files: The files to create as a list of
2037
(filename, content) tuples
2038
:param name: Name of colocated branch to create, if any
2039
:return: a branch in this format
2041
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2042
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2043
control_files = lockable_files.LockableFiles(branch_transport,
2044
'lock', lockdir.LockDir)
2045
control_files.create_lock()
2046
control_files.lock_write()
2048
utf8_files += [('format', self.as_string())]
2049
for (filename, content) in utf8_files:
2050
branch_transport.put_bytes(
2052
mode=a_bzrdir._get_file_mode())
2054
control_files.unlock()
2055
branch = self.open(a_bzrdir, name, _found=True,
2056
found_repository=repository)
2057
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2060
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2061
found_repository=None, possible_transports=None):
2062
"""See BranchFormat.open()."""
2064
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2065
if format.__class__ != self.__class__:
2066
raise AssertionError("wrong format %r found for %r" %
2068
transport = a_bzrdir.get_branch_transport(None, name=name)
2070
control_files = lockable_files.LockableFiles(transport, 'lock',
2072
if found_repository is None:
2073
found_repository = a_bzrdir.find_repository()
2074
return self._branch_class()(_format=self,
2075
_control_files=control_files,
2078
_repository=found_repository,
2079
ignore_fallbacks=ignore_fallbacks,
2080
possible_transports=possible_transports)
2081
except errors.NoSuchFile:
2082
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2085
def _matchingbzrdir(self):
2086
ret = bzrdir.BzrDirMetaFormat1()
2087
ret.set_branch_format(self)
2090
def supports_tags(self):
2093
def supports_leaving_lock(self):
2096
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
2098
BranchFormat.check_support_status(self,
2099
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
2101
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
2102
recommend_upgrade=recommend_upgrade, basedir=basedir)
2105
class BzrBranchFormat5(BranchFormatMetadir):
2106
"""Bzr branch format 5.
2109
- a revision-history file.
2111
- a lock dir guarding the branch itself
2112
- all of this stored in a branch/ subdirectory
2113
- works with shared repositories.
2115
This format is new in bzr 0.8.
2118
def _branch_class(self):
2122
def get_format_string(cls):
2123
"""See BranchFormat.get_format_string()."""
2124
return "Bazaar-NG branch format 5\n"
2126
def get_format_description(self):
2127
"""See BranchFormat.get_format_description()."""
2128
return "Branch format 5"
2130
def initialize(self, a_bzrdir, name=None, repository=None,
2131
append_revisions_only=None):
2132
"""Create a branch of this format in a_bzrdir."""
2133
if append_revisions_only:
2134
raise errors.UpgradeRequired(a_bzrdir.user_url)
2135
utf8_files = [('revision-history', ''),
2136
('branch-name', ''),
2138
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2140
def supports_tags(self):
2144
class BzrBranchFormat6(BranchFormatMetadir):
2145
"""Branch format with last-revision and tags.
2147
Unlike previous formats, this has no explicit revision history. Instead,
2148
this just stores the last-revision, and the left-hand history leading
2149
up to there is the history.
2151
This format was introduced in bzr 0.15
2152
and became the default in 0.91.
2155
def _branch_class(self):
2159
def get_format_string(cls):
2160
"""See BranchFormat.get_format_string()."""
2161
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2163
def get_format_description(self):
2164
"""See BranchFormat.get_format_description()."""
2165
return "Branch format 6"
2167
def initialize(self, a_bzrdir, name=None, repository=None,
2168
append_revisions_only=None):
2169
"""Create a branch of this format in a_bzrdir."""
2170
utf8_files = [('last-revision', '0 null:\n'),
2172
self._get_initial_config(append_revisions_only)),
2175
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2177
def make_tags(self, branch):
2178
"""See bzrlib.branch.BranchFormat.make_tags()."""
2179
return _mod_tag.BasicTags(branch)
2181
def supports_set_append_revisions_only(self):
2185
class BzrBranchFormat8(BranchFormatMetadir):
2186
"""Metadir format supporting storing locations of subtree branches."""
2188
def _branch_class(self):
2192
def get_format_string(cls):
2193
"""See BranchFormat.get_format_string()."""
2194
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2196
def get_format_description(self):
2197
"""See BranchFormat.get_format_description()."""
2198
return "Branch format 8"
2200
def initialize(self, a_bzrdir, name=None, repository=None,
2201
append_revisions_only=None):
2202
"""Create a branch of this format in a_bzrdir."""
2203
utf8_files = [('last-revision', '0 null:\n'),
2205
self._get_initial_config(append_revisions_only)),
2209
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2211
def make_tags(self, branch):
2212
"""See bzrlib.branch.BranchFormat.make_tags()."""
2213
return _mod_tag.BasicTags(branch)
2215
def supports_set_append_revisions_only(self):
2218
def supports_stacking(self):
2221
supports_reference_locations = True
2224
class BzrBranchFormat7(BranchFormatMetadir):
2225
"""Branch format with last-revision, tags, and a stacked location pointer.
2227
The stacked location pointer is passed down to the repository and requires
2228
a repository format with supports_external_lookups = True.
2230
This format was introduced in bzr 1.6.
2233
def initialize(self, a_bzrdir, name=None, repository=None,
2234
append_revisions_only=None):
2235
"""Create a branch of this format in a_bzrdir."""
2236
utf8_files = [('last-revision', '0 null:\n'),
2238
self._get_initial_config(append_revisions_only)),
2241
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2243
def _branch_class(self):
2247
def get_format_string(cls):
2248
"""See BranchFormat.get_format_string()."""
2249
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2251
def get_format_description(self):
2252
"""See BranchFormat.get_format_description()."""
2253
return "Branch format 7"
2255
def supports_set_append_revisions_only(self):
2258
def supports_stacking(self):
2261
def make_tags(self, branch):
2262
"""See bzrlib.branch.BranchFormat.make_tags()."""
2263
return _mod_tag.BasicTags(branch)
2265
supports_reference_locations = False
2268
class BranchReferenceFormat(BranchFormatMetadir):
2269
"""Bzr branch reference format.
2271
Branch references are used in implementing checkouts, they
2272
act as an alias to the real branch which is at some other url.
2280
def get_format_string(cls):
2281
"""See BranchFormat.get_format_string()."""
2282
return "Bazaar-NG Branch Reference Format 1\n"
2284
def get_format_description(self):
2285
"""See BranchFormat.get_format_description()."""
2286
return "Checkout reference format 1"
2288
def get_reference(self, a_bzrdir, name=None):
2289
"""See BranchFormat.get_reference()."""
2290
transport = a_bzrdir.get_branch_transport(None, name=name)
2291
return transport.get_bytes('location')
2293
def set_reference(self, a_bzrdir, name, to_branch):
2294
"""See BranchFormat.set_reference()."""
2295
transport = a_bzrdir.get_branch_transport(None, name=name)
2296
location = transport.put_bytes('location', to_branch.base)
2298
def initialize(self, a_bzrdir, name=None, target_branch=None,
2299
repository=None, append_revisions_only=None):
2300
"""Create a branch of this format in a_bzrdir."""
2301
if target_branch is None:
2302
# this format does not implement branch itself, thus the implicit
2303
# creation contract must see it as uninitializable
2304
raise errors.UninitializableFormat(self)
2305
mutter('creating branch reference in %s', a_bzrdir.user_url)
2306
if a_bzrdir._format.fixed_components:
2307
raise errors.IncompatibleFormat(self, a_bzrdir._format)
2308
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2309
branch_transport.put_bytes('location',
2310
target_branch.user_url)
2311
branch_transport.put_bytes('format', self.as_string())
2313
a_bzrdir, name, _found=True,
2314
possible_transports=[target_branch.bzrdir.root_transport])
2315
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2318
def _make_reference_clone_function(format, a_branch):
2319
"""Create a clone() routine for a branch dynamically."""
2320
def clone(to_bzrdir, revision_id=None,
2321
repository_policy=None):
2322
"""See Branch.clone()."""
2323
return format.initialize(to_bzrdir, target_branch=a_branch)
2324
# cannot obey revision_id limits when cloning a reference ...
2325
# FIXME RBC 20060210 either nuke revision_id for clone, or
2326
# emit some sort of warning/error to the caller ?!
2329
def open(self, a_bzrdir, name=None, _found=False, location=None,
2330
possible_transports=None, ignore_fallbacks=False,
2331
found_repository=None):
2332
"""Return the branch that the branch reference in a_bzrdir points at.
2334
:param a_bzrdir: A BzrDir that contains a branch.
2335
:param name: Name of colocated branch to open, if any
2336
:param _found: a private parameter, do not use it. It is used to
2337
indicate if format probing has already be done.
2338
:param ignore_fallbacks: when set, no fallback branches will be opened
2339
(if there are any). Default is to open fallbacks.
2340
:param location: The location of the referenced branch. If
2341
unspecified, this will be determined from the branch reference in
2343
:param possible_transports: An optional reusable transports list.
2346
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2347
if format.__class__ != self.__class__:
2348
raise AssertionError("wrong format %r found for %r" %
2350
if location is None:
2351
location = self.get_reference(a_bzrdir, name)
2352
real_bzrdir = controldir.ControlDir.open(
2353
location, possible_transports=possible_transports)
2354
result = real_bzrdir.open_branch(name=name,
2355
ignore_fallbacks=ignore_fallbacks,
2356
possible_transports=possible_transports)
2357
# this changes the behaviour of result.clone to create a new reference
2358
# rather than a copy of the content of the branch.
2359
# I did not use a proxy object because that needs much more extensive
2360
# testing, and we are only changing one behaviour at the moment.
2361
# If we decide to alter more behaviours - i.e. the implicit nickname
2362
# then this should be refactored to introduce a tested proxy branch
2363
# and a subclass of that for use in overriding clone() and ....
2365
result.clone = self._make_reference_clone_function(result)
2369
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2370
"""Branch format registry."""
2372
def __init__(self, other_registry=None):
2373
super(BranchFormatRegistry, self).__init__(other_registry)
2374
self._default_format = None
2376
def set_default(self, format):
2377
self._default_format = format
2379
def get_default(self):
2380
return self._default_format
2383
network_format_registry = registry.FormatRegistry()
2384
"""Registry of formats indexed by their network name.
2386
The network name for a branch format is an identifier that can be used when
2387
referring to formats with smart server operations. See
2388
BranchFormat.network_name() for more detail.
2391
format_registry = BranchFormatRegistry(network_format_registry)
2394
# formats which have no format string are not discoverable
2395
# and not independently creatable, so are not registered.
2396
__format5 = BzrBranchFormat5()
2397
__format6 = BzrBranchFormat6()
2398
__format7 = BzrBranchFormat7()
2399
__format8 = BzrBranchFormat8()
2400
format_registry.register(__format5)
2401
format_registry.register(BranchReferenceFormat())
2402
format_registry.register(__format6)
2403
format_registry.register(__format7)
2404
format_registry.register(__format8)
2405
format_registry.set_default(__format7)
2408
class BranchWriteLockResult(LogicalLockResult):
2409
"""The result of write locking a branch.
2411
:ivar branch_token: The token obtained from the underlying branch lock, or
2413
:ivar unlock: A callable which will unlock the lock.
2416
def __init__(self, unlock, branch_token):
2417
LogicalLockResult.__init__(self, unlock)
2418
self.branch_token = branch_token
2421
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2425
class BzrBranch(Branch, _RelockDebugMixin):
2426
"""A branch stored in the actual filesystem.
2428
Note that it's "local" in the context of the filesystem; it doesn't
2429
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2430
it's writable, and can be accessed via the normal filesystem API.
2432
:ivar _transport: Transport for file operations on this branch's
2433
control files, typically pointing to the .bzr/branch directory.
2434
:ivar repository: Repository for this branch.
2435
:ivar base: The url of the base directory for this branch; the one
2436
containing the .bzr directory.
2437
:ivar name: Optional colocated branch name as it exists in the control
2441
def __init__(self, _format=None,
2442
_control_files=None, a_bzrdir=None, name=None,
2443
_repository=None, ignore_fallbacks=False,
2444
possible_transports=None):
2445
"""Create new branch object at a particular location."""
2446
if a_bzrdir is None:
2447
raise ValueError('a_bzrdir must be supplied')
2449
self.bzrdir = a_bzrdir
2450
self._user_transport = self.bzrdir.transport.clone('..')
2451
if name is not None:
2452
self._user_transport.set_segment_parameter(
2453
"branch", urlutils.escape(name))
2454
self._base = self._user_transport.base
2456
self._format = _format
2457
if _control_files is None:
2458
raise ValueError('BzrBranch _control_files is None')
2459
self.control_files = _control_files
2460
self._transport = _control_files._transport
2461
self.repository = _repository
2462
Branch.__init__(self, possible_transports)
2465
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2469
def _get_base(self):
2470
"""Returns the directory containing the control directory."""
2473
base = property(_get_base, doc="The URL for the root of this branch.")
2476
def user_transport(self):
2477
return self._user_transport
2479
def _get_config(self):
2480
return _mod_config.TransportConfig(self._transport, 'branch.conf')
2482
def _get_config_store(self):
2483
return _mod_config.BranchStore(self)
2485
def is_locked(self):
2486
return self.control_files.is_locked()
2488
def lock_write(self, token=None):
2489
"""Lock the branch for write operations.
2491
:param token: A token to permit reacquiring a previously held and
2493
:return: A BranchWriteLockResult.
2495
if not self.is_locked():
2496
self._note_lock('w')
2497
# All-in-one needs to always unlock/lock.
2498
repo_control = getattr(self.repository, 'control_files', None)
2499
if self.control_files == repo_control or not self.is_locked():
2500
self.repository._warn_if_deprecated(self)
2501
self.repository.lock_write()
2506
return BranchWriteLockResult(self.unlock,
2507
self.control_files.lock_write(token=token))
2510
self.repository.unlock()
2513
def lock_read(self):
2514
"""Lock the branch for read operations.
2516
:return: A bzrlib.lock.LogicalLockResult.
2518
if not self.is_locked():
2519
self._note_lock('r')
2520
# All-in-one needs to always unlock/lock.
2521
repo_control = getattr(self.repository, 'control_files', None)
2522
if self.control_files == repo_control or not self.is_locked():
2523
self.repository._warn_if_deprecated(self)
2524
self.repository.lock_read()
2529
self.control_files.lock_read()
2530
return LogicalLockResult(self.unlock)
2533
self.repository.unlock()
2536
@only_raises(errors.LockNotHeld, errors.LockBroken)
2539
self.control_files.unlock()
2541
# All-in-one needs to always unlock/lock.
2542
repo_control = getattr(self.repository, 'control_files', None)
2543
if (self.control_files == repo_control or
2544
not self.control_files.is_locked()):
2545
self.repository.unlock()
2546
if not self.control_files.is_locked():
2547
# we just released the lock
2548
self._clear_cached_state()
2550
def peek_lock_mode(self):
2551
if self.control_files._lock_count == 0:
2554
return self.control_files._lock_mode
2556
def get_physical_lock_status(self):
2557
return self.control_files.get_physical_lock_status()
2560
def print_file(self, file, revision_id):
2561
"""See Branch.print_file."""
2562
return self.repository.print_file(file, revision_id)
2565
def set_last_revision_info(self, revno, revision_id):
2566
if not revision_id or not isinstance(revision_id, basestring):
2567
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2568
revision_id = _mod_revision.ensure_null(revision_id)
2569
old_revno, old_revid = self.last_revision_info()
2570
if self.get_append_revisions_only():
2571
self._check_history_violation(revision_id)
2572
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2573
self._write_last_revision_info(revno, revision_id)
2574
self._clear_cached_state()
2575
self._last_revision_info_cache = revno, revision_id
2576
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2578
def basis_tree(self):
2579
"""See Branch.basis_tree."""
2580
return self.repository.revision_tree(self.last_revision())
2582
def _get_parent_location(self):
2583
_locs = ['parent', 'pull', 'x-pull']
2586
return self._transport.get_bytes(l).strip('\n')
2587
except errors.NoSuchFile:
2591
def get_stacked_on_url(self):
2592
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2594
def set_push_location(self, location):
2595
"""See Branch.set_push_location."""
2596
self.get_config().set_user_option(
2597
'push_location', location,
2598
store=_mod_config.STORE_LOCATION_NORECURSE)
2600
def _set_parent_location(self, url):
2602
self._transport.delete('parent')
2604
self._transport.put_bytes('parent', url + '\n',
2605
mode=self.bzrdir._get_file_mode())
2609
"""If bound, unbind"""
2610
return self.set_bound_location(None)
2613
def bind(self, other):
2614
"""Bind this branch to the branch other.
2616
This does not push or pull data between the branches, though it does
2617
check for divergence to raise an error when the branches are not
2618
either the same, or one a prefix of the other. That behaviour may not
2619
be useful, so that check may be removed in future.
2621
:param other: The branch to bind to
2624
# TODO: jam 20051230 Consider checking if the target is bound
2625
# It is debatable whether you should be able to bind to
2626
# a branch which is itself bound.
2627
# Committing is obviously forbidden,
2628
# but binding itself may not be.
2629
# Since we *have* to check at commit time, we don't
2630
# *need* to check here
2632
# we want to raise diverged if:
2633
# last_rev is not in the other_last_rev history, AND
2634
# other_last_rev is not in our history, and do it without pulling
2636
self.set_bound_location(other.base)
2638
def get_bound_location(self):
2640
return self._transport.get_bytes('bound')[:-1]
2641
except errors.NoSuchFile:
2645
def get_master_branch(self, possible_transports=None):
2646
"""Return the branch we are bound to.
2648
:return: Either a Branch, or None
2650
if self._master_branch_cache is None:
2651
self._master_branch_cache = self._get_master_branch(
2652
possible_transports)
2653
return self._master_branch_cache
2655
def _get_master_branch(self, possible_transports):
2656
bound_loc = self.get_bound_location()
2660
return Branch.open(bound_loc,
2661
possible_transports=possible_transports)
2662
except (errors.NotBranchError, errors.ConnectionError), e:
2663
raise errors.BoundBranchConnectionFailure(
2667
def set_bound_location(self, location):
2668
"""Set the target where this branch is bound to.
2670
:param location: URL to the target branch
2672
self._master_branch_cache = None
2674
self._transport.put_bytes('bound', location+'\n',
2675
mode=self.bzrdir._get_file_mode())
2678
self._transport.delete('bound')
2679
except errors.NoSuchFile:
2684
def update(self, possible_transports=None):
2685
"""Synchronise this branch with the master branch if any.
2687
:return: None or the last_revision that was pivoted out during the
2690
master = self.get_master_branch(possible_transports)
2691
if master is not None:
2692
old_tip = _mod_revision.ensure_null(self.last_revision())
2693
self.pull(master, overwrite=True)
2694
if self.repository.get_graph().is_ancestor(old_tip,
2695
_mod_revision.ensure_null(self.last_revision())):
2700
def _read_last_revision_info(self):
2701
revision_string = self._transport.get_bytes('last-revision')
2702
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2703
revision_id = cache_utf8.get_cached_utf8(revision_id)
2705
return revno, revision_id
2707
def _write_last_revision_info(self, revno, revision_id):
2708
"""Simply write out the revision id, with no checks.
2710
Use set_last_revision_info to perform this safely.
2712
Does not update the revision_history cache.
2714
revision_id = _mod_revision.ensure_null(revision_id)
2715
out_string = '%d %s\n' % (revno, revision_id)
2716
self._transport.put_bytes('last-revision', out_string,
2717
mode=self.bzrdir._get_file_mode())
2720
def update_feature_flags(self, updated_flags):
2721
"""Update the feature flags for this branch.
2723
:param updated_flags: Dictionary mapping feature names to necessities
2724
A necessity can be None to indicate the feature should be removed
2726
self._format._update_feature_flags(updated_flags)
2727
self.control_transport.put_bytes('format', self._format.as_string())
2730
class FullHistoryBzrBranch(BzrBranch):
2731
"""Bzr branch which contains the full revision history."""
2734
def set_last_revision_info(self, revno, revision_id):
2735
if not revision_id or not isinstance(revision_id, basestring):
2736
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2737
revision_id = _mod_revision.ensure_null(revision_id)
2738
# this old format stores the full history, but this api doesn't
2739
# provide it, so we must generate, and might as well check it's
2741
history = self._lefthand_history(revision_id)
2742
if len(history) != revno:
2743
raise AssertionError('%d != %d' % (len(history), revno))
2744
self._set_revision_history(history)
2746
def _read_last_revision_info(self):
2747
rh = self._revision_history()
2750
return (revno, rh[-1])
2752
return (0, _mod_revision.NULL_REVISION)
2754
@deprecated_method(deprecated_in((2, 4, 0)))
2756
def set_revision_history(self, rev_history):
2757
"""See Branch.set_revision_history."""
2758
self._set_revision_history(rev_history)
2760
def _set_revision_history(self, rev_history):
2761
if 'evil' in debug.debug_flags:
2762
mutter_callsite(3, "set_revision_history scales with history.")
2763
check_not_reserved_id = _mod_revision.check_not_reserved_id
2764
for rev_id in rev_history:
2765
check_not_reserved_id(rev_id)
2766
if Branch.hooks['post_change_branch_tip']:
2767
# Don't calculate the last_revision_info() if there are no hooks
2769
old_revno, old_revid = self.last_revision_info()
2770
if len(rev_history) == 0:
2771
revid = _mod_revision.NULL_REVISION
2773
revid = rev_history[-1]
2774
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2775
self._write_revision_history(rev_history)
2776
self._clear_cached_state()
2777
self._cache_revision_history(rev_history)
2778
for hook in Branch.hooks['set_rh']:
2779
hook(self, rev_history)
2780
if Branch.hooks['post_change_branch_tip']:
2781
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2783
def _write_revision_history(self, history):
2784
"""Factored out of set_revision_history.
2786
This performs the actual writing to disk.
2787
It is intended to be called by set_revision_history."""
2788
self._transport.put_bytes(
2789
'revision-history', '\n'.join(history),
2790
mode=self.bzrdir._get_file_mode())
2792
def _gen_revision_history(self):
2793
history = self._transport.get_bytes('revision-history').split('\n')
2794
if history[-1:] == ['']:
2795
# There shouldn't be a trailing newline, but just in case.
2799
def _synchronize_history(self, destination, revision_id):
2800
if not isinstance(destination, FullHistoryBzrBranch):
2801
super(BzrBranch, self)._synchronize_history(
2802
destination, revision_id)
2804
if revision_id == _mod_revision.NULL_REVISION:
2807
new_history = self._revision_history()
2808
if revision_id is not None and new_history != []:
2810
new_history = new_history[:new_history.index(revision_id) + 1]
2812
rev = self.repository.get_revision(revision_id)
2813
new_history = rev.get_history(self.repository)[1:]
2814
destination._set_revision_history(new_history)
2817
def generate_revision_history(self, revision_id, last_rev=None,
2819
"""Create a new revision history that will finish with revision_id.
2821
:param revision_id: the new tip to use.
2822
:param last_rev: The previous last_revision. If not None, then this
2823
must be a ancestory of revision_id, or DivergedBranches is raised.
2824
:param other_branch: The other branch that DivergedBranches should
2825
raise with respect to.
2827
self._set_revision_history(self._lefthand_history(revision_id,
2828
last_rev, other_branch))
2831
class BzrBranch5(FullHistoryBzrBranch):
2832
"""A format 5 branch. This supports new features over plain branches.
2834
It has support for a master_branch which is the data for bound branches.
2838
class BzrBranch8(BzrBranch):
2839
"""A branch that stores tree-reference locations."""
2841
def _open_hook(self, possible_transports=None):
2842
if self._ignore_fallbacks:
2844
if possible_transports is None:
2845
possible_transports = [self.bzrdir.root_transport]
2847
url = self.get_stacked_on_url()
2848
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2849
errors.UnstackableBranchFormat):
2852
for hook in Branch.hooks['transform_fallback_location']:
2853
url = hook(self, url)
2855
hook_name = Branch.hooks.get_hook_name(hook)
2856
raise AssertionError(
2857
"'transform_fallback_location' hook %s returned "
2858
"None, not a URL." % hook_name)
2859
self._activate_fallback_location(url,
2860
possible_transports=possible_transports)
2862
def __init__(self, *args, **kwargs):
2863
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2864
super(BzrBranch8, self).__init__(*args, **kwargs)
2865
self._last_revision_info_cache = None
2866
self._reference_info = None
2868
def _clear_cached_state(self):
2869
super(BzrBranch8, self)._clear_cached_state()
2870
self._last_revision_info_cache = None
2871
self._reference_info = None
2873
def _check_history_violation(self, revision_id):
2874
current_revid = self.last_revision()
2875
last_revision = _mod_revision.ensure_null(current_revid)
2876
if _mod_revision.is_null(last_revision):
2878
graph = self.repository.get_graph()
2879
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2880
if lh_ancestor == current_revid:
2882
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2884
def _gen_revision_history(self):
2885
"""Generate the revision history from last revision
2887
last_revno, last_revision = self.last_revision_info()
2888
self._extend_partial_history(stop_index=last_revno-1)
2889
return list(reversed(self._partial_revision_history_cache))
2892
def _set_parent_location(self, url):
2893
"""Set the parent branch"""
2894
self._set_config_location('parent_location', url, make_relative=True)
2897
def _get_parent_location(self):
2898
"""Set the parent branch"""
2899
return self._get_config_location('parent_location')
2902
def _set_all_reference_info(self, info_dict):
2903
"""Replace all reference info stored in a branch.
2905
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2908
writer = rio.RioWriter(s)
2909
for key, (tree_path, branch_location) in info_dict.iteritems():
2910
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2911
branch_location=branch_location)
2912
writer.write_stanza(stanza)
2913
self._transport.put_bytes('references', s.getvalue())
2914
self._reference_info = info_dict
2917
def _get_all_reference_info(self):
2918
"""Return all the reference info stored in a branch.
2920
:return: A dict of {file_id: (tree_path, branch_location)}
2922
if self._reference_info is not None:
2923
return self._reference_info
2924
rio_file = self._transport.get('references')
2926
stanzas = rio.read_stanzas(rio_file)
2927
info_dict = dict((s['file_id'], (s['tree_path'],
2928
s['branch_location'])) for s in stanzas)
2931
self._reference_info = info_dict
2934
def set_reference_info(self, file_id, tree_path, branch_location):
2935
"""Set the branch location to use for a tree reference.
2937
:param file_id: The file-id of the tree reference.
2938
:param tree_path: The path of the tree reference in the tree.
2939
:param branch_location: The location of the branch to retrieve tree
2942
info_dict = self._get_all_reference_info()
2943
info_dict[file_id] = (tree_path, branch_location)
2944
if None in (tree_path, branch_location):
2945
if tree_path is not None:
2946
raise ValueError('tree_path must be None when branch_location'
2948
if branch_location is not None:
2949
raise ValueError('branch_location must be None when tree_path'
2951
del info_dict[file_id]
2952
self._set_all_reference_info(info_dict)
2954
def get_reference_info(self, file_id):
2955
"""Get the tree_path and branch_location for a tree reference.
2957
:return: a tuple of (tree_path, branch_location)
2959
return self._get_all_reference_info().get(file_id, (None, None))
2961
def reference_parent(self, file_id, path, possible_transports=None):
2962
"""Return the parent branch for a tree-reference file_id.
2964
:param file_id: The file_id of the tree reference
2965
:param path: The path of the file_id in the tree
2966
:return: A branch associated with the file_id
2968
branch_location = self.get_reference_info(file_id)[1]
2969
if branch_location is None:
2970
return Branch.reference_parent(self, file_id, path,
2971
possible_transports)
2972
branch_location = urlutils.join(self.user_url, branch_location)
2973
return Branch.open(branch_location,
2974
possible_transports=possible_transports)
2976
def set_push_location(self, location):
2977
"""See Branch.set_push_location."""
2978
self._set_config_location('push_location', location)
2980
def set_bound_location(self, location):
2981
"""See Branch.set_push_location."""
2982
self._master_branch_cache = None
2984
conf = self.get_config_stack()
2985
if location is None:
2986
if not conf.get('bound'):
2989
conf.set('bound', 'False')
2992
self._set_config_location('bound_location', location,
2994
conf.set('bound', 'True')
2997
def _get_bound_location(self, bound):
2998
"""Return the bound location in the config file.
3000
Return None if the bound parameter does not match"""
3001
conf = self.get_config_stack()
3002
if conf.get('bound') != bound:
3004
return self._get_config_location('bound_location', config=conf)
3006
def get_bound_location(self):
3007
"""See Branch.get_bound_location."""
3008
return self._get_bound_location(True)
3010
def get_old_bound_location(self):
3011
"""See Branch.get_old_bound_location"""
3012
return self._get_bound_location(False)
3014
def get_stacked_on_url(self):
3015
# you can always ask for the URL; but you might not be able to use it
3016
# if the repo can't support stacking.
3017
## self._check_stackable_repo()
3018
# stacked_on_location is only ever defined in branch.conf, so don't
3019
# waste effort reading the whole stack of config files.
3020
conf = _mod_config.BranchOnlyStack(self)
3021
stacked_url = self._get_config_location('stacked_on_location',
3023
if stacked_url is None:
3024
raise errors.NotStacked(self)
3025
return stacked_url.encode('utf-8')
3028
def get_rev_id(self, revno, history=None):
3029
"""Find the revision id of the specified revno."""
3031
return _mod_revision.NULL_REVISION
3033
last_revno, last_revision_id = self.last_revision_info()
3034
if revno <= 0 or revno > last_revno:
3035
raise errors.NoSuchRevision(self, revno)
3037
if history is not None:
3038
return history[revno - 1]
3040
index = last_revno - revno
3041
if len(self._partial_revision_history_cache) <= index:
3042
self._extend_partial_history(stop_index=index)
3043
if len(self._partial_revision_history_cache) > index:
3044
return self._partial_revision_history_cache[index]
3046
raise errors.NoSuchRevision(self, revno)
3049
def revision_id_to_revno(self, revision_id):
3050
"""Given a revision id, return its revno"""
3051
if _mod_revision.is_null(revision_id):
3054
index = self._partial_revision_history_cache.index(revision_id)
3057
self._extend_partial_history(stop_revision=revision_id)
3058
except errors.RevisionNotPresent, e:
3059
raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
3060
index = len(self._partial_revision_history_cache) - 1
3062
raise errors.NoSuchRevision(self, revision_id)
3063
if self._partial_revision_history_cache[index] != revision_id:
3064
raise errors.NoSuchRevision(self, revision_id)
3065
return self.revno() - index
3068
class BzrBranch7(BzrBranch8):
3069
"""A branch with support for a fallback repository."""
3071
def set_reference_info(self, file_id, tree_path, branch_location):
3072
Branch.set_reference_info(self, file_id, tree_path, branch_location)
3074
def get_reference_info(self, file_id):
3075
Branch.get_reference_info(self, file_id)
3077
def reference_parent(self, file_id, path, possible_transports=None):
3078
return Branch.reference_parent(self, file_id, path,
3079
possible_transports)
3082
class BzrBranch6(BzrBranch7):
3083
"""See BzrBranchFormat6 for the capabilities of this branch.
3085
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
3089
def get_stacked_on_url(self):
3090
raise errors.UnstackableBranchFormat(self._format, self.user_url)
3093
######################################################################
3094
# results of operations
3097
class _Result(object):
3099
def _show_tag_conficts(self, to_file):
3100
if not getattr(self, 'tag_conflicts', None):
3102
to_file.write('Conflicting tags:\n')
3103
for name, value1, value2 in self.tag_conflicts:
3104
to_file.write(' %s\n' % (name, ))
3107
class PullResult(_Result):
3108
"""Result of a Branch.pull operation.
3110
:ivar old_revno: Revision number before pull.
3111
:ivar new_revno: Revision number after pull.
3112
:ivar old_revid: Tip revision id before pull.
3113
:ivar new_revid: Tip revision id after pull.
3114
:ivar source_branch: Source (local) branch object. (read locked)
3115
:ivar master_branch: Master branch of the target, or the target if no
3117
:ivar local_branch: target branch if there is a Master, else None
3118
:ivar target_branch: Target/destination branch object. (write locked)
3119
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3120
:ivar tag_updates: A dict with new tags, see BasicTags.merge_to
3123
@deprecated_method(deprecated_in((2, 3, 0)))
3125
"""Return the relative change in revno.
3127
:deprecated: Use `new_revno` and `old_revno` instead.
3129
return self.new_revno - self.old_revno
3131
def report(self, to_file):
3132
tag_conflicts = getattr(self, "tag_conflicts", None)
3133
tag_updates = getattr(self, "tag_updates", None)
3135
if self.old_revid != self.new_revid:
3136
to_file.write('Now on revision %d.\n' % self.new_revno)
3138
to_file.write('%d tag(s) updated.\n' % len(tag_updates))
3139
if self.old_revid == self.new_revid and not tag_updates:
3140
if not tag_conflicts:
3141
to_file.write('No revisions or tags to pull.\n')
3143
to_file.write('No revisions to pull.\n')
3144
self._show_tag_conficts(to_file)
3147
class BranchPushResult(_Result):
3148
"""Result of a Branch.push operation.
3150
:ivar old_revno: Revision number (eg 10) of the target before push.
3151
:ivar new_revno: Revision number (eg 12) of the target after push.
3152
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3154
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3156
:ivar source_branch: Source branch object that the push was from. This is
3157
read locked, and generally is a local (and thus low latency) branch.
3158
:ivar master_branch: If target is a bound branch, the master branch of
3159
target, or target itself. Always write locked.
3160
:ivar target_branch: The direct Branch where data is being sent (write
3162
:ivar local_branch: If the target is a bound branch this will be the
3163
target, otherwise it will be None.
3166
@deprecated_method(deprecated_in((2, 3, 0)))
3168
"""Return the relative change in revno.
3170
:deprecated: Use `new_revno` and `old_revno` instead.
3172
return self.new_revno - self.old_revno
3174
def report(self, to_file):
3175
# TODO: This function gets passed a to_file, but then
3176
# ignores it and calls note() instead. This is also
3177
# inconsistent with PullResult(), which writes to stdout.
3178
# -- JRV20110901, bug #838853
3179
tag_conflicts = getattr(self, "tag_conflicts", None)
3180
tag_updates = getattr(self, "tag_updates", None)
3182
if self.old_revid != self.new_revid:
3183
note(gettext('Pushed up to revision %d.') % self.new_revno)
3185
note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
3186
if self.old_revid == self.new_revid and not tag_updates:
3187
if not tag_conflicts:
3188
note(gettext('No new revisions or tags to push.'))
3190
note(gettext('No new revisions to push.'))
3191
self._show_tag_conficts(to_file)
3194
class BranchCheckResult(object):
3195
"""Results of checking branch consistency.
3200
def __init__(self, branch):
3201
self.branch = branch
3204
def report_results(self, verbose):
3205
"""Report the check results via trace.note.
3207
:param verbose: Requests more detailed display of what was checked,
3210
note(gettext('checked branch {0} format {1}').format(
3211
self.branch.user_url, self.branch._format))
3212
for error in self.errors:
3213
note(gettext('found error:%s'), error)
3216
class Converter5to6(object):
3217
"""Perform an in-place upgrade of format 5 to format 6"""
3219
def convert(self, branch):
3220
# Data for 5 and 6 can peacefully coexist.
3221
format = BzrBranchFormat6()
3222
new_branch = format.open(branch.bzrdir, _found=True)
3224
# Copy source data into target
3225
new_branch._write_last_revision_info(*branch.last_revision_info())
3226
new_branch.set_parent(branch.get_parent())
3227
new_branch.set_bound_location(branch.get_bound_location())
3228
new_branch.set_push_location(branch.get_push_location())
3230
# New branch has no tags by default
3231
new_branch.tags._set_tag_dict({})
3233
# Copying done; now update target format
3234
new_branch._transport.put_bytes('format',
3236
mode=new_branch.bzrdir._get_file_mode())
3238
# Clean up old files
3239
new_branch._transport.delete('revision-history')
3241
branch.set_parent(None)
3242
except errors.NoSuchFile:
3244
branch.set_bound_location(None)
3247
class Converter6to7(object):
3248
"""Perform an in-place upgrade of format 6 to format 7"""
3250
def convert(self, branch):
3251
format = BzrBranchFormat7()
3252
branch._set_config_location('stacked_on_location', '')
3253
# update target format
3254
branch._transport.put_bytes('format', format.as_string())
3257
class Converter7to8(object):
3258
"""Perform an in-place upgrade of format 7 to format 8"""
3260
def convert(self, branch):
3261
format = BzrBranchFormat8()
3262
branch._transport.put_bytes('references', '')
3263
# update target format
3264
branch._transport.put_bytes('format', format.as_string())
3267
class InterBranch(InterObject):
3268
"""This class represents operations taking place between two branches.
3270
Its instances have methods like pull() and push() and contain
3271
references to the source and target repositories these operations
3272
can be carried out on.
3276
"""The available optimised InterBranch types."""
3279
def _get_branch_formats_to_test(klass):
3280
"""Return an iterable of format tuples for testing.
3282
:return: An iterable of (from_format, to_format) to use when testing
3283
this InterBranch class. Each InterBranch class should define this
3286
raise NotImplementedError(klass._get_branch_formats_to_test)
3289
def pull(self, overwrite=False, stop_revision=None,
3290
possible_transports=None, local=False):
3291
"""Mirror source into target branch.
3293
The target branch is considered to be 'local', having low latency.
3295
:returns: PullResult instance
3297
raise NotImplementedError(self.pull)
3300
def push(self, overwrite=False, stop_revision=None, lossy=False,
3301
_override_hook_source_branch=None):
3302
"""Mirror the source branch into the target branch.
3304
The source branch is considered to be 'local', having low latency.
3306
raise NotImplementedError(self.push)
3309
def copy_content_into(self, revision_id=None):
3310
"""Copy the content of source into target
3312
revision_id: if not None, the revision history in the new branch will
3313
be truncated to end with revision_id.
3315
raise NotImplementedError(self.copy_content_into)
3318
def fetch(self, stop_revision=None, limit=None):
3321
:param stop_revision: Last revision to fetch
3322
:param limit: Optional rough limit of revisions to fetch
3324
raise NotImplementedError(self.fetch)
3327
class GenericInterBranch(InterBranch):
3328
"""InterBranch implementation that uses public Branch functions."""
3331
def is_compatible(klass, source, target):
3332
# GenericBranch uses the public API, so always compatible
3336
def _get_branch_formats_to_test(klass):
3337
return [(format_registry.get_default(), format_registry.get_default())]
3340
def unwrap_format(klass, format):
3341
if isinstance(format, remote.RemoteBranchFormat):
3342
format._ensure_real()
3343
return format._custom_format
3347
def copy_content_into(self, revision_id=None):
3348
"""Copy the content of source into target
3350
revision_id: if not None, the revision history in the new branch will
3351
be truncated to end with revision_id.
3353
self.source.update_references(self.target)
3354
self.source._synchronize_history(self.target, revision_id)
3356
parent = self.source.get_parent()
3357
except errors.InaccessibleParent, e:
3358
mutter('parent was not accessible to copy: %s', e)
3361
self.target.set_parent(parent)
3362
if self.source._push_should_merge_tags():
3363
self.source.tags.merge_to(self.target.tags)
3366
def fetch(self, stop_revision=None, limit=None):
3367
if self.target.base == self.source.base:
3369
self.source.lock_read()
3371
fetch_spec_factory = fetch.FetchSpecFactory()
3372
fetch_spec_factory.source_branch = self.source
3373
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3374
fetch_spec_factory.source_repo = self.source.repository
3375
fetch_spec_factory.target_repo = self.target.repository
3376
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3377
fetch_spec_factory.limit = limit
3378
fetch_spec = fetch_spec_factory.make_fetch_spec()
3379
return self.target.repository.fetch(self.source.repository,
3380
fetch_spec=fetch_spec)
3382
self.source.unlock()
3385
def _update_revisions(self, stop_revision=None, overwrite=False,
3387
other_revno, other_last_revision = self.source.last_revision_info()
3388
stop_revno = None # unknown
3389
if stop_revision is None:
3390
stop_revision = other_last_revision
3391
if _mod_revision.is_null(stop_revision):
3392
# if there are no commits, we're done.
3394
stop_revno = other_revno
3396
# what's the current last revision, before we fetch [and change it
3398
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3399
# we fetch here so that we don't process data twice in the common
3400
# case of having something to pull, and so that the check for
3401
# already merged can operate on the just fetched graph, which will
3402
# be cached in memory.
3403
self.fetch(stop_revision=stop_revision)
3404
# Check to see if one is an ancestor of the other
3407
graph = self.target.repository.get_graph()
3408
if self.target._check_if_descendant_or_diverged(
3409
stop_revision, last_rev, graph, self.source):
3410
# stop_revision is a descendant of last_rev, but we aren't
3411
# overwriting, so we're done.
3413
if stop_revno is None:
3415
graph = self.target.repository.get_graph()
3416
this_revno, this_last_revision = \
3417
self.target.last_revision_info()
3418
stop_revno = graph.find_distance_to_null(stop_revision,
3419
[(other_last_revision, other_revno),
3420
(this_last_revision, this_revno)])
3421
self.target.set_last_revision_info(stop_revno, stop_revision)
3424
def pull(self, overwrite=False, stop_revision=None,
3425
possible_transports=None, run_hooks=True,
3426
_override_hook_target=None, local=False):
3427
"""Pull from source into self, updating my master if any.
3429
:param run_hooks: Private parameter - if false, this branch
3430
is being called because it's the master of the primary branch,
3431
so it should not run its hooks.
3433
bound_location = self.target.get_bound_location()
3434
if local and not bound_location:
3435
raise errors.LocalRequiresBoundBranch()
3436
master_branch = None
3437
source_is_master = False
3439
# bound_location comes from a config file, some care has to be
3440
# taken to relate it to source.user_url
3441
normalized = urlutils.normalize_url(bound_location)
3443
relpath = self.source.user_transport.relpath(normalized)
3444
source_is_master = (relpath == '')
3445
except (errors.PathNotChild, errors.InvalidURL):
3446
source_is_master = False
3447
if not local and bound_location and not source_is_master:
3448
# not pulling from master, so we need to update master.
3449
master_branch = self.target.get_master_branch(possible_transports)
3450
master_branch.lock_write()
3453
# pull from source into master.
3454
master_branch.pull(self.source, overwrite, stop_revision,
3456
return self._pull(overwrite,
3457
stop_revision, _hook_master=master_branch,
3458
run_hooks=run_hooks,
3459
_override_hook_target=_override_hook_target,
3460
merge_tags_to_master=not source_is_master)
3463
master_branch.unlock()
3465
def push(self, overwrite=False, stop_revision=None, lossy=False,
3466
_override_hook_source_branch=None):
3467
"""See InterBranch.push.
3469
This is the basic concrete implementation of push()
3471
:param _override_hook_source_branch: If specified, run the hooks
3472
passing this Branch as the source, rather than self. This is for
3473
use of RemoteBranch, where push is delegated to the underlying
3477
raise errors.LossyPushToSameVCS(self.source, self.target)
3478
# TODO: Public option to disable running hooks - should be trivial but
3481
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3482
op.add_cleanup(self.source.lock_read().unlock)
3483
op.add_cleanup(self.target.lock_write().unlock)
3484
return op.run(overwrite, stop_revision,
3485
_override_hook_source_branch=_override_hook_source_branch)
3487
def _basic_push(self, overwrite, stop_revision):
3488
"""Basic implementation of push without bound branches or hooks.
3490
Must be called with source read locked and target write locked.
3492
result = BranchPushResult()
3493
result.source_branch = self.source
3494
result.target_branch = self.target
3495
result.old_revno, result.old_revid = self.target.last_revision_info()
3496
self.source.update_references(self.target)
3497
if result.old_revid != stop_revision:
3498
# We assume that during 'push' this repository is closer than
3500
graph = self.source.repository.get_graph(self.target.repository)
3501
self._update_revisions(stop_revision, overwrite=overwrite,
3503
if self.source._push_should_merge_tags():
3504
result.tag_updates, result.tag_conflicts = (
3505
self.source.tags.merge_to(self.target.tags, overwrite))
3506
result.new_revno, result.new_revid = self.target.last_revision_info()
3509
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3510
_override_hook_source_branch=None):
3511
"""Push from source into target, and into target's master if any.
3514
if _override_hook_source_branch:
3515
result.source_branch = _override_hook_source_branch
3516
for hook in Branch.hooks['post_push']:
3519
bound_location = self.target.get_bound_location()
3520
if bound_location and self.target.base != bound_location:
3521
# there is a master branch.
3523
# XXX: Why the second check? Is it even supported for a branch to
3524
# be bound to itself? -- mbp 20070507
3525
master_branch = self.target.get_master_branch()
3526
master_branch.lock_write()
3527
operation.add_cleanup(master_branch.unlock)
3528
# push into the master from the source branch.
3529
master_inter = InterBranch.get(self.source, master_branch)
3530
master_inter._basic_push(overwrite, stop_revision)
3531
# and push into the target branch from the source. Note that
3532
# we push from the source branch again, because it's considered
3533
# the highest bandwidth repository.
3534
result = self._basic_push(overwrite, stop_revision)
3535
result.master_branch = master_branch
3536
result.local_branch = self.target
3538
master_branch = None
3540
result = self._basic_push(overwrite, stop_revision)
3541
# TODO: Why set master_branch and local_branch if there's no
3542
# binding? Maybe cleaner to just leave them unset? -- mbp
3544
result.master_branch = self.target
3545
result.local_branch = None
3549
def _pull(self, overwrite=False, stop_revision=None,
3550
possible_transports=None, _hook_master=None, run_hooks=True,
3551
_override_hook_target=None, local=False,
3552
merge_tags_to_master=True):
3555
This function is the core worker, used by GenericInterBranch.pull to
3556
avoid duplication when pulling source->master and source->local.
3558
:param _hook_master: Private parameter - set the branch to
3559
be supplied as the master to pull hooks.
3560
:param run_hooks: Private parameter - if false, this branch
3561
is being called because it's the master of the primary branch,
3562
so it should not run its hooks.
3563
is being called because it's the master of the primary branch,
3564
so it should not run its hooks.
3565
:param _override_hook_target: Private parameter - set the branch to be
3566
supplied as the target_branch to pull hooks.
3567
:param local: Only update the local branch, and not the bound branch.
3569
# This type of branch can't be bound.
3571
raise errors.LocalRequiresBoundBranch()
3572
result = PullResult()
3573
result.source_branch = self.source
3574
if _override_hook_target is None:
3575
result.target_branch = self.target
3577
result.target_branch = _override_hook_target
3578
self.source.lock_read()
3580
# We assume that during 'pull' the target repository is closer than
3582
self.source.update_references(self.target)
3583
graph = self.target.repository.get_graph(self.source.repository)
3584
# TODO: Branch formats should have a flag that indicates
3585
# that revno's are expensive, and pull() should honor that flag.
3587
result.old_revno, result.old_revid = \
3588
self.target.last_revision_info()
3589
self._update_revisions(stop_revision, overwrite=overwrite,
3591
# TODO: The old revid should be specified when merging tags,
3592
# so a tags implementation that versions tags can only
3593
# pull in the most recent changes. -- JRV20090506
3594
result.tag_updates, result.tag_conflicts = (
3595
self.source.tags.merge_to(self.target.tags, overwrite,
3596
ignore_master=not merge_tags_to_master))
3597
result.new_revno, result.new_revid = self.target.last_revision_info()
3599
result.master_branch = _hook_master
3600
result.local_branch = result.target_branch
3602
result.master_branch = result.target_branch
3603
result.local_branch = None
3605
for hook in Branch.hooks['post_pull']:
3608
self.source.unlock()
3612
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
