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
21
from .lazy_import import lazy_import
22
lazy_import(globals(), """
26
config as _mod_config,
30
revision as _mod_revision,
36
from breezy.bzr import (
40
from breezy.i18n import gettext, ngettext
47
from .decorators import (
50
from .hooks import Hooks
51
from .inter import InterObject
52
from .lock import LogicalLockResult
57
from .trace import mutter, mutter_callsite, note, is_quiet
60
class UnstackableBranchFormat(errors.BzrError):
62
_fmt = ("The branch '%(url)s'(%(format)s) is not a stackable format. "
63
"You will need to upgrade the branch to permit branch stacking.")
65
def __init__(self, format, url):
66
errors.BzrError.__init__(self)
71
class Branch(controldir.ControlComponent):
72
"""Branch holding a history of revisions.
75
Base directory/url of the branch; using control_url and
76
control_transport is more standardized.
77
:ivar hooks: An instance of BranchHooks.
78
:ivar _master_branch_cache: cached result of get_master_branch, see
81
# this is really an instance variable - FIXME move it there
86
def control_transport(self):
87
return self._transport
90
def user_transport(self):
91
return self.controldir.user_transport
93
def __init__(self, possible_transports=None):
94
self.tags = self._format.make_tags(self)
95
self._revision_history_cache = None
96
self._revision_id_to_revno_cache = None
97
self._partial_revision_id_to_revno_cache = {}
98
self._partial_revision_history_cache = []
99
self._tags_bytes = None
100
self._last_revision_info_cache = None
101
self._master_branch_cache = None
102
self._merge_sorted_revisions_cache = None
103
self._open_hook(possible_transports)
104
hooks = Branch.hooks['open']
108
def _open_hook(self, possible_transports):
109
"""Called by init to allow simpler extension of the base class."""
111
def _activate_fallback_location(self, url, possible_transports):
112
"""Activate the branch/repository from url as a fallback repository."""
113
for existing_fallback_repo in self.repository._fallback_repositories:
114
if existing_fallback_repo.user_url == url:
115
# This fallback is already configured. This probably only
116
# happens because ControlDir.sprout is a horrible mess. To
117
# avoid confusing _unstack we don't add this a second time.
118
mutter('duplicate activation of fallback %r on %r', url, self)
120
repo = self._get_fallback_repository(url, possible_transports)
121
if repo.has_same_location(self.repository):
122
raise errors.UnstackableLocationError(self.user_url, url)
123
self.repository.add_fallback_repository(repo)
125
def break_lock(self):
126
"""Break a lock if one is present from another instance.
128
Uses the ui factory to ask for confirmation if the lock may be from
131
This will probe the repository for its lock as well.
133
self.control_files.break_lock()
134
self.repository.break_lock()
135
master = self.get_master_branch()
136
if master is not None:
139
def _check_stackable_repo(self):
140
if not self.repository._format.supports_external_lookups:
141
raise errors.UnstackableRepositoryFormat(
142
self.repository._format, self.repository.base)
144
def _extend_partial_history(self, stop_index=None, stop_revision=None):
145
"""Extend the partial history to include a given index
147
If a stop_index is supplied, stop when that index has been reached.
148
If a stop_revision is supplied, stop when that revision is
149
encountered. Otherwise, stop when the beginning of history is
152
:param stop_index: The index which should be present. When it is
153
present, history extension will stop.
154
:param stop_revision: The revision id which should be present. When
155
it is encountered, history extension will stop.
157
if len(self._partial_revision_history_cache) == 0:
158
self._partial_revision_history_cache = [self.last_revision()]
159
repository._iter_for_revno(
160
self.repository, self._partial_revision_history_cache,
161
stop_index=stop_index, stop_revision=stop_revision)
162
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
163
self._partial_revision_history_cache.pop()
165
def _get_check_refs(self):
166
"""Get the references needed for check().
170
revid = self.last_revision()
171
return [('revision-existence', revid), ('lefthand-distance', revid)]
174
def open(base, _unsupported=False, possible_transports=None):
175
"""Open the branch rooted at base.
177
For instance, if the branch is at URL/.bzr/branch,
178
Branch.open(URL) -> a Branch instance.
180
control = controldir.ControlDir.open(base,
181
possible_transports=possible_transports, _unsupported=_unsupported)
182
return control.open_branch(unsupported=_unsupported,
183
possible_transports=possible_transports)
186
def open_from_transport(transport, name=None, _unsupported=False,
187
possible_transports=None):
188
"""Open the branch rooted at transport"""
189
control = controldir.ControlDir.open_from_transport(transport, _unsupported)
190
return control.open_branch(name=name, unsupported=_unsupported,
191
possible_transports=possible_transports)
194
def open_containing(url, possible_transports=None):
195
"""Open an existing branch which contains url.
197
This probes for a branch at url, and searches upwards from there.
199
Basically we keep looking up until we find the control directory or
200
run into the root. If there isn't one, raises NotBranchError.
201
If there is one and it is either an unrecognised format or an unsupported
202
format, UnknownFormatError or UnsupportedFormatError are raised.
203
If there is one, it is returned, along with the unused portion of url.
205
control, relpath = controldir.ControlDir.open_containing(url,
207
branch = control.open_branch(possible_transports=possible_transports)
208
return (branch, relpath)
210
def _push_should_merge_tags(self):
211
"""Should _basic_push merge this branch's tags into the target?
213
The default implementation returns False if this branch has no tags,
214
and True the rest of the time. Subclasses may override this.
216
return self.supports_tags() and self.tags.get_tag_dict()
218
def get_config(self):
219
"""Get a breezy.config.BranchConfig for this Branch.
221
This can then be used to get and set configuration options for the
224
:return: A breezy.config.BranchConfig.
226
return _mod_config.BranchConfig(self)
228
def get_config_stack(self):
229
"""Get a breezy.config.BranchStack for this Branch.
231
This can then be used to get and set configuration options for the
234
:return: A breezy.config.BranchStack.
236
return _mod_config.BranchStack(self)
238
def store_uncommitted(self, creator):
239
"""Store uncommitted changes from a ShelfCreator.
241
:param creator: The ShelfCreator containing uncommitted changes, or
242
None to delete any stored changes.
243
:raises: ChangesAlreadyStored if the branch already has changes.
245
raise NotImplementedError(self.store_uncommitted)
247
def get_unshelver(self, tree):
248
"""Return a shelf.Unshelver for this branch and tree.
250
:param tree: The tree to use to construct the Unshelver.
251
:return: an Unshelver or None if no changes are stored.
253
raise NotImplementedError(self.get_unshelver)
255
def _get_fallback_repository(self, url, possible_transports):
256
"""Get the repository we fallback to at url."""
257
url = urlutils.join(self.base, url)
258
a_branch = Branch.open(url, possible_transports=possible_transports)
259
return a_branch.repository
261
def _get_tags_bytes(self):
262
"""Get the bytes of a serialised tags dict.
264
Note that not all branches support tags, nor do all use the same tags
265
logic: this method is specific to BasicTags. Other tag implementations
266
may use the same method name and behave differently, safely, because
267
of the double-dispatch via
268
format.make_tags->tags_instance->get_tags_dict.
270
:return: The bytes of the tags file.
271
:seealso: Branch._set_tags_bytes.
273
with self.lock_read():
274
if self._tags_bytes is None:
275
self._tags_bytes = self._transport.get_bytes('tags')
276
return self._tags_bytes
278
def _get_nick(self, local=False, possible_transports=None):
279
config = self.get_config()
280
# explicit overrides master, but don't look for master if local is True
281
if not local and not config.has_explicit_nickname():
283
master = self.get_master_branch(possible_transports)
284
if master and self.user_url == master.user_url:
285
raise errors.RecursiveBind(self.user_url)
286
if master is not None:
287
# return the master branch value
289
except errors.RecursiveBind as e:
291
except errors.BzrError as e:
292
# Silently fall back to local implicit nick if the master is
294
mutter("Could not connect to bound branch, "
295
"falling back to local nick.\n " + str(e))
296
return config.get_nickname()
298
def _set_nick(self, nick):
299
self.get_config().set_user_option('nickname', nick, warn_masked=True)
301
nick = property(_get_nick, _set_nick)
304
raise NotImplementedError(self.is_locked)
306
def _lefthand_history(self, revision_id, last_rev=None,
308
if 'evil' in debug.debug_flags:
309
mutter_callsite(4, "_lefthand_history scales with history.")
310
# stop_revision must be a descendant of last_revision
311
graph = self.repository.get_graph()
312
if last_rev is not None:
313
if not graph.is_ancestor(last_rev, revision_id):
314
# our previous tip is not merged into stop_revision
315
raise errors.DivergedBranches(self, other_branch)
316
# make a new revision history from the graph
317
parents_map = graph.get_parent_map([revision_id])
318
if revision_id not in parents_map:
319
raise errors.NoSuchRevision(self, revision_id)
320
current_rev_id = revision_id
322
check_not_reserved_id = _mod_revision.check_not_reserved_id
323
# Do not include ghosts or graph origin in revision_history
324
while (current_rev_id in parents_map and
325
len(parents_map[current_rev_id]) > 0):
326
check_not_reserved_id(current_rev_id)
327
new_history.append(current_rev_id)
328
current_rev_id = parents_map[current_rev_id][0]
329
parents_map = graph.get_parent_map([current_rev_id])
330
new_history.reverse()
333
def lock_write(self, token=None):
334
"""Lock the branch for write operations.
336
:param token: A token to permit reacquiring a previously held and
338
:return: A BranchWriteLockResult.
340
raise NotImplementedError(self.lock_write)
343
"""Lock the branch for read operations.
345
:return: A breezy.lock.LogicalLockResult.
347
raise NotImplementedError(self.lock_read)
350
raise NotImplementedError(self.unlock)
352
def peek_lock_mode(self):
353
"""Return lock mode for the Branch: 'r', 'w' or None"""
354
raise NotImplementedError(self.peek_lock_mode)
356
def get_physical_lock_status(self):
357
raise NotImplementedError(self.get_physical_lock_status)
359
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
360
"""Return the revision_id for a dotted revno.
362
:param revno: a tuple like (1,) or (1,1,2)
363
:param _cache_reverse: a private parameter enabling storage
364
of the reverse mapping in a top level cache. (This should
365
only be done in selective circumstances as we want to
366
avoid having the mapping cached multiple times.)
367
:return: the revision_id
368
:raises errors.NoSuchRevision: if the revno doesn't exist
370
with self.lock_read():
371
rev_id = self._do_dotted_revno_to_revision_id(revno)
373
self._partial_revision_id_to_revno_cache[rev_id] = revno
376
def _do_dotted_revno_to_revision_id(self, revno):
377
"""Worker function for dotted_revno_to_revision_id.
379
Subclasses should override this if they wish to
380
provide a more efficient implementation.
383
return self.get_rev_id(revno[0])
384
revision_id_to_revno = self.get_revision_id_to_revno_map()
385
revision_ids = [revision_id for revision_id, this_revno
386
in viewitems(revision_id_to_revno)
387
if revno == this_revno]
388
if len(revision_ids) == 1:
389
return revision_ids[0]
391
revno_str = '.'.join(map(str, revno))
392
raise errors.NoSuchRevision(self, revno_str)
394
def revision_id_to_dotted_revno(self, revision_id):
395
"""Given a revision id, return its dotted revno.
397
:return: a tuple like (1,) or (400,1,3).
399
with self.lock_read():
400
return self._do_revision_id_to_dotted_revno(revision_id)
402
def _do_revision_id_to_dotted_revno(self, revision_id):
403
"""Worker function for revision_id_to_revno."""
404
# Try the caches if they are loaded
405
result = self._partial_revision_id_to_revno_cache.get(revision_id)
406
if result is not None:
408
if self._revision_id_to_revno_cache:
409
result = self._revision_id_to_revno_cache.get(revision_id)
411
raise errors.NoSuchRevision(self, revision_id)
412
# Try the mainline as it's optimised
414
revno = self.revision_id_to_revno(revision_id)
416
except errors.NoSuchRevision:
417
# We need to load and use the full revno map after all
418
result = self.get_revision_id_to_revno_map().get(revision_id)
420
raise errors.NoSuchRevision(self, revision_id)
423
def get_revision_id_to_revno_map(self):
424
"""Return the revision_id => dotted revno map.
426
This will be regenerated on demand, but will be cached.
428
:return: A dictionary mapping revision_id => dotted revno.
429
This dictionary should not be modified by the caller.
431
with self.lock_read():
432
if self._revision_id_to_revno_cache is not None:
433
mapping = self._revision_id_to_revno_cache
435
mapping = self._gen_revno_map()
436
self._cache_revision_id_to_revno(mapping)
437
# TODO: jam 20070417 Since this is being cached, should we be returning
439
# I would rather not, and instead just declare that users should not
440
# modify the return value.
443
def _gen_revno_map(self):
444
"""Create a new mapping from revision ids to dotted revnos.
446
Dotted revnos are generated based on the current tip in the revision
448
This is the worker function for get_revision_id_to_revno_map, which
449
just caches the return value.
451
:return: A dictionary mapping revision_id => dotted revno.
453
revision_id_to_revno = dict((rev_id, revno)
454
for rev_id, depth, revno, end_of_merge
455
in self.iter_merge_sorted_revisions())
456
return revision_id_to_revno
458
def iter_merge_sorted_revisions(self, start_revision_id=None,
459
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
460
"""Walk the revisions for a branch in merge sorted order.
462
Merge sorted order is the output from a merge-aware,
463
topological sort, i.e. all parents come before their
464
children going forward; the opposite for reverse.
466
:param start_revision_id: the revision_id to begin walking from.
467
If None, the branch tip is used.
468
:param stop_revision_id: the revision_id to terminate the walk
469
after. If None, the rest of history is included.
470
:param stop_rule: if stop_revision_id is not None, the precise rule
471
to use for termination:
473
* 'exclude' - leave the stop revision out of the result (default)
474
* 'include' - the stop revision is the last item in the result
475
* 'with-merges' - include the stop revision and all of its
476
merged revisions in the result
477
* 'with-merges-without-common-ancestry' - filter out revisions
478
that are in both ancestries
479
:param direction: either 'reverse' or 'forward':
481
* reverse means return the start_revision_id first, i.e.
482
start at the most recent revision and go backwards in history
483
* forward returns tuples in the opposite order to reverse.
484
Note in particular that forward does *not* do any intelligent
485
ordering w.r.t. depth as some clients of this API may like.
486
(If required, that ought to be done at higher layers.)
488
:return: an iterator over (revision_id, depth, revno, end_of_merge)
491
* revision_id: the unique id of the revision
492
* depth: How many levels of merging deep this node has been
494
* revno_sequence: This field provides a sequence of
495
revision numbers for all revisions. The format is:
496
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
497
branch that the revno is on. From left to right the REVNO numbers
498
are the sequence numbers within that branch of the revision.
499
* end_of_merge: When True the next node (earlier in history) is
500
part of a different merge.
502
with self.lock_read():
503
# Note: depth and revno values are in the context of the branch so
504
# we need the full graph to get stable numbers, regardless of the
506
if self._merge_sorted_revisions_cache is None:
507
last_revision = self.last_revision()
508
known_graph = self.repository.get_known_graph_ancestry(
510
self._merge_sorted_revisions_cache = known_graph.merge_sort(
512
filtered = self._filter_merge_sorted_revisions(
513
self._merge_sorted_revisions_cache, start_revision_id,
514
stop_revision_id, stop_rule)
515
# Make sure we don't return revisions that are not part of the
516
# start_revision_id ancestry.
517
filtered = self._filter_start_non_ancestors(filtered)
518
if direction == 'reverse':
520
if direction == 'forward':
521
return reversed(list(filtered))
523
raise ValueError('invalid direction %r' % direction)
525
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
526
start_revision_id, stop_revision_id, stop_rule):
527
"""Iterate over an inclusive range of sorted revisions."""
528
rev_iter = iter(merge_sorted_revisions)
529
if start_revision_id is not None:
530
for node in rev_iter:
532
if rev_id != start_revision_id:
535
# The decision to include the start or not
536
# depends on the stop_rule if a stop is provided
537
# so pop this node back into the iterator
538
rev_iter = itertools.chain(iter([node]), rev_iter)
540
if stop_revision_id is None:
542
for node in rev_iter:
544
yield (rev_id, node.merge_depth, node.revno,
546
elif stop_rule == 'exclude':
547
for node in rev_iter:
549
if rev_id == stop_revision_id:
551
yield (rev_id, node.merge_depth, node.revno,
553
elif stop_rule == 'include':
554
for node in rev_iter:
556
yield (rev_id, node.merge_depth, node.revno,
558
if rev_id == stop_revision_id:
560
elif stop_rule == 'with-merges-without-common-ancestry':
561
# We want to exclude all revisions that are already part of the
562
# stop_revision_id ancestry.
563
graph = self.repository.get_graph()
564
ancestors = graph.find_unique_ancestors(start_revision_id,
566
for node in rev_iter:
568
if rev_id not in ancestors:
570
yield (rev_id, node.merge_depth, node.revno,
572
elif stop_rule == 'with-merges':
573
stop_rev = self.repository.get_revision(stop_revision_id)
574
if stop_rev.parent_ids:
575
left_parent = stop_rev.parent_ids[0]
577
left_parent = _mod_revision.NULL_REVISION
578
# left_parent is the actual revision we want to stop logging at,
579
# since we want to show the merged revisions after the stop_rev too
580
reached_stop_revision_id = False
581
revision_id_whitelist = []
582
for node in rev_iter:
584
if rev_id == left_parent:
585
# reached the left parent after the stop_revision
587
if (not reached_stop_revision_id or
588
rev_id in revision_id_whitelist):
589
yield (rev_id, node.merge_depth, node.revno,
591
if reached_stop_revision_id or rev_id == stop_revision_id:
592
# only do the merged revs of rev_id from now on
593
rev = self.repository.get_revision(rev_id)
595
reached_stop_revision_id = True
596
revision_id_whitelist.extend(rev.parent_ids)
598
raise ValueError('invalid stop_rule %r' % stop_rule)
600
def _filter_start_non_ancestors(self, rev_iter):
601
# If we started from a dotted revno, we want to consider it as a tip
602
# and don't want to yield revisions that are not part of its
603
# ancestry. Given the order guaranteed by the merge sort, we will see
604
# uninteresting descendants of the first parent of our tip before the
606
first = next(rev_iter)
607
(rev_id, merge_depth, revno, end_of_merge) = first
610
# We start at a mainline revision so by definition, all others
611
# revisions in rev_iter are ancestors
612
for node in rev_iter:
617
pmap = self.repository.get_parent_map([rev_id])
618
parents = pmap.get(rev_id, [])
620
whitelist.update(parents)
622
# If there is no parents, there is nothing of interest left
624
# FIXME: It's hard to test this scenario here as this code is never
625
# called in that case. -- vila 20100322
628
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
630
if rev_id in whitelist:
631
pmap = self.repository.get_parent_map([rev_id])
632
parents = pmap.get(rev_id, [])
633
whitelist.remove(rev_id)
634
whitelist.update(parents)
636
# We've reached the mainline, there is nothing left to
640
# A revision that is not part of the ancestry of our
643
yield (rev_id, merge_depth, revno, end_of_merge)
645
def leave_lock_in_place(self):
646
"""Tell this branch object not to release the physical lock when this
649
If lock_write doesn't return a token, then this method is not supported.
651
self.control_files.leave_in_place()
653
def dont_leave_lock_in_place(self):
654
"""Tell this branch object to release the physical lock when this
655
object is unlocked, even if it didn't originally acquire it.
657
If lock_write doesn't return a token, then this method is not supported.
659
self.control_files.dont_leave_in_place()
661
def bind(self, other):
662
"""Bind the local branch the other branch.
664
:param other: The branch to bind to
667
raise errors.UpgradeRequired(self.user_url)
669
def get_append_revisions_only(self):
670
"""Whether it is only possible to append revisions to the history.
672
if not self._format.supports_set_append_revisions_only():
674
return self.get_config_stack().get('append_revisions_only')
676
def set_append_revisions_only(self, enabled):
677
if not self._format.supports_set_append_revisions_only():
678
raise errors.UpgradeRequired(self.user_url)
679
self.get_config_stack().set('append_revisions_only', enabled)
681
def set_reference_info(self, file_id, tree_path, branch_location):
682
"""Set the branch location to use for a tree reference."""
683
raise errors.UnsupportedOperation(self.set_reference_info, self)
685
def get_reference_info(self, file_id):
686
"""Get the tree_path and branch_location for a tree reference."""
687
raise errors.UnsupportedOperation(self.get_reference_info, self)
689
def fetch(self, from_branch, last_revision=None, limit=None):
690
"""Copy revisions from from_branch into this branch.
692
:param from_branch: Where to copy from.
693
:param last_revision: What revision to stop at (None for at the end
695
:param limit: Optional rough limit of revisions to fetch
698
with self.lock_write():
699
return InterBranch.get(from_branch, self).fetch(
700
last_revision, limit=limit)
702
def get_bound_location(self):
703
"""Return the URL of the branch we are bound to.
705
Older format branches cannot bind, please be sure to use a metadir
710
def get_old_bound_location(self):
711
"""Return the URL of the branch we used to be bound to
713
raise errors.UpgradeRequired(self.user_url)
715
def get_commit_builder(self, parents, config_stack=None, timestamp=None,
716
timezone=None, committer=None, revprops=None,
717
revision_id=None, lossy=False):
718
"""Obtain a CommitBuilder for this branch.
720
:param parents: Revision ids of the parents of the new revision.
721
:param config: Optional configuration to use.
722
:param timestamp: Optional timestamp recorded for commit.
723
:param timezone: Optional timezone for timestamp.
724
:param committer: Optional committer to set for commit.
725
:param revprops: Optional dictionary of revision properties.
726
:param revision_id: Optional revision id.
727
:param lossy: Whether to discard data that can not be natively
728
represented, when pushing to a foreign VCS
731
if config_stack is None:
732
config_stack = self.get_config_stack()
734
return self.repository.get_commit_builder(self, parents, config_stack,
735
timestamp, timezone, committer, revprops, revision_id,
738
def get_master_branch(self, possible_transports=None):
739
"""Return the branch we are bound to.
741
:return: Either a Branch, or None
745
def get_stacked_on_url(self):
746
"""Get the URL this branch is stacked against.
748
:raises NotStacked: If the branch is not stacked.
749
:raises UnstackableBranchFormat: If the branch does not support
752
raise NotImplementedError(self.get_stacked_on_url)
754
def set_last_revision_info(self, revno, revision_id):
755
"""Set the last revision of this branch.
757
The caller is responsible for checking that the revno is correct
758
for this revision id.
760
It may be possible to set the branch last revision to an id not
761
present in the repository. However, branches can also be
762
configured to check constraints on history, in which case this may not
765
raise NotImplementedError(self.set_last_revision_info)
767
def generate_revision_history(self, revision_id, last_rev=None,
769
"""See Branch.generate_revision_history"""
770
with self.lock_write():
771
graph = self.repository.get_graph()
772
(last_revno, last_revid) = self.last_revision_info()
773
known_revision_ids = [
774
(last_revid, last_revno),
775
(_mod_revision.NULL_REVISION, 0),
777
if last_rev is not None:
778
if not graph.is_ancestor(last_rev, revision_id):
779
# our previous tip is not merged into stop_revision
780
raise errors.DivergedBranches(self, other_branch)
781
revno = graph.find_distance_to_null(revision_id, known_revision_ids)
782
self.set_last_revision_info(revno, revision_id)
784
def set_parent(self, url):
785
"""See Branch.set_parent."""
786
# TODO: Maybe delete old location files?
787
# URLs should never be unicode, even on the local fs,
788
# FIXUP this and get_parent in a future branch format bump:
789
# read and rewrite the file. RBC 20060125
791
if isinstance(url, unicode):
793
url = url.encode('ascii')
794
except UnicodeEncodeError:
795
raise urlutils.InvalidURL(url,
796
"Urls must be 7-bit ascii, "
797
"use breezy.urlutils.escape")
798
url = urlutils.relative_url(self.base, url)
799
with self.lock_write():
800
self._set_parent_location(url)
802
def set_stacked_on_url(self, url):
803
"""Set the URL this branch is stacked against.
805
:raises UnstackableBranchFormat: If the branch does not support
807
:raises UnstackableRepositoryFormat: If the repository does not support
810
if not self._format.supports_stacking():
811
raise UnstackableBranchFormat(self._format, self.user_url)
812
with self.lock_write():
813
# XXX: Changing from one fallback repository to another does not check
814
# that all the data you need is present in the new fallback.
815
# Possibly it should.
816
self._check_stackable_repo()
819
old_url = self.get_stacked_on_url()
820
except (errors.NotStacked, UnstackableBranchFormat,
821
errors.UnstackableRepositoryFormat):
825
self._activate_fallback_location(url,
826
possible_transports=[self.controldir.root_transport])
827
# write this out after the repository is stacked to avoid setting a
828
# stacked config that doesn't work.
829
self._set_config_location('stacked_on_location', url)
832
"""Change a branch to be unstacked, copying data as needed.
834
Don't call this directly, use set_stacked_on_url(None).
836
pb = ui.ui_factory.nested_progress_bar()
838
pb.update(gettext("Unstacking"))
839
# The basic approach here is to fetch the tip of the branch,
840
# including all available ghosts, from the existing stacked
841
# repository into a new repository object without the fallbacks.
843
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
844
# correct for CHKMap repostiories
845
old_repository = self.repository
846
if len(old_repository._fallback_repositories) != 1:
847
raise AssertionError("can't cope with fallback repositories "
848
"of %r (fallbacks: %r)" % (old_repository,
849
old_repository._fallback_repositories))
850
# Open the new repository object.
851
# Repositories don't offer an interface to remove fallback
852
# repositories today; take the conceptually simpler option and just
853
# reopen it. We reopen it starting from the URL so that we
854
# get a separate connection for RemoteRepositories and can
855
# stream from one of them to the other. This does mean doing
856
# separate SSH connection setup, but unstacking is not a
857
# common operation so it's tolerable.
858
new_bzrdir = controldir.ControlDir.open(
859
self.controldir.root_transport.base)
860
new_repository = new_bzrdir.find_repository()
861
if new_repository._fallback_repositories:
862
raise AssertionError("didn't expect %r to have "
863
"fallback_repositories"
864
% (self.repository,))
865
# Replace self.repository with the new repository.
866
# Do our best to transfer the lock state (i.e. lock-tokens and
867
# lock count) of self.repository to the new repository.
868
lock_token = old_repository.lock_write().repository_token
869
self.repository = new_repository
870
if isinstance(self, remote.RemoteBranch):
871
# Remote branches can have a second reference to the old
872
# repository that need to be replaced.
873
if self._real_branch is not None:
874
self._real_branch.repository = new_repository
875
self.repository.lock_write(token=lock_token)
876
if lock_token is not None:
877
old_repository.leave_lock_in_place()
878
old_repository.unlock()
879
if lock_token is not None:
880
# XXX: self.repository.leave_lock_in_place() before this
881
# function will not be preserved. Fortunately that doesn't
882
# affect the current default format (2a), and would be a
883
# corner-case anyway.
884
# - Andrew Bennetts, 2010/06/30
885
self.repository.dont_leave_lock_in_place()
889
old_repository.unlock()
890
except errors.LockNotHeld:
893
if old_lock_count == 0:
894
raise AssertionError(
895
'old_repository should have been locked at least once.')
896
for i in range(old_lock_count-1):
897
self.repository.lock_write()
898
# Fetch from the old repository into the new.
899
with old_repository.lock_read():
900
# XXX: If you unstack a branch while it has a working tree
901
# with a pending merge, the pending-merged revisions will no
902
# longer be present. You can (probably) revert and remerge.
904
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
905
except errors.TagsNotSupported:
906
tags_to_fetch = set()
907
fetch_spec = vf_search.NotInOtherForRevs(self.repository,
908
old_repository, required_ids=[self.last_revision()],
909
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
910
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
914
def _set_tags_bytes(self, bytes):
915
"""Mirror method for _get_tags_bytes.
917
:seealso: Branch._get_tags_bytes.
919
with self.lock_write():
920
self._tags_bytes = bytes
921
return self._transport.put_bytes('tags', bytes)
923
def _cache_revision_history(self, rev_history):
924
"""Set the cached revision history to rev_history.
926
The revision_history method will use this cache to avoid regenerating
927
the revision history.
929
This API is semi-public; it only for use by subclasses, all other code
930
should consider it to be private.
932
self._revision_history_cache = rev_history
934
def _cache_revision_id_to_revno(self, revision_id_to_revno):
935
"""Set the cached revision_id => revno map to revision_id_to_revno.
937
This API is semi-public; it only for use by subclasses, all other code
938
should consider it to be private.
940
self._revision_id_to_revno_cache = revision_id_to_revno
942
def _clear_cached_state(self):
943
"""Clear any cached data on this branch, e.g. cached revision history.
945
This means the next call to revision_history will need to call
946
_gen_revision_history.
948
This API is semi-public; it is only for use by subclasses, all other
949
code should consider it to be private.
951
self._revision_history_cache = None
952
self._revision_id_to_revno_cache = None
953
self._last_revision_info_cache = None
954
self._master_branch_cache = None
955
self._merge_sorted_revisions_cache = None
956
self._partial_revision_history_cache = []
957
self._partial_revision_id_to_revno_cache = {}
958
self._tags_bytes = None
960
def _gen_revision_history(self):
961
"""Return sequence of revision hashes on to this branch.
963
Unlike revision_history, this method always regenerates or rereads the
964
revision history, i.e. it does not cache the result, so repeated calls
967
Concrete subclasses should override this instead of revision_history so
968
that subclasses do not need to deal with caching logic.
970
This API is semi-public; it only for use by subclasses, all other code
971
should consider it to be private.
973
raise NotImplementedError(self._gen_revision_history)
975
def _revision_history(self):
976
if 'evil' in debug.debug_flags:
977
mutter_callsite(3, "revision_history scales with history.")
978
if self._revision_history_cache is not None:
979
history = self._revision_history_cache
981
history = self._gen_revision_history()
982
self._cache_revision_history(history)
986
"""Return current revision number for this branch.
988
That is equivalent to the number of revisions committed to
991
return self.last_revision_info()[0]
994
"""Older format branches cannot bind or unbind."""
995
raise errors.UpgradeRequired(self.user_url)
997
def last_revision(self):
998
"""Return last revision id, or NULL_REVISION."""
999
return self.last_revision_info()[1]
1001
def last_revision_info(self):
1002
"""Return information about the last revision.
1004
:return: A tuple (revno, revision_id).
1006
with self.lock_read():
1007
if self._last_revision_info_cache is None:
1008
self._last_revision_info_cache = self._read_last_revision_info()
1009
return self._last_revision_info_cache
1011
def _read_last_revision_info(self):
1012
raise NotImplementedError(self._read_last_revision_info)
1014
def import_last_revision_info_and_tags(self, source, revno, revid,
1016
"""Set the last revision info, importing from another repo if necessary.
1018
This is used by the bound branch code to upload a revision to
1019
the master branch first before updating the tip of the local branch.
1020
Revisions referenced by source's tags are also transferred.
1022
:param source: Source branch to optionally fetch from
1023
:param revno: Revision number of the new tip
1024
:param revid: Revision id of the new tip
1025
:param lossy: Whether to discard metadata that can not be
1026
natively represented
1027
:return: Tuple with the new revision number and revision id
1028
(should only be different from the arguments when lossy=True)
1030
if not self.repository.has_same_location(source.repository):
1031
self.fetch(source, revid)
1032
self.set_last_revision_info(revno, revid)
1033
return (revno, revid)
1035
def revision_id_to_revno(self, revision_id):
1036
"""Given a revision id, return its revno"""
1037
if _mod_revision.is_null(revision_id):
1039
history = self._revision_history()
1041
return history.index(revision_id) + 1
1043
raise errors.NoSuchRevision(self, revision_id)
1045
def get_rev_id(self, revno, history=None):
1046
"""Find the revision id of the specified revno."""
1047
with self.lock_read():
1049
return _mod_revision.NULL_REVISION
1050
last_revno, last_revid = self.last_revision_info()
1051
if revno == last_revno:
1053
if revno <= 0 or revno > last_revno:
1054
raise errors.NoSuchRevision(self, revno)
1055
distance_from_last = last_revno - revno
1056
if len(self._partial_revision_history_cache) <= distance_from_last:
1057
self._extend_partial_history(distance_from_last)
1058
return self._partial_revision_history_cache[distance_from_last]
1060
def pull(self, source, overwrite=False, stop_revision=None,
1061
possible_transports=None, *args, **kwargs):
1062
"""Mirror source into this branch.
1064
This branch is considered to be 'local', having low latency.
1066
:returns: PullResult instance
1068
return InterBranch.get(source, self).pull(overwrite=overwrite,
1069
stop_revision=stop_revision,
1070
possible_transports=possible_transports, *args, **kwargs)
1072
def push(self, target, overwrite=False, stop_revision=None, lossy=False,
1074
"""Mirror this branch into target.
1076
This branch is considered to be 'local', having low latency.
1078
return InterBranch.get(self, target).push(overwrite, stop_revision,
1079
lossy, *args, **kwargs)
1081
def basis_tree(self):
1082
"""Return `Tree` object for last revision."""
1083
return self.repository.revision_tree(self.last_revision())
1085
def get_parent(self):
1086
"""Return the parent location of the branch.
1088
This is the default location for pull/missing. The usual
1089
pattern is that the user can override it by specifying a
1092
parent = self._get_parent_location()
1095
# This is an old-format absolute path to a local branch
1096
# turn it into a url
1097
if parent.startswith('/'):
1098
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1100
return urlutils.join(self.base[:-1], parent)
1101
except urlutils.InvalidURLJoin as e:
1102
raise errors.InaccessibleParent(parent, self.user_url)
1104
def _get_parent_location(self):
1105
raise NotImplementedError(self._get_parent_location)
1107
def _set_config_location(self, name, url, config=None,
1108
make_relative=False):
1110
config = self.get_config_stack()
1114
url = urlutils.relative_url(self.base, url)
1115
config.set(name, url)
1117
def _get_config_location(self, name, config=None):
1119
config = self.get_config_stack()
1120
location = config.get(name)
1125
def get_child_submit_format(self):
1126
"""Return the preferred format of submissions to this branch."""
1127
return self.get_config_stack().get('child_submit_format')
1129
def get_submit_branch(self):
1130
"""Return the submit location of the branch.
1132
This is the default location for bundle. The usual
1133
pattern is that the user can override it by specifying a
1136
return self.get_config_stack().get('submit_branch')
1138
def set_submit_branch(self, location):
1139
"""Return the submit location of the branch.
1141
This is the default location for bundle. The usual
1142
pattern is that the user can override it by specifying a
1145
self.get_config_stack().set('submit_branch', location)
1147
def get_public_branch(self):
1148
"""Return the public location of the branch.
1150
This is used by merge directives.
1152
return self._get_config_location('public_branch')
1154
def set_public_branch(self, location):
1155
"""Return the submit location of the branch.
1157
This is the default location for bundle. The usual
1158
pattern is that the user can override it by specifying a
1161
self._set_config_location('public_branch', location)
1163
def get_push_location(self):
1164
"""Return None or the location to push this branch to."""
1165
return self.get_config_stack().get('push_location')
1167
def set_push_location(self, location):
1168
"""Set a new push location for this branch."""
1169
raise NotImplementedError(self.set_push_location)
1171
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1172
"""Run the post_change_branch_tip hooks."""
1173
hooks = Branch.hooks['post_change_branch_tip']
1176
new_revno, new_revid = self.last_revision_info()
1177
params = ChangeBranchTipParams(
1178
self, old_revno, new_revno, old_revid, new_revid)
1182
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1183
"""Run the pre_change_branch_tip hooks."""
1184
hooks = Branch.hooks['pre_change_branch_tip']
1187
old_revno, old_revid = self.last_revision_info()
1188
params = ChangeBranchTipParams(
1189
self, old_revno, new_revno, old_revid, new_revid)
1194
"""Synchronise this branch with the master branch if any.
1196
:return: None or the last_revision pivoted out during the update.
1200
def check_revno(self, revno):
1202
Check whether a revno corresponds to any revision.
1203
Zero (the NULL revision) is considered valid.
1206
self.check_real_revno(revno)
1208
def check_real_revno(self, revno):
1210
Check whether a revno corresponds to a real revision.
1211
Zero (the NULL revision) is considered invalid
1213
if revno < 1 or revno > self.revno():
1214
raise errors.InvalidRevisionNumber(revno)
1216
def clone(self, to_controldir, revision_id=None, repository_policy=None):
1217
"""Clone this branch into to_controldir preserving all semantic values.
1219
Most API users will want 'create_clone_on_transport', which creates a
1220
new bzrdir and branch on the fly.
1222
revision_id: if not None, the revision history in the new branch will
1223
be truncated to end with revision_id.
1225
result = to_controldir.create_branch()
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)
1232
def sprout(self, to_controldir, revision_id=None, repository_policy=None,
1234
"""Create a new line of development from the branch, into to_controldir.
1236
to_controldir controls the branch format.
1238
revision_id: if not None, the revision history in the new branch will
1239
be truncated to end with revision_id.
1241
if (repository_policy is not None and
1242
repository_policy.requires_stacking()):
1243
to_controldir._format.require_stacking(_skip_repo=True)
1244
result = to_controldir.create_branch(repository=repository)
1245
with self.lock_read(), result.lock_write():
1246
if repository_policy is not None:
1247
repository_policy.configure_branch(result)
1248
self.copy_content_into(result, revision_id=revision_id)
1249
master_url = self.get_bound_location()
1250
if master_url is None:
1251
result.set_parent(self.controldir.root_transport.base)
1253
result.set_parent(master_url)
1256
def _synchronize_history(self, destination, revision_id):
1257
"""Synchronize last revision and revision history between branches.
1259
This version is most efficient when the destination is also a
1260
BzrBranch6, but works for BzrBranch5, as long as the destination's
1261
repository contains all the lefthand ancestors of the intended
1262
last_revision. If not, set_last_revision_info will fail.
1264
:param destination: The branch to copy the history into
1265
:param revision_id: The revision-id to truncate history at. May
1266
be None to copy complete history.
1268
source_revno, source_revision_id = self.last_revision_info()
1269
if revision_id is None:
1270
revno, revision_id = source_revno, source_revision_id
1272
graph = self.repository.get_graph()
1274
revno = graph.find_distance_to_null(revision_id,
1275
[(source_revision_id, source_revno)])
1276
except errors.GhostRevisionsHaveNoRevno:
1277
# Default to 1, if we can't find anything else
1279
destination.set_last_revision_info(revno, revision_id)
1281
def copy_content_into(self, destination, revision_id=None):
1282
"""Copy the content of self into destination.
1284
revision_id: if not None, the revision history in the new branch will
1285
be truncated to end with revision_id.
1287
return InterBranch.get(self, destination).copy_content_into(
1288
revision_id=revision_id)
1290
def update_references(self, target):
1291
if not getattr(self._format, 'supports_reference_locations', False):
1293
reference_dict = self._get_all_reference_info()
1294
if len(reference_dict) == 0:
1296
old_base = self.base
1297
new_base = target.base
1298
target_reference_dict = target._get_all_reference_info()
1299
for file_id, (tree_path, branch_location) in viewitems(reference_dict):
1300
branch_location = urlutils.rebase_url(branch_location,
1302
target_reference_dict.setdefault(
1303
file_id, (tree_path, branch_location))
1304
target._set_all_reference_info(target_reference_dict)
1306
def check(self, refs):
1307
"""Check consistency of the branch.
1309
In particular this checks that revisions given in the revision-history
1310
do actually match up in the revision graph, and that they're all
1311
present in the repository.
1313
Callers will typically also want to check the repository.
1315
:param refs: Calculated refs for this branch as specified by
1316
branch._get_check_refs()
1317
:return: A BranchCheckResult.
1319
with self.lock_read():
1320
result = BranchCheckResult(self)
1321
last_revno, last_revision_id = self.last_revision_info()
1322
actual_revno = refs[('lefthand-distance', last_revision_id)]
1323
if actual_revno != last_revno:
1324
result.errors.append(errors.BzrCheckError(
1325
'revno does not match len(mainline) %s != %s' % (
1326
last_revno, actual_revno)))
1327
# TODO: We should probably also check that self.revision_history
1328
# matches the repository for older branch formats.
1329
# If looking for the code that cross-checks repository parents against
1330
# the Graph.iter_lefthand_ancestry output, that is now a repository
1334
def _get_checkout_format(self, lightweight=False):
1335
"""Return the most suitable metadir for a checkout of this branch.
1336
Weaves are used if this branch's repository uses weaves.
1338
format = self.repository.controldir.checkout_metadir()
1339
format.set_branch_format(self._format)
1342
def create_clone_on_transport(self, to_transport, revision_id=None,
1343
stacked_on=None, create_prefix=False, use_existing_dir=False,
1345
"""Create a clone of this branch and its bzrdir.
1347
:param to_transport: The transport to clone onto.
1348
:param revision_id: The revision id to use as tip in the new branch.
1349
If None the tip is obtained from this branch.
1350
:param stacked_on: An optional URL to stack the clone on.
1351
:param create_prefix: Create any missing directories leading up to
1353
:param use_existing_dir: Use an existing directory if one exists.
1355
# XXX: Fix the bzrdir API to allow getting the branch back from the
1356
# clone call. Or something. 20090224 RBC/spiv.
1357
# XXX: Should this perhaps clone colocated branches as well,
1358
# rather than just the default branch? 20100319 JRV
1359
if revision_id is None:
1360
revision_id = self.last_revision()
1361
dir_to = self.controldir.clone_on_transport(to_transport,
1362
revision_id=revision_id, stacked_on=stacked_on,
1363
create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1365
return dir_to.open_branch()
1367
def create_checkout(self, to_location, revision_id=None,
1368
lightweight=False, accelerator_tree=None,
1370
"""Create a checkout of a branch.
1372
:param to_location: The url to produce the checkout at
1373
:param revision_id: The revision to check out
1374
:param lightweight: If True, produce a lightweight checkout, otherwise,
1375
produce a bound branch (heavyweight checkout)
1376
:param accelerator_tree: A tree which can be used for retrieving file
1377
contents more quickly than the revision tree, i.e. a workingtree.
1378
The revision tree will be used for cases where accelerator_tree's
1379
content is different.
1380
:param hardlink: If true, hard-link files from accelerator_tree,
1382
:return: The tree of the created checkout
1384
t = transport.get_transport(to_location)
1386
format = self._get_checkout_format(lightweight=lightweight)
1388
checkout = format.initialize_on_transport(t)
1389
except errors.AlreadyControlDirError:
1390
# It's fine if the control directory already exists,
1391
# as long as there is no existing branch and working tree.
1392
checkout = controldir.ControlDir.open_from_transport(t)
1394
checkout.open_branch()
1395
except errors.NotBranchError:
1398
raise errors.AlreadyControlDirError(t.base)
1399
if checkout.control_transport.base == self.controldir.control_transport.base:
1400
# When checking out to the same control directory,
1401
# always create a lightweight checkout
1405
from_branch = checkout.set_branch_reference(target_branch=self)
1407
policy = checkout.determine_repository_policy()
1408
repo = policy.acquire_repository()[0]
1409
checkout_branch = checkout.create_branch()
1410
checkout_branch.bind(self)
1411
# pull up to the specified revision_id to set the initial
1412
# branch tip correctly, and seed it with history.
1413
checkout_branch.pull(self, stop_revision=revision_id)
1415
tree = checkout.create_workingtree(revision_id,
1416
from_branch=from_branch,
1417
accelerator_tree=accelerator_tree,
1419
basis_tree = tree.basis_tree()
1420
with basis_tree.lock_read():
1421
for path, file_id in basis_tree.iter_references():
1422
reference_parent = self.reference_parent(file_id, path)
1423
reference_parent.create_checkout(tree.abspath(path),
1424
basis_tree.get_reference_revision(file_id, path),
1428
def reconcile(self, thorough=True):
1429
"""Make sure the data stored in this branch is consistent."""
1430
from breezy.reconcile import BranchReconciler
1431
with self.lock_write():
1432
reconciler = BranchReconciler(self, thorough=thorough)
1433
reconciler.reconcile()
1436
def reference_parent(self, file_id, path, possible_transports=None):
1437
"""Return the parent branch for a tree-reference file_id
1439
:param file_id: The file_id of the tree reference
1440
:param path: The path of the file_id in the tree
1441
:return: A branch associated with the file_id
1443
# FIXME should provide multiple branches, based on config
1444
return Branch.open(self.controldir.root_transport.clone(path).base,
1445
possible_transports=possible_transports)
1447
def supports_tags(self):
1448
return self._format.supports_tags()
1450
def automatic_tag_name(self, revision_id):
1451
"""Try to automatically find the tag name for a revision.
1453
:param revision_id: Revision id of the revision.
1454
:return: A tag name or None if no tag name could be determined.
1456
for hook in Branch.hooks['automatic_tag_name']:
1457
ret = hook(self, revision_id)
1462
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1464
"""Ensure that revision_b is a descendant of revision_a.
1466
This is a helper function for update_revisions.
1468
:raises: DivergedBranches if revision_b has diverged from revision_a.
1469
:returns: True if revision_b is a descendant of revision_a.
1471
relation = self._revision_relations(revision_a, revision_b, graph)
1472
if relation == 'b_descends_from_a':
1474
elif relation == 'diverged':
1475
raise errors.DivergedBranches(self, other_branch)
1476
elif relation == 'a_descends_from_b':
1479
raise AssertionError("invalid relation: %r" % (relation,))
1481
def _revision_relations(self, revision_a, revision_b, graph):
1482
"""Determine the relationship between two revisions.
1484
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1486
heads = graph.heads([revision_a, revision_b])
1487
if heads == {revision_b}:
1488
return 'b_descends_from_a'
1489
elif heads == {revision_a, revision_b}:
1490
# These branches have diverged
1492
elif heads == {revision_a}:
1493
return 'a_descends_from_b'
1495
raise AssertionError("invalid heads: %r" % (heads,))
1497
def heads_to_fetch(self):
1498
"""Return the heads that must and that should be fetched to copy this
1499
branch into another repo.
1501
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1502
set of heads that must be fetched. if_present_fetch is a set of
1503
heads that must be fetched if present, but no error is necessary if
1504
they are not present.
1506
# For bzr native formats must_fetch is just the tip, and
1507
# if_present_fetch are the tags.
1508
must_fetch = {self.last_revision()}
1509
if_present_fetch = set()
1510
if self.get_config_stack().get('branch.fetch_tags'):
1512
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1513
except errors.TagsNotSupported:
1515
must_fetch.discard(_mod_revision.NULL_REVISION)
1516
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1517
return must_fetch, if_present_fetch
1520
class BranchFormat(controldir.ControlComponentFormat):
1521
"""An encapsulation of the initialization and open routines for a format.
1523
Formats provide three things:
1524
* An initialization routine,
1525
* a format description
1528
Formats are placed in an dict by their format string for reference
1529
during branch opening. It's not required that these be instances, they
1530
can be classes themselves with class methods - it simply depends on
1531
whether state is needed for a given format or not.
1533
Once a format is deprecated, just deprecate the initialize and open
1534
methods on the format class. Do not deprecate the object, as the
1535
object will be created every time regardless.
1538
def __eq__(self, other):
1539
return self.__class__ is other.__class__
1541
def __ne__(self, other):
1542
return not (self == other)
1544
def get_reference(self, controldir, name=None):
1545
"""Get the target reference of the branch in controldir.
1547
format probing must have been completed before calling
1548
this method - it is assumed that the format of the branch
1549
in controldir is correct.
1551
:param controldir: The controldir to get the branch data from.
1552
:param name: Name of the colocated branch to fetch
1553
:return: None if the branch is not a reference branch.
1558
def set_reference(self, controldir, name, to_branch):
1559
"""Set the target reference of the branch in controldir.
1561
format probing must have been completed before calling
1562
this method - it is assumed that the format of the branch
1563
in controldir is correct.
1565
:param controldir: The controldir to set the branch reference for.
1566
:param name: Name of colocated branch to set, None for default
1567
:param to_branch: branch that the checkout is to reference
1569
raise NotImplementedError(self.set_reference)
1571
def get_format_description(self):
1572
"""Return the short format description for this format."""
1573
raise NotImplementedError(self.get_format_description)
1575
def _run_post_branch_init_hooks(self, controldir, name, branch):
1576
hooks = Branch.hooks['post_branch_init']
1579
params = BranchInitHookParams(self, controldir, name, branch)
1583
def initialize(self, controldir, name=None, repository=None,
1584
append_revisions_only=None):
1585
"""Create a branch of this format in controldir.
1587
:param name: Name of the colocated branch to create.
1589
raise NotImplementedError(self.initialize)
1591
def is_supported(self):
1592
"""Is this format supported?
1594
Supported formats can be initialized and opened.
1595
Unsupported formats may not support initialization or committing or
1596
some other features depending on the reason for not being supported.
1600
def make_tags(self, branch):
1601
"""Create a tags object for branch.
1603
This method is on BranchFormat, because BranchFormats are reflected
1604
over the wire via network_name(), whereas full Branch instances require
1605
multiple VFS method calls to operate at all.
1607
The default implementation returns a disabled-tags instance.
1609
Note that it is normal for branch to be a RemoteBranch when using tags
1612
return _mod_tag.DisabledTags(branch)
1614
def network_name(self):
1615
"""A simple byte string uniquely identifying this format for RPC calls.
1617
MetaDir branch formats use their disk format string to identify the
1618
repository over the wire. All in one formats such as bzr < 0.8, and
1619
foreign formats like svn/git and hg should use some marker which is
1620
unique and immutable.
1622
raise NotImplementedError(self.network_name)
1624
def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
1625
found_repository=None, possible_transports=None):
1626
"""Return the branch object for controldir.
1628
:param controldir: A ControlDir that contains a branch.
1629
:param name: Name of colocated branch to open
1630
:param _found: a private parameter, do not use it. It is used to
1631
indicate if format probing has already be done.
1632
:param ignore_fallbacks: when set, no fallback branches will be opened
1633
(if there are any). Default is to open fallbacks.
1635
raise NotImplementedError(self.open)
1637
def supports_set_append_revisions_only(self):
1638
"""True if this format supports set_append_revisions_only."""
1641
def supports_stacking(self):
1642
"""True if this format records a stacked-on branch."""
1645
def supports_leaving_lock(self):
1646
"""True if this format supports leaving locks in place."""
1647
return False # by default
1650
return self.get_format_description().rstrip()
1652
def supports_tags(self):
1653
"""True if this format supports tags stored in the branch"""
1654
return False # by default
1656
def tags_are_versioned(self):
1657
"""Whether the tag container for this branch versions tags."""
1660
def supports_tags_referencing_ghosts(self):
1661
"""True if tags can reference ghost revisions."""
1664
def supports_store_uncommitted(self):
1665
"""True if uncommitted changes can be stored in this branch."""
1669
class BranchHooks(Hooks):
1670
"""A dictionary mapping hook name to a list of callables for branch hooks.
1672
e.g. ['post_push'] Is the list of items to be called when the
1673
push function is invoked.
1677
"""Create the default hooks.
1679
These are all empty initially, because by default nothing should get
1682
Hooks.__init__(self, "breezy.branch", "Branch.hooks")
1683
self.add_hook('open',
1684
"Called with the Branch object that has been opened after a "
1685
"branch is opened.", (1, 8))
1686
self.add_hook('post_push',
1687
"Called after a push operation completes. post_push is called "
1688
"with a breezy.branch.BranchPushResult object and only runs in the "
1689
"bzr client.", (0, 15))
1690
self.add_hook('post_pull',
1691
"Called after a pull operation completes. post_pull is called "
1692
"with a breezy.branch.PullResult object and only runs in the "
1693
"bzr client.", (0, 15))
1694
self.add_hook('pre_commit',
1695
"Called after a commit is calculated but before it is "
1696
"completed. pre_commit is called with (local, master, old_revno, "
1697
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1698
"). old_revid is NULL_REVISION for the first commit to a branch, "
1699
"tree_delta is a TreeDelta object describing changes from the "
1700
"basis revision. hooks MUST NOT modify this delta. "
1701
" future_tree is an in-memory tree obtained from "
1702
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1704
self.add_hook('post_commit',
1705
"Called in the bzr client after a commit has completed. "
1706
"post_commit is called with (local, master, old_revno, old_revid, "
1707
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1708
"commit to a branch.", (0, 15))
1709
self.add_hook('post_uncommit',
1710
"Called in the bzr client after an uncommit completes. "
1711
"post_uncommit is called with (local, master, old_revno, "
1712
"old_revid, new_revno, new_revid) where local is the local branch "
1713
"or None, master is the target branch, and an empty branch "
1714
"receives new_revno of 0, new_revid of None.", (0, 15))
1715
self.add_hook('pre_change_branch_tip',
1716
"Called in bzr client and server before a change to the tip of a "
1717
"branch is made. pre_change_branch_tip is called with a "
1718
"breezy.branch.ChangeBranchTipParams. Note that push, pull, "
1719
"commit, uncommit will all trigger this hook.", (1, 6))
1720
self.add_hook('post_change_branch_tip',
1721
"Called in bzr client and server after a change to the tip of a "
1722
"branch is made. post_change_branch_tip is called with a "
1723
"breezy.branch.ChangeBranchTipParams. Note that push, pull, "
1724
"commit, uncommit will all trigger this hook.", (1, 4))
1725
self.add_hook('transform_fallback_location',
1726
"Called when a stacked branch is activating its fallback "
1727
"locations. transform_fallback_location is called with (branch, "
1728
"url), and should return a new url. Returning the same url "
1729
"allows it to be used as-is, returning a different one can be "
1730
"used to cause the branch to stack on a closer copy of that "
1731
"fallback_location. Note that the branch cannot have history "
1732
"accessing methods called on it during this hook because the "
1733
"fallback locations have not been activated. When there are "
1734
"multiple hooks installed for transform_fallback_location, "
1735
"all are called with the url returned from the previous hook."
1736
"The order is however undefined.", (1, 9))
1737
self.add_hook('automatic_tag_name',
1738
"Called to determine an automatic tag name for a revision. "
1739
"automatic_tag_name is called with (branch, revision_id) and "
1740
"should return a tag name or None if no tag name could be "
1741
"determined. The first non-None tag name returned will be used.",
1743
self.add_hook('post_branch_init',
1744
"Called after new branch initialization completes. "
1745
"post_branch_init is called with a "
1746
"breezy.branch.BranchInitHookParams. "
1747
"Note that init, branch and checkout (both heavyweight and "
1748
"lightweight) will all trigger this hook.", (2, 2))
1749
self.add_hook('post_switch',
1750
"Called after a checkout switches branch. "
1751
"post_switch is called with a "
1752
"breezy.branch.SwitchHookParams.", (2, 2))
1756
# install the default hooks into the Branch class.
1757
Branch.hooks = BranchHooks()
1760
class ChangeBranchTipParams(object):
1761
"""Object holding parameters passed to `*_change_branch_tip` hooks.
1763
There are 5 fields that hooks may wish to access:
1765
:ivar branch: the branch being changed
1766
:ivar old_revno: revision number before the change
1767
:ivar new_revno: revision number after the change
1768
:ivar old_revid: revision id before the change
1769
:ivar new_revid: revision id after the change
1771
The revid fields are strings. The revno fields are integers.
1774
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1775
"""Create a group of ChangeBranchTip parameters.
1777
:param branch: The branch being changed.
1778
:param old_revno: Revision number before the change.
1779
:param new_revno: Revision number after the change.
1780
:param old_revid: Tip revision id before the change.
1781
:param new_revid: Tip revision id after the change.
1783
self.branch = branch
1784
self.old_revno = old_revno
1785
self.new_revno = new_revno
1786
self.old_revid = old_revid
1787
self.new_revid = new_revid
1789
def __eq__(self, other):
1790
return self.__dict__ == other.__dict__
1793
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1794
self.__class__.__name__, self.branch,
1795
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1798
class BranchInitHookParams(object):
1799
"""Object holding parameters passed to `*_branch_init` hooks.
1801
There are 4 fields that hooks may wish to access:
1803
:ivar format: the branch format
1804
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1805
:ivar name: name of colocated branch, if any (or None)
1806
:ivar branch: the branch created
1808
Note that for lightweight checkouts, the bzrdir and format fields refer to
1809
the checkout, hence they are different from the corresponding fields in
1810
branch, which refer to the original branch.
1813
def __init__(self, format, controldir, name, branch):
1814
"""Create a group of BranchInitHook parameters.
1816
:param format: the branch format
1817
:param controldir: the ControlDir where the branch will be/has been
1819
:param name: name of colocated branch, if any (or None)
1820
:param branch: the branch created
1822
Note that for lightweight checkouts, the bzrdir and format fields refer
1823
to the checkout, hence they are different from the corresponding fields
1824
in branch, which refer to the original branch.
1826
self.format = format
1827
self.controldir = controldir
1829
self.branch = branch
1831
def __eq__(self, other):
1832
return self.__dict__ == other.__dict__
1835
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1838
class SwitchHookParams(object):
1839
"""Object holding parameters passed to `*_switch` hooks.
1841
There are 4 fields that hooks may wish to access:
1843
:ivar control_dir: ControlDir of the checkout to change
1844
:ivar to_branch: branch that the checkout is to reference
1845
:ivar force: skip the check for local commits in a heavy checkout
1846
:ivar revision_id: revision ID to switch to (or None)
1849
def __init__(self, control_dir, to_branch, force, revision_id):
1850
"""Create a group of SwitchHook parameters.
1852
:param control_dir: ControlDir of the checkout to change
1853
:param to_branch: branch that the checkout is to reference
1854
:param force: skip the check for local commits in a heavy checkout
1855
:param revision_id: revision ID to switch to (or None)
1857
self.control_dir = control_dir
1858
self.to_branch = to_branch
1860
self.revision_id = revision_id
1862
def __eq__(self, other):
1863
return self.__dict__ == other.__dict__
1866
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1867
self.control_dir, self.to_branch,
1871
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
1872
"""Branch format registry."""
1874
def __init__(self, other_registry=None):
1875
super(BranchFormatRegistry, self).__init__(other_registry)
1876
self._default_format = None
1877
self._default_format_key = None
1879
def get_default(self):
1880
"""Return the current default format."""
1881
if (self._default_format_key is not None and
1882
self._default_format is None):
1883
self._default_format = self.get(self._default_format_key)
1884
return self._default_format
1886
def set_default(self, format):
1887
"""Set the default format."""
1888
self._default_format = format
1889
self._default_format_key = None
1891
def set_default_key(self, format_string):
1892
"""Set the default format by its format string."""
1893
self._default_format_key = format_string
1894
self._default_format = None
1897
network_format_registry = registry.FormatRegistry()
1898
"""Registry of formats indexed by their network name.
1900
The network name for a branch format is an identifier that can be used when
1901
referring to formats with smart server operations. See
1902
BranchFormat.network_name() for more detail.
1905
format_registry = BranchFormatRegistry(network_format_registry)
1908
# formats which have no format string are not discoverable
1909
# and not independently creatable, so are not registered.
1910
format_registry.register_lazy(
1911
"Bazaar-NG branch format 5\n", "breezy.bzr.fullhistory",
1913
format_registry.register_lazy(
1914
"Bazaar Branch Format 6 (bzr 0.15)\n",
1915
"breezy.bzr.branch", "BzrBranchFormat6")
1916
format_registry.register_lazy(
1917
"Bazaar Branch Format 7 (needs bzr 1.6)\n",
1918
"breezy.bzr.branch", "BzrBranchFormat7")
1919
format_registry.register_lazy(
1920
"Bazaar Branch Format 8 (needs bzr 1.15)\n",
1921
"breezy.bzr.branch", "BzrBranchFormat8")
1922
format_registry.register_lazy(
1923
"Bazaar-NG Branch Reference Format 1\n",
1924
"breezy.bzr.branch", "BranchReferenceFormat")
1926
format_registry.set_default_key("Bazaar Branch Format 7 (needs bzr 1.6)\n")
1929
class BranchWriteLockResult(LogicalLockResult):
1930
"""The result of write locking a branch.
1932
:ivar token: The token obtained from the underlying branch lock, or
1934
:ivar unlock: A callable which will unlock the lock.
1938
return "BranchWriteLockResult(%r, %r)" % (self.unlock, self.token)
1941
######################################################################
1942
# results of operations
1945
class _Result(object):
1947
def _show_tag_conficts(self, to_file):
1948
if not getattr(self, 'tag_conflicts', None):
1950
to_file.write('Conflicting tags:\n')
1951
for name, value1, value2 in self.tag_conflicts:
1952
to_file.write(' %s\n' % (name, ))
1955
class PullResult(_Result):
1956
"""Result of a Branch.pull operation.
1958
:ivar old_revno: Revision number before pull.
1959
:ivar new_revno: Revision number after pull.
1960
:ivar old_revid: Tip revision id before pull.
1961
:ivar new_revid: Tip revision id after pull.
1962
:ivar source_branch: Source (local) branch object. (read locked)
1963
:ivar master_branch: Master branch of the target, or the target if no
1965
:ivar local_branch: target branch if there is a Master, else None
1966
:ivar target_branch: Target/destination branch object. (write locked)
1967
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
1968
:ivar tag_updates: A dict with new tags, see BasicTags.merge_to
1971
def report(self, to_file):
1972
tag_conflicts = getattr(self, "tag_conflicts", None)
1973
tag_updates = getattr(self, "tag_updates", None)
1975
if self.old_revid != self.new_revid:
1976
to_file.write('Now on revision %d.\n' % self.new_revno)
1978
to_file.write('%d tag(s) updated.\n' % len(tag_updates))
1979
if self.old_revid == self.new_revid and not tag_updates:
1980
if not tag_conflicts:
1981
to_file.write('No revisions or tags to pull.\n')
1983
to_file.write('No revisions to pull.\n')
1984
self._show_tag_conficts(to_file)
1987
class BranchPushResult(_Result):
1988
"""Result of a Branch.push operation.
1990
:ivar old_revno: Revision number (eg 10) of the target before push.
1991
:ivar new_revno: Revision number (eg 12) of the target after push.
1992
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
1994
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
1996
:ivar source_branch: Source branch object that the push was from. This is
1997
read locked, and generally is a local (and thus low latency) branch.
1998
:ivar master_branch: If target is a bound branch, the master branch of
1999
target, or target itself. Always write locked.
2000
:ivar target_branch: The direct Branch where data is being sent (write
2002
:ivar local_branch: If the target is a bound branch this will be the
2003
target, otherwise it will be None.
2006
def report(self, to_file):
2007
# TODO: This function gets passed a to_file, but then
2008
# ignores it and calls note() instead. This is also
2009
# inconsistent with PullResult(), which writes to stdout.
2010
# -- JRV20110901, bug #838853
2011
tag_conflicts = getattr(self, "tag_conflicts", None)
2012
tag_updates = getattr(self, "tag_updates", None)
2014
if self.old_revid != self.new_revid:
2015
note(gettext('Pushed up to revision %d.') % self.new_revno)
2017
note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
2018
if self.old_revid == self.new_revid and not tag_updates:
2019
if not tag_conflicts:
2020
note(gettext('No new revisions or tags to push.'))
2022
note(gettext('No new revisions to push.'))
2023
self._show_tag_conficts(to_file)
2026
class BranchCheckResult(object):
2027
"""Results of checking branch consistency.
2032
def __init__(self, branch):
2033
self.branch = branch
2036
def report_results(self, verbose):
2037
"""Report the check results via trace.note.
2039
:param verbose: Requests more detailed display of what was checked,
2042
note(gettext('checked branch {0} format {1}').format(
2043
self.branch.user_url, self.branch._format))
2044
for error in self.errors:
2045
note(gettext('found error:%s'), error)
2048
class InterBranch(InterObject):
2049
"""This class represents operations taking place between two branches.
2051
Its instances have methods like pull() and push() and contain
2052
references to the source and target repositories these operations
2053
can be carried out on.
2057
"""The available optimised InterBranch types."""
2060
def _get_branch_formats_to_test(klass):
2061
"""Return an iterable of format tuples for testing.
2063
:return: An iterable of (from_format, to_format) to use when testing
2064
this InterBranch class. Each InterBranch class should define this
2067
raise NotImplementedError(klass._get_branch_formats_to_test)
2069
def pull(self, overwrite=False, stop_revision=None,
2070
possible_transports=None, local=False):
2071
"""Mirror source into target branch.
2073
The target branch is considered to be 'local', having low latency.
2075
:returns: PullResult instance
2077
raise NotImplementedError(self.pull)
2079
def push(self, overwrite=False, stop_revision=None, lossy=False,
2080
_override_hook_source_branch=None):
2081
"""Mirror the source branch into the target branch.
2083
The source branch is considered to be 'local', having low latency.
2085
raise NotImplementedError(self.push)
2087
def copy_content_into(self, revision_id=None):
2088
"""Copy the content of source into target
2090
revision_id: if not None, the revision history in the new branch will
2091
be truncated to end with revision_id.
2093
raise NotImplementedError(self.copy_content_into)
2095
def fetch(self, stop_revision=None, limit=None):
2098
:param stop_revision: Last revision to fetch
2099
:param limit: Optional rough limit of revisions to fetch
2101
raise NotImplementedError(self.fetch)
2104
def _fix_overwrite_type(overwrite):
2105
if isinstance(overwrite, bool):
2107
return ["history", "tags"]
2113
class GenericInterBranch(InterBranch):
2114
"""InterBranch implementation that uses public Branch functions."""
2117
def is_compatible(klass, source, target):
2118
# GenericBranch uses the public API, so always compatible
2122
def _get_branch_formats_to_test(klass):
2123
return [(format_registry.get_default(), format_registry.get_default())]
2126
def unwrap_format(klass, format):
2127
if isinstance(format, remote.RemoteBranchFormat):
2128
format._ensure_real()
2129
return format._custom_format
2132
def copy_content_into(self, revision_id=None):
2133
"""Copy the content of source into target
2135
revision_id: if not None, the revision history in the new branch will
2136
be truncated to end with revision_id.
2138
with self.source.lock_read(), self.target.lock_write():
2139
self.source.update_references(self.target)
2140
self.source._synchronize_history(self.target, revision_id)
2142
parent = self.source.get_parent()
2143
except errors.InaccessibleParent as e:
2144
mutter('parent was not accessible to copy: %s', e)
2147
self.target.set_parent(parent)
2148
if self.source._push_should_merge_tags():
2149
self.source.tags.merge_to(self.target.tags)
2151
def fetch(self, stop_revision=None, limit=None):
2152
if self.target.base == self.source.base:
2154
with self.source.lock_read(), self.target.lock_write():
2155
fetch_spec_factory = fetch.FetchSpecFactory()
2156
fetch_spec_factory.source_branch = self.source
2157
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
2158
fetch_spec_factory.source_repo = self.source.repository
2159
fetch_spec_factory.target_repo = self.target.repository
2160
fetch_spec_factory.target_repo_kind = 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,
2165
fetch_spec=fetch_spec)
2167
def _update_revisions(self, stop_revision=None, overwrite=False,
2169
with self.source.lock_read(), self.target.lock_write():
2170
other_revno, other_last_revision = self.source.last_revision_info()
2171
stop_revno = None # unknown
2172
if stop_revision is None:
2173
stop_revision = other_last_revision
2174
if _mod_revision.is_null(stop_revision):
2175
# if there are no commits, we're done.
2177
stop_revno = other_revno
2179
# what's the current last revision, before we fetch [and change it
2181
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2182
# we fetch here so that we don't process data twice in the common
2183
# case of having something to pull, and so that the check for
2184
# already merged can operate on the just fetched graph, which will
2185
# be cached in memory.
2186
self.fetch(stop_revision=stop_revision)
2187
# Check to see if one is an ancestor of the other
2190
graph = self.target.repository.get_graph()
2191
if self.target._check_if_descendant_or_diverged(
2192
stop_revision, last_rev, graph, self.source):
2193
# stop_revision is a descendant of last_rev, but we aren't
2194
# overwriting, so we're done.
2196
if stop_revno is None:
2198
graph = self.target.repository.get_graph()
2199
this_revno, this_last_revision = \
2200
self.target.last_revision_info()
2201
stop_revno = graph.find_distance_to_null(stop_revision,
2202
[(other_last_revision, other_revno),
2203
(this_last_revision, this_revno)])
2204
self.target.set_last_revision_info(stop_revno, stop_revision)
2206
def pull(self, overwrite=False, stop_revision=None,
2207
possible_transports=None, run_hooks=True,
2208
_override_hook_target=None, local=False):
2209
"""Pull from source into self, updating my master if any.
2211
:param run_hooks: Private parameter - if false, this branch
2212
is being called because it's the master of the primary branch,
2213
so it should not run its hooks.
2215
with self.target.lock_write():
2216
bound_location = self.target.get_bound_location()
2217
if local and not bound_location:
2218
raise errors.LocalRequiresBoundBranch()
2219
master_branch = None
2220
source_is_master = False
2222
# bound_location comes from a config file, some care has to be
2223
# taken to relate it to source.user_url
2224
normalized = urlutils.normalize_url(bound_location)
2226
relpath = self.source.user_transport.relpath(normalized)
2227
source_is_master = (relpath == '')
2228
except (errors.PathNotChild, urlutils.InvalidURL):
2229
source_is_master = False
2230
if not local and bound_location and not source_is_master:
2231
# not pulling from master, so we need to update master.
2232
master_branch = self.target.get_master_branch(possible_transports)
2233
master_branch.lock_write()
2236
# pull from source into master.
2237
master_branch.pull(self.source, overwrite, stop_revision,
2239
return self._pull(overwrite,
2240
stop_revision, _hook_master=master_branch,
2241
run_hooks=run_hooks,
2242
_override_hook_target=_override_hook_target,
2243
merge_tags_to_master=not source_is_master)
2246
master_branch.unlock()
2248
def push(self, overwrite=False, stop_revision=None, lossy=False,
2249
_override_hook_source_branch=None):
2250
"""See InterBranch.push.
2252
This is the basic concrete implementation of push()
2254
:param _override_hook_source_branch: If specified, run the hooks
2255
passing this Branch as the source, rather than self. This is for
2256
use of RemoteBranch, where push is delegated to the underlying
2260
raise errors.LossyPushToSameVCS(self.source, self.target)
2261
# TODO: Public option to disable running hooks - should be trivial but
2264
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
2265
op.add_cleanup(self.source.lock_read().unlock)
2266
op.add_cleanup(self.target.lock_write().unlock)
2267
return op.run(overwrite, stop_revision,
2268
_override_hook_source_branch=_override_hook_source_branch)
2270
def _basic_push(self, overwrite, stop_revision):
2271
"""Basic implementation of push without bound branches or hooks.
2273
Must be called with source read locked and target write locked.
2275
result = BranchPushResult()
2276
result.source_branch = self.source
2277
result.target_branch = self.target
2278
result.old_revno, result.old_revid = self.target.last_revision_info()
2279
self.source.update_references(self.target)
2280
overwrite = _fix_overwrite_type(overwrite)
2281
if result.old_revid != stop_revision:
2282
# We assume that during 'push' this repository is closer than
2284
graph = self.source.repository.get_graph(self.target.repository)
2285
self._update_revisions(stop_revision,
2286
overwrite=("history" in overwrite),
2288
if self.source._push_should_merge_tags():
2289
result.tag_updates, result.tag_conflicts = (
2290
self.source.tags.merge_to(
2291
self.target.tags, "tags" in overwrite))
2292
result.new_revno, result.new_revid = self.target.last_revision_info()
2295
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
2296
_override_hook_source_branch=None):
2297
"""Push from source into target, and into target's master if any.
2300
if _override_hook_source_branch:
2301
result.source_branch = _override_hook_source_branch
2302
for hook in Branch.hooks['post_push']:
2305
bound_location = self.target.get_bound_location()
2306
if bound_location and self.target.base != bound_location:
2307
# there is a master branch.
2309
# XXX: Why the second check? Is it even supported for a branch to
2310
# be bound to itself? -- mbp 20070507
2311
master_branch = self.target.get_master_branch()
2312
master_branch.lock_write()
2313
operation.add_cleanup(master_branch.unlock)
2314
# push into the master from the source branch.
2315
master_inter = InterBranch.get(self.source, master_branch)
2316
master_inter._basic_push(overwrite, stop_revision)
2317
# and push into the target branch from the source. Note that
2318
# we push from the source branch again, because it's considered
2319
# the highest bandwidth repository.
2320
result = self._basic_push(overwrite, stop_revision)
2321
result.master_branch = master_branch
2322
result.local_branch = self.target
2324
master_branch = None
2326
result = self._basic_push(overwrite, stop_revision)
2327
# TODO: Why set master_branch and local_branch if there's no
2328
# binding? Maybe cleaner to just leave them unset? -- mbp
2330
result.master_branch = self.target
2331
result.local_branch = None
2335
def _pull(self, overwrite=False, stop_revision=None,
2336
possible_transports=None, _hook_master=None, run_hooks=True,
2337
_override_hook_target=None, local=False,
2338
merge_tags_to_master=True):
2341
This function is the core worker, used by GenericInterBranch.pull to
2342
avoid duplication when pulling source->master and source->local.
2344
:param _hook_master: Private parameter - set the branch to
2345
be supplied as the master to pull hooks.
2346
:param run_hooks: Private parameter - if false, this branch
2347
is being called because it's the master of the primary branch,
2348
so it should not run its hooks.
2349
is being called because it's the master of the primary branch,
2350
so it should not run its hooks.
2351
:param _override_hook_target: Private parameter - set the branch to be
2352
supplied as the target_branch to pull hooks.
2353
:param local: Only update the local branch, and not the bound branch.
2355
# This type of branch can't be bound.
2357
raise errors.LocalRequiresBoundBranch()
2358
result = PullResult()
2359
result.source_branch = self.source
2360
if _override_hook_target is None:
2361
result.target_branch = self.target
2363
result.target_branch = _override_hook_target
2364
with self.source.lock_read():
2365
# We assume that during 'pull' the target repository is closer than
2367
self.source.update_references(self.target)
2368
graph = self.target.repository.get_graph(self.source.repository)
2369
# TODO: Branch formats should have a flag that indicates
2370
# that revno's are expensive, and pull() should honor that flag.
2372
result.old_revno, result.old_revid = \
2373
self.target.last_revision_info()
2374
overwrite = _fix_overwrite_type(overwrite)
2375
self._update_revisions(stop_revision,
2376
overwrite=("history" in overwrite),
2378
# TODO: The old revid should be specified when merging tags,
2379
# so a tags implementation that versions tags can only
2380
# pull in the most recent changes. -- JRV20090506
2381
result.tag_updates, result.tag_conflicts = (
2382
self.source.tags.merge_to(self.target.tags,
2383
"tags" in overwrite,
2384
ignore_master=not merge_tags_to_master))
2385
result.new_revno, result.new_revid = self.target.last_revision_info()
2387
result.master_branch = _hook_master
2388
result.local_branch = result.target_branch
2390
result.master_branch = result.target_branch
2391
result.local_branch = None
2393
for hook in Branch.hooks['post_pull']:
2398
InterBranch.register_optimiser(GenericInterBranch)
added
removed
breezy/branch.py
