73
48
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
76
class Branch(controldir.ControlComponent):
51
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
52
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
53
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
56
# TODO: Maybe include checks for common corruption of newlines, etc?
58
# TODO: Some operations like log might retrieve the same revisions
59
# repeatedly to calculate deltas. We could perhaps have a weakref
60
# cache in memory to make this faster. In general anything can be
61
# cached in memory between lock and unlock operations. .. nb thats
62
# what the transaction identity map provides
65
######################################################################
77
69
"""Branch holding a history of revisions.
80
Base directory/url of the branch; using control_url and
81
control_transport is more standardized.
82
:ivar hooks: An instance of BranchHooks.
83
:ivar _master_branch_cache: cached result of get_master_branch, see
72
Base directory/url of the branch.
74
hooks: An instance of BranchHooks.
86
76
# this is really an instance variable - FIXME move it there
91
def control_transport(self):
92
return self._transport
95
def user_transport(self):
96
return self.bzrdir.user_transport
98
def __init__(self, possible_transports=None):
99
self.tags = self._format.make_tags(self)
80
# override this to set the strategy for storing tags
82
return DisabledTags(self)
84
def __init__(self, *ignored, **ignored_too):
85
self.tags = self._make_tags()
100
86
self._revision_history_cache = None
101
87
self._revision_id_to_revno_cache = None
102
self._partial_revision_id_to_revno_cache = {}
103
self._partial_revision_history_cache = []
104
self._tags_bytes = None
105
self._last_revision_info_cache = None
106
self._master_branch_cache = None
107
self._merge_sorted_revisions_cache = None
108
self._open_hook(possible_transports)
109
hooks = Branch.hooks['open']
113
def _open_hook(self, possible_transports):
114
"""Called by init to allow simpler extension of the base class."""
116
def _activate_fallback_location(self, url, possible_transports):
117
"""Activate the branch/repository from url as a fallback repository."""
118
for existing_fallback_repo in self.repository._fallback_repositories:
119
if existing_fallback_repo.user_url == url:
120
# This fallback is already configured. This probably only
121
# happens because ControlDir.sprout is a horrible mess. To avoid
122
# confusing _unstack we don't add this a second time.
123
mutter('duplicate activation of fallback %r on %r', url, self)
125
repo = self._get_fallback_repository(url, possible_transports)
126
if repo.has_same_location(self.repository):
127
raise errors.UnstackableLocationError(self.user_url, url)
128
self.repository.add_fallback_repository(repo)
130
89
def break_lock(self):
131
90
"""Break a lock if one is present from another instance.
182
107
For instance, if the branch is at URL/.bzr/branch,
183
108
Branch.open(URL) -> a Branch instance.
185
control = controldir.ControlDir.open(base,
186
possible_transports=possible_transports, _unsupported=_unsupported)
187
return control.open_branch(unsupported=_unsupported,
188
possible_transports=possible_transports)
110
control = bzrdir.BzrDir.open(base, _unsupported,
111
possible_transports=possible_transports)
112
return control.open_branch(_unsupported)
191
def open_from_transport(transport, name=None, _unsupported=False,
192
possible_transports=None):
115
def open_from_transport(transport, _unsupported=False):
193
116
"""Open the branch rooted at transport"""
194
control = controldir.ControlDir.open_from_transport(transport, _unsupported)
195
return control.open_branch(name=name, unsupported=_unsupported,
196
possible_transports=possible_transports)
117
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
118
return control.open_branch(_unsupported)
199
121
def open_containing(url, possible_transports=None):
200
122
"""Open an existing branch which contains url.
202
124
This probes for a branch at url, and searches upwards from there.
204
126
Basically we keep looking up until we find the control directory or
205
127
run into the root. If there isn't one, raises NotBranchError.
206
If there is one and it is either an unrecognised format or an unsupported
128
If there is one and it is either an unrecognised format or an unsupported
207
129
format, UnknownFormatError or UnsupportedFormatError are raised.
208
130
If there is one, it is returned, along with the unused portion of url.
210
control, relpath = controldir.ControlDir.open_containing(url,
132
control, relpath = bzrdir.BzrDir.open_containing(url,
211
133
possible_transports)
212
branch = control.open_branch(possible_transports=possible_transports)
213
return (branch, relpath)
215
def _push_should_merge_tags(self):
216
"""Should _basic_push merge this branch's tags into the target?
218
The default implementation returns False if this branch has no tags,
219
and True the rest of the time. Subclasses may override this.
221
return self.supports_tags() and self.tags.get_tag_dict()
134
return control.open_branch(), relpath
223
136
def get_config(self):
224
"""Get a bzrlib.config.BranchConfig for this Branch.
226
This can then be used to get and set configuration options for the
229
:return: A bzrlib.config.BranchConfig.
231
return _mod_config.BranchConfig(self)
233
def get_config_stack(self):
234
"""Get a bzrlib.config.BranchStack for this Branch.
236
This can then be used to get and set configuration options for the
239
:return: A bzrlib.config.BranchStack.
241
return _mod_config.BranchStack(self)
243
def _get_config(self):
244
"""Get the concrete config for just the config in this branch.
246
This is not intended for client use; see Branch.get_config for the
251
:return: An object supporting get_option and set_option.
253
raise NotImplementedError(self._get_config)
255
def store_uncommitted(self, creator):
256
"""Store uncommitted changes from a ShelfCreator.
258
:param creator: The ShelfCreator containing uncommitted changes, or
259
None to delete any stored changes.
260
:raises: ChangesAlreadyStored if the branch already has changes.
262
raise NotImplementedError(self.store_uncommitted)
264
def get_unshelver(self, tree):
265
"""Return a shelf.Unshelver for this branch and tree.
267
:param tree: The tree to use to construct the Unshelver.
268
:return: an Unshelver or None if no changes are stored.
270
raise NotImplementedError(self.get_unshelver)
272
def _get_fallback_repository(self, url, possible_transports):
273
"""Get the repository we fallback to at url."""
274
url = urlutils.join(self.base, url)
275
a_branch = Branch.open(url, possible_transports=possible_transports)
276
return a_branch.repository
279
def _get_tags_bytes(self):
280
"""Get the bytes of a serialised tags dict.
282
Note that not all branches support tags, nor do all use the same tags
283
logic: this method is specific to BasicTags. Other tag implementations
284
may use the same method name and behave differently, safely, because
285
of the double-dispatch via
286
format.make_tags->tags_instance->get_tags_dict.
288
:return: The bytes of the tags file.
289
:seealso: Branch._set_tags_bytes.
291
if self._tags_bytes is None:
292
self._tags_bytes = self._transport.get_bytes('tags')
293
return self._tags_bytes
295
def _get_nick(self, local=False, possible_transports=None):
296
config = self.get_config()
297
# explicit overrides master, but don't look for master if local is True
298
if not local and not config.has_explicit_nickname():
300
master = self.get_master_branch(possible_transports)
301
if master and self.user_url == master.user_url:
302
raise errors.RecursiveBind(self.user_url)
303
if master is not None:
304
# return the master branch value
306
except errors.RecursiveBind, e:
308
except errors.BzrError, e:
309
# Silently fall back to local implicit nick if the master is
311
mutter("Could not connect to bound branch, "
312
"falling back to local nick.\n " + str(e))
313
return config.get_nickname()
137
return BranchConfig(self)
140
return self.get_config().get_nickname()
315
142
def _set_nick(self, nick):
316
143
self.get_config().set_user_option('nickname', nick, warn_masked=True)
468
194
:return: A dictionary mapping revision_id => dotted revno.
196
last_revision = self.last_revision()
197
revision_graph = repository._old_get_graph(self.repository,
199
merge_sorted_revisions = tsort.merge_sort(
470
204
revision_id_to_revno = dict((rev_id, revno)
471
for rev_id, depth, revno, end_of_merge
472
in self.iter_merge_sorted_revisions())
205
for seq_num, rev_id, depth, revno, end_of_merge
206
in merge_sorted_revisions)
473
207
return revision_id_to_revno
476
def iter_merge_sorted_revisions(self, start_revision_id=None,
477
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
478
"""Walk the revisions for a branch in merge sorted order.
480
Merge sorted order is the output from a merge-aware,
481
topological sort, i.e. all parents come before their
482
children going forward; the opposite for reverse.
484
:param start_revision_id: the revision_id to begin walking from.
485
If None, the branch tip is used.
486
:param stop_revision_id: the revision_id to terminate the walk
487
after. If None, the rest of history is included.
488
:param stop_rule: if stop_revision_id is not None, the precise rule
489
to use for termination:
491
* 'exclude' - leave the stop revision out of the result (default)
492
* 'include' - the stop revision is the last item in the result
493
* 'with-merges' - include the stop revision and all of its
494
merged revisions in the result
495
* 'with-merges-without-common-ancestry' - filter out revisions
496
that are in both ancestries
497
:param direction: either 'reverse' or 'forward':
499
* reverse means return the start_revision_id first, i.e.
500
start at the most recent revision and go backwards in history
501
* forward returns tuples in the opposite order to reverse.
502
Note in particular that forward does *not* do any intelligent
503
ordering w.r.t. depth as some clients of this API may like.
504
(If required, that ought to be done at higher layers.)
506
:return: an iterator over (revision_id, depth, revno, end_of_merge)
509
* revision_id: the unique id of the revision
510
* depth: How many levels of merging deep this node has been
512
* revno_sequence: This field provides a sequence of
513
revision numbers for all revisions. The format is:
514
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
515
branch that the revno is on. From left to right the REVNO numbers
516
are the sequence numbers within that branch of the revision.
517
* end_of_merge: When True the next node (earlier in history) is
518
part of a different merge.
520
# Note: depth and revno values are in the context of the branch so
521
# we need the full graph to get stable numbers, regardless of the
523
if self._merge_sorted_revisions_cache is None:
524
last_revision = self.last_revision()
525
known_graph = self.repository.get_known_graph_ancestry(
527
self._merge_sorted_revisions_cache = known_graph.merge_sort(
529
filtered = self._filter_merge_sorted_revisions(
530
self._merge_sorted_revisions_cache, start_revision_id,
531
stop_revision_id, stop_rule)
532
# Make sure we don't return revisions that are not part of the
533
# start_revision_id ancestry.
534
filtered = self._filter_start_non_ancestors(filtered)
535
if direction == 'reverse':
537
if direction == 'forward':
538
return reversed(list(filtered))
540
raise ValueError('invalid direction %r' % direction)
542
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
543
start_revision_id, stop_revision_id, stop_rule):
544
"""Iterate over an inclusive range of sorted revisions."""
545
rev_iter = iter(merge_sorted_revisions)
546
if start_revision_id is not None:
547
for node in rev_iter:
549
if rev_id != start_revision_id:
552
# The decision to include the start or not
553
# depends on the stop_rule if a stop is provided
554
# so pop this node back into the iterator
555
rev_iter = itertools.chain(iter([node]), rev_iter)
557
if stop_revision_id is None:
559
for node in rev_iter:
561
yield (rev_id, node.merge_depth, node.revno,
563
elif stop_rule == 'exclude':
564
for node in rev_iter:
566
if rev_id == stop_revision_id:
568
yield (rev_id, node.merge_depth, node.revno,
570
elif stop_rule == 'include':
571
for node in rev_iter:
573
yield (rev_id, node.merge_depth, node.revno,
575
if rev_id == stop_revision_id:
577
elif stop_rule == 'with-merges-without-common-ancestry':
578
# We want to exclude all revisions that are already part of the
579
# stop_revision_id ancestry.
580
graph = self.repository.get_graph()
581
ancestors = graph.find_unique_ancestors(start_revision_id,
583
for node in rev_iter:
585
if rev_id not in ancestors:
587
yield (rev_id, node.merge_depth, node.revno,
589
elif stop_rule == 'with-merges':
590
stop_rev = self.repository.get_revision(stop_revision_id)
591
if stop_rev.parent_ids:
592
left_parent = stop_rev.parent_ids[0]
594
left_parent = _mod_revision.NULL_REVISION
595
# left_parent is the actual revision we want to stop logging at,
596
# since we want to show the merged revisions after the stop_rev too
597
reached_stop_revision_id = False
598
revision_id_whitelist = []
599
for node in rev_iter:
601
if rev_id == left_parent:
602
# reached the left parent after the stop_revision
604
if (not reached_stop_revision_id or
605
rev_id in revision_id_whitelist):
606
yield (rev_id, node.merge_depth, node.revno,
608
if reached_stop_revision_id or rev_id == stop_revision_id:
609
# only do the merged revs of rev_id from now on
610
rev = self.repository.get_revision(rev_id)
612
reached_stop_revision_id = True
613
revision_id_whitelist.extend(rev.parent_ids)
615
raise ValueError('invalid stop_rule %r' % stop_rule)
617
def _filter_start_non_ancestors(self, rev_iter):
618
# If we started from a dotted revno, we want to consider it as a tip
619
# and don't want to yield revisions that are not part of its
620
# ancestry. Given the order guaranteed by the merge sort, we will see
621
# uninteresting descendants of the first parent of our tip before the
623
first = rev_iter.next()
624
(rev_id, merge_depth, revno, end_of_merge) = first
627
# We start at a mainline revision so by definition, all others
628
# revisions in rev_iter are ancestors
629
for node in rev_iter:
634
pmap = self.repository.get_parent_map([rev_id])
635
parents = pmap.get(rev_id, [])
637
whitelist.update(parents)
639
# If there is no parents, there is nothing of interest left
641
# FIXME: It's hard to test this scenario here as this code is never
642
# called in that case. -- vila 20100322
645
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
647
if rev_id in whitelist:
648
pmap = self.repository.get_parent_map([rev_id])
649
parents = pmap.get(rev_id, [])
650
whitelist.remove(rev_id)
651
whitelist.update(parents)
653
# We've reached the mainline, there is nothing left to
657
# A revision that is not part of the ancestry of our
660
yield (rev_id, merge_depth, revno, end_of_merge)
662
209
def leave_lock_in_place(self):
663
210
"""Tell this branch object not to release the physical lock when this
664
211
object is unlocked.
666
213
If lock_write doesn't return a token, then this method is not supported.
668
215
self.control_files.leave_in_place()
740
298
:param committer: Optional committer to set for commit.
741
299
:param revprops: Optional dictionary of revision properties.
742
300
:param revision_id: Optional revision id.
743
:param lossy: Whether to discard data that can not be natively
744
represented, when pushing to a foreign VCS
747
if config_stack is None:
748
config_stack = self.get_config_stack()
750
return self.repository.get_commit_builder(self, parents, config_stack,
751
timestamp, timezone, committer, revprops, revision_id,
304
config = self.get_config()
306
return self.repository.get_commit_builder(self, parents, config,
307
timestamp, timezone, committer, revprops, revision_id)
754
309
def get_master_branch(self, possible_transports=None):
755
310
"""Return the branch we are bound to.
757
312
:return: Either a Branch, or None
761
@deprecated_method(deprecated_in((2, 5, 0)))
762
316
def get_revision_delta(self, revno):
763
317
"""Return the delta for one revision.
765
319
The delta is relative to its mainline predecessor, or the
766
320
empty tree for revision 1.
769
revid = self.get_rev_id(revno)
770
except errors.NoSuchRevision:
322
rh = self.revision_history()
323
if not (1 <= revno <= len(rh)):
771
324
raise errors.InvalidRevisionNumber(revno)
772
return self.repository.get_revision_delta(revid)
774
def get_stacked_on_url(self):
775
"""Get the URL this branch is stacked against.
777
:raises NotStacked: If the branch is not stacked.
778
:raises UnstackableBranchFormat: If the branch does not support
781
raise NotImplementedError(self.get_stacked_on_url)
325
return self.repository.get_revision_delta(rh[revno-1])
783
327
def print_file(self, file, revision_id):
784
328
"""Print `file` to stdout."""
785
329
raise NotImplementedError(self.print_file)
788
def set_last_revision_info(self, revno, revision_id):
789
"""Set the last revision of this branch.
791
The caller is responsible for checking that the revno is correct
792
for this revision id.
794
It may be possible to set the branch last revision to an id not
795
present in the repository. However, branches can also be
796
configured to check constraints on history, in which case this may not
799
raise NotImplementedError(self.set_last_revision_info)
802
def generate_revision_history(self, revision_id, last_rev=None,
804
"""See Branch.generate_revision_history"""
805
graph = self.repository.get_graph()
806
(last_revno, last_revid) = self.last_revision_info()
807
known_revision_ids = [
808
(last_revid, last_revno),
809
(_mod_revision.NULL_REVISION, 0),
811
if last_rev is not None:
812
if not graph.is_ancestor(last_rev, revision_id):
813
# our previous tip is not merged into stop_revision
814
raise errors.DivergedBranches(self, other_branch)
815
revno = graph.find_distance_to_null(revision_id, known_revision_ids)
816
self.set_last_revision_info(revno, revision_id)
819
def set_parent(self, url):
820
"""See Branch.set_parent."""
821
# TODO: Maybe delete old location files?
822
# URLs should never be unicode, even on the local fs,
823
# FIXUP this and get_parent in a future branch format bump:
824
# read and rewrite the file. RBC 20060125
826
if isinstance(url, unicode):
828
url = url.encode('ascii')
829
except UnicodeEncodeError:
830
raise errors.InvalidURL(url,
831
"Urls must be 7-bit ascii, "
832
"use bzrlib.urlutils.escape")
833
url = urlutils.relative_url(self.base, url)
834
self._set_parent_location(url)
837
def set_stacked_on_url(self, url):
838
"""Set the URL this branch is stacked against.
840
:raises UnstackableBranchFormat: If the branch does not support
842
:raises UnstackableRepositoryFormat: If the repository does not support
845
if not self._format.supports_stacking():
846
raise errors.UnstackableBranchFormat(self._format, self.user_url)
847
# XXX: Changing from one fallback repository to another does not check
848
# that all the data you need is present in the new fallback.
849
# Possibly it should.
850
self._check_stackable_repo()
853
old_url = self.get_stacked_on_url()
854
except (errors.NotStacked, errors.UnstackableBranchFormat,
855
errors.UnstackableRepositoryFormat):
859
self._activate_fallback_location(url,
860
possible_transports=[self.bzrdir.root_transport])
861
# write this out after the repository is stacked to avoid setting a
862
# stacked config that doesn't work.
863
self._set_config_location('stacked_on_location', url)
866
"""Change a branch to be unstacked, copying data as needed.
868
Don't call this directly, use set_stacked_on_url(None).
870
pb = ui.ui_factory.nested_progress_bar()
872
pb.update(gettext("Unstacking"))
873
# The basic approach here is to fetch the tip of the branch,
874
# including all available ghosts, from the existing stacked
875
# repository into a new repository object without the fallbacks.
877
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
878
# correct for CHKMap repostiories
879
old_repository = self.repository
880
if len(old_repository._fallback_repositories) != 1:
881
raise AssertionError("can't cope with fallback repositories "
882
"of %r (fallbacks: %r)" % (old_repository,
883
old_repository._fallback_repositories))
884
# Open the new repository object.
885
# Repositories don't offer an interface to remove fallback
886
# repositories today; take the conceptually simpler option and just
887
# reopen it. We reopen it starting from the URL so that we
888
# get a separate connection for RemoteRepositories and can
889
# stream from one of them to the other. This does mean doing
890
# separate SSH connection setup, but unstacking is not a
891
# common operation so it's tolerable.
892
new_bzrdir = controldir.ControlDir.open(
893
self.bzrdir.root_transport.base)
894
new_repository = new_bzrdir.find_repository()
895
if new_repository._fallback_repositories:
896
raise AssertionError("didn't expect %r to have "
897
"fallback_repositories"
898
% (self.repository,))
899
# Replace self.repository with the new repository.
900
# Do our best to transfer the lock state (i.e. lock-tokens and
901
# lock count) of self.repository to the new repository.
902
lock_token = old_repository.lock_write().repository_token
903
self.repository = new_repository
904
if isinstance(self, remote.RemoteBranch):
905
# Remote branches can have a second reference to the old
906
# repository that need to be replaced.
907
if self._real_branch is not None:
908
self._real_branch.repository = new_repository
909
self.repository.lock_write(token=lock_token)
910
if lock_token is not None:
911
old_repository.leave_lock_in_place()
912
old_repository.unlock()
913
if lock_token is not None:
914
# XXX: self.repository.leave_lock_in_place() before this
915
# function will not be preserved. Fortunately that doesn't
916
# affect the current default format (2a), and would be a
917
# corner-case anyway.
918
# - Andrew Bennetts, 2010/06/30
919
self.repository.dont_leave_lock_in_place()
923
old_repository.unlock()
924
except errors.LockNotHeld:
927
if old_lock_count == 0:
928
raise AssertionError(
929
'old_repository should have been locked at least once.')
930
for i in range(old_lock_count-1):
931
self.repository.lock_write()
932
# Fetch from the old repository into the new.
933
old_repository.lock_read()
935
# XXX: If you unstack a branch while it has a working tree
936
# with a pending merge, the pending-merged revisions will no
937
# longer be present. You can (probably) revert and remerge.
939
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
940
except errors.TagsNotSupported:
941
tags_to_fetch = set()
942
fetch_spec = vf_search.NotInOtherForRevs(self.repository,
943
old_repository, required_ids=[self.last_revision()],
944
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
945
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
947
old_repository.unlock()
951
def _set_tags_bytes(self, bytes):
952
"""Mirror method for _get_tags_bytes.
954
:seealso: Branch._get_tags_bytes.
956
op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
957
op.add_cleanup(self.lock_write().unlock)
958
return op.run_simple(bytes)
960
def _set_tags_bytes_locked(self, bytes):
961
self._tags_bytes = bytes
962
return self._transport.put_bytes('tags', bytes)
331
def set_revision_history(self, rev_history):
332
raise NotImplementedError(self.set_revision_history)
964
334
def _cache_revision_history(self, rev_history):
965
335
"""Set the cached revision history to rev_history.
1034
404
def unbind(self):
1035
405
"""Older format branches cannot bind or unbind."""
1036
raise errors.UpgradeRequired(self.user_url)
406
raise errors.UpgradeRequired(self.base)
408
def set_append_revisions_only(self, enabled):
409
"""Older format branches are never restricted to append-only"""
410
raise errors.UpgradeRequired(self.base)
1038
412
def last_revision(self):
1039
413
"""Return last revision id, or NULL_REVISION."""
1040
414
return self.last_revision_info()[1]
1043
416
def last_revision_info(self):
1044
417
"""Return information about the last revision.
1046
:return: A tuple (revno, revision_id).
1048
if self._last_revision_info_cache is None:
1049
self._last_revision_info_cache = self._read_last_revision_info()
1050
return self._last_revision_info_cache
1052
def _read_last_revision_info(self):
1053
raise NotImplementedError(self._read_last_revision_info)
1055
def import_last_revision_info_and_tags(self, source, revno, revid,
1057
"""Set the last revision info, importing from another repo if necessary.
1059
This is used by the bound branch code to upload a revision to
1060
the master branch first before updating the tip of the local branch.
1061
Revisions referenced by source's tags are also transferred.
1063
:param source: Source branch to optionally fetch from
1064
:param revno: Revision number of the new tip
1065
:param revid: Revision id of the new tip
1066
:param lossy: Whether to discard metadata that can not be
1067
natively represented
1068
:return: Tuple with the new revision number and revision id
1069
(should only be different from the arguments when lossy=True)
1071
if not self.repository.has_same_location(source.repository):
1072
self.fetch(source, revid)
1073
self.set_last_revision_info(revno, revid)
1074
return (revno, revid)
419
:return: A tuple (revno, last_revision_id).
421
rh = self.revision_history()
424
return (revno, rh[-1])
426
return (0, _mod_revision.NULL_REVISION)
428
@deprecated_method(deprecated_in((1, 6, 0)))
429
def missing_revisions(self, other, stop_revision=None):
430
"""Return a list of new revisions that would perfectly fit.
432
If self and other have not diverged, return a list of the revisions
433
present in other, but missing from self.
435
self_history = self.revision_history()
436
self_len = len(self_history)
437
other_history = other.revision_history()
438
other_len = len(other_history)
439
common_index = min(self_len, other_len) -1
440
if common_index >= 0 and \
441
self_history[common_index] != other_history[common_index]:
442
raise errors.DivergedBranches(self, other)
444
if stop_revision is None:
445
stop_revision = other_len
447
if stop_revision > other_len:
448
raise errors.NoSuchRevision(self, stop_revision)
449
return other_history[self_len:stop_revision]
452
def update_revisions(self, other, stop_revision=None, overwrite=False,
454
"""Pull in new perfect-fit revisions.
456
:param other: Another Branch to pull from
457
:param stop_revision: Updated until the given revision
458
:param overwrite: Always set the branch pointer, rather than checking
459
to see if it is a proper descendant.
460
:param graph: A Graph object that can be used to query history
461
information. This can be None.
466
other_revno, other_last_revision = other.last_revision_info()
467
stop_revno = None # unknown
468
if stop_revision is None:
469
stop_revision = other_last_revision
470
if _mod_revision.is_null(stop_revision):
471
# if there are no commits, we're done.
473
stop_revno = other_revno
475
# what's the current last revision, before we fetch [and change it
477
last_rev = _mod_revision.ensure_null(self.last_revision())
478
# we fetch here so that we don't process data twice in the common
479
# case of having something to pull, and so that the check for
480
# already merged can operate on the just fetched graph, which will
481
# be cached in memory.
482
self.fetch(other, stop_revision)
483
# Check to see if one is an ancestor of the other
486
graph = self.repository.get_graph()
487
heads = graph.heads([stop_revision, last_rev])
488
if heads == set([last_rev]):
489
# The current revision is a decendent of the target,
492
elif heads == set([stop_revision, last_rev]):
493
# These branches have diverged
494
raise errors.DivergedBranches(self, other)
495
elif heads != set([stop_revision]):
496
raise AssertionError("invalid heads: %r" % heads)
497
if stop_revno is None:
499
graph = self.repository.get_graph()
500
this_revno, this_last_revision = self.last_revision_info()
501
stop_revno = graph.find_distance_to_null(stop_revision,
502
[(other_last_revision, other_revno),
503
(this_last_revision, this_revno)])
504
self.set_last_revision_info(stop_revno, stop_revision)
1076
510
def revision_id_to_revno(self, revision_id):
1077
511
"""Given a revision id, return its revno"""
1078
512
if _mod_revision.is_null(revision_id):
1080
history = self._revision_history()
514
history = self.revision_history()
1082
516
return history.index(revision_id) + 1
1083
517
except ValueError:
1084
518
raise errors.NoSuchRevision(self, revision_id)
1087
520
def get_rev_id(self, revno, history=None):
1088
521
"""Find the revision id of the specified revno."""
1090
523
return _mod_revision.NULL_REVISION
1091
last_revno, last_revid = self.last_revision_info()
1092
if revno == last_revno:
1094
if revno <= 0 or revno > last_revno:
525
history = self.revision_history()
526
if revno <= 0 or revno > len(history):
1095
527
raise errors.NoSuchRevision(self, revno)
1096
distance_from_last = last_revno - revno
1097
if len(self._partial_revision_history_cache) <= distance_from_last:
1098
self._extend_partial_history(distance_from_last)
1099
return self._partial_revision_history_cache[distance_from_last]
528
return history[revno - 1]
1101
530
def pull(self, source, overwrite=False, stop_revision=None,
1102
possible_transports=None, *args, **kwargs):
531
possible_transports=None):
1103
532
"""Mirror source into this branch.
1105
534
This branch is considered to be 'local', having low latency.
1107
536
:returns: PullResult instance
1109
return InterBranch.get(source, self).pull(overwrite=overwrite,
1110
stop_revision=stop_revision,
1111
possible_transports=possible_transports, *args, **kwargs)
538
raise NotImplementedError(self.pull)
1113
def push(self, target, overwrite=False, stop_revision=None, lossy=False,
540
def push(self, target, overwrite=False, stop_revision=None):
1115
541
"""Mirror this branch into target.
1117
543
This branch is considered to be 'local', having low latency.
1119
return InterBranch.get(self, target).push(overwrite, stop_revision,
1120
lossy, *args, **kwargs)
545
raise NotImplementedError(self.push)
1122
547
def basis_tree(self):
1123
548
"""Return `Tree` object for last revision."""
1124
549
return self.repository.revision_tree(self.last_revision())
551
def rename_one(self, from_rel, to_rel):
554
This can change the directory or the filename or both.
556
raise NotImplementedError(self.rename_one)
558
def move(self, from_paths, to_name):
561
to_name must exist as a versioned directory.
563
If to_name exists and is a directory, the files are moved into
564
it, keeping their old names. If it is a directory,
566
Note that to_name is only the last component of the new name;
567
this doesn't change the directory.
569
This returns a list of (from_path, to_path) pairs for each
572
raise NotImplementedError(self.move)
1126
574
def get_parent(self):
1127
575
"""Return the parent location of the branch.
1129
This is the default location for pull/missing. The usual
577
This is the default location for push/pull/missing. The usual
1130
578
pattern is that the user can override it by specifying a
1133
parent = self._get_parent_location()
1136
# This is an old-format absolute path to a local branch
1137
# turn it into a url
1138
if parent.startswith('/'):
1139
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1141
return urlutils.join(self.base[:-1], parent)
1142
except errors.InvalidURLJoin, e:
1143
raise errors.InaccessibleParent(parent, self.user_url)
1145
def _get_parent_location(self):
1146
raise NotImplementedError(self._get_parent_location)
581
raise NotImplementedError(self.get_parent)
1148
583
def _set_config_location(self, name, url, config=None,
1149
584
make_relative=False):
1150
585
if config is None:
1151
config = self.get_config_stack()
586
config = self.get_config()
1154
589
elif make_relative:
1155
590
url = urlutils.relative_url(self.base, url)
1156
config.set(name, url)
591
config.set_user_option(name, url, warn_masked=True)
1158
593
def _get_config_location(self, name, config=None):
1159
594
if config is None:
1160
config = self.get_config_stack()
1161
location = config.get(name)
595
config = self.get_config()
596
location = config.get_user_option(name)
1162
597
if location == '':
1166
def get_child_submit_format(self):
1167
"""Return the preferred format of submissions to this branch."""
1168
return self.get_config_stack().get('child_submit_format')
1170
601
def get_submit_branch(self):
1171
602
"""Return the submit location of the branch.
1256
670
raise errors.InvalidRevisionNumber(revno)
1258
672
@needs_read_lock
1259
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
673
def clone(self, to_bzrdir, revision_id=None):
1260
674
"""Clone this branch into to_bzrdir preserving all semantic values.
1262
Most API users will want 'create_clone_on_transport', which creates a
1263
new bzrdir and branch on the fly.
1265
676
revision_id: if not None, the revision history in the new branch will
1266
677
be truncated to end with revision_id.
1268
result = to_bzrdir.create_branch()
1271
if repository_policy is not None:
1272
repository_policy.configure_branch(result)
1273
self.copy_content_into(result, revision_id=revision_id)
679
result = self._format.initialize(to_bzrdir)
680
self.copy_content_into(result, revision_id=revision_id)
1278
683
@needs_read_lock
1279
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
684
def sprout(self, to_bzrdir, revision_id=None):
1281
685
"""Create a new line of development from the branch, into to_bzrdir.
1283
to_bzrdir controls the branch format.
1285
687
revision_id: if not None, the revision history in the new branch will
1286
688
be truncated to end with revision_id.
1288
if (repository_policy is not None and
1289
repository_policy.requires_stacking()):
1290
to_bzrdir._format.require_stacking(_skip_repo=True)
1291
result = to_bzrdir.create_branch(repository=repository)
1294
if repository_policy is not None:
1295
repository_policy.configure_branch(result)
1296
self.copy_content_into(result, revision_id=revision_id)
1297
master_url = self.get_bound_location()
1298
if master_url is None:
1299
result.set_parent(self.bzrdir.root_transport.base)
1301
result.set_parent(master_url)
690
result = self._format.initialize(to_bzrdir)
691
self.copy_content_into(result, revision_id=revision_id)
692
result.set_parent(self.bzrdir.root_transport.base)
1306
695
def _synchronize_history(self, destination, revision_id):
1307
696
"""Synchronize last revision and revision history between branches.
1309
698
This version is most efficient when the destination is also a
1310
BzrBranch6, but works for BzrBranch5, as long as the destination's
1311
repository contains all the lefthand ancestors of the intended
1312
last_revision. If not, set_last_revision_info will fail.
699
BzrBranch5, but works for BzrBranch6 as long as the revision
700
history is the true lefthand parent history, and all of the revisions
701
are in the destination's repository. If not, set_revision_history
1314
704
:param destination: The branch to copy the history into
1315
705
:param revision_id: The revision-id to truncate history at. May
1316
706
be None to copy complete history.
1318
source_revno, source_revision_id = self.last_revision_info()
1319
if revision_id is None:
1320
revno, revision_id = source_revno, source_revision_id
1322
graph = self.repository.get_graph()
708
if revision_id == _mod_revision.NULL_REVISION:
710
new_history = self.revision_history()
711
if revision_id is not None and new_history != []:
1324
revno = graph.find_distance_to_null(revision_id,
1325
[(source_revision_id, source_revno)])
1326
except errors.GhostRevisionsHaveNoRevno:
1327
# Default to 1, if we can't find anything else
1329
destination.set_last_revision_info(revno, revision_id)
713
new_history = new_history[:new_history.index(revision_id) + 1]
715
rev = self.repository.get_revision(revision_id)
716
new_history = rev.get_history(self.repository)[1:]
717
destination.set_revision_history(new_history)
1331
720
def copy_content_into(self, destination, revision_id=None):
1332
721
"""Copy the content of self into destination.
1334
723
revision_id: if not None, the revision history in the new branch will
1335
724
be truncated to end with revision_id.
1337
return InterBranch.get(self, destination).copy_content_into(
1338
revision_id=revision_id)
1340
def update_references(self, target):
1341
if not getattr(self._format, 'supports_reference_locations', False):
1343
reference_dict = self._get_all_reference_info()
1344
if len(reference_dict) == 0:
1346
old_base = self.base
1347
new_base = target.base
1348
target_reference_dict = target._get_all_reference_info()
1349
for file_id, (tree_path, branch_location) in (
1350
reference_dict.items()):
1351
branch_location = urlutils.rebase_url(branch_location,
1353
target_reference_dict.setdefault(
1354
file_id, (tree_path, branch_location))
1355
target._set_all_reference_info(target_reference_dict)
726
self._synchronize_history(destination, revision_id)
728
parent = self.get_parent()
729
except errors.InaccessibleParent, e:
730
mutter('parent was not accessible to copy: %s', e)
733
destination.set_parent(parent)
734
self.tags.merge_to(destination.tags)
1357
736
@needs_read_lock
1358
def check(self, refs):
1359
738
"""Check consistency of the branch.
1361
740
In particular this checks that revisions given in the revision-history
1362
do actually match up in the revision graph, and that they're all
741
do actually match up in the revision graph, and that they're all
1363
742
present in the repository.
1365
744
Callers will typically also want to check the repository.
1367
:param refs: Calculated refs for this branch as specified by
1368
branch._get_check_refs()
1369
746
:return: A BranchCheckResult.
1371
result = BranchCheckResult(self)
748
mainline_parent_id = None
1372
749
last_revno, last_revision_id = self.last_revision_info()
1373
actual_revno = refs[('lefthand-distance', last_revision_id)]
1374
if actual_revno != last_revno:
1375
result.errors.append(errors.BzrCheckError(
1376
'revno does not match len(mainline) %s != %s' % (
1377
last_revno, actual_revno)))
1378
# TODO: We should probably also check that self.revision_history
1379
# matches the repository for older branch formats.
1380
# If looking for the code that cross-checks repository parents against
1381
# the Graph.iter_lefthand_ancestry output, that is now a repository
750
real_rev_history = list(self.repository.iter_reverse_revision_history(
752
real_rev_history.reverse()
753
if len(real_rev_history) != last_revno:
754
raise errors.BzrCheckError('revno does not match len(mainline)'
755
' %s != %s' % (last_revno, len(real_rev_history)))
756
# TODO: We should probably also check that real_rev_history actually
757
# matches self.revision_history()
758
for revision_id in real_rev_history:
760
revision = self.repository.get_revision(revision_id)
761
except errors.NoSuchRevision, e:
762
raise errors.BzrCheckError("mainline revision {%s} not in repository"
764
# In general the first entry on the revision history has no parents.
765
# But it's not illegal for it to have parents listed; this can happen
766
# in imports from Arch when the parents weren't reachable.
767
if mainline_parent_id is not None:
768
if mainline_parent_id not in revision.parent_ids:
769
raise errors.BzrCheckError("previous revision {%s} not listed among "
771
% (mainline_parent_id, revision_id))
772
mainline_parent_id = revision_id
773
return BranchCheckResult(self)
1385
def _get_checkout_format(self, lightweight=False):
775
def _get_checkout_format(self):
1386
776
"""Return the most suitable metadir for a checkout of this branch.
1387
777
Weaves are used if this branch's repository uses weaves.
1389
format = self.repository.bzrdir.checkout_metadir()
1390
format.set_branch_format(self._format)
779
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
780
from bzrlib.repofmt import weaverepo
781
format = bzrdir.BzrDirMetaFormat1()
782
format.repository_format = weaverepo.RepositoryFormat7()
784
format = self.repository.bzrdir.checkout_metadir()
785
format.set_branch_format(self._format)
1393
def create_clone_on_transport(self, to_transport, revision_id=None,
1394
stacked_on=None, create_prefix=False, use_existing_dir=False,
1396
"""Create a clone of this branch and its bzrdir.
1398
:param to_transport: The transport to clone onto.
1399
:param revision_id: The revision id to use as tip in the new branch.
1400
If None the tip is obtained from this branch.
1401
:param stacked_on: An optional URL to stack the clone on.
1402
:param create_prefix: Create any missing directories leading up to
1404
:param use_existing_dir: Use an existing directory if one exists.
1406
# XXX: Fix the bzrdir API to allow getting the branch back from the
1407
# clone call. Or something. 20090224 RBC/spiv.
1408
# XXX: Should this perhaps clone colocated branches as well,
1409
# rather than just the default branch? 20100319 JRV
1410
if revision_id is None:
1411
revision_id = self.last_revision()
1412
dir_to = self.bzrdir.clone_on_transport(to_transport,
1413
revision_id=revision_id, stacked_on=stacked_on,
1414
create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1416
return dir_to.open_branch()
1418
788
def create_checkout(self, to_location, revision_id=None,
1419
789
lightweight=False, accelerator_tree=None,
1420
790
hardlink=False):
1421
791
"""Create a checkout of a branch.
1423
793
:param to_location: The url to produce the checkout at
1424
794
:param revision_id: The revision to check out
1425
795
:param lightweight: If True, produce a lightweight checkout, otherwise,
1426
produce a bound branch (heavyweight checkout)
796
produce a bound branch (heavyweight checkout)
1427
797
:param accelerator_tree: A tree which can be used for retrieving file
1428
798
contents more quickly than the revision tree, i.e. a workingtree.
1429
799
The revision tree will be used for cases where accelerator_tree's
1487
842
reconciler.reconcile()
1488
843
return reconciler
1490
def reference_parent(self, file_id, path, possible_transports=None):
845
def reference_parent(self, file_id, path):
1491
846
"""Return the parent branch for a tree-reference file_id
1493
847
:param file_id: The file_id of the tree reference
1494
848
:param path: The path of the file_id in the tree
1495
849
:return: A branch associated with the file_id
1497
851
# FIXME should provide multiple branches, based on config
1498
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1499
possible_transports=possible_transports)
852
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1501
854
def supports_tags(self):
1502
855
return self._format.supports_tags()
1504
def automatic_tag_name(self, revision_id):
1505
"""Try to automatically find the tag name for a revision.
1507
:param revision_id: Revision id of the revision.
1508
:return: A tag name or None if no tag name could be determined.
1510
for hook in Branch.hooks['automatic_tag_name']:
1511
ret = hook(self, revision_id)
1516
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1518
"""Ensure that revision_b is a descendant of revision_a.
1520
This is a helper function for update_revisions.
1522
:raises: DivergedBranches if revision_b has diverged from revision_a.
1523
:returns: True if revision_b is a descendant of revision_a.
1525
relation = self._revision_relations(revision_a, revision_b, graph)
1526
if relation == 'b_descends_from_a':
1528
elif relation == 'diverged':
1529
raise errors.DivergedBranches(self, other_branch)
1530
elif relation == 'a_descends_from_b':
1533
raise AssertionError("invalid relation: %r" % (relation,))
1535
def _revision_relations(self, revision_a, revision_b, graph):
1536
"""Determine the relationship between two revisions.
1538
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1540
heads = graph.heads([revision_a, revision_b])
1541
if heads == set([revision_b]):
1542
return 'b_descends_from_a'
1543
elif heads == set([revision_a, revision_b]):
1544
# These branches have diverged
1546
elif heads == set([revision_a]):
1547
return 'a_descends_from_b'
1549
raise AssertionError("invalid heads: %r" % (heads,))
1551
def heads_to_fetch(self):
1552
"""Return the heads that must and that should be fetched to copy this
1553
branch into another repo.
1555
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1556
set of heads that must be fetched. if_present_fetch is a set of
1557
heads that must be fetched if present, but no error is necessary if
1558
they are not present.
1560
# For bzr native formats must_fetch is just the tip, and
1561
# if_present_fetch are the tags.
1562
must_fetch = set([self.last_revision()])
1563
if_present_fetch = set()
1564
if self.get_config_stack().get('branch.fetch_tags'):
1566
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1567
except errors.TagsNotSupported:
1569
must_fetch.discard(_mod_revision.NULL_REVISION)
1570
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1571
return must_fetch, if_present_fetch
1574
class BranchFormat(controldir.ControlComponentFormat):
858
class BranchFormat(object):
1575
859
"""An encapsulation of the initialization and open routines for a format.
1577
861
Formats provide three things:
1578
862
* An initialization routine,
1579
* a format description
1580
864
* an open routine.
1582
Formats are placed in an dict by their format string for reference
1583
during branch opening. It's not required that these be instances, they
1584
can be classes themselves with class methods - it simply depends on
866
Formats are placed in an dict by their format string for reference
867
during branch opening. Its not required that these be instances, they
868
can be classes themselves with class methods - it simply depends on
1585
869
whether state is needed for a given format or not.
1587
871
Once a format is deprecated, just deprecate the initialize and open
1588
methods on the format class. Do not deprecate the object, as the
872
methods on the format class. Do not deprecate the object, as the
1589
873
object will be created every time regardless.
876
_default_format = None
877
"""The default format used for new branches."""
880
"""The known formats."""
1592
882
def __eq__(self, other):
1593
883
return self.__class__ is other.__class__
1595
885
def __ne__(self, other):
1596
886
return not (self == other)
1598
def get_reference(self, controldir, name=None):
1599
"""Get the target reference of the branch in controldir.
889
def find_format(klass, a_bzrdir):
890
"""Return the format for the branch object in a_bzrdir."""
892
transport = a_bzrdir.get_branch_transport(None)
893
format_string = transport.get("format").read()
894
return klass._formats[format_string]
895
except errors.NoSuchFile:
896
raise errors.NotBranchError(path=transport.base)
898
raise errors.UnknownFormatError(format=format_string, kind='branch')
901
def get_default_format(klass):
902
"""Return the current default format."""
903
return klass._default_format
905
def get_reference(self, a_bzrdir):
906
"""Get the target reference of the branch in a_bzrdir.
1601
908
format probing must have been completed before calling
1602
909
this method - it is assumed that the format of the branch
1603
in controldir is correct.
910
in a_bzrdir is correct.
1605
:param controldir: The controldir to get the branch data from.
1606
:param name: Name of the colocated branch to fetch
912
:param a_bzrdir: The bzrdir to get the branch data from.
1607
913
:return: None if the branch is not a reference branch.
1612
def set_reference(self, controldir, name, to_branch):
1613
"""Set the target reference of the branch in controldir.
918
def set_reference(self, a_bzrdir, to_branch):
919
"""Set the target reference of the branch in a_bzrdir.
1615
921
format probing must have been completed before calling
1616
922
this method - it is assumed that the format of the branch
1617
in controldir is correct.
923
in a_bzrdir is correct.
1619
:param controldir: The controldir to set the branch reference for.
1620
:param name: Name of colocated branch to set, None for default
925
:param a_bzrdir: The bzrdir to set the branch reference for.
1621
926
:param to_branch: branch that the checkout is to reference
1623
928
raise NotImplementedError(self.set_reference)
930
def get_format_string(self):
931
"""Return the ASCII format string that identifies this format."""
932
raise NotImplementedError(self.get_format_string)
1625
934
def get_format_description(self):
1626
935
"""Return the short format description for this format."""
1627
936
raise NotImplementedError(self.get_format_description)
1629
def _run_post_branch_init_hooks(self, controldir, name, branch):
1630
hooks = Branch.hooks['post_branch_init']
1633
params = BranchInitHookParams(self, controldir, name, branch)
1637
def initialize(self, controldir, name=None, repository=None,
1638
append_revisions_only=None):
1639
"""Create a branch of this format in controldir.
1641
:param name: Name of the colocated branch to create.
938
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
940
"""Initialize a branch in a bzrdir, with specified files
942
:param a_bzrdir: The bzrdir to initialize the branch in
943
:param utf8_files: The files to create as a list of
944
(filename, content) tuples
945
:param set_format: If True, set the format with
946
self.get_format_string. (BzrBranch4 has its format set
948
:return: a branch in this format
950
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
951
branch_transport = a_bzrdir.get_branch_transport(self)
953
'metadir': ('lock', lockdir.LockDir),
954
'branch4': ('branch-lock', lockable_files.TransportLock),
956
lock_name, lock_class = lock_map[lock_type]
957
control_files = lockable_files.LockableFiles(branch_transport,
958
lock_name, lock_class)
959
control_files.create_lock()
960
control_files.lock_write()
962
utf8_files += [('format', self.get_format_string())]
964
for (filename, content) in utf8_files:
965
branch_transport.put_bytes(
967
mode=a_bzrdir._get_file_mode())
969
control_files.unlock()
970
return self.open(a_bzrdir, _found=True)
972
def initialize(self, a_bzrdir):
973
"""Create a branch of this format in a_bzrdir."""
1643
974
raise NotImplementedError(self.initialize)
1645
976
def is_supported(self):
1646
977
"""Is this format supported?
1648
979
Supported formats can be initialized and opened.
1649
Unsupported formats may not support initialization or committing or
980
Unsupported formats may not support initialization or committing or
1650
981
some other features depending on the reason for not being supported.
1654
def make_tags(self, branch):
1655
"""Create a tags object for branch.
1657
This method is on BranchFormat, because BranchFormats are reflected
1658
over the wire via network_name(), whereas full Branch instances require
1659
multiple VFS method calls to operate at all.
1661
The default implementation returns a disabled-tags instance.
1663
Note that it is normal for branch to be a RemoteBranch when using tags
1666
return _mod_tag.DisabledTags(branch)
1668
def network_name(self):
1669
"""A simple byte string uniquely identifying this format for RPC calls.
1671
MetaDir branch formats use their disk format string to identify the
1672
repository over the wire. All in one formats such as bzr < 0.8, and
1673
foreign formats like svn/git and hg should use some marker which is
1674
unique and immutable.
1676
raise NotImplementedError(self.network_name)
1678
def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
1679
found_repository=None, possible_transports=None):
1680
"""Return the branch object for controldir.
1682
:param controldir: A ControlDir that contains a branch.
1683
:param name: Name of colocated branch to open
1684
:param _found: a private parameter, do not use it. It is used to
1685
indicate if format probing has already be done.
1686
:param ignore_fallbacks: when set, no fallback branches will be opened
1687
(if there are any). Default is to open fallbacks.
985
def open(self, a_bzrdir, _found=False):
986
"""Return the branch object for a_bzrdir
988
_found is a private parameter, do not use it. It is used to indicate
989
if format probing has already be done.
1689
991
raise NotImplementedError(self.open)
1691
def supports_set_append_revisions_only(self):
1692
"""True if this format supports set_append_revisions_only."""
1695
def supports_stacking(self):
1696
"""True if this format records a stacked-on branch."""
1699
def supports_leaving_lock(self):
1700
"""True if this format supports leaving locks in place."""
1701
return False # by default
994
def register_format(klass, format):
995
klass._formats[format.get_format_string()] = format
998
def set_default_format(klass, format):
999
klass._default_format = format
1002
def unregister_format(klass, format):
1003
del klass._formats[format.get_format_string()]
1703
1005
def __str__(self):
1704
return self.get_format_description().rstrip()
1006
return self.get_format_string().rstrip()
1706
1008
def supports_tags(self):
1707
1009
"""True if this format supports tags stored in the branch"""
1708
1010
return False # by default
1710
def tags_are_versioned(self):
1711
"""Whether the tag container for this branch versions tags."""
1714
def supports_tags_referencing_ghosts(self):
1715
"""True if tags can reference ghost revisions."""
1719
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1720
"""A factory for a BranchFormat object, permitting simple lazy registration.
1722
While none of the built in BranchFormats are lazy registered yet,
1723
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1724
use it, and the bzr-loom plugin uses it as well (see
1725
bzrlib.plugins.loom.formats).
1728
def __init__(self, format_string, module_name, member_name):
1729
"""Create a MetaDirBranchFormatFactory.
1731
:param format_string: The format string the format has.
1732
:param module_name: Module to load the format class from.
1733
:param member_name: Attribute name within the module for the format class.
1735
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1736
self._format_string = format_string
1738
def get_format_string(self):
1739
"""See BranchFormat.get_format_string."""
1740
return self._format_string
1743
"""Used for network_format_registry support."""
1744
return self.get_obj()()
1747
1013
class BranchHooks(Hooks):
1748
1014
"""A dictionary mapping hook name to a list of callables for branch hooks.
1750
e.g. ['post_push'] Is the list of items to be called when the
1751
push function is invoked.
1016
e.g. ['set_rh'] Is the list of items to be called when the
1017
set_revision_history function is invoked.
1754
1020
def __init__(self):
1757
1023
These are all empty initially, because by default nothing should get
1760
Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1761
self.add_hook('open',
1762
"Called with the Branch object that has been opened after a "
1763
"branch is opened.", (1, 8))
1764
self.add_hook('post_push',
1765
"Called after a push operation completes. post_push is called "
1766
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1767
"bzr client.", (0, 15))
1768
self.add_hook('post_pull',
1769
"Called after a pull operation completes. post_pull is called "
1770
"with a bzrlib.branch.PullResult object and only runs in the "
1771
"bzr client.", (0, 15))
1772
self.add_hook('pre_commit',
1773
"Called after a commit is calculated but before it is "
1774
"completed. pre_commit is called with (local, master, old_revno, "
1775
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1776
"). old_revid is NULL_REVISION for the first commit to a branch, "
1777
"tree_delta is a TreeDelta object describing changes from the "
1778
"basis revision. hooks MUST NOT modify this delta. "
1779
" future_tree is an in-memory tree obtained from "
1780
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1782
self.add_hook('post_commit',
1783
"Called in the bzr client after a commit has completed. "
1784
"post_commit is called with (local, master, old_revno, old_revid, "
1785
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1786
"commit to a branch.", (0, 15))
1787
self.add_hook('post_uncommit',
1788
"Called in the bzr client after an uncommit completes. "
1789
"post_uncommit is called with (local, master, old_revno, "
1790
"old_revid, new_revno, new_revid) where local is the local branch "
1791
"or None, master is the target branch, and an empty branch "
1792
"receives new_revno of 0, new_revid of None.", (0, 15))
1793
self.add_hook('pre_change_branch_tip',
1794
"Called in bzr client and server before a change to the tip of a "
1795
"branch is made. pre_change_branch_tip is called with a "
1796
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1797
"commit, uncommit will all trigger this hook.", (1, 6))
1798
self.add_hook('post_change_branch_tip',
1799
"Called in bzr client and server after a change to the tip of a "
1800
"branch is made. post_change_branch_tip is called with a "
1801
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1802
"commit, uncommit will all trigger this hook.", (1, 4))
1803
self.add_hook('transform_fallback_location',
1804
"Called when a stacked branch is activating its fallback "
1805
"locations. transform_fallback_location is called with (branch, "
1806
"url), and should return a new url. Returning the same url "
1807
"allows it to be used as-is, returning a different one can be "
1808
"used to cause the branch to stack on a closer copy of that "
1809
"fallback_location. Note that the branch cannot have history "
1810
"accessing methods called on it during this hook because the "
1811
"fallback locations have not been activated. When there are "
1812
"multiple hooks installed for transform_fallback_location, "
1813
"all are called with the url returned from the previous hook."
1814
"The order is however undefined.", (1, 9))
1815
self.add_hook('automatic_tag_name',
1816
"Called to determine an automatic tag name for a revision. "
1817
"automatic_tag_name is called with (branch, revision_id) and "
1818
"should return a tag name or None if no tag name could be "
1819
"determined. The first non-None tag name returned will be used.",
1821
self.add_hook('post_branch_init',
1822
"Called after new branch initialization completes. "
1823
"post_branch_init is called with a "
1824
"bzrlib.branch.BranchInitHookParams. "
1825
"Note that init, branch and checkout (both heavyweight and "
1826
"lightweight) will all trigger this hook.", (2, 2))
1827
self.add_hook('post_switch',
1828
"Called after a checkout switches branch. "
1829
"post_switch is called with a "
1830
"bzrlib.branch.SwitchHookParams.", (2, 2))
1026
Hooks.__init__(self)
1027
# Introduced in 0.15:
1028
# invoked whenever the revision history has been set
1029
# with set_revision_history. The api signature is
1030
# (branch, revision_history), and the branch will
1033
# invoked after a push operation completes.
1034
# the api signature is
1036
# containing the members
1037
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1038
# where local is the local target branch or None, master is the target
1039
# master branch, and the rest should be self explanatory. The source
1040
# is read locked and the target branches write locked. Source will
1041
# be the local low-latency branch.
1042
self['post_push'] = []
1043
# invoked after a pull operation completes.
1044
# the api signature is
1046
# containing the members
1047
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1048
# where local is the local branch or None, master is the target
1049
# master branch, and the rest should be self explanatory. The source
1050
# is read locked and the target branches write locked. The local
1051
# branch is the low-latency branch.
1052
self['post_pull'] = []
1053
# invoked before a commit operation takes place.
1054
# the api signature is
1055
# (local, master, old_revno, old_revid, future_revno, future_revid,
1056
# tree_delta, future_tree).
1057
# old_revid is NULL_REVISION for the first commit to a branch
1058
# tree_delta is a TreeDelta object describing changes from the basis
1059
# revision, hooks MUST NOT modify this delta
1060
# future_tree is an in-memory tree obtained from
1061
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1062
self['pre_commit'] = []
1063
# invoked after a commit operation completes.
1064
# the api signature is
1065
# (local, master, old_revno, old_revid, new_revno, new_revid)
1066
# old_revid is NULL_REVISION for the first commit to a branch.
1067
self['post_commit'] = []
1068
# invoked after a uncommit operation completes.
1069
# the api signature is
1070
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1071
# local is the local branch or None, master is the target branch,
1072
# and an empty branch recieves new_revno of 0, new_revid of None.
1073
self['post_uncommit'] = []
1075
# Invoked after the tip of a branch changes.
1076
# the api signature is
1077
# (params) where params is a ChangeBranchTipParams with the members
1078
# (branch, old_revno, new_revno, old_revid, new_revid)
1079
self['post_change_branch_tip'] = []
1834
1082
# install the default hooks into the Branch class.
1864
1112
self.old_revid = old_revid
1865
1113
self.new_revid = new_revid
1867
def __eq__(self, other):
1868
return self.__dict__ == other.__dict__
1871
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1872
self.__class__.__name__, self.branch,
1873
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1876
class BranchInitHookParams(object):
1877
"""Object holding parameters passed to `*_branch_init` hooks.
1879
There are 4 fields that hooks may wish to access:
1881
:ivar format: the branch format
1882
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1883
:ivar name: name of colocated branch, if any (or None)
1884
:ivar branch: the branch created
1886
Note that for lightweight checkouts, the bzrdir and format fields refer to
1887
the checkout, hence they are different from the corresponding fields in
1888
branch, which refer to the original branch.
1891
def __init__(self, format, controldir, name, branch):
1892
"""Create a group of BranchInitHook parameters.
1894
:param format: the branch format
1895
:param controldir: the ControlDir where the branch will be/has been
1897
:param name: name of colocated branch, if any (or None)
1898
:param branch: the branch created
1900
Note that for lightweight checkouts, the bzrdir and format fields refer
1901
to the checkout, hence they are different from the corresponding fields
1902
in branch, which refer to the original branch.
1904
self.format = format
1905
self.bzrdir = controldir
1907
self.branch = branch
1909
def __eq__(self, other):
1910
return self.__dict__ == other.__dict__
1913
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1916
class SwitchHookParams(object):
1917
"""Object holding parameters passed to `*_switch` hooks.
1919
There are 4 fields that hooks may wish to access:
1921
:ivar control_dir: ControlDir of the checkout to change
1922
:ivar to_branch: branch that the checkout is to reference
1923
:ivar force: skip the check for local commits in a heavy checkout
1924
:ivar revision_id: revision ID to switch to (or None)
1927
def __init__(self, control_dir, to_branch, force, revision_id):
1928
"""Create a group of SwitchHook parameters.
1930
:param control_dir: ControlDir of the checkout to change
1931
:param to_branch: branch that the checkout is to reference
1932
:param force: skip the check for local commits in a heavy checkout
1933
:param revision_id: revision ID to switch to (or None)
1935
self.control_dir = control_dir
1936
self.to_branch = to_branch
1938
self.revision_id = revision_id
1940
def __eq__(self, other):
1941
return self.__dict__ == other.__dict__
1944
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1945
self.control_dir, self.to_branch,
1949
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
1950
"""Base class for branch formats that live in meta directories.
1954
BranchFormat.__init__(self)
1955
bzrdir.BzrFormat.__init__(self)
1958
def find_format(klass, controldir, name=None):
1959
"""Return the format for the branch object in controldir."""
1961
transport = controldir.get_branch_transport(None, name=name)
1962
except errors.NoSuchFile:
1963
raise errors.NotBranchError(path=name, bzrdir=controldir)
1965
format_string = transport.get_bytes("format")
1966
except errors.NoSuchFile:
1967
raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
1968
return klass._find_format(format_registry, 'branch', format_string)
1970
def _branch_class(self):
1971
"""What class to instantiate on open calls."""
1972
raise NotImplementedError(self._branch_class)
1974
def _get_initial_config(self, append_revisions_only=None):
1975
if append_revisions_only:
1976
return "append_revisions_only = True\n"
1978
# Avoid writing anything if append_revisions_only is disabled,
1979
# as that is the default.
1982
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1984
"""Initialize a branch in a control dir, with specified files
1986
:param a_bzrdir: The bzrdir to initialize the branch in
1987
:param utf8_files: The files to create as a list of
1988
(filename, content) tuples
1989
:param name: Name of colocated branch to create, if any
1990
:return: a branch in this format
1993
name = a_bzrdir._get_selected_branch()
1994
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1995
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1996
control_files = lockable_files.LockableFiles(branch_transport,
1997
'lock', lockdir.LockDir)
1998
control_files.create_lock()
1999
control_files.lock_write()
2001
utf8_files += [('format', self.as_string())]
2002
for (filename, content) in utf8_files:
2003
branch_transport.put_bytes(
2005
mode=a_bzrdir._get_file_mode())
2007
control_files.unlock()
2008
branch = self.open(a_bzrdir, name, _found=True,
2009
found_repository=repository)
2010
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2013
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2014
found_repository=None, possible_transports=None):
2015
"""See BranchFormat.open()."""
2017
name = a_bzrdir._get_selected_branch()
2019
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
1116
class BzrBranchFormat4(BranchFormat):
1117
"""Bzr branch format 4.
1120
- a revision-history file.
1121
- a branch-lock lock file [ to be shared with the bzrdir ]
1124
def get_format_description(self):
1125
"""See BranchFormat.get_format_description()."""
1126
return "Branch format 4"
1128
def initialize(self, a_bzrdir):
1129
"""Create a branch of this format in a_bzrdir."""
1130
utf8_files = [('revision-history', ''),
1131
('branch-name', ''),
1133
return self._initialize_helper(a_bzrdir, utf8_files,
1134
lock_type='branch4', set_format=False)
1137
super(BzrBranchFormat4, self).__init__()
1138
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1140
def open(self, a_bzrdir, _found=False):
1141
"""Return the branch object for a_bzrdir
1143
_found is a private parameter, do not use it. It is used to indicate
1144
if format probing has already be done.
1147
# we are being called directly and must probe.
1148
raise NotImplementedError
1149
return BzrBranch(_format=self,
1150
_control_files=a_bzrdir._control_files,
1152
_repository=a_bzrdir.open_repository())
1155
return "Bazaar-NG branch format 4"
1158
class BzrBranchFormat5(BranchFormat):
1159
"""Bzr branch format 5.
1162
- a revision-history file.
1164
- a lock dir guarding the branch itself
1165
- all of this stored in a branch/ subdirectory
1166
- works with shared repositories.
1168
This format is new in bzr 0.8.
1171
def get_format_string(self):
1172
"""See BranchFormat.get_format_string()."""
1173
return "Bazaar-NG branch format 5\n"
1175
def get_format_description(self):
1176
"""See BranchFormat.get_format_description()."""
1177
return "Branch format 5"
1179
def initialize(self, a_bzrdir):
1180
"""Create a branch of this format in a_bzrdir."""
1181
utf8_files = [('revision-history', ''),
1182
('branch-name', ''),
1184
return self._initialize_helper(a_bzrdir, utf8_files)
1187
super(BzrBranchFormat5, self).__init__()
1188
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1190
def open(self, a_bzrdir, _found=False):
1191
"""Return the branch object for a_bzrdir
1193
_found is a private parameter, do not use it. It is used to indicate
1194
if format probing has already be done.
1197
format = BranchFormat.find_format(a_bzrdir)
2020
1198
if format.__class__ != self.__class__:
2021
1199
raise AssertionError("wrong format %r found for %r" %
2022
1200
(format, self))
2023
transport = a_bzrdir.get_branch_transport(None, name=name)
1202
transport = a_bzrdir.get_branch_transport(None)
2025
1203
control_files = lockable_files.LockableFiles(transport, 'lock',
2026
1204
lockdir.LockDir)
2027
if found_repository is None:
2028
found_repository = a_bzrdir.find_repository()
2029
return self._branch_class()(_format=self,
1205
return BzrBranch5(_format=self,
2030
1206
_control_files=control_files,
2032
1207
a_bzrdir=a_bzrdir,
2033
_repository=found_repository,
2034
ignore_fallbacks=ignore_fallbacks,
2035
possible_transports=possible_transports)
1208
_repository=a_bzrdir.find_repository())
2036
1209
except errors.NoSuchFile:
2037
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2040
def _matchingbzrdir(self):
2041
ret = bzrdir.BzrDirMetaFormat1()
2042
ret.set_branch_format(self)
2045
def supports_tags(self):
2048
def supports_leaving_lock(self):
2051
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
2053
BranchFormat.check_support_status(self,
2054
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
2056
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
2057
recommend_upgrade=recommend_upgrade, basedir=basedir)
2060
class BzrBranchFormat6(BranchFormatMetadir):
1210
raise errors.NotBranchError(path=transport.base)
1213
class BzrBranchFormat6(BzrBranchFormat5):
2061
1214
"""Branch format with last-revision and tags.
2063
1216
Unlike previous formats, this has no explicit revision history. Instead,
2080
1229
"""See BranchFormat.get_format_description()."""
2081
1230
return "Branch format 6"
2083
def initialize(self, a_bzrdir, name=None, repository=None,
2084
append_revisions_only=None):
2085
"""Create a branch of this format in a_bzrdir."""
2086
utf8_files = [('last-revision', '0 null:\n'),
2088
self._get_initial_config(append_revisions_only)),
2091
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2093
def make_tags(self, branch):
2094
"""See bzrlib.branch.BranchFormat.make_tags()."""
2095
return _mod_tag.BasicTags(branch)
2097
def supports_set_append_revisions_only(self):
2101
class BzrBranchFormat8(BranchFormatMetadir):
2102
"""Metadir format supporting storing locations of subtree branches."""
2104
def _branch_class(self):
2108
def get_format_string(cls):
2109
"""See BranchFormat.get_format_string()."""
2110
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2112
def get_format_description(self):
2113
"""See BranchFormat.get_format_description()."""
2114
return "Branch format 8"
2116
def initialize(self, a_bzrdir, name=None, repository=None,
2117
append_revisions_only=None):
2118
"""Create a branch of this format in a_bzrdir."""
2119
utf8_files = [('last-revision', '0 null:\n'),
2121
self._get_initial_config(append_revisions_only)),
2125
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2127
def make_tags(self, branch):
2128
"""See bzrlib.branch.BranchFormat.make_tags()."""
2129
return _mod_tag.BasicTags(branch)
2131
def supports_set_append_revisions_only(self):
2134
def supports_stacking(self):
2137
supports_reference_locations = True
2140
class BzrBranchFormat7(BranchFormatMetadir):
2141
"""Branch format with last-revision, tags, and a stacked location pointer.
2143
The stacked location pointer is passed down to the repository and requires
2144
a repository format with supports_external_lookups = True.
2146
This format was introduced in bzr 1.6.
2149
def initialize(self, a_bzrdir, name=None, repository=None,
2150
append_revisions_only=None):
2151
"""Create a branch of this format in a_bzrdir."""
2152
utf8_files = [('last-revision', '0 null:\n'),
2154
self._get_initial_config(append_revisions_only)),
2157
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2159
def _branch_class(self):
2163
def get_format_string(cls):
2164
"""See BranchFormat.get_format_string()."""
2165
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2167
def get_format_description(self):
2168
"""See BranchFormat.get_format_description()."""
2169
return "Branch format 7"
2171
def supports_set_append_revisions_only(self):
2174
def supports_stacking(self):
2177
def make_tags(self, branch):
2178
"""See bzrlib.branch.BranchFormat.make_tags()."""
2179
return _mod_tag.BasicTags(branch)
2181
supports_reference_locations = False
2184
class BranchReferenceFormat(BranchFormatMetadir):
1232
def initialize(self, a_bzrdir):
1233
"""Create a branch of this format in a_bzrdir."""
1234
utf8_files = [('last-revision', '0 null:\n'),
1235
('branch.conf', ''),
1238
return self._initialize_helper(a_bzrdir, utf8_files)
1240
def open(self, a_bzrdir, _found=False):
1241
"""Return the branch object for a_bzrdir
1243
_found is a private parameter, do not use it. It is used to indicate
1244
if format probing has already be done.
1247
format = BranchFormat.find_format(a_bzrdir)
1248
if format.__class__ != self.__class__:
1249
raise AssertionError("wrong format %r found for %r" %
1251
transport = a_bzrdir.get_branch_transport(None)
1252
control_files = lockable_files.LockableFiles(transport, 'lock',
1254
return BzrBranch6(_format=self,
1255
_control_files=control_files,
1257
_repository=a_bzrdir.find_repository())
1259
def supports_tags(self):
1263
class BranchReferenceFormat(BranchFormat):
2185
1264
"""Bzr branch reference format.
2187
1266
Branch references are used in implementing checkouts, they
2201
1279
"""See BranchFormat.get_format_description()."""
2202
1280
return "Checkout reference format 1"
2204
def get_reference(self, a_bzrdir, name=None):
1282
def get_reference(self, a_bzrdir):
2205
1283
"""See BranchFormat.get_reference()."""
2206
transport = a_bzrdir.get_branch_transport(None, name=name)
2207
return transport.get_bytes('location')
1284
transport = a_bzrdir.get_branch_transport(None)
1285
return transport.get('location').read()
2209
def set_reference(self, a_bzrdir, name, to_branch):
1287
def set_reference(self, a_bzrdir, to_branch):
2210
1288
"""See BranchFormat.set_reference()."""
2211
transport = a_bzrdir.get_branch_transport(None, name=name)
1289
transport = a_bzrdir.get_branch_transport(None)
2212
1290
location = transport.put_bytes('location', to_branch.base)
2214
def initialize(self, a_bzrdir, name=None, target_branch=None,
2215
repository=None, append_revisions_only=None):
1292
def initialize(self, a_bzrdir, target_branch=None):
2216
1293
"""Create a branch of this format in a_bzrdir."""
2217
1294
if target_branch is None:
2218
1295
# this format does not implement branch itself, thus the implicit
2219
1296
# creation contract must see it as uninitializable
2220
1297
raise errors.UninitializableFormat(self)
2221
mutter('creating branch reference in %s', a_bzrdir.user_url)
2222
if a_bzrdir._format.fixed_components:
2223
raise errors.IncompatibleFormat(self, a_bzrdir._format)
2225
name = a_bzrdir._get_selected_branch()
2226
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1298
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1299
branch_transport = a_bzrdir.get_branch_transport(self)
2227
1300
branch_transport.put_bytes('location',
2228
target_branch.user_url)
2229
branch_transport.put_bytes('format', self.as_string())
2230
branch = self.open(a_bzrdir, name, _found=True,
1301
target_branch.bzrdir.root_transport.base)
1302
branch_transport.put_bytes('format', self.get_format_string())
1304
a_bzrdir, _found=True,
2231
1305
possible_transports=[target_branch.bzrdir.root_transport])
2232
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1308
super(BranchReferenceFormat, self).__init__()
1309
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2235
1311
def _make_reference_clone_function(format, a_branch):
2236
1312
"""Create a clone() routine for a branch dynamically."""
2237
def clone(to_bzrdir, revision_id=None,
2238
repository_policy=None):
1313
def clone(to_bzrdir, revision_id=None):
2239
1314
"""See Branch.clone()."""
2240
return format.initialize(to_bzrdir, target_branch=a_branch)
1315
return format.initialize(to_bzrdir, a_branch)
2241
1316
# cannot obey revision_id limits when cloning a reference ...
2242
1317
# FIXME RBC 20060210 either nuke revision_id for clone, or
2243
1318
# emit some sort of warning/error to the caller ?!
2246
def open(self, a_bzrdir, name=None, _found=False, location=None,
2247
possible_transports=None, ignore_fallbacks=False,
2248
found_repository=None):
1321
def open(self, a_bzrdir, _found=False, location=None,
1322
possible_transports=None):
2249
1323
"""Return the branch that the branch reference in a_bzrdir points at.
2251
:param a_bzrdir: A BzrDir that contains a branch.
2252
:param name: Name of colocated branch to open, if any
2253
:param _found: a private parameter, do not use it. It is used to
2254
indicate if format probing has already be done.
2255
:param ignore_fallbacks: when set, no fallback branches will be opened
2256
(if there are any). Default is to open fallbacks.
2257
:param location: The location of the referenced branch. If
2258
unspecified, this will be determined from the branch reference in
2260
:param possible_transports: An optional reusable transports list.
1325
_found is a private parameter, do not use it. It is used to indicate
1326
if format probing has already be done.
2263
name = a_bzrdir._get_selected_branch()
2265
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
1329
format = BranchFormat.find_format(a_bzrdir)
2266
1330
if format.__class__ != self.__class__:
2267
1331
raise AssertionError("wrong format %r found for %r" %
2268
1332
(format, self))
2269
1333
if location is None:
2270
location = self.get_reference(a_bzrdir, name)
2271
real_bzrdir = controldir.ControlDir.open(
1334
location = self.get_reference(a_bzrdir)
1335
real_bzrdir = bzrdir.BzrDir.open(
2272
1336
location, possible_transports=possible_transports)
2273
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks,
2274
possible_transports=possible_transports)
1337
result = real_bzrdir.open_branch()
2275
1338
# this changes the behaviour of result.clone to create a new reference
2276
1339
# rather than a copy of the content of the branch.
2277
1340
# I did not use a proxy object because that needs much more extensive
2287
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2288
"""Branch format registry."""
2290
def __init__(self, other_registry=None):
2291
super(BranchFormatRegistry, self).__init__(other_registry)
2292
self._default_format = None
2294
def set_default(self, format):
2295
self._default_format = format
2297
def get_default(self):
2298
return self._default_format
2301
network_format_registry = registry.FormatRegistry()
2302
"""Registry of formats indexed by their network name.
2304
The network name for a branch format is an identifier that can be used when
2305
referring to formats with smart server operations. See
2306
BranchFormat.network_name() for more detail.
2309
format_registry = BranchFormatRegistry(network_format_registry)
2312
1350
# formats which have no format string are not discoverable
2313
1351
# and not independently creatable, so are not registered.
1352
__format5 = BzrBranchFormat5()
2314
1353
__format6 = BzrBranchFormat6()
2315
__format7 = BzrBranchFormat7()
2316
__format8 = BzrBranchFormat8()
2317
format_registry.register_lazy(
2318
"Bazaar-NG branch format 5\n", "bzrlib.branchfmt.fullhistory", "BzrBranchFormat5")
2319
format_registry.register(BranchReferenceFormat())
2320
format_registry.register(__format6)
2321
format_registry.register(__format7)
2322
format_registry.register(__format8)
2323
format_registry.set_default(__format7)
2326
class BranchWriteLockResult(LogicalLockResult):
2327
"""The result of write locking a branch.
2329
:ivar branch_token: The token obtained from the underlying branch lock, or
2331
:ivar unlock: A callable which will unlock the lock.
2334
def __init__(self, unlock, branch_token):
2335
LogicalLockResult.__init__(self, unlock)
2336
self.branch_token = branch_token
2339
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2343
class BzrBranch(Branch, _RelockDebugMixin):
1354
BranchFormat.register_format(__format5)
1355
BranchFormat.register_format(BranchReferenceFormat())
1356
BranchFormat.register_format(__format6)
1357
BranchFormat.set_default_format(__format6)
1358
_legacy_formats = [BzrBranchFormat4(),
1361
class BzrBranch(Branch):
2344
1362
"""A branch stored in the actual filesystem.
2346
1364
Note that it's "local" in the context of the filesystem; it doesn't
2347
1365
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2348
1366
it's writable, and can be accessed via the normal filesystem API.
2350
:ivar _transport: Transport for file operations on this branch's
1368
:ivar _transport: Transport for file operations on this branch's
2351
1369
control files, typically pointing to the .bzr/branch directory.
2352
1370
:ivar repository: Repository for this branch.
2353
:ivar base: The url of the base directory for this branch; the one
1371
:ivar base: The url of the base directory for this branch; the one
2354
1372
containing the .bzr directory.
2355
:ivar name: Optional colocated branch name as it exists in the control
2359
1375
def __init__(self, _format=None,
2360
_control_files=None, a_bzrdir=None, name=None,
2361
_repository=None, ignore_fallbacks=False,
2362
possible_transports=None):
1376
_control_files=None, a_bzrdir=None, _repository=None):
2363
1377
"""Create new branch object at a particular location."""
1378
Branch.__init__(self)
2364
1379
if a_bzrdir is None:
2365
1380
raise ValueError('a_bzrdir must be supplied')
2367
raise ValueError('name must be supplied')
2368
self.bzrdir = a_bzrdir
2369
self._user_transport = self.bzrdir.transport.clone('..')
2371
self._user_transport.set_segment_parameter(
2372
"branch", urlutils.escape(name))
2373
self._base = self._user_transport.base
1382
self.bzrdir = a_bzrdir
1383
self._base = self.bzrdir.transport.clone('..').base
1384
# XXX: We should be able to just do
1385
# self.base = self.bzrdir.root_transport.base
1386
# but this does not quite work yet -- mbp 20080522
2375
1387
self._format = _format
2376
1388
if _control_files is None:
2377
1389
raise ValueError('BzrBranch _control_files is None')
2378
1390
self.control_files = _control_files
2379
1391
self._transport = _control_files._transport
2380
1392
self.repository = _repository
2381
self.conf_store = None
2382
Branch.__init__(self, possible_transports)
2384
1394
def __str__(self):
2385
return '%s(%s)' % (self.__class__.__name__, self.user_url)
1395
return '%s(%r)' % (self.__class__.__name__, self.base)
2387
1397
__repr__ = __str__
2393
1403
base = property(_get_base, doc="The URL for the root of this branch.")
2396
def user_transport(self):
2397
return self._user_transport
2399
def _get_config(self):
2400
return _mod_config.TransportConfig(self._transport, 'branch.conf')
2402
def _get_config_store(self):
2403
if self.conf_store is None:
2404
self.conf_store = _mod_config.BranchStore(self)
2405
return self.conf_store
2407
def _uncommitted_branch(self):
2408
"""Return the branch that may contain uncommitted changes."""
2409
master = self.get_master_branch()
2410
if master is not None:
2415
def store_uncommitted(self, creator):
2416
"""Store uncommitted changes from a ShelfCreator.
2418
:param creator: The ShelfCreator containing uncommitted changes, or
2419
None to delete any stored changes.
2420
:raises: ChangesAlreadyStored if the branch already has changes.
2422
branch = self._uncommitted_branch()
2424
branch._transport.delete('stored-transform')
2426
if branch._transport.has('stored-transform'):
2427
raise errors.ChangesAlreadyStored
2428
transform = StringIO()
2429
creator.write_shelf(transform)
2431
branch._transport.put_file('stored-transform', transform)
2433
def get_unshelver(self, tree):
2434
"""Return a shelf.Unshelver for this branch and tree.
2436
:param tree: The tree to use to construct the Unshelver.
2437
:return: an Unshelver or None if no changes are stored.
2439
branch = self._uncommitted_branch()
2441
transform = branch._transport.get('stored-transform')
2442
except errors.NoSuchFile:
2444
return shelf.Unshelver.from_tree_and_shelf(tree, transform)
1405
@deprecated_method(deprecated_in((0, 16, 0)))
1406
def abspath(self, name):
1407
"""See Branch.abspath."""
1408
return self._transport.abspath(name)
2446
1410
def is_locked(self):
2447
1411
return self.control_files.is_locked()
2449
1413
def lock_write(self, token=None):
2450
"""Lock the branch for write operations.
2452
:param token: A token to permit reacquiring a previously held and
2454
:return: A BranchWriteLockResult.
2456
if not self.is_locked():
2457
self._note_lock('w')
2458
self.repository._warn_if_deprecated(self)
2459
self.repository.lock_write()
1414
repo_token = self.repository.lock_write()
2464
return BranchWriteLockResult(self.unlock,
2465
self.control_files.lock_write(token=token))
1416
token = self.control_files.lock_write(token=token)
2468
self.repository.unlock()
1418
self.repository.unlock()
2471
1422
def lock_read(self):
2472
"""Lock the branch for read operations.
2474
:return: A bzrlib.lock.LogicalLockResult.
2476
if not self.is_locked():
2477
self._note_lock('r')
2478
self.repository._warn_if_deprecated(self)
2479
self.repository.lock_read()
1423
self.repository.lock_read()
2484
1425
self.control_files.lock_read()
2485
return LogicalLockResult(self.unlock)
2488
self.repository.unlock()
1427
self.repository.unlock()
2491
@only_raises(errors.LockNotHeld, errors.LockBroken)
2492
1430
def unlock(self):
2493
if self.control_files._lock_count == 1 and self.conf_store is not None:
2494
self.conf_store.save_changes()
1431
# TODO: test for failed two phase locks. This is known broken.
2496
1433
self.control_files.unlock()
2498
if not self.control_files.is_locked():
2499
self.repository.unlock()
2500
# we just released the lock
2501
self._clear_cached_state()
1435
self.repository.unlock()
1436
if not self.control_files.is_locked():
1437
# we just released the lock
1438
self._clear_cached_state()
2503
1440
def peek_lock_mode(self):
2504
1441
if self.control_files._lock_count == 0:
2514
1451
"""See Branch.print_file."""
2515
1452
return self.repository.print_file(file, revision_id)
1454
def _write_revision_history(self, history):
1455
"""Factored out of set_revision_history.
1457
This performs the actual writing to disk.
1458
It is intended to be called by BzrBranch5.set_revision_history."""
1459
self._transport.put_bytes(
1460
'revision-history', '\n'.join(history),
1461
mode=self.bzrdir._get_file_mode())
1464
def set_revision_history(self, rev_history):
1465
"""See Branch.set_revision_history."""
1466
if 'evil' in debug.debug_flags:
1467
mutter_callsite(3, "set_revision_history scales with history.")
1468
self._write_revision_history(rev_history)
1469
self._clear_cached_state()
1470
self._cache_revision_history(rev_history)
1471
for hook in Branch.hooks['set_rh']:
1472
hook(self, rev_history)
1474
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1475
"""Run the post_change_branch_tip hooks."""
1476
hooks = Branch.hooks['post_change_branch_tip']
1479
new_revno, new_revid = self.last_revision_info()
1480
params = ChangeBranchTipParams(
1481
self, old_revno, new_revno, old_revid, new_revid)
2517
1485
@needs_write_lock
2518
1486
def set_last_revision_info(self, revno, revision_id):
2519
if not revision_id or not isinstance(revision_id, basestring):
2520
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
1487
"""Set the last revision of this branch.
1489
The caller is responsible for checking that the revno is correct
1490
for this revision id.
1492
It may be possible to set the branch last revision to an id not
1493
present in the repository. However, branches can also be
1494
configured to check constraints on history, in which case this may not
2521
1497
revision_id = _mod_revision.ensure_null(revision_id)
2522
1498
old_revno, old_revid = self.last_revision_info()
2523
if self.get_append_revisions_only():
2524
self._check_history_violation(revision_id)
2525
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2526
self._write_last_revision_info(revno, revision_id)
2527
self._clear_cached_state()
2528
self._last_revision_info_cache = revno, revision_id
1499
# this old format stores the full history, but this api doesn't
1500
# provide it, so we must generate, and might as well check it's
1502
history = self._lefthand_history(revision_id)
1503
if len(history) != revno:
1504
raise AssertionError('%d != %d' % (len(history), revno))
1505
self.set_revision_history(history)
2529
1506
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1508
def _gen_revision_history(self):
1509
history = self._transport.get_bytes('revision-history').split('\n')
1510
if history[-1:] == ['']:
1511
# There shouldn't be a trailing newline, but just in case.
1515
def _lefthand_history(self, revision_id, last_rev=None,
1517
if 'evil' in debug.debug_flags:
1518
mutter_callsite(4, "_lefthand_history scales with history.")
1519
# stop_revision must be a descendant of last_revision
1520
graph = self.repository.get_graph()
1521
if last_rev is not None:
1522
if not graph.is_ancestor(last_rev, revision_id):
1523
# our previous tip is not merged into stop_revision
1524
raise errors.DivergedBranches(self, other_branch)
1525
# make a new revision history from the graph
1526
parents_map = graph.get_parent_map([revision_id])
1527
if revision_id not in parents_map:
1528
raise errors.NoSuchRevision(self, revision_id)
1529
current_rev_id = revision_id
1531
# Do not include ghosts or graph origin in revision_history
1532
while (current_rev_id in parents_map and
1533
len(parents_map[current_rev_id]) > 0):
1534
new_history.append(current_rev_id)
1535
current_rev_id = parents_map[current_rev_id][0]
1536
parents_map = graph.get_parent_map([current_rev_id])
1537
new_history.reverse()
1541
def generate_revision_history(self, revision_id, last_rev=None,
1543
"""Create a new revision history that will finish with revision_id.
1545
:param revision_id: the new tip to use.
1546
:param last_rev: The previous last_revision. If not None, then this
1547
must be a ancestory of revision_id, or DivergedBranches is raised.
1548
:param other_branch: The other branch that DivergedBranches should
1549
raise with respect to.
1551
self.set_revision_history(self._lefthand_history(revision_id,
1552
last_rev, other_branch))
2531
1554
def basis_tree(self):
2532
1555
"""See Branch.basis_tree."""
2533
1556
return self.repository.revision_tree(self.last_revision())
1559
def pull(self, source, overwrite=False, stop_revision=None,
1560
_hook_master=None, run_hooks=True, possible_transports=None):
1563
:param _hook_master: Private parameter - set the branch to
1564
be supplied as the master to push hooks.
1565
:param run_hooks: Private parameter - if false, this branch
1566
is being called because it's the master of the primary branch,
1567
so it should not run its hooks.
1569
result = PullResult()
1570
result.source_branch = source
1571
result.target_branch = self
1574
# We assume that during 'pull' the local repository is closer than
1576
graph = self.repository.get_graph(source.repository)
1577
result.old_revno, result.old_revid = self.last_revision_info()
1578
self.update_revisions(source, stop_revision, overwrite=overwrite,
1580
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1581
result.new_revno, result.new_revid = self.last_revision_info()
1583
result.master_branch = _hook_master
1584
result.local_branch = self
1586
result.master_branch = self
1587
result.local_branch = None
1589
for hook in Branch.hooks['post_pull']:
2535
1595
def _get_parent_location(self):
2536
1596
_locs = ['parent', 'pull', 'x-pull']
2537
1597
for l in _locs:
2544
def get_stacked_on_url(self):
2545
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1605
def push(self, target, overwrite=False, stop_revision=None,
1606
_override_hook_source_branch=None):
1609
This is the basic concrete implementation of push()
1611
:param _override_hook_source_branch: If specified, run
1612
the hooks passing this Branch as the source, rather than self.
1613
This is for use of RemoteBranch, where push is delegated to the
1614
underlying vfs-based Branch.
1616
# TODO: Public option to disable running hooks - should be trivial but
1620
result = self._push_with_bound_branches(target, overwrite,
1622
_override_hook_source_branch=_override_hook_source_branch)
1627
def _push_with_bound_branches(self, target, overwrite,
1629
_override_hook_source_branch=None):
1630
"""Push from self into target, and into target's master if any.
1632
This is on the base BzrBranch class even though it doesn't support
1633
bound branches because the *target* might be bound.
1636
if _override_hook_source_branch:
1637
result.source_branch = _override_hook_source_branch
1638
for hook in Branch.hooks['post_push']:
1641
bound_location = target.get_bound_location()
1642
if bound_location and target.base != bound_location:
1643
# there is a master branch.
1645
# XXX: Why the second check? Is it even supported for a branch to
1646
# be bound to itself? -- mbp 20070507
1647
master_branch = target.get_master_branch()
1648
master_branch.lock_write()
1650
# push into the master from this branch.
1651
self._basic_push(master_branch, overwrite, stop_revision)
1652
# and push into the target branch from this. Note that we push from
1653
# this branch again, because its considered the highest bandwidth
1655
result = self._basic_push(target, overwrite, stop_revision)
1656
result.master_branch = master_branch
1657
result.local_branch = target
1661
master_branch.unlock()
1664
result = self._basic_push(target, overwrite, stop_revision)
1665
# TODO: Why set master_branch and local_branch if there's no
1666
# binding? Maybe cleaner to just leave them unset? -- mbp
1668
result.master_branch = target
1669
result.local_branch = None
1673
def _basic_push(self, target, overwrite, stop_revision):
1674
"""Basic implementation of push without bound branches or hooks.
1676
Must be called with self read locked and target write locked.
1678
result = PushResult()
1679
result.source_branch = self
1680
result.target_branch = target
1681
result.old_revno, result.old_revid = target.last_revision_info()
1683
# We assume that during 'push' this repository is closer than
1685
graph = self.repository.get_graph(target.repository)
1686
target.update_revisions(self, stop_revision, overwrite=overwrite,
1688
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
1689
result.new_revno, result.new_revid = target.last_revision_info()
1692
def get_parent(self):
1693
"""See Branch.get_parent."""
1694
parent = self._get_parent_location()
1697
# This is an old-format absolute path to a local branch
1698
# turn it into a url
1699
if parent.startswith('/'):
1700
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1702
return urlutils.join(self.base[:-1], parent)
1703
except errors.InvalidURLJoin, e:
1704
raise errors.InaccessibleParent(parent, self.base)
2547
1706
def set_push_location(self, location):
2548
1707
"""See Branch.set_push_location."""
2670
1914
mode=self.bzrdir._get_file_mode())
2672
1916
@needs_write_lock
2673
def update_feature_flags(self, updated_flags):
2674
"""Update the feature flags for this branch.
2676
:param updated_flags: Dictionary mapping feature names to necessities
2677
A necessity can be None to indicate the feature should be removed
2679
self._format._update_feature_flags(updated_flags)
2680
self.control_transport.put_bytes('format', self._format.as_string())
2683
class BzrBranch8(BzrBranch):
2684
"""A branch that stores tree-reference locations."""
2686
def _open_hook(self, possible_transports=None):
2687
if self._ignore_fallbacks:
2689
if possible_transports is None:
2690
possible_transports = [self.bzrdir.root_transport]
2692
url = self.get_stacked_on_url()
2693
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2694
errors.UnstackableBranchFormat):
2697
for hook in Branch.hooks['transform_fallback_location']:
2698
url = hook(self, url)
2700
hook_name = Branch.hooks.get_hook_name(hook)
2701
raise AssertionError(
2702
"'transform_fallback_location' hook %s returned "
2703
"None, not a URL." % hook_name)
2704
self._activate_fallback_location(url,
2705
possible_transports=possible_transports)
2707
def __init__(self, *args, **kwargs):
2708
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2709
super(BzrBranch8, self).__init__(*args, **kwargs)
2710
self._last_revision_info_cache = None
2711
self._reference_info = None
2713
def _clear_cached_state(self):
2714
super(BzrBranch8, self)._clear_cached_state()
2715
self._last_revision_info_cache = None
2716
self._reference_info = None
1917
def set_last_revision_info(self, revno, revision_id):
1918
revision_id = _mod_revision.ensure_null(revision_id)
1919
old_revno, old_revid = self.last_revision_info()
1920
if self._get_append_revisions_only():
1921
self._check_history_violation(revision_id)
1922
self._write_last_revision_info(revno, revision_id)
1923
self._clear_cached_state()
1924
self._last_revision_info_cache = revno, revision_id
1925
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2718
1927
def _check_history_violation(self, revision_id):
2719
current_revid = self.last_revision()
2720
last_revision = _mod_revision.ensure_null(current_revid)
1928
last_revision = _mod_revision.ensure_null(self.last_revision())
2721
1929
if _mod_revision.is_null(last_revision):
2723
graph = self.repository.get_graph()
2724
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2725
if lh_ancestor == current_revid:
2727
raise errors.AppendRevisionsOnlyViolation(self.user_url)
1931
if last_revision not in self._lefthand_history(revision_id):
1932
raise errors.AppendRevisionsOnlyViolation(self.base)
2729
1934
def _gen_revision_history(self):
2730
1935
"""Generate the revision history from last revision
2732
last_revno, last_revision = self.last_revision_info()
2733
self._extend_partial_history(stop_index=last_revno-1)
1937
self._extend_partial_history()
2734
1938
return list(reversed(self._partial_revision_history_cache))
1940
def _extend_partial_history(self, stop_index=None, stop_revision=None):
1941
"""Extend the partial history to include a given index
1943
If a stop_index is supplied, stop when that index has been reached.
1944
If a stop_revision is supplied, stop when that revision is
1945
encountered. Otherwise, stop when the beginning of history is
1948
:param stop_index: The index which should be present. When it is
1949
present, history extension will stop.
1950
:param revision_id: The revision id which should be present. When
1951
it is encountered, history extension will stop.
1953
repo = self.repository
1954
if len(self._partial_revision_history_cache) == 0:
1955
iterator = repo.iter_reverse_revision_history(self.last_revision())
1957
start_revision = self._partial_revision_history_cache[-1]
1958
iterator = repo.iter_reverse_revision_history(start_revision)
1959
#skip the last revision in the list
1960
next_revision = iterator.next()
1961
for revision_id in iterator:
1962
self._partial_revision_history_cache.append(revision_id)
1963
if (stop_index is not None and
1964
len(self._partial_revision_history_cache) > stop_index):
1966
if revision_id == stop_revision:
1969
def _write_revision_history(self, history):
1970
"""Factored out of set_revision_history.
1972
This performs the actual writing to disk, with format-specific checks.
1973
It is intended to be called by BzrBranch5.set_revision_history.
1975
if len(history) == 0:
1976
last_revision = 'null:'
1978
if history != self._lefthand_history(history[-1]):
1979
raise errors.NotLefthandHistory(history)
1980
last_revision = history[-1]
1981
if self._get_append_revisions_only():
1982
self._check_history_violation(last_revision)
1983
self._write_last_revision_info(len(history), last_revision)
2736
1985
@needs_write_lock
2737
1986
def _set_parent_location(self, url):
2738
1987
"""Set the parent branch"""
2743
1992
"""Set the parent branch"""
2744
1993
return self._get_config_location('parent_location')
2747
def _set_all_reference_info(self, info_dict):
2748
"""Replace all reference info stored in a branch.
2750
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2753
writer = rio.RioWriter(s)
2754
for key, (tree_path, branch_location) in info_dict.iteritems():
2755
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2756
branch_location=branch_location)
2757
writer.write_stanza(stanza)
2758
self._transport.put_bytes('references', s.getvalue())
2759
self._reference_info = info_dict
2762
def _get_all_reference_info(self):
2763
"""Return all the reference info stored in a branch.
2765
:return: A dict of {file_id: (tree_path, branch_location)}
2767
if self._reference_info is not None:
2768
return self._reference_info
2769
rio_file = self._transport.get('references')
2771
stanzas = rio.read_stanzas(rio_file)
2772
info_dict = dict((s['file_id'], (s['tree_path'],
2773
s['branch_location'])) for s in stanzas)
2776
self._reference_info = info_dict
2779
def set_reference_info(self, file_id, tree_path, branch_location):
2780
"""Set the branch location to use for a tree reference.
2782
:param file_id: The file-id of the tree reference.
2783
:param tree_path: The path of the tree reference in the tree.
2784
:param branch_location: The location of the branch to retrieve tree
2787
info_dict = self._get_all_reference_info()
2788
info_dict[file_id] = (tree_path, branch_location)
2789
if None in (tree_path, branch_location):
2790
if tree_path is not None:
2791
raise ValueError('tree_path must be None when branch_location'
2793
if branch_location is not None:
2794
raise ValueError('branch_location must be None when tree_path'
2796
del info_dict[file_id]
2797
self._set_all_reference_info(info_dict)
2799
def get_reference_info(self, file_id):
2800
"""Get the tree_path and branch_location for a tree reference.
2802
:return: a tuple of (tree_path, branch_location)
2804
return self._get_all_reference_info().get(file_id, (None, None))
2806
def reference_parent(self, file_id, path, possible_transports=None):
2807
"""Return the parent branch for a tree-reference file_id.
2809
:param file_id: The file_id of the tree reference
2810
:param path: The path of the file_id in the tree
2811
:return: A branch associated with the file_id
2813
branch_location = self.get_reference_info(file_id)[1]
2814
if branch_location is None:
2815
return Branch.reference_parent(self, file_id, path,
2816
possible_transports)
2817
branch_location = urlutils.join(self.user_url, branch_location)
2818
return Branch.open(branch_location,
2819
possible_transports=possible_transports)
2821
1995
def set_push_location(self, location):
2822
1996
"""See Branch.set_push_location."""
2823
1997
self._set_config_location('push_location', location)
2825
1999
def set_bound_location(self, location):
2826
2000
"""See Branch.set_push_location."""
2827
self._master_branch_cache = None
2829
conf = self.get_config_stack()
2002
config = self.get_config()
2830
2003
if location is None:
2831
if not conf.get('bound'):
2004
if config.get_user_option('bound') != 'True':
2834
conf.set('bound', 'False')
2007
config.set_user_option('bound', 'False', warn_masked=True)
2837
2010
self._set_config_location('bound_location', location,
2839
conf.set('bound', 'True')
2012
config.set_user_option('bound', 'True', warn_masked=True)
2842
2015
def _get_bound_location(self, bound):
2843
2016
"""Return the bound location in the config file.
2845
2018
Return None if the bound parameter does not match"""
2846
conf = self.get_config_stack()
2847
if conf.get('bound') != bound:
2019
config = self.get_config()
2020
config_bound = (config.get_user_option('bound') == 'True')
2021
if config_bound != bound:
2849
return self._get_config_location('bound_location', config=conf)
2023
return self._get_config_location('bound_location', config=config)
2851
2025
def get_bound_location(self):
2852
"""See Branch.get_bound_location."""
2026
"""See Branch.set_push_location."""
2853
2027
return self._get_bound_location(True)
2855
2029
def get_old_bound_location(self):
2856
2030
"""See Branch.get_old_bound_location"""
2857
2031
return self._get_bound_location(False)
2859
def get_stacked_on_url(self):
2860
# you can always ask for the URL; but you might not be able to use it
2861
# if the repo can't support stacking.
2862
## self._check_stackable_repo()
2863
# stacked_on_location is only ever defined in branch.conf, so don't
2864
# waste effort reading the whole stack of config files.
2865
conf = _mod_config.BranchOnlyStack(self)
2866
stacked_url = self._get_config_location('stacked_on_location',
2868
if stacked_url is None:
2869
raise errors.NotStacked(self)
2870
return stacked_url.encode('utf-8')
2033
def set_append_revisions_only(self, enabled):
2038
self.get_config().set_user_option('append_revisions_only', value,
2041
def _get_append_revisions_only(self):
2042
value = self.get_config().get_user_option('append_revisions_only')
2043
return value == 'True'
2045
def _synchronize_history(self, destination, revision_id):
2046
"""Synchronize last revision and revision history between branches.
2048
This version is most efficient when the destination is also a
2049
BzrBranch6, but works for BzrBranch5, as long as the destination's
2050
repository contains all the lefthand ancestors of the intended
2051
last_revision. If not, set_last_revision_info will fail.
2053
:param destination: The branch to copy the history into
2054
:param revision_id: The revision-id to truncate history at. May
2055
be None to copy complete history.
2057
source_revno, source_revision_id = self.last_revision_info()
2058
if revision_id is None:
2059
revno, revision_id = source_revno, source_revision_id
2060
elif source_revision_id == revision_id:
2061
# we know the revno without needing to walk all of history
2062
revno = source_revno
2064
# To figure out the revno for a random revision, we need to build
2065
# the revision history, and count its length.
2066
# We don't care about the order, just how long it is.
2067
# Alternatively, we could start at the current location, and count
2068
# backwards. But there is no guarantee that we will find it since
2069
# it may be a merged revision.
2070
revno = len(list(self.repository.iter_reverse_revision_history(
2072
destination.set_last_revision_info(revno, revision_id)
2074
def _make_tags(self):
2075
return BasicTags(self)
2078
def generate_revision_history(self, revision_id, last_rev=None,
2080
"""See BzrBranch5.generate_revision_history"""
2081
history = self._lefthand_history(revision_id, last_rev, other_branch)
2082
revno = len(history)
2083
self.set_last_revision_info(revno, revision_id)
2872
2085
@needs_read_lock
2873
2086
def get_rev_id(self, revno, history=None):
2956
2139
:ivar new_revno: Revision number after pull.
2957
2140
:ivar old_revid: Tip revision id before pull.
2958
2141
:ivar new_revid: Tip revision id after pull.
2959
:ivar source_branch: Source (local) branch object. (read locked)
2142
:ivar source_branch: Source (local) branch object.
2960
2143
:ivar master_branch: Master branch of the target, or the target if no
2962
2145
:ivar local_branch: target branch if there is a Master, else None
2963
:ivar target_branch: Target/destination branch object. (write locked)
2146
:ivar target_branch: Target/destination branch object.
2964
2147
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2965
:ivar tag_updates: A dict with new tags, see BasicTags.merge_to
2151
# DEPRECATED: pull used to return the change in revno
2152
return self.new_revno - self.old_revno
2968
2154
def report(self, to_file):
2969
tag_conflicts = getattr(self, "tag_conflicts", None)
2970
tag_updates = getattr(self, "tag_updates", None)
2971
2155
if not is_quiet():
2972
if self.old_revid != self.new_revid:
2156
if self.old_revid == self.new_revid:
2157
to_file.write('No revisions to pull.\n')
2973
2159
to_file.write('Now on revision %d.\n' % self.new_revno)
2975
to_file.write('%d tag(s) updated.\n' % len(tag_updates))
2976
if self.old_revid == self.new_revid and not tag_updates:
2977
if not tag_conflicts:
2978
to_file.write('No revisions or tags to pull.\n')
2980
to_file.write('No revisions to pull.\n')
2981
2160
self._show_tag_conficts(to_file)
2984
class BranchPushResult(_Result):
2163
class PushResult(_Result):
2985
2164
"""Result of a Branch.push operation.
2987
:ivar old_revno: Revision number (eg 10) of the target before push.
2988
:ivar new_revno: Revision number (eg 12) of the target after push.
2989
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2991
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2993
:ivar source_branch: Source branch object that the push was from. This is
2994
read locked, and generally is a local (and thus low latency) branch.
2995
:ivar master_branch: If target is a bound branch, the master branch of
2996
target, or target itself. Always write locked.
2997
:ivar target_branch: The direct Branch where data is being sent (write
2999
:ivar local_branch: If the target is a bound branch this will be the
3000
target, otherwise it will be None.
2166
:ivar old_revno: Revision number before push.
2167
:ivar new_revno: Revision number after push.
2168
:ivar old_revid: Tip revision id before push.
2169
:ivar new_revid: Tip revision id after push.
2170
:ivar source_branch: Source branch object.
2171
:ivar master_branch: Master branch of the target, or None.
2172
:ivar target_branch: Target/destination branch object.
2176
# DEPRECATED: push used to return the change in revno
2177
return self.new_revno - self.old_revno
3003
2179
def report(self, to_file):
3004
# TODO: This function gets passed a to_file, but then
3005
# ignores it and calls note() instead. This is also
3006
# inconsistent with PullResult(), which writes to stdout.
3007
# -- JRV20110901, bug #838853
3008
tag_conflicts = getattr(self, "tag_conflicts", None)
3009
tag_updates = getattr(self, "tag_updates", None)
3011
if self.old_revid != self.new_revid:
3012
note(gettext('Pushed up to revision %d.') % self.new_revno)
3014
note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
3015
if self.old_revid == self.new_revid and not tag_updates:
3016
if not tag_conflicts:
3017
note(gettext('No new revisions or tags to push.'))
3019
note(gettext('No new revisions to push.'))
2180
"""Write a human-readable description of the result."""
2181
if self.old_revid == self.new_revid:
2182
to_file.write('No new revisions to push.\n')
2184
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
3020
2185
self._show_tag_conficts(to_file)
3053
2216
# Copy source data into target
3054
2217
new_branch._write_last_revision_info(*branch.last_revision_info())
3055
new_branch.lock_write()
3057
new_branch.set_parent(branch.get_parent())
3058
new_branch.set_bound_location(branch.get_bound_location())
3059
new_branch.set_push_location(branch.get_push_location())
2218
new_branch.set_parent(branch.get_parent())
2219
new_branch.set_bound_location(branch.get_bound_location())
2220
new_branch.set_push_location(branch.get_push_location())
3063
2222
# New branch has no tags by default
3064
2223
new_branch.tags._set_tag_dict({})
3066
2225
# Copying done; now update target format
3067
2226
new_branch._transport.put_bytes('format',
2227
format.get_format_string(),
3069
2228
mode=new_branch.bzrdir._get_file_mode())
3071
2230
# Clean up old files
3072
2231
new_branch._transport.delete('revision-history')
3076
branch.set_parent(None)
3077
except errors.NoSuchFile:
3079
branch.set_bound_location(None)
3084
class Converter6to7(object):
3085
"""Perform an in-place upgrade of format 6 to format 7"""
3087
def convert(self, branch):
3088
format = BzrBranchFormat7()
3089
branch._set_config_location('stacked_on_location', '')
3090
# update target format
3091
branch._transport.put_bytes('format', format.as_string())
3094
class Converter7to8(object):
3095
"""Perform an in-place upgrade of format 7 to format 8"""
3097
def convert(self, branch):
3098
format = BzrBranchFormat8()
3099
branch._transport.put_bytes('references', '')
3100
# update target format
3101
branch._transport.put_bytes('format', format.as_string())
3104
class InterBranch(InterObject):
3105
"""This class represents operations taking place between two branches.
3107
Its instances have methods like pull() and push() and contain
3108
references to the source and target repositories these operations
3109
can be carried out on.
3113
"""The available optimised InterBranch types."""
3116
def _get_branch_formats_to_test(klass):
3117
"""Return an iterable of format tuples for testing.
3119
:return: An iterable of (from_format, to_format) to use when testing
3120
this InterBranch class. Each InterBranch class should define this
3123
raise NotImplementedError(klass._get_branch_formats_to_test)
3126
def pull(self, overwrite=False, stop_revision=None,
3127
possible_transports=None, local=False):
3128
"""Mirror source into target branch.
3130
The target branch is considered to be 'local', having low latency.
3132
:returns: PullResult instance
3134
raise NotImplementedError(self.pull)
3137
def push(self, overwrite=False, stop_revision=None, lossy=False,
3138
_override_hook_source_branch=None):
3139
"""Mirror the source branch into the target branch.
3141
The source branch is considered to be 'local', having low latency.
3143
raise NotImplementedError(self.push)
3146
def copy_content_into(self, revision_id=None):
3147
"""Copy the content of source into target
3149
revision_id: if not None, the revision history in the new branch will
3150
be truncated to end with revision_id.
3152
raise NotImplementedError(self.copy_content_into)
3155
def fetch(self, stop_revision=None, limit=None):
3158
:param stop_revision: Last revision to fetch
3159
:param limit: Optional rough limit of revisions to fetch
3161
raise NotImplementedError(self.fetch)
3164
def _fix_overwrite_type(overwrite):
3165
if isinstance(overwrite, bool):
3167
return ["history", "tags"]
3173
class GenericInterBranch(InterBranch):
3174
"""InterBranch implementation that uses public Branch functions."""
3177
def is_compatible(klass, source, target):
3178
# GenericBranch uses the public API, so always compatible
3182
def _get_branch_formats_to_test(klass):
3183
return [(format_registry.get_default(), format_registry.get_default())]
3186
def unwrap_format(klass, format):
3187
if isinstance(format, remote.RemoteBranchFormat):
3188
format._ensure_real()
3189
return format._custom_format
3193
def copy_content_into(self, revision_id=None):
3194
"""Copy the content of source into target
3196
revision_id: if not None, the revision history in the new branch will
3197
be truncated to end with revision_id.
3199
self.source.update_references(self.target)
3200
self.source._synchronize_history(self.target, revision_id)
3202
parent = self.source.get_parent()
3203
except errors.InaccessibleParent, e:
3204
mutter('parent was not accessible to copy: %s', e)
3207
self.target.set_parent(parent)
3208
if self.source._push_should_merge_tags():
3209
self.source.tags.merge_to(self.target.tags)
3212
def fetch(self, stop_revision=None, limit=None):
3213
if self.target.base == self.source.base:
3215
self.source.lock_read()
3217
fetch_spec_factory = fetch.FetchSpecFactory()
3218
fetch_spec_factory.source_branch = self.source
3219
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3220
fetch_spec_factory.source_repo = self.source.repository
3221
fetch_spec_factory.target_repo = self.target.repository
3222
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3223
fetch_spec_factory.limit = limit
3224
fetch_spec = fetch_spec_factory.make_fetch_spec()
3225
return self.target.repository.fetch(self.source.repository,
3226
fetch_spec=fetch_spec)
3228
self.source.unlock()
3231
def _update_revisions(self, stop_revision=None, overwrite=False,
3233
other_revno, other_last_revision = self.source.last_revision_info()
3234
stop_revno = None # unknown
3235
if stop_revision is None:
3236
stop_revision = other_last_revision
3237
if _mod_revision.is_null(stop_revision):
3238
# if there are no commits, we're done.
3240
stop_revno = other_revno
3242
# what's the current last revision, before we fetch [and change it
3244
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3245
# we fetch here so that we don't process data twice in the common
3246
# case of having something to pull, and so that the check for
3247
# already merged can operate on the just fetched graph, which will
3248
# be cached in memory.
3249
self.fetch(stop_revision=stop_revision)
3250
# Check to see if one is an ancestor of the other
3253
graph = self.target.repository.get_graph()
3254
if self.target._check_if_descendant_or_diverged(
3255
stop_revision, last_rev, graph, self.source):
3256
# stop_revision is a descendant of last_rev, but we aren't
3257
# overwriting, so we're done.
3259
if stop_revno is None:
3261
graph = self.target.repository.get_graph()
3262
this_revno, this_last_revision = \
3263
self.target.last_revision_info()
3264
stop_revno = graph.find_distance_to_null(stop_revision,
3265
[(other_last_revision, other_revno),
3266
(this_last_revision, this_revno)])
3267
self.target.set_last_revision_info(stop_revno, stop_revision)
3270
def pull(self, overwrite=False, stop_revision=None,
3271
possible_transports=None, run_hooks=True,
3272
_override_hook_target=None, local=False):
3273
"""Pull from source into self, updating my master if any.
3275
:param run_hooks: Private parameter - if false, this branch
3276
is being called because it's the master of the primary branch,
3277
so it should not run its hooks.
3279
bound_location = self.target.get_bound_location()
3280
if local and not bound_location:
3281
raise errors.LocalRequiresBoundBranch()
3282
master_branch = None
3283
source_is_master = False
3285
# bound_location comes from a config file, some care has to be
3286
# taken to relate it to source.user_url
3287
normalized = urlutils.normalize_url(bound_location)
3289
relpath = self.source.user_transport.relpath(normalized)
3290
source_is_master = (relpath == '')
3291
except (errors.PathNotChild, errors.InvalidURL):
3292
source_is_master = False
3293
if not local and bound_location and not source_is_master:
3294
# not pulling from master, so we need to update master.
3295
master_branch = self.target.get_master_branch(possible_transports)
3296
master_branch.lock_write()
3299
# pull from source into master.
3300
master_branch.pull(self.source, overwrite, stop_revision,
3302
return self._pull(overwrite,
3303
stop_revision, _hook_master=master_branch,
3304
run_hooks=run_hooks,
3305
_override_hook_target=_override_hook_target,
3306
merge_tags_to_master=not source_is_master)
3309
master_branch.unlock()
3311
def push(self, overwrite=False, stop_revision=None, lossy=False,
3312
_override_hook_source_branch=None):
3313
"""See InterBranch.push.
3315
This is the basic concrete implementation of push()
3317
:param _override_hook_source_branch: If specified, run the hooks
3318
passing this Branch as the source, rather than self. This is for
3319
use of RemoteBranch, where push is delegated to the underlying
3323
raise errors.LossyPushToSameVCS(self.source, self.target)
3324
# TODO: Public option to disable running hooks - should be trivial but
3327
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3328
op.add_cleanup(self.source.lock_read().unlock)
3329
op.add_cleanup(self.target.lock_write().unlock)
3330
return op.run(overwrite, stop_revision,
3331
_override_hook_source_branch=_override_hook_source_branch)
3333
def _basic_push(self, overwrite, stop_revision):
3334
"""Basic implementation of push without bound branches or hooks.
3336
Must be called with source read locked and target write locked.
3338
result = BranchPushResult()
3339
result.source_branch = self.source
3340
result.target_branch = self.target
3341
result.old_revno, result.old_revid = self.target.last_revision_info()
3342
self.source.update_references(self.target)
3343
overwrite = _fix_overwrite_type(overwrite)
3344
if result.old_revid != stop_revision:
3345
# We assume that during 'push' this repository is closer than
3347
graph = self.source.repository.get_graph(self.target.repository)
3348
self._update_revisions(stop_revision,
3349
overwrite=("history" in overwrite),
3351
if self.source._push_should_merge_tags():
3352
result.tag_updates, result.tag_conflicts = (
3353
self.source.tags.merge_to(
3354
self.target.tags, "tags" in overwrite))
3355
result.new_revno, result.new_revid = self.target.last_revision_info()
3358
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3359
_override_hook_source_branch=None):
3360
"""Push from source into target, and into target's master if any.
3363
if _override_hook_source_branch:
3364
result.source_branch = _override_hook_source_branch
3365
for hook in Branch.hooks['post_push']:
3368
bound_location = self.target.get_bound_location()
3369
if bound_location and self.target.base != bound_location:
3370
# there is a master branch.
3372
# XXX: Why the second check? Is it even supported for a branch to
3373
# be bound to itself? -- mbp 20070507
3374
master_branch = self.target.get_master_branch()
3375
master_branch.lock_write()
3376
operation.add_cleanup(master_branch.unlock)
3377
# push into the master from the source branch.
3378
master_inter = InterBranch.get(self.source, master_branch)
3379
master_inter._basic_push(overwrite, stop_revision)
3380
# and push into the target branch from the source. Note that
3381
# we push from the source branch again, because it's considered
3382
# the highest bandwidth repository.
3383
result = self._basic_push(overwrite, stop_revision)
3384
result.master_branch = master_branch
3385
result.local_branch = self.target
3387
master_branch = None
3389
result = self._basic_push(overwrite, stop_revision)
3390
# TODO: Why set master_branch and local_branch if there's no
3391
# binding? Maybe cleaner to just leave them unset? -- mbp
3393
result.master_branch = self.target
3394
result.local_branch = None
3398
def _pull(self, overwrite=False, stop_revision=None,
3399
possible_transports=None, _hook_master=None, run_hooks=True,
3400
_override_hook_target=None, local=False,
3401
merge_tags_to_master=True):
3404
This function is the core worker, used by GenericInterBranch.pull to
3405
avoid duplication when pulling source->master and source->local.
3407
:param _hook_master: Private parameter - set the branch to
3408
be supplied as the master to pull hooks.
3409
:param run_hooks: Private parameter - if false, this branch
3410
is being called because it's the master of the primary branch,
3411
so it should not run its hooks.
3412
is being called because it's the master of the primary branch,
3413
so it should not run its hooks.
3414
:param _override_hook_target: Private parameter - set the branch to be
3415
supplied as the target_branch to pull hooks.
3416
:param local: Only update the local branch, and not the bound branch.
3418
# This type of branch can't be bound.
3420
raise errors.LocalRequiresBoundBranch()
3421
result = PullResult()
3422
result.source_branch = self.source
3423
if _override_hook_target is None:
3424
result.target_branch = self.target
3426
result.target_branch = _override_hook_target
3427
self.source.lock_read()
3429
# We assume that during 'pull' the target repository is closer than
3431
self.source.update_references(self.target)
3432
graph = self.target.repository.get_graph(self.source.repository)
3433
# TODO: Branch formats should have a flag that indicates
3434
# that revno's are expensive, and pull() should honor that flag.
3436
result.old_revno, result.old_revid = \
3437
self.target.last_revision_info()
3438
overwrite = _fix_overwrite_type(overwrite)
3439
self._update_revisions(stop_revision,
3440
overwrite=("history" in overwrite),
3442
# TODO: The old revid should be specified when merging tags,
3443
# so a tags implementation that versions tags can only
3444
# pull in the most recent changes. -- JRV20090506
3445
result.tag_updates, result.tag_conflicts = (
3446
self.source.tags.merge_to(self.target.tags,
3447
"tags" in overwrite,
3448
ignore_master=not merge_tags_to_master))
3449
result.new_revno, result.new_revid = self.target.last_revision_info()
3451
result.master_branch = _hook_master
3452
result.local_branch = result.target_branch
3454
result.master_branch = result.target_branch
3455
result.local_branch = None
3457
for hook in Branch.hooks['post_pull']:
3460
self.source.unlock()
3464
InterBranch.register_optimiser(GenericInterBranch)
2233
branch.set_parent(None)
2234
except errors.NoSuchFile:
2236
branch.set_bound_location(None)
added
removed
bzrlib/branch.py
