1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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
18
from cStringIO import StringIO
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from itertools import chain
27
config as _mod_config,
33
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TransportConfig
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
from bzrlib.hooks import HookPoint, Hooks
51
from bzrlib.inter import InterObject
52
from bzrlib import registry
53
from bzrlib.symbol_versioning import (
57
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
60
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
61
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
62
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
65
# TODO: Maybe include checks for common corruption of newlines, etc?
67
# TODO: Some operations like log might retrieve the same revisions
68
# repeatedly to calculate deltas. We could perhaps have a weakref
69
# cache in memory to make this faster. In general anything can be
70
# cached in memory between lock and unlock operations. .. nb thats
71
# what the transaction identity map provides
74
######################################################################
78
"""Branch holding a history of revisions.
81
Base directory/url of the branch.
83
hooks: An instance of BranchHooks.
85
# this is really an instance variable - FIXME move it there
89
def __init__(self, *ignored, **ignored_too):
90
self.tags = self._format.make_tags(self)
91
self._revision_history_cache = None
92
self._revision_id_to_revno_cache = None
93
self._partial_revision_id_to_revno_cache = {}
94
self._partial_revision_history_cache = []
95
self._last_revision_info_cache = None
96
self._merge_sorted_revisions_cache = None
98
hooks = Branch.hooks['open']
102
def _open_hook(self):
103
"""Called by init to allow simpler extension of the base class."""
105
def _activate_fallback_location(self, url):
106
"""Activate the branch/repository from url as a fallback repository."""
107
repo = self._get_fallback_repository(url)
108
if repo.has_same_location(self.repository):
109
raise errors.UnstackableLocationError(self.base, url)
110
self.repository.add_fallback_repository(repo)
112
def break_lock(self):
113
"""Break a lock if one is present from another instance.
115
Uses the ui factory to ask for confirmation if the lock may be from
118
This will probe the repository for its lock as well.
120
self.control_files.break_lock()
121
self.repository.break_lock()
122
master = self.get_master_branch()
123
if master is not None:
126
def _check_stackable_repo(self):
127
if not self.repository._format.supports_external_lookups:
128
raise errors.UnstackableRepositoryFormat(self.repository._format,
129
self.repository.base)
131
def _extend_partial_history(self, stop_index=None, stop_revision=None):
132
"""Extend the partial history to include a given index
134
If a stop_index is supplied, stop when that index has been reached.
135
If a stop_revision is supplied, stop when that revision is
136
encountered. Otherwise, stop when the beginning of history is
139
:param stop_index: The index which should be present. When it is
140
present, history extension will stop.
141
:param stop_revision: The revision id which should be present. When
142
it is encountered, history extension will stop.
144
if len(self._partial_revision_history_cache) == 0:
145
self._partial_revision_history_cache = [self.last_revision()]
146
repository._iter_for_revno(
147
self.repository, self._partial_revision_history_cache,
148
stop_index=stop_index, stop_revision=stop_revision)
149
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
150
self._partial_revision_history_cache.pop()
152
def _get_check_refs(self):
153
"""Get the references needed for check().
157
revid = self.last_revision()
158
return [('revision-existence', revid), ('lefthand-distance', revid)]
161
def open(base, _unsupported=False, possible_transports=None):
162
"""Open the branch rooted at base.
164
For instance, if the branch is at URL/.bzr/branch,
165
Branch.open(URL) -> a Branch instance.
167
control = bzrdir.BzrDir.open(base, _unsupported,
168
possible_transports=possible_transports)
169
return control.open_branch(_unsupported)
172
def open_from_transport(transport, _unsupported=False):
173
"""Open the branch rooted at transport"""
174
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
175
return control.open_branch(_unsupported)
178
def open_containing(url, possible_transports=None):
179
"""Open an existing branch which contains url.
181
This probes for a branch at url, and searches upwards from there.
183
Basically we keep looking up until we find the control directory or
184
run into the root. If there isn't one, raises NotBranchError.
185
If there is one and it is either an unrecognised format or an unsupported
186
format, UnknownFormatError or UnsupportedFormatError are raised.
187
If there is one, it is returned, along with the unused portion of url.
189
control, relpath = bzrdir.BzrDir.open_containing(url,
191
return control.open_branch(), relpath
193
def _push_should_merge_tags(self):
194
"""Should _basic_push merge this branch's tags into the target?
196
The default implementation returns False if this branch has no tags,
197
and True the rest of the time. Subclasses may override this.
199
return self.supports_tags() and self.tags.get_tag_dict()
201
def get_config(self):
202
return BranchConfig(self)
204
def _get_config(self):
205
"""Get the concrete config for just the config in this branch.
207
This is not intended for client use; see Branch.get_config for the
212
:return: An object supporting get_option and set_option.
214
raise NotImplementedError(self._get_config)
216
def _get_fallback_repository(self, url):
217
"""Get the repository we fallback to at url."""
218
url = urlutils.join(self.base, url)
219
a_bzrdir = bzrdir.BzrDir.open(url,
220
possible_transports=[self.bzrdir.root_transport])
221
return a_bzrdir.open_branch().repository
223
def _get_tags_bytes(self):
224
"""Get the bytes of a serialised tags dict.
226
Note that not all branches support tags, nor do all use the same tags
227
logic: this method is specific to BasicTags. Other tag implementations
228
may use the same method name and behave differently, safely, because
229
of the double-dispatch via
230
format.make_tags->tags_instance->get_tags_dict.
232
:return: The bytes of the tags file.
233
:seealso: Branch._set_tags_bytes.
235
return self._transport.get_bytes('tags')
237
def _get_nick(self, local=False, possible_transports=None):
238
config = self.get_config()
239
# explicit overrides master, but don't look for master if local is True
240
if not local and not config.has_explicit_nickname():
242
master = self.get_master_branch(possible_transports)
243
if master is not None:
244
# return the master branch value
246
except errors.BzrError, e:
247
# Silently fall back to local implicit nick if the master is
249
mutter("Could not connect to bound branch, "
250
"falling back to local nick.\n " + str(e))
251
return config.get_nickname()
253
def _set_nick(self, nick):
254
self.get_config().set_user_option('nickname', nick, warn_masked=True)
256
nick = property(_get_nick, _set_nick)
259
raise NotImplementedError(self.is_locked)
261
def _lefthand_history(self, revision_id, last_rev=None,
263
if 'evil' in debug.debug_flags:
264
mutter_callsite(4, "_lefthand_history scales with history.")
265
# stop_revision must be a descendant of last_revision
266
graph = self.repository.get_graph()
267
if last_rev is not None:
268
if not graph.is_ancestor(last_rev, revision_id):
269
# our previous tip is not merged into stop_revision
270
raise errors.DivergedBranches(self, other_branch)
271
# make a new revision history from the graph
272
parents_map = graph.get_parent_map([revision_id])
273
if revision_id not in parents_map:
274
raise errors.NoSuchRevision(self, revision_id)
275
current_rev_id = revision_id
277
check_not_reserved_id = _mod_revision.check_not_reserved_id
278
# Do not include ghosts or graph origin in revision_history
279
while (current_rev_id in parents_map and
280
len(parents_map[current_rev_id]) > 0):
281
check_not_reserved_id(current_rev_id)
282
new_history.append(current_rev_id)
283
current_rev_id = parents_map[current_rev_id][0]
284
parents_map = graph.get_parent_map([current_rev_id])
285
new_history.reverse()
288
def lock_write(self):
289
raise NotImplementedError(self.lock_write)
292
raise NotImplementedError(self.lock_read)
295
raise NotImplementedError(self.unlock)
297
def peek_lock_mode(self):
298
"""Return lock mode for the Branch: 'r', 'w' or None"""
299
raise NotImplementedError(self.peek_lock_mode)
301
def get_physical_lock_status(self):
302
raise NotImplementedError(self.get_physical_lock_status)
305
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
306
"""Return the revision_id for a dotted revno.
308
:param revno: a tuple like (1,) or (1,1,2)
309
:param _cache_reverse: a private parameter enabling storage
310
of the reverse mapping in a top level cache. (This should
311
only be done in selective circumstances as we want to
312
avoid having the mapping cached multiple times.)
313
:return: the revision_id
314
:raises errors.NoSuchRevision: if the revno doesn't exist
316
rev_id = self._do_dotted_revno_to_revision_id(revno)
318
self._partial_revision_id_to_revno_cache[rev_id] = revno
321
def _do_dotted_revno_to_revision_id(self, revno):
322
"""Worker function for dotted_revno_to_revision_id.
324
Subclasses should override this if they wish to
325
provide a more efficient implementation.
328
return self.get_rev_id(revno[0])
329
revision_id_to_revno = self.get_revision_id_to_revno_map()
330
revision_ids = [revision_id for revision_id, this_revno
331
in revision_id_to_revno.iteritems()
332
if revno == this_revno]
333
if len(revision_ids) == 1:
334
return revision_ids[0]
336
revno_str = '.'.join(map(str, revno))
337
raise errors.NoSuchRevision(self, revno_str)
340
def revision_id_to_dotted_revno(self, revision_id):
341
"""Given a revision id, return its dotted revno.
343
:return: a tuple like (1,) or (400,1,3).
345
return self._do_revision_id_to_dotted_revno(revision_id)
347
def _do_revision_id_to_dotted_revno(self, revision_id):
348
"""Worker function for revision_id_to_revno."""
349
# Try the caches if they are loaded
350
result = self._partial_revision_id_to_revno_cache.get(revision_id)
351
if result is not None:
353
if self._revision_id_to_revno_cache:
354
result = self._revision_id_to_revno_cache.get(revision_id)
356
raise errors.NoSuchRevision(self, revision_id)
357
# Try the mainline as it's optimised
359
revno = self.revision_id_to_revno(revision_id)
361
except errors.NoSuchRevision:
362
# We need to load and use the full revno map after all
363
result = self.get_revision_id_to_revno_map().get(revision_id)
365
raise errors.NoSuchRevision(self, revision_id)
369
def get_revision_id_to_revno_map(self):
370
"""Return the revision_id => dotted revno map.
372
This will be regenerated on demand, but will be cached.
374
:return: A dictionary mapping revision_id => dotted revno.
375
This dictionary should not be modified by the caller.
377
if self._revision_id_to_revno_cache is not None:
378
mapping = self._revision_id_to_revno_cache
380
mapping = self._gen_revno_map()
381
self._cache_revision_id_to_revno(mapping)
382
# TODO: jam 20070417 Since this is being cached, should we be returning
384
# I would rather not, and instead just declare that users should not
385
# modify the return value.
388
def _gen_revno_map(self):
389
"""Create a new mapping from revision ids to dotted revnos.
391
Dotted revnos are generated based on the current tip in the revision
393
This is the worker function for get_revision_id_to_revno_map, which
394
just caches the return value.
396
:return: A dictionary mapping revision_id => dotted revno.
398
revision_id_to_revno = dict((rev_id, revno)
399
for rev_id, depth, revno, end_of_merge
400
in self.iter_merge_sorted_revisions())
401
return revision_id_to_revno
404
def iter_merge_sorted_revisions(self, start_revision_id=None,
405
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
406
"""Walk the revisions for a branch in merge sorted order.
408
Merge sorted order is the output from a merge-aware,
409
topological sort, i.e. all parents come before their
410
children going forward; the opposite for reverse.
412
:param start_revision_id: the revision_id to begin walking from.
413
If None, the branch tip is used.
414
:param stop_revision_id: the revision_id to terminate the walk
415
after. If None, the rest of history is included.
416
:param stop_rule: if stop_revision_id is not None, the precise rule
417
to use for termination:
418
* 'exclude' - leave the stop revision out of the result (default)
419
* 'include' - the stop revision is the last item in the result
420
* 'with-merges' - include the stop revision and all of its
421
merged revisions in the result
422
:param direction: either 'reverse' or 'forward':
423
* reverse means return the start_revision_id first, i.e.
424
start at the most recent revision and go backwards in history
425
* forward returns tuples in the opposite order to reverse.
426
Note in particular that forward does *not* do any intelligent
427
ordering w.r.t. depth as some clients of this API may like.
428
(If required, that ought to be done at higher layers.)
430
:return: an iterator over (revision_id, depth, revno, end_of_merge)
433
* revision_id: the unique id of the revision
434
* depth: How many levels of merging deep this node has been
436
* revno_sequence: This field provides a sequence of
437
revision numbers for all revisions. The format is:
438
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
439
branch that the revno is on. From left to right the REVNO numbers
440
are the sequence numbers within that branch of the revision.
441
* end_of_merge: When True the next node (earlier in history) is
442
part of a different merge.
444
# Note: depth and revno values are in the context of the branch so
445
# we need the full graph to get stable numbers, regardless of the
447
if self._merge_sorted_revisions_cache is None:
448
last_revision = self.last_revision()
449
last_key = (last_revision,)
450
known_graph = self.repository.revisions.get_known_graph_ancestry(
452
self._merge_sorted_revisions_cache = known_graph.merge_sort(
454
filtered = self._filter_merge_sorted_revisions(
455
self._merge_sorted_revisions_cache, start_revision_id,
456
stop_revision_id, stop_rule)
457
if direction == 'reverse':
459
if direction == 'forward':
460
return reversed(list(filtered))
462
raise ValueError('invalid direction %r' % direction)
464
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
465
start_revision_id, stop_revision_id, stop_rule):
466
"""Iterate over an inclusive range of sorted revisions."""
467
rev_iter = iter(merge_sorted_revisions)
468
if start_revision_id is not None:
469
for node in rev_iter:
470
rev_id = node.key[-1]
471
if rev_id != start_revision_id:
474
# The decision to include the start or not
475
# depends on the stop_rule if a stop is provided
476
# so pop this node back into the iterator
477
rev_iter = chain(iter([node]), rev_iter)
479
if stop_revision_id is None:
481
for node in rev_iter:
482
rev_id = node.key[-1]
483
yield (rev_id, node.merge_depth, node.revno,
485
elif stop_rule == 'exclude':
486
for node in rev_iter:
487
rev_id = node.key[-1]
488
if rev_id == stop_revision_id:
490
yield (rev_id, node.merge_depth, node.revno,
492
elif stop_rule == 'include':
493
for node in rev_iter:
494
rev_id = node.key[-1]
495
yield (rev_id, node.merge_depth, node.revno,
497
if rev_id == stop_revision_id:
499
elif stop_rule == 'with-merges':
500
stop_rev = self.repository.get_revision(stop_revision_id)
501
if stop_rev.parent_ids:
502
left_parent = stop_rev.parent_ids[0]
504
left_parent = _mod_revision.NULL_REVISION
505
for node in rev_iter:
506
rev_id = node.key[-1]
507
if rev_id == left_parent:
509
yield (rev_id, node.merge_depth, node.revno,
512
raise ValueError('invalid stop_rule %r' % stop_rule)
514
def leave_lock_in_place(self):
515
"""Tell this branch object not to release the physical lock when this
518
If lock_write doesn't return a token, then this method is not supported.
520
self.control_files.leave_in_place()
522
def dont_leave_lock_in_place(self):
523
"""Tell this branch object to release the physical lock when this
524
object is unlocked, even if it didn't originally acquire it.
526
If lock_write doesn't return a token, then this method is not supported.
528
self.control_files.dont_leave_in_place()
530
def bind(self, other):
531
"""Bind the local branch the other branch.
533
:param other: The branch to bind to
536
raise errors.UpgradeRequired(self.base)
538
def set_append_revisions_only(self, enabled):
539
if not self._format.supports_set_append_revisions_only():
540
raise errors.UpgradeRequired(self.base)
545
self.get_config().set_user_option('append_revisions_only', value,
548
def set_reference_info(self, file_id, tree_path, branch_location):
549
"""Set the branch location to use for a tree reference."""
550
raise errors.UnsupportedOperation(self.set_reference_info, self)
552
def get_reference_info(self, file_id):
553
"""Get the tree_path and branch_location for a tree reference."""
554
raise errors.UnsupportedOperation(self.get_reference_info, self)
557
def fetch(self, from_branch, last_revision=None, pb=None):
558
"""Copy revisions from from_branch into this branch.
560
:param from_branch: Where to copy from.
561
:param last_revision: What revision to stop at (None for at the end
563
:param pb: An optional progress bar to use.
566
if self.base == from_branch.base:
569
symbol_versioning.warn(
570
symbol_versioning.deprecated_in((1, 14, 0))
571
% "pb parameter to fetch()")
572
from_branch.lock_read()
574
if last_revision is None:
575
last_revision = from_branch.last_revision()
576
last_revision = _mod_revision.ensure_null(last_revision)
577
return self.repository.fetch(from_branch.repository,
578
revision_id=last_revision,
583
def get_bound_location(self):
584
"""Return the URL of the branch we are bound to.
586
Older format branches cannot bind, please be sure to use a metadir
591
def get_old_bound_location(self):
592
"""Return the URL of the branch we used to be bound to
594
raise errors.UpgradeRequired(self.base)
596
def get_commit_builder(self, parents, config=None, timestamp=None,
597
timezone=None, committer=None, revprops=None,
599
"""Obtain a CommitBuilder for this branch.
601
:param parents: Revision ids of the parents of the new revision.
602
:param config: Optional configuration to use.
603
:param timestamp: Optional timestamp recorded for commit.
604
:param timezone: Optional timezone for timestamp.
605
:param committer: Optional committer to set for commit.
606
:param revprops: Optional dictionary of revision properties.
607
:param revision_id: Optional revision id.
611
config = self.get_config()
613
return self.repository.get_commit_builder(self, parents, config,
614
timestamp, timezone, committer, revprops, revision_id)
616
def get_master_branch(self, possible_transports=None):
617
"""Return the branch we are bound to.
619
:return: Either a Branch, or None
623
def get_revision_delta(self, revno):
624
"""Return the delta for one revision.
626
The delta is relative to its mainline predecessor, or the
627
empty tree for revision 1.
629
rh = self.revision_history()
630
if not (1 <= revno <= len(rh)):
631
raise errors.InvalidRevisionNumber(revno)
632
return self.repository.get_revision_delta(rh[revno-1])
634
def get_stacked_on_url(self):
635
"""Get the URL this branch is stacked against.
637
:raises NotStacked: If the branch is not stacked.
638
:raises UnstackableBranchFormat: If the branch does not support
641
raise NotImplementedError(self.get_stacked_on_url)
643
def print_file(self, file, revision_id):
644
"""Print `file` to stdout."""
645
raise NotImplementedError(self.print_file)
647
def set_revision_history(self, rev_history):
648
raise NotImplementedError(self.set_revision_history)
651
def set_parent(self, url):
652
"""See Branch.set_parent."""
653
# TODO: Maybe delete old location files?
654
# URLs should never be unicode, even on the local fs,
655
# FIXUP this and get_parent in a future branch format bump:
656
# read and rewrite the file. RBC 20060125
658
if isinstance(url, unicode):
660
url = url.encode('ascii')
661
except UnicodeEncodeError:
662
raise errors.InvalidURL(url,
663
"Urls must be 7-bit ascii, "
664
"use bzrlib.urlutils.escape")
665
url = urlutils.relative_url(self.base, url)
666
self._set_parent_location(url)
669
def set_stacked_on_url(self, url):
670
"""Set the URL this branch is stacked against.
672
:raises UnstackableBranchFormat: If the branch does not support
674
:raises UnstackableRepositoryFormat: If the repository does not support
677
if not self._format.supports_stacking():
678
raise errors.UnstackableBranchFormat(self._format, self.base)
679
# XXX: Changing from one fallback repository to another does not check
680
# that all the data you need is present in the new fallback.
681
# Possibly it should.
682
self._check_stackable_repo()
685
old_url = self.get_stacked_on_url()
686
except (errors.NotStacked, errors.UnstackableBranchFormat,
687
errors.UnstackableRepositoryFormat):
691
self._activate_fallback_location(url)
692
# write this out after the repository is stacked to avoid setting a
693
# stacked config that doesn't work.
694
self._set_config_location('stacked_on_location', url)
697
"""Change a branch to be unstacked, copying data as needed.
699
Don't call this directly, use set_stacked_on_url(None).
701
pb = ui.ui_factory.nested_progress_bar()
703
pb.update("Unstacking")
704
# The basic approach here is to fetch the tip of the branch,
705
# including all available ghosts, from the existing stacked
706
# repository into a new repository object without the fallbacks.
708
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
709
# correct for CHKMap repostiories
710
old_repository = self.repository
711
if len(old_repository._fallback_repositories) != 1:
712
raise AssertionError("can't cope with fallback repositories "
713
"of %r" % (self.repository,))
714
# unlock it, including unlocking the fallback
715
old_repository.unlock()
716
old_repository.lock_read()
718
# Repositories don't offer an interface to remove fallback
719
# repositories today; take the conceptually simpler option and just
720
# reopen it. We reopen it starting from the URL so that we
721
# get a separate connection for RemoteRepositories and can
722
# stream from one of them to the other. This does mean doing
723
# separate SSH connection setup, but unstacking is not a
724
# common operation so it's tolerable.
725
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
726
new_repository = new_bzrdir.find_repository()
727
self.repository = new_repository
728
if self.repository._fallback_repositories:
729
raise AssertionError("didn't expect %r to have "
730
"fallback_repositories"
731
% (self.repository,))
732
# this is not paired with an unlock because it's just restoring
733
# the previous state; the lock's released when set_stacked_on_url
735
self.repository.lock_write()
736
# XXX: If you unstack a branch while it has a working tree
737
# with a pending merge, the pending-merged revisions will no
738
# longer be present. You can (probably) revert and remerge.
740
# XXX: This only fetches up to the tip of the repository; it
741
# doesn't bring across any tags. That's fairly consistent
742
# with how branch works, but perhaps not ideal.
743
self.repository.fetch(old_repository,
744
revision_id=self.last_revision(),
747
old_repository.unlock()
751
def _set_tags_bytes(self, bytes):
752
"""Mirror method for _get_tags_bytes.
754
:seealso: Branch._get_tags_bytes.
756
return _run_with_write_locked_target(self, self._transport.put_bytes,
759
def _cache_revision_history(self, rev_history):
760
"""Set the cached revision history to rev_history.
762
The revision_history method will use this cache to avoid regenerating
763
the revision history.
765
This API is semi-public; it only for use by subclasses, all other code
766
should consider it to be private.
768
self._revision_history_cache = rev_history
770
def _cache_revision_id_to_revno(self, revision_id_to_revno):
771
"""Set the cached revision_id => revno map to revision_id_to_revno.
773
This API is semi-public; it only for use by subclasses, all other code
774
should consider it to be private.
776
self._revision_id_to_revno_cache = revision_id_to_revno
778
def _clear_cached_state(self):
779
"""Clear any cached data on this branch, e.g. cached revision history.
781
This means the next call to revision_history will need to call
782
_gen_revision_history.
784
This API is semi-public; it only for use by subclasses, all other code
785
should consider it to be private.
787
self._revision_history_cache = None
788
self._revision_id_to_revno_cache = None
789
self._last_revision_info_cache = None
790
self._merge_sorted_revisions_cache = None
791
self._partial_revision_history_cache = []
792
self._partial_revision_id_to_revno_cache = {}
794
def _gen_revision_history(self):
795
"""Return sequence of revision hashes on to this branch.
797
Unlike revision_history, this method always regenerates or rereads the
798
revision history, i.e. it does not cache the result, so repeated calls
801
Concrete subclasses should override this instead of revision_history so
802
that subclasses do not need to deal with caching logic.
804
This API is semi-public; it only for use by subclasses, all other code
805
should consider it to be private.
807
raise NotImplementedError(self._gen_revision_history)
810
def revision_history(self):
811
"""Return sequence of revision ids on this branch.
813
This method will cache the revision history for as long as it is safe to
816
if 'evil' in debug.debug_flags:
817
mutter_callsite(3, "revision_history scales with history.")
818
if self._revision_history_cache is not None:
819
history = self._revision_history_cache
821
history = self._gen_revision_history()
822
self._cache_revision_history(history)
826
"""Return current revision number for this branch.
828
That is equivalent to the number of revisions committed to
831
return self.last_revision_info()[0]
834
"""Older format branches cannot bind or unbind."""
835
raise errors.UpgradeRequired(self.base)
837
def last_revision(self):
838
"""Return last revision id, or NULL_REVISION."""
839
return self.last_revision_info()[1]
842
def last_revision_info(self):
843
"""Return information about the last revision.
845
:return: A tuple (revno, revision_id).
847
if self._last_revision_info_cache is None:
848
self._last_revision_info_cache = self._last_revision_info()
849
return self._last_revision_info_cache
851
def _last_revision_info(self):
852
rh = self.revision_history()
855
return (revno, rh[-1])
857
return (0, _mod_revision.NULL_REVISION)
859
@deprecated_method(deprecated_in((1, 6, 0)))
860
def missing_revisions(self, other, stop_revision=None):
861
"""Return a list of new revisions that would perfectly fit.
863
If self and other have not diverged, return a list of the revisions
864
present in other, but missing from self.
866
self_history = self.revision_history()
867
self_len = len(self_history)
868
other_history = other.revision_history()
869
other_len = len(other_history)
870
common_index = min(self_len, other_len) -1
871
if common_index >= 0 and \
872
self_history[common_index] != other_history[common_index]:
873
raise errors.DivergedBranches(self, other)
875
if stop_revision is None:
876
stop_revision = other_len
878
if stop_revision > other_len:
879
raise errors.NoSuchRevision(self, stop_revision)
880
return other_history[self_len:stop_revision]
883
def update_revisions(self, other, stop_revision=None, overwrite=False,
885
"""Pull in new perfect-fit revisions.
887
:param other: Another Branch to pull from
888
:param stop_revision: Updated until the given revision
889
:param overwrite: Always set the branch pointer, rather than checking
890
to see if it is a proper descendant.
891
:param graph: A Graph object that can be used to query history
892
information. This can be None.
895
return InterBranch.get(other, self).update_revisions(stop_revision,
898
def import_last_revision_info(self, source_repo, revno, revid):
899
"""Set the last revision info, importing from another repo if necessary.
901
This is used by the bound branch code to upload a revision to
902
the master branch first before updating the tip of the local branch.
904
:param source_repo: Source repository to optionally fetch from
905
:param revno: Revision number of the new tip
906
:param revid: Revision id of the new tip
908
if not self.repository.has_same_location(source_repo):
909
self.repository.fetch(source_repo, revision_id=revid)
910
self.set_last_revision_info(revno, revid)
912
def revision_id_to_revno(self, revision_id):
913
"""Given a revision id, return its revno"""
914
if _mod_revision.is_null(revision_id):
916
history = self.revision_history()
918
return history.index(revision_id) + 1
920
raise errors.NoSuchRevision(self, revision_id)
923
def get_rev_id(self, revno, history=None):
924
"""Find the revision id of the specified revno."""
926
return _mod_revision.NULL_REVISION
927
last_revno, last_revid = self.last_revision_info()
928
if revno == last_revno:
930
if revno <= 0 or revno > last_revno:
931
raise errors.NoSuchRevision(self, revno)
932
distance_from_last = last_revno - revno
933
if len(self._partial_revision_history_cache) <= distance_from_last:
934
self._extend_partial_history(distance_from_last)
935
return self._partial_revision_history_cache[distance_from_last]
938
def pull(self, source, overwrite=False, stop_revision=None,
939
possible_transports=None, *args, **kwargs):
940
"""Mirror source into this branch.
942
This branch is considered to be 'local', having low latency.
944
:returns: PullResult instance
946
return InterBranch.get(source, self).pull(overwrite=overwrite,
947
stop_revision=stop_revision,
948
possible_transports=possible_transports, *args, **kwargs)
950
def push(self, target, overwrite=False, stop_revision=None, *args,
952
"""Mirror this branch into target.
954
This branch is considered to be 'local', having low latency.
956
return InterBranch.get(self, target).push(overwrite, stop_revision,
959
def lossy_push(self, target, stop_revision=None):
960
"""Push deltas into another branch.
962
:note: This does not, like push, retain the revision ids from
963
the source branch and will, rather than adding bzr-specific
964
metadata, push only those semantics of the revision that can be
965
natively represented by this branch' VCS.
967
:param target: Target branch
968
:param stop_revision: Revision to push, defaults to last revision.
969
:return: BranchPushResult with an extra member revidmap:
970
A dictionary mapping revision ids from the target branch
971
to new revision ids in the target branch, for each
972
revision that was pushed.
974
inter = InterBranch.get(self, target)
975
lossy_push = getattr(inter, "lossy_push", None)
976
if lossy_push is None:
977
raise errors.LossyPushToSameVCS(self, target)
978
return lossy_push(stop_revision)
980
def basis_tree(self):
981
"""Return `Tree` object for last revision."""
982
return self.repository.revision_tree(self.last_revision())
984
def get_parent(self):
985
"""Return the parent location of the branch.
987
This is the default location for pull/missing. The usual
988
pattern is that the user can override it by specifying a
991
parent = self._get_parent_location()
994
# This is an old-format absolute path to a local branch
996
if parent.startswith('/'):
997
parent = urlutils.local_path_to_url(parent.decode('utf8'))
999
return urlutils.join(self.base[:-1], parent)
1000
except errors.InvalidURLJoin, e:
1001
raise errors.InaccessibleParent(parent, self.base)
1003
def _get_parent_location(self):
1004
raise NotImplementedError(self._get_parent_location)
1006
def _set_config_location(self, name, url, config=None,
1007
make_relative=False):
1009
config = self.get_config()
1013
url = urlutils.relative_url(self.base, url)
1014
config.set_user_option(name, url, warn_masked=True)
1016
def _get_config_location(self, name, config=None):
1018
config = self.get_config()
1019
location = config.get_user_option(name)
1024
def get_child_submit_format(self):
1025
"""Return the preferred format of submissions to this branch."""
1026
return self.get_config().get_user_option("child_submit_format")
1028
def get_submit_branch(self):
1029
"""Return the submit location of the branch.
1031
This is the default location for bundle. The usual
1032
pattern is that the user can override it by specifying a
1035
return self.get_config().get_user_option('submit_branch')
1037
def set_submit_branch(self, location):
1038
"""Return the submit location of the branch.
1040
This is the default location for bundle. The usual
1041
pattern is that the user can override it by specifying a
1044
self.get_config().set_user_option('submit_branch', location,
1047
def get_public_branch(self):
1048
"""Return the public location of the branch.
1050
This is used by merge directives.
1052
return self._get_config_location('public_branch')
1054
def set_public_branch(self, location):
1055
"""Return the submit location of the branch.
1057
This is the default location for bundle. The usual
1058
pattern is that the user can override it by specifying a
1061
self._set_config_location('public_branch', location)
1063
def get_push_location(self):
1064
"""Return the None or the location to push this branch to."""
1065
push_loc = self.get_config().get_user_option('push_location')
1068
def set_push_location(self, location):
1069
"""Set a new push location for this branch."""
1070
raise NotImplementedError(self.set_push_location)
1072
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1073
"""Run the post_change_branch_tip hooks."""
1074
hooks = Branch.hooks['post_change_branch_tip']
1077
new_revno, new_revid = self.last_revision_info()
1078
params = ChangeBranchTipParams(
1079
self, old_revno, new_revno, old_revid, new_revid)
1083
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1084
"""Run the pre_change_branch_tip hooks."""
1085
hooks = Branch.hooks['pre_change_branch_tip']
1088
old_revno, old_revid = self.last_revision_info()
1089
params = ChangeBranchTipParams(
1090
self, old_revno, new_revno, old_revid, new_revid)
1094
except errors.TipChangeRejected:
1097
exc_info = sys.exc_info()
1098
hook_name = Branch.hooks.get_hook_name(hook)
1099
raise errors.HookFailed(
1100
'pre_change_branch_tip', hook_name, exc_info)
1104
"""Synchronise this branch with the master branch if any.
1106
:return: None or the last_revision pivoted out during the update.
1110
def check_revno(self, revno):
1112
Check whether a revno corresponds to any revision.
1113
Zero (the NULL revision) is considered valid.
1116
self.check_real_revno(revno)
1118
def check_real_revno(self, revno):
1120
Check whether a revno corresponds to a real revision.
1121
Zero (the NULL revision) is considered invalid
1123
if revno < 1 or revno > self.revno():
1124
raise errors.InvalidRevisionNumber(revno)
1127
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1128
"""Clone this branch into to_bzrdir preserving all semantic values.
1130
Most API users will want 'create_clone_on_transport', which creates a
1131
new bzrdir and branch on the fly.
1133
revision_id: if not None, the revision history in the new branch will
1134
be truncated to end with revision_id.
1136
result = to_bzrdir.create_branch()
1139
if repository_policy is not None:
1140
repository_policy.configure_branch(result)
1141
self.copy_content_into(result, revision_id=revision_id)
1147
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1148
"""Create a new line of development from the branch, into to_bzrdir.
1150
to_bzrdir controls the branch format.
1152
revision_id: if not None, the revision history in the new branch will
1153
be truncated to end with revision_id.
1155
result = to_bzrdir.create_branch()
1158
if repository_policy is not None:
1159
repository_policy.configure_branch(result)
1160
self.copy_content_into(result, revision_id=revision_id)
1161
result.set_parent(self.bzrdir.root_transport.base)
1166
def _synchronize_history(self, destination, revision_id):
1167
"""Synchronize last revision and revision history between branches.
1169
This version is most efficient when the destination is also a
1170
BzrBranch6, but works for BzrBranch5, as long as the destination's
1171
repository contains all the lefthand ancestors of the intended
1172
last_revision. If not, set_last_revision_info will fail.
1174
:param destination: The branch to copy the history into
1175
:param revision_id: The revision-id to truncate history at. May
1176
be None to copy complete history.
1178
source_revno, source_revision_id = self.last_revision_info()
1179
if revision_id is None:
1180
revno, revision_id = source_revno, source_revision_id
1182
graph = self.repository.get_graph()
1184
revno = graph.find_distance_to_null(revision_id,
1185
[(source_revision_id, source_revno)])
1186
except errors.GhostRevisionsHaveNoRevno:
1187
# Default to 1, if we can't find anything else
1189
destination.set_last_revision_info(revno, revision_id)
1192
def copy_content_into(self, destination, revision_id=None):
1193
"""Copy the content of self into destination.
1195
revision_id: if not None, the revision history in the new branch will
1196
be truncated to end with revision_id.
1198
self.update_references(destination)
1199
self._synchronize_history(destination, revision_id)
1201
parent = self.get_parent()
1202
except errors.InaccessibleParent, e:
1203
mutter('parent was not accessible to copy: %s', e)
1206
destination.set_parent(parent)
1207
if self._push_should_merge_tags():
1208
self.tags.merge_to(destination.tags)
1210
def update_references(self, target):
1211
if not getattr(self._format, 'supports_reference_locations', False):
1213
reference_dict = self._get_all_reference_info()
1214
if len(reference_dict) == 0:
1216
old_base = self.base
1217
new_base = target.base
1218
target_reference_dict = target._get_all_reference_info()
1219
for file_id, (tree_path, branch_location) in (
1220
reference_dict.items()):
1221
branch_location = urlutils.rebase_url(branch_location,
1223
target_reference_dict.setdefault(
1224
file_id, (tree_path, branch_location))
1225
target._set_all_reference_info(target_reference_dict)
1228
def check(self, refs):
1229
"""Check consistency of the branch.
1231
In particular this checks that revisions given in the revision-history
1232
do actually match up in the revision graph, and that they're all
1233
present in the repository.
1235
Callers will typically also want to check the repository.
1237
:param refs: Calculated refs for this branch as specified by
1238
branch._get_check_refs()
1239
:return: A BranchCheckResult.
1241
result = BranchCheckResult(self)
1242
last_revno, last_revision_id = self.last_revision_info()
1243
actual_revno = refs[('lefthand-distance', last_revision_id)]
1244
if actual_revno != last_revno:
1245
result.errors.append(errors.BzrCheckError(
1246
'revno does not match len(mainline) %s != %s' % (
1247
last_revno, actual_revno)))
1248
# TODO: We should probably also check that self.revision_history
1249
# matches the repository for older branch formats.
1250
# If looking for the code that cross-checks repository parents against
1251
# the iter_reverse_revision_history output, that is now a repository
1255
def _get_checkout_format(self):
1256
"""Return the most suitable metadir for a checkout of this branch.
1257
Weaves are used if this branch's repository uses weaves.
1259
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1260
from bzrlib.repofmt import weaverepo
1261
format = bzrdir.BzrDirMetaFormat1()
1262
format.repository_format = weaverepo.RepositoryFormat7()
1264
format = self.repository.bzrdir.checkout_metadir()
1265
format.set_branch_format(self._format)
1268
def create_clone_on_transport(self, to_transport, revision_id=None,
1269
stacked_on=None, create_prefix=False, use_existing_dir=False):
1270
"""Create a clone of this branch and its bzrdir.
1272
:param to_transport: The transport to clone onto.
1273
:param revision_id: The revision id to use as tip in the new branch.
1274
If None the tip is obtained from this branch.
1275
:param stacked_on: An optional URL to stack the clone on.
1276
:param create_prefix: Create any missing directories leading up to
1278
:param use_existing_dir: Use an existing directory if one exists.
1280
# XXX: Fix the bzrdir API to allow getting the branch back from the
1281
# clone call. Or something. 20090224 RBC/spiv.
1282
if revision_id is None:
1283
revision_id = self.last_revision()
1285
dir_to = self.bzrdir.clone_on_transport(to_transport,
1286
revision_id=revision_id, stacked_on=stacked_on,
1287
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1288
except errors.FileExists:
1289
if not use_existing_dir:
1291
except errors.NoSuchFile:
1292
if not create_prefix:
1294
return dir_to.open_branch()
1296
def create_checkout(self, to_location, revision_id=None,
1297
lightweight=False, accelerator_tree=None,
1299
"""Create a checkout of a branch.
1301
:param to_location: The url to produce the checkout at
1302
:param revision_id: The revision to check out
1303
:param lightweight: If True, produce a lightweight checkout, otherwise,
1304
produce a bound branch (heavyweight checkout)
1305
:param accelerator_tree: A tree which can be used for retrieving file
1306
contents more quickly than the revision tree, i.e. a workingtree.
1307
The revision tree will be used for cases where accelerator_tree's
1308
content is different.
1309
:param hardlink: If true, hard-link files from accelerator_tree,
1311
:return: The tree of the created checkout
1313
t = transport.get_transport(to_location)
1316
format = self._get_checkout_format()
1317
checkout = format.initialize_on_transport(t)
1318
from_branch = BranchReferenceFormat().initialize(checkout, self)
1320
format = self._get_checkout_format()
1321
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1322
to_location, force_new_tree=False, format=format)
1323
checkout = checkout_branch.bzrdir
1324
checkout_branch.bind(self)
1325
# pull up to the specified revision_id to set the initial
1326
# branch tip correctly, and seed it with history.
1327
checkout_branch.pull(self, stop_revision=revision_id)
1329
tree = checkout.create_workingtree(revision_id,
1330
from_branch=from_branch,
1331
accelerator_tree=accelerator_tree,
1333
basis_tree = tree.basis_tree()
1334
basis_tree.lock_read()
1336
for path, file_id in basis_tree.iter_references():
1337
reference_parent = self.reference_parent(file_id, path)
1338
reference_parent.create_checkout(tree.abspath(path),
1339
basis_tree.get_reference_revision(file_id, path),
1346
def reconcile(self, thorough=True):
1347
"""Make sure the data stored in this branch is consistent."""
1348
from bzrlib.reconcile import BranchReconciler
1349
reconciler = BranchReconciler(self, thorough=thorough)
1350
reconciler.reconcile()
1353
def reference_parent(self, file_id, path, possible_transports=None):
1354
"""Return the parent branch for a tree-reference file_id
1355
:param file_id: The file_id of the tree reference
1356
:param path: The path of the file_id in the tree
1357
:return: A branch associated with the file_id
1359
# FIXME should provide multiple branches, based on config
1360
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1361
possible_transports=possible_transports)
1363
def supports_tags(self):
1364
return self._format.supports_tags()
1366
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1368
"""Ensure that revision_b is a descendant of revision_a.
1370
This is a helper function for update_revisions.
1372
:raises: DivergedBranches if revision_b has diverged from revision_a.
1373
:returns: True if revision_b is a descendant of revision_a.
1375
relation = self._revision_relations(revision_a, revision_b, graph)
1376
if relation == 'b_descends_from_a':
1378
elif relation == 'diverged':
1379
raise errors.DivergedBranches(self, other_branch)
1380
elif relation == 'a_descends_from_b':
1383
raise AssertionError("invalid relation: %r" % (relation,))
1385
def _revision_relations(self, revision_a, revision_b, graph):
1386
"""Determine the relationship between two revisions.
1388
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1390
heads = graph.heads([revision_a, revision_b])
1391
if heads == set([revision_b]):
1392
return 'b_descends_from_a'
1393
elif heads == set([revision_a, revision_b]):
1394
# These branches have diverged
1396
elif heads == set([revision_a]):
1397
return 'a_descends_from_b'
1399
raise AssertionError("invalid heads: %r" % (heads,))
1402
class BranchFormat(object):
1403
"""An encapsulation of the initialization and open routines for a format.
1405
Formats provide three things:
1406
* An initialization routine,
1410
Formats are placed in an dict by their format string for reference
1411
during branch opening. Its not required that these be instances, they
1412
can be classes themselves with class methods - it simply depends on
1413
whether state is needed for a given format or not.
1415
Once a format is deprecated, just deprecate the initialize and open
1416
methods on the format class. Do not deprecate the object, as the
1417
object will be created every time regardless.
1420
_default_format = None
1421
"""The default format used for new branches."""
1424
"""The known formats."""
1426
can_set_append_revisions_only = True
1428
def __eq__(self, other):
1429
return self.__class__ is other.__class__
1431
def __ne__(self, other):
1432
return not (self == other)
1435
def find_format(klass, a_bzrdir):
1436
"""Return the format for the branch object in a_bzrdir."""
1438
transport = a_bzrdir.get_branch_transport(None)
1439
format_string = transport.get("format").read()
1440
return klass._formats[format_string]
1441
except errors.NoSuchFile:
1442
raise errors.NotBranchError(path=transport.base)
1444
raise errors.UnknownFormatError(format=format_string, kind='branch')
1447
def get_default_format(klass):
1448
"""Return the current default format."""
1449
return klass._default_format
1451
def get_reference(self, a_bzrdir):
1452
"""Get the target reference of the branch in a_bzrdir.
1454
format probing must have been completed before calling
1455
this method - it is assumed that the format of the branch
1456
in a_bzrdir is correct.
1458
:param a_bzrdir: The bzrdir to get the branch data from.
1459
:return: None if the branch is not a reference branch.
1464
def set_reference(self, a_bzrdir, to_branch):
1465
"""Set the target reference of the branch in a_bzrdir.
1467
format probing must have been completed before calling
1468
this method - it is assumed that the format of the branch
1469
in a_bzrdir is correct.
1471
:param a_bzrdir: The bzrdir to set the branch reference for.
1472
:param to_branch: branch that the checkout is to reference
1474
raise NotImplementedError(self.set_reference)
1476
def get_format_string(self):
1477
"""Return the ASCII format string that identifies this format."""
1478
raise NotImplementedError(self.get_format_string)
1480
def get_format_description(self):
1481
"""Return the short format description for this format."""
1482
raise NotImplementedError(self.get_format_description)
1484
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1486
"""Initialize a branch in a bzrdir, with specified files
1488
:param a_bzrdir: The bzrdir to initialize the branch in
1489
:param utf8_files: The files to create as a list of
1490
(filename, content) tuples
1491
:param set_format: If True, set the format with
1492
self.get_format_string. (BzrBranch4 has its format set
1494
:return: a branch in this format
1496
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1497
branch_transport = a_bzrdir.get_branch_transport(self)
1499
'metadir': ('lock', lockdir.LockDir),
1500
'branch4': ('branch-lock', lockable_files.TransportLock),
1502
lock_name, lock_class = lock_map[lock_type]
1503
control_files = lockable_files.LockableFiles(branch_transport,
1504
lock_name, lock_class)
1505
control_files.create_lock()
1507
control_files.lock_write()
1508
except errors.LockContention:
1509
if lock_type != 'branch4':
1515
utf8_files += [('format', self.get_format_string())]
1517
for (filename, content) in utf8_files:
1518
branch_transport.put_bytes(
1520
mode=a_bzrdir._get_file_mode())
1523
control_files.unlock()
1524
return self.open(a_bzrdir, _found=True)
1526
def initialize(self, a_bzrdir):
1527
"""Create a branch of this format in a_bzrdir."""
1528
raise NotImplementedError(self.initialize)
1530
def is_supported(self):
1531
"""Is this format supported?
1533
Supported formats can be initialized and opened.
1534
Unsupported formats may not support initialization or committing or
1535
some other features depending on the reason for not being supported.
1539
def make_tags(self, branch):
1540
"""Create a tags object for branch.
1542
This method is on BranchFormat, because BranchFormats are reflected
1543
over the wire via network_name(), whereas full Branch instances require
1544
multiple VFS method calls to operate at all.
1546
The default implementation returns a disabled-tags instance.
1548
Note that it is normal for branch to be a RemoteBranch when using tags
1551
return DisabledTags(branch)
1553
def network_name(self):
1554
"""A simple byte string uniquely identifying this format for RPC calls.
1556
MetaDir branch formats use their disk format string to identify the
1557
repository over the wire. All in one formats such as bzr < 0.8, and
1558
foreign formats like svn/git and hg should use some marker which is
1559
unique and immutable.
1561
raise NotImplementedError(self.network_name)
1563
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1564
"""Return the branch object for a_bzrdir
1566
:param a_bzrdir: A BzrDir that contains a branch.
1567
:param _found: a private parameter, do not use it. It is used to
1568
indicate if format probing has already be done.
1569
:param ignore_fallbacks: when set, no fallback branches will be opened
1570
(if there are any). Default is to open fallbacks.
1572
raise NotImplementedError(self.open)
1575
def register_format(klass, format):
1576
"""Register a metadir format."""
1577
klass._formats[format.get_format_string()] = format
1578
# Metadir formats have a network name of their format string, and get
1579
# registered as class factories.
1580
network_format_registry.register(format.get_format_string(), format.__class__)
1583
def set_default_format(klass, format):
1584
klass._default_format = format
1586
def supports_set_append_revisions_only(self):
1587
"""True if this format supports set_append_revisions_only."""
1590
def supports_stacking(self):
1591
"""True if this format records a stacked-on branch."""
1595
def unregister_format(klass, format):
1596
del klass._formats[format.get_format_string()]
1599
return self.get_format_description().rstrip()
1601
def supports_tags(self):
1602
"""True if this format supports tags stored in the branch"""
1603
return False # by default
1606
class BranchHooks(Hooks):
1607
"""A dictionary mapping hook name to a list of callables for branch hooks.
1609
e.g. ['set_rh'] Is the list of items to be called when the
1610
set_revision_history function is invoked.
1614
"""Create the default hooks.
1616
These are all empty initially, because by default nothing should get
1619
Hooks.__init__(self)
1620
self.create_hook(HookPoint('set_rh',
1621
"Invoked whenever the revision history has been set via "
1622
"set_revision_history. The api signature is (branch, "
1623
"revision_history), and the branch will be write-locked. "
1624
"The set_rh hook can be expensive for bzr to trigger, a better "
1625
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1626
self.create_hook(HookPoint('open',
1627
"Called with the Branch object that has been opened after a "
1628
"branch is opened.", (1, 8), None))
1629
self.create_hook(HookPoint('post_push',
1630
"Called after a push operation completes. post_push is called "
1631
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1632
"bzr client.", (0, 15), None))
1633
self.create_hook(HookPoint('post_pull',
1634
"Called after a pull operation completes. post_pull is called "
1635
"with a bzrlib.branch.PullResult object and only runs in the "
1636
"bzr client.", (0, 15), None))
1637
self.create_hook(HookPoint('pre_commit',
1638
"Called after a commit is calculated but before it is is "
1639
"completed. pre_commit is called with (local, master, old_revno, "
1640
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1641
"). old_revid is NULL_REVISION for the first commit to a branch, "
1642
"tree_delta is a TreeDelta object describing changes from the "
1643
"basis revision. hooks MUST NOT modify this delta. "
1644
" future_tree is an in-memory tree obtained from "
1645
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1646
"tree.", (0,91), None))
1647
self.create_hook(HookPoint('post_commit',
1648
"Called in the bzr client after a commit has completed. "
1649
"post_commit is called with (local, master, old_revno, old_revid, "
1650
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1651
"commit to a branch.", (0, 15), None))
1652
self.create_hook(HookPoint('post_uncommit',
1653
"Called in the bzr client after an uncommit completes. "
1654
"post_uncommit is called with (local, master, old_revno, "
1655
"old_revid, new_revno, new_revid) where local is the local branch "
1656
"or None, master is the target branch, and an empty branch "
1657
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1658
self.create_hook(HookPoint('pre_change_branch_tip',
1659
"Called in bzr client and server before a change to the tip of a "
1660
"branch is made. pre_change_branch_tip is called with a "
1661
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1662
"commit, uncommit will all trigger this hook.", (1, 6), None))
1663
self.create_hook(HookPoint('post_change_branch_tip',
1664
"Called in bzr client and server after a change to the tip of a "
1665
"branch is made. post_change_branch_tip is called with a "
1666
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1667
"commit, uncommit will all trigger this hook.", (1, 4), None))
1668
self.create_hook(HookPoint('transform_fallback_location',
1669
"Called when a stacked branch is activating its fallback "
1670
"locations. transform_fallback_location is called with (branch, "
1671
"url), and should return a new url. Returning the same url "
1672
"allows it to be used as-is, returning a different one can be "
1673
"used to cause the branch to stack on a closer copy of that "
1674
"fallback_location. Note that the branch cannot have history "
1675
"accessing methods called on it during this hook because the "
1676
"fallback locations have not been activated. When there are "
1677
"multiple hooks installed for transform_fallback_location, "
1678
"all are called with the url returned from the previous hook."
1679
"The order is however undefined.", (1, 9), None))
1682
# install the default hooks into the Branch class.
1683
Branch.hooks = BranchHooks()
1686
class ChangeBranchTipParams(object):
1687
"""Object holding parameters passed to *_change_branch_tip hooks.
1689
There are 5 fields that hooks may wish to access:
1691
:ivar branch: the branch being changed
1692
:ivar old_revno: revision number before the change
1693
:ivar new_revno: revision number after the change
1694
:ivar old_revid: revision id before the change
1695
:ivar new_revid: revision id after the change
1697
The revid fields are strings. The revno fields are integers.
1700
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1701
"""Create a group of ChangeBranchTip parameters.
1703
:param branch: The branch being changed.
1704
:param old_revno: Revision number before the change.
1705
:param new_revno: Revision number after the change.
1706
:param old_revid: Tip revision id before the change.
1707
:param new_revid: Tip revision id after the change.
1709
self.branch = branch
1710
self.old_revno = old_revno
1711
self.new_revno = new_revno
1712
self.old_revid = old_revid
1713
self.new_revid = new_revid
1715
def __eq__(self, other):
1716
return self.__dict__ == other.__dict__
1719
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1720
self.__class__.__name__, self.branch,
1721
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1724
class BzrBranchFormat4(BranchFormat):
1725
"""Bzr branch format 4.
1728
- a revision-history file.
1729
- a branch-lock lock file [ to be shared with the bzrdir ]
1732
def get_format_description(self):
1733
"""See BranchFormat.get_format_description()."""
1734
return "Branch format 4"
1736
def initialize(self, a_bzrdir):
1737
"""Create a branch of this format in a_bzrdir."""
1738
utf8_files = [('revision-history', ''),
1739
('branch-name', ''),
1741
return self._initialize_helper(a_bzrdir, utf8_files,
1742
lock_type='branch4', set_format=False)
1745
super(BzrBranchFormat4, self).__init__()
1746
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1748
def network_name(self):
1749
"""The network name for this format is the control dirs disk label."""
1750
return self._matchingbzrdir.get_format_string()
1752
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1753
"""See BranchFormat.open()."""
1755
# we are being called directly and must probe.
1756
raise NotImplementedError
1757
return BzrBranch(_format=self,
1758
_control_files=a_bzrdir._control_files,
1760
_repository=a_bzrdir.open_repository())
1763
return "Bazaar-NG branch format 4"
1766
class BranchFormatMetadir(BranchFormat):
1767
"""Common logic for meta-dir based branch formats."""
1769
def _branch_class(self):
1770
"""What class to instantiate on open calls."""
1771
raise NotImplementedError(self._branch_class)
1773
def network_name(self):
1774
"""A simple byte string uniquely identifying this format for RPC calls.
1776
Metadir branch formats use their format string.
1778
return self.get_format_string()
1780
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1781
"""See BranchFormat.open()."""
1783
format = BranchFormat.find_format(a_bzrdir)
1784
if format.__class__ != self.__class__:
1785
raise AssertionError("wrong format %r found for %r" %
1788
transport = a_bzrdir.get_branch_transport(None)
1789
control_files = lockable_files.LockableFiles(transport, 'lock',
1791
return self._branch_class()(_format=self,
1792
_control_files=control_files,
1794
_repository=a_bzrdir.find_repository(),
1795
ignore_fallbacks=ignore_fallbacks)
1796
except errors.NoSuchFile:
1797
raise errors.NotBranchError(path=transport.base)
1800
super(BranchFormatMetadir, self).__init__()
1801
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1802
self._matchingbzrdir.set_branch_format(self)
1804
def supports_tags(self):
1808
class BzrBranchFormat5(BranchFormatMetadir):
1809
"""Bzr branch format 5.
1812
- a revision-history file.
1814
- a lock dir guarding the branch itself
1815
- all of this stored in a branch/ subdirectory
1816
- works with shared repositories.
1818
This format is new in bzr 0.8.
1821
def _branch_class(self):
1824
def get_format_string(self):
1825
"""See BranchFormat.get_format_string()."""
1826
return "Bazaar-NG branch format 5\n"
1828
def get_format_description(self):
1829
"""See BranchFormat.get_format_description()."""
1830
return "Branch format 5"
1832
def initialize(self, a_bzrdir):
1833
"""Create a branch of this format in a_bzrdir."""
1834
utf8_files = [('revision-history', ''),
1835
('branch-name', ''),
1837
return self._initialize_helper(a_bzrdir, utf8_files)
1839
def supports_tags(self):
1843
class BzrBranchFormat6(BranchFormatMetadir):
1844
"""Branch format with last-revision and tags.
1846
Unlike previous formats, this has no explicit revision history. Instead,
1847
this just stores the last-revision, and the left-hand history leading
1848
up to there is the history.
1850
This format was introduced in bzr 0.15
1851
and became the default in 0.91.
1854
def _branch_class(self):
1857
def get_format_string(self):
1858
"""See BranchFormat.get_format_string()."""
1859
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1861
def get_format_description(self):
1862
"""See BranchFormat.get_format_description()."""
1863
return "Branch format 6"
1865
def initialize(self, a_bzrdir):
1866
"""Create a branch of this format in a_bzrdir."""
1867
utf8_files = [('last-revision', '0 null:\n'),
1868
('branch.conf', ''),
1871
return self._initialize_helper(a_bzrdir, utf8_files)
1873
def make_tags(self, branch):
1874
"""See bzrlib.branch.BranchFormat.make_tags()."""
1875
return BasicTags(branch)
1877
def supports_set_append_revisions_only(self):
1881
class BzrBranchFormat8(BranchFormatMetadir):
1882
"""Metadir format supporting storing locations of subtree branches."""
1884
def _branch_class(self):
1887
def get_format_string(self):
1888
"""See BranchFormat.get_format_string()."""
1889
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1891
def get_format_description(self):
1892
"""See BranchFormat.get_format_description()."""
1893
return "Branch format 8"
1895
def initialize(self, a_bzrdir):
1896
"""Create a branch of this format in a_bzrdir."""
1897
utf8_files = [('last-revision', '0 null:\n'),
1898
('branch.conf', ''),
1902
return self._initialize_helper(a_bzrdir, utf8_files)
1905
super(BzrBranchFormat8, self).__init__()
1906
self._matchingbzrdir.repository_format = \
1907
RepositoryFormatKnitPack5RichRoot()
1909
def make_tags(self, branch):
1910
"""See bzrlib.branch.BranchFormat.make_tags()."""
1911
return BasicTags(branch)
1913
def supports_set_append_revisions_only(self):
1916
def supports_stacking(self):
1919
supports_reference_locations = True
1922
class BzrBranchFormat7(BzrBranchFormat8):
1923
"""Branch format with last-revision, tags, and a stacked location pointer.
1925
The stacked location pointer is passed down to the repository and requires
1926
a repository format with supports_external_lookups = True.
1928
This format was introduced in bzr 1.6.
1931
def initialize(self, a_bzrdir):
1932
"""Create a branch of this format in a_bzrdir."""
1933
utf8_files = [('last-revision', '0 null:\n'),
1934
('branch.conf', ''),
1937
return self._initialize_helper(a_bzrdir, utf8_files)
1939
def _branch_class(self):
1942
def get_format_string(self):
1943
"""See BranchFormat.get_format_string()."""
1944
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1946
def get_format_description(self):
1947
"""See BranchFormat.get_format_description()."""
1948
return "Branch format 7"
1950
def supports_set_append_revisions_only(self):
1953
supports_reference_locations = False
1956
class BranchReferenceFormat(BranchFormat):
1957
"""Bzr branch reference format.
1959
Branch references are used in implementing checkouts, they
1960
act as an alias to the real branch which is at some other url.
1967
def get_format_string(self):
1968
"""See BranchFormat.get_format_string()."""
1969
return "Bazaar-NG Branch Reference Format 1\n"
1971
def get_format_description(self):
1972
"""See BranchFormat.get_format_description()."""
1973
return "Checkout reference format 1"
1975
def get_reference(self, a_bzrdir):
1976
"""See BranchFormat.get_reference()."""
1977
transport = a_bzrdir.get_branch_transport(None)
1978
return transport.get('location').read()
1980
def set_reference(self, a_bzrdir, to_branch):
1981
"""See BranchFormat.set_reference()."""
1982
transport = a_bzrdir.get_branch_transport(None)
1983
location = transport.put_bytes('location', to_branch.base)
1985
def initialize(self, a_bzrdir, target_branch=None):
1986
"""Create a branch of this format in a_bzrdir."""
1987
if target_branch is None:
1988
# this format does not implement branch itself, thus the implicit
1989
# creation contract must see it as uninitializable
1990
raise errors.UninitializableFormat(self)
1991
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1992
branch_transport = a_bzrdir.get_branch_transport(self)
1993
branch_transport.put_bytes('location',
1994
target_branch.bzrdir.root_transport.base)
1995
branch_transport.put_bytes('format', self.get_format_string())
1997
a_bzrdir, _found=True,
1998
possible_transports=[target_branch.bzrdir.root_transport])
2001
super(BranchReferenceFormat, self).__init__()
2002
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2003
self._matchingbzrdir.set_branch_format(self)
2005
def _make_reference_clone_function(format, a_branch):
2006
"""Create a clone() routine for a branch dynamically."""
2007
def clone(to_bzrdir, revision_id=None,
2008
repository_policy=None):
2009
"""See Branch.clone()."""
2010
return format.initialize(to_bzrdir, a_branch)
2011
# cannot obey revision_id limits when cloning a reference ...
2012
# FIXME RBC 20060210 either nuke revision_id for clone, or
2013
# emit some sort of warning/error to the caller ?!
2016
def open(self, a_bzrdir, _found=False, location=None,
2017
possible_transports=None, ignore_fallbacks=False):
2018
"""Return the branch that the branch reference in a_bzrdir points at.
2020
:param a_bzrdir: A BzrDir that contains a branch.
2021
:param _found: a private parameter, do not use it. It is used to
2022
indicate if format probing has already be done.
2023
:param ignore_fallbacks: when set, no fallback branches will be opened
2024
(if there are any). Default is to open fallbacks.
2025
:param location: The location of the referenced branch. If
2026
unspecified, this will be determined from the branch reference in
2028
:param possible_transports: An optional reusable transports list.
2031
format = BranchFormat.find_format(a_bzrdir)
2032
if format.__class__ != self.__class__:
2033
raise AssertionError("wrong format %r found for %r" %
2035
if location is None:
2036
location = self.get_reference(a_bzrdir)
2037
real_bzrdir = bzrdir.BzrDir.open(
2038
location, possible_transports=possible_transports)
2039
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2040
# this changes the behaviour of result.clone to create a new reference
2041
# rather than a copy of the content of the branch.
2042
# I did not use a proxy object because that needs much more extensive
2043
# testing, and we are only changing one behaviour at the moment.
2044
# If we decide to alter more behaviours - i.e. the implicit nickname
2045
# then this should be refactored to introduce a tested proxy branch
2046
# and a subclass of that for use in overriding clone() and ....
2048
result.clone = self._make_reference_clone_function(result)
2052
network_format_registry = registry.FormatRegistry()
2053
"""Registry of formats indexed by their network name.
2055
The network name for a branch format is an identifier that can be used when
2056
referring to formats with smart server operations. See
2057
BranchFormat.network_name() for more detail.
2061
# formats which have no format string are not discoverable
2062
# and not independently creatable, so are not registered.
2063
__format5 = BzrBranchFormat5()
2064
__format6 = BzrBranchFormat6()
2065
__format7 = BzrBranchFormat7()
2066
__format8 = BzrBranchFormat8()
2067
BranchFormat.register_format(__format5)
2068
BranchFormat.register_format(BranchReferenceFormat())
2069
BranchFormat.register_format(__format6)
2070
BranchFormat.register_format(__format7)
2071
BranchFormat.register_format(__format8)
2072
BranchFormat.set_default_format(__format6)
2073
_legacy_formats = [BzrBranchFormat4(),
2075
network_format_registry.register(
2076
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2079
class BzrBranch(Branch):
2080
"""A branch stored in the actual filesystem.
2082
Note that it's "local" in the context of the filesystem; it doesn't
2083
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2084
it's writable, and can be accessed via the normal filesystem API.
2086
:ivar _transport: Transport for file operations on this branch's
2087
control files, typically pointing to the .bzr/branch directory.
2088
:ivar repository: Repository for this branch.
2089
:ivar base: The url of the base directory for this branch; the one
2090
containing the .bzr directory.
2093
def __init__(self, _format=None,
2094
_control_files=None, a_bzrdir=None, _repository=None,
2095
ignore_fallbacks=False):
2096
"""Create new branch object at a particular location."""
2097
if a_bzrdir is None:
2098
raise ValueError('a_bzrdir must be supplied')
2100
self.bzrdir = a_bzrdir
2101
self._base = self.bzrdir.transport.clone('..').base
2102
# XXX: We should be able to just do
2103
# self.base = self.bzrdir.root_transport.base
2104
# but this does not quite work yet -- mbp 20080522
2105
self._format = _format
2106
if _control_files is None:
2107
raise ValueError('BzrBranch _control_files is None')
2108
self.control_files = _control_files
2109
self._transport = _control_files._transport
2110
self.repository = _repository
2111
Branch.__init__(self)
2114
return '%s(%r)' % (self.__class__.__name__, self.base)
2118
def _get_base(self):
2119
"""Returns the directory containing the control directory."""
2122
base = property(_get_base, doc="The URL for the root of this branch.")
2124
def _get_config(self):
2125
return TransportConfig(self._transport, 'branch.conf')
2127
def is_locked(self):
2128
return self.control_files.is_locked()
2130
def lock_write(self, token=None):
2131
# All-in-one needs to always unlock/lock.
2132
repo_control = getattr(self.repository, 'control_files', None)
2133
if self.control_files == repo_control or not self.is_locked():
2134
self.repository.lock_write()
2139
return self.control_files.lock_write(token=token)
2142
self.repository.unlock()
2145
def lock_read(self):
2146
# All-in-one needs to always unlock/lock.
2147
repo_control = getattr(self.repository, 'control_files', None)
2148
if self.control_files == repo_control or not self.is_locked():
2149
self.repository.lock_read()
2154
self.control_files.lock_read()
2157
self.repository.unlock()
2162
self.control_files.unlock()
2164
# All-in-one needs to always unlock/lock.
2165
repo_control = getattr(self.repository, 'control_files', None)
2166
if (self.control_files == repo_control or
2167
not self.control_files.is_locked()):
2168
self.repository.unlock()
2169
if not self.control_files.is_locked():
2170
# we just released the lock
2171
self._clear_cached_state()
2173
def peek_lock_mode(self):
2174
if self.control_files._lock_count == 0:
2177
return self.control_files._lock_mode
2179
def get_physical_lock_status(self):
2180
return self.control_files.get_physical_lock_status()
2183
def print_file(self, file, revision_id):
2184
"""See Branch.print_file."""
2185
return self.repository.print_file(file, revision_id)
2187
def _write_revision_history(self, history):
2188
"""Factored out of set_revision_history.
2190
This performs the actual writing to disk.
2191
It is intended to be called by BzrBranch5.set_revision_history."""
2192
self._transport.put_bytes(
2193
'revision-history', '\n'.join(history),
2194
mode=self.bzrdir._get_file_mode())
2197
def set_revision_history(self, rev_history):
2198
"""See Branch.set_revision_history."""
2199
if 'evil' in debug.debug_flags:
2200
mutter_callsite(3, "set_revision_history scales with history.")
2201
check_not_reserved_id = _mod_revision.check_not_reserved_id
2202
for rev_id in rev_history:
2203
check_not_reserved_id(rev_id)
2204
if Branch.hooks['post_change_branch_tip']:
2205
# Don't calculate the last_revision_info() if there are no hooks
2207
old_revno, old_revid = self.last_revision_info()
2208
if len(rev_history) == 0:
2209
revid = _mod_revision.NULL_REVISION
2211
revid = rev_history[-1]
2212
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2213
self._write_revision_history(rev_history)
2214
self._clear_cached_state()
2215
self._cache_revision_history(rev_history)
2216
for hook in Branch.hooks['set_rh']:
2217
hook(self, rev_history)
2218
if Branch.hooks['post_change_branch_tip']:
2219
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2221
def _synchronize_history(self, destination, revision_id):
2222
"""Synchronize last revision and revision history between branches.
2224
This version is most efficient when the destination is also a
2225
BzrBranch5, but works for BzrBranch6 as long as the revision
2226
history is the true lefthand parent history, and all of the revisions
2227
are in the destination's repository. If not, set_revision_history
2230
:param destination: The branch to copy the history into
2231
:param revision_id: The revision-id to truncate history at. May
2232
be None to copy complete history.
2234
if not isinstance(destination._format, BzrBranchFormat5):
2235
super(BzrBranch, self)._synchronize_history(
2236
destination, revision_id)
2238
if revision_id == _mod_revision.NULL_REVISION:
2241
new_history = self.revision_history()
2242
if revision_id is not None and new_history != []:
2244
new_history = new_history[:new_history.index(revision_id) + 1]
2246
rev = self.repository.get_revision(revision_id)
2247
new_history = rev.get_history(self.repository)[1:]
2248
destination.set_revision_history(new_history)
2251
def set_last_revision_info(self, revno, revision_id):
2252
"""Set the last revision of this branch.
2254
The caller is responsible for checking that the revno is correct
2255
for this revision id.
2257
It may be possible to set the branch last revision to an id not
2258
present in the repository. However, branches can also be
2259
configured to check constraints on history, in which case this may not
2262
revision_id = _mod_revision.ensure_null(revision_id)
2263
# this old format stores the full history, but this api doesn't
2264
# provide it, so we must generate, and might as well check it's
2266
history = self._lefthand_history(revision_id)
2267
if len(history) != revno:
2268
raise AssertionError('%d != %d' % (len(history), revno))
2269
self.set_revision_history(history)
2271
def _gen_revision_history(self):
2272
history = self._transport.get_bytes('revision-history').split('\n')
2273
if history[-1:] == ['']:
2274
# There shouldn't be a trailing newline, but just in case.
2279
def generate_revision_history(self, revision_id, last_rev=None,
2281
"""Create a new revision history that will finish with revision_id.
2283
:param revision_id: the new tip to use.
2284
:param last_rev: The previous last_revision. If not None, then this
2285
must be a ancestory of revision_id, or DivergedBranches is raised.
2286
:param other_branch: The other branch that DivergedBranches should
2287
raise with respect to.
2289
self.set_revision_history(self._lefthand_history(revision_id,
2290
last_rev, other_branch))
2292
def basis_tree(self):
2293
"""See Branch.basis_tree."""
2294
return self.repository.revision_tree(self.last_revision())
2296
def _get_parent_location(self):
2297
_locs = ['parent', 'pull', 'x-pull']
2300
return self._transport.get_bytes(l).strip('\n')
2301
except errors.NoSuchFile:
2305
def _basic_push(self, target, overwrite, stop_revision):
2306
"""Basic implementation of push without bound branches or hooks.
2308
Must be called with source read locked and target write locked.
2310
result = BranchPushResult()
2311
result.source_branch = self
2312
result.target_branch = target
2313
result.old_revno, result.old_revid = target.last_revision_info()
2314
self.update_references(target)
2315
if result.old_revid != self.last_revision():
2316
# We assume that during 'push' this repository is closer than
2318
graph = self.repository.get_graph(target.repository)
2319
target.update_revisions(self, stop_revision,
2320
overwrite=overwrite, graph=graph)
2321
if self._push_should_merge_tags():
2322
result.tag_conflicts = self.tags.merge_to(target.tags,
2324
result.new_revno, result.new_revid = target.last_revision_info()
2327
def get_stacked_on_url(self):
2328
raise errors.UnstackableBranchFormat(self._format, self.base)
2330
def set_push_location(self, location):
2331
"""See Branch.set_push_location."""
2332
self.get_config().set_user_option(
2333
'push_location', location,
2334
store=_mod_config.STORE_LOCATION_NORECURSE)
2336
def _set_parent_location(self, url):
2338
self._transport.delete('parent')
2340
self._transport.put_bytes('parent', url + '\n',
2341
mode=self.bzrdir._get_file_mode())
2344
class BzrBranch5(BzrBranch):
2345
"""A format 5 branch. This supports new features over plain branches.
2347
It has support for a master_branch which is the data for bound branches.
2350
def get_bound_location(self):
2352
return self._transport.get_bytes('bound')[:-1]
2353
except errors.NoSuchFile:
2357
def get_master_branch(self, possible_transports=None):
2358
"""Return the branch we are bound to.
2360
:return: Either a Branch, or None
2362
This could memoise the branch, but if thats done
2363
it must be revalidated on each new lock.
2364
So for now we just don't memoise it.
2365
# RBC 20060304 review this decision.
2367
bound_loc = self.get_bound_location()
2371
return Branch.open(bound_loc,
2372
possible_transports=possible_transports)
2373
except (errors.NotBranchError, errors.ConnectionError), e:
2374
raise errors.BoundBranchConnectionFailure(
2378
def set_bound_location(self, location):
2379
"""Set the target where this branch is bound to.
2381
:param location: URL to the target branch
2384
self._transport.put_bytes('bound', location+'\n',
2385
mode=self.bzrdir._get_file_mode())
2388
self._transport.delete('bound')
2389
except errors.NoSuchFile:
2394
def bind(self, other):
2395
"""Bind this branch to the branch other.
2397
This does not push or pull data between the branches, though it does
2398
check for divergence to raise an error when the branches are not
2399
either the same, or one a prefix of the other. That behaviour may not
2400
be useful, so that check may be removed in future.
2402
:param other: The branch to bind to
2405
# TODO: jam 20051230 Consider checking if the target is bound
2406
# It is debatable whether you should be able to bind to
2407
# a branch which is itself bound.
2408
# Committing is obviously forbidden,
2409
# but binding itself may not be.
2410
# Since we *have* to check at commit time, we don't
2411
# *need* to check here
2413
# we want to raise diverged if:
2414
# last_rev is not in the other_last_rev history, AND
2415
# other_last_rev is not in our history, and do it without pulling
2417
self.set_bound_location(other.base)
2421
"""If bound, unbind"""
2422
return self.set_bound_location(None)
2425
def update(self, possible_transports=None):
2426
"""Synchronise this branch with the master branch if any.
2428
:return: None or the last_revision that was pivoted out during the
2431
master = self.get_master_branch(possible_transports)
2432
if master is not None:
2433
old_tip = _mod_revision.ensure_null(self.last_revision())
2434
self.pull(master, overwrite=True)
2435
if self.repository.get_graph().is_ancestor(old_tip,
2436
_mod_revision.ensure_null(self.last_revision())):
2442
class BzrBranch8(BzrBranch5):
2443
"""A branch that stores tree-reference locations."""
2445
def _open_hook(self):
2446
if self._ignore_fallbacks:
2449
url = self.get_stacked_on_url()
2450
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2451
errors.UnstackableBranchFormat):
2454
for hook in Branch.hooks['transform_fallback_location']:
2455
url = hook(self, url)
2457
hook_name = Branch.hooks.get_hook_name(hook)
2458
raise AssertionError(
2459
"'transform_fallback_location' hook %s returned "
2460
"None, not a URL." % hook_name)
2461
self._activate_fallback_location(url)
2463
def __init__(self, *args, **kwargs):
2464
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2465
super(BzrBranch8, self).__init__(*args, **kwargs)
2466
self._last_revision_info_cache = None
2467
self._reference_info = None
2469
def _clear_cached_state(self):
2470
super(BzrBranch8, self)._clear_cached_state()
2471
self._last_revision_info_cache = None
2472
self._reference_info = None
2474
def _last_revision_info(self):
2475
revision_string = self._transport.get_bytes('last-revision')
2476
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2477
revision_id = cache_utf8.get_cached_utf8(revision_id)
2479
return revno, revision_id
2481
def _write_last_revision_info(self, revno, revision_id):
2482
"""Simply write out the revision id, with no checks.
2484
Use set_last_revision_info to perform this safely.
2486
Does not update the revision_history cache.
2487
Intended to be called by set_last_revision_info and
2488
_write_revision_history.
2490
revision_id = _mod_revision.ensure_null(revision_id)
2491
out_string = '%d %s\n' % (revno, revision_id)
2492
self._transport.put_bytes('last-revision', out_string,
2493
mode=self.bzrdir._get_file_mode())
2496
def set_last_revision_info(self, revno, revision_id):
2497
revision_id = _mod_revision.ensure_null(revision_id)
2498
old_revno, old_revid = self.last_revision_info()
2499
if self._get_append_revisions_only():
2500
self._check_history_violation(revision_id)
2501
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2502
self._write_last_revision_info(revno, revision_id)
2503
self._clear_cached_state()
2504
self._last_revision_info_cache = revno, revision_id
2505
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2507
def _synchronize_history(self, destination, revision_id):
2508
"""Synchronize last revision and revision history between branches.
2510
:see: Branch._synchronize_history
2512
# XXX: The base Branch has a fast implementation of this method based
2513
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2514
# that uses set_revision_history. This class inherits from BzrBranch5,
2515
# but wants the fast implementation, so it calls
2516
# Branch._synchronize_history directly.
2517
Branch._synchronize_history(self, destination, revision_id)
2519
def _check_history_violation(self, revision_id):
2520
last_revision = _mod_revision.ensure_null(self.last_revision())
2521
if _mod_revision.is_null(last_revision):
2523
if last_revision not in self._lefthand_history(revision_id):
2524
raise errors.AppendRevisionsOnlyViolation(self.base)
2526
def _gen_revision_history(self):
2527
"""Generate the revision history from last revision
2529
last_revno, last_revision = self.last_revision_info()
2530
self._extend_partial_history(stop_index=last_revno-1)
2531
return list(reversed(self._partial_revision_history_cache))
2533
def _write_revision_history(self, history):
2534
"""Factored out of set_revision_history.
2536
This performs the actual writing to disk, with format-specific checks.
2537
It is intended to be called by BzrBranch5.set_revision_history.
2539
if len(history) == 0:
2540
last_revision = 'null:'
2542
if history != self._lefthand_history(history[-1]):
2543
raise errors.NotLefthandHistory(history)
2544
last_revision = history[-1]
2545
if self._get_append_revisions_only():
2546
self._check_history_violation(last_revision)
2547
self._write_last_revision_info(len(history), last_revision)
2550
def _set_parent_location(self, url):
2551
"""Set the parent branch"""
2552
self._set_config_location('parent_location', url, make_relative=True)
2555
def _get_parent_location(self):
2556
"""Set the parent branch"""
2557
return self._get_config_location('parent_location')
2560
def _set_all_reference_info(self, info_dict):
2561
"""Replace all reference info stored in a branch.
2563
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2566
writer = rio.RioWriter(s)
2567
for key, (tree_path, branch_location) in info_dict.iteritems():
2568
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2569
branch_location=branch_location)
2570
writer.write_stanza(stanza)
2571
self._transport.put_bytes('references', s.getvalue())
2572
self._reference_info = info_dict
2575
def _get_all_reference_info(self):
2576
"""Return all the reference info stored in a branch.
2578
:return: A dict of {file_id: (tree_path, branch_location)}
2580
if self._reference_info is not None:
2581
return self._reference_info
2582
rio_file = self._transport.get('references')
2584
stanzas = rio.read_stanzas(rio_file)
2585
info_dict = dict((s['file_id'], (s['tree_path'],
2586
s['branch_location'])) for s in stanzas)
2589
self._reference_info = info_dict
2592
def set_reference_info(self, file_id, tree_path, branch_location):
2593
"""Set the branch location to use for a tree reference.
2595
:param file_id: The file-id of the tree reference.
2596
:param tree_path: The path of the tree reference in the tree.
2597
:param branch_location: The location of the branch to retrieve tree
2600
info_dict = self._get_all_reference_info()
2601
info_dict[file_id] = (tree_path, branch_location)
2602
if None in (tree_path, branch_location):
2603
if tree_path is not None:
2604
raise ValueError('tree_path must be None when branch_location'
2606
if branch_location is not None:
2607
raise ValueError('branch_location must be None when tree_path'
2609
del info_dict[file_id]
2610
self._set_all_reference_info(info_dict)
2612
def get_reference_info(self, file_id):
2613
"""Get the tree_path and branch_location for a tree reference.
2615
:return: a tuple of (tree_path, branch_location)
2617
return self._get_all_reference_info().get(file_id, (None, None))
2619
def reference_parent(self, file_id, path, possible_transports=None):
2620
"""Return the parent branch for a tree-reference file_id.
2622
:param file_id: The file_id of the tree reference
2623
:param path: The path of the file_id in the tree
2624
:return: A branch associated with the file_id
2626
branch_location = self.get_reference_info(file_id)[1]
2627
if branch_location is None:
2628
return Branch.reference_parent(self, file_id, path,
2629
possible_transports)
2630
branch_location = urlutils.join(self.base, branch_location)
2631
return Branch.open(branch_location,
2632
possible_transports=possible_transports)
2634
def set_push_location(self, location):
2635
"""See Branch.set_push_location."""
2636
self._set_config_location('push_location', location)
2638
def set_bound_location(self, location):
2639
"""See Branch.set_push_location."""
2641
config = self.get_config()
2642
if location is None:
2643
if config.get_user_option('bound') != 'True':
2646
config.set_user_option('bound', 'False', warn_masked=True)
2649
self._set_config_location('bound_location', location,
2651
config.set_user_option('bound', 'True', warn_masked=True)
2654
def _get_bound_location(self, bound):
2655
"""Return the bound location in the config file.
2657
Return None if the bound parameter does not match"""
2658
config = self.get_config()
2659
config_bound = (config.get_user_option('bound') == 'True')
2660
if config_bound != bound:
2662
return self._get_config_location('bound_location', config=config)
2664
def get_bound_location(self):
2665
"""See Branch.set_push_location."""
2666
return self._get_bound_location(True)
2668
def get_old_bound_location(self):
2669
"""See Branch.get_old_bound_location"""
2670
return self._get_bound_location(False)
2672
def get_stacked_on_url(self):
2673
# you can always ask for the URL; but you might not be able to use it
2674
# if the repo can't support stacking.
2675
## self._check_stackable_repo()
2676
stacked_url = self._get_config_location('stacked_on_location')
2677
if stacked_url is None:
2678
raise errors.NotStacked(self)
2681
def _get_append_revisions_only(self):
2682
value = self.get_config().get_user_option('append_revisions_only')
2683
return value == 'True'
2686
def generate_revision_history(self, revision_id, last_rev=None,
2688
"""See BzrBranch5.generate_revision_history"""
2689
history = self._lefthand_history(revision_id, last_rev, other_branch)
2690
revno = len(history)
2691
self.set_last_revision_info(revno, revision_id)
2694
def get_rev_id(self, revno, history=None):
2695
"""Find the revision id of the specified revno."""
2697
return _mod_revision.NULL_REVISION
2699
last_revno, last_revision_id = self.last_revision_info()
2700
if revno <= 0 or revno > last_revno:
2701
raise errors.NoSuchRevision(self, revno)
2703
if history is not None:
2704
return history[revno - 1]
2706
index = last_revno - revno
2707
if len(self._partial_revision_history_cache) <= index:
2708
self._extend_partial_history(stop_index=index)
2709
if len(self._partial_revision_history_cache) > index:
2710
return self._partial_revision_history_cache[index]
2712
raise errors.NoSuchRevision(self, revno)
2715
def revision_id_to_revno(self, revision_id):
2716
"""Given a revision id, return its revno"""
2717
if _mod_revision.is_null(revision_id):
2720
index = self._partial_revision_history_cache.index(revision_id)
2722
self._extend_partial_history(stop_revision=revision_id)
2723
index = len(self._partial_revision_history_cache) - 1
2724
if self._partial_revision_history_cache[index] != revision_id:
2725
raise errors.NoSuchRevision(self, revision_id)
2726
return self.revno() - index
2729
class BzrBranch7(BzrBranch8):
2730
"""A branch with support for a fallback repository."""
2732
def set_reference_info(self, file_id, tree_path, branch_location):
2733
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2735
def get_reference_info(self, file_id):
2736
Branch.get_reference_info(self, file_id)
2738
def reference_parent(self, file_id, path, possible_transports=None):
2739
return Branch.reference_parent(self, file_id, path,
2740
possible_transports)
2743
class BzrBranch6(BzrBranch7):
2744
"""See BzrBranchFormat6 for the capabilities of this branch.
2746
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2750
def get_stacked_on_url(self):
2751
raise errors.UnstackableBranchFormat(self._format, self.base)
2754
######################################################################
2755
# results of operations
2758
class _Result(object):
2760
def _show_tag_conficts(self, to_file):
2761
if not getattr(self, 'tag_conflicts', None):
2763
to_file.write('Conflicting tags:\n')
2764
for name, value1, value2 in self.tag_conflicts:
2765
to_file.write(' %s\n' % (name, ))
2768
class PullResult(_Result):
2769
"""Result of a Branch.pull operation.
2771
:ivar old_revno: Revision number before pull.
2772
:ivar new_revno: Revision number after pull.
2773
:ivar old_revid: Tip revision id before pull.
2774
:ivar new_revid: Tip revision id after pull.
2775
:ivar source_branch: Source (local) branch object. (read locked)
2776
:ivar master_branch: Master branch of the target, or the target if no
2778
:ivar local_branch: target branch if there is a Master, else None
2779
:ivar target_branch: Target/destination branch object. (write locked)
2780
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2784
# DEPRECATED: pull used to return the change in revno
2785
return self.new_revno - self.old_revno
2787
def report(self, to_file):
2789
if self.old_revid == self.new_revid:
2790
to_file.write('No revisions to pull.\n')
2792
to_file.write('Now on revision %d.\n' % self.new_revno)
2793
self._show_tag_conficts(to_file)
2796
class BranchPushResult(_Result):
2797
"""Result of a Branch.push operation.
2799
:ivar old_revno: Revision number (eg 10) of the target before push.
2800
:ivar new_revno: Revision number (eg 12) of the target after push.
2801
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2803
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2805
:ivar source_branch: Source branch object that the push was from. This is
2806
read locked, and generally is a local (and thus low latency) branch.
2807
:ivar master_branch: If target is a bound branch, the master branch of
2808
target, or target itself. Always write locked.
2809
:ivar target_branch: The direct Branch where data is being sent (write
2811
:ivar local_branch: If the target is a bound branch this will be the
2812
target, otherwise it will be None.
2816
# DEPRECATED: push used to return the change in revno
2817
return self.new_revno - self.old_revno
2819
def report(self, to_file):
2820
"""Write a human-readable description of the result."""
2821
if self.old_revid == self.new_revid:
2822
note('No new revisions to push.')
2824
note('Pushed up to revision %d.' % self.new_revno)
2825
self._show_tag_conficts(to_file)
2828
class BranchCheckResult(object):
2829
"""Results of checking branch consistency.
2834
def __init__(self, branch):
2835
self.branch = branch
2838
def report_results(self, verbose):
2839
"""Report the check results via trace.note.
2841
:param verbose: Requests more detailed display of what was checked,
2844
note('checked branch %s format %s', self.branch.base,
2845
self.branch._format)
2846
for error in self.errors:
2847
note('found error:%s', error)
2850
class Converter5to6(object):
2851
"""Perform an in-place upgrade of format 5 to format 6"""
2853
def convert(self, branch):
2854
# Data for 5 and 6 can peacefully coexist.
2855
format = BzrBranchFormat6()
2856
new_branch = format.open(branch.bzrdir, _found=True)
2858
# Copy source data into target
2859
new_branch._write_last_revision_info(*branch.last_revision_info())
2860
new_branch.set_parent(branch.get_parent())
2861
new_branch.set_bound_location(branch.get_bound_location())
2862
new_branch.set_push_location(branch.get_push_location())
2864
# New branch has no tags by default
2865
new_branch.tags._set_tag_dict({})
2867
# Copying done; now update target format
2868
new_branch._transport.put_bytes('format',
2869
format.get_format_string(),
2870
mode=new_branch.bzrdir._get_file_mode())
2872
# Clean up old files
2873
new_branch._transport.delete('revision-history')
2875
branch.set_parent(None)
2876
except errors.NoSuchFile:
2878
branch.set_bound_location(None)
2881
class Converter6to7(object):
2882
"""Perform an in-place upgrade of format 6 to format 7"""
2884
def convert(self, branch):
2885
format = BzrBranchFormat7()
2886
branch._set_config_location('stacked_on_location', '')
2887
# update target format
2888
branch._transport.put_bytes('format', format.get_format_string())
2891
class Converter7to8(object):
2892
"""Perform an in-place upgrade of format 6 to format 7"""
2894
def convert(self, branch):
2895
format = BzrBranchFormat8()
2896
branch._transport.put_bytes('references', '')
2897
# update target format
2898
branch._transport.put_bytes('format', format.get_format_string())
2901
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2902
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2905
_run_with_write_locked_target will attempt to release the lock it acquires.
2907
If an exception is raised by callable, then that exception *will* be
2908
propagated, even if the unlock attempt raises its own error. Thus
2909
_run_with_write_locked_target should be preferred to simply doing::
2913
return callable(*args, **kwargs)
2918
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2919
# should share code?
2922
result = callable(*args, **kwargs)
2924
exc_info = sys.exc_info()
2928
raise exc_info[0], exc_info[1], exc_info[2]
2934
class InterBranch(InterObject):
2935
"""This class represents operations taking place between two branches.
2937
Its instances have methods like pull() and push() and contain
2938
references to the source and target repositories these operations
2939
can be carried out on.
2943
"""The available optimised InterBranch types."""
2946
def _get_branch_formats_to_test():
2947
"""Return a tuple with the Branch formats to use when testing."""
2948
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
2950
def pull(self, overwrite=False, stop_revision=None,
2951
possible_transports=None, local=False):
2952
"""Mirror source into target branch.
2954
The target branch is considered to be 'local', having low latency.
2956
:returns: PullResult instance
2958
raise NotImplementedError(self.pull)
2960
def update_revisions(self, stop_revision=None, overwrite=False,
2962
"""Pull in new perfect-fit revisions.
2964
:param stop_revision: Updated until the given revision
2965
:param overwrite: Always set the branch pointer, rather than checking
2966
to see if it is a proper descendant.
2967
:param graph: A Graph object that can be used to query history
2968
information. This can be None.
2971
raise NotImplementedError(self.update_revisions)
2973
def push(self, overwrite=False, stop_revision=None,
2974
_override_hook_source_branch=None):
2975
"""Mirror the source branch into the target branch.
2977
The source branch is considered to be 'local', having low latency.
2979
raise NotImplementedError(self.push)
2982
class GenericInterBranch(InterBranch):
2983
"""InterBranch implementation that uses public Branch functions.
2987
def _get_branch_formats_to_test():
2988
return BranchFormat._default_format, BranchFormat._default_format
2990
def update_revisions(self, stop_revision=None, overwrite=False,
2992
"""See InterBranch.update_revisions()."""
2993
self.source.lock_read()
2995
other_revno, other_last_revision = self.source.last_revision_info()
2996
stop_revno = None # unknown
2997
if stop_revision is None:
2998
stop_revision = other_last_revision
2999
if _mod_revision.is_null(stop_revision):
3000
# if there are no commits, we're done.
3002
stop_revno = other_revno
3004
# what's the current last revision, before we fetch [and change it
3006
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3007
# we fetch here so that we don't process data twice in the common
3008
# case of having something to pull, and so that the check for
3009
# already merged can operate on the just fetched graph, which will
3010
# be cached in memory.
3011
self.target.fetch(self.source, stop_revision)
3012
# Check to see if one is an ancestor of the other
3015
graph = self.target.repository.get_graph()
3016
if self.target._check_if_descendant_or_diverged(
3017
stop_revision, last_rev, graph, self.source):
3018
# stop_revision is a descendant of last_rev, but we aren't
3019
# overwriting, so we're done.
3021
if stop_revno is None:
3023
graph = self.target.repository.get_graph()
3024
this_revno, this_last_revision = \
3025
self.target.last_revision_info()
3026
stop_revno = graph.find_distance_to_null(stop_revision,
3027
[(other_last_revision, other_revno),
3028
(this_last_revision, this_revno)])
3029
self.target.set_last_revision_info(stop_revno, stop_revision)
3031
self.source.unlock()
3033
def pull(self, overwrite=False, stop_revision=None,
3034
possible_transports=None, _hook_master=None, run_hooks=True,
3035
_override_hook_target=None, local=False):
3038
:param _hook_master: Private parameter - set the branch to
3039
be supplied as the master to pull hooks.
3040
:param run_hooks: Private parameter - if false, this branch
3041
is being called because it's the master of the primary branch,
3042
so it should not run its hooks.
3043
:param _override_hook_target: Private parameter - set the branch to be
3044
supplied as the target_branch to pull hooks.
3045
:param local: Only update the local branch, and not the bound branch.
3047
# This type of branch can't be bound.
3049
raise errors.LocalRequiresBoundBranch()
3050
result = PullResult()
3051
result.source_branch = self.source
3052
if _override_hook_target is None:
3053
result.target_branch = self.target
3055
result.target_branch = _override_hook_target
3056
self.source.lock_read()
3058
# We assume that during 'pull' the target repository is closer than
3060
self.source.update_references(self.target)
3061
graph = self.target.repository.get_graph(self.source.repository)
3062
# TODO: Branch formats should have a flag that indicates
3063
# that revno's are expensive, and pull() should honor that flag.
3065
result.old_revno, result.old_revid = \
3066
self.target.last_revision_info()
3067
self.target.update_revisions(self.source, stop_revision,
3068
overwrite=overwrite, graph=graph)
3069
# TODO: The old revid should be specified when merging tags,
3070
# so a tags implementation that versions tags can only
3071
# pull in the most recent changes. -- JRV20090506
3072
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3074
result.new_revno, result.new_revid = self.target.last_revision_info()
3076
result.master_branch = _hook_master
3077
result.local_branch = result.target_branch
3079
result.master_branch = result.target_branch
3080
result.local_branch = None
3082
for hook in Branch.hooks['post_pull']:
3085
self.source.unlock()
3088
def push(self, overwrite=False, stop_revision=None,
3089
_override_hook_source_branch=None):
3090
"""See InterBranch.push.
3092
This is the basic concrete implementation of push()
3094
:param _override_hook_source_branch: If specified, run
3095
the hooks passing this Branch as the source, rather than self.
3096
This is for use of RemoteBranch, where push is delegated to the
3097
underlying vfs-based Branch.
3099
# TODO: Public option to disable running hooks - should be trivial but
3101
self.source.lock_read()
3103
return _run_with_write_locked_target(
3104
self.target, self._push_with_bound_branches, overwrite,
3106
_override_hook_source_branch=_override_hook_source_branch)
3108
self.source.unlock()
3110
def _push_with_bound_branches(self, overwrite, stop_revision,
3111
_override_hook_source_branch=None):
3112
"""Push from source into target, and into target's master if any.
3115
if _override_hook_source_branch:
3116
result.source_branch = _override_hook_source_branch
3117
for hook in Branch.hooks['post_push']:
3120
bound_location = self.target.get_bound_location()
3121
if bound_location and self.target.base != bound_location:
3122
# there is a master branch.
3124
# XXX: Why the second check? Is it even supported for a branch to
3125
# be bound to itself? -- mbp 20070507
3126
master_branch = self.target.get_master_branch()
3127
master_branch.lock_write()
3129
# push into the master from the source branch.
3130
self.source._basic_push(master_branch, overwrite, stop_revision)
3131
# and push into the target branch from the source. Note that we
3132
# push from the source branch again, because its considered the
3133
# highest bandwidth repository.
3134
result = self.source._basic_push(self.target, overwrite,
3136
result.master_branch = master_branch
3137
result.local_branch = self.target
3141
master_branch.unlock()
3144
result = self.source._basic_push(self.target, overwrite,
3146
# TODO: Why set master_branch and local_branch if there's no
3147
# binding? Maybe cleaner to just leave them unset? -- mbp
3149
result.master_branch = self.target
3150
result.local_branch = None
3155
def is_compatible(self, source, target):
3156
# GenericBranch uses the public API, so always compatible
3160
class InterToBranch5(GenericInterBranch):
3163
def _get_branch_formats_to_test():
3164
return BranchFormat._default_format, BzrBranchFormat5()
3166
def pull(self, overwrite=False, stop_revision=None,
3167
possible_transports=None, run_hooks=True,
3168
_override_hook_target=None, local=False):
3169
"""Pull from source into self, updating my master if any.
3171
:param run_hooks: Private parameter - if false, this branch
3172
is being called because it's the master of the primary branch,
3173
so it should not run its hooks.
3175
bound_location = self.target.get_bound_location()
3176
if local and not bound_location:
3177
raise errors.LocalRequiresBoundBranch()
3178
master_branch = None
3179
if not local and bound_location and self.source.base != bound_location:
3180
# not pulling from master, so we need to update master.
3181
master_branch = self.target.get_master_branch(possible_transports)
3182
master_branch.lock_write()
3185
# pull from source into master.
3186
master_branch.pull(self.source, overwrite, stop_revision,
3188
return super(InterToBranch5, self).pull(overwrite,
3189
stop_revision, _hook_master=master_branch,
3190
run_hooks=run_hooks,
3191
_override_hook_target=_override_hook_target)
3194
master_branch.unlock()
3197
InterBranch.register_optimiser(GenericInterBranch)
3198
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
