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
19
from .lazy_import import lazy_import
20
lazy_import(globals(), """
24
config as _mod_config,
28
revision as _mod_revision,
34
from breezy.bzr import (
39
from breezy.i18n import gettext, ngettext
47
from .hooks import Hooks
48
from .inter import InterObject
49
from .lock import LogicalLockResult
54
from .trace import mutter, mutter_callsite, note, is_quiet, warning
57
class UnstackableBranchFormat(errors.BzrError):
59
_fmt = ("The branch '%(url)s'(%(format)s) is not a stackable format. "
60
"You will need to upgrade the branch to permit branch stacking.")
62
def __init__(self, format, url):
63
errors.BzrError.__init__(self)
68
class Branch(controldir.ControlComponent):
69
"""Branch holding a history of revisions.
72
Base directory/url of the branch; using control_url and
73
control_transport is more standardized.
74
:ivar hooks: An instance of BranchHooks.
75
:ivar _master_branch_cache: cached result of get_master_branch, see
78
# this is really an instance variable - FIXME move it there
83
def control_transport(self):
84
return self._transport
87
def user_transport(self):
88
return self.controldir.user_transport
90
def __init__(self, possible_transports=None):
91
self.tags = self._format.make_tags(self)
92
self._revision_history_cache = None
93
self._revision_id_to_revno_cache = None
94
self._partial_revision_id_to_revno_cache = {}
95
self._partial_revision_history_cache = []
96
self._last_revision_info_cache = None
97
self._master_branch_cache = None
98
self._merge_sorted_revisions_cache = None
99
self._open_hook(possible_transports)
100
hooks = Branch.hooks['open']
104
def _open_hook(self, possible_transports):
105
"""Called by init to allow simpler extension of the base class."""
107
def _activate_fallback_location(self, url, possible_transports):
108
"""Activate the branch/repository from url as a fallback repository."""
109
for existing_fallback_repo in self.repository._fallback_repositories:
110
if existing_fallback_repo.user_url == url:
111
# This fallback is already configured. This probably only
112
# happens because ControlDir.sprout is a horrible mess. To
113
# avoid confusing _unstack we don't add this a second time.
114
mutter('duplicate activation of fallback %r on %r', url, self)
116
repo = self._get_fallback_repository(url, possible_transports)
117
if repo.has_same_location(self.repository):
118
raise errors.UnstackableLocationError(self.user_url, url)
119
self.repository.add_fallback_repository(repo)
121
def break_lock(self):
122
"""Break a lock if one is present from another instance.
124
Uses the ui factory to ask for confirmation if the lock may be from
127
This will probe the repository for its lock as well.
129
self.control_files.break_lock()
130
self.repository.break_lock()
131
master = self.get_master_branch()
132
if master is not None:
135
def _check_stackable_repo(self):
136
if not self.repository._format.supports_external_lookups:
137
raise errors.UnstackableRepositoryFormat(
138
self.repository._format, self.repository.base)
140
def _extend_partial_history(self, stop_index=None, stop_revision=None):
141
"""Extend the partial history to include a given index
143
If a stop_index is supplied, stop when that index has been reached.
144
If a stop_revision is supplied, stop when that revision is
145
encountered. Otherwise, stop when the beginning of history is
148
:param stop_index: The index which should be present. When it is
149
present, history extension will stop.
150
:param stop_revision: The revision id which should be present. When
151
it is encountered, history extension will stop.
153
if len(self._partial_revision_history_cache) == 0:
154
self._partial_revision_history_cache = [self.last_revision()]
155
repository._iter_for_revno(
156
self.repository, self._partial_revision_history_cache,
157
stop_index=stop_index, stop_revision=stop_revision)
158
if self._partial_revision_history_cache[-1] == \
159
_mod_revision.NULL_REVISION:
160
self._partial_revision_history_cache.pop()
162
def _get_check_refs(self):
163
"""Get the references needed for check().
167
revid = self.last_revision()
168
return [('revision-existence', revid), ('lefthand-distance', revid)]
171
def open(base, _unsupported=False, possible_transports=None):
172
"""Open the branch rooted at base.
174
For instance, if the branch is at URL/.bzr/branch,
175
Branch.open(URL) -> a Branch instance.
177
control = controldir.ControlDir.open(
178
base, possible_transports=possible_transports,
179
_unsupported=_unsupported)
180
return control.open_branch(
181
unsupported=_unsupported,
182
possible_transports=possible_transports)
185
def open_from_transport(transport, name=None, _unsupported=False,
186
possible_transports=None):
187
"""Open the branch rooted at transport"""
188
control = controldir.ControlDir.open_from_transport(
189
transport, _unsupported)
190
return control.open_branch(
191
name=name, unsupported=_unsupported,
192
possible_transports=possible_transports)
195
def open_containing(url, possible_transports=None):
196
"""Open an existing branch which contains url.
198
This probes for a branch at url, and searches upwards from there.
200
Basically we keep looking up until we find the control directory or
201
run into the root. If there isn't one, raises NotBranchError.
202
If there is one and it is either an unrecognised format or an
203
unsupported format, UnknownFormatError or UnsupportedFormatError are
204
raised. If there is one, it is returned, along with the unused portion
207
control, relpath = controldir.ControlDir.open_containing(
208
url, possible_transports)
209
branch = control.open_branch(possible_transports=possible_transports)
210
return (branch, relpath)
212
def _push_should_merge_tags(self):
213
"""Should _basic_push merge this branch's tags into the target?
215
The default implementation returns False if this branch has no tags,
216
and True the rest of the time. Subclasses may override this.
218
return self.supports_tags() and self.tags.get_tag_dict()
220
def get_config(self):
221
"""Get a breezy.config.BranchConfig for this Branch.
223
This can then be used to get and set configuration options for the
226
:return: A breezy.config.BranchConfig.
228
return _mod_config.BranchConfig(self)
230
def get_config_stack(self):
231
"""Get a breezy.config.BranchStack for this Branch.
233
This can then be used to get and set configuration options for the
236
:return: A breezy.config.BranchStack.
238
return _mod_config.BranchStack(self)
240
def store_uncommitted(self, creator):
241
"""Store uncommitted changes from a ShelfCreator.
243
:param creator: The ShelfCreator containing uncommitted changes, or
244
None to delete any stored changes.
245
:raises: ChangesAlreadyStored if the branch already has changes.
247
raise NotImplementedError(self.store_uncommitted)
249
def get_unshelver(self, tree):
250
"""Return a shelf.Unshelver for this branch and tree.
252
:param tree: The tree to use to construct the Unshelver.
253
:return: an Unshelver or None if no changes are stored.
255
raise NotImplementedError(self.get_unshelver)
257
def _get_fallback_repository(self, url, possible_transports):
258
"""Get the repository we fallback to at url."""
259
url = urlutils.join(self.base, url)
260
a_branch = Branch.open(url, possible_transports=possible_transports)
261
return a_branch.repository
263
def _get_nick(self, local=False, possible_transports=None):
264
config = self.get_config()
265
# explicit overrides master, but don't look for master if local is True
266
if not local and not config.has_explicit_nickname():
268
master = self.get_master_branch(possible_transports)
269
if master and self.user_url == master.user_url:
270
raise errors.RecursiveBind(self.user_url)
271
if master is not None:
272
# return the master branch value
274
except errors.RecursiveBind as e:
276
except errors.BzrError as e:
277
# Silently fall back to local implicit nick if the master is
279
mutter("Could not connect to bound branch, "
280
"falling back to local nick.\n " + str(e))
281
return config.get_nickname()
283
def _set_nick(self, nick):
284
self.get_config().set_user_option('nickname', nick, warn_masked=True)
286
nick = property(_get_nick, _set_nick)
289
raise NotImplementedError(self.is_locked)
291
def _lefthand_history(self, revision_id, last_rev=None,
293
if 'evil' in debug.debug_flags:
294
mutter_callsite(4, "_lefthand_history scales with history.")
295
# stop_revision must be a descendant of last_revision
296
graph = self.repository.get_graph()
297
if last_rev is not None:
298
if not graph.is_ancestor(last_rev, revision_id):
299
# our previous tip is not merged into stop_revision
300
raise errors.DivergedBranches(self, other_branch)
301
# make a new revision history from the graph
302
parents_map = graph.get_parent_map([revision_id])
303
if revision_id not in parents_map:
304
raise errors.NoSuchRevision(self, revision_id)
305
current_rev_id = revision_id
307
check_not_reserved_id = _mod_revision.check_not_reserved_id
308
# Do not include ghosts or graph origin in revision_history
309
while (current_rev_id in parents_map
310
and len(parents_map[current_rev_id]) > 0):
311
check_not_reserved_id(current_rev_id)
312
new_history.append(current_rev_id)
313
current_rev_id = parents_map[current_rev_id][0]
314
parents_map = graph.get_parent_map([current_rev_id])
315
new_history.reverse()
318
def lock_write(self, token=None):
319
"""Lock the branch for write operations.
321
:param token: A token to permit reacquiring a previously held and
323
:return: A BranchWriteLockResult.
325
raise NotImplementedError(self.lock_write)
328
"""Lock the branch for read operations.
330
:return: A breezy.lock.LogicalLockResult.
332
raise NotImplementedError(self.lock_read)
335
raise NotImplementedError(self.unlock)
337
def peek_lock_mode(self):
338
"""Return lock mode for the Branch: 'r', 'w' or None"""
339
raise NotImplementedError(self.peek_lock_mode)
341
def get_physical_lock_status(self):
342
raise NotImplementedError(self.get_physical_lock_status)
344
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
345
"""Return the revision_id for a dotted revno.
347
:param revno: a tuple like (1,) or (1,1,2)
348
:param _cache_reverse: a private parameter enabling storage
349
of the reverse mapping in a top level cache. (This should
350
only be done in selective circumstances as we want to
351
avoid having the mapping cached multiple times.)
352
:return: the revision_id
353
:raises errors.NoSuchRevision: if the revno doesn't exist
355
with self.lock_read():
356
rev_id = self._do_dotted_revno_to_revision_id(revno)
358
self._partial_revision_id_to_revno_cache[rev_id] = revno
361
def _do_dotted_revno_to_revision_id(self, revno):
362
"""Worker function for dotted_revno_to_revision_id.
364
Subclasses should override this if they wish to
365
provide a more efficient implementation.
369
return self.get_rev_id(revno[0])
370
except errors.RevisionNotPresent as e:
371
raise errors.GhostRevisionsHaveNoRevno(revno[0], e.revision_id)
372
revision_id_to_revno = self.get_revision_id_to_revno_map()
373
revision_ids = [revision_id for revision_id, this_revno
374
in viewitems(revision_id_to_revno)
375
if revno == this_revno]
376
if len(revision_ids) == 1:
377
return revision_ids[0]
379
revno_str = '.'.join(map(str, revno))
380
raise errors.NoSuchRevision(self, revno_str)
382
def revision_id_to_dotted_revno(self, revision_id):
383
"""Given a revision id, return its dotted revno.
385
:return: a tuple like (1,) or (400,1,3).
387
with self.lock_read():
388
return self._do_revision_id_to_dotted_revno(revision_id)
390
def _do_revision_id_to_dotted_revno(self, revision_id):
391
"""Worker function for revision_id_to_revno."""
392
# Try the caches if they are loaded
393
result = self._partial_revision_id_to_revno_cache.get(revision_id)
394
if result is not None:
396
if self._revision_id_to_revno_cache:
397
result = self._revision_id_to_revno_cache.get(revision_id)
399
raise errors.NoSuchRevision(self, revision_id)
400
# Try the mainline as it's optimised
402
revno = self.revision_id_to_revno(revision_id)
404
except errors.NoSuchRevision:
405
# We need to load and use the full revno map after all
406
result = self.get_revision_id_to_revno_map().get(revision_id)
408
raise errors.NoSuchRevision(self, revision_id)
411
def get_revision_id_to_revno_map(self):
412
"""Return the revision_id => dotted revno map.
414
This will be regenerated on demand, but will be cached.
416
:return: A dictionary mapping revision_id => dotted revno.
417
This dictionary should not be modified by the caller.
419
if 'evil' in debug.debug_flags:
421
3, "get_revision_id_to_revno_map scales with ancestry.")
422
with self.lock_read():
423
if self._revision_id_to_revno_cache is not None:
424
mapping = self._revision_id_to_revno_cache
426
mapping = self._gen_revno_map()
427
self._cache_revision_id_to_revno(mapping)
428
# TODO: jam 20070417 Since this is being cached, should we be
430
# I would rather not, and instead just declare that users should
431
# not modify the return value.
434
def _gen_revno_map(self):
435
"""Create a new mapping from revision ids to dotted revnos.
437
Dotted revnos are generated based on the current tip in the revision
439
This is the worker function for get_revision_id_to_revno_map, which
440
just caches the return value.
442
:return: A dictionary mapping revision_id => dotted revno.
444
revision_id_to_revno = {
445
rev_id: revno for rev_id, depth, revno, end_of_merge
446
in self.iter_merge_sorted_revisions()}
447
return revision_id_to_revno
449
def iter_merge_sorted_revisions(self, start_revision_id=None,
450
stop_revision_id=None,
451
stop_rule='exclude', direction='reverse'):
452
"""Walk the revisions for a branch in merge sorted order.
454
Merge sorted order is the output from a merge-aware,
455
topological sort, i.e. all parents come before their
456
children going forward; the opposite for reverse.
458
:param start_revision_id: the revision_id to begin walking from.
459
If None, the branch tip is used.
460
:param stop_revision_id: the revision_id to terminate the walk
461
after. If None, the rest of history is included.
462
:param stop_rule: if stop_revision_id is not None, the precise rule
463
to use for termination:
465
* 'exclude' - leave the stop revision out of the result (default)
466
* 'include' - the stop revision is the last item in the result
467
* 'with-merges' - include the stop revision and all of its
468
merged revisions in the result
469
* 'with-merges-without-common-ancestry' - filter out revisions
470
that are in both ancestries
471
:param direction: either 'reverse' or 'forward':
473
* reverse means return the start_revision_id first, i.e.
474
start at the most recent revision and go backwards in history
475
* forward returns tuples in the opposite order to reverse.
476
Note in particular that forward does *not* do any intelligent
477
ordering w.r.t. depth as some clients of this API may like.
478
(If required, that ought to be done at higher layers.)
480
:return: an iterator over (revision_id, depth, revno, end_of_merge)
483
* revision_id: the unique id of the revision
484
* depth: How many levels of merging deep this node has been
486
* revno_sequence: This field provides a sequence of
487
revision numbers for all revisions. The format is:
488
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
489
branch that the revno is on. From left to right the REVNO numbers
490
are the sequence numbers within that branch of the revision.
491
* end_of_merge: When True the next node (earlier in history) is
492
part of a different merge.
494
with self.lock_read():
495
# Note: depth and revno values are in the context of the branch so
496
# we need the full graph to get stable numbers, regardless of the
498
if self._merge_sorted_revisions_cache is None:
499
last_revision = self.last_revision()
500
known_graph = self.repository.get_known_graph_ancestry(
502
self._merge_sorted_revisions_cache = known_graph.merge_sort(
504
filtered = self._filter_merge_sorted_revisions(
505
self._merge_sorted_revisions_cache, start_revision_id,
506
stop_revision_id, stop_rule)
507
# Make sure we don't return revisions that are not part of the
508
# start_revision_id ancestry.
509
filtered = self._filter_start_non_ancestors(filtered)
510
if direction == 'reverse':
512
if direction == 'forward':
513
return reversed(list(filtered))
515
raise ValueError('invalid direction %r' % direction)
517
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
518
start_revision_id, stop_revision_id,
520
"""Iterate over an inclusive range of sorted revisions."""
521
rev_iter = iter(merge_sorted_revisions)
522
if start_revision_id is not None:
523
for node in rev_iter:
525
if rev_id != start_revision_id:
528
# The decision to include the start or not
529
# depends on the stop_rule if a stop is provided
530
# so pop this node back into the iterator
531
rev_iter = itertools.chain(iter([node]), rev_iter)
533
if stop_revision_id is None:
535
for node in rev_iter:
537
yield (rev_id, node.merge_depth, node.revno,
539
elif stop_rule == 'exclude':
540
for node in rev_iter:
542
if rev_id == stop_revision_id:
544
yield (rev_id, node.merge_depth, node.revno,
546
elif stop_rule == 'include':
547
for node in rev_iter:
549
yield (rev_id, node.merge_depth, node.revno,
551
if rev_id == stop_revision_id:
553
elif stop_rule == 'with-merges-without-common-ancestry':
554
# We want to exclude all revisions that are already part of the
555
# stop_revision_id ancestry.
556
graph = self.repository.get_graph()
557
ancestors = graph.find_unique_ancestors(start_revision_id,
559
for node in rev_iter:
561
if rev_id not in ancestors:
563
yield (rev_id, node.merge_depth, node.revno,
565
elif stop_rule == 'with-merges':
566
stop_rev = self.repository.get_revision(stop_revision_id)
567
if stop_rev.parent_ids:
568
left_parent = stop_rev.parent_ids[0]
570
left_parent = _mod_revision.NULL_REVISION
571
# left_parent is the actual revision we want to stop logging at,
572
# since we want to show the merged revisions after the stop_rev too
573
reached_stop_revision_id = False
574
revision_id_whitelist = []
575
for node in rev_iter:
577
if rev_id == left_parent:
578
# reached the left parent after the stop_revision
580
if (not reached_stop_revision_id
581
or rev_id in revision_id_whitelist):
582
yield (rev_id, node.merge_depth, node.revno,
584
if reached_stop_revision_id or rev_id == stop_revision_id:
585
# only do the merged revs of rev_id from now on
586
rev = self.repository.get_revision(rev_id)
588
reached_stop_revision_id = True
589
revision_id_whitelist.extend(rev.parent_ids)
591
raise ValueError('invalid stop_rule %r' % stop_rule)
593
def _filter_start_non_ancestors(self, rev_iter):
594
# If we started from a dotted revno, we want to consider it as a tip
595
# and don't want to yield revisions that are not part of its
596
# ancestry. Given the order guaranteed by the merge sort, we will see
597
# uninteresting descendants of the first parent of our tip before the
600
first = next(rev_iter)
601
except StopIteration:
603
(rev_id, merge_depth, revno, end_of_merge) = first
606
# We start at a mainline revision so by definition, all others
607
# revisions in rev_iter are ancestors
608
for node in rev_iter:
613
pmap = self.repository.get_parent_map([rev_id])
614
parents = pmap.get(rev_id, [])
616
whitelist.update(parents)
618
# If there is no parents, there is nothing of interest left
620
# FIXME: It's hard to test this scenario here as this code is never
621
# called in that case. -- vila 20100322
624
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
626
if rev_id in whitelist:
627
pmap = self.repository.get_parent_map([rev_id])
628
parents = pmap.get(rev_id, [])
629
whitelist.remove(rev_id)
630
whitelist.update(parents)
632
# We've reached the mainline, there is nothing left to
636
# A revision that is not part of the ancestry of our
639
yield (rev_id, merge_depth, revno, end_of_merge)
641
def leave_lock_in_place(self):
642
"""Tell this branch object not to release the physical lock when this
645
If lock_write doesn't return a token, then this method is not
648
self.control_files.leave_in_place()
650
def dont_leave_lock_in_place(self):
651
"""Tell this branch object to release the physical lock when this
652
object is unlocked, even if it didn't originally acquire it.
654
If lock_write doesn't return a token, then this method is not
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 fetch(self, from_branch, stop_revision=None, limit=None, lossy=False):
680
"""Copy revisions from from_branch into this branch.
682
:param from_branch: Where to copy from.
683
:param stop_revision: What revision to stop at (None for at the end
685
:param limit: Optional rough limit of revisions to fetch
688
with self.lock_write():
689
return InterBranch.get(from_branch, self).fetch(
690
stop_revision, limit=limit, lossy=lossy)
692
def get_bound_location(self):
693
"""Return the URL of the branch we are bound to.
695
Older format branches cannot bind, please be sure to use a metadir
700
def get_old_bound_location(self):
701
"""Return the URL of the branch we used to be bound to
703
raise errors.UpgradeRequired(self.user_url)
705
def get_commit_builder(self, parents, config_stack=None, timestamp=None,
706
timezone=None, committer=None, revprops=None,
707
revision_id=None, lossy=False):
708
"""Obtain a CommitBuilder for this branch.
710
:param parents: Revision ids of the parents of the new revision.
711
:param config: Optional configuration to use.
712
:param timestamp: Optional timestamp recorded for commit.
713
:param timezone: Optional timezone for timestamp.
714
:param committer: Optional committer to set for commit.
715
:param revprops: Optional dictionary of revision properties.
716
:param revision_id: Optional revision id.
717
:param lossy: Whether to discard data that can not be natively
718
represented, when pushing to a foreign VCS
721
if config_stack is None:
722
config_stack = self.get_config_stack()
724
return self.repository.get_commit_builder(
725
self, parents, config_stack, timestamp, timezone, committer,
726
revprops, revision_id, lossy)
728
def get_master_branch(self, possible_transports=None):
729
"""Return the branch we are bound to.
731
:return: Either a Branch, or None
735
def get_stacked_on_url(self):
736
"""Get the URL this branch is stacked against.
738
:raises NotStacked: If the branch is not stacked.
739
:raises UnstackableBranchFormat: If the branch does not support
742
raise NotImplementedError(self.get_stacked_on_url)
744
def set_last_revision_info(self, revno, revision_id):
745
"""Set the last revision of this branch.
747
The caller is responsible for checking that the revno is correct
748
for this revision id.
750
It may be possible to set the branch last revision to an id not
751
present in the repository. However, branches can also be
752
configured to check constraints on history, in which case this may not
755
raise NotImplementedError(self.set_last_revision_info)
757
def generate_revision_history(self, revision_id, last_rev=None,
759
"""See Branch.generate_revision_history"""
760
with self.lock_write():
761
graph = self.repository.get_graph()
762
(last_revno, last_revid) = self.last_revision_info()
763
known_revision_ids = [
764
(last_revid, last_revno),
765
(_mod_revision.NULL_REVISION, 0),
767
if last_rev is not None:
768
if not graph.is_ancestor(last_rev, revision_id):
769
# our previous tip is not merged into stop_revision
770
raise errors.DivergedBranches(self, other_branch)
771
revno = graph.find_distance_to_null(
772
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
if isinstance(url, text_type):
785
except UnicodeEncodeError:
786
raise urlutils.InvalidURL(
787
url, "Urls must be 7-bit ascii, "
788
"use breezy.urlutils.escape")
789
url = urlutils.relative_url(self.base, url)
790
with self.lock_write():
791
self._set_parent_location(url)
793
def set_stacked_on_url(self, url):
794
"""Set the URL this branch is stacked against.
796
:raises UnstackableBranchFormat: If the branch does not support
798
:raises UnstackableRepositoryFormat: If the repository does not support
801
if not self._format.supports_stacking():
802
raise UnstackableBranchFormat(self._format, self.user_url)
803
with self.lock_write():
804
# XXX: Changing from one fallback repository to another does not
805
# check that all the data you need is present in the new fallback.
806
# Possibly it should.
807
self._check_stackable_repo()
810
self.get_stacked_on_url()
811
except (errors.NotStacked, UnstackableBranchFormat,
812
errors.UnstackableRepositoryFormat):
816
self._activate_fallback_location(
817
url, possible_transports=[self.controldir.root_transport])
818
# write this out after the repository is stacked to avoid setting a
819
# stacked config that doesn't work.
820
self._set_config_location('stacked_on_location', url)
823
"""Change a branch to be unstacked, copying data as needed.
825
Don't call this directly, use set_stacked_on_url(None).
827
with ui.ui_factory.nested_progress_bar() as pb:
828
pb.update(gettext("Unstacking"))
829
# The basic approach here is to fetch the tip of the branch,
830
# including all available ghosts, from the existing stacked
831
# repository into a new repository object without the fallbacks.
833
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
834
# correct for CHKMap repostiories
835
old_repository = self.repository
836
if len(old_repository._fallback_repositories) != 1:
837
raise AssertionError(
838
"can't cope with fallback repositories "
839
"of %r (fallbacks: %r)" % (
840
old_repository, 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(
854
"didn't expect %r to have 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(
899
self.repository, old_repository,
900
required_ids=[self.last_revision()],
901
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
902
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
904
def _cache_revision_history(self, rev_history):
905
"""Set the cached revision history to rev_history.
907
The revision_history method will use this cache to avoid regenerating
908
the revision history.
910
This API is semi-public; it only for use by subclasses, all other code
911
should consider it to be private.
913
self._revision_history_cache = rev_history
915
def _cache_revision_id_to_revno(self, revision_id_to_revno):
916
"""Set the cached revision_id => revno map to revision_id_to_revno.
918
This API is semi-public; it only for use by subclasses, all other code
919
should consider it to be private.
921
self._revision_id_to_revno_cache = revision_id_to_revno
923
def _clear_cached_state(self):
924
"""Clear any cached data on this branch, e.g. cached revision history.
926
This means the next call to revision_history will need to call
927
_gen_revision_history.
929
This API is semi-public; it is only for use by subclasses, all other
930
code should consider it to be private.
932
self._revision_history_cache = None
933
self._revision_id_to_revno_cache = None
934
self._last_revision_info_cache = None
935
self._master_branch_cache = None
936
self._merge_sorted_revisions_cache = None
937
self._partial_revision_history_cache = []
938
self._partial_revision_id_to_revno_cache = {}
940
def _gen_revision_history(self):
941
"""Return sequence of revision hashes on to this branch.
943
Unlike revision_history, this method always regenerates or rereads the
944
revision history, i.e. it does not cache the result, so repeated calls
947
Concrete subclasses should override this instead of revision_history so
948
that subclasses do not need to deal with caching logic.
950
This API is semi-public; it only for use by subclasses, all other code
951
should consider it to be private.
953
raise NotImplementedError(self._gen_revision_history)
955
def _revision_history(self):
956
if 'evil' in debug.debug_flags:
957
mutter_callsite(3, "revision_history scales with history.")
958
if self._revision_history_cache is not None:
959
history = self._revision_history_cache
961
history = self._gen_revision_history()
962
self._cache_revision_history(history)
966
"""Return current revision number for this branch.
968
That is equivalent to the number of revisions committed to
971
return self.last_revision_info()[0]
974
"""Older format branches cannot bind or unbind."""
975
raise errors.UpgradeRequired(self.user_url)
977
def last_revision(self):
978
"""Return last revision id, or NULL_REVISION."""
979
return self.last_revision_info()[1]
981
def last_revision_info(self):
982
"""Return information about the last revision.
984
:return: A tuple (revno, revision_id).
986
with self.lock_read():
987
if self._last_revision_info_cache is None:
988
self._last_revision_info_cache = (
989
self._read_last_revision_info())
990
return self._last_revision_info_cache
992
def _read_last_revision_info(self):
993
raise NotImplementedError(self._read_last_revision_info)
995
def import_last_revision_info_and_tags(self, source, revno, revid,
997
"""Set the last revision info, importing from another repo if necessary.
999
This is used by the bound branch code to upload a revision to
1000
the master branch first before updating the tip of the local branch.
1001
Revisions referenced by source's tags are also transferred.
1003
:param source: Source branch to optionally fetch from
1004
:param revno: Revision number of the new tip
1005
:param revid: Revision id of the new tip
1006
:param lossy: Whether to discard metadata that can not be
1007
natively represented
1008
:return: Tuple with the new revision number and revision id
1009
(should only be different from the arguments when lossy=True)
1011
if not self.repository.has_same_location(source.repository):
1012
self.fetch(source, revid)
1013
self.set_last_revision_info(revno, revid)
1014
return (revno, revid)
1016
def revision_id_to_revno(self, revision_id):
1017
"""Given a revision id, return its revno"""
1018
if _mod_revision.is_null(revision_id):
1020
history = self._revision_history()
1022
return history.index(revision_id) + 1
1024
raise errors.NoSuchRevision(self, revision_id)
1026
def get_rev_id(self, revno, history=None):
1027
"""Find the revision id of the specified revno."""
1028
with self.lock_read():
1030
return _mod_revision.NULL_REVISION
1031
last_revno, last_revid = self.last_revision_info()
1032
if revno == last_revno:
1034
if revno <= 0 or revno > last_revno:
1035
raise errors.NoSuchRevision(self, revno)
1036
distance_from_last = last_revno - revno
1037
if len(self._partial_revision_history_cache) <= distance_from_last:
1038
self._extend_partial_history(distance_from_last)
1039
return self._partial_revision_history_cache[distance_from_last]
1041
def pull(self, source, overwrite=False, stop_revision=None,
1042
possible_transports=None, *args, **kwargs):
1043
"""Mirror source into this branch.
1045
This branch is considered to be 'local', having low latency.
1047
:returns: PullResult instance
1049
return InterBranch.get(source, self).pull(
1050
overwrite=overwrite, stop_revision=stop_revision,
1051
possible_transports=possible_transports, *args, **kwargs)
1053
def push(self, target, overwrite=False, stop_revision=None, lossy=False,
1055
"""Mirror this branch into target.
1057
This branch is considered to be 'local', having low latency.
1059
return InterBranch.get(self, target).push(
1060
overwrite, stop_revision, lossy, *args, **kwargs)
1062
def basis_tree(self):
1063
"""Return `Tree` object for last revision."""
1064
return self.repository.revision_tree(self.last_revision())
1066
def get_parent(self):
1067
"""Return the parent location of the branch.
1069
This is the default location for pull/missing. The usual
1070
pattern is that the user can override it by specifying a
1073
parent = self._get_parent_location()
1076
# This is an old-format absolute path to a local branch
1077
# turn it into a url
1078
if parent.startswith('/'):
1079
parent = urlutils.local_path_to_url(parent)
1081
return urlutils.join(self.base[:-1], parent)
1082
except urlutils.InvalidURLJoin:
1083
raise errors.InaccessibleParent(parent, self.user_url)
1085
def _get_parent_location(self):
1086
raise NotImplementedError(self._get_parent_location)
1088
def _set_config_location(self, name, url, config=None,
1089
make_relative=False):
1091
config = self.get_config_stack()
1095
url = urlutils.relative_url(self.base, url)
1096
config.set(name, url)
1098
def _get_config_location(self, name, config=None):
1100
config = self.get_config_stack()
1101
location = config.get(name)
1106
def get_child_submit_format(self):
1107
"""Return the preferred format of submissions to this branch."""
1108
return self.get_config_stack().get('child_submit_format')
1110
def get_submit_branch(self):
1111
"""Return the submit location of the branch.
1113
This is the default location for bundle. The usual
1114
pattern is that the user can override it by specifying a
1117
return self.get_config_stack().get('submit_branch')
1119
def set_submit_branch(self, location):
1120
"""Return the submit location of the branch.
1122
This is the default location for bundle. The usual
1123
pattern is that the user can override it by specifying a
1126
self.get_config_stack().set('submit_branch', location)
1128
def get_public_branch(self):
1129
"""Return the public location of the branch.
1131
This is used by merge directives.
1133
return self._get_config_location('public_branch')
1135
def set_public_branch(self, location):
1136
"""Return the submit location of the branch.
1138
This is the default location for bundle. The usual
1139
pattern is that the user can override it by specifying a
1142
self._set_config_location('public_branch', location)
1144
def get_push_location(self):
1145
"""Return None or the location to push this branch to."""
1146
return self.get_config_stack().get('push_location')
1148
def set_push_location(self, location):
1149
"""Set a new push location for this branch."""
1150
raise NotImplementedError(self.set_push_location)
1152
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1153
"""Run the post_change_branch_tip hooks."""
1154
hooks = Branch.hooks['post_change_branch_tip']
1157
new_revno, new_revid = self.last_revision_info()
1158
params = ChangeBranchTipParams(
1159
self, old_revno, new_revno, old_revid, new_revid)
1163
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1164
"""Run the pre_change_branch_tip hooks."""
1165
hooks = Branch.hooks['pre_change_branch_tip']
1168
old_revno, old_revid = self.last_revision_info()
1169
params = ChangeBranchTipParams(
1170
self, old_revno, new_revno, old_revid, new_revid)
1175
"""Synchronise this branch with the master branch if any.
1177
:return: None or the last_revision pivoted out during the update.
1181
def check_revno(self, revno):
1183
Check whether a revno corresponds to any revision.
1184
Zero (the NULL revision) is considered valid.
1187
self.check_real_revno(revno)
1189
def check_real_revno(self, revno):
1191
Check whether a revno corresponds to a real revision.
1192
Zero (the NULL revision) is considered invalid
1194
if revno < 1 or revno > self.revno():
1195
raise errors.InvalidRevisionNumber(revno)
1197
def clone(self, to_controldir, revision_id=None, repository_policy=None):
1198
"""Clone this branch into to_controldir preserving all semantic values.
1200
Most API users will want 'create_clone_on_transport', which creates a
1201
new bzrdir and branch on the fly.
1203
revision_id: if not None, the revision history in the new branch will
1204
be truncated to end with revision_id.
1206
result = to_controldir.create_branch()
1207
with self.lock_read(), result.lock_write():
1208
if repository_policy is not None:
1209
repository_policy.configure_branch(result)
1210
self.copy_content_into(result, revision_id=revision_id)
1213
def sprout(self, to_controldir, revision_id=None, repository_policy=None,
1214
repository=None, lossy=False):
1215
"""Create a new line of development from the branch, into to_controldir.
1217
to_controldir controls the branch format.
1219
revision_id: if not None, the revision history in the new branch will
1220
be truncated to end with revision_id.
1222
if (repository_policy is not None
1223
and repository_policy.requires_stacking()):
1224
to_controldir._format.require_stacking(_skip_repo=True)
1225
result = to_controldir.create_branch(repository=repository)
1227
raise errors.LossyPushToSameVCS(self, result)
1228
with self.lock_read(), result.lock_write():
1229
if repository_policy is not None:
1230
repository_policy.configure_branch(result)
1231
self.copy_content_into(result, revision_id=revision_id)
1232
master_url = self.get_bound_location()
1233
if master_url is None:
1234
result.set_parent(self.user_url)
1236
result.set_parent(master_url)
1239
def _synchronize_history(self, destination, revision_id):
1240
"""Synchronize last revision and revision history between branches.
1242
This version is most efficient when the destination is also a
1243
BzrBranch6, but works for BzrBranch5, as long as the destination's
1244
repository contains all the lefthand ancestors of the intended
1245
last_revision. If not, set_last_revision_info will fail.
1247
:param destination: The branch to copy the history into
1248
:param revision_id: The revision-id to truncate history at. May
1249
be None to copy complete history.
1251
source_revno, source_revision_id = self.last_revision_info()
1252
if revision_id is None:
1253
revno, revision_id = source_revno, source_revision_id
1255
graph = self.repository.get_graph()
1257
revno = graph.find_distance_to_null(
1258
revision_id, [(source_revision_id, source_revno)])
1259
except errors.GhostRevisionsHaveNoRevno:
1260
# Default to 1, if we can't find anything else
1262
destination.set_last_revision_info(revno, revision_id)
1264
def copy_content_into(self, destination, revision_id=None):
1265
"""Copy the content of self into destination.
1267
revision_id: if not None, the revision history in the new branch will
1268
be truncated to end with revision_id.
1270
return InterBranch.get(self, destination).copy_content_into(
1271
revision_id=revision_id)
1273
def update_references(self, target):
1274
if not self._format.supports_reference_locations:
1276
return InterBranch.get(self, target).update_references()
1278
def check(self, refs):
1279
"""Check consistency of the branch.
1281
In particular this checks that revisions given in the revision-history
1282
do actually match up in the revision graph, and that they're all
1283
present in the repository.
1285
Callers will typically also want to check the repository.
1287
:param refs: Calculated refs for this branch as specified by
1288
branch._get_check_refs()
1289
:return: A BranchCheckResult.
1291
with self.lock_read():
1292
result = BranchCheckResult(self)
1293
last_revno, last_revision_id = self.last_revision_info()
1294
actual_revno = refs[('lefthand-distance', last_revision_id)]
1295
if actual_revno != last_revno:
1296
result.errors.append(errors.BzrCheckError(
1297
'revno does not match len(mainline) %s != %s' % (
1298
last_revno, actual_revno)))
1299
# TODO: We should probably also check that self.revision_history
1300
# matches the repository for older branch formats.
1301
# If looking for the code that cross-checks repository parents
1302
# against the Graph.iter_lefthand_ancestry output, that is now a
1303
# repository specific check.
1306
def _get_checkout_format(self, lightweight=False):
1307
"""Return the most suitable metadir for a checkout of this branch.
1308
Weaves are used if this branch's repository uses weaves.
1310
format = self.repository.controldir.checkout_metadir()
1311
format.set_branch_format(self._format)
1314
def create_clone_on_transport(self, to_transport, revision_id=None,
1315
stacked_on=None, create_prefix=False,
1316
use_existing_dir=False, no_tree=None):
1317
"""Create a clone of this branch and its bzrdir.
1319
:param to_transport: The transport to clone onto.
1320
:param revision_id: The revision id to use as tip in the new branch.
1321
If None the tip is obtained from this branch.
1322
:param stacked_on: An optional URL to stack the clone on.
1323
:param create_prefix: Create any missing directories leading up to
1325
:param use_existing_dir: Use an existing directory if one exists.
1327
# XXX: Fix the bzrdir API to allow getting the branch back from the
1328
# clone call. Or something. 20090224 RBC/spiv.
1329
# XXX: Should this perhaps clone colocated branches as well,
1330
# rather than just the default branch? 20100319 JRV
1331
if revision_id is None:
1332
revision_id = self.last_revision()
1333
dir_to = self.controldir.clone_on_transport(
1334
to_transport, revision_id=revision_id, stacked_on=stacked_on,
1335
create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1337
return dir_to.open_branch()
1339
def create_checkout(self, to_location, revision_id=None,
1340
lightweight=False, accelerator_tree=None,
1341
hardlink=False, recurse_nested=True):
1342
"""Create a checkout of a branch.
1344
:param to_location: The url to produce the checkout at
1345
:param revision_id: The revision to check out
1346
:param lightweight: If True, produce a lightweight checkout, otherwise,
1347
produce a bound branch (heavyweight checkout)
1348
:param accelerator_tree: A tree which can be used for retrieving file
1349
contents more quickly than the revision tree, i.e. a workingtree.
1350
The revision tree will be used for cases where accelerator_tree's
1351
content is different.
1352
:param hardlink: If true, hard-link files from accelerator_tree,
1354
:param recurse_nested: Whether to recurse into nested trees
1355
:return: The tree of the created checkout
1357
t = transport.get_transport(to_location)
1359
format = self._get_checkout_format(lightweight=lightweight)
1361
checkout = format.initialize_on_transport(t)
1362
except errors.AlreadyControlDirError:
1363
# It's fine if the control directory already exists,
1364
# as long as there is no existing branch and working tree.
1365
checkout = controldir.ControlDir.open_from_transport(t)
1367
checkout.open_branch()
1368
except errors.NotBranchError:
1371
raise errors.AlreadyControlDirError(t.base)
1372
if (checkout.control_transport.base
1373
== self.controldir.control_transport.base):
1374
# When checking out to the same control directory,
1375
# always create a lightweight checkout
1379
from_branch = checkout.set_branch_reference(target_branch=self)
1381
policy = checkout.determine_repository_policy()
1382
policy.acquire_repository()
1383
checkout_branch = checkout.create_branch()
1384
checkout_branch.bind(self)
1385
# pull up to the specified revision_id to set the initial
1386
# branch tip correctly, and seed it with history.
1387
checkout_branch.pull(self, stop_revision=revision_id)
1389
tree = checkout.create_workingtree(revision_id,
1390
from_branch=from_branch,
1391
accelerator_tree=accelerator_tree,
1393
basis_tree = tree.basis_tree()
1394
with basis_tree.lock_read():
1395
for path in basis_tree.iter_references():
1396
reference_parent = tree.reference_parent(path)
1397
if reference_parent is None:
1398
warning('Branch location for %s unknown.', path)
1400
reference_parent.create_checkout(
1402
basis_tree.get_reference_revision(path), lightweight)
1405
def reconcile(self, thorough=True):
1406
"""Make sure the data stored in this branch is consistent.
1408
:return: A `ReconcileResult` object.
1410
raise NotImplementedError(self.reconcile)
1412
def supports_tags(self):
1413
return self._format.supports_tags()
1415
def automatic_tag_name(self, revision_id):
1416
"""Try to automatically find the tag name for a revision.
1418
:param revision_id: Revision id of the revision.
1419
:return: A tag name or None if no tag name could be determined.
1421
for hook in Branch.hooks['automatic_tag_name']:
1422
ret = hook(self, revision_id)
1427
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1429
"""Ensure that revision_b is a descendant of revision_a.
1431
This is a helper function for update_revisions.
1433
:raises: DivergedBranches if revision_b has diverged from revision_a.
1434
:returns: True if revision_b is a descendant of revision_a.
1436
relation = self._revision_relations(revision_a, revision_b, graph)
1437
if relation == 'b_descends_from_a':
1439
elif relation == 'diverged':
1440
raise errors.DivergedBranches(self, other_branch)
1441
elif relation == 'a_descends_from_b':
1444
raise AssertionError("invalid relation: %r" % (relation,))
1446
def _revision_relations(self, revision_a, revision_b, graph):
1447
"""Determine the relationship between two revisions.
1449
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1451
heads = graph.heads([revision_a, revision_b])
1452
if heads == {revision_b}:
1453
return 'b_descends_from_a'
1454
elif heads == {revision_a, revision_b}:
1455
# These branches have diverged
1457
elif heads == {revision_a}:
1458
return 'a_descends_from_b'
1460
raise AssertionError("invalid heads: %r" % (heads,))
1462
def heads_to_fetch(self):
1463
"""Return the heads that must and that should be fetched to copy this
1464
branch into another repo.
1466
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1467
set of heads that must be fetched. if_present_fetch is a set of
1468
heads that must be fetched if present, but no error is necessary if
1469
they are not present.
1471
# For bzr native formats must_fetch is just the tip, and
1472
# if_present_fetch are the tags.
1473
must_fetch = {self.last_revision()}
1474
if_present_fetch = set()
1475
if self.get_config_stack().get('branch.fetch_tags'):
1477
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1478
except errors.TagsNotSupported:
1480
must_fetch.discard(_mod_revision.NULL_REVISION)
1481
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1482
return must_fetch, if_present_fetch
1484
def create_memorytree(self):
1485
"""Create a memory tree for this branch.
1487
:return: An in-memory MutableTree instance
1489
return memorytree.MemoryTree.create_on_branch(self)
1492
class BranchFormat(controldir.ControlComponentFormat):
1493
"""An encapsulation of the initialization and open routines for a format.
1495
Formats provide three things:
1496
* An initialization routine,
1497
* a format description
1500
Formats are placed in an dict by their format string for reference
1501
during branch opening. It's not required that these be instances, they
1502
can be classes themselves with class methods - it simply depends on
1503
whether state is needed for a given format or not.
1505
Once a format is deprecated, just deprecate the initialize and open
1506
methods on the format class. Do not deprecate the object, as the
1507
object will be created every time regardless.
1510
def __eq__(self, other):
1511
return self.__class__ is other.__class__
1513
def __ne__(self, other):
1514
return not (self == other)
1516
def get_reference(self, controldir, name=None):
1517
"""Get the target reference of the branch in controldir.
1519
format probing must have been completed before calling
1520
this method - it is assumed that the format of the branch
1521
in controldir is correct.
1523
:param controldir: The controldir to get the branch data from.
1524
:param name: Name of the colocated branch to fetch
1525
:return: None if the branch is not a reference branch.
1530
def set_reference(self, controldir, name, to_branch):
1531
"""Set the target reference of the branch in controldir.
1533
format probing must have been completed before calling
1534
this method - it is assumed that the format of the branch
1535
in controldir is correct.
1537
:param controldir: The controldir to set the branch reference for.
1538
:param name: Name of colocated branch to set, None for default
1539
:param to_branch: branch that the checkout is to reference
1541
raise NotImplementedError(self.set_reference)
1543
def get_format_description(self):
1544
"""Return the short format description for this format."""
1545
raise NotImplementedError(self.get_format_description)
1547
def _run_post_branch_init_hooks(self, controldir, name, branch):
1548
hooks = Branch.hooks['post_branch_init']
1551
params = BranchInitHookParams(self, controldir, name, branch)
1555
def initialize(self, controldir, name=None, repository=None,
1556
append_revisions_only=None):
1557
"""Create a branch of this format in controldir.
1559
:param name: Name of the colocated branch to create.
1561
raise NotImplementedError(self.initialize)
1563
def is_supported(self):
1564
"""Is this format supported?
1566
Supported formats can be initialized and opened.
1567
Unsupported formats may not support initialization or committing or
1568
some other features depending on the reason for not being supported.
1572
def make_tags(self, branch):
1573
"""Create a tags object for branch.
1575
This method is on BranchFormat, because BranchFormats are reflected
1576
over the wire via network_name(), whereas full Branch instances require
1577
multiple VFS method calls to operate at all.
1579
The default implementation returns a disabled-tags instance.
1581
Note that it is normal for branch to be a RemoteBranch when using tags
1584
return _mod_tag.DisabledTags(branch)
1586
def network_name(self):
1587
"""A simple byte string uniquely identifying this format for RPC calls.
1589
MetaDir branch formats use their disk format string to identify the
1590
repository over the wire. All in one formats such as bzr < 0.8, and
1591
foreign formats like svn/git and hg should use some marker which is
1592
unique and immutable.
1594
raise NotImplementedError(self.network_name)
1596
def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
1597
found_repository=None, possible_transports=None):
1598
"""Return the branch object for controldir.
1600
:param controldir: A ControlDir that contains a branch.
1601
:param name: Name of colocated branch to open
1602
:param _found: a private parameter, do not use it. It is used to
1603
indicate if format probing has already be done.
1604
:param ignore_fallbacks: when set, no fallback branches will be opened
1605
(if there are any). Default is to open fallbacks.
1607
raise NotImplementedError(self.open)
1609
def supports_set_append_revisions_only(self):
1610
"""True if this format supports set_append_revisions_only."""
1613
def supports_stacking(self):
1614
"""True if this format records a stacked-on branch."""
1617
def supports_leaving_lock(self):
1618
"""True if this format supports leaving locks in place."""
1619
return False # by default
1622
return self.get_format_description().rstrip()
1624
def supports_tags(self):
1625
"""True if this format supports tags stored in the branch"""
1626
return False # by default
1628
def tags_are_versioned(self):
1629
"""Whether the tag container for this branch versions tags."""
1632
def supports_tags_referencing_ghosts(self):
1633
"""True if tags can reference ghost revisions."""
1636
def supports_store_uncommitted(self):
1637
"""True if uncommitted changes can be stored in this branch."""
1640
def stores_revno(self):
1641
"""True if this branch format store revision numbers."""
1645
class BranchHooks(Hooks):
1646
"""A dictionary mapping hook name to a list of callables for branch hooks.
1648
e.g. ['post_push'] Is the list of items to be called when the
1649
push function is invoked.
1653
"""Create the default hooks.
1655
These are all empty initially, because by default nothing should get
1658
Hooks.__init__(self, "breezy.branch", "Branch.hooks")
1661
"Called with the Branch object that has been opened after a "
1662
"branch is opened.", (1, 8))
1665
"Called after a push operation completes. post_push is called "
1666
"with a breezy.branch.BranchPushResult object and only runs in "
1667
"the bzr client.", (0, 15))
1670
"Called after a pull operation completes. post_pull is called "
1671
"with a breezy.branch.PullResult object and only runs in the "
1672
"bzr client.", (0, 15))
1675
"Called after a commit is calculated but before it is "
1676
"completed. pre_commit is called with (local, master, old_revno, "
1677
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1678
"). old_revid is NULL_REVISION for the first commit to a branch, "
1679
"tree_delta is a TreeDelta object describing changes from the "
1680
"basis revision. hooks MUST NOT modify this delta. "
1681
" future_tree is an in-memory tree obtained from "
1682
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1686
"Called in the bzr client after a commit has completed. "
1687
"post_commit is called with (local, master, old_revno, old_revid, "
1688
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1689
"commit to a branch.", (0, 15))
1692
"Called in the bzr client after an uncommit completes. "
1693
"post_uncommit is called with (local, master, old_revno, "
1694
"old_revid, new_revno, new_revid) where local is the local branch "
1695
"or None, master is the target branch, and an empty branch "
1696
"receives new_revno of 0, new_revid of None.", (0, 15))
1698
'pre_change_branch_tip',
1699
"Called in bzr client and server before a change to the tip of a "
1700
"branch is made. pre_change_branch_tip is called with a "
1701
"breezy.branch.ChangeBranchTipParams. Note that push, pull, "
1702
"commit, uncommit will all trigger this hook.", (1, 6))
1704
'post_change_branch_tip',
1705
"Called in bzr client and server after a change to the tip of a "
1706
"branch is made. post_change_branch_tip is called with a "
1707
"breezy.branch.ChangeBranchTipParams. Note that push, pull, "
1708
"commit, uncommit will all trigger this hook.", (1, 4))
1710
'transform_fallback_location',
1711
"Called when a stacked branch is activating its fallback "
1712
"locations. transform_fallback_location is called with (branch, "
1713
"url), and should return a new url. Returning the same url "
1714
"allows it to be used as-is, returning a different one can be "
1715
"used to cause the branch to stack on a closer copy of that "
1716
"fallback_location. Note that the branch cannot have history "
1717
"accessing methods called on it during this hook because the "
1718
"fallback locations have not been activated. When there are "
1719
"multiple hooks installed for transform_fallback_location, "
1720
"all are called with the url returned from the previous hook."
1721
"The order is however undefined.", (1, 9))
1723
'automatic_tag_name',
1724
"Called to determine an automatic tag name for a revision. "
1725
"automatic_tag_name is called with (branch, revision_id) and "
1726
"should return a tag name or None if no tag name could be "
1727
"determined. The first non-None tag name returned will be used.",
1731
"Called after new branch initialization completes. "
1732
"post_branch_init is called with a "
1733
"breezy.branch.BranchInitHookParams. "
1734
"Note that init, branch and checkout (both heavyweight and "
1735
"lightweight) will all trigger this hook.", (2, 2))
1738
"Called after a checkout switches branch. "
1739
"post_switch is called with a "
1740
"breezy.branch.SwitchHookParams.", (2, 2))
1743
# install the default hooks into the Branch class.
1744
Branch.hooks = BranchHooks()
1747
class ChangeBranchTipParams(object):
1748
"""Object holding parameters passed to `*_change_branch_tip` hooks.
1750
There are 5 fields that hooks may wish to access:
1752
:ivar branch: the branch being changed
1753
:ivar old_revno: revision number before the change
1754
:ivar new_revno: revision number after the change
1755
:ivar old_revid: revision id before the change
1756
:ivar new_revid: revision id after the change
1758
The revid fields are strings. The revno fields are integers.
1761
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1762
"""Create a group of ChangeBranchTip parameters.
1764
:param branch: The branch being changed.
1765
:param old_revno: Revision number before the change.
1766
:param new_revno: Revision number after the change.
1767
:param old_revid: Tip revision id before the change.
1768
:param new_revid: Tip revision id after the change.
1770
self.branch = branch
1771
self.old_revno = old_revno
1772
self.new_revno = new_revno
1773
self.old_revid = old_revid
1774
self.new_revid = new_revid
1776
def __eq__(self, other):
1777
return self.__dict__ == other.__dict__
1780
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1781
self.__class__.__name__, self.branch,
1782
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1785
class BranchInitHookParams(object):
1786
"""Object holding parameters passed to `*_branch_init` hooks.
1788
There are 4 fields that hooks may wish to access:
1790
:ivar format: the branch format
1791
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1792
:ivar name: name of colocated branch, if any (or None)
1793
:ivar branch: the branch created
1795
Note that for lightweight checkouts, the bzrdir and format fields refer to
1796
the checkout, hence they are different from the corresponding fields in
1797
branch, which refer to the original branch.
1800
def __init__(self, format, controldir, name, branch):
1801
"""Create a group of BranchInitHook parameters.
1803
:param format: the branch format
1804
:param controldir: the ControlDir where the branch will be/has been
1806
:param name: name of colocated branch, if any (or None)
1807
:param branch: the branch created
1809
Note that for lightweight checkouts, the bzrdir and format fields refer
1810
to the checkout, hence they are different from the corresponding fields
1811
in branch, which refer to the original branch.
1813
self.format = format
1814
self.controldir = controldir
1816
self.branch = branch
1818
def __eq__(self, other):
1819
return self.__dict__ == other.__dict__
1822
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1825
class SwitchHookParams(object):
1826
"""Object holding parameters passed to `*_switch` hooks.
1828
There are 4 fields that hooks may wish to access:
1830
:ivar control_dir: ControlDir of the checkout to change
1831
:ivar to_branch: branch that the checkout is to reference
1832
:ivar force: skip the check for local commits in a heavy checkout
1833
:ivar revision_id: revision ID to switch to (or None)
1836
def __init__(self, control_dir, to_branch, force, revision_id):
1837
"""Create a group of SwitchHook parameters.
1839
:param control_dir: ControlDir of the checkout to change
1840
:param to_branch: branch that the checkout is to reference
1841
:param force: skip the check for local commits in a heavy checkout
1842
:param revision_id: revision ID to switch to (or None)
1844
self.control_dir = control_dir
1845
self.to_branch = to_branch
1847
self.revision_id = revision_id
1849
def __eq__(self, other):
1850
return self.__dict__ == other.__dict__
1853
return "<%s for %s to (%s, %s)>" % (
1854
self.__class__.__name__, self.control_dir, self.to_branch,
1858
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
1859
"""Branch format registry."""
1861
def __init__(self, other_registry=None):
1862
super(BranchFormatRegistry, self).__init__(other_registry)
1863
self._default_format = None
1864
self._default_format_key = None
1866
def get_default(self):
1867
"""Return the current default format."""
1868
if (self._default_format_key is not None
1869
and self._default_format is None):
1870
self._default_format = self.get(self._default_format_key)
1871
return self._default_format
1873
def set_default(self, format):
1874
"""Set the default format."""
1875
self._default_format = format
1876
self._default_format_key = None
1878
def set_default_key(self, format_string):
1879
"""Set the default format by its format string."""
1880
self._default_format_key = format_string
1881
self._default_format = None
1884
network_format_registry = registry.FormatRegistry()
1885
"""Registry of formats indexed by their network name.
1887
The network name for a branch format is an identifier that can be used when
1888
referring to formats with smart server operations. See
1889
BranchFormat.network_name() for more detail.
1892
format_registry = BranchFormatRegistry(network_format_registry)
1895
# formats which have no format string are not discoverable
1896
# and not independently creatable, so are not registered.
1897
format_registry.register_lazy(
1898
b"Bazaar-NG branch format 5\n", "breezy.bzr.fullhistory",
1900
format_registry.register_lazy(
1901
b"Bazaar Branch Format 6 (bzr 0.15)\n",
1902
"breezy.bzr.branch", "BzrBranchFormat6")
1903
format_registry.register_lazy(
1904
b"Bazaar Branch Format 7 (needs bzr 1.6)\n",
1905
"breezy.bzr.branch", "BzrBranchFormat7")
1906
format_registry.register_lazy(
1907
b"Bazaar Branch Format 8 (needs bzr 1.15)\n",
1908
"breezy.bzr.branch", "BzrBranchFormat8")
1909
format_registry.register_lazy(
1910
b"Bazaar-NG Branch Reference Format 1\n",
1911
"breezy.bzr.branch", "BranchReferenceFormat")
1913
format_registry.set_default_key(b"Bazaar Branch Format 7 (needs bzr 1.6)\n")
1916
class BranchWriteLockResult(LogicalLockResult):
1917
"""The result of write locking a branch.
1919
:ivar token: The token obtained from the underlying branch lock, or
1921
:ivar unlock: A callable which will unlock the lock.
1925
return "BranchWriteLockResult(%r, %r)" % (self.unlock, self.token)
1928
######################################################################
1929
# results of operations
1932
class _Result(object):
1934
def _show_tag_conficts(self, to_file):
1935
if not getattr(self, 'tag_conflicts', None):
1937
to_file.write('Conflicting tags:\n')
1938
for name, value1, value2 in self.tag_conflicts:
1939
to_file.write(' %s\n' % (name, ))
1942
class PullResult(_Result):
1943
"""Result of a Branch.pull operation.
1945
:ivar old_revno: Revision number before pull.
1946
:ivar new_revno: Revision number after pull.
1947
:ivar old_revid: Tip revision id before pull.
1948
:ivar new_revid: Tip revision id after pull.
1949
:ivar source_branch: Source (local) branch object. (read locked)
1950
:ivar master_branch: Master branch of the target, or the target if no
1952
:ivar local_branch: target branch if there is a Master, else None
1953
:ivar target_branch: Target/destination branch object. (write locked)
1954
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
1955
:ivar tag_updates: A dict with new tags, see BasicTags.merge_to
1958
def report(self, to_file):
1959
tag_conflicts = getattr(self, "tag_conflicts", None)
1960
tag_updates = getattr(self, "tag_updates", None)
1962
if self.old_revid != self.new_revid:
1963
to_file.write('Now on revision %d.\n' % self.new_revno)
1965
to_file.write('%d tag(s) updated.\n' % len(tag_updates))
1966
if self.old_revid == self.new_revid and not tag_updates:
1967
if not tag_conflicts:
1968
to_file.write('No revisions or tags to pull.\n')
1970
to_file.write('No revisions to pull.\n')
1971
self._show_tag_conficts(to_file)
1974
class BranchPushResult(_Result):
1975
"""Result of a Branch.push operation.
1977
:ivar old_revno: Revision number (eg 10) of the target before push.
1978
:ivar new_revno: Revision number (eg 12) of the target after push.
1979
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
1981
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
1983
:ivar source_branch: Source branch object that the push was from. This is
1984
read locked, and generally is a local (and thus low latency) branch.
1985
:ivar master_branch: If target is a bound branch, the master branch of
1986
target, or target itself. Always write locked.
1987
:ivar target_branch: The direct Branch where data is being sent (write
1989
:ivar local_branch: If the target is a bound branch this will be the
1990
target, otherwise it will be None.
1993
def report(self, to_file):
1994
# TODO: This function gets passed a to_file, but then
1995
# ignores it and calls note() instead. This is also
1996
# inconsistent with PullResult(), which writes to stdout.
1997
# -- JRV20110901, bug #838853
1998
tag_conflicts = getattr(self, "tag_conflicts", None)
1999
tag_updates = getattr(self, "tag_updates", None)
2001
if self.old_revid != self.new_revid:
2002
if self.new_revno is not None:
2003
note(gettext('Pushed up to revision %d.'),
2006
note(gettext('Pushed up to revision id %s.'),
2007
self.new_revid.decode('utf-8'))
2009
note(ngettext('%d tag updated.', '%d tags updated.',
2010
len(tag_updates)) % len(tag_updates))
2011
if self.old_revid == self.new_revid and not tag_updates:
2012
if not tag_conflicts:
2013
note(gettext('No new revisions or tags to push.'))
2015
note(gettext('No new revisions to push.'))
2016
self._show_tag_conficts(to_file)
2019
class BranchCheckResult(object):
2020
"""Results of checking branch consistency.
2025
def __init__(self, branch):
2026
self.branch = branch
2029
def report_results(self, verbose):
2030
"""Report the check results via trace.note.
2032
:param verbose: Requests more detailed display of what was checked,
2035
note(gettext('checked branch {0} format {1}').format(
2036
self.branch.user_url, self.branch._format))
2037
for error in self.errors:
2038
note(gettext('found error:%s'), error)
2041
class InterBranch(InterObject):
2042
"""This class represents operations taking place between two branches.
2044
Its instances have methods like pull() and push() and contain
2045
references to the source and target repositories these operations
2046
can be carried out on.
2050
"""The available optimised InterBranch types."""
2053
def _get_branch_formats_to_test(klass):
2054
"""Return an iterable of format tuples for testing.
2056
:return: An iterable of (from_format, to_format) to use when testing
2057
this InterBranch class. Each InterBranch class should define this
2060
raise NotImplementedError(klass._get_branch_formats_to_test)
2062
def pull(self, overwrite=False, stop_revision=None,
2063
possible_transports=None, local=False):
2064
"""Mirror source into target branch.
2066
The target branch is considered to be 'local', having low latency.
2068
:returns: PullResult instance
2070
raise NotImplementedError(self.pull)
2072
def push(self, overwrite=False, stop_revision=None, lossy=False,
2073
_override_hook_source_branch=None):
2074
"""Mirror the source branch into the target branch.
2076
The source branch is considered to be 'local', having low latency.
2078
raise NotImplementedError(self.push)
2080
def copy_content_into(self, revision_id=None):
2081
"""Copy the content of source into target
2083
revision_id: if not None, the revision history in the new branch will
2084
be truncated to end with revision_id.
2086
raise NotImplementedError(self.copy_content_into)
2088
def fetch(self, stop_revision=None, limit=None, lossy=False):
2091
:param stop_revision: Last revision to fetch
2092
:param limit: Optional rough limit of revisions to fetch
2093
:return: FetchResult object
2095
raise NotImplementedError(self.fetch)
2097
def update_references(self):
2098
"""Import reference information from source to target.
2100
raise NotImplementedError(self.update_references)
2103
def _fix_overwrite_type(overwrite):
2104
if isinstance(overwrite, bool):
2106
return ["history", "tags"]
2112
class GenericInterBranch(InterBranch):
2113
"""InterBranch implementation that uses public Branch functions."""
2116
def is_compatible(klass, source, target):
2117
# GenericBranch uses the public API, so always compatible
2121
def _get_branch_formats_to_test(klass):
2122
return [(format_registry.get_default(), format_registry.get_default())]
2125
def unwrap_format(klass, format):
2126
if isinstance(format, remote.RemoteBranchFormat):
2127
format._ensure_real()
2128
return format._custom_format
2131
def copy_content_into(self, revision_id=None):
2132
"""Copy the content of source into target
2134
revision_id: if not None, the revision history in the new branch will
2135
be truncated to end with revision_id.
2137
with self.source.lock_read(), self.target.lock_write():
2138
self.source._synchronize_history(self.target, revision_id)
2139
self.update_references()
2141
parent = self.source.get_parent()
2142
except errors.InaccessibleParent as e:
2143
mutter('parent was not accessible to copy: %s', str(e))
2146
self.target.set_parent(parent)
2147
if self.source._push_should_merge_tags():
2148
self.source.tags.merge_to(self.target.tags)
2150
def fetch(self, stop_revision=None, limit=None, lossy=False):
2151
if self.target.base == self.source.base:
2153
with self.source.lock_read(), self.target.lock_write():
2154
fetch_spec_factory = fetch.FetchSpecFactory()
2155
fetch_spec_factory.source_branch = self.source
2156
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
2157
fetch_spec_factory.source_repo = self.source.repository
2158
fetch_spec_factory.target_repo = self.target.repository
2159
fetch_spec_factory.target_repo_kind = (
2160
fetch.TargetRepoKinds.PREEXISTING)
2161
fetch_spec_factory.limit = limit
2162
fetch_spec = fetch_spec_factory.make_fetch_spec()
2163
return self.target.repository.fetch(
2164
self.source.repository,
2166
fetch_spec=fetch_spec)
2168
def _update_revisions(self, stop_revision=None, overwrite=False,
2170
with self.source.lock_read(), self.target.lock_write():
2171
other_revno, other_last_revision = self.source.last_revision_info()
2172
stop_revno = None # unknown
2173
if stop_revision is None:
2174
stop_revision = other_last_revision
2175
if _mod_revision.is_null(stop_revision):
2176
# if there are no commits, we're done.
2178
stop_revno = other_revno
2180
# what's the current last revision, before we fetch [and change it
2182
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2183
# we fetch here so that we don't process data twice in the common
2184
# case of having something to pull, and so that the check for
2185
# already merged can operate on the just fetched graph, which will
2186
# be cached in memory.
2187
self.fetch(stop_revision=stop_revision)
2188
# Check to see if one is an ancestor of the other
2191
graph = self.target.repository.get_graph()
2192
if self.target._check_if_descendant_or_diverged(
2193
stop_revision, last_rev, graph, self.source):
2194
# stop_revision is a descendant of last_rev, but we aren't
2195
# overwriting, so we're done.
2197
if stop_revno is None:
2199
graph = self.target.repository.get_graph()
2200
this_revno, this_last_revision = \
2201
self.target.last_revision_info()
2202
stop_revno = graph.find_distance_to_null(
2203
stop_revision, [(other_last_revision, other_revno),
2204
(this_last_revision, this_revno)])
2205
self.target.set_last_revision_info(stop_revno, stop_revision)
2207
def pull(self, overwrite=False, stop_revision=None,
2208
possible_transports=None, run_hooks=True,
2209
_override_hook_target=None, local=False):
2210
"""Pull from source into self, updating my master if any.
2212
:param run_hooks: Private parameter - if false, this branch
2213
is being called because it's the master of the primary branch,
2214
so it should not run its hooks.
2216
with cleanup.ExitStack() as exit_stack:
2217
exit_stack.enter_context(self.target.lock_write())
2218
bound_location = self.target.get_bound_location()
2219
if local and not bound_location:
2220
raise errors.LocalRequiresBoundBranch()
2221
master_branch = None
2222
source_is_master = False
2224
# bound_location comes from a config file, some care has to be
2225
# taken to relate it to source.user_url
2226
normalized = urlutils.normalize_url(bound_location)
2228
relpath = self.source.user_transport.relpath(normalized)
2229
source_is_master = (relpath == '')
2230
except (errors.PathNotChild, urlutils.InvalidURL):
2231
source_is_master = False
2232
if not local and bound_location and not source_is_master:
2233
# not pulling from master, so we need to update master.
2234
master_branch = self.target.get_master_branch(
2235
possible_transports)
2236
exit_stack.enter_context(master_branch.lock_write())
2238
# pull from source into master.
2240
self.source, overwrite, stop_revision, run_hooks=False)
2242
overwrite, stop_revision, _hook_master=master_branch,
2243
run_hooks=run_hooks,
2244
_override_hook_target=_override_hook_target,
2245
merge_tags_to_master=not source_is_master)
2247
def push(self, overwrite=False, stop_revision=None, lossy=False,
2248
_override_hook_source_branch=None):
2249
"""See InterBranch.push.
2251
This is the basic concrete implementation of push()
2253
:param _override_hook_source_branch: If specified, run the hooks
2254
passing this Branch as the source, rather than self. This is for
2255
use of RemoteBranch, where push is delegated to the underlying
2259
raise errors.LossyPushToSameVCS(self.source, self.target)
2260
# TODO: Public option to disable running hooks - should be trivial but
2264
if _override_hook_source_branch:
2265
result.source_branch = _override_hook_source_branch
2266
for hook in Branch.hooks['post_push']:
2269
with self.source.lock_read(), self.target.lock_write():
2270
bound_location = self.target.get_bound_location()
2271
if bound_location and self.target.base != bound_location:
2272
# there is a master branch.
2274
# XXX: Why the second check? Is it even supported for a branch
2275
# to be bound to itself? -- mbp 20070507
2276
master_branch = self.target.get_master_branch()
2277
with master_branch.lock_write():
2278
# push into the master from the source branch.
2279
master_inter = InterBranch.get(self.source, master_branch)
2280
master_inter._basic_push(overwrite, stop_revision)
2281
# and push into the target branch from the source. Note
2282
# that we push from the source branch again, because it's
2283
# considered the highest bandwidth repository.
2284
result = self._basic_push(overwrite, stop_revision)
2285
result.master_branch = master_branch
2286
result.local_branch = self.target
2289
master_branch = None
2291
result = self._basic_push(overwrite, stop_revision)
2292
# TODO: Why set master_branch and local_branch if there's no
2293
# binding? Maybe cleaner to just leave them unset? -- mbp
2295
result.master_branch = self.target
2296
result.local_branch = None
2300
def _basic_push(self, overwrite, stop_revision):
2301
"""Basic implementation of push without bound branches or hooks.
2303
Must be called with source read locked and target write locked.
2305
result = BranchPushResult()
2306
result.source_branch = self.source
2307
result.target_branch = self.target
2308
result.old_revno, result.old_revid = self.target.last_revision_info()
2309
overwrite = _fix_overwrite_type(overwrite)
2310
if result.old_revid != stop_revision:
2311
# We assume that during 'push' this repository is closer than
2313
graph = self.source.repository.get_graph(self.target.repository)
2314
self._update_revisions(
2315
stop_revision, overwrite=("history" in overwrite), graph=graph)
2316
if self.source._push_should_merge_tags():
2317
result.tag_updates, result.tag_conflicts = (
2318
self.source.tags.merge_to(
2319
self.target.tags, "tags" in overwrite))
2320
self.update_references()
2321
result.new_revno, result.new_revid = self.target.last_revision_info()
2324
def _pull(self, overwrite=False, stop_revision=None,
2325
possible_transports=None, _hook_master=None, run_hooks=True,
2326
_override_hook_target=None, local=False,
2327
merge_tags_to_master=True):
2330
This function is the core worker, used by GenericInterBranch.pull to
2331
avoid duplication when pulling source->master and source->local.
2333
:param _hook_master: Private parameter - set the branch to
2334
be supplied as the master to pull hooks.
2335
:param run_hooks: Private parameter - if false, this branch
2336
is being called because it's the master of the primary branch,
2337
so it should not run its hooks.
2338
is being called because it's the master of the primary branch,
2339
so it should not run its hooks.
2340
:param _override_hook_target: Private parameter - set the branch to be
2341
supplied as the target_branch to pull hooks.
2342
:param local: Only update the local branch, and not the bound branch.
2344
# This type of branch can't be bound.
2346
raise errors.LocalRequiresBoundBranch()
2347
result = PullResult()
2348
result.source_branch = self.source
2349
if _override_hook_target is None:
2350
result.target_branch = self.target
2352
result.target_branch = _override_hook_target
2353
with self.source.lock_read():
2354
# We assume that during 'pull' the target repository is closer than
2356
graph = self.target.repository.get_graph(self.source.repository)
2357
# TODO: Branch formats should have a flag that indicates
2358
# that revno's are expensive, and pull() should honor that flag.
2360
result.old_revno, result.old_revid = \
2361
self.target.last_revision_info()
2362
overwrite = _fix_overwrite_type(overwrite)
2363
self._update_revisions(
2364
stop_revision, overwrite=("history" in overwrite), graph=graph)
2365
# TODO: The old revid should be specified when merging tags,
2366
# so a tags implementation that versions tags can only
2367
# pull in the most recent changes. -- JRV20090506
2368
result.tag_updates, result.tag_conflicts = (
2369
self.source.tags.merge_to(
2370
self.target.tags, "tags" in overwrite,
2371
ignore_master=not merge_tags_to_master))
2372
self.update_references()
2373
result.new_revno, result.new_revid = (
2374
self.target.last_revision_info())
2376
result.master_branch = _hook_master
2377
result.local_branch = result.target_branch
2379
result.master_branch = result.target_branch
2380
result.local_branch = None
2382
for hook in Branch.hooks['post_pull']:
2386
def update_references(self):
2387
if not getattr(self.source._format, 'supports_reference_locations', False):
2389
reference_dict = self.source._get_all_reference_info()
2390
if len(reference_dict) == 0:
2392
old_base = self.source.base
2393
new_base = self.target.base
2394
target_reference_dict = self.target._get_all_reference_info()
2395
for tree_path, (branch_location, file_id) in viewitems(reference_dict):
2397
branch_location = urlutils.rebase_url(branch_location,
2399
except urlutils.InvalidRebaseURLs:
2400
# Fall back to absolute URL
2401
branch_location = urlutils.join(old_base, branch_location)
2402
target_reference_dict.setdefault(
2403
tree_path, (branch_location, file_id))
2404
self.target._set_all_reference_info(target_reference_dict)
2407
InterBranch.register_optimiser(GenericInterBranch)
added
removed
breezy/branch.py
