13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
18
21
from cStringIO import StringIO
20
23
from bzrlib.lazy_import import lazy_import
21
24
lazy_import(globals(), """
22
from warnings import warn
25
26
from bzrlib import (
28
config as _mod_config,
33
revision as _mod_revision,
40
from bzrlib.config import BranchConfig, TreeConfig
41
from bzrlib.lockable_files import LockableFiles, TransportLock
42
from bzrlib.tag import (
31
config as _mod_config,
40
revision as _mod_revision,
48
from bzrlib.i18n import gettext, ngettext
48
from bzrlib.decorators import needs_read_lock, needs_write_lock
49
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
50
HistoryMissing, InvalidRevisionId,
51
InvalidRevisionNumber, LockError, NoSuchFile,
52
NoSuchRevision, NotVersionedError,
53
NotBranchError, UninitializableFormat,
54
UnlistableStore, UnlistableBranch,
51
# Explicitly import bzrlib.bzrdir so that the BzrProber
52
# is guaranteed to be registered.
59
from bzrlib.decorators import (
56
64
from bzrlib.hooks import Hooks
57
from bzrlib.symbol_versioning import (deprecated_function,
61
zero_eight, zero_nine, zero_sixteen,
64
from bzrlib.trace import mutter, note
67
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
68
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
69
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
72
# TODO: Maybe include checks for common corruption of newlines, etc?
74
# TODO: Some operations like log might retrieve the same revisions
75
# repeatedly to calculate deltas. We could perhaps have a weakref
76
# cache in memory to make this faster. In general anything can be
77
# cached in memory between lock and unlock operations. .. nb thats
78
# what the transaction identity map provides
81
######################################################################
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):
85
76
"""Branch holding a history of revisions.
88
Base directory/url of the branch.
90
hooks: An instance of BranchHooks.
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
92
85
# this is really an instance variable - FIXME move it there
96
# override this to set the strategy for storing tags
98
return DisabledTags(self)
100
def __init__(self, *ignored, **ignored_too):
101
self.tags = self._make_tags()
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)
102
99
self._revision_history_cache = None
103
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)
105
129
def break_lock(self):
106
130
"""Break a lock if one is present from another instance.
116
140
if master is not None:
117
141
master.break_lock()
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)]
120
def open(base, _unsupported=False):
178
def open(base, _unsupported=False, possible_transports=None):
121
179
"""Open the branch rooted at base.
123
181
For instance, if the branch is at URL/.bzr/branch,
124
182
Branch.open(URL) -> a Branch instance.
126
control = bzrdir.BzrDir.open(base, _unsupported)
127
return control.open_branch(_unsupported)
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)
130
def open_from_transport(transport, _unsupported=False):
190
def open_from_transport(transport, name=None, _unsupported=False,
191
possible_transports=None):
131
192
"""Open the branch rooted at transport"""
132
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
133
return control.open_branch(_unsupported)
193
control = controldir.ControlDir.open_from_transport(transport, _unsupported)
194
return control.open_branch(name=name, unsupported=_unsupported,
195
possible_transports=possible_transports)
136
198
def open_containing(url, possible_transports=None):
137
199
"""Open an existing branch which contains url.
139
201
This probes for a branch at url, and searches upwards from there.
141
203
Basically we keep looking up until we find the control directory or
142
204
run into the root. If there isn't one, raises NotBranchError.
143
If there is one and it is either an unrecognised format or an unsupported
205
If there is one and it is either an unrecognised format or an unsupported
144
206
format, UnknownFormatError or UnsupportedFormatError are raised.
145
207
If there is one, it is returned, along with the unused portion of url.
147
control, relpath = bzrdir.BzrDir.open_containing(url,
209
control, relpath = controldir.ControlDir.open_containing(url,
148
210
possible_transports)
149
return control.open_branch(), relpath
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()
151
222
def get_config(self):
152
return BranchConfig(self)
155
return self.get_config().get_nickname()
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()
157
297
def _set_nick(self, nick):
158
298
self.get_config().set_user_option('nickname', nick, warn_masked=True)
209
450
:return: A dictionary mapping revision_id => dotted revno.
211
last_revision = self.last_revision()
212
revision_graph = self.repository.get_revision_graph(last_revision)
213
merge_sorted_revisions = tsort.merge_sort(
218
452
revision_id_to_revno = dict((rev_id, revno)
219
for seq_num, rev_id, depth, revno, end_of_merge
220
in merge_sorted_revisions)
453
for rev_id, depth, revno, end_of_merge
454
in self.iter_merge_sorted_revisions())
221
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)
223
644
def leave_lock_in_place(self):
224
645
"""Tell this branch object not to release the physical lock when this
225
646
object is unlocked.
227
648
If lock_write doesn't return a token, then this method is not supported.
229
650
self.control_files.leave_in_place()
312
722
:param committer: Optional committer to set for commit.
313
723
:param revprops: Optional dictionary of revision properties.
314
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
318
config = self.get_config()
320
return self.repository.get_commit_builder(self, parents, config,
321
timestamp, timezone, committer, revprops, revision_id)
323
def get_master_branch(self):
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):
324
737
"""Return the branch we are bound to.
326
739
:return: Either a Branch, or None
743
@deprecated_method(deprecated_in((2, 5, 0)))
330
744
def get_revision_delta(self, revno):
331
745
"""Return the delta for one revision.
333
747
The delta is relative to its mainline predecessor, or the
334
748
empty tree for revision 1.
336
assert isinstance(revno, int)
337
rh = self.revision_history()
338
if not (1 <= revno <= len(rh)):
339
raise InvalidRevisionNumber(revno)
340
return self.repository.get_revision_delta(rh[revno-1])
342
@deprecated_method(zero_sixteen)
343
def get_root_id(self):
344
"""Return the id of this branches root
346
Deprecated: branches don't have root ids-- trees do.
347
Use basis_tree().get_root_id() instead.
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
349
raise NotImplementedError(self.get_root_id)
763
raise NotImplementedError(self.get_stacked_on_url)
351
765
def print_file(self, file, revision_id):
352
766
"""Print `file` to stdout."""
353
767
raise NotImplementedError(self.print_file)
355
def set_revision_history(self, rev_history):
356
raise NotImplementedError(self.set_revision_history)
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)
358
946
def _cache_revision_history(self, rev_history):
359
947
"""Set the cached revision history to rev_history.
421
1011
That is equivalent to the number of revisions committed to
424
return len(self.revision_history())
1014
return self.last_revision_info()[0]
426
1016
def unbind(self):
427
1017
"""Older format branches cannot bind or unbind."""
428
raise errors.UpgradeRequired(self.base)
430
def set_append_revisions_only(self, enabled):
431
"""Older format branches are never restricted to append-only"""
432
raise errors.UpgradeRequired(self.base)
1018
raise errors.UpgradeRequired(self.user_url)
434
1020
def last_revision(self):
435
"""Return last revision id, or None"""
436
ph = self.revision_history()
440
return _mod_revision.NULL_REVISION
1021
"""Return last revision id, or NULL_REVISION."""
1022
return self.last_revision_info()[1]
442
1025
def last_revision_info(self):
443
1026
"""Return information about the last revision.
445
:return: A tuple (revno, last_revision_id).
447
rh = self.revision_history()
450
return (revno, rh[-1])
452
return (0, _mod_revision.NULL_REVISION)
454
def missing_revisions(self, other, stop_revision=None):
455
"""Return a list of new revisions that would perfectly fit.
457
If self and other have not diverged, return a list of the revisions
458
present in other, but missing from self.
460
self_history = self.revision_history()
461
self_len = len(self_history)
462
other_history = other.revision_history()
463
other_len = len(other_history)
464
common_index = min(self_len, other_len) -1
465
if common_index >= 0 and \
466
self_history[common_index] != other_history[common_index]:
467
raise DivergedBranches(self, other)
469
if stop_revision is None:
470
stop_revision = other_len
472
assert isinstance(stop_revision, int)
473
if stop_revision > other_len:
474
raise errors.NoSuchRevision(self, stop_revision)
475
return other_history[self_len:stop_revision]
477
def update_revisions(self, other, stop_revision=None):
478
"""Pull in new perfect-fit revisions.
480
:param other: Another Branch to pull from
481
:param stop_revision: Updated until the given revision
484
raise NotImplementedError(self.update_revisions)
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)
486
1070
def revision_id_to_revno(self, revision_id):
487
1071
"""Given a revision id, return its revno"""
488
1072
if _mod_revision.is_null(revision_id):
490
revision_id = osutils.safe_revision_id(revision_id)
491
history = self.revision_history()
1074
history = self._revision_history()
493
1076
return history.index(revision_id) + 1
494
1077
except ValueError:
495
1078
raise errors.NoSuchRevision(self, revision_id)
497
1081
def get_rev_id(self, revno, history=None):
498
1082
"""Find the revision id of the specified revno."""
500
1084
return _mod_revision.NULL_REVISION
502
history = self.revision_history()
503
if revno <= 0 or revno > len(history):
1085
last_revno, last_revid = self.last_revision_info()
1086
if revno == last_revno:
1088
if revno <= 0 or revno > last_revno:
504
1089
raise errors.NoSuchRevision(self, revno)
505
return history[revno - 1]
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]
507
def pull(self, source, overwrite=False, stop_revision=None):
1095
def pull(self, source, overwrite=False, stop_revision=None,
1096
possible_transports=None, *args, **kwargs):
508
1097
"""Mirror source into this branch.
510
1099
This branch is considered to be 'local', having low latency.
512
1101
:returns: PullResult instance
514
raise NotImplementedError(self.pull)
1103
return InterBranch.get(source, self).pull(overwrite=overwrite,
1104
stop_revision=stop_revision,
1105
possible_transports=possible_transports, *args, **kwargs)
516
def push(self, target, overwrite=False, stop_revision=None):
1107
def push(self, target, overwrite=False, stop_revision=None, lossy=False,
517
1109
"""Mirror this branch into target.
519
1111
This branch is considered to be 'local', having low latency.
521
raise NotImplementedError(self.push)
1113
return InterBranch.get(self, target).push(overwrite, stop_revision,
1114
lossy, *args, **kwargs)
523
1116
def basis_tree(self):
524
1117
"""Return `Tree` object for last revision."""
525
1118
return self.repository.revision_tree(self.last_revision())
527
def rename_one(self, from_rel, to_rel):
530
This can change the directory or the filename or both.
532
raise NotImplementedError(self.rename_one)
534
def move(self, from_paths, to_name):
537
to_name must exist as a versioned directory.
539
If to_name exists and is a directory, the files are moved into
540
it, keeping their old names. If it is a directory,
542
Note that to_name is only the last component of the new name;
543
this doesn't change the directory.
545
This returns a list of (from_path, to_path) pairs for each
548
raise NotImplementedError(self.move)
550
1120
def get_parent(self):
551
1121
"""Return the parent location of the branch.
553
This is the default location for push/pull/missing. The usual
1123
This is the default location for pull/missing. The usual
554
1124
pattern is that the user can override it by specifying a
557
raise NotImplementedError(self.get_parent)
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)
559
1142
def _set_config_location(self, name, url, config=None,
560
1143
make_relative=False):
561
1144
if config is None:
562
config = self.get_config()
1145
config = self.get_config_stack()
565
1148
elif make_relative:
566
1149
url = urlutils.relative_url(self.base, url)
567
config.set_user_option(name, url, warn_masked=True)
1150
config.set(name, url)
569
1152
def _get_config_location(self, name, config=None):
570
1153
if config is None:
571
config = self.get_config()
572
location = config.get_user_option(name)
1154
config = self.get_config_stack()
1155
location = config.get(name)
573
1156
if location == '':
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')
577
1164
def get_submit_branch(self):
578
1165
"""Return the submit location of the branch.
638
1242
self.check_real_revno(revno)
640
1244
def check_real_revno(self, revno):
642
1246
Check whether a revno corresponds to a real revision.
643
1247
Zero (the NULL revision) is considered invalid
645
1249
if revno < 1 or revno > self.revno():
646
raise InvalidRevisionNumber(revno)
1250
raise errors.InvalidRevisionNumber(revno)
648
1252
@needs_read_lock
649
def clone(self, to_bzrdir, revision_id=None):
1253
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
650
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.
652
1259
revision_id: if not None, the revision history in the new branch will
653
1260
be truncated to end with revision_id.
655
result = self._format.initialize(to_bzrdir)
656
self.copy_content_into(result, revision_id=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)
659
1272
@needs_read_lock
660
def sprout(self, to_bzrdir, revision_id=None):
1273
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
661
1275
"""Create a new line of development from the branch, into to_bzrdir.
1277
to_bzrdir controls the branch format.
663
1279
revision_id: if not None, the revision history in the new branch will
664
1280
be truncated to end with revision_id.
666
result = self._format.initialize(to_bzrdir)
667
self.copy_content_into(result, revision_id=revision_id)
668
result.set_parent(self.bzrdir.root_transport.base)
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)
671
1300
def _synchronize_history(self, destination, revision_id):
672
1301
"""Synchronize last revision and revision history between branches.
674
1303
This version is most efficient when the destination is also a
675
BzrBranch5, but works for BzrBranch6 as long as the revision
676
history is the true lefthand parent history, and all of the revisions
677
are in the destination's repository. If not, set_revision_history
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.
680
1308
:param destination: The branch to copy the history into
681
1309
:param revision_id: The revision-id to truncate history at. May
682
1310
be None to copy complete history.
684
if revision_id == _mod_revision.NULL_REVISION:
686
new_history = self.revision_history()
687
if revision_id is not None and new_history != []:
688
revision_id = osutils.safe_revision_id(revision_id)
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()
690
new_history = new_history[:new_history.index(revision_id) + 1]
692
rev = self.repository.get_revision(revision_id)
693
new_history = rev.get_history(self.repository)[1:]
694
destination.set_revision_history(new_history)
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)
697
1325
def copy_content_into(self, destination, revision_id=None):
698
1326
"""Copy the content of self into destination.
700
1328
revision_id: if not None, the revision history in the new branch will
701
1329
be truncated to end with revision_id.
703
self._synchronize_history(destination, revision_id)
705
parent = self.get_parent()
706
except errors.InaccessibleParent, e:
707
mutter('parent was not accessible to copy: %s', e)
710
destination.set_parent(parent)
711
self.tags.merge_to(destination.tags)
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)
713
1351
@needs_read_lock
1352
def check(self, refs):
715
1353
"""Check consistency of the branch.
717
1355
In particular this checks that revisions given in the revision-history
718
do actually match up in the revision graph, and that they're all
1356
do actually match up in the revision graph, and that they're all
719
1357
present in the repository.
721
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()
723
1363
:return: A BranchCheckResult.
725
mainline_parent_id = None
726
for revision_id in self.revision_history():
728
revision = self.repository.get_revision(revision_id)
729
except errors.NoSuchRevision, e:
730
raise errors.BzrCheckError("mainline revision {%s} not in repository"
732
# In general the first entry on the revision history has no parents.
733
# But it's not illegal for it to have parents listed; this can happen
734
# in imports from Arch when the parents weren't reachable.
735
if mainline_parent_id is not None:
736
if mainline_parent_id not in revision.parent_ids:
737
raise errors.BzrCheckError("previous revision {%s} not listed among "
739
% (mainline_parent_id, revision_id))
740
mainline_parent_id = revision_id
741
return BranchCheckResult(self)
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
743
def _get_checkout_format(self):
1379
def _get_checkout_format(self, lightweight=False):
744
1380
"""Return the most suitable metadir for a checkout of this branch.
745
1381
Weaves are used if this branch's repository uses weaves.
747
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
748
from bzrlib.repofmt import weaverepo
749
format = bzrdir.BzrDirMetaFormat1()
750
format.repository_format = weaverepo.RepositoryFormat7()
752
format = self.repository.bzrdir.checkout_metadir()
753
format.set_branch_format(self._format)
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()
756
1412
def create_checkout(self, to_location, revision_id=None,
1413
lightweight=False, accelerator_tree=None,
758
1415
"""Create a checkout of a branch.
760
1417
:param to_location: The url to produce the checkout at
761
1418
:param revision_id: The revision to check out
762
1419
:param lightweight: If True, produce a lightweight checkout, otherwise,
763
produce a bound branch (heavyweight checkout)
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,
764
1427
:return: The tree of the created checkout
766
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
769
format = self._get_checkout_format()
770
checkout = format.initialize_on_transport(t)
771
BranchReferenceFormat().initialize(checkout, self)
1450
from_branch = checkout.set_branch_reference(target_branch=self)
773
format = self._get_checkout_format()
774
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
775
to_location, force_new_tree=False, format=format)
776
checkout = checkout_branch.bzrdir
1452
policy = checkout.determine_repository_policy()
1453
repo = policy.acquire_repository()[0]
1454
checkout_branch = checkout.create_branch()
777
1455
checkout_branch.bind(self)
778
# pull up to the specified revision_id to set the initial
1456
# pull up to the specified revision_id to set the initial
779
1457
# branch tip correctly, and seed it with history.
780
1458
checkout_branch.pull(self, stop_revision=revision_id)
781
tree = checkout.create_workingtree(revision_id)
1460
tree = checkout.create_workingtree(revision_id,
1461
from_branch=from_branch,
1462
accelerator_tree=accelerator_tree,
782
1464
basis_tree = tree.basis_tree()
783
1465
basis_tree.lock_read()
791
1473
basis_tree.unlock()
794
def reference_parent(self, 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):
795
1485
"""Return the parent branch for a tree-reference file_id
796
1487
:param file_id: The file_id of the tree reference
797
1488
:param path: The path of the file_id in the tree
798
1489
:return: A branch associated with the file_id
800
1491
# FIXME should provide multiple branches, based on config
801
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1492
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1493
possible_transports=possible_transports)
803
1495
def supports_tags(self):
804
1496
return self._format.supports_tags()
807
class BranchFormat(object):
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):
808
1569
"""An encapsulation of the initialization and open routines for a format.
810
1571
Formats provide three things:
811
1572
* An initialization routine,
1573
* a format description
813
1574
* an open routine.
815
Formats are placed in an dict by their format string for reference
816
during branch opening. Its not required that these be instances, they
817
can be classes themselves with class methods - it simply depends on
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
818
1579
whether state is needed for a given format or not.
820
1581
Once a format is deprecated, just deprecate the initialize and open
821
methods on the format class. Do not deprecate the object, as the
1582
methods on the format class. Do not deprecate the object, as the
822
1583
object will be created every time regardless.
825
_default_format = None
826
"""The default format used for new branches."""
829
"""The known formats."""
831
1586
def __eq__(self, other):
832
1587
return self.__class__ is other.__class__
834
1589
def __ne__(self, other):
835
1590
return not (self == other)
838
def find_format(klass, a_bzrdir):
839
"""Return the format for the branch object in a_bzrdir."""
841
transport = a_bzrdir.get_branch_transport(None)
842
format_string = transport.get("format").read()
843
return klass._formats[format_string]
845
raise NotBranchError(path=transport.base)
847
raise errors.UnknownFormatError(format=format_string)
850
def get_default_format(klass):
851
"""Return the current default format."""
852
return klass._default_format
854
def get_reference(self, a_bzrdir):
855
"""Get the target reference of the branch in a_bzrdir.
1592
def get_reference(self, controldir, name=None):
1593
"""Get the target reference of the branch in controldir.
857
1595
format probing must have been completed before calling
858
1596
this method - it is assumed that the format of the branch
859
in a_bzrdir is correct.
1597
in controldir is correct.
861
:param a_bzrdir: The bzrdir to get the branch data from.
1599
:param controldir: The controldir to get the branch data from.
1600
:param name: Name of the colocated branch to fetch
862
1601
:return: None if the branch is not a reference branch.
866
def get_format_string(self):
867
"""Return the ASCII format string that identifies this format."""
868
raise NotImplementedError(self.get_format_string)
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)
870
1619
def get_format_description(self):
871
1620
"""Return the short format description for this format."""
872
1621
raise NotImplementedError(self.get_format_description)
874
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
876
"""Initialize a branch in a bzrdir, with specified files
878
:param a_bzrdir: The bzrdir to initialize the branch in
879
:param utf8_files: The files to create as a list of
880
(filename, content) tuples
881
:param set_format: If True, set the format with
882
self.get_format_string. (BzrBranch4 has its format set
884
:return: a branch in this format
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.
886
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
887
branch_transport = a_bzrdir.get_branch_transport(self)
889
'metadir': ('lock', lockdir.LockDir),
890
'branch4': ('branch-lock', lockable_files.TransportLock),
892
lock_name, lock_class = lock_map[lock_type]
893
control_files = lockable_files.LockableFiles(branch_transport,
894
lock_name, lock_class)
895
control_files.create_lock()
896
control_files.lock_write()
898
control_files.put_utf8('format', self.get_format_string())
900
for file, content in utf8_files:
901
control_files.put_utf8(file, content)
903
control_files.unlock()
904
return self.open(a_bzrdir, _found=True)
906
def initialize(self, a_bzrdir):
907
"""Create a branch of this format in a_bzrdir."""
908
1637
raise NotImplementedError(self.initialize)
910
1639
def is_supported(self):
911
1640
"""Is this format supported?
913
1642
Supported formats can be initialized and opened.
914
Unsupported formats may not support initialization or committing or
1643
Unsupported formats may not support initialization or committing or
915
1644
some other features depending on the reason for not being supported.
919
def open(self, a_bzrdir, _found=False):
920
"""Return the branch object for a_bzrdir
922
_found is a private parameter, do not use it. It is used to indicate
923
if format probing has already be done.
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.
925
1683
raise NotImplementedError(self.open)
928
def register_format(klass, format):
929
klass._formats[format.get_format_string()] = format
932
def set_default_format(klass, format):
933
klass._default_format = format
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)))
936
1699
def unregister_format(klass, format):
937
assert klass._formats[format.get_format_string()] is format
938
del klass._formats[format.get_format_string()]
1700
format_registry.remove(format)
940
1702
def __str__(self):
941
return self.get_format_string().rstrip()
1703
return self.get_format_description().rstrip()
943
1705
def supports_tags(self):
944
1706
"""True if this format supports tags stored in the branch"""
945
1707
return False # by default
947
# XXX: Probably doesn't really belong here -- mbp 20070212
948
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
950
branch_transport = a_bzrdir.get_branch_transport(self)
951
control_files = lockable_files.LockableFiles(branch_transport,
952
lock_filename, lock_class)
953
control_files.create_lock()
954
control_files.lock_write()
956
for filename, content in utf8_files:
957
control_files.put_utf8(filename, content)
959
control_files.unlock()
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()()
962
1746
class BranchHooks(Hooks):
963
1747
"""A dictionary mapping hook name to a list of callables for branch hooks.
965
e.g. ['set_rh'] Is the list of items to be called when the
966
set_revision_history function is invoked.
1749
e.g. ['post_push'] Is the list of items to be called when the
1750
push function is invoked.
969
1753
def __init__(self):
972
1756
These are all empty initially, because by default nothing should get
976
# Introduced in 0.15:
977
# invoked whenever the revision history has been set
978
# with set_revision_history. The api signature is
979
# (branch, revision_history), and the branch will
982
# invoked after a push operation completes.
983
# the api signature is
985
# containing the members
986
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
987
# where local is the local target branch or None, master is the target
988
# master branch, and the rest should be self explanatory. The source
989
# is read locked and the target branches write locked. Source will
990
# be the local low-latency branch.
991
self['post_push'] = []
992
# invoked after a pull operation completes.
993
# the api signature is
995
# containing the members
996
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
997
# where local is the local branch or None, master is the target
998
# master branch, and the rest should be self explanatory. The source
999
# is read locked and the target branches write locked. The local
1000
# branch is the low-latency branch.
1001
self['post_pull'] = []
1002
# invoked after a commit operation completes.
1003
# the api signature is
1004
# (local, master, old_revno, old_revid, new_revno, new_revid)
1005
# old_revid is NULL_REVISION for the first commit to a branch.
1006
self['post_commit'] = []
1007
# invoked after a uncommit operation completes.
1008
# the api signature is
1009
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1010
# local is the local branch or None, master is the target branch,
1011
# and an empty branch recieves new_revno of 0, new_revid of None.
1012
self['post_uncommit'] = []
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))
1015
1833
# install the default hooks into the Branch class.
1016
1834
Branch.hooks = BranchHooks()
1019
class BzrBranchFormat4(BranchFormat):
1020
"""Bzr branch format 4.
1023
- a revision-history file.
1024
- a branch-lock lock file [ to be shared with the bzrdir ]
1027
def get_format_description(self):
1028
"""See BranchFormat.get_format_description()."""
1029
return "Branch format 4"
1031
def initialize(self, a_bzrdir):
1032
"""Create a branch of this format in a_bzrdir."""
1033
utf8_files = [('revision-history', ''),
1034
('branch-name', ''),
1036
return self._initialize_helper(a_bzrdir, utf8_files,
1037
lock_type='branch4', set_format=False)
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.
1039
1952
def __init__(self):
1040
super(BzrBranchFormat4, self).__init__()
1041
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1043
def open(self, a_bzrdir, _found=False):
1044
"""Return the branch object for a_bzrdir
1046
_found is a private parameter, do not use it. It is used to indicate
1047
if format probing has already be done.
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()
1050
# we are being called directly and must probe.
1051
raise NotImplementedError
1052
return BzrBranch(_format=self,
1053
_control_files=a_bzrdir._control_files,
1055
_repository=a_bzrdir.open_repository())
1058
return "Bazaar-NG branch format 4"
1061
class BzrBranchFormat5(BranchFormat):
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):
1062
2060
"""Bzr branch format 5.
1064
2062
This format has:
1130
2118
"""See BranchFormat.get_format_description()."""
1131
2119
return "Branch format 6"
1133
def initialize(self, a_bzrdir):
1134
"""Create a branch of this format in a_bzrdir."""
1135
utf8_files = [('last-revision', '0 null:\n'),
1136
('branch-name', ''),
1137
('branch.conf', ''),
1140
return self._initialize_helper(a_bzrdir, utf8_files)
1142
def open(self, a_bzrdir, _found=False):
1143
"""Return the branch object for a_bzrdir
1145
_found is a private parameter, do not use it. It is used to indicate
1146
if format probing has already be done.
1149
format = BranchFormat.find_format(a_bzrdir)
1150
assert format.__class__ == self.__class__
1151
transport = a_bzrdir.get_branch_transport(None)
1152
control_files = lockable_files.LockableFiles(transport, 'lock',
1154
return BzrBranch6(_format=self,
1155
_control_files=control_files,
1157
_repository=a_bzrdir.find_repository())
1159
def supports_tags(self):
1163
class BranchReferenceFormat(BranchFormat):
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):
1164
2223
"""Bzr branch reference format.
1166
2225
Branch references are used in implementing checkouts, they
1171
2230
- a format string
1174
def get_format_string(self):
2234
def get_format_string(cls):
1175
2235
"""See BranchFormat.get_format_string()."""
1176
2236
return "Bazaar-NG Branch Reference Format 1\n"
1178
2238
def get_format_description(self):
1179
2239
"""See BranchFormat.get_format_description()."""
1180
2240
return "Checkout reference format 1"
1182
def get_reference(self, a_bzrdir):
2242
def get_reference(self, a_bzrdir, name=None):
1183
2243
"""See BranchFormat.get_reference()."""
1184
transport = a_bzrdir.get_branch_transport(None)
1185
return transport.get('location').read()
1187
def initialize(self, a_bzrdir, target_branch=None):
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):
1188
2254
"""Create a branch of this format in a_bzrdir."""
1189
2255
if target_branch is None:
1190
2256
# this format does not implement branch itself, thus the implicit
1191
2257
# creation contract must see it as uninitializable
1192
2258
raise errors.UninitializableFormat(self)
1193
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1194
branch_transport = a_bzrdir.get_branch_transport(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)
1195
2265
branch_transport.put_bytes('location',
1196
target_branch.bzrdir.root_transport.base)
1197
branch_transport.put_bytes('format', self.get_format_string())
1198
return self.open(a_bzrdir, _found=True)
1201
super(BranchReferenceFormat, self).__init__()
1202
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
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)
1204
2273
def _make_reference_clone_function(format, a_branch):
1205
2274
"""Create a clone() routine for a branch dynamically."""
1206
def clone(to_bzrdir, revision_id=None):
2275
def clone(to_bzrdir, revision_id=None,
2276
repository_policy=None):
1207
2277
"""See Branch.clone()."""
1208
return format.initialize(to_bzrdir, a_branch)
2278
return format.initialize(to_bzrdir, target_branch=a_branch)
1209
2279
# cannot obey revision_id limits when cloning a reference ...
1210
2280
# FIXME RBC 20060210 either nuke revision_id for clone, or
1211
2281
# emit some sort of warning/error to the caller ?!
1214
def open(self, a_bzrdir, _found=False, location=None):
2284
def open(self, a_bzrdir, name=None, _found=False, location=None,
2285
possible_transports=None, ignore_fallbacks=False,
2286
found_repository=None):
1215
2287
"""Return the branch that the branch reference in a_bzrdir points at.
1217
_found is a private parameter, do not use it. It is used to indicate
1218
if format probing has already be done.
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()
1221
format = BranchFormat.find_format(a_bzrdir)
1222
assert format.__class__ == self.__class__
2303
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2304
if format.__class__ != self.__class__:
2305
raise AssertionError("wrong format %r found for %r" %
1223
2307
if location is None:
1224
location = self.get_reference(a_bzrdir)
1225
real_bzrdir = bzrdir.BzrDir.open(location)
1226
result = real_bzrdir.open_branch()
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)
1227
2313
# this changes the behaviour of result.clone to create a new reference
1228
2314
# rather than a copy of the content of the branch.
1229
2315
# I did not use a proxy object because that needs much more extensive
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)
1239
2350
# formats which have no format string are not discoverable
1240
2351
# and not independently creatable, so are not registered.
1241
2352
__format5 = BzrBranchFormat5()
1242
2353
__format6 = BzrBranchFormat6()
1243
BranchFormat.register_format(__format5)
1244
BranchFormat.register_format(BranchReferenceFormat())
1245
BranchFormat.register_format(__format6)
1246
BranchFormat.set_default_format(__format6)
1247
_legacy_formats = [BzrBranchFormat4(),
1250
class BzrBranch(Branch):
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):
1251
2382
"""A branch stored in the actual filesystem.
1253
2384
Note that it's "local" in the context of the filesystem; it doesn't
1254
2385
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1255
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
1258
2397
def __init__(self, _format=None,
1259
_control_files=None, a_bzrdir=None, _repository=None):
2398
_control_files=None, a_bzrdir=None, name=None,
2399
_repository=None, ignore_fallbacks=False,
2400
possible_transports=None):
1260
2401
"""Create new branch object at a particular location."""
1261
Branch.__init__(self)
1262
2402
if a_bzrdir is None:
1263
2403
raise ValueError('a_bzrdir must be supplied')
1265
self.bzrdir = a_bzrdir
1266
# self._transport used to point to the directory containing the
1267
# control directory, but was not used - now it's just the transport
1268
# for the branch control files. mbp 20070212
1269
self._base = self.bzrdir.transport.clone('..').base
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
1270
2413
self._format = _format
1271
2414
if _control_files is None:
1272
2415
raise ValueError('BzrBranch _control_files is None')
1273
2416
self.control_files = _control_files
1274
2417
self._transport = _control_files._transport
1275
2418
self.repository = _repository
2419
self.conf_store = None
2420
Branch.__init__(self, possible_transports)
1277
2422
def __str__(self):
1278
return '%s(%r)' % (self.__class__.__name__, self.base)
2423
return '%s(%s)' % (self.__class__.__name__, self.user_url)
1280
2425
__repr__ = __str__
1341
2523
"""See Branch.print_file."""
1342
2524
return self.repository.print_file(file, revision_id)
1344
def _write_revision_history(self, history):
1345
"""Factored out of set_revision_history.
1347
This performs the actual writing to disk.
1348
It is intended to be called by BzrBranch5.set_revision_history."""
1349
self.control_files.put_bytes(
1350
'revision-history', '\n'.join(history))
1352
2526
@needs_write_lock
1353
def set_revision_history(self, rev_history):
1354
"""See Branch.set_revision_history."""
1355
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
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)
1356
2536
self._clear_cached_state()
1357
self._write_revision_history(rev_history)
1358
self._cache_revision_history(rev_history)
1359
for hook in Branch.hooks['set_rh']:
1360
hook(self, rev_history)
1363
def set_last_revision_info(self, revno, revision_id):
1364
"""Set the last revision of this branch.
1366
The caller is responsible for checking that the revno is correct
1367
for this revision id.
1369
It may be possible to set the branch last revision to an id not
1370
present in the repository. However, branches can also be
1371
configured to check constraints on history, in which case this may not
1374
revision_id = osutils.safe_revision_id(revision_id)
1375
history = self._lefthand_history(revision_id)
1376
assert len(history) == revno, '%d != %d' % (len(history), revno)
1377
self.set_revision_history(history)
1379
def _gen_revision_history(self):
1380
history = self.control_files.get('revision-history').read().split('\n')
1381
if history[-1:] == ['']:
1382
# There shouldn't be a trailing newline, but just in case.
1386
def _lefthand_history(self, revision_id, last_rev=None,
1388
# stop_revision must be a descendant of last_revision
1389
stop_graph = self.repository.get_revision_graph(revision_id)
1390
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1391
and last_rev not in stop_graph):
1392
# our previous tip is not merged into stop_revision
1393
raise errors.DivergedBranches(self, other_branch)
1394
# make a new revision history from the graph
1395
current_rev_id = revision_id
1397
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1398
new_history.append(current_rev_id)
1399
current_rev_id_parents = stop_graph[current_rev_id]
1401
current_rev_id = current_rev_id_parents[0]
1403
current_rev_id = None
1404
new_history.reverse()
1408
def generate_revision_history(self, revision_id, last_rev=None,
1410
"""Create a new revision history that will finish with revision_id.
1412
:param revision_id: the new tip to use.
1413
:param last_rev: The previous last_revision. If not None, then this
1414
must be a ancestory of revision_id, or DivergedBranches is raised.
1415
:param other_branch: The other branch that DivergedBranches should
1416
raise with respect to.
1418
revision_id = osutils.safe_revision_id(revision_id)
1419
self.set_revision_history(self._lefthand_history(revision_id,
1420
last_rev, other_branch))
1423
def update_revisions(self, other, stop_revision=None):
1424
"""See Branch.update_revisions."""
1427
if stop_revision is None:
1428
stop_revision = other.last_revision()
1429
if stop_revision is None:
1430
# if there are no commits, we're done.
1433
stop_revision = osutils.safe_revision_id(stop_revision)
1434
# whats the current last revision, before we fetch [and change it
1436
last_rev = _mod_revision.ensure_null(self.last_revision())
1437
# we fetch here regardless of whether we need to so that we pickup
1439
self.fetch(other, stop_revision)
1440
if self.repository.get_graph().is_ancestor(stop_revision,
1443
self.generate_revision_history(stop_revision, last_rev=last_rev,
2537
self._last_revision_info_cache = revno, revision_id
2538
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1448
2540
def basis_tree(self):
1449
2541
"""See Branch.basis_tree."""
1450
2542
return self.repository.revision_tree(self.last_revision())
1453
def pull(self, source, overwrite=False, stop_revision=None,
1454
_hook_master=None, run_hooks=True):
1457
:param _hook_master: Private parameter - set the branch to
1458
be supplied as the master to push hooks.
1459
:param run_hooks: Private parameter - if false, this branch
1460
is being called because it's the master of the primary branch,
1461
so it should not run its hooks.
1463
result = PullResult()
1464
result.source_branch = source
1465
result.target_branch = self
1468
result.old_revno, result.old_revid = self.last_revision_info()
1470
self.update_revisions(source, stop_revision)
1471
except DivergedBranches:
1475
if stop_revision is None:
1476
stop_revision = source.last_revision()
1477
self.generate_revision_history(stop_revision)
1478
result.tag_conflicts = source.tags.merge_to(self.tags)
1479
result.new_revno, result.new_revid = self.last_revision_info()
1481
result.master_branch = _hook_master
1482
result.local_branch = self
1484
result.master_branch = self
1485
result.local_branch = None
1487
for hook in Branch.hooks['post_pull']:
1493
2544
def _get_parent_location(self):
1494
2545
_locs = ['parent', 'pull', 'x-pull']
1495
2546
for l in _locs:
1497
return self.control_files.get(l).read().strip('\n')
2548
return self._transport.get_bytes(l).strip('\n')
2549
except errors.NoSuchFile:
1503
def push(self, target, overwrite=False, stop_revision=None,
1504
_override_hook_source_branch=None):
1507
This is the basic concrete implementation of push()
1509
:param _override_hook_source_branch: If specified, run
1510
the hooks passing this Branch as the source, rather than self.
1511
This is for use of RemoteBranch, where push is delegated to the
1512
underlying vfs-based Branch.
1514
# TODO: Public option to disable running hooks - should be trivial but
1518
result = self._push_with_bound_branches(target, overwrite,
1520
_override_hook_source_branch=_override_hook_source_branch)
1525
def _push_with_bound_branches(self, target, overwrite,
1527
_override_hook_source_branch=None):
1528
"""Push from self into target, and into target's master if any.
1530
This is on the base BzrBranch class even though it doesn't support
1531
bound branches because the *target* might be bound.
1534
if _override_hook_source_branch:
1535
result.source_branch = _override_hook_source_branch
1536
for hook in Branch.hooks['post_push']:
1539
bound_location = target.get_bound_location()
1540
if bound_location and target.base != bound_location:
1541
# there is a master branch.
1543
# XXX: Why the second check? Is it even supported for a branch to
1544
# be bound to itself? -- mbp 20070507
1545
master_branch = target.get_master_branch()
1546
master_branch.lock_write()
1548
# push into the master from this branch.
1549
self._basic_push(master_branch, overwrite, stop_revision)
1550
# and push into the target branch from this. Note that we push from
1551
# this branch again, because its considered the highest bandwidth
1553
result = self._basic_push(target, overwrite, stop_revision)
1554
result.master_branch = master_branch
1555
result.local_branch = target
1559
master_branch.unlock()
1562
result = self._basic_push(target, overwrite, stop_revision)
1563
# TODO: Why set master_branch and local_branch if there's no
1564
# binding? Maybe cleaner to just leave them unset? -- mbp
1566
result.master_branch = target
1567
result.local_branch = None
1571
def _basic_push(self, target, overwrite, stop_revision):
1572
"""Basic implementation of push without bound branches or hooks.
1574
Must be called with self read locked and target write locked.
1576
result = PushResult()
1577
result.source_branch = self
1578
result.target_branch = target
1579
result.old_revno, result.old_revid = target.last_revision_info()
1581
target.update_revisions(self, stop_revision)
1582
except DivergedBranches:
1586
target.set_revision_history(self.revision_history())
1587
result.tag_conflicts = self.tags.merge_to(target.tags)
1588
result.new_revno, result.new_revid = target.last_revision_info()
1591
def get_parent(self):
1592
"""See Branch.get_parent."""
1594
assert self.base[-1] == '/'
1595
parent = self._get_parent_location()
1598
# This is an old-format absolute path to a local branch
1599
# turn it into a url
1600
if parent.startswith('/'):
1601
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1603
return urlutils.join(self.base[:-1], parent)
1604
except errors.InvalidURLJoin, e:
1605
raise errors.InaccessibleParent(parent, self.base)
2553
def get_stacked_on_url(self):
2554
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1607
2556
def set_push_location(self, location):
1608
2557
"""See Branch.set_push_location."""
1610
2559
'push_location', location,
1611
2560
store=_mod_config.STORE_LOCATION_NORECURSE)
1614
def set_parent(self, url):
1615
"""See Branch.set_parent."""
1616
# TODO: Maybe delete old location files?
1617
# URLs should never be unicode, even on the local fs,
1618
# FIXUP this and get_parent in a future branch format bump:
1619
# read and rewrite the file, and have the new format code read
1620
# using .get not .get_utf8. RBC 20060125
1622
if isinstance(url, unicode):
1624
url = url.encode('ascii')
1625
except UnicodeEncodeError:
1626
raise errors.InvalidURL(url,
1627
"Urls must be 7-bit ascii, "
1628
"use bzrlib.urlutils.escape")
1629
url = urlutils.relative_url(self.base, url)
1630
self._set_parent_location(url)
1632
2562
def _set_parent_location(self, url):
1633
2563
if url is None:
1634
self.control_files._transport.delete('parent')
1636
assert isinstance(url, str)
1637
self.control_files.put_bytes('parent', url + '\n')
1640
class BzrBranch5(BzrBranch):
1641
"""A format 5 branch. This supports new features over plan branches.
1643
It has support for a master_branch which is the data for bound branches.
1651
super(BzrBranch5, self).__init__(_format=_format,
1652
_control_files=_control_files,
1654
_repository=_repository)
1657
def pull(self, source, overwrite=False, stop_revision=None,
1659
"""Pull from source into self, updating my master if any.
1661
:param run_hooks: Private parameter - if false, this branch
1662
is being called because it's the master of the primary branch,
1663
so it should not run its hooks.
1665
bound_location = self.get_bound_location()
1666
master_branch = None
1667
if bound_location and source.base != bound_location:
1668
# not pulling from master, so we need to update master.
1669
master_branch = self.get_master_branch()
1670
master_branch.lock_write()
1673
# pull from source into master.
1674
master_branch.pull(source, overwrite, stop_revision,
1676
return super(BzrBranch5, self).pull(source, overwrite,
1677
stop_revision, _hook_master=master_branch,
1678
run_hooks=run_hooks)
1681
master_branch.unlock()
1683
def get_bound_location(self):
1685
return self.control_files.get_utf8('bound').read()[:-1]
1686
except errors.NoSuchFile:
1690
def get_master_branch(self):
1691
"""Return the branch we are bound to.
1693
:return: Either a Branch, or None
1695
This could memoise the branch, but if thats done
1696
it must be revalidated on each new lock.
1697
So for now we just don't memoise it.
1698
# RBC 20060304 review this decision.
1700
bound_loc = self.get_bound_location()
1704
return Branch.open(bound_loc)
1705
except (errors.NotBranchError, errors.ConnectionError), e:
1706
raise errors.BoundBranchConnectionFailure(
1710
def set_bound_location(self, location):
1711
"""Set the target where this branch is bound to.
1713
:param location: URL to the target branch
1716
self.control_files.put_utf8('bound', location+'\n')
1719
self.control_files._transport.delete('bound')
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)
1724
2574
@needs_write_lock
1725
2575
def bind(self, other):
1789
class BzrBranchExperimental(BzrBranch5):
1790
"""Bzr experimental branch format
1793
- a revision-history file.
1795
- a lock dir guarding the branch itself
1796
- all of this stored in a branch/ subdirectory
1797
- works with shared repositories.
1798
- a tag dictionary in the branch
1800
This format is new in bzr 0.15, but shouldn't be used for real data,
1803
This class acts as it's own BranchFormat.
1806
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1809
def get_format_string(cls):
1810
"""See BranchFormat.get_format_string()."""
1811
return "Bazaar-NG branch format experimental\n"
1814
def get_format_description(cls):
1815
"""See BranchFormat.get_format_description()."""
1816
return "Experimental branch format"
1819
def get_reference(cls, a_bzrdir):
1820
"""Get the target reference of the branch in a_bzrdir.
1822
format probing must have been completed before calling
1823
this method - it is assumed that the format of the branch
1824
in a_bzrdir is correct.
1826
:param a_bzrdir: The bzrdir to get the branch data from.
1827
:return: None if the branch is not a reference branch.
1832
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1834
branch_transport = a_bzrdir.get_branch_transport(cls)
1835
control_files = lockable_files.LockableFiles(branch_transport,
1836
lock_filename, lock_class)
1837
control_files.create_lock()
1838
control_files.lock_write()
1840
for filename, content in utf8_files:
1841
control_files.put_utf8(filename, content)
1843
control_files.unlock()
1846
def initialize(cls, a_bzrdir):
1847
"""Create a branch of this format in a_bzrdir."""
1848
utf8_files = [('format', cls.get_format_string()),
1849
('revision-history', ''),
1850
('branch-name', ''),
1853
cls._initialize_control_files(a_bzrdir, utf8_files,
1854
'lock', lockdir.LockDir)
1855
return cls.open(a_bzrdir, _found=True)
1858
def open(cls, a_bzrdir, _found=False):
1859
"""Return the branch object for a_bzrdir
1861
_found is a private parameter, do not use it. It is used to indicate
1862
if format probing has already be done.
1865
format = BranchFormat.find_format(a_bzrdir)
1866
assert format.__class__ == cls
1867
transport = a_bzrdir.get_branch_transport(None)
1868
control_files = lockable_files.LockableFiles(transport, 'lock',
1870
return cls(_format=cls,
1871
_control_files=control_files,
1873
_repository=a_bzrdir.find_repository())
1876
def is_supported(cls):
1879
def _make_tags(self):
1880
return BasicTags(self)
1883
def supports_tags(cls):
1887
BranchFormat.register_format(BzrBranchExperimental)
1890
class BzrBranch6(BzrBranch5):
1893
def last_revision_info(self):
1894
revision_string = self.control_files.get('last-revision').read()
2662
def _read_last_revision_info(self):
2663
revision_string = self._transport.get_bytes('last-revision')
1895
2664
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1896
2665
revision_id = cache_utf8.get_cached_utf8(revision_id)
1897
2666
revno = int(revno)
1898
2667
return revno, revision_id
1900
def last_revision(self):
1901
"""Return last revision id, or None"""
1902
revision_id = self.last_revision_info()[1]
1905
2669
def _write_last_revision_info(self, revno, revision_id):
1906
2670
"""Simply write out the revision id, with no checks.
1908
2672
Use set_last_revision_info to perform this safely.
1910
2674
Does not update the revision_history cache.
1911
Intended to be called by set_last_revision_info and
1912
_write_revision_history.
1914
if revision_id is None:
1915
revision_id = 'null:'
2676
revision_id = _mod_revision.ensure_null(revision_id)
1916
2677
out_string = '%d %s\n' % (revno, revision_id)
1917
self.control_files.put_bytes('last-revision', out_string)
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."""
1919
2695
@needs_write_lock
1920
2696
def set_last_revision_info(self, revno, revision_id):
1921
revision_id = osutils.safe_revision_id(revision_id)
1922
if self._get_append_revisions_only():
1923
self._check_history_violation(revision_id)
1924
self._write_last_revision_info(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)
1925
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
1927
2827
def _check_history_violation(self, revision_id):
1928
last_revision = _mod_revision.ensure_null(self.last_revision())
2828
current_revid = self.last_revision()
2829
last_revision = _mod_revision.ensure_null(current_revid)
1929
2830
if _mod_revision.is_null(last_revision):
1931
if last_revision not in self._lefthand_history(revision_id):
1932
raise errors.AppendRevisionsOnlyViolation(self.base)
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)
1934
2838
def _gen_revision_history(self):
1935
2839
"""Generate the revision history from last revision
1937
history = list(self.repository.iter_reverse_revision_history(
1938
self.last_revision()))
1942
def _write_revision_history(self, history):
1943
"""Factored out of set_revision_history.
1945
This performs the actual writing to disk, with format-specific checks.
1946
It is intended to be called by BzrBranch5.set_revision_history.
1948
if len(history) == 0:
1949
last_revision = 'null:'
1951
if history != self._lefthand_history(history[-1]):
1952
raise errors.NotLefthandHistory(history)
1953
last_revision = history[-1]
1954
if self._get_append_revisions_only():
1955
self._check_history_violation(last_revision)
1956
self._write_last_revision_info(len(history), 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))
1958
2845
@needs_write_lock
1959
2846
def _set_parent_location(self, url):
1965
2852
"""Set the parent branch"""
1966
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)
1968
2930
def set_push_location(self, location):
1969
2931
"""See Branch.set_push_location."""
1970
2932
self._set_config_location('push_location', location)
1972
2934
def set_bound_location(self, location):
1973
2935
"""See Branch.set_push_location."""
2936
self._master_branch_cache = None
1975
config = self.get_config()
2938
conf = self.get_config_stack()
1976
2939
if location is None:
1977
if config.get_user_option('bound') != 'True':
2940
if not conf.get('bound'):
1980
config.set_user_option('bound', 'False', warn_masked=True)
2943
conf.set('bound', 'False')
1983
2946
self._set_config_location('bound_location', location,
1985
config.set_user_option('bound', 'True', warn_masked=True)
2948
conf.set('bound', 'True')
1988
2951
def _get_bound_location(self, bound):
1989
2952
"""Return the bound location in the config file.
1991
2954
Return None if the bound parameter does not match"""
1992
config = self.get_config()
1993
config_bound = (config.get_user_option('bound') == 'True')
1994
if config_bound != bound:
2955
conf = self.get_config_stack()
2956
if conf.get('bound') != bound:
1996
return self._get_config_location('bound_location', config=config)
2958
return self._get_config_location('bound_location', config=conf)
1998
2960
def get_bound_location(self):
1999
"""See Branch.set_push_location."""
2961
"""See Branch.get_bound_location."""
2000
2962
return self._get_bound_location(True)
2002
2964
def get_old_bound_location(self):
2003
2965
"""See Branch.get_old_bound_location"""
2004
2966
return self._get_bound_location(False)
2006
def set_append_revisions_only(self, enabled):
2011
self.get_config().set_user_option('append_revisions_only', value,
2014
def _get_append_revisions_only(self):
2015
value = self.get_config().get_user_option('append_revisions_only')
2016
return value == 'True'
2018
def _synchronize_history(self, destination, revision_id):
2019
"""Synchronize last revision and revision history between branches.
2021
This version is most efficient when the destination is also a
2022
BzrBranch6, but works for BzrBranch5, as long as the destination's
2023
repository contains all the lefthand ancestors of the intended
2024
last_revision. If not, set_last_revision_info will fail.
2026
:param destination: The branch to copy the history into
2027
:param revision_id: The revision-id to truncate history at. May
2028
be None to copy complete history.
2030
source_revno, source_revision_id = self.last_revision_info()
2031
if revision_id is None:
2032
revno, revision_id = source_revno, source_revision_id
2033
elif source_revision_id == revision_id:
2034
# we know the revno without needing to walk all of history
2035
revno = source_revno
2037
# To figure out the revno for a random revision, we need to build
2038
# the revision history, and count its length.
2039
# We don't care about the order, just how long it is.
2040
# Alternatively, we could start at the current location, and count
2041
# backwards. But there is no guarantee that we will find it since
2042
# it may be a merged revision.
2043
revno = len(list(self.repository.iter_reverse_revision_history(
2045
destination.set_last_revision_info(revno, revision_id)
2047
def _make_tags(self):
2048
return BasicTags(self)
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)
2051
3047
######################################################################
2069
3065
:ivar new_revno: Revision number after pull.
2070
3066
:ivar old_revid: Tip revision id before pull.
2071
3067
:ivar new_revid: Tip revision id after pull.
2072
:ivar source_branch: Source (local) branch object.
2073
:ivar master_branch: Master branch of the target, or None.
2074
:ivar target_branch: Target/destination branch object.
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
2078
# DEPRECATED: pull used to return the change in revno
2079
return self.new_revno - self.old_revno
2081
3077
def report(self, to_file):
2082
if self.old_revid == self.new_revid:
2083
to_file.write('No revisions to pull.\n')
2085
to_file.write('Now on revision %d.\n' % self.new_revno)
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')
2086
3090
self._show_tag_conficts(to_file)
2089
class PushResult(_Result):
3093
class BranchPushResult(_Result):
2090
3094
"""Result of a Branch.push operation.
2092
:ivar old_revno: Revision number before push.
2093
:ivar new_revno: Revision number after push.
2094
:ivar old_revid: Tip revision id before push.
2095
:ivar new_revid: Tip revision id after push.
2096
:ivar source_branch: Source branch object.
2097
:ivar master_branch: Master branch of the target, or None.
2098
:ivar target_branch: Target/destination branch object.
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.
2102
# DEPRECATED: push used to return the change in revno
2103
return self.new_revno - self.old_revno
2105
3112
def report(self, to_file):
2106
"""Write a human-readable description of the result."""
2107
if self.old_revid == self.new_revid:
2108
to_file.write('No new revisions to push.\n')
2110
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
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.'))
2111
3129
self._show_tag_conficts(to_file)
2140
3160
new_branch = format.open(branch.bzrdir, _found=True)
2142
3162
# Copy source data into target
2143
new_branch.set_last_revision_info(*branch.last_revision_info())
2144
new_branch.set_parent(branch.get_parent())
2145
new_branch.set_bound_location(branch.get_bound_location())
2146
new_branch.set_push_location(branch.get_push_location())
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())
2148
3172
# New branch has no tags by default
2149
3173
new_branch.tags._set_tag_dict({})
2151
3175
# Copying done; now update target format
2152
new_branch.control_files.put_utf8('format',
2153
format.get_format_string())
3176
new_branch._transport.put_bytes('format',
3178
mode=new_branch.bzrdir._get_file_mode())
2155
3180
# Clean up old files
2156
new_branch.control_files._transport.delete('revision-history')
2158
branch.set_parent(None)
2161
branch.set_bound_location(None)
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
def _fix_overwrite_type(overwrite):
3274
if isinstance(overwrite, bool):
3276
return ["history", "tags"]
3282
class GenericInterBranch(InterBranch):
3283
"""InterBranch implementation that uses public Branch functions."""
3286
def is_compatible(klass, source, target):
3287
# GenericBranch uses the public API, so always compatible
3291
def _get_branch_formats_to_test(klass):
3292
return [(format_registry.get_default(), format_registry.get_default())]
3295
def unwrap_format(klass, format):
3296
if isinstance(format, remote.RemoteBranchFormat):
3297
format._ensure_real()
3298
return format._custom_format
3302
def copy_content_into(self, revision_id=None):
3303
"""Copy the content of source into target
3305
revision_id: if not None, the revision history in the new branch will
3306
be truncated to end with revision_id.
3308
self.source.update_references(self.target)
3309
self.source._synchronize_history(self.target, revision_id)
3311
parent = self.source.get_parent()
3312
except errors.InaccessibleParent, e:
3313
mutter('parent was not accessible to copy: %s', e)
3316
self.target.set_parent(parent)
3317
if self.source._push_should_merge_tags():
3318
self.source.tags.merge_to(self.target.tags)
3321
def fetch(self, stop_revision=None, limit=None):
3322
if self.target.base == self.source.base:
3324
self.source.lock_read()
3326
fetch_spec_factory = fetch.FetchSpecFactory()
3327
fetch_spec_factory.source_branch = self.source
3328
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3329
fetch_spec_factory.source_repo = self.source.repository
3330
fetch_spec_factory.target_repo = self.target.repository
3331
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3332
fetch_spec_factory.limit = limit
3333
fetch_spec = fetch_spec_factory.make_fetch_spec()
3334
return self.target.repository.fetch(self.source.repository,
3335
fetch_spec=fetch_spec)
3337
self.source.unlock()
3340
def _update_revisions(self, stop_revision=None, overwrite=False,
3342
other_revno, other_last_revision = self.source.last_revision_info()
3343
stop_revno = None # unknown
3344
if stop_revision is None:
3345
stop_revision = other_last_revision
3346
if _mod_revision.is_null(stop_revision):
3347
# if there are no commits, we're done.
3349
stop_revno = other_revno
3351
# what's the current last revision, before we fetch [and change it
3353
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3354
# we fetch here so that we don't process data twice in the common
3355
# case of having something to pull, and so that the check for
3356
# already merged can operate on the just fetched graph, which will
3357
# be cached in memory.
3358
self.fetch(stop_revision=stop_revision)
3359
# Check to see if one is an ancestor of the other
3362
graph = self.target.repository.get_graph()
3363
if self.target._check_if_descendant_or_diverged(
3364
stop_revision, last_rev, graph, self.source):
3365
# stop_revision is a descendant of last_rev, but we aren't
3366
# overwriting, so we're done.
3368
if stop_revno is None:
3370
graph = self.target.repository.get_graph()
3371
this_revno, this_last_revision = \
3372
self.target.last_revision_info()
3373
stop_revno = graph.find_distance_to_null(stop_revision,
3374
[(other_last_revision, other_revno),
3375
(this_last_revision, this_revno)])
3376
self.target.set_last_revision_info(stop_revno, stop_revision)
3379
def pull(self, overwrite=False, stop_revision=None,
3380
possible_transports=None, run_hooks=True,
3381
_override_hook_target=None, local=False):
3382
"""Pull from source into self, updating my master if any.
3384
:param run_hooks: Private parameter - if false, this branch
3385
is being called because it's the master of the primary branch,
3386
so it should not run its hooks.
3388
bound_location = self.target.get_bound_location()
3389
if local and not bound_location:
3390
raise errors.LocalRequiresBoundBranch()
3391
master_branch = None
3392
source_is_master = False
3394
# bound_location comes from a config file, some care has to be
3395
# taken to relate it to source.user_url
3396
normalized = urlutils.normalize_url(bound_location)
3398
relpath = self.source.user_transport.relpath(normalized)
3399
source_is_master = (relpath == '')
3400
except (errors.PathNotChild, errors.InvalidURL):
3401
source_is_master = False
3402
if not local and bound_location and not source_is_master:
3403
# not pulling from master, so we need to update master.
3404
master_branch = self.target.get_master_branch(possible_transports)
3405
master_branch.lock_write()
3408
# pull from source into master.
3409
master_branch.pull(self.source, overwrite, stop_revision,
3411
return self._pull(overwrite,
3412
stop_revision, _hook_master=master_branch,
3413
run_hooks=run_hooks,
3414
_override_hook_target=_override_hook_target,
3415
merge_tags_to_master=not source_is_master)
3418
master_branch.unlock()
3420
def push(self, overwrite=False, stop_revision=None, lossy=False,
3421
_override_hook_source_branch=None):
3422
"""See InterBranch.push.
3424
This is the basic concrete implementation of push()
3426
:param _override_hook_source_branch: If specified, run the hooks
3427
passing this Branch as the source, rather than self. This is for
3428
use of RemoteBranch, where push is delegated to the underlying
3432
raise errors.LossyPushToSameVCS(self.source, self.target)
3433
# TODO: Public option to disable running hooks - should be trivial but
3436
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3437
op.add_cleanup(self.source.lock_read().unlock)
3438
op.add_cleanup(self.target.lock_write().unlock)
3439
return op.run(overwrite, stop_revision,
3440
_override_hook_source_branch=_override_hook_source_branch)
3442
def _basic_push(self, overwrite, stop_revision):
3443
"""Basic implementation of push without bound branches or hooks.
3445
Must be called with source read locked and target write locked.
3447
result = BranchPushResult()
3448
result.source_branch = self.source
3449
result.target_branch = self.target
3450
result.old_revno, result.old_revid = self.target.last_revision_info()
3451
self.source.update_references(self.target)
3452
overwrite = _fix_overwrite_type(overwrite)
3453
if result.old_revid != stop_revision:
3454
# We assume that during 'push' this repository is closer than
3456
graph = self.source.repository.get_graph(self.target.repository)
3457
self._update_revisions(stop_revision,
3458
overwrite=("history" in overwrite),
3460
if self.source._push_should_merge_tags():
3461
result.tag_updates, result.tag_conflicts = (
3462
self.source.tags.merge_to(
3463
self.target.tags, "tags" in overwrite))
3464
result.new_revno, result.new_revid = self.target.last_revision_info()
3467
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3468
_override_hook_source_branch=None):
3469
"""Push from source into target, and into target's master if any.
3472
if _override_hook_source_branch:
3473
result.source_branch = _override_hook_source_branch
3474
for hook in Branch.hooks['post_push']:
3477
bound_location = self.target.get_bound_location()
3478
if bound_location and self.target.base != bound_location:
3479
# there is a master branch.
3481
# XXX: Why the second check? Is it even supported for a branch to
3482
# be bound to itself? -- mbp 20070507
3483
master_branch = self.target.get_master_branch()
3484
master_branch.lock_write()
3485
operation.add_cleanup(master_branch.unlock)
3486
# push into the master from the source branch.
3487
master_inter = InterBranch.get(self.source, master_branch)
3488
master_inter._basic_push(overwrite, stop_revision)
3489
# and push into the target branch from the source. Note that
3490
# we push from the source branch again, because it's considered
3491
# the highest bandwidth repository.
3492
result = self._basic_push(overwrite, stop_revision)
3493
result.master_branch = master_branch
3494
result.local_branch = self.target
3496
master_branch = None
3498
result = self._basic_push(overwrite, stop_revision)
3499
# TODO: Why set master_branch and local_branch if there's no
3500
# binding? Maybe cleaner to just leave them unset? -- mbp
3502
result.master_branch = self.target
3503
result.local_branch = None
3507
def _pull(self, overwrite=False, stop_revision=None,
3508
possible_transports=None, _hook_master=None, run_hooks=True,
3509
_override_hook_target=None, local=False,
3510
merge_tags_to_master=True):
3513
This function is the core worker, used by GenericInterBranch.pull to
3514
avoid duplication when pulling source->master and source->local.
3516
:param _hook_master: Private parameter - set the branch to
3517
be supplied as the master to pull hooks.
3518
:param run_hooks: Private parameter - if false, this branch
3519
is being called because it's the master of the primary branch,
3520
so it should not run its hooks.
3521
is being called because it's the master of the primary branch,
3522
so it should not run its hooks.
3523
:param _override_hook_target: Private parameter - set the branch to be
3524
supplied as the target_branch to pull hooks.
3525
:param local: Only update the local branch, and not the bound branch.
3527
# This type of branch can't be bound.
3529
raise errors.LocalRequiresBoundBranch()
3530
result = PullResult()
3531
result.source_branch = self.source
3532
if _override_hook_target is None:
3533
result.target_branch = self.target
3535
result.target_branch = _override_hook_target
3536
self.source.lock_read()
3538
# We assume that during 'pull' the target repository is closer than
3540
self.source.update_references(self.target)
3541
graph = self.target.repository.get_graph(self.source.repository)
3542
# TODO: Branch formats should have a flag that indicates
3543
# that revno's are expensive, and pull() should honor that flag.
3545
result.old_revno, result.old_revid = \
3546
self.target.last_revision_info()
3547
overwrite = _fix_overwrite_type(overwrite)
3548
self._update_revisions(stop_revision,
3549
overwrite=("history" in overwrite),
3551
# TODO: The old revid should be specified when merging tags,
3552
# so a tags implementation that versions tags can only
3553
# pull in the most recent changes. -- JRV20090506
3554
result.tag_updates, result.tag_conflicts = (
3555
self.source.tags.merge_to(self.target.tags,
3556
"tags" in overwrite,
3557
ignore_master=not merge_tags_to_master))
3558
result.new_revno, result.new_revid = self.target.last_revision_info()
3560
result.master_branch = _hook_master
3561
result.local_branch = result.target_branch
3563
result.master_branch = result.target_branch
3564
result.local_branch = None
3566
for hook in Branch.hooks['post_pull']:
3569
self.source.unlock()
3573
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
