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.
469
if self.base == from_branch.base:
472
nested_pb = ui.ui_factory.nested_progress_bar()
477
from_branch.lock_read()
479
if last_revision is None:
480
pb.update('get source history')
481
last_revision = from_branch.last_revision()
482
last_revision = _mod_revision.ensure_null(last_revision)
483
return self.repository.fetch(from_branch.repository,
484
revision_id=last_revision,
487
if nested_pb is not None:
491
def get_bound_location(self):
492
"""Return the URL of the branch we are bound to.
494
Older format branches cannot bind, please be sure to use a metadir
499
def get_old_bound_location(self):
500
"""Return the URL of the branch we used to be bound to
502
raise errors.UpgradeRequired(self.base)
504
def get_commit_builder(self, parents, config=None, timestamp=None,
505
timezone=None, committer=None, revprops=None,
507
"""Obtain a CommitBuilder for this branch.
509
:param parents: Revision ids of the parents of the new revision.
510
:param config: Optional configuration to use.
511
:param timestamp: Optional timestamp recorded for commit.
512
:param timezone: Optional timezone for timestamp.
513
:param committer: Optional committer to set for commit.
514
:param revprops: Optional dictionary of revision properties.
515
:param revision_id: Optional revision id.
519
config = self.get_config()
521
return self.repository.get_commit_builder(self, parents, config,
522
timestamp, timezone, committer, revprops, revision_id)
524
def get_master_branch(self, possible_transports=None):
525
"""Return the branch we are bound to.
527
:return: Either a Branch, or None
531
def get_revision_delta(self, revno):
532
"""Return the delta for one revision.
534
The delta is relative to its mainline predecessor, or the
535
empty tree for revision 1.
537
rh = self.revision_history()
538
if not (1 <= revno <= len(rh)):
539
raise errors.InvalidRevisionNumber(revno)
540
return self.repository.get_revision_delta(rh[revno-1])
542
def get_stacked_on_url(self):
543
"""Get the URL this branch is stacked against.
545
:raises NotStacked: If the branch is not stacked.
546
:raises UnstackableBranchFormat: If the branch does not support
549
raise NotImplementedError(self.get_stacked_on_url)
551
def print_file(self, file, revision_id):
552
"""Print `file` to stdout."""
553
raise NotImplementedError(self.print_file)
555
def set_revision_history(self, rev_history):
556
raise NotImplementedError(self.set_revision_history)
558
def set_stacked_on_url(self, url):
559
"""Set the URL this branch is stacked against.
561
:raises UnstackableBranchFormat: If the branch does not support
563
:raises UnstackableRepositoryFormat: If the repository does not support
566
raise NotImplementedError(self.set_stacked_on_url)
568
def _cache_revision_history(self, rev_history):
569
"""Set the cached revision history to rev_history.
571
The revision_history method will use this cache to avoid regenerating
572
the revision history.
574
This API is semi-public; it only for use by subclasses, all other code
575
should consider it to be private.
577
self._revision_history_cache = rev_history
579
def _cache_revision_id_to_revno(self, revision_id_to_revno):
580
"""Set the cached revision_id => revno map to revision_id_to_revno.
582
This API is semi-public; it only for use by subclasses, all other code
583
should consider it to be private.
585
self._revision_id_to_revno_cache = revision_id_to_revno
587
def _clear_cached_state(self):
588
"""Clear any cached data on this branch, e.g. cached revision history.
590
This means the next call to revision_history will need to call
591
_gen_revision_history.
593
This API is semi-public; it only for use by subclasses, all other code
594
should consider it to be private.
596
self._revision_history_cache = None
597
self._revision_id_to_revno_cache = None
598
self._last_revision_info_cache = None
599
self._merge_sorted_revisions_cache = None
601
def _gen_revision_history(self):
602
"""Return sequence of revision hashes on to this branch.
604
Unlike revision_history, this method always regenerates or rereads the
605
revision history, i.e. it does not cache the result, so repeated calls
608
Concrete subclasses should override this instead of revision_history so
609
that subclasses do not need to deal with caching logic.
611
This API is semi-public; it only for use by subclasses, all other code
612
should consider it to be private.
614
raise NotImplementedError(self._gen_revision_history)
617
def revision_history(self):
618
"""Return sequence of revision ids on this branch.
620
This method will cache the revision history for as long as it is safe to
623
if 'evil' in debug.debug_flags:
624
mutter_callsite(3, "revision_history scales with history.")
625
if self._revision_history_cache is not None:
626
history = self._revision_history_cache
628
history = self._gen_revision_history()
629
self._cache_revision_history(history)
633
"""Return current revision number for this branch.
635
That is equivalent to the number of revisions committed to
638
return self.last_revision_info()[0]
641
"""Older format branches cannot bind or unbind."""
642
raise errors.UpgradeRequired(self.base)
644
def set_append_revisions_only(self, enabled):
645
"""Older format branches are never restricted to append-only"""
646
raise errors.UpgradeRequired(self.base)
648
def last_revision(self):
649
"""Return last revision id, or NULL_REVISION."""
650
return self.last_revision_info()[1]
653
def last_revision_info(self):
654
"""Return information about the last revision.
656
:return: A tuple (revno, revision_id).
658
if self._last_revision_info_cache is None:
659
self._last_revision_info_cache = self._last_revision_info()
660
return self._last_revision_info_cache
662
def _last_revision_info(self):
663
rh = self.revision_history()
666
return (revno, rh[-1])
668
return (0, _mod_revision.NULL_REVISION)
670
@deprecated_method(deprecated_in((1, 6, 0)))
671
def missing_revisions(self, other, stop_revision=None):
672
"""Return a list of new revisions that would perfectly fit.
674
If self and other have not diverged, return a list of the revisions
675
present in other, but missing from self.
677
self_history = self.revision_history()
678
self_len = len(self_history)
679
other_history = other.revision_history()
680
other_len = len(other_history)
681
common_index = min(self_len, other_len) -1
682
if common_index >= 0 and \
683
self_history[common_index] != other_history[common_index]:
684
raise errors.DivergedBranches(self, other)
686
if stop_revision is None:
687
stop_revision = other_len
689
if stop_revision > other_len:
690
raise errors.NoSuchRevision(self, stop_revision)
691
return other_history[self_len:stop_revision]
694
def update_revisions(self, other, stop_revision=None, overwrite=False,
696
"""Pull in new perfect-fit revisions.
698
:param other: Another Branch to pull from
699
:param stop_revision: Updated until the given revision
700
:param overwrite: Always set the branch pointer, rather than checking
701
to see if it is a proper descendant.
702
:param graph: A Graph object that can be used to query history
703
information. This can be None.
706
return InterBranch.get(other, self).update_revisions(stop_revision,
709
def revision_id_to_revno(self, revision_id):
710
"""Given a revision id, return its revno"""
711
if _mod_revision.is_null(revision_id):
713
history = self.revision_history()
715
return history.index(revision_id) + 1
717
raise errors.NoSuchRevision(self, revision_id)
719
def get_rev_id(self, revno, history=None):
720
"""Find the revision id of the specified revno."""
722
return _mod_revision.NULL_REVISION
724
history = self.revision_history()
725
if revno <= 0 or revno > len(history):
726
raise errors.NoSuchRevision(self, revno)
727
return history[revno - 1]
729
def pull(self, source, overwrite=False, stop_revision=None,
730
possible_transports=None, _override_hook_target=None):
731
"""Mirror source into this branch.
733
This branch is considered to be 'local', having low latency.
735
:returns: PullResult instance
737
raise NotImplementedError(self.pull)
739
def push(self, target, overwrite=False, stop_revision=None):
740
"""Mirror this branch into target.
742
This branch is considered to be 'local', having low latency.
744
raise NotImplementedError(self.push)
746
def basis_tree(self):
747
"""Return `Tree` object for last revision."""
748
return self.repository.revision_tree(self.last_revision())
750
def get_parent(self):
751
"""Return the parent location of the branch.
753
This is the default location for pull/missing. The usual
754
pattern is that the user can override it by specifying a
757
raise NotImplementedError(self.get_parent)
759
def _set_config_location(self, name, url, config=None,
760
make_relative=False):
762
config = self.get_config()
766
url = urlutils.relative_url(self.base, url)
767
config.set_user_option(name, url, warn_masked=True)
769
def _get_config_location(self, name, config=None):
771
config = self.get_config()
772
location = config.get_user_option(name)
777
def get_submit_branch(self):
778
"""Return the submit location of the branch.
780
This is the default location for bundle. The usual
781
pattern is that the user can override it by specifying a
784
return self.get_config().get_user_option('submit_branch')
786
def set_submit_branch(self, location):
787
"""Return the submit location of the branch.
789
This is the default location for bundle. The usual
790
pattern is that the user can override it by specifying a
793
self.get_config().set_user_option('submit_branch', location,
796
def get_public_branch(self):
797
"""Return the public location of the branch.
799
This is is used by merge directives.
801
return self._get_config_location('public_branch')
803
def set_public_branch(self, location):
804
"""Return the submit location of the branch.
806
This is the default location for bundle. The usual
807
pattern is that the user can override it by specifying a
810
self._set_config_location('public_branch', location)
812
def get_push_location(self):
813
"""Return the None or the location to push this branch to."""
814
push_loc = self.get_config().get_user_option('push_location')
817
def set_push_location(self, location):
818
"""Set a new push location for this branch."""
819
raise NotImplementedError(self.set_push_location)
821
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
822
"""Run the post_change_branch_tip hooks."""
823
hooks = Branch.hooks['post_change_branch_tip']
826
new_revno, new_revid = self.last_revision_info()
827
params = ChangeBranchTipParams(
828
self, old_revno, new_revno, old_revid, new_revid)
832
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
833
"""Run the pre_change_branch_tip hooks."""
834
hooks = Branch.hooks['pre_change_branch_tip']
837
old_revno, old_revid = self.last_revision_info()
838
params = ChangeBranchTipParams(
839
self, old_revno, new_revno, old_revid, new_revid)
843
except errors.TipChangeRejected:
846
exc_info = sys.exc_info()
847
hook_name = Branch.hooks.get_hook_name(hook)
848
raise errors.HookFailed(
849
'pre_change_branch_tip', hook_name, exc_info)
851
def set_parent(self, url):
852
raise NotImplementedError(self.set_parent)
856
"""Synchronise this branch with the master branch if any.
858
:return: None or the last_revision pivoted out during the update.
862
def check_revno(self, revno):
864
Check whether a revno corresponds to any revision.
865
Zero (the NULL revision) is considered valid.
868
self.check_real_revno(revno)
870
def check_real_revno(self, revno):
872
Check whether a revno corresponds to a real revision.
873
Zero (the NULL revision) is considered invalid
875
if revno < 1 or revno > self.revno():
876
raise errors.InvalidRevisionNumber(revno)
879
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
880
"""Clone this branch into to_bzrdir preserving all semantic values.
882
Most API users will want 'create_clone_on_transport', which creates a
883
new bzrdir and branch on the fly.
885
revision_id: if not None, the revision history in the new branch will
886
be truncated to end with revision_id.
888
result = to_bzrdir.create_branch()
889
if repository_policy is not None:
890
repository_policy.configure_branch(result)
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
repository_policy=None):
1673
"""See Branch.clone()."""
1674
return format.initialize(to_bzrdir, a_branch)
1675
# cannot obey revision_id limits when cloning a reference ...
1676
# FIXME RBC 20060210 either nuke revision_id for clone, or
1677
# emit some sort of warning/error to the caller ?!
1680
def open(self, a_bzrdir, _found=False, location=None,
1681
possible_transports=None):
1682
"""Return the branch that the branch reference in a_bzrdir points at.
1684
_found is a private parameter, do not use it. It is used to indicate
1685
if format probing has already be done.
1688
format = BranchFormat.find_format(a_bzrdir)
1689
if format.__class__ != self.__class__:
1690
raise AssertionError("wrong format %r found for %r" %
1692
if location is None:
1693
location = self.get_reference(a_bzrdir)
1694
real_bzrdir = bzrdir.BzrDir.open(
1695
location, possible_transports=possible_transports)
1696
result = real_bzrdir.open_branch()
1697
# this changes the behaviour of result.clone to create a new reference
1698
# rather than a copy of the content of the branch.
1699
# I did not use a proxy object because that needs much more extensive
1700
# testing, and we are only changing one behaviour at the moment.
1701
# If we decide to alter more behaviours - i.e. the implicit nickname
1702
# then this should be refactored to introduce a tested proxy branch
1703
# and a subclass of that for use in overriding clone() and ....
1705
result.clone = self._make_reference_clone_function(result)
1709
network_format_registry = registry.FormatRegistry()
1710
"""Registry of formats indexed by their network name.
1712
The network name for a repository format is an identifier that can be used when
1713
referring to formats with smart server operations. See
1714
BranchFormat.network_name() for more detail.
1718
# formats which have no format string are not discoverable
1719
# and not independently creatable, so are not registered.
1720
__format5 = BzrBranchFormat5()
1721
__format6 = BzrBranchFormat6()
1722
__format7 = BzrBranchFormat7()
1723
BranchFormat.register_format(__format5)
1724
BranchFormat.register_format(BranchReferenceFormat())
1725
BranchFormat.register_format(__format6)
1726
BranchFormat.register_format(__format7)
1727
BranchFormat.set_default_format(__format6)
1728
_legacy_formats = [BzrBranchFormat4(),
1730
network_format_registry.register(
1731
_legacy_formats[0].network_name(), _legacy_formats[0])
1734
class BzrBranch(Branch):
1735
"""A branch stored in the actual filesystem.
1737
Note that it's "local" in the context of the filesystem; it doesn't
1738
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1739
it's writable, and can be accessed via the normal filesystem API.
1741
:ivar _transport: Transport for file operations on this branch's
1742
control files, typically pointing to the .bzr/branch directory.
1743
:ivar repository: Repository for this branch.
1744
:ivar base: The url of the base directory for this branch; the one
1745
containing the .bzr directory.
1748
def __init__(self, _format=None,
1749
_control_files=None, a_bzrdir=None, _repository=None):
1750
"""Create new branch object at a particular location."""
1751
if a_bzrdir is None:
1752
raise ValueError('a_bzrdir must be supplied')
1754
self.bzrdir = a_bzrdir
1755
self._base = self.bzrdir.transport.clone('..').base
1756
# XXX: We should be able to just do
1757
# self.base = self.bzrdir.root_transport.base
1758
# but this does not quite work yet -- mbp 20080522
1759
self._format = _format
1760
if _control_files is None:
1761
raise ValueError('BzrBranch _control_files is None')
1762
self.control_files = _control_files
1763
self._transport = _control_files._transport
1764
self.repository = _repository
1765
Branch.__init__(self)
1768
return '%s(%r)' % (self.__class__.__name__, self.base)
1772
def _get_base(self):
1773
"""Returns the directory containing the control directory."""
1776
base = property(_get_base, doc="The URL for the root of this branch.")
1778
def is_locked(self):
1779
return self.control_files.is_locked()
1781
def lock_write(self, token=None):
1782
repo_token = self.repository.lock_write()
1784
token = self.control_files.lock_write(token=token)
1786
self.repository.unlock()
1790
def lock_read(self):
1791
self.repository.lock_read()
1793
self.control_files.lock_read()
1795
self.repository.unlock()
1799
# TODO: test for failed two phase locks. This is known broken.
1801
self.control_files.unlock()
1803
self.repository.unlock()
1804
if not self.control_files.is_locked():
1805
# we just released the lock
1806
self._clear_cached_state()
1808
def peek_lock_mode(self):
1809
if self.control_files._lock_count == 0:
1812
return self.control_files._lock_mode
1814
def get_physical_lock_status(self):
1815
return self.control_files.get_physical_lock_status()
1818
def print_file(self, file, revision_id):
1819
"""See Branch.print_file."""
1820
return self.repository.print_file(file, revision_id)
1822
def _write_revision_history(self, history):
1823
"""Factored out of set_revision_history.
1825
This performs the actual writing to disk.
1826
It is intended to be called by BzrBranch5.set_revision_history."""
1827
self._transport.put_bytes(
1828
'revision-history', '\n'.join(history),
1829
mode=self.bzrdir._get_file_mode())
1832
def set_revision_history(self, rev_history):
1833
"""See Branch.set_revision_history."""
1834
if 'evil' in debug.debug_flags:
1835
mutter_callsite(3, "set_revision_history scales with history.")
1836
check_not_reserved_id = _mod_revision.check_not_reserved_id
1837
for rev_id in rev_history:
1838
check_not_reserved_id(rev_id)
1839
if Branch.hooks['post_change_branch_tip']:
1840
# Don't calculate the last_revision_info() if there are no hooks
1842
old_revno, old_revid = self.last_revision_info()
1843
if len(rev_history) == 0:
1844
revid = _mod_revision.NULL_REVISION
1846
revid = rev_history[-1]
1847
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1848
self._write_revision_history(rev_history)
1849
self._clear_cached_state()
1850
self._cache_revision_history(rev_history)
1851
for hook in Branch.hooks['set_rh']:
1852
hook(self, rev_history)
1853
if Branch.hooks['post_change_branch_tip']:
1854
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1856
def _synchronize_history(self, destination, revision_id):
1857
"""Synchronize last revision and revision history between branches.
1859
This version is most efficient when the destination is also a
1860
BzrBranch5, but works for BzrBranch6 as long as the revision
1861
history is the true lefthand parent history, and all of the revisions
1862
are in the destination's repository. If not, set_revision_history
1865
:param destination: The branch to copy the history into
1866
:param revision_id: The revision-id to truncate history at. May
1867
be None to copy complete history.
1869
if not isinstance(destination._format, BzrBranchFormat5):
1870
super(BzrBranch, self)._synchronize_history(
1871
destination, revision_id)
1873
if revision_id == _mod_revision.NULL_REVISION:
1876
new_history = self.revision_history()
1877
if revision_id is not None and new_history != []:
1879
new_history = new_history[:new_history.index(revision_id) + 1]
1881
rev = self.repository.get_revision(revision_id)
1882
new_history = rev.get_history(self.repository)[1:]
1883
destination.set_revision_history(new_history)
1886
def set_last_revision_info(self, revno, revision_id):
1887
"""Set the last revision of this branch.
1889
The caller is responsible for checking that the revno is correct
1890
for this revision id.
1892
It may be possible to set the branch last revision to an id not
1893
present in the repository. However, branches can also be
1894
configured to check constraints on history, in which case this may not
1897
revision_id = _mod_revision.ensure_null(revision_id)
1898
# this old format stores the full history, but this api doesn't
1899
# provide it, so we must generate, and might as well check it's
1901
history = self._lefthand_history(revision_id)
1902
if len(history) != revno:
1903
raise AssertionError('%d != %d' % (len(history), revno))
1904
self.set_revision_history(history)
1906
def _gen_revision_history(self):
1907
history = self._transport.get_bytes('revision-history').split('\n')
1908
if history[-1:] == ['']:
1909
# There shouldn't be a trailing newline, but just in case.
1914
def generate_revision_history(self, revision_id, last_rev=None,
1916
"""Create a new revision history that will finish with revision_id.
1918
:param revision_id: the new tip to use.
1919
:param last_rev: The previous last_revision. If not None, then this
1920
must be a ancestory of revision_id, or DivergedBranches is raised.
1921
:param other_branch: The other branch that DivergedBranches should
1922
raise with respect to.
1924
self.set_revision_history(self._lefthand_history(revision_id,
1925
last_rev, other_branch))
1927
def basis_tree(self):
1928
"""See Branch.basis_tree."""
1929
return self.repository.revision_tree(self.last_revision())
1932
def pull(self, source, overwrite=False, stop_revision=None,
1933
_hook_master=None, run_hooks=True, possible_transports=None,
1934
_override_hook_target=None):
1937
:param _hook_master: Private parameter - set the branch to
1938
be supplied as the master to pull hooks.
1939
:param run_hooks: Private parameter - if false, this branch
1940
is being called because it's the master of the primary branch,
1941
so it should not run its hooks.
1942
:param _override_hook_target: Private parameter - set the branch to be
1943
supplied as the target_branch to pull hooks.
1945
result = PullResult()
1946
result.source_branch = source
1947
if _override_hook_target is None:
1948
result.target_branch = self
1950
result.target_branch = _override_hook_target
1953
# We assume that during 'pull' the local repository is closer than
1955
graph = self.repository.get_graph(source.repository)
1956
result.old_revno, result.old_revid = self.last_revision_info()
1957
self.update_revisions(source, stop_revision, overwrite=overwrite,
1959
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1960
result.new_revno, result.new_revid = self.last_revision_info()
1962
result.master_branch = _hook_master
1963
result.local_branch = result.target_branch
1965
result.master_branch = result.target_branch
1966
result.local_branch = None
1968
for hook in Branch.hooks['post_pull']:
1974
def _get_parent_location(self):
1975
_locs = ['parent', 'pull', 'x-pull']
1978
return self._transport.get_bytes(l).strip('\n')
1979
except errors.NoSuchFile:
1984
def push(self, target, overwrite=False, stop_revision=None,
1985
_override_hook_source_branch=None):
1988
This is the basic concrete implementation of push()
1990
:param _override_hook_source_branch: If specified, run
1991
the hooks passing this Branch as the source, rather than self.
1992
This is for use of RemoteBranch, where push is delegated to the
1993
underlying vfs-based Branch.
1995
# TODO: Public option to disable running hooks - should be trivial but
1997
return _run_with_write_locked_target(
1998
target, self._push_with_bound_branches, target, overwrite,
2000
_override_hook_source_branch=_override_hook_source_branch)
2002
def _push_with_bound_branches(self, target, overwrite,
2004
_override_hook_source_branch=None):
2005
"""Push from self into target, and into target's master if any.
2007
This is on the base BzrBranch class even though it doesn't support
2008
bound branches because the *target* might be bound.
2011
if _override_hook_source_branch:
2012
result.source_branch = _override_hook_source_branch
2013
for hook in Branch.hooks['post_push']:
2016
bound_location = target.get_bound_location()
2017
if bound_location and target.base != bound_location:
2018
# there is a master branch.
2020
# XXX: Why the second check? Is it even supported for a branch to
2021
# be bound to itself? -- mbp 20070507
2022
master_branch = target.get_master_branch()
2023
master_branch.lock_write()
2025
# push into the master from this branch.
2026
self._basic_push(master_branch, overwrite, stop_revision)
2027
# and push into the target branch from this. Note that we push from
2028
# this branch again, because its considered the highest bandwidth
2030
result = self._basic_push(target, overwrite, stop_revision)
2031
result.master_branch = master_branch
2032
result.local_branch = target
2036
master_branch.unlock()
2039
result = self._basic_push(target, overwrite, stop_revision)
2040
# TODO: Why set master_branch and local_branch if there's no
2041
# binding? Maybe cleaner to just leave them unset? -- mbp
2043
result.master_branch = target
2044
result.local_branch = None
2048
def _basic_push(self, target, overwrite, stop_revision):
2049
"""Basic implementation of push without bound branches or hooks.
2051
Must be called with self read locked and target write locked.
2053
result = PushResult()
2054
result.source_branch = self
2055
result.target_branch = target
2056
result.old_revno, result.old_revid = target.last_revision_info()
2057
if result.old_revid != self.last_revision():
2058
# We assume that during 'push' this repository is closer than
2060
graph = self.repository.get_graph(target.repository)
2061
target.update_revisions(self, stop_revision, overwrite=overwrite,
2063
if self._push_should_merge_tags():
2064
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2065
result.new_revno, result.new_revid = target.last_revision_info()
2068
def get_parent(self):
2069
"""See Branch.get_parent."""
2070
parent = self._get_parent_location()
2073
# This is an old-format absolute path to a local branch
2074
# turn it into a url
2075
if parent.startswith('/'):
2076
parent = urlutils.local_path_to_url(parent.decode('utf8'))
2078
return urlutils.join(self.base[:-1], parent)
2079
except errors.InvalidURLJoin, e:
2080
raise errors.InaccessibleParent(parent, self.base)
2082
def get_stacked_on_url(self):
2083
raise errors.UnstackableBranchFormat(self._format, self.base)
2085
def set_push_location(self, location):
2086
"""See Branch.set_push_location."""
2087
self.get_config().set_user_option(
2088
'push_location', location,
2089
store=_mod_config.STORE_LOCATION_NORECURSE)
2092
def set_parent(self, url):
2093
"""See Branch.set_parent."""
2094
# TODO: Maybe delete old location files?
2095
# URLs should never be unicode, even on the local fs,
2096
# FIXUP this and get_parent in a future branch format bump:
2097
# read and rewrite the file. RBC 20060125
2099
if isinstance(url, unicode):
2101
url = url.encode('ascii')
2102
except UnicodeEncodeError:
2103
raise errors.InvalidURL(url,
2104
"Urls must be 7-bit ascii, "
2105
"use bzrlib.urlutils.escape")
2106
url = urlutils.relative_url(self.base, url)
2107
self._set_parent_location(url)
2109
def _set_parent_location(self, url):
2111
self._transport.delete('parent')
2113
self._transport.put_bytes('parent', url + '\n',
2114
mode=self.bzrdir._get_file_mode())
2116
def set_stacked_on_url(self, url):
2117
raise errors.UnstackableBranchFormat(self._format, self.base)
2120
class BzrBranch5(BzrBranch):
2121
"""A format 5 branch. This supports new features over plain branches.
2123
It has support for a master_branch which is the data for bound branches.
2127
def pull(self, source, overwrite=False, stop_revision=None,
2128
run_hooks=True, possible_transports=None,
2129
_override_hook_target=None):
2130
"""Pull from source into self, updating my master if any.
2132
:param run_hooks: Private parameter - if false, this branch
2133
is being called because it's the master of the primary branch,
2134
so it should not run its hooks.
2136
bound_location = self.get_bound_location()
2137
master_branch = None
2138
if bound_location and source.base != bound_location:
2139
# not pulling from master, so we need to update master.
2140
master_branch = self.get_master_branch(possible_transports)
2141
master_branch.lock_write()
2144
# pull from source into master.
2145
master_branch.pull(source, overwrite, stop_revision,
2147
return super(BzrBranch5, self).pull(source, overwrite,
2148
stop_revision, _hook_master=master_branch,
2149
run_hooks=run_hooks,
2150
_override_hook_target=_override_hook_target)
2153
master_branch.unlock()
2155
def get_bound_location(self):
2157
return self._transport.get_bytes('bound')[:-1]
2158
except errors.NoSuchFile:
2162
def get_master_branch(self, possible_transports=None):
2163
"""Return the branch we are bound to.
2165
:return: Either a Branch, or None
2167
This could memoise the branch, but if thats done
2168
it must be revalidated on each new lock.
2169
So for now we just don't memoise it.
2170
# RBC 20060304 review this decision.
2172
bound_loc = self.get_bound_location()
2176
return Branch.open(bound_loc,
2177
possible_transports=possible_transports)
2178
except (errors.NotBranchError, errors.ConnectionError), e:
2179
raise errors.BoundBranchConnectionFailure(
2183
def set_bound_location(self, location):
2184
"""Set the target where this branch is bound to.
2186
:param location: URL to the target branch
2189
self._transport.put_bytes('bound', location+'\n',
2190
mode=self.bzrdir._get_file_mode())
2193
self._transport.delete('bound')
2194
except errors.NoSuchFile:
2199
def bind(self, other):
2200
"""Bind this branch to the branch other.
2202
This does not push or pull data between the branches, though it does
2203
check for divergence to raise an error when the branches are not
2204
either the same, or one a prefix of the other. That behaviour may not
2205
be useful, so that check may be removed in future.
2207
:param other: The branch to bind to
2210
# TODO: jam 20051230 Consider checking if the target is bound
2211
# It is debatable whether you should be able to bind to
2212
# a branch which is itself bound.
2213
# Committing is obviously forbidden,
2214
# but binding itself may not be.
2215
# Since we *have* to check at commit time, we don't
2216
# *need* to check here
2218
# we want to raise diverged if:
2219
# last_rev is not in the other_last_rev history, AND
2220
# other_last_rev is not in our history, and do it without pulling
2222
self.set_bound_location(other.base)
2226
"""If bound, unbind"""
2227
return self.set_bound_location(None)
2230
def update(self, possible_transports=None):
2231
"""Synchronise this branch with the master branch if any.
2233
:return: None or the last_revision that was pivoted out during the
2236
master = self.get_master_branch(possible_transports)
2237
if master is not None:
2238
old_tip = _mod_revision.ensure_null(self.last_revision())
2239
self.pull(master, overwrite=True)
2240
if self.repository.get_graph().is_ancestor(old_tip,
2241
_mod_revision.ensure_null(self.last_revision())):
2247
class BzrBranch7(BzrBranch5):
2248
"""A branch with support for a fallback repository."""
2250
def _get_fallback_repository(self, url):
2251
"""Get the repository we fallback to at url."""
2252
url = urlutils.join(self.base, url)
2253
a_bzrdir = bzrdir.BzrDir.open(url,
2254
possible_transports=[self._transport])
2255
return a_bzrdir.open_branch().repository
2257
def _activate_fallback_location(self, url):
2258
"""Activate the branch/repository from url as a fallback repository."""
2259
self.repository.add_fallback_repository(
2260
self._get_fallback_repository(url))
2262
def _open_hook(self):
2264
url = self.get_stacked_on_url()
2265
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2266
errors.UnstackableBranchFormat):
2269
for hook in Branch.hooks['transform_fallback_location']:
2270
url = hook(self, url)
2272
hook_name = Branch.hooks.get_hook_name(hook)
2273
raise AssertionError(
2274
"'transform_fallback_location' hook %s returned "
2275
"None, not a URL." % hook_name)
2276
self._activate_fallback_location(url)
2278
def _check_stackable_repo(self):
2279
if not self.repository._format.supports_external_lookups:
2280
raise errors.UnstackableRepositoryFormat(self.repository._format,
2281
self.repository.base)
2283
def __init__(self, *args, **kwargs):
2284
super(BzrBranch7, self).__init__(*args, **kwargs)
2285
self._last_revision_info_cache = None
2286
self._partial_revision_history_cache = []
2288
def _clear_cached_state(self):
2289
super(BzrBranch7, self)._clear_cached_state()
2290
self._last_revision_info_cache = None
2291
self._partial_revision_history_cache = []
2293
def _last_revision_info(self):
2294
revision_string = self._transport.get_bytes('last-revision')
2295
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2296
revision_id = cache_utf8.get_cached_utf8(revision_id)
2298
return revno, revision_id
2300
def _write_last_revision_info(self, revno, revision_id):
2301
"""Simply write out the revision id, with no checks.
2303
Use set_last_revision_info to perform this safely.
2305
Does not update the revision_history cache.
2306
Intended to be called by set_last_revision_info and
2307
_write_revision_history.
2309
revision_id = _mod_revision.ensure_null(revision_id)
2310
out_string = '%d %s\n' % (revno, revision_id)
2311
self._transport.put_bytes('last-revision', out_string,
2312
mode=self.bzrdir._get_file_mode())
2315
def set_last_revision_info(self, revno, revision_id):
2316
revision_id = _mod_revision.ensure_null(revision_id)
2317
old_revno, old_revid = self.last_revision_info()
2318
if self._get_append_revisions_only():
2319
self._check_history_violation(revision_id)
2320
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2321
self._write_last_revision_info(revno, revision_id)
2322
self._clear_cached_state()
2323
self._last_revision_info_cache = revno, revision_id
2324
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2326
def _synchronize_history(self, destination, revision_id):
2327
"""Synchronize last revision and revision history between branches.
2329
:see: Branch._synchronize_history
2331
# XXX: The base Branch has a fast implementation of this method based
2332
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2333
# that uses set_revision_history. This class inherits from BzrBranch5,
2334
# but wants the fast implementation, so it calls
2335
# Branch._synchronize_history directly.
2336
Branch._synchronize_history(self, destination, revision_id)
2338
def _check_history_violation(self, revision_id):
2339
last_revision = _mod_revision.ensure_null(self.last_revision())
2340
if _mod_revision.is_null(last_revision):
2342
if last_revision not in self._lefthand_history(revision_id):
2343
raise errors.AppendRevisionsOnlyViolation(self.base)
2345
def _gen_revision_history(self):
2346
"""Generate the revision history from last revision
2348
last_revno, last_revision = self.last_revision_info()
2349
self._extend_partial_history(stop_index=last_revno-1)
2350
return list(reversed(self._partial_revision_history_cache))
2352
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2353
"""Extend the partial history to include a given index
2355
If a stop_index is supplied, stop when that index has been reached.
2356
If a stop_revision is supplied, stop when that revision is
2357
encountered. Otherwise, stop when the beginning of history is
2360
:param stop_index: The index which should be present. When it is
2361
present, history extension will stop.
2362
:param revision_id: The revision id which should be present. When
2363
it is encountered, history extension will stop.
2365
repo = self.repository
2366
if len(self._partial_revision_history_cache) == 0:
2367
iterator = repo.iter_reverse_revision_history(self.last_revision())
2369
start_revision = self._partial_revision_history_cache[-1]
2370
iterator = repo.iter_reverse_revision_history(start_revision)
2371
#skip the last revision in the list
2372
next_revision = iterator.next()
2373
for revision_id in iterator:
2374
self._partial_revision_history_cache.append(revision_id)
2375
if (stop_index is not None and
2376
len(self._partial_revision_history_cache) > stop_index):
2378
if revision_id == stop_revision:
2381
def _write_revision_history(self, history):
2382
"""Factored out of set_revision_history.
2384
This performs the actual writing to disk, with format-specific checks.
2385
It is intended to be called by BzrBranch5.set_revision_history.
2387
if len(history) == 0:
2388
last_revision = 'null:'
2390
if history != self._lefthand_history(history[-1]):
2391
raise errors.NotLefthandHistory(history)
2392
last_revision = history[-1]
2393
if self._get_append_revisions_only():
2394
self._check_history_violation(last_revision)
2395
self._write_last_revision_info(len(history), last_revision)
2398
def _set_parent_location(self, url):
2399
"""Set the parent branch"""
2400
self._set_config_location('parent_location', url, make_relative=True)
2403
def _get_parent_location(self):
2404
"""Set the parent branch"""
2405
return self._get_config_location('parent_location')
2407
def set_push_location(self, location):
2408
"""See Branch.set_push_location."""
2409
self._set_config_location('push_location', location)
2411
def set_bound_location(self, location):
2412
"""See Branch.set_push_location."""
2414
config = self.get_config()
2415
if location is None:
2416
if config.get_user_option('bound') != 'True':
2419
config.set_user_option('bound', 'False', warn_masked=True)
2422
self._set_config_location('bound_location', location,
2424
config.set_user_option('bound', 'True', warn_masked=True)
2427
def _get_bound_location(self, bound):
2428
"""Return the bound location in the config file.
2430
Return None if the bound parameter does not match"""
2431
config = self.get_config()
2432
config_bound = (config.get_user_option('bound') == 'True')
2433
if config_bound != bound:
2435
return self._get_config_location('bound_location', config=config)
2437
def get_bound_location(self):
2438
"""See Branch.set_push_location."""
2439
return self._get_bound_location(True)
2441
def get_old_bound_location(self):
2442
"""See Branch.get_old_bound_location"""
2443
return self._get_bound_location(False)
2445
def get_stacked_on_url(self):
2446
# you can always ask for the URL; but you might not be able to use it
2447
# if the repo can't support stacking.
2448
## self._check_stackable_repo()
2449
stacked_url = self._get_config_location('stacked_on_location')
2450
if stacked_url is None:
2451
raise errors.NotStacked(self)
2454
def set_append_revisions_only(self, enabled):
2459
self.get_config().set_user_option('append_revisions_only', value,
2462
def set_stacked_on_url(self, url):
2463
self._check_stackable_repo()
2466
old_url = self.get_stacked_on_url()
2467
except (errors.NotStacked, errors.UnstackableBranchFormat,
2468
errors.UnstackableRepositoryFormat):
2471
# repositories don't offer an interface to remove fallback
2472
# repositories today; take the conceptually simpler option and just
2474
self.repository = self.bzrdir.find_repository()
2475
# for every revision reference the branch has, ensure it is pulled
2477
source_repository = self._get_fallback_repository(old_url)
2478
for revision_id in chain([self.last_revision()],
2479
self.tags.get_reverse_tag_dict()):
2480
self.repository.fetch(source_repository, revision_id,
2483
self._activate_fallback_location(url)
2484
# write this out after the repository is stacked to avoid setting a
2485
# stacked config that doesn't work.
2486
self._set_config_location('stacked_on_location', url)
2488
def _get_append_revisions_only(self):
2489
value = self.get_config().get_user_option('append_revisions_only')
2490
return value == 'True'
2492
def _make_tags(self):
2493
return BasicTags(self)
2496
def generate_revision_history(self, revision_id, last_rev=None,
2498
"""See BzrBranch5.generate_revision_history"""
2499
history = self._lefthand_history(revision_id, last_rev, other_branch)
2500
revno = len(history)
2501
self.set_last_revision_info(revno, revision_id)
2504
def get_rev_id(self, revno, history=None):
2505
"""Find the revision id of the specified revno."""
2507
return _mod_revision.NULL_REVISION
2509
last_revno, last_revision_id = self.last_revision_info()
2510
if revno <= 0 or revno > last_revno:
2511
raise errors.NoSuchRevision(self, revno)
2513
if history is not None:
2514
return history[revno - 1]
2516
index = last_revno - revno
2517
if len(self._partial_revision_history_cache) <= index:
2518
self._extend_partial_history(stop_index=index)
2519
if len(self._partial_revision_history_cache) > index:
2520
return self._partial_revision_history_cache[index]
2522
raise errors.NoSuchRevision(self, revno)
2525
def revision_id_to_revno(self, revision_id):
2526
"""Given a revision id, return its revno"""
2527
if _mod_revision.is_null(revision_id):
2530
index = self._partial_revision_history_cache.index(revision_id)
2532
self._extend_partial_history(stop_revision=revision_id)
2533
index = len(self._partial_revision_history_cache) - 1
2534
if self._partial_revision_history_cache[index] != revision_id:
2535
raise errors.NoSuchRevision(self, revision_id)
2536
return self.revno() - index
2539
class BzrBranch6(BzrBranch7):
2540
"""See BzrBranchFormat6 for the capabilities of this branch.
2542
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2546
def get_stacked_on_url(self):
2547
raise errors.UnstackableBranchFormat(self._format, self.base)
2549
def set_stacked_on_url(self, url):
2550
raise errors.UnstackableBranchFormat(self._format, self.base)
2553
######################################################################
2554
# results of operations
2557
class _Result(object):
2559
def _show_tag_conficts(self, to_file):
2560
if not getattr(self, 'tag_conflicts', None):
2562
to_file.write('Conflicting tags:\n')
2563
for name, value1, value2 in self.tag_conflicts:
2564
to_file.write(' %s\n' % (name, ))
2567
class PullResult(_Result):
2568
"""Result of a Branch.pull operation.
2570
:ivar old_revno: Revision number before pull.
2571
:ivar new_revno: Revision number after pull.
2572
:ivar old_revid: Tip revision id before pull.
2573
:ivar new_revid: Tip revision id after pull.
2574
:ivar source_branch: Source (local) branch object.
2575
:ivar master_branch: Master branch of the target, or the target if no
2577
:ivar local_branch: target branch if there is a Master, else None
2578
:ivar target_branch: Target/destination branch object.
2579
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2583
# DEPRECATED: pull used to return the change in revno
2584
return self.new_revno - self.old_revno
2586
def report(self, to_file):
2588
if self.old_revid == self.new_revid:
2589
to_file.write('No revisions to pull.\n')
2591
to_file.write('Now on revision %d.\n' % self.new_revno)
2592
self._show_tag_conficts(to_file)
2595
class PushResult(_Result):
2596
"""Result of a Branch.push operation.
2598
:ivar old_revno: Revision number before push.
2599
:ivar new_revno: Revision number after push.
2600
:ivar old_revid: Tip revision id before push.
2601
:ivar new_revid: Tip revision id after push.
2602
:ivar source_branch: Source branch object.
2603
:ivar master_branch: Master branch of the target, or None.
2604
:ivar target_branch: Target/destination branch object.
2608
# DEPRECATED: push used to return the change in revno
2609
return self.new_revno - self.old_revno
2611
def report(self, to_file):
2612
"""Write a human-readable description of the result."""
2613
if self.old_revid == self.new_revid:
2614
note('No new revisions to push.')
2616
note('Pushed up to revision %d.' % self.new_revno)
2617
self._show_tag_conficts(to_file)
2620
class BranchCheckResult(object):
2621
"""Results of checking branch consistency.
2626
def __init__(self, branch):
2627
self.branch = branch
2629
def report_results(self, verbose):
2630
"""Report the check results via trace.note.
2632
:param verbose: Requests more detailed display of what was checked,
2635
note('checked branch %s format %s',
2637
self.branch._format)
2640
class Converter5to6(object):
2641
"""Perform an in-place upgrade of format 5 to format 6"""
2643
def convert(self, branch):
2644
# Data for 5 and 6 can peacefully coexist.
2645
format = BzrBranchFormat6()
2646
new_branch = format.open(branch.bzrdir, _found=True)
2648
# Copy source data into target
2649
new_branch._write_last_revision_info(*branch.last_revision_info())
2650
new_branch.set_parent(branch.get_parent())
2651
new_branch.set_bound_location(branch.get_bound_location())
2652
new_branch.set_push_location(branch.get_push_location())
2654
# New branch has no tags by default
2655
new_branch.tags._set_tag_dict({})
2657
# Copying done; now update target format
2658
new_branch._transport.put_bytes('format',
2659
format.get_format_string(),
2660
mode=new_branch.bzrdir._get_file_mode())
2662
# Clean up old files
2663
new_branch._transport.delete('revision-history')
2665
branch.set_parent(None)
2666
except errors.NoSuchFile:
2668
branch.set_bound_location(None)
2671
class Converter6to7(object):
2672
"""Perform an in-place upgrade of format 6 to format 7"""
2674
def convert(self, branch):
2675
format = BzrBranchFormat7()
2676
branch._set_config_location('stacked_on_location', '')
2677
# update target format
2678
branch._transport.put_bytes('format', format.get_format_string())
2682
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2683
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2686
_run_with_write_locked_target will attempt to release the lock it acquires.
2688
If an exception is raised by callable, then that exception *will* be
2689
propagated, even if the unlock attempt raises its own error. Thus
2690
_run_with_write_locked_target should be preferred to simply doing::
2694
return callable(*args, **kwargs)
2699
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2700
# should share code?
2703
result = callable(*args, **kwargs)
2705
exc_info = sys.exc_info()
2709
raise exc_info[0], exc_info[1], exc_info[2]
2715
class InterBranch(InterObject):
2716
"""This class represents operations taking place between two branches.
2718
Its instances have methods like pull() and push() and contain
2719
references to the source and target repositories these operations
2720
can be carried out on.
2724
"""The available optimised InterBranch types."""
2727
def _get_branch_formats_to_test():
2728
"""Return a tuple with the Branch formats to use when testing."""
2729
raise NotImplementedError(self._get_branch_formats_to_test)
2731
def update_revisions(self, stop_revision=None, overwrite=False,
2733
"""Pull in new perfect-fit revisions.
2735
:param stop_revision: Updated until the given revision
2736
:param overwrite: Always set the branch pointer, rather than checking
2737
to see if it is a proper descendant.
2738
:param graph: A Graph object that can be used to query history
2739
information. This can be None.
2742
raise NotImplementedError(self.update_revisions)
2745
class GenericInterBranch(InterBranch):
2746
"""InterBranch implementation that uses public Branch functions.
2750
def _get_branch_formats_to_test():
2751
return BranchFormat._default_format, BranchFormat._default_format
2753
def update_revisions(self, stop_revision=None, overwrite=False,
2755
"""See InterBranch.update_revisions()."""
2756
self.source.lock_read()
2758
other_revno, other_last_revision = self.source.last_revision_info()
2759
stop_revno = None # unknown
2760
if stop_revision is None:
2761
stop_revision = other_last_revision
2762
if _mod_revision.is_null(stop_revision):
2763
# if there are no commits, we're done.
2765
stop_revno = other_revno
2767
# what's the current last revision, before we fetch [and change it
2769
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2770
# we fetch here so that we don't process data twice in the common
2771
# case of having something to pull, and so that the check for
2772
# already merged can operate on the just fetched graph, which will
2773
# be cached in memory.
2774
self.target.fetch(self.source, stop_revision)
2775
# Check to see if one is an ancestor of the other
2778
graph = self.target.repository.get_graph()
2779
if self.target._check_if_descendant_or_diverged(
2780
stop_revision, last_rev, graph, self.source):
2781
# stop_revision is a descendant of last_rev, but we aren't
2782
# overwriting, so we're done.
2784
if stop_revno is None:
2786
graph = self.target.repository.get_graph()
2787
this_revno, this_last_revision = \
2788
self.target.last_revision_info()
2789
stop_revno = graph.find_distance_to_null(stop_revision,
2790
[(other_last_revision, other_revno),
2791
(this_last_revision, this_revno)])
2792
self.target.set_last_revision_info(stop_revno, stop_revision)
2794
self.source.unlock()
2797
def is_compatible(self, source, target):
2798
# GenericBranch uses the public API, so always compatible
2802
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
