1
# Copyright (C) 2005-2012 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
23
from .lazy_import import lazy_import
24
lazy_import(globals(), """
28
config as _mod_config,
33
revision as _mod_revision,
39
from breezy.bzr import (
43
from breezy.i18n import gettext, ngettext
50
from .decorators import (
53
from .hooks import Hooks
54
from .inter import InterObject
55
from .lock import LogicalLockResult
61
from .trace import mutter, mutter_callsite, note, is_quiet
64
class UnstackableBranchFormat(errors.BzrError):
66
_fmt = ("The branch '%(url)s'(%(format)s) is not a stackable format. "
67
"You will need to upgrade the branch to permit branch stacking.")
69
def __init__(self, format, url):
70
errors.BzrError.__init__(self)
75
class Branch(controldir.ControlComponent):
76
"""Branch holding a history of revisions.
79
Base directory/url of the branch; using control_url and
80
control_transport is more standardized.
81
:ivar hooks: An instance of BranchHooks.
82
:ivar _master_branch_cache: cached result of get_master_branch, see
85
# this is really an instance variable - FIXME move it there
90
def control_transport(self):
91
return self._transport
94
def user_transport(self):
95
return self.controldir.user_transport
97
def __init__(self, possible_transports=None):
98
self.tags = self._format.make_tags(self)
99
self._revision_history_cache = None
100
self._revision_id_to_revno_cache = None
101
self._partial_revision_id_to_revno_cache = {}
102
self._partial_revision_history_cache = []
103
self._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
120
# avoid 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(
145
self.repository._format, 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,
184
possible_transports=possible_transports, _unsupported=_unsupported)
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 breezy.config.BranchConfig for this Branch.
224
This can then be used to get and set configuration options for the
227
:return: A breezy.config.BranchConfig.
229
return _mod_config.BranchConfig(self)
231
def get_config_stack(self):
232
"""Get a breezy.config.BranchStack for this Branch.
234
This can then be used to get and set configuration options for the
237
:return: A breezy.config.BranchStack.
239
return _mod_config.BranchStack(self)
241
def store_uncommitted(self, creator):
242
"""Store uncommitted changes from a ShelfCreator.
244
:param creator: The ShelfCreator containing uncommitted changes, or
245
None to delete any stored changes.
246
:raises: ChangesAlreadyStored if the branch already has changes.
248
raise NotImplementedError(self.store_uncommitted)
250
def get_unshelver(self, tree):
251
"""Return a shelf.Unshelver for this branch and tree.
253
:param tree: The tree to use to construct the Unshelver.
254
:return: an Unshelver or None if no changes are stored.
256
raise NotImplementedError(self.get_unshelver)
258
def _get_fallback_repository(self, url, possible_transports):
259
"""Get the repository we fallback to at url."""
260
url = urlutils.join(self.base, url)
261
a_branch = Branch.open(url, possible_transports=possible_transports)
262
return a_branch.repository
264
def _get_nick(self, local=False, possible_transports=None):
265
config = self.get_config()
266
# explicit overrides master, but don't look for master if local is True
267
if not local and not config.has_explicit_nickname():
269
master = self.get_master_branch(possible_transports)
270
if master and self.user_url == master.user_url:
271
raise errors.RecursiveBind(self.user_url)
272
if master is not None:
273
# return the master branch value
275
except errors.RecursiveBind as e:
277
except errors.BzrError as e:
278
# Silently fall back to local implicit nick if the master is
280
mutter("Could not connect to bound branch, "
281
"falling back to local nick.\n " + str(e))
282
return config.get_nickname()
284
def _set_nick(self, nick):
285
self.get_config().set_user_option('nickname', nick, warn_masked=True)
287
nick = property(_get_nick, _set_nick)
290
raise NotImplementedError(self.is_locked)
292
def _lefthand_history(self, revision_id, last_rev=None,
294
if 'evil' in debug.debug_flags:
295
mutter_callsite(4, "_lefthand_history scales with history.")
296
# stop_revision must be a descendant of last_revision
297
graph = self.repository.get_graph()
298
if last_rev is not None:
299
if not graph.is_ancestor(last_rev, revision_id):
300
# our previous tip is not merged into stop_revision
301
raise errors.DivergedBranches(self, other_branch)
302
# make a new revision history from the graph
303
parents_map = graph.get_parent_map([revision_id])
304
if revision_id not in parents_map:
305
raise errors.NoSuchRevision(self, revision_id)
306
current_rev_id = revision_id
308
check_not_reserved_id = _mod_revision.check_not_reserved_id
309
# Do not include ghosts or graph origin in revision_history
310
while (current_rev_id in parents_map and
311
len(parents_map[current_rev_id]) > 0):
312
check_not_reserved_id(current_rev_id)
313
new_history.append(current_rev_id)
314
current_rev_id = parents_map[current_rev_id][0]
315
parents_map = graph.get_parent_map([current_rev_id])
316
new_history.reverse()
319
def lock_write(self, token=None):
320
"""Lock the branch for write operations.
322
:param token: A token to permit reacquiring a previously held and
324
:return: A BranchWriteLockResult.
326
raise NotImplementedError(self.lock_write)
329
"""Lock the branch for read operations.
331
:return: A breezy.lock.LogicalLockResult.
333
raise NotImplementedError(self.lock_read)
336
raise NotImplementedError(self.unlock)
338
def peek_lock_mode(self):
339
"""Return lock mode for the Branch: 'r', 'w' or None"""
340
raise NotImplementedError(self.peek_lock_mode)
342
def get_physical_lock_status(self):
343
raise NotImplementedError(self.get_physical_lock_status)
345
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
346
"""Return the revision_id for a dotted revno.
348
:param revno: a tuple like (1,) or (1,1,2)
349
:param _cache_reverse: a private parameter enabling storage
350
of the reverse mapping in a top level cache. (This should
351
only be done in selective circumstances as we want to
352
avoid having the mapping cached multiple times.)
353
:return: the revision_id
354
:raises errors.NoSuchRevision: if the revno doesn't exist
356
with self.lock_read():
357
rev_id = self._do_dotted_revno_to_revision_id(revno)
359
self._partial_revision_id_to_revno_cache[rev_id] = revno
362
def _do_dotted_revno_to_revision_id(self, revno):
363
"""Worker function for dotted_revno_to_revision_id.
365
Subclasses should override this if they wish to
366
provide a more efficient implementation.
369
return self.get_rev_id(revno[0])
370
revision_id_to_revno = self.get_revision_id_to_revno_map()
371
revision_ids = [revision_id for revision_id, this_revno
372
in viewitems(revision_id_to_revno)
373
if revno == this_revno]
374
if len(revision_ids) == 1:
375
return revision_ids[0]
377
revno_str = '.'.join(map(str, revno))
378
raise errors.NoSuchRevision(self, revno_str)
380
def revision_id_to_dotted_revno(self, revision_id):
381
"""Given a revision id, return its dotted revno.
383
:return: a tuple like (1,) or (400,1,3).
385
with self.lock_read():
386
return self._do_revision_id_to_dotted_revno(revision_id)
388
def _do_revision_id_to_dotted_revno(self, revision_id):
389
"""Worker function for revision_id_to_revno."""
390
# Try the caches if they are loaded
391
result = self._partial_revision_id_to_revno_cache.get(revision_id)
392
if result is not None:
394
if self._revision_id_to_revno_cache:
395
result = self._revision_id_to_revno_cache.get(revision_id)
397
raise errors.NoSuchRevision(self, revision_id)
398
# Try the mainline as it's optimised
400
revno = self.revision_id_to_revno(revision_id)
402
except errors.NoSuchRevision:
403
# We need to load and use the full revno map after all
404
result = self.get_revision_id_to_revno_map().get(revision_id)
406
raise errors.NoSuchRevision(self, revision_id)
409
def get_revision_id_to_revno_map(self):
410
"""Return the revision_id => dotted revno map.
412
This will be regenerated on demand, but will be cached.
414
:return: A dictionary mapping revision_id => dotted revno.
415
This dictionary should not be modified by the caller.
417
if 'evil' in debug.debug_flags:
418
mutter_callsite(3, "get_revision_id_to_revno_map scales with ancestry.")
419
with self.lock_read():
420
if self._revision_id_to_revno_cache is not None:
421
mapping = self._revision_id_to_revno_cache
423
mapping = self._gen_revno_map()
424
self._cache_revision_id_to_revno(mapping)
425
# TODO: jam 20070417 Since this is being cached, should we be returning
427
# I would rather not, and instead just declare that users should not
428
# modify the return value.
431
def _gen_revno_map(self):
432
"""Create a new mapping from revision ids to dotted revnos.
434
Dotted revnos are generated based on the current tip in the revision
436
This is the worker function for get_revision_id_to_revno_map, which
437
just caches the return value.
439
:return: A dictionary mapping revision_id => dotted revno.
441
revision_id_to_revno = dict((rev_id, revno)
442
for rev_id, depth, revno, end_of_merge
443
in self.iter_merge_sorted_revisions())
444
return revision_id_to_revno
446
def iter_merge_sorted_revisions(self, start_revision_id=None,
447
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
448
"""Walk the revisions for a branch in merge sorted order.
450
Merge sorted order is the output from a merge-aware,
451
topological sort, i.e. all parents come before their
452
children going forward; the opposite for reverse.
454
:param start_revision_id: the revision_id to begin walking from.
455
If None, the branch tip is used.
456
:param stop_revision_id: the revision_id to terminate the walk
457
after. If None, the rest of history is included.
458
:param stop_rule: if stop_revision_id is not None, the precise rule
459
to use for termination:
461
* 'exclude' - leave the stop revision out of the result (default)
462
* 'include' - the stop revision is the last item in the result
463
* 'with-merges' - include the stop revision and all of its
464
merged revisions in the result
465
* 'with-merges-without-common-ancestry' - filter out revisions
466
that are in both ancestries
467
:param direction: either 'reverse' or 'forward':
469
* reverse means return the start_revision_id first, i.e.
470
start at the most recent revision and go backwards in history
471
* forward returns tuples in the opposite order to reverse.
472
Note in particular that forward does *not* do any intelligent
473
ordering w.r.t. depth as some clients of this API may like.
474
(If required, that ought to be done at higher layers.)
476
:return: an iterator over (revision_id, depth, revno, end_of_merge)
479
* revision_id: the unique id of the revision
480
* depth: How many levels of merging deep this node has been
482
* revno_sequence: This field provides a sequence of
483
revision numbers for all revisions. The format is:
484
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
485
branch that the revno is on. From left to right the REVNO numbers
486
are the sequence numbers within that branch of the revision.
487
* end_of_merge: When True the next node (earlier in history) is
488
part of a different merge.
490
with self.lock_read():
491
# Note: depth and revno values are in the context of the branch so
492
# we need the full graph to get stable numbers, regardless of the
494
if self._merge_sorted_revisions_cache is None:
495
last_revision = self.last_revision()
496
known_graph = self.repository.get_known_graph_ancestry(
498
self._merge_sorted_revisions_cache = known_graph.merge_sort(
500
filtered = self._filter_merge_sorted_revisions(
501
self._merge_sorted_revisions_cache, start_revision_id,
502
stop_revision_id, stop_rule)
503
# Make sure we don't return revisions that are not part of the
504
# start_revision_id ancestry.
505
filtered = self._filter_start_non_ancestors(filtered)
506
if direction == 'reverse':
508
if direction == 'forward':
509
return reversed(list(filtered))
511
raise ValueError('invalid direction %r' % direction)
513
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
514
start_revision_id, stop_revision_id, stop_rule):
515
"""Iterate over an inclusive range of sorted revisions."""
516
rev_iter = iter(merge_sorted_revisions)
517
if start_revision_id is not None:
518
for node in rev_iter:
520
if rev_id != start_revision_id:
523
# The decision to include the start or not
524
# depends on the stop_rule if a stop is provided
525
# so pop this node back into the iterator
526
rev_iter = itertools.chain(iter([node]), rev_iter)
528
if stop_revision_id is None:
530
for node in rev_iter:
532
yield (rev_id, node.merge_depth, node.revno,
534
elif stop_rule == 'exclude':
535
for node in rev_iter:
537
if rev_id == stop_revision_id:
539
yield (rev_id, node.merge_depth, node.revno,
541
elif stop_rule == 'include':
542
for node in rev_iter:
544
yield (rev_id, node.merge_depth, node.revno,
546
if rev_id == stop_revision_id:
548
elif stop_rule == 'with-merges-without-common-ancestry':
549
# We want to exclude all revisions that are already part of the
550
# stop_revision_id ancestry.
551
graph = self.repository.get_graph()
552
ancestors = graph.find_unique_ancestors(start_revision_id,
554
for node in rev_iter:
556
if rev_id not in ancestors:
558
yield (rev_id, node.merge_depth, node.revno,
560
elif stop_rule == 'with-merges':
561
stop_rev = self.repository.get_revision(stop_revision_id)
562
if stop_rev.parent_ids:
563
left_parent = stop_rev.parent_ids[0]
565
left_parent = _mod_revision.NULL_REVISION
566
# left_parent is the actual revision we want to stop logging at,
567
# since we want to show the merged revisions after the stop_rev too
568
reached_stop_revision_id = False
569
revision_id_whitelist = []
570
for node in rev_iter:
572
if rev_id == left_parent:
573
# reached the left parent after the stop_revision
575
if (not reached_stop_revision_id or
576
rev_id in revision_id_whitelist):
577
yield (rev_id, node.merge_depth, node.revno,
579
if reached_stop_revision_id or rev_id == stop_revision_id:
580
# only do the merged revs of rev_id from now on
581
rev = self.repository.get_revision(rev_id)
583
reached_stop_revision_id = True
584
revision_id_whitelist.extend(rev.parent_ids)
586
raise ValueError('invalid stop_rule %r' % stop_rule)
588
def _filter_start_non_ancestors(self, rev_iter):
589
# If we started from a dotted revno, we want to consider it as a tip
590
# and don't want to yield revisions that are not part of its
591
# ancestry. Given the order guaranteed by the merge sort, we will see
592
# uninteresting descendants of the first parent of our tip before the
595
first = next(rev_iter)
596
except StopIteration:
598
(rev_id, merge_depth, revno, end_of_merge) = first
601
# We start at a mainline revision so by definition, all others
602
# revisions in rev_iter are ancestors
603
for node in rev_iter:
608
pmap = self.repository.get_parent_map([rev_id])
609
parents = pmap.get(rev_id, [])
611
whitelist.update(parents)
613
# If there is no parents, there is nothing of interest left
615
# FIXME: It's hard to test this scenario here as this code is never
616
# called in that case. -- vila 20100322
619
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
621
if rev_id in whitelist:
622
pmap = self.repository.get_parent_map([rev_id])
623
parents = pmap.get(rev_id, [])
624
whitelist.remove(rev_id)
625
whitelist.update(parents)
627
# We've reached the mainline, there is nothing left to
631
# A revision that is not part of the ancestry of our
634
yield (rev_id, merge_depth, revno, end_of_merge)
636
def leave_lock_in_place(self):
637
"""Tell this branch object not to release the physical lock when this
640
If lock_write doesn't return a token, then this method is not supported.
642
self.control_files.leave_in_place()
644
def dont_leave_lock_in_place(self):
645
"""Tell this branch object to release the physical lock when this
646
object is unlocked, even if it didn't originally acquire it.
648
If lock_write doesn't return a token, then this method is not supported.
650
self.control_files.dont_leave_in_place()
652
def bind(self, other):
653
"""Bind the local branch the other branch.
655
:param other: The branch to bind to
658
raise errors.UpgradeRequired(self.user_url)
660
def get_append_revisions_only(self):
661
"""Whether it is only possible to append revisions to the history.
663
if not self._format.supports_set_append_revisions_only():
665
return self.get_config_stack().get('append_revisions_only')
667
def set_append_revisions_only(self, enabled):
668
if not self._format.supports_set_append_revisions_only():
669
raise errors.UpgradeRequired(self.user_url)
670
self.get_config_stack().set('append_revisions_only', enabled)
672
def set_reference_info(self, tree_path, branch_location, file_id=None):
673
"""Set the branch location to use for a tree reference."""
674
raise errors.UnsupportedOperation(self.set_reference_info, self)
676
def get_reference_info(self, path):
677
"""Get the tree_path and branch_location for a tree reference."""
678
raise errors.UnsupportedOperation(self.get_reference_info, self)
680
def fetch(self, from_branch, last_revision=None, limit=None):
681
"""Copy revisions from from_branch into this branch.
683
:param from_branch: Where to copy from.
684
:param last_revision: What revision to stop at (None for at the end
686
:param limit: Optional rough limit of revisions to fetch
689
with self.lock_write():
690
return InterBranch.get(from_branch, self).fetch(
691
last_revision, limit=limit)
693
def get_bound_location(self):
694
"""Return the URL of the branch we are bound to.
696
Older format branches cannot bind, please be sure to use a metadir
701
def get_old_bound_location(self):
702
"""Return the URL of the branch we used to be bound to
704
raise errors.UpgradeRequired(self.user_url)
706
def get_commit_builder(self, parents, config_stack=None, timestamp=None,
707
timezone=None, committer=None, revprops=None,
708
revision_id=None, lossy=False):
709
"""Obtain a CommitBuilder for this branch.
711
:param parents: Revision ids of the parents of the new revision.
712
:param config: Optional configuration to use.
713
:param timestamp: Optional timestamp recorded for commit.
714
:param timezone: Optional timezone for timestamp.
715
:param committer: Optional committer to set for commit.
716
:param revprops: Optional dictionary of revision properties.
717
:param revision_id: Optional revision id.
718
:param lossy: Whether to discard data that can not be natively
719
represented, when pushing to a foreign VCS
722
if config_stack is None:
723
config_stack = self.get_config_stack()
725
return self.repository.get_commit_builder(self, parents, config_stack,
726
timestamp, timezone, committer, revprops, revision_id,
729
def get_master_branch(self, possible_transports=None):
730
"""Return the branch we are bound to.
732
:return: Either a Branch, or None
736
def get_stacked_on_url(self):
737
"""Get the URL this branch is stacked against.
739
:raises NotStacked: If the branch is not stacked.
740
:raises UnstackableBranchFormat: If the branch does not support
743
raise NotImplementedError(self.get_stacked_on_url)
745
def set_last_revision_info(self, revno, revision_id):
746
"""Set the last revision of this branch.
748
The caller is responsible for checking that the revno is correct
749
for this revision id.
751
It may be possible to set the branch last revision to an id not
752
present in the repository. However, branches can also be
753
configured to check constraints on history, in which case this may not
756
raise NotImplementedError(self.set_last_revision_info)
758
def generate_revision_history(self, revision_id, last_rev=None,
760
"""See Branch.generate_revision_history"""
761
with self.lock_write():
762
graph = self.repository.get_graph()
763
(last_revno, last_revid) = self.last_revision_info()
764
known_revision_ids = [
765
(last_revid, last_revno),
766
(_mod_revision.NULL_REVISION, 0),
768
if last_rev is not None:
769
if not graph.is_ancestor(last_rev, revision_id):
770
# our previous tip is not merged into stop_revision
771
raise errors.DivergedBranches(self, other_branch)
772
revno = graph.find_distance_to_null(revision_id, known_revision_ids)
773
self.set_last_revision_info(revno, revision_id)
775
def set_parent(self, url):
776
"""See Branch.set_parent."""
777
# TODO: Maybe delete old location files?
778
# URLs should never be unicode, even on the local fs,
779
# FIXUP this and get_parent in a future branch format bump:
780
# read and rewrite the file. RBC 20060125
782
# TODO(jelmer): Clean this up for pad.lv/1696545
783
if isinstance(url, text_type) and sys.version_info[0] == 2:
785
url = url.encode('ascii')
786
except UnicodeEncodeError:
787
raise urlutils.InvalidURL(url,
788
"Urls must be 7-bit ascii, "
789
"use breezy.urlutils.escape")
790
url = urlutils.relative_url(self.base, url)
791
with self.lock_write():
792
self._set_parent_location(url)
794
def set_stacked_on_url(self, url):
795
"""Set the URL this branch is stacked against.
797
:raises UnstackableBranchFormat: If the branch does not support
799
:raises UnstackableRepositoryFormat: If the repository does not support
802
if not self._format.supports_stacking():
803
raise UnstackableBranchFormat(self._format, self.user_url)
804
with self.lock_write():
805
# XXX: Changing from one fallback repository to another does not check
806
# that all the data you need is present in the new fallback.
807
# Possibly it should.
808
self._check_stackable_repo()
811
old_url = self.get_stacked_on_url()
812
except (errors.NotStacked, UnstackableBranchFormat,
813
errors.UnstackableRepositoryFormat):
817
self._activate_fallback_location(url,
818
possible_transports=[self.controldir.root_transport])
819
# write this out after the repository is stacked to avoid setting a
820
# stacked config that doesn't work.
821
self._set_config_location('stacked_on_location', url)
824
"""Change a branch to be unstacked, copying data as needed.
826
Don't call this directly, use set_stacked_on_url(None).
828
with ui.ui_factory.nested_progress_bar() as pb:
829
pb.update(gettext("Unstacking"))
830
# The basic approach here is to fetch the tip of the branch,
831
# including all available ghosts, from the existing stacked
832
# repository into a new repository object without the fallbacks.
834
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
835
# correct for CHKMap repostiories
836
old_repository = self.repository
837
if len(old_repository._fallback_repositories) != 1:
838
raise AssertionError("can't cope with fallback repositories "
839
"of %r (fallbacks: %r)" % (old_repository,
840
old_repository._fallback_repositories))
841
# Open the new repository object.
842
# Repositories don't offer an interface to remove fallback
843
# repositories today; take the conceptually simpler option and just
844
# reopen it. We reopen it starting from the URL so that we
845
# get a separate connection for RemoteRepositories and can
846
# stream from one of them to the other. This does mean doing
847
# separate SSH connection setup, but unstacking is not a
848
# common operation so it's tolerable.
849
new_bzrdir = controldir.ControlDir.open(
850
self.controldir.root_transport.base)
851
new_repository = new_bzrdir.find_repository()
852
if new_repository._fallback_repositories:
853
raise AssertionError("didn't expect %r to have "
854
"fallback_repositories"
855
% (self.repository,))
856
# Replace self.repository with the new repository.
857
# Do our best to transfer the lock state (i.e. lock-tokens and
858
# lock count) of self.repository to the new repository.
859
lock_token = old_repository.lock_write().repository_token
860
self.repository = new_repository
861
if isinstance(self, remote.RemoteBranch):
862
# Remote branches can have a second reference to the old
863
# repository that need to be replaced.
864
if self._real_branch is not None:
865
self._real_branch.repository = new_repository
866
self.repository.lock_write(token=lock_token)
867
if lock_token is not None:
868
old_repository.leave_lock_in_place()
869
old_repository.unlock()
870
if lock_token is not None:
871
# XXX: self.repository.leave_lock_in_place() before this
872
# function will not be preserved. Fortunately that doesn't
873
# affect the current default format (2a), and would be a
874
# corner-case anyway.
875
# - Andrew Bennetts, 2010/06/30
876
self.repository.dont_leave_lock_in_place()
880
old_repository.unlock()
881
except errors.LockNotHeld:
884
if old_lock_count == 0:
885
raise AssertionError(
886
'old_repository should have been locked at least once.')
887
for i in range(old_lock_count-1):
888
self.repository.lock_write()
889
# Fetch from the old repository into the new.
890
with old_repository.lock_read():
891
# XXX: If you unstack a branch while it has a working tree
892
# with a pending merge, the pending-merged revisions will no
893
# longer be present. You can (probably) revert and remerge.
895
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
896
except errors.TagsNotSupported:
897
tags_to_fetch = set()
898
fetch_spec = vf_search.NotInOtherForRevs(self.repository,
899
old_repository, required_ids=[self.last_revision()],
900
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
901
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
903
def _cache_revision_history(self, rev_history):
904
"""Set the cached revision history to rev_history.
906
The revision_history method will use this cache to avoid regenerating
907
the revision history.
909
This API is semi-public; it only for use by subclasses, all other code
910
should consider it to be private.
912
self._revision_history_cache = rev_history
914
def _cache_revision_id_to_revno(self, revision_id_to_revno):
915
"""Set the cached revision_id => revno map to revision_id_to_revno.
917
This API is semi-public; it only for use by subclasses, all other code
918
should consider it to be private.
920
self._revision_id_to_revno_cache = revision_id_to_revno
922
def _clear_cached_state(self):
923
"""Clear any cached data on this branch, e.g. cached revision history.
925
This means the next call to revision_history will need to call
926
_gen_revision_history.
928
This API is semi-public; it is only for use by subclasses, all other
929
code should consider it to be private.
931
self._revision_history_cache = None
932
self._revision_id_to_revno_cache = None
933
self._last_revision_info_cache = None
934
self._master_branch_cache = None
935
self._merge_sorted_revisions_cache = None
936
self._partial_revision_history_cache = []
937
self._partial_revision_id_to_revno_cache = {}
939
def _gen_revision_history(self):
940
"""Return sequence of revision hashes on to this branch.
942
Unlike revision_history, this method always regenerates or rereads the
943
revision history, i.e. it does not cache the result, so repeated calls
946
Concrete subclasses should override this instead of revision_history so
947
that subclasses do not need to deal with caching logic.
949
This API is semi-public; it only for use by subclasses, all other code
950
should consider it to be private.
952
raise NotImplementedError(self._gen_revision_history)
954
def _revision_history(self):
955
if 'evil' in debug.debug_flags:
956
mutter_callsite(3, "revision_history scales with history.")
957
if self._revision_history_cache is not None:
958
history = self._revision_history_cache
960
history = self._gen_revision_history()
961
self._cache_revision_history(history)
965
"""Return current revision number for this branch.
967
That is equivalent to the number of revisions committed to
970
return self.last_revision_info()[0]
973
"""Older format branches cannot bind or unbind."""
974
raise errors.UpgradeRequired(self.user_url)
976
def last_revision(self):
977
"""Return last revision id, or NULL_REVISION."""
978
return self.last_revision_info()[1]
980
def last_revision_info(self):
981
"""Return information about the last revision.
983
:return: A tuple (revno, revision_id).
985
with self.lock_read():
986
if self._last_revision_info_cache is None:
987
self._last_revision_info_cache = self._read_last_revision_info()
988
return self._last_revision_info_cache
990
def _read_last_revision_info(self):
991
raise NotImplementedError(self._read_last_revision_info)
993
def import_last_revision_info_and_tags(self, source, revno, revid,
995
"""Set the last revision info, importing from another repo if necessary.
997
This is used by the bound branch code to upload a revision to
998
the master branch first before updating the tip of the local branch.
999
Revisions referenced by source's tags are also transferred.
1001
:param source: Source branch to optionally fetch from
1002
:param revno: Revision number of the new tip
1003
:param revid: Revision id of the new tip
1004
:param lossy: Whether to discard metadata that can not be
1005
natively represented
1006
:return: Tuple with the new revision number and revision id
1007
(should only be different from the arguments when lossy=True)
1009
if not self.repository.has_same_location(source.repository):
1010
self.fetch(source, revid)
1011
self.set_last_revision_info(revno, revid)
1012
return (revno, revid)
1014
def revision_id_to_revno(self, revision_id):
1015
"""Given a revision id, return its revno"""
1016
if _mod_revision.is_null(revision_id):
1018
history = self._revision_history()
1020
return history.index(revision_id) + 1
1022
raise errors.NoSuchRevision(self, revision_id)
1024
def get_rev_id(self, revno, history=None):
1025
"""Find the revision id of the specified revno."""
1026
with self.lock_read():
1028
return _mod_revision.NULL_REVISION
1029
last_revno, last_revid = self.last_revision_info()
1030
if revno == last_revno:
1032
if revno <= 0 or revno > last_revno:
1033
raise errors.NoSuchRevision(self, revno)
1034
distance_from_last = last_revno - revno
1035
if len(self._partial_revision_history_cache) <= distance_from_last:
1036
self._extend_partial_history(distance_from_last)
1037
return self._partial_revision_history_cache[distance_from_last]
1039
def pull(self, source, overwrite=False, stop_revision=None,
1040
possible_transports=None, *args, **kwargs):
1041
"""Mirror source into this branch.
1043
This branch is considered to be 'local', having low latency.
1045
:returns: PullResult instance
1047
return InterBranch.get(source, self).pull(overwrite=overwrite,
1048
stop_revision=stop_revision,
1049
possible_transports=possible_transports, *args, **kwargs)
1051
def push(self, target, overwrite=False, stop_revision=None, lossy=False,
1053
"""Mirror this branch into target.
1055
This branch is considered to be 'local', having low latency.
1057
return InterBranch.get(self, target).push(overwrite, stop_revision,
1058
lossy, *args, **kwargs)
1060
def basis_tree(self):
1061
"""Return `Tree` object for last revision."""
1062
return self.repository.revision_tree(self.last_revision())
1064
def get_parent(self):
1065
"""Return the parent location of the branch.
1067
This is the default location for pull/missing. The usual
1068
pattern is that the user can override it by specifying a
1071
parent = self._get_parent_location()
1074
# This is an old-format absolute path to a local branch
1075
# turn it into a url
1076
if parent.startswith('/'):
1077
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1079
return urlutils.join(self.base[:-1], parent)
1080
except urlutils.InvalidURLJoin as e:
1081
raise errors.InaccessibleParent(parent, self.user_url)
1083
def _get_parent_location(self):
1084
raise NotImplementedError(self._get_parent_location)
1086
def _set_config_location(self, name, url, config=None,
1087
make_relative=False):
1089
config = self.get_config_stack()
1093
url = urlutils.relative_url(self.base, url)
1094
config.set(name, url)
1096
def _get_config_location(self, name, config=None):
1098
config = self.get_config_stack()
1099
location = config.get(name)
1104
def get_child_submit_format(self):
1105
"""Return the preferred format of submissions to this branch."""
1106
return self.get_config_stack().get('child_submit_format')
1108
def get_submit_branch(self):
1109
"""Return the submit location of the branch.
1111
This is the default location for bundle. The usual
1112
pattern is that the user can override it by specifying a
1115
return self.get_config_stack().get('submit_branch')
1117
def set_submit_branch(self, location):
1118
"""Return the submit location of the branch.
1120
This is the default location for bundle. The usual
1121
pattern is that the user can override it by specifying a
1124
self.get_config_stack().set('submit_branch', location)
1126
def get_public_branch(self):
1127
"""Return the public location of the branch.
1129
This is used by merge directives.
1131
return self._get_config_location('public_branch')
1133
def set_public_branch(self, location):
1134
"""Return the submit location of the branch.
1136
This is the default location for bundle. The usual
1137
pattern is that the user can override it by specifying a
1140
self._set_config_location('public_branch', location)
1142
def get_push_location(self):
1143
"""Return None or the location to push this branch to."""
1144
return self.get_config_stack().get('push_location')
1146
def set_push_location(self, location):
1147
"""Set a new push location for this branch."""
1148
raise NotImplementedError(self.set_push_location)
1150
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1151
"""Run the post_change_branch_tip hooks."""
1152
hooks = Branch.hooks['post_change_branch_tip']
1155
new_revno, new_revid = self.last_revision_info()
1156
params = ChangeBranchTipParams(
1157
self, old_revno, new_revno, old_revid, new_revid)
1161
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1162
"""Run the pre_change_branch_tip hooks."""
1163
hooks = Branch.hooks['pre_change_branch_tip']
1166
old_revno, old_revid = self.last_revision_info()
1167
params = ChangeBranchTipParams(
1168
self, old_revno, new_revno, old_revid, new_revid)
1173
"""Synchronise this branch with the master branch if any.
1175
:return: None or the last_revision pivoted out during the update.
1179
def check_revno(self, revno):
1181
Check whether a revno corresponds to any revision.
1182
Zero (the NULL revision) is considered valid.
1185
self.check_real_revno(revno)
1187
def check_real_revno(self, revno):
1189
Check whether a revno corresponds to a real revision.
1190
Zero (the NULL revision) is considered invalid
1192
if revno < 1 or revno > self.revno():
1193
raise errors.InvalidRevisionNumber(revno)
1195
def clone(self, to_controldir, revision_id=None, repository_policy=None):
1196
"""Clone this branch into to_controldir preserving all semantic values.
1198
Most API users will want 'create_clone_on_transport', which creates a
1199
new bzrdir and branch on the fly.
1201
revision_id: if not None, the revision history in the new branch will
1202
be truncated to end with revision_id.
1204
result = to_controldir.create_branch()
1205
with self.lock_read(), result.lock_write():
1206
if repository_policy is not None:
1207
repository_policy.configure_branch(result)
1208
self.copy_content_into(result, revision_id=revision_id)
1211
def sprout(self, to_controldir, revision_id=None, repository_policy=None,
1212
repository=None, lossy=False):
1213
"""Create a new line of development from the branch, into to_controldir.
1215
to_controldir controls the branch format.
1217
revision_id: if not None, the revision history in the new branch will
1218
be truncated to end with revision_id.
1220
if (repository_policy is not None and
1221
repository_policy.requires_stacking()):
1222
to_controldir._format.require_stacking(_skip_repo=True)
1223
result = to_controldir.create_branch(repository=repository)
1225
raise errors.LossyPushToSameVCS(self, result)
1226
with self.lock_read(), result.lock_write():
1227
if repository_policy is not None:
1228
repository_policy.configure_branch(result)
1229
self.copy_content_into(result, revision_id=revision_id)
1230
master_url = self.get_bound_location()
1231
if master_url is None:
1232
result.set_parent(self.user_url)
1234
result.set_parent(master_url)
1237
def _synchronize_history(self, destination, revision_id):
1238
"""Synchronize last revision and revision history between branches.
1240
This version is most efficient when the destination is also a
1241
BzrBranch6, but works for BzrBranch5, as long as the destination's
1242
repository contains all the lefthand ancestors of the intended
1243
last_revision. If not, set_last_revision_info will fail.
1245
:param destination: The branch to copy the history into
1246
:param revision_id: The revision-id to truncate history at. May
1247
be None to copy complete history.
1249
source_revno, source_revision_id = self.last_revision_info()
1250
if revision_id is None:
1251
revno, revision_id = source_revno, source_revision_id
1253
graph = self.repository.get_graph()
1255
revno = graph.find_distance_to_null(revision_id,
1256
[(source_revision_id, source_revno)])
1257
except errors.GhostRevisionsHaveNoRevno:
1258
# Default to 1, if we can't find anything else
1260
destination.set_last_revision_info(revno, revision_id)
1262
def copy_content_into(self, destination, revision_id=None):
1263
"""Copy the content of self into destination.
1265
revision_id: if not None, the revision history in the new branch will
1266
be truncated to end with revision_id.
1268
return InterBranch.get(self, destination).copy_content_into(
1269
revision_id=revision_id)
1271
def update_references(self, target):
1272
if not getattr(self._format, 'supports_reference_locations', False):
1274
reference_dict = self._get_all_reference_info()
1275
if len(reference_dict) == 0:
1277
old_base = self.base
1278
new_base = target.base
1279
target_reference_dict = target._get_all_reference_info()
1280
for tree_path, (branch_location, file_id) in viewitems(reference_dict):
1281
branch_location = urlutils.rebase_url(branch_location,
1283
target_reference_dict.setdefault(
1284
tree_path, (branch_location, file_id))
1285
target._set_all_reference_info(target_reference_dict)
1287
def check(self, refs):
1288
"""Check consistency of the branch.
1290
In particular this checks that revisions given in the revision-history
1291
do actually match up in the revision graph, and that they're all
1292
present in the repository.
1294
Callers will typically also want to check the repository.
1296
:param refs: Calculated refs for this branch as specified by
1297
branch._get_check_refs()
1298
:return: A BranchCheckResult.
1300
with self.lock_read():
1301
result = BranchCheckResult(self)
1302
last_revno, last_revision_id = self.last_revision_info()
1303
actual_revno = refs[('lefthand-distance', last_revision_id)]
1304
if actual_revno != last_revno:
1305
result.errors.append(errors.BzrCheckError(
1306
'revno does not match len(mainline) %s != %s' % (
1307
last_revno, actual_revno)))
1308
# TODO: We should probably also check that self.revision_history
1309
# matches the repository for older branch formats.
1310
# If looking for the code that cross-checks repository parents against
1311
# the Graph.iter_lefthand_ancestry output, that is now a repository
1315
def _get_checkout_format(self, lightweight=False):
1316
"""Return the most suitable metadir for a checkout of this branch.
1317
Weaves are used if this branch's repository uses weaves.
1319
format = self.repository.controldir.checkout_metadir()
1320
format.set_branch_format(self._format)
1323
def create_clone_on_transport(self, to_transport, revision_id=None,
1324
stacked_on=None, create_prefix=False, use_existing_dir=False,
1326
"""Create a clone of this branch and its bzrdir.
1328
:param to_transport: The transport to clone onto.
1329
:param revision_id: The revision id to use as tip in the new branch.
1330
If None the tip is obtained from this branch.
1331
:param stacked_on: An optional URL to stack the clone on.
1332
:param create_prefix: Create any missing directories leading up to
1334
:param use_existing_dir: Use an existing directory if one exists.
1336
# XXX: Fix the bzrdir API to allow getting the branch back from the
1337
# clone call. Or something. 20090224 RBC/spiv.
1338
# XXX: Should this perhaps clone colocated branches as well,
1339
# rather than just the default branch? 20100319 JRV
1340
if revision_id is None:
1341
revision_id = self.last_revision()
1342
dir_to = self.controldir.clone_on_transport(to_transport,
1343
revision_id=revision_id, stacked_on=stacked_on,
1344
create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1346
return dir_to.open_branch()
1348
def create_checkout(self, to_location, revision_id=None,
1349
lightweight=False, accelerator_tree=None,
1351
"""Create a checkout of a branch.
1353
:param to_location: The url to produce the checkout at
1354
:param revision_id: The revision to check out
1355
:param lightweight: If True, produce a lightweight checkout, otherwise,
1356
produce a bound branch (heavyweight checkout)
1357
:param accelerator_tree: A tree which can be used for retrieving file
1358
contents more quickly than the revision tree, i.e. a workingtree.
1359
The revision tree will be used for cases where accelerator_tree's
1360
content is different.
1361
:param hardlink: If true, hard-link files from accelerator_tree,
1363
:return: The tree of the created checkout
1365
t = transport.get_transport(to_location)
1367
format = self._get_checkout_format(lightweight=lightweight)
1369
checkout = format.initialize_on_transport(t)
1370
except errors.AlreadyControlDirError:
1371
# It's fine if the control directory already exists,
1372
# as long as there is no existing branch and working tree.
1373
checkout = controldir.ControlDir.open_from_transport(t)
1375
checkout.open_branch()
1376
except errors.NotBranchError:
1379
raise errors.AlreadyControlDirError(t.base)
1380
if checkout.control_transport.base == self.controldir.control_transport.base:
1381
# When checking out to the same control directory,
1382
# always create a lightweight checkout
1386
from_branch = checkout.set_branch_reference(target_branch=self)
1388
policy = checkout.determine_repository_policy()
1389
repo = policy.acquire_repository()[0]
1390
checkout_branch = checkout.create_branch()
1391
checkout_branch.bind(self)
1392
# pull up to the specified revision_id to set the initial
1393
# branch tip correctly, and seed it with history.
1394
checkout_branch.pull(self, stop_revision=revision_id)
1396
tree = checkout.create_workingtree(revision_id,
1397
from_branch=from_branch,
1398
accelerator_tree=accelerator_tree,
1400
basis_tree = tree.basis_tree()
1401
with basis_tree.lock_read():
1402
for path, file_id in basis_tree.iter_references():
1403
reference_parent = self.reference_parent(path, file_id)
1404
reference_parent.create_checkout(tree.abspath(path),
1405
basis_tree.get_reference_revision(path, file_id),
1409
def reconcile(self, thorough=True):
1410
"""Make sure the data stored in this branch is consistent."""
1411
from breezy.reconcile import BranchReconciler
1412
with self.lock_write():
1413
reconciler = BranchReconciler(self, thorough=thorough)
1414
reconciler.reconcile()
1417
def reference_parent(self, path, file_id=None, possible_transports=None):
1418
"""Return the parent branch for a tree-reference file_id
1420
:param path: The path of the file_id in the tree
1421
:param file_id: Optional file_id of the tree reference
1422
:return: A branch associated with the file_id
1424
# FIXME should provide multiple branches, based on config
1425
return Branch.open(self.controldir.root_transport.clone(path).base,
1426
possible_transports=possible_transports)
1428
def supports_tags(self):
1429
return self._format.supports_tags()
1431
def automatic_tag_name(self, revision_id):
1432
"""Try to automatically find the tag name for a revision.
1434
:param revision_id: Revision id of the revision.
1435
:return: A tag name or None if no tag name could be determined.
1437
for hook in Branch.hooks['automatic_tag_name']:
1438
ret = hook(self, revision_id)
1443
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1445
"""Ensure that revision_b is a descendant of revision_a.
1447
This is a helper function for update_revisions.
1449
:raises: DivergedBranches if revision_b has diverged from revision_a.
1450
:returns: True if revision_b is a descendant of revision_a.
1452
relation = self._revision_relations(revision_a, revision_b, graph)
1453
if relation == 'b_descends_from_a':
1455
elif relation == 'diverged':
1456
raise errors.DivergedBranches(self, other_branch)
1457
elif relation == 'a_descends_from_b':
1460
raise AssertionError("invalid relation: %r" % (relation,))
1462
def _revision_relations(self, revision_a, revision_b, graph):
1463
"""Determine the relationship between two revisions.
1465
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1467
heads = graph.heads([revision_a, revision_b])
1468
if heads == {revision_b}:
1469
return 'b_descends_from_a'
1470
elif heads == {revision_a, revision_b}:
1471
# These branches have diverged
1473
elif heads == {revision_a}:
1474
return 'a_descends_from_b'
1476
raise AssertionError("invalid heads: %r" % (heads,))
1478
def heads_to_fetch(self):
1479
"""Return the heads that must and that should be fetched to copy this
1480
branch into another repo.
1482
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1483
set of heads that must be fetched. if_present_fetch is a set of
1484
heads that must be fetched if present, but no error is necessary if
1485
they are not present.
1487
# For bzr native formats must_fetch is just the tip, and
1488
# if_present_fetch are the tags.
1489
must_fetch = {self.last_revision()}
1490
if_present_fetch = set()
1491
if self.get_config_stack().get('branch.fetch_tags'):
1493
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1494
except errors.TagsNotSupported:
1496
must_fetch.discard(_mod_revision.NULL_REVISION)
1497
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1498
return must_fetch, if_present_fetch
1500
def create_memorytree(self):
1501
"""Create a memory tree for this branch.
1503
:return: An in-memory MutableTree instance
1505
return memorytree.MemoryTree.create_on_branch(self)
1508
class BranchFormat(controldir.ControlComponentFormat):
1509
"""An encapsulation of the initialization and open routines for a format.
1511
Formats provide three things:
1512
* An initialization routine,
1513
* a format description
1516
Formats are placed in an dict by their format string for reference
1517
during branch opening. It's not required that these be instances, they
1518
can be classes themselves with class methods - it simply depends on
1519
whether state is needed for a given format or not.
1521
Once a format is deprecated, just deprecate the initialize and open
1522
methods on the format class. Do not deprecate the object, as the
1523
object will be created every time regardless.
1526
def __eq__(self, other):
1527
return self.__class__ is other.__class__
1529
def __ne__(self, other):
1530
return not (self == other)
1532
def get_reference(self, controldir, name=None):
1533
"""Get the target reference of the branch in controldir.
1535
format probing must have been completed before calling
1536
this method - it is assumed that the format of the branch
1537
in controldir is correct.
1539
:param controldir: The controldir to get the branch data from.
1540
:param name: Name of the colocated branch to fetch
1541
:return: None if the branch is not a reference branch.
1546
def set_reference(self, controldir, name, to_branch):
1547
"""Set the target reference of the branch in controldir.
1549
format probing must have been completed before calling
1550
this method - it is assumed that the format of the branch
1551
in controldir is correct.
1553
:param controldir: The controldir to set the branch reference for.
1554
:param name: Name of colocated branch to set, None for default
1555
:param to_branch: branch that the checkout is to reference
1557
raise NotImplementedError(self.set_reference)
1559
def get_format_description(self):
1560
"""Return the short format description for this format."""
1561
raise NotImplementedError(self.get_format_description)
1563
def _run_post_branch_init_hooks(self, controldir, name, branch):
1564
hooks = Branch.hooks['post_branch_init']
1567
params = BranchInitHookParams(self, controldir, name, branch)
1571
def initialize(self, controldir, name=None, repository=None,
1572
append_revisions_only=None):
1573
"""Create a branch of this format in controldir.
1575
:param name: Name of the colocated branch to create.
1577
raise NotImplementedError(self.initialize)
1579
def is_supported(self):
1580
"""Is this format supported?
1582
Supported formats can be initialized and opened.
1583
Unsupported formats may not support initialization or committing or
1584
some other features depending on the reason for not being supported.
1588
def make_tags(self, branch):
1589
"""Create a tags object for branch.
1591
This method is on BranchFormat, because BranchFormats are reflected
1592
over the wire via network_name(), whereas full Branch instances require
1593
multiple VFS method calls to operate at all.
1595
The default implementation returns a disabled-tags instance.
1597
Note that it is normal for branch to be a RemoteBranch when using tags
1600
return _mod_tag.DisabledTags(branch)
1602
def network_name(self):
1603
"""A simple byte string uniquely identifying this format for RPC calls.
1605
MetaDir branch formats use their disk format string to identify the
1606
repository over the wire. All in one formats such as bzr < 0.8, and
1607
foreign formats like svn/git and hg should use some marker which is
1608
unique and immutable.
1610
raise NotImplementedError(self.network_name)
1612
def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
1613
found_repository=None, possible_transports=None):
1614
"""Return the branch object for controldir.
1616
:param controldir: A ControlDir that contains a branch.
1617
:param name: Name of colocated branch to open
1618
:param _found: a private parameter, do not use it. It is used to
1619
indicate if format probing has already be done.
1620
:param ignore_fallbacks: when set, no fallback branches will be opened
1621
(if there are any). Default is to open fallbacks.
1623
raise NotImplementedError(self.open)
1625
def supports_set_append_revisions_only(self):
1626
"""True if this format supports set_append_revisions_only."""
1629
def supports_stacking(self):
1630
"""True if this format records a stacked-on branch."""
1633
def supports_leaving_lock(self):
1634
"""True if this format supports leaving locks in place."""
1635
return False # by default
1638
return self.get_format_description().rstrip()
1640
def supports_tags(self):
1641
"""True if this format supports tags stored in the branch"""
1642
return False # by default
1644
def tags_are_versioned(self):
1645
"""Whether the tag container for this branch versions tags."""
1648
def supports_tags_referencing_ghosts(self):
1649
"""True if tags can reference ghost revisions."""
1652
def supports_store_uncommitted(self):
1653
"""True if uncommitted changes can be stored in this branch."""
1657
class BranchHooks(Hooks):
1658
"""A dictionary mapping hook name to a list of callables for branch hooks.
1660
e.g. ['post_push'] Is the list of items to be called when the
1661
push function is invoked.
1665
"""Create the default hooks.
1667
These are all empty initially, because by default nothing should get
1670
Hooks.__init__(self, "breezy.branch", "Branch.hooks")
1671
self.add_hook('open',
1672
"Called with the Branch object that has been opened after a "
1673
"branch is opened.", (1, 8))
1674
self.add_hook('post_push',
1675
"Called after a push operation completes. post_push is called "
1676
"with a breezy.branch.BranchPushResult object and only runs in the "
1677
"bzr client.", (0, 15))
1678
self.add_hook('post_pull',
1679
"Called after a pull operation completes. post_pull is called "
1680
"with a breezy.branch.PullResult object and only runs in the "
1681
"bzr client.", (0, 15))
1682
self.add_hook('pre_commit',
1683
"Called after a commit is calculated but before it is "
1684
"completed. pre_commit is called with (local, master, old_revno, "
1685
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1686
"). old_revid is NULL_REVISION for the first commit to a branch, "
1687
"tree_delta is a TreeDelta object describing changes from the "
1688
"basis revision. hooks MUST NOT modify this delta. "
1689
" future_tree is an in-memory tree obtained from "
1690
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1692
self.add_hook('post_commit',
1693
"Called in the bzr client after a commit has completed. "
1694
"post_commit is called with (local, master, old_revno, old_revid, "
1695
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1696
"commit to a branch.", (0, 15))
1697
self.add_hook('post_uncommit',
1698
"Called in the bzr client after an uncommit completes. "
1699
"post_uncommit is called with (local, master, old_revno, "
1700
"old_revid, new_revno, new_revid) where local is the local branch "
1701
"or None, master is the target branch, and an empty branch "
1702
"receives new_revno of 0, new_revid of None.", (0, 15))
1703
self.add_hook('pre_change_branch_tip',
1704
"Called in bzr client and server before a change to the tip of a "
1705
"branch is made. pre_change_branch_tip is called with a "
1706
"breezy.branch.ChangeBranchTipParams. Note that push, pull, "
1707
"commit, uncommit will all trigger this hook.", (1, 6))
1708
self.add_hook('post_change_branch_tip',
1709
"Called in bzr client and server after a change to the tip of a "
1710
"branch is made. post_change_branch_tip is called with a "
1711
"breezy.branch.ChangeBranchTipParams. Note that push, pull, "
1712
"commit, uncommit will all trigger this hook.", (1, 4))
1713
self.add_hook('transform_fallback_location',
1714
"Called when a stacked branch is activating its fallback "
1715
"locations. transform_fallback_location is called with (branch, "
1716
"url), and should return a new url. Returning the same url "
1717
"allows it to be used as-is, returning a different one can be "
1718
"used to cause the branch to stack on a closer copy of that "
1719
"fallback_location. Note that the branch cannot have history "
1720
"accessing methods called on it during this hook because the "
1721
"fallback locations have not been activated. When there are "
1722
"multiple hooks installed for transform_fallback_location, "
1723
"all are called with the url returned from the previous hook."
1724
"The order is however undefined.", (1, 9))
1725
self.add_hook('automatic_tag_name',
1726
"Called to determine an automatic tag name for a revision. "
1727
"automatic_tag_name is called with (branch, revision_id) and "
1728
"should return a tag name or None if no tag name could be "
1729
"determined. The first non-None tag name returned will be used.",
1731
self.add_hook('post_branch_init',
1732
"Called after new branch initialization completes. "
1733
"post_branch_init is called with a "
1734
"breezy.branch.BranchInitHookParams. "
1735
"Note that init, branch and checkout (both heavyweight and "
1736
"lightweight) will all trigger this hook.", (2, 2))
1737
self.add_hook('post_switch',
1738
"Called after a checkout switches branch. "
1739
"post_switch is called with a "
1740
"breezy.branch.SwitchHookParams.", (2, 2))
1744
# install the default hooks into the Branch class.
1745
Branch.hooks = BranchHooks()
1748
class ChangeBranchTipParams(object):
1749
"""Object holding parameters passed to `*_change_branch_tip` hooks.
1751
There are 5 fields that hooks may wish to access:
1753
:ivar branch: the branch being changed
1754
:ivar old_revno: revision number before the change
1755
:ivar new_revno: revision number after the change
1756
:ivar old_revid: revision id before the change
1757
:ivar new_revid: revision id after the change
1759
The revid fields are strings. The revno fields are integers.
1762
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1763
"""Create a group of ChangeBranchTip parameters.
1765
:param branch: The branch being changed.
1766
:param old_revno: Revision number before the change.
1767
:param new_revno: Revision number after the change.
1768
:param old_revid: Tip revision id before the change.
1769
:param new_revid: Tip revision id after the change.
1771
self.branch = branch
1772
self.old_revno = old_revno
1773
self.new_revno = new_revno
1774
self.old_revid = old_revid
1775
self.new_revid = new_revid
1777
def __eq__(self, other):
1778
return self.__dict__ == other.__dict__
1781
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1782
self.__class__.__name__, self.branch,
1783
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1786
class BranchInitHookParams(object):
1787
"""Object holding parameters passed to `*_branch_init` hooks.
1789
There are 4 fields that hooks may wish to access:
1791
:ivar format: the branch format
1792
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1793
:ivar name: name of colocated branch, if any (or None)
1794
:ivar branch: the branch created
1796
Note that for lightweight checkouts, the bzrdir and format fields refer to
1797
the checkout, hence they are different from the corresponding fields in
1798
branch, which refer to the original branch.
1801
def __init__(self, format, controldir, name, branch):
1802
"""Create a group of BranchInitHook parameters.
1804
:param format: the branch format
1805
:param controldir: the ControlDir where the branch will be/has been
1807
:param name: name of colocated branch, if any (or None)
1808
:param branch: the branch created
1810
Note that for lightweight checkouts, the bzrdir and format fields refer
1811
to the checkout, hence they are different from the corresponding fields
1812
in branch, which refer to the original branch.
1814
self.format = format
1815
self.controldir = controldir
1817
self.branch = branch
1819
def __eq__(self, other):
1820
return self.__dict__ == other.__dict__
1823
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1826
class SwitchHookParams(object):
1827
"""Object holding parameters passed to `*_switch` hooks.
1829
There are 4 fields that hooks may wish to access:
1831
:ivar control_dir: ControlDir of the checkout to change
1832
:ivar to_branch: branch that the checkout is to reference
1833
:ivar force: skip the check for local commits in a heavy checkout
1834
:ivar revision_id: revision ID to switch to (or None)
1837
def __init__(self, control_dir, to_branch, force, revision_id):
1838
"""Create a group of SwitchHook parameters.
1840
:param control_dir: ControlDir of the checkout to change
1841
:param to_branch: branch that the checkout is to reference
1842
:param force: skip the check for local commits in a heavy checkout
1843
:param revision_id: revision ID to switch to (or None)
1845
self.control_dir = control_dir
1846
self.to_branch = to_branch
1848
self.revision_id = revision_id
1850
def __eq__(self, other):
1851
return self.__dict__ == other.__dict__
1854
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1855
self.control_dir, self.to_branch,
1859
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
1860
"""Branch format registry."""
1862
def __init__(self, other_registry=None):
1863
super(BranchFormatRegistry, self).__init__(other_registry)
1864
self._default_format = None
1865
self._default_format_key = None
1867
def get_default(self):
1868
"""Return the current default format."""
1869
if (self._default_format_key is not None and
1870
self._default_format is None):
1871
self._default_format = self.get(self._default_format_key)
1872
return self._default_format
1874
def set_default(self, format):
1875
"""Set the default format."""
1876
self._default_format = format
1877
self._default_format_key = None
1879
def set_default_key(self, format_string):
1880
"""Set the default format by its format string."""
1881
self._default_format_key = format_string
1882
self._default_format = None
1885
network_format_registry = registry.FormatRegistry()
1886
"""Registry of formats indexed by their network name.
1888
The network name for a branch format is an identifier that can be used when
1889
referring to formats with smart server operations. See
1890
BranchFormat.network_name() for more detail.
1893
format_registry = BranchFormatRegistry(network_format_registry)
1896
# formats which have no format string are not discoverable
1897
# and not independently creatable, so are not registered.
1898
format_registry.register_lazy(
1899
b"Bazaar-NG branch format 5\n", "breezy.bzr.fullhistory",
1901
format_registry.register_lazy(
1902
b"Bazaar Branch Format 6 (bzr 0.15)\n",
1903
"breezy.bzr.branch", "BzrBranchFormat6")
1904
format_registry.register_lazy(
1905
b"Bazaar Branch Format 7 (needs bzr 1.6)\n",
1906
"breezy.bzr.branch", "BzrBranchFormat7")
1907
format_registry.register_lazy(
1908
b"Bazaar Branch Format 8 (needs bzr 1.15)\n",
1909
"breezy.bzr.branch", "BzrBranchFormat8")
1910
format_registry.register_lazy(
1911
b"Bazaar-NG Branch Reference Format 1\n",
1912
"breezy.bzr.branch", "BranchReferenceFormat")
1914
format_registry.set_default_key(b"Bazaar Branch Format 7 (needs bzr 1.6)\n")
1917
class BranchWriteLockResult(LogicalLockResult):
1918
"""The result of write locking a branch.
1920
:ivar token: The token obtained from the underlying branch lock, or
1922
:ivar unlock: A callable which will unlock the lock.
1926
return "BranchWriteLockResult(%r, %r)" % (self.unlock, self.token)
1929
######################################################################
1930
# results of operations
1933
class _Result(object):
1935
def _show_tag_conficts(self, to_file):
1936
if not getattr(self, 'tag_conflicts', None):
1938
to_file.write('Conflicting tags:\n')
1939
for name, value1, value2 in self.tag_conflicts:
1940
to_file.write(' %s\n' % (name, ))
1943
class PullResult(_Result):
1944
"""Result of a Branch.pull operation.
1946
:ivar old_revno: Revision number before pull.
1947
:ivar new_revno: Revision number after pull.
1948
:ivar old_revid: Tip revision id before pull.
1949
:ivar new_revid: Tip revision id after pull.
1950
:ivar source_branch: Source (local) branch object. (read locked)
1951
:ivar master_branch: Master branch of the target, or the target if no
1953
:ivar local_branch: target branch if there is a Master, else None
1954
:ivar target_branch: Target/destination branch object. (write locked)
1955
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
1956
:ivar tag_updates: A dict with new tags, see BasicTags.merge_to
1959
def report(self, to_file):
1960
tag_conflicts = getattr(self, "tag_conflicts", None)
1961
tag_updates = getattr(self, "tag_updates", None)
1963
if self.old_revid != self.new_revid:
1964
to_file.write('Now on revision %d.\n' % self.new_revno)
1966
to_file.write('%d tag(s) updated.\n' % len(tag_updates))
1967
if self.old_revid == self.new_revid and not tag_updates:
1968
if not tag_conflicts:
1969
to_file.write('No revisions or tags to pull.\n')
1971
to_file.write('No revisions to pull.\n')
1972
self._show_tag_conficts(to_file)
1975
class BranchPushResult(_Result):
1976
"""Result of a Branch.push operation.
1978
:ivar old_revno: Revision number (eg 10) of the target before push.
1979
:ivar new_revno: Revision number (eg 12) of the target after push.
1980
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
1982
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
1984
:ivar source_branch: Source branch object that the push was from. This is
1985
read locked, and generally is a local (and thus low latency) branch.
1986
:ivar master_branch: If target is a bound branch, the master branch of
1987
target, or target itself. Always write locked.
1988
:ivar target_branch: The direct Branch where data is being sent (write
1990
:ivar local_branch: If the target is a bound branch this will be the
1991
target, otherwise it will be None.
1994
def report(self, to_file):
1995
# TODO: This function gets passed a to_file, but then
1996
# ignores it and calls note() instead. This is also
1997
# inconsistent with PullResult(), which writes to stdout.
1998
# -- JRV20110901, bug #838853
1999
tag_conflicts = getattr(self, "tag_conflicts", None)
2000
tag_updates = getattr(self, "tag_updates", None)
2002
if self.old_revid != self.new_revid:
2003
note(gettext('Pushed up to revision %d.') % self.new_revno)
2005
note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
2006
if self.old_revid == self.new_revid and not tag_updates:
2007
if not tag_conflicts:
2008
note(gettext('No new revisions or tags to push.'))
2010
note(gettext('No new revisions to push.'))
2011
self._show_tag_conficts(to_file)
2014
class BranchCheckResult(object):
2015
"""Results of checking branch consistency.
2020
def __init__(self, branch):
2021
self.branch = branch
2024
def report_results(self, verbose):
2025
"""Report the check results via trace.note.
2027
:param verbose: Requests more detailed display of what was checked,
2030
note(gettext('checked branch {0} format {1}').format(
2031
self.branch.user_url, self.branch._format))
2032
for error in self.errors:
2033
note(gettext('found error:%s'), error)
2036
class InterBranch(InterObject):
2037
"""This class represents operations taking place between two branches.
2039
Its instances have methods like pull() and push() and contain
2040
references to the source and target repositories these operations
2041
can be carried out on.
2045
"""The available optimised InterBranch types."""
2048
def _get_branch_formats_to_test(klass):
2049
"""Return an iterable of format tuples for testing.
2051
:return: An iterable of (from_format, to_format) to use when testing
2052
this InterBranch class. Each InterBranch class should define this
2055
raise NotImplementedError(klass._get_branch_formats_to_test)
2057
def pull(self, overwrite=False, stop_revision=None,
2058
possible_transports=None, local=False):
2059
"""Mirror source into target branch.
2061
The target branch is considered to be 'local', having low latency.
2063
:returns: PullResult instance
2065
raise NotImplementedError(self.pull)
2067
def push(self, overwrite=False, stop_revision=None, lossy=False,
2068
_override_hook_source_branch=None):
2069
"""Mirror the source branch into the target branch.
2071
The source branch is considered to be 'local', having low latency.
2073
raise NotImplementedError(self.push)
2075
def copy_content_into(self, revision_id=None):
2076
"""Copy the content of source into target
2078
revision_id: if not None, the revision history in the new branch will
2079
be truncated to end with revision_id.
2081
raise NotImplementedError(self.copy_content_into)
2083
def fetch(self, stop_revision=None, limit=None):
2086
:param stop_revision: Last revision to fetch
2087
:param limit: Optional rough limit of revisions to fetch
2089
raise NotImplementedError(self.fetch)
2092
def _fix_overwrite_type(overwrite):
2093
if isinstance(overwrite, bool):
2095
return ["history", "tags"]
2101
class GenericInterBranch(InterBranch):
2102
"""InterBranch implementation that uses public Branch functions."""
2105
def is_compatible(klass, source, target):
2106
# GenericBranch uses the public API, so always compatible
2110
def _get_branch_formats_to_test(klass):
2111
return [(format_registry.get_default(), format_registry.get_default())]
2114
def unwrap_format(klass, format):
2115
if isinstance(format, remote.RemoteBranchFormat):
2116
format._ensure_real()
2117
return format._custom_format
2120
def copy_content_into(self, revision_id=None):
2121
"""Copy the content of source into target
2123
revision_id: if not None, the revision history in the new branch will
2124
be truncated to end with revision_id.
2126
with self.source.lock_read(), self.target.lock_write():
2127
self.source.update_references(self.target)
2128
self.source._synchronize_history(self.target, revision_id)
2130
parent = self.source.get_parent()
2131
except errors.InaccessibleParent as e:
2132
mutter('parent was not accessible to copy: %s', str(e))
2135
self.target.set_parent(parent)
2136
if self.source._push_should_merge_tags():
2137
self.source.tags.merge_to(self.target.tags)
2139
def fetch(self, stop_revision=None, limit=None):
2140
if self.target.base == self.source.base:
2142
with self.source.lock_read(), self.target.lock_write():
2143
fetch_spec_factory = fetch.FetchSpecFactory()
2144
fetch_spec_factory.source_branch = self.source
2145
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
2146
fetch_spec_factory.source_repo = self.source.repository
2147
fetch_spec_factory.target_repo = self.target.repository
2148
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
2149
fetch_spec_factory.limit = limit
2150
fetch_spec = fetch_spec_factory.make_fetch_spec()
2151
return self.target.repository.fetch(
2152
self.source.repository,
2153
fetch_spec=fetch_spec)
2155
def _update_revisions(self, stop_revision=None, overwrite=False,
2157
with self.source.lock_read(), self.target.lock_write():
2158
other_revno, other_last_revision = self.source.last_revision_info()
2159
stop_revno = None # unknown
2160
if stop_revision is None:
2161
stop_revision = other_last_revision
2162
if _mod_revision.is_null(stop_revision):
2163
# if there are no commits, we're done.
2165
stop_revno = other_revno
2167
# what's the current last revision, before we fetch [and change it
2169
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2170
# we fetch here so that we don't process data twice in the common
2171
# case of having something to pull, and so that the check for
2172
# already merged can operate on the just fetched graph, which will
2173
# be cached in memory.
2174
self.fetch(stop_revision=stop_revision)
2175
# Check to see if one is an ancestor of the other
2178
graph = self.target.repository.get_graph()
2179
if self.target._check_if_descendant_or_diverged(
2180
stop_revision, last_rev, graph, self.source):
2181
# stop_revision is a descendant of last_rev, but we aren't
2182
# overwriting, so we're done.
2184
if stop_revno is None:
2186
graph = self.target.repository.get_graph()
2187
this_revno, this_last_revision = \
2188
self.target.last_revision_info()
2189
stop_revno = graph.find_distance_to_null(stop_revision,
2190
[(other_last_revision, other_revno),
2191
(this_last_revision, this_revno)])
2192
self.target.set_last_revision_info(stop_revno, stop_revision)
2194
def pull(self, overwrite=False, stop_revision=None,
2195
possible_transports=None, run_hooks=True,
2196
_override_hook_target=None, local=False):
2197
"""Pull from source into self, updating my master if any.
2199
:param run_hooks: Private parameter - if false, this branch
2200
is being called because it's the master of the primary branch,
2201
so it should not run its hooks.
2203
with self.target.lock_write():
2204
bound_location = self.target.get_bound_location()
2205
if local and not bound_location:
2206
raise errors.LocalRequiresBoundBranch()
2207
master_branch = None
2208
source_is_master = False
2210
# bound_location comes from a config file, some care has to be
2211
# taken to relate it to source.user_url
2212
normalized = urlutils.normalize_url(bound_location)
2214
relpath = self.source.user_transport.relpath(normalized)
2215
source_is_master = (relpath == '')
2216
except (errors.PathNotChild, urlutils.InvalidURL):
2217
source_is_master = False
2218
if not local and bound_location and not source_is_master:
2219
# not pulling from master, so we need to update master.
2220
master_branch = self.target.get_master_branch(possible_transports)
2221
master_branch.lock_write()
2224
# pull from source into master.
2225
master_branch.pull(self.source, overwrite, stop_revision,
2227
return self._pull(overwrite,
2228
stop_revision, _hook_master=master_branch,
2229
run_hooks=run_hooks,
2230
_override_hook_target=_override_hook_target,
2231
merge_tags_to_master=not source_is_master)
2234
master_branch.unlock()
2236
def push(self, overwrite=False, stop_revision=None, lossy=False,
2237
_override_hook_source_branch=None):
2238
"""See InterBranch.push.
2240
This is the basic concrete implementation of push()
2242
:param _override_hook_source_branch: If specified, run the hooks
2243
passing this Branch as the source, rather than self. This is for
2244
use of RemoteBranch, where push is delegated to the underlying
2248
raise errors.LossyPushToSameVCS(self.source, self.target)
2249
# TODO: Public option to disable running hooks - should be trivial but
2252
if _override_hook_source_branch:
2253
result.source_branch = _override_hook_source_branch
2254
for hook in Branch.hooks['post_push']:
2257
with self.source.lock_read(), self.target.lock_write():
2258
bound_location = self.target.get_bound_location()
2259
if bound_location and self.target.base != bound_location:
2260
# there is a master branch.
2262
# XXX: Why the second check? Is it even supported for a branch to
2263
# be bound to itself? -- mbp 20070507
2264
master_branch = self.target.get_master_branch()
2265
with master_branch.lock_write():
2266
# push into the master from the source branch.
2267
master_inter = InterBranch.get(self.source, master_branch)
2268
master_inter._basic_push(overwrite, stop_revision)
2269
# and push into the target branch from the source. Note that
2270
# we push from the source branch again, because it's considered
2271
# the highest bandwidth repository.
2272
result = self._basic_push(overwrite, stop_revision)
2273
result.master_branch = master_branch
2274
result.local_branch = self.target
2277
master_branch = None
2279
result = self._basic_push(overwrite, stop_revision)
2280
# TODO: Why set master_branch and local_branch if there's no
2281
# binding? Maybe cleaner to just leave them unset? -- mbp
2283
result.master_branch = self.target
2284
result.local_branch = None
2288
def _basic_push(self, overwrite, stop_revision):
2289
"""Basic implementation of push without bound branches or hooks.
2291
Must be called with source read locked and target write locked.
2293
result = BranchPushResult()
2294
result.source_branch = self.source
2295
result.target_branch = self.target
2296
result.old_revno, result.old_revid = self.target.last_revision_info()
2297
self.source.update_references(self.target)
2298
overwrite = _fix_overwrite_type(overwrite)
2299
if result.old_revid != stop_revision:
2300
# We assume that during 'push' this repository is closer than
2302
graph = self.source.repository.get_graph(self.target.repository)
2303
self._update_revisions(stop_revision,
2304
overwrite=("history" in overwrite),
2306
if self.source._push_should_merge_tags():
2307
result.tag_updates, result.tag_conflicts = (
2308
self.source.tags.merge_to(
2309
self.target.tags, "tags" in overwrite))
2310
result.new_revno, result.new_revid = self.target.last_revision_info()
2313
def _pull(self, overwrite=False, stop_revision=None,
2314
possible_transports=None, _hook_master=None, run_hooks=True,
2315
_override_hook_target=None, local=False,
2316
merge_tags_to_master=True):
2319
This function is the core worker, used by GenericInterBranch.pull to
2320
avoid duplication when pulling source->master and source->local.
2322
:param _hook_master: Private parameter - set the branch to
2323
be supplied as the master to pull hooks.
2324
:param run_hooks: Private parameter - if false, this branch
2325
is being called because it's the master of the primary branch,
2326
so it should not run its hooks.
2327
is being called because it's the master of the primary branch,
2328
so it should not run its hooks.
2329
:param _override_hook_target: Private parameter - set the branch to be
2330
supplied as the target_branch to pull hooks.
2331
:param local: Only update the local branch, and not the bound branch.
2333
# This type of branch can't be bound.
2335
raise errors.LocalRequiresBoundBranch()
2336
result = PullResult()
2337
result.source_branch = self.source
2338
if _override_hook_target is None:
2339
result.target_branch = self.target
2341
result.target_branch = _override_hook_target
2342
with self.source.lock_read():
2343
# We assume that during 'pull' the target repository is closer than
2345
self.source.update_references(self.target)
2346
graph = self.target.repository.get_graph(self.source.repository)
2347
# TODO: Branch formats should have a flag that indicates
2348
# that revno's are expensive, and pull() should honor that flag.
2350
result.old_revno, result.old_revid = \
2351
self.target.last_revision_info()
2352
overwrite = _fix_overwrite_type(overwrite)
2353
self._update_revisions(stop_revision,
2354
overwrite=("history" in overwrite),
2356
# TODO: The old revid should be specified when merging tags,
2357
# so a tags implementation that versions tags can only
2358
# pull in the most recent changes. -- JRV20090506
2359
result.tag_updates, result.tag_conflicts = (
2360
self.source.tags.merge_to(self.target.tags,
2361
"tags" in overwrite,
2362
ignore_master=not merge_tags_to_master))
2363
result.new_revno, result.new_revid = self.target.last_revision_info()
2365
result.master_branch = _hook_master
2366
result.local_branch = result.target_branch
2368
result.master_branch = result.target_branch
2369
result.local_branch = None
2371
for hook in Branch.hooks['post_pull']:
2376
InterBranch.register_optimiser(GenericInterBranch)
added
removed
breezy/branch.py
