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
class Branch(bzrdir.ControlComponent):
67
"""Branch holding a history of revisions.
70
Base directory/url of the branch; using control_url and
71
control_transport is more standardized.
73
hooks: An instance of BranchHooks.
75
# this is really an instance variable - FIXME move it there
80
def control_transport(self):
81
return self._transport
84
def user_transport(self):
85
return self.bzrdir.user_transport
87
def __init__(self, *ignored, **ignored_too):
88
self.tags = self._format.make_tags(self)
89
self._revision_history_cache = None
90
self._revision_id_to_revno_cache = None
91
self._partial_revision_id_to_revno_cache = {}
92
self._partial_revision_history_cache = []
93
self._last_revision_info_cache = None
94
self._merge_sorted_revisions_cache = None
96
hooks = Branch.hooks['open']
100
def _open_hook(self):
101
"""Called by init to allow simpler extension of the base class."""
103
def _activate_fallback_location(self, url):
104
"""Activate the branch/repository from url as a fallback repository."""
105
repo = self._get_fallback_repository(url)
106
if repo.has_same_location(self.repository):
107
raise errors.UnstackableLocationError(self.user_url, url)
108
self.repository.add_fallback_repository(repo)
110
def break_lock(self):
111
"""Break a lock if one is present from another instance.
113
Uses the ui factory to ask for confirmation if the lock may be from
116
This will probe the repository for its lock as well.
118
self.control_files.break_lock()
119
self.repository.break_lock()
120
master = self.get_master_branch()
121
if master is not None:
124
def _check_stackable_repo(self):
125
if not self.repository._format.supports_external_lookups:
126
raise errors.UnstackableRepositoryFormat(self.repository._format,
127
self.repository.base)
129
def _extend_partial_history(self, stop_index=None, stop_revision=None):
130
"""Extend the partial history to include a given index
132
If a stop_index is supplied, stop when that index has been reached.
133
If a stop_revision is supplied, stop when that revision is
134
encountered. Otherwise, stop when the beginning of history is
137
:param stop_index: The index which should be present. When it is
138
present, history extension will stop.
139
:param stop_revision: The revision id which should be present. When
140
it is encountered, history extension will stop.
142
if len(self._partial_revision_history_cache) == 0:
143
self._partial_revision_history_cache = [self.last_revision()]
144
repository._iter_for_revno(
145
self.repository, self._partial_revision_history_cache,
146
stop_index=stop_index, stop_revision=stop_revision)
147
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
148
self._partial_revision_history_cache.pop()
150
def _get_check_refs(self):
151
"""Get the references needed for check().
155
revid = self.last_revision()
156
return [('revision-existence', revid), ('lefthand-distance', revid)]
159
def open(base, _unsupported=False, possible_transports=None):
160
"""Open the branch rooted at base.
162
For instance, if the branch is at URL/.bzr/branch,
163
Branch.open(URL) -> a Branch instance.
165
control = bzrdir.BzrDir.open(base, _unsupported,
166
possible_transports=possible_transports)
167
return control.open_branch(unsupported=_unsupported)
170
def open_from_transport(transport, name=None, _unsupported=False):
171
"""Open the branch rooted at transport"""
172
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
return control.open_branch(name=name, unsupported=_unsupported)
176
def open_containing(url, possible_transports=None):
177
"""Open an existing branch which contains url.
179
This probes for a branch at url, and searches upwards from there.
181
Basically we keep looking up until we find the control directory or
182
run into the root. If there isn't one, raises NotBranchError.
183
If there is one and it is either an unrecognised format or an unsupported
184
format, UnknownFormatError or UnsupportedFormatError are raised.
185
If there is one, it is returned, along with the unused portion of url.
187
control, relpath = bzrdir.BzrDir.open_containing(url,
189
return control.open_branch(), relpath
191
def _push_should_merge_tags(self):
192
"""Should _basic_push merge this branch's tags into the target?
194
The default implementation returns False if this branch has no tags,
195
and True the rest of the time. Subclasses may override this.
197
return self.supports_tags() and self.tags.get_tag_dict()
199
def get_config(self):
200
return BranchConfig(self)
202
def _get_config(self):
203
"""Get the concrete config for just the config in this branch.
205
This is not intended for client use; see Branch.get_config for the
210
:return: An object supporting get_option and set_option.
212
raise NotImplementedError(self._get_config)
214
def _get_fallback_repository(self, url):
215
"""Get the repository we fallback to at url."""
216
url = urlutils.join(self.base, url)
217
a_branch = Branch.open(url,
218
possible_transports=[self.bzrdir.root_transport])
219
return a_branch.repository
221
def _get_tags_bytes(self):
222
"""Get the bytes of a serialised tags dict.
224
Note that not all branches support tags, nor do all use the same tags
225
logic: this method is specific to BasicTags. Other tag implementations
226
may use the same method name and behave differently, safely, because
227
of the double-dispatch via
228
format.make_tags->tags_instance->get_tags_dict.
230
:return: The bytes of the tags file.
231
:seealso: Branch._set_tags_bytes.
233
return self._transport.get_bytes('tags')
235
def _get_nick(self, local=False, possible_transports=None):
236
config = self.get_config()
237
# explicit overrides master, but don't look for master if local is True
238
if not local and not config.has_explicit_nickname():
240
master = self.get_master_branch(possible_transports)
241
if master is not None:
242
# return the master branch value
244
except errors.BzrError, e:
245
# Silently fall back to local implicit nick if the master is
247
mutter("Could not connect to bound branch, "
248
"falling back to local nick.\n " + str(e))
249
return config.get_nickname()
251
def _set_nick(self, nick):
252
self.get_config().set_user_option('nickname', nick, warn_masked=True)
254
nick = property(_get_nick, _set_nick)
257
raise NotImplementedError(self.is_locked)
259
def _lefthand_history(self, revision_id, last_rev=None,
261
if 'evil' in debug.debug_flags:
262
mutter_callsite(4, "_lefthand_history scales with history.")
263
# stop_revision must be a descendant of last_revision
264
graph = self.repository.get_graph()
265
if last_rev is not None:
266
if not graph.is_ancestor(last_rev, revision_id):
267
# our previous tip is not merged into stop_revision
268
raise errors.DivergedBranches(self, other_branch)
269
# make a new revision history from the graph
270
parents_map = graph.get_parent_map([revision_id])
271
if revision_id not in parents_map:
272
raise errors.NoSuchRevision(self, revision_id)
273
current_rev_id = revision_id
275
check_not_reserved_id = _mod_revision.check_not_reserved_id
276
# Do not include ghosts or graph origin in revision_history
277
while (current_rev_id in parents_map and
278
len(parents_map[current_rev_id]) > 0):
279
check_not_reserved_id(current_rev_id)
280
new_history.append(current_rev_id)
281
current_rev_id = parents_map[current_rev_id][0]
282
parents_map = graph.get_parent_map([current_rev_id])
283
new_history.reverse()
286
def lock_write(self):
287
raise NotImplementedError(self.lock_write)
290
raise NotImplementedError(self.lock_read)
293
raise NotImplementedError(self.unlock)
295
def peek_lock_mode(self):
296
"""Return lock mode for the Branch: 'r', 'w' or None"""
297
raise NotImplementedError(self.peek_lock_mode)
299
def get_physical_lock_status(self):
300
raise NotImplementedError(self.get_physical_lock_status)
303
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
304
"""Return the revision_id for a dotted revno.
306
:param revno: a tuple like (1,) or (1,1,2)
307
:param _cache_reverse: a private parameter enabling storage
308
of the reverse mapping in a top level cache. (This should
309
only be done in selective circumstances as we want to
310
avoid having the mapping cached multiple times.)
311
:return: the revision_id
312
:raises errors.NoSuchRevision: if the revno doesn't exist
314
rev_id = self._do_dotted_revno_to_revision_id(revno)
316
self._partial_revision_id_to_revno_cache[rev_id] = revno
319
def _do_dotted_revno_to_revision_id(self, revno):
320
"""Worker function for dotted_revno_to_revision_id.
322
Subclasses should override this if they wish to
323
provide a more efficient implementation.
326
return self.get_rev_id(revno[0])
327
revision_id_to_revno = self.get_revision_id_to_revno_map()
328
revision_ids = [revision_id for revision_id, this_revno
329
in revision_id_to_revno.iteritems()
330
if revno == this_revno]
331
if len(revision_ids) == 1:
332
return revision_ids[0]
334
revno_str = '.'.join(map(str, revno))
335
raise errors.NoSuchRevision(self, revno_str)
338
def revision_id_to_dotted_revno(self, revision_id):
339
"""Given a revision id, return its dotted revno.
341
:return: a tuple like (1,) or (400,1,3).
343
return self._do_revision_id_to_dotted_revno(revision_id)
345
def _do_revision_id_to_dotted_revno(self, revision_id):
346
"""Worker function for revision_id_to_revno."""
347
# Try the caches if they are loaded
348
result = self._partial_revision_id_to_revno_cache.get(revision_id)
349
if result is not None:
351
if self._revision_id_to_revno_cache:
352
result = self._revision_id_to_revno_cache.get(revision_id)
354
raise errors.NoSuchRevision(self, revision_id)
355
# Try the mainline as it's optimised
357
revno = self.revision_id_to_revno(revision_id)
359
except errors.NoSuchRevision:
360
# We need to load and use the full revno map after all
361
result = self.get_revision_id_to_revno_map().get(revision_id)
363
raise errors.NoSuchRevision(self, revision_id)
367
def get_revision_id_to_revno_map(self):
368
"""Return the revision_id => dotted revno map.
370
This will be regenerated on demand, but will be cached.
372
:return: A dictionary mapping revision_id => dotted revno.
373
This dictionary should not be modified by the caller.
375
if self._revision_id_to_revno_cache is not None:
376
mapping = self._revision_id_to_revno_cache
378
mapping = self._gen_revno_map()
379
self._cache_revision_id_to_revno(mapping)
380
# TODO: jam 20070417 Since this is being cached, should we be returning
382
# I would rather not, and instead just declare that users should not
383
# modify the return value.
386
def _gen_revno_map(self):
387
"""Create a new mapping from revision ids to dotted revnos.
389
Dotted revnos are generated based on the current tip in the revision
391
This is the worker function for get_revision_id_to_revno_map, which
392
just caches the return value.
394
:return: A dictionary mapping revision_id => dotted revno.
396
revision_id_to_revno = dict((rev_id, revno)
397
for rev_id, depth, revno, end_of_merge
398
in self.iter_merge_sorted_revisions())
399
return revision_id_to_revno
402
def iter_merge_sorted_revisions(self, start_revision_id=None,
403
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
404
"""Walk the revisions for a branch in merge sorted order.
406
Merge sorted order is the output from a merge-aware,
407
topological sort, i.e. all parents come before their
408
children going forward; the opposite for reverse.
410
:param start_revision_id: the revision_id to begin walking from.
411
If None, the branch tip is used.
412
:param stop_revision_id: the revision_id to terminate the walk
413
after. If None, the rest of history is included.
414
:param stop_rule: if stop_revision_id is not None, the precise rule
415
to use for termination:
416
* 'exclude' - leave the stop revision out of the result (default)
417
* 'include' - the stop revision is the last item in the result
418
* 'with-merges' - include the stop revision and all of its
419
merged revisions in the result
420
:param direction: either 'reverse' or 'forward':
421
* reverse means return the start_revision_id first, i.e.
422
start at the most recent revision and go backwards in history
423
* forward returns tuples in the opposite order to reverse.
424
Note in particular that forward does *not* do any intelligent
425
ordering w.r.t. depth as some clients of this API may like.
426
(If required, that ought to be done at higher layers.)
428
:return: an iterator over (revision_id, depth, revno, end_of_merge)
431
* revision_id: the unique id of the revision
432
* depth: How many levels of merging deep this node has been
434
* revno_sequence: This field provides a sequence of
435
revision numbers for all revisions. The format is:
436
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
437
branch that the revno is on. From left to right the REVNO numbers
438
are the sequence numbers within that branch of the revision.
439
* end_of_merge: When True the next node (earlier in history) is
440
part of a different merge.
442
# Note: depth and revno values are in the context of the branch so
443
# we need the full graph to get stable numbers, regardless of the
445
if self._merge_sorted_revisions_cache is None:
446
last_revision = self.last_revision()
447
known_graph = self.repository.get_known_graph_ancestry(
449
self._merge_sorted_revisions_cache = known_graph.merge_sort(
451
filtered = self._filter_merge_sorted_revisions(
452
self._merge_sorted_revisions_cache, start_revision_id,
453
stop_revision_id, stop_rule)
454
# Make sure we don't return revisions that are not part of the
455
# start_revision_id ancestry.
456
filtered = self._filter_non_ancestors(filtered)
457
if direction == 'reverse':
459
if direction == 'forward':
460
return reversed(list(filtered))
462
raise ValueError('invalid direction %r' % direction)
464
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
465
start_revision_id, stop_revision_id, stop_rule):
466
"""Iterate over an inclusive range of sorted revisions."""
467
rev_iter = iter(merge_sorted_revisions)
468
if start_revision_id is not None:
469
for node in rev_iter:
470
rev_id = node.key[-1]
471
if rev_id != start_revision_id:
474
# The decision to include the start or not
475
# depends on the stop_rule if a stop is provided
476
# so pop this node back into the iterator
477
rev_iter = chain(iter([node]), rev_iter)
479
if stop_revision_id is None:
481
for node in rev_iter:
482
rev_id = node.key[-1]
483
yield (rev_id, node.merge_depth, node.revno,
485
elif stop_rule == 'exclude':
486
for node in rev_iter:
487
rev_id = node.key[-1]
488
if rev_id == stop_revision_id:
490
yield (rev_id, node.merge_depth, node.revno,
492
elif stop_rule == 'include':
493
for node in rev_iter:
494
rev_id = node.key[-1]
495
yield (rev_id, node.merge_depth, node.revno,
497
if rev_id == stop_revision_id:
499
elif stop_rule == 'with-merges':
500
stop_rev = self.repository.get_revision(stop_revision_id)
501
if stop_rev.parent_ids:
502
left_parent = stop_rev.parent_ids[0]
504
left_parent = _mod_revision.NULL_REVISION
505
# left_parent is the actual revision we want to stop logging at,
506
# since we want to show the merged revisions after the stop_rev too
507
reached_stop_revision_id = False
508
revision_id_whitelist = []
509
for node in rev_iter:
510
rev_id = node.key[-1]
511
if rev_id == left_parent:
512
# reached the left parent after the stop_revision
514
if (not reached_stop_revision_id or
515
rev_id in revision_id_whitelist):
516
yield (rev_id, node.merge_depth, node.revno,
518
if reached_stop_revision_id or rev_id == stop_revision_id:
519
# only do the merged revs of rev_id from now on
520
rev = self.repository.get_revision(rev_id)
522
reached_stop_revision_id = True
523
revision_id_whitelist.extend(rev.parent_ids)
525
raise ValueError('invalid stop_rule %r' % stop_rule)
527
def _filter_non_ancestors(self, rev_iter):
528
# If we started from a dotted revno, we want to consider it as a tip
529
# and don't want to yield revisions that are not part of its
530
# ancestry. Given the order guaranteed by the merge sort, we will see
531
# uninteresting descendants of the first parent of our tip before the
533
first = rev_iter.next()
534
(rev_id, merge_depth, revno, end_of_merge) = first
537
# We start at a mainline revision so by definition, all others
538
# revisions in rev_iter are ancestors
539
for node in rev_iter:
544
pmap = self.repository.get_parent_map([rev_id])
545
parents = pmap.get(rev_id, [])
547
whitelist.update(parents)
549
# If there is no parents, there is nothing of interest left
551
# FIXME: It's hard to test this scenario here as this code is never
552
# called in that case. -- vila 20100322
555
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
557
if rev_id in whitelist:
558
pmap = self.repository.get_parent_map([rev_id])
559
parents = pmap.get(rev_id, [])
560
whitelist.remove(rev_id)
561
whitelist.update(parents)
563
# We've reached the mainline, there is nothing left to
567
# A revision that is not part of the ancestry of our
570
yield (rev_id, merge_depth, revno, end_of_merge)
572
def leave_lock_in_place(self):
573
"""Tell this branch object not to release the physical lock when this
576
If lock_write doesn't return a token, then this method is not supported.
578
self.control_files.leave_in_place()
580
def dont_leave_lock_in_place(self):
581
"""Tell this branch object to release the physical lock when this
582
object is unlocked, even if it didn't originally acquire it.
584
If lock_write doesn't return a token, then this method is not supported.
586
self.control_files.dont_leave_in_place()
588
def bind(self, other):
589
"""Bind the local branch the other branch.
591
:param other: The branch to bind to
594
raise errors.UpgradeRequired(self.user_url)
596
def set_append_revisions_only(self, enabled):
597
if not self._format.supports_set_append_revisions_only():
598
raise errors.UpgradeRequired(self.user_url)
603
self.get_config().set_user_option('append_revisions_only', value,
606
def set_reference_info(self, file_id, tree_path, branch_location):
607
"""Set the branch location to use for a tree reference."""
608
raise errors.UnsupportedOperation(self.set_reference_info, self)
610
def get_reference_info(self, file_id):
611
"""Get the tree_path and branch_location for a tree reference."""
612
raise errors.UnsupportedOperation(self.get_reference_info, self)
615
def fetch(self, from_branch, last_revision=None, pb=None):
616
"""Copy revisions from from_branch into this branch.
618
:param from_branch: Where to copy from.
619
:param last_revision: What revision to stop at (None for at the end
621
:param pb: An optional progress bar to use.
624
if self.control_url == from_branch.control_url:
627
symbol_versioning.warn(
628
symbol_versioning.deprecated_in((1, 14, 0))
629
% "pb parameter to fetch()")
630
from_branch.lock_read()
632
if last_revision is None:
633
last_revision = from_branch.last_revision()
634
last_revision = _mod_revision.ensure_null(last_revision)
635
return self.repository.fetch(from_branch.repository,
636
revision_id=last_revision,
641
def get_bound_location(self):
642
"""Return the URL of the branch we are bound to.
644
Older format branches cannot bind, please be sure to use a metadir
649
def get_old_bound_location(self):
650
"""Return the URL of the branch we used to be bound to
652
raise errors.UpgradeRequired(self.user_url)
654
def get_commit_builder(self, parents, config=None, timestamp=None,
655
timezone=None, committer=None, revprops=None,
657
"""Obtain a CommitBuilder for this branch.
659
:param parents: Revision ids of the parents of the new revision.
660
:param config: Optional configuration to use.
661
:param timestamp: Optional timestamp recorded for commit.
662
:param timezone: Optional timezone for timestamp.
663
:param committer: Optional committer to set for commit.
664
:param revprops: Optional dictionary of revision properties.
665
:param revision_id: Optional revision id.
669
config = self.get_config()
671
return self.repository.get_commit_builder(self, parents, config,
672
timestamp, timezone, committer, revprops, revision_id)
674
def get_master_branch(self, possible_transports=None):
675
"""Return the branch we are bound to.
677
:return: Either a Branch, or None
681
def get_revision_delta(self, revno):
682
"""Return the delta for one revision.
684
The delta is relative to its mainline predecessor, or the
685
empty tree for revision 1.
687
rh = self.revision_history()
688
if not (1 <= revno <= len(rh)):
689
raise errors.InvalidRevisionNumber(revno)
690
return self.repository.get_revision_delta(rh[revno-1])
692
def get_stacked_on_url(self):
693
"""Get the URL this branch is stacked against.
695
:raises NotStacked: If the branch is not stacked.
696
:raises UnstackableBranchFormat: If the branch does not support
699
raise NotImplementedError(self.get_stacked_on_url)
701
def print_file(self, file, revision_id):
702
"""Print `file` to stdout."""
703
raise NotImplementedError(self.print_file)
705
def set_revision_history(self, rev_history):
706
raise NotImplementedError(self.set_revision_history)
709
def set_parent(self, url):
710
"""See Branch.set_parent."""
711
# TODO: Maybe delete old location files?
712
# URLs should never be unicode, even on the local fs,
713
# FIXUP this and get_parent in a future branch format bump:
714
# read and rewrite the file. RBC 20060125
716
if isinstance(url, unicode):
718
url = url.encode('ascii')
719
except UnicodeEncodeError:
720
raise errors.InvalidURL(url,
721
"Urls must be 7-bit ascii, "
722
"use bzrlib.urlutils.escape")
723
url = urlutils.relative_url(self.base, url)
724
self._set_parent_location(url)
727
def set_stacked_on_url(self, url):
728
"""Set the URL this branch is stacked against.
730
:raises UnstackableBranchFormat: If the branch does not support
732
:raises UnstackableRepositoryFormat: If the repository does not support
735
if not self._format.supports_stacking():
736
raise errors.UnstackableBranchFormat(self._format, self.user_url)
737
# XXX: Changing from one fallback repository to another does not check
738
# that all the data you need is present in the new fallback.
739
# Possibly it should.
740
self._check_stackable_repo()
743
old_url = self.get_stacked_on_url()
744
except (errors.NotStacked, errors.UnstackableBranchFormat,
745
errors.UnstackableRepositoryFormat):
749
self._activate_fallback_location(url)
750
# write this out after the repository is stacked to avoid setting a
751
# stacked config that doesn't work.
752
self._set_config_location('stacked_on_location', url)
755
"""Change a branch to be unstacked, copying data as needed.
757
Don't call this directly, use set_stacked_on_url(None).
759
pb = ui.ui_factory.nested_progress_bar()
761
pb.update("Unstacking")
762
# The basic approach here is to fetch the tip of the branch,
763
# including all available ghosts, from the existing stacked
764
# repository into a new repository object without the fallbacks.
766
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
767
# correct for CHKMap repostiories
768
old_repository = self.repository
769
if len(old_repository._fallback_repositories) != 1:
770
raise AssertionError("can't cope with fallback repositories "
771
"of %r" % (self.repository,))
772
# unlock it, including unlocking the fallback
773
old_repository.unlock()
774
old_repository.lock_read()
776
# Repositories don't offer an interface to remove fallback
777
# repositories today; take the conceptually simpler option and just
778
# reopen it. We reopen it starting from the URL so that we
779
# get a separate connection for RemoteRepositories and can
780
# stream from one of them to the other. This does mean doing
781
# separate SSH connection setup, but unstacking is not a
782
# common operation so it's tolerable.
783
new_bzrdir = bzrdir.BzrDir.open_from_transport(
784
self.bzrdir.user_transport)
785
new_repository = new_bzrdir.find_repository()
786
self.repository = new_repository
787
if self.repository._fallback_repositories:
788
raise AssertionError("didn't expect %r to have "
789
"fallback_repositories"
790
% (self.repository,))
791
# this is not paired with an unlock because it's just restoring
792
# the previous state; the lock's released when set_stacked_on_url
794
self.repository.lock_write()
795
# XXX: If you unstack a branch while it has a working tree
796
# with a pending merge, the pending-merged revisions will no
797
# longer be present. You can (probably) revert and remerge.
799
# XXX: This only fetches up to the tip of the repository; it
800
# doesn't bring across any tags. That's fairly consistent
801
# with how branch works, but perhaps not ideal.
802
self.repository.fetch(old_repository,
803
revision_id=self.last_revision(),
806
old_repository.unlock()
810
def _set_tags_bytes(self, bytes):
811
"""Mirror method for _get_tags_bytes.
813
:seealso: Branch._get_tags_bytes.
815
return _run_with_write_locked_target(self, self._transport.put_bytes,
818
def _cache_revision_history(self, rev_history):
819
"""Set the cached revision history to rev_history.
821
The revision_history method will use this cache to avoid regenerating
822
the revision history.
824
This API is semi-public; it only for use by subclasses, all other code
825
should consider it to be private.
827
self._revision_history_cache = rev_history
829
def _cache_revision_id_to_revno(self, revision_id_to_revno):
830
"""Set the cached revision_id => revno map to revision_id_to_revno.
832
This API is semi-public; it only for use by subclasses, all other code
833
should consider it to be private.
835
self._revision_id_to_revno_cache = revision_id_to_revno
837
def _clear_cached_state(self):
838
"""Clear any cached data on this branch, e.g. cached revision history.
840
This means the next call to revision_history will need to call
841
_gen_revision_history.
843
This API is semi-public; it only for use by subclasses, all other code
844
should consider it to be private.
846
self._revision_history_cache = None
847
self._revision_id_to_revno_cache = None
848
self._last_revision_info_cache = None
849
self._merge_sorted_revisions_cache = None
850
self._partial_revision_history_cache = []
851
self._partial_revision_id_to_revno_cache = {}
853
def _gen_revision_history(self):
854
"""Return sequence of revision hashes on to this branch.
856
Unlike revision_history, this method always regenerates or rereads the
857
revision history, i.e. it does not cache the result, so repeated calls
860
Concrete subclasses should override this instead of revision_history so
861
that subclasses do not need to deal with caching logic.
863
This API is semi-public; it only for use by subclasses, all other code
864
should consider it to be private.
866
raise NotImplementedError(self._gen_revision_history)
869
def revision_history(self):
870
"""Return sequence of revision ids on this branch.
872
This method will cache the revision history for as long as it is safe to
875
if 'evil' in debug.debug_flags:
876
mutter_callsite(3, "revision_history scales with history.")
877
if self._revision_history_cache is not None:
878
history = self._revision_history_cache
880
history = self._gen_revision_history()
881
self._cache_revision_history(history)
885
"""Return current revision number for this branch.
887
That is equivalent to the number of revisions committed to
890
return self.last_revision_info()[0]
893
"""Older format branches cannot bind or unbind."""
894
raise errors.UpgradeRequired(self.user_url)
896
def last_revision(self):
897
"""Return last revision id, or NULL_REVISION."""
898
return self.last_revision_info()[1]
901
def last_revision_info(self):
902
"""Return information about the last revision.
904
:return: A tuple (revno, revision_id).
906
if self._last_revision_info_cache is None:
907
self._last_revision_info_cache = self._last_revision_info()
908
return self._last_revision_info_cache
910
def _last_revision_info(self):
911
rh = self.revision_history()
914
return (revno, rh[-1])
916
return (0, _mod_revision.NULL_REVISION)
918
@deprecated_method(deprecated_in((1, 6, 0)))
919
def missing_revisions(self, other, stop_revision=None):
920
"""Return a list of new revisions that would perfectly fit.
922
If self and other have not diverged, return a list of the revisions
923
present in other, but missing from self.
925
self_history = self.revision_history()
926
self_len = len(self_history)
927
other_history = other.revision_history()
928
other_len = len(other_history)
929
common_index = min(self_len, other_len) -1
930
if common_index >= 0 and \
931
self_history[common_index] != other_history[common_index]:
932
raise errors.DivergedBranches(self, other)
934
if stop_revision is None:
935
stop_revision = other_len
937
if stop_revision > other_len:
938
raise errors.NoSuchRevision(self, stop_revision)
939
return other_history[self_len:stop_revision]
942
def update_revisions(self, other, stop_revision=None, overwrite=False,
944
"""Pull in new perfect-fit revisions.
946
:param other: Another Branch to pull from
947
:param stop_revision: Updated until the given revision
948
:param overwrite: Always set the branch pointer, rather than checking
949
to see if it is a proper descendant.
950
:param graph: A Graph object that can be used to query history
951
information. This can be None.
954
return InterBranch.get(other, self).update_revisions(stop_revision,
957
def import_last_revision_info(self, source_repo, revno, revid):
958
"""Set the last revision info, importing from another repo if necessary.
960
This is used by the bound branch code to upload a revision to
961
the master branch first before updating the tip of the local branch.
963
:param source_repo: Source repository to optionally fetch from
964
:param revno: Revision number of the new tip
965
:param revid: Revision id of the new tip
967
if not self.repository.has_same_location(source_repo):
968
self.repository.fetch(source_repo, revision_id=revid)
969
self.set_last_revision_info(revno, revid)
971
def revision_id_to_revno(self, revision_id):
972
"""Given a revision id, return its revno"""
973
if _mod_revision.is_null(revision_id):
975
history = self.revision_history()
977
return history.index(revision_id) + 1
979
raise errors.NoSuchRevision(self, revision_id)
982
def get_rev_id(self, revno, history=None):
983
"""Find the revision id of the specified revno."""
985
return _mod_revision.NULL_REVISION
986
last_revno, last_revid = self.last_revision_info()
987
if revno == last_revno:
989
if revno <= 0 or revno > last_revno:
990
raise errors.NoSuchRevision(self, revno)
991
distance_from_last = last_revno - revno
992
if len(self._partial_revision_history_cache) <= distance_from_last:
993
self._extend_partial_history(distance_from_last)
994
return self._partial_revision_history_cache[distance_from_last]
997
def pull(self, source, overwrite=False, stop_revision=None,
998
possible_transports=None, *args, **kwargs):
999
"""Mirror source into this branch.
1001
This branch is considered to be 'local', having low latency.
1003
:returns: PullResult instance
1005
return InterBranch.get(source, self).pull(overwrite=overwrite,
1006
stop_revision=stop_revision,
1007
possible_transports=possible_transports, *args, **kwargs)
1009
def push(self, target, overwrite=False, stop_revision=None, *args,
1011
"""Mirror this branch into target.
1013
This branch is considered to be 'local', having low latency.
1015
return InterBranch.get(self, target).push(overwrite, stop_revision,
1018
def lossy_push(self, target, stop_revision=None):
1019
"""Push deltas into another branch.
1021
:note: This does not, like push, retain the revision ids from
1022
the source branch and will, rather than adding bzr-specific
1023
metadata, push only those semantics of the revision that can be
1024
natively represented by this branch' VCS.
1026
:param target: Target branch
1027
:param stop_revision: Revision to push, defaults to last revision.
1028
:return: BranchPushResult with an extra member revidmap:
1029
A dictionary mapping revision ids from the target branch
1030
to new revision ids in the target branch, for each
1031
revision that was pushed.
1033
inter = InterBranch.get(self, target)
1034
lossy_push = getattr(inter, "lossy_push", None)
1035
if lossy_push is None:
1036
raise errors.LossyPushToSameVCS(self, target)
1037
return lossy_push(stop_revision)
1039
def basis_tree(self):
1040
"""Return `Tree` object for last revision."""
1041
return self.repository.revision_tree(self.last_revision())
1043
def get_parent(self):
1044
"""Return the parent location of the branch.
1046
This is the default location for pull/missing. The usual
1047
pattern is that the user can override it by specifying a
1050
parent = self._get_parent_location()
1053
# This is an old-format absolute path to a local branch
1054
# turn it into a url
1055
if parent.startswith('/'):
1056
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1058
return urlutils.join(self.base[:-1], parent)
1059
except errors.InvalidURLJoin, e:
1060
raise errors.InaccessibleParent(parent, self.user_url)
1062
def _get_parent_location(self):
1063
raise NotImplementedError(self._get_parent_location)
1065
def _set_config_location(self, name, url, config=None,
1066
make_relative=False):
1068
config = self.get_config()
1072
url = urlutils.relative_url(self.base, url)
1073
config.set_user_option(name, url, warn_masked=True)
1075
def _get_config_location(self, name, config=None):
1077
config = self.get_config()
1078
location = config.get_user_option(name)
1083
def get_child_submit_format(self):
1084
"""Return the preferred format of submissions to this branch."""
1085
return self.get_config().get_user_option("child_submit_format")
1087
def get_submit_branch(self):
1088
"""Return the submit location of the branch.
1090
This is the default location for bundle. The usual
1091
pattern is that the user can override it by specifying a
1094
return self.get_config().get_user_option('submit_branch')
1096
def set_submit_branch(self, location):
1097
"""Return the submit location of the branch.
1099
This is the default location for bundle. The usual
1100
pattern is that the user can override it by specifying a
1103
self.get_config().set_user_option('submit_branch', location,
1106
def get_public_branch(self):
1107
"""Return the public location of the branch.
1109
This is used by merge directives.
1111
return self._get_config_location('public_branch')
1113
def set_public_branch(self, location):
1114
"""Return the submit location of the branch.
1116
This is the default location for bundle. The usual
1117
pattern is that the user can override it by specifying a
1120
self._set_config_location('public_branch', location)
1122
def get_push_location(self):
1123
"""Return the None or the location to push this branch to."""
1124
push_loc = self.get_config().get_user_option('push_location')
1127
def set_push_location(self, location):
1128
"""Set a new push location for this branch."""
1129
raise NotImplementedError(self.set_push_location)
1131
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1132
"""Run the post_change_branch_tip hooks."""
1133
hooks = Branch.hooks['post_change_branch_tip']
1136
new_revno, new_revid = self.last_revision_info()
1137
params = ChangeBranchTipParams(
1138
self, old_revno, new_revno, old_revid, new_revid)
1142
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1143
"""Run the pre_change_branch_tip hooks."""
1144
hooks = Branch.hooks['pre_change_branch_tip']
1147
old_revno, old_revid = self.last_revision_info()
1148
params = ChangeBranchTipParams(
1149
self, old_revno, new_revno, old_revid, new_revid)
1155
"""Synchronise this branch with the master branch if any.
1157
:return: None or the last_revision pivoted out during the update.
1161
def check_revno(self, revno):
1163
Check whether a revno corresponds to any revision.
1164
Zero (the NULL revision) is considered valid.
1167
self.check_real_revno(revno)
1169
def check_real_revno(self, revno):
1171
Check whether a revno corresponds to a real revision.
1172
Zero (the NULL revision) is considered invalid
1174
if revno < 1 or revno > self.revno():
1175
raise errors.InvalidRevisionNumber(revno)
1178
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1179
"""Clone this branch into to_bzrdir preserving all semantic values.
1181
Most API users will want 'create_clone_on_transport', which creates a
1182
new bzrdir and branch on the fly.
1184
revision_id: if not None, the revision history in the new branch will
1185
be truncated to end with revision_id.
1187
result = to_bzrdir.create_branch()
1190
if repository_policy is not None:
1191
repository_policy.configure_branch(result)
1192
self.copy_content_into(result, revision_id=revision_id)
1198
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1199
"""Create a new line of development from the branch, into to_bzrdir.
1201
to_bzrdir controls the branch format.
1203
revision_id: if not None, the revision history in the new branch will
1204
be truncated to end with revision_id.
1206
if (repository_policy is not None and
1207
repository_policy.requires_stacking()):
1208
to_bzrdir._format.require_stacking(_skip_repo=True)
1209
result = to_bzrdir.create_branch()
1212
if repository_policy is not None:
1213
repository_policy.configure_branch(result)
1214
self.copy_content_into(result, revision_id=revision_id)
1215
result.set_parent(self.bzrdir.user_url)
1220
def _synchronize_history(self, destination, revision_id):
1221
"""Synchronize last revision and revision history between branches.
1223
This version is most efficient when the destination is also a
1224
BzrBranch6, but works for BzrBranch5, as long as the destination's
1225
repository contains all the lefthand ancestors of the intended
1226
last_revision. If not, set_last_revision_info will fail.
1228
:param destination: The branch to copy the history into
1229
:param revision_id: The revision-id to truncate history at. May
1230
be None to copy complete history.
1232
source_revno, source_revision_id = self.last_revision_info()
1233
if revision_id is None:
1234
revno, revision_id = source_revno, source_revision_id
1236
graph = self.repository.get_graph()
1238
revno = graph.find_distance_to_null(revision_id,
1239
[(source_revision_id, source_revno)])
1240
except errors.GhostRevisionsHaveNoRevno:
1241
# Default to 1, if we can't find anything else
1243
destination.set_last_revision_info(revno, revision_id)
1246
def copy_content_into(self, destination, revision_id=None):
1247
"""Copy the content of self into destination.
1249
revision_id: if not None, the revision history in the new branch will
1250
be truncated to end with revision_id.
1252
self.update_references(destination)
1253
self._synchronize_history(destination, revision_id)
1255
parent = self.get_parent()
1256
except errors.InaccessibleParent, e:
1257
mutter('parent was not accessible to copy: %s', e)
1260
destination.set_parent(parent)
1261
if self._push_should_merge_tags():
1262
self.tags.merge_to(destination.tags)
1264
def update_references(self, target):
1265
if not getattr(self._format, 'supports_reference_locations', False):
1267
reference_dict = self._get_all_reference_info()
1268
if len(reference_dict) == 0:
1270
old_base = self.base
1271
new_base = target.base
1272
target_reference_dict = target._get_all_reference_info()
1273
for file_id, (tree_path, branch_location) in (
1274
reference_dict.items()):
1275
branch_location = urlutils.rebase_url(branch_location,
1277
target_reference_dict.setdefault(
1278
file_id, (tree_path, branch_location))
1279
target._set_all_reference_info(target_reference_dict)
1282
def check(self, refs):
1283
"""Check consistency of the branch.
1285
In particular this checks that revisions given in the revision-history
1286
do actually match up in the revision graph, and that they're all
1287
present in the repository.
1289
Callers will typically also want to check the repository.
1291
:param refs: Calculated refs for this branch as specified by
1292
branch._get_check_refs()
1293
:return: A BranchCheckResult.
1295
result = BranchCheckResult(self)
1296
last_revno, last_revision_id = self.last_revision_info()
1297
actual_revno = refs[('lefthand-distance', last_revision_id)]
1298
if actual_revno != last_revno:
1299
result.errors.append(errors.BzrCheckError(
1300
'revno does not match len(mainline) %s != %s' % (
1301
last_revno, actual_revno)))
1302
# TODO: We should probably also check that self.revision_history
1303
# matches the repository for older branch formats.
1304
# If looking for the code that cross-checks repository parents against
1305
# the iter_reverse_revision_history output, that is now a repository
1309
def _get_checkout_format(self):
1310
"""Return the most suitable metadir for a checkout of this branch.
1311
Weaves are used if this branch's repository uses weaves.
1313
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1314
from bzrlib.repofmt import weaverepo
1315
format = bzrdir.BzrDirMetaFormat1()
1316
format.repository_format = weaverepo.RepositoryFormat7()
1318
format = self.repository.bzrdir.checkout_metadir()
1319
format.set_branch_format(self._format)
1322
def create_clone_on_transport(self, to_transport, revision_id=None,
1323
stacked_on=None, create_prefix=False, use_existing_dir=False):
1324
"""Create a clone of this branch and its bzrdir.
1326
:param to_transport: The transport to clone onto.
1327
:param revision_id: The revision id to use as tip in the new branch.
1328
If None the tip is obtained from this branch.
1329
:param stacked_on: An optional URL to stack the clone on.
1330
:param create_prefix: Create any missing directories leading up to
1332
:param use_existing_dir: Use an existing directory if one exists.
1334
# XXX: Fix the bzrdir API to allow getting the branch back from the
1335
# clone call. Or something. 20090224 RBC/spiv.
1336
if revision_id is None:
1337
revision_id = self.last_revision()
1338
dir_to = self.bzrdir.clone_on_transport(to_transport,
1339
revision_id=revision_id, stacked_on=stacked_on,
1340
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1341
return dir_to.open_branch()
1343
def create_checkout(self, to_location, revision_id=None,
1344
lightweight=False, accelerator_tree=None,
1346
"""Create a checkout of a branch.
1348
:param to_location: The url to produce the checkout at
1349
:param revision_id: The revision to check out
1350
:param lightweight: If True, produce a lightweight checkout, otherwise,
1351
produce a bound branch (heavyweight checkout)
1352
:param accelerator_tree: A tree which can be used for retrieving file
1353
contents more quickly than the revision tree, i.e. a workingtree.
1354
The revision tree will be used for cases where accelerator_tree's
1355
content is different.
1356
:param hardlink: If true, hard-link files from accelerator_tree,
1358
:return: The tree of the created checkout
1360
t = transport.get_transport(to_location)
1363
format = self._get_checkout_format()
1364
checkout = format.initialize_on_transport(t)
1365
from_branch = BranchReferenceFormat().initialize(checkout,
1368
format = self._get_checkout_format()
1369
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1370
to_location, force_new_tree=False, format=format)
1371
checkout = checkout_branch.bzrdir
1372
checkout_branch.bind(self)
1373
# pull up to the specified revision_id to set the initial
1374
# branch tip correctly, and seed it with history.
1375
checkout_branch.pull(self, stop_revision=revision_id)
1377
tree = checkout.create_workingtree(revision_id,
1378
from_branch=from_branch,
1379
accelerator_tree=accelerator_tree,
1381
basis_tree = tree.basis_tree()
1382
basis_tree.lock_read()
1384
for path, file_id in basis_tree.iter_references():
1385
reference_parent = self.reference_parent(file_id, path)
1386
reference_parent.create_checkout(tree.abspath(path),
1387
basis_tree.get_reference_revision(file_id, path),
1394
def reconcile(self, thorough=True):
1395
"""Make sure the data stored in this branch is consistent."""
1396
from bzrlib.reconcile import BranchReconciler
1397
reconciler = BranchReconciler(self, thorough=thorough)
1398
reconciler.reconcile()
1401
def reference_parent(self, file_id, path, possible_transports=None):
1402
"""Return the parent branch for a tree-reference file_id
1403
:param file_id: The file_id of the tree reference
1404
:param path: The path of the file_id in the tree
1405
:return: A branch associated with the file_id
1407
# FIXME should provide multiple branches, based on config
1408
return Branch.open(self.user_transport.clone(path).base,
1409
possible_transports=possible_transports)
1411
def supports_tags(self):
1412
return self._format.supports_tags()
1414
def automatic_tag_name(self, revision_id):
1415
"""Try to automatically find the tag name for a revision.
1417
:param revision_id: Revision id of the revision.
1418
:return: A tag name or None if no tag name could be determined.
1420
for hook in Branch.hooks['automatic_tag_name']:
1421
ret = hook(self, revision_id)
1426
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1428
"""Ensure that revision_b is a descendant of revision_a.
1430
This is a helper function for update_revisions.
1432
:raises: DivergedBranches if revision_b has diverged from revision_a.
1433
:returns: True if revision_b is a descendant of revision_a.
1435
relation = self._revision_relations(revision_a, revision_b, graph)
1436
if relation == 'b_descends_from_a':
1438
elif relation == 'diverged':
1439
raise errors.DivergedBranches(self, other_branch)
1440
elif relation == 'a_descends_from_b':
1443
raise AssertionError("invalid relation: %r" % (relation,))
1445
def _revision_relations(self, revision_a, revision_b, graph):
1446
"""Determine the relationship between two revisions.
1448
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1450
heads = graph.heads([revision_a, revision_b])
1451
if heads == set([revision_b]):
1452
return 'b_descends_from_a'
1453
elif heads == set([revision_a, revision_b]):
1454
# These branches have diverged
1456
elif heads == set([revision_a]):
1457
return 'a_descends_from_b'
1459
raise AssertionError("invalid heads: %r" % (heads,))
1462
class BranchFormat(object):
1463
"""An encapsulation of the initialization and open routines for a format.
1465
Formats provide three things:
1466
* An initialization routine,
1470
Formats are placed in an dict by their format string for reference
1471
during branch opening. Its not required that these be instances, they
1472
can be classes themselves with class methods - it simply depends on
1473
whether state is needed for a given format or not.
1475
Once a format is deprecated, just deprecate the initialize and open
1476
methods on the format class. Do not deprecate the object, as the
1477
object will be created every time regardless.
1480
_default_format = None
1481
"""The default format used for new branches."""
1484
"""The known formats."""
1486
can_set_append_revisions_only = True
1488
def __eq__(self, other):
1489
return self.__class__ is other.__class__
1491
def __ne__(self, other):
1492
return not (self == other)
1495
def find_format(klass, a_bzrdir, name=None):
1496
"""Return the format for the branch object in a_bzrdir."""
1498
transport = a_bzrdir.get_branch_transport(None, name=name)
1499
format_string = transport.get_bytes("format")
1500
return klass._formats[format_string]
1501
except errors.NoSuchFile:
1502
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1504
raise errors.UnknownFormatError(format=format_string, kind='branch')
1507
def get_default_format(klass):
1508
"""Return the current default format."""
1509
return klass._default_format
1511
def get_reference(self, a_bzrdir):
1512
"""Get the target reference of the branch in a_bzrdir.
1514
format probing must have been completed before calling
1515
this method - it is assumed that the format of the branch
1516
in a_bzrdir is correct.
1518
:param a_bzrdir: The bzrdir to get the branch data from.
1519
:return: None if the branch is not a reference branch.
1524
def set_reference(self, a_bzrdir, to_branch):
1525
"""Set the target reference of the branch in a_bzrdir.
1527
format probing must have been completed before calling
1528
this method - it is assumed that the format of the branch
1529
in a_bzrdir is correct.
1531
:param a_bzrdir: The bzrdir to set the branch reference for.
1532
:param to_branch: branch that the checkout is to reference
1534
raise NotImplementedError(self.set_reference)
1536
def get_format_string(self):
1537
"""Return the ASCII format string that identifies this format."""
1538
raise NotImplementedError(self.get_format_string)
1540
def get_format_description(self):
1541
"""Return the short format description for this format."""
1542
raise NotImplementedError(self.get_format_description)
1544
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1545
lock_type='metadir', set_format=True):
1546
"""Initialize a branch in a bzrdir, with specified files
1548
:param a_bzrdir: The bzrdir to initialize the branch in
1549
:param utf8_files: The files to create as a list of
1550
(filename, content) tuples
1551
:param name: Name of colocated branch to create, if any
1552
:param set_format: If True, set the format with
1553
self.get_format_string. (BzrBranch4 has its format set
1555
:return: a branch in this format
1557
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1558
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1560
'metadir': ('lock', lockdir.LockDir),
1561
'branch4': ('branch-lock', lockable_files.TransportLock),
1563
lock_name, lock_class = lock_map[lock_type]
1564
control_files = lockable_files.LockableFiles(branch_transport,
1565
lock_name, lock_class)
1566
control_files.create_lock()
1568
control_files.lock_write()
1569
except errors.LockContention:
1570
if lock_type != 'branch4':
1576
utf8_files += [('format', self.get_format_string())]
1578
for (filename, content) in utf8_files:
1579
branch_transport.put_bytes(
1581
mode=a_bzrdir._get_file_mode())
1584
control_files.unlock()
1585
return self.open(a_bzrdir, name, _found=True)
1587
def initialize(self, a_bzrdir, name=None):
1588
"""Create a branch of this format in a_bzrdir.
1590
:param name: Name of the colocated branch to create.
1592
raise NotImplementedError(self.initialize)
1594
def is_supported(self):
1595
"""Is this format supported?
1597
Supported formats can be initialized and opened.
1598
Unsupported formats may not support initialization or committing or
1599
some other features depending on the reason for not being supported.
1603
def make_tags(self, branch):
1604
"""Create a tags object for branch.
1606
This method is on BranchFormat, because BranchFormats are reflected
1607
over the wire via network_name(), whereas full Branch instances require
1608
multiple VFS method calls to operate at all.
1610
The default implementation returns a disabled-tags instance.
1612
Note that it is normal for branch to be a RemoteBranch when using tags
1615
return DisabledTags(branch)
1617
def network_name(self):
1618
"""A simple byte string uniquely identifying this format for RPC calls.
1620
MetaDir branch formats use their disk format string to identify the
1621
repository over the wire. All in one formats such as bzr < 0.8, and
1622
foreign formats like svn/git and hg should use some marker which is
1623
unique and immutable.
1625
raise NotImplementedError(self.network_name)
1627
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1628
"""Return the branch object for a_bzrdir
1630
:param a_bzrdir: A BzrDir that contains a branch.
1631
:param name: Name of colocated branch to open
1632
:param _found: a private parameter, do not use it. It is used to
1633
indicate if format probing has already be done.
1634
:param ignore_fallbacks: when set, no fallback branches will be opened
1635
(if there are any). Default is to open fallbacks.
1637
raise NotImplementedError(self.open)
1640
def register_format(klass, format):
1641
"""Register a metadir format."""
1642
klass._formats[format.get_format_string()] = format
1643
# Metadir formats have a network name of their format string, and get
1644
# registered as class factories.
1645
network_format_registry.register(format.get_format_string(), format.__class__)
1648
def set_default_format(klass, format):
1649
klass._default_format = format
1651
def supports_set_append_revisions_only(self):
1652
"""True if this format supports set_append_revisions_only."""
1655
def supports_stacking(self):
1656
"""True if this format records a stacked-on branch."""
1660
def unregister_format(klass, format):
1661
del klass._formats[format.get_format_string()]
1664
return self.get_format_description().rstrip()
1666
def supports_tags(self):
1667
"""True if this format supports tags stored in the branch"""
1668
return False # by default
1671
class BranchHooks(Hooks):
1672
"""A dictionary mapping hook name to a list of callables for branch hooks.
1674
e.g. ['set_rh'] Is the list of items to be called when the
1675
set_revision_history function is invoked.
1679
"""Create the default hooks.
1681
These are all empty initially, because by default nothing should get
1684
Hooks.__init__(self)
1685
self.create_hook(HookPoint('set_rh',
1686
"Invoked whenever the revision history has been set via "
1687
"set_revision_history. The api signature is (branch, "
1688
"revision_history), and the branch will be write-locked. "
1689
"The set_rh hook can be expensive for bzr to trigger, a better "
1690
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1691
self.create_hook(HookPoint('open',
1692
"Called with the Branch object that has been opened after a "
1693
"branch is opened.", (1, 8), None))
1694
self.create_hook(HookPoint('post_push',
1695
"Called after a push operation completes. post_push is called "
1696
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1697
"bzr client.", (0, 15), None))
1698
self.create_hook(HookPoint('post_pull',
1699
"Called after a pull operation completes. post_pull is called "
1700
"with a bzrlib.branch.PullResult object and only runs in the "
1701
"bzr client.", (0, 15), None))
1702
self.create_hook(HookPoint('pre_commit',
1703
"Called after a commit is calculated but before it is is "
1704
"completed. pre_commit is called with (local, master, old_revno, "
1705
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1706
"). old_revid is NULL_REVISION for the first commit to a branch, "
1707
"tree_delta is a TreeDelta object describing changes from the "
1708
"basis revision. hooks MUST NOT modify this delta. "
1709
" future_tree is an in-memory tree obtained from "
1710
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1711
"tree.", (0,91), None))
1712
self.create_hook(HookPoint('post_commit',
1713
"Called in the bzr client after a commit has completed. "
1714
"post_commit is called with (local, master, old_revno, old_revid, "
1715
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1716
"commit to a branch.", (0, 15), None))
1717
self.create_hook(HookPoint('post_uncommit',
1718
"Called in the bzr client after an uncommit completes. "
1719
"post_uncommit is called with (local, master, old_revno, "
1720
"old_revid, new_revno, new_revid) where local is the local branch "
1721
"or None, master is the target branch, and an empty branch "
1722
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1723
self.create_hook(HookPoint('pre_change_branch_tip',
1724
"Called in bzr client and server before a change to the tip of a "
1725
"branch is made. pre_change_branch_tip is called with a "
1726
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1727
"commit, uncommit will all trigger this hook.", (1, 6), None))
1728
self.create_hook(HookPoint('post_change_branch_tip',
1729
"Called in bzr client and server after a change to the tip of a "
1730
"branch is made. post_change_branch_tip is called with a "
1731
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1732
"commit, uncommit will all trigger this hook.", (1, 4), None))
1733
self.create_hook(HookPoint('transform_fallback_location',
1734
"Called when a stacked branch is activating its fallback "
1735
"locations. transform_fallback_location is called with (branch, "
1736
"url), and should return a new url. Returning the same url "
1737
"allows it to be used as-is, returning a different one can be "
1738
"used to cause the branch to stack on a closer copy of that "
1739
"fallback_location. Note that the branch cannot have history "
1740
"accessing methods called on it during this hook because the "
1741
"fallback locations have not been activated. When there are "
1742
"multiple hooks installed for transform_fallback_location, "
1743
"all are called with the url returned from the previous hook."
1744
"The order is however undefined.", (1, 9), None))
1745
self.create_hook(HookPoint('automatic_tag_name',
1746
"Called to determine an automatic tag name for a revision."
1747
"automatic_tag_name is called with (branch, revision_id) and "
1748
"should return a tag name or None if no tag name could be "
1749
"determined. The first non-None tag name returned will be used.",
1754
# install the default hooks into the Branch class.
1755
Branch.hooks = BranchHooks()
1758
class ChangeBranchTipParams(object):
1759
"""Object holding parameters passed to *_change_branch_tip hooks.
1761
There are 5 fields that hooks may wish to access:
1763
:ivar branch: the branch being changed
1764
:ivar old_revno: revision number before the change
1765
:ivar new_revno: revision number after the change
1766
:ivar old_revid: revision id before the change
1767
:ivar new_revid: revision id after the change
1769
The revid fields are strings. The revno fields are integers.
1772
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1773
"""Create a group of ChangeBranchTip parameters.
1775
:param branch: The branch being changed.
1776
:param old_revno: Revision number before the change.
1777
:param new_revno: Revision number after the change.
1778
:param old_revid: Tip revision id before the change.
1779
:param new_revid: Tip revision id after the change.
1781
self.branch = branch
1782
self.old_revno = old_revno
1783
self.new_revno = new_revno
1784
self.old_revid = old_revid
1785
self.new_revid = new_revid
1787
def __eq__(self, other):
1788
return self.__dict__ == other.__dict__
1791
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1792
self.__class__.__name__, self.branch,
1793
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1796
class BzrBranchFormat4(BranchFormat):
1797
"""Bzr branch format 4.
1800
- a revision-history file.
1801
- a branch-lock lock file [ to be shared with the bzrdir ]
1804
def get_format_description(self):
1805
"""See BranchFormat.get_format_description()."""
1806
return "Branch format 4"
1808
def initialize(self, a_bzrdir, name=None):
1809
"""Create a branch of this format in a_bzrdir."""
1810
utf8_files = [('revision-history', ''),
1811
('branch-name', ''),
1813
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1814
lock_type='branch4', set_format=False)
1817
super(BzrBranchFormat4, self).__init__()
1818
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1820
def network_name(self):
1821
"""The network name for this format is the control dirs disk label."""
1822
return self._matchingbzrdir.get_format_string()
1824
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1825
"""See BranchFormat.open()."""
1827
# we are being called directly and must probe.
1828
raise NotImplementedError
1829
return BzrBranch(_format=self,
1830
_control_files=a_bzrdir._control_files,
1833
_repository=a_bzrdir.open_repository())
1836
return "Bazaar-NG branch format 4"
1839
class BranchFormatMetadir(BranchFormat):
1840
"""Common logic for meta-dir based branch formats."""
1842
def _branch_class(self):
1843
"""What class to instantiate on open calls."""
1844
raise NotImplementedError(self._branch_class)
1846
def network_name(self):
1847
"""A simple byte string uniquely identifying this format for RPC calls.
1849
Metadir branch formats use their format string.
1851
return self.get_format_string()
1853
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1854
"""See BranchFormat.open()."""
1856
format = BranchFormat.find_format(a_bzrdir, name=name)
1857
if format.__class__ != self.__class__:
1858
raise AssertionError("wrong format %r found for %r" %
1860
transport = a_bzrdir.get_branch_transport(None, name=name)
1862
control_files = lockable_files.LockableFiles(transport, 'lock',
1864
return self._branch_class()(_format=self,
1865
_control_files=control_files,
1868
_repository=a_bzrdir.find_repository(),
1869
ignore_fallbacks=ignore_fallbacks)
1870
except errors.NoSuchFile:
1871
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1874
super(BranchFormatMetadir, self).__init__()
1875
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1876
self._matchingbzrdir.set_branch_format(self)
1878
def supports_tags(self):
1882
class BzrBranchFormat5(BranchFormatMetadir):
1883
"""Bzr branch format 5.
1886
- a revision-history file.
1888
- a lock dir guarding the branch itself
1889
- all of this stored in a branch/ subdirectory
1890
- works with shared repositories.
1892
This format is new in bzr 0.8.
1895
def _branch_class(self):
1898
def get_format_string(self):
1899
"""See BranchFormat.get_format_string()."""
1900
return "Bazaar-NG branch format 5\n"
1902
def get_format_description(self):
1903
"""See BranchFormat.get_format_description()."""
1904
return "Branch format 5"
1906
def initialize(self, a_bzrdir, name=None):
1907
"""Create a branch of this format in a_bzrdir."""
1908
utf8_files = [('revision-history', ''),
1909
('branch-name', ''),
1911
return self._initialize_helper(a_bzrdir, utf8_files, name)
1913
def supports_tags(self):
1917
class BzrBranchFormat6(BranchFormatMetadir):
1918
"""Branch format with last-revision and tags.
1920
Unlike previous formats, this has no explicit revision history. Instead,
1921
this just stores the last-revision, and the left-hand history leading
1922
up to there is the history.
1924
This format was introduced in bzr 0.15
1925
and became the default in 0.91.
1928
def _branch_class(self):
1931
def get_format_string(self):
1932
"""See BranchFormat.get_format_string()."""
1933
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1935
def get_format_description(self):
1936
"""See BranchFormat.get_format_description()."""
1937
return "Branch format 6"
1939
def initialize(self, a_bzrdir, name=None):
1940
"""Create a branch of this format in a_bzrdir."""
1941
utf8_files = [('last-revision', '0 null:\n'),
1942
('branch.conf', ''),
1945
return self._initialize_helper(a_bzrdir, utf8_files, name)
1947
def make_tags(self, branch):
1948
"""See bzrlib.branch.BranchFormat.make_tags()."""
1949
return BasicTags(branch)
1951
def supports_set_append_revisions_only(self):
1955
class BzrBranchFormat8(BranchFormatMetadir):
1956
"""Metadir format supporting storing locations of subtree branches."""
1958
def _branch_class(self):
1961
def get_format_string(self):
1962
"""See BranchFormat.get_format_string()."""
1963
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1965
def get_format_description(self):
1966
"""See BranchFormat.get_format_description()."""
1967
return "Branch format 8"
1969
def initialize(self, a_bzrdir, name=None):
1970
"""Create a branch of this format in a_bzrdir."""
1971
utf8_files = [('last-revision', '0 null:\n'),
1972
('branch.conf', ''),
1976
return self._initialize_helper(a_bzrdir, utf8_files, name)
1979
super(BzrBranchFormat8, self).__init__()
1980
self._matchingbzrdir.repository_format = \
1981
RepositoryFormatKnitPack5RichRoot()
1983
def make_tags(self, branch):
1984
"""See bzrlib.branch.BranchFormat.make_tags()."""
1985
return BasicTags(branch)
1987
def supports_set_append_revisions_only(self):
1990
def supports_stacking(self):
1993
supports_reference_locations = True
1996
class BzrBranchFormat7(BzrBranchFormat8):
1997
"""Branch format with last-revision, tags, and a stacked location pointer.
1999
The stacked location pointer is passed down to the repository and requires
2000
a repository format with supports_external_lookups = True.
2002
This format was introduced in bzr 1.6.
2005
def initialize(self, a_bzrdir, name=None):
2006
"""Create a branch of this format in a_bzrdir."""
2007
utf8_files = [('last-revision', '0 null:\n'),
2008
('branch.conf', ''),
2011
return self._initialize_helper(a_bzrdir, utf8_files, name)
2013
def _branch_class(self):
2016
def get_format_string(self):
2017
"""See BranchFormat.get_format_string()."""
2018
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2020
def get_format_description(self):
2021
"""See BranchFormat.get_format_description()."""
2022
return "Branch format 7"
2024
def supports_set_append_revisions_only(self):
2027
supports_reference_locations = False
2030
class BranchReferenceFormat(BranchFormat):
2031
"""Bzr branch reference format.
2033
Branch references are used in implementing checkouts, they
2034
act as an alias to the real branch which is at some other url.
2041
def get_format_string(self):
2042
"""See BranchFormat.get_format_string()."""
2043
return "Bazaar-NG Branch Reference Format 1\n"
2045
def get_format_description(self):
2046
"""See BranchFormat.get_format_description()."""
2047
return "Checkout reference format 1"
2049
def get_reference(self, a_bzrdir):
2050
"""See BranchFormat.get_reference()."""
2051
transport = a_bzrdir.get_branch_transport(None)
2052
return transport.get_bytes('location')
2054
def set_reference(self, a_bzrdir, to_branch):
2055
"""See BranchFormat.set_reference()."""
2056
transport = a_bzrdir.get_branch_transport(None)
2057
location = transport.put_bytes('location', to_branch.base)
2059
def initialize(self, a_bzrdir, name=None, target_branch=None):
2060
"""Create a branch of this format in a_bzrdir."""
2061
if target_branch is None:
2062
# this format does not implement branch itself, thus the implicit
2063
# creation contract must see it as uninitializable
2064
raise errors.UninitializableFormat(self)
2065
mutter('creating branch reference in %s', a_bzrdir.user_url)
2066
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2067
branch_transport.put_bytes('location',
2068
target_branch.bzrdir.user_url)
2069
branch_transport.put_bytes('format', self.get_format_string())
2071
a_bzrdir, name, _found=True,
2072
possible_transports=[target_branch.bzrdir.root_transport])
2075
super(BranchReferenceFormat, self).__init__()
2076
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2077
self._matchingbzrdir.set_branch_format(self)
2079
def _make_reference_clone_function(format, a_branch):
2080
"""Create a clone() routine for a branch dynamically."""
2081
def clone(to_bzrdir, revision_id=None,
2082
repository_policy=None):
2083
"""See Branch.clone()."""
2084
return format.initialize(to_bzrdir, target_branch=a_branch)
2085
# cannot obey revision_id limits when cloning a reference ...
2086
# FIXME RBC 20060210 either nuke revision_id for clone, or
2087
# emit some sort of warning/error to the caller ?!
2090
def open(self, a_bzrdir, name=None, _found=False, location=None,
2091
possible_transports=None, ignore_fallbacks=False):
2092
"""Return the branch that the branch reference in a_bzrdir points at.
2094
:param a_bzrdir: A BzrDir that contains a branch.
2095
:param name: Name of colocated branch to open, if any
2096
:param _found: a private parameter, do not use it. It is used to
2097
indicate if format probing has already be done.
2098
:param ignore_fallbacks: when set, no fallback branches will be opened
2099
(if there are any). Default is to open fallbacks.
2100
:param location: The location of the referenced branch. If
2101
unspecified, this will be determined from the branch reference in
2103
:param possible_transports: An optional reusable transports list.
2106
format = BranchFormat.find_format(a_bzrdir, name=name)
2107
if format.__class__ != self.__class__:
2108
raise AssertionError("wrong format %r found for %r" %
2110
if location is None:
2111
location = self.get_reference(a_bzrdir)
2112
real_bzrdir = bzrdir.BzrDir.open(
2113
location, possible_transports=possible_transports)
2114
result = real_bzrdir.open_branch(name=name,
2115
ignore_fallbacks=ignore_fallbacks)
2116
# this changes the behaviour of result.clone to create a new reference
2117
# rather than a copy of the content of the branch.
2118
# I did not use a proxy object because that needs much more extensive
2119
# testing, and we are only changing one behaviour at the moment.
2120
# If we decide to alter more behaviours - i.e. the implicit nickname
2121
# then this should be refactored to introduce a tested proxy branch
2122
# and a subclass of that for use in overriding clone() and ....
2124
result.clone = self._make_reference_clone_function(result)
2128
network_format_registry = registry.FormatRegistry()
2129
"""Registry of formats indexed by their network name.
2131
The network name for a branch format is an identifier that can be used when
2132
referring to formats with smart server operations. See
2133
BranchFormat.network_name() for more detail.
2137
# formats which have no format string are not discoverable
2138
# and not independently creatable, so are not registered.
2139
__format5 = BzrBranchFormat5()
2140
__format6 = BzrBranchFormat6()
2141
__format7 = BzrBranchFormat7()
2142
__format8 = BzrBranchFormat8()
2143
BranchFormat.register_format(__format5)
2144
BranchFormat.register_format(BranchReferenceFormat())
2145
BranchFormat.register_format(__format6)
2146
BranchFormat.register_format(__format7)
2147
BranchFormat.register_format(__format8)
2148
BranchFormat.set_default_format(__format7)
2149
_legacy_formats = [BzrBranchFormat4(),
2151
network_format_registry.register(
2152
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2155
class BzrBranch(Branch, _RelockDebugMixin):
2156
"""A branch stored in the actual filesystem.
2158
Note that it's "local" in the context of the filesystem; it doesn't
2159
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2160
it's writable, and can be accessed via the normal filesystem API.
2162
:ivar _transport: Transport for file operations on this branch's
2163
control files, typically pointing to the .bzr/branch directory.
2164
:ivar repository: Repository for this branch.
2165
:ivar base: The url of the base directory for this branch; the one
2166
containing the .bzr directory.
2167
:ivar name: Optional colocated branch name as it exists in the control
2171
def __init__(self, _format=None,
2172
_control_files=None, a_bzrdir=None, name=None,
2173
_repository=None, ignore_fallbacks=False):
2174
"""Create new branch object at a particular location."""
2175
if a_bzrdir is None:
2176
raise ValueError('a_bzrdir must be supplied')
2178
self.bzrdir = a_bzrdir
2179
self._base = self.bzrdir.transport.clone('..').base
2181
# XXX: We should be able to just do
2182
# self.base = self.bzrdir.root_transport.base
2183
# but this does not quite work yet -- mbp 20080522
2184
self._format = _format
2185
if _control_files is None:
2186
raise ValueError('BzrBranch _control_files is None')
2187
self.control_files = _control_files
2188
self._transport = _control_files._transport
2189
self.repository = _repository
2190
Branch.__init__(self)
2193
if self.name is None:
2194
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2196
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2201
def _get_base(self):
2202
"""Returns the directory containing the control directory."""
2205
base = property(_get_base, doc="The URL for the root of this branch.")
2207
def _get_config(self):
2208
return TransportConfig(self._transport, 'branch.conf')
2210
def is_locked(self):
2211
return self.control_files.is_locked()
2213
def lock_write(self, token=None):
2214
if not self.is_locked():
2215
self._note_lock('w')
2216
# All-in-one needs to always unlock/lock.
2217
repo_control = getattr(self.repository, 'control_files', None)
2218
if self.control_files == repo_control or not self.is_locked():
2219
self.repository._warn_if_deprecated(self)
2220
self.repository.lock_write()
2225
return self.control_files.lock_write(token=token)
2228
self.repository.unlock()
2231
def lock_read(self):
2232
if not self.is_locked():
2233
self._note_lock('r')
2234
# All-in-one needs to always unlock/lock.
2235
repo_control = getattr(self.repository, 'control_files', None)
2236
if self.control_files == repo_control or not self.is_locked():
2237
self.repository._warn_if_deprecated(self)
2238
self.repository.lock_read()
2243
self.control_files.lock_read()
2246
self.repository.unlock()
2249
@only_raises(errors.LockNotHeld, errors.LockBroken)
2252
self.control_files.unlock()
2254
# All-in-one needs to always unlock/lock.
2255
repo_control = getattr(self.repository, 'control_files', None)
2256
if (self.control_files == repo_control or
2257
not self.control_files.is_locked()):
2258
self.repository.unlock()
2259
if not self.control_files.is_locked():
2260
# we just released the lock
2261
self._clear_cached_state()
2263
def peek_lock_mode(self):
2264
if self.control_files._lock_count == 0:
2267
return self.control_files._lock_mode
2269
def get_physical_lock_status(self):
2270
return self.control_files.get_physical_lock_status()
2273
def print_file(self, file, revision_id):
2274
"""See Branch.print_file."""
2275
return self.repository.print_file(file, revision_id)
2277
def _write_revision_history(self, history):
2278
"""Factored out of set_revision_history.
2280
This performs the actual writing to disk.
2281
It is intended to be called by BzrBranch5.set_revision_history."""
2282
self._transport.put_bytes(
2283
'revision-history', '\n'.join(history),
2284
mode=self.bzrdir._get_file_mode())
2287
def set_revision_history(self, rev_history):
2288
"""See Branch.set_revision_history."""
2289
if 'evil' in debug.debug_flags:
2290
mutter_callsite(3, "set_revision_history scales with history.")
2291
check_not_reserved_id = _mod_revision.check_not_reserved_id
2292
for rev_id in rev_history:
2293
check_not_reserved_id(rev_id)
2294
if Branch.hooks['post_change_branch_tip']:
2295
# Don't calculate the last_revision_info() if there are no hooks
2297
old_revno, old_revid = self.last_revision_info()
2298
if len(rev_history) == 0:
2299
revid = _mod_revision.NULL_REVISION
2301
revid = rev_history[-1]
2302
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2303
self._write_revision_history(rev_history)
2304
self._clear_cached_state()
2305
self._cache_revision_history(rev_history)
2306
for hook in Branch.hooks['set_rh']:
2307
hook(self, rev_history)
2308
if Branch.hooks['post_change_branch_tip']:
2309
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2311
def _synchronize_history(self, destination, revision_id):
2312
"""Synchronize last revision and revision history between branches.
2314
This version is most efficient when the destination is also a
2315
BzrBranch5, but works for BzrBranch6 as long as the revision
2316
history is the true lefthand parent history, and all of the revisions
2317
are in the destination's repository. If not, set_revision_history
2320
:param destination: The branch to copy the history into
2321
:param revision_id: The revision-id to truncate history at. May
2322
be None to copy complete history.
2324
if not isinstance(destination._format, BzrBranchFormat5):
2325
super(BzrBranch, self)._synchronize_history(
2326
destination, revision_id)
2328
if revision_id == _mod_revision.NULL_REVISION:
2331
new_history = self.revision_history()
2332
if revision_id is not None and new_history != []:
2334
new_history = new_history[:new_history.index(revision_id) + 1]
2336
rev = self.repository.get_revision(revision_id)
2337
new_history = rev.get_history(self.repository)[1:]
2338
destination.set_revision_history(new_history)
2341
def set_last_revision_info(self, revno, revision_id):
2342
"""Set the last revision of this branch.
2344
The caller is responsible for checking that the revno is correct
2345
for this revision id.
2347
It may be possible to set the branch last revision to an id not
2348
present in the repository. However, branches can also be
2349
configured to check constraints on history, in which case this may not
2352
revision_id = _mod_revision.ensure_null(revision_id)
2353
# this old format stores the full history, but this api doesn't
2354
# provide it, so we must generate, and might as well check it's
2356
history = self._lefthand_history(revision_id)
2357
if len(history) != revno:
2358
raise AssertionError('%d != %d' % (len(history), revno))
2359
self.set_revision_history(history)
2361
def _gen_revision_history(self):
2362
history = self._transport.get_bytes('revision-history').split('\n')
2363
if history[-1:] == ['']:
2364
# There shouldn't be a trailing newline, but just in case.
2369
def generate_revision_history(self, revision_id, last_rev=None,
2371
"""Create a new revision history that will finish with revision_id.
2373
:param revision_id: the new tip to use.
2374
:param last_rev: The previous last_revision. If not None, then this
2375
must be a ancestory of revision_id, or DivergedBranches is raised.
2376
:param other_branch: The other branch that DivergedBranches should
2377
raise with respect to.
2379
self.set_revision_history(self._lefthand_history(revision_id,
2380
last_rev, other_branch))
2382
def basis_tree(self):
2383
"""See Branch.basis_tree."""
2384
return self.repository.revision_tree(self.last_revision())
2386
def _get_parent_location(self):
2387
_locs = ['parent', 'pull', 'x-pull']
2390
return self._transport.get_bytes(l).strip('\n')
2391
except errors.NoSuchFile:
2395
def _basic_push(self, target, overwrite, stop_revision):
2396
"""Basic implementation of push without bound branches or hooks.
2398
Must be called with source read locked and target write locked.
2400
result = BranchPushResult()
2401
result.source_branch = self
2402
result.target_branch = target
2403
result.old_revno, result.old_revid = target.last_revision_info()
2404
self.update_references(target)
2405
if result.old_revid != self.last_revision():
2406
# We assume that during 'push' this repository is closer than
2408
graph = self.repository.get_graph(target.repository)
2409
target.update_revisions(self, stop_revision,
2410
overwrite=overwrite, graph=graph)
2411
if self._push_should_merge_tags():
2412
result.tag_conflicts = self.tags.merge_to(target.tags,
2414
result.new_revno, result.new_revid = target.last_revision_info()
2417
def get_stacked_on_url(self):
2418
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2420
def set_push_location(self, location):
2421
"""See Branch.set_push_location."""
2422
self.get_config().set_user_option(
2423
'push_location', location,
2424
store=_mod_config.STORE_LOCATION_NORECURSE)
2426
def _set_parent_location(self, url):
2428
self._transport.delete('parent')
2430
self._transport.put_bytes('parent', url + '\n',
2431
mode=self.bzrdir._get_file_mode())
2434
class BzrBranch5(BzrBranch):
2435
"""A format 5 branch. This supports new features over plain branches.
2437
It has support for a master_branch which is the data for bound branches.
2440
def get_bound_location(self):
2442
return self._transport.get_bytes('bound')[:-1]
2443
except errors.NoSuchFile:
2447
def get_master_branch(self, possible_transports=None):
2448
"""Return the branch we are bound to.
2450
:return: Either a Branch, or None
2452
This could memoise the branch, but if thats done
2453
it must be revalidated on each new lock.
2454
So for now we just don't memoise it.
2455
# RBC 20060304 review this decision.
2457
bound_loc = self.get_bound_location()
2461
return Branch.open(bound_loc,
2462
possible_transports=possible_transports)
2463
except (errors.NotBranchError, errors.ConnectionError), e:
2464
raise errors.BoundBranchConnectionFailure(
2468
def set_bound_location(self, location):
2469
"""Set the target where this branch is bound to.
2471
:param location: URL to the target branch
2474
self._transport.put_bytes('bound', location+'\n',
2475
mode=self.bzrdir._get_file_mode())
2478
self._transport.delete('bound')
2479
except errors.NoSuchFile:
2484
def bind(self, other):
2485
"""Bind this branch to the branch other.
2487
This does not push or pull data between the branches, though it does
2488
check for divergence to raise an error when the branches are not
2489
either the same, or one a prefix of the other. That behaviour may not
2490
be useful, so that check may be removed in future.
2492
:param other: The branch to bind to
2495
# TODO: jam 20051230 Consider checking if the target is bound
2496
# It is debatable whether you should be able to bind to
2497
# a branch which is itself bound.
2498
# Committing is obviously forbidden,
2499
# but binding itself may not be.
2500
# Since we *have* to check at commit time, we don't
2501
# *need* to check here
2503
# we want to raise diverged if:
2504
# last_rev is not in the other_last_rev history, AND
2505
# other_last_rev is not in our history, and do it without pulling
2507
self.set_bound_location(other.base)
2511
"""If bound, unbind"""
2512
return self.set_bound_location(None)
2515
def update(self, possible_transports=None):
2516
"""Synchronise this branch with the master branch if any.
2518
:return: None or the last_revision that was pivoted out during the
2521
master = self.get_master_branch(possible_transports)
2522
if master is not None:
2523
old_tip = _mod_revision.ensure_null(self.last_revision())
2524
self.pull(master, overwrite=True)
2525
if self.repository.get_graph().is_ancestor(old_tip,
2526
_mod_revision.ensure_null(self.last_revision())):
2532
class BzrBranch8(BzrBranch5):
2533
"""A branch that stores tree-reference locations."""
2535
def _open_hook(self):
2536
if self._ignore_fallbacks:
2539
url = self.get_stacked_on_url()
2540
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2541
errors.UnstackableBranchFormat):
2544
for hook in Branch.hooks['transform_fallback_location']:
2545
url = hook(self, url)
2547
hook_name = Branch.hooks.get_hook_name(hook)
2548
raise AssertionError(
2549
"'transform_fallback_location' hook %s returned "
2550
"None, not a URL." % hook_name)
2551
self._activate_fallback_location(url)
2553
def __init__(self, *args, **kwargs):
2554
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2555
super(BzrBranch8, self).__init__(*args, **kwargs)
2556
self._last_revision_info_cache = None
2557
self._reference_info = None
2559
def _clear_cached_state(self):
2560
super(BzrBranch8, self)._clear_cached_state()
2561
self._last_revision_info_cache = None
2562
self._reference_info = None
2564
def _last_revision_info(self):
2565
revision_string = self._transport.get_bytes('last-revision')
2566
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2567
revision_id = cache_utf8.get_cached_utf8(revision_id)
2569
return revno, revision_id
2571
def _write_last_revision_info(self, revno, revision_id):
2572
"""Simply write out the revision id, with no checks.
2574
Use set_last_revision_info to perform this safely.
2576
Does not update the revision_history cache.
2577
Intended to be called by set_last_revision_info and
2578
_write_revision_history.
2580
revision_id = _mod_revision.ensure_null(revision_id)
2581
out_string = '%d %s\n' % (revno, revision_id)
2582
self._transport.put_bytes('last-revision', out_string,
2583
mode=self.bzrdir._get_file_mode())
2586
def set_last_revision_info(self, revno, revision_id):
2587
revision_id = _mod_revision.ensure_null(revision_id)
2588
old_revno, old_revid = self.last_revision_info()
2589
if self._get_append_revisions_only():
2590
self._check_history_violation(revision_id)
2591
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2592
self._write_last_revision_info(revno, revision_id)
2593
self._clear_cached_state()
2594
self._last_revision_info_cache = revno, revision_id
2595
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2597
def _synchronize_history(self, destination, revision_id):
2598
"""Synchronize last revision and revision history between branches.
2600
:see: Branch._synchronize_history
2602
# XXX: The base Branch has a fast implementation of this method based
2603
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2604
# that uses set_revision_history. This class inherits from BzrBranch5,
2605
# but wants the fast implementation, so it calls
2606
# Branch._synchronize_history directly.
2607
Branch._synchronize_history(self, destination, revision_id)
2609
def _check_history_violation(self, revision_id):
2610
last_revision = _mod_revision.ensure_null(self.last_revision())
2611
if _mod_revision.is_null(last_revision):
2613
if last_revision not in self._lefthand_history(revision_id):
2614
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2616
def _gen_revision_history(self):
2617
"""Generate the revision history from last revision
2619
last_revno, last_revision = self.last_revision_info()
2620
self._extend_partial_history(stop_index=last_revno-1)
2621
return list(reversed(self._partial_revision_history_cache))
2623
def _write_revision_history(self, history):
2624
"""Factored out of set_revision_history.
2626
This performs the actual writing to disk, with format-specific checks.
2627
It is intended to be called by BzrBranch5.set_revision_history.
2629
if len(history) == 0:
2630
last_revision = 'null:'
2632
if history != self._lefthand_history(history[-1]):
2633
raise errors.NotLefthandHistory(history)
2634
last_revision = history[-1]
2635
if self._get_append_revisions_only():
2636
self._check_history_violation(last_revision)
2637
self._write_last_revision_info(len(history), last_revision)
2640
def _set_parent_location(self, url):
2641
"""Set the parent branch"""
2642
self._set_config_location('parent_location', url, make_relative=True)
2645
def _get_parent_location(self):
2646
"""Set the parent branch"""
2647
return self._get_config_location('parent_location')
2650
def _set_all_reference_info(self, info_dict):
2651
"""Replace all reference info stored in a branch.
2653
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2656
writer = rio.RioWriter(s)
2657
for key, (tree_path, branch_location) in info_dict.iteritems():
2658
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2659
branch_location=branch_location)
2660
writer.write_stanza(stanza)
2661
self._transport.put_bytes('references', s.getvalue())
2662
self._reference_info = info_dict
2665
def _get_all_reference_info(self):
2666
"""Return all the reference info stored in a branch.
2668
:return: A dict of {file_id: (tree_path, branch_location)}
2670
if self._reference_info is not None:
2671
return self._reference_info
2672
rio_file = self._transport.get('references')
2674
stanzas = rio.read_stanzas(rio_file)
2675
info_dict = dict((s['file_id'], (s['tree_path'],
2676
s['branch_location'])) for s in stanzas)
2679
self._reference_info = info_dict
2682
def set_reference_info(self, file_id, tree_path, branch_location):
2683
"""Set the branch location to use for a tree reference.
2685
:param file_id: The file-id of the tree reference.
2686
:param tree_path: The path of the tree reference in the tree.
2687
:param branch_location: The location of the branch to retrieve tree
2690
info_dict = self._get_all_reference_info()
2691
info_dict[file_id] = (tree_path, branch_location)
2692
if None in (tree_path, branch_location):
2693
if tree_path is not None:
2694
raise ValueError('tree_path must be None when branch_location'
2696
if branch_location is not None:
2697
raise ValueError('branch_location must be None when tree_path'
2699
del info_dict[file_id]
2700
self._set_all_reference_info(info_dict)
2702
def get_reference_info(self, file_id):
2703
"""Get the tree_path and branch_location for a tree reference.
2705
:return: a tuple of (tree_path, branch_location)
2707
return self._get_all_reference_info().get(file_id, (None, None))
2709
def reference_parent(self, file_id, path, possible_transports=None):
2710
"""Return the parent branch for a tree-reference file_id.
2712
:param file_id: The file_id of the tree reference
2713
:param path: The path of the file_id in the tree
2714
:return: A branch associated with the file_id
2716
branch_location = self.get_reference_info(file_id)[1]
2717
if branch_location is None:
2718
return Branch.reference_parent(self, file_id, path,
2719
possible_transports)
2720
branch_location = urlutils.join(self.user_url, branch_location)
2721
return Branch.open(branch_location,
2722
possible_transports=possible_transports)
2724
def set_push_location(self, location):
2725
"""See Branch.set_push_location."""
2726
self._set_config_location('push_location', location)
2728
def set_bound_location(self, location):
2729
"""See Branch.set_push_location."""
2731
config = self.get_config()
2732
if location is None:
2733
if config.get_user_option('bound') != 'True':
2736
config.set_user_option('bound', 'False', warn_masked=True)
2739
self._set_config_location('bound_location', location,
2741
config.set_user_option('bound', 'True', warn_masked=True)
2744
def _get_bound_location(self, bound):
2745
"""Return the bound location in the config file.
2747
Return None if the bound parameter does not match"""
2748
config = self.get_config()
2749
config_bound = (config.get_user_option('bound') == 'True')
2750
if config_bound != bound:
2752
return self._get_config_location('bound_location', config=config)
2754
def get_bound_location(self):
2755
"""See Branch.set_push_location."""
2756
return self._get_bound_location(True)
2758
def get_old_bound_location(self):
2759
"""See Branch.get_old_bound_location"""
2760
return self._get_bound_location(False)
2762
def get_stacked_on_url(self):
2763
# you can always ask for the URL; but you might not be able to use it
2764
# if the repo can't support stacking.
2765
## self._check_stackable_repo()
2766
stacked_url = self._get_config_location('stacked_on_location')
2767
if stacked_url is None:
2768
raise errors.NotStacked(self)
2771
def _get_append_revisions_only(self):
2772
value = self.get_config().get_user_option('append_revisions_only')
2773
return value == 'True'
2776
def generate_revision_history(self, revision_id, last_rev=None,
2778
"""See BzrBranch5.generate_revision_history"""
2779
history = self._lefthand_history(revision_id, last_rev, other_branch)
2780
revno = len(history)
2781
self.set_last_revision_info(revno, revision_id)
2784
def get_rev_id(self, revno, history=None):
2785
"""Find the revision id of the specified revno."""
2787
return _mod_revision.NULL_REVISION
2789
last_revno, last_revision_id = self.last_revision_info()
2790
if revno <= 0 or revno > last_revno:
2791
raise errors.NoSuchRevision(self, revno)
2793
if history is not None:
2794
return history[revno - 1]
2796
index = last_revno - revno
2797
if len(self._partial_revision_history_cache) <= index:
2798
self._extend_partial_history(stop_index=index)
2799
if len(self._partial_revision_history_cache) > index:
2800
return self._partial_revision_history_cache[index]
2802
raise errors.NoSuchRevision(self, revno)
2805
def revision_id_to_revno(self, revision_id):
2806
"""Given a revision id, return its revno"""
2807
if _mod_revision.is_null(revision_id):
2810
index = self._partial_revision_history_cache.index(revision_id)
2812
self._extend_partial_history(stop_revision=revision_id)
2813
index = len(self._partial_revision_history_cache) - 1
2814
if self._partial_revision_history_cache[index] != revision_id:
2815
raise errors.NoSuchRevision(self, revision_id)
2816
return self.revno() - index
2819
class BzrBranch7(BzrBranch8):
2820
"""A branch with support for a fallback repository."""
2822
def set_reference_info(self, file_id, tree_path, branch_location):
2823
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2825
def get_reference_info(self, file_id):
2826
Branch.get_reference_info(self, file_id)
2828
def reference_parent(self, file_id, path, possible_transports=None):
2829
return Branch.reference_parent(self, file_id, path,
2830
possible_transports)
2833
class BzrBranch6(BzrBranch7):
2834
"""See BzrBranchFormat6 for the capabilities of this branch.
2836
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2840
def get_stacked_on_url(self):
2841
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2844
######################################################################
2845
# results of operations
2848
class _Result(object):
2850
def _show_tag_conficts(self, to_file):
2851
if not getattr(self, 'tag_conflicts', None):
2853
to_file.write('Conflicting tags:\n')
2854
for name, value1, value2 in self.tag_conflicts:
2855
to_file.write(' %s\n' % (name, ))
2858
class PullResult(_Result):
2859
"""Result of a Branch.pull operation.
2861
:ivar old_revno: Revision number before pull.
2862
:ivar new_revno: Revision number after pull.
2863
:ivar old_revid: Tip revision id before pull.
2864
:ivar new_revid: Tip revision id after pull.
2865
:ivar source_branch: Source (local) branch object. (read locked)
2866
:ivar master_branch: Master branch of the target, or the target if no
2868
:ivar local_branch: target branch if there is a Master, else None
2869
:ivar target_branch: Target/destination branch object. (write locked)
2870
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2874
# DEPRECATED: pull used to return the change in revno
2875
return self.new_revno - self.old_revno
2877
def report(self, to_file):
2879
if self.old_revid == self.new_revid:
2880
to_file.write('No revisions to pull.\n')
2882
to_file.write('Now on revision %d.\n' % self.new_revno)
2883
self._show_tag_conficts(to_file)
2886
class BranchPushResult(_Result):
2887
"""Result of a Branch.push operation.
2889
:ivar old_revno: Revision number (eg 10) of the target before push.
2890
:ivar new_revno: Revision number (eg 12) of the target after push.
2891
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2893
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2895
:ivar source_branch: Source branch object that the push was from. This is
2896
read locked, and generally is a local (and thus low latency) branch.
2897
:ivar master_branch: If target is a bound branch, the master branch of
2898
target, or target itself. Always write locked.
2899
:ivar target_branch: The direct Branch where data is being sent (write
2901
:ivar local_branch: If the target is a bound branch this will be the
2902
target, otherwise it will be None.
2906
# DEPRECATED: push used to return the change in revno
2907
return self.new_revno - self.old_revno
2909
def report(self, to_file):
2910
"""Write a human-readable description of the result."""
2911
if self.old_revid == self.new_revid:
2912
note('No new revisions to push.')
2914
note('Pushed up to revision %d.' % self.new_revno)
2915
self._show_tag_conficts(to_file)
2918
class BranchCheckResult(object):
2919
"""Results of checking branch consistency.
2924
def __init__(self, branch):
2925
self.branch = branch
2928
def report_results(self, verbose):
2929
"""Report the check results via trace.note.
2931
:param verbose: Requests more detailed display of what was checked,
2934
note('checked branch %s format %s', self.branch.user_url,
2935
self.branch._format)
2936
for error in self.errors:
2937
note('found error:%s', error)
2940
class Converter5to6(object):
2941
"""Perform an in-place upgrade of format 5 to format 6"""
2943
def convert(self, branch):
2944
# Data for 5 and 6 can peacefully coexist.
2945
format = BzrBranchFormat6()
2946
new_branch = format.open(branch.bzrdir, _found=True)
2948
# Copy source data into target
2949
new_branch._write_last_revision_info(*branch.last_revision_info())
2950
new_branch.set_parent(branch.get_parent())
2951
new_branch.set_bound_location(branch.get_bound_location())
2952
new_branch.set_push_location(branch.get_push_location())
2954
# New branch has no tags by default
2955
new_branch.tags._set_tag_dict({})
2957
# Copying done; now update target format
2958
new_branch._transport.put_bytes('format',
2959
format.get_format_string(),
2960
mode=new_branch.bzrdir._get_file_mode())
2962
# Clean up old files
2963
new_branch._transport.delete('revision-history')
2965
branch.set_parent(None)
2966
except errors.NoSuchFile:
2968
branch.set_bound_location(None)
2971
class Converter6to7(object):
2972
"""Perform an in-place upgrade of format 6 to format 7"""
2974
def convert(self, branch):
2975
format = BzrBranchFormat7()
2976
branch._set_config_location('stacked_on_location', '')
2977
# update target format
2978
branch._transport.put_bytes('format', format.get_format_string())
2981
class Converter7to8(object):
2982
"""Perform an in-place upgrade of format 6 to format 7"""
2984
def convert(self, branch):
2985
format = BzrBranchFormat8()
2986
branch._transport.put_bytes('references', '')
2987
# update target format
2988
branch._transport.put_bytes('format', format.get_format_string())
2991
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2992
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2995
_run_with_write_locked_target will attempt to release the lock it acquires.
2997
If an exception is raised by callable, then that exception *will* be
2998
propagated, even if the unlock attempt raises its own error. Thus
2999
_run_with_write_locked_target should be preferred to simply doing::
3003
return callable(*args, **kwargs)
3008
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3009
# should share code?
3012
result = callable(*args, **kwargs)
3014
exc_info = sys.exc_info()
3018
raise exc_info[0], exc_info[1], exc_info[2]
3024
class InterBranch(InterObject):
3025
"""This class represents operations taking place between two branches.
3027
Its instances have methods like pull() and push() and contain
3028
references to the source and target repositories these operations
3029
can be carried out on.
3033
"""The available optimised InterBranch types."""
3036
def _get_branch_formats_to_test():
3037
"""Return a tuple with the Branch formats to use when testing."""
3038
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3040
def pull(self, overwrite=False, stop_revision=None,
3041
possible_transports=None, local=False):
3042
"""Mirror source into target branch.
3044
The target branch is considered to be 'local', having low latency.
3046
:returns: PullResult instance
3048
raise NotImplementedError(self.pull)
3050
def update_revisions(self, stop_revision=None, overwrite=False,
3052
"""Pull in new perfect-fit revisions.
3054
:param stop_revision: Updated until the given revision
3055
:param overwrite: Always set the branch pointer, rather than checking
3056
to see if it is a proper descendant.
3057
:param graph: A Graph object that can be used to query history
3058
information. This can be None.
3061
raise NotImplementedError(self.update_revisions)
3063
def push(self, overwrite=False, stop_revision=None,
3064
_override_hook_source_branch=None):
3065
"""Mirror the source branch into the target branch.
3067
The source branch is considered to be 'local', having low latency.
3069
raise NotImplementedError(self.push)
3072
class GenericInterBranch(InterBranch):
3073
"""InterBranch implementation that uses public Branch functions.
3077
def _get_branch_formats_to_test():
3078
return BranchFormat._default_format, BranchFormat._default_format
3080
def update_revisions(self, stop_revision=None, overwrite=False,
3082
"""See InterBranch.update_revisions()."""
3083
self.source.lock_read()
3085
other_revno, other_last_revision = self.source.last_revision_info()
3086
stop_revno = None # unknown
3087
if stop_revision is None:
3088
stop_revision = other_last_revision
3089
if _mod_revision.is_null(stop_revision):
3090
# if there are no commits, we're done.
3092
stop_revno = other_revno
3094
# what's the current last revision, before we fetch [and change it
3096
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3097
# we fetch here so that we don't process data twice in the common
3098
# case of having something to pull, and so that the check for
3099
# already merged can operate on the just fetched graph, which will
3100
# be cached in memory.
3101
self.target.fetch(self.source, stop_revision)
3102
# Check to see if one is an ancestor of the other
3105
graph = self.target.repository.get_graph()
3106
if self.target._check_if_descendant_or_diverged(
3107
stop_revision, last_rev, graph, self.source):
3108
# stop_revision is a descendant of last_rev, but we aren't
3109
# overwriting, so we're done.
3111
if stop_revno is None:
3113
graph = self.target.repository.get_graph()
3114
this_revno, this_last_revision = \
3115
self.target.last_revision_info()
3116
stop_revno = graph.find_distance_to_null(stop_revision,
3117
[(other_last_revision, other_revno),
3118
(this_last_revision, this_revno)])
3119
self.target.set_last_revision_info(stop_revno, stop_revision)
3121
self.source.unlock()
3123
def pull(self, overwrite=False, stop_revision=None,
3124
possible_transports=None, _hook_master=None, run_hooks=True,
3125
_override_hook_target=None, local=False):
3128
:param _hook_master: Private parameter - set the branch to
3129
be supplied as the master to pull hooks.
3130
:param run_hooks: Private parameter - if false, this branch
3131
is being called because it's the master of the primary branch,
3132
so it should not run its hooks.
3133
:param _override_hook_target: Private parameter - set the branch to be
3134
supplied as the target_branch to pull hooks.
3135
:param local: Only update the local branch, and not the bound branch.
3137
# This type of branch can't be bound.
3139
raise errors.LocalRequiresBoundBranch()
3140
result = PullResult()
3141
result.source_branch = self.source
3142
if _override_hook_target is None:
3143
result.target_branch = self.target
3145
result.target_branch = _override_hook_target
3146
self.source.lock_read()
3148
# We assume that during 'pull' the target repository is closer than
3150
self.source.update_references(self.target)
3151
graph = self.target.repository.get_graph(self.source.repository)
3152
# TODO: Branch formats should have a flag that indicates
3153
# that revno's are expensive, and pull() should honor that flag.
3155
result.old_revno, result.old_revid = \
3156
self.target.last_revision_info()
3157
self.target.update_revisions(self.source, stop_revision,
3158
overwrite=overwrite, graph=graph)
3159
# TODO: The old revid should be specified when merging tags,
3160
# so a tags implementation that versions tags can only
3161
# pull in the most recent changes. -- JRV20090506
3162
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3164
result.new_revno, result.new_revid = self.target.last_revision_info()
3166
result.master_branch = _hook_master
3167
result.local_branch = result.target_branch
3169
result.master_branch = result.target_branch
3170
result.local_branch = None
3172
for hook in Branch.hooks['post_pull']:
3175
self.source.unlock()
3178
def push(self, overwrite=False, stop_revision=None,
3179
_override_hook_source_branch=None):
3180
"""See InterBranch.push.
3182
This is the basic concrete implementation of push()
3184
:param _override_hook_source_branch: If specified, run
3185
the hooks passing this Branch as the source, rather than self.
3186
This is for use of RemoteBranch, where push is delegated to the
3187
underlying vfs-based Branch.
3189
# TODO: Public option to disable running hooks - should be trivial but
3191
self.source.lock_read()
3193
return _run_with_write_locked_target(
3194
self.target, self._push_with_bound_branches, overwrite,
3196
_override_hook_source_branch=_override_hook_source_branch)
3198
self.source.unlock()
3200
def _push_with_bound_branches(self, overwrite, stop_revision,
3201
_override_hook_source_branch=None):
3202
"""Push from source into target, and into target's master if any.
3205
if _override_hook_source_branch:
3206
result.source_branch = _override_hook_source_branch
3207
for hook in Branch.hooks['post_push']:
3210
bound_location = self.target.get_bound_location()
3211
if bound_location and self.target.base != bound_location:
3212
# there is a master branch.
3214
# XXX: Why the second check? Is it even supported for a branch to
3215
# be bound to itself? -- mbp 20070507
3216
master_branch = self.target.get_master_branch()
3217
master_branch.lock_write()
3219
# push into the master from the source branch.
3220
self.source._basic_push(master_branch, overwrite, stop_revision)
3221
# and push into the target branch from the source. Note that we
3222
# push from the source branch again, because its considered the
3223
# highest bandwidth repository.
3224
result = self.source._basic_push(self.target, overwrite,
3226
result.master_branch = master_branch
3227
result.local_branch = self.target
3231
master_branch.unlock()
3234
result = self.source._basic_push(self.target, overwrite,
3236
# TODO: Why set master_branch and local_branch if there's no
3237
# binding? Maybe cleaner to just leave them unset? -- mbp
3239
result.master_branch = self.target
3240
result.local_branch = None
3245
def is_compatible(self, source, target):
3246
# GenericBranch uses the public API, so always compatible
3250
class InterToBranch5(GenericInterBranch):
3253
def _get_branch_formats_to_test():
3254
return BranchFormat._default_format, BzrBranchFormat5()
3256
def pull(self, overwrite=False, stop_revision=None,
3257
possible_transports=None, run_hooks=True,
3258
_override_hook_target=None, local=False):
3259
"""Pull from source into self, updating my master if any.
3261
:param run_hooks: Private parameter - if false, this branch
3262
is being called because it's the master of the primary branch,
3263
so it should not run its hooks.
3265
bound_location = self.target.get_bound_location()
3266
if local and not bound_location:
3267
raise errors.LocalRequiresBoundBranch()
3268
master_branch = None
3269
if not local and bound_location and self.source.user_url != bound_location:
3270
# not pulling from master, so we need to update master.
3271
master_branch = self.target.get_master_branch(possible_transports)
3272
master_branch.lock_write()
3275
# pull from source into master.
3276
master_branch.pull(self.source, overwrite, stop_revision,
3278
return super(InterToBranch5, self).pull(overwrite,
3279
stop_revision, _hook_master=master_branch,
3280
run_hooks=run_hooks,
3281
_override_hook_target=_override_hook_target)
3284
master_branch.unlock()
3287
InterBranch.register_optimiser(GenericInterBranch)
3288
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
