13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
18
from cStringIO import StringIO
21
20
from bzrlib.lazy_import import lazy_import
22
21
lazy_import(globals(), """
23
from itertools import chain
22
from copy import deepcopy
23
from unittest import TestSuite
24
from warnings import warn
24
27
from bzrlib import (
27
30
config as _mod_config,
33
35
revision as _mod_revision,
41
from bzrlib.config import BranchConfig, TransportConfig
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
from bzrlib.tag import (
41
from bzrlib.config import BranchConfig, TreeConfig
42
from bzrlib.lockable_files import LockableFiles, TransportLock
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
45
from bzrlib.decorators import needs_read_lock, needs_write_lock
46
from bzrlib.errors import (BzrError, BzrCheckError, DivergedBranches,
47
HistoryMissing, InvalidRevisionId,
48
InvalidRevisionNumber, LockError, NoSuchFile,
49
NoSuchRevision, NoWorkingTree, NotVersionedError,
50
NotBranchError, UninitializableFormat,
51
UnlistableStore, UnlistableBranch,
53
from bzrlib.symbol_versioning import (deprecated_function,
57
zero_eight, zero_nine,
59
from bzrlib.trace import mutter, note
61
62
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
62
63
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
66
class Branch(bzrdir.ControlComponent):
64
BZR_BRANCH_FORMAT_6 = "Bazaar-NG branch, format 6\n"
67
# TODO: Maybe include checks for common corruption of newlines, etc?
69
# TODO: Some operations like log might retrieve the same revisions
70
# repeatedly to calculate deltas. We could perhaps have a weakref
71
# cache in memory to make this faster. In general anything can be
72
# cached in memory between lock and unlock operations. .. nb thats
73
# what the transaction identity map provides
76
######################################################################
67
80
"""Branch holding a history of revisions.
70
Base directory/url of the branch; using control_url and
71
control_transport is more standardized.
73
hooks: An instance of BranchHooks.
83
Base directory/url of the branch.
75
85
# this is really an instance variable - FIXME move it there
80
def control_transport(self):
81
return self._transport
84
def user_transport(self):
85
return self.bzrdir.user_transport
87
89
def __init__(self, *ignored, **ignored_too):
88
self.tags = self._format.make_tags(self)
89
self._revision_history_cache = None
90
self._revision_id_to_revno_cache = None
91
self._partial_revision_id_to_revno_cache = {}
92
self._partial_revision_history_cache = []
93
self._last_revision_info_cache = None
94
self._merge_sorted_revisions_cache = None
96
hooks = Branch.hooks['open']
100
def _open_hook(self):
101
"""Called by init to allow simpler extension of the base class."""
103
def _activate_fallback_location(self, url):
104
"""Activate the branch/repository from url as a fallback repository."""
105
repo = self._get_fallback_repository(url)
106
if repo.has_same_location(self.repository):
107
raise errors.UnstackableLocationError(self.user_url, url)
108
self.repository.add_fallback_repository(repo)
90
raise NotImplementedError('The Branch class is abstract')
110
92
def break_lock(self):
111
93
"""Break a lock if one is present from another instance.
121
103
if master is not None:
122
104
master.break_lock()
124
def _check_stackable_repo(self):
125
if not self.repository._format.supports_external_lookups:
126
raise errors.UnstackableRepositoryFormat(self.repository._format,
127
self.repository.base)
129
def _extend_partial_history(self, stop_index=None, stop_revision=None):
130
"""Extend the partial history to include a given index
132
If a stop_index is supplied, stop when that index has been reached.
133
If a stop_revision is supplied, stop when that revision is
134
encountered. Otherwise, stop when the beginning of history is
137
:param stop_index: The index which should be present. When it is
138
present, history extension will stop.
139
:param stop_revision: The revision id which should be present. When
140
it is encountered, history extension will stop.
142
if len(self._partial_revision_history_cache) == 0:
143
self._partial_revision_history_cache = [self.last_revision()]
144
repository._iter_for_revno(
145
self.repository, self._partial_revision_history_cache,
146
stop_index=stop_index, stop_revision=stop_revision)
147
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
148
self._partial_revision_history_cache.pop()
150
def _get_check_refs(self):
151
"""Get the references needed for check().
155
revid = self.last_revision()
156
return [('revision-existence', revid), ('lefthand-distance', revid)]
159
def open(base, _unsupported=False, possible_transports=None):
107
@deprecated_method(zero_eight)
108
def open_downlevel(base):
109
"""Open a branch which may be of an old format."""
110
return Branch.open(base, _unsupported=True)
113
def open(base, _unsupported=False):
160
114
"""Open the branch rooted at base.
162
116
For instance, if the branch is at URL/.bzr/branch,
163
117
Branch.open(URL) -> a Branch instance.
165
control = bzrdir.BzrDir.open(base, _unsupported,
166
possible_transports=possible_transports)
167
return control.open_branch(unsupported=_unsupported)
170
def open_from_transport(transport, name=None, _unsupported=False):
171
"""Open the branch rooted at transport"""
172
control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
return control.open_branch(name=name, unsupported=_unsupported)
176
def open_containing(url, possible_transports=None):
119
control = bzrdir.BzrDir.open(base, _unsupported)
120
return control.open_branch(_unsupported)
123
def open_containing(url):
177
124
"""Open an existing branch which contains url.
179
126
This probes for a branch at url, and searches upwards from there.
181
128
Basically we keep looking up until we find the control directory or
182
129
run into the root. If there isn't one, raises NotBranchError.
183
If there is one and it is either an unrecognised format or an unsupported
130
If there is one and it is either an unrecognised format or an unsupported
184
131
format, UnknownFormatError or UnsupportedFormatError are raised.
185
132
If there is one, it is returned, along with the unused portion of url.
187
control, relpath = bzrdir.BzrDir.open_containing(url,
134
control, relpath = bzrdir.BzrDir.open_containing(url)
189
135
return control.open_branch(), relpath
191
def _push_should_merge_tags(self):
192
"""Should _basic_push merge this branch's tags into the target?
194
The default implementation returns False if this branch has no tags,
195
and True the rest of the time. Subclasses may override this.
197
return self.supports_tags() and self.tags.get_tag_dict()
138
@deprecated_function(zero_eight)
139
def initialize(base):
140
"""Create a new working tree and branch, rooted at 'base' (url)
142
NOTE: This will soon be deprecated in favour of creation
145
return bzrdir.BzrDir.create_standalone_workingtree(base).branch
147
@deprecated_function(zero_eight)
148
def setup_caching(self, cache_root):
149
"""Subclasses that care about caching should override this, and set
150
up cached stores located under cache_root.
152
NOTE: This is unused.
199
156
def get_config(self):
200
157
return BranchConfig(self)
202
def _get_config(self):
203
"""Get the concrete config for just the config in this branch.
205
This is not intended for client use; see Branch.get_config for the
210
:return: An object supporting get_option and set_option.
212
raise NotImplementedError(self._get_config)
214
def _get_fallback_repository(self, url):
215
"""Get the repository we fallback to at url."""
216
url = urlutils.join(self.base, url)
217
a_branch = Branch.open(url,
218
possible_transports=[self.bzrdir.root_transport])
219
return a_branch.repository
221
def _get_tags_bytes(self):
222
"""Get the bytes of a serialised tags dict.
224
Note that not all branches support tags, nor do all use the same tags
225
logic: this method is specific to BasicTags. Other tag implementations
226
may use the same method name and behave differently, safely, because
227
of the double-dispatch via
228
format.make_tags->tags_instance->get_tags_dict.
230
:return: The bytes of the tags file.
231
:seealso: Branch._set_tags_bytes.
233
return self._transport.get_bytes('tags')
235
def _get_nick(self, local=False, possible_transports=None):
236
config = self.get_config()
237
# explicit overrides master, but don't look for master if local is True
238
if not local and not config.has_explicit_nickname():
240
master = self.get_master_branch(possible_transports)
241
if master is not None:
242
# return the master branch value
244
except errors.BzrError, e:
245
# Silently fall back to local implicit nick if the master is
247
mutter("Could not connect to bound branch, "
248
"falling back to local nick.\n " + str(e))
249
return config.get_nickname()
160
return self.get_config().get_nickname()
251
162
def _set_nick(self, nick):
252
self.get_config().set_user_option('nickname', nick, warn_masked=True)
163
self.get_config().set_user_option('nickname', nick)
254
165
nick = property(_get_nick, _set_nick)
256
167
def is_locked(self):
257
168
raise NotImplementedError(self.is_locked)
259
def _lefthand_history(self, revision_id, last_rev=None,
261
if 'evil' in debug.debug_flags:
262
mutter_callsite(4, "_lefthand_history scales with history.")
263
# stop_revision must be a descendant of last_revision
264
graph = self.repository.get_graph()
265
if last_rev is not None:
266
if not graph.is_ancestor(last_rev, revision_id):
267
# our previous tip is not merged into stop_revision
268
raise errors.DivergedBranches(self, other_branch)
269
# make a new revision history from the graph
270
parents_map = graph.get_parent_map([revision_id])
271
if revision_id not in parents_map:
272
raise errors.NoSuchRevision(self, revision_id)
273
current_rev_id = revision_id
275
check_not_reserved_id = _mod_revision.check_not_reserved_id
276
# Do not include ghosts or graph origin in revision_history
277
while (current_rev_id in parents_map and
278
len(parents_map[current_rev_id]) > 0):
279
check_not_reserved_id(current_rev_id)
280
new_history.append(current_rev_id)
281
current_rev_id = parents_map[current_rev_id][0]
282
parents_map = graph.get_parent_map([current_rev_id])
283
new_history.reverse()
286
def lock_write(self, token=None):
287
"""Lock the branch for write operations.
289
:param token: A token to permit reacquiring a previously held and
291
:return: A BranchWriteLockResult.
170
def lock_write(self):
293
171
raise NotImplementedError(self.lock_write)
295
173
def lock_read(self):
296
"""Lock the branch for read operations.
298
:return: An object with an unlock method which will release the lock
301
174
raise NotImplementedError(self.lock_read)
303
176
def unlock(self):
310
183
def get_physical_lock_status(self):
311
184
raise NotImplementedError(self.get_physical_lock_status)
314
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
315
"""Return the revision_id for a dotted revno.
317
:param revno: a tuple like (1,) or (1,1,2)
318
:param _cache_reverse: a private parameter enabling storage
319
of the reverse mapping in a top level cache. (This should
320
only be done in selective circumstances as we want to
321
avoid having the mapping cached multiple times.)
322
:return: the revision_id
323
:raises errors.NoSuchRevision: if the revno doesn't exist
325
rev_id = self._do_dotted_revno_to_revision_id(revno)
327
self._partial_revision_id_to_revno_cache[rev_id] = revno
330
def _do_dotted_revno_to_revision_id(self, revno):
331
"""Worker function for dotted_revno_to_revision_id.
333
Subclasses should override this if they wish to
334
provide a more efficient implementation.
337
return self.get_rev_id(revno[0])
338
revision_id_to_revno = self.get_revision_id_to_revno_map()
339
revision_ids = [revision_id for revision_id, this_revno
340
in revision_id_to_revno.iteritems()
341
if revno == this_revno]
342
if len(revision_ids) == 1:
343
return revision_ids[0]
345
revno_str = '.'.join(map(str, revno))
346
raise errors.NoSuchRevision(self, revno_str)
349
def revision_id_to_dotted_revno(self, revision_id):
350
"""Given a revision id, return its dotted revno.
352
:return: a tuple like (1,) or (400,1,3).
354
return self._do_revision_id_to_dotted_revno(revision_id)
356
def _do_revision_id_to_dotted_revno(self, revision_id):
357
"""Worker function for revision_id_to_revno."""
358
# Try the caches if they are loaded
359
result = self._partial_revision_id_to_revno_cache.get(revision_id)
360
if result is not None:
362
if self._revision_id_to_revno_cache:
363
result = self._revision_id_to_revno_cache.get(revision_id)
365
raise errors.NoSuchRevision(self, revision_id)
366
# Try the mainline as it's optimised
368
revno = self.revision_id_to_revno(revision_id)
370
except errors.NoSuchRevision:
371
# We need to load and use the full revno map after all
372
result = self.get_revision_id_to_revno_map().get(revision_id)
374
raise errors.NoSuchRevision(self, revision_id)
378
def get_revision_id_to_revno_map(self):
379
"""Return the revision_id => dotted revno map.
381
This will be regenerated on demand, but will be cached.
383
:return: A dictionary mapping revision_id => dotted revno.
384
This dictionary should not be modified by the caller.
386
if self._revision_id_to_revno_cache is not None:
387
mapping = self._revision_id_to_revno_cache
389
mapping = self._gen_revno_map()
390
self._cache_revision_id_to_revno(mapping)
391
# TODO: jam 20070417 Since this is being cached, should we be returning
393
# I would rather not, and instead just declare that users should not
394
# modify the return value.
397
def _gen_revno_map(self):
398
"""Create a new mapping from revision ids to dotted revnos.
400
Dotted revnos are generated based on the current tip in the revision
402
This is the worker function for get_revision_id_to_revno_map, which
403
just caches the return value.
405
:return: A dictionary mapping revision_id => dotted revno.
407
revision_id_to_revno = dict((rev_id, revno)
408
for rev_id, depth, revno, end_of_merge
409
in self.iter_merge_sorted_revisions())
410
return revision_id_to_revno
413
def iter_merge_sorted_revisions(self, start_revision_id=None,
414
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
415
"""Walk the revisions for a branch in merge sorted order.
417
Merge sorted order is the output from a merge-aware,
418
topological sort, i.e. all parents come before their
419
children going forward; the opposite for reverse.
421
:param start_revision_id: the revision_id to begin walking from.
422
If None, the branch tip is used.
423
:param stop_revision_id: the revision_id to terminate the walk
424
after. If None, the rest of history is included.
425
:param stop_rule: if stop_revision_id is not None, the precise rule
426
to use for termination:
427
* 'exclude' - leave the stop revision out of the result (default)
428
* 'include' - the stop revision is the last item in the result
429
* 'with-merges' - include the stop revision and all of its
430
merged revisions in the result
431
* 'with-merges-without-common-ancestry' - filter out revisions
432
that are in both ancestries
433
:param direction: either 'reverse' or 'forward':
434
* reverse means return the start_revision_id first, i.e.
435
start at the most recent revision and go backwards in history
436
* forward returns tuples in the opposite order to reverse.
437
Note in particular that forward does *not* do any intelligent
438
ordering w.r.t. depth as some clients of this API may like.
439
(If required, that ought to be done at higher layers.)
441
:return: an iterator over (revision_id, depth, revno, end_of_merge)
444
* revision_id: the unique id of the revision
445
* depth: How many levels of merging deep this node has been
447
* revno_sequence: This field provides a sequence of
448
revision numbers for all revisions. The format is:
449
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
450
branch that the revno is on. From left to right the REVNO numbers
451
are the sequence numbers within that branch of the revision.
452
* end_of_merge: When True the next node (earlier in history) is
453
part of a different merge.
455
# Note: depth and revno values are in the context of the branch so
456
# we need the full graph to get stable numbers, regardless of the
458
if self._merge_sorted_revisions_cache is None:
459
last_revision = self.last_revision()
460
known_graph = self.repository.get_known_graph_ancestry(
462
self._merge_sorted_revisions_cache = known_graph.merge_sort(
464
filtered = self._filter_merge_sorted_revisions(
465
self._merge_sorted_revisions_cache, start_revision_id,
466
stop_revision_id, stop_rule)
467
# Make sure we don't return revisions that are not part of the
468
# start_revision_id ancestry.
469
filtered = self._filter_start_non_ancestors(filtered)
470
if direction == 'reverse':
472
if direction == 'forward':
473
return reversed(list(filtered))
475
raise ValueError('invalid direction %r' % direction)
477
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
478
start_revision_id, stop_revision_id, stop_rule):
479
"""Iterate over an inclusive range of sorted revisions."""
480
rev_iter = iter(merge_sorted_revisions)
481
if start_revision_id is not None:
482
for node in rev_iter:
483
rev_id = node.key[-1]
484
if rev_id != start_revision_id:
487
# The decision to include the start or not
488
# depends on the stop_rule if a stop is provided
489
# so pop this node back into the iterator
490
rev_iter = chain(iter([node]), rev_iter)
492
if stop_revision_id is None:
494
for node in rev_iter:
495
rev_id = node.key[-1]
496
yield (rev_id, node.merge_depth, node.revno,
498
elif stop_rule == 'exclude':
499
for node in rev_iter:
500
rev_id = node.key[-1]
501
if rev_id == stop_revision_id:
503
yield (rev_id, node.merge_depth, node.revno,
505
elif stop_rule == 'include':
506
for node in rev_iter:
507
rev_id = node.key[-1]
508
yield (rev_id, node.merge_depth, node.revno,
510
if rev_id == stop_revision_id:
512
elif stop_rule == 'with-merges-without-common-ancestry':
513
# We want to exclude all revisions that are already part of the
514
# stop_revision_id ancestry.
515
graph = self.repository.get_graph()
516
ancestors = graph.find_unique_ancestors(start_revision_id,
518
for node in rev_iter:
519
rev_id = node.key[-1]
520
if rev_id not in ancestors:
522
yield (rev_id, node.merge_depth, node.revno,
524
elif stop_rule == 'with-merges':
525
stop_rev = self.repository.get_revision(stop_revision_id)
526
if stop_rev.parent_ids:
527
left_parent = stop_rev.parent_ids[0]
529
left_parent = _mod_revision.NULL_REVISION
530
# left_parent is the actual revision we want to stop logging at,
531
# since we want to show the merged revisions after the stop_rev too
532
reached_stop_revision_id = False
533
revision_id_whitelist = []
534
for node in rev_iter:
535
rev_id = node.key[-1]
536
if rev_id == left_parent:
537
# reached the left parent after the stop_revision
539
if (not reached_stop_revision_id or
540
rev_id in revision_id_whitelist):
541
yield (rev_id, node.merge_depth, node.revno,
543
if reached_stop_revision_id or rev_id == stop_revision_id:
544
# only do the merged revs of rev_id from now on
545
rev = self.repository.get_revision(rev_id)
547
reached_stop_revision_id = True
548
revision_id_whitelist.extend(rev.parent_ids)
550
raise ValueError('invalid stop_rule %r' % stop_rule)
552
def _filter_start_non_ancestors(self, rev_iter):
553
# If we started from a dotted revno, we want to consider it as a tip
554
# and don't want to yield revisions that are not part of its
555
# ancestry. Given the order guaranteed by the merge sort, we will see
556
# uninteresting descendants of the first parent of our tip before the
558
first = rev_iter.next()
559
(rev_id, merge_depth, revno, end_of_merge) = first
562
# We start at a mainline revision so by definition, all others
563
# revisions in rev_iter are ancestors
564
for node in rev_iter:
569
pmap = self.repository.get_parent_map([rev_id])
570
parents = pmap.get(rev_id, [])
572
whitelist.update(parents)
574
# If there is no parents, there is nothing of interest left
576
# FIXME: It's hard to test this scenario here as this code is never
577
# called in that case. -- vila 20100322
580
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
582
if rev_id in whitelist:
583
pmap = self.repository.get_parent_map([rev_id])
584
parents = pmap.get(rev_id, [])
585
whitelist.remove(rev_id)
586
whitelist.update(parents)
588
# We've reached the mainline, there is nothing left to
592
# A revision that is not part of the ancestry of our
595
yield (rev_id, merge_depth, revno, end_of_merge)
597
def leave_lock_in_place(self):
598
"""Tell this branch object not to release the physical lock when this
601
If lock_write doesn't return a token, then this method is not supported.
603
self.control_files.leave_in_place()
605
def dont_leave_lock_in_place(self):
606
"""Tell this branch object to release the physical lock when this
607
object is unlocked, even if it didn't originally acquire it.
609
If lock_write doesn't return a token, then this method is not supported.
611
self.control_files.dont_leave_in_place()
186
def abspath(self, name):
187
"""Return absolute filename for something in the branch
189
XXX: Robert Collins 20051017 what is this used for? why is it a branch
190
method and not a tree method.
192
raise NotImplementedError(self.abspath)
613
194
def bind(self, other):
614
195
"""Bind the local branch the other branch.
709
278
The delta is relative to its mainline predecessor, or the
710
279
empty tree for revision 1.
281
assert isinstance(revno, int)
712
282
rh = self.revision_history()
713
283
if not (1 <= revno <= len(rh)):
714
raise errors.InvalidRevisionNumber(revno)
284
raise InvalidRevisionNumber(revno)
715
285
return self.repository.get_revision_delta(rh[revno-1])
717
def get_stacked_on_url(self):
718
"""Get the URL this branch is stacked against.
720
:raises NotStacked: If the branch is not stacked.
721
:raises UnstackableBranchFormat: If the branch does not support
724
raise NotImplementedError(self.get_stacked_on_url)
287
def get_root_id(self):
288
"""Return the id of this branches root"""
289
raise NotImplementedError(self.get_root_id)
726
291
def print_file(self, file, revision_id):
727
292
"""Print `file` to stdout."""
728
293
raise NotImplementedError(self.print_file)
295
def append_revision(self, *revision_ids):
296
raise NotImplementedError(self.append_revision)
730
298
def set_revision_history(self, rev_history):
731
299
raise NotImplementedError(self.set_revision_history)
734
def set_parent(self, url):
735
"""See Branch.set_parent."""
736
# TODO: Maybe delete old location files?
737
# URLs should never be unicode, even on the local fs,
738
# FIXUP this and get_parent in a future branch format bump:
739
# read and rewrite the file. RBC 20060125
741
if isinstance(url, unicode):
743
url = url.encode('ascii')
744
except UnicodeEncodeError:
745
raise errors.InvalidURL(url,
746
"Urls must be 7-bit ascii, "
747
"use bzrlib.urlutils.escape")
748
url = urlutils.relative_url(self.base, url)
749
self._set_parent_location(url)
752
def set_stacked_on_url(self, url):
753
"""Set the URL this branch is stacked against.
755
:raises UnstackableBranchFormat: If the branch does not support
757
:raises UnstackableRepositoryFormat: If the repository does not support
760
if not self._format.supports_stacking():
761
raise errors.UnstackableBranchFormat(self._format, self.user_url)
762
# XXX: Changing from one fallback repository to another does not check
763
# that all the data you need is present in the new fallback.
764
# Possibly it should.
765
self._check_stackable_repo()
768
old_url = self.get_stacked_on_url()
769
except (errors.NotStacked, errors.UnstackableBranchFormat,
770
errors.UnstackableRepositoryFormat):
774
self._activate_fallback_location(url)
775
# write this out after the repository is stacked to avoid setting a
776
# stacked config that doesn't work.
777
self._set_config_location('stacked_on_location', url)
780
"""Change a branch to be unstacked, copying data as needed.
782
Don't call this directly, use set_stacked_on_url(None).
784
pb = ui.ui_factory.nested_progress_bar()
786
pb.update("Unstacking")
787
# The basic approach here is to fetch the tip of the branch,
788
# including all available ghosts, from the existing stacked
789
# repository into a new repository object without the fallbacks.
791
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
792
# correct for CHKMap repostiories
793
old_repository = self.repository
794
if len(old_repository._fallback_repositories) != 1:
795
raise AssertionError("can't cope with fallback repositories "
796
"of %r" % (self.repository,))
797
# unlock it, including unlocking the fallback
798
old_repository.unlock()
799
old_repository.lock_read()
801
# Repositories don't offer an interface to remove fallback
802
# repositories today; take the conceptually simpler option and just
803
# reopen it. We reopen it starting from the URL so that we
804
# get a separate connection for RemoteRepositories and can
805
# stream from one of them to the other. This does mean doing
806
# separate SSH connection setup, but unstacking is not a
807
# common operation so it's tolerable.
808
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
809
new_repository = new_bzrdir.find_repository()
810
self.repository = new_repository
811
if self.repository._fallback_repositories:
812
raise AssertionError("didn't expect %r to have "
813
"fallback_repositories"
814
% (self.repository,))
815
# this is not paired with an unlock because it's just restoring
816
# the previous state; the lock's released when set_stacked_on_url
818
self.repository.lock_write()
819
# XXX: If you unstack a branch while it has a working tree
820
# with a pending merge, the pending-merged revisions will no
821
# longer be present. You can (probably) revert and remerge.
823
# XXX: This only fetches up to the tip of the repository; it
824
# doesn't bring across any tags. That's fairly consistent
825
# with how branch works, but perhaps not ideal.
826
self.repository.fetch(old_repository,
827
revision_id=self.last_revision(),
830
old_repository.unlock()
834
def _set_tags_bytes(self, bytes):
835
"""Mirror method for _get_tags_bytes.
837
:seealso: Branch._get_tags_bytes.
839
return _run_with_write_locked_target(self, self._transport.put_bytes,
842
def _cache_revision_history(self, rev_history):
843
"""Set the cached revision history to rev_history.
845
The revision_history method will use this cache to avoid regenerating
846
the revision history.
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_history_cache = rev_history
853
def _cache_revision_id_to_revno(self, revision_id_to_revno):
854
"""Set the cached revision_id => revno map to revision_id_to_revno.
856
This API is semi-public; it only for use by subclasses, all other code
857
should consider it to be private.
859
self._revision_id_to_revno_cache = revision_id_to_revno
861
def _clear_cached_state(self):
862
"""Clear any cached data on this branch, e.g. cached revision history.
864
This means the next call to revision_history will need to call
865
_gen_revision_history.
867
This API is semi-public; it only for use by subclasses, all other code
868
should consider it to be private.
870
self._revision_history_cache = None
871
self._revision_id_to_revno_cache = None
872
self._last_revision_info_cache = None
873
self._merge_sorted_revisions_cache = None
874
self._partial_revision_history_cache = []
875
self._partial_revision_id_to_revno_cache = {}
877
def _gen_revision_history(self):
878
"""Return sequence of revision hashes on to this branch.
880
Unlike revision_history, this method always regenerates or rereads the
881
revision history, i.e. it does not cache the result, so repeated calls
884
Concrete subclasses should override this instead of revision_history so
885
that subclasses do not need to deal with caching logic.
887
This API is semi-public; it only for use by subclasses, all other code
888
should consider it to be private.
890
raise NotImplementedError(self._gen_revision_history)
893
301
def revision_history(self):
894
"""Return sequence of revision ids on this branch.
896
This method will cache the revision history for as long as it is safe to
899
if 'evil' in debug.debug_flags:
900
mutter_callsite(3, "revision_history scales with history.")
901
if self._revision_history_cache is not None:
902
history = self._revision_history_cache
904
history = self._gen_revision_history()
905
self._cache_revision_history(history)
302
"""Return sequence of revision hashes on to this branch."""
303
raise NotImplementedError(self.revision_history)
909
306
"""Return current revision number for this branch.
953
335
common_index = min(self_len, other_len) -1
954
336
if common_index >= 0 and \
955
337
self_history[common_index] != other_history[common_index]:
956
raise errors.DivergedBranches(self, other)
338
raise DivergedBranches(self, other)
958
340
if stop_revision is None:
959
341
stop_revision = other_len
343
assert isinstance(stop_revision, int)
961
344
if stop_revision > other_len:
962
345
raise errors.NoSuchRevision(self, stop_revision)
963
346
return other_history[self_len:stop_revision]
966
def update_revisions(self, other, stop_revision=None, overwrite=False,
348
def update_revisions(self, other, stop_revision=None):
968
349
"""Pull in new perfect-fit revisions.
970
351
:param other: Another Branch to pull from
971
352
:param stop_revision: Updated until the given revision
972
:param overwrite: Always set the branch pointer, rather than checking
973
to see if it is a proper descendant.
974
:param graph: A Graph object that can be used to query history
975
information. This can be None.
978
return InterBranch.get(other, self).update_revisions(stop_revision,
981
def import_last_revision_info(self, source_repo, revno, revid):
982
"""Set the last revision info, importing from another repo if necessary.
984
This is used by the bound branch code to upload a revision to
985
the master branch first before updating the tip of the local branch.
987
:param source_repo: Source repository to optionally fetch from
988
:param revno: Revision number of the new tip
989
:param revid: Revision id of the new tip
991
if not self.repository.has_same_location(source_repo):
992
self.repository.fetch(source_repo, revision_id=revid)
993
self.set_last_revision_info(revno, revid)
355
raise NotImplementedError(self.update_revisions)
995
357
def revision_id_to_revno(self, revision_id):
996
358
"""Given a revision id, return its revno"""
997
if _mod_revision.is_null(revision_id):
359
if revision_id is None:
999
361
history = self.revision_history()
1001
363
return history.index(revision_id) + 1
1002
364
except ValueError:
1003
raise errors.NoSuchRevision(self, revision_id)
365
raise bzrlib.errors.NoSuchRevision(self, revision_id)
1006
367
def get_rev_id(self, revno, history=None):
1007
368
"""Find the revision id of the specified revno."""
1009
return _mod_revision.NULL_REVISION
1010
last_revno, last_revid = self.last_revision_info()
1011
if revno == last_revno:
1013
if revno <= 0 or revno > last_revno:
1014
raise errors.NoSuchRevision(self, revno)
1015
distance_from_last = last_revno - revno
1016
if len(self._partial_revision_history_cache) <= distance_from_last:
1017
self._extend_partial_history(distance_from_last)
1018
return self._partial_revision_history_cache[distance_from_last]
1021
def pull(self, source, overwrite=False, stop_revision=None,
1022
possible_transports=None, *args, **kwargs):
1023
"""Mirror source into this branch.
1025
This branch is considered to be 'local', having low latency.
1027
:returns: PullResult instance
1029
return InterBranch.get(source, self).pull(overwrite=overwrite,
1030
stop_revision=stop_revision,
1031
possible_transports=possible_transports, *args, **kwargs)
1033
def push(self, target, overwrite=False, stop_revision=None, *args,
1035
"""Mirror this branch into target.
1037
This branch is considered to be 'local', having low latency.
1039
return InterBranch.get(self, target).push(overwrite, stop_revision,
1042
def lossy_push(self, target, stop_revision=None):
1043
"""Push deltas into another branch.
1045
:note: This does not, like push, retain the revision ids from
1046
the source branch and will, rather than adding bzr-specific
1047
metadata, push only those semantics of the revision that can be
1048
natively represented by this branch' VCS.
1050
:param target: Target branch
1051
:param stop_revision: Revision to push, defaults to last revision.
1052
:return: BranchPushResult with an extra member revidmap:
1053
A dictionary mapping revision ids from the target branch
1054
to new revision ids in the target branch, for each
1055
revision that was pushed.
1057
inter = InterBranch.get(self, target)
1058
lossy_push = getattr(inter, "lossy_push", None)
1059
if lossy_push is None:
1060
raise errors.LossyPushToSameVCS(self, target)
1061
return lossy_push(stop_revision)
372
history = self.revision_history()
373
if revno <= 0 or revno > len(history):
374
raise bzrlib.errors.NoSuchRevision(self, revno)
375
return history[revno - 1]
377
def pull(self, source, overwrite=False, stop_revision=None):
378
raise NotImplementedError(self.pull)
1063
380
def basis_tree(self):
1064
381
"""Return `Tree` object for last revision."""
1065
382
return self.repository.revision_tree(self.last_revision())
384
def rename_one(self, from_rel, to_rel):
387
This can change the directory or the filename or both.
389
raise NotImplementedError(self.rename_one)
391
def move(self, from_paths, to_name):
394
to_name must exist as a versioned directory.
396
If to_name exists and is a directory, the files are moved into
397
it, keeping their old names. If it is a directory,
399
Note that to_name is only the last component of the new name;
400
this doesn't change the directory.
402
This returns a list of (from_path, to_path) pairs for each
405
raise NotImplementedError(self.move)
1067
407
def get_parent(self):
1068
408
"""Return the parent location of the branch.
1070
This is the default location for pull/missing. The usual
410
This is the default location for push/pull/missing. The usual
1071
411
pattern is that the user can override it by specifying a
1074
parent = self._get_parent_location()
1077
# This is an old-format absolute path to a local branch
1078
# turn it into a url
1079
if parent.startswith('/'):
1080
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1082
return urlutils.join(self.base[:-1], parent)
1083
except errors.InvalidURLJoin, e:
1084
raise errors.InaccessibleParent(parent, self.user_url)
1086
def _get_parent_location(self):
1087
raise NotImplementedError(self._get_parent_location)
1089
def _set_config_location(self, name, url, config=None,
1090
make_relative=False):
1092
config = self.get_config()
1096
url = urlutils.relative_url(self.base, url)
1097
config.set_user_option(name, url, warn_masked=True)
1099
def _get_config_location(self, name, config=None):
1101
config = self.get_config()
1102
location = config.get_user_option(name)
1107
def get_child_submit_format(self):
1108
"""Return the preferred format of submissions to this branch."""
1109
return self.get_config().get_user_option("child_submit_format")
414
raise NotImplementedError(self.get_parent)
1111
416
def get_submit_branch(self):
1112
417
"""Return the submit location of the branch.
1191
459
self.check_real_revno(revno)
1193
461
def check_real_revno(self, revno):
1195
463
Check whether a revno corresponds to a real revision.
1196
464
Zero (the NULL revision) is considered invalid
1198
466
if revno < 1 or revno > self.revno():
1199
raise errors.InvalidRevisionNumber(revno)
467
raise InvalidRevisionNumber(revno)
1201
469
@needs_read_lock
1202
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
470
def clone(self, *args, **kwargs):
1203
471
"""Clone this branch into to_bzrdir preserving all semantic values.
1205
Most API users will want 'create_clone_on_transport', which creates a
1206
new bzrdir and branch on the fly.
1208
473
revision_id: if not None, the revision history in the new branch will
1209
474
be truncated to end with revision_id.
1211
result = to_bzrdir.create_branch()
1214
if repository_policy is not None:
1215
repository_policy.configure_branch(result)
1216
self.copy_content_into(result, revision_id=revision_id)
476
# for API compatibility, until 0.8 releases we provide the old api:
477
# def clone(self, to_location, revision=None, basis_branch=None, to_branch_format=None):
478
# after 0.8 releases, the *args and **kwargs should be changed:
479
# def clone(self, to_bzrdir, revision_id=None):
480
if (kwargs.get('to_location', None) or
481
kwargs.get('revision', None) or
482
kwargs.get('basis_branch', None) or
483
(len(args) and isinstance(args[0], basestring))):
484
# backwards compatibility api:
485
warn("Branch.clone() has been deprecated for BzrDir.clone() from"
486
" bzrlib 0.8.", DeprecationWarning, stacklevel=3)
489
basis_branch = args[2]
491
basis_branch = kwargs.get('basis_branch', None)
493
basis = basis_branch.bzrdir
498
revision_id = args[1]
500
revision_id = kwargs.get('revision', None)
505
# no default to raise if not provided.
506
url = kwargs.get('to_location')
507
return self.bzrdir.clone(url,
508
revision_id=revision_id,
509
basis=basis).open_branch()
511
# generate args by hand
513
revision_id = args[1]
515
revision_id = kwargs.get('revision_id', None)
519
# no default to raise if not provided.
520
to_bzrdir = kwargs.get('to_bzrdir')
521
result = self._format.initialize(to_bzrdir)
522
self.copy_content_into(result, revision_id=revision_id)
1221
525
@needs_read_lock
1222
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
526
def sprout(self, to_bzrdir, revision_id=None):
1223
527
"""Create a new line of development from the branch, into to_bzrdir.
1225
to_bzrdir controls the branch format.
1227
529
revision_id: if not None, the revision history in the new branch will
1228
530
be truncated to end with revision_id.
1230
if (repository_policy is not None and
1231
repository_policy.requires_stacking()):
1232
to_bzrdir._format.require_stacking(_skip_repo=True)
1233
result = to_bzrdir.create_branch()
1236
if repository_policy is not None:
1237
repository_policy.configure_branch(result)
1238
self.copy_content_into(result, revision_id=revision_id)
1239
result.set_parent(self.bzrdir.root_transport.base)
532
result = self._format.initialize(to_bzrdir)
533
self.copy_content_into(result, revision_id=revision_id)
534
result.set_parent(self.bzrdir.root_transport.base)
1244
def _synchronize_history(self, destination, revision_id):
1245
"""Synchronize last revision and revision history between branches.
1247
This version is most efficient when the destination is also a
1248
BzrBranch6, but works for BzrBranch5, as long as the destination's
1249
repository contains all the lefthand ancestors of the intended
1250
last_revision. If not, set_last_revision_info will fail.
1252
:param destination: The branch to copy the history into
1253
:param revision_id: The revision-id to truncate history at. May
1254
be None to copy complete history.
1256
source_revno, source_revision_id = self.last_revision_info()
1257
if revision_id is None:
1258
revno, revision_id = source_revno, source_revision_id
1260
graph = self.repository.get_graph()
1262
revno = graph.find_distance_to_null(revision_id,
1263
[(source_revision_id, source_revno)])
1264
except errors.GhostRevisionsHaveNoRevno:
1265
# Default to 1, if we can't find anything else
1267
destination.set_last_revision_info(revno, revision_id)
1269
537
@needs_read_lock
1270
538
def copy_content_into(self, destination, revision_id=None):
1271
539
"""Copy the content of self into destination.
1284
558
destination.set_parent(parent)
1285
if self._push_should_merge_tags():
1286
self.tags.merge_to(destination.tags)
1288
def update_references(self, target):
1289
if not getattr(self._format, 'supports_reference_locations', False):
1291
reference_dict = self._get_all_reference_info()
1292
if len(reference_dict) == 0:
1294
old_base = self.base
1295
new_base = target.base
1296
target_reference_dict = target._get_all_reference_info()
1297
for file_id, (tree_path, branch_location) in (
1298
reference_dict.items()):
1299
branch_location = urlutils.rebase_url(branch_location,
1301
target_reference_dict.setdefault(
1302
file_id, (tree_path, branch_location))
1303
target._set_all_reference_info(target_reference_dict)
1305
560
@needs_read_lock
1306
def check(self, refs):
1307
562
"""Check consistency of the branch.
1309
564
In particular this checks that revisions given in the revision-history
1310
do actually match up in the revision graph, and that they're all
565
do actually match up in the revision graph, and that they're all
1311
566
present in the repository.
1313
568
Callers will typically also want to check the repository.
1315
:param refs: Calculated refs for this branch as specified by
1316
branch._get_check_refs()
1317
570
:return: A BranchCheckResult.
1319
result = BranchCheckResult(self)
1320
last_revno, last_revision_id = self.last_revision_info()
1321
actual_revno = refs[('lefthand-distance', last_revision_id)]
1322
if actual_revno != last_revno:
1323
result.errors.append(errors.BzrCheckError(
1324
'revno does not match len(mainline) %s != %s' % (
1325
last_revno, actual_revno)))
1326
# TODO: We should probably also check that self.revision_history
1327
# matches the repository for older branch formats.
1328
# If looking for the code that cross-checks repository parents against
1329
# the iter_reverse_revision_history output, that is now a repository
572
mainline_parent_id = None
573
for revision_id in self.revision_history():
575
revision = self.repository.get_revision(revision_id)
576
except errors.NoSuchRevision, e:
577
raise errors.BzrCheckError("mainline revision {%s} not in repository"
579
# In general the first entry on the revision history has no parents.
580
# But it's not illegal for it to have parents listed; this can happen
581
# in imports from Arch when the parents weren't reachable.
582
if mainline_parent_id is not None:
583
if mainline_parent_id not in revision.parent_ids:
584
raise errors.BzrCheckError("previous revision {%s} not listed among "
586
% (mainline_parent_id, revision_id))
587
mainline_parent_id = revision_id
588
return BranchCheckResult(self)
1333
590
def _get_checkout_format(self):
1334
591
"""Return the most suitable metadir for a checkout of this branch.
1335
Weaves are used if this branch's repository uses weaves.
592
Weaves are used if this branch's repostory uses weaves.
1337
594
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1338
from bzrlib.repofmt import weaverepo
595
from bzrlib import repository
1339
596
format = bzrdir.BzrDirMetaFormat1()
1340
format.repository_format = weaverepo.RepositoryFormat7()
597
format.repository_format = repository.RepositoryFormat7()
1342
format = self.repository.bzrdir.checkout_metadir()
1343
format.set_branch_format(self._format)
599
format = self.repository.bzrdir.cloning_metadir()
1346
def create_clone_on_transport(self, to_transport, revision_id=None,
1347
stacked_on=None, create_prefix=False, use_existing_dir=False):
1348
"""Create a clone of this branch and its bzrdir.
1350
:param to_transport: The transport to clone onto.
1351
:param revision_id: The revision id to use as tip in the new branch.
1352
If None the tip is obtained from this branch.
1353
:param stacked_on: An optional URL to stack the clone on.
1354
:param create_prefix: Create any missing directories leading up to
1356
:param use_existing_dir: Use an existing directory if one exists.
1358
# XXX: Fix the bzrdir API to allow getting the branch back from the
1359
# clone call. Or something. 20090224 RBC/spiv.
1360
if revision_id is None:
1361
revision_id = self.last_revision()
1362
dir_to = self.bzrdir.clone_on_transport(to_transport,
1363
revision_id=revision_id, stacked_on=stacked_on,
1364
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1365
return dir_to.open_branch()
1367
def create_checkout(self, to_location, revision_id=None,
1368
lightweight=False, accelerator_tree=None,
602
def create_checkout(self, to_location, revision_id=None,
1370
604
"""Create a checkout of a branch.
1372
606
:param to_location: The url to produce the checkout at
1373
607
:param revision_id: The revision to check out
1374
608
:param lightweight: If True, produce a lightweight checkout, otherwise,
1375
609
produce a bound branch (heavyweight checkout)
1376
:param accelerator_tree: A tree which can be used for retrieving file
1377
contents more quickly than the revision tree, i.e. a workingtree.
1378
The revision tree will be used for cases where accelerator_tree's
1379
content is different.
1380
:param hardlink: If true, hard-link files from accelerator_tree,
1382
610
:return: The tree of the created checkout
1384
612
t = transport.get_transport(to_location)
615
except errors.FileExists:
1387
format = self._get_checkout_format()
1388
checkout = format.initialize_on_transport(t)
1389
from_branch = BranchReferenceFormat().initialize(checkout,
618
checkout = bzrdir.BzrDirMetaFormat1().initialize_on_transport(t)
619
BranchReferenceFormat().initialize(checkout, self)
1392
621
format = self._get_checkout_format()
1393
622
checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1394
623
to_location, force_new_tree=False, format=format)
1395
624
checkout = checkout_branch.bzrdir
1396
625
checkout_branch.bind(self)
1397
# pull up to the specified revision_id to set the initial
626
# pull up to the specified revision_id to set the initial
1398
627
# branch tip correctly, and seed it with history.
1399
628
checkout_branch.pull(self, stop_revision=revision_id)
1401
tree = checkout.create_workingtree(revision_id,
1402
from_branch=from_branch,
1403
accelerator_tree=accelerator_tree,
1405
basis_tree = tree.basis_tree()
1406
basis_tree.lock_read()
1408
for path, file_id in basis_tree.iter_references():
1409
reference_parent = self.reference_parent(file_id, path)
1410
reference_parent.create_checkout(tree.abspath(path),
1411
basis_tree.get_reference_revision(file_id, path),
1418
def reconcile(self, thorough=True):
1419
"""Make sure the data stored in this branch is consistent."""
1420
from bzrlib.reconcile import BranchReconciler
1421
reconciler = BranchReconciler(self, thorough=thorough)
1422
reconciler.reconcile()
1425
def reference_parent(self, file_id, path, possible_transports=None):
1426
"""Return the parent branch for a tree-reference file_id
1427
:param file_id: The file_id of the tree reference
1428
:param path: The path of the file_id in the tree
1429
:return: A branch associated with the file_id
1431
# FIXME should provide multiple branches, based on config
1432
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1433
possible_transports=possible_transports)
1435
def supports_tags(self):
1436
return self._format.supports_tags()
1438
def automatic_tag_name(self, revision_id):
1439
"""Try to automatically find the tag name for a revision.
1441
:param revision_id: Revision id of the revision.
1442
:return: A tag name or None if no tag name could be determined.
1444
for hook in Branch.hooks['automatic_tag_name']:
1445
ret = hook(self, revision_id)
1450
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1452
"""Ensure that revision_b is a descendant of revision_a.
1454
This is a helper function for update_revisions.
1456
:raises: DivergedBranches if revision_b has diverged from revision_a.
1457
:returns: True if revision_b is a descendant of revision_a.
1459
relation = self._revision_relations(revision_a, revision_b, graph)
1460
if relation == 'b_descends_from_a':
1462
elif relation == 'diverged':
1463
raise errors.DivergedBranches(self, other_branch)
1464
elif relation == 'a_descends_from_b':
1467
raise AssertionError("invalid relation: %r" % (relation,))
1469
def _revision_relations(self, revision_a, revision_b, graph):
1470
"""Determine the relationship between two revisions.
1472
:returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1474
heads = graph.heads([revision_a, revision_b])
1475
if heads == set([revision_b]):
1476
return 'b_descends_from_a'
1477
elif heads == set([revision_a, revision_b]):
1478
# These branches have diverged
1480
elif heads == set([revision_a]):
1481
return 'a_descends_from_b'
1483
raise AssertionError("invalid heads: %r" % (heads,))
629
return checkout.create_workingtree(revision_id)
1486
632
class BranchFormat(object):
1508
654
"""The known formats."""
1510
can_set_append_revisions_only = True
1512
def __eq__(self, other):
1513
return self.__class__ is other.__class__
1515
def __ne__(self, other):
1516
return not (self == other)
1519
def find_format(klass, a_bzrdir, name=None):
657
def find_format(klass, a_bzrdir):
1520
658
"""Return the format for the branch object in a_bzrdir."""
1522
transport = a_bzrdir.get_branch_transport(None, name=name)
1523
format_string = transport.get_bytes("format")
660
transport = a_bzrdir.get_branch_transport(None)
661
format_string = transport.get("format").read()
1524
662
return klass._formats[format_string]
1525
except errors.NoSuchFile:
1526
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
664
raise NotBranchError(path=transport.base)
1527
665
except KeyError:
1528
raise errors.UnknownFormatError(format=format_string, kind='branch')
666
raise errors.UnknownFormatError(format=format_string)
1531
669
def get_default_format(klass):
1532
670
"""Return the current default format."""
1533
671
return klass._default_format
1535
def get_reference(self, a_bzrdir):
1536
"""Get the target reference of the branch in a_bzrdir.
1538
format probing must have been completed before calling
1539
this method - it is assumed that the format of the branch
1540
in a_bzrdir is correct.
1542
:param a_bzrdir: The bzrdir to get the branch data from.
1543
:return: None if the branch is not a reference branch.
1548
def set_reference(self, a_bzrdir, to_branch):
1549
"""Set the target reference of the branch in a_bzrdir.
1551
format probing must have been completed before calling
1552
this method - it is assumed that the format of the branch
1553
in a_bzrdir is correct.
1555
:param a_bzrdir: The bzrdir to set the branch reference for.
1556
:param to_branch: branch that the checkout is to reference
1558
raise NotImplementedError(self.set_reference)
1560
673
def get_format_string(self):
1561
674
"""Return the ASCII format string that identifies this format."""
1562
675
raise NotImplementedError(self.get_format_string)
1564
677
def get_format_description(self):
1565
678
"""Return the short format description for this format."""
1566
raise NotImplementedError(self.get_format_description)
1568
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1569
hooks = Branch.hooks['post_branch_init']
1572
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1576
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1577
lock_type='metadir', set_format=True):
1578
"""Initialize a branch in a bzrdir, with specified files
1580
:param a_bzrdir: The bzrdir to initialize the branch in
1581
:param utf8_files: The files to create as a list of
1582
(filename, content) tuples
1583
:param name: Name of colocated branch to create, if any
1584
:param set_format: If True, set the format with
1585
self.get_format_string. (BzrBranch4 has its format set
1587
:return: a branch in this format
1589
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1590
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1592
'metadir': ('lock', lockdir.LockDir),
1593
'branch4': ('branch-lock', lockable_files.TransportLock),
1595
lock_name, lock_class = lock_map[lock_type]
1596
control_files = lockable_files.LockableFiles(branch_transport,
1597
lock_name, lock_class)
1598
control_files.create_lock()
1600
control_files.lock_write()
1601
except errors.LockContention:
1602
if lock_type != 'branch4':
1608
utf8_files += [('format', self.get_format_string())]
1610
for (filename, content) in utf8_files:
1611
branch_transport.put_bytes(
1613
mode=a_bzrdir._get_file_mode())
1616
control_files.unlock()
1617
branch = self.open(a_bzrdir, name, _found=True)
1618
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1621
def initialize(self, a_bzrdir, name=None):
1622
"""Create a branch of this format in a_bzrdir.
1624
:param name: Name of the colocated branch to create.
679
raise NotImplementedError(self.get_format_string)
681
def initialize(self, a_bzrdir):
682
"""Create a branch of this format in a_bzrdir."""
1626
683
raise NotImplementedError(self.initialize)
1628
685
def is_supported(self):
1629
686
"""Is this format supported?
1631
688
Supported formats can be initialized and opened.
1632
Unsupported formats may not support initialization or committing or
689
Unsupported formats may not support initialization or committing or
1633
690
some other features depending on the reason for not being supported.
1637
def make_tags(self, branch):
1638
"""Create a tags object for branch.
1640
This method is on BranchFormat, because BranchFormats are reflected
1641
over the wire via network_name(), whereas full Branch instances require
1642
multiple VFS method calls to operate at all.
1644
The default implementation returns a disabled-tags instance.
1646
Note that it is normal for branch to be a RemoteBranch when using tags
1649
return DisabledTags(branch)
1651
def network_name(self):
1652
"""A simple byte string uniquely identifying this format for RPC calls.
1654
MetaDir branch formats use their disk format string to identify the
1655
repository over the wire. All in one formats such as bzr < 0.8, and
1656
foreign formats like svn/git and hg should use some marker which is
1657
unique and immutable.
1659
raise NotImplementedError(self.network_name)
1661
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
694
def open(self, a_bzrdir, _found=False):
1662
695
"""Return the branch object for a_bzrdir
1664
:param a_bzrdir: A BzrDir that contains a branch.
1665
:param name: Name of colocated branch to open
1666
:param _found: a private parameter, do not use it. It is used to
1667
indicate if format probing has already be done.
1668
:param ignore_fallbacks: when set, no fallback branches will be opened
1669
(if there are any). Default is to open fallbacks.
697
_found is a private parameter, do not use it. It is used to indicate
698
if format probing has already be done.
1671
700
raise NotImplementedError(self.open)
1674
703
def register_format(klass, format):
1675
"""Register a metadir format."""
1676
704
klass._formats[format.get_format_string()] = format
1677
# Metadir formats have a network name of their format string, and get
1678
# registered as class factories.
1679
network_format_registry.register(format.get_format_string(), format.__class__)
1682
707
def set_default_format(klass, format):
1683
708
klass._default_format = format
1685
def supports_set_append_revisions_only(self):
1686
"""True if this format supports set_append_revisions_only."""
1689
def supports_stacking(self):
1690
"""True if this format records a stacked-on branch."""
1694
711
def unregister_format(klass, format):
712
assert klass._formats[format.get_format_string()] is format
1695
713
del klass._formats[format.get_format_string()]
1697
715
def __str__(self):
1698
return self.get_format_description().rstrip()
1700
def supports_tags(self):
1701
"""True if this format supports tags stored in the branch"""
1702
return False # by default
1705
class BranchHooks(Hooks):
1706
"""A dictionary mapping hook name to a list of callables for branch hooks.
1708
e.g. ['set_rh'] Is the list of items to be called when the
1709
set_revision_history function is invoked.
1713
"""Create the default hooks.
1715
These are all empty initially, because by default nothing should get
1718
Hooks.__init__(self)
1719
self.create_hook(HookPoint('set_rh',
1720
"Invoked whenever the revision history has been set via "
1721
"set_revision_history. The api signature is (branch, "
1722
"revision_history), and the branch will be write-locked. "
1723
"The set_rh hook can be expensive for bzr to trigger, a better "
1724
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1725
self.create_hook(HookPoint('open',
1726
"Called with the Branch object that has been opened after a "
1727
"branch is opened.", (1, 8), None))
1728
self.create_hook(HookPoint('post_push',
1729
"Called after a push operation completes. post_push is called "
1730
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1731
"bzr client.", (0, 15), None))
1732
self.create_hook(HookPoint('post_pull',
1733
"Called after a pull operation completes. post_pull is called "
1734
"with a bzrlib.branch.PullResult object and only runs in the "
1735
"bzr client.", (0, 15), None))
1736
self.create_hook(HookPoint('pre_commit',
1737
"Called after a commit is calculated but before it is is "
1738
"completed. pre_commit is called with (local, master, old_revno, "
1739
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1740
"). old_revid is NULL_REVISION for the first commit to a branch, "
1741
"tree_delta is a TreeDelta object describing changes from the "
1742
"basis revision. hooks MUST NOT modify this delta. "
1743
" future_tree is an in-memory tree obtained from "
1744
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1745
"tree.", (0,91), None))
1746
self.create_hook(HookPoint('post_commit',
1747
"Called in the bzr client after a commit has completed. "
1748
"post_commit is called with (local, master, old_revno, old_revid, "
1749
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1750
"commit to a branch.", (0, 15), None))
1751
self.create_hook(HookPoint('post_uncommit',
1752
"Called in the bzr client after an uncommit completes. "
1753
"post_uncommit is called with (local, master, old_revno, "
1754
"old_revid, new_revno, new_revid) where local is the local branch "
1755
"or None, master is the target branch, and an empty branch "
1756
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1757
self.create_hook(HookPoint('pre_change_branch_tip',
1758
"Called in bzr client and server before a change to the tip of a "
1759
"branch is made. pre_change_branch_tip is called with a "
1760
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1761
"commit, uncommit will all trigger this hook.", (1, 6), None))
1762
self.create_hook(HookPoint('post_change_branch_tip',
1763
"Called in bzr client and server after a change to the tip of a "
1764
"branch is made. post_change_branch_tip is called with a "
1765
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1766
"commit, uncommit will all trigger this hook.", (1, 4), None))
1767
self.create_hook(HookPoint('transform_fallback_location',
1768
"Called when a stacked branch is activating its fallback "
1769
"locations. transform_fallback_location is called with (branch, "
1770
"url), and should return a new url. Returning the same url "
1771
"allows it to be used as-is, returning a different one can be "
1772
"used to cause the branch to stack on a closer copy of that "
1773
"fallback_location. Note that the branch cannot have history "
1774
"accessing methods called on it during this hook because the "
1775
"fallback locations have not been activated. When there are "
1776
"multiple hooks installed for transform_fallback_location, "
1777
"all are called with the url returned from the previous hook."
1778
"The order is however undefined.", (1, 9), None))
1779
self.create_hook(HookPoint('automatic_tag_name',
1780
"Called to determine an automatic tag name for a revision."
1781
"automatic_tag_name is called with (branch, revision_id) and "
1782
"should return a tag name or None if no tag name could be "
1783
"determined. The first non-None tag name returned will be used.",
1785
self.create_hook(HookPoint('post_branch_init',
1786
"Called after new branch initialization completes. "
1787
"post_branch_init is called with a "
1788
"bzrlib.branch.BranchInitHookParams. "
1789
"Note that init, branch and checkout (both heavyweight and "
1790
"lightweight) will all trigger this hook.", (2, 2), None))
1791
self.create_hook(HookPoint('post_switch',
1792
"Called after a checkout switches branch. "
1793
"post_switch is called with a "
1794
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1798
# install the default hooks into the Branch class.
1799
Branch.hooks = BranchHooks()
1802
class ChangeBranchTipParams(object):
1803
"""Object holding parameters passed to *_change_branch_tip hooks.
1805
There are 5 fields that hooks may wish to access:
1807
:ivar branch: the branch being changed
1808
:ivar old_revno: revision number before the change
1809
:ivar new_revno: revision number after the change
1810
:ivar old_revid: revision id before the change
1811
:ivar new_revid: revision id after the change
1813
The revid fields are strings. The revno fields are integers.
1816
def __init__(self, branch, old_revno, new_revno, old_revid, new_revid):
1817
"""Create a group of ChangeBranchTip parameters.
1819
:param branch: The branch being changed.
1820
:param old_revno: Revision number before the change.
1821
:param new_revno: Revision number after the change.
1822
:param old_revid: Tip revision id before the change.
1823
:param new_revid: Tip revision id after the change.
1825
self.branch = branch
1826
self.old_revno = old_revno
1827
self.new_revno = new_revno
1828
self.old_revid = old_revid
1829
self.new_revid = new_revid
1831
def __eq__(self, other):
1832
return self.__dict__ == other.__dict__
1835
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1836
self.__class__.__name__, self.branch,
1837
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1840
class BranchInitHookParams(object):
1841
"""Object holding parameters passed to *_branch_init hooks.
1843
There are 4 fields that hooks may wish to access:
1845
:ivar format: the branch format
1846
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1847
:ivar name: name of colocated branch, if any (or None)
1848
:ivar branch: the branch created
1850
Note that for lightweight checkouts, the bzrdir and format fields refer to
1851
the checkout, hence they are different from the corresponding fields in
1852
branch, which refer to the original branch.
1855
def __init__(self, format, a_bzrdir, name, branch):
1856
"""Create a group of BranchInitHook parameters.
1858
:param format: the branch format
1859
:param a_bzrdir: the BzrDir where the branch will be/has been
1861
:param name: name of colocated branch, if any (or None)
1862
:param branch: the branch created
1864
Note that for lightweight checkouts, the bzrdir and format fields refer
1865
to the checkout, hence they are different from the corresponding fields
1866
in branch, which refer to the original branch.
1868
self.format = format
1869
self.bzrdir = a_bzrdir
1871
self.branch = branch
1873
def __eq__(self, other):
1874
return self.__dict__ == other.__dict__
1878
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1880
return "<%s of format:%s bzrdir:%s>" % (
1881
self.__class__.__name__, self.branch,
1882
self.format, self.bzrdir)
1885
class SwitchHookParams(object):
1886
"""Object holding parameters passed to *_switch hooks.
1888
There are 4 fields that hooks may wish to access:
1890
:ivar control_dir: BzrDir of the checkout to change
1891
:ivar to_branch: branch that the checkout is to reference
1892
:ivar force: skip the check for local commits in a heavy checkout
1893
:ivar revision_id: revision ID to switch to (or None)
1896
def __init__(self, control_dir, to_branch, force, revision_id):
1897
"""Create a group of SwitchHook parameters.
1899
:param control_dir: BzrDir of the checkout to change
1900
:param to_branch: branch that the checkout is to reference
1901
:param force: skip the check for local commits in a heavy checkout
1902
:param revision_id: revision ID to switch to (or None)
1904
self.control_dir = control_dir
1905
self.to_branch = to_branch
1907
self.revision_id = revision_id
1909
def __eq__(self, other):
1910
return self.__dict__ == other.__dict__
1913
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1914
self.control_dir, self.to_branch,
716
return self.get_format_string().rstrip()
1918
719
class BzrBranchFormat4(BranchFormat):
1927
728
"""See BranchFormat.get_format_description()."""
1928
729
return "Branch format 4"
1930
def initialize(self, a_bzrdir, name=None):
731
def initialize(self, a_bzrdir):
1931
732
"""Create a branch of this format in a_bzrdir."""
733
mutter('creating branch in %s', a_bzrdir.transport.base)
734
branch_transport = a_bzrdir.get_branch_transport(self)
1932
735
utf8_files = [('revision-history', ''),
1933
736
('branch-name', ''),
1935
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1936
lock_type='branch4', set_format=False)
738
control_files = lockable_files.LockableFiles(branch_transport,
739
'branch-lock', lockable_files.TransportLock)
740
control_files.create_lock()
741
control_files.lock_write()
743
for file, content in utf8_files:
744
control_files.put_utf8(file, content)
746
control_files.unlock()
747
return self.open(a_bzrdir, _found=True)
1938
749
def __init__(self):
1939
750
super(BzrBranchFormat4, self).__init__()
1940
751
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1942
def network_name(self):
1943
"""The network name for this format is the control dirs disk label."""
1944
return self._matchingbzrdir.get_format_string()
753
def open(self, a_bzrdir, _found=False):
754
"""Return the branch object for a_bzrdir
1946
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1947
"""See BranchFormat.open()."""
756
_found is a private parameter, do not use it. It is used to indicate
757
if format probing has already be done.
1949
760
# we are being called directly and must probe.
1950
761
raise NotImplementedError
1951
762
return BzrBranch(_format=self,
1952
763
_control_files=a_bzrdir._control_files,
1953
764
a_bzrdir=a_bzrdir,
1955
765
_repository=a_bzrdir.open_repository())
1957
767
def __str__(self):
1958
768
return "Bazaar-NG branch format 4"
1961
class BranchFormatMetadir(BranchFormat):
1962
"""Common logic for meta-dir based branch formats."""
1964
def _branch_class(self):
1965
"""What class to instantiate on open calls."""
1966
raise NotImplementedError(self._branch_class)
1968
def network_name(self):
1969
"""A simple byte string uniquely identifying this format for RPC calls.
1971
Metadir branch formats use their format string.
1973
return self.get_format_string()
1975
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1976
"""See BranchFormat.open()."""
1978
format = BranchFormat.find_format(a_bzrdir, name=name)
1979
if format.__class__ != self.__class__:
1980
raise AssertionError("wrong format %r found for %r" %
1982
transport = a_bzrdir.get_branch_transport(None, name=name)
1984
control_files = lockable_files.LockableFiles(transport, 'lock',
1986
return self._branch_class()(_format=self,
1987
_control_files=control_files,
1990
_repository=a_bzrdir.find_repository(),
1991
ignore_fallbacks=ignore_fallbacks)
1992
except errors.NoSuchFile:
1993
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1996
super(BranchFormatMetadir, self).__init__()
1997
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1998
self._matchingbzrdir.set_branch_format(self)
2000
def supports_tags(self):
2004
class BzrBranchFormat5(BranchFormatMetadir):
771
class BzrBranchFormat5(BranchFormat):
2005
772
"""Bzr branch format 5.
2007
774
This format has:
2024
788
def get_format_description(self):
2025
789
"""See BranchFormat.get_format_description()."""
2026
790
return "Branch format 5"
2028
def initialize(self, a_bzrdir, name=None):
792
def initialize(self, a_bzrdir):
2029
793
"""Create a branch of this format in a_bzrdir."""
794
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
795
branch_transport = a_bzrdir.get_branch_transport(self)
2030
796
utf8_files = [('revision-history', ''),
2031
797
('branch-name', ''),
2033
return self._initialize_helper(a_bzrdir, utf8_files, name)
2035
def supports_tags(self):
2039
class BzrBranchFormat6(BranchFormatMetadir):
2040
"""Branch format with last-revision and tags.
2042
Unlike previous formats, this has no explicit revision history. Instead,
2043
this just stores the last-revision, and the left-hand history leading
2044
up to there is the history.
2046
This format was introduced in bzr 0.15
2047
and became the default in 0.91.
2050
def _branch_class(self):
2053
def get_format_string(self):
2054
"""See BranchFormat.get_format_string()."""
2055
return "Bazaar Branch Format 6 (bzr 0.15)\n"
2057
def get_format_description(self):
2058
"""See BranchFormat.get_format_description()."""
2059
return "Branch format 6"
2061
def initialize(self, a_bzrdir, name=None):
2062
"""Create a branch of this format in a_bzrdir."""
2063
utf8_files = [('last-revision', '0 null:\n'),
2064
('branch.conf', ''),
2067
return self._initialize_helper(a_bzrdir, utf8_files, name)
2069
def make_tags(self, branch):
2070
"""See bzrlib.branch.BranchFormat.make_tags()."""
2071
return BasicTags(branch)
2073
def supports_set_append_revisions_only(self):
2077
class BzrBranchFormat8(BranchFormatMetadir):
2078
"""Metadir format supporting storing locations of subtree branches."""
2080
def _branch_class(self):
2083
def get_format_string(self):
2084
"""See BranchFormat.get_format_string()."""
2085
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2087
def get_format_description(self):
2088
"""See BranchFormat.get_format_description()."""
2089
return "Branch format 8"
2091
def initialize(self, a_bzrdir, name=None):
2092
"""Create a branch of this format in a_bzrdir."""
2093
utf8_files = [('last-revision', '0 null:\n'),
2094
('branch.conf', ''),
2098
return self._initialize_helper(a_bzrdir, utf8_files, name)
799
control_files = lockable_files.LockableFiles(branch_transport, 'lock',
801
control_files.create_lock()
802
control_files.lock_write()
803
control_files.put_utf8('format', self.get_format_string())
805
for file, content in utf8_files:
806
control_files.put_utf8(file, content)
808
control_files.unlock()
809
return self.open(a_bzrdir, _found=True, )
2100
811
def __init__(self):
2101
super(BzrBranchFormat8, self).__init__()
2102
self._matchingbzrdir.repository_format = \
2103
RepositoryFormatKnitPack5RichRoot()
2105
def make_tags(self, branch):
2106
"""See bzrlib.branch.BranchFormat.make_tags()."""
2107
return BasicTags(branch)
2109
def supports_set_append_revisions_only(self):
2112
def supports_stacking(self):
2115
supports_reference_locations = True
2118
class BzrBranchFormat7(BzrBranchFormat8):
2119
"""Branch format with last-revision, tags, and a stacked location pointer.
2121
The stacked location pointer is passed down to the repository and requires
2122
a repository format with supports_external_lookups = True.
2124
This format was introduced in bzr 1.6.
2127
def initialize(self, a_bzrdir, name=None):
2128
"""Create a branch of this format in a_bzrdir."""
2129
utf8_files = [('last-revision', '0 null:\n'),
2130
('branch.conf', ''),
2133
return self._initialize_helper(a_bzrdir, utf8_files, name)
2135
def _branch_class(self):
2138
def get_format_string(self):
2139
"""See BranchFormat.get_format_string()."""
2140
return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2142
def get_format_description(self):
2143
"""See BranchFormat.get_format_description()."""
2144
return "Branch format 7"
2146
def supports_set_append_revisions_only(self):
2149
supports_reference_locations = False
812
super(BzrBranchFormat5, self).__init__()
813
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
815
def open(self, a_bzrdir, _found=False):
816
"""Return the branch object for a_bzrdir
818
_found is a private parameter, do not use it. It is used to indicate
819
if format probing has already be done.
822
format = BranchFormat.find_format(a_bzrdir)
823
assert format.__class__ == self.__class__
824
transport = a_bzrdir.get_branch_transport(None)
825
control_files = lockable_files.LockableFiles(transport, 'lock',
827
return BzrBranch5(_format=self,
828
_control_files=control_files,
830
_repository=a_bzrdir.find_repository())
833
return "Bazaar-NG Metadir branch format 5"
2152
836
class BranchReferenceFormat(BranchFormat):
2167
851
def get_format_description(self):
2168
852
"""See BranchFormat.get_format_description()."""
2169
853
return "Checkout reference format 1"
2171
def get_reference(self, a_bzrdir):
2172
"""See BranchFormat.get_reference()."""
2173
transport = a_bzrdir.get_branch_transport(None)
2174
return transport.get_bytes('location')
2176
def set_reference(self, a_bzrdir, to_branch):
2177
"""See BranchFormat.set_reference()."""
2178
transport = a_bzrdir.get_branch_transport(None)
2179
location = transport.put_bytes('location', to_branch.base)
2181
def initialize(self, a_bzrdir, name=None, target_branch=None):
855
def initialize(self, a_bzrdir, target_branch=None):
2182
856
"""Create a branch of this format in a_bzrdir."""
2183
857
if target_branch is None:
2184
858
# this format does not implement branch itself, thus the implicit
2185
859
# creation contract must see it as uninitializable
2186
860
raise errors.UninitializableFormat(self)
2187
mutter('creating branch reference in %s', a_bzrdir.user_url)
2188
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
861
mutter('creating branch reference in %s', a_bzrdir.transport.base)
862
branch_transport = a_bzrdir.get_branch_transport(self)
2189
863
branch_transport.put_bytes('location',
2190
target_branch.bzrdir.user_url)
864
target_branch.bzrdir.root_transport.base)
2191
865
branch_transport.put_bytes('format', self.get_format_string())
2193
a_bzrdir, name, _found=True,
2194
possible_transports=[target_branch.bzrdir.root_transport])
2195
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
866
return self.open(a_bzrdir, _found=True)
2198
868
def __init__(self):
2199
869
super(BranchReferenceFormat, self).__init__()
2200
870
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2201
self._matchingbzrdir.set_branch_format(self)
2203
872
def _make_reference_clone_function(format, a_branch):
2204
873
"""Create a clone() routine for a branch dynamically."""
2205
def clone(to_bzrdir, revision_id=None,
2206
repository_policy=None):
874
def clone(to_bzrdir, revision_id=None):
2207
875
"""See Branch.clone()."""
2208
return format.initialize(to_bzrdir, target_branch=a_branch)
876
return format.initialize(to_bzrdir, a_branch)
2209
877
# cannot obey revision_id limits when cloning a reference ...
2210
878
# FIXME RBC 20060210 either nuke revision_id for clone, or
2211
879
# emit some sort of warning/error to the caller ?!
2214
def open(self, a_bzrdir, name=None, _found=False, location=None,
2215
possible_transports=None, ignore_fallbacks=False):
882
def open(self, a_bzrdir, _found=False):
2216
883
"""Return the branch that the branch reference in a_bzrdir points at.
2218
:param a_bzrdir: A BzrDir that contains a branch.
2219
:param name: Name of colocated branch to open, if any
2220
:param _found: a private parameter, do not use it. It is used to
2221
indicate if format probing has already be done.
2222
:param ignore_fallbacks: when set, no fallback branches will be opened
2223
(if there are any). Default is to open fallbacks.
2224
:param location: The location of the referenced branch. If
2225
unspecified, this will be determined from the branch reference in
2227
:param possible_transports: An optional reusable transports list.
885
_found is a private parameter, do not use it. It is used to indicate
886
if format probing has already be done.
2230
format = BranchFormat.find_format(a_bzrdir, name=name)
2231
if format.__class__ != self.__class__:
2232
raise AssertionError("wrong format %r found for %r" %
2234
if location is None:
2235
location = self.get_reference(a_bzrdir)
2236
real_bzrdir = bzrdir.BzrDir.open(
2237
location, possible_transports=possible_transports)
2238
result = real_bzrdir.open_branch(name=name,
2239
ignore_fallbacks=ignore_fallbacks)
889
format = BranchFormat.find_format(a_bzrdir)
890
assert format.__class__ == self.__class__
891
transport = a_bzrdir.get_branch_transport(None)
892
real_bzrdir = bzrdir.BzrDir.open(transport.get('location').read())
893
result = real_bzrdir.open_branch()
2240
894
# this changes the behaviour of result.clone to create a new reference
2241
895
# rather than a copy of the content of the branch.
2242
896
# I did not use a proxy object because that needs much more extensive
2252
network_format_registry = registry.FormatRegistry()
2253
"""Registry of formats indexed by their network name.
2255
The network name for a branch format is an identifier that can be used when
2256
referring to formats with smart server operations. See
2257
BranchFormat.network_name() for more detail.
2261
906
# formats which have no format string are not discoverable
2262
907
# and not independently creatable, so are not registered.
2263
__format5 = BzrBranchFormat5()
2264
__format6 = BzrBranchFormat6()
2265
__format7 = BzrBranchFormat7()
2266
__format8 = BzrBranchFormat8()
2267
BranchFormat.register_format(__format5)
908
__default_format = BzrBranchFormat5()
909
BranchFormat.register_format(__default_format)
2268
910
BranchFormat.register_format(BranchReferenceFormat())
2269
BranchFormat.register_format(__format6)
2270
BranchFormat.register_format(__format7)
2271
BranchFormat.register_format(__format8)
2272
BranchFormat.set_default_format(__format7)
911
BranchFormat.set_default_format(__default_format)
2273
912
_legacy_formats = [BzrBranchFormat4(),
2275
network_format_registry.register(
2276
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2279
class BranchWriteLockResult(object):
2280
"""The result of write locking a branch.
2282
:ivar branch_token: The token obtained from the underlying branch lock, or
2284
:ivar unlock: A callable which will unlock the lock.
2287
def __init__(self, unlock, branch_token):
2288
self.branch_token = branch_token
2289
self.unlock = unlock
2292
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2296
class BzrBranch(Branch, _RelockDebugMixin):
915
class BzrBranch(Branch):
2297
916
"""A branch stored in the actual filesystem.
2299
918
Note that it's "local" in the context of the filesystem; it doesn't
2300
919
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2301
920
it's writable, and can be accessed via the normal filesystem API.
2303
:ivar _transport: Transport for file operations on this branch's
2304
control files, typically pointing to the .bzr/branch directory.
2305
:ivar repository: Repository for this branch.
2306
:ivar base: The url of the base directory for this branch; the one
2307
containing the .bzr directory.
2308
:ivar name: Optional colocated branch name as it exists in the control
2312
def __init__(self, _format=None,
2313
_control_files=None, a_bzrdir=None, name=None,
2314
_repository=None, ignore_fallbacks=False):
2315
"""Create new branch object at a particular location."""
923
def __init__(self, transport=DEPRECATED_PARAMETER, init=DEPRECATED_PARAMETER,
924
relax_version_check=DEPRECATED_PARAMETER, _format=None,
925
_control_files=None, a_bzrdir=None, _repository=None):
926
"""Create new branch object at a particular location.
928
transport -- A Transport object, defining how to access files.
930
init -- If True, create new control files in a previously
931
unversioned directory. If False, the branch must already
934
relax_version_check -- If true, the usual check for the branch
935
version is not applied. This is intended only for
936
upgrade/recovery type use; it's not guaranteed that
937
all operations will work on old format branches.
2316
939
if a_bzrdir is None:
2317
raise ValueError('a_bzrdir must be supplied')
940
self.bzrdir = bzrdir.BzrDir.open(transport.base)
2319
942
self.bzrdir = a_bzrdir
2320
self._base = self.bzrdir.transport.clone('..').base
2322
# XXX: We should be able to just do
2323
# self.base = self.bzrdir.root_transport.base
2324
# but this does not quite work yet -- mbp 20080522
943
self._transport = self.bzrdir.transport.clone('..')
944
self._base = self._transport.base
2325
945
self._format = _format
2326
946
if _control_files is None:
2327
947
raise ValueError('BzrBranch _control_files is None')
2328
948
self.control_files = _control_files
2329
self._transport = _control_files._transport
949
if deprecated_passed(init):
950
warn("BzrBranch.__init__(..., init=XXX): The init parameter is "
951
"deprecated as of bzr 0.8. Please use Branch.create().",
955
# this is slower than before deprecation, oh well never mind.
957
self._initialize(transport.base)
958
self._check_format(_format)
959
if deprecated_passed(relax_version_check):
960
warn("BzrBranch.__init__(..., relax_version_check=XXX_: The "
961
"relax_version_check parameter is deprecated as of bzr 0.8. "
962
"Please use BzrDir.open_downlevel, or a BzrBranchFormat's "
966
if (not relax_version_check
967
and not self._format.is_supported()):
968
raise errors.UnsupportedFormatError(format=fmt)
969
if deprecated_passed(transport):
970
warn("BzrBranch.__init__(transport=XXX...): The transport "
971
"parameter is deprecated as of bzr 0.8. "
972
"Please use Branch.open, or bzrdir.open_branch().",
2330
975
self.repository = _repository
2331
Branch.__init__(self)
2333
977
def __str__(self):
2334
if self.name is None:
2335
return '%s(%s)' % (self.__class__.__name__, self.user_url)
2337
return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
978
return '%s(%r)' % (self.__class__.__name__, self.base)
2340
980
__repr__ = __str__
2342
982
def _get_base(self):
2343
"""Returns the directory containing the control directory."""
2344
983
return self._base
2346
985
base = property(_get_base, doc="The URL for the root of this branch.")
2348
def _get_config(self):
2349
return TransportConfig(self._transport, 'branch.conf')
987
def _finish_transaction(self):
988
"""Exit the current transaction."""
989
return self.control_files._finish_transaction()
991
def get_transaction(self):
992
"""Return the current active transaction.
994
If no transaction is active, this returns a passthrough object
995
for which all data is immediately flushed and no caching happens.
997
# this is an explicit function so that we can do tricky stuff
998
# when the storage in rev_storage is elsewhere.
999
# we probably need to hook the two 'lock a location' and
1000
# 'have a transaction' together more delicately, so that
1001
# we can have two locks (branch and storage) and one transaction
1002
# ... and finishing the transaction unlocks both, but unlocking
1003
# does not. - RBC 20051121
1004
return self.control_files.get_transaction()
1006
def _set_transaction(self, transaction):
1007
"""Set a new active transaction."""
1008
return self.control_files._set_transaction(transaction)
1010
def abspath(self, name):
1011
"""See Branch.abspath."""
1012
return self.control_files._transport.abspath(name)
1014
def _check_format(self, format):
1015
"""Identify the branch format if needed.
1017
The format is stored as a reference to the format object in
1018
self._format for code that needs to check it later.
1020
The format parameter is either None or the branch format class
1021
used to open this branch.
1023
FIXME: DELETE THIS METHOD when pre 0.8 support is removed.
1026
format = BranchFormat.find_format(self.bzrdir)
1027
self._format = format
1028
mutter("got branch format %s", self._format)
1031
def get_root_id(self):
1032
"""See Branch.get_root_id."""
1033
tree = self.repository.revision_tree(self.last_revision())
1034
return tree.inventory.root.file_id
2351
1036
def is_locked(self):
2352
1037
return self.control_files.is_locked()
2354
def lock_write(self, token=None):
2355
"""Lock the branch for write operations.
2357
:param token: A token to permit reacquiring a previously held and
2359
:return: A BranchWriteLockResult.
2361
if not self.is_locked():
2362
self._note_lock('w')
2363
# All-in-one needs to always unlock/lock.
2364
repo_control = getattr(self.repository, 'control_files', None)
2365
if self.control_files == repo_control or not self.is_locked():
2366
self.repository._warn_if_deprecated(self)
2367
self.repository.lock_write()
1039
def lock_write(self):
1040
self.repository.lock_write()
2372
return BranchWriteLockResult(self.unlock,
2373
self.control_files.lock_write(token=token))
1042
self.control_files.lock_write()
2376
self.repository.unlock()
1044
self.repository.unlock()
2379
1047
def lock_read(self):
2380
"""Lock the branch for read operations.
2382
:return: An object with an unlock method which will release the lock
2385
if not self.is_locked():
2386
self._note_lock('r')
2387
# All-in-one needs to always unlock/lock.
2388
repo_control = getattr(self.repository, 'control_files', None)
2389
if self.control_files == repo_control or not self.is_locked():
2390
self.repository._warn_if_deprecated(self)
2391
self.repository.lock_read()
1048
self.repository.lock_read()
2396
1050
self.control_files.lock_read()
2400
self.repository.unlock()
1052
self.repository.unlock()
2403
@only_raises(errors.LockNotHeld, errors.LockBroken)
2404
1055
def unlock(self):
1056
# TODO: test for failed two phase locks. This is known broken.
2406
1058
self.control_files.unlock()
2408
# All-in-one needs to always unlock/lock.
2409
repo_control = getattr(self.repository, 'control_files', None)
2410
if (self.control_files == repo_control or
2411
not self.control_files.is_locked()):
2412
self.repository.unlock()
2413
if not self.control_files.is_locked():
2414
# we just released the lock
2415
self._clear_cached_state()
1060
self.repository.unlock()
2417
1062
def peek_lock_mode(self):
2418
1063
if self.control_files._lock_count == 0:
2428
1073
"""See Branch.print_file."""
2429
1074
return self.repository.print_file(file, revision_id)
2431
def _write_revision_history(self, history):
2432
"""Factored out of set_revision_history.
2434
This performs the actual writing to disk.
2435
It is intended to be called by BzrBranch5.set_revision_history."""
2436
self._transport.put_bytes(
2437
'revision-history', '\n'.join(history),
2438
mode=self.bzrdir._get_file_mode())
1077
def append_revision(self, *revision_ids):
1078
"""See Branch.append_revision."""
1079
for revision_id in revision_ids:
1080
_mod_revision.check_not_reserved_id(revision_id)
1081
mutter("add {%s} to revision-history" % revision_id)
1082
rev_history = self.revision_history()
1083
rev_history.extend(revision_ids)
1084
self.set_revision_history(rev_history)
2440
1086
@needs_write_lock
2441
1087
def set_revision_history(self, rev_history):
2442
1088
"""See Branch.set_revision_history."""
2443
if 'evil' in debug.debug_flags:
2444
mutter_callsite(3, "set_revision_history scales with history.")
2445
check_not_reserved_id = _mod_revision.check_not_reserved_id
2446
for rev_id in rev_history:
2447
check_not_reserved_id(rev_id)
2448
if Branch.hooks['post_change_branch_tip']:
2449
# Don't calculate the last_revision_info() if there are no hooks
2451
old_revno, old_revid = self.last_revision_info()
2452
if len(rev_history) == 0:
2453
revid = _mod_revision.NULL_REVISION
2455
revid = rev_history[-1]
2456
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2457
self._write_revision_history(rev_history)
2458
self._clear_cached_state()
2459
self._cache_revision_history(rev_history)
2460
for hook in Branch.hooks['set_rh']:
2461
hook(self, rev_history)
2462
if Branch.hooks['post_change_branch_tip']:
2463
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2465
def _synchronize_history(self, destination, revision_id):
2466
"""Synchronize last revision and revision history between branches.
2468
This version is most efficient when the destination is also a
2469
BzrBranch5, but works for BzrBranch6 as long as the revision
2470
history is the true lefthand parent history, and all of the revisions
2471
are in the destination's repository. If not, set_revision_history
2474
:param destination: The branch to copy the history into
2475
:param revision_id: The revision-id to truncate history at. May
2476
be None to copy complete history.
2478
if not isinstance(destination._format, BzrBranchFormat5):
2479
super(BzrBranch, self)._synchronize_history(
2480
destination, revision_id)
2482
if revision_id == _mod_revision.NULL_REVISION:
2485
new_history = self.revision_history()
2486
if revision_id is not None and new_history != []:
2488
new_history = new_history[:new_history.index(revision_id) + 1]
2490
rev = self.repository.get_revision(revision_id)
2491
new_history = rev.get_history(self.repository)[1:]
2492
destination.set_revision_history(new_history)
2495
def set_last_revision_info(self, revno, revision_id):
2496
"""Set the last revision of this branch.
2498
The caller is responsible for checking that the revno is correct
2499
for this revision id.
2501
It may be possible to set the branch last revision to an id not
2502
present in the repository. However, branches can also be
2503
configured to check constraints on history, in which case this may not
2506
revision_id = _mod_revision.ensure_null(revision_id)
2507
# this old format stores the full history, but this api doesn't
2508
# provide it, so we must generate, and might as well check it's
2510
history = self._lefthand_history(revision_id)
2511
if len(history) != revno:
2512
raise AssertionError('%d != %d' % (len(history), revno))
2513
self.set_revision_history(history)
2515
def _gen_revision_history(self):
2516
history = self._transport.get_bytes('revision-history').split('\n')
2517
if history[-1:] == ['']:
2518
# There shouldn't be a trailing newline, but just in case.
2523
def generate_revision_history(self, revision_id, last_rev=None,
1089
self.control_files.put_utf8(
1090
'revision-history', '\n'.join(rev_history))
1091
transaction = self.get_transaction()
1092
history = transaction.map.find_revision_history()
1093
if history is not None:
1094
# update the revision history in the identity map.
1095
history[:] = list(rev_history)
1096
# this call is disabled because revision_history is
1097
# not really an object yet, and the transaction is for objects.
1098
# transaction.register_dirty(history)
1100
transaction.map.add_revision_history(rev_history)
1101
# this call is disabled because revision_history is
1102
# not really an object yet, and the transaction is for objects.
1103
# transaction.register_clean(history)
1106
def revision_history(self):
1107
"""See Branch.revision_history."""
1108
transaction = self.get_transaction()
1109
history = transaction.map.find_revision_history()
1110
if history is not None:
1111
# mutter("cache hit for revision-history in %s", self)
1112
return list(history)
1113
decode_utf8 = cache_utf8.decode
1114
history = [decode_utf8(l.rstrip('\r\n')) for l in
1115
self.control_files.get('revision-history').readlines()]
1116
transaction.map.add_revision_history(history)
1117
# this call is disabled because revision_history is
1118
# not really an object yet, and the transaction is for objects.
1119
# transaction.register_clean(history, precious=True)
1120
return list(history)
1123
def generate_revision_history(self, revision_id, last_rev=None,
2524
1124
other_branch=None):
2525
1125
"""Create a new revision history that will finish with revision_id.
2527
1127
:param revision_id: the new tip to use.
2528
1128
:param last_rev: The previous last_revision. If not None, then this
2529
1129
must be a ancestory of revision_id, or DivergedBranches is raised.
2530
1130
:param other_branch: The other branch that DivergedBranches should
2531
1131
raise with respect to.
2533
self.set_revision_history(self._lefthand_history(revision_id,
2534
last_rev, other_branch))
1133
# stop_revision must be a descendant of last_revision
1134
stop_graph = self.repository.get_revision_graph(revision_id)
1135
if last_rev is not None and last_rev not in stop_graph:
1136
# our previous tip is not merged into stop_revision
1137
raise errors.DivergedBranches(self, other_branch)
1138
# make a new revision history from the graph
1139
current_rev_id = revision_id
1141
while current_rev_id not in (None, _mod_revision.NULL_REVISION):
1142
new_history.append(current_rev_id)
1143
current_rev_id_parents = stop_graph[current_rev_id]
1145
current_rev_id = current_rev_id_parents[0]
1147
current_rev_id = None
1148
new_history.reverse()
1149
self.set_revision_history(new_history)
1152
def update_revisions(self, other, stop_revision=None):
1153
"""See Branch.update_revisions."""
1156
if stop_revision is None:
1157
stop_revision = other.last_revision()
1158
if stop_revision is None:
1159
# if there are no commits, we're done.
1161
# whats the current last revision, before we fetch [and change it
1163
last_rev = self.last_revision()
1164
# we fetch here regardless of whether we need to so that we pickup
1166
self.fetch(other, stop_revision)
1167
my_ancestry = self.repository.get_ancestry(last_rev)
1168
if stop_revision in my_ancestry:
1169
# last_revision is a descendant of stop_revision
1171
self.generate_revision_history(stop_revision, last_rev=last_rev,
2536
1176
def basis_tree(self):
2537
1177
"""See Branch.basis_tree."""
2538
1178
return self.repository.revision_tree(self.last_revision())
2540
def _get_parent_location(self):
1180
@deprecated_method(zero_eight)
1181
def working_tree(self):
1182
"""Create a Working tree object for this branch."""
1184
from bzrlib.transport.local import LocalTransport
1185
if (self.base.find('://') != -1 or
1186
not isinstance(self._transport, LocalTransport)):
1187
raise NoWorkingTree(self.base)
1188
return self.bzrdir.open_workingtree()
1191
def pull(self, source, overwrite=False, stop_revision=None):
1192
"""See Branch.pull."""
1195
old_count = len(self.revision_history())
1197
self.update_revisions(source, stop_revision)
1198
except DivergedBranches:
1202
self.set_revision_history(source.revision_history())
1203
new_count = len(self.revision_history())
1204
return new_count - old_count
1208
def get_parent(self):
1209
"""See Branch.get_parent."""
2541
1211
_locs = ['parent', 'pull', 'x-pull']
1212
assert self.base[-1] == '/'
2542
1213
for l in _locs:
2544
return self._transport.get_bytes(l).strip('\n')
2545
except errors.NoSuchFile:
1215
parent = self.control_files.get(l).read().strip('\n')
1218
# This is an old-format absolute path to a local branch
1219
# turn it into a url
1220
if parent.startswith('/'):
1221
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1223
return urlutils.join(self.base[:-1], parent)
1224
except errors.InvalidURLJoin, e:
1225
raise errors.InaccessibleParent(parent, self.base)
2549
def _basic_push(self, target, overwrite, stop_revision):
2550
"""Basic implementation of push without bound branches or hooks.
2552
Must be called with source read locked and target write locked.
2554
result = BranchPushResult()
2555
result.source_branch = self
2556
result.target_branch = target
2557
result.old_revno, result.old_revid = target.last_revision_info()
2558
self.update_references(target)
2559
if result.old_revid != self.last_revision():
2560
# We assume that during 'push' this repository is closer than
2562
graph = self.repository.get_graph(target.repository)
2563
target.update_revisions(self, stop_revision,
2564
overwrite=overwrite, graph=graph)
2565
if self._push_should_merge_tags():
2566
result.tag_conflicts = self.tags.merge_to(target.tags,
2568
result.new_revno, result.new_revid = target.last_revision_info()
2571
def get_stacked_on_url(self):
2572
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1228
def get_push_location(self):
1229
"""See Branch.get_push_location."""
1230
push_loc = self.get_config().get_user_option('push_location')
2574
1233
def set_push_location(self, location):
2575
1234
"""See Branch.set_push_location."""
2666
1382
return self.set_bound_location(None)
2668
1384
@needs_write_lock
2669
def update(self, possible_transports=None):
2670
"""Synchronise this branch with the master branch if any.
1386
"""Synchronise this branch with the master branch if any.
2672
1388
:return: None or the last_revision that was pivoted out during the
2675
master = self.get_master_branch(possible_transports)
1391
master = self.get_master_branch()
2676
1392
if master is not None:
2677
old_tip = _mod_revision.ensure_null(self.last_revision())
1393
old_tip = self.last_revision()
2678
1394
self.pull(master, overwrite=True)
2679
if self.repository.get_graph().is_ancestor(old_tip,
2680
_mod_revision.ensure_null(self.last_revision())):
1395
if old_tip in self.repository.get_ancestry(self.last_revision()):
2686
class BzrBranch8(BzrBranch5):
2687
"""A branch that stores tree-reference locations."""
2689
def _open_hook(self):
2690
if self._ignore_fallbacks:
2693
url = self.get_stacked_on_url()
2694
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2695
errors.UnstackableBranchFormat):
2698
for hook in Branch.hooks['transform_fallback_location']:
2699
url = hook(self, url)
2701
hook_name = Branch.hooks.get_hook_name(hook)
2702
raise AssertionError(
2703
"'transform_fallback_location' hook %s returned "
2704
"None, not a URL." % hook_name)
2705
self._activate_fallback_location(url)
2707
def __init__(self, *args, **kwargs):
2708
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2709
super(BzrBranch8, self).__init__(*args, **kwargs)
2710
self._last_revision_info_cache = None
2711
self._reference_info = None
2713
def _clear_cached_state(self):
2714
super(BzrBranch8, self)._clear_cached_state()
2715
self._last_revision_info_cache = None
2716
self._reference_info = None
2718
def _last_revision_info(self):
2719
revision_string = self._transport.get_bytes('last-revision')
2720
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2721
revision_id = cache_utf8.get_cached_utf8(revision_id)
2723
return revno, revision_id
2725
def _write_last_revision_info(self, revno, revision_id):
2726
"""Simply write out the revision id, with no checks.
2728
Use set_last_revision_info to perform this safely.
2730
Does not update the revision_history cache.
2731
Intended to be called by set_last_revision_info and
2732
_write_revision_history.
2734
revision_id = _mod_revision.ensure_null(revision_id)
2735
out_string = '%d %s\n' % (revno, revision_id)
2736
self._transport.put_bytes('last-revision', out_string,
2737
mode=self.bzrdir._get_file_mode())
2740
def set_last_revision_info(self, revno, revision_id):
2741
revision_id = _mod_revision.ensure_null(revision_id)
2742
old_revno, old_revid = self.last_revision_info()
2743
if self._get_append_revisions_only():
2744
self._check_history_violation(revision_id)
2745
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2746
self._write_last_revision_info(revno, revision_id)
2747
self._clear_cached_state()
2748
self._last_revision_info_cache = revno, revision_id
2749
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2751
def _synchronize_history(self, destination, revision_id):
2752
"""Synchronize last revision and revision history between branches.
2754
:see: Branch._synchronize_history
2756
# XXX: The base Branch has a fast implementation of this method based
2757
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2758
# that uses set_revision_history. This class inherits from BzrBranch5,
2759
# but wants the fast implementation, so it calls
2760
# Branch._synchronize_history directly.
2761
Branch._synchronize_history(self, destination, revision_id)
2763
def _check_history_violation(self, revision_id):
2764
last_revision = _mod_revision.ensure_null(self.last_revision())
2765
if _mod_revision.is_null(last_revision):
2767
if last_revision not in self._lefthand_history(revision_id):
2768
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2770
def _gen_revision_history(self):
2771
"""Generate the revision history from last revision
2773
last_revno, last_revision = self.last_revision_info()
2774
self._extend_partial_history(stop_index=last_revno-1)
2775
return list(reversed(self._partial_revision_history_cache))
2777
def _write_revision_history(self, history):
2778
"""Factored out of set_revision_history.
2780
This performs the actual writing to disk, with format-specific checks.
2781
It is intended to be called by BzrBranch5.set_revision_history.
2783
if len(history) == 0:
2784
last_revision = 'null:'
2786
if history != self._lefthand_history(history[-1]):
2787
raise errors.NotLefthandHistory(history)
2788
last_revision = history[-1]
2789
if self._get_append_revisions_only():
2790
self._check_history_violation(last_revision)
2791
self._write_last_revision_info(len(history), last_revision)
2794
def _set_parent_location(self, url):
2795
"""Set the parent branch"""
2796
self._set_config_location('parent_location', url, make_relative=True)
2799
def _get_parent_location(self):
2800
"""Set the parent branch"""
2801
return self._get_config_location('parent_location')
2804
def _set_all_reference_info(self, info_dict):
2805
"""Replace all reference info stored in a branch.
2807
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2810
writer = rio.RioWriter(s)
2811
for key, (tree_path, branch_location) in info_dict.iteritems():
2812
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2813
branch_location=branch_location)
2814
writer.write_stanza(stanza)
2815
self._transport.put_bytes('references', s.getvalue())
2816
self._reference_info = info_dict
2819
def _get_all_reference_info(self):
2820
"""Return all the reference info stored in a branch.
2822
:return: A dict of {file_id: (tree_path, branch_location)}
2824
if self._reference_info is not None:
2825
return self._reference_info
2826
rio_file = self._transport.get('references')
2828
stanzas = rio.read_stanzas(rio_file)
2829
info_dict = dict((s['file_id'], (s['tree_path'],
2830
s['branch_location'])) for s in stanzas)
2833
self._reference_info = info_dict
2836
def set_reference_info(self, file_id, tree_path, branch_location):
2837
"""Set the branch location to use for a tree reference.
2839
:param file_id: The file-id of the tree reference.
2840
:param tree_path: The path of the tree reference in the tree.
2841
:param branch_location: The location of the branch to retrieve tree
2844
info_dict = self._get_all_reference_info()
2845
info_dict[file_id] = (tree_path, branch_location)
2846
if None in (tree_path, branch_location):
2847
if tree_path is not None:
2848
raise ValueError('tree_path must be None when branch_location'
2850
if branch_location is not None:
2851
raise ValueError('branch_location must be None when tree_path'
2853
del info_dict[file_id]
2854
self._set_all_reference_info(info_dict)
2856
def get_reference_info(self, file_id):
2857
"""Get the tree_path and branch_location for a tree reference.
2859
:return: a tuple of (tree_path, branch_location)
2861
return self._get_all_reference_info().get(file_id, (None, None))
2863
def reference_parent(self, file_id, path, possible_transports=None):
2864
"""Return the parent branch for a tree-reference file_id.
2866
:param file_id: The file_id of the tree reference
2867
:param path: The path of the file_id in the tree
2868
:return: A branch associated with the file_id
2870
branch_location = self.get_reference_info(file_id)[1]
2871
if branch_location is None:
2872
return Branch.reference_parent(self, file_id, path,
2873
possible_transports)
2874
branch_location = urlutils.join(self.user_url, branch_location)
2875
return Branch.open(branch_location,
2876
possible_transports=possible_transports)
2878
def set_push_location(self, location):
2879
"""See Branch.set_push_location."""
2880
self._set_config_location('push_location', location)
2882
def set_bound_location(self, location):
2883
"""See Branch.set_push_location."""
2885
config = self.get_config()
2886
if location is None:
2887
if config.get_user_option('bound') != 'True':
2890
config.set_user_option('bound', 'False', warn_masked=True)
2893
self._set_config_location('bound_location', location,
2895
config.set_user_option('bound', 'True', warn_masked=True)
2898
def _get_bound_location(self, bound):
2899
"""Return the bound location in the config file.
2901
Return None if the bound parameter does not match"""
2902
config = self.get_config()
2903
config_bound = (config.get_user_option('bound') == 'True')
2904
if config_bound != bound:
2906
return self._get_config_location('bound_location', config=config)
2908
def get_bound_location(self):
2909
"""See Branch.set_push_location."""
2910
return self._get_bound_location(True)
2912
def get_old_bound_location(self):
2913
"""See Branch.get_old_bound_location"""
2914
return self._get_bound_location(False)
2916
def get_stacked_on_url(self):
2917
# you can always ask for the URL; but you might not be able to use it
2918
# if the repo can't support stacking.
2919
## self._check_stackable_repo()
2920
stacked_url = self._get_config_location('stacked_on_location')
2921
if stacked_url is None:
2922
raise errors.NotStacked(self)
2925
def _get_append_revisions_only(self):
2926
return self.get_config(
2927
).get_user_option_as_bool('append_revisions_only')
2930
def generate_revision_history(self, revision_id, last_rev=None,
2932
"""See BzrBranch5.generate_revision_history"""
2933
history = self._lefthand_history(revision_id, last_rev, other_branch)
2934
revno = len(history)
2935
self.set_last_revision_info(revno, revision_id)
2938
def get_rev_id(self, revno, history=None):
2939
"""Find the revision id of the specified revno."""
2941
return _mod_revision.NULL_REVISION
2943
last_revno, last_revision_id = self.last_revision_info()
2944
if revno <= 0 or revno > last_revno:
2945
raise errors.NoSuchRevision(self, revno)
2947
if history is not None:
2948
return history[revno - 1]
2950
index = last_revno - revno
2951
if len(self._partial_revision_history_cache) <= index:
2952
self._extend_partial_history(stop_index=index)
2953
if len(self._partial_revision_history_cache) > index:
2954
return self._partial_revision_history_cache[index]
2956
raise errors.NoSuchRevision(self, revno)
2959
def revision_id_to_revno(self, revision_id):
2960
"""Given a revision id, return its revno"""
2961
if _mod_revision.is_null(revision_id):
2964
index = self._partial_revision_history_cache.index(revision_id)
2966
self._extend_partial_history(stop_revision=revision_id)
2967
index = len(self._partial_revision_history_cache) - 1
2968
if self._partial_revision_history_cache[index] != revision_id:
2969
raise errors.NoSuchRevision(self, revision_id)
2970
return self.revno() - index
2973
class BzrBranch7(BzrBranch8):
2974
"""A branch with support for a fallback repository."""
2976
def set_reference_info(self, file_id, tree_path, branch_location):
2977
Branch.set_reference_info(self, file_id, tree_path, branch_location)
2979
def get_reference_info(self, file_id):
2980
Branch.get_reference_info(self, file_id)
2982
def reference_parent(self, file_id, path, possible_transports=None):
2983
return Branch.reference_parent(self, file_id, path,
2984
possible_transports)
2987
class BzrBranch6(BzrBranch7):
2988
"""See BzrBranchFormat6 for the capabilities of this branch.
2990
This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2994
def get_stacked_on_url(self):
2995
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2998
######################################################################
2999
# results of operations
3002
class _Result(object):
3004
def _show_tag_conficts(self, to_file):
3005
if not getattr(self, 'tag_conflicts', None):
3007
to_file.write('Conflicting tags:\n')
3008
for name, value1, value2 in self.tag_conflicts:
3009
to_file.write(' %s\n' % (name, ))
3012
class PullResult(_Result):
3013
"""Result of a Branch.pull operation.
3015
:ivar old_revno: Revision number before pull.
3016
:ivar new_revno: Revision number after pull.
3017
:ivar old_revid: Tip revision id before pull.
3018
:ivar new_revid: Tip revision id after pull.
3019
:ivar source_branch: Source (local) branch object. (read locked)
3020
:ivar master_branch: Master branch of the target, or the target if no
3022
:ivar local_branch: target branch if there is a Master, else None
3023
:ivar target_branch: Target/destination branch object. (write locked)
3024
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3028
# DEPRECATED: pull used to return the change in revno
3029
return self.new_revno - self.old_revno
3031
def report(self, to_file):
3033
if self.old_revid == self.new_revid:
3034
to_file.write('No revisions to pull.\n')
3036
to_file.write('Now on revision %d.\n' % self.new_revno)
3037
self._show_tag_conficts(to_file)
3040
class BranchPushResult(_Result):
3041
"""Result of a Branch.push operation.
3043
:ivar old_revno: Revision number (eg 10) of the target before push.
3044
:ivar new_revno: Revision number (eg 12) of the target after push.
3045
:ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
3047
:ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
3049
:ivar source_branch: Source branch object that the push was from. This is
3050
read locked, and generally is a local (and thus low latency) branch.
3051
:ivar master_branch: If target is a bound branch, the master branch of
3052
target, or target itself. Always write locked.
3053
:ivar target_branch: The direct Branch where data is being sent (write
3055
:ivar local_branch: If the target is a bound branch this will be the
3056
target, otherwise it will be None.
3060
# DEPRECATED: push used to return the change in revno
3061
return self.new_revno - self.old_revno
3063
def report(self, to_file):
3064
"""Write a human-readable description of the result."""
3065
if self.old_revid == self.new_revid:
3066
note('No new revisions to push.')
3068
note('Pushed up to revision %d.' % self.new_revno)
3069
self._show_tag_conficts(to_file)
1401
class BranchTestProviderAdapter(object):
1402
"""A tool to generate a suite testing multiple branch formats at once.
1404
This is done by copying the test once for each transport and injecting
1405
the transport_server, transport_readonly_server, and branch_format
1406
classes into each copy. Each copy is also given a new id() to make it
1410
def __init__(self, transport_server, transport_readonly_server, formats):
1411
self._transport_server = transport_server
1412
self._transport_readonly_server = transport_readonly_server
1413
self._formats = formats
1415
def adapt(self, test):
1416
result = TestSuite()
1417
for branch_format, bzrdir_format in self._formats:
1418
new_test = deepcopy(test)
1419
new_test.transport_server = self._transport_server
1420
new_test.transport_readonly_server = self._transport_readonly_server
1421
new_test.bzrdir_format = bzrdir_format
1422
new_test.branch_format = branch_format
1423
def make_new_test_id():
1424
new_id = "%s(%s)" % (new_test.id(), branch_format.__class__.__name__)
1425
return lambda: new_id
1426
new_test.id = make_new_test_id()
1427
result.addTest(new_test)
3072
1431
class BranchCheckResult(object):
3078
1437
def __init__(self, branch):
3079
1438
self.branch = branch
3082
1440
def report_results(self, verbose):
3083
1441
"""Report the check results via trace.note.
3085
1443
:param verbose: Requests more detailed display of what was checked,
3088
note('checked branch %s format %s', self.branch.user_url,
3089
self.branch._format)
3090
for error in self.errors:
3091
note('found error:%s', error)
3094
class Converter5to6(object):
3095
"""Perform an in-place upgrade of format 5 to format 6"""
3097
def convert(self, branch):
3098
# Data for 5 and 6 can peacefully coexist.
3099
format = BzrBranchFormat6()
3100
new_branch = format.open(branch.bzrdir, _found=True)
3102
# Copy source data into target
3103
new_branch._write_last_revision_info(*branch.last_revision_info())
3104
new_branch.set_parent(branch.get_parent())
3105
new_branch.set_bound_location(branch.get_bound_location())
3106
new_branch.set_push_location(branch.get_push_location())
3108
# New branch has no tags by default
3109
new_branch.tags._set_tag_dict({})
3111
# Copying done; now update target format
3112
new_branch._transport.put_bytes('format',
3113
format.get_format_string(),
3114
mode=new_branch.bzrdir._get_file_mode())
3116
# Clean up old files
3117
new_branch._transport.delete('revision-history')
3119
branch.set_parent(None)
3120
except errors.NoSuchFile:
3122
branch.set_bound_location(None)
3125
class Converter6to7(object):
3126
"""Perform an in-place upgrade of format 6 to format 7"""
3128
def convert(self, branch):
3129
format = BzrBranchFormat7()
3130
branch._set_config_location('stacked_on_location', '')
3131
# update target format
3132
branch._transport.put_bytes('format', format.get_format_string())
3135
class Converter7to8(object):
3136
"""Perform an in-place upgrade of format 6 to format 7"""
3138
def convert(self, branch):
3139
format = BzrBranchFormat8()
3140
branch._transport.put_bytes('references', '')
3141
# update target format
3142
branch._transport.put_bytes('format', format.get_format_string())
3145
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3146
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3149
_run_with_write_locked_target will attempt to release the lock it acquires.
3151
If an exception is raised by callable, then that exception *will* be
3152
propagated, even if the unlock attempt raises its own error. Thus
3153
_run_with_write_locked_target should be preferred to simply doing::
3157
return callable(*args, **kwargs)
3162
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3163
# should share code?
3166
result = callable(*args, **kwargs)
3168
exc_info = sys.exc_info()
3172
raise exc_info[0], exc_info[1], exc_info[2]
3178
class InterBranch(InterObject):
3179
"""This class represents operations taking place between two branches.
3181
Its instances have methods like pull() and push() and contain
3182
references to the source and target repositories these operations
3183
can be carried out on.
3187
"""The available optimised InterBranch types."""
3190
def _get_branch_formats_to_test():
3191
"""Return a tuple with the Branch formats to use when testing."""
3192
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3194
def pull(self, overwrite=False, stop_revision=None,
3195
possible_transports=None, local=False):
3196
"""Mirror source into target branch.
3198
The target branch is considered to be 'local', having low latency.
3200
:returns: PullResult instance
3202
raise NotImplementedError(self.pull)
3204
def update_revisions(self, stop_revision=None, overwrite=False,
3206
"""Pull in new perfect-fit revisions.
3208
:param stop_revision: Updated until the given revision
3209
:param overwrite: Always set the branch pointer, rather than checking
3210
to see if it is a proper descendant.
3211
:param graph: A Graph object that can be used to query history
3212
information. This can be None.
3215
raise NotImplementedError(self.update_revisions)
3217
def push(self, overwrite=False, stop_revision=None,
3218
_override_hook_source_branch=None):
3219
"""Mirror the source branch into the target branch.
3221
The source branch is considered to be 'local', having low latency.
3223
raise NotImplementedError(self.push)
3226
class GenericInterBranch(InterBranch):
3227
"""InterBranch implementation that uses public Branch functions.
3231
def _get_branch_formats_to_test():
3232
return BranchFormat._default_format, BranchFormat._default_format
3234
def update_revisions(self, stop_revision=None, overwrite=False,
3236
"""See InterBranch.update_revisions()."""
3237
self.source.lock_read()
3239
other_revno, other_last_revision = self.source.last_revision_info()
3240
stop_revno = None # unknown
3241
if stop_revision is None:
3242
stop_revision = other_last_revision
3243
if _mod_revision.is_null(stop_revision):
3244
# if there are no commits, we're done.
3246
stop_revno = other_revno
3248
# what's the current last revision, before we fetch [and change it
3250
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3251
# we fetch here so that we don't process data twice in the common
3252
# case of having something to pull, and so that the check for
3253
# already merged can operate on the just fetched graph, which will
3254
# be cached in memory.
3255
self.target.fetch(self.source, stop_revision)
3256
# Check to see if one is an ancestor of the other
3259
graph = self.target.repository.get_graph()
3260
if self.target._check_if_descendant_or_diverged(
3261
stop_revision, last_rev, graph, self.source):
3262
# stop_revision is a descendant of last_rev, but we aren't
3263
# overwriting, so we're done.
3265
if stop_revno is None:
3267
graph = self.target.repository.get_graph()
3268
this_revno, this_last_revision = \
3269
self.target.last_revision_info()
3270
stop_revno = graph.find_distance_to_null(stop_revision,
3271
[(other_last_revision, other_revno),
3272
(this_last_revision, this_revno)])
3273
self.target.set_last_revision_info(stop_revno, stop_revision)
3275
self.source.unlock()
3277
def pull(self, overwrite=False, stop_revision=None,
3278
possible_transports=None, _hook_master=None, run_hooks=True,
3279
_override_hook_target=None, local=False):
3282
:param _hook_master: Private parameter - set the branch to
3283
be supplied as the master to pull hooks.
3284
:param run_hooks: Private parameter - if false, this branch
3285
is being called because it's the master of the primary branch,
3286
so it should not run its hooks.
3287
:param _override_hook_target: Private parameter - set the branch to be
3288
supplied as the target_branch to pull hooks.
3289
:param local: Only update the local branch, and not the bound branch.
3291
# This type of branch can't be bound.
3293
raise errors.LocalRequiresBoundBranch()
3294
result = PullResult()
3295
result.source_branch = self.source
3296
if _override_hook_target is None:
3297
result.target_branch = self.target
3299
result.target_branch = _override_hook_target
3300
self.source.lock_read()
3302
# We assume that during 'pull' the target repository is closer than
3304
self.source.update_references(self.target)
3305
graph = self.target.repository.get_graph(self.source.repository)
3306
# TODO: Branch formats should have a flag that indicates
3307
# that revno's are expensive, and pull() should honor that flag.
3309
result.old_revno, result.old_revid = \
3310
self.target.last_revision_info()
3311
self.target.update_revisions(self.source, stop_revision,
3312
overwrite=overwrite, graph=graph)
3313
# TODO: The old revid should be specified when merging tags,
3314
# so a tags implementation that versions tags can only
3315
# pull in the most recent changes. -- JRV20090506
3316
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3318
result.new_revno, result.new_revid = self.target.last_revision_info()
3320
result.master_branch = _hook_master
3321
result.local_branch = result.target_branch
3323
result.master_branch = result.target_branch
3324
result.local_branch = None
3326
for hook in Branch.hooks['post_pull']:
3329
self.source.unlock()
3332
def push(self, overwrite=False, stop_revision=None,
3333
_override_hook_source_branch=None):
3334
"""See InterBranch.push.
3336
This is the basic concrete implementation of push()
3338
:param _override_hook_source_branch: If specified, run
3339
the hooks passing this Branch as the source, rather than self.
3340
This is for use of RemoteBranch, where push is delegated to the
3341
underlying vfs-based Branch.
3343
# TODO: Public option to disable running hooks - should be trivial but
3345
self.source.lock_read()
3347
return _run_with_write_locked_target(
3348
self.target, self._push_with_bound_branches, overwrite,
3350
_override_hook_source_branch=_override_hook_source_branch)
3352
self.source.unlock()
3354
def _push_with_bound_branches(self, overwrite, stop_revision,
3355
_override_hook_source_branch=None):
3356
"""Push from source into target, and into target's master if any.
3359
if _override_hook_source_branch:
3360
result.source_branch = _override_hook_source_branch
3361
for hook in Branch.hooks['post_push']:
3364
bound_location = self.target.get_bound_location()
3365
if bound_location and self.target.base != bound_location:
3366
# there is a master branch.
3368
# XXX: Why the second check? Is it even supported for a branch to
3369
# be bound to itself? -- mbp 20070507
3370
master_branch = self.target.get_master_branch()
3371
master_branch.lock_write()
3373
# push into the master from the source branch.
3374
self.source._basic_push(master_branch, overwrite, stop_revision)
3375
# and push into the target branch from the source. Note that we
3376
# push from the source branch again, because its considered the
3377
# highest bandwidth repository.
3378
result = self.source._basic_push(self.target, overwrite,
3380
result.master_branch = master_branch
3381
result.local_branch = self.target
3385
master_branch.unlock()
3388
result = self.source._basic_push(self.target, overwrite,
3390
# TODO: Why set master_branch and local_branch if there's no
3391
# binding? Maybe cleaner to just leave them unset? -- mbp
3393
result.master_branch = self.target
3394
result.local_branch = None
3399
def is_compatible(self, source, target):
3400
# GenericBranch uses the public API, so always compatible
3404
class InterToBranch5(GenericInterBranch):
3407
def _get_branch_formats_to_test():
3408
return BranchFormat._default_format, BzrBranchFormat5()
3410
def pull(self, overwrite=False, stop_revision=None,
3411
possible_transports=None, run_hooks=True,
3412
_override_hook_target=None, local=False):
3413
"""Pull from source into self, updating my master if any.
3415
:param run_hooks: Private parameter - if false, this branch
3416
is being called because it's the master of the primary branch,
3417
so it should not run its hooks.
3419
bound_location = self.target.get_bound_location()
3420
if local and not bound_location:
3421
raise errors.LocalRequiresBoundBranch()
3422
master_branch = None
3423
if not local and bound_location and self.source.user_url != bound_location:
3424
# not pulling from master, so we need to update master.
3425
master_branch = self.target.get_master_branch(possible_transports)
3426
master_branch.lock_write()
3429
# pull from source into master.
3430
master_branch.pull(self.source, overwrite, stop_revision,
3432
return super(InterToBranch5, self).pull(overwrite,
3433
stop_revision, _hook_master=master_branch,
3434
run_hooks=run_hooks,
3435
_override_hook_target=_override_hook_target)
3438
master_branch.unlock()
3441
InterBranch.register_optimiser(GenericInterBranch)
3442
InterBranch.register_optimiser(InterToBranch5)
1446
note('checked branch %s format %s',
1448
self.branch._format)
1451
######################################################################
1455
@deprecated_function(zero_eight)
1456
def is_control_file(*args, **kwargs):
1457
"""See bzrlib.workingtree.is_control_file."""
1458
from bzrlib import workingtree
1459
return workingtree.is_control_file(*args, **kwargs)
added
removed
bzrlib/branch.py
