13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
18
21
from cStringIO import StringIO
20
23
from bzrlib.lazy_import import lazy_import
21
24
lazy_import(globals(), """
22
from copy import deepcopy
23
from unittest import TestSuite
24
from warnings import warn
27
26
from bzrlib import (
30
config as _mod_config,
35
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TreeConfig
42
from bzrlib.lockable_files import LockableFiles, TransportLock
31
config as _mod_config,
40
revision as _mod_revision,
49
from bzrlib.i18n import gettext, ngettext
45
from bzrlib.decorators import needs_read_lock, needs_write_lock
46
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
47
HistoryMissing, InvalidRevisionId,
48
InvalidRevisionNumber, LockError, NoSuchFile,
49
NoSuchRevision, NoWorkingTree, NotVersionedError,
50
NotBranchError, UninitializableFormat,
51
UnlistableStore, UnlistableBranch,
53
from bzrlib.symbol_versioning import (deprecated_function,
57
zero_eight, zero_nine,
59
from bzrlib.trace import mutter, note
62
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
63
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
64
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
67
# TODO: Maybe include checks for common corruption of newlines, etc?
69
# TODO: Some operations like log might retrieve the same revisions
70
# repeatedly to calculate deltas. We could perhaps have a weakref
71
# cache in memory to make this faster. In general anything can be
72
# cached in memory between lock and unlock operations. .. nb thats
73
# what the transaction identity map provides
76
######################################################################
52
# Explicitly import bzrlib.bzrdir so that the BzrProber
53
# is guaranteed to be registered.
60
from bzrlib.decorators import (
65
from bzrlib.hooks import Hooks
66
from bzrlib.inter import InterObject
67
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
68
from bzrlib import registry
69
from bzrlib.symbol_versioning import (
73
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
76
class Branch(controldir.ControlComponent):
80
77
"""Branch holding a history of revisions.
83
Base directory/url of the branch.
85
hooks: An instance of BranchHooks.
80
Base directory/url of the branch; using control_url and
81
control_transport is more standardized.
82
:ivar hooks: An instance of BranchHooks.
83
:ivar _master_branch_cache: cached result of get_master_branch, see
87
86
# this is really an instance variable - FIXME move it there
91
def __init__(self, *ignored, **ignored_too):
92
raise NotImplementedError('The Branch class is abstract')
91
def control_transport(self):
92
return self._transport
95
def user_transport(self):
96
return self.bzrdir.user_transport
98
def __init__(self, possible_transports=None):
99
self.tags = self._format.make_tags(self)
100
self._revision_history_cache = None
101
self._revision_id_to_revno_cache = None
102
self._partial_revision_id_to_revno_cache = {}
103
self._partial_revision_history_cache = []
104
self._tags_bytes = None
105
self._last_revision_info_cache = None
106
self._master_branch_cache = None
107
self._merge_sorted_revisions_cache = None
108
self._open_hook(possible_transports)
109
hooks = Branch.hooks['open']
113
def _open_hook(self, possible_transports):
114
"""Called by init to allow simpler extension of the base class."""
116
def _activate_fallback_location(self, url, possible_transports):
117
"""Activate the branch/repository from url as a fallback repository."""
118
for existing_fallback_repo in self.repository._fallback_repositories:
119
if existing_fallback_repo.user_url == url:
120
# This fallback is already configured. This probably only
121
# happens because ControlDir.sprout is a horrible mess. To avoid
122
# confusing _unstack we don't add this a second time.
123
mutter('duplicate activation of fallback %r on %r', url, self)
125
repo = self._get_fallback_repository(url, possible_transports)
126
if repo.has_same_location(self.repository):
127
raise errors.UnstackableLocationError(self.user_url, url)
128
self.repository.add_fallback_repository(repo)
94
130
def break_lock(self):
95
131
"""Break a lock if one is present from another instance.
105
141
if master is not None:
106
142
master.break_lock()
109
@deprecated_method(zero_eight)
110
def open_downlevel(base):
111
"""Open a branch which may be of an old format."""
112
return Branch.open(base, _unsupported=True)
115
def open(base, _unsupported=False):
144
def _check_stackable_repo(self):
145
if not self.repository._format.supports_external_lookups:
146
raise errors.UnstackableRepositoryFormat(self.repository._format,
147
self.repository.base)
149
def _extend_partial_history(self, stop_index=None, stop_revision=None):
150
"""Extend the partial history to include a given index
152
If a stop_index is supplied, stop when that index has been reached.
153
If a stop_revision is supplied, stop when that revision is
154
encountered. Otherwise, stop when the beginning of history is
157
:param stop_index: The index which should be present. When it is
158
present, history extension will stop.
159
:param stop_revision: The revision id which should be present. When
160
it is encountered, history extension will stop.
162
if len(self._partial_revision_history_cache) == 0:
163
self._partial_revision_history_cache = [self.last_revision()]
164
repository._iter_for_revno(
165
self.repository, self._partial_revision_history_cache,
166
stop_index=stop_index, stop_revision=stop_revision)
167
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
168
self._partial_revision_history_cache.pop()
170
def _get_check_refs(self):
171
"""Get the references needed for check().
175
revid = self.last_revision()
176
return [('revision-existence', revid), ('lefthand-distance', revid)]
179
def open(base, _unsupported=False, possible_transports=None):
116
180
"""Open the branch rooted at base.
118
182
For instance, if the branch is at URL/.bzr/branch,
119
183
Branch.open(URL) -> a Branch instance.
121
control = bzrdir.BzrDir.open(base, _unsupported)
122
return control.open_branch(_unsupported)
125
def open_containing(url):
185
control = controldir.ControlDir.open(base,
186
possible_transports=possible_transports, _unsupported=_unsupported)
187
return control.open_branch(unsupported=_unsupported,
188
possible_transports=possible_transports)
191
def open_from_transport(transport, name=None, _unsupported=False,
192
possible_transports=None):
193
"""Open the branch rooted at transport"""
194
control = controldir.ControlDir.open_from_transport(transport, _unsupported)
195
return control.open_branch(name=name, unsupported=_unsupported,
196
possible_transports=possible_transports)
199
def open_containing(url, possible_transports=None):
126
200
"""Open an existing branch which contains url.
128
202
This probes for a branch at url, and searches upwards from there.
130
204
Basically we keep looking up until we find the control directory or
131
205
run into the root. If there isn't one, raises NotBranchError.
132
If there is one and it is either an unrecognised format or an unsupported
206
If there is one and it is either an unrecognised format or an unsupported
133
207
format, UnknownFormatError or UnsupportedFormatError are raised.
134
208
If there is one, it is returned, along with the unused portion of url.
136
control, relpath = bzrdir.BzrDir.open_containing(url)
137
return control.open_branch(), relpath
140
@deprecated_function(zero_eight)
141
def initialize(base):
142
"""Create a new working tree and branch, rooted at 'base' (url)
144
NOTE: This will soon be deprecated in favour of creation
147
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
149
@deprecated_function(zero_eight)
150
def setup_caching(self, cache_root):
151
"""Subclasses that care about caching should override this, and set
152
up cached stores located under cache_root.
154
NOTE: This is unused.
210
control, relpath = controldir.ControlDir.open_containing(url,
212
branch = control.open_branch(possible_transports=possible_transports)
213
return (branch, relpath)
215
def _push_should_merge_tags(self):
216
"""Should _basic_push merge this branch's tags into the target?
218
The default implementation returns False if this branch has no tags,
219
and True the rest of the time. Subclasses may override this.
221
return self.supports_tags() and self.tags.get_tag_dict()
158
223
def get_config(self):
159
return BranchConfig(self)
162
return self.get_config().get_nickname()
224
"""Get a bzrlib.config.BranchConfig for this Branch.
226
This can then be used to get and set configuration options for the
229
:return: A bzrlib.config.BranchConfig.
231
return _mod_config.BranchConfig(self)
233
def get_config_stack(self):
234
"""Get a bzrlib.config.BranchStack for this Branch.
236
This can then be used to get and set configuration options for the
239
:return: A bzrlib.config.BranchStack.
241
return _mod_config.BranchStack(self)
243
def _get_config(self):
244
"""Get the concrete config for just the config in this branch.
246
This is not intended for client use; see Branch.get_config for the
251
:return: An object supporting get_option and set_option.
253
raise NotImplementedError(self._get_config)
255
def store_uncommitted(self, creator):
256
"""Store uncommitted changes from a ShelfCreator.
258
:param creator: The ShelfCreator containing uncommitted changes, or
259
None to delete any stored changes.
260
:raises: ChangesAlreadyStored if the branch already has changes.
262
raise NotImplementedError(self.store_uncommitted)
264
def get_unshelver(self, tree):
265
"""Return a shelf.Unshelver for this branch and tree.
267
:param tree: The tree to use to construct the Unshelver.
268
:return: an Unshelver or None if no changes are stored.
270
raise NotImplementedError(self.get_unshelver)
272
def _get_fallback_repository(self, url, possible_transports):
273
"""Get the repository we fallback to at url."""
274
url = urlutils.join(self.base, url)
275
a_branch = Branch.open(url, possible_transports=possible_transports)
276
return a_branch.repository
279
def _get_tags_bytes(self):
280
"""Get the bytes of a serialised tags dict.
282
Note that not all branches support tags, nor do all use the same tags
283
logic: this method is specific to BasicTags. Other tag implementations
284
may use the same method name and behave differently, safely, because
285
of the double-dispatch via
286
format.make_tags->tags_instance->get_tags_dict.
288
:return: The bytes of the tags file.
289
:seealso: Branch._set_tags_bytes.
291
if self._tags_bytes is None:
292
self._tags_bytes = self._transport.get_bytes('tags')
293
return self._tags_bytes
295
def _get_nick(self, local=False, possible_transports=None):
296
config = self.get_config()
297
# explicit overrides master, but don't look for master if local is True
298
if not local and not config.has_explicit_nickname():
300
master = self.get_master_branch(possible_transports)
301
if master and self.user_url == master.user_url:
302
raise errors.RecursiveBind(self.user_url)
303
if master is not None:
304
# return the master branch value
306
except errors.RecursiveBind, e:
308
except errors.BzrError, e:
309
# Silently fall back to local implicit nick if the master is
311
mutter("Could not connect to bound branch, "
312
"falling back to local nick.\n " + str(e))
313
return config.get_nickname()
164
315
def _set_nick(self, nick):
165
self.get_config().set_user_option('nickname', nick)
316
self.get_config().set_user_option('nickname', nick, warn_masked=True)
167
318
nick = property(_get_nick, _set_nick)
169
320
def is_locked(self):
170
321
raise NotImplementedError(self.is_locked)
172
def lock_write(self):
323
def _lefthand_history(self, revision_id, last_rev=None,
325
if 'evil' in debug.debug_flags:
326
mutter_callsite(4, "_lefthand_history scales with history.")
327
# stop_revision must be a descendant of last_revision
328
graph = self.repository.get_graph()
329
if last_rev is not None:
330
if not graph.is_ancestor(last_rev, revision_id):
331
# our previous tip is not merged into stop_revision
332
raise errors.DivergedBranches(self, other_branch)
333
# make a new revision history from the graph
334
parents_map = graph.get_parent_map([revision_id])
335
if revision_id not in parents_map:
336
raise errors.NoSuchRevision(self, revision_id)
337
current_rev_id = revision_id
339
check_not_reserved_id = _mod_revision.check_not_reserved_id
340
# Do not include ghosts or graph origin in revision_history
341
while (current_rev_id in parents_map and
342
len(parents_map[current_rev_id]) > 0):
343
check_not_reserved_id(current_rev_id)
344
new_history.append(current_rev_id)
345
current_rev_id = parents_map[current_rev_id][0]
346
parents_map = graph.get_parent_map([current_rev_id])
347
new_history.reverse()
350
def lock_write(self, token=None):
351
"""Lock the branch for write operations.
353
:param token: A token to permit reacquiring a previously held and
355
:return: A BranchWriteLockResult.
173
357
raise NotImplementedError(self.lock_write)
175
359
def lock_read(self):
360
"""Lock the branch for read operations.
362
:return: A bzrlib.lock.LogicalLockResult.
176
364
raise NotImplementedError(self.lock_read)
178
366
def unlock(self):
185
373
def get_physical_lock_status(self):
186
374
raise NotImplementedError(self.get_physical_lock_status)
188
def abspath(self, name):
189
"""Return absolute filename for something in the branch
191
XXX: Robert Collins 20051017 what is this used for? why is it a branch
192
method and not a tree method.
194
raise NotImplementedError(self.abspath)
377
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
378
"""Return the revision_id for a dotted revno.
380
:param revno: a tuple like (1,) or (1,1,2)
381
:param _cache_reverse: a private parameter enabling storage
382
of the reverse mapping in a top level cache. (This should
383
only be done in selective circumstances as we want to
384
avoid having the mapping cached multiple times.)
385
:return: the revision_id
386
:raises errors.NoSuchRevision: if the revno doesn't exist
388
rev_id = self._do_dotted_revno_to_revision_id(revno)
390
self._partial_revision_id_to_revno_cache[rev_id] = revno
393
def _do_dotted_revno_to_revision_id(self, revno):
394
"""Worker function for dotted_revno_to_revision_id.
396
Subclasses should override this if they wish to
397
provide a more efficient implementation.
400
return self.get_rev_id(revno[0])
401
revision_id_to_revno = self.get_revision_id_to_revno_map()
402
revision_ids = [revision_id for revision_id, this_revno
403
in revision_id_to_revno.iteritems()
404
if revno == this_revno]
405
if len(revision_ids) == 1:
406
return revision_ids[0]
408
revno_str = '.'.join(map(str, revno))
409
raise errors.NoSuchRevision(self, revno_str)
412
def revision_id_to_dotted_revno(self, revision_id):
413
"""Given a revision id, return its dotted revno.
415
:return: a tuple like (1,) or (400,1,3).
417
return self._do_revision_id_to_dotted_revno(revision_id)
419
def _do_revision_id_to_dotted_revno(self, revision_id):
420
"""Worker function for revision_id_to_revno."""
421
# Try the caches if they are loaded
422
result = self._partial_revision_id_to_revno_cache.get(revision_id)
423
if result is not None:
425
if self._revision_id_to_revno_cache:
426
result = self._revision_id_to_revno_cache.get(revision_id)
428
raise errors.NoSuchRevision(self, revision_id)
429
# Try the mainline as it's optimised
431
revno = self.revision_id_to_revno(revision_id)
433
except errors.NoSuchRevision:
434
# We need to load and use the full revno map after all
435
result = self.get_revision_id_to_revno_map().get(revision_id)
437
raise errors.NoSuchRevision(self, revision_id)
441
def get_revision_id_to_revno_map(self):
442
"""Return the revision_id => dotted revno map.
444
This will be regenerated on demand, but will be cached.
446
:return: A dictionary mapping revision_id => dotted revno.
447
This dictionary should not be modified by the caller.
449
if self._revision_id_to_revno_cache is not None:
450
mapping = self._revision_id_to_revno_cache
452
mapping = self._gen_revno_map()
453
self._cache_revision_id_to_revno(mapping)
454
# TODO: jam 20070417 Since this is being cached, should we be returning
456
# I would rather not, and instead just declare that users should not
457
# modify the return value.
460
def _gen_revno_map(self):
461
"""Create a new mapping from revision ids to dotted revnos.
463
Dotted revnos are generated based on the current tip in the revision
465
This is the worker function for get_revision_id_to_revno_map, which
466
just caches the return value.
468
:return: A dictionary mapping revision_id => dotted revno.
470
revision_id_to_revno = dict((rev_id, revno)
471
for rev_id, depth, revno, end_of_merge
472
in self.iter_merge_sorted_revisions())
473
return revision_id_to_revno
476
def iter_merge_sorted_revisions(self, start_revision_id=None,
477
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
478
"""Walk the revisions for a branch in merge sorted order.
480
Merge sorted order is the output from a merge-aware,
481
topological sort, i.e. all parents come before their
482
children going forward; the opposite for reverse.
484
:param start_revision_id: the revision_id to begin walking from.
485
If None, the branch tip is used.
486
:param stop_revision_id: the revision_id to terminate the walk
487
after. If None, the rest of history is included.
488
:param stop_rule: if stop_revision_id is not None, the precise rule
489
to use for termination:
491
* 'exclude' - leave the stop revision out of the result (default)
492
* 'include' - the stop revision is the last item in the result
493
* 'with-merges' - include the stop revision and all of its
494
merged revisions in the result
495
* 'with-merges-without-common-ancestry' - filter out revisions
496
that are in both ancestries
497
:param direction: either 'reverse' or 'forward':
499
* reverse means return the start_revision_id first, i.e.
500
start at the most recent revision and go backwards in history
501
* forward returns tuples in the opposite order to reverse.
502
Note in particular that forward does *not* do any intelligent
503
ordering w.r.t. depth as some clients of this API may like.
504
(If required, that ought to be done at higher layers.)
506
:return: an iterator over (revision_id, depth, revno, end_of_merge)
509
* revision_id: the unique id of the revision
510
* depth: How many levels of merging deep this node has been
512
* revno_sequence: This field provides a sequence of
513
revision numbers for all revisions. The format is:
514
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
515
branch that the revno is on. From left to right the REVNO numbers
516
are the sequence numbers within that branch of the revision.
517
* end_of_merge: When True the next node (earlier in history) is
518
part of a different merge.
520
# Note: depth and revno values are in the context of the branch so
521
# we need the full graph to get stable numbers, regardless of the
523
if self._merge_sorted_revisions_cache is None:
524
last_revision = self.last_revision()
525
known_graph = self.repository.get_known_graph_ancestry(
527
self._merge_sorted_revisions_cache = known_graph.merge_sort(
529
filtered = self._filter_merge_sorted_revisions(
530
self._merge_sorted_revisions_cache, start_revision_id,
531
stop_revision_id, stop_rule)
532
# Make sure we don't return revisions that are not part of the
533
# start_revision_id ancestry.
534
filtered = self._filter_start_non_ancestors(filtered)
535
if direction == 'reverse':
537
if direction == 'forward':
538
return reversed(list(filtered))
540
raise ValueError('invalid direction %r' % direction)
542
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
543
start_revision_id, stop_revision_id, stop_rule):
544
"""Iterate over an inclusive range of sorted revisions."""
545
rev_iter = iter(merge_sorted_revisions)
546
if start_revision_id is not None:
547
for node in rev_iter:
549
if rev_id != start_revision_id:
552
# The decision to include the start or not
553
# depends on the stop_rule if a stop is provided
554
# so pop this node back into the iterator
555
rev_iter = itertools.chain(iter([node]), rev_iter)
557
if stop_revision_id is None:
559
for node in rev_iter:
561
yield (rev_id, node.merge_depth, node.revno,
563
elif stop_rule == 'exclude':
564
for node in rev_iter:
566
if rev_id == stop_revision_id:
568
yield (rev_id, node.merge_depth, node.revno,
570
elif stop_rule == 'include':
571
for node in rev_iter:
573
yield (rev_id, node.merge_depth, node.revno,
575
if rev_id == stop_revision_id:
577
elif stop_rule == 'with-merges-without-common-ancestry':
578
# We want to exclude all revisions that are already part of the
579
# stop_revision_id ancestry.
580
graph = self.repository.get_graph()
581
ancestors = graph.find_unique_ancestors(start_revision_id,
583
for node in rev_iter:
585
if rev_id not in ancestors:
587
yield (rev_id, node.merge_depth, node.revno,
589
elif stop_rule == 'with-merges':
590
stop_rev = self.repository.get_revision(stop_revision_id)
591
if stop_rev.parent_ids:
592
left_parent = stop_rev.parent_ids[0]
594
left_parent = _mod_revision.NULL_REVISION
595
# left_parent is the actual revision we want to stop logging at,
596
# since we want to show the merged revisions after the stop_rev too
597
reached_stop_revision_id = False
598
revision_id_whitelist = []
599
for node in rev_iter:
601
if rev_id == left_parent:
602
# reached the left parent after the stop_revision
604
if (not reached_stop_revision_id or
605
rev_id in revision_id_whitelist):
606
yield (rev_id, node.merge_depth, node.revno,
608
if reached_stop_revision_id or rev_id == stop_revision_id:
609
# only do the merged revs of rev_id from now on
610
rev = self.repository.get_revision(rev_id)
612
reached_stop_revision_id = True
613
revision_id_whitelist.extend(rev.parent_ids)
615
raise ValueError('invalid stop_rule %r' % stop_rule)
617
def _filter_start_non_ancestors(self, rev_iter):
618
# If we started from a dotted revno, we want to consider it as a tip
619
# and don't want to yield revisions that are not part of its
620
# ancestry. Given the order guaranteed by the merge sort, we will see
621
# uninteresting descendants of the first parent of our tip before the
623
first = rev_iter.next()
624
(rev_id, merge_depth, revno, end_of_merge) = first
627
# We start at a mainline revision so by definition, all others
628
# revisions in rev_iter are ancestors
629
for node in rev_iter:
634
pmap = self.repository.get_parent_map([rev_id])
635
parents = pmap.get(rev_id, [])
637
whitelist.update(parents)
639
# If there is no parents, there is nothing of interest left
641
# FIXME: It's hard to test this scenario here as this code is never
642
# called in that case. -- vila 20100322
645
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
647
if rev_id in whitelist:
648
pmap = self.repository.get_parent_map([rev_id])
649
parents = pmap.get(rev_id, [])
650
whitelist.remove(rev_id)
651
whitelist.update(parents)
653
# We've reached the mainline, there is nothing left to
657
# A revision that is not part of the ancestry of our
660
yield (rev_id, merge_depth, revno, end_of_merge)
662
def leave_lock_in_place(self):
663
"""Tell this branch object not to release the physical lock when this
666
If lock_write doesn't return a token, then this method is not supported.
668
self.control_files.leave_in_place()
670
def dont_leave_lock_in_place(self):
671
"""Tell this branch object to release the physical lock when this
672
object is unlocked, even if it didn't originally acquire it.
674
If lock_write doesn't return a token, then this method is not supported.
676
self.control_files.dont_leave_in_place()
196
678
def bind(self, other):
197
679
"""Bind the local branch the other branch.
261
740
:param committer: Optional committer to set for commit.
262
741
:param revprops: Optional dictionary of revision properties.
263
742
:param revision_id: Optional revision id.
743
:param lossy: Whether to discard data that can not be natively
744
represented, when pushing to a foreign VCS
267
config = self.get_config()
269
return self.repository.get_commit_builder(self, parents, config,
270
timestamp, timezone, committer, revprops, revision_id)
272
def get_master_branch(self):
747
if config_stack is None:
748
config_stack = self.get_config_stack()
750
return self.repository.get_commit_builder(self, parents, config_stack,
751
timestamp, timezone, committer, revprops, revision_id,
754
def get_master_branch(self, possible_transports=None):
273
755
"""Return the branch we are bound to.
275
757
:return: Either a Branch, or None
761
@deprecated_method(deprecated_in((2, 5, 0)))
279
762
def get_revision_delta(self, revno):
280
763
"""Return the delta for one revision.
282
765
The delta is relative to its mainline predecessor, or the
283
766
empty tree for revision 1.
285
assert isinstance(revno, int)
286
rh = self.revision_history()
287
if not (1 <= revno <= len(rh)):
288
raise InvalidRevisionNumber(revno)
289
return self.repository.get_revision_delta(rh[revno-1])
291
def get_root_id(self):
292
"""Return the id of this branches root"""
293
raise NotImplementedError(self.get_root_id)
769
revid = self.get_rev_id(revno)
770
except errors.NoSuchRevision:
771
raise errors.InvalidRevisionNumber(revno)
772
return self.repository.get_revision_delta(revid)
774
def get_stacked_on_url(self):
775
"""Get the URL this branch is stacked against.
777
:raises NotStacked: If the branch is not stacked.
778
:raises UnstackableBranchFormat: If the branch does not support
781
raise NotImplementedError(self.get_stacked_on_url)
295
783
def print_file(self, file, revision_id):
296
784
"""Print `file` to stdout."""
297
785
raise NotImplementedError(self.print_file)
299
def append_revision(self, *revision_ids):
300
raise NotImplementedError(self.append_revision)
302
def set_revision_history(self, rev_history):
303
raise NotImplementedError(self.set_revision_history)
305
def revision_history(self):
306
"""Return sequence of revision hashes on to this branch."""
307
raise NotImplementedError(self.revision_history)
788
def set_last_revision_info(self, revno, revision_id):
789
"""Set the last revision of this branch.
791
The caller is responsible for checking that the revno is correct
792
for this revision id.
794
It may be possible to set the branch last revision to an id not
795
present in the repository. However, branches can also be
796
configured to check constraints on history, in which case this may not
799
raise NotImplementedError(self.set_last_revision_info)
802
def generate_revision_history(self, revision_id, last_rev=None,
804
"""See Branch.generate_revision_history"""
805
graph = self.repository.get_graph()
806
(last_revno, last_revid) = self.last_revision_info()
807
known_revision_ids = [
808
(last_revid, last_revno),
809
(_mod_revision.NULL_REVISION, 0),
811
if last_rev is not None:
812
if not graph.is_ancestor(last_rev, revision_id):
813
# our previous tip is not merged into stop_revision
814
raise errors.DivergedBranches(self, other_branch)
815
revno = graph.find_distance_to_null(revision_id, known_revision_ids)
816
self.set_last_revision_info(revno, revision_id)
819
def set_parent(self, url):
820
"""See Branch.set_parent."""
821
# TODO: Maybe delete old location files?
822
# URLs should never be unicode, even on the local fs,
823
# FIXUP this and get_parent in a future branch format bump:
824
# read and rewrite the file. RBC 20060125
826
if isinstance(url, unicode):
828
url = url.encode('ascii')
829
except UnicodeEncodeError:
830
raise errors.InvalidURL(url,
831
"Urls must be 7-bit ascii, "
832
"use bzrlib.urlutils.escape")
833
url = urlutils.relative_url(self.base, url)
834
self._set_parent_location(url)
837
def set_stacked_on_url(self, url):
838
"""Set the URL this branch is stacked against.
840
:raises UnstackableBranchFormat: If the branch does not support
842
:raises UnstackableRepositoryFormat: If the repository does not support
845
if not self._format.supports_stacking():
846
raise errors.UnstackableBranchFormat(self._format, self.user_url)
847
# XXX: Changing from one fallback repository to another does not check
848
# that all the data you need is present in the new fallback.
849
# Possibly it should.
850
self._check_stackable_repo()
853
old_url = self.get_stacked_on_url()
854
except (errors.NotStacked, errors.UnstackableBranchFormat,
855
errors.UnstackableRepositoryFormat):
859
self._activate_fallback_location(url,
860
possible_transports=[self.bzrdir.root_transport])
861
# write this out after the repository is stacked to avoid setting a
862
# stacked config that doesn't work.
863
self._set_config_location('stacked_on_location', url)
866
"""Change a branch to be unstacked, copying data as needed.
868
Don't call this directly, use set_stacked_on_url(None).
870
pb = ui.ui_factory.nested_progress_bar()
872
pb.update(gettext("Unstacking"))
873
# The basic approach here is to fetch the tip of the branch,
874
# including all available ghosts, from the existing stacked
875
# repository into a new repository object without the fallbacks.
877
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
878
# correct for CHKMap repostiories
879
old_repository = self.repository
880
if len(old_repository._fallback_repositories) != 1:
881
raise AssertionError("can't cope with fallback repositories "
882
"of %r (fallbacks: %r)" % (old_repository,
883
old_repository._fallback_repositories))
884
# Open the new repository object.
885
# Repositories don't offer an interface to remove fallback
886
# repositories today; take the conceptually simpler option and just
887
# reopen it. We reopen it starting from the URL so that we
888
# get a separate connection for RemoteRepositories and can
889
# stream from one of them to the other. This does mean doing
890
# separate SSH connection setup, but unstacking is not a
891
# common operation so it's tolerable.
892
new_bzrdir = controldir.ControlDir.open(
893
self.bzrdir.root_transport.base)
894
new_repository = new_bzrdir.find_repository()
895
if new_repository._fallback_repositories:
896
raise AssertionError("didn't expect %r to have "
897
"fallback_repositories"
898
% (self.repository,))
899
# Replace self.repository with the new repository.
900
# Do our best to transfer the lock state (i.e. lock-tokens and
901
# lock count) of self.repository to the new repository.
902
lock_token = old_repository.lock_write().repository_token
903
self.repository = new_repository
904
if isinstance(self, remote.RemoteBranch):
905
# Remote branches can have a second reference to the old
906
# repository that need to be replaced.
907
if self._real_branch is not None:
908
self._real_branch.repository = new_repository
909
self.repository.lock_write(token=lock_token)
910
if lock_token is not None:
911
old_repository.leave_lock_in_place()
912
old_repository.unlock()
913
if lock_token is not None:
914
# XXX: self.repository.leave_lock_in_place() before this
915
# function will not be preserved. Fortunately that doesn't
916
# affect the current default format (2a), and would be a
917
# corner-case anyway.
918
# - Andrew Bennetts, 2010/06/30
919
self.repository.dont_leave_lock_in_place()
923
old_repository.unlock()
924
except errors.LockNotHeld:
927
if old_lock_count == 0:
928
raise AssertionError(
929
'old_repository should have been locked at least once.')
930
for i in range(old_lock_count-1):
931
self.repository.lock_write()
932
# Fetch from the old repository into the new.
933
old_repository.lock_read()
935
# XXX: If you unstack a branch while it has a working tree
936
# with a pending merge, the pending-merged revisions will no
937
# longer be present. You can (probably) revert and remerge.
939
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
940
except errors.TagsNotSupported:
941
tags_to_fetch = set()
942
fetch_spec = vf_search.NotInOtherForRevs(self.repository,
943
old_repository, required_ids=[self.last_revision()],
944
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
945
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
947
old_repository.unlock()
951
def _set_tags_bytes(self, bytes):
952
"""Mirror method for _get_tags_bytes.
954
:seealso: Branch._get_tags_bytes.
956
op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
957
op.add_cleanup(self.lock_write().unlock)
958
return op.run_simple(bytes)
960
def _set_tags_bytes_locked(self, bytes):
961
self._tags_bytes = bytes
962
return self._transport.put_bytes('tags', bytes)
964
def _cache_revision_history(self, rev_history):
965
"""Set the cached revision history to rev_history.
967
The revision_history method will use this cache to avoid regenerating
968
the revision history.
970
This API is semi-public; it only for use by subclasses, all other code
971
should consider it to be private.
973
self._revision_history_cache = rev_history
975
def _cache_revision_id_to_revno(self, revision_id_to_revno):
976
"""Set the cached revision_id => revno map to revision_id_to_revno.
978
This API is semi-public; it only for use by subclasses, all other code
979
should consider it to be private.
981
self._revision_id_to_revno_cache = revision_id_to_revno
983
def _clear_cached_state(self):
984
"""Clear any cached data on this branch, e.g. cached revision history.
986
This means the next call to revision_history will need to call
987
_gen_revision_history.
989
This API is semi-public; it is only for use by subclasses, all other
990
code should consider it to be private.
992
self._revision_history_cache = None
993
self._revision_id_to_revno_cache = None
994
self._last_revision_info_cache = None
995
self._master_branch_cache = None
996
self._merge_sorted_revisions_cache = None
997
self._partial_revision_history_cache = []
998
self._partial_revision_id_to_revno_cache = {}
999
self._tags_bytes = None
1001
def _gen_revision_history(self):
1002
"""Return sequence of revision hashes on to this branch.
1004
Unlike revision_history, this method always regenerates or rereads the
1005
revision history, i.e. it does not cache the result, so repeated calls
1008
Concrete subclasses should override this instead of revision_history so
1009
that subclasses do not need to deal with caching logic.
1011
This API is semi-public; it only for use by subclasses, all other code
1012
should consider it to be private.
1014
raise NotImplementedError(self._gen_revision_history)
1016
def _revision_history(self):
1017
if 'evil' in debug.debug_flags:
1018
mutter_callsite(3, "revision_history scales with history.")
1019
if self._revision_history_cache is not None:
1020
history = self._revision_history_cache
1022
history = self._gen_revision_history()
1023
self._cache_revision_history(history)
1024
return list(history)
309
1026
def revno(self):
310
1027
"""Return current revision number for this branch.
312
1029
That is equivalent to the number of revisions committed to
315
return len(self.revision_history())
1032
return self.last_revision_info()[0]
317
1034
def unbind(self):
318
1035
"""Older format branches cannot bind or unbind."""
319
raise errors.UpgradeRequired(self.base)
321
def set_append_revisions_only(self, enabled):
322
"""Older format branches are never restricted to append-only"""
323
raise errors.UpgradeRequired(self.base)
1036
raise errors.UpgradeRequired(self.user_url)
325
1038
def last_revision(self):
326
"""Return last revision id, or None"""
327
ph = self.revision_history()
1039
"""Return last revision id, or NULL_REVISION."""
1040
return self.last_revision_info()[1]
333
1043
def last_revision_info(self):
334
1044
"""Return information about the last revision.
336
:return: A tuple (revno, last_revision_id).
338
rh = self.revision_history()
341
return (revno, rh[-1])
343
return (0, _mod_revision.NULL_REVISION)
345
def missing_revisions(self, other, stop_revision=None):
346
"""Return a list of new revisions that would perfectly fit.
348
If self and other have not diverged, return a list of the revisions
349
present in other, but missing from self.
351
self_history = self.revision_history()
352
self_len = len(self_history)
353
other_history = other.revision_history()
354
other_len = len(other_history)
355
common_index = min(self_len, other_len) -1
356
if common_index >= 0 and \
357
self_history[common_index] != other_history[common_index]:
358
raise DivergedBranches(self, other)
360
if stop_revision is None:
361
stop_revision = other_len
363
assert isinstance(stop_revision, int)
364
if stop_revision > other_len:
365
raise errors.NoSuchRevision(self, stop_revision)
366
return other_history[self_len:stop_revision]
368
def update_revisions(self, other, stop_revision=None):
369
"""Pull in new perfect-fit revisions.
371
:param other: Another Branch to pull from
372
:param stop_revision: Updated until the given revision
375
raise NotImplementedError(self.update_revisions)
1046
:return: A tuple (revno, revision_id).
1048
if self._last_revision_info_cache is None:
1049
self._last_revision_info_cache = self._read_last_revision_info()
1050
return self._last_revision_info_cache
1052
def _read_last_revision_info(self):
1053
raise NotImplementedError(self._read_last_revision_info)
1055
def import_last_revision_info_and_tags(self, source, revno, revid,
1057
"""Set the last revision info, importing from another repo if necessary.
1059
This is used by the bound branch code to upload a revision to
1060
the master branch first before updating the tip of the local branch.
1061
Revisions referenced by source's tags are also transferred.
1063
:param source: Source branch to optionally fetch from
1064
:param revno: Revision number of the new tip
1065
:param revid: Revision id of the new tip
1066
:param lossy: Whether to discard metadata that can not be
1067
natively represented
1068
:return: Tuple with the new revision number and revision id
1069
(should only be different from the arguments when lossy=True)
1071
if not self.repository.has_same_location(source.repository):
1072
self.fetch(source, revid)
1073
self.set_last_revision_info(revno, revid)
1074
return (revno, revid)
377
1076
def revision_id_to_revno(self, revision_id):
378
1077
"""Given a revision id, return its revno"""
379
if revision_id is None:
1078
if _mod_revision.is_null(revision_id):
381
revision_id = osutils.safe_revision_id(revision_id)
382
history = self.revision_history()
1080
history = self._revision_history()
384
1082
return history.index(revision_id) + 1
385
1083
except ValueError:
386
raise bzrlib.errors.NoSuchRevision(self, revision_id)
1084
raise errors.NoSuchRevision(self, revision_id)
388
1087
def get_rev_id(self, revno, history=None):
389
1088
"""Find the revision id of the specified revno."""
393
history = self.revision_history()
394
if revno <= 0 or revno > len(history):
395
raise bzrlib.errors.NoSuchRevision(self, revno)
396
return history[revno - 1]
1090
return _mod_revision.NULL_REVISION
1091
last_revno, last_revid = self.last_revision_info()
1092
if revno == last_revno:
1094
if revno <= 0 or revno > last_revno:
1095
raise errors.NoSuchRevision(self, revno)
1096
distance_from_last = last_revno - revno
1097
if len(self._partial_revision_history_cache) <= distance_from_last:
1098
self._extend_partial_history(distance_from_last)
1099
return self._partial_revision_history_cache[distance_from_last]
398
def pull(self, source, overwrite=False, stop_revision=None):
1101
def pull(self, source, overwrite=False, stop_revision=None,
1102
possible_transports=None, *args, **kwargs):
399
1103
"""Mirror source into this branch.
401
1105
This branch is considered to be 'local', having low latency.
1107
:returns: PullResult instance
403
raise NotImplementedError(self.pull)
1109
return InterBranch.get(source, self).pull(overwrite=overwrite,
1110
stop_revision=stop_revision,
1111
possible_transports=possible_transports, *args, **kwargs)
405
def push(self, target, overwrite=False, stop_revision=None):
1113
def push(self, target, overwrite=False, stop_revision=None, lossy=False,
406
1115
"""Mirror this branch into target.
408
1117
This branch is considered to be 'local', having low latency.
410
raise NotImplementedError(self.push)
1119
return InterBranch.get(self, target).push(overwrite, stop_revision,
1120
lossy, *args, **kwargs)
412
1122
def basis_tree(self):
413
1123
"""Return `Tree` object for last revision."""
414
1124
return self.repository.revision_tree(self.last_revision())
416
def rename_one(self, from_rel, to_rel):
419
This can change the directory or the filename or both.
421
raise NotImplementedError(self.rename_one)
423
def move(self, from_paths, to_name):
426
to_name must exist as a versioned directory.
428
If to_name exists and is a directory, the files are moved into
429
it, keeping their old names. If it is a directory,
431
Note that to_name is only the last component of the new name;
432
this doesn't change the directory.
434
This returns a list of (from_path, to_path) pairs for each
437
raise NotImplementedError(self.move)
439
1126
def get_parent(self):
440
1127
"""Return the parent location of the branch.
442
This is the default location for push/pull/missing. The usual
1129
This is the default location for pull/missing. The usual
443
1130
pattern is that the user can override it by specifying a
446
raise NotImplementedError(self.get_parent)
1133
parent = self._get_parent_location()
1136
# This is an old-format absolute path to a local branch
1137
# turn it into a url
1138
if parent.startswith('/'):
1139
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1141
return urlutils.join(self.base[:-1], parent)
1142
except errors.InvalidURLJoin, e:
1143
raise errors.InaccessibleParent(parent, self.user_url)
1145
def _get_parent_location(self):
1146
raise NotImplementedError(self._get_parent_location)
1148
def _set_config_location(self, name, url, config=None,
1149
make_relative=False):
1151
config = self.get_config_stack()
1155
url = urlutils.relative_url(self.base, url)
1156
config.set(name, url)
1158
def _get_config_location(self, name, config=None):
1160
config = self.get_config_stack()
1161
location = config.get(name)
1166
def get_child_submit_format(self):
1167
"""Return the preferred format of submissions to this branch."""
1168
return self.get_config_stack().get('child_submit_format')
448
1170
def get_submit_branch(self):
449
1171
"""Return the submit location of the branch.
491
1248
self.check_real_revno(revno)
493
1250
def check_real_revno(self, revno):
495
1252
Check whether a revno corresponds to a real revision.
496
1253
Zero (the NULL revision) is considered invalid
498
1255
if revno < 1 or revno > self.revno():
499
raise InvalidRevisionNumber(revno)
1256
raise errors.InvalidRevisionNumber(revno)
501
1258
@needs_read_lock
502
def clone(self, *args, **kwargs):
1259
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
503
1260
"""Clone this branch into to_bzrdir preserving all semantic values.
1262
Most API users will want 'create_clone_on_transport', which creates a
1263
new bzrdir and branch on the fly.
505
1265
revision_id: if not None, the revision history in the new branch will
506
1266
be truncated to end with revision_id.
508
# for API compatibility, until 0.8 releases we provide the old api:
509
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
510
# after 0.8 releases, the *args and **kwargs should be changed:
511
# def clone(self, to_bzrdir, revision_id=None):
512
if (kwargs.get('to_location', None) or
513
kwargs.get('revision', None) or
514
kwargs.get('basis_branch', None) or
515
(len(args) and isinstance(args[0], basestring))):
516
# backwards compatibility api:
517
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
518
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
521
basis_branch = args[2]
523
basis_branch = kwargs.get('basis_branch', None)
525
basis = basis_branch.bzrdir
530
revision_id = args[1]
532
revision_id = kwargs.get('revision', None)
537
# no default to raise if not provided.
538
url = kwargs.get('to_location')
539
return self.bzrdir.clone(url,
540
revision_id=revision_id,
541
basis=basis).open_branch()
543
# generate args by hand
545
revision_id = args[1]
547
revision_id = kwargs.get('revision_id', None)
551
# no default to raise if not provided.
552
to_bzrdir = kwargs.get('to_bzrdir')
553
result = self._format.initialize(to_bzrdir)
554
self.copy_content_into(result, revision_id=revision_id)
1268
result = to_bzrdir.create_branch()
1271
if repository_policy is not None:
1272
repository_policy.configure_branch(result)
1273
self.copy_content_into(result, revision_id=revision_id)
557
1278
@needs_read_lock
558
def sprout(self, to_bzrdir, revision_id=None):
1279
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
559
1281
"""Create a new line of development from the branch, into to_bzrdir.
1283
to_bzrdir controls the branch format.
561
1285
revision_id: if not None, the revision history in the new branch will
562
1286
be truncated to end with revision_id.
564
result = self._format.initialize(to_bzrdir)
565
self.copy_content_into(result, revision_id=revision_id)
566
result.set_parent(self.bzrdir.root_transport.base)
1288
if (repository_policy is not None and
1289
repository_policy.requires_stacking()):
1290
to_bzrdir._format.require_stacking(_skip_repo=True)
1291
result = to_bzrdir.create_branch(repository=repository)
1294
if repository_policy is not None:
1295
repository_policy.configure_branch(result)
1296
self.copy_content_into(result, revision_id=revision_id)
1297
master_url = self.get_bound_location()
1298
if master_url is None:
1299
result.set_parent(self.bzrdir.root_transport.base)
1301
result.set_parent(master_url)
569
1306
def _synchronize_history(self, destination, revision_id):
570
1307
"""Synchronize last revision and revision history between branches.
572
1309
This version is most efficient when the destination is also a
573
BzrBranch5, but works for BzrBranch6 as long as the revision
574
history is the true lefthand parent history, and all of the revisions
575
are in the destination's repository. If not, set_revision_history
1310
BzrBranch6, but works for BzrBranch5, as long as the destination's
1311
repository contains all the lefthand ancestors of the intended
1312
last_revision. If not, set_last_revision_info will fail.
578
1314
:param destination: The branch to copy the history into
579
1315
:param revision_id: The revision-id to truncate history at. May
580
1316
be None to copy complete history.
582
new_history = self.revision_history()
583
if revision_id is not None:
584
revision_id = osutils.safe_revision_id(revision_id)
1318
source_revno, source_revision_id = self.last_revision_info()
1319
if revision_id is None:
1320
revno, revision_id = source_revno, source_revision_id
1322
graph = self.repository.get_graph()
586
new_history = new_history[:new_history.index(revision_id) + 1]
588
rev = self.repository.get_revision(revision_id)
589
new_history = rev.get_history(self.repository)[1:]
590
destination.set_revision_history(new_history)
1324
revno = graph.find_distance_to_null(revision_id,
1325
[(source_revision_id, source_revno)])
1326
except errors.GhostRevisionsHaveNoRevno:
1327
# Default to 1, if we can't find anything else
1329
destination.set_last_revision_info(revno, revision_id)
593
1331
def copy_content_into(self, destination, revision_id=None):
594
1332
"""Copy the content of self into destination.
596
1334
revision_id: if not None, the revision history in the new branch will
597
1335
be truncated to end with revision_id.
599
self._synchronize_history(destination, revision_id)
601
parent = self.get_parent()
602
except errors.InaccessibleParent, e:
603
mutter('parent was not accessible to copy: %s', e)
606
destination.set_parent(parent)
1337
return InterBranch.get(self, destination).copy_content_into(
1338
revision_id=revision_id)
1340
def update_references(self, target):
1341
if not getattr(self._format, 'supports_reference_locations', False):
1343
reference_dict = self._get_all_reference_info()
1344
if len(reference_dict) == 0:
1346
old_base = self.base
1347
new_base = target.base
1348
target_reference_dict = target._get_all_reference_info()
1349
for file_id, (tree_path, branch_location) in (
1350
reference_dict.items()):
1351
branch_location = urlutils.rebase_url(branch_location,
1353
target_reference_dict.setdefault(
1354
file_id, (tree_path, branch_location))
1355
target._set_all_reference_info(target_reference_dict)
608
1357
@needs_read_lock
1358
def check(self, refs):
610
1359
"""Check consistency of the branch.
612
1361
In particular this checks that revisions given in the revision-history
613
do actually match up in the revision graph, and that they're all
1362
do actually match up in the revision graph, and that they're all
614
1363
present in the repository.
616
1365
Callers will typically also want to check the repository.
1367
:param refs: Calculated refs for this branch as specified by
1368
branch._get_check_refs()
618
1369
:return: A BranchCheckResult.
620
mainline_parent_id = None
621
for revision_id in self.revision_history():
623
revision = self.repository.get_revision(revision_id)
624
except errors.NoSuchRevision, e:
625
raise errors.BzrCheckError("mainline revision {%s} not in repository"
627
# In general the first entry on the revision history has no parents.
628
# But it's not illegal for it to have parents listed; this can happen
629
# in imports from Arch when the parents weren't reachable.
630
if mainline_parent_id is not None:
631
if mainline_parent_id not in revision.parent_ids:
632
raise errors.BzrCheckError("previous revision {%s} not listed among "
634
% (mainline_parent_id, revision_id))
635
mainline_parent_id = revision_id
636
return BranchCheckResult(self)
1371
result = BranchCheckResult(self)
1372
last_revno, last_revision_id = self.last_revision_info()
1373
actual_revno = refs[('lefthand-distance', last_revision_id)]
1374
if actual_revno != last_revno:
1375
result.errors.append(errors.BzrCheckError(
1376
'revno does not match len(mainline) %s != %s' % (
1377
last_revno, actual_revno)))
1378
# TODO: We should probably also check that self.revision_history
1379
# matches the repository for older branch formats.
1380
# If looking for the code that cross-checks repository parents against
1381
# the Graph.iter_lefthand_ancestry output, that is now a repository
638
def _get_checkout_format(self):
1385
def _get_checkout_format(self, lightweight=False):
639
1386
"""Return the most suitable metadir for a checkout of this branch.
640
Weaves are used if this branch's repostory uses weaves.
1387
Weaves are used if this branch's repository uses weaves.
642
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
643
from bzrlib.repofmt import weaverepo
644
format = bzrdir.BzrDirMetaFormat1()
645
format.repository_format = weaverepo.RepositoryFormat7()
647
format = self.repository.bzrdir.cloning_metadir()
648
format.branch_format = self._format
1389
format = self.repository.bzrdir.checkout_metadir()
1390
format.set_branch_format(self._format)
1393
def create_clone_on_transport(self, to_transport, revision_id=None,
1394
stacked_on=None, create_prefix=False, use_existing_dir=False,
1396
"""Create a clone of this branch and its bzrdir.
1398
:param to_transport: The transport to clone onto.
1399
:param revision_id: The revision id to use as tip in the new branch.
1400
If None the tip is obtained from this branch.
1401
:param stacked_on: An optional URL to stack the clone on.
1402
:param create_prefix: Create any missing directories leading up to
1404
:param use_existing_dir: Use an existing directory if one exists.
1406
# XXX: Fix the bzrdir API to allow getting the branch back from the
1407
# clone call. Or something. 20090224 RBC/spiv.
1408
# XXX: Should this perhaps clone colocated branches as well,
1409
# rather than just the default branch? 20100319 JRV
1410
if revision_id is None:
1411
revision_id = self.last_revision()
1412
dir_to = self.bzrdir.clone_on_transport(to_transport,
1413
revision_id=revision_id, stacked_on=stacked_on,
1414
create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1416
return dir_to.open_branch()
651
1418
def create_checkout(self, to_location, revision_id=None,
1419
lightweight=False, accelerator_tree=None,
653
1421
"""Create a checkout of a branch.
655
1423
:param to_location: The url to produce the checkout at
656
1424
:param revision_id: The revision to check out
657
1425
:param lightweight: If True, produce a lightweight checkout, otherwise,
658
produce a bound branch (heavyweight checkout)
1426
produce a bound branch (heavyweight checkout)
1427
:param accelerator_tree: A tree which can be used for retrieving file
1428
contents more quickly than the revision tree, i.e. a workingtree.
1429
The revision tree will be used for cases where accelerator_tree's
1430
content is different.
1431
:param hardlink: If true, hard-link files from accelerator_tree,
659
1433
:return: The tree of the created checkout
661
1435
t = transport.get_transport(to_location)
1437
format = self._get_checkout_format(lightweight=lightweight)
664
except errors.FileExists:
1439
checkout = format.initialize_on_transport(t)
1440
except errors.AlreadyControlDirError:
1441
# It's fine if the control directory already exists,
1442
# as long as there is no existing branch and working tree.
1443
checkout = controldir.ControlDir.open_from_transport(t)
1445
checkout.open_branch()
1446
except errors.NotBranchError:
1449
raise errors.AlreadyControlDirError(t.base)
1450
if checkout.control_transport.base == self.bzrdir.control_transport.base:
1451
# When checking out to the same control directory,
1452
# always create a lightweight checkout
667
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
668
BranchReferenceFormat().initialize(checkout, self)
1456
from_branch = checkout.set_branch_reference(target_branch=self)
670
format = self._get_checkout_format()
671
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
672
to_location, force_new_tree=False, format=format)
673
checkout = checkout_branch.bzrdir
1458
policy = checkout.determine_repository_policy()
1459
repo = policy.acquire_repository()[0]
1460
checkout_branch = checkout.create_branch()
674
1461
checkout_branch.bind(self)
675
# pull up to the specified revision_id to set the initial
1462
# pull up to the specified revision_id to set the initial
676
1463
# branch tip correctly, and seed it with history.
677
1464
checkout_branch.pull(self, stop_revision=revision_id)
678
return checkout.create_workingtree(revision_id)
681
class BranchFormat(object):
1466
tree = checkout.create_workingtree(revision_id,
1467
from_branch=from_branch,
1468
accelerator_tree=accelerator_tree,
1470
basis_tree = tree.basis_tree()
1471
basis_tree.lock_read()
1473
for path, file_id in basis_tree.iter_references():
1474
reference_parent = self.reference_parent(file_id, path)
1475
reference_parent.create_checkout(tree.abspath(path),
1476
basis_tree.get_reference_revision(file_id, path),
1483
def reconcile(self, thorough=True):
1484
"""Make sure the data stored in this branch is consistent."""
1485
from bzrlib.reconcile import BranchReconciler
1486
reconciler = BranchReconciler(self, thorough=thorough)
1487
reconciler.reconcile()
1490
def reference_parent(self, file_id, path, possible_transports=None):
1491
"""Return the parent branch for a tree-reference file_id
1493
:param file_id: The file_id of the tree reference
1494
:param path: The path of the file_id in the tree
1495
:return: A branch associated with the file_id
1497
# FIXME should provide multiple branches, based on config
1498
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1499
possible_transports=possible_transports)
1501
def supports_tags(self):
1502
return self._format.supports_tags()
1504
def automatic_tag_name(self, revision_id):
1505
"""Try to automatically find the tag name for a revision.
1507
:param revision_id: Revision id of the revision.
1508
:return: A tag name or None if no tag name could be determined.
1510
for hook in Branch.hooks['automatic_tag_name']:
1511
ret = hook(self, revision_id)
1516
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1518
"""Ensure that revision_b is a descendant of revision_a.
1520
This is a helper function for update_revisions.
1522
:raises: DivergedBranches if revision_b has diverged from revision_a.
1523
:returns: True if revision_b is a descendant of revision_a.
1525
relation = self._revision_relations(revision_a, revision_b, graph)
1526
if relation == 'b_descends_from_a':
1528
elif relation == 'diverged':
1529
raise errors.DivergedBranches(self, other_branch)
1530
elif relation == 'a_descends_from_b':
1533
raise AssertionError("invalid relation: %r" % (relation,))
1535
def _revision_relations(self, revision_a, revision_b, graph):
1536
"""Determine the relationship between two revisions.
1538
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1540
heads = graph.heads([revision_a, revision_b])
1541
if heads == set([revision_b]):
1542
return 'b_descends_from_a'
1543
elif heads == set([revision_a, revision_b]):
1544
# These branches have diverged
1546
elif heads == set([revision_a]):
1547
return 'a_descends_from_b'
1549
raise AssertionError("invalid heads: %r" % (heads,))
1551
def heads_to_fetch(self):
1552
"""Return the heads that must and that should be fetched to copy this
1553
branch into another repo.
1555
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1556
set of heads that must be fetched. if_present_fetch is a set of
1557
heads that must be fetched if present, but no error is necessary if
1558
they are not present.
1560
# For bzr native formats must_fetch is just the tip, and
1561
# if_present_fetch are the tags.
1562
must_fetch = set([self.last_revision()])
1563
if_present_fetch = set()
1564
if self.get_config_stack().get('branch.fetch_tags'):
1566
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1567
except errors.TagsNotSupported:
1569
must_fetch.discard(_mod_revision.NULL_REVISION)
1570
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1571
return must_fetch, if_present_fetch
1574
class BranchFormat(controldir.ControlComponentFormat):
682
1575
"""An encapsulation of the initialization and open routines for a format.
684
1577
Formats provide three things:
685
1578
* An initialization routine,
1579
* a format description
687
1580
* an open routine.
689
Formats are placed in an dict by their format string for reference
690
during branch opening. Its not required that these be instances, they
691
can be classes themselves with class methods - it simply depends on
1582
Formats are placed in an dict by their format string for reference
1583
during branch opening. It's not required that these be instances, they
1584
can be classes themselves with class methods - it simply depends on
692
1585
whether state is needed for a given format or not.
694
1587
Once a format is deprecated, just deprecate the initialize and open
695
methods on the format class. Do not deprecate the object, as the
1588
methods on the format class. Do not deprecate the object, as the
696
1589
object will be created every time regardless.
699
_default_format = None
700
"""The default format used for new branches."""
703
"""The known formats."""
706
def find_format(klass, a_bzrdir):
707
"""Return the format for the branch object in a_bzrdir."""
709
transport = a_bzrdir.get_branch_transport(None)
710
format_string = transport.get("format").read()
711
return klass._formats[format_string]
713
raise NotBranchError(path=transport.base)
715
raise errors.UnknownFormatError(format=format_string)
718
def get_default_format(klass):
719
"""Return the current default format."""
720
return klass._default_format
722
def get_format_string(self):
723
"""Return the ASCII format string that identifies this format."""
724
raise NotImplementedError(self.get_format_string)
1592
def __eq__(self, other):
1593
return self.__class__ is other.__class__
1595
def __ne__(self, other):
1596
return not (self == other)
1598
def get_reference(self, controldir, name=None):
1599
"""Get the target reference of the branch in controldir.
1601
format probing must have been completed before calling
1602
this method - it is assumed that the format of the branch
1603
in controldir is correct.
1605
:param controldir: The controldir to get the branch data from.
1606
:param name: Name of the colocated branch to fetch
1607
:return: None if the branch is not a reference branch.
1612
def set_reference(self, controldir, name, to_branch):
1613
"""Set the target reference of the branch in controldir.
1615
format probing must have been completed before calling
1616
this method - it is assumed that the format of the branch
1617
in controldir is correct.
1619
:param controldir: The controldir to set the branch reference for.
1620
:param name: Name of colocated branch to set, None for default
1621
:param to_branch: branch that the checkout is to reference
1623
raise NotImplementedError(self.set_reference)
726
1625
def get_format_description(self):
727
1626
"""Return the short format description for this format."""
728
1627
raise NotImplementedError(self.get_format_description)
730
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
732
"""Initialize a branch in a bzrdir, with specified files
734
:param a_bzrdir: The bzrdir to initialize the branch in
735
:param utf8_files: The files to create as a list of
736
(filename, content) tuples
737
:param set_format: If True, set the format with
738
self.get_format_string. (BzrBranch4 has its format set
740
:return: a branch in this format
1629
def _run_post_branch_init_hooks(self, controldir, name, branch):
1630
hooks = Branch.hooks['post_branch_init']
1633
params = BranchInitHookParams(self, controldir, name, branch)
1637
def initialize(self, controldir, name=None, repository=None,
1638
append_revisions_only=None):
1639
"""Create a branch of this format in controldir.
1641
:param name: Name of the colocated branch to create.
742
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
743
branch_transport = a_bzrdir.get_branch_transport(self)
745
'metadir': ('lock', lockdir.LockDir),
746
'branch4': ('branch-lock', lockable_files.TransportLock),
748
lock_name, lock_class = lock_map[lock_type]
749
control_files = lockable_files.LockableFiles(branch_transport,
750
lock_name, lock_class)
751
control_files.create_lock()
752
control_files.lock_write()
754
control_files.put_utf8('format', self.get_format_string())
756
for file, content in utf8_files:
757
control_files.put_utf8(file, content)
759
control_files.unlock()
760
return self.open(a_bzrdir, _found=True)
762
def initialize(self, a_bzrdir):
763
"""Create a branch of this format in a_bzrdir."""
764
1643
raise NotImplementedError(self.initialize)
766
1645
def is_supported(self):
767
1646
"""Is this format supported?
769
1648
Supported formats can be initialized and opened.
770
Unsupported formats may not support initialization or committing or
1649
Unsupported formats may not support initialization or committing or
771
1650
some other features depending on the reason for not being supported.
775
def open(self, a_bzrdir, _found=False):
776
"""Return the branch object for a_bzrdir
778
_found is a private parameter, do not use it. It is used to indicate
779
if format probing has already be done.
1654
def make_tags(self, branch):
1655
"""Create a tags object for branch.
1657
This method is on BranchFormat, because BranchFormats are reflected
1658
over the wire via network_name(), whereas full Branch instances require
1659
multiple VFS method calls to operate at all.
1661
The default implementation returns a disabled-tags instance.
1663
Note that it is normal for branch to be a RemoteBranch when using tags
1666
return _mod_tag.DisabledTags(branch)
1668
def network_name(self):
1669
"""A simple byte string uniquely identifying this format for RPC calls.
1671
MetaDir branch formats use their disk format string to identify the
1672
repository over the wire. All in one formats such as bzr < 0.8, and
1673
foreign formats like svn/git and hg should use some marker which is
1674
unique and immutable.
1676
raise NotImplementedError(self.network_name)
1678
def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
1679
found_repository=None, possible_transports=None):
1680
"""Return the branch object for controldir.
1682
:param controldir: A ControlDir that contains a branch.
1683
:param name: Name of colocated branch to open
1684
:param _found: a private parameter, do not use it. It is used to
1685
indicate if format probing has already be done.
1686
:param ignore_fallbacks: when set, no fallback branches will be opened
1687
(if there are any). Default is to open fallbacks.
781
1689
raise NotImplementedError(self.open)
784
def register_format(klass, format):
785
klass._formats[format.get_format_string()] = format
788
def set_default_format(klass, format):
789
klass._default_format = format
792
def unregister_format(klass, format):
793
assert klass._formats[format.get_format_string()] is format
794
del klass._formats[format.get_format_string()]
1691
def supports_set_append_revisions_only(self):
1692
"""True if this format supports set_append_revisions_only."""
1695
def supports_stacking(self):
1696
"""True if this format records a stacked-on branch."""
1699
def supports_leaving_lock(self):
1700
"""True if this format supports leaving locks in place."""
1701
return False # by default
796
1703
def __str__(self):
797
return self.get_format_string().rstrip()
800
class BranchHooks(dict):
1704
return self.get_format_description().rstrip()
1706
def supports_tags(self):
1707
"""True if this format supports tags stored in the branch"""
1708
return False # by default
1710
def tags_are_versioned(self):
1711
"""Whether the tag container for this branch versions tags."""
1714
def supports_tags_referencing_ghosts(self):
1715
"""True if tags can reference ghost revisions."""
1719
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1720
"""A factory for a BranchFormat object, permitting simple lazy registration.
1722
While none of the built in BranchFormats are lazy registered yet,
1723
bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1724
use it, and the bzr-loom plugin uses it as well (see
1725
bzrlib.plugins.loom.formats).
1728
def __init__(self, format_string, module_name, member_name):
1729
"""Create a MetaDirBranchFormatFactory.
1731
:param format_string: The format string the format has.
1732
:param module_name: Module to load the format class from.
1733
:param member_name: Attribute name within the module for the format class.
1735
registry._LazyObjectGetter.__init__(self, module_name, member_name)
1736
self._format_string = format_string
1738
def get_format_string(self):
1739
"""See BranchFormat.get_format_string."""
1740
return self._format_string
1743
"""Used for network_format_registry support."""
1744
return self.get_obj()()
1747
class BranchHooks(Hooks):
801
1748
"""A dictionary mapping hook name to a list of callables for branch hooks.
803
e.g. ['set_rh'] Is the list of items to be called when the
804
set_revision_history function is invoked.
1750
e.g. ['post_push'] Is the list of items to be called when the
1751
push function is invoked.
807
1754
def __init__(self):
810
1757
These are all empty initially, because by default nothing should get
814
# Introduced in 0.15:
815
# invoked whenever the revision history has been set
816
# with set_revision_history. The api signature is
817
# (branch, revision_history), and the branch will
820
# invoked after a push operation completes.
821
# the api signature is
822
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
823
# where local is the local branch or None, master is the target
824
# master branch, and the rest should be self explanatory. The source
825
# is read locked and the target branches write locked. Source will
826
# be the local low-latency branch.
827
self['post_push'] = []
828
# invoked after a pull operation completes.
829
# the api signature is
830
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
831
# where local is the local branch or None, master is the target
832
# master branch, and the rest should be self explanatory. The source
833
# is read locked and the target branches write locked. The local
834
# branch is the low-latency branch.
835
self['post_pull'] = []
836
# invoked after a commit operation completes.
837
# the api signature is
838
# (local, master, old_revno, old_revid, new_revno, new_revid)
839
# old_revid is NULL_REVISION for the first commit to a branch.
840
self['post_commit'] = []
841
# invoked after a uncommit operation completes.
842
# the api signature is
843
# (local, master, old_revno, old_revid, new_revno, new_revid) where
844
# local is the local branch or None, master is the target branch,
845
# and an empty branch recieves new_revno of 0, new_revid of None.
846
self['post_uncommit'] = []
848
def install_hook(self, hook_name, a_callable):
849
"""Install a_callable in to the hook hook_name.
851
:param hook_name: A hook name. See the __init__ method of BranchHooks
852
for the complete list of hooks.
853
:param a_callable: The callable to be invoked when the hook triggers.
854
The exact signature will depend on the hook - see the __init__
855
method of BranchHooks for details on each hook.
858
self[hook_name].append(a_callable)
860
raise errors.UnknownHook('branch', hook_name)
1760
Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1761
self.add_hook('open',
1762
"Called with the Branch object that has been opened after a "
1763
"branch is opened.", (1, 8))
1764
self.add_hook('post_push',
1765
"Called after a push operation completes. post_push is called "
1766
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1767
"bzr client.", (0, 15))
1768
self.add_hook('post_pull',
1769
"Called after a pull operation completes. post_pull is called "
1770
"with a bzrlib.branch.PullResult object and only runs in the "
1771
"bzr client.", (0, 15))
1772
self.add_hook('pre_commit',
1773
"Called after a commit is calculated but before it is "
1774
"completed. pre_commit is called with (local, master, old_revno, "
1775
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1776
"). old_revid is NULL_REVISION for the first commit to a branch, "
1777
"tree_delta is a TreeDelta object describing changes from the "
1778
"basis revision. hooks MUST NOT modify this delta. "
1779
" future_tree is an in-memory tree obtained from "
1780
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1782
self.add_hook('post_commit',
1783
"Called in the bzr client after a commit has completed. "
1784
"post_commit is called with (local, master, old_revno, old_revid, "
1785
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1786
"commit to a branch.", (0, 15))
1787
self.add_hook('post_uncommit',
1788
"Called in the bzr client after an uncommit completes. "
1789
"post_uncommit is called with (local, master, old_revno, "
1790
"old_revid, new_revno, new_revid) where local is the local branch "
1791
"or None, master is the target branch, and an empty branch "
1792
"receives new_revno of 0, new_revid of None.", (0, 15))
1793
self.add_hook('pre_change_branch_tip',
1794
"Called in bzr client and server before a change to the tip of a "
1795
"branch is made. pre_change_branch_tip is called with a "
1796
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1797
"commit, uncommit will all trigger this hook.", (1, 6))
1798
self.add_hook('post_change_branch_tip',
1799
"Called in bzr client and server after a change to the tip of a "
1800
"branch is made. post_change_branch_tip is called with a "
1801
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1802
"commit, uncommit will all trigger this hook.", (1, 4))
1803
self.add_hook('transform_fallback_location',
1804
"Called when a stacked branch is activating its fallback "
1805
"locations. transform_fallback_location is called with (branch, "
1806
"url), and should return a new url. Returning the same url "
1807
"allows it to be used as-is, returning a different one can be "
1808
"used to cause the branch to stack on a closer copy of that "
1809
"fallback_location. Note that the branch cannot have history "
1810
"accessing methods called on it during this hook because the "
1811
"fallback locations have not been activated. When there are "
1812
"multiple hooks installed for transform_fallback_location, "
1813
"all are called with the url returned from the previous hook."
1814
"The order is however undefined.", (1, 9))
1815
self.add_hook('automatic_tag_name',
1816
"Called to determine an automatic tag name for a revision. "
1817
"automatic_tag_name is called with (branch, revision_id) and "
1818
"should return a tag name or None if no tag name could be "
1819
"determined. The first non-None tag name returned will be used.",
1821
self.add_hook('post_branch_init',
1822
"Called after new branch initialization completes. "
1823
"post_branch_init is called with a "
1824
"bzrlib.branch.BranchInitHookParams. "
1825
"Note that init, branch and checkout (both heavyweight and "
1826
"lightweight) will all trigger this hook.", (2, 2))
1827
self.add_hook('post_switch',
1828
"Called after a checkout switches branch. "
1829
"post_switch is called with a "
1830
"bzrlib.branch.SwitchHookParams.", (2, 2))
863
1834
# install the default hooks into the Branch class.
864
1835
Branch.hooks = BranchHooks()
867
class BzrBranchFormat4(BranchFormat):
868
"""Bzr branch format 4.
871
- a revision-history file.
872
- a branch-lock lock file [ to be shared with the bzrdir ]
875
def get_format_description(self):
876
"""See BranchFormat.get_format_description()."""
877
return "Branch format 4"
879
def initialize(self, a_bzrdir):
880
"""Create a branch of this format in a_bzrdir."""
881
utf8_files = [('revision-history', ''),
884
return self._initialize_helper(a_bzrdir, utf8_files,
885
lock_type='branch4', set_format=False)
888
super(BzrBranchFormat4, self).__init__()
889
self._matchingbzrdir = bzrdir.BzrDirFormat6()
891
def open(self, a_bzrdir, _found=False):
892
"""Return the branch object for a_bzrdir
894
_found is a private parameter, do not use it. It is used to indicate
895
if format probing has already be done.
898
# we are being called directly and must probe.
899
raise NotImplementedError
900
return BzrBranch(_format=self,
901
_control_files=a_bzrdir._control_files,
903
_repository=a_bzrdir.open_repository())
906
return "Bazaar-NG branch format 4"
909
class BzrBranchFormat5(BranchFormat):
910
"""Bzr branch format 5.
913
- a revision-history file.
915
- a lock dir guarding the branch itself
916
- all of this stored in a branch/ subdirectory
917
- works with shared repositories.
919
This format is new in bzr 0.8.
922
def get_format_string(self):
923
"""See BranchFormat.get_format_string()."""
924
return "Bazaar-NG branch format 5\n"
926
def get_format_description(self):
927
"""See BranchFormat.get_format_description()."""
928
return "Branch format 5"
930
def initialize(self, a_bzrdir):
931
"""Create a branch of this format in a_bzrdir."""
932
utf8_files = [('revision-history', ''),
935
return self._initialize_helper(a_bzrdir, utf8_files)
938
super(BzrBranchFormat5, self).__init__()
939
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
941
def open(self, a_bzrdir, _found=False):
942
"""Return the branch object for a_bzrdir
944
_found is a private parameter, do not use it. It is used to indicate
945
if format probing has already be done.
948
format = BranchFormat.find_format(a_bzrdir)
949
assert format.__class__ == self.__class__
950
transport = a_bzrdir.get_branch_transport(None)
951
control_files = lockable_files.LockableFiles(transport, 'lock',
953
return BzrBranch5(_format=self,
954
_control_files=control_files,
956
_repository=a_bzrdir.find_repository())
959
return "Bazaar-NG Metadir branch format 5"
962
class BzrBranchFormat6(BzrBranchFormat5):
963
"""Branch format with last-revision
1838
class ChangeBranchTipParams(object):
1839
"""Object holding parameters passed to `*_change_branch_tip` hooks.
1841
There are 5 fields that hooks may wish to access:
1843
:ivar branch: the branch being changed
1844
:ivar old_revno: revision number before the change
1845
:ivar new_revno: revision number after the change
1846
:ivar old_revid: revision id before the change
1847
:ivar new_revid: revision id after the change
1849
The revid fields are strings. The revno fields are integers.
1852
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1853
"""Create a group of ChangeBranchTip parameters.
1855
:param branch: The branch being changed.
1856
:param old_revno: Revision number before the change.
1857
:param new_revno: Revision number after the change.
1858
:param old_revid: Tip revision id before the change.
1859
:param new_revid: Tip revision id after the change.
1861
self.branch = branch
1862
self.old_revno = old_revno
1863
self.new_revno = new_revno
1864
self.old_revid = old_revid
1865
self.new_revid = new_revid
1867
def __eq__(self, other):
1868
return self.__dict__ == other.__dict__
1871
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1872
self.__class__.__name__, self.branch,
1873
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1876
class BranchInitHookParams(object):
1877
"""Object holding parameters passed to `*_branch_init` hooks.
1879
There are 4 fields that hooks may wish to access:
1881
:ivar format: the branch format
1882
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1883
:ivar name: name of colocated branch, if any (or None)
1884
:ivar branch: the branch created
1886
Note that for lightweight checkouts, the bzrdir and format fields refer to
1887
the checkout, hence they are different from the corresponding fields in
1888
branch, which refer to the original branch.
1891
def __init__(self, format, controldir, name, branch):
1892
"""Create a group of BranchInitHook parameters.
1894
:param format: the branch format
1895
:param controldir: the ControlDir where the branch will be/has been
1897
:param name: name of colocated branch, if any (or None)
1898
:param branch: the branch created
1900
Note that for lightweight checkouts, the bzrdir and format fields refer
1901
to the checkout, hence they are different from the corresponding fields
1902
in branch, which refer to the original branch.
1904
self.format = format
1905
self.bzrdir = controldir
1907
self.branch = branch
1909
def __eq__(self, other):
1910
return self.__dict__ == other.__dict__
1913
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1916
class SwitchHookParams(object):
1917
"""Object holding parameters passed to `*_switch` hooks.
1919
There are 4 fields that hooks may wish to access:
1921
:ivar control_dir: ControlDir of the checkout to change
1922
:ivar to_branch: branch that the checkout is to reference
1923
:ivar force: skip the check for local commits in a heavy checkout
1924
:ivar revision_id: revision ID to switch to (or None)
1927
def __init__(self, control_dir, to_branch, force, revision_id):
1928
"""Create a group of SwitchHook parameters.
1930
:param control_dir: ControlDir of the checkout to change
1931
:param to_branch: branch that the checkout is to reference
1932
:param force: skip the check for local commits in a heavy checkout
1933
:param revision_id: revision ID to switch to (or None)
1935
self.control_dir = control_dir
1936
self.to_branch = to_branch
1938
self.revision_id = revision_id
1940
def __eq__(self, other):
1941
return self.__dict__ == other.__dict__
1944
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1945
self.control_dir, self.to_branch,
1949
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
1950
"""Base class for branch formats that live in meta directories.
1954
BranchFormat.__init__(self)
1955
bzrdir.BzrFormat.__init__(self)
1958
def find_format(klass, controldir, name=None):
1959
"""Return the format for the branch object in controldir."""
1961
transport = controldir.get_branch_transport(None, name=name)
1962
except errors.NoSuchFile:
1963
raise errors.NotBranchError(path=name, bzrdir=controldir)
1965
format_string = transport.get_bytes("format")
1966
except errors.NoSuchFile:
1967
raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
1968
return klass._find_format(format_registry, 'branch', format_string)
1970
def _branch_class(self):
1971
"""What class to instantiate on open calls."""
1972
raise NotImplementedError(self._branch_class)
1974
def _get_initial_config(self, append_revisions_only=None):
1975
if append_revisions_only:
1976
return "append_revisions_only = True\n"
1978
# Avoid writing anything if append_revisions_only is disabled,
1979
# as that is the default.
1982
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1984
"""Initialize a branch in a control dir, with specified files
1986
:param a_bzrdir: The bzrdir to initialize the branch in
1987
:param utf8_files: The files to create as a list of
1988
(filename, content) tuples
1989
:param name: Name of colocated branch to create, if any
1990
:return: a branch in this format
1993
name = a_bzrdir._get_selected_branch()
1994
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1995
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1996
control_files = lockable_files.LockableFiles(branch_transport,
1997
'lock', lockdir.LockDir)
1998
control_files.create_lock()
1999
control_files.lock_write()
2001
utf8_files += [('format', self.as_string())]
2002
for (filename, content) in utf8_files:
2003
branch_transport.put_bytes(
2005
mode=a_bzrdir._get_file_mode())
2007
control_files.unlock()
2008
branch = self.open(a_bzrdir, name, _found=True,
2009
found_repository=repository)
2010
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2013
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2014
found_repository=None, possible_transports=None):
2015
"""See BranchFormat.open()."""
2017
name = a_bzrdir._get_selected_branch()
2019
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2020
if format.__class__ != self.__class__:
2021
raise AssertionError("wrong format %r found for %r" %
2023
transport = a_bzrdir.get_branch_transport(None, name=name)
2025
control_files = lockable_files.LockableFiles(transport, 'lock',
2027
if found_repository is None:
2028
found_repository = a_bzrdir.find_repository()
2029
return self._branch_class()(_format=self,
2030
_control_files=control_files,
2033
_repository=found_repository,
2034
ignore_fallbacks=ignore_fallbacks,
2035
possible_transports=possible_transports)
2036
except errors.NoSuchFile:
2037
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2040
def _matchingbzrdir(self):
2041
ret = bzrdir.BzrDirMetaFormat1()
2042
ret.set_branch_format(self)
2045
def supports_tags(self):
2048
def supports_leaving_lock(self):
2051
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
2053
BranchFormat.check_support_status(self,
2054
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
2056
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
2057
recommend_upgrade=recommend_upgrade, basedir=basedir)
2060
class BzrBranchFormat6(BranchFormatMetadir):
2061
"""Branch format with last-revision and tags.
965
2063
Unlike previous formats, this has no explicit revision history. Instead,
966
2064
this just stores the last-revision, and the left-hand history leading
967
2065
up to there is the history.
969
2067
This format was introduced in bzr 0.15
2068
and became the default in 0.91.
972
def get_format_string(self):
2071
def _branch_class(self):
2075
def get_format_string(cls):
973
2076
"""See BranchFormat.get_format_string()."""
974
return "Bazaar-NG branch format 6\n"
2077
return "Bazaar Branch Format 6 (bzr 0.15)\n"
976
2079
def get_format_description(self):
977
2080
"""See BranchFormat.get_format_description()."""
978
2081
return "Branch format 6"
980
def initialize(self, a_bzrdir):
981
"""Create a branch of this format in a_bzrdir."""
982
utf8_files = [('last-revision', '0 null:\n'),
986
return self._initialize_helper(a_bzrdir, utf8_files)
988
def open(self, a_bzrdir, _found=False):
989
"""Return the branch object for a_bzrdir
991
_found is a private parameter, do not use it. It is used to indicate
992
if format probing has already be done.
995
format = BranchFormat.find_format(a_bzrdir)
996
assert format.__class__ == self.__class__
997
transport = a_bzrdir.get_branch_transport(None)
998
control_files = lockable_files.LockableFiles(transport, 'lock',
1000
return BzrBranch6(_format=self,
1001
_control_files=control_files,
1003
_repository=a_bzrdir.find_repository())
1006
class BranchReferenceFormat(BranchFormat):
2083
def initialize(self, a_bzrdir, name=None, repository=None,
2084
append_revisions_only=None):
2085
"""Create a branch of this format in a_bzrdir."""
2086
utf8_files = [('last-revision', '0 null:\n'),
2088
self._get_initial_config(append_revisions_only)),
2091
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2093
def make_tags(self, branch):
2094
"""See bzrlib.branch.BranchFormat.make_tags()."""
2095
return _mod_tag.BasicTags(branch)
2097
def supports_set_append_revisions_only(self):
2101
class BzrBranchFormat8(BranchFormatMetadir):
2102
"""Metadir format supporting storing locations of subtree branches."""
2104
def _branch_class(self):
2108
def get_format_string(cls):
2109
"""See BranchFormat.get_format_string()."""
2110
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2112
def get_format_description(self):
2113
"""See BranchFormat.get_format_description()."""
2114
return "Branch format 8"
2116
def initialize(self, a_bzrdir, name=None, repository=None,
2117
append_revisions_only=None):
2118
"""Create a branch of this format in a_bzrdir."""
2119
utf8_files = [('last-revision', '0 null:\n'),
2121
self._get_initial_config(append_revisions_only)),
2125
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2127
def make_tags(self, branch):
2128
"""See bzrlib.branch.BranchFormat.make_tags()."""
2129
return _mod_tag.BasicTags(branch)
2131
def supports_set_append_revisions_only(self):
2134
def supports_stacking(self):
2137
supports_reference_locations = True
2140
class BzrBranchFormat7(BranchFormatMetadir):
2141
"""Branch format with last-revision, tags, and a stacked location pointer.
2143
The stacked location pointer is passed down to the repository and requires
2144
a repository format with supports_external_lookups = True.
2146
This format was introduced in bzr 1.6.
2149
def initialize(self, a_bzrdir, name=None, repository=None,
2150
append_revisions_only=None):
2151
"""Create a branch of this format in a_bzrdir."""
2152
utf8_files = [('last-revision', '0 null:\n'),
2154
self._get_initial_config(append_revisions_only)),
2157
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2159
def _branch_class(self):
2163
def get_format_string(cls):
2164
"""See BranchFormat.get_format_string()."""
2165
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2167
def get_format_description(self):
2168
"""See BranchFormat.get_format_description()."""
2169
return "Branch format 7"
2171
def supports_set_append_revisions_only(self):
2174
def supports_stacking(self):
2177
def make_tags(self, branch):
2178
"""See bzrlib.branch.BranchFormat.make_tags()."""
2179
return _mod_tag.BasicTags(branch)
2181
supports_reference_locations = False
2184
class BranchReferenceFormat(BranchFormatMetadir):
1007
2185
"""Bzr branch reference format.
1009
2187
Branch references are used in implementing checkouts, they
1014
2192
- a format string
1017
def get_format_string(self):
2196
def get_format_string(cls):
1018
2197
"""See BranchFormat.get_format_string()."""
1019
2198
return "Bazaar-NG Branch Reference Format 1\n"
1021
2200
def get_format_description(self):
1022
2201
"""See BranchFormat.get_format_description()."""
1023
2202
return "Checkout reference format 1"
1025
def initialize(self, a_bzrdir, target_branch=None):
2204
def get_reference(self, a_bzrdir, name=None):
2205
"""See BranchFormat.get_reference()."""
2206
transport = a_bzrdir.get_branch_transport(None, name=name)
2207
return transport.get_bytes('location')
2209
def set_reference(self, a_bzrdir, name, to_branch):
2210
"""See BranchFormat.set_reference()."""
2211
transport = a_bzrdir.get_branch_transport(None, name=name)
2212
location = transport.put_bytes('location', to_branch.base)
2214
def initialize(self, a_bzrdir, name=None, target_branch=None,
2215
repository=None, append_revisions_only=None):
1026
2216
"""Create a branch of this format in a_bzrdir."""
1027
2217
if target_branch is None:
1028
2218
# this format does not implement branch itself, thus the implicit
1029
2219
# creation contract must see it as uninitializable
1030
2220
raise errors.UninitializableFormat(self)
1031
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1032
branch_transport = a_bzrdir.get_branch_transport(self)
2221
mutter('creating branch reference in %s', a_bzrdir.user_url)
2222
if a_bzrdir._format.fixed_components:
2223
raise errors.IncompatibleFormat(self, a_bzrdir._format)
2225
name = a_bzrdir._get_selected_branch()
2226
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1033
2227
branch_transport.put_bytes('location',
1034
target_branch.bzrdir.root_transport.base)
1035
branch_transport.put_bytes('format', self.get_format_string())
1036
return self.open(a_bzrdir, _found=True)
1039
super(BranchReferenceFormat, self).__init__()
1040
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2228
target_branch.user_url)
2229
branch_transport.put_bytes('format', self.as_string())
2230
branch = self.open(a_bzrdir, name, _found=True,
2231
possible_transports=[target_branch.bzrdir.root_transport])
2232
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1042
2235
def _make_reference_clone_function(format, a_branch):
1043
2236
"""Create a clone() routine for a branch dynamically."""
1044
def clone(to_bzrdir, revision_id=None):
2237
def clone(to_bzrdir, revision_id=None,
2238
repository_policy=None):
1045
2239
"""See Branch.clone()."""
1046
return format.initialize(to_bzrdir, a_branch)
2240
return format.initialize(to_bzrdir, target_branch=a_branch)
1047
2241
# cannot obey revision_id limits when cloning a reference ...
1048
2242
# FIXME RBC 20060210 either nuke revision_id for clone, or
1049
2243
# emit some sort of warning/error to the caller ?!
1052
def open(self, a_bzrdir, _found=False):
2246
def open(self, a_bzrdir, name=None, _found=False, location=None,
2247
possible_transports=None, ignore_fallbacks=False,
2248
found_repository=None):
1053
2249
"""Return the branch that the branch reference in a_bzrdir points at.
1055
_found is a private parameter, do not use it. It is used to indicate
1056
if format probing has already be done.
2251
:param a_bzrdir: A BzrDir that contains a branch.
2252
:param name: Name of colocated branch to open, if any
2253
:param _found: a private parameter, do not use it. It is used to
2254
indicate if format probing has already be done.
2255
:param ignore_fallbacks: when set, no fallback branches will be opened
2256
(if there are any). Default is to open fallbacks.
2257
:param location: The location of the referenced branch. If
2258
unspecified, this will be determined from the branch reference in
2260
:param possible_transports: An optional reusable transports list.
2263
name = a_bzrdir._get_selected_branch()
1059
format = BranchFormat.find_format(a_bzrdir)
1060
assert format.__class__ == self.__class__
1061
transport = a_bzrdir.get_branch_transport(None)
1062
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
1063
result = real_bzrdir.open_branch()
2265
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2266
if format.__class__ != self.__class__:
2267
raise AssertionError("wrong format %r found for %r" %
2269
if location is None:
2270
location = self.get_reference(a_bzrdir, name)
2271
real_bzrdir = controldir.ControlDir.open(
2272
location, possible_transports=possible_transports)
2273
result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks,
2274
possible_transports=possible_transports)
1064
2275
# this changes the behaviour of result.clone to create a new reference
1065
2276
# rather than a copy of the content of the branch.
1066
2277
# I did not use a proxy object because that needs much more extensive
2287
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2288
"""Branch format registry."""
2290
def __init__(self, other_registry=None):
2291
super(BranchFormatRegistry, self).__init__(other_registry)
2292
self._default_format = None
2294
def set_default(self, format):
2295
self._default_format = format
2297
def get_default(self):
2298
return self._default_format
2301
network_format_registry = registry.FormatRegistry()
2302
"""Registry of formats indexed by their network name.
2304
The network name for a branch format is an identifier that can be used when
2305
referring to formats with smart server operations. See
2306
BranchFormat.network_name() for more detail.
2309
format_registry = BranchFormatRegistry(network_format_registry)
1076
2312
# formats which have no format string are not discoverable
1077
2313
# and not independently creatable, so are not registered.
1078
__default_format = BzrBranchFormat5()
1079
BranchFormat.register_format(__default_format)
1080
BranchFormat.register_format(BranchReferenceFormat())
1081
BranchFormat.register_format(BzrBranchFormat6())
1082
BranchFormat.set_default_format(__default_format)
1083
_legacy_formats = [BzrBranchFormat4(),
1086
class BzrBranch(Branch):
2314
__format6 = BzrBranchFormat6()
2315
__format7 = BzrBranchFormat7()
2316
__format8 = BzrBranchFormat8()
2317
format_registry.register_lazy(
2318
"Bazaar-NG branch format 5\n", "bzrlib.branchfmt.fullhistory", "BzrBranchFormat5")
2319
format_registry.register(BranchReferenceFormat())
2320
format_registry.register(__format6)
2321
format_registry.register(__format7)
2322
format_registry.register(__format8)
2323
format_registry.set_default(__format7)
2326
class BranchWriteLockResult(LogicalLockResult):
2327
"""The result of write locking a branch.
2329
:ivar branch_token: The token obtained from the underlying branch lock, or
2331
:ivar unlock: A callable which will unlock the lock.
2334
def __init__(self, unlock, branch_token):
2335
LogicalLockResult.__init__(self, unlock)
2336
self.branch_token = branch_token
2339
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2343
class BzrBranch(Branch, _RelockDebugMixin):
1087
2344
"""A branch stored in the actual filesystem.
1089
2346
Note that it's "local" in the context of the filesystem; it doesn't
1090
2347
really matter if it's on an nfs/smb/afs/coda/... share, as long as
1091
2348
it's writable, and can be accessed via the normal filesystem API.
2350
:ivar _transport: Transport for file operations on this branch's
2351
control files, typically pointing to the .bzr/branch directory.
2352
:ivar repository: Repository for this branch.
2353
:ivar base: The url of the base directory for this branch; the one
2354
containing the .bzr directory.
2355
:ivar name: Optional colocated branch name as it exists in the control
1094
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
1095
relax_version_check=DEPRECATED_PARAMETER, _format=None,
1096
_control_files=None, a_bzrdir=None, _repository=None):
1097
"""Create new branch object at a particular location.
1099
transport -- A Transport object, defining how to access files.
1101
init -- If True, create new control files in a previously
1102
unversioned directory. If False, the branch must already
1105
relax_version_check -- If true, the usual check for the branch
1106
version is not applied. This is intended only for
1107
upgrade/recovery type use; it's not guaranteed that
1108
all operations will work on old format branches.
2359
def __init__(self, _format=None,
2360
_control_files=None, a_bzrdir=None, name=None,
2361
_repository=None, ignore_fallbacks=False,
2362
possible_transports=None):
2363
"""Create new branch object at a particular location."""
1110
2364
if a_bzrdir is None:
1111
self.bzrdir = bzrdir.BzrDir.open(transport.base)
1113
self.bzrdir = a_bzrdir
1114
self._transport = self.bzrdir.transport.clone('..')
1115
self._base = self._transport.base
2365
raise ValueError('a_bzrdir must be supplied')
2367
raise ValueError('name must be supplied')
2368
self.bzrdir = a_bzrdir
2369
self._user_transport = self.bzrdir.transport.clone('..')
2371
self._user_transport.set_segment_parameter(
2372
"branch", urlutils.escape(name))
2373
self._base = self._user_transport.base
1116
2375
self._format = _format
1117
2376
if _control_files is None:
1118
2377
raise ValueError('BzrBranch _control_files is None')
1119
2378
self.control_files = _control_files
1120
if deprecated_passed(init):
1121
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
1122
"deprecated as of bzr 0.8. Please use Branch.create().",
1126
# this is slower than before deprecation, oh well never mind.
1127
# -> its deprecated.
1128
self._initialize(transport.base)
1129
self._check_format(_format)
1130
if deprecated_passed(relax_version_check):
1131
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
1132
"relax_version_check parameter is deprecated as of bzr 0.8. "
1133
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
1137
if (not relax_version_check
1138
and not self._format.is_supported()):
1139
raise errors.UnsupportedFormatError(format=fmt)
1140
if deprecated_passed(transport):
1141
warn("BzrBranch.__init__(transport=XXX...): The transport "
1142
"parameter is deprecated as of bzr 0.8. "
1143
"Please use Branch.open, or bzrdir.open_branch().",
2379
self._transport = _control_files._transport
1146
2380
self.repository = _repository
2381
self.conf_store = None
2382
Branch.__init__(self, possible_transports)
1148
2384
def __str__(self):
1149
return '%s(%r)' % (self.__class__.__name__, self.base)
2385
return '%s(%s)' % (self.__class__.__name__, self.user_url)
1151
2387
__repr__ = __str__
1153
2389
def _get_base(self):
2390
"""Returns the directory containing the control directory."""
1154
2391
return self._base
1156
2393
base = property(_get_base, doc="The URL for the root of this branch.")
1158
def _finish_transaction(self):
1159
"""Exit the current transaction."""
1160
return self.control_files._finish_transaction()
1162
def get_transaction(self):
1163
"""Return the current active transaction.
1165
If no transaction is active, this returns a passthrough object
1166
for which all data is immediately flushed and no caching happens.
1168
# this is an explicit function so that we can do tricky stuff
1169
# when the storage in rev_storage is elsewhere.
1170
# we probably need to hook the two 'lock a location' and
1171
# 'have a transaction' together more delicately, so that
1172
# we can have two locks (branch and storage) and one transaction
1173
# ... and finishing the transaction unlocks both, but unlocking
1174
# does not. - RBC 20051121
1175
return self.control_files.get_transaction()
1177
def _set_transaction(self, transaction):
1178
"""Set a new active transaction."""
1179
return self.control_files._set_transaction(transaction)
1181
def abspath(self, name):
1182
"""See Branch.abspath."""
1183
return self.control_files._transport.abspath(name)
1185
def _check_format(self, format):
1186
"""Identify the branch format if needed.
1188
The format is stored as a reference to the format object in
1189
self._format for code that needs to check it later.
1191
The format parameter is either None or the branch format class
1192
used to open this branch.
1194
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1197
format = BranchFormat.find_format(self.bzrdir)
1198
self._format = format
1199
mutter("got branch format %s", self._format)
1202
def get_root_id(self):
1203
"""See Branch.get_root_id."""
1204
tree = self.repository.revision_tree(self.last_revision())
1205
return tree.inventory.root.file_id
2396
def user_transport(self):
2397
return self._user_transport
2399
def _get_config(self):
2400
return _mod_config.TransportConfig(self._transport, 'branch.conf')
2402
def _get_config_store(self):
2403
if self.conf_store is None:
2404
self.conf_store = _mod_config.BranchStore(self)
2405
return self.conf_store
2407
def _uncommitted_branch(self):
2408
"""Return the branch that may contain uncommitted changes."""
2409
master = self.get_master_branch()
2410
if master is not None:
2415
def store_uncommitted(self, creator):
2416
"""Store uncommitted changes from a ShelfCreator.
2418
:param creator: The ShelfCreator containing uncommitted changes, or
2419
None to delete any stored changes.
2420
:raises: ChangesAlreadyStored if the branch already has changes.
2422
branch = self._uncommitted_branch()
2424
branch._transport.delete('stored-transform')
2426
if branch._transport.has('stored-transform'):
2427
raise errors.ChangesAlreadyStored
2428
transform = StringIO()
2429
creator.write_shelf(transform)
2431
branch._transport.put_file('stored-transform', transform)
2433
def get_unshelver(self, tree):
2434
"""Return a shelf.Unshelver for this branch and tree.
2436
:param tree: The tree to use to construct the Unshelver.
2437
:return: an Unshelver or None if no changes are stored.
2439
branch = self._uncommitted_branch()
2441
transform = branch._transport.get('stored-transform')
2442
except errors.NoSuchFile:
2444
return shelf.Unshelver.from_tree_and_shelf(tree, transform)
1207
2446
def is_locked(self):
1208
2447
return self.control_files.is_locked()
1210
def lock_write(self):
1211
self.repository.lock_write()
2449
def lock_write(self, token=None):
2450
"""Lock the branch for write operations.
2452
:param token: A token to permit reacquiring a previously held and
2454
:return: A BranchWriteLockResult.
2456
if not self.is_locked():
2457
self._note_lock('w')
2458
self.repository._warn_if_deprecated(self)
2459
self.repository.lock_write()
1213
self.control_files.lock_write()
2464
return BranchWriteLockResult(self.unlock,
2465
self.control_files.lock_write(token=token))
1215
self.repository.unlock()
2468
self.repository.unlock()
1218
2471
def lock_read(self):
1219
self.repository.lock_read()
2472
"""Lock the branch for read operations.
2474
:return: A bzrlib.lock.LogicalLockResult.
2476
if not self.is_locked():
2477
self._note_lock('r')
2478
self.repository._warn_if_deprecated(self)
2479
self.repository.lock_read()
1221
2484
self.control_files.lock_read()
2485
return LogicalLockResult(self.unlock)
1223
self.repository.unlock()
2488
self.repository.unlock()
2491
@only_raises(errors.LockNotHeld, errors.LockBroken)
1226
2492
def unlock(self):
1227
# TODO: test for failed two phase locks. This is known broken.
2493
if self.control_files._lock_count == 1 and self.conf_store is not None:
2494
self.conf_store.save_changes()
1229
2496
self.control_files.unlock()
1231
self.repository.unlock()
2498
if not self.control_files.is_locked():
2499
self.repository.unlock()
2500
# we just released the lock
2501
self._clear_cached_state()
1233
2503
def peek_lock_mode(self):
1234
2504
if self.control_files._lock_count == 0:
1245
2515
return self.repository.print_file(file, revision_id)
1247
2517
@needs_write_lock
1248
def append_revision(self, *revision_ids):
1249
"""See Branch.append_revision."""
1250
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1251
for revision_id in revision_ids:
1252
_mod_revision.check_not_reserved_id(revision_id)
1253
mutter("add {%s} to revision-history" % revision_id)
1254
rev_history = self.revision_history()
1255
rev_history.extend(revision_ids)
1256
self.set_revision_history(rev_history)
1258
def _write_revision_history(self, history):
1259
"""Factored out of set_revision_history.
1261
This performs the actual writing to disk.
1262
It is intended to be called by BzrBranch5.set_revision_history."""
1263
self.control_files.put_bytes(
1264
'revision-history', '\n'.join(history))
1267
def set_revision_history(self, rev_history):
1268
"""See Branch.set_revision_history."""
1269
rev_history = [osutils.safe_revision_id(r) for r in rev_history]
1270
self._write_revision_history(rev_history)
1271
transaction = self.get_transaction()
1272
history = transaction.map.find_revision_history()
1273
if history is not None:
1274
# update the revision history in the identity map.
1275
history[:] = list(rev_history)
1276
# this call is disabled because revision_history is
1277
# not really an object yet, and the transaction is for objects.
1278
# transaction.register_dirty(history)
1280
transaction.map.add_revision_history(rev_history)
1281
# this call is disabled because revision_history is
1282
# not really an object yet, and the transaction is for objects.
1283
# transaction.register_clean(history)
1284
for hook in Branch.hooks['set_rh']:
1285
hook(self, rev_history)
1288
2518
def set_last_revision_info(self, revno, revision_id):
1289
revision_id = osutils.safe_revision_id(revision_id)
1290
history = self._lefthand_history(revision_id)
1291
assert len(history) == revno, '%d != %d' % (len(history), revno)
1292
self.set_revision_history(history)
1294
def _gen_revision_history(self):
1295
get_cached_utf8 = cache_utf8.get_cached_utf8
1296
history = [get_cached_utf8(l.rstrip('\r\n')) for l in
1297
self.control_files.get('revision-history').readlines()]
1301
def revision_history(self):
1302
"""See Branch.revision_history."""
1303
transaction = self.get_transaction()
1304
history = transaction.map.find_revision_history()
1305
if history is not None:
1306
# mutter("cache hit for revision-history in %s", self)
1307
return list(history)
1308
history = self._gen_revision_history()
1309
transaction.map.add_revision_history(history)
1310
# this call is disabled because revision_history is
1311
# not really an object yet, and the transaction is for objects.
1312
# transaction.register_clean(history, precious=True)
1313
return list(history)
1315
def _lefthand_history(self, revision_id, last_rev=None,
1317
# stop_revision must be a descendant of last_revision
1318
stop_graph = self.repository.get_revision_graph(revision_id)
1319
if last_rev is not None and last_rev not in stop_graph:
1320
# our previous tip is not merged into stop_revision
1321
raise errors.DivergedBranches(self, other_branch)
1322
# make a new revision history from the graph
1323
current_rev_id = revision_id
1325
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1326
new_history.append(current_rev_id)
1327
current_rev_id_parents = stop_graph[current_rev_id]
1329
current_rev_id = current_rev_id_parents[0]
1331
current_rev_id = None
1332
new_history.reverse()
1336
def generate_revision_history(self, revision_id, last_rev=None,
1338
"""Create a new revision history that will finish with revision_id.
1340
:param revision_id: the new tip to use.
1341
:param last_rev: The previous last_revision. If not None, then this
1342
must be a ancestory of revision_id, or DivergedBranches is raised.
1343
:param other_branch: The other branch that DivergedBranches should
1344
raise with respect to.
1346
revision_id = osutils.safe_revision_id(revision_id)
1347
self.set_revision_history(self._lefthand_history(revision_id,
1348
last_rev, other_branch))
1351
def update_revisions(self, other, stop_revision=None):
1352
"""See Branch.update_revisions."""
1355
if stop_revision is None:
1356
stop_revision = other.last_revision()
1357
if stop_revision is None:
1358
# if there are no commits, we're done.
1361
stop_revision = osutils.safe_revision_id(stop_revision)
1362
# whats the current last revision, before we fetch [and change it
1364
last_rev = self.last_revision()
1365
# we fetch here regardless of whether we need to so that we pickup
1367
self.fetch(other, stop_revision)
1368
my_ancestry = self.repository.get_ancestry(last_rev)
1369
if stop_revision in my_ancestry:
1370
# last_revision is a descendant of stop_revision
1372
self.generate_revision_history(stop_revision, last_rev=last_rev,
2519
if not revision_id or not isinstance(revision_id, basestring):
2520
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2521
revision_id = _mod_revision.ensure_null(revision_id)
2522
old_revno, old_revid = self.last_revision_info()
2523
if self.get_append_revisions_only():
2524
self._check_history_violation(revision_id)
2525
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2526
self._write_last_revision_info(revno, revision_id)
2527
self._clear_cached_state()
2528
self._last_revision_info_cache = revno, revision_id
2529
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1377
2531
def basis_tree(self):
1378
2532
"""See Branch.basis_tree."""
1379
2533
return self.repository.revision_tree(self.last_revision())
1381
@deprecated_method(zero_eight)
1382
def working_tree(self):
1383
"""Create a Working tree object for this branch."""
1385
from bzrlib.transport.local import LocalTransport
1386
if (self.base.find('://') != -1 or
1387
not isinstance(self._transport, LocalTransport)):
1388
raise NoWorkingTree(self.base)
1389
return self.bzrdir.open_workingtree()
1392
def pull(self, source, overwrite=False, stop_revision=None,
1393
_hook_master=None, _run_hooks=True):
1396
:param _hook_master: Private parameter - set the branch to
1397
be supplied as the master to push hooks.
1398
:param _run_hooks: Private parameter - allow disabling of
1399
hooks, used when pushing to a master branch.
1403
old_count, old_tip = self.last_revision_info()
1405
self.update_revisions(source, stop_revision)
1406
except DivergedBranches:
1410
self.set_revision_history(source.revision_history())
1411
new_count, new_tip = self.last_revision_info()
1418
for hook in Branch.hooks['post_pull']:
1419
hook(source, _hook_local, _hook_master, old_count, old_tip,
1421
return new_count - old_count
1425
2535
def _get_parent_location(self):
1426
2536
_locs = ['parent', 'pull', 'x-pull']
1427
2537
for l in _locs:
1429
return self.control_files.get(l).read().strip('\n')
2539
return self._transport.get_bytes(l).strip('\n')
2540
except errors.NoSuchFile:
1435
def push(self, target, overwrite=False, stop_revision=None,
1436
_hook_master=None, _run_hooks=True):
1439
:param _hook_master: Private parameter - set the branch to
1440
be supplied as the master to push hooks.
1441
:param _run_hooks: Private parameter - allow disabling of
1442
hooks, used when pushing to a master branch.
1446
old_count, old_tip = target.last_revision_info()
1448
target.update_revisions(self, stop_revision)
1449
except DivergedBranches:
1453
target.set_revision_history(self.revision_history())
1454
new_count, new_tip = target.last_revision_info()
1457
_hook_local = target
1459
_hook_master = target
1461
for hook in Branch.hooks['post_push']:
1462
hook(self, _hook_local, _hook_master, old_count, old_tip,
1464
return new_count - old_count
1468
def get_parent(self):
1469
"""See Branch.get_parent."""
1471
assert self.base[-1] == '/'
1472
parent = self._get_parent_location()
1475
# This is an old-format absolute path to a local branch
1476
# turn it into a url
1477
if parent.startswith('/'):
1478
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1480
return urlutils.join(self.base[:-1], parent)
1481
except errors.InvalidURLJoin, e:
1482
raise errors.InaccessibleParent(parent, self.base)
1484
def get_push_location(self):
1485
"""See Branch.get_push_location."""
1486
push_loc = self.get_config().get_user_option('push_location')
2544
def get_stacked_on_url(self):
2545
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1489
2547
def set_push_location(self, location):
1490
2548
"""See Branch.set_push_location."""
1655
2586
# last_rev is not in the other_last_rev history, AND
1656
2587
# other_last_rev is not in our history, and do it without pulling
1657
2588
# history around
1658
last_rev = self.last_revision()
1659
if last_rev is not None:
1662
other_last_rev = other.last_revision()
1663
if other_last_rev is not None:
1664
# neither branch is new, we have to do some work to
1665
# ascertain diversion.
1666
remote_graph = other.repository.get_revision_graph(
1668
local_graph = self.repository.get_revision_graph(last_rev)
1669
if (last_rev not in remote_graph and
1670
other_last_rev not in local_graph):
1671
raise errors.DivergedBranches(self, other)
1674
2589
self.set_bound_location(other.base)
1678
"""If bound, unbind"""
1679
return self.set_bound_location(None)
1683
"""Synchronise this branch with the master branch if any.
2591
def get_bound_location(self):
2593
return self._transport.get_bytes('bound')[:-1]
2594
except errors.NoSuchFile:
2598
def get_master_branch(self, possible_transports=None):
2599
"""Return the branch we are bound to.
2601
:return: Either a Branch, or None
2603
if self._master_branch_cache is None:
2604
self._master_branch_cache = self._get_master_branch(
2605
possible_transports)
2606
return self._master_branch_cache
2608
def _get_master_branch(self, possible_transports):
2609
bound_loc = self.get_bound_location()
2613
return Branch.open(bound_loc,
2614
possible_transports=possible_transports)
2615
except (errors.NotBranchError, errors.ConnectionError), e:
2616
raise errors.BoundBranchConnectionFailure(
2620
def set_bound_location(self, location):
2621
"""Set the target where this branch is bound to.
2623
:param location: URL to the target branch
2625
self._master_branch_cache = None
2627
self._transport.put_bytes('bound', location+'\n',
2628
mode=self.bzrdir._get_file_mode())
2631
self._transport.delete('bound')
2632
except errors.NoSuchFile:
2637
def update(self, possible_transports=None):
2638
"""Synchronise this branch with the master branch if any.
1685
2640
:return: None or the last_revision that was pivoted out during the
1688
master = self.get_master_branch()
2643
master = self.get_master_branch(possible_transports)
1689
2644
if master is not None:
1690
old_tip = self.last_revision()
2645
old_tip = _mod_revision.ensure_null(self.last_revision())
1691
2646
self.pull(master, overwrite=True)
1692
if old_tip in self.repository.get_ancestry(self.last_revision()):
2647
if self.repository.get_graph().is_ancestor(old_tip,
2648
_mod_revision.ensure_null(self.last_revision())):
1698
class BzrBranch6(BzrBranch5):
1701
def last_revision_info(self):
1702
revision_string = self.control_files.get('last-revision').read()
2653
def _read_last_revision_info(self):
2654
revision_string = self._transport.get_bytes('last-revision')
1703
2655
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
1704
2656
revision_id = cache_utf8.get_cached_utf8(revision_id)
1705
2657
revno = int(revno)
1706
2658
return revno, revision_id
1708
def last_revision(self):
1709
"""Return last revision id, or None"""
1710
revision_id = self.last_revision_info()[1]
1711
if revision_id == _mod_revision.NULL_REVISION:
1715
2660
def _write_last_revision_info(self, revno, revision_id):
1716
2661
"""Simply write out the revision id, with no checks.
1718
2663
Use set_last_revision_info to perform this safely.
1720
2665
Does not update the revision_history cache.
1721
Intended to be called by set_last_revision_info and
1722
_write_revision_history.
1724
if revision_id is None:
1725
revision_id = 'null:'
2667
revision_id = _mod_revision.ensure_null(revision_id)
1726
2668
out_string = '%d %s\n' % (revno, revision_id)
1727
self.control_files.put_bytes('last-revision', out_string)
2669
self._transport.put_bytes('last-revision', out_string,
2670
mode=self.bzrdir._get_file_mode())
1729
2672
@needs_write_lock
1730
def set_last_revision_info(self, revno, revision_id):
1731
revision_id = osutils.safe_revision_id(revision_id)
1732
if self._get_append_revisions_only():
1733
self._check_history_violation(revision_id)
1734
self._write_last_revision_info(revno, revision_id)
1735
transaction = self.get_transaction()
1736
cached_history = transaction.map.find_revision_history()
1737
if cached_history is not None:
1738
transaction.map.remove_object(cached_history)
2673
def update_feature_flags(self, updated_flags):
2674
"""Update the feature flags for this branch.
2676
:param updated_flags: Dictionary mapping feature names to necessities
2677
A necessity can be None to indicate the feature should be removed
2679
self._format._update_feature_flags(updated_flags)
2680
self.control_transport.put_bytes('format', self._format.as_string())
2683
class BzrBranch8(BzrBranch):
2684
"""A branch that stores tree-reference locations."""
2686
def _open_hook(self, possible_transports=None):
2687
if self._ignore_fallbacks:
2689
if possible_transports is None:
2690
possible_transports = [self.bzrdir.root_transport]
2692
url = self.get_stacked_on_url()
2693
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2694
errors.UnstackableBranchFormat):
2697
for hook in Branch.hooks['transform_fallback_location']:
2698
url = hook(self, url)
2700
hook_name = Branch.hooks.get_hook_name(hook)
2701
raise AssertionError(
2702
"'transform_fallback_location' hook %s returned "
2703
"None, not a URL." % hook_name)
2704
self._activate_fallback_location(url,
2705
possible_transports=possible_transports)
2707
def __init__(self, *args, **kwargs):
2708
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2709
super(BzrBranch8, self).__init__(*args, **kwargs)
2710
self._last_revision_info_cache = None
2711
self._reference_info = None
2713
def _clear_cached_state(self):
2714
super(BzrBranch8, self)._clear_cached_state()
2715
self._last_revision_info_cache = None
2716
self._reference_info = None
1740
2718
def _check_history_violation(self, revision_id):
1741
last_revision = self.last_revision()
1742
if last_revision is None:
2719
current_revid = self.last_revision()
2720
last_revision = _mod_revision.ensure_null(current_revid)
2721
if _mod_revision.is_null(last_revision):
1744
if last_revision not in self._lefthand_history(revision_id):
1745
raise errors.AppendRevisionsOnlyViolation(self.base)
2723
graph = self.repository.get_graph()
2724
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2725
if lh_ancestor == current_revid:
2727
raise errors.AppendRevisionsOnlyViolation(self.user_url)
1747
2729
def _gen_revision_history(self):
1748
2730
"""Generate the revision history from last revision
1750
history = list(self.repository.iter_reverse_revision_history(
1751
self.last_revision()))
1755
def _write_revision_history(self, history):
1756
"""Factored out of set_revision_history.
1758
This performs the actual writing to disk, with format-specific checks.
1759
It is intended to be called by BzrBranch5.set_revision_history.
1761
if len(history) == 0:
1762
last_revision = 'null:'
1764
if history != self._lefthand_history(history[-1]):
1765
raise errors.NotLefthandHistory(history)
1766
last_revision = history[-1]
1767
if self._get_append_revisions_only():
1768
self._check_history_violation(last_revision)
1769
self._write_last_revision_info(len(history), last_revision)
1772
def append_revision(self, *revision_ids):
1773
revision_ids = [osutils.safe_revision_id(r) for r in revision_ids]
1774
if len(revision_ids) == 0:
1776
prev_revno, prev_revision = self.last_revision_info()
1777
for revision in self.repository.get_revisions(revision_ids):
1778
if prev_revision == _mod_revision.NULL_REVISION:
1779
if revision.parent_ids != []:
1780
raise errors.NotLeftParentDescendant(self, prev_revision,
1781
revision.revision_id)
1783
if revision.parent_ids[0] != prev_revision:
1784
raise errors.NotLeftParentDescendant(self, prev_revision,
1785
revision.revision_id)
1786
prev_revision = revision.revision_id
1787
self.set_last_revision_info(prev_revno + len(revision_ids),
1790
def _set_config_location(self, name, url, config=None,
1791
make_relative=False):
1793
config = self.get_config()
1797
url = urlutils.relative_url(self.base, url)
1798
config.set_user_option(name, url)
1801
def _get_config_location(self, name, config=None):
1803
config = self.get_config()
1804
location = config.get_user_option(name)
2732
last_revno, last_revision = self.last_revision_info()
2733
self._extend_partial_history(stop_index=last_revno-1)
2734
return list(reversed(self._partial_revision_history_cache))
1809
2736
@needs_write_lock
1810
2737
def _set_parent_location(self, url):
1816
2743
"""Set the parent branch"""
1817
2744
return self._get_config_location('parent_location')
2747
def _set_all_reference_info(self, info_dict):
2748
"""Replace all reference info stored in a branch.
2750
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2753
writer = rio.RioWriter(s)
2754
for key, (tree_path, branch_location) in info_dict.iteritems():
2755
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2756
branch_location=branch_location)
2757
writer.write_stanza(stanza)
2758
self._transport.put_bytes('references', s.getvalue())
2759
self._reference_info = info_dict
2762
def _get_all_reference_info(self):
2763
"""Return all the reference info stored in a branch.
2765
:return: A dict of {file_id: (tree_path, branch_location)}
2767
if self._reference_info is not None:
2768
return self._reference_info
2769
rio_file = self._transport.get('references')
2771
stanzas = rio.read_stanzas(rio_file)
2772
info_dict = dict((s['file_id'], (s['tree_path'],
2773
s['branch_location'])) for s in stanzas)
2776
self._reference_info = info_dict
2779
def set_reference_info(self, file_id, tree_path, branch_location):
2780
"""Set the branch location to use for a tree reference.
2782
:param file_id: The file-id of the tree reference.
2783
:param tree_path: The path of the tree reference in the tree.
2784
:param branch_location: The location of the branch to retrieve tree
2787
info_dict = self._get_all_reference_info()
2788
info_dict[file_id] = (tree_path, branch_location)
2789
if None in (tree_path, branch_location):
2790
if tree_path is not None:
2791
raise ValueError('tree_path must be None when branch_location'
2793
if branch_location is not None:
2794
raise ValueError('branch_location must be None when tree_path'
2796
del info_dict[file_id]
2797
self._set_all_reference_info(info_dict)
2799
def get_reference_info(self, file_id):
2800
"""Get the tree_path and branch_location for a tree reference.
2802
:return: a tuple of (tree_path, branch_location)
2804
return self._get_all_reference_info().get(file_id, (None, None))
2806
def reference_parent(self, file_id, path, possible_transports=None):
2807
"""Return the parent branch for a tree-reference file_id.
2809
:param file_id: The file_id of the tree reference
2810
:param path: The path of the file_id in the tree
2811
:return: A branch associated with the file_id
2813
branch_location = self.get_reference_info(file_id)[1]
2814
if branch_location is None:
2815
return Branch.reference_parent(self, file_id, path,
2816
possible_transports)
2817
branch_location = urlutils.join(self.user_url, branch_location)
2818
return Branch.open(branch_location,
2819
possible_transports=possible_transports)
1819
2821
def set_push_location(self, location):
1820
2822
"""See Branch.set_push_location."""
1821
2823
self._set_config_location('push_location', location)
1823
2825
def set_bound_location(self, location):
1824
2826
"""See Branch.set_push_location."""
2827
self._master_branch_cache = None
1826
config = self.get_config()
2829
conf = self.get_config_stack()
1827
2830
if location is None:
1828
if config.get_user_option('bound') != 'True':
2831
if not conf.get('bound'):
1831
config.set_user_option('bound', 'False')
2834
conf.set('bound', 'False')
1834
2837
self._set_config_location('bound_location', location,
1836
config.set_user_option('bound', 'True')
2839
conf.set('bound', 'True')
1839
2842
def _get_bound_location(self, bound):
1840
2843
"""Return the bound location in the config file.
1842
2845
Return None if the bound parameter does not match"""
1843
config = self.get_config()
1844
config_bound = (config.get_user_option('bound') == 'True')
1845
if config_bound != bound:
2846
conf = self.get_config_stack()
2847
if conf.get('bound') != bound:
1847
return self._get_config_location('bound_location', config=config)
2849
return self._get_config_location('bound_location', config=conf)
1849
2851
def get_bound_location(self):
1850
"""See Branch.set_push_location."""
2852
"""See Branch.get_bound_location."""
1851
2853
return self._get_bound_location(True)
1853
2855
def get_old_bound_location(self):
1854
2856
"""See Branch.get_old_bound_location"""
1855
2857
return self._get_bound_location(False)
1857
def set_append_revisions_only(self, enabled):
1862
self.get_config().set_user_option('append_revisions_only', value)
1864
def _get_append_revisions_only(self):
1865
value = self.get_config().get_user_option('append_revisions_only')
1866
return value == 'True'
1868
def _synchronize_history(self, destination, revision_id):
1869
"""Synchronize last revision and revision history between branches.
1871
This version is most efficient when the destination is also a
1872
BzrBranch6, but works for BzrBranch5, as long as the destination's
1873
repository contains all the lefthand ancestors of the intended
1874
last_revision. If not, set_last_revision_info will fail.
1876
:param destination: The branch to copy the history into
1877
:param revision_id: The revision-id to truncate history at. May
1878
be None to copy complete history.
1880
if revision_id is None:
1881
revno, revision_id = self.last_revision_info()
1883
revno = self.revision_id_to_revno(revision_id)
1884
destination.set_last_revision_info(revno, revision_id)
1887
class BranchTestProviderAdapter(object):
1888
"""A tool to generate a suite testing multiple branch formats at once.
1890
This is done by copying the test once for each transport and injecting
1891
the transport_server, transport_readonly_server, and branch_format
1892
classes into each copy. Each copy is also given a new id() to make it
1896
def __init__(self, transport_server, transport_readonly_server, formats):
1897
self._transport_server = transport_server
1898
self._transport_readonly_server = transport_readonly_server
1899
self._formats = formats
1901
def adapt(self, test):
1902
result = TestSuite()
1903
for branch_format, bzrdir_format in self._formats:
1904
new_test = deepcopy(test)
1905
new_test.transport_server = self._transport_server
1906
new_test.transport_readonly_server = self._transport_readonly_server
1907
new_test.bzrdir_format = bzrdir_format
1908
new_test.branch_format = branch_format
1909
def make_new_test_id():
1910
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1911
return lambda: new_id
1912
new_test.id = make_new_test_id()
1913
result.addTest(new_test)
2859
def get_stacked_on_url(self):
2860
# you can always ask for the URL; but you might not be able to use it
2861
# if the repo can't support stacking.
2862
## self._check_stackable_repo()
2863
# stacked_on_location is only ever defined in branch.conf, so don't
2864
# waste effort reading the whole stack of config files.
2865
conf = _mod_config.BranchOnlyStack(self)
2866
stacked_url = self._get_config_location('stacked_on_location',
2868
if stacked_url is None:
2869
raise errors.NotStacked(self)
2870
return stacked_url.encode('utf-8')
2873
def get_rev_id(self, revno, history=None):
2874
"""Find the revision id of the specified revno."""
2876
return _mod_revision.NULL_REVISION
2878
last_revno, last_revision_id = self.last_revision_info()
2879
if revno <= 0 or revno > last_revno:
2880
raise errors.NoSuchRevision(self, revno)
2882
if history is not None:
2883
return history[revno - 1]
2885
index = last_revno - revno
2886
if len(self._partial_revision_history_cache) <= index:
2887
self._extend_partial_history(stop_index=index)
2888
if len(self._partial_revision_history_cache) > index:
2889
return self._partial_revision_history_cache[index]
2891
raise errors.NoSuchRevision(self, revno)
2894
def revision_id_to_revno(self, revision_id):
2895
"""Given a revision id, return its revno"""
2896
if _mod_revision.is_null(revision_id):
2899
index = self._partial_revision_history_cache.index(revision_id)
2902
self._extend_partial_history(stop_revision=revision_id)
2903
except errors.RevisionNotPresent, e:
2904
raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
2905
index = len(self._partial_revision_history_cache) - 1
2907
raise errors.NoSuchRevision(self, revision_id)
2908
if self._partial_revision_history_cache[index] != revision_id:
2909
raise errors.NoSuchRevision(self, revision_id)
2910
return self.revno() - index
2913
class BzrBranch7(BzrBranch8):
2914
"""A branch with support for a fallback repository."""
2916
def set_reference_info(self, file_id, tree_path, branch_location):
2917
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2919
def get_reference_info(self, file_id):
2920
Branch.get_reference_info(self, file_id)
2922
def reference_parent(self, file_id, path, possible_transports=None):
2923
return Branch.reference_parent(self, file_id, path,
2924
possible_transports)
2927
class BzrBranch6(BzrBranch7):
2928
"""See BzrBranchFormat6 for the capabilities of this branch.
2930
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2934
def get_stacked_on_url(self):
2935
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2938
######################################################################
2939
# results of operations
2942
class _Result(object):
2944
def _show_tag_conficts(self, to_file):
2945
if not getattr(self, 'tag_conflicts', None):
2947
to_file.write('Conflicting tags:\n')
2948
for name, value1, value2 in self.tag_conflicts:
2949
to_file.write(' %s\n' % (name, ))
2952
class PullResult(_Result):
2953
"""Result of a Branch.pull operation.
2955
:ivar old_revno: Revision number before pull.
2956
:ivar new_revno: Revision number after pull.
2957
:ivar old_revid: Tip revision id before pull.
2958
:ivar new_revid: Tip revision id after pull.
2959
:ivar source_branch: Source (local) branch object. (read locked)
2960
:ivar master_branch: Master branch of the target, or the target if no
2962
:ivar local_branch: target branch if there is a Master, else None
2963
:ivar target_branch: Target/destination branch object. (write locked)
2964
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2965
:ivar tag_updates: A dict with new tags, see BasicTags.merge_to
2968
def report(self, to_file):
2969
tag_conflicts = getattr(self, "tag_conflicts", None)
2970
tag_updates = getattr(self, "tag_updates", None)
2972
if self.old_revid != self.new_revid:
2973
to_file.write('Now on revision %d.\n' % self.new_revno)
2975
to_file.write('%d tag(s) updated.\n' % len(tag_updates))
2976
if self.old_revid == self.new_revid and not tag_updates:
2977
if not tag_conflicts:
2978
to_file.write('No revisions or tags to pull.\n')
2980
to_file.write('No revisions to pull.\n')
2981
self._show_tag_conficts(to_file)
2984
class BranchPushResult(_Result):
2985
"""Result of a Branch.push operation.
2987
:ivar old_revno: Revision number (eg 10) of the target before push.
2988
:ivar new_revno: Revision number (eg 12) of the target after push.
2989
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2991
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2993
:ivar source_branch: Source branch object that the push was from. This is
2994
read locked, and generally is a local (and thus low latency) branch.
2995
:ivar master_branch: If target is a bound branch, the master branch of
2996
target, or target itself. Always write locked.
2997
:ivar target_branch: The direct Branch where data is being sent (write
2999
:ivar local_branch: If the target is a bound branch this will be the
3000
target, otherwise it will be None.
3003
def report(self, to_file):
3004
# TODO: This function gets passed a to_file, but then
3005
# ignores it and calls note() instead. This is also
3006
# inconsistent with PullResult(), which writes to stdout.
3007
# -- JRV20110901, bug #838853
3008
tag_conflicts = getattr(self, "tag_conflicts", None)
3009
tag_updates = getattr(self, "tag_updates", None)
3011
if self.old_revid != self.new_revid:
3012
note(gettext('Pushed up to revision %d.') % self.new_revno)
3014
note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
3015
if self.old_revid == self.new_revid and not tag_updates:
3016
if not tag_conflicts:
3017
note(gettext('No new revisions or tags to push.'))
3019
note(gettext('No new revisions to push.'))
3020
self._show_tag_conficts(to_file)
1917
3023
class BranchCheckResult(object):
1954
3051
new_branch = format.open(branch.bzrdir, _found=True)
1956
3053
# Copy source data into target
1957
new_branch.set_last_revision_info(*branch.last_revision_info())
1958
new_branch.set_parent(branch.get_parent())
1959
new_branch.set_bound_location(branch.get_bound_location())
1960
new_branch.set_push_location(branch.get_push_location())
3054
new_branch._write_last_revision_info(*branch.last_revision_info())
3055
new_branch.lock_write()
3057
new_branch.set_parent(branch.get_parent())
3058
new_branch.set_bound_location(branch.get_bound_location())
3059
new_branch.set_push_location(branch.get_push_location())
3063
# New branch has no tags by default
3064
new_branch.tags._set_tag_dict({})
1962
3066
# Copying done; now update target format
1963
new_branch.control_files.put_utf8('format',
1964
format.get_format_string())
3067
new_branch._transport.put_bytes('format',
3069
mode=new_branch.bzrdir._get_file_mode())
1966
3071
# Clean up old files
1967
new_branch.control_files._transport.delete('revision-history')
1969
branch.set_parent(None)
1972
branch.set_bound_location(None)
3072
new_branch._transport.delete('revision-history')
3076
branch.set_parent(None)
3077
except errors.NoSuchFile:
3079
branch.set_bound_location(None)
3084
class Converter6to7(object):
3085
"""Perform an in-place upgrade of format 6 to format 7"""
3087
def convert(self, branch):
3088
format = BzrBranchFormat7()
3089
branch._set_config_location('stacked_on_location', '')
3090
# update target format
3091
branch._transport.put_bytes('format', format.as_string())
3094
class Converter7to8(object):
3095
"""Perform an in-place upgrade of format 7 to format 8"""
3097
def convert(self, branch):
3098
format = BzrBranchFormat8()
3099
branch._transport.put_bytes('references', '')
3100
# update target format
3101
branch._transport.put_bytes('format', format.as_string())
3104
class InterBranch(InterObject):
3105
"""This class represents operations taking place between two branches.
3107
Its instances have methods like pull() and push() and contain
3108
references to the source and target repositories these operations
3109
can be carried out on.
3113
"""The available optimised InterBranch types."""
3116
def _get_branch_formats_to_test(klass):
3117
"""Return an iterable of format tuples for testing.
3119
:return: An iterable of (from_format, to_format) to use when testing
3120
this InterBranch class. Each InterBranch class should define this
3123
raise NotImplementedError(klass._get_branch_formats_to_test)
3126
def pull(self, overwrite=False, stop_revision=None,
3127
possible_transports=None, local=False):
3128
"""Mirror source into target branch.
3130
The target branch is considered to be 'local', having low latency.
3132
:returns: PullResult instance
3134
raise NotImplementedError(self.pull)
3137
def push(self, overwrite=False, stop_revision=None, lossy=False,
3138
_override_hook_source_branch=None):
3139
"""Mirror the source branch into the target branch.
3141
The source branch is considered to be 'local', having low latency.
3143
raise NotImplementedError(self.push)
3146
def copy_content_into(self, revision_id=None):
3147
"""Copy the content of source into target
3149
revision_id: if not None, the revision history in the new branch will
3150
be truncated to end with revision_id.
3152
raise NotImplementedError(self.copy_content_into)
3155
def fetch(self, stop_revision=None, limit=None):
3158
:param stop_revision: Last revision to fetch
3159
:param limit: Optional rough limit of revisions to fetch
3161
raise NotImplementedError(self.fetch)
3164
def _fix_overwrite_type(overwrite):
3165
if isinstance(overwrite, bool):
3167
return ["history", "tags"]
3173
class GenericInterBranch(InterBranch):
3174
"""InterBranch implementation that uses public Branch functions."""
3177
def is_compatible(klass, source, target):
3178
# GenericBranch uses the public API, so always compatible
3182
def _get_branch_formats_to_test(klass):
3183
return [(format_registry.get_default(), format_registry.get_default())]
3186
def unwrap_format(klass, format):
3187
if isinstance(format, remote.RemoteBranchFormat):
3188
format._ensure_real()
3189
return format._custom_format
3193
def copy_content_into(self, revision_id=None):
3194
"""Copy the content of source into target
3196
revision_id: if not None, the revision history in the new branch will
3197
be truncated to end with revision_id.
3199
self.source.update_references(self.target)
3200
self.source._synchronize_history(self.target, revision_id)
3202
parent = self.source.get_parent()
3203
except errors.InaccessibleParent, e:
3204
mutter('parent was not accessible to copy: %s', e)
3207
self.target.set_parent(parent)
3208
if self.source._push_should_merge_tags():
3209
self.source.tags.merge_to(self.target.tags)
3212
def fetch(self, stop_revision=None, limit=None):
3213
if self.target.base == self.source.base:
3215
self.source.lock_read()
3217
fetch_spec_factory = fetch.FetchSpecFactory()
3218
fetch_spec_factory.source_branch = self.source
3219
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3220
fetch_spec_factory.source_repo = self.source.repository
3221
fetch_spec_factory.target_repo = self.target.repository
3222
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3223
fetch_spec_factory.limit = limit
3224
fetch_spec = fetch_spec_factory.make_fetch_spec()
3225
return self.target.repository.fetch(self.source.repository,
3226
fetch_spec=fetch_spec)
3228
self.source.unlock()
3231
def _update_revisions(self, stop_revision=None, overwrite=False,
3233
other_revno, other_last_revision = self.source.last_revision_info()
3234
stop_revno = None # unknown
3235
if stop_revision is None:
3236
stop_revision = other_last_revision
3237
if _mod_revision.is_null(stop_revision):
3238
# if there are no commits, we're done.
3240
stop_revno = other_revno
3242
# what's the current last revision, before we fetch [and change it
3244
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3245
# we fetch here so that we don't process data twice in the common
3246
# case of having something to pull, and so that the check for
3247
# already merged can operate on the just fetched graph, which will
3248
# be cached in memory.
3249
self.fetch(stop_revision=stop_revision)
3250
# Check to see if one is an ancestor of the other
3253
graph = self.target.repository.get_graph()
3254
if self.target._check_if_descendant_or_diverged(
3255
stop_revision, last_rev, graph, self.source):
3256
# stop_revision is a descendant of last_rev, but we aren't
3257
# overwriting, so we're done.
3259
if stop_revno is None:
3261
graph = self.target.repository.get_graph()
3262
this_revno, this_last_revision = \
3263
self.target.last_revision_info()
3264
stop_revno = graph.find_distance_to_null(stop_revision,
3265
[(other_last_revision, other_revno),
3266
(this_last_revision, this_revno)])
3267
self.target.set_last_revision_info(stop_revno, stop_revision)
3270
def pull(self, overwrite=False, stop_revision=None,
3271
possible_transports=None, run_hooks=True,
3272
_override_hook_target=None, local=False):
3273
"""Pull from source into self, updating my master if any.
3275
:param run_hooks: Private parameter - if false, this branch
3276
is being called because it's the master of the primary branch,
3277
so it should not run its hooks.
3279
bound_location = self.target.get_bound_location()
3280
if local and not bound_location:
3281
raise errors.LocalRequiresBoundBranch()
3282
master_branch = None
3283
source_is_master = False
3285
# bound_location comes from a config file, some care has to be
3286
# taken to relate it to source.user_url
3287
normalized = urlutils.normalize_url(bound_location)
3289
relpath = self.source.user_transport.relpath(normalized)
3290
source_is_master = (relpath == '')
3291
except (errors.PathNotChild, errors.InvalidURL):
3292
source_is_master = False
3293
if not local and bound_location and not source_is_master:
3294
# not pulling from master, so we need to update master.
3295
master_branch = self.target.get_master_branch(possible_transports)
3296
master_branch.lock_write()
3299
# pull from source into master.
3300
master_branch.pull(self.source, overwrite, stop_revision,
3302
return self._pull(overwrite,
3303
stop_revision, _hook_master=master_branch,
3304
run_hooks=run_hooks,
3305
_override_hook_target=_override_hook_target,
3306
merge_tags_to_master=not source_is_master)
3309
master_branch.unlock()
3311
def push(self, overwrite=False, stop_revision=None, lossy=False,
3312
_override_hook_source_branch=None):
3313
"""See InterBranch.push.
3315
This is the basic concrete implementation of push()
3317
:param _override_hook_source_branch: If specified, run the hooks
3318
passing this Branch as the source, rather than self. This is for
3319
use of RemoteBranch, where push is delegated to the underlying
3323
raise errors.LossyPushToSameVCS(self.source, self.target)
3324
# TODO: Public option to disable running hooks - should be trivial but
3327
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3328
op.add_cleanup(self.source.lock_read().unlock)
3329
op.add_cleanup(self.target.lock_write().unlock)
3330
return op.run(overwrite, stop_revision,
3331
_override_hook_source_branch=_override_hook_source_branch)
3333
def _basic_push(self, overwrite, stop_revision):
3334
"""Basic implementation of push without bound branches or hooks.
3336
Must be called with source read locked and target write locked.
3338
result = BranchPushResult()
3339
result.source_branch = self.source
3340
result.target_branch = self.target
3341
result.old_revno, result.old_revid = self.target.last_revision_info()
3342
self.source.update_references(self.target)
3343
overwrite = _fix_overwrite_type(overwrite)
3344
if result.old_revid != stop_revision:
3345
# We assume that during 'push' this repository is closer than
3347
graph = self.source.repository.get_graph(self.target.repository)
3348
self._update_revisions(stop_revision,
3349
overwrite=("history" in overwrite),
3351
if self.source._push_should_merge_tags():
3352
result.tag_updates, result.tag_conflicts = (
3353
self.source.tags.merge_to(
3354
self.target.tags, "tags" in overwrite))
3355
result.new_revno, result.new_revid = self.target.last_revision_info()
3358
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3359
_override_hook_source_branch=None):
3360
"""Push from source into target, and into target's master if any.
3363
if _override_hook_source_branch:
3364
result.source_branch = _override_hook_source_branch
3365
for hook in Branch.hooks['post_push']:
3368
bound_location = self.target.get_bound_location()
3369
if bound_location and self.target.base != bound_location:
3370
# there is a master branch.
3372
# XXX: Why the second check? Is it even supported for a branch to
3373
# be bound to itself? -- mbp 20070507
3374
master_branch = self.target.get_master_branch()
3375
master_branch.lock_write()
3376
operation.add_cleanup(master_branch.unlock)
3377
# push into the master from the source branch.
3378
master_inter = InterBranch.get(self.source, master_branch)
3379
master_inter._basic_push(overwrite, stop_revision)
3380
# and push into the target branch from the source. Note that
3381
# we push from the source branch again, because it's considered
3382
# the highest bandwidth repository.
3383
result = self._basic_push(overwrite, stop_revision)
3384
result.master_branch = master_branch
3385
result.local_branch = self.target
3387
master_branch = None
3389
result = self._basic_push(overwrite, stop_revision)
3390
# TODO: Why set master_branch and local_branch if there's no
3391
# binding? Maybe cleaner to just leave them unset? -- mbp
3393
result.master_branch = self.target
3394
result.local_branch = None
3398
def _pull(self, overwrite=False, stop_revision=None,
3399
possible_transports=None, _hook_master=None, run_hooks=True,
3400
_override_hook_target=None, local=False,
3401
merge_tags_to_master=True):
3404
This function is the core worker, used by GenericInterBranch.pull to
3405
avoid duplication when pulling source->master and source->local.
3407
:param _hook_master: Private parameter - set the branch to
3408
be supplied as the master to pull hooks.
3409
:param run_hooks: Private parameter - if false, this branch
3410
is being called because it's the master of the primary branch,
3411
so it should not run its hooks.
3412
is being called because it's the master of the primary branch,
3413
so it should not run its hooks.
3414
:param _override_hook_target: Private parameter - set the branch to be
3415
supplied as the target_branch to pull hooks.
3416
:param local: Only update the local branch, and not the bound branch.
3418
# This type of branch can't be bound.
3420
raise errors.LocalRequiresBoundBranch()
3421
result = PullResult()
3422
result.source_branch = self.source
3423
if _override_hook_target is None:
3424
result.target_branch = self.target
3426
result.target_branch = _override_hook_target
3427
self.source.lock_read()
3429
# We assume that during 'pull' the target repository is closer than
3431
self.source.update_references(self.target)
3432
graph = self.target.repository.get_graph(self.source.repository)
3433
# TODO: Branch formats should have a flag that indicates
3434
# that revno's are expensive, and pull() should honor that flag.
3436
result.old_revno, result.old_revid = \
3437
self.target.last_revision_info()
3438
overwrite = _fix_overwrite_type(overwrite)
3439
self._update_revisions(stop_revision,
3440
overwrite=("history" in overwrite),
3442
# TODO: The old revid should be specified when merging tags,
3443
# so a tags implementation that versions tags can only
3444
# pull in the most recent changes. -- JRV20090506
3445
result.tag_updates, result.tag_conflicts = (
3446
self.source.tags.merge_to(self.target.tags,
3447
"tags" in overwrite,
3448
ignore_master=not merge_tags_to_master))
3449
result.new_revno, result.new_revid = self.target.last_revision_info()
3451
result.master_branch = _hook_master
3452
result.local_branch = result.target_branch
3454
result.master_branch = result.target_branch
3455
result.local_branch = None
3457
for hook in Branch.hooks['post_pull']:
3460
self.source.unlock()
3464
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
