1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
from cStringIO import StringIO
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
23
from itertools import chain
27
config as _mod_config,
33
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TransportConfig
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
from bzrlib.tag import (
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
from bzrlib.hooks import HookPoint, Hooks
51
from bzrlib.inter import InterObject
52
from bzrlib.lock import _RelockDebugMixin
53
from bzrlib import registry
54
from bzrlib.symbol_versioning import (
58
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
61
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
62
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
66
# TODO: Maybe include checks for common corruption of newlines, etc?
68
# TODO: Some operations like log might retrieve the same revisions
69
# repeatedly to calculate deltas. We could perhaps have a weakref
70
# cache in memory to make this faster. In general anything can be
71
# cached in memory between lock and unlock operations. .. nb thats
72
# what the transaction identity map provides
75
######################################################################
79
"""Branch holding a history of revisions.
82
Base directory/url of the branch.
84
hooks: An instance of BranchHooks.
86
# this is really an instance variable - FIXME move it there
90
def __init__(self, *ignored, **ignored_too):
91
self.tags = self._format.make_tags(self)
92
self._revision_history_cache = None
93
self._revision_id_to_revno_cache = None
94
self._partial_revision_id_to_revno_cache = {}
95
self._partial_revision_history_cache = []
96
self._last_revision_info_cache = None
97
self._merge_sorted_revisions_cache = None
99
hooks = Branch.hooks['open']
103
def _open_hook(self):
104
"""Called by init to allow simpler extension of the base class."""
106
def _activate_fallback_location(self, url):
107
"""Activate the branch/repository from url as a fallback repository."""
108
repo = self._get_fallback_repository(url)
109
if repo.has_same_location(self.repository):
110
raise errors.UnstackableLocationError(self.base, url)
111
self.repository.add_fallback_repository(repo)
113
def break_lock(self):
114
"""Break a lock if one is present from another instance.
116
Uses the ui factory to ask for confirmation if the lock may be from
119
This will probe the repository for its lock as well.
121
self.control_files.break_lock()
122
self.repository.break_lock()
123
master = self.get_master_branch()
124
if master is not None:
127
def _check_stackable_repo(self):
128
if not self.repository._format.supports_external_lookups:
129
raise errors.UnstackableRepositoryFormat(self.repository._format,
130
self.repository.base)
132
def _extend_partial_history(self, stop_index=None, stop_revision=None):
133
"""Extend the partial history to include a given index
135
If a stop_index is supplied, stop when that index has been reached.
136
If a stop_revision is supplied, stop when that revision is
137
encountered. Otherwise, stop when the beginning of history is
140
:param stop_index: The index which should be present. When it is
141
present, history extension will stop.
142
:param stop_revision: The revision id which should be present. When
143
it is encountered, history extension will stop.
145
if len(self._partial_revision_history_cache) == 0:
146
self._partial_revision_history_cache = [self.last_revision()]
147
repository._iter_for_revno(
148
self.repository, self._partial_revision_history_cache,
149
stop_index=stop_index, stop_revision=stop_revision)
150
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
151
self._partial_revision_history_cache.pop()
153
def _get_check_refs(self):
154
"""Get the references needed for check().
158
revid = self.last_revision()
159
return [('revision-existence', revid), ('lefthand-distance', revid)]
162
def open(base, _unsupported=False, possible_transports=None):
163
"""Open the branch rooted at base.
165
For instance, if the branch is at URL/.bzr/branch,
166
Branch.open(URL) -> a Branch instance.
168
control = bzrdir.BzrDir.open(base, _unsupported,
169
possible_transports=possible_transports)
170
return control.open_branch(unsupported=_unsupported)
173
def open_from_transport(transport, name=None, _unsupported=False):
174
"""Open the branch rooted at transport"""
175
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
176
return control.open_branch(name=name, unsupported=_unsupported)
179
def open_containing(url, possible_transports=None):
180
"""Open an existing branch which contains url.
182
This probes for a branch at url, and searches upwards from there.
184
Basically we keep looking up until we find the control directory or
185
run into the root. If there isn't one, raises NotBranchError.
186
If there is one and it is either an unrecognised format or an unsupported
187
format, UnknownFormatError or UnsupportedFormatError are raised.
188
If there is one, it is returned, along with the unused portion of url.
190
control, relpath = bzrdir.BzrDir.open_containing(url,
192
return control.open_branch(), relpath
194
def _push_should_merge_tags(self):
195
"""Should _basic_push merge this branch's tags into the target?
197
The default implementation returns False if this branch has no tags,
198
and True the rest of the time. Subclasses may override this.
200
return self.supports_tags() and self.tags.get_tag_dict()
202
def get_config(self):
203
return BranchConfig(self)
205
def _get_config(self):
206
"""Get the concrete config for just the config in this branch.
208
This is not intended for client use; see Branch.get_config for the
213
:return: An object supporting get_option and set_option.
215
raise NotImplementedError(self._get_config)
217
def _get_fallback_repository(self, url):
218
"""Get the repository we fallback to at url."""
219
url = urlutils.join(self.base, url)
220
a_branch = Branch.open(url,
221
possible_transports=[self.bzrdir.root_transport])
222
return a_branch.repository
224
def _get_tags_bytes(self):
225
"""Get the bytes of a serialised tags dict.
227
Note that not all branches support tags, nor do all use the same tags
228
logic: this method is specific to BasicTags. Other tag implementations
229
may use the same method name and behave differently, safely, because
230
of the double-dispatch via
231
format.make_tags->tags_instance->get_tags_dict.
233
:return: The bytes of the tags file.
234
:seealso: Branch._set_tags_bytes.
236
return self._transport.get_bytes('tags')
238
def _get_nick(self, local=False, possible_transports=None):
239
config = self.get_config()
240
# explicit overrides master, but don't look for master if local is True
241
if not local and not config.has_explicit_nickname():
243
master = self.get_master_branch(possible_transports)
244
if master is not None:
245
# return the master branch value
247
except errors.BzrError, e:
248
# Silently fall back to local implicit nick if the master is
250
mutter("Could not connect to bound branch, "
251
"falling back to local nick.\n " + str(e))
252
return config.get_nickname()
254
def _set_nick(self, nick):
255
self.get_config().set_user_option('nickname', nick, warn_masked=True)
257
nick = property(_get_nick, _set_nick)
260
raise NotImplementedError(self.is_locked)
262
def _lefthand_history(self, revision_id, last_rev=None,
264
if 'evil' in debug.debug_flags:
265
mutter_callsite(4, "_lefthand_history scales with history.")
266
# stop_revision must be a descendant of last_revision
267
graph = self.repository.get_graph()
268
if last_rev is not None:
269
if not graph.is_ancestor(last_rev, revision_id):
270
# our previous tip is not merged into stop_revision
271
raise errors.DivergedBranches(self, other_branch)
272
# make a new revision history from the graph
273
parents_map = graph.get_parent_map([revision_id])
274
if revision_id not in parents_map:
275
raise errors.NoSuchRevision(self, revision_id)
276
current_rev_id = revision_id
278
check_not_reserved_id = _mod_revision.check_not_reserved_id
279
# Do not include ghosts or graph origin in revision_history
280
while (current_rev_id in parents_map and
281
len(parents_map[current_rev_id]) > 0):
282
check_not_reserved_id(current_rev_id)
283
new_history.append(current_rev_id)
284
current_rev_id = parents_map[current_rev_id][0]
285
parents_map = graph.get_parent_map([current_rev_id])
286
new_history.reverse()
289
def lock_write(self):
290
raise NotImplementedError(self.lock_write)
293
raise NotImplementedError(self.lock_read)
296
raise NotImplementedError(self.unlock)
298
def peek_lock_mode(self):
299
"""Return lock mode for the Branch: 'r', 'w' or None"""
300
raise NotImplementedError(self.peek_lock_mode)
302
def get_physical_lock_status(self):
303
raise NotImplementedError(self.get_physical_lock_status)
306
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
307
"""Return the revision_id for a dotted revno.
309
:param revno: a tuple like (1,) or (1,1,2)
310
:param _cache_reverse: a private parameter enabling storage
311
of the reverse mapping in a top level cache. (This should
312
only be done in selective circumstances as we want to
313
avoid having the mapping cached multiple times.)
314
:return: the revision_id
315
:raises errors.NoSuchRevision: if the revno doesn't exist
317
rev_id = self._do_dotted_revno_to_revision_id(revno)
319
self._partial_revision_id_to_revno_cache[rev_id] = revno
322
def _do_dotted_revno_to_revision_id(self, revno):
323
"""Worker function for dotted_revno_to_revision_id.
325
Subclasses should override this if they wish to
326
provide a more efficient implementation.
329
return self.get_rev_id(revno[0])
330
revision_id_to_revno = self.get_revision_id_to_revno_map()
331
revision_ids = [revision_id for revision_id, this_revno
332
in revision_id_to_revno.iteritems()
333
if revno == this_revno]
334
if len(revision_ids) == 1:
335
return revision_ids[0]
337
revno_str = '.'.join(map(str, revno))
338
raise errors.NoSuchRevision(self, revno_str)
341
def revision_id_to_dotted_revno(self, revision_id):
342
"""Given a revision id, return its dotted revno.
344
:return: a tuple like (1,) or (400,1,3).
346
return self._do_revision_id_to_dotted_revno(revision_id)
348
def _do_revision_id_to_dotted_revno(self, revision_id):
349
"""Worker function for revision_id_to_revno."""
350
# Try the caches if they are loaded
351
result = self._partial_revision_id_to_revno_cache.get(revision_id)
352
if result is not None:
354
if self._revision_id_to_revno_cache:
355
result = self._revision_id_to_revno_cache.get(revision_id)
357
raise errors.NoSuchRevision(self, revision_id)
358
# Try the mainline as it's optimised
360
revno = self.revision_id_to_revno(revision_id)
362
except errors.NoSuchRevision:
363
# We need to load and use the full revno map after all
364
result = self.get_revision_id_to_revno_map().get(revision_id)
366
raise errors.NoSuchRevision(self, revision_id)
370
def get_revision_id_to_revno_map(self):
371
"""Return the revision_id => dotted revno map.
373
This will be regenerated on demand, but will be cached.
375
:return: A dictionary mapping revision_id => dotted revno.
376
This dictionary should not be modified by the caller.
378
if self._revision_id_to_revno_cache is not None:
379
mapping = self._revision_id_to_revno_cache
381
mapping = self._gen_revno_map()
382
self._cache_revision_id_to_revno(mapping)
383
# TODO: jam 20070417 Since this is being cached, should we be returning
385
# I would rather not, and instead just declare that users should not
386
# modify the return value.
389
def _gen_revno_map(self):
390
"""Create a new mapping from revision ids to dotted revnos.
392
Dotted revnos are generated based on the current tip in the revision
394
This is the worker function for get_revision_id_to_revno_map, which
395
just caches the return value.
397
:return: A dictionary mapping revision_id => dotted revno.
399
revision_id_to_revno = dict((rev_id, revno)
400
for rev_id, depth, revno, end_of_merge
401
in self.iter_merge_sorted_revisions())
402
return revision_id_to_revno
405
def iter_merge_sorted_revisions(self, start_revision_id=None,
406
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
407
"""Walk the revisions for a branch in merge sorted order.
409
Merge sorted order is the output from a merge-aware,
410
topological sort, i.e. all parents come before their
411
children going forward; the opposite for reverse.
413
:param start_revision_id: the revision_id to begin walking from.
414
If None, the branch tip is used.
415
:param stop_revision_id: the revision_id to terminate the walk
416
after. If None, the rest of history is included.
417
:param stop_rule: if stop_revision_id is not None, the precise rule
418
to use for termination:
419
* 'exclude' - leave the stop revision out of the result (default)
420
* 'include' - the stop revision is the last item in the result
421
* 'with-merges' - include the stop revision and all of its
422
merged revisions in the result
423
* 'with-merges-without-common-ancestry' - filter out revisions
424
that are in both ancestries
425
:param direction: either 'reverse' or 'forward':
426
* reverse means return the start_revision_id first, i.e.
427
start at the most recent revision and go backwards in history
428
* forward returns tuples in the opposite order to reverse.
429
Note in particular that forward does *not* do any intelligent
430
ordering w.r.t. depth as some clients of this API may like.
431
(If required, that ought to be done at higher layers.)
433
:return: an iterator over (revision_id, depth, revno, end_of_merge)
436
* revision_id: the unique id of the revision
437
* depth: How many levels of merging deep this node has been
439
* revno_sequence: This field provides a sequence of
440
revision numbers for all revisions. The format is:
441
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
442
branch that the revno is on. From left to right the REVNO numbers
443
are the sequence numbers within that branch of the revision.
444
* end_of_merge: When True the next node (earlier in history) is
445
part of a different merge.
447
# Note: depth and revno values are in the context of the branch so
448
# we need the full graph to get stable numbers, regardless of the
450
if self._merge_sorted_revisions_cache is None:
451
last_revision = self.last_revision()
452
known_graph = self.repository.get_known_graph_ancestry(
454
self._merge_sorted_revisions_cache = known_graph.merge_sort(
456
filtered = self._filter_merge_sorted_revisions(
457
self._merge_sorted_revisions_cache, start_revision_id,
458
stop_revision_id, stop_rule)
459
# Make sure we don't return revisions that are not part of the
460
# start_revision_id ancestry.
461
filtered = self._filter_start_non_ancestors(filtered)
462
if direction == 'reverse':
464
if direction == 'forward':
465
return reversed(list(filtered))
467
raise ValueError('invalid direction %r' % direction)
469
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
470
start_revision_id, stop_revision_id, stop_rule):
471
"""Iterate over an inclusive range of sorted revisions."""
472
rev_iter = iter(merge_sorted_revisions)
473
if start_revision_id is not None:
474
for node in rev_iter:
475
rev_id = node.key[-1]
476
if rev_id != start_revision_id:
479
# The decision to include the start or not
480
# depends on the stop_rule if a stop is provided
481
# so pop this node back into the iterator
482
rev_iter = chain(iter([node]), rev_iter)
484
if stop_revision_id is None:
486
for node in rev_iter:
487
rev_id = node.key[-1]
488
yield (rev_id, node.merge_depth, node.revno,
490
elif stop_rule == 'exclude':
491
for node in rev_iter:
492
rev_id = node.key[-1]
493
if rev_id == stop_revision_id:
495
yield (rev_id, node.merge_depth, node.revno,
497
elif stop_rule == 'include':
498
for node in rev_iter:
499
rev_id = node.key[-1]
500
yield (rev_id, node.merge_depth, node.revno,
502
if rev_id == stop_revision_id:
504
elif stop_rule == 'with-merges-without-common-ancestry':
505
# We want to exclude all revisions that are already part of the
506
# stop_revision_id ancestry.
507
graph = self.repository.get_graph()
508
ancestors = graph.find_unique_ancestors(start_revision_id,
510
for node in rev_iter:
511
rev_id = node.key[-1]
512
if rev_id not in ancestors:
514
yield (rev_id, node.merge_depth, node.revno,
516
elif stop_rule == 'with-merges':
517
stop_rev = self.repository.get_revision(stop_revision_id)
518
if stop_rev.parent_ids:
519
left_parent = stop_rev.parent_ids[0]
521
left_parent = _mod_revision.NULL_REVISION
522
# left_parent is the actual revision we want to stop logging at,
523
# since we want to show the merged revisions after the stop_rev too
524
reached_stop_revision_id = False
525
revision_id_whitelist = []
526
for node in rev_iter:
527
rev_id = node.key[-1]
528
if rev_id == left_parent:
529
# reached the left parent after the stop_revision
531
if (not reached_stop_revision_id or
532
rev_id in revision_id_whitelist):
533
yield (rev_id, node.merge_depth, node.revno,
535
if reached_stop_revision_id or rev_id == stop_revision_id:
536
# only do the merged revs of rev_id from now on
537
rev = self.repository.get_revision(rev_id)
539
reached_stop_revision_id = True
540
revision_id_whitelist.extend(rev.parent_ids)
542
raise ValueError('invalid stop_rule %r' % stop_rule)
544
def _filter_start_non_ancestors(self, rev_iter):
545
# If we started from a dotted revno, we want to consider it as a tip
546
# and don't want to yield revisions that are not part of its
547
# ancestry. Given the order guaranteed by the merge sort, we will see
548
# uninteresting descendants of the first parent of our tip before the
550
first = rev_iter.next()
551
(rev_id, merge_depth, revno, end_of_merge) = first
554
# We start at a mainline revision so by definition, all others
555
# revisions in rev_iter are ancestors
556
for node in rev_iter:
561
pmap = self.repository.get_parent_map([rev_id])
562
parents = pmap.get(rev_id, [])
564
whitelist.update(parents)
566
# If there is no parents, there is nothing of interest left
568
# FIXME: It's hard to test this scenario here as this code is never
569
# called in that case. -- vila 20100322
572
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
574
if rev_id in whitelist:
575
pmap = self.repository.get_parent_map([rev_id])
576
parents = pmap.get(rev_id, [])
577
whitelist.remove(rev_id)
578
whitelist.update(parents)
580
# We've reached the mainline, there is nothing left to
584
# A revision that is not part of the ancestry of our
587
yield (rev_id, merge_depth, revno, end_of_merge)
589
def leave_lock_in_place(self):
590
"""Tell this branch object not to release the physical lock when this
593
If lock_write doesn't return a token, then this method is not supported.
595
self.control_files.leave_in_place()
597
def dont_leave_lock_in_place(self):
598
"""Tell this branch object to release the physical lock when this
599
object is unlocked, even if it didn't originally acquire it.
601
If lock_write doesn't return a token, then this method is not supported.
603
self.control_files.dont_leave_in_place()
605
def bind(self, other):
606
"""Bind the local branch the other branch.
608
:param other: The branch to bind to
611
raise errors.UpgradeRequired(self.base)
613
def set_append_revisions_only(self, enabled):
614
if not self._format.supports_set_append_revisions_only():
615
raise errors.UpgradeRequired(self.base)
620
self.get_config().set_user_option('append_revisions_only', value,
623
def set_reference_info(self, file_id, tree_path, branch_location):
624
"""Set the branch location to use for a tree reference."""
625
raise errors.UnsupportedOperation(self.set_reference_info, self)
627
def get_reference_info(self, file_id):
628
"""Get the tree_path and branch_location for a tree reference."""
629
raise errors.UnsupportedOperation(self.get_reference_info, self)
632
def fetch(self, from_branch, last_revision=None, pb=None):
633
"""Copy revisions from from_branch into this branch.
635
:param from_branch: Where to copy from.
636
:param last_revision: What revision to stop at (None for at the end
638
:param pb: An optional progress bar to use.
641
if self.base == from_branch.base:
644
symbol_versioning.warn(
645
symbol_versioning.deprecated_in((1, 14, 0))
646
% "pb parameter to fetch()")
647
from_branch.lock_read()
649
if last_revision is None:
650
last_revision = from_branch.last_revision()
651
last_revision = _mod_revision.ensure_null(last_revision)
652
return self.repository.fetch(from_branch.repository,
653
revision_id=last_revision,
658
def get_bound_location(self):
659
"""Return the URL of the branch we are bound to.
661
Older format branches cannot bind, please be sure to use a metadir
666
def get_old_bound_location(self):
667
"""Return the URL of the branch we used to be bound to
669
raise errors.UpgradeRequired(self.base)
671
def get_commit_builder(self, parents, config=None, timestamp=None,
672
timezone=None, committer=None, revprops=None,
674
"""Obtain a CommitBuilder for this branch.
676
:param parents: Revision ids of the parents of the new revision.
677
:param config: Optional configuration to use.
678
:param timestamp: Optional timestamp recorded for commit.
679
:param timezone: Optional timezone for timestamp.
680
:param committer: Optional committer to set for commit.
681
:param revprops: Optional dictionary of revision properties.
682
:param revision_id: Optional revision id.
686
config = self.get_config()
688
return self.repository.get_commit_builder(self, parents, config,
689
timestamp, timezone, committer, revprops, revision_id)
691
def get_master_branch(self, possible_transports=None):
692
"""Return the branch we are bound to.
694
:return: Either a Branch, or None
698
def get_revision_delta(self, revno):
699
"""Return the delta for one revision.
701
The delta is relative to its mainline predecessor, or the
702
empty tree for revision 1.
704
rh = self.revision_history()
705
if not (1 <= revno <= len(rh)):
706
raise errors.InvalidRevisionNumber(revno)
707
return self.repository.get_revision_delta(rh[revno-1])
709
def get_stacked_on_url(self):
710
"""Get the URL this branch is stacked against.
712
:raises NotStacked: If the branch is not stacked.
713
:raises UnstackableBranchFormat: If the branch does not support
716
raise NotImplementedError(self.get_stacked_on_url)
718
def print_file(self, file, revision_id):
719
"""Print `file` to stdout."""
720
raise NotImplementedError(self.print_file)
722
def set_revision_history(self, rev_history):
723
raise NotImplementedError(self.set_revision_history)
726
def set_parent(self, url):
727
"""See Branch.set_parent."""
728
# TODO: Maybe delete old location files?
729
# URLs should never be unicode, even on the local fs,
730
# FIXUP this and get_parent in a future branch format bump:
731
# read and rewrite the file. RBC 20060125
733
if isinstance(url, unicode):
735
url = url.encode('ascii')
736
except UnicodeEncodeError:
737
raise errors.InvalidURL(url,
738
"Urls must be 7-bit ascii, "
739
"use bzrlib.urlutils.escape")
740
url = urlutils.relative_url(self.base, url)
741
self._set_parent_location(url)
744
def set_stacked_on_url(self, url):
745
"""Set the URL this branch is stacked against.
747
:raises UnstackableBranchFormat: If the branch does not support
749
:raises UnstackableRepositoryFormat: If the repository does not support
752
if not self._format.supports_stacking():
753
raise errors.UnstackableBranchFormat(self._format, self.base)
754
# XXX: Changing from one fallback repository to another does not check
755
# that all the data you need is present in the new fallback.
756
# Possibly it should.
757
self._check_stackable_repo()
760
old_url = self.get_stacked_on_url()
761
except (errors.NotStacked, errors.UnstackableBranchFormat,
762
errors.UnstackableRepositoryFormat):
766
self._activate_fallback_location(url)
767
# write this out after the repository is stacked to avoid setting a
768
# stacked config that doesn't work.
769
self._set_config_location('stacked_on_location', url)
772
"""Change a branch to be unstacked, copying data as needed.
774
Don't call this directly, use set_stacked_on_url(None).
776
pb = ui.ui_factory.nested_progress_bar()
778
pb.update("Unstacking")
779
# The basic approach here is to fetch the tip of the branch,
780
# including all available ghosts, from the existing stacked
781
# repository into a new repository object without the fallbacks.
783
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
784
# correct for CHKMap repostiories
785
old_repository = self.repository
786
if len(old_repository._fallback_repositories) != 1:
787
raise AssertionError("can't cope with fallback repositories "
788
"of %r" % (self.repository,))
789
# unlock it, including unlocking the fallback
790
old_repository.unlock()
791
old_repository.lock_read()
793
# Repositories don't offer an interface to remove fallback
794
# repositories today; take the conceptually simpler option and just
795
# reopen it. We reopen it starting from the URL so that we
796
# get a separate connection for RemoteRepositories and can
797
# stream from one of them to the other. This does mean doing
798
# separate SSH connection setup, but unstacking is not a
799
# common operation so it's tolerable.
800
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
801
new_repository = new_bzrdir.find_repository()
802
self.repository = new_repository
803
if self.repository._fallback_repositories:
804
raise AssertionError("didn't expect %r to have "
805
"fallback_repositories"
806
% (self.repository,))
807
# this is not paired with an unlock because it's just restoring
808
# the previous state; the lock's released when set_stacked_on_url
810
self.repository.lock_write()
811
# XXX: If you unstack a branch while it has a working tree
812
# with a pending merge, the pending-merged revisions will no
813
# longer be present. You can (probably) revert and remerge.
815
# XXX: This only fetches up to the tip of the repository; it
816
# doesn't bring across any tags. That's fairly consistent
817
# with how branch works, but perhaps not ideal.
818
self.repository.fetch(old_repository,
819
revision_id=self.last_revision(),
822
old_repository.unlock()
826
def _set_tags_bytes(self, bytes):
827
"""Mirror method for _get_tags_bytes.
829
:seealso: Branch._get_tags_bytes.
831
return _run_with_write_locked_target(self, self._transport.put_bytes,
834
def _cache_revision_history(self, rev_history):
835
"""Set the cached revision history to rev_history.
837
The revision_history method will use this cache to avoid regenerating
838
the revision history.
840
This API is semi-public; it only for use by subclasses, all other code
841
should consider it to be private.
843
self._revision_history_cache = rev_history
845
def _cache_revision_id_to_revno(self, revision_id_to_revno):
846
"""Set the cached revision_id => revno map to revision_id_to_revno.
848
This API is semi-public; it only for use by subclasses, all other code
849
should consider it to be private.
851
self._revision_id_to_revno_cache = revision_id_to_revno
853
def _clear_cached_state(self):
854
"""Clear any cached data on this branch, e.g. cached revision history.
856
This means the next call to revision_history will need to call
857
_gen_revision_history.
859
This API is semi-public; it only for use by subclasses, all other code
860
should consider it to be private.
862
self._revision_history_cache = None
863
self._revision_id_to_revno_cache = None
864
self._last_revision_info_cache = None
865
self._merge_sorted_revisions_cache = None
866
self._partial_revision_history_cache = []
867
self._partial_revision_id_to_revno_cache = {}
869
def _gen_revision_history(self):
870
"""Return sequence of revision hashes on to this branch.
872
Unlike revision_history, this method always regenerates or rereads the
873
revision history, i.e. it does not cache the result, so repeated calls
876
Concrete subclasses should override this instead of revision_history so
877
that subclasses do not need to deal with caching logic.
879
This API is semi-public; it only for use by subclasses, all other code
880
should consider it to be private.
882
raise NotImplementedError(self._gen_revision_history)
885
def revision_history(self):
886
"""Return sequence of revision ids on this branch.
888
This method will cache the revision history for as long as it is safe to
891
if 'evil' in debug.debug_flags:
892
mutter_callsite(3, "revision_history scales with history.")
893
if self._revision_history_cache is not None:
894
history = self._revision_history_cache
896
history = self._gen_revision_history()
897
self._cache_revision_history(history)
901
"""Return current revision number for this branch.
903
That is equivalent to the number of revisions committed to
906
return self.last_revision_info()[0]
909
"""Older format branches cannot bind or unbind."""
910
raise errors.UpgradeRequired(self.base)
912
def last_revision(self):
913
"""Return last revision id, or NULL_REVISION."""
914
return self.last_revision_info()[1]
917
def last_revision_info(self):
918
"""Return information about the last revision.
920
:return: A tuple (revno, revision_id).
922
if self._last_revision_info_cache is None:
923
self._last_revision_info_cache = self._last_revision_info()
924
return self._last_revision_info_cache
926
def _last_revision_info(self):
927
rh = self.revision_history()
930
return (revno, rh[-1])
932
return (0, _mod_revision.NULL_REVISION)
934
@deprecated_method(deprecated_in((1, 6, 0)))
935
def missing_revisions(self, other, stop_revision=None):
936
"""Return a list of new revisions that would perfectly fit.
938
If self and other have not diverged, return a list of the revisions
939
present in other, but missing from self.
941
self_history = self.revision_history()
942
self_len = len(self_history)
943
other_history = other.revision_history()
944
other_len = len(other_history)
945
common_index = min(self_len, other_len) -1
946
if common_index >= 0 and \
947
self_history[common_index] != other_history[common_index]:
948
raise errors.DivergedBranches(self, other)
950
if stop_revision is None:
951
stop_revision = other_len
953
if stop_revision > other_len:
954
raise errors.NoSuchRevision(self, stop_revision)
955
return other_history[self_len:stop_revision]
958
def update_revisions(self, other, stop_revision=None, overwrite=False,
960
"""Pull in new perfect-fit revisions.
962
:param other: Another Branch to pull from
963
:param stop_revision: Updated until the given revision
964
:param overwrite: Always set the branch pointer, rather than checking
965
to see if it is a proper descendant.
966
:param graph: A Graph object that can be used to query history
967
information. This can be None.
970
return InterBranch.get(other, self).update_revisions(stop_revision,
973
def import_last_revision_info(self, source_repo, revno, revid):
974
"""Set the last revision info, importing from another repo if necessary.
976
This is used by the bound branch code to upload a revision to
977
the master branch first before updating the tip of the local branch.
979
:param source_repo: Source repository to optionally fetch from
980
:param revno: Revision number of the new tip
981
:param revid: Revision id of the new tip
983
if not self.repository.has_same_location(source_repo):
984
self.repository.fetch(source_repo, revision_id=revid)
985
self.set_last_revision_info(revno, revid)
987
def revision_id_to_revno(self, revision_id):
988
"""Given a revision id, return its revno"""
989
if _mod_revision.is_null(revision_id):
991
history = self.revision_history()
993
return history.index(revision_id) + 1
995
raise errors.NoSuchRevision(self, revision_id)
998
def get_rev_id(self, revno, history=None):
999
"""Find the revision id of the specified revno."""
1001
return _mod_revision.NULL_REVISION
1002
last_revno, last_revid = self.last_revision_info()
1003
if revno == last_revno:
1005
if revno <= 0 or revno > last_revno:
1006
raise errors.NoSuchRevision(self, revno)
1007
distance_from_last = last_revno - revno
1008
if len(self._partial_revision_history_cache) <= distance_from_last:
1009
self._extend_partial_history(distance_from_last)
1010
return self._partial_revision_history_cache[distance_from_last]
1013
def pull(self, source, overwrite=False, stop_revision=None,
1014
possible_transports=None, *args, **kwargs):
1015
"""Mirror source into this branch.
1017
This branch is considered to be 'local', having low latency.
1019
:returns: PullResult instance
1021
return InterBranch.get(source, self).pull(overwrite=overwrite,
1022
stop_revision=stop_revision,
1023
possible_transports=possible_transports, *args, **kwargs)
1025
def push(self, target, overwrite=False, stop_revision=None, *args,
1027
"""Mirror this branch into target.
1029
This branch is considered to be 'local', having low latency.
1031
return InterBranch.get(self, target).push(overwrite, stop_revision,
1034
def lossy_push(self, target, stop_revision=None):
1035
"""Push deltas into another branch.
1037
:note: This does not, like push, retain the revision ids from
1038
the source branch and will, rather than adding bzr-specific
1039
metadata, push only those semantics of the revision that can be
1040
natively represented by this branch' VCS.
1042
:param target: Target branch
1043
:param stop_revision: Revision to push, defaults to last revision.
1044
:return: BranchPushResult with an extra member revidmap:
1045
A dictionary mapping revision ids from the target branch
1046
to new revision ids in the target branch, for each
1047
revision that was pushed.
1049
inter = InterBranch.get(self, target)
1050
lossy_push = getattr(inter, "lossy_push", None)
1051
if lossy_push is None:
1052
raise errors.LossyPushToSameVCS(self, target)
1053
return lossy_push(stop_revision)
1055
def basis_tree(self):
1056
"""Return `Tree` object for last revision."""
1057
return self.repository.revision_tree(self.last_revision())
1059
def get_parent(self):
1060
"""Return the parent location of the branch.
1062
This is the default location for pull/missing. The usual
1063
pattern is that the user can override it by specifying a
1066
parent = self._get_parent_location()
1069
# This is an old-format absolute path to a local branch
1070
# turn it into a url
1071
if parent.startswith('/'):
1072
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1074
return urlutils.join(self.base[:-1], parent)
1075
except errors.InvalidURLJoin, e:
1076
raise errors.InaccessibleParent(parent, self.base)
1078
def _get_parent_location(self):
1079
raise NotImplementedError(self._get_parent_location)
1081
def _set_config_location(self, name, url, config=None,
1082
make_relative=False):
1084
config = self.get_config()
1088
url = urlutils.relative_url(self.base, url)
1089
config.set_user_option(name, url, warn_masked=True)
1091
def _get_config_location(self, name, config=None):
1093
config = self.get_config()
1094
location = config.get_user_option(name)
1099
def get_child_submit_format(self):
1100
"""Return the preferred format of submissions to this branch."""
1101
return self.get_config().get_user_option("child_submit_format")
1103
def get_submit_branch(self):
1104
"""Return the submit location of the branch.
1106
This is the default location for bundle. The usual
1107
pattern is that the user can override it by specifying a
1110
return self.get_config().get_user_option('submit_branch')
1112
def set_submit_branch(self, location):
1113
"""Return the submit location of the branch.
1115
This is the default location for bundle. The usual
1116
pattern is that the user can override it by specifying a
1119
self.get_config().set_user_option('submit_branch', location,
1122
def get_public_branch(self):
1123
"""Return the public location of the branch.
1125
This is used by merge directives.
1127
return self._get_config_location('public_branch')
1129
def set_public_branch(self, location):
1130
"""Return the submit location of the branch.
1132
This is the default location for bundle. The usual
1133
pattern is that the user can override it by specifying a
1136
self._set_config_location('public_branch', location)
1138
def get_push_location(self):
1139
"""Return the None or the location to push this branch to."""
1140
push_loc = self.get_config().get_user_option('push_location')
1143
def set_push_location(self, location):
1144
"""Set a new push location for this branch."""
1145
raise NotImplementedError(self.set_push_location)
1147
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1148
"""Run the post_change_branch_tip hooks."""
1149
hooks = Branch.hooks['post_change_branch_tip']
1152
new_revno, new_revid = self.last_revision_info()
1153
params = ChangeBranchTipParams(
1154
self, old_revno, new_revno, old_revid, new_revid)
1158
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1159
"""Run the pre_change_branch_tip hooks."""
1160
hooks = Branch.hooks['pre_change_branch_tip']
1163
old_revno, old_revid = self.last_revision_info()
1164
params = ChangeBranchTipParams(
1165
self, old_revno, new_revno, old_revid, new_revid)
1171
"""Synchronise this branch with the master branch if any.
1173
:return: None or the last_revision pivoted out during the update.
1177
def check_revno(self, revno):
1179
Check whether a revno corresponds to any revision.
1180
Zero (the NULL revision) is considered valid.
1183
self.check_real_revno(revno)
1185
def check_real_revno(self, revno):
1187
Check whether a revno corresponds to a real revision.
1188
Zero (the NULL revision) is considered invalid
1190
if revno < 1 or revno > self.revno():
1191
raise errors.InvalidRevisionNumber(revno)
1194
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1195
"""Clone this branch into to_bzrdir preserving all semantic values.
1197
Most API users will want 'create_clone_on_transport', which creates a
1198
new bzrdir and branch on the fly.
1200
revision_id: if not None, the revision history in the new branch will
1201
be truncated to end with revision_id.
1203
result = to_bzrdir.create_branch()
1206
if repository_policy is not None:
1207
repository_policy.configure_branch(result)
1208
self.copy_content_into(result, revision_id=revision_id)
1214
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1215
"""Create a new line of development from the branch, into to_bzrdir.
1217
to_bzrdir controls the branch format.
1219
revision_id: if not None, the revision history in the new branch will
1220
be truncated to end with revision_id.
1222
if (repository_policy is not None and
1223
repository_policy.requires_stacking()):
1224
to_bzrdir._format.require_stacking(_skip_repo=True)
1225
result = to_bzrdir.create_branch()
1228
if repository_policy is not None:
1229
repository_policy.configure_branch(result)
1230
self.copy_content_into(result, revision_id=revision_id)
1231
result.set_parent(self.bzrdir.root_transport.base)
1236
def _synchronize_history(self, destination, revision_id):
1237
"""Synchronize last revision and revision history between branches.
1239
This version is most efficient when the destination is also a
1240
BzrBranch6, but works for BzrBranch5, as long as the destination's
1241
repository contains all the lefthand ancestors of the intended
1242
last_revision. If not, set_last_revision_info will fail.
1244
:param destination: The branch to copy the history into
1245
:param revision_id: The revision-id to truncate history at. May
1246
be None to copy complete history.
1248
source_revno, source_revision_id = self.last_revision_info()
1249
if revision_id is None:
1250
revno, revision_id = source_revno, source_revision_id
1252
graph = self.repository.get_graph()
1254
revno = graph.find_distance_to_null(revision_id,
1255
[(source_revision_id, source_revno)])
1256
except errors.GhostRevisionsHaveNoRevno:
1257
# Default to 1, if we can't find anything else
1259
destination.set_last_revision_info(revno, revision_id)
1262
def copy_content_into(self, destination, revision_id=None):
1263
"""Copy the content of self into destination.
1265
revision_id: if not None, the revision history in the new branch will
1266
be truncated to end with revision_id.
1268
self.update_references(destination)
1269
self._synchronize_history(destination, revision_id)
1271
parent = self.get_parent()
1272
except errors.InaccessibleParent, e:
1273
mutter('parent was not accessible to copy: %s', e)
1276
destination.set_parent(parent)
1277
if self._push_should_merge_tags():
1278
self.tags.merge_to(destination.tags)
1280
def update_references(self, target):
1281
if not getattr(self._format, 'supports_reference_locations', False):
1283
reference_dict = self._get_all_reference_info()
1284
if len(reference_dict) == 0:
1286
old_base = self.base
1287
new_base = target.base
1288
target_reference_dict = target._get_all_reference_info()
1289
for file_id, (tree_path, branch_location) in (
1290
reference_dict.items()):
1291
branch_location = urlutils.rebase_url(branch_location,
1293
target_reference_dict.setdefault(
1294
file_id, (tree_path, branch_location))
1295
target._set_all_reference_info(target_reference_dict)
1298
def check(self, refs):
1299
"""Check consistency of the branch.
1301
In particular this checks that revisions given in the revision-history
1302
do actually match up in the revision graph, and that they're all
1303
present in the repository.
1305
Callers will typically also want to check the repository.
1307
:param refs: Calculated refs for this branch as specified by
1308
branch._get_check_refs()
1309
:return: A BranchCheckResult.
1311
result = BranchCheckResult(self)
1312
last_revno, last_revision_id = self.last_revision_info()
1313
actual_revno = refs[('lefthand-distance', last_revision_id)]
1314
if actual_revno != last_revno:
1315
result.errors.append(errors.BzrCheckError(
1316
'revno does not match len(mainline) %s != %s' % (
1317
last_revno, actual_revno)))
1318
# TODO: We should probably also check that self.revision_history
1319
# matches the repository for older branch formats.
1320
# If looking for the code that cross-checks repository parents against
1321
# the iter_reverse_revision_history output, that is now a repository
1325
def _get_checkout_format(self):
1326
"""Return the most suitable metadir for a checkout of this branch.
1327
Weaves are used if this branch's repository uses weaves.
1329
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1330
from bzrlib.repofmt import weaverepo
1331
format = bzrdir.BzrDirMetaFormat1()
1332
format.repository_format = weaverepo.RepositoryFormat7()
1334
format = self.repository.bzrdir.checkout_metadir()
1335
format.set_branch_format(self._format)
1338
def create_clone_on_transport(self, to_transport, revision_id=None,
1339
stacked_on=None, create_prefix=False, use_existing_dir=False):
1340
"""Create a clone of this branch and its bzrdir.
1342
:param to_transport: The transport to clone onto.
1343
:param revision_id: The revision id to use as tip in the new branch.
1344
If None the tip is obtained from this branch.
1345
:param stacked_on: An optional URL to stack the clone on.
1346
:param create_prefix: Create any missing directories leading up to
1348
:param use_existing_dir: Use an existing directory if one exists.
1350
# XXX: Fix the bzrdir API to allow getting the branch back from the
1351
# clone call. Or something. 20090224 RBC/spiv.
1352
if revision_id is None:
1353
revision_id = self.last_revision()
1354
dir_to = self.bzrdir.clone_on_transport(to_transport,
1355
revision_id=revision_id, stacked_on=stacked_on,
1356
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1357
return dir_to.open_branch()
1359
def create_checkout(self, to_location, revision_id=None,
1360
lightweight=False, accelerator_tree=None,
1362
"""Create a checkout of a branch.
1364
:param to_location: The url to produce the checkout at
1365
:param revision_id: The revision to check out
1366
:param lightweight: If True, produce a lightweight checkout, otherwise,
1367
produce a bound branch (heavyweight checkout)
1368
:param accelerator_tree: A tree which can be used for retrieving file
1369
contents more quickly than the revision tree, i.e. a workingtree.
1370
The revision tree will be used for cases where accelerator_tree's
1371
content is different.
1372
:param hardlink: If true, hard-link files from accelerator_tree,
1374
:return: The tree of the created checkout
1376
t = transport.get_transport(to_location)
1379
format = self._get_checkout_format()
1380
checkout = format.initialize_on_transport(t)
1381
from_branch = BranchReferenceFormat().initialize(checkout,
1384
format = self._get_checkout_format()
1385
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1386
to_location, force_new_tree=False, format=format)
1387
checkout = checkout_branch.bzrdir
1388
checkout_branch.bind(self)
1389
# pull up to the specified revision_id to set the initial
1390
# branch tip correctly, and seed it with history.
1391
checkout_branch.pull(self, stop_revision=revision_id)
1393
tree = checkout.create_workingtree(revision_id,
1394
from_branch=from_branch,
1395
accelerator_tree=accelerator_tree,
1397
basis_tree = tree.basis_tree()
1398
basis_tree.lock_read()
1400
for path, file_id in basis_tree.iter_references():
1401
reference_parent = self.reference_parent(file_id, path)
1402
reference_parent.create_checkout(tree.abspath(path),
1403
basis_tree.get_reference_revision(file_id, path),
1410
def reconcile(self, thorough=True):
1411
"""Make sure the data stored in this branch is consistent."""
1412
from bzrlib.reconcile import BranchReconciler
1413
reconciler = BranchReconciler(self, thorough=thorough)
1414
reconciler.reconcile()
1417
def reference_parent(self, file_id, path, possible_transports=None):
1418
"""Return the parent branch for a tree-reference file_id
1419
:param file_id: The file_id of the tree reference
1420
:param path: The path of the file_id in the tree
1421
:return: A branch associated with the file_id
1423
# FIXME should provide multiple branches, based on config
1424
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1425
possible_transports=possible_transports)
1427
def supports_tags(self):
1428
return self._format.supports_tags()
1430
def automatic_tag_name(self, revision_id):
1431
"""Try to automatically find the tag name for a revision.
1433
:param revision_id: Revision id of the revision.
1434
:return: A tag name or None if no tag name could be determined.
1436
for hook in Branch.hooks['automatic_tag_name']:
1437
ret = hook(self, revision_id)
1442
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1444
"""Ensure that revision_b is a descendant of revision_a.
1446
This is a helper function for update_revisions.
1448
:raises: DivergedBranches if revision_b has diverged from revision_a.
1449
:returns: True if revision_b is a descendant of revision_a.
1451
relation = self._revision_relations(revision_a, revision_b, graph)
1452
if relation == 'b_descends_from_a':
1454
elif relation == 'diverged':
1455
raise errors.DivergedBranches(self, other_branch)
1456
elif relation == 'a_descends_from_b':
1459
raise AssertionError("invalid relation: %r" % (relation,))
1461
def _revision_relations(self, revision_a, revision_b, graph):
1462
"""Determine the relationship between two revisions.
1464
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1466
heads = graph.heads([revision_a, revision_b])
1467
if heads == set([revision_b]):
1468
return 'b_descends_from_a'
1469
elif heads == set([revision_a, revision_b]):
1470
# These branches have diverged
1472
elif heads == set([revision_a]):
1473
return 'a_descends_from_b'
1475
raise AssertionError("invalid heads: %r" % (heads,))
1478
class BranchFormat(object):
1479
"""An encapsulation of the initialization and open routines for a format.
1481
Formats provide three things:
1482
* An initialization routine,
1486
Formats are placed in an dict by their format string for reference
1487
during branch opening. Its not required that these be instances, they
1488
can be classes themselves with class methods - it simply depends on
1489
whether state is needed for a given format or not.
1491
Once a format is deprecated, just deprecate the initialize and open
1492
methods on the format class. Do not deprecate the object, as the
1493
object will be created every time regardless.
1496
_default_format = None
1497
"""The default format used for new branches."""
1500
"""The known formats."""
1502
can_set_append_revisions_only = True
1504
def __eq__(self, other):
1505
return self.__class__ is other.__class__
1507
def __ne__(self, other):
1508
return not (self == other)
1511
def find_format(klass, a_bzrdir, name=None):
1512
"""Return the format for the branch object in a_bzrdir."""
1514
transport = a_bzrdir.get_branch_transport(None, name=name)
1515
format_string = transport.get_bytes("format")
1516
return klass._formats[format_string]
1517
except errors.NoSuchFile:
1518
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1520
raise errors.UnknownFormatError(format=format_string, kind='branch')
1523
def get_default_format(klass):
1524
"""Return the current default format."""
1525
return klass._default_format
1527
def get_reference(self, a_bzrdir):
1528
"""Get the target reference of the branch in a_bzrdir.
1530
format probing must have been completed before calling
1531
this method - it is assumed that the format of the branch
1532
in a_bzrdir is correct.
1534
:param a_bzrdir: The bzrdir to get the branch data from.
1535
:return: None if the branch is not a reference branch.
1540
def set_reference(self, a_bzrdir, to_branch):
1541
"""Set the target reference of the branch in a_bzrdir.
1543
format probing must have been completed before calling
1544
this method - it is assumed that the format of the branch
1545
in a_bzrdir is correct.
1547
:param a_bzrdir: The bzrdir to set the branch reference for.
1548
:param to_branch: branch that the checkout is to reference
1550
raise NotImplementedError(self.set_reference)
1552
def get_format_string(self):
1553
"""Return the ASCII format string that identifies this format."""
1554
raise NotImplementedError(self.get_format_string)
1556
def get_format_description(self):
1557
"""Return the short format description for this format."""
1558
raise NotImplementedError(self.get_format_description)
1560
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1561
hooks = Branch.hooks['post_branch_init']
1564
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1568
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1569
lock_type='metadir', set_format=True):
1570
"""Initialize a branch in a bzrdir, with specified files
1572
:param a_bzrdir: The bzrdir to initialize the branch in
1573
:param utf8_files: The files to create as a list of
1574
(filename, content) tuples
1575
:param name: Name of colocated branch to create, if any
1576
:param set_format: If True, set the format with
1577
self.get_format_string. (BzrBranch4 has its format set
1579
:return: a branch in this format
1581
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1582
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1584
'metadir': ('lock', lockdir.LockDir),
1585
'branch4': ('branch-lock', lockable_files.TransportLock),
1587
lock_name, lock_class = lock_map[lock_type]
1588
control_files = lockable_files.LockableFiles(branch_transport,
1589
lock_name, lock_class)
1590
control_files.create_lock()
1592
control_files.lock_write()
1593
except errors.LockContention:
1594
if lock_type != 'branch4':
1600
utf8_files += [('format', self.get_format_string())]
1602
for (filename, content) in utf8_files:
1603
branch_transport.put_bytes(
1605
mode=a_bzrdir._get_file_mode())
1608
control_files.unlock()
1609
branch = self.open(a_bzrdir, name, _found=True)
1610
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1613
def initialize(self, a_bzrdir, name=None):
1614
"""Create a branch of this format in a_bzrdir.
1616
:param name: Name of the colocated branch to create.
1618
raise NotImplementedError(self.initialize)
1620
def is_supported(self):
1621
"""Is this format supported?
1623
Supported formats can be initialized and opened.
1624
Unsupported formats may not support initialization or committing or
1625
some other features depending on the reason for not being supported.
1629
def make_tags(self, branch):
1630
"""Create a tags object for branch.
1632
This method is on BranchFormat, because BranchFormats are reflected
1633
over the wire via network_name(), whereas full Branch instances require
1634
multiple VFS method calls to operate at all.
1636
The default implementation returns a disabled-tags instance.
1638
Note that it is normal for branch to be a RemoteBranch when using tags
1641
return DisabledTags(branch)
1643
def network_name(self):
1644
"""A simple byte string uniquely identifying this format for RPC calls.
1646
MetaDir branch formats use their disk format string to identify the
1647
repository over the wire. All in one formats such as bzr < 0.8, and
1648
foreign formats like svn/git and hg should use some marker which is
1649
unique and immutable.
1651
raise NotImplementedError(self.network_name)
1653
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1654
"""Return the branch object for a_bzrdir
1656
:param a_bzrdir: A BzrDir that contains a branch.
1657
:param name: Name of colocated branch to open
1658
:param _found: a private parameter, do not use it. It is used to
1659
indicate if format probing has already be done.
1660
:param ignore_fallbacks: when set, no fallback branches will be opened
1661
(if there are any). Default is to open fallbacks.
1663
raise NotImplementedError(self.open)
1666
def register_format(klass, format):
1667
"""Register a metadir format."""
1668
klass._formats[format.get_format_string()] = format
1669
# Metadir formats have a network name of their format string, and get
1670
# registered as class factories.
1671
network_format_registry.register(format.get_format_string(), format.__class__)
1674
def set_default_format(klass, format):
1675
klass._default_format = format
1677
def supports_set_append_revisions_only(self):
1678
"""True if this format supports set_append_revisions_only."""
1681
def supports_stacking(self):
1682
"""True if this format records a stacked-on branch."""
1686
def unregister_format(klass, format):
1687
del klass._formats[format.get_format_string()]
1690
return self.get_format_description().rstrip()
1692
def supports_tags(self):
1693
"""True if this format supports tags stored in the branch"""
1694
return False # by default
1697
class BranchHooks(Hooks):
1698
"""A dictionary mapping hook name to a list of callables for branch hooks.
1700
e.g. ['set_rh'] Is the list of items to be called when the
1701
set_revision_history function is invoked.
1705
"""Create the default hooks.
1707
These are all empty initially, because by default nothing should get
1710
Hooks.__init__(self)
1711
self.create_hook(HookPoint('set_rh',
1712
"Invoked whenever the revision history has been set via "
1713
"set_revision_history. The api signature is (branch, "
1714
"revision_history), and the branch will be write-locked. "
1715
"The set_rh hook can be expensive for bzr to trigger, a better "
1716
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1717
self.create_hook(HookPoint('open',
1718
"Called with the Branch object that has been opened after a "
1719
"branch is opened.", (1, 8), None))
1720
self.create_hook(HookPoint('post_push',
1721
"Called after a push operation completes. post_push is called "
1722
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1723
"bzr client.", (0, 15), None))
1724
self.create_hook(HookPoint('post_pull',
1725
"Called after a pull operation completes. post_pull is called "
1726
"with a bzrlib.branch.PullResult object and only runs in the "
1727
"bzr client.", (0, 15), None))
1728
self.create_hook(HookPoint('pre_commit',
1729
"Called after a commit is calculated but before it is is "
1730
"completed. pre_commit is called with (local, master, old_revno, "
1731
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1732
"). old_revid is NULL_REVISION for the first commit to a branch, "
1733
"tree_delta is a TreeDelta object describing changes from the "
1734
"basis revision. hooks MUST NOT modify this delta. "
1735
" future_tree is an in-memory tree obtained from "
1736
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1737
"tree.", (0,91), None))
1738
self.create_hook(HookPoint('post_commit',
1739
"Called in the bzr client after a commit has completed. "
1740
"post_commit is called with (local, master, old_revno, old_revid, "
1741
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1742
"commit to a branch.", (0, 15), None))
1743
self.create_hook(HookPoint('post_uncommit',
1744
"Called in the bzr client after an uncommit completes. "
1745
"post_uncommit is called with (local, master, old_revno, "
1746
"old_revid, new_revno, new_revid) where local is the local branch "
1747
"or None, master is the target branch, and an empty branch "
1748
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1749
self.create_hook(HookPoint('pre_change_branch_tip',
1750
"Called in bzr client and server before a change to the tip of a "
1751
"branch is made. pre_change_branch_tip is called with a "
1752
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1753
"commit, uncommit will all trigger this hook.", (1, 6), None))
1754
self.create_hook(HookPoint('post_change_branch_tip',
1755
"Called in bzr client and server after a change to the tip of a "
1756
"branch is made. post_change_branch_tip is called with a "
1757
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1758
"commit, uncommit will all trigger this hook.", (1, 4), None))
1759
self.create_hook(HookPoint('transform_fallback_location',
1760
"Called when a stacked branch is activating its fallback "
1761
"locations. transform_fallback_location is called with (branch, "
1762
"url), and should return a new url. Returning the same url "
1763
"allows it to be used as-is, returning a different one can be "
1764
"used to cause the branch to stack on a closer copy of that "
1765
"fallback_location. Note that the branch cannot have history "
1766
"accessing methods called on it during this hook because the "
1767
"fallback locations have not been activated. When there are "
1768
"multiple hooks installed for transform_fallback_location, "
1769
"all are called with the url returned from the previous hook."
1770
"The order is however undefined.", (1, 9), None))
1771
self.create_hook(HookPoint('automatic_tag_name',
1772
"Called to determine an automatic tag name for a revision."
1773
"automatic_tag_name is called with (branch, revision_id) and "
1774
"should return a tag name or None if no tag name could be "
1775
"determined. The first non-None tag name returned will be used.",
1777
self.create_hook(HookPoint('post_branch_init',
1778
"Called after new branch initialization completes. "
1779
"post_branch_init is called with a "
1780
"bzrlib.branch.BranchInitHookParams. "
1781
"Note that init, branch and checkout (both heavyweight and "
1782
"lightweight) will all trigger this hook.", (2, 2), None))
1783
self.create_hook(HookPoint('post_switch',
1784
"Called after a checkout switches branch. "
1785
"post_switch is called with a "
1786
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1790
# install the default hooks into the Branch class.
1791
Branch.hooks = BranchHooks()
1794
class ChangeBranchTipParams(object):
1795
"""Object holding parameters passed to *_change_branch_tip hooks.
1797
There are 5 fields that hooks may wish to access:
1799
:ivar branch: the branch being changed
1800
:ivar old_revno: revision number before the change
1801
:ivar new_revno: revision number after the change
1802
:ivar old_revid: revision id before the change
1803
:ivar new_revid: revision id after the change
1805
The revid fields are strings. The revno fields are integers.
1808
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1809
"""Create a group of ChangeBranchTip parameters.
1811
:param branch: The branch being changed.
1812
:param old_revno: Revision number before the change.
1813
:param new_revno: Revision number after the change.
1814
:param old_revid: Tip revision id before the change.
1815
:param new_revid: Tip revision id after the change.
1817
self.branch = branch
1818
self.old_revno = old_revno
1819
self.new_revno = new_revno
1820
self.old_revid = old_revid
1821
self.new_revid = new_revid
1823
def __eq__(self, other):
1824
return self.__dict__ == other.__dict__
1827
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1828
self.__class__.__name__, self.branch,
1829
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1832
class BranchInitHookParams(object):
1833
"""Object holding parameters passed to *_branch_init hooks.
1835
There are 4 fields that hooks may wish to access:
1837
:ivar format: the branch format
1838
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1839
:ivar name: name of colocated branch, if any (or None)
1840
:ivar branch: the branch created
1842
Note that for lightweight checkouts, the bzrdir and format fields refer to
1843
the checkout, hence they are different from the corresponding fields in
1844
branch, which refer to the original branch.
1847
def __init__(self, format, a_bzrdir, name, branch):
1848
"""Create a group of BranchInitHook parameters.
1850
:param format: the branch format
1851
:param a_bzrdir: the BzrDir where the branch will be/has been
1853
:param name: name of colocated branch, if any (or None)
1854
:param branch: the branch created
1856
Note that for lightweight checkouts, the bzrdir and format fields refer
1857
to the checkout, hence they are different from the corresponding fields
1858
in branch, which refer to the original branch.
1860
self.format = format
1861
self.bzrdir = a_bzrdir
1863
self.branch = branch
1865
def __eq__(self, other):
1866
return self.__dict__ == other.__dict__
1870
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1872
return "<%s of format:%s bzrdir:%s>" % (
1873
self.__class__.__name__, self.branch,
1874
self.format, self.bzrdir)
1877
class SwitchHookParams(object):
1878
"""Object holding parameters passed to *_switch hooks.
1880
There are 4 fields that hooks may wish to access:
1882
:ivar control_dir: BzrDir of the checkout to change
1883
:ivar to_branch: branch that the checkout is to reference
1884
:ivar force: skip the check for local commits in a heavy checkout
1885
:ivar revision_id: revision ID to switch to (or None)
1888
def __init__(self, control_dir, to_branch, force, revision_id):
1889
"""Create a group of SwitchHook parameters.
1891
:param control_dir: BzrDir of the checkout to change
1892
:param to_branch: branch that the checkout is to reference
1893
:param force: skip the check for local commits in a heavy checkout
1894
:param revision_id: revision ID to switch to (or None)
1896
self.control_dir = control_dir
1897
self.to_branch = to_branch
1899
self.revision_id = revision_id
1901
def __eq__(self, other):
1902
return self.__dict__ == other.__dict__
1905
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1906
self.control_dir, self.to_branch,
1910
class BzrBranchFormat4(BranchFormat):
1911
"""Bzr branch format 4.
1914
- a revision-history file.
1915
- a branch-lock lock file [ to be shared with the bzrdir ]
1918
def get_format_description(self):
1919
"""See BranchFormat.get_format_description()."""
1920
return "Branch format 4"
1922
def initialize(self, a_bzrdir, name=None):
1923
"""Create a branch of this format in a_bzrdir."""
1924
utf8_files = [('revision-history', ''),
1925
('branch-name', ''),
1927
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1928
lock_type='branch4', set_format=False)
1931
super(BzrBranchFormat4, self).__init__()
1932
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1934
def network_name(self):
1935
"""The network name for this format is the control dirs disk label."""
1936
return self._matchingbzrdir.get_format_string()
1938
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1939
"""See BranchFormat.open()."""
1941
# we are being called directly and must probe.
1942
raise NotImplementedError
1943
return BzrBranch(_format=self,
1944
_control_files=a_bzrdir._control_files,
1947
_repository=a_bzrdir.open_repository())
1950
return "Bazaar-NG branch format 4"
1953
class BranchFormatMetadir(BranchFormat):
1954
"""Common logic for meta-dir based branch formats."""
1956
def _branch_class(self):
1957
"""What class to instantiate on open calls."""
1958
raise NotImplementedError(self._branch_class)
1960
def network_name(self):
1961
"""A simple byte string uniquely identifying this format for RPC calls.
1963
Metadir branch formats use their format string.
1965
return self.get_format_string()
1967
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1968
"""See BranchFormat.open()."""
1970
format = BranchFormat.find_format(a_bzrdir, name=name)
1971
if format.__class__ != self.__class__:
1972
raise AssertionError("wrong format %r found for %r" %
1975
transport = a_bzrdir.get_branch_transport(None, name=name)
1976
control_files = lockable_files.LockableFiles(transport, 'lock',
1978
return self._branch_class()(_format=self,
1979
_control_files=control_files,
1982
_repository=a_bzrdir.find_repository(),
1983
ignore_fallbacks=ignore_fallbacks)
1984
except errors.NoSuchFile:
1985
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1988
super(BranchFormatMetadir, self).__init__()
1989
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1990
self._matchingbzrdir.set_branch_format(self)
1992
def supports_tags(self):
1996
class BzrBranchFormat5(BranchFormatMetadir):
1997
"""Bzr branch format 5.
2000
- a revision-history file.
2002
- a lock dir guarding the branch itself
2003
- all of this stored in a branch/ subdirectory
2004
- works with shared repositories.
2006
This format is new in bzr 0.8.
2009
def _branch_class(self):
2012
def get_format_string(self):
2013
"""See BranchFormat.get_format_string()."""
2014
return "Bazaar-NG branch format 5\n"
2016
def get_format_description(self):
2017
"""See BranchFormat.get_format_description()."""
2018
return "Branch format 5"
2020
def initialize(self, a_bzrdir, name=None):
2021
"""Create a branch of this format in a_bzrdir."""
2022
utf8_files = [('revision-history', ''),
2023
('branch-name', ''),
2025
return self._initialize_helper(a_bzrdir, utf8_files, name)
2027
def supports_tags(self):
2031
class BzrBranchFormat6(BranchFormatMetadir):
2032
"""Branch format with last-revision and tags.
2034
Unlike previous formats, this has no explicit revision history. Instead,
2035
this just stores the last-revision, and the left-hand history leading
2036
up to there is the history.
2038
This format was introduced in bzr 0.15
2039
and became the default in 0.91.
2042
def _branch_class(self):
2045
def get_format_string(self):
2046
"""See BranchFormat.get_format_string()."""
2047
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2049
def get_format_description(self):
2050
"""See BranchFormat.get_format_description()."""
2051
return "Branch format 6"
2053
def initialize(self, a_bzrdir, name=None):
2054
"""Create a branch of this format in a_bzrdir."""
2055
utf8_files = [('last-revision', '0 null:\n'),
2056
('branch.conf', ''),
2059
return self._initialize_helper(a_bzrdir, utf8_files, name)
2061
def make_tags(self, branch):
2062
"""See bzrlib.branch.BranchFormat.make_tags()."""
2063
return BasicTags(branch)
2065
def supports_set_append_revisions_only(self):
2069
class BzrBranchFormat8(BranchFormatMetadir):
2070
"""Metadir format supporting storing locations of subtree branches."""
2072
def _branch_class(self):
2075
def get_format_string(self):
2076
"""See BranchFormat.get_format_string()."""
2077
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2079
def get_format_description(self):
2080
"""See BranchFormat.get_format_description()."""
2081
return "Branch format 8"
2083
def initialize(self, a_bzrdir, name=None):
2084
"""Create a branch of this format in a_bzrdir."""
2085
utf8_files = [('last-revision', '0 null:\n'),
2086
('branch.conf', ''),
2090
return self._initialize_helper(a_bzrdir, utf8_files, name)
2093
super(BzrBranchFormat8, self).__init__()
2094
self._matchingbzrdir.repository_format = \
2095
RepositoryFormatKnitPack5RichRoot()
2097
def make_tags(self, branch):
2098
"""See bzrlib.branch.BranchFormat.make_tags()."""
2099
return BasicTags(branch)
2101
def supports_set_append_revisions_only(self):
2104
def supports_stacking(self):
2107
supports_reference_locations = True
2110
class BzrBranchFormat7(BzrBranchFormat8):
2111
"""Branch format with last-revision, tags, and a stacked location pointer.
2113
The stacked location pointer is passed down to the repository and requires
2114
a repository format with supports_external_lookups = True.
2116
This format was introduced in bzr 1.6.
2119
def initialize(self, a_bzrdir, name=None):
2120
"""Create a branch of this format in a_bzrdir."""
2121
utf8_files = [('last-revision', '0 null:\n'),
2122
('branch.conf', ''),
2125
return self._initialize_helper(a_bzrdir, utf8_files, name)
2127
def _branch_class(self):
2130
def get_format_string(self):
2131
"""See BranchFormat.get_format_string()."""
2132
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2134
def get_format_description(self):
2135
"""See BranchFormat.get_format_description()."""
2136
return "Branch format 7"
2138
def supports_set_append_revisions_only(self):
2141
supports_reference_locations = False
2144
class BranchReferenceFormat(BranchFormat):
2145
"""Bzr branch reference format.
2147
Branch references are used in implementing checkouts, they
2148
act as an alias to the real branch which is at some other url.
2155
def get_format_string(self):
2156
"""See BranchFormat.get_format_string()."""
2157
return "Bazaar-NG Branch Reference Format 1\n"
2159
def get_format_description(self):
2160
"""See BranchFormat.get_format_description()."""
2161
return "Checkout reference format 1"
2163
def get_reference(self, a_bzrdir):
2164
"""See BranchFormat.get_reference()."""
2165
transport = a_bzrdir.get_branch_transport(None)
2166
return transport.get_bytes('location')
2168
def set_reference(self, a_bzrdir, to_branch):
2169
"""See BranchFormat.set_reference()."""
2170
transport = a_bzrdir.get_branch_transport(None)
2171
location = transport.put_bytes('location', to_branch.base)
2173
def initialize(self, a_bzrdir, name=None, target_branch=None):
2174
"""Create a branch of this format in a_bzrdir."""
2175
if target_branch is None:
2176
# this format does not implement branch itself, thus the implicit
2177
# creation contract must see it as uninitializable
2178
raise errors.UninitializableFormat(self)
2179
mutter('creating branch reference in %s', a_bzrdir.transport.base)
2180
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2181
branch_transport.put_bytes('location',
2182
target_branch.bzrdir.root_transport.base)
2183
branch_transport.put_bytes('format', self.get_format_string())
2185
a_bzrdir, name, _found=True,
2186
possible_transports=[target_branch.bzrdir.root_transport])
2187
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2191
super(BranchReferenceFormat, self).__init__()
2192
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2193
self._matchingbzrdir.set_branch_format(self)
2195
def _make_reference_clone_function(format, a_branch):
2196
"""Create a clone() routine for a branch dynamically."""
2197
def clone(to_bzrdir, revision_id=None,
2198
repository_policy=None):
2199
"""See Branch.clone()."""
2200
return format.initialize(to_bzrdir, target_branch=a_branch)
2201
# cannot obey revision_id limits when cloning a reference ...
2202
# FIXME RBC 20060210 either nuke revision_id for clone, or
2203
# emit some sort of warning/error to the caller ?!
2206
def open(self, a_bzrdir, name=None, _found=False, location=None,
2207
possible_transports=None, ignore_fallbacks=False):
2208
"""Return the branch that the branch reference in a_bzrdir points at.
2210
:param a_bzrdir: A BzrDir that contains a branch.
2211
:param name: Name of colocated branch to open, if any
2212
:param _found: a private parameter, do not use it. It is used to
2213
indicate if format probing has already be done.
2214
:param ignore_fallbacks: when set, no fallback branches will be opened
2215
(if there are any). Default is to open fallbacks.
2216
:param location: The location of the referenced branch. If
2217
unspecified, this will be determined from the branch reference in
2219
:param possible_transports: An optional reusable transports list.
2222
format = BranchFormat.find_format(a_bzrdir, name=name)
2223
if format.__class__ != self.__class__:
2224
raise AssertionError("wrong format %r found for %r" %
2226
if location is None:
2227
location = self.get_reference(a_bzrdir)
2228
real_bzrdir = bzrdir.BzrDir.open(
2229
location, possible_transports=possible_transports)
2230
result = real_bzrdir.open_branch(name=name,
2231
ignore_fallbacks=ignore_fallbacks)
2232
# this changes the behaviour of result.clone to create a new reference
2233
# rather than a copy of the content of the branch.
2234
# I did not use a proxy object because that needs much more extensive
2235
# testing, and we are only changing one behaviour at the moment.
2236
# If we decide to alter more behaviours - i.e. the implicit nickname
2237
# then this should be refactored to introduce a tested proxy branch
2238
# and a subclass of that for use in overriding clone() and ....
2240
result.clone = self._make_reference_clone_function(result)
2244
network_format_registry = registry.FormatRegistry()
2245
"""Registry of formats indexed by their network name.
2247
The network name for a branch format is an identifier that can be used when
2248
referring to formats with smart server operations. See
2249
BranchFormat.network_name() for more detail.
2253
# formats which have no format string are not discoverable
2254
# and not independently creatable, so are not registered.
2255
__format5 = BzrBranchFormat5()
2256
__format6 = BzrBranchFormat6()
2257
__format7 = BzrBranchFormat7()
2258
__format8 = BzrBranchFormat8()
2259
BranchFormat.register_format(__format5)
2260
BranchFormat.register_format(BranchReferenceFormat())
2261
BranchFormat.register_format(__format6)
2262
BranchFormat.register_format(__format7)
2263
BranchFormat.register_format(__format8)
2264
BranchFormat.set_default_format(__format7)
2265
_legacy_formats = [BzrBranchFormat4(),
2267
network_format_registry.register(
2268
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2271
class BzrBranch(Branch, _RelockDebugMixin):
2272
"""A branch stored in the actual filesystem.
2274
Note that it's "local" in the context of the filesystem; it doesn't
2275
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2276
it's writable, and can be accessed via the normal filesystem API.
2278
:ivar _transport: Transport for file operations on this branch's
2279
control files, typically pointing to the .bzr/branch directory.
2280
:ivar repository: Repository for this branch.
2281
:ivar base: The url of the base directory for this branch; the one
2282
containing the .bzr directory.
2283
:ivar name: Optional colocated branch name as it exists in the control
2287
def __init__(self, _format=None,
2288
_control_files=None, a_bzrdir=None, name=None,
2289
_repository=None, ignore_fallbacks=False):
2290
"""Create new branch object at a particular location."""
2291
if a_bzrdir is None:
2292
raise ValueError('a_bzrdir must be supplied')
2294
self.bzrdir = a_bzrdir
2295
self._base = self.bzrdir.transport.clone('..').base
2297
# XXX: We should be able to just do
2298
# self.base = self.bzrdir.root_transport.base
2299
# but this does not quite work yet -- mbp 20080522
2300
self._format = _format
2301
if _control_files is None:
2302
raise ValueError('BzrBranch _control_files is None')
2303
self.control_files = _control_files
2304
self._transport = _control_files._transport
2305
self.repository = _repository
2306
Branch.__init__(self)
2309
if self.name is None:
2310
return '%s(%r)' % (self.__class__.__name__, self.base)
2312
return '%s(%r,%r)' % (self.__class__.__name__, self.base, self.name)
2316
def _get_base(self):
2317
"""Returns the directory containing the control directory."""
2320
base = property(_get_base, doc="The URL for the root of this branch.")
2322
def _get_config(self):
2323
return TransportConfig(self._transport, 'branch.conf')
2325
def is_locked(self):
2326
return self.control_files.is_locked()
2328
def lock_write(self, token=None):
2329
if not self.is_locked():
2330
self._note_lock('w')
2331
# All-in-one needs to always unlock/lock.
2332
repo_control = getattr(self.repository, 'control_files', None)
2333
if self.control_files == repo_control or not self.is_locked():
2334
self.repository._warn_if_deprecated(self)
2335
self.repository.lock_write()
2340
return self.control_files.lock_write(token=token)
2343
self.repository.unlock()
2346
def lock_read(self):
2347
if not self.is_locked():
2348
self._note_lock('r')
2349
# All-in-one needs to always unlock/lock.
2350
repo_control = getattr(self.repository, 'control_files', None)
2351
if self.control_files == repo_control or not self.is_locked():
2352
self.repository._warn_if_deprecated(self)
2353
self.repository.lock_read()
2358
self.control_files.lock_read()
2361
self.repository.unlock()
2364
@only_raises(errors.LockNotHeld, errors.LockBroken)
2367
self.control_files.unlock()
2369
# All-in-one needs to always unlock/lock.
2370
repo_control = getattr(self.repository, 'control_files', None)
2371
if (self.control_files == repo_control or
2372
not self.control_files.is_locked()):
2373
self.repository.unlock()
2374
if not self.control_files.is_locked():
2375
# we just released the lock
2376
self._clear_cached_state()
2378
def peek_lock_mode(self):
2379
if self.control_files._lock_count == 0:
2382
return self.control_files._lock_mode
2384
def get_physical_lock_status(self):
2385
return self.control_files.get_physical_lock_status()
2388
def print_file(self, file, revision_id):
2389
"""See Branch.print_file."""
2390
return self.repository.print_file(file, revision_id)
2392
def _write_revision_history(self, history):
2393
"""Factored out of set_revision_history.
2395
This performs the actual writing to disk.
2396
It is intended to be called by BzrBranch5.set_revision_history."""
2397
self._transport.put_bytes(
2398
'revision-history', '\n'.join(history),
2399
mode=self.bzrdir._get_file_mode())
2402
def set_revision_history(self, rev_history):
2403
"""See Branch.set_revision_history."""
2404
if 'evil' in debug.debug_flags:
2405
mutter_callsite(3, "set_revision_history scales with history.")
2406
check_not_reserved_id = _mod_revision.check_not_reserved_id
2407
for rev_id in rev_history:
2408
check_not_reserved_id(rev_id)
2409
if Branch.hooks['post_change_branch_tip']:
2410
# Don't calculate the last_revision_info() if there are no hooks
2412
old_revno, old_revid = self.last_revision_info()
2413
if len(rev_history) == 0:
2414
revid = _mod_revision.NULL_REVISION
2416
revid = rev_history[-1]
2417
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2418
self._write_revision_history(rev_history)
2419
self._clear_cached_state()
2420
self._cache_revision_history(rev_history)
2421
for hook in Branch.hooks['set_rh']:
2422
hook(self, rev_history)
2423
if Branch.hooks['post_change_branch_tip']:
2424
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2426
def _synchronize_history(self, destination, revision_id):
2427
"""Synchronize last revision and revision history between branches.
2429
This version is most efficient when the destination is also a
2430
BzrBranch5, but works for BzrBranch6 as long as the revision
2431
history is the true lefthand parent history, and all of the revisions
2432
are in the destination's repository. If not, set_revision_history
2435
:param destination: The branch to copy the history into
2436
:param revision_id: The revision-id to truncate history at. May
2437
be None to copy complete history.
2439
if not isinstance(destination._format, BzrBranchFormat5):
2440
super(BzrBranch, self)._synchronize_history(
2441
destination, revision_id)
2443
if revision_id == _mod_revision.NULL_REVISION:
2446
new_history = self.revision_history()
2447
if revision_id is not None and new_history != []:
2449
new_history = new_history[:new_history.index(revision_id) + 1]
2451
rev = self.repository.get_revision(revision_id)
2452
new_history = rev.get_history(self.repository)[1:]
2453
destination.set_revision_history(new_history)
2456
def set_last_revision_info(self, revno, revision_id):
2457
"""Set the last revision of this branch.
2459
The caller is responsible for checking that the revno is correct
2460
for this revision id.
2462
It may be possible to set the branch last revision to an id not
2463
present in the repository. However, branches can also be
2464
configured to check constraints on history, in which case this may not
2467
revision_id = _mod_revision.ensure_null(revision_id)
2468
# this old format stores the full history, but this api doesn't
2469
# provide it, so we must generate, and might as well check it's
2471
history = self._lefthand_history(revision_id)
2472
if len(history) != revno:
2473
raise AssertionError('%d != %d' % (len(history), revno))
2474
self.set_revision_history(history)
2476
def _gen_revision_history(self):
2477
history = self._transport.get_bytes('revision-history').split('\n')
2478
if history[-1:] == ['']:
2479
# There shouldn't be a trailing newline, but just in case.
2484
def generate_revision_history(self, revision_id, last_rev=None,
2486
"""Create a new revision history that will finish with revision_id.
2488
:param revision_id: the new tip to use.
2489
:param last_rev: The previous last_revision. If not None, then this
2490
must be a ancestory of revision_id, or DivergedBranches is raised.
2491
:param other_branch: The other branch that DivergedBranches should
2492
raise with respect to.
2494
self.set_revision_history(self._lefthand_history(revision_id,
2495
last_rev, other_branch))
2497
def basis_tree(self):
2498
"""See Branch.basis_tree."""
2499
return self.repository.revision_tree(self.last_revision())
2501
def _get_parent_location(self):
2502
_locs = ['parent', 'pull', 'x-pull']
2505
return self._transport.get_bytes(l).strip('\n')
2506
except errors.NoSuchFile:
2510
def _basic_push(self, target, overwrite, stop_revision):
2511
"""Basic implementation of push without bound branches or hooks.
2513
Must be called with source read locked and target write locked.
2515
result = BranchPushResult()
2516
result.source_branch = self
2517
result.target_branch = target
2518
result.old_revno, result.old_revid = target.last_revision_info()
2519
self.update_references(target)
2520
if result.old_revid != self.last_revision():
2521
# We assume that during 'push' this repository is closer than
2523
graph = self.repository.get_graph(target.repository)
2524
target.update_revisions(self, stop_revision,
2525
overwrite=overwrite, graph=graph)
2526
if self._push_should_merge_tags():
2527
result.tag_conflicts = self.tags.merge_to(target.tags,
2529
result.new_revno, result.new_revid = target.last_revision_info()
2532
def get_stacked_on_url(self):
2533
raise errors.UnstackableBranchFormat(self._format, self.base)
2535
def set_push_location(self, location):
2536
"""See Branch.set_push_location."""
2537
self.get_config().set_user_option(
2538
'push_location', location,
2539
store=_mod_config.STORE_LOCATION_NORECURSE)
2541
def _set_parent_location(self, url):
2543
self._transport.delete('parent')
2545
self._transport.put_bytes('parent', url + '\n',
2546
mode=self.bzrdir._get_file_mode())
2549
class BzrBranch5(BzrBranch):
2550
"""A format 5 branch. This supports new features over plain branches.
2552
It has support for a master_branch which is the data for bound branches.
2555
def get_bound_location(self):
2557
return self._transport.get_bytes('bound')[:-1]
2558
except errors.NoSuchFile:
2562
def get_master_branch(self, possible_transports=None):
2563
"""Return the branch we are bound to.
2565
:return: Either a Branch, or None
2567
This could memoise the branch, but if thats done
2568
it must be revalidated on each new lock.
2569
So for now we just don't memoise it.
2570
# RBC 20060304 review this decision.
2572
bound_loc = self.get_bound_location()
2576
return Branch.open(bound_loc,
2577
possible_transports=possible_transports)
2578
except (errors.NotBranchError, errors.ConnectionError), e:
2579
raise errors.BoundBranchConnectionFailure(
2583
def set_bound_location(self, location):
2584
"""Set the target where this branch is bound to.
2586
:param location: URL to the target branch
2589
self._transport.put_bytes('bound', location+'\n',
2590
mode=self.bzrdir._get_file_mode())
2593
self._transport.delete('bound')
2594
except errors.NoSuchFile:
2599
def bind(self, other):
2600
"""Bind this branch to the branch other.
2602
This does not push or pull data between the branches, though it does
2603
check for divergence to raise an error when the branches are not
2604
either the same, or one a prefix of the other. That behaviour may not
2605
be useful, so that check may be removed in future.
2607
:param other: The branch to bind to
2610
# TODO: jam 20051230 Consider checking if the target is bound
2611
# It is debatable whether you should be able to bind to
2612
# a branch which is itself bound.
2613
# Committing is obviously forbidden,
2614
# but binding itself may not be.
2615
# Since we *have* to check at commit time, we don't
2616
# *need* to check here
2618
# we want to raise diverged if:
2619
# last_rev is not in the other_last_rev history, AND
2620
# other_last_rev is not in our history, and do it without pulling
2622
self.set_bound_location(other.base)
2626
"""If bound, unbind"""
2627
return self.set_bound_location(None)
2630
def update(self, possible_transports=None):
2631
"""Synchronise this branch with the master branch if any.
2633
:return: None or the last_revision that was pivoted out during the
2636
master = self.get_master_branch(possible_transports)
2637
if master is not None:
2638
old_tip = _mod_revision.ensure_null(self.last_revision())
2639
self.pull(master, overwrite=True)
2640
if self.repository.get_graph().is_ancestor(old_tip,
2641
_mod_revision.ensure_null(self.last_revision())):
2647
class BzrBranch8(BzrBranch5):
2648
"""A branch that stores tree-reference locations."""
2650
def _open_hook(self):
2651
if self._ignore_fallbacks:
2654
url = self.get_stacked_on_url()
2655
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2656
errors.UnstackableBranchFormat):
2659
for hook in Branch.hooks['transform_fallback_location']:
2660
url = hook(self, url)
2662
hook_name = Branch.hooks.get_hook_name(hook)
2663
raise AssertionError(
2664
"'transform_fallback_location' hook %s returned "
2665
"None, not a URL." % hook_name)
2666
self._activate_fallback_location(url)
2668
def __init__(self, *args, **kwargs):
2669
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2670
super(BzrBranch8, self).__init__(*args, **kwargs)
2671
self._last_revision_info_cache = None
2672
self._reference_info = None
2674
def _clear_cached_state(self):
2675
super(BzrBranch8, self)._clear_cached_state()
2676
self._last_revision_info_cache = None
2677
self._reference_info = None
2679
def _last_revision_info(self):
2680
revision_string = self._transport.get_bytes('last-revision')
2681
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2682
revision_id = cache_utf8.get_cached_utf8(revision_id)
2684
return revno, revision_id
2686
def _write_last_revision_info(self, revno, revision_id):
2687
"""Simply write out the revision id, with no checks.
2689
Use set_last_revision_info to perform this safely.
2691
Does not update the revision_history cache.
2692
Intended to be called by set_last_revision_info and
2693
_write_revision_history.
2695
revision_id = _mod_revision.ensure_null(revision_id)
2696
out_string = '%d %s\n' % (revno, revision_id)
2697
self._transport.put_bytes('last-revision', out_string,
2698
mode=self.bzrdir._get_file_mode())
2701
def set_last_revision_info(self, revno, revision_id):
2702
revision_id = _mod_revision.ensure_null(revision_id)
2703
old_revno, old_revid = self.last_revision_info()
2704
if self._get_append_revisions_only():
2705
self._check_history_violation(revision_id)
2706
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2707
self._write_last_revision_info(revno, revision_id)
2708
self._clear_cached_state()
2709
self._last_revision_info_cache = revno, revision_id
2710
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2712
def _synchronize_history(self, destination, revision_id):
2713
"""Synchronize last revision and revision history between branches.
2715
:see: Branch._synchronize_history
2717
# XXX: The base Branch has a fast implementation of this method based
2718
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2719
# that uses set_revision_history. This class inherits from BzrBranch5,
2720
# but wants the fast implementation, so it calls
2721
# Branch._synchronize_history directly.
2722
Branch._synchronize_history(self, destination, revision_id)
2724
def _check_history_violation(self, revision_id):
2725
last_revision = _mod_revision.ensure_null(self.last_revision())
2726
if _mod_revision.is_null(last_revision):
2728
if last_revision not in self._lefthand_history(revision_id):
2729
raise errors.AppendRevisionsOnlyViolation(self.base)
2731
def _gen_revision_history(self):
2732
"""Generate the revision history from last revision
2734
last_revno, last_revision = self.last_revision_info()
2735
self._extend_partial_history(stop_index=last_revno-1)
2736
return list(reversed(self._partial_revision_history_cache))
2738
def _write_revision_history(self, history):
2739
"""Factored out of set_revision_history.
2741
This performs the actual writing to disk, with format-specific checks.
2742
It is intended to be called by BzrBranch5.set_revision_history.
2744
if len(history) == 0:
2745
last_revision = 'null:'
2747
if history != self._lefthand_history(history[-1]):
2748
raise errors.NotLefthandHistory(history)
2749
last_revision = history[-1]
2750
if self._get_append_revisions_only():
2751
self._check_history_violation(last_revision)
2752
self._write_last_revision_info(len(history), last_revision)
2755
def _set_parent_location(self, url):
2756
"""Set the parent branch"""
2757
self._set_config_location('parent_location', url, make_relative=True)
2760
def _get_parent_location(self):
2761
"""Set the parent branch"""
2762
return self._get_config_location('parent_location')
2765
def _set_all_reference_info(self, info_dict):
2766
"""Replace all reference info stored in a branch.
2768
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2771
writer = rio.RioWriter(s)
2772
for key, (tree_path, branch_location) in info_dict.iteritems():
2773
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2774
branch_location=branch_location)
2775
writer.write_stanza(stanza)
2776
self._transport.put_bytes('references', s.getvalue())
2777
self._reference_info = info_dict
2780
def _get_all_reference_info(self):
2781
"""Return all the reference info stored in a branch.
2783
:return: A dict of {file_id: (tree_path, branch_location)}
2785
if self._reference_info is not None:
2786
return self._reference_info
2787
rio_file = self._transport.get('references')
2789
stanzas = rio.read_stanzas(rio_file)
2790
info_dict = dict((s['file_id'], (s['tree_path'],
2791
s['branch_location'])) for s in stanzas)
2794
self._reference_info = info_dict
2797
def set_reference_info(self, file_id, tree_path, branch_location):
2798
"""Set the branch location to use for a tree reference.
2800
:param file_id: The file-id of the tree reference.
2801
:param tree_path: The path of the tree reference in the tree.
2802
:param branch_location: The location of the branch to retrieve tree
2805
info_dict = self._get_all_reference_info()
2806
info_dict[file_id] = (tree_path, branch_location)
2807
if None in (tree_path, branch_location):
2808
if tree_path is not None:
2809
raise ValueError('tree_path must be None when branch_location'
2811
if branch_location is not None:
2812
raise ValueError('branch_location must be None when tree_path'
2814
del info_dict[file_id]
2815
self._set_all_reference_info(info_dict)
2817
def get_reference_info(self, file_id):
2818
"""Get the tree_path and branch_location for a tree reference.
2820
:return: a tuple of (tree_path, branch_location)
2822
return self._get_all_reference_info().get(file_id, (None, None))
2824
def reference_parent(self, file_id, path, possible_transports=None):
2825
"""Return the parent branch for a tree-reference file_id.
2827
:param file_id: The file_id of the tree reference
2828
:param path: The path of the file_id in the tree
2829
:return: A branch associated with the file_id
2831
branch_location = self.get_reference_info(file_id)[1]
2832
if branch_location is None:
2833
return Branch.reference_parent(self, file_id, path,
2834
possible_transports)
2835
branch_location = urlutils.join(self.base, branch_location)
2836
return Branch.open(branch_location,
2837
possible_transports=possible_transports)
2839
def set_push_location(self, location):
2840
"""See Branch.set_push_location."""
2841
self._set_config_location('push_location', location)
2843
def set_bound_location(self, location):
2844
"""See Branch.set_push_location."""
2846
config = self.get_config()
2847
if location is None:
2848
if config.get_user_option('bound') != 'True':
2851
config.set_user_option('bound', 'False', warn_masked=True)
2854
self._set_config_location('bound_location', location,
2856
config.set_user_option('bound', 'True', warn_masked=True)
2859
def _get_bound_location(self, bound):
2860
"""Return the bound location in the config file.
2862
Return None if the bound parameter does not match"""
2863
config = self.get_config()
2864
config_bound = (config.get_user_option('bound') == 'True')
2865
if config_bound != bound:
2867
return self._get_config_location('bound_location', config=config)
2869
def get_bound_location(self):
2870
"""See Branch.set_push_location."""
2871
return self._get_bound_location(True)
2873
def get_old_bound_location(self):
2874
"""See Branch.get_old_bound_location"""
2875
return self._get_bound_location(False)
2877
def get_stacked_on_url(self):
2878
# you can always ask for the URL; but you might not be able to use it
2879
# if the repo can't support stacking.
2880
## self._check_stackable_repo()
2881
stacked_url = self._get_config_location('stacked_on_location')
2882
if stacked_url is None:
2883
raise errors.NotStacked(self)
2886
def _get_append_revisions_only(self):
2887
return self.get_config(
2888
).get_user_option_as_bool('append_revisions_only')
2891
def generate_revision_history(self, revision_id, last_rev=None,
2893
"""See BzrBranch5.generate_revision_history"""
2894
history = self._lefthand_history(revision_id, last_rev, other_branch)
2895
revno = len(history)
2896
self.set_last_revision_info(revno, revision_id)
2899
def get_rev_id(self, revno, history=None):
2900
"""Find the revision id of the specified revno."""
2902
return _mod_revision.NULL_REVISION
2904
last_revno, last_revision_id = self.last_revision_info()
2905
if revno <= 0 or revno > last_revno:
2906
raise errors.NoSuchRevision(self, revno)
2908
if history is not None:
2909
return history[revno - 1]
2911
index = last_revno - revno
2912
if len(self._partial_revision_history_cache) <= index:
2913
self._extend_partial_history(stop_index=index)
2914
if len(self._partial_revision_history_cache) > index:
2915
return self._partial_revision_history_cache[index]
2917
raise errors.NoSuchRevision(self, revno)
2920
def revision_id_to_revno(self, revision_id):
2921
"""Given a revision id, return its revno"""
2922
if _mod_revision.is_null(revision_id):
2925
index = self._partial_revision_history_cache.index(revision_id)
2927
self._extend_partial_history(stop_revision=revision_id)
2928
index = len(self._partial_revision_history_cache) - 1
2929
if self._partial_revision_history_cache[index] != revision_id:
2930
raise errors.NoSuchRevision(self, revision_id)
2931
return self.revno() - index
2934
class BzrBranch7(BzrBranch8):
2935
"""A branch with support for a fallback repository."""
2937
def set_reference_info(self, file_id, tree_path, branch_location):
2938
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2940
def get_reference_info(self, file_id):
2941
Branch.get_reference_info(self, file_id)
2943
def reference_parent(self, file_id, path, possible_transports=None):
2944
return Branch.reference_parent(self, file_id, path,
2945
possible_transports)
2948
class BzrBranch6(BzrBranch7):
2949
"""See BzrBranchFormat6 for the capabilities of this branch.
2951
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2955
def get_stacked_on_url(self):
2956
raise errors.UnstackableBranchFormat(self._format, self.base)
2959
######################################################################
2960
# results of operations
2963
class _Result(object):
2965
def _show_tag_conficts(self, to_file):
2966
if not getattr(self, 'tag_conflicts', None):
2968
to_file.write('Conflicting tags:\n')
2969
for name, value1, value2 in self.tag_conflicts:
2970
to_file.write(' %s\n' % (name, ))
2973
class PullResult(_Result):
2974
"""Result of a Branch.pull operation.
2976
:ivar old_revno: Revision number before pull.
2977
:ivar new_revno: Revision number after pull.
2978
:ivar old_revid: Tip revision id before pull.
2979
:ivar new_revid: Tip revision id after pull.
2980
:ivar source_branch: Source (local) branch object. (read locked)
2981
:ivar master_branch: Master branch of the target, or the target if no
2983
:ivar local_branch: target branch if there is a Master, else None
2984
:ivar target_branch: Target/destination branch object. (write locked)
2985
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2989
# DEPRECATED: pull used to return the change in revno
2990
return self.new_revno - self.old_revno
2992
def report(self, to_file):
2994
if self.old_revid == self.new_revid:
2995
to_file.write('No revisions to pull.\n')
2997
to_file.write('Now on revision %d.\n' % self.new_revno)
2998
self._show_tag_conficts(to_file)
3001
class BranchPushResult(_Result):
3002
"""Result of a Branch.push operation.
3004
:ivar old_revno: Revision number (eg 10) of the target before push.
3005
:ivar new_revno: Revision number (eg 12) of the target after push.
3006
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3008
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3010
:ivar source_branch: Source branch object that the push was from. This is
3011
read locked, and generally is a local (and thus low latency) branch.
3012
:ivar master_branch: If target is a bound branch, the master branch of
3013
target, or target itself. Always write locked.
3014
:ivar target_branch: The direct Branch where data is being sent (write
3016
:ivar local_branch: If the target is a bound branch this will be the
3017
target, otherwise it will be None.
3021
# DEPRECATED: push used to return the change in revno
3022
return self.new_revno - self.old_revno
3024
def report(self, to_file):
3025
"""Write a human-readable description of the result."""
3026
if self.old_revid == self.new_revid:
3027
note('No new revisions to push.')
3029
note('Pushed up to revision %d.' % self.new_revno)
3030
self._show_tag_conficts(to_file)
3033
class BranchCheckResult(object):
3034
"""Results of checking branch consistency.
3039
def __init__(self, branch):
3040
self.branch = branch
3043
def report_results(self, verbose):
3044
"""Report the check results via trace.note.
3046
:param verbose: Requests more detailed display of what was checked,
3049
note('checked branch %s format %s', self.branch.base,
3050
self.branch._format)
3051
for error in self.errors:
3052
note('found error:%s', error)
3055
class Converter5to6(object):
3056
"""Perform an in-place upgrade of format 5 to format 6"""
3058
def convert(self, branch):
3059
# Data for 5 and 6 can peacefully coexist.
3060
format = BzrBranchFormat6()
3061
new_branch = format.open(branch.bzrdir, _found=True)
3063
# Copy source data into target
3064
new_branch._write_last_revision_info(*branch.last_revision_info())
3065
new_branch.set_parent(branch.get_parent())
3066
new_branch.set_bound_location(branch.get_bound_location())
3067
new_branch.set_push_location(branch.get_push_location())
3069
# New branch has no tags by default
3070
new_branch.tags._set_tag_dict({})
3072
# Copying done; now update target format
3073
new_branch._transport.put_bytes('format',
3074
format.get_format_string(),
3075
mode=new_branch.bzrdir._get_file_mode())
3077
# Clean up old files
3078
new_branch._transport.delete('revision-history')
3080
branch.set_parent(None)
3081
except errors.NoSuchFile:
3083
branch.set_bound_location(None)
3086
class Converter6to7(object):
3087
"""Perform an in-place upgrade of format 6 to format 7"""
3089
def convert(self, branch):
3090
format = BzrBranchFormat7()
3091
branch._set_config_location('stacked_on_location', '')
3092
# update target format
3093
branch._transport.put_bytes('format', format.get_format_string())
3096
class Converter7to8(object):
3097
"""Perform an in-place upgrade of format 6 to format 7"""
3099
def convert(self, branch):
3100
format = BzrBranchFormat8()
3101
branch._transport.put_bytes('references', '')
3102
# update target format
3103
branch._transport.put_bytes('format', format.get_format_string())
3106
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3107
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3110
_run_with_write_locked_target will attempt to release the lock it acquires.
3112
If an exception is raised by callable, then that exception *will* be
3113
propagated, even if the unlock attempt raises its own error. Thus
3114
_run_with_write_locked_target should be preferred to simply doing::
3118
return callable(*args, **kwargs)
3123
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3124
# should share code?
3127
result = callable(*args, **kwargs)
3129
exc_info = sys.exc_info()
3133
raise exc_info[0], exc_info[1], exc_info[2]
3139
class InterBranch(InterObject):
3140
"""This class represents operations taking place between two branches.
3142
Its instances have methods like pull() and push() and contain
3143
references to the source and target repositories these operations
3144
can be carried out on.
3148
"""The available optimised InterBranch types."""
3151
def _get_branch_formats_to_test():
3152
"""Return a tuple with the Branch formats to use when testing."""
3153
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3155
def pull(self, overwrite=False, stop_revision=None,
3156
possible_transports=None, local=False):
3157
"""Mirror source into target branch.
3159
The target branch is considered to be 'local', having low latency.
3161
:returns: PullResult instance
3163
raise NotImplementedError(self.pull)
3165
def update_revisions(self, stop_revision=None, overwrite=False,
3167
"""Pull in new perfect-fit revisions.
3169
:param stop_revision: Updated until the given revision
3170
:param overwrite: Always set the branch pointer, rather than checking
3171
to see if it is a proper descendant.
3172
:param graph: A Graph object that can be used to query history
3173
information. This can be None.
3176
raise NotImplementedError(self.update_revisions)
3178
def push(self, overwrite=False, stop_revision=None,
3179
_override_hook_source_branch=None):
3180
"""Mirror the source branch into the target branch.
3182
The source branch is considered to be 'local', having low latency.
3184
raise NotImplementedError(self.push)
3187
class GenericInterBranch(InterBranch):
3188
"""InterBranch implementation that uses public Branch functions.
3192
def _get_branch_formats_to_test():
3193
return BranchFormat._default_format, BranchFormat._default_format
3195
def update_revisions(self, stop_revision=None, overwrite=False,
3197
"""See InterBranch.update_revisions()."""
3198
self.source.lock_read()
3200
other_revno, other_last_revision = self.source.last_revision_info()
3201
stop_revno = None # unknown
3202
if stop_revision is None:
3203
stop_revision = other_last_revision
3204
if _mod_revision.is_null(stop_revision):
3205
# if there are no commits, we're done.
3207
stop_revno = other_revno
3209
# what's the current last revision, before we fetch [and change it
3211
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3212
# we fetch here so that we don't process data twice in the common
3213
# case of having something to pull, and so that the check for
3214
# already merged can operate on the just fetched graph, which will
3215
# be cached in memory.
3216
self.target.fetch(self.source, stop_revision)
3217
# Check to see if one is an ancestor of the other
3220
graph = self.target.repository.get_graph()
3221
if self.target._check_if_descendant_or_diverged(
3222
stop_revision, last_rev, graph, self.source):
3223
# stop_revision is a descendant of last_rev, but we aren't
3224
# overwriting, so we're done.
3226
if stop_revno is None:
3228
graph = self.target.repository.get_graph()
3229
this_revno, this_last_revision = \
3230
self.target.last_revision_info()
3231
stop_revno = graph.find_distance_to_null(stop_revision,
3232
[(other_last_revision, other_revno),
3233
(this_last_revision, this_revno)])
3234
self.target.set_last_revision_info(stop_revno, stop_revision)
3236
self.source.unlock()
3238
def pull(self, overwrite=False, stop_revision=None,
3239
possible_transports=None, _hook_master=None, run_hooks=True,
3240
_override_hook_target=None, local=False):
3243
:param _hook_master: Private parameter - set the branch to
3244
be supplied as the master to pull hooks.
3245
:param run_hooks: Private parameter - if false, this branch
3246
is being called because it's the master of the primary branch,
3247
so it should not run its hooks.
3248
:param _override_hook_target: Private parameter - set the branch to be
3249
supplied as the target_branch to pull hooks.
3250
:param local: Only update the local branch, and not the bound branch.
3252
# This type of branch can't be bound.
3254
raise errors.LocalRequiresBoundBranch()
3255
result = PullResult()
3256
result.source_branch = self.source
3257
if _override_hook_target is None:
3258
result.target_branch = self.target
3260
result.target_branch = _override_hook_target
3261
self.source.lock_read()
3263
# We assume that during 'pull' the target repository is closer than
3265
self.source.update_references(self.target)
3266
graph = self.target.repository.get_graph(self.source.repository)
3267
# TODO: Branch formats should have a flag that indicates
3268
# that revno's are expensive, and pull() should honor that flag.
3270
result.old_revno, result.old_revid = \
3271
self.target.last_revision_info()
3272
self.target.update_revisions(self.source, stop_revision,
3273
overwrite=overwrite, graph=graph)
3274
# TODO: The old revid should be specified when merging tags,
3275
# so a tags implementation that versions tags can only
3276
# pull in the most recent changes. -- JRV20090506
3277
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3279
result.new_revno, result.new_revid = self.target.last_revision_info()
3281
result.master_branch = _hook_master
3282
result.local_branch = result.target_branch
3284
result.master_branch = result.target_branch
3285
result.local_branch = None
3287
for hook in Branch.hooks['post_pull']:
3290
self.source.unlock()
3293
def push(self, overwrite=False, stop_revision=None,
3294
_override_hook_source_branch=None):
3295
"""See InterBranch.push.
3297
This is the basic concrete implementation of push()
3299
:param _override_hook_source_branch: If specified, run
3300
the hooks passing this Branch as the source, rather than self.
3301
This is for use of RemoteBranch, where push is delegated to the
3302
underlying vfs-based Branch.
3304
# TODO: Public option to disable running hooks - should be trivial but
3306
self.source.lock_read()
3308
return _run_with_write_locked_target(
3309
self.target, self._push_with_bound_branches, overwrite,
3311
_override_hook_source_branch=_override_hook_source_branch)
3313
self.source.unlock()
3315
def _push_with_bound_branches(self, overwrite, stop_revision,
3316
_override_hook_source_branch=None):
3317
"""Push from source into target, and into target's master if any.
3320
if _override_hook_source_branch:
3321
result.source_branch = _override_hook_source_branch
3322
for hook in Branch.hooks['post_push']:
3325
bound_location = self.target.get_bound_location()
3326
if bound_location and self.target.base != bound_location:
3327
# there is a master branch.
3329
# XXX: Why the second check? Is it even supported for a branch to
3330
# be bound to itself? -- mbp 20070507
3331
master_branch = self.target.get_master_branch()
3332
master_branch.lock_write()
3334
# push into the master from the source branch.
3335
self.source._basic_push(master_branch, overwrite, stop_revision)
3336
# and push into the target branch from the source. Note that we
3337
# push from the source branch again, because its considered the
3338
# highest bandwidth repository.
3339
result = self.source._basic_push(self.target, overwrite,
3341
result.master_branch = master_branch
3342
result.local_branch = self.target
3346
master_branch.unlock()
3349
result = self.source._basic_push(self.target, overwrite,
3351
# TODO: Why set master_branch and local_branch if there's no
3352
# binding? Maybe cleaner to just leave them unset? -- mbp
3354
result.master_branch = self.target
3355
result.local_branch = None
3360
def is_compatible(self, source, target):
3361
# GenericBranch uses the public API, so always compatible
3365
class InterToBranch5(GenericInterBranch):
3368
def _get_branch_formats_to_test():
3369
return BranchFormat._default_format, BzrBranchFormat5()
3371
def pull(self, overwrite=False, stop_revision=None,
3372
possible_transports=None, run_hooks=True,
3373
_override_hook_target=None, local=False):
3374
"""Pull from source into self, updating my master if any.
3376
:param run_hooks: Private parameter - if false, this branch
3377
is being called because it's the master of the primary branch,
3378
so it should not run its hooks.
3380
bound_location = self.target.get_bound_location()
3381
if local and not bound_location:
3382
raise errors.LocalRequiresBoundBranch()
3383
master_branch = None
3384
if not local and bound_location and self.source.base != bound_location:
3385
# not pulling from master, so we need to update master.
3386
master_branch = self.target.get_master_branch(possible_transports)
3387
master_branch.lock_write()
3390
# pull from source into master.
3391
master_branch.pull(self.source, overwrite, stop_revision,
3393
return super(InterToBranch5, self).pull(overwrite,
3394
stop_revision, _hook_master=master_branch,
3395
run_hooks=run_hooks,
3396
_override_hook_target=_override_hook_target)
3399
master_branch.unlock()
3402
InterBranch.register_optimiser(GenericInterBranch)
3403
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
