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()
153
def open(base, _unsupported=False, possible_transports=None):
154
"""Open the branch rooted at base.
156
For instance, if the branch is at URL/.bzr/branch,
157
Branch.open(URL) -> a Branch instance.
159
control = bzrdir.BzrDir.open(base, _unsupported,
160
possible_transports=possible_transports)
161
return control.open_branch(_unsupported)
164
def open_from_transport(transport, _unsupported=False):
165
"""Open the branch rooted at transport"""
166
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
167
return control.open_branch(_unsupported)
170
def open_containing(url, possible_transports=None):
171
"""Open an existing branch which contains url.
173
This probes for a branch at url, and searches upwards from there.
175
Basically we keep looking up until we find the control directory or
176
run into the root. If there isn't one, raises NotBranchError.
177
If there is one and it is either an unrecognised format or an unsupported
178
format, UnknownFormatError or UnsupportedFormatError are raised.
179
If there is one, it is returned, along with the unused portion of url.
181
control, relpath = bzrdir.BzrDir.open_containing(url,
183
return control.open_branch(), relpath
185
def _push_should_merge_tags(self):
186
"""Should _basic_push merge this branch's tags into the target?
188
The default implementation returns False if this branch has no tags,
189
and True the rest of the time. Subclasses may override this.
191
return self.supports_tags() and self.tags.get_tag_dict()
193
def get_config(self):
194
return BranchConfig(self)
196
def _get_config(self):
197
"""Get the concrete config for just the config in this branch.
199
This is not intended for client use; see Branch.get_config for the
204
:return: An object supporting get_option and set_option.
206
raise NotImplementedError(self._get_config)
208
def _get_fallback_repository(self, url):
209
"""Get the repository we fallback to at url."""
210
url = urlutils.join(self.base, url)
211
a_bzrdir = bzrdir.BzrDir.open(url,
212
possible_transports=[self.bzrdir.root_transport])
213
return a_bzrdir.open_branch().repository
215
def _get_tags_bytes(self):
216
"""Get the bytes of a serialised tags dict.
218
Note that not all branches support tags, nor do all use the same tags
219
logic: this method is specific to BasicTags. Other tag implementations
220
may use the same method name and behave differently, safely, because
221
of the double-dispatch via
222
format.make_tags->tags_instance->get_tags_dict.
224
:return: The bytes of the tags file.
225
:seealso: Branch._set_tags_bytes.
227
return self._transport.get_bytes('tags')
229
def _get_nick(self, local=False, possible_transports=None):
230
config = self.get_config()
231
# explicit overrides master, but don't look for master if local is True
232
if not local and not config.has_explicit_nickname():
234
master = self.get_master_branch(possible_transports)
235
if master is not None:
236
# return the master branch value
238
except errors.BzrError, e:
239
# Silently fall back to local implicit nick if the master is
241
mutter("Could not connect to bound branch, "
242
"falling back to local nick.\n " + str(e))
243
return config.get_nickname()
245
def _set_nick(self, nick):
246
self.get_config().set_user_option('nickname', nick, warn_masked=True)
248
nick = property(_get_nick, _set_nick)
251
raise NotImplementedError(self.is_locked)
253
def _lefthand_history(self, revision_id, last_rev=None,
255
if 'evil' in debug.debug_flags:
256
mutter_callsite(4, "_lefthand_history scales with history.")
257
# stop_revision must be a descendant of last_revision
258
graph = self.repository.get_graph()
259
if last_rev is not None:
260
if not graph.is_ancestor(last_rev, revision_id):
261
# our previous tip is not merged into stop_revision
262
raise errors.DivergedBranches(self, other_branch)
263
# make a new revision history from the graph
264
parents_map = graph.get_parent_map([revision_id])
265
if revision_id not in parents_map:
266
raise errors.NoSuchRevision(self, revision_id)
267
current_rev_id = revision_id
269
check_not_reserved_id = _mod_revision.check_not_reserved_id
270
# Do not include ghosts or graph origin in revision_history
271
while (current_rev_id in parents_map and
272
len(parents_map[current_rev_id]) > 0):
273
check_not_reserved_id(current_rev_id)
274
new_history.append(current_rev_id)
275
current_rev_id = parents_map[current_rev_id][0]
276
parents_map = graph.get_parent_map([current_rev_id])
277
new_history.reverse()
280
def lock_write(self):
281
raise NotImplementedError(self.lock_write)
284
raise NotImplementedError(self.lock_read)
287
raise NotImplementedError(self.unlock)
289
def peek_lock_mode(self):
290
"""Return lock mode for the Branch: 'r', 'w' or None"""
291
raise NotImplementedError(self.peek_lock_mode)
293
def get_physical_lock_status(self):
294
raise NotImplementedError(self.get_physical_lock_status)
297
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
298
"""Return the revision_id for a dotted revno.
300
:param revno: a tuple like (1,) or (1,1,2)
301
:param _cache_reverse: a private parameter enabling storage
302
of the reverse mapping in a top level cache. (This should
303
only be done in selective circumstances as we want to
304
avoid having the mapping cached multiple times.)
305
:return: the revision_id
306
:raises errors.NoSuchRevision: if the revno doesn't exist
308
rev_id = self._do_dotted_revno_to_revision_id(revno)
310
self._partial_revision_id_to_revno_cache[rev_id] = revno
313
def _do_dotted_revno_to_revision_id(self, revno):
314
"""Worker function for dotted_revno_to_revision_id.
316
Subclasses should override this if they wish to
317
provide a more efficient implementation.
320
return self.get_rev_id(revno[0])
321
revision_id_to_revno = self.get_revision_id_to_revno_map()
322
revision_ids = [revision_id for revision_id, this_revno
323
in revision_id_to_revno.iteritems()
324
if revno == this_revno]
325
if len(revision_ids) == 1:
326
return revision_ids[0]
328
revno_str = '.'.join(map(str, revno))
329
raise errors.NoSuchRevision(self, revno_str)
332
def revision_id_to_dotted_revno(self, revision_id):
333
"""Given a revision id, return its dotted revno.
335
:return: a tuple like (1,) or (400,1,3).
337
return self._do_revision_id_to_dotted_revno(revision_id)
339
def _do_revision_id_to_dotted_revno(self, revision_id):
340
"""Worker function for revision_id_to_revno."""
341
# Try the caches if they are loaded
342
result = self._partial_revision_id_to_revno_cache.get(revision_id)
343
if result is not None:
345
if self._revision_id_to_revno_cache:
346
result = self._revision_id_to_revno_cache.get(revision_id)
348
raise errors.NoSuchRevision(self, revision_id)
349
# Try the mainline as it's optimised
351
revno = self.revision_id_to_revno(revision_id)
353
except errors.NoSuchRevision:
354
# We need to load and use the full revno map after all
355
result = self.get_revision_id_to_revno_map().get(revision_id)
357
raise errors.NoSuchRevision(self, revision_id)
361
def get_revision_id_to_revno_map(self):
362
"""Return the revision_id => dotted revno map.
364
This will be regenerated on demand, but will be cached.
366
:return: A dictionary mapping revision_id => dotted revno.
367
This dictionary should not be modified by the caller.
369
if self._revision_id_to_revno_cache is not None:
370
mapping = self._revision_id_to_revno_cache
372
mapping = self._gen_revno_map()
373
self._cache_revision_id_to_revno(mapping)
374
# TODO: jam 20070417 Since this is being cached, should we be returning
376
# I would rather not, and instead just declare that users should not
377
# modify the return value.
380
def _gen_revno_map(self):
381
"""Create a new mapping from revision ids to dotted revnos.
383
Dotted revnos are generated based on the current tip in the revision
385
This is the worker function for get_revision_id_to_revno_map, which
386
just caches the return value.
388
:return: A dictionary mapping revision_id => dotted revno.
390
revision_id_to_revno = dict((rev_id, revno)
391
for rev_id, depth, revno, end_of_merge
392
in self.iter_merge_sorted_revisions())
393
return revision_id_to_revno
396
def iter_merge_sorted_revisions(self, start_revision_id=None,
397
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
398
"""Walk the revisions for a branch in merge sorted order.
400
Merge sorted order is the output from a merge-aware,
401
topological sort, i.e. all parents come before their
402
children going forward; the opposite for reverse.
404
:param start_revision_id: the revision_id to begin walking from.
405
If None, the branch tip is used.
406
:param stop_revision_id: the revision_id to terminate the walk
407
after. If None, the rest of history is included.
408
:param stop_rule: if stop_revision_id is not None, the precise rule
409
to use for termination:
410
* 'exclude' - leave the stop revision out of the result (default)
411
* 'include' - the stop revision is the last item in the result
412
* 'with-merges' - include the stop revision and all of its
413
merged revisions in the result
414
:param direction: either 'reverse' or 'forward':
415
* reverse means return the start_revision_id first, i.e.
416
start at the most recent revision and go backwards in history
417
* forward returns tuples in the opposite order to reverse.
418
Note in particular that forward does *not* do any intelligent
419
ordering w.r.t. depth as some clients of this API may like.
420
(If required, that ought to be done at higher layers.)
422
:return: an iterator over (revision_id, depth, revno, end_of_merge)
425
* revision_id: the unique id of the revision
426
* depth: How many levels of merging deep this node has been
428
* revno_sequence: This field provides a sequence of
429
revision numbers for all revisions. The format is:
430
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
431
branch that the revno is on. From left to right the REVNO numbers
432
are the sequence numbers within that branch of the revision.
433
* end_of_merge: When True the next node (earlier in history) is
434
part of a different merge.
436
# Note: depth and revno values are in the context of the branch so
437
# we need the full graph to get stable numbers, regardless of the
439
if self._merge_sorted_revisions_cache is None:
440
last_revision = self.last_revision()
441
graph = self.repository.get_graph()
442
parent_map = dict(((key, value) for key, value in
443
graph.iter_ancestry([last_revision]) if value is not None))
444
revision_graph = repository._strip_NULL_ghosts(parent_map)
445
revs = tsort.merge_sort(revision_graph, last_revision, None,
447
# Drop the sequence # before caching
448
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
450
filtered = self._filter_merge_sorted_revisions(
451
self._merge_sorted_revisions_cache, start_revision_id,
452
stop_revision_id, stop_rule)
453
if direction == 'reverse':
455
if direction == 'forward':
456
return reversed(list(filtered))
458
raise ValueError('invalid direction %r' % direction)
460
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
461
start_revision_id, stop_revision_id, stop_rule):
462
"""Iterate over an inclusive range of sorted revisions."""
463
rev_iter = iter(merge_sorted_revisions)
464
if start_revision_id is not None:
465
for rev_id, depth, revno, end_of_merge in rev_iter:
466
if rev_id != start_revision_id:
469
# The decision to include the start or not
470
# depends on the stop_rule if a stop is provided
472
iter([(rev_id, depth, revno, end_of_merge)]),
475
if stop_revision_id is None:
476
for rev_id, depth, revno, end_of_merge in rev_iter:
477
yield rev_id, depth, revno, end_of_merge
478
elif stop_rule == 'exclude':
479
for rev_id, depth, revno, end_of_merge in rev_iter:
480
if rev_id == stop_revision_id:
482
yield rev_id, depth, revno, end_of_merge
483
elif stop_rule == 'include':
484
for rev_id, depth, revno, end_of_merge in rev_iter:
485
yield rev_id, depth, revno, end_of_merge
486
if rev_id == stop_revision_id:
488
elif stop_rule == 'with-merges':
489
stop_rev = self.repository.get_revision(stop_revision_id)
490
if stop_rev.parent_ids:
491
left_parent = stop_rev.parent_ids[0]
493
left_parent = _mod_revision.NULL_REVISION
494
for rev_id, depth, revno, end_of_merge in rev_iter:
495
if rev_id == left_parent:
497
yield rev_id, depth, revno, end_of_merge
499
raise ValueError('invalid stop_rule %r' % stop_rule)
501
def leave_lock_in_place(self):
502
"""Tell this branch object not to release the physical lock when this
505
If lock_write doesn't return a token, then this method is not supported.
507
self.control_files.leave_in_place()
509
def dont_leave_lock_in_place(self):
510
"""Tell this branch object to release the physical lock when this
511
object is unlocked, even if it didn't originally acquire it.
513
If lock_write doesn't return a token, then this method is not supported.
515
self.control_files.dont_leave_in_place()
517
def bind(self, other):
518
"""Bind the local branch the other branch.
520
:param other: The branch to bind to
523
raise errors.UpgradeRequired(self.base)
525
def set_append_revisions_only(self, enabled):
526
if not self._format.supports_set_append_revisions_only():
527
raise errors.UpgradeRequired(self.base)
532
self.get_config().set_user_option('append_revisions_only', value,
535
def set_reference_info(self, file_id, tree_path, branch_location):
536
"""Set the branch location to use for a tree reference."""
537
raise errors.UnsupportedOperation(self.set_reference_info, self)
539
def get_reference_info(self, file_id):
540
"""Get the tree_path and branch_location for a tree reference."""
541
raise errors.UnsupportedOperation(self.get_reference_info, self)
544
def fetch(self, from_branch, last_revision=None, pb=None):
545
"""Copy revisions from from_branch into this branch.
547
:param from_branch: Where to copy from.
548
:param last_revision: What revision to stop at (None for at the end
550
:param pb: An optional progress bar to use.
553
if self.base == from_branch.base:
556
symbol_versioning.warn(
557
symbol_versioning.deprecated_in((1, 14, 0))
558
% "pb parameter to fetch()")
559
from_branch.lock_read()
561
if last_revision is None:
562
last_revision = from_branch.last_revision()
563
last_revision = _mod_revision.ensure_null(last_revision)
564
return self.repository.fetch(from_branch.repository,
565
revision_id=last_revision,
570
def get_bound_location(self):
571
"""Return the URL of the branch we are bound to.
573
Older format branches cannot bind, please be sure to use a metadir
578
def get_old_bound_location(self):
579
"""Return the URL of the branch we used to be bound to
581
raise errors.UpgradeRequired(self.base)
583
def get_commit_builder(self, parents, config=None, timestamp=None,
584
timezone=None, committer=None, revprops=None,
586
"""Obtain a CommitBuilder for this branch.
588
:param parents: Revision ids of the parents of the new revision.
589
:param config: Optional configuration to use.
590
:param timestamp: Optional timestamp recorded for commit.
591
:param timezone: Optional timezone for timestamp.
592
:param committer: Optional committer to set for commit.
593
:param revprops: Optional dictionary of revision properties.
594
:param revision_id: Optional revision id.
598
config = self.get_config()
600
return self.repository.get_commit_builder(self, parents, config,
601
timestamp, timezone, committer, revprops, revision_id)
603
def get_master_branch(self, possible_transports=None):
604
"""Return the branch we are bound to.
606
:return: Either a Branch, or None
610
def get_revision_delta(self, revno):
611
"""Return the delta for one revision.
613
The delta is relative to its mainline predecessor, or the
614
empty tree for revision 1.
616
rh = self.revision_history()
617
if not (1 <= revno <= len(rh)):
618
raise errors.InvalidRevisionNumber(revno)
619
return self.repository.get_revision_delta(rh[revno-1])
621
def get_stacked_on_url(self):
622
"""Get the URL this branch is stacked against.
624
:raises NotStacked: If the branch is not stacked.
625
:raises UnstackableBranchFormat: If the branch does not support
628
raise NotImplementedError(self.get_stacked_on_url)
630
def print_file(self, file, revision_id):
631
"""Print `file` to stdout."""
632
raise NotImplementedError(self.print_file)
634
def set_revision_history(self, rev_history):
635
raise NotImplementedError(self.set_revision_history)
638
def set_parent(self, url):
639
"""See Branch.set_parent."""
640
# TODO: Maybe delete old location files?
641
# URLs should never be unicode, even on the local fs,
642
# FIXUP this and get_parent in a future branch format bump:
643
# read and rewrite the file. RBC 20060125
645
if isinstance(url, unicode):
647
url = url.encode('ascii')
648
except UnicodeEncodeError:
649
raise errors.InvalidURL(url,
650
"Urls must be 7-bit ascii, "
651
"use bzrlib.urlutils.escape")
652
url = urlutils.relative_url(self.base, url)
653
self._set_parent_location(url)
656
def set_stacked_on_url(self, url):
657
"""Set the URL this branch is stacked against.
659
:raises UnstackableBranchFormat: If the branch does not support
661
:raises UnstackableRepositoryFormat: If the repository does not support
664
if not self._format.supports_stacking():
665
raise errors.UnstackableBranchFormat(self._format, self.base)
666
self._check_stackable_repo()
669
old_url = self.get_stacked_on_url()
670
except (errors.NotStacked, errors.UnstackableBranchFormat,
671
errors.UnstackableRepositoryFormat):
674
# XXX: Lock correctness - should unlock our old repo if we were
676
# repositories don't offer an interface to remove fallback
677
# repositories today; take the conceptually simpler option and just
679
self.repository = self.bzrdir.find_repository()
680
self.repository.lock_write()
681
# for every revision reference the branch has, ensure it is pulled
683
source_repository = self._get_fallback_repository(old_url)
684
for revision_id in chain([self.last_revision()],
685
self.tags.get_reverse_tag_dict()):
686
self.repository.fetch(source_repository, revision_id,
689
self._activate_fallback_location(url)
690
# write this out after the repository is stacked to avoid setting a
691
# stacked config that doesn't work.
692
self._set_config_location('stacked_on_location', url)
695
def _set_tags_bytes(self, bytes):
696
"""Mirror method for _get_tags_bytes.
698
:seealso: Branch._get_tags_bytes.
700
return _run_with_write_locked_target(self, self._transport.put_bytes,
703
def _cache_revision_history(self, rev_history):
704
"""Set the cached revision history to rev_history.
706
The revision_history method will use this cache to avoid regenerating
707
the revision history.
709
This API is semi-public; it only for use by subclasses, all other code
710
should consider it to be private.
712
self._revision_history_cache = rev_history
714
def _cache_revision_id_to_revno(self, revision_id_to_revno):
715
"""Set the cached revision_id => revno map to revision_id_to_revno.
717
This API is semi-public; it only for use by subclasses, all other code
718
should consider it to be private.
720
self._revision_id_to_revno_cache = revision_id_to_revno
722
def _clear_cached_state(self):
723
"""Clear any cached data on this branch, e.g. cached revision history.
725
This means the next call to revision_history will need to call
726
_gen_revision_history.
728
This API is semi-public; it only for use by subclasses, all other code
729
should consider it to be private.
731
self._revision_history_cache = None
732
self._revision_id_to_revno_cache = None
733
self._last_revision_info_cache = None
734
self._merge_sorted_revisions_cache = None
735
self._partial_revision_history_cache = []
736
self._partial_revision_id_to_revno_cache = {}
738
def _gen_revision_history(self):
739
"""Return sequence of revision hashes on to this branch.
741
Unlike revision_history, this method always regenerates or rereads the
742
revision history, i.e. it does not cache the result, so repeated calls
745
Concrete subclasses should override this instead of revision_history so
746
that subclasses do not need to deal with caching logic.
748
This API is semi-public; it only for use by subclasses, all other code
749
should consider it to be private.
751
raise NotImplementedError(self._gen_revision_history)
754
def revision_history(self):
755
"""Return sequence of revision ids on this branch.
757
This method will cache the revision history for as long as it is safe to
760
if 'evil' in debug.debug_flags:
761
mutter_callsite(3, "revision_history scales with history.")
762
if self._revision_history_cache is not None:
763
history = self._revision_history_cache
765
history = self._gen_revision_history()
766
self._cache_revision_history(history)
770
"""Return current revision number for this branch.
772
That is equivalent to the number of revisions committed to
775
return self.last_revision_info()[0]
778
"""Older format branches cannot bind or unbind."""
779
raise errors.UpgradeRequired(self.base)
781
def last_revision(self):
782
"""Return last revision id, or NULL_REVISION."""
783
return self.last_revision_info()[1]
786
def last_revision_info(self):
787
"""Return information about the last revision.
789
:return: A tuple (revno, revision_id).
791
if self._last_revision_info_cache is None:
792
self._last_revision_info_cache = self._last_revision_info()
793
return self._last_revision_info_cache
795
def _last_revision_info(self):
796
rh = self.revision_history()
799
return (revno, rh[-1])
801
return (0, _mod_revision.NULL_REVISION)
803
@deprecated_method(deprecated_in((1, 6, 0)))
804
def missing_revisions(self, other, stop_revision=None):
805
"""Return a list of new revisions that would perfectly fit.
807
If self and other have not diverged, return a list of the revisions
808
present in other, but missing from self.
810
self_history = self.revision_history()
811
self_len = len(self_history)
812
other_history = other.revision_history()
813
other_len = len(other_history)
814
common_index = min(self_len, other_len) -1
815
if common_index >= 0 and \
816
self_history[common_index] != other_history[common_index]:
817
raise errors.DivergedBranches(self, other)
819
if stop_revision is None:
820
stop_revision = other_len
822
if stop_revision > other_len:
823
raise errors.NoSuchRevision(self, stop_revision)
824
return other_history[self_len:stop_revision]
827
def update_revisions(self, other, stop_revision=None, overwrite=False,
829
"""Pull in new perfect-fit revisions.
831
:param other: Another Branch to pull from
832
:param stop_revision: Updated until the given revision
833
:param overwrite: Always set the branch pointer, rather than checking
834
to see if it is a proper descendant.
835
:param graph: A Graph object that can be used to query history
836
information. This can be None.
839
return InterBranch.get(other, self).update_revisions(stop_revision,
842
def import_last_revision_info(self, source_repo, revno, revid):
843
"""Set the last revision info, importing from another repo if necessary.
845
This is used by the bound branch code to upload a revision to
846
the master branch first before updating the tip of the local branch.
848
:param source_repo: Source repository to optionally fetch from
849
:param revno: Revision number of the new tip
850
:param revid: Revision id of the new tip
852
if not self.repository.has_same_location(source_repo):
853
self.repository.fetch(source_repo, revision_id=revid)
854
self.set_last_revision_info(revno, revid)
856
def revision_id_to_revno(self, revision_id):
857
"""Given a revision id, return its revno"""
858
if _mod_revision.is_null(revision_id):
860
history = self.revision_history()
862
return history.index(revision_id) + 1
864
raise errors.NoSuchRevision(self, revision_id)
867
def get_rev_id(self, revno, history=None):
868
"""Find the revision id of the specified revno."""
870
return _mod_revision.NULL_REVISION
871
last_revno, last_revid = self.last_revision_info()
872
if revno == last_revno:
874
if revno <= 0 or revno > last_revno:
875
raise errors.NoSuchRevision(self, revno)
876
distance_from_last = last_revno - revno
877
if len(self._partial_revision_history_cache) <= distance_from_last:
878
self._extend_partial_history(distance_from_last)
879
return self._partial_revision_history_cache[distance_from_last]
882
def pull(self, source, overwrite=False, stop_revision=None,
883
possible_transports=None, *args, **kwargs):
884
"""Mirror source into this branch.
886
This branch is considered to be 'local', having low latency.
888
:returns: PullResult instance
890
return InterBranch.get(source, self).pull(overwrite=overwrite,
891
stop_revision=stop_revision,
892
possible_transports=possible_transports, *args, **kwargs)
894
def push(self, target, overwrite=False, stop_revision=None, *args,
896
"""Mirror this branch into target.
898
This branch is considered to be 'local', having low latency.
900
return InterBranch.get(self, target).push(overwrite, stop_revision,
903
def lossy_push(self, target, stop_revision=None):
904
"""Push deltas into another branch.
906
:note: This does not, like push, retain the revision ids from
907
the source branch and will, rather than adding bzr-specific
908
metadata, push only those semantics of the revision that can be
909
natively represented by this branch' VCS.
911
:param target: Target branch
912
:param stop_revision: Revision to push, defaults to last revision.
913
:return: BranchPushResult with an extra member revidmap:
914
A dictionary mapping revision ids from the target branch
915
to new revision ids in the target branch, for each
916
revision that was pushed.
918
inter = InterBranch.get(self, target)
919
lossy_push = getattr(inter, "lossy_push", None)
920
if lossy_push is None:
921
raise errors.LossyPushToSameVCS(self, target)
922
return lossy_push(stop_revision)
924
def basis_tree(self):
925
"""Return `Tree` object for last revision."""
926
return self.repository.revision_tree(self.last_revision())
928
def get_parent(self):
929
"""Return the parent location of the branch.
931
This is the default location for pull/missing. The usual
932
pattern is that the user can override it by specifying a
935
parent = self._get_parent_location()
938
# This is an old-format absolute path to a local branch
940
if parent.startswith('/'):
941
parent = urlutils.local_path_to_url(parent.decode('utf8'))
943
return urlutils.join(self.base[:-1], parent)
944
except errors.InvalidURLJoin, e:
945
raise errors.InaccessibleParent(parent, self.base)
947
def _get_parent_location(self):
948
raise NotImplementedError(self._get_parent_location)
950
def _set_config_location(self, name, url, config=None,
951
make_relative=False):
953
config = self.get_config()
957
url = urlutils.relative_url(self.base, url)
958
config.set_user_option(name, url, warn_masked=True)
960
def _get_config_location(self, name, config=None):
962
config = self.get_config()
963
location = config.get_user_option(name)
968
def get_child_submit_format(self):
969
"""Return the preferred format of submissions to this branch."""
970
return self.get_config().get_user_option("child_submit_format")
972
def get_submit_branch(self):
973
"""Return the submit location of the branch.
975
This is the default location for bundle. The usual
976
pattern is that the user can override it by specifying a
979
return self.get_config().get_user_option('submit_branch')
981
def set_submit_branch(self, location):
982
"""Return the submit location of the branch.
984
This is the default location for bundle. The usual
985
pattern is that the user can override it by specifying a
988
self.get_config().set_user_option('submit_branch', location,
991
def get_public_branch(self):
992
"""Return the public location of the branch.
994
This is used by merge directives.
996
return self._get_config_location('public_branch')
998
def set_public_branch(self, location):
999
"""Return the submit location of the branch.
1001
This is the default location for bundle. The usual
1002
pattern is that the user can override it by specifying a
1005
self._set_config_location('public_branch', location)
1007
def get_push_location(self):
1008
"""Return the None or the location to push this branch to."""
1009
push_loc = self.get_config().get_user_option('push_location')
1012
def set_push_location(self, location):
1013
"""Set a new push location for this branch."""
1014
raise NotImplementedError(self.set_push_location)
1016
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1017
"""Run the post_change_branch_tip hooks."""
1018
hooks = Branch.hooks['post_change_branch_tip']
1021
new_revno, new_revid = self.last_revision_info()
1022
params = ChangeBranchTipParams(
1023
self, old_revno, new_revno, old_revid, new_revid)
1027
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1028
"""Run the pre_change_branch_tip hooks."""
1029
hooks = Branch.hooks['pre_change_branch_tip']
1032
old_revno, old_revid = self.last_revision_info()
1033
params = ChangeBranchTipParams(
1034
self, old_revno, new_revno, old_revid, new_revid)
1038
except errors.TipChangeRejected:
1041
exc_info = sys.exc_info()
1042
hook_name = Branch.hooks.get_hook_name(hook)
1043
raise errors.HookFailed(
1044
'pre_change_branch_tip', hook_name, exc_info)
1048
"""Synchronise this branch with the master branch if any.
1050
:return: None or the last_revision pivoted out during the update.
1054
def check_revno(self, revno):
1056
Check whether a revno corresponds to any revision.
1057
Zero (the NULL revision) is considered valid.
1060
self.check_real_revno(revno)
1062
def check_real_revno(self, revno):
1064
Check whether a revno corresponds to a real revision.
1065
Zero (the NULL revision) is considered invalid
1067
if revno < 1 or revno > self.revno():
1068
raise errors.InvalidRevisionNumber(revno)
1071
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1072
"""Clone this branch into to_bzrdir preserving all semantic values.
1074
Most API users will want 'create_clone_on_transport', which creates a
1075
new bzrdir and branch on the fly.
1077
revision_id: if not None, the revision history in the new branch will
1078
be truncated to end with revision_id.
1080
result = to_bzrdir.create_branch()
1083
if repository_policy is not None:
1084
repository_policy.configure_branch(result)
1085
self.copy_content_into(result, revision_id=revision_id)
1091
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1092
"""Create a new line of development from the branch, into to_bzrdir.
1094
to_bzrdir controls the branch format.
1096
revision_id: if not None, the revision history in the new branch will
1097
be truncated to end with revision_id.
1099
result = to_bzrdir.create_branch()
1102
if repository_policy is not None:
1103
repository_policy.configure_branch(result)
1104
self.copy_content_into(result, revision_id=revision_id)
1105
result.set_parent(self.bzrdir.root_transport.base)
1110
def _synchronize_history(self, destination, revision_id):
1111
"""Synchronize last revision and revision history between branches.
1113
This version is most efficient when the destination is also a
1114
BzrBranch6, but works for BzrBranch5, as long as the destination's
1115
repository contains all the lefthand ancestors of the intended
1116
last_revision. If not, set_last_revision_info will fail.
1118
:param destination: The branch to copy the history into
1119
:param revision_id: The revision-id to truncate history at. May
1120
be None to copy complete history.
1122
source_revno, source_revision_id = self.last_revision_info()
1123
if revision_id is None:
1124
revno, revision_id = source_revno, source_revision_id
1126
graph = self.repository.get_graph()
1128
revno = graph.find_distance_to_null(revision_id,
1129
[(source_revision_id, source_revno)])
1130
except errors.GhostRevisionsHaveNoRevno:
1131
# Default to 1, if we can't find anything else
1133
destination.set_last_revision_info(revno, revision_id)
1136
def copy_content_into(self, destination, revision_id=None):
1137
"""Copy the content of self into destination.
1139
revision_id: if not None, the revision history in the new branch will
1140
be truncated to end with revision_id.
1142
self.update_references(destination)
1143
self._synchronize_history(destination, revision_id)
1145
parent = self.get_parent()
1146
except errors.InaccessibleParent, e:
1147
mutter('parent was not accessible to copy: %s', e)
1150
destination.set_parent(parent)
1151
if self._push_should_merge_tags():
1152
self.tags.merge_to(destination.tags)
1154
def update_references(self, target):
1155
if not getattr(self._format, 'supports_reference_locations', False):
1157
reference_dict = self._get_all_reference_info()
1158
if len(reference_dict) == 0:
1160
old_base = self.base
1161
new_base = target.base
1162
target_reference_dict = target._get_all_reference_info()
1163
for file_id, (tree_path, branch_location) in (
1164
reference_dict.items()):
1165
branch_location = urlutils.rebase_url(branch_location,
1167
target_reference_dict.setdefault(
1168
file_id, (tree_path, branch_location))
1169
target._set_all_reference_info(target_reference_dict)
1173
"""Check consistency of the branch.
1175
In particular this checks that revisions given in the revision-history
1176
do actually match up in the revision graph, and that they're all
1177
present in the repository.
1179
Callers will typically also want to check the repository.
1181
:return: A BranchCheckResult.
1183
ret = BranchCheckResult(self)
1184
mainline_parent_id = None
1185
last_revno, last_revision_id = self.last_revision_info()
1186
real_rev_history = []
1188
for revid in self.repository.iter_reverse_revision_history(
1190
real_rev_history.append(revid)
1191
except errors.RevisionNotPresent:
1192
ret.ghosts_in_mainline = True
1194
ret.ghosts_in_mainline = False
1195
real_rev_history.reverse()
1196
if len(real_rev_history) != last_revno:
1197
raise errors.BzrCheckError('revno does not match len(mainline)'
1198
' %s != %s' % (last_revno, len(real_rev_history)))
1199
# TODO: We should probably also check that real_rev_history actually
1200
# matches self.revision_history()
1201
for revision_id in real_rev_history:
1203
revision = self.repository.get_revision(revision_id)
1204
except errors.NoSuchRevision, e:
1205
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1207
# In general the first entry on the revision history has no parents.
1208
# But it's not illegal for it to have parents listed; this can happen
1209
# in imports from Arch when the parents weren't reachable.
1210
if mainline_parent_id is not None:
1211
if mainline_parent_id not in revision.parent_ids:
1212
raise errors.BzrCheckError("previous revision {%s} not listed among "
1214
% (mainline_parent_id, revision_id))
1215
mainline_parent_id = revision_id
1218
def _get_checkout_format(self):
1219
"""Return the most suitable metadir for a checkout of this branch.
1220
Weaves are used if this branch's repository uses weaves.
1222
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1223
from bzrlib.repofmt import weaverepo
1224
format = bzrdir.BzrDirMetaFormat1()
1225
format.repository_format = weaverepo.RepositoryFormat7()
1227
format = self.repository.bzrdir.checkout_metadir()
1228
format.set_branch_format(self._format)
1231
def create_clone_on_transport(self, to_transport, revision_id=None,
1232
stacked_on=None, create_prefix=False, use_existing_dir=False):
1233
"""Create a clone of this branch and its bzrdir.
1235
:param to_transport: The transport to clone onto.
1236
:param revision_id: The revision id to use as tip in the new branch.
1237
If None the tip is obtained from this branch.
1238
:param stacked_on: An optional URL to stack the clone on.
1239
:param create_prefix: Create any missing directories leading up to
1241
:param use_existing_dir: Use an existing directory if one exists.
1243
# XXX: Fix the bzrdir API to allow getting the branch back from the
1244
# clone call. Or something. 20090224 RBC/spiv.
1245
if revision_id is None:
1246
revision_id = self.last_revision()
1248
dir_to = self.bzrdir.clone_on_transport(to_transport,
1249
revision_id=revision_id, stacked_on=stacked_on,
1250
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1251
except errors.FileExists:
1252
if not use_existing_dir:
1254
except errors.NoSuchFile:
1255
if not create_prefix:
1257
return dir_to.open_branch()
1259
def create_checkout(self, to_location, revision_id=None,
1260
lightweight=False, accelerator_tree=None,
1262
"""Create a checkout of a branch.
1264
:param to_location: The url to produce the checkout at
1265
:param revision_id: The revision to check out
1266
:param lightweight: If True, produce a lightweight checkout, otherwise,
1267
produce a bound branch (heavyweight checkout)
1268
:param accelerator_tree: A tree which can be used for retrieving file
1269
contents more quickly than the revision tree, i.e. a workingtree.
1270
The revision tree will be used for cases where accelerator_tree's
1271
content is different.
1272
:param hardlink: If true, hard-link files from accelerator_tree,
1274
:return: The tree of the created checkout
1276
t = transport.get_transport(to_location)
1279
format = self._get_checkout_format()
1280
checkout = format.initialize_on_transport(t)
1281
from_branch = BranchReferenceFormat().initialize(checkout, self)
1283
format = self._get_checkout_format()
1284
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1285
to_location, force_new_tree=False, format=format)
1286
checkout = checkout_branch.bzrdir
1287
checkout_branch.bind(self)
1288
# pull up to the specified revision_id to set the initial
1289
# branch tip correctly, and seed it with history.
1290
checkout_branch.pull(self, stop_revision=revision_id)
1292
tree = checkout.create_workingtree(revision_id,
1293
from_branch=from_branch,
1294
accelerator_tree=accelerator_tree,
1296
basis_tree = tree.basis_tree()
1297
basis_tree.lock_read()
1299
for path, file_id in basis_tree.iter_references():
1300
reference_parent = self.reference_parent(file_id, path)
1301
reference_parent.create_checkout(tree.abspath(path),
1302
basis_tree.get_reference_revision(file_id, path),
1309
def reconcile(self, thorough=True):
1310
"""Make sure the data stored in this branch is consistent."""
1311
from bzrlib.reconcile import BranchReconciler
1312
reconciler = BranchReconciler(self, thorough=thorough)
1313
reconciler.reconcile()
1316
def reference_parent(self, file_id, path, possible_transports=None):
1317
"""Return the parent branch for a tree-reference file_id
1318
:param file_id: The file_id of the tree reference
1319
:param path: The path of the file_id in the tree
1320
:return: A branch associated with the file_id
1322
# FIXME should provide multiple branches, based on config
1323
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1324
possible_transports=possible_transports)
1326
def supports_tags(self):
1327
return self._format.supports_tags()
1329
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1331
"""Ensure that revision_b is a descendant of revision_a.
1333
This is a helper function for update_revisions.
1335
:raises: DivergedBranches if revision_b has diverged from revision_a.
1336
:returns: True if revision_b is a descendant of revision_a.
1338
relation = self._revision_relations(revision_a, revision_b, graph)
1339
if relation == 'b_descends_from_a':
1341
elif relation == 'diverged':
1342
raise errors.DivergedBranches(self, other_branch)
1343
elif relation == 'a_descends_from_b':
1346
raise AssertionError("invalid relation: %r" % (relation,))
1348
def _revision_relations(self, revision_a, revision_b, graph):
1349
"""Determine the relationship between two revisions.
1351
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1353
heads = graph.heads([revision_a, revision_b])
1354
if heads == set([revision_b]):
1355
return 'b_descends_from_a'
1356
elif heads == set([revision_a, revision_b]):
1357
# These branches have diverged
1359
elif heads == set([revision_a]):
1360
return 'a_descends_from_b'
1362
raise AssertionError("invalid heads: %r" % (heads,))
1365
class BranchFormat(object):
1366
"""An encapsulation of the initialization and open routines for a format.
1368
Formats provide three things:
1369
* An initialization routine,
1373
Formats are placed in an dict by their format string for reference
1374
during branch opening. Its not required that these be instances, they
1375
can be classes themselves with class methods - it simply depends on
1376
whether state is needed for a given format or not.
1378
Once a format is deprecated, just deprecate the initialize and open
1379
methods on the format class. Do not deprecate the object, as the
1380
object will be created every time regardless.
1383
_default_format = None
1384
"""The default format used for new branches."""
1387
"""The known formats."""
1389
can_set_append_revisions_only = True
1391
def __eq__(self, other):
1392
return self.__class__ is other.__class__
1394
def __ne__(self, other):
1395
return not (self == other)
1398
def find_format(klass, a_bzrdir):
1399
"""Return the format for the branch object in a_bzrdir."""
1401
transport = a_bzrdir.get_branch_transport(None)
1402
format_string = transport.get("format").read()
1403
return klass._formats[format_string]
1404
except errors.NoSuchFile:
1405
raise errors.NotBranchError(path=transport.base)
1407
raise errors.UnknownFormatError(format=format_string, kind='branch')
1410
def get_default_format(klass):
1411
"""Return the current default format."""
1412
return klass._default_format
1414
def get_reference(self, a_bzrdir):
1415
"""Get the target reference of the branch in a_bzrdir.
1417
format probing must have been completed before calling
1418
this method - it is assumed that the format of the branch
1419
in a_bzrdir is correct.
1421
:param a_bzrdir: The bzrdir to get the branch data from.
1422
:return: None if the branch is not a reference branch.
1427
def set_reference(self, a_bzrdir, to_branch):
1428
"""Set the target reference of the branch in a_bzrdir.
1430
format probing must have been completed before calling
1431
this method - it is assumed that the format of the branch
1432
in a_bzrdir is correct.
1434
:param a_bzrdir: The bzrdir to set the branch reference for.
1435
:param to_branch: branch that the checkout is to reference
1437
raise NotImplementedError(self.set_reference)
1439
def get_format_string(self):
1440
"""Return the ASCII format string that identifies this format."""
1441
raise NotImplementedError(self.get_format_string)
1443
def get_format_description(self):
1444
"""Return the short format description for this format."""
1445
raise NotImplementedError(self.get_format_description)
1447
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1449
"""Initialize a branch in a bzrdir, with specified files
1451
:param a_bzrdir: The bzrdir to initialize the branch in
1452
:param utf8_files: The files to create as a list of
1453
(filename, content) tuples
1454
:param set_format: If True, set the format with
1455
self.get_format_string. (BzrBranch4 has its format set
1457
:return: a branch in this format
1459
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1460
branch_transport = a_bzrdir.get_branch_transport(self)
1462
'metadir': ('lock', lockdir.LockDir),
1463
'branch4': ('branch-lock', lockable_files.TransportLock),
1465
lock_name, lock_class = lock_map[lock_type]
1466
control_files = lockable_files.LockableFiles(branch_transport,
1467
lock_name, lock_class)
1468
control_files.create_lock()
1470
control_files.lock_write()
1471
except errors.LockContention:
1472
if lock_type != 'branch4':
1478
utf8_files += [('format', self.get_format_string())]
1480
for (filename, content) in utf8_files:
1481
branch_transport.put_bytes(
1483
mode=a_bzrdir._get_file_mode())
1486
control_files.unlock()
1487
return self.open(a_bzrdir, _found=True)
1489
def initialize(self, a_bzrdir):
1490
"""Create a branch of this format in a_bzrdir."""
1491
raise NotImplementedError(self.initialize)
1493
def is_supported(self):
1494
"""Is this format supported?
1496
Supported formats can be initialized and opened.
1497
Unsupported formats may not support initialization or committing or
1498
some other features depending on the reason for not being supported.
1502
def make_tags(self, branch):
1503
"""Create a tags object for branch.
1505
This method is on BranchFormat, because BranchFormats are reflected
1506
over the wire via network_name(), whereas full Branch instances require
1507
multiple VFS method calls to operate at all.
1509
The default implementation returns a disabled-tags instance.
1511
Note that it is normal for branch to be a RemoteBranch when using tags
1514
return DisabledTags(branch)
1516
def network_name(self):
1517
"""A simple byte string uniquely identifying this format for RPC calls.
1519
MetaDir branch formats use their disk format string to identify the
1520
repository over the wire. All in one formats such as bzr < 0.8, and
1521
foreign formats like svn/git and hg should use some marker which is
1522
unique and immutable.
1524
raise NotImplementedError(self.network_name)
1526
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1527
"""Return the branch object for a_bzrdir
1529
:param a_bzrdir: A BzrDir that contains a branch.
1530
:param _found: a private parameter, do not use it. It is used to
1531
indicate if format probing has already be done.
1532
:param ignore_fallbacks: when set, no fallback branches will be opened
1533
(if there are any). Default is to open fallbacks.
1535
raise NotImplementedError(self.open)
1538
def register_format(klass, format):
1539
"""Register a metadir format."""
1540
klass._formats[format.get_format_string()] = format
1541
# Metadir formats have a network name of their format string, and get
1542
# registered as class factories.
1543
network_format_registry.register(format.get_format_string(), format.__class__)
1546
def set_default_format(klass, format):
1547
klass._default_format = format
1549
def supports_set_append_revisions_only(self):
1550
"""True if this format supports set_append_revisions_only."""
1553
def supports_stacking(self):
1554
"""True if this format records a stacked-on branch."""
1558
def unregister_format(klass, format):
1559
del klass._formats[format.get_format_string()]
1562
return self.get_format_description().rstrip()
1564
def supports_tags(self):
1565
"""True if this format supports tags stored in the branch"""
1566
return False # by default
1569
class BranchHooks(Hooks):
1570
"""A dictionary mapping hook name to a list of callables for branch hooks.
1572
e.g. ['set_rh'] Is the list of items to be called when the
1573
set_revision_history function is invoked.
1577
"""Create the default hooks.
1579
These are all empty initially, because by default nothing should get
1582
Hooks.__init__(self)
1583
self.create_hook(HookPoint('set_rh',
1584
"Invoked whenever the revision history has been set via "
1585
"set_revision_history. The api signature is (branch, "
1586
"revision_history), and the branch will be write-locked. "
1587
"The set_rh hook can be expensive for bzr to trigger, a better "
1588
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1589
self.create_hook(HookPoint('open',
1590
"Called with the Branch object that has been opened after a "
1591
"branch is opened.", (1, 8), None))
1592
self.create_hook(HookPoint('post_push',
1593
"Called after a push operation completes. post_push is called "
1594
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1595
"bzr client.", (0, 15), None))
1596
self.create_hook(HookPoint('post_pull',
1597
"Called after a pull operation completes. post_pull is called "
1598
"with a bzrlib.branch.PullResult object and only runs in the "
1599
"bzr client.", (0, 15), None))
1600
self.create_hook(HookPoint('pre_commit',
1601
"Called after a commit is calculated but before it is is "
1602
"completed. pre_commit is called with (local, master, old_revno, "
1603
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1604
"). old_revid is NULL_REVISION for the first commit to a branch, "
1605
"tree_delta is a TreeDelta object describing changes from the "
1606
"basis revision. hooks MUST NOT modify this delta. "
1607
" future_tree is an in-memory tree obtained from "
1608
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1609
"tree.", (0,91), None))
1610
self.create_hook(HookPoint('post_commit',
1611
"Called in the bzr client after a commit has completed. "
1612
"post_commit is called with (local, master, old_revno, old_revid, "
1613
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1614
"commit to a branch.", (0, 15), None))
1615
self.create_hook(HookPoint('post_uncommit',
1616
"Called in the bzr client after an uncommit completes. "
1617
"post_uncommit is called with (local, master, old_revno, "
1618
"old_revid, new_revno, new_revid) where local is the local branch "
1619
"or None, master is the target branch, and an empty branch "
1620
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1621
self.create_hook(HookPoint('pre_change_branch_tip',
1622
"Called in bzr client and server before a change to the tip of a "
1623
"branch is made. pre_change_branch_tip is called with a "
1624
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1625
"commit, uncommit will all trigger this hook.", (1, 6), None))
1626
self.create_hook(HookPoint('post_change_branch_tip',
1627
"Called in bzr client and server after a change to the tip of a "
1628
"branch is made. post_change_branch_tip is called with a "
1629
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1630
"commit, uncommit will all trigger this hook.", (1, 4), None))
1631
self.create_hook(HookPoint('transform_fallback_location',
1632
"Called when a stacked branch is activating its fallback "
1633
"locations. transform_fallback_location is called with (branch, "
1634
"url), and should return a new url. Returning the same url "
1635
"allows it to be used as-is, returning a different one can be "
1636
"used to cause the branch to stack on a closer copy of that "
1637
"fallback_location. Note that the branch cannot have history "
1638
"accessing methods called on it during this hook because the "
1639
"fallback locations have not been activated. When there are "
1640
"multiple hooks installed for transform_fallback_location, "
1641
"all are called with the url returned from the previous hook."
1642
"The order is however undefined.", (1, 9), None))
1645
# install the default hooks into the Branch class.
1646
Branch.hooks = BranchHooks()
1649
class ChangeBranchTipParams(object):
1650
"""Object holding parameters passed to *_change_branch_tip hooks.
1652
There are 5 fields that hooks may wish to access:
1654
:ivar branch: the branch being changed
1655
:ivar old_revno: revision number before the change
1656
:ivar new_revno: revision number after the change
1657
:ivar old_revid: revision id before the change
1658
:ivar new_revid: revision id after the change
1660
The revid fields are strings. The revno fields are integers.
1663
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1664
"""Create a group of ChangeBranchTip parameters.
1666
:param branch: The branch being changed.
1667
:param old_revno: Revision number before the change.
1668
:param new_revno: Revision number after the change.
1669
:param old_revid: Tip revision id before the change.
1670
:param new_revid: Tip revision id after the change.
1672
self.branch = branch
1673
self.old_revno = old_revno
1674
self.new_revno = new_revno
1675
self.old_revid = old_revid
1676
self.new_revid = new_revid
1678
def __eq__(self, other):
1679
return self.__dict__ == other.__dict__
1682
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1683
self.__class__.__name__, self.branch,
1684
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1687
class BzrBranchFormat4(BranchFormat):
1688
"""Bzr branch format 4.
1691
- a revision-history file.
1692
- a branch-lock lock file [ to be shared with the bzrdir ]
1695
def get_format_description(self):
1696
"""See BranchFormat.get_format_description()."""
1697
return "Branch format 4"
1699
def initialize(self, a_bzrdir):
1700
"""Create a branch of this format in a_bzrdir."""
1701
utf8_files = [('revision-history', ''),
1702
('branch-name', ''),
1704
return self._initialize_helper(a_bzrdir, utf8_files,
1705
lock_type='branch4', set_format=False)
1708
super(BzrBranchFormat4, self).__init__()
1709
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1711
def network_name(self):
1712
"""The network name for this format is the control dirs disk label."""
1713
return self._matchingbzrdir.get_format_string()
1715
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1716
"""See BranchFormat.open()."""
1718
# we are being called directly and must probe.
1719
raise NotImplementedError
1720
return BzrBranch(_format=self,
1721
_control_files=a_bzrdir._control_files,
1723
_repository=a_bzrdir.open_repository())
1726
return "Bazaar-NG branch format 4"
1729
class BranchFormatMetadir(BranchFormat):
1730
"""Common logic for meta-dir based branch formats."""
1732
def _branch_class(self):
1733
"""What class to instantiate on open calls."""
1734
raise NotImplementedError(self._branch_class)
1736
def network_name(self):
1737
"""A simple byte string uniquely identifying this format for RPC calls.
1739
Metadir branch formats use their format string.
1741
return self.get_format_string()
1743
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1744
"""See BranchFormat.open()."""
1746
format = BranchFormat.find_format(a_bzrdir)
1747
if format.__class__ != self.__class__:
1748
raise AssertionError("wrong format %r found for %r" %
1751
transport = a_bzrdir.get_branch_transport(None)
1752
control_files = lockable_files.LockableFiles(transport, 'lock',
1754
return self._branch_class()(_format=self,
1755
_control_files=control_files,
1757
_repository=a_bzrdir.find_repository(),
1758
ignore_fallbacks=ignore_fallbacks)
1759
except errors.NoSuchFile:
1760
raise errors.NotBranchError(path=transport.base)
1763
super(BranchFormatMetadir, self).__init__()
1764
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1765
self._matchingbzrdir.set_branch_format(self)
1767
def supports_tags(self):
1771
class BzrBranchFormat5(BranchFormatMetadir):
1772
"""Bzr branch format 5.
1775
- a revision-history file.
1777
- a lock dir guarding the branch itself
1778
- all of this stored in a branch/ subdirectory
1779
- works with shared repositories.
1781
This format is new in bzr 0.8.
1784
def _branch_class(self):
1787
def get_format_string(self):
1788
"""See BranchFormat.get_format_string()."""
1789
return "Bazaar-NG branch format 5\n"
1791
def get_format_description(self):
1792
"""See BranchFormat.get_format_description()."""
1793
return "Branch format 5"
1795
def initialize(self, a_bzrdir):
1796
"""Create a branch of this format in a_bzrdir."""
1797
utf8_files = [('revision-history', ''),
1798
('branch-name', ''),
1800
return self._initialize_helper(a_bzrdir, utf8_files)
1802
def supports_tags(self):
1806
class BzrBranchFormat6(BranchFormatMetadir):
1807
"""Branch format with last-revision and tags.
1809
Unlike previous formats, this has no explicit revision history. Instead,
1810
this just stores the last-revision, and the left-hand history leading
1811
up to there is the history.
1813
This format was introduced in bzr 0.15
1814
and became the default in 0.91.
1817
def _branch_class(self):
1820
def get_format_string(self):
1821
"""See BranchFormat.get_format_string()."""
1822
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1824
def get_format_description(self):
1825
"""See BranchFormat.get_format_description()."""
1826
return "Branch format 6"
1828
def initialize(self, a_bzrdir):
1829
"""Create a branch of this format in a_bzrdir."""
1830
utf8_files = [('last-revision', '0 null:\n'),
1831
('branch.conf', ''),
1834
return self._initialize_helper(a_bzrdir, utf8_files)
1836
def make_tags(self, branch):
1837
"""See bzrlib.branch.BranchFormat.make_tags()."""
1838
return BasicTags(branch)
1840
def supports_set_append_revisions_only(self):
1844
class BzrBranchFormat8(BranchFormatMetadir):
1845
"""Metadir format supporting storing locations of subtree branches."""
1847
def _branch_class(self):
1850
def get_format_string(self):
1851
"""See BranchFormat.get_format_string()."""
1852
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1854
def get_format_description(self):
1855
"""See BranchFormat.get_format_description()."""
1856
return "Branch format 8"
1858
def initialize(self, a_bzrdir):
1859
"""Create a branch of this format in a_bzrdir."""
1860
utf8_files = [('last-revision', '0 null:\n'),
1861
('branch.conf', ''),
1865
return self._initialize_helper(a_bzrdir, utf8_files)
1868
super(BzrBranchFormat8, self).__init__()
1869
self._matchingbzrdir.repository_format = \
1870
RepositoryFormatKnitPack5RichRoot()
1872
def make_tags(self, branch):
1873
"""See bzrlib.branch.BranchFormat.make_tags()."""
1874
return BasicTags(branch)
1876
def supports_set_append_revisions_only(self):
1879
def supports_stacking(self):
1882
supports_reference_locations = True
1885
class BzrBranchFormat7(BzrBranchFormat8):
1886
"""Branch format with last-revision, tags, and a stacked location pointer.
1888
The stacked location pointer is passed down to the repository and requires
1889
a repository format with supports_external_lookups = True.
1891
This format was introduced in bzr 1.6.
1894
def initialize(self, a_bzrdir):
1895
"""Create a branch of this format in a_bzrdir."""
1896
utf8_files = [('last-revision', '0 null:\n'),
1897
('branch.conf', ''),
1900
return self._initialize_helper(a_bzrdir, utf8_files)
1902
def _branch_class(self):
1905
def get_format_string(self):
1906
"""See BranchFormat.get_format_string()."""
1907
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1909
def get_format_description(self):
1910
"""See BranchFormat.get_format_description()."""
1911
return "Branch format 7"
1913
def supports_set_append_revisions_only(self):
1916
supports_reference_locations = False
1919
class BranchReferenceFormat(BranchFormat):
1920
"""Bzr branch reference format.
1922
Branch references are used in implementing checkouts, they
1923
act as an alias to the real branch which is at some other url.
1930
def get_format_string(self):
1931
"""See BranchFormat.get_format_string()."""
1932
return "Bazaar-NG Branch Reference Format 1\n"
1934
def get_format_description(self):
1935
"""See BranchFormat.get_format_description()."""
1936
return "Checkout reference format 1"
1938
def get_reference(self, a_bzrdir):
1939
"""See BranchFormat.get_reference()."""
1940
transport = a_bzrdir.get_branch_transport(None)
1941
return transport.get('location').read()
1943
def set_reference(self, a_bzrdir, to_branch):
1944
"""See BranchFormat.set_reference()."""
1945
transport = a_bzrdir.get_branch_transport(None)
1946
location = transport.put_bytes('location', to_branch.base)
1948
def initialize(self, a_bzrdir, target_branch=None):
1949
"""Create a branch of this format in a_bzrdir."""
1950
if target_branch is None:
1951
# this format does not implement branch itself, thus the implicit
1952
# creation contract must see it as uninitializable
1953
raise errors.UninitializableFormat(self)
1954
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1955
branch_transport = a_bzrdir.get_branch_transport(self)
1956
branch_transport.put_bytes('location',
1957
target_branch.bzrdir.root_transport.base)
1958
branch_transport.put_bytes('format', self.get_format_string())
1960
a_bzrdir, _found=True,
1961
possible_transports=[target_branch.bzrdir.root_transport])
1964
super(BranchReferenceFormat, self).__init__()
1965
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1966
self._matchingbzrdir.set_branch_format(self)
1968
def _make_reference_clone_function(format, a_branch):
1969
"""Create a clone() routine for a branch dynamically."""
1970
def clone(to_bzrdir, revision_id=None,
1971
repository_policy=None):
1972
"""See Branch.clone()."""
1973
return format.initialize(to_bzrdir, a_branch)
1974
# cannot obey revision_id limits when cloning a reference ...
1975
# FIXME RBC 20060210 either nuke revision_id for clone, or
1976
# emit some sort of warning/error to the caller ?!
1979
def open(self, a_bzrdir, _found=False, location=None,
1980
possible_transports=None, ignore_fallbacks=False):
1981
"""Return the branch that the branch reference in a_bzrdir points at.
1983
:param a_bzrdir: A BzrDir that contains a branch.
1984
:param _found: a private parameter, do not use it. It is used to
1985
indicate if format probing has already be done.
1986
:param ignore_fallbacks: when set, no fallback branches will be opened
1987
(if there are any). Default is to open fallbacks.
1988
:param location: The location of the referenced branch. If
1989
unspecified, this will be determined from the branch reference in
1991
:param possible_transports: An optional reusable transports list.
1994
format = BranchFormat.find_format(a_bzrdir)
1995
if format.__class__ != self.__class__:
1996
raise AssertionError("wrong format %r found for %r" %
1998
if location is None:
1999
location = self.get_reference(a_bzrdir)
2000
real_bzrdir = bzrdir.BzrDir.open(
2001
location, possible_transports=possible_transports)
2002
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2003
# this changes the behaviour of result.clone to create a new reference
2004
# rather than a copy of the content of the branch.
2005
# I did not use a proxy object because that needs much more extensive
2006
# testing, and we are only changing one behaviour at the moment.
2007
# If we decide to alter more behaviours - i.e. the implicit nickname
2008
# then this should be refactored to introduce a tested proxy branch
2009
# and a subclass of that for use in overriding clone() and ....
2011
result.clone = self._make_reference_clone_function(result)
2015
network_format_registry = registry.FormatRegistry()
2016
"""Registry of formats indexed by their network name.
2018
The network name for a branch format is an identifier that can be used when
2019
referring to formats with smart server operations. See
2020
BranchFormat.network_name() for more detail.
2024
# formats which have no format string are not discoverable
2025
# and not independently creatable, so are not registered.
2026
__format5 = BzrBranchFormat5()
2027
__format6 = BzrBranchFormat6()
2028
__format7 = BzrBranchFormat7()
2029
__format8 = BzrBranchFormat8()
2030
BranchFormat.register_format(__format5)
2031
BranchFormat.register_format(BranchReferenceFormat())
2032
BranchFormat.register_format(__format6)
2033
BranchFormat.register_format(__format7)
2034
BranchFormat.register_format(__format8)
2035
BranchFormat.set_default_format(__format6)
2036
_legacy_formats = [BzrBranchFormat4(),
2038
network_format_registry.register(
2039
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2042
class BzrBranch(Branch):
2043
"""A branch stored in the actual filesystem.
2045
Note that it's "local" in the context of the filesystem; it doesn't
2046
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2047
it's writable, and can be accessed via the normal filesystem API.
2049
:ivar _transport: Transport for file operations on this branch's
2050
control files, typically pointing to the .bzr/branch directory.
2051
:ivar repository: Repository for this branch.
2052
:ivar base: The url of the base directory for this branch; the one
2053
containing the .bzr directory.
2056
def __init__(self, _format=None,
2057
_control_files=None, a_bzrdir=None, _repository=None,
2058
ignore_fallbacks=False):
2059
"""Create new branch object at a particular location."""
2060
if a_bzrdir is None:
2061
raise ValueError('a_bzrdir must be supplied')
2063
self.bzrdir = a_bzrdir
2064
self._base = self.bzrdir.transport.clone('..').base
2065
# XXX: We should be able to just do
2066
# self.base = self.bzrdir.root_transport.base
2067
# but this does not quite work yet -- mbp 20080522
2068
self._format = _format
2069
if _control_files is None:
2070
raise ValueError('BzrBranch _control_files is None')
2071
self.control_files = _control_files
2072
self._transport = _control_files._transport
2073
self.repository = _repository
2074
Branch.__init__(self)
2077
return '%s(%r)' % (self.__class__.__name__, self.base)
2081
def _get_base(self):
2082
"""Returns the directory containing the control directory."""
2085
base = property(_get_base, doc="The URL for the root of this branch.")
2087
def _get_config(self):
2088
return TransportConfig(self._transport, 'branch.conf')
2090
def is_locked(self):
2091
return self.control_files.is_locked()
2093
def lock_write(self, token=None):
2094
# All-in-one needs to always unlock/lock.
2095
repo_control = getattr(self.repository, 'control_files', None)
2096
if self.control_files == repo_control or not self.is_locked():
2097
self.repository.lock_write()
2102
return self.control_files.lock_write(token=token)
2105
self.repository.unlock()
2108
def lock_read(self):
2109
# All-in-one needs to always unlock/lock.
2110
repo_control = getattr(self.repository, 'control_files', None)
2111
if self.control_files == repo_control or not self.is_locked():
2112
self.repository.lock_read()
2117
self.control_files.lock_read()
2120
self.repository.unlock()
2125
self.control_files.unlock()
2127
# All-in-one needs to always unlock/lock.
2128
repo_control = getattr(self.repository, 'control_files', None)
2129
if (self.control_files == repo_control or
2130
not self.control_files.is_locked()):
2131
self.repository.unlock()
2132
if not self.control_files.is_locked():
2133
# we just released the lock
2134
self._clear_cached_state()
2136
def peek_lock_mode(self):
2137
if self.control_files._lock_count == 0:
2140
return self.control_files._lock_mode
2142
def get_physical_lock_status(self):
2143
return self.control_files.get_physical_lock_status()
2146
def print_file(self, file, revision_id):
2147
"""See Branch.print_file."""
2148
return self.repository.print_file(file, revision_id)
2150
def _write_revision_history(self, history):
2151
"""Factored out of set_revision_history.
2153
This performs the actual writing to disk.
2154
It is intended to be called by BzrBranch5.set_revision_history."""
2155
self._transport.put_bytes(
2156
'revision-history', '\n'.join(history),
2157
mode=self.bzrdir._get_file_mode())
2160
def set_revision_history(self, rev_history):
2161
"""See Branch.set_revision_history."""
2162
if 'evil' in debug.debug_flags:
2163
mutter_callsite(3, "set_revision_history scales with history.")
2164
check_not_reserved_id = _mod_revision.check_not_reserved_id
2165
for rev_id in rev_history:
2166
check_not_reserved_id(rev_id)
2167
if Branch.hooks['post_change_branch_tip']:
2168
# Don't calculate the last_revision_info() if there are no hooks
2170
old_revno, old_revid = self.last_revision_info()
2171
if len(rev_history) == 0:
2172
revid = _mod_revision.NULL_REVISION
2174
revid = rev_history[-1]
2175
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2176
self._write_revision_history(rev_history)
2177
self._clear_cached_state()
2178
self._cache_revision_history(rev_history)
2179
for hook in Branch.hooks['set_rh']:
2180
hook(self, rev_history)
2181
if Branch.hooks['post_change_branch_tip']:
2182
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2184
def _synchronize_history(self, destination, revision_id):
2185
"""Synchronize last revision and revision history between branches.
2187
This version is most efficient when the destination is also a
2188
BzrBranch5, but works for BzrBranch6 as long as the revision
2189
history is the true lefthand parent history, and all of the revisions
2190
are in the destination's repository. If not, set_revision_history
2193
:param destination: The branch to copy the history into
2194
:param revision_id: The revision-id to truncate history at. May
2195
be None to copy complete history.
2197
if not isinstance(destination._format, BzrBranchFormat5):
2198
super(BzrBranch, self)._synchronize_history(
2199
destination, revision_id)
2201
if revision_id == _mod_revision.NULL_REVISION:
2204
new_history = self.revision_history()
2205
if revision_id is not None and new_history != []:
2207
new_history = new_history[:new_history.index(revision_id) + 1]
2209
rev = self.repository.get_revision(revision_id)
2210
new_history = rev.get_history(self.repository)[1:]
2211
destination.set_revision_history(new_history)
2214
def set_last_revision_info(self, revno, revision_id):
2215
"""Set the last revision of this branch.
2217
The caller is responsible for checking that the revno is correct
2218
for this revision id.
2220
It may be possible to set the branch last revision to an id not
2221
present in the repository. However, branches can also be
2222
configured to check constraints on history, in which case this may not
2225
revision_id = _mod_revision.ensure_null(revision_id)
2226
# this old format stores the full history, but this api doesn't
2227
# provide it, so we must generate, and might as well check it's
2229
history = self._lefthand_history(revision_id)
2230
if len(history) != revno:
2231
raise AssertionError('%d != %d' % (len(history), revno))
2232
self.set_revision_history(history)
2234
def _gen_revision_history(self):
2235
history = self._transport.get_bytes('revision-history').split('\n')
2236
if history[-1:] == ['']:
2237
# There shouldn't be a trailing newline, but just in case.
2242
def generate_revision_history(self, revision_id, last_rev=None,
2244
"""Create a new revision history that will finish with revision_id.
2246
:param revision_id: the new tip to use.
2247
:param last_rev: The previous last_revision. If not None, then this
2248
must be a ancestory of revision_id, or DivergedBranches is raised.
2249
:param other_branch: The other branch that DivergedBranches should
2250
raise with respect to.
2252
self.set_revision_history(self._lefthand_history(revision_id,
2253
last_rev, other_branch))
2255
def basis_tree(self):
2256
"""See Branch.basis_tree."""
2257
return self.repository.revision_tree(self.last_revision())
2259
def _get_parent_location(self):
2260
_locs = ['parent', 'pull', 'x-pull']
2263
return self._transport.get_bytes(l).strip('\n')
2264
except errors.NoSuchFile:
2268
def _basic_push(self, target, overwrite, stop_revision):
2269
"""Basic implementation of push without bound branches or hooks.
2271
Must be called with source read locked and target write locked.
2273
result = BranchPushResult()
2274
result.source_branch = self
2275
result.target_branch = target
2276
result.old_revno, result.old_revid = target.last_revision_info()
2277
self.update_references(target)
2278
if result.old_revid != self.last_revision():
2279
# We assume that during 'push' this repository is closer than
2281
graph = self.repository.get_graph(target.repository)
2282
target.update_revisions(self, stop_revision,
2283
overwrite=overwrite, graph=graph)
2284
if self._push_should_merge_tags():
2285
result.tag_conflicts = self.tags.merge_to(target.tags,
2287
result.new_revno, result.new_revid = target.last_revision_info()
2290
def get_stacked_on_url(self):
2291
raise errors.UnstackableBranchFormat(self._format, self.base)
2293
def set_push_location(self, location):
2294
"""See Branch.set_push_location."""
2295
self.get_config().set_user_option(
2296
'push_location', location,
2297
store=_mod_config.STORE_LOCATION_NORECURSE)
2299
def _set_parent_location(self, url):
2301
self._transport.delete('parent')
2303
self._transport.put_bytes('parent', url + '\n',
2304
mode=self.bzrdir._get_file_mode())
2307
class BzrBranch5(BzrBranch):
2308
"""A format 5 branch. This supports new features over plain branches.
2310
It has support for a master_branch which is the data for bound branches.
2313
def get_bound_location(self):
2315
return self._transport.get_bytes('bound')[:-1]
2316
except errors.NoSuchFile:
2320
def get_master_branch(self, possible_transports=None):
2321
"""Return the branch we are bound to.
2323
:return: Either a Branch, or None
2325
This could memoise the branch, but if thats done
2326
it must be revalidated on each new lock.
2327
So for now we just don't memoise it.
2328
# RBC 20060304 review this decision.
2330
bound_loc = self.get_bound_location()
2334
return Branch.open(bound_loc,
2335
possible_transports=possible_transports)
2336
except (errors.NotBranchError, errors.ConnectionError), e:
2337
raise errors.BoundBranchConnectionFailure(
2341
def set_bound_location(self, location):
2342
"""Set the target where this branch is bound to.
2344
:param location: URL to the target branch
2347
self._transport.put_bytes('bound', location+'\n',
2348
mode=self.bzrdir._get_file_mode())
2351
self._transport.delete('bound')
2352
except errors.NoSuchFile:
2357
def bind(self, other):
2358
"""Bind this branch to the branch other.
2360
This does not push or pull data between the branches, though it does
2361
check for divergence to raise an error when the branches are not
2362
either the same, or one a prefix of the other. That behaviour may not
2363
be useful, so that check may be removed in future.
2365
:param other: The branch to bind to
2368
# TODO: jam 20051230 Consider checking if the target is bound
2369
# It is debatable whether you should be able to bind to
2370
# a branch which is itself bound.
2371
# Committing is obviously forbidden,
2372
# but binding itself may not be.
2373
# Since we *have* to check at commit time, we don't
2374
# *need* to check here
2376
# we want to raise diverged if:
2377
# last_rev is not in the other_last_rev history, AND
2378
# other_last_rev is not in our history, and do it without pulling
2380
self.set_bound_location(other.base)
2384
"""If bound, unbind"""
2385
return self.set_bound_location(None)
2388
def update(self, possible_transports=None):
2389
"""Synchronise this branch with the master branch if any.
2391
:return: None or the last_revision that was pivoted out during the
2394
master = self.get_master_branch(possible_transports)
2395
if master is not None:
2396
old_tip = _mod_revision.ensure_null(self.last_revision())
2397
self.pull(master, overwrite=True)
2398
if self.repository.get_graph().is_ancestor(old_tip,
2399
_mod_revision.ensure_null(self.last_revision())):
2405
class BzrBranch8(BzrBranch5):
2406
"""A branch that stores tree-reference locations."""
2408
def _open_hook(self):
2409
if self._ignore_fallbacks:
2412
url = self.get_stacked_on_url()
2413
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2414
errors.UnstackableBranchFormat):
2417
for hook in Branch.hooks['transform_fallback_location']:
2418
url = hook(self, url)
2420
hook_name = Branch.hooks.get_hook_name(hook)
2421
raise AssertionError(
2422
"'transform_fallback_location' hook %s returned "
2423
"None, not a URL." % hook_name)
2424
self._activate_fallback_location(url)
2426
def __init__(self, *args, **kwargs):
2427
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2428
super(BzrBranch8, self).__init__(*args, **kwargs)
2429
self._last_revision_info_cache = None
2430
self._reference_info = None
2432
def _clear_cached_state(self):
2433
super(BzrBranch8, self)._clear_cached_state()
2434
self._last_revision_info_cache = None
2435
self._reference_info = None
2437
def _last_revision_info(self):
2438
revision_string = self._transport.get_bytes('last-revision')
2439
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2440
revision_id = cache_utf8.get_cached_utf8(revision_id)
2442
return revno, revision_id
2444
def _write_last_revision_info(self, revno, revision_id):
2445
"""Simply write out the revision id, with no checks.
2447
Use set_last_revision_info to perform this safely.
2449
Does not update the revision_history cache.
2450
Intended to be called by set_last_revision_info and
2451
_write_revision_history.
2453
revision_id = _mod_revision.ensure_null(revision_id)
2454
out_string = '%d %s\n' % (revno, revision_id)
2455
self._transport.put_bytes('last-revision', out_string,
2456
mode=self.bzrdir._get_file_mode())
2459
def set_last_revision_info(self, revno, revision_id):
2460
revision_id = _mod_revision.ensure_null(revision_id)
2461
old_revno, old_revid = self.last_revision_info()
2462
if self._get_append_revisions_only():
2463
self._check_history_violation(revision_id)
2464
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2465
self._write_last_revision_info(revno, revision_id)
2466
self._clear_cached_state()
2467
self._last_revision_info_cache = revno, revision_id
2468
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2470
def _synchronize_history(self, destination, revision_id):
2471
"""Synchronize last revision and revision history between branches.
2473
:see: Branch._synchronize_history
2475
# XXX: The base Branch has a fast implementation of this method based
2476
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2477
# that uses set_revision_history. This class inherits from BzrBranch5,
2478
# but wants the fast implementation, so it calls
2479
# Branch._synchronize_history directly.
2480
Branch._synchronize_history(self, destination, revision_id)
2482
def _check_history_violation(self, revision_id):
2483
last_revision = _mod_revision.ensure_null(self.last_revision())
2484
if _mod_revision.is_null(last_revision):
2486
if last_revision not in self._lefthand_history(revision_id):
2487
raise errors.AppendRevisionsOnlyViolation(self.base)
2489
def _gen_revision_history(self):
2490
"""Generate the revision history from last revision
2492
last_revno, last_revision = self.last_revision_info()
2493
self._extend_partial_history(stop_index=last_revno-1)
2494
return list(reversed(self._partial_revision_history_cache))
2496
def _write_revision_history(self, history):
2497
"""Factored out of set_revision_history.
2499
This performs the actual writing to disk, with format-specific checks.
2500
It is intended to be called by BzrBranch5.set_revision_history.
2502
if len(history) == 0:
2503
last_revision = 'null:'
2505
if history != self._lefthand_history(history[-1]):
2506
raise errors.NotLefthandHistory(history)
2507
last_revision = history[-1]
2508
if self._get_append_revisions_only():
2509
self._check_history_violation(last_revision)
2510
self._write_last_revision_info(len(history), last_revision)
2513
def _set_parent_location(self, url):
2514
"""Set the parent branch"""
2515
self._set_config_location('parent_location', url, make_relative=True)
2518
def _get_parent_location(self):
2519
"""Set the parent branch"""
2520
return self._get_config_location('parent_location')
2523
def _set_all_reference_info(self, info_dict):
2524
"""Replace all reference info stored in a branch.
2526
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2529
writer = rio.RioWriter(s)
2530
for key, (tree_path, branch_location) in info_dict.iteritems():
2531
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2532
branch_location=branch_location)
2533
writer.write_stanza(stanza)
2534
self._transport.put_bytes('references', s.getvalue())
2535
self._reference_info = info_dict
2538
def _get_all_reference_info(self):
2539
"""Return all the reference info stored in a branch.
2541
:return: A dict of {file_id: (tree_path, branch_location)}
2543
if self._reference_info is not None:
2544
return self._reference_info
2545
rio_file = self._transport.get('references')
2547
stanzas = rio.read_stanzas(rio_file)
2548
info_dict = dict((s['file_id'], (s['tree_path'],
2549
s['branch_location'])) for s in stanzas)
2552
self._reference_info = info_dict
2555
def set_reference_info(self, file_id, tree_path, branch_location):
2556
"""Set the branch location to use for a tree reference.
2558
:param file_id: The file-id of the tree reference.
2559
:param tree_path: The path of the tree reference in the tree.
2560
:param branch_location: The location of the branch to retrieve tree
2563
info_dict = self._get_all_reference_info()
2564
info_dict[file_id] = (tree_path, branch_location)
2565
if None in (tree_path, branch_location):
2566
if tree_path is not None:
2567
raise ValueError('tree_path must be None when branch_location'
2569
if branch_location is not None:
2570
raise ValueError('branch_location must be None when tree_path'
2572
del info_dict[file_id]
2573
self._set_all_reference_info(info_dict)
2575
def get_reference_info(self, file_id):
2576
"""Get the tree_path and branch_location for a tree reference.
2578
:return: a tuple of (tree_path, branch_location)
2580
return self._get_all_reference_info().get(file_id, (None, None))
2582
def reference_parent(self, file_id, path, possible_transports=None):
2583
"""Return the parent branch for a tree-reference file_id.
2585
:param file_id: The file_id of the tree reference
2586
:param path: The path of the file_id in the tree
2587
:return: A branch associated with the file_id
2589
branch_location = self.get_reference_info(file_id)[1]
2590
if branch_location is None:
2591
return Branch.reference_parent(self, file_id, path,
2592
possible_transports)
2593
branch_location = urlutils.join(self.base, branch_location)
2594
return Branch.open(branch_location,
2595
possible_transports=possible_transports)
2597
def set_push_location(self, location):
2598
"""See Branch.set_push_location."""
2599
self._set_config_location('push_location', location)
2601
def set_bound_location(self, location):
2602
"""See Branch.set_push_location."""
2604
config = self.get_config()
2605
if location is None:
2606
if config.get_user_option('bound') != 'True':
2609
config.set_user_option('bound', 'False', warn_masked=True)
2612
self._set_config_location('bound_location', location,
2614
config.set_user_option('bound', 'True', warn_masked=True)
2617
def _get_bound_location(self, bound):
2618
"""Return the bound location in the config file.
2620
Return None if the bound parameter does not match"""
2621
config = self.get_config()
2622
config_bound = (config.get_user_option('bound') == 'True')
2623
if config_bound != bound:
2625
return self._get_config_location('bound_location', config=config)
2627
def get_bound_location(self):
2628
"""See Branch.set_push_location."""
2629
return self._get_bound_location(True)
2631
def get_old_bound_location(self):
2632
"""See Branch.get_old_bound_location"""
2633
return self._get_bound_location(False)
2635
def get_stacked_on_url(self):
2636
# you can always ask for the URL; but you might not be able to use it
2637
# if the repo can't support stacking.
2638
## self._check_stackable_repo()
2639
stacked_url = self._get_config_location('stacked_on_location')
2640
if stacked_url is None:
2641
raise errors.NotStacked(self)
2644
def _get_append_revisions_only(self):
2645
value = self.get_config().get_user_option('append_revisions_only')
2646
return value == 'True'
2649
def generate_revision_history(self, revision_id, last_rev=None,
2651
"""See BzrBranch5.generate_revision_history"""
2652
history = self._lefthand_history(revision_id, last_rev, other_branch)
2653
revno = len(history)
2654
self.set_last_revision_info(revno, revision_id)
2657
def get_rev_id(self, revno, history=None):
2658
"""Find the revision id of the specified revno."""
2660
return _mod_revision.NULL_REVISION
2662
last_revno, last_revision_id = self.last_revision_info()
2663
if revno <= 0 or revno > last_revno:
2664
raise errors.NoSuchRevision(self, revno)
2666
if history is not None:
2667
return history[revno - 1]
2669
index = last_revno - revno
2670
if len(self._partial_revision_history_cache) <= index:
2671
self._extend_partial_history(stop_index=index)
2672
if len(self._partial_revision_history_cache) > index:
2673
return self._partial_revision_history_cache[index]
2675
raise errors.NoSuchRevision(self, revno)
2678
def revision_id_to_revno(self, revision_id):
2679
"""Given a revision id, return its revno"""
2680
if _mod_revision.is_null(revision_id):
2683
index = self._partial_revision_history_cache.index(revision_id)
2685
self._extend_partial_history(stop_revision=revision_id)
2686
index = len(self._partial_revision_history_cache) - 1
2687
if self._partial_revision_history_cache[index] != revision_id:
2688
raise errors.NoSuchRevision(self, revision_id)
2689
return self.revno() - index
2692
class BzrBranch7(BzrBranch8):
2693
"""A branch with support for a fallback repository."""
2695
def set_reference_info(self, file_id, tree_path, branch_location):
2696
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2698
def get_reference_info(self, file_id):
2699
Branch.get_reference_info(self, file_id)
2701
def reference_parent(self, file_id, path, possible_transports=None):
2702
return Branch.reference_parent(self, file_id, path,
2703
possible_transports)
2706
class BzrBranch6(BzrBranch7):
2707
"""See BzrBranchFormat6 for the capabilities of this branch.
2709
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2713
def get_stacked_on_url(self):
2714
raise errors.UnstackableBranchFormat(self._format, self.base)
2717
######################################################################
2718
# results of operations
2721
class _Result(object):
2723
def _show_tag_conficts(self, to_file):
2724
if not getattr(self, 'tag_conflicts', None):
2726
to_file.write('Conflicting tags:\n')
2727
for name, value1, value2 in self.tag_conflicts:
2728
to_file.write(' %s\n' % (name, ))
2731
class PullResult(_Result):
2732
"""Result of a Branch.pull operation.
2734
:ivar old_revno: Revision number before pull.
2735
:ivar new_revno: Revision number after pull.
2736
:ivar old_revid: Tip revision id before pull.
2737
:ivar new_revid: Tip revision id after pull.
2738
:ivar source_branch: Source (local) branch object. (read locked)
2739
:ivar master_branch: Master branch of the target, or the target if no
2741
:ivar local_branch: target branch if there is a Master, else None
2742
:ivar target_branch: Target/destination branch object. (write locked)
2743
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2747
# DEPRECATED: pull used to return the change in revno
2748
return self.new_revno - self.old_revno
2750
def report(self, to_file):
2752
if self.old_revid == self.new_revid:
2753
to_file.write('No revisions to pull.\n')
2755
to_file.write('Now on revision %d.\n' % self.new_revno)
2756
self._show_tag_conficts(to_file)
2759
class BranchPushResult(_Result):
2760
"""Result of a Branch.push operation.
2762
:ivar old_revno: Revision number (eg 10) of the target before push.
2763
:ivar new_revno: Revision number (eg 12) of the target after push.
2764
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2766
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2768
:ivar source_branch: Source branch object that the push was from. This is
2769
read locked, and generally is a local (and thus low latency) branch.
2770
:ivar master_branch: If target is a bound branch, the master branch of
2771
target, or target itself. Always write locked.
2772
:ivar target_branch: The direct Branch where data is being sent (write
2774
:ivar local_branch: If the target is a bound branch this will be the
2775
target, otherwise it will be None.
2779
# DEPRECATED: push used to return the change in revno
2780
return self.new_revno - self.old_revno
2782
def report(self, to_file):
2783
"""Write a human-readable description of the result."""
2784
if self.old_revid == self.new_revid:
2785
note('No new revisions to push.')
2787
note('Pushed up to revision %d.' % self.new_revno)
2788
self._show_tag_conficts(to_file)
2791
class BranchCheckResult(object):
2792
"""Results of checking branch consistency.
2797
def __init__(self, branch):
2798
self.branch = branch
2799
self.ghosts_in_mainline = False
2801
def report_results(self, verbose):
2802
"""Report the check results via trace.note.
2804
:param verbose: Requests more detailed display of what was checked,
2807
note('checked branch %s format %s',
2809
self.branch._format)
2810
if self.ghosts_in_mainline:
2811
note('branch contains ghosts in mainline')
2814
class Converter5to6(object):
2815
"""Perform an in-place upgrade of format 5 to format 6"""
2817
def convert(self, branch):
2818
# Data for 5 and 6 can peacefully coexist.
2819
format = BzrBranchFormat6()
2820
new_branch = format.open(branch.bzrdir, _found=True)
2822
# Copy source data into target
2823
new_branch._write_last_revision_info(*branch.last_revision_info())
2824
new_branch.set_parent(branch.get_parent())
2825
new_branch.set_bound_location(branch.get_bound_location())
2826
new_branch.set_push_location(branch.get_push_location())
2828
# New branch has no tags by default
2829
new_branch.tags._set_tag_dict({})
2831
# Copying done; now update target format
2832
new_branch._transport.put_bytes('format',
2833
format.get_format_string(),
2834
mode=new_branch.bzrdir._get_file_mode())
2836
# Clean up old files
2837
new_branch._transport.delete('revision-history')
2839
branch.set_parent(None)
2840
except errors.NoSuchFile:
2842
branch.set_bound_location(None)
2845
class Converter6to7(object):
2846
"""Perform an in-place upgrade of format 6 to format 7"""
2848
def convert(self, branch):
2849
format = BzrBranchFormat7()
2850
branch._set_config_location('stacked_on_location', '')
2851
# update target format
2852
branch._transport.put_bytes('format', format.get_format_string())
2855
class Converter7to8(object):
2856
"""Perform an in-place upgrade of format 6 to format 7"""
2858
def convert(self, branch):
2859
format = BzrBranchFormat8()
2860
branch._transport.put_bytes('references', '')
2861
# update target format
2862
branch._transport.put_bytes('format', format.get_format_string())
2865
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2866
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2869
_run_with_write_locked_target will attempt to release the lock it acquires.
2871
If an exception is raised by callable, then that exception *will* be
2872
propagated, even if the unlock attempt raises its own error. Thus
2873
_run_with_write_locked_target should be preferred to simply doing::
2877
return callable(*args, **kwargs)
2882
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2883
# should share code?
2886
result = callable(*args, **kwargs)
2888
exc_info = sys.exc_info()
2892
raise exc_info[0], exc_info[1], exc_info[2]
2898
class InterBranch(InterObject):
2899
"""This class represents operations taking place between two branches.
2901
Its instances have methods like pull() and push() and contain
2902
references to the source and target repositories these operations
2903
can be carried out on.
2907
"""The available optimised InterBranch types."""
2910
def _get_branch_formats_to_test():
2911
"""Return a tuple with the Branch formats to use when testing."""
2912
raise NotImplementedError(self._get_branch_formats_to_test)
2914
def pull(self, overwrite=False, stop_revision=None,
2915
possible_transports=None, local=False):
2916
"""Mirror source into target branch.
2918
The target branch is considered to be 'local', having low latency.
2920
:returns: PullResult instance
2922
raise NotImplementedError(self.pull)
2924
def update_revisions(self, stop_revision=None, overwrite=False,
2926
"""Pull in new perfect-fit revisions.
2928
:param stop_revision: Updated until the given revision
2929
:param overwrite: Always set the branch pointer, rather than checking
2930
to see if it is a proper descendant.
2931
:param graph: A Graph object that can be used to query history
2932
information. This can be None.
2935
raise NotImplementedError(self.update_revisions)
2937
def push(self, overwrite=False, stop_revision=None,
2938
_override_hook_source_branch=None):
2939
"""Mirror the source branch into the target branch.
2941
The source branch is considered to be 'local', having low latency.
2943
raise NotImplementedError(self.push)
2946
class GenericInterBranch(InterBranch):
2947
"""InterBranch implementation that uses public Branch functions.
2951
def _get_branch_formats_to_test():
2952
return BranchFormat._default_format, BranchFormat._default_format
2954
def update_revisions(self, stop_revision=None, overwrite=False,
2956
"""See InterBranch.update_revisions()."""
2957
self.source.lock_read()
2959
other_revno, other_last_revision = self.source.last_revision_info()
2960
stop_revno = None # unknown
2961
if stop_revision is None:
2962
stop_revision = other_last_revision
2963
if _mod_revision.is_null(stop_revision):
2964
# if there are no commits, we're done.
2966
stop_revno = other_revno
2968
# what's the current last revision, before we fetch [and change it
2970
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2971
# we fetch here so that we don't process data twice in the common
2972
# case of having something to pull, and so that the check for
2973
# already merged can operate on the just fetched graph, which will
2974
# be cached in memory.
2975
self.target.fetch(self.source, stop_revision)
2976
# Check to see if one is an ancestor of the other
2979
graph = self.target.repository.get_graph()
2980
if self.target._check_if_descendant_or_diverged(
2981
stop_revision, last_rev, graph, self.source):
2982
# stop_revision is a descendant of last_rev, but we aren't
2983
# overwriting, so we're done.
2985
if stop_revno is None:
2987
graph = self.target.repository.get_graph()
2988
this_revno, this_last_revision = \
2989
self.target.last_revision_info()
2990
stop_revno = graph.find_distance_to_null(stop_revision,
2991
[(other_last_revision, other_revno),
2992
(this_last_revision, this_revno)])
2993
self.target.set_last_revision_info(stop_revno, stop_revision)
2995
self.source.unlock()
2997
def pull(self, overwrite=False, stop_revision=None,
2998
possible_transports=None, _hook_master=None, run_hooks=True,
2999
_override_hook_target=None, local=False):
3002
:param _hook_master: Private parameter - set the branch to
3003
be supplied as the master to pull hooks.
3004
:param run_hooks: Private parameter - if false, this branch
3005
is being called because it's the master of the primary branch,
3006
so it should not run its hooks.
3007
:param _override_hook_target: Private parameter - set the branch to be
3008
supplied as the target_branch to pull hooks.
3009
:param local: Only update the local branch, and not the bound branch.
3011
# This type of branch can't be bound.
3013
raise errors.LocalRequiresBoundBranch()
3014
result = PullResult()
3015
result.source_branch = self.source
3016
if _override_hook_target is None:
3017
result.target_branch = self.target
3019
result.target_branch = _override_hook_target
3020
self.source.lock_read()
3022
# We assume that during 'pull' the target repository is closer than
3024
self.source.update_references(self.target)
3025
graph = self.target.repository.get_graph(self.source.repository)
3026
# TODO: Branch formats should have a flag that indicates
3027
# that revno's are expensive, and pull() should honor that flag.
3029
result.old_revno, result.old_revid = \
3030
self.target.last_revision_info()
3031
self.target.update_revisions(self.source, stop_revision,
3032
overwrite=overwrite, graph=graph)
3033
# TODO: The old revid should be specified when merging tags,
3034
# so a tags implementation that versions tags can only
3035
# pull in the most recent changes. -- JRV20090506
3036
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3038
result.new_revno, result.new_revid = self.target.last_revision_info()
3040
result.master_branch = _hook_master
3041
result.local_branch = result.target_branch
3043
result.master_branch = result.target_branch
3044
result.local_branch = None
3046
for hook in Branch.hooks['post_pull']:
3049
self.source.unlock()
3052
def push(self, overwrite=False, stop_revision=None,
3053
_override_hook_source_branch=None):
3054
"""See InterBranch.push.
3056
This is the basic concrete implementation of push()
3058
:param _override_hook_source_branch: If specified, run
3059
the hooks passing this Branch as the source, rather than self.
3060
This is for use of RemoteBranch, where push is delegated to the
3061
underlying vfs-based Branch.
3063
# TODO: Public option to disable running hooks - should be trivial but
3065
self.source.lock_read()
3067
return _run_with_write_locked_target(
3068
self.target, self._push_with_bound_branches, overwrite,
3070
_override_hook_source_branch=_override_hook_source_branch)
3072
self.source.unlock()
3075
def _push_with_bound_branches(self, overwrite, stop_revision,
3076
_override_hook_source_branch=None):
3077
"""Push from source into target, and into target's master if any.
3080
if _override_hook_source_branch:
3081
result.source_branch = _override_hook_source_branch
3082
for hook in Branch.hooks['post_push']:
3085
bound_location = self.target.get_bound_location()
3086
if bound_location and self.target.base != bound_location:
3087
# there is a master branch.
3089
# XXX: Why the second check? Is it even supported for a branch to
3090
# be bound to itself? -- mbp 20070507
3091
master_branch = self.target.get_master_branch()
3092
master_branch.lock_write()
3094
# push into the master from the source branch.
3095
self.source._basic_push(master_branch, overwrite, stop_revision)
3096
# and push into the target branch from the source. Note that we
3097
# push from the source branch again, because its considered the
3098
# highest bandwidth repository.
3099
result = self.source._basic_push(self.target, overwrite,
3101
result.master_branch = master_branch
3102
result.local_branch = self.target
3106
master_branch.unlock()
3109
result = self.source._basic_push(self.target, overwrite,
3111
# TODO: Why set master_branch and local_branch if there's no
3112
# binding? Maybe cleaner to just leave them unset? -- mbp
3114
result.master_branch = self.target
3115
result.local_branch = None
3120
def is_compatible(self, source, target):
3121
# GenericBranch uses the public API, so always compatible
3125
class InterToBranch5(GenericInterBranch):
3128
def _get_branch_formats_to_test():
3129
return BranchFormat._default_format, BzrBranchFormat5()
3131
def pull(self, overwrite=False, stop_revision=None,
3132
possible_transports=None, run_hooks=True,
3133
_override_hook_target=None, local=False):
3134
"""Pull from source into self, updating my master if any.
3136
:param run_hooks: Private parameter - if false, this branch
3137
is being called because it's the master of the primary branch,
3138
so it should not run its hooks.
3140
bound_location = self.target.get_bound_location()
3141
if local and not bound_location:
3142
raise errors.LocalRequiresBoundBranch()
3143
master_branch = None
3144
if not local and bound_location and self.source.base != bound_location:
3145
# not pulling from master, so we need to update master.
3146
master_branch = self.target.get_master_branch(possible_transports)
3147
master_branch.lock_write()
3150
# pull from source into master.
3151
master_branch.pull(self.source, overwrite, stop_revision,
3153
return super(InterToBranch5, self).pull(overwrite,
3154
stop_revision, _hook_master=master_branch,
3155
run_hooks=run_hooks,
3156
_override_hook_target=_override_hook_target)
3159
master_branch.unlock()
3162
InterBranch.register_optimiser(GenericInterBranch)
3163
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
