13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
18
21
from cStringIO import StringIO
20
23
from bzrlib.lazy_import import lazy_import
21
24
lazy_import(globals(), """
22
from warnings import warn
25
26
from bzrlib import (
28
config as _mod_config,
33
revision as _mod_revision,
40
from bzrlib.config import BranchConfig, TreeConfig
41
from bzrlib.lockable_files import LockableFiles, TransportLock
42
from bzrlib.tag import (
31
config as _mod_config,
40
revision as _mod_revision,
48
from bzrlib.i18n import gettext, ngettext
48
from bzrlib.decorators import needs_read_lock, needs_write_lock
49
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
50
HistoryMissing, InvalidRevisionId,
51
InvalidRevisionNumber, LockError, NoSuchFile,
52
NoSuchRevision, NotVersionedError,
53
NotBranchError, UninitializableFormat,
54
UnlistableStore, UnlistableBranch,
51
# Explicitly import bzrlib.bzrdir so that the BzrProber
52
# is guaranteed to be registered.
59
from bzrlib.decorators import (
56
64
from bzrlib.hooks import Hooks
57
from bzrlib.symbol_versioning import (deprecated_function,
61
zero_eight, zero_nine, zero_sixteen,
64
from bzrlib.trace import mutter, note
67
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
68
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
69
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
72
# TODO: Maybe include checks for common corruption of newlines, etc?
74
# TODO: Some operations like log might retrieve the same revisions
75
# repeatedly to calculate deltas. We could perhaps have a weakref
76
# cache in memory to make this faster. In general anything can be
77
# cached in memory between lock and unlock operations. .. nb thats
78
# what the transaction identity map provides
81
######################################################################
65
from bzrlib.inter import InterObject
66
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
67
from bzrlib import registry
68
from bzrlib.symbol_versioning import (
72
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
75
class Branch(controldir.ControlComponent):
85
76
"""Branch holding a history of revisions.
88
Base directory/url of the branch.
90
hooks: An instance of BranchHooks.
79
Base directory/url of the branch; using control_url and
80
control_transport is more standardized.
81
:ivar hooks: An instance of BranchHooks.
82
:ivar _master_branch_cache: cached result of get_master_branch, see
92
85
# this is really an instance variable - FIXME move it there
96
# override this to set the strategy for storing tags
98
return DisabledTags(self)
100
def __init__(self, *ignored, **ignored_too):
101
self.tags = self._make_tags()
90
def control_transport(self):
91
return self._transport
94
def user_transport(self):
95
return self.bzrdir.user_transport
97
def __init__(self, possible_transports=None):
98
self.tags = self._format.make_tags(self)
102
99
self._revision_history_cache = None
103
100
self._revision_id_to_revno_cache = None
101
self._partial_revision_id_to_revno_cache = {}
102
self._partial_revision_history_cache = []
103
self._tags_bytes = None
104
self._last_revision_info_cache = None
105
self._master_branch_cache = None
106
self._merge_sorted_revisions_cache = None
107
self._open_hook(possible_transports)
108
hooks = Branch.hooks['open']
112
def _open_hook(self, possible_transports):
113
"""Called by init to allow simpler extension of the base class."""
115
def _activate_fallback_location(self, url, possible_transports):
116
"""Activate the branch/repository from url as a fallback repository."""
117
for existing_fallback_repo in self.repository._fallback_repositories:
118
if existing_fallback_repo.user_url == url:
119
# This fallback is already configured. This probably only
120
# happens because ControlDir.sprout is a horrible mess. To avoid
121
# confusing _unstack we don't add this a second time.
122
mutter('duplicate activation of fallback %r on %r', url, self)
124
repo = self._get_fallback_repository(url, possible_transports)
125
if repo.has_same_location(self.repository):
126
raise errors.UnstackableLocationError(self.user_url, url)
127
self.repository.add_fallback_repository(repo)
105
129
def break_lock(self):
106
130
"""Break a lock if one is present from another instance.
116
140
if master is not None:
117
141
master.break_lock()
143
def _check_stackable_repo(self):
144
if not self.repository._format.supports_external_lookups:
145
raise errors.UnstackableRepositoryFormat(self.repository._format,
146
self.repository.base)
148
def _extend_partial_history(self, stop_index=None, stop_revision=None):
149
"""Extend the partial history to include a given index
151
If a stop_index is supplied, stop when that index has been reached.
152
If a stop_revision is supplied, stop when that revision is
153
encountered. Otherwise, stop when the beginning of history is
156
:param stop_index: The index which should be present. When it is
157
present, history extension will stop.
158
:param stop_revision: The revision id which should be present. When
159
it is encountered, history extension will stop.
161
if len(self._partial_revision_history_cache) == 0:
162
self._partial_revision_history_cache = [self.last_revision()]
163
repository._iter_for_revno(
164
self.repository, self._partial_revision_history_cache,
165
stop_index=stop_index, stop_revision=stop_revision)
166
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
167
self._partial_revision_history_cache.pop()
169
def _get_check_refs(self):
170
"""Get the references needed for check().
174
revid = self.last_revision()
175
return [('revision-existence', revid), ('lefthand-distance', revid)]
120
def open(base, _unsupported=False):
178
def open(base, _unsupported=False, possible_transports=None):
121
179
"""Open the branch rooted at base.
123
181
For instance, if the branch is at URL/.bzr/branch,
124
182
Branch.open(URL) -> a Branch instance.
126
control = bzrdir.BzrDir.open(base, _unsupported)
127
return control.open_branch(_unsupported)
184
control = controldir.ControlDir.open(base,
185
possible_transports=possible_transports, _unsupported=_unsupported)
186
return control.open_branch(unsupported=_unsupported,
187
possible_transports=possible_transports)
130
def open_from_transport(transport, _unsupported=False):
190
def open_from_transport(transport, name=None, _unsupported=False,
191
possible_transports=None):
131
192
"""Open the branch rooted at transport"""
132
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
133
return control.open_branch(_unsupported)
193
control = controldir.ControlDir.open_from_transport(transport, _unsupported)
194
return control.open_branch(name=name, unsupported=_unsupported,
195
possible_transports=possible_transports)
136
198
def open_containing(url, possible_transports=None):
137
199
"""Open an existing branch which contains url.
139
201
This probes for a branch at url, and searches upwards from there.
141
203
Basically we keep looking up until we find the control directory or
142
204
run into the root. If there isn't one, raises NotBranchError.
143
If there is one and it is either an unrecognised format or an unsupported
205
If there is one and it is either an unrecognised format or an unsupported
144
206
format, UnknownFormatError or UnsupportedFormatError are raised.
145
207
If there is one, it is returned, along with the unused portion of url.
147
control, relpath = bzrdir.BzrDir.open_containing(url,
209
control, relpath = controldir.ControlDir.open_containing(url,
148
210
possible_transports)
149
return control.open_branch(), relpath
211
branch = control.open_branch(possible_transports=possible_transports)
212
return (branch, relpath)
214
def _push_should_merge_tags(self):
215
"""Should _basic_push merge this branch's tags into the target?
217
The default implementation returns False if this branch has no tags,
218
and True the rest of the time. Subclasses may override this.
220
return self.supports_tags() and self.tags.get_tag_dict()
151
222
def get_config(self):
152
return BranchConfig(self)
155
return self.get_config().get_nickname()
223
"""Get a bzrlib.config.BranchConfig for this Branch.
225
This can then be used to get and set configuration options for the
228
:return: A bzrlib.config.BranchConfig.
230
return _mod_config.BranchConfig(self)
232
def get_config_stack(self):
233
"""Get a bzrlib.config.BranchStack for this Branch.
235
This can then be used to get and set configuration options for the
238
:return: A bzrlib.config.BranchStack.
240
return _mod_config.BranchStack(self)
242
def _get_config(self):
243
"""Get the concrete config for just the config in this branch.
245
This is not intended for client use; see Branch.get_config for the
250
:return: An object supporting get_option and set_option.
252
raise NotImplementedError(self._get_config)
254
def _get_fallback_repository(self, url, possible_transports):
255
"""Get the repository we fallback to at url."""
256
url = urlutils.join(self.base, url)
257
a_branch = Branch.open(url, possible_transports=possible_transports)
258
return a_branch.repository
261
def _get_tags_bytes(self):
262
"""Get the bytes of a serialised tags dict.
264
Note that not all branches support tags, nor do all use the same tags
265
logic: this method is specific to BasicTags. Other tag implementations
266
may use the same method name and behave differently, safely, because
267
of the double-dispatch via
268
format.make_tags->tags_instance->get_tags_dict.
270
:return: The bytes of the tags file.
271
:seealso: Branch._set_tags_bytes.
273
if self._tags_bytes is None:
274
self._tags_bytes = self._transport.get_bytes('tags')
275
return self._tags_bytes
277
def _get_nick(self, local=False, possible_transports=None):
278
config = self.get_config()
279
# explicit overrides master, but don't look for master if local is True
280
if not local and not config.has_explicit_nickname():
282
master = self.get_master_branch(possible_transports)
283
if master and self.user_url == master.user_url:
284
raise errors.RecursiveBind(self.user_url)
285
if master is not None:
286
# return the master branch value
288
except errors.RecursiveBind, e:
290
except errors.BzrError, e:
291
# Silently fall back to local implicit nick if the master is
293
mutter("Could not connect to bound branch, "
294
"falling back to local nick.\n " + str(e))
295
return config.get_nickname()
157
297
def _set_nick(self, nick):
158
298
self.get_config().set_user_option('nickname', nick, warn_masked=True)
209
450
:return: A dictionary mapping revision_id => dotted revno.
211
last_revision = self.last_revision()
212
revision_graph = self.repository.get_revision_graph(last_revision)
213
merge_sorted_revisions = tsort.merge_sort(
218
452
revision_id_to_revno = dict((rev_id, revno)
219
for seq_num, rev_id, depth, revno, end_of_merge
220
in merge_sorted_revisions)
453
for rev_id, depth, revno, end_of_merge
454
in self.iter_merge_sorted_revisions())
221
455
return revision_id_to_revno
458
def iter_merge_sorted_revisions(self, start_revision_id=None,
459
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
460
"""Walk the revisions for a branch in merge sorted order.
462
Merge sorted order is the output from a merge-aware,
463
topological sort, i.e. all parents come before their
464
children going forward; the opposite for reverse.
466
:param start_revision_id: the revision_id to begin walking from.
467
If None, the branch tip is used.
468
:param stop_revision_id: the revision_id to terminate the walk
469
after. If None, the rest of history is included.
470
:param stop_rule: if stop_revision_id is not None, the precise rule
471
to use for termination:
473
* 'exclude' - leave the stop revision out of the result (default)
474
* 'include' - the stop revision is the last item in the result
475
* 'with-merges' - include the stop revision and all of its
476
merged revisions in the result
477
* 'with-merges-without-common-ancestry' - filter out revisions
478
that are in both ancestries
479
:param direction: either 'reverse' or 'forward':
481
* reverse means return the start_revision_id first, i.e.
482
start at the most recent revision and go backwards in history
483
* forward returns tuples in the opposite order to reverse.
484
Note in particular that forward does *not* do any intelligent
485
ordering w.r.t. depth as some clients of this API may like.
486
(If required, that ought to be done at higher layers.)
488
:return: an iterator over (revision_id, depth, revno, end_of_merge)
491
* revision_id: the unique id of the revision
492
* depth: How many levels of merging deep this node has been
494
* revno_sequence: This field provides a sequence of
495
revision numbers for all revisions. The format is:
496
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
497
branch that the revno is on. From left to right the REVNO numbers
498
are the sequence numbers within that branch of the revision.
499
* end_of_merge: When True the next node (earlier in history) is
500
part of a different merge.
502
# Note: depth and revno values are in the context of the branch so
503
# we need the full graph to get stable numbers, regardless of the
505
if self._merge_sorted_revisions_cache is None:
506
last_revision = self.last_revision()
507
known_graph = self.repository.get_known_graph_ancestry(
509
self._merge_sorted_revisions_cache = known_graph.merge_sort(
511
filtered = self._filter_merge_sorted_revisions(
512
self._merge_sorted_revisions_cache, start_revision_id,
513
stop_revision_id, stop_rule)
514
# Make sure we don't return revisions that are not part of the
515
# start_revision_id ancestry.
516
filtered = self._filter_start_non_ancestors(filtered)
517
if direction == 'reverse':
519
if direction == 'forward':
520
return reversed(list(filtered))
522
raise ValueError('invalid direction %r' % direction)
524
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
525
start_revision_id, stop_revision_id, stop_rule):
526
"""Iterate over an inclusive range of sorted revisions."""
527
rev_iter = iter(merge_sorted_revisions)
528
if start_revision_id is not None:
529
for node in rev_iter:
531
if rev_id != start_revision_id:
534
# The decision to include the start or not
535
# depends on the stop_rule if a stop is provided
536
# so pop this node back into the iterator
537
rev_iter = itertools.chain(iter([node]), rev_iter)
539
if stop_revision_id is None:
541
for node in rev_iter:
543
yield (rev_id, node.merge_depth, node.revno,
545
elif stop_rule == 'exclude':
546
for node in rev_iter:
548
if rev_id == stop_revision_id:
550
yield (rev_id, node.merge_depth, node.revno,
552
elif stop_rule == 'include':
553
for node in rev_iter:
555
yield (rev_id, node.merge_depth, node.revno,
557
if rev_id == stop_revision_id:
559
elif stop_rule == 'with-merges-without-common-ancestry':
560
# We want to exclude all revisions that are already part of the
561
# stop_revision_id ancestry.
562
graph = self.repository.get_graph()
563
ancestors = graph.find_unique_ancestors(start_revision_id,
565
for node in rev_iter:
567
if rev_id not in ancestors:
569
yield (rev_id, node.merge_depth, node.revno,
571
elif stop_rule == 'with-merges':
572
stop_rev = self.repository.get_revision(stop_revision_id)
573
if stop_rev.parent_ids:
574
left_parent = stop_rev.parent_ids[0]
576
left_parent = _mod_revision.NULL_REVISION
577
# left_parent is the actual revision we want to stop logging at,
578
# since we want to show the merged revisions after the stop_rev too
579
reached_stop_revision_id = False
580
revision_id_whitelist = []
581
for node in rev_iter:
583
if rev_id == left_parent:
584
# reached the left parent after the stop_revision
586
if (not reached_stop_revision_id or
587
rev_id in revision_id_whitelist):
588
yield (rev_id, node.merge_depth, node.revno,
590
if reached_stop_revision_id or rev_id == stop_revision_id:
591
# only do the merged revs of rev_id from now on
592
rev = self.repository.get_revision(rev_id)
594
reached_stop_revision_id = True
595
revision_id_whitelist.extend(rev.parent_ids)
597
raise ValueError('invalid stop_rule %r' % stop_rule)
599
def _filter_start_non_ancestors(self, rev_iter):
600
# If we started from a dotted revno, we want to consider it as a tip
601
# and don't want to yield revisions that are not part of its
602
# ancestry. Given the order guaranteed by the merge sort, we will see
603
# uninteresting descendants of the first parent of our tip before the
605
first = rev_iter.next()
606
(rev_id, merge_depth, revno, end_of_merge) = first
609
# We start at a mainline revision so by definition, all others
610
# revisions in rev_iter are ancestors
611
for node in rev_iter:
616
pmap = self.repository.get_parent_map([rev_id])
617
parents = pmap.get(rev_id, [])
619
whitelist.update(parents)
621
# If there is no parents, there is nothing of interest left
623
# FIXME: It's hard to test this scenario here as this code is never
624
# called in that case. -- vila 20100322
627
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
629
if rev_id in whitelist:
630
pmap = self.repository.get_parent_map([rev_id])
631
parents = pmap.get(rev_id, [])
632
whitelist.remove(rev_id)
633
whitelist.update(parents)
635
# We've reached the mainline, there is nothing left to
639
# A revision that is not part of the ancestry of our
642
yield (rev_id, merge_depth, revno, end_of_merge)
223
644
def leave_lock_in_place(self):
224
645
"""Tell this branch object not to release the physical lock when this
225
646
object is unlocked.
227
648
If lock_write doesn't return a token, then this method is not supported.
229
650
self.control_files.leave_in_place()
312
722
:param committer: Optional committer to set for commit.
313
723
:param revprops: Optional dictionary of revision properties.
314
724
:param revision_id: Optional revision id.
725
:param lossy: Whether to discard data that can not be natively
726
represented, when pushing to a foreign VCS
318
config = self.get_config()
320
return self.repository.get_commit_builder(self, parents, config,
321
timestamp, timezone, committer, revprops, revision_id)
323
def get_master_branch(self):
729
if config_stack is None:
730
config_stack = self.get_config_stack()
732
return self.repository.get_commit_builder(self, parents, config_stack,
733
timestamp, timezone, committer, revprops, revision_id,
736
def get_master_branch(self, possible_transports=None):
324
737
"""Return the branch we are bound to.
326
739
:return: Either a Branch, or None
743
@deprecated_method(deprecated_in((2, 5, 0)))
330
744
def get_revision_delta(self, revno):
331
745
"""Return the delta for one revision.
333
747
The delta is relative to its mainline predecessor, or the
334
748
empty tree for revision 1.
336
assert isinstance(revno, int)
337
rh = self.revision_history()
338
if not (1 <= revno <= len(rh)):
339
raise InvalidRevisionNumber(revno)
340
return self.repository.get_revision_delta(rh[revno-1])
342
@deprecated_method(zero_sixteen)
343
def get_root_id(self):
344
"""Return the id of this branches root
346
Deprecated: branches don't have root ids-- trees do.
347
Use basis_tree().get_root_id() instead.
751
revid = self.get_rev_id(revno)
752
except errors.NoSuchRevision:
753
raise errors.InvalidRevisionNumber(revno)
754
return self.repository.get_revision_delta(revid)
756
def get_stacked_on_url(self):
757
"""Get the URL this branch is stacked against.
759
:raises NotStacked: If the branch is not stacked.
760
:raises UnstackableBranchFormat: If the branch does not support
349
raise NotImplementedError(self.get_root_id)
763
raise NotImplementedError(self.get_stacked_on_url)
351
765
def print_file(self, file, revision_id):
352
766
"""Print `file` to stdout."""
353
767
raise NotImplementedError(self.print_file)
769
@deprecated_method(deprecated_in((2, 4, 0)))
355
770
def set_revision_history(self, rev_history):
356
raise NotImplementedError(self.set_revision_history)
771
"""See Branch.set_revision_history."""
772
self._set_revision_history(rev_history)
775
def _set_revision_history(self, rev_history):
776
if len(rev_history) == 0:
777
revid = _mod_revision.NULL_REVISION
779
revid = rev_history[-1]
780
if rev_history != self._lefthand_history(revid):
781
raise errors.NotLefthandHistory(rev_history)
782
self.set_last_revision_info(len(rev_history), revid)
783
self._cache_revision_history(rev_history)
784
for hook in Branch.hooks['set_rh']:
785
hook(self, rev_history)
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)
358
964
def _cache_revision_history(self, rev_history):
359
965
"""Set the cached revision history to rev_history.
421
1039
That is equivalent to the number of revisions committed to
424
return len(self.revision_history())
1042
return self.last_revision_info()[0]
426
1044
def unbind(self):
427
1045
"""Older format branches cannot bind or unbind."""
428
raise errors.UpgradeRequired(self.base)
430
def set_append_revisions_only(self, enabled):
431
"""Older format branches are never restricted to append-only"""
432
raise errors.UpgradeRequired(self.base)
1046
raise errors.UpgradeRequired(self.user_url)
434
1048
def last_revision(self):
435
"""Return last revision id, or None"""
436
ph = self.revision_history()
440
return _mod_revision.NULL_REVISION
1049
"""Return last revision id, or NULL_REVISION."""
1050
return self.last_revision_info()[1]
442
1053
def last_revision_info(self):
443
1054
"""Return information about the last revision.
445
:return: A tuple (revno, last_revision_id).
447
rh = self.revision_history()
450
return (revno, rh[-1])
452
return (0, _mod_revision.NULL_REVISION)
454
def missing_revisions(self, other, stop_revision=None):
455
"""Return a list of new revisions that would perfectly fit.
457
If self and other have not diverged, return a list of the revisions
458
present in other, but missing from self.
460
self_history = self.revision_history()
461
self_len = len(self_history)
462
other_history = other.revision_history()
463
other_len = len(other_history)
464
common_index = min(self_len, other_len) -1
465
if common_index >= 0 and \
466
self_history[common_index] != other_history[common_index]:
467
raise DivergedBranches(self, other)
469
if stop_revision is None:
470
stop_revision = other_len
472
assert isinstance(stop_revision, int)
473
if stop_revision > other_len:
474
raise errors.NoSuchRevision(self, stop_revision)
475
return other_history[self_len:stop_revision]
477
def update_revisions(self, other, stop_revision=None):
478
"""Pull in new perfect-fit revisions.
480
:param other: Another Branch to pull from
481
:param stop_revision: Updated until the given revision
484
raise NotImplementedError(self.update_revisions)
1056
:return: A tuple (revno, revision_id).
1058
if self._last_revision_info_cache is None:
1059
self._last_revision_info_cache = self._read_last_revision_info()
1060
return self._last_revision_info_cache
1062
def _read_last_revision_info(self):
1063
raise NotImplementedError(self._read_last_revision_info)
1065
@deprecated_method(deprecated_in((2, 4, 0)))
1066
def import_last_revision_info(self, source_repo, revno, revid):
1067
"""Set the last revision info, importing from another repo if necessary.
1069
:param source_repo: Source repository to optionally fetch from
1070
:param revno: Revision number of the new tip
1071
:param revid: Revision id of the new tip
1073
if not self.repository.has_same_location(source_repo):
1074
self.repository.fetch(source_repo, revision_id=revid)
1075
self.set_last_revision_info(revno, revid)
1077
def import_last_revision_info_and_tags(self, source, revno, revid,
1079
"""Set the last revision info, importing from another repo if necessary.
1081
This is used by the bound branch code to upload a revision to
1082
the master branch first before updating the tip of the local branch.
1083
Revisions referenced by source's tags are also transferred.
1085
:param source: Source branch to optionally fetch from
1086
:param revno: Revision number of the new tip
1087
:param revid: Revision id of the new tip
1088
:param lossy: Whether to discard metadata that can not be
1089
natively represented
1090
:return: Tuple with the new revision number and revision id
1091
(should only be different from the arguments when lossy=True)
1093
if not self.repository.has_same_location(source.repository):
1094
self.fetch(source, revid)
1095
self.set_last_revision_info(revno, revid)
1096
return (revno, revid)
486
1098
def revision_id_to_revno(self, revision_id):
487
1099
"""Given a revision id, return its revno"""
488
1100
if _mod_revision.is_null(revision_id):
490
revision_id = osutils.safe_revision_id(revision_id)
491
history = self.revision_history()
1102
history = self._revision_history()
493
1104
return history.index(revision_id) + 1
494
1105
except ValueError:
495
1106
raise errors.NoSuchRevision(self, revision_id)
497
1109
def get_rev_id(self, revno, history=None):
498
1110
"""Find the revision id of the specified revno."""
500
1112
return _mod_revision.NULL_REVISION
502
history = self.revision_history()
503
if revno <= 0 or revno > len(history):
1113
last_revno, last_revid = self.last_revision_info()
1114
if revno == last_revno:
1116
if revno <= 0 or revno > last_revno:
504
1117
raise errors.NoSuchRevision(self, revno)
505
return history[revno - 1]
1118
distance_from_last = last_revno - revno
1119
if len(self._partial_revision_history_cache) <= distance_from_last:
1120
self._extend_partial_history(distance_from_last)
1121
return self._partial_revision_history_cache[distance_from_last]
507
def pull(self, source, overwrite=False, stop_revision=None):
1123
def pull(self, source, overwrite=False, stop_revision=None,
1124
possible_transports=None, *args, **kwargs):
508
1125
"""Mirror source into this branch.
510
1127
This branch is considered to be 'local', having low latency.
512
1129
:returns: PullResult instance
514
raise NotImplementedError(self.pull)
1131
return InterBranch.get(source, self).pull(overwrite=overwrite,
1132
stop_revision=stop_revision,
1133
possible_transports=possible_transports, *args, **kwargs)
516
def push(self, target, overwrite=False, stop_revision=None):
1135
def push(self, target, overwrite=False, stop_revision=None, lossy=False,
517
1137
"""Mirror this branch into target.
519
1139
This branch is considered to be 'local', having low latency.
521
raise NotImplementedError(self.push)
1141
return InterBranch.get(self, target).push(overwrite, stop_revision,
1142
lossy, *args, **kwargs)
523
1144
def basis_tree(self):
524
1145
"""Return `Tree` object for last revision."""
525
1146
return self.repository.revision_tree(self.last_revision())
527
def rename_one(self, from_rel, to_rel):
530
This can change the directory or the filename or both.
532
raise NotImplementedError(self.rename_one)
534
def move(self, from_paths, to_name):
537
to_name must exist as a versioned directory.
539
If to_name exists and is a directory, the files are moved into
540
it, keeping their old names. If it is a directory,
542
Note that to_name is only the last component of the new name;
543
this doesn't change the directory.
545
This returns a list of (from_path, to_path) pairs for each
548
raise NotImplementedError(self.move)
550
1148
def get_parent(self):
551
1149
"""Return the parent location of the branch.
553
This is the default location for push/pull/missing. The usual
1151
This is the default location for pull/missing. The usual
554
1152
pattern is that the user can override it by specifying a
557
raise NotImplementedError(self.get_parent)
1155
parent = self._get_parent_location()
1158
# This is an old-format absolute path to a local branch
1159
# turn it into a url
1160
if parent.startswith('/'):
1161
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1163
return urlutils.join(self.base[:-1], parent)
1164
except errors.InvalidURLJoin, e:
1165
raise errors.InaccessibleParent(parent, self.user_url)
1167
def _get_parent_location(self):
1168
raise NotImplementedError(self._get_parent_location)
559
1170
def _set_config_location(self, name, url, config=None,
560
1171
make_relative=False):
561
1172
if config is None:
562
config = self.get_config()
1173
config = self.get_config_stack()
565
1176
elif make_relative:
566
1177
url = urlutils.relative_url(self.base, url)
567
config.set_user_option(name, url, warn_masked=True)
1178
config.set(name, url)
569
1180
def _get_config_location(self, name, config=None):
570
1181
if config is None:
571
config = self.get_config()
572
location = config.get_user_option(name)
1182
config = self.get_config_stack()
1183
location = config.get(name)
573
1184
if location == '':
1188
def get_child_submit_format(self):
1189
"""Return the preferred format of submissions to this branch."""
1190
return self.get_config_stack().get('child_submit_format')
577
1192
def get_submit_branch(self):
578
1193
"""Return the submit location of the branch.
638
1270
self.check_real_revno(revno)
640
1272
def check_real_revno(self, revno):
642
1274
Check whether a revno corresponds to a real revision.
643
1275
Zero (the NULL revision) is considered invalid
645
1277
if revno < 1 or revno > self.revno():
646
raise InvalidRevisionNumber(revno)
1278
raise errors.InvalidRevisionNumber(revno)
648
1280
@needs_read_lock
649
def clone(self, to_bzrdir, revision_id=None):
1281
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
650
1282
"""Clone this branch into to_bzrdir preserving all semantic values.
1284
Most API users will want 'create_clone_on_transport', which creates a
1285
new bzrdir and branch on the fly.
652
1287
revision_id: if not None, the revision history in the new branch will
653
1288
be truncated to end with revision_id.
655
result = self._format.initialize(to_bzrdir)
656
self.copy_content_into(result, revision_id=revision_id)
1290
result = to_bzrdir.create_branch()
1293
if repository_policy is not None:
1294
repository_policy.configure_branch(result)
1295
self.copy_content_into(result, revision_id=revision_id)
659
1300
@needs_read_lock
660
def sprout(self, to_bzrdir, revision_id=None):
1301
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
661
1303
"""Create a new line of development from the branch, into to_bzrdir.
1305
to_bzrdir controls the branch format.
663
1307
revision_id: if not None, the revision history in the new branch will
664
1308
be truncated to end with revision_id.
666
result = self._format.initialize(to_bzrdir)
667
self.copy_content_into(result, revision_id=revision_id)
668
result.set_parent(self.bzrdir.root_transport.base)
1310
if (repository_policy is not None and
1311
repository_policy.requires_stacking()):
1312
to_bzrdir._format.require_stacking(_skip_repo=True)
1313
result = to_bzrdir.create_branch(repository=repository)
1316
if repository_policy is not None:
1317
repository_policy.configure_branch(result)
1318
self.copy_content_into(result, revision_id=revision_id)
1319
master_url = self.get_bound_location()
1320
if master_url is None:
1321
result.set_parent(self.bzrdir.root_transport.base)
1323
result.set_parent(master_url)
671
1328
def _synchronize_history(self, destination, revision_id):
672
1329
"""Synchronize last revision and revision history between branches.
674
1331
This version is most efficient when the destination is also a
675
BzrBranch5, but works for BzrBranch6 as long as the revision
676
history is the true lefthand parent history, and all of the revisions
677
are in the destination's repository. If not, set_revision_history
1332
BzrBranch6, but works for BzrBranch5, as long as the destination's
1333
repository contains all the lefthand ancestors of the intended
1334
last_revision. If not, set_last_revision_info will fail.
680
1336
:param destination: The branch to copy the history into
681
1337
:param revision_id: The revision-id to truncate history at. May
682
1338
be None to copy complete history.
684
if revision_id == _mod_revision.NULL_REVISION:
686
new_history = self.revision_history()
687
if revision_id is not None and new_history != []:
688
revision_id = osutils.safe_revision_id(revision_id)
1340
source_revno, source_revision_id = self.last_revision_info()
1341
if revision_id is None:
1342
revno, revision_id = source_revno, source_revision_id
1344
graph = self.repository.get_graph()
690
new_history = new_history[:new_history.index(revision_id) + 1]
692
rev = self.repository.get_revision(revision_id)
693
new_history = rev.get_history(self.repository)[1:]
694
destination.set_revision_history(new_history)
1346
revno = graph.find_distance_to_null(revision_id,
1347
[(source_revision_id, source_revno)])
1348
except errors.GhostRevisionsHaveNoRevno:
1349
# Default to 1, if we can't find anything else
1351
destination.set_last_revision_info(revno, revision_id)
697
1353
def copy_content_into(self, destination, revision_id=None):
698
1354
"""Copy the content of self into destination.
700
1356
revision_id: if not None, the revision history in the new branch will
701
1357
be truncated to end with revision_id.
703
self._synchronize_history(destination, revision_id)
705
parent = self.get_parent()
706
except errors.InaccessibleParent, e:
707
mutter('parent was not accessible to copy: %s', e)
710
destination.set_parent(parent)
711
self.tags.merge_to(destination.tags)
1359
return InterBranch.get(self, destination).copy_content_into(
1360
revision_id=revision_id)
1362
def update_references(self, target):
1363
if not getattr(self._format, 'supports_reference_locations', False):
1365
reference_dict = self._get_all_reference_info()
1366
if len(reference_dict) == 0:
1368
old_base = self.base
1369
new_base = target.base
1370
target_reference_dict = target._get_all_reference_info()
1371
for file_id, (tree_path, branch_location) in (
1372
reference_dict.items()):
1373
branch_location = urlutils.rebase_url(branch_location,
1375
target_reference_dict.setdefault(
1376
file_id, (tree_path, branch_location))
1377
target._set_all_reference_info(target_reference_dict)
713
1379
@needs_read_lock
1380
def check(self, refs):
715
1381
"""Check consistency of the branch.
717
1383
In particular this checks that revisions given in the revision-history
718
do actually match up in the revision graph, and that they're all
1384
do actually match up in the revision graph, and that they're all
719
1385
present in the repository.
721
1387
Callers will typically also want to check the repository.
1389
:param refs: Calculated refs for this branch as specified by
1390
branch._get_check_refs()
723
1391
:return: A BranchCheckResult.
725
mainline_parent_id = None
726
for revision_id in self.revision_history():
728
revision = self.repository.get_revision(revision_id)
729
except errors.NoSuchRevision, e:
730
raise errors.BzrCheckError("mainline revision {%s} not in repository"
732
# In general the first entry on the revision history has no parents.
733
# But it's not illegal for it to have parents listed; this can happen
734
# in imports from Arch when the parents weren't reachable.
735
if mainline_parent_id is not None:
736
if mainline_parent_id not in revision.parent_ids:
737
raise errors.BzrCheckError("previous revision {%s} not listed among "
739
% (mainline_parent_id, revision_id))
740
mainline_parent_id = revision_id
741
return BranchCheckResult(self)
1393
result = BranchCheckResult(self)
1394
last_revno, last_revision_id = self.last_revision_info()
1395
actual_revno = refs[('lefthand-distance', last_revision_id)]
1396
if actual_revno != last_revno:
1397
result.errors.append(errors.BzrCheckError(
1398
'revno does not match len(mainline) %s != %s' % (
1399
last_revno, actual_revno)))
1400
# TODO: We should probably also check that self.revision_history
1401
# matches the repository for older branch formats.
1402
# If looking for the code that cross-checks repository parents against
1403
# the Graph.iter_lefthand_ancestry output, that is now a repository
743
def _get_checkout_format(self):
1407
def _get_checkout_format(self, lightweight=False):
744
1408
"""Return the most suitable metadir for a checkout of this branch.
745
1409
Weaves are used if this branch's repository uses weaves.
747
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
748
from bzrlib.repofmt import weaverepo
749
format = bzrdir.BzrDirMetaFormat1()
750
format.repository_format = weaverepo.RepositoryFormat7()
752
format = self.repository.bzrdir.checkout_metadir()
753
format.set_branch_format(self._format)
1411
format = self.repository.bzrdir.checkout_metadir()
1412
format.set_branch_format(self._format)
1415
def create_clone_on_transport(self, to_transport, revision_id=None,
1416
stacked_on=None, create_prefix=False, use_existing_dir=False,
1418
"""Create a clone of this branch and its bzrdir.
1420
:param to_transport: The transport to clone onto.
1421
:param revision_id: The revision id to use as tip in the new branch.
1422
If None the tip is obtained from this branch.
1423
:param stacked_on: An optional URL to stack the clone on.
1424
:param create_prefix: Create any missing directories leading up to
1426
:param use_existing_dir: Use an existing directory if one exists.
1428
# XXX: Fix the bzrdir API to allow getting the branch back from the
1429
# clone call. Or something. 20090224 RBC/spiv.
1430
# XXX: Should this perhaps clone colocated branches as well,
1431
# rather than just the default branch? 20100319 JRV
1432
if revision_id is None:
1433
revision_id = self.last_revision()
1434
dir_to = self.bzrdir.clone_on_transport(to_transport,
1435
revision_id=revision_id, stacked_on=stacked_on,
1436
create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1438
return dir_to.open_branch()
756
1440
def create_checkout(self, to_location, revision_id=None,
1441
lightweight=False, accelerator_tree=None,
758
1443
"""Create a checkout of a branch.
760
1445
:param to_location: The url to produce the checkout at
761
1446
:param revision_id: The revision to check out
762
1447
:param lightweight: If True, produce a lightweight checkout, otherwise,
763
produce a bound branch (heavyweight checkout)
1448
produce a bound branch (heavyweight checkout)
1449
:param accelerator_tree: A tree which can be used for retrieving file
1450
contents more quickly than the revision tree, i.e. a workingtree.
1451
The revision tree will be used for cases where accelerator_tree's
1452
content is different.
1453
:param hardlink: If true, hard-link files from accelerator_tree,
764
1455
:return: The tree of the created checkout
766
1457
t = transport.get_transport(to_location)
1459
format = self._get_checkout_format(lightweight=lightweight)
1461
checkout = format.initialize_on_transport(t)
1462
except errors.AlreadyControlDirError:
1463
# It's fine if the control directory already exists,
1464
# as long as there is no existing branch and working tree.
1465
checkout = controldir.ControlDir.open_from_transport(t)
1467
checkout.open_branch()
1468
except errors.NotBranchError:
1471
raise errors.AlreadyControlDirError(t.base)
1472
if checkout.control_transport.base == self.bzrdir.control_transport.base:
1473
# When checking out to the same control directory,
1474
# always create a lightweight checkout
769
format = self._get_checkout_format()
770
checkout = format.initialize_on_transport(t)
771
BranchReferenceFormat().initialize(checkout, self)
1478
from_branch = checkout.set_branch_reference(target_branch=self)
773
format = self._get_checkout_format()
774
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
775
to_location, force_new_tree=False, format=format)
776
checkout = checkout_branch.bzrdir
1480
policy = checkout.determine_repository_policy()
1481
repo = policy.acquire_repository()[0]
1482
checkout_branch = checkout.create_branch()
777
1483
checkout_branch.bind(self)
778
# pull up to the specified revision_id to set the initial
1484
# pull up to the specified revision_id to set the initial
779
1485
# branch tip correctly, and seed it with history.
780
1486
checkout_branch.pull(self, stop_revision=revision_id)
781
tree = checkout.create_workingtree(revision_id)
1488
tree = checkout.create_workingtree(revision_id,
1489
from_branch=from_branch,
1490
accelerator_tree=accelerator_tree,
782
1492
basis_tree = tree.basis_tree()
783
1493
basis_tree.lock_read()
791
1501
basis_tree.unlock()
794
def reference_parent(self, file_id, path):
1505
def reconcile(self, thorough=True):
1506
"""Make sure the data stored in this branch is consistent."""
1507
from bzrlib.reconcile import BranchReconciler
1508
reconciler = BranchReconciler(self, thorough=thorough)
1509
reconciler.reconcile()
1512
def reference_parent(self, file_id, path, possible_transports=None):
795
1513
"""Return the parent branch for a tree-reference file_id
796
1515
:param file_id: The file_id of the tree reference
797
1516
:param path: The path of the file_id in the tree
798
1517
:return: A branch associated with the file_id
800
1519
# FIXME should provide multiple branches, based on config
801
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1520
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1521
possible_transports=possible_transports)
803
1523
def supports_tags(self):
804
1524
return self._format.supports_tags()
807
class BranchFormat(object):
1526
def automatic_tag_name(self, revision_id):
1527
"""Try to automatically find the tag name for a revision.
1529
:param revision_id: Revision id of the revision.
1530
:return: A tag name or None if no tag name could be determined.
1532
for hook in Branch.hooks['automatic_tag_name']:
1533
ret = hook(self, revision_id)
1538
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1540
"""Ensure that revision_b is a descendant of revision_a.
1542
This is a helper function for update_revisions.
1544
:raises: DivergedBranches if revision_b has diverged from revision_a.
1545
:returns: True if revision_b is a descendant of revision_a.
1547
relation = self._revision_relations(revision_a, revision_b, graph)
1548
if relation == 'b_descends_from_a':
1550
elif relation == 'diverged':
1551
raise errors.DivergedBranches(self, other_branch)
1552
elif relation == 'a_descends_from_b':
1555
raise AssertionError("invalid relation: %r" % (relation,))
1557
def _revision_relations(self, revision_a, revision_b, graph):
1558
"""Determine the relationship between two revisions.
1560
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1562
heads = graph.heads([revision_a, revision_b])
1563
if heads == set([revision_b]):
1564
return 'b_descends_from_a'
1565
elif heads == set([revision_a, revision_b]):
1566
# These branches have diverged
1568
elif heads == set([revision_a]):
1569
return 'a_descends_from_b'
1571
raise AssertionError("invalid heads: %r" % (heads,))
1573
def heads_to_fetch(self):
1574
"""Return the heads that must and that should be fetched to copy this
1575
branch into another repo.
1577
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1578
set of heads that must be fetched. if_present_fetch is a set of
1579
heads that must be fetched if present, but no error is necessary if
1580
they are not present.
1582
# For bzr native formats must_fetch is just the tip, and
1583
# if_present_fetch are the tags.
1584
must_fetch = set([self.last_revision()])
1585
if_present_fetch = set()
1586
if self.get_config_stack().get('branch.fetch_tags'):
1588
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1589
except errors.TagsNotSupported:
1591
must_fetch.discard(_mod_revision.NULL_REVISION)
1592
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1593
return must_fetch, if_present_fetch
1596
class BranchFormat(controldir.ControlComponentFormat):
808
1597
"""An encapsulation of the initialization and open routines for a format.
810
1599
Formats provide three things:
811
1600
* An initialization routine,
1601
* a format description
813
1602
* an open routine.
815
Formats are placed in an dict by their format string for reference
816
during branch opening. Its not required that these be instances, they
817
can be classes themselves with class methods - it simply depends on
1604
Formats are placed in an dict by their format string for reference
1605
during branch opening. It's not required that these be instances, they
1606
can be classes themselves with class methods - it simply depends on
818
1607
whether state is needed for a given format or not.
820
1609
Once a format is deprecated, just deprecate the initialize and open
821
methods on the format class. Do not deprecate the object, as the
1610
methods on the format class. Do not deprecate the object, as the
822
1611
object will be created every time regardless.
825
_default_format = None
826
"""The default format used for new branches."""
829
"""The known formats."""
831
1614
def __eq__(self, other):
832
1615
return self.__class__ is other.__class__
835
1618
return not (self == other)
838
def find_format(klass, a_bzrdir):
839
"""Return the format for the branch object in a_bzrdir."""
841
transport = a_bzrdir.get_branch_transport(None)
842
format_string = transport.get("format").read()
843
return klass._formats[format_string]
845
raise NotBranchError(path=transport.base)
847
raise errors.UnknownFormatError(format=format_string)
1621
@deprecated_method(deprecated_in((2, 4, 0)))
850
1622
def get_default_format(klass):
851
1623
"""Return the current default format."""
852
return klass._default_format
854
def get_reference(self, a_bzrdir):
855
"""Get the target reference of the branch in a_bzrdir.
1624
return format_registry.get_default()
1627
@deprecated_method(deprecated_in((2, 4, 0)))
1628
def get_formats(klass):
1629
"""Get all the known formats.
1631
Warning: This triggers a load of all lazy registered formats: do not
1632
use except when that is desireed.
1634
return format_registry._get_all()
1636
def get_reference(self, controldir, name=None):
1637
"""Get the target reference of the branch in controldir.
857
1639
format probing must have been completed before calling
858
1640
this method - it is assumed that the format of the branch
859
in a_bzrdir is correct.
1641
in controldir is correct.
861
:param a_bzrdir: The bzrdir to get the branch data from.
1643
:param controldir: The controldir to get the branch data from.
1644
:param name: Name of the colocated branch to fetch
862
1645
:return: None if the branch is not a reference branch.
866
def get_format_string(self):
867
"""Return the ASCII format string that identifies this format."""
868
raise NotImplementedError(self.get_format_string)
1650
def set_reference(self, controldir, name, to_branch):
1651
"""Set the target reference of the branch in controldir.
1653
format probing must have been completed before calling
1654
this method - it is assumed that the format of the branch
1655
in controldir is correct.
1657
:param controldir: The controldir to set the branch reference for.
1658
:param name: Name of colocated branch to set, None for default
1659
:param to_branch: branch that the checkout is to reference
1661
raise NotImplementedError(self.set_reference)
870
1663
def get_format_description(self):
871
1664
"""Return the short format description for this format."""
872
1665
raise NotImplementedError(self.get_format_description)
874
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
876
"""Initialize a branch in a bzrdir, with specified files
878
:param a_bzrdir: The bzrdir to initialize the branch in
879
:param utf8_files: The files to create as a list of
880
(filename, content) tuples
881
:param set_format: If True, set the format with
882
self.get_format_string. (BzrBranch4 has its format set
884
:return: a branch in this format
1667
def _run_post_branch_init_hooks(self, controldir, name, branch):
1668
hooks = Branch.hooks['post_branch_init']
1671
params = BranchInitHookParams(self, controldir, name, branch)
1675
def initialize(self, controldir, name=None, repository=None,
1676
append_revisions_only=None):
1677
"""Create a branch of this format in controldir.
1679
:param name: Name of the colocated branch to create.
886
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
887
branch_transport = a_bzrdir.get_branch_transport(self)
889
'metadir': ('lock', lockdir.LockDir),
890
'branch4': ('branch-lock', lockable_files.TransportLock),
892
lock_name, lock_class = lock_map[lock_type]
893
control_files = lockable_files.LockableFiles(branch_transport,
894
lock_name, lock_class)
895
control_files.create_lock()
896
control_files.lock_write()
898
control_files.put_utf8('format', self.get_format_string())
900
for file, content in utf8_files:
901
control_files.put_utf8(file, content)
903
control_files.unlock()
904
return self.open(a_bzrdir, _found=True)
906
def initialize(self, a_bzrdir):
907
"""Create a branch of this format in a_bzrdir."""
908
1681
raise NotImplementedError(self.initialize)
910
1683
def is_supported(self):
911
1684
"""Is this format supported?
913
1686
Supported formats can be initialized and opened.
914
Unsupported formats may not support initialization or committing or
1687
Unsupported formats may not support initialization or committing or
915
1688
some other features depending on the reason for not being supported.
919
def open(self, a_bzrdir, _found=False):
920
"""Return the branch object for a_bzrdir
922
_found is a private parameter, do not use it. It is used to indicate
923
if format probing has already be done.
1692
def make_tags(self, branch):
1693
"""Create a tags object for branch.
1695
This method is on BranchFormat, because BranchFormats are reflected
1696
over the wire via network_name(), whereas full Branch instances require
1697
multiple VFS method calls to operate at all.
1699
The default implementation returns a disabled-tags instance.
1701
Note that it is normal for branch to be a RemoteBranch when using tags
1704
return _mod_tag.DisabledTags(branch)
1706
def network_name(self):
1707
"""A simple byte string uniquely identifying this format for RPC calls.
1709
MetaDir branch formats use their disk format string to identify the
1710
repository over the wire. All in one formats such as bzr < 0.8, and
1711
foreign formats like svn/git and hg should use some marker which is
1712
unique and immutable.
1714
raise NotImplementedError(self.network_name)
1716
def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
1717
found_repository=None, possible_transports=None):
1718
"""Return the branch object for controldir.
1720
:param controldir: A ControlDir that contains a branch.
1721
:param name: Name of colocated branch to open
1722
:param _found: a private parameter, do not use it. It is used to
1723
indicate if format probing has already be done.
1724
:param ignore_fallbacks: when set, no fallback branches will be opened
1725
(if there are any). Default is to open fallbacks.
925
1727
raise NotImplementedError(self.open)
1730
@deprecated_method(deprecated_in((2, 4, 0)))
928
1731
def register_format(klass, format):
929
klass._formats[format.get_format_string()] = format
1732
"""Register a metadir format.
1734
See MetaDirBranchFormatFactory for the ability to register a format
1735
without loading the code the format needs until it is actually used.
1737
format_registry.register(format)
1740
@deprecated_method(deprecated_in((2, 4, 0)))
932
1741
def set_default_format(klass, format):
933
klass._default_format = format
1742
format_registry.set_default(format)
1744
def supports_set_append_revisions_only(self):
1745
"""True if this format supports set_append_revisions_only."""
1748
def supports_stacking(self):
1749
"""True if this format records a stacked-on branch."""
1752
def supports_leaving_lock(self):
1753
"""True if this format supports leaving locks in place."""
1754
return False # by default
1757
@deprecated_method(deprecated_in((2, 4, 0)))
936
1758
def unregister_format(klass, format):
937
assert klass._formats[format.get_format_string()] is format
938
del klass._formats[format.get_format_string()]
1759
format_registry.remove(format)
940
1761
def __str__(self):
941
return self.get_format_string().rstrip()
1762
return self.get_format_description().rstrip()
943
1764
def supports_tags(self):
944
1765
"""True if this format supports tags stored in the branch"""
945
1766
return False # by default
947
# XXX: Probably doesn't really belong here -- mbp 20070212
948
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
950
branch_transport = a_bzrdir.get_branch_transport(self)
951
control_files = lockable_files.LockableFiles(branch_transport,
952
lock_filename, lock_class)
953
control_files.create_lock()
954
control_files.lock_write()
956
for filename, content in utf8_files:
957
control_files.put_utf8(filename, content)
959
control_files.unlock()
1768
def tags_are_versioned(self):
1769
"""Whether the tag container for this branch versions tags."""
1772
def supports_tags_referencing_ghosts(self):
1773
"""True if tags can reference ghost revisions."""
1777
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1778
"""A factory for a BranchFormat object, permitting simple lazy registration.
1780
While none of the built in BranchFormats are lazy registered yet,
1781
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1782
use it, and the bzr-loom plugin uses it as well (see
1783
bzrlib.plugins.loom.formats).
1786
def __init__(self, format_string, module_name, member_name):
1787
"""Create a MetaDirBranchFormatFactory.
1789
:param format_string: The format string the format has.
1790
:param module_name: Module to load the format class from.
1791
:param member_name: Attribute name within the module for the format class.
1793
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1794
self._format_string = format_string
1796
def get_format_string(self):
1797
"""See BranchFormat.get_format_string."""
1798
return self._format_string
1801
"""Used for network_format_registry support."""
1802
return self.get_obj()()
962
1805
class BranchHooks(Hooks):
963
1806
"""A dictionary mapping hook name to a list of callables for branch hooks.
965
1808
e.g. ['set_rh'] Is the list of items to be called when the
966
1809
set_revision_history function is invoked.
972
1815
These are all empty initially, because by default nothing should get
976
# Introduced in 0.15:
977
# invoked whenever the revision history has been set
978
# with set_revision_history. The api signature is
979
# (branch, revision_history), and the branch will
982
# invoked after a push operation completes.
983
# the api signature is
985
# containing the members
986
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
987
# where local is the local target branch or None, master is the target
988
# master branch, and the rest should be self explanatory. The source
989
# is read locked and the target branches write locked. Source will
990
# be the local low-latency branch.
991
self['post_push'] = []
992
# invoked after a pull operation completes.
993
# the api signature is
995
# containing the members
996
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
997
# where local is the local branch or None, master is the target
998
# master branch, and the rest should be self explanatory. The source
999
# is read locked and the target branches write locked. The local
1000
# branch is the low-latency branch.
1001
self['post_pull'] = []
1002
# invoked after a commit operation completes.
1003
# the api signature is
1004
# (local, master, old_revno, old_revid, new_revno, new_revid)
1005
# old_revid is NULL_REVISION for the first commit to a branch.
1006
self['post_commit'] = []
1007
# invoked after a uncommit operation completes.
1008
# the api signature is
1009
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1010
# local is the local branch or None, master is the target branch,
1011
# and an empty branch recieves new_revno of 0, new_revid of None.
1012
self['post_uncommit'] = []
1818
Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1819
self.add_hook('set_rh',
1820
"Invoked whenever the revision history has been set via "
1821
"set_revision_history. The api signature is (branch, "
1822
"revision_history), and the branch will be write-locked. "
1823
"The set_rh hook can be expensive for bzr to trigger, a better "
1824
"hook to use is Branch.post_change_branch_tip.", (0, 15))
1825
self.add_hook('open',
1826
"Called with the Branch object that has been opened after a "
1827
"branch is opened.", (1, 8))
1828
self.add_hook('post_push',
1829
"Called after a push operation completes. post_push is called "
1830
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1831
"bzr client.", (0, 15))
1832
self.add_hook('post_pull',
1833
"Called after a pull operation completes. post_pull is called "
1834
"with a bzrlib.branch.PullResult object and only runs in the "
1835
"bzr client.", (0, 15))
1836
self.add_hook('pre_commit',
1837
"Called after a commit is calculated but before it is "
1838
"completed. pre_commit is called with (local, master, old_revno, "
1839
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1840
"). old_revid is NULL_REVISION for the first commit to a branch, "
1841
"tree_delta is a TreeDelta object describing changes from the "
1842
"basis revision. hooks MUST NOT modify this delta. "
1843
" future_tree is an in-memory tree obtained from "
1844
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1846
self.add_hook('post_commit',
1847
"Called in the bzr client after a commit has completed. "
1848
"post_commit is called with (local, master, old_revno, old_revid, "
1849
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1850
"commit to a branch.", (0, 15))
1851
self.add_hook('post_uncommit',
1852
"Called in the bzr client after an uncommit completes. "
1853
"post_uncommit is called with (local, master, old_revno, "
1854
"old_revid, new_revno, new_revid) where local is the local branch "
1855
"or None, master is the target branch, and an empty branch "
1856
"receives new_revno of 0, new_revid of None.", (0, 15))
1857
self.add_hook('pre_change_branch_tip',
1858
"Called in bzr client and server before a change to the tip of a "
1859
"branch is made. pre_change_branch_tip is called with a "
1860
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1861
"commit, uncommit will all trigger this hook.", (1, 6))
1862
self.add_hook('post_change_branch_tip',
1863
"Called in bzr client and server after a change to the tip of a "
1864
"branch is made. post_change_branch_tip is called with a "
1865
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1866
"commit, uncommit will all trigger this hook.", (1, 4))
1867
self.add_hook('transform_fallback_location',
1868
"Called when a stacked branch is activating its fallback "
1869
"locations. transform_fallback_location is called with (branch, "
1870
"url), and should return a new url. Returning the same url "
1871
"allows it to be used as-is, returning a different one can be "
1872
"used to cause the branch to stack on a closer copy of that "
1873
"fallback_location. Note that the branch cannot have history "
1874
"accessing methods called on it during this hook because the "
1875
"fallback locations have not been activated. When there are "
1876
"multiple hooks installed for transform_fallback_location, "
1877
"all are called with the url returned from the previous hook."
1878
"The order is however undefined.", (1, 9))
1879
self.add_hook('automatic_tag_name',
1880
"Called to determine an automatic tag name for a revision. "
1881
"automatic_tag_name is called with (branch, revision_id) and "
1882
"should return a tag name or None if no tag name could be "
1883
"determined. The first non-None tag name returned will be used.",
1885
self.add_hook('post_branch_init',
1886
"Called after new branch initialization completes. "
1887
"post_branch_init is called with a "
1888
"bzrlib.branch.BranchInitHookParams. "
1889
"Note that init, branch and checkout (both heavyweight and "
1890
"lightweight) will all trigger this hook.", (2, 2))
1891
self.add_hook('post_switch',
1892
"Called after a checkout switches branch. "
1893
"post_switch is called with a "
1894
"bzrlib.branch.SwitchHookParams.", (2, 2))
1015
1898
# install the default hooks into the Branch class.
1016
1899
Branch.hooks = BranchHooks()
1019
class BzrBranchFormat4(BranchFormat):
1020
"""Bzr branch format 4.
1023
- a revision-history file.
1024
- a branch-lock lock file [ to be shared with the bzrdir ]
1027
def get_format_description(self):
1028
"""See BranchFormat.get_format_description()."""
1029
return "Branch format 4"
1031
def initialize(self, a_bzrdir):
1032
"""Create a branch of this format in a_bzrdir."""
1033
utf8_files = [('revision-history', ''),
1034
('branch-name', ''),
1036
return self._initialize_helper(a_bzrdir, utf8_files,
1037
lock_type='branch4', set_format=False)
1902
class ChangeBranchTipParams(object):
1903
"""Object holding parameters passed to `*_change_branch_tip` hooks.
1905
There are 5 fields that hooks may wish to access:
1907
:ivar branch: the branch being changed
1908
:ivar old_revno: revision number before the change
1909
:ivar new_revno: revision number after the change
1910
:ivar old_revid: revision id before the change
1911
:ivar new_revid: revision id after the change
1913
The revid fields are strings. The revno fields are integers.
1916
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1917
"""Create a group of ChangeBranchTip parameters.
1919
:param branch: The branch being changed.
1920
:param old_revno: Revision number before the change.
1921
:param new_revno: Revision number after the change.
1922
:param old_revid: Tip revision id before the change.
1923
:param new_revid: Tip revision id after the change.
1925
self.branch = branch
1926
self.old_revno = old_revno
1927
self.new_revno = new_revno
1928
self.old_revid = old_revid
1929
self.new_revid = new_revid
1931
def __eq__(self, other):
1932
return self.__dict__ == other.__dict__
1935
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1936
self.__class__.__name__, self.branch,
1937
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1940
class BranchInitHookParams(object):
1941
"""Object holding parameters passed to `*_branch_init` hooks.
1943
There are 4 fields that hooks may wish to access:
1945
:ivar format: the branch format
1946
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1947
:ivar name: name of colocated branch, if any (or None)
1948
:ivar branch: the branch created
1950
Note that for lightweight checkouts, the bzrdir and format fields refer to
1951
the checkout, hence they are different from the corresponding fields in
1952
branch, which refer to the original branch.
1955
def __init__(self, format, controldir, name, branch):
1956
"""Create a group of BranchInitHook parameters.
1958
:param format: the branch format
1959
:param controldir: the ControlDir where the branch will be/has been
1961
:param name: name of colocated branch, if any (or None)
1962
:param branch: the branch created
1964
Note that for lightweight checkouts, the bzrdir and format fields refer
1965
to the checkout, hence they are different from the corresponding fields
1966
in branch, which refer to the original branch.
1968
self.format = format
1969
self.bzrdir = controldir
1971
self.branch = branch
1973
def __eq__(self, other):
1974
return self.__dict__ == other.__dict__
1977
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1980
class SwitchHookParams(object):
1981
"""Object holding parameters passed to `*_switch` hooks.
1983
There are 4 fields that hooks may wish to access:
1985
:ivar control_dir: ControlDir of the checkout to change
1986
:ivar to_branch: branch that the checkout is to reference
1987
:ivar force: skip the check for local commits in a heavy checkout
1988
:ivar revision_id: revision ID to switch to (or None)
1991
def __init__(self, control_dir, to_branch, force, revision_id):
1992
"""Create a group of SwitchHook parameters.
1994
:param control_dir: ControlDir of the checkout to change
1995
:param to_branch: branch that the checkout is to reference
1996
:param force: skip the check for local commits in a heavy checkout
1997
:param revision_id: revision ID to switch to (or None)
1999
self.control_dir = control_dir
2000
self.to_branch = to_branch
2002
self.revision_id = revision_id
2004
def __eq__(self, other):
2005
return self.__dict__ == other.__dict__
2008
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
2009
self.control_dir, self.to_branch,
2013
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
2014
"""Base class for branch formats that live in meta directories.
1039
2017
def __init__(self):
1040
super(BzrBranchFormat4, self).__init__()
1041
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1043
def open(self, a_bzrdir, _found=False):
1044
"""Return the branch object for a_bzrdir
1046
_found is a private parameter, do not use it. It is used to indicate
1047
if format probing has already be done.
2018
BranchFormat.__init__(self)
2019
bzrdir.BzrFormat.__init__(self)
2022
def find_format(klass, controldir, name=None):
2023
"""Return the format for the branch object in controldir."""
2025
transport = controldir.get_branch_transport(None, name=name)
2026
except errors.NoSuchFile:
2027
raise errors.NotBranchError(path=name, bzrdir=controldir)
2029
format_string = transport.get_bytes("format")
2030
except errors.NoSuchFile:
2031
raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
2032
return klass._find_format(format_registry, 'branch', format_string)
2034
def _branch_class(self):
2035
"""What class to instantiate on open calls."""
2036
raise NotImplementedError(self._branch_class)
2038
def _get_initial_config(self, append_revisions_only=None):
2039
if append_revisions_only:
2040
return "append_revisions_only = True\n"
2042
# Avoid writing anything if append_revisions_only is disabled,
2043
# as that is the default.
2046
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
2048
"""Initialize a branch in a control dir, with specified files
2050
:param a_bzrdir: The bzrdir to initialize the branch in
2051
:param utf8_files: The files to create as a list of
2052
(filename, content) tuples
2053
:param name: Name of colocated branch to create, if any
2054
:return: a branch in this format
2057
name = a_bzrdir._get_selected_branch()
2058
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2059
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2060
control_files = lockable_files.LockableFiles(branch_transport,
2061
'lock', lockdir.LockDir)
2062
control_files.create_lock()
2063
control_files.lock_write()
2065
utf8_files += [('format', self.as_string())]
2066
for (filename, content) in utf8_files:
2067
branch_transport.put_bytes(
2069
mode=a_bzrdir._get_file_mode())
2071
control_files.unlock()
2072
branch = self.open(a_bzrdir, name, _found=True,
2073
found_repository=repository)
2074
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2077
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2078
found_repository=None, possible_transports=None):
2079
"""See BranchFormat.open()."""
2081
name = a_bzrdir._get_selected_branch()
1050
# we are being called directly and must probe.
1051
raise NotImplementedError
1052
return BzrBranch(_format=self,
1053
_control_files=a_bzrdir._control_files,
1055
_repository=a_bzrdir.open_repository())
1058
return "Bazaar-NG branch format 4"
1061
class BzrBranchFormat5(BranchFormat):
2083
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2084
if format.__class__ != self.__class__:
2085
raise AssertionError("wrong format %r found for %r" %
2087
transport = a_bzrdir.get_branch_transport(None, name=name)
2089
control_files = lockable_files.LockableFiles(transport, 'lock',
2091
if found_repository is None:
2092
found_repository = a_bzrdir.find_repository()
2093
return self._branch_class()(_format=self,
2094
_control_files=control_files,
2097
_repository=found_repository,
2098
ignore_fallbacks=ignore_fallbacks,
2099
possible_transports=possible_transports)
2100
except errors.NoSuchFile:
2101
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2104
def _matchingbzrdir(self):
2105
ret = bzrdir.BzrDirMetaFormat1()
2106
ret.set_branch_format(self)
2109
def supports_tags(self):
2112
def supports_leaving_lock(self):
2115
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
2117
BranchFormat.check_support_status(self,
2118
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
2120
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
2121
recommend_upgrade=recommend_upgrade, basedir=basedir)
2124
class BzrBranchFormat5(BranchFormatMetadir):
1062
2125
"""Bzr branch format 5.
1064
2127
This format has:
1130
2183
"""See BranchFormat.get_format_description()."""
1131
2184
return "Branch format 6"
1133
def initialize(self, a_bzrdir):
1134
"""Create a branch of this format in a_bzrdir."""
1135
utf8_files = [('last-revision', '0 null:\n'),
1136
('branch-name', ''),
1137
('branch.conf', ''),
1140
return self._initialize_helper(a_bzrdir, utf8_files)
1142
def open(self, a_bzrdir, _found=False):
1143
"""Return the branch object for a_bzrdir
1145
_found is a private parameter, do not use it. It is used to indicate
1146
if format probing has already be done.
1149
format = BranchFormat.find_format(a_bzrdir)
1150
assert format.__class__ == self.__class__
1151
transport = a_bzrdir.get_branch_transport(None)
1152
control_files = lockable_files.LockableFiles(transport, 'lock',
1154
return BzrBranch6(_format=self,
1155
_control_files=control_files,
1157
_repository=a_bzrdir.find_repository())
1159
def supports_tags(self):
1163
class BranchReferenceFormat(BranchFormat):
2186
def initialize(self, a_bzrdir, name=None, repository=None,
2187
append_revisions_only=None):
2188
"""Create a branch of this format in a_bzrdir."""
2189
utf8_files = [('last-revision', '0 null:\n'),
2191
self._get_initial_config(append_revisions_only)),
2194
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2196
def make_tags(self, branch):
2197
"""See bzrlib.branch.BranchFormat.make_tags()."""
2198
return _mod_tag.BasicTags(branch)
2200
def supports_set_append_revisions_only(self):
2204
class BzrBranchFormat8(BranchFormatMetadir):
2205
"""Metadir format supporting storing locations of subtree branches."""
2207
def _branch_class(self):
2211
def get_format_string(cls):
2212
"""See BranchFormat.get_format_string()."""
2213
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2215
def get_format_description(self):
2216
"""See BranchFormat.get_format_description()."""
2217
return "Branch format 8"
2219
def initialize(self, a_bzrdir, name=None, repository=None,
2220
append_revisions_only=None):
2221
"""Create a branch of this format in a_bzrdir."""
2222
utf8_files = [('last-revision', '0 null:\n'),
2224
self._get_initial_config(append_revisions_only)),
2228
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2230
def make_tags(self, branch):
2231
"""See bzrlib.branch.BranchFormat.make_tags()."""
2232
return _mod_tag.BasicTags(branch)
2234
def supports_set_append_revisions_only(self):
2237
def supports_stacking(self):
2240
supports_reference_locations = True
2243
class BzrBranchFormat7(BranchFormatMetadir):
2244
"""Branch format with last-revision, tags, and a stacked location pointer.
2246
The stacked location pointer is passed down to the repository and requires
2247
a repository format with supports_external_lookups = True.
2249
This format was introduced in bzr 1.6.
2252
def initialize(self, a_bzrdir, name=None, repository=None,
2253
append_revisions_only=None):
2254
"""Create a branch of this format in a_bzrdir."""
2255
utf8_files = [('last-revision', '0 null:\n'),
2257
self._get_initial_config(append_revisions_only)),
2260
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2262
def _branch_class(self):
2266
def get_format_string(cls):
2267
"""See BranchFormat.get_format_string()."""
2268
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2270
def get_format_description(self):
2271
"""See BranchFormat.get_format_description()."""
2272
return "Branch format 7"
2274
def supports_set_append_revisions_only(self):
2277
def supports_stacking(self):
2280
def make_tags(self, branch):
2281
"""See bzrlib.branch.BranchFormat.make_tags()."""
2282
return _mod_tag.BasicTags(branch)
2284
supports_reference_locations = False
2287
class BranchReferenceFormat(BranchFormatMetadir):
1164
2288
"""Bzr branch reference format.
1166
2290
Branch references are used in implementing checkouts, they
1171
2295
- a format string
1174
def get_format_string(self):
2299
def get_format_string(cls):
1175
2300
"""See BranchFormat.get_format_string()."""
1176
2301
return "Bazaar-NG Branch Reference Format 1\n"
1178
2303
def get_format_description(self):
1179
2304
"""See BranchFormat.get_format_description()."""
1180
2305
return "Checkout reference format 1"
1182
def get_reference(self, a_bzrdir):
2307
def get_reference(self, a_bzrdir, name=None):
1183
2308
"""See BranchFormat.get_reference()."""
1184
transport = a_bzrdir.get_branch_transport(None)
1185
return transport.get('location').read()
1187
def initialize(self, a_bzrdir, target_branch=None):
2309
transport = a_bzrdir.get_branch_transport(None, name=name)
2310
return transport.get_bytes('location')
2312
def set_reference(self, a_bzrdir, name, to_branch):
2313
"""See BranchFormat.set_reference()."""
2314
transport = a_bzrdir.get_branch_transport(None, name=name)
2315
location = transport.put_bytes('location', to_branch.base)
2317
def initialize(self, a_bzrdir, name=None, target_branch=None,
2318
repository=None, append_revisions_only=None):
1188
2319
"""Create a branch of this format in a_bzrdir."""
1189
2320
if target_branch is None:
1190
2321
# this format does not implement branch itself, thus the implicit
1191
2322
# creation contract must see it as uninitializable
1192
2323
raise errors.UninitializableFormat(self)
1193
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1194
branch_transport = a_bzrdir.get_branch_transport(self)
2324
mutter('creating branch reference in %s', a_bzrdir.user_url)
2325
if a_bzrdir._format.fixed_components:
2326
raise errors.IncompatibleFormat(self, a_bzrdir._format)
2328
name = a_bzrdir._get_selected_branch()
2329
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1195
2330
branch_transport.put_bytes('location',
1196
target_branch.bzrdir.root_transport.base)
1197
branch_transport.put_bytes('format', self.get_format_string())
1198
return self.open(a_bzrdir, _found=True)
1201
super(BranchReferenceFormat, self).__init__()
1202
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2331
target_branch.user_url)
2332
branch_transport.put_bytes('format', self.as_string())
2333
branch = self.open(a_bzrdir, name, _found=True,
2334
possible_transports=[target_branch.bzrdir.root_transport])
2335
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1204
2338
def _make_reference_clone_function(format, a_branch):
1205
2339
"""Create a clone() routine for a branch dynamically."""
1206
def clone(to_bzrdir, revision_id=None):
2340
def clone(to_bzrdir, revision_id=None,
2341
repository_policy=None):
1207
2342
"""See Branch.clone()."""
1208
return format.initialize(to_bzrdir, a_branch)
2343
return format.initialize(to_bzrdir, target_branch=a_branch)
1209
2344
# cannot obey revision_id limits when cloning a reference ...
1210
2345
# FIXME RBC 20060210 either nuke revision_id for clone, or
1211
2346
# emit some sort of warning/error to the caller ?!
1214
def open(self, a_bzrdir, _found=False, location=None):
2349
def open(self, a_bzrdir, name=None, _found=False, location=None,
2350
possible_transports=None, ignore_fallbacks=False,
2351
found_repository=None):
1215
2352
"""Return the branch that the branch reference in a_bzrdir points at.
1217
_found is a private parameter, do not use it. It is used to indicate
1218
if format probing has already be done.
2354
:param a_bzrdir: A BzrDir that contains a branch.
2355
:param name: Name of colocated branch to open, if any
2356
:param _found: a private parameter, do not use it. It is used to
2357
indicate if format probing has already be done.
2358
:param ignore_fallbacks: when set, no fallback branches will be opened
2359
(if there are any). Default is to open fallbacks.
2360
:param location: The location of the referenced branch. If
2361
unspecified, this will be determined from the branch reference in
2363
:param possible_transports: An optional reusable transports list.
2366
name = a_bzrdir._get_selected_branch()
1221
format = BranchFormat.find_format(a_bzrdir)
1222
assert format.__class__ == self.__class__
2368
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2369
if format.__class__ != self.__class__:
2370
raise AssertionError("wrong format %r found for %r" %
1223
2372
if location is None:
1224
location = self.get_reference(a_bzrdir)
1225
real_bzrdir = bzrdir.BzrDir.open(location)
1226
result = real_bzrdir.open_branch()
2373
location = self.get_reference(a_bzrdir, name)
2374
real_bzrdir = controldir.ControlDir.open(
2375
location, possible_transports=possible_transports)
2376
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks,
2377
possible_transports=possible_transports)
1227
2378
# this changes the behaviour of result.clone to create a new reference
1228
2379
# rather than a copy of the content of the branch.
1229
2380
# I did not use a proxy object because that needs much more extensive
2390
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2391
"""Branch format registry."""
2393
def __init__(self, other_registry=None):
2394
super(BranchFormatRegistry, self).__init__(other_registry)
2395
self._default_format = None
2397
def set_default(self, format):
2398
self._default_format = format
2400
def get_default(self):
2401
return self._default_format
2404
network_format_registry = registry.FormatRegistry()
2405
"""Registry of formats indexed by their network name.
2407
The network name for a branch format is an identifier that can be used when
2408
referring to formats with smart server operations. See
2409
BranchFormat.network_name() for more detail.
2412
format_registry = BranchFormatRegistry(network_format_registry)
1239
2415
# formats which have no format string are not discoverable
1240
2416
# and not independently creatable, so are not registered.
1241
2417
__format5 = BzrBranchFormat5()
1242
2418
__format6 = BzrBranchFormat6()
1243
BranchFormat.register_format(__format5)
1244
BranchFormat.register_format(BranchReferenceFormat())
1245
BranchFormat.register_format(__format6)
1246
BranchFormat.set_default_format(__format6)
1247
_legacy_formats = [BzrBranchFormat4(),
1250
class BzrBranch(Branch):
2419
__format7 = BzrBranchFormat7()
2420
__format8 = BzrBranchFormat8()
2421
format_registry.register(__format5)
2422
format_registry.register(BranchReferenceFormat())
2423
format_registry.register(__format6)
2424
format_registry.register(__format7)
2425
format_registry.register(__format8)
2426
format_registry.set_default(__format7)
2429
class BranchWriteLockResult(LogicalLockResult):
2430
"""The result of write locking a branch.
2432
:ivar branch_token: The token obtained from the underlying branch lock, or
2434
:ivar unlock: A callable which will unlock the lock.
2437
def __init__(self, unlock, branch_token):
2438
LogicalLockResult.__init__(self, unlock)
2439
self.branch_token = branch_token
2442
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2446
class BzrBranch(Branch, _RelockDebugMixin):
1251
2447
"""A branch stored in the actual filesystem.
1253
2449
Note that it's "local" in the context of the filesystem; it doesn't
1254
2450
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1255
2451
it's writable, and can be accessed via the normal filesystem API.
2453
:ivar _transport: Transport for file operations on this branch's
2454
control files, typically pointing to the .bzr/branch directory.
2455
:ivar repository: Repository for this branch.
2456
:ivar base: The url of the base directory for this branch; the one
2457
containing the .bzr directory.
2458
:ivar name: Optional colocated branch name as it exists in the control
1258
2462
def __init__(self, _format=None,
1259
_control_files=None, a_bzrdir=None, _repository=None):
2463
_control_files=None, a_bzrdir=None, name=None,
2464
_repository=None, ignore_fallbacks=False,
2465
possible_transports=None):
1260
2466
"""Create new branch object at a particular location."""
1261
Branch.__init__(self)
1262
2467
if a_bzrdir is None:
1263
2468
raise ValueError('a_bzrdir must be supplied')
1265
self.bzrdir = a_bzrdir
1266
# self._transport used to point to the directory containing the
1267
# control directory, but was not used - now it's just the transport
1268
# for the branch control files. mbp 20070212
1269
self._base = self.bzrdir.transport.clone('..').base
2470
raise ValueError('name must be supplied')
2471
self.bzrdir = a_bzrdir
2472
self._user_transport = self.bzrdir.transport.clone('..')
2474
self._user_transport.set_segment_parameter(
2475
"branch", urlutils.escape(name))
2476
self._base = self._user_transport.base
1270
2478
self._format = _format
1271
2479
if _control_files is None:
1272
2480
raise ValueError('BzrBranch _control_files is None')
1273
2481
self.control_files = _control_files
1274
2482
self._transport = _control_files._transport
1275
2483
self.repository = _repository
2484
self.conf_store = None
2485
Branch.__init__(self, possible_transports)
1277
2487
def __str__(self):
1278
return '%s(%r)' % (self.__class__.__name__, self.base)
2488
return '%s(%s)' % (self.__class__.__name__, self.user_url)
1280
2490
__repr__ = __str__
1341
2588
"""See Branch.print_file."""
1342
2589
return self.repository.print_file(file, revision_id)
1344
def _write_revision_history(self, history):
1345
"""Factored out of set_revision_history.
1347
This performs the actual writing to disk.
1348
It is intended to be called by BzrBranch5.set_revision_history."""
1349
self.control_files.put_bytes(
1350
'revision-history', '\n'.join(history))
1352
2591
@needs_write_lock
1353
def set_revision_history(self, rev_history):
1354
"""See Branch.set_revision_history."""
1355
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
2592
def set_last_revision_info(self, revno, revision_id):
2593
if not revision_id or not isinstance(revision_id, basestring):
2594
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2595
revision_id = _mod_revision.ensure_null(revision_id)
2596
old_revno, old_revid = self.last_revision_info()
2597
if self.get_append_revisions_only():
2598
self._check_history_violation(revision_id)
2599
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2600
self._write_last_revision_info(revno, revision_id)
1356
2601
self._clear_cached_state()
1357
self._write_revision_history(rev_history)
1358
self._cache_revision_history(rev_history)
1359
for hook in Branch.hooks['set_rh']:
1360
hook(self, rev_history)
1363
def set_last_revision_info(self, revno, revision_id):
1364
"""Set the last revision of this branch.
1366
The caller is responsible for checking that the revno is correct
1367
for this revision id.
1369
It may be possible to set the branch last revision to an id not
1370
present in the repository. However, branches can also be
1371
configured to check constraints on history, in which case this may not
1374
revision_id = osutils.safe_revision_id(revision_id)
1375
history = self._lefthand_history(revision_id)
1376
assert len(history) == revno, '%d != %d' % (len(history), revno)
1377
self.set_revision_history(history)
1379
def _gen_revision_history(self):
1380
history = self.control_files.get('revision-history').read().split('\n')
1381
if history[-1:] == ['']:
1382
# There shouldn't be a trailing newline, but just in case.
1386
def _lefthand_history(self, revision_id, last_rev=None,
1388
# stop_revision must be a descendant of last_revision
1389
stop_graph = self.repository.get_revision_graph(revision_id)
1390
if (last_rev is not None and last_rev != _mod_revision.NULL_REVISION
1391
and last_rev not in stop_graph):
1392
# our previous tip is not merged into stop_revision
1393
raise errors.DivergedBranches(self, other_branch)
1394
# make a new revision history from the graph
1395
current_rev_id = revision_id
1397
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1398
new_history.append(current_rev_id)
1399
current_rev_id_parents = stop_graph[current_rev_id]
1401
current_rev_id = current_rev_id_parents[0]
1403
current_rev_id = None
1404
new_history.reverse()
1408
def generate_revision_history(self, revision_id, last_rev=None,
1410
"""Create a new revision history that will finish with revision_id.
1412
:param revision_id: the new tip to use.
1413
:param last_rev: The previous last_revision. If not None, then this
1414
must be a ancestory of revision_id, or DivergedBranches is raised.
1415
:param other_branch: The other branch that DivergedBranches should
1416
raise with respect to.
1418
revision_id = osutils.safe_revision_id(revision_id)
1419
self.set_revision_history(self._lefthand_history(revision_id,
1420
last_rev, other_branch))
1423
def update_revisions(self, other, stop_revision=None):
1424
"""See Branch.update_revisions."""
1427
if stop_revision is None:
1428
stop_revision = other.last_revision()
1429
if stop_revision is None:
1430
# if there are no commits, we're done.
1433
stop_revision = osutils.safe_revision_id(stop_revision)
1434
# whats the current last revision, before we fetch [and change it
1436
last_rev = _mod_revision.ensure_null(self.last_revision())
1437
# we fetch here regardless of whether we need to so that we pickup
1439
self.fetch(other, stop_revision)
1440
if self.repository.get_graph().is_ancestor(stop_revision,
1443
self.generate_revision_history(stop_revision, last_rev=last_rev,
2602
self._last_revision_info_cache = revno, revision_id
2603
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1448
2605
def basis_tree(self):
1449
2606
"""See Branch.basis_tree."""
1450
2607
return self.repository.revision_tree(self.last_revision())
1453
def pull(self, source, overwrite=False, stop_revision=None,
1454
_hook_master=None, run_hooks=True):
1457
:param _hook_master: Private parameter - set the branch to
1458
be supplied as the master to push hooks.
1459
:param run_hooks: Private parameter - if false, this branch
1460
is being called because it's the master of the primary branch,
1461
so it should not run its hooks.
1463
result = PullResult()
1464
result.source_branch = source
1465
result.target_branch = self
1468
result.old_revno, result.old_revid = self.last_revision_info()
1470
self.update_revisions(source, stop_revision)
1471
except DivergedBranches:
1475
if stop_revision is None:
1476
stop_revision = source.last_revision()
1477
self.generate_revision_history(stop_revision)
1478
result.tag_conflicts = source.tags.merge_to(self.tags)
1479
result.new_revno, result.new_revid = self.last_revision_info()
1481
result.master_branch = _hook_master
1482
result.local_branch = self
1484
result.master_branch = self
1485
result.local_branch = None
1487
for hook in Branch.hooks['post_pull']:
1493
2609
def _get_parent_location(self):
1494
2610
_locs = ['parent', 'pull', 'x-pull']
1495
2611
for l in _locs:
1497
return self.control_files.get(l).read().strip('\n')
2613
return self._transport.get_bytes(l).strip('\n')
2614
except errors.NoSuchFile:
1503
def push(self, target, overwrite=False, stop_revision=None,
1504
_override_hook_source_branch=None):
1507
This is the basic concrete implementation of push()
1509
:param _override_hook_source_branch: If specified, run
1510
the hooks passing this Branch as the source, rather than self.
1511
This is for use of RemoteBranch, where push is delegated to the
1512
underlying vfs-based Branch.
1514
# TODO: Public option to disable running hooks - should be trivial but
1518
result = self._push_with_bound_branches(target, overwrite,
1520
_override_hook_source_branch=_override_hook_source_branch)
1525
def _push_with_bound_branches(self, target, overwrite,
1527
_override_hook_source_branch=None):
1528
"""Push from self into target, and into target's master if any.
1530
This is on the base BzrBranch class even though it doesn't support
1531
bound branches because the *target* might be bound.
1534
if _override_hook_source_branch:
1535
result.source_branch = _override_hook_source_branch
1536
for hook in Branch.hooks['post_push']:
1539
bound_location = target.get_bound_location()
1540
if bound_location and target.base != bound_location:
1541
# there is a master branch.
1543
# XXX: Why the second check? Is it even supported for a branch to
1544
# be bound to itself? -- mbp 20070507
1545
master_branch = target.get_master_branch()
1546
master_branch.lock_write()
1548
# push into the master from this branch.
1549
self._basic_push(master_branch, overwrite, stop_revision)
1550
# and push into the target branch from this. Note that we push from
1551
# this branch again, because its considered the highest bandwidth
1553
result = self._basic_push(target, overwrite, stop_revision)
1554
result.master_branch = master_branch
1555
result.local_branch = target
1559
master_branch.unlock()
1562
result = self._basic_push(target, overwrite, stop_revision)
1563
# TODO: Why set master_branch and local_branch if there's no
1564
# binding? Maybe cleaner to just leave them unset? -- mbp
1566
result.master_branch = target
1567
result.local_branch = None
1571
def _basic_push(self, target, overwrite, stop_revision):
1572
"""Basic implementation of push without bound branches or hooks.
1574
Must be called with self read locked and target write locked.
1576
result = PushResult()
1577
result.source_branch = self
1578
result.target_branch = target
1579
result.old_revno, result.old_revid = target.last_revision_info()
1581
target.update_revisions(self, stop_revision)
1582
except DivergedBranches:
1586
target.set_revision_history(self.revision_history())
1587
result.tag_conflicts = self.tags.merge_to(target.tags)
1588
result.new_revno, result.new_revid = target.last_revision_info()
1591
def get_parent(self):
1592
"""See Branch.get_parent."""
1594
assert self.base[-1] == '/'
1595
parent = self._get_parent_location()
1598
# This is an old-format absolute path to a local branch
1599
# turn it into a url
1600
if parent.startswith('/'):
1601
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1603
return urlutils.join(self.base[:-1], parent)
1604
except errors.InvalidURLJoin, e:
1605
raise errors.InaccessibleParent(parent, self.base)
2618
def get_stacked_on_url(self):
2619
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1607
2621
def set_push_location(self, location):
1608
2622
"""See Branch.set_push_location."""
1610
2624
'push_location', location,
1611
2625
store=_mod_config.STORE_LOCATION_NORECURSE)
1614
def set_parent(self, url):
1615
"""See Branch.set_parent."""
1616
# TODO: Maybe delete old location files?
1617
# URLs should never be unicode, even on the local fs,
1618
# FIXUP this and get_parent in a future branch format bump:
1619
# read and rewrite the file, and have the new format code read
1620
# using .get not .get_utf8. RBC 20060125
1622
if isinstance(url, unicode):
1624
url = url.encode('ascii')
1625
except UnicodeEncodeError:
1626
raise errors.InvalidURL(url,
1627
"Urls must be 7-bit ascii, "
1628
"use bzrlib.urlutils.escape")
1629
url = urlutils.relative_url(self.base, url)
1630
self._set_parent_location(url)
1632
2627
def _set_parent_location(self, url):
1633
2628
if url is None:
1634
self.control_files._transport.delete('parent')
1636
assert isinstance(url, str)
1637
self.control_files.put_bytes('parent', url + '\n')
1640
class BzrBranch5(BzrBranch):
1641
"""A format 5 branch. This supports new features over plan branches.
1643
It has support for a master_branch which is the data for bound branches.
1651
super(BzrBranch5, self).__init__(_format=_format,
1652
_control_files=_control_files,
1654
_repository=_repository)
1657
def pull(self, source, overwrite=False, stop_revision=None,
1659
"""Pull from source into self, updating my master if any.
1661
:param run_hooks: Private parameter - if false, this branch
1662
is being called because it's the master of the primary branch,
1663
so it should not run its hooks.
1665
bound_location = self.get_bound_location()
1666
master_branch = None
1667
if bound_location and source.base != bound_location:
1668
# not pulling from master, so we need to update master.
1669
master_branch = self.get_master_branch()
1670
master_branch.lock_write()
1673
# pull from source into master.
1674
master_branch.pull(source, overwrite, stop_revision,
1676
return super(BzrBranch5, self).pull(source, overwrite,
1677
stop_revision, _hook_master=master_branch,
1678
run_hooks=run_hooks)
1681
master_branch.unlock()
1683
def get_bound_location(self):
1685
return self.control_files.get_utf8('bound').read()[:-1]
1686
except errors.NoSuchFile:
1690
def get_master_branch(self):
1691
"""Return the branch we are bound to.
1693
:return: Either a Branch, or None
1695
This could memoise the branch, but if thats done
1696
it must be revalidated on each new lock.
1697
So for now we just don't memoise it.
1698
# RBC 20060304 review this decision.
1700
bound_loc = self.get_bound_location()
1704
return Branch.open(bound_loc)
1705
except (errors.NotBranchError, errors.ConnectionError), e:
1706
raise errors.BoundBranchConnectionFailure(
1710
def set_bound_location(self, location):
1711
"""Set the target where this branch is bound to.
1713
:param location: URL to the target branch
1716
self.control_files.put_utf8('bound', location+'\n')
1719
self.control_files._transport.delete('bound')
2629
self._transport.delete('parent')
2631
self._transport.put_bytes('parent', url + '\n',
2632
mode=self.bzrdir._get_file_mode())
2636
"""If bound, unbind"""
2637
return self.set_bound_location(None)
1724
2639
@needs_write_lock
1725
2640
def bind(self, other):
1789
class BzrBranchExperimental(BzrBranch5):
1790
"""Bzr experimental branch format
1793
- a revision-history file.
1795
- a lock dir guarding the branch itself
1796
- all of this stored in a branch/ subdirectory
1797
- works with shared repositories.
1798
- a tag dictionary in the branch
1800
This format is new in bzr 0.15, but shouldn't be used for real data,
1803
This class acts as it's own BranchFormat.
1806
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1809
def get_format_string(cls):
1810
"""See BranchFormat.get_format_string()."""
1811
return "Bazaar-NG branch format experimental\n"
1814
def get_format_description(cls):
1815
"""See BranchFormat.get_format_description()."""
1816
return "Experimental branch format"
1819
def get_reference(cls, a_bzrdir):
1820
"""Get the target reference of the branch in a_bzrdir.
1822
format probing must have been completed before calling
1823
this method - it is assumed that the format of the branch
1824
in a_bzrdir is correct.
1826
:param a_bzrdir: The bzrdir to get the branch data from.
1827
:return: None if the branch is not a reference branch.
1832
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1834
branch_transport = a_bzrdir.get_branch_transport(cls)
1835
control_files = lockable_files.LockableFiles(branch_transport,
1836
lock_filename, lock_class)
1837
control_files.create_lock()
1838
control_files.lock_write()
1840
for filename, content in utf8_files:
1841
control_files.put_utf8(filename, content)
1843
control_files.unlock()
1846
def initialize(cls, a_bzrdir):
1847
"""Create a branch of this format in a_bzrdir."""
1848
utf8_files = [('format', cls.get_format_string()),
1849
('revision-history', ''),
1850
('branch-name', ''),
1853
cls._initialize_control_files(a_bzrdir, utf8_files,
1854
'lock', lockdir.LockDir)
1855
return cls.open(a_bzrdir, _found=True)
1858
def open(cls, a_bzrdir, _found=False):
1859
"""Return the branch object for a_bzrdir
1861
_found is a private parameter, do not use it. It is used to indicate
1862
if format probing has already be done.
1865
format = BranchFormat.find_format(a_bzrdir)
1866
assert format.__class__ == cls
1867
transport = a_bzrdir.get_branch_transport(None)
1868
control_files = lockable_files.LockableFiles(transport, 'lock',
1870
return cls(_format=cls,
1871
_control_files=control_files,
1873
_repository=a_bzrdir.find_repository())
1876
def is_supported(cls):
1879
def _make_tags(self):
1880
return BasicTags(self)
1883
def supports_tags(cls):
1887
BranchFormat.register_format(BzrBranchExperimental)
1890
class BzrBranch6(BzrBranch5):
1893
def last_revision_info(self):
1894
revision_string = self.control_files.get('last-revision').read()
2727
def _read_last_revision_info(self):
2728
revision_string = self._transport.get_bytes('last-revision')
1895
2729
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1896
2730
revision_id = cache_utf8.get_cached_utf8(revision_id)
1897
2731
revno = int(revno)
1898
2732
return revno, revision_id
1900
def last_revision(self):
1901
"""Return last revision id, or None"""
1902
revision_id = self.last_revision_info()[1]
1905
2734
def _write_last_revision_info(self, revno, revision_id):
1906
2735
"""Simply write out the revision id, with no checks.
1908
2737
Use set_last_revision_info to perform this safely.
1910
2739
Does not update the revision_history cache.
1911
Intended to be called by set_last_revision_info and
1912
_write_revision_history.
1914
if revision_id is None:
1915
revision_id = 'null:'
2741
revision_id = _mod_revision.ensure_null(revision_id)
1916
2742
out_string = '%d %s\n' % (revno, revision_id)
1917
self.control_files.put_bytes('last-revision', out_string)
2743
self._transport.put_bytes('last-revision', out_string,
2744
mode=self.bzrdir._get_file_mode())
2747
def update_feature_flags(self, updated_flags):
2748
"""Update the feature flags for this branch.
2750
:param updated_flags: Dictionary mapping feature names to necessities
2751
A necessity can be None to indicate the feature should be removed
2753
self._format._update_feature_flags(updated_flags)
2754
self.control_transport.put_bytes('format', self._format.as_string())
2757
class FullHistoryBzrBranch(BzrBranch):
2758
"""Bzr branch which contains the full revision history."""
1919
2760
@needs_write_lock
1920
2761
def set_last_revision_info(self, revno, revision_id):
1921
revision_id = osutils.safe_revision_id(revision_id)
1922
if self._get_append_revisions_only():
1923
self._check_history_violation(revision_id)
1924
self._write_last_revision_info(revno, revision_id)
2762
if not revision_id or not isinstance(revision_id, basestring):
2763
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2764
revision_id = _mod_revision.ensure_null(revision_id)
2765
# this old format stores the full history, but this api doesn't
2766
# provide it, so we must generate, and might as well check it's
2768
history = self._lefthand_history(revision_id)
2769
if len(history) != revno:
2770
raise AssertionError('%d != %d' % (len(history), revno))
2771
self._set_revision_history(history)
2773
def _read_last_revision_info(self):
2774
rh = self._revision_history()
2777
return (revno, rh[-1])
2779
return (0, _mod_revision.NULL_REVISION)
2781
@deprecated_method(deprecated_in((2, 4, 0)))
2783
def set_revision_history(self, rev_history):
2784
"""See Branch.set_revision_history."""
2785
self._set_revision_history(rev_history)
2787
def _set_revision_history(self, rev_history):
2788
if 'evil' in debug.debug_flags:
2789
mutter_callsite(3, "set_revision_history scales with history.")
2790
check_not_reserved_id = _mod_revision.check_not_reserved_id
2791
for rev_id in rev_history:
2792
check_not_reserved_id(rev_id)
2793
if Branch.hooks['post_change_branch_tip']:
2794
# Don't calculate the last_revision_info() if there are no hooks
2796
old_revno, old_revid = self.last_revision_info()
2797
if len(rev_history) == 0:
2798
revid = _mod_revision.NULL_REVISION
2800
revid = rev_history[-1]
2801
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2802
self._write_revision_history(rev_history)
1925
2803
self._clear_cached_state()
2804
self._cache_revision_history(rev_history)
2805
for hook in Branch.hooks['set_rh']:
2806
hook(self, rev_history)
2807
if Branch.hooks['post_change_branch_tip']:
2808
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2810
def _write_revision_history(self, history):
2811
"""Factored out of set_revision_history.
2813
This performs the actual writing to disk.
2814
It is intended to be called by set_revision_history."""
2815
self._transport.put_bytes(
2816
'revision-history', '\n'.join(history),
2817
mode=self.bzrdir._get_file_mode())
2819
def _gen_revision_history(self):
2820
history = self._transport.get_bytes('revision-history').split('\n')
2821
if history[-1:] == ['']:
2822
# There shouldn't be a trailing newline, but just in case.
2826
def _synchronize_history(self, destination, revision_id):
2827
if not isinstance(destination, FullHistoryBzrBranch):
2828
super(BzrBranch, self)._synchronize_history(
2829
destination, revision_id)
2831
if revision_id == _mod_revision.NULL_REVISION:
2834
new_history = self._revision_history()
2835
if revision_id is not None and new_history != []:
2837
new_history = new_history[:new_history.index(revision_id) + 1]
2839
rev = self.repository.get_revision(revision_id)
2840
new_history = rev.get_history(self.repository)[1:]
2841
destination._set_revision_history(new_history)
2844
def generate_revision_history(self, revision_id, last_rev=None,
2846
"""Create a new revision history that will finish with revision_id.
2848
:param revision_id: the new tip to use.
2849
:param last_rev: The previous last_revision. If not None, then this
2850
must be a ancestory of revision_id, or DivergedBranches is raised.
2851
:param other_branch: The other branch that DivergedBranches should
2852
raise with respect to.
2854
self._set_revision_history(self._lefthand_history(revision_id,
2855
last_rev, other_branch))
2858
class BzrBranch5(FullHistoryBzrBranch):
2859
"""A format 5 branch. This supports new features over plain branches.
2861
It has support for a master_branch which is the data for bound branches.
2865
class BzrBranch8(BzrBranch):
2866
"""A branch that stores tree-reference locations."""
2868
def _open_hook(self, possible_transports=None):
2869
if self._ignore_fallbacks:
2871
if possible_transports is None:
2872
possible_transports = [self.bzrdir.root_transport]
2874
url = self.get_stacked_on_url()
2875
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2876
errors.UnstackableBranchFormat):
2879
for hook in Branch.hooks['transform_fallback_location']:
2880
url = hook(self, url)
2882
hook_name = Branch.hooks.get_hook_name(hook)
2883
raise AssertionError(
2884
"'transform_fallback_location' hook %s returned "
2885
"None, not a URL." % hook_name)
2886
self._activate_fallback_location(url,
2887
possible_transports=possible_transports)
2889
def __init__(self, *args, **kwargs):
2890
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2891
super(BzrBranch8, self).__init__(*args, **kwargs)
2892
self._last_revision_info_cache = None
2893
self._reference_info = None
2895
def _clear_cached_state(self):
2896
super(BzrBranch8, self)._clear_cached_state()
2897
self._last_revision_info_cache = None
2898
self._reference_info = None
1927
2900
def _check_history_violation(self, revision_id):
1928
last_revision = _mod_revision.ensure_null(self.last_revision())
2901
current_revid = self.last_revision()
2902
last_revision = _mod_revision.ensure_null(current_revid)
1929
2903
if _mod_revision.is_null(last_revision):
1931
if last_revision not in self._lefthand_history(revision_id):
1932
raise errors.AppendRevisionsOnlyViolation(self.base)
2905
graph = self.repository.get_graph()
2906
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2907
if lh_ancestor == current_revid:
2909
raise errors.AppendRevisionsOnlyViolation(self.user_url)
1934
2911
def _gen_revision_history(self):
1935
2912
"""Generate the revision history from last revision
1937
history = list(self.repository.iter_reverse_revision_history(
1938
self.last_revision()))
1942
def _write_revision_history(self, history):
1943
"""Factored out of set_revision_history.
1945
This performs the actual writing to disk, with format-specific checks.
1946
It is intended to be called by BzrBranch5.set_revision_history.
1948
if len(history) == 0:
1949
last_revision = 'null:'
1951
if history != self._lefthand_history(history[-1]):
1952
raise errors.NotLefthandHistory(history)
1953
last_revision = history[-1]
1954
if self._get_append_revisions_only():
1955
self._check_history_violation(last_revision)
1956
self._write_last_revision_info(len(history), last_revision)
2914
last_revno, last_revision = self.last_revision_info()
2915
self._extend_partial_history(stop_index=last_revno-1)
2916
return list(reversed(self._partial_revision_history_cache))
1958
2918
@needs_write_lock
1959
2919
def _set_parent_location(self, url):
1965
2925
"""Set the parent branch"""
1966
2926
return self._get_config_location('parent_location')
2929
def _set_all_reference_info(self, info_dict):
2930
"""Replace all reference info stored in a branch.
2932
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2935
writer = rio.RioWriter(s)
2936
for key, (tree_path, branch_location) in info_dict.iteritems():
2937
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2938
branch_location=branch_location)
2939
writer.write_stanza(stanza)
2940
self._transport.put_bytes('references', s.getvalue())
2941
self._reference_info = info_dict
2944
def _get_all_reference_info(self):
2945
"""Return all the reference info stored in a branch.
2947
:return: A dict of {file_id: (tree_path, branch_location)}
2949
if self._reference_info is not None:
2950
return self._reference_info
2951
rio_file = self._transport.get('references')
2953
stanzas = rio.read_stanzas(rio_file)
2954
info_dict = dict((s['file_id'], (s['tree_path'],
2955
s['branch_location'])) for s in stanzas)
2958
self._reference_info = info_dict
2961
def set_reference_info(self, file_id, tree_path, branch_location):
2962
"""Set the branch location to use for a tree reference.
2964
:param file_id: The file-id of the tree reference.
2965
:param tree_path: The path of the tree reference in the tree.
2966
:param branch_location: The location of the branch to retrieve tree
2969
info_dict = self._get_all_reference_info()
2970
info_dict[file_id] = (tree_path, branch_location)
2971
if None in (tree_path, branch_location):
2972
if tree_path is not None:
2973
raise ValueError('tree_path must be None when branch_location'
2975
if branch_location is not None:
2976
raise ValueError('branch_location must be None when tree_path'
2978
del info_dict[file_id]
2979
self._set_all_reference_info(info_dict)
2981
def get_reference_info(self, file_id):
2982
"""Get the tree_path and branch_location for a tree reference.
2984
:return: a tuple of (tree_path, branch_location)
2986
return self._get_all_reference_info().get(file_id, (None, None))
2988
def reference_parent(self, file_id, path, possible_transports=None):
2989
"""Return the parent branch for a tree-reference file_id.
2991
:param file_id: The file_id of the tree reference
2992
:param path: The path of the file_id in the tree
2993
:return: A branch associated with the file_id
2995
branch_location = self.get_reference_info(file_id)[1]
2996
if branch_location is None:
2997
return Branch.reference_parent(self, file_id, path,
2998
possible_transports)
2999
branch_location = urlutils.join(self.user_url, branch_location)
3000
return Branch.open(branch_location,
3001
possible_transports=possible_transports)
1968
3003
def set_push_location(self, location):
1969
3004
"""See Branch.set_push_location."""
1970
3005
self._set_config_location('push_location', location)
1972
3007
def set_bound_location(self, location):
1973
3008
"""See Branch.set_push_location."""
3009
self._master_branch_cache = None
1975
config = self.get_config()
3011
conf = self.get_config_stack()
1976
3012
if location is None:
1977
if config.get_user_option('bound') != 'True':
3013
if not conf.get('bound'):
1980
config.set_user_option('bound', 'False', warn_masked=True)
3016
conf.set('bound', 'False')
1983
3019
self._set_config_location('bound_location', location,
1985
config.set_user_option('bound', 'True', warn_masked=True)
3021
conf.set('bound', 'True')
1988
3024
def _get_bound_location(self, bound):
1989
3025
"""Return the bound location in the config file.
1991
3027
Return None if the bound parameter does not match"""
1992
config = self.get_config()
1993
config_bound = (config.get_user_option('bound') == 'True')
1994
if config_bound != bound:
3028
conf = self.get_config_stack()
3029
if conf.get('bound') != bound:
1996
return self._get_config_location('bound_location', config=config)
3031
return self._get_config_location('bound_location', config=conf)
1998
3033
def get_bound_location(self):
1999
"""See Branch.set_push_location."""
3034
"""See Branch.get_bound_location."""
2000
3035
return self._get_bound_location(True)
2002
3037
def get_old_bound_location(self):
2003
3038
"""See Branch.get_old_bound_location"""
2004
3039
return self._get_bound_location(False)
2006
def set_append_revisions_only(self, enabled):
2011
self.get_config().set_user_option('append_revisions_only', value,
2014
def _get_append_revisions_only(self):
2015
value = self.get_config().get_user_option('append_revisions_only')
2016
return value == 'True'
2018
def _synchronize_history(self, destination, revision_id):
2019
"""Synchronize last revision and revision history between branches.
2021
This version is most efficient when the destination is also a
2022
BzrBranch6, but works for BzrBranch5, as long as the destination's
2023
repository contains all the lefthand ancestors of the intended
2024
last_revision. If not, set_last_revision_info will fail.
2026
:param destination: The branch to copy the history into
2027
:param revision_id: The revision-id to truncate history at. May
2028
be None to copy complete history.
2030
source_revno, source_revision_id = self.last_revision_info()
2031
if revision_id is None:
2032
revno, revision_id = source_revno, source_revision_id
2033
elif source_revision_id == revision_id:
2034
# we know the revno without needing to walk all of history
2035
revno = source_revno
2037
# To figure out the revno for a random revision, we need to build
2038
# the revision history, and count its length.
2039
# We don't care about the order, just how long it is.
2040
# Alternatively, we could start at the current location, and count
2041
# backwards. But there is no guarantee that we will find it since
2042
# it may be a merged revision.
2043
revno = len(list(self.repository.iter_reverse_revision_history(
2045
destination.set_last_revision_info(revno, revision_id)
2047
def _make_tags(self):
2048
return BasicTags(self)
3041
def get_stacked_on_url(self):
3042
# you can always ask for the URL; but you might not be able to use it
3043
# if the repo can't support stacking.
3044
## self._check_stackable_repo()
3045
# stacked_on_location is only ever defined in branch.conf, so don't
3046
# waste effort reading the whole stack of config files.
3047
conf = _mod_config.BranchOnlyStack(self)
3048
stacked_url = self._get_config_location('stacked_on_location',
3050
if stacked_url is None:
3051
raise errors.NotStacked(self)
3052
return stacked_url.encode('utf-8')
3055
def get_rev_id(self, revno, history=None):
3056
"""Find the revision id of the specified revno."""
3058
return _mod_revision.NULL_REVISION
3060
last_revno, last_revision_id = self.last_revision_info()
3061
if revno <= 0 or revno > last_revno:
3062
raise errors.NoSuchRevision(self, revno)
3064
if history is not None:
3065
return history[revno - 1]
3067
index = last_revno - revno
3068
if len(self._partial_revision_history_cache) <= index:
3069
self._extend_partial_history(stop_index=index)
3070
if len(self._partial_revision_history_cache) > index:
3071
return self._partial_revision_history_cache[index]
3073
raise errors.NoSuchRevision(self, revno)
3076
def revision_id_to_revno(self, revision_id):
3077
"""Given a revision id, return its revno"""
3078
if _mod_revision.is_null(revision_id):
3081
index = self._partial_revision_history_cache.index(revision_id)
3084
self._extend_partial_history(stop_revision=revision_id)
3085
except errors.RevisionNotPresent, e:
3086
raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
3087
index = len(self._partial_revision_history_cache) - 1
3089
raise errors.NoSuchRevision(self, revision_id)
3090
if self._partial_revision_history_cache[index] != revision_id:
3091
raise errors.NoSuchRevision(self, revision_id)
3092
return self.revno() - index
3095
class BzrBranch7(BzrBranch8):
3096
"""A branch with support for a fallback repository."""
3098
def set_reference_info(self, file_id, tree_path, branch_location):
3099
Branch.set_reference_info(self, file_id, tree_path, branch_location)
3101
def get_reference_info(self, file_id):
3102
Branch.get_reference_info(self, file_id)
3104
def reference_parent(self, file_id, path, possible_transports=None):
3105
return Branch.reference_parent(self, file_id, path,
3106
possible_transports)
3109
class BzrBranch6(BzrBranch7):
3110
"""See BzrBranchFormat6 for the capabilities of this branch.
3112
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
3116
def get_stacked_on_url(self):
3117
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2051
3120
######################################################################
2069
3138
:ivar new_revno: Revision number after pull.
2070
3139
:ivar old_revid: Tip revision id before pull.
2071
3140
:ivar new_revid: Tip revision id after pull.
2072
:ivar source_branch: Source (local) branch object.
2073
:ivar master_branch: Master branch of the target, or None.
2074
:ivar target_branch: Target/destination branch object.
3141
:ivar source_branch: Source (local) branch object. (read locked)
3142
:ivar master_branch: Master branch of the target, or the target if no
3144
:ivar local_branch: target branch if there is a Master, else None
3145
:ivar target_branch: Target/destination branch object. (write locked)
3146
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3147
:ivar tag_updates: A dict with new tags, see BasicTags.merge_to
3150
@deprecated_method(deprecated_in((2, 3, 0)))
2077
3151
def __int__(self):
2078
# DEPRECATED: pull used to return the change in revno
3152
"""Return the relative change in revno.
3154
:deprecated: Use `new_revno` and `old_revno` instead.
2079
3156
return self.new_revno - self.old_revno
2081
3158
def report(self, to_file):
2082
if self.old_revid == self.new_revid:
2083
to_file.write('No revisions to pull.\n')
2085
to_file.write('Now on revision %d.\n' % self.new_revno)
3159
tag_conflicts = getattr(self, "tag_conflicts", None)
3160
tag_updates = getattr(self, "tag_updates", None)
3162
if self.old_revid != self.new_revid:
3163
to_file.write('Now on revision %d.\n' % self.new_revno)
3165
to_file.write('%d tag(s) updated.\n' % len(tag_updates))
3166
if self.old_revid == self.new_revid and not tag_updates:
3167
if not tag_conflicts:
3168
to_file.write('No revisions or tags to pull.\n')
3170
to_file.write('No revisions to pull.\n')
2086
3171
self._show_tag_conficts(to_file)
2089
class PushResult(_Result):
3174
class BranchPushResult(_Result):
2090
3175
"""Result of a Branch.push operation.
2092
:ivar old_revno: Revision number before push.
2093
:ivar new_revno: Revision number after push.
2094
:ivar old_revid: Tip revision id before push.
2095
:ivar new_revid: Tip revision id after push.
2096
:ivar source_branch: Source branch object.
2097
:ivar master_branch: Master branch of the target, or None.
2098
:ivar target_branch: Target/destination branch object.
3177
:ivar old_revno: Revision number (eg 10) of the target before push.
3178
:ivar new_revno: Revision number (eg 12) of the target after push.
3179
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3181
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3183
:ivar source_branch: Source branch object that the push was from. This is
3184
read locked, and generally is a local (and thus low latency) branch.
3185
:ivar master_branch: If target is a bound branch, the master branch of
3186
target, or target itself. Always write locked.
3187
:ivar target_branch: The direct Branch where data is being sent (write
3189
:ivar local_branch: If the target is a bound branch this will be the
3190
target, otherwise it will be None.
3193
@deprecated_method(deprecated_in((2, 3, 0)))
2101
3194
def __int__(self):
2102
# DEPRECATED: push used to return the change in revno
3195
"""Return the relative change in revno.
3197
:deprecated: Use `new_revno` and `old_revno` instead.
2103
3199
return self.new_revno - self.old_revno
2105
3201
def report(self, to_file):
2106
"""Write a human-readable description of the result."""
2107
if self.old_revid == self.new_revid:
2108
to_file.write('No new revisions to push.\n')
2110
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
3202
# TODO: This function gets passed a to_file, but then
3203
# ignores it and calls note() instead. This is also
3204
# inconsistent with PullResult(), which writes to stdout.
3205
# -- JRV20110901, bug #838853
3206
tag_conflicts = getattr(self, "tag_conflicts", None)
3207
tag_updates = getattr(self, "tag_updates", None)
3209
if self.old_revid != self.new_revid:
3210
note(gettext('Pushed up to revision %d.') % self.new_revno)
3212
note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
3213
if self.old_revid == self.new_revid and not tag_updates:
3214
if not tag_conflicts:
3215
note(gettext('No new revisions or tags to push.'))
3217
note(gettext('No new revisions to push.'))
2111
3218
self._show_tag_conficts(to_file)
2140
3249
new_branch = format.open(branch.bzrdir, _found=True)
2142
3251
# Copy source data into target
2143
new_branch.set_last_revision_info(*branch.last_revision_info())
2144
new_branch.set_parent(branch.get_parent())
2145
new_branch.set_bound_location(branch.get_bound_location())
2146
new_branch.set_push_location(branch.get_push_location())
3252
new_branch._write_last_revision_info(*branch.last_revision_info())
3253
new_branch.lock_write()
3255
new_branch.set_parent(branch.get_parent())
3256
new_branch.set_bound_location(branch.get_bound_location())
3257
new_branch.set_push_location(branch.get_push_location())
2148
3261
# New branch has no tags by default
2149
3262
new_branch.tags._set_tag_dict({})
2151
3264
# Copying done; now update target format
2152
new_branch.control_files.put_utf8('format',
2153
format.get_format_string())
3265
new_branch._transport.put_bytes('format',
3267
mode=new_branch.bzrdir._get_file_mode())
2155
3269
# Clean up old files
2156
new_branch.control_files._transport.delete('revision-history')
2158
branch.set_parent(None)
2161
branch.set_bound_location(None)
3270
new_branch._transport.delete('revision-history')
3274
branch.set_parent(None)
3275
except errors.NoSuchFile:
3277
branch.set_bound_location(None)
3282
class Converter6to7(object):
3283
"""Perform an in-place upgrade of format 6 to format 7"""
3285
def convert(self, branch):
3286
format = BzrBranchFormat7()
3287
branch._set_config_location('stacked_on_location', '')
3288
# update target format
3289
branch._transport.put_bytes('format', format.as_string())
3292
class Converter7to8(object):
3293
"""Perform an in-place upgrade of format 7 to format 8"""
3295
def convert(self, branch):
3296
format = BzrBranchFormat8()
3297
branch._transport.put_bytes('references', '')
3298
# update target format
3299
branch._transport.put_bytes('format', format.as_string())
3302
class InterBranch(InterObject):
3303
"""This class represents operations taking place between two branches.
3305
Its instances have methods like pull() and push() and contain
3306
references to the source and target repositories these operations
3307
can be carried out on.
3311
"""The available optimised InterBranch types."""
3314
def _get_branch_formats_to_test(klass):
3315
"""Return an iterable of format tuples for testing.
3317
:return: An iterable of (from_format, to_format) to use when testing
3318
this InterBranch class. Each InterBranch class should define this
3321
raise NotImplementedError(klass._get_branch_formats_to_test)
3324
def pull(self, overwrite=False, stop_revision=None,
3325
possible_transports=None, local=False):
3326
"""Mirror source into target branch.
3328
The target branch is considered to be 'local', having low latency.
3330
:returns: PullResult instance
3332
raise NotImplementedError(self.pull)
3335
def push(self, overwrite=False, stop_revision=None, lossy=False,
3336
_override_hook_source_branch=None):
3337
"""Mirror the source branch into the target branch.
3339
The source branch is considered to be 'local', having low latency.
3341
raise NotImplementedError(self.push)
3344
def copy_content_into(self, revision_id=None):
3345
"""Copy the content of source into target
3347
revision_id: if not None, the revision history in the new branch will
3348
be truncated to end with revision_id.
3350
raise NotImplementedError(self.copy_content_into)
3353
def fetch(self, stop_revision=None, limit=None):
3356
:param stop_revision: Last revision to fetch
3357
:param limit: Optional rough limit of revisions to fetch
3359
raise NotImplementedError(self.fetch)
3362
class GenericInterBranch(InterBranch):
3363
"""InterBranch implementation that uses public Branch functions."""
3366
def is_compatible(klass, source, target):
3367
# GenericBranch uses the public API, so always compatible
3371
def _get_branch_formats_to_test(klass):
3372
return [(format_registry.get_default(), format_registry.get_default())]
3375
def unwrap_format(klass, format):
3376
if isinstance(format, remote.RemoteBranchFormat):
3377
format._ensure_real()
3378
return format._custom_format
3382
def copy_content_into(self, revision_id=None):
3383
"""Copy the content of source into target
3385
revision_id: if not None, the revision history in the new branch will
3386
be truncated to end with revision_id.
3388
self.source.update_references(self.target)
3389
self.source._synchronize_history(self.target, revision_id)
3391
parent = self.source.get_parent()
3392
except errors.InaccessibleParent, e:
3393
mutter('parent was not accessible to copy: %s', e)
3396
self.target.set_parent(parent)
3397
if self.source._push_should_merge_tags():
3398
self.source.tags.merge_to(self.target.tags)
3401
def fetch(self, stop_revision=None, limit=None):
3402
if self.target.base == self.source.base:
3404
self.source.lock_read()
3406
fetch_spec_factory = fetch.FetchSpecFactory()
3407
fetch_spec_factory.source_branch = self.source
3408
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3409
fetch_spec_factory.source_repo = self.source.repository
3410
fetch_spec_factory.target_repo = self.target.repository
3411
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3412
fetch_spec_factory.limit = limit
3413
fetch_spec = fetch_spec_factory.make_fetch_spec()
3414
return self.target.repository.fetch(self.source.repository,
3415
fetch_spec=fetch_spec)
3417
self.source.unlock()
3420
def _update_revisions(self, stop_revision=None, overwrite=False,
3422
other_revno, other_last_revision = self.source.last_revision_info()
3423
stop_revno = None # unknown
3424
if stop_revision is None:
3425
stop_revision = other_last_revision
3426
if _mod_revision.is_null(stop_revision):
3427
# if there are no commits, we're done.
3429
stop_revno = other_revno
3431
# what's the current last revision, before we fetch [and change it
3433
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3434
# we fetch here so that we don't process data twice in the common
3435
# case of having something to pull, and so that the check for
3436
# already merged can operate on the just fetched graph, which will
3437
# be cached in memory.
3438
self.fetch(stop_revision=stop_revision)
3439
# Check to see if one is an ancestor of the other
3442
graph = self.target.repository.get_graph()
3443
if self.target._check_if_descendant_or_diverged(
3444
stop_revision, last_rev, graph, self.source):
3445
# stop_revision is a descendant of last_rev, but we aren't
3446
# overwriting, so we're done.
3448
if stop_revno is None:
3450
graph = self.target.repository.get_graph()
3451
this_revno, this_last_revision = \
3452
self.target.last_revision_info()
3453
stop_revno = graph.find_distance_to_null(stop_revision,
3454
[(other_last_revision, other_revno),
3455
(this_last_revision, this_revno)])
3456
self.target.set_last_revision_info(stop_revno, stop_revision)
3459
def pull(self, overwrite=False, stop_revision=None,
3460
possible_transports=None, run_hooks=True,
3461
_override_hook_target=None, local=False):
3462
"""Pull from source into self, updating my master if any.
3464
:param run_hooks: Private parameter - if false, this branch
3465
is being called because it's the master of the primary branch,
3466
so it should not run its hooks.
3468
bound_location = self.target.get_bound_location()
3469
if local and not bound_location:
3470
raise errors.LocalRequiresBoundBranch()
3471
master_branch = None
3472
source_is_master = False
3474
# bound_location comes from a config file, some care has to be
3475
# taken to relate it to source.user_url
3476
normalized = urlutils.normalize_url(bound_location)
3478
relpath = self.source.user_transport.relpath(normalized)
3479
source_is_master = (relpath == '')
3480
except (errors.PathNotChild, errors.InvalidURL):
3481
source_is_master = False
3482
if not local and bound_location and not source_is_master:
3483
# not pulling from master, so we need to update master.
3484
master_branch = self.target.get_master_branch(possible_transports)
3485
master_branch.lock_write()
3488
# pull from source into master.
3489
master_branch.pull(self.source, overwrite, stop_revision,
3491
return self._pull(overwrite,
3492
stop_revision, _hook_master=master_branch,
3493
run_hooks=run_hooks,
3494
_override_hook_target=_override_hook_target,
3495
merge_tags_to_master=not source_is_master)
3498
master_branch.unlock()
3500
def push(self, overwrite=False, stop_revision=None, lossy=False,
3501
_override_hook_source_branch=None):
3502
"""See InterBranch.push.
3504
This is the basic concrete implementation of push()
3506
:param _override_hook_source_branch: If specified, run the hooks
3507
passing this Branch as the source, rather than self. This is for
3508
use of RemoteBranch, where push is delegated to the underlying
3512
raise errors.LossyPushToSameVCS(self.source, self.target)
3513
# TODO: Public option to disable running hooks - should be trivial but
3516
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3517
op.add_cleanup(self.source.lock_read().unlock)
3518
op.add_cleanup(self.target.lock_write().unlock)
3519
return op.run(overwrite, stop_revision,
3520
_override_hook_source_branch=_override_hook_source_branch)
3522
def _basic_push(self, overwrite, stop_revision):
3523
"""Basic implementation of push without bound branches or hooks.
3525
Must be called with source read locked and target write locked.
3527
result = BranchPushResult()
3528
result.source_branch = self.source
3529
result.target_branch = self.target
3530
result.old_revno, result.old_revid = self.target.last_revision_info()
3531
self.source.update_references(self.target)
3532
if result.old_revid != stop_revision:
3533
# We assume that during 'push' this repository is closer than
3535
graph = self.source.repository.get_graph(self.target.repository)
3536
self._update_revisions(stop_revision, overwrite=overwrite,
3538
if self.source._push_should_merge_tags():
3539
result.tag_updates, result.tag_conflicts = (
3540
self.source.tags.merge_to(self.target.tags, overwrite))
3541
result.new_revno, result.new_revid = self.target.last_revision_info()
3544
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3545
_override_hook_source_branch=None):
3546
"""Push from source into target, and into target's master if any.
3549
if _override_hook_source_branch:
3550
result.source_branch = _override_hook_source_branch
3551
for hook in Branch.hooks['post_push']:
3554
bound_location = self.target.get_bound_location()
3555
if bound_location and self.target.base != bound_location:
3556
# there is a master branch.
3558
# XXX: Why the second check? Is it even supported for a branch to
3559
# be bound to itself? -- mbp 20070507
3560
master_branch = self.target.get_master_branch()
3561
master_branch.lock_write()
3562
operation.add_cleanup(master_branch.unlock)
3563
# push into the master from the source branch.
3564
master_inter = InterBranch.get(self.source, master_branch)
3565
master_inter._basic_push(overwrite, stop_revision)
3566
# and push into the target branch from the source. Note that
3567
# we push from the source branch again, because it's considered
3568
# the highest bandwidth repository.
3569
result = self._basic_push(overwrite, stop_revision)
3570
result.master_branch = master_branch
3571
result.local_branch = self.target
3573
master_branch = None
3575
result = self._basic_push(overwrite, stop_revision)
3576
# TODO: Why set master_branch and local_branch if there's no
3577
# binding? Maybe cleaner to just leave them unset? -- mbp
3579
result.master_branch = self.target
3580
result.local_branch = None
3584
def _pull(self, overwrite=False, stop_revision=None,
3585
possible_transports=None, _hook_master=None, run_hooks=True,
3586
_override_hook_target=None, local=False,
3587
merge_tags_to_master=True):
3590
This function is the core worker, used by GenericInterBranch.pull to
3591
avoid duplication when pulling source->master and source->local.
3593
:param _hook_master: Private parameter - set the branch to
3594
be supplied as the master to pull hooks.
3595
:param run_hooks: Private parameter - if false, this branch
3596
is being called because it's the master of the primary branch,
3597
so it should not run its hooks.
3598
is being called because it's the master of the primary branch,
3599
so it should not run its hooks.
3600
:param _override_hook_target: Private parameter - set the branch to be
3601
supplied as the target_branch to pull hooks.
3602
:param local: Only update the local branch, and not the bound branch.
3604
# This type of branch can't be bound.
3606
raise errors.LocalRequiresBoundBranch()
3607
result = PullResult()
3608
result.source_branch = self.source
3609
if _override_hook_target is None:
3610
result.target_branch = self.target
3612
result.target_branch = _override_hook_target
3613
self.source.lock_read()
3615
# We assume that during 'pull' the target repository is closer than
3617
self.source.update_references(self.target)
3618
graph = self.target.repository.get_graph(self.source.repository)
3619
# TODO: Branch formats should have a flag that indicates
3620
# that revno's are expensive, and pull() should honor that flag.
3622
result.old_revno, result.old_revid = \
3623
self.target.last_revision_info()
3624
self._update_revisions(stop_revision, overwrite=overwrite,
3626
# TODO: The old revid should be specified when merging tags,
3627
# so a tags implementation that versions tags can only
3628
# pull in the most recent changes. -- JRV20090506
3629
result.tag_updates, result.tag_conflicts = (
3630
self.source.tags.merge_to(self.target.tags, overwrite,
3631
ignore_master=not merge_tags_to_master))
3632
result.new_revno, result.new_revid = self.target.last_revision_info()
3634
result.master_branch = _hook_master
3635
result.local_branch = result.target_branch
3637
result.master_branch = result.target_branch
3638
result.local_branch = None
3640
for hook in Branch.hooks['post_pull']:
3643
self.source.unlock()
3647
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
