1
# Copyright (C) 2005-2010 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=_unsupported)
173
def open_from_transport(transport, name=None, _unsupported=False):
174
"""Open the branch rooted at transport"""
175
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
176
return control.open_branch(name=name, unsupported=_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_branch = Branch.open(url,
221
possible_transports=[self.bzrdir.root_transport])
222
return a_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
known_graph = self.repository.get_known_graph_ancestry(
452
self._merge_sorted_revisions_cache = known_graph.merge_sort(
454
filtered = self._filter_merge_sorted_revisions(
455
self._merge_sorted_revisions_cache, start_revision_id,
456
stop_revision_id, stop_rule)
457
# Make sure we don't return revisions that are not part of the
458
# start_revision_id ancestry.
459
filtered = self._filter_start_non_ancestors(filtered)
460
if direction == 'reverse':
462
if direction == 'forward':
463
return reversed(list(filtered))
465
raise ValueError('invalid direction %r' % direction)
467
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
468
start_revision_id, stop_revision_id, stop_rule):
469
"""Iterate over an inclusive range of sorted revisions."""
470
rev_iter = iter(merge_sorted_revisions)
471
if start_revision_id is not None:
472
for node in rev_iter:
473
rev_id = node.key[-1]
474
if rev_id != start_revision_id:
477
# The decision to include the start or not
478
# depends on the stop_rule if a stop is provided
479
# so pop this node back into the iterator
480
rev_iter = chain(iter([node]), rev_iter)
482
if stop_revision_id is None:
484
for node in rev_iter:
485
rev_id = node.key[-1]
486
yield (rev_id, node.merge_depth, node.revno,
488
elif stop_rule == 'exclude':
489
for node in rev_iter:
490
rev_id = node.key[-1]
491
if rev_id == stop_revision_id:
493
yield (rev_id, node.merge_depth, node.revno,
495
elif stop_rule == 'include':
496
for node in rev_iter:
497
rev_id = node.key[-1]
498
yield (rev_id, node.merge_depth, node.revno,
500
if rev_id == stop_revision_id:
502
elif stop_rule == 'with-merges-without-common-ancestry':
503
# We want to exclude all revisions that are already part of the
504
# stop_revision_id ancestry.
505
graph = self.repository.get_graph()
506
for node in rev_iter:
507
rev_id = node.key[-1]
508
if graph.is_ancestor(rev_id, stop_revision_id):
510
yield (rev_id, node.merge_depth, node.revno,
512
elif stop_rule == 'with-merges':
513
stop_rev = self.repository.get_revision(stop_revision_id)
514
if stop_rev.parent_ids:
515
left_parent = stop_rev.parent_ids[0]
517
left_parent = _mod_revision.NULL_REVISION
518
# left_parent is the actual revision we want to stop logging at,
519
# since we want to show the merged revisions after the stop_rev too
520
reached_stop_revision_id = False
521
revision_id_whitelist = []
522
for node in rev_iter:
523
rev_id = node.key[-1]
524
if rev_id == left_parent:
525
# reached the left parent after the stop_revision
527
if (not reached_stop_revision_id or
528
rev_id in revision_id_whitelist):
529
yield (rev_id, node.merge_depth, node.revno,
531
if reached_stop_revision_id or rev_id == stop_revision_id:
532
# only do the merged revs of rev_id from now on
533
rev = self.repository.get_revision(rev_id)
535
reached_stop_revision_id = True
536
revision_id_whitelist.extend(rev.parent_ids)
538
raise ValueError('invalid stop_rule %r' % stop_rule)
540
def _filter_start_non_ancestors(self, rev_iter):
541
# If we started from a dotted revno, we want to consider it as a tip
542
# and don't want to yield revisions that are not part of its
543
# ancestry. Given the order guaranteed by the merge sort, we will see
544
# uninteresting descendants of the first parent of our tip before the
546
first = rev_iter.next()
547
(rev_id, merge_depth, revno, end_of_merge) = first
550
# We start at a mainline revision so by definition, all others
551
# revisions in rev_iter are ancestors
552
for node in rev_iter:
557
pmap = self.repository.get_parent_map([rev_id])
558
parents = pmap.get(rev_id, [])
560
whitelist.update(parents)
562
# If there is no parents, there is nothing of interest left
564
# FIXME: It's hard to test this scenario here as this code is never
565
# called in that case. -- vila 20100322
568
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
570
if rev_id in whitelist:
571
pmap = self.repository.get_parent_map([rev_id])
572
parents = pmap.get(rev_id, [])
573
whitelist.remove(rev_id)
574
whitelist.update(parents)
576
# We've reached the mainline, there is nothing left to
580
# A revision that is not part of the ancestry of our
583
yield (rev_id, merge_depth, revno, end_of_merge)
585
def leave_lock_in_place(self):
586
"""Tell this branch object not to release the physical lock when this
589
If lock_write doesn't return a token, then this method is not supported.
591
self.control_files.leave_in_place()
593
def dont_leave_lock_in_place(self):
594
"""Tell this branch object to release the physical lock when this
595
object is unlocked, even if it didn't originally acquire it.
597
If lock_write doesn't return a token, then this method is not supported.
599
self.control_files.dont_leave_in_place()
601
def bind(self, other):
602
"""Bind the local branch the other branch.
604
:param other: The branch to bind to
607
raise errors.UpgradeRequired(self.base)
609
def set_append_revisions_only(self, enabled):
610
if not self._format.supports_set_append_revisions_only():
611
raise errors.UpgradeRequired(self.base)
616
self.get_config().set_user_option('append_revisions_only', value,
619
def set_reference_info(self, file_id, tree_path, branch_location):
620
"""Set the branch location to use for a tree reference."""
621
raise errors.UnsupportedOperation(self.set_reference_info, self)
623
def get_reference_info(self, file_id):
624
"""Get the tree_path and branch_location for a tree reference."""
625
raise errors.UnsupportedOperation(self.get_reference_info, self)
628
def fetch(self, from_branch, last_revision=None, pb=None):
629
"""Copy revisions from from_branch into this branch.
631
:param from_branch: Where to copy from.
632
:param last_revision: What revision to stop at (None for at the end
634
:param pb: An optional progress bar to use.
637
if self.base == from_branch.base:
640
symbol_versioning.warn(
641
symbol_versioning.deprecated_in((1, 14, 0))
642
% "pb parameter to fetch()")
643
from_branch.lock_read()
645
if last_revision is None:
646
last_revision = from_branch.last_revision()
647
last_revision = _mod_revision.ensure_null(last_revision)
648
return self.repository.fetch(from_branch.repository,
649
revision_id=last_revision,
654
def get_bound_location(self):
655
"""Return the URL of the branch we are bound to.
657
Older format branches cannot bind, please be sure to use a metadir
662
def get_old_bound_location(self):
663
"""Return the URL of the branch we used to be bound to
665
raise errors.UpgradeRequired(self.base)
667
def get_commit_builder(self, parents, config=None, timestamp=None,
668
timezone=None, committer=None, revprops=None,
670
"""Obtain a CommitBuilder for this branch.
672
:param parents: Revision ids of the parents of the new revision.
673
:param config: Optional configuration to use.
674
:param timestamp: Optional timestamp recorded for commit.
675
:param timezone: Optional timezone for timestamp.
676
:param committer: Optional committer to set for commit.
677
:param revprops: Optional dictionary of revision properties.
678
:param revision_id: Optional revision id.
682
config = self.get_config()
684
return self.repository.get_commit_builder(self, parents, config,
685
timestamp, timezone, committer, revprops, revision_id)
687
def get_master_branch(self, possible_transports=None):
688
"""Return the branch we are bound to.
690
:return: Either a Branch, or None
694
def get_revision_delta(self, revno):
695
"""Return the delta for one revision.
697
The delta is relative to its mainline predecessor, or the
698
empty tree for revision 1.
700
rh = self.revision_history()
701
if not (1 <= revno <= len(rh)):
702
raise errors.InvalidRevisionNumber(revno)
703
return self.repository.get_revision_delta(rh[revno-1])
705
def get_stacked_on_url(self):
706
"""Get the URL this branch is stacked against.
708
:raises NotStacked: If the branch is not stacked.
709
:raises UnstackableBranchFormat: If the branch does not support
712
raise NotImplementedError(self.get_stacked_on_url)
714
def print_file(self, file, revision_id):
715
"""Print `file` to stdout."""
716
raise NotImplementedError(self.print_file)
718
def set_revision_history(self, rev_history):
719
raise NotImplementedError(self.set_revision_history)
722
def set_parent(self, url):
723
"""See Branch.set_parent."""
724
# TODO: Maybe delete old location files?
725
# URLs should never be unicode, even on the local fs,
726
# FIXUP this and get_parent in a future branch format bump:
727
# read and rewrite the file. RBC 20060125
729
if isinstance(url, unicode):
731
url = url.encode('ascii')
732
except UnicodeEncodeError:
733
raise errors.InvalidURL(url,
734
"Urls must be 7-bit ascii, "
735
"use bzrlib.urlutils.escape")
736
url = urlutils.relative_url(self.base, url)
737
self._set_parent_location(url)
740
def set_stacked_on_url(self, url):
741
"""Set the URL this branch is stacked against.
743
:raises UnstackableBranchFormat: If the branch does not support
745
:raises UnstackableRepositoryFormat: If the repository does not support
748
if not self._format.supports_stacking():
749
raise errors.UnstackableBranchFormat(self._format, self.base)
750
# XXX: Changing from one fallback repository to another does not check
751
# that all the data you need is present in the new fallback.
752
# Possibly it should.
753
self._check_stackable_repo()
756
old_url = self.get_stacked_on_url()
757
except (errors.NotStacked, errors.UnstackableBranchFormat,
758
errors.UnstackableRepositoryFormat):
762
self._activate_fallback_location(url)
763
# write this out after the repository is stacked to avoid setting a
764
# stacked config that doesn't work.
765
self._set_config_location('stacked_on_location', url)
768
"""Change a branch to be unstacked, copying data as needed.
770
Don't call this directly, use set_stacked_on_url(None).
772
pb = ui.ui_factory.nested_progress_bar()
774
pb.update("Unstacking")
775
# The basic approach here is to fetch the tip of the branch,
776
# including all available ghosts, from the existing stacked
777
# repository into a new repository object without the fallbacks.
779
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
780
# correct for CHKMap repostiories
781
old_repository = self.repository
782
if len(old_repository._fallback_repositories) != 1:
783
raise AssertionError("can't cope with fallback repositories "
784
"of %r" % (self.repository,))
785
# unlock it, including unlocking the fallback
786
old_repository.unlock()
787
old_repository.lock_read()
789
# Repositories don't offer an interface to remove fallback
790
# repositories today; take the conceptually simpler option and just
791
# reopen it. We reopen it starting from the URL so that we
792
# get a separate connection for RemoteRepositories and can
793
# stream from one of them to the other. This does mean doing
794
# separate SSH connection setup, but unstacking is not a
795
# common operation so it's tolerable.
796
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
797
new_repository = new_bzrdir.find_repository()
798
self.repository = new_repository
799
if self.repository._fallback_repositories:
800
raise AssertionError("didn't expect %r to have "
801
"fallback_repositories"
802
% (self.repository,))
803
# this is not paired with an unlock because it's just restoring
804
# the previous state; the lock's released when set_stacked_on_url
806
self.repository.lock_write()
807
# XXX: If you unstack a branch while it has a working tree
808
# with a pending merge, the pending-merged revisions will no
809
# longer be present. You can (probably) revert and remerge.
811
# XXX: This only fetches up to the tip of the repository; it
812
# doesn't bring across any tags. That's fairly consistent
813
# with how branch works, but perhaps not ideal.
814
self.repository.fetch(old_repository,
815
revision_id=self.last_revision(),
818
old_repository.unlock()
822
def _set_tags_bytes(self, bytes):
823
"""Mirror method for _get_tags_bytes.
825
:seealso: Branch._get_tags_bytes.
827
return _run_with_write_locked_target(self, self._transport.put_bytes,
830
def _cache_revision_history(self, rev_history):
831
"""Set the cached revision history to rev_history.
833
The revision_history method will use this cache to avoid regenerating
834
the revision history.
836
This API is semi-public; it only for use by subclasses, all other code
837
should consider it to be private.
839
self._revision_history_cache = rev_history
841
def _cache_revision_id_to_revno(self, revision_id_to_revno):
842
"""Set the cached revision_id => revno map to revision_id_to_revno.
844
This API is semi-public; it only for use by subclasses, all other code
845
should consider it to be private.
847
self._revision_id_to_revno_cache = revision_id_to_revno
849
def _clear_cached_state(self):
850
"""Clear any cached data on this branch, e.g. cached revision history.
852
This means the next call to revision_history will need to call
853
_gen_revision_history.
855
This API is semi-public; it only for use by subclasses, all other code
856
should consider it to be private.
858
self._revision_history_cache = None
859
self._revision_id_to_revno_cache = None
860
self._last_revision_info_cache = None
861
self._merge_sorted_revisions_cache = None
862
self._partial_revision_history_cache = []
863
self._partial_revision_id_to_revno_cache = {}
865
def _gen_revision_history(self):
866
"""Return sequence of revision hashes on to this branch.
868
Unlike revision_history, this method always regenerates or rereads the
869
revision history, i.e. it does not cache the result, so repeated calls
872
Concrete subclasses should override this instead of revision_history so
873
that subclasses do not need to deal with caching logic.
875
This API is semi-public; it only for use by subclasses, all other code
876
should consider it to be private.
878
raise NotImplementedError(self._gen_revision_history)
881
def revision_history(self):
882
"""Return sequence of revision ids on this branch.
884
This method will cache the revision history for as long as it is safe to
887
if 'evil' in debug.debug_flags:
888
mutter_callsite(3, "revision_history scales with history.")
889
if self._revision_history_cache is not None:
890
history = self._revision_history_cache
892
history = self._gen_revision_history()
893
self._cache_revision_history(history)
897
"""Return current revision number for this branch.
899
That is equivalent to the number of revisions committed to
902
return self.last_revision_info()[0]
905
"""Older format branches cannot bind or unbind."""
906
raise errors.UpgradeRequired(self.base)
908
def last_revision(self):
909
"""Return last revision id, or NULL_REVISION."""
910
return self.last_revision_info()[1]
913
def last_revision_info(self):
914
"""Return information about the last revision.
916
:return: A tuple (revno, revision_id).
918
if self._last_revision_info_cache is None:
919
self._last_revision_info_cache = self._last_revision_info()
920
return self._last_revision_info_cache
922
def _last_revision_info(self):
923
rh = self.revision_history()
926
return (revno, rh[-1])
928
return (0, _mod_revision.NULL_REVISION)
930
@deprecated_method(deprecated_in((1, 6, 0)))
931
def missing_revisions(self, other, stop_revision=None):
932
"""Return a list of new revisions that would perfectly fit.
934
If self and other have not diverged, return a list of the revisions
935
present in other, but missing from self.
937
self_history = self.revision_history()
938
self_len = len(self_history)
939
other_history = other.revision_history()
940
other_len = len(other_history)
941
common_index = min(self_len, other_len) -1
942
if common_index >= 0 and \
943
self_history[common_index] != other_history[common_index]:
944
raise errors.DivergedBranches(self, other)
946
if stop_revision is None:
947
stop_revision = other_len
949
if stop_revision > other_len:
950
raise errors.NoSuchRevision(self, stop_revision)
951
return other_history[self_len:stop_revision]
954
def update_revisions(self, other, stop_revision=None, overwrite=False,
956
"""Pull in new perfect-fit revisions.
958
:param other: Another Branch to pull from
959
:param stop_revision: Updated until the given revision
960
:param overwrite: Always set the branch pointer, rather than checking
961
to see if it is a proper descendant.
962
:param graph: A Graph object that can be used to query history
963
information. This can be None.
966
return InterBranch.get(other, self).update_revisions(stop_revision,
969
def import_last_revision_info(self, source_repo, revno, revid):
970
"""Set the last revision info, importing from another repo if necessary.
972
This is used by the bound branch code to upload a revision to
973
the master branch first before updating the tip of the local branch.
975
:param source_repo: Source repository to optionally fetch from
976
:param revno: Revision number of the new tip
977
:param revid: Revision id of the new tip
979
if not self.repository.has_same_location(source_repo):
980
self.repository.fetch(source_repo, revision_id=revid)
981
self.set_last_revision_info(revno, revid)
983
def revision_id_to_revno(self, revision_id):
984
"""Given a revision id, return its revno"""
985
if _mod_revision.is_null(revision_id):
987
history = self.revision_history()
989
return history.index(revision_id) + 1
991
raise errors.NoSuchRevision(self, revision_id)
994
def get_rev_id(self, revno, history=None):
995
"""Find the revision id of the specified revno."""
997
return _mod_revision.NULL_REVISION
998
last_revno, last_revid = self.last_revision_info()
999
if revno == last_revno:
1001
if revno <= 0 or revno > last_revno:
1002
raise errors.NoSuchRevision(self, revno)
1003
distance_from_last = last_revno - revno
1004
if len(self._partial_revision_history_cache) <= distance_from_last:
1005
self._extend_partial_history(distance_from_last)
1006
return self._partial_revision_history_cache[distance_from_last]
1009
def pull(self, source, overwrite=False, stop_revision=None,
1010
possible_transports=None, *args, **kwargs):
1011
"""Mirror source into this branch.
1013
This branch is considered to be 'local', having low latency.
1015
:returns: PullResult instance
1017
return InterBranch.get(source, self).pull(overwrite=overwrite,
1018
stop_revision=stop_revision,
1019
possible_transports=possible_transports, *args, **kwargs)
1021
def push(self, target, overwrite=False, stop_revision=None, *args,
1023
"""Mirror this branch into target.
1025
This branch is considered to be 'local', having low latency.
1027
return InterBranch.get(self, target).push(overwrite, stop_revision,
1030
def lossy_push(self, target, stop_revision=None):
1031
"""Push deltas into another branch.
1033
:note: This does not, like push, retain the revision ids from
1034
the source branch and will, rather than adding bzr-specific
1035
metadata, push only those semantics of the revision that can be
1036
natively represented by this branch' VCS.
1038
:param target: Target branch
1039
:param stop_revision: Revision to push, defaults to last revision.
1040
:return: BranchPushResult with an extra member revidmap:
1041
A dictionary mapping revision ids from the target branch
1042
to new revision ids in the target branch, for each
1043
revision that was pushed.
1045
inter = InterBranch.get(self, target)
1046
lossy_push = getattr(inter, "lossy_push", None)
1047
if lossy_push is None:
1048
raise errors.LossyPushToSameVCS(self, target)
1049
return lossy_push(stop_revision)
1051
def basis_tree(self):
1052
"""Return `Tree` object for last revision."""
1053
return self.repository.revision_tree(self.last_revision())
1055
def get_parent(self):
1056
"""Return the parent location of the branch.
1058
This is the default location for pull/missing. The usual
1059
pattern is that the user can override it by specifying a
1062
parent = self._get_parent_location()
1065
# This is an old-format absolute path to a local branch
1066
# turn it into a url
1067
if parent.startswith('/'):
1068
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1070
return urlutils.join(self.base[:-1], parent)
1071
except errors.InvalidURLJoin, e:
1072
raise errors.InaccessibleParent(parent, self.base)
1074
def _get_parent_location(self):
1075
raise NotImplementedError(self._get_parent_location)
1077
def _set_config_location(self, name, url, config=None,
1078
make_relative=False):
1080
config = self.get_config()
1084
url = urlutils.relative_url(self.base, url)
1085
config.set_user_option(name, url, warn_masked=True)
1087
def _get_config_location(self, name, config=None):
1089
config = self.get_config()
1090
location = config.get_user_option(name)
1095
def get_child_submit_format(self):
1096
"""Return the preferred format of submissions to this branch."""
1097
return self.get_config().get_user_option("child_submit_format")
1099
def get_submit_branch(self):
1100
"""Return the submit location of the branch.
1102
This is the default location for bundle. The usual
1103
pattern is that the user can override it by specifying a
1106
return self.get_config().get_user_option('submit_branch')
1108
def set_submit_branch(self, location):
1109
"""Return the submit location of the branch.
1111
This is the default location for bundle. The usual
1112
pattern is that the user can override it by specifying a
1115
self.get_config().set_user_option('submit_branch', location,
1118
def get_public_branch(self):
1119
"""Return the public location of the branch.
1121
This is used by merge directives.
1123
return self._get_config_location('public_branch')
1125
def set_public_branch(self, location):
1126
"""Return the submit location of the branch.
1128
This is the default location for bundle. The usual
1129
pattern is that the user can override it by specifying a
1132
self._set_config_location('public_branch', location)
1134
def get_push_location(self):
1135
"""Return the None or the location to push this branch to."""
1136
push_loc = self.get_config().get_user_option('push_location')
1139
def set_push_location(self, location):
1140
"""Set a new push location for this branch."""
1141
raise NotImplementedError(self.set_push_location)
1143
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1144
"""Run the post_change_branch_tip hooks."""
1145
hooks = Branch.hooks['post_change_branch_tip']
1148
new_revno, new_revid = self.last_revision_info()
1149
params = ChangeBranchTipParams(
1150
self, old_revno, new_revno, old_revid, new_revid)
1154
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1155
"""Run the pre_change_branch_tip hooks."""
1156
hooks = Branch.hooks['pre_change_branch_tip']
1159
old_revno, old_revid = self.last_revision_info()
1160
params = ChangeBranchTipParams(
1161
self, old_revno, new_revno, old_revid, new_revid)
1167
"""Synchronise this branch with the master branch if any.
1169
:return: None or the last_revision pivoted out during the update.
1173
def check_revno(self, revno):
1175
Check whether a revno corresponds to any revision.
1176
Zero (the NULL revision) is considered valid.
1179
self.check_real_revno(revno)
1181
def check_real_revno(self, revno):
1183
Check whether a revno corresponds to a real revision.
1184
Zero (the NULL revision) is considered invalid
1186
if revno < 1 or revno > self.revno():
1187
raise errors.InvalidRevisionNumber(revno)
1190
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1191
"""Clone this branch into to_bzrdir preserving all semantic values.
1193
Most API users will want 'create_clone_on_transport', which creates a
1194
new bzrdir and branch on the fly.
1196
revision_id: if not None, the revision history in the new branch will
1197
be truncated to end with revision_id.
1199
result = to_bzrdir.create_branch()
1202
if repository_policy is not None:
1203
repository_policy.configure_branch(result)
1204
self.copy_content_into(result, revision_id=revision_id)
1210
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1211
"""Create a new line of development from the branch, into to_bzrdir.
1213
to_bzrdir controls the branch format.
1215
revision_id: if not None, the revision history in the new branch will
1216
be truncated to end with revision_id.
1218
if (repository_policy is not None and
1219
repository_policy.requires_stacking()):
1220
to_bzrdir._format.require_stacking(_skip_repo=True)
1221
result = to_bzrdir.create_branch()
1224
if repository_policy is not None:
1225
repository_policy.configure_branch(result)
1226
self.copy_content_into(result, revision_id=revision_id)
1227
result.set_parent(self.bzrdir.root_transport.base)
1232
def _synchronize_history(self, destination, revision_id):
1233
"""Synchronize last revision and revision history between branches.
1235
This version is most efficient when the destination is also a
1236
BzrBranch6, but works for BzrBranch5, as long as the destination's
1237
repository contains all the lefthand ancestors of the intended
1238
last_revision. If not, set_last_revision_info will fail.
1240
:param destination: The branch to copy the history into
1241
:param revision_id: The revision-id to truncate history at. May
1242
be None to copy complete history.
1244
source_revno, source_revision_id = self.last_revision_info()
1245
if revision_id is None:
1246
revno, revision_id = source_revno, source_revision_id
1248
graph = self.repository.get_graph()
1250
revno = graph.find_distance_to_null(revision_id,
1251
[(source_revision_id, source_revno)])
1252
except errors.GhostRevisionsHaveNoRevno:
1253
# Default to 1, if we can't find anything else
1255
destination.set_last_revision_info(revno, revision_id)
1258
def copy_content_into(self, destination, revision_id=None):
1259
"""Copy the content of self into destination.
1261
revision_id: if not None, the revision history in the new branch will
1262
be truncated to end with revision_id.
1264
self.update_references(destination)
1265
self._synchronize_history(destination, revision_id)
1267
parent = self.get_parent()
1268
except errors.InaccessibleParent, e:
1269
mutter('parent was not accessible to copy: %s', e)
1272
destination.set_parent(parent)
1273
if self._push_should_merge_tags():
1274
self.tags.merge_to(destination.tags)
1276
def update_references(self, target):
1277
if not getattr(self._format, 'supports_reference_locations', False):
1279
reference_dict = self._get_all_reference_info()
1280
if len(reference_dict) == 0:
1282
old_base = self.base
1283
new_base = target.base
1284
target_reference_dict = target._get_all_reference_info()
1285
for file_id, (tree_path, branch_location) in (
1286
reference_dict.items()):
1287
branch_location = urlutils.rebase_url(branch_location,
1289
target_reference_dict.setdefault(
1290
file_id, (tree_path, branch_location))
1291
target._set_all_reference_info(target_reference_dict)
1294
def check(self, refs):
1295
"""Check consistency of the branch.
1297
In particular this checks that revisions given in the revision-history
1298
do actually match up in the revision graph, and that they're all
1299
present in the repository.
1301
Callers will typically also want to check the repository.
1303
:param refs: Calculated refs for this branch as specified by
1304
branch._get_check_refs()
1305
:return: A BranchCheckResult.
1307
result = BranchCheckResult(self)
1308
last_revno, last_revision_id = self.last_revision_info()
1309
actual_revno = refs[('lefthand-distance', last_revision_id)]
1310
if actual_revno != last_revno:
1311
result.errors.append(errors.BzrCheckError(
1312
'revno does not match len(mainline) %s != %s' % (
1313
last_revno, actual_revno)))
1314
# TODO: We should probably also check that self.revision_history
1315
# matches the repository for older branch formats.
1316
# If looking for the code that cross-checks repository parents against
1317
# the iter_reverse_revision_history output, that is now a repository
1321
def _get_checkout_format(self):
1322
"""Return the most suitable metadir for a checkout of this branch.
1323
Weaves are used if this branch's repository uses weaves.
1325
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1326
from bzrlib.repofmt import weaverepo
1327
format = bzrdir.BzrDirMetaFormat1()
1328
format.repository_format = weaverepo.RepositoryFormat7()
1330
format = self.repository.bzrdir.checkout_metadir()
1331
format.set_branch_format(self._format)
1334
def create_clone_on_transport(self, to_transport, revision_id=None,
1335
stacked_on=None, create_prefix=False, use_existing_dir=False):
1336
"""Create a clone of this branch and its bzrdir.
1338
:param to_transport: The transport to clone onto.
1339
:param revision_id: The revision id to use as tip in the new branch.
1340
If None the tip is obtained from this branch.
1341
:param stacked_on: An optional URL to stack the clone on.
1342
:param create_prefix: Create any missing directories leading up to
1344
:param use_existing_dir: Use an existing directory if one exists.
1346
# XXX: Fix the bzrdir API to allow getting the branch back from the
1347
# clone call. Or something. 20090224 RBC/spiv.
1348
if revision_id is None:
1349
revision_id = self.last_revision()
1350
dir_to = self.bzrdir.clone_on_transport(to_transport,
1351
revision_id=revision_id, stacked_on=stacked_on,
1352
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1353
return dir_to.open_branch()
1355
def create_checkout(self, to_location, revision_id=None,
1356
lightweight=False, accelerator_tree=None,
1358
"""Create a checkout of a branch.
1360
:param to_location: The url to produce the checkout at
1361
:param revision_id: The revision to check out
1362
:param lightweight: If True, produce a lightweight checkout, otherwise,
1363
produce a bound branch (heavyweight checkout)
1364
:param accelerator_tree: A tree which can be used for retrieving file
1365
contents more quickly than the revision tree, i.e. a workingtree.
1366
The revision tree will be used for cases where accelerator_tree's
1367
content is different.
1368
:param hardlink: If true, hard-link files from accelerator_tree,
1370
:return: The tree of the created checkout
1372
t = transport.get_transport(to_location)
1375
format = self._get_checkout_format()
1376
checkout = format.initialize_on_transport(t)
1377
from_branch = BranchReferenceFormat().initialize(checkout,
1380
format = self._get_checkout_format()
1381
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1382
to_location, force_new_tree=False, format=format)
1383
checkout = checkout_branch.bzrdir
1384
checkout_branch.bind(self)
1385
# pull up to the specified revision_id to set the initial
1386
# branch tip correctly, and seed it with history.
1387
checkout_branch.pull(self, stop_revision=revision_id)
1389
tree = checkout.create_workingtree(revision_id,
1390
from_branch=from_branch,
1391
accelerator_tree=accelerator_tree,
1393
basis_tree = tree.basis_tree()
1394
basis_tree.lock_read()
1396
for path, file_id in basis_tree.iter_references():
1397
reference_parent = self.reference_parent(file_id, path)
1398
reference_parent.create_checkout(tree.abspath(path),
1399
basis_tree.get_reference_revision(file_id, path),
1406
def reconcile(self, thorough=True):
1407
"""Make sure the data stored in this branch is consistent."""
1408
from bzrlib.reconcile import BranchReconciler
1409
reconciler = BranchReconciler(self, thorough=thorough)
1410
reconciler.reconcile()
1413
def reference_parent(self, file_id, path, possible_transports=None):
1414
"""Return the parent branch for a tree-reference file_id
1415
:param file_id: The file_id of the tree reference
1416
:param path: The path of the file_id in the tree
1417
:return: A branch associated with the file_id
1419
# FIXME should provide multiple branches, based on config
1420
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1421
possible_transports=possible_transports)
1423
def supports_tags(self):
1424
return self._format.supports_tags()
1426
def automatic_tag_name(self, revision_id):
1427
"""Try to automatically find the tag name for a revision.
1429
:param revision_id: Revision id of the revision.
1430
:return: A tag name or None if no tag name could be determined.
1432
for hook in Branch.hooks['automatic_tag_name']:
1433
ret = hook(self, revision_id)
1438
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1440
"""Ensure that revision_b is a descendant of revision_a.
1442
This is a helper function for update_revisions.
1444
:raises: DivergedBranches if revision_b has diverged from revision_a.
1445
:returns: True if revision_b is a descendant of revision_a.
1447
relation = self._revision_relations(revision_a, revision_b, graph)
1448
if relation == 'b_descends_from_a':
1450
elif relation == 'diverged':
1451
raise errors.DivergedBranches(self, other_branch)
1452
elif relation == 'a_descends_from_b':
1455
raise AssertionError("invalid relation: %r" % (relation,))
1457
def _revision_relations(self, revision_a, revision_b, graph):
1458
"""Determine the relationship between two revisions.
1460
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1462
heads = graph.heads([revision_a, revision_b])
1463
if heads == set([revision_b]):
1464
return 'b_descends_from_a'
1465
elif heads == set([revision_a, revision_b]):
1466
# These branches have diverged
1468
elif heads == set([revision_a]):
1469
return 'a_descends_from_b'
1471
raise AssertionError("invalid heads: %r" % (heads,))
1474
class BranchFormat(object):
1475
"""An encapsulation of the initialization and open routines for a format.
1477
Formats provide three things:
1478
* An initialization routine,
1482
Formats are placed in an dict by their format string for reference
1483
during branch opening. Its not required that these be instances, they
1484
can be classes themselves with class methods - it simply depends on
1485
whether state is needed for a given format or not.
1487
Once a format is deprecated, just deprecate the initialize and open
1488
methods on the format class. Do not deprecate the object, as the
1489
object will be created every time regardless.
1492
_default_format = None
1493
"""The default format used for new branches."""
1496
"""The known formats."""
1498
can_set_append_revisions_only = True
1500
def __eq__(self, other):
1501
return self.__class__ is other.__class__
1503
def __ne__(self, other):
1504
return not (self == other)
1507
def find_format(klass, a_bzrdir, name=None):
1508
"""Return the format for the branch object in a_bzrdir."""
1510
transport = a_bzrdir.get_branch_transport(None, name=name)
1511
format_string = transport.get_bytes("format")
1512
return klass._formats[format_string]
1513
except errors.NoSuchFile:
1514
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1516
raise errors.UnknownFormatError(format=format_string, kind='branch')
1519
def get_default_format(klass):
1520
"""Return the current default format."""
1521
return klass._default_format
1523
def get_reference(self, a_bzrdir):
1524
"""Get the target reference of the branch in a_bzrdir.
1526
format probing must have been completed before calling
1527
this method - it is assumed that the format of the branch
1528
in a_bzrdir is correct.
1530
:param a_bzrdir: The bzrdir to get the branch data from.
1531
:return: None if the branch is not a reference branch.
1536
def set_reference(self, a_bzrdir, to_branch):
1537
"""Set the target reference of the branch in a_bzrdir.
1539
format probing must have been completed before calling
1540
this method - it is assumed that the format of the branch
1541
in a_bzrdir is correct.
1543
:param a_bzrdir: The bzrdir to set the branch reference for.
1544
:param to_branch: branch that the checkout is to reference
1546
raise NotImplementedError(self.set_reference)
1548
def get_format_string(self):
1549
"""Return the ASCII format string that identifies this format."""
1550
raise NotImplementedError(self.get_format_string)
1552
def get_format_description(self):
1553
"""Return the short format description for this format."""
1554
raise NotImplementedError(self.get_format_description)
1556
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1557
lock_type='metadir', set_format=True):
1558
"""Initialize a branch in a bzrdir, with specified files
1560
:param a_bzrdir: The bzrdir to initialize the branch in
1561
:param utf8_files: The files to create as a list of
1562
(filename, content) tuples
1563
:param name: Name of colocated branch to create, if any
1564
:param set_format: If True, set the format with
1565
self.get_format_string. (BzrBranch4 has its format set
1567
:return: a branch in this format
1569
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1570
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1572
'metadir': ('lock', lockdir.LockDir),
1573
'branch4': ('branch-lock', lockable_files.TransportLock),
1575
lock_name, lock_class = lock_map[lock_type]
1576
control_files = lockable_files.LockableFiles(branch_transport,
1577
lock_name, lock_class)
1578
control_files.create_lock()
1580
control_files.lock_write()
1581
except errors.LockContention:
1582
if lock_type != 'branch4':
1588
utf8_files += [('format', self.get_format_string())]
1590
for (filename, content) in utf8_files:
1591
branch_transport.put_bytes(
1593
mode=a_bzrdir._get_file_mode())
1596
control_files.unlock()
1597
return self.open(a_bzrdir, name, _found=True)
1599
def initialize(self, a_bzrdir, name=None):
1600
"""Create a branch of this format in a_bzrdir.
1602
:param name: Name of the colocated branch to create.
1604
raise NotImplementedError(self.initialize)
1606
def is_supported(self):
1607
"""Is this format supported?
1609
Supported formats can be initialized and opened.
1610
Unsupported formats may not support initialization or committing or
1611
some other features depending on the reason for not being supported.
1615
def make_tags(self, branch):
1616
"""Create a tags object for branch.
1618
This method is on BranchFormat, because BranchFormats are reflected
1619
over the wire via network_name(), whereas full Branch instances require
1620
multiple VFS method calls to operate at all.
1622
The default implementation returns a disabled-tags instance.
1624
Note that it is normal for branch to be a RemoteBranch when using tags
1627
return DisabledTags(branch)
1629
def network_name(self):
1630
"""A simple byte string uniquely identifying this format for RPC calls.
1632
MetaDir branch formats use their disk format string to identify the
1633
repository over the wire. All in one formats such as bzr < 0.8, and
1634
foreign formats like svn/git and hg should use some marker which is
1635
unique and immutable.
1637
raise NotImplementedError(self.network_name)
1639
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1640
"""Return the branch object for a_bzrdir
1642
:param a_bzrdir: A BzrDir that contains a branch.
1643
:param name: Name of colocated branch to open
1644
:param _found: a private parameter, do not use it. It is used to
1645
indicate if format probing has already be done.
1646
:param ignore_fallbacks: when set, no fallback branches will be opened
1647
(if there are any). Default is to open fallbacks.
1649
raise NotImplementedError(self.open)
1652
def register_format(klass, format):
1653
"""Register a metadir format."""
1654
klass._formats[format.get_format_string()] = format
1655
# Metadir formats have a network name of their format string, and get
1656
# registered as class factories.
1657
network_format_registry.register(format.get_format_string(), format.__class__)
1660
def set_default_format(klass, format):
1661
klass._default_format = format
1663
def supports_set_append_revisions_only(self):
1664
"""True if this format supports set_append_revisions_only."""
1667
def supports_stacking(self):
1668
"""True if this format records a stacked-on branch."""
1672
def unregister_format(klass, format):
1673
del klass._formats[format.get_format_string()]
1676
return self.get_format_description().rstrip()
1678
def supports_tags(self):
1679
"""True if this format supports tags stored in the branch"""
1680
return False # by default
1683
class BranchHooks(Hooks):
1684
"""A dictionary mapping hook name to a list of callables for branch hooks.
1686
e.g. ['set_rh'] Is the list of items to be called when the
1687
set_revision_history function is invoked.
1691
"""Create the default hooks.
1693
These are all empty initially, because by default nothing should get
1696
Hooks.__init__(self)
1697
self.create_hook(HookPoint('set_rh',
1698
"Invoked whenever the revision history has been set via "
1699
"set_revision_history. The api signature is (branch, "
1700
"revision_history), and the branch will be write-locked. "
1701
"The set_rh hook can be expensive for bzr to trigger, a better "
1702
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1703
self.create_hook(HookPoint('open',
1704
"Called with the Branch object that has been opened after a "
1705
"branch is opened.", (1, 8), None))
1706
self.create_hook(HookPoint('post_push',
1707
"Called after a push operation completes. post_push is called "
1708
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1709
"bzr client.", (0, 15), None))
1710
self.create_hook(HookPoint('post_pull',
1711
"Called after a pull operation completes. post_pull is called "
1712
"with a bzrlib.branch.PullResult object and only runs in the "
1713
"bzr client.", (0, 15), None))
1714
self.create_hook(HookPoint('pre_commit',
1715
"Called after a commit is calculated but before it is is "
1716
"completed. pre_commit is called with (local, master, old_revno, "
1717
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1718
"). old_revid is NULL_REVISION for the first commit to a branch, "
1719
"tree_delta is a TreeDelta object describing changes from the "
1720
"basis revision. hooks MUST NOT modify this delta. "
1721
" future_tree is an in-memory tree obtained from "
1722
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1723
"tree.", (0,91), None))
1724
self.create_hook(HookPoint('post_commit',
1725
"Called in the bzr client after a commit has completed. "
1726
"post_commit is called with (local, master, old_revno, old_revid, "
1727
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1728
"commit to a branch.", (0, 15), None))
1729
self.create_hook(HookPoint('post_uncommit',
1730
"Called in the bzr client after an uncommit completes. "
1731
"post_uncommit is called with (local, master, old_revno, "
1732
"old_revid, new_revno, new_revid) where local is the local branch "
1733
"or None, master is the target branch, and an empty branch "
1734
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1735
self.create_hook(HookPoint('pre_change_branch_tip',
1736
"Called in bzr client and server before a change to the tip of a "
1737
"branch is made. pre_change_branch_tip is called with a "
1738
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1739
"commit, uncommit will all trigger this hook.", (1, 6), None))
1740
self.create_hook(HookPoint('post_change_branch_tip',
1741
"Called in bzr client and server after a change to the tip of a "
1742
"branch is made. post_change_branch_tip is called with a "
1743
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1744
"commit, uncommit will all trigger this hook.", (1, 4), None))
1745
self.create_hook(HookPoint('transform_fallback_location',
1746
"Called when a stacked branch is activating its fallback "
1747
"locations. transform_fallback_location is called with (branch, "
1748
"url), and should return a new url. Returning the same url "
1749
"allows it to be used as-is, returning a different one can be "
1750
"used to cause the branch to stack on a closer copy of that "
1751
"fallback_location. Note that the branch cannot have history "
1752
"accessing methods called on it during this hook because the "
1753
"fallback locations have not been activated. When there are "
1754
"multiple hooks installed for transform_fallback_location, "
1755
"all are called with the url returned from the previous hook."
1756
"The order is however undefined.", (1, 9), None))
1757
self.create_hook(HookPoint('automatic_tag_name',
1758
"Called to determine an automatic tag name for a revision."
1759
"automatic_tag_name is called with (branch, revision_id) and "
1760
"should return a tag name or None if no tag name could be "
1761
"determined. The first non-None tag name returned will be used.",
1766
# install the default hooks into the Branch class.
1767
Branch.hooks = BranchHooks()
1770
class ChangeBranchTipParams(object):
1771
"""Object holding parameters passed to *_change_branch_tip hooks.
1773
There are 5 fields that hooks may wish to access:
1775
:ivar branch: the branch being changed
1776
:ivar old_revno: revision number before the change
1777
:ivar new_revno: revision number after the change
1778
:ivar old_revid: revision id before the change
1779
:ivar new_revid: revision id after the change
1781
The revid fields are strings. The revno fields are integers.
1784
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1785
"""Create a group of ChangeBranchTip parameters.
1787
:param branch: The branch being changed.
1788
:param old_revno: Revision number before the change.
1789
:param new_revno: Revision number after the change.
1790
:param old_revid: Tip revision id before the change.
1791
:param new_revid: Tip revision id after the change.
1793
self.branch = branch
1794
self.old_revno = old_revno
1795
self.new_revno = new_revno
1796
self.old_revid = old_revid
1797
self.new_revid = new_revid
1799
def __eq__(self, other):
1800
return self.__dict__ == other.__dict__
1803
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1804
self.__class__.__name__, self.branch,
1805
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1808
class BzrBranchFormat4(BranchFormat):
1809
"""Bzr branch format 4.
1812
- a revision-history file.
1813
- a branch-lock lock file [ to be shared with the bzrdir ]
1816
def get_format_description(self):
1817
"""See BranchFormat.get_format_description()."""
1818
return "Branch format 4"
1820
def initialize(self, a_bzrdir, name=None):
1821
"""Create a branch of this format in a_bzrdir."""
1822
utf8_files = [('revision-history', ''),
1823
('branch-name', ''),
1825
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1826
lock_type='branch4', set_format=False)
1829
super(BzrBranchFormat4, self).__init__()
1830
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1832
def network_name(self):
1833
"""The network name for this format is the control dirs disk label."""
1834
return self._matchingbzrdir.get_format_string()
1836
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1837
"""See BranchFormat.open()."""
1839
# we are being called directly and must probe.
1840
raise NotImplementedError
1841
return BzrBranch(_format=self,
1842
_control_files=a_bzrdir._control_files,
1845
_repository=a_bzrdir.open_repository())
1848
return "Bazaar-NG branch format 4"
1851
class BranchFormatMetadir(BranchFormat):
1852
"""Common logic for meta-dir based branch formats."""
1854
def _branch_class(self):
1855
"""What class to instantiate on open calls."""
1856
raise NotImplementedError(self._branch_class)
1858
def network_name(self):
1859
"""A simple byte string uniquely identifying this format for RPC calls.
1861
Metadir branch formats use their format string.
1863
return self.get_format_string()
1865
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1866
"""See BranchFormat.open()."""
1868
format = BranchFormat.find_format(a_bzrdir, name=name)
1869
if format.__class__ != self.__class__:
1870
raise AssertionError("wrong format %r found for %r" %
1873
transport = a_bzrdir.get_branch_transport(None, name=name)
1874
control_files = lockable_files.LockableFiles(transport, 'lock',
1876
return self._branch_class()(_format=self,
1877
_control_files=control_files,
1880
_repository=a_bzrdir.find_repository(),
1881
ignore_fallbacks=ignore_fallbacks)
1882
except errors.NoSuchFile:
1883
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1886
super(BranchFormatMetadir, self).__init__()
1887
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1888
self._matchingbzrdir.set_branch_format(self)
1890
def supports_tags(self):
1894
class BzrBranchFormat5(BranchFormatMetadir):
1895
"""Bzr branch format 5.
1898
- a revision-history file.
1900
- a lock dir guarding the branch itself
1901
- all of this stored in a branch/ subdirectory
1902
- works with shared repositories.
1904
This format is new in bzr 0.8.
1907
def _branch_class(self):
1910
def get_format_string(self):
1911
"""See BranchFormat.get_format_string()."""
1912
return "Bazaar-NG branch format 5\n"
1914
def get_format_description(self):
1915
"""See BranchFormat.get_format_description()."""
1916
return "Branch format 5"
1918
def initialize(self, a_bzrdir, name=None):
1919
"""Create a branch of this format in a_bzrdir."""
1920
utf8_files = [('revision-history', ''),
1921
('branch-name', ''),
1923
return self._initialize_helper(a_bzrdir, utf8_files, name)
1925
def supports_tags(self):
1929
class BzrBranchFormat6(BranchFormatMetadir):
1930
"""Branch format with last-revision and tags.
1932
Unlike previous formats, this has no explicit revision history. Instead,
1933
this just stores the last-revision, and the left-hand history leading
1934
up to there is the history.
1936
This format was introduced in bzr 0.15
1937
and became the default in 0.91.
1940
def _branch_class(self):
1943
def get_format_string(self):
1944
"""See BranchFormat.get_format_string()."""
1945
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1947
def get_format_description(self):
1948
"""See BranchFormat.get_format_description()."""
1949
return "Branch format 6"
1951
def initialize(self, a_bzrdir, name=None):
1952
"""Create a branch of this format in a_bzrdir."""
1953
utf8_files = [('last-revision', '0 null:\n'),
1954
('branch.conf', ''),
1957
return self._initialize_helper(a_bzrdir, utf8_files, name)
1959
def make_tags(self, branch):
1960
"""See bzrlib.branch.BranchFormat.make_tags()."""
1961
return BasicTags(branch)
1963
def supports_set_append_revisions_only(self):
1967
class BzrBranchFormat8(BranchFormatMetadir):
1968
"""Metadir format supporting storing locations of subtree branches."""
1970
def _branch_class(self):
1973
def get_format_string(self):
1974
"""See BranchFormat.get_format_string()."""
1975
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1977
def get_format_description(self):
1978
"""See BranchFormat.get_format_description()."""
1979
return "Branch format 8"
1981
def initialize(self, a_bzrdir, name=None):
1982
"""Create a branch of this format in a_bzrdir."""
1983
utf8_files = [('last-revision', '0 null:\n'),
1984
('branch.conf', ''),
1988
return self._initialize_helper(a_bzrdir, utf8_files, name)
1991
super(BzrBranchFormat8, self).__init__()
1992
self._matchingbzrdir.repository_format = \
1993
RepositoryFormatKnitPack5RichRoot()
1995
def make_tags(self, branch):
1996
"""See bzrlib.branch.BranchFormat.make_tags()."""
1997
return BasicTags(branch)
1999
def supports_set_append_revisions_only(self):
2002
def supports_stacking(self):
2005
supports_reference_locations = True
2008
class BzrBranchFormat7(BzrBranchFormat8):
2009
"""Branch format with last-revision, tags, and a stacked location pointer.
2011
The stacked location pointer is passed down to the repository and requires
2012
a repository format with supports_external_lookups = True.
2014
This format was introduced in bzr 1.6.
2017
def initialize(self, a_bzrdir, name=None):
2018
"""Create a branch of this format in a_bzrdir."""
2019
utf8_files = [('last-revision', '0 null:\n'),
2020
('branch.conf', ''),
2023
return self._initialize_helper(a_bzrdir, utf8_files, name)
2025
def _branch_class(self):
2028
def get_format_string(self):
2029
"""See BranchFormat.get_format_string()."""
2030
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2032
def get_format_description(self):
2033
"""See BranchFormat.get_format_description()."""
2034
return "Branch format 7"
2036
def supports_set_append_revisions_only(self):
2039
supports_reference_locations = False
2042
class BranchReferenceFormat(BranchFormat):
2043
"""Bzr branch reference format.
2045
Branch references are used in implementing checkouts, they
2046
act as an alias to the real branch which is at some other url.
2053
def get_format_string(self):
2054
"""See BranchFormat.get_format_string()."""
2055
return "Bazaar-NG Branch Reference Format 1\n"
2057
def get_format_description(self):
2058
"""See BranchFormat.get_format_description()."""
2059
return "Checkout reference format 1"
2061
def get_reference(self, a_bzrdir):
2062
"""See BranchFormat.get_reference()."""
2063
transport = a_bzrdir.get_branch_transport(None)
2064
return transport.get_bytes('location')
2066
def set_reference(self, a_bzrdir, to_branch):
2067
"""See BranchFormat.set_reference()."""
2068
transport = a_bzrdir.get_branch_transport(None)
2069
location = transport.put_bytes('location', to_branch.base)
2071
def initialize(self, a_bzrdir, name=None, target_branch=None):
2072
"""Create a branch of this format in a_bzrdir."""
2073
if target_branch is None:
2074
# this format does not implement branch itself, thus the implicit
2075
# creation contract must see it as uninitializable
2076
raise errors.UninitializableFormat(self)
2077
mutter('creating branch reference in %s', a_bzrdir.transport.base)
2078
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2079
branch_transport.put_bytes('location',
2080
target_branch.bzrdir.root_transport.base)
2081
branch_transport.put_bytes('format', self.get_format_string())
2083
a_bzrdir, name, _found=True,
2084
possible_transports=[target_branch.bzrdir.root_transport])
2087
super(BranchReferenceFormat, self).__init__()
2088
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2089
self._matchingbzrdir.set_branch_format(self)
2091
def _make_reference_clone_function(format, a_branch):
2092
"""Create a clone() routine for a branch dynamically."""
2093
def clone(to_bzrdir, revision_id=None,
2094
repository_policy=None):
2095
"""See Branch.clone()."""
2096
return format.initialize(to_bzrdir, target_branch=a_branch)
2097
# cannot obey revision_id limits when cloning a reference ...
2098
# FIXME RBC 20060210 either nuke revision_id for clone, or
2099
# emit some sort of warning/error to the caller ?!
2102
def open(self, a_bzrdir, name=None, _found=False, location=None,
2103
possible_transports=None, ignore_fallbacks=False):
2104
"""Return the branch that the branch reference in a_bzrdir points at.
2106
:param a_bzrdir: A BzrDir that contains a branch.
2107
:param name: Name of colocated branch to open, if any
2108
:param _found: a private parameter, do not use it. It is used to
2109
indicate if format probing has already be done.
2110
:param ignore_fallbacks: when set, no fallback branches will be opened
2111
(if there are any). Default is to open fallbacks.
2112
:param location: The location of the referenced branch. If
2113
unspecified, this will be determined from the branch reference in
2115
:param possible_transports: An optional reusable transports list.
2118
format = BranchFormat.find_format(a_bzrdir, name=name)
2119
if format.__class__ != self.__class__:
2120
raise AssertionError("wrong format %r found for %r" %
2122
if location is None:
2123
location = self.get_reference(a_bzrdir)
2124
real_bzrdir = bzrdir.BzrDir.open(
2125
location, possible_transports=possible_transports)
2126
result = real_bzrdir.open_branch(name=name,
2127
ignore_fallbacks=ignore_fallbacks)
2128
# this changes the behaviour of result.clone to create a new reference
2129
# rather than a copy of the content of the branch.
2130
# I did not use a proxy object because that needs much more extensive
2131
# testing, and we are only changing one behaviour at the moment.
2132
# If we decide to alter more behaviours - i.e. the implicit nickname
2133
# then this should be refactored to introduce a tested proxy branch
2134
# and a subclass of that for use in overriding clone() and ....
2136
result.clone = self._make_reference_clone_function(result)
2140
network_format_registry = registry.FormatRegistry()
2141
"""Registry of formats indexed by their network name.
2143
The network name for a branch format is an identifier that can be used when
2144
referring to formats with smart server operations. See
2145
BranchFormat.network_name() for more detail.
2149
# formats which have no format string are not discoverable
2150
# and not independently creatable, so are not registered.
2151
__format5 = BzrBranchFormat5()
2152
__format6 = BzrBranchFormat6()
2153
__format7 = BzrBranchFormat7()
2154
__format8 = BzrBranchFormat8()
2155
BranchFormat.register_format(__format5)
2156
BranchFormat.register_format(BranchReferenceFormat())
2157
BranchFormat.register_format(__format6)
2158
BranchFormat.register_format(__format7)
2159
BranchFormat.register_format(__format8)
2160
BranchFormat.set_default_format(__format7)
2161
_legacy_formats = [BzrBranchFormat4(),
2163
network_format_registry.register(
2164
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2167
class BzrBranch(Branch, _RelockDebugMixin):
2168
"""A branch stored in the actual filesystem.
2170
Note that it's "local" in the context of the filesystem; it doesn't
2171
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2172
it's writable, and can be accessed via the normal filesystem API.
2174
:ivar _transport: Transport for file operations on this branch's
2175
control files, typically pointing to the .bzr/branch directory.
2176
:ivar repository: Repository for this branch.
2177
:ivar base: The url of the base directory for this branch; the one
2178
containing the .bzr directory.
2179
:ivar name: Optional colocated branch name as it exists in the control
2183
def __init__(self, _format=None,
2184
_control_files=None, a_bzrdir=None, name=None,
2185
_repository=None, ignore_fallbacks=False):
2186
"""Create new branch object at a particular location."""
2187
if a_bzrdir is None:
2188
raise ValueError('a_bzrdir must be supplied')
2190
self.bzrdir = a_bzrdir
2191
self._base = self.bzrdir.transport.clone('..').base
2193
# XXX: We should be able to just do
2194
# self.base = self.bzrdir.root_transport.base
2195
# but this does not quite work yet -- mbp 20080522
2196
self._format = _format
2197
if _control_files is None:
2198
raise ValueError('BzrBranch _control_files is None')
2199
self.control_files = _control_files
2200
self._transport = _control_files._transport
2201
self.repository = _repository
2202
Branch.__init__(self)
2205
if self.name is None:
2206
return '%s(%r)' % (self.__class__.__name__, self.base)
2208
return '%s(%r,%r)' % (self.__class__.__name__, self.base, self.name)
2212
def _get_base(self):
2213
"""Returns the directory containing the control directory."""
2216
base = property(_get_base, doc="The URL for the root of this branch.")
2218
def _get_config(self):
2219
return TransportConfig(self._transport, 'branch.conf')
2221
def is_locked(self):
2222
return self.control_files.is_locked()
2224
def lock_write(self, token=None):
2225
if not self.is_locked():
2226
self._note_lock('w')
2227
# All-in-one needs to always unlock/lock.
2228
repo_control = getattr(self.repository, 'control_files', None)
2229
if self.control_files == repo_control or not self.is_locked():
2230
self.repository._warn_if_deprecated(self)
2231
self.repository.lock_write()
2236
return self.control_files.lock_write(token=token)
2239
self.repository.unlock()
2242
def lock_read(self):
2243
if not self.is_locked():
2244
self._note_lock('r')
2245
# All-in-one needs to always unlock/lock.
2246
repo_control = getattr(self.repository, 'control_files', None)
2247
if self.control_files == repo_control or not self.is_locked():
2248
self.repository._warn_if_deprecated(self)
2249
self.repository.lock_read()
2254
self.control_files.lock_read()
2257
self.repository.unlock()
2260
@only_raises(errors.LockNotHeld, errors.LockBroken)
2263
self.control_files.unlock()
2265
# All-in-one needs to always unlock/lock.
2266
repo_control = getattr(self.repository, 'control_files', None)
2267
if (self.control_files == repo_control or
2268
not self.control_files.is_locked()):
2269
self.repository.unlock()
2270
if not self.control_files.is_locked():
2271
# we just released the lock
2272
self._clear_cached_state()
2274
def peek_lock_mode(self):
2275
if self.control_files._lock_count == 0:
2278
return self.control_files._lock_mode
2280
def get_physical_lock_status(self):
2281
return self.control_files.get_physical_lock_status()
2284
def print_file(self, file, revision_id):
2285
"""See Branch.print_file."""
2286
return self.repository.print_file(file, revision_id)
2288
def _write_revision_history(self, history):
2289
"""Factored out of set_revision_history.
2291
This performs the actual writing to disk.
2292
It is intended to be called by BzrBranch5.set_revision_history."""
2293
self._transport.put_bytes(
2294
'revision-history', '\n'.join(history),
2295
mode=self.bzrdir._get_file_mode())
2298
def set_revision_history(self, rev_history):
2299
"""See Branch.set_revision_history."""
2300
if 'evil' in debug.debug_flags:
2301
mutter_callsite(3, "set_revision_history scales with history.")
2302
check_not_reserved_id = _mod_revision.check_not_reserved_id
2303
for rev_id in rev_history:
2304
check_not_reserved_id(rev_id)
2305
if Branch.hooks['post_change_branch_tip']:
2306
# Don't calculate the last_revision_info() if there are no hooks
2308
old_revno, old_revid = self.last_revision_info()
2309
if len(rev_history) == 0:
2310
revid = _mod_revision.NULL_REVISION
2312
revid = rev_history[-1]
2313
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2314
self._write_revision_history(rev_history)
2315
self._clear_cached_state()
2316
self._cache_revision_history(rev_history)
2317
for hook in Branch.hooks['set_rh']:
2318
hook(self, rev_history)
2319
if Branch.hooks['post_change_branch_tip']:
2320
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2322
def _synchronize_history(self, destination, revision_id):
2323
"""Synchronize last revision and revision history between branches.
2325
This version is most efficient when the destination is also a
2326
BzrBranch5, but works for BzrBranch6 as long as the revision
2327
history is the true lefthand parent history, and all of the revisions
2328
are in the destination's repository. If not, set_revision_history
2331
:param destination: The branch to copy the history into
2332
:param revision_id: The revision-id to truncate history at. May
2333
be None to copy complete history.
2335
if not isinstance(destination._format, BzrBranchFormat5):
2336
super(BzrBranch, self)._synchronize_history(
2337
destination, revision_id)
2339
if revision_id == _mod_revision.NULL_REVISION:
2342
new_history = self.revision_history()
2343
if revision_id is not None and new_history != []:
2345
new_history = new_history[:new_history.index(revision_id) + 1]
2347
rev = self.repository.get_revision(revision_id)
2348
new_history = rev.get_history(self.repository)[1:]
2349
destination.set_revision_history(new_history)
2352
def set_last_revision_info(self, revno, revision_id):
2353
"""Set the last revision of this branch.
2355
The caller is responsible for checking that the revno is correct
2356
for this revision id.
2358
It may be possible to set the branch last revision to an id not
2359
present in the repository. However, branches can also be
2360
configured to check constraints on history, in which case this may not
2363
revision_id = _mod_revision.ensure_null(revision_id)
2364
# this old format stores the full history, but this api doesn't
2365
# provide it, so we must generate, and might as well check it's
2367
history = self._lefthand_history(revision_id)
2368
if len(history) != revno:
2369
raise AssertionError('%d != %d' % (len(history), revno))
2370
self.set_revision_history(history)
2372
def _gen_revision_history(self):
2373
history = self._transport.get_bytes('revision-history').split('\n')
2374
if history[-1:] == ['']:
2375
# There shouldn't be a trailing newline, but just in case.
2380
def generate_revision_history(self, revision_id, last_rev=None,
2382
"""Create a new revision history that will finish with revision_id.
2384
:param revision_id: the new tip to use.
2385
:param last_rev: The previous last_revision. If not None, then this
2386
must be a ancestory of revision_id, or DivergedBranches is raised.
2387
:param other_branch: The other branch that DivergedBranches should
2388
raise with respect to.
2390
self.set_revision_history(self._lefthand_history(revision_id,
2391
last_rev, other_branch))
2393
def basis_tree(self):
2394
"""See Branch.basis_tree."""
2395
return self.repository.revision_tree(self.last_revision())
2397
def _get_parent_location(self):
2398
_locs = ['parent', 'pull', 'x-pull']
2401
return self._transport.get_bytes(l).strip('\n')
2402
except errors.NoSuchFile:
2406
def _basic_push(self, target, overwrite, stop_revision):
2407
"""Basic implementation of push without bound branches or hooks.
2409
Must be called with source read locked and target write locked.
2411
result = BranchPushResult()
2412
result.source_branch = self
2413
result.target_branch = target
2414
result.old_revno, result.old_revid = target.last_revision_info()
2415
self.update_references(target)
2416
if result.old_revid != self.last_revision():
2417
# We assume that during 'push' this repository is closer than
2419
graph = self.repository.get_graph(target.repository)
2420
target.update_revisions(self, stop_revision,
2421
overwrite=overwrite, graph=graph)
2422
if self._push_should_merge_tags():
2423
result.tag_conflicts = self.tags.merge_to(target.tags,
2425
result.new_revno, result.new_revid = target.last_revision_info()
2428
def get_stacked_on_url(self):
2429
raise errors.UnstackableBranchFormat(self._format, self.base)
2431
def set_push_location(self, location):
2432
"""See Branch.set_push_location."""
2433
self.get_config().set_user_option(
2434
'push_location', location,
2435
store=_mod_config.STORE_LOCATION_NORECURSE)
2437
def _set_parent_location(self, url):
2439
self._transport.delete('parent')
2441
self._transport.put_bytes('parent', url + '\n',
2442
mode=self.bzrdir._get_file_mode())
2445
class BzrBranch5(BzrBranch):
2446
"""A format 5 branch. This supports new features over plain branches.
2448
It has support for a master_branch which is the data for bound branches.
2451
def get_bound_location(self):
2453
return self._transport.get_bytes('bound')[:-1]
2454
except errors.NoSuchFile:
2458
def get_master_branch(self, possible_transports=None):
2459
"""Return the branch we are bound to.
2461
:return: Either a Branch, or None
2463
This could memoise the branch, but if thats done
2464
it must be revalidated on each new lock.
2465
So for now we just don't memoise it.
2466
# RBC 20060304 review this decision.
2468
bound_loc = self.get_bound_location()
2472
return Branch.open(bound_loc,
2473
possible_transports=possible_transports)
2474
except (errors.NotBranchError, errors.ConnectionError), e:
2475
raise errors.BoundBranchConnectionFailure(
2479
def set_bound_location(self, location):
2480
"""Set the target where this branch is bound to.
2482
:param location: URL to the target branch
2485
self._transport.put_bytes('bound', location+'\n',
2486
mode=self.bzrdir._get_file_mode())
2489
self._transport.delete('bound')
2490
except errors.NoSuchFile:
2495
def bind(self, other):
2496
"""Bind this branch to the branch other.
2498
This does not push or pull data between the branches, though it does
2499
check for divergence to raise an error when the branches are not
2500
either the same, or one a prefix of the other. That behaviour may not
2501
be useful, so that check may be removed in future.
2503
:param other: The branch to bind to
2506
# TODO: jam 20051230 Consider checking if the target is bound
2507
# It is debatable whether you should be able to bind to
2508
# a branch which is itself bound.
2509
# Committing is obviously forbidden,
2510
# but binding itself may not be.
2511
# Since we *have* to check at commit time, we don't
2512
# *need* to check here
2514
# we want to raise diverged if:
2515
# last_rev is not in the other_last_rev history, AND
2516
# other_last_rev is not in our history, and do it without pulling
2518
self.set_bound_location(other.base)
2522
"""If bound, unbind"""
2523
return self.set_bound_location(None)
2526
def update(self, possible_transports=None):
2527
"""Synchronise this branch with the master branch if any.
2529
:return: None or the last_revision that was pivoted out during the
2532
master = self.get_master_branch(possible_transports)
2533
if master is not None:
2534
old_tip = _mod_revision.ensure_null(self.last_revision())
2535
self.pull(master, overwrite=True)
2536
if self.repository.get_graph().is_ancestor(old_tip,
2537
_mod_revision.ensure_null(self.last_revision())):
2543
class BzrBranch8(BzrBranch5):
2544
"""A branch that stores tree-reference locations."""
2546
def _open_hook(self):
2547
if self._ignore_fallbacks:
2550
url = self.get_stacked_on_url()
2551
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2552
errors.UnstackableBranchFormat):
2555
for hook in Branch.hooks['transform_fallback_location']:
2556
url = hook(self, url)
2558
hook_name = Branch.hooks.get_hook_name(hook)
2559
raise AssertionError(
2560
"'transform_fallback_location' hook %s returned "
2561
"None, not a URL." % hook_name)
2562
self._activate_fallback_location(url)
2564
def __init__(self, *args, **kwargs):
2565
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2566
super(BzrBranch8, self).__init__(*args, **kwargs)
2567
self._last_revision_info_cache = None
2568
self._reference_info = None
2570
def _clear_cached_state(self):
2571
super(BzrBranch8, self)._clear_cached_state()
2572
self._last_revision_info_cache = None
2573
self._reference_info = None
2575
def _last_revision_info(self):
2576
revision_string = self._transport.get_bytes('last-revision')
2577
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2578
revision_id = cache_utf8.get_cached_utf8(revision_id)
2580
return revno, revision_id
2582
def _write_last_revision_info(self, revno, revision_id):
2583
"""Simply write out the revision id, with no checks.
2585
Use set_last_revision_info to perform this safely.
2587
Does not update the revision_history cache.
2588
Intended to be called by set_last_revision_info and
2589
_write_revision_history.
2591
revision_id = _mod_revision.ensure_null(revision_id)
2592
out_string = '%d %s\n' % (revno, revision_id)
2593
self._transport.put_bytes('last-revision', out_string,
2594
mode=self.bzrdir._get_file_mode())
2597
def set_last_revision_info(self, revno, revision_id):
2598
revision_id = _mod_revision.ensure_null(revision_id)
2599
old_revno, old_revid = self.last_revision_info()
2600
if self._get_append_revisions_only():
2601
self._check_history_violation(revision_id)
2602
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2603
self._write_last_revision_info(revno, revision_id)
2604
self._clear_cached_state()
2605
self._last_revision_info_cache = revno, revision_id
2606
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2608
def _synchronize_history(self, destination, revision_id):
2609
"""Synchronize last revision and revision history between branches.
2611
:see: Branch._synchronize_history
2613
# XXX: The base Branch has a fast implementation of this method based
2614
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2615
# that uses set_revision_history. This class inherits from BzrBranch5,
2616
# but wants the fast implementation, so it calls
2617
# Branch._synchronize_history directly.
2618
Branch._synchronize_history(self, destination, revision_id)
2620
def _check_history_violation(self, revision_id):
2621
last_revision = _mod_revision.ensure_null(self.last_revision())
2622
if _mod_revision.is_null(last_revision):
2624
if last_revision not in self._lefthand_history(revision_id):
2625
raise errors.AppendRevisionsOnlyViolation(self.base)
2627
def _gen_revision_history(self):
2628
"""Generate the revision history from last revision
2630
last_revno, last_revision = self.last_revision_info()
2631
self._extend_partial_history(stop_index=last_revno-1)
2632
return list(reversed(self._partial_revision_history_cache))
2634
def _write_revision_history(self, history):
2635
"""Factored out of set_revision_history.
2637
This performs the actual writing to disk, with format-specific checks.
2638
It is intended to be called by BzrBranch5.set_revision_history.
2640
if len(history) == 0:
2641
last_revision = 'null:'
2643
if history != self._lefthand_history(history[-1]):
2644
raise errors.NotLefthandHistory(history)
2645
last_revision = history[-1]
2646
if self._get_append_revisions_only():
2647
self._check_history_violation(last_revision)
2648
self._write_last_revision_info(len(history), last_revision)
2651
def _set_parent_location(self, url):
2652
"""Set the parent branch"""
2653
self._set_config_location('parent_location', url, make_relative=True)
2656
def _get_parent_location(self):
2657
"""Set the parent branch"""
2658
return self._get_config_location('parent_location')
2661
def _set_all_reference_info(self, info_dict):
2662
"""Replace all reference info stored in a branch.
2664
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2667
writer = rio.RioWriter(s)
2668
for key, (tree_path, branch_location) in info_dict.iteritems():
2669
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2670
branch_location=branch_location)
2671
writer.write_stanza(stanza)
2672
self._transport.put_bytes('references', s.getvalue())
2673
self._reference_info = info_dict
2676
def _get_all_reference_info(self):
2677
"""Return all the reference info stored in a branch.
2679
:return: A dict of {file_id: (tree_path, branch_location)}
2681
if self._reference_info is not None:
2682
return self._reference_info
2683
rio_file = self._transport.get('references')
2685
stanzas = rio.read_stanzas(rio_file)
2686
info_dict = dict((s['file_id'], (s['tree_path'],
2687
s['branch_location'])) for s in stanzas)
2690
self._reference_info = info_dict
2693
def set_reference_info(self, file_id, tree_path, branch_location):
2694
"""Set the branch location to use for a tree reference.
2696
:param file_id: The file-id of the tree reference.
2697
:param tree_path: The path of the tree reference in the tree.
2698
:param branch_location: The location of the branch to retrieve tree
2701
info_dict = self._get_all_reference_info()
2702
info_dict[file_id] = (tree_path, branch_location)
2703
if None in (tree_path, branch_location):
2704
if tree_path is not None:
2705
raise ValueError('tree_path must be None when branch_location'
2707
if branch_location is not None:
2708
raise ValueError('branch_location must be None when tree_path'
2710
del info_dict[file_id]
2711
self._set_all_reference_info(info_dict)
2713
def get_reference_info(self, file_id):
2714
"""Get the tree_path and branch_location for a tree reference.
2716
:return: a tuple of (tree_path, branch_location)
2718
return self._get_all_reference_info().get(file_id, (None, None))
2720
def reference_parent(self, file_id, path, possible_transports=None):
2721
"""Return the parent branch for a tree-reference file_id.
2723
:param file_id: The file_id of the tree reference
2724
:param path: The path of the file_id in the tree
2725
:return: A branch associated with the file_id
2727
branch_location = self.get_reference_info(file_id)[1]
2728
if branch_location is None:
2729
return Branch.reference_parent(self, file_id, path,
2730
possible_transports)
2731
branch_location = urlutils.join(self.base, branch_location)
2732
return Branch.open(branch_location,
2733
possible_transports=possible_transports)
2735
def set_push_location(self, location):
2736
"""See Branch.set_push_location."""
2737
self._set_config_location('push_location', location)
2739
def set_bound_location(self, location):
2740
"""See Branch.set_push_location."""
2742
config = self.get_config()
2743
if location is None:
2744
if config.get_user_option('bound') != 'True':
2747
config.set_user_option('bound', 'False', warn_masked=True)
2750
self._set_config_location('bound_location', location,
2752
config.set_user_option('bound', 'True', warn_masked=True)
2755
def _get_bound_location(self, bound):
2756
"""Return the bound location in the config file.
2758
Return None if the bound parameter does not match"""
2759
config = self.get_config()
2760
config_bound = (config.get_user_option('bound') == 'True')
2761
if config_bound != bound:
2763
return self._get_config_location('bound_location', config=config)
2765
def get_bound_location(self):
2766
"""See Branch.set_push_location."""
2767
return self._get_bound_location(True)
2769
def get_old_bound_location(self):
2770
"""See Branch.get_old_bound_location"""
2771
return self._get_bound_location(False)
2773
def get_stacked_on_url(self):
2774
# you can always ask for the URL; but you might not be able to use it
2775
# if the repo can't support stacking.
2776
## self._check_stackable_repo()
2777
stacked_url = self._get_config_location('stacked_on_location')
2778
if stacked_url is None:
2779
raise errors.NotStacked(self)
2782
def _get_append_revisions_only(self):
2783
value = self.get_config().get_user_option('append_revisions_only')
2784
return value == 'True'
2787
def generate_revision_history(self, revision_id, last_rev=None,
2789
"""See BzrBranch5.generate_revision_history"""
2790
history = self._lefthand_history(revision_id, last_rev, other_branch)
2791
revno = len(history)
2792
self.set_last_revision_info(revno, revision_id)
2795
def get_rev_id(self, revno, history=None):
2796
"""Find the revision id of the specified revno."""
2798
return _mod_revision.NULL_REVISION
2800
last_revno, last_revision_id = self.last_revision_info()
2801
if revno <= 0 or revno > last_revno:
2802
raise errors.NoSuchRevision(self, revno)
2804
if history is not None:
2805
return history[revno - 1]
2807
index = last_revno - revno
2808
if len(self._partial_revision_history_cache) <= index:
2809
self._extend_partial_history(stop_index=index)
2810
if len(self._partial_revision_history_cache) > index:
2811
return self._partial_revision_history_cache[index]
2813
raise errors.NoSuchRevision(self, revno)
2816
def revision_id_to_revno(self, revision_id):
2817
"""Given a revision id, return its revno"""
2818
if _mod_revision.is_null(revision_id):
2821
index = self._partial_revision_history_cache.index(revision_id)
2823
self._extend_partial_history(stop_revision=revision_id)
2824
index = len(self._partial_revision_history_cache) - 1
2825
if self._partial_revision_history_cache[index] != revision_id:
2826
raise errors.NoSuchRevision(self, revision_id)
2827
return self.revno() - index
2830
class BzrBranch7(BzrBranch8):
2831
"""A branch with support for a fallback repository."""
2833
def set_reference_info(self, file_id, tree_path, branch_location):
2834
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2836
def get_reference_info(self, file_id):
2837
Branch.get_reference_info(self, file_id)
2839
def reference_parent(self, file_id, path, possible_transports=None):
2840
return Branch.reference_parent(self, file_id, path,
2841
possible_transports)
2844
class BzrBranch6(BzrBranch7):
2845
"""See BzrBranchFormat6 for the capabilities of this branch.
2847
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2851
def get_stacked_on_url(self):
2852
raise errors.UnstackableBranchFormat(self._format, self.base)
2855
######################################################################
2856
# results of operations
2859
class _Result(object):
2861
def _show_tag_conficts(self, to_file):
2862
if not getattr(self, 'tag_conflicts', None):
2864
to_file.write('Conflicting tags:\n')
2865
for name, value1, value2 in self.tag_conflicts:
2866
to_file.write(' %s\n' % (name, ))
2869
class PullResult(_Result):
2870
"""Result of a Branch.pull operation.
2872
:ivar old_revno: Revision number before pull.
2873
:ivar new_revno: Revision number after pull.
2874
:ivar old_revid: Tip revision id before pull.
2875
:ivar new_revid: Tip revision id after pull.
2876
:ivar source_branch: Source (local) branch object. (read locked)
2877
:ivar master_branch: Master branch of the target, or the target if no
2879
:ivar local_branch: target branch if there is a Master, else None
2880
:ivar target_branch: Target/destination branch object. (write locked)
2881
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2885
# DEPRECATED: pull used to return the change in revno
2886
return self.new_revno - self.old_revno
2888
def report(self, to_file):
2890
if self.old_revid == self.new_revid:
2891
to_file.write('No revisions to pull.\n')
2893
to_file.write('Now on revision %d.\n' % self.new_revno)
2894
self._show_tag_conficts(to_file)
2897
class BranchPushResult(_Result):
2898
"""Result of a Branch.push operation.
2900
:ivar old_revno: Revision number (eg 10) of the target before push.
2901
:ivar new_revno: Revision number (eg 12) of the target after push.
2902
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2904
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2906
:ivar source_branch: Source branch object that the push was from. This is
2907
read locked, and generally is a local (and thus low latency) branch.
2908
:ivar master_branch: If target is a bound branch, the master branch of
2909
target, or target itself. Always write locked.
2910
:ivar target_branch: The direct Branch where data is being sent (write
2912
:ivar local_branch: If the target is a bound branch this will be the
2913
target, otherwise it will be None.
2917
# DEPRECATED: push used to return the change in revno
2918
return self.new_revno - self.old_revno
2920
def report(self, to_file):
2921
"""Write a human-readable description of the result."""
2922
if self.old_revid == self.new_revid:
2923
note('No new revisions to push.')
2925
note('Pushed up to revision %d.' % self.new_revno)
2926
self._show_tag_conficts(to_file)
2929
class BranchCheckResult(object):
2930
"""Results of checking branch consistency.
2935
def __init__(self, branch):
2936
self.branch = branch
2939
def report_results(self, verbose):
2940
"""Report the check results via trace.note.
2942
:param verbose: Requests more detailed display of what was checked,
2945
note('checked branch %s format %s', self.branch.base,
2946
self.branch._format)
2947
for error in self.errors:
2948
note('found error:%s', error)
2951
class Converter5to6(object):
2952
"""Perform an in-place upgrade of format 5 to format 6"""
2954
def convert(self, branch):
2955
# Data for 5 and 6 can peacefully coexist.
2956
format = BzrBranchFormat6()
2957
new_branch = format.open(branch.bzrdir, _found=True)
2959
# Copy source data into target
2960
new_branch._write_last_revision_info(*branch.last_revision_info())
2961
new_branch.set_parent(branch.get_parent())
2962
new_branch.set_bound_location(branch.get_bound_location())
2963
new_branch.set_push_location(branch.get_push_location())
2965
# New branch has no tags by default
2966
new_branch.tags._set_tag_dict({})
2968
# Copying done; now update target format
2969
new_branch._transport.put_bytes('format',
2970
format.get_format_string(),
2971
mode=new_branch.bzrdir._get_file_mode())
2973
# Clean up old files
2974
new_branch._transport.delete('revision-history')
2976
branch.set_parent(None)
2977
except errors.NoSuchFile:
2979
branch.set_bound_location(None)
2982
class Converter6to7(object):
2983
"""Perform an in-place upgrade of format 6 to format 7"""
2985
def convert(self, branch):
2986
format = BzrBranchFormat7()
2987
branch._set_config_location('stacked_on_location', '')
2988
# update target format
2989
branch._transport.put_bytes('format', format.get_format_string())
2992
class Converter7to8(object):
2993
"""Perform an in-place upgrade of format 6 to format 7"""
2995
def convert(self, branch):
2996
format = BzrBranchFormat8()
2997
branch._transport.put_bytes('references', '')
2998
# update target format
2999
branch._transport.put_bytes('format', format.get_format_string())
3002
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3003
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3006
_run_with_write_locked_target will attempt to release the lock it acquires.
3008
If an exception is raised by callable, then that exception *will* be
3009
propagated, even if the unlock attempt raises its own error. Thus
3010
_run_with_write_locked_target should be preferred to simply doing::
3014
return callable(*args, **kwargs)
3019
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3020
# should share code?
3023
result = callable(*args, **kwargs)
3025
exc_info = sys.exc_info()
3029
raise exc_info[0], exc_info[1], exc_info[2]
3035
class InterBranch(InterObject):
3036
"""This class represents operations taking place between two branches.
3038
Its instances have methods like pull() and push() and contain
3039
references to the source and target repositories these operations
3040
can be carried out on.
3044
"""The available optimised InterBranch types."""
3047
def _get_branch_formats_to_test():
3048
"""Return a tuple with the Branch formats to use when testing."""
3049
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3051
def pull(self, overwrite=False, stop_revision=None,
3052
possible_transports=None, local=False):
3053
"""Mirror source into target branch.
3055
The target branch is considered to be 'local', having low latency.
3057
:returns: PullResult instance
3059
raise NotImplementedError(self.pull)
3061
def update_revisions(self, stop_revision=None, overwrite=False,
3063
"""Pull in new perfect-fit revisions.
3065
:param stop_revision: Updated until the given revision
3066
:param overwrite: Always set the branch pointer, rather than checking
3067
to see if it is a proper descendant.
3068
:param graph: A Graph object that can be used to query history
3069
information. This can be None.
3072
raise NotImplementedError(self.update_revisions)
3074
def push(self, overwrite=False, stop_revision=None,
3075
_override_hook_source_branch=None):
3076
"""Mirror the source branch into the target branch.
3078
The source branch is considered to be 'local', having low latency.
3080
raise NotImplementedError(self.push)
3083
class GenericInterBranch(InterBranch):
3084
"""InterBranch implementation that uses public Branch functions.
3088
def _get_branch_formats_to_test():
3089
return BranchFormat._default_format, BranchFormat._default_format
3091
def update_revisions(self, stop_revision=None, overwrite=False,
3093
"""See InterBranch.update_revisions()."""
3094
self.source.lock_read()
3096
other_revno, other_last_revision = self.source.last_revision_info()
3097
stop_revno = None # unknown
3098
if stop_revision is None:
3099
stop_revision = other_last_revision
3100
if _mod_revision.is_null(stop_revision):
3101
# if there are no commits, we're done.
3103
stop_revno = other_revno
3105
# what's the current last revision, before we fetch [and change it
3107
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3108
# we fetch here so that we don't process data twice in the common
3109
# case of having something to pull, and so that the check for
3110
# already merged can operate on the just fetched graph, which will
3111
# be cached in memory.
3112
self.target.fetch(self.source, stop_revision)
3113
# Check to see if one is an ancestor of the other
3116
graph = self.target.repository.get_graph()
3117
if self.target._check_if_descendant_or_diverged(
3118
stop_revision, last_rev, graph, self.source):
3119
# stop_revision is a descendant of last_rev, but we aren't
3120
# overwriting, so we're done.
3122
if stop_revno is None:
3124
graph = self.target.repository.get_graph()
3125
this_revno, this_last_revision = \
3126
self.target.last_revision_info()
3127
stop_revno = graph.find_distance_to_null(stop_revision,
3128
[(other_last_revision, other_revno),
3129
(this_last_revision, this_revno)])
3130
self.target.set_last_revision_info(stop_revno, stop_revision)
3132
self.source.unlock()
3134
def pull(self, overwrite=False, stop_revision=None,
3135
possible_transports=None, _hook_master=None, run_hooks=True,
3136
_override_hook_target=None, local=False):
3139
:param _hook_master: Private parameter - set the branch to
3140
be supplied as the master to pull hooks.
3141
:param run_hooks: Private parameter - if false, this branch
3142
is being called because it's the master of the primary branch,
3143
so it should not run its hooks.
3144
:param _override_hook_target: Private parameter - set the branch to be
3145
supplied as the target_branch to pull hooks.
3146
:param local: Only update the local branch, and not the bound branch.
3148
# This type of branch can't be bound.
3150
raise errors.LocalRequiresBoundBranch()
3151
result = PullResult()
3152
result.source_branch = self.source
3153
if _override_hook_target is None:
3154
result.target_branch = self.target
3156
result.target_branch = _override_hook_target
3157
self.source.lock_read()
3159
# We assume that during 'pull' the target repository is closer than
3161
self.source.update_references(self.target)
3162
graph = self.target.repository.get_graph(self.source.repository)
3163
# TODO: Branch formats should have a flag that indicates
3164
# that revno's are expensive, and pull() should honor that flag.
3166
result.old_revno, result.old_revid = \
3167
self.target.last_revision_info()
3168
self.target.update_revisions(self.source, stop_revision,
3169
overwrite=overwrite, graph=graph)
3170
# TODO: The old revid should be specified when merging tags,
3171
# so a tags implementation that versions tags can only
3172
# pull in the most recent changes. -- JRV20090506
3173
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3175
result.new_revno, result.new_revid = self.target.last_revision_info()
3177
result.master_branch = _hook_master
3178
result.local_branch = result.target_branch
3180
result.master_branch = result.target_branch
3181
result.local_branch = None
3183
for hook in Branch.hooks['post_pull']:
3186
self.source.unlock()
3189
def push(self, overwrite=False, stop_revision=None,
3190
_override_hook_source_branch=None):
3191
"""See InterBranch.push.
3193
This is the basic concrete implementation of push()
3195
:param _override_hook_source_branch: If specified, run
3196
the hooks passing this Branch as the source, rather than self.
3197
This is for use of RemoteBranch, where push is delegated to the
3198
underlying vfs-based Branch.
3200
# TODO: Public option to disable running hooks - should be trivial but
3202
self.source.lock_read()
3204
return _run_with_write_locked_target(
3205
self.target, self._push_with_bound_branches, overwrite,
3207
_override_hook_source_branch=_override_hook_source_branch)
3209
self.source.unlock()
3211
def _push_with_bound_branches(self, overwrite, stop_revision,
3212
_override_hook_source_branch=None):
3213
"""Push from source into target, and into target's master if any.
3216
if _override_hook_source_branch:
3217
result.source_branch = _override_hook_source_branch
3218
for hook in Branch.hooks['post_push']:
3221
bound_location = self.target.get_bound_location()
3222
if bound_location and self.target.base != bound_location:
3223
# there is a master branch.
3225
# XXX: Why the second check? Is it even supported for a branch to
3226
# be bound to itself? -- mbp 20070507
3227
master_branch = self.target.get_master_branch()
3228
master_branch.lock_write()
3230
# push into the master from the source branch.
3231
self.source._basic_push(master_branch, overwrite, stop_revision)
3232
# and push into the target branch from the source. Note that we
3233
# push from the source branch again, because its considered the
3234
# highest bandwidth repository.
3235
result = self.source._basic_push(self.target, overwrite,
3237
result.master_branch = master_branch
3238
result.local_branch = self.target
3242
master_branch.unlock()
3245
result = self.source._basic_push(self.target, overwrite,
3247
# TODO: Why set master_branch and local_branch if there's no
3248
# binding? Maybe cleaner to just leave them unset? -- mbp
3250
result.master_branch = self.target
3251
result.local_branch = None
3256
def is_compatible(self, source, target):
3257
# GenericBranch uses the public API, so always compatible
3261
class InterToBranch5(GenericInterBranch):
3264
def _get_branch_formats_to_test():
3265
return BranchFormat._default_format, BzrBranchFormat5()
3267
def pull(self, overwrite=False, stop_revision=None,
3268
possible_transports=None, run_hooks=True,
3269
_override_hook_target=None, local=False):
3270
"""Pull from source into self, updating my master if any.
3272
:param run_hooks: Private parameter - if false, this branch
3273
is being called because it's the master of the primary branch,
3274
so it should not run its hooks.
3276
bound_location = self.target.get_bound_location()
3277
if local and not bound_location:
3278
raise errors.LocalRequiresBoundBranch()
3279
master_branch = None
3280
if not local and bound_location and self.source.base != bound_location:
3281
# not pulling from master, so we need to update master.
3282
master_branch = self.target.get_master_branch(possible_transports)
3283
master_branch.lock_write()
3286
# pull from source into master.
3287
master_branch.pull(self.source, overwrite, stop_revision,
3289
return super(InterToBranch5, self).pull(overwrite,
3290
stop_revision, _hook_master=master_branch,
3291
run_hooks=run_hooks,
3292
_override_hook_target=_override_hook_target)
3295
master_branch.unlock()
3298
InterBranch.register_optimiser(GenericInterBranch)
3299
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
