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, only_raises
50
from bzrlib.hooks import HookPoint, Hooks
51
from bzrlib.inter import InterObject
52
from bzrlib.lock import _RelockDebugMixin
53
from bzrlib import registry
54
from bzrlib.symbol_versioning import (
58
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
61
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
62
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
66
# TODO: Maybe include checks for common corruption of newlines, etc?
68
# TODO: Some operations like log might retrieve the same revisions
69
# repeatedly to calculate deltas. We could perhaps have a weakref
70
# cache in memory to make this faster. In general anything can be
71
# cached in memory between lock and unlock operations. .. nb thats
72
# what the transaction identity map provides
75
######################################################################
79
"""Branch holding a history of revisions.
82
Base directory/url of the branch.
84
hooks: An instance of BranchHooks.
86
# this is really an instance variable - FIXME move it there
90
def __init__(self, *ignored, **ignored_too):
91
self.tags = self._format.make_tags(self)
92
self._revision_history_cache = None
93
self._revision_id_to_revno_cache = None
94
self._partial_revision_id_to_revno_cache = {}
95
self._partial_revision_history_cache = []
96
self._last_revision_info_cache = None
97
self._merge_sorted_revisions_cache = None
99
hooks = Branch.hooks['open']
103
def _open_hook(self):
104
"""Called by init to allow simpler extension of the base class."""
106
def _activate_fallback_location(self, url):
107
"""Activate the branch/repository from url as a fallback repository."""
108
repo = self._get_fallback_repository(url)
109
if repo.has_same_location(self.repository):
110
raise errors.UnstackableLocationError(self.base, url)
111
self.repository.add_fallback_repository(repo)
113
def break_lock(self):
114
"""Break a lock if one is present from another instance.
116
Uses the ui factory to ask for confirmation if the lock may be from
119
This will probe the repository for its lock as well.
121
self.control_files.break_lock()
122
self.repository.break_lock()
123
master = self.get_master_branch()
124
if master is not None:
127
def _check_stackable_repo(self):
128
if not self.repository._format.supports_external_lookups:
129
raise errors.UnstackableRepositoryFormat(self.repository._format,
130
self.repository.base)
132
def _extend_partial_history(self, stop_index=None, stop_revision=None):
133
"""Extend the partial history to include a given index
135
If a stop_index is supplied, stop when that index has been reached.
136
If a stop_revision is supplied, stop when that revision is
137
encountered. Otherwise, stop when the beginning of history is
140
:param stop_index: The index which should be present. When it is
141
present, history extension will stop.
142
:param stop_revision: The revision id which should be present. When
143
it is encountered, history extension will stop.
145
if len(self._partial_revision_history_cache) == 0:
146
self._partial_revision_history_cache = [self.last_revision()]
147
repository._iter_for_revno(
148
self.repository, self._partial_revision_history_cache,
149
stop_index=stop_index, stop_revision=stop_revision)
150
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
151
self._partial_revision_history_cache.pop()
153
def _get_check_refs(self):
154
"""Get the references needed for check().
158
revid = self.last_revision()
159
return [('revision-existence', revid), ('lefthand-distance', revid)]
162
def open(base, _unsupported=False, possible_transports=None):
163
"""Open the branch rooted at base.
165
For instance, if the branch is at URL/.bzr/branch,
166
Branch.open(URL) -> a Branch instance.
168
control = bzrdir.BzrDir.open(base, _unsupported,
169
possible_transports=possible_transports)
170
return control.open_branch(_unsupported)
173
def open_from_transport(transport, _unsupported=False):
174
"""Open the branch rooted at transport"""
175
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
176
return control.open_branch(_unsupported)
179
def open_containing(url, possible_transports=None):
180
"""Open an existing branch which contains url.
182
This probes for a branch at url, and searches upwards from there.
184
Basically we keep looking up until we find the control directory or
185
run into the root. If there isn't one, raises NotBranchError.
186
If there is one and it is either an unrecognised format or an unsupported
187
format, UnknownFormatError or UnsupportedFormatError are raised.
188
If there is one, it is returned, along with the unused portion of url.
190
control, relpath = bzrdir.BzrDir.open_containing(url,
192
return control.open_branch(), relpath
194
def _push_should_merge_tags(self):
195
"""Should _basic_push merge this branch's tags into the target?
197
The default implementation returns False if this branch has no tags,
198
and True the rest of the time. Subclasses may override this.
200
return self.supports_tags() and self.tags.get_tag_dict()
202
def get_config(self):
203
return BranchConfig(self)
205
def _get_config(self):
206
"""Get the concrete config for just the config in this branch.
208
This is not intended for client use; see Branch.get_config for the
213
:return: An object supporting get_option and set_option.
215
raise NotImplementedError(self._get_config)
217
def _get_fallback_repository(self, url):
218
"""Get the repository we fallback to at url."""
219
url = urlutils.join(self.base, url)
220
a_bzrdir = bzrdir.BzrDir.open(url,
221
possible_transports=[self.bzrdir.root_transport])
222
return a_bzrdir.open_branch().repository
224
def _get_tags_bytes(self):
225
"""Get the bytes of a serialised tags dict.
227
Note that not all branches support tags, nor do all use the same tags
228
logic: this method is specific to BasicTags. Other tag implementations
229
may use the same method name and behave differently, safely, because
230
of the double-dispatch via
231
format.make_tags->tags_instance->get_tags_dict.
233
:return: The bytes of the tags file.
234
:seealso: Branch._set_tags_bytes.
236
return self._transport.get_bytes('tags')
238
def _get_nick(self, local=False, possible_transports=None):
239
config = self.get_config()
240
# explicit overrides master, but don't look for master if local is True
241
if not local and not config.has_explicit_nickname():
243
master = self.get_master_branch(possible_transports)
244
if master is not None:
245
# return the master branch value
247
except errors.BzrError, e:
248
# Silently fall back to local implicit nick if the master is
250
mutter("Could not connect to bound branch, "
251
"falling back to local nick.\n " + str(e))
252
return config.get_nickname()
254
def _set_nick(self, nick):
255
self.get_config().set_user_option('nickname', nick, warn_masked=True)
257
nick = property(_get_nick, _set_nick)
260
raise NotImplementedError(self.is_locked)
262
def _lefthand_history(self, revision_id, last_rev=None,
264
if 'evil' in debug.debug_flags:
265
mutter_callsite(4, "_lefthand_history scales with history.")
266
# stop_revision must be a descendant of last_revision
267
graph = self.repository.get_graph()
268
if last_rev is not None:
269
if not graph.is_ancestor(last_rev, revision_id):
270
# our previous tip is not merged into stop_revision
271
raise errors.DivergedBranches(self, other_branch)
272
# make a new revision history from the graph
273
parents_map = graph.get_parent_map([revision_id])
274
if revision_id not in parents_map:
275
raise errors.NoSuchRevision(self, revision_id)
276
current_rev_id = revision_id
278
check_not_reserved_id = _mod_revision.check_not_reserved_id
279
# Do not include ghosts or graph origin in revision_history
280
while (current_rev_id in parents_map and
281
len(parents_map[current_rev_id]) > 0):
282
check_not_reserved_id(current_rev_id)
283
new_history.append(current_rev_id)
284
current_rev_id = parents_map[current_rev_id][0]
285
parents_map = graph.get_parent_map([current_rev_id])
286
new_history.reverse()
289
def lock_write(self):
290
raise NotImplementedError(self.lock_write)
293
raise NotImplementedError(self.lock_read)
296
raise NotImplementedError(self.unlock)
298
def peek_lock_mode(self):
299
"""Return lock mode for the Branch: 'r', 'w' or None"""
300
raise NotImplementedError(self.peek_lock_mode)
302
def get_physical_lock_status(self):
303
raise NotImplementedError(self.get_physical_lock_status)
306
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
307
"""Return the revision_id for a dotted revno.
309
:param revno: a tuple like (1,) or (1,1,2)
310
:param _cache_reverse: a private parameter enabling storage
311
of the reverse mapping in a top level cache. (This should
312
only be done in selective circumstances as we want to
313
avoid having the mapping cached multiple times.)
314
:return: the revision_id
315
:raises errors.NoSuchRevision: if the revno doesn't exist
317
rev_id = self._do_dotted_revno_to_revision_id(revno)
319
self._partial_revision_id_to_revno_cache[rev_id] = revno
322
def _do_dotted_revno_to_revision_id(self, revno):
323
"""Worker function for dotted_revno_to_revision_id.
325
Subclasses should override this if they wish to
326
provide a more efficient implementation.
329
return self.get_rev_id(revno[0])
330
revision_id_to_revno = self.get_revision_id_to_revno_map()
331
revision_ids = [revision_id for revision_id, this_revno
332
in revision_id_to_revno.iteritems()
333
if revno == this_revno]
334
if len(revision_ids) == 1:
335
return revision_ids[0]
337
revno_str = '.'.join(map(str, revno))
338
raise errors.NoSuchRevision(self, revno_str)
341
def revision_id_to_dotted_revno(self, revision_id):
342
"""Given a revision id, return its dotted revno.
344
:return: a tuple like (1,) or (400,1,3).
346
return self._do_revision_id_to_dotted_revno(revision_id)
348
def _do_revision_id_to_dotted_revno(self, revision_id):
349
"""Worker function for revision_id_to_revno."""
350
# Try the caches if they are loaded
351
result = self._partial_revision_id_to_revno_cache.get(revision_id)
352
if result is not None:
354
if self._revision_id_to_revno_cache:
355
result = self._revision_id_to_revno_cache.get(revision_id)
357
raise errors.NoSuchRevision(self, revision_id)
358
# Try the mainline as it's optimised
360
revno = self.revision_id_to_revno(revision_id)
362
except errors.NoSuchRevision:
363
# We need to load and use the full revno map after all
364
result = self.get_revision_id_to_revno_map().get(revision_id)
366
raise errors.NoSuchRevision(self, revision_id)
370
def get_revision_id_to_revno_map(self):
371
"""Return the revision_id => dotted revno map.
373
This will be regenerated on demand, but will be cached.
375
:return: A dictionary mapping revision_id => dotted revno.
376
This dictionary should not be modified by the caller.
378
if self._revision_id_to_revno_cache is not None:
379
mapping = self._revision_id_to_revno_cache
381
mapping = self._gen_revno_map()
382
self._cache_revision_id_to_revno(mapping)
383
# TODO: jam 20070417 Since this is being cached, should we be returning
385
# I would rather not, and instead just declare that users should not
386
# modify the return value.
389
def _gen_revno_map(self):
390
"""Create a new mapping from revision ids to dotted revnos.
392
Dotted revnos are generated based on the current tip in the revision
394
This is the worker function for get_revision_id_to_revno_map, which
395
just caches the return value.
397
:return: A dictionary mapping revision_id => dotted revno.
399
revision_id_to_revno = dict((rev_id, revno)
400
for rev_id, depth, revno, end_of_merge
401
in self.iter_merge_sorted_revisions())
402
return revision_id_to_revno
405
def iter_merge_sorted_revisions(self, start_revision_id=None,
406
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
407
"""Walk the revisions for a branch in merge sorted order.
409
Merge sorted order is the output from a merge-aware,
410
topological sort, i.e. all parents come before their
411
children going forward; the opposite for reverse.
413
:param start_revision_id: the revision_id to begin walking from.
414
If None, the branch tip is used.
415
:param stop_revision_id: the revision_id to terminate the walk
416
after. If None, the rest of history is included.
417
:param stop_rule: if stop_revision_id is not None, the precise rule
418
to use for termination:
419
* 'exclude' - leave the stop revision out of the result (default)
420
* 'include' - the stop revision is the last item in the result
421
* 'with-merges' - include the stop revision and all of its
422
merged revisions in the result
423
:param direction: either 'reverse' or 'forward':
424
* reverse means return the start_revision_id first, i.e.
425
start at the most recent revision and go backwards in history
426
* forward returns tuples in the opposite order to reverse.
427
Note in particular that forward does *not* do any intelligent
428
ordering w.r.t. depth as some clients of this API may like.
429
(If required, that ought to be done at higher layers.)
431
:return: an iterator over (revision_id, depth, revno, end_of_merge)
434
* revision_id: the unique id of the revision
435
* depth: How many levels of merging deep this node has been
437
* revno_sequence: This field provides a sequence of
438
revision numbers for all revisions. The format is:
439
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
440
branch that the revno is on. From left to right the REVNO numbers
441
are the sequence numbers within that branch of the revision.
442
* end_of_merge: When True the next node (earlier in history) is
443
part of a different merge.
445
# Note: depth and revno values are in the context of the branch so
446
# we need the full graph to get stable numbers, regardless of the
448
if self._merge_sorted_revisions_cache is None:
449
last_revision = self.last_revision()
450
last_key = (last_revision,)
451
known_graph = self.repository.revisions.get_known_graph_ancestry(
453
self._merge_sorted_revisions_cache = known_graph.merge_sort(
455
filtered = self._filter_merge_sorted_revisions(
456
self._merge_sorted_revisions_cache, start_revision_id,
457
stop_revision_id, stop_rule)
458
if direction == 'reverse':
460
if direction == 'forward':
461
return reversed(list(filtered))
463
raise ValueError('invalid direction %r' % direction)
465
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
466
start_revision_id, stop_revision_id, stop_rule):
467
"""Iterate over an inclusive range of sorted revisions."""
468
rev_iter = iter(merge_sorted_revisions)
469
if start_revision_id is not None:
470
for node in rev_iter:
471
rev_id = node.key[-1]
472
if rev_id != start_revision_id:
475
# The decision to include the start or not
476
# depends on the stop_rule if a stop is provided
477
# so pop this node back into the iterator
478
rev_iter = chain(iter([node]), rev_iter)
480
if stop_revision_id is None:
482
for node in rev_iter:
483
rev_id = node.key[-1]
484
yield (rev_id, node.merge_depth, node.revno,
486
elif stop_rule == 'exclude':
487
for node in rev_iter:
488
rev_id = node.key[-1]
489
if rev_id == stop_revision_id:
491
yield (rev_id, node.merge_depth, node.revno,
493
elif stop_rule == 'include':
494
for node in rev_iter:
495
rev_id = node.key[-1]
496
yield (rev_id, node.merge_depth, node.revno,
498
if rev_id == stop_revision_id:
500
elif stop_rule == 'with-merges':
501
stop_rev = self.repository.get_revision(stop_revision_id)
502
if stop_rev.parent_ids:
503
left_parent = stop_rev.parent_ids[0]
505
left_parent = _mod_revision.NULL_REVISION
506
# left_parent is the actual revision we want to stop logging at,
507
# since we want to show the merged revisions after the stop_rev too
508
reached_stop_revision_id = False
509
revision_id_whitelist = []
510
for node in rev_iter:
511
rev_id = node.key[-1]
512
if rev_id == left_parent:
513
# reached the left parent after the stop_revision
515
if (not reached_stop_revision_id or
516
rev_id in revision_id_whitelist):
517
yield (rev_id, node.merge_depth, node.revno,
519
if reached_stop_revision_id or rev_id == stop_revision_id:
520
# only do the merged revs of rev_id from now on
521
rev = self.repository.get_revision(rev_id)
523
reached_stop_revision_id = True
524
revision_id_whitelist.extend(rev.parent_ids)
526
raise ValueError('invalid stop_rule %r' % stop_rule)
528
def leave_lock_in_place(self):
529
"""Tell this branch object not to release the physical lock when this
532
If lock_write doesn't return a token, then this method is not supported.
534
self.control_files.leave_in_place()
536
def dont_leave_lock_in_place(self):
537
"""Tell this branch object to release the physical lock when this
538
object is unlocked, even if it didn't originally acquire it.
540
If lock_write doesn't return a token, then this method is not supported.
542
self.control_files.dont_leave_in_place()
544
def bind(self, other):
545
"""Bind the local branch the other branch.
547
:param other: The branch to bind to
550
raise errors.UpgradeRequired(self.base)
552
def set_append_revisions_only(self, enabled):
553
if not self._format.supports_set_append_revisions_only():
554
raise errors.UpgradeRequired(self.base)
559
self.get_config().set_user_option('append_revisions_only', value,
562
def set_reference_info(self, file_id, tree_path, branch_location):
563
"""Set the branch location to use for a tree reference."""
564
raise errors.UnsupportedOperation(self.set_reference_info, self)
566
def get_reference_info(self, file_id):
567
"""Get the tree_path and branch_location for a tree reference."""
568
raise errors.UnsupportedOperation(self.get_reference_info, self)
571
def fetch(self, from_branch, last_revision=None, pb=None):
572
"""Copy revisions from from_branch into this branch.
574
:param from_branch: Where to copy from.
575
:param last_revision: What revision to stop at (None for at the end
577
:param pb: An optional progress bar to use.
580
if self.base == from_branch.base:
583
symbol_versioning.warn(
584
symbol_versioning.deprecated_in((1, 14, 0))
585
% "pb parameter to fetch()")
586
from_branch.lock_read()
588
if last_revision is None:
589
last_revision = from_branch.last_revision()
590
last_revision = _mod_revision.ensure_null(last_revision)
591
return self.repository.fetch(from_branch.repository,
592
revision_id=last_revision,
597
def get_bound_location(self):
598
"""Return the URL of the branch we are bound to.
600
Older format branches cannot bind, please be sure to use a metadir
605
def get_old_bound_location(self):
606
"""Return the URL of the branch we used to be bound to
608
raise errors.UpgradeRequired(self.base)
610
def get_commit_builder(self, parents, config=None, timestamp=None,
611
timezone=None, committer=None, revprops=None,
613
"""Obtain a CommitBuilder for this branch.
615
:param parents: Revision ids of the parents of the new revision.
616
:param config: Optional configuration to use.
617
:param timestamp: Optional timestamp recorded for commit.
618
:param timezone: Optional timezone for timestamp.
619
:param committer: Optional committer to set for commit.
620
:param revprops: Optional dictionary of revision properties.
621
:param revision_id: Optional revision id.
625
config = self.get_config()
627
return self.repository.get_commit_builder(self, parents, config,
628
timestamp, timezone, committer, revprops, revision_id)
630
def get_master_branch(self, possible_transports=None):
631
"""Return the branch we are bound to.
633
:return: Either a Branch, or None
637
def get_revision_delta(self, revno):
638
"""Return the delta for one revision.
640
The delta is relative to its mainline predecessor, or the
641
empty tree for revision 1.
643
rh = self.revision_history()
644
if not (1 <= revno <= len(rh)):
645
raise errors.InvalidRevisionNumber(revno)
646
return self.repository.get_revision_delta(rh[revno-1])
648
def get_stacked_on_url(self):
649
"""Get the URL this branch is stacked against.
651
:raises NotStacked: If the branch is not stacked.
652
:raises UnstackableBranchFormat: If the branch does not support
655
raise NotImplementedError(self.get_stacked_on_url)
657
def print_file(self, file, revision_id):
658
"""Print `file` to stdout."""
659
raise NotImplementedError(self.print_file)
661
def set_revision_history(self, rev_history):
662
raise NotImplementedError(self.set_revision_history)
665
def set_parent(self, url):
666
"""See Branch.set_parent."""
667
# TODO: Maybe delete old location files?
668
# URLs should never be unicode, even on the local fs,
669
# FIXUP this and get_parent in a future branch format bump:
670
# read and rewrite the file. RBC 20060125
672
if isinstance(url, unicode):
674
url = url.encode('ascii')
675
except UnicodeEncodeError:
676
raise errors.InvalidURL(url,
677
"Urls must be 7-bit ascii, "
678
"use bzrlib.urlutils.escape")
679
url = urlutils.relative_url(self.base, url)
680
self._set_parent_location(url)
683
def set_stacked_on_url(self, url):
684
"""Set the URL this branch is stacked against.
686
:raises UnstackableBranchFormat: If the branch does not support
688
:raises UnstackableRepositoryFormat: If the repository does not support
691
if not self._format.supports_stacking():
692
raise errors.UnstackableBranchFormat(self._format, self.base)
693
# XXX: Changing from one fallback repository to another does not check
694
# that all the data you need is present in the new fallback.
695
# Possibly it should.
696
self._check_stackable_repo()
699
old_url = self.get_stacked_on_url()
700
except (errors.NotStacked, errors.UnstackableBranchFormat,
701
errors.UnstackableRepositoryFormat):
705
self._activate_fallback_location(url)
706
# write this out after the repository is stacked to avoid setting a
707
# stacked config that doesn't work.
708
self._set_config_location('stacked_on_location', url)
711
"""Change a branch to be unstacked, copying data as needed.
713
Don't call this directly, use set_stacked_on_url(None).
715
pb = ui.ui_factory.nested_progress_bar()
717
pb.update("Unstacking")
718
# The basic approach here is to fetch the tip of the branch,
719
# including all available ghosts, from the existing stacked
720
# repository into a new repository object without the fallbacks.
722
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
723
# correct for CHKMap repostiories
724
old_repository = self.repository
725
if len(old_repository._fallback_repositories) != 1:
726
raise AssertionError("can't cope with fallback repositories "
727
"of %r" % (self.repository,))
728
# unlock it, including unlocking the fallback
729
old_repository.unlock()
730
old_repository.lock_read()
732
# Repositories don't offer an interface to remove fallback
733
# repositories today; take the conceptually simpler option and just
734
# reopen it. We reopen it starting from the URL so that we
735
# get a separate connection for RemoteRepositories and can
736
# stream from one of them to the other. This does mean doing
737
# separate SSH connection setup, but unstacking is not a
738
# common operation so it's tolerable.
739
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
740
new_repository = new_bzrdir.find_repository()
741
self.repository = new_repository
742
if self.repository._fallback_repositories:
743
raise AssertionError("didn't expect %r to have "
744
"fallback_repositories"
745
% (self.repository,))
746
# this is not paired with an unlock because it's just restoring
747
# the previous state; the lock's released when set_stacked_on_url
749
self.repository.lock_write()
750
# XXX: If you unstack a branch while it has a working tree
751
# with a pending merge, the pending-merged revisions will no
752
# longer be present. You can (probably) revert and remerge.
754
# XXX: This only fetches up to the tip of the repository; it
755
# doesn't bring across any tags. That's fairly consistent
756
# with how branch works, but perhaps not ideal.
757
self.repository.fetch(old_repository,
758
revision_id=self.last_revision(),
761
old_repository.unlock()
765
def _set_tags_bytes(self, bytes):
766
"""Mirror method for _get_tags_bytes.
768
:seealso: Branch._get_tags_bytes.
770
return _run_with_write_locked_target(self, self._transport.put_bytes,
773
def _cache_revision_history(self, rev_history):
774
"""Set the cached revision history to rev_history.
776
The revision_history method will use this cache to avoid regenerating
777
the revision history.
779
This API is semi-public; it only for use by subclasses, all other code
780
should consider it to be private.
782
self._revision_history_cache = rev_history
784
def _cache_revision_id_to_revno(self, revision_id_to_revno):
785
"""Set the cached revision_id => revno map to revision_id_to_revno.
787
This API is semi-public; it only for use by subclasses, all other code
788
should consider it to be private.
790
self._revision_id_to_revno_cache = revision_id_to_revno
792
def _clear_cached_state(self):
793
"""Clear any cached data on this branch, e.g. cached revision history.
795
This means the next call to revision_history will need to call
796
_gen_revision_history.
798
This API is semi-public; it only for use by subclasses, all other code
799
should consider it to be private.
801
self._revision_history_cache = None
802
self._revision_id_to_revno_cache = None
803
self._last_revision_info_cache = None
804
self._merge_sorted_revisions_cache = None
805
self._partial_revision_history_cache = []
806
self._partial_revision_id_to_revno_cache = {}
808
def _gen_revision_history(self):
809
"""Return sequence of revision hashes on to this branch.
811
Unlike revision_history, this method always regenerates or rereads the
812
revision history, i.e. it does not cache the result, so repeated calls
815
Concrete subclasses should override this instead of revision_history so
816
that subclasses do not need to deal with caching logic.
818
This API is semi-public; it only for use by subclasses, all other code
819
should consider it to be private.
821
raise NotImplementedError(self._gen_revision_history)
824
def revision_history(self):
825
"""Return sequence of revision ids on this branch.
827
This method will cache the revision history for as long as it is safe to
830
if 'evil' in debug.debug_flags:
831
mutter_callsite(3, "revision_history scales with history.")
832
if self._revision_history_cache is not None:
833
history = self._revision_history_cache
835
history = self._gen_revision_history()
836
self._cache_revision_history(history)
840
"""Return current revision number for this branch.
842
That is equivalent to the number of revisions committed to
845
return self.last_revision_info()[0]
848
"""Older format branches cannot bind or unbind."""
849
raise errors.UpgradeRequired(self.base)
851
def last_revision(self):
852
"""Return last revision id, or NULL_REVISION."""
853
return self.last_revision_info()[1]
856
def last_revision_info(self):
857
"""Return information about the last revision.
859
:return: A tuple (revno, revision_id).
861
if self._last_revision_info_cache is None:
862
self._last_revision_info_cache = self._last_revision_info()
863
return self._last_revision_info_cache
865
def _last_revision_info(self):
866
rh = self.revision_history()
869
return (revno, rh[-1])
871
return (0, _mod_revision.NULL_REVISION)
873
@deprecated_method(deprecated_in((1, 6, 0)))
874
def missing_revisions(self, other, stop_revision=None):
875
"""Return a list of new revisions that would perfectly fit.
877
If self and other have not diverged, return a list of the revisions
878
present in other, but missing from self.
880
self_history = self.revision_history()
881
self_len = len(self_history)
882
other_history = other.revision_history()
883
other_len = len(other_history)
884
common_index = min(self_len, other_len) -1
885
if common_index >= 0 and \
886
self_history[common_index] != other_history[common_index]:
887
raise errors.DivergedBranches(self, other)
889
if stop_revision is None:
890
stop_revision = other_len
892
if stop_revision > other_len:
893
raise errors.NoSuchRevision(self, stop_revision)
894
return other_history[self_len:stop_revision]
897
def update_revisions(self, other, stop_revision=None, overwrite=False,
899
"""Pull in new perfect-fit revisions.
901
:param other: Another Branch to pull from
902
:param stop_revision: Updated until the given revision
903
:param overwrite: Always set the branch pointer, rather than checking
904
to see if it is a proper descendant.
905
:param graph: A Graph object that can be used to query history
906
information. This can be None.
909
return InterBranch.get(other, self).update_revisions(stop_revision,
912
def import_last_revision_info(self, source_repo, revno, revid):
913
"""Set the last revision info, importing from another repo if necessary.
915
This is used by the bound branch code to upload a revision to
916
the master branch first before updating the tip of the local branch.
918
:param source_repo: Source repository to optionally fetch from
919
:param revno: Revision number of the new tip
920
:param revid: Revision id of the new tip
922
if not self.repository.has_same_location(source_repo):
923
self.repository.fetch(source_repo, revision_id=revid)
924
self.set_last_revision_info(revno, revid)
926
def revision_id_to_revno(self, revision_id):
927
"""Given a revision id, return its revno"""
928
if _mod_revision.is_null(revision_id):
930
history = self.revision_history()
932
return history.index(revision_id) + 1
934
raise errors.NoSuchRevision(self, revision_id)
937
def get_rev_id(self, revno, history=None):
938
"""Find the revision id of the specified revno."""
940
return _mod_revision.NULL_REVISION
941
last_revno, last_revid = self.last_revision_info()
942
if revno == last_revno:
944
if revno <= 0 or revno > last_revno:
945
raise errors.NoSuchRevision(self, revno)
946
distance_from_last = last_revno - revno
947
if len(self._partial_revision_history_cache) <= distance_from_last:
948
self._extend_partial_history(distance_from_last)
949
return self._partial_revision_history_cache[distance_from_last]
952
def pull(self, source, overwrite=False, stop_revision=None,
953
possible_transports=None, *args, **kwargs):
954
"""Mirror source into this branch.
956
This branch is considered to be 'local', having low latency.
958
:returns: PullResult instance
960
return InterBranch.get(source, self).pull(overwrite=overwrite,
961
stop_revision=stop_revision,
962
possible_transports=possible_transports, *args, **kwargs)
964
def push(self, target, overwrite=False, stop_revision=None, *args,
966
"""Mirror this branch into target.
968
This branch is considered to be 'local', having low latency.
970
return InterBranch.get(self, target).push(overwrite, stop_revision,
973
def lossy_push(self, target, stop_revision=None):
974
"""Push deltas into another branch.
976
:note: This does not, like push, retain the revision ids from
977
the source branch and will, rather than adding bzr-specific
978
metadata, push only those semantics of the revision that can be
979
natively represented by this branch' VCS.
981
:param target: Target branch
982
:param stop_revision: Revision to push, defaults to last revision.
983
:return: BranchPushResult with an extra member revidmap:
984
A dictionary mapping revision ids from the target branch
985
to new revision ids in the target branch, for each
986
revision that was pushed.
988
inter = InterBranch.get(self, target)
989
lossy_push = getattr(inter, "lossy_push", None)
990
if lossy_push is None:
991
raise errors.LossyPushToSameVCS(self, target)
992
return lossy_push(stop_revision)
994
def basis_tree(self):
995
"""Return `Tree` object for last revision."""
996
return self.repository.revision_tree(self.last_revision())
998
def get_parent(self):
999
"""Return the parent location of the branch.
1001
This is the default location for pull/missing. The usual
1002
pattern is that the user can override it by specifying a
1005
parent = self._get_parent_location()
1008
# This is an old-format absolute path to a local branch
1009
# turn it into a url
1010
if parent.startswith('/'):
1011
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1013
return urlutils.join(self.base[:-1], parent)
1014
except errors.InvalidURLJoin, e:
1015
raise errors.InaccessibleParent(parent, self.base)
1017
def _get_parent_location(self):
1018
raise NotImplementedError(self._get_parent_location)
1020
def _set_config_location(self, name, url, config=None,
1021
make_relative=False):
1023
config = self.get_config()
1027
url = urlutils.relative_url(self.base, url)
1028
config.set_user_option(name, url, warn_masked=True)
1030
def _get_config_location(self, name, config=None):
1032
config = self.get_config()
1033
location = config.get_user_option(name)
1038
def get_child_submit_format(self):
1039
"""Return the preferred format of submissions to this branch."""
1040
return self.get_config().get_user_option("child_submit_format")
1042
def get_submit_branch(self):
1043
"""Return the submit location of the branch.
1045
This is the default location for bundle. The usual
1046
pattern is that the user can override it by specifying a
1049
return self.get_config().get_user_option('submit_branch')
1051
def set_submit_branch(self, location):
1052
"""Return the submit location of the branch.
1054
This is the default location for bundle. The usual
1055
pattern is that the user can override it by specifying a
1058
self.get_config().set_user_option('submit_branch', location,
1061
def get_public_branch(self):
1062
"""Return the public location of the branch.
1064
This is used by merge directives.
1066
return self._get_config_location('public_branch')
1068
def set_public_branch(self, location):
1069
"""Return the submit location of the branch.
1071
This is the default location for bundle. The usual
1072
pattern is that the user can override it by specifying a
1075
self._set_config_location('public_branch', location)
1077
def get_push_location(self):
1078
"""Return the None or the location to push this branch to."""
1079
push_loc = self.get_config().get_user_option('push_location')
1082
def set_push_location(self, location):
1083
"""Set a new push location for this branch."""
1084
raise NotImplementedError(self.set_push_location)
1086
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1087
"""Run the post_change_branch_tip hooks."""
1088
hooks = Branch.hooks['post_change_branch_tip']
1091
new_revno, new_revid = self.last_revision_info()
1092
params = ChangeBranchTipParams(
1093
self, old_revno, new_revno, old_revid, new_revid)
1097
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1098
"""Run the pre_change_branch_tip hooks."""
1099
hooks = Branch.hooks['pre_change_branch_tip']
1102
old_revno, old_revid = self.last_revision_info()
1103
params = ChangeBranchTipParams(
1104
self, old_revno, new_revno, old_revid, new_revid)
1108
except errors.TipChangeRejected:
1111
exc_info = sys.exc_info()
1112
hook_name = Branch.hooks.get_hook_name(hook)
1113
raise errors.HookFailed(
1114
'pre_change_branch_tip', hook_name, exc_info)
1118
"""Synchronise this branch with the master branch if any.
1120
:return: None or the last_revision pivoted out during the update.
1124
def check_revno(self, revno):
1126
Check whether a revno corresponds to any revision.
1127
Zero (the NULL revision) is considered valid.
1130
self.check_real_revno(revno)
1132
def check_real_revno(self, revno):
1134
Check whether a revno corresponds to a real revision.
1135
Zero (the NULL revision) is considered invalid
1137
if revno < 1 or revno > self.revno():
1138
raise errors.InvalidRevisionNumber(revno)
1141
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1142
"""Clone this branch into to_bzrdir preserving all semantic values.
1144
Most API users will want 'create_clone_on_transport', which creates a
1145
new bzrdir and branch on the fly.
1147
revision_id: if not None, the revision history in the new branch will
1148
be truncated to end with revision_id.
1150
result = to_bzrdir.create_branch()
1153
if repository_policy is not None:
1154
repository_policy.configure_branch(result)
1155
self.copy_content_into(result, revision_id=revision_id)
1161
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1162
"""Create a new line of development from the branch, into to_bzrdir.
1164
to_bzrdir controls the branch format.
1166
revision_id: if not None, the revision history in the new branch will
1167
be truncated to end with revision_id.
1169
if (repository_policy is not None and
1170
repository_policy.requires_stacking()):
1171
to_bzrdir._format.require_stacking(_skip_repo=True)
1172
result = to_bzrdir.create_branch()
1175
if repository_policy is not None:
1176
repository_policy.configure_branch(result)
1177
self.copy_content_into(result, revision_id=revision_id)
1178
result.set_parent(self.bzrdir.root_transport.base)
1183
def _synchronize_history(self, destination, revision_id):
1184
"""Synchronize last revision and revision history between branches.
1186
This version is most efficient when the destination is also a
1187
BzrBranch6, but works for BzrBranch5, as long as the destination's
1188
repository contains all the lefthand ancestors of the intended
1189
last_revision. If not, set_last_revision_info will fail.
1191
:param destination: The branch to copy the history into
1192
:param revision_id: The revision-id to truncate history at. May
1193
be None to copy complete history.
1195
source_revno, source_revision_id = self.last_revision_info()
1196
if revision_id is None:
1197
revno, revision_id = source_revno, source_revision_id
1199
graph = self.repository.get_graph()
1201
revno = graph.find_distance_to_null(revision_id,
1202
[(source_revision_id, source_revno)])
1203
except errors.GhostRevisionsHaveNoRevno:
1204
# Default to 1, if we can't find anything else
1206
destination.set_last_revision_info(revno, revision_id)
1209
def copy_content_into(self, destination, revision_id=None):
1210
"""Copy the content of self into destination.
1212
revision_id: if not None, the revision history in the new branch will
1213
be truncated to end with revision_id.
1215
self.update_references(destination)
1216
self._synchronize_history(destination, revision_id)
1218
parent = self.get_parent()
1219
except errors.InaccessibleParent, e:
1220
mutter('parent was not accessible to copy: %s', e)
1223
destination.set_parent(parent)
1224
if self._push_should_merge_tags():
1225
self.tags.merge_to(destination.tags)
1227
def update_references(self, target):
1228
if not getattr(self._format, 'supports_reference_locations', False):
1230
reference_dict = self._get_all_reference_info()
1231
if len(reference_dict) == 0:
1233
old_base = self.base
1234
new_base = target.base
1235
target_reference_dict = target._get_all_reference_info()
1236
for file_id, (tree_path, branch_location) in (
1237
reference_dict.items()):
1238
branch_location = urlutils.rebase_url(branch_location,
1240
target_reference_dict.setdefault(
1241
file_id, (tree_path, branch_location))
1242
target._set_all_reference_info(target_reference_dict)
1245
def check(self, refs):
1246
"""Check consistency of the branch.
1248
In particular this checks that revisions given in the revision-history
1249
do actually match up in the revision graph, and that they're all
1250
present in the repository.
1252
Callers will typically also want to check the repository.
1254
:param refs: Calculated refs for this branch as specified by
1255
branch._get_check_refs()
1256
:return: A BranchCheckResult.
1258
result = BranchCheckResult(self)
1259
last_revno, last_revision_id = self.last_revision_info()
1260
actual_revno = refs[('lefthand-distance', last_revision_id)]
1261
if actual_revno != last_revno:
1262
result.errors.append(errors.BzrCheckError(
1263
'revno does not match len(mainline) %s != %s' % (
1264
last_revno, actual_revno)))
1265
# TODO: We should probably also check that self.revision_history
1266
# matches the repository for older branch formats.
1267
# If looking for the code that cross-checks repository parents against
1268
# the iter_reverse_revision_history output, that is now a repository
1272
def _get_checkout_format(self):
1273
"""Return the most suitable metadir for a checkout of this branch.
1274
Weaves are used if this branch's repository uses weaves.
1276
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1277
from bzrlib.repofmt import weaverepo
1278
format = bzrdir.BzrDirMetaFormat1()
1279
format.repository_format = weaverepo.RepositoryFormat7()
1281
format = self.repository.bzrdir.checkout_metadir()
1282
format.set_branch_format(self._format)
1285
def create_clone_on_transport(self, to_transport, revision_id=None,
1286
stacked_on=None, create_prefix=False, use_existing_dir=False):
1287
"""Create a clone of this branch and its bzrdir.
1289
:param to_transport: The transport to clone onto.
1290
:param revision_id: The revision id to use as tip in the new branch.
1291
If None the tip is obtained from this branch.
1292
:param stacked_on: An optional URL to stack the clone on.
1293
:param create_prefix: Create any missing directories leading up to
1295
:param use_existing_dir: Use an existing directory if one exists.
1297
# XXX: Fix the bzrdir API to allow getting the branch back from the
1298
# clone call. Or something. 20090224 RBC/spiv.
1299
if revision_id is None:
1300
revision_id = self.last_revision()
1301
dir_to = self.bzrdir.clone_on_transport(to_transport,
1302
revision_id=revision_id, stacked_on=stacked_on,
1303
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1304
return dir_to.open_branch()
1306
def create_checkout(self, to_location, revision_id=None,
1307
lightweight=False, accelerator_tree=None,
1309
"""Create a checkout of a branch.
1311
:param to_location: The url to produce the checkout at
1312
:param revision_id: The revision to check out
1313
:param lightweight: If True, produce a lightweight checkout, otherwise,
1314
produce a bound branch (heavyweight checkout)
1315
:param accelerator_tree: A tree which can be used for retrieving file
1316
contents more quickly than the revision tree, i.e. a workingtree.
1317
The revision tree will be used for cases where accelerator_tree's
1318
content is different.
1319
:param hardlink: If true, hard-link files from accelerator_tree,
1321
:return: The tree of the created checkout
1323
t = transport.get_transport(to_location)
1326
format = self._get_checkout_format()
1327
checkout = format.initialize_on_transport(t)
1328
from_branch = BranchReferenceFormat().initialize(checkout, self)
1330
format = self._get_checkout_format()
1331
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1332
to_location, force_new_tree=False, format=format)
1333
checkout = checkout_branch.bzrdir
1334
checkout_branch.bind(self)
1335
# pull up to the specified revision_id to set the initial
1336
# branch tip correctly, and seed it with history.
1337
checkout_branch.pull(self, stop_revision=revision_id)
1339
tree = checkout.create_workingtree(revision_id,
1340
from_branch=from_branch,
1341
accelerator_tree=accelerator_tree,
1343
basis_tree = tree.basis_tree()
1344
basis_tree.lock_read()
1346
for path, file_id in basis_tree.iter_references():
1347
reference_parent = self.reference_parent(file_id, path)
1348
reference_parent.create_checkout(tree.abspath(path),
1349
basis_tree.get_reference_revision(file_id, path),
1356
def reconcile(self, thorough=True):
1357
"""Make sure the data stored in this branch is consistent."""
1358
from bzrlib.reconcile import BranchReconciler
1359
reconciler = BranchReconciler(self, thorough=thorough)
1360
reconciler.reconcile()
1363
def reference_parent(self, file_id, path, possible_transports=None):
1364
"""Return the parent branch for a tree-reference file_id
1365
:param file_id: The file_id of the tree reference
1366
:param path: The path of the file_id in the tree
1367
:return: A branch associated with the file_id
1369
# FIXME should provide multiple branches, based on config
1370
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1371
possible_transports=possible_transports)
1373
def supports_tags(self):
1374
return self._format.supports_tags()
1376
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1378
"""Ensure that revision_b is a descendant of revision_a.
1380
This is a helper function for update_revisions.
1382
:raises: DivergedBranches if revision_b has diverged from revision_a.
1383
:returns: True if revision_b is a descendant of revision_a.
1385
relation = self._revision_relations(revision_a, revision_b, graph)
1386
if relation == 'b_descends_from_a':
1388
elif relation == 'diverged':
1389
raise errors.DivergedBranches(self, other_branch)
1390
elif relation == 'a_descends_from_b':
1393
raise AssertionError("invalid relation: %r" % (relation,))
1395
def _revision_relations(self, revision_a, revision_b, graph):
1396
"""Determine the relationship between two revisions.
1398
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1400
heads = graph.heads([revision_a, revision_b])
1401
if heads == set([revision_b]):
1402
return 'b_descends_from_a'
1403
elif heads == set([revision_a, revision_b]):
1404
# These branches have diverged
1406
elif heads == set([revision_a]):
1407
return 'a_descends_from_b'
1409
raise AssertionError("invalid heads: %r" % (heads,))
1412
class BranchFormat(object):
1413
"""An encapsulation of the initialization and open routines for a format.
1415
Formats provide three things:
1416
* An initialization routine,
1420
Formats are placed in an dict by their format string for reference
1421
during branch opening. Its not required that these be instances, they
1422
can be classes themselves with class methods - it simply depends on
1423
whether state is needed for a given format or not.
1425
Once a format is deprecated, just deprecate the initialize and open
1426
methods on the format class. Do not deprecate the object, as the
1427
object will be created every time regardless.
1430
_default_format = None
1431
"""The default format used for new branches."""
1434
"""The known formats."""
1436
can_set_append_revisions_only = True
1438
def __eq__(self, other):
1439
return self.__class__ is other.__class__
1441
def __ne__(self, other):
1442
return not (self == other)
1445
def find_format(klass, a_bzrdir):
1446
"""Return the format for the branch object in a_bzrdir."""
1448
transport = a_bzrdir.get_branch_transport(None)
1449
format_string = transport.get_bytes("format")
1450
return klass._formats[format_string]
1451
except errors.NoSuchFile:
1452
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1454
raise errors.UnknownFormatError(format=format_string, kind='branch')
1457
def get_default_format(klass):
1458
"""Return the current default format."""
1459
return klass._default_format
1461
def get_reference(self, a_bzrdir):
1462
"""Get the target reference of the branch in a_bzrdir.
1464
format probing must have been completed before calling
1465
this method - it is assumed that the format of the branch
1466
in a_bzrdir is correct.
1468
:param a_bzrdir: The bzrdir to get the branch data from.
1469
:return: None if the branch is not a reference branch.
1474
def set_reference(self, a_bzrdir, to_branch):
1475
"""Set the target reference of the branch in a_bzrdir.
1477
format probing must have been completed before calling
1478
this method - it is assumed that the format of the branch
1479
in a_bzrdir is correct.
1481
:param a_bzrdir: The bzrdir to set the branch reference for.
1482
:param to_branch: branch that the checkout is to reference
1484
raise NotImplementedError(self.set_reference)
1486
def get_format_string(self):
1487
"""Return the ASCII format string that identifies this format."""
1488
raise NotImplementedError(self.get_format_string)
1490
def get_format_description(self):
1491
"""Return the short format description for this format."""
1492
raise NotImplementedError(self.get_format_description)
1494
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1496
"""Initialize a branch in a bzrdir, with specified files
1498
:param a_bzrdir: The bzrdir to initialize the branch in
1499
:param utf8_files: The files to create as a list of
1500
(filename, content) tuples
1501
:param set_format: If True, set the format with
1502
self.get_format_string. (BzrBranch4 has its format set
1504
:return: a branch in this format
1506
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1507
branch_transport = a_bzrdir.get_branch_transport(self)
1509
'metadir': ('lock', lockdir.LockDir),
1510
'branch4': ('branch-lock', lockable_files.TransportLock),
1512
lock_name, lock_class = lock_map[lock_type]
1513
control_files = lockable_files.LockableFiles(branch_transport,
1514
lock_name, lock_class)
1515
control_files.create_lock()
1517
control_files.lock_write()
1518
except errors.LockContention:
1519
if lock_type != 'branch4':
1525
utf8_files += [('format', self.get_format_string())]
1527
for (filename, content) in utf8_files:
1528
branch_transport.put_bytes(
1530
mode=a_bzrdir._get_file_mode())
1533
control_files.unlock()
1534
return self.open(a_bzrdir, _found=True)
1536
def initialize(self, a_bzrdir):
1537
"""Create a branch of this format in a_bzrdir."""
1538
raise NotImplementedError(self.initialize)
1540
def is_supported(self):
1541
"""Is this format supported?
1543
Supported formats can be initialized and opened.
1544
Unsupported formats may not support initialization or committing or
1545
some other features depending on the reason for not being supported.
1549
def make_tags(self, branch):
1550
"""Create a tags object for branch.
1552
This method is on BranchFormat, because BranchFormats are reflected
1553
over the wire via network_name(), whereas full Branch instances require
1554
multiple VFS method calls to operate at all.
1556
The default implementation returns a disabled-tags instance.
1558
Note that it is normal for branch to be a RemoteBranch when using tags
1561
return DisabledTags(branch)
1563
def network_name(self):
1564
"""A simple byte string uniquely identifying this format for RPC calls.
1566
MetaDir branch formats use their disk format string to identify the
1567
repository over the wire. All in one formats such as bzr < 0.8, and
1568
foreign formats like svn/git and hg should use some marker which is
1569
unique and immutable.
1571
raise NotImplementedError(self.network_name)
1573
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1574
"""Return the branch object for a_bzrdir
1576
:param a_bzrdir: A BzrDir that contains a branch.
1577
:param _found: a private parameter, do not use it. It is used to
1578
indicate if format probing has already be done.
1579
:param ignore_fallbacks: when set, no fallback branches will be opened
1580
(if there are any). Default is to open fallbacks.
1582
raise NotImplementedError(self.open)
1585
def register_format(klass, format):
1586
"""Register a metadir format."""
1587
klass._formats[format.get_format_string()] = format
1588
# Metadir formats have a network name of their format string, and get
1589
# registered as class factories.
1590
network_format_registry.register(format.get_format_string(), format.__class__)
1593
def set_default_format(klass, format):
1594
klass._default_format = format
1596
def supports_set_append_revisions_only(self):
1597
"""True if this format supports set_append_revisions_only."""
1600
def supports_stacking(self):
1601
"""True if this format records a stacked-on branch."""
1605
def unregister_format(klass, format):
1606
del klass._formats[format.get_format_string()]
1609
return self.get_format_description().rstrip()
1611
def supports_tags(self):
1612
"""True if this format supports tags stored in the branch"""
1613
return False # by default
1616
class BranchHooks(Hooks):
1617
"""A dictionary mapping hook name to a list of callables for branch hooks.
1619
e.g. ['set_rh'] Is the list of items to be called when the
1620
set_revision_history function is invoked.
1624
"""Create the default hooks.
1626
These are all empty initially, because by default nothing should get
1629
Hooks.__init__(self)
1630
self.create_hook(HookPoint('set_rh',
1631
"Invoked whenever the revision history has been set via "
1632
"set_revision_history. The api signature is (branch, "
1633
"revision_history), and the branch will be write-locked. "
1634
"The set_rh hook can be expensive for bzr to trigger, a better "
1635
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1636
self.create_hook(HookPoint('open',
1637
"Called with the Branch object that has been opened after a "
1638
"branch is opened.", (1, 8), None))
1639
self.create_hook(HookPoint('post_push',
1640
"Called after a push operation completes. post_push is called "
1641
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1642
"bzr client.", (0, 15), None))
1643
self.create_hook(HookPoint('post_pull',
1644
"Called after a pull operation completes. post_pull is called "
1645
"with a bzrlib.branch.PullResult object and only runs in the "
1646
"bzr client.", (0, 15), None))
1647
self.create_hook(HookPoint('pre_commit',
1648
"Called after a commit is calculated but before it is is "
1649
"completed. pre_commit is called with (local, master, old_revno, "
1650
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1651
"). old_revid is NULL_REVISION for the first commit to a branch, "
1652
"tree_delta is a TreeDelta object describing changes from the "
1653
"basis revision. hooks MUST NOT modify this delta. "
1654
" future_tree is an in-memory tree obtained from "
1655
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1656
"tree.", (0,91), None))
1657
self.create_hook(HookPoint('post_commit',
1658
"Called in the bzr client after a commit has completed. "
1659
"post_commit is called with (local, master, old_revno, old_revid, "
1660
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1661
"commit to a branch.", (0, 15), None))
1662
self.create_hook(HookPoint('post_uncommit',
1663
"Called in the bzr client after an uncommit completes. "
1664
"post_uncommit is called with (local, master, old_revno, "
1665
"old_revid, new_revno, new_revid) where local is the local branch "
1666
"or None, master is the target branch, and an empty branch "
1667
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1668
self.create_hook(HookPoint('pre_change_branch_tip',
1669
"Called in bzr client and server before a change to the tip of a "
1670
"branch is made. pre_change_branch_tip is called with a "
1671
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1672
"commit, uncommit will all trigger this hook.", (1, 6), None))
1673
self.create_hook(HookPoint('post_change_branch_tip',
1674
"Called in bzr client and server after a change to the tip of a "
1675
"branch is made. post_change_branch_tip is called with a "
1676
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1677
"commit, uncommit will all trigger this hook.", (1, 4), None))
1678
self.create_hook(HookPoint('transform_fallback_location',
1679
"Called when a stacked branch is activating its fallback "
1680
"locations. transform_fallback_location is called with (branch, "
1681
"url), and should return a new url. Returning the same url "
1682
"allows it to be used as-is, returning a different one can be "
1683
"used to cause the branch to stack on a closer copy of that "
1684
"fallback_location. Note that the branch cannot have history "
1685
"accessing methods called on it during this hook because the "
1686
"fallback locations have not been activated. When there are "
1687
"multiple hooks installed for transform_fallback_location, "
1688
"all are called with the url returned from the previous hook."
1689
"The order is however undefined.", (1, 9), None))
1692
# install the default hooks into the Branch class.
1693
Branch.hooks = BranchHooks()
1696
class ChangeBranchTipParams(object):
1697
"""Object holding parameters passed to *_change_branch_tip hooks.
1699
There are 5 fields that hooks may wish to access:
1701
:ivar branch: the branch being changed
1702
:ivar old_revno: revision number before the change
1703
:ivar new_revno: revision number after the change
1704
:ivar old_revid: revision id before the change
1705
:ivar new_revid: revision id after the change
1707
The revid fields are strings. The revno fields are integers.
1710
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1711
"""Create a group of ChangeBranchTip parameters.
1713
:param branch: The branch being changed.
1714
:param old_revno: Revision number before the change.
1715
:param new_revno: Revision number after the change.
1716
:param old_revid: Tip revision id before the change.
1717
:param new_revid: Tip revision id after the change.
1719
self.branch = branch
1720
self.old_revno = old_revno
1721
self.new_revno = new_revno
1722
self.old_revid = old_revid
1723
self.new_revid = new_revid
1725
def __eq__(self, other):
1726
return self.__dict__ == other.__dict__
1729
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1730
self.__class__.__name__, self.branch,
1731
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1734
class BzrBranchFormat4(BranchFormat):
1735
"""Bzr branch format 4.
1738
- a revision-history file.
1739
- a branch-lock lock file [ to be shared with the bzrdir ]
1742
def get_format_description(self):
1743
"""See BranchFormat.get_format_description()."""
1744
return "Branch format 4"
1746
def initialize(self, a_bzrdir):
1747
"""Create a branch of this format in a_bzrdir."""
1748
utf8_files = [('revision-history', ''),
1749
('branch-name', ''),
1751
return self._initialize_helper(a_bzrdir, utf8_files,
1752
lock_type='branch4', set_format=False)
1755
super(BzrBranchFormat4, self).__init__()
1756
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1758
def network_name(self):
1759
"""The network name for this format is the control dirs disk label."""
1760
return self._matchingbzrdir.get_format_string()
1762
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1763
"""See BranchFormat.open()."""
1765
# we are being called directly and must probe.
1766
raise NotImplementedError
1767
return BzrBranch(_format=self,
1768
_control_files=a_bzrdir._control_files,
1770
_repository=a_bzrdir.open_repository())
1773
return "Bazaar-NG branch format 4"
1776
class BranchFormatMetadir(BranchFormat):
1777
"""Common logic for meta-dir based branch formats."""
1779
def _branch_class(self):
1780
"""What class to instantiate on open calls."""
1781
raise NotImplementedError(self._branch_class)
1783
def network_name(self):
1784
"""A simple byte string uniquely identifying this format for RPC calls.
1786
Metadir branch formats use their format string.
1788
return self.get_format_string()
1790
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1791
"""See BranchFormat.open()."""
1793
format = BranchFormat.find_format(a_bzrdir)
1794
if format.__class__ != self.__class__:
1795
raise AssertionError("wrong format %r found for %r" %
1798
transport = a_bzrdir.get_branch_transport(None)
1799
control_files = lockable_files.LockableFiles(transport, 'lock',
1801
return self._branch_class()(_format=self,
1802
_control_files=control_files,
1804
_repository=a_bzrdir.find_repository(),
1805
ignore_fallbacks=ignore_fallbacks)
1806
except errors.NoSuchFile:
1807
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1810
super(BranchFormatMetadir, self).__init__()
1811
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1812
self._matchingbzrdir.set_branch_format(self)
1814
def supports_tags(self):
1818
class BzrBranchFormat5(BranchFormatMetadir):
1819
"""Bzr branch format 5.
1822
- a revision-history file.
1824
- a lock dir guarding the branch itself
1825
- all of this stored in a branch/ subdirectory
1826
- works with shared repositories.
1828
This format is new in bzr 0.8.
1831
def _branch_class(self):
1834
def get_format_string(self):
1835
"""See BranchFormat.get_format_string()."""
1836
return "Bazaar-NG branch format 5\n"
1838
def get_format_description(self):
1839
"""See BranchFormat.get_format_description()."""
1840
return "Branch format 5"
1842
def initialize(self, a_bzrdir):
1843
"""Create a branch of this format in a_bzrdir."""
1844
utf8_files = [('revision-history', ''),
1845
('branch-name', ''),
1847
return self._initialize_helper(a_bzrdir, utf8_files)
1849
def supports_tags(self):
1853
class BzrBranchFormat6(BranchFormatMetadir):
1854
"""Branch format with last-revision and tags.
1856
Unlike previous formats, this has no explicit revision history. Instead,
1857
this just stores the last-revision, and the left-hand history leading
1858
up to there is the history.
1860
This format was introduced in bzr 0.15
1861
and became the default in 0.91.
1864
def _branch_class(self):
1867
def get_format_string(self):
1868
"""See BranchFormat.get_format_string()."""
1869
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1871
def get_format_description(self):
1872
"""See BranchFormat.get_format_description()."""
1873
return "Branch format 6"
1875
def initialize(self, a_bzrdir):
1876
"""Create a branch of this format in a_bzrdir."""
1877
utf8_files = [('last-revision', '0 null:\n'),
1878
('branch.conf', ''),
1881
return self._initialize_helper(a_bzrdir, utf8_files)
1883
def make_tags(self, branch):
1884
"""See bzrlib.branch.BranchFormat.make_tags()."""
1885
return BasicTags(branch)
1887
def supports_set_append_revisions_only(self):
1891
class BzrBranchFormat8(BranchFormatMetadir):
1892
"""Metadir format supporting storing locations of subtree branches."""
1894
def _branch_class(self):
1897
def get_format_string(self):
1898
"""See BranchFormat.get_format_string()."""
1899
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1901
def get_format_description(self):
1902
"""See BranchFormat.get_format_description()."""
1903
return "Branch format 8"
1905
def initialize(self, a_bzrdir):
1906
"""Create a branch of this format in a_bzrdir."""
1907
utf8_files = [('last-revision', '0 null:\n'),
1908
('branch.conf', ''),
1912
return self._initialize_helper(a_bzrdir, utf8_files)
1915
super(BzrBranchFormat8, self).__init__()
1916
self._matchingbzrdir.repository_format = \
1917
RepositoryFormatKnitPack5RichRoot()
1919
def make_tags(self, branch):
1920
"""See bzrlib.branch.BranchFormat.make_tags()."""
1921
return BasicTags(branch)
1923
def supports_set_append_revisions_only(self):
1926
def supports_stacking(self):
1929
supports_reference_locations = True
1932
class BzrBranchFormat7(BzrBranchFormat8):
1933
"""Branch format with last-revision, tags, and a stacked location pointer.
1935
The stacked location pointer is passed down to the repository and requires
1936
a repository format with supports_external_lookups = True.
1938
This format was introduced in bzr 1.6.
1941
def initialize(self, a_bzrdir):
1942
"""Create a branch of this format in a_bzrdir."""
1943
utf8_files = [('last-revision', '0 null:\n'),
1944
('branch.conf', ''),
1947
return self._initialize_helper(a_bzrdir, utf8_files)
1949
def _branch_class(self):
1952
def get_format_string(self):
1953
"""See BranchFormat.get_format_string()."""
1954
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1956
def get_format_description(self):
1957
"""See BranchFormat.get_format_description()."""
1958
return "Branch format 7"
1960
def supports_set_append_revisions_only(self):
1963
supports_reference_locations = False
1966
class BranchReferenceFormat(BranchFormat):
1967
"""Bzr branch reference format.
1969
Branch references are used in implementing checkouts, they
1970
act as an alias to the real branch which is at some other url.
1977
def get_format_string(self):
1978
"""See BranchFormat.get_format_string()."""
1979
return "Bazaar-NG Branch Reference Format 1\n"
1981
def get_format_description(self):
1982
"""See BranchFormat.get_format_description()."""
1983
return "Checkout reference format 1"
1985
def get_reference(self, a_bzrdir):
1986
"""See BranchFormat.get_reference()."""
1987
transport = a_bzrdir.get_branch_transport(None)
1988
return transport.get_bytes('location')
1990
def set_reference(self, a_bzrdir, to_branch):
1991
"""See BranchFormat.set_reference()."""
1992
transport = a_bzrdir.get_branch_transport(None)
1993
location = transport.put_bytes('location', to_branch.base)
1995
def initialize(self, a_bzrdir, target_branch=None):
1996
"""Create a branch of this format in a_bzrdir."""
1997
if target_branch is None:
1998
# this format does not implement branch itself, thus the implicit
1999
# creation contract must see it as uninitializable
2000
raise errors.UninitializableFormat(self)
2001
mutter('creating branch reference in %s', a_bzrdir.transport.base)
2002
branch_transport = a_bzrdir.get_branch_transport(self)
2003
branch_transport.put_bytes('location',
2004
target_branch.bzrdir.root_transport.base)
2005
branch_transport.put_bytes('format', self.get_format_string())
2007
a_bzrdir, _found=True,
2008
possible_transports=[target_branch.bzrdir.root_transport])
2011
super(BranchReferenceFormat, self).__init__()
2012
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2013
self._matchingbzrdir.set_branch_format(self)
2015
def _make_reference_clone_function(format, a_branch):
2016
"""Create a clone() routine for a branch dynamically."""
2017
def clone(to_bzrdir, revision_id=None,
2018
repository_policy=None):
2019
"""See Branch.clone()."""
2020
return format.initialize(to_bzrdir, a_branch)
2021
# cannot obey revision_id limits when cloning a reference ...
2022
# FIXME RBC 20060210 either nuke revision_id for clone, or
2023
# emit some sort of warning/error to the caller ?!
2026
def open(self, a_bzrdir, _found=False, location=None,
2027
possible_transports=None, ignore_fallbacks=False):
2028
"""Return the branch that the branch reference in a_bzrdir points at.
2030
:param a_bzrdir: A BzrDir that contains a branch.
2031
:param _found: a private parameter, do not use it. It is used to
2032
indicate if format probing has already be done.
2033
:param ignore_fallbacks: when set, no fallback branches will be opened
2034
(if there are any). Default is to open fallbacks.
2035
:param location: The location of the referenced branch. If
2036
unspecified, this will be determined from the branch reference in
2038
:param possible_transports: An optional reusable transports list.
2041
format = BranchFormat.find_format(a_bzrdir)
2042
if format.__class__ != self.__class__:
2043
raise AssertionError("wrong format %r found for %r" %
2045
if location is None:
2046
location = self.get_reference(a_bzrdir)
2047
real_bzrdir = bzrdir.BzrDir.open(
2048
location, possible_transports=possible_transports)
2049
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2050
# this changes the behaviour of result.clone to create a new reference
2051
# rather than a copy of the content of the branch.
2052
# I did not use a proxy object because that needs much more extensive
2053
# testing, and we are only changing one behaviour at the moment.
2054
# If we decide to alter more behaviours - i.e. the implicit nickname
2055
# then this should be refactored to introduce a tested proxy branch
2056
# and a subclass of that for use in overriding clone() and ....
2058
result.clone = self._make_reference_clone_function(result)
2062
network_format_registry = registry.FormatRegistry()
2063
"""Registry of formats indexed by their network name.
2065
The network name for a branch format is an identifier that can be used when
2066
referring to formats with smart server operations. See
2067
BranchFormat.network_name() for more detail.
2071
# formats which have no format string are not discoverable
2072
# and not independently creatable, so are not registered.
2073
__format5 = BzrBranchFormat5()
2074
__format6 = BzrBranchFormat6()
2075
__format7 = BzrBranchFormat7()
2076
__format8 = BzrBranchFormat8()
2077
BranchFormat.register_format(__format5)
2078
BranchFormat.register_format(BranchReferenceFormat())
2079
BranchFormat.register_format(__format6)
2080
BranchFormat.register_format(__format7)
2081
BranchFormat.register_format(__format8)
2082
BranchFormat.set_default_format(__format7)
2083
_legacy_formats = [BzrBranchFormat4(),
2085
network_format_registry.register(
2086
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2089
class BzrBranch(Branch, _RelockDebugMixin):
2090
"""A branch stored in the actual filesystem.
2092
Note that it's "local" in the context of the filesystem; it doesn't
2093
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2094
it's writable, and can be accessed via the normal filesystem API.
2096
:ivar _transport: Transport for file operations on this branch's
2097
control files, typically pointing to the .bzr/branch directory.
2098
:ivar repository: Repository for this branch.
2099
:ivar base: The url of the base directory for this branch; the one
2100
containing the .bzr directory.
2103
def __init__(self, _format=None,
2104
_control_files=None, a_bzrdir=None, _repository=None,
2105
ignore_fallbacks=False):
2106
"""Create new branch object at a particular location."""
2107
if a_bzrdir is None:
2108
raise ValueError('a_bzrdir must be supplied')
2110
self.bzrdir = a_bzrdir
2111
self._base = self.bzrdir.transport.clone('..').base
2112
# XXX: We should be able to just do
2113
# self.base = self.bzrdir.root_transport.base
2114
# but this does not quite work yet -- mbp 20080522
2115
self._format = _format
2116
if _control_files is None:
2117
raise ValueError('BzrBranch _control_files is None')
2118
self.control_files = _control_files
2119
self._transport = _control_files._transport
2120
self.repository = _repository
2121
Branch.__init__(self)
2124
return '%s(%r)' % (self.__class__.__name__, self.base)
2128
def _get_base(self):
2129
"""Returns the directory containing the control directory."""
2132
base = property(_get_base, doc="The URL for the root of this branch.")
2134
def _get_config(self):
2135
return TransportConfig(self._transport, 'branch.conf')
2137
def is_locked(self):
2138
return self.control_files.is_locked()
2140
def lock_write(self, token=None):
2141
if not self.is_locked():
2142
self._note_lock('w')
2143
# All-in-one needs to always unlock/lock.
2144
repo_control = getattr(self.repository, 'control_files', None)
2145
if self.control_files == repo_control or not self.is_locked():
2146
self.repository._warn_if_deprecated(self)
2147
self.repository.lock_write()
2152
return self.control_files.lock_write(token=token)
2155
self.repository.unlock()
2158
def lock_read(self):
2159
if not self.is_locked():
2160
self._note_lock('r')
2161
# All-in-one needs to always unlock/lock.
2162
repo_control = getattr(self.repository, 'control_files', None)
2163
if self.control_files == repo_control or not self.is_locked():
2164
self.repository._warn_if_deprecated(self)
2165
self.repository.lock_read()
2170
self.control_files.lock_read()
2173
self.repository.unlock()
2176
@only_raises(errors.LockNotHeld, errors.LockBroken)
2179
self.control_files.unlock()
2181
# All-in-one needs to always unlock/lock.
2182
repo_control = getattr(self.repository, 'control_files', None)
2183
if (self.control_files == repo_control or
2184
not self.control_files.is_locked()):
2185
self.repository.unlock()
2186
if not self.control_files.is_locked():
2187
# we just released the lock
2188
self._clear_cached_state()
2190
def peek_lock_mode(self):
2191
if self.control_files._lock_count == 0:
2194
return self.control_files._lock_mode
2196
def get_physical_lock_status(self):
2197
return self.control_files.get_physical_lock_status()
2200
def print_file(self, file, revision_id):
2201
"""See Branch.print_file."""
2202
return self.repository.print_file(file, revision_id)
2204
def _write_revision_history(self, history):
2205
"""Factored out of set_revision_history.
2207
This performs the actual writing to disk.
2208
It is intended to be called by BzrBranch5.set_revision_history."""
2209
self._transport.put_bytes(
2210
'revision-history', '\n'.join(history),
2211
mode=self.bzrdir._get_file_mode())
2214
def set_revision_history(self, rev_history):
2215
"""See Branch.set_revision_history."""
2216
if 'evil' in debug.debug_flags:
2217
mutter_callsite(3, "set_revision_history scales with history.")
2218
check_not_reserved_id = _mod_revision.check_not_reserved_id
2219
for rev_id in rev_history:
2220
check_not_reserved_id(rev_id)
2221
if Branch.hooks['post_change_branch_tip']:
2222
# Don't calculate the last_revision_info() if there are no hooks
2224
old_revno, old_revid = self.last_revision_info()
2225
if len(rev_history) == 0:
2226
revid = _mod_revision.NULL_REVISION
2228
revid = rev_history[-1]
2229
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2230
self._write_revision_history(rev_history)
2231
self._clear_cached_state()
2232
self._cache_revision_history(rev_history)
2233
for hook in Branch.hooks['set_rh']:
2234
hook(self, rev_history)
2235
if Branch.hooks['post_change_branch_tip']:
2236
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2238
def _synchronize_history(self, destination, revision_id):
2239
"""Synchronize last revision and revision history between branches.
2241
This version is most efficient when the destination is also a
2242
BzrBranch5, but works for BzrBranch6 as long as the revision
2243
history is the true lefthand parent history, and all of the revisions
2244
are in the destination's repository. If not, set_revision_history
2247
:param destination: The branch to copy the history into
2248
:param revision_id: The revision-id to truncate history at. May
2249
be None to copy complete history.
2251
if not isinstance(destination._format, BzrBranchFormat5):
2252
super(BzrBranch, self)._synchronize_history(
2253
destination, revision_id)
2255
if revision_id == _mod_revision.NULL_REVISION:
2258
new_history = self.revision_history()
2259
if revision_id is not None and new_history != []:
2261
new_history = new_history[:new_history.index(revision_id) + 1]
2263
rev = self.repository.get_revision(revision_id)
2264
new_history = rev.get_history(self.repository)[1:]
2265
destination.set_revision_history(new_history)
2268
def set_last_revision_info(self, revno, revision_id):
2269
"""Set the last revision of this branch.
2271
The caller is responsible for checking that the revno is correct
2272
for this revision id.
2274
It may be possible to set the branch last revision to an id not
2275
present in the repository. However, branches can also be
2276
configured to check constraints on history, in which case this may not
2279
revision_id = _mod_revision.ensure_null(revision_id)
2280
# this old format stores the full history, but this api doesn't
2281
# provide it, so we must generate, and might as well check it's
2283
history = self._lefthand_history(revision_id)
2284
if len(history) != revno:
2285
raise AssertionError('%d != %d' % (len(history), revno))
2286
self.set_revision_history(history)
2288
def _gen_revision_history(self):
2289
history = self._transport.get_bytes('revision-history').split('\n')
2290
if history[-1:] == ['']:
2291
# There shouldn't be a trailing newline, but just in case.
2296
def generate_revision_history(self, revision_id, last_rev=None,
2298
"""Create a new revision history that will finish with revision_id.
2300
:param revision_id: the new tip to use.
2301
:param last_rev: The previous last_revision. If not None, then this
2302
must be a ancestory of revision_id, or DivergedBranches is raised.
2303
:param other_branch: The other branch that DivergedBranches should
2304
raise with respect to.
2306
self.set_revision_history(self._lefthand_history(revision_id,
2307
last_rev, other_branch))
2309
def basis_tree(self):
2310
"""See Branch.basis_tree."""
2311
return self.repository.revision_tree(self.last_revision())
2313
def _get_parent_location(self):
2314
_locs = ['parent', 'pull', 'x-pull']
2317
return self._transport.get_bytes(l).strip('\n')
2318
except errors.NoSuchFile:
2322
def _basic_push(self, target, overwrite, stop_revision):
2323
"""Basic implementation of push without bound branches or hooks.
2325
Must be called with source read locked and target write locked.
2327
result = BranchPushResult()
2328
result.source_branch = self
2329
result.target_branch = target
2330
result.old_revno, result.old_revid = target.last_revision_info()
2331
self.update_references(target)
2332
if result.old_revid != self.last_revision():
2333
# We assume that during 'push' this repository is closer than
2335
graph = self.repository.get_graph(target.repository)
2336
target.update_revisions(self, stop_revision,
2337
overwrite=overwrite, graph=graph)
2338
if self._push_should_merge_tags():
2339
result.tag_conflicts = self.tags.merge_to(target.tags,
2341
result.new_revno, result.new_revid = target.last_revision_info()
2344
def get_stacked_on_url(self):
2345
raise errors.UnstackableBranchFormat(self._format, self.base)
2347
def set_push_location(self, location):
2348
"""See Branch.set_push_location."""
2349
self.get_config().set_user_option(
2350
'push_location', location,
2351
store=_mod_config.STORE_LOCATION_NORECURSE)
2353
def _set_parent_location(self, url):
2355
self._transport.delete('parent')
2357
self._transport.put_bytes('parent', url + '\n',
2358
mode=self.bzrdir._get_file_mode())
2361
class BzrBranch5(BzrBranch):
2362
"""A format 5 branch. This supports new features over plain branches.
2364
It has support for a master_branch which is the data for bound branches.
2367
def get_bound_location(self):
2369
return self._transport.get_bytes('bound')[:-1]
2370
except errors.NoSuchFile:
2374
def get_master_branch(self, possible_transports=None):
2375
"""Return the branch we are bound to.
2377
:return: Either a Branch, or None
2379
This could memoise the branch, but if thats done
2380
it must be revalidated on each new lock.
2381
So for now we just don't memoise it.
2382
# RBC 20060304 review this decision.
2384
bound_loc = self.get_bound_location()
2388
return Branch.open(bound_loc,
2389
possible_transports=possible_transports)
2390
except (errors.NotBranchError, errors.ConnectionError), e:
2391
raise errors.BoundBranchConnectionFailure(
2395
def set_bound_location(self, location):
2396
"""Set the target where this branch is bound to.
2398
:param location: URL to the target branch
2401
self._transport.put_bytes('bound', location+'\n',
2402
mode=self.bzrdir._get_file_mode())
2405
self._transport.delete('bound')
2406
except errors.NoSuchFile:
2411
def bind(self, other):
2412
"""Bind this branch to the branch other.
2414
This does not push or pull data between the branches, though it does
2415
check for divergence to raise an error when the branches are not
2416
either the same, or one a prefix of the other. That behaviour may not
2417
be useful, so that check may be removed in future.
2419
:param other: The branch to bind to
2422
# TODO: jam 20051230 Consider checking if the target is bound
2423
# It is debatable whether you should be able to bind to
2424
# a branch which is itself bound.
2425
# Committing is obviously forbidden,
2426
# but binding itself may not be.
2427
# Since we *have* to check at commit time, we don't
2428
# *need* to check here
2430
# we want to raise diverged if:
2431
# last_rev is not in the other_last_rev history, AND
2432
# other_last_rev is not in our history, and do it without pulling
2434
self.set_bound_location(other.base)
2438
"""If bound, unbind"""
2439
return self.set_bound_location(None)
2442
def update(self, possible_transports=None):
2443
"""Synchronise this branch with the master branch if any.
2445
:return: None or the last_revision that was pivoted out during the
2448
master = self.get_master_branch(possible_transports)
2449
if master is not None:
2450
old_tip = _mod_revision.ensure_null(self.last_revision())
2451
self.pull(master, overwrite=True)
2452
if self.repository.get_graph().is_ancestor(old_tip,
2453
_mod_revision.ensure_null(self.last_revision())):
2459
class BzrBranch8(BzrBranch5):
2460
"""A branch that stores tree-reference locations."""
2462
def _open_hook(self):
2463
if self._ignore_fallbacks:
2466
url = self.get_stacked_on_url()
2467
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2468
errors.UnstackableBranchFormat):
2471
for hook in Branch.hooks['transform_fallback_location']:
2472
url = hook(self, url)
2474
hook_name = Branch.hooks.get_hook_name(hook)
2475
raise AssertionError(
2476
"'transform_fallback_location' hook %s returned "
2477
"None, not a URL." % hook_name)
2478
self._activate_fallback_location(url)
2480
def __init__(self, *args, **kwargs):
2481
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2482
super(BzrBranch8, self).__init__(*args, **kwargs)
2483
self._last_revision_info_cache = None
2484
self._reference_info = None
2486
def _clear_cached_state(self):
2487
super(BzrBranch8, self)._clear_cached_state()
2488
self._last_revision_info_cache = None
2489
self._reference_info = None
2491
def _last_revision_info(self):
2492
revision_string = self._transport.get_bytes('last-revision')
2493
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2494
revision_id = cache_utf8.get_cached_utf8(revision_id)
2496
return revno, revision_id
2498
def _write_last_revision_info(self, revno, revision_id):
2499
"""Simply write out the revision id, with no checks.
2501
Use set_last_revision_info to perform this safely.
2503
Does not update the revision_history cache.
2504
Intended to be called by set_last_revision_info and
2505
_write_revision_history.
2507
revision_id = _mod_revision.ensure_null(revision_id)
2508
out_string = '%d %s\n' % (revno, revision_id)
2509
self._transport.put_bytes('last-revision', out_string,
2510
mode=self.bzrdir._get_file_mode())
2513
def set_last_revision_info(self, revno, revision_id):
2514
revision_id = _mod_revision.ensure_null(revision_id)
2515
old_revno, old_revid = self.last_revision_info()
2516
if self._get_append_revisions_only():
2517
self._check_history_violation(revision_id)
2518
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2519
self._write_last_revision_info(revno, revision_id)
2520
self._clear_cached_state()
2521
self._last_revision_info_cache = revno, revision_id
2522
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2524
def _synchronize_history(self, destination, revision_id):
2525
"""Synchronize last revision and revision history between branches.
2527
:see: Branch._synchronize_history
2529
# XXX: The base Branch has a fast implementation of this method based
2530
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2531
# that uses set_revision_history. This class inherits from BzrBranch5,
2532
# but wants the fast implementation, so it calls
2533
# Branch._synchronize_history directly.
2534
Branch._synchronize_history(self, destination, revision_id)
2536
def _check_history_violation(self, revision_id):
2537
last_revision = _mod_revision.ensure_null(self.last_revision())
2538
if _mod_revision.is_null(last_revision):
2540
if last_revision not in self._lefthand_history(revision_id):
2541
raise errors.AppendRevisionsOnlyViolation(self.base)
2543
def _gen_revision_history(self):
2544
"""Generate the revision history from last revision
2546
last_revno, last_revision = self.last_revision_info()
2547
self._extend_partial_history(stop_index=last_revno-1)
2548
return list(reversed(self._partial_revision_history_cache))
2550
def _write_revision_history(self, history):
2551
"""Factored out of set_revision_history.
2553
This performs the actual writing to disk, with format-specific checks.
2554
It is intended to be called by BzrBranch5.set_revision_history.
2556
if len(history) == 0:
2557
last_revision = 'null:'
2559
if history != self._lefthand_history(history[-1]):
2560
raise errors.NotLefthandHistory(history)
2561
last_revision = history[-1]
2562
if self._get_append_revisions_only():
2563
self._check_history_violation(last_revision)
2564
self._write_last_revision_info(len(history), last_revision)
2567
def _set_parent_location(self, url):
2568
"""Set the parent branch"""
2569
self._set_config_location('parent_location', url, make_relative=True)
2572
def _get_parent_location(self):
2573
"""Set the parent branch"""
2574
return self._get_config_location('parent_location')
2577
def _set_all_reference_info(self, info_dict):
2578
"""Replace all reference info stored in a branch.
2580
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2583
writer = rio.RioWriter(s)
2584
for key, (tree_path, branch_location) in info_dict.iteritems():
2585
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2586
branch_location=branch_location)
2587
writer.write_stanza(stanza)
2588
self._transport.put_bytes('references', s.getvalue())
2589
self._reference_info = info_dict
2592
def _get_all_reference_info(self):
2593
"""Return all the reference info stored in a branch.
2595
:return: A dict of {file_id: (tree_path, branch_location)}
2597
if self._reference_info is not None:
2598
return self._reference_info
2599
rio_file = self._transport.get('references')
2601
stanzas = rio.read_stanzas(rio_file)
2602
info_dict = dict((s['file_id'], (s['tree_path'],
2603
s['branch_location'])) for s in stanzas)
2606
self._reference_info = info_dict
2609
def set_reference_info(self, file_id, tree_path, branch_location):
2610
"""Set the branch location to use for a tree reference.
2612
:param file_id: The file-id of the tree reference.
2613
:param tree_path: The path of the tree reference in the tree.
2614
:param branch_location: The location of the branch to retrieve tree
2617
info_dict = self._get_all_reference_info()
2618
info_dict[file_id] = (tree_path, branch_location)
2619
if None in (tree_path, branch_location):
2620
if tree_path is not None:
2621
raise ValueError('tree_path must be None when branch_location'
2623
if branch_location is not None:
2624
raise ValueError('branch_location must be None when tree_path'
2626
del info_dict[file_id]
2627
self._set_all_reference_info(info_dict)
2629
def get_reference_info(self, file_id):
2630
"""Get the tree_path and branch_location for a tree reference.
2632
:return: a tuple of (tree_path, branch_location)
2634
return self._get_all_reference_info().get(file_id, (None, None))
2636
def reference_parent(self, file_id, path, possible_transports=None):
2637
"""Return the parent branch for a tree-reference file_id.
2639
:param file_id: The file_id of the tree reference
2640
:param path: The path of the file_id in the tree
2641
:return: A branch associated with the file_id
2643
branch_location = self.get_reference_info(file_id)[1]
2644
if branch_location is None:
2645
return Branch.reference_parent(self, file_id, path,
2646
possible_transports)
2647
branch_location = urlutils.join(self.base, branch_location)
2648
return Branch.open(branch_location,
2649
possible_transports=possible_transports)
2651
def set_push_location(self, location):
2652
"""See Branch.set_push_location."""
2653
self._set_config_location('push_location', location)
2655
def set_bound_location(self, location):
2656
"""See Branch.set_push_location."""
2658
config = self.get_config()
2659
if location is None:
2660
if config.get_user_option('bound') != 'True':
2663
config.set_user_option('bound', 'False', warn_masked=True)
2666
self._set_config_location('bound_location', location,
2668
config.set_user_option('bound', 'True', warn_masked=True)
2671
def _get_bound_location(self, bound):
2672
"""Return the bound location in the config file.
2674
Return None if the bound parameter does not match"""
2675
config = self.get_config()
2676
config_bound = (config.get_user_option('bound') == 'True')
2677
if config_bound != bound:
2679
return self._get_config_location('bound_location', config=config)
2681
def get_bound_location(self):
2682
"""See Branch.set_push_location."""
2683
return self._get_bound_location(True)
2685
def get_old_bound_location(self):
2686
"""See Branch.get_old_bound_location"""
2687
return self._get_bound_location(False)
2689
def get_stacked_on_url(self):
2690
# you can always ask for the URL; but you might not be able to use it
2691
# if the repo can't support stacking.
2692
## self._check_stackable_repo()
2693
stacked_url = self._get_config_location('stacked_on_location')
2694
if stacked_url is None:
2695
raise errors.NotStacked(self)
2698
def _get_append_revisions_only(self):
2699
value = self.get_config().get_user_option('append_revisions_only')
2700
return value == 'True'
2703
def generate_revision_history(self, revision_id, last_rev=None,
2705
"""See BzrBranch5.generate_revision_history"""
2706
history = self._lefthand_history(revision_id, last_rev, other_branch)
2707
revno = len(history)
2708
self.set_last_revision_info(revno, revision_id)
2711
def get_rev_id(self, revno, history=None):
2712
"""Find the revision id of the specified revno."""
2714
return _mod_revision.NULL_REVISION
2716
last_revno, last_revision_id = self.last_revision_info()
2717
if revno <= 0 or revno > last_revno:
2718
raise errors.NoSuchRevision(self, revno)
2720
if history is not None:
2721
return history[revno - 1]
2723
index = last_revno - revno
2724
if len(self._partial_revision_history_cache) <= index:
2725
self._extend_partial_history(stop_index=index)
2726
if len(self._partial_revision_history_cache) > index:
2727
return self._partial_revision_history_cache[index]
2729
raise errors.NoSuchRevision(self, revno)
2732
def revision_id_to_revno(self, revision_id):
2733
"""Given a revision id, return its revno"""
2734
if _mod_revision.is_null(revision_id):
2737
index = self._partial_revision_history_cache.index(revision_id)
2739
self._extend_partial_history(stop_revision=revision_id)
2740
index = len(self._partial_revision_history_cache) - 1
2741
if self._partial_revision_history_cache[index] != revision_id:
2742
raise errors.NoSuchRevision(self, revision_id)
2743
return self.revno() - index
2746
class BzrBranch7(BzrBranch8):
2747
"""A branch with support for a fallback repository."""
2749
def set_reference_info(self, file_id, tree_path, branch_location):
2750
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2752
def get_reference_info(self, file_id):
2753
Branch.get_reference_info(self, file_id)
2755
def reference_parent(self, file_id, path, possible_transports=None):
2756
return Branch.reference_parent(self, file_id, path,
2757
possible_transports)
2760
class BzrBranch6(BzrBranch7):
2761
"""See BzrBranchFormat6 for the capabilities of this branch.
2763
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2767
def get_stacked_on_url(self):
2768
raise errors.UnstackableBranchFormat(self._format, self.base)
2771
######################################################################
2772
# results of operations
2775
class _Result(object):
2777
def _show_tag_conficts(self, to_file):
2778
if not getattr(self, 'tag_conflicts', None):
2780
to_file.write('Conflicting tags:\n')
2781
for name, value1, value2 in self.tag_conflicts:
2782
to_file.write(' %s\n' % (name, ))
2785
class PullResult(_Result):
2786
"""Result of a Branch.pull operation.
2788
:ivar old_revno: Revision number before pull.
2789
:ivar new_revno: Revision number after pull.
2790
:ivar old_revid: Tip revision id before pull.
2791
:ivar new_revid: Tip revision id after pull.
2792
:ivar source_branch: Source (local) branch object. (read locked)
2793
:ivar master_branch: Master branch of the target, or the target if no
2795
:ivar local_branch: target branch if there is a Master, else None
2796
:ivar target_branch: Target/destination branch object. (write locked)
2797
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2801
# DEPRECATED: pull used to return the change in revno
2802
return self.new_revno - self.old_revno
2804
def report(self, to_file):
2806
if self.old_revid == self.new_revid:
2807
to_file.write('No revisions to pull.\n')
2809
to_file.write('Now on revision %d.\n' % self.new_revno)
2810
self._show_tag_conficts(to_file)
2813
class BranchPushResult(_Result):
2814
"""Result of a Branch.push operation.
2816
:ivar old_revno: Revision number (eg 10) of the target before push.
2817
:ivar new_revno: Revision number (eg 12) of the target after push.
2818
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2820
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2822
:ivar source_branch: Source branch object that the push was from. This is
2823
read locked, and generally is a local (and thus low latency) branch.
2824
:ivar master_branch: If target is a bound branch, the master branch of
2825
target, or target itself. Always write locked.
2826
:ivar target_branch: The direct Branch where data is being sent (write
2828
:ivar local_branch: If the target is a bound branch this will be the
2829
target, otherwise it will be None.
2833
# DEPRECATED: push used to return the change in revno
2834
return self.new_revno - self.old_revno
2836
def report(self, to_file):
2837
"""Write a human-readable description of the result."""
2838
if self.old_revid == self.new_revid:
2839
note('No new revisions to push.')
2841
note('Pushed up to revision %d.' % self.new_revno)
2842
self._show_tag_conficts(to_file)
2845
class BranchCheckResult(object):
2846
"""Results of checking branch consistency.
2851
def __init__(self, branch):
2852
self.branch = branch
2855
def report_results(self, verbose):
2856
"""Report the check results via trace.note.
2858
:param verbose: Requests more detailed display of what was checked,
2861
note('checked branch %s format %s', self.branch.base,
2862
self.branch._format)
2863
for error in self.errors:
2864
note('found error:%s', error)
2867
class Converter5to6(object):
2868
"""Perform an in-place upgrade of format 5 to format 6"""
2870
def convert(self, branch):
2871
# Data for 5 and 6 can peacefully coexist.
2872
format = BzrBranchFormat6()
2873
new_branch = format.open(branch.bzrdir, _found=True)
2875
# Copy source data into target
2876
new_branch._write_last_revision_info(*branch.last_revision_info())
2877
new_branch.set_parent(branch.get_parent())
2878
new_branch.set_bound_location(branch.get_bound_location())
2879
new_branch.set_push_location(branch.get_push_location())
2881
# New branch has no tags by default
2882
new_branch.tags._set_tag_dict({})
2884
# Copying done; now update target format
2885
new_branch._transport.put_bytes('format',
2886
format.get_format_string(),
2887
mode=new_branch.bzrdir._get_file_mode())
2889
# Clean up old files
2890
new_branch._transport.delete('revision-history')
2892
branch.set_parent(None)
2893
except errors.NoSuchFile:
2895
branch.set_bound_location(None)
2898
class Converter6to7(object):
2899
"""Perform an in-place upgrade of format 6 to format 7"""
2901
def convert(self, branch):
2902
format = BzrBranchFormat7()
2903
branch._set_config_location('stacked_on_location', '')
2904
# update target format
2905
branch._transport.put_bytes('format', format.get_format_string())
2908
class Converter7to8(object):
2909
"""Perform an in-place upgrade of format 6 to format 7"""
2911
def convert(self, branch):
2912
format = BzrBranchFormat8()
2913
branch._transport.put_bytes('references', '')
2914
# update target format
2915
branch._transport.put_bytes('format', format.get_format_string())
2918
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2919
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2922
_run_with_write_locked_target will attempt to release the lock it acquires.
2924
If an exception is raised by callable, then that exception *will* be
2925
propagated, even if the unlock attempt raises its own error. Thus
2926
_run_with_write_locked_target should be preferred to simply doing::
2930
return callable(*args, **kwargs)
2935
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2936
# should share code?
2939
result = callable(*args, **kwargs)
2941
exc_info = sys.exc_info()
2945
raise exc_info[0], exc_info[1], exc_info[2]
2951
class InterBranch(InterObject):
2952
"""This class represents operations taking place between two branches.
2954
Its instances have methods like pull() and push() and contain
2955
references to the source and target repositories these operations
2956
can be carried out on.
2960
"""The available optimised InterBranch types."""
2963
def _get_branch_formats_to_test():
2964
"""Return a tuple with the Branch formats to use when testing."""
2965
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
2967
def pull(self, overwrite=False, stop_revision=None,
2968
possible_transports=None, local=False):
2969
"""Mirror source into target branch.
2971
The target branch is considered to be 'local', having low latency.
2973
:returns: PullResult instance
2975
raise NotImplementedError(self.pull)
2977
def update_revisions(self, stop_revision=None, overwrite=False,
2979
"""Pull in new perfect-fit revisions.
2981
:param stop_revision: Updated until the given revision
2982
:param overwrite: Always set the branch pointer, rather than checking
2983
to see if it is a proper descendant.
2984
:param graph: A Graph object that can be used to query history
2985
information. This can be None.
2988
raise NotImplementedError(self.update_revisions)
2990
def push(self, overwrite=False, stop_revision=None,
2991
_override_hook_source_branch=None):
2992
"""Mirror the source branch into the target branch.
2994
The source branch is considered to be 'local', having low latency.
2996
raise NotImplementedError(self.push)
2999
class GenericInterBranch(InterBranch):
3000
"""InterBranch implementation that uses public Branch functions.
3004
def _get_branch_formats_to_test():
3005
return BranchFormat._default_format, BranchFormat._default_format
3007
def update_revisions(self, stop_revision=None, overwrite=False,
3009
"""See InterBranch.update_revisions()."""
3010
self.source.lock_read()
3012
other_revno, other_last_revision = self.source.last_revision_info()
3013
stop_revno = None # unknown
3014
if stop_revision is None:
3015
stop_revision = other_last_revision
3016
if _mod_revision.is_null(stop_revision):
3017
# if there are no commits, we're done.
3019
stop_revno = other_revno
3021
# what's the current last revision, before we fetch [and change it
3023
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3024
# we fetch here so that we don't process data twice in the common
3025
# case of having something to pull, and so that the check for
3026
# already merged can operate on the just fetched graph, which will
3027
# be cached in memory.
3028
self.target.fetch(self.source, stop_revision)
3029
# Check to see if one is an ancestor of the other
3032
graph = self.target.repository.get_graph()
3033
if self.target._check_if_descendant_or_diverged(
3034
stop_revision, last_rev, graph, self.source):
3035
# stop_revision is a descendant of last_rev, but we aren't
3036
# overwriting, so we're done.
3038
if stop_revno is None:
3040
graph = self.target.repository.get_graph()
3041
this_revno, this_last_revision = \
3042
self.target.last_revision_info()
3043
stop_revno = graph.find_distance_to_null(stop_revision,
3044
[(other_last_revision, other_revno),
3045
(this_last_revision, this_revno)])
3046
self.target.set_last_revision_info(stop_revno, stop_revision)
3048
self.source.unlock()
3050
def pull(self, overwrite=False, stop_revision=None,
3051
possible_transports=None, _hook_master=None, run_hooks=True,
3052
_override_hook_target=None, local=False):
3055
:param _hook_master: Private parameter - set the branch to
3056
be supplied as the master to pull hooks.
3057
:param run_hooks: Private parameter - if false, this branch
3058
is being called because it's the master of the primary branch,
3059
so it should not run its hooks.
3060
:param _override_hook_target: Private parameter - set the branch to be
3061
supplied as the target_branch to pull hooks.
3062
:param local: Only update the local branch, and not the bound branch.
3064
# This type of branch can't be bound.
3066
raise errors.LocalRequiresBoundBranch()
3067
result = PullResult()
3068
result.source_branch = self.source
3069
if _override_hook_target is None:
3070
result.target_branch = self.target
3072
result.target_branch = _override_hook_target
3073
self.source.lock_read()
3075
# We assume that during 'pull' the target repository is closer than
3077
self.source.update_references(self.target)
3078
graph = self.target.repository.get_graph(self.source.repository)
3079
# TODO: Branch formats should have a flag that indicates
3080
# that revno's are expensive, and pull() should honor that flag.
3082
result.old_revno, result.old_revid = \
3083
self.target.last_revision_info()
3084
self.target.update_revisions(self.source, stop_revision,
3085
overwrite=overwrite, graph=graph)
3086
# TODO: The old revid should be specified when merging tags,
3087
# so a tags implementation that versions tags can only
3088
# pull in the most recent changes. -- JRV20090506
3089
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3091
result.new_revno, result.new_revid = self.target.last_revision_info()
3093
result.master_branch = _hook_master
3094
result.local_branch = result.target_branch
3096
result.master_branch = result.target_branch
3097
result.local_branch = None
3099
for hook in Branch.hooks['post_pull']:
3102
self.source.unlock()
3105
def push(self, overwrite=False, stop_revision=None,
3106
_override_hook_source_branch=None):
3107
"""See InterBranch.push.
3109
This is the basic concrete implementation of push()
3111
:param _override_hook_source_branch: If specified, run
3112
the hooks passing this Branch as the source, rather than self.
3113
This is for use of RemoteBranch, where push is delegated to the
3114
underlying vfs-based Branch.
3116
# TODO: Public option to disable running hooks - should be trivial but
3118
self.source.lock_read()
3120
return _run_with_write_locked_target(
3121
self.target, self._push_with_bound_branches, overwrite,
3123
_override_hook_source_branch=_override_hook_source_branch)
3125
self.source.unlock()
3127
def _push_with_bound_branches(self, overwrite, stop_revision,
3128
_override_hook_source_branch=None):
3129
"""Push from source into target, and into target's master if any.
3132
if _override_hook_source_branch:
3133
result.source_branch = _override_hook_source_branch
3134
for hook in Branch.hooks['post_push']:
3137
bound_location = self.target.get_bound_location()
3138
if bound_location and self.target.base != bound_location:
3139
# there is a master branch.
3141
# XXX: Why the second check? Is it even supported for a branch to
3142
# be bound to itself? -- mbp 20070507
3143
master_branch = self.target.get_master_branch()
3144
master_branch.lock_write()
3146
# push into the master from the source branch.
3147
self.source._basic_push(master_branch, overwrite, stop_revision)
3148
# and push into the target branch from the source. Note that we
3149
# push from the source branch again, because its considered the
3150
# highest bandwidth repository.
3151
result = self.source._basic_push(self.target, overwrite,
3153
result.master_branch = master_branch
3154
result.local_branch = self.target
3158
master_branch.unlock()
3161
result = self.source._basic_push(self.target, overwrite,
3163
# TODO: Why set master_branch and local_branch if there's no
3164
# binding? Maybe cleaner to just leave them unset? -- mbp
3166
result.master_branch = self.target
3167
result.local_branch = None
3172
def is_compatible(self, source, target):
3173
# GenericBranch uses the public API, so always compatible
3177
class InterToBranch5(GenericInterBranch):
3180
def _get_branch_formats_to_test():
3181
return BranchFormat._default_format, BzrBranchFormat5()
3183
def pull(self, overwrite=False, stop_revision=None,
3184
possible_transports=None, run_hooks=True,
3185
_override_hook_target=None, local=False):
3186
"""Pull from source into self, updating my master if any.
3188
:param run_hooks: Private parameter - if false, this branch
3189
is being called because it's the master of the primary branch,
3190
so it should not run its hooks.
3192
bound_location = self.target.get_bound_location()
3193
if local and not bound_location:
3194
raise errors.LocalRequiresBoundBranch()
3195
master_branch = None
3196
if not local and bound_location and self.source.base != bound_location:
3197
# not pulling from master, so we need to update master.
3198
master_branch = self.target.get_master_branch(possible_transports)
3199
master_branch.lock_write()
3202
# pull from source into master.
3203
master_branch.pull(self.source, overwrite, stop_revision,
3205
return super(InterToBranch5, self).pull(overwrite,
3206
stop_revision, _hook_master=master_branch,
3207
run_hooks=run_hooks,
3208
_override_hook_target=_override_hook_target)
3211
master_branch.unlock()
3214
InterBranch.register_optimiser(GenericInterBranch)
3215
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
