1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
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,
33
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TransportConfig
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
from bzrlib.hooks import HookPoint, Hooks
51
from bzrlib.inter import InterObject
52
from bzrlib.lock import _RelockDebugMixin
53
from bzrlib import registry
54
from bzrlib.symbol_versioning import (
58
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
61
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
62
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
66
# TODO: Maybe include checks for common corruption of newlines, etc?
68
# TODO: Some operations like log might retrieve the same revisions
69
# repeatedly to calculate deltas. We could perhaps have a weakref
70
# cache in memory to make this faster. In general anything can be
71
# cached in memory between lock and unlock operations. .. nb thats
72
# what the transaction identity map provides
75
######################################################################
79
"""Branch holding a history of revisions.
82
Base directory/url of the branch.
84
hooks: An instance of BranchHooks.
86
# this is really an instance variable - FIXME move it there
90
def __init__(self, *ignored, **ignored_too):
91
self.tags = self._format.make_tags(self)
92
self._revision_history_cache = None
93
self._revision_id_to_revno_cache = None
94
self._partial_revision_id_to_revno_cache = {}
95
self._partial_revision_history_cache = []
96
self._last_revision_info_cache = None
97
self._merge_sorted_revisions_cache = None
99
hooks = Branch.hooks['open']
103
def _open_hook(self):
104
"""Called by init to allow simpler extension of the base class."""
106
def _activate_fallback_location(self, url):
107
"""Activate the branch/repository from url as a fallback repository."""
108
repo = self._get_fallback_repository(url)
109
if repo.has_same_location(self.repository):
110
raise errors.UnstackableLocationError(self.base, url)
111
self.repository.add_fallback_repository(repo)
113
def break_lock(self):
114
"""Break a lock if one is present from another instance.
116
Uses the ui factory to ask for confirmation if the lock may be from
119
This will probe the repository for its lock as well.
121
self.control_files.break_lock()
122
self.repository.break_lock()
123
master = self.get_master_branch()
124
if master is not None:
127
def _check_stackable_repo(self):
128
if not self.repository._format.supports_external_lookups:
129
raise errors.UnstackableRepositoryFormat(self.repository._format,
130
self.repository.base)
132
def _extend_partial_history(self, stop_index=None, stop_revision=None):
133
"""Extend the partial history to include a given index
135
If a stop_index is supplied, stop when that index has been reached.
136
If a stop_revision is supplied, stop when that revision is
137
encountered. Otherwise, stop when the beginning of history is
140
:param stop_index: The index which should be present. When it is
141
present, history extension will stop.
142
:param stop_revision: The revision id which should be present. When
143
it is encountered, history extension will stop.
145
if len(self._partial_revision_history_cache) == 0:
146
self._partial_revision_history_cache = [self.last_revision()]
147
repository._iter_for_revno(
148
self.repository, self._partial_revision_history_cache,
149
stop_index=stop_index, stop_revision=stop_revision)
150
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
151
self._partial_revision_history_cache.pop()
153
def _get_check_refs(self):
154
"""Get the references needed for check().
158
revid = self.last_revision()
159
return [('revision-existence', revid), ('lefthand-distance', revid)]
162
def open(base, _unsupported=False, possible_transports=None):
163
"""Open the branch rooted at base.
165
For instance, if the branch is at URL/.bzr/branch,
166
Branch.open(URL) -> a Branch instance.
168
control = bzrdir.BzrDir.open(base, _unsupported,
169
possible_transports=possible_transports)
170
return control.open_branch(unsupported=_unsupported)
173
def open_from_transport(transport, name=None, _unsupported=False):
174
"""Open the branch rooted at transport"""
175
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
176
return control.open_branch(name=name, unsupported=_unsupported)
179
def open_containing(url, possible_transports=None):
180
"""Open an existing branch which contains url.
182
This probes for a branch at url, and searches upwards from there.
184
Basically we keep looking up until we find the control directory or
185
run into the root. If there isn't one, raises NotBranchError.
186
If there is one and it is either an unrecognised format or an unsupported
187
format, UnknownFormatError or UnsupportedFormatError are raised.
188
If there is one, it is returned, along with the unused portion of url.
190
control, relpath = bzrdir.BzrDir.open_containing(url,
192
return control.open_branch(), relpath
194
def _push_should_merge_tags(self):
195
"""Should _basic_push merge this branch's tags into the target?
197
The default implementation returns False if this branch has no tags,
198
and True the rest of the time. Subclasses may override this.
200
return self.supports_tags() and self.tags.get_tag_dict()
202
def get_config(self):
203
return BranchConfig(self)
205
def _get_config(self):
206
"""Get the concrete config for just the config in this branch.
208
This is not intended for client use; see Branch.get_config for the
213
:return: An object supporting get_option and set_option.
215
raise NotImplementedError(self._get_config)
217
def _get_fallback_repository(self, url):
218
"""Get the repository we fallback to at url."""
219
url = urlutils.join(self.base, url)
220
a_branch = Branch.open(url,
221
possible_transports=[self.bzrdir.root_transport])
222
return a_branch.repository
224
def _get_tags_bytes(self):
225
"""Get the bytes of a serialised tags dict.
227
Note that not all branches support tags, nor do all use the same tags
228
logic: this method is specific to BasicTags. Other tag implementations
229
may use the same method name and behave differently, safely, because
230
of the double-dispatch via
231
format.make_tags->tags_instance->get_tags_dict.
233
:return: The bytes of the tags file.
234
:seealso: Branch._set_tags_bytes.
236
return self._transport.get_bytes('tags')
238
def _get_nick(self, local=False, possible_transports=None):
239
config = self.get_config()
240
# explicit overrides master, but don't look for master if local is True
241
if not local and not config.has_explicit_nickname():
243
master = self.get_master_branch(possible_transports)
244
if master is not None:
245
# return the master branch value
247
except errors.BzrError, e:
248
# Silently fall back to local implicit nick if the master is
250
mutter("Could not connect to bound branch, "
251
"falling back to local nick.\n " + str(e))
252
return config.get_nickname()
254
def _set_nick(self, nick):
255
self.get_config().set_user_option('nickname', nick, warn_masked=True)
257
nick = property(_get_nick, _set_nick)
260
raise NotImplementedError(self.is_locked)
262
def _lefthand_history(self, revision_id, last_rev=None,
264
if 'evil' in debug.debug_flags:
265
mutter_callsite(4, "_lefthand_history scales with history.")
266
# stop_revision must be a descendant of last_revision
267
graph = self.repository.get_graph()
268
if last_rev is not None:
269
if not graph.is_ancestor(last_rev, revision_id):
270
# our previous tip is not merged into stop_revision
271
raise errors.DivergedBranches(self, other_branch)
272
# make a new revision history from the graph
273
parents_map = graph.get_parent_map([revision_id])
274
if revision_id not in parents_map:
275
raise errors.NoSuchRevision(self, revision_id)
276
current_rev_id = revision_id
278
check_not_reserved_id = _mod_revision.check_not_reserved_id
279
# Do not include ghosts or graph origin in revision_history
280
while (current_rev_id in parents_map and
281
len(parents_map[current_rev_id]) > 0):
282
check_not_reserved_id(current_rev_id)
283
new_history.append(current_rev_id)
284
current_rev_id = parents_map[current_rev_id][0]
285
parents_map = graph.get_parent_map([current_rev_id])
286
new_history.reverse()
289
def lock_write(self):
290
raise NotImplementedError(self.lock_write)
293
raise NotImplementedError(self.lock_read)
296
raise NotImplementedError(self.unlock)
298
def peek_lock_mode(self):
299
"""Return lock mode for the Branch: 'r', 'w' or None"""
300
raise NotImplementedError(self.peek_lock_mode)
302
def get_physical_lock_status(self):
303
raise NotImplementedError(self.get_physical_lock_status)
306
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
307
"""Return the revision_id for a dotted revno.
309
:param revno: a tuple like (1,) or (1,1,2)
310
:param _cache_reverse: a private parameter enabling storage
311
of the reverse mapping in a top level cache. (This should
312
only be done in selective circumstances as we want to
313
avoid having the mapping cached multiple times.)
314
:return: the revision_id
315
:raises errors.NoSuchRevision: if the revno doesn't exist
317
rev_id = self._do_dotted_revno_to_revision_id(revno)
319
self._partial_revision_id_to_revno_cache[rev_id] = revno
322
def _do_dotted_revno_to_revision_id(self, revno):
323
"""Worker function for dotted_revno_to_revision_id.
325
Subclasses should override this if they wish to
326
provide a more efficient implementation.
329
return self.get_rev_id(revno[0])
330
revision_id_to_revno = self.get_revision_id_to_revno_map()
331
revision_ids = [revision_id for revision_id, this_revno
332
in revision_id_to_revno.iteritems()
333
if revno == this_revno]
334
if len(revision_ids) == 1:
335
return revision_ids[0]
337
revno_str = '.'.join(map(str, revno))
338
raise errors.NoSuchRevision(self, revno_str)
341
def revision_id_to_dotted_revno(self, revision_id):
342
"""Given a revision id, return its dotted revno.
344
:return: a tuple like (1,) or (400,1,3).
346
return self._do_revision_id_to_dotted_revno(revision_id)
348
def _do_revision_id_to_dotted_revno(self, revision_id):
349
"""Worker function for revision_id_to_revno."""
350
# Try the caches if they are loaded
351
result = self._partial_revision_id_to_revno_cache.get(revision_id)
352
if result is not None:
354
if self._revision_id_to_revno_cache:
355
result = self._revision_id_to_revno_cache.get(revision_id)
357
raise errors.NoSuchRevision(self, revision_id)
358
# Try the mainline as it's optimised
360
revno = self.revision_id_to_revno(revision_id)
362
except errors.NoSuchRevision:
363
# We need to load and use the full revno map after all
364
result = self.get_revision_id_to_revno_map().get(revision_id)
366
raise errors.NoSuchRevision(self, revision_id)
370
def get_revision_id_to_revno_map(self):
371
"""Return the revision_id => dotted revno map.
373
This will be regenerated on demand, but will be cached.
375
:return: A dictionary mapping revision_id => dotted revno.
376
This dictionary should not be modified by the caller.
378
if self._revision_id_to_revno_cache is not None:
379
mapping = self._revision_id_to_revno_cache
381
mapping = self._gen_revno_map()
382
self._cache_revision_id_to_revno(mapping)
383
# TODO: jam 20070417 Since this is being cached, should we be returning
385
# I would rather not, and instead just declare that users should not
386
# modify the return value.
389
def _gen_revno_map(self):
390
"""Create a new mapping from revision ids to dotted revnos.
392
Dotted revnos are generated based on the current tip in the revision
394
This is the worker function for get_revision_id_to_revno_map, which
395
just caches the return value.
397
:return: A dictionary mapping revision_id => dotted revno.
399
revision_id_to_revno = dict((rev_id, revno)
400
for rev_id, depth, revno, end_of_merge
401
in self.iter_merge_sorted_revisions())
402
return revision_id_to_revno
405
def iter_merge_sorted_revisions(self, start_revision_id=None,
406
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
407
"""Walk the revisions for a branch in merge sorted order.
409
Merge sorted order is the output from a merge-aware,
410
topological sort, i.e. all parents come before their
411
children going forward; the opposite for reverse.
413
:param start_revision_id: the revision_id to begin walking from.
414
If None, the branch tip is used.
415
:param stop_revision_id: the revision_id to terminate the walk
416
after. If None, the rest of history is included.
417
:param stop_rule: if stop_revision_id is not None, the precise rule
418
to use for termination:
419
* 'exclude' - leave the stop revision out of the result (default)
420
* 'include' - the stop revision is the last item in the result
421
* 'with-merges' - include the stop revision and all of its
422
merged revisions in the result
423
:param direction: either 'reverse' or 'forward':
424
* reverse means return the start_revision_id first, i.e.
425
start at the most recent revision and go backwards in history
426
* forward returns tuples in the opposite order to reverse.
427
Note in particular that forward does *not* do any intelligent
428
ordering w.r.t. depth as some clients of this API may like.
429
(If required, that ought to be done at higher layers.)
431
:return: an iterator over (revision_id, depth, revno, end_of_merge)
434
* revision_id: the unique id of the revision
435
* depth: How many levels of merging deep this node has been
437
* revno_sequence: This field provides a sequence of
438
revision numbers for all revisions. The format is:
439
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
440
branch that the revno is on. From left to right the REVNO numbers
441
are the sequence numbers within that branch of the revision.
442
* end_of_merge: When True the next node (earlier in history) is
443
part of a different merge.
445
# Note: depth and revno values are in the context of the branch so
446
# we need the full graph to get stable numbers, regardless of the
448
if self._merge_sorted_revisions_cache is None:
449
last_revision = self.last_revision()
450
known_graph = self.repository.get_known_graph_ancestry(
452
self._merge_sorted_revisions_cache = known_graph.merge_sort(
454
filtered = self._filter_merge_sorted_revisions(
455
self._merge_sorted_revisions_cache, start_revision_id,
456
stop_revision_id, stop_rule)
457
# Make sure we don't return revisions that are not part of the
458
# start_revision_id ancestry.
459
filtered = self._filter_non_ancestors(filtered)
460
if direction == 'reverse':
462
if direction == 'forward':
463
return reversed(list(filtered))
465
raise ValueError('invalid direction %r' % direction)
467
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
468
start_revision_id, stop_revision_id, stop_rule):
469
"""Iterate over an inclusive range of sorted revisions."""
470
rev_iter = iter(merge_sorted_revisions)
471
if start_revision_id is not None:
472
for node in rev_iter:
473
rev_id = node.key[-1]
474
if rev_id != start_revision_id:
477
# The decision to include the start or not
478
# depends on the stop_rule if a stop is provided
479
# so pop this node back into the iterator
480
rev_iter = chain(iter([node]), rev_iter)
482
if stop_revision_id is None:
484
for node in rev_iter:
485
rev_id = node.key[-1]
486
yield (rev_id, node.merge_depth, node.revno,
488
elif stop_rule == 'exclude':
489
for node in rev_iter:
490
rev_id = node.key[-1]
491
if rev_id == stop_revision_id:
493
yield (rev_id, node.merge_depth, node.revno,
495
elif stop_rule == 'include':
496
for node in rev_iter:
497
rev_id = node.key[-1]
498
yield (rev_id, node.merge_depth, node.revno,
500
if rev_id == stop_revision_id:
502
elif stop_rule == 'with-merges':
503
stop_rev = self.repository.get_revision(stop_revision_id)
504
if stop_rev.parent_ids:
505
left_parent = stop_rev.parent_ids[0]
507
left_parent = _mod_revision.NULL_REVISION
508
# left_parent is the actual revision we want to stop logging at,
509
# since we want to show the merged revisions after the stop_rev too
510
reached_stop_revision_id = False
511
revision_id_whitelist = []
512
for node in rev_iter:
513
rev_id = node.key[-1]
514
if rev_id == left_parent:
515
# reached the left parent after the stop_revision
517
if (not reached_stop_revision_id or
518
rev_id in revision_id_whitelist):
519
yield (rev_id, node.merge_depth, node.revno,
521
if reached_stop_revision_id or rev_id == stop_revision_id:
522
# only do the merged revs of rev_id from now on
523
rev = self.repository.get_revision(rev_id)
525
reached_stop_revision_id = True
526
revision_id_whitelist.extend(rev.parent_ids)
528
raise ValueError('invalid stop_rule %r' % stop_rule)
530
def _filter_non_ancestors(self, rev_iter):
531
# If we started from a dotted revno, we want to consider it as a tip
532
# and don't want to yield revisions that are not part of its
533
# ancestry. Given the order guaranteed by the merge sort, we will see
534
# uninteresting descendants of the first parent of our tip before the
536
first = rev_iter.next()
537
(rev_id, merge_depth, revno, end_of_merge) = first
540
# We start at a mainline revision so by definition, all others
541
# revisions in rev_iter are ancestors
542
for node in rev_iter:
547
pmap = self.repository.get_parent_map([rev_id])
548
parents = pmap.get(rev_id, [])
550
whitelist.update(parents)
552
# If there is no parents, there is nothing of interest left
554
# FIXME: It's hard to test this scenario here as this code is never
555
# called in that case. -- vila 20100322
558
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
560
if rev_id in whitelist:
561
pmap = self.repository.get_parent_map([rev_id])
562
parents = pmap.get(rev_id, [])
563
whitelist.remove(rev_id)
564
whitelist.update(parents)
566
# We've reached the mainline, there is nothing left to
570
# A revision that is not part of the ancestry of our
573
yield (rev_id, merge_depth, revno, end_of_merge)
575
def leave_lock_in_place(self):
576
"""Tell this branch object not to release the physical lock when this
579
If lock_write doesn't return a token, then this method is not supported.
581
self.control_files.leave_in_place()
583
def dont_leave_lock_in_place(self):
584
"""Tell this branch object to release the physical lock when this
585
object is unlocked, even if it didn't originally acquire it.
587
If lock_write doesn't return a token, then this method is not supported.
589
self.control_files.dont_leave_in_place()
591
def bind(self, other):
592
"""Bind the local branch the other branch.
594
:param other: The branch to bind to
597
raise errors.UpgradeRequired(self.base)
599
def set_append_revisions_only(self, enabled):
600
if not self._format.supports_set_append_revisions_only():
601
raise errors.UpgradeRequired(self.base)
606
self.get_config().set_user_option('append_revisions_only', value,
609
def set_reference_info(self, file_id, tree_path, branch_location):
610
"""Set the branch location to use for a tree reference."""
611
raise errors.UnsupportedOperation(self.set_reference_info, self)
613
def get_reference_info(self, file_id):
614
"""Get the tree_path and branch_location for a tree reference."""
615
raise errors.UnsupportedOperation(self.get_reference_info, self)
618
def fetch(self, from_branch, last_revision=None, pb=None):
619
"""Copy revisions from from_branch into this branch.
621
:param from_branch: Where to copy from.
622
:param last_revision: What revision to stop at (None for at the end
624
:param pb: An optional progress bar to use.
627
if self.base == from_branch.base:
630
symbol_versioning.warn(
631
symbol_versioning.deprecated_in((1, 14, 0))
632
% "pb parameter to fetch()")
633
from_branch.lock_read()
635
if last_revision is None:
636
last_revision = from_branch.last_revision()
637
last_revision = _mod_revision.ensure_null(last_revision)
638
return self.repository.fetch(from_branch.repository,
639
revision_id=last_revision,
644
def get_bound_location(self):
645
"""Return the URL of the branch we are bound to.
647
Older format branches cannot bind, please be sure to use a metadir
652
def get_old_bound_location(self):
653
"""Return the URL of the branch we used to be bound to
655
raise errors.UpgradeRequired(self.base)
657
def get_commit_builder(self, parents, config=None, timestamp=None,
658
timezone=None, committer=None, revprops=None,
660
"""Obtain a CommitBuilder for this branch.
662
:param parents: Revision ids of the parents of the new revision.
663
:param config: Optional configuration to use.
664
:param timestamp: Optional timestamp recorded for commit.
665
:param timezone: Optional timezone for timestamp.
666
:param committer: Optional committer to set for commit.
667
:param revprops: Optional dictionary of revision properties.
668
:param revision_id: Optional revision id.
672
config = self.get_config()
674
return self.repository.get_commit_builder(self, parents, config,
675
timestamp, timezone, committer, revprops, revision_id)
677
def get_master_branch(self, possible_transports=None):
678
"""Return the branch we are bound to.
680
:return: Either a Branch, or None
684
def get_revision_delta(self, revno):
685
"""Return the delta for one revision.
687
The delta is relative to its mainline predecessor, or the
688
empty tree for revision 1.
690
rh = self.revision_history()
691
if not (1 <= revno <= len(rh)):
692
raise errors.InvalidRevisionNumber(revno)
693
return self.repository.get_revision_delta(rh[revno-1])
695
def get_stacked_on_url(self):
696
"""Get the URL this branch is stacked against.
698
:raises NotStacked: If the branch is not stacked.
699
:raises UnstackableBranchFormat: If the branch does not support
702
raise NotImplementedError(self.get_stacked_on_url)
704
def print_file(self, file, revision_id):
705
"""Print `file` to stdout."""
706
raise NotImplementedError(self.print_file)
708
def set_revision_history(self, rev_history):
709
raise NotImplementedError(self.set_revision_history)
712
def set_parent(self, url):
713
"""See Branch.set_parent."""
714
# TODO: Maybe delete old location files?
715
# URLs should never be unicode, even on the local fs,
716
# FIXUP this and get_parent in a future branch format bump:
717
# read and rewrite the file. RBC 20060125
719
if isinstance(url, unicode):
721
url = url.encode('ascii')
722
except UnicodeEncodeError:
723
raise errors.InvalidURL(url,
724
"Urls must be 7-bit ascii, "
725
"use bzrlib.urlutils.escape")
726
url = urlutils.relative_url(self.base, url)
727
self._set_parent_location(url)
730
def set_stacked_on_url(self, url):
731
"""Set the URL this branch is stacked against.
733
:raises UnstackableBranchFormat: If the branch does not support
735
:raises UnstackableRepositoryFormat: If the repository does not support
738
if not self._format.supports_stacking():
739
raise errors.UnstackableBranchFormat(self._format, self.base)
740
# XXX: Changing from one fallback repository to another does not check
741
# that all the data you need is present in the new fallback.
742
# Possibly it should.
743
self._check_stackable_repo()
746
old_url = self.get_stacked_on_url()
747
except (errors.NotStacked, errors.UnstackableBranchFormat,
748
errors.UnstackableRepositoryFormat):
752
self._activate_fallback_location(url)
753
# write this out after the repository is stacked to avoid setting a
754
# stacked config that doesn't work.
755
self._set_config_location('stacked_on_location', url)
758
"""Change a branch to be unstacked, copying data as needed.
760
Don't call this directly, use set_stacked_on_url(None).
762
pb = ui.ui_factory.nested_progress_bar()
764
pb.update("Unstacking")
765
# The basic approach here is to fetch the tip of the branch,
766
# including all available ghosts, from the existing stacked
767
# repository into a new repository object without the fallbacks.
769
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
770
# correct for CHKMap repostiories
771
old_repository = self.repository
772
if len(old_repository._fallback_repositories) != 1:
773
raise AssertionError("can't cope with fallback repositories "
774
"of %r" % (self.repository,))
775
# unlock it, including unlocking the fallback
776
old_repository.unlock()
777
old_repository.lock_read()
779
# Repositories don't offer an interface to remove fallback
780
# repositories today; take the conceptually simpler option and just
781
# reopen it. We reopen it starting from the URL so that we
782
# get a separate connection for RemoteRepositories and can
783
# stream from one of them to the other. This does mean doing
784
# separate SSH connection setup, but unstacking is not a
785
# common operation so it's tolerable.
786
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
787
new_repository = new_bzrdir.find_repository()
788
self.repository = new_repository
789
if self.repository._fallback_repositories:
790
raise AssertionError("didn't expect %r to have "
791
"fallback_repositories"
792
% (self.repository,))
793
# this is not paired with an unlock because it's just restoring
794
# the previous state; the lock's released when set_stacked_on_url
796
self.repository.lock_write()
797
# XXX: If you unstack a branch while it has a working tree
798
# with a pending merge, the pending-merged revisions will no
799
# longer be present. You can (probably) revert and remerge.
801
# XXX: This only fetches up to the tip of the repository; it
802
# doesn't bring across any tags. That's fairly consistent
803
# with how branch works, but perhaps not ideal.
804
self.repository.fetch(old_repository,
805
revision_id=self.last_revision(),
808
old_repository.unlock()
812
def _set_tags_bytes(self, bytes):
813
"""Mirror method for _get_tags_bytes.
815
:seealso: Branch._get_tags_bytes.
817
return _run_with_write_locked_target(self, self._transport.put_bytes,
820
def _cache_revision_history(self, rev_history):
821
"""Set the cached revision history to rev_history.
823
The revision_history method will use this cache to avoid regenerating
824
the revision history.
826
This API is semi-public; it only for use by subclasses, all other code
827
should consider it to be private.
829
self._revision_history_cache = rev_history
831
def _cache_revision_id_to_revno(self, revision_id_to_revno):
832
"""Set the cached revision_id => revno map to revision_id_to_revno.
834
This API is semi-public; it only for use by subclasses, all other code
835
should consider it to be private.
837
self._revision_id_to_revno_cache = revision_id_to_revno
839
def _clear_cached_state(self):
840
"""Clear any cached data on this branch, e.g. cached revision history.
842
This means the next call to revision_history will need to call
843
_gen_revision_history.
845
This API is semi-public; it only for use by subclasses, all other code
846
should consider it to be private.
848
self._revision_history_cache = None
849
self._revision_id_to_revno_cache = None
850
self._last_revision_info_cache = None
851
self._merge_sorted_revisions_cache = None
852
self._partial_revision_history_cache = []
853
self._partial_revision_id_to_revno_cache = {}
855
def _gen_revision_history(self):
856
"""Return sequence of revision hashes on to this branch.
858
Unlike revision_history, this method always regenerates or rereads the
859
revision history, i.e. it does not cache the result, so repeated calls
862
Concrete subclasses should override this instead of revision_history so
863
that subclasses do not need to deal with caching logic.
865
This API is semi-public; it only for use by subclasses, all other code
866
should consider it to be private.
868
raise NotImplementedError(self._gen_revision_history)
871
def revision_history(self):
872
"""Return sequence of revision ids on this branch.
874
This method will cache the revision history for as long as it is safe to
877
if 'evil' in debug.debug_flags:
878
mutter_callsite(3, "revision_history scales with history.")
879
if self._revision_history_cache is not None:
880
history = self._revision_history_cache
882
history = self._gen_revision_history()
883
self._cache_revision_history(history)
887
"""Return current revision number for this branch.
889
That is equivalent to the number of revisions committed to
892
return self.last_revision_info()[0]
895
"""Older format branches cannot bind or unbind."""
896
raise errors.UpgradeRequired(self.base)
898
def last_revision(self):
899
"""Return last revision id, or NULL_REVISION."""
900
return self.last_revision_info()[1]
903
def last_revision_info(self):
904
"""Return information about the last revision.
906
:return: A tuple (revno, revision_id).
908
if self._last_revision_info_cache is None:
909
self._last_revision_info_cache = self._last_revision_info()
910
return self._last_revision_info_cache
912
def _last_revision_info(self):
913
rh = self.revision_history()
916
return (revno, rh[-1])
918
return (0, _mod_revision.NULL_REVISION)
920
@deprecated_method(deprecated_in((1, 6, 0)))
921
def missing_revisions(self, other, stop_revision=None):
922
"""Return a list of new revisions that would perfectly fit.
924
If self and other have not diverged, return a list of the revisions
925
present in other, but missing from self.
927
self_history = self.revision_history()
928
self_len = len(self_history)
929
other_history = other.revision_history()
930
other_len = len(other_history)
931
common_index = min(self_len, other_len) -1
932
if common_index >= 0 and \
933
self_history[common_index] != other_history[common_index]:
934
raise errors.DivergedBranches(self, other)
936
if stop_revision is None:
937
stop_revision = other_len
939
if stop_revision > other_len:
940
raise errors.NoSuchRevision(self, stop_revision)
941
return other_history[self_len:stop_revision]
944
def update_revisions(self, other, stop_revision=None, overwrite=False,
946
"""Pull in new perfect-fit revisions.
948
:param other: Another Branch to pull from
949
:param stop_revision: Updated until the given revision
950
:param overwrite: Always set the branch pointer, rather than checking
951
to see if it is a proper descendant.
952
:param graph: A Graph object that can be used to query history
953
information. This can be None.
956
return InterBranch.get(other, self).update_revisions(stop_revision,
959
def import_last_revision_info(self, source_repo, revno, revid):
960
"""Set the last revision info, importing from another repo if necessary.
962
This is used by the bound branch code to upload a revision to
963
the master branch first before updating the tip of the local branch.
965
:param source_repo: Source repository to optionally fetch from
966
:param revno: Revision number of the new tip
967
:param revid: Revision id of the new tip
969
if not self.repository.has_same_location(source_repo):
970
self.repository.fetch(source_repo, revision_id=revid)
971
self.set_last_revision_info(revno, revid)
973
def revision_id_to_revno(self, revision_id):
974
"""Given a revision id, return its revno"""
975
if _mod_revision.is_null(revision_id):
977
history = self.revision_history()
979
return history.index(revision_id) + 1
981
raise errors.NoSuchRevision(self, revision_id)
984
def get_rev_id(self, revno, history=None):
985
"""Find the revision id of the specified revno."""
987
return _mod_revision.NULL_REVISION
988
last_revno, last_revid = self.last_revision_info()
989
if revno == last_revno:
991
if revno <= 0 or revno > last_revno:
992
raise errors.NoSuchRevision(self, revno)
993
distance_from_last = last_revno - revno
994
if len(self._partial_revision_history_cache) <= distance_from_last:
995
self._extend_partial_history(distance_from_last)
996
return self._partial_revision_history_cache[distance_from_last]
999
def pull(self, source, overwrite=False, stop_revision=None,
1000
possible_transports=None, *args, **kwargs):
1001
"""Mirror source into this branch.
1003
This branch is considered to be 'local', having low latency.
1005
:returns: PullResult instance
1007
return InterBranch.get(source, self).pull(overwrite=overwrite,
1008
stop_revision=stop_revision,
1009
possible_transports=possible_transports, *args, **kwargs)
1011
def push(self, target, overwrite=False, stop_revision=None, *args,
1013
"""Mirror this branch into target.
1015
This branch is considered to be 'local', having low latency.
1017
return InterBranch.get(self, target).push(overwrite, stop_revision,
1020
def lossy_push(self, target, stop_revision=None):
1021
"""Push deltas into another branch.
1023
:note: This does not, like push, retain the revision ids from
1024
the source branch and will, rather than adding bzr-specific
1025
metadata, push only those semantics of the revision that can be
1026
natively represented by this branch' VCS.
1028
:param target: Target branch
1029
:param stop_revision: Revision to push, defaults to last revision.
1030
:return: BranchPushResult with an extra member revidmap:
1031
A dictionary mapping revision ids from the target branch
1032
to new revision ids in the target branch, for each
1033
revision that was pushed.
1035
inter = InterBranch.get(self, target)
1036
lossy_push = getattr(inter, "lossy_push", None)
1037
if lossy_push is None:
1038
raise errors.LossyPushToSameVCS(self, target)
1039
return lossy_push(stop_revision)
1041
def basis_tree(self):
1042
"""Return `Tree` object for last revision."""
1043
return self.repository.revision_tree(self.last_revision())
1045
def get_parent(self):
1046
"""Return the parent location of the branch.
1048
This is the default location for pull/missing. The usual
1049
pattern is that the user can override it by specifying a
1052
parent = self._get_parent_location()
1055
# This is an old-format absolute path to a local branch
1056
# turn it into a url
1057
if parent.startswith('/'):
1058
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1060
return urlutils.join(self.base[:-1], parent)
1061
except errors.InvalidURLJoin, e:
1062
raise errors.InaccessibleParent(parent, self.base)
1064
def _get_parent_location(self):
1065
raise NotImplementedError(self._get_parent_location)
1067
def _set_config_location(self, name, url, config=None,
1068
make_relative=False):
1070
config = self.get_config()
1074
url = urlutils.relative_url(self.base, url)
1075
config.set_user_option(name, url, warn_masked=True)
1077
def _get_config_location(self, name, config=None):
1079
config = self.get_config()
1080
location = config.get_user_option(name)
1085
def get_child_submit_format(self):
1086
"""Return the preferred format of submissions to this branch."""
1087
return self.get_config().get_user_option("child_submit_format")
1089
def get_submit_branch(self):
1090
"""Return the submit location of the branch.
1092
This is the default location for bundle. The usual
1093
pattern is that the user can override it by specifying a
1096
return self.get_config().get_user_option('submit_branch')
1098
def set_submit_branch(self, location):
1099
"""Return the submit location of the branch.
1101
This is the default location for bundle. The usual
1102
pattern is that the user can override it by specifying a
1105
self.get_config().set_user_option('submit_branch', location,
1108
def get_public_branch(self):
1109
"""Return the public location of the branch.
1111
This is used by merge directives.
1113
return self._get_config_location('public_branch')
1115
def set_public_branch(self, location):
1116
"""Return the submit location of the branch.
1118
This is the default location for bundle. The usual
1119
pattern is that the user can override it by specifying a
1122
self._set_config_location('public_branch', location)
1124
def get_push_location(self):
1125
"""Return the None or the location to push this branch to."""
1126
push_loc = self.get_config().get_user_option('push_location')
1129
def set_push_location(self, location):
1130
"""Set a new push location for this branch."""
1131
raise NotImplementedError(self.set_push_location)
1133
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1134
"""Run the post_change_branch_tip hooks."""
1135
hooks = Branch.hooks['post_change_branch_tip']
1138
new_revno, new_revid = self.last_revision_info()
1139
params = ChangeBranchTipParams(
1140
self, old_revno, new_revno, old_revid, new_revid)
1144
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1145
"""Run the pre_change_branch_tip hooks."""
1146
hooks = Branch.hooks['pre_change_branch_tip']
1149
old_revno, old_revid = self.last_revision_info()
1150
params = ChangeBranchTipParams(
1151
self, old_revno, new_revno, old_revid, new_revid)
1157
"""Synchronise this branch with the master branch if any.
1159
:return: None or the last_revision pivoted out during the update.
1163
def check_revno(self, revno):
1165
Check whether a revno corresponds to any revision.
1166
Zero (the NULL revision) is considered valid.
1169
self.check_real_revno(revno)
1171
def check_real_revno(self, revno):
1173
Check whether a revno corresponds to a real revision.
1174
Zero (the NULL revision) is considered invalid
1176
if revno < 1 or revno > self.revno():
1177
raise errors.InvalidRevisionNumber(revno)
1180
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1181
"""Clone this branch into to_bzrdir preserving all semantic values.
1183
Most API users will want 'create_clone_on_transport', which creates a
1184
new bzrdir and branch on the fly.
1186
revision_id: if not None, the revision history in the new branch will
1187
be truncated to end with revision_id.
1189
result = to_bzrdir.create_branch()
1192
if repository_policy is not None:
1193
repository_policy.configure_branch(result)
1194
self.copy_content_into(result, revision_id=revision_id)
1200
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1201
"""Create a new line of development from the branch, into to_bzrdir.
1203
to_bzrdir controls the branch format.
1205
revision_id: if not None, the revision history in the new branch will
1206
be truncated to end with revision_id.
1208
if (repository_policy is not None and
1209
repository_policy.requires_stacking()):
1210
to_bzrdir._format.require_stacking(_skip_repo=True)
1211
result = to_bzrdir.create_branch()
1214
if repository_policy is not None:
1215
repository_policy.configure_branch(result)
1216
self.copy_content_into(result, revision_id=revision_id)
1217
result.set_parent(self.bzrdir.root_transport.base)
1222
def _synchronize_history(self, destination, revision_id):
1223
"""Synchronize last revision and revision history between branches.
1225
This version is most efficient when the destination is also a
1226
BzrBranch6, but works for BzrBranch5, as long as the destination's
1227
repository contains all the lefthand ancestors of the intended
1228
last_revision. If not, set_last_revision_info will fail.
1230
:param destination: The branch to copy the history into
1231
:param revision_id: The revision-id to truncate history at. May
1232
be None to copy complete history.
1234
source_revno, source_revision_id = self.last_revision_info()
1235
if revision_id is None:
1236
revno, revision_id = source_revno, source_revision_id
1238
graph = self.repository.get_graph()
1240
revno = graph.find_distance_to_null(revision_id,
1241
[(source_revision_id, source_revno)])
1242
except errors.GhostRevisionsHaveNoRevno:
1243
# Default to 1, if we can't find anything else
1245
destination.set_last_revision_info(revno, revision_id)
1248
def copy_content_into(self, destination, revision_id=None):
1249
"""Copy the content of self into destination.
1251
revision_id: if not None, the revision history in the new branch will
1252
be truncated to end with revision_id.
1254
self.update_references(destination)
1255
self._synchronize_history(destination, revision_id)
1257
parent = self.get_parent()
1258
except errors.InaccessibleParent, e:
1259
mutter('parent was not accessible to copy: %s', e)
1262
destination.set_parent(parent)
1263
if self._push_should_merge_tags():
1264
self.tags.merge_to(destination.tags)
1266
def update_references(self, target):
1267
if not getattr(self._format, 'supports_reference_locations', False):
1269
reference_dict = self._get_all_reference_info()
1270
if len(reference_dict) == 0:
1272
old_base = self.base
1273
new_base = target.base
1274
target_reference_dict = target._get_all_reference_info()
1275
for file_id, (tree_path, branch_location) in (
1276
reference_dict.items()):
1277
branch_location = urlutils.rebase_url(branch_location,
1279
target_reference_dict.setdefault(
1280
file_id, (tree_path, branch_location))
1281
target._set_all_reference_info(target_reference_dict)
1284
def check(self, refs):
1285
"""Check consistency of the branch.
1287
In particular this checks that revisions given in the revision-history
1288
do actually match up in the revision graph, and that they're all
1289
present in the repository.
1291
Callers will typically also want to check the repository.
1293
:param refs: Calculated refs for this branch as specified by
1294
branch._get_check_refs()
1295
:return: A BranchCheckResult.
1297
result = BranchCheckResult(self)
1298
last_revno, last_revision_id = self.last_revision_info()
1299
actual_revno = refs[('lefthand-distance', last_revision_id)]
1300
if actual_revno != last_revno:
1301
result.errors.append(errors.BzrCheckError(
1302
'revno does not match len(mainline) %s != %s' % (
1303
last_revno, actual_revno)))
1304
# TODO: We should probably also check that self.revision_history
1305
# matches the repository for older branch formats.
1306
# If looking for the code that cross-checks repository parents against
1307
# the iter_reverse_revision_history output, that is now a repository
1311
def _get_checkout_format(self):
1312
"""Return the most suitable metadir for a checkout of this branch.
1313
Weaves are used if this branch's repository uses weaves.
1315
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1316
from bzrlib.repofmt import weaverepo
1317
format = bzrdir.BzrDirMetaFormat1()
1318
format.repository_format = weaverepo.RepositoryFormat7()
1320
format = self.repository.bzrdir.checkout_metadir()
1321
format.set_branch_format(self._format)
1324
def create_clone_on_transport(self, to_transport, revision_id=None,
1325
stacked_on=None, create_prefix=False, use_existing_dir=False):
1326
"""Create a clone of this branch and its bzrdir.
1328
:param to_transport: The transport to clone onto.
1329
:param revision_id: The revision id to use as tip in the new branch.
1330
If None the tip is obtained from this branch.
1331
:param stacked_on: An optional URL to stack the clone on.
1332
:param create_prefix: Create any missing directories leading up to
1334
:param use_existing_dir: Use an existing directory if one exists.
1336
# XXX: Fix the bzrdir API to allow getting the branch back from the
1337
# clone call. Or something. 20090224 RBC/spiv.
1338
if revision_id is None:
1339
revision_id = self.last_revision()
1340
dir_to = self.bzrdir.clone_on_transport(to_transport,
1341
revision_id=revision_id, stacked_on=stacked_on,
1342
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1343
return dir_to.open_branch()
1345
def create_checkout(self, to_location, revision_id=None,
1346
lightweight=False, accelerator_tree=None,
1348
"""Create a checkout of a branch.
1350
:param to_location: The url to produce the checkout at
1351
:param revision_id: The revision to check out
1352
:param lightweight: If True, produce a lightweight checkout, otherwise,
1353
produce a bound branch (heavyweight checkout)
1354
:param accelerator_tree: A tree which can be used for retrieving file
1355
contents more quickly than the revision tree, i.e. a workingtree.
1356
The revision tree will be used for cases where accelerator_tree's
1357
content is different.
1358
:param hardlink: If true, hard-link files from accelerator_tree,
1360
:return: The tree of the created checkout
1362
t = transport.get_transport(to_location)
1365
format = self._get_checkout_format()
1366
checkout = format.initialize_on_transport(t)
1367
from_branch = BranchReferenceFormat().initialize(checkout,
1370
format = self._get_checkout_format()
1371
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1372
to_location, force_new_tree=False, format=format)
1373
checkout = checkout_branch.bzrdir
1374
checkout_branch.bind(self)
1375
# pull up to the specified revision_id to set the initial
1376
# branch tip correctly, and seed it with history.
1377
checkout_branch.pull(self, stop_revision=revision_id)
1379
tree = checkout.create_workingtree(revision_id,
1380
from_branch=from_branch,
1381
accelerator_tree=accelerator_tree,
1383
basis_tree = tree.basis_tree()
1384
basis_tree.lock_read()
1386
for path, file_id in basis_tree.iter_references():
1387
reference_parent = self.reference_parent(file_id, path)
1388
reference_parent.create_checkout(tree.abspath(path),
1389
basis_tree.get_reference_revision(file_id, path),
1396
def reconcile(self, thorough=True):
1397
"""Make sure the data stored in this branch is consistent."""
1398
from bzrlib.reconcile import BranchReconciler
1399
reconciler = BranchReconciler(self, thorough=thorough)
1400
reconciler.reconcile()
1403
def reference_parent(self, file_id, path, possible_transports=None):
1404
"""Return the parent branch for a tree-reference file_id
1405
:param file_id: The file_id of the tree reference
1406
:param path: The path of the file_id in the tree
1407
:return: A branch associated with the file_id
1409
# FIXME should provide multiple branches, based on config
1410
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1411
possible_transports=possible_transports)
1413
def supports_tags(self):
1414
return self._format.supports_tags()
1416
def automatic_tag_name(self, revision_id):
1417
"""Try to automatically find the tag name for a revision.
1419
:param revision_id: Revision id of the revision.
1420
:return: A tag name or None if no tag name could be determined.
1422
for hook in Branch.hooks['automatic_tag_name']:
1423
ret = hook(self, revision_id)
1428
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1430
"""Ensure that revision_b is a descendant of revision_a.
1432
This is a helper function for update_revisions.
1434
:raises: DivergedBranches if revision_b has diverged from revision_a.
1435
:returns: True if revision_b is a descendant of revision_a.
1437
relation = self._revision_relations(revision_a, revision_b, graph)
1438
if relation == 'b_descends_from_a':
1440
elif relation == 'diverged':
1441
raise errors.DivergedBranches(self, other_branch)
1442
elif relation == 'a_descends_from_b':
1445
raise AssertionError("invalid relation: %r" % (relation,))
1447
def _revision_relations(self, revision_a, revision_b, graph):
1448
"""Determine the relationship between two revisions.
1450
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1452
heads = graph.heads([revision_a, revision_b])
1453
if heads == set([revision_b]):
1454
return 'b_descends_from_a'
1455
elif heads == set([revision_a, revision_b]):
1456
# These branches have diverged
1458
elif heads == set([revision_a]):
1459
return 'a_descends_from_b'
1461
raise AssertionError("invalid heads: %r" % (heads,))
1464
class BranchFormat(object):
1465
"""An encapsulation of the initialization and open routines for a format.
1467
Formats provide three things:
1468
* An initialization routine,
1472
Formats are placed in an dict by their format string for reference
1473
during branch opening. Its not required that these be instances, they
1474
can be classes themselves with class methods - it simply depends on
1475
whether state is needed for a given format or not.
1477
Once a format is deprecated, just deprecate the initialize and open
1478
methods on the format class. Do not deprecate the object, as the
1479
object will be created every time regardless.
1482
_default_format = None
1483
"""The default format used for new branches."""
1486
"""The known formats."""
1488
can_set_append_revisions_only = True
1490
def __eq__(self, other):
1491
return self.__class__ is other.__class__
1493
def __ne__(self, other):
1494
return not (self == other)
1497
def find_format(klass, a_bzrdir, name=None):
1498
"""Return the format for the branch object in a_bzrdir."""
1500
transport = a_bzrdir.get_branch_transport(None, name=name)
1501
format_string = transport.get_bytes("format")
1502
return klass._formats[format_string]
1503
except errors.NoSuchFile:
1504
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1506
raise errors.UnknownFormatError(format=format_string, kind='branch')
1509
def get_default_format(klass):
1510
"""Return the current default format."""
1511
return klass._default_format
1513
def get_reference(self, a_bzrdir):
1514
"""Get the target reference of the branch in a_bzrdir.
1516
format probing must have been completed before calling
1517
this method - it is assumed that the format of the branch
1518
in a_bzrdir is correct.
1520
:param a_bzrdir: The bzrdir to get the branch data from.
1521
:return: None if the branch is not a reference branch.
1526
def set_reference(self, a_bzrdir, to_branch):
1527
"""Set the target reference of the branch in a_bzrdir.
1529
format probing must have been completed before calling
1530
this method - it is assumed that the format of the branch
1531
in a_bzrdir is correct.
1533
:param a_bzrdir: The bzrdir to set the branch reference for.
1534
:param to_branch: branch that the checkout is to reference
1536
raise NotImplementedError(self.set_reference)
1538
def get_format_string(self):
1539
"""Return the ASCII format string that identifies this format."""
1540
raise NotImplementedError(self.get_format_string)
1542
def get_format_description(self):
1543
"""Return the short format description for this format."""
1544
raise NotImplementedError(self.get_format_description)
1546
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1547
hooks = Branch.hooks['post_branch_init']
1550
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1554
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1555
lock_type='metadir', set_format=True):
1556
"""Initialize a branch in a bzrdir, with specified files
1558
:param a_bzrdir: The bzrdir to initialize the branch in
1559
:param utf8_files: The files to create as a list of
1560
(filename, content) tuples
1561
:param name: Name of colocated branch to create, if any
1562
:param set_format: If True, set the format with
1563
self.get_format_string. (BzrBranch4 has its format set
1565
:return: a branch in this format
1567
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1568
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1570
'metadir': ('lock', lockdir.LockDir),
1571
'branch4': ('branch-lock', lockable_files.TransportLock),
1573
lock_name, lock_class = lock_map[lock_type]
1574
control_files = lockable_files.LockableFiles(branch_transport,
1575
lock_name, lock_class)
1576
control_files.create_lock()
1578
control_files.lock_write()
1579
except errors.LockContention:
1580
if lock_type != 'branch4':
1586
utf8_files += [('format', self.get_format_string())]
1588
for (filename, content) in utf8_files:
1589
branch_transport.put_bytes(
1591
mode=a_bzrdir._get_file_mode())
1594
control_files.unlock()
1595
branch = self.open(a_bzrdir, name, _found=True)
1596
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1599
def initialize(self, a_bzrdir, name=None):
1600
"""Create a branch of this format in a_bzrdir.
1602
:param name: Name of the colocated branch to create.
1604
raise NotImplementedError(self.initialize)
1606
def is_supported(self):
1607
"""Is this format supported?
1609
Supported formats can be initialized and opened.
1610
Unsupported formats may not support initialization or committing or
1611
some other features depending on the reason for not being supported.
1615
def make_tags(self, branch):
1616
"""Create a tags object for branch.
1618
This method is on BranchFormat, because BranchFormats are reflected
1619
over the wire via network_name(), whereas full Branch instances require
1620
multiple VFS method calls to operate at all.
1622
The default implementation returns a disabled-tags instance.
1624
Note that it is normal for branch to be a RemoteBranch when using tags
1627
return DisabledTags(branch)
1629
def network_name(self):
1630
"""A simple byte string uniquely identifying this format for RPC calls.
1632
MetaDir branch formats use their disk format string to identify the
1633
repository over the wire. All in one formats such as bzr < 0.8, and
1634
foreign formats like svn/git and hg should use some marker which is
1635
unique and immutable.
1637
raise NotImplementedError(self.network_name)
1639
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1640
"""Return the branch object for a_bzrdir
1642
:param a_bzrdir: A BzrDir that contains a branch.
1643
:param name: Name of colocated branch to open
1644
:param _found: a private parameter, do not use it. It is used to
1645
indicate if format probing has already be done.
1646
:param ignore_fallbacks: when set, no fallback branches will be opened
1647
(if there are any). Default is to open fallbacks.
1649
raise NotImplementedError(self.open)
1652
def register_format(klass, format):
1653
"""Register a metadir format."""
1654
klass._formats[format.get_format_string()] = format
1655
# Metadir formats have a network name of their format string, and get
1656
# registered as class factories.
1657
network_format_registry.register(format.get_format_string(), format.__class__)
1660
def set_default_format(klass, format):
1661
klass._default_format = format
1663
def supports_set_append_revisions_only(self):
1664
"""True if this format supports set_append_revisions_only."""
1667
def supports_stacking(self):
1668
"""True if this format records a stacked-on branch."""
1672
def unregister_format(klass, format):
1673
del klass._formats[format.get_format_string()]
1676
return self.get_format_description().rstrip()
1678
def supports_tags(self):
1679
"""True if this format supports tags stored in the branch"""
1680
return False # by default
1683
class BranchHooks(Hooks):
1684
"""A dictionary mapping hook name to a list of callables for branch hooks.
1686
e.g. ['set_rh'] Is the list of items to be called when the
1687
set_revision_history function is invoked.
1691
"""Create the default hooks.
1693
These are all empty initially, because by default nothing should get
1696
Hooks.__init__(self)
1697
self.create_hook(HookPoint('set_rh',
1698
"Invoked whenever the revision history has been set via "
1699
"set_revision_history. The api signature is (branch, "
1700
"revision_history), and the branch will be write-locked. "
1701
"The set_rh hook can be expensive for bzr to trigger, a better "
1702
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1703
self.create_hook(HookPoint('open',
1704
"Called with the Branch object that has been opened after a "
1705
"branch is opened.", (1, 8), None))
1706
self.create_hook(HookPoint('post_push',
1707
"Called after a push operation completes. post_push is called "
1708
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1709
"bzr client.", (0, 15), None))
1710
self.create_hook(HookPoint('post_pull',
1711
"Called after a pull operation completes. post_pull is called "
1712
"with a bzrlib.branch.PullResult object and only runs in the "
1713
"bzr client.", (0, 15), None))
1714
self.create_hook(HookPoint('pre_commit',
1715
"Called after a commit is calculated but before it is is "
1716
"completed. pre_commit is called with (local, master, old_revno, "
1717
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1718
"). old_revid is NULL_REVISION for the first commit to a branch, "
1719
"tree_delta is a TreeDelta object describing changes from the "
1720
"basis revision. hooks MUST NOT modify this delta. "
1721
" future_tree is an in-memory tree obtained from "
1722
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1723
"tree.", (0,91), None))
1724
self.create_hook(HookPoint('post_commit',
1725
"Called in the bzr client after a commit has completed. "
1726
"post_commit is called with (local, master, old_revno, old_revid, "
1727
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1728
"commit to a branch.", (0, 15), None))
1729
self.create_hook(HookPoint('post_uncommit',
1730
"Called in the bzr client after an uncommit completes. "
1731
"post_uncommit is called with (local, master, old_revno, "
1732
"old_revid, new_revno, new_revid) where local is the local branch "
1733
"or None, master is the target branch, and an empty branch "
1734
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1735
self.create_hook(HookPoint('pre_change_branch_tip',
1736
"Called in bzr client and server before a change to the tip of a "
1737
"branch is made. pre_change_branch_tip is called with a "
1738
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1739
"commit, uncommit will all trigger this hook.", (1, 6), None))
1740
self.create_hook(HookPoint('post_change_branch_tip',
1741
"Called in bzr client and server after a change to the tip of a "
1742
"branch is made. post_change_branch_tip is called with a "
1743
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1744
"commit, uncommit will all trigger this hook.", (1, 4), None))
1745
self.create_hook(HookPoint('transform_fallback_location',
1746
"Called when a stacked branch is activating its fallback "
1747
"locations. transform_fallback_location is called with (branch, "
1748
"url), and should return a new url. Returning the same url "
1749
"allows it to be used as-is, returning a different one can be "
1750
"used to cause the branch to stack on a closer copy of that "
1751
"fallback_location. Note that the branch cannot have history "
1752
"accessing methods called on it during this hook because the "
1753
"fallback locations have not been activated. When there are "
1754
"multiple hooks installed for transform_fallback_location, "
1755
"all are called with the url returned from the previous hook."
1756
"The order is however undefined.", (1, 9), None))
1757
self.create_hook(HookPoint('automatic_tag_name',
1758
"Called to determine an automatic tag name for a revision."
1759
"automatic_tag_name is called with (branch, revision_id) and "
1760
"should return a tag name or None if no tag name could be "
1761
"determined. The first non-None tag name returned will be used.",
1763
self.create_hook(HookPoint('post_branch_init',
1764
"Called after new branch initialization completes. "
1765
"post_branch_init is called with a "
1766
"bzrlib.branch.BranchInitHookParams. "
1767
"Note that init, branch and checkout (both heavyweight and "
1768
"lightweight) will all trigger this hook.", (2, 2), None))
1769
self.create_hook(HookPoint('post_switch',
1770
"Called after a checkout switches branch. "
1771
"post_switch is called with a "
1772
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1776
# install the default hooks into the Branch class.
1777
Branch.hooks = BranchHooks()
1780
class ChangeBranchTipParams(object):
1781
"""Object holding parameters passed to *_change_branch_tip hooks.
1783
There are 5 fields that hooks may wish to access:
1785
:ivar branch: the branch being changed
1786
:ivar old_revno: revision number before the change
1787
:ivar new_revno: revision number after the change
1788
:ivar old_revid: revision id before the change
1789
:ivar new_revid: revision id after the change
1791
The revid fields are strings. The revno fields are integers.
1794
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1795
"""Create a group of ChangeBranchTip parameters.
1797
:param branch: The branch being changed.
1798
:param old_revno: Revision number before the change.
1799
:param new_revno: Revision number after the change.
1800
:param old_revid: Tip revision id before the change.
1801
:param new_revid: Tip revision id after the change.
1803
self.branch = branch
1804
self.old_revno = old_revno
1805
self.new_revno = new_revno
1806
self.old_revid = old_revid
1807
self.new_revid = new_revid
1809
def __eq__(self, other):
1810
return self.__dict__ == other.__dict__
1813
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1814
self.__class__.__name__, self.branch,
1815
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1818
class BranchInitHookParams(object):
1819
"""Object holding parameters passed to *_branch_init hooks.
1821
There are 4 fields that hooks may wish to access:
1823
:ivar format: the branch format
1824
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1825
:ivar name: name of colocated branch, if any (or None)
1826
:ivar branch: the branch created
1828
Note that for lightweight checkouts, the bzrdir and format fields refer to
1829
the checkout, hence they are different from the corresponding fields in
1830
branch, which refer to the original branch.
1833
def __init__(self, format, a_bzrdir, name, branch):
1834
"""Create a group of BranchInitHook parameters.
1836
:param format: the branch format
1837
:param a_bzrdir: the BzrDir where the branch will be/has been
1839
:param name: name of colocated branch, if any (or None)
1840
:param branch: the branch created
1842
Note that for lightweight checkouts, the bzrdir and format fields refer
1843
to the checkout, hence they are different from the corresponding fields
1844
in branch, which refer to the original branch.
1846
self.format = format
1847
self.bzrdir = a_bzrdir
1849
self.branch = branch
1851
def __eq__(self, other):
1852
return self.__dict__ == other.__dict__
1856
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1858
return "<%s of format:%s bzrdir:%s>" % (
1859
self.__class__.__name__, self.branch,
1860
self.format, self.bzrdir)
1863
class SwitchHookParams(object):
1864
"""Object holding parameters passed to *_switch hooks.
1866
There are 4 fields that hooks may wish to access:
1868
:ivar control_dir: BzrDir of the checkout to change
1869
:ivar to_branch: branch that the checkout is to reference
1870
:ivar force: skip the check for local commits in a heavy checkout
1871
:ivar revision_id: revision ID to switch to (or None)
1874
def __init__(self, control_dir, to_branch, force, revision_id):
1875
"""Create a group of SwitchHook parameters.
1877
:param control_dir: BzrDir of the checkout to change
1878
:param to_branch: branch that the checkout is to reference
1879
:param force: skip the check for local commits in a heavy checkout
1880
:param revision_id: revision ID to switch to (or None)
1882
self.control_dir = control_dir
1883
self.to_branch = to_branch
1885
self.revision_id = revision_id
1887
def __eq__(self, other):
1888
return self.__dict__ == other.__dict__
1891
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1892
self.control_dir, self.to_branch,
1896
class BzrBranchFormat4(BranchFormat):
1897
"""Bzr branch format 4.
1900
- a revision-history file.
1901
- a branch-lock lock file [ to be shared with the bzrdir ]
1904
def get_format_description(self):
1905
"""See BranchFormat.get_format_description()."""
1906
return "Branch format 4"
1908
def initialize(self, a_bzrdir, name=None):
1909
"""Create a branch of this format in a_bzrdir."""
1910
utf8_files = [('revision-history', ''),
1911
('branch-name', ''),
1913
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1914
lock_type='branch4', set_format=False)
1917
super(BzrBranchFormat4, self).__init__()
1918
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1920
def network_name(self):
1921
"""The network name for this format is the control dirs disk label."""
1922
return self._matchingbzrdir.get_format_string()
1924
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1925
"""See BranchFormat.open()."""
1927
# we are being called directly and must probe.
1928
raise NotImplementedError
1929
return BzrBranch(_format=self,
1930
_control_files=a_bzrdir._control_files,
1933
_repository=a_bzrdir.open_repository())
1936
return "Bazaar-NG branch format 4"
1939
class BranchFormatMetadir(BranchFormat):
1940
"""Common logic for meta-dir based branch formats."""
1942
def _branch_class(self):
1943
"""What class to instantiate on open calls."""
1944
raise NotImplementedError(self._branch_class)
1946
def network_name(self):
1947
"""A simple byte string uniquely identifying this format for RPC calls.
1949
Metadir branch formats use their format string.
1951
return self.get_format_string()
1953
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1954
"""See BranchFormat.open()."""
1956
format = BranchFormat.find_format(a_bzrdir, name=name)
1957
if format.__class__ != self.__class__:
1958
raise AssertionError("wrong format %r found for %r" %
1961
transport = a_bzrdir.get_branch_transport(None, name=name)
1962
control_files = lockable_files.LockableFiles(transport, 'lock',
1964
return self._branch_class()(_format=self,
1965
_control_files=control_files,
1968
_repository=a_bzrdir.find_repository(),
1969
ignore_fallbacks=ignore_fallbacks)
1970
except errors.NoSuchFile:
1971
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1974
super(BranchFormatMetadir, self).__init__()
1975
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1976
self._matchingbzrdir.set_branch_format(self)
1978
def supports_tags(self):
1982
class BzrBranchFormat5(BranchFormatMetadir):
1983
"""Bzr branch format 5.
1986
- a revision-history file.
1988
- a lock dir guarding the branch itself
1989
- all of this stored in a branch/ subdirectory
1990
- works with shared repositories.
1992
This format is new in bzr 0.8.
1995
def _branch_class(self):
1998
def get_format_string(self):
1999
"""See BranchFormat.get_format_string()."""
2000
return "Bazaar-NG branch format 5\n"
2002
def get_format_description(self):
2003
"""See BranchFormat.get_format_description()."""
2004
return "Branch format 5"
2006
def initialize(self, a_bzrdir, name=None):
2007
"""Create a branch of this format in a_bzrdir."""
2008
utf8_files = [('revision-history', ''),
2009
('branch-name', ''),
2011
return self._initialize_helper(a_bzrdir, utf8_files, name)
2013
def supports_tags(self):
2017
class BzrBranchFormat6(BranchFormatMetadir):
2018
"""Branch format with last-revision and tags.
2020
Unlike previous formats, this has no explicit revision history. Instead,
2021
this just stores the last-revision, and the left-hand history leading
2022
up to there is the history.
2024
This format was introduced in bzr 0.15
2025
and became the default in 0.91.
2028
def _branch_class(self):
2031
def get_format_string(self):
2032
"""See BranchFormat.get_format_string()."""
2033
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2035
def get_format_description(self):
2036
"""See BranchFormat.get_format_description()."""
2037
return "Branch format 6"
2039
def initialize(self, a_bzrdir, name=None):
2040
"""Create a branch of this format in a_bzrdir."""
2041
utf8_files = [('last-revision', '0 null:\n'),
2042
('branch.conf', ''),
2045
return self._initialize_helper(a_bzrdir, utf8_files, name)
2047
def make_tags(self, branch):
2048
"""See bzrlib.branch.BranchFormat.make_tags()."""
2049
return BasicTags(branch)
2051
def supports_set_append_revisions_only(self):
2055
class BzrBranchFormat8(BranchFormatMetadir):
2056
"""Metadir format supporting storing locations of subtree branches."""
2058
def _branch_class(self):
2061
def get_format_string(self):
2062
"""See BranchFormat.get_format_string()."""
2063
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2065
def get_format_description(self):
2066
"""See BranchFormat.get_format_description()."""
2067
return "Branch format 8"
2069
def initialize(self, a_bzrdir, name=None):
2070
"""Create a branch of this format in a_bzrdir."""
2071
utf8_files = [('last-revision', '0 null:\n'),
2072
('branch.conf', ''),
2076
return self._initialize_helper(a_bzrdir, utf8_files, name)
2079
super(BzrBranchFormat8, self).__init__()
2080
self._matchingbzrdir.repository_format = \
2081
RepositoryFormatKnitPack5RichRoot()
2083
def make_tags(self, branch):
2084
"""See bzrlib.branch.BranchFormat.make_tags()."""
2085
return BasicTags(branch)
2087
def supports_set_append_revisions_only(self):
2090
def supports_stacking(self):
2093
supports_reference_locations = True
2096
class BzrBranchFormat7(BzrBranchFormat8):
2097
"""Branch format with last-revision, tags, and a stacked location pointer.
2099
The stacked location pointer is passed down to the repository and requires
2100
a repository format with supports_external_lookups = True.
2102
This format was introduced in bzr 1.6.
2105
def initialize(self, a_bzrdir, name=None):
2106
"""Create a branch of this format in a_bzrdir."""
2107
utf8_files = [('last-revision', '0 null:\n'),
2108
('branch.conf', ''),
2111
return self._initialize_helper(a_bzrdir, utf8_files, name)
2113
def _branch_class(self):
2116
def get_format_string(self):
2117
"""See BranchFormat.get_format_string()."""
2118
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2120
def get_format_description(self):
2121
"""See BranchFormat.get_format_description()."""
2122
return "Branch format 7"
2124
def supports_set_append_revisions_only(self):
2127
supports_reference_locations = False
2130
class BranchReferenceFormat(BranchFormat):
2131
"""Bzr branch reference format.
2133
Branch references are used in implementing checkouts, they
2134
act as an alias to the real branch which is at some other url.
2141
def get_format_string(self):
2142
"""See BranchFormat.get_format_string()."""
2143
return "Bazaar-NG Branch Reference Format 1\n"
2145
def get_format_description(self):
2146
"""See BranchFormat.get_format_description()."""
2147
return "Checkout reference format 1"
2149
def get_reference(self, a_bzrdir):
2150
"""See BranchFormat.get_reference()."""
2151
transport = a_bzrdir.get_branch_transport(None)
2152
return transport.get_bytes('location')
2154
def set_reference(self, a_bzrdir, to_branch):
2155
"""See BranchFormat.set_reference()."""
2156
transport = a_bzrdir.get_branch_transport(None)
2157
location = transport.put_bytes('location', to_branch.base)
2159
def initialize(self, a_bzrdir, name=None, target_branch=None):
2160
"""Create a branch of this format in a_bzrdir."""
2161
if target_branch is None:
2162
# this format does not implement branch itself, thus the implicit
2163
# creation contract must see it as uninitializable
2164
raise errors.UninitializableFormat(self)
2165
mutter('creating branch reference in %s', a_bzrdir.transport.base)
2166
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2167
branch_transport.put_bytes('location',
2168
target_branch.bzrdir.root_transport.base)
2169
branch_transport.put_bytes('format', self.get_format_string())
2171
a_bzrdir, name, _found=True,
2172
possible_transports=[target_branch.bzrdir.root_transport])
2173
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2177
super(BranchReferenceFormat, self).__init__()
2178
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2179
self._matchingbzrdir.set_branch_format(self)
2181
def _make_reference_clone_function(format, a_branch):
2182
"""Create a clone() routine for a branch dynamically."""
2183
def clone(to_bzrdir, revision_id=None,
2184
repository_policy=None):
2185
"""See Branch.clone()."""
2186
return format.initialize(to_bzrdir, target_branch=a_branch)
2187
# cannot obey revision_id limits when cloning a reference ...
2188
# FIXME RBC 20060210 either nuke revision_id for clone, or
2189
# emit some sort of warning/error to the caller ?!
2192
def open(self, a_bzrdir, name=None, _found=False, location=None,
2193
possible_transports=None, ignore_fallbacks=False):
2194
"""Return the branch that the branch reference in a_bzrdir points at.
2196
:param a_bzrdir: A BzrDir that contains a branch.
2197
:param name: Name of colocated branch to open, if any
2198
:param _found: a private parameter, do not use it. It is used to
2199
indicate if format probing has already be done.
2200
:param ignore_fallbacks: when set, no fallback branches will be opened
2201
(if there are any). Default is to open fallbacks.
2202
:param location: The location of the referenced branch. If
2203
unspecified, this will be determined from the branch reference in
2205
:param possible_transports: An optional reusable transports list.
2208
format = BranchFormat.find_format(a_bzrdir, name=name)
2209
if format.__class__ != self.__class__:
2210
raise AssertionError("wrong format %r found for %r" %
2212
if location is None:
2213
location = self.get_reference(a_bzrdir)
2214
real_bzrdir = bzrdir.BzrDir.open(
2215
location, possible_transports=possible_transports)
2216
result = real_bzrdir.open_branch(name=name,
2217
ignore_fallbacks=ignore_fallbacks)
2218
# this changes the behaviour of result.clone to create a new reference
2219
# rather than a copy of the content of the branch.
2220
# I did not use a proxy object because that needs much more extensive
2221
# testing, and we are only changing one behaviour at the moment.
2222
# If we decide to alter more behaviours - i.e. the implicit nickname
2223
# then this should be refactored to introduce a tested proxy branch
2224
# and a subclass of that for use in overriding clone() and ....
2226
result.clone = self._make_reference_clone_function(result)
2230
network_format_registry = registry.FormatRegistry()
2231
"""Registry of formats indexed by their network name.
2233
The network name for a branch format is an identifier that can be used when
2234
referring to formats with smart server operations. See
2235
BranchFormat.network_name() for more detail.
2239
# formats which have no format string are not discoverable
2240
# and not independently creatable, so are not registered.
2241
__format5 = BzrBranchFormat5()
2242
__format6 = BzrBranchFormat6()
2243
__format7 = BzrBranchFormat7()
2244
__format8 = BzrBranchFormat8()
2245
BranchFormat.register_format(__format5)
2246
BranchFormat.register_format(BranchReferenceFormat())
2247
BranchFormat.register_format(__format6)
2248
BranchFormat.register_format(__format7)
2249
BranchFormat.register_format(__format8)
2250
BranchFormat.set_default_format(__format7)
2251
_legacy_formats = [BzrBranchFormat4(),
2253
network_format_registry.register(
2254
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2257
class BzrBranch(Branch, _RelockDebugMixin):
2258
"""A branch stored in the actual filesystem.
2260
Note that it's "local" in the context of the filesystem; it doesn't
2261
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2262
it's writable, and can be accessed via the normal filesystem API.
2264
:ivar _transport: Transport for file operations on this branch's
2265
control files, typically pointing to the .bzr/branch directory.
2266
:ivar repository: Repository for this branch.
2267
:ivar base: The url of the base directory for this branch; the one
2268
containing the .bzr directory.
2269
:ivar name: Optional colocated branch name as it exists in the control
2273
def __init__(self, _format=None,
2274
_control_files=None, a_bzrdir=None, name=None,
2275
_repository=None, ignore_fallbacks=False):
2276
"""Create new branch object at a particular location."""
2277
if a_bzrdir is None:
2278
raise ValueError('a_bzrdir must be supplied')
2280
self.bzrdir = a_bzrdir
2281
self._base = self.bzrdir.transport.clone('..').base
2283
# XXX: We should be able to just do
2284
# self.base = self.bzrdir.root_transport.base
2285
# but this does not quite work yet -- mbp 20080522
2286
self._format = _format
2287
if _control_files is None:
2288
raise ValueError('BzrBranch _control_files is None')
2289
self.control_files = _control_files
2290
self._transport = _control_files._transport
2291
self.repository = _repository
2292
Branch.__init__(self)
2295
if self.name is None:
2296
return '%s(%r)' % (self.__class__.__name__, self.base)
2298
return '%s(%r,%r)' % (self.__class__.__name__, self.base, self.name)
2302
def _get_base(self):
2303
"""Returns the directory containing the control directory."""
2306
base = property(_get_base, doc="The URL for the root of this branch.")
2308
def _get_config(self):
2309
return TransportConfig(self._transport, 'branch.conf')
2311
def is_locked(self):
2312
return self.control_files.is_locked()
2314
def lock_write(self, token=None):
2315
if not self.is_locked():
2316
self._note_lock('w')
2317
# All-in-one needs to always unlock/lock.
2318
repo_control = getattr(self.repository, 'control_files', None)
2319
if self.control_files == repo_control or not self.is_locked():
2320
self.repository._warn_if_deprecated(self)
2321
self.repository.lock_write()
2326
return self.control_files.lock_write(token=token)
2329
self.repository.unlock()
2332
def lock_read(self):
2333
if not self.is_locked():
2334
self._note_lock('r')
2335
# All-in-one needs to always unlock/lock.
2336
repo_control = getattr(self.repository, 'control_files', None)
2337
if self.control_files == repo_control or not self.is_locked():
2338
self.repository._warn_if_deprecated(self)
2339
self.repository.lock_read()
2344
self.control_files.lock_read()
2347
self.repository.unlock()
2350
@only_raises(errors.LockNotHeld, errors.LockBroken)
2353
self.control_files.unlock()
2355
# All-in-one needs to always unlock/lock.
2356
repo_control = getattr(self.repository, 'control_files', None)
2357
if (self.control_files == repo_control or
2358
not self.control_files.is_locked()):
2359
self.repository.unlock()
2360
if not self.control_files.is_locked():
2361
# we just released the lock
2362
self._clear_cached_state()
2364
def peek_lock_mode(self):
2365
if self.control_files._lock_count == 0:
2368
return self.control_files._lock_mode
2370
def get_physical_lock_status(self):
2371
return self.control_files.get_physical_lock_status()
2374
def print_file(self, file, revision_id):
2375
"""See Branch.print_file."""
2376
return self.repository.print_file(file, revision_id)
2378
def _write_revision_history(self, history):
2379
"""Factored out of set_revision_history.
2381
This performs the actual writing to disk.
2382
It is intended to be called by BzrBranch5.set_revision_history."""
2383
self._transport.put_bytes(
2384
'revision-history', '\n'.join(history),
2385
mode=self.bzrdir._get_file_mode())
2388
def set_revision_history(self, rev_history):
2389
"""See Branch.set_revision_history."""
2390
if 'evil' in debug.debug_flags:
2391
mutter_callsite(3, "set_revision_history scales with history.")
2392
check_not_reserved_id = _mod_revision.check_not_reserved_id
2393
for rev_id in rev_history:
2394
check_not_reserved_id(rev_id)
2395
if Branch.hooks['post_change_branch_tip']:
2396
# Don't calculate the last_revision_info() if there are no hooks
2398
old_revno, old_revid = self.last_revision_info()
2399
if len(rev_history) == 0:
2400
revid = _mod_revision.NULL_REVISION
2402
revid = rev_history[-1]
2403
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2404
self._write_revision_history(rev_history)
2405
self._clear_cached_state()
2406
self._cache_revision_history(rev_history)
2407
for hook in Branch.hooks['set_rh']:
2408
hook(self, rev_history)
2409
if Branch.hooks['post_change_branch_tip']:
2410
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2412
def _synchronize_history(self, destination, revision_id):
2413
"""Synchronize last revision and revision history between branches.
2415
This version is most efficient when the destination is also a
2416
BzrBranch5, but works for BzrBranch6 as long as the revision
2417
history is the true lefthand parent history, and all of the revisions
2418
are in the destination's repository. If not, set_revision_history
2421
:param destination: The branch to copy the history into
2422
:param revision_id: The revision-id to truncate history at. May
2423
be None to copy complete history.
2425
if not isinstance(destination._format, BzrBranchFormat5):
2426
super(BzrBranch, self)._synchronize_history(
2427
destination, revision_id)
2429
if revision_id == _mod_revision.NULL_REVISION:
2432
new_history = self.revision_history()
2433
if revision_id is not None and new_history != []:
2435
new_history = new_history[:new_history.index(revision_id) + 1]
2437
rev = self.repository.get_revision(revision_id)
2438
new_history = rev.get_history(self.repository)[1:]
2439
destination.set_revision_history(new_history)
2442
def set_last_revision_info(self, revno, revision_id):
2443
"""Set the last revision of this branch.
2445
The caller is responsible for checking that the revno is correct
2446
for this revision id.
2448
It may be possible to set the branch last revision to an id not
2449
present in the repository. However, branches can also be
2450
configured to check constraints on history, in which case this may not
2453
revision_id = _mod_revision.ensure_null(revision_id)
2454
# this old format stores the full history, but this api doesn't
2455
# provide it, so we must generate, and might as well check it's
2457
history = self._lefthand_history(revision_id)
2458
if len(history) != revno:
2459
raise AssertionError('%d != %d' % (len(history), revno))
2460
self.set_revision_history(history)
2462
def _gen_revision_history(self):
2463
history = self._transport.get_bytes('revision-history').split('\n')
2464
if history[-1:] == ['']:
2465
# There shouldn't be a trailing newline, but just in case.
2470
def generate_revision_history(self, revision_id, last_rev=None,
2472
"""Create a new revision history that will finish with revision_id.
2474
:param revision_id: the new tip to use.
2475
:param last_rev: The previous last_revision. If not None, then this
2476
must be a ancestory of revision_id, or DivergedBranches is raised.
2477
:param other_branch: The other branch that DivergedBranches should
2478
raise with respect to.
2480
self.set_revision_history(self._lefthand_history(revision_id,
2481
last_rev, other_branch))
2483
def basis_tree(self):
2484
"""See Branch.basis_tree."""
2485
return self.repository.revision_tree(self.last_revision())
2487
def _get_parent_location(self):
2488
_locs = ['parent', 'pull', 'x-pull']
2491
return self._transport.get_bytes(l).strip('\n')
2492
except errors.NoSuchFile:
2496
def _basic_push(self, target, overwrite, stop_revision):
2497
"""Basic implementation of push without bound branches or hooks.
2499
Must be called with source read locked and target write locked.
2501
result = BranchPushResult()
2502
result.source_branch = self
2503
result.target_branch = target
2504
result.old_revno, result.old_revid = target.last_revision_info()
2505
self.update_references(target)
2506
if result.old_revid != self.last_revision():
2507
# We assume that during 'push' this repository is closer than
2509
graph = self.repository.get_graph(target.repository)
2510
target.update_revisions(self, stop_revision,
2511
overwrite=overwrite, graph=graph)
2512
if self._push_should_merge_tags():
2513
result.tag_conflicts = self.tags.merge_to(target.tags,
2515
result.new_revno, result.new_revid = target.last_revision_info()
2518
def get_stacked_on_url(self):
2519
raise errors.UnstackableBranchFormat(self._format, self.base)
2521
def set_push_location(self, location):
2522
"""See Branch.set_push_location."""
2523
self.get_config().set_user_option(
2524
'push_location', location,
2525
store=_mod_config.STORE_LOCATION_NORECURSE)
2527
def _set_parent_location(self, url):
2529
self._transport.delete('parent')
2531
self._transport.put_bytes('parent', url + '\n',
2532
mode=self.bzrdir._get_file_mode())
2535
class BzrBranch5(BzrBranch):
2536
"""A format 5 branch. This supports new features over plain branches.
2538
It has support for a master_branch which is the data for bound branches.
2541
def get_bound_location(self):
2543
return self._transport.get_bytes('bound')[:-1]
2544
except errors.NoSuchFile:
2548
def get_master_branch(self, possible_transports=None):
2549
"""Return the branch we are bound to.
2551
:return: Either a Branch, or None
2553
This could memoise the branch, but if thats done
2554
it must be revalidated on each new lock.
2555
So for now we just don't memoise it.
2556
# RBC 20060304 review this decision.
2558
bound_loc = self.get_bound_location()
2562
return Branch.open(bound_loc,
2563
possible_transports=possible_transports)
2564
except (errors.NotBranchError, errors.ConnectionError), e:
2565
raise errors.BoundBranchConnectionFailure(
2569
def set_bound_location(self, location):
2570
"""Set the target where this branch is bound to.
2572
:param location: URL to the target branch
2575
self._transport.put_bytes('bound', location+'\n',
2576
mode=self.bzrdir._get_file_mode())
2579
self._transport.delete('bound')
2580
except errors.NoSuchFile:
2585
def bind(self, other):
2586
"""Bind this branch to the branch other.
2588
This does not push or pull data between the branches, though it does
2589
check for divergence to raise an error when the branches are not
2590
either the same, or one a prefix of the other. That behaviour may not
2591
be useful, so that check may be removed in future.
2593
:param other: The branch to bind to
2596
# TODO: jam 20051230 Consider checking if the target is bound
2597
# It is debatable whether you should be able to bind to
2598
# a branch which is itself bound.
2599
# Committing is obviously forbidden,
2600
# but binding itself may not be.
2601
# Since we *have* to check at commit time, we don't
2602
# *need* to check here
2604
# we want to raise diverged if:
2605
# last_rev is not in the other_last_rev history, AND
2606
# other_last_rev is not in our history, and do it without pulling
2608
self.set_bound_location(other.base)
2612
"""If bound, unbind"""
2613
return self.set_bound_location(None)
2616
def update(self, possible_transports=None):
2617
"""Synchronise this branch with the master branch if any.
2619
:return: None or the last_revision that was pivoted out during the
2622
master = self.get_master_branch(possible_transports)
2623
if master is not None:
2624
old_tip = _mod_revision.ensure_null(self.last_revision())
2625
self.pull(master, overwrite=True)
2626
if self.repository.get_graph().is_ancestor(old_tip,
2627
_mod_revision.ensure_null(self.last_revision())):
2633
class BzrBranch8(BzrBranch5):
2634
"""A branch that stores tree-reference locations."""
2636
def _open_hook(self):
2637
if self._ignore_fallbacks:
2640
url = self.get_stacked_on_url()
2641
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2642
errors.UnstackableBranchFormat):
2645
for hook in Branch.hooks['transform_fallback_location']:
2646
url = hook(self, url)
2648
hook_name = Branch.hooks.get_hook_name(hook)
2649
raise AssertionError(
2650
"'transform_fallback_location' hook %s returned "
2651
"None, not a URL." % hook_name)
2652
self._activate_fallback_location(url)
2654
def __init__(self, *args, **kwargs):
2655
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2656
super(BzrBranch8, self).__init__(*args, **kwargs)
2657
self._last_revision_info_cache = None
2658
self._reference_info = None
2660
def _clear_cached_state(self):
2661
super(BzrBranch8, self)._clear_cached_state()
2662
self._last_revision_info_cache = None
2663
self._reference_info = None
2665
def _last_revision_info(self):
2666
revision_string = self._transport.get_bytes('last-revision')
2667
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2668
revision_id = cache_utf8.get_cached_utf8(revision_id)
2670
return revno, revision_id
2672
def _write_last_revision_info(self, revno, revision_id):
2673
"""Simply write out the revision id, with no checks.
2675
Use set_last_revision_info to perform this safely.
2677
Does not update the revision_history cache.
2678
Intended to be called by set_last_revision_info and
2679
_write_revision_history.
2681
revision_id = _mod_revision.ensure_null(revision_id)
2682
out_string = '%d %s\n' % (revno, revision_id)
2683
self._transport.put_bytes('last-revision', out_string,
2684
mode=self.bzrdir._get_file_mode())
2687
def set_last_revision_info(self, revno, revision_id):
2688
revision_id = _mod_revision.ensure_null(revision_id)
2689
old_revno, old_revid = self.last_revision_info()
2690
if self._get_append_revisions_only():
2691
self._check_history_violation(revision_id)
2692
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2693
self._write_last_revision_info(revno, revision_id)
2694
self._clear_cached_state()
2695
self._last_revision_info_cache = revno, revision_id
2696
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2698
def _synchronize_history(self, destination, revision_id):
2699
"""Synchronize last revision and revision history between branches.
2701
:see: Branch._synchronize_history
2703
# XXX: The base Branch has a fast implementation of this method based
2704
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2705
# that uses set_revision_history. This class inherits from BzrBranch5,
2706
# but wants the fast implementation, so it calls
2707
# Branch._synchronize_history directly.
2708
Branch._synchronize_history(self, destination, revision_id)
2710
def _check_history_violation(self, revision_id):
2711
last_revision = _mod_revision.ensure_null(self.last_revision())
2712
if _mod_revision.is_null(last_revision):
2714
if last_revision not in self._lefthand_history(revision_id):
2715
raise errors.AppendRevisionsOnlyViolation(self.base)
2717
def _gen_revision_history(self):
2718
"""Generate the revision history from last revision
2720
last_revno, last_revision = self.last_revision_info()
2721
self._extend_partial_history(stop_index=last_revno-1)
2722
return list(reversed(self._partial_revision_history_cache))
2724
def _write_revision_history(self, history):
2725
"""Factored out of set_revision_history.
2727
This performs the actual writing to disk, with format-specific checks.
2728
It is intended to be called by BzrBranch5.set_revision_history.
2730
if len(history) == 0:
2731
last_revision = 'null:'
2733
if history != self._lefthand_history(history[-1]):
2734
raise errors.NotLefthandHistory(history)
2735
last_revision = history[-1]
2736
if self._get_append_revisions_only():
2737
self._check_history_violation(last_revision)
2738
self._write_last_revision_info(len(history), last_revision)
2741
def _set_parent_location(self, url):
2742
"""Set the parent branch"""
2743
self._set_config_location('parent_location', url, make_relative=True)
2746
def _get_parent_location(self):
2747
"""Set the parent branch"""
2748
return self._get_config_location('parent_location')
2751
def _set_all_reference_info(self, info_dict):
2752
"""Replace all reference info stored in a branch.
2754
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2757
writer = rio.RioWriter(s)
2758
for key, (tree_path, branch_location) in info_dict.iteritems():
2759
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2760
branch_location=branch_location)
2761
writer.write_stanza(stanza)
2762
self._transport.put_bytes('references', s.getvalue())
2763
self._reference_info = info_dict
2766
def _get_all_reference_info(self):
2767
"""Return all the reference info stored in a branch.
2769
:return: A dict of {file_id: (tree_path, branch_location)}
2771
if self._reference_info is not None:
2772
return self._reference_info
2773
rio_file = self._transport.get('references')
2775
stanzas = rio.read_stanzas(rio_file)
2776
info_dict = dict((s['file_id'], (s['tree_path'],
2777
s['branch_location'])) for s in stanzas)
2780
self._reference_info = info_dict
2783
def set_reference_info(self, file_id, tree_path, branch_location):
2784
"""Set the branch location to use for a tree reference.
2786
:param file_id: The file-id of the tree reference.
2787
:param tree_path: The path of the tree reference in the tree.
2788
:param branch_location: The location of the branch to retrieve tree
2791
info_dict = self._get_all_reference_info()
2792
info_dict[file_id] = (tree_path, branch_location)
2793
if None in (tree_path, branch_location):
2794
if tree_path is not None:
2795
raise ValueError('tree_path must be None when branch_location'
2797
if branch_location is not None:
2798
raise ValueError('branch_location must be None when tree_path'
2800
del info_dict[file_id]
2801
self._set_all_reference_info(info_dict)
2803
def get_reference_info(self, file_id):
2804
"""Get the tree_path and branch_location for a tree reference.
2806
:return: a tuple of (tree_path, branch_location)
2808
return self._get_all_reference_info().get(file_id, (None, None))
2810
def reference_parent(self, file_id, path, possible_transports=None):
2811
"""Return the parent branch for a tree-reference file_id.
2813
:param file_id: The file_id of the tree reference
2814
:param path: The path of the file_id in the tree
2815
:return: A branch associated with the file_id
2817
branch_location = self.get_reference_info(file_id)[1]
2818
if branch_location is None:
2819
return Branch.reference_parent(self, file_id, path,
2820
possible_transports)
2821
branch_location = urlutils.join(self.base, branch_location)
2822
return Branch.open(branch_location,
2823
possible_transports=possible_transports)
2825
def set_push_location(self, location):
2826
"""See Branch.set_push_location."""
2827
self._set_config_location('push_location', location)
2829
def set_bound_location(self, location):
2830
"""See Branch.set_push_location."""
2832
config = self.get_config()
2833
if location is None:
2834
if config.get_user_option('bound') != 'True':
2837
config.set_user_option('bound', 'False', warn_masked=True)
2840
self._set_config_location('bound_location', location,
2842
config.set_user_option('bound', 'True', warn_masked=True)
2845
def _get_bound_location(self, bound):
2846
"""Return the bound location in the config file.
2848
Return None if the bound parameter does not match"""
2849
config = self.get_config()
2850
config_bound = (config.get_user_option('bound') == 'True')
2851
if config_bound != bound:
2853
return self._get_config_location('bound_location', config=config)
2855
def get_bound_location(self):
2856
"""See Branch.set_push_location."""
2857
return self._get_bound_location(True)
2859
def get_old_bound_location(self):
2860
"""See Branch.get_old_bound_location"""
2861
return self._get_bound_location(False)
2863
def get_stacked_on_url(self):
2864
# you can always ask for the URL; but you might not be able to use it
2865
# if the repo can't support stacking.
2866
## self._check_stackable_repo()
2867
stacked_url = self._get_config_location('stacked_on_location')
2868
if stacked_url is None:
2869
raise errors.NotStacked(self)
2872
def _get_append_revisions_only(self):
2873
return self.get_config(
2874
).get_user_option_as_bool('append_revisions_only')
2877
def generate_revision_history(self, revision_id, last_rev=None,
2879
"""See BzrBranch5.generate_revision_history"""
2880
history = self._lefthand_history(revision_id, last_rev, other_branch)
2881
revno = len(history)
2882
self.set_last_revision_info(revno, revision_id)
2885
def get_rev_id(self, revno, history=None):
2886
"""Find the revision id of the specified revno."""
2888
return _mod_revision.NULL_REVISION
2890
last_revno, last_revision_id = self.last_revision_info()
2891
if revno <= 0 or revno > last_revno:
2892
raise errors.NoSuchRevision(self, revno)
2894
if history is not None:
2895
return history[revno - 1]
2897
index = last_revno - revno
2898
if len(self._partial_revision_history_cache) <= index:
2899
self._extend_partial_history(stop_index=index)
2900
if len(self._partial_revision_history_cache) > index:
2901
return self._partial_revision_history_cache[index]
2903
raise errors.NoSuchRevision(self, revno)
2906
def revision_id_to_revno(self, revision_id):
2907
"""Given a revision id, return its revno"""
2908
if _mod_revision.is_null(revision_id):
2911
index = self._partial_revision_history_cache.index(revision_id)
2913
self._extend_partial_history(stop_revision=revision_id)
2914
index = len(self._partial_revision_history_cache) - 1
2915
if self._partial_revision_history_cache[index] != revision_id:
2916
raise errors.NoSuchRevision(self, revision_id)
2917
return self.revno() - index
2920
class BzrBranch7(BzrBranch8):
2921
"""A branch with support for a fallback repository."""
2923
def set_reference_info(self, file_id, tree_path, branch_location):
2924
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2926
def get_reference_info(self, file_id):
2927
Branch.get_reference_info(self, file_id)
2929
def reference_parent(self, file_id, path, possible_transports=None):
2930
return Branch.reference_parent(self, file_id, path,
2931
possible_transports)
2934
class BzrBranch6(BzrBranch7):
2935
"""See BzrBranchFormat6 for the capabilities of this branch.
2937
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2941
def get_stacked_on_url(self):
2942
raise errors.UnstackableBranchFormat(self._format, self.base)
2945
######################################################################
2946
# results of operations
2949
class _Result(object):
2951
def _show_tag_conficts(self, to_file):
2952
if not getattr(self, 'tag_conflicts', None):
2954
to_file.write('Conflicting tags:\n')
2955
for name, value1, value2 in self.tag_conflicts:
2956
to_file.write(' %s\n' % (name, ))
2959
class PullResult(_Result):
2960
"""Result of a Branch.pull operation.
2962
:ivar old_revno: Revision number before pull.
2963
:ivar new_revno: Revision number after pull.
2964
:ivar old_revid: Tip revision id before pull.
2965
:ivar new_revid: Tip revision id after pull.
2966
:ivar source_branch: Source (local) branch object. (read locked)
2967
:ivar master_branch: Master branch of the target, or the target if no
2969
:ivar local_branch: target branch if there is a Master, else None
2970
:ivar target_branch: Target/destination branch object. (write locked)
2971
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2975
# DEPRECATED: pull used to return the change in revno
2976
return self.new_revno - self.old_revno
2978
def report(self, to_file):
2980
if self.old_revid == self.new_revid:
2981
to_file.write('No revisions to pull.\n')
2983
to_file.write('Now on revision %d.\n' % self.new_revno)
2984
self._show_tag_conficts(to_file)
2987
class BranchPushResult(_Result):
2988
"""Result of a Branch.push operation.
2990
:ivar old_revno: Revision number (eg 10) of the target before push.
2991
:ivar new_revno: Revision number (eg 12) of the target after push.
2992
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2994
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2996
:ivar source_branch: Source branch object that the push was from. This is
2997
read locked, and generally is a local (and thus low latency) branch.
2998
:ivar master_branch: If target is a bound branch, the master branch of
2999
target, or target itself. Always write locked.
3000
:ivar target_branch: The direct Branch where data is being sent (write
3002
:ivar local_branch: If the target is a bound branch this will be the
3003
target, otherwise it will be None.
3007
# DEPRECATED: push used to return the change in revno
3008
return self.new_revno - self.old_revno
3010
def report(self, to_file):
3011
"""Write a human-readable description of the result."""
3012
if self.old_revid == self.new_revid:
3013
note('No new revisions to push.')
3015
note('Pushed up to revision %d.' % self.new_revno)
3016
self._show_tag_conficts(to_file)
3019
class BranchCheckResult(object):
3020
"""Results of checking branch consistency.
3025
def __init__(self, branch):
3026
self.branch = branch
3029
def report_results(self, verbose):
3030
"""Report the check results via trace.note.
3032
:param verbose: Requests more detailed display of what was checked,
3035
note('checked branch %s format %s', self.branch.base,
3036
self.branch._format)
3037
for error in self.errors:
3038
note('found error:%s', error)
3041
class Converter5to6(object):
3042
"""Perform an in-place upgrade of format 5 to format 6"""
3044
def convert(self, branch):
3045
# Data for 5 and 6 can peacefully coexist.
3046
format = BzrBranchFormat6()
3047
new_branch = format.open(branch.bzrdir, _found=True)
3049
# Copy source data into target
3050
new_branch._write_last_revision_info(*branch.last_revision_info())
3051
new_branch.set_parent(branch.get_parent())
3052
new_branch.set_bound_location(branch.get_bound_location())
3053
new_branch.set_push_location(branch.get_push_location())
3055
# New branch has no tags by default
3056
new_branch.tags._set_tag_dict({})
3058
# Copying done; now update target format
3059
new_branch._transport.put_bytes('format',
3060
format.get_format_string(),
3061
mode=new_branch.bzrdir._get_file_mode())
3063
# Clean up old files
3064
new_branch._transport.delete('revision-history')
3066
branch.set_parent(None)
3067
except errors.NoSuchFile:
3069
branch.set_bound_location(None)
3072
class Converter6to7(object):
3073
"""Perform an in-place upgrade of format 6 to format 7"""
3075
def convert(self, branch):
3076
format = BzrBranchFormat7()
3077
branch._set_config_location('stacked_on_location', '')
3078
# update target format
3079
branch._transport.put_bytes('format', format.get_format_string())
3082
class Converter7to8(object):
3083
"""Perform an in-place upgrade of format 6 to format 7"""
3085
def convert(self, branch):
3086
format = BzrBranchFormat8()
3087
branch._transport.put_bytes('references', '')
3088
# update target format
3089
branch._transport.put_bytes('format', format.get_format_string())
3092
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3093
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3096
_run_with_write_locked_target will attempt to release the lock it acquires.
3098
If an exception is raised by callable, then that exception *will* be
3099
propagated, even if the unlock attempt raises its own error. Thus
3100
_run_with_write_locked_target should be preferred to simply doing::
3104
return callable(*args, **kwargs)
3109
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3110
# should share code?
3113
result = callable(*args, **kwargs)
3115
exc_info = sys.exc_info()
3119
raise exc_info[0], exc_info[1], exc_info[2]
3125
class InterBranch(InterObject):
3126
"""This class represents operations taking place between two branches.
3128
Its instances have methods like pull() and push() and contain
3129
references to the source and target repositories these operations
3130
can be carried out on.
3134
"""The available optimised InterBranch types."""
3137
def _get_branch_formats_to_test():
3138
"""Return a tuple with the Branch formats to use when testing."""
3139
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3141
def pull(self, overwrite=False, stop_revision=None,
3142
possible_transports=None, local=False):
3143
"""Mirror source into target branch.
3145
The target branch is considered to be 'local', having low latency.
3147
:returns: PullResult instance
3149
raise NotImplementedError(self.pull)
3151
def update_revisions(self, stop_revision=None, overwrite=False,
3153
"""Pull in new perfect-fit revisions.
3155
:param stop_revision: Updated until the given revision
3156
:param overwrite: Always set the branch pointer, rather than checking
3157
to see if it is a proper descendant.
3158
:param graph: A Graph object that can be used to query history
3159
information. This can be None.
3162
raise NotImplementedError(self.update_revisions)
3164
def push(self, overwrite=False, stop_revision=None,
3165
_override_hook_source_branch=None):
3166
"""Mirror the source branch into the target branch.
3168
The source branch is considered to be 'local', having low latency.
3170
raise NotImplementedError(self.push)
3173
class GenericInterBranch(InterBranch):
3174
"""InterBranch implementation that uses public Branch functions.
3178
def _get_branch_formats_to_test():
3179
return BranchFormat._default_format, BranchFormat._default_format
3181
def update_revisions(self, stop_revision=None, overwrite=False,
3183
"""See InterBranch.update_revisions()."""
3184
self.source.lock_read()
3186
other_revno, other_last_revision = self.source.last_revision_info()
3187
stop_revno = None # unknown
3188
if stop_revision is None:
3189
stop_revision = other_last_revision
3190
if _mod_revision.is_null(stop_revision):
3191
# if there are no commits, we're done.
3193
stop_revno = other_revno
3195
# what's the current last revision, before we fetch [and change it
3197
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3198
# we fetch here so that we don't process data twice in the common
3199
# case of having something to pull, and so that the check for
3200
# already merged can operate on the just fetched graph, which will
3201
# be cached in memory.
3202
self.target.fetch(self.source, stop_revision)
3203
# Check to see if one is an ancestor of the other
3206
graph = self.target.repository.get_graph()
3207
if self.target._check_if_descendant_or_diverged(
3208
stop_revision, last_rev, graph, self.source):
3209
# stop_revision is a descendant of last_rev, but we aren't
3210
# overwriting, so we're done.
3212
if stop_revno is None:
3214
graph = self.target.repository.get_graph()
3215
this_revno, this_last_revision = \
3216
self.target.last_revision_info()
3217
stop_revno = graph.find_distance_to_null(stop_revision,
3218
[(other_last_revision, other_revno),
3219
(this_last_revision, this_revno)])
3220
self.target.set_last_revision_info(stop_revno, stop_revision)
3222
self.source.unlock()
3224
def pull(self, overwrite=False, stop_revision=None,
3225
possible_transports=None, _hook_master=None, run_hooks=True,
3226
_override_hook_target=None, local=False):
3229
:param _hook_master: Private parameter - set the branch to
3230
be supplied as the master to pull hooks.
3231
:param run_hooks: Private parameter - if false, this branch
3232
is being called because it's the master of the primary branch,
3233
so it should not run its hooks.
3234
:param _override_hook_target: Private parameter - set the branch to be
3235
supplied as the target_branch to pull hooks.
3236
:param local: Only update the local branch, and not the bound branch.
3238
# This type of branch can't be bound.
3240
raise errors.LocalRequiresBoundBranch()
3241
result = PullResult()
3242
result.source_branch = self.source
3243
if _override_hook_target is None:
3244
result.target_branch = self.target
3246
result.target_branch = _override_hook_target
3247
self.source.lock_read()
3249
# We assume that during 'pull' the target repository is closer than
3251
self.source.update_references(self.target)
3252
graph = self.target.repository.get_graph(self.source.repository)
3253
# TODO: Branch formats should have a flag that indicates
3254
# that revno's are expensive, and pull() should honor that flag.
3256
result.old_revno, result.old_revid = \
3257
self.target.last_revision_info()
3258
self.target.update_revisions(self.source, stop_revision,
3259
overwrite=overwrite, graph=graph)
3260
# TODO: The old revid should be specified when merging tags,
3261
# so a tags implementation that versions tags can only
3262
# pull in the most recent changes. -- JRV20090506
3263
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3265
result.new_revno, result.new_revid = self.target.last_revision_info()
3267
result.master_branch = _hook_master
3268
result.local_branch = result.target_branch
3270
result.master_branch = result.target_branch
3271
result.local_branch = None
3273
for hook in Branch.hooks['post_pull']:
3276
self.source.unlock()
3279
def push(self, overwrite=False, stop_revision=None,
3280
_override_hook_source_branch=None):
3281
"""See InterBranch.push.
3283
This is the basic concrete implementation of push()
3285
:param _override_hook_source_branch: If specified, run
3286
the hooks passing this Branch as the source, rather than self.
3287
This is for use of RemoteBranch, where push is delegated to the
3288
underlying vfs-based Branch.
3290
# TODO: Public option to disable running hooks - should be trivial but
3292
self.source.lock_read()
3294
return _run_with_write_locked_target(
3295
self.target, self._push_with_bound_branches, overwrite,
3297
_override_hook_source_branch=_override_hook_source_branch)
3299
self.source.unlock()
3301
def _push_with_bound_branches(self, overwrite, stop_revision,
3302
_override_hook_source_branch=None):
3303
"""Push from source into target, and into target's master if any.
3306
if _override_hook_source_branch:
3307
result.source_branch = _override_hook_source_branch
3308
for hook in Branch.hooks['post_push']:
3311
bound_location = self.target.get_bound_location()
3312
if bound_location and self.target.base != bound_location:
3313
# there is a master branch.
3315
# XXX: Why the second check? Is it even supported for a branch to
3316
# be bound to itself? -- mbp 20070507
3317
master_branch = self.target.get_master_branch()
3318
master_branch.lock_write()
3320
# push into the master from the source branch.
3321
self.source._basic_push(master_branch, overwrite, stop_revision)
3322
# and push into the target branch from the source. Note that we
3323
# push from the source branch again, because its considered the
3324
# highest bandwidth repository.
3325
result = self.source._basic_push(self.target, overwrite,
3327
result.master_branch = master_branch
3328
result.local_branch = self.target
3332
master_branch.unlock()
3335
result = self.source._basic_push(self.target, overwrite,
3337
# TODO: Why set master_branch and local_branch if there's no
3338
# binding? Maybe cleaner to just leave them unset? -- mbp
3340
result.master_branch = self.target
3341
result.local_branch = None
3346
def is_compatible(self, source, target):
3347
# GenericBranch uses the public API, so always compatible
3351
class InterToBranch5(GenericInterBranch):
3354
def _get_branch_formats_to_test():
3355
return BranchFormat._default_format, BzrBranchFormat5()
3357
def pull(self, overwrite=False, stop_revision=None,
3358
possible_transports=None, run_hooks=True,
3359
_override_hook_target=None, local=False):
3360
"""Pull from source into self, updating my master if any.
3362
:param run_hooks: Private parameter - if false, this branch
3363
is being called because it's the master of the primary branch,
3364
so it should not run its hooks.
3366
bound_location = self.target.get_bound_location()
3367
if local and not bound_location:
3368
raise errors.LocalRequiresBoundBranch()
3369
master_branch = None
3370
if not local and bound_location and self.source.base != bound_location:
3371
# not pulling from master, so we need to update master.
3372
master_branch = self.target.get_master_branch(possible_transports)
3373
master_branch.lock_write()
3376
# pull from source into master.
3377
master_branch.pull(self.source, overwrite, stop_revision,
3379
return super(InterToBranch5, self).pull(overwrite,
3380
stop_revision, _hook_master=master_branch,
3381
run_hooks=run_hooks,
3382
_override_hook_target=_override_hook_target)
3385
master_branch.unlock()
3388
InterBranch.register_optimiser(GenericInterBranch)
3389
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
