1
# Copyright (C) 2005-2011 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
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
27
config as _mod_config,
36
revision as _mod_revision,
43
from bzrlib.i18n import gettext, ngettext
49
from bzrlib.decorators import (
54
from bzrlib.hooks import Hooks
55
from bzrlib.inter import InterObject
56
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
57
from bzrlib import registry
58
from bzrlib.symbol_versioning import (
62
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
65
class Branch(controldir.ControlComponent):
66
"""Branch holding a history of revisions.
69
Base directory/url of the branch; using control_url and
70
control_transport is more standardized.
71
:ivar hooks: An instance of BranchHooks.
72
:ivar _master_branch_cache: cached result of get_master_branch, see
75
# this is really an instance variable - FIXME move it there
80
def control_transport(self):
81
return self._transport
84
def user_transport(self):
85
return self.bzrdir.user_transport
87
def __init__(self, *ignored, **ignored_too):
88
self.tags = self._format.make_tags(self)
89
self._revision_history_cache = None
90
self._revision_id_to_revno_cache = None
91
self._partial_revision_id_to_revno_cache = {}
92
self._partial_revision_history_cache = []
93
self._tags_bytes = None
94
self._last_revision_info_cache = None
95
self._master_branch_cache = None
96
self._merge_sorted_revisions_cache = None
98
hooks = Branch.hooks['open']
102
def _open_hook(self):
103
"""Called by init to allow simpler extension of the base class."""
105
def _activate_fallback_location(self, url):
106
"""Activate the branch/repository from url as a fallback repository."""
107
for existing_fallback_repo in self.repository._fallback_repositories:
108
if existing_fallback_repo.user_url == url:
109
# This fallback is already configured. This probably only
110
# happens because BzrDir.sprout is a horrible mess. To avoid
111
# confusing _unstack we don't add this a second time.
112
mutter('duplicate activation of fallback %r on %r', url, self)
114
repo = self._get_fallback_repository(url)
115
if repo.has_same_location(self.repository):
116
raise errors.UnstackableLocationError(self.user_url, url)
117
self.repository.add_fallback_repository(repo)
119
def break_lock(self):
120
"""Break a lock if one is present from another instance.
122
Uses the ui factory to ask for confirmation if the lock may be from
125
This will probe the repository for its lock as well.
127
self.control_files.break_lock()
128
self.repository.break_lock()
129
master = self.get_master_branch()
130
if master is not None:
133
def _check_stackable_repo(self):
134
if not self.repository._format.supports_external_lookups:
135
raise errors.UnstackableRepositoryFormat(self.repository._format,
136
self.repository.base)
138
def _extend_partial_history(self, stop_index=None, stop_revision=None):
139
"""Extend the partial history to include a given index
141
If a stop_index is supplied, stop when that index has been reached.
142
If a stop_revision is supplied, stop when that revision is
143
encountered. Otherwise, stop when the beginning of history is
146
:param stop_index: The index which should be present. When it is
147
present, history extension will stop.
148
:param stop_revision: The revision id which should be present. When
149
it is encountered, history extension will stop.
151
if len(self._partial_revision_history_cache) == 0:
152
self._partial_revision_history_cache = [self.last_revision()]
153
repository._iter_for_revno(
154
self.repository, self._partial_revision_history_cache,
155
stop_index=stop_index, stop_revision=stop_revision)
156
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
157
self._partial_revision_history_cache.pop()
159
def _get_check_refs(self):
160
"""Get the references needed for check().
164
revid = self.last_revision()
165
return [('revision-existence', revid), ('lefthand-distance', revid)]
168
def open(base, _unsupported=False, possible_transports=None):
169
"""Open the branch rooted at base.
171
For instance, if the branch is at URL/.bzr/branch,
172
Branch.open(URL) -> a Branch instance.
174
control = bzrdir.BzrDir.open(base, _unsupported,
175
possible_transports=possible_transports)
176
return control.open_branch(unsupported=_unsupported)
179
def open_from_transport(transport, name=None, _unsupported=False):
180
"""Open the branch rooted at transport"""
181
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
182
return control.open_branch(name=name, unsupported=_unsupported)
185
def open_containing(url, possible_transports=None):
186
"""Open an existing branch which contains url.
188
This probes for a branch at url, and searches upwards from there.
190
Basically we keep looking up until we find the control directory or
191
run into the root. If there isn't one, raises NotBranchError.
192
If there is one and it is either an unrecognised format or an unsupported
193
format, UnknownFormatError or UnsupportedFormatError are raised.
194
If there is one, it is returned, along with the unused portion of url.
196
control, relpath = bzrdir.BzrDir.open_containing(url,
198
return control.open_branch(), relpath
200
def _push_should_merge_tags(self):
201
"""Should _basic_push merge this branch's tags into the target?
203
The default implementation returns False if this branch has no tags,
204
and True the rest of the time. Subclasses may override this.
206
return self.supports_tags() and self.tags.get_tag_dict()
208
def get_config(self):
209
"""Get a bzrlib.config.BranchConfig for this Branch.
211
This can then be used to get and set configuration options for the
214
:return: A bzrlib.config.BranchConfig.
216
return _mod_config.BranchConfig(self)
218
def get_config_stack(self):
219
"""Get a bzrlib.config.BranchStack for this Branch.
221
This can then be used to get and set configuration options for the
224
:return: A bzrlib.config.BranchStack.
226
return _mod_config.BranchStack(self)
228
def _get_config(self):
229
"""Get the concrete config for just the config in this branch.
231
This is not intended for client use; see Branch.get_config for the
236
:return: An object supporting get_option and set_option.
238
raise NotImplementedError(self._get_config)
240
def _get_fallback_repository(self, url):
241
"""Get the repository we fallback to at url."""
242
url = urlutils.join(self.base, url)
243
a_branch = Branch.open(url,
244
possible_transports=[self.bzrdir.root_transport])
245
return a_branch.repository
248
def _get_tags_bytes(self):
249
"""Get the bytes of a serialised tags dict.
251
Note that not all branches support tags, nor do all use the same tags
252
logic: this method is specific to BasicTags. Other tag implementations
253
may use the same method name and behave differently, safely, because
254
of the double-dispatch via
255
format.make_tags->tags_instance->get_tags_dict.
257
:return: The bytes of the tags file.
258
:seealso: Branch._set_tags_bytes.
260
if self._tags_bytes is None:
261
self._tags_bytes = self._transport.get_bytes('tags')
262
return self._tags_bytes
264
def _get_nick(self, local=False, possible_transports=None):
265
config = self.get_config()
266
# explicit overrides master, but don't look for master if local is True
267
if not local and not config.has_explicit_nickname():
269
master = self.get_master_branch(possible_transports)
270
if master and self.user_url == master.user_url:
271
raise errors.RecursiveBind(self.user_url)
272
if master is not None:
273
# return the master branch value
275
except errors.RecursiveBind, e:
277
except errors.BzrError, e:
278
# Silently fall back to local implicit nick if the master is
280
mutter("Could not connect to bound branch, "
281
"falling back to local nick.\n " + str(e))
282
return config.get_nickname()
284
def _set_nick(self, nick):
285
self.get_config().set_user_option('nickname', nick, warn_masked=True)
287
nick = property(_get_nick, _set_nick)
290
raise NotImplementedError(self.is_locked)
292
def _lefthand_history(self, revision_id, last_rev=None,
294
if 'evil' in debug.debug_flags:
295
mutter_callsite(4, "_lefthand_history scales with history.")
296
# stop_revision must be a descendant of last_revision
297
graph = self.repository.get_graph()
298
if last_rev is not None:
299
if not graph.is_ancestor(last_rev, revision_id):
300
# our previous tip is not merged into stop_revision
301
raise errors.DivergedBranches(self, other_branch)
302
# make a new revision history from the graph
303
parents_map = graph.get_parent_map([revision_id])
304
if revision_id not in parents_map:
305
raise errors.NoSuchRevision(self, revision_id)
306
current_rev_id = revision_id
308
check_not_reserved_id = _mod_revision.check_not_reserved_id
309
# Do not include ghosts or graph origin in revision_history
310
while (current_rev_id in parents_map and
311
len(parents_map[current_rev_id]) > 0):
312
check_not_reserved_id(current_rev_id)
313
new_history.append(current_rev_id)
314
current_rev_id = parents_map[current_rev_id][0]
315
parents_map = graph.get_parent_map([current_rev_id])
316
new_history.reverse()
319
def lock_write(self, token=None):
320
"""Lock the branch for write operations.
322
:param token: A token to permit reacquiring a previously held and
324
:return: A BranchWriteLockResult.
326
raise NotImplementedError(self.lock_write)
329
"""Lock the branch for read operations.
331
:return: A bzrlib.lock.LogicalLockResult.
333
raise NotImplementedError(self.lock_read)
336
raise NotImplementedError(self.unlock)
338
def peek_lock_mode(self):
339
"""Return lock mode for the Branch: 'r', 'w' or None"""
340
raise NotImplementedError(self.peek_lock_mode)
342
def get_physical_lock_status(self):
343
raise NotImplementedError(self.get_physical_lock_status)
346
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
347
"""Return the revision_id for a dotted revno.
349
:param revno: a tuple like (1,) or (1,1,2)
350
:param _cache_reverse: a private parameter enabling storage
351
of the reverse mapping in a top level cache. (This should
352
only be done in selective circumstances as we want to
353
avoid having the mapping cached multiple times.)
354
:return: the revision_id
355
:raises errors.NoSuchRevision: if the revno doesn't exist
357
rev_id = self._do_dotted_revno_to_revision_id(revno)
359
self._partial_revision_id_to_revno_cache[rev_id] = revno
362
def _do_dotted_revno_to_revision_id(self, revno):
363
"""Worker function for dotted_revno_to_revision_id.
365
Subclasses should override this if they wish to
366
provide a more efficient implementation.
369
return self.get_rev_id(revno[0])
370
revision_id_to_revno = self.get_revision_id_to_revno_map()
371
revision_ids = [revision_id for revision_id, this_revno
372
in revision_id_to_revno.iteritems()
373
if revno == this_revno]
374
if len(revision_ids) == 1:
375
return revision_ids[0]
377
revno_str = '.'.join(map(str, revno))
378
raise errors.NoSuchRevision(self, revno_str)
381
def revision_id_to_dotted_revno(self, revision_id):
382
"""Given a revision id, return its dotted revno.
384
:return: a tuple like (1,) or (400,1,3).
386
return self._do_revision_id_to_dotted_revno(revision_id)
388
def _do_revision_id_to_dotted_revno(self, revision_id):
389
"""Worker function for revision_id_to_revno."""
390
# Try the caches if they are loaded
391
result = self._partial_revision_id_to_revno_cache.get(revision_id)
392
if result is not None:
394
if self._revision_id_to_revno_cache:
395
result = self._revision_id_to_revno_cache.get(revision_id)
397
raise errors.NoSuchRevision(self, revision_id)
398
# Try the mainline as it's optimised
400
revno = self.revision_id_to_revno(revision_id)
402
except errors.NoSuchRevision:
403
# We need to load and use the full revno map after all
404
result = self.get_revision_id_to_revno_map().get(revision_id)
406
raise errors.NoSuchRevision(self, revision_id)
410
def get_revision_id_to_revno_map(self):
411
"""Return the revision_id => dotted revno map.
413
This will be regenerated on demand, but will be cached.
415
:return: A dictionary mapping revision_id => dotted revno.
416
This dictionary should not be modified by the caller.
418
if self._revision_id_to_revno_cache is not None:
419
mapping = self._revision_id_to_revno_cache
421
mapping = self._gen_revno_map()
422
self._cache_revision_id_to_revno(mapping)
423
# TODO: jam 20070417 Since this is being cached, should we be returning
425
# I would rather not, and instead just declare that users should not
426
# modify the return value.
429
def _gen_revno_map(self):
430
"""Create a new mapping from revision ids to dotted revnos.
432
Dotted revnos are generated based on the current tip in the revision
434
This is the worker function for get_revision_id_to_revno_map, which
435
just caches the return value.
437
:return: A dictionary mapping revision_id => dotted revno.
439
revision_id_to_revno = dict((rev_id, revno)
440
for rev_id, depth, revno, end_of_merge
441
in self.iter_merge_sorted_revisions())
442
return revision_id_to_revno
445
def iter_merge_sorted_revisions(self, start_revision_id=None,
446
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
447
"""Walk the revisions for a branch in merge sorted order.
449
Merge sorted order is the output from a merge-aware,
450
topological sort, i.e. all parents come before their
451
children going forward; the opposite for reverse.
453
:param start_revision_id: the revision_id to begin walking from.
454
If None, the branch tip is used.
455
:param stop_revision_id: the revision_id to terminate the walk
456
after. If None, the rest of history is included.
457
:param stop_rule: if stop_revision_id is not None, the precise rule
458
to use for termination:
460
* 'exclude' - leave the stop revision out of the result (default)
461
* 'include' - the stop revision is the last item in the result
462
* 'with-merges' - include the stop revision and all of its
463
merged revisions in the result
464
* 'with-merges-without-common-ancestry' - filter out revisions
465
that are in both ancestries
466
:param direction: either 'reverse' or 'forward':
468
* reverse means return the start_revision_id first, i.e.
469
start at the most recent revision and go backwards in history
470
* forward returns tuples in the opposite order to reverse.
471
Note in particular that forward does *not* do any intelligent
472
ordering w.r.t. depth as some clients of this API may like.
473
(If required, that ought to be done at higher layers.)
475
:return: an iterator over (revision_id, depth, revno, end_of_merge)
478
* revision_id: the unique id of the revision
479
* depth: How many levels of merging deep this node has been
481
* revno_sequence: This field provides a sequence of
482
revision numbers for all revisions. The format is:
483
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
484
branch that the revno is on. From left to right the REVNO numbers
485
are the sequence numbers within that branch of the revision.
486
* end_of_merge: When True the next node (earlier in history) is
487
part of a different merge.
489
# Note: depth and revno values are in the context of the branch so
490
# we need the full graph to get stable numbers, regardless of the
492
if self._merge_sorted_revisions_cache is None:
493
last_revision = self.last_revision()
494
known_graph = self.repository.get_known_graph_ancestry(
496
self._merge_sorted_revisions_cache = known_graph.merge_sort(
498
filtered = self._filter_merge_sorted_revisions(
499
self._merge_sorted_revisions_cache, start_revision_id,
500
stop_revision_id, stop_rule)
501
# Make sure we don't return revisions that are not part of the
502
# start_revision_id ancestry.
503
filtered = self._filter_start_non_ancestors(filtered)
504
if direction == 'reverse':
506
if direction == 'forward':
507
return reversed(list(filtered))
509
raise ValueError('invalid direction %r' % direction)
511
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
512
start_revision_id, stop_revision_id, stop_rule):
513
"""Iterate over an inclusive range of sorted revisions."""
514
rev_iter = iter(merge_sorted_revisions)
515
if start_revision_id is not None:
516
for node in rev_iter:
518
if rev_id != start_revision_id:
521
# The decision to include the start or not
522
# depends on the stop_rule if a stop is provided
523
# so pop this node back into the iterator
524
rev_iter = itertools.chain(iter([node]), rev_iter)
526
if stop_revision_id is None:
528
for node in rev_iter:
530
yield (rev_id, node.merge_depth, node.revno,
532
elif stop_rule == 'exclude':
533
for node in rev_iter:
535
if rev_id == stop_revision_id:
537
yield (rev_id, node.merge_depth, node.revno,
539
elif stop_rule == 'include':
540
for node in rev_iter:
542
yield (rev_id, node.merge_depth, node.revno,
544
if rev_id == stop_revision_id:
546
elif stop_rule == 'with-merges-without-common-ancestry':
547
# We want to exclude all revisions that are already part of the
548
# stop_revision_id ancestry.
549
graph = self.repository.get_graph()
550
ancestors = graph.find_unique_ancestors(start_revision_id,
552
for node in rev_iter:
554
if rev_id not in ancestors:
556
yield (rev_id, node.merge_depth, node.revno,
558
elif stop_rule == 'with-merges':
559
stop_rev = self.repository.get_revision(stop_revision_id)
560
if stop_rev.parent_ids:
561
left_parent = stop_rev.parent_ids[0]
563
left_parent = _mod_revision.NULL_REVISION
564
# left_parent is the actual revision we want to stop logging at,
565
# since we want to show the merged revisions after the stop_rev too
566
reached_stop_revision_id = False
567
revision_id_whitelist = []
568
for node in rev_iter:
570
if rev_id == left_parent:
571
# reached the left parent after the stop_revision
573
if (not reached_stop_revision_id or
574
rev_id in revision_id_whitelist):
575
yield (rev_id, node.merge_depth, node.revno,
577
if reached_stop_revision_id or rev_id == stop_revision_id:
578
# only do the merged revs of rev_id from now on
579
rev = self.repository.get_revision(rev_id)
581
reached_stop_revision_id = True
582
revision_id_whitelist.extend(rev.parent_ids)
584
raise ValueError('invalid stop_rule %r' % stop_rule)
586
def _filter_start_non_ancestors(self, rev_iter):
587
# If we started from a dotted revno, we want to consider it as a tip
588
# and don't want to yield revisions that are not part of its
589
# ancestry. Given the order guaranteed by the merge sort, we will see
590
# uninteresting descendants of the first parent of our tip before the
592
first = rev_iter.next()
593
(rev_id, merge_depth, revno, end_of_merge) = first
596
# We start at a mainline revision so by definition, all others
597
# revisions in rev_iter are ancestors
598
for node in rev_iter:
603
pmap = self.repository.get_parent_map([rev_id])
604
parents = pmap.get(rev_id, [])
606
whitelist.update(parents)
608
# If there is no parents, there is nothing of interest left
610
# FIXME: It's hard to test this scenario here as this code is never
611
# called in that case. -- vila 20100322
614
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
616
if rev_id in whitelist:
617
pmap = self.repository.get_parent_map([rev_id])
618
parents = pmap.get(rev_id, [])
619
whitelist.remove(rev_id)
620
whitelist.update(parents)
622
# We've reached the mainline, there is nothing left to
626
# A revision that is not part of the ancestry of our
629
yield (rev_id, merge_depth, revno, end_of_merge)
631
def leave_lock_in_place(self):
632
"""Tell this branch object not to release the physical lock when this
635
If lock_write doesn't return a token, then this method is not supported.
637
self.control_files.leave_in_place()
639
def dont_leave_lock_in_place(self):
640
"""Tell this branch object to release the physical lock when this
641
object is unlocked, even if it didn't originally acquire it.
643
If lock_write doesn't return a token, then this method is not supported.
645
self.control_files.dont_leave_in_place()
647
def bind(self, other):
648
"""Bind the local branch the other branch.
650
:param other: The branch to bind to
653
raise errors.UpgradeRequired(self.user_url)
655
def get_append_revisions_only(self):
656
"""Whether it is only possible to append revisions to the history.
658
if not self._format.supports_set_append_revisions_only():
660
return self.get_config(
661
).get_user_option_as_bool('append_revisions_only')
663
def set_append_revisions_only(self, enabled):
664
if not self._format.supports_set_append_revisions_only():
665
raise errors.UpgradeRequired(self.user_url)
670
self.get_config().set_user_option('append_revisions_only', value,
673
def set_reference_info(self, file_id, tree_path, branch_location):
674
"""Set the branch location to use for a tree reference."""
675
raise errors.UnsupportedOperation(self.set_reference_info, self)
677
def get_reference_info(self, file_id):
678
"""Get the tree_path and branch_location for a tree reference."""
679
raise errors.UnsupportedOperation(self.get_reference_info, self)
682
def fetch(self, from_branch, last_revision=None, limit=None):
683
"""Copy revisions from from_branch into this branch.
685
:param from_branch: Where to copy from.
686
:param last_revision: What revision to stop at (None for at the end
688
:param limit: Optional rough limit of revisions to fetch
691
return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
693
def get_bound_location(self):
694
"""Return the URL of the branch we are bound to.
696
Older format branches cannot bind, please be sure to use a metadir
701
def get_old_bound_location(self):
702
"""Return the URL of the branch we used to be bound to
704
raise errors.UpgradeRequired(self.user_url)
706
def get_commit_builder(self, parents, config=None, timestamp=None,
707
timezone=None, committer=None, revprops=None,
708
revision_id=None, lossy=False):
709
"""Obtain a CommitBuilder for this branch.
711
:param parents: Revision ids of the parents of the new revision.
712
:param config: Optional configuration to use.
713
:param timestamp: Optional timestamp recorded for commit.
714
:param timezone: Optional timezone for timestamp.
715
:param committer: Optional committer to set for commit.
716
:param revprops: Optional dictionary of revision properties.
717
:param revision_id: Optional revision id.
718
:param lossy: Whether to discard data that can not be natively
719
represented, when pushing to a foreign VCS
723
config = self.get_config()
725
return self.repository.get_commit_builder(self, parents, config,
726
timestamp, timezone, committer, revprops, revision_id,
729
def get_master_branch(self, possible_transports=None):
730
"""Return the branch we are bound to.
732
:return: Either a Branch, or None
736
@deprecated_method(deprecated_in((2, 5, 0)))
737
def get_revision_delta(self, revno):
738
"""Return the delta for one revision.
740
The delta is relative to its mainline predecessor, or the
741
empty tree for revision 1.
744
revid = self.get_rev_id(revno)
745
except errors.NoSuchRevision:
746
raise errors.InvalidRevisionNumber(revno)
747
return self.repository.get_revision_delta(revid)
749
def get_stacked_on_url(self):
750
"""Get the URL this branch is stacked against.
752
:raises NotStacked: If the branch is not stacked.
753
:raises UnstackableBranchFormat: If the branch does not support
756
raise NotImplementedError(self.get_stacked_on_url)
758
def print_file(self, file, revision_id):
759
"""Print `file` to stdout."""
760
raise NotImplementedError(self.print_file)
762
@deprecated_method(deprecated_in((2, 4, 0)))
763
def set_revision_history(self, rev_history):
764
"""See Branch.set_revision_history."""
765
self._set_revision_history(rev_history)
768
def _set_revision_history(self, rev_history):
769
if len(rev_history) == 0:
770
revid = _mod_revision.NULL_REVISION
772
revid = rev_history[-1]
773
if rev_history != self._lefthand_history(revid):
774
raise errors.NotLefthandHistory(rev_history)
775
self.set_last_revision_info(len(rev_history), revid)
776
self._cache_revision_history(rev_history)
777
for hook in Branch.hooks['set_rh']:
778
hook(self, rev_history)
781
def set_last_revision_info(self, revno, revision_id):
782
"""Set the last revision of this branch.
784
The caller is responsible for checking that the revno is correct
785
for this revision id.
787
It may be possible to set the branch last revision to an id not
788
present in the repository. However, branches can also be
789
configured to check constraints on history, in which case this may not
792
raise NotImplementedError(self.set_last_revision_info)
795
def generate_revision_history(self, revision_id, last_rev=None,
797
"""See Branch.generate_revision_history"""
798
graph = self.repository.get_graph()
799
(last_revno, last_revid) = self.last_revision_info()
800
known_revision_ids = [
801
(last_revid, last_revno),
802
(_mod_revision.NULL_REVISION, 0),
804
if last_rev is not None:
805
if not graph.is_ancestor(last_rev, revision_id):
806
# our previous tip is not merged into stop_revision
807
raise errors.DivergedBranches(self, other_branch)
808
revno = graph.find_distance_to_null(revision_id, known_revision_ids)
809
self.set_last_revision_info(revno, revision_id)
812
def set_parent(self, url):
813
"""See Branch.set_parent."""
814
# TODO: Maybe delete old location files?
815
# URLs should never be unicode, even on the local fs,
816
# FIXUP this and get_parent in a future branch format bump:
817
# read and rewrite the file. RBC 20060125
819
if isinstance(url, unicode):
821
url = url.encode('ascii')
822
except UnicodeEncodeError:
823
raise errors.InvalidURL(url,
824
"Urls must be 7-bit ascii, "
825
"use bzrlib.urlutils.escape")
826
url = urlutils.relative_url(self.base, url)
827
self._set_parent_location(url)
830
def set_stacked_on_url(self, url):
831
"""Set the URL this branch is stacked against.
833
:raises UnstackableBranchFormat: If the branch does not support
835
:raises UnstackableRepositoryFormat: If the repository does not support
838
if not self._format.supports_stacking():
839
raise errors.UnstackableBranchFormat(self._format, self.user_url)
840
# XXX: Changing from one fallback repository to another does not check
841
# that all the data you need is present in the new fallback.
842
# Possibly it should.
843
self._check_stackable_repo()
846
old_url = self.get_stacked_on_url()
847
except (errors.NotStacked, errors.UnstackableBranchFormat,
848
errors.UnstackableRepositoryFormat):
852
self._activate_fallback_location(url)
853
# write this out after the repository is stacked to avoid setting a
854
# stacked config that doesn't work.
855
self._set_config_location('stacked_on_location', url)
858
"""Change a branch to be unstacked, copying data as needed.
860
Don't call this directly, use set_stacked_on_url(None).
862
pb = ui.ui_factory.nested_progress_bar()
864
pb.update(gettext("Unstacking"))
865
# The basic approach here is to fetch the tip of the branch,
866
# including all available ghosts, from the existing stacked
867
# repository into a new repository object without the fallbacks.
869
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
870
# correct for CHKMap repostiories
871
old_repository = self.repository
872
if len(old_repository._fallback_repositories) != 1:
873
raise AssertionError("can't cope with fallback repositories "
874
"of %r (fallbacks: %r)" % (old_repository,
875
old_repository._fallback_repositories))
876
# Open the new repository object.
877
# Repositories don't offer an interface to remove fallback
878
# repositories today; take the conceptually simpler option and just
879
# reopen it. We reopen it starting from the URL so that we
880
# get a separate connection for RemoteRepositories and can
881
# stream from one of them to the other. This does mean doing
882
# separate SSH connection setup, but unstacking is not a
883
# common operation so it's tolerable.
884
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
885
new_repository = new_bzrdir.find_repository()
886
if new_repository._fallback_repositories:
887
raise AssertionError("didn't expect %r to have "
888
"fallback_repositories"
889
% (self.repository,))
890
# Replace self.repository with the new repository.
891
# Do our best to transfer the lock state (i.e. lock-tokens and
892
# lock count) of self.repository to the new repository.
893
lock_token = old_repository.lock_write().repository_token
894
self.repository = new_repository
895
if isinstance(self, remote.RemoteBranch):
896
# Remote branches can have a second reference to the old
897
# repository that need to be replaced.
898
if self._real_branch is not None:
899
self._real_branch.repository = new_repository
900
self.repository.lock_write(token=lock_token)
901
if lock_token is not None:
902
old_repository.leave_lock_in_place()
903
old_repository.unlock()
904
if lock_token is not None:
905
# XXX: self.repository.leave_lock_in_place() before this
906
# function will not be preserved. Fortunately that doesn't
907
# affect the current default format (2a), and would be a
908
# corner-case anyway.
909
# - Andrew Bennetts, 2010/06/30
910
self.repository.dont_leave_lock_in_place()
914
old_repository.unlock()
915
except errors.LockNotHeld:
918
if old_lock_count == 0:
919
raise AssertionError(
920
'old_repository should have been locked at least once.')
921
for i in range(old_lock_count-1):
922
self.repository.lock_write()
923
# Fetch from the old repository into the new.
924
old_repository.lock_read()
926
# XXX: If you unstack a branch while it has a working tree
927
# with a pending merge, the pending-merged revisions will no
928
# longer be present. You can (probably) revert and remerge.
930
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
931
except errors.TagsNotSupported:
932
tags_to_fetch = set()
933
fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
934
old_repository, required_ids=[self.last_revision()],
935
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
936
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
938
old_repository.unlock()
942
def _set_tags_bytes(self, bytes):
943
"""Mirror method for _get_tags_bytes.
945
:seealso: Branch._get_tags_bytes.
947
op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
948
op.add_cleanup(self.lock_write().unlock)
949
return op.run_simple(bytes)
951
def _set_tags_bytes_locked(self, bytes):
952
self._tags_bytes = bytes
953
return self._transport.put_bytes('tags', bytes)
955
def _cache_revision_history(self, rev_history):
956
"""Set the cached revision history to rev_history.
958
The revision_history method will use this cache to avoid regenerating
959
the revision history.
961
This API is semi-public; it only for use by subclasses, all other code
962
should consider it to be private.
964
self._revision_history_cache = rev_history
966
def _cache_revision_id_to_revno(self, revision_id_to_revno):
967
"""Set the cached revision_id => revno map to revision_id_to_revno.
969
This API is semi-public; it only for use by subclasses, all other code
970
should consider it to be private.
972
self._revision_id_to_revno_cache = revision_id_to_revno
974
def _clear_cached_state(self):
975
"""Clear any cached data on this branch, e.g. cached revision history.
977
This means the next call to revision_history will need to call
978
_gen_revision_history.
980
This API is semi-public; it only for use by subclasses, all other code
981
should consider it to be private.
983
self._revision_history_cache = None
984
self._revision_id_to_revno_cache = None
985
self._last_revision_info_cache = None
986
self._master_branch_cache = None
987
self._merge_sorted_revisions_cache = None
988
self._partial_revision_history_cache = []
989
self._partial_revision_id_to_revno_cache = {}
990
self._tags_bytes = None
992
def _gen_revision_history(self):
993
"""Return sequence of revision hashes on to this branch.
995
Unlike revision_history, this method always regenerates or rereads the
996
revision history, i.e. it does not cache the result, so repeated calls
999
Concrete subclasses should override this instead of revision_history so
1000
that subclasses do not need to deal with caching logic.
1002
This API is semi-public; it only for use by subclasses, all other code
1003
should consider it to be private.
1005
raise NotImplementedError(self._gen_revision_history)
1007
@deprecated_method(deprecated_in((2, 5, 0)))
1009
def revision_history(self):
1010
"""Return sequence of revision ids on this branch.
1012
This method will cache the revision history for as long as it is safe to
1015
return self._revision_history()
1017
def _revision_history(self):
1018
if 'evil' in debug.debug_flags:
1019
mutter_callsite(3, "revision_history scales with history.")
1020
if self._revision_history_cache is not None:
1021
history = self._revision_history_cache
1023
history = self._gen_revision_history()
1024
self._cache_revision_history(history)
1025
return list(history)
1028
"""Return current revision number for this branch.
1030
That is equivalent to the number of revisions committed to
1033
return self.last_revision_info()[0]
1036
"""Older format branches cannot bind or unbind."""
1037
raise errors.UpgradeRequired(self.user_url)
1039
def last_revision(self):
1040
"""Return last revision id, or NULL_REVISION."""
1041
return self.last_revision_info()[1]
1044
def last_revision_info(self):
1045
"""Return information about the last revision.
1047
:return: A tuple (revno, revision_id).
1049
if self._last_revision_info_cache is None:
1050
self._last_revision_info_cache = self._read_last_revision_info()
1051
return self._last_revision_info_cache
1053
def _read_last_revision_info(self):
1054
raise NotImplementedError(self._read_last_revision_info)
1056
@deprecated_method(deprecated_in((2, 4, 0)))
1057
def import_last_revision_info(self, source_repo, revno, revid):
1058
"""Set the last revision info, importing from another repo if necessary.
1060
:param source_repo: Source repository to optionally fetch from
1061
:param revno: Revision number of the new tip
1062
:param revid: Revision id of the new tip
1064
if not self.repository.has_same_location(source_repo):
1065
self.repository.fetch(source_repo, revision_id=revid)
1066
self.set_last_revision_info(revno, revid)
1068
def import_last_revision_info_and_tags(self, source, revno, revid,
1070
"""Set the last revision info, importing from another repo if necessary.
1072
This is used by the bound branch code to upload a revision to
1073
the master branch first before updating the tip of the local branch.
1074
Revisions referenced by source's tags are also transferred.
1076
:param source: Source branch to optionally fetch from
1077
:param revno: Revision number of the new tip
1078
:param revid: Revision id of the new tip
1079
:param lossy: Whether to discard metadata that can not be
1080
natively represented
1081
:return: Tuple with the new revision number and revision id
1082
(should only be different from the arguments when lossy=True)
1084
if not self.repository.has_same_location(source.repository):
1085
self.fetch(source, revid)
1086
self.set_last_revision_info(revno, revid)
1087
return (revno, revid)
1089
def revision_id_to_revno(self, revision_id):
1090
"""Given a revision id, return its revno"""
1091
if _mod_revision.is_null(revision_id):
1093
history = self._revision_history()
1095
return history.index(revision_id) + 1
1097
raise errors.NoSuchRevision(self, revision_id)
1100
def get_rev_id(self, revno, history=None):
1101
"""Find the revision id of the specified revno."""
1103
return _mod_revision.NULL_REVISION
1104
last_revno, last_revid = self.last_revision_info()
1105
if revno == last_revno:
1107
if revno <= 0 or revno > last_revno:
1108
raise errors.NoSuchRevision(self, revno)
1109
distance_from_last = last_revno - revno
1110
if len(self._partial_revision_history_cache) <= distance_from_last:
1111
self._extend_partial_history(distance_from_last)
1112
return self._partial_revision_history_cache[distance_from_last]
1114
def pull(self, source, overwrite=False, stop_revision=None,
1115
possible_transports=None, *args, **kwargs):
1116
"""Mirror source into this branch.
1118
This branch is considered to be 'local', having low latency.
1120
:returns: PullResult instance
1122
return InterBranch.get(source, self).pull(overwrite=overwrite,
1123
stop_revision=stop_revision,
1124
possible_transports=possible_transports, *args, **kwargs)
1126
def push(self, target, overwrite=False, stop_revision=None, lossy=False,
1128
"""Mirror this branch into target.
1130
This branch is considered to be 'local', having low latency.
1132
return InterBranch.get(self, target).push(overwrite, stop_revision,
1133
lossy, *args, **kwargs)
1135
def basis_tree(self):
1136
"""Return `Tree` object for last revision."""
1137
return self.repository.revision_tree(self.last_revision())
1139
def get_parent(self):
1140
"""Return the parent location of the branch.
1142
This is the default location for pull/missing. The usual
1143
pattern is that the user can override it by specifying a
1146
parent = self._get_parent_location()
1149
# This is an old-format absolute path to a local branch
1150
# turn it into a url
1151
if parent.startswith('/'):
1152
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1154
return urlutils.join(self.base[:-1], parent)
1155
except errors.InvalidURLJoin, e:
1156
raise errors.InaccessibleParent(parent, self.user_url)
1158
def _get_parent_location(self):
1159
raise NotImplementedError(self._get_parent_location)
1161
def _set_config_location(self, name, url, config=None,
1162
make_relative=False):
1164
config = self.get_config()
1168
url = urlutils.relative_url(self.base, url)
1169
config.set_user_option(name, url, warn_masked=True)
1171
def _get_config_location(self, name, config=None):
1173
config = self.get_config()
1174
location = config.get_user_option(name)
1179
def get_child_submit_format(self):
1180
"""Return the preferred format of submissions to this branch."""
1181
return self.get_config().get_user_option("child_submit_format")
1183
def get_submit_branch(self):
1184
"""Return the submit location of the branch.
1186
This is the default location for bundle. The usual
1187
pattern is that the user can override it by specifying a
1190
return self.get_config().get_user_option('submit_branch')
1192
def set_submit_branch(self, location):
1193
"""Return the submit location of the branch.
1195
This is the default location for bundle. The usual
1196
pattern is that the user can override it by specifying a
1199
self.get_config().set_user_option('submit_branch', location,
1202
def get_public_branch(self):
1203
"""Return the public location of the branch.
1205
This is used by merge directives.
1207
return self._get_config_location('public_branch')
1209
def set_public_branch(self, location):
1210
"""Return the submit location of the branch.
1212
This is the default location for bundle. The usual
1213
pattern is that the user can override it by specifying a
1216
self._set_config_location('public_branch', location)
1218
def get_push_location(self):
1219
"""Return the None or the location to push this branch to."""
1220
push_loc = self.get_config().get_user_option('push_location')
1223
def set_push_location(self, location):
1224
"""Set a new push location for this branch."""
1225
raise NotImplementedError(self.set_push_location)
1227
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1228
"""Run the post_change_branch_tip hooks."""
1229
hooks = Branch.hooks['post_change_branch_tip']
1232
new_revno, new_revid = self.last_revision_info()
1233
params = ChangeBranchTipParams(
1234
self, old_revno, new_revno, old_revid, new_revid)
1238
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1239
"""Run the pre_change_branch_tip hooks."""
1240
hooks = Branch.hooks['pre_change_branch_tip']
1243
old_revno, old_revid = self.last_revision_info()
1244
params = ChangeBranchTipParams(
1245
self, old_revno, new_revno, old_revid, new_revid)
1251
"""Synchronise this branch with the master branch if any.
1253
:return: None or the last_revision pivoted out during the update.
1257
def check_revno(self, revno):
1259
Check whether a revno corresponds to any revision.
1260
Zero (the NULL revision) is considered valid.
1263
self.check_real_revno(revno)
1265
def check_real_revno(self, revno):
1267
Check whether a revno corresponds to a real revision.
1268
Zero (the NULL revision) is considered invalid
1270
if revno < 1 or revno > self.revno():
1271
raise errors.InvalidRevisionNumber(revno)
1274
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1275
"""Clone this branch into to_bzrdir preserving all semantic values.
1277
Most API users will want 'create_clone_on_transport', which creates a
1278
new bzrdir and branch on the fly.
1280
revision_id: if not None, the revision history in the new branch will
1281
be truncated to end with revision_id.
1283
result = to_bzrdir.create_branch()
1286
if repository_policy is not None:
1287
repository_policy.configure_branch(result)
1288
self.copy_content_into(result, revision_id=revision_id)
1294
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
1296
"""Create a new line of development from the branch, into to_bzrdir.
1298
to_bzrdir controls the branch format.
1300
revision_id: if not None, the revision history in the new branch will
1301
be truncated to end with revision_id.
1303
if (repository_policy is not None and
1304
repository_policy.requires_stacking()):
1305
to_bzrdir._format.require_stacking(_skip_repo=True)
1306
result = to_bzrdir.create_branch(repository=repository)
1309
if repository_policy is not None:
1310
repository_policy.configure_branch(result)
1311
self.copy_content_into(result, revision_id=revision_id)
1312
master_url = self.get_bound_location()
1313
if master_url is None:
1314
result.set_parent(self.bzrdir.root_transport.base)
1316
result.set_parent(master_url)
1321
def _synchronize_history(self, destination, revision_id):
1322
"""Synchronize last revision and revision history between branches.
1324
This version is most efficient when the destination is also a
1325
BzrBranch6, but works for BzrBranch5, as long as the destination's
1326
repository contains all the lefthand ancestors of the intended
1327
last_revision. If not, set_last_revision_info will fail.
1329
:param destination: The branch to copy the history into
1330
:param revision_id: The revision-id to truncate history at. May
1331
be None to copy complete history.
1333
source_revno, source_revision_id = self.last_revision_info()
1334
if revision_id is None:
1335
revno, revision_id = source_revno, source_revision_id
1337
graph = self.repository.get_graph()
1339
revno = graph.find_distance_to_null(revision_id,
1340
[(source_revision_id, source_revno)])
1341
except errors.GhostRevisionsHaveNoRevno:
1342
# Default to 1, if we can't find anything else
1344
destination.set_last_revision_info(revno, revision_id)
1346
def copy_content_into(self, destination, revision_id=None):
1347
"""Copy the content of self into destination.
1349
revision_id: if not None, the revision history in the new branch will
1350
be truncated to end with revision_id.
1352
return InterBranch.get(self, destination).copy_content_into(
1353
revision_id=revision_id)
1355
def update_references(self, target):
1356
if not getattr(self._format, 'supports_reference_locations', False):
1358
reference_dict = self._get_all_reference_info()
1359
if len(reference_dict) == 0:
1361
old_base = self.base
1362
new_base = target.base
1363
target_reference_dict = target._get_all_reference_info()
1364
for file_id, (tree_path, branch_location) in (
1365
reference_dict.items()):
1366
branch_location = urlutils.rebase_url(branch_location,
1368
target_reference_dict.setdefault(
1369
file_id, (tree_path, branch_location))
1370
target._set_all_reference_info(target_reference_dict)
1373
def check(self, refs):
1374
"""Check consistency of the branch.
1376
In particular this checks that revisions given in the revision-history
1377
do actually match up in the revision graph, and that they're all
1378
present in the repository.
1380
Callers will typically also want to check the repository.
1382
:param refs: Calculated refs for this branch as specified by
1383
branch._get_check_refs()
1384
:return: A BranchCheckResult.
1386
result = BranchCheckResult(self)
1387
last_revno, last_revision_id = self.last_revision_info()
1388
actual_revno = refs[('lefthand-distance', last_revision_id)]
1389
if actual_revno != last_revno:
1390
result.errors.append(errors.BzrCheckError(
1391
'revno does not match len(mainline) %s != %s' % (
1392
last_revno, actual_revno)))
1393
# TODO: We should probably also check that self.revision_history
1394
# matches the repository for older branch formats.
1395
# If looking for the code that cross-checks repository parents against
1396
# the Graph.iter_lefthand_ancestry output, that is now a repository
1400
def _get_checkout_format(self, lightweight=False):
1401
"""Return the most suitable metadir for a checkout of this branch.
1402
Weaves are used if this branch's repository uses weaves.
1404
format = self.repository.bzrdir.checkout_metadir()
1405
format.set_branch_format(self._format)
1408
def create_clone_on_transport(self, to_transport, revision_id=None,
1409
stacked_on=None, create_prefix=False, use_existing_dir=False,
1411
"""Create a clone of this branch and its bzrdir.
1413
:param to_transport: The transport to clone onto.
1414
:param revision_id: The revision id to use as tip in the new branch.
1415
If None the tip is obtained from this branch.
1416
:param stacked_on: An optional URL to stack the clone on.
1417
:param create_prefix: Create any missing directories leading up to
1419
:param use_existing_dir: Use an existing directory if one exists.
1421
# XXX: Fix the bzrdir API to allow getting the branch back from the
1422
# clone call. Or something. 20090224 RBC/spiv.
1423
# XXX: Should this perhaps clone colocated branches as well,
1424
# rather than just the default branch? 20100319 JRV
1425
if revision_id is None:
1426
revision_id = self.last_revision()
1427
dir_to = self.bzrdir.clone_on_transport(to_transport,
1428
revision_id=revision_id, stacked_on=stacked_on,
1429
create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1431
return dir_to.open_branch()
1433
def create_checkout(self, to_location, revision_id=None,
1434
lightweight=False, accelerator_tree=None,
1436
"""Create a checkout of a branch.
1438
:param to_location: The url to produce the checkout at
1439
:param revision_id: The revision to check out
1440
:param lightweight: If True, produce a lightweight checkout, otherwise,
1441
produce a bound branch (heavyweight checkout)
1442
:param accelerator_tree: A tree which can be used for retrieving file
1443
contents more quickly than the revision tree, i.e. a workingtree.
1444
The revision tree will be used for cases where accelerator_tree's
1445
content is different.
1446
:param hardlink: If true, hard-link files from accelerator_tree,
1448
:return: The tree of the created checkout
1450
t = transport.get_transport(to_location)
1452
format = self._get_checkout_format(lightweight=lightweight)
1454
checkout = format.initialize_on_transport(t)
1455
from_branch = BranchReferenceFormat().initialize(checkout,
1458
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1459
to_location, force_new_tree=False, format=format)
1460
checkout = checkout_branch.bzrdir
1461
checkout_branch.bind(self)
1462
# pull up to the specified revision_id to set the initial
1463
# branch tip correctly, and seed it with history.
1464
checkout_branch.pull(self, stop_revision=revision_id)
1466
tree = checkout.create_workingtree(revision_id,
1467
from_branch=from_branch,
1468
accelerator_tree=accelerator_tree,
1470
basis_tree = tree.basis_tree()
1471
basis_tree.lock_read()
1473
for path, file_id in basis_tree.iter_references():
1474
reference_parent = self.reference_parent(file_id, path)
1475
reference_parent.create_checkout(tree.abspath(path),
1476
basis_tree.get_reference_revision(file_id, path),
1483
def reconcile(self, thorough=True):
1484
"""Make sure the data stored in this branch is consistent."""
1485
from bzrlib.reconcile import BranchReconciler
1486
reconciler = BranchReconciler(self, thorough=thorough)
1487
reconciler.reconcile()
1490
def reference_parent(self, file_id, path, possible_transports=None):
1491
"""Return the parent branch for a tree-reference file_id
1493
:param file_id: The file_id of the tree reference
1494
:param path: The path of the file_id in the tree
1495
:return: A branch associated with the file_id
1497
# FIXME should provide multiple branches, based on config
1498
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1499
possible_transports=possible_transports)
1501
def supports_tags(self):
1502
return self._format.supports_tags()
1504
def automatic_tag_name(self, revision_id):
1505
"""Try to automatically find the tag name for a revision.
1507
:param revision_id: Revision id of the revision.
1508
:return: A tag name or None if no tag name could be determined.
1510
for hook in Branch.hooks['automatic_tag_name']:
1511
ret = hook(self, revision_id)
1516
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1518
"""Ensure that revision_b is a descendant of revision_a.
1520
This is a helper function for update_revisions.
1522
:raises: DivergedBranches if revision_b has diverged from revision_a.
1523
:returns: True if revision_b is a descendant of revision_a.
1525
relation = self._revision_relations(revision_a, revision_b, graph)
1526
if relation == 'b_descends_from_a':
1528
elif relation == 'diverged':
1529
raise errors.DivergedBranches(self, other_branch)
1530
elif relation == 'a_descends_from_b':
1533
raise AssertionError("invalid relation: %r" % (relation,))
1535
def _revision_relations(self, revision_a, revision_b, graph):
1536
"""Determine the relationship between two revisions.
1538
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1540
heads = graph.heads([revision_a, revision_b])
1541
if heads == set([revision_b]):
1542
return 'b_descends_from_a'
1543
elif heads == set([revision_a, revision_b]):
1544
# These branches have diverged
1546
elif heads == set([revision_a]):
1547
return 'a_descends_from_b'
1549
raise AssertionError("invalid heads: %r" % (heads,))
1551
def heads_to_fetch(self):
1552
"""Return the heads that must and that should be fetched to copy this
1553
branch into another repo.
1555
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1556
set of heads that must be fetched. if_present_fetch is a set of
1557
heads that must be fetched if present, but no error is necessary if
1558
they are not present.
1560
# For bzr native formats must_fetch is just the tip, and if_present_fetch
1562
must_fetch = set([self.last_revision()])
1563
if_present_fetch = set()
1564
c = self.get_config()
1565
include_tags = c.get_user_option_as_bool('branch.fetch_tags',
1569
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1570
except errors.TagsNotSupported:
1572
must_fetch.discard(_mod_revision.NULL_REVISION)
1573
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1574
return must_fetch, if_present_fetch
1577
class BranchFormat(controldir.ControlComponentFormat):
1578
"""An encapsulation of the initialization and open routines for a format.
1580
Formats provide three things:
1581
* An initialization routine,
1585
Formats are placed in an dict by their format string for reference
1586
during branch opening. It's not required that these be instances, they
1587
can be classes themselves with class methods - it simply depends on
1588
whether state is needed for a given format or not.
1590
Once a format is deprecated, just deprecate the initialize and open
1591
methods on the format class. Do not deprecate the object, as the
1592
object will be created every time regardless.
1595
def __eq__(self, other):
1596
return self.__class__ is other.__class__
1598
def __ne__(self, other):
1599
return not (self == other)
1602
def find_format(klass, a_bzrdir, name=None):
1603
"""Return the format for the branch object in a_bzrdir."""
1605
transport = a_bzrdir.get_branch_transport(None, name=name)
1606
format_string = transport.get_bytes("format")
1607
return format_registry.get(format_string)
1608
except errors.NoSuchFile:
1609
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1611
raise errors.UnknownFormatError(format=format_string, kind='branch')
1614
@deprecated_method(deprecated_in((2, 4, 0)))
1615
def get_default_format(klass):
1616
"""Return the current default format."""
1617
return format_registry.get_default()
1620
@deprecated_method(deprecated_in((2, 4, 0)))
1621
def get_formats(klass):
1622
"""Get all the known formats.
1624
Warning: This triggers a load of all lazy registered formats: do not
1625
use except when that is desireed.
1627
return format_registry._get_all()
1629
def get_reference(self, a_bzrdir, name=None):
1630
"""Get the target reference of the branch in a_bzrdir.
1632
format probing must have been completed before calling
1633
this method - it is assumed that the format of the branch
1634
in a_bzrdir is correct.
1636
:param a_bzrdir: The bzrdir to get the branch data from.
1637
:param name: Name of the colocated branch to fetch
1638
:return: None if the branch is not a reference branch.
1643
def set_reference(self, a_bzrdir, name, to_branch):
1644
"""Set the target reference of the branch in a_bzrdir.
1646
format probing must have been completed before calling
1647
this method - it is assumed that the format of the branch
1648
in a_bzrdir is correct.
1650
:param a_bzrdir: The bzrdir to set the branch reference for.
1651
:param name: Name of colocated branch to set, None for default
1652
:param to_branch: branch that the checkout is to reference
1654
raise NotImplementedError(self.set_reference)
1656
def get_format_string(self):
1657
"""Return the ASCII format string that identifies this format."""
1658
raise NotImplementedError(self.get_format_string)
1660
def get_format_description(self):
1661
"""Return the short format description for this format."""
1662
raise NotImplementedError(self.get_format_description)
1664
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1665
hooks = Branch.hooks['post_branch_init']
1668
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1672
def initialize(self, a_bzrdir, name=None, repository=None,
1673
append_revisions_only=None):
1674
"""Create a branch of this format in a_bzrdir.
1676
:param name: Name of the colocated branch to create.
1678
raise NotImplementedError(self.initialize)
1680
def is_supported(self):
1681
"""Is this format supported?
1683
Supported formats can be initialized and opened.
1684
Unsupported formats may not support initialization or committing or
1685
some other features depending on the reason for not being supported.
1689
def make_tags(self, branch):
1690
"""Create a tags object for branch.
1692
This method is on BranchFormat, because BranchFormats are reflected
1693
over the wire via network_name(), whereas full Branch instances require
1694
multiple VFS method calls to operate at all.
1696
The default implementation returns a disabled-tags instance.
1698
Note that it is normal for branch to be a RemoteBranch when using tags
1701
return _mod_tag.DisabledTags(branch)
1703
def network_name(self):
1704
"""A simple byte string uniquely identifying this format for RPC calls.
1706
MetaDir branch formats use their disk format string to identify the
1707
repository over the wire. All in one formats such as bzr < 0.8, and
1708
foreign formats like svn/git and hg should use some marker which is
1709
unique and immutable.
1711
raise NotImplementedError(self.network_name)
1713
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
1714
found_repository=None):
1715
"""Return the branch object for a_bzrdir
1717
:param a_bzrdir: A BzrDir that contains a branch.
1718
:param name: Name of colocated branch to open
1719
:param _found: a private parameter, do not use it. It is used to
1720
indicate if format probing has already be done.
1721
:param ignore_fallbacks: when set, no fallback branches will be opened
1722
(if there are any). Default is to open fallbacks.
1724
raise NotImplementedError(self.open)
1727
@deprecated_method(deprecated_in((2, 4, 0)))
1728
def register_format(klass, format):
1729
"""Register a metadir format.
1731
See MetaDirBranchFormatFactory for the ability to register a format
1732
without loading the code the format needs until it is actually used.
1734
format_registry.register(format)
1737
@deprecated_method(deprecated_in((2, 4, 0)))
1738
def set_default_format(klass, format):
1739
format_registry.set_default(format)
1741
def supports_set_append_revisions_only(self):
1742
"""True if this format supports set_append_revisions_only."""
1745
def supports_stacking(self):
1746
"""True if this format records a stacked-on branch."""
1749
def supports_leaving_lock(self):
1750
"""True if this format supports leaving locks in place."""
1751
return False # by default
1754
@deprecated_method(deprecated_in((2, 4, 0)))
1755
def unregister_format(klass, format):
1756
format_registry.remove(format)
1759
return self.get_format_description().rstrip()
1761
def supports_tags(self):
1762
"""True if this format supports tags stored in the branch"""
1763
return False # by default
1765
def tags_are_versioned(self):
1766
"""Whether the tag container for this branch versions tags."""
1769
def supports_tags_referencing_ghosts(self):
1770
"""True if tags can reference ghost revisions."""
1774
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1775
"""A factory for a BranchFormat object, permitting simple lazy registration.
1777
While none of the built in BranchFormats are lazy registered yet,
1778
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1779
use it, and the bzr-loom plugin uses it as well (see
1780
bzrlib.plugins.loom.formats).
1783
def __init__(self, format_string, module_name, member_name):
1784
"""Create a MetaDirBranchFormatFactory.
1786
:param format_string: The format string the format has.
1787
:param module_name: Module to load the format class from.
1788
:param member_name: Attribute name within the module for the format class.
1790
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1791
self._format_string = format_string
1793
def get_format_string(self):
1794
"""See BranchFormat.get_format_string."""
1795
return self._format_string
1798
"""Used for network_format_registry support."""
1799
return self.get_obj()()
1802
class BranchHooks(Hooks):
1803
"""A dictionary mapping hook name to a list of callables for branch hooks.
1805
e.g. ['set_rh'] Is the list of items to be called when the
1806
set_revision_history function is invoked.
1810
"""Create the default hooks.
1812
These are all empty initially, because by default nothing should get
1815
Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1816
self.add_hook('set_rh',
1817
"Invoked whenever the revision history has been set via "
1818
"set_revision_history. The api signature is (branch, "
1819
"revision_history), and the branch will be write-locked. "
1820
"The set_rh hook can be expensive for bzr to trigger, a better "
1821
"hook to use is Branch.post_change_branch_tip.", (0, 15))
1822
self.add_hook('open',
1823
"Called with the Branch object that has been opened after a "
1824
"branch is opened.", (1, 8))
1825
self.add_hook('post_push',
1826
"Called after a push operation completes. post_push is called "
1827
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1828
"bzr client.", (0, 15))
1829
self.add_hook('post_pull',
1830
"Called after a pull operation completes. post_pull is called "
1831
"with a bzrlib.branch.PullResult object and only runs in the "
1832
"bzr client.", (0, 15))
1833
self.add_hook('pre_commit',
1834
"Called after a commit is calculated but before it is "
1835
"completed. pre_commit is called with (local, master, old_revno, "
1836
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1837
"). old_revid is NULL_REVISION for the first commit to a branch, "
1838
"tree_delta is a TreeDelta object describing changes from the "
1839
"basis revision. hooks MUST NOT modify this delta. "
1840
" future_tree is an in-memory tree obtained from "
1841
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1843
self.add_hook('post_commit',
1844
"Called in the bzr client after a commit has completed. "
1845
"post_commit is called with (local, master, old_revno, old_revid, "
1846
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1847
"commit to a branch.", (0, 15))
1848
self.add_hook('post_uncommit',
1849
"Called in the bzr client after an uncommit completes. "
1850
"post_uncommit is called with (local, master, old_revno, "
1851
"old_revid, new_revno, new_revid) where local is the local branch "
1852
"or None, master is the target branch, and an empty branch "
1853
"receives new_revno of 0, new_revid of None.", (0, 15))
1854
self.add_hook('pre_change_branch_tip',
1855
"Called in bzr client and server before a change to the tip of a "
1856
"branch is made. pre_change_branch_tip is called with a "
1857
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1858
"commit, uncommit will all trigger this hook.", (1, 6))
1859
self.add_hook('post_change_branch_tip',
1860
"Called in bzr client and server after a change to the tip of a "
1861
"branch is made. post_change_branch_tip is called with a "
1862
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1863
"commit, uncommit will all trigger this hook.", (1, 4))
1864
self.add_hook('transform_fallback_location',
1865
"Called when a stacked branch is activating its fallback "
1866
"locations. transform_fallback_location is called with (branch, "
1867
"url), and should return a new url. Returning the same url "
1868
"allows it to be used as-is, returning a different one can be "
1869
"used to cause the branch to stack on a closer copy of that "
1870
"fallback_location. Note that the branch cannot have history "
1871
"accessing methods called on it during this hook because the "
1872
"fallback locations have not been activated. When there are "
1873
"multiple hooks installed for transform_fallback_location, "
1874
"all are called with the url returned from the previous hook."
1875
"The order is however undefined.", (1, 9))
1876
self.add_hook('automatic_tag_name',
1877
"Called to determine an automatic tag name for a revision. "
1878
"automatic_tag_name is called with (branch, revision_id) and "
1879
"should return a tag name or None if no tag name could be "
1880
"determined. The first non-None tag name returned will be used.",
1882
self.add_hook('post_branch_init',
1883
"Called after new branch initialization completes. "
1884
"post_branch_init is called with a "
1885
"bzrlib.branch.BranchInitHookParams. "
1886
"Note that init, branch and checkout (both heavyweight and "
1887
"lightweight) will all trigger this hook.", (2, 2))
1888
self.add_hook('post_switch',
1889
"Called after a checkout switches branch. "
1890
"post_switch is called with a "
1891
"bzrlib.branch.SwitchHookParams.", (2, 2))
1895
# install the default hooks into the Branch class.
1896
Branch.hooks = BranchHooks()
1899
class ChangeBranchTipParams(object):
1900
"""Object holding parameters passed to `*_change_branch_tip` hooks.
1902
There are 5 fields that hooks may wish to access:
1904
:ivar branch: the branch being changed
1905
:ivar old_revno: revision number before the change
1906
:ivar new_revno: revision number after the change
1907
:ivar old_revid: revision id before the change
1908
:ivar new_revid: revision id after the change
1910
The revid fields are strings. The revno fields are integers.
1913
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1914
"""Create a group of ChangeBranchTip parameters.
1916
:param branch: The branch being changed.
1917
:param old_revno: Revision number before the change.
1918
:param new_revno: Revision number after the change.
1919
:param old_revid: Tip revision id before the change.
1920
:param new_revid: Tip revision id after the change.
1922
self.branch = branch
1923
self.old_revno = old_revno
1924
self.new_revno = new_revno
1925
self.old_revid = old_revid
1926
self.new_revid = new_revid
1928
def __eq__(self, other):
1929
return self.__dict__ == other.__dict__
1932
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1933
self.__class__.__name__, self.branch,
1934
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1937
class BranchInitHookParams(object):
1938
"""Object holding parameters passed to `*_branch_init` hooks.
1940
There are 4 fields that hooks may wish to access:
1942
:ivar format: the branch format
1943
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1944
:ivar name: name of colocated branch, if any (or None)
1945
:ivar branch: the branch created
1947
Note that for lightweight checkouts, the bzrdir and format fields refer to
1948
the checkout, hence they are different from the corresponding fields in
1949
branch, which refer to the original branch.
1952
def __init__(self, format, a_bzrdir, name, branch):
1953
"""Create a group of BranchInitHook parameters.
1955
:param format: the branch format
1956
:param a_bzrdir: the BzrDir where the branch will be/has been
1958
:param name: name of colocated branch, if any (or None)
1959
:param branch: the branch created
1961
Note that for lightweight checkouts, the bzrdir and format fields refer
1962
to the checkout, hence they are different from the corresponding fields
1963
in branch, which refer to the original branch.
1965
self.format = format
1966
self.bzrdir = a_bzrdir
1968
self.branch = branch
1970
def __eq__(self, other):
1971
return self.__dict__ == other.__dict__
1974
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1977
class SwitchHookParams(object):
1978
"""Object holding parameters passed to `*_switch` hooks.
1980
There are 4 fields that hooks may wish to access:
1982
:ivar control_dir: BzrDir of the checkout to change
1983
:ivar to_branch: branch that the checkout is to reference
1984
:ivar force: skip the check for local commits in a heavy checkout
1985
:ivar revision_id: revision ID to switch to (or None)
1988
def __init__(self, control_dir, to_branch, force, revision_id):
1989
"""Create a group of SwitchHook parameters.
1991
:param control_dir: BzrDir of the checkout to change
1992
:param to_branch: branch that the checkout is to reference
1993
:param force: skip the check for local commits in a heavy checkout
1994
:param revision_id: revision ID to switch to (or None)
1996
self.control_dir = control_dir
1997
self.to_branch = to_branch
1999
self.revision_id = revision_id
2001
def __eq__(self, other):
2002
return self.__dict__ == other.__dict__
2005
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
2006
self.control_dir, self.to_branch,
2010
class BranchFormatMetadir(BranchFormat):
2011
"""Common logic for meta-dir based branch formats."""
2013
def _branch_class(self):
2014
"""What class to instantiate on open calls."""
2015
raise NotImplementedError(self._branch_class)
2017
def _get_initial_config(self, append_revisions_only=None):
2018
if append_revisions_only:
2019
return "append_revisions_only = True\n"
2021
# Avoid writing anything if append_revisions_only is disabled,
2022
# as that is the default.
2025
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
2027
"""Initialize a branch in a bzrdir, with specified files
2029
:param a_bzrdir: The bzrdir to initialize the branch in
2030
:param utf8_files: The files to create as a list of
2031
(filename, content) tuples
2032
:param name: Name of colocated branch to create, if any
2033
:return: a branch in this format
2035
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2036
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2037
control_files = lockable_files.LockableFiles(branch_transport,
2038
'lock', lockdir.LockDir)
2039
control_files.create_lock()
2040
control_files.lock_write()
2042
utf8_files += [('format', self.get_format_string())]
2043
for (filename, content) in utf8_files:
2044
branch_transport.put_bytes(
2046
mode=a_bzrdir._get_file_mode())
2048
control_files.unlock()
2049
branch = self.open(a_bzrdir, name, _found=True,
2050
found_repository=repository)
2051
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2054
def network_name(self):
2055
"""A simple byte string uniquely identifying this format for RPC calls.
2057
Metadir branch formats use their format string.
2059
return self.get_format_string()
2061
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2062
found_repository=None):
2063
"""See BranchFormat.open()."""
2065
format = BranchFormat.find_format(a_bzrdir, name=name)
2066
if format.__class__ != self.__class__:
2067
raise AssertionError("wrong format %r found for %r" %
2069
transport = a_bzrdir.get_branch_transport(None, name=name)
2071
control_files = lockable_files.LockableFiles(transport, 'lock',
2073
if found_repository is None:
2074
found_repository = a_bzrdir.find_repository()
2075
return self._branch_class()(_format=self,
2076
_control_files=control_files,
2079
_repository=found_repository,
2080
ignore_fallbacks=ignore_fallbacks)
2081
except errors.NoSuchFile:
2082
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2085
super(BranchFormatMetadir, self).__init__()
2086
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2087
self._matchingbzrdir.set_branch_format(self)
2089
def supports_tags(self):
2092
def supports_leaving_lock(self):
2096
class BzrBranchFormat5(BranchFormatMetadir):
2097
"""Bzr branch format 5.
2100
- a revision-history file.
2102
- a lock dir guarding the branch itself
2103
- all of this stored in a branch/ subdirectory
2104
- works with shared repositories.
2106
This format is new in bzr 0.8.
2109
def _branch_class(self):
2112
def get_format_string(self):
2113
"""See BranchFormat.get_format_string()."""
2114
return "Bazaar-NG branch format 5\n"
2116
def get_format_description(self):
2117
"""See BranchFormat.get_format_description()."""
2118
return "Branch format 5"
2120
def initialize(self, a_bzrdir, name=None, repository=None,
2121
append_revisions_only=None):
2122
"""Create a branch of this format in a_bzrdir."""
2123
if append_revisions_only:
2124
raise errors.UpgradeRequired(a_bzrdir.user_url)
2125
utf8_files = [('revision-history', ''),
2126
('branch-name', ''),
2128
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2130
def supports_tags(self):
2134
class BzrBranchFormat6(BranchFormatMetadir):
2135
"""Branch format with last-revision and tags.
2137
Unlike previous formats, this has no explicit revision history. Instead,
2138
this just stores the last-revision, and the left-hand history leading
2139
up to there is the history.
2141
This format was introduced in bzr 0.15
2142
and became the default in 0.91.
2145
def _branch_class(self):
2148
def get_format_string(self):
2149
"""See BranchFormat.get_format_string()."""
2150
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2152
def get_format_description(self):
2153
"""See BranchFormat.get_format_description()."""
2154
return "Branch format 6"
2156
def initialize(self, a_bzrdir, name=None, repository=None,
2157
append_revisions_only=None):
2158
"""Create a branch of this format in a_bzrdir."""
2159
utf8_files = [('last-revision', '0 null:\n'),
2161
self._get_initial_config(append_revisions_only)),
2164
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2166
def make_tags(self, branch):
2167
"""See bzrlib.branch.BranchFormat.make_tags()."""
2168
return _mod_tag.BasicTags(branch)
2170
def supports_set_append_revisions_only(self):
2174
class BzrBranchFormat8(BranchFormatMetadir):
2175
"""Metadir format supporting storing locations of subtree branches."""
2177
def _branch_class(self):
2180
def get_format_string(self):
2181
"""See BranchFormat.get_format_string()."""
2182
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2184
def get_format_description(self):
2185
"""See BranchFormat.get_format_description()."""
2186
return "Branch format 8"
2188
def initialize(self, a_bzrdir, name=None, repository=None,
2189
append_revisions_only=None):
2190
"""Create a branch of this format in a_bzrdir."""
2191
utf8_files = [('last-revision', '0 null:\n'),
2193
self._get_initial_config(append_revisions_only)),
2197
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2199
def make_tags(self, branch):
2200
"""See bzrlib.branch.BranchFormat.make_tags()."""
2201
return _mod_tag.BasicTags(branch)
2203
def supports_set_append_revisions_only(self):
2206
def supports_stacking(self):
2209
supports_reference_locations = True
2212
class BzrBranchFormat7(BranchFormatMetadir):
2213
"""Branch format with last-revision, tags, and a stacked location pointer.
2215
The stacked location pointer is passed down to the repository and requires
2216
a repository format with supports_external_lookups = True.
2218
This format was introduced in bzr 1.6.
2221
def initialize(self, a_bzrdir, name=None, repository=None,
2222
append_revisions_only=None):
2223
"""Create a branch of this format in a_bzrdir."""
2224
utf8_files = [('last-revision', '0 null:\n'),
2226
self._get_initial_config(append_revisions_only)),
2229
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2231
def _branch_class(self):
2234
def get_format_string(self):
2235
"""See BranchFormat.get_format_string()."""
2236
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2238
def get_format_description(self):
2239
"""See BranchFormat.get_format_description()."""
2240
return "Branch format 7"
2242
def supports_set_append_revisions_only(self):
2245
def supports_stacking(self):
2248
def make_tags(self, branch):
2249
"""See bzrlib.branch.BranchFormat.make_tags()."""
2250
return _mod_tag.BasicTags(branch)
2252
supports_reference_locations = False
2255
class BranchReferenceFormat(BranchFormat):
2256
"""Bzr branch reference format.
2258
Branch references are used in implementing checkouts, they
2259
act as an alias to the real branch which is at some other url.
2266
def get_format_string(self):
2267
"""See BranchFormat.get_format_string()."""
2268
return "Bazaar-NG Branch Reference Format 1\n"
2270
def get_format_description(self):
2271
"""See BranchFormat.get_format_description()."""
2272
return "Checkout reference format 1"
2274
def get_reference(self, a_bzrdir, name=None):
2275
"""See BranchFormat.get_reference()."""
2276
transport = a_bzrdir.get_branch_transport(None, name=name)
2277
return transport.get_bytes('location')
2279
def set_reference(self, a_bzrdir, name, to_branch):
2280
"""See BranchFormat.set_reference()."""
2281
transport = a_bzrdir.get_branch_transport(None, name=name)
2282
location = transport.put_bytes('location', to_branch.base)
2284
def initialize(self, a_bzrdir, name=None, target_branch=None,
2285
repository=None, append_revisions_only=None):
2286
"""Create a branch of this format in a_bzrdir."""
2287
if target_branch is None:
2288
# this format does not implement branch itself, thus the implicit
2289
# creation contract must see it as uninitializable
2290
raise errors.UninitializableFormat(self)
2291
mutter('creating branch reference in %s', a_bzrdir.user_url)
2292
if a_bzrdir._format.fixed_components:
2293
raise errors.IncompatibleFormat(self, a_bzrdir._format)
2294
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2295
branch_transport.put_bytes('location',
2296
target_branch.bzrdir.user_url)
2297
branch_transport.put_bytes('format', self.get_format_string())
2299
a_bzrdir, name, _found=True,
2300
possible_transports=[target_branch.bzrdir.root_transport])
2301
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2305
super(BranchReferenceFormat, self).__init__()
2306
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2307
self._matchingbzrdir.set_branch_format(self)
2309
def _make_reference_clone_function(format, a_branch):
2310
"""Create a clone() routine for a branch dynamically."""
2311
def clone(to_bzrdir, revision_id=None,
2312
repository_policy=None):
2313
"""See Branch.clone()."""
2314
return format.initialize(to_bzrdir, target_branch=a_branch)
2315
# cannot obey revision_id limits when cloning a reference ...
2316
# FIXME RBC 20060210 either nuke revision_id for clone, or
2317
# emit some sort of warning/error to the caller ?!
2320
def open(self, a_bzrdir, name=None, _found=False, location=None,
2321
possible_transports=None, ignore_fallbacks=False,
2322
found_repository=None):
2323
"""Return the branch that the branch reference in a_bzrdir points at.
2325
:param a_bzrdir: A BzrDir that contains a branch.
2326
:param name: Name of colocated branch to open, if any
2327
:param _found: a private parameter, do not use it. It is used to
2328
indicate if format probing has already be done.
2329
:param ignore_fallbacks: when set, no fallback branches will be opened
2330
(if there are any). Default is to open fallbacks.
2331
:param location: The location of the referenced branch. If
2332
unspecified, this will be determined from the branch reference in
2334
:param possible_transports: An optional reusable transports list.
2337
format = BranchFormat.find_format(a_bzrdir, name=name)
2338
if format.__class__ != self.__class__:
2339
raise AssertionError("wrong format %r found for %r" %
2341
if location is None:
2342
location = self.get_reference(a_bzrdir, name)
2343
real_bzrdir = bzrdir.BzrDir.open(
2344
location, possible_transports=possible_transports)
2345
result = real_bzrdir.open_branch(name=name,
2346
ignore_fallbacks=ignore_fallbacks)
2347
# this changes the behaviour of result.clone to create a new reference
2348
# rather than a copy of the content of the branch.
2349
# I did not use a proxy object because that needs much more extensive
2350
# testing, and we are only changing one behaviour at the moment.
2351
# If we decide to alter more behaviours - i.e. the implicit nickname
2352
# then this should be refactored to introduce a tested proxy branch
2353
# and a subclass of that for use in overriding clone() and ....
2355
result.clone = self._make_reference_clone_function(result)
2359
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2360
"""Branch format registry."""
2362
def __init__(self, other_registry=None):
2363
super(BranchFormatRegistry, self).__init__(other_registry)
2364
self._default_format = None
2366
def set_default(self, format):
2367
self._default_format = format
2369
def get_default(self):
2370
return self._default_format
2373
network_format_registry = registry.FormatRegistry()
2374
"""Registry of formats indexed by their network name.
2376
The network name for a branch format is an identifier that can be used when
2377
referring to formats with smart server operations. See
2378
BranchFormat.network_name() for more detail.
2381
format_registry = BranchFormatRegistry(network_format_registry)
2384
# formats which have no format string are not discoverable
2385
# and not independently creatable, so are not registered.
2386
__format5 = BzrBranchFormat5()
2387
__format6 = BzrBranchFormat6()
2388
__format7 = BzrBranchFormat7()
2389
__format8 = BzrBranchFormat8()
2390
format_registry.register(__format5)
2391
format_registry.register(BranchReferenceFormat())
2392
format_registry.register(__format6)
2393
format_registry.register(__format7)
2394
format_registry.register(__format8)
2395
format_registry.set_default(__format7)
2398
class BranchWriteLockResult(LogicalLockResult):
2399
"""The result of write locking a branch.
2401
:ivar branch_token: The token obtained from the underlying branch lock, or
2403
:ivar unlock: A callable which will unlock the lock.
2406
def __init__(self, unlock, branch_token):
2407
LogicalLockResult.__init__(self, unlock)
2408
self.branch_token = branch_token
2411
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2415
class BzrBranch(Branch, _RelockDebugMixin):
2416
"""A branch stored in the actual filesystem.
2418
Note that it's "local" in the context of the filesystem; it doesn't
2419
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2420
it's writable, and can be accessed via the normal filesystem API.
2422
:ivar _transport: Transport for file operations on this branch's
2423
control files, typically pointing to the .bzr/branch directory.
2424
:ivar repository: Repository for this branch.
2425
:ivar base: The url of the base directory for this branch; the one
2426
containing the .bzr directory.
2427
:ivar name: Optional colocated branch name as it exists in the control
2431
def __init__(self, _format=None,
2432
_control_files=None, a_bzrdir=None, name=None,
2433
_repository=None, ignore_fallbacks=False):
2434
"""Create new branch object at a particular location."""
2435
if a_bzrdir is None:
2436
raise ValueError('a_bzrdir must be supplied')
2438
self.bzrdir = a_bzrdir
2439
self._base = self.bzrdir.transport.clone('..').base
2441
# XXX: We should be able to just do
2442
# self.base = self.bzrdir.root_transport.base
2443
# but this does not quite work yet -- mbp 20080522
2444
self._format = _format
2445
if _control_files is None:
2446
raise ValueError('BzrBranch _control_files is None')
2447
self.control_files = _control_files
2448
self._transport = _control_files._transport
2449
self.repository = _repository
2450
Branch.__init__(self)
2453
if self.name is None:
2454
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2456
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2461
def _get_base(self):
2462
"""Returns the directory containing the control directory."""
2465
base = property(_get_base, doc="The URL for the root of this branch.")
2467
def _get_config(self):
2468
return _mod_config.TransportConfig(self._transport, 'branch.conf')
2470
def is_locked(self):
2471
return self.control_files.is_locked()
2473
def lock_write(self, token=None):
2474
"""Lock the branch for write operations.
2476
:param token: A token to permit reacquiring a previously held and
2478
:return: A BranchWriteLockResult.
2480
if not self.is_locked():
2481
self._note_lock('w')
2482
# All-in-one needs to always unlock/lock.
2483
repo_control = getattr(self.repository, 'control_files', None)
2484
if self.control_files == repo_control or not self.is_locked():
2485
self.repository._warn_if_deprecated(self)
2486
self.repository.lock_write()
2491
return BranchWriteLockResult(self.unlock,
2492
self.control_files.lock_write(token=token))
2495
self.repository.unlock()
2498
def lock_read(self):
2499
"""Lock the branch for read operations.
2501
:return: A bzrlib.lock.LogicalLockResult.
2503
if not self.is_locked():
2504
self._note_lock('r')
2505
# All-in-one needs to always unlock/lock.
2506
repo_control = getattr(self.repository, 'control_files', None)
2507
if self.control_files == repo_control or not self.is_locked():
2508
self.repository._warn_if_deprecated(self)
2509
self.repository.lock_read()
2514
self.control_files.lock_read()
2515
return LogicalLockResult(self.unlock)
2518
self.repository.unlock()
2521
@only_raises(errors.LockNotHeld, errors.LockBroken)
2524
self.control_files.unlock()
2526
# All-in-one needs to always unlock/lock.
2527
repo_control = getattr(self.repository, 'control_files', None)
2528
if (self.control_files == repo_control or
2529
not self.control_files.is_locked()):
2530
self.repository.unlock()
2531
if not self.control_files.is_locked():
2532
# we just released the lock
2533
self._clear_cached_state()
2535
def peek_lock_mode(self):
2536
if self.control_files._lock_count == 0:
2539
return self.control_files._lock_mode
2541
def get_physical_lock_status(self):
2542
return self.control_files.get_physical_lock_status()
2545
def print_file(self, file, revision_id):
2546
"""See Branch.print_file."""
2547
return self.repository.print_file(file, revision_id)
2550
def set_last_revision_info(self, revno, revision_id):
2551
if not revision_id or not isinstance(revision_id, basestring):
2552
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2553
revision_id = _mod_revision.ensure_null(revision_id)
2554
old_revno, old_revid = self.last_revision_info()
2555
if self.get_append_revisions_only():
2556
self._check_history_violation(revision_id)
2557
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2558
self._write_last_revision_info(revno, revision_id)
2559
self._clear_cached_state()
2560
self._last_revision_info_cache = revno, revision_id
2561
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2563
def basis_tree(self):
2564
"""See Branch.basis_tree."""
2565
return self.repository.revision_tree(self.last_revision())
2567
def _get_parent_location(self):
2568
_locs = ['parent', 'pull', 'x-pull']
2571
return self._transport.get_bytes(l).strip('\n')
2572
except errors.NoSuchFile:
2576
def get_stacked_on_url(self):
2577
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2579
def set_push_location(self, location):
2580
"""See Branch.set_push_location."""
2581
self.get_config().set_user_option(
2582
'push_location', location,
2583
store=_mod_config.STORE_LOCATION_NORECURSE)
2585
def _set_parent_location(self, url):
2587
self._transport.delete('parent')
2589
self._transport.put_bytes('parent', url + '\n',
2590
mode=self.bzrdir._get_file_mode())
2594
"""If bound, unbind"""
2595
return self.set_bound_location(None)
2598
def bind(self, other):
2599
"""Bind this branch to the branch other.
2601
This does not push or pull data between the branches, though it does
2602
check for divergence to raise an error when the branches are not
2603
either the same, or one a prefix of the other. That behaviour may not
2604
be useful, so that check may be removed in future.
2606
:param other: The branch to bind to
2609
# TODO: jam 20051230 Consider checking if the target is bound
2610
# It is debatable whether you should be able to bind to
2611
# a branch which is itself bound.
2612
# Committing is obviously forbidden,
2613
# but binding itself may not be.
2614
# Since we *have* to check at commit time, we don't
2615
# *need* to check here
2617
# we want to raise diverged if:
2618
# last_rev is not in the other_last_rev history, AND
2619
# other_last_rev is not in our history, and do it without pulling
2621
self.set_bound_location(other.base)
2623
def get_bound_location(self):
2625
return self._transport.get_bytes('bound')[:-1]
2626
except errors.NoSuchFile:
2630
def get_master_branch(self, possible_transports=None):
2631
"""Return the branch we are bound to.
2633
:return: Either a Branch, or None
2635
if self._master_branch_cache is None:
2636
self._master_branch_cache = self._get_master_branch(
2637
possible_transports)
2638
return self._master_branch_cache
2640
def _get_master_branch(self, possible_transports):
2641
bound_loc = self.get_bound_location()
2645
return Branch.open(bound_loc,
2646
possible_transports=possible_transports)
2647
except (errors.NotBranchError, errors.ConnectionError), e:
2648
raise errors.BoundBranchConnectionFailure(
2652
def set_bound_location(self, location):
2653
"""Set the target where this branch is bound to.
2655
:param location: URL to the target branch
2657
self._master_branch_cache = None
2659
self._transport.put_bytes('bound', location+'\n',
2660
mode=self.bzrdir._get_file_mode())
2663
self._transport.delete('bound')
2664
except errors.NoSuchFile:
2669
def update(self, possible_transports=None):
2670
"""Synchronise this branch with the master branch if any.
2672
:return: None or the last_revision that was pivoted out during the
2675
master = self.get_master_branch(possible_transports)
2676
if master is not None:
2677
old_tip = _mod_revision.ensure_null(self.last_revision())
2678
self.pull(master, overwrite=True)
2679
if self.repository.get_graph().is_ancestor(old_tip,
2680
_mod_revision.ensure_null(self.last_revision())):
2685
def _read_last_revision_info(self):
2686
revision_string = self._transport.get_bytes('last-revision')
2687
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2688
revision_id = cache_utf8.get_cached_utf8(revision_id)
2690
return revno, revision_id
2692
def _write_last_revision_info(self, revno, revision_id):
2693
"""Simply write out the revision id, with no checks.
2695
Use set_last_revision_info to perform this safely.
2697
Does not update the revision_history cache.
2699
revision_id = _mod_revision.ensure_null(revision_id)
2700
out_string = '%d %s\n' % (revno, revision_id)
2701
self._transport.put_bytes('last-revision', out_string,
2702
mode=self.bzrdir._get_file_mode())
2705
class FullHistoryBzrBranch(BzrBranch):
2706
"""Bzr branch which contains the full revision history."""
2709
def set_last_revision_info(self, revno, revision_id):
2710
if not revision_id or not isinstance(revision_id, basestring):
2711
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2712
revision_id = _mod_revision.ensure_null(revision_id)
2713
# this old format stores the full history, but this api doesn't
2714
# provide it, so we must generate, and might as well check it's
2716
history = self._lefthand_history(revision_id)
2717
if len(history) != revno:
2718
raise AssertionError('%d != %d' % (len(history), revno))
2719
self._set_revision_history(history)
2721
def _read_last_revision_info(self):
2722
rh = self._revision_history()
2725
return (revno, rh[-1])
2727
return (0, _mod_revision.NULL_REVISION)
2729
@deprecated_method(deprecated_in((2, 4, 0)))
2731
def set_revision_history(self, rev_history):
2732
"""See Branch.set_revision_history."""
2733
self._set_revision_history(rev_history)
2735
def _set_revision_history(self, rev_history):
2736
if 'evil' in debug.debug_flags:
2737
mutter_callsite(3, "set_revision_history scales with history.")
2738
check_not_reserved_id = _mod_revision.check_not_reserved_id
2739
for rev_id in rev_history:
2740
check_not_reserved_id(rev_id)
2741
if Branch.hooks['post_change_branch_tip']:
2742
# Don't calculate the last_revision_info() if there are no hooks
2744
old_revno, old_revid = self.last_revision_info()
2745
if len(rev_history) == 0:
2746
revid = _mod_revision.NULL_REVISION
2748
revid = rev_history[-1]
2749
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2750
self._write_revision_history(rev_history)
2751
self._clear_cached_state()
2752
self._cache_revision_history(rev_history)
2753
for hook in Branch.hooks['set_rh']:
2754
hook(self, rev_history)
2755
if Branch.hooks['post_change_branch_tip']:
2756
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2758
def _write_revision_history(self, history):
2759
"""Factored out of set_revision_history.
2761
This performs the actual writing to disk.
2762
It is intended to be called by set_revision_history."""
2763
self._transport.put_bytes(
2764
'revision-history', '\n'.join(history),
2765
mode=self.bzrdir._get_file_mode())
2767
def _gen_revision_history(self):
2768
history = self._transport.get_bytes('revision-history').split('\n')
2769
if history[-1:] == ['']:
2770
# There shouldn't be a trailing newline, but just in case.
2774
def _synchronize_history(self, destination, revision_id):
2775
if not isinstance(destination, FullHistoryBzrBranch):
2776
super(BzrBranch, self)._synchronize_history(
2777
destination, revision_id)
2779
if revision_id == _mod_revision.NULL_REVISION:
2782
new_history = self._revision_history()
2783
if revision_id is not None and new_history != []:
2785
new_history = new_history[:new_history.index(revision_id) + 1]
2787
rev = self.repository.get_revision(revision_id)
2788
new_history = rev.get_history(self.repository)[1:]
2789
destination._set_revision_history(new_history)
2792
def generate_revision_history(self, revision_id, last_rev=None,
2794
"""Create a new revision history that will finish with revision_id.
2796
:param revision_id: the new tip to use.
2797
:param last_rev: The previous last_revision. If not None, then this
2798
must be a ancestory of revision_id, or DivergedBranches is raised.
2799
:param other_branch: The other branch that DivergedBranches should
2800
raise with respect to.
2802
self._set_revision_history(self._lefthand_history(revision_id,
2803
last_rev, other_branch))
2806
class BzrBranch5(FullHistoryBzrBranch):
2807
"""A format 5 branch. This supports new features over plain branches.
2809
It has support for a master_branch which is the data for bound branches.
2813
class BzrBranch8(BzrBranch):
2814
"""A branch that stores tree-reference locations."""
2816
def _open_hook(self):
2817
if self._ignore_fallbacks:
2820
url = self.get_stacked_on_url()
2821
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2822
errors.UnstackableBranchFormat):
2825
for hook in Branch.hooks['transform_fallback_location']:
2826
url = hook(self, url)
2828
hook_name = Branch.hooks.get_hook_name(hook)
2829
raise AssertionError(
2830
"'transform_fallback_location' hook %s returned "
2831
"None, not a URL." % hook_name)
2832
self._activate_fallback_location(url)
2834
def __init__(self, *args, **kwargs):
2835
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2836
super(BzrBranch8, self).__init__(*args, **kwargs)
2837
self._last_revision_info_cache = None
2838
self._reference_info = None
2840
def _clear_cached_state(self):
2841
super(BzrBranch8, self)._clear_cached_state()
2842
self._last_revision_info_cache = None
2843
self._reference_info = None
2845
def _check_history_violation(self, revision_id):
2846
current_revid = self.last_revision()
2847
last_revision = _mod_revision.ensure_null(current_revid)
2848
if _mod_revision.is_null(last_revision):
2850
graph = self.repository.get_graph()
2851
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2852
if lh_ancestor == current_revid:
2854
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2856
def _gen_revision_history(self):
2857
"""Generate the revision history from last revision
2859
last_revno, last_revision = self.last_revision_info()
2860
self._extend_partial_history(stop_index=last_revno-1)
2861
return list(reversed(self._partial_revision_history_cache))
2864
def _set_parent_location(self, url):
2865
"""Set the parent branch"""
2866
self._set_config_location('parent_location', url, make_relative=True)
2869
def _get_parent_location(self):
2870
"""Set the parent branch"""
2871
return self._get_config_location('parent_location')
2874
def _set_all_reference_info(self, info_dict):
2875
"""Replace all reference info stored in a branch.
2877
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2880
writer = rio.RioWriter(s)
2881
for key, (tree_path, branch_location) in info_dict.iteritems():
2882
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2883
branch_location=branch_location)
2884
writer.write_stanza(stanza)
2885
self._transport.put_bytes('references', s.getvalue())
2886
self._reference_info = info_dict
2889
def _get_all_reference_info(self):
2890
"""Return all the reference info stored in a branch.
2892
:return: A dict of {file_id: (tree_path, branch_location)}
2894
if self._reference_info is not None:
2895
return self._reference_info
2896
rio_file = self._transport.get('references')
2898
stanzas = rio.read_stanzas(rio_file)
2899
info_dict = dict((s['file_id'], (s['tree_path'],
2900
s['branch_location'])) for s in stanzas)
2903
self._reference_info = info_dict
2906
def set_reference_info(self, file_id, tree_path, branch_location):
2907
"""Set the branch location to use for a tree reference.
2909
:param file_id: The file-id of the tree reference.
2910
:param tree_path: The path of the tree reference in the tree.
2911
:param branch_location: The location of the branch to retrieve tree
2914
info_dict = self._get_all_reference_info()
2915
info_dict[file_id] = (tree_path, branch_location)
2916
if None in (tree_path, branch_location):
2917
if tree_path is not None:
2918
raise ValueError('tree_path must be None when branch_location'
2920
if branch_location is not None:
2921
raise ValueError('branch_location must be None when tree_path'
2923
del info_dict[file_id]
2924
self._set_all_reference_info(info_dict)
2926
def get_reference_info(self, file_id):
2927
"""Get the tree_path and branch_location for a tree reference.
2929
:return: a tuple of (tree_path, branch_location)
2931
return self._get_all_reference_info().get(file_id, (None, None))
2933
def reference_parent(self, file_id, path, possible_transports=None):
2934
"""Return the parent branch for a tree-reference file_id.
2936
:param file_id: The file_id of the tree reference
2937
:param path: The path of the file_id in the tree
2938
:return: A branch associated with the file_id
2940
branch_location = self.get_reference_info(file_id)[1]
2941
if branch_location is None:
2942
return Branch.reference_parent(self, file_id, path,
2943
possible_transports)
2944
branch_location = urlutils.join(self.user_url, branch_location)
2945
return Branch.open(branch_location,
2946
possible_transports=possible_transports)
2948
def set_push_location(self, location):
2949
"""See Branch.set_push_location."""
2950
self._set_config_location('push_location', location)
2952
def set_bound_location(self, location):
2953
"""See Branch.set_push_location."""
2954
self._master_branch_cache = None
2956
config = self.get_config()
2957
if location is None:
2958
if config.get_user_option('bound') != 'True':
2961
config.set_user_option('bound', 'False', warn_masked=True)
2964
self._set_config_location('bound_location', location,
2966
config.set_user_option('bound', 'True', warn_masked=True)
2969
def _get_bound_location(self, bound):
2970
"""Return the bound location in the config file.
2972
Return None if the bound parameter does not match"""
2973
config = self.get_config()
2974
config_bound = (config.get_user_option('bound') == 'True')
2975
if config_bound != bound:
2977
return self._get_config_location('bound_location', config=config)
2979
def get_bound_location(self):
2980
"""See Branch.set_push_location."""
2981
return self._get_bound_location(True)
2983
def get_old_bound_location(self):
2984
"""See Branch.get_old_bound_location"""
2985
return self._get_bound_location(False)
2987
def get_stacked_on_url(self):
2988
# you can always ask for the URL; but you might not be able to use it
2989
# if the repo can't support stacking.
2990
## self._check_stackable_repo()
2991
# stacked_on_location is only ever defined in branch.conf, so don't
2992
# waste effort reading the whole stack of config files.
2993
config = self.get_config()._get_branch_data_config()
2994
stacked_url = self._get_config_location('stacked_on_location',
2996
if stacked_url is None:
2997
raise errors.NotStacked(self)
3001
def get_rev_id(self, revno, history=None):
3002
"""Find the revision id of the specified revno."""
3004
return _mod_revision.NULL_REVISION
3006
last_revno, last_revision_id = self.last_revision_info()
3007
if revno <= 0 or revno > last_revno:
3008
raise errors.NoSuchRevision(self, revno)
3010
if history is not None:
3011
return history[revno - 1]
3013
index = last_revno - revno
3014
if len(self._partial_revision_history_cache) <= index:
3015
self._extend_partial_history(stop_index=index)
3016
if len(self._partial_revision_history_cache) > index:
3017
return self._partial_revision_history_cache[index]
3019
raise errors.NoSuchRevision(self, revno)
3022
def revision_id_to_revno(self, revision_id):
3023
"""Given a revision id, return its revno"""
3024
if _mod_revision.is_null(revision_id):
3027
index = self._partial_revision_history_cache.index(revision_id)
3030
self._extend_partial_history(stop_revision=revision_id)
3031
except errors.RevisionNotPresent, e:
3032
raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
3033
index = len(self._partial_revision_history_cache) - 1
3034
if self._partial_revision_history_cache[index] != revision_id:
3035
raise errors.NoSuchRevision(self, revision_id)
3036
return self.revno() - index
3039
class BzrBranch7(BzrBranch8):
3040
"""A branch with support for a fallback repository."""
3042
def set_reference_info(self, file_id, tree_path, branch_location):
3043
Branch.set_reference_info(self, file_id, tree_path, branch_location)
3045
def get_reference_info(self, file_id):
3046
Branch.get_reference_info(self, file_id)
3048
def reference_parent(self, file_id, path, possible_transports=None):
3049
return Branch.reference_parent(self, file_id, path,
3050
possible_transports)
3053
class BzrBranch6(BzrBranch7):
3054
"""See BzrBranchFormat6 for the capabilities of this branch.
3056
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
3060
def get_stacked_on_url(self):
3061
raise errors.UnstackableBranchFormat(self._format, self.user_url)
3064
######################################################################
3065
# results of operations
3068
class _Result(object):
3070
def _show_tag_conficts(self, to_file):
3071
if not getattr(self, 'tag_conflicts', None):
3073
to_file.write('Conflicting tags:\n')
3074
for name, value1, value2 in self.tag_conflicts:
3075
to_file.write(' %s\n' % (name, ))
3078
class PullResult(_Result):
3079
"""Result of a Branch.pull operation.
3081
:ivar old_revno: Revision number before pull.
3082
:ivar new_revno: Revision number after pull.
3083
:ivar old_revid: Tip revision id before pull.
3084
:ivar new_revid: Tip revision id after pull.
3085
:ivar source_branch: Source (local) branch object. (read locked)
3086
:ivar master_branch: Master branch of the target, or the target if no
3088
:ivar local_branch: target branch if there is a Master, else None
3089
:ivar target_branch: Target/destination branch object. (write locked)
3090
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3091
:ivar tag_updates: A dict with new tags, see BasicTags.merge_to
3094
@deprecated_method(deprecated_in((2, 3, 0)))
3096
"""Return the relative change in revno.
3098
:deprecated: Use `new_revno` and `old_revno` instead.
3100
return self.new_revno - self.old_revno
3102
def report(self, to_file):
3103
tag_conflicts = getattr(self, "tag_conflicts", None)
3104
tag_updates = getattr(self, "tag_updates", None)
3106
if self.old_revid != self.new_revid:
3107
to_file.write('Now on revision %d.\n' % self.new_revno)
3109
to_file.write('%d tag(s) updated.\n' % len(tag_updates))
3110
if self.old_revid == self.new_revid and not tag_updates:
3111
if not tag_conflicts:
3112
to_file.write('No revisions or tags to pull.\n')
3114
to_file.write('No revisions to pull.\n')
3115
self._show_tag_conficts(to_file)
3118
class BranchPushResult(_Result):
3119
"""Result of a Branch.push operation.
3121
:ivar old_revno: Revision number (eg 10) of the target before push.
3122
:ivar new_revno: Revision number (eg 12) of the target after push.
3123
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3125
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3127
:ivar source_branch: Source branch object that the push was from. This is
3128
read locked, and generally is a local (and thus low latency) branch.
3129
:ivar master_branch: If target is a bound branch, the master branch of
3130
target, or target itself. Always write locked.
3131
:ivar target_branch: The direct Branch where data is being sent (write
3133
:ivar local_branch: If the target is a bound branch this will be the
3134
target, otherwise it will be None.
3137
@deprecated_method(deprecated_in((2, 3, 0)))
3139
"""Return the relative change in revno.
3141
:deprecated: Use `new_revno` and `old_revno` instead.
3143
return self.new_revno - self.old_revno
3145
def report(self, to_file):
3146
# TODO: This function gets passed a to_file, but then
3147
# ignores it and calls note() instead. This is also
3148
# inconsistent with PullResult(), which writes to stdout.
3149
# -- JRV20110901, bug #838853
3150
tag_conflicts = getattr(self, "tag_conflicts", None)
3151
tag_updates = getattr(self, "tag_updates", None)
3153
if self.old_revid != self.new_revid:
3154
note(gettext('Pushed up to revision %d.') % self.new_revno)
3156
note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
3157
if self.old_revid == self.new_revid and not tag_updates:
3158
if not tag_conflicts:
3159
note(gettext('No new revisions or tags to push.'))
3161
note(gettext('No new revisions to push.'))
3162
self._show_tag_conficts(to_file)
3165
class BranchCheckResult(object):
3166
"""Results of checking branch consistency.
3171
def __init__(self, branch):
3172
self.branch = branch
3175
def report_results(self, verbose):
3176
"""Report the check results via trace.note.
3178
:param verbose: Requests more detailed display of what was checked,
3181
note(gettext('checked branch {0} format {1}').format(
3182
self.branch.user_url, self.branch._format))
3183
for error in self.errors:
3184
note(gettext('found error:%s'), error)
3187
class Converter5to6(object):
3188
"""Perform an in-place upgrade of format 5 to format 6"""
3190
def convert(self, branch):
3191
# Data for 5 and 6 can peacefully coexist.
3192
format = BzrBranchFormat6()
3193
new_branch = format.open(branch.bzrdir, _found=True)
3195
# Copy source data into target
3196
new_branch._write_last_revision_info(*branch.last_revision_info())
3197
new_branch.set_parent(branch.get_parent())
3198
new_branch.set_bound_location(branch.get_bound_location())
3199
new_branch.set_push_location(branch.get_push_location())
3201
# New branch has no tags by default
3202
new_branch.tags._set_tag_dict({})
3204
# Copying done; now update target format
3205
new_branch._transport.put_bytes('format',
3206
format.get_format_string(),
3207
mode=new_branch.bzrdir._get_file_mode())
3209
# Clean up old files
3210
new_branch._transport.delete('revision-history')
3212
branch.set_parent(None)
3213
except errors.NoSuchFile:
3215
branch.set_bound_location(None)
3218
class Converter6to7(object):
3219
"""Perform an in-place upgrade of format 6 to format 7"""
3221
def convert(self, branch):
3222
format = BzrBranchFormat7()
3223
branch._set_config_location('stacked_on_location', '')
3224
# update target format
3225
branch._transport.put_bytes('format', format.get_format_string())
3228
class Converter7to8(object):
3229
"""Perform an in-place upgrade of format 7 to format 8"""
3231
def convert(self, branch):
3232
format = BzrBranchFormat8()
3233
branch._transport.put_bytes('references', '')
3234
# update target format
3235
branch._transport.put_bytes('format', format.get_format_string())
3238
class InterBranch(InterObject):
3239
"""This class represents operations taking place between two branches.
3241
Its instances have methods like pull() and push() and contain
3242
references to the source and target repositories these operations
3243
can be carried out on.
3247
"""The available optimised InterBranch types."""
3250
def _get_branch_formats_to_test(klass):
3251
"""Return an iterable of format tuples for testing.
3253
:return: An iterable of (from_format, to_format) to use when testing
3254
this InterBranch class. Each InterBranch class should define this
3257
raise NotImplementedError(klass._get_branch_formats_to_test)
3260
def pull(self, overwrite=False, stop_revision=None,
3261
possible_transports=None, local=False):
3262
"""Mirror source into target branch.
3264
The target branch is considered to be 'local', having low latency.
3266
:returns: PullResult instance
3268
raise NotImplementedError(self.pull)
3271
def push(self, overwrite=False, stop_revision=None, lossy=False,
3272
_override_hook_source_branch=None):
3273
"""Mirror the source branch into the target branch.
3275
The source branch is considered to be 'local', having low latency.
3277
raise NotImplementedError(self.push)
3280
def copy_content_into(self, revision_id=None):
3281
"""Copy the content of source into target
3283
revision_id: if not None, the revision history in the new branch will
3284
be truncated to end with revision_id.
3286
raise NotImplementedError(self.copy_content_into)
3289
def fetch(self, stop_revision=None, limit=None):
3292
:param stop_revision: Last revision to fetch
3293
:param limit: Optional rough limit of revisions to fetch
3295
raise NotImplementedError(self.fetch)
3298
class GenericInterBranch(InterBranch):
3299
"""InterBranch implementation that uses public Branch functions."""
3302
def is_compatible(klass, source, target):
3303
# GenericBranch uses the public API, so always compatible
3307
def _get_branch_formats_to_test(klass):
3308
return [(format_registry.get_default(), format_registry.get_default())]
3311
def unwrap_format(klass, format):
3312
if isinstance(format, remote.RemoteBranchFormat):
3313
format._ensure_real()
3314
return format._custom_format
3318
def copy_content_into(self, revision_id=None):
3319
"""Copy the content of source into target
3321
revision_id: if not None, the revision history in the new branch will
3322
be truncated to end with revision_id.
3324
self.source.update_references(self.target)
3325
self.source._synchronize_history(self.target, revision_id)
3327
parent = self.source.get_parent()
3328
except errors.InaccessibleParent, e:
3329
mutter('parent was not accessible to copy: %s', e)
3332
self.target.set_parent(parent)
3333
if self.source._push_should_merge_tags():
3334
self.source.tags.merge_to(self.target.tags)
3337
def fetch(self, stop_revision=None, limit=None):
3338
if self.target.base == self.source.base:
3340
self.source.lock_read()
3342
fetch_spec_factory = fetch.FetchSpecFactory()
3343
fetch_spec_factory.source_branch = self.source
3344
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3345
fetch_spec_factory.source_repo = self.source.repository
3346
fetch_spec_factory.target_repo = self.target.repository
3347
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3348
fetch_spec_factory.limit = limit
3349
fetch_spec = fetch_spec_factory.make_fetch_spec()
3350
return self.target.repository.fetch(self.source.repository,
3351
fetch_spec=fetch_spec)
3353
self.source.unlock()
3356
def _update_revisions(self, stop_revision=None, overwrite=False,
3358
other_revno, other_last_revision = self.source.last_revision_info()
3359
stop_revno = None # unknown
3360
if stop_revision is None:
3361
stop_revision = other_last_revision
3362
if _mod_revision.is_null(stop_revision):
3363
# if there are no commits, we're done.
3365
stop_revno = other_revno
3367
# what's the current last revision, before we fetch [and change it
3369
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3370
# we fetch here so that we don't process data twice in the common
3371
# case of having something to pull, and so that the check for
3372
# already merged can operate on the just fetched graph, which will
3373
# be cached in memory.
3374
self.fetch(stop_revision=stop_revision)
3375
# Check to see if one is an ancestor of the other
3378
graph = self.target.repository.get_graph()
3379
if self.target._check_if_descendant_or_diverged(
3380
stop_revision, last_rev, graph, self.source):
3381
# stop_revision is a descendant of last_rev, but we aren't
3382
# overwriting, so we're done.
3384
if stop_revno is None:
3386
graph = self.target.repository.get_graph()
3387
this_revno, this_last_revision = \
3388
self.target.last_revision_info()
3389
stop_revno = graph.find_distance_to_null(stop_revision,
3390
[(other_last_revision, other_revno),
3391
(this_last_revision, this_revno)])
3392
self.target.set_last_revision_info(stop_revno, stop_revision)
3395
def pull(self, overwrite=False, stop_revision=None,
3396
possible_transports=None, run_hooks=True,
3397
_override_hook_target=None, local=False):
3398
"""Pull from source into self, updating my master if any.
3400
:param run_hooks: Private parameter - if false, this branch
3401
is being called because it's the master of the primary branch,
3402
so it should not run its hooks.
3404
bound_location = self.target.get_bound_location()
3405
if local and not bound_location:
3406
raise errors.LocalRequiresBoundBranch()
3407
master_branch = None
3408
source_is_master = False
3410
# bound_location comes from a config file, some care has to be
3411
# taken to relate it to source.user_url
3412
normalized = urlutils.normalize_url(bound_location)
3414
relpath = self.source.user_transport.relpath(normalized)
3415
source_is_master = (relpath == '')
3416
except (errors.PathNotChild, errors.InvalidURL):
3417
source_is_master = False
3418
if not local and bound_location and not source_is_master:
3419
# not pulling from master, so we need to update master.
3420
master_branch = self.target.get_master_branch(possible_transports)
3421
master_branch.lock_write()
3424
# pull from source into master.
3425
master_branch.pull(self.source, overwrite, stop_revision,
3427
return self._pull(overwrite,
3428
stop_revision, _hook_master=master_branch,
3429
run_hooks=run_hooks,
3430
_override_hook_target=_override_hook_target,
3431
merge_tags_to_master=not source_is_master)
3434
master_branch.unlock()
3436
def push(self, overwrite=False, stop_revision=None, lossy=False,
3437
_override_hook_source_branch=None):
3438
"""See InterBranch.push.
3440
This is the basic concrete implementation of push()
3442
:param _override_hook_source_branch: If specified, run the hooks
3443
passing this Branch as the source, rather than self. This is for
3444
use of RemoteBranch, where push is delegated to the underlying
3448
raise errors.LossyPushToSameVCS(self.source, self.target)
3449
# TODO: Public option to disable running hooks - should be trivial but
3452
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3453
op.add_cleanup(self.source.lock_read().unlock)
3454
op.add_cleanup(self.target.lock_write().unlock)
3455
return op.run(overwrite, stop_revision,
3456
_override_hook_source_branch=_override_hook_source_branch)
3458
def _basic_push(self, overwrite, stop_revision):
3459
"""Basic implementation of push without bound branches or hooks.
3461
Must be called with source read locked and target write locked.
3463
result = BranchPushResult()
3464
result.source_branch = self.source
3465
result.target_branch = self.target
3466
result.old_revno, result.old_revid = self.target.last_revision_info()
3467
self.source.update_references(self.target)
3468
if result.old_revid != stop_revision:
3469
# We assume that during 'push' this repository is closer than
3471
graph = self.source.repository.get_graph(self.target.repository)
3472
self._update_revisions(stop_revision, overwrite=overwrite,
3474
if self.source._push_should_merge_tags():
3475
result.tag_updates, result.tag_conflicts = (
3476
self.source.tags.merge_to(self.target.tags, overwrite))
3477
result.new_revno, result.new_revid = self.target.last_revision_info()
3480
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3481
_override_hook_source_branch=None):
3482
"""Push from source into target, and into target's master if any.
3485
if _override_hook_source_branch:
3486
result.source_branch = _override_hook_source_branch
3487
for hook in Branch.hooks['post_push']:
3490
bound_location = self.target.get_bound_location()
3491
if bound_location and self.target.base != bound_location:
3492
# there is a master branch.
3494
# XXX: Why the second check? Is it even supported for a branch to
3495
# be bound to itself? -- mbp 20070507
3496
master_branch = self.target.get_master_branch()
3497
master_branch.lock_write()
3498
operation.add_cleanup(master_branch.unlock)
3499
# push into the master from the source branch.
3500
master_inter = InterBranch.get(self.source, master_branch)
3501
master_inter._basic_push(overwrite, stop_revision)
3502
# and push into the target branch from the source. Note that
3503
# we push from the source branch again, because it's considered
3504
# the highest bandwidth repository.
3505
result = self._basic_push(overwrite, stop_revision)
3506
result.master_branch = master_branch
3507
result.local_branch = self.target
3509
master_branch = None
3511
result = self._basic_push(overwrite, stop_revision)
3512
# TODO: Why set master_branch and local_branch if there's no
3513
# binding? Maybe cleaner to just leave them unset? -- mbp
3515
result.master_branch = self.target
3516
result.local_branch = None
3520
def _pull(self, overwrite=False, stop_revision=None,
3521
possible_transports=None, _hook_master=None, run_hooks=True,
3522
_override_hook_target=None, local=False,
3523
merge_tags_to_master=True):
3526
This function is the core worker, used by GenericInterBranch.pull to
3527
avoid duplication when pulling source->master and source->local.
3529
:param _hook_master: Private parameter - set the branch to
3530
be supplied as the master to pull hooks.
3531
:param run_hooks: Private parameter - if false, this branch
3532
is being called because it's the master of the primary branch,
3533
so it should not run its hooks.
3534
is being called because it's the master of the primary branch,
3535
so it should not run its hooks.
3536
:param _override_hook_target: Private parameter - set the branch to be
3537
supplied as the target_branch to pull hooks.
3538
:param local: Only update the local branch, and not the bound branch.
3540
# This type of branch can't be bound.
3542
raise errors.LocalRequiresBoundBranch()
3543
result = PullResult()
3544
result.source_branch = self.source
3545
if _override_hook_target is None:
3546
result.target_branch = self.target
3548
result.target_branch = _override_hook_target
3549
self.source.lock_read()
3551
# We assume that during 'pull' the target repository is closer than
3553
self.source.update_references(self.target)
3554
graph = self.target.repository.get_graph(self.source.repository)
3555
# TODO: Branch formats should have a flag that indicates
3556
# that revno's are expensive, and pull() should honor that flag.
3558
result.old_revno, result.old_revid = \
3559
self.target.last_revision_info()
3560
self._update_revisions(stop_revision, overwrite=overwrite,
3562
# TODO: The old revid should be specified when merging tags,
3563
# so a tags implementation that versions tags can only
3564
# pull in the most recent changes. -- JRV20090506
3565
result.tag_updates, result.tag_conflicts = (
3566
self.source.tags.merge_to(self.target.tags, overwrite,
3567
ignore_master=not merge_tags_to_master))
3568
result.new_revno, result.new_revid = self.target.last_revision_info()
3570
result.master_branch = _hook_master
3571
result.local_branch = result.target_branch
3573
result.master_branch = result.target_branch
3574
result.local_branch = None
3576
for hook in Branch.hooks['post_pull']:
3579
self.source.unlock()
3583
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
