1
# Copyright (C) 2005-2012 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
17
from __future__ import absolute_import
21
from cStringIO import StringIO
23
from bzrlib.lazy_import import lazy_import
24
lazy_import(globals(), """
31
config as _mod_config,
40
revision as _mod_revision,
48
from bzrlib.i18n import gettext, ngettext
51
# Explicitly import bzrlib.bzrdir so that the BzrProber
52
# is guaranteed to be registered.
59
from bzrlib.decorators import (
64
from bzrlib.hooks import Hooks
65
from bzrlib.inter import InterObject
66
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
67
from bzrlib import registry
68
from bzrlib.symbol_versioning import (
72
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
75
class Branch(controldir.ControlComponent):
76
"""Branch holding a history of revisions.
79
Base directory/url of the branch; using control_url and
80
control_transport is more standardized.
81
:ivar hooks: An instance of BranchHooks.
82
:ivar _master_branch_cache: cached result of get_master_branch, see
85
# this is really an instance variable - FIXME move it there
90
def control_transport(self):
91
return self._transport
94
def user_transport(self):
95
return self.bzrdir.user_transport
97
def __init__(self, possible_transports=None):
98
self.tags = self._format.make_tags(self)
99
self._revision_history_cache = None
100
self._revision_id_to_revno_cache = None
101
self._partial_revision_id_to_revno_cache = {}
102
self._partial_revision_history_cache = []
103
self._tags_bytes = None
104
self._last_revision_info_cache = None
105
self._master_branch_cache = None
106
self._merge_sorted_revisions_cache = None
107
self._open_hook(possible_transports)
108
hooks = Branch.hooks['open']
112
def _open_hook(self, possible_transports):
113
"""Called by init to allow simpler extension of the base class."""
115
def _activate_fallback_location(self, url, possible_transports):
116
"""Activate the branch/repository from url as a fallback repository."""
117
for existing_fallback_repo in self.repository._fallback_repositories:
118
if existing_fallback_repo.user_url == url:
119
# This fallback is already configured. This probably only
120
# happens because ControlDir.sprout is a horrible mess. To avoid
121
# confusing _unstack we don't add this a second time.
122
mutter('duplicate activation of fallback %r on %r', url, self)
124
repo = self._get_fallback_repository(url, possible_transports)
125
if repo.has_same_location(self.repository):
126
raise errors.UnstackableLocationError(self.user_url, url)
127
self.repository.add_fallback_repository(repo)
129
def break_lock(self):
130
"""Break a lock if one is present from another instance.
132
Uses the ui factory to ask for confirmation if the lock may be from
135
This will probe the repository for its lock as well.
137
self.control_files.break_lock()
138
self.repository.break_lock()
139
master = self.get_master_branch()
140
if master is not None:
143
def _check_stackable_repo(self):
144
if not self.repository._format.supports_external_lookups:
145
raise errors.UnstackableRepositoryFormat(self.repository._format,
146
self.repository.base)
148
def _extend_partial_history(self, stop_index=None, stop_revision=None):
149
"""Extend the partial history to include a given index
151
If a stop_index is supplied, stop when that index has been reached.
152
If a stop_revision is supplied, stop when that revision is
153
encountered. Otherwise, stop when the beginning of history is
156
:param stop_index: The index which should be present. When it is
157
present, history extension will stop.
158
:param stop_revision: The revision id which should be present. When
159
it is encountered, history extension will stop.
161
if len(self._partial_revision_history_cache) == 0:
162
self._partial_revision_history_cache = [self.last_revision()]
163
repository._iter_for_revno(
164
self.repository, self._partial_revision_history_cache,
165
stop_index=stop_index, stop_revision=stop_revision)
166
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
167
self._partial_revision_history_cache.pop()
169
def _get_check_refs(self):
170
"""Get the references needed for check().
174
revid = self.last_revision()
175
return [('revision-existence', revid), ('lefthand-distance', revid)]
178
def open(base, _unsupported=False, possible_transports=None):
179
"""Open the branch rooted at base.
181
For instance, if the branch is at URL/.bzr/branch,
182
Branch.open(URL) -> a Branch instance.
184
control = controldir.ControlDir.open(base,
185
possible_transports=possible_transports, _unsupported=_unsupported)
186
return control.open_branch(unsupported=_unsupported,
187
possible_transports=possible_transports)
190
def open_from_transport(transport, name=None, _unsupported=False,
191
possible_transports=None):
192
"""Open the branch rooted at transport"""
193
control = controldir.ControlDir.open_from_transport(transport, _unsupported)
194
return control.open_branch(name=name, unsupported=_unsupported,
195
possible_transports=possible_transports)
198
def open_containing(url, possible_transports=None):
199
"""Open an existing branch which contains url.
201
This probes for a branch at url, and searches upwards from there.
203
Basically we keep looking up until we find the control directory or
204
run into the root. If there isn't one, raises NotBranchError.
205
If there is one and it is either an unrecognised format or an unsupported
206
format, UnknownFormatError or UnsupportedFormatError are raised.
207
If there is one, it is returned, along with the unused portion of url.
209
control, relpath = controldir.ControlDir.open_containing(url,
211
branch = control.open_branch(possible_transports=possible_transports)
212
return (branch, relpath)
214
def _push_should_merge_tags(self):
215
"""Should _basic_push merge this branch's tags into the target?
217
The default implementation returns False if this branch has no tags,
218
and True the rest of the time. Subclasses may override this.
220
return self.supports_tags() and self.tags.get_tag_dict()
222
def get_config(self):
223
"""Get a bzrlib.config.BranchConfig for this Branch.
225
This can then be used to get and set configuration options for the
228
:return: A bzrlib.config.BranchConfig.
230
return _mod_config.BranchConfig(self)
232
def get_config_stack(self):
233
"""Get a bzrlib.config.BranchStack for this Branch.
235
This can then be used to get and set configuration options for the
238
:return: A bzrlib.config.BranchStack.
240
return _mod_config.BranchStack(self)
242
def _get_config(self):
243
"""Get the concrete config for just the config in this branch.
245
This is not intended for client use; see Branch.get_config for the
250
:return: An object supporting get_option and set_option.
252
raise NotImplementedError(self._get_config)
254
def _get_fallback_repository(self, url, possible_transports):
255
"""Get the repository we fallback to at url."""
256
url = urlutils.join(self.base, url)
257
a_branch = Branch.open(url, possible_transports=possible_transports)
258
return a_branch.repository
261
def _get_tags_bytes(self):
262
"""Get the bytes of a serialised tags dict.
264
Note that not all branches support tags, nor do all use the same tags
265
logic: this method is specific to BasicTags. Other tag implementations
266
may use the same method name and behave differently, safely, because
267
of the double-dispatch via
268
format.make_tags->tags_instance->get_tags_dict.
270
:return: The bytes of the tags file.
271
:seealso: Branch._set_tags_bytes.
273
if self._tags_bytes is None:
274
self._tags_bytes = self._transport.get_bytes('tags')
275
return self._tags_bytes
277
def _get_nick(self, local=False, possible_transports=None):
278
config = self.get_config()
279
# explicit overrides master, but don't look for master if local is True
280
if not local and not config.has_explicit_nickname():
282
master = self.get_master_branch(possible_transports)
283
if master and self.user_url == master.user_url:
284
raise errors.RecursiveBind(self.user_url)
285
if master is not None:
286
# return the master branch value
288
except errors.RecursiveBind, e:
290
except errors.BzrError, e:
291
# Silently fall back to local implicit nick if the master is
293
mutter("Could not connect to bound branch, "
294
"falling back to local nick.\n " + str(e))
295
return config.get_nickname()
297
def _set_nick(self, nick):
298
self.get_config().set_user_option('nickname', nick, warn_masked=True)
300
nick = property(_get_nick, _set_nick)
303
raise NotImplementedError(self.is_locked)
305
def _lefthand_history(self, revision_id, last_rev=None,
307
if 'evil' in debug.debug_flags:
308
mutter_callsite(4, "_lefthand_history scales with history.")
309
# stop_revision must be a descendant of last_revision
310
graph = self.repository.get_graph()
311
if last_rev is not None:
312
if not graph.is_ancestor(last_rev, revision_id):
313
# our previous tip is not merged into stop_revision
314
raise errors.DivergedBranches(self, other_branch)
315
# make a new revision history from the graph
316
parents_map = graph.get_parent_map([revision_id])
317
if revision_id not in parents_map:
318
raise errors.NoSuchRevision(self, revision_id)
319
current_rev_id = revision_id
321
check_not_reserved_id = _mod_revision.check_not_reserved_id
322
# Do not include ghosts or graph origin in revision_history
323
while (current_rev_id in parents_map and
324
len(parents_map[current_rev_id]) > 0):
325
check_not_reserved_id(current_rev_id)
326
new_history.append(current_rev_id)
327
current_rev_id = parents_map[current_rev_id][0]
328
parents_map = graph.get_parent_map([current_rev_id])
329
new_history.reverse()
332
def lock_write(self, token=None):
333
"""Lock the branch for write operations.
335
:param token: A token to permit reacquiring a previously held and
337
:return: A BranchWriteLockResult.
339
raise NotImplementedError(self.lock_write)
342
"""Lock the branch for read operations.
344
:return: A bzrlib.lock.LogicalLockResult.
346
raise NotImplementedError(self.lock_read)
349
raise NotImplementedError(self.unlock)
351
def peek_lock_mode(self):
352
"""Return lock mode for the Branch: 'r', 'w' or None"""
353
raise NotImplementedError(self.peek_lock_mode)
355
def get_physical_lock_status(self):
356
raise NotImplementedError(self.get_physical_lock_status)
359
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
360
"""Return the revision_id for a dotted revno.
362
:param revno: a tuple like (1,) or (1,1,2)
363
:param _cache_reverse: a private parameter enabling storage
364
of the reverse mapping in a top level cache. (This should
365
only be done in selective circumstances as we want to
366
avoid having the mapping cached multiple times.)
367
:return: the revision_id
368
:raises errors.NoSuchRevision: if the revno doesn't exist
370
rev_id = self._do_dotted_revno_to_revision_id(revno)
372
self._partial_revision_id_to_revno_cache[rev_id] = revno
375
def _do_dotted_revno_to_revision_id(self, revno):
376
"""Worker function for dotted_revno_to_revision_id.
378
Subclasses should override this if they wish to
379
provide a more efficient implementation.
382
return self.get_rev_id(revno[0])
383
revision_id_to_revno = self.get_revision_id_to_revno_map()
384
revision_ids = [revision_id for revision_id, this_revno
385
in revision_id_to_revno.iteritems()
386
if revno == this_revno]
387
if len(revision_ids) == 1:
388
return revision_ids[0]
390
revno_str = '.'.join(map(str, revno))
391
raise errors.NoSuchRevision(self, revno_str)
394
def revision_id_to_dotted_revno(self, revision_id):
395
"""Given a revision id, return its dotted revno.
397
:return: a tuple like (1,) or (400,1,3).
399
return self._do_revision_id_to_dotted_revno(revision_id)
401
def _do_revision_id_to_dotted_revno(self, revision_id):
402
"""Worker function for revision_id_to_revno."""
403
# Try the caches if they are loaded
404
result = self._partial_revision_id_to_revno_cache.get(revision_id)
405
if result is not None:
407
if self._revision_id_to_revno_cache:
408
result = self._revision_id_to_revno_cache.get(revision_id)
410
raise errors.NoSuchRevision(self, revision_id)
411
# Try the mainline as it's optimised
413
revno = self.revision_id_to_revno(revision_id)
415
except errors.NoSuchRevision:
416
# We need to load and use the full revno map after all
417
result = self.get_revision_id_to_revno_map().get(revision_id)
419
raise errors.NoSuchRevision(self, revision_id)
423
def get_revision_id_to_revno_map(self):
424
"""Return the revision_id => dotted revno map.
426
This will be regenerated on demand, but will be cached.
428
:return: A dictionary mapping revision_id => dotted revno.
429
This dictionary should not be modified by the caller.
431
if self._revision_id_to_revno_cache is not None:
432
mapping = self._revision_id_to_revno_cache
434
mapping = self._gen_revno_map()
435
self._cache_revision_id_to_revno(mapping)
436
# TODO: jam 20070417 Since this is being cached, should we be returning
438
# I would rather not, and instead just declare that users should not
439
# modify the return value.
442
def _gen_revno_map(self):
443
"""Create a new mapping from revision ids to dotted revnos.
445
Dotted revnos are generated based on the current tip in the revision
447
This is the worker function for get_revision_id_to_revno_map, which
448
just caches the return value.
450
:return: A dictionary mapping revision_id => dotted revno.
452
revision_id_to_revno = dict((rev_id, revno)
453
for rev_id, depth, revno, end_of_merge
454
in self.iter_merge_sorted_revisions())
455
return revision_id_to_revno
458
def iter_merge_sorted_revisions(self, start_revision_id=None,
459
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
460
"""Walk the revisions for a branch in merge sorted order.
462
Merge sorted order is the output from a merge-aware,
463
topological sort, i.e. all parents come before their
464
children going forward; the opposite for reverse.
466
:param start_revision_id: the revision_id to begin walking from.
467
If None, the branch tip is used.
468
:param stop_revision_id: the revision_id to terminate the walk
469
after. If None, the rest of history is included.
470
:param stop_rule: if stop_revision_id is not None, the precise rule
471
to use for termination:
473
* 'exclude' - leave the stop revision out of the result (default)
474
* 'include' - the stop revision is the last item in the result
475
* 'with-merges' - include the stop revision and all of its
476
merged revisions in the result
477
* 'with-merges-without-common-ancestry' - filter out revisions
478
that are in both ancestries
479
:param direction: either 'reverse' or 'forward':
481
* reverse means return the start_revision_id first, i.e.
482
start at the most recent revision and go backwards in history
483
* forward returns tuples in the opposite order to reverse.
484
Note in particular that forward does *not* do any intelligent
485
ordering w.r.t. depth as some clients of this API may like.
486
(If required, that ought to be done at higher layers.)
488
:return: an iterator over (revision_id, depth, revno, end_of_merge)
491
* revision_id: the unique id of the revision
492
* depth: How many levels of merging deep this node has been
494
* revno_sequence: This field provides a sequence of
495
revision numbers for all revisions. The format is:
496
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
497
branch that the revno is on. From left to right the REVNO numbers
498
are the sequence numbers within that branch of the revision.
499
* end_of_merge: When True the next node (earlier in history) is
500
part of a different merge.
502
# Note: depth and revno values are in the context of the branch so
503
# we need the full graph to get stable numbers, regardless of the
505
if self._merge_sorted_revisions_cache is None:
506
last_revision = self.last_revision()
507
known_graph = self.repository.get_known_graph_ancestry(
509
self._merge_sorted_revisions_cache = known_graph.merge_sort(
511
filtered = self._filter_merge_sorted_revisions(
512
self._merge_sorted_revisions_cache, start_revision_id,
513
stop_revision_id, stop_rule)
514
# Make sure we don't return revisions that are not part of the
515
# start_revision_id ancestry.
516
filtered = self._filter_start_non_ancestors(filtered)
517
if direction == 'reverse':
519
if direction == 'forward':
520
return reversed(list(filtered))
522
raise ValueError('invalid direction %r' % direction)
524
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
525
start_revision_id, stop_revision_id, stop_rule):
526
"""Iterate over an inclusive range of sorted revisions."""
527
rev_iter = iter(merge_sorted_revisions)
528
if start_revision_id is not None:
529
for node in rev_iter:
531
if rev_id != start_revision_id:
534
# The decision to include the start or not
535
# depends on the stop_rule if a stop is provided
536
# so pop this node back into the iterator
537
rev_iter = itertools.chain(iter([node]), rev_iter)
539
if stop_revision_id is None:
541
for node in rev_iter:
543
yield (rev_id, node.merge_depth, node.revno,
545
elif stop_rule == 'exclude':
546
for node in rev_iter:
548
if rev_id == stop_revision_id:
550
yield (rev_id, node.merge_depth, node.revno,
552
elif stop_rule == 'include':
553
for node in rev_iter:
555
yield (rev_id, node.merge_depth, node.revno,
557
if rev_id == stop_revision_id:
559
elif stop_rule == 'with-merges-without-common-ancestry':
560
# We want to exclude all revisions that are already part of the
561
# stop_revision_id ancestry.
562
graph = self.repository.get_graph()
563
ancestors = graph.find_unique_ancestors(start_revision_id,
565
for node in rev_iter:
567
if rev_id not in ancestors:
569
yield (rev_id, node.merge_depth, node.revno,
571
elif stop_rule == 'with-merges':
572
stop_rev = self.repository.get_revision(stop_revision_id)
573
if stop_rev.parent_ids:
574
left_parent = stop_rev.parent_ids[0]
576
left_parent = _mod_revision.NULL_REVISION
577
# left_parent is the actual revision we want to stop logging at,
578
# since we want to show the merged revisions after the stop_rev too
579
reached_stop_revision_id = False
580
revision_id_whitelist = []
581
for node in rev_iter:
583
if rev_id == left_parent:
584
# reached the left parent after the stop_revision
586
if (not reached_stop_revision_id or
587
rev_id in revision_id_whitelist):
588
yield (rev_id, node.merge_depth, node.revno,
590
if reached_stop_revision_id or rev_id == stop_revision_id:
591
# only do the merged revs of rev_id from now on
592
rev = self.repository.get_revision(rev_id)
594
reached_stop_revision_id = True
595
revision_id_whitelist.extend(rev.parent_ids)
597
raise ValueError('invalid stop_rule %r' % stop_rule)
599
def _filter_start_non_ancestors(self, rev_iter):
600
# If we started from a dotted revno, we want to consider it as a tip
601
# and don't want to yield revisions that are not part of its
602
# ancestry. Given the order guaranteed by the merge sort, we will see
603
# uninteresting descendants of the first parent of our tip before the
605
first = rev_iter.next()
606
(rev_id, merge_depth, revno, end_of_merge) = first
609
# We start at a mainline revision so by definition, all others
610
# revisions in rev_iter are ancestors
611
for node in rev_iter:
616
pmap = self.repository.get_parent_map([rev_id])
617
parents = pmap.get(rev_id, [])
619
whitelist.update(parents)
621
# If there is no parents, there is nothing of interest left
623
# FIXME: It's hard to test this scenario here as this code is never
624
# called in that case. -- vila 20100322
627
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
629
if rev_id in whitelist:
630
pmap = self.repository.get_parent_map([rev_id])
631
parents = pmap.get(rev_id, [])
632
whitelist.remove(rev_id)
633
whitelist.update(parents)
635
# We've reached the mainline, there is nothing left to
639
# A revision that is not part of the ancestry of our
642
yield (rev_id, merge_depth, revno, end_of_merge)
644
def leave_lock_in_place(self):
645
"""Tell this branch object not to release the physical lock when this
648
If lock_write doesn't return a token, then this method is not supported.
650
self.control_files.leave_in_place()
652
def dont_leave_lock_in_place(self):
653
"""Tell this branch object to release the physical lock when this
654
object is unlocked, even if it didn't originally acquire it.
656
If lock_write doesn't return a token, then this method is not supported.
658
self.control_files.dont_leave_in_place()
660
def bind(self, other):
661
"""Bind the local branch the other branch.
663
:param other: The branch to bind to
666
raise errors.UpgradeRequired(self.user_url)
668
def get_append_revisions_only(self):
669
"""Whether it is only possible to append revisions to the history.
671
if not self._format.supports_set_append_revisions_only():
673
return self.get_config_stack().get('append_revisions_only')
675
def set_append_revisions_only(self, enabled):
676
if not self._format.supports_set_append_revisions_only():
677
raise errors.UpgradeRequired(self.user_url)
678
self.get_config_stack().set('append_revisions_only', enabled)
680
def set_reference_info(self, file_id, tree_path, branch_location):
681
"""Set the branch location to use for a tree reference."""
682
raise errors.UnsupportedOperation(self.set_reference_info, self)
684
def get_reference_info(self, file_id):
685
"""Get the tree_path and branch_location for a tree reference."""
686
raise errors.UnsupportedOperation(self.get_reference_info, self)
689
def fetch(self, from_branch, last_revision=None, limit=None):
690
"""Copy revisions from from_branch into this branch.
692
:param from_branch: Where to copy from.
693
:param last_revision: What revision to stop at (None for at the end
695
:param limit: Optional rough limit of revisions to fetch
698
return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
700
def get_bound_location(self):
701
"""Return the URL of the branch we are bound to.
703
Older format branches cannot bind, please be sure to use a metadir
708
def get_old_bound_location(self):
709
"""Return the URL of the branch we used to be bound to
711
raise errors.UpgradeRequired(self.user_url)
713
def get_commit_builder(self, parents, config_stack=None, timestamp=None,
714
timezone=None, committer=None, revprops=None,
715
revision_id=None, lossy=False):
716
"""Obtain a CommitBuilder for this branch.
718
:param parents: Revision ids of the parents of the new revision.
719
:param config: Optional configuration to use.
720
:param timestamp: Optional timestamp recorded for commit.
721
:param timezone: Optional timezone for timestamp.
722
:param committer: Optional committer to set for commit.
723
:param revprops: Optional dictionary of revision properties.
724
:param revision_id: Optional revision id.
725
:param lossy: Whether to discard data that can not be natively
726
represented, when pushing to a foreign VCS
729
if config_stack is None:
730
config_stack = self.get_config_stack()
732
return self.repository.get_commit_builder(self, parents, config_stack,
733
timestamp, timezone, committer, revprops, revision_id,
736
def get_master_branch(self, possible_transports=None):
737
"""Return the branch we are bound to.
739
:return: Either a Branch, or None
743
@deprecated_method(deprecated_in((2, 5, 0)))
744
def get_revision_delta(self, revno):
745
"""Return the delta for one revision.
747
The delta is relative to its mainline predecessor, or the
748
empty tree for revision 1.
751
revid = self.get_rev_id(revno)
752
except errors.NoSuchRevision:
753
raise errors.InvalidRevisionNumber(revno)
754
return self.repository.get_revision_delta(revid)
756
def get_stacked_on_url(self):
757
"""Get the URL this branch is stacked against.
759
:raises NotStacked: If the branch is not stacked.
760
:raises UnstackableBranchFormat: If the branch does not support
763
raise NotImplementedError(self.get_stacked_on_url)
765
def print_file(self, file, revision_id):
766
"""Print `file` to stdout."""
767
raise NotImplementedError(self.print_file)
770
def set_last_revision_info(self, revno, revision_id):
771
"""Set the last revision of this branch.
773
The caller is responsible for checking that the revno is correct
774
for this revision id.
776
It may be possible to set the branch last revision to an id not
777
present in the repository. However, branches can also be
778
configured to check constraints on history, in which case this may not
781
raise NotImplementedError(self.set_last_revision_info)
784
def generate_revision_history(self, revision_id, last_rev=None,
786
"""See Branch.generate_revision_history"""
787
graph = self.repository.get_graph()
788
(last_revno, last_revid) = self.last_revision_info()
789
known_revision_ids = [
790
(last_revid, last_revno),
791
(_mod_revision.NULL_REVISION, 0),
793
if last_rev is not None:
794
if not graph.is_ancestor(last_rev, revision_id):
795
# our previous tip is not merged into stop_revision
796
raise errors.DivergedBranches(self, other_branch)
797
revno = graph.find_distance_to_null(revision_id, known_revision_ids)
798
self.set_last_revision_info(revno, revision_id)
801
def set_parent(self, url):
802
"""See Branch.set_parent."""
803
# TODO: Maybe delete old location files?
804
# URLs should never be unicode, even on the local fs,
805
# FIXUP this and get_parent in a future branch format bump:
806
# read and rewrite the file. RBC 20060125
808
if isinstance(url, unicode):
810
url = url.encode('ascii')
811
except UnicodeEncodeError:
812
raise errors.InvalidURL(url,
813
"Urls must be 7-bit ascii, "
814
"use bzrlib.urlutils.escape")
815
url = urlutils.relative_url(self.base, url)
816
self._set_parent_location(url)
819
def set_stacked_on_url(self, url):
820
"""Set the URL this branch is stacked against.
822
:raises UnstackableBranchFormat: If the branch does not support
824
:raises UnstackableRepositoryFormat: If the repository does not support
827
if not self._format.supports_stacking():
828
raise errors.UnstackableBranchFormat(self._format, self.user_url)
829
# XXX: Changing from one fallback repository to another does not check
830
# that all the data you need is present in the new fallback.
831
# Possibly it should.
832
self._check_stackable_repo()
835
old_url = self.get_stacked_on_url()
836
except (errors.NotStacked, errors.UnstackableBranchFormat,
837
errors.UnstackableRepositoryFormat):
841
self._activate_fallback_location(url,
842
possible_transports=[self.bzrdir.root_transport])
843
# write this out after the repository is stacked to avoid setting a
844
# stacked config that doesn't work.
845
self._set_config_location('stacked_on_location', url)
848
"""Change a branch to be unstacked, copying data as needed.
850
Don't call this directly, use set_stacked_on_url(None).
852
pb = ui.ui_factory.nested_progress_bar()
854
pb.update(gettext("Unstacking"))
855
# The basic approach here is to fetch the tip of the branch,
856
# including all available ghosts, from the existing stacked
857
# repository into a new repository object without the fallbacks.
859
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
860
# correct for CHKMap repostiories
861
old_repository = self.repository
862
if len(old_repository._fallback_repositories) != 1:
863
raise AssertionError("can't cope with fallback repositories "
864
"of %r (fallbacks: %r)" % (old_repository,
865
old_repository._fallback_repositories))
866
# Open the new repository object.
867
# Repositories don't offer an interface to remove fallback
868
# repositories today; take the conceptually simpler option and just
869
# reopen it. We reopen it starting from the URL so that we
870
# get a separate connection for RemoteRepositories and can
871
# stream from one of them to the other. This does mean doing
872
# separate SSH connection setup, but unstacking is not a
873
# common operation so it's tolerable.
874
new_bzrdir = controldir.ControlDir.open(
875
self.bzrdir.root_transport.base)
876
new_repository = new_bzrdir.find_repository()
877
if new_repository._fallback_repositories:
878
raise AssertionError("didn't expect %r to have "
879
"fallback_repositories"
880
% (self.repository,))
881
# Replace self.repository with the new repository.
882
# Do our best to transfer the lock state (i.e. lock-tokens and
883
# lock count) of self.repository to the new repository.
884
lock_token = old_repository.lock_write().repository_token
885
self.repository = new_repository
886
if isinstance(self, remote.RemoteBranch):
887
# Remote branches can have a second reference to the old
888
# repository that need to be replaced.
889
if self._real_branch is not None:
890
self._real_branch.repository = new_repository
891
self.repository.lock_write(token=lock_token)
892
if lock_token is not None:
893
old_repository.leave_lock_in_place()
894
old_repository.unlock()
895
if lock_token is not None:
896
# XXX: self.repository.leave_lock_in_place() before this
897
# function will not be preserved. Fortunately that doesn't
898
# affect the current default format (2a), and would be a
899
# corner-case anyway.
900
# - Andrew Bennetts, 2010/06/30
901
self.repository.dont_leave_lock_in_place()
905
old_repository.unlock()
906
except errors.LockNotHeld:
909
if old_lock_count == 0:
910
raise AssertionError(
911
'old_repository should have been locked at least once.')
912
for i in range(old_lock_count-1):
913
self.repository.lock_write()
914
# Fetch from the old repository into the new.
915
old_repository.lock_read()
917
# XXX: If you unstack a branch while it has a working tree
918
# with a pending merge, the pending-merged revisions will no
919
# longer be present. You can (probably) revert and remerge.
921
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
922
except errors.TagsNotSupported:
923
tags_to_fetch = set()
924
fetch_spec = vf_search.NotInOtherForRevs(self.repository,
925
old_repository, required_ids=[self.last_revision()],
926
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
927
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
929
old_repository.unlock()
933
def _set_tags_bytes(self, bytes):
934
"""Mirror method for _get_tags_bytes.
936
:seealso: Branch._get_tags_bytes.
938
op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
939
op.add_cleanup(self.lock_write().unlock)
940
return op.run_simple(bytes)
942
def _set_tags_bytes_locked(self, bytes):
943
self._tags_bytes = bytes
944
return self._transport.put_bytes('tags', bytes)
946
def _cache_revision_history(self, rev_history):
947
"""Set the cached revision history to rev_history.
949
The revision_history method will use this cache to avoid regenerating
950
the revision history.
952
This API is semi-public; it only for use by subclasses, all other code
953
should consider it to be private.
955
self._revision_history_cache = rev_history
957
def _cache_revision_id_to_revno(self, revision_id_to_revno):
958
"""Set the cached revision_id => revno map to revision_id_to_revno.
960
This API is semi-public; it only for use by subclasses, all other code
961
should consider it to be private.
963
self._revision_id_to_revno_cache = revision_id_to_revno
965
def _clear_cached_state(self):
966
"""Clear any cached data on this branch, e.g. cached revision history.
968
This means the next call to revision_history will need to call
969
_gen_revision_history.
971
This API is semi-public; it is only for use by subclasses, all other
972
code should consider it to be private.
974
self._revision_history_cache = None
975
self._revision_id_to_revno_cache = None
976
self._last_revision_info_cache = None
977
self._master_branch_cache = None
978
self._merge_sorted_revisions_cache = None
979
self._partial_revision_history_cache = []
980
self._partial_revision_id_to_revno_cache = {}
981
self._tags_bytes = None
983
def _gen_revision_history(self):
984
"""Return sequence of revision hashes on to this branch.
986
Unlike revision_history, this method always regenerates or rereads the
987
revision history, i.e. it does not cache the result, so repeated calls
990
Concrete subclasses should override this instead of revision_history so
991
that subclasses do not need to deal with caching logic.
993
This API is semi-public; it only for use by subclasses, all other code
994
should consider it to be private.
996
raise NotImplementedError(self._gen_revision_history)
998
def _revision_history(self):
999
if 'evil' in debug.debug_flags:
1000
mutter_callsite(3, "revision_history scales with history.")
1001
if self._revision_history_cache is not None:
1002
history = self._revision_history_cache
1004
history = self._gen_revision_history()
1005
self._cache_revision_history(history)
1006
return list(history)
1009
"""Return current revision number for this branch.
1011
That is equivalent to the number of revisions committed to
1014
return self.last_revision_info()[0]
1017
"""Older format branches cannot bind or unbind."""
1018
raise errors.UpgradeRequired(self.user_url)
1020
def last_revision(self):
1021
"""Return last revision id, or NULL_REVISION."""
1022
return self.last_revision_info()[1]
1025
def last_revision_info(self):
1026
"""Return information about the last revision.
1028
:return: A tuple (revno, revision_id).
1030
if self._last_revision_info_cache is None:
1031
self._last_revision_info_cache = self._read_last_revision_info()
1032
return self._last_revision_info_cache
1034
def _read_last_revision_info(self):
1035
raise NotImplementedError(self._read_last_revision_info)
1037
def import_last_revision_info_and_tags(self, source, revno, revid,
1039
"""Set the last revision info, importing from another repo if necessary.
1041
This is used by the bound branch code to upload a revision to
1042
the master branch first before updating the tip of the local branch.
1043
Revisions referenced by source's tags are also transferred.
1045
:param source: Source branch to optionally fetch from
1046
:param revno: Revision number of the new tip
1047
:param revid: Revision id of the new tip
1048
:param lossy: Whether to discard metadata that can not be
1049
natively represented
1050
:return: Tuple with the new revision number and revision id
1051
(should only be different from the arguments when lossy=True)
1053
if not self.repository.has_same_location(source.repository):
1054
self.fetch(source, revid)
1055
self.set_last_revision_info(revno, revid)
1056
return (revno, revid)
1058
def revision_id_to_revno(self, revision_id):
1059
"""Given a revision id, return its revno"""
1060
if _mod_revision.is_null(revision_id):
1062
history = self._revision_history()
1064
return history.index(revision_id) + 1
1066
raise errors.NoSuchRevision(self, revision_id)
1069
def get_rev_id(self, revno, history=None):
1070
"""Find the revision id of the specified revno."""
1072
return _mod_revision.NULL_REVISION
1073
last_revno, last_revid = self.last_revision_info()
1074
if revno == last_revno:
1076
if revno <= 0 or revno > last_revno:
1077
raise errors.NoSuchRevision(self, revno)
1078
distance_from_last = last_revno - revno
1079
if len(self._partial_revision_history_cache) <= distance_from_last:
1080
self._extend_partial_history(distance_from_last)
1081
return self._partial_revision_history_cache[distance_from_last]
1083
def pull(self, source, overwrite=False, stop_revision=None,
1084
possible_transports=None, *args, **kwargs):
1085
"""Mirror source into this branch.
1087
This branch is considered to be 'local', having low latency.
1089
:returns: PullResult instance
1091
return InterBranch.get(source, self).pull(overwrite=overwrite,
1092
stop_revision=stop_revision,
1093
possible_transports=possible_transports, *args, **kwargs)
1095
def push(self, target, overwrite=False, stop_revision=None, lossy=False,
1097
"""Mirror this branch into target.
1099
This branch is considered to be 'local', having low latency.
1101
return InterBranch.get(self, target).push(overwrite, stop_revision,
1102
lossy, *args, **kwargs)
1104
def basis_tree(self):
1105
"""Return `Tree` object for last revision."""
1106
return self.repository.revision_tree(self.last_revision())
1108
def get_parent(self):
1109
"""Return the parent location of the branch.
1111
This is the default location for pull/missing. The usual
1112
pattern is that the user can override it by specifying a
1115
parent = self._get_parent_location()
1118
# This is an old-format absolute path to a local branch
1119
# turn it into a url
1120
if parent.startswith('/'):
1121
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1123
return urlutils.join(self.base[:-1], parent)
1124
except errors.InvalidURLJoin, e:
1125
raise errors.InaccessibleParent(parent, self.user_url)
1127
def _get_parent_location(self):
1128
raise NotImplementedError(self._get_parent_location)
1130
def _set_config_location(self, name, url, config=None,
1131
make_relative=False):
1133
config = self.get_config_stack()
1137
url = urlutils.relative_url(self.base, url)
1138
config.set(name, url)
1140
def _get_config_location(self, name, config=None):
1142
config = self.get_config_stack()
1143
location = config.get(name)
1148
def get_child_submit_format(self):
1149
"""Return the preferred format of submissions to this branch."""
1150
return self.get_config_stack().get('child_submit_format')
1152
def get_submit_branch(self):
1153
"""Return the submit location of the branch.
1155
This is the default location for bundle. The usual
1156
pattern is that the user can override it by specifying a
1159
return self.get_config_stack().get('submit_branch')
1161
def set_submit_branch(self, location):
1162
"""Return the submit location of the branch.
1164
This is the default location for bundle. The usual
1165
pattern is that the user can override it by specifying a
1168
self.get_config_stack().set('submit_branch', location)
1170
def get_public_branch(self):
1171
"""Return the public location of the branch.
1173
This is used by merge directives.
1175
return self._get_config_location('public_branch')
1177
def set_public_branch(self, location):
1178
"""Return the submit location of the branch.
1180
This is the default location for bundle. The usual
1181
pattern is that the user can override it by specifying a
1184
self._set_config_location('public_branch', location)
1186
def get_push_location(self):
1187
"""Return None or the location to push this branch to."""
1188
return self.get_config_stack().get('push_location')
1190
def set_push_location(self, location):
1191
"""Set a new push location for this branch."""
1192
raise NotImplementedError(self.set_push_location)
1194
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1195
"""Run the post_change_branch_tip hooks."""
1196
hooks = Branch.hooks['post_change_branch_tip']
1199
new_revno, new_revid = self.last_revision_info()
1200
params = ChangeBranchTipParams(
1201
self, old_revno, new_revno, old_revid, new_revid)
1205
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1206
"""Run the pre_change_branch_tip hooks."""
1207
hooks = Branch.hooks['pre_change_branch_tip']
1210
old_revno, old_revid = self.last_revision_info()
1211
params = ChangeBranchTipParams(
1212
self, old_revno, new_revno, old_revid, new_revid)
1218
"""Synchronise this branch with the master branch if any.
1220
:return: None or the last_revision pivoted out during the update.
1224
def check_revno(self, revno):
1226
Check whether a revno corresponds to any revision.
1227
Zero (the NULL revision) is considered valid.
1230
self.check_real_revno(revno)
1232
def check_real_revno(self, revno):
1234
Check whether a revno corresponds to a real revision.
1235
Zero (the NULL revision) is considered invalid
1237
if revno < 1 or revno > self.revno():
1238
raise errors.InvalidRevisionNumber(revno)
1241
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1242
"""Clone this branch into to_bzrdir preserving all semantic values.
1244
Most API users will want 'create_clone_on_transport', which creates a
1245
new bzrdir and branch on the fly.
1247
revision_id: if not None, the revision history in the new branch will
1248
be truncated to end with revision_id.
1250
result = to_bzrdir.create_branch()
1253
if repository_policy is not None:
1254
repository_policy.configure_branch(result)
1255
self.copy_content_into(result, revision_id=revision_id)
1261
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
1263
"""Create a new line of development from the branch, into to_bzrdir.
1265
to_bzrdir controls the branch format.
1267
revision_id: if not None, the revision history in the new branch will
1268
be truncated to end with revision_id.
1270
if (repository_policy is not None and
1271
repository_policy.requires_stacking()):
1272
to_bzrdir._format.require_stacking(_skip_repo=True)
1273
result = to_bzrdir.create_branch(repository=repository)
1276
if repository_policy is not None:
1277
repository_policy.configure_branch(result)
1278
self.copy_content_into(result, revision_id=revision_id)
1279
master_url = self.get_bound_location()
1280
if master_url is None:
1281
result.set_parent(self.bzrdir.root_transport.base)
1283
result.set_parent(master_url)
1288
def _synchronize_history(self, destination, revision_id):
1289
"""Synchronize last revision and revision history between branches.
1291
This version is most efficient when the destination is also a
1292
BzrBranch6, but works for BzrBranch5, as long as the destination's
1293
repository contains all the lefthand ancestors of the intended
1294
last_revision. If not, set_last_revision_info will fail.
1296
:param destination: The branch to copy the history into
1297
:param revision_id: The revision-id to truncate history at. May
1298
be None to copy complete history.
1300
source_revno, source_revision_id = self.last_revision_info()
1301
if revision_id is None:
1302
revno, revision_id = source_revno, source_revision_id
1304
graph = self.repository.get_graph()
1306
revno = graph.find_distance_to_null(revision_id,
1307
[(source_revision_id, source_revno)])
1308
except errors.GhostRevisionsHaveNoRevno:
1309
# Default to 1, if we can't find anything else
1311
destination.set_last_revision_info(revno, revision_id)
1313
def copy_content_into(self, destination, revision_id=None):
1314
"""Copy the content of self into destination.
1316
revision_id: if not None, the revision history in the new branch will
1317
be truncated to end with revision_id.
1319
return InterBranch.get(self, destination).copy_content_into(
1320
revision_id=revision_id)
1322
def update_references(self, target):
1323
if not getattr(self._format, 'supports_reference_locations', False):
1325
reference_dict = self._get_all_reference_info()
1326
if len(reference_dict) == 0:
1328
old_base = self.base
1329
new_base = target.base
1330
target_reference_dict = target._get_all_reference_info()
1331
for file_id, (tree_path, branch_location) in (
1332
reference_dict.items()):
1333
branch_location = urlutils.rebase_url(branch_location,
1335
target_reference_dict.setdefault(
1336
file_id, (tree_path, branch_location))
1337
target._set_all_reference_info(target_reference_dict)
1340
def check(self, refs):
1341
"""Check consistency of the branch.
1343
In particular this checks that revisions given in the revision-history
1344
do actually match up in the revision graph, and that they're all
1345
present in the repository.
1347
Callers will typically also want to check the repository.
1349
:param refs: Calculated refs for this branch as specified by
1350
branch._get_check_refs()
1351
:return: A BranchCheckResult.
1353
result = BranchCheckResult(self)
1354
last_revno, last_revision_id = self.last_revision_info()
1355
actual_revno = refs[('lefthand-distance', last_revision_id)]
1356
if actual_revno != last_revno:
1357
result.errors.append(errors.BzrCheckError(
1358
'revno does not match len(mainline) %s != %s' % (
1359
last_revno, actual_revno)))
1360
# TODO: We should probably also check that self.revision_history
1361
# matches the repository for older branch formats.
1362
# If looking for the code that cross-checks repository parents against
1363
# the Graph.iter_lefthand_ancestry output, that is now a repository
1367
def _get_checkout_format(self, lightweight=False):
1368
"""Return the most suitable metadir for a checkout of this branch.
1369
Weaves are used if this branch's repository uses weaves.
1371
format = self.repository.bzrdir.checkout_metadir()
1372
format.set_branch_format(self._format)
1375
def create_clone_on_transport(self, to_transport, revision_id=None,
1376
stacked_on=None, create_prefix=False, use_existing_dir=False,
1378
"""Create a clone of this branch and its bzrdir.
1380
:param to_transport: The transport to clone onto.
1381
:param revision_id: The revision id to use as tip in the new branch.
1382
If None the tip is obtained from this branch.
1383
:param stacked_on: An optional URL to stack the clone on.
1384
:param create_prefix: Create any missing directories leading up to
1386
:param use_existing_dir: Use an existing directory if one exists.
1388
# XXX: Fix the bzrdir API to allow getting the branch back from the
1389
# clone call. Or something. 20090224 RBC/spiv.
1390
# XXX: Should this perhaps clone colocated branches as well,
1391
# rather than just the default branch? 20100319 JRV
1392
if revision_id is None:
1393
revision_id = self.last_revision()
1394
dir_to = self.bzrdir.clone_on_transport(to_transport,
1395
revision_id=revision_id, stacked_on=stacked_on,
1396
create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1398
return dir_to.open_branch()
1400
def create_checkout(self, to_location, revision_id=None,
1401
lightweight=False, accelerator_tree=None,
1403
"""Create a checkout of a branch.
1405
:param to_location: The url to produce the checkout at
1406
:param revision_id: The revision to check out
1407
:param lightweight: If True, produce a lightweight checkout, otherwise,
1408
produce a bound branch (heavyweight checkout)
1409
:param accelerator_tree: A tree which can be used for retrieving file
1410
contents more quickly than the revision tree, i.e. a workingtree.
1411
The revision tree will be used for cases where accelerator_tree's
1412
content is different.
1413
:param hardlink: If true, hard-link files from accelerator_tree,
1415
:return: The tree of the created checkout
1417
t = transport.get_transport(to_location)
1419
format = self._get_checkout_format(lightweight=lightweight)
1421
checkout = format.initialize_on_transport(t)
1422
except errors.AlreadyControlDirError:
1423
# It's fine if the control directory already exists,
1424
# as long as there is no existing branch and working tree.
1425
checkout = controldir.ControlDir.open_from_transport(t)
1427
checkout.open_branch()
1428
except errors.NotBranchError:
1431
raise errors.AlreadyControlDirError(t.base)
1432
if checkout.control_transport.base == self.bzrdir.control_transport.base:
1433
# When checking out to the same control directory,
1434
# always create a lightweight checkout
1438
from_branch = checkout.set_branch_reference(target_branch=self)
1440
policy = checkout.determine_repository_policy()
1441
repo = policy.acquire_repository()[0]
1442
checkout_branch = checkout.create_branch()
1443
checkout_branch.bind(self)
1444
# pull up to the specified revision_id to set the initial
1445
# branch tip correctly, and seed it with history.
1446
checkout_branch.pull(self, stop_revision=revision_id)
1448
tree = checkout.create_workingtree(revision_id,
1449
from_branch=from_branch,
1450
accelerator_tree=accelerator_tree,
1452
basis_tree = tree.basis_tree()
1453
basis_tree.lock_read()
1455
for path, file_id in basis_tree.iter_references():
1456
reference_parent = self.reference_parent(file_id, path)
1457
reference_parent.create_checkout(tree.abspath(path),
1458
basis_tree.get_reference_revision(file_id, path),
1465
def reconcile(self, thorough=True):
1466
"""Make sure the data stored in this branch is consistent."""
1467
from bzrlib.reconcile import BranchReconciler
1468
reconciler = BranchReconciler(self, thorough=thorough)
1469
reconciler.reconcile()
1472
def reference_parent(self, file_id, path, possible_transports=None):
1473
"""Return the parent branch for a tree-reference file_id
1475
:param file_id: The file_id of the tree reference
1476
:param path: The path of the file_id in the tree
1477
:return: A branch associated with the file_id
1479
# FIXME should provide multiple branches, based on config
1480
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1481
possible_transports=possible_transports)
1483
def supports_tags(self):
1484
return self._format.supports_tags()
1486
def automatic_tag_name(self, revision_id):
1487
"""Try to automatically find the tag name for a revision.
1489
:param revision_id: Revision id of the revision.
1490
:return: A tag name or None if no tag name could be determined.
1492
for hook in Branch.hooks['automatic_tag_name']:
1493
ret = hook(self, revision_id)
1498
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1500
"""Ensure that revision_b is a descendant of revision_a.
1502
This is a helper function for update_revisions.
1504
:raises: DivergedBranches if revision_b has diverged from revision_a.
1505
:returns: True if revision_b is a descendant of revision_a.
1507
relation = self._revision_relations(revision_a, revision_b, graph)
1508
if relation == 'b_descends_from_a':
1510
elif relation == 'diverged':
1511
raise errors.DivergedBranches(self, other_branch)
1512
elif relation == 'a_descends_from_b':
1515
raise AssertionError("invalid relation: %r" % (relation,))
1517
def _revision_relations(self, revision_a, revision_b, graph):
1518
"""Determine the relationship between two revisions.
1520
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1522
heads = graph.heads([revision_a, revision_b])
1523
if heads == set([revision_b]):
1524
return 'b_descends_from_a'
1525
elif heads == set([revision_a, revision_b]):
1526
# These branches have diverged
1528
elif heads == set([revision_a]):
1529
return 'a_descends_from_b'
1531
raise AssertionError("invalid heads: %r" % (heads,))
1533
def heads_to_fetch(self):
1534
"""Return the heads that must and that should be fetched to copy this
1535
branch into another repo.
1537
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1538
set of heads that must be fetched. if_present_fetch is a set of
1539
heads that must be fetched if present, but no error is necessary if
1540
they are not present.
1542
# For bzr native formats must_fetch is just the tip, and
1543
# if_present_fetch are the tags.
1544
must_fetch = set([self.last_revision()])
1545
if_present_fetch = set()
1546
if self.get_config_stack().get('branch.fetch_tags'):
1548
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1549
except errors.TagsNotSupported:
1551
must_fetch.discard(_mod_revision.NULL_REVISION)
1552
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1553
return must_fetch, if_present_fetch
1556
class BranchFormat(controldir.ControlComponentFormat):
1557
"""An encapsulation of the initialization and open routines for a format.
1559
Formats provide three things:
1560
* An initialization routine,
1561
* a format description
1564
Formats are placed in an dict by their format string for reference
1565
during branch opening. It's not required that these be instances, they
1566
can be classes themselves with class methods - it simply depends on
1567
whether state is needed for a given format or not.
1569
Once a format is deprecated, just deprecate the initialize and open
1570
methods on the format class. Do not deprecate the object, as the
1571
object will be created every time regardless.
1574
def __eq__(self, other):
1575
return self.__class__ is other.__class__
1577
def __ne__(self, other):
1578
return not (self == other)
1580
def get_reference(self, controldir, name=None):
1581
"""Get the target reference of the branch in controldir.
1583
format probing must have been completed before calling
1584
this method - it is assumed that the format of the branch
1585
in controldir is correct.
1587
:param controldir: The controldir to get the branch data from.
1588
:param name: Name of the colocated branch to fetch
1589
:return: None if the branch is not a reference branch.
1594
def set_reference(self, controldir, name, to_branch):
1595
"""Set the target reference of the branch in controldir.
1597
format probing must have been completed before calling
1598
this method - it is assumed that the format of the branch
1599
in controldir is correct.
1601
:param controldir: The controldir to set the branch reference for.
1602
:param name: Name of colocated branch to set, None for default
1603
:param to_branch: branch that the checkout is to reference
1605
raise NotImplementedError(self.set_reference)
1607
def get_format_description(self):
1608
"""Return the short format description for this format."""
1609
raise NotImplementedError(self.get_format_description)
1611
def _run_post_branch_init_hooks(self, controldir, name, branch):
1612
hooks = Branch.hooks['post_branch_init']
1615
params = BranchInitHookParams(self, controldir, name, branch)
1619
def initialize(self, controldir, name=None, repository=None,
1620
append_revisions_only=None):
1621
"""Create a branch of this format in controldir.
1623
:param name: Name of the colocated branch to create.
1625
raise NotImplementedError(self.initialize)
1627
def is_supported(self):
1628
"""Is this format supported?
1630
Supported formats can be initialized and opened.
1631
Unsupported formats may not support initialization or committing or
1632
some other features depending on the reason for not being supported.
1636
def make_tags(self, branch):
1637
"""Create a tags object for branch.
1639
This method is on BranchFormat, because BranchFormats are reflected
1640
over the wire via network_name(), whereas full Branch instances require
1641
multiple VFS method calls to operate at all.
1643
The default implementation returns a disabled-tags instance.
1645
Note that it is normal for branch to be a RemoteBranch when using tags
1648
return _mod_tag.DisabledTags(branch)
1650
def network_name(self):
1651
"""A simple byte string uniquely identifying this format for RPC calls.
1653
MetaDir branch formats use their disk format string to identify the
1654
repository over the wire. All in one formats such as bzr < 0.8, and
1655
foreign formats like svn/git and hg should use some marker which is
1656
unique and immutable.
1658
raise NotImplementedError(self.network_name)
1660
def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
1661
found_repository=None, possible_transports=None):
1662
"""Return the branch object for controldir.
1664
:param controldir: A ControlDir that contains a branch.
1665
:param name: Name of colocated branch to open
1666
:param _found: a private parameter, do not use it. It is used to
1667
indicate if format probing has already be done.
1668
:param ignore_fallbacks: when set, no fallback branches will be opened
1669
(if there are any). Default is to open fallbacks.
1671
raise NotImplementedError(self.open)
1673
def supports_set_append_revisions_only(self):
1674
"""True if this format supports set_append_revisions_only."""
1677
def supports_stacking(self):
1678
"""True if this format records a stacked-on branch."""
1681
def supports_leaving_lock(self):
1682
"""True if this format supports leaving locks in place."""
1683
return False # by default
1686
return self.get_format_description().rstrip()
1688
def supports_tags(self):
1689
"""True if this format supports tags stored in the branch"""
1690
return False # by default
1692
def tags_are_versioned(self):
1693
"""Whether the tag container for this branch versions tags."""
1696
def supports_tags_referencing_ghosts(self):
1697
"""True if tags can reference ghost revisions."""
1701
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1702
"""A factory for a BranchFormat object, permitting simple lazy registration.
1704
While none of the built in BranchFormats are lazy registered yet,
1705
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1706
use it, and the bzr-loom plugin uses it as well (see
1707
bzrlib.plugins.loom.formats).
1710
def __init__(self, format_string, module_name, member_name):
1711
"""Create a MetaDirBranchFormatFactory.
1713
:param format_string: The format string the format has.
1714
:param module_name: Module to load the format class from.
1715
:param member_name: Attribute name within the module for the format class.
1717
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1718
self._format_string = format_string
1720
def get_format_string(self):
1721
"""See BranchFormat.get_format_string."""
1722
return self._format_string
1725
"""Used for network_format_registry support."""
1726
return self.get_obj()()
1729
class BranchHooks(Hooks):
1730
"""A dictionary mapping hook name to a list of callables for branch hooks.
1732
e.g. ['post_push'] Is the list of items to be called when the
1733
push function is invoked.
1737
"""Create the default hooks.
1739
These are all empty initially, because by default nothing should get
1742
Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1743
self.add_hook('open',
1744
"Called with the Branch object that has been opened after a "
1745
"branch is opened.", (1, 8))
1746
self.add_hook('post_push',
1747
"Called after a push operation completes. post_push is called "
1748
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1749
"bzr client.", (0, 15))
1750
self.add_hook('post_pull',
1751
"Called after a pull operation completes. post_pull is called "
1752
"with a bzrlib.branch.PullResult object and only runs in the "
1753
"bzr client.", (0, 15))
1754
self.add_hook('pre_commit',
1755
"Called after a commit is calculated but before it is "
1756
"completed. pre_commit is called with (local, master, old_revno, "
1757
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1758
"). old_revid is NULL_REVISION for the first commit to a branch, "
1759
"tree_delta is a TreeDelta object describing changes from the "
1760
"basis revision. hooks MUST NOT modify this delta. "
1761
" future_tree is an in-memory tree obtained from "
1762
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1764
self.add_hook('post_commit',
1765
"Called in the bzr client after a commit has completed. "
1766
"post_commit is called with (local, master, old_revno, old_revid, "
1767
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1768
"commit to a branch.", (0, 15))
1769
self.add_hook('post_uncommit',
1770
"Called in the bzr client after an uncommit completes. "
1771
"post_uncommit is called with (local, master, old_revno, "
1772
"old_revid, new_revno, new_revid) where local is the local branch "
1773
"or None, master is the target branch, and an empty branch "
1774
"receives new_revno of 0, new_revid of None.", (0, 15))
1775
self.add_hook('pre_change_branch_tip',
1776
"Called in bzr client and server before a change to the tip of a "
1777
"branch is made. pre_change_branch_tip is called with a "
1778
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1779
"commit, uncommit will all trigger this hook.", (1, 6))
1780
self.add_hook('post_change_branch_tip',
1781
"Called in bzr client and server after a change to the tip of a "
1782
"branch is made. post_change_branch_tip is called with a "
1783
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1784
"commit, uncommit will all trigger this hook.", (1, 4))
1785
self.add_hook('transform_fallback_location',
1786
"Called when a stacked branch is activating its fallback "
1787
"locations. transform_fallback_location is called with (branch, "
1788
"url), and should return a new url. Returning the same url "
1789
"allows it to be used as-is, returning a different one can be "
1790
"used to cause the branch to stack on a closer copy of that "
1791
"fallback_location. Note that the branch cannot have history "
1792
"accessing methods called on it during this hook because the "
1793
"fallback locations have not been activated. When there are "
1794
"multiple hooks installed for transform_fallback_location, "
1795
"all are called with the url returned from the previous hook."
1796
"The order is however undefined.", (1, 9))
1797
self.add_hook('automatic_tag_name',
1798
"Called to determine an automatic tag name for a revision. "
1799
"automatic_tag_name is called with (branch, revision_id) and "
1800
"should return a tag name or None if no tag name could be "
1801
"determined. The first non-None tag name returned will be used.",
1803
self.add_hook('post_branch_init',
1804
"Called after new branch initialization completes. "
1805
"post_branch_init is called with a "
1806
"bzrlib.branch.BranchInitHookParams. "
1807
"Note that init, branch and checkout (both heavyweight and "
1808
"lightweight) will all trigger this hook.", (2, 2))
1809
self.add_hook('post_switch',
1810
"Called after a checkout switches branch. "
1811
"post_switch is called with a "
1812
"bzrlib.branch.SwitchHookParams.", (2, 2))
1816
# install the default hooks into the Branch class.
1817
Branch.hooks = BranchHooks()
1820
class ChangeBranchTipParams(object):
1821
"""Object holding parameters passed to `*_change_branch_tip` hooks.
1823
There are 5 fields that hooks may wish to access:
1825
:ivar branch: the branch being changed
1826
:ivar old_revno: revision number before the change
1827
:ivar new_revno: revision number after the change
1828
:ivar old_revid: revision id before the change
1829
:ivar new_revid: revision id after the change
1831
The revid fields are strings. The revno fields are integers.
1834
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1835
"""Create a group of ChangeBranchTip parameters.
1837
:param branch: The branch being changed.
1838
:param old_revno: Revision number before the change.
1839
:param new_revno: Revision number after the change.
1840
:param old_revid: Tip revision id before the change.
1841
:param new_revid: Tip revision id after the change.
1843
self.branch = branch
1844
self.old_revno = old_revno
1845
self.new_revno = new_revno
1846
self.old_revid = old_revid
1847
self.new_revid = new_revid
1849
def __eq__(self, other):
1850
return self.__dict__ == other.__dict__
1853
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1854
self.__class__.__name__, self.branch,
1855
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1858
class BranchInitHookParams(object):
1859
"""Object holding parameters passed to `*_branch_init` hooks.
1861
There are 4 fields that hooks may wish to access:
1863
:ivar format: the branch format
1864
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1865
:ivar name: name of colocated branch, if any (or None)
1866
:ivar branch: the branch created
1868
Note that for lightweight checkouts, the bzrdir and format fields refer to
1869
the checkout, hence they are different from the corresponding fields in
1870
branch, which refer to the original branch.
1873
def __init__(self, format, controldir, name, branch):
1874
"""Create a group of BranchInitHook parameters.
1876
:param format: the branch format
1877
:param controldir: the ControlDir where the branch will be/has been
1879
:param name: name of colocated branch, if any (or None)
1880
:param branch: the branch created
1882
Note that for lightweight checkouts, the bzrdir and format fields refer
1883
to the checkout, hence they are different from the corresponding fields
1884
in branch, which refer to the original branch.
1886
self.format = format
1887
self.bzrdir = controldir
1889
self.branch = branch
1891
def __eq__(self, other):
1892
return self.__dict__ == other.__dict__
1895
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1898
class SwitchHookParams(object):
1899
"""Object holding parameters passed to `*_switch` hooks.
1901
There are 4 fields that hooks may wish to access:
1903
:ivar control_dir: ControlDir of the checkout to change
1904
:ivar to_branch: branch that the checkout is to reference
1905
:ivar force: skip the check for local commits in a heavy checkout
1906
:ivar revision_id: revision ID to switch to (or None)
1909
def __init__(self, control_dir, to_branch, force, revision_id):
1910
"""Create a group of SwitchHook parameters.
1912
:param control_dir: ControlDir of the checkout to change
1913
:param to_branch: branch that the checkout is to reference
1914
:param force: skip the check for local commits in a heavy checkout
1915
:param revision_id: revision ID to switch to (or None)
1917
self.control_dir = control_dir
1918
self.to_branch = to_branch
1920
self.revision_id = revision_id
1922
def __eq__(self, other):
1923
return self.__dict__ == other.__dict__
1926
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1927
self.control_dir, self.to_branch,
1931
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
1932
"""Base class for branch formats that live in meta directories.
1936
BranchFormat.__init__(self)
1937
bzrdir.BzrFormat.__init__(self)
1940
def find_format(klass, controldir, name=None):
1941
"""Return the format for the branch object in controldir."""
1943
transport = controldir.get_branch_transport(None, name=name)
1944
except errors.NoSuchFile:
1945
raise errors.NotBranchError(path=name, bzrdir=controldir)
1947
format_string = transport.get_bytes("format")
1948
except errors.NoSuchFile:
1949
raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
1950
return klass._find_format(format_registry, 'branch', format_string)
1952
def _branch_class(self):
1953
"""What class to instantiate on open calls."""
1954
raise NotImplementedError(self._branch_class)
1956
def _get_initial_config(self, append_revisions_only=None):
1957
if append_revisions_only:
1958
return "append_revisions_only = True\n"
1960
# Avoid writing anything if append_revisions_only is disabled,
1961
# as that is the default.
1964
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1966
"""Initialize a branch in a control dir, with specified files
1968
:param a_bzrdir: The bzrdir to initialize the branch in
1969
:param utf8_files: The files to create as a list of
1970
(filename, content) tuples
1971
:param name: Name of colocated branch to create, if any
1972
:return: a branch in this format
1975
name = a_bzrdir._get_selected_branch()
1976
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1977
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1978
control_files = lockable_files.LockableFiles(branch_transport,
1979
'lock', lockdir.LockDir)
1980
control_files.create_lock()
1981
control_files.lock_write()
1983
utf8_files += [('format', self.as_string())]
1984
for (filename, content) in utf8_files:
1985
branch_transport.put_bytes(
1987
mode=a_bzrdir._get_file_mode())
1989
control_files.unlock()
1990
branch = self.open(a_bzrdir, name, _found=True,
1991
found_repository=repository)
1992
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1995
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
1996
found_repository=None, possible_transports=None):
1997
"""See BranchFormat.open()."""
1999
name = a_bzrdir._get_selected_branch()
2001
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2002
if format.__class__ != self.__class__:
2003
raise AssertionError("wrong format %r found for %r" %
2005
transport = a_bzrdir.get_branch_transport(None, name=name)
2007
control_files = lockable_files.LockableFiles(transport, 'lock',
2009
if found_repository is None:
2010
found_repository = a_bzrdir.find_repository()
2011
return self._branch_class()(_format=self,
2012
_control_files=control_files,
2015
_repository=found_repository,
2016
ignore_fallbacks=ignore_fallbacks,
2017
possible_transports=possible_transports)
2018
except errors.NoSuchFile:
2019
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2022
def _matchingbzrdir(self):
2023
ret = bzrdir.BzrDirMetaFormat1()
2024
ret.set_branch_format(self)
2027
def supports_tags(self):
2030
def supports_leaving_lock(self):
2033
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
2035
BranchFormat.check_support_status(self,
2036
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
2038
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
2039
recommend_upgrade=recommend_upgrade, basedir=basedir)
2042
class BzrBranchFormat5(BranchFormatMetadir):
2043
"""Bzr branch format 5.
2046
- a revision-history file.
2048
- a lock dir guarding the branch itself
2049
- all of this stored in a branch/ subdirectory
2050
- works with shared repositories.
2052
This format is new in bzr 0.8.
2055
def _branch_class(self):
2059
def get_format_string(cls):
2060
"""See BranchFormat.get_format_string()."""
2061
return "Bazaar-NG branch format 5\n"
2063
def get_format_description(self):
2064
"""See BranchFormat.get_format_description()."""
2065
return "Branch format 5"
2067
def initialize(self, a_bzrdir, name=None, repository=None,
2068
append_revisions_only=None):
2069
"""Create a branch of this format in a_bzrdir."""
2070
if append_revisions_only:
2071
raise errors.UpgradeRequired(a_bzrdir.user_url)
2072
utf8_files = [('revision-history', ''),
2073
('branch-name', ''),
2075
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2077
def supports_tags(self):
2081
class BzrBranchFormat6(BranchFormatMetadir):
2082
"""Branch format with last-revision and tags.
2084
Unlike previous formats, this has no explicit revision history. Instead,
2085
this just stores the last-revision, and the left-hand history leading
2086
up to there is the history.
2088
This format was introduced in bzr 0.15
2089
and became the default in 0.91.
2092
def _branch_class(self):
2096
def get_format_string(cls):
2097
"""See BranchFormat.get_format_string()."""
2098
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2100
def get_format_description(self):
2101
"""See BranchFormat.get_format_description()."""
2102
return "Branch format 6"
2104
def initialize(self, a_bzrdir, name=None, repository=None,
2105
append_revisions_only=None):
2106
"""Create a branch of this format in a_bzrdir."""
2107
utf8_files = [('last-revision', '0 null:\n'),
2109
self._get_initial_config(append_revisions_only)),
2112
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2114
def make_tags(self, branch):
2115
"""See bzrlib.branch.BranchFormat.make_tags()."""
2116
return _mod_tag.BasicTags(branch)
2118
def supports_set_append_revisions_only(self):
2122
class BzrBranchFormat8(BranchFormatMetadir):
2123
"""Metadir format supporting storing locations of subtree branches."""
2125
def _branch_class(self):
2129
def get_format_string(cls):
2130
"""See BranchFormat.get_format_string()."""
2131
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2133
def get_format_description(self):
2134
"""See BranchFormat.get_format_description()."""
2135
return "Branch format 8"
2137
def initialize(self, a_bzrdir, name=None, repository=None,
2138
append_revisions_only=None):
2139
"""Create a branch of this format in a_bzrdir."""
2140
utf8_files = [('last-revision', '0 null:\n'),
2142
self._get_initial_config(append_revisions_only)),
2146
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2148
def make_tags(self, branch):
2149
"""See bzrlib.branch.BranchFormat.make_tags()."""
2150
return _mod_tag.BasicTags(branch)
2152
def supports_set_append_revisions_only(self):
2155
def supports_stacking(self):
2158
supports_reference_locations = True
2161
class BzrBranchFormat7(BranchFormatMetadir):
2162
"""Branch format with last-revision, tags, and a stacked location pointer.
2164
The stacked location pointer is passed down to the repository and requires
2165
a repository format with supports_external_lookups = True.
2167
This format was introduced in bzr 1.6.
2170
def initialize(self, a_bzrdir, name=None, repository=None,
2171
append_revisions_only=None):
2172
"""Create a branch of this format in a_bzrdir."""
2173
utf8_files = [('last-revision', '0 null:\n'),
2175
self._get_initial_config(append_revisions_only)),
2178
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2180
def _branch_class(self):
2184
def get_format_string(cls):
2185
"""See BranchFormat.get_format_string()."""
2186
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2188
def get_format_description(self):
2189
"""See BranchFormat.get_format_description()."""
2190
return "Branch format 7"
2192
def supports_set_append_revisions_only(self):
2195
def supports_stacking(self):
2198
def make_tags(self, branch):
2199
"""See bzrlib.branch.BranchFormat.make_tags()."""
2200
return _mod_tag.BasicTags(branch)
2202
supports_reference_locations = False
2205
class BranchReferenceFormat(BranchFormatMetadir):
2206
"""Bzr branch reference format.
2208
Branch references are used in implementing checkouts, they
2209
act as an alias to the real branch which is at some other url.
2217
def get_format_string(cls):
2218
"""See BranchFormat.get_format_string()."""
2219
return "Bazaar-NG Branch Reference Format 1\n"
2221
def get_format_description(self):
2222
"""See BranchFormat.get_format_description()."""
2223
return "Checkout reference format 1"
2225
def get_reference(self, a_bzrdir, name=None):
2226
"""See BranchFormat.get_reference()."""
2227
transport = a_bzrdir.get_branch_transport(None, name=name)
2228
return transport.get_bytes('location')
2230
def set_reference(self, a_bzrdir, name, to_branch):
2231
"""See BranchFormat.set_reference()."""
2232
transport = a_bzrdir.get_branch_transport(None, name=name)
2233
location = transport.put_bytes('location', to_branch.base)
2235
def initialize(self, a_bzrdir, name=None, target_branch=None,
2236
repository=None, append_revisions_only=None):
2237
"""Create a branch of this format in a_bzrdir."""
2238
if target_branch is None:
2239
# this format does not implement branch itself, thus the implicit
2240
# creation contract must see it as uninitializable
2241
raise errors.UninitializableFormat(self)
2242
mutter('creating branch reference in %s', a_bzrdir.user_url)
2243
if a_bzrdir._format.fixed_components:
2244
raise errors.IncompatibleFormat(self, a_bzrdir._format)
2246
name = a_bzrdir._get_selected_branch()
2247
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2248
branch_transport.put_bytes('location',
2249
target_branch.user_url)
2250
branch_transport.put_bytes('format', self.as_string())
2251
branch = self.open(a_bzrdir, name, _found=True,
2252
possible_transports=[target_branch.bzrdir.root_transport])
2253
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2256
def _make_reference_clone_function(format, a_branch):
2257
"""Create a clone() routine for a branch dynamically."""
2258
def clone(to_bzrdir, revision_id=None,
2259
repository_policy=None):
2260
"""See Branch.clone()."""
2261
return format.initialize(to_bzrdir, target_branch=a_branch)
2262
# cannot obey revision_id limits when cloning a reference ...
2263
# FIXME RBC 20060210 either nuke revision_id for clone, or
2264
# emit some sort of warning/error to the caller ?!
2267
def open(self, a_bzrdir, name=None, _found=False, location=None,
2268
possible_transports=None, ignore_fallbacks=False,
2269
found_repository=None):
2270
"""Return the branch that the branch reference in a_bzrdir points at.
2272
:param a_bzrdir: A BzrDir that contains a branch.
2273
:param name: Name of colocated branch to open, if any
2274
:param _found: a private parameter, do not use it. It is used to
2275
indicate if format probing has already be done.
2276
:param ignore_fallbacks: when set, no fallback branches will be opened
2277
(if there are any). Default is to open fallbacks.
2278
:param location: The location of the referenced branch. If
2279
unspecified, this will be determined from the branch reference in
2281
:param possible_transports: An optional reusable transports list.
2284
name = a_bzrdir._get_selected_branch()
2286
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2287
if format.__class__ != self.__class__:
2288
raise AssertionError("wrong format %r found for %r" %
2290
if location is None:
2291
location = self.get_reference(a_bzrdir, name)
2292
real_bzrdir = controldir.ControlDir.open(
2293
location, possible_transports=possible_transports)
2294
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks,
2295
possible_transports=possible_transports)
2296
# this changes the behaviour of result.clone to create a new reference
2297
# rather than a copy of the content of the branch.
2298
# I did not use a proxy object because that needs much more extensive
2299
# testing, and we are only changing one behaviour at the moment.
2300
# If we decide to alter more behaviours - i.e. the implicit nickname
2301
# then this should be refactored to introduce a tested proxy branch
2302
# and a subclass of that for use in overriding clone() and ....
2304
result.clone = self._make_reference_clone_function(result)
2308
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2309
"""Branch format registry."""
2311
def __init__(self, other_registry=None):
2312
super(BranchFormatRegistry, self).__init__(other_registry)
2313
self._default_format = None
2315
def set_default(self, format):
2316
self._default_format = format
2318
def get_default(self):
2319
return self._default_format
2322
network_format_registry = registry.FormatRegistry()
2323
"""Registry of formats indexed by their network name.
2325
The network name for a branch format is an identifier that can be used when
2326
referring to formats with smart server operations. See
2327
BranchFormat.network_name() for more detail.
2330
format_registry = BranchFormatRegistry(network_format_registry)
2333
# formats which have no format string are not discoverable
2334
# and not independently creatable, so are not registered.
2335
__format5 = BzrBranchFormat5()
2336
__format6 = BzrBranchFormat6()
2337
__format7 = BzrBranchFormat7()
2338
__format8 = BzrBranchFormat8()
2339
format_registry.register(__format5)
2340
format_registry.register(BranchReferenceFormat())
2341
format_registry.register(__format6)
2342
format_registry.register(__format7)
2343
format_registry.register(__format8)
2344
format_registry.set_default(__format7)
2347
class BranchWriteLockResult(LogicalLockResult):
2348
"""The result of write locking a branch.
2350
:ivar branch_token: The token obtained from the underlying branch lock, or
2352
:ivar unlock: A callable which will unlock the lock.
2355
def __init__(self, unlock, branch_token):
2356
LogicalLockResult.__init__(self, unlock)
2357
self.branch_token = branch_token
2360
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2364
class BzrBranch(Branch, _RelockDebugMixin):
2365
"""A branch stored in the actual filesystem.
2367
Note that it's "local" in the context of the filesystem; it doesn't
2368
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2369
it's writable, and can be accessed via the normal filesystem API.
2371
:ivar _transport: Transport for file operations on this branch's
2372
control files, typically pointing to the .bzr/branch directory.
2373
:ivar repository: Repository for this branch.
2374
:ivar base: The url of the base directory for this branch; the one
2375
containing the .bzr directory.
2376
:ivar name: Optional colocated branch name as it exists in the control
2380
def __init__(self, _format=None,
2381
_control_files=None, a_bzrdir=None, name=None,
2382
_repository=None, ignore_fallbacks=False,
2383
possible_transports=None):
2384
"""Create new branch object at a particular location."""
2385
if a_bzrdir is None:
2386
raise ValueError('a_bzrdir must be supplied')
2388
raise ValueError('name must be supplied')
2389
self.bzrdir = a_bzrdir
2390
self._user_transport = self.bzrdir.transport.clone('..')
2392
self._user_transport.set_segment_parameter(
2393
"branch", urlutils.escape(name))
2394
self._base = self._user_transport.base
2396
self._format = _format
2397
if _control_files is None:
2398
raise ValueError('BzrBranch _control_files is None')
2399
self.control_files = _control_files
2400
self._transport = _control_files._transport
2401
self.repository = _repository
2402
self.conf_store = None
2403
Branch.__init__(self, possible_transports)
2406
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2410
def _get_base(self):
2411
"""Returns the directory containing the control directory."""
2414
base = property(_get_base, doc="The URL for the root of this branch.")
2417
def user_transport(self):
2418
return self._user_transport
2420
def _get_config(self):
2421
return _mod_config.TransportConfig(self._transport, 'branch.conf')
2423
def _get_config_store(self):
2424
if self.conf_store is None:
2425
self.conf_store = _mod_config.BranchStore(self)
2426
return self.conf_store
2428
def is_locked(self):
2429
return self.control_files.is_locked()
2431
def lock_write(self, token=None):
2432
"""Lock the branch for write operations.
2434
:param token: A token to permit reacquiring a previously held and
2436
:return: A BranchWriteLockResult.
2438
if not self.is_locked():
2439
self._note_lock('w')
2440
# All-in-one needs to always unlock/lock.
2441
repo_control = getattr(self.repository, 'control_files', None)
2442
if self.control_files == repo_control or not self.is_locked():
2443
self.repository._warn_if_deprecated(self)
2444
self.repository.lock_write()
2449
return BranchWriteLockResult(self.unlock,
2450
self.control_files.lock_write(token=token))
2453
self.repository.unlock()
2456
def lock_read(self):
2457
"""Lock the branch for read operations.
2459
:return: A bzrlib.lock.LogicalLockResult.
2461
if not self.is_locked():
2462
self._note_lock('r')
2463
# All-in-one needs to always unlock/lock.
2464
repo_control = getattr(self.repository, 'control_files', None)
2465
if self.control_files == repo_control or not self.is_locked():
2466
self.repository._warn_if_deprecated(self)
2467
self.repository.lock_read()
2472
self.control_files.lock_read()
2473
return LogicalLockResult(self.unlock)
2476
self.repository.unlock()
2479
@only_raises(errors.LockNotHeld, errors.LockBroken)
2481
if self.control_files._lock_count == 1 and self.conf_store is not None:
2482
self.conf_store.save_changes()
2484
self.control_files.unlock()
2486
# All-in-one needs to always unlock/lock.
2487
repo_control = getattr(self.repository, 'control_files', None)
2488
if (self.control_files == repo_control or
2489
not self.control_files.is_locked()):
2490
self.repository.unlock()
2491
if not self.control_files.is_locked():
2492
# we just released the lock
2493
self._clear_cached_state()
2495
def peek_lock_mode(self):
2496
if self.control_files._lock_count == 0:
2499
return self.control_files._lock_mode
2501
def get_physical_lock_status(self):
2502
return self.control_files.get_physical_lock_status()
2505
def print_file(self, file, revision_id):
2506
"""See Branch.print_file."""
2507
return self.repository.print_file(file, revision_id)
2510
def set_last_revision_info(self, revno, revision_id):
2511
if not revision_id or not isinstance(revision_id, basestring):
2512
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2513
revision_id = _mod_revision.ensure_null(revision_id)
2514
old_revno, old_revid = self.last_revision_info()
2515
if self.get_append_revisions_only():
2516
self._check_history_violation(revision_id)
2517
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2518
self._write_last_revision_info(revno, revision_id)
2519
self._clear_cached_state()
2520
self._last_revision_info_cache = revno, revision_id
2521
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2523
def basis_tree(self):
2524
"""See Branch.basis_tree."""
2525
return self.repository.revision_tree(self.last_revision())
2527
def _get_parent_location(self):
2528
_locs = ['parent', 'pull', 'x-pull']
2531
return self._transport.get_bytes(l).strip('\n')
2532
except errors.NoSuchFile:
2536
def get_stacked_on_url(self):
2537
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2539
def set_push_location(self, location):
2540
"""See Branch.set_push_location."""
2541
self.get_config().set_user_option(
2542
'push_location', location,
2543
store=_mod_config.STORE_LOCATION_NORECURSE)
2545
def _set_parent_location(self, url):
2547
self._transport.delete('parent')
2549
self._transport.put_bytes('parent', url + '\n',
2550
mode=self.bzrdir._get_file_mode())
2554
"""If bound, unbind"""
2555
return self.set_bound_location(None)
2558
def bind(self, other):
2559
"""Bind this branch to the branch other.
2561
This does not push or pull data between the branches, though it does
2562
check for divergence to raise an error when the branches are not
2563
either the same, or one a prefix of the other. That behaviour may not
2564
be useful, so that check may be removed in future.
2566
:param other: The branch to bind to
2569
# TODO: jam 20051230 Consider checking if the target is bound
2570
# It is debatable whether you should be able to bind to
2571
# a branch which is itself bound.
2572
# Committing is obviously forbidden,
2573
# but binding itself may not be.
2574
# Since we *have* to check at commit time, we don't
2575
# *need* to check here
2577
# we want to raise diverged if:
2578
# last_rev is not in the other_last_rev history, AND
2579
# other_last_rev is not in our history, and do it without pulling
2581
self.set_bound_location(other.base)
2583
def get_bound_location(self):
2585
return self._transport.get_bytes('bound')[:-1]
2586
except errors.NoSuchFile:
2590
def get_master_branch(self, possible_transports=None):
2591
"""Return the branch we are bound to.
2593
:return: Either a Branch, or None
2595
if self._master_branch_cache is None:
2596
self._master_branch_cache = self._get_master_branch(
2597
possible_transports)
2598
return self._master_branch_cache
2600
def _get_master_branch(self, possible_transports):
2601
bound_loc = self.get_bound_location()
2605
return Branch.open(bound_loc,
2606
possible_transports=possible_transports)
2607
except (errors.NotBranchError, errors.ConnectionError), e:
2608
raise errors.BoundBranchConnectionFailure(
2612
def set_bound_location(self, location):
2613
"""Set the target where this branch is bound to.
2615
:param location: URL to the target branch
2617
self._master_branch_cache = None
2619
self._transport.put_bytes('bound', location+'\n',
2620
mode=self.bzrdir._get_file_mode())
2623
self._transport.delete('bound')
2624
except errors.NoSuchFile:
2629
def update(self, possible_transports=None):
2630
"""Synchronise this branch with the master branch if any.
2632
:return: None or the last_revision that was pivoted out during the
2635
master = self.get_master_branch(possible_transports)
2636
if master is not None:
2637
old_tip = _mod_revision.ensure_null(self.last_revision())
2638
self.pull(master, overwrite=True)
2639
if self.repository.get_graph().is_ancestor(old_tip,
2640
_mod_revision.ensure_null(self.last_revision())):
2645
def _read_last_revision_info(self):
2646
revision_string = self._transport.get_bytes('last-revision')
2647
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2648
revision_id = cache_utf8.get_cached_utf8(revision_id)
2650
return revno, revision_id
2652
def _write_last_revision_info(self, revno, revision_id):
2653
"""Simply write out the revision id, with no checks.
2655
Use set_last_revision_info to perform this safely.
2657
Does not update the revision_history cache.
2659
revision_id = _mod_revision.ensure_null(revision_id)
2660
out_string = '%d %s\n' % (revno, revision_id)
2661
self._transport.put_bytes('last-revision', out_string,
2662
mode=self.bzrdir._get_file_mode())
2665
def update_feature_flags(self, updated_flags):
2666
"""Update the feature flags for this branch.
2668
:param updated_flags: Dictionary mapping feature names to necessities
2669
A necessity can be None to indicate the feature should be removed
2671
self._format._update_feature_flags(updated_flags)
2672
self.control_transport.put_bytes('format', self._format.as_string())
2675
class FullHistoryBzrBranch(BzrBranch):
2676
"""Bzr branch which contains the full revision history."""
2679
def set_last_revision_info(self, revno, revision_id):
2680
if not revision_id or not isinstance(revision_id, basestring):
2681
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2682
revision_id = _mod_revision.ensure_null(revision_id)
2683
# this old format stores the full history, but this api doesn't
2684
# provide it, so we must generate, and might as well check it's
2686
history = self._lefthand_history(revision_id)
2687
if len(history) != revno:
2688
raise AssertionError('%d != %d' % (len(history), revno))
2689
self._set_revision_history(history)
2691
def _read_last_revision_info(self):
2692
rh = self._revision_history()
2695
return (revno, rh[-1])
2697
return (0, _mod_revision.NULL_REVISION)
2699
def _set_revision_history(self, rev_history):
2700
if 'evil' in debug.debug_flags:
2701
mutter_callsite(3, "set_revision_history scales with history.")
2702
check_not_reserved_id = _mod_revision.check_not_reserved_id
2703
for rev_id in rev_history:
2704
check_not_reserved_id(rev_id)
2705
if Branch.hooks['post_change_branch_tip']:
2706
# Don't calculate the last_revision_info() if there are no hooks
2708
old_revno, old_revid = self.last_revision_info()
2709
if len(rev_history) == 0:
2710
revid = _mod_revision.NULL_REVISION
2712
revid = rev_history[-1]
2713
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2714
self._write_revision_history(rev_history)
2715
self._clear_cached_state()
2716
self._cache_revision_history(rev_history)
2717
if Branch.hooks['post_change_branch_tip']:
2718
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2720
def _write_revision_history(self, history):
2721
"""Factored out of set_revision_history.
2723
This performs the actual writing to disk.
2724
It is intended to be called by set_revision_history."""
2725
self._transport.put_bytes(
2726
'revision-history', '\n'.join(history),
2727
mode=self.bzrdir._get_file_mode())
2729
def _gen_revision_history(self):
2730
history = self._transport.get_bytes('revision-history').split('\n')
2731
if history[-1:] == ['']:
2732
# There shouldn't be a trailing newline, but just in case.
2736
def _synchronize_history(self, destination, revision_id):
2737
if not isinstance(destination, FullHistoryBzrBranch):
2738
super(BzrBranch, self)._synchronize_history(
2739
destination, revision_id)
2741
if revision_id == _mod_revision.NULL_REVISION:
2744
new_history = self._revision_history()
2745
if revision_id is not None and new_history != []:
2747
new_history = new_history[:new_history.index(revision_id) + 1]
2749
rev = self.repository.get_revision(revision_id)
2750
new_history = rev.get_history(self.repository)[1:]
2751
destination._set_revision_history(new_history)
2754
def generate_revision_history(self, revision_id, last_rev=None,
2756
"""Create a new revision history that will finish with revision_id.
2758
:param revision_id: the new tip to use.
2759
:param last_rev: The previous last_revision. If not None, then this
2760
must be a ancestory of revision_id, or DivergedBranches is raised.
2761
:param other_branch: The other branch that DivergedBranches should
2762
raise with respect to.
2764
self._set_revision_history(self._lefthand_history(revision_id,
2765
last_rev, other_branch))
2768
class BzrBranch5(FullHistoryBzrBranch):
2769
"""A format 5 branch. This supports new features over plain branches.
2771
It has support for a master_branch which is the data for bound branches.
2775
class BzrBranch8(BzrBranch):
2776
"""A branch that stores tree-reference locations."""
2778
def _open_hook(self, possible_transports=None):
2779
if self._ignore_fallbacks:
2781
if possible_transports is None:
2782
possible_transports = [self.bzrdir.root_transport]
2784
url = self.get_stacked_on_url()
2785
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2786
errors.UnstackableBranchFormat):
2789
for hook in Branch.hooks['transform_fallback_location']:
2790
url = hook(self, url)
2792
hook_name = Branch.hooks.get_hook_name(hook)
2793
raise AssertionError(
2794
"'transform_fallback_location' hook %s returned "
2795
"None, not a URL." % hook_name)
2796
self._activate_fallback_location(url,
2797
possible_transports=possible_transports)
2799
def __init__(self, *args, **kwargs):
2800
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2801
super(BzrBranch8, self).__init__(*args, **kwargs)
2802
self._last_revision_info_cache = None
2803
self._reference_info = None
2805
def _clear_cached_state(self):
2806
super(BzrBranch8, self)._clear_cached_state()
2807
self._last_revision_info_cache = None
2808
self._reference_info = None
2810
def _check_history_violation(self, revision_id):
2811
current_revid = self.last_revision()
2812
last_revision = _mod_revision.ensure_null(current_revid)
2813
if _mod_revision.is_null(last_revision):
2815
graph = self.repository.get_graph()
2816
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2817
if lh_ancestor == current_revid:
2819
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2821
def _gen_revision_history(self):
2822
"""Generate the revision history from last revision
2824
last_revno, last_revision = self.last_revision_info()
2825
self._extend_partial_history(stop_index=last_revno-1)
2826
return list(reversed(self._partial_revision_history_cache))
2829
def _set_parent_location(self, url):
2830
"""Set the parent branch"""
2831
self._set_config_location('parent_location', url, make_relative=True)
2834
def _get_parent_location(self):
2835
"""Set the parent branch"""
2836
return self._get_config_location('parent_location')
2839
def _set_all_reference_info(self, info_dict):
2840
"""Replace all reference info stored in a branch.
2842
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2845
writer = rio.RioWriter(s)
2846
for key, (tree_path, branch_location) in info_dict.iteritems():
2847
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2848
branch_location=branch_location)
2849
writer.write_stanza(stanza)
2850
self._transport.put_bytes('references', s.getvalue())
2851
self._reference_info = info_dict
2854
def _get_all_reference_info(self):
2855
"""Return all the reference info stored in a branch.
2857
:return: A dict of {file_id: (tree_path, branch_location)}
2859
if self._reference_info is not None:
2860
return self._reference_info
2861
rio_file = self._transport.get('references')
2863
stanzas = rio.read_stanzas(rio_file)
2864
info_dict = dict((s['file_id'], (s['tree_path'],
2865
s['branch_location'])) for s in stanzas)
2868
self._reference_info = info_dict
2871
def set_reference_info(self, file_id, tree_path, branch_location):
2872
"""Set the branch location to use for a tree reference.
2874
:param file_id: The file-id of the tree reference.
2875
:param tree_path: The path of the tree reference in the tree.
2876
:param branch_location: The location of the branch to retrieve tree
2879
info_dict = self._get_all_reference_info()
2880
info_dict[file_id] = (tree_path, branch_location)
2881
if None in (tree_path, branch_location):
2882
if tree_path is not None:
2883
raise ValueError('tree_path must be None when branch_location'
2885
if branch_location is not None:
2886
raise ValueError('branch_location must be None when tree_path'
2888
del info_dict[file_id]
2889
self._set_all_reference_info(info_dict)
2891
def get_reference_info(self, file_id):
2892
"""Get the tree_path and branch_location for a tree reference.
2894
:return: a tuple of (tree_path, branch_location)
2896
return self._get_all_reference_info().get(file_id, (None, None))
2898
def reference_parent(self, file_id, path, possible_transports=None):
2899
"""Return the parent branch for a tree-reference file_id.
2901
:param file_id: The file_id of the tree reference
2902
:param path: The path of the file_id in the tree
2903
:return: A branch associated with the file_id
2905
branch_location = self.get_reference_info(file_id)[1]
2906
if branch_location is None:
2907
return Branch.reference_parent(self, file_id, path,
2908
possible_transports)
2909
branch_location = urlutils.join(self.user_url, branch_location)
2910
return Branch.open(branch_location,
2911
possible_transports=possible_transports)
2913
def set_push_location(self, location):
2914
"""See Branch.set_push_location."""
2915
self._set_config_location('push_location', location)
2917
def set_bound_location(self, location):
2918
"""See Branch.set_push_location."""
2919
self._master_branch_cache = None
2921
conf = self.get_config_stack()
2922
if location is None:
2923
if not conf.get('bound'):
2926
conf.set('bound', 'False')
2929
self._set_config_location('bound_location', location,
2931
conf.set('bound', 'True')
2934
def _get_bound_location(self, bound):
2935
"""Return the bound location in the config file.
2937
Return None if the bound parameter does not match"""
2938
conf = self.get_config_stack()
2939
if conf.get('bound') != bound:
2941
return self._get_config_location('bound_location', config=conf)
2943
def get_bound_location(self):
2944
"""See Branch.get_bound_location."""
2945
return self._get_bound_location(True)
2947
def get_old_bound_location(self):
2948
"""See Branch.get_old_bound_location"""
2949
return self._get_bound_location(False)
2951
def get_stacked_on_url(self):
2952
# you can always ask for the URL; but you might not be able to use it
2953
# if the repo can't support stacking.
2954
## self._check_stackable_repo()
2955
# stacked_on_location is only ever defined in branch.conf, so don't
2956
# waste effort reading the whole stack of config files.
2957
conf = _mod_config.BranchOnlyStack(self)
2958
stacked_url = self._get_config_location('stacked_on_location',
2960
if stacked_url is None:
2961
raise errors.NotStacked(self)
2962
return stacked_url.encode('utf-8')
2965
def get_rev_id(self, revno, history=None):
2966
"""Find the revision id of the specified revno."""
2968
return _mod_revision.NULL_REVISION
2970
last_revno, last_revision_id = self.last_revision_info()
2971
if revno <= 0 or revno > last_revno:
2972
raise errors.NoSuchRevision(self, revno)
2974
if history is not None:
2975
return history[revno - 1]
2977
index = last_revno - revno
2978
if len(self._partial_revision_history_cache) <= index:
2979
self._extend_partial_history(stop_index=index)
2980
if len(self._partial_revision_history_cache) > index:
2981
return self._partial_revision_history_cache[index]
2983
raise errors.NoSuchRevision(self, revno)
2986
def revision_id_to_revno(self, revision_id):
2987
"""Given a revision id, return its revno"""
2988
if _mod_revision.is_null(revision_id):
2991
index = self._partial_revision_history_cache.index(revision_id)
2994
self._extend_partial_history(stop_revision=revision_id)
2995
except errors.RevisionNotPresent, e:
2996
raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
2997
index = len(self._partial_revision_history_cache) - 1
2999
raise errors.NoSuchRevision(self, revision_id)
3000
if self._partial_revision_history_cache[index] != revision_id:
3001
raise errors.NoSuchRevision(self, revision_id)
3002
return self.revno() - index
3005
class BzrBranch7(BzrBranch8):
3006
"""A branch with support for a fallback repository."""
3008
def set_reference_info(self, file_id, tree_path, branch_location):
3009
Branch.set_reference_info(self, file_id, tree_path, branch_location)
3011
def get_reference_info(self, file_id):
3012
Branch.get_reference_info(self, file_id)
3014
def reference_parent(self, file_id, path, possible_transports=None):
3015
return Branch.reference_parent(self, file_id, path,
3016
possible_transports)
3019
class BzrBranch6(BzrBranch7):
3020
"""See BzrBranchFormat6 for the capabilities of this branch.
3022
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
3026
def get_stacked_on_url(self):
3027
raise errors.UnstackableBranchFormat(self._format, self.user_url)
3030
######################################################################
3031
# results of operations
3034
class _Result(object):
3036
def _show_tag_conficts(self, to_file):
3037
if not getattr(self, 'tag_conflicts', None):
3039
to_file.write('Conflicting tags:\n')
3040
for name, value1, value2 in self.tag_conflicts:
3041
to_file.write(' %s\n' % (name, ))
3044
class PullResult(_Result):
3045
"""Result of a Branch.pull operation.
3047
:ivar old_revno: Revision number before pull.
3048
:ivar new_revno: Revision number after pull.
3049
:ivar old_revid: Tip revision id before pull.
3050
:ivar new_revid: Tip revision id after pull.
3051
:ivar source_branch: Source (local) branch object. (read locked)
3052
:ivar master_branch: Master branch of the target, or the target if no
3054
:ivar local_branch: target branch if there is a Master, else None
3055
:ivar target_branch: Target/destination branch object. (write locked)
3056
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3057
:ivar tag_updates: A dict with new tags, see BasicTags.merge_to
3060
def report(self, to_file):
3061
tag_conflicts = getattr(self, "tag_conflicts", None)
3062
tag_updates = getattr(self, "tag_updates", None)
3064
if self.old_revid != self.new_revid:
3065
to_file.write('Now on revision %d.\n' % self.new_revno)
3067
to_file.write('%d tag(s) updated.\n' % len(tag_updates))
3068
if self.old_revid == self.new_revid and not tag_updates:
3069
if not tag_conflicts:
3070
to_file.write('No revisions or tags to pull.\n')
3072
to_file.write('No revisions to pull.\n')
3073
self._show_tag_conficts(to_file)
3076
class BranchPushResult(_Result):
3077
"""Result of a Branch.push operation.
3079
:ivar old_revno: Revision number (eg 10) of the target before push.
3080
:ivar new_revno: Revision number (eg 12) of the target after push.
3081
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3083
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3085
:ivar source_branch: Source branch object that the push was from. This is
3086
read locked, and generally is a local (and thus low latency) branch.
3087
:ivar master_branch: If target is a bound branch, the master branch of
3088
target, or target itself. Always write locked.
3089
:ivar target_branch: The direct Branch where data is being sent (write
3091
:ivar local_branch: If the target is a bound branch this will be the
3092
target, otherwise it will be None.
3095
def report(self, to_file):
3096
# TODO: This function gets passed a to_file, but then
3097
# ignores it and calls note() instead. This is also
3098
# inconsistent with PullResult(), which writes to stdout.
3099
# -- JRV20110901, bug #838853
3100
tag_conflicts = getattr(self, "tag_conflicts", None)
3101
tag_updates = getattr(self, "tag_updates", None)
3103
if self.old_revid != self.new_revid:
3104
note(gettext('Pushed up to revision %d.') % self.new_revno)
3106
note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
3107
if self.old_revid == self.new_revid and not tag_updates:
3108
if not tag_conflicts:
3109
note(gettext('No new revisions or tags to push.'))
3111
note(gettext('No new revisions to push.'))
3112
self._show_tag_conficts(to_file)
3115
class BranchCheckResult(object):
3116
"""Results of checking branch consistency.
3121
def __init__(self, branch):
3122
self.branch = branch
3125
def report_results(self, verbose):
3126
"""Report the check results via trace.note.
3128
:param verbose: Requests more detailed display of what was checked,
3131
note(gettext('checked branch {0} format {1}').format(
3132
self.branch.user_url, self.branch._format))
3133
for error in self.errors:
3134
note(gettext('found error:%s'), error)
3137
class Converter5to6(object):
3138
"""Perform an in-place upgrade of format 5 to format 6"""
3140
def convert(self, branch):
3141
# Data for 5 and 6 can peacefully coexist.
3142
format = BzrBranchFormat6()
3143
new_branch = format.open(branch.bzrdir, _found=True)
3145
# Copy source data into target
3146
new_branch._write_last_revision_info(*branch.last_revision_info())
3147
new_branch.lock_write()
3149
new_branch.set_parent(branch.get_parent())
3150
new_branch.set_bound_location(branch.get_bound_location())
3151
new_branch.set_push_location(branch.get_push_location())
3155
# New branch has no tags by default
3156
new_branch.tags._set_tag_dict({})
3158
# Copying done; now update target format
3159
new_branch._transport.put_bytes('format',
3161
mode=new_branch.bzrdir._get_file_mode())
3163
# Clean up old files
3164
new_branch._transport.delete('revision-history')
3168
branch.set_parent(None)
3169
except errors.NoSuchFile:
3171
branch.set_bound_location(None)
3176
class Converter6to7(object):
3177
"""Perform an in-place upgrade of format 6 to format 7"""
3179
def convert(self, branch):
3180
format = BzrBranchFormat7()
3181
branch._set_config_location('stacked_on_location', '')
3182
# update target format
3183
branch._transport.put_bytes('format', format.as_string())
3186
class Converter7to8(object):
3187
"""Perform an in-place upgrade of format 7 to format 8"""
3189
def convert(self, branch):
3190
format = BzrBranchFormat8()
3191
branch._transport.put_bytes('references', '')
3192
# update target format
3193
branch._transport.put_bytes('format', format.as_string())
3196
class InterBranch(InterObject):
3197
"""This class represents operations taking place between two branches.
3199
Its instances have methods like pull() and push() and contain
3200
references to the source and target repositories these operations
3201
can be carried out on.
3205
"""The available optimised InterBranch types."""
3208
def _get_branch_formats_to_test(klass):
3209
"""Return an iterable of format tuples for testing.
3211
:return: An iterable of (from_format, to_format) to use when testing
3212
this InterBranch class. Each InterBranch class should define this
3215
raise NotImplementedError(klass._get_branch_formats_to_test)
3218
def pull(self, overwrite=False, stop_revision=None,
3219
possible_transports=None, local=False):
3220
"""Mirror source into target branch.
3222
The target branch is considered to be 'local', having low latency.
3224
:returns: PullResult instance
3226
raise NotImplementedError(self.pull)
3229
def push(self, overwrite=False, stop_revision=None, lossy=False,
3230
_override_hook_source_branch=None):
3231
"""Mirror the source branch into the target branch.
3233
The source branch is considered to be 'local', having low latency.
3235
raise NotImplementedError(self.push)
3238
def copy_content_into(self, revision_id=None):
3239
"""Copy the content of source into target
3241
revision_id: if not None, the revision history in the new branch will
3242
be truncated to end with revision_id.
3244
raise NotImplementedError(self.copy_content_into)
3247
def fetch(self, stop_revision=None, limit=None):
3250
:param stop_revision: Last revision to fetch
3251
:param limit: Optional rough limit of revisions to fetch
3253
raise NotImplementedError(self.fetch)
3256
def _fix_overwrite_type(overwrite):
3257
if isinstance(overwrite, bool):
3259
return ["history", "tags"]
3265
class GenericInterBranch(InterBranch):
3266
"""InterBranch implementation that uses public Branch functions."""
3269
def is_compatible(klass, source, target):
3270
# GenericBranch uses the public API, so always compatible
3274
def _get_branch_formats_to_test(klass):
3275
return [(format_registry.get_default(), format_registry.get_default())]
3278
def unwrap_format(klass, format):
3279
if isinstance(format, remote.RemoteBranchFormat):
3280
format._ensure_real()
3281
return format._custom_format
3285
def copy_content_into(self, revision_id=None):
3286
"""Copy the content of source into target
3288
revision_id: if not None, the revision history in the new branch will
3289
be truncated to end with revision_id.
3291
self.source.update_references(self.target)
3292
self.source._synchronize_history(self.target, revision_id)
3294
parent = self.source.get_parent()
3295
except errors.InaccessibleParent, e:
3296
mutter('parent was not accessible to copy: %s', e)
3299
self.target.set_parent(parent)
3300
if self.source._push_should_merge_tags():
3301
self.source.tags.merge_to(self.target.tags)
3304
def fetch(self, stop_revision=None, limit=None):
3305
if self.target.base == self.source.base:
3307
self.source.lock_read()
3309
fetch_spec_factory = fetch.FetchSpecFactory()
3310
fetch_spec_factory.source_branch = self.source
3311
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3312
fetch_spec_factory.source_repo = self.source.repository
3313
fetch_spec_factory.target_repo = self.target.repository
3314
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3315
fetch_spec_factory.limit = limit
3316
fetch_spec = fetch_spec_factory.make_fetch_spec()
3317
return self.target.repository.fetch(self.source.repository,
3318
fetch_spec=fetch_spec)
3320
self.source.unlock()
3323
def _update_revisions(self, stop_revision=None, overwrite=False,
3325
other_revno, other_last_revision = self.source.last_revision_info()
3326
stop_revno = None # unknown
3327
if stop_revision is None:
3328
stop_revision = other_last_revision
3329
if _mod_revision.is_null(stop_revision):
3330
# if there are no commits, we're done.
3332
stop_revno = other_revno
3334
# what's the current last revision, before we fetch [and change it
3336
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3337
# we fetch here so that we don't process data twice in the common
3338
# case of having something to pull, and so that the check for
3339
# already merged can operate on the just fetched graph, which will
3340
# be cached in memory.
3341
self.fetch(stop_revision=stop_revision)
3342
# Check to see if one is an ancestor of the other
3345
graph = self.target.repository.get_graph()
3346
if self.target._check_if_descendant_or_diverged(
3347
stop_revision, last_rev, graph, self.source):
3348
# stop_revision is a descendant of last_rev, but we aren't
3349
# overwriting, so we're done.
3351
if stop_revno is None:
3353
graph = self.target.repository.get_graph()
3354
this_revno, this_last_revision = \
3355
self.target.last_revision_info()
3356
stop_revno = graph.find_distance_to_null(stop_revision,
3357
[(other_last_revision, other_revno),
3358
(this_last_revision, this_revno)])
3359
self.target.set_last_revision_info(stop_revno, stop_revision)
3362
def pull(self, overwrite=False, stop_revision=None,
3363
possible_transports=None, run_hooks=True,
3364
_override_hook_target=None, local=False):
3365
"""Pull from source into self, updating my master if any.
3367
:param run_hooks: Private parameter - if false, this branch
3368
is being called because it's the master of the primary branch,
3369
so it should not run its hooks.
3371
bound_location = self.target.get_bound_location()
3372
if local and not bound_location:
3373
raise errors.LocalRequiresBoundBranch()
3374
master_branch = None
3375
source_is_master = False
3377
# bound_location comes from a config file, some care has to be
3378
# taken to relate it to source.user_url
3379
normalized = urlutils.normalize_url(bound_location)
3381
relpath = self.source.user_transport.relpath(normalized)
3382
source_is_master = (relpath == '')
3383
except (errors.PathNotChild, errors.InvalidURL):
3384
source_is_master = False
3385
if not local and bound_location and not source_is_master:
3386
# not pulling from master, so we need to update master.
3387
master_branch = self.target.get_master_branch(possible_transports)
3388
master_branch.lock_write()
3391
# pull from source into master.
3392
master_branch.pull(self.source, overwrite, stop_revision,
3394
return self._pull(overwrite,
3395
stop_revision, _hook_master=master_branch,
3396
run_hooks=run_hooks,
3397
_override_hook_target=_override_hook_target,
3398
merge_tags_to_master=not source_is_master)
3401
master_branch.unlock()
3403
def push(self, overwrite=False, stop_revision=None, lossy=False,
3404
_override_hook_source_branch=None):
3405
"""See InterBranch.push.
3407
This is the basic concrete implementation of push()
3409
:param _override_hook_source_branch: If specified, run the hooks
3410
passing this Branch as the source, rather than self. This is for
3411
use of RemoteBranch, where push is delegated to the underlying
3415
raise errors.LossyPushToSameVCS(self.source, self.target)
3416
# TODO: Public option to disable running hooks - should be trivial but
3419
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3420
op.add_cleanup(self.source.lock_read().unlock)
3421
op.add_cleanup(self.target.lock_write().unlock)
3422
return op.run(overwrite, stop_revision,
3423
_override_hook_source_branch=_override_hook_source_branch)
3425
def _basic_push(self, overwrite, stop_revision):
3426
"""Basic implementation of push without bound branches or hooks.
3428
Must be called with source read locked and target write locked.
3430
result = BranchPushResult()
3431
result.source_branch = self.source
3432
result.target_branch = self.target
3433
result.old_revno, result.old_revid = self.target.last_revision_info()
3434
self.source.update_references(self.target)
3435
overwrite = _fix_overwrite_type(overwrite)
3436
if result.old_revid != stop_revision:
3437
# We assume that during 'push' this repository is closer than
3439
graph = self.source.repository.get_graph(self.target.repository)
3440
self._update_revisions(stop_revision,
3441
overwrite=("history" in overwrite),
3443
if self.source._push_should_merge_tags():
3444
result.tag_updates, result.tag_conflicts = (
3445
self.source.tags.merge_to(
3446
self.target.tags, "tags" in overwrite))
3447
result.new_revno, result.new_revid = self.target.last_revision_info()
3450
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3451
_override_hook_source_branch=None):
3452
"""Push from source into target, and into target's master if any.
3455
if _override_hook_source_branch:
3456
result.source_branch = _override_hook_source_branch
3457
for hook in Branch.hooks['post_push']:
3460
bound_location = self.target.get_bound_location()
3461
if bound_location and self.target.base != bound_location:
3462
# there is a master branch.
3464
# XXX: Why the second check? Is it even supported for a branch to
3465
# be bound to itself? -- mbp 20070507
3466
master_branch = self.target.get_master_branch()
3467
master_branch.lock_write()
3468
operation.add_cleanup(master_branch.unlock)
3469
# push into the master from the source branch.
3470
master_inter = InterBranch.get(self.source, master_branch)
3471
master_inter._basic_push(overwrite, stop_revision)
3472
# and push into the target branch from the source. Note that
3473
# we push from the source branch again, because it's considered
3474
# the highest bandwidth repository.
3475
result = self._basic_push(overwrite, stop_revision)
3476
result.master_branch = master_branch
3477
result.local_branch = self.target
3479
master_branch = None
3481
result = self._basic_push(overwrite, stop_revision)
3482
# TODO: Why set master_branch and local_branch if there's no
3483
# binding? Maybe cleaner to just leave them unset? -- mbp
3485
result.master_branch = self.target
3486
result.local_branch = None
3490
def _pull(self, overwrite=False, stop_revision=None,
3491
possible_transports=None, _hook_master=None, run_hooks=True,
3492
_override_hook_target=None, local=False,
3493
merge_tags_to_master=True):
3496
This function is the core worker, used by GenericInterBranch.pull to
3497
avoid duplication when pulling source->master and source->local.
3499
:param _hook_master: Private parameter - set the branch to
3500
be supplied as the master to pull hooks.
3501
:param run_hooks: Private parameter - if false, this branch
3502
is being called because it's the master of the primary branch,
3503
so it should not run its hooks.
3504
is being called because it's the master of the primary branch,
3505
so it should not run its hooks.
3506
:param _override_hook_target: Private parameter - set the branch to be
3507
supplied as the target_branch to pull hooks.
3508
:param local: Only update the local branch, and not the bound branch.
3510
# This type of branch can't be bound.
3512
raise errors.LocalRequiresBoundBranch()
3513
result = PullResult()
3514
result.source_branch = self.source
3515
if _override_hook_target is None:
3516
result.target_branch = self.target
3518
result.target_branch = _override_hook_target
3519
self.source.lock_read()
3521
# We assume that during 'pull' the target repository is closer than
3523
self.source.update_references(self.target)
3524
graph = self.target.repository.get_graph(self.source.repository)
3525
# TODO: Branch formats should have a flag that indicates
3526
# that revno's are expensive, and pull() should honor that flag.
3528
result.old_revno, result.old_revid = \
3529
self.target.last_revision_info()
3530
overwrite = _fix_overwrite_type(overwrite)
3531
self._update_revisions(stop_revision,
3532
overwrite=("history" in overwrite),
3534
# TODO: The old revid should be specified when merging tags,
3535
# so a tags implementation that versions tags can only
3536
# pull in the most recent changes. -- JRV20090506
3537
result.tag_updates, result.tag_conflicts = (
3538
self.source.tags.merge_to(self.target.tags,
3539
"tags" in overwrite,
3540
ignore_master=not merge_tags_to_master))
3541
result.new_revno, result.new_revid = self.target.last_revision_info()
3543
result.master_branch = _hook_master
3544
result.local_branch = result.target_branch
3546
result.master_branch = result.target_branch
3547
result.local_branch = None
3549
for hook in Branch.hooks['post_pull']:
3552
self.source.unlock()
3556
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
