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 copy import deepcopy
23
from unittest import TestSuite
24
from warnings import warn
27
26
from bzrlib import (
30
config as _mod_config,
35
revision as _mod_revision,
42
from bzrlib.config import BranchConfig, TreeConfig
43
from bzrlib.lockable_files import LockableFiles, TransportLock
44
from bzrlib.tag import (
31
config as _mod_config,
40
revision as _mod_revision,
48
from bzrlib.i18n import gettext, ngettext
50
from bzrlib.decorators import needs_read_lock, needs_write_lock
51
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
52
HistoryMissing, InvalidRevisionId,
53
InvalidRevisionNumber, LockError, NoSuchFile,
54
NoSuchRevision, NoWorkingTree, NotVersionedError,
55
NotBranchError, UninitializableFormat,
56
UnlistableStore, UnlistableBranch,
51
# Explicitly import bzrlib.bzrdir so that the BzrProber
52
# is guaranteed to be registered.
59
from bzrlib.decorators import (
58
64
from bzrlib.hooks import Hooks
59
from bzrlib.symbol_versioning import (deprecated_function,
63
zero_eight, zero_nine, zero_sixteen,
65
from bzrlib.trace import mutter, note
68
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
69
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
70
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
73
# TODO: Maybe include checks for common corruption of newlines, etc?
75
# TODO: Some operations like log might retrieve the same revisions
76
# repeatedly to calculate deltas. We could perhaps have a weakref
77
# cache in memory to make this faster. In general anything can be
78
# cached in memory between lock and unlock operations. .. nb thats
79
# what the transaction identity map provides
82
######################################################################
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):
86
76
"""Branch holding a history of revisions.
89
Base directory/url of the branch.
91
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
93
85
# this is really an instance variable - FIXME move it there
97
# override this to set the strategy for storing tags
99
return DisabledTags(self)
101
def __init__(self, *ignored, **ignored_too):
102
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)
103
99
self._revision_history_cache = None
104
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)
106
129
def break_lock(self):
107
130
"""Break a lock if one is present from another instance.
117
140
if master is not None:
118
141
master.break_lock()
121
@deprecated_method(zero_eight)
122
def open_downlevel(base):
123
"""Open a branch which may be of an old format."""
124
return Branch.open(base, _unsupported=True)
127
def open(base, _unsupported=False):
143
def _check_stackable_repo(self):
144
if not self.repository._format.supports_external_lookups:
145
raise errors.UnstackableRepositoryFormat(self.repository._format,
146
self.repository.base)
148
def _extend_partial_history(self, stop_index=None, stop_revision=None):
149
"""Extend the partial history to include a given index
151
If a stop_index is supplied, stop when that index has been reached.
152
If a stop_revision is supplied, stop when that revision is
153
encountered. Otherwise, stop when the beginning of history is
156
:param stop_index: The index which should be present. When it is
157
present, history extension will stop.
158
:param stop_revision: The revision id which should be present. When
159
it is encountered, history extension will stop.
161
if len(self._partial_revision_history_cache) == 0:
162
self._partial_revision_history_cache = [self.last_revision()]
163
repository._iter_for_revno(
164
self.repository, self._partial_revision_history_cache,
165
stop_index=stop_index, stop_revision=stop_revision)
166
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
167
self._partial_revision_history_cache.pop()
169
def _get_check_refs(self):
170
"""Get the references needed for check().
174
revid = self.last_revision()
175
return [('revision-existence', revid), ('lefthand-distance', revid)]
178
def open(base, _unsupported=False, possible_transports=None):
128
179
"""Open the branch rooted at base.
130
181
For instance, if the branch is at URL/.bzr/branch,
131
182
Branch.open(URL) -> a Branch instance.
133
control = bzrdir.BzrDir.open(base, _unsupported)
134
return control.open_branch(_unsupported)
137
def open_containing(url):
184
control = controldir.ControlDir.open(base,
185
possible_transports=possible_transports, _unsupported=_unsupported)
186
return control.open_branch(unsupported=_unsupported,
187
possible_transports=possible_transports)
190
def open_from_transport(transport, name=None, _unsupported=False,
191
possible_transports=None):
192
"""Open the branch rooted at transport"""
193
control = controldir.ControlDir.open_from_transport(transport, _unsupported)
194
return control.open_branch(name=name, unsupported=_unsupported,
195
possible_transports=possible_transports)
198
def open_containing(url, possible_transports=None):
138
199
"""Open an existing branch which contains url.
140
201
This probes for a branch at url, and searches upwards from there.
142
203
Basically we keep looking up until we find the control directory or
143
204
run into the root. If there isn't one, raises NotBranchError.
144
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
145
206
format, UnknownFormatError or UnsupportedFormatError are raised.
146
207
If there is one, it is returned, along with the unused portion of url.
148
control, relpath = bzrdir.BzrDir.open_containing(url)
149
return control.open_branch(), relpath
152
@deprecated_function(zero_eight)
153
def initialize(base):
154
"""Create a new working tree and branch, rooted at 'base' (url)
156
NOTE: This will soon be deprecated in favour of creation
159
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
161
@deprecated_function(zero_eight)
162
def setup_caching(self, cache_root):
163
"""Subclasses that care about caching should override this, and set
164
up cached stores located under cache_root.
166
NOTE: This is unused.
209
control, relpath = controldir.ControlDir.open_containing(url,
211
branch = control.open_branch(possible_transports=possible_transports)
212
return (branch, relpath)
214
def _push_should_merge_tags(self):
215
"""Should _basic_push merge this branch's tags into the target?
217
The default implementation returns False if this branch has no tags,
218
and True the rest of the time. Subclasses may override this.
220
return self.supports_tags() and self.tags.get_tag_dict()
170
222
def get_config(self):
171
return BranchConfig(self)
174
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()
176
297
def _set_nick(self, nick):
177
self.get_config().set_user_option('nickname', nick)
298
self.get_config().set_user_option('nickname', nick, warn_masked=True)
179
300
nick = property(_get_nick, _set_nick)
181
302
def is_locked(self):
182
303
raise NotImplementedError(self.is_locked)
184
def lock_write(self):
305
def _lefthand_history(self, revision_id, last_rev=None,
307
if 'evil' in debug.debug_flags:
308
mutter_callsite(4, "_lefthand_history scales with history.")
309
# stop_revision must be a descendant of last_revision
310
graph = self.repository.get_graph()
311
if last_rev is not None:
312
if not graph.is_ancestor(last_rev, revision_id):
313
# our previous tip is not merged into stop_revision
314
raise errors.DivergedBranches(self, other_branch)
315
# make a new revision history from the graph
316
parents_map = graph.get_parent_map([revision_id])
317
if revision_id not in parents_map:
318
raise errors.NoSuchRevision(self, revision_id)
319
current_rev_id = revision_id
321
check_not_reserved_id = _mod_revision.check_not_reserved_id
322
# Do not include ghosts or graph origin in revision_history
323
while (current_rev_id in parents_map and
324
len(parents_map[current_rev_id]) > 0):
325
check_not_reserved_id(current_rev_id)
326
new_history.append(current_rev_id)
327
current_rev_id = parents_map[current_rev_id][0]
328
parents_map = graph.get_parent_map([current_rev_id])
329
new_history.reverse()
332
def lock_write(self, token=None):
333
"""Lock the branch for write operations.
335
:param token: A token to permit reacquiring a previously held and
337
:return: A BranchWriteLockResult.
185
339
raise NotImplementedError(self.lock_write)
187
341
def lock_read(self):
342
"""Lock the branch for read operations.
344
:return: A bzrlib.lock.LogicalLockResult.
188
346
raise NotImplementedError(self.lock_read)
190
348
def unlock(self):
228
450
:return: A dictionary mapping revision_id => dotted revno.
230
last_revision = self.last_revision()
231
revision_graph = self.repository.get_revision_graph(last_revision)
232
merge_sorted_revisions = tsort.merge_sort(
237
452
revision_id_to_revno = dict((rev_id, revno)
238
for seq_num, rev_id, depth, revno, end_of_merge
239
in merge_sorted_revisions)
453
for rev_id, depth, revno, end_of_merge
454
in self.iter_merge_sorted_revisions())
240
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)
242
644
def leave_lock_in_place(self):
243
645
"""Tell this branch object not to release the physical lock when this
244
646
object is unlocked.
246
648
If lock_write doesn't return a token, then this method is not supported.
248
650
self.control_files.leave_in_place()
331
722
:param committer: Optional committer to set for commit.
332
723
:param revprops: Optional dictionary of revision properties.
333
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
337
config = self.get_config()
339
return self.repository.get_commit_builder(self, parents, config,
340
timestamp, timezone, committer, revprops, revision_id)
342
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):
343
737
"""Return the branch we are bound to.
345
739
:return: Either a Branch, or None
743
@deprecated_method(deprecated_in((2, 5, 0)))
349
744
def get_revision_delta(self, revno):
350
745
"""Return the delta for one revision.
352
747
The delta is relative to its mainline predecessor, or the
353
748
empty tree for revision 1.
355
assert isinstance(revno, int)
356
rh = self.revision_history()
357
if not (1 <= revno <= len(rh)):
358
raise InvalidRevisionNumber(revno)
359
return self.repository.get_revision_delta(rh[revno-1])
361
@deprecated_method(zero_sixteen)
362
def get_root_id(self):
363
"""Return the id of this branches root
365
Deprecated: branches don't have root ids-- trees do.
366
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
368
raise NotImplementedError(self.get_root_id)
763
raise NotImplementedError(self.get_stacked_on_url)
370
765
def print_file(self, file, revision_id):
371
766
"""Print `file` to stdout."""
372
767
raise NotImplementedError(self.print_file)
374
def append_revision(self, *revision_ids):
375
raise NotImplementedError(self.append_revision)
769
@deprecated_method(deprecated_in((2, 4, 0)))
377
770
def set_revision_history(self, rev_history):
378
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)
380
964
def _cache_revision_history(self, rev_history):
381
965
"""Set the cached revision history to rev_history.
443
1039
That is equivalent to the number of revisions committed to
446
return len(self.revision_history())
1042
return self.last_revision_info()[0]
448
1044
def unbind(self):
449
1045
"""Older format branches cannot bind or unbind."""
450
raise errors.UpgradeRequired(self.base)
452
def set_append_revisions_only(self, enabled):
453
"""Older format branches are never restricted to append-only"""
454
raise errors.UpgradeRequired(self.base)
1046
raise errors.UpgradeRequired(self.user_url)
456
1048
def last_revision(self):
457
"""Return last revision id, or None"""
458
ph = self.revision_history()
1049
"""Return last revision id, or NULL_REVISION."""
1050
return self.last_revision_info()[1]
464
1053
def last_revision_info(self):
465
1054
"""Return information about the last revision.
467
:return: A tuple (revno, last_revision_id).
469
rh = self.revision_history()
472
return (revno, rh[-1])
474
return (0, _mod_revision.NULL_REVISION)
476
def missing_revisions(self, other, stop_revision=None):
477
"""Return a list of new revisions that would perfectly fit.
479
If self and other have not diverged, return a list of the revisions
480
present in other, but missing from self.
482
self_history = self.revision_history()
483
self_len = len(self_history)
484
other_history = other.revision_history()
485
other_len = len(other_history)
486
common_index = min(self_len, other_len) -1
487
if common_index >= 0 and \
488
self_history[common_index] != other_history[common_index]:
489
raise DivergedBranches(self, other)
491
if stop_revision is None:
492
stop_revision = other_len
494
assert isinstance(stop_revision, int)
495
if stop_revision > other_len:
496
raise errors.NoSuchRevision(self, stop_revision)
497
return other_history[self_len:stop_revision]
499
def update_revisions(self, other, stop_revision=None):
500
"""Pull in new perfect-fit revisions.
502
:param other: Another Branch to pull from
503
:param stop_revision: Updated until the given revision
506
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)
508
1098
def revision_id_to_revno(self, revision_id):
509
1099
"""Given a revision id, return its revno"""
510
if revision_id is None:
1100
if _mod_revision.is_null(revision_id):
512
revision_id = osutils.safe_revision_id(revision_id)
513
history = self.revision_history()
1102
history = self._revision_history()
515
1104
return history.index(revision_id) + 1
516
1105
except ValueError:
517
1106
raise errors.NoSuchRevision(self, revision_id)
519
1109
def get_rev_id(self, revno, history=None):
520
1110
"""Find the revision id of the specified revno."""
524
history = self.revision_history()
525
if revno <= 0 or revno > len(history):
1112
return _mod_revision.NULL_REVISION
1113
last_revno, last_revid = self.last_revision_info()
1114
if revno == last_revno:
1116
if revno <= 0 or revno > last_revno:
526
1117
raise errors.NoSuchRevision(self, revno)
527
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]
529
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):
530
1125
"""Mirror source into this branch.
532
1127
This branch is considered to be 'local', having low latency.
534
1129
:returns: PullResult instance
536
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)
538
def push(self, target, overwrite=False, stop_revision=None):
1135
def push(self, target, overwrite=False, stop_revision=None, lossy=False,
539
1137
"""Mirror this branch into target.
541
1139
This branch is considered to be 'local', having low latency.
543
raise NotImplementedError(self.push)
1141
return InterBranch.get(self, target).push(overwrite, stop_revision,
1142
lossy, *args, **kwargs)
545
1144
def basis_tree(self):
546
1145
"""Return `Tree` object for last revision."""
547
1146
return self.repository.revision_tree(self.last_revision())
549
def rename_one(self, from_rel, to_rel):
552
This can change the directory or the filename or both.
554
raise NotImplementedError(self.rename_one)
556
def move(self, from_paths, to_name):
559
to_name must exist as a versioned directory.
561
If to_name exists and is a directory, the files are moved into
562
it, keeping their old names. If it is a directory,
564
Note that to_name is only the last component of the new name;
565
this doesn't change the directory.
567
This returns a list of (from_path, to_path) pairs for each
570
raise NotImplementedError(self.move)
572
1148
def get_parent(self):
573
1149
"""Return the parent location of the branch.
575
This is the default location for push/pull/missing. The usual
1151
This is the default location for pull/missing. The usual
576
1152
pattern is that the user can override it by specifying a
579
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)
581
1170
def _set_config_location(self, name, url, config=None,
582
1171
make_relative=False):
583
1172
if config is None:
584
config = self.get_config()
1173
config = self.get_config_stack()
587
1176
elif make_relative:
588
1177
url = urlutils.relative_url(self.base, url)
589
config.set_user_option(name, url)
1178
config.set(name, url)
591
1180
def _get_config_location(self, name, config=None):
592
1181
if config is None:
593
config = self.get_config()
594
location = config.get_user_option(name)
1182
config = self.get_config_stack()
1183
location = config.get(name)
595
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')
599
1192
def get_submit_branch(self):
600
1193
"""Return the submit location of the branch.
659
1270
self.check_real_revno(revno)
661
1272
def check_real_revno(self, revno):
663
1274
Check whether a revno corresponds to a real revision.
664
1275
Zero (the NULL revision) is considered invalid
666
1277
if revno < 1 or revno > self.revno():
667
raise InvalidRevisionNumber(revno)
1278
raise errors.InvalidRevisionNumber(revno)
669
1280
@needs_read_lock
670
def clone(self, to_bzrdir, revision_id=None):
1281
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
671
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.
673
1287
revision_id: if not None, the revision history in the new branch will
674
1288
be truncated to end with revision_id.
676
result = self._format.initialize(to_bzrdir)
677
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)
680
1300
@needs_read_lock
681
def sprout(self, to_bzrdir, revision_id=None):
1301
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
682
1303
"""Create a new line of development from the branch, into to_bzrdir.
1305
to_bzrdir controls the branch format.
684
1307
revision_id: if not None, the revision history in the new branch will
685
1308
be truncated to end with revision_id.
687
result = self._format.initialize(to_bzrdir)
688
self.copy_content_into(result, revision_id=revision_id)
689
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)
692
1328
def _synchronize_history(self, destination, revision_id):
693
1329
"""Synchronize last revision and revision history between branches.
695
1331
This version is most efficient when the destination is also a
696
BzrBranch5, but works for BzrBranch6 as long as the revision
697
history is the true lefthand parent history, and all of the revisions
698
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.
701
1336
:param destination: The branch to copy the history into
702
1337
:param revision_id: The revision-id to truncate history at. May
703
1338
be None to copy complete history.
705
new_history = self.revision_history()
706
if revision_id is not None:
707
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()
709
new_history = new_history[:new_history.index(revision_id) + 1]
711
rev = self.repository.get_revision(revision_id)
712
new_history = rev.get_history(self.repository)[1:]
713
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)
716
1353
def copy_content_into(self, destination, revision_id=None):
717
1354
"""Copy the content of self into destination.
719
1356
revision_id: if not None, the revision history in the new branch will
720
1357
be truncated to end with revision_id.
722
self._synchronize_history(destination, revision_id)
724
parent = self.get_parent()
725
except errors.InaccessibleParent, e:
726
mutter('parent was not accessible to copy: %s', e)
729
destination.set_parent(parent)
730
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)
732
1379
@needs_read_lock
1380
def check(self, refs):
734
1381
"""Check consistency of the branch.
736
1383
In particular this checks that revisions given in the revision-history
737
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
738
1385
present in the repository.
740
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()
742
1391
:return: A BranchCheckResult.
744
mainline_parent_id = None
745
for revision_id in self.revision_history():
747
revision = self.repository.get_revision(revision_id)
748
except errors.NoSuchRevision, e:
749
raise errors.BzrCheckError("mainline revision {%s} not in repository"
751
# In general the first entry on the revision history has no parents.
752
# But it's not illegal for it to have parents listed; this can happen
753
# in imports from Arch when the parents weren't reachable.
754
if mainline_parent_id is not None:
755
if mainline_parent_id not in revision.parent_ids:
756
raise errors.BzrCheckError("previous revision {%s} not listed among "
758
% (mainline_parent_id, revision_id))
759
mainline_parent_id = revision_id
760
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
762
def _get_checkout_format(self):
1407
def _get_checkout_format(self, lightweight=False):
763
1408
"""Return the most suitable metadir for a checkout of this branch.
764
1409
Weaves are used if this branch's repository uses weaves.
766
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
767
from bzrlib.repofmt import weaverepo
768
format = bzrdir.BzrDirMetaFormat1()
769
format.repository_format = weaverepo.RepositoryFormat7()
771
format = self.repository.bzrdir.checkout_metadir()
772
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()
775
1440
def create_checkout(self, to_location, revision_id=None,
1441
lightweight=False, accelerator_tree=None,
777
1443
"""Create a checkout of a branch.
779
1445
:param to_location: The url to produce the checkout at
780
1446
:param revision_id: The revision to check out
781
1447
:param lightweight: If True, produce a lightweight checkout, otherwise,
782
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,
783
1455
:return: The tree of the created checkout
785
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
788
format = self._get_checkout_format()
789
checkout = format.initialize_on_transport(t)
790
BranchReferenceFormat().initialize(checkout, self)
1478
from_branch = checkout.set_branch_reference(target_branch=self)
792
format = self._get_checkout_format()
793
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
794
to_location, force_new_tree=False, format=format)
795
checkout = checkout_branch.bzrdir
1480
policy = checkout.determine_repository_policy()
1481
repo = policy.acquire_repository()[0]
1482
checkout_branch = checkout.create_branch()
796
1483
checkout_branch.bind(self)
797
# pull up to the specified revision_id to set the initial
1484
# pull up to the specified revision_id to set the initial
798
1485
# branch tip correctly, and seed it with history.
799
1486
checkout_branch.pull(self, stop_revision=revision_id)
800
tree = checkout.create_workingtree(revision_id)
1488
tree = checkout.create_workingtree(revision_id,
1489
from_branch=from_branch,
1490
accelerator_tree=accelerator_tree,
801
1492
basis_tree = tree.basis_tree()
802
1493
basis_tree.lock_read()
810
1501
basis_tree.unlock()
813
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):
814
1513
"""Return the parent branch for a tree-reference file_id
815
1515
:param file_id: The file_id of the tree reference
816
1516
:param path: The path of the file_id in the tree
817
1517
:return: A branch associated with the file_id
819
1519
# FIXME should provide multiple branches, based on config
820
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)
822
1523
def supports_tags(self):
823
1524
return self._format.supports_tags()
826
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):
827
1597
"""An encapsulation of the initialization and open routines for a format.
829
1599
Formats provide three things:
830
1600
* An initialization routine,
1601
* a format description
832
1602
* an open routine.
834
Formats are placed in an dict by their format string for reference
835
during branch opening. Its not required that these be instances, they
836
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
837
1607
whether state is needed for a given format or not.
839
1609
Once a format is deprecated, just deprecate the initialize and open
840
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
841
1611
object will be created every time regardless.
844
_default_format = None
845
"""The default format used for new branches."""
848
"""The known formats."""
851
def find_format(klass, a_bzrdir):
852
"""Return the format for the branch object in a_bzrdir."""
854
transport = a_bzrdir.get_branch_transport(None)
855
format_string = transport.get("format").read()
856
return klass._formats[format_string]
858
raise NotBranchError(path=transport.base)
860
raise errors.UnknownFormatError(format=format_string)
1614
def __eq__(self, other):
1615
return self.__class__ is other.__class__
1617
def __ne__(self, other):
1618
return not (self == other)
1621
@deprecated_method(deprecated_in((2, 4, 0)))
863
1622
def get_default_format(klass):
864
1623
"""Return the current default format."""
865
return klass._default_format
867
def get_reference(self, a_bzrdir):
868
"""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.
870
1639
format probing must have been completed before calling
871
1640
this method - it is assumed that the format of the branch
872
in a_bzrdir is correct.
1641
in controldir is correct.
874
: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
875
1645
:return: None if the branch is not a reference branch.
879
def get_format_string(self):
880
"""Return the ASCII format string that identifies this format."""
881
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)
883
1663
def get_format_description(self):
884
1664
"""Return the short format description for this format."""
885
1665
raise NotImplementedError(self.get_format_description)
887
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
889
"""Initialize a branch in a bzrdir, with specified files
891
:param a_bzrdir: The bzrdir to initialize the branch in
892
:param utf8_files: The files to create as a list of
893
(filename, content) tuples
894
:param set_format: If True, set the format with
895
self.get_format_string. (BzrBranch4 has its format set
897
: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.
899
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
900
branch_transport = a_bzrdir.get_branch_transport(self)
902
'metadir': ('lock', lockdir.LockDir),
903
'branch4': ('branch-lock', lockable_files.TransportLock),
905
lock_name, lock_class = lock_map[lock_type]
906
control_files = lockable_files.LockableFiles(branch_transport,
907
lock_name, lock_class)
908
control_files.create_lock()
909
control_files.lock_write()
911
control_files.put_utf8('format', self.get_format_string())
913
for file, content in utf8_files:
914
control_files.put_utf8(file, content)
916
control_files.unlock()
917
return self.open(a_bzrdir, _found=True)
919
def initialize(self, a_bzrdir):
920
"""Create a branch of this format in a_bzrdir."""
921
1681
raise NotImplementedError(self.initialize)
923
1683
def is_supported(self):
924
1684
"""Is this format supported?
926
1686
Supported formats can be initialized and opened.
927
Unsupported formats may not support initialization or committing or
1687
Unsupported formats may not support initialization or committing or
928
1688
some other features depending on the reason for not being supported.
932
def open(self, a_bzrdir, _found=False):
933
"""Return the branch object for a_bzrdir
935
_found is a private parameter, do not use it. It is used to indicate
936
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.
938
1727
raise NotImplementedError(self.open)
1730
@deprecated_method(deprecated_in((2, 4, 0)))
941
1731
def register_format(klass, format):
942
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)))
945
1741
def set_default_format(klass, format):
946
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)))
949
1758
def unregister_format(klass, format):
950
assert klass._formats[format.get_format_string()] is format
951
del klass._formats[format.get_format_string()]
1759
format_registry.remove(format)
953
1761
def __str__(self):
954
return self.get_format_string().rstrip()
1762
return self.get_format_description().rstrip()
956
1764
def supports_tags(self):
957
1765
"""True if this format supports tags stored in the branch"""
958
1766
return False # by default
960
# XXX: Probably doesn't really belong here -- mbp 20070212
961
def _initialize_control_files(self, a_bzrdir, utf8_files, lock_filename,
963
branch_transport = a_bzrdir.get_branch_transport(self)
964
control_files = lockable_files.LockableFiles(branch_transport,
965
lock_filename, lock_class)
966
control_files.create_lock()
967
control_files.lock_write()
969
for filename, content in utf8_files:
970
control_files.put_utf8(filename, content)
972
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()()
975
1805
class BranchHooks(Hooks):
976
1806
"""A dictionary mapping hook name to a list of callables for branch hooks.
978
1808
e.g. ['set_rh'] Is the list of items to be called when the
979
1809
set_revision_history function is invoked.
985
1815
These are all empty initially, because by default nothing should get
989
# Introduced in 0.15:
990
# invoked whenever the revision history has been set
991
# with set_revision_history. The api signature is
992
# (branch, revision_history), and the branch will
995
# invoked after a push operation completes.
996
# the api signature is
998
# containing the members
999
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1000
# where local is the local target branch or None, master is the target
1001
# master branch, and the rest should be self explanatory. The source
1002
# is read locked and the target branches write locked. Source will
1003
# be the local low-latency branch.
1004
self['post_push'] = []
1005
# invoked after a pull operation completes.
1006
# the api signature is
1008
# containing the members
1009
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1010
# where local is the local branch or None, master is the target
1011
# master branch, and the rest should be self explanatory. The source
1012
# is read locked and the target branches write locked. The local
1013
# branch is the low-latency branch.
1014
self['post_pull'] = []
1015
# invoked after a commit operation completes.
1016
# the api signature is
1017
# (local, master, old_revno, old_revid, new_revno, new_revid)
1018
# old_revid is NULL_REVISION for the first commit to a branch.
1019
self['post_commit'] = []
1020
# invoked after a uncommit operation completes.
1021
# the api signature is
1022
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1023
# local is the local branch or None, master is the target branch,
1024
# and an empty branch recieves new_revno of 0, new_revid of None.
1025
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))
1028
1898
# install the default hooks into the Branch class.
1029
1899
Branch.hooks = BranchHooks()
1032
class BzrBranchFormat4(BranchFormat):
1033
"""Bzr branch format 4.
1036
- a revision-history file.
1037
- a branch-lock lock file [ to be shared with the bzrdir ]
1040
def get_format_description(self):
1041
"""See BranchFormat.get_format_description()."""
1042
return "Branch format 4"
1044
def initialize(self, a_bzrdir):
1045
"""Create a branch of this format in a_bzrdir."""
1046
utf8_files = [('revision-history', ''),
1047
('branch-name', ''),
1049
return self._initialize_helper(a_bzrdir, utf8_files,
1050
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.
1052
2017
def __init__(self):
1053
super(BzrBranchFormat4, self).__init__()
1054
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1056
def open(self, a_bzrdir, _found=False):
1057
"""Return the branch object for a_bzrdir
1059
_found is a private parameter, do not use it. It is used to indicate
1060
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 bzrdir, 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()
1063
# we are being called directly and must probe.
1064
raise NotImplementedError
1065
return BzrBranch(_format=self,
1066
_control_files=a_bzrdir._control_files,
1068
_repository=a_bzrdir.open_repository())
1071
return "Bazaar-NG branch format 4"
1074
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):
1075
2125
"""Bzr branch format 5.
1077
2127
This format has:
1142
2183
"""See BranchFormat.get_format_description()."""
1143
2184
return "Branch format 6"
1145
def initialize(self, a_bzrdir):
1146
"""Create a branch of this format in a_bzrdir."""
1147
utf8_files = [('last-revision', '0 null:\n'),
1148
('branch-name', ''),
1149
('branch.conf', ''),
1152
return self._initialize_helper(a_bzrdir, utf8_files)
1154
def open(self, a_bzrdir, _found=False):
1155
"""Return the branch object for a_bzrdir
1157
_found is a private parameter, do not use it. It is used to indicate
1158
if format probing has already be done.
1161
format = BranchFormat.find_format(a_bzrdir)
1162
assert format.__class__ == self.__class__
1163
transport = a_bzrdir.get_branch_transport(None)
1164
control_files = lockable_files.LockableFiles(transport, 'lock',
1166
return BzrBranch6(_format=self,
1167
_control_files=control_files,
1169
_repository=a_bzrdir.find_repository())
1171
def supports_tags(self):
1175
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):
1176
2288
"""Bzr branch reference format.
1178
2290
Branch references are used in implementing checkouts, they
1183
2295
- a format string
1186
def get_format_string(self):
2299
def get_format_string(cls):
1187
2300
"""See BranchFormat.get_format_string()."""
1188
2301
return "Bazaar-NG Branch Reference Format 1\n"
1190
2303
def get_format_description(self):
1191
2304
"""See BranchFormat.get_format_description()."""
1192
2305
return "Checkout reference format 1"
1194
def get_reference(self, a_bzrdir):
2307
def get_reference(self, a_bzrdir, name=None):
1195
2308
"""See BranchFormat.get_reference()."""
1196
transport = a_bzrdir.get_branch_transport(None)
1197
return transport.get('location').read()
1199
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):
1200
2319
"""Create a branch of this format in a_bzrdir."""
1201
2320
if target_branch is None:
1202
2321
# this format does not implement branch itself, thus the implicit
1203
2322
# creation contract must see it as uninitializable
1204
2323
raise errors.UninitializableFormat(self)
1205
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1206
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)
1207
2330
branch_transport.put_bytes('location',
1208
target_branch.bzrdir.root_transport.base)
1209
branch_transport.put_bytes('format', self.get_format_string())
1210
return self.open(a_bzrdir, _found=True)
1213
super(BranchReferenceFormat, self).__init__()
1214
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)
1216
2338
def _make_reference_clone_function(format, a_branch):
1217
2339
"""Create a clone() routine for a branch dynamically."""
1218
def clone(to_bzrdir, revision_id=None):
2340
def clone(to_bzrdir, revision_id=None,
2341
repository_policy=None):
1219
2342
"""See Branch.clone()."""
1220
return format.initialize(to_bzrdir, a_branch)
2343
return format.initialize(to_bzrdir, target_branch=a_branch)
1221
2344
# cannot obey revision_id limits when cloning a reference ...
1222
2345
# FIXME RBC 20060210 either nuke revision_id for clone, or
1223
2346
# emit some sort of warning/error to the caller ?!
1226
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):
1227
2352
"""Return the branch that the branch reference in a_bzrdir points at.
1229
_found is a private parameter, do not use it. It is used to indicate
1230
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()
1233
format = BranchFormat.find_format(a_bzrdir)
1234
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" %
1235
2372
if location is None:
1236
location = self.get_reference(a_bzrdir)
1237
real_bzrdir = bzrdir.BzrDir.open(location)
1238
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)
1239
2378
# this changes the behaviour of result.clone to create a new reference
1240
2379
# rather than a copy of the content of the branch.
1241
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)
1251
2415
# formats which have no format string are not discoverable
1252
2416
# and not independently creatable, so are not registered.
1253
__default_format = BzrBranchFormat5()
1254
BranchFormat.register_format(__default_format)
1255
BranchFormat.register_format(BranchReferenceFormat())
1256
BranchFormat.register_format(BzrBranchFormat6())
1257
BranchFormat.set_default_format(__default_format)
1258
_legacy_formats = [BzrBranchFormat4(),
1261
class BzrBranch(Branch):
2417
__format5 = BzrBranchFormat5()
2418
__format6 = BzrBranchFormat6()
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):
1262
2447
"""A branch stored in the actual filesystem.
1264
2449
Note that it's "local" in the context of the filesystem; it doesn't
1265
2450
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1266
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
1269
2462
def __init__(self, _format=None,
1270
_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):
1271
2466
"""Create new branch object at a particular location."""
1272
Branch.__init__(self)
1273
2467
if a_bzrdir is None:
1274
2468
raise ValueError('a_bzrdir must be supplied')
1276
self.bzrdir = a_bzrdir
1277
# self._transport used to point to the directory containing the
1278
# control directory, but was not used - now it's just the transport
1279
# for the branch control files. mbp 20070212
1280
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
1281
2478
self._format = _format
1282
2479
if _control_files is None:
1283
2480
raise ValueError('BzrBranch _control_files is None')
1284
2481
self.control_files = _control_files
1285
2482
self._transport = _control_files._transport
1286
2483
self.repository = _repository
2484
Branch.__init__(self, possible_transports)
1288
2486
def __str__(self):
1289
return '%s(%r)' % (self.__class__.__name__, self.base)
2487
return '%s(%s)' % (self.__class__.__name__, self.user_url)
1291
2489
__repr__ = __str__
1353
2584
return self.repository.print_file(file, revision_id)
1355
2586
@needs_write_lock
1356
def append_revision(self, *revision_ids):
1357
"""See Branch.append_revision."""
1358
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1359
for revision_id in revision_ids:
1360
_mod_revision.check_not_reserved_id(revision_id)
1361
mutter("add {%s} to revision-history" % revision_id)
1362
rev_history = self.revision_history()
1363
rev_history.extend(revision_ids)
1364
self.set_revision_history(rev_history)
1366
def _write_revision_history(self, history):
1367
"""Factored out of set_revision_history.
1369
This performs the actual writing to disk.
1370
It is intended to be called by BzrBranch5.set_revision_history."""
1371
self.control_files.put_bytes(
1372
'revision-history', '\n'.join(history))
1375
def set_revision_history(self, rev_history):
1376
"""See Branch.set_revision_history."""
1377
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
2587
def set_last_revision_info(self, revno, revision_id):
2588
if not revision_id or not isinstance(revision_id, basestring):
2589
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2590
revision_id = _mod_revision.ensure_null(revision_id)
2591
old_revno, old_revid = self.last_revision_info()
2592
if self.get_append_revisions_only():
2593
self._check_history_violation(revision_id)
2594
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2595
self._write_last_revision_info(revno, revision_id)
1378
2596
self._clear_cached_state()
1379
self._write_revision_history(rev_history)
1380
self._cache_revision_history(rev_history)
1381
for hook in Branch.hooks['set_rh']:
1382
hook(self, rev_history)
1385
def set_last_revision_info(self, revno, revision_id):
1386
revision_id = osutils.safe_revision_id(revision_id)
1387
history = self._lefthand_history(revision_id)
1388
assert len(history) == revno, '%d != %d' % (len(history), revno)
1389
self.set_revision_history(history)
1391
def _gen_revision_history(self):
1392
history = self.control_files.get('revision-history').read().split('\n')
1393
if history[-1:] == ['']:
1394
# There shouldn't be a trailing newline, but just in case.
1398
def _lefthand_history(self, revision_id, last_rev=None,
1400
# stop_revision must be a descendant of last_revision
1401
stop_graph = self.repository.get_revision_graph(revision_id)
1402
if last_rev is not None and last_rev not in stop_graph:
1403
# our previous tip is not merged into stop_revision
1404
raise errors.DivergedBranches(self, other_branch)
1405
# make a new revision history from the graph
1406
current_rev_id = revision_id
1408
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1409
new_history.append(current_rev_id)
1410
current_rev_id_parents = stop_graph[current_rev_id]
1412
current_rev_id = current_rev_id_parents[0]
1414
current_rev_id = None
1415
new_history.reverse()
1419
def generate_revision_history(self, revision_id, last_rev=None,
1421
"""Create a new revision history that will finish with revision_id.
1423
:param revision_id: the new tip to use.
1424
:param last_rev: The previous last_revision. If not None, then this
1425
must be a ancestory of revision_id, or DivergedBranches is raised.
1426
:param other_branch: The other branch that DivergedBranches should
1427
raise with respect to.
1429
revision_id = osutils.safe_revision_id(revision_id)
1430
self.set_revision_history(self._lefthand_history(revision_id,
1431
last_rev, other_branch))
1434
def update_revisions(self, other, stop_revision=None):
1435
"""See Branch.update_revisions."""
1438
if stop_revision is None:
1439
stop_revision = other.last_revision()
1440
if stop_revision is None:
1441
# if there are no commits, we're done.
1444
stop_revision = osutils.safe_revision_id(stop_revision)
1445
# whats the current last revision, before we fetch [and change it
1447
last_rev = self.last_revision()
1448
# we fetch here regardless of whether we need to so that we pickup
1450
self.fetch(other, stop_revision)
1451
my_ancestry = self.repository.get_ancestry(last_rev)
1452
if stop_revision in my_ancestry:
1453
# last_revision is a descendant of stop_revision
1455
self.generate_revision_history(stop_revision, last_rev=last_rev,
2597
self._last_revision_info_cache = revno, revision_id
2598
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1460
2600
def basis_tree(self):
1461
2601
"""See Branch.basis_tree."""
1462
2602
return self.repository.revision_tree(self.last_revision())
1464
@deprecated_method(zero_eight)
1465
def working_tree(self):
1466
"""Create a Working tree object for this branch."""
1468
from bzrlib.transport.local import LocalTransport
1469
if (self.base.find('://') != -1 or
1470
not isinstance(self._transport, LocalTransport)):
1471
raise NoWorkingTree(self.base)
1472
return self.bzrdir.open_workingtree()
1475
def pull(self, source, overwrite=False, stop_revision=None,
1476
_hook_master=None, run_hooks=True):
1479
:param _hook_master: Private parameter - set the branch to
1480
be supplied as the master to push hooks.
1481
:param run_hooks: Private parameter - if false, this branch
1482
is being called because it's the master of the primary branch,
1483
so it should not run its hooks.
1485
result = PullResult()
1486
result.source_branch = source
1487
result.target_branch = self
1490
result.old_revno, result.old_revid = self.last_revision_info()
1492
self.update_revisions(source, stop_revision)
1493
except DivergedBranches:
1497
if stop_revision is None:
1498
stop_revision = source.last_revision()
1499
self.generate_revision_history(stop_revision)
1500
result.tag_conflicts = source.tags.merge_to(self.tags)
1501
result.new_revno, result.new_revid = self.last_revision_info()
1503
result.master_branch = _hook_master
1504
result.local_branch = self
1506
result.master_branch = self
1507
result.local_branch = None
1509
for hook in Branch.hooks['post_pull']:
1515
2604
def _get_parent_location(self):
1516
2605
_locs = ['parent', 'pull', 'x-pull']
1517
2606
for l in _locs:
1519
return self.control_files.get(l).read().strip('\n')
2608
return self._transport.get_bytes(l).strip('\n')
2609
except errors.NoSuchFile:
1525
def push(self, target, overwrite=False, stop_revision=None,
1526
_override_hook_source_branch=None):
1529
This is the basic concrete implementation of push()
1531
:param _override_hook_source_branch: If specified, run
1532
the hooks passing this Branch as the source, rather than self.
1533
This is for use of RemoteBranch, where push is delegated to the
1534
underlying vfs-based Branch.
1536
# TODO: Public option to disable running hooks - should be trivial but
1540
result = self._push_with_bound_branches(target, overwrite,
1542
_override_hook_source_branch=_override_hook_source_branch)
1547
def _push_with_bound_branches(self, target, overwrite,
1549
_override_hook_source_branch=None):
1550
"""Push from self into target, and into target's master if any.
1552
This is on the base BzrBranch class even though it doesn't support
1553
bound branches because the *target* might be bound.
1556
if _override_hook_source_branch:
1557
result.source_branch = _override_hook_source_branch
1558
for hook in Branch.hooks['post_push']:
1561
bound_location = target.get_bound_location()
1562
if bound_location and target.base != bound_location:
1563
# there is a master branch.
1565
# XXX: Why the second check? Is it even supported for a branch to
1566
# be bound to itself? -- mbp 20070507
1567
master_branch = target.get_master_branch()
1568
master_branch.lock_write()
1570
# push into the master from this branch.
1571
self._basic_push(master_branch, overwrite, stop_revision)
1572
# and push into the target branch from this. Note that we push from
1573
# this branch again, because its considered the highest bandwidth
1575
result = self._basic_push(target, overwrite, stop_revision)
1576
result.master_branch = master_branch
1577
result.local_branch = target
1581
master_branch.unlock()
1584
result = self._basic_push(target, overwrite, stop_revision)
1585
# TODO: Why set master_branch and local_branch if there's no
1586
# binding? Maybe cleaner to just leave them unset? -- mbp
1588
result.master_branch = target
1589
result.local_branch = None
1593
def _basic_push(self, target, overwrite, stop_revision):
1594
"""Basic implementation of push without bound branches or hooks.
1596
Must be called with self read locked and target write locked.
1598
result = PushResult()
1599
result.source_branch = self
1600
result.target_branch = target
1601
result.old_revno, result.old_revid = target.last_revision_info()
1603
target.update_revisions(self, stop_revision)
1604
except DivergedBranches:
1608
target.set_revision_history(self.revision_history())
1609
result.tag_conflicts = self.tags.merge_to(target.tags)
1610
result.new_revno, result.new_revid = target.last_revision_info()
1613
def get_parent(self):
1614
"""See Branch.get_parent."""
1616
assert self.base[-1] == '/'
1617
parent = self._get_parent_location()
1620
# This is an old-format absolute path to a local branch
1621
# turn it into a url
1622
if parent.startswith('/'):
1623
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1625
return urlutils.join(self.base[:-1], parent)
1626
except errors.InvalidURLJoin, e:
1627
raise errors.InaccessibleParent(parent, self.base)
2613
def get_stacked_on_url(self):
2614
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1629
2616
def set_push_location(self, location):
1630
2617
"""See Branch.set_push_location."""
1632
2619
'push_location', location,
1633
2620
store=_mod_config.STORE_LOCATION_NORECURSE)
1636
def set_parent(self, url):
1637
"""See Branch.set_parent."""
1638
# TODO: Maybe delete old location files?
1639
# URLs should never be unicode, even on the local fs,
1640
# FIXUP this and get_parent in a future branch format bump:
1641
# read and rewrite the file, and have the new format code read
1642
# using .get not .get_utf8. RBC 20060125
1644
if isinstance(url, unicode):
1646
url = url.encode('ascii')
1647
except UnicodeEncodeError:
1648
raise errors.InvalidURL(url,
1649
"Urls must be 7-bit ascii, "
1650
"use bzrlib.urlutils.escape")
1651
url = urlutils.relative_url(self.base, url)
1652
self._set_parent_location(url)
1654
2622
def _set_parent_location(self, url):
1655
2623
if url is None:
1656
self.control_files._transport.delete('parent')
1658
assert isinstance(url, str)
1659
self.control_files.put_bytes('parent', url + '\n')
1661
@deprecated_function(zero_nine)
1662
def tree_config(self):
1663
"""DEPRECATED; call get_config instead.
1664
TreeConfig has become part of BranchConfig."""
1665
return TreeConfig(self)
1668
class BzrBranch5(BzrBranch):
1669
"""A format 5 branch. This supports new features over plan branches.
1671
It has support for a master_branch which is the data for bound branches.
1679
super(BzrBranch5, self).__init__(_format=_format,
1680
_control_files=_control_files,
1682
_repository=_repository)
1685
def pull(self, source, overwrite=False, stop_revision=None,
1687
"""Pull from source into self, updating my master if any.
1689
:param run_hooks: Private parameter - if false, this branch
1690
is being called because it's the master of the primary branch,
1691
so it should not run its hooks.
1693
bound_location = self.get_bound_location()
1694
master_branch = None
1695
if bound_location and source.base != bound_location:
1696
# not pulling from master, so we need to update master.
1697
master_branch = self.get_master_branch()
1698
master_branch.lock_write()
1701
# pull from source into master.
1702
master_branch.pull(source, overwrite, stop_revision,
1704
return super(BzrBranch5, self).pull(source, overwrite,
1705
stop_revision, _hook_master=master_branch,
1706
run_hooks=run_hooks)
1709
master_branch.unlock()
1711
def get_bound_location(self):
1713
return self.control_files.get_utf8('bound').read()[:-1]
1714
except errors.NoSuchFile:
1718
def get_master_branch(self):
1719
"""Return the branch we are bound to.
1721
:return: Either a Branch, or None
1723
This could memoise the branch, but if thats done
1724
it must be revalidated on each new lock.
1725
So for now we just don't memoise it.
1726
# RBC 20060304 review this decision.
1728
bound_loc = self.get_bound_location()
1732
return Branch.open(bound_loc)
1733
except (errors.NotBranchError, errors.ConnectionError), e:
1734
raise errors.BoundBranchConnectionFailure(
1738
def set_bound_location(self, location):
1739
"""Set the target where this branch is bound to.
1741
:param location: URL to the target branch
1744
self.control_files.put_utf8('bound', location+'\n')
1747
self.control_files._transport.delete('bound')
2624
self._transport.delete('parent')
2626
self._transport.put_bytes('parent', url + '\n',
2627
mode=self.bzrdir._get_file_mode())
2631
"""If bound, unbind"""
2632
return self.set_bound_location(None)
1752
2634
@needs_write_lock
1753
2635
def bind(self, other):
1773
2655
# last_rev is not in the other_last_rev history, AND
1774
2656
# other_last_rev is not in our history, and do it without pulling
1775
2657
# history around
1776
last_rev = self.last_revision()
1777
if last_rev is not None:
1780
other_last_rev = other.last_revision()
1781
if other_last_rev is not None:
1782
# neither branch is new, we have to do some work to
1783
# ascertain diversion.
1784
remote_graph = other.repository.get_revision_graph(
1786
local_graph = self.repository.get_revision_graph(last_rev)
1787
if (last_rev not in remote_graph and
1788
other_last_rev not in local_graph):
1789
raise errors.DivergedBranches(self, other)
1792
2658
self.set_bound_location(other.base)
1796
"""If bound, unbind"""
1797
return self.set_bound_location(None)
1801
"""Synchronise this branch with the master branch if any.
2660
def get_bound_location(self):
2662
return self._transport.get_bytes('bound')[:-1]
2663
except errors.NoSuchFile:
2667
def get_master_branch(self, possible_transports=None):
2668
"""Return the branch we are bound to.
2670
:return: Either a Branch, or None
2672
if self._master_branch_cache is None:
2673
self._master_branch_cache = self._get_master_branch(
2674
possible_transports)
2675
return self._master_branch_cache
2677
def _get_master_branch(self, possible_transports):
2678
bound_loc = self.get_bound_location()
2682
return Branch.open(bound_loc,
2683
possible_transports=possible_transports)
2684
except (errors.NotBranchError, errors.ConnectionError), e:
2685
raise errors.BoundBranchConnectionFailure(
2689
def set_bound_location(self, location):
2690
"""Set the target where this branch is bound to.
2692
:param location: URL to the target branch
2694
self._master_branch_cache = None
2696
self._transport.put_bytes('bound', location+'\n',
2697
mode=self.bzrdir._get_file_mode())
2700
self._transport.delete('bound')
2701
except errors.NoSuchFile:
2706
def update(self, possible_transports=None):
2707
"""Synchronise this branch with the master branch if any.
1803
2709
:return: None or the last_revision that was pivoted out during the
1806
master = self.get_master_branch()
2712
master = self.get_master_branch(possible_transports)
1807
2713
if master is not None:
1808
old_tip = self.last_revision()
2714
old_tip = _mod_revision.ensure_null(self.last_revision())
1809
2715
self.pull(master, overwrite=True)
1810
if old_tip in self.repository.get_ancestry(self.last_revision()):
2716
if self.repository.get_graph().is_ancestor(old_tip,
2717
_mod_revision.ensure_null(self.last_revision())):
1816
class BzrBranchExperimental(BzrBranch5):
1817
"""Bzr experimental branch format
1820
- a revision-history file.
1822
- a lock dir guarding the branch itself
1823
- all of this stored in a branch/ subdirectory
1824
- works with shared repositories.
1825
- a tag dictionary in the branch
1827
This format is new in bzr 0.15, but shouldn't be used for real data,
1830
This class acts as it's own BranchFormat.
1833
_matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1836
def get_format_string(cls):
1837
"""See BranchFormat.get_format_string()."""
1838
return "Bazaar-NG branch format experimental\n"
1841
def get_format_description(cls):
1842
"""See BranchFormat.get_format_description()."""
1843
return "Experimental branch format"
1846
def get_reference(cls, a_bzrdir):
1847
"""Get the target reference of the branch in a_bzrdir.
1849
format probing must have been completed before calling
1850
this method - it is assumed that the format of the branch
1851
in a_bzrdir is correct.
1853
:param a_bzrdir: The bzrdir to get the branch data from.
1854
:return: None if the branch is not a reference branch.
1859
def _initialize_control_files(cls, a_bzrdir, utf8_files, lock_filename,
1861
branch_transport = a_bzrdir.get_branch_transport(cls)
1862
control_files = lockable_files.LockableFiles(branch_transport,
1863
lock_filename, lock_class)
1864
control_files.create_lock()
1865
control_files.lock_write()
1867
for filename, content in utf8_files:
1868
control_files.put_utf8(filename, content)
1870
control_files.unlock()
1873
def initialize(cls, a_bzrdir):
1874
"""Create a branch of this format in a_bzrdir."""
1875
utf8_files = [('format', cls.get_format_string()),
1876
('revision-history', ''),
1877
('branch-name', ''),
1880
cls._initialize_control_files(a_bzrdir, utf8_files,
1881
'lock', lockdir.LockDir)
1882
return cls.open(a_bzrdir, _found=True)
1885
def open(cls, a_bzrdir, _found=False):
1886
"""Return the branch object for a_bzrdir
1888
_found is a private parameter, do not use it. It is used to indicate
1889
if format probing has already be done.
1892
format = BranchFormat.find_format(a_bzrdir)
1893
assert format.__class__ == cls
1894
transport = a_bzrdir.get_branch_transport(None)
1895
control_files = lockable_files.LockableFiles(transport, 'lock',
1897
return cls(_format=cls,
1898
_control_files=control_files,
1900
_repository=a_bzrdir.find_repository())
1903
def is_supported(cls):
1906
def _make_tags(self):
1907
return BasicTags(self)
1910
def supports_tags(cls):
1914
BranchFormat.register_format(BzrBranchExperimental)
1917
class BzrBranch6(BzrBranch5):
1920
def last_revision_info(self):
1921
revision_string = self.control_files.get('last-revision').read()
2722
def _read_last_revision_info(self):
2723
revision_string = self._transport.get_bytes('last-revision')
1922
2724
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1923
2725
revision_id = cache_utf8.get_cached_utf8(revision_id)
1924
2726
revno = int(revno)
1925
2727
return revno, revision_id
1927
def last_revision(self):
1928
"""Return last revision id, or None"""
1929
revision_id = self.last_revision_info()[1]
1930
if revision_id == _mod_revision.NULL_REVISION:
1934
2729
def _write_last_revision_info(self, revno, revision_id):
1935
2730
"""Simply write out the revision id, with no checks.
1937
2732
Use set_last_revision_info to perform this safely.
1939
2734
Does not update the revision_history cache.
1940
Intended to be called by set_last_revision_info and
1941
_write_revision_history.
1943
if revision_id is None:
1944
revision_id = 'null:'
2736
revision_id = _mod_revision.ensure_null(revision_id)
1945
2737
out_string = '%d %s\n' % (revno, revision_id)
1946
self.control_files.put_bytes('last-revision', out_string)
2738
self._transport.put_bytes('last-revision', out_string,
2739
mode=self.bzrdir._get_file_mode())
2742
def update_feature_flags(self, updated_flags):
2743
"""Update the feature flags for this branch.
2745
:param updated_flags: Dictionary mapping feature names to necessities
2746
A necessity can be None to indicate the feature should be removed
2748
self._format._update_feature_flags(updated_flags)
2749
self.control_transport.put_bytes('format', self._format.as_string())
2752
class FullHistoryBzrBranch(BzrBranch):
2753
"""Bzr branch which contains the full revision history."""
1948
2755
@needs_write_lock
1949
2756
def set_last_revision_info(self, revno, revision_id):
1950
revision_id = osutils.safe_revision_id(revision_id)
1951
if self._get_append_revisions_only():
1952
self._check_history_violation(revision_id)
1953
self._write_last_revision_info(revno, revision_id)
2757
if not revision_id or not isinstance(revision_id, basestring):
2758
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2759
revision_id = _mod_revision.ensure_null(revision_id)
2760
# this old format stores the full history, but this api doesn't
2761
# provide it, so we must generate, and might as well check it's
2763
history = self._lefthand_history(revision_id)
2764
if len(history) != revno:
2765
raise AssertionError('%d != %d' % (len(history), revno))
2766
self._set_revision_history(history)
2768
def _read_last_revision_info(self):
2769
rh = self._revision_history()
2772
return (revno, rh[-1])
2774
return (0, _mod_revision.NULL_REVISION)
2776
@deprecated_method(deprecated_in((2, 4, 0)))
2778
def set_revision_history(self, rev_history):
2779
"""See Branch.set_revision_history."""
2780
self._set_revision_history(rev_history)
2782
def _set_revision_history(self, rev_history):
2783
if 'evil' in debug.debug_flags:
2784
mutter_callsite(3, "set_revision_history scales with history.")
2785
check_not_reserved_id = _mod_revision.check_not_reserved_id
2786
for rev_id in rev_history:
2787
check_not_reserved_id(rev_id)
2788
if Branch.hooks['post_change_branch_tip']:
2789
# Don't calculate the last_revision_info() if there are no hooks
2791
old_revno, old_revid = self.last_revision_info()
2792
if len(rev_history) == 0:
2793
revid = _mod_revision.NULL_REVISION
2795
revid = rev_history[-1]
2796
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2797
self._write_revision_history(rev_history)
1954
2798
self._clear_cached_state()
2799
self._cache_revision_history(rev_history)
2800
for hook in Branch.hooks['set_rh']:
2801
hook(self, rev_history)
2802
if Branch.hooks['post_change_branch_tip']:
2803
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2805
def _write_revision_history(self, history):
2806
"""Factored out of set_revision_history.
2808
This performs the actual writing to disk.
2809
It is intended to be called by set_revision_history."""
2810
self._transport.put_bytes(
2811
'revision-history', '\n'.join(history),
2812
mode=self.bzrdir._get_file_mode())
2814
def _gen_revision_history(self):
2815
history = self._transport.get_bytes('revision-history').split('\n')
2816
if history[-1:] == ['']:
2817
# There shouldn't be a trailing newline, but just in case.
2821
def _synchronize_history(self, destination, revision_id):
2822
if not isinstance(destination, FullHistoryBzrBranch):
2823
super(BzrBranch, self)._synchronize_history(
2824
destination, revision_id)
2826
if revision_id == _mod_revision.NULL_REVISION:
2829
new_history = self._revision_history()
2830
if revision_id is not None and new_history != []:
2832
new_history = new_history[:new_history.index(revision_id) + 1]
2834
rev = self.repository.get_revision(revision_id)
2835
new_history = rev.get_history(self.repository)[1:]
2836
destination._set_revision_history(new_history)
2839
def generate_revision_history(self, revision_id, last_rev=None,
2841
"""Create a new revision history that will finish with revision_id.
2843
:param revision_id: the new tip to use.
2844
:param last_rev: The previous last_revision. If not None, then this
2845
must be a ancestory of revision_id, or DivergedBranches is raised.
2846
:param other_branch: The other branch that DivergedBranches should
2847
raise with respect to.
2849
self._set_revision_history(self._lefthand_history(revision_id,
2850
last_rev, other_branch))
2853
class BzrBranch5(FullHistoryBzrBranch):
2854
"""A format 5 branch. This supports new features over plain branches.
2856
It has support for a master_branch which is the data for bound branches.
2860
class BzrBranch8(BzrBranch):
2861
"""A branch that stores tree-reference locations."""
2863
def _open_hook(self, possible_transports=None):
2864
if self._ignore_fallbacks:
2866
if possible_transports is None:
2867
possible_transports = [self.bzrdir.root_transport]
2869
url = self.get_stacked_on_url()
2870
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2871
errors.UnstackableBranchFormat):
2874
for hook in Branch.hooks['transform_fallback_location']:
2875
url = hook(self, url)
2877
hook_name = Branch.hooks.get_hook_name(hook)
2878
raise AssertionError(
2879
"'transform_fallback_location' hook %s returned "
2880
"None, not a URL." % hook_name)
2881
self._activate_fallback_location(url,
2882
possible_transports=possible_transports)
2884
def __init__(self, *args, **kwargs):
2885
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2886
super(BzrBranch8, self).__init__(*args, **kwargs)
2887
self._last_revision_info_cache = None
2888
self._reference_info = None
2890
def _clear_cached_state(self):
2891
super(BzrBranch8, self)._clear_cached_state()
2892
self._last_revision_info_cache = None
2893
self._reference_info = None
1956
2895
def _check_history_violation(self, revision_id):
1957
last_revision = self.last_revision()
1958
if last_revision is None:
2896
current_revid = self.last_revision()
2897
last_revision = _mod_revision.ensure_null(current_revid)
2898
if _mod_revision.is_null(last_revision):
1960
if last_revision not in self._lefthand_history(revision_id):
1961
raise errors.AppendRevisionsOnlyViolation(self.base)
2900
graph = self.repository.get_graph()
2901
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2902
if lh_ancestor == current_revid:
2904
raise errors.AppendRevisionsOnlyViolation(self.user_url)
1963
2906
def _gen_revision_history(self):
1964
2907
"""Generate the revision history from last revision
1966
history = list(self.repository.iter_reverse_revision_history(
1967
self.last_revision()))
1971
def _write_revision_history(self, history):
1972
"""Factored out of set_revision_history.
1974
This performs the actual writing to disk, with format-specific checks.
1975
It is intended to be called by BzrBranch5.set_revision_history.
1977
if len(history) == 0:
1978
last_revision = 'null:'
1980
if history != self._lefthand_history(history[-1]):
1981
raise errors.NotLefthandHistory(history)
1982
last_revision = history[-1]
1983
if self._get_append_revisions_only():
1984
self._check_history_violation(last_revision)
1985
self._write_last_revision_info(len(history), last_revision)
1988
def append_revision(self, *revision_ids):
1989
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1990
if len(revision_ids) == 0:
1992
prev_revno, prev_revision = self.last_revision_info()
1993
for revision in self.repository.get_revisions(revision_ids):
1994
if prev_revision == _mod_revision.NULL_REVISION:
1995
if revision.parent_ids != []:
1996
raise errors.NotLeftParentDescendant(self, prev_revision,
1997
revision.revision_id)
1999
if revision.parent_ids[0] != prev_revision:
2000
raise errors.NotLeftParentDescendant(self, prev_revision,
2001
revision.revision_id)
2002
prev_revision = revision.revision_id
2003
self.set_last_revision_info(prev_revno + len(revision_ids),
2909
last_revno, last_revision = self.last_revision_info()
2910
self._extend_partial_history(stop_index=last_revno-1)
2911
return list(reversed(self._partial_revision_history_cache))
2006
2913
@needs_write_lock
2007
2914
def _set_parent_location(self, url):
2013
2920
"""Set the parent branch"""
2014
2921
return self._get_config_location('parent_location')
2924
def _set_all_reference_info(self, info_dict):
2925
"""Replace all reference info stored in a branch.
2927
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2930
writer = rio.RioWriter(s)
2931
for key, (tree_path, branch_location) in info_dict.iteritems():
2932
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2933
branch_location=branch_location)
2934
writer.write_stanza(stanza)
2935
self._transport.put_bytes('references', s.getvalue())
2936
self._reference_info = info_dict
2939
def _get_all_reference_info(self):
2940
"""Return all the reference info stored in a branch.
2942
:return: A dict of {file_id: (tree_path, branch_location)}
2944
if self._reference_info is not None:
2945
return self._reference_info
2946
rio_file = self._transport.get('references')
2948
stanzas = rio.read_stanzas(rio_file)
2949
info_dict = dict((s['file_id'], (s['tree_path'],
2950
s['branch_location'])) for s in stanzas)
2953
self._reference_info = info_dict
2956
def set_reference_info(self, file_id, tree_path, branch_location):
2957
"""Set the branch location to use for a tree reference.
2959
:param file_id: The file-id of the tree reference.
2960
:param tree_path: The path of the tree reference in the tree.
2961
:param branch_location: The location of the branch to retrieve tree
2964
info_dict = self._get_all_reference_info()
2965
info_dict[file_id] = (tree_path, branch_location)
2966
if None in (tree_path, branch_location):
2967
if tree_path is not None:
2968
raise ValueError('tree_path must be None when branch_location'
2970
if branch_location is not None:
2971
raise ValueError('branch_location must be None when tree_path'
2973
del info_dict[file_id]
2974
self._set_all_reference_info(info_dict)
2976
def get_reference_info(self, file_id):
2977
"""Get the tree_path and branch_location for a tree reference.
2979
:return: a tuple of (tree_path, branch_location)
2981
return self._get_all_reference_info().get(file_id, (None, None))
2983
def reference_parent(self, file_id, path, possible_transports=None):
2984
"""Return the parent branch for a tree-reference file_id.
2986
:param file_id: The file_id of the tree reference
2987
:param path: The path of the file_id in the tree
2988
:return: A branch associated with the file_id
2990
branch_location = self.get_reference_info(file_id)[1]
2991
if branch_location is None:
2992
return Branch.reference_parent(self, file_id, path,
2993
possible_transports)
2994
branch_location = urlutils.join(self.user_url, branch_location)
2995
return Branch.open(branch_location,
2996
possible_transports=possible_transports)
2016
2998
def set_push_location(self, location):
2017
2999
"""See Branch.set_push_location."""
2018
3000
self._set_config_location('push_location', location)
2020
3002
def set_bound_location(self, location):
2021
3003
"""See Branch.set_push_location."""
3004
self._master_branch_cache = None
2023
config = self.get_config()
3006
conf = self.get_config_stack()
2024
3007
if location is None:
2025
if config.get_user_option('bound') != 'True':
3008
if not conf.get('bound'):
2028
config.set_user_option('bound', 'False')
3011
conf.set('bound', 'False')
2031
3014
self._set_config_location('bound_location', location,
2033
config.set_user_option('bound', 'True')
3016
conf.set('bound', 'True')
2036
3019
def _get_bound_location(self, bound):
2037
3020
"""Return the bound location in the config file.
2039
3022
Return None if the bound parameter does not match"""
2040
config = self.get_config()
2041
config_bound = (config.get_user_option('bound') == 'True')
2042
if config_bound != bound:
3023
conf = self.get_config_stack()
3024
if conf.get('bound') != bound:
2044
return self._get_config_location('bound_location', config=config)
3026
return self._get_config_location('bound_location', config=conf)
2046
3028
def get_bound_location(self):
2047
"""See Branch.set_push_location."""
3029
"""See Branch.get_bound_location."""
2048
3030
return self._get_bound_location(True)
2050
3032
def get_old_bound_location(self):
2051
3033
"""See Branch.get_old_bound_location"""
2052
3034
return self._get_bound_location(False)
2054
def set_append_revisions_only(self, enabled):
2059
self.get_config().set_user_option('append_revisions_only', value)
2061
def _get_append_revisions_only(self):
2062
value = self.get_config().get_user_option('append_revisions_only')
2063
return value == 'True'
2065
def _synchronize_history(self, destination, revision_id):
2066
"""Synchronize last revision and revision history between branches.
2068
This version is most efficient when the destination is also a
2069
BzrBranch6, but works for BzrBranch5, as long as the destination's
2070
repository contains all the lefthand ancestors of the intended
2071
last_revision. If not, set_last_revision_info will fail.
2073
:param destination: The branch to copy the history into
2074
:param revision_id: The revision-id to truncate history at. May
2075
be None to copy complete history.
2077
if revision_id is None:
2078
revno, revision_id = self.last_revision_info()
2080
revno = self.revision_id_to_revno(revision_id)
2081
destination.set_last_revision_info(revno, revision_id)
2083
def _make_tags(self):
2084
return BasicTags(self)
2087
class BranchTestProviderAdapter(object):
2088
"""A tool to generate a suite testing multiple branch formats at once.
2090
This is done by copying the test once for each transport and injecting
2091
the transport_server, transport_readonly_server, and branch_format
2092
classes into each copy. Each copy is also given a new id() to make it
3036
def get_stacked_on_url(self):
3037
# you can always ask for the URL; but you might not be able to use it
3038
# if the repo can't support stacking.
3039
## self._check_stackable_repo()
3040
# stacked_on_location is only ever defined in branch.conf, so don't
3041
# waste effort reading the whole stack of config files.
3042
conf = _mod_config.BranchOnlyStack(self)
3043
stacked_url = self._get_config_location('stacked_on_location',
3045
if stacked_url is None:
3046
raise errors.NotStacked(self)
3047
return stacked_url.encode('utf-8')
3050
def get_rev_id(self, revno, history=None):
3051
"""Find the revision id of the specified revno."""
3053
return _mod_revision.NULL_REVISION
3055
last_revno, last_revision_id = self.last_revision_info()
3056
if revno <= 0 or revno > last_revno:
3057
raise errors.NoSuchRevision(self, revno)
3059
if history is not None:
3060
return history[revno - 1]
3062
index = last_revno - revno
3063
if len(self._partial_revision_history_cache) <= index:
3064
self._extend_partial_history(stop_index=index)
3065
if len(self._partial_revision_history_cache) > index:
3066
return self._partial_revision_history_cache[index]
3068
raise errors.NoSuchRevision(self, revno)
3071
def revision_id_to_revno(self, revision_id):
3072
"""Given a revision id, return its revno"""
3073
if _mod_revision.is_null(revision_id):
3076
index = self._partial_revision_history_cache.index(revision_id)
3079
self._extend_partial_history(stop_revision=revision_id)
3080
except errors.RevisionNotPresent, e:
3081
raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
3082
index = len(self._partial_revision_history_cache) - 1
3084
raise errors.NoSuchRevision(self, revision_id)
3085
if self._partial_revision_history_cache[index] != revision_id:
3086
raise errors.NoSuchRevision(self, revision_id)
3087
return self.revno() - index
3090
class BzrBranch7(BzrBranch8):
3091
"""A branch with support for a fallback repository."""
3093
def set_reference_info(self, file_id, tree_path, branch_location):
3094
Branch.set_reference_info(self, file_id, tree_path, branch_location)
3096
def get_reference_info(self, file_id):
3097
Branch.get_reference_info(self, file_id)
3099
def reference_parent(self, file_id, path, possible_transports=None):
3100
return Branch.reference_parent(self, file_id, path,
3101
possible_transports)
3104
class BzrBranch6(BzrBranch7):
3105
"""See BzrBranchFormat6 for the capabilities of this branch.
3107
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2096
def __init__(self, transport_server, transport_readonly_server, formats,
2097
vfs_transport_factory=None):
2098
self._transport_server = transport_server
2099
self._transport_readonly_server = transport_readonly_server
2100
self._formats = formats
2102
def adapt(self, test):
2103
result = TestSuite()
2104
for branch_format, bzrdir_format in self._formats:
2105
new_test = deepcopy(test)
2106
new_test.transport_server = self._transport_server
2107
new_test.transport_readonly_server = self._transport_readonly_server
2108
new_test.bzrdir_format = bzrdir_format
2109
new_test.branch_format = branch_format
2110
def make_new_test_id():
2111
# the format can be either a class or an instance
2112
name = getattr(branch_format, '__name__',
2113
branch_format.__class__.__name__)
2114
new_id = "%s(%s)" % (new_test.id(), name)
2115
return lambda: new_id
2116
new_test.id = make_new_test_id()
2117
result.addTest(new_test)
3111
def get_stacked_on_url(self):
3112
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2121
3115
######################################################################
2139
3133
:ivar new_revno: Revision number after pull.
2140
3134
:ivar old_revid: Tip revision id before pull.
2141
3135
:ivar new_revid: Tip revision id after pull.
2142
:ivar source_branch: Source (local) branch object.
2143
:ivar master_branch: Master branch of the target, or None.
2144
:ivar target_branch: Target/destination branch object.
3136
:ivar source_branch: Source (local) branch object. (read locked)
3137
:ivar master_branch: Master branch of the target, or the target if no
3139
:ivar local_branch: target branch if there is a Master, else None
3140
:ivar target_branch: Target/destination branch object. (write locked)
3141
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3142
:ivar tag_updates: A dict with new tags, see BasicTags.merge_to
3145
@deprecated_method(deprecated_in((2, 3, 0)))
2147
3146
def __int__(self):
2148
# DEPRECATED: pull used to return the change in revno
3147
"""Return the relative change in revno.
3149
:deprecated: Use `new_revno` and `old_revno` instead.
2149
3151
return self.new_revno - self.old_revno
2151
3153
def report(self, to_file):
2152
if self.old_revid == self.new_revid:
2153
to_file.write('No revisions to pull.\n')
2155
to_file.write('Now on revision %d.\n' % self.new_revno)
3154
tag_conflicts = getattr(self, "tag_conflicts", None)
3155
tag_updates = getattr(self, "tag_updates", None)
3157
if self.old_revid != self.new_revid:
3158
to_file.write('Now on revision %d.\n' % self.new_revno)
3160
to_file.write('%d tag(s) updated.\n' % len(tag_updates))
3161
if self.old_revid == self.new_revid and not tag_updates:
3162
if not tag_conflicts:
3163
to_file.write('No revisions or tags to pull.\n')
3165
to_file.write('No revisions to pull.\n')
2156
3166
self._show_tag_conficts(to_file)
2159
class PushResult(_Result):
3169
class BranchPushResult(_Result):
2160
3170
"""Result of a Branch.push operation.
2162
:ivar old_revno: Revision number before push.
2163
:ivar new_revno: Revision number after push.
2164
:ivar old_revid: Tip revision id before push.
2165
:ivar new_revid: Tip revision id after push.
2166
:ivar source_branch: Source branch object.
2167
:ivar master_branch: Master branch of the target, or None.
2168
:ivar target_branch: Target/destination branch object.
3172
:ivar old_revno: Revision number (eg 10) of the target before push.
3173
:ivar new_revno: Revision number (eg 12) of the target after push.
3174
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3176
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3178
:ivar source_branch: Source branch object that the push was from. This is
3179
read locked, and generally is a local (and thus low latency) branch.
3180
:ivar master_branch: If target is a bound branch, the master branch of
3181
target, or target itself. Always write locked.
3182
:ivar target_branch: The direct Branch where data is being sent (write
3184
:ivar local_branch: If the target is a bound branch this will be the
3185
target, otherwise it will be None.
3188
@deprecated_method(deprecated_in((2, 3, 0)))
2171
3189
def __int__(self):
2172
# DEPRECATED: push used to return the change in revno
3190
"""Return the relative change in revno.
3192
:deprecated: Use `new_revno` and `old_revno` instead.
2173
3194
return self.new_revno - self.old_revno
2175
3196
def report(self, to_file):
2176
"""Write a human-readable description of the result."""
2177
if self.old_revid == self.new_revid:
2178
to_file.write('No new revisions to push.\n')
2180
to_file.write('Pushed up to revision %d.\n' % self.new_revno)
3197
# TODO: This function gets passed a to_file, but then
3198
# ignores it and calls note() instead. This is also
3199
# inconsistent with PullResult(), which writes to stdout.
3200
# -- JRV20110901, bug #838853
3201
tag_conflicts = getattr(self, "tag_conflicts", None)
3202
tag_updates = getattr(self, "tag_updates", None)
3204
if self.old_revid != self.new_revid:
3205
note(gettext('Pushed up to revision %d.') % self.new_revno)
3207
note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
3208
if self.old_revid == self.new_revid and not tag_updates:
3209
if not tag_conflicts:
3210
note(gettext('No new revisions or tags to push.'))
3212
note(gettext('No new revisions to push.'))
2181
3213
self._show_tag_conficts(to_file)
2219
3253
new_branch.tags._set_tag_dict({})
2221
3255
# Copying done; now update target format
2222
new_branch.control_files.put_utf8('format',
2223
format.get_format_string())
3256
new_branch._transport.put_bytes('format',
3258
mode=new_branch.bzrdir._get_file_mode())
2225
3260
# Clean up old files
2226
new_branch.control_files._transport.delete('revision-history')
3261
new_branch._transport.delete('revision-history')
2228
3263
branch.set_parent(None)
3264
except errors.NoSuchFile:
2231
3266
branch.set_bound_location(None)
3269
class Converter6to7(object):
3270
"""Perform an in-place upgrade of format 6 to format 7"""
3272
def convert(self, branch):
3273
format = BzrBranchFormat7()
3274
branch._set_config_location('stacked_on_location', '')
3275
# update target format
3276
branch._transport.put_bytes('format', format.as_string())
3279
class Converter7to8(object):
3280
"""Perform an in-place upgrade of format 7 to format 8"""
3282
def convert(self, branch):
3283
format = BzrBranchFormat8()
3284
branch._transport.put_bytes('references', '')
3285
# update target format
3286
branch._transport.put_bytes('format', format.as_string())
3289
class InterBranch(InterObject):
3290
"""This class represents operations taking place between two branches.
3292
Its instances have methods like pull() and push() and contain
3293
references to the source and target repositories these operations
3294
can be carried out on.
3298
"""The available optimised InterBranch types."""
3301
def _get_branch_formats_to_test(klass):
3302
"""Return an iterable of format tuples for testing.
3304
:return: An iterable of (from_format, to_format) to use when testing
3305
this InterBranch class. Each InterBranch class should define this
3308
raise NotImplementedError(klass._get_branch_formats_to_test)
3311
def pull(self, overwrite=False, stop_revision=None,
3312
possible_transports=None, local=False):
3313
"""Mirror source into target branch.
3315
The target branch is considered to be 'local', having low latency.
3317
:returns: PullResult instance
3319
raise NotImplementedError(self.pull)
3322
def push(self, overwrite=False, stop_revision=None, lossy=False,
3323
_override_hook_source_branch=None):
3324
"""Mirror the source branch into the target branch.
3326
The source branch is considered to be 'local', having low latency.
3328
raise NotImplementedError(self.push)
3331
def copy_content_into(self, revision_id=None):
3332
"""Copy the content of source into target
3334
revision_id: if not None, the revision history in the new branch will
3335
be truncated to end with revision_id.
3337
raise NotImplementedError(self.copy_content_into)
3340
def fetch(self, stop_revision=None, limit=None):
3343
:param stop_revision: Last revision to fetch
3344
:param limit: Optional rough limit of revisions to fetch
3346
raise NotImplementedError(self.fetch)
3349
class GenericInterBranch(InterBranch):
3350
"""InterBranch implementation that uses public Branch functions."""
3353
def is_compatible(klass, source, target):
3354
# GenericBranch uses the public API, so always compatible
3358
def _get_branch_formats_to_test(klass):
3359
return [(format_registry.get_default(), format_registry.get_default())]
3362
def unwrap_format(klass, format):
3363
if isinstance(format, remote.RemoteBranchFormat):
3364
format._ensure_real()
3365
return format._custom_format
3369
def copy_content_into(self, revision_id=None):
3370
"""Copy the content of source into target
3372
revision_id: if not None, the revision history in the new branch will
3373
be truncated to end with revision_id.
3375
self.source.update_references(self.target)
3376
self.source._synchronize_history(self.target, revision_id)
3378
parent = self.source.get_parent()
3379
except errors.InaccessibleParent, e:
3380
mutter('parent was not accessible to copy: %s', e)
3383
self.target.set_parent(parent)
3384
if self.source._push_should_merge_tags():
3385
self.source.tags.merge_to(self.target.tags)
3388
def fetch(self, stop_revision=None, limit=None):
3389
if self.target.base == self.source.base:
3391
self.source.lock_read()
3393
fetch_spec_factory = fetch.FetchSpecFactory()
3394
fetch_spec_factory.source_branch = self.source
3395
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3396
fetch_spec_factory.source_repo = self.source.repository
3397
fetch_spec_factory.target_repo = self.target.repository
3398
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3399
fetch_spec_factory.limit = limit
3400
fetch_spec = fetch_spec_factory.make_fetch_spec()
3401
return self.target.repository.fetch(self.source.repository,
3402
fetch_spec=fetch_spec)
3404
self.source.unlock()
3407
def _update_revisions(self, stop_revision=None, overwrite=False,
3409
other_revno, other_last_revision = self.source.last_revision_info()
3410
stop_revno = None # unknown
3411
if stop_revision is None:
3412
stop_revision = other_last_revision
3413
if _mod_revision.is_null(stop_revision):
3414
# if there are no commits, we're done.
3416
stop_revno = other_revno
3418
# what's the current last revision, before we fetch [and change it
3420
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3421
# we fetch here so that we don't process data twice in the common
3422
# case of having something to pull, and so that the check for
3423
# already merged can operate on the just fetched graph, which will
3424
# be cached in memory.
3425
self.fetch(stop_revision=stop_revision)
3426
# Check to see if one is an ancestor of the other
3429
graph = self.target.repository.get_graph()
3430
if self.target._check_if_descendant_or_diverged(
3431
stop_revision, last_rev, graph, self.source):
3432
# stop_revision is a descendant of last_rev, but we aren't
3433
# overwriting, so we're done.
3435
if stop_revno is None:
3437
graph = self.target.repository.get_graph()
3438
this_revno, this_last_revision = \
3439
self.target.last_revision_info()
3440
stop_revno = graph.find_distance_to_null(stop_revision,
3441
[(other_last_revision, other_revno),
3442
(this_last_revision, this_revno)])
3443
self.target.set_last_revision_info(stop_revno, stop_revision)
3446
def pull(self, overwrite=False, stop_revision=None,
3447
possible_transports=None, run_hooks=True,
3448
_override_hook_target=None, local=False):
3449
"""Pull from source into self, updating my master if any.
3451
:param run_hooks: Private parameter - if false, this branch
3452
is being called because it's the master of the primary branch,
3453
so it should not run its hooks.
3455
bound_location = self.target.get_bound_location()
3456
if local and not bound_location:
3457
raise errors.LocalRequiresBoundBranch()
3458
master_branch = None
3459
source_is_master = False
3461
# bound_location comes from a config file, some care has to be
3462
# taken to relate it to source.user_url
3463
normalized = urlutils.normalize_url(bound_location)
3465
relpath = self.source.user_transport.relpath(normalized)
3466
source_is_master = (relpath == '')
3467
except (errors.PathNotChild, errors.InvalidURL):
3468
source_is_master = False
3469
if not local and bound_location and not source_is_master:
3470
# not pulling from master, so we need to update master.
3471
master_branch = self.target.get_master_branch(possible_transports)
3472
master_branch.lock_write()
3475
# pull from source into master.
3476
master_branch.pull(self.source, overwrite, stop_revision,
3478
return self._pull(overwrite,
3479
stop_revision, _hook_master=master_branch,
3480
run_hooks=run_hooks,
3481
_override_hook_target=_override_hook_target,
3482
merge_tags_to_master=not source_is_master)
3485
master_branch.unlock()
3487
def push(self, overwrite=False, stop_revision=None, lossy=False,
3488
_override_hook_source_branch=None):
3489
"""See InterBranch.push.
3491
This is the basic concrete implementation of push()
3493
:param _override_hook_source_branch: If specified, run the hooks
3494
passing this Branch as the source, rather than self. This is for
3495
use of RemoteBranch, where push is delegated to the underlying
3499
raise errors.LossyPushToSameVCS(self.source, self.target)
3500
# TODO: Public option to disable running hooks - should be trivial but
3503
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3504
op.add_cleanup(self.source.lock_read().unlock)
3505
op.add_cleanup(self.target.lock_write().unlock)
3506
return op.run(overwrite, stop_revision,
3507
_override_hook_source_branch=_override_hook_source_branch)
3509
def _basic_push(self, overwrite, stop_revision):
3510
"""Basic implementation of push without bound branches or hooks.
3512
Must be called with source read locked and target write locked.
3514
result = BranchPushResult()
3515
result.source_branch = self.source
3516
result.target_branch = self.target
3517
result.old_revno, result.old_revid = self.target.last_revision_info()
3518
self.source.update_references(self.target)
3519
if result.old_revid != stop_revision:
3520
# We assume that during 'push' this repository is closer than
3522
graph = self.source.repository.get_graph(self.target.repository)
3523
self._update_revisions(stop_revision, overwrite=overwrite,
3525
if self.source._push_should_merge_tags():
3526
result.tag_updates, result.tag_conflicts = (
3527
self.source.tags.merge_to(self.target.tags, overwrite))
3528
result.new_revno, result.new_revid = self.target.last_revision_info()
3531
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3532
_override_hook_source_branch=None):
3533
"""Push from source into target, and into target's master if any.
3536
if _override_hook_source_branch:
3537
result.source_branch = _override_hook_source_branch
3538
for hook in Branch.hooks['post_push']:
3541
bound_location = self.target.get_bound_location()
3542
if bound_location and self.target.base != bound_location:
3543
# there is a master branch.
3545
# XXX: Why the second check? Is it even supported for a branch to
3546
# be bound to itself? -- mbp 20070507
3547
master_branch = self.target.get_master_branch()
3548
master_branch.lock_write()
3549
operation.add_cleanup(master_branch.unlock)
3550
# push into the master from the source branch.
3551
master_inter = InterBranch.get(self.source, master_branch)
3552
master_inter._basic_push(overwrite, stop_revision)
3553
# and push into the target branch from the source. Note that
3554
# we push from the source branch again, because it's considered
3555
# the highest bandwidth repository.
3556
result = self._basic_push(overwrite, stop_revision)
3557
result.master_branch = master_branch
3558
result.local_branch = self.target
3560
master_branch = None
3562
result = self._basic_push(overwrite, stop_revision)
3563
# TODO: Why set master_branch and local_branch if there's no
3564
# binding? Maybe cleaner to just leave them unset? -- mbp
3566
result.master_branch = self.target
3567
result.local_branch = None
3571
def _pull(self, overwrite=False, stop_revision=None,
3572
possible_transports=None, _hook_master=None, run_hooks=True,
3573
_override_hook_target=None, local=False,
3574
merge_tags_to_master=True):
3577
This function is the core worker, used by GenericInterBranch.pull to
3578
avoid duplication when pulling source->master and source->local.
3580
:param _hook_master: Private parameter - set the branch to
3581
be supplied as the master to pull hooks.
3582
:param run_hooks: Private parameter - if false, this branch
3583
is being called because it's the master of the primary branch,
3584
so it should not run its hooks.
3585
is being called because it's the master of the primary branch,
3586
so it should not run its hooks.
3587
:param _override_hook_target: Private parameter - set the branch to be
3588
supplied as the target_branch to pull hooks.
3589
:param local: Only update the local branch, and not the bound branch.
3591
# This type of branch can't be bound.
3593
raise errors.LocalRequiresBoundBranch()
3594
result = PullResult()
3595
result.source_branch = self.source
3596
if _override_hook_target is None:
3597
result.target_branch = self.target
3599
result.target_branch = _override_hook_target
3600
self.source.lock_read()
3602
# We assume that during 'pull' the target repository is closer than
3604
self.source.update_references(self.target)
3605
graph = self.target.repository.get_graph(self.source.repository)
3606
# TODO: Branch formats should have a flag that indicates
3607
# that revno's are expensive, and pull() should honor that flag.
3609
result.old_revno, result.old_revid = \
3610
self.target.last_revision_info()
3611
self._update_revisions(stop_revision, overwrite=overwrite,
3613
# TODO: The old revid should be specified when merging tags,
3614
# so a tags implementation that versions tags can only
3615
# pull in the most recent changes. -- JRV20090506
3616
result.tag_updates, result.tag_conflicts = (
3617
self.source.tags.merge_to(self.target.tags, overwrite,
3618
ignore_master=not merge_tags_to_master))
3619
result.new_revno, result.new_revid = self.target.last_revision_info()
3621
result.master_branch = _hook_master
3622
result.local_branch = result.target_branch
3624
result.master_branch = result.target_branch
3625
result.local_branch = None
3627
for hook in Branch.hooks['post_pull']:
3630
self.source.unlock()
3634
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
