1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20
from bzrlib.lazy_import import lazy_import
21
lazy_import(globals(), """
22
from itertools import chain
26
config as _mod_config,
32
revision as _mod_revision,
38
from bzrlib.config import BranchConfig
39
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
40
from bzrlib.tag import (
46
from bzrlib.decorators import needs_read_lock, needs_write_lock
47
from bzrlib.hooks import Hooks
48
from bzrlib.inter import InterObject
49
from bzrlib import registry
50
from bzrlib.symbol_versioning import (
54
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
57
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
58
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
59
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
62
# TODO: Maybe include checks for common corruption of newlines, etc?
64
# TODO: Some operations like log might retrieve the same revisions
65
# repeatedly to calculate deltas. We could perhaps have a weakref
66
# cache in memory to make this faster. In general anything can be
67
# cached in memory between lock and unlock operations. .. nb thats
68
# what the transaction identity map provides
71
######################################################################
75
"""Branch holding a history of revisions.
78
Base directory/url of the branch.
80
hooks: An instance of BranchHooks.
82
# this is really an instance variable - FIXME move it there
86
# override this to set the strategy for storing tags
88
return DisabledTags(self)
90
def __init__(self, *ignored, **ignored_too):
91
self.tags = self._make_tags()
92
self._revision_history_cache = None
93
self._revision_id_to_revno_cache = None
94
self._partial_revision_id_to_revno_cache = {}
95
self._last_revision_info_cache = None
96
self._merge_sorted_revisions_cache = None
98
hooks = Branch.hooks['open']
102
def _open_hook(self):
103
"""Called by init to allow simpler extension of the base class."""
105
def break_lock(self):
106
"""Break a lock if one is present from another instance.
108
Uses the ui factory to ask for confirmation if the lock may be from
111
This will probe the repository for its lock as well.
113
self.control_files.break_lock()
114
self.repository.break_lock()
115
master = self.get_master_branch()
116
if master is not None:
120
def open(base, _unsupported=False, possible_transports=None):
121
"""Open the branch rooted at base.
123
For instance, if the branch is at URL/.bzr/branch,
124
Branch.open(URL) -> a Branch instance.
126
control = bzrdir.BzrDir.open(base, _unsupported,
127
possible_transports=possible_transports)
128
return control.open_branch(_unsupported)
131
def open_from_transport(transport, _unsupported=False):
132
"""Open the branch rooted at transport"""
133
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
134
return control.open_branch(_unsupported)
137
def open_containing(url, possible_transports=None):
138
"""Open an existing branch which contains url.
140
This probes for a branch at url, and searches upwards from there.
142
Basically we keep looking up until we find the control directory or
143
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
145
format, UnknownFormatError or UnsupportedFormatError are raised.
146
If there is one, it is returned, along with the unused portion of url.
148
control, relpath = bzrdir.BzrDir.open_containing(url,
150
return control.open_branch(), relpath
152
def _push_should_merge_tags(self):
153
"""Should _basic_push merge this branch's tags into the target?
155
The default implementation returns False if this branch has no tags,
156
and True the rest of the time. Subclasses may override this.
158
return self.tags.supports_tags() and self.tags.get_tag_dict()
160
def get_config(self):
161
return BranchConfig(self)
163
def _get_nick(self, local=False, possible_transports=None):
164
config = self.get_config()
165
# explicit overrides master, but don't look for master if local is True
166
if not local and not config.has_explicit_nickname():
168
master = self.get_master_branch(possible_transports)
169
if master is not None:
170
# return the master branch value
172
except errors.BzrError, e:
173
# Silently fall back to local implicit nick if the master is
175
mutter("Could not connect to bound branch, "
176
"falling back to local nick.\n " + str(e))
177
return config.get_nickname()
179
def _set_nick(self, nick):
180
self.get_config().set_user_option('nickname', nick, warn_masked=True)
182
nick = property(_get_nick, _set_nick)
185
raise NotImplementedError(self.is_locked)
187
def _lefthand_history(self, revision_id, last_rev=None,
189
if 'evil' in debug.debug_flags:
190
mutter_callsite(4, "_lefthand_history scales with history.")
191
# stop_revision must be a descendant of last_revision
192
graph = self.repository.get_graph()
193
if last_rev is not None:
194
if not graph.is_ancestor(last_rev, revision_id):
195
# our previous tip is not merged into stop_revision
196
raise errors.DivergedBranches(self, other_branch)
197
# make a new revision history from the graph
198
parents_map = graph.get_parent_map([revision_id])
199
if revision_id not in parents_map:
200
raise errors.NoSuchRevision(self, revision_id)
201
current_rev_id = revision_id
203
check_not_reserved_id = _mod_revision.check_not_reserved_id
204
# Do not include ghosts or graph origin in revision_history
205
while (current_rev_id in parents_map and
206
len(parents_map[current_rev_id]) > 0):
207
check_not_reserved_id(current_rev_id)
208
new_history.append(current_rev_id)
209
current_rev_id = parents_map[current_rev_id][0]
210
parents_map = graph.get_parent_map([current_rev_id])
211
new_history.reverse()
214
def lock_write(self):
215
raise NotImplementedError(self.lock_write)
218
raise NotImplementedError(self.lock_read)
221
raise NotImplementedError(self.unlock)
223
def peek_lock_mode(self):
224
"""Return lock mode for the Branch: 'r', 'w' or None"""
225
raise NotImplementedError(self.peek_lock_mode)
227
def get_physical_lock_status(self):
228
raise NotImplementedError(self.get_physical_lock_status)
231
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
232
"""Return the revision_id for a dotted revno.
234
:param revno: a tuple like (1,) or (1,1,2)
235
:param _cache_reverse: a private parameter enabling storage
236
of the reverse mapping in a top level cache. (This should
237
only be done in selective circumstances as we want to
238
avoid having the mapping cached multiple times.)
239
:return: the revision_id
240
:raises errors.NoSuchRevision: if the revno doesn't exist
242
rev_id = self._do_dotted_revno_to_revision_id(revno)
244
self._partial_revision_id_to_revno_cache[rev_id] = revno
247
def _do_dotted_revno_to_revision_id(self, revno):
248
"""Worker function for dotted_revno_to_revision_id.
250
Subclasses should override this if they wish to
251
provide a more efficient implementation.
254
return self.get_rev_id(revno[0])
255
revision_id_to_revno = self.get_revision_id_to_revno_map()
256
revision_ids = [revision_id for revision_id, this_revno
257
in revision_id_to_revno.iteritems()
258
if revno == this_revno]
259
if len(revision_ids) == 1:
260
return revision_ids[0]
262
revno_str = '.'.join(map(str, revno))
263
raise errors.NoSuchRevision(self, revno_str)
266
def revision_id_to_dotted_revno(self, revision_id):
267
"""Given a revision id, return its dotted revno.
269
:return: a tuple like (1,) or (400,1,3).
271
return self._do_revision_id_to_dotted_revno(revision_id)
273
def _do_revision_id_to_dotted_revno(self, revision_id):
274
"""Worker function for revision_id_to_revno."""
275
# Try the caches if they are loaded
276
result = self._partial_revision_id_to_revno_cache.get(revision_id)
277
if result is not None:
279
if self._revision_id_to_revno_cache:
280
result = self._revision_id_to_revno_cache.get(revision_id)
282
raise errors.NoSuchRevision(self, revision_id)
283
# Try the mainline as it's optimised
285
revno = self.revision_id_to_revno(revision_id)
287
except errors.NoSuchRevision:
288
# We need to load and use the full revno map after all
289
result = self.get_revision_id_to_revno_map().get(revision_id)
291
raise errors.NoSuchRevision(self, revision_id)
295
def get_revision_id_to_revno_map(self):
296
"""Return the revision_id => dotted revno map.
298
This will be regenerated on demand, but will be cached.
300
:return: A dictionary mapping revision_id => dotted revno.
301
This dictionary should not be modified by the caller.
303
if self._revision_id_to_revno_cache is not None:
304
mapping = self._revision_id_to_revno_cache
306
mapping = self._gen_revno_map()
307
self._cache_revision_id_to_revno(mapping)
308
# TODO: jam 20070417 Since this is being cached, should we be returning
310
# I would rather not, and instead just declare that users should not
311
# modify the return value.
314
def _gen_revno_map(self):
315
"""Create a new mapping from revision ids to dotted revnos.
317
Dotted revnos are generated based on the current tip in the revision
319
This is the worker function for get_revision_id_to_revno_map, which
320
just caches the return value.
322
:return: A dictionary mapping revision_id => dotted revno.
324
revision_id_to_revno = dict((rev_id, revno)
325
for rev_id, depth, revno, end_of_merge
326
in self.iter_merge_sorted_revisions())
327
return revision_id_to_revno
330
def iter_merge_sorted_revisions(self, start_revision_id=None,
331
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
332
"""Walk the revisions for a branch in merge sorted order.
334
Merge sorted order is the output from a merge-aware,
335
topological sort, i.e. all parents come before their
336
children going forward; the opposite for reverse.
338
:param start_revision_id: the revision_id to begin walking from.
339
If None, the branch tip is used.
340
:param stop_revision_id: the revision_id to terminate the walk
341
after. If None, the rest of history is included.
342
:param stop_rule: if stop_revision_id is not None, the precise rule
343
to use for termination:
344
* 'exclude' - leave the stop revision out of the result (default)
345
* 'include' - the stop revision is the last item in the result
346
* 'with-merges' - include the stop revision and all of its
347
merged revisions in the result
348
:param direction: either 'reverse' or 'forward':
349
* reverse means return the start_revision_id first, i.e.
350
start at the most recent revision and go backwards in history
351
* forward returns tuples in the opposite order to reverse.
352
Note in particular that forward does *not* do any intelligent
353
ordering w.r.t. depth as some clients of this API may like.
354
(If required, that ought to be done at higher layers.)
356
:return: an iterator over (revision_id, depth, revno, end_of_merge)
359
* revision_id: the unique id of the revision
360
* depth: How many levels of merging deep this node has been
362
* revno_sequence: This field provides a sequence of
363
revision numbers for all revisions. The format is:
364
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
365
branch that the revno is on. From left to right the REVNO numbers
366
are the sequence numbers within that branch of the revision.
367
* end_of_merge: When True the next node (earlier in history) is
368
part of a different merge.
370
# Note: depth and revno values are in the context of the branch so
371
# we need the full graph to get stable numbers, regardless of the
373
if self._merge_sorted_revisions_cache is None:
374
last_revision = self.last_revision()
375
graph = self.repository.get_graph()
376
parent_map = dict(((key, value) for key, value in
377
graph.iter_ancestry([last_revision]) if value is not None))
378
revision_graph = repository._strip_NULL_ghosts(parent_map)
379
revs = tsort.merge_sort(revision_graph, last_revision, None,
381
# Drop the sequence # before caching
382
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
384
filtered = self._filter_merge_sorted_revisions(
385
self._merge_sorted_revisions_cache, start_revision_id,
386
stop_revision_id, stop_rule)
387
if direction == 'reverse':
389
if direction == 'forward':
390
return reversed(list(filtered))
392
raise ValueError('invalid direction %r' % direction)
394
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
395
start_revision_id, stop_revision_id, stop_rule):
396
"""Iterate over an inclusive range of sorted revisions."""
397
rev_iter = iter(merge_sorted_revisions)
398
if start_revision_id is not None:
399
for rev_id, depth, revno, end_of_merge in rev_iter:
400
if rev_id != start_revision_id:
403
# The decision to include the start or not
404
# depends on the stop_rule if a stop is provided
406
iter([(rev_id, depth, revno, end_of_merge)]),
409
if stop_revision_id is None:
410
for rev_id, depth, revno, end_of_merge in rev_iter:
411
yield rev_id, depth, revno, end_of_merge
412
elif stop_rule == 'exclude':
413
for rev_id, depth, revno, end_of_merge in rev_iter:
414
if rev_id == stop_revision_id:
416
yield rev_id, depth, revno, end_of_merge
417
elif stop_rule == 'include':
418
for rev_id, depth, revno, end_of_merge in rev_iter:
419
yield rev_id, depth, revno, end_of_merge
420
if rev_id == stop_revision_id:
422
elif stop_rule == 'with-merges':
423
stop_rev = self.repository.get_revision(stop_revision_id)
424
if stop_rev.parent_ids:
425
left_parent = stop_rev.parent_ids[0]
427
left_parent = _mod_revision.NULL_REVISION
428
for rev_id, depth, revno, end_of_merge in rev_iter:
429
if rev_id == left_parent:
431
yield rev_id, depth, revno, end_of_merge
433
raise ValueError('invalid stop_rule %r' % stop_rule)
435
def leave_lock_in_place(self):
436
"""Tell this branch object not to release the physical lock when this
439
If lock_write doesn't return a token, then this method is not supported.
441
self.control_files.leave_in_place()
443
def dont_leave_lock_in_place(self):
444
"""Tell this branch object to release the physical lock when this
445
object is unlocked, even if it didn't originally acquire it.
447
If lock_write doesn't return a token, then this method is not supported.
449
self.control_files.dont_leave_in_place()
451
def bind(self, other):
452
"""Bind the local branch the other branch.
454
:param other: The branch to bind to
457
raise errors.UpgradeRequired(self.base)
460
def fetch(self, from_branch, last_revision=None, pb=None):
461
"""Copy revisions from from_branch into this branch.
463
:param from_branch: Where to copy from.
464
:param last_revision: What revision to stop at (None for at the end
466
:param pb: An optional progress bar to use.
468
Returns the copied revision count and the failed revisions in a tuple:
471
if self.base == from_branch.base:
474
nested_pb = ui.ui_factory.nested_progress_bar()
479
from_branch.lock_read()
481
if last_revision is None:
482
pb.update('get source history')
483
last_revision = from_branch.last_revision()
484
last_revision = _mod_revision.ensure_null(last_revision)
485
return self.repository.fetch(from_branch.repository,
486
revision_id=last_revision,
489
if nested_pb is not None:
493
def get_bound_location(self):
494
"""Return the URL of the branch we are bound to.
496
Older format branches cannot bind, please be sure to use a metadir
501
def get_old_bound_location(self):
502
"""Return the URL of the branch we used to be bound to
504
raise errors.UpgradeRequired(self.base)
506
def get_commit_builder(self, parents, config=None, timestamp=None,
507
timezone=None, committer=None, revprops=None,
509
"""Obtain a CommitBuilder for this branch.
511
:param parents: Revision ids of the parents of the new revision.
512
:param config: Optional configuration to use.
513
:param timestamp: Optional timestamp recorded for commit.
514
:param timezone: Optional timezone for timestamp.
515
:param committer: Optional committer to set for commit.
516
:param revprops: Optional dictionary of revision properties.
517
:param revision_id: Optional revision id.
521
config = self.get_config()
523
return self.repository.get_commit_builder(self, parents, config,
524
timestamp, timezone, committer, revprops, revision_id)
526
def get_master_branch(self, possible_transports=None):
527
"""Return the branch we are bound to.
529
:return: Either a Branch, or None
533
def get_revision_delta(self, revno):
534
"""Return the delta for one revision.
536
The delta is relative to its mainline predecessor, or the
537
empty tree for revision 1.
539
rh = self.revision_history()
540
if not (1 <= revno <= len(rh)):
541
raise errors.InvalidRevisionNumber(revno)
542
return self.repository.get_revision_delta(rh[revno-1])
544
def get_stacked_on_url(self):
545
"""Get the URL this branch is stacked against.
547
:raises NotStacked: If the branch is not stacked.
548
:raises UnstackableBranchFormat: If the branch does not support
551
raise NotImplementedError(self.get_stacked_on_url)
553
def print_file(self, file, revision_id):
554
"""Print `file` to stdout."""
555
raise NotImplementedError(self.print_file)
557
def set_revision_history(self, rev_history):
558
raise NotImplementedError(self.set_revision_history)
560
def set_stacked_on_url(self, url):
561
"""Set the URL this branch is stacked against.
563
:raises UnstackableBranchFormat: If the branch does not support
565
:raises UnstackableRepositoryFormat: If the repository does not support
568
raise NotImplementedError(self.set_stacked_on_url)
570
def _cache_revision_history(self, rev_history):
571
"""Set the cached revision history to rev_history.
573
The revision_history method will use this cache to avoid regenerating
574
the revision history.
576
This API is semi-public; it only for use by subclasses, all other code
577
should consider it to be private.
579
self._revision_history_cache = rev_history
581
def _cache_revision_id_to_revno(self, revision_id_to_revno):
582
"""Set the cached revision_id => revno map to revision_id_to_revno.
584
This API is semi-public; it only for use by subclasses, all other code
585
should consider it to be private.
587
self._revision_id_to_revno_cache = revision_id_to_revno
589
def _clear_cached_state(self):
590
"""Clear any cached data on this branch, e.g. cached revision history.
592
This means the next call to revision_history will need to call
593
_gen_revision_history.
595
This API is semi-public; it only for use by subclasses, all other code
596
should consider it to be private.
598
self._revision_history_cache = None
599
self._revision_id_to_revno_cache = None
600
self._last_revision_info_cache = None
601
self._merge_sorted_revisions_cache = None
603
def _gen_revision_history(self):
604
"""Return sequence of revision hashes on to this branch.
606
Unlike revision_history, this method always regenerates or rereads the
607
revision history, i.e. it does not cache the result, so repeated calls
610
Concrete subclasses should override this instead of revision_history so
611
that subclasses do not need to deal with caching logic.
613
This API is semi-public; it only for use by subclasses, all other code
614
should consider it to be private.
616
raise NotImplementedError(self._gen_revision_history)
619
def revision_history(self):
620
"""Return sequence of revision ids on this branch.
622
This method will cache the revision history for as long as it is safe to
625
if 'evil' in debug.debug_flags:
626
mutter_callsite(3, "revision_history scales with history.")
627
if self._revision_history_cache is not None:
628
history = self._revision_history_cache
630
history = self._gen_revision_history()
631
self._cache_revision_history(history)
635
"""Return current revision number for this branch.
637
That is equivalent to the number of revisions committed to
640
return self.last_revision_info()[0]
643
"""Older format branches cannot bind or unbind."""
644
raise errors.UpgradeRequired(self.base)
646
def set_append_revisions_only(self, enabled):
647
"""Older format branches are never restricted to append-only"""
648
raise errors.UpgradeRequired(self.base)
650
def last_revision(self):
651
"""Return last revision id, or NULL_REVISION."""
652
return self.last_revision_info()[1]
655
def last_revision_info(self):
656
"""Return information about the last revision.
658
:return: A tuple (revno, revision_id).
660
if self._last_revision_info_cache is None:
661
self._last_revision_info_cache = self._last_revision_info()
662
return self._last_revision_info_cache
664
def _last_revision_info(self):
665
rh = self.revision_history()
668
return (revno, rh[-1])
670
return (0, _mod_revision.NULL_REVISION)
672
@deprecated_method(deprecated_in((1, 6, 0)))
673
def missing_revisions(self, other, stop_revision=None):
674
"""Return a list of new revisions that would perfectly fit.
676
If self and other have not diverged, return a list of the revisions
677
present in other, but missing from self.
679
self_history = self.revision_history()
680
self_len = len(self_history)
681
other_history = other.revision_history()
682
other_len = len(other_history)
683
common_index = min(self_len, other_len) -1
684
if common_index >= 0 and \
685
self_history[common_index] != other_history[common_index]:
686
raise errors.DivergedBranches(self, other)
688
if stop_revision is None:
689
stop_revision = other_len
691
if stop_revision > other_len:
692
raise errors.NoSuchRevision(self, stop_revision)
693
return other_history[self_len:stop_revision]
696
def update_revisions(self, other, stop_revision=None, overwrite=False,
698
"""Pull in new perfect-fit revisions.
700
:param other: Another Branch to pull from
701
:param stop_revision: Updated until the given revision
702
:param overwrite: Always set the branch pointer, rather than checking
703
to see if it is a proper descendant.
704
:param graph: A Graph object that can be used to query history
705
information. This can be None.
708
return InterBranch.get(other, self).update_revisions(stop_revision,
711
def revision_id_to_revno(self, revision_id):
712
"""Given a revision id, return its revno"""
713
if _mod_revision.is_null(revision_id):
715
history = self.revision_history()
717
return history.index(revision_id) + 1
719
raise errors.NoSuchRevision(self, revision_id)
721
def get_rev_id(self, revno, history=None):
722
"""Find the revision id of the specified revno."""
724
return _mod_revision.NULL_REVISION
726
history = self.revision_history()
727
if revno <= 0 or revno > len(history):
728
raise errors.NoSuchRevision(self, revno)
729
return history[revno - 1]
731
def pull(self, source, overwrite=False, stop_revision=None,
732
possible_transports=None, _override_hook_target=None):
733
"""Mirror source into this branch.
735
This branch is considered to be 'local', having low latency.
737
:returns: PullResult instance
739
raise NotImplementedError(self.pull)
741
def push(self, target, overwrite=False, stop_revision=None):
742
"""Mirror this branch into target.
744
This branch is considered to be 'local', having low latency.
746
raise NotImplementedError(self.push)
748
def basis_tree(self):
749
"""Return `Tree` object for last revision."""
750
return self.repository.revision_tree(self.last_revision())
752
def get_parent(self):
753
"""Return the parent location of the branch.
755
This is the default location for pull/missing. The usual
756
pattern is that the user can override it by specifying a
759
raise NotImplementedError(self.get_parent)
761
def _set_config_location(self, name, url, config=None,
762
make_relative=False):
764
config = self.get_config()
768
url = urlutils.relative_url(self.base, url)
769
config.set_user_option(name, url, warn_masked=True)
771
def _get_config_location(self, name, config=None):
773
config = self.get_config()
774
location = config.get_user_option(name)
779
def get_submit_branch(self):
780
"""Return the submit location of the branch.
782
This is the default location for bundle. The usual
783
pattern is that the user can override it by specifying a
786
return self.get_config().get_user_option('submit_branch')
788
def set_submit_branch(self, location):
789
"""Return the submit location of the branch.
791
This is the default location for bundle. The usual
792
pattern is that the user can override it by specifying a
795
self.get_config().set_user_option('submit_branch', location,
798
def get_public_branch(self):
799
"""Return the public location of the branch.
801
This is is used by merge directives.
803
return self._get_config_location('public_branch')
805
def set_public_branch(self, location):
806
"""Return the submit location of the branch.
808
This is the default location for bundle. The usual
809
pattern is that the user can override it by specifying a
812
self._set_config_location('public_branch', location)
814
def get_push_location(self):
815
"""Return the None or the location to push this branch to."""
816
push_loc = self.get_config().get_user_option('push_location')
819
def set_push_location(self, location):
820
"""Set a new push location for this branch."""
821
raise NotImplementedError(self.set_push_location)
823
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
824
"""Run the post_change_branch_tip hooks."""
825
hooks = Branch.hooks['post_change_branch_tip']
828
new_revno, new_revid = self.last_revision_info()
829
params = ChangeBranchTipParams(
830
self, old_revno, new_revno, old_revid, new_revid)
834
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
835
"""Run the pre_change_branch_tip hooks."""
836
hooks = Branch.hooks['pre_change_branch_tip']
839
old_revno, old_revid = self.last_revision_info()
840
params = ChangeBranchTipParams(
841
self, old_revno, new_revno, old_revid, new_revid)
845
except errors.TipChangeRejected:
848
exc_info = sys.exc_info()
849
hook_name = Branch.hooks.get_hook_name(hook)
850
raise errors.HookFailed(
851
'pre_change_branch_tip', hook_name, exc_info)
853
def set_parent(self, url):
854
raise NotImplementedError(self.set_parent)
858
"""Synchronise this branch with the master branch if any.
860
:return: None or the last_revision pivoted out during the update.
864
def check_revno(self, revno):
866
Check whether a revno corresponds to any revision.
867
Zero (the NULL revision) is considered valid.
870
self.check_real_revno(revno)
872
def check_real_revno(self, revno):
874
Check whether a revno corresponds to a real revision.
875
Zero (the NULL revision) is considered invalid
877
if revno < 1 or revno > self.revno():
878
raise errors.InvalidRevisionNumber(revno)
881
def clone(self, to_bzrdir, revision_id=None):
882
"""Clone this branch into to_bzrdir preserving all semantic values.
884
Most API users will want 'create_clone_on_transport', which creates a
885
new bzrdir and branch on the fly.
887
revision_id: if not None, the revision history in the new branch will
888
be truncated to end with revision_id.
890
result = to_bzrdir.create_branch()
891
self.copy_content_into(result, revision_id=revision_id)
895
def sprout(self, to_bzrdir, revision_id=None):
896
"""Create a new line of development from the branch, into to_bzrdir.
898
to_bzrdir controls the branch format.
900
revision_id: if not None, the revision history in the new branch will
901
be truncated to end with revision_id.
903
result = to_bzrdir.create_branch()
904
self.copy_content_into(result, revision_id=revision_id)
905
result.set_parent(self.bzrdir.root_transport.base)
908
def _synchronize_history(self, destination, revision_id):
909
"""Synchronize last revision and revision history between branches.
911
This version is most efficient when the destination is also a
912
BzrBranch6, but works for BzrBranch5, as long as the destination's
913
repository contains all the lefthand ancestors of the intended
914
last_revision. If not, set_last_revision_info will fail.
916
:param destination: The branch to copy the history into
917
:param revision_id: The revision-id to truncate history at. May
918
be None to copy complete history.
920
source_revno, source_revision_id = self.last_revision_info()
921
if revision_id is None:
922
revno, revision_id = source_revno, source_revision_id
923
elif source_revision_id == revision_id:
924
# we know the revno without needing to walk all of history
927
# To figure out the revno for a random revision, we need to build
928
# the revision history, and count its length.
929
# We don't care about the order, just how long it is.
930
# Alternatively, we could start at the current location, and count
931
# backwards. But there is no guarantee that we will find it since
932
# it may be a merged revision.
933
revno = len(list(self.repository.iter_reverse_revision_history(
935
destination.set_last_revision_info(revno, revision_id)
938
def copy_content_into(self, destination, revision_id=None):
939
"""Copy the content of self into destination.
941
revision_id: if not None, the revision history in the new branch will
942
be truncated to end with revision_id.
944
self._synchronize_history(destination, revision_id)
946
parent = self.get_parent()
947
except errors.InaccessibleParent, e:
948
mutter('parent was not accessible to copy: %s', e)
951
destination.set_parent(parent)
952
if self._push_should_merge_tags():
953
self.tags.merge_to(destination.tags)
957
"""Check consistency of the branch.
959
In particular this checks that revisions given in the revision-history
960
do actually match up in the revision graph, and that they're all
961
present in the repository.
963
Callers will typically also want to check the repository.
965
:return: A BranchCheckResult.
967
mainline_parent_id = None
968
last_revno, last_revision_id = self.last_revision_info()
969
real_rev_history = list(self.repository.iter_reverse_revision_history(
971
real_rev_history.reverse()
972
if len(real_rev_history) != last_revno:
973
raise errors.BzrCheckError('revno does not match len(mainline)'
974
' %s != %s' % (last_revno, len(real_rev_history)))
975
# TODO: We should probably also check that real_rev_history actually
976
# matches self.revision_history()
977
for revision_id in real_rev_history:
979
revision = self.repository.get_revision(revision_id)
980
except errors.NoSuchRevision, e:
981
raise errors.BzrCheckError("mainline revision {%s} not in repository"
983
# In general the first entry on the revision history has no parents.
984
# But it's not illegal for it to have parents listed; this can happen
985
# in imports from Arch when the parents weren't reachable.
986
if mainline_parent_id is not None:
987
if mainline_parent_id not in revision.parent_ids:
988
raise errors.BzrCheckError("previous revision {%s} not listed among "
990
% (mainline_parent_id, revision_id))
991
mainline_parent_id = revision_id
992
return BranchCheckResult(self)
994
def _get_checkout_format(self):
995
"""Return the most suitable metadir for a checkout of this branch.
996
Weaves are used if this branch's repository uses weaves.
998
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
999
from bzrlib.repofmt import weaverepo
1000
format = bzrdir.BzrDirMetaFormat1()
1001
format.repository_format = weaverepo.RepositoryFormat7()
1003
format = self.repository.bzrdir.checkout_metadir()
1004
format.set_branch_format(self._format)
1007
def create_clone_on_transport(self, to_transport, revision_id=None,
1009
"""Create a clone of this branch and its bzrdir.
1011
:param to_transport: The transport to clone onto.
1012
:param revision_id: The revision id to use as tip in the new branch.
1013
If None the tip is obtained from this branch.
1014
:param stacked_on: An optional URL to stack the clone on.
1016
# XXX: Fix the bzrdir API to allow getting the branch back from the
1017
# clone call. Or something. 20090224 RBC/spiv.
1018
dir_to = self.bzrdir.clone_on_transport(to_transport,
1019
revision_id=revision_id, stacked_on=stacked_on)
1020
return dir_to.open_branch()
1022
def create_checkout(self, to_location, revision_id=None,
1023
lightweight=False, accelerator_tree=None,
1025
"""Create a checkout of a branch.
1027
:param to_location: The url to produce the checkout at
1028
:param revision_id: The revision to check out
1029
:param lightweight: If True, produce a lightweight checkout, otherwise,
1030
produce a bound branch (heavyweight checkout)
1031
:param accelerator_tree: A tree which can be used for retrieving file
1032
contents more quickly than the revision tree, i.e. a workingtree.
1033
The revision tree will be used for cases where accelerator_tree's
1034
content is different.
1035
:param hardlink: If true, hard-link files from accelerator_tree,
1037
:return: The tree of the created checkout
1039
t = transport.get_transport(to_location)
1042
format = self._get_checkout_format()
1043
checkout = format.initialize_on_transport(t)
1044
from_branch = BranchReferenceFormat().initialize(checkout, self)
1046
format = self._get_checkout_format()
1047
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1048
to_location, force_new_tree=False, format=format)
1049
checkout = checkout_branch.bzrdir
1050
checkout_branch.bind(self)
1051
# pull up to the specified revision_id to set the initial
1052
# branch tip correctly, and seed it with history.
1053
checkout_branch.pull(self, stop_revision=revision_id)
1055
tree = checkout.create_workingtree(revision_id,
1056
from_branch=from_branch,
1057
accelerator_tree=accelerator_tree,
1059
basis_tree = tree.basis_tree()
1060
basis_tree.lock_read()
1062
for path, file_id in basis_tree.iter_references():
1063
reference_parent = self.reference_parent(file_id, path)
1064
reference_parent.create_checkout(tree.abspath(path),
1065
basis_tree.get_reference_revision(file_id, path),
1072
def reconcile(self, thorough=True):
1073
"""Make sure the data stored in this branch is consistent."""
1074
from bzrlib.reconcile import BranchReconciler
1075
reconciler = BranchReconciler(self, thorough=thorough)
1076
reconciler.reconcile()
1079
def reference_parent(self, file_id, path):
1080
"""Return the parent branch for a tree-reference file_id
1081
:param file_id: The file_id of the tree reference
1082
:param path: The path of the file_id in the tree
1083
:return: A branch associated with the file_id
1085
# FIXME should provide multiple branches, based on config
1086
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1088
def supports_tags(self):
1089
return self._format.supports_tags()
1091
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1093
"""Ensure that revision_b is a descendant of revision_a.
1095
This is a helper function for update_revisions.
1097
:raises: DivergedBranches if revision_b has diverged from revision_a.
1098
:returns: True if revision_b is a descendant of revision_a.
1100
relation = self._revision_relations(revision_a, revision_b, graph)
1101
if relation == 'b_descends_from_a':
1103
elif relation == 'diverged':
1104
raise errors.DivergedBranches(self, other_branch)
1105
elif relation == 'a_descends_from_b':
1108
raise AssertionError("invalid relation: %r" % (relation,))
1110
def _revision_relations(self, revision_a, revision_b, graph):
1111
"""Determine the relationship between two revisions.
1113
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1115
heads = graph.heads([revision_a, revision_b])
1116
if heads == set([revision_b]):
1117
return 'b_descends_from_a'
1118
elif heads == set([revision_a, revision_b]):
1119
# These branches have diverged
1121
elif heads == set([revision_a]):
1122
return 'a_descends_from_b'
1124
raise AssertionError("invalid heads: %r" % (heads,))
1127
class BranchFormat(object):
1128
"""An encapsulation of the initialization and open routines for a format.
1130
Formats provide three things:
1131
* An initialization routine,
1135
Formats are placed in an dict by their format string for reference
1136
during branch opening. Its not required that these be instances, they
1137
can be classes themselves with class methods - it simply depends on
1138
whether state is needed for a given format or not.
1140
Once a format is deprecated, just deprecate the initialize and open
1141
methods on the format class. Do not deprecate the object, as the
1142
object will be created every time regardless.
1145
_default_format = None
1146
"""The default format used for new branches."""
1149
"""The known formats."""
1151
def __eq__(self, other):
1152
return self.__class__ is other.__class__
1154
def __ne__(self, other):
1155
return not (self == other)
1158
def find_format(klass, a_bzrdir):
1159
"""Return the format for the branch object in a_bzrdir."""
1161
transport = a_bzrdir.get_branch_transport(None)
1162
format_string = transport.get("format").read()
1163
return klass._formats[format_string]
1164
except errors.NoSuchFile:
1165
raise errors.NotBranchError(path=transport.base)
1167
raise errors.UnknownFormatError(format=format_string, kind='branch')
1170
def get_default_format(klass):
1171
"""Return the current default format."""
1172
return klass._default_format
1174
def get_reference(self, a_bzrdir):
1175
"""Get the target reference of the branch in a_bzrdir.
1177
format probing must have been completed before calling
1178
this method - it is assumed that the format of the branch
1179
in a_bzrdir is correct.
1181
:param a_bzrdir: The bzrdir to get the branch data from.
1182
:return: None if the branch is not a reference branch.
1187
def set_reference(self, a_bzrdir, to_branch):
1188
"""Set the target reference of the branch in a_bzrdir.
1190
format probing must have been completed before calling
1191
this method - it is assumed that the format of the branch
1192
in a_bzrdir is correct.
1194
:param a_bzrdir: The bzrdir to set the branch reference for.
1195
:param to_branch: branch that the checkout is to reference
1197
raise NotImplementedError(self.set_reference)
1199
def get_format_string(self):
1200
"""Return the ASCII format string that identifies this format."""
1201
raise NotImplementedError(self.get_format_string)
1203
def get_format_description(self):
1204
"""Return the short format description for this format."""
1205
raise NotImplementedError(self.get_format_description)
1207
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1209
"""Initialize a branch in a bzrdir, with specified files
1211
:param a_bzrdir: The bzrdir to initialize the branch in
1212
:param utf8_files: The files to create as a list of
1213
(filename, content) tuples
1214
:param set_format: If True, set the format with
1215
self.get_format_string. (BzrBranch4 has its format set
1217
:return: a branch in this format
1219
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1220
branch_transport = a_bzrdir.get_branch_transport(self)
1222
'metadir': ('lock', lockdir.LockDir),
1223
'branch4': ('branch-lock', lockable_files.TransportLock),
1225
lock_name, lock_class = lock_map[lock_type]
1226
control_files = lockable_files.LockableFiles(branch_transport,
1227
lock_name, lock_class)
1228
control_files.create_lock()
1229
control_files.lock_write()
1231
utf8_files += [('format', self.get_format_string())]
1233
for (filename, content) in utf8_files:
1234
branch_transport.put_bytes(
1236
mode=a_bzrdir._get_file_mode())
1238
control_files.unlock()
1239
return self.open(a_bzrdir, _found=True)
1241
def initialize(self, a_bzrdir):
1242
"""Create a branch of this format in a_bzrdir."""
1243
raise NotImplementedError(self.initialize)
1245
def is_supported(self):
1246
"""Is this format supported?
1248
Supported formats can be initialized and opened.
1249
Unsupported formats may not support initialization or committing or
1250
some other features depending on the reason for not being supported.
1254
def network_name(self):
1255
"""A simple byte string uniquely identifying this format for RPC calls.
1257
MetaDir branch formats use their disk format string to identify the
1258
repository over the wire. All in one formats such as bzr < 0.8, and
1259
foreign formats like svn/git and hg should use some marker which is
1260
unique and immutable.
1262
raise NotImplementedError(self.network_name)
1264
def open(self, a_bzrdir, _found=False):
1265
"""Return the branch object for a_bzrdir
1267
_found is a private parameter, do not use it. It is used to indicate
1268
if format probing has already be done.
1270
raise NotImplementedError(self.open)
1273
def register_format(klass, format):
1274
"""Register a metadir format."""
1275
klass._formats[format.get_format_string()] = format
1276
# Metadir formats have a network name of their format string.
1277
network_format_registry.register(format.get_format_string(), format)
1280
def set_default_format(klass, format):
1281
klass._default_format = format
1283
def supports_stacking(self):
1284
"""True if this format records a stacked-on branch."""
1288
def unregister_format(klass, format):
1289
del klass._formats[format.get_format_string()]
1292
return self.get_format_description().rstrip()
1294
def supports_tags(self):
1295
"""True if this format supports tags stored in the branch"""
1296
return False # by default
1299
class BranchHooks(Hooks):
1300
"""A dictionary mapping hook name to a list of callables for branch hooks.
1302
e.g. ['set_rh'] Is the list of items to be called when the
1303
set_revision_history function is invoked.
1307
"""Create the default hooks.
1309
These are all empty initially, because by default nothing should get
1312
Hooks.__init__(self)
1313
# Introduced in 0.15:
1314
# invoked whenever the revision history has been set
1315
# with set_revision_history. The api signature is
1316
# (branch, revision_history), and the branch will
1319
# Invoked after a branch is opened. The api signature is (branch).
1321
# invoked after a push operation completes.
1322
# the api signature is
1324
# containing the members
1325
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1326
# where local is the local target branch or None, master is the target
1327
# master branch, and the rest should be self explanatory. The source
1328
# is read locked and the target branches write locked. Source will
1329
# be the local low-latency branch.
1330
self['post_push'] = []
1331
# invoked after a pull operation completes.
1332
# the api signature is
1334
# containing the members
1335
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1336
# where local is the local branch or None, master is the target
1337
# master branch, and the rest should be self explanatory. The source
1338
# is read locked and the target branches write locked. The local
1339
# branch is the low-latency branch.
1340
self['post_pull'] = []
1341
# invoked before a commit operation takes place.
1342
# the api signature is
1343
# (local, master, old_revno, old_revid, future_revno, future_revid,
1344
# tree_delta, future_tree).
1345
# old_revid is NULL_REVISION for the first commit to a branch
1346
# tree_delta is a TreeDelta object describing changes from the basis
1347
# revision, hooks MUST NOT modify this delta
1348
# future_tree is an in-memory tree obtained from
1349
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1350
self['pre_commit'] = []
1351
# invoked after a commit operation completes.
1352
# the api signature is
1353
# (local, master, old_revno, old_revid, new_revno, new_revid)
1354
# old_revid is NULL_REVISION for the first commit to a branch.
1355
self['post_commit'] = []
1356
# invoked after a uncommit operation completes.
1357
# the api signature is
1358
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1359
# local is the local branch or None, master is the target branch,
1360
# and an empty branch recieves new_revno of 0, new_revid of None.
1361
self['post_uncommit'] = []
1363
# Invoked before the tip of a branch changes.
1364
# the api signature is
1365
# (params) where params is a ChangeBranchTipParams with the members
1366
# (branch, old_revno, new_revno, old_revid, new_revid)
1367
self['pre_change_branch_tip'] = []
1369
# Invoked after the tip of a branch changes.
1370
# the api signature is
1371
# (params) where params is a ChangeBranchTipParams with the members
1372
# (branch, old_revno, new_revno, old_revid, new_revid)
1373
self['post_change_branch_tip'] = []
1375
# Invoked when a stacked branch activates its fallback locations and
1376
# allows the transformation of the url of said location.
1377
# the api signature is
1378
# (branch, url) where branch is the branch having its fallback
1379
# location activated and url is the url for the fallback location.
1380
# The hook should return a url.
1381
self['transform_fallback_location'] = []
1384
# install the default hooks into the Branch class.
1385
Branch.hooks = BranchHooks()
1388
class ChangeBranchTipParams(object):
1389
"""Object holding parameters passed to *_change_branch_tip hooks.
1391
There are 5 fields that hooks may wish to access:
1393
:ivar branch: the branch being changed
1394
:ivar old_revno: revision number before the change
1395
:ivar new_revno: revision number after the change
1396
:ivar old_revid: revision id before the change
1397
:ivar new_revid: revision id after the change
1399
The revid fields are strings. The revno fields are integers.
1402
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1403
"""Create a group of ChangeBranchTip parameters.
1405
:param branch: The branch being changed.
1406
:param old_revno: Revision number before the change.
1407
:param new_revno: Revision number after the change.
1408
:param old_revid: Tip revision id before the change.
1409
:param new_revid: Tip revision id after the change.
1411
self.branch = branch
1412
self.old_revno = old_revno
1413
self.new_revno = new_revno
1414
self.old_revid = old_revid
1415
self.new_revid = new_revid
1417
def __eq__(self, other):
1418
return self.__dict__ == other.__dict__
1421
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1422
self.__class__.__name__, self.branch,
1423
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1426
class BzrBranchFormat4(BranchFormat):
1427
"""Bzr branch format 4.
1430
- a revision-history file.
1431
- a branch-lock lock file [ to be shared with the bzrdir ]
1434
def get_format_description(self):
1435
"""See BranchFormat.get_format_description()."""
1436
return "Branch format 4"
1438
def initialize(self, a_bzrdir):
1439
"""Create a branch of this format in a_bzrdir."""
1440
utf8_files = [('revision-history', ''),
1441
('branch-name', ''),
1443
return self._initialize_helper(a_bzrdir, utf8_files,
1444
lock_type='branch4', set_format=False)
1447
super(BzrBranchFormat4, self).__init__()
1448
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1450
def network_name(self):
1451
"""The network name for this format is the control dirs disk label."""
1452
return self._matchingbzrdir.get_format_string()
1454
def open(self, a_bzrdir, _found=False):
1455
"""Return the branch object for a_bzrdir
1457
_found is a private parameter, do not use it. It is used to indicate
1458
if format probing has already be done.
1461
# we are being called directly and must probe.
1462
raise NotImplementedError
1463
return BzrBranch(_format=self,
1464
_control_files=a_bzrdir._control_files,
1466
_repository=a_bzrdir.open_repository())
1469
return "Bazaar-NG branch format 4"
1472
class BranchFormatMetadir(BranchFormat):
1473
"""Common logic for meta-dir based branch formats."""
1475
def _branch_class(self):
1476
"""What class to instantiate on open calls."""
1477
raise NotImplementedError(self._branch_class)
1479
def network_name(self):
1480
"""A simple byte string uniquely identifying this format for RPC calls.
1482
Metadir branch formats use their format string.
1484
return self.get_format_string()
1486
def open(self, a_bzrdir, _found=False):
1487
"""Return the branch object for a_bzrdir.
1489
_found is a private parameter, do not use it. It is used to indicate
1490
if format probing has already be done.
1493
format = BranchFormat.find_format(a_bzrdir)
1494
if format.__class__ != self.__class__:
1495
raise AssertionError("wrong format %r found for %r" %
1498
transport = a_bzrdir.get_branch_transport(None)
1499
control_files = lockable_files.LockableFiles(transport, 'lock',
1501
return self._branch_class()(_format=self,
1502
_control_files=control_files,
1504
_repository=a_bzrdir.find_repository())
1505
except errors.NoSuchFile:
1506
raise errors.NotBranchError(path=transport.base)
1509
super(BranchFormatMetadir, self).__init__()
1510
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1511
self._matchingbzrdir.set_branch_format(self)
1513
def supports_tags(self):
1517
class BzrBranchFormat5(BranchFormatMetadir):
1518
"""Bzr branch format 5.
1521
- a revision-history file.
1523
- a lock dir guarding the branch itself
1524
- all of this stored in a branch/ subdirectory
1525
- works with shared repositories.
1527
This format is new in bzr 0.8.
1530
def _branch_class(self):
1533
def get_format_string(self):
1534
"""See BranchFormat.get_format_string()."""
1535
return "Bazaar-NG branch format 5\n"
1537
def get_format_description(self):
1538
"""See BranchFormat.get_format_description()."""
1539
return "Branch format 5"
1541
def initialize(self, a_bzrdir):
1542
"""Create a branch of this format in a_bzrdir."""
1543
utf8_files = [('revision-history', ''),
1544
('branch-name', ''),
1546
return self._initialize_helper(a_bzrdir, utf8_files)
1548
def supports_tags(self):
1552
class BzrBranchFormat6(BranchFormatMetadir):
1553
"""Branch format with last-revision and tags.
1555
Unlike previous formats, this has no explicit revision history. Instead,
1556
this just stores the last-revision, and the left-hand history leading
1557
up to there is the history.
1559
This format was introduced in bzr 0.15
1560
and became the default in 0.91.
1563
def _branch_class(self):
1566
def get_format_string(self):
1567
"""See BranchFormat.get_format_string()."""
1568
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1570
def get_format_description(self):
1571
"""See BranchFormat.get_format_description()."""
1572
return "Branch format 6"
1574
def initialize(self, a_bzrdir):
1575
"""Create a branch of this format in a_bzrdir."""
1576
utf8_files = [('last-revision', '0 null:\n'),
1577
('branch.conf', ''),
1580
return self._initialize_helper(a_bzrdir, utf8_files)
1583
class BzrBranchFormat7(BranchFormatMetadir):
1584
"""Branch format with last-revision, tags, and a stacked location pointer.
1586
The stacked location pointer is passed down to the repository and requires
1587
a repository format with supports_external_lookups = True.
1589
This format was introduced in bzr 1.6.
1592
def _branch_class(self):
1595
def get_format_string(self):
1596
"""See BranchFormat.get_format_string()."""
1597
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1599
def get_format_description(self):
1600
"""See BranchFormat.get_format_description()."""
1601
return "Branch format 7"
1603
def initialize(self, a_bzrdir):
1604
"""Create a branch of this format in a_bzrdir."""
1605
utf8_files = [('last-revision', '0 null:\n'),
1606
('branch.conf', ''),
1609
return self._initialize_helper(a_bzrdir, utf8_files)
1612
super(BzrBranchFormat7, self).__init__()
1613
self._matchingbzrdir.repository_format = \
1614
RepositoryFormatKnitPack5RichRoot()
1616
def supports_stacking(self):
1620
class BranchReferenceFormat(BranchFormat):
1621
"""Bzr branch reference format.
1623
Branch references are used in implementing checkouts, they
1624
act as an alias to the real branch which is at some other url.
1631
def get_format_string(self):
1632
"""See BranchFormat.get_format_string()."""
1633
return "Bazaar-NG Branch Reference Format 1\n"
1635
def get_format_description(self):
1636
"""See BranchFormat.get_format_description()."""
1637
return "Checkout reference format 1"
1639
def get_reference(self, a_bzrdir):
1640
"""See BranchFormat.get_reference()."""
1641
transport = a_bzrdir.get_branch_transport(None)
1642
return transport.get('location').read()
1644
def set_reference(self, a_bzrdir, to_branch):
1645
"""See BranchFormat.set_reference()."""
1646
transport = a_bzrdir.get_branch_transport(None)
1647
location = transport.put_bytes('location', to_branch.base)
1649
def initialize(self, a_bzrdir, target_branch=None):
1650
"""Create a branch of this format in a_bzrdir."""
1651
if target_branch is None:
1652
# this format does not implement branch itself, thus the implicit
1653
# creation contract must see it as uninitializable
1654
raise errors.UninitializableFormat(self)
1655
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1656
branch_transport = a_bzrdir.get_branch_transport(self)
1657
branch_transport.put_bytes('location',
1658
target_branch.bzrdir.root_transport.base)
1659
branch_transport.put_bytes('format', self.get_format_string())
1661
a_bzrdir, _found=True,
1662
possible_transports=[target_branch.bzrdir.root_transport])
1665
super(BranchReferenceFormat, self).__init__()
1666
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1667
self._matchingbzrdir.set_branch_format(self)
1669
def _make_reference_clone_function(format, a_branch):
1670
"""Create a clone() routine for a branch dynamically."""
1671
def clone(to_bzrdir, revision_id=None):
1672
"""See Branch.clone()."""
1673
return format.initialize(to_bzrdir, a_branch)
1674
# cannot obey revision_id limits when cloning a reference ...
1675
# FIXME RBC 20060210 either nuke revision_id for clone, or
1676
# emit some sort of warning/error to the caller ?!
1679
def open(self, a_bzrdir, _found=False, location=None,
1680
possible_transports=None):
1681
"""Return the branch that the branch reference in a_bzrdir points at.
1683
_found is a private parameter, do not use it. It is used to indicate
1684
if format probing has already be done.
1687
format = BranchFormat.find_format(a_bzrdir)
1688
if format.__class__ != self.__class__:
1689
raise AssertionError("wrong format %r found for %r" %
1691
if location is None:
1692
location = self.get_reference(a_bzrdir)
1693
real_bzrdir = bzrdir.BzrDir.open(
1694
location, possible_transports=possible_transports)
1695
result = real_bzrdir.open_branch()
1696
# this changes the behaviour of result.clone to create a new reference
1697
# rather than a copy of the content of the branch.
1698
# I did not use a proxy object because that needs much more extensive
1699
# testing, and we are only changing one behaviour at the moment.
1700
# If we decide to alter more behaviours - i.e. the implicit nickname
1701
# then this should be refactored to introduce a tested proxy branch
1702
# and a subclass of that for use in overriding clone() and ....
1704
result.clone = self._make_reference_clone_function(result)
1708
network_format_registry = registry.FormatRegistry()
1709
"""Registry of formats indexed by their network name.
1711
The network name for a repository format is an identifier that can be used when
1712
referring to formats with smart server operations. See
1713
BranchFormat.network_name() for more detail.
1717
# formats which have no format string are not discoverable
1718
# and not independently creatable, so are not registered.
1719
__format5 = BzrBranchFormat5()
1720
__format6 = BzrBranchFormat6()
1721
__format7 = BzrBranchFormat7()
1722
BranchFormat.register_format(__format5)
1723
BranchFormat.register_format(BranchReferenceFormat())
1724
BranchFormat.register_format(__format6)
1725
BranchFormat.register_format(__format7)
1726
BranchFormat.set_default_format(__format6)
1727
_legacy_formats = [BzrBranchFormat4(),
1729
network_format_registry.register(
1730
_legacy_formats[0].network_name(), _legacy_formats[0])
1733
class BzrBranch(Branch):
1734
"""A branch stored in the actual filesystem.
1736
Note that it's "local" in the context of the filesystem; it doesn't
1737
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1738
it's writable, and can be accessed via the normal filesystem API.
1740
:ivar _transport: Transport for file operations on this branch's
1741
control files, typically pointing to the .bzr/branch directory.
1742
:ivar repository: Repository for this branch.
1743
:ivar base: The url of the base directory for this branch; the one
1744
containing the .bzr directory.
1747
def __init__(self, _format=None,
1748
_control_files=None, a_bzrdir=None, _repository=None):
1749
"""Create new branch object at a particular location."""
1750
if a_bzrdir is None:
1751
raise ValueError('a_bzrdir must be supplied')
1753
self.bzrdir = a_bzrdir
1754
self._base = self.bzrdir.transport.clone('..').base
1755
# XXX: We should be able to just do
1756
# self.base = self.bzrdir.root_transport.base
1757
# but this does not quite work yet -- mbp 20080522
1758
self._format = _format
1759
if _control_files is None:
1760
raise ValueError('BzrBranch _control_files is None')
1761
self.control_files = _control_files
1762
self._transport = _control_files._transport
1763
self.repository = _repository
1764
Branch.__init__(self)
1767
return '%s(%r)' % (self.__class__.__name__, self.base)
1771
def _get_base(self):
1772
"""Returns the directory containing the control directory."""
1775
base = property(_get_base, doc="The URL for the root of this branch.")
1777
def is_locked(self):
1778
return self.control_files.is_locked()
1780
def lock_write(self, token=None):
1781
repo_token = self.repository.lock_write()
1783
token = self.control_files.lock_write(token=token)
1785
self.repository.unlock()
1789
def lock_read(self):
1790
self.repository.lock_read()
1792
self.control_files.lock_read()
1794
self.repository.unlock()
1798
# TODO: test for failed two phase locks. This is known broken.
1800
self.control_files.unlock()
1802
self.repository.unlock()
1803
if not self.control_files.is_locked():
1804
# we just released the lock
1805
self._clear_cached_state()
1807
def peek_lock_mode(self):
1808
if self.control_files._lock_count == 0:
1811
return self.control_files._lock_mode
1813
def get_physical_lock_status(self):
1814
return self.control_files.get_physical_lock_status()
1817
def print_file(self, file, revision_id):
1818
"""See Branch.print_file."""
1819
return self.repository.print_file(file, revision_id)
1821
def _write_revision_history(self, history):
1822
"""Factored out of set_revision_history.
1824
This performs the actual writing to disk.
1825
It is intended to be called by BzrBranch5.set_revision_history."""
1826
self._transport.put_bytes(
1827
'revision-history', '\n'.join(history),
1828
mode=self.bzrdir._get_file_mode())
1831
def set_revision_history(self, rev_history):
1832
"""See Branch.set_revision_history."""
1833
if 'evil' in debug.debug_flags:
1834
mutter_callsite(3, "set_revision_history scales with history.")
1835
check_not_reserved_id = _mod_revision.check_not_reserved_id
1836
for rev_id in rev_history:
1837
check_not_reserved_id(rev_id)
1838
if Branch.hooks['post_change_branch_tip']:
1839
# Don't calculate the last_revision_info() if there are no hooks
1841
old_revno, old_revid = self.last_revision_info()
1842
if len(rev_history) == 0:
1843
revid = _mod_revision.NULL_REVISION
1845
revid = rev_history[-1]
1846
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1847
self._write_revision_history(rev_history)
1848
self._clear_cached_state()
1849
self._cache_revision_history(rev_history)
1850
for hook in Branch.hooks['set_rh']:
1851
hook(self, rev_history)
1852
if Branch.hooks['post_change_branch_tip']:
1853
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1855
def _synchronize_history(self, destination, revision_id):
1856
"""Synchronize last revision and revision history between branches.
1858
This version is most efficient when the destination is also a
1859
BzrBranch5, but works for BzrBranch6 as long as the revision
1860
history is the true lefthand parent history, and all of the revisions
1861
are in the destination's repository. If not, set_revision_history
1864
:param destination: The branch to copy the history into
1865
:param revision_id: The revision-id to truncate history at. May
1866
be None to copy complete history.
1868
if not isinstance(destination._format, BzrBranchFormat5):
1869
super(BzrBranch, self)._synchronize_history(
1870
destination, revision_id)
1872
if revision_id == _mod_revision.NULL_REVISION:
1875
new_history = self.revision_history()
1876
if revision_id is not None and new_history != []:
1878
new_history = new_history[:new_history.index(revision_id) + 1]
1880
rev = self.repository.get_revision(revision_id)
1881
new_history = rev.get_history(self.repository)[1:]
1882
destination.set_revision_history(new_history)
1885
def set_last_revision_info(self, revno, revision_id):
1886
"""Set the last revision of this branch.
1888
The caller is responsible for checking that the revno is correct
1889
for this revision id.
1891
It may be possible to set the branch last revision to an id not
1892
present in the repository. However, branches can also be
1893
configured to check constraints on history, in which case this may not
1896
revision_id = _mod_revision.ensure_null(revision_id)
1897
# this old format stores the full history, but this api doesn't
1898
# provide it, so we must generate, and might as well check it's
1900
history = self._lefthand_history(revision_id)
1901
if len(history) != revno:
1902
raise AssertionError('%d != %d' % (len(history), revno))
1903
self.set_revision_history(history)
1905
def _gen_revision_history(self):
1906
history = self._transport.get_bytes('revision-history').split('\n')
1907
if history[-1:] == ['']:
1908
# There shouldn't be a trailing newline, but just in case.
1913
def generate_revision_history(self, revision_id, last_rev=None,
1915
"""Create a new revision history that will finish with revision_id.
1917
:param revision_id: the new tip to use.
1918
:param last_rev: The previous last_revision. If not None, then this
1919
must be a ancestory of revision_id, or DivergedBranches is raised.
1920
:param other_branch: The other branch that DivergedBranches should
1921
raise with respect to.
1923
self.set_revision_history(self._lefthand_history(revision_id,
1924
last_rev, other_branch))
1926
def basis_tree(self):
1927
"""See Branch.basis_tree."""
1928
return self.repository.revision_tree(self.last_revision())
1931
def pull(self, source, overwrite=False, stop_revision=None,
1932
_hook_master=None, run_hooks=True, possible_transports=None,
1933
_override_hook_target=None):
1936
:param _hook_master: Private parameter - set the branch to
1937
be supplied as the master to pull hooks.
1938
:param run_hooks: Private parameter - if false, this branch
1939
is being called because it's the master of the primary branch,
1940
so it should not run its hooks.
1941
:param _override_hook_target: Private parameter - set the branch to be
1942
supplied as the target_branch to pull hooks.
1944
result = PullResult()
1945
result.source_branch = source
1946
if _override_hook_target is None:
1947
result.target_branch = self
1949
result.target_branch = _override_hook_target
1952
# We assume that during 'pull' the local repository is closer than
1954
graph = self.repository.get_graph(source.repository)
1955
result.old_revno, result.old_revid = self.last_revision_info()
1956
self.update_revisions(source, stop_revision, overwrite=overwrite,
1958
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1959
result.new_revno, result.new_revid = self.last_revision_info()
1961
result.master_branch = _hook_master
1962
result.local_branch = result.target_branch
1964
result.master_branch = result.target_branch
1965
result.local_branch = None
1967
for hook in Branch.hooks['post_pull']:
1973
def _get_parent_location(self):
1974
_locs = ['parent', 'pull', 'x-pull']
1977
return self._transport.get_bytes(l).strip('\n')
1978
except errors.NoSuchFile:
1983
def push(self, target, overwrite=False, stop_revision=None,
1984
_override_hook_source_branch=None):
1987
This is the basic concrete implementation of push()
1989
:param _override_hook_source_branch: If specified, run
1990
the hooks passing this Branch as the source, rather than self.
1991
This is for use of RemoteBranch, where push is delegated to the
1992
underlying vfs-based Branch.
1994
# TODO: Public option to disable running hooks - should be trivial but
1996
return _run_with_write_locked_target(
1997
target, self._push_with_bound_branches, target, overwrite,
1999
_override_hook_source_branch=_override_hook_source_branch)
2001
def _push_with_bound_branches(self, target, overwrite,
2003
_override_hook_source_branch=None):
2004
"""Push from self into target, and into target's master if any.
2006
This is on the base BzrBranch class even though it doesn't support
2007
bound branches because the *target* might be bound.
2010
if _override_hook_source_branch:
2011
result.source_branch = _override_hook_source_branch
2012
for hook in Branch.hooks['post_push']:
2015
bound_location = target.get_bound_location()
2016
if bound_location and target.base != bound_location:
2017
# there is a master branch.
2019
# XXX: Why the second check? Is it even supported for a branch to
2020
# be bound to itself? -- mbp 20070507
2021
master_branch = target.get_master_branch()
2022
master_branch.lock_write()
2024
# push into the master from this branch.
2025
self._basic_push(master_branch, overwrite, stop_revision)
2026
# and push into the target branch from this. Note that we push from
2027
# this branch again, because its considered the highest bandwidth
2029
result = self._basic_push(target, overwrite, stop_revision)
2030
result.master_branch = master_branch
2031
result.local_branch = target
2035
master_branch.unlock()
2038
result = self._basic_push(target, overwrite, stop_revision)
2039
# TODO: Why set master_branch and local_branch if there's no
2040
# binding? Maybe cleaner to just leave them unset? -- mbp
2042
result.master_branch = target
2043
result.local_branch = None
2047
def _basic_push(self, target, overwrite, stop_revision):
2048
"""Basic implementation of push without bound branches or hooks.
2050
Must be called with self read locked and target write locked.
2052
result = PushResult()
2053
result.source_branch = self
2054
result.target_branch = target
2055
result.old_revno, result.old_revid = target.last_revision_info()
2056
if result.old_revid != self.last_revision():
2057
# We assume that during 'push' this repository is closer than
2059
graph = self.repository.get_graph(target.repository)
2060
target.update_revisions(self, stop_revision, overwrite=overwrite,
2062
if self._push_should_merge_tags():
2063
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2064
result.new_revno, result.new_revid = target.last_revision_info()
2067
def get_parent(self):
2068
"""See Branch.get_parent."""
2069
parent = self._get_parent_location()
2072
# This is an old-format absolute path to a local branch
2073
# turn it into a url
2074
if parent.startswith('/'):
2075
parent = urlutils.local_path_to_url(parent.decode('utf8'))
2077
return urlutils.join(self.base[:-1], parent)
2078
except errors.InvalidURLJoin, e:
2079
raise errors.InaccessibleParent(parent, self.base)
2081
def get_stacked_on_url(self):
2082
raise errors.UnstackableBranchFormat(self._format, self.base)
2084
def set_push_location(self, location):
2085
"""See Branch.set_push_location."""
2086
self.get_config().set_user_option(
2087
'push_location', location,
2088
store=_mod_config.STORE_LOCATION_NORECURSE)
2091
def set_parent(self, url):
2092
"""See Branch.set_parent."""
2093
# TODO: Maybe delete old location files?
2094
# URLs should never be unicode, even on the local fs,
2095
# FIXUP this and get_parent in a future branch format bump:
2096
# read and rewrite the file. RBC 20060125
2098
if isinstance(url, unicode):
2100
url = url.encode('ascii')
2101
except UnicodeEncodeError:
2102
raise errors.InvalidURL(url,
2103
"Urls must be 7-bit ascii, "
2104
"use bzrlib.urlutils.escape")
2105
url = urlutils.relative_url(self.base, url)
2106
self._set_parent_location(url)
2108
def _set_parent_location(self, url):
2110
self._transport.delete('parent')
2112
self._transport.put_bytes('parent', url + '\n',
2113
mode=self.bzrdir._get_file_mode())
2115
def set_stacked_on_url(self, url):
2116
raise errors.UnstackableBranchFormat(self._format, self.base)
2119
class BzrBranch5(BzrBranch):
2120
"""A format 5 branch. This supports new features over plain branches.
2122
It has support for a master_branch which is the data for bound branches.
2126
def pull(self, source, overwrite=False, stop_revision=None,
2127
run_hooks=True, possible_transports=None,
2128
_override_hook_target=None):
2129
"""Pull from source into self, updating my master if any.
2131
:param run_hooks: Private parameter - if false, this branch
2132
is being called because it's the master of the primary branch,
2133
so it should not run its hooks.
2135
bound_location = self.get_bound_location()
2136
master_branch = None
2137
if bound_location and source.base != bound_location:
2138
# not pulling from master, so we need to update master.
2139
master_branch = self.get_master_branch(possible_transports)
2140
master_branch.lock_write()
2143
# pull from source into master.
2144
master_branch.pull(source, overwrite, stop_revision,
2146
return super(BzrBranch5, self).pull(source, overwrite,
2147
stop_revision, _hook_master=master_branch,
2148
run_hooks=run_hooks,
2149
_override_hook_target=_override_hook_target)
2152
master_branch.unlock()
2154
def get_bound_location(self):
2156
return self._transport.get_bytes('bound')[:-1]
2157
except errors.NoSuchFile:
2161
def get_master_branch(self, possible_transports=None):
2162
"""Return the branch we are bound to.
2164
:return: Either a Branch, or None
2166
This could memoise the branch, but if thats done
2167
it must be revalidated on each new lock.
2168
So for now we just don't memoise it.
2169
# RBC 20060304 review this decision.
2171
bound_loc = self.get_bound_location()
2175
return Branch.open(bound_loc,
2176
possible_transports=possible_transports)
2177
except (errors.NotBranchError, errors.ConnectionError), e:
2178
raise errors.BoundBranchConnectionFailure(
2182
def set_bound_location(self, location):
2183
"""Set the target where this branch is bound to.
2185
:param location: URL to the target branch
2188
self._transport.put_bytes('bound', location+'\n',
2189
mode=self.bzrdir._get_file_mode())
2192
self._transport.delete('bound')
2193
except errors.NoSuchFile:
2198
def bind(self, other):
2199
"""Bind this branch to the branch other.
2201
This does not push or pull data between the branches, though it does
2202
check for divergence to raise an error when the branches are not
2203
either the same, or one a prefix of the other. That behaviour may not
2204
be useful, so that check may be removed in future.
2206
:param other: The branch to bind to
2209
# TODO: jam 20051230 Consider checking if the target is bound
2210
# It is debatable whether you should be able to bind to
2211
# a branch which is itself bound.
2212
# Committing is obviously forbidden,
2213
# but binding itself may not be.
2214
# Since we *have* to check at commit time, we don't
2215
# *need* to check here
2217
# we want to raise diverged if:
2218
# last_rev is not in the other_last_rev history, AND
2219
# other_last_rev is not in our history, and do it without pulling
2221
self.set_bound_location(other.base)
2225
"""If bound, unbind"""
2226
return self.set_bound_location(None)
2229
def update(self, possible_transports=None):
2230
"""Synchronise this branch with the master branch if any.
2232
:return: None or the last_revision that was pivoted out during the
2235
master = self.get_master_branch(possible_transports)
2236
if master is not None:
2237
old_tip = _mod_revision.ensure_null(self.last_revision())
2238
self.pull(master, overwrite=True)
2239
if self.repository.get_graph().is_ancestor(old_tip,
2240
_mod_revision.ensure_null(self.last_revision())):
2246
class BzrBranch7(BzrBranch5):
2247
"""A branch with support for a fallback repository."""
2249
def _get_fallback_repository(self, url):
2250
"""Get the repository we fallback to at url."""
2251
url = urlutils.join(self.base, url)
2252
a_bzrdir = bzrdir.BzrDir.open(url,
2253
possible_transports=[self._transport])
2254
return a_bzrdir.open_branch().repository
2256
def _activate_fallback_location(self, url):
2257
"""Activate the branch/repository from url as a fallback repository."""
2258
self.repository.add_fallback_repository(
2259
self._get_fallback_repository(url))
2261
def _open_hook(self):
2263
url = self.get_stacked_on_url()
2264
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2265
errors.UnstackableBranchFormat):
2268
for hook in Branch.hooks['transform_fallback_location']:
2269
url = hook(self, url)
2271
hook_name = Branch.hooks.get_hook_name(hook)
2272
raise AssertionError(
2273
"'transform_fallback_location' hook %s returned "
2274
"None, not a URL." % hook_name)
2275
self._activate_fallback_location(url)
2277
def _check_stackable_repo(self):
2278
if not self.repository._format.supports_external_lookups:
2279
raise errors.UnstackableRepositoryFormat(self.repository._format,
2280
self.repository.base)
2282
def __init__(self, *args, **kwargs):
2283
super(BzrBranch7, self).__init__(*args, **kwargs)
2284
self._last_revision_info_cache = None
2285
self._partial_revision_history_cache = []
2287
def _clear_cached_state(self):
2288
super(BzrBranch7, self)._clear_cached_state()
2289
self._last_revision_info_cache = None
2290
self._partial_revision_history_cache = []
2292
def _last_revision_info(self):
2293
revision_string = self._transport.get_bytes('last-revision')
2294
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2295
revision_id = cache_utf8.get_cached_utf8(revision_id)
2297
return revno, revision_id
2299
def _write_last_revision_info(self, revno, revision_id):
2300
"""Simply write out the revision id, with no checks.
2302
Use set_last_revision_info to perform this safely.
2304
Does not update the revision_history cache.
2305
Intended to be called by set_last_revision_info and
2306
_write_revision_history.
2308
revision_id = _mod_revision.ensure_null(revision_id)
2309
out_string = '%d %s\n' % (revno, revision_id)
2310
self._transport.put_bytes('last-revision', out_string,
2311
mode=self.bzrdir._get_file_mode())
2314
def set_last_revision_info(self, revno, revision_id):
2315
revision_id = _mod_revision.ensure_null(revision_id)
2316
old_revno, old_revid = self.last_revision_info()
2317
if self._get_append_revisions_only():
2318
self._check_history_violation(revision_id)
2319
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2320
self._write_last_revision_info(revno, revision_id)
2321
self._clear_cached_state()
2322
self._last_revision_info_cache = revno, revision_id
2323
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2325
def _synchronize_history(self, destination, revision_id):
2326
"""Synchronize last revision and revision history between branches.
2328
:see: Branch._synchronize_history
2330
# XXX: The base Branch has a fast implementation of this method based
2331
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2332
# that uses set_revision_history. This class inherits from BzrBranch5,
2333
# but wants the fast implementation, so it calls
2334
# Branch._synchronize_history directly.
2335
Branch._synchronize_history(self, destination, revision_id)
2337
def _check_history_violation(self, revision_id):
2338
last_revision = _mod_revision.ensure_null(self.last_revision())
2339
if _mod_revision.is_null(last_revision):
2341
if last_revision not in self._lefthand_history(revision_id):
2342
raise errors.AppendRevisionsOnlyViolation(self.base)
2344
def _gen_revision_history(self):
2345
"""Generate the revision history from last revision
2347
last_revno, last_revision = self.last_revision_info()
2348
self._extend_partial_history(stop_index=last_revno-1)
2349
return list(reversed(self._partial_revision_history_cache))
2351
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2352
"""Extend the partial history to include a given index
2354
If a stop_index is supplied, stop when that index has been reached.
2355
If a stop_revision is supplied, stop when that revision is
2356
encountered. Otherwise, stop when the beginning of history is
2359
:param stop_index: The index which should be present. When it is
2360
present, history extension will stop.
2361
:param revision_id: The revision id which should be present. When
2362
it is encountered, history extension will stop.
2364
repo = self.repository
2365
if len(self._partial_revision_history_cache) == 0:
2366
iterator = repo.iter_reverse_revision_history(self.last_revision())
2368
start_revision = self._partial_revision_history_cache[-1]
2369
iterator = repo.iter_reverse_revision_history(start_revision)
2370
#skip the last revision in the list
2371
next_revision = iterator.next()
2372
for revision_id in iterator:
2373
self._partial_revision_history_cache.append(revision_id)
2374
if (stop_index is not None and
2375
len(self._partial_revision_history_cache) > stop_index):
2377
if revision_id == stop_revision:
2380
def _write_revision_history(self, history):
2381
"""Factored out of set_revision_history.
2383
This performs the actual writing to disk, with format-specific checks.
2384
It is intended to be called by BzrBranch5.set_revision_history.
2386
if len(history) == 0:
2387
last_revision = 'null:'
2389
if history != self._lefthand_history(history[-1]):
2390
raise errors.NotLefthandHistory(history)
2391
last_revision = history[-1]
2392
if self._get_append_revisions_only():
2393
self._check_history_violation(last_revision)
2394
self._write_last_revision_info(len(history), last_revision)
2397
def _set_parent_location(self, url):
2398
"""Set the parent branch"""
2399
self._set_config_location('parent_location', url, make_relative=True)
2402
def _get_parent_location(self):
2403
"""Set the parent branch"""
2404
return self._get_config_location('parent_location')
2406
def set_push_location(self, location):
2407
"""See Branch.set_push_location."""
2408
self._set_config_location('push_location', location)
2410
def set_bound_location(self, location):
2411
"""See Branch.set_push_location."""
2413
config = self.get_config()
2414
if location is None:
2415
if config.get_user_option('bound') != 'True':
2418
config.set_user_option('bound', 'False', warn_masked=True)
2421
self._set_config_location('bound_location', location,
2423
config.set_user_option('bound', 'True', warn_masked=True)
2426
def _get_bound_location(self, bound):
2427
"""Return the bound location in the config file.
2429
Return None if the bound parameter does not match"""
2430
config = self.get_config()
2431
config_bound = (config.get_user_option('bound') == 'True')
2432
if config_bound != bound:
2434
return self._get_config_location('bound_location', config=config)
2436
def get_bound_location(self):
2437
"""See Branch.set_push_location."""
2438
return self._get_bound_location(True)
2440
def get_old_bound_location(self):
2441
"""See Branch.get_old_bound_location"""
2442
return self._get_bound_location(False)
2444
def get_stacked_on_url(self):
2445
# you can always ask for the URL; but you might not be able to use it
2446
# if the repo can't support stacking.
2447
## self._check_stackable_repo()
2448
stacked_url = self._get_config_location('stacked_on_location')
2449
if stacked_url is None:
2450
raise errors.NotStacked(self)
2453
def set_append_revisions_only(self, enabled):
2458
self.get_config().set_user_option('append_revisions_only', value,
2461
def set_stacked_on_url(self, url):
2462
self._check_stackable_repo()
2465
old_url = self.get_stacked_on_url()
2466
except (errors.NotStacked, errors.UnstackableBranchFormat,
2467
errors.UnstackableRepositoryFormat):
2470
# repositories don't offer an interface to remove fallback
2471
# repositories today; take the conceptually simpler option and just
2473
self.repository = self.bzrdir.find_repository()
2474
# for every revision reference the branch has, ensure it is pulled
2476
source_repository = self._get_fallback_repository(old_url)
2477
for revision_id in chain([self.last_revision()],
2478
self.tags.get_reverse_tag_dict()):
2479
self.repository.fetch(source_repository, revision_id,
2482
self._activate_fallback_location(url)
2483
# write this out after the repository is stacked to avoid setting a
2484
# stacked config that doesn't work.
2485
self._set_config_location('stacked_on_location', url)
2487
def _get_append_revisions_only(self):
2488
value = self.get_config().get_user_option('append_revisions_only')
2489
return value == 'True'
2491
def _make_tags(self):
2492
return BasicTags(self)
2495
def generate_revision_history(self, revision_id, last_rev=None,
2497
"""See BzrBranch5.generate_revision_history"""
2498
history = self._lefthand_history(revision_id, last_rev, other_branch)
2499
revno = len(history)
2500
self.set_last_revision_info(revno, revision_id)
2503
def get_rev_id(self, revno, history=None):
2504
"""Find the revision id of the specified revno."""
2506
return _mod_revision.NULL_REVISION
2508
last_revno, last_revision_id = self.last_revision_info()
2509
if revno <= 0 or revno > last_revno:
2510
raise errors.NoSuchRevision(self, revno)
2512
if history is not None:
2513
return history[revno - 1]
2515
index = last_revno - revno
2516
if len(self._partial_revision_history_cache) <= index:
2517
self._extend_partial_history(stop_index=index)
2518
if len(self._partial_revision_history_cache) > index:
2519
return self._partial_revision_history_cache[index]
2521
raise errors.NoSuchRevision(self, revno)
2524
def revision_id_to_revno(self, revision_id):
2525
"""Given a revision id, return its revno"""
2526
if _mod_revision.is_null(revision_id):
2529
index = self._partial_revision_history_cache.index(revision_id)
2531
self._extend_partial_history(stop_revision=revision_id)
2532
index = len(self._partial_revision_history_cache) - 1
2533
if self._partial_revision_history_cache[index] != revision_id:
2534
raise errors.NoSuchRevision(self, revision_id)
2535
return self.revno() - index
2538
class BzrBranch6(BzrBranch7):
2539
"""See BzrBranchFormat6 for the capabilities of this branch.
2541
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2545
def get_stacked_on_url(self):
2546
raise errors.UnstackableBranchFormat(self._format, self.base)
2548
def set_stacked_on_url(self, url):
2549
raise errors.UnstackableBranchFormat(self._format, self.base)
2552
######################################################################
2553
# results of operations
2556
class _Result(object):
2558
def _show_tag_conficts(self, to_file):
2559
if not getattr(self, 'tag_conflicts', None):
2561
to_file.write('Conflicting tags:\n')
2562
for name, value1, value2 in self.tag_conflicts:
2563
to_file.write(' %s\n' % (name, ))
2566
class PullResult(_Result):
2567
"""Result of a Branch.pull operation.
2569
:ivar old_revno: Revision number before pull.
2570
:ivar new_revno: Revision number after pull.
2571
:ivar old_revid: Tip revision id before pull.
2572
:ivar new_revid: Tip revision id after pull.
2573
:ivar source_branch: Source (local) branch object.
2574
:ivar master_branch: Master branch of the target, or the target if no
2576
:ivar local_branch: target branch if there is a Master, else None
2577
:ivar target_branch: Target/destination branch object.
2578
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2582
# DEPRECATED: pull used to return the change in revno
2583
return self.new_revno - self.old_revno
2585
def report(self, to_file):
2587
if self.old_revid == self.new_revid:
2588
to_file.write('No revisions to pull.\n')
2590
to_file.write('Now on revision %d.\n' % self.new_revno)
2591
self._show_tag_conficts(to_file)
2594
class PushResult(_Result):
2595
"""Result of a Branch.push operation.
2597
:ivar old_revno: Revision number before push.
2598
:ivar new_revno: Revision number after push.
2599
:ivar old_revid: Tip revision id before push.
2600
:ivar new_revid: Tip revision id after push.
2601
:ivar source_branch: Source branch object.
2602
:ivar master_branch: Master branch of the target, or None.
2603
:ivar target_branch: Target/destination branch object.
2607
# DEPRECATED: push used to return the change in revno
2608
return self.new_revno - self.old_revno
2610
def report(self, to_file):
2611
"""Write a human-readable description of the result."""
2612
if self.old_revid == self.new_revid:
2613
note('No new revisions to push.')
2615
note('Pushed up to revision %d.' % self.new_revno)
2616
self._show_tag_conficts(to_file)
2619
class BranchCheckResult(object):
2620
"""Results of checking branch consistency.
2625
def __init__(self, branch):
2626
self.branch = branch
2628
def report_results(self, verbose):
2629
"""Report the check results via trace.note.
2631
:param verbose: Requests more detailed display of what was checked,
2634
note('checked branch %s format %s',
2636
self.branch._format)
2639
class Converter5to6(object):
2640
"""Perform an in-place upgrade of format 5 to format 6"""
2642
def convert(self, branch):
2643
# Data for 5 and 6 can peacefully coexist.
2644
format = BzrBranchFormat6()
2645
new_branch = format.open(branch.bzrdir, _found=True)
2647
# Copy source data into target
2648
new_branch._write_last_revision_info(*branch.last_revision_info())
2649
new_branch.set_parent(branch.get_parent())
2650
new_branch.set_bound_location(branch.get_bound_location())
2651
new_branch.set_push_location(branch.get_push_location())
2653
# New branch has no tags by default
2654
new_branch.tags._set_tag_dict({})
2656
# Copying done; now update target format
2657
new_branch._transport.put_bytes('format',
2658
format.get_format_string(),
2659
mode=new_branch.bzrdir._get_file_mode())
2661
# Clean up old files
2662
new_branch._transport.delete('revision-history')
2664
branch.set_parent(None)
2665
except errors.NoSuchFile:
2667
branch.set_bound_location(None)
2670
class Converter6to7(object):
2671
"""Perform an in-place upgrade of format 6 to format 7"""
2673
def convert(self, branch):
2674
format = BzrBranchFormat7()
2675
branch._set_config_location('stacked_on_location', '')
2676
# update target format
2677
branch._transport.put_bytes('format', format.get_format_string())
2681
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2682
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2685
_run_with_write_locked_target will attempt to release the lock it acquires.
2687
If an exception is raised by callable, then that exception *will* be
2688
propagated, even if the unlock attempt raises its own error. Thus
2689
_run_with_write_locked_target should be preferred to simply doing::
2693
return callable(*args, **kwargs)
2698
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2699
# should share code?
2702
result = callable(*args, **kwargs)
2704
exc_info = sys.exc_info()
2708
raise exc_info[0], exc_info[1], exc_info[2]
2714
class InterBranch(InterObject):
2715
"""This class represents operations taking place between two branches.
2717
Its instances have methods like pull() and push() and contain
2718
references to the source and target repositories these operations
2719
can be carried out on.
2723
"""The available optimised InterBranch types."""
2726
def _get_branch_formats_to_test():
2727
"""Return a tuple with the Branch formats to use when testing."""
2728
raise NotImplementedError(self._get_branch_formats_to_test)
2730
def update_revisions(self, stop_revision=None, overwrite=False,
2732
"""Pull in new perfect-fit revisions.
2734
:param stop_revision: Updated until the given revision
2735
:param overwrite: Always set the branch pointer, rather than checking
2736
to see if it is a proper descendant.
2737
:param graph: A Graph object that can be used to query history
2738
information. This can be None.
2741
raise NotImplementedError(self.update_revisions)
2744
class GenericInterBranch(InterBranch):
2745
"""InterBranch implementation that uses public Branch functions.
2749
def _get_branch_formats_to_test():
2750
return BranchFormat._default_format, BranchFormat._default_format
2752
def update_revisions(self, stop_revision=None, overwrite=False,
2754
"""See InterBranch.update_revisions()."""
2755
self.source.lock_read()
2757
other_revno, other_last_revision = self.source.last_revision_info()
2758
stop_revno = None # unknown
2759
if stop_revision is None:
2760
stop_revision = other_last_revision
2761
if _mod_revision.is_null(stop_revision):
2762
# if there are no commits, we're done.
2764
stop_revno = other_revno
2766
# what's the current last revision, before we fetch [and change it
2768
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2769
# we fetch here so that we don't process data twice in the common
2770
# case of having something to pull, and so that the check for
2771
# already merged can operate on the just fetched graph, which will
2772
# be cached in memory.
2773
self.target.fetch(self.source, stop_revision)
2774
# Check to see if one is an ancestor of the other
2777
graph = self.target.repository.get_graph()
2778
if self.target._check_if_descendant_or_diverged(
2779
stop_revision, last_rev, graph, self.source):
2780
# stop_revision is a descendant of last_rev, but we aren't
2781
# overwriting, so we're done.
2783
if stop_revno is None:
2785
graph = self.target.repository.get_graph()
2786
this_revno, this_last_revision = \
2787
self.target.last_revision_info()
2788
stop_revno = graph.find_distance_to_null(stop_revision,
2789
[(other_last_revision, other_revno),
2790
(this_last_revision, this_revno)])
2791
self.target.set_last_revision_info(stop_revno, stop_revision)
2793
self.source.unlock()
2796
def is_compatible(self, source, target):
2797
# GenericBranch uses the public API, so always compatible
2801
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
