1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
from cStringIO import StringIO
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from itertools import chain
27
config as _mod_config,
33
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TransportConfig
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
from bzrlib.hooks import HookPoint, Hooks
51
from bzrlib.inter import InterObject
52
from bzrlib.lock import _RelockDebugMixin
53
from bzrlib import registry
54
from bzrlib.symbol_versioning import (
58
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
61
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
62
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
66
# TODO: Maybe include checks for common corruption of newlines, etc?
68
# TODO: Some operations like log might retrieve the same revisions
69
# repeatedly to calculate deltas. We could perhaps have a weakref
70
# cache in memory to make this faster. In general anything can be
71
# cached in memory between lock and unlock operations. .. nb thats
72
# what the transaction identity map provides
75
######################################################################
79
"""Branch holding a history of revisions.
82
Base directory/url of the branch.
84
hooks: An instance of BranchHooks.
86
# this is really an instance variable - FIXME move it there
90
def __init__(self, *ignored, **ignored_too):
91
self.tags = self._format.make_tags(self)
92
self._revision_history_cache = None
93
self._revision_id_to_revno_cache = None
94
self._partial_revision_id_to_revno_cache = {}
95
self._partial_revision_history_cache = []
96
self._last_revision_info_cache = None
97
self._merge_sorted_revisions_cache = None
99
hooks = Branch.hooks['open']
103
def _open_hook(self):
104
"""Called by init to allow simpler extension of the base class."""
106
def _activate_fallback_location(self, url):
107
"""Activate the branch/repository from url as a fallback repository."""
108
repo = self._get_fallback_repository(url)
109
if repo.has_same_location(self.repository):
110
raise errors.UnstackableLocationError(self.base, url)
111
self.repository.add_fallback_repository(repo)
113
def break_lock(self):
114
"""Break a lock if one is present from another instance.
116
Uses the ui factory to ask for confirmation if the lock may be from
119
This will probe the repository for its lock as well.
121
self.control_files.break_lock()
122
self.repository.break_lock()
123
master = self.get_master_branch()
124
if master is not None:
127
def _check_stackable_repo(self):
128
if not self.repository._format.supports_external_lookups:
129
raise errors.UnstackableRepositoryFormat(self.repository._format,
130
self.repository.base)
132
def _extend_partial_history(self, stop_index=None, stop_revision=None):
133
"""Extend the partial history to include a given index
135
If a stop_index is supplied, stop when that index has been reached.
136
If a stop_revision is supplied, stop when that revision is
137
encountered. Otherwise, stop when the beginning of history is
140
:param stop_index: The index which should be present. When it is
141
present, history extension will stop.
142
:param stop_revision: The revision id which should be present. When
143
it is encountered, history extension will stop.
145
if len(self._partial_revision_history_cache) == 0:
146
self._partial_revision_history_cache = [self.last_revision()]
147
repository._iter_for_revno(
148
self.repository, self._partial_revision_history_cache,
149
stop_index=stop_index, stop_revision=stop_revision)
150
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
151
self._partial_revision_history_cache.pop()
153
def _get_check_refs(self):
154
"""Get the references needed for check().
158
revid = self.last_revision()
159
return [('revision-existence', revid), ('lefthand-distance', revid)]
162
def open(base, _unsupported=False, possible_transports=None):
163
"""Open the branch rooted at base.
165
For instance, if the branch is at URL/.bzr/branch,
166
Branch.open(URL) -> a Branch instance.
168
control = bzrdir.BzrDir.open(base, _unsupported,
169
possible_transports=possible_transports)
170
return control.open_branch(unsupported=_unsupported)
173
def open_from_transport(transport, name=None, _unsupported=False):
174
"""Open the branch rooted at transport"""
175
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
176
return control.open_branch(name=name, unsupported=_unsupported)
179
def open_containing(url, possible_transports=None):
180
"""Open an existing branch which contains url.
182
This probes for a branch at url, and searches upwards from there.
184
Basically we keep looking up until we find the control directory or
185
run into the root. If there isn't one, raises NotBranchError.
186
If there is one and it is either an unrecognised format or an unsupported
187
format, UnknownFormatError or UnsupportedFormatError are raised.
188
If there is one, it is returned, along with the unused portion of url.
190
control, relpath = bzrdir.BzrDir.open_containing(url,
192
return control.open_branch(), relpath
194
def _push_should_merge_tags(self):
195
"""Should _basic_push merge this branch's tags into the target?
197
The default implementation returns False if this branch has no tags,
198
and True the rest of the time. Subclasses may override this.
200
return self.supports_tags() and self.tags.get_tag_dict()
202
def get_config(self):
203
return BranchConfig(self)
205
def _get_config(self):
206
"""Get the concrete config for just the config in this branch.
208
This is not intended for client use; see Branch.get_config for the
213
:return: An object supporting get_option and set_option.
215
raise NotImplementedError(self._get_config)
217
def _get_fallback_repository(self, url):
218
"""Get the repository we fallback to at url."""
219
url = urlutils.join(self.base, url)
220
a_branch = Branch.open(url,
221
possible_transports=[self.bzrdir.root_transport])
222
return a_branch.repository
224
def _get_tags_bytes(self):
225
"""Get the bytes of a serialised tags dict.
227
Note that not all branches support tags, nor do all use the same tags
228
logic: this method is specific to BasicTags. Other tag implementations
229
may use the same method name and behave differently, safely, because
230
of the double-dispatch via
231
format.make_tags->tags_instance->get_tags_dict.
233
:return: The bytes of the tags file.
234
:seealso: Branch._set_tags_bytes.
236
return self._transport.get_bytes('tags')
238
def _get_nick(self, local=False, possible_transports=None):
239
config = self.get_config()
240
# explicit overrides master, but don't look for master if local is True
241
if not local and not config.has_explicit_nickname():
243
master = self.get_master_branch(possible_transports)
244
if master is not None:
245
# return the master branch value
247
except errors.BzrError, e:
248
# Silently fall back to local implicit nick if the master is
250
mutter("Could not connect to bound branch, "
251
"falling back to local nick.\n " + str(e))
252
return config.get_nickname()
254
def _set_nick(self, nick):
255
self.get_config().set_user_option('nickname', nick, warn_masked=True)
257
nick = property(_get_nick, _set_nick)
260
raise NotImplementedError(self.is_locked)
262
def _lefthand_history(self, revision_id, last_rev=None,
264
if 'evil' in debug.debug_flags:
265
mutter_callsite(4, "_lefthand_history scales with history.")
266
# stop_revision must be a descendant of last_revision
267
graph = self.repository.get_graph()
268
if last_rev is not None:
269
if not graph.is_ancestor(last_rev, revision_id):
270
# our previous tip is not merged into stop_revision
271
raise errors.DivergedBranches(self, other_branch)
272
# make a new revision history from the graph
273
parents_map = graph.get_parent_map([revision_id])
274
if revision_id not in parents_map:
275
raise errors.NoSuchRevision(self, revision_id)
276
current_rev_id = revision_id
278
check_not_reserved_id = _mod_revision.check_not_reserved_id
279
# Do not include ghosts or graph origin in revision_history
280
while (current_rev_id in parents_map and
281
len(parents_map[current_rev_id]) > 0):
282
check_not_reserved_id(current_rev_id)
283
new_history.append(current_rev_id)
284
current_rev_id = parents_map[current_rev_id][0]
285
parents_map = graph.get_parent_map([current_rev_id])
286
new_history.reverse()
289
def lock_write(self):
290
raise NotImplementedError(self.lock_write)
293
raise NotImplementedError(self.lock_read)
296
raise NotImplementedError(self.unlock)
298
def peek_lock_mode(self):
299
"""Return lock mode for the Branch: 'r', 'w' or None"""
300
raise NotImplementedError(self.peek_lock_mode)
302
def get_physical_lock_status(self):
303
raise NotImplementedError(self.get_physical_lock_status)
306
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
307
"""Return the revision_id for a dotted revno.
309
:param revno: a tuple like (1,) or (1,1,2)
310
:param _cache_reverse: a private parameter enabling storage
311
of the reverse mapping in a top level cache. (This should
312
only be done in selective circumstances as we want to
313
avoid having the mapping cached multiple times.)
314
:return: the revision_id
315
:raises errors.NoSuchRevision: if the revno doesn't exist
317
rev_id = self._do_dotted_revno_to_revision_id(revno)
319
self._partial_revision_id_to_revno_cache[rev_id] = revno
322
def _do_dotted_revno_to_revision_id(self, revno):
323
"""Worker function for dotted_revno_to_revision_id.
325
Subclasses should override this if they wish to
326
provide a more efficient implementation.
329
return self.get_rev_id(revno[0])
330
revision_id_to_revno = self.get_revision_id_to_revno_map()
331
revision_ids = [revision_id for revision_id, this_revno
332
in revision_id_to_revno.iteritems()
333
if revno == this_revno]
334
if len(revision_ids) == 1:
335
return revision_ids[0]
337
revno_str = '.'.join(map(str, revno))
338
raise errors.NoSuchRevision(self, revno_str)
341
def revision_id_to_dotted_revno(self, revision_id):
342
"""Given a revision id, return its dotted revno.
344
:return: a tuple like (1,) or (400,1,3).
346
return self._do_revision_id_to_dotted_revno(revision_id)
348
def _do_revision_id_to_dotted_revno(self, revision_id):
349
"""Worker function for revision_id_to_revno."""
350
# Try the caches if they are loaded
351
result = self._partial_revision_id_to_revno_cache.get(revision_id)
352
if result is not None:
354
if self._revision_id_to_revno_cache:
355
result = self._revision_id_to_revno_cache.get(revision_id)
357
raise errors.NoSuchRevision(self, revision_id)
358
# Try the mainline as it's optimised
360
revno = self.revision_id_to_revno(revision_id)
362
except errors.NoSuchRevision:
363
# We need to load and use the full revno map after all
364
result = self.get_revision_id_to_revno_map().get(revision_id)
366
raise errors.NoSuchRevision(self, revision_id)
370
def get_revision_id_to_revno_map(self):
371
"""Return the revision_id => dotted revno map.
373
This will be regenerated on demand, but will be cached.
375
:return: A dictionary mapping revision_id => dotted revno.
376
This dictionary should not be modified by the caller.
378
if self._revision_id_to_revno_cache is not None:
379
mapping = self._revision_id_to_revno_cache
381
mapping = self._gen_revno_map()
382
self._cache_revision_id_to_revno(mapping)
383
# TODO: jam 20070417 Since this is being cached, should we be returning
385
# I would rather not, and instead just declare that users should not
386
# modify the return value.
389
def _gen_revno_map(self):
390
"""Create a new mapping from revision ids to dotted revnos.
392
Dotted revnos are generated based on the current tip in the revision
394
This is the worker function for get_revision_id_to_revno_map, which
395
just caches the return value.
397
:return: A dictionary mapping revision_id => dotted revno.
399
revision_id_to_revno = dict((rev_id, revno)
400
for rev_id, depth, revno, end_of_merge
401
in self.iter_merge_sorted_revisions())
402
return revision_id_to_revno
405
def iter_merge_sorted_revisions(self, start_revision_id=None,
406
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
407
"""Walk the revisions for a branch in merge sorted order.
409
Merge sorted order is the output from a merge-aware,
410
topological sort, i.e. all parents come before their
411
children going forward; the opposite for reverse.
413
:param start_revision_id: the revision_id to begin walking from.
414
If None, the branch tip is used.
415
:param stop_revision_id: the revision_id to terminate the walk
416
after. If None, the rest of history is included.
417
:param stop_rule: if stop_revision_id is not None, the precise rule
418
to use for termination:
419
* 'exclude' - leave the stop revision out of the result (default)
420
* 'include' - the stop revision is the last item in the result
421
* 'with-merges' - include the stop revision and all of its
422
merged revisions in the result
423
:param direction: either 'reverse' or 'forward':
424
* reverse means return the start_revision_id first, i.e.
425
start at the most recent revision and go backwards in history
426
* forward returns tuples in the opposite order to reverse.
427
Note in particular that forward does *not* do any intelligent
428
ordering w.r.t. depth as some clients of this API may like.
429
(If required, that ought to be done at higher layers.)
431
:return: an iterator over (revision_id, depth, revno, end_of_merge)
434
* revision_id: the unique id of the revision
435
* depth: How many levels of merging deep this node has been
437
* revno_sequence: This field provides a sequence of
438
revision numbers for all revisions. The format is:
439
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
440
branch that the revno is on. From left to right the REVNO numbers
441
are the sequence numbers within that branch of the revision.
442
* end_of_merge: When True the next node (earlier in history) is
443
part of a different merge.
445
# Note: depth and revno values are in the context of the branch so
446
# we need the full graph to get stable numbers, regardless of the
448
if self._merge_sorted_revisions_cache is None:
449
last_revision = self.last_revision()
450
last_key = (last_revision,)
451
known_graph = self.repository.revisions.get_known_graph_ancestry(
453
self._merge_sorted_revisions_cache = known_graph.merge_sort(
455
filtered = self._filter_merge_sorted_revisions(
456
self._merge_sorted_revisions_cache, start_revision_id,
457
stop_revision_id, stop_rule)
458
if direction == 'reverse':
460
if direction == 'forward':
461
return reversed(list(filtered))
463
raise ValueError('invalid direction %r' % direction)
465
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
466
start_revision_id, stop_revision_id, stop_rule):
467
"""Iterate over an inclusive range of sorted revisions."""
468
rev_iter = iter(merge_sorted_revisions)
469
if start_revision_id is not None:
470
for node in rev_iter:
471
rev_id = node.key[-1]
472
if rev_id != start_revision_id:
475
# The decision to include the start or not
476
# depends on the stop_rule if a stop is provided
477
# so pop this node back into the iterator
478
rev_iter = chain(iter([node]), rev_iter)
480
if stop_revision_id is None:
482
for node in rev_iter:
483
rev_id = node.key[-1]
484
yield (rev_id, node.merge_depth, node.revno,
486
elif stop_rule == 'exclude':
487
for node in rev_iter:
488
rev_id = node.key[-1]
489
if rev_id == stop_revision_id:
491
yield (rev_id, node.merge_depth, node.revno,
493
elif stop_rule == 'include':
494
for node in rev_iter:
495
rev_id = node.key[-1]
496
yield (rev_id, node.merge_depth, node.revno,
498
if rev_id == stop_revision_id:
500
elif stop_rule == 'with-merges':
501
stop_rev = self.repository.get_revision(stop_revision_id)
502
if stop_rev.parent_ids:
503
left_parent = stop_rev.parent_ids[0]
505
left_parent = _mod_revision.NULL_REVISION
506
# left_parent is the actual revision we want to stop logging at,
507
# since we want to show the merged revisions after the stop_rev too
508
reached_stop_revision_id = False
509
revision_id_whitelist = []
510
for node in rev_iter:
511
rev_id = node.key[-1]
512
if rev_id == left_parent:
513
# reached the left parent after the stop_revision
515
if (not reached_stop_revision_id or
516
rev_id in revision_id_whitelist):
517
yield (rev_id, node.merge_depth, node.revno,
519
if reached_stop_revision_id or rev_id == stop_revision_id:
520
# only do the merged revs of rev_id from now on
521
rev = self.repository.get_revision(rev_id)
523
reached_stop_revision_id = True
524
revision_id_whitelist.extend(rev.parent_ids)
526
raise ValueError('invalid stop_rule %r' % stop_rule)
528
def leave_lock_in_place(self):
529
"""Tell this branch object not to release the physical lock when this
532
If lock_write doesn't return a token, then this method is not supported.
534
self.control_files.leave_in_place()
536
def dont_leave_lock_in_place(self):
537
"""Tell this branch object to release the physical lock when this
538
object is unlocked, even if it didn't originally acquire it.
540
If lock_write doesn't return a token, then this method is not supported.
542
self.control_files.dont_leave_in_place()
544
def bind(self, other):
545
"""Bind the local branch the other branch.
547
:param other: The branch to bind to
550
raise errors.UpgradeRequired(self.base)
552
def set_append_revisions_only(self, enabled):
553
if not self._format.supports_set_append_revisions_only():
554
raise errors.UpgradeRequired(self.base)
559
self.get_config().set_user_option('append_revisions_only', value,
562
def set_reference_info(self, file_id, tree_path, branch_location):
563
"""Set the branch location to use for a tree reference."""
564
raise errors.UnsupportedOperation(self.set_reference_info, self)
566
def get_reference_info(self, file_id):
567
"""Get the tree_path and branch_location for a tree reference."""
568
raise errors.UnsupportedOperation(self.get_reference_info, self)
571
def fetch(self, from_branch, last_revision=None, pb=None):
572
"""Copy revisions from from_branch into this branch.
574
:param from_branch: Where to copy from.
575
:param last_revision: What revision to stop at (None for at the end
577
:param pb: An optional progress bar to use.
580
if self.base == from_branch.base:
583
symbol_versioning.warn(
584
symbol_versioning.deprecated_in((1, 14, 0))
585
% "pb parameter to fetch()")
586
from_branch.lock_read()
588
if last_revision is None:
589
last_revision = from_branch.last_revision()
590
last_revision = _mod_revision.ensure_null(last_revision)
591
return self.repository.fetch(from_branch.repository,
592
revision_id=last_revision,
597
def get_bound_location(self):
598
"""Return the URL of the branch we are bound to.
600
Older format branches cannot bind, please be sure to use a metadir
605
def get_old_bound_location(self):
606
"""Return the URL of the branch we used to be bound to
608
raise errors.UpgradeRequired(self.base)
610
def get_commit_builder(self, parents, config=None, timestamp=None,
611
timezone=None, committer=None, revprops=None,
613
"""Obtain a CommitBuilder for this branch.
615
:param parents: Revision ids of the parents of the new revision.
616
:param config: Optional configuration to use.
617
:param timestamp: Optional timestamp recorded for commit.
618
:param timezone: Optional timezone for timestamp.
619
:param committer: Optional committer to set for commit.
620
:param revprops: Optional dictionary of revision properties.
621
:param revision_id: Optional revision id.
625
config = self.get_config()
627
return self.repository.get_commit_builder(self, parents, config,
628
timestamp, timezone, committer, revprops, revision_id)
630
def get_master_branch(self, possible_transports=None):
631
"""Return the branch we are bound to.
633
:return: Either a Branch, or None
637
def get_revision_delta(self, revno):
638
"""Return the delta for one revision.
640
The delta is relative to its mainline predecessor, or the
641
empty tree for revision 1.
643
rh = self.revision_history()
644
if not (1 <= revno <= len(rh)):
645
raise errors.InvalidRevisionNumber(revno)
646
return self.repository.get_revision_delta(rh[revno-1])
648
def get_stacked_on_url(self):
649
"""Get the URL this branch is stacked against.
651
:raises NotStacked: If the branch is not stacked.
652
:raises UnstackableBranchFormat: If the branch does not support
655
raise NotImplementedError(self.get_stacked_on_url)
657
def print_file(self, file, revision_id):
658
"""Print `file` to stdout."""
659
raise NotImplementedError(self.print_file)
661
def set_revision_history(self, rev_history):
662
raise NotImplementedError(self.set_revision_history)
665
def set_parent(self, url):
666
"""See Branch.set_parent."""
667
# TODO: Maybe delete old location files?
668
# URLs should never be unicode, even on the local fs,
669
# FIXUP this and get_parent in a future branch format bump:
670
# read and rewrite the file. RBC 20060125
672
if isinstance(url, unicode):
674
url = url.encode('ascii')
675
except UnicodeEncodeError:
676
raise errors.InvalidURL(url,
677
"Urls must be 7-bit ascii, "
678
"use bzrlib.urlutils.escape")
679
url = urlutils.relative_url(self.base, url)
680
self._set_parent_location(url)
683
def set_stacked_on_url(self, url):
684
"""Set the URL this branch is stacked against.
686
:raises UnstackableBranchFormat: If the branch does not support
688
:raises UnstackableRepositoryFormat: If the repository does not support
691
if not self._format.supports_stacking():
692
raise errors.UnstackableBranchFormat(self._format, self.base)
693
# XXX: Changing from one fallback repository to another does not check
694
# that all the data you need is present in the new fallback.
695
# Possibly it should.
696
self._check_stackable_repo()
699
old_url = self.get_stacked_on_url()
700
except (errors.NotStacked, errors.UnstackableBranchFormat,
701
errors.UnstackableRepositoryFormat):
705
self._activate_fallback_location(url)
706
# write this out after the repository is stacked to avoid setting a
707
# stacked config that doesn't work.
708
self._set_config_location('stacked_on_location', url)
711
"""Change a branch to be unstacked, copying data as needed.
713
Don't call this directly, use set_stacked_on_url(None).
715
pb = ui.ui_factory.nested_progress_bar()
717
pb.update("Unstacking")
718
# The basic approach here is to fetch the tip of the branch,
719
# including all available ghosts, from the existing stacked
720
# repository into a new repository object without the fallbacks.
722
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
723
# correct for CHKMap repostiories
724
old_repository = self.repository
725
if len(old_repository._fallback_repositories) != 1:
726
raise AssertionError("can't cope with fallback repositories "
727
"of %r" % (self.repository,))
728
# unlock it, including unlocking the fallback
729
old_repository.unlock()
730
old_repository.lock_read()
732
# Repositories don't offer an interface to remove fallback
733
# repositories today; take the conceptually simpler option and just
734
# reopen it. We reopen it starting from the URL so that we
735
# get a separate connection for RemoteRepositories and can
736
# stream from one of them to the other. This does mean doing
737
# separate SSH connection setup, but unstacking is not a
738
# common operation so it's tolerable.
739
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
740
new_repository = new_bzrdir.find_repository()
741
self.repository = new_repository
742
if self.repository._fallback_repositories:
743
raise AssertionError("didn't expect %r to have "
744
"fallback_repositories"
745
% (self.repository,))
746
# this is not paired with an unlock because it's just restoring
747
# the previous state; the lock's released when set_stacked_on_url
749
self.repository.lock_write()
750
# XXX: If you unstack a branch while it has a working tree
751
# with a pending merge, the pending-merged revisions will no
752
# longer be present. You can (probably) revert and remerge.
754
# XXX: This only fetches up to the tip of the repository; it
755
# doesn't bring across any tags. That's fairly consistent
756
# with how branch works, but perhaps not ideal.
757
self.repository.fetch(old_repository,
758
revision_id=self.last_revision(),
761
old_repository.unlock()
765
def _set_tags_bytes(self, bytes):
766
"""Mirror method for _get_tags_bytes.
768
:seealso: Branch._get_tags_bytes.
770
return _run_with_write_locked_target(self, self._transport.put_bytes,
773
def _cache_revision_history(self, rev_history):
774
"""Set the cached revision history to rev_history.
776
The revision_history method will use this cache to avoid regenerating
777
the revision history.
779
This API is semi-public; it only for use by subclasses, all other code
780
should consider it to be private.
782
self._revision_history_cache = rev_history
784
def _cache_revision_id_to_revno(self, revision_id_to_revno):
785
"""Set the cached revision_id => revno map to revision_id_to_revno.
787
This API is semi-public; it only for use by subclasses, all other code
788
should consider it to be private.
790
self._revision_id_to_revno_cache = revision_id_to_revno
792
def _clear_cached_state(self):
793
"""Clear any cached data on this branch, e.g. cached revision history.
795
This means the next call to revision_history will need to call
796
_gen_revision_history.
798
This API is semi-public; it only for use by subclasses, all other code
799
should consider it to be private.
801
self._revision_history_cache = None
802
self._revision_id_to_revno_cache = None
803
self._last_revision_info_cache = None
804
self._merge_sorted_revisions_cache = None
805
self._partial_revision_history_cache = []
806
self._partial_revision_id_to_revno_cache = {}
808
def _gen_revision_history(self):
809
"""Return sequence of revision hashes on to this branch.
811
Unlike revision_history, this method always regenerates or rereads the
812
revision history, i.e. it does not cache the result, so repeated calls
815
Concrete subclasses should override this instead of revision_history so
816
that subclasses do not need to deal with caching logic.
818
This API is semi-public; it only for use by subclasses, all other code
819
should consider it to be private.
821
raise NotImplementedError(self._gen_revision_history)
824
def revision_history(self):
825
"""Return sequence of revision ids on this branch.
827
This method will cache the revision history for as long as it is safe to
830
if 'evil' in debug.debug_flags:
831
mutter_callsite(3, "revision_history scales with history.")
832
if self._revision_history_cache is not None:
833
history = self._revision_history_cache
835
history = self._gen_revision_history()
836
self._cache_revision_history(history)
840
"""Return current revision number for this branch.
842
That is equivalent to the number of revisions committed to
845
return self.last_revision_info()[0]
848
"""Older format branches cannot bind or unbind."""
849
raise errors.UpgradeRequired(self.base)
851
def last_revision(self):
852
"""Return last revision id, or NULL_REVISION."""
853
return self.last_revision_info()[1]
856
def last_revision_info(self):
857
"""Return information about the last revision.
859
:return: A tuple (revno, revision_id).
861
if self._last_revision_info_cache is None:
862
self._last_revision_info_cache = self._last_revision_info()
863
return self._last_revision_info_cache
865
def _last_revision_info(self):
866
rh = self.revision_history()
869
return (revno, rh[-1])
871
return (0, _mod_revision.NULL_REVISION)
873
@deprecated_method(deprecated_in((1, 6, 0)))
874
def missing_revisions(self, other, stop_revision=None):
875
"""Return a list of new revisions that would perfectly fit.
877
If self and other have not diverged, return a list of the revisions
878
present in other, but missing from self.
880
self_history = self.revision_history()
881
self_len = len(self_history)
882
other_history = other.revision_history()
883
other_len = len(other_history)
884
common_index = min(self_len, other_len) -1
885
if common_index >= 0 and \
886
self_history[common_index] != other_history[common_index]:
887
raise errors.DivergedBranches(self, other)
889
if stop_revision is None:
890
stop_revision = other_len
892
if stop_revision > other_len:
893
raise errors.NoSuchRevision(self, stop_revision)
894
return other_history[self_len:stop_revision]
897
def update_revisions(self, other, stop_revision=None, overwrite=False,
899
"""Pull in new perfect-fit revisions.
901
:param other: Another Branch to pull from
902
:param stop_revision: Updated until the given revision
903
:param overwrite: Always set the branch pointer, rather than checking
904
to see if it is a proper descendant.
905
:param graph: A Graph object that can be used to query history
906
information. This can be None.
909
return InterBranch.get(other, self).update_revisions(stop_revision,
912
def import_last_revision_info(self, source_repo, revno, revid):
913
"""Set the last revision info, importing from another repo if necessary.
915
This is used by the bound branch code to upload a revision to
916
the master branch first before updating the tip of the local branch.
918
:param source_repo: Source repository to optionally fetch from
919
:param revno: Revision number of the new tip
920
:param revid: Revision id of the new tip
922
if not self.repository.has_same_location(source_repo):
923
self.repository.fetch(source_repo, revision_id=revid)
924
self.set_last_revision_info(revno, revid)
926
def revision_id_to_revno(self, revision_id):
927
"""Given a revision id, return its revno"""
928
if _mod_revision.is_null(revision_id):
930
history = self.revision_history()
932
return history.index(revision_id) + 1
934
raise errors.NoSuchRevision(self, revision_id)
937
def get_rev_id(self, revno, history=None):
938
"""Find the revision id of the specified revno."""
940
return _mod_revision.NULL_REVISION
941
last_revno, last_revid = self.last_revision_info()
942
if revno == last_revno:
944
if revno <= 0 or revno > last_revno:
945
raise errors.NoSuchRevision(self, revno)
946
distance_from_last = last_revno - revno
947
if len(self._partial_revision_history_cache) <= distance_from_last:
948
self._extend_partial_history(distance_from_last)
949
return self._partial_revision_history_cache[distance_from_last]
952
def pull(self, source, overwrite=False, stop_revision=None,
953
possible_transports=None, *args, **kwargs):
954
"""Mirror source into this branch.
956
This branch is considered to be 'local', having low latency.
958
:returns: PullResult instance
960
return InterBranch.get(source, self).pull(overwrite=overwrite,
961
stop_revision=stop_revision,
962
possible_transports=possible_transports, *args, **kwargs)
964
def push(self, target, overwrite=False, stop_revision=None, *args,
966
"""Mirror this branch into target.
968
This branch is considered to be 'local', having low latency.
970
return InterBranch.get(self, target).push(overwrite, stop_revision,
973
def lossy_push(self, target, stop_revision=None):
974
"""Push deltas into another branch.
976
:note: This does not, like push, retain the revision ids from
977
the source branch and will, rather than adding bzr-specific
978
metadata, push only those semantics of the revision that can be
979
natively represented by this branch' VCS.
981
:param target: Target branch
982
:param stop_revision: Revision to push, defaults to last revision.
983
:return: BranchPushResult with an extra member revidmap:
984
A dictionary mapping revision ids from the target branch
985
to new revision ids in the target branch, for each
986
revision that was pushed.
988
inter = InterBranch.get(self, target)
989
lossy_push = getattr(inter, "lossy_push", None)
990
if lossy_push is None:
991
raise errors.LossyPushToSameVCS(self, target)
992
return lossy_push(stop_revision)
994
def basis_tree(self):
995
"""Return `Tree` object for last revision."""
996
return self.repository.revision_tree(self.last_revision())
998
def get_parent(self):
999
"""Return the parent location of the branch.
1001
This is the default location for pull/missing. The usual
1002
pattern is that the user can override it by specifying a
1005
parent = self._get_parent_location()
1008
# This is an old-format absolute path to a local branch
1009
# turn it into a url
1010
if parent.startswith('/'):
1011
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1013
return urlutils.join(self.base[:-1], parent)
1014
except errors.InvalidURLJoin, e:
1015
raise errors.InaccessibleParent(parent, self.base)
1017
def _get_parent_location(self):
1018
raise NotImplementedError(self._get_parent_location)
1020
def _set_config_location(self, name, url, config=None,
1021
make_relative=False):
1023
config = self.get_config()
1027
url = urlutils.relative_url(self.base, url)
1028
config.set_user_option(name, url, warn_masked=True)
1030
def _get_config_location(self, name, config=None):
1032
config = self.get_config()
1033
location = config.get_user_option(name)
1038
def get_child_submit_format(self):
1039
"""Return the preferred format of submissions to this branch."""
1040
return self.get_config().get_user_option("child_submit_format")
1042
def get_submit_branch(self):
1043
"""Return the submit location of the branch.
1045
This is the default location for bundle. The usual
1046
pattern is that the user can override it by specifying a
1049
return self.get_config().get_user_option('submit_branch')
1051
def set_submit_branch(self, location):
1052
"""Return the submit location of the branch.
1054
This is the default location for bundle. The usual
1055
pattern is that the user can override it by specifying a
1058
self.get_config().set_user_option('submit_branch', location,
1061
def get_public_branch(self):
1062
"""Return the public location of the branch.
1064
This is used by merge directives.
1066
return self._get_config_location('public_branch')
1068
def set_public_branch(self, location):
1069
"""Return the submit location of the branch.
1071
This is the default location for bundle. The usual
1072
pattern is that the user can override it by specifying a
1075
self._set_config_location('public_branch', location)
1077
def get_push_location(self):
1078
"""Return the None or the location to push this branch to."""
1079
push_loc = self.get_config().get_user_option('push_location')
1082
def set_push_location(self, location):
1083
"""Set a new push location for this branch."""
1084
raise NotImplementedError(self.set_push_location)
1086
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1087
"""Run the post_change_branch_tip hooks."""
1088
hooks = Branch.hooks['post_change_branch_tip']
1091
new_revno, new_revid = self.last_revision_info()
1092
params = ChangeBranchTipParams(
1093
self, old_revno, new_revno, old_revid, new_revid)
1097
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1098
"""Run the pre_change_branch_tip hooks."""
1099
hooks = Branch.hooks['pre_change_branch_tip']
1102
old_revno, old_revid = self.last_revision_info()
1103
params = ChangeBranchTipParams(
1104
self, old_revno, new_revno, old_revid, new_revid)
1110
"""Synchronise this branch with the master branch if any.
1112
:return: None or the last_revision pivoted out during the update.
1116
def check_revno(self, revno):
1118
Check whether a revno corresponds to any revision.
1119
Zero (the NULL revision) is considered valid.
1122
self.check_real_revno(revno)
1124
def check_real_revno(self, revno):
1126
Check whether a revno corresponds to a real revision.
1127
Zero (the NULL revision) is considered invalid
1129
if revno < 1 or revno > self.revno():
1130
raise errors.InvalidRevisionNumber(revno)
1133
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1134
"""Clone this branch into to_bzrdir preserving all semantic values.
1136
Most API users will want 'create_clone_on_transport', which creates a
1137
new bzrdir and branch on the fly.
1139
revision_id: if not None, the revision history in the new branch will
1140
be truncated to end with revision_id.
1142
result = to_bzrdir.create_branch()
1145
if repository_policy is not None:
1146
repository_policy.configure_branch(result)
1147
self.copy_content_into(result, revision_id=revision_id)
1153
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1154
"""Create a new line of development from the branch, into to_bzrdir.
1156
to_bzrdir controls the branch format.
1158
revision_id: if not None, the revision history in the new branch will
1159
be truncated to end with revision_id.
1161
if (repository_policy is not None and
1162
repository_policy.requires_stacking()):
1163
to_bzrdir._format.require_stacking(_skip_repo=True)
1164
result = to_bzrdir.create_branch()
1167
if repository_policy is not None:
1168
repository_policy.configure_branch(result)
1169
self.copy_content_into(result, revision_id=revision_id)
1170
result.set_parent(self.bzrdir.root_transport.base)
1175
def _synchronize_history(self, destination, revision_id):
1176
"""Synchronize last revision and revision history between branches.
1178
This version is most efficient when the destination is also a
1179
BzrBranch6, but works for BzrBranch5, as long as the destination's
1180
repository contains all the lefthand ancestors of the intended
1181
last_revision. If not, set_last_revision_info will fail.
1183
:param destination: The branch to copy the history into
1184
:param revision_id: The revision-id to truncate history at. May
1185
be None to copy complete history.
1187
source_revno, source_revision_id = self.last_revision_info()
1188
if revision_id is None:
1189
revno, revision_id = source_revno, source_revision_id
1191
graph = self.repository.get_graph()
1193
revno = graph.find_distance_to_null(revision_id,
1194
[(source_revision_id, source_revno)])
1195
except errors.GhostRevisionsHaveNoRevno:
1196
# Default to 1, if we can't find anything else
1198
destination.set_last_revision_info(revno, revision_id)
1201
def copy_content_into(self, destination, revision_id=None):
1202
"""Copy the content of self into destination.
1204
revision_id: if not None, the revision history in the new branch will
1205
be truncated to end with revision_id.
1207
self.update_references(destination)
1208
self._synchronize_history(destination, revision_id)
1210
parent = self.get_parent()
1211
except errors.InaccessibleParent, e:
1212
mutter('parent was not accessible to copy: %s', e)
1215
destination.set_parent(parent)
1216
if self._push_should_merge_tags():
1217
self.tags.merge_to(destination.tags)
1219
def update_references(self, target):
1220
if not getattr(self._format, 'supports_reference_locations', False):
1222
reference_dict = self._get_all_reference_info()
1223
if len(reference_dict) == 0:
1225
old_base = self.base
1226
new_base = target.base
1227
target_reference_dict = target._get_all_reference_info()
1228
for file_id, (tree_path, branch_location) in (
1229
reference_dict.items()):
1230
branch_location = urlutils.rebase_url(branch_location,
1232
target_reference_dict.setdefault(
1233
file_id, (tree_path, branch_location))
1234
target._set_all_reference_info(target_reference_dict)
1237
def check(self, refs):
1238
"""Check consistency of the branch.
1240
In particular this checks that revisions given in the revision-history
1241
do actually match up in the revision graph, and that they're all
1242
present in the repository.
1244
Callers will typically also want to check the repository.
1246
:param refs: Calculated refs for this branch as specified by
1247
branch._get_check_refs()
1248
:return: A BranchCheckResult.
1250
result = BranchCheckResult(self)
1251
last_revno, last_revision_id = self.last_revision_info()
1252
actual_revno = refs[('lefthand-distance', last_revision_id)]
1253
if actual_revno != last_revno:
1254
result.errors.append(errors.BzrCheckError(
1255
'revno does not match len(mainline) %s != %s' % (
1256
last_revno, actual_revno)))
1257
# TODO: We should probably also check that self.revision_history
1258
# matches the repository for older branch formats.
1259
# If looking for the code that cross-checks repository parents against
1260
# the iter_reverse_revision_history output, that is now a repository
1264
def _get_checkout_format(self):
1265
"""Return the most suitable metadir for a checkout of this branch.
1266
Weaves are used if this branch's repository uses weaves.
1268
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1269
from bzrlib.repofmt import weaverepo
1270
format = bzrdir.BzrDirMetaFormat1()
1271
format.repository_format = weaverepo.RepositoryFormat7()
1273
format = self.repository.bzrdir.checkout_metadir()
1274
format.set_branch_format(self._format)
1277
def create_clone_on_transport(self, to_transport, revision_id=None,
1278
stacked_on=None, create_prefix=False, use_existing_dir=False):
1279
"""Create a clone of this branch and its bzrdir.
1281
:param to_transport: The transport to clone onto.
1282
:param revision_id: The revision id to use as tip in the new branch.
1283
If None the tip is obtained from this branch.
1284
:param stacked_on: An optional URL to stack the clone on.
1285
:param create_prefix: Create any missing directories leading up to
1287
:param use_existing_dir: Use an existing directory if one exists.
1289
# XXX: Fix the bzrdir API to allow getting the branch back from the
1290
# clone call. Or something. 20090224 RBC/spiv.
1291
if revision_id is None:
1292
revision_id = self.last_revision()
1293
dir_to = self.bzrdir.clone_on_transport(to_transport,
1294
revision_id=revision_id, stacked_on=stacked_on,
1295
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1296
return dir_to.open_branch()
1298
def create_checkout(self, to_location, revision_id=None,
1299
lightweight=False, accelerator_tree=None,
1301
"""Create a checkout of a branch.
1303
:param to_location: The url to produce the checkout at
1304
:param revision_id: The revision to check out
1305
:param lightweight: If True, produce a lightweight checkout, otherwise,
1306
produce a bound branch (heavyweight checkout)
1307
:param accelerator_tree: A tree which can be used for retrieving file
1308
contents more quickly than the revision tree, i.e. a workingtree.
1309
The revision tree will be used for cases where accelerator_tree's
1310
content is different.
1311
:param hardlink: If true, hard-link files from accelerator_tree,
1313
:return: The tree of the created checkout
1315
t = transport.get_transport(to_location)
1318
format = self._get_checkout_format()
1319
checkout = format.initialize_on_transport(t)
1320
from_branch = BranchReferenceFormat().initialize(checkout,
1323
format = self._get_checkout_format()
1324
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1325
to_location, force_new_tree=False, format=format)
1326
checkout = checkout_branch.bzrdir
1327
checkout_branch.bind(self)
1328
# pull up to the specified revision_id to set the initial
1329
# branch tip correctly, and seed it with history.
1330
checkout_branch.pull(self, stop_revision=revision_id)
1332
tree = checkout.create_workingtree(revision_id,
1333
from_branch=from_branch,
1334
accelerator_tree=accelerator_tree,
1336
basis_tree = tree.basis_tree()
1337
basis_tree.lock_read()
1339
for path, file_id in basis_tree.iter_references():
1340
reference_parent = self.reference_parent(file_id, path)
1341
reference_parent.create_checkout(tree.abspath(path),
1342
basis_tree.get_reference_revision(file_id, path),
1349
def reconcile(self, thorough=True):
1350
"""Make sure the data stored in this branch is consistent."""
1351
from bzrlib.reconcile import BranchReconciler
1352
reconciler = BranchReconciler(self, thorough=thorough)
1353
reconciler.reconcile()
1356
def reference_parent(self, file_id, path, possible_transports=None):
1357
"""Return the parent branch for a tree-reference file_id
1358
:param file_id: The file_id of the tree reference
1359
:param path: The path of the file_id in the tree
1360
:return: A branch associated with the file_id
1362
# FIXME should provide multiple branches, based on config
1363
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1364
possible_transports=possible_transports)
1366
def supports_tags(self):
1367
return self._format.supports_tags()
1369
def automatic_tag_name(self, revision_id):
1370
"""Try to automatically find the tag name for a revision.
1372
:param revision_id: Revision id of the revision.
1373
:return: A tag name or None if no tag name could be determined.
1375
for hook in Branch.hooks['automatic_tag_name']:
1376
ret = hook(self, revision_id)
1381
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1383
"""Ensure that revision_b is a descendant of revision_a.
1385
This is a helper function for update_revisions.
1387
:raises: DivergedBranches if revision_b has diverged from revision_a.
1388
:returns: True if revision_b is a descendant of revision_a.
1390
relation = self._revision_relations(revision_a, revision_b, graph)
1391
if relation == 'b_descends_from_a':
1393
elif relation == 'diverged':
1394
raise errors.DivergedBranches(self, other_branch)
1395
elif relation == 'a_descends_from_b':
1398
raise AssertionError("invalid relation: %r" % (relation,))
1400
def _revision_relations(self, revision_a, revision_b, graph):
1401
"""Determine the relationship between two revisions.
1403
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1405
heads = graph.heads([revision_a, revision_b])
1406
if heads == set([revision_b]):
1407
return 'b_descends_from_a'
1408
elif heads == set([revision_a, revision_b]):
1409
# These branches have diverged
1411
elif heads == set([revision_a]):
1412
return 'a_descends_from_b'
1414
raise AssertionError("invalid heads: %r" % (heads,))
1417
class BranchFormat(object):
1418
"""An encapsulation of the initialization and open routines for a format.
1420
Formats provide three things:
1421
* An initialization routine,
1425
Formats are placed in an dict by their format string for reference
1426
during branch opening. Its not required that these be instances, they
1427
can be classes themselves with class methods - it simply depends on
1428
whether state is needed for a given format or not.
1430
Once a format is deprecated, just deprecate the initialize and open
1431
methods on the format class. Do not deprecate the object, as the
1432
object will be created every time regardless.
1435
_default_format = None
1436
"""The default format used for new branches."""
1439
"""The known formats."""
1441
can_set_append_revisions_only = True
1443
def __eq__(self, other):
1444
return self.__class__ is other.__class__
1446
def __ne__(self, other):
1447
return not (self == other)
1450
def find_format(klass, a_bzrdir, name=None):
1451
"""Return the format for the branch object in a_bzrdir."""
1453
transport = a_bzrdir.get_branch_transport(None, name=name)
1454
format_string = transport.get_bytes("format")
1455
return klass._formats[format_string]
1456
except errors.NoSuchFile:
1457
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1459
raise errors.UnknownFormatError(format=format_string, kind='branch')
1462
def get_default_format(klass):
1463
"""Return the current default format."""
1464
return klass._default_format
1466
def get_reference(self, a_bzrdir):
1467
"""Get the target reference of the branch in a_bzrdir.
1469
format probing must have been completed before calling
1470
this method - it is assumed that the format of the branch
1471
in a_bzrdir is correct.
1473
:param a_bzrdir: The bzrdir to get the branch data from.
1474
:return: None if the branch is not a reference branch.
1479
def set_reference(self, a_bzrdir, to_branch):
1480
"""Set the target reference of the branch in a_bzrdir.
1482
format probing must have been completed before calling
1483
this method - it is assumed that the format of the branch
1484
in a_bzrdir is correct.
1486
:param a_bzrdir: The bzrdir to set the branch reference for.
1487
:param to_branch: branch that the checkout is to reference
1489
raise NotImplementedError(self.set_reference)
1491
def get_format_string(self):
1492
"""Return the ASCII format string that identifies this format."""
1493
raise NotImplementedError(self.get_format_string)
1495
def get_format_description(self):
1496
"""Return the short format description for this format."""
1497
raise NotImplementedError(self.get_format_description)
1499
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1500
hooks = Branch.hooks['post_branch_init']
1503
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1507
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1508
lock_type='metadir', set_format=True):
1509
"""Initialize a branch in a bzrdir, with specified files
1511
:param a_bzrdir: The bzrdir to initialize the branch in
1512
:param utf8_files: The files to create as a list of
1513
(filename, content) tuples
1514
:param name: Name of colocated branch to create, if any
1515
:param set_format: If True, set the format with
1516
self.get_format_string. (BzrBranch4 has its format set
1518
:return: a branch in this format
1520
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1521
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1523
'metadir': ('lock', lockdir.LockDir),
1524
'branch4': ('branch-lock', lockable_files.TransportLock),
1526
lock_name, lock_class = lock_map[lock_type]
1527
control_files = lockable_files.LockableFiles(branch_transport,
1528
lock_name, lock_class)
1529
control_files.create_lock()
1531
control_files.lock_write()
1532
except errors.LockContention:
1533
if lock_type != 'branch4':
1539
utf8_files += [('format', self.get_format_string())]
1541
for (filename, content) in utf8_files:
1542
branch_transport.put_bytes(
1544
mode=a_bzrdir._get_file_mode())
1547
control_files.unlock()
1548
branch = self.open(a_bzrdir, name, _found=True)
1549
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1552
def initialize(self, a_bzrdir, name=None):
1553
"""Create a branch of this format in a_bzrdir.
1555
:param name: Name of the colocated branch to create.
1557
raise NotImplementedError(self.initialize)
1559
def is_supported(self):
1560
"""Is this format supported?
1562
Supported formats can be initialized and opened.
1563
Unsupported formats may not support initialization or committing or
1564
some other features depending on the reason for not being supported.
1568
def make_tags(self, branch):
1569
"""Create a tags object for branch.
1571
This method is on BranchFormat, because BranchFormats are reflected
1572
over the wire via network_name(), whereas full Branch instances require
1573
multiple VFS method calls to operate at all.
1575
The default implementation returns a disabled-tags instance.
1577
Note that it is normal for branch to be a RemoteBranch when using tags
1580
return DisabledTags(branch)
1582
def network_name(self):
1583
"""A simple byte string uniquely identifying this format for RPC calls.
1585
MetaDir branch formats use their disk format string to identify the
1586
repository over the wire. All in one formats such as bzr < 0.8, and
1587
foreign formats like svn/git and hg should use some marker which is
1588
unique and immutable.
1590
raise NotImplementedError(self.network_name)
1592
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1593
"""Return the branch object for a_bzrdir
1595
:param a_bzrdir: A BzrDir that contains a branch.
1596
:param name: Name of colocated branch to open
1597
:param _found: a private parameter, do not use it. It is used to
1598
indicate if format probing has already be done.
1599
:param ignore_fallbacks: when set, no fallback branches will be opened
1600
(if there are any). Default is to open fallbacks.
1602
raise NotImplementedError(self.open)
1605
def register_format(klass, format):
1606
"""Register a metadir format."""
1607
klass._formats[format.get_format_string()] = format
1608
# Metadir formats have a network name of their format string, and get
1609
# registered as class factories.
1610
network_format_registry.register(format.get_format_string(), format.__class__)
1613
def set_default_format(klass, format):
1614
klass._default_format = format
1616
def supports_set_append_revisions_only(self):
1617
"""True if this format supports set_append_revisions_only."""
1620
def supports_stacking(self):
1621
"""True if this format records a stacked-on branch."""
1625
def unregister_format(klass, format):
1626
del klass._formats[format.get_format_string()]
1629
return self.get_format_description().rstrip()
1631
def supports_tags(self):
1632
"""True if this format supports tags stored in the branch"""
1633
return False # by default
1636
class BranchHooks(Hooks):
1637
"""A dictionary mapping hook name to a list of callables for branch hooks.
1639
e.g. ['set_rh'] Is the list of items to be called when the
1640
set_revision_history function is invoked.
1644
"""Create the default hooks.
1646
These are all empty initially, because by default nothing should get
1649
Hooks.__init__(self)
1650
self.create_hook(HookPoint('set_rh',
1651
"Invoked whenever the revision history has been set via "
1652
"set_revision_history. The api signature is (branch, "
1653
"revision_history), and the branch will be write-locked. "
1654
"The set_rh hook can be expensive for bzr to trigger, a better "
1655
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1656
self.create_hook(HookPoint('open',
1657
"Called with the Branch object that has been opened after a "
1658
"branch is opened.", (1, 8), None))
1659
self.create_hook(HookPoint('post_push',
1660
"Called after a push operation completes. post_push is called "
1661
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1662
"bzr client.", (0, 15), None))
1663
self.create_hook(HookPoint('post_pull',
1664
"Called after a pull operation completes. post_pull is called "
1665
"with a bzrlib.branch.PullResult object and only runs in the "
1666
"bzr client.", (0, 15), None))
1667
self.create_hook(HookPoint('pre_commit',
1668
"Called after a commit is calculated but before it is is "
1669
"completed. pre_commit is called with (local, master, old_revno, "
1670
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1671
"). old_revid is NULL_REVISION for the first commit to a branch, "
1672
"tree_delta is a TreeDelta object describing changes from the "
1673
"basis revision. hooks MUST NOT modify this delta. "
1674
" future_tree is an in-memory tree obtained from "
1675
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1676
"tree.", (0,91), None))
1677
self.create_hook(HookPoint('post_commit',
1678
"Called in the bzr client after a commit has completed. "
1679
"post_commit is called with (local, master, old_revno, old_revid, "
1680
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1681
"commit to a branch.", (0, 15), None))
1682
self.create_hook(HookPoint('post_uncommit',
1683
"Called in the bzr client after an uncommit completes. "
1684
"post_uncommit is called with (local, master, old_revno, "
1685
"old_revid, new_revno, new_revid) where local is the local branch "
1686
"or None, master is the target branch, and an empty branch "
1687
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1688
self.create_hook(HookPoint('pre_change_branch_tip',
1689
"Called in bzr client and server before a change to the tip of a "
1690
"branch is made. pre_change_branch_tip is called with a "
1691
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1692
"commit, uncommit will all trigger this hook.", (1, 6), None))
1693
self.create_hook(HookPoint('post_change_branch_tip',
1694
"Called in bzr client and server after a change to the tip of a "
1695
"branch is made. post_change_branch_tip is called with a "
1696
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1697
"commit, uncommit will all trigger this hook.", (1, 4), None))
1698
self.create_hook(HookPoint('transform_fallback_location',
1699
"Called when a stacked branch is activating its fallback "
1700
"locations. transform_fallback_location is called with (branch, "
1701
"url), and should return a new url. Returning the same url "
1702
"allows it to be used as-is, returning a different one can be "
1703
"used to cause the branch to stack on a closer copy of that "
1704
"fallback_location. Note that the branch cannot have history "
1705
"accessing methods called on it during this hook because the "
1706
"fallback locations have not been activated. When there are "
1707
"multiple hooks installed for transform_fallback_location, "
1708
"all are called with the url returned from the previous hook."
1709
"The order is however undefined.", (1, 9), None))
1710
self.create_hook(HookPoint('automatic_tag_name',
1711
"Called to determine an automatic tag name for a revision."
1712
"automatic_tag_name is called with (branch, revision_id) and "
1713
"should return a tag name or None if no tag name could be "
1714
"determined. The first non-None tag name returned will be used.",
1716
self.create_hook(HookPoint('post_branch_init',
1717
"Called after new branch initialization completes. "
1718
"post_branch_init is called with a bzrlib.branch.BranchInitHookParams. "
1719
"Note that init, branch and checkout will all trigger this hook.",
1721
self.create_hook(HookPoint('post_switch',
1722
"Called after a checkout switches branch. "
1723
"post_switch is called with a "
1724
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1728
# install the default hooks into the Branch class.
1729
Branch.hooks = BranchHooks()
1732
class ChangeBranchTipParams(object):
1733
"""Object holding parameters passed to *_change_branch_tip hooks.
1735
There are 5 fields that hooks may wish to access:
1737
:ivar branch: the branch being changed
1738
:ivar old_revno: revision number before the change
1739
:ivar new_revno: revision number after the change
1740
:ivar old_revid: revision id before the change
1741
:ivar new_revid: revision id after the change
1743
The revid fields are strings. The revno fields are integers.
1746
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1747
"""Create a group of ChangeBranchTip parameters.
1749
:param branch: The branch being changed.
1750
:param old_revno: Revision number before the change.
1751
:param new_revno: Revision number after the change.
1752
:param old_revid: Tip revision id before the change.
1753
:param new_revid: Tip revision id after the change.
1755
self.branch = branch
1756
self.old_revno = old_revno
1757
self.new_revno = new_revno
1758
self.old_revid = old_revid
1759
self.new_revid = new_revid
1761
def __eq__(self, other):
1762
return self.__dict__ == other.__dict__
1765
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1766
self.__class__.__name__, self.branch,
1767
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1770
class BranchInitHookParams(object):
1771
"""Object holding parameters passed to *_branch_init hooks.
1773
There are 4 fields that hooks may wish to access:
1775
:ivar format: the branch format
1776
:ivar bzrdir: the bzrdir where the branch will be/has been initialized
1777
:ivar name: name of colocated branch, if any (or None)
1778
:ivar branch: the branch
1781
def __init__(self, format, a_bzrdir, name, branch):
1782
"""Create a group of BranchInitHook parameters.
1784
:param format: the branch format
1785
:param a_bzrdir: the bzrdir where the branch will be/has been initialized
1786
:param name: name of colocated branch, if any (or None)
1787
:param branch: the branch
1789
self.format = format
1790
self.bzrdir = a_bzrdir
1792
self.branch = branch
1794
def __eq__(self, other):
1795
return self.__dict__ == other.__dict__
1799
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1801
return "<%s of format:%s bzrdir:%s>" % (
1802
self.__class__.__name__, self.branch,
1803
self.format, self.bzrdir)
1806
class SwitchHookParams(object):
1807
"""Object holding parameters passed to *_switch hooks.
1809
There are 4 fields that hooks may wish to access:
1811
:ivar control_dir: BzrDir of the checkout to change
1812
:ivar to_branch: branch that the checkout is to reference
1813
:ivar force: skip the check for local commits in a heavy checkout
1814
:ivar revision_id: revision ID to switch to (or None)
1817
def __init__(self, control_dir, to_branch, force, revision_id):
1818
"""Create a group of SwitchHook parameters.
1820
:param control_dir: BzrDir of the checkout to change
1821
:param to_branch: branch that the checkout is to reference
1822
:param force: skip the check for local commits in a heavy checkout
1823
:param revision_id: revision ID to switch to (or None)
1825
self.control_dir = control_dir
1826
self.to_branch = to_branch
1828
self.revision_id = revision_id
1830
def __eq__(self, other):
1831
return self.__dict__ == other.__dict__
1834
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1835
self.control_dir, self.to_branch,
1839
class BzrBranchFormat4(BranchFormat):
1840
"""Bzr branch format 4.
1843
- a revision-history file.
1844
- a branch-lock lock file [ to be shared with the bzrdir ]
1847
def get_format_description(self):
1848
"""See BranchFormat.get_format_description()."""
1849
return "Branch format 4"
1851
def initialize(self, a_bzrdir, name=None):
1852
"""Create a branch of this format in a_bzrdir."""
1853
utf8_files = [('revision-history', ''),
1854
('branch-name', ''),
1856
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1857
lock_type='branch4', set_format=False)
1860
super(BzrBranchFormat4, self).__init__()
1861
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1863
def network_name(self):
1864
"""The network name for this format is the control dirs disk label."""
1865
return self._matchingbzrdir.get_format_string()
1867
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1868
"""See BranchFormat.open()."""
1870
# we are being called directly and must probe.
1871
raise NotImplementedError
1872
return BzrBranch(_format=self,
1873
_control_files=a_bzrdir._control_files,
1876
_repository=a_bzrdir.open_repository())
1879
return "Bazaar-NG branch format 4"
1882
class BranchFormatMetadir(BranchFormat):
1883
"""Common logic for meta-dir based branch formats."""
1885
def _branch_class(self):
1886
"""What class to instantiate on open calls."""
1887
raise NotImplementedError(self._branch_class)
1889
def network_name(self):
1890
"""A simple byte string uniquely identifying this format for RPC calls.
1892
Metadir branch formats use their format string.
1894
return self.get_format_string()
1896
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1897
"""See BranchFormat.open()."""
1899
format = BranchFormat.find_format(a_bzrdir, name=name)
1900
if format.__class__ != self.__class__:
1901
raise AssertionError("wrong format %r found for %r" %
1904
transport = a_bzrdir.get_branch_transport(None, name=name)
1905
control_files = lockable_files.LockableFiles(transport, 'lock',
1907
return self._branch_class()(_format=self,
1908
_control_files=control_files,
1911
_repository=a_bzrdir.find_repository(),
1912
ignore_fallbacks=ignore_fallbacks)
1913
except errors.NoSuchFile:
1914
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1917
super(BranchFormatMetadir, self).__init__()
1918
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1919
self._matchingbzrdir.set_branch_format(self)
1921
def supports_tags(self):
1925
class BzrBranchFormat5(BranchFormatMetadir):
1926
"""Bzr branch format 5.
1929
- a revision-history file.
1931
- a lock dir guarding the branch itself
1932
- all of this stored in a branch/ subdirectory
1933
- works with shared repositories.
1935
This format is new in bzr 0.8.
1938
def _branch_class(self):
1941
def get_format_string(self):
1942
"""See BranchFormat.get_format_string()."""
1943
return "Bazaar-NG branch format 5\n"
1945
def get_format_description(self):
1946
"""See BranchFormat.get_format_description()."""
1947
return "Branch format 5"
1949
def initialize(self, a_bzrdir, name=None):
1950
"""Create a branch of this format in a_bzrdir."""
1951
utf8_files = [('revision-history', ''),
1952
('branch-name', ''),
1954
return self._initialize_helper(a_bzrdir, utf8_files, name)
1956
def supports_tags(self):
1960
class BzrBranchFormat6(BranchFormatMetadir):
1961
"""Branch format with last-revision and tags.
1963
Unlike previous formats, this has no explicit revision history. Instead,
1964
this just stores the last-revision, and the left-hand history leading
1965
up to there is the history.
1967
This format was introduced in bzr 0.15
1968
and became the default in 0.91.
1971
def _branch_class(self):
1974
def get_format_string(self):
1975
"""See BranchFormat.get_format_string()."""
1976
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1978
def get_format_description(self):
1979
"""See BranchFormat.get_format_description()."""
1980
return "Branch format 6"
1982
def initialize(self, a_bzrdir, name=None):
1983
"""Create a branch of this format in a_bzrdir."""
1984
utf8_files = [('last-revision', '0 null:\n'),
1985
('branch.conf', ''),
1988
return self._initialize_helper(a_bzrdir, utf8_files, name)
1990
def make_tags(self, branch):
1991
"""See bzrlib.branch.BranchFormat.make_tags()."""
1992
return BasicTags(branch)
1994
def supports_set_append_revisions_only(self):
1998
class BzrBranchFormat8(BranchFormatMetadir):
1999
"""Metadir format supporting storing locations of subtree branches."""
2001
def _branch_class(self):
2004
def get_format_string(self):
2005
"""See BranchFormat.get_format_string()."""
2006
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2008
def get_format_description(self):
2009
"""See BranchFormat.get_format_description()."""
2010
return "Branch format 8"
2012
def initialize(self, a_bzrdir, name=None):
2013
"""Create a branch of this format in a_bzrdir."""
2014
utf8_files = [('last-revision', '0 null:\n'),
2015
('branch.conf', ''),
2019
return self._initialize_helper(a_bzrdir, utf8_files, name)
2022
super(BzrBranchFormat8, self).__init__()
2023
self._matchingbzrdir.repository_format = \
2024
RepositoryFormatKnitPack5RichRoot()
2026
def make_tags(self, branch):
2027
"""See bzrlib.branch.BranchFormat.make_tags()."""
2028
return BasicTags(branch)
2030
def supports_set_append_revisions_only(self):
2033
def supports_stacking(self):
2036
supports_reference_locations = True
2039
class BzrBranchFormat7(BzrBranchFormat8):
2040
"""Branch format with last-revision, tags, and a stacked location pointer.
2042
The stacked location pointer is passed down to the repository and requires
2043
a repository format with supports_external_lookups = True.
2045
This format was introduced in bzr 1.6.
2048
def initialize(self, a_bzrdir, name=None):
2049
"""Create a branch of this format in a_bzrdir."""
2050
utf8_files = [('last-revision', '0 null:\n'),
2051
('branch.conf', ''),
2054
return self._initialize_helper(a_bzrdir, utf8_files, name)
2056
def _branch_class(self):
2059
def get_format_string(self):
2060
"""See BranchFormat.get_format_string()."""
2061
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2063
def get_format_description(self):
2064
"""See BranchFormat.get_format_description()."""
2065
return "Branch format 7"
2067
def supports_set_append_revisions_only(self):
2070
supports_reference_locations = False
2073
class BranchReferenceFormat(BranchFormat):
2074
"""Bzr branch reference format.
2076
Branch references are used in implementing checkouts, they
2077
act as an alias to the real branch which is at some other url.
2084
def get_format_string(self):
2085
"""See BranchFormat.get_format_string()."""
2086
return "Bazaar-NG Branch Reference Format 1\n"
2088
def get_format_description(self):
2089
"""See BranchFormat.get_format_description()."""
2090
return "Checkout reference format 1"
2092
def get_reference(self, a_bzrdir):
2093
"""See BranchFormat.get_reference()."""
2094
transport = a_bzrdir.get_branch_transport(None)
2095
return transport.get_bytes('location')
2097
def set_reference(self, a_bzrdir, to_branch):
2098
"""See BranchFormat.set_reference()."""
2099
transport = a_bzrdir.get_branch_transport(None)
2100
location = transport.put_bytes('location', to_branch.base)
2102
def initialize(self, a_bzrdir, name=None, target_branch=None):
2103
"""Create a branch of this format in a_bzrdir."""
2104
if target_branch is None:
2105
# this format does not implement branch itself, thus the implicit
2106
# creation contract must see it as uninitializable
2107
raise errors.UninitializableFormat(self)
2108
mutter('creating branch reference in %s', a_bzrdir.transport.base)
2109
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2110
branch_transport.put_bytes('location',
2111
target_branch.bzrdir.root_transport.base)
2112
branch_transport.put_bytes('format', self.get_format_string())
2114
a_bzrdir, name, _found=True,
2115
possible_transports=[target_branch.bzrdir.root_transport])
2116
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2120
super(BranchReferenceFormat, self).__init__()
2121
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2122
self._matchingbzrdir.set_branch_format(self)
2124
def _make_reference_clone_function(format, a_branch):
2125
"""Create a clone() routine for a branch dynamically."""
2126
def clone(to_bzrdir, revision_id=None,
2127
repository_policy=None):
2128
"""See Branch.clone()."""
2129
return format.initialize(to_bzrdir, target_branch=a_branch)
2130
# cannot obey revision_id limits when cloning a reference ...
2131
# FIXME RBC 20060210 either nuke revision_id for clone, or
2132
# emit some sort of warning/error to the caller ?!
2135
def open(self, a_bzrdir, name=None, _found=False, location=None,
2136
possible_transports=None, ignore_fallbacks=False):
2137
"""Return the branch that the branch reference in a_bzrdir points at.
2139
:param a_bzrdir: A BzrDir that contains a branch.
2140
:param name: Name of colocated branch to open, if any
2141
:param _found: a private parameter, do not use it. It is used to
2142
indicate if format probing has already be done.
2143
:param ignore_fallbacks: when set, no fallback branches will be opened
2144
(if there are any). Default is to open fallbacks.
2145
:param location: The location of the referenced branch. If
2146
unspecified, this will be determined from the branch reference in
2148
:param possible_transports: An optional reusable transports list.
2151
format = BranchFormat.find_format(a_bzrdir, name=name)
2152
if format.__class__ != self.__class__:
2153
raise AssertionError("wrong format %r found for %r" %
2155
if location is None:
2156
location = self.get_reference(a_bzrdir)
2157
real_bzrdir = bzrdir.BzrDir.open(
2158
location, possible_transports=possible_transports)
2159
result = real_bzrdir.open_branch(name=name,
2160
ignore_fallbacks=ignore_fallbacks)
2161
# this changes the behaviour of result.clone to create a new reference
2162
# rather than a copy of the content of the branch.
2163
# I did not use a proxy object because that needs much more extensive
2164
# testing, and we are only changing one behaviour at the moment.
2165
# If we decide to alter more behaviours - i.e. the implicit nickname
2166
# then this should be refactored to introduce a tested proxy branch
2167
# and a subclass of that for use in overriding clone() and ....
2169
result.clone = self._make_reference_clone_function(result)
2173
network_format_registry = registry.FormatRegistry()
2174
"""Registry of formats indexed by their network name.
2176
The network name for a branch format is an identifier that can be used when
2177
referring to formats with smart server operations. See
2178
BranchFormat.network_name() for more detail.
2182
# formats which have no format string are not discoverable
2183
# and not independently creatable, so are not registered.
2184
__format5 = BzrBranchFormat5()
2185
__format6 = BzrBranchFormat6()
2186
__format7 = BzrBranchFormat7()
2187
__format8 = BzrBranchFormat8()
2188
BranchFormat.register_format(__format5)
2189
BranchFormat.register_format(BranchReferenceFormat())
2190
BranchFormat.register_format(__format6)
2191
BranchFormat.register_format(__format7)
2192
BranchFormat.register_format(__format8)
2193
BranchFormat.set_default_format(__format7)
2194
_legacy_formats = [BzrBranchFormat4(),
2196
network_format_registry.register(
2197
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2200
class BzrBranch(Branch, _RelockDebugMixin):
2201
"""A branch stored in the actual filesystem.
2203
Note that it's "local" in the context of the filesystem; it doesn't
2204
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2205
it's writable, and can be accessed via the normal filesystem API.
2207
:ivar _transport: Transport for file operations on this branch's
2208
control files, typically pointing to the .bzr/branch directory.
2209
:ivar repository: Repository for this branch.
2210
:ivar base: The url of the base directory for this branch; the one
2211
containing the .bzr directory.
2212
:ivar name: Optional colocated branch name as it exists in the control
2216
def __init__(self, _format=None,
2217
_control_files=None, a_bzrdir=None, name=None,
2218
_repository=None, ignore_fallbacks=False):
2219
"""Create new branch object at a particular location."""
2220
if a_bzrdir is None:
2221
raise ValueError('a_bzrdir must be supplied')
2223
self.bzrdir = a_bzrdir
2224
self._base = self.bzrdir.transport.clone('..').base
2226
# XXX: We should be able to just do
2227
# self.base = self.bzrdir.root_transport.base
2228
# but this does not quite work yet -- mbp 20080522
2229
self._format = _format
2230
if _control_files is None:
2231
raise ValueError('BzrBranch _control_files is None')
2232
self.control_files = _control_files
2233
self._transport = _control_files._transport
2234
self.repository = _repository
2235
Branch.__init__(self)
2238
if self.name is None:
2239
return '%s(%r)' % (self.__class__.__name__, self.base)
2241
return '%s(%r,%r)' % (self.__class__.__name__, self.base, self.name)
2245
def _get_base(self):
2246
"""Returns the directory containing the control directory."""
2249
base = property(_get_base, doc="The URL for the root of this branch.")
2251
def _get_config(self):
2252
return TransportConfig(self._transport, 'branch.conf')
2254
def is_locked(self):
2255
return self.control_files.is_locked()
2257
def lock_write(self, token=None):
2258
if not self.is_locked():
2259
self._note_lock('w')
2260
# All-in-one needs to always unlock/lock.
2261
repo_control = getattr(self.repository, 'control_files', None)
2262
if self.control_files == repo_control or not self.is_locked():
2263
self.repository._warn_if_deprecated(self)
2264
self.repository.lock_write()
2269
return self.control_files.lock_write(token=token)
2272
self.repository.unlock()
2275
def lock_read(self):
2276
if not self.is_locked():
2277
self._note_lock('r')
2278
# All-in-one needs to always unlock/lock.
2279
repo_control = getattr(self.repository, 'control_files', None)
2280
if self.control_files == repo_control or not self.is_locked():
2281
self.repository._warn_if_deprecated(self)
2282
self.repository.lock_read()
2287
self.control_files.lock_read()
2290
self.repository.unlock()
2293
@only_raises(errors.LockNotHeld, errors.LockBroken)
2296
self.control_files.unlock()
2298
# All-in-one needs to always unlock/lock.
2299
repo_control = getattr(self.repository, 'control_files', None)
2300
if (self.control_files == repo_control or
2301
not self.control_files.is_locked()):
2302
self.repository.unlock()
2303
if not self.control_files.is_locked():
2304
# we just released the lock
2305
self._clear_cached_state()
2307
def peek_lock_mode(self):
2308
if self.control_files._lock_count == 0:
2311
return self.control_files._lock_mode
2313
def get_physical_lock_status(self):
2314
return self.control_files.get_physical_lock_status()
2317
def print_file(self, file, revision_id):
2318
"""See Branch.print_file."""
2319
return self.repository.print_file(file, revision_id)
2321
def _write_revision_history(self, history):
2322
"""Factored out of set_revision_history.
2324
This performs the actual writing to disk.
2325
It is intended to be called by BzrBranch5.set_revision_history."""
2326
self._transport.put_bytes(
2327
'revision-history', '\n'.join(history),
2328
mode=self.bzrdir._get_file_mode())
2331
def set_revision_history(self, rev_history):
2332
"""See Branch.set_revision_history."""
2333
if 'evil' in debug.debug_flags:
2334
mutter_callsite(3, "set_revision_history scales with history.")
2335
check_not_reserved_id = _mod_revision.check_not_reserved_id
2336
for rev_id in rev_history:
2337
check_not_reserved_id(rev_id)
2338
if Branch.hooks['post_change_branch_tip']:
2339
# Don't calculate the last_revision_info() if there are no hooks
2341
old_revno, old_revid = self.last_revision_info()
2342
if len(rev_history) == 0:
2343
revid = _mod_revision.NULL_REVISION
2345
revid = rev_history[-1]
2346
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2347
self._write_revision_history(rev_history)
2348
self._clear_cached_state()
2349
self._cache_revision_history(rev_history)
2350
for hook in Branch.hooks['set_rh']:
2351
hook(self, rev_history)
2352
if Branch.hooks['post_change_branch_tip']:
2353
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2355
def _synchronize_history(self, destination, revision_id):
2356
"""Synchronize last revision and revision history between branches.
2358
This version is most efficient when the destination is also a
2359
BzrBranch5, but works for BzrBranch6 as long as the revision
2360
history is the true lefthand parent history, and all of the revisions
2361
are in the destination's repository. If not, set_revision_history
2364
:param destination: The branch to copy the history into
2365
:param revision_id: The revision-id to truncate history at. May
2366
be None to copy complete history.
2368
if not isinstance(destination._format, BzrBranchFormat5):
2369
super(BzrBranch, self)._synchronize_history(
2370
destination, revision_id)
2372
if revision_id == _mod_revision.NULL_REVISION:
2375
new_history = self.revision_history()
2376
if revision_id is not None and new_history != []:
2378
new_history = new_history[:new_history.index(revision_id) + 1]
2380
rev = self.repository.get_revision(revision_id)
2381
new_history = rev.get_history(self.repository)[1:]
2382
destination.set_revision_history(new_history)
2385
def set_last_revision_info(self, revno, revision_id):
2386
"""Set the last revision of this branch.
2388
The caller is responsible for checking that the revno is correct
2389
for this revision id.
2391
It may be possible to set the branch last revision to an id not
2392
present in the repository. However, branches can also be
2393
configured to check constraints on history, in which case this may not
2396
revision_id = _mod_revision.ensure_null(revision_id)
2397
# this old format stores the full history, but this api doesn't
2398
# provide it, so we must generate, and might as well check it's
2400
history = self._lefthand_history(revision_id)
2401
if len(history) != revno:
2402
raise AssertionError('%d != %d' % (len(history), revno))
2403
self.set_revision_history(history)
2405
def _gen_revision_history(self):
2406
history = self._transport.get_bytes('revision-history').split('\n')
2407
if history[-1:] == ['']:
2408
# There shouldn't be a trailing newline, but just in case.
2413
def generate_revision_history(self, revision_id, last_rev=None,
2415
"""Create a new revision history that will finish with revision_id.
2417
:param revision_id: the new tip to use.
2418
:param last_rev: The previous last_revision. If not None, then this
2419
must be a ancestory of revision_id, or DivergedBranches is raised.
2420
:param other_branch: The other branch that DivergedBranches should
2421
raise with respect to.
2423
self.set_revision_history(self._lefthand_history(revision_id,
2424
last_rev, other_branch))
2426
def basis_tree(self):
2427
"""See Branch.basis_tree."""
2428
return self.repository.revision_tree(self.last_revision())
2430
def _get_parent_location(self):
2431
_locs = ['parent', 'pull', 'x-pull']
2434
return self._transport.get_bytes(l).strip('\n')
2435
except errors.NoSuchFile:
2439
def _basic_push(self, target, overwrite, stop_revision):
2440
"""Basic implementation of push without bound branches or hooks.
2442
Must be called with source read locked and target write locked.
2444
result = BranchPushResult()
2445
result.source_branch = self
2446
result.target_branch = target
2447
result.old_revno, result.old_revid = target.last_revision_info()
2448
self.update_references(target)
2449
if result.old_revid != self.last_revision():
2450
# We assume that during 'push' this repository is closer than
2452
graph = self.repository.get_graph(target.repository)
2453
target.update_revisions(self, stop_revision,
2454
overwrite=overwrite, graph=graph)
2455
if self._push_should_merge_tags():
2456
result.tag_conflicts = self.tags.merge_to(target.tags,
2458
result.new_revno, result.new_revid = target.last_revision_info()
2461
def get_stacked_on_url(self):
2462
raise errors.UnstackableBranchFormat(self._format, self.base)
2464
def set_push_location(self, location):
2465
"""See Branch.set_push_location."""
2466
self.get_config().set_user_option(
2467
'push_location', location,
2468
store=_mod_config.STORE_LOCATION_NORECURSE)
2470
def _set_parent_location(self, url):
2472
self._transport.delete('parent')
2474
self._transport.put_bytes('parent', url + '\n',
2475
mode=self.bzrdir._get_file_mode())
2478
class BzrBranch5(BzrBranch):
2479
"""A format 5 branch. This supports new features over plain branches.
2481
It has support for a master_branch which is the data for bound branches.
2484
def get_bound_location(self):
2486
return self._transport.get_bytes('bound')[:-1]
2487
except errors.NoSuchFile:
2491
def get_master_branch(self, possible_transports=None):
2492
"""Return the branch we are bound to.
2494
:return: Either a Branch, or None
2496
This could memoise the branch, but if thats done
2497
it must be revalidated on each new lock.
2498
So for now we just don't memoise it.
2499
# RBC 20060304 review this decision.
2501
bound_loc = self.get_bound_location()
2505
return Branch.open(bound_loc,
2506
possible_transports=possible_transports)
2507
except (errors.NotBranchError, errors.ConnectionError), e:
2508
raise errors.BoundBranchConnectionFailure(
2512
def set_bound_location(self, location):
2513
"""Set the target where this branch is bound to.
2515
:param location: URL to the target branch
2518
self._transport.put_bytes('bound', location+'\n',
2519
mode=self.bzrdir._get_file_mode())
2522
self._transport.delete('bound')
2523
except errors.NoSuchFile:
2528
def bind(self, other):
2529
"""Bind this branch to the branch other.
2531
This does not push or pull data between the branches, though it does
2532
check for divergence to raise an error when the branches are not
2533
either the same, or one a prefix of the other. That behaviour may not
2534
be useful, so that check may be removed in future.
2536
:param other: The branch to bind to
2539
# TODO: jam 20051230 Consider checking if the target is bound
2540
# It is debatable whether you should be able to bind to
2541
# a branch which is itself bound.
2542
# Committing is obviously forbidden,
2543
# but binding itself may not be.
2544
# Since we *have* to check at commit time, we don't
2545
# *need* to check here
2547
# we want to raise diverged if:
2548
# last_rev is not in the other_last_rev history, AND
2549
# other_last_rev is not in our history, and do it without pulling
2551
self.set_bound_location(other.base)
2555
"""If bound, unbind"""
2556
return self.set_bound_location(None)
2559
def update(self, possible_transports=None):
2560
"""Synchronise this branch with the master branch if any.
2562
:return: None or the last_revision that was pivoted out during the
2565
master = self.get_master_branch(possible_transports)
2566
if master is not None:
2567
old_tip = _mod_revision.ensure_null(self.last_revision())
2568
self.pull(master, overwrite=True)
2569
if self.repository.get_graph().is_ancestor(old_tip,
2570
_mod_revision.ensure_null(self.last_revision())):
2576
class BzrBranch8(BzrBranch5):
2577
"""A branch that stores tree-reference locations."""
2579
def _open_hook(self):
2580
if self._ignore_fallbacks:
2583
url = self.get_stacked_on_url()
2584
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2585
errors.UnstackableBranchFormat):
2588
for hook in Branch.hooks['transform_fallback_location']:
2589
url = hook(self, url)
2591
hook_name = Branch.hooks.get_hook_name(hook)
2592
raise AssertionError(
2593
"'transform_fallback_location' hook %s returned "
2594
"None, not a URL." % hook_name)
2595
self._activate_fallback_location(url)
2597
def __init__(self, *args, **kwargs):
2598
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2599
super(BzrBranch8, self).__init__(*args, **kwargs)
2600
self._last_revision_info_cache = None
2601
self._reference_info = None
2603
def _clear_cached_state(self):
2604
super(BzrBranch8, self)._clear_cached_state()
2605
self._last_revision_info_cache = None
2606
self._reference_info = None
2608
def _last_revision_info(self):
2609
revision_string = self._transport.get_bytes('last-revision')
2610
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2611
revision_id = cache_utf8.get_cached_utf8(revision_id)
2613
return revno, revision_id
2615
def _write_last_revision_info(self, revno, revision_id):
2616
"""Simply write out the revision id, with no checks.
2618
Use set_last_revision_info to perform this safely.
2620
Does not update the revision_history cache.
2621
Intended to be called by set_last_revision_info and
2622
_write_revision_history.
2624
revision_id = _mod_revision.ensure_null(revision_id)
2625
out_string = '%d %s\n' % (revno, revision_id)
2626
self._transport.put_bytes('last-revision', out_string,
2627
mode=self.bzrdir._get_file_mode())
2630
def set_last_revision_info(self, revno, revision_id):
2631
revision_id = _mod_revision.ensure_null(revision_id)
2632
old_revno, old_revid = self.last_revision_info()
2633
if self._get_append_revisions_only():
2634
self._check_history_violation(revision_id)
2635
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2636
self._write_last_revision_info(revno, revision_id)
2637
self._clear_cached_state()
2638
self._last_revision_info_cache = revno, revision_id
2639
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2641
def _synchronize_history(self, destination, revision_id):
2642
"""Synchronize last revision and revision history between branches.
2644
:see: Branch._synchronize_history
2646
# XXX: The base Branch has a fast implementation of this method based
2647
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2648
# that uses set_revision_history. This class inherits from BzrBranch5,
2649
# but wants the fast implementation, so it calls
2650
# Branch._synchronize_history directly.
2651
Branch._synchronize_history(self, destination, revision_id)
2653
def _check_history_violation(self, revision_id):
2654
last_revision = _mod_revision.ensure_null(self.last_revision())
2655
if _mod_revision.is_null(last_revision):
2657
if last_revision not in self._lefthand_history(revision_id):
2658
raise errors.AppendRevisionsOnlyViolation(self.base)
2660
def _gen_revision_history(self):
2661
"""Generate the revision history from last revision
2663
last_revno, last_revision = self.last_revision_info()
2664
self._extend_partial_history(stop_index=last_revno-1)
2665
return list(reversed(self._partial_revision_history_cache))
2667
def _write_revision_history(self, history):
2668
"""Factored out of set_revision_history.
2670
This performs the actual writing to disk, with format-specific checks.
2671
It is intended to be called by BzrBranch5.set_revision_history.
2673
if len(history) == 0:
2674
last_revision = 'null:'
2676
if history != self._lefthand_history(history[-1]):
2677
raise errors.NotLefthandHistory(history)
2678
last_revision = history[-1]
2679
if self._get_append_revisions_only():
2680
self._check_history_violation(last_revision)
2681
self._write_last_revision_info(len(history), last_revision)
2684
def _set_parent_location(self, url):
2685
"""Set the parent branch"""
2686
self._set_config_location('parent_location', url, make_relative=True)
2689
def _get_parent_location(self):
2690
"""Set the parent branch"""
2691
return self._get_config_location('parent_location')
2694
def _set_all_reference_info(self, info_dict):
2695
"""Replace all reference info stored in a branch.
2697
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2700
writer = rio.RioWriter(s)
2701
for key, (tree_path, branch_location) in info_dict.iteritems():
2702
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2703
branch_location=branch_location)
2704
writer.write_stanza(stanza)
2705
self._transport.put_bytes('references', s.getvalue())
2706
self._reference_info = info_dict
2709
def _get_all_reference_info(self):
2710
"""Return all the reference info stored in a branch.
2712
:return: A dict of {file_id: (tree_path, branch_location)}
2714
if self._reference_info is not None:
2715
return self._reference_info
2716
rio_file = self._transport.get('references')
2718
stanzas = rio.read_stanzas(rio_file)
2719
info_dict = dict((s['file_id'], (s['tree_path'],
2720
s['branch_location'])) for s in stanzas)
2723
self._reference_info = info_dict
2726
def set_reference_info(self, file_id, tree_path, branch_location):
2727
"""Set the branch location to use for a tree reference.
2729
:param file_id: The file-id of the tree reference.
2730
:param tree_path: The path of the tree reference in the tree.
2731
:param branch_location: The location of the branch to retrieve tree
2734
info_dict = self._get_all_reference_info()
2735
info_dict[file_id] = (tree_path, branch_location)
2736
if None in (tree_path, branch_location):
2737
if tree_path is not None:
2738
raise ValueError('tree_path must be None when branch_location'
2740
if branch_location is not None:
2741
raise ValueError('branch_location must be None when tree_path'
2743
del info_dict[file_id]
2744
self._set_all_reference_info(info_dict)
2746
def get_reference_info(self, file_id):
2747
"""Get the tree_path and branch_location for a tree reference.
2749
:return: a tuple of (tree_path, branch_location)
2751
return self._get_all_reference_info().get(file_id, (None, None))
2753
def reference_parent(self, file_id, path, possible_transports=None):
2754
"""Return the parent branch for a tree-reference file_id.
2756
:param file_id: The file_id of the tree reference
2757
:param path: The path of the file_id in the tree
2758
:return: A branch associated with the file_id
2760
branch_location = self.get_reference_info(file_id)[1]
2761
if branch_location is None:
2762
return Branch.reference_parent(self, file_id, path,
2763
possible_transports)
2764
branch_location = urlutils.join(self.base, branch_location)
2765
return Branch.open(branch_location,
2766
possible_transports=possible_transports)
2768
def set_push_location(self, location):
2769
"""See Branch.set_push_location."""
2770
self._set_config_location('push_location', location)
2772
def set_bound_location(self, location):
2773
"""See Branch.set_push_location."""
2775
config = self.get_config()
2776
if location is None:
2777
if config.get_user_option('bound') != 'True':
2780
config.set_user_option('bound', 'False', warn_masked=True)
2783
self._set_config_location('bound_location', location,
2785
config.set_user_option('bound', 'True', warn_masked=True)
2788
def _get_bound_location(self, bound):
2789
"""Return the bound location in the config file.
2791
Return None if the bound parameter does not match"""
2792
config = self.get_config()
2793
config_bound = (config.get_user_option('bound') == 'True')
2794
if config_bound != bound:
2796
return self._get_config_location('bound_location', config=config)
2798
def get_bound_location(self):
2799
"""See Branch.set_push_location."""
2800
return self._get_bound_location(True)
2802
def get_old_bound_location(self):
2803
"""See Branch.get_old_bound_location"""
2804
return self._get_bound_location(False)
2806
def get_stacked_on_url(self):
2807
# you can always ask for the URL; but you might not be able to use it
2808
# if the repo can't support stacking.
2809
## self._check_stackable_repo()
2810
stacked_url = self._get_config_location('stacked_on_location')
2811
if stacked_url is None:
2812
raise errors.NotStacked(self)
2815
def _get_append_revisions_only(self):
2816
value = self.get_config().get_user_option('append_revisions_only')
2817
return value == 'True'
2820
def generate_revision_history(self, revision_id, last_rev=None,
2822
"""See BzrBranch5.generate_revision_history"""
2823
history = self._lefthand_history(revision_id, last_rev, other_branch)
2824
revno = len(history)
2825
self.set_last_revision_info(revno, revision_id)
2828
def get_rev_id(self, revno, history=None):
2829
"""Find the revision id of the specified revno."""
2831
return _mod_revision.NULL_REVISION
2833
last_revno, last_revision_id = self.last_revision_info()
2834
if revno <= 0 or revno > last_revno:
2835
raise errors.NoSuchRevision(self, revno)
2837
if history is not None:
2838
return history[revno - 1]
2840
index = last_revno - revno
2841
if len(self._partial_revision_history_cache) <= index:
2842
self._extend_partial_history(stop_index=index)
2843
if len(self._partial_revision_history_cache) > index:
2844
return self._partial_revision_history_cache[index]
2846
raise errors.NoSuchRevision(self, revno)
2849
def revision_id_to_revno(self, revision_id):
2850
"""Given a revision id, return its revno"""
2851
if _mod_revision.is_null(revision_id):
2854
index = self._partial_revision_history_cache.index(revision_id)
2856
self._extend_partial_history(stop_revision=revision_id)
2857
index = len(self._partial_revision_history_cache) - 1
2858
if self._partial_revision_history_cache[index] != revision_id:
2859
raise errors.NoSuchRevision(self, revision_id)
2860
return self.revno() - index
2863
class BzrBranch7(BzrBranch8):
2864
"""A branch with support for a fallback repository."""
2866
def set_reference_info(self, file_id, tree_path, branch_location):
2867
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2869
def get_reference_info(self, file_id):
2870
Branch.get_reference_info(self, file_id)
2872
def reference_parent(self, file_id, path, possible_transports=None):
2873
return Branch.reference_parent(self, file_id, path,
2874
possible_transports)
2877
class BzrBranch6(BzrBranch7):
2878
"""See BzrBranchFormat6 for the capabilities of this branch.
2880
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2884
def get_stacked_on_url(self):
2885
raise errors.UnstackableBranchFormat(self._format, self.base)
2888
######################################################################
2889
# results of operations
2892
class _Result(object):
2894
def _show_tag_conficts(self, to_file):
2895
if not getattr(self, 'tag_conflicts', None):
2897
to_file.write('Conflicting tags:\n')
2898
for name, value1, value2 in self.tag_conflicts:
2899
to_file.write(' %s\n' % (name, ))
2902
class PullResult(_Result):
2903
"""Result of a Branch.pull operation.
2905
:ivar old_revno: Revision number before pull.
2906
:ivar new_revno: Revision number after pull.
2907
:ivar old_revid: Tip revision id before pull.
2908
:ivar new_revid: Tip revision id after pull.
2909
:ivar source_branch: Source (local) branch object. (read locked)
2910
:ivar master_branch: Master branch of the target, or the target if no
2912
:ivar local_branch: target branch if there is a Master, else None
2913
:ivar target_branch: Target/destination branch object. (write locked)
2914
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2918
# DEPRECATED: pull used to return the change in revno
2919
return self.new_revno - self.old_revno
2921
def report(self, to_file):
2923
if self.old_revid == self.new_revid:
2924
to_file.write('No revisions to pull.\n')
2926
to_file.write('Now on revision %d.\n' % self.new_revno)
2927
self._show_tag_conficts(to_file)
2930
class BranchPushResult(_Result):
2931
"""Result of a Branch.push operation.
2933
:ivar old_revno: Revision number (eg 10) of the target before push.
2934
:ivar new_revno: Revision number (eg 12) of the target after push.
2935
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2937
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2939
:ivar source_branch: Source branch object that the push was from. This is
2940
read locked, and generally is a local (and thus low latency) branch.
2941
:ivar master_branch: If target is a bound branch, the master branch of
2942
target, or target itself. Always write locked.
2943
:ivar target_branch: The direct Branch where data is being sent (write
2945
:ivar local_branch: If the target is a bound branch this will be the
2946
target, otherwise it will be None.
2950
# DEPRECATED: push used to return the change in revno
2951
return self.new_revno - self.old_revno
2953
def report(self, to_file):
2954
"""Write a human-readable description of the result."""
2955
if self.old_revid == self.new_revid:
2956
note('No new revisions to push.')
2958
note('Pushed up to revision %d.' % self.new_revno)
2959
self._show_tag_conficts(to_file)
2962
class BranchCheckResult(object):
2963
"""Results of checking branch consistency.
2968
def __init__(self, branch):
2969
self.branch = branch
2972
def report_results(self, verbose):
2973
"""Report the check results via trace.note.
2975
:param verbose: Requests more detailed display of what was checked,
2978
note('checked branch %s format %s', self.branch.base,
2979
self.branch._format)
2980
for error in self.errors:
2981
note('found error:%s', error)
2984
class Converter5to6(object):
2985
"""Perform an in-place upgrade of format 5 to format 6"""
2987
def convert(self, branch):
2988
# Data for 5 and 6 can peacefully coexist.
2989
format = BzrBranchFormat6()
2990
new_branch = format.open(branch.bzrdir, _found=True)
2992
# Copy source data into target
2993
new_branch._write_last_revision_info(*branch.last_revision_info())
2994
new_branch.set_parent(branch.get_parent())
2995
new_branch.set_bound_location(branch.get_bound_location())
2996
new_branch.set_push_location(branch.get_push_location())
2998
# New branch has no tags by default
2999
new_branch.tags._set_tag_dict({})
3001
# Copying done; now update target format
3002
new_branch._transport.put_bytes('format',
3003
format.get_format_string(),
3004
mode=new_branch.bzrdir._get_file_mode())
3006
# Clean up old files
3007
new_branch._transport.delete('revision-history')
3009
branch.set_parent(None)
3010
except errors.NoSuchFile:
3012
branch.set_bound_location(None)
3015
class Converter6to7(object):
3016
"""Perform an in-place upgrade of format 6 to format 7"""
3018
def convert(self, branch):
3019
format = BzrBranchFormat7()
3020
branch._set_config_location('stacked_on_location', '')
3021
# update target format
3022
branch._transport.put_bytes('format', format.get_format_string())
3025
class Converter7to8(object):
3026
"""Perform an in-place upgrade of format 6 to format 7"""
3028
def convert(self, branch):
3029
format = BzrBranchFormat8()
3030
branch._transport.put_bytes('references', '')
3031
# update target format
3032
branch._transport.put_bytes('format', format.get_format_string())
3035
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3036
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3039
_run_with_write_locked_target will attempt to release the lock it acquires.
3041
If an exception is raised by callable, then that exception *will* be
3042
propagated, even if the unlock attempt raises its own error. Thus
3043
_run_with_write_locked_target should be preferred to simply doing::
3047
return callable(*args, **kwargs)
3052
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3053
# should share code?
3056
result = callable(*args, **kwargs)
3058
exc_info = sys.exc_info()
3062
raise exc_info[0], exc_info[1], exc_info[2]
3068
class InterBranch(InterObject):
3069
"""This class represents operations taking place between two branches.
3071
Its instances have methods like pull() and push() and contain
3072
references to the source and target repositories these operations
3073
can be carried out on.
3077
"""The available optimised InterBranch types."""
3080
def _get_branch_formats_to_test():
3081
"""Return a tuple with the Branch formats to use when testing."""
3082
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3084
def pull(self, overwrite=False, stop_revision=None,
3085
possible_transports=None, local=False):
3086
"""Mirror source into target branch.
3088
The target branch is considered to be 'local', having low latency.
3090
:returns: PullResult instance
3092
raise NotImplementedError(self.pull)
3094
def update_revisions(self, stop_revision=None, overwrite=False,
3096
"""Pull in new perfect-fit revisions.
3098
:param stop_revision: Updated until the given revision
3099
:param overwrite: Always set the branch pointer, rather than checking
3100
to see if it is a proper descendant.
3101
:param graph: A Graph object that can be used to query history
3102
information. This can be None.
3105
raise NotImplementedError(self.update_revisions)
3107
def push(self, overwrite=False, stop_revision=None,
3108
_override_hook_source_branch=None):
3109
"""Mirror the source branch into the target branch.
3111
The source branch is considered to be 'local', having low latency.
3113
raise NotImplementedError(self.push)
3116
class GenericInterBranch(InterBranch):
3117
"""InterBranch implementation that uses public Branch functions.
3121
def _get_branch_formats_to_test():
3122
return BranchFormat._default_format, BranchFormat._default_format
3124
def update_revisions(self, stop_revision=None, overwrite=False,
3126
"""See InterBranch.update_revisions()."""
3127
self.source.lock_read()
3129
other_revno, other_last_revision = self.source.last_revision_info()
3130
stop_revno = None # unknown
3131
if stop_revision is None:
3132
stop_revision = other_last_revision
3133
if _mod_revision.is_null(stop_revision):
3134
# if there are no commits, we're done.
3136
stop_revno = other_revno
3138
# what's the current last revision, before we fetch [and change it
3140
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3141
# we fetch here so that we don't process data twice in the common
3142
# case of having something to pull, and so that the check for
3143
# already merged can operate on the just fetched graph, which will
3144
# be cached in memory.
3145
self.target.fetch(self.source, stop_revision)
3146
# Check to see if one is an ancestor of the other
3149
graph = self.target.repository.get_graph()
3150
if self.target._check_if_descendant_or_diverged(
3151
stop_revision, last_rev, graph, self.source):
3152
# stop_revision is a descendant of last_rev, but we aren't
3153
# overwriting, so we're done.
3155
if stop_revno is None:
3157
graph = self.target.repository.get_graph()
3158
this_revno, this_last_revision = \
3159
self.target.last_revision_info()
3160
stop_revno = graph.find_distance_to_null(stop_revision,
3161
[(other_last_revision, other_revno),
3162
(this_last_revision, this_revno)])
3163
self.target.set_last_revision_info(stop_revno, stop_revision)
3165
self.source.unlock()
3167
def pull(self, overwrite=False, stop_revision=None,
3168
possible_transports=None, _hook_master=None, run_hooks=True,
3169
_override_hook_target=None, local=False):
3172
:param _hook_master: Private parameter - set the branch to
3173
be supplied as the master to pull hooks.
3174
:param run_hooks: Private parameter - if false, this branch
3175
is being called because it's the master of the primary branch,
3176
so it should not run its hooks.
3177
:param _override_hook_target: Private parameter - set the branch to be
3178
supplied as the target_branch to pull hooks.
3179
:param local: Only update the local branch, and not the bound branch.
3181
# This type of branch can't be bound.
3183
raise errors.LocalRequiresBoundBranch()
3184
result = PullResult()
3185
result.source_branch = self.source
3186
if _override_hook_target is None:
3187
result.target_branch = self.target
3189
result.target_branch = _override_hook_target
3190
self.source.lock_read()
3192
# We assume that during 'pull' the target repository is closer than
3194
self.source.update_references(self.target)
3195
graph = self.target.repository.get_graph(self.source.repository)
3196
# TODO: Branch formats should have a flag that indicates
3197
# that revno's are expensive, and pull() should honor that flag.
3199
result.old_revno, result.old_revid = \
3200
self.target.last_revision_info()
3201
self.target.update_revisions(self.source, stop_revision,
3202
overwrite=overwrite, graph=graph)
3203
# TODO: The old revid should be specified when merging tags,
3204
# so a tags implementation that versions tags can only
3205
# pull in the most recent changes. -- JRV20090506
3206
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3208
result.new_revno, result.new_revid = self.target.last_revision_info()
3210
result.master_branch = _hook_master
3211
result.local_branch = result.target_branch
3213
result.master_branch = result.target_branch
3214
result.local_branch = None
3216
for hook in Branch.hooks['post_pull']:
3219
self.source.unlock()
3222
def push(self, overwrite=False, stop_revision=None,
3223
_override_hook_source_branch=None):
3224
"""See InterBranch.push.
3226
This is the basic concrete implementation of push()
3228
:param _override_hook_source_branch: If specified, run
3229
the hooks passing this Branch as the source, rather than self.
3230
This is for use of RemoteBranch, where push is delegated to the
3231
underlying vfs-based Branch.
3233
# TODO: Public option to disable running hooks - should be trivial but
3235
self.source.lock_read()
3237
return _run_with_write_locked_target(
3238
self.target, self._push_with_bound_branches, overwrite,
3240
_override_hook_source_branch=_override_hook_source_branch)
3242
self.source.unlock()
3244
def _push_with_bound_branches(self, overwrite, stop_revision,
3245
_override_hook_source_branch=None):
3246
"""Push from source into target, and into target's master if any.
3249
if _override_hook_source_branch:
3250
result.source_branch = _override_hook_source_branch
3251
for hook in Branch.hooks['post_push']:
3254
bound_location = self.target.get_bound_location()
3255
if bound_location and self.target.base != bound_location:
3256
# there is a master branch.
3258
# XXX: Why the second check? Is it even supported for a branch to
3259
# be bound to itself? -- mbp 20070507
3260
master_branch = self.target.get_master_branch()
3261
master_branch.lock_write()
3263
# push into the master from the source branch.
3264
self.source._basic_push(master_branch, overwrite, stop_revision)
3265
# and push into the target branch from the source. Note that we
3266
# push from the source branch again, because its considered the
3267
# highest bandwidth repository.
3268
result = self.source._basic_push(self.target, overwrite,
3270
result.master_branch = master_branch
3271
result.local_branch = self.target
3275
master_branch.unlock()
3278
result = self.source._basic_push(self.target, overwrite,
3280
# TODO: Why set master_branch and local_branch if there's no
3281
# binding? Maybe cleaner to just leave them unset? -- mbp
3283
result.master_branch = self.target
3284
result.local_branch = None
3289
def is_compatible(self, source, target):
3290
# GenericBranch uses the public API, so always compatible
3294
class InterToBranch5(GenericInterBranch):
3297
def _get_branch_formats_to_test():
3298
return BranchFormat._default_format, BzrBranchFormat5()
3300
def pull(self, overwrite=False, stop_revision=None,
3301
possible_transports=None, run_hooks=True,
3302
_override_hook_target=None, local=False):
3303
"""Pull from source into self, updating my master if any.
3305
:param run_hooks: Private parameter - if false, this branch
3306
is being called because it's the master of the primary branch,
3307
so it should not run its hooks.
3309
bound_location = self.target.get_bound_location()
3310
if local and not bound_location:
3311
raise errors.LocalRequiresBoundBranch()
3312
master_branch = None
3313
if not local and bound_location and self.source.base != bound_location:
3314
# not pulling from master, so we need to update master.
3315
master_branch = self.target.get_master_branch(possible_transports)
3316
master_branch.lock_write()
3319
# pull from source into master.
3320
master_branch.pull(self.source, overwrite, stop_revision,
3322
return super(InterToBranch5, self).pull(overwrite,
3323
stop_revision, _hook_master=master_branch,
3324
run_hooks=run_hooks,
3325
_override_hook_target=_override_hook_target)
3328
master_branch.unlock()
3331
InterBranch.register_optimiser(GenericInterBranch)
3332
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
