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 only for use by subclasses, all other code
972
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
@deprecated_method(deprecated_in((2, 4, 0)))
1038
def import_last_revision_info(self, source_repo, revno, revid):
1039
"""Set the last revision info, importing from another repo if necessary.
1041
:param source_repo: Source repository to optionally fetch from
1042
:param revno: Revision number of the new tip
1043
:param revid: Revision id of the new tip
1045
if not self.repository.has_same_location(source_repo):
1046
self.repository.fetch(source_repo, revision_id=revid)
1047
self.set_last_revision_info(revno, revid)
1049
def import_last_revision_info_and_tags(self, source, revno, revid,
1051
"""Set the last revision info, importing from another repo if necessary.
1053
This is used by the bound branch code to upload a revision to
1054
the master branch first before updating the tip of the local branch.
1055
Revisions referenced by source's tags are also transferred.
1057
:param source: Source branch to optionally fetch from
1058
:param revno: Revision number of the new tip
1059
:param revid: Revision id of the new tip
1060
:param lossy: Whether to discard metadata that can not be
1061
natively represented
1062
:return: Tuple with the new revision number and revision id
1063
(should only be different from the arguments when lossy=True)
1065
if not self.repository.has_same_location(source.repository):
1066
self.fetch(source, revid)
1067
self.set_last_revision_info(revno, revid)
1068
return (revno, revid)
1070
def revision_id_to_revno(self, revision_id):
1071
"""Given a revision id, return its revno"""
1072
if _mod_revision.is_null(revision_id):
1074
history = self._revision_history()
1076
return history.index(revision_id) + 1
1078
raise errors.NoSuchRevision(self, revision_id)
1081
def get_rev_id(self, revno, history=None):
1082
"""Find the revision id of the specified revno."""
1084
return _mod_revision.NULL_REVISION
1085
last_revno, last_revid = self.last_revision_info()
1086
if revno == last_revno:
1088
if revno <= 0 or revno > last_revno:
1089
raise errors.NoSuchRevision(self, revno)
1090
distance_from_last = last_revno - revno
1091
if len(self._partial_revision_history_cache) <= distance_from_last:
1092
self._extend_partial_history(distance_from_last)
1093
return self._partial_revision_history_cache[distance_from_last]
1095
def pull(self, source, overwrite=False, stop_revision=None,
1096
possible_transports=None, *args, **kwargs):
1097
"""Mirror source into this branch.
1099
This branch is considered to be 'local', having low latency.
1101
:returns: PullResult instance
1103
return InterBranch.get(source, self).pull(overwrite=overwrite,
1104
stop_revision=stop_revision,
1105
possible_transports=possible_transports, *args, **kwargs)
1107
def push(self, target, overwrite=False, stop_revision=None, lossy=False,
1109
"""Mirror this branch into target.
1111
This branch is considered to be 'local', having low latency.
1113
return InterBranch.get(self, target).push(overwrite, stop_revision,
1114
lossy, *args, **kwargs)
1116
def basis_tree(self):
1117
"""Return `Tree` object for last revision."""
1118
return self.repository.revision_tree(self.last_revision())
1120
def get_parent(self):
1121
"""Return the parent location of the branch.
1123
This is the default location for pull/missing. The usual
1124
pattern is that the user can override it by specifying a
1127
parent = self._get_parent_location()
1130
# This is an old-format absolute path to a local branch
1131
# turn it into a url
1132
if parent.startswith('/'):
1133
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1135
return urlutils.join(self.base[:-1], parent)
1136
except errors.InvalidURLJoin, e:
1137
raise errors.InaccessibleParent(parent, self.user_url)
1139
def _get_parent_location(self):
1140
raise NotImplementedError(self._get_parent_location)
1142
def _set_config_location(self, name, url, config=None,
1143
make_relative=False):
1145
config = self.get_config_stack()
1149
url = urlutils.relative_url(self.base, url)
1150
config.set(name, url)
1152
def _get_config_location(self, name, config=None):
1154
config = self.get_config_stack()
1155
location = config.get(name)
1160
def get_child_submit_format(self):
1161
"""Return the preferred format of submissions to this branch."""
1162
return self.get_config_stack().get('child_submit_format')
1164
def get_submit_branch(self):
1165
"""Return the submit location of the branch.
1167
This is the default location for bundle. The usual
1168
pattern is that the user can override it by specifying a
1171
return self.get_config_stack().get('submit_branch')
1173
def set_submit_branch(self, location):
1174
"""Return the submit location of the branch.
1176
This is the default location for bundle. The usual
1177
pattern is that the user can override it by specifying a
1180
self.get_config_stack().set('submit_branch', location)
1182
def get_public_branch(self):
1183
"""Return the public location of the branch.
1185
This is used by merge directives.
1187
return self._get_config_location('public_branch')
1189
def set_public_branch(self, location):
1190
"""Return the submit location of the branch.
1192
This is the default location for bundle. The usual
1193
pattern is that the user can override it by specifying a
1196
self._set_config_location('public_branch', location)
1198
def get_push_location(self):
1199
"""Return None or the location to push this branch to."""
1200
return self.get_config_stack().get('push_location')
1202
def set_push_location(self, location):
1203
"""Set a new push location for this branch."""
1204
raise NotImplementedError(self.set_push_location)
1206
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1207
"""Run the post_change_branch_tip hooks."""
1208
hooks = Branch.hooks['post_change_branch_tip']
1211
new_revno, new_revid = self.last_revision_info()
1212
params = ChangeBranchTipParams(
1213
self, old_revno, new_revno, old_revid, new_revid)
1217
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1218
"""Run the pre_change_branch_tip hooks."""
1219
hooks = Branch.hooks['pre_change_branch_tip']
1222
old_revno, old_revid = self.last_revision_info()
1223
params = ChangeBranchTipParams(
1224
self, old_revno, new_revno, old_revid, new_revid)
1230
"""Synchronise this branch with the master branch if any.
1232
:return: None or the last_revision pivoted out during the update.
1236
def check_revno(self, revno):
1238
Check whether a revno corresponds to any revision.
1239
Zero (the NULL revision) is considered valid.
1242
self.check_real_revno(revno)
1244
def check_real_revno(self, revno):
1246
Check whether a revno corresponds to a real revision.
1247
Zero (the NULL revision) is considered invalid
1249
if revno < 1 or revno > self.revno():
1250
raise errors.InvalidRevisionNumber(revno)
1253
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1254
"""Clone this branch into to_bzrdir preserving all semantic values.
1256
Most API users will want 'create_clone_on_transport', which creates a
1257
new bzrdir and branch on the fly.
1259
revision_id: if not None, the revision history in the new branch will
1260
be truncated to end with revision_id.
1262
result = to_bzrdir.create_branch()
1265
if repository_policy is not None:
1266
repository_policy.configure_branch(result)
1267
self.copy_content_into(result, revision_id=revision_id)
1273
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
1275
"""Create a new line of development from the branch, into to_bzrdir.
1277
to_bzrdir controls the branch format.
1279
revision_id: if not None, the revision history in the new branch will
1280
be truncated to end with revision_id.
1282
if (repository_policy is not None and
1283
repository_policy.requires_stacking()):
1284
to_bzrdir._format.require_stacking(_skip_repo=True)
1285
result = to_bzrdir.create_branch(repository=repository)
1288
if repository_policy is not None:
1289
repository_policy.configure_branch(result)
1290
self.copy_content_into(result, revision_id=revision_id)
1291
master_url = self.get_bound_location()
1292
if master_url is None:
1293
result.set_parent(self.bzrdir.root_transport.base)
1295
result.set_parent(master_url)
1300
def _synchronize_history(self, destination, revision_id):
1301
"""Synchronize last revision and revision history between branches.
1303
This version is most efficient when the destination is also a
1304
BzrBranch6, but works for BzrBranch5, as long as the destination's
1305
repository contains all the lefthand ancestors of the intended
1306
last_revision. If not, set_last_revision_info will fail.
1308
:param destination: The branch to copy the history into
1309
:param revision_id: The revision-id to truncate history at. May
1310
be None to copy complete history.
1312
source_revno, source_revision_id = self.last_revision_info()
1313
if revision_id is None:
1314
revno, revision_id = source_revno, source_revision_id
1316
graph = self.repository.get_graph()
1318
revno = graph.find_distance_to_null(revision_id,
1319
[(source_revision_id, source_revno)])
1320
except errors.GhostRevisionsHaveNoRevno:
1321
# Default to 1, if we can't find anything else
1323
destination.set_last_revision_info(revno, revision_id)
1325
def copy_content_into(self, destination, revision_id=None):
1326
"""Copy the content of self into destination.
1328
revision_id: if not None, the revision history in the new branch will
1329
be truncated to end with revision_id.
1331
return InterBranch.get(self, destination).copy_content_into(
1332
revision_id=revision_id)
1334
def update_references(self, target):
1335
if not getattr(self._format, 'supports_reference_locations', False):
1337
reference_dict = self._get_all_reference_info()
1338
if len(reference_dict) == 0:
1340
old_base = self.base
1341
new_base = target.base
1342
target_reference_dict = target._get_all_reference_info()
1343
for file_id, (tree_path, branch_location) in (
1344
reference_dict.items()):
1345
branch_location = urlutils.rebase_url(branch_location,
1347
target_reference_dict.setdefault(
1348
file_id, (tree_path, branch_location))
1349
target._set_all_reference_info(target_reference_dict)
1352
def check(self, refs):
1353
"""Check consistency of the branch.
1355
In particular this checks that revisions given in the revision-history
1356
do actually match up in the revision graph, and that they're all
1357
present in the repository.
1359
Callers will typically also want to check the repository.
1361
:param refs: Calculated refs for this branch as specified by
1362
branch._get_check_refs()
1363
:return: A BranchCheckResult.
1365
result = BranchCheckResult(self)
1366
last_revno, last_revision_id = self.last_revision_info()
1367
actual_revno = refs[('lefthand-distance', last_revision_id)]
1368
if actual_revno != last_revno:
1369
result.errors.append(errors.BzrCheckError(
1370
'revno does not match len(mainline) %s != %s' % (
1371
last_revno, actual_revno)))
1372
# TODO: We should probably also check that self.revision_history
1373
# matches the repository for older branch formats.
1374
# If looking for the code that cross-checks repository parents against
1375
# the Graph.iter_lefthand_ancestry output, that is now a repository
1379
def _get_checkout_format(self, lightweight=False):
1380
"""Return the most suitable metadir for a checkout of this branch.
1381
Weaves are used if this branch's repository uses weaves.
1383
format = self.repository.bzrdir.checkout_metadir()
1384
format.set_branch_format(self._format)
1387
def create_clone_on_transport(self, to_transport, revision_id=None,
1388
stacked_on=None, create_prefix=False, use_existing_dir=False,
1390
"""Create a clone of this branch and its bzrdir.
1392
:param to_transport: The transport to clone onto.
1393
:param revision_id: The revision id to use as tip in the new branch.
1394
If None the tip is obtained from this branch.
1395
:param stacked_on: An optional URL to stack the clone on.
1396
:param create_prefix: Create any missing directories leading up to
1398
:param use_existing_dir: Use an existing directory if one exists.
1400
# XXX: Fix the bzrdir API to allow getting the branch back from the
1401
# clone call. Or something. 20090224 RBC/spiv.
1402
# XXX: Should this perhaps clone colocated branches as well,
1403
# rather than just the default branch? 20100319 JRV
1404
if revision_id is None:
1405
revision_id = self.last_revision()
1406
dir_to = self.bzrdir.clone_on_transport(to_transport,
1407
revision_id=revision_id, stacked_on=stacked_on,
1408
create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1410
return dir_to.open_branch()
1412
def create_checkout(self, to_location, revision_id=None,
1413
lightweight=False, accelerator_tree=None,
1415
"""Create a checkout of a branch.
1417
:param to_location: The url to produce the checkout at
1418
:param revision_id: The revision to check out
1419
:param lightweight: If True, produce a lightweight checkout, otherwise,
1420
produce a bound branch (heavyweight checkout)
1421
:param accelerator_tree: A tree which can be used for retrieving file
1422
contents more quickly than the revision tree, i.e. a workingtree.
1423
The revision tree will be used for cases where accelerator_tree's
1424
content is different.
1425
:param hardlink: If true, hard-link files from accelerator_tree,
1427
:return: The tree of the created checkout
1429
t = transport.get_transport(to_location)
1431
format = self._get_checkout_format(lightweight=lightweight)
1433
checkout = format.initialize_on_transport(t)
1434
except errors.AlreadyControlDirError:
1435
# It's fine if the control directory already exists,
1436
# as long as there is no existing branch and working tree.
1437
checkout = controldir.ControlDir.open_from_transport(t)
1439
checkout.open_branch()
1440
except errors.NotBranchError:
1443
raise errors.AlreadyControlDirError(t.base)
1444
if checkout.control_transport.base == self.bzrdir.control_transport.base:
1445
# When checking out to the same control directory,
1446
# always create a lightweight checkout
1450
from_branch = checkout.set_branch_reference(target_branch=self)
1452
policy = checkout.determine_repository_policy()
1453
repo = policy.acquire_repository()[0]
1454
checkout_branch = checkout.create_branch()
1455
checkout_branch.bind(self)
1456
# pull up to the specified revision_id to set the initial
1457
# branch tip correctly, and seed it with history.
1458
checkout_branch.pull(self, stop_revision=revision_id)
1460
tree = checkout.create_workingtree(revision_id,
1461
from_branch=from_branch,
1462
accelerator_tree=accelerator_tree,
1464
basis_tree = tree.basis_tree()
1465
basis_tree.lock_read()
1467
for path, file_id in basis_tree.iter_references():
1468
reference_parent = self.reference_parent(file_id, path)
1469
reference_parent.create_checkout(tree.abspath(path),
1470
basis_tree.get_reference_revision(file_id, path),
1477
def reconcile(self, thorough=True):
1478
"""Make sure the data stored in this branch is consistent."""
1479
from bzrlib.reconcile import BranchReconciler
1480
reconciler = BranchReconciler(self, thorough=thorough)
1481
reconciler.reconcile()
1484
def reference_parent(self, file_id, path, possible_transports=None):
1485
"""Return the parent branch for a tree-reference file_id
1487
:param file_id: The file_id of the tree reference
1488
:param path: The path of the file_id in the tree
1489
:return: A branch associated with the file_id
1491
# FIXME should provide multiple branches, based on config
1492
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1493
possible_transports=possible_transports)
1495
def supports_tags(self):
1496
return self._format.supports_tags()
1498
def automatic_tag_name(self, revision_id):
1499
"""Try to automatically find the tag name for a revision.
1501
:param revision_id: Revision id of the revision.
1502
:return: A tag name or None if no tag name could be determined.
1504
for hook in Branch.hooks['automatic_tag_name']:
1505
ret = hook(self, revision_id)
1510
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1512
"""Ensure that revision_b is a descendant of revision_a.
1514
This is a helper function for update_revisions.
1516
:raises: DivergedBranches if revision_b has diverged from revision_a.
1517
:returns: True if revision_b is a descendant of revision_a.
1519
relation = self._revision_relations(revision_a, revision_b, graph)
1520
if relation == 'b_descends_from_a':
1522
elif relation == 'diverged':
1523
raise errors.DivergedBranches(self, other_branch)
1524
elif relation == 'a_descends_from_b':
1527
raise AssertionError("invalid relation: %r" % (relation,))
1529
def _revision_relations(self, revision_a, revision_b, graph):
1530
"""Determine the relationship between two revisions.
1532
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1534
heads = graph.heads([revision_a, revision_b])
1535
if heads == set([revision_b]):
1536
return 'b_descends_from_a'
1537
elif heads == set([revision_a, revision_b]):
1538
# These branches have diverged
1540
elif heads == set([revision_a]):
1541
return 'a_descends_from_b'
1543
raise AssertionError("invalid heads: %r" % (heads,))
1545
def heads_to_fetch(self):
1546
"""Return the heads that must and that should be fetched to copy this
1547
branch into another repo.
1549
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1550
set of heads that must be fetched. if_present_fetch is a set of
1551
heads that must be fetched if present, but no error is necessary if
1552
they are not present.
1554
# For bzr native formats must_fetch is just the tip, and
1555
# if_present_fetch are the tags.
1556
must_fetch = set([self.last_revision()])
1557
if_present_fetch = set()
1558
if self.get_config_stack().get('branch.fetch_tags'):
1560
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1561
except errors.TagsNotSupported:
1563
must_fetch.discard(_mod_revision.NULL_REVISION)
1564
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1565
return must_fetch, if_present_fetch
1568
class BranchFormat(controldir.ControlComponentFormat):
1569
"""An encapsulation of the initialization and open routines for a format.
1571
Formats provide three things:
1572
* An initialization routine,
1573
* a format description
1576
Formats are placed in an dict by their format string for reference
1577
during branch opening. It's not required that these be instances, they
1578
can be classes themselves with class methods - it simply depends on
1579
whether state is needed for a given format or not.
1581
Once a format is deprecated, just deprecate the initialize and open
1582
methods on the format class. Do not deprecate the object, as the
1583
object will be created every time regardless.
1586
def __eq__(self, other):
1587
return self.__class__ is other.__class__
1589
def __ne__(self, other):
1590
return not (self == other)
1592
def get_reference(self, controldir, name=None):
1593
"""Get the target reference of the branch in controldir.
1595
format probing must have been completed before calling
1596
this method - it is assumed that the format of the branch
1597
in controldir is correct.
1599
:param controldir: The controldir to get the branch data from.
1600
:param name: Name of the colocated branch to fetch
1601
:return: None if the branch is not a reference branch.
1606
def set_reference(self, controldir, name, to_branch):
1607
"""Set the target reference of the branch in controldir.
1609
format probing must have been completed before calling
1610
this method - it is assumed that the format of the branch
1611
in controldir is correct.
1613
:param controldir: The controldir to set the branch reference for.
1614
:param name: Name of colocated branch to set, None for default
1615
:param to_branch: branch that the checkout is to reference
1617
raise NotImplementedError(self.set_reference)
1619
def get_format_description(self):
1620
"""Return the short format description for this format."""
1621
raise NotImplementedError(self.get_format_description)
1623
def _run_post_branch_init_hooks(self, controldir, name, branch):
1624
hooks = Branch.hooks['post_branch_init']
1627
params = BranchInitHookParams(self, controldir, name, branch)
1631
def initialize(self, controldir, name=None, repository=None,
1632
append_revisions_only=None):
1633
"""Create a branch of this format in controldir.
1635
:param name: Name of the colocated branch to create.
1637
raise NotImplementedError(self.initialize)
1639
def is_supported(self):
1640
"""Is this format supported?
1642
Supported formats can be initialized and opened.
1643
Unsupported formats may not support initialization or committing or
1644
some other features depending on the reason for not being supported.
1648
def make_tags(self, branch):
1649
"""Create a tags object for branch.
1651
This method is on BranchFormat, because BranchFormats are reflected
1652
over the wire via network_name(), whereas full Branch instances require
1653
multiple VFS method calls to operate at all.
1655
The default implementation returns a disabled-tags instance.
1657
Note that it is normal for branch to be a RemoteBranch when using tags
1660
return _mod_tag.DisabledTags(branch)
1662
def network_name(self):
1663
"""A simple byte string uniquely identifying this format for RPC calls.
1665
MetaDir branch formats use their disk format string to identify the
1666
repository over the wire. All in one formats such as bzr < 0.8, and
1667
foreign formats like svn/git and hg should use some marker which is
1668
unique and immutable.
1670
raise NotImplementedError(self.network_name)
1672
def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
1673
found_repository=None, possible_transports=None):
1674
"""Return the branch object for controldir.
1676
:param controldir: A ControlDir that contains a branch.
1677
:param name: Name of colocated branch to open
1678
:param _found: a private parameter, do not use it. It is used to
1679
indicate if format probing has already be done.
1680
:param ignore_fallbacks: when set, no fallback branches will be opened
1681
(if there are any). Default is to open fallbacks.
1683
raise NotImplementedError(self.open)
1685
def supports_set_append_revisions_only(self):
1686
"""True if this format supports set_append_revisions_only."""
1689
def supports_stacking(self):
1690
"""True if this format records a stacked-on branch."""
1693
def supports_leaving_lock(self):
1694
"""True if this format supports leaving locks in place."""
1695
return False # by default
1698
@deprecated_method(deprecated_in((2, 4, 0)))
1699
def unregister_format(klass, format):
1700
format_registry.remove(format)
1703
return self.get_format_description().rstrip()
1705
def supports_tags(self):
1706
"""True if this format supports tags stored in the branch"""
1707
return False # by default
1709
def tags_are_versioned(self):
1710
"""Whether the tag container for this branch versions tags."""
1713
def supports_tags_referencing_ghosts(self):
1714
"""True if tags can reference ghost revisions."""
1718
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1719
"""A factory for a BranchFormat object, permitting simple lazy registration.
1721
While none of the built in BranchFormats are lazy registered yet,
1722
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1723
use it, and the bzr-loom plugin uses it as well (see
1724
bzrlib.plugins.loom.formats).
1727
def __init__(self, format_string, module_name, member_name):
1728
"""Create a MetaDirBranchFormatFactory.
1730
:param format_string: The format string the format has.
1731
:param module_name: Module to load the format class from.
1732
:param member_name: Attribute name within the module for the format class.
1734
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1735
self._format_string = format_string
1737
def get_format_string(self):
1738
"""See BranchFormat.get_format_string."""
1739
return self._format_string
1742
"""Used for network_format_registry support."""
1743
return self.get_obj()()
1746
class BranchHooks(Hooks):
1747
"""A dictionary mapping hook name to a list of callables for branch hooks.
1749
e.g. ['post_push'] Is the list of items to be called when the
1750
push function is invoked.
1754
"""Create the default hooks.
1756
These are all empty initially, because by default nothing should get
1759
Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1760
self.add_hook('open',
1761
"Called with the Branch object that has been opened after a "
1762
"branch is opened.", (1, 8))
1763
self.add_hook('post_push',
1764
"Called after a push operation completes. post_push is called "
1765
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1766
"bzr client.", (0, 15))
1767
self.add_hook('post_pull',
1768
"Called after a pull operation completes. post_pull is called "
1769
"with a bzrlib.branch.PullResult object and only runs in the "
1770
"bzr client.", (0, 15))
1771
self.add_hook('pre_commit',
1772
"Called after a commit is calculated but before it is "
1773
"completed. pre_commit is called with (local, master, old_revno, "
1774
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1775
"). old_revid is NULL_REVISION for the first commit to a branch, "
1776
"tree_delta is a TreeDelta object describing changes from the "
1777
"basis revision. hooks MUST NOT modify this delta. "
1778
" future_tree is an in-memory tree obtained from "
1779
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1781
self.add_hook('post_commit',
1782
"Called in the bzr client after a commit has completed. "
1783
"post_commit is called with (local, master, old_revno, old_revid, "
1784
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1785
"commit to a branch.", (0, 15))
1786
self.add_hook('post_uncommit',
1787
"Called in the bzr client after an uncommit completes. "
1788
"post_uncommit is called with (local, master, old_revno, "
1789
"old_revid, new_revno, new_revid) where local is the local branch "
1790
"or None, master is the target branch, and an empty branch "
1791
"receives new_revno of 0, new_revid of None.", (0, 15))
1792
self.add_hook('pre_change_branch_tip',
1793
"Called in bzr client and server before a change to the tip of a "
1794
"branch is made. pre_change_branch_tip is called with a "
1795
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1796
"commit, uncommit will all trigger this hook.", (1, 6))
1797
self.add_hook('post_change_branch_tip',
1798
"Called in bzr client and server after a change to the tip of a "
1799
"branch is made. post_change_branch_tip is called with a "
1800
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1801
"commit, uncommit will all trigger this hook.", (1, 4))
1802
self.add_hook('transform_fallback_location',
1803
"Called when a stacked branch is activating its fallback "
1804
"locations. transform_fallback_location is called with (branch, "
1805
"url), and should return a new url. Returning the same url "
1806
"allows it to be used as-is, returning a different one can be "
1807
"used to cause the branch to stack on a closer copy of that "
1808
"fallback_location. Note that the branch cannot have history "
1809
"accessing methods called on it during this hook because the "
1810
"fallback locations have not been activated. When there are "
1811
"multiple hooks installed for transform_fallback_location, "
1812
"all are called with the url returned from the previous hook."
1813
"The order is however undefined.", (1, 9))
1814
self.add_hook('automatic_tag_name',
1815
"Called to determine an automatic tag name for a revision. "
1816
"automatic_tag_name is called with (branch, revision_id) and "
1817
"should return a tag name or None if no tag name could be "
1818
"determined. The first non-None tag name returned will be used.",
1820
self.add_hook('post_branch_init',
1821
"Called after new branch initialization completes. "
1822
"post_branch_init is called with a "
1823
"bzrlib.branch.BranchInitHookParams. "
1824
"Note that init, branch and checkout (both heavyweight and "
1825
"lightweight) will all trigger this hook.", (2, 2))
1826
self.add_hook('post_switch',
1827
"Called after a checkout switches branch. "
1828
"post_switch is called with a "
1829
"bzrlib.branch.SwitchHookParams.", (2, 2))
1833
# install the default hooks into the Branch class.
1834
Branch.hooks = BranchHooks()
1837
class ChangeBranchTipParams(object):
1838
"""Object holding parameters passed to `*_change_branch_tip` hooks.
1840
There are 5 fields that hooks may wish to access:
1842
:ivar branch: the branch being changed
1843
:ivar old_revno: revision number before the change
1844
:ivar new_revno: revision number after the change
1845
:ivar old_revid: revision id before the change
1846
:ivar new_revid: revision id after the change
1848
The revid fields are strings. The revno fields are integers.
1851
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1852
"""Create a group of ChangeBranchTip parameters.
1854
:param branch: The branch being changed.
1855
:param old_revno: Revision number before the change.
1856
:param new_revno: Revision number after the change.
1857
:param old_revid: Tip revision id before the change.
1858
:param new_revid: Tip revision id after the change.
1860
self.branch = branch
1861
self.old_revno = old_revno
1862
self.new_revno = new_revno
1863
self.old_revid = old_revid
1864
self.new_revid = new_revid
1866
def __eq__(self, other):
1867
return self.__dict__ == other.__dict__
1870
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1871
self.__class__.__name__, self.branch,
1872
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1875
class BranchInitHookParams(object):
1876
"""Object holding parameters passed to `*_branch_init` hooks.
1878
There are 4 fields that hooks may wish to access:
1880
:ivar format: the branch format
1881
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1882
:ivar name: name of colocated branch, if any (or None)
1883
:ivar branch: the branch created
1885
Note that for lightweight checkouts, the bzrdir and format fields refer to
1886
the checkout, hence they are different from the corresponding fields in
1887
branch, which refer to the original branch.
1890
def __init__(self, format, controldir, name, branch):
1891
"""Create a group of BranchInitHook parameters.
1893
:param format: the branch format
1894
:param controldir: the ControlDir where the branch will be/has been
1896
:param name: name of colocated branch, if any (or None)
1897
:param branch: the branch created
1899
Note that for lightweight checkouts, the bzrdir and format fields refer
1900
to the checkout, hence they are different from the corresponding fields
1901
in branch, which refer to the original branch.
1903
self.format = format
1904
self.bzrdir = controldir
1906
self.branch = branch
1908
def __eq__(self, other):
1909
return self.__dict__ == other.__dict__
1912
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1915
class SwitchHookParams(object):
1916
"""Object holding parameters passed to `*_switch` hooks.
1918
There are 4 fields that hooks may wish to access:
1920
:ivar control_dir: ControlDir of the checkout to change
1921
:ivar to_branch: branch that the checkout is to reference
1922
:ivar force: skip the check for local commits in a heavy checkout
1923
:ivar revision_id: revision ID to switch to (or None)
1926
def __init__(self, control_dir, to_branch, force, revision_id):
1927
"""Create a group of SwitchHook parameters.
1929
:param control_dir: ControlDir of the checkout to change
1930
:param to_branch: branch that the checkout is to reference
1931
:param force: skip the check for local commits in a heavy checkout
1932
:param revision_id: revision ID to switch to (or None)
1934
self.control_dir = control_dir
1935
self.to_branch = to_branch
1937
self.revision_id = revision_id
1939
def __eq__(self, other):
1940
return self.__dict__ == other.__dict__
1943
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1944
self.control_dir, self.to_branch,
1948
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
1949
"""Base class for branch formats that live in meta directories.
1953
BranchFormat.__init__(self)
1954
bzrdir.BzrFormat.__init__(self)
1957
def find_format(klass, controldir, name=None):
1958
"""Return the format for the branch object in controldir."""
1960
transport = controldir.get_branch_transport(None, name=name)
1961
except errors.NoSuchFile:
1962
raise errors.NotBranchError(path=name, bzrdir=controldir)
1964
format_string = transport.get_bytes("format")
1965
except errors.NoSuchFile:
1966
raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
1967
return klass._find_format(format_registry, 'branch', format_string)
1969
def _branch_class(self):
1970
"""What class to instantiate on open calls."""
1971
raise NotImplementedError(self._branch_class)
1973
def _get_initial_config(self, append_revisions_only=None):
1974
if append_revisions_only:
1975
return "append_revisions_only = True\n"
1977
# Avoid writing anything if append_revisions_only is disabled,
1978
# as that is the default.
1981
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1983
"""Initialize a branch in a control dir, with specified files
1985
:param a_bzrdir: The bzrdir to initialize the branch in
1986
:param utf8_files: The files to create as a list of
1987
(filename, content) tuples
1988
:param name: Name of colocated branch to create, if any
1989
:return: a branch in this format
1992
name = a_bzrdir._get_selected_branch()
1993
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1994
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1995
control_files = lockable_files.LockableFiles(branch_transport,
1996
'lock', lockdir.LockDir)
1997
control_files.create_lock()
1998
control_files.lock_write()
2000
utf8_files += [('format', self.as_string())]
2001
for (filename, content) in utf8_files:
2002
branch_transport.put_bytes(
2004
mode=a_bzrdir._get_file_mode())
2006
control_files.unlock()
2007
branch = self.open(a_bzrdir, name, _found=True,
2008
found_repository=repository)
2009
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2012
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2013
found_repository=None, possible_transports=None):
2014
"""See BranchFormat.open()."""
2016
name = a_bzrdir._get_selected_branch()
2018
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2019
if format.__class__ != self.__class__:
2020
raise AssertionError("wrong format %r found for %r" %
2022
transport = a_bzrdir.get_branch_transport(None, name=name)
2024
control_files = lockable_files.LockableFiles(transport, 'lock',
2026
if found_repository is None:
2027
found_repository = a_bzrdir.find_repository()
2028
return self._branch_class()(_format=self,
2029
_control_files=control_files,
2032
_repository=found_repository,
2033
ignore_fallbacks=ignore_fallbacks,
2034
possible_transports=possible_transports)
2035
except errors.NoSuchFile:
2036
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2039
def _matchingbzrdir(self):
2040
ret = bzrdir.BzrDirMetaFormat1()
2041
ret.set_branch_format(self)
2044
def supports_tags(self):
2047
def supports_leaving_lock(self):
2050
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
2052
BranchFormat.check_support_status(self,
2053
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
2055
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
2056
recommend_upgrade=recommend_upgrade, basedir=basedir)
2059
class BzrBranchFormat5(BranchFormatMetadir):
2060
"""Bzr branch format 5.
2063
- a revision-history file.
2065
- a lock dir guarding the branch itself
2066
- all of this stored in a branch/ subdirectory
2067
- works with shared repositories.
2069
This format is new in bzr 0.8.
2072
def _branch_class(self):
2076
def get_format_string(cls):
2077
"""See BranchFormat.get_format_string()."""
2078
return "Bazaar-NG branch format 5\n"
2080
def get_format_description(self):
2081
"""See BranchFormat.get_format_description()."""
2082
return "Branch format 5"
2084
def initialize(self, a_bzrdir, name=None, repository=None,
2085
append_revisions_only=None):
2086
"""Create a branch of this format in a_bzrdir."""
2087
if append_revisions_only:
2088
raise errors.UpgradeRequired(a_bzrdir.user_url)
2089
utf8_files = [('revision-history', ''),
2090
('branch-name', ''),
2092
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2094
def supports_tags(self):
2098
class BzrBranchFormat6(BranchFormatMetadir):
2099
"""Branch format with last-revision and tags.
2101
Unlike previous formats, this has no explicit revision history. Instead,
2102
this just stores the last-revision, and the left-hand history leading
2103
up to there is the history.
2105
This format was introduced in bzr 0.15
2106
and became the default in 0.91.
2109
def _branch_class(self):
2113
def get_format_string(cls):
2114
"""See BranchFormat.get_format_string()."""
2115
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2117
def get_format_description(self):
2118
"""See BranchFormat.get_format_description()."""
2119
return "Branch format 6"
2121
def initialize(self, a_bzrdir, name=None, repository=None,
2122
append_revisions_only=None):
2123
"""Create a branch of this format in a_bzrdir."""
2124
utf8_files = [('last-revision', '0 null:\n'),
2126
self._get_initial_config(append_revisions_only)),
2129
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2131
def make_tags(self, branch):
2132
"""See bzrlib.branch.BranchFormat.make_tags()."""
2133
return _mod_tag.BasicTags(branch)
2135
def supports_set_append_revisions_only(self):
2139
class BzrBranchFormat8(BranchFormatMetadir):
2140
"""Metadir format supporting storing locations of subtree branches."""
2142
def _branch_class(self):
2146
def get_format_string(cls):
2147
"""See BranchFormat.get_format_string()."""
2148
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2150
def get_format_description(self):
2151
"""See BranchFormat.get_format_description()."""
2152
return "Branch format 8"
2154
def initialize(self, a_bzrdir, name=None, repository=None,
2155
append_revisions_only=None):
2156
"""Create a branch of this format in a_bzrdir."""
2157
utf8_files = [('last-revision', '0 null:\n'),
2159
self._get_initial_config(append_revisions_only)),
2163
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2165
def make_tags(self, branch):
2166
"""See bzrlib.branch.BranchFormat.make_tags()."""
2167
return _mod_tag.BasicTags(branch)
2169
def supports_set_append_revisions_only(self):
2172
def supports_stacking(self):
2175
supports_reference_locations = True
2178
class BzrBranchFormat7(BranchFormatMetadir):
2179
"""Branch format with last-revision, tags, and a stacked location pointer.
2181
The stacked location pointer is passed down to the repository and requires
2182
a repository format with supports_external_lookups = True.
2184
This format was introduced in bzr 1.6.
2187
def initialize(self, a_bzrdir, name=None, repository=None,
2188
append_revisions_only=None):
2189
"""Create a branch of this format in a_bzrdir."""
2190
utf8_files = [('last-revision', '0 null:\n'),
2192
self._get_initial_config(append_revisions_only)),
2195
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2197
def _branch_class(self):
2201
def get_format_string(cls):
2202
"""See BranchFormat.get_format_string()."""
2203
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2205
def get_format_description(self):
2206
"""See BranchFormat.get_format_description()."""
2207
return "Branch format 7"
2209
def supports_set_append_revisions_only(self):
2212
def supports_stacking(self):
2215
def make_tags(self, branch):
2216
"""See bzrlib.branch.BranchFormat.make_tags()."""
2217
return _mod_tag.BasicTags(branch)
2219
supports_reference_locations = False
2222
class BranchReferenceFormat(BranchFormatMetadir):
2223
"""Bzr branch reference format.
2225
Branch references are used in implementing checkouts, they
2226
act as an alias to the real branch which is at some other url.
2234
def get_format_string(cls):
2235
"""See BranchFormat.get_format_string()."""
2236
return "Bazaar-NG Branch Reference Format 1\n"
2238
def get_format_description(self):
2239
"""See BranchFormat.get_format_description()."""
2240
return "Checkout reference format 1"
2242
def get_reference(self, a_bzrdir, name=None):
2243
"""See BranchFormat.get_reference()."""
2244
transport = a_bzrdir.get_branch_transport(None, name=name)
2245
return transport.get_bytes('location')
2247
def set_reference(self, a_bzrdir, name, to_branch):
2248
"""See BranchFormat.set_reference()."""
2249
transport = a_bzrdir.get_branch_transport(None, name=name)
2250
location = transport.put_bytes('location', to_branch.base)
2252
def initialize(self, a_bzrdir, name=None, target_branch=None,
2253
repository=None, append_revisions_only=None):
2254
"""Create a branch of this format in a_bzrdir."""
2255
if target_branch is None:
2256
# this format does not implement branch itself, thus the implicit
2257
# creation contract must see it as uninitializable
2258
raise errors.UninitializableFormat(self)
2259
mutter('creating branch reference in %s', a_bzrdir.user_url)
2260
if a_bzrdir._format.fixed_components:
2261
raise errors.IncompatibleFormat(self, a_bzrdir._format)
2263
name = a_bzrdir._get_selected_branch()
2264
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2265
branch_transport.put_bytes('location',
2266
target_branch.user_url)
2267
branch_transport.put_bytes('format', self.as_string())
2268
branch = self.open(a_bzrdir, name, _found=True,
2269
possible_transports=[target_branch.bzrdir.root_transport])
2270
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2273
def _make_reference_clone_function(format, a_branch):
2274
"""Create a clone() routine for a branch dynamically."""
2275
def clone(to_bzrdir, revision_id=None,
2276
repository_policy=None):
2277
"""See Branch.clone()."""
2278
return format.initialize(to_bzrdir, target_branch=a_branch)
2279
# cannot obey revision_id limits when cloning a reference ...
2280
# FIXME RBC 20060210 either nuke revision_id for clone, or
2281
# emit some sort of warning/error to the caller ?!
2284
def open(self, a_bzrdir, name=None, _found=False, location=None,
2285
possible_transports=None, ignore_fallbacks=False,
2286
found_repository=None):
2287
"""Return the branch that the branch reference in a_bzrdir points at.
2289
:param a_bzrdir: A BzrDir that contains a branch.
2290
:param name: Name of colocated branch to open, if any
2291
:param _found: a private parameter, do not use it. It is used to
2292
indicate if format probing has already be done.
2293
:param ignore_fallbacks: when set, no fallback branches will be opened
2294
(if there are any). Default is to open fallbacks.
2295
:param location: The location of the referenced branch. If
2296
unspecified, this will be determined from the branch reference in
2298
:param possible_transports: An optional reusable transports list.
2301
name = a_bzrdir._get_selected_branch()
2303
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2304
if format.__class__ != self.__class__:
2305
raise AssertionError("wrong format %r found for %r" %
2307
if location is None:
2308
location = self.get_reference(a_bzrdir, name)
2309
real_bzrdir = controldir.ControlDir.open(
2310
location, possible_transports=possible_transports)
2311
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks,
2312
possible_transports=possible_transports)
2313
# this changes the behaviour of result.clone to create a new reference
2314
# rather than a copy of the content of the branch.
2315
# I did not use a proxy object because that needs much more extensive
2316
# testing, and we are only changing one behaviour at the moment.
2317
# If we decide to alter more behaviours - i.e. the implicit nickname
2318
# then this should be refactored to introduce a tested proxy branch
2319
# and a subclass of that for use in overriding clone() and ....
2321
result.clone = self._make_reference_clone_function(result)
2325
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2326
"""Branch format registry."""
2328
def __init__(self, other_registry=None):
2329
super(BranchFormatRegistry, self).__init__(other_registry)
2330
self._default_format = None
2332
def set_default(self, format):
2333
self._default_format = format
2335
def get_default(self):
2336
return self._default_format
2339
network_format_registry = registry.FormatRegistry()
2340
"""Registry of formats indexed by their network name.
2342
The network name for a branch format is an identifier that can be used when
2343
referring to formats with smart server operations. See
2344
BranchFormat.network_name() for more detail.
2347
format_registry = BranchFormatRegistry(network_format_registry)
2350
# formats which have no format string are not discoverable
2351
# and not independently creatable, so are not registered.
2352
__format5 = BzrBranchFormat5()
2353
__format6 = BzrBranchFormat6()
2354
__format7 = BzrBranchFormat7()
2355
__format8 = BzrBranchFormat8()
2356
format_registry.register(__format5)
2357
format_registry.register(BranchReferenceFormat())
2358
format_registry.register(__format6)
2359
format_registry.register(__format7)
2360
format_registry.register(__format8)
2361
format_registry.set_default(__format7)
2364
class BranchWriteLockResult(LogicalLockResult):
2365
"""The result of write locking a branch.
2367
:ivar branch_token: The token obtained from the underlying branch lock, or
2369
:ivar unlock: A callable which will unlock the lock.
2372
def __init__(self, unlock, branch_token):
2373
LogicalLockResult.__init__(self, unlock)
2374
self.branch_token = branch_token
2377
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2381
class BzrBranch(Branch, _RelockDebugMixin):
2382
"""A branch stored in the actual filesystem.
2384
Note that it's "local" in the context of the filesystem; it doesn't
2385
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2386
it's writable, and can be accessed via the normal filesystem API.
2388
:ivar _transport: Transport for file operations on this branch's
2389
control files, typically pointing to the .bzr/branch directory.
2390
:ivar repository: Repository for this branch.
2391
:ivar base: The url of the base directory for this branch; the one
2392
containing the .bzr directory.
2393
:ivar name: Optional colocated branch name as it exists in the control
2397
def __init__(self, _format=None,
2398
_control_files=None, a_bzrdir=None, name=None,
2399
_repository=None, ignore_fallbacks=False,
2400
possible_transports=None):
2401
"""Create new branch object at a particular location."""
2402
if a_bzrdir is None:
2403
raise ValueError('a_bzrdir must be supplied')
2405
raise ValueError('name must be supplied')
2406
self.bzrdir = a_bzrdir
2407
self._user_transport = self.bzrdir.transport.clone('..')
2409
self._user_transport.set_segment_parameter(
2410
"branch", urlutils.escape(name))
2411
self._base = self._user_transport.base
2413
self._format = _format
2414
if _control_files is None:
2415
raise ValueError('BzrBranch _control_files is None')
2416
self.control_files = _control_files
2417
self._transport = _control_files._transport
2418
self.repository = _repository
2419
self.conf_store = None
2420
Branch.__init__(self, possible_transports)
2423
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2427
def _get_base(self):
2428
"""Returns the directory containing the control directory."""
2431
base = property(_get_base, doc="The URL for the root of this branch.")
2434
def user_transport(self):
2435
return self._user_transport
2437
def _get_config(self):
2438
return _mod_config.TransportConfig(self._transport, 'branch.conf')
2440
def _get_config_store(self):
2441
if self.conf_store is None:
2442
self.conf_store = _mod_config.BranchStore(self)
2443
return self.conf_store
2445
def is_locked(self):
2446
return self.control_files.is_locked()
2448
def lock_write(self, token=None):
2449
"""Lock the branch for write operations.
2451
:param token: A token to permit reacquiring a previously held and
2453
:return: A BranchWriteLockResult.
2455
if not self.is_locked():
2456
self._note_lock('w')
2457
# All-in-one needs to always unlock/lock.
2458
repo_control = getattr(self.repository, 'control_files', None)
2459
if self.control_files == repo_control or not self.is_locked():
2460
self.repository._warn_if_deprecated(self)
2461
self.repository.lock_write()
2466
return BranchWriteLockResult(self.unlock,
2467
self.control_files.lock_write(token=token))
2470
self.repository.unlock()
2473
def lock_read(self):
2474
"""Lock the branch for read operations.
2476
:return: A bzrlib.lock.LogicalLockResult.
2478
if not self.is_locked():
2479
self._note_lock('r')
2480
# All-in-one needs to always unlock/lock.
2481
repo_control = getattr(self.repository, 'control_files', None)
2482
if self.control_files == repo_control or not self.is_locked():
2483
self.repository._warn_if_deprecated(self)
2484
self.repository.lock_read()
2489
self.control_files.lock_read()
2490
return LogicalLockResult(self.unlock)
2493
self.repository.unlock()
2496
@only_raises(errors.LockNotHeld, errors.LockBroken)
2498
if self.conf_store is not None:
2499
self.conf_store.save_changes()
2501
self.control_files.unlock()
2503
# All-in-one needs to always unlock/lock.
2504
repo_control = getattr(self.repository, 'control_files', None)
2505
if (self.control_files == repo_control or
2506
not self.control_files.is_locked()):
2507
self.repository.unlock()
2508
if not self.control_files.is_locked():
2509
# we just released the lock
2510
self._clear_cached_state()
2512
def peek_lock_mode(self):
2513
if self.control_files._lock_count == 0:
2516
return self.control_files._lock_mode
2518
def get_physical_lock_status(self):
2519
return self.control_files.get_physical_lock_status()
2522
def print_file(self, file, revision_id):
2523
"""See Branch.print_file."""
2524
return self.repository.print_file(file, revision_id)
2527
def set_last_revision_info(self, revno, revision_id):
2528
if not revision_id or not isinstance(revision_id, basestring):
2529
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2530
revision_id = _mod_revision.ensure_null(revision_id)
2531
old_revno, old_revid = self.last_revision_info()
2532
if self.get_append_revisions_only():
2533
self._check_history_violation(revision_id)
2534
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2535
self._write_last_revision_info(revno, revision_id)
2536
self._clear_cached_state()
2537
self._last_revision_info_cache = revno, revision_id
2538
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2540
def basis_tree(self):
2541
"""See Branch.basis_tree."""
2542
return self.repository.revision_tree(self.last_revision())
2544
def _get_parent_location(self):
2545
_locs = ['parent', 'pull', 'x-pull']
2548
return self._transport.get_bytes(l).strip('\n')
2549
except errors.NoSuchFile:
2553
def get_stacked_on_url(self):
2554
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2556
def set_push_location(self, location):
2557
"""See Branch.set_push_location."""
2558
self.get_config().set_user_option(
2559
'push_location', location,
2560
store=_mod_config.STORE_LOCATION_NORECURSE)
2562
def _set_parent_location(self, url):
2564
self._transport.delete('parent')
2566
self._transport.put_bytes('parent', url + '\n',
2567
mode=self.bzrdir._get_file_mode())
2571
"""If bound, unbind"""
2572
return self.set_bound_location(None)
2575
def bind(self, other):
2576
"""Bind this branch to the branch other.
2578
This does not push or pull data between the branches, though it does
2579
check for divergence to raise an error when the branches are not
2580
either the same, or one a prefix of the other. That behaviour may not
2581
be useful, so that check may be removed in future.
2583
:param other: The branch to bind to
2586
# TODO: jam 20051230 Consider checking if the target is bound
2587
# It is debatable whether you should be able to bind to
2588
# a branch which is itself bound.
2589
# Committing is obviously forbidden,
2590
# but binding itself may not be.
2591
# Since we *have* to check at commit time, we don't
2592
# *need* to check here
2594
# we want to raise diverged if:
2595
# last_rev is not in the other_last_rev history, AND
2596
# other_last_rev is not in our history, and do it without pulling
2598
self.set_bound_location(other.base)
2600
def get_bound_location(self):
2602
return self._transport.get_bytes('bound')[:-1]
2603
except errors.NoSuchFile:
2607
def get_master_branch(self, possible_transports=None):
2608
"""Return the branch we are bound to.
2610
:return: Either a Branch, or None
2612
if self._master_branch_cache is None:
2613
self._master_branch_cache = self._get_master_branch(
2614
possible_transports)
2615
return self._master_branch_cache
2617
def _get_master_branch(self, possible_transports):
2618
bound_loc = self.get_bound_location()
2622
return Branch.open(bound_loc,
2623
possible_transports=possible_transports)
2624
except (errors.NotBranchError, errors.ConnectionError), e:
2625
raise errors.BoundBranchConnectionFailure(
2629
def set_bound_location(self, location):
2630
"""Set the target where this branch is bound to.
2632
:param location: URL to the target branch
2634
self._master_branch_cache = None
2636
self._transport.put_bytes('bound', location+'\n',
2637
mode=self.bzrdir._get_file_mode())
2640
self._transport.delete('bound')
2641
except errors.NoSuchFile:
2646
def update(self, possible_transports=None):
2647
"""Synchronise this branch with the master branch if any.
2649
:return: None or the last_revision that was pivoted out during the
2652
master = self.get_master_branch(possible_transports)
2653
if master is not None:
2654
old_tip = _mod_revision.ensure_null(self.last_revision())
2655
self.pull(master, overwrite=True)
2656
if self.repository.get_graph().is_ancestor(old_tip,
2657
_mod_revision.ensure_null(self.last_revision())):
2662
def _read_last_revision_info(self):
2663
revision_string = self._transport.get_bytes('last-revision')
2664
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2665
revision_id = cache_utf8.get_cached_utf8(revision_id)
2667
return revno, revision_id
2669
def _write_last_revision_info(self, revno, revision_id):
2670
"""Simply write out the revision id, with no checks.
2672
Use set_last_revision_info to perform this safely.
2674
Does not update the revision_history cache.
2676
revision_id = _mod_revision.ensure_null(revision_id)
2677
out_string = '%d %s\n' % (revno, revision_id)
2678
self._transport.put_bytes('last-revision', out_string,
2679
mode=self.bzrdir._get_file_mode())
2682
def update_feature_flags(self, updated_flags):
2683
"""Update the feature flags for this branch.
2685
:param updated_flags: Dictionary mapping feature names to necessities
2686
A necessity can be None to indicate the feature should be removed
2688
self._format._update_feature_flags(updated_flags)
2689
self.control_transport.put_bytes('format', self._format.as_string())
2692
class FullHistoryBzrBranch(BzrBranch):
2693
"""Bzr branch which contains the full revision history."""
2696
def set_last_revision_info(self, revno, revision_id):
2697
if not revision_id or not isinstance(revision_id, basestring):
2698
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2699
revision_id = _mod_revision.ensure_null(revision_id)
2700
# this old format stores the full history, but this api doesn't
2701
# provide it, so we must generate, and might as well check it's
2703
history = self._lefthand_history(revision_id)
2704
if len(history) != revno:
2705
raise AssertionError('%d != %d' % (len(history), revno))
2706
self._set_revision_history(history)
2708
def _read_last_revision_info(self):
2709
rh = self._revision_history()
2712
return (revno, rh[-1])
2714
return (0, _mod_revision.NULL_REVISION)
2716
def _set_revision_history(self, rev_history):
2717
if 'evil' in debug.debug_flags:
2718
mutter_callsite(3, "set_revision_history scales with history.")
2719
check_not_reserved_id = _mod_revision.check_not_reserved_id
2720
for rev_id in rev_history:
2721
check_not_reserved_id(rev_id)
2722
if Branch.hooks['post_change_branch_tip']:
2723
# Don't calculate the last_revision_info() if there are no hooks
2725
old_revno, old_revid = self.last_revision_info()
2726
if len(rev_history) == 0:
2727
revid = _mod_revision.NULL_REVISION
2729
revid = rev_history[-1]
2730
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2731
self._write_revision_history(rev_history)
2732
self._clear_cached_state()
2733
self._cache_revision_history(rev_history)
2734
if Branch.hooks['post_change_branch_tip']:
2735
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2737
def _write_revision_history(self, history):
2738
"""Factored out of set_revision_history.
2740
This performs the actual writing to disk.
2741
It is intended to be called by set_revision_history."""
2742
self._transport.put_bytes(
2743
'revision-history', '\n'.join(history),
2744
mode=self.bzrdir._get_file_mode())
2746
def _gen_revision_history(self):
2747
history = self._transport.get_bytes('revision-history').split('\n')
2748
if history[-1:] == ['']:
2749
# There shouldn't be a trailing newline, but just in case.
2753
def _synchronize_history(self, destination, revision_id):
2754
if not isinstance(destination, FullHistoryBzrBranch):
2755
super(BzrBranch, self)._synchronize_history(
2756
destination, revision_id)
2758
if revision_id == _mod_revision.NULL_REVISION:
2761
new_history = self._revision_history()
2762
if revision_id is not None and new_history != []:
2764
new_history = new_history[:new_history.index(revision_id) + 1]
2766
rev = self.repository.get_revision(revision_id)
2767
new_history = rev.get_history(self.repository)[1:]
2768
destination._set_revision_history(new_history)
2771
def generate_revision_history(self, revision_id, last_rev=None,
2773
"""Create a new revision history that will finish with revision_id.
2775
:param revision_id: the new tip to use.
2776
:param last_rev: The previous last_revision. If not None, then this
2777
must be a ancestory of revision_id, or DivergedBranches is raised.
2778
:param other_branch: The other branch that DivergedBranches should
2779
raise with respect to.
2781
self._set_revision_history(self._lefthand_history(revision_id,
2782
last_rev, other_branch))
2785
class BzrBranch5(FullHistoryBzrBranch):
2786
"""A format 5 branch. This supports new features over plain branches.
2788
It has support for a master_branch which is the data for bound branches.
2792
class BzrBranch8(BzrBranch):
2793
"""A branch that stores tree-reference locations."""
2795
def _open_hook(self, possible_transports=None):
2796
if self._ignore_fallbacks:
2798
if possible_transports is None:
2799
possible_transports = [self.bzrdir.root_transport]
2801
url = self.get_stacked_on_url()
2802
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2803
errors.UnstackableBranchFormat):
2806
for hook in Branch.hooks['transform_fallback_location']:
2807
url = hook(self, url)
2809
hook_name = Branch.hooks.get_hook_name(hook)
2810
raise AssertionError(
2811
"'transform_fallback_location' hook %s returned "
2812
"None, not a URL." % hook_name)
2813
self._activate_fallback_location(url,
2814
possible_transports=possible_transports)
2816
def __init__(self, *args, **kwargs):
2817
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2818
super(BzrBranch8, self).__init__(*args, **kwargs)
2819
self._last_revision_info_cache = None
2820
self._reference_info = None
2822
def _clear_cached_state(self):
2823
super(BzrBranch8, self)._clear_cached_state()
2824
self._last_revision_info_cache = None
2825
self._reference_info = None
2827
def _check_history_violation(self, revision_id):
2828
current_revid = self.last_revision()
2829
last_revision = _mod_revision.ensure_null(current_revid)
2830
if _mod_revision.is_null(last_revision):
2832
graph = self.repository.get_graph()
2833
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2834
if lh_ancestor == current_revid:
2836
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2838
def _gen_revision_history(self):
2839
"""Generate the revision history from last revision
2841
last_revno, last_revision = self.last_revision_info()
2842
self._extend_partial_history(stop_index=last_revno-1)
2843
return list(reversed(self._partial_revision_history_cache))
2846
def _set_parent_location(self, url):
2847
"""Set the parent branch"""
2848
self._set_config_location('parent_location', url, make_relative=True)
2851
def _get_parent_location(self):
2852
"""Set the parent branch"""
2853
return self._get_config_location('parent_location')
2856
def _set_all_reference_info(self, info_dict):
2857
"""Replace all reference info stored in a branch.
2859
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2862
writer = rio.RioWriter(s)
2863
for key, (tree_path, branch_location) in info_dict.iteritems():
2864
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2865
branch_location=branch_location)
2866
writer.write_stanza(stanza)
2867
self._transport.put_bytes('references', s.getvalue())
2868
self._reference_info = info_dict
2871
def _get_all_reference_info(self):
2872
"""Return all the reference info stored in a branch.
2874
:return: A dict of {file_id: (tree_path, branch_location)}
2876
if self._reference_info is not None:
2877
return self._reference_info
2878
rio_file = self._transport.get('references')
2880
stanzas = rio.read_stanzas(rio_file)
2881
info_dict = dict((s['file_id'], (s['tree_path'],
2882
s['branch_location'])) for s in stanzas)
2885
self._reference_info = info_dict
2888
def set_reference_info(self, file_id, tree_path, branch_location):
2889
"""Set the branch location to use for a tree reference.
2891
:param file_id: The file-id of the tree reference.
2892
:param tree_path: The path of the tree reference in the tree.
2893
:param branch_location: The location of the branch to retrieve tree
2896
info_dict = self._get_all_reference_info()
2897
info_dict[file_id] = (tree_path, branch_location)
2898
if None in (tree_path, branch_location):
2899
if tree_path is not None:
2900
raise ValueError('tree_path must be None when branch_location'
2902
if branch_location is not None:
2903
raise ValueError('branch_location must be None when tree_path'
2905
del info_dict[file_id]
2906
self._set_all_reference_info(info_dict)
2908
def get_reference_info(self, file_id):
2909
"""Get the tree_path and branch_location for a tree reference.
2911
:return: a tuple of (tree_path, branch_location)
2913
return self._get_all_reference_info().get(file_id, (None, None))
2915
def reference_parent(self, file_id, path, possible_transports=None):
2916
"""Return the parent branch for a tree-reference file_id.
2918
:param file_id: The file_id of the tree reference
2919
:param path: The path of the file_id in the tree
2920
:return: A branch associated with the file_id
2922
branch_location = self.get_reference_info(file_id)[1]
2923
if branch_location is None:
2924
return Branch.reference_parent(self, file_id, path,
2925
possible_transports)
2926
branch_location = urlutils.join(self.user_url, branch_location)
2927
return Branch.open(branch_location,
2928
possible_transports=possible_transports)
2930
def set_push_location(self, location):
2931
"""See Branch.set_push_location."""
2932
self._set_config_location('push_location', location)
2934
def set_bound_location(self, location):
2935
"""See Branch.set_push_location."""
2936
self._master_branch_cache = None
2938
conf = self.get_config_stack()
2939
if location is None:
2940
if not conf.get('bound'):
2943
conf.set('bound', 'False')
2946
self._set_config_location('bound_location', location,
2948
conf.set('bound', 'True')
2951
def _get_bound_location(self, bound):
2952
"""Return the bound location in the config file.
2954
Return None if the bound parameter does not match"""
2955
conf = self.get_config_stack()
2956
if conf.get('bound') != bound:
2958
return self._get_config_location('bound_location', config=conf)
2960
def get_bound_location(self):
2961
"""See Branch.get_bound_location."""
2962
return self._get_bound_location(True)
2964
def get_old_bound_location(self):
2965
"""See Branch.get_old_bound_location"""
2966
return self._get_bound_location(False)
2968
def get_stacked_on_url(self):
2969
# you can always ask for the URL; but you might not be able to use it
2970
# if the repo can't support stacking.
2971
## self._check_stackable_repo()
2972
# stacked_on_location is only ever defined in branch.conf, so don't
2973
# waste effort reading the whole stack of config files.
2974
conf = _mod_config.BranchOnlyStack(self)
2975
stacked_url = self._get_config_location('stacked_on_location',
2977
if stacked_url is None:
2978
raise errors.NotStacked(self)
2979
return stacked_url.encode('utf-8')
2982
def get_rev_id(self, revno, history=None):
2983
"""Find the revision id of the specified revno."""
2985
return _mod_revision.NULL_REVISION
2987
last_revno, last_revision_id = self.last_revision_info()
2988
if revno <= 0 or revno > last_revno:
2989
raise errors.NoSuchRevision(self, revno)
2991
if history is not None:
2992
return history[revno - 1]
2994
index = last_revno - revno
2995
if len(self._partial_revision_history_cache) <= index:
2996
self._extend_partial_history(stop_index=index)
2997
if len(self._partial_revision_history_cache) > index:
2998
return self._partial_revision_history_cache[index]
3000
raise errors.NoSuchRevision(self, revno)
3003
def revision_id_to_revno(self, revision_id):
3004
"""Given a revision id, return its revno"""
3005
if _mod_revision.is_null(revision_id):
3008
index = self._partial_revision_history_cache.index(revision_id)
3011
self._extend_partial_history(stop_revision=revision_id)
3012
except errors.RevisionNotPresent, e:
3013
raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
3014
index = len(self._partial_revision_history_cache) - 1
3016
raise errors.NoSuchRevision(self, revision_id)
3017
if self._partial_revision_history_cache[index] != revision_id:
3018
raise errors.NoSuchRevision(self, revision_id)
3019
return self.revno() - index
3022
class BzrBranch7(BzrBranch8):
3023
"""A branch with support for a fallback repository."""
3025
def set_reference_info(self, file_id, tree_path, branch_location):
3026
Branch.set_reference_info(self, file_id, tree_path, branch_location)
3028
def get_reference_info(self, file_id):
3029
Branch.get_reference_info(self, file_id)
3031
def reference_parent(self, file_id, path, possible_transports=None):
3032
return Branch.reference_parent(self, file_id, path,
3033
possible_transports)
3036
class BzrBranch6(BzrBranch7):
3037
"""See BzrBranchFormat6 for the capabilities of this branch.
3039
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
3043
def get_stacked_on_url(self):
3044
raise errors.UnstackableBranchFormat(self._format, self.user_url)
3047
######################################################################
3048
# results of operations
3051
class _Result(object):
3053
def _show_tag_conficts(self, to_file):
3054
if not getattr(self, 'tag_conflicts', None):
3056
to_file.write('Conflicting tags:\n')
3057
for name, value1, value2 in self.tag_conflicts:
3058
to_file.write(' %s\n' % (name, ))
3061
class PullResult(_Result):
3062
"""Result of a Branch.pull operation.
3064
:ivar old_revno: Revision number before pull.
3065
:ivar new_revno: Revision number after pull.
3066
:ivar old_revid: Tip revision id before pull.
3067
:ivar new_revid: Tip revision id after pull.
3068
:ivar source_branch: Source (local) branch object. (read locked)
3069
:ivar master_branch: Master branch of the target, or the target if no
3071
:ivar local_branch: target branch if there is a Master, else None
3072
:ivar target_branch: Target/destination branch object. (write locked)
3073
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3074
:ivar tag_updates: A dict with new tags, see BasicTags.merge_to
3077
def report(self, to_file):
3078
tag_conflicts = getattr(self, "tag_conflicts", None)
3079
tag_updates = getattr(self, "tag_updates", None)
3081
if self.old_revid != self.new_revid:
3082
to_file.write('Now on revision %d.\n' % self.new_revno)
3084
to_file.write('%d tag(s) updated.\n' % len(tag_updates))
3085
if self.old_revid == self.new_revid and not tag_updates:
3086
if not tag_conflicts:
3087
to_file.write('No revisions or tags to pull.\n')
3089
to_file.write('No revisions to pull.\n')
3090
self._show_tag_conficts(to_file)
3093
class BranchPushResult(_Result):
3094
"""Result of a Branch.push operation.
3096
:ivar old_revno: Revision number (eg 10) of the target before push.
3097
:ivar new_revno: Revision number (eg 12) of the target after push.
3098
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3100
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3102
:ivar source_branch: Source branch object that the push was from. This is
3103
read locked, and generally is a local (and thus low latency) branch.
3104
:ivar master_branch: If target is a bound branch, the master branch of
3105
target, or target itself. Always write locked.
3106
:ivar target_branch: The direct Branch where data is being sent (write
3108
:ivar local_branch: If the target is a bound branch this will be the
3109
target, otherwise it will be None.
3112
def report(self, to_file):
3113
# TODO: This function gets passed a to_file, but then
3114
# ignores it and calls note() instead. This is also
3115
# inconsistent with PullResult(), which writes to stdout.
3116
# -- JRV20110901, bug #838853
3117
tag_conflicts = getattr(self, "tag_conflicts", None)
3118
tag_updates = getattr(self, "tag_updates", None)
3120
if self.old_revid != self.new_revid:
3121
note(gettext('Pushed up to revision %d.') % self.new_revno)
3123
note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
3124
if self.old_revid == self.new_revid and not tag_updates:
3125
if not tag_conflicts:
3126
note(gettext('No new revisions or tags to push.'))
3128
note(gettext('No new revisions to push.'))
3129
self._show_tag_conficts(to_file)
3132
class BranchCheckResult(object):
3133
"""Results of checking branch consistency.
3138
def __init__(self, branch):
3139
self.branch = branch
3142
def report_results(self, verbose):
3143
"""Report the check results via trace.note.
3145
:param verbose: Requests more detailed display of what was checked,
3148
note(gettext('checked branch {0} format {1}').format(
3149
self.branch.user_url, self.branch._format))
3150
for error in self.errors:
3151
note(gettext('found error:%s'), error)
3154
class Converter5to6(object):
3155
"""Perform an in-place upgrade of format 5 to format 6"""
3157
def convert(self, branch):
3158
# Data for 5 and 6 can peacefully coexist.
3159
format = BzrBranchFormat6()
3160
new_branch = format.open(branch.bzrdir, _found=True)
3162
# Copy source data into target
3163
new_branch._write_last_revision_info(*branch.last_revision_info())
3164
new_branch.lock_write()
3166
new_branch.set_parent(branch.get_parent())
3167
new_branch.set_bound_location(branch.get_bound_location())
3168
new_branch.set_push_location(branch.get_push_location())
3172
# New branch has no tags by default
3173
new_branch.tags._set_tag_dict({})
3175
# Copying done; now update target format
3176
new_branch._transport.put_bytes('format',
3178
mode=new_branch.bzrdir._get_file_mode())
3180
# Clean up old files
3181
new_branch._transport.delete('revision-history')
3185
branch.set_parent(None)
3186
except errors.NoSuchFile:
3188
branch.set_bound_location(None)
3193
class Converter6to7(object):
3194
"""Perform an in-place upgrade of format 6 to format 7"""
3196
def convert(self, branch):
3197
format = BzrBranchFormat7()
3198
branch._set_config_location('stacked_on_location', '')
3199
# update target format
3200
branch._transport.put_bytes('format', format.as_string())
3203
class Converter7to8(object):
3204
"""Perform an in-place upgrade of format 7 to format 8"""
3206
def convert(self, branch):
3207
format = BzrBranchFormat8()
3208
branch._transport.put_bytes('references', '')
3209
# update target format
3210
branch._transport.put_bytes('format', format.as_string())
3213
class InterBranch(InterObject):
3214
"""This class represents operations taking place between two branches.
3216
Its instances have methods like pull() and push() and contain
3217
references to the source and target repositories these operations
3218
can be carried out on.
3222
"""The available optimised InterBranch types."""
3225
def _get_branch_formats_to_test(klass):
3226
"""Return an iterable of format tuples for testing.
3228
:return: An iterable of (from_format, to_format) to use when testing
3229
this InterBranch class. Each InterBranch class should define this
3232
raise NotImplementedError(klass._get_branch_formats_to_test)
3235
def pull(self, overwrite=False, stop_revision=None,
3236
possible_transports=None, local=False):
3237
"""Mirror source into target branch.
3239
The target branch is considered to be 'local', having low latency.
3241
:returns: PullResult instance
3243
raise NotImplementedError(self.pull)
3246
def push(self, overwrite=False, stop_revision=None, lossy=False,
3247
_override_hook_source_branch=None):
3248
"""Mirror the source branch into the target branch.
3250
The source branch is considered to be 'local', having low latency.
3252
raise NotImplementedError(self.push)
3255
def copy_content_into(self, revision_id=None):
3256
"""Copy the content of source into target
3258
revision_id: if not None, the revision history in the new branch will
3259
be truncated to end with revision_id.
3261
raise NotImplementedError(self.copy_content_into)
3264
def fetch(self, stop_revision=None, limit=None):
3267
:param stop_revision: Last revision to fetch
3268
:param limit: Optional rough limit of revisions to fetch
3270
raise NotImplementedError(self.fetch)
3273
class GenericInterBranch(InterBranch):
3274
"""InterBranch implementation that uses public Branch functions."""
3277
def is_compatible(klass, source, target):
3278
# GenericBranch uses the public API, so always compatible
3282
def _get_branch_formats_to_test(klass):
3283
return [(format_registry.get_default(), format_registry.get_default())]
3286
def unwrap_format(klass, format):
3287
if isinstance(format, remote.RemoteBranchFormat):
3288
format._ensure_real()
3289
return format._custom_format
3293
def copy_content_into(self, revision_id=None):
3294
"""Copy the content of source into target
3296
revision_id: if not None, the revision history in the new branch will
3297
be truncated to end with revision_id.
3299
self.source.update_references(self.target)
3300
self.source._synchronize_history(self.target, revision_id)
3302
parent = self.source.get_parent()
3303
except errors.InaccessibleParent, e:
3304
mutter('parent was not accessible to copy: %s', e)
3307
self.target.set_parent(parent)
3308
if self.source._push_should_merge_tags():
3309
self.source.tags.merge_to(self.target.tags)
3312
def fetch(self, stop_revision=None, limit=None):
3313
if self.target.base == self.source.base:
3315
self.source.lock_read()
3317
fetch_spec_factory = fetch.FetchSpecFactory()
3318
fetch_spec_factory.source_branch = self.source
3319
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3320
fetch_spec_factory.source_repo = self.source.repository
3321
fetch_spec_factory.target_repo = self.target.repository
3322
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3323
fetch_spec_factory.limit = limit
3324
fetch_spec = fetch_spec_factory.make_fetch_spec()
3325
return self.target.repository.fetch(self.source.repository,
3326
fetch_spec=fetch_spec)
3328
self.source.unlock()
3331
def _update_revisions(self, stop_revision=None, overwrite=False,
3333
other_revno, other_last_revision = self.source.last_revision_info()
3334
stop_revno = None # unknown
3335
if stop_revision is None:
3336
stop_revision = other_last_revision
3337
if _mod_revision.is_null(stop_revision):
3338
# if there are no commits, we're done.
3340
stop_revno = other_revno
3342
# what's the current last revision, before we fetch [and change it
3344
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3345
# we fetch here so that we don't process data twice in the common
3346
# case of having something to pull, and so that the check for
3347
# already merged can operate on the just fetched graph, which will
3348
# be cached in memory.
3349
self.fetch(stop_revision=stop_revision)
3350
# Check to see if one is an ancestor of the other
3353
graph = self.target.repository.get_graph()
3354
if self.target._check_if_descendant_or_diverged(
3355
stop_revision, last_rev, graph, self.source):
3356
# stop_revision is a descendant of last_rev, but we aren't
3357
# overwriting, so we're done.
3359
if stop_revno is None:
3361
graph = self.target.repository.get_graph()
3362
this_revno, this_last_revision = \
3363
self.target.last_revision_info()
3364
stop_revno = graph.find_distance_to_null(stop_revision,
3365
[(other_last_revision, other_revno),
3366
(this_last_revision, this_revno)])
3367
self.target.set_last_revision_info(stop_revno, stop_revision)
3370
def pull(self, overwrite=False, stop_revision=None,
3371
possible_transports=None, run_hooks=True,
3372
_override_hook_target=None, local=False):
3373
"""Pull from source into self, updating my master if any.
3375
:param run_hooks: Private parameter - if false, this branch
3376
is being called because it's the master of the primary branch,
3377
so it should not run its hooks.
3379
bound_location = self.target.get_bound_location()
3380
if local and not bound_location:
3381
raise errors.LocalRequiresBoundBranch()
3382
master_branch = None
3383
source_is_master = False
3385
# bound_location comes from a config file, some care has to be
3386
# taken to relate it to source.user_url
3387
normalized = urlutils.normalize_url(bound_location)
3389
relpath = self.source.user_transport.relpath(normalized)
3390
source_is_master = (relpath == '')
3391
except (errors.PathNotChild, errors.InvalidURL):
3392
source_is_master = False
3393
if not local and bound_location and not source_is_master:
3394
# not pulling from master, so we need to update master.
3395
master_branch = self.target.get_master_branch(possible_transports)
3396
master_branch.lock_write()
3399
# pull from source into master.
3400
master_branch.pull(self.source, overwrite, stop_revision,
3402
return self._pull(overwrite,
3403
stop_revision, _hook_master=master_branch,
3404
run_hooks=run_hooks,
3405
_override_hook_target=_override_hook_target,
3406
merge_tags_to_master=not source_is_master)
3409
master_branch.unlock()
3411
def push(self, overwrite=False, stop_revision=None, lossy=False,
3412
_override_hook_source_branch=None):
3413
"""See InterBranch.push.
3415
This is the basic concrete implementation of push()
3417
:param _override_hook_source_branch: If specified, run the hooks
3418
passing this Branch as the source, rather than self. This is for
3419
use of RemoteBranch, where push is delegated to the underlying
3423
raise errors.LossyPushToSameVCS(self.source, self.target)
3424
# TODO: Public option to disable running hooks - should be trivial but
3427
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3428
op.add_cleanup(self.source.lock_read().unlock)
3429
op.add_cleanup(self.target.lock_write().unlock)
3430
return op.run(overwrite, stop_revision,
3431
_override_hook_source_branch=_override_hook_source_branch)
3433
def _basic_push(self, overwrite, stop_revision):
3434
"""Basic implementation of push without bound branches or hooks.
3436
Must be called with source read locked and target write locked.
3438
result = BranchPushResult()
3439
result.source_branch = self.source
3440
result.target_branch = self.target
3441
result.old_revno, result.old_revid = self.target.last_revision_info()
3442
self.source.update_references(self.target)
3443
if result.old_revid != stop_revision:
3444
# We assume that during 'push' this repository is closer than
3446
graph = self.source.repository.get_graph(self.target.repository)
3447
self._update_revisions(stop_revision, overwrite=overwrite,
3449
if self.source._push_should_merge_tags():
3450
result.tag_updates, result.tag_conflicts = (
3451
self.source.tags.merge_to(self.target.tags, overwrite))
3452
result.new_revno, result.new_revid = self.target.last_revision_info()
3455
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3456
_override_hook_source_branch=None):
3457
"""Push from source into target, and into target's master if any.
3460
if _override_hook_source_branch:
3461
result.source_branch = _override_hook_source_branch
3462
for hook in Branch.hooks['post_push']:
3465
bound_location = self.target.get_bound_location()
3466
if bound_location and self.target.base != bound_location:
3467
# there is a master branch.
3469
# XXX: Why the second check? Is it even supported for a branch to
3470
# be bound to itself? -- mbp 20070507
3471
master_branch = self.target.get_master_branch()
3472
master_branch.lock_write()
3473
operation.add_cleanup(master_branch.unlock)
3474
# push into the master from the source branch.
3475
master_inter = InterBranch.get(self.source, master_branch)
3476
master_inter._basic_push(overwrite, stop_revision)
3477
# and push into the target branch from the source. Note that
3478
# we push from the source branch again, because it's considered
3479
# the highest bandwidth repository.
3480
result = self._basic_push(overwrite, stop_revision)
3481
result.master_branch = master_branch
3482
result.local_branch = self.target
3484
master_branch = None
3486
result = self._basic_push(overwrite, stop_revision)
3487
# TODO: Why set master_branch and local_branch if there's no
3488
# binding? Maybe cleaner to just leave them unset? -- mbp
3490
result.master_branch = self.target
3491
result.local_branch = None
3495
def _pull(self, overwrite=False, stop_revision=None,
3496
possible_transports=None, _hook_master=None, run_hooks=True,
3497
_override_hook_target=None, local=False,
3498
merge_tags_to_master=True):
3501
This function is the core worker, used by GenericInterBranch.pull to
3502
avoid duplication when pulling source->master and source->local.
3504
:param _hook_master: Private parameter - set the branch to
3505
be supplied as the master to pull hooks.
3506
:param run_hooks: Private parameter - if false, this branch
3507
is being called because it's the master of the primary branch,
3508
so it should not run its hooks.
3509
is being called because it's the master of the primary branch,
3510
so it should not run its hooks.
3511
:param _override_hook_target: Private parameter - set the branch to be
3512
supplied as the target_branch to pull hooks.
3513
:param local: Only update the local branch, and not the bound branch.
3515
# This type of branch can't be bound.
3517
raise errors.LocalRequiresBoundBranch()
3518
result = PullResult()
3519
result.source_branch = self.source
3520
if _override_hook_target is None:
3521
result.target_branch = self.target
3523
result.target_branch = _override_hook_target
3524
self.source.lock_read()
3526
# We assume that during 'pull' the target repository is closer than
3528
self.source.update_references(self.target)
3529
graph = self.target.repository.get_graph(self.source.repository)
3530
# TODO: Branch formats should have a flag that indicates
3531
# that revno's are expensive, and pull() should honor that flag.
3533
result.old_revno, result.old_revid = \
3534
self.target.last_revision_info()
3535
self._update_revisions(stop_revision, overwrite=overwrite,
3537
# TODO: The old revid should be specified when merging tags,
3538
# so a tags implementation that versions tags can only
3539
# pull in the most recent changes. -- JRV20090506
3540
result.tag_updates, result.tag_conflicts = (
3541
self.source.tags.merge_to(self.target.tags, overwrite,
3542
ignore_master=not merge_tags_to_master))
3543
result.new_revno, result.new_revid = self.target.last_revision_info()
3545
result.master_branch = _hook_master
3546
result.local_branch = result.target_branch
3548
result.master_branch = result.target_branch
3549
result.local_branch = None
3551
for hook in Branch.hooks['post_pull']:
3554
self.source.unlock()
3558
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
