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 import_last_revision_info(self, source_repo, revno, revid):
710
"""Set the last revision info, importing from another repo if necessary.
712
This is used by the bound branch code to upload a revision to
713
the master branch first before updating the tip of the local branch.
715
:param source_repo: Source repository to optionally fetch from
716
:param revno: Revision number of the new tip
717
:param revid: Revision id of the new tip
719
if not self.repository.has_same_location(source_repo):
720
self.repository.fetch(source_repo, revision_id=revid)
721
self.set_last_revision_info(revno, revid)
723
def revision_id_to_revno(self, revision_id):
724
"""Given a revision id, return its revno"""
725
if _mod_revision.is_null(revision_id):
727
history = self.revision_history()
729
return history.index(revision_id) + 1
731
raise errors.NoSuchRevision(self, revision_id)
733
def get_rev_id(self, revno, history=None):
734
"""Find the revision id of the specified revno."""
736
return _mod_revision.NULL_REVISION
738
history = self.revision_history()
739
if revno <= 0 or revno > len(history):
740
raise errors.NoSuchRevision(self, revno)
741
return history[revno - 1]
743
def pull(self, source, overwrite=False, stop_revision=None,
744
possible_transports=None, _override_hook_target=None):
745
"""Mirror source into this branch.
747
This branch is considered to be 'local', having low latency.
749
:returns: PullResult instance
751
raise NotImplementedError(self.pull)
753
def push(self, target, overwrite=False, stop_revision=None):
754
"""Mirror this branch into target.
756
This branch is considered to be 'local', having low latency.
758
raise NotImplementedError(self.push)
760
def basis_tree(self):
761
"""Return `Tree` object for last revision."""
762
return self.repository.revision_tree(self.last_revision())
764
def get_parent(self):
765
"""Return the parent location of the branch.
767
This is the default location for pull/missing. The usual
768
pattern is that the user can override it by specifying a
771
raise NotImplementedError(self.get_parent)
773
def _set_config_location(self, name, url, config=None,
774
make_relative=False):
776
config = self.get_config()
780
url = urlutils.relative_url(self.base, url)
781
config.set_user_option(name, url, warn_masked=True)
783
def _get_config_location(self, name, config=None):
785
config = self.get_config()
786
location = config.get_user_option(name)
791
def get_submit_branch(self):
792
"""Return the submit location of the branch.
794
This is the default location for bundle. The usual
795
pattern is that the user can override it by specifying a
798
return self.get_config().get_user_option('submit_branch')
800
def set_submit_branch(self, location):
801
"""Return the submit location of the branch.
803
This is the default location for bundle. The usual
804
pattern is that the user can override it by specifying a
807
self.get_config().set_user_option('submit_branch', location,
810
def get_public_branch(self):
811
"""Return the public location of the branch.
813
This is is used by merge directives.
815
return self._get_config_location('public_branch')
817
def set_public_branch(self, location):
818
"""Return the submit location of the branch.
820
This is the default location for bundle. The usual
821
pattern is that the user can override it by specifying a
824
self._set_config_location('public_branch', location)
826
def get_push_location(self):
827
"""Return the None or the location to push this branch to."""
828
push_loc = self.get_config().get_user_option('push_location')
831
def set_push_location(self, location):
832
"""Set a new push location for this branch."""
833
raise NotImplementedError(self.set_push_location)
835
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
836
"""Run the post_change_branch_tip hooks."""
837
hooks = Branch.hooks['post_change_branch_tip']
840
new_revno, new_revid = self.last_revision_info()
841
params = ChangeBranchTipParams(
842
self, old_revno, new_revno, old_revid, new_revid)
846
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
847
"""Run the pre_change_branch_tip hooks."""
848
hooks = Branch.hooks['pre_change_branch_tip']
851
old_revno, old_revid = self.last_revision_info()
852
params = ChangeBranchTipParams(
853
self, old_revno, new_revno, old_revid, new_revid)
857
except errors.TipChangeRejected:
860
exc_info = sys.exc_info()
861
hook_name = Branch.hooks.get_hook_name(hook)
862
raise errors.HookFailed(
863
'pre_change_branch_tip', hook_name, exc_info)
865
def set_parent(self, url):
866
raise NotImplementedError(self.set_parent)
870
"""Synchronise this branch with the master branch if any.
872
:return: None or the last_revision pivoted out during the update.
876
def check_revno(self, revno):
878
Check whether a revno corresponds to any revision.
879
Zero (the NULL revision) is considered valid.
882
self.check_real_revno(revno)
884
def check_real_revno(self, revno):
886
Check whether a revno corresponds to a real revision.
887
Zero (the NULL revision) is considered invalid
889
if revno < 1 or revno > self.revno():
890
raise errors.InvalidRevisionNumber(revno)
893
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
894
"""Clone this branch into to_bzrdir preserving all semantic values.
896
Most API users will want 'create_clone_on_transport', which creates a
897
new bzrdir and branch on the fly.
899
revision_id: if not None, the revision history in the new branch will
900
be truncated to end with revision_id.
902
result = to_bzrdir.create_branch()
903
if repository_policy is not None:
904
repository_policy.configure_branch(result)
905
self.copy_content_into(result, revision_id=revision_id)
909
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
910
"""Create a new line of development from the branch, into to_bzrdir.
912
to_bzrdir controls the branch format.
914
revision_id: if not None, the revision history in the new branch will
915
be truncated to end with revision_id.
917
result = to_bzrdir.create_branch()
918
if repository_policy is not None:
919
repository_policy.configure_branch(result)
920
self.copy_content_into(result, revision_id=revision_id)
921
result.set_parent(self.bzrdir.root_transport.base)
924
def _synchronize_history(self, destination, revision_id):
925
"""Synchronize last revision and revision history between branches.
927
This version is most efficient when the destination is also a
928
BzrBranch6, but works for BzrBranch5, as long as the destination's
929
repository contains all the lefthand ancestors of the intended
930
last_revision. If not, set_last_revision_info will fail.
932
:param destination: The branch to copy the history into
933
:param revision_id: The revision-id to truncate history at. May
934
be None to copy complete history.
936
source_revno, source_revision_id = self.last_revision_info()
937
if revision_id is None:
938
revno, revision_id = source_revno, source_revision_id
939
elif source_revision_id == revision_id:
940
# we know the revno without needing to walk all of history
943
# To figure out the revno for a random revision, we need to build
944
# the revision history, and count its length.
945
# We don't care about the order, just how long it is.
946
# Alternatively, we could start at the current location, and count
947
# backwards. But there is no guarantee that we will find it since
948
# it may be a merged revision.
949
revno = len(list(self.repository.iter_reverse_revision_history(
951
destination.set_last_revision_info(revno, revision_id)
954
def copy_content_into(self, destination, revision_id=None):
955
"""Copy the content of self into destination.
957
revision_id: if not None, the revision history in the new branch will
958
be truncated to end with revision_id.
960
self._synchronize_history(destination, revision_id)
962
parent = self.get_parent()
963
except errors.InaccessibleParent, e:
964
mutter('parent was not accessible to copy: %s', e)
967
destination.set_parent(parent)
968
if self._push_should_merge_tags():
969
self.tags.merge_to(destination.tags)
973
"""Check consistency of the branch.
975
In particular this checks that revisions given in the revision-history
976
do actually match up in the revision graph, and that they're all
977
present in the repository.
979
Callers will typically also want to check the repository.
981
:return: A BranchCheckResult.
983
mainline_parent_id = None
984
last_revno, last_revision_id = self.last_revision_info()
985
real_rev_history = list(self.repository.iter_reverse_revision_history(
987
real_rev_history.reverse()
988
if len(real_rev_history) != last_revno:
989
raise errors.BzrCheckError('revno does not match len(mainline)'
990
' %s != %s' % (last_revno, len(real_rev_history)))
991
# TODO: We should probably also check that real_rev_history actually
992
# matches self.revision_history()
993
for revision_id in real_rev_history:
995
revision = self.repository.get_revision(revision_id)
996
except errors.NoSuchRevision, e:
997
raise errors.BzrCheckError("mainline revision {%s} not in repository"
999
# In general the first entry on the revision history has no parents.
1000
# But it's not illegal for it to have parents listed; this can happen
1001
# in imports from Arch when the parents weren't reachable.
1002
if mainline_parent_id is not None:
1003
if mainline_parent_id not in revision.parent_ids:
1004
raise errors.BzrCheckError("previous revision {%s} not listed among "
1006
% (mainline_parent_id, revision_id))
1007
mainline_parent_id = revision_id
1008
return BranchCheckResult(self)
1010
def _get_checkout_format(self):
1011
"""Return the most suitable metadir for a checkout of this branch.
1012
Weaves are used if this branch's repository uses weaves.
1014
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1015
from bzrlib.repofmt import weaverepo
1016
format = bzrdir.BzrDirMetaFormat1()
1017
format.repository_format = weaverepo.RepositoryFormat7()
1019
format = self.repository.bzrdir.checkout_metadir()
1020
format.set_branch_format(self._format)
1023
def create_clone_on_transport(self, to_transport, revision_id=None,
1025
"""Create a clone of this branch and its bzrdir.
1027
:param to_transport: The transport to clone onto.
1028
:param revision_id: The revision id to use as tip in the new branch.
1029
If None the tip is obtained from this branch.
1030
:param stacked_on: An optional URL to stack the clone on.
1032
# XXX: Fix the bzrdir API to allow getting the branch back from the
1033
# clone call. Or something. 20090224 RBC/spiv.
1034
dir_to = self.bzrdir.clone_on_transport(to_transport,
1035
revision_id=revision_id, stacked_on=stacked_on)
1036
return dir_to.open_branch()
1038
def create_checkout(self, to_location, revision_id=None,
1039
lightweight=False, accelerator_tree=None,
1041
"""Create a checkout of a branch.
1043
:param to_location: The url to produce the checkout at
1044
:param revision_id: The revision to check out
1045
:param lightweight: If True, produce a lightweight checkout, otherwise,
1046
produce a bound branch (heavyweight checkout)
1047
:param accelerator_tree: A tree which can be used for retrieving file
1048
contents more quickly than the revision tree, i.e. a workingtree.
1049
The revision tree will be used for cases where accelerator_tree's
1050
content is different.
1051
:param hardlink: If true, hard-link files from accelerator_tree,
1053
:return: The tree of the created checkout
1055
t = transport.get_transport(to_location)
1058
format = self._get_checkout_format()
1059
checkout = format.initialize_on_transport(t)
1060
from_branch = BranchReferenceFormat().initialize(checkout, self)
1062
format = self._get_checkout_format()
1063
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1064
to_location, force_new_tree=False, format=format)
1065
checkout = checkout_branch.bzrdir
1066
checkout_branch.bind(self)
1067
# pull up to the specified revision_id to set the initial
1068
# branch tip correctly, and seed it with history.
1069
checkout_branch.pull(self, stop_revision=revision_id)
1071
tree = checkout.create_workingtree(revision_id,
1072
from_branch=from_branch,
1073
accelerator_tree=accelerator_tree,
1075
basis_tree = tree.basis_tree()
1076
basis_tree.lock_read()
1078
for path, file_id in basis_tree.iter_references():
1079
reference_parent = self.reference_parent(file_id, path)
1080
reference_parent.create_checkout(tree.abspath(path),
1081
basis_tree.get_reference_revision(file_id, path),
1088
def reconcile(self, thorough=True):
1089
"""Make sure the data stored in this branch is consistent."""
1090
from bzrlib.reconcile import BranchReconciler
1091
reconciler = BranchReconciler(self, thorough=thorough)
1092
reconciler.reconcile()
1095
def reference_parent(self, file_id, path):
1096
"""Return the parent branch for a tree-reference file_id
1097
:param file_id: The file_id of the tree reference
1098
:param path: The path of the file_id in the tree
1099
:return: A branch associated with the file_id
1101
# FIXME should provide multiple branches, based on config
1102
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1104
def supports_tags(self):
1105
return self._format.supports_tags()
1107
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1109
"""Ensure that revision_b is a descendant of revision_a.
1111
This is a helper function for update_revisions.
1113
:raises: DivergedBranches if revision_b has diverged from revision_a.
1114
:returns: True if revision_b is a descendant of revision_a.
1116
relation = self._revision_relations(revision_a, revision_b, graph)
1117
if relation == 'b_descends_from_a':
1119
elif relation == 'diverged':
1120
raise errors.DivergedBranches(self, other_branch)
1121
elif relation == 'a_descends_from_b':
1124
raise AssertionError("invalid relation: %r" % (relation,))
1126
def _revision_relations(self, revision_a, revision_b, graph):
1127
"""Determine the relationship between two revisions.
1129
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1131
heads = graph.heads([revision_a, revision_b])
1132
if heads == set([revision_b]):
1133
return 'b_descends_from_a'
1134
elif heads == set([revision_a, revision_b]):
1135
# These branches have diverged
1137
elif heads == set([revision_a]):
1138
return 'a_descends_from_b'
1140
raise AssertionError("invalid heads: %r" % (heads,))
1143
class BranchFormat(object):
1144
"""An encapsulation of the initialization and open routines for a format.
1146
Formats provide three things:
1147
* An initialization routine,
1151
Formats are placed in an dict by their format string for reference
1152
during branch opening. Its not required that these be instances, they
1153
can be classes themselves with class methods - it simply depends on
1154
whether state is needed for a given format or not.
1156
Once a format is deprecated, just deprecate the initialize and open
1157
methods on the format class. Do not deprecate the object, as the
1158
object will be created every time regardless.
1161
_default_format = None
1162
"""The default format used for new branches."""
1165
"""The known formats."""
1167
def __eq__(self, other):
1168
return self.__class__ is other.__class__
1170
def __ne__(self, other):
1171
return not (self == other)
1174
def find_format(klass, a_bzrdir):
1175
"""Return the format for the branch object in a_bzrdir."""
1177
transport = a_bzrdir.get_branch_transport(None)
1178
format_string = transport.get("format").read()
1179
return klass._formats[format_string]
1180
except errors.NoSuchFile:
1181
raise errors.NotBranchError(path=transport.base)
1183
raise errors.UnknownFormatError(format=format_string, kind='branch')
1186
def get_default_format(klass):
1187
"""Return the current default format."""
1188
return klass._default_format
1190
def get_reference(self, a_bzrdir):
1191
"""Get the target reference of the branch in a_bzrdir.
1193
format probing must have been completed before calling
1194
this method - it is assumed that the format of the branch
1195
in a_bzrdir is correct.
1197
:param a_bzrdir: The bzrdir to get the branch data from.
1198
:return: None if the branch is not a reference branch.
1203
def set_reference(self, a_bzrdir, to_branch):
1204
"""Set the target reference of the branch in a_bzrdir.
1206
format probing must have been completed before calling
1207
this method - it is assumed that the format of the branch
1208
in a_bzrdir is correct.
1210
:param a_bzrdir: The bzrdir to set the branch reference for.
1211
:param to_branch: branch that the checkout is to reference
1213
raise NotImplementedError(self.set_reference)
1215
def get_format_string(self):
1216
"""Return the ASCII format string that identifies this format."""
1217
raise NotImplementedError(self.get_format_string)
1219
def get_format_description(self):
1220
"""Return the short format description for this format."""
1221
raise NotImplementedError(self.get_format_description)
1223
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1225
"""Initialize a branch in a bzrdir, with specified files
1227
:param a_bzrdir: The bzrdir to initialize the branch in
1228
:param utf8_files: The files to create as a list of
1229
(filename, content) tuples
1230
:param set_format: If True, set the format with
1231
self.get_format_string. (BzrBranch4 has its format set
1233
:return: a branch in this format
1235
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1236
branch_transport = a_bzrdir.get_branch_transport(self)
1238
'metadir': ('lock', lockdir.LockDir),
1239
'branch4': ('branch-lock', lockable_files.TransportLock),
1241
lock_name, lock_class = lock_map[lock_type]
1242
control_files = lockable_files.LockableFiles(branch_transport,
1243
lock_name, lock_class)
1244
control_files.create_lock()
1245
control_files.lock_write()
1247
utf8_files += [('format', self.get_format_string())]
1249
for (filename, content) in utf8_files:
1250
branch_transport.put_bytes(
1252
mode=a_bzrdir._get_file_mode())
1254
control_files.unlock()
1255
return self.open(a_bzrdir, _found=True)
1257
def initialize(self, a_bzrdir):
1258
"""Create a branch of this format in a_bzrdir."""
1259
raise NotImplementedError(self.initialize)
1261
def is_supported(self):
1262
"""Is this format supported?
1264
Supported formats can be initialized and opened.
1265
Unsupported formats may not support initialization or committing or
1266
some other features depending on the reason for not being supported.
1270
def network_name(self):
1271
"""A simple byte string uniquely identifying this format for RPC calls.
1273
MetaDir branch formats use their disk format string to identify the
1274
repository over the wire. All in one formats such as bzr < 0.8, and
1275
foreign formats like svn/git and hg should use some marker which is
1276
unique and immutable.
1278
raise NotImplementedError(self.network_name)
1280
def open(self, a_bzrdir, _found=False):
1281
"""Return the branch object for a_bzrdir
1283
_found is a private parameter, do not use it. It is used to indicate
1284
if format probing has already be done.
1286
raise NotImplementedError(self.open)
1289
def register_format(klass, format):
1290
"""Register a metadir format."""
1291
klass._formats[format.get_format_string()] = format
1292
# Metadir formats have a network name of their format string.
1293
network_format_registry.register(format.get_format_string(), format)
1296
def set_default_format(klass, format):
1297
klass._default_format = format
1299
def supports_stacking(self):
1300
"""True if this format records a stacked-on branch."""
1304
def unregister_format(klass, format):
1305
del klass._formats[format.get_format_string()]
1308
return self.get_format_description().rstrip()
1310
def supports_tags(self):
1311
"""True if this format supports tags stored in the branch"""
1312
return False # by default
1315
class BranchHooks(Hooks):
1316
"""A dictionary mapping hook name to a list of callables for branch hooks.
1318
e.g. ['set_rh'] Is the list of items to be called when the
1319
set_revision_history function is invoked.
1323
"""Create the default hooks.
1325
These are all empty initially, because by default nothing should get
1328
Hooks.__init__(self)
1329
# Introduced in 0.15:
1330
# invoked whenever the revision history has been set
1331
# with set_revision_history. The api signature is
1332
# (branch, revision_history), and the branch will
1335
# Invoked after a branch is opened. The api signature is (branch).
1337
# invoked after a push operation completes.
1338
# the api signature is
1340
# containing the members
1341
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1342
# where local is the local target branch or None, master is the target
1343
# master branch, and the rest should be self explanatory. The source
1344
# is read locked and the target branches write locked. Source will
1345
# be the local low-latency branch.
1346
self['post_push'] = []
1347
# invoked after a pull operation completes.
1348
# the api signature is
1350
# containing the members
1351
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1352
# where local is the local branch or None, master is the target
1353
# master branch, and the rest should be self explanatory. The source
1354
# is read locked and the target branches write locked. The local
1355
# branch is the low-latency branch.
1356
self['post_pull'] = []
1357
# invoked before a commit operation takes place.
1358
# the api signature is
1359
# (local, master, old_revno, old_revid, future_revno, future_revid,
1360
# tree_delta, future_tree).
1361
# old_revid is NULL_REVISION for the first commit to a branch
1362
# tree_delta is a TreeDelta object describing changes from the basis
1363
# revision, hooks MUST NOT modify this delta
1364
# future_tree is an in-memory tree obtained from
1365
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1366
self['pre_commit'] = []
1367
# invoked after a commit operation completes.
1368
# the api signature is
1369
# (local, master, old_revno, old_revid, new_revno, new_revid)
1370
# old_revid is NULL_REVISION for the first commit to a branch.
1371
self['post_commit'] = []
1372
# invoked after a uncommit operation completes.
1373
# the api signature is
1374
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1375
# local is the local branch or None, master is the target branch,
1376
# and an empty branch recieves new_revno of 0, new_revid of None.
1377
self['post_uncommit'] = []
1379
# Invoked before the tip of a branch changes.
1380
# the api signature is
1381
# (params) where params is a ChangeBranchTipParams with the members
1382
# (branch, old_revno, new_revno, old_revid, new_revid)
1383
self['pre_change_branch_tip'] = []
1385
# Invoked after the tip of a branch changes.
1386
# the api signature is
1387
# (params) where params is a ChangeBranchTipParams with the members
1388
# (branch, old_revno, new_revno, old_revid, new_revid)
1389
self['post_change_branch_tip'] = []
1391
# Invoked when a stacked branch activates its fallback locations and
1392
# allows the transformation of the url of said location.
1393
# the api signature is
1394
# (branch, url) where branch is the branch having its fallback
1395
# location activated and url is the url for the fallback location.
1396
# The hook should return a url.
1397
self['transform_fallback_location'] = []
1400
# install the default hooks into the Branch class.
1401
Branch.hooks = BranchHooks()
1404
class ChangeBranchTipParams(object):
1405
"""Object holding parameters passed to *_change_branch_tip hooks.
1407
There are 5 fields that hooks may wish to access:
1409
:ivar branch: the branch being changed
1410
:ivar old_revno: revision number before the change
1411
:ivar new_revno: revision number after the change
1412
:ivar old_revid: revision id before the change
1413
:ivar new_revid: revision id after the change
1415
The revid fields are strings. The revno fields are integers.
1418
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1419
"""Create a group of ChangeBranchTip parameters.
1421
:param branch: The branch being changed.
1422
:param old_revno: Revision number before the change.
1423
:param new_revno: Revision number after the change.
1424
:param old_revid: Tip revision id before the change.
1425
:param new_revid: Tip revision id after the change.
1427
self.branch = branch
1428
self.old_revno = old_revno
1429
self.new_revno = new_revno
1430
self.old_revid = old_revid
1431
self.new_revid = new_revid
1433
def __eq__(self, other):
1434
return self.__dict__ == other.__dict__
1437
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1438
self.__class__.__name__, self.branch,
1439
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1442
class BzrBranchFormat4(BranchFormat):
1443
"""Bzr branch format 4.
1446
- a revision-history file.
1447
- a branch-lock lock file [ to be shared with the bzrdir ]
1450
def get_format_description(self):
1451
"""See BranchFormat.get_format_description()."""
1452
return "Branch format 4"
1454
def initialize(self, a_bzrdir):
1455
"""Create a branch of this format in a_bzrdir."""
1456
utf8_files = [('revision-history', ''),
1457
('branch-name', ''),
1459
return self._initialize_helper(a_bzrdir, utf8_files,
1460
lock_type='branch4', set_format=False)
1463
super(BzrBranchFormat4, self).__init__()
1464
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1466
def network_name(self):
1467
"""The network name for this format is the control dirs disk label."""
1468
return self._matchingbzrdir.get_format_string()
1470
def open(self, a_bzrdir, _found=False):
1471
"""Return the branch object for a_bzrdir
1473
_found is a private parameter, do not use it. It is used to indicate
1474
if format probing has already be done.
1477
# we are being called directly and must probe.
1478
raise NotImplementedError
1479
return BzrBranch(_format=self,
1480
_control_files=a_bzrdir._control_files,
1482
_repository=a_bzrdir.open_repository())
1485
return "Bazaar-NG branch format 4"
1488
class BranchFormatMetadir(BranchFormat):
1489
"""Common logic for meta-dir based branch formats."""
1491
def _branch_class(self):
1492
"""What class to instantiate on open calls."""
1493
raise NotImplementedError(self._branch_class)
1495
def network_name(self):
1496
"""A simple byte string uniquely identifying this format for RPC calls.
1498
Metadir branch formats use their format string.
1500
return self.get_format_string()
1502
def open(self, a_bzrdir, _found=False):
1503
"""Return the branch object for a_bzrdir.
1505
_found is a private parameter, do not use it. It is used to indicate
1506
if format probing has already be done.
1509
format = BranchFormat.find_format(a_bzrdir)
1510
if format.__class__ != self.__class__:
1511
raise AssertionError("wrong format %r found for %r" %
1514
transport = a_bzrdir.get_branch_transport(None)
1515
control_files = lockable_files.LockableFiles(transport, 'lock',
1517
return self._branch_class()(_format=self,
1518
_control_files=control_files,
1520
_repository=a_bzrdir.find_repository())
1521
except errors.NoSuchFile:
1522
raise errors.NotBranchError(path=transport.base)
1525
super(BranchFormatMetadir, self).__init__()
1526
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1527
self._matchingbzrdir.set_branch_format(self)
1529
def supports_tags(self):
1533
class BzrBranchFormat5(BranchFormatMetadir):
1534
"""Bzr branch format 5.
1537
- a revision-history file.
1539
- a lock dir guarding the branch itself
1540
- all of this stored in a branch/ subdirectory
1541
- works with shared repositories.
1543
This format is new in bzr 0.8.
1546
def _branch_class(self):
1549
def get_format_string(self):
1550
"""See BranchFormat.get_format_string()."""
1551
return "Bazaar-NG branch format 5\n"
1553
def get_format_description(self):
1554
"""See BranchFormat.get_format_description()."""
1555
return "Branch format 5"
1557
def initialize(self, a_bzrdir):
1558
"""Create a branch of this format in a_bzrdir."""
1559
utf8_files = [('revision-history', ''),
1560
('branch-name', ''),
1562
return self._initialize_helper(a_bzrdir, utf8_files)
1564
def supports_tags(self):
1568
class BzrBranchFormat6(BranchFormatMetadir):
1569
"""Branch format with last-revision and tags.
1571
Unlike previous formats, this has no explicit revision history. Instead,
1572
this just stores the last-revision, and the left-hand history leading
1573
up to there is the history.
1575
This format was introduced in bzr 0.15
1576
and became the default in 0.91.
1579
def _branch_class(self):
1582
def get_format_string(self):
1583
"""See BranchFormat.get_format_string()."""
1584
return "Bazaar Branch Format 6 (bzr 0.15)\n"
1586
def get_format_description(self):
1587
"""See BranchFormat.get_format_description()."""
1588
return "Branch format 6"
1590
def initialize(self, a_bzrdir):
1591
"""Create a branch of this format in a_bzrdir."""
1592
utf8_files = [('last-revision', '0 null:\n'),
1593
('branch.conf', ''),
1596
return self._initialize_helper(a_bzrdir, utf8_files)
1599
class BzrBranchFormat7(BranchFormatMetadir):
1600
"""Branch format with last-revision, tags, and a stacked location pointer.
1602
The stacked location pointer is passed down to the repository and requires
1603
a repository format with supports_external_lookups = True.
1605
This format was introduced in bzr 1.6.
1608
def _branch_class(self):
1611
def get_format_string(self):
1612
"""See BranchFormat.get_format_string()."""
1613
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
1615
def get_format_description(self):
1616
"""See BranchFormat.get_format_description()."""
1617
return "Branch format 7"
1619
def initialize(self, a_bzrdir):
1620
"""Create a branch of this format in a_bzrdir."""
1621
utf8_files = [('last-revision', '0 null:\n'),
1622
('branch.conf', ''),
1625
return self._initialize_helper(a_bzrdir, utf8_files)
1628
super(BzrBranchFormat7, self).__init__()
1629
self._matchingbzrdir.repository_format = \
1630
RepositoryFormatKnitPack5RichRoot()
1632
def supports_stacking(self):
1636
class BranchReferenceFormat(BranchFormat):
1637
"""Bzr branch reference format.
1639
Branch references are used in implementing checkouts, they
1640
act as an alias to the real branch which is at some other url.
1647
def get_format_string(self):
1648
"""See BranchFormat.get_format_string()."""
1649
return "Bazaar-NG Branch Reference Format 1\n"
1651
def get_format_description(self):
1652
"""See BranchFormat.get_format_description()."""
1653
return "Checkout reference format 1"
1655
def get_reference(self, a_bzrdir):
1656
"""See BranchFormat.get_reference()."""
1657
transport = a_bzrdir.get_branch_transport(None)
1658
return transport.get('location').read()
1660
def set_reference(self, a_bzrdir, to_branch):
1661
"""See BranchFormat.set_reference()."""
1662
transport = a_bzrdir.get_branch_transport(None)
1663
location = transport.put_bytes('location', to_branch.base)
1665
def initialize(self, a_bzrdir, target_branch=None):
1666
"""Create a branch of this format in a_bzrdir."""
1667
if target_branch is None:
1668
# this format does not implement branch itself, thus the implicit
1669
# creation contract must see it as uninitializable
1670
raise errors.UninitializableFormat(self)
1671
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1672
branch_transport = a_bzrdir.get_branch_transport(self)
1673
branch_transport.put_bytes('location',
1674
target_branch.bzrdir.root_transport.base)
1675
branch_transport.put_bytes('format', self.get_format_string())
1677
a_bzrdir, _found=True,
1678
possible_transports=[target_branch.bzrdir.root_transport])
1681
super(BranchReferenceFormat, self).__init__()
1682
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1683
self._matchingbzrdir.set_branch_format(self)
1685
def _make_reference_clone_function(format, a_branch):
1686
"""Create a clone() routine for a branch dynamically."""
1687
def clone(to_bzrdir, revision_id=None,
1688
repository_policy=None):
1689
"""See Branch.clone()."""
1690
return format.initialize(to_bzrdir, a_branch)
1691
# cannot obey revision_id limits when cloning a reference ...
1692
# FIXME RBC 20060210 either nuke revision_id for clone, or
1693
# emit some sort of warning/error to the caller ?!
1696
def open(self, a_bzrdir, _found=False, location=None,
1697
possible_transports=None):
1698
"""Return the branch that the branch reference in a_bzrdir points at.
1700
_found is a private parameter, do not use it. It is used to indicate
1701
if format probing has already be done.
1704
format = BranchFormat.find_format(a_bzrdir)
1705
if format.__class__ != self.__class__:
1706
raise AssertionError("wrong format %r found for %r" %
1708
if location is None:
1709
location = self.get_reference(a_bzrdir)
1710
real_bzrdir = bzrdir.BzrDir.open(
1711
location, possible_transports=possible_transports)
1712
result = real_bzrdir.open_branch()
1713
# this changes the behaviour of result.clone to create a new reference
1714
# rather than a copy of the content of the branch.
1715
# I did not use a proxy object because that needs much more extensive
1716
# testing, and we are only changing one behaviour at the moment.
1717
# If we decide to alter more behaviours - i.e. the implicit nickname
1718
# then this should be refactored to introduce a tested proxy branch
1719
# and a subclass of that for use in overriding clone() and ....
1721
result.clone = self._make_reference_clone_function(result)
1725
network_format_registry = registry.FormatRegistry()
1726
"""Registry of formats indexed by their network name.
1728
The network name for a branch format is an identifier that can be used when
1729
referring to formats with smart server operations. See
1730
BranchFormat.network_name() for more detail.
1734
# formats which have no format string are not discoverable
1735
# and not independently creatable, so are not registered.
1736
__format5 = BzrBranchFormat5()
1737
__format6 = BzrBranchFormat6()
1738
__format7 = BzrBranchFormat7()
1739
BranchFormat.register_format(__format5)
1740
BranchFormat.register_format(BranchReferenceFormat())
1741
BranchFormat.register_format(__format6)
1742
BranchFormat.register_format(__format7)
1743
BranchFormat.set_default_format(__format6)
1744
_legacy_formats = [BzrBranchFormat4(),
1746
network_format_registry.register(
1747
_legacy_formats[0].network_name(), _legacy_formats[0])
1750
class BzrBranch(Branch):
1751
"""A branch stored in the actual filesystem.
1753
Note that it's "local" in the context of the filesystem; it doesn't
1754
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1755
it's writable, and can be accessed via the normal filesystem API.
1757
:ivar _transport: Transport for file operations on this branch's
1758
control files, typically pointing to the .bzr/branch directory.
1759
:ivar repository: Repository for this branch.
1760
:ivar base: The url of the base directory for this branch; the one
1761
containing the .bzr directory.
1764
def __init__(self, _format=None,
1765
_control_files=None, a_bzrdir=None, _repository=None):
1766
"""Create new branch object at a particular location."""
1767
if a_bzrdir is None:
1768
raise ValueError('a_bzrdir must be supplied')
1770
self.bzrdir = a_bzrdir
1771
self._base = self.bzrdir.transport.clone('..').base
1772
# XXX: We should be able to just do
1773
# self.base = self.bzrdir.root_transport.base
1774
# but this does not quite work yet -- mbp 20080522
1775
self._format = _format
1776
if _control_files is None:
1777
raise ValueError('BzrBranch _control_files is None')
1778
self.control_files = _control_files
1779
self._transport = _control_files._transport
1780
self.repository = _repository
1781
Branch.__init__(self)
1784
return '%s(%r)' % (self.__class__.__name__, self.base)
1788
def _get_base(self):
1789
"""Returns the directory containing the control directory."""
1792
base = property(_get_base, doc="The URL for the root of this branch.")
1794
def is_locked(self):
1795
return self.control_files.is_locked()
1797
def lock_write(self, token=None):
1798
repo_token = self.repository.lock_write()
1800
token = self.control_files.lock_write(token=token)
1802
self.repository.unlock()
1806
def lock_read(self):
1807
self.repository.lock_read()
1809
self.control_files.lock_read()
1811
self.repository.unlock()
1815
# TODO: test for failed two phase locks. This is known broken.
1817
self.control_files.unlock()
1819
self.repository.unlock()
1820
if not self.control_files.is_locked():
1821
# we just released the lock
1822
self._clear_cached_state()
1824
def peek_lock_mode(self):
1825
if self.control_files._lock_count == 0:
1828
return self.control_files._lock_mode
1830
def get_physical_lock_status(self):
1831
return self.control_files.get_physical_lock_status()
1834
def print_file(self, file, revision_id):
1835
"""See Branch.print_file."""
1836
return self.repository.print_file(file, revision_id)
1838
def _write_revision_history(self, history):
1839
"""Factored out of set_revision_history.
1841
This performs the actual writing to disk.
1842
It is intended to be called by BzrBranch5.set_revision_history."""
1843
self._transport.put_bytes(
1844
'revision-history', '\n'.join(history),
1845
mode=self.bzrdir._get_file_mode())
1848
def set_revision_history(self, rev_history):
1849
"""See Branch.set_revision_history."""
1850
if 'evil' in debug.debug_flags:
1851
mutter_callsite(3, "set_revision_history scales with history.")
1852
check_not_reserved_id = _mod_revision.check_not_reserved_id
1853
for rev_id in rev_history:
1854
check_not_reserved_id(rev_id)
1855
if Branch.hooks['post_change_branch_tip']:
1856
# Don't calculate the last_revision_info() if there are no hooks
1858
old_revno, old_revid = self.last_revision_info()
1859
if len(rev_history) == 0:
1860
revid = _mod_revision.NULL_REVISION
1862
revid = rev_history[-1]
1863
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
1864
self._write_revision_history(rev_history)
1865
self._clear_cached_state()
1866
self._cache_revision_history(rev_history)
1867
for hook in Branch.hooks['set_rh']:
1868
hook(self, rev_history)
1869
if Branch.hooks['post_change_branch_tip']:
1870
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1872
def _synchronize_history(self, destination, revision_id):
1873
"""Synchronize last revision and revision history between branches.
1875
This version is most efficient when the destination is also a
1876
BzrBranch5, but works for BzrBranch6 as long as the revision
1877
history is the true lefthand parent history, and all of the revisions
1878
are in the destination's repository. If not, set_revision_history
1881
:param destination: The branch to copy the history into
1882
:param revision_id: The revision-id to truncate history at. May
1883
be None to copy complete history.
1885
if not isinstance(destination._format, BzrBranchFormat5):
1886
super(BzrBranch, self)._synchronize_history(
1887
destination, revision_id)
1889
if revision_id == _mod_revision.NULL_REVISION:
1892
new_history = self.revision_history()
1893
if revision_id is not None and new_history != []:
1895
new_history = new_history[:new_history.index(revision_id) + 1]
1897
rev = self.repository.get_revision(revision_id)
1898
new_history = rev.get_history(self.repository)[1:]
1899
destination.set_revision_history(new_history)
1902
def set_last_revision_info(self, revno, revision_id):
1903
"""Set the last revision of this branch.
1905
The caller is responsible for checking that the revno is correct
1906
for this revision id.
1908
It may be possible to set the branch last revision to an id not
1909
present in the repository. However, branches can also be
1910
configured to check constraints on history, in which case this may not
1913
revision_id = _mod_revision.ensure_null(revision_id)
1914
# this old format stores the full history, but this api doesn't
1915
# provide it, so we must generate, and might as well check it's
1917
history = self._lefthand_history(revision_id)
1918
if len(history) != revno:
1919
raise AssertionError('%d != %d' % (len(history), revno))
1920
self.set_revision_history(history)
1922
def _gen_revision_history(self):
1923
history = self._transport.get_bytes('revision-history').split('\n')
1924
if history[-1:] == ['']:
1925
# There shouldn't be a trailing newline, but just in case.
1930
def generate_revision_history(self, revision_id, last_rev=None,
1932
"""Create a new revision history that will finish with revision_id.
1934
:param revision_id: the new tip to use.
1935
:param last_rev: The previous last_revision. If not None, then this
1936
must be a ancestory of revision_id, or DivergedBranches is raised.
1937
:param other_branch: The other branch that DivergedBranches should
1938
raise with respect to.
1940
self.set_revision_history(self._lefthand_history(revision_id,
1941
last_rev, other_branch))
1943
def basis_tree(self):
1944
"""See Branch.basis_tree."""
1945
return self.repository.revision_tree(self.last_revision())
1948
def pull(self, source, overwrite=False, stop_revision=None,
1949
_hook_master=None, run_hooks=True, possible_transports=None,
1950
_override_hook_target=None):
1953
:param _hook_master: Private parameter - set the branch to
1954
be supplied as the master to pull hooks.
1955
:param run_hooks: Private parameter - if false, this branch
1956
is being called because it's the master of the primary branch,
1957
so it should not run its hooks.
1958
:param _override_hook_target: Private parameter - set the branch to be
1959
supplied as the target_branch to pull hooks.
1961
result = PullResult()
1962
result.source_branch = source
1963
if _override_hook_target is None:
1964
result.target_branch = self
1966
result.target_branch = _override_hook_target
1969
# We assume that during 'pull' the local repository is closer than
1971
graph = self.repository.get_graph(source.repository)
1972
result.old_revno, result.old_revid = self.last_revision_info()
1973
self.update_revisions(source, stop_revision, overwrite=overwrite,
1975
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1976
result.new_revno, result.new_revid = self.last_revision_info()
1978
result.master_branch = _hook_master
1979
result.local_branch = result.target_branch
1981
result.master_branch = result.target_branch
1982
result.local_branch = None
1984
for hook in Branch.hooks['post_pull']:
1990
def _get_parent_location(self):
1991
_locs = ['parent', 'pull', 'x-pull']
1994
return self._transport.get_bytes(l).strip('\n')
1995
except errors.NoSuchFile:
2000
def push(self, target, overwrite=False, stop_revision=None,
2001
_override_hook_source_branch=None):
2004
This is the basic concrete implementation of push()
2006
:param _override_hook_source_branch: If specified, run
2007
the hooks passing this Branch as the source, rather than self.
2008
This is for use of RemoteBranch, where push is delegated to the
2009
underlying vfs-based Branch.
2011
# TODO: Public option to disable running hooks - should be trivial but
2013
return _run_with_write_locked_target(
2014
target, self._push_with_bound_branches, target, overwrite,
2016
_override_hook_source_branch=_override_hook_source_branch)
2018
def _push_with_bound_branches(self, target, overwrite,
2020
_override_hook_source_branch=None):
2021
"""Push from self into target, and into target's master if any.
2023
This is on the base BzrBranch class even though it doesn't support
2024
bound branches because the *target* might be bound.
2027
if _override_hook_source_branch:
2028
result.source_branch = _override_hook_source_branch
2029
for hook in Branch.hooks['post_push']:
2032
bound_location = target.get_bound_location()
2033
if bound_location and target.base != bound_location:
2034
# there is a master branch.
2036
# XXX: Why the second check? Is it even supported for a branch to
2037
# be bound to itself? -- mbp 20070507
2038
master_branch = target.get_master_branch()
2039
master_branch.lock_write()
2041
# push into the master from this branch.
2042
self._basic_push(master_branch, overwrite, stop_revision)
2043
# and push into the target branch from this. Note that we push from
2044
# this branch again, because its considered the highest bandwidth
2046
result = self._basic_push(target, overwrite, stop_revision)
2047
result.master_branch = master_branch
2048
result.local_branch = target
2052
master_branch.unlock()
2055
result = self._basic_push(target, overwrite, stop_revision)
2056
# TODO: Why set master_branch and local_branch if there's no
2057
# binding? Maybe cleaner to just leave them unset? -- mbp
2059
result.master_branch = target
2060
result.local_branch = None
2064
def _basic_push(self, target, overwrite, stop_revision):
2065
"""Basic implementation of push without bound branches or hooks.
2067
Must be called with self read locked and target write locked.
2069
result = PushResult()
2070
result.source_branch = self
2071
result.target_branch = target
2072
result.old_revno, result.old_revid = target.last_revision_info()
2073
if result.old_revid != self.last_revision():
2074
# We assume that during 'push' this repository is closer than
2076
graph = self.repository.get_graph(target.repository)
2077
target.update_revisions(self, stop_revision, overwrite=overwrite,
2079
if self._push_should_merge_tags():
2080
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2081
result.new_revno, result.new_revid = target.last_revision_info()
2084
def get_parent(self):
2085
"""See Branch.get_parent."""
2086
parent = self._get_parent_location()
2089
# This is an old-format absolute path to a local branch
2090
# turn it into a url
2091
if parent.startswith('/'):
2092
parent = urlutils.local_path_to_url(parent.decode('utf8'))
2094
return urlutils.join(self.base[:-1], parent)
2095
except errors.InvalidURLJoin, e:
2096
raise errors.InaccessibleParent(parent, self.base)
2098
def get_stacked_on_url(self):
2099
raise errors.UnstackableBranchFormat(self._format, self.base)
2101
def set_push_location(self, location):
2102
"""See Branch.set_push_location."""
2103
self.get_config().set_user_option(
2104
'push_location', location,
2105
store=_mod_config.STORE_LOCATION_NORECURSE)
2108
def set_parent(self, url):
2109
"""See Branch.set_parent."""
2110
# TODO: Maybe delete old location files?
2111
# URLs should never be unicode, even on the local fs,
2112
# FIXUP this and get_parent in a future branch format bump:
2113
# read and rewrite the file. RBC 20060125
2115
if isinstance(url, unicode):
2117
url = url.encode('ascii')
2118
except UnicodeEncodeError:
2119
raise errors.InvalidURL(url,
2120
"Urls must be 7-bit ascii, "
2121
"use bzrlib.urlutils.escape")
2122
url = urlutils.relative_url(self.base, url)
2123
self._set_parent_location(url)
2125
def _set_parent_location(self, url):
2127
self._transport.delete('parent')
2129
self._transport.put_bytes('parent', url + '\n',
2130
mode=self.bzrdir._get_file_mode())
2132
def set_stacked_on_url(self, url):
2133
raise errors.UnstackableBranchFormat(self._format, self.base)
2136
class BzrBranch5(BzrBranch):
2137
"""A format 5 branch. This supports new features over plain branches.
2139
It has support for a master_branch which is the data for bound branches.
2143
def pull(self, source, overwrite=False, stop_revision=None,
2144
run_hooks=True, possible_transports=None,
2145
_override_hook_target=None):
2146
"""Pull from source into self, updating my master if any.
2148
:param run_hooks: Private parameter - if false, this branch
2149
is being called because it's the master of the primary branch,
2150
so it should not run its hooks.
2152
bound_location = self.get_bound_location()
2153
master_branch = None
2154
if bound_location and source.base != bound_location:
2155
# not pulling from master, so we need to update master.
2156
master_branch = self.get_master_branch(possible_transports)
2157
master_branch.lock_write()
2160
# pull from source into master.
2161
master_branch.pull(source, overwrite, stop_revision,
2163
return super(BzrBranch5, self).pull(source, overwrite,
2164
stop_revision, _hook_master=master_branch,
2165
run_hooks=run_hooks,
2166
_override_hook_target=_override_hook_target)
2169
master_branch.unlock()
2171
def get_bound_location(self):
2173
return self._transport.get_bytes('bound')[:-1]
2174
except errors.NoSuchFile:
2178
def get_master_branch(self, possible_transports=None):
2179
"""Return the branch we are bound to.
2181
:return: Either a Branch, or None
2183
This could memoise the branch, but if thats done
2184
it must be revalidated on each new lock.
2185
So for now we just don't memoise it.
2186
# RBC 20060304 review this decision.
2188
bound_loc = self.get_bound_location()
2192
return Branch.open(bound_loc,
2193
possible_transports=possible_transports)
2194
except (errors.NotBranchError, errors.ConnectionError), e:
2195
raise errors.BoundBranchConnectionFailure(
2199
def set_bound_location(self, location):
2200
"""Set the target where this branch is bound to.
2202
:param location: URL to the target branch
2205
self._transport.put_bytes('bound', location+'\n',
2206
mode=self.bzrdir._get_file_mode())
2209
self._transport.delete('bound')
2210
except errors.NoSuchFile:
2215
def bind(self, other):
2216
"""Bind this branch to the branch other.
2218
This does not push or pull data between the branches, though it does
2219
check for divergence to raise an error when the branches are not
2220
either the same, or one a prefix of the other. That behaviour may not
2221
be useful, so that check may be removed in future.
2223
:param other: The branch to bind to
2226
# TODO: jam 20051230 Consider checking if the target is bound
2227
# It is debatable whether you should be able to bind to
2228
# a branch which is itself bound.
2229
# Committing is obviously forbidden,
2230
# but binding itself may not be.
2231
# Since we *have* to check at commit time, we don't
2232
# *need* to check here
2234
# we want to raise diverged if:
2235
# last_rev is not in the other_last_rev history, AND
2236
# other_last_rev is not in our history, and do it without pulling
2238
self.set_bound_location(other.base)
2242
"""If bound, unbind"""
2243
return self.set_bound_location(None)
2246
def update(self, possible_transports=None):
2247
"""Synchronise this branch with the master branch if any.
2249
:return: None or the last_revision that was pivoted out during the
2252
master = self.get_master_branch(possible_transports)
2253
if master is not None:
2254
old_tip = _mod_revision.ensure_null(self.last_revision())
2255
self.pull(master, overwrite=True)
2256
if self.repository.get_graph().is_ancestor(old_tip,
2257
_mod_revision.ensure_null(self.last_revision())):
2263
class BzrBranch7(BzrBranch5):
2264
"""A branch with support for a fallback repository."""
2266
def _get_fallback_repository(self, url):
2267
"""Get the repository we fallback to at url."""
2268
url = urlutils.join(self.base, url)
2269
a_bzrdir = bzrdir.BzrDir.open(url,
2270
possible_transports=[self._transport])
2271
return a_bzrdir.open_branch().repository
2273
def _activate_fallback_location(self, url):
2274
"""Activate the branch/repository from url as a fallback repository."""
2275
self.repository.add_fallback_repository(
2276
self._get_fallback_repository(url))
2278
def _open_hook(self):
2280
url = self.get_stacked_on_url()
2281
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2282
errors.UnstackableBranchFormat):
2285
for hook in Branch.hooks['transform_fallback_location']:
2286
url = hook(self, url)
2288
hook_name = Branch.hooks.get_hook_name(hook)
2289
raise AssertionError(
2290
"'transform_fallback_location' hook %s returned "
2291
"None, not a URL." % hook_name)
2292
self._activate_fallback_location(url)
2294
def _check_stackable_repo(self):
2295
if not self.repository._format.supports_external_lookups:
2296
raise errors.UnstackableRepositoryFormat(self.repository._format,
2297
self.repository.base)
2299
def __init__(self, *args, **kwargs):
2300
super(BzrBranch7, self).__init__(*args, **kwargs)
2301
self._last_revision_info_cache = None
2302
self._partial_revision_history_cache = []
2304
def _clear_cached_state(self):
2305
super(BzrBranch7, self)._clear_cached_state()
2306
self._last_revision_info_cache = None
2307
self._partial_revision_history_cache = []
2309
def _last_revision_info(self):
2310
revision_string = self._transport.get_bytes('last-revision')
2311
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2312
revision_id = cache_utf8.get_cached_utf8(revision_id)
2314
return revno, revision_id
2316
def _write_last_revision_info(self, revno, revision_id):
2317
"""Simply write out the revision id, with no checks.
2319
Use set_last_revision_info to perform this safely.
2321
Does not update the revision_history cache.
2322
Intended to be called by set_last_revision_info and
2323
_write_revision_history.
2325
revision_id = _mod_revision.ensure_null(revision_id)
2326
out_string = '%d %s\n' % (revno, revision_id)
2327
self._transport.put_bytes('last-revision', out_string,
2328
mode=self.bzrdir._get_file_mode())
2331
def set_last_revision_info(self, revno, revision_id):
2332
revision_id = _mod_revision.ensure_null(revision_id)
2333
old_revno, old_revid = self.last_revision_info()
2334
if self._get_append_revisions_only():
2335
self._check_history_violation(revision_id)
2336
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2337
self._write_last_revision_info(revno, revision_id)
2338
self._clear_cached_state()
2339
self._last_revision_info_cache = revno, revision_id
2340
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2342
def _synchronize_history(self, destination, revision_id):
2343
"""Synchronize last revision and revision history between branches.
2345
:see: Branch._synchronize_history
2347
# XXX: The base Branch has a fast implementation of this method based
2348
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2349
# that uses set_revision_history. This class inherits from BzrBranch5,
2350
# but wants the fast implementation, so it calls
2351
# Branch._synchronize_history directly.
2352
Branch._synchronize_history(self, destination, revision_id)
2354
def _check_history_violation(self, revision_id):
2355
last_revision = _mod_revision.ensure_null(self.last_revision())
2356
if _mod_revision.is_null(last_revision):
2358
if last_revision not in self._lefthand_history(revision_id):
2359
raise errors.AppendRevisionsOnlyViolation(self.base)
2361
def _gen_revision_history(self):
2362
"""Generate the revision history from last revision
2364
last_revno, last_revision = self.last_revision_info()
2365
self._extend_partial_history(stop_index=last_revno-1)
2366
return list(reversed(self._partial_revision_history_cache))
2368
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2369
"""Extend the partial history to include a given index
2371
If a stop_index is supplied, stop when that index has been reached.
2372
If a stop_revision is supplied, stop when that revision is
2373
encountered. Otherwise, stop when the beginning of history is
2376
:param stop_index: The index which should be present. When it is
2377
present, history extension will stop.
2378
:param revision_id: The revision id which should be present. When
2379
it is encountered, history extension will stop.
2381
repo = self.repository
2382
if len(self._partial_revision_history_cache) == 0:
2383
iterator = repo.iter_reverse_revision_history(self.last_revision())
2385
start_revision = self._partial_revision_history_cache[-1]
2386
iterator = repo.iter_reverse_revision_history(start_revision)
2387
#skip the last revision in the list
2388
next_revision = iterator.next()
2389
for revision_id in iterator:
2390
self._partial_revision_history_cache.append(revision_id)
2391
if (stop_index is not None and
2392
len(self._partial_revision_history_cache) > stop_index):
2394
if revision_id == stop_revision:
2397
def _write_revision_history(self, history):
2398
"""Factored out of set_revision_history.
2400
This performs the actual writing to disk, with format-specific checks.
2401
It is intended to be called by BzrBranch5.set_revision_history.
2403
if len(history) == 0:
2404
last_revision = 'null:'
2406
if history != self._lefthand_history(history[-1]):
2407
raise errors.NotLefthandHistory(history)
2408
last_revision = history[-1]
2409
if self._get_append_revisions_only():
2410
self._check_history_violation(last_revision)
2411
self._write_last_revision_info(len(history), last_revision)
2414
def _set_parent_location(self, url):
2415
"""Set the parent branch"""
2416
self._set_config_location('parent_location', url, make_relative=True)
2419
def _get_parent_location(self):
2420
"""Set the parent branch"""
2421
return self._get_config_location('parent_location')
2423
def set_push_location(self, location):
2424
"""See Branch.set_push_location."""
2425
self._set_config_location('push_location', location)
2427
def set_bound_location(self, location):
2428
"""See Branch.set_push_location."""
2430
config = self.get_config()
2431
if location is None:
2432
if config.get_user_option('bound') != 'True':
2435
config.set_user_option('bound', 'False', warn_masked=True)
2438
self._set_config_location('bound_location', location,
2440
config.set_user_option('bound', 'True', warn_masked=True)
2443
def _get_bound_location(self, bound):
2444
"""Return the bound location in the config file.
2446
Return None if the bound parameter does not match"""
2447
config = self.get_config()
2448
config_bound = (config.get_user_option('bound') == 'True')
2449
if config_bound != bound:
2451
return self._get_config_location('bound_location', config=config)
2453
def get_bound_location(self):
2454
"""See Branch.set_push_location."""
2455
return self._get_bound_location(True)
2457
def get_old_bound_location(self):
2458
"""See Branch.get_old_bound_location"""
2459
return self._get_bound_location(False)
2461
def get_stacked_on_url(self):
2462
# you can always ask for the URL; but you might not be able to use it
2463
# if the repo can't support stacking.
2464
## self._check_stackable_repo()
2465
stacked_url = self._get_config_location('stacked_on_location')
2466
if stacked_url is None:
2467
raise errors.NotStacked(self)
2470
def set_append_revisions_only(self, enabled):
2475
self.get_config().set_user_option('append_revisions_only', value,
2478
def set_stacked_on_url(self, url):
2479
self._check_stackable_repo()
2482
old_url = self.get_stacked_on_url()
2483
except (errors.NotStacked, errors.UnstackableBranchFormat,
2484
errors.UnstackableRepositoryFormat):
2487
# repositories don't offer an interface to remove fallback
2488
# repositories today; take the conceptually simpler option and just
2490
self.repository = self.bzrdir.find_repository()
2491
# for every revision reference the branch has, ensure it is pulled
2493
source_repository = self._get_fallback_repository(old_url)
2494
for revision_id in chain([self.last_revision()],
2495
self.tags.get_reverse_tag_dict()):
2496
self.repository.fetch(source_repository, revision_id,
2499
self._activate_fallback_location(url)
2500
# write this out after the repository is stacked to avoid setting a
2501
# stacked config that doesn't work.
2502
self._set_config_location('stacked_on_location', url)
2504
def _get_append_revisions_only(self):
2505
value = self.get_config().get_user_option('append_revisions_only')
2506
return value == 'True'
2508
def _make_tags(self):
2509
return BasicTags(self)
2512
def generate_revision_history(self, revision_id, last_rev=None,
2514
"""See BzrBranch5.generate_revision_history"""
2515
history = self._lefthand_history(revision_id, last_rev, other_branch)
2516
revno = len(history)
2517
self.set_last_revision_info(revno, revision_id)
2520
def get_rev_id(self, revno, history=None):
2521
"""Find the revision id of the specified revno."""
2523
return _mod_revision.NULL_REVISION
2525
last_revno, last_revision_id = self.last_revision_info()
2526
if revno <= 0 or revno > last_revno:
2527
raise errors.NoSuchRevision(self, revno)
2529
if history is not None:
2530
return history[revno - 1]
2532
index = last_revno - revno
2533
if len(self._partial_revision_history_cache) <= index:
2534
self._extend_partial_history(stop_index=index)
2535
if len(self._partial_revision_history_cache) > index:
2536
return self._partial_revision_history_cache[index]
2538
raise errors.NoSuchRevision(self, revno)
2541
def revision_id_to_revno(self, revision_id):
2542
"""Given a revision id, return its revno"""
2543
if _mod_revision.is_null(revision_id):
2546
index = self._partial_revision_history_cache.index(revision_id)
2548
self._extend_partial_history(stop_revision=revision_id)
2549
index = len(self._partial_revision_history_cache) - 1
2550
if self._partial_revision_history_cache[index] != revision_id:
2551
raise errors.NoSuchRevision(self, revision_id)
2552
return self.revno() - index
2555
class BzrBranch6(BzrBranch7):
2556
"""See BzrBranchFormat6 for the capabilities of this branch.
2558
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2562
def get_stacked_on_url(self):
2563
raise errors.UnstackableBranchFormat(self._format, self.base)
2565
def set_stacked_on_url(self, url):
2566
raise errors.UnstackableBranchFormat(self._format, self.base)
2569
######################################################################
2570
# results of operations
2573
class _Result(object):
2575
def _show_tag_conficts(self, to_file):
2576
if not getattr(self, 'tag_conflicts', None):
2578
to_file.write('Conflicting tags:\n')
2579
for name, value1, value2 in self.tag_conflicts:
2580
to_file.write(' %s\n' % (name, ))
2583
class PullResult(_Result):
2584
"""Result of a Branch.pull operation.
2586
:ivar old_revno: Revision number before pull.
2587
:ivar new_revno: Revision number after pull.
2588
:ivar old_revid: Tip revision id before pull.
2589
:ivar new_revid: Tip revision id after pull.
2590
:ivar source_branch: Source (local) branch object.
2591
:ivar master_branch: Master branch of the target, or the target if no
2593
:ivar local_branch: target branch if there is a Master, else None
2594
:ivar target_branch: Target/destination branch object.
2595
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2599
# DEPRECATED: pull used to return the change in revno
2600
return self.new_revno - self.old_revno
2602
def report(self, to_file):
2604
if self.old_revid == self.new_revid:
2605
to_file.write('No revisions to pull.\n')
2607
to_file.write('Now on revision %d.\n' % self.new_revno)
2608
self._show_tag_conficts(to_file)
2611
class PushResult(_Result):
2612
"""Result of a Branch.push operation.
2614
:ivar old_revno: Revision number before push.
2615
:ivar new_revno: Revision number after push.
2616
:ivar old_revid: Tip revision id before push.
2617
:ivar new_revid: Tip revision id after push.
2618
:ivar source_branch: Source branch object.
2619
:ivar master_branch: Master branch of the target, or None.
2620
:ivar target_branch: Target/destination branch object.
2624
# DEPRECATED: push used to return the change in revno
2625
return self.new_revno - self.old_revno
2627
def report(self, to_file):
2628
"""Write a human-readable description of the result."""
2629
if self.old_revid == self.new_revid:
2630
note('No new revisions to push.')
2632
note('Pushed up to revision %d.' % self.new_revno)
2633
self._show_tag_conficts(to_file)
2636
class BranchCheckResult(object):
2637
"""Results of checking branch consistency.
2642
def __init__(self, branch):
2643
self.branch = branch
2645
def report_results(self, verbose):
2646
"""Report the check results via trace.note.
2648
:param verbose: Requests more detailed display of what was checked,
2651
note('checked branch %s format %s',
2653
self.branch._format)
2656
class Converter5to6(object):
2657
"""Perform an in-place upgrade of format 5 to format 6"""
2659
def convert(self, branch):
2660
# Data for 5 and 6 can peacefully coexist.
2661
format = BzrBranchFormat6()
2662
new_branch = format.open(branch.bzrdir, _found=True)
2664
# Copy source data into target
2665
new_branch._write_last_revision_info(*branch.last_revision_info())
2666
new_branch.set_parent(branch.get_parent())
2667
new_branch.set_bound_location(branch.get_bound_location())
2668
new_branch.set_push_location(branch.get_push_location())
2670
# New branch has no tags by default
2671
new_branch.tags._set_tag_dict({})
2673
# Copying done; now update target format
2674
new_branch._transport.put_bytes('format',
2675
format.get_format_string(),
2676
mode=new_branch.bzrdir._get_file_mode())
2678
# Clean up old files
2679
new_branch._transport.delete('revision-history')
2681
branch.set_parent(None)
2682
except errors.NoSuchFile:
2684
branch.set_bound_location(None)
2687
class Converter6to7(object):
2688
"""Perform an in-place upgrade of format 6 to format 7"""
2690
def convert(self, branch):
2691
format = BzrBranchFormat7()
2692
branch._set_config_location('stacked_on_location', '')
2693
# update target format
2694
branch._transport.put_bytes('format', format.get_format_string())
2698
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2699
"""Run ``callable(*args, **kwargs)``, write-locking target for the
2702
_run_with_write_locked_target will attempt to release the lock it acquires.
2704
If an exception is raised by callable, then that exception *will* be
2705
propagated, even if the unlock attempt raises its own error. Thus
2706
_run_with_write_locked_target should be preferred to simply doing::
2710
return callable(*args, **kwargs)
2715
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
2716
# should share code?
2719
result = callable(*args, **kwargs)
2721
exc_info = sys.exc_info()
2725
raise exc_info[0], exc_info[1], exc_info[2]
2731
class InterBranch(InterObject):
2732
"""This class represents operations taking place between two branches.
2734
Its instances have methods like pull() and push() and contain
2735
references to the source and target repositories these operations
2736
can be carried out on.
2740
"""The available optimised InterBranch types."""
2743
def _get_branch_formats_to_test():
2744
"""Return a tuple with the Branch formats to use when testing."""
2745
raise NotImplementedError(self._get_branch_formats_to_test)
2747
def update_revisions(self, stop_revision=None, overwrite=False,
2749
"""Pull in new perfect-fit revisions.
2751
:param stop_revision: Updated until the given revision
2752
:param overwrite: Always set the branch pointer, rather than checking
2753
to see if it is a proper descendant.
2754
:param graph: A Graph object that can be used to query history
2755
information. This can be None.
2758
raise NotImplementedError(self.update_revisions)
2761
class GenericInterBranch(InterBranch):
2762
"""InterBranch implementation that uses public Branch functions.
2766
def _get_branch_formats_to_test():
2767
return BranchFormat._default_format, BranchFormat._default_format
2769
def update_revisions(self, stop_revision=None, overwrite=False,
2771
"""See InterBranch.update_revisions()."""
2772
self.source.lock_read()
2774
other_revno, other_last_revision = self.source.last_revision_info()
2775
stop_revno = None # unknown
2776
if stop_revision is None:
2777
stop_revision = other_last_revision
2778
if _mod_revision.is_null(stop_revision):
2779
# if there are no commits, we're done.
2781
stop_revno = other_revno
2783
# what's the current last revision, before we fetch [and change it
2785
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2786
# we fetch here so that we don't process data twice in the common
2787
# case of having something to pull, and so that the check for
2788
# already merged can operate on the just fetched graph, which will
2789
# be cached in memory.
2790
self.target.fetch(self.source, stop_revision)
2791
# Check to see if one is an ancestor of the other
2794
graph = self.target.repository.get_graph()
2795
if self.target._check_if_descendant_or_diverged(
2796
stop_revision, last_rev, graph, self.source):
2797
# stop_revision is a descendant of last_rev, but we aren't
2798
# overwriting, so we're done.
2800
if stop_revno is None:
2802
graph = self.target.repository.get_graph()
2803
this_revno, this_last_revision = \
2804
self.target.last_revision_info()
2805
stop_revno = graph.find_distance_to_null(stop_revision,
2806
[(other_last_revision, other_revno),
2807
(this_last_revision, this_revno)])
2808
self.target.set_last_revision_info(stop_revno, stop_revision)
2810
self.source.unlock()
2813
def is_compatible(self, source, target):
2814
# GenericBranch uses the public API, so always compatible
2818
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
