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.
58
from bzrlib.decorators import (
63
from bzrlib.hooks import Hooks
64
from bzrlib.inter import InterObject
65
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
66
from bzrlib import registry
67
from bzrlib.symbol_versioning import (
71
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
74
class Branch(controldir.ControlComponent):
75
"""Branch holding a history of revisions.
78
Base directory/url of the branch; using control_url and
79
control_transport is more standardized.
80
:ivar hooks: An instance of BranchHooks.
81
:ivar _master_branch_cache: cached result of get_master_branch, see
84
# this is really an instance variable - FIXME move it there
89
def control_transport(self):
90
return self._transport
93
def user_transport(self):
94
return self.bzrdir.user_transport
96
def __init__(self, possible_transports=None):
97
self.tags = self._format.make_tags(self)
98
self._revision_history_cache = None
99
self._revision_id_to_revno_cache = None
100
self._partial_revision_id_to_revno_cache = {}
101
self._partial_revision_history_cache = []
102
self._tags_bytes = None
103
self._last_revision_info_cache = None
104
self._master_branch_cache = None
105
self._merge_sorted_revisions_cache = None
106
self._open_hook(possible_transports)
107
hooks = Branch.hooks['open']
111
def _open_hook(self, possible_transports):
112
"""Called by init to allow simpler extension of the base class."""
114
def _activate_fallback_location(self, url, possible_transports):
115
"""Activate the branch/repository from url as a fallback repository."""
116
for existing_fallback_repo in self.repository._fallback_repositories:
117
if existing_fallback_repo.user_url == url:
118
# This fallback is already configured. This probably only
119
# happens because ControlDir.sprout is a horrible mess. To avoid
120
# confusing _unstack we don't add this a second time.
121
mutter('duplicate activation of fallback %r on %r', url, self)
123
repo = self._get_fallback_repository(url, possible_transports)
124
if repo.has_same_location(self.repository):
125
raise errors.UnstackableLocationError(self.user_url, url)
126
self.repository.add_fallback_repository(repo)
128
def break_lock(self):
129
"""Break a lock if one is present from another instance.
131
Uses the ui factory to ask for confirmation if the lock may be from
134
This will probe the repository for its lock as well.
136
self.control_files.break_lock()
137
self.repository.break_lock()
138
master = self.get_master_branch()
139
if master is not None:
142
def _check_stackable_repo(self):
143
if not self.repository._format.supports_external_lookups:
144
raise errors.UnstackableRepositoryFormat(self.repository._format,
145
self.repository.base)
147
def _extend_partial_history(self, stop_index=None, stop_revision=None):
148
"""Extend the partial history to include a given index
150
If a stop_index is supplied, stop when that index has been reached.
151
If a stop_revision is supplied, stop when that revision is
152
encountered. Otherwise, stop when the beginning of history is
155
:param stop_index: The index which should be present. When it is
156
present, history extension will stop.
157
:param stop_revision: The revision id which should be present. When
158
it is encountered, history extension will stop.
160
if len(self._partial_revision_history_cache) == 0:
161
self._partial_revision_history_cache = [self.last_revision()]
162
repository._iter_for_revno(
163
self.repository, self._partial_revision_history_cache,
164
stop_index=stop_index, stop_revision=stop_revision)
165
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
166
self._partial_revision_history_cache.pop()
168
def _get_check_refs(self):
169
"""Get the references needed for check().
173
revid = self.last_revision()
174
return [('revision-existence', revid), ('lefthand-distance', revid)]
177
def open(base, _unsupported=False, possible_transports=None):
178
"""Open the branch rooted at base.
180
For instance, if the branch is at URL/.bzr/branch,
181
Branch.open(URL) -> a Branch instance.
183
control = controldir.ControlDir.open(base, _unsupported,
184
possible_transports=possible_transports)
185
return control.open_branch(unsupported=_unsupported,
186
possible_transports=possible_transports)
189
def open_from_transport(transport, name=None, _unsupported=False,
190
possible_transports=None):
191
"""Open the branch rooted at transport"""
192
control = controldir.ControlDir.open_from_transport(transport, _unsupported)
193
return control.open_branch(name=name, unsupported=_unsupported,
194
possible_transports=possible_transports)
197
def open_containing(url, possible_transports=None):
198
"""Open an existing branch which contains url.
200
This probes for a branch at url, and searches upwards from there.
202
Basically we keep looking up until we find the control directory or
203
run into the root. If there isn't one, raises NotBranchError.
204
If there is one and it is either an unrecognised format or an unsupported
205
format, UnknownFormatError or UnsupportedFormatError are raised.
206
If there is one, it is returned, along with the unused portion of url.
208
control, relpath = controldir.ControlDir.open_containing(url,
210
branch = control.open_branch(possible_transports=possible_transports)
211
return (branch, relpath)
213
def _push_should_merge_tags(self):
214
"""Should _basic_push merge this branch's tags into the target?
216
The default implementation returns False if this branch has no tags,
217
and True the rest of the time. Subclasses may override this.
219
return self.supports_tags() and self.tags.get_tag_dict()
221
def get_config(self):
222
"""Get a bzrlib.config.BranchConfig for this Branch.
224
This can then be used to get and set configuration options for the
227
:return: A bzrlib.config.BranchConfig.
229
return _mod_config.BranchConfig(self)
231
def get_config_stack(self):
232
"""Get a bzrlib.config.BranchStack for this Branch.
234
This can then be used to get and set configuration options for the
237
:return: A bzrlib.config.BranchStack.
239
return _mod_config.BranchStack(self)
241
def _get_config(self):
242
"""Get the concrete config for just the config in this branch.
244
This is not intended for client use; see Branch.get_config for the
249
:return: An object supporting get_option and set_option.
251
raise NotImplementedError(self._get_config)
253
def _get_fallback_repository(self, url, possible_transports):
254
"""Get the repository we fallback to at url."""
255
url = urlutils.join(self.base, url)
256
a_branch = Branch.open(url, possible_transports=possible_transports)
257
return a_branch.repository
260
def _get_tags_bytes(self):
261
"""Get the bytes of a serialised tags dict.
263
Note that not all branches support tags, nor do all use the same tags
264
logic: this method is specific to BasicTags. Other tag implementations
265
may use the same method name and behave differently, safely, because
266
of the double-dispatch via
267
format.make_tags->tags_instance->get_tags_dict.
269
:return: The bytes of the tags file.
270
:seealso: Branch._set_tags_bytes.
272
if self._tags_bytes is None:
273
self._tags_bytes = self._transport.get_bytes('tags')
274
return self._tags_bytes
276
def _get_nick(self, local=False, possible_transports=None):
277
config = self.get_config()
278
# explicit overrides master, but don't look for master if local is True
279
if not local and not config.has_explicit_nickname():
281
master = self.get_master_branch(possible_transports)
282
if master and self.user_url == master.user_url:
283
raise errors.RecursiveBind(self.user_url)
284
if master is not None:
285
# return the master branch value
287
except errors.RecursiveBind, e:
289
except errors.BzrError, e:
290
# Silently fall back to local implicit nick if the master is
292
mutter("Could not connect to bound branch, "
293
"falling back to local nick.\n " + str(e))
294
return config.get_nickname()
296
def _set_nick(self, nick):
297
self.get_config().set_user_option('nickname', nick, warn_masked=True)
299
nick = property(_get_nick, _set_nick)
302
raise NotImplementedError(self.is_locked)
304
def _lefthand_history(self, revision_id, last_rev=None,
306
if 'evil' in debug.debug_flags:
307
mutter_callsite(4, "_lefthand_history scales with history.")
308
# stop_revision must be a descendant of last_revision
309
graph = self.repository.get_graph()
310
if last_rev is not None:
311
if not graph.is_ancestor(last_rev, revision_id):
312
# our previous tip is not merged into stop_revision
313
raise errors.DivergedBranches(self, other_branch)
314
# make a new revision history from the graph
315
parents_map = graph.get_parent_map([revision_id])
316
if revision_id not in parents_map:
317
raise errors.NoSuchRevision(self, revision_id)
318
current_rev_id = revision_id
320
check_not_reserved_id = _mod_revision.check_not_reserved_id
321
# Do not include ghosts or graph origin in revision_history
322
while (current_rev_id in parents_map and
323
len(parents_map[current_rev_id]) > 0):
324
check_not_reserved_id(current_rev_id)
325
new_history.append(current_rev_id)
326
current_rev_id = parents_map[current_rev_id][0]
327
parents_map = graph.get_parent_map([current_rev_id])
328
new_history.reverse()
331
def lock_write(self, token=None):
332
"""Lock the branch for write operations.
334
:param token: A token to permit reacquiring a previously held and
336
:return: A BranchWriteLockResult.
338
raise NotImplementedError(self.lock_write)
341
"""Lock the branch for read operations.
343
:return: A bzrlib.lock.LogicalLockResult.
345
raise NotImplementedError(self.lock_read)
348
raise NotImplementedError(self.unlock)
350
def peek_lock_mode(self):
351
"""Return lock mode for the Branch: 'r', 'w' or None"""
352
raise NotImplementedError(self.peek_lock_mode)
354
def get_physical_lock_status(self):
355
raise NotImplementedError(self.get_physical_lock_status)
358
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
359
"""Return the revision_id for a dotted revno.
361
:param revno: a tuple like (1,) or (1,1,2)
362
:param _cache_reverse: a private parameter enabling storage
363
of the reverse mapping in a top level cache. (This should
364
only be done in selective circumstances as we want to
365
avoid having the mapping cached multiple times.)
366
:return: the revision_id
367
:raises errors.NoSuchRevision: if the revno doesn't exist
369
rev_id = self._do_dotted_revno_to_revision_id(revno)
371
self._partial_revision_id_to_revno_cache[rev_id] = revno
374
def _do_dotted_revno_to_revision_id(self, revno):
375
"""Worker function for dotted_revno_to_revision_id.
377
Subclasses should override this if they wish to
378
provide a more efficient implementation.
381
return self.get_rev_id(revno[0])
382
revision_id_to_revno = self.get_revision_id_to_revno_map()
383
revision_ids = [revision_id for revision_id, this_revno
384
in revision_id_to_revno.iteritems()
385
if revno == this_revno]
386
if len(revision_ids) == 1:
387
return revision_ids[0]
389
revno_str = '.'.join(map(str, revno))
390
raise errors.NoSuchRevision(self, revno_str)
393
def revision_id_to_dotted_revno(self, revision_id):
394
"""Given a revision id, return its dotted revno.
396
:return: a tuple like (1,) or (400,1,3).
398
return self._do_revision_id_to_dotted_revno(revision_id)
400
def _do_revision_id_to_dotted_revno(self, revision_id):
401
"""Worker function for revision_id_to_revno."""
402
# Try the caches if they are loaded
403
result = self._partial_revision_id_to_revno_cache.get(revision_id)
404
if result is not None:
406
if self._revision_id_to_revno_cache:
407
result = self._revision_id_to_revno_cache.get(revision_id)
409
raise errors.NoSuchRevision(self, revision_id)
410
# Try the mainline as it's optimised
412
revno = self.revision_id_to_revno(revision_id)
414
except errors.NoSuchRevision:
415
# We need to load and use the full revno map after all
416
result = self.get_revision_id_to_revno_map().get(revision_id)
418
raise errors.NoSuchRevision(self, revision_id)
422
def get_revision_id_to_revno_map(self):
423
"""Return the revision_id => dotted revno map.
425
This will be regenerated on demand, but will be cached.
427
:return: A dictionary mapping revision_id => dotted revno.
428
This dictionary should not be modified by the caller.
430
if self._revision_id_to_revno_cache is not None:
431
mapping = self._revision_id_to_revno_cache
433
mapping = self._gen_revno_map()
434
self._cache_revision_id_to_revno(mapping)
435
# TODO: jam 20070417 Since this is being cached, should we be returning
437
# I would rather not, and instead just declare that users should not
438
# modify the return value.
441
def _gen_revno_map(self):
442
"""Create a new mapping from revision ids to dotted revnos.
444
Dotted revnos are generated based on the current tip in the revision
446
This is the worker function for get_revision_id_to_revno_map, which
447
just caches the return value.
449
:return: A dictionary mapping revision_id => dotted revno.
451
revision_id_to_revno = dict((rev_id, revno)
452
for rev_id, depth, revno, end_of_merge
453
in self.iter_merge_sorted_revisions())
454
return revision_id_to_revno
457
def iter_merge_sorted_revisions(self, start_revision_id=None,
458
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
459
"""Walk the revisions for a branch in merge sorted order.
461
Merge sorted order is the output from a merge-aware,
462
topological sort, i.e. all parents come before their
463
children going forward; the opposite for reverse.
465
:param start_revision_id: the revision_id to begin walking from.
466
If None, the branch tip is used.
467
:param stop_revision_id: the revision_id to terminate the walk
468
after. If None, the rest of history is included.
469
:param stop_rule: if stop_revision_id is not None, the precise rule
470
to use for termination:
472
* 'exclude' - leave the stop revision out of the result (default)
473
* 'include' - the stop revision is the last item in the result
474
* 'with-merges' - include the stop revision and all of its
475
merged revisions in the result
476
* 'with-merges-without-common-ancestry' - filter out revisions
477
that are in both ancestries
478
:param direction: either 'reverse' or 'forward':
480
* reverse means return the start_revision_id first, i.e.
481
start at the most recent revision and go backwards in history
482
* forward returns tuples in the opposite order to reverse.
483
Note in particular that forward does *not* do any intelligent
484
ordering w.r.t. depth as some clients of this API may like.
485
(If required, that ought to be done at higher layers.)
487
:return: an iterator over (revision_id, depth, revno, end_of_merge)
490
* revision_id: the unique id of the revision
491
* depth: How many levels of merging deep this node has been
493
* revno_sequence: This field provides a sequence of
494
revision numbers for all revisions. The format is:
495
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
496
branch that the revno is on. From left to right the REVNO numbers
497
are the sequence numbers within that branch of the revision.
498
* end_of_merge: When True the next node (earlier in history) is
499
part of a different merge.
501
# Note: depth and revno values are in the context of the branch so
502
# we need the full graph to get stable numbers, regardless of the
504
if self._merge_sorted_revisions_cache is None:
505
last_revision = self.last_revision()
506
known_graph = self.repository.get_known_graph_ancestry(
508
self._merge_sorted_revisions_cache = known_graph.merge_sort(
510
filtered = self._filter_merge_sorted_revisions(
511
self._merge_sorted_revisions_cache, start_revision_id,
512
stop_revision_id, stop_rule)
513
# Make sure we don't return revisions that are not part of the
514
# start_revision_id ancestry.
515
filtered = self._filter_start_non_ancestors(filtered)
516
if direction == 'reverse':
518
if direction == 'forward':
519
return reversed(list(filtered))
521
raise ValueError('invalid direction %r' % direction)
523
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
524
start_revision_id, stop_revision_id, stop_rule):
525
"""Iterate over an inclusive range of sorted revisions."""
526
rev_iter = iter(merge_sorted_revisions)
527
if start_revision_id is not None:
528
for node in rev_iter:
530
if rev_id != start_revision_id:
533
# The decision to include the start or not
534
# depends on the stop_rule if a stop is provided
535
# so pop this node back into the iterator
536
rev_iter = itertools.chain(iter([node]), rev_iter)
538
if stop_revision_id is None:
540
for node in rev_iter:
542
yield (rev_id, node.merge_depth, node.revno,
544
elif stop_rule == 'exclude':
545
for node in rev_iter:
547
if rev_id == stop_revision_id:
549
yield (rev_id, node.merge_depth, node.revno,
551
elif stop_rule == 'include':
552
for node in rev_iter:
554
yield (rev_id, node.merge_depth, node.revno,
556
if rev_id == stop_revision_id:
558
elif stop_rule == 'with-merges-without-common-ancestry':
559
# We want to exclude all revisions that are already part of the
560
# stop_revision_id ancestry.
561
graph = self.repository.get_graph()
562
ancestors = graph.find_unique_ancestors(start_revision_id,
564
for node in rev_iter:
566
if rev_id not in ancestors:
568
yield (rev_id, node.merge_depth, node.revno,
570
elif stop_rule == 'with-merges':
571
stop_rev = self.repository.get_revision(stop_revision_id)
572
if stop_rev.parent_ids:
573
left_parent = stop_rev.parent_ids[0]
575
left_parent = _mod_revision.NULL_REVISION
576
# left_parent is the actual revision we want to stop logging at,
577
# since we want to show the merged revisions after the stop_rev too
578
reached_stop_revision_id = False
579
revision_id_whitelist = []
580
for node in rev_iter:
582
if rev_id == left_parent:
583
# reached the left parent after the stop_revision
585
if (not reached_stop_revision_id or
586
rev_id in revision_id_whitelist):
587
yield (rev_id, node.merge_depth, node.revno,
589
if reached_stop_revision_id or rev_id == stop_revision_id:
590
# only do the merged revs of rev_id from now on
591
rev = self.repository.get_revision(rev_id)
593
reached_stop_revision_id = True
594
revision_id_whitelist.extend(rev.parent_ids)
596
raise ValueError('invalid stop_rule %r' % stop_rule)
598
def _filter_start_non_ancestors(self, rev_iter):
599
# If we started from a dotted revno, we want to consider it as a tip
600
# and don't want to yield revisions that are not part of its
601
# ancestry. Given the order guaranteed by the merge sort, we will see
602
# uninteresting descendants of the first parent of our tip before the
604
first = rev_iter.next()
605
(rev_id, merge_depth, revno, end_of_merge) = first
608
# We start at a mainline revision so by definition, all others
609
# revisions in rev_iter are ancestors
610
for node in rev_iter:
615
pmap = self.repository.get_parent_map([rev_id])
616
parents = pmap.get(rev_id, [])
618
whitelist.update(parents)
620
# If there is no parents, there is nothing of interest left
622
# FIXME: It's hard to test this scenario here as this code is never
623
# called in that case. -- vila 20100322
626
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
628
if rev_id in whitelist:
629
pmap = self.repository.get_parent_map([rev_id])
630
parents = pmap.get(rev_id, [])
631
whitelist.remove(rev_id)
632
whitelist.update(parents)
634
# We've reached the mainline, there is nothing left to
638
# A revision that is not part of the ancestry of our
641
yield (rev_id, merge_depth, revno, end_of_merge)
643
def leave_lock_in_place(self):
644
"""Tell this branch object not to release the physical lock when this
647
If lock_write doesn't return a token, then this method is not supported.
649
self.control_files.leave_in_place()
651
def dont_leave_lock_in_place(self):
652
"""Tell this branch object to release the physical lock when this
653
object is unlocked, even if it didn't originally acquire it.
655
If lock_write doesn't return a token, then this method is not supported.
657
self.control_files.dont_leave_in_place()
659
def bind(self, other):
660
"""Bind the local branch the other branch.
662
:param other: The branch to bind to
665
raise errors.UpgradeRequired(self.user_url)
667
def get_append_revisions_only(self):
668
"""Whether it is only possible to append revisions to the history.
670
if not self._format.supports_set_append_revisions_only():
672
return self.get_config_stack().get('append_revisions_only')
674
def set_append_revisions_only(self, enabled):
675
if not self._format.supports_set_append_revisions_only():
676
raise errors.UpgradeRequired(self.user_url)
677
self.get_config_stack().set('append_revisions_only', enabled)
679
def set_reference_info(self, file_id, tree_path, branch_location):
680
"""Set the branch location to use for a tree reference."""
681
raise errors.UnsupportedOperation(self.set_reference_info, self)
683
def get_reference_info(self, file_id):
684
"""Get the tree_path and branch_location for a tree reference."""
685
raise errors.UnsupportedOperation(self.get_reference_info, self)
688
def fetch(self, from_branch, last_revision=None, limit=None):
689
"""Copy revisions from from_branch into this branch.
691
:param from_branch: Where to copy from.
692
:param last_revision: What revision to stop at (None for at the end
694
:param limit: Optional rough limit of revisions to fetch
697
return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
699
def get_bound_location(self):
700
"""Return the URL of the branch we are bound to.
702
Older format branches cannot bind, please be sure to use a metadir
707
def get_old_bound_location(self):
708
"""Return the URL of the branch we used to be bound to
710
raise errors.UpgradeRequired(self.user_url)
712
def get_commit_builder(self, parents, config_stack=None, timestamp=None,
713
timezone=None, committer=None, revprops=None,
714
revision_id=None, lossy=False):
715
"""Obtain a CommitBuilder for this branch.
717
:param parents: Revision ids of the parents of the new revision.
718
:param config: Optional configuration to use.
719
:param timestamp: Optional timestamp recorded for commit.
720
:param timezone: Optional timezone for timestamp.
721
:param committer: Optional committer to set for commit.
722
:param revprops: Optional dictionary of revision properties.
723
:param revision_id: Optional revision id.
724
:param lossy: Whether to discard data that can not be natively
725
represented, when pushing to a foreign VCS
728
if config_stack is None:
729
config_stack = self.get_config_stack()
731
return self.repository.get_commit_builder(self, parents, config_stack,
732
timestamp, timezone, committer, revprops, revision_id,
735
def get_master_branch(self, possible_transports=None):
736
"""Return the branch we are bound to.
738
:return: Either a Branch, or None
742
@deprecated_method(deprecated_in((2, 5, 0)))
743
def get_revision_delta(self, revno):
744
"""Return the delta for one revision.
746
The delta is relative to its mainline predecessor, or the
747
empty tree for revision 1.
750
revid = self.get_rev_id(revno)
751
except errors.NoSuchRevision:
752
raise errors.InvalidRevisionNumber(revno)
753
return self.repository.get_revision_delta(revid)
755
def get_stacked_on_url(self):
756
"""Get the URL this branch is stacked against.
758
:raises NotStacked: If the branch is not stacked.
759
:raises UnstackableBranchFormat: If the branch does not support
762
raise NotImplementedError(self.get_stacked_on_url)
764
def print_file(self, file, revision_id):
765
"""Print `file` to stdout."""
766
raise NotImplementedError(self.print_file)
768
@deprecated_method(deprecated_in((2, 4, 0)))
769
def set_revision_history(self, rev_history):
770
"""See Branch.set_revision_history."""
771
self._set_revision_history(rev_history)
774
def _set_revision_history(self, rev_history):
775
if len(rev_history) == 0:
776
revid = _mod_revision.NULL_REVISION
778
revid = rev_history[-1]
779
if rev_history != self._lefthand_history(revid):
780
raise errors.NotLefthandHistory(rev_history)
781
self.set_last_revision_info(len(rev_history), revid)
782
self._cache_revision_history(rev_history)
783
for hook in Branch.hooks['set_rh']:
784
hook(self, rev_history)
787
def set_last_revision_info(self, revno, revision_id):
788
"""Set the last revision of this branch.
790
The caller is responsible for checking that the revno is correct
791
for this revision id.
793
It may be possible to set the branch last revision to an id not
794
present in the repository. However, branches can also be
795
configured to check constraints on history, in which case this may not
798
raise NotImplementedError(self.set_last_revision_info)
801
def generate_revision_history(self, revision_id, last_rev=None,
803
"""See Branch.generate_revision_history"""
804
graph = self.repository.get_graph()
805
(last_revno, last_revid) = self.last_revision_info()
806
known_revision_ids = [
807
(last_revid, last_revno),
808
(_mod_revision.NULL_REVISION, 0),
810
if last_rev is not None:
811
if not graph.is_ancestor(last_rev, revision_id):
812
# our previous tip is not merged into stop_revision
813
raise errors.DivergedBranches(self, other_branch)
814
revno = graph.find_distance_to_null(revision_id, known_revision_ids)
815
self.set_last_revision_info(revno, revision_id)
818
def set_parent(self, url):
819
"""See Branch.set_parent."""
820
# TODO: Maybe delete old location files?
821
# URLs should never be unicode, even on the local fs,
822
# FIXUP this and get_parent in a future branch format bump:
823
# read and rewrite the file. RBC 20060125
825
if isinstance(url, unicode):
827
url = url.encode('ascii')
828
except UnicodeEncodeError:
829
raise errors.InvalidURL(url,
830
"Urls must be 7-bit ascii, "
831
"use bzrlib.urlutils.escape")
832
url = urlutils.relative_url(self.base, url)
833
self._set_parent_location(url)
836
def set_stacked_on_url(self, url):
837
"""Set the URL this branch is stacked against.
839
:raises UnstackableBranchFormat: If the branch does not support
841
:raises UnstackableRepositoryFormat: If the repository does not support
844
if not self._format.supports_stacking():
845
raise errors.UnstackableBranchFormat(self._format, self.user_url)
846
# XXX: Changing from one fallback repository to another does not check
847
# that all the data you need is present in the new fallback.
848
# Possibly it should.
849
self._check_stackable_repo()
852
old_url = self.get_stacked_on_url()
853
except (errors.NotStacked, errors.UnstackableBranchFormat,
854
errors.UnstackableRepositoryFormat):
858
self._activate_fallback_location(url,
859
possible_transports=[self.bzrdir.root_transport])
860
# write this out after the repository is stacked to avoid setting a
861
# stacked config that doesn't work.
862
self._set_config_location('stacked_on_location', url)
865
"""Change a branch to be unstacked, copying data as needed.
867
Don't call this directly, use set_stacked_on_url(None).
869
pb = ui.ui_factory.nested_progress_bar()
871
pb.update(gettext("Unstacking"))
872
# The basic approach here is to fetch the tip of the branch,
873
# including all available ghosts, from the existing stacked
874
# repository into a new repository object without the fallbacks.
876
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
877
# correct for CHKMap repostiories
878
old_repository = self.repository
879
if len(old_repository._fallback_repositories) != 1:
880
raise AssertionError("can't cope with fallback repositories "
881
"of %r (fallbacks: %r)" % (old_repository,
882
old_repository._fallback_repositories))
883
# Open the new repository object.
884
# Repositories don't offer an interface to remove fallback
885
# repositories today; take the conceptually simpler option and just
886
# reopen it. We reopen it starting from the URL so that we
887
# get a separate connection for RemoteRepositories and can
888
# stream from one of them to the other. This does mean doing
889
# separate SSH connection setup, but unstacking is not a
890
# common operation so it's tolerable.
891
new_bzrdir = controldir.ControlDir.open(
892
self.bzrdir.root_transport.base)
893
new_repository = new_bzrdir.find_repository()
894
if new_repository._fallback_repositories:
895
raise AssertionError("didn't expect %r to have "
896
"fallback_repositories"
897
% (self.repository,))
898
# Replace self.repository with the new repository.
899
# Do our best to transfer the lock state (i.e. lock-tokens and
900
# lock count) of self.repository to the new repository.
901
lock_token = old_repository.lock_write().repository_token
902
self.repository = new_repository
903
if isinstance(self, remote.RemoteBranch):
904
# Remote branches can have a second reference to the old
905
# repository that need to be replaced.
906
if self._real_branch is not None:
907
self._real_branch.repository = new_repository
908
self.repository.lock_write(token=lock_token)
909
if lock_token is not None:
910
old_repository.leave_lock_in_place()
911
old_repository.unlock()
912
if lock_token is not None:
913
# XXX: self.repository.leave_lock_in_place() before this
914
# function will not be preserved. Fortunately that doesn't
915
# affect the current default format (2a), and would be a
916
# corner-case anyway.
917
# - Andrew Bennetts, 2010/06/30
918
self.repository.dont_leave_lock_in_place()
922
old_repository.unlock()
923
except errors.LockNotHeld:
926
if old_lock_count == 0:
927
raise AssertionError(
928
'old_repository should have been locked at least once.')
929
for i in range(old_lock_count-1):
930
self.repository.lock_write()
931
# Fetch from the old repository into the new.
932
old_repository.lock_read()
934
# XXX: If you unstack a branch while it has a working tree
935
# with a pending merge, the pending-merged revisions will no
936
# longer be present. You can (probably) revert and remerge.
938
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
939
except errors.TagsNotSupported:
940
tags_to_fetch = set()
941
fetch_spec = vf_search.NotInOtherForRevs(self.repository,
942
old_repository, required_ids=[self.last_revision()],
943
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
944
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
946
old_repository.unlock()
950
def _set_tags_bytes(self, bytes):
951
"""Mirror method for _get_tags_bytes.
953
:seealso: Branch._get_tags_bytes.
955
op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
956
op.add_cleanup(self.lock_write().unlock)
957
return op.run_simple(bytes)
959
def _set_tags_bytes_locked(self, bytes):
960
self._tags_bytes = bytes
961
return self._transport.put_bytes('tags', bytes)
963
def _cache_revision_history(self, rev_history):
964
"""Set the cached revision history to rev_history.
966
The revision_history method will use this cache to avoid regenerating
967
the revision history.
969
This API is semi-public; it only for use by subclasses, all other code
970
should consider it to be private.
972
self._revision_history_cache = rev_history
974
def _cache_revision_id_to_revno(self, revision_id_to_revno):
975
"""Set the cached revision_id => revno map to revision_id_to_revno.
977
This API is semi-public; it only for use by subclasses, all other code
978
should consider it to be private.
980
self._revision_id_to_revno_cache = revision_id_to_revno
982
def _clear_cached_state(self):
983
"""Clear any cached data on this branch, e.g. cached revision history.
985
This means the next call to revision_history will need to call
986
_gen_revision_history.
988
This API is semi-public; it only for use by subclasses, all other code
989
should consider it to be private.
991
self._revision_history_cache = None
992
self._revision_id_to_revno_cache = None
993
self._last_revision_info_cache = None
994
self._master_branch_cache = None
995
self._merge_sorted_revisions_cache = None
996
self._partial_revision_history_cache = []
997
self._partial_revision_id_to_revno_cache = {}
998
self._tags_bytes = None
1000
def _gen_revision_history(self):
1001
"""Return sequence of revision hashes on to this branch.
1003
Unlike revision_history, this method always regenerates or rereads the
1004
revision history, i.e. it does not cache the result, so repeated calls
1007
Concrete subclasses should override this instead of revision_history so
1008
that subclasses do not need to deal with caching logic.
1010
This API is semi-public; it only for use by subclasses, all other code
1011
should consider it to be private.
1013
raise NotImplementedError(self._gen_revision_history)
1015
@deprecated_method(deprecated_in((2, 5, 0)))
1017
def revision_history(self):
1018
"""Return sequence of revision ids on this branch.
1020
This method will cache the revision history for as long as it is safe to
1023
return self._revision_history()
1025
def _revision_history(self):
1026
if 'evil' in debug.debug_flags:
1027
mutter_callsite(3, "revision_history scales with history.")
1028
if self._revision_history_cache is not None:
1029
history = self._revision_history_cache
1031
history = self._gen_revision_history()
1032
self._cache_revision_history(history)
1033
return list(history)
1036
"""Return current revision number for this branch.
1038
That is equivalent to the number of revisions committed to
1041
return self.last_revision_info()[0]
1044
"""Older format branches cannot bind or unbind."""
1045
raise errors.UpgradeRequired(self.user_url)
1047
def last_revision(self):
1048
"""Return last revision id, or NULL_REVISION."""
1049
return self.last_revision_info()[1]
1052
def last_revision_info(self):
1053
"""Return information about the last revision.
1055
:return: A tuple (revno, revision_id).
1057
if self._last_revision_info_cache is None:
1058
self._last_revision_info_cache = self._read_last_revision_info()
1059
return self._last_revision_info_cache
1061
def _read_last_revision_info(self):
1062
raise NotImplementedError(self._read_last_revision_info)
1064
@deprecated_method(deprecated_in((2, 4, 0)))
1065
def import_last_revision_info(self, source_repo, revno, revid):
1066
"""Set the last revision info, importing from another repo if necessary.
1068
:param source_repo: Source repository to optionally fetch from
1069
:param revno: Revision number of the new tip
1070
:param revid: Revision id of the new tip
1072
if not self.repository.has_same_location(source_repo):
1073
self.repository.fetch(source_repo, revision_id=revid)
1074
self.set_last_revision_info(revno, revid)
1076
def import_last_revision_info_and_tags(self, source, revno, revid,
1078
"""Set the last revision info, importing from another repo if necessary.
1080
This is used by the bound branch code to upload a revision to
1081
the master branch first before updating the tip of the local branch.
1082
Revisions referenced by source's tags are also transferred.
1084
:param source: Source branch to optionally fetch from
1085
:param revno: Revision number of the new tip
1086
:param revid: Revision id of the new tip
1087
:param lossy: Whether to discard metadata that can not be
1088
natively represented
1089
:return: Tuple with the new revision number and revision id
1090
(should only be different from the arguments when lossy=True)
1092
if not self.repository.has_same_location(source.repository):
1093
self.fetch(source, revid)
1094
self.set_last_revision_info(revno, revid)
1095
return (revno, revid)
1097
def revision_id_to_revno(self, revision_id):
1098
"""Given a revision id, return its revno"""
1099
if _mod_revision.is_null(revision_id):
1101
history = self._revision_history()
1103
return history.index(revision_id) + 1
1105
raise errors.NoSuchRevision(self, revision_id)
1108
def get_rev_id(self, revno, history=None):
1109
"""Find the revision id of the specified revno."""
1111
return _mod_revision.NULL_REVISION
1112
last_revno, last_revid = self.last_revision_info()
1113
if revno == last_revno:
1115
if revno <= 0 or revno > last_revno:
1116
raise errors.NoSuchRevision(self, revno)
1117
distance_from_last = last_revno - revno
1118
if len(self._partial_revision_history_cache) <= distance_from_last:
1119
self._extend_partial_history(distance_from_last)
1120
return self._partial_revision_history_cache[distance_from_last]
1122
def pull(self, source, overwrite=False, stop_revision=None,
1123
possible_transports=None, *args, **kwargs):
1124
"""Mirror source into this branch.
1126
This branch is considered to be 'local', having low latency.
1128
:returns: PullResult instance
1130
return InterBranch.get(source, self).pull(overwrite=overwrite,
1131
stop_revision=stop_revision,
1132
possible_transports=possible_transports, *args, **kwargs)
1134
def push(self, target, overwrite=False, stop_revision=None, lossy=False,
1136
"""Mirror this branch into target.
1138
This branch is considered to be 'local', having low latency.
1140
return InterBranch.get(self, target).push(overwrite, stop_revision,
1141
lossy, *args, **kwargs)
1143
def basis_tree(self):
1144
"""Return `Tree` object for last revision."""
1145
return self.repository.revision_tree(self.last_revision())
1147
def get_parent(self):
1148
"""Return the parent location of the branch.
1150
This is the default location for pull/missing. The usual
1151
pattern is that the user can override it by specifying a
1154
parent = self._get_parent_location()
1157
# This is an old-format absolute path to a local branch
1158
# turn it into a url
1159
if parent.startswith('/'):
1160
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1162
return urlutils.join(self.base[:-1], parent)
1163
except errors.InvalidURLJoin, e:
1164
raise errors.InaccessibleParent(parent, self.user_url)
1166
def _get_parent_location(self):
1167
raise NotImplementedError(self._get_parent_location)
1169
def _set_config_location(self, name, url, config=None,
1170
make_relative=False):
1172
config = self.get_config()
1176
url = urlutils.relative_url(self.base, url)
1177
config.set_user_option(name, url, warn_masked=True)
1179
def _get_config_location(self, name, config=None):
1181
config = self.get_config()
1182
location = config.get_user_option(name)
1187
def get_child_submit_format(self):
1188
"""Return the preferred format of submissions to this branch."""
1189
return self.get_config().get_user_option("child_submit_format")
1191
def get_submit_branch(self):
1192
"""Return the submit location of the branch.
1194
This is the default location for bundle. The usual
1195
pattern is that the user can override it by specifying a
1198
return self.get_config().get_user_option('submit_branch')
1200
def set_submit_branch(self, location):
1201
"""Return the submit location of the branch.
1203
This is the default location for bundle. The usual
1204
pattern is that the user can override it by specifying a
1207
self.get_config().set_user_option('submit_branch', location,
1210
def get_public_branch(self):
1211
"""Return the public location of the branch.
1213
This is used by merge directives.
1215
return self._get_config_location('public_branch')
1217
def set_public_branch(self, location):
1218
"""Return the submit location of the branch.
1220
This is the default location for bundle. The usual
1221
pattern is that the user can override it by specifying a
1224
self._set_config_location('public_branch', location)
1226
def get_push_location(self):
1227
"""Return the None or the location to push this branch to."""
1228
push_loc = self.get_config().get_user_option('push_location')
1231
def set_push_location(self, location):
1232
"""Set a new push location for this branch."""
1233
raise NotImplementedError(self.set_push_location)
1235
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1236
"""Run the post_change_branch_tip hooks."""
1237
hooks = Branch.hooks['post_change_branch_tip']
1240
new_revno, new_revid = self.last_revision_info()
1241
params = ChangeBranchTipParams(
1242
self, old_revno, new_revno, old_revid, new_revid)
1246
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1247
"""Run the pre_change_branch_tip hooks."""
1248
hooks = Branch.hooks['pre_change_branch_tip']
1251
old_revno, old_revid = self.last_revision_info()
1252
params = ChangeBranchTipParams(
1253
self, old_revno, new_revno, old_revid, new_revid)
1259
"""Synchronise this branch with the master branch if any.
1261
:return: None or the last_revision pivoted out during the update.
1265
def check_revno(self, revno):
1267
Check whether a revno corresponds to any revision.
1268
Zero (the NULL revision) is considered valid.
1271
self.check_real_revno(revno)
1273
def check_real_revno(self, revno):
1275
Check whether a revno corresponds to a real revision.
1276
Zero (the NULL revision) is considered invalid
1278
if revno < 1 or revno > self.revno():
1279
raise errors.InvalidRevisionNumber(revno)
1282
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1283
"""Clone this branch into to_bzrdir preserving all semantic values.
1285
Most API users will want 'create_clone_on_transport', which creates a
1286
new bzrdir and branch on the fly.
1288
revision_id: if not None, the revision history in the new branch will
1289
be truncated to end with revision_id.
1291
result = to_bzrdir.create_branch()
1294
if repository_policy is not None:
1295
repository_policy.configure_branch(result)
1296
self.copy_content_into(result, revision_id=revision_id)
1302
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
1304
"""Create a new line of development from the branch, into to_bzrdir.
1306
to_bzrdir controls the branch format.
1308
revision_id: if not None, the revision history in the new branch will
1309
be truncated to end with revision_id.
1311
if (repository_policy is not None and
1312
repository_policy.requires_stacking()):
1313
to_bzrdir._format.require_stacking(_skip_repo=True)
1314
result = to_bzrdir.create_branch(repository=repository)
1317
if repository_policy is not None:
1318
repository_policy.configure_branch(result)
1319
self.copy_content_into(result, revision_id=revision_id)
1320
master_url = self.get_bound_location()
1321
if master_url is None:
1322
result.set_parent(self.bzrdir.root_transport.base)
1324
result.set_parent(master_url)
1329
def _synchronize_history(self, destination, revision_id):
1330
"""Synchronize last revision and revision history between branches.
1332
This version is most efficient when the destination is also a
1333
BzrBranch6, but works for BzrBranch5, as long as the destination's
1334
repository contains all the lefthand ancestors of the intended
1335
last_revision. If not, set_last_revision_info will fail.
1337
:param destination: The branch to copy the history into
1338
:param revision_id: The revision-id to truncate history at. May
1339
be None to copy complete history.
1341
source_revno, source_revision_id = self.last_revision_info()
1342
if revision_id is None:
1343
revno, revision_id = source_revno, source_revision_id
1345
graph = self.repository.get_graph()
1347
revno = graph.find_distance_to_null(revision_id,
1348
[(source_revision_id, source_revno)])
1349
except errors.GhostRevisionsHaveNoRevno:
1350
# Default to 1, if we can't find anything else
1352
destination.set_last_revision_info(revno, revision_id)
1354
def copy_content_into(self, destination, revision_id=None):
1355
"""Copy the content of self into destination.
1357
revision_id: if not None, the revision history in the new branch will
1358
be truncated to end with revision_id.
1360
return InterBranch.get(self, destination).copy_content_into(
1361
revision_id=revision_id)
1363
def update_references(self, target):
1364
if not getattr(self._format, 'supports_reference_locations', False):
1366
reference_dict = self._get_all_reference_info()
1367
if len(reference_dict) == 0:
1369
old_base = self.base
1370
new_base = target.base
1371
target_reference_dict = target._get_all_reference_info()
1372
for file_id, (tree_path, branch_location) in (
1373
reference_dict.items()):
1374
branch_location = urlutils.rebase_url(branch_location,
1376
target_reference_dict.setdefault(
1377
file_id, (tree_path, branch_location))
1378
target._set_all_reference_info(target_reference_dict)
1381
def check(self, refs):
1382
"""Check consistency of the branch.
1384
In particular this checks that revisions given in the revision-history
1385
do actually match up in the revision graph, and that they're all
1386
present in the repository.
1388
Callers will typically also want to check the repository.
1390
:param refs: Calculated refs for this branch as specified by
1391
branch._get_check_refs()
1392
:return: A BranchCheckResult.
1394
result = BranchCheckResult(self)
1395
last_revno, last_revision_id = self.last_revision_info()
1396
actual_revno = refs[('lefthand-distance', last_revision_id)]
1397
if actual_revno != last_revno:
1398
result.errors.append(errors.BzrCheckError(
1399
'revno does not match len(mainline) %s != %s' % (
1400
last_revno, actual_revno)))
1401
# TODO: We should probably also check that self.revision_history
1402
# matches the repository for older branch formats.
1403
# If looking for the code that cross-checks repository parents against
1404
# the Graph.iter_lefthand_ancestry output, that is now a repository
1408
def _get_checkout_format(self, lightweight=False):
1409
"""Return the most suitable metadir for a checkout of this branch.
1410
Weaves are used if this branch's repository uses weaves.
1412
format = self.repository.bzrdir.checkout_metadir()
1413
format.set_branch_format(self._format)
1416
def create_clone_on_transport(self, to_transport, revision_id=None,
1417
stacked_on=None, create_prefix=False, use_existing_dir=False,
1419
"""Create a clone of this branch and its bzrdir.
1421
:param to_transport: The transport to clone onto.
1422
:param revision_id: The revision id to use as tip in the new branch.
1423
If None the tip is obtained from this branch.
1424
:param stacked_on: An optional URL to stack the clone on.
1425
:param create_prefix: Create any missing directories leading up to
1427
:param use_existing_dir: Use an existing directory if one exists.
1429
# XXX: Fix the bzrdir API to allow getting the branch back from the
1430
# clone call. Or something. 20090224 RBC/spiv.
1431
# XXX: Should this perhaps clone colocated branches as well,
1432
# rather than just the default branch? 20100319 JRV
1433
if revision_id is None:
1434
revision_id = self.last_revision()
1435
dir_to = self.bzrdir.clone_on_transport(to_transport,
1436
revision_id=revision_id, stacked_on=stacked_on,
1437
create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1439
return dir_to.open_branch()
1441
def create_checkout(self, to_location, revision_id=None,
1442
lightweight=False, accelerator_tree=None,
1444
"""Create a checkout of a branch.
1446
:param to_location: The url to produce the checkout at
1447
:param revision_id: The revision to check out
1448
:param lightweight: If True, produce a lightweight checkout, otherwise,
1449
produce a bound branch (heavyweight checkout)
1450
:param accelerator_tree: A tree which can be used for retrieving file
1451
contents more quickly than the revision tree, i.e. a workingtree.
1452
The revision tree will be used for cases where accelerator_tree's
1453
content is different.
1454
:param hardlink: If true, hard-link files from accelerator_tree,
1456
:return: The tree of the created checkout
1458
t = transport.get_transport(to_location)
1460
format = self._get_checkout_format(lightweight=lightweight)
1462
checkout = format.initialize_on_transport(t)
1463
from_branch = BranchReferenceFormat().initialize(checkout,
1466
checkout_branch = controldir.ControlDir.create_branch_convenience(
1467
to_location, force_new_tree=False, format=format)
1468
checkout = checkout_branch.bzrdir
1469
checkout_branch.bind(self)
1470
# pull up to the specified revision_id to set the initial
1471
# branch tip correctly, and seed it with history.
1472
checkout_branch.pull(self, stop_revision=revision_id)
1474
tree = checkout.create_workingtree(revision_id,
1475
from_branch=from_branch,
1476
accelerator_tree=accelerator_tree,
1478
basis_tree = tree.basis_tree()
1479
basis_tree.lock_read()
1481
for path, file_id in basis_tree.iter_references():
1482
reference_parent = self.reference_parent(file_id, path)
1483
reference_parent.create_checkout(tree.abspath(path),
1484
basis_tree.get_reference_revision(file_id, path),
1491
def reconcile(self, thorough=True):
1492
"""Make sure the data stored in this branch is consistent."""
1493
from bzrlib.reconcile import BranchReconciler
1494
reconciler = BranchReconciler(self, thorough=thorough)
1495
reconciler.reconcile()
1498
def reference_parent(self, file_id, path, possible_transports=None):
1499
"""Return the parent branch for a tree-reference file_id
1501
:param file_id: The file_id of the tree reference
1502
:param path: The path of the file_id in the tree
1503
:return: A branch associated with the file_id
1505
# FIXME should provide multiple branches, based on config
1506
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1507
possible_transports=possible_transports)
1509
def supports_tags(self):
1510
return self._format.supports_tags()
1512
def automatic_tag_name(self, revision_id):
1513
"""Try to automatically find the tag name for a revision.
1515
:param revision_id: Revision id of the revision.
1516
:return: A tag name or None if no tag name could be determined.
1518
for hook in Branch.hooks['automatic_tag_name']:
1519
ret = hook(self, revision_id)
1524
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1526
"""Ensure that revision_b is a descendant of revision_a.
1528
This is a helper function for update_revisions.
1530
:raises: DivergedBranches if revision_b has diverged from revision_a.
1531
:returns: True if revision_b is a descendant of revision_a.
1533
relation = self._revision_relations(revision_a, revision_b, graph)
1534
if relation == 'b_descends_from_a':
1536
elif relation == 'diverged':
1537
raise errors.DivergedBranches(self, other_branch)
1538
elif relation == 'a_descends_from_b':
1541
raise AssertionError("invalid relation: %r" % (relation,))
1543
def _revision_relations(self, revision_a, revision_b, graph):
1544
"""Determine the relationship between two revisions.
1546
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1548
heads = graph.heads([revision_a, revision_b])
1549
if heads == set([revision_b]):
1550
return 'b_descends_from_a'
1551
elif heads == set([revision_a, revision_b]):
1552
# These branches have diverged
1554
elif heads == set([revision_a]):
1555
return 'a_descends_from_b'
1557
raise AssertionError("invalid heads: %r" % (heads,))
1559
def heads_to_fetch(self):
1560
"""Return the heads that must and that should be fetched to copy this
1561
branch into another repo.
1563
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1564
set of heads that must be fetched. if_present_fetch is a set of
1565
heads that must be fetched if present, but no error is necessary if
1566
they are not present.
1568
# For bzr native formats must_fetch is just the tip, and if_present_fetch
1570
must_fetch = set([self.last_revision()])
1571
if_present_fetch = set()
1572
c = self.get_config()
1573
include_tags = c.get_user_option_as_bool('branch.fetch_tags',
1577
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1578
except errors.TagsNotSupported:
1580
must_fetch.discard(_mod_revision.NULL_REVISION)
1581
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1582
return must_fetch, if_present_fetch
1585
class BranchFormat(controldir.ControlComponentFormat):
1586
"""An encapsulation of the initialization and open routines for a format.
1588
Formats provide three things:
1589
* An initialization routine,
1593
Formats are placed in an dict by their format string for reference
1594
during branch opening. It's not required that these be instances, they
1595
can be classes themselves with class methods - it simply depends on
1596
whether state is needed for a given format or not.
1598
Once a format is deprecated, just deprecate the initialize and open
1599
methods on the format class. Do not deprecate the object, as the
1600
object will be created every time regardless.
1603
def __eq__(self, other):
1604
return self.__class__ is other.__class__
1606
def __ne__(self, other):
1607
return not (self == other)
1610
@deprecated_method(deprecated_in((2, 4, 0)))
1611
def get_default_format(klass):
1612
"""Return the current default format."""
1613
return format_registry.get_default()
1616
@deprecated_method(deprecated_in((2, 4, 0)))
1617
def get_formats(klass):
1618
"""Get all the known formats.
1620
Warning: This triggers a load of all lazy registered formats: do not
1621
use except when that is desireed.
1623
return format_registry._get_all()
1625
def get_reference(self, controldir, name=None):
1626
"""Get the target reference of the branch in controldir.
1628
format probing must have been completed before calling
1629
this method - it is assumed that the format of the branch
1630
in controldir is correct.
1632
:param controldir: The controldir to get the branch data from.
1633
:param name: Name of the colocated branch to fetch
1634
:return: None if the branch is not a reference branch.
1639
def set_reference(self, controldir, name, to_branch):
1640
"""Set the target reference of the branch in controldir.
1642
format probing must have been completed before calling
1643
this method - it is assumed that the format of the branch
1644
in controldir is correct.
1646
:param controldir: The controldir to set the branch reference for.
1647
:param name: Name of colocated branch to set, None for default
1648
:param to_branch: branch that the checkout is to reference
1650
raise NotImplementedError(self.set_reference)
1652
def get_format_description(self):
1653
"""Return the short format description for this format."""
1654
raise NotImplementedError(self.get_format_description)
1656
def _run_post_branch_init_hooks(self, controldir, name, branch):
1657
hooks = Branch.hooks['post_branch_init']
1660
params = BranchInitHookParams(self, controldir, name, branch)
1664
def initialize(self, controldir, name=None, repository=None,
1665
append_revisions_only=None):
1666
"""Create a branch of this format in controldir.
1668
:param name: Name of the colocated branch to create.
1670
raise NotImplementedError(self.initialize)
1672
def is_supported(self):
1673
"""Is this format supported?
1675
Supported formats can be initialized and opened.
1676
Unsupported formats may not support initialization or committing or
1677
some other features depending on the reason for not being supported.
1681
def make_tags(self, branch):
1682
"""Create a tags object for branch.
1684
This method is on BranchFormat, because BranchFormats are reflected
1685
over the wire via network_name(), whereas full Branch instances require
1686
multiple VFS method calls to operate at all.
1688
The default implementation returns a disabled-tags instance.
1690
Note that it is normal for branch to be a RemoteBranch when using tags
1693
return _mod_tag.DisabledTags(branch)
1695
def network_name(self):
1696
"""A simple byte string uniquely identifying this format for RPC calls.
1698
MetaDir branch formats use their disk format string to identify the
1699
repository over the wire. All in one formats such as bzr < 0.8, and
1700
foreign formats like svn/git and hg should use some marker which is
1701
unique and immutable.
1703
raise NotImplementedError(self.network_name)
1705
def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
1706
found_repository=None, possible_transports=None):
1707
"""Return the branch object for controldir.
1709
:param controldir: A ControlDir that contains a branch.
1710
:param name: Name of colocated branch to open
1711
:param _found: a private parameter, do not use it. It is used to
1712
indicate if format probing has already be done.
1713
:param ignore_fallbacks: when set, no fallback branches will be opened
1714
(if there are any). Default is to open fallbacks.
1716
raise NotImplementedError(self.open)
1719
@deprecated_method(deprecated_in((2, 4, 0)))
1720
def register_format(klass, format):
1721
"""Register a metadir format.
1723
See MetaDirBranchFormatFactory for the ability to register a format
1724
without loading the code the format needs until it is actually used.
1726
format_registry.register(format)
1729
@deprecated_method(deprecated_in((2, 4, 0)))
1730
def set_default_format(klass, format):
1731
format_registry.set_default(format)
1733
def supports_set_append_revisions_only(self):
1734
"""True if this format supports set_append_revisions_only."""
1737
def supports_stacking(self):
1738
"""True if this format records a stacked-on branch."""
1741
def supports_leaving_lock(self):
1742
"""True if this format supports leaving locks in place."""
1743
return False # by default
1746
@deprecated_method(deprecated_in((2, 4, 0)))
1747
def unregister_format(klass, format):
1748
format_registry.remove(format)
1751
return self.get_format_description().rstrip()
1753
def supports_tags(self):
1754
"""True if this format supports tags stored in the branch"""
1755
return False # by default
1757
def tags_are_versioned(self):
1758
"""Whether the tag container for this branch versions tags."""
1761
def supports_tags_referencing_ghosts(self):
1762
"""True if tags can reference ghost revisions."""
1766
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1767
"""A factory for a BranchFormat object, permitting simple lazy registration.
1769
While none of the built in BranchFormats are lazy registered yet,
1770
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1771
use it, and the bzr-loom plugin uses it as well (see
1772
bzrlib.plugins.loom.formats).
1775
def __init__(self, format_string, module_name, member_name):
1776
"""Create a MetaDirBranchFormatFactory.
1778
:param format_string: The format string the format has.
1779
:param module_name: Module to load the format class from.
1780
:param member_name: Attribute name within the module for the format class.
1782
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1783
self._format_string = format_string
1785
def get_format_string(self):
1786
"""See BranchFormat.get_format_string."""
1787
return self._format_string
1790
"""Used for network_format_registry support."""
1791
return self.get_obj()()
1794
class BranchHooks(Hooks):
1795
"""A dictionary mapping hook name to a list of callables for branch hooks.
1797
e.g. ['set_rh'] Is the list of items to be called when the
1798
set_revision_history function is invoked.
1802
"""Create the default hooks.
1804
These are all empty initially, because by default nothing should get
1807
Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1808
self.add_hook('set_rh',
1809
"Invoked whenever the revision history has been set via "
1810
"set_revision_history. The api signature is (branch, "
1811
"revision_history), and the branch will be write-locked. "
1812
"The set_rh hook can be expensive for bzr to trigger, a better "
1813
"hook to use is Branch.post_change_branch_tip.", (0, 15))
1814
self.add_hook('open',
1815
"Called with the Branch object that has been opened after a "
1816
"branch is opened.", (1, 8))
1817
self.add_hook('post_push',
1818
"Called after a push operation completes. post_push is called "
1819
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1820
"bzr client.", (0, 15))
1821
self.add_hook('post_pull',
1822
"Called after a pull operation completes. post_pull is called "
1823
"with a bzrlib.branch.PullResult object and only runs in the "
1824
"bzr client.", (0, 15))
1825
self.add_hook('pre_commit',
1826
"Called after a commit is calculated but before it is "
1827
"completed. pre_commit is called with (local, master, old_revno, "
1828
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1829
"). old_revid is NULL_REVISION for the first commit to a branch, "
1830
"tree_delta is a TreeDelta object describing changes from the "
1831
"basis revision. hooks MUST NOT modify this delta. "
1832
" future_tree is an in-memory tree obtained from "
1833
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1835
self.add_hook('post_commit',
1836
"Called in the bzr client after a commit has completed. "
1837
"post_commit is called with (local, master, old_revno, old_revid, "
1838
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1839
"commit to a branch.", (0, 15))
1840
self.add_hook('post_uncommit',
1841
"Called in the bzr client after an uncommit completes. "
1842
"post_uncommit is called with (local, master, old_revno, "
1843
"old_revid, new_revno, new_revid) where local is the local branch "
1844
"or None, master is the target branch, and an empty branch "
1845
"receives new_revno of 0, new_revid of None.", (0, 15))
1846
self.add_hook('pre_change_branch_tip',
1847
"Called in bzr client and server before a change to the tip of a "
1848
"branch is made. pre_change_branch_tip is called with a "
1849
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1850
"commit, uncommit will all trigger this hook.", (1, 6))
1851
self.add_hook('post_change_branch_tip',
1852
"Called in bzr client and server after a change to the tip of a "
1853
"branch is made. post_change_branch_tip is called with a "
1854
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1855
"commit, uncommit will all trigger this hook.", (1, 4))
1856
self.add_hook('transform_fallback_location',
1857
"Called when a stacked branch is activating its fallback "
1858
"locations. transform_fallback_location is called with (branch, "
1859
"url), and should return a new url. Returning the same url "
1860
"allows it to be used as-is, returning a different one can be "
1861
"used to cause the branch to stack on a closer copy of that "
1862
"fallback_location. Note that the branch cannot have history "
1863
"accessing methods called on it during this hook because the "
1864
"fallback locations have not been activated. When there are "
1865
"multiple hooks installed for transform_fallback_location, "
1866
"all are called with the url returned from the previous hook."
1867
"The order is however undefined.", (1, 9))
1868
self.add_hook('automatic_tag_name',
1869
"Called to determine an automatic tag name for a revision. "
1870
"automatic_tag_name is called with (branch, revision_id) and "
1871
"should return a tag name or None if no tag name could be "
1872
"determined. The first non-None tag name returned will be used.",
1874
self.add_hook('post_branch_init',
1875
"Called after new branch initialization completes. "
1876
"post_branch_init is called with a "
1877
"bzrlib.branch.BranchInitHookParams. "
1878
"Note that init, branch and checkout (both heavyweight and "
1879
"lightweight) will all trigger this hook.", (2, 2))
1880
self.add_hook('post_switch',
1881
"Called after a checkout switches branch. "
1882
"post_switch is called with a "
1883
"bzrlib.branch.SwitchHookParams.", (2, 2))
1887
# install the default hooks into the Branch class.
1888
Branch.hooks = BranchHooks()
1891
class ChangeBranchTipParams(object):
1892
"""Object holding parameters passed to `*_change_branch_tip` hooks.
1894
There are 5 fields that hooks may wish to access:
1896
:ivar branch: the branch being changed
1897
:ivar old_revno: revision number before the change
1898
:ivar new_revno: revision number after the change
1899
:ivar old_revid: revision id before the change
1900
:ivar new_revid: revision id after the change
1902
The revid fields are strings. The revno fields are integers.
1905
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1906
"""Create a group of ChangeBranchTip parameters.
1908
:param branch: The branch being changed.
1909
:param old_revno: Revision number before the change.
1910
:param new_revno: Revision number after the change.
1911
:param old_revid: Tip revision id before the change.
1912
:param new_revid: Tip revision id after the change.
1914
self.branch = branch
1915
self.old_revno = old_revno
1916
self.new_revno = new_revno
1917
self.old_revid = old_revid
1918
self.new_revid = new_revid
1920
def __eq__(self, other):
1921
return self.__dict__ == other.__dict__
1924
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1925
self.__class__.__name__, self.branch,
1926
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1929
class BranchInitHookParams(object):
1930
"""Object holding parameters passed to `*_branch_init` hooks.
1932
There are 4 fields that hooks may wish to access:
1934
:ivar format: the branch format
1935
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1936
:ivar name: name of colocated branch, if any (or None)
1937
:ivar branch: the branch created
1939
Note that for lightweight checkouts, the bzrdir and format fields refer to
1940
the checkout, hence they are different from the corresponding fields in
1941
branch, which refer to the original branch.
1944
def __init__(self, format, controldir, name, branch):
1945
"""Create a group of BranchInitHook parameters.
1947
:param format: the branch format
1948
:param controldir: the ControlDir where the branch will be/has been
1950
:param name: name of colocated branch, if any (or None)
1951
:param branch: the branch created
1953
Note that for lightweight checkouts, the bzrdir and format fields refer
1954
to the checkout, hence they are different from the corresponding fields
1955
in branch, which refer to the original branch.
1957
self.format = format
1958
self.bzrdir = controldir
1960
self.branch = branch
1962
def __eq__(self, other):
1963
return self.__dict__ == other.__dict__
1966
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1969
class SwitchHookParams(object):
1970
"""Object holding parameters passed to `*_switch` hooks.
1972
There are 4 fields that hooks may wish to access:
1974
:ivar control_dir: ControlDir of the checkout to change
1975
:ivar to_branch: branch that the checkout is to reference
1976
:ivar force: skip the check for local commits in a heavy checkout
1977
:ivar revision_id: revision ID to switch to (or None)
1980
def __init__(self, control_dir, to_branch, force, revision_id):
1981
"""Create a group of SwitchHook parameters.
1983
:param control_dir: ControlDir of the checkout to change
1984
:param to_branch: branch that the checkout is to reference
1985
:param force: skip the check for local commits in a heavy checkout
1986
:param revision_id: revision ID to switch to (or None)
1988
self.control_dir = control_dir
1989
self.to_branch = to_branch
1991
self.revision_id = revision_id
1993
def __eq__(self, other):
1994
return self.__dict__ == other.__dict__
1997
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1998
self.control_dir, self.to_branch,
2002
class BranchFormatMetadir(bzrdir.BzrDirMetaComponentFormat, BranchFormat):
2003
"""Base class for branch formats that live in meta directories.
2007
BranchFormat.__init__(self)
2008
bzrdir.BzrDirMetaComponentFormat.__init__(self)
2011
def find_format(klass, controldir, name=None):
2012
"""Return the format for the branch object in controldir."""
2014
transport = controldir.get_branch_transport(None, name=name)
2015
except errors.NoSuchFile:
2016
raise errors.NotBranchError(path=name, bzrdir=controldir)
2018
format_string = transport.get_bytes("format")
2019
except errors.NoSuchFile:
2020
raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
2021
return klass._find_format(format_registry, 'branch', format_string)
2023
def _branch_class(self):
2024
"""What class to instantiate on open calls."""
2025
raise NotImplementedError(self._branch_class)
2027
def _get_initial_config(self, append_revisions_only=None):
2028
if append_revisions_only:
2029
return "append_revisions_only = True\n"
2031
# Avoid writing anything if append_revisions_only is disabled,
2032
# as that is the default.
2035
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
2037
"""Initialize a branch in a bzrdir, with specified files
2039
:param a_bzrdir: The bzrdir to initialize the branch in
2040
:param utf8_files: The files to create as a list of
2041
(filename, content) tuples
2042
:param name: Name of colocated branch to create, if any
2043
:return: a branch in this format
2045
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2046
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2047
control_files = lockable_files.LockableFiles(branch_transport,
2048
'lock', lockdir.LockDir)
2049
control_files.create_lock()
2050
control_files.lock_write()
2052
utf8_files += [('format', self.get_format_string())]
2053
for (filename, content) in utf8_files:
2054
branch_transport.put_bytes(
2056
mode=a_bzrdir._get_file_mode())
2058
control_files.unlock()
2059
branch = self.open(a_bzrdir, name, _found=True,
2060
found_repository=repository)
2061
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2064
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2065
found_repository=None, possible_transports=None):
2066
"""See BranchFormat.open()."""
2068
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2069
if format.__class__ != self.__class__:
2070
raise AssertionError("wrong format %r found for %r" %
2072
transport = a_bzrdir.get_branch_transport(None, name=name)
2074
control_files = lockable_files.LockableFiles(transport, 'lock',
2076
if found_repository is None:
2077
found_repository = a_bzrdir.find_repository()
2078
return self._branch_class()(_format=self,
2079
_control_files=control_files,
2082
_repository=found_repository,
2083
ignore_fallbacks=ignore_fallbacks,
2084
possible_transports=possible_transports)
2085
except errors.NoSuchFile:
2086
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2089
def _matchingbzrdir(self):
2090
ret = bzrdir.BzrDirMetaFormat1()
2091
ret.set_branch_format(self)
2094
def supports_tags(self):
2097
def supports_leaving_lock(self):
2101
class BzrBranchFormat5(BranchFormatMetadir):
2102
"""Bzr branch format 5.
2105
- a revision-history file.
2107
- a lock dir guarding the branch itself
2108
- all of this stored in a branch/ subdirectory
2109
- works with shared repositories.
2111
This format is new in bzr 0.8.
2114
def _branch_class(self):
2118
def get_format_string(cls):
2119
"""See BranchFormat.get_format_string()."""
2120
return "Bazaar-NG branch format 5\n"
2122
def get_format_description(self):
2123
"""See BranchFormat.get_format_description()."""
2124
return "Branch format 5"
2126
def initialize(self, a_bzrdir, name=None, repository=None,
2127
append_revisions_only=None):
2128
"""Create a branch of this format in a_bzrdir."""
2129
if append_revisions_only:
2130
raise errors.UpgradeRequired(a_bzrdir.user_url)
2131
utf8_files = [('revision-history', ''),
2132
('branch-name', ''),
2134
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2136
def supports_tags(self):
2140
class BzrBranchFormat6(BranchFormatMetadir):
2141
"""Branch format with last-revision and tags.
2143
Unlike previous formats, this has no explicit revision history. Instead,
2144
this just stores the last-revision, and the left-hand history leading
2145
up to there is the history.
2147
This format was introduced in bzr 0.15
2148
and became the default in 0.91.
2151
def _branch_class(self):
2155
def get_format_string(cls):
2156
"""See BranchFormat.get_format_string()."""
2157
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2159
def get_format_description(self):
2160
"""See BranchFormat.get_format_description()."""
2161
return "Branch format 6"
2163
def initialize(self, a_bzrdir, name=None, repository=None,
2164
append_revisions_only=None):
2165
"""Create a branch of this format in a_bzrdir."""
2166
utf8_files = [('last-revision', '0 null:\n'),
2168
self._get_initial_config(append_revisions_only)),
2171
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2173
def make_tags(self, branch):
2174
"""See bzrlib.branch.BranchFormat.make_tags()."""
2175
return _mod_tag.BasicTags(branch)
2177
def supports_set_append_revisions_only(self):
2181
class BzrBranchFormat8(BranchFormatMetadir):
2182
"""Metadir format supporting storing locations of subtree branches."""
2184
def _branch_class(self):
2188
def get_format_string(cls):
2189
"""See BranchFormat.get_format_string()."""
2190
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2192
def get_format_description(self):
2193
"""See BranchFormat.get_format_description()."""
2194
return "Branch format 8"
2196
def initialize(self, a_bzrdir, name=None, repository=None,
2197
append_revisions_only=None):
2198
"""Create a branch of this format in a_bzrdir."""
2199
utf8_files = [('last-revision', '0 null:\n'),
2201
self._get_initial_config(append_revisions_only)),
2205
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2207
def make_tags(self, branch):
2208
"""See bzrlib.branch.BranchFormat.make_tags()."""
2209
return _mod_tag.BasicTags(branch)
2211
def supports_set_append_revisions_only(self):
2214
def supports_stacking(self):
2217
supports_reference_locations = True
2220
class BzrBranchFormat7(BranchFormatMetadir):
2221
"""Branch format with last-revision, tags, and a stacked location pointer.
2223
The stacked location pointer is passed down to the repository and requires
2224
a repository format with supports_external_lookups = True.
2226
This format was introduced in bzr 1.6.
2229
def initialize(self, a_bzrdir, name=None, repository=None,
2230
append_revisions_only=None):
2231
"""Create a branch of this format in a_bzrdir."""
2232
utf8_files = [('last-revision', '0 null:\n'),
2234
self._get_initial_config(append_revisions_only)),
2237
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2239
def _branch_class(self):
2243
def get_format_string(cls):
2244
"""See BranchFormat.get_format_string()."""
2245
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2247
def get_format_description(self):
2248
"""See BranchFormat.get_format_description()."""
2249
return "Branch format 7"
2251
def supports_set_append_revisions_only(self):
2254
def supports_stacking(self):
2257
def make_tags(self, branch):
2258
"""See bzrlib.branch.BranchFormat.make_tags()."""
2259
return _mod_tag.BasicTags(branch)
2261
supports_reference_locations = False
2264
class BranchReferenceFormat(BranchFormatMetadir):
2265
"""Bzr branch reference format.
2267
Branch references are used in implementing checkouts, they
2268
act as an alias to the real branch which is at some other url.
2276
def get_format_string(cls):
2277
"""See BranchFormat.get_format_string()."""
2278
return "Bazaar-NG Branch Reference Format 1\n"
2280
def get_format_description(self):
2281
"""See BranchFormat.get_format_description()."""
2282
return "Checkout reference format 1"
2284
def get_reference(self, a_bzrdir, name=None):
2285
"""See BranchFormat.get_reference()."""
2286
transport = a_bzrdir.get_branch_transport(None, name=name)
2287
return transport.get_bytes('location')
2289
def set_reference(self, a_bzrdir, name, to_branch):
2290
"""See BranchFormat.set_reference()."""
2291
transport = a_bzrdir.get_branch_transport(None, name=name)
2292
location = transport.put_bytes('location', to_branch.base)
2294
def initialize(self, a_bzrdir, name=None, target_branch=None,
2295
repository=None, append_revisions_only=None):
2296
"""Create a branch of this format in a_bzrdir."""
2297
if target_branch is None:
2298
# this format does not implement branch itself, thus the implicit
2299
# creation contract must see it as uninitializable
2300
raise errors.UninitializableFormat(self)
2301
mutter('creating branch reference in %s', a_bzrdir.user_url)
2302
if a_bzrdir._format.fixed_components:
2303
raise errors.IncompatibleFormat(self, a_bzrdir._format)
2304
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2305
branch_transport.put_bytes('location',
2306
target_branch.user_url)
2307
branch_transport.put_bytes('format', self.get_format_string())
2309
a_bzrdir, name, _found=True,
2310
possible_transports=[target_branch.bzrdir.root_transport])
2311
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2314
def _make_reference_clone_function(format, a_branch):
2315
"""Create a clone() routine for a branch dynamically."""
2316
def clone(to_bzrdir, revision_id=None,
2317
repository_policy=None):
2318
"""See Branch.clone()."""
2319
return format.initialize(to_bzrdir, target_branch=a_branch)
2320
# cannot obey revision_id limits when cloning a reference ...
2321
# FIXME RBC 20060210 either nuke revision_id for clone, or
2322
# emit some sort of warning/error to the caller ?!
2325
def open(self, a_bzrdir, name=None, _found=False, location=None,
2326
possible_transports=None, ignore_fallbacks=False,
2327
found_repository=None):
2328
"""Return the branch that the branch reference in a_bzrdir points at.
2330
:param a_bzrdir: A BzrDir that contains a branch.
2331
:param name: Name of colocated branch to open, if any
2332
:param _found: a private parameter, do not use it. It is used to
2333
indicate if format probing has already be done.
2334
:param ignore_fallbacks: when set, no fallback branches will be opened
2335
(if there are any). Default is to open fallbacks.
2336
:param location: The location of the referenced branch. If
2337
unspecified, this will be determined from the branch reference in
2339
:param possible_transports: An optional reusable transports list.
2342
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2343
if format.__class__ != self.__class__:
2344
raise AssertionError("wrong format %r found for %r" %
2346
if location is None:
2347
location = self.get_reference(a_bzrdir, name)
2348
real_bzrdir = controldir.ControlDir.open(
2349
location, possible_transports=possible_transports)
2350
result = real_bzrdir.open_branch(name=name,
2351
ignore_fallbacks=ignore_fallbacks,
2352
possible_transports=possible_transports)
2353
# this changes the behaviour of result.clone to create a new reference
2354
# rather than a copy of the content of the branch.
2355
# I did not use a proxy object because that needs much more extensive
2356
# testing, and we are only changing one behaviour at the moment.
2357
# If we decide to alter more behaviours - i.e. the implicit nickname
2358
# then this should be refactored to introduce a tested proxy branch
2359
# and a subclass of that for use in overriding clone() and ....
2361
result.clone = self._make_reference_clone_function(result)
2365
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2366
"""Branch format registry."""
2368
def __init__(self, other_registry=None):
2369
super(BranchFormatRegistry, self).__init__(other_registry)
2370
self._default_format = None
2372
def set_default(self, format):
2373
self._default_format = format
2375
def get_default(self):
2376
return self._default_format
2379
network_format_registry = registry.FormatRegistry()
2380
"""Registry of formats indexed by their network name.
2382
The network name for a branch format is an identifier that can be used when
2383
referring to formats with smart server operations. See
2384
BranchFormat.network_name() for more detail.
2387
format_registry = BranchFormatRegistry(network_format_registry)
2390
# formats which have no format string are not discoverable
2391
# and not independently creatable, so are not registered.
2392
__format5 = BzrBranchFormat5()
2393
__format6 = BzrBranchFormat6()
2394
__format7 = BzrBranchFormat7()
2395
__format8 = BzrBranchFormat8()
2396
format_registry.register(__format5)
2397
format_registry.register(BranchReferenceFormat())
2398
format_registry.register(__format6)
2399
format_registry.register(__format7)
2400
format_registry.register(__format8)
2401
format_registry.set_default(__format7)
2404
class BranchWriteLockResult(LogicalLockResult):
2405
"""The result of write locking a branch.
2407
:ivar branch_token: The token obtained from the underlying branch lock, or
2409
:ivar unlock: A callable which will unlock the lock.
2412
def __init__(self, unlock, branch_token):
2413
LogicalLockResult.__init__(self, unlock)
2414
self.branch_token = branch_token
2417
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2421
class BzrBranch(Branch, _RelockDebugMixin):
2422
"""A branch stored in the actual filesystem.
2424
Note that it's "local" in the context of the filesystem; it doesn't
2425
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2426
it's writable, and can be accessed via the normal filesystem API.
2428
:ivar _transport: Transport for file operations on this branch's
2429
control files, typically pointing to the .bzr/branch directory.
2430
:ivar repository: Repository for this branch.
2431
:ivar base: The url of the base directory for this branch; the one
2432
containing the .bzr directory.
2433
:ivar name: Optional colocated branch name as it exists in the control
2437
def __init__(self, _format=None,
2438
_control_files=None, a_bzrdir=None, name=None,
2439
_repository=None, ignore_fallbacks=False,
2440
possible_transports=None):
2441
"""Create new branch object at a particular location."""
2442
if a_bzrdir is None:
2443
raise ValueError('a_bzrdir must be supplied')
2445
self.bzrdir = a_bzrdir
2446
self._user_transport = self.bzrdir.transport.clone('..')
2447
if name is not None:
2448
self._user_transport.set_segment_parameter(
2449
"branch", urlutils.escape(name))
2450
self._base = self._user_transport.base
2452
self._format = _format
2453
if _control_files is None:
2454
raise ValueError('BzrBranch _control_files is None')
2455
self.control_files = _control_files
2456
self._transport = _control_files._transport
2457
self.repository = _repository
2458
Branch.__init__(self, possible_transports)
2461
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2465
def _get_base(self):
2466
"""Returns the directory containing the control directory."""
2469
base = property(_get_base, doc="The URL for the root of this branch.")
2472
def user_transport(self):
2473
return self._user_transport
2475
def _get_config(self):
2476
return _mod_config.TransportConfig(self._transport, 'branch.conf')
2478
def _get_config_store(self):
2479
return _mod_config.BranchStore(self)
2481
def is_locked(self):
2482
return self.control_files.is_locked()
2484
def lock_write(self, token=None):
2485
"""Lock the branch for write operations.
2487
:param token: A token to permit reacquiring a previously held and
2489
:return: A BranchWriteLockResult.
2491
if not self.is_locked():
2492
self._note_lock('w')
2493
# All-in-one needs to always unlock/lock.
2494
repo_control = getattr(self.repository, 'control_files', None)
2495
if self.control_files == repo_control or not self.is_locked():
2496
self.repository._warn_if_deprecated(self)
2497
self.repository.lock_write()
2502
return BranchWriteLockResult(self.unlock,
2503
self.control_files.lock_write(token=token))
2506
self.repository.unlock()
2509
def lock_read(self):
2510
"""Lock the branch for read operations.
2512
:return: A bzrlib.lock.LogicalLockResult.
2514
if not self.is_locked():
2515
self._note_lock('r')
2516
# All-in-one needs to always unlock/lock.
2517
repo_control = getattr(self.repository, 'control_files', None)
2518
if self.control_files == repo_control or not self.is_locked():
2519
self.repository._warn_if_deprecated(self)
2520
self.repository.lock_read()
2525
self.control_files.lock_read()
2526
return LogicalLockResult(self.unlock)
2529
self.repository.unlock()
2532
@only_raises(errors.LockNotHeld, errors.LockBroken)
2535
self.control_files.unlock()
2537
# All-in-one needs to always unlock/lock.
2538
repo_control = getattr(self.repository, 'control_files', None)
2539
if (self.control_files == repo_control or
2540
not self.control_files.is_locked()):
2541
self.repository.unlock()
2542
if not self.control_files.is_locked():
2543
# we just released the lock
2544
self._clear_cached_state()
2546
def peek_lock_mode(self):
2547
if self.control_files._lock_count == 0:
2550
return self.control_files._lock_mode
2552
def get_physical_lock_status(self):
2553
return self.control_files.get_physical_lock_status()
2556
def print_file(self, file, revision_id):
2557
"""See Branch.print_file."""
2558
return self.repository.print_file(file, revision_id)
2561
def set_last_revision_info(self, revno, revision_id):
2562
if not revision_id or not isinstance(revision_id, basestring):
2563
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2564
revision_id = _mod_revision.ensure_null(revision_id)
2565
old_revno, old_revid = self.last_revision_info()
2566
if self.get_append_revisions_only():
2567
self._check_history_violation(revision_id)
2568
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2569
self._write_last_revision_info(revno, revision_id)
2570
self._clear_cached_state()
2571
self._last_revision_info_cache = revno, revision_id
2572
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2574
def basis_tree(self):
2575
"""See Branch.basis_tree."""
2576
return self.repository.revision_tree(self.last_revision())
2578
def _get_parent_location(self):
2579
_locs = ['parent', 'pull', 'x-pull']
2582
return self._transport.get_bytes(l).strip('\n')
2583
except errors.NoSuchFile:
2587
def get_stacked_on_url(self):
2588
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2590
def set_push_location(self, location):
2591
"""See Branch.set_push_location."""
2592
self.get_config().set_user_option(
2593
'push_location', location,
2594
store=_mod_config.STORE_LOCATION_NORECURSE)
2596
def _set_parent_location(self, url):
2598
self._transport.delete('parent')
2600
self._transport.put_bytes('parent', url + '\n',
2601
mode=self.bzrdir._get_file_mode())
2605
"""If bound, unbind"""
2606
return self.set_bound_location(None)
2609
def bind(self, other):
2610
"""Bind this branch to the branch other.
2612
This does not push or pull data between the branches, though it does
2613
check for divergence to raise an error when the branches are not
2614
either the same, or one a prefix of the other. That behaviour may not
2615
be useful, so that check may be removed in future.
2617
:param other: The branch to bind to
2620
# TODO: jam 20051230 Consider checking if the target is bound
2621
# It is debatable whether you should be able to bind to
2622
# a branch which is itself bound.
2623
# Committing is obviously forbidden,
2624
# but binding itself may not be.
2625
# Since we *have* to check at commit time, we don't
2626
# *need* to check here
2628
# we want to raise diverged if:
2629
# last_rev is not in the other_last_rev history, AND
2630
# other_last_rev is not in our history, and do it without pulling
2632
self.set_bound_location(other.base)
2634
def get_bound_location(self):
2636
return self._transport.get_bytes('bound')[:-1]
2637
except errors.NoSuchFile:
2641
def get_master_branch(self, possible_transports=None):
2642
"""Return the branch we are bound to.
2644
:return: Either a Branch, or None
2646
if self._master_branch_cache is None:
2647
self._master_branch_cache = self._get_master_branch(
2648
possible_transports)
2649
return self._master_branch_cache
2651
def _get_master_branch(self, possible_transports):
2652
bound_loc = self.get_bound_location()
2656
return Branch.open(bound_loc,
2657
possible_transports=possible_transports)
2658
except (errors.NotBranchError, errors.ConnectionError), e:
2659
raise errors.BoundBranchConnectionFailure(
2663
def set_bound_location(self, location):
2664
"""Set the target where this branch is bound to.
2666
:param location: URL to the target branch
2668
self._master_branch_cache = None
2670
self._transport.put_bytes('bound', location+'\n',
2671
mode=self.bzrdir._get_file_mode())
2674
self._transport.delete('bound')
2675
except errors.NoSuchFile:
2680
def update(self, possible_transports=None):
2681
"""Synchronise this branch with the master branch if any.
2683
:return: None or the last_revision that was pivoted out during the
2686
master = self.get_master_branch(possible_transports)
2687
if master is not None:
2688
old_tip = _mod_revision.ensure_null(self.last_revision())
2689
self.pull(master, overwrite=True)
2690
if self.repository.get_graph().is_ancestor(old_tip,
2691
_mod_revision.ensure_null(self.last_revision())):
2696
def _read_last_revision_info(self):
2697
revision_string = self._transport.get_bytes('last-revision')
2698
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2699
revision_id = cache_utf8.get_cached_utf8(revision_id)
2701
return revno, revision_id
2703
def _write_last_revision_info(self, revno, revision_id):
2704
"""Simply write out the revision id, with no checks.
2706
Use set_last_revision_info to perform this safely.
2708
Does not update the revision_history cache.
2710
revision_id = _mod_revision.ensure_null(revision_id)
2711
out_string = '%d %s\n' % (revno, revision_id)
2712
self._transport.put_bytes('last-revision', out_string,
2713
mode=self.bzrdir._get_file_mode())
2716
class FullHistoryBzrBranch(BzrBranch):
2717
"""Bzr branch which contains the full revision history."""
2720
def set_last_revision_info(self, revno, revision_id):
2721
if not revision_id or not isinstance(revision_id, basestring):
2722
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2723
revision_id = _mod_revision.ensure_null(revision_id)
2724
# this old format stores the full history, but this api doesn't
2725
# provide it, so we must generate, and might as well check it's
2727
history = self._lefthand_history(revision_id)
2728
if len(history) != revno:
2729
raise AssertionError('%d != %d' % (len(history), revno))
2730
self._set_revision_history(history)
2732
def _read_last_revision_info(self):
2733
rh = self._revision_history()
2736
return (revno, rh[-1])
2738
return (0, _mod_revision.NULL_REVISION)
2740
@deprecated_method(deprecated_in((2, 4, 0)))
2742
def set_revision_history(self, rev_history):
2743
"""See Branch.set_revision_history."""
2744
self._set_revision_history(rev_history)
2746
def _set_revision_history(self, rev_history):
2747
if 'evil' in debug.debug_flags:
2748
mutter_callsite(3, "set_revision_history scales with history.")
2749
check_not_reserved_id = _mod_revision.check_not_reserved_id
2750
for rev_id in rev_history:
2751
check_not_reserved_id(rev_id)
2752
if Branch.hooks['post_change_branch_tip']:
2753
# Don't calculate the last_revision_info() if there are no hooks
2755
old_revno, old_revid = self.last_revision_info()
2756
if len(rev_history) == 0:
2757
revid = _mod_revision.NULL_REVISION
2759
revid = rev_history[-1]
2760
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2761
self._write_revision_history(rev_history)
2762
self._clear_cached_state()
2763
self._cache_revision_history(rev_history)
2764
for hook in Branch.hooks['set_rh']:
2765
hook(self, rev_history)
2766
if Branch.hooks['post_change_branch_tip']:
2767
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2769
def _write_revision_history(self, history):
2770
"""Factored out of set_revision_history.
2772
This performs the actual writing to disk.
2773
It is intended to be called by set_revision_history."""
2774
self._transport.put_bytes(
2775
'revision-history', '\n'.join(history),
2776
mode=self.bzrdir._get_file_mode())
2778
def _gen_revision_history(self):
2779
history = self._transport.get_bytes('revision-history').split('\n')
2780
if history[-1:] == ['']:
2781
# There shouldn't be a trailing newline, but just in case.
2785
def _synchronize_history(self, destination, revision_id):
2786
if not isinstance(destination, FullHistoryBzrBranch):
2787
super(BzrBranch, self)._synchronize_history(
2788
destination, revision_id)
2790
if revision_id == _mod_revision.NULL_REVISION:
2793
new_history = self._revision_history()
2794
if revision_id is not None and new_history != []:
2796
new_history = new_history[:new_history.index(revision_id) + 1]
2798
rev = self.repository.get_revision(revision_id)
2799
new_history = rev.get_history(self.repository)[1:]
2800
destination._set_revision_history(new_history)
2803
def generate_revision_history(self, revision_id, last_rev=None,
2805
"""Create a new revision history that will finish with revision_id.
2807
:param revision_id: the new tip to use.
2808
:param last_rev: The previous last_revision. If not None, then this
2809
must be a ancestory of revision_id, or DivergedBranches is raised.
2810
:param other_branch: The other branch that DivergedBranches should
2811
raise with respect to.
2813
self._set_revision_history(self._lefthand_history(revision_id,
2814
last_rev, other_branch))
2817
class BzrBranch5(FullHistoryBzrBranch):
2818
"""A format 5 branch. This supports new features over plain branches.
2820
It has support for a master_branch which is the data for bound branches.
2824
class BzrBranch8(BzrBranch):
2825
"""A branch that stores tree-reference locations."""
2827
def _open_hook(self, possible_transports=None):
2828
if self._ignore_fallbacks:
2830
if possible_transports is None:
2831
possible_transports = [self.bzrdir.root_transport]
2833
url = self.get_stacked_on_url()
2834
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2835
errors.UnstackableBranchFormat):
2838
for hook in Branch.hooks['transform_fallback_location']:
2839
url = hook(self, url)
2841
hook_name = Branch.hooks.get_hook_name(hook)
2842
raise AssertionError(
2843
"'transform_fallback_location' hook %s returned "
2844
"None, not a URL." % hook_name)
2845
self._activate_fallback_location(url,
2846
possible_transports=possible_transports)
2848
def __init__(self, *args, **kwargs):
2849
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2850
super(BzrBranch8, self).__init__(*args, **kwargs)
2851
self._last_revision_info_cache = None
2852
self._reference_info = None
2854
def _clear_cached_state(self):
2855
super(BzrBranch8, self)._clear_cached_state()
2856
self._last_revision_info_cache = None
2857
self._reference_info = None
2859
def _check_history_violation(self, revision_id):
2860
current_revid = self.last_revision()
2861
last_revision = _mod_revision.ensure_null(current_revid)
2862
if _mod_revision.is_null(last_revision):
2864
graph = self.repository.get_graph()
2865
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2866
if lh_ancestor == current_revid:
2868
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2870
def _gen_revision_history(self):
2871
"""Generate the revision history from last revision
2873
last_revno, last_revision = self.last_revision_info()
2874
self._extend_partial_history(stop_index=last_revno-1)
2875
return list(reversed(self._partial_revision_history_cache))
2878
def _set_parent_location(self, url):
2879
"""Set the parent branch"""
2880
self._set_config_location('parent_location', url, make_relative=True)
2883
def _get_parent_location(self):
2884
"""Set the parent branch"""
2885
return self._get_config_location('parent_location')
2888
def _set_all_reference_info(self, info_dict):
2889
"""Replace all reference info stored in a branch.
2891
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2894
writer = rio.RioWriter(s)
2895
for key, (tree_path, branch_location) in info_dict.iteritems():
2896
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2897
branch_location=branch_location)
2898
writer.write_stanza(stanza)
2899
self._transport.put_bytes('references', s.getvalue())
2900
self._reference_info = info_dict
2903
def _get_all_reference_info(self):
2904
"""Return all the reference info stored in a branch.
2906
:return: A dict of {file_id: (tree_path, branch_location)}
2908
if self._reference_info is not None:
2909
return self._reference_info
2910
rio_file = self._transport.get('references')
2912
stanzas = rio.read_stanzas(rio_file)
2913
info_dict = dict((s['file_id'], (s['tree_path'],
2914
s['branch_location'])) for s in stanzas)
2917
self._reference_info = info_dict
2920
def set_reference_info(self, file_id, tree_path, branch_location):
2921
"""Set the branch location to use for a tree reference.
2923
:param file_id: The file-id of the tree reference.
2924
:param tree_path: The path of the tree reference in the tree.
2925
:param branch_location: The location of the branch to retrieve tree
2928
info_dict = self._get_all_reference_info()
2929
info_dict[file_id] = (tree_path, branch_location)
2930
if None in (tree_path, branch_location):
2931
if tree_path is not None:
2932
raise ValueError('tree_path must be None when branch_location'
2934
if branch_location is not None:
2935
raise ValueError('branch_location must be None when tree_path'
2937
del info_dict[file_id]
2938
self._set_all_reference_info(info_dict)
2940
def get_reference_info(self, file_id):
2941
"""Get the tree_path and branch_location for a tree reference.
2943
:return: a tuple of (tree_path, branch_location)
2945
return self._get_all_reference_info().get(file_id, (None, None))
2947
def reference_parent(self, file_id, path, possible_transports=None):
2948
"""Return the parent branch for a tree-reference file_id.
2950
:param file_id: The file_id of the tree reference
2951
:param path: The path of the file_id in the tree
2952
:return: A branch associated with the file_id
2954
branch_location = self.get_reference_info(file_id)[1]
2955
if branch_location is None:
2956
return Branch.reference_parent(self, file_id, path,
2957
possible_transports)
2958
branch_location = urlutils.join(self.user_url, branch_location)
2959
return Branch.open(branch_location,
2960
possible_transports=possible_transports)
2962
def set_push_location(self, location):
2963
"""See Branch.set_push_location."""
2964
self._set_config_location('push_location', location)
2966
def set_bound_location(self, location):
2967
"""See Branch.set_push_location."""
2968
self._master_branch_cache = None
2970
config = self.get_config()
2971
if location is None:
2972
if config.get_user_option('bound') != 'True':
2975
config.set_user_option('bound', 'False', warn_masked=True)
2978
self._set_config_location('bound_location', location,
2980
config.set_user_option('bound', 'True', warn_masked=True)
2983
def _get_bound_location(self, bound):
2984
"""Return the bound location in the config file.
2986
Return None if the bound parameter does not match"""
2987
config = self.get_config()
2988
config_bound = (config.get_user_option('bound') == 'True')
2989
if config_bound != bound:
2991
return self._get_config_location('bound_location', config=config)
2993
def get_bound_location(self):
2994
"""See Branch.set_push_location."""
2995
return self._get_bound_location(True)
2997
def get_old_bound_location(self):
2998
"""See Branch.get_old_bound_location"""
2999
return self._get_bound_location(False)
3001
def get_stacked_on_url(self):
3002
# you can always ask for the URL; but you might not be able to use it
3003
# if the repo can't support stacking.
3004
## self._check_stackable_repo()
3005
# stacked_on_location is only ever defined in branch.conf, so don't
3006
# waste effort reading the whole stack of config files.
3007
config = self.get_config()._get_branch_data_config()
3008
stacked_url = self._get_config_location('stacked_on_location',
3010
if stacked_url is None:
3011
raise errors.NotStacked(self)
3015
def get_rev_id(self, revno, history=None):
3016
"""Find the revision id of the specified revno."""
3018
return _mod_revision.NULL_REVISION
3020
last_revno, last_revision_id = self.last_revision_info()
3021
if revno <= 0 or revno > last_revno:
3022
raise errors.NoSuchRevision(self, revno)
3024
if history is not None:
3025
return history[revno - 1]
3027
index = last_revno - revno
3028
if len(self._partial_revision_history_cache) <= index:
3029
self._extend_partial_history(stop_index=index)
3030
if len(self._partial_revision_history_cache) > index:
3031
return self._partial_revision_history_cache[index]
3033
raise errors.NoSuchRevision(self, revno)
3036
def revision_id_to_revno(self, revision_id):
3037
"""Given a revision id, return its revno"""
3038
if _mod_revision.is_null(revision_id):
3041
index = self._partial_revision_history_cache.index(revision_id)
3044
self._extend_partial_history(stop_revision=revision_id)
3045
except errors.RevisionNotPresent, e:
3046
raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
3047
index = len(self._partial_revision_history_cache) - 1
3049
raise errors.NoSuchRevision(self, revision_id)
3050
if self._partial_revision_history_cache[index] != revision_id:
3051
raise errors.NoSuchRevision(self, revision_id)
3052
return self.revno() - index
3055
class BzrBranch7(BzrBranch8):
3056
"""A branch with support for a fallback repository."""
3058
def set_reference_info(self, file_id, tree_path, branch_location):
3059
Branch.set_reference_info(self, file_id, tree_path, branch_location)
3061
def get_reference_info(self, file_id):
3062
Branch.get_reference_info(self, file_id)
3064
def reference_parent(self, file_id, path, possible_transports=None):
3065
return Branch.reference_parent(self, file_id, path,
3066
possible_transports)
3069
class BzrBranch6(BzrBranch7):
3070
"""See BzrBranchFormat6 for the capabilities of this branch.
3072
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
3076
def get_stacked_on_url(self):
3077
raise errors.UnstackableBranchFormat(self._format, self.user_url)
3080
######################################################################
3081
# results of operations
3084
class _Result(object):
3086
def _show_tag_conficts(self, to_file):
3087
if not getattr(self, 'tag_conflicts', None):
3089
to_file.write('Conflicting tags:\n')
3090
for name, value1, value2 in self.tag_conflicts:
3091
to_file.write(' %s\n' % (name, ))
3094
class PullResult(_Result):
3095
"""Result of a Branch.pull operation.
3097
:ivar old_revno: Revision number before pull.
3098
:ivar new_revno: Revision number after pull.
3099
:ivar old_revid: Tip revision id before pull.
3100
:ivar new_revid: Tip revision id after pull.
3101
:ivar source_branch: Source (local) branch object. (read locked)
3102
:ivar master_branch: Master branch of the target, or the target if no
3104
:ivar local_branch: target branch if there is a Master, else None
3105
:ivar target_branch: Target/destination branch object. (write locked)
3106
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3107
:ivar tag_updates: A dict with new tags, see BasicTags.merge_to
3110
@deprecated_method(deprecated_in((2, 3, 0)))
3112
"""Return the relative change in revno.
3114
:deprecated: Use `new_revno` and `old_revno` instead.
3116
return self.new_revno - self.old_revno
3118
def report(self, to_file):
3119
tag_conflicts = getattr(self, "tag_conflicts", None)
3120
tag_updates = getattr(self, "tag_updates", None)
3122
if self.old_revid != self.new_revid:
3123
to_file.write('Now on revision %d.\n' % self.new_revno)
3125
to_file.write('%d tag(s) updated.\n' % len(tag_updates))
3126
if self.old_revid == self.new_revid and not tag_updates:
3127
if not tag_conflicts:
3128
to_file.write('No revisions or tags to pull.\n')
3130
to_file.write('No revisions to pull.\n')
3131
self._show_tag_conficts(to_file)
3134
class BranchPushResult(_Result):
3135
"""Result of a Branch.push operation.
3137
:ivar old_revno: Revision number (eg 10) of the target before push.
3138
:ivar new_revno: Revision number (eg 12) of the target after push.
3139
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3141
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3143
:ivar source_branch: Source branch object that the push was from. This is
3144
read locked, and generally is a local (and thus low latency) branch.
3145
:ivar master_branch: If target is a bound branch, the master branch of
3146
target, or target itself. Always write locked.
3147
:ivar target_branch: The direct Branch where data is being sent (write
3149
:ivar local_branch: If the target is a bound branch this will be the
3150
target, otherwise it will be None.
3153
@deprecated_method(deprecated_in((2, 3, 0)))
3155
"""Return the relative change in revno.
3157
:deprecated: Use `new_revno` and `old_revno` instead.
3159
return self.new_revno - self.old_revno
3161
def report(self, to_file):
3162
# TODO: This function gets passed a to_file, but then
3163
# ignores it and calls note() instead. This is also
3164
# inconsistent with PullResult(), which writes to stdout.
3165
# -- JRV20110901, bug #838853
3166
tag_conflicts = getattr(self, "tag_conflicts", None)
3167
tag_updates = getattr(self, "tag_updates", None)
3169
if self.old_revid != self.new_revid:
3170
note(gettext('Pushed up to revision %d.') % self.new_revno)
3172
note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
3173
if self.old_revid == self.new_revid and not tag_updates:
3174
if not tag_conflicts:
3175
note(gettext('No new revisions or tags to push.'))
3177
note(gettext('No new revisions to push.'))
3178
self._show_tag_conficts(to_file)
3181
class BranchCheckResult(object):
3182
"""Results of checking branch consistency.
3187
def __init__(self, branch):
3188
self.branch = branch
3191
def report_results(self, verbose):
3192
"""Report the check results via trace.note.
3194
:param verbose: Requests more detailed display of what was checked,
3197
note(gettext('checked branch {0} format {1}').format(
3198
self.branch.user_url, self.branch._format))
3199
for error in self.errors:
3200
note(gettext('found error:%s'), error)
3203
class Converter5to6(object):
3204
"""Perform an in-place upgrade of format 5 to format 6"""
3206
def convert(self, branch):
3207
# Data for 5 and 6 can peacefully coexist.
3208
format = BzrBranchFormat6()
3209
new_branch = format.open(branch.bzrdir, _found=True)
3211
# Copy source data into target
3212
new_branch._write_last_revision_info(*branch.last_revision_info())
3213
new_branch.set_parent(branch.get_parent())
3214
new_branch.set_bound_location(branch.get_bound_location())
3215
new_branch.set_push_location(branch.get_push_location())
3217
# New branch has no tags by default
3218
new_branch.tags._set_tag_dict({})
3220
# Copying done; now update target format
3221
new_branch._transport.put_bytes('format',
3222
format.get_format_string(),
3223
mode=new_branch.bzrdir._get_file_mode())
3225
# Clean up old files
3226
new_branch._transport.delete('revision-history')
3228
branch.set_parent(None)
3229
except errors.NoSuchFile:
3231
branch.set_bound_location(None)
3234
class Converter6to7(object):
3235
"""Perform an in-place upgrade of format 6 to format 7"""
3237
def convert(self, branch):
3238
format = BzrBranchFormat7()
3239
branch._set_config_location('stacked_on_location', '')
3240
# update target format
3241
branch._transport.put_bytes('format', format.get_format_string())
3244
class Converter7to8(object):
3245
"""Perform an in-place upgrade of format 7 to format 8"""
3247
def convert(self, branch):
3248
format = BzrBranchFormat8()
3249
branch._transport.put_bytes('references', '')
3250
# update target format
3251
branch._transport.put_bytes('format', format.get_format_string())
3254
class InterBranch(InterObject):
3255
"""This class represents operations taking place between two branches.
3257
Its instances have methods like pull() and push() and contain
3258
references to the source and target repositories these operations
3259
can be carried out on.
3263
"""The available optimised InterBranch types."""
3266
def _get_branch_formats_to_test(klass):
3267
"""Return an iterable of format tuples for testing.
3269
:return: An iterable of (from_format, to_format) to use when testing
3270
this InterBranch class. Each InterBranch class should define this
3273
raise NotImplementedError(klass._get_branch_formats_to_test)
3276
def pull(self, overwrite=False, stop_revision=None,
3277
possible_transports=None, local=False):
3278
"""Mirror source into target branch.
3280
The target branch is considered to be 'local', having low latency.
3282
:returns: PullResult instance
3284
raise NotImplementedError(self.pull)
3287
def push(self, overwrite=False, stop_revision=None, lossy=False,
3288
_override_hook_source_branch=None):
3289
"""Mirror the source branch into the target branch.
3291
The source branch is considered to be 'local', having low latency.
3293
raise NotImplementedError(self.push)
3296
def copy_content_into(self, revision_id=None):
3297
"""Copy the content of source into target
3299
revision_id: if not None, the revision history in the new branch will
3300
be truncated to end with revision_id.
3302
raise NotImplementedError(self.copy_content_into)
3305
def fetch(self, stop_revision=None, limit=None):
3308
:param stop_revision: Last revision to fetch
3309
:param limit: Optional rough limit of revisions to fetch
3311
raise NotImplementedError(self.fetch)
3314
class GenericInterBranch(InterBranch):
3315
"""InterBranch implementation that uses public Branch functions."""
3318
def is_compatible(klass, source, target):
3319
# GenericBranch uses the public API, so always compatible
3323
def _get_branch_formats_to_test(klass):
3324
return [(format_registry.get_default(), format_registry.get_default())]
3327
def unwrap_format(klass, format):
3328
if isinstance(format, remote.RemoteBranchFormat):
3329
format._ensure_real()
3330
return format._custom_format
3334
def copy_content_into(self, revision_id=None):
3335
"""Copy the content of source into target
3337
revision_id: if not None, the revision history in the new branch will
3338
be truncated to end with revision_id.
3340
self.source.update_references(self.target)
3341
self.source._synchronize_history(self.target, revision_id)
3343
parent = self.source.get_parent()
3344
except errors.InaccessibleParent, e:
3345
mutter('parent was not accessible to copy: %s', e)
3348
self.target.set_parent(parent)
3349
if self.source._push_should_merge_tags():
3350
self.source.tags.merge_to(self.target.tags)
3353
def fetch(self, stop_revision=None, limit=None):
3354
if self.target.base == self.source.base:
3356
self.source.lock_read()
3358
fetch_spec_factory = fetch.FetchSpecFactory()
3359
fetch_spec_factory.source_branch = self.source
3360
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3361
fetch_spec_factory.source_repo = self.source.repository
3362
fetch_spec_factory.target_repo = self.target.repository
3363
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3364
fetch_spec_factory.limit = limit
3365
fetch_spec = fetch_spec_factory.make_fetch_spec()
3366
return self.target.repository.fetch(self.source.repository,
3367
fetch_spec=fetch_spec)
3369
self.source.unlock()
3372
def _update_revisions(self, stop_revision=None, overwrite=False,
3374
other_revno, other_last_revision = self.source.last_revision_info()
3375
stop_revno = None # unknown
3376
if stop_revision is None:
3377
stop_revision = other_last_revision
3378
if _mod_revision.is_null(stop_revision):
3379
# if there are no commits, we're done.
3381
stop_revno = other_revno
3383
# what's the current last revision, before we fetch [and change it
3385
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3386
# we fetch here so that we don't process data twice in the common
3387
# case of having something to pull, and so that the check for
3388
# already merged can operate on the just fetched graph, which will
3389
# be cached in memory.
3390
self.fetch(stop_revision=stop_revision)
3391
# Check to see if one is an ancestor of the other
3394
graph = self.target.repository.get_graph()
3395
if self.target._check_if_descendant_or_diverged(
3396
stop_revision, last_rev, graph, self.source):
3397
# stop_revision is a descendant of last_rev, but we aren't
3398
# overwriting, so we're done.
3400
if stop_revno is None:
3402
graph = self.target.repository.get_graph()
3403
this_revno, this_last_revision = \
3404
self.target.last_revision_info()
3405
stop_revno = graph.find_distance_to_null(stop_revision,
3406
[(other_last_revision, other_revno),
3407
(this_last_revision, this_revno)])
3408
self.target.set_last_revision_info(stop_revno, stop_revision)
3411
def pull(self, overwrite=False, stop_revision=None,
3412
possible_transports=None, run_hooks=True,
3413
_override_hook_target=None, local=False):
3414
"""Pull from source into self, updating my master if any.
3416
:param run_hooks: Private parameter - if false, this branch
3417
is being called because it's the master of the primary branch,
3418
so it should not run its hooks.
3420
bound_location = self.target.get_bound_location()
3421
if local and not bound_location:
3422
raise errors.LocalRequiresBoundBranch()
3423
master_branch = None
3424
source_is_master = False
3426
# bound_location comes from a config file, some care has to be
3427
# taken to relate it to source.user_url
3428
normalized = urlutils.normalize_url(bound_location)
3430
relpath = self.source.user_transport.relpath(normalized)
3431
source_is_master = (relpath == '')
3432
except (errors.PathNotChild, errors.InvalidURL):
3433
source_is_master = False
3434
if not local and bound_location and not source_is_master:
3435
# not pulling from master, so we need to update master.
3436
master_branch = self.target.get_master_branch(possible_transports)
3437
master_branch.lock_write()
3440
# pull from source into master.
3441
master_branch.pull(self.source, overwrite, stop_revision,
3443
return self._pull(overwrite,
3444
stop_revision, _hook_master=master_branch,
3445
run_hooks=run_hooks,
3446
_override_hook_target=_override_hook_target,
3447
merge_tags_to_master=not source_is_master)
3450
master_branch.unlock()
3452
def push(self, overwrite=False, stop_revision=None, lossy=False,
3453
_override_hook_source_branch=None):
3454
"""See InterBranch.push.
3456
This is the basic concrete implementation of push()
3458
:param _override_hook_source_branch: If specified, run the hooks
3459
passing this Branch as the source, rather than self. This is for
3460
use of RemoteBranch, where push is delegated to the underlying
3464
raise errors.LossyPushToSameVCS(self.source, self.target)
3465
# TODO: Public option to disable running hooks - should be trivial but
3468
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3469
op.add_cleanup(self.source.lock_read().unlock)
3470
op.add_cleanup(self.target.lock_write().unlock)
3471
return op.run(overwrite, stop_revision,
3472
_override_hook_source_branch=_override_hook_source_branch)
3474
def _basic_push(self, overwrite, stop_revision):
3475
"""Basic implementation of push without bound branches or hooks.
3477
Must be called with source read locked and target write locked.
3479
result = BranchPushResult()
3480
result.source_branch = self.source
3481
result.target_branch = self.target
3482
result.old_revno, result.old_revid = self.target.last_revision_info()
3483
self.source.update_references(self.target)
3484
if result.old_revid != stop_revision:
3485
# We assume that during 'push' this repository is closer than
3487
graph = self.source.repository.get_graph(self.target.repository)
3488
self._update_revisions(stop_revision, overwrite=overwrite,
3490
if self.source._push_should_merge_tags():
3491
result.tag_updates, result.tag_conflicts = (
3492
self.source.tags.merge_to(self.target.tags, overwrite))
3493
result.new_revno, result.new_revid = self.target.last_revision_info()
3496
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3497
_override_hook_source_branch=None):
3498
"""Push from source into target, and into target's master if any.
3501
if _override_hook_source_branch:
3502
result.source_branch = _override_hook_source_branch
3503
for hook in Branch.hooks['post_push']:
3506
bound_location = self.target.get_bound_location()
3507
if bound_location and self.target.base != bound_location:
3508
# there is a master branch.
3510
# XXX: Why the second check? Is it even supported for a branch to
3511
# be bound to itself? -- mbp 20070507
3512
master_branch = self.target.get_master_branch()
3513
master_branch.lock_write()
3514
operation.add_cleanup(master_branch.unlock)
3515
# push into the master from the source branch.
3516
master_inter = InterBranch.get(self.source, master_branch)
3517
master_inter._basic_push(overwrite, stop_revision)
3518
# and push into the target branch from the source. Note that
3519
# we push from the source branch again, because it's considered
3520
# the highest bandwidth repository.
3521
result = self._basic_push(overwrite, stop_revision)
3522
result.master_branch = master_branch
3523
result.local_branch = self.target
3525
master_branch = None
3527
result = self._basic_push(overwrite, stop_revision)
3528
# TODO: Why set master_branch and local_branch if there's no
3529
# binding? Maybe cleaner to just leave them unset? -- mbp
3531
result.master_branch = self.target
3532
result.local_branch = None
3536
def _pull(self, overwrite=False, stop_revision=None,
3537
possible_transports=None, _hook_master=None, run_hooks=True,
3538
_override_hook_target=None, local=False,
3539
merge_tags_to_master=True):
3542
This function is the core worker, used by GenericInterBranch.pull to
3543
avoid duplication when pulling source->master and source->local.
3545
:param _hook_master: Private parameter - set the branch to
3546
be supplied as the master to pull hooks.
3547
:param run_hooks: Private parameter - if false, this branch
3548
is being called because it's the master of the primary branch,
3549
so it should not run its hooks.
3550
is being called because it's the master of the primary branch,
3551
so it should not run its hooks.
3552
:param _override_hook_target: Private parameter - set the branch to be
3553
supplied as the target_branch to pull hooks.
3554
:param local: Only update the local branch, and not the bound branch.
3556
# This type of branch can't be bound.
3558
raise errors.LocalRequiresBoundBranch()
3559
result = PullResult()
3560
result.source_branch = self.source
3561
if _override_hook_target is None:
3562
result.target_branch = self.target
3564
result.target_branch = _override_hook_target
3565
self.source.lock_read()
3567
# We assume that during 'pull' the target repository is closer than
3569
self.source.update_references(self.target)
3570
graph = self.target.repository.get_graph(self.source.repository)
3571
# TODO: Branch formats should have a flag that indicates
3572
# that revno's are expensive, and pull() should honor that flag.
3574
result.old_revno, result.old_revid = \
3575
self.target.last_revision_info()
3576
self._update_revisions(stop_revision, overwrite=overwrite,
3578
# TODO: The old revid should be specified when merging tags,
3579
# so a tags implementation that versions tags can only
3580
# pull in the most recent changes. -- JRV20090506
3581
result.tag_updates, result.tag_conflicts = (
3582
self.source.tags.merge_to(self.target.tags, overwrite,
3583
ignore_master=not merge_tags_to_master))
3584
result.new_revno, result.new_revid = self.target.last_revision_info()
3586
result.master_branch = _hook_master
3587
result.local_branch = result.target_branch
3589
result.master_branch = result.target_branch
3590
result.local_branch = None
3592
for hook in Branch.hooks['post_pull']:
3595
self.source.unlock()
3599
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
