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, repository_policy=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
if repository_policy is not None:
892
repository_policy.configure_branch(result)
893
self.copy_content_into(result, revision_id=revision_id)
897
def sprout(self, to_bzrdir, revision_id=None):
898
"""Create a new line of development from the branch, into to_bzrdir.
900
to_bzrdir controls the branch format.
902
revision_id: if not None, the revision history in the new branch will
903
be truncated to end with revision_id.
905
result = to_bzrdir.create_branch()
906
self.copy_content_into(result, revision_id=revision_id)
907
result.set_parent(self.bzrdir.root_transport.base)
910
def _synchronize_history(self, destination, revision_id):
911
"""Synchronize last revision and revision history between branches.
913
This version is most efficient when the destination is also a
914
BzrBranch6, but works for BzrBranch5, as long as the destination's
915
repository contains all the lefthand ancestors of the intended
916
last_revision. If not, set_last_revision_info will fail.
918
:param destination: The branch to copy the history into
919
:param revision_id: The revision-id to truncate history at. May
920
be None to copy complete history.
922
source_revno, source_revision_id = self.last_revision_info()
923
if revision_id is None:
924
revno, revision_id = source_revno, source_revision_id
925
elif source_revision_id == revision_id:
926
# we know the revno without needing to walk all of history
929
# To figure out the revno for a random revision, we need to build
930
# the revision history, and count its length.
931
# We don't care about the order, just how long it is.
932
# Alternatively, we could start at the current location, and count
933
# backwards. But there is no guarantee that we will find it since
934
# it may be a merged revision.
935
revno = len(list(self.repository.iter_reverse_revision_history(
937
destination.set_last_revision_info(revno, revision_id)
940
def copy_content_into(self, destination, revision_id=None):
941
"""Copy the content of self into destination.
943
revision_id: if not None, the revision history in the new branch will
944
be truncated to end with revision_id.
946
self._synchronize_history(destination, revision_id)
948
parent = self.get_parent()
949
except errors.InaccessibleParent, e:
950
mutter('parent was not accessible to copy: %s', e)
953
destination.set_parent(parent)
954
if self._push_should_merge_tags():
955
self.tags.merge_to(destination.tags)
959
"""Check consistency of the branch.
961
In particular this checks that revisions given in the revision-history
962
do actually match up in the revision graph, and that they're all
963
present in the repository.
965
Callers will typically also want to check the repository.
967
:return: A BranchCheckResult.
969
mainline_parent_id = None
970
last_revno, last_revision_id = self.last_revision_info()
971
real_rev_history = list(self.repository.iter_reverse_revision_history(
973
real_rev_history.reverse()
974
if len(real_rev_history) != last_revno:
975
raise errors.BzrCheckError('revno does not match len(mainline)'
976
' %s != %s' % (last_revno, len(real_rev_history)))
977
# TODO: We should probably also check that real_rev_history actually
978
# matches self.revision_history()
979
for revision_id in real_rev_history:
981
revision = self.repository.get_revision(revision_id)
982
except errors.NoSuchRevision, e:
983
raise errors.BzrCheckError("mainline revision {%s} not in repository"
985
# In general the first entry on the revision history has no parents.
986
# But it's not illegal for it to have parents listed; this can happen
987
# in imports from Arch when the parents weren't reachable.
988
if mainline_parent_id is not None:
989
if mainline_parent_id not in revision.parent_ids:
990
raise errors.BzrCheckError("previous revision {%s} not listed among "
992
% (mainline_parent_id, revision_id))
993
mainline_parent_id = revision_id
994
return BranchCheckResult(self)
996
def _get_checkout_format(self):
997
"""Return the most suitable metadir for a checkout of this branch.
998
Weaves are used if this branch's repository uses weaves.
1000
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1001
from bzrlib.repofmt import weaverepo
1002
format = bzrdir.BzrDirMetaFormat1()
1003
format.repository_format = weaverepo.RepositoryFormat7()
1005
format = self.repository.bzrdir.checkout_metadir()
1006
format.set_branch_format(self._format)
1009
def create_clone_on_transport(self, to_transport, revision_id=None,
1011
"""Create a clone of this branch and its bzrdir.
1013
:param to_transport: The transport to clone onto.
1014
:param revision_id: The revision id to use as tip in the new branch.
1015
If None the tip is obtained from this branch.
1016
:param stacked_on: An optional URL to stack the clone on.
1018
# XXX: Fix the bzrdir API to allow getting the branch back from the
1019
# clone call. Or something. 20090224 RBC/spiv.
1020
dir_to = self.bzrdir.clone_on_transport(to_transport,
1021
revision_id=revision_id, stacked_on=stacked_on)
1022
return dir_to.open_branch()
1024
def create_checkout(self, to_location, revision_id=None,
1025
lightweight=False, accelerator_tree=None,
1027
"""Create a checkout of a branch.
1029
:param to_location: The url to produce the checkout at
1030
:param revision_id: The revision to check out
1031
:param lightweight: If True, produce a lightweight checkout, otherwise,
1032
produce a bound branch (heavyweight checkout)
1033
:param accelerator_tree: A tree which can be used for retrieving file
1034
contents more quickly than the revision tree, i.e. a workingtree.
1035
The revision tree will be used for cases where accelerator_tree's
1036
content is different.
1037
:param hardlink: If true, hard-link files from accelerator_tree,
1039
:return: The tree of the created checkout
1041
t = transport.get_transport(to_location)
1044
format = self._get_checkout_format()
1045
checkout = format.initialize_on_transport(t)
1046
from_branch = BranchReferenceFormat().initialize(checkout, self)
1048
format = self._get_checkout_format()
1049
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1050
to_location, force_new_tree=False, format=format)
1051
checkout = checkout_branch.bzrdir
1052
checkout_branch.bind(self)
1053
# pull up to the specified revision_id to set the initial
1054
# branch tip correctly, and seed it with history.
1055
checkout_branch.pull(self, stop_revision=revision_id)
1057
tree = checkout.create_workingtree(revision_id,
1058
from_branch=from_branch,
1059
accelerator_tree=accelerator_tree,
1061
basis_tree = tree.basis_tree()
1062
basis_tree.lock_read()
1064
for path, file_id in basis_tree.iter_references():
1065
reference_parent = self.reference_parent(file_id, path)
1066
reference_parent.create_checkout(tree.abspath(path),
1067
basis_tree.get_reference_revision(file_id, path),
1074
def reconcile(self, thorough=True):
1075
"""Make sure the data stored in this branch is consistent."""
1076
from bzrlib.reconcile import BranchReconciler
1077
reconciler = BranchReconciler(self, thorough=thorough)
1078
reconciler.reconcile()
1081
def reference_parent(self, file_id, path):
1082
"""Return the parent branch for a tree-reference file_id
1083
:param file_id: The file_id of the tree reference
1084
:param path: The path of the file_id in the tree
1085
:return: A branch associated with the file_id
1087
# FIXME should provide multiple branches, based on config
1088
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1090
def supports_tags(self):
1091
return self._format.supports_tags()
1093
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1095
"""Ensure that revision_b is a descendant of revision_a.
1097
This is a helper function for update_revisions.
1099
:raises: DivergedBranches if revision_b has diverged from revision_a.
1100
:returns: True if revision_b is a descendant of revision_a.
1102
relation = self._revision_relations(revision_a, revision_b, graph)
1103
if relation == 'b_descends_from_a':
1105
elif relation == 'diverged':
1106
raise errors.DivergedBranches(self, other_branch)
1107
elif relation == 'a_descends_from_b':
1110
raise AssertionError("invalid relation: %r" % (relation,))
1112
def _revision_relations(self, revision_a, revision_b, graph):
1113
"""Determine the relationship between two revisions.
1115
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1117
heads = graph.heads([revision_a, revision_b])
1118
if heads == set([revision_b]):
1119
return 'b_descends_from_a'
1120
elif heads == set([revision_a, revision_b]):
1121
# These branches have diverged
1123
elif heads == set([revision_a]):
1124
return 'a_descends_from_b'
1126
raise AssertionError("invalid heads: %r" % (heads,))
1129
class BranchFormat(object):
1130
"""An encapsulation of the initialization and open routines for a format.
1132
Formats provide three things:
1133
* An initialization routine,
1137
Formats are placed in an dict by their format string for reference
1138
during branch opening. Its not required that these be instances, they
1139
can be classes themselves with class methods - it simply depends on
1140
whether state is needed for a given format or not.
1142
Once a format is deprecated, just deprecate the initialize and open
1143
methods on the format class. Do not deprecate the object, as the
1144
object will be created every time regardless.
1147
_default_format = None
1148
"""The default format used for new branches."""
1151
"""The known formats."""
1153
def __eq__(self, other):
1154
return self.__class__ is other.__class__
1156
def __ne__(self, other):
1157
return not (self == other)
1160
def find_format(klass, a_bzrdir):
1161
"""Return the format for the branch object in a_bzrdir."""
1163
transport = a_bzrdir.get_branch_transport(None)
1164
format_string = transport.get("format").read()
1165
return klass._formats[format_string]
1166
except errors.NoSuchFile:
1167
raise errors.NotBranchError(path=transport.base)
1169
raise errors.UnknownFormatError(format=format_string, kind='branch')
1172
def get_default_format(klass):
1173
"""Return the current default format."""
1174
return klass._default_format
1176
def get_reference(self, a_bzrdir):
1177
"""Get the target reference of the branch in a_bzrdir.
1179
format probing must have been completed before calling
1180
this method - it is assumed that the format of the branch
1181
in a_bzrdir is correct.
1183
:param a_bzrdir: The bzrdir to get the branch data from.
1184
:return: None if the branch is not a reference branch.
1189
def set_reference(self, a_bzrdir, to_branch):
1190
"""Set the target reference of the branch in a_bzrdir.
1192
format probing must have been completed before calling
1193
this method - it is assumed that the format of the branch
1194
in a_bzrdir is correct.
1196
:param a_bzrdir: The bzrdir to set the branch reference for.
1197
:param to_branch: branch that the checkout is to reference
1199
raise NotImplementedError(self.set_reference)
1201
def get_format_string(self):
1202
"""Return the ASCII format string that identifies this format."""
1203
raise NotImplementedError(self.get_format_string)
1205
def get_format_description(self):
1206
"""Return the short format description for this format."""
1207
raise NotImplementedError(self.get_format_description)
1209
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1211
"""Initialize a branch in a bzrdir, with specified files
1213
:param a_bzrdir: The bzrdir to initialize the branch in
1214
:param utf8_files: The files to create as a list of
1215
(filename, content) tuples
1216
:param set_format: If True, set the format with
1217
self.get_format_string. (BzrBranch4 has its format set
1219
:return: a branch in this format
1221
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1222
branch_transport = a_bzrdir.get_branch_transport(self)
1224
'metadir': ('lock', lockdir.LockDir),
1225
'branch4': ('branch-lock', lockable_files.TransportLock),
1227
lock_name, lock_class = lock_map[lock_type]
1228
control_files = lockable_files.LockableFiles(branch_transport,
1229
lock_name, lock_class)
1230
control_files.create_lock()
1231
control_files.lock_write()
1233
utf8_files += [('format', self.get_format_string())]
1235
for (filename, content) in utf8_files:
1236
branch_transport.put_bytes(
1238
mode=a_bzrdir._get_file_mode())
1240
control_files.unlock()
1241
return self.open(a_bzrdir, _found=True)
1243
def initialize(self, a_bzrdir):
1244
"""Create a branch of this format in a_bzrdir."""
1245
raise NotImplementedError(self.initialize)
1247
def is_supported(self):
1248
"""Is this format supported?
1250
Supported formats can be initialized and opened.
1251
Unsupported formats may not support initialization or committing or
1252
some other features depending on the reason for not being supported.
1256
def network_name(self):
1257
"""A simple byte string uniquely identifying this format for RPC calls.
1259
MetaDir branch formats use their disk format string to identify the
1260
repository over the wire. All in one formats such as bzr < 0.8, and
1261
foreign formats like svn/git and hg should use some marker which is
1262
unique and immutable.
1264
raise NotImplementedError(self.network_name)
1266
def open(self, a_bzrdir, _found=False):
1267
"""Return the branch object for a_bzrdir
1269
_found is a private parameter, do not use it. It is used to indicate
1270
if format probing has already be done.
1272
raise NotImplementedError(self.open)
1275
def register_format(klass, format):
1276
"""Register a metadir format."""
1277
klass._formats[format.get_format_string()] = format
1278
# Metadir formats have a network name of their format string.
1279
network_format_registry.register(format.get_format_string(), format)
1282
def set_default_format(klass, format):
1283
klass._default_format = format
1285
def supports_stacking(self):
1286
"""True if this format records a stacked-on branch."""
1290
def unregister_format(klass, format):
1291
del klass._formats[format.get_format_string()]
1294
return self.get_format_description().rstrip()
1296
def supports_tags(self):
1297
"""True if this format supports tags stored in the branch"""
1298
return False # by default
1301
class BranchHooks(Hooks):
1302
"""A dictionary mapping hook name to a list of callables for branch hooks.
1304
e.g. ['set_rh'] Is the list of items to be called when the
1305
set_revision_history function is invoked.
1309
"""Create the default hooks.
1311
These are all empty initially, because by default nothing should get
1314
Hooks.__init__(self)
1315
# Introduced in 0.15:
1316
# invoked whenever the revision history has been set
1317
# with set_revision_history. The api signature is
1318
# (branch, revision_history), and the branch will
1321
# Invoked after a branch is opened. The api signature is (branch).
1323
# invoked after a push operation completes.
1324
# the api signature is
1326
# containing the members
1327
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1328
# where local is the local target branch or None, master is the target
1329
# master branch, and the rest should be self explanatory. The source
1330
# is read locked and the target branches write locked. Source will
1331
# be the local low-latency branch.
1332
self['post_push'] = []
1333
# invoked after a pull operation completes.
1334
# the api signature is
1336
# containing the members
1337
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1338
# where local is the local branch or None, master is the target
1339
# master branch, and the rest should be self explanatory. The source
1340
# is read locked and the target branches write locked. The local
1341
# branch is the low-latency branch.
1342
self['post_pull'] = []
1343
# invoked before a commit operation takes place.
1344
# the api signature is
1345
# (local, master, old_revno, old_revid, future_revno, future_revid,
1346
# tree_delta, future_tree).
1347
# old_revid is NULL_REVISION for the first commit to a branch
1348
# tree_delta is a TreeDelta object describing changes from the basis
1349
# revision, hooks MUST NOT modify this delta
1350
# future_tree is an in-memory tree obtained from
1351
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1352
self['pre_commit'] = []
1353
# invoked after a commit operation completes.
1354
# the api signature is
1355
# (local, master, old_revno, old_revid, new_revno, new_revid)
1356
# old_revid is NULL_REVISION for the first commit to a branch.
1357
self['post_commit'] = []
1358
# invoked after a uncommit operation completes.
1359
# the api signature is
1360
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1361
# local is the local branch or None, master is the target branch,
1362
# and an empty branch recieves new_revno of 0, new_revid of None.
1363
self['post_uncommit'] = []
1365
# Invoked before the tip of a branch changes.
1366
# the api signature is
1367
# (params) where params is a ChangeBranchTipParams with the members
1368
# (branch, old_revno, new_revno, old_revid, new_revid)
1369
self['pre_change_branch_tip'] = []
1371
# Invoked after the tip of a branch changes.
1372
# the api signature is
1373
# (params) where params is a ChangeBranchTipParams with the members
1374
# (branch, old_revno, new_revno, old_revid, new_revid)
1375
self['post_change_branch_tip'] = []
1377
# Invoked when a stacked branch activates its fallback locations and
1378
# allows the transformation of the url of said location.
1379
# the api signature is
1380
# (branch, url) where branch is the branch having its fallback
1381
# location activated and url is the url for the fallback location.
1382
# The hook should return a url.
1383
self['transform_fallback_location'] = []
1386
# install the default hooks into the Branch class.
1387
Branch.hooks = BranchHooks()
1390
class ChangeBranchTipParams(object):
1391
"""Object holding parameters passed to *_change_branch_tip hooks.
1393
There are 5 fields that hooks may wish to access:
1395
:ivar branch: the branch being changed
1396
:ivar old_revno: revision number before the change
1397
:ivar new_revno: revision number after the change
1398
:ivar old_revid: revision id before the change
1399
:ivar new_revid: revision id after the change
1401
The revid fields are strings. The revno fields are integers.
1404
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1405
"""Create a group of ChangeBranchTip parameters.
1407
:param branch: The branch being changed.
1408
:param old_revno: Revision number before the change.
1409
:param new_revno: Revision number after the change.
1410
:param old_revid: Tip revision id before the change.
1411
:param new_revid: Tip revision id after the change.
1413
self.branch = branch
1414
self.old_revno = old_revno
1415
self.new_revno = new_revno
1416
self.old_revid = old_revid
1417
self.new_revid = new_revid
1419
def __eq__(self, other):
1420
return self.__dict__ == other.__dict__
1423
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1424
self.__class__.__name__, self.branch,
1425
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1428
class BzrBranchFormat4(BranchFormat):
1429
"""Bzr branch format 4.
1432
- a revision-history file.
1433
- a branch-lock lock file [ to be shared with the bzrdir ]
1436
def get_format_description(self):
1437
"""See BranchFormat.get_format_description()."""
1438
return "Branch format 4"
1440
def initialize(self, a_bzrdir):
1441
"""Create a branch of this format in a_bzrdir."""
1442
utf8_files = [('revision-history', ''),
1443
('branch-name', ''),
1445
return self._initialize_helper(a_bzrdir, utf8_files,
1446
lock_type='branch4', set_format=False)
1449
super(BzrBranchFormat4, self).__init__()
1450
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1452
def network_name(self):
1453
"""The network name for this format is the control dirs disk label."""
1454
return self._matchingbzrdir.get_format_string()
1456
def open(self, a_bzrdir, _found=False):
1457
"""Return the branch object for a_bzrdir
1459
_found is a private parameter, do not use it. It is used to indicate
1460
if format probing has already be done.
1463
# we are being called directly and must probe.
1464
raise NotImplementedError
1465
return BzrBranch(_format=self,
1466
_control_files=a_bzrdir._control_files,
1468
_repository=a_bzrdir.open_repository())
1471
return "Bazaar-NG branch format 4"
1474
class BranchFormatMetadir(BranchFormat):
1475
"""Common logic for meta-dir based branch formats."""
1477
def _branch_class(self):
1478
"""What class to instantiate on open calls."""
1479
raise NotImplementedError(self._branch_class)
1481
def network_name(self):
1482
"""A simple byte string uniquely identifying this format for RPC calls.
1484
Metadir branch formats use their format string.
1486
return self.get_format_string()
1488
def open(self, a_bzrdir, _found=False):
1489
"""Return the branch object for a_bzrdir.
1491
_found is a private parameter, do not use it. It is used to indicate
1492
if format probing has already be done.
1495
format = BranchFormat.find_format(a_bzrdir)
1496
if format.__class__ != self.__class__:
1497
raise AssertionError("wrong format %r found for %r" %
1500
transport = a_bzrdir.get_branch_transport(None)
1501
control_files = lockable_files.LockableFiles(transport, 'lock',
1503
return self._branch_class()(_format=self,
1504
_control_files=control_files,
1506
_repository=a_bzrdir.find_repository())
1507
except errors.NoSuchFile:
1508
raise errors.NotBranchError(path=transport.base)
1511
super(BranchFormatMetadir, self).__init__()
1512
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1513
self._matchingbzrdir.set_branch_format(self)
1515
def supports_tags(self):
1519
class BzrBranchFormat5(BranchFormatMetadir):
1520
"""Bzr branch format 5.
1523
- a revision-history file.
1525
- a lock dir guarding the branch itself
1526
- all of this stored in a branch/ subdirectory
1527
- works with shared repositories.
1529
This format is new in bzr 0.8.
1532
def _branch_class(self):
1535
def get_format_string(self):
1536
"""See BranchFormat.get_format_string()."""
1537
return "Bazaar-NG branch format 5\n"
1539
def get_format_description(self):
1540
"""See BranchFormat.get_format_description()."""
1541
return "Branch format 5"
1543
def initialize(self, a_bzrdir):
1544
"""Create a branch of this format in a_bzrdir."""
1545
utf8_files = [('revision-history', ''),
1546
('branch-name', ''),
1548
return self._initialize_helper(a_bzrdir, utf8_files)
1550
def supports_tags(self):
1554
class BzrBranchFormat6(BranchFormatMetadir):
1555
"""Branch format with last-revision and tags.
1557
Unlike previous formats, this has no explicit revision history. Instead,
1558
this just stores the last-revision, and the left-hand history leading
1559
up to there is the history.
1561
This format was introduced in bzr 0.15
1562
and became the default in 0.91.
1565
def _branch_class(self):
1568
def get_format_string(self):
1569
"""See BranchFormat.get_format_string()."""
1570
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1572
def get_format_description(self):
1573
"""See BranchFormat.get_format_description()."""
1574
return "Branch format 6"
1576
def initialize(self, a_bzrdir):
1577
"""Create a branch of this format in a_bzrdir."""
1578
utf8_files = [('last-revision', '0 null:\n'),
1579
('branch.conf', ''),
1582
return self._initialize_helper(a_bzrdir, utf8_files)
1585
class BzrBranchFormat7(BranchFormatMetadir):
1586
"""Branch format with last-revision, tags, and a stacked location pointer.
1588
The stacked location pointer is passed down to the repository and requires
1589
a repository format with supports_external_lookups = True.
1591
This format was introduced in bzr 1.6.
1594
def _branch_class(self):
1597
def get_format_string(self):
1598
"""See BranchFormat.get_format_string()."""
1599
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1601
def get_format_description(self):
1602
"""See BranchFormat.get_format_description()."""
1603
return "Branch format 7"
1605
def initialize(self, a_bzrdir):
1606
"""Create a branch of this format in a_bzrdir."""
1607
utf8_files = [('last-revision', '0 null:\n'),
1608
('branch.conf', ''),
1611
return self._initialize_helper(a_bzrdir, utf8_files)
1614
super(BzrBranchFormat7, self).__init__()
1615
self._matchingbzrdir.repository_format = \
1616
RepositoryFormatKnitPack5RichRoot()
1618
def supports_stacking(self):
1622
class BranchReferenceFormat(BranchFormat):
1623
"""Bzr branch reference format.
1625
Branch references are used in implementing checkouts, they
1626
act as an alias to the real branch which is at some other url.
1633
def get_format_string(self):
1634
"""See BranchFormat.get_format_string()."""
1635
return "Bazaar-NG Branch Reference Format 1\n"
1637
def get_format_description(self):
1638
"""See BranchFormat.get_format_description()."""
1639
return "Checkout reference format 1"
1641
def get_reference(self, a_bzrdir):
1642
"""See BranchFormat.get_reference()."""
1643
transport = a_bzrdir.get_branch_transport(None)
1644
return transport.get('location').read()
1646
def set_reference(self, a_bzrdir, to_branch):
1647
"""See BranchFormat.set_reference()."""
1648
transport = a_bzrdir.get_branch_transport(None)
1649
location = transport.put_bytes('location', to_branch.base)
1651
def initialize(self, a_bzrdir, target_branch=None):
1652
"""Create a branch of this format in a_bzrdir."""
1653
if target_branch is None:
1654
# this format does not implement branch itself, thus the implicit
1655
# creation contract must see it as uninitializable
1656
raise errors.UninitializableFormat(self)
1657
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1658
branch_transport = a_bzrdir.get_branch_transport(self)
1659
branch_transport.put_bytes('location',
1660
target_branch.bzrdir.root_transport.base)
1661
branch_transport.put_bytes('format', self.get_format_string())
1663
a_bzrdir, _found=True,
1664
possible_transports=[target_branch.bzrdir.root_transport])
1667
super(BranchReferenceFormat, self).__init__()
1668
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1669
self._matchingbzrdir.set_branch_format(self)
1671
def _make_reference_clone_function(format, a_branch):
1672
"""Create a clone() routine for a branch dynamically."""
1673
def clone(to_bzrdir, revision_id=None,
1674
repository_policy=None):
1675
"""See Branch.clone()."""
1676
return format.initialize(to_bzrdir, a_branch)
1677
# cannot obey revision_id limits when cloning a reference ...
1678
# FIXME RBC 20060210 either nuke revision_id for clone, or
1679
# emit some sort of warning/error to the caller ?!
1682
def open(self, a_bzrdir, _found=False, location=None,
1683
possible_transports=None):
1684
"""Return the branch that the branch reference in a_bzrdir points at.
1686
_found is a private parameter, do not use it. It is used to indicate
1687
if format probing has already be done.
1690
format = BranchFormat.find_format(a_bzrdir)
1691
if format.__class__ != self.__class__:
1692
raise AssertionError("wrong format %r found for %r" %
1694
if location is None:
1695
location = self.get_reference(a_bzrdir)
1696
real_bzrdir = bzrdir.BzrDir.open(
1697
location, possible_transports=possible_transports)
1698
result = real_bzrdir.open_branch()
1699
# this changes the behaviour of result.clone to create a new reference
1700
# rather than a copy of the content of the branch.
1701
# I did not use a proxy object because that needs much more extensive
1702
# testing, and we are only changing one behaviour at the moment.
1703
# If we decide to alter more behaviours - i.e. the implicit nickname
1704
# then this should be refactored to introduce a tested proxy branch
1705
# and a subclass of that for use in overriding clone() and ....
1707
result.clone = self._make_reference_clone_function(result)
1711
network_format_registry = registry.FormatRegistry()
1712
"""Registry of formats indexed by their network name.
1714
The network name for a repository format is an identifier that can be used when
1715
referring to formats with smart server operations. See
1716
BranchFormat.network_name() for more detail.
1720
# formats which have no format string are not discoverable
1721
# and not independently creatable, so are not registered.
1722
__format5 = BzrBranchFormat5()
1723
__format6 = BzrBranchFormat6()
1724
__format7 = BzrBranchFormat7()
1725
BranchFormat.register_format(__format5)
1726
BranchFormat.register_format(BranchReferenceFormat())
1727
BranchFormat.register_format(__format6)
1728
BranchFormat.register_format(__format7)
1729
BranchFormat.set_default_format(__format6)
1730
_legacy_formats = [BzrBranchFormat4(),
1732
network_format_registry.register(
1733
_legacy_formats[0].network_name(), _legacy_formats[0])
1736
class BzrBranch(Branch):
1737
"""A branch stored in the actual filesystem.
1739
Note that it's "local" in the context of the filesystem; it doesn't
1740
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1741
it's writable, and can be accessed via the normal filesystem API.
1743
:ivar _transport: Transport for file operations on this branch's
1744
control files, typically pointing to the .bzr/branch directory.
1745
:ivar repository: Repository for this branch.
1746
:ivar base: The url of the base directory for this branch; the one
1747
containing the .bzr directory.
1750
def __init__(self, _format=None,
1751
_control_files=None, a_bzrdir=None, _repository=None):
1752
"""Create new branch object at a particular location."""
1753
if a_bzrdir is None:
1754
raise ValueError('a_bzrdir must be supplied')
1756
self.bzrdir = a_bzrdir
1757
self._base = self.bzrdir.transport.clone('..').base
1758
# XXX: We should be able to just do
1759
# self.base = self.bzrdir.root_transport.base
1760
# but this does not quite work yet -- mbp 20080522
1761
self._format = _format
1762
if _control_files is None:
1763
raise ValueError('BzrBranch _control_files is None')
1764
self.control_files = _control_files
1765
self._transport = _control_files._transport
1766
self.repository = _repository
1767
Branch.__init__(self)
1770
return '%s(%r)' % (self.__class__.__name__, self.base)
1774
def _get_base(self):
1775
"""Returns the directory containing the control directory."""
1778
base = property(_get_base, doc="The URL for the root of this branch.")
1780
def is_locked(self):
1781
return self.control_files.is_locked()
1783
def lock_write(self, token=None):
1784
repo_token = self.repository.lock_write()
1786
token = self.control_files.lock_write(token=token)
1788
self.repository.unlock()
1792
def lock_read(self):
1793
self.repository.lock_read()
1795
self.control_files.lock_read()
1797
self.repository.unlock()
1801
# TODO: test for failed two phase locks. This is known broken.
1803
self.control_files.unlock()
1805
self.repository.unlock()
1806
if not self.control_files.is_locked():
1807
# we just released the lock
1808
self._clear_cached_state()
1810
def peek_lock_mode(self):
1811
if self.control_files._lock_count == 0:
1814
return self.control_files._lock_mode
1816
def get_physical_lock_status(self):
1817
return self.control_files.get_physical_lock_status()
1820
def print_file(self, file, revision_id):
1821
"""See Branch.print_file."""
1822
return self.repository.print_file(file, revision_id)
1824
def _write_revision_history(self, history):
1825
"""Factored out of set_revision_history.
1827
This performs the actual writing to disk.
1828
It is intended to be called by BzrBranch5.set_revision_history."""
1829
self._transport.put_bytes(
1830
'revision-history', '\n'.join(history),
1831
mode=self.bzrdir._get_file_mode())
1834
def set_revision_history(self, rev_history):
1835
"""See Branch.set_revision_history."""
1836
if 'evil' in debug.debug_flags:
1837
mutter_callsite(3, "set_revision_history scales with history.")
1838
check_not_reserved_id = _mod_revision.check_not_reserved_id
1839
for rev_id in rev_history:
1840
check_not_reserved_id(rev_id)
1841
if Branch.hooks['post_change_branch_tip']:
1842
# Don't calculate the last_revision_info() if there are no hooks
1844
old_revno, old_revid = self.last_revision_info()
1845
if len(rev_history) == 0:
1846
revid = _mod_revision.NULL_REVISION
1848
revid = rev_history[-1]
1849
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1850
self._write_revision_history(rev_history)
1851
self._clear_cached_state()
1852
self._cache_revision_history(rev_history)
1853
for hook in Branch.hooks['set_rh']:
1854
hook(self, rev_history)
1855
if Branch.hooks['post_change_branch_tip']:
1856
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1858
def _synchronize_history(self, destination, revision_id):
1859
"""Synchronize last revision and revision history between branches.
1861
This version is most efficient when the destination is also a
1862
BzrBranch5, but works for BzrBranch6 as long as the revision
1863
history is the true lefthand parent history, and all of the revisions
1864
are in the destination's repository. If not, set_revision_history
1867
:param destination: The branch to copy the history into
1868
:param revision_id: The revision-id to truncate history at. May
1869
be None to copy complete history.
1871
if not isinstance(destination._format, BzrBranchFormat5):
1872
super(BzrBranch, self)._synchronize_history(
1873
destination, revision_id)
1875
if revision_id == _mod_revision.NULL_REVISION:
1878
new_history = self.revision_history()
1879
if revision_id is not None and new_history != []:
1881
new_history = new_history[:new_history.index(revision_id) + 1]
1883
rev = self.repository.get_revision(revision_id)
1884
new_history = rev.get_history(self.repository)[1:]
1885
destination.set_revision_history(new_history)
1888
def set_last_revision_info(self, revno, revision_id):
1889
"""Set the last revision of this branch.
1891
The caller is responsible for checking that the revno is correct
1892
for this revision id.
1894
It may be possible to set the branch last revision to an id not
1895
present in the repository. However, branches can also be
1896
configured to check constraints on history, in which case this may not
1899
revision_id = _mod_revision.ensure_null(revision_id)
1900
# this old format stores the full history, but this api doesn't
1901
# provide it, so we must generate, and might as well check it's
1903
history = self._lefthand_history(revision_id)
1904
if len(history) != revno:
1905
raise AssertionError('%d != %d' % (len(history), revno))
1906
self.set_revision_history(history)
1908
def _gen_revision_history(self):
1909
history = self._transport.get_bytes('revision-history').split('\n')
1910
if history[-1:] == ['']:
1911
# There shouldn't be a trailing newline, but just in case.
1916
def generate_revision_history(self, revision_id, last_rev=None,
1918
"""Create a new revision history that will finish with revision_id.
1920
:param revision_id: the new tip to use.
1921
:param last_rev: The previous last_revision. If not None, then this
1922
must be a ancestory of revision_id, or DivergedBranches is raised.
1923
:param other_branch: The other branch that DivergedBranches should
1924
raise with respect to.
1926
self.set_revision_history(self._lefthand_history(revision_id,
1927
last_rev, other_branch))
1929
def basis_tree(self):
1930
"""See Branch.basis_tree."""
1931
return self.repository.revision_tree(self.last_revision())
1934
def pull(self, source, overwrite=False, stop_revision=None,
1935
_hook_master=None, run_hooks=True, possible_transports=None,
1936
_override_hook_target=None):
1939
:param _hook_master: Private parameter - set the branch to
1940
be supplied as the master to pull hooks.
1941
:param run_hooks: Private parameter - if false, this branch
1942
is being called because it's the master of the primary branch,
1943
so it should not run its hooks.
1944
:param _override_hook_target: Private parameter - set the branch to be
1945
supplied as the target_branch to pull hooks.
1947
result = PullResult()
1948
result.source_branch = source
1949
if _override_hook_target is None:
1950
result.target_branch = self
1952
result.target_branch = _override_hook_target
1955
# We assume that during 'pull' the local repository is closer than
1957
graph = self.repository.get_graph(source.repository)
1958
result.old_revno, result.old_revid = self.last_revision_info()
1959
self.update_revisions(source, stop_revision, overwrite=overwrite,
1961
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1962
result.new_revno, result.new_revid = self.last_revision_info()
1964
result.master_branch = _hook_master
1965
result.local_branch = result.target_branch
1967
result.master_branch = result.target_branch
1968
result.local_branch = None
1970
for hook in Branch.hooks['post_pull']:
1976
def _get_parent_location(self):
1977
_locs = ['parent', 'pull', 'x-pull']
1980
return self._transport.get_bytes(l).strip('\n')
1981
except errors.NoSuchFile:
1986
def push(self, target, overwrite=False, stop_revision=None,
1987
_override_hook_source_branch=None):
1990
This is the basic concrete implementation of push()
1992
:param _override_hook_source_branch: If specified, run
1993
the hooks passing this Branch as the source, rather than self.
1994
This is for use of RemoteBranch, where push is delegated to the
1995
underlying vfs-based Branch.
1997
# TODO: Public option to disable running hooks - should be trivial but
1999
return _run_with_write_locked_target(
2000
target, self._push_with_bound_branches, target, overwrite,
2002
_override_hook_source_branch=_override_hook_source_branch)
2004
def _push_with_bound_branches(self, target, overwrite,
2006
_override_hook_source_branch=None):
2007
"""Push from self into target, and into target's master if any.
2009
This is on the base BzrBranch class even though it doesn't support
2010
bound branches because the *target* might be bound.
2013
if _override_hook_source_branch:
2014
result.source_branch = _override_hook_source_branch
2015
for hook in Branch.hooks['post_push']:
2018
bound_location = target.get_bound_location()
2019
if bound_location and target.base != bound_location:
2020
# there is a master branch.
2022
# XXX: Why the second check? Is it even supported for a branch to
2023
# be bound to itself? -- mbp 20070507
2024
master_branch = target.get_master_branch()
2025
master_branch.lock_write()
2027
# push into the master from this branch.
2028
self._basic_push(master_branch, overwrite, stop_revision)
2029
# and push into the target branch from this. Note that we push from
2030
# this branch again, because its considered the highest bandwidth
2032
result = self._basic_push(target, overwrite, stop_revision)
2033
result.master_branch = master_branch
2034
result.local_branch = target
2038
master_branch.unlock()
2041
result = self._basic_push(target, overwrite, stop_revision)
2042
# TODO: Why set master_branch and local_branch if there's no
2043
# binding? Maybe cleaner to just leave them unset? -- mbp
2045
result.master_branch = target
2046
result.local_branch = None
2050
def _basic_push(self, target, overwrite, stop_revision):
2051
"""Basic implementation of push without bound branches or hooks.
2053
Must be called with self read locked and target write locked.
2055
result = PushResult()
2056
result.source_branch = self
2057
result.target_branch = target
2058
result.old_revno, result.old_revid = target.last_revision_info()
2059
if result.old_revid != self.last_revision():
2060
# We assume that during 'push' this repository is closer than
2062
graph = self.repository.get_graph(target.repository)
2063
target.update_revisions(self, stop_revision, overwrite=overwrite,
2065
if self._push_should_merge_tags():
2066
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2067
result.new_revno, result.new_revid = target.last_revision_info()
2070
def get_parent(self):
2071
"""See Branch.get_parent."""
2072
parent = self._get_parent_location()
2075
# This is an old-format absolute path to a local branch
2076
# turn it into a url
2077
if parent.startswith('/'):
2078
parent = urlutils.local_path_to_url(parent.decode('utf8'))
2080
return urlutils.join(self.base[:-1], parent)
2081
except errors.InvalidURLJoin, e:
2082
raise errors.InaccessibleParent(parent, self.base)
2084
def get_stacked_on_url(self):
2085
raise errors.UnstackableBranchFormat(self._format, self.base)
2087
def set_push_location(self, location):
2088
"""See Branch.set_push_location."""
2089
self.get_config().set_user_option(
2090
'push_location', location,
2091
store=_mod_config.STORE_LOCATION_NORECURSE)
2094
def set_parent(self, url):
2095
"""See Branch.set_parent."""
2096
# TODO: Maybe delete old location files?
2097
# URLs should never be unicode, even on the local fs,
2098
# FIXUP this and get_parent in a future branch format bump:
2099
# read and rewrite the file. RBC 20060125
2101
if isinstance(url, unicode):
2103
url = url.encode('ascii')
2104
except UnicodeEncodeError:
2105
raise errors.InvalidURL(url,
2106
"Urls must be 7-bit ascii, "
2107
"use bzrlib.urlutils.escape")
2108
url = urlutils.relative_url(self.base, url)
2109
self._set_parent_location(url)
2111
def _set_parent_location(self, url):
2113
self._transport.delete('parent')
2115
self._transport.put_bytes('parent', url + '\n',
2116
mode=self.bzrdir._get_file_mode())
2118
def set_stacked_on_url(self, url):
2119
raise errors.UnstackableBranchFormat(self._format, self.base)
2122
class BzrBranch5(BzrBranch):
2123
"""A format 5 branch. This supports new features over plain branches.
2125
It has support for a master_branch which is the data for bound branches.
2129
def pull(self, source, overwrite=False, stop_revision=None,
2130
run_hooks=True, possible_transports=None,
2131
_override_hook_target=None):
2132
"""Pull from source into self, updating my master if any.
2134
:param run_hooks: Private parameter - if false, this branch
2135
is being called because it's the master of the primary branch,
2136
so it should not run its hooks.
2138
bound_location = self.get_bound_location()
2139
master_branch = None
2140
if bound_location and source.base != bound_location:
2141
# not pulling from master, so we need to update master.
2142
master_branch = self.get_master_branch(possible_transports)
2143
master_branch.lock_write()
2146
# pull from source into master.
2147
master_branch.pull(source, overwrite, stop_revision,
2149
return super(BzrBranch5, self).pull(source, overwrite,
2150
stop_revision, _hook_master=master_branch,
2151
run_hooks=run_hooks,
2152
_override_hook_target=_override_hook_target)
2155
master_branch.unlock()
2157
def get_bound_location(self):
2159
return self._transport.get_bytes('bound')[:-1]
2160
except errors.NoSuchFile:
2164
def get_master_branch(self, possible_transports=None):
2165
"""Return the branch we are bound to.
2167
:return: Either a Branch, or None
2169
This could memoise the branch, but if thats done
2170
it must be revalidated on each new lock.
2171
So for now we just don't memoise it.
2172
# RBC 20060304 review this decision.
2174
bound_loc = self.get_bound_location()
2178
return Branch.open(bound_loc,
2179
possible_transports=possible_transports)
2180
except (errors.NotBranchError, errors.ConnectionError), e:
2181
raise errors.BoundBranchConnectionFailure(
2185
def set_bound_location(self, location):
2186
"""Set the target where this branch is bound to.
2188
:param location: URL to the target branch
2191
self._transport.put_bytes('bound', location+'\n',
2192
mode=self.bzrdir._get_file_mode())
2195
self._transport.delete('bound')
2196
except errors.NoSuchFile:
2201
def bind(self, other):
2202
"""Bind this branch to the branch other.
2204
This does not push or pull data between the branches, though it does
2205
check for divergence to raise an error when the branches are not
2206
either the same, or one a prefix of the other. That behaviour may not
2207
be useful, so that check may be removed in future.
2209
:param other: The branch to bind to
2212
# TODO: jam 20051230 Consider checking if the target is bound
2213
# It is debatable whether you should be able to bind to
2214
# a branch which is itself bound.
2215
# Committing is obviously forbidden,
2216
# but binding itself may not be.
2217
# Since we *have* to check at commit time, we don't
2218
# *need* to check here
2220
# we want to raise diverged if:
2221
# last_rev is not in the other_last_rev history, AND
2222
# other_last_rev is not in our history, and do it without pulling
2224
self.set_bound_location(other.base)
2228
"""If bound, unbind"""
2229
return self.set_bound_location(None)
2232
def update(self, possible_transports=None):
2233
"""Synchronise this branch with the master branch if any.
2235
:return: None or the last_revision that was pivoted out during the
2238
master = self.get_master_branch(possible_transports)
2239
if master is not None:
2240
old_tip = _mod_revision.ensure_null(self.last_revision())
2241
self.pull(master, overwrite=True)
2242
if self.repository.get_graph().is_ancestor(old_tip,
2243
_mod_revision.ensure_null(self.last_revision())):
2249
class BzrBranch7(BzrBranch5):
2250
"""A branch with support for a fallback repository."""
2252
def _get_fallback_repository(self, url):
2253
"""Get the repository we fallback to at url."""
2254
url = urlutils.join(self.base, url)
2255
a_bzrdir = bzrdir.BzrDir.open(url,
2256
possible_transports=[self._transport])
2257
return a_bzrdir.open_branch().repository
2259
def _activate_fallback_location(self, url):
2260
"""Activate the branch/repository from url as a fallback repository."""
2261
self.repository.add_fallback_repository(
2262
self._get_fallback_repository(url))
2264
def _open_hook(self):
2266
url = self.get_stacked_on_url()
2267
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2268
errors.UnstackableBranchFormat):
2271
for hook in Branch.hooks['transform_fallback_location']:
2272
url = hook(self, url)
2274
hook_name = Branch.hooks.get_hook_name(hook)
2275
raise AssertionError(
2276
"'transform_fallback_location' hook %s returned "
2277
"None, not a URL." % hook_name)
2278
self._activate_fallback_location(url)
2280
def _check_stackable_repo(self):
2281
if not self.repository._format.supports_external_lookups:
2282
raise errors.UnstackableRepositoryFormat(self.repository._format,
2283
self.repository.base)
2285
def __init__(self, *args, **kwargs):
2286
super(BzrBranch7, self).__init__(*args, **kwargs)
2287
self._last_revision_info_cache = None
2288
self._partial_revision_history_cache = []
2290
def _clear_cached_state(self):
2291
super(BzrBranch7, self)._clear_cached_state()
2292
self._last_revision_info_cache = None
2293
self._partial_revision_history_cache = []
2295
def _last_revision_info(self):
2296
revision_string = self._transport.get_bytes('last-revision')
2297
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2298
revision_id = cache_utf8.get_cached_utf8(revision_id)
2300
return revno, revision_id
2302
def _write_last_revision_info(self, revno, revision_id):
2303
"""Simply write out the revision id, with no checks.
2305
Use set_last_revision_info to perform this safely.
2307
Does not update the revision_history cache.
2308
Intended to be called by set_last_revision_info and
2309
_write_revision_history.
2311
revision_id = _mod_revision.ensure_null(revision_id)
2312
out_string = '%d %s\n' % (revno, revision_id)
2313
self._transport.put_bytes('last-revision', out_string,
2314
mode=self.bzrdir._get_file_mode())
2317
def set_last_revision_info(self, revno, revision_id):
2318
revision_id = _mod_revision.ensure_null(revision_id)
2319
old_revno, old_revid = self.last_revision_info()
2320
if self._get_append_revisions_only():
2321
self._check_history_violation(revision_id)
2322
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2323
self._write_last_revision_info(revno, revision_id)
2324
self._clear_cached_state()
2325
self._last_revision_info_cache = revno, revision_id
2326
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2328
def _synchronize_history(self, destination, revision_id):
2329
"""Synchronize last revision and revision history between branches.
2331
:see: Branch._synchronize_history
2333
# XXX: The base Branch has a fast implementation of this method based
2334
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2335
# that uses set_revision_history. This class inherits from BzrBranch5,
2336
# but wants the fast implementation, so it calls
2337
# Branch._synchronize_history directly.
2338
Branch._synchronize_history(self, destination, revision_id)
2340
def _check_history_violation(self, revision_id):
2341
last_revision = _mod_revision.ensure_null(self.last_revision())
2342
if _mod_revision.is_null(last_revision):
2344
if last_revision not in self._lefthand_history(revision_id):
2345
raise errors.AppendRevisionsOnlyViolation(self.base)
2347
def _gen_revision_history(self):
2348
"""Generate the revision history from last revision
2350
last_revno, last_revision = self.last_revision_info()
2351
self._extend_partial_history(stop_index=last_revno-1)
2352
return list(reversed(self._partial_revision_history_cache))
2354
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2355
"""Extend the partial history to include a given index
2357
If a stop_index is supplied, stop when that index has been reached.
2358
If a stop_revision is supplied, stop when that revision is
2359
encountered. Otherwise, stop when the beginning of history is
2362
:param stop_index: The index which should be present. When it is
2363
present, history extension will stop.
2364
:param revision_id: The revision id which should be present. When
2365
it is encountered, history extension will stop.
2367
repo = self.repository
2368
if len(self._partial_revision_history_cache) == 0:
2369
iterator = repo.iter_reverse_revision_history(self.last_revision())
2371
start_revision = self._partial_revision_history_cache[-1]
2372
iterator = repo.iter_reverse_revision_history(start_revision)
2373
#skip the last revision in the list
2374
next_revision = iterator.next()
2375
for revision_id in iterator:
2376
self._partial_revision_history_cache.append(revision_id)
2377
if (stop_index is not None and
2378
len(self._partial_revision_history_cache) > stop_index):
2380
if revision_id == stop_revision:
2383
def _write_revision_history(self, history):
2384
"""Factored out of set_revision_history.
2386
This performs the actual writing to disk, with format-specific checks.
2387
It is intended to be called by BzrBranch5.set_revision_history.
2389
if len(history) == 0:
2390
last_revision = 'null:'
2392
if history != self._lefthand_history(history[-1]):
2393
raise errors.NotLefthandHistory(history)
2394
last_revision = history[-1]
2395
if self._get_append_revisions_only():
2396
self._check_history_violation(last_revision)
2397
self._write_last_revision_info(len(history), last_revision)
2400
def _set_parent_location(self, url):
2401
"""Set the parent branch"""
2402
self._set_config_location('parent_location', url, make_relative=True)
2405
def _get_parent_location(self):
2406
"""Set the parent branch"""
2407
return self._get_config_location('parent_location')
2409
def set_push_location(self, location):
2410
"""See Branch.set_push_location."""
2411
self._set_config_location('push_location', location)
2413
def set_bound_location(self, location):
2414
"""See Branch.set_push_location."""
2416
config = self.get_config()
2417
if location is None:
2418
if config.get_user_option('bound') != 'True':
2421
config.set_user_option('bound', 'False', warn_masked=True)
2424
self._set_config_location('bound_location', location,
2426
config.set_user_option('bound', 'True', warn_masked=True)
2429
def _get_bound_location(self, bound):
2430
"""Return the bound location in the config file.
2432
Return None if the bound parameter does not match"""
2433
config = self.get_config()
2434
config_bound = (config.get_user_option('bound') == 'True')
2435
if config_bound != bound:
2437
return self._get_config_location('bound_location', config=config)
2439
def get_bound_location(self):
2440
"""See Branch.set_push_location."""
2441
return self._get_bound_location(True)
2443
def get_old_bound_location(self):
2444
"""See Branch.get_old_bound_location"""
2445
return self._get_bound_location(False)
2447
def get_stacked_on_url(self):
2448
# you can always ask for the URL; but you might not be able to use it
2449
# if the repo can't support stacking.
2450
## self._check_stackable_repo()
2451
stacked_url = self._get_config_location('stacked_on_location')
2452
if stacked_url is None:
2453
raise errors.NotStacked(self)
2456
def set_append_revisions_only(self, enabled):
2461
self.get_config().set_user_option('append_revisions_only', value,
2464
def set_stacked_on_url(self, url):
2465
self._check_stackable_repo()
2468
old_url = self.get_stacked_on_url()
2469
except (errors.NotStacked, errors.UnstackableBranchFormat,
2470
errors.UnstackableRepositoryFormat):
2473
# repositories don't offer an interface to remove fallback
2474
# repositories today; take the conceptually simpler option and just
2476
self.repository = self.bzrdir.find_repository()
2477
# for every revision reference the branch has, ensure it is pulled
2479
source_repository = self._get_fallback_repository(old_url)
2480
for revision_id in chain([self.last_revision()],
2481
self.tags.get_reverse_tag_dict()):
2482
self.repository.fetch(source_repository, revision_id,
2485
self._activate_fallback_location(url)
2486
# write this out after the repository is stacked to avoid setting a
2487
# stacked config that doesn't work.
2488
self._set_config_location('stacked_on_location', url)
2490
def _get_append_revisions_only(self):
2491
value = self.get_config().get_user_option('append_revisions_only')
2492
return value == 'True'
2494
def _make_tags(self):
2495
return BasicTags(self)
2498
def generate_revision_history(self, revision_id, last_rev=None,
2500
"""See BzrBranch5.generate_revision_history"""
2501
history = self._lefthand_history(revision_id, last_rev, other_branch)
2502
revno = len(history)
2503
self.set_last_revision_info(revno, revision_id)
2506
def get_rev_id(self, revno, history=None):
2507
"""Find the revision id of the specified revno."""
2509
return _mod_revision.NULL_REVISION
2511
last_revno, last_revision_id = self.last_revision_info()
2512
if revno <= 0 or revno > last_revno:
2513
raise errors.NoSuchRevision(self, revno)
2515
if history is not None:
2516
return history[revno - 1]
2518
index = last_revno - revno
2519
if len(self._partial_revision_history_cache) <= index:
2520
self._extend_partial_history(stop_index=index)
2521
if len(self._partial_revision_history_cache) > index:
2522
return self._partial_revision_history_cache[index]
2524
raise errors.NoSuchRevision(self, revno)
2527
def revision_id_to_revno(self, revision_id):
2528
"""Given a revision id, return its revno"""
2529
if _mod_revision.is_null(revision_id):
2532
index = self._partial_revision_history_cache.index(revision_id)
2534
self._extend_partial_history(stop_revision=revision_id)
2535
index = len(self._partial_revision_history_cache) - 1
2536
if self._partial_revision_history_cache[index] != revision_id:
2537
raise errors.NoSuchRevision(self, revision_id)
2538
return self.revno() - index
2541
class BzrBranch6(BzrBranch7):
2542
"""See BzrBranchFormat6 for the capabilities of this branch.
2544
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2548
def get_stacked_on_url(self):
2549
raise errors.UnstackableBranchFormat(self._format, self.base)
2551
def set_stacked_on_url(self, url):
2552
raise errors.UnstackableBranchFormat(self._format, self.base)
2555
######################################################################
2556
# results of operations
2559
class _Result(object):
2561
def _show_tag_conficts(self, to_file):
2562
if not getattr(self, 'tag_conflicts', None):
2564
to_file.write('Conflicting tags:\n')
2565
for name, value1, value2 in self.tag_conflicts:
2566
to_file.write(' %s\n' % (name, ))
2569
class PullResult(_Result):
2570
"""Result of a Branch.pull operation.
2572
:ivar old_revno: Revision number before pull.
2573
:ivar new_revno: Revision number after pull.
2574
:ivar old_revid: Tip revision id before pull.
2575
:ivar new_revid: Tip revision id after pull.
2576
:ivar source_branch: Source (local) branch object.
2577
:ivar master_branch: Master branch of the target, or the target if no
2579
:ivar local_branch: target branch if there is a Master, else None
2580
:ivar target_branch: Target/destination branch object.
2581
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2585
# DEPRECATED: pull used to return the change in revno
2586
return self.new_revno - self.old_revno
2588
def report(self, to_file):
2590
if self.old_revid == self.new_revid:
2591
to_file.write('No revisions to pull.\n')
2593
to_file.write('Now on revision %d.\n' % self.new_revno)
2594
self._show_tag_conficts(to_file)
2597
class PushResult(_Result):
2598
"""Result of a Branch.push operation.
2600
:ivar old_revno: Revision number before push.
2601
:ivar new_revno: Revision number after push.
2602
:ivar old_revid: Tip revision id before push.
2603
:ivar new_revid: Tip revision id after push.
2604
:ivar source_branch: Source branch object.
2605
:ivar master_branch: Master branch of the target, or None.
2606
:ivar target_branch: Target/destination branch object.
2610
# DEPRECATED: push used to return the change in revno
2611
return self.new_revno - self.old_revno
2613
def report(self, to_file):
2614
"""Write a human-readable description of the result."""
2615
if self.old_revid == self.new_revid:
2616
note('No new revisions to push.')
2618
note('Pushed up to revision %d.' % self.new_revno)
2619
self._show_tag_conficts(to_file)
2622
class BranchCheckResult(object):
2623
"""Results of checking branch consistency.
2628
def __init__(self, branch):
2629
self.branch = branch
2631
def report_results(self, verbose):
2632
"""Report the check results via trace.note.
2634
:param verbose: Requests more detailed display of what was checked,
2637
note('checked branch %s format %s',
2639
self.branch._format)
2642
class Converter5to6(object):
2643
"""Perform an in-place upgrade of format 5 to format 6"""
2645
def convert(self, branch):
2646
# Data for 5 and 6 can peacefully coexist.
2647
format = BzrBranchFormat6()
2648
new_branch = format.open(branch.bzrdir, _found=True)
2650
# Copy source data into target
2651
new_branch._write_last_revision_info(*branch.last_revision_info())
2652
new_branch.set_parent(branch.get_parent())
2653
new_branch.set_bound_location(branch.get_bound_location())
2654
new_branch.set_push_location(branch.get_push_location())
2656
# New branch has no tags by default
2657
new_branch.tags._set_tag_dict({})
2659
# Copying done; now update target format
2660
new_branch._transport.put_bytes('format',
2661
format.get_format_string(),
2662
mode=new_branch.bzrdir._get_file_mode())
2664
# Clean up old files
2665
new_branch._transport.delete('revision-history')
2667
branch.set_parent(None)
2668
except errors.NoSuchFile:
2670
branch.set_bound_location(None)
2673
class Converter6to7(object):
2674
"""Perform an in-place upgrade of format 6 to format 7"""
2676
def convert(self, branch):
2677
format = BzrBranchFormat7()
2678
branch._set_config_location('stacked_on_location', '')
2679
# update target format
2680
branch._transport.put_bytes('format', format.get_format_string())
2684
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2685
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2688
_run_with_write_locked_target will attempt to release the lock it acquires.
2690
If an exception is raised by callable, then that exception *will* be
2691
propagated, even if the unlock attempt raises its own error. Thus
2692
_run_with_write_locked_target should be preferred to simply doing::
2696
return callable(*args, **kwargs)
2701
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2702
# should share code?
2705
result = callable(*args, **kwargs)
2707
exc_info = sys.exc_info()
2711
raise exc_info[0], exc_info[1], exc_info[2]
2717
class InterBranch(InterObject):
2718
"""This class represents operations taking place between two branches.
2720
Its instances have methods like pull() and push() and contain
2721
references to the source and target repositories these operations
2722
can be carried out on.
2726
"""The available optimised InterBranch types."""
2729
def _get_branch_formats_to_test():
2730
"""Return a tuple with the Branch formats to use when testing."""
2731
raise NotImplementedError(self._get_branch_formats_to_test)
2733
def update_revisions(self, stop_revision=None, overwrite=False,
2735
"""Pull in new perfect-fit revisions.
2737
:param stop_revision: Updated until the given revision
2738
:param overwrite: Always set the branch pointer, rather than checking
2739
to see if it is a proper descendant.
2740
:param graph: A Graph object that can be used to query history
2741
information. This can be None.
2744
raise NotImplementedError(self.update_revisions)
2747
class GenericInterBranch(InterBranch):
2748
"""InterBranch implementation that uses public Branch functions.
2752
def _get_branch_formats_to_test():
2753
return BranchFormat._default_format, BranchFormat._default_format
2755
def update_revisions(self, stop_revision=None, overwrite=False,
2757
"""See InterBranch.update_revisions()."""
2758
self.source.lock_read()
2760
other_revno, other_last_revision = self.source.last_revision_info()
2761
stop_revno = None # unknown
2762
if stop_revision is None:
2763
stop_revision = other_last_revision
2764
if _mod_revision.is_null(stop_revision):
2765
# if there are no commits, we're done.
2767
stop_revno = other_revno
2769
# what's the current last revision, before we fetch [and change it
2771
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2772
# we fetch here so that we don't process data twice in the common
2773
# case of having something to pull, and so that the check for
2774
# already merged can operate on the just fetched graph, which will
2775
# be cached in memory.
2776
self.target.fetch(self.source, stop_revision)
2777
# Check to see if one is an ancestor of the other
2780
graph = self.target.repository.get_graph()
2781
if self.target._check_if_descendant_or_diverged(
2782
stop_revision, last_rev, graph, self.source):
2783
# stop_revision is a descendant of last_rev, but we aren't
2784
# overwriting, so we're done.
2786
if stop_revno is None:
2788
graph = self.target.repository.get_graph()
2789
this_revno, this_last_revision = \
2790
self.target.last_revision_info()
2791
stop_revno = graph.find_distance_to_null(stop_revision,
2792
[(other_last_revision, other_revno),
2793
(this_last_revision, this_revno)])
2794
self.target.set_last_revision_info(stop_revno, stop_revision)
2796
self.source.unlock()
2799
def is_compatible(self, source, target):
2800
# GenericBranch uses the public API, so always compatible
2804
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
