13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from copy import deepcopy
18
19
from cStringIO import StringIO
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from itertools import chain
27
config as _mod_config,
35
revision as _mod_revision,
43
from bzrlib.config import BranchConfig, TransportConfig
44
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
45
from bzrlib.tag import (
51
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
52
from bzrlib.hooks import HookPoint, Hooks
53
from bzrlib.inter import InterObject
54
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
55
from bzrlib import registry
56
from bzrlib.symbol_versioning import (
60
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
20
from unittest import TestSuite
21
from warnings import warn
24
from bzrlib import bzrdir, errors, lockdir, osutils, revision, \
28
from bzrlib.config import TreeConfig
29
from bzrlib.decorators import needs_read_lock, needs_write_lock
30
import bzrlib.errors as errors
31
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
32
HistoryMissing, InvalidRevisionId,
33
InvalidRevisionNumber, LockError, NoSuchFile,
34
NoSuchRevision, NoWorkingTree, NotVersionedError,
35
NotBranchError, UninitializableFormat,
36
UnlistableStore, UnlistableBranch,
38
from bzrlib.lockable_files import LockableFiles, TransportLock
39
from bzrlib.symbol_versioning import (deprecated_function,
43
zero_eight, zero_nine,
45
from bzrlib.trace import mutter, note
63
48
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
64
49
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
65
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
68
class Branch(controldir.ControlComponent):
50
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
53
# TODO: Maybe include checks for common corruption of newlines, etc?
55
# TODO: Some operations like log might retrieve the same revisions
56
# repeatedly to calculate deltas. We could perhaps have a weakref
57
# cache in memory to make this faster. In general anything can be
58
# cached in memory between lock and unlock operations. .. nb thats
59
# what the transaction identity map provides
62
######################################################################
69
66
"""Branch holding a history of revisions.
72
Base directory/url of the branch; using control_url and
73
control_transport is more standardized.
75
hooks: An instance of BranchHooks.
69
Base directory/url of the branch.
77
71
# this is really an instance variable - FIXME move it there
82
def control_transport(self):
83
return self._transport
86
def user_transport(self):
87
return self.bzrdir.user_transport
89
75
def __init__(self, *ignored, **ignored_too):
90
self.tags = self._format.make_tags(self)
91
self._revision_history_cache = None
92
self._revision_id_to_revno_cache = None
93
self._partial_revision_id_to_revno_cache = {}
94
self._partial_revision_history_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 _activate_fallback_location(self, url):
106
"""Activate the branch/repository from url as a fallback repository."""
107
repo = self._get_fallback_repository(url)
108
if repo.has_same_location(self.repository):
109
raise errors.UnstackableLocationError(self.user_url, url)
110
self.repository.add_fallback_repository(repo)
76
raise NotImplementedError('The Branch class is abstract')
112
78
def break_lock(self):
113
79
"""Break a lock if one is present from another instance.
123
89
if master is not None:
124
90
master.break_lock()
126
def _check_stackable_repo(self):
127
if not self.repository._format.supports_external_lookups:
128
raise errors.UnstackableRepositoryFormat(self.repository._format,
129
self.repository.base)
131
def _extend_partial_history(self, stop_index=None, stop_revision=None):
132
"""Extend the partial history to include a given index
134
If a stop_index is supplied, stop when that index has been reached.
135
If a stop_revision is supplied, stop when that revision is
136
encountered. Otherwise, stop when the beginning of history is
139
:param stop_index: The index which should be present. When it is
140
present, history extension will stop.
141
:param stop_revision: The revision id which should be present. When
142
it is encountered, history extension will stop.
144
if len(self._partial_revision_history_cache) == 0:
145
self._partial_revision_history_cache = [self.last_revision()]
146
repository._iter_for_revno(
147
self.repository, self._partial_revision_history_cache,
148
stop_index=stop_index, stop_revision=stop_revision)
149
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
150
self._partial_revision_history_cache.pop()
152
def _get_check_refs(self):
153
"""Get the references needed for check().
157
revid = self.last_revision()
158
return [('revision-existence', revid), ('lefthand-distance', revid)]
161
def open(base, _unsupported=False, possible_transports=None):
93
@deprecated_method(zero_eight)
94
def open_downlevel(base):
95
"""Open a branch which may be of an old format."""
96
return Branch.open(base, _unsupported=True)
99
def open(base, _unsupported=False):
162
100
"""Open the branch rooted at base.
164
102
For instance, if the branch is at URL/.bzr/branch,
165
103
Branch.open(URL) -> a Branch instance.
167
control = bzrdir.BzrDir.open(base, _unsupported,
168
possible_transports=possible_transports)
169
return control.open_branch(unsupported=_unsupported)
172
def open_from_transport(transport, name=None, _unsupported=False):
173
"""Open the branch rooted at transport"""
174
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
175
return control.open_branch(name=name, unsupported=_unsupported)
178
def open_containing(url, possible_transports=None):
105
control = bzrdir.BzrDir.open(base, _unsupported)
106
return control.open_branch(_unsupported)
109
def open_containing(url):
179
110
"""Open an existing branch which contains url.
181
112
This probes for a branch at url, and searches upwards from there.
183
114
Basically we keep looking up until we find the control directory or
184
115
run into the root. If there isn't one, raises NotBranchError.
185
If there is one and it is either an unrecognised format or an unsupported
116
If there is one and it is either an unrecognised format or an unsupported
186
117
format, UnknownFormatError or UnsupportedFormatError are raised.
187
118
If there is one, it is returned, along with the unused portion of url.
189
control, relpath = bzrdir.BzrDir.open_containing(url,
120
control, relpath = bzrdir.BzrDir.open_containing(url)
191
121
return control.open_branch(), relpath
193
def _push_should_merge_tags(self):
194
"""Should _basic_push merge this branch's tags into the target?
196
The default implementation returns False if this branch has no tags,
197
and True the rest of the time. Subclasses may override this.
199
return self.supports_tags() and self.tags.get_tag_dict()
124
@deprecated_function(zero_eight)
125
def initialize(base):
126
"""Create a new working tree and branch, rooted at 'base' (url)
128
NOTE: This will soon be deprecated in favour of creation
131
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
133
def setup_caching(self, cache_root):
134
"""Subclasses that care about caching should override this, and set
135
up cached stores located under cache_root.
137
# seems to be unused, 2006-01-13 mbp
138
warn('%s is deprecated' % self.setup_caching)
139
self.cache_root = cache_root
201
141
def get_config(self):
202
"""Get a bzrlib.config.BranchConfig for this Branch.
204
This can then be used to get and set configuration options for the
207
:return: A bzrlib.config.BranchConfig.
209
return BranchConfig(self)
211
def _get_config(self):
212
"""Get the concrete config for just the config in this branch.
214
This is not intended for client use; see Branch.get_config for the
219
:return: An object supporting get_option and set_option.
221
raise NotImplementedError(self._get_config)
223
def _get_fallback_repository(self, url):
224
"""Get the repository we fallback to at url."""
225
url = urlutils.join(self.base, url)
226
a_branch = Branch.open(url,
227
possible_transports=[self.bzrdir.root_transport])
228
return a_branch.repository
230
def _get_tags_bytes(self):
231
"""Get the bytes of a serialised tags dict.
233
Note that not all branches support tags, nor do all use the same tags
234
logic: this method is specific to BasicTags. Other tag implementations
235
may use the same method name and behave differently, safely, because
236
of the double-dispatch via
237
format.make_tags->tags_instance->get_tags_dict.
239
:return: The bytes of the tags file.
240
:seealso: Branch._set_tags_bytes.
242
return self._transport.get_bytes('tags')
244
def _get_nick(self, local=False, possible_transports=None):
245
config = self.get_config()
246
# explicit overrides master, but don't look for master if local is True
247
if not local and not config.has_explicit_nickname():
249
master = self.get_master_branch(possible_transports)
250
if master and self.user_url == master.user_url:
251
raise errors.RecursiveBind(self.user_url)
252
if master is not None:
253
# return the master branch value
255
except errors.RecursiveBind, e:
257
except errors.BzrError, e:
258
# Silently fall back to local implicit nick if the master is
260
mutter("Could not connect to bound branch, "
261
"falling back to local nick.\n " + str(e))
262
return config.get_nickname()
142
return bzrlib.config.BranchConfig(self)
145
return self.get_config().get_nickname()
264
147
def _set_nick(self, nick):
265
self.get_config().set_user_option('nickname', nick, warn_masked=True)
148
self.get_config().set_user_option('nickname', nick)
267
150
nick = property(_get_nick, _set_nick)
269
152
def is_locked(self):
270
raise NotImplementedError(self.is_locked)
272
def _lefthand_history(self, revision_id, last_rev=None,
274
if 'evil' in debug.debug_flags:
275
mutter_callsite(4, "_lefthand_history scales with history.")
276
# stop_revision must be a descendant of last_revision
277
graph = self.repository.get_graph()
278
if last_rev is not None:
279
if not graph.is_ancestor(last_rev, revision_id):
280
# our previous tip is not merged into stop_revision
281
raise errors.DivergedBranches(self, other_branch)
282
# make a new revision history from the graph
283
parents_map = graph.get_parent_map([revision_id])
284
if revision_id not in parents_map:
285
raise errors.NoSuchRevision(self, revision_id)
286
current_rev_id = revision_id
288
check_not_reserved_id = _mod_revision.check_not_reserved_id
289
# Do not include ghosts or graph origin in revision_history
290
while (current_rev_id in parents_map and
291
len(parents_map[current_rev_id]) > 0):
292
check_not_reserved_id(current_rev_id)
293
new_history.append(current_rev_id)
294
current_rev_id = parents_map[current_rev_id][0]
295
parents_map = graph.get_parent_map([current_rev_id])
296
new_history.reverse()
299
def lock_write(self, token=None):
300
"""Lock the branch for write operations.
302
:param token: A token to permit reacquiring a previously held and
304
:return: A BranchWriteLockResult.
306
raise NotImplementedError(self.lock_write)
153
raise NotImplementedError('is_locked is abstract')
155
def lock_write(self):
156
raise NotImplementedError('lock_write is abstract')
308
158
def lock_read(self):
309
"""Lock the branch for read operations.
311
:return: A bzrlib.lock.LogicalLockResult.
313
raise NotImplementedError(self.lock_read)
159
raise NotImplementedError('lock_read is abstract')
315
161
def unlock(self):
316
raise NotImplementedError(self.unlock)
162
raise NotImplementedError('unlock is abstract')
318
164
def peek_lock_mode(self):
319
165
"""Return lock mode for the Branch: 'r', 'w' or None"""
320
166
raise NotImplementedError(self.peek_lock_mode)
322
168
def get_physical_lock_status(self):
323
raise NotImplementedError(self.get_physical_lock_status)
326
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
327
"""Return the revision_id for a dotted revno.
329
:param revno: a tuple like (1,) or (1,1,2)
330
:param _cache_reverse: a private parameter enabling storage
331
of the reverse mapping in a top level cache. (This should
332
only be done in selective circumstances as we want to
333
avoid having the mapping cached multiple times.)
334
:return: the revision_id
335
:raises errors.NoSuchRevision: if the revno doesn't exist
337
rev_id = self._do_dotted_revno_to_revision_id(revno)
339
self._partial_revision_id_to_revno_cache[rev_id] = revno
342
def _do_dotted_revno_to_revision_id(self, revno):
343
"""Worker function for dotted_revno_to_revision_id.
345
Subclasses should override this if they wish to
346
provide a more efficient implementation.
349
return self.get_rev_id(revno[0])
350
revision_id_to_revno = self.get_revision_id_to_revno_map()
351
revision_ids = [revision_id for revision_id, this_revno
352
in revision_id_to_revno.iteritems()
353
if revno == this_revno]
354
if len(revision_ids) == 1:
355
return revision_ids[0]
357
revno_str = '.'.join(map(str, revno))
358
raise errors.NoSuchRevision(self, revno_str)
361
def revision_id_to_dotted_revno(self, revision_id):
362
"""Given a revision id, return its dotted revno.
364
:return: a tuple like (1,) or (400,1,3).
366
return self._do_revision_id_to_dotted_revno(revision_id)
368
def _do_revision_id_to_dotted_revno(self, revision_id):
369
"""Worker function for revision_id_to_revno."""
370
# Try the caches if they are loaded
371
result = self._partial_revision_id_to_revno_cache.get(revision_id)
372
if result is not None:
374
if self._revision_id_to_revno_cache:
375
result = self._revision_id_to_revno_cache.get(revision_id)
377
raise errors.NoSuchRevision(self, revision_id)
378
# Try the mainline as it's optimised
380
revno = self.revision_id_to_revno(revision_id)
382
except errors.NoSuchRevision:
383
# We need to load and use the full revno map after all
384
result = self.get_revision_id_to_revno_map().get(revision_id)
386
raise errors.NoSuchRevision(self, revision_id)
390
def get_revision_id_to_revno_map(self):
391
"""Return the revision_id => dotted revno map.
393
This will be regenerated on demand, but will be cached.
395
:return: A dictionary mapping revision_id => dotted revno.
396
This dictionary should not be modified by the caller.
398
if self._revision_id_to_revno_cache is not None:
399
mapping = self._revision_id_to_revno_cache
401
mapping = self._gen_revno_map()
402
self._cache_revision_id_to_revno(mapping)
403
# TODO: jam 20070417 Since this is being cached, should we be returning
405
# I would rather not, and instead just declare that users should not
406
# modify the return value.
409
def _gen_revno_map(self):
410
"""Create a new mapping from revision ids to dotted revnos.
412
Dotted revnos are generated based on the current tip in the revision
414
This is the worker function for get_revision_id_to_revno_map, which
415
just caches the return value.
417
:return: A dictionary mapping revision_id => dotted revno.
419
revision_id_to_revno = dict((rev_id, revno)
420
for rev_id, depth, revno, end_of_merge
421
in self.iter_merge_sorted_revisions())
422
return revision_id_to_revno
425
def iter_merge_sorted_revisions(self, start_revision_id=None,
426
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
427
"""Walk the revisions for a branch in merge sorted order.
429
Merge sorted order is the output from a merge-aware,
430
topological sort, i.e. all parents come before their
431
children going forward; the opposite for reverse.
433
:param start_revision_id: the revision_id to begin walking from.
434
If None, the branch tip is used.
435
:param stop_revision_id: the revision_id to terminate the walk
436
after. If None, the rest of history is included.
437
:param stop_rule: if stop_revision_id is not None, the precise rule
438
to use for termination:
439
* 'exclude' - leave the stop revision out of the result (default)
440
* 'include' - the stop revision is the last item in the result
441
* 'with-merges' - include the stop revision and all of its
442
merged revisions in the result
443
* 'with-merges-without-common-ancestry' - filter out revisions
444
that are in both ancestries
445
:param direction: either 'reverse' or 'forward':
446
* reverse means return the start_revision_id first, i.e.
447
start at the most recent revision and go backwards in history
448
* forward returns tuples in the opposite order to reverse.
449
Note in particular that forward does *not* do any intelligent
450
ordering w.r.t. depth as some clients of this API may like.
451
(If required, that ought to be done at higher layers.)
453
:return: an iterator over (revision_id, depth, revno, end_of_merge)
456
* revision_id: the unique id of the revision
457
* depth: How many levels of merging deep this node has been
459
* revno_sequence: This field provides a sequence of
460
revision numbers for all revisions. The format is:
461
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
462
branch that the revno is on. From left to right the REVNO numbers
463
are the sequence numbers within that branch of the revision.
464
* end_of_merge: When True the next node (earlier in history) is
465
part of a different merge.
467
# Note: depth and revno values are in the context of the branch so
468
# we need the full graph to get stable numbers, regardless of the
470
if self._merge_sorted_revisions_cache is None:
471
last_revision = self.last_revision()
472
known_graph = self.repository.get_known_graph_ancestry(
474
self._merge_sorted_revisions_cache = known_graph.merge_sort(
476
filtered = self._filter_merge_sorted_revisions(
477
self._merge_sorted_revisions_cache, start_revision_id,
478
stop_revision_id, stop_rule)
479
# Make sure we don't return revisions that are not part of the
480
# start_revision_id ancestry.
481
filtered = self._filter_start_non_ancestors(filtered)
482
if direction == 'reverse':
484
if direction == 'forward':
485
return reversed(list(filtered))
487
raise ValueError('invalid direction %r' % direction)
489
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
490
start_revision_id, stop_revision_id, stop_rule):
491
"""Iterate over an inclusive range of sorted revisions."""
492
rev_iter = iter(merge_sorted_revisions)
493
if start_revision_id is not None:
494
for node in rev_iter:
495
rev_id = node.key[-1]
496
if rev_id != start_revision_id:
499
# The decision to include the start or not
500
# depends on the stop_rule if a stop is provided
501
# so pop this node back into the iterator
502
rev_iter = chain(iter([node]), rev_iter)
504
if stop_revision_id is None:
506
for node in rev_iter:
507
rev_id = node.key[-1]
508
yield (rev_id, node.merge_depth, node.revno,
510
elif stop_rule == 'exclude':
511
for node in rev_iter:
512
rev_id = node.key[-1]
513
if rev_id == stop_revision_id:
515
yield (rev_id, node.merge_depth, node.revno,
517
elif stop_rule == 'include':
518
for node in rev_iter:
519
rev_id = node.key[-1]
520
yield (rev_id, node.merge_depth, node.revno,
522
if rev_id == stop_revision_id:
524
elif stop_rule == 'with-merges-without-common-ancestry':
525
# We want to exclude all revisions that are already part of the
526
# stop_revision_id ancestry.
527
graph = self.repository.get_graph()
528
ancestors = graph.find_unique_ancestors(start_revision_id,
530
for node in rev_iter:
531
rev_id = node.key[-1]
532
if rev_id not in ancestors:
534
yield (rev_id, node.merge_depth, node.revno,
536
elif stop_rule == 'with-merges':
537
stop_rev = self.repository.get_revision(stop_revision_id)
538
if stop_rev.parent_ids:
539
left_parent = stop_rev.parent_ids[0]
541
left_parent = _mod_revision.NULL_REVISION
542
# left_parent is the actual revision we want to stop logging at,
543
# since we want to show the merged revisions after the stop_rev too
544
reached_stop_revision_id = False
545
revision_id_whitelist = []
546
for node in rev_iter:
547
rev_id = node.key[-1]
548
if rev_id == left_parent:
549
# reached the left parent after the stop_revision
551
if (not reached_stop_revision_id or
552
rev_id in revision_id_whitelist):
553
yield (rev_id, node.merge_depth, node.revno,
555
if reached_stop_revision_id or rev_id == stop_revision_id:
556
# only do the merged revs of rev_id from now on
557
rev = self.repository.get_revision(rev_id)
559
reached_stop_revision_id = True
560
revision_id_whitelist.extend(rev.parent_ids)
562
raise ValueError('invalid stop_rule %r' % stop_rule)
564
def _filter_start_non_ancestors(self, rev_iter):
565
# If we started from a dotted revno, we want to consider it as a tip
566
# and don't want to yield revisions that are not part of its
567
# ancestry. Given the order guaranteed by the merge sort, we will see
568
# uninteresting descendants of the first parent of our tip before the
570
first = rev_iter.next()
571
(rev_id, merge_depth, revno, end_of_merge) = first
574
# We start at a mainline revision so by definition, all others
575
# revisions in rev_iter are ancestors
576
for node in rev_iter:
581
pmap = self.repository.get_parent_map([rev_id])
582
parents = pmap.get(rev_id, [])
584
whitelist.update(parents)
586
# If there is no parents, there is nothing of interest left
588
# FIXME: It's hard to test this scenario here as this code is never
589
# called in that case. -- vila 20100322
592
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
594
if rev_id in whitelist:
595
pmap = self.repository.get_parent_map([rev_id])
596
parents = pmap.get(rev_id, [])
597
whitelist.remove(rev_id)
598
whitelist.update(parents)
600
# We've reached the mainline, there is nothing left to
604
# A revision that is not part of the ancestry of our
607
yield (rev_id, merge_depth, revno, end_of_merge)
609
def leave_lock_in_place(self):
610
"""Tell this branch object not to release the physical lock when this
613
If lock_write doesn't return a token, then this method is not supported.
615
self.control_files.leave_in_place()
617
def dont_leave_lock_in_place(self):
618
"""Tell this branch object to release the physical lock when this
619
object is unlocked, even if it didn't originally acquire it.
621
If lock_write doesn't return a token, then this method is not supported.
623
self.control_files.dont_leave_in_place()
169
raise NotImplementedError('get_physical_lock_status is abstract')
171
def abspath(self, name):
172
"""Return absolute filename for something in the branch
174
XXX: Robert Collins 20051017 what is this used for? why is it a branch
175
method and not a tree method.
177
raise NotImplementedError('abspath is abstract')
625
179
def bind(self, other):
626
180
"""Bind the local branch the other branch.
721
263
The delta is relative to its mainline predecessor, or the
722
264
empty tree for revision 1.
266
assert isinstance(revno, int)
724
267
rh = self.revision_history()
725
268
if not (1 <= revno <= len(rh)):
726
raise errors.InvalidRevisionNumber(revno)
269
raise InvalidRevisionNumber(revno)
727
270
return self.repository.get_revision_delta(rh[revno-1])
729
def get_stacked_on_url(self):
730
"""Get the URL this branch is stacked against.
732
:raises NotStacked: If the branch is not stacked.
733
:raises UnstackableBranchFormat: If the branch does not support
736
raise NotImplementedError(self.get_stacked_on_url)
272
def get_root_id(self):
273
"""Return the id of this branches root"""
274
raise NotImplementedError('get_root_id is abstract')
738
276
def print_file(self, file, revision_id):
739
277
"""Print `file` to stdout."""
740
raise NotImplementedError(self.print_file)
278
raise NotImplementedError('print_file is abstract')
280
def append_revision(self, *revision_ids):
281
raise NotImplementedError('append_revision is abstract')
742
283
def set_revision_history(self, rev_history):
743
raise NotImplementedError(self.set_revision_history)
746
def set_parent(self, url):
747
"""See Branch.set_parent."""
748
# TODO: Maybe delete old location files?
749
# URLs should never be unicode, even on the local fs,
750
# FIXUP this and get_parent in a future branch format bump:
751
# read and rewrite the file. RBC 20060125
753
if isinstance(url, unicode):
755
url = url.encode('ascii')
756
except UnicodeEncodeError:
757
raise errors.InvalidURL(url,
758
"Urls must be 7-bit ascii, "
759
"use bzrlib.urlutils.escape")
760
url = urlutils.relative_url(self.base, url)
761
self._set_parent_location(url)
764
def set_stacked_on_url(self, url):
765
"""Set the URL this branch is stacked against.
767
:raises UnstackableBranchFormat: If the branch does not support
769
:raises UnstackableRepositoryFormat: If the repository does not support
772
if not self._format.supports_stacking():
773
raise errors.UnstackableBranchFormat(self._format, self.user_url)
774
# XXX: Changing from one fallback repository to another does not check
775
# that all the data you need is present in the new fallback.
776
# Possibly it should.
777
self._check_stackable_repo()
780
old_url = self.get_stacked_on_url()
781
except (errors.NotStacked, errors.UnstackableBranchFormat,
782
errors.UnstackableRepositoryFormat):
786
self._activate_fallback_location(url)
787
# write this out after the repository is stacked to avoid setting a
788
# stacked config that doesn't work.
789
self._set_config_location('stacked_on_location', url)
792
"""Change a branch to be unstacked, copying data as needed.
794
Don't call this directly, use set_stacked_on_url(None).
796
pb = ui.ui_factory.nested_progress_bar()
798
pb.update("Unstacking")
799
# The basic approach here is to fetch the tip of the branch,
800
# including all available ghosts, from the existing stacked
801
# repository into a new repository object without the fallbacks.
803
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
804
# correct for CHKMap repostiories
805
old_repository = self.repository
806
if len(old_repository._fallback_repositories) != 1:
807
raise AssertionError("can't cope with fallback repositories "
808
"of %r" % (self.repository,))
809
# Open the new repository object.
810
# Repositories don't offer an interface to remove fallback
811
# repositories today; take the conceptually simpler option and just
812
# reopen it. We reopen it starting from the URL so that we
813
# get a separate connection for RemoteRepositories and can
814
# stream from one of them to the other. This does mean doing
815
# separate SSH connection setup, but unstacking is not a
816
# common operation so it's tolerable.
817
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
818
new_repository = new_bzrdir.find_repository()
819
if new_repository._fallback_repositories:
820
raise AssertionError("didn't expect %r to have "
821
"fallback_repositories"
822
% (self.repository,))
823
# Replace self.repository with the new repository.
824
# Do our best to transfer the lock state (i.e. lock-tokens and
825
# lock count) of self.repository to the new repository.
826
lock_token = old_repository.lock_write().repository_token
827
self.repository = new_repository
828
if isinstance(self, remote.RemoteBranch):
829
# Remote branches can have a second reference to the old
830
# repository that need to be replaced.
831
if self._real_branch is not None:
832
self._real_branch.repository = new_repository
833
self.repository.lock_write(token=lock_token)
834
if lock_token is not None:
835
old_repository.leave_lock_in_place()
836
old_repository.unlock()
837
if lock_token is not None:
838
# XXX: self.repository.leave_lock_in_place() before this
839
# function will not be preserved. Fortunately that doesn't
840
# affect the current default format (2a), and would be a
841
# corner-case anyway.
842
# - Andrew Bennetts, 2010/06/30
843
self.repository.dont_leave_lock_in_place()
847
old_repository.unlock()
848
except errors.LockNotHeld:
851
if old_lock_count == 0:
852
raise AssertionError(
853
'old_repository should have been locked at least once.')
854
for i in range(old_lock_count-1):
855
self.repository.lock_write()
856
# Fetch from the old repository into the new.
857
old_repository.lock_read()
859
# XXX: If you unstack a branch while it has a working tree
860
# with a pending merge, the pending-merged revisions will no
861
# longer be present. You can (probably) revert and remerge.
863
# XXX: This only fetches up to the tip of the repository; it
864
# doesn't bring across any tags. That's fairly consistent
865
# with how branch works, but perhaps not ideal.
866
self.repository.fetch(old_repository,
867
revision_id=self.last_revision(),
870
old_repository.unlock()
874
def _set_tags_bytes(self, bytes):
875
"""Mirror method for _get_tags_bytes.
877
:seealso: Branch._get_tags_bytes.
879
return _run_with_write_locked_target(self, self._transport.put_bytes,
882
def _cache_revision_history(self, rev_history):
883
"""Set the cached revision history to rev_history.
885
The revision_history method will use this cache to avoid regenerating
886
the revision history.
888
This API is semi-public; it only for use by subclasses, all other code
889
should consider it to be private.
891
self._revision_history_cache = rev_history
893
def _cache_revision_id_to_revno(self, revision_id_to_revno):
894
"""Set the cached revision_id => revno map to revision_id_to_revno.
896
This API is semi-public; it only for use by subclasses, all other code
897
should consider it to be private.
899
self._revision_id_to_revno_cache = revision_id_to_revno
901
def _clear_cached_state(self):
902
"""Clear any cached data on this branch, e.g. cached revision history.
904
This means the next call to revision_history will need to call
905
_gen_revision_history.
907
This API is semi-public; it only for use by subclasses, all other code
908
should consider it to be private.
910
self._revision_history_cache = None
911
self._revision_id_to_revno_cache = None
912
self._last_revision_info_cache = None
913
self._merge_sorted_revisions_cache = None
914
self._partial_revision_history_cache = []
915
self._partial_revision_id_to_revno_cache = {}
917
def _gen_revision_history(self):
918
"""Return sequence of revision hashes on to this branch.
920
Unlike revision_history, this method always regenerates or rereads the
921
revision history, i.e. it does not cache the result, so repeated calls
924
Concrete subclasses should override this instead of revision_history so
925
that subclasses do not need to deal with caching logic.
927
This API is semi-public; it only for use by subclasses, all other code
928
should consider it to be private.
930
raise NotImplementedError(self._gen_revision_history)
284
raise NotImplementedError('set_revision_history is abstract')
933
286
def revision_history(self):
934
"""Return sequence of revision ids on this branch.
936
This method will cache the revision history for as long as it is safe to
939
if 'evil' in debug.debug_flags:
940
mutter_callsite(3, "revision_history scales with history.")
941
if self._revision_history_cache is not None:
942
history = self._revision_history_cache
944
history = self._gen_revision_history()
945
self._cache_revision_history(history)
287
"""Return sequence of revision hashes on to this branch."""
288
raise NotImplementedError('revision_history is abstract')
949
291
"""Return current revision number for this branch.
993
320
common_index = min(self_len, other_len) -1
994
321
if common_index >= 0 and \
995
322
self_history[common_index] != other_history[common_index]:
996
raise errors.DivergedBranches(self, other)
323
raise DivergedBranches(self, other)
998
325
if stop_revision is None:
999
326
stop_revision = other_len
328
assert isinstance(stop_revision, int)
1001
329
if stop_revision > other_len:
1002
330
raise errors.NoSuchRevision(self, stop_revision)
1003
331
return other_history[self_len:stop_revision]
1005
def update_revisions(self, other, stop_revision=None, overwrite=False,
333
def update_revisions(self, other, stop_revision=None):
1007
334
"""Pull in new perfect-fit revisions.
1009
336
:param other: Another Branch to pull from
1010
337
:param stop_revision: Updated until the given revision
1011
:param overwrite: Always set the branch pointer, rather than checking
1012
to see if it is a proper descendant.
1013
:param graph: A Graph object that can be used to query history
1014
information. This can be None.
1017
return InterBranch.get(other, self).update_revisions(stop_revision,
1020
def import_last_revision_info(self, source_repo, revno, revid):
1021
"""Set the last revision info, importing from another repo if necessary.
1023
This is used by the bound branch code to upload a revision to
1024
the master branch first before updating the tip of the local branch.
1026
:param source_repo: Source repository to optionally fetch from
1027
:param revno: Revision number of the new tip
1028
:param revid: Revision id of the new tip
1030
if not self.repository.has_same_location(source_repo):
1031
self.repository.fetch(source_repo, revision_id=revid)
1032
self.set_last_revision_info(revno, revid)
340
raise NotImplementedError('update_revisions is abstract')
1034
342
def revision_id_to_revno(self, revision_id):
1035
343
"""Given a revision id, return its revno"""
1036
if _mod_revision.is_null(revision_id):
344
if revision_id is None:
1038
346
history = self.revision_history()
1040
348
return history.index(revision_id) + 1
1041
349
except ValueError:
1042
raise errors.NoSuchRevision(self, revision_id)
350
raise bzrlib.errors.NoSuchRevision(self, revision_id)
1045
352
def get_rev_id(self, revno, history=None):
1046
353
"""Find the revision id of the specified revno."""
1048
return _mod_revision.NULL_REVISION
1049
last_revno, last_revid = self.last_revision_info()
1050
if revno == last_revno:
1052
if revno <= 0 or revno > last_revno:
1053
raise errors.NoSuchRevision(self, revno)
1054
distance_from_last = last_revno - revno
1055
if len(self._partial_revision_history_cache) <= distance_from_last:
1056
self._extend_partial_history(distance_from_last)
1057
return self._partial_revision_history_cache[distance_from_last]
1059
def pull(self, source, overwrite=False, stop_revision=None,
1060
possible_transports=None, *args, **kwargs):
1061
"""Mirror source into this branch.
1063
This branch is considered to be 'local', having low latency.
1065
:returns: PullResult instance
1067
return InterBranch.get(source, self).pull(overwrite=overwrite,
1068
stop_revision=stop_revision,
1069
possible_transports=possible_transports, *args, **kwargs)
1071
def push(self, target, overwrite=False, stop_revision=None, *args,
1073
"""Mirror this branch into target.
1075
This branch is considered to be 'local', having low latency.
1077
return InterBranch.get(self, target).push(overwrite, stop_revision,
1080
def lossy_push(self, target, stop_revision=None):
1081
"""Push deltas into another branch.
1083
:note: This does not, like push, retain the revision ids from
1084
the source branch and will, rather than adding bzr-specific
1085
metadata, push only those semantics of the revision that can be
1086
natively represented by this branch' VCS.
1088
:param target: Target branch
1089
:param stop_revision: Revision to push, defaults to last revision.
1090
:return: BranchPushResult with an extra member revidmap:
1091
A dictionary mapping revision ids from the target branch
1092
to new revision ids in the target branch, for each
1093
revision that was pushed.
1095
inter = InterBranch.get(self, target)
1096
lossy_push = getattr(inter, "lossy_push", None)
1097
if lossy_push is None:
1098
raise errors.LossyPushToSameVCS(self, target)
1099
return lossy_push(stop_revision)
357
history = self.revision_history()
358
elif revno <= 0 or revno > len(history):
359
raise bzrlib.errors.NoSuchRevision(self, revno)
360
return history[revno - 1]
362
def pull(self, source, overwrite=False, stop_revision=None):
363
raise NotImplementedError('pull is abstract')
1101
365
def basis_tree(self):
1102
366
"""Return `Tree` object for last revision."""
1103
367
return self.repository.revision_tree(self.last_revision())
369
def rename_one(self, from_rel, to_rel):
372
This can change the directory or the filename or both.
374
raise NotImplementedError('rename_one is abstract')
376
def move(self, from_paths, to_name):
379
to_name must exist as a versioned directory.
381
If to_name exists and is a directory, the files are moved into
382
it, keeping their old names. If it is a directory,
384
Note that to_name is only the last component of the new name;
385
this doesn't change the directory.
387
This returns a list of (from_path, to_path) pairs for each
390
raise NotImplementedError('move is abstract')
1105
392
def get_parent(self):
1106
393
"""Return the parent location of the branch.
1108
This is the default location for pull/missing. The usual
395
This is the default location for push/pull/missing. The usual
1109
396
pattern is that the user can override it by specifying a
1112
parent = self._get_parent_location()
1115
# This is an old-format absolute path to a local branch
1116
# turn it into a url
1117
if parent.startswith('/'):
1118
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1120
return urlutils.join(self.base[:-1], parent)
1121
except errors.InvalidURLJoin, e:
1122
raise errors.InaccessibleParent(parent, self.user_url)
1124
def _get_parent_location(self):
1125
raise NotImplementedError(self._get_parent_location)
1127
def _set_config_location(self, name, url, config=None,
1128
make_relative=False):
1130
config = self.get_config()
1134
url = urlutils.relative_url(self.base, url)
1135
config.set_user_option(name, url, warn_masked=True)
1137
def _get_config_location(self, name, config=None):
1139
config = self.get_config()
1140
location = config.get_user_option(name)
1145
def get_child_submit_format(self):
1146
"""Return the preferred format of submissions to this branch."""
1147
return self.get_config().get_user_option("child_submit_format")
399
raise NotImplementedError('get_parent is abstract')
1149
401
def get_submit_branch(self):
1150
402
"""Return the submit location of the branch.
1229
444
self.check_real_revno(revno)
1231
446
def check_real_revno(self, revno):
1233
448
Check whether a revno corresponds to a real revision.
1234
449
Zero (the NULL revision) is considered invalid
1236
451
if revno < 1 or revno > self.revno():
1237
raise errors.InvalidRevisionNumber(revno)
452
raise InvalidRevisionNumber(revno)
1239
454
@needs_read_lock
1240
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
455
def clone(self, *args, **kwargs):
1241
456
"""Clone this branch into to_bzrdir preserving all semantic values.
1243
Most API users will want 'create_clone_on_transport', which creates a
1244
new bzrdir and branch on the fly.
1246
458
revision_id: if not None, the revision history in the new branch will
1247
459
be truncated to end with revision_id.
1249
result = to_bzrdir.create_branch()
1252
if repository_policy is not None:
1253
repository_policy.configure_branch(result)
1254
self.copy_content_into(result, revision_id=revision_id)
461
# for API compatibility, until 0.8 releases we provide the old api:
462
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
463
# after 0.8 releases, the *args and **kwargs should be changed:
464
# def clone(self, to_bzrdir, revision_id=None):
465
if (kwargs.get('to_location', None) or
466
kwargs.get('revision', None) or
467
kwargs.get('basis_branch', None) or
468
(len(args) and isinstance(args[0], basestring))):
469
# backwards compatibility api:
470
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
471
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
474
basis_branch = args[2]
476
basis_branch = kwargs.get('basis_branch', None)
478
basis = basis_branch.bzrdir
483
revision_id = args[1]
485
revision_id = kwargs.get('revision', None)
490
# no default to raise if not provided.
491
url = kwargs.get('to_location')
492
return self.bzrdir.clone(url,
493
revision_id=revision_id,
494
basis=basis).open_branch()
496
# generate args by hand
498
revision_id = args[1]
500
revision_id = kwargs.get('revision_id', None)
504
# no default to raise if not provided.
505
to_bzrdir = kwargs.get('to_bzrdir')
506
result = self._format.initialize(to_bzrdir)
507
self.copy_content_into(result, revision_id=revision_id)
1259
510
@needs_read_lock
1260
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
511
def sprout(self, to_bzrdir, revision_id=None):
1261
512
"""Create a new line of development from the branch, into to_bzrdir.
1263
to_bzrdir controls the branch format.
1265
514
revision_id: if not None, the revision history in the new branch will
1266
515
be truncated to end with revision_id.
1268
if (repository_policy is not None and
1269
repository_policy.requires_stacking()):
1270
to_bzrdir._format.require_stacking(_skip_repo=True)
1271
result = to_bzrdir.create_branch()
1274
if repository_policy is not None:
1275
repository_policy.configure_branch(result)
1276
self.copy_content_into(result, revision_id=revision_id)
1277
result.set_parent(self.bzrdir.root_transport.base)
517
result = self._format.initialize(to_bzrdir)
518
self.copy_content_into(result, revision_id=revision_id)
519
result.set_parent(self.bzrdir.root_transport.base)
1282
def _synchronize_history(self, destination, revision_id):
1283
"""Synchronize last revision and revision history between branches.
1285
This version is most efficient when the destination is also a
1286
BzrBranch6, but works for BzrBranch5, as long as the destination's
1287
repository contains all the lefthand ancestors of the intended
1288
last_revision. If not, set_last_revision_info will fail.
1290
:param destination: The branch to copy the history into
1291
:param revision_id: The revision-id to truncate history at. May
1292
be None to copy complete history.
1294
source_revno, source_revision_id = self.last_revision_info()
1295
if revision_id is None:
1296
revno, revision_id = source_revno, source_revision_id
1298
graph = self.repository.get_graph()
1300
revno = graph.find_distance_to_null(revision_id,
1301
[(source_revision_id, source_revno)])
1302
except errors.GhostRevisionsHaveNoRevno:
1303
# Default to 1, if we can't find anything else
1305
destination.set_last_revision_info(revno, revision_id)
1307
523
def copy_content_into(self, destination, revision_id=None):
1308
524
"""Copy the content of self into destination.
1310
526
revision_id: if not None, the revision history in the new branch will
1311
527
be truncated to end with revision_id.
1313
return InterBranch.get(self, destination).copy_content_into(
1314
revision_id=revision_id)
1316
def update_references(self, target):
1317
if not getattr(self._format, 'supports_reference_locations', False):
1319
reference_dict = self._get_all_reference_info()
1320
if len(reference_dict) == 0:
1322
old_base = self.base
1323
new_base = target.base
1324
target_reference_dict = target._get_all_reference_info()
1325
for file_id, (tree_path, branch_location) in (
1326
reference_dict.items()):
1327
branch_location = urlutils.rebase_url(branch_location,
1329
target_reference_dict.setdefault(
1330
file_id, (tree_path, branch_location))
1331
target._set_all_reference_info(target_reference_dict)
529
new_history = self.revision_history()
530
if revision_id is not None:
532
new_history = new_history[:new_history.index(revision_id) + 1]
534
rev = self.repository.get_revision(revision_id)
535
new_history = rev.get_history(self.repository)[1:]
536
destination.set_revision_history(new_history)
537
parent = self.get_parent()
539
destination.set_parent(parent)
1333
541
@needs_read_lock
1334
def check(self, refs):
1335
543
"""Check consistency of the branch.
1337
545
In particular this checks that revisions given in the revision-history
1338
do actually match up in the revision graph, and that they're all
546
do actually match up in the revision graph, and that they're all
1339
547
present in the repository.
1341
549
Callers will typically also want to check the repository.
1343
:param refs: Calculated refs for this branch as specified by
1344
branch._get_check_refs()
1345
551
:return: A BranchCheckResult.
1347
result = BranchCheckResult(self)
1348
last_revno, last_revision_id = self.last_revision_info()
1349
actual_revno = refs[('lefthand-distance', last_revision_id)]
1350
if actual_revno != last_revno:
1351
result.errors.append(errors.BzrCheckError(
1352
'revno does not match len(mainline) %s != %s' % (
1353
last_revno, actual_revno)))
1354
# TODO: We should probably also check that self.revision_history
1355
# matches the repository for older branch formats.
1356
# If looking for the code that cross-checks repository parents against
1357
# the iter_reverse_revision_history output, that is now a repository
1361
def _get_checkout_format(self):
1362
"""Return the most suitable metadir for a checkout of this branch.
1363
Weaves are used if this branch's repository uses weaves.
1365
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1366
from bzrlib.repofmt import weaverepo
1367
format = bzrdir.BzrDirMetaFormat1()
1368
format.repository_format = weaverepo.RepositoryFormat7()
1370
format = self.repository.bzrdir.checkout_metadir()
1371
format.set_branch_format(self._format)
1374
def create_clone_on_transport(self, to_transport, revision_id=None,
1375
stacked_on=None, create_prefix=False, use_existing_dir=False):
1376
"""Create a clone of this branch and its bzrdir.
1378
:param to_transport: The transport to clone onto.
1379
:param revision_id: The revision id to use as tip in the new branch.
1380
If None the tip is obtained from this branch.
1381
:param stacked_on: An optional URL to stack the clone on.
1382
:param create_prefix: Create any missing directories leading up to
1384
:param use_existing_dir: Use an existing directory if one exists.
1386
# XXX: Fix the bzrdir API to allow getting the branch back from the
1387
# clone call. Or something. 20090224 RBC/spiv.
1388
# XXX: Should this perhaps clone colocated branches as well,
1389
# rather than just the default branch? 20100319 JRV
1390
if revision_id is None:
1391
revision_id = self.last_revision()
1392
dir_to = self.bzrdir.clone_on_transport(to_transport,
1393
revision_id=revision_id, stacked_on=stacked_on,
1394
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1395
return dir_to.open_branch()
1397
def create_checkout(self, to_location, revision_id=None,
1398
lightweight=False, accelerator_tree=None,
1400
"""Create a checkout of a branch.
1402
:param to_location: The url to produce the checkout at
1403
:param revision_id: The revision to check out
1404
:param lightweight: If True, produce a lightweight checkout, otherwise,
1405
produce a bound branch (heavyweight checkout)
1406
:param accelerator_tree: A tree which can be used for retrieving file
1407
contents more quickly than the revision tree, i.e. a workingtree.
1408
The revision tree will be used for cases where accelerator_tree's
1409
content is different.
1410
:param hardlink: If true, hard-link files from accelerator_tree,
1412
:return: The tree of the created checkout
1414
t = transport.get_transport(to_location)
1417
format = self._get_checkout_format()
1418
checkout = format.initialize_on_transport(t)
1419
from_branch = BranchReferenceFormat().initialize(checkout,
1422
format = self._get_checkout_format()
1423
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1424
to_location, force_new_tree=False, format=format)
1425
checkout = checkout_branch.bzrdir
1426
checkout_branch.bind(self)
1427
# pull up to the specified revision_id to set the initial
1428
# branch tip correctly, and seed it with history.
1429
checkout_branch.pull(self, stop_revision=revision_id)
1431
tree = checkout.create_workingtree(revision_id,
1432
from_branch=from_branch,
1433
accelerator_tree=accelerator_tree,
1435
basis_tree = tree.basis_tree()
1436
basis_tree.lock_read()
1438
for path, file_id in basis_tree.iter_references():
1439
reference_parent = self.reference_parent(file_id, path)
1440
reference_parent.create_checkout(tree.abspath(path),
1441
basis_tree.get_reference_revision(file_id, path),
1448
def reconcile(self, thorough=True):
1449
"""Make sure the data stored in this branch is consistent."""
1450
from bzrlib.reconcile import BranchReconciler
1451
reconciler = BranchReconciler(self, thorough=thorough)
1452
reconciler.reconcile()
1455
def reference_parent(self, file_id, path, possible_transports=None):
1456
"""Return the parent branch for a tree-reference file_id
1457
:param file_id: The file_id of the tree reference
1458
:param path: The path of the file_id in the tree
1459
:return: A branch associated with the file_id
1461
# FIXME should provide multiple branches, based on config
1462
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1463
possible_transports=possible_transports)
1465
def supports_tags(self):
1466
return self._format.supports_tags()
1468
def automatic_tag_name(self, revision_id):
1469
"""Try to automatically find the tag name for a revision.
1471
:param revision_id: Revision id of the revision.
1472
:return: A tag name or None if no tag name could be determined.
1474
for hook in Branch.hooks['automatic_tag_name']:
1475
ret = hook(self, revision_id)
1480
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1482
"""Ensure that revision_b is a descendant of revision_a.
1484
This is a helper function for update_revisions.
1486
:raises: DivergedBranches if revision_b has diverged from revision_a.
1487
:returns: True if revision_b is a descendant of revision_a.
1489
relation = self._revision_relations(revision_a, revision_b, graph)
1490
if relation == 'b_descends_from_a':
1492
elif relation == 'diverged':
1493
raise errors.DivergedBranches(self, other_branch)
1494
elif relation == 'a_descends_from_b':
1497
raise AssertionError("invalid relation: %r" % (relation,))
1499
def _revision_relations(self, revision_a, revision_b, graph):
1500
"""Determine the relationship between two revisions.
1502
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1504
heads = graph.heads([revision_a, revision_b])
1505
if heads == set([revision_b]):
1506
return 'b_descends_from_a'
1507
elif heads == set([revision_a, revision_b]):
1508
# These branches have diverged
1510
elif heads == set([revision_a]):
1511
return 'a_descends_from_b'
1513
raise AssertionError("invalid heads: %r" % (heads,))
553
mainline_parent_id = None
554
for revision_id in self.revision_history():
556
revision = self.repository.get_revision(revision_id)
557
except errors.NoSuchRevision, e:
558
raise errors.BzrCheckError("mainline revision {%s} not in repository"
560
# In general the first entry on the revision history has no parents.
561
# But it's not illegal for it to have parents listed; this can happen
562
# in imports from Arch when the parents weren't reachable.
563
if mainline_parent_id is not None:
564
if mainline_parent_id not in revision.parent_ids:
565
raise errors.BzrCheckError("previous revision {%s} not listed among "
567
% (mainline_parent_id, revision_id))
568
mainline_parent_id = revision_id
569
return BranchCheckResult(self)
1516
572
class BranchFormat(object):
1538
594
"""The known formats."""
1540
can_set_append_revisions_only = True
1542
def __eq__(self, other):
1543
return self.__class__ is other.__class__
1545
def __ne__(self, other):
1546
return not (self == other)
1549
def find_format(klass, a_bzrdir, name=None):
597
def find_format(klass, a_bzrdir):
1550
598
"""Return the format for the branch object in a_bzrdir."""
1552
transport = a_bzrdir.get_branch_transport(None, name=name)
1553
format_string = transport.get_bytes("format")
1554
format = klass._formats[format_string]
1555
if isinstance(format, MetaDirBranchFormatFactory):
1558
except errors.NoSuchFile:
1559
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
600
transport = a_bzrdir.get_branch_transport(None)
601
format_string = transport.get("format").read()
602
return klass._formats[format_string]
604
raise NotBranchError(path=transport.base)
1560
605
except KeyError:
1561
raise errors.UnknownFormatError(format=format_string, kind='branch')
606
raise errors.UnknownFormatError(format=format_string)
1564
609
def get_default_format(klass):
1565
610
"""Return the current default format."""
1566
611
return klass._default_format
1569
def get_formats(klass):
1570
"""Get all the known formats.
1572
Warning: This triggers a load of all lazy registered formats: do not
1573
use except when that is desireed.
1576
for fmt in klass._formats.values():
1577
if isinstance(fmt, MetaDirBranchFormatFactory):
1582
def get_reference(self, a_bzrdir, name=None):
1583
"""Get the target reference of the branch in a_bzrdir.
1585
format probing must have been completed before calling
1586
this method - it is assumed that the format of the branch
1587
in a_bzrdir is correct.
1589
:param a_bzrdir: The bzrdir to get the branch data from.
1590
:param name: Name of the colocated branch to fetch
1591
:return: None if the branch is not a reference branch.
1596
def set_reference(self, a_bzrdir, name, to_branch):
1597
"""Set the target reference of the branch in a_bzrdir.
1599
format probing must have been completed before calling
1600
this method - it is assumed that the format of the branch
1601
in a_bzrdir is correct.
1603
:param a_bzrdir: The bzrdir to set the branch reference for.
1604
:param name: Name of colocated branch to set, None for default
1605
:param to_branch: branch that the checkout is to reference
1607
raise NotImplementedError(self.set_reference)
1609
613
def get_format_string(self):
1610
614
"""Return the ASCII format string that identifies this format."""
1611
615
raise NotImplementedError(self.get_format_string)
1613
617
def get_format_description(self):
1614
618
"""Return the short format description for this format."""
1615
raise NotImplementedError(self.get_format_description)
1617
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1618
hooks = Branch.hooks['post_branch_init']
1621
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1625
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1626
lock_type='metadir', set_format=True):
1627
"""Initialize a branch in a bzrdir, with specified files
1629
:param a_bzrdir: The bzrdir to initialize the branch in
1630
:param utf8_files: The files to create as a list of
1631
(filename, content) tuples
1632
:param name: Name of colocated branch to create, if any
1633
:param set_format: If True, set the format with
1634
self.get_format_string. (BzrBranch4 has its format set
1636
:return: a branch in this format
1638
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1639
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1641
'metadir': ('lock', lockdir.LockDir),
1642
'branch4': ('branch-lock', lockable_files.TransportLock),
1644
lock_name, lock_class = lock_map[lock_type]
1645
control_files = lockable_files.LockableFiles(branch_transport,
1646
lock_name, lock_class)
1647
control_files.create_lock()
1649
control_files.lock_write()
1650
except errors.LockContention:
1651
if lock_type != 'branch4':
1657
utf8_files += [('format', self.get_format_string())]
1659
for (filename, content) in utf8_files:
1660
branch_transport.put_bytes(
1662
mode=a_bzrdir._get_file_mode())
1665
control_files.unlock()
1666
branch = self.open(a_bzrdir, name, _found=True)
1667
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1670
def initialize(self, a_bzrdir, name=None):
1671
"""Create a branch of this format in a_bzrdir.
1673
:param name: Name of the colocated branch to create.
619
raise NotImplementedError(self.get_format_string)
621
def initialize(self, a_bzrdir):
622
"""Create a branch of this format in a_bzrdir."""
1675
623
raise NotImplementedError(self.initialize)
1677
625
def is_supported(self):
1678
626
"""Is this format supported?
1680
628
Supported formats can be initialized and opened.
1681
Unsupported formats may not support initialization or committing or
629
Unsupported formats may not support initialization or committing or
1682
630
some other features depending on the reason for not being supported.
1686
def make_tags(self, branch):
1687
"""Create a tags object for branch.
1689
This method is on BranchFormat, because BranchFormats are reflected
1690
over the wire via network_name(), whereas full Branch instances require
1691
multiple VFS method calls to operate at all.
1693
The default implementation returns a disabled-tags instance.
1695
Note that it is normal for branch to be a RemoteBranch when using tags
1698
return DisabledTags(branch)
1700
def network_name(self):
1701
"""A simple byte string uniquely identifying this format for RPC calls.
1703
MetaDir branch formats use their disk format string to identify the
1704
repository over the wire. All in one formats such as bzr < 0.8, and
1705
foreign formats like svn/git and hg should use some marker which is
1706
unique and immutable.
1708
raise NotImplementedError(self.network_name)
1710
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
634
def open(self, a_bzrdir, _found=False):
1711
635
"""Return the branch object for a_bzrdir
1713
:param a_bzrdir: A BzrDir that contains a branch.
1714
:param name: Name of colocated branch to open
1715
:param _found: a private parameter, do not use it. It is used to
1716
indicate if format probing has already be done.
1717
:param ignore_fallbacks: when set, no fallback branches will be opened
1718
(if there are any). Default is to open fallbacks.
637
_found is a private parameter, do not use it. It is used to indicate
638
if format probing has already be done.
1720
640
raise NotImplementedError(self.open)
1723
643
def register_format(klass, format):
1724
"""Register a metadir format.
1726
See MetaDirBranchFormatFactory for the ability to register a format
1727
without loading the code the format needs until it is actually used.
1729
644
klass._formats[format.get_format_string()] = format
1730
# Metadir formats have a network name of their format string, and get
1731
# registered as factories.
1732
if isinstance(format, MetaDirBranchFormatFactory):
1733
network_format_registry.register(format.get_format_string(), format)
1735
network_format_registry.register(format.get_format_string(),
1739
647
def set_default_format(klass, format):
1740
648
klass._default_format = format
1742
def supports_set_append_revisions_only(self):
1743
"""True if this format supports set_append_revisions_only."""
1746
def supports_stacking(self):
1747
"""True if this format records a stacked-on branch."""
1751
651
def unregister_format(klass, format):
652
assert klass._formats[format.get_format_string()] is format
1752
653
del klass._formats[format.get_format_string()]
1754
655
def __str__(self):
1755
return self.get_format_description().rstrip()
1757
def supports_tags(self):
1758
"""True if this format supports tags stored in the branch"""
1759
return False # by default
1762
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1763
"""A factory for a BranchFormat object, permitting simple lazy registration.
1765
While none of the built in BranchFormats are lazy registered yet,
1766
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1767
use it, and the bzr-loom plugin uses it as well (see
1768
bzrlib.plugins.loom.formats).
1771
def __init__(self, format_string, module_name, member_name):
1772
"""Create a MetaDirBranchFormatFactory.
1774
:param format_string: The format string the format has.
1775
:param module_name: Module to load the format class from.
1776
:param member_name: Attribute name within the module for the format class.
1778
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1779
self._format_string = format_string
1781
def get_format_string(self):
1782
"""See BranchFormat.get_format_string."""
1783
return self._format_string
1786
"""Used for network_format_registry support."""
1787
return self.get_obj()()
1790
class BranchHooks(Hooks):
1791
"""A dictionary mapping hook name to a list of callables for branch hooks.
1793
e.g. ['set_rh'] Is the list of items to be called when the
1794
set_revision_history function is invoked.
1798
"""Create the default hooks.
1800
These are all empty initially, because by default nothing should get
1803
Hooks.__init__(self)
1804
self.create_hook(HookPoint('set_rh',
1805
"Invoked whenever the revision history has been set via "
1806
"set_revision_history. The api signature is (branch, "
1807
"revision_history), and the branch will be write-locked. "
1808
"The set_rh hook can be expensive for bzr to trigger, a better "
1809
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1810
self.create_hook(HookPoint('open',
1811
"Called with the Branch object that has been opened after a "
1812
"branch is opened.", (1, 8), None))
1813
self.create_hook(HookPoint('post_push',
1814
"Called after a push operation completes. post_push is called "
1815
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1816
"bzr client.", (0, 15), None))
1817
self.create_hook(HookPoint('post_pull',
1818
"Called after a pull operation completes. post_pull is called "
1819
"with a bzrlib.branch.PullResult object and only runs in the "
1820
"bzr client.", (0, 15), None))
1821
self.create_hook(HookPoint('pre_commit',
1822
"Called after a commit is calculated but before it is is "
1823
"completed. pre_commit is called with (local, master, old_revno, "
1824
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1825
"). old_revid is NULL_REVISION for the first commit to a branch, "
1826
"tree_delta is a TreeDelta object describing changes from the "
1827
"basis revision. hooks MUST NOT modify this delta. "
1828
" future_tree is an in-memory tree obtained from "
1829
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1830
"tree.", (0,91), None))
1831
self.create_hook(HookPoint('post_commit',
1832
"Called in the bzr client after a commit has completed. "
1833
"post_commit is called with (local, master, old_revno, old_revid, "
1834
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1835
"commit to a branch.", (0, 15), None))
1836
self.create_hook(HookPoint('post_uncommit',
1837
"Called in the bzr client after an uncommit completes. "
1838
"post_uncommit is called with (local, master, old_revno, "
1839
"old_revid, new_revno, new_revid) where local is the local branch "
1840
"or None, master is the target branch, and an empty branch "
1841
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1842
self.create_hook(HookPoint('pre_change_branch_tip',
1843
"Called in bzr client and server before a change to the tip of a "
1844
"branch is made. pre_change_branch_tip is called with a "
1845
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1846
"commit, uncommit will all trigger this hook.", (1, 6), None))
1847
self.create_hook(HookPoint('post_change_branch_tip',
1848
"Called in bzr client and server after a change to the tip of a "
1849
"branch is made. post_change_branch_tip is called with a "
1850
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1851
"commit, uncommit will all trigger this hook.", (1, 4), None))
1852
self.create_hook(HookPoint('transform_fallback_location',
1853
"Called when a stacked branch is activating its fallback "
1854
"locations. transform_fallback_location is called with (branch, "
1855
"url), and should return a new url. Returning the same url "
1856
"allows it to be used as-is, returning a different one can be "
1857
"used to cause the branch to stack on a closer copy of that "
1858
"fallback_location. Note that the branch cannot have history "
1859
"accessing methods called on it during this hook because the "
1860
"fallback locations have not been activated. When there are "
1861
"multiple hooks installed for transform_fallback_location, "
1862
"all are called with the url returned from the previous hook."
1863
"The order is however undefined.", (1, 9), None))
1864
self.create_hook(HookPoint('automatic_tag_name',
1865
"Called to determine an automatic tag name for a revision. "
1866
"automatic_tag_name is called with (branch, revision_id) and "
1867
"should return a tag name or None if no tag name could be "
1868
"determined. The first non-None tag name returned will be used.",
1870
self.create_hook(HookPoint('post_branch_init',
1871
"Called after new branch initialization completes. "
1872
"post_branch_init is called with a "
1873
"bzrlib.branch.BranchInitHookParams. "
1874
"Note that init, branch and checkout (both heavyweight and "
1875
"lightweight) will all trigger this hook.", (2, 2), None))
1876
self.create_hook(HookPoint('post_switch',
1877
"Called after a checkout switches branch. "
1878
"post_switch is called with a "
1879
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1883
# install the default hooks into the Branch class.
1884
Branch.hooks = BranchHooks()
1887
class ChangeBranchTipParams(object):
1888
"""Object holding parameters passed to *_change_branch_tip hooks.
1890
There are 5 fields that hooks may wish to access:
1892
:ivar branch: the branch being changed
1893
:ivar old_revno: revision number before the change
1894
:ivar new_revno: revision number after the change
1895
:ivar old_revid: revision id before the change
1896
:ivar new_revid: revision id after the change
1898
The revid fields are strings. The revno fields are integers.
1901
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1902
"""Create a group of ChangeBranchTip parameters.
1904
:param branch: The branch being changed.
1905
:param old_revno: Revision number before the change.
1906
:param new_revno: Revision number after the change.
1907
:param old_revid: Tip revision id before the change.
1908
:param new_revid: Tip revision id after the change.
1910
self.branch = branch
1911
self.old_revno = old_revno
1912
self.new_revno = new_revno
1913
self.old_revid = old_revid
1914
self.new_revid = new_revid
1916
def __eq__(self, other):
1917
return self.__dict__ == other.__dict__
1920
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1921
self.__class__.__name__, self.branch,
1922
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1925
class BranchInitHookParams(object):
1926
"""Object holding parameters passed to *_branch_init hooks.
1928
There are 4 fields that hooks may wish to access:
1930
:ivar format: the branch format
1931
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1932
:ivar name: name of colocated branch, if any (or None)
1933
:ivar branch: the branch created
1935
Note that for lightweight checkouts, the bzrdir and format fields refer to
1936
the checkout, hence they are different from the corresponding fields in
1937
branch, which refer to the original branch.
1940
def __init__(self, format, a_bzrdir, name, branch):
1941
"""Create a group of BranchInitHook parameters.
1943
:param format: the branch format
1944
:param a_bzrdir: the BzrDir where the branch will be/has been
1946
:param name: name of colocated branch, if any (or None)
1947
:param branch: the branch created
1949
Note that for lightweight checkouts, the bzrdir and format fields refer
1950
to the checkout, hence they are different from the corresponding fields
1951
in branch, which refer to the original branch.
1953
self.format = format
1954
self.bzrdir = a_bzrdir
1956
self.branch = branch
1958
def __eq__(self, other):
1959
return self.__dict__ == other.__dict__
1962
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1965
class SwitchHookParams(object):
1966
"""Object holding parameters passed to *_switch hooks.
1968
There are 4 fields that hooks may wish to access:
1970
:ivar control_dir: BzrDir of the checkout to change
1971
:ivar to_branch: branch that the checkout is to reference
1972
:ivar force: skip the check for local commits in a heavy checkout
1973
:ivar revision_id: revision ID to switch to (or None)
1976
def __init__(self, control_dir, to_branch, force, revision_id):
1977
"""Create a group of SwitchHook parameters.
1979
:param control_dir: BzrDir of the checkout to change
1980
:param to_branch: branch that the checkout is to reference
1981
:param force: skip the check for local commits in a heavy checkout
1982
:param revision_id: revision ID to switch to (or None)
1984
self.control_dir = control_dir
1985
self.to_branch = to_branch
1987
self.revision_id = revision_id
1989
def __eq__(self, other):
1990
return self.__dict__ == other.__dict__
1993
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1994
self.control_dir, self.to_branch,
656
return self.get_format_string().rstrip()
1998
659
class BzrBranchFormat4(BranchFormat):
2104
728
def get_format_description(self):
2105
729
"""See BranchFormat.get_format_description()."""
2106
730
return "Branch format 5"
2108
def initialize(self, a_bzrdir, name=None):
732
def initialize(self, a_bzrdir):
2109
733
"""Create a branch of this format in a_bzrdir."""
734
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
735
branch_transport = a_bzrdir.get_branch_transport(self)
2110
736
utf8_files = [('revision-history', ''),
2111
737
('branch-name', ''),
2113
return self._initialize_helper(a_bzrdir, utf8_files, name)
2115
def supports_tags(self):
2119
class BzrBranchFormat6(BranchFormatMetadir):
2120
"""Branch format with last-revision and tags.
2122
Unlike previous formats, this has no explicit revision history. Instead,
2123
this just stores the last-revision, and the left-hand history leading
2124
up to there is the history.
2126
This format was introduced in bzr 0.15
2127
and became the default in 0.91.
2130
def _branch_class(self):
2133
def get_format_string(self):
2134
"""See BranchFormat.get_format_string()."""
2135
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2137
def get_format_description(self):
2138
"""See BranchFormat.get_format_description()."""
2139
return "Branch format 6"
2141
def initialize(self, a_bzrdir, name=None):
2142
"""Create a branch of this format in a_bzrdir."""
2143
utf8_files = [('last-revision', '0 null:\n'),
2144
('branch.conf', ''),
2147
return self._initialize_helper(a_bzrdir, utf8_files, name)
2149
def make_tags(self, branch):
2150
"""See bzrlib.branch.BranchFormat.make_tags()."""
2151
return BasicTags(branch)
2153
def supports_set_append_revisions_only(self):
2157
class BzrBranchFormat8(BranchFormatMetadir):
2158
"""Metadir format supporting storing locations of subtree branches."""
2160
def _branch_class(self):
2163
def get_format_string(self):
2164
"""See BranchFormat.get_format_string()."""
2165
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2167
def get_format_description(self):
2168
"""See BranchFormat.get_format_description()."""
2169
return "Branch format 8"
2171
def initialize(self, a_bzrdir, name=None):
2172
"""Create a branch of this format in a_bzrdir."""
2173
utf8_files = [('last-revision', '0 null:\n'),
2174
('branch.conf', ''),
2178
return self._initialize_helper(a_bzrdir, utf8_files, name)
739
control_files = LockableFiles(branch_transport, 'lock', lockdir.LockDir)
740
control_files.create_lock()
741
control_files.lock_write()
742
control_files.put_utf8('format', self.get_format_string())
744
for file, content in utf8_files:
745
control_files.put_utf8(file, content)
747
control_files.unlock()
748
return self.open(a_bzrdir, _found=True, )
2180
750
def __init__(self):
2181
super(BzrBranchFormat8, self).__init__()
2182
self._matchingbzrdir.repository_format = \
2183
RepositoryFormatKnitPack5RichRoot()
2185
def make_tags(self, branch):
2186
"""See bzrlib.branch.BranchFormat.make_tags()."""
2187
return BasicTags(branch)
2189
def supports_set_append_revisions_only(self):
2192
def supports_stacking(self):
2195
supports_reference_locations = True
2198
class BzrBranchFormat7(BzrBranchFormat8):
2199
"""Branch format with last-revision, tags, and a stacked location pointer.
2201
The stacked location pointer is passed down to the repository and requires
2202
a repository format with supports_external_lookups = True.
2204
This format was introduced in bzr 1.6.
2207
def initialize(self, a_bzrdir, name=None):
2208
"""Create a branch of this format in a_bzrdir."""
2209
utf8_files = [('last-revision', '0 null:\n'),
2210
('branch.conf', ''),
2213
return self._initialize_helper(a_bzrdir, utf8_files, name)
2215
def _branch_class(self):
2218
def get_format_string(self):
2219
"""See BranchFormat.get_format_string()."""
2220
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2222
def get_format_description(self):
2223
"""See BranchFormat.get_format_description()."""
2224
return "Branch format 7"
2226
def supports_set_append_revisions_only(self):
2229
supports_reference_locations = False
751
super(BzrBranchFormat5, self).__init__()
752
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
754
def open(self, a_bzrdir, _found=False):
755
"""Return the branch object for a_bzrdir
757
_found is a private parameter, do not use it. It is used to indicate
758
if format probing has already be done.
761
format = BranchFormat.find_format(a_bzrdir)
762
assert format.__class__ == self.__class__
763
transport = a_bzrdir.get_branch_transport(None)
764
control_files = LockableFiles(transport, 'lock', lockdir.LockDir)
765
return BzrBranch5(_format=self,
766
_control_files=control_files,
768
_repository=a_bzrdir.find_repository())
771
return "Bazaar-NG Metadir branch format 5"
2232
774
class BranchReferenceFormat(BranchFormat):
2247
789
def get_format_description(self):
2248
790
"""See BranchFormat.get_format_description()."""
2249
791
return "Checkout reference format 1"
2251
def get_reference(self, a_bzrdir, name=None):
2252
"""See BranchFormat.get_reference()."""
2253
transport = a_bzrdir.get_branch_transport(None, name=name)
2254
return transport.get_bytes('location')
2256
def set_reference(self, a_bzrdir, name, to_branch):
2257
"""See BranchFormat.set_reference()."""
2258
transport = a_bzrdir.get_branch_transport(None, name=name)
2259
location = transport.put_bytes('location', to_branch.base)
2261
def initialize(self, a_bzrdir, name=None, target_branch=None):
793
def initialize(self, a_bzrdir, target_branch=None):
2262
794
"""Create a branch of this format in a_bzrdir."""
2263
795
if target_branch is None:
2264
796
# this format does not implement branch itself, thus the implicit
2265
797
# creation contract must see it as uninitializable
2266
798
raise errors.UninitializableFormat(self)
2267
mutter('creating branch reference in %s', a_bzrdir.user_url)
2268
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2269
branch_transport.put_bytes('location',
2270
target_branch.bzrdir.user_url)
2271
branch_transport.put_bytes('format', self.get_format_string())
2273
a_bzrdir, name, _found=True,
2274
possible_transports=[target_branch.bzrdir.root_transport])
2275
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
799
mutter('creating branch reference in %s', a_bzrdir.transport.base)
800
branch_transport = a_bzrdir.get_branch_transport(self)
801
# FIXME rbc 20060209 one j-a-ms encoding branch lands this str() cast is not needed.
802
branch_transport.put('location', StringIO(str(target_branch.bzrdir.root_transport.base)))
803
branch_transport.put('format', StringIO(self.get_format_string()))
804
return self.open(a_bzrdir, _found=True)
2278
806
def __init__(self):
2279
807
super(BranchReferenceFormat, self).__init__()
2280
808
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2281
self._matchingbzrdir.set_branch_format(self)
2283
810
def _make_reference_clone_function(format, a_branch):
2284
811
"""Create a clone() routine for a branch dynamically."""
2285
def clone(to_bzrdir, revision_id=None,
2286
repository_policy=None):
812
def clone(to_bzrdir, revision_id=None):
2287
813
"""See Branch.clone()."""
2288
return format.initialize(to_bzrdir, target_branch=a_branch)
814
return format.initialize(to_bzrdir, a_branch)
2289
815
# cannot obey revision_id limits when cloning a reference ...
2290
816
# FIXME RBC 20060210 either nuke revision_id for clone, or
2291
817
# emit some sort of warning/error to the caller ?!
2294
def open(self, a_bzrdir, name=None, _found=False, location=None,
2295
possible_transports=None, ignore_fallbacks=False):
820
def open(self, a_bzrdir, _found=False):
2296
821
"""Return the branch that the branch reference in a_bzrdir points at.
2298
:param a_bzrdir: A BzrDir that contains a branch.
2299
:param name: Name of colocated branch to open, if any
2300
:param _found: a private parameter, do not use it. It is used to
2301
indicate if format probing has already be done.
2302
:param ignore_fallbacks: when set, no fallback branches will be opened
2303
(if there are any). Default is to open fallbacks.
2304
:param location: The location of the referenced branch. If
2305
unspecified, this will be determined from the branch reference in
2307
:param possible_transports: An optional reusable transports list.
823
_found is a private parameter, do not use it. It is used to indicate
824
if format probing has already be done.
2310
format = BranchFormat.find_format(a_bzrdir, name=name)
2311
if format.__class__ != self.__class__:
2312
raise AssertionError("wrong format %r found for %r" %
2314
if location is None:
2315
location = self.get_reference(a_bzrdir, name)
2316
real_bzrdir = bzrdir.BzrDir.open(
2317
location, possible_transports=possible_transports)
2318
result = real_bzrdir.open_branch(name=name,
2319
ignore_fallbacks=ignore_fallbacks)
827
format = BranchFormat.find_format(a_bzrdir)
828
assert format.__class__ == self.__class__
829
transport = a_bzrdir.get_branch_transport(None)
830
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
831
result = real_bzrdir.open_branch()
2320
832
# this changes the behaviour of result.clone to create a new reference
2321
833
# rather than a copy of the content of the branch.
2322
834
# I did not use a proxy object because that needs much more extensive
2332
network_format_registry = registry.FormatRegistry()
2333
"""Registry of formats indexed by their network name.
2335
The network name for a branch format is an identifier that can be used when
2336
referring to formats with smart server operations. See
2337
BranchFormat.network_name() for more detail.
2341
844
# formats which have no format string are not discoverable
2342
845
# and not independently creatable, so are not registered.
2343
__format5 = BzrBranchFormat5()
2344
__format6 = BzrBranchFormat6()
2345
__format7 = BzrBranchFormat7()
2346
__format8 = BzrBranchFormat8()
2347
BranchFormat.register_format(__format5)
846
__default_format = BzrBranchFormat5()
847
BranchFormat.register_format(__default_format)
2348
848
BranchFormat.register_format(BranchReferenceFormat())
2349
BranchFormat.register_format(__format6)
2350
BranchFormat.register_format(__format7)
2351
BranchFormat.register_format(__format8)
2352
BranchFormat.set_default_format(__format7)
849
BranchFormat.set_default_format(__default_format)
2353
850
_legacy_formats = [BzrBranchFormat4(),
2355
network_format_registry.register(
2356
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2359
class BranchWriteLockResult(LogicalLockResult):
2360
"""The result of write locking a branch.
2362
:ivar branch_token: The token obtained from the underlying branch lock, or
2364
:ivar unlock: A callable which will unlock the lock.
2367
def __init__(self, unlock, branch_token):
2368
LogicalLockResult.__init__(self, unlock)
2369
self.branch_token = branch_token
2372
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2376
class BzrBranch(Branch, _RelockDebugMixin):
853
class BzrBranch(Branch):
2377
854
"""A branch stored in the actual filesystem.
2379
856
Note that it's "local" in the context of the filesystem; it doesn't
2380
857
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2381
858
it's writable, and can be accessed via the normal filesystem API.
2383
:ivar _transport: Transport for file operations on this branch's
2384
control files, typically pointing to the .bzr/branch directory.
2385
:ivar repository: Repository for this branch.
2386
:ivar base: The url of the base directory for this branch; the one
2387
containing the .bzr directory.
2388
:ivar name: Optional colocated branch name as it exists in the control
2392
def __init__(self, _format=None,
2393
_control_files=None, a_bzrdir=None, name=None,
2394
_repository=None, ignore_fallbacks=False):
2395
"""Create new branch object at a particular location."""
861
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
862
relax_version_check=DEPRECATED_PARAMETER, _format=None,
863
_control_files=None, a_bzrdir=None, _repository=None):
864
"""Create new branch object at a particular location.
866
transport -- A Transport object, defining how to access files.
868
init -- If True, create new control files in a previously
869
unversioned directory. If False, the branch must already
872
relax_version_check -- If true, the usual check for the branch
873
version is not applied. This is intended only for
874
upgrade/recovery type use; it's not guaranteed that
875
all operations will work on old format branches.
2396
877
if a_bzrdir is None:
2397
raise ValueError('a_bzrdir must be supplied')
878
self.bzrdir = bzrdir.BzrDir.open(transport.base)
2399
880
self.bzrdir = a_bzrdir
2400
self._base = self.bzrdir.transport.clone('..').base
2402
# XXX: We should be able to just do
2403
# self.base = self.bzrdir.root_transport.base
2404
# but this does not quite work yet -- mbp 20080522
881
self._transport = self.bzrdir.transport.clone('..')
882
self._base = self._transport.base
2405
883
self._format = _format
2406
884
if _control_files is None:
2407
885
raise ValueError('BzrBranch _control_files is None')
2408
886
self.control_files = _control_files
2409
self._transport = _control_files._transport
887
if deprecated_passed(init):
888
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
889
"deprecated as of bzr 0.8. Please use Branch.create().",
893
# this is slower than before deprecation, oh well never mind.
895
self._initialize(transport.base)
896
self._check_format(_format)
897
if deprecated_passed(relax_version_check):
898
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
899
"relax_version_check parameter is deprecated as of bzr 0.8. "
900
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
904
if (not relax_version_check
905
and not self._format.is_supported()):
906
raise errors.UnsupportedFormatError(format=fmt)
907
if deprecated_passed(transport):
908
warn("BzrBranch.__init__(transport=XXX...): The transport "
909
"parameter is deprecated as of bzr 0.8. "
910
"Please use Branch.open, or bzrdir.open_branch().",
2410
913
self.repository = _repository
2411
Branch.__init__(self)
2413
915
def __str__(self):
2414
if self.name is None:
2415
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2417
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
916
return '%s(%r)' % (self.__class__.__name__, self.base)
2420
918
__repr__ = __str__
921
# TODO: It might be best to do this somewhere else,
922
# but it is nice for a Branch object to automatically
923
# cache it's information.
924
# Alternatively, we could have the Transport objects cache requests
925
# See the earlier discussion about how major objects (like Branch)
926
# should never expect their __del__ function to run.
927
# XXX: cache_root seems to be unused, 2006-01-13 mbp
928
if hasattr(self, 'cache_root') and self.cache_root is not None:
930
osutils.rmtree(self.cache_root)
933
self.cache_root = None
2422
935
def _get_base(self):
2423
"""Returns the directory containing the control directory."""
2424
936
return self._base
2426
938
base = property(_get_base, doc="The URL for the root of this branch.")
2428
def _get_config(self):
2429
return TransportConfig(self._transport, 'branch.conf')
940
def _finish_transaction(self):
941
"""Exit the current transaction."""
942
return self.control_files._finish_transaction()
944
def get_transaction(self):
945
"""Return the current active transaction.
947
If no transaction is active, this returns a passthrough object
948
for which all data is immediately flushed and no caching happens.
950
# this is an explicit function so that we can do tricky stuff
951
# when the storage in rev_storage is elsewhere.
952
# we probably need to hook the two 'lock a location' and
953
# 'have a transaction' together more delicately, so that
954
# we can have two locks (branch and storage) and one transaction
955
# ... and finishing the transaction unlocks both, but unlocking
956
# does not. - RBC 20051121
957
return self.control_files.get_transaction()
959
def _set_transaction(self, transaction):
960
"""Set a new active transaction."""
961
return self.control_files._set_transaction(transaction)
963
def abspath(self, name):
964
"""See Branch.abspath."""
965
return self.control_files._transport.abspath(name)
967
def _check_format(self, format):
968
"""Identify the branch format if needed.
970
The format is stored as a reference to the format object in
971
self._format for code that needs to check it later.
973
The format parameter is either None or the branch format class
974
used to open this branch.
976
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
979
format = BranchFormat.find_format(self.bzrdir)
980
self._format = format
981
mutter("got branch format %s", self._format)
984
def get_root_id(self):
985
"""See Branch.get_root_id."""
986
tree = self.repository.revision_tree(self.last_revision())
987
return tree.inventory.root.file_id
2431
989
def is_locked(self):
2432
990
return self.control_files.is_locked()
2434
def lock_write(self, token=None):
2435
"""Lock the branch for write operations.
2437
:param token: A token to permit reacquiring a previously held and
2439
:return: A BranchWriteLockResult.
2441
if not self.is_locked():
2442
self._note_lock('w')
2443
# All-in-one needs to always unlock/lock.
2444
repo_control = getattr(self.repository, 'control_files', None)
2445
if self.control_files == repo_control or not self.is_locked():
2446
self.repository._warn_if_deprecated(self)
2447
self.repository.lock_write()
992
def lock_write(self):
993
self.repository.lock_write()
2452
return BranchWriteLockResult(self.unlock,
2453
self.control_files.lock_write(token=token))
995
self.control_files.lock_write()
2456
self.repository.unlock()
997
self.repository.unlock()
2459
1000
def lock_read(self):
2460
"""Lock the branch for read operations.
2462
:return: A bzrlib.lock.LogicalLockResult.
2464
if not self.is_locked():
2465
self._note_lock('r')
2466
# All-in-one needs to always unlock/lock.
2467
repo_control = getattr(self.repository, 'control_files', None)
2468
if self.control_files == repo_control or not self.is_locked():
2469
self.repository._warn_if_deprecated(self)
2470
self.repository.lock_read()
1001
self.repository.lock_read()
2475
1003
self.control_files.lock_read()
2476
return LogicalLockResult(self.unlock)
2479
self.repository.unlock()
1005
self.repository.unlock()
2482
@only_raises(errors.LockNotHeld, errors.LockBroken)
2483
1008
def unlock(self):
1009
# TODO: test for failed two phase locks. This is known broken.
2485
1011
self.control_files.unlock()
2487
# All-in-one needs to always unlock/lock.
2488
repo_control = getattr(self.repository, 'control_files', None)
2489
if (self.control_files == repo_control or
2490
not self.control_files.is_locked()):
2491
self.repository.unlock()
2492
if not self.control_files.is_locked():
2493
# we just released the lock
2494
self._clear_cached_state()
1013
self.repository.unlock()
2496
1015
def peek_lock_mode(self):
2497
1016
if self.control_files._lock_count == 0:
2507
1026
"""See Branch.print_file."""
2508
1027
return self.repository.print_file(file, revision_id)
2510
def _write_revision_history(self, history):
2511
"""Factored out of set_revision_history.
2513
This performs the actual writing to disk.
2514
It is intended to be called by BzrBranch5.set_revision_history."""
2515
self._transport.put_bytes(
2516
'revision-history', '\n'.join(history),
2517
mode=self.bzrdir._get_file_mode())
1030
def append_revision(self, *revision_ids):
1031
"""See Branch.append_revision."""
1032
for revision_id in revision_ids:
1033
mutter("add {%s} to revision-history" % revision_id)
1034
rev_history = self.revision_history()
1035
rev_history.extend(revision_ids)
1036
self.set_revision_history(rev_history)
2519
1038
@needs_write_lock
2520
1039
def set_revision_history(self, rev_history):
2521
1040
"""See Branch.set_revision_history."""
2522
if 'evil' in debug.debug_flags:
2523
mutter_callsite(3, "set_revision_history scales with history.")
2524
check_not_reserved_id = _mod_revision.check_not_reserved_id
2525
for rev_id in rev_history:
2526
check_not_reserved_id(rev_id)
2527
if Branch.hooks['post_change_branch_tip']:
2528
# Don't calculate the last_revision_info() if there are no hooks
2530
old_revno, old_revid = self.last_revision_info()
2531
if len(rev_history) == 0:
2532
revid = _mod_revision.NULL_REVISION
2534
revid = rev_history[-1]
2535
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2536
self._write_revision_history(rev_history)
2537
self._clear_cached_state()
2538
self._cache_revision_history(rev_history)
2539
for hook in Branch.hooks['set_rh']:
2540
hook(self, rev_history)
2541
if Branch.hooks['post_change_branch_tip']:
2542
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2544
def _synchronize_history(self, destination, revision_id):
2545
"""Synchronize last revision and revision history between branches.
2547
This version is most efficient when the destination is also a
2548
BzrBranch5, but works for BzrBranch6 as long as the revision
2549
history is the true lefthand parent history, and all of the revisions
2550
are in the destination's repository. If not, set_revision_history
2553
:param destination: The branch to copy the history into
2554
:param revision_id: The revision-id to truncate history at. May
2555
be None to copy complete history.
2557
if not isinstance(destination._format, BzrBranchFormat5):
2558
super(BzrBranch, self)._synchronize_history(
2559
destination, revision_id)
2561
if revision_id == _mod_revision.NULL_REVISION:
2564
new_history = self.revision_history()
2565
if revision_id is not None and new_history != []:
2567
new_history = new_history[:new_history.index(revision_id) + 1]
2569
rev = self.repository.get_revision(revision_id)
2570
new_history = rev.get_history(self.repository)[1:]
2571
destination.set_revision_history(new_history)
2574
def set_last_revision_info(self, revno, revision_id):
2575
"""Set the last revision of this branch.
2577
The caller is responsible for checking that the revno is correct
2578
for this revision id.
2580
It may be possible to set the branch last revision to an id not
2581
present in the repository. However, branches can also be
2582
configured to check constraints on history, in which case this may not
2585
revision_id = _mod_revision.ensure_null(revision_id)
2586
# this old format stores the full history, but this api doesn't
2587
# provide it, so we must generate, and might as well check it's
2589
history = self._lefthand_history(revision_id)
2590
if len(history) != revno:
2591
raise AssertionError('%d != %d' % (len(history), revno))
2592
self.set_revision_history(history)
2594
def _gen_revision_history(self):
2595
history = self._transport.get_bytes('revision-history').split('\n')
2596
if history[-1:] == ['']:
2597
# There shouldn't be a trailing newline, but just in case.
2602
def generate_revision_history(self, revision_id, last_rev=None,
1041
self.control_files.put_utf8(
1042
'revision-history', '\n'.join(rev_history))
1043
transaction = self.get_transaction()
1044
history = transaction.map.find_revision_history()
1045
if history is not None:
1046
# update the revision history in the identity map.
1047
history[:] = list(rev_history)
1048
# this call is disabled because revision_history is
1049
# not really an object yet, and the transaction is for objects.
1050
# transaction.register_dirty(history)
1052
transaction.map.add_revision_history(rev_history)
1053
# this call is disabled because revision_history is
1054
# not really an object yet, and the transaction is for objects.
1055
# transaction.register_clean(history)
1058
def revision_history(self):
1059
"""See Branch.revision_history."""
1060
transaction = self.get_transaction()
1061
history = transaction.map.find_revision_history()
1062
if history is not None:
1063
mutter("cache hit for revision-history in %s", self)
1064
return list(history)
1065
history = [l.rstrip('\r\n') for l in
1066
self.control_files.get_utf8('revision-history').readlines()]
1067
transaction.map.add_revision_history(history)
1068
# this call is disabled because revision_history is
1069
# not really an object yet, and the transaction is for objects.
1070
# transaction.register_clean(history, precious=True)
1071
return list(history)
1074
def generate_revision_history(self, revision_id, last_rev=None,
2603
1075
other_branch=None):
2604
1076
"""Create a new revision history that will finish with revision_id.
2606
1078
:param revision_id: the new tip to use.
2607
1079
:param last_rev: The previous last_revision. If not None, then this
2608
1080
must be a ancestory of revision_id, or DivergedBranches is raised.
2609
1081
:param other_branch: The other branch that DivergedBranches should
2610
1082
raise with respect to.
2612
self.set_revision_history(self._lefthand_history(revision_id,
2613
last_rev, other_branch))
1084
# stop_revision must be a descendant of last_revision
1085
stop_graph = self.repository.get_revision_graph(revision_id)
1086
if last_rev is not None and last_rev not in stop_graph:
1087
# our previous tip is not merged into stop_revision
1088
raise errors.DivergedBranches(self, other_branch)
1089
# make a new revision history from the graph
1090
current_rev_id = revision_id
1092
while current_rev_id not in (None, revision.NULL_REVISION):
1093
new_history.append(current_rev_id)
1094
current_rev_id_parents = stop_graph[current_rev_id]
1096
current_rev_id = current_rev_id_parents[0]
1098
current_rev_id = None
1099
new_history.reverse()
1100
self.set_revision_history(new_history)
1103
def update_revisions(self, other, stop_revision=None):
1104
"""See Branch.update_revisions."""
1107
if stop_revision is None:
1108
stop_revision = other.last_revision()
1109
if stop_revision is None:
1110
# if there are no commits, we're done.
1112
# whats the current last revision, before we fetch [and change it
1114
last_rev = self.last_revision()
1115
# we fetch here regardless of whether we need to so that we pickup
1117
self.fetch(other, stop_revision)
1118
my_ancestry = self.repository.get_ancestry(last_rev)
1119
if stop_revision in my_ancestry:
1120
# last_revision is a descendant of stop_revision
1122
self.generate_revision_history(stop_revision, last_rev=last_rev,
2615
1127
def basis_tree(self):
2616
1128
"""See Branch.basis_tree."""
2617
1129
return self.repository.revision_tree(self.last_revision())
2619
def _get_parent_location(self):
1131
@deprecated_method(zero_eight)
1132
def working_tree(self):
1133
"""Create a Working tree object for this branch."""
1135
from bzrlib.transport.local import LocalTransport
1136
if (self.base.find('://') != -1 or
1137
not isinstance(self._transport, LocalTransport)):
1138
raise NoWorkingTree(self.base)
1139
return self.bzrdir.open_workingtree()
1142
def pull(self, source, overwrite=False, stop_revision=None):
1143
"""See Branch.pull."""
1146
old_count = len(self.revision_history())
1148
self.update_revisions(source,stop_revision)
1149
except DivergedBranches:
1153
self.set_revision_history(source.revision_history())
1154
new_count = len(self.revision_history())
1155
return new_count - old_count
1159
def get_parent(self):
1160
"""See Branch.get_parent."""
2620
1162
_locs = ['parent', 'pull', 'x-pull']
1163
assert self.base[-1] == '/'
2621
1164
for l in _locs:
2623
return self._transport.get_bytes(l).strip('\n')
2624
except errors.NoSuchFile:
1166
parent = self.control_files.get(l).read().strip('\n')
1169
# This is an old-format absolute path to a local branch
1170
# turn it into a url
1171
if parent.startswith('/'):
1172
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1173
return urlutils.join(self.base[:-1], parent)
2628
def _basic_push(self, target, overwrite, stop_revision):
2629
"""Basic implementation of push without bound branches or hooks.
2631
Must be called with source read locked and target write locked.
2633
result = BranchPushResult()
2634
result.source_branch = self
2635
result.target_branch = target
2636
result.old_revno, result.old_revid = target.last_revision_info()
2637
self.update_references(target)
2638
if result.old_revid != self.last_revision():
2639
# We assume that during 'push' this repository is closer than
2641
graph = self.repository.get_graph(target.repository)
2642
target.update_revisions(self, stop_revision,
2643
overwrite=overwrite, graph=graph)
2644
if self._push_should_merge_tags():
2645
result.tag_conflicts = self.tags.merge_to(target.tags,
2647
result.new_revno, result.new_revid = target.last_revision_info()
2650
def get_stacked_on_url(self):
2651
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1176
def get_push_location(self):
1177
"""See Branch.get_push_location."""
1178
push_loc = self.get_config().get_user_option('push_location')
2653
1181
def set_push_location(self, location):
2654
1182
"""See Branch.set_push_location."""
2655
self.get_config().set_user_option(
2656
'push_location', location,
2657
store=_mod_config.STORE_LOCATION_NORECURSE)
1183
self.get_config().set_user_option('push_location', location,
2659
def _set_parent_location(self, url):
1187
def set_parent(self, url):
1188
"""See Branch.set_parent."""
1189
# TODO: Maybe delete old location files?
1190
# URLs should never be unicode, even on the local fs,
1191
# FIXUP this and get_parent in a future branch format bump:
1192
# read and rewrite the file, and have the new format code read
1193
# using .get not .get_utf8. RBC 20060125
2660
1194
if url is None:
2661
self._transport.delete('parent')
1195
self.control_files._transport.delete('parent')
2663
self._transport.put_bytes('parent', url + '\n',
2664
mode=self.bzrdir._get_file_mode())
1197
if isinstance(url, unicode):
1199
url = url.encode('ascii')
1200
except UnicodeEncodeError:
1201
raise bzrlib.errors.InvalidURL(url,
1202
"Urls must be 7-bit ascii, "
1203
"use bzrlib.urlutils.escape")
1205
url = urlutils.relative_url(self.base, url)
1206
self.control_files.put('parent', url + '\n')
1208
@deprecated_function(zero_nine)
1209
def tree_config(self):
1210
"""DEPRECATED; call get_config instead.
1211
TreeConfig has become part of BranchConfig."""
1212
return TreeConfig(self)
2667
1215
class BzrBranch5(BzrBranch):
2668
"""A format 5 branch. This supports new features over plain branches.
1216
"""A format 5 branch. This supports new features over plan branches.
2670
1218
It has support for a master_branch which is the data for bound branches.
1226
super(BzrBranch5, self).__init__(_format=_format,
1227
_control_files=_control_files,
1229
_repository=_repository)
1232
def pull(self, source, overwrite=False, stop_revision=None):
1233
"""Updates branch.pull to be bound branch aware."""
1234
bound_location = self.get_bound_location()
1235
if source.base != bound_location:
1236
# not pulling from master, so we need to update master.
1237
master_branch = self.get_master_branch()
1239
master_branch.pull(source)
1240
source = master_branch
1241
return super(BzrBranch5, self).pull(source, overwrite, stop_revision)
2673
1243
def get_bound_location(self):
2675
return self._transport.get_bytes('bound')[:-1]
1245
return self.control_files.get_utf8('bound').read()[:-1]
2676
1246
except errors.NoSuchFile:
2679
1249
@needs_read_lock
2680
def get_master_branch(self, possible_transports=None):
1250
def get_master_branch(self):
2681
1251
"""Return the branch we are bound to.
2683
1253
:return: Either a Branch, or None
2685
1255
This could memoise the branch, but if thats done
2745
1332
return self.set_bound_location(None)
2747
1334
@needs_write_lock
2748
def update(self, possible_transports=None):
2749
"""Synchronise this branch with the master branch if any.
1336
"""Synchronise this branch with the master branch if any.
2751
1338
:return: None or the last_revision that was pivoted out during the
2754
master = self.get_master_branch(possible_transports)
1341
master = self.get_master_branch()
2755
1342
if master is not None:
2756
old_tip = _mod_revision.ensure_null(self.last_revision())
1343
old_tip = self.last_revision()
2757
1344
self.pull(master, overwrite=True)
2758
if self.repository.get_graph().is_ancestor(old_tip,
2759
_mod_revision.ensure_null(self.last_revision())):
1345
if old_tip in self.repository.get_ancestry(self.last_revision()):
2765
class BzrBranch8(BzrBranch5):
2766
"""A branch that stores tree-reference locations."""
2768
def _open_hook(self):
2769
if self._ignore_fallbacks:
2772
url = self.get_stacked_on_url()
2773
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2774
errors.UnstackableBranchFormat):
2777
for hook in Branch.hooks['transform_fallback_location']:
2778
url = hook(self, url)
2780
hook_name = Branch.hooks.get_hook_name(hook)
2781
raise AssertionError(
2782
"'transform_fallback_location' hook %s returned "
2783
"None, not a URL." % hook_name)
2784
self._activate_fallback_location(url)
2786
def __init__(self, *args, **kwargs):
2787
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2788
super(BzrBranch8, self).__init__(*args, **kwargs)
2789
self._last_revision_info_cache = None
2790
self._reference_info = None
2792
def _clear_cached_state(self):
2793
super(BzrBranch8, self)._clear_cached_state()
2794
self._last_revision_info_cache = None
2795
self._reference_info = None
2797
def _last_revision_info(self):
2798
revision_string = self._transport.get_bytes('last-revision')
2799
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2800
revision_id = cache_utf8.get_cached_utf8(revision_id)
2802
return revno, revision_id
2804
def _write_last_revision_info(self, revno, revision_id):
2805
"""Simply write out the revision id, with no checks.
2807
Use set_last_revision_info to perform this safely.
2809
Does not update the revision_history cache.
2810
Intended to be called by set_last_revision_info and
2811
_write_revision_history.
2813
revision_id = _mod_revision.ensure_null(revision_id)
2814
out_string = '%d %s\n' % (revno, revision_id)
2815
self._transport.put_bytes('last-revision', out_string,
2816
mode=self.bzrdir._get_file_mode())
2819
def set_last_revision_info(self, revno, revision_id):
2820
revision_id = _mod_revision.ensure_null(revision_id)
2821
old_revno, old_revid = self.last_revision_info()
2822
if self._get_append_revisions_only():
2823
self._check_history_violation(revision_id)
2824
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2825
self._write_last_revision_info(revno, revision_id)
2826
self._clear_cached_state()
2827
self._last_revision_info_cache = revno, revision_id
2828
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2830
def _synchronize_history(self, destination, revision_id):
2831
"""Synchronize last revision and revision history between branches.
2833
:see: Branch._synchronize_history
2835
# XXX: The base Branch has a fast implementation of this method based
2836
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2837
# that uses set_revision_history. This class inherits from BzrBranch5,
2838
# but wants the fast implementation, so it calls
2839
# Branch._synchronize_history directly.
2840
Branch._synchronize_history(self, destination, revision_id)
2842
def _check_history_violation(self, revision_id):
2843
last_revision = _mod_revision.ensure_null(self.last_revision())
2844
if _mod_revision.is_null(last_revision):
2846
if last_revision not in self._lefthand_history(revision_id):
2847
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2849
def _gen_revision_history(self):
2850
"""Generate the revision history from last revision
2852
last_revno, last_revision = self.last_revision_info()
2853
self._extend_partial_history(stop_index=last_revno-1)
2854
return list(reversed(self._partial_revision_history_cache))
2856
def _write_revision_history(self, history):
2857
"""Factored out of set_revision_history.
2859
This performs the actual writing to disk, with format-specific checks.
2860
It is intended to be called by BzrBranch5.set_revision_history.
2862
if len(history) == 0:
2863
last_revision = 'null:'
2865
if history != self._lefthand_history(history[-1]):
2866
raise errors.NotLefthandHistory(history)
2867
last_revision = history[-1]
2868
if self._get_append_revisions_only():
2869
self._check_history_violation(last_revision)
2870
self._write_last_revision_info(len(history), last_revision)
2873
def _set_parent_location(self, url):
2874
"""Set the parent branch"""
2875
self._set_config_location('parent_location', url, make_relative=True)
2878
def _get_parent_location(self):
2879
"""Set the parent branch"""
2880
return self._get_config_location('parent_location')
2883
def _set_all_reference_info(self, info_dict):
2884
"""Replace all reference info stored in a branch.
2886
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2889
writer = rio.RioWriter(s)
2890
for key, (tree_path, branch_location) in info_dict.iteritems():
2891
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2892
branch_location=branch_location)
2893
writer.write_stanza(stanza)
2894
self._transport.put_bytes('references', s.getvalue())
2895
self._reference_info = info_dict
2898
def _get_all_reference_info(self):
2899
"""Return all the reference info stored in a branch.
2901
:return: A dict of {file_id: (tree_path, branch_location)}
2903
if self._reference_info is not None:
2904
return self._reference_info
2905
rio_file = self._transport.get('references')
2907
stanzas = rio.read_stanzas(rio_file)
2908
info_dict = dict((s['file_id'], (s['tree_path'],
2909
s['branch_location'])) for s in stanzas)
2912
self._reference_info = info_dict
2915
def set_reference_info(self, file_id, tree_path, branch_location):
2916
"""Set the branch location to use for a tree reference.
2918
:param file_id: The file-id of the tree reference.
2919
:param tree_path: The path of the tree reference in the tree.
2920
:param branch_location: The location of the branch to retrieve tree
2923
info_dict = self._get_all_reference_info()
2924
info_dict[file_id] = (tree_path, branch_location)
2925
if None in (tree_path, branch_location):
2926
if tree_path is not None:
2927
raise ValueError('tree_path must be None when branch_location'
2929
if branch_location is not None:
2930
raise ValueError('branch_location must be None when tree_path'
2932
del info_dict[file_id]
2933
self._set_all_reference_info(info_dict)
2935
def get_reference_info(self, file_id):
2936
"""Get the tree_path and branch_location for a tree reference.
2938
:return: a tuple of (tree_path, branch_location)
2940
return self._get_all_reference_info().get(file_id, (None, None))
2942
def reference_parent(self, file_id, path, possible_transports=None):
2943
"""Return the parent branch for a tree-reference file_id.
2945
:param file_id: The file_id of the tree reference
2946
:param path: The path of the file_id in the tree
2947
:return: A branch associated with the file_id
2949
branch_location = self.get_reference_info(file_id)[1]
2950
if branch_location is None:
2951
return Branch.reference_parent(self, file_id, path,
2952
possible_transports)
2953
branch_location = urlutils.join(self.user_url, branch_location)
2954
return Branch.open(branch_location,
2955
possible_transports=possible_transports)
2957
def set_push_location(self, location):
2958
"""See Branch.set_push_location."""
2959
self._set_config_location('push_location', location)
2961
def set_bound_location(self, location):
2962
"""See Branch.set_push_location."""
2964
config = self.get_config()
2965
if location is None:
2966
if config.get_user_option('bound') != 'True':
2969
config.set_user_option('bound', 'False', warn_masked=True)
2972
self._set_config_location('bound_location', location,
2974
config.set_user_option('bound', 'True', warn_masked=True)
2977
def _get_bound_location(self, bound):
2978
"""Return the bound location in the config file.
2980
Return None if the bound parameter does not match"""
2981
config = self.get_config()
2982
config_bound = (config.get_user_option('bound') == 'True')
2983
if config_bound != bound:
2985
return self._get_config_location('bound_location', config=config)
2987
def get_bound_location(self):
2988
"""See Branch.set_push_location."""
2989
return self._get_bound_location(True)
2991
def get_old_bound_location(self):
2992
"""See Branch.get_old_bound_location"""
2993
return self._get_bound_location(False)
2995
def get_stacked_on_url(self):
2996
# you can always ask for the URL; but you might not be able to use it
2997
# if the repo can't support stacking.
2998
## self._check_stackable_repo()
2999
stacked_url = self._get_config_location('stacked_on_location')
3000
if stacked_url is None:
3001
raise errors.NotStacked(self)
3004
def _get_append_revisions_only(self):
3005
return self.get_config(
3006
).get_user_option_as_bool('append_revisions_only')
3009
def generate_revision_history(self, revision_id, last_rev=None,
3011
"""See BzrBranch5.generate_revision_history"""
3012
history = self._lefthand_history(revision_id, last_rev, other_branch)
3013
revno = len(history)
3014
self.set_last_revision_info(revno, revision_id)
3017
def get_rev_id(self, revno, history=None):
3018
"""Find the revision id of the specified revno."""
3020
return _mod_revision.NULL_REVISION
3022
last_revno, last_revision_id = self.last_revision_info()
3023
if revno <= 0 or revno > last_revno:
3024
raise errors.NoSuchRevision(self, revno)
3026
if history is not None:
3027
return history[revno - 1]
3029
index = last_revno - revno
3030
if len(self._partial_revision_history_cache) <= index:
3031
self._extend_partial_history(stop_index=index)
3032
if len(self._partial_revision_history_cache) > index:
3033
return self._partial_revision_history_cache[index]
3035
raise errors.NoSuchRevision(self, revno)
3038
def revision_id_to_revno(self, revision_id):
3039
"""Given a revision id, return its revno"""
3040
if _mod_revision.is_null(revision_id):
3043
index = self._partial_revision_history_cache.index(revision_id)
3045
self._extend_partial_history(stop_revision=revision_id)
3046
index = len(self._partial_revision_history_cache) - 1
3047
if self._partial_revision_history_cache[index] != revision_id:
3048
raise errors.NoSuchRevision(self, revision_id)
3049
return self.revno() - index
3052
class BzrBranch7(BzrBranch8):
3053
"""A branch with support for a fallback repository."""
3055
def set_reference_info(self, file_id, tree_path, branch_location):
3056
Branch.set_reference_info(self, file_id, tree_path, branch_location)
3058
def get_reference_info(self, file_id):
3059
Branch.get_reference_info(self, file_id)
3061
def reference_parent(self, file_id, path, possible_transports=None):
3062
return Branch.reference_parent(self, file_id, path,
3063
possible_transports)
3066
class BzrBranch6(BzrBranch7):
3067
"""See BzrBranchFormat6 for the capabilities of this branch.
3069
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
3073
def get_stacked_on_url(self):
3074
raise errors.UnstackableBranchFormat(self._format, self.user_url)
3077
######################################################################
3078
# results of operations
3081
class _Result(object):
3083
def _show_tag_conficts(self, to_file):
3084
if not getattr(self, 'tag_conflicts', None):
3086
to_file.write('Conflicting tags:\n')
3087
for name, value1, value2 in self.tag_conflicts:
3088
to_file.write(' %s\n' % (name, ))
3091
class PullResult(_Result):
3092
"""Result of a Branch.pull operation.
3094
:ivar old_revno: Revision number before pull.
3095
:ivar new_revno: Revision number after pull.
3096
:ivar old_revid: Tip revision id before pull.
3097
:ivar new_revid: Tip revision id after pull.
3098
:ivar source_branch: Source (local) branch object. (read locked)
3099
:ivar master_branch: Master branch of the target, or the target if no
3101
:ivar local_branch: target branch if there is a Master, else None
3102
:ivar target_branch: Target/destination branch object. (write locked)
3103
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3107
# DEPRECATED: pull used to return the change in revno
3108
return self.new_revno - self.old_revno
3110
def report(self, to_file):
3112
if self.old_revid == self.new_revid:
3113
to_file.write('No revisions to pull.\n')
3115
to_file.write('Now on revision %d.\n' % self.new_revno)
3116
self._show_tag_conficts(to_file)
3119
class BranchPushResult(_Result):
3120
"""Result of a Branch.push operation.
3122
:ivar old_revno: Revision number (eg 10) of the target before push.
3123
:ivar new_revno: Revision number (eg 12) of the target after push.
3124
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3126
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3128
:ivar source_branch: Source branch object that the push was from. This is
3129
read locked, and generally is a local (and thus low latency) branch.
3130
:ivar master_branch: If target is a bound branch, the master branch of
3131
target, or target itself. Always write locked.
3132
:ivar target_branch: The direct Branch where data is being sent (write
3134
:ivar local_branch: If the target is a bound branch this will be the
3135
target, otherwise it will be None.
3139
# DEPRECATED: push used to return the change in revno
3140
return self.new_revno - self.old_revno
3142
def report(self, to_file):
3143
"""Write a human-readable description of the result."""
3144
if self.old_revid == self.new_revid:
3145
note('No new revisions to push.')
3147
note('Pushed up to revision %d.' % self.new_revno)
3148
self._show_tag_conficts(to_file)
1351
class BranchTestProviderAdapter(object):
1352
"""A tool to generate a suite testing multiple branch formats at once.
1354
This is done by copying the test once for each transport and injecting
1355
the transport_server, transport_readonly_server, and branch_format
1356
classes into each copy. Each copy is also given a new id() to make it
1360
def __init__(self, transport_server, transport_readonly_server, formats):
1361
self._transport_server = transport_server
1362
self._transport_readonly_server = transport_readonly_server
1363
self._formats = formats
1365
def adapt(self, test):
1366
result = TestSuite()
1367
for branch_format, bzrdir_format in self._formats:
1368
new_test = deepcopy(test)
1369
new_test.transport_server = self._transport_server
1370
new_test.transport_readonly_server = self._transport_readonly_server
1371
new_test.bzrdir_format = bzrdir_format
1372
new_test.branch_format = branch_format
1373
def make_new_test_id():
1374
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1375
return lambda: new_id
1376
new_test.id = make_new_test_id()
1377
result.addTest(new_test)
3151
1381
class BranchCheckResult(object):
3157
1387
def __init__(self, branch):
3158
1388
self.branch = branch
3161
1390
def report_results(self, verbose):
3162
1391
"""Report the check results via trace.note.
3164
1393
:param verbose: Requests more detailed display of what was checked,
3167
note('checked branch %s format %s', self.branch.user_url,
3168
self.branch._format)
3169
for error in self.errors:
3170
note('found error:%s', error)
3173
class Converter5to6(object):
3174
"""Perform an in-place upgrade of format 5 to format 6"""
3176
def convert(self, branch):
3177
# Data for 5 and 6 can peacefully coexist.
3178
format = BzrBranchFormat6()
3179
new_branch = format.open(branch.bzrdir, _found=True)
3181
# Copy source data into target
3182
new_branch._write_last_revision_info(*branch.last_revision_info())
3183
new_branch.set_parent(branch.get_parent())
3184
new_branch.set_bound_location(branch.get_bound_location())
3185
new_branch.set_push_location(branch.get_push_location())
3187
# New branch has no tags by default
3188
new_branch.tags._set_tag_dict({})
3190
# Copying done; now update target format
3191
new_branch._transport.put_bytes('format',
3192
format.get_format_string(),
3193
mode=new_branch.bzrdir._get_file_mode())
3195
# Clean up old files
3196
new_branch._transport.delete('revision-history')
3198
branch.set_parent(None)
3199
except errors.NoSuchFile:
3201
branch.set_bound_location(None)
3204
class Converter6to7(object):
3205
"""Perform an in-place upgrade of format 6 to format 7"""
3207
def convert(self, branch):
3208
format = BzrBranchFormat7()
3209
branch._set_config_location('stacked_on_location', '')
3210
# update target format
3211
branch._transport.put_bytes('format', format.get_format_string())
3214
class Converter7to8(object):
3215
"""Perform an in-place upgrade of format 6 to format 7"""
3217
def convert(self, branch):
3218
format = BzrBranchFormat8()
3219
branch._transport.put_bytes('references', '')
3220
# update target format
3221
branch._transport.put_bytes('format', format.get_format_string())
3224
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3225
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3228
_run_with_write_locked_target will attempt to release the lock it acquires.
3230
If an exception is raised by callable, then that exception *will* be
3231
propagated, even if the unlock attempt raises its own error. Thus
3232
_run_with_write_locked_target should be preferred to simply doing::
3236
return callable(*args, **kwargs)
3241
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3242
# should share code?
3245
result = callable(*args, **kwargs)
3247
exc_info = sys.exc_info()
3251
raise exc_info[0], exc_info[1], exc_info[2]
3257
class InterBranch(InterObject):
3258
"""This class represents operations taking place between two branches.
3260
Its instances have methods like pull() and push() and contain
3261
references to the source and target repositories these operations
3262
can be carried out on.
3266
"""The available optimised InterBranch types."""
3269
def _get_branch_formats_to_test(klass):
3270
"""Return an iterable of format tuples for testing.
3272
:return: An iterable of (from_format, to_format) to use when testing
3273
this InterBranch class. Each InterBranch class should define this
3276
raise NotImplementedError(klass._get_branch_formats_to_test)
3279
def pull(self, overwrite=False, stop_revision=None,
3280
possible_transports=None, local=False):
3281
"""Mirror source into target branch.
3283
The target branch is considered to be 'local', having low latency.
3285
:returns: PullResult instance
3287
raise NotImplementedError(self.pull)
3290
def update_revisions(self, stop_revision=None, overwrite=False,
3292
"""Pull in new perfect-fit revisions.
3294
:param stop_revision: Updated until the given revision
3295
:param overwrite: Always set the branch pointer, rather than checking
3296
to see if it is a proper descendant.
3297
:param graph: A Graph object that can be used to query history
3298
information. This can be None.
3301
raise NotImplementedError(self.update_revisions)
3304
def push(self, overwrite=False, stop_revision=None,
3305
_override_hook_source_branch=None):
3306
"""Mirror the source branch into the target branch.
3308
The source branch is considered to be 'local', having low latency.
3310
raise NotImplementedError(self.push)
3313
def copy_content_into(self, revision_id=None):
3314
"""Copy the content of source into target
3316
revision_id: if not None, the revision history in the new branch will
3317
be truncated to end with revision_id.
3319
raise NotImplementedError(self.copy_content_into)
3322
class GenericInterBranch(InterBranch):
3323
"""InterBranch implementation that uses public Branch functions."""
3326
def is_compatible(klass, source, target):
3327
# GenericBranch uses the public API, so always compatible
3331
def _get_branch_formats_to_test(klass):
3332
return [(BranchFormat._default_format, BranchFormat._default_format)]
3335
def unwrap_format(klass, format):
3336
if isinstance(format, remote.RemoteBranchFormat):
3337
format._ensure_real()
3338
return format._custom_format
3342
def copy_content_into(self, revision_id=None):
3343
"""Copy the content of source into target
3345
revision_id: if not None, the revision history in the new branch will
3346
be truncated to end with revision_id.
3348
self.source.update_references(self.target)
3349
self.source._synchronize_history(self.target, revision_id)
3351
parent = self.source.get_parent()
3352
except errors.InaccessibleParent, e:
3353
mutter('parent was not accessible to copy: %s', e)
3356
self.target.set_parent(parent)
3357
if self.source._push_should_merge_tags():
3358
self.source.tags.merge_to(self.target.tags)
3361
def update_revisions(self, stop_revision=None, overwrite=False,
3363
"""See InterBranch.update_revisions()."""
3364
other_revno, other_last_revision = self.source.last_revision_info()
3365
stop_revno = None # unknown
3366
if stop_revision is None:
3367
stop_revision = other_last_revision
3368
if _mod_revision.is_null(stop_revision):
3369
# if there are no commits, we're done.
3371
stop_revno = other_revno
3373
# what's the current last revision, before we fetch [and change it
3375
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3376
# we fetch here so that we don't process data twice in the common
3377
# case of having something to pull, and so that the check for
3378
# already merged can operate on the just fetched graph, which will
3379
# be cached in memory.
3380
self.target.fetch(self.source, stop_revision)
3381
# Check to see if one is an ancestor of the other
3384
graph = self.target.repository.get_graph()
3385
if self.target._check_if_descendant_or_diverged(
3386
stop_revision, last_rev, graph, self.source):
3387
# stop_revision is a descendant of last_rev, but we aren't
3388
# overwriting, so we're done.
3390
if stop_revno is None:
3392
graph = self.target.repository.get_graph()
3393
this_revno, this_last_revision = \
3394
self.target.last_revision_info()
3395
stop_revno = graph.find_distance_to_null(stop_revision,
3396
[(other_last_revision, other_revno),
3397
(this_last_revision, this_revno)])
3398
self.target.set_last_revision_info(stop_revno, stop_revision)
3401
def pull(self, overwrite=False, stop_revision=None,
3402
possible_transports=None, run_hooks=True,
3403
_override_hook_target=None, local=False):
3404
"""Pull from source into self, updating my master if any.
3406
:param run_hooks: Private parameter - if false, this branch
3407
is being called because it's the master of the primary branch,
3408
so it should not run its hooks.
3410
bound_location = self.target.get_bound_location()
3411
if local and not bound_location:
3412
raise errors.LocalRequiresBoundBranch()
3413
master_branch = None
3414
if not local and bound_location and self.source.user_url != bound_location:
3415
# not pulling from master, so we need to update master.
3416
master_branch = self.target.get_master_branch(possible_transports)
3417
master_branch.lock_write()
3420
# pull from source into master.
3421
master_branch.pull(self.source, overwrite, stop_revision,
3423
return self._pull(overwrite,
3424
stop_revision, _hook_master=master_branch,
3425
run_hooks=run_hooks,
3426
_override_hook_target=_override_hook_target)
3429
master_branch.unlock()
3431
def push(self, overwrite=False, stop_revision=None,
3432
_override_hook_source_branch=None):
3433
"""See InterBranch.push.
3435
This is the basic concrete implementation of push()
3437
:param _override_hook_source_branch: If specified, run
3438
the hooks passing this Branch as the source, rather than self.
3439
This is for use of RemoteBranch, where push is delegated to the
3440
underlying vfs-based Branch.
3442
# TODO: Public option to disable running hooks - should be trivial but
3444
self.source.lock_read()
3446
return _run_with_write_locked_target(
3447
self.target, self._push_with_bound_branches, overwrite,
3449
_override_hook_source_branch=_override_hook_source_branch)
3451
self.source.unlock()
3453
def _push_with_bound_branches(self, overwrite, stop_revision,
3454
_override_hook_source_branch=None):
3455
"""Push from source into target, and into target's master if any.
3458
if _override_hook_source_branch:
3459
result.source_branch = _override_hook_source_branch
3460
for hook in Branch.hooks['post_push']:
3463
bound_location = self.target.get_bound_location()
3464
if bound_location and self.target.base != bound_location:
3465
# there is a master branch.
3467
# XXX: Why the second check? Is it even supported for a branch to
3468
# be bound to itself? -- mbp 20070507
3469
master_branch = self.target.get_master_branch()
3470
master_branch.lock_write()
3472
# push into the master from the source branch.
3473
self.source._basic_push(master_branch, overwrite, stop_revision)
3474
# and push into the target branch from the source. Note that we
3475
# push from the source branch again, because its considered the
3476
# highest bandwidth repository.
3477
result = self.source._basic_push(self.target, overwrite,
3479
result.master_branch = master_branch
3480
result.local_branch = self.target
3484
master_branch.unlock()
3487
result = self.source._basic_push(self.target, overwrite,
3489
# TODO: Why set master_branch and local_branch if there's no
3490
# binding? Maybe cleaner to just leave them unset? -- mbp
3492
result.master_branch = self.target
3493
result.local_branch = None
3497
def _pull(self, overwrite=False, stop_revision=None,
3498
possible_transports=None, _hook_master=None, run_hooks=True,
3499
_override_hook_target=None, local=False):
3502
This function is the core worker, used by GenericInterBranch.pull to
3503
avoid duplication when pulling source->master and source->local.
3505
:param _hook_master: Private parameter - set the branch to
3506
be supplied as the master to pull hooks.
3507
:param run_hooks: Private parameter - if false, this branch
3508
is being called because it's the master of the primary branch,
3509
so it should not run its hooks.
3510
:param _override_hook_target: Private parameter - set the branch to be
3511
supplied as the target_branch to pull hooks.
3512
:param local: Only update the local branch, and not the bound branch.
3514
# This type of branch can't be bound.
3516
raise errors.LocalRequiresBoundBranch()
3517
result = PullResult()
3518
result.source_branch = self.source
3519
if _override_hook_target is None:
3520
result.target_branch = self.target
3522
result.target_branch = _override_hook_target
3523
self.source.lock_read()
3525
# We assume that during 'pull' the target repository is closer than
3527
self.source.update_references(self.target)
3528
graph = self.target.repository.get_graph(self.source.repository)
3529
# TODO: Branch formats should have a flag that indicates
3530
# that revno's are expensive, and pull() should honor that flag.
3532
result.old_revno, result.old_revid = \
3533
self.target.last_revision_info()
3534
self.target.update_revisions(self.source, stop_revision,
3535
overwrite=overwrite, graph=graph)
3536
# TODO: The old revid should be specified when merging tags,
3537
# so a tags implementation that versions tags can only
3538
# pull in the most recent changes. -- JRV20090506
3539
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3541
result.new_revno, result.new_revid = self.target.last_revision_info()
3543
result.master_branch = _hook_master
3544
result.local_branch = result.target_branch
3546
result.master_branch = result.target_branch
3547
result.local_branch = None
3549
for hook in Branch.hooks['post_pull']:
3552
self.source.unlock()
3556
InterBranch.register_optimiser(GenericInterBranch)
1396
note('checked branch %s format %s',
1398
self.branch._format)
1401
######################################################################
1405
@deprecated_function(zero_eight)
1406
def is_control_file(*args, **kwargs):
1407
"""See bzrlib.workingtree.is_control_file."""
1408
return bzrlib.workingtree.is_control_file(*args, **kwargs)