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().get_user_option("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().get_user_option('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().set_user_option('submit_branch', location,
1211
def get_public_branch(self):
1212
"""Return the public location of the branch.
1214
This is used by merge directives.
1216
return self._get_config_location('public_branch')
1218
def set_public_branch(self, location):
1219
"""Return the submit location of the branch.
1221
This is the default location for bundle. The usual
1222
pattern is that the user can override it by specifying a
1225
self._set_config_location('public_branch', location)
1227
def get_push_location(self):
1228
"""Return the None or the location to push this branch to."""
1229
push_loc = self.get_config().get_user_option('push_location')
1232
def set_push_location(self, location):
1233
"""Set a new push location for this branch."""
1234
raise NotImplementedError(self.set_push_location)
1236
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1237
"""Run the post_change_branch_tip hooks."""
1238
hooks = Branch.hooks['post_change_branch_tip']
1241
new_revno, new_revid = self.last_revision_info()
1242
params = ChangeBranchTipParams(
1243
self, old_revno, new_revno, old_revid, new_revid)
1247
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1248
"""Run the pre_change_branch_tip hooks."""
1249
hooks = Branch.hooks['pre_change_branch_tip']
1252
old_revno, old_revid = self.last_revision_info()
1253
params = ChangeBranchTipParams(
1254
self, old_revno, new_revno, old_revid, new_revid)
1260
"""Synchronise this branch with the master branch if any.
1262
:return: None or the last_revision pivoted out during the update.
1266
def check_revno(self, revno):
1268
Check whether a revno corresponds to any revision.
1269
Zero (the NULL revision) is considered valid.
1272
self.check_real_revno(revno)
1274
def check_real_revno(self, revno):
1276
Check whether a revno corresponds to a real revision.
1277
Zero (the NULL revision) is considered invalid
1279
if revno < 1 or revno > self.revno():
1280
raise errors.InvalidRevisionNumber(revno)
1283
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1284
"""Clone this branch into to_bzrdir preserving all semantic values.
1286
Most API users will want 'create_clone_on_transport', which creates a
1287
new bzrdir and branch on the fly.
1289
revision_id: if not None, the revision history in the new branch will
1290
be truncated to end with revision_id.
1292
result = to_bzrdir.create_branch()
1295
if repository_policy is not None:
1296
repository_policy.configure_branch(result)
1297
self.copy_content_into(result, revision_id=revision_id)
1303
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
1305
"""Create a new line of development from the branch, into to_bzrdir.
1307
to_bzrdir controls the branch format.
1309
revision_id: if not None, the revision history in the new branch will
1310
be truncated to end with revision_id.
1312
if (repository_policy is not None and
1313
repository_policy.requires_stacking()):
1314
to_bzrdir._format.require_stacking(_skip_repo=True)
1315
result = to_bzrdir.create_branch(repository=repository)
1318
if repository_policy is not None:
1319
repository_policy.configure_branch(result)
1320
self.copy_content_into(result, revision_id=revision_id)
1321
master_url = self.get_bound_location()
1322
if master_url is None:
1323
result.set_parent(self.bzrdir.root_transport.base)
1325
result.set_parent(master_url)
1330
def _synchronize_history(self, destination, revision_id):
1331
"""Synchronize last revision and revision history between branches.
1333
This version is most efficient when the destination is also a
1334
BzrBranch6, but works for BzrBranch5, as long as the destination's
1335
repository contains all the lefthand ancestors of the intended
1336
last_revision. If not, set_last_revision_info will fail.
1338
:param destination: The branch to copy the history into
1339
:param revision_id: The revision-id to truncate history at. May
1340
be None to copy complete history.
1342
source_revno, source_revision_id = self.last_revision_info()
1343
if revision_id is None:
1344
revno, revision_id = source_revno, source_revision_id
1346
graph = self.repository.get_graph()
1348
revno = graph.find_distance_to_null(revision_id,
1349
[(source_revision_id, source_revno)])
1350
except errors.GhostRevisionsHaveNoRevno:
1351
# Default to 1, if we can't find anything else
1353
destination.set_last_revision_info(revno, revision_id)
1355
def copy_content_into(self, destination, revision_id=None):
1356
"""Copy the content of self into destination.
1358
revision_id: if not None, the revision history in the new branch will
1359
be truncated to end with revision_id.
1361
return InterBranch.get(self, destination).copy_content_into(
1362
revision_id=revision_id)
1364
def update_references(self, target):
1365
if not getattr(self._format, 'supports_reference_locations', False):
1367
reference_dict = self._get_all_reference_info()
1368
if len(reference_dict) == 0:
1370
old_base = self.base
1371
new_base = target.base
1372
target_reference_dict = target._get_all_reference_info()
1373
for file_id, (tree_path, branch_location) in (
1374
reference_dict.items()):
1375
branch_location = urlutils.rebase_url(branch_location,
1377
target_reference_dict.setdefault(
1378
file_id, (tree_path, branch_location))
1379
target._set_all_reference_info(target_reference_dict)
1382
def check(self, refs):
1383
"""Check consistency of the branch.
1385
In particular this checks that revisions given in the revision-history
1386
do actually match up in the revision graph, and that they're all
1387
present in the repository.
1389
Callers will typically also want to check the repository.
1391
:param refs: Calculated refs for this branch as specified by
1392
branch._get_check_refs()
1393
:return: A BranchCheckResult.
1395
result = BranchCheckResult(self)
1396
last_revno, last_revision_id = self.last_revision_info()
1397
actual_revno = refs[('lefthand-distance', last_revision_id)]
1398
if actual_revno != last_revno:
1399
result.errors.append(errors.BzrCheckError(
1400
'revno does not match len(mainline) %s != %s' % (
1401
last_revno, actual_revno)))
1402
# TODO: We should probably also check that self.revision_history
1403
# matches the repository for older branch formats.
1404
# If looking for the code that cross-checks repository parents against
1405
# the Graph.iter_lefthand_ancestry output, that is now a repository
1409
def _get_checkout_format(self, lightweight=False):
1410
"""Return the most suitable metadir for a checkout of this branch.
1411
Weaves are used if this branch's repository uses weaves.
1413
format = self.repository.bzrdir.checkout_metadir()
1414
format.set_branch_format(self._format)
1417
def create_clone_on_transport(self, to_transport, revision_id=None,
1418
stacked_on=None, create_prefix=False, use_existing_dir=False,
1420
"""Create a clone of this branch and its bzrdir.
1422
:param to_transport: The transport to clone onto.
1423
:param revision_id: The revision id to use as tip in the new branch.
1424
If None the tip is obtained from this branch.
1425
:param stacked_on: An optional URL to stack the clone on.
1426
:param create_prefix: Create any missing directories leading up to
1428
:param use_existing_dir: Use an existing directory if one exists.
1430
# XXX: Fix the bzrdir API to allow getting the branch back from the
1431
# clone call. Or something. 20090224 RBC/spiv.
1432
# XXX: Should this perhaps clone colocated branches as well,
1433
# rather than just the default branch? 20100319 JRV
1434
if revision_id is None:
1435
revision_id = self.last_revision()
1436
dir_to = self.bzrdir.clone_on_transport(to_transport,
1437
revision_id=revision_id, stacked_on=stacked_on,
1438
create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1440
return dir_to.open_branch()
1442
def create_checkout(self, to_location, revision_id=None,
1443
lightweight=False, accelerator_tree=None,
1445
"""Create a checkout of a branch.
1447
:param to_location: The url to produce the checkout at
1448
:param revision_id: The revision to check out
1449
:param lightweight: If True, produce a lightweight checkout, otherwise,
1450
produce a bound branch (heavyweight checkout)
1451
:param accelerator_tree: A tree which can be used for retrieving file
1452
contents more quickly than the revision tree, i.e. a workingtree.
1453
The revision tree will be used for cases where accelerator_tree's
1454
content is different.
1455
:param hardlink: If true, hard-link files from accelerator_tree,
1457
:return: The tree of the created checkout
1459
t = transport.get_transport(to_location)
1461
format = self._get_checkout_format(lightweight=lightweight)
1463
checkout = format.initialize_on_transport(t)
1464
from_branch = BranchReferenceFormat().initialize(checkout,
1467
checkout_branch = controldir.ControlDir.create_branch_convenience(
1468
to_location, force_new_tree=False, format=format)
1469
checkout = checkout_branch.bzrdir
1470
checkout_branch.bind(self)
1471
# pull up to the specified revision_id to set the initial
1472
# branch tip correctly, and seed it with history.
1473
checkout_branch.pull(self, stop_revision=revision_id)
1475
tree = checkout.create_workingtree(revision_id,
1476
from_branch=from_branch,
1477
accelerator_tree=accelerator_tree,
1479
basis_tree = tree.basis_tree()
1480
basis_tree.lock_read()
1482
for path, file_id in basis_tree.iter_references():
1483
reference_parent = self.reference_parent(file_id, path)
1484
reference_parent.create_checkout(tree.abspath(path),
1485
basis_tree.get_reference_revision(file_id, path),
1492
def reconcile(self, thorough=True):
1493
"""Make sure the data stored in this branch is consistent."""
1494
from bzrlib.reconcile import BranchReconciler
1495
reconciler = BranchReconciler(self, thorough=thorough)
1496
reconciler.reconcile()
1499
def reference_parent(self, file_id, path, possible_transports=None):
1500
"""Return the parent branch for a tree-reference file_id
1502
:param file_id: The file_id of the tree reference
1503
:param path: The path of the file_id in the tree
1504
:return: A branch associated with the file_id
1506
# FIXME should provide multiple branches, based on config
1507
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1508
possible_transports=possible_transports)
1510
def supports_tags(self):
1511
return self._format.supports_tags()
1513
def automatic_tag_name(self, revision_id):
1514
"""Try to automatically find the tag name for a revision.
1516
:param revision_id: Revision id of the revision.
1517
:return: A tag name or None if no tag name could be determined.
1519
for hook in Branch.hooks['automatic_tag_name']:
1520
ret = hook(self, revision_id)
1525
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1527
"""Ensure that revision_b is a descendant of revision_a.
1529
This is a helper function for update_revisions.
1531
:raises: DivergedBranches if revision_b has diverged from revision_a.
1532
:returns: True if revision_b is a descendant of revision_a.
1534
relation = self._revision_relations(revision_a, revision_b, graph)
1535
if relation == 'b_descends_from_a':
1537
elif relation == 'diverged':
1538
raise errors.DivergedBranches(self, other_branch)
1539
elif relation == 'a_descends_from_b':
1542
raise AssertionError("invalid relation: %r" % (relation,))
1544
def _revision_relations(self, revision_a, revision_b, graph):
1545
"""Determine the relationship between two revisions.
1547
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1549
heads = graph.heads([revision_a, revision_b])
1550
if heads == set([revision_b]):
1551
return 'b_descends_from_a'
1552
elif heads == set([revision_a, revision_b]):
1553
# These branches have diverged
1555
elif heads == set([revision_a]):
1556
return 'a_descends_from_b'
1558
raise AssertionError("invalid heads: %r" % (heads,))
1560
def heads_to_fetch(self):
1561
"""Return the heads that must and that should be fetched to copy this
1562
branch into another repo.
1564
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1565
set of heads that must be fetched. if_present_fetch is a set of
1566
heads that must be fetched if present, but no error is necessary if
1567
they are not present.
1569
# For bzr native formats must_fetch is just the tip, and
1570
# if_present_fetch are the tags.
1571
must_fetch = set([self.last_revision()])
1572
if_present_fetch = set()
1573
if self.get_config_stack().get('branch.fetch_tags'):
1575
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1576
except errors.TagsNotSupported:
1578
must_fetch.discard(_mod_revision.NULL_REVISION)
1579
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1580
return must_fetch, if_present_fetch
1583
class BranchFormat(controldir.ControlComponentFormat):
1584
"""An encapsulation of the initialization and open routines for a format.
1586
Formats provide three things:
1587
* An initialization routine,
1588
* a format description
1591
Formats are placed in an dict by their format string for reference
1592
during branch opening. It's not required that these be instances, they
1593
can be classes themselves with class methods - it simply depends on
1594
whether state is needed for a given format or not.
1596
Once a format is deprecated, just deprecate the initialize and open
1597
methods on the format class. Do not deprecate the object, as the
1598
object will be created every time regardless.
1601
def __eq__(self, other):
1602
return self.__class__ is other.__class__
1604
def __ne__(self, other):
1605
return not (self == other)
1608
@deprecated_method(deprecated_in((2, 4, 0)))
1609
def get_default_format(klass):
1610
"""Return the current default format."""
1611
return format_registry.get_default()
1614
@deprecated_method(deprecated_in((2, 4, 0)))
1615
def get_formats(klass):
1616
"""Get all the known formats.
1618
Warning: This triggers a load of all lazy registered formats: do not
1619
use except when that is desireed.
1621
return format_registry._get_all()
1623
def get_reference(self, controldir, name=None):
1624
"""Get the target reference of the branch in controldir.
1626
format probing must have been completed before calling
1627
this method - it is assumed that the format of the branch
1628
in controldir is correct.
1630
:param controldir: The controldir to get the branch data from.
1631
:param name: Name of the colocated branch to fetch
1632
:return: None if the branch is not a reference branch.
1637
def set_reference(self, controldir, name, to_branch):
1638
"""Set the target reference of the branch in controldir.
1640
format probing must have been completed before calling
1641
this method - it is assumed that the format of the branch
1642
in controldir is correct.
1644
:param controldir: The controldir to set the branch reference for.
1645
:param name: Name of colocated branch to set, None for default
1646
:param to_branch: branch that the checkout is to reference
1648
raise NotImplementedError(self.set_reference)
1650
def get_format_description(self):
1651
"""Return the short format description for this format."""
1652
raise NotImplementedError(self.get_format_description)
1654
def _run_post_branch_init_hooks(self, controldir, name, branch):
1655
hooks = Branch.hooks['post_branch_init']
1658
params = BranchInitHookParams(self, controldir, name, branch)
1662
def initialize(self, controldir, name=None, repository=None,
1663
append_revisions_only=None):
1664
"""Create a branch of this format in controldir.
1666
:param name: Name of the colocated branch to create.
1668
raise NotImplementedError(self.initialize)
1670
def is_supported(self):
1671
"""Is this format supported?
1673
Supported formats can be initialized and opened.
1674
Unsupported formats may not support initialization or committing or
1675
some other features depending on the reason for not being supported.
1679
def make_tags(self, branch):
1680
"""Create a tags object for branch.
1682
This method is on BranchFormat, because BranchFormats are reflected
1683
over the wire via network_name(), whereas full Branch instances require
1684
multiple VFS method calls to operate at all.
1686
The default implementation returns a disabled-tags instance.
1688
Note that it is normal for branch to be a RemoteBranch when using tags
1691
return _mod_tag.DisabledTags(branch)
1693
def network_name(self):
1694
"""A simple byte string uniquely identifying this format for RPC calls.
1696
MetaDir branch formats use their disk format string to identify the
1697
repository over the wire. All in one formats such as bzr < 0.8, and
1698
foreign formats like svn/git and hg should use some marker which is
1699
unique and immutable.
1701
raise NotImplementedError(self.network_name)
1703
def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
1704
found_repository=None, possible_transports=None):
1705
"""Return the branch object for controldir.
1707
:param controldir: A ControlDir that contains a branch.
1708
:param name: Name of colocated branch to open
1709
:param _found: a private parameter, do not use it. It is used to
1710
indicate if format probing has already be done.
1711
:param ignore_fallbacks: when set, no fallback branches will be opened
1712
(if there are any). Default is to open fallbacks.
1714
raise NotImplementedError(self.open)
1717
@deprecated_method(deprecated_in((2, 4, 0)))
1718
def register_format(klass, format):
1719
"""Register a metadir format.
1721
See MetaDirBranchFormatFactory for the ability to register a format
1722
without loading the code the format needs until it is actually used.
1724
format_registry.register(format)
1727
@deprecated_method(deprecated_in((2, 4, 0)))
1728
def set_default_format(klass, format):
1729
format_registry.set_default(format)
1731
def supports_set_append_revisions_only(self):
1732
"""True if this format supports set_append_revisions_only."""
1735
def supports_stacking(self):
1736
"""True if this format records a stacked-on branch."""
1739
def supports_leaving_lock(self):
1740
"""True if this format supports leaving locks in place."""
1741
return False # by default
1744
@deprecated_method(deprecated_in((2, 4, 0)))
1745
def unregister_format(klass, format):
1746
format_registry.remove(format)
1749
return self.get_format_description().rstrip()
1751
def supports_tags(self):
1752
"""True if this format supports tags stored in the branch"""
1753
return False # by default
1755
def tags_are_versioned(self):
1756
"""Whether the tag container for this branch versions tags."""
1759
def supports_tags_referencing_ghosts(self):
1760
"""True if tags can reference ghost revisions."""
1764
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1765
"""A factory for a BranchFormat object, permitting simple lazy registration.
1767
While none of the built in BranchFormats are lazy registered yet,
1768
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1769
use it, and the bzr-loom plugin uses it as well (see
1770
bzrlib.plugins.loom.formats).
1773
def __init__(self, format_string, module_name, member_name):
1774
"""Create a MetaDirBranchFormatFactory.
1776
:param format_string: The format string the format has.
1777
:param module_name: Module to load the format class from.
1778
:param member_name: Attribute name within the module for the format class.
1780
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1781
self._format_string = format_string
1783
def get_format_string(self):
1784
"""See BranchFormat.get_format_string."""
1785
return self._format_string
1788
"""Used for network_format_registry support."""
1789
return self.get_obj()()
1792
class BranchHooks(Hooks):
1793
"""A dictionary mapping hook name to a list of callables for branch hooks.
1795
e.g. ['set_rh'] Is the list of items to be called when the
1796
set_revision_history function is invoked.
1800
"""Create the default hooks.
1802
These are all empty initially, because by default nothing should get
1805
Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1806
self.add_hook('set_rh',
1807
"Invoked whenever the revision history has been set via "
1808
"set_revision_history. The api signature is (branch, "
1809
"revision_history), and the branch will be write-locked. "
1810
"The set_rh hook can be expensive for bzr to trigger, a better "
1811
"hook to use is Branch.post_change_branch_tip.", (0, 15))
1812
self.add_hook('open',
1813
"Called with the Branch object that has been opened after a "
1814
"branch is opened.", (1, 8))
1815
self.add_hook('post_push',
1816
"Called after a push operation completes. post_push is called "
1817
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1818
"bzr client.", (0, 15))
1819
self.add_hook('post_pull',
1820
"Called after a pull operation completes. post_pull is called "
1821
"with a bzrlib.branch.PullResult object and only runs in the "
1822
"bzr client.", (0, 15))
1823
self.add_hook('pre_commit',
1824
"Called after a commit is calculated but before it is "
1825
"completed. pre_commit is called with (local, master, old_revno, "
1826
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1827
"). old_revid is NULL_REVISION for the first commit to a branch, "
1828
"tree_delta is a TreeDelta object describing changes from the "
1829
"basis revision. hooks MUST NOT modify this delta. "
1830
" future_tree is an in-memory tree obtained from "
1831
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1833
self.add_hook('post_commit',
1834
"Called in the bzr client after a commit has completed. "
1835
"post_commit is called with (local, master, old_revno, old_revid, "
1836
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1837
"commit to a branch.", (0, 15))
1838
self.add_hook('post_uncommit',
1839
"Called in the bzr client after an uncommit completes. "
1840
"post_uncommit is called with (local, master, old_revno, "
1841
"old_revid, new_revno, new_revid) where local is the local branch "
1842
"or None, master is the target branch, and an empty branch "
1843
"receives new_revno of 0, new_revid of None.", (0, 15))
1844
self.add_hook('pre_change_branch_tip',
1845
"Called in bzr client and server before a change to the tip of a "
1846
"branch is made. pre_change_branch_tip is called with a "
1847
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1848
"commit, uncommit will all trigger this hook.", (1, 6))
1849
self.add_hook('post_change_branch_tip',
1850
"Called in bzr client and server after a change to the tip of a "
1851
"branch is made. post_change_branch_tip is called with a "
1852
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1853
"commit, uncommit will all trigger this hook.", (1, 4))
1854
self.add_hook('transform_fallback_location',
1855
"Called when a stacked branch is activating its fallback "
1856
"locations. transform_fallback_location is called with (branch, "
1857
"url), and should return a new url. Returning the same url "
1858
"allows it to be used as-is, returning a different one can be "
1859
"used to cause the branch to stack on a closer copy of that "
1860
"fallback_location. Note that the branch cannot have history "
1861
"accessing methods called on it during this hook because the "
1862
"fallback locations have not been activated. When there are "
1863
"multiple hooks installed for transform_fallback_location, "
1864
"all are called with the url returned from the previous hook."
1865
"The order is however undefined.", (1, 9))
1866
self.add_hook('automatic_tag_name',
1867
"Called to determine an automatic tag name for a revision. "
1868
"automatic_tag_name is called with (branch, revision_id) and "
1869
"should return a tag name or None if no tag name could be "
1870
"determined. The first non-None tag name returned will be used.",
1872
self.add_hook('post_branch_init',
1873
"Called after new branch initialization completes. "
1874
"post_branch_init is called with a "
1875
"bzrlib.branch.BranchInitHookParams. "
1876
"Note that init, branch and checkout (both heavyweight and "
1877
"lightweight) will all trigger this hook.", (2, 2))
1878
self.add_hook('post_switch',
1879
"Called after a checkout switches branch. "
1880
"post_switch is called with a "
1881
"bzrlib.branch.SwitchHookParams.", (2, 2))
1885
# install the default hooks into the Branch class.
1886
Branch.hooks = BranchHooks()
1889
class ChangeBranchTipParams(object):
1890
"""Object holding parameters passed to `*_change_branch_tip` hooks.
1892
There are 5 fields that hooks may wish to access:
1894
:ivar branch: the branch being changed
1895
:ivar old_revno: revision number before the change
1896
:ivar new_revno: revision number after the change
1897
:ivar old_revid: revision id before the change
1898
:ivar new_revid: revision id after the change
1900
The revid fields are strings. The revno fields are integers.
1903
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1904
"""Create a group of ChangeBranchTip parameters.
1906
:param branch: The branch being changed.
1907
:param old_revno: Revision number before the change.
1908
:param new_revno: Revision number after the change.
1909
:param old_revid: Tip revision id before the change.
1910
:param new_revid: Tip revision id after the change.
1912
self.branch = branch
1913
self.old_revno = old_revno
1914
self.new_revno = new_revno
1915
self.old_revid = old_revid
1916
self.new_revid = new_revid
1918
def __eq__(self, other):
1919
return self.__dict__ == other.__dict__
1922
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1923
self.__class__.__name__, self.branch,
1924
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1927
class BranchInitHookParams(object):
1928
"""Object holding parameters passed to `*_branch_init` hooks.
1930
There are 4 fields that hooks may wish to access:
1932
:ivar format: the branch format
1933
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1934
:ivar name: name of colocated branch, if any (or None)
1935
:ivar branch: the branch created
1937
Note that for lightweight checkouts, the bzrdir and format fields refer to
1938
the checkout, hence they are different from the corresponding fields in
1939
branch, which refer to the original branch.
1942
def __init__(self, format, controldir, name, branch):
1943
"""Create a group of BranchInitHook parameters.
1945
:param format: the branch format
1946
:param controldir: the ControlDir where the branch will be/has been
1948
:param name: name of colocated branch, if any (or None)
1949
:param branch: the branch created
1951
Note that for lightweight checkouts, the bzrdir and format fields refer
1952
to the checkout, hence they are different from the corresponding fields
1953
in branch, which refer to the original branch.
1955
self.format = format
1956
self.bzrdir = controldir
1958
self.branch = branch
1960
def __eq__(self, other):
1961
return self.__dict__ == other.__dict__
1964
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1967
class SwitchHookParams(object):
1968
"""Object holding parameters passed to `*_switch` hooks.
1970
There are 4 fields that hooks may wish to access:
1972
:ivar control_dir: ControlDir of the checkout to change
1973
:ivar to_branch: branch that the checkout is to reference
1974
:ivar force: skip the check for local commits in a heavy checkout
1975
:ivar revision_id: revision ID to switch to (or None)
1978
def __init__(self, control_dir, to_branch, force, revision_id):
1979
"""Create a group of SwitchHook parameters.
1981
:param control_dir: ControlDir of the checkout to change
1982
:param to_branch: branch that the checkout is to reference
1983
:param force: skip the check for local commits in a heavy checkout
1984
:param revision_id: revision ID to switch to (or None)
1986
self.control_dir = control_dir
1987
self.to_branch = to_branch
1989
self.revision_id = revision_id
1991
def __eq__(self, other):
1992
return self.__dict__ == other.__dict__
1995
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1996
self.control_dir, self.to_branch,
2000
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
2001
"""Base class for branch formats that live in meta directories.
2005
BranchFormat.__init__(self)
2006
bzrdir.BzrFormat.__init__(self)
2009
def find_format(klass, controldir, name=None):
2010
"""Return the format for the branch object in controldir."""
2012
transport = controldir.get_branch_transport(None, name=name)
2013
except errors.NoSuchFile:
2014
raise errors.NotBranchError(path=name, bzrdir=controldir)
2016
format_string = transport.get_bytes("format")
2017
except errors.NoSuchFile:
2018
raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
2019
return klass._find_format(format_registry, 'branch', format_string)
2021
def _branch_class(self):
2022
"""What class to instantiate on open calls."""
2023
raise NotImplementedError(self._branch_class)
2025
def _get_initial_config(self, append_revisions_only=None):
2026
if append_revisions_only:
2027
return "append_revisions_only = True\n"
2029
# Avoid writing anything if append_revisions_only is disabled,
2030
# as that is the default.
2033
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
2035
"""Initialize a branch in a bzrdir, with specified files
2037
:param a_bzrdir: The bzrdir to initialize the branch in
2038
:param utf8_files: The files to create as a list of
2039
(filename, content) tuples
2040
:param name: Name of colocated branch to create, if any
2041
:return: a branch in this format
2043
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2044
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2045
control_files = lockable_files.LockableFiles(branch_transport,
2046
'lock', lockdir.LockDir)
2047
control_files.create_lock()
2048
control_files.lock_write()
2050
utf8_files += [('format', self.as_string())]
2051
for (filename, content) in utf8_files:
2052
branch_transport.put_bytes(
2054
mode=a_bzrdir._get_file_mode())
2056
control_files.unlock()
2057
branch = self.open(a_bzrdir, name, _found=True,
2058
found_repository=repository)
2059
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2062
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2063
found_repository=None, possible_transports=None):
2064
"""See BranchFormat.open()."""
2066
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2067
if format.__class__ != self.__class__:
2068
raise AssertionError("wrong format %r found for %r" %
2070
transport = a_bzrdir.get_branch_transport(None, name=name)
2072
control_files = lockable_files.LockableFiles(transport, 'lock',
2074
if found_repository is None:
2075
found_repository = a_bzrdir.find_repository()
2076
return self._branch_class()(_format=self,
2077
_control_files=control_files,
2080
_repository=found_repository,
2081
ignore_fallbacks=ignore_fallbacks,
2082
possible_transports=possible_transports)
2083
except errors.NoSuchFile:
2084
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2087
def _matchingbzrdir(self):
2088
ret = bzrdir.BzrDirMetaFormat1()
2089
ret.set_branch_format(self)
2092
def supports_tags(self):
2095
def supports_leaving_lock(self):
2098
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
2100
BranchFormat.check_support_status(self,
2101
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
2103
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
2104
recommend_upgrade=recommend_upgrade, basedir=basedir)
2107
class BzrBranchFormat5(BranchFormatMetadir):
2108
"""Bzr branch format 5.
2111
- a revision-history file.
2113
- a lock dir guarding the branch itself
2114
- all of this stored in a branch/ subdirectory
2115
- works with shared repositories.
2117
This format is new in bzr 0.8.
2120
def _branch_class(self):
2124
def get_format_string(cls):
2125
"""See BranchFormat.get_format_string()."""
2126
return "Bazaar-NG branch format 5\n"
2128
def get_format_description(self):
2129
"""See BranchFormat.get_format_description()."""
2130
return "Branch format 5"
2132
def initialize(self, a_bzrdir, name=None, repository=None,
2133
append_revisions_only=None):
2134
"""Create a branch of this format in a_bzrdir."""
2135
if append_revisions_only:
2136
raise errors.UpgradeRequired(a_bzrdir.user_url)
2137
utf8_files = [('revision-history', ''),
2138
('branch-name', ''),
2140
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2142
def supports_tags(self):
2146
class BzrBranchFormat6(BranchFormatMetadir):
2147
"""Branch format with last-revision and tags.
2149
Unlike previous formats, this has no explicit revision history. Instead,
2150
this just stores the last-revision, and the left-hand history leading
2151
up to there is the history.
2153
This format was introduced in bzr 0.15
2154
and became the default in 0.91.
2157
def _branch_class(self):
2161
def get_format_string(cls):
2162
"""See BranchFormat.get_format_string()."""
2163
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2165
def get_format_description(self):
2166
"""See BranchFormat.get_format_description()."""
2167
return "Branch format 6"
2169
def initialize(self, a_bzrdir, name=None, repository=None,
2170
append_revisions_only=None):
2171
"""Create a branch of this format in a_bzrdir."""
2172
utf8_files = [('last-revision', '0 null:\n'),
2174
self._get_initial_config(append_revisions_only)),
2177
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2179
def make_tags(self, branch):
2180
"""See bzrlib.branch.BranchFormat.make_tags()."""
2181
return _mod_tag.BasicTags(branch)
2183
def supports_set_append_revisions_only(self):
2187
class BzrBranchFormat8(BranchFormatMetadir):
2188
"""Metadir format supporting storing locations of subtree branches."""
2190
def _branch_class(self):
2194
def get_format_string(cls):
2195
"""See BranchFormat.get_format_string()."""
2196
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2198
def get_format_description(self):
2199
"""See BranchFormat.get_format_description()."""
2200
return "Branch format 8"
2202
def initialize(self, a_bzrdir, name=None, repository=None,
2203
append_revisions_only=None):
2204
"""Create a branch of this format in a_bzrdir."""
2205
utf8_files = [('last-revision', '0 null:\n'),
2207
self._get_initial_config(append_revisions_only)),
2211
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2213
def make_tags(self, branch):
2214
"""See bzrlib.branch.BranchFormat.make_tags()."""
2215
return _mod_tag.BasicTags(branch)
2217
def supports_set_append_revisions_only(self):
2220
def supports_stacking(self):
2223
supports_reference_locations = True
2226
class BzrBranchFormat7(BranchFormatMetadir):
2227
"""Branch format with last-revision, tags, and a stacked location pointer.
2229
The stacked location pointer is passed down to the repository and requires
2230
a repository format with supports_external_lookups = True.
2232
This format was introduced in bzr 1.6.
2235
def initialize(self, a_bzrdir, name=None, repository=None,
2236
append_revisions_only=None):
2237
"""Create a branch of this format in a_bzrdir."""
2238
utf8_files = [('last-revision', '0 null:\n'),
2240
self._get_initial_config(append_revisions_only)),
2243
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2245
def _branch_class(self):
2249
def get_format_string(cls):
2250
"""See BranchFormat.get_format_string()."""
2251
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2253
def get_format_description(self):
2254
"""See BranchFormat.get_format_description()."""
2255
return "Branch format 7"
2257
def supports_set_append_revisions_only(self):
2260
def supports_stacking(self):
2263
def make_tags(self, branch):
2264
"""See bzrlib.branch.BranchFormat.make_tags()."""
2265
return _mod_tag.BasicTags(branch)
2267
supports_reference_locations = False
2270
class BranchReferenceFormat(BranchFormatMetadir):
2271
"""Bzr branch reference format.
2273
Branch references are used in implementing checkouts, they
2274
act as an alias to the real branch which is at some other url.
2282
def get_format_string(cls):
2283
"""See BranchFormat.get_format_string()."""
2284
return "Bazaar-NG Branch Reference Format 1\n"
2286
def get_format_description(self):
2287
"""See BranchFormat.get_format_description()."""
2288
return "Checkout reference format 1"
2290
def get_reference(self, a_bzrdir, name=None):
2291
"""See BranchFormat.get_reference()."""
2292
transport = a_bzrdir.get_branch_transport(None, name=name)
2293
return transport.get_bytes('location')
2295
def set_reference(self, a_bzrdir, name, to_branch):
2296
"""See BranchFormat.set_reference()."""
2297
transport = a_bzrdir.get_branch_transport(None, name=name)
2298
location = transport.put_bytes('location', to_branch.base)
2300
def initialize(self, a_bzrdir, name=None, target_branch=None,
2301
repository=None, append_revisions_only=None):
2302
"""Create a branch of this format in a_bzrdir."""
2303
if target_branch is None:
2304
# this format does not implement branch itself, thus the implicit
2305
# creation contract must see it as uninitializable
2306
raise errors.UninitializableFormat(self)
2307
mutter('creating branch reference in %s', a_bzrdir.user_url)
2308
if a_bzrdir._format.fixed_components:
2309
raise errors.IncompatibleFormat(self, a_bzrdir._format)
2310
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2311
branch_transport.put_bytes('location',
2312
target_branch.user_url)
2313
branch_transport.put_bytes('format', self.as_string())
2315
a_bzrdir, name, _found=True,
2316
possible_transports=[target_branch.bzrdir.root_transport])
2317
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2320
def _make_reference_clone_function(format, a_branch):
2321
"""Create a clone() routine for a branch dynamically."""
2322
def clone(to_bzrdir, revision_id=None,
2323
repository_policy=None):
2324
"""See Branch.clone()."""
2325
return format.initialize(to_bzrdir, target_branch=a_branch)
2326
# cannot obey revision_id limits when cloning a reference ...
2327
# FIXME RBC 20060210 either nuke revision_id for clone, or
2328
# emit some sort of warning/error to the caller ?!
2331
def open(self, a_bzrdir, name=None, _found=False, location=None,
2332
possible_transports=None, ignore_fallbacks=False,
2333
found_repository=None):
2334
"""Return the branch that the branch reference in a_bzrdir points at.
2336
:param a_bzrdir: A BzrDir that contains a branch.
2337
:param name: Name of colocated branch to open, if any
2338
:param _found: a private parameter, do not use it. It is used to
2339
indicate if format probing has already be done.
2340
:param ignore_fallbacks: when set, no fallback branches will be opened
2341
(if there are any). Default is to open fallbacks.
2342
:param location: The location of the referenced branch. If
2343
unspecified, this will be determined from the branch reference in
2345
:param possible_transports: An optional reusable transports list.
2348
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2349
if format.__class__ != self.__class__:
2350
raise AssertionError("wrong format %r found for %r" %
2352
if location is None:
2353
location = self.get_reference(a_bzrdir, name)
2354
real_bzrdir = controldir.ControlDir.open(
2355
location, possible_transports=possible_transports)
2356
result = real_bzrdir.open_branch(name=name,
2357
ignore_fallbacks=ignore_fallbacks,
2358
possible_transports=possible_transports)
2359
# this changes the behaviour of result.clone to create a new reference
2360
# rather than a copy of the content of the branch.
2361
# I did not use a proxy object because that needs much more extensive
2362
# testing, and we are only changing one behaviour at the moment.
2363
# If we decide to alter more behaviours - i.e. the implicit nickname
2364
# then this should be refactored to introduce a tested proxy branch
2365
# and a subclass of that for use in overriding clone() and ....
2367
result.clone = self._make_reference_clone_function(result)
2371
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2372
"""Branch format registry."""
2374
def __init__(self, other_registry=None):
2375
super(BranchFormatRegistry, self).__init__(other_registry)
2376
self._default_format = None
2378
def set_default(self, format):
2379
self._default_format = format
2381
def get_default(self):
2382
return self._default_format
2385
network_format_registry = registry.FormatRegistry()
2386
"""Registry of formats indexed by their network name.
2388
The network name for a branch format is an identifier that can be used when
2389
referring to formats with smart server operations. See
2390
BranchFormat.network_name() for more detail.
2393
format_registry = BranchFormatRegistry(network_format_registry)
2396
# formats which have no format string are not discoverable
2397
# and not independently creatable, so are not registered.
2398
__format5 = BzrBranchFormat5()
2399
__format6 = BzrBranchFormat6()
2400
__format7 = BzrBranchFormat7()
2401
__format8 = BzrBranchFormat8()
2402
format_registry.register(__format5)
2403
format_registry.register(BranchReferenceFormat())
2404
format_registry.register(__format6)
2405
format_registry.register(__format7)
2406
format_registry.register(__format8)
2407
format_registry.set_default(__format7)
2410
class BranchWriteLockResult(LogicalLockResult):
2411
"""The result of write locking a branch.
2413
:ivar branch_token: The token obtained from the underlying branch lock, or
2415
:ivar unlock: A callable which will unlock the lock.
2418
def __init__(self, unlock, branch_token):
2419
LogicalLockResult.__init__(self, unlock)
2420
self.branch_token = branch_token
2423
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2427
class BzrBranch(Branch, _RelockDebugMixin):
2428
"""A branch stored in the actual filesystem.
2430
Note that it's "local" in the context of the filesystem; it doesn't
2431
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2432
it's writable, and can be accessed via the normal filesystem API.
2434
:ivar _transport: Transport for file operations on this branch's
2435
control files, typically pointing to the .bzr/branch directory.
2436
:ivar repository: Repository for this branch.
2437
:ivar base: The url of the base directory for this branch; the one
2438
containing the .bzr directory.
2439
:ivar name: Optional colocated branch name as it exists in the control
2443
def __init__(self, _format=None,
2444
_control_files=None, a_bzrdir=None, name=None,
2445
_repository=None, ignore_fallbacks=False,
2446
possible_transports=None):
2447
"""Create new branch object at a particular location."""
2448
if a_bzrdir is None:
2449
raise ValueError('a_bzrdir must be supplied')
2451
self.bzrdir = a_bzrdir
2452
self._user_transport = self.bzrdir.transport.clone('..')
2453
if name is not None:
2454
self._user_transport.set_segment_parameter(
2455
"branch", urlutils.escape(name))
2456
self._base = self._user_transport.base
2458
self._format = _format
2459
if _control_files is None:
2460
raise ValueError('BzrBranch _control_files is None')
2461
self.control_files = _control_files
2462
self._transport = _control_files._transport
2463
self.repository = _repository
2464
Branch.__init__(self, possible_transports)
2467
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2471
def _get_base(self):
2472
"""Returns the directory containing the control directory."""
2475
base = property(_get_base, doc="The URL for the root of this branch.")
2478
def user_transport(self):
2479
return self._user_transport
2481
def _get_config(self):
2482
return _mod_config.TransportConfig(self._transport, 'branch.conf')
2484
def _get_config_store(self):
2485
return _mod_config.BranchStore(self)
2487
def is_locked(self):
2488
return self.control_files.is_locked()
2490
def lock_write(self, token=None):
2491
"""Lock the branch for write operations.
2493
:param token: A token to permit reacquiring a previously held and
2495
:return: A BranchWriteLockResult.
2497
if not self.is_locked():
2498
self._note_lock('w')
2499
# All-in-one needs to always unlock/lock.
2500
repo_control = getattr(self.repository, 'control_files', None)
2501
if self.control_files == repo_control or not self.is_locked():
2502
self.repository._warn_if_deprecated(self)
2503
self.repository.lock_write()
2508
return BranchWriteLockResult(self.unlock,
2509
self.control_files.lock_write(token=token))
2512
self.repository.unlock()
2515
def lock_read(self):
2516
"""Lock the branch for read operations.
2518
:return: A bzrlib.lock.LogicalLockResult.
2520
if not self.is_locked():
2521
self._note_lock('r')
2522
# All-in-one needs to always unlock/lock.
2523
repo_control = getattr(self.repository, 'control_files', None)
2524
if self.control_files == repo_control or not self.is_locked():
2525
self.repository._warn_if_deprecated(self)
2526
self.repository.lock_read()
2531
self.control_files.lock_read()
2532
return LogicalLockResult(self.unlock)
2535
self.repository.unlock()
2538
@only_raises(errors.LockNotHeld, errors.LockBroken)
2541
self.control_files.unlock()
2543
# All-in-one needs to always unlock/lock.
2544
repo_control = getattr(self.repository, 'control_files', None)
2545
if (self.control_files == repo_control or
2546
not self.control_files.is_locked()):
2547
self.repository.unlock()
2548
if not self.control_files.is_locked():
2549
# we just released the lock
2550
self._clear_cached_state()
2552
def peek_lock_mode(self):
2553
if self.control_files._lock_count == 0:
2556
return self.control_files._lock_mode
2558
def get_physical_lock_status(self):
2559
return self.control_files.get_physical_lock_status()
2562
def print_file(self, file, revision_id):
2563
"""See Branch.print_file."""
2564
return self.repository.print_file(file, revision_id)
2567
def set_last_revision_info(self, revno, revision_id):
2568
if not revision_id or not isinstance(revision_id, basestring):
2569
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2570
revision_id = _mod_revision.ensure_null(revision_id)
2571
old_revno, old_revid = self.last_revision_info()
2572
if self.get_append_revisions_only():
2573
self._check_history_violation(revision_id)
2574
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2575
self._write_last_revision_info(revno, revision_id)
2576
self._clear_cached_state()
2577
self._last_revision_info_cache = revno, revision_id
2578
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2580
def basis_tree(self):
2581
"""See Branch.basis_tree."""
2582
return self.repository.revision_tree(self.last_revision())
2584
def _get_parent_location(self):
2585
_locs = ['parent', 'pull', 'x-pull']
2588
return self._transport.get_bytes(l).strip('\n')
2589
except errors.NoSuchFile:
2593
def get_stacked_on_url(self):
2594
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2596
def set_push_location(self, location):
2597
"""See Branch.set_push_location."""
2598
self.get_config().set_user_option(
2599
'push_location', location,
2600
store=_mod_config.STORE_LOCATION_NORECURSE)
2602
def _set_parent_location(self, url):
2604
self._transport.delete('parent')
2606
self._transport.put_bytes('parent', url + '\n',
2607
mode=self.bzrdir._get_file_mode())
2611
"""If bound, unbind"""
2612
return self.set_bound_location(None)
2615
def bind(self, other):
2616
"""Bind this branch to the branch other.
2618
This does not push or pull data between the branches, though it does
2619
check for divergence to raise an error when the branches are not
2620
either the same, or one a prefix of the other. That behaviour may not
2621
be useful, so that check may be removed in future.
2623
:param other: The branch to bind to
2626
# TODO: jam 20051230 Consider checking if the target is bound
2627
# It is debatable whether you should be able to bind to
2628
# a branch which is itself bound.
2629
# Committing is obviously forbidden,
2630
# but binding itself may not be.
2631
# Since we *have* to check at commit time, we don't
2632
# *need* to check here
2634
# we want to raise diverged if:
2635
# last_rev is not in the other_last_rev history, AND
2636
# other_last_rev is not in our history, and do it without pulling
2638
self.set_bound_location(other.base)
2640
def get_bound_location(self):
2642
return self._transport.get_bytes('bound')[:-1]
2643
except errors.NoSuchFile:
2647
def get_master_branch(self, possible_transports=None):
2648
"""Return the branch we are bound to.
2650
:return: Either a Branch, or None
2652
if self._master_branch_cache is None:
2653
self._master_branch_cache = self._get_master_branch(
2654
possible_transports)
2655
return self._master_branch_cache
2657
def _get_master_branch(self, possible_transports):
2658
bound_loc = self.get_bound_location()
2662
return Branch.open(bound_loc,
2663
possible_transports=possible_transports)
2664
except (errors.NotBranchError, errors.ConnectionError), e:
2665
raise errors.BoundBranchConnectionFailure(
2669
def set_bound_location(self, location):
2670
"""Set the target where this branch is bound to.
2672
:param location: URL to the target branch
2674
self._master_branch_cache = None
2676
self._transport.put_bytes('bound', location+'\n',
2677
mode=self.bzrdir._get_file_mode())
2680
self._transport.delete('bound')
2681
except errors.NoSuchFile:
2686
def update(self, possible_transports=None):
2687
"""Synchronise this branch with the master branch if any.
2689
:return: None or the last_revision that was pivoted out during the
2692
master = self.get_master_branch(possible_transports)
2693
if master is not None:
2694
old_tip = _mod_revision.ensure_null(self.last_revision())
2695
self.pull(master, overwrite=True)
2696
if self.repository.get_graph().is_ancestor(old_tip,
2697
_mod_revision.ensure_null(self.last_revision())):
2702
def _read_last_revision_info(self):
2703
revision_string = self._transport.get_bytes('last-revision')
2704
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2705
revision_id = cache_utf8.get_cached_utf8(revision_id)
2707
return revno, revision_id
2709
def _write_last_revision_info(self, revno, revision_id):
2710
"""Simply write out the revision id, with no checks.
2712
Use set_last_revision_info to perform this safely.
2714
Does not update the revision_history cache.
2716
revision_id = _mod_revision.ensure_null(revision_id)
2717
out_string = '%d %s\n' % (revno, revision_id)
2718
self._transport.put_bytes('last-revision', out_string,
2719
mode=self.bzrdir._get_file_mode())
2722
def update_feature_flags(self, updated_flags):
2723
"""Update the feature flags for this branch.
2725
:param updated_flags: Dictionary mapping feature names to necessities
2726
A necessity can be None to indicate the feature should be removed
2728
self._format._update_feature_flags(updated_flags)
2729
self.control_transport.put_bytes('format', self._format.as_string())
2732
class FullHistoryBzrBranch(BzrBranch):
2733
"""Bzr branch which contains the full revision history."""
2736
def set_last_revision_info(self, revno, revision_id):
2737
if not revision_id or not isinstance(revision_id, basestring):
2738
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2739
revision_id = _mod_revision.ensure_null(revision_id)
2740
# this old format stores the full history, but this api doesn't
2741
# provide it, so we must generate, and might as well check it's
2743
history = self._lefthand_history(revision_id)
2744
if len(history) != revno:
2745
raise AssertionError('%d != %d' % (len(history), revno))
2746
self._set_revision_history(history)
2748
def _read_last_revision_info(self):
2749
rh = self._revision_history()
2752
return (revno, rh[-1])
2754
return (0, _mod_revision.NULL_REVISION)
2756
@deprecated_method(deprecated_in((2, 4, 0)))
2758
def set_revision_history(self, rev_history):
2759
"""See Branch.set_revision_history."""
2760
self._set_revision_history(rev_history)
2762
def _set_revision_history(self, rev_history):
2763
if 'evil' in debug.debug_flags:
2764
mutter_callsite(3, "set_revision_history scales with history.")
2765
check_not_reserved_id = _mod_revision.check_not_reserved_id
2766
for rev_id in rev_history:
2767
check_not_reserved_id(rev_id)
2768
if Branch.hooks['post_change_branch_tip']:
2769
# Don't calculate the last_revision_info() if there are no hooks
2771
old_revno, old_revid = self.last_revision_info()
2772
if len(rev_history) == 0:
2773
revid = _mod_revision.NULL_REVISION
2775
revid = rev_history[-1]
2776
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2777
self._write_revision_history(rev_history)
2778
self._clear_cached_state()
2779
self._cache_revision_history(rev_history)
2780
for hook in Branch.hooks['set_rh']:
2781
hook(self, rev_history)
2782
if Branch.hooks['post_change_branch_tip']:
2783
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2785
def _write_revision_history(self, history):
2786
"""Factored out of set_revision_history.
2788
This performs the actual writing to disk.
2789
It is intended to be called by set_revision_history."""
2790
self._transport.put_bytes(
2791
'revision-history', '\n'.join(history),
2792
mode=self.bzrdir._get_file_mode())
2794
def _gen_revision_history(self):
2795
history = self._transport.get_bytes('revision-history').split('\n')
2796
if history[-1:] == ['']:
2797
# There shouldn't be a trailing newline, but just in case.
2801
def _synchronize_history(self, destination, revision_id):
2802
if not isinstance(destination, FullHistoryBzrBranch):
2803
super(BzrBranch, self)._synchronize_history(
2804
destination, revision_id)
2806
if revision_id == _mod_revision.NULL_REVISION:
2809
new_history = self._revision_history()
2810
if revision_id is not None and new_history != []:
2812
new_history = new_history[:new_history.index(revision_id) + 1]
2814
rev = self.repository.get_revision(revision_id)
2815
new_history = rev.get_history(self.repository)[1:]
2816
destination._set_revision_history(new_history)
2819
def generate_revision_history(self, revision_id, last_rev=None,
2821
"""Create a new revision history that will finish with revision_id.
2823
:param revision_id: the new tip to use.
2824
:param last_rev: The previous last_revision. If not None, then this
2825
must be a ancestory of revision_id, or DivergedBranches is raised.
2826
:param other_branch: The other branch that DivergedBranches should
2827
raise with respect to.
2829
self._set_revision_history(self._lefthand_history(revision_id,
2830
last_rev, other_branch))
2833
class BzrBranch5(FullHistoryBzrBranch):
2834
"""A format 5 branch. This supports new features over plain branches.
2836
It has support for a master_branch which is the data for bound branches.
2840
class BzrBranch8(BzrBranch):
2841
"""A branch that stores tree-reference locations."""
2843
def _open_hook(self, possible_transports=None):
2844
if self._ignore_fallbacks:
2846
if possible_transports is None:
2847
possible_transports = [self.bzrdir.root_transport]
2849
url = self.get_stacked_on_url()
2850
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2851
errors.UnstackableBranchFormat):
2854
for hook in Branch.hooks['transform_fallback_location']:
2855
url = hook(self, url)
2857
hook_name = Branch.hooks.get_hook_name(hook)
2858
raise AssertionError(
2859
"'transform_fallback_location' hook %s returned "
2860
"None, not a URL." % hook_name)
2861
self._activate_fallback_location(url,
2862
possible_transports=possible_transports)
2864
def __init__(self, *args, **kwargs):
2865
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2866
super(BzrBranch8, self).__init__(*args, **kwargs)
2867
self._last_revision_info_cache = None
2868
self._reference_info = None
2870
def _clear_cached_state(self):
2871
super(BzrBranch8, self)._clear_cached_state()
2872
self._last_revision_info_cache = None
2873
self._reference_info = None
2875
def _check_history_violation(self, revision_id):
2876
current_revid = self.last_revision()
2877
last_revision = _mod_revision.ensure_null(current_revid)
2878
if _mod_revision.is_null(last_revision):
2880
graph = self.repository.get_graph()
2881
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2882
if lh_ancestor == current_revid:
2884
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2886
def _gen_revision_history(self):
2887
"""Generate the revision history from last revision
2889
last_revno, last_revision = self.last_revision_info()
2890
self._extend_partial_history(stop_index=last_revno-1)
2891
return list(reversed(self._partial_revision_history_cache))
2894
def _set_parent_location(self, url):
2895
"""Set the parent branch"""
2896
self._set_config_location('parent_location', url, make_relative=True)
2899
def _get_parent_location(self):
2900
"""Set the parent branch"""
2901
return self._get_config_location('parent_location')
2904
def _set_all_reference_info(self, info_dict):
2905
"""Replace all reference info stored in a branch.
2907
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2910
writer = rio.RioWriter(s)
2911
for key, (tree_path, branch_location) in info_dict.iteritems():
2912
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2913
branch_location=branch_location)
2914
writer.write_stanza(stanza)
2915
self._transport.put_bytes('references', s.getvalue())
2916
self._reference_info = info_dict
2919
def _get_all_reference_info(self):
2920
"""Return all the reference info stored in a branch.
2922
:return: A dict of {file_id: (tree_path, branch_location)}
2924
if self._reference_info is not None:
2925
return self._reference_info
2926
rio_file = self._transport.get('references')
2928
stanzas = rio.read_stanzas(rio_file)
2929
info_dict = dict((s['file_id'], (s['tree_path'],
2930
s['branch_location'])) for s in stanzas)
2933
self._reference_info = info_dict
2936
def set_reference_info(self, file_id, tree_path, branch_location):
2937
"""Set the branch location to use for a tree reference.
2939
:param file_id: The file-id of the tree reference.
2940
:param tree_path: The path of the tree reference in the tree.
2941
:param branch_location: The location of the branch to retrieve tree
2944
info_dict = self._get_all_reference_info()
2945
info_dict[file_id] = (tree_path, branch_location)
2946
if None in (tree_path, branch_location):
2947
if tree_path is not None:
2948
raise ValueError('tree_path must be None when branch_location'
2950
if branch_location is not None:
2951
raise ValueError('branch_location must be None when tree_path'
2953
del info_dict[file_id]
2954
self._set_all_reference_info(info_dict)
2956
def get_reference_info(self, file_id):
2957
"""Get the tree_path and branch_location for a tree reference.
2959
:return: a tuple of (tree_path, branch_location)
2961
return self._get_all_reference_info().get(file_id, (None, None))
2963
def reference_parent(self, file_id, path, possible_transports=None):
2964
"""Return the parent branch for a tree-reference file_id.
2966
:param file_id: The file_id of the tree reference
2967
:param path: The path of the file_id in the tree
2968
:return: A branch associated with the file_id
2970
branch_location = self.get_reference_info(file_id)[1]
2971
if branch_location is None:
2972
return Branch.reference_parent(self, file_id, path,
2973
possible_transports)
2974
branch_location = urlutils.join(self.user_url, branch_location)
2975
return Branch.open(branch_location,
2976
possible_transports=possible_transports)
2978
def set_push_location(self, location):
2979
"""See Branch.set_push_location."""
2980
self._set_config_location('push_location', location)
2982
def set_bound_location(self, location):
2983
"""See Branch.set_push_location."""
2984
self._master_branch_cache = None
2986
conf = self.get_config_stack()
2987
if location is None:
2988
if not conf.get('bound'):
2991
conf.set('bound', 'False')
2994
self._set_config_location('bound_location', location,
2996
conf.set('bound', 'True')
2999
def _get_bound_location(self, bound):
3000
"""Return the bound location in the config file.
3002
Return None if the bound parameter does not match"""
3003
conf = self.get_config_stack()
3004
if conf.get('bound') != bound:
3006
return self._get_config_location('bound_location', config=conf)
3008
def get_bound_location(self):
3009
"""See Branch.set_push_location."""
3010
return self._get_bound_location(True)
3012
def get_old_bound_location(self):
3013
"""See Branch.get_old_bound_location"""
3014
return self._get_bound_location(False)
3016
def get_stacked_on_url(self):
3017
# you can always ask for the URL; but you might not be able to use it
3018
# if the repo can't support stacking.
3019
## self._check_stackable_repo()
3020
# stacked_on_location is only ever defined in branch.conf, so don't
3021
# waste effort reading the whole stack of config files.
3022
conf = _mod_config.BranchOnlyStack(self)
3023
stacked_url = self._get_config_location('stacked_on_location',
3025
if stacked_url is None:
3026
raise errors.NotStacked(self)
3027
return stacked_url.encode('utf-8')
3030
def get_rev_id(self, revno, history=None):
3031
"""Find the revision id of the specified revno."""
3033
return _mod_revision.NULL_REVISION
3035
last_revno, last_revision_id = self.last_revision_info()
3036
if revno <= 0 or revno > last_revno:
3037
raise errors.NoSuchRevision(self, revno)
3039
if history is not None:
3040
return history[revno - 1]
3042
index = last_revno - revno
3043
if len(self._partial_revision_history_cache) <= index:
3044
self._extend_partial_history(stop_index=index)
3045
if len(self._partial_revision_history_cache) > index:
3046
return self._partial_revision_history_cache[index]
3048
raise errors.NoSuchRevision(self, revno)
3051
def revision_id_to_revno(self, revision_id):
3052
"""Given a revision id, return its revno"""
3053
if _mod_revision.is_null(revision_id):
3056
index = self._partial_revision_history_cache.index(revision_id)
3059
self._extend_partial_history(stop_revision=revision_id)
3060
except errors.RevisionNotPresent, e:
3061
raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
3062
index = len(self._partial_revision_history_cache) - 1
3064
raise errors.NoSuchRevision(self, revision_id)
3065
if self._partial_revision_history_cache[index] != revision_id:
3066
raise errors.NoSuchRevision(self, revision_id)
3067
return self.revno() - index
3070
class BzrBranch7(BzrBranch8):
3071
"""A branch with support for a fallback repository."""
3073
def set_reference_info(self, file_id, tree_path, branch_location):
3074
Branch.set_reference_info(self, file_id, tree_path, branch_location)
3076
def get_reference_info(self, file_id):
3077
Branch.get_reference_info(self, file_id)
3079
def reference_parent(self, file_id, path, possible_transports=None):
3080
return Branch.reference_parent(self, file_id, path,
3081
possible_transports)
3084
class BzrBranch6(BzrBranch7):
3085
"""See BzrBranchFormat6 for the capabilities of this branch.
3087
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
3091
def get_stacked_on_url(self):
3092
raise errors.UnstackableBranchFormat(self._format, self.user_url)
3095
######################################################################
3096
# results of operations
3099
class _Result(object):
3101
def _show_tag_conficts(self, to_file):
3102
if not getattr(self, 'tag_conflicts', None):
3104
to_file.write('Conflicting tags:\n')
3105
for name, value1, value2 in self.tag_conflicts:
3106
to_file.write(' %s\n' % (name, ))
3109
class PullResult(_Result):
3110
"""Result of a Branch.pull operation.
3112
:ivar old_revno: Revision number before pull.
3113
:ivar new_revno: Revision number after pull.
3114
:ivar old_revid: Tip revision id before pull.
3115
:ivar new_revid: Tip revision id after pull.
3116
:ivar source_branch: Source (local) branch object. (read locked)
3117
:ivar master_branch: Master branch of the target, or the target if no
3119
:ivar local_branch: target branch if there is a Master, else None
3120
:ivar target_branch: Target/destination branch object. (write locked)
3121
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3122
:ivar tag_updates: A dict with new tags, see BasicTags.merge_to
3125
@deprecated_method(deprecated_in((2, 3, 0)))
3127
"""Return the relative change in revno.
3129
:deprecated: Use `new_revno` and `old_revno` instead.
3131
return self.new_revno - self.old_revno
3133
def report(self, to_file):
3134
tag_conflicts = getattr(self, "tag_conflicts", None)
3135
tag_updates = getattr(self, "tag_updates", None)
3137
if self.old_revid != self.new_revid:
3138
to_file.write('Now on revision %d.\n' % self.new_revno)
3140
to_file.write('%d tag(s) updated.\n' % len(tag_updates))
3141
if self.old_revid == self.new_revid and not tag_updates:
3142
if not tag_conflicts:
3143
to_file.write('No revisions or tags to pull.\n')
3145
to_file.write('No revisions to pull.\n')
3146
self._show_tag_conficts(to_file)
3149
class BranchPushResult(_Result):
3150
"""Result of a Branch.push operation.
3152
:ivar old_revno: Revision number (eg 10) of the target before push.
3153
:ivar new_revno: Revision number (eg 12) of the target after push.
3154
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3156
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3158
:ivar source_branch: Source branch object that the push was from. This is
3159
read locked, and generally is a local (and thus low latency) branch.
3160
:ivar master_branch: If target is a bound branch, the master branch of
3161
target, or target itself. Always write locked.
3162
:ivar target_branch: The direct Branch where data is being sent (write
3164
:ivar local_branch: If the target is a bound branch this will be the
3165
target, otherwise it will be None.
3168
@deprecated_method(deprecated_in((2, 3, 0)))
3170
"""Return the relative change in revno.
3172
:deprecated: Use `new_revno` and `old_revno` instead.
3174
return self.new_revno - self.old_revno
3176
def report(self, to_file):
3177
# TODO: This function gets passed a to_file, but then
3178
# ignores it and calls note() instead. This is also
3179
# inconsistent with PullResult(), which writes to stdout.
3180
# -- JRV20110901, bug #838853
3181
tag_conflicts = getattr(self, "tag_conflicts", None)
3182
tag_updates = getattr(self, "tag_updates", None)
3184
if self.old_revid != self.new_revid:
3185
note(gettext('Pushed up to revision %d.') % self.new_revno)
3187
note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
3188
if self.old_revid == self.new_revid and not tag_updates:
3189
if not tag_conflicts:
3190
note(gettext('No new revisions or tags to push.'))
3192
note(gettext('No new revisions to push.'))
3193
self._show_tag_conficts(to_file)
3196
class BranchCheckResult(object):
3197
"""Results of checking branch consistency.
3202
def __init__(self, branch):
3203
self.branch = branch
3206
def report_results(self, verbose):
3207
"""Report the check results via trace.note.
3209
:param verbose: Requests more detailed display of what was checked,
3212
note(gettext('checked branch {0} format {1}').format(
3213
self.branch.user_url, self.branch._format))
3214
for error in self.errors:
3215
note(gettext('found error:%s'), error)
3218
class Converter5to6(object):
3219
"""Perform an in-place upgrade of format 5 to format 6"""
3221
def convert(self, branch):
3222
# Data for 5 and 6 can peacefully coexist.
3223
format = BzrBranchFormat6()
3224
new_branch = format.open(branch.bzrdir, _found=True)
3226
# Copy source data into target
3227
new_branch._write_last_revision_info(*branch.last_revision_info())
3228
new_branch.set_parent(branch.get_parent())
3229
new_branch.set_bound_location(branch.get_bound_location())
3230
new_branch.set_push_location(branch.get_push_location())
3232
# New branch has no tags by default
3233
new_branch.tags._set_tag_dict({})
3235
# Copying done; now update target format
3236
new_branch._transport.put_bytes('format',
3238
mode=new_branch.bzrdir._get_file_mode())
3240
# Clean up old files
3241
new_branch._transport.delete('revision-history')
3243
branch.set_parent(None)
3244
except errors.NoSuchFile:
3246
branch.set_bound_location(None)
3249
class Converter6to7(object):
3250
"""Perform an in-place upgrade of format 6 to format 7"""
3252
def convert(self, branch):
3253
format = BzrBranchFormat7()
3254
branch._set_config_location('stacked_on_location', '')
3255
# update target format
3256
branch._transport.put_bytes('format', format.as_string())
3259
class Converter7to8(object):
3260
"""Perform an in-place upgrade of format 7 to format 8"""
3262
def convert(self, branch):
3263
format = BzrBranchFormat8()
3264
branch._transport.put_bytes('references', '')
3265
# update target format
3266
branch._transport.put_bytes('format', format.as_string())
3269
class InterBranch(InterObject):
3270
"""This class represents operations taking place between two branches.
3272
Its instances have methods like pull() and push() and contain
3273
references to the source and target repositories these operations
3274
can be carried out on.
3278
"""The available optimised InterBranch types."""
3281
def _get_branch_formats_to_test(klass):
3282
"""Return an iterable of format tuples for testing.
3284
:return: An iterable of (from_format, to_format) to use when testing
3285
this InterBranch class. Each InterBranch class should define this
3288
raise NotImplementedError(klass._get_branch_formats_to_test)
3291
def pull(self, overwrite=False, stop_revision=None,
3292
possible_transports=None, local=False):
3293
"""Mirror source into target branch.
3295
The target branch is considered to be 'local', having low latency.
3297
:returns: PullResult instance
3299
raise NotImplementedError(self.pull)
3302
def push(self, overwrite=False, stop_revision=None, lossy=False,
3303
_override_hook_source_branch=None):
3304
"""Mirror the source branch into the target branch.
3306
The source branch is considered to be 'local', having low latency.
3308
raise NotImplementedError(self.push)
3311
def copy_content_into(self, revision_id=None):
3312
"""Copy the content of source into target
3314
revision_id: if not None, the revision history in the new branch will
3315
be truncated to end with revision_id.
3317
raise NotImplementedError(self.copy_content_into)
3320
def fetch(self, stop_revision=None, limit=None):
3323
:param stop_revision: Last revision to fetch
3324
:param limit: Optional rough limit of revisions to fetch
3326
raise NotImplementedError(self.fetch)
3329
class GenericInterBranch(InterBranch):
3330
"""InterBranch implementation that uses public Branch functions."""
3333
def is_compatible(klass, source, target):
3334
# GenericBranch uses the public API, so always compatible
3338
def _get_branch_formats_to_test(klass):
3339
return [(format_registry.get_default(), format_registry.get_default())]
3342
def unwrap_format(klass, format):
3343
if isinstance(format, remote.RemoteBranchFormat):
3344
format._ensure_real()
3345
return format._custom_format
3349
def copy_content_into(self, revision_id=None):
3350
"""Copy the content of source into target
3352
revision_id: if not None, the revision history in the new branch will
3353
be truncated to end with revision_id.
3355
self.source.update_references(self.target)
3356
self.source._synchronize_history(self.target, revision_id)
3358
parent = self.source.get_parent()
3359
except errors.InaccessibleParent, e:
3360
mutter('parent was not accessible to copy: %s', e)
3363
self.target.set_parent(parent)
3364
if self.source._push_should_merge_tags():
3365
self.source.tags.merge_to(self.target.tags)
3368
def fetch(self, stop_revision=None, limit=None):
3369
if self.target.base == self.source.base:
3371
self.source.lock_read()
3373
fetch_spec_factory = fetch.FetchSpecFactory()
3374
fetch_spec_factory.source_branch = self.source
3375
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3376
fetch_spec_factory.source_repo = self.source.repository
3377
fetch_spec_factory.target_repo = self.target.repository
3378
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3379
fetch_spec_factory.limit = limit
3380
fetch_spec = fetch_spec_factory.make_fetch_spec()
3381
return self.target.repository.fetch(self.source.repository,
3382
fetch_spec=fetch_spec)
3384
self.source.unlock()
3387
def _update_revisions(self, stop_revision=None, overwrite=False,
3389
other_revno, other_last_revision = self.source.last_revision_info()
3390
stop_revno = None # unknown
3391
if stop_revision is None:
3392
stop_revision = other_last_revision
3393
if _mod_revision.is_null(stop_revision):
3394
# if there are no commits, we're done.
3396
stop_revno = other_revno
3398
# what's the current last revision, before we fetch [and change it
3400
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3401
# we fetch here so that we don't process data twice in the common
3402
# case of having something to pull, and so that the check for
3403
# already merged can operate on the just fetched graph, which will
3404
# be cached in memory.
3405
self.fetch(stop_revision=stop_revision)
3406
# Check to see if one is an ancestor of the other
3409
graph = self.target.repository.get_graph()
3410
if self.target._check_if_descendant_or_diverged(
3411
stop_revision, last_rev, graph, self.source):
3412
# stop_revision is a descendant of last_rev, but we aren't
3413
# overwriting, so we're done.
3415
if stop_revno is None:
3417
graph = self.target.repository.get_graph()
3418
this_revno, this_last_revision = \
3419
self.target.last_revision_info()
3420
stop_revno = graph.find_distance_to_null(stop_revision,
3421
[(other_last_revision, other_revno),
3422
(this_last_revision, this_revno)])
3423
self.target.set_last_revision_info(stop_revno, stop_revision)
3426
def pull(self, overwrite=False, stop_revision=None,
3427
possible_transports=None, run_hooks=True,
3428
_override_hook_target=None, local=False):
3429
"""Pull from source into self, updating my master if any.
3431
:param run_hooks: Private parameter - if false, this branch
3432
is being called because it's the master of the primary branch,
3433
so it should not run its hooks.
3435
bound_location = self.target.get_bound_location()
3436
if local and not bound_location:
3437
raise errors.LocalRequiresBoundBranch()
3438
master_branch = None
3439
source_is_master = False
3441
# bound_location comes from a config file, some care has to be
3442
# taken to relate it to source.user_url
3443
normalized = urlutils.normalize_url(bound_location)
3445
relpath = self.source.user_transport.relpath(normalized)
3446
source_is_master = (relpath == '')
3447
except (errors.PathNotChild, errors.InvalidURL):
3448
source_is_master = False
3449
if not local and bound_location and not source_is_master:
3450
# not pulling from master, so we need to update master.
3451
master_branch = self.target.get_master_branch(possible_transports)
3452
master_branch.lock_write()
3455
# pull from source into master.
3456
master_branch.pull(self.source, overwrite, stop_revision,
3458
return self._pull(overwrite,
3459
stop_revision, _hook_master=master_branch,
3460
run_hooks=run_hooks,
3461
_override_hook_target=_override_hook_target,
3462
merge_tags_to_master=not source_is_master)
3465
master_branch.unlock()
3467
def push(self, overwrite=False, stop_revision=None, lossy=False,
3468
_override_hook_source_branch=None):
3469
"""See InterBranch.push.
3471
This is the basic concrete implementation of push()
3473
:param _override_hook_source_branch: If specified, run the hooks
3474
passing this Branch as the source, rather than self. This is for
3475
use of RemoteBranch, where push is delegated to the underlying
3479
raise errors.LossyPushToSameVCS(self.source, self.target)
3480
# TODO: Public option to disable running hooks - should be trivial but
3483
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3484
op.add_cleanup(self.source.lock_read().unlock)
3485
op.add_cleanup(self.target.lock_write().unlock)
3486
return op.run(overwrite, stop_revision,
3487
_override_hook_source_branch=_override_hook_source_branch)
3489
def _basic_push(self, overwrite, stop_revision):
3490
"""Basic implementation of push without bound branches or hooks.
3492
Must be called with source read locked and target write locked.
3494
result = BranchPushResult()
3495
result.source_branch = self.source
3496
result.target_branch = self.target
3497
result.old_revno, result.old_revid = self.target.last_revision_info()
3498
self.source.update_references(self.target)
3499
if result.old_revid != stop_revision:
3500
# We assume that during 'push' this repository is closer than
3502
graph = self.source.repository.get_graph(self.target.repository)
3503
self._update_revisions(stop_revision, overwrite=overwrite,
3505
if self.source._push_should_merge_tags():
3506
result.tag_updates, result.tag_conflicts = (
3507
self.source.tags.merge_to(self.target.tags, overwrite))
3508
result.new_revno, result.new_revid = self.target.last_revision_info()
3511
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3512
_override_hook_source_branch=None):
3513
"""Push from source into target, and into target's master if any.
3516
if _override_hook_source_branch:
3517
result.source_branch = _override_hook_source_branch
3518
for hook in Branch.hooks['post_push']:
3521
bound_location = self.target.get_bound_location()
3522
if bound_location and self.target.base != bound_location:
3523
# there is a master branch.
3525
# XXX: Why the second check? Is it even supported for a branch to
3526
# be bound to itself? -- mbp 20070507
3527
master_branch = self.target.get_master_branch()
3528
master_branch.lock_write()
3529
operation.add_cleanup(master_branch.unlock)
3530
# push into the master from the source branch.
3531
master_inter = InterBranch.get(self.source, master_branch)
3532
master_inter._basic_push(overwrite, stop_revision)
3533
# and push into the target branch from the source. Note that
3534
# we push from the source branch again, because it's considered
3535
# the highest bandwidth repository.
3536
result = self._basic_push(overwrite, stop_revision)
3537
result.master_branch = master_branch
3538
result.local_branch = self.target
3540
master_branch = None
3542
result = self._basic_push(overwrite, stop_revision)
3543
# TODO: Why set master_branch and local_branch if there's no
3544
# binding? Maybe cleaner to just leave them unset? -- mbp
3546
result.master_branch = self.target
3547
result.local_branch = None
3551
def _pull(self, overwrite=False, stop_revision=None,
3552
possible_transports=None, _hook_master=None, run_hooks=True,
3553
_override_hook_target=None, local=False,
3554
merge_tags_to_master=True):
3557
This function is the core worker, used by GenericInterBranch.pull to
3558
avoid duplication when pulling source->master and source->local.
3560
:param _hook_master: Private parameter - set the branch to
3561
be supplied as the master to pull hooks.
3562
:param run_hooks: Private parameter - if false, this branch
3563
is being called because it's the master of the primary branch,
3564
so it should not run its hooks.
3565
is being called because it's the master of the primary branch,
3566
so it should not run its hooks.
3567
:param _override_hook_target: Private parameter - set the branch to be
3568
supplied as the target_branch to pull hooks.
3569
:param local: Only update the local branch, and not the bound branch.
3571
# This type of branch can't be bound.
3573
raise errors.LocalRequiresBoundBranch()
3574
result = PullResult()
3575
result.source_branch = self.source
3576
if _override_hook_target is None:
3577
result.target_branch = self.target
3579
result.target_branch = _override_hook_target
3580
self.source.lock_read()
3582
# We assume that during 'pull' the target repository is closer than
3584
self.source.update_references(self.target)
3585
graph = self.target.repository.get_graph(self.source.repository)
3586
# TODO: Branch formats should have a flag that indicates
3587
# that revno's are expensive, and pull() should honor that flag.
3589
result.old_revno, result.old_revid = \
3590
self.target.last_revision_info()
3591
self._update_revisions(stop_revision, overwrite=overwrite,
3593
# TODO: The old revid should be specified when merging tags,
3594
# so a tags implementation that versions tags can only
3595
# pull in the most recent changes. -- JRV20090506
3596
result.tag_updates, result.tag_conflicts = (
3597
self.source.tags.merge_to(self.target.tags, overwrite,
3598
ignore_master=not merge_tags_to_master))
3599
result.new_revno, result.new_revid = self.target.last_revision_info()
3601
result.master_branch = _hook_master
3602
result.local_branch = result.target_branch
3604
result.master_branch = result.target_branch
3605
result.local_branch = None
3607
for hook in Branch.hooks['post_pull']:
3610
self.source.unlock()
3614
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
