188
142
possible_transports)
189
143
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()
199
145
def get_config(self):
200
146
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()
149
return self.get_config().get_nickname()
251
151
def _set_nick(self, nick):
252
152
self.get_config().set_user_option('nickname', nick, warn_masked=True)
310
173
raise NotImplementedError(self.get_physical_lock_status)
313
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
314
"""Return the revision_id for a dotted revno.
316
:param revno: a tuple like (1,) or (1,1,2)
317
:param _cache_reverse: a private parameter enabling storage
318
of the reverse mapping in a top level cache. (This should
319
only be done in selective circumstances as we want to
320
avoid having the mapping cached multiple times.)
321
:return: the revision_id
322
:raises errors.NoSuchRevision: if the revno doesn't exist
324
rev_id = self._do_dotted_revno_to_revision_id(revno)
326
self._partial_revision_id_to_revno_cache[rev_id] = revno
329
def _do_dotted_revno_to_revision_id(self, revno):
330
"""Worker function for dotted_revno_to_revision_id.
332
Subclasses should override this if they wish to
333
provide a more efficient implementation.
336
return self.get_rev_id(revno[0])
337
revision_id_to_revno = self.get_revision_id_to_revno_map()
338
revision_ids = [revision_id for revision_id, this_revno
339
in revision_id_to_revno.iteritems()
340
if revno == this_revno]
341
if len(revision_ids) == 1:
342
return revision_ids[0]
344
revno_str = '.'.join(map(str, revno))
345
raise errors.NoSuchRevision(self, revno_str)
348
def revision_id_to_dotted_revno(self, revision_id):
349
"""Given a revision id, return its dotted revno.
351
:return: a tuple like (1,) or (400,1,3).
353
return self._do_revision_id_to_dotted_revno(revision_id)
355
def _do_revision_id_to_dotted_revno(self, revision_id):
356
"""Worker function for revision_id_to_revno."""
357
# Try the caches if they are loaded
358
result = self._partial_revision_id_to_revno_cache.get(revision_id)
359
if result is not None:
361
if self._revision_id_to_revno_cache:
362
result = self._revision_id_to_revno_cache.get(revision_id)
364
raise errors.NoSuchRevision(self, revision_id)
365
# Try the mainline as it's optimised
367
revno = self.revision_id_to_revno(revision_id)
369
except errors.NoSuchRevision:
370
# We need to load and use the full revno map after all
371
result = self.get_revision_id_to_revno_map().get(revision_id)
373
raise errors.NoSuchRevision(self, revision_id)
377
176
def get_revision_id_to_revno_map(self):
378
177
"""Return the revision_id => dotted revno map.
404
203
:return: A dictionary mapping revision_id => dotted revno.
205
last_revision = self.last_revision()
206
revision_graph = repository._old_get_graph(self.repository,
208
merge_sorted_revisions = tsort.merge_sort(
406
213
revision_id_to_revno = dict((rev_id, revno)
407
for rev_id, depth, revno, end_of_merge
408
in self.iter_merge_sorted_revisions())
214
for seq_num, rev_id, depth, revno, end_of_merge
215
in merge_sorted_revisions)
409
216
return revision_id_to_revno
412
def iter_merge_sorted_revisions(self, start_revision_id=None,
413
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
414
"""Walk the revisions for a branch in merge sorted order.
416
Merge sorted order is the output from a merge-aware,
417
topological sort, i.e. all parents come before their
418
children going forward; the opposite for reverse.
420
:param start_revision_id: the revision_id to begin walking from.
421
If None, the branch tip is used.
422
:param stop_revision_id: the revision_id to terminate the walk
423
after. If None, the rest of history is included.
424
:param stop_rule: if stop_revision_id is not None, the precise rule
425
to use for termination:
426
* 'exclude' - leave the stop revision out of the result (default)
427
* 'include' - the stop revision is the last item in the result
428
* 'with-merges' - include the stop revision and all of its
429
merged revisions in the result
430
* 'with-merges-without-common-ancestry' - filter out revisions
431
that are in both ancestries
432
:param direction: either 'reverse' or 'forward':
433
* reverse means return the start_revision_id first, i.e.
434
start at the most recent revision and go backwards in history
435
* forward returns tuples in the opposite order to reverse.
436
Note in particular that forward does *not* do any intelligent
437
ordering w.r.t. depth as some clients of this API may like.
438
(If required, that ought to be done at higher layers.)
440
:return: an iterator over (revision_id, depth, revno, end_of_merge)
443
* revision_id: the unique id of the revision
444
* depth: How many levels of merging deep this node has been
446
* revno_sequence: This field provides a sequence of
447
revision numbers for all revisions. The format is:
448
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
449
branch that the revno is on. From left to right the REVNO numbers
450
are the sequence numbers within that branch of the revision.
451
* end_of_merge: When True the next node (earlier in history) is
452
part of a different merge.
454
# Note: depth and revno values are in the context of the branch so
455
# we need the full graph to get stable numbers, regardless of the
457
if self._merge_sorted_revisions_cache is None:
458
last_revision = self.last_revision()
459
known_graph = self.repository.get_known_graph_ancestry(
461
self._merge_sorted_revisions_cache = known_graph.merge_sort(
463
filtered = self._filter_merge_sorted_revisions(
464
self._merge_sorted_revisions_cache, start_revision_id,
465
stop_revision_id, stop_rule)
466
# Make sure we don't return revisions that are not part of the
467
# start_revision_id ancestry.
468
filtered = self._filter_start_non_ancestors(filtered)
469
if direction == 'reverse':
471
if direction == 'forward':
472
return reversed(list(filtered))
474
raise ValueError('invalid direction %r' % direction)
476
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
477
start_revision_id, stop_revision_id, stop_rule):
478
"""Iterate over an inclusive range of sorted revisions."""
479
rev_iter = iter(merge_sorted_revisions)
480
if start_revision_id is not None:
481
for node in rev_iter:
482
rev_id = node.key[-1]
483
if rev_id != start_revision_id:
486
# The decision to include the start or not
487
# depends on the stop_rule if a stop is provided
488
# so pop this node back into the iterator
489
rev_iter = chain(iter([node]), rev_iter)
491
if stop_revision_id is None:
493
for node in rev_iter:
494
rev_id = node.key[-1]
495
yield (rev_id, node.merge_depth, node.revno,
497
elif stop_rule == 'exclude':
498
for node in rev_iter:
499
rev_id = node.key[-1]
500
if rev_id == stop_revision_id:
502
yield (rev_id, node.merge_depth, node.revno,
504
elif stop_rule == 'include':
505
for node in rev_iter:
506
rev_id = node.key[-1]
507
yield (rev_id, node.merge_depth, node.revno,
509
if rev_id == stop_revision_id:
511
elif stop_rule == 'with-merges-without-common-ancestry':
512
# We want to exclude all revisions that are already part of the
513
# stop_revision_id ancestry.
514
graph = self.repository.get_graph()
515
ancestors = graph.find_unique_ancestors(start_revision_id,
517
for node in rev_iter:
518
rev_id = node.key[-1]
519
if rev_id not in ancestors:
521
yield (rev_id, node.merge_depth, node.revno,
523
elif stop_rule == 'with-merges':
524
stop_rev = self.repository.get_revision(stop_revision_id)
525
if stop_rev.parent_ids:
526
left_parent = stop_rev.parent_ids[0]
528
left_parent = _mod_revision.NULL_REVISION
529
# left_parent is the actual revision we want to stop logging at,
530
# since we want to show the merged revisions after the stop_rev too
531
reached_stop_revision_id = False
532
revision_id_whitelist = []
533
for node in rev_iter:
534
rev_id = node.key[-1]
535
if rev_id == left_parent:
536
# reached the left parent after the stop_revision
538
if (not reached_stop_revision_id or
539
rev_id in revision_id_whitelist):
540
yield (rev_id, node.merge_depth, node.revno,
542
if reached_stop_revision_id or rev_id == stop_revision_id:
543
# only do the merged revs of rev_id from now on
544
rev = self.repository.get_revision(rev_id)
546
reached_stop_revision_id = True
547
revision_id_whitelist.extend(rev.parent_ids)
549
raise ValueError('invalid stop_rule %r' % stop_rule)
551
def _filter_start_non_ancestors(self, rev_iter):
552
# If we started from a dotted revno, we want to consider it as a tip
553
# and don't want to yield revisions that are not part of its
554
# ancestry. Given the order guaranteed by the merge sort, we will see
555
# uninteresting descendants of the first parent of our tip before the
557
first = rev_iter.next()
558
(rev_id, merge_depth, revno, end_of_merge) = first
561
# We start at a mainline revision so by definition, all others
562
# revisions in rev_iter are ancestors
563
for node in rev_iter:
568
pmap = self.repository.get_parent_map([rev_id])
569
parents = pmap.get(rev_id, [])
571
whitelist.update(parents)
573
# If there is no parents, there is nothing of interest left
575
# FIXME: It's hard to test this scenario here as this code is never
576
# called in that case. -- vila 20100322
579
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
581
if rev_id in whitelist:
582
pmap = self.repository.get_parent_map([rev_id])
583
parents = pmap.get(rev_id, [])
584
whitelist.remove(rev_id)
585
whitelist.update(parents)
587
# We've reached the mainline, there is nothing left to
591
# A revision that is not part of the ancestry of our
594
yield (rev_id, merge_depth, revno, end_of_merge)
596
218
def leave_lock_in_place(self):
597
219
"""Tell this branch object not to release the physical lock when this
598
220
object is unlocked.
600
222
If lock_write doesn't return a token, then this method is not supported.
602
224
self.control_files.leave_in_place()
756
348
:raises UnstackableRepositoryFormat: If the repository does not support
759
if not self._format.supports_stacking():
760
raise errors.UnstackableBranchFormat(self._format, self.user_url)
761
# XXX: Changing from one fallback repository to another does not check
762
# that all the data you need is present in the new fallback.
763
# Possibly it should.
764
self._check_stackable_repo()
767
old_url = self.get_stacked_on_url()
768
except (errors.NotStacked, errors.UnstackableBranchFormat,
769
errors.UnstackableRepositoryFormat):
773
self._activate_fallback_location(url)
774
# write this out after the repository is stacked to avoid setting a
775
# stacked config that doesn't work.
776
self._set_config_location('stacked_on_location', url)
779
"""Change a branch to be unstacked, copying data as needed.
781
Don't call this directly, use set_stacked_on_url(None).
783
pb = ui.ui_factory.nested_progress_bar()
785
pb.update("Unstacking")
786
# The basic approach here is to fetch the tip of the branch,
787
# including all available ghosts, from the existing stacked
788
# repository into a new repository object without the fallbacks.
790
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
791
# correct for CHKMap repostiories
792
old_repository = self.repository
793
if len(old_repository._fallback_repositories) != 1:
794
raise AssertionError("can't cope with fallback repositories "
795
"of %r" % (self.repository,))
796
# unlock it, including unlocking the fallback
797
old_repository.unlock()
798
old_repository.lock_read()
800
# Repositories don't offer an interface to remove fallback
801
# repositories today; take the conceptually simpler option and just
802
# reopen it. We reopen it starting from the URL so that we
803
# get a separate connection for RemoteRepositories and can
804
# stream from one of them to the other. This does mean doing
805
# separate SSH connection setup, but unstacking is not a
806
# common operation so it's tolerable.
807
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
808
new_repository = new_bzrdir.find_repository()
809
self.repository = new_repository
810
if self.repository._fallback_repositories:
811
raise AssertionError("didn't expect %r to have "
812
"fallback_repositories"
813
% (self.repository,))
814
# this is not paired with an unlock because it's just restoring
815
# the previous state; the lock's released when set_stacked_on_url
817
self.repository.lock_write()
818
# XXX: If you unstack a branch while it has a working tree
819
# with a pending merge, the pending-merged revisions will no
820
# longer be present. You can (probably) revert and remerge.
822
# XXX: This only fetches up to the tip of the repository; it
823
# doesn't bring across any tags. That's fairly consistent
824
# with how branch works, but perhaps not ideal.
825
self.repository.fetch(old_repository,
826
revision_id=self.last_revision(),
829
old_repository.unlock()
833
def _set_tags_bytes(self, bytes):
834
"""Mirror method for _get_tags_bytes.
836
:seealso: Branch._get_tags_bytes.
838
return _run_with_write_locked_target(self, self._transport.put_bytes,
351
raise NotImplementedError(self.set_stacked_on_url)
841
353
def _cache_revision_history(self, rev_history):
842
354
"""Set the cached revision history to rev_history.
974
487
information. This can be None.
977
return InterBranch.get(other, self).update_revisions(stop_revision,
980
def import_last_revision_info(self, source_repo, revno, revid):
981
"""Set the last revision info, importing from another repo if necessary.
983
This is used by the bound branch code to upload a revision to
984
the master branch first before updating the tip of the local branch.
986
:param source_repo: Source repository to optionally fetch from
987
:param revno: Revision number of the new tip
988
:param revid: Revision id of the new tip
990
if not self.repository.has_same_location(source_repo):
991
self.repository.fetch(source_repo, revision_id=revid)
992
self.set_last_revision_info(revno, revid)
492
other_revno, other_last_revision = other.last_revision_info()
493
stop_revno = None # unknown
494
if stop_revision is None:
495
stop_revision = other_last_revision
496
if _mod_revision.is_null(stop_revision):
497
# if there are no commits, we're done.
499
stop_revno = other_revno
501
# what's the current last revision, before we fetch [and change it
503
last_rev = _mod_revision.ensure_null(self.last_revision())
504
# we fetch here so that we don't process data twice in the common
505
# case of having something to pull, and so that the check for
506
# already merged can operate on the just fetched graph, which will
507
# be cached in memory.
508
self.fetch(other, stop_revision)
509
# Check to see if one is an ancestor of the other
512
graph = self.repository.get_graph()
513
if self._check_if_descendant_or_diverged(
514
stop_revision, last_rev, graph, other):
515
# stop_revision is a descendant of last_rev, but we aren't
516
# overwriting, so we're done.
518
if stop_revno is None:
520
graph = self.repository.get_graph()
521
this_revno, this_last_revision = self.last_revision_info()
522
stop_revno = graph.find_distance_to_null(stop_revision,
523
[(other_last_revision, other_revno),
524
(this_last_revision, this_revno)])
525
self.set_last_revision_info(stop_revno, stop_revision)
994
529
def revision_id_to_revno(self, revision_id):
995
530
"""Given a revision id, return its revno"""
1001
536
except ValueError:
1002
537
raise errors.NoSuchRevision(self, revision_id)
1005
539
def get_rev_id(self, revno, history=None):
1006
540
"""Find the revision id of the specified revno."""
1008
542
return _mod_revision.NULL_REVISION
1009
last_revno, last_revid = self.last_revision_info()
1010
if revno == last_revno:
1012
if revno <= 0 or revno > last_revno:
544
history = self.revision_history()
545
if revno <= 0 or revno > len(history):
1013
546
raise errors.NoSuchRevision(self, revno)
1014
distance_from_last = last_revno - revno
1015
if len(self._partial_revision_history_cache) <= distance_from_last:
1016
self._extend_partial_history(distance_from_last)
1017
return self._partial_revision_history_cache[distance_from_last]
547
return history[revno - 1]
1020
549
def pull(self, source, overwrite=False, stop_revision=None,
1021
possible_transports=None, *args, **kwargs):
550
possible_transports=None, _override_hook_target=None):
1022
551
"""Mirror source into this branch.
1024
553
This branch is considered to be 'local', having low latency.
1026
555
:returns: PullResult instance
1028
return InterBranch.get(source, self).pull(overwrite=overwrite,
1029
stop_revision=stop_revision,
1030
possible_transports=possible_transports, *args, **kwargs)
557
raise NotImplementedError(self.pull)
1032
def push(self, target, overwrite=False, stop_revision=None, *args,
559
def push(self, target, overwrite=False, stop_revision=None):
1034
560
"""Mirror this branch into target.
1036
562
This branch is considered to be 'local', having low latency.
1038
return InterBranch.get(self, target).push(overwrite, stop_revision,
1041
def lossy_push(self, target, stop_revision=None):
1042
"""Push deltas into another branch.
1044
:note: This does not, like push, retain the revision ids from
1045
the source branch and will, rather than adding bzr-specific
1046
metadata, push only those semantics of the revision that can be
1047
natively represented by this branch' VCS.
1049
:param target: Target branch
1050
:param stop_revision: Revision to push, defaults to last revision.
1051
:return: BranchPushResult with an extra member revidmap:
1052
A dictionary mapping revision ids from the target branch
1053
to new revision ids in the target branch, for each
1054
revision that was pushed.
1056
inter = InterBranch.get(self, target)
1057
lossy_push = getattr(inter, "lossy_push", None)
1058
if lossy_push is None:
1059
raise errors.LossyPushToSameVCS(self, target)
1060
return lossy_push(stop_revision)
564
raise NotImplementedError(self.push)
1062
566
def basis_tree(self):
1063
567
"""Return `Tree` object for last revision."""
1198
666
raise errors.InvalidRevisionNumber(revno)
1200
668
@needs_read_lock
1201
def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
669
def clone(self, to_bzrdir, revision_id=None):
1202
670
"""Clone this branch into to_bzrdir preserving all semantic values.
1204
Most API users will want 'create_clone_on_transport', which creates a
1205
new bzrdir and branch on the fly.
1207
672
revision_id: if not None, the revision history in the new branch will
1208
673
be truncated to end with revision_id.
1210
result = to_bzrdir.create_branch()
1213
if repository_policy is not None:
1214
repository_policy.configure_branch(result)
1215
self.copy_content_into(result, revision_id=revision_id)
675
result = self._format.initialize(to_bzrdir)
676
self.copy_content_into(result, revision_id=revision_id)
1220
679
@needs_read_lock
1221
def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
680
def sprout(self, to_bzrdir, revision_id=None):
1222
681
"""Create a new line of development from the branch, into to_bzrdir.
1224
to_bzrdir controls the branch format.
1226
683
revision_id: if not None, the revision history in the new branch will
1227
684
be truncated to end with revision_id.
1229
if (repository_policy is not None and
1230
repository_policy.requires_stacking()):
1231
to_bzrdir._format.require_stacking(_skip_repo=True)
1232
result = to_bzrdir.create_branch()
1235
if repository_policy is not None:
1236
repository_policy.configure_branch(result)
1237
self.copy_content_into(result, revision_id=revision_id)
1238
result.set_parent(self.bzrdir.root_transport.base)
686
result = self._format.initialize(to_bzrdir)
687
self.copy_content_into(result, revision_id=revision_id)
688
result.set_parent(self.bzrdir.root_transport.base)
1243
691
def _synchronize_history(self, destination, revision_id):
1244
692
"""Synchronize last revision and revision history between branches.
1246
694
This version is most efficient when the destination is also a
1247
BzrBranch6, but works for BzrBranch5, as long as the destination's
1248
repository contains all the lefthand ancestors of the intended
1249
last_revision. If not, set_last_revision_info will fail.
695
BzrBranch5, but works for BzrBranch6 as long as the revision
696
history is the true lefthand parent history, and all of the revisions
697
are in the destination's repository. If not, set_revision_history
1251
700
:param destination: The branch to copy the history into
1252
701
:param revision_id: The revision-id to truncate history at. May
1253
702
be None to copy complete history.
1255
source_revno, source_revision_id = self.last_revision_info()
1256
if revision_id is None:
1257
revno, revision_id = source_revno, source_revision_id
1259
graph = self.repository.get_graph()
704
if revision_id == _mod_revision.NULL_REVISION:
706
new_history = self.revision_history()
707
if revision_id is not None and new_history != []:
1261
revno = graph.find_distance_to_null(revision_id,
1262
[(source_revision_id, source_revno)])
1263
except errors.GhostRevisionsHaveNoRevno:
1264
# Default to 1, if we can't find anything else
1266
destination.set_last_revision_info(revno, revision_id)
709
new_history = new_history[:new_history.index(revision_id) + 1]
711
rev = self.repository.get_revision(revision_id)
712
new_history = rev.get_history(self.repository)[1:]
713
destination.set_revision_history(new_history)
1268
715
@needs_read_lock
1269
716
def copy_content_into(self, destination, revision_id=None):
1283
729
destination.set_parent(parent)
1284
if self._push_should_merge_tags():
1285
self.tags.merge_to(destination.tags)
1287
def update_references(self, target):
1288
if not getattr(self._format, 'supports_reference_locations', False):
1290
reference_dict = self._get_all_reference_info()
1291
if len(reference_dict) == 0:
1293
old_base = self.base
1294
new_base = target.base
1295
target_reference_dict = target._get_all_reference_info()
1296
for file_id, (tree_path, branch_location) in (
1297
reference_dict.items()):
1298
branch_location = urlutils.rebase_url(branch_location,
1300
target_reference_dict.setdefault(
1301
file_id, (tree_path, branch_location))
1302
target._set_all_reference_info(target_reference_dict)
730
self.tags.merge_to(destination.tags)
1304
732
@needs_read_lock
1305
def check(self, refs):
1306
734
"""Check consistency of the branch.
1308
736
In particular this checks that revisions given in the revision-history
1309
do actually match up in the revision graph, and that they're all
737
do actually match up in the revision graph, and that they're all
1310
738
present in the repository.
1312
740
Callers will typically also want to check the repository.
1314
:param refs: Calculated refs for this branch as specified by
1315
branch._get_check_refs()
1316
742
:return: A BranchCheckResult.
1318
result = BranchCheckResult(self)
744
mainline_parent_id = None
1319
745
last_revno, last_revision_id = self.last_revision_info()
1320
actual_revno = refs[('lefthand-distance', last_revision_id)]
1321
if actual_revno != last_revno:
1322
result.errors.append(errors.BzrCheckError(
1323
'revno does not match len(mainline) %s != %s' % (
1324
last_revno, actual_revno)))
1325
# TODO: We should probably also check that self.revision_history
1326
# matches the repository for older branch formats.
1327
# If looking for the code that cross-checks repository parents against
1328
# the iter_reverse_revision_history output, that is now a repository
746
real_rev_history = list(self.repository.iter_reverse_revision_history(
748
real_rev_history.reverse()
749
if len(real_rev_history) != last_revno:
750
raise errors.BzrCheckError('revno does not match len(mainline)'
751
' %s != %s' % (last_revno, len(real_rev_history)))
752
# TODO: We should probably also check that real_rev_history actually
753
# matches self.revision_history()
754
for revision_id in real_rev_history:
756
revision = self.repository.get_revision(revision_id)
757
except errors.NoSuchRevision, e:
758
raise errors.BzrCheckError("mainline revision {%s} not in repository"
760
# In general the first entry on the revision history has no parents.
761
# But it's not illegal for it to have parents listed; this can happen
762
# in imports from Arch when the parents weren't reachable.
763
if mainline_parent_id is not None:
764
if mainline_parent_id not in revision.parent_ids:
765
raise errors.BzrCheckError("previous revision {%s} not listed among "
767
% (mainline_parent_id, revision_id))
768
mainline_parent_id = revision_id
769
return BranchCheckResult(self)
1332
771
def _get_checkout_format(self):
1333
772
"""Return the most suitable metadir for a checkout of this branch.
1611
997
filename, content,
1612
998
mode=a_bzrdir._get_file_mode())
1615
control_files.unlock()
1616
branch = self.open(a_bzrdir, name, _found=True)
1617
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1000
control_files.unlock()
1001
return self.open(a_bzrdir, _found=True)
1620
def initialize(self, a_bzrdir, name=None):
1621
"""Create a branch of this format in a_bzrdir.
1623
:param name: Name of the colocated branch to create.
1003
def initialize(self, a_bzrdir):
1004
"""Create a branch of this format in a_bzrdir."""
1625
1005
raise NotImplementedError(self.initialize)
1627
1007
def is_supported(self):
1628
1008
"""Is this format supported?
1630
1010
Supported formats can be initialized and opened.
1631
Unsupported formats may not support initialization or committing or
1011
Unsupported formats may not support initialization or committing or
1632
1012
some other features depending on the reason for not being supported.
1636
def make_tags(self, branch):
1637
"""Create a tags object for branch.
1639
This method is on BranchFormat, because BranchFormats are reflected
1640
over the wire via network_name(), whereas full Branch instances require
1641
multiple VFS method calls to operate at all.
1643
The default implementation returns a disabled-tags instance.
1645
Note that it is normal for branch to be a RemoteBranch when using tags
1648
return DisabledTags(branch)
1650
def network_name(self):
1651
"""A simple byte string uniquely identifying this format for RPC calls.
1653
MetaDir branch formats use their disk format string to identify the
1654
repository over the wire. All in one formats such as bzr < 0.8, and
1655
foreign formats like svn/git and hg should use some marker which is
1656
unique and immutable.
1658
raise NotImplementedError(self.network_name)
1660
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1016
def open(self, a_bzrdir, _found=False):
1661
1017
"""Return the branch object for a_bzrdir
1663
:param a_bzrdir: A BzrDir that contains a branch.
1664
:param name: Name of colocated branch to open
1665
:param _found: a private parameter, do not use it. It is used to
1666
indicate if format probing has already be done.
1667
:param ignore_fallbacks: when set, no fallback branches will be opened
1668
(if there are any). Default is to open fallbacks.
1019
_found is a private parameter, do not use it. It is used to indicate
1020
if format probing has already be done.
1670
1022
raise NotImplementedError(self.open)
1673
1025
def register_format(klass, format):
1674
"""Register a metadir format."""
1675
1026
klass._formats[format.get_format_string()] = format
1676
# Metadir formats have a network name of their format string, and get
1677
# registered as class factories.
1678
network_format_registry.register(format.get_format_string(), format.__class__)
1681
1029
def set_default_format(klass, format):
1682
1030
klass._default_format = format
1684
def supports_set_append_revisions_only(self):
1685
"""True if this format supports set_append_revisions_only."""
1688
1032
def supports_stacking(self):
1689
1033
"""True if this format records a stacked-on branch."""
1717
1061
Hooks.__init__(self)
1718
self.create_hook(HookPoint('set_rh',
1719
"Invoked whenever the revision history has been set via "
1720
"set_revision_history. The api signature is (branch, "
1721
"revision_history), and the branch will be write-locked. "
1722
"The set_rh hook can be expensive for bzr to trigger, a better "
1723
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1724
self.create_hook(HookPoint('open',
1725
"Called with the Branch object that has been opened after a "
1726
"branch is opened.", (1, 8), None))
1727
self.create_hook(HookPoint('post_push',
1728
"Called after a push operation completes. post_push is called "
1729
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1730
"bzr client.", (0, 15), None))
1731
self.create_hook(HookPoint('post_pull',
1732
"Called after a pull operation completes. post_pull is called "
1733
"with a bzrlib.branch.PullResult object and only runs in the "
1734
"bzr client.", (0, 15), None))
1735
self.create_hook(HookPoint('pre_commit',
1736
"Called after a commit is calculated but before it is is "
1737
"completed. pre_commit is called with (local, master, old_revno, "
1738
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1739
"). old_revid is NULL_REVISION for the first commit to a branch, "
1740
"tree_delta is a TreeDelta object describing changes from the "
1741
"basis revision. hooks MUST NOT modify this delta. "
1742
" future_tree is an in-memory tree obtained from "
1743
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1744
"tree.", (0,91), None))
1745
self.create_hook(HookPoint('post_commit',
1746
"Called in the bzr client after a commit has completed. "
1747
"post_commit is called with (local, master, old_revno, old_revid, "
1748
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1749
"commit to a branch.", (0, 15), None))
1750
self.create_hook(HookPoint('post_uncommit',
1751
"Called in the bzr client after an uncommit completes. "
1752
"post_uncommit is called with (local, master, old_revno, "
1753
"old_revid, new_revno, new_revid) where local is the local branch "
1754
"or None, master is the target branch, and an empty branch "
1755
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1756
self.create_hook(HookPoint('pre_change_branch_tip',
1757
"Called in bzr client and server before a change to the tip of a "
1758
"branch is made. pre_change_branch_tip is called with a "
1759
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1760
"commit, uncommit will all trigger this hook.", (1, 6), None))
1761
self.create_hook(HookPoint('post_change_branch_tip',
1762
"Called in bzr client and server after a change to the tip of a "
1763
"branch is made. post_change_branch_tip is called with a "
1764
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1765
"commit, uncommit will all trigger this hook.", (1, 4), None))
1766
self.create_hook(HookPoint('transform_fallback_location',
1767
"Called when a stacked branch is activating its fallback "
1768
"locations. transform_fallback_location is called with (branch, "
1769
"url), and should return a new url. Returning the same url "
1770
"allows it to be used as-is, returning a different one can be "
1771
"used to cause the branch to stack on a closer copy of that "
1772
"fallback_location. Note that the branch cannot have history "
1773
"accessing methods called on it during this hook because the "
1774
"fallback locations have not been activated. When there are "
1775
"multiple hooks installed for transform_fallback_location, "
1776
"all are called with the url returned from the previous hook."
1777
"The order is however undefined.", (1, 9), None))
1778
self.create_hook(HookPoint('automatic_tag_name',
1779
"Called to determine an automatic tag name for a revision."
1780
"automatic_tag_name is called with (branch, revision_id) and "
1781
"should return a tag name or None if no tag name could be "
1782
"determined. The first non-None tag name returned will be used.",
1784
self.create_hook(HookPoint('post_branch_init',
1785
"Called after new branch initialization completes. "
1786
"post_branch_init is called with a "
1787
"bzrlib.branch.BranchInitHookParams. "
1788
"Note that init, branch and checkout (both heavyweight and "
1789
"lightweight) will all trigger this hook.", (2, 2), None))
1790
self.create_hook(HookPoint('post_switch',
1791
"Called after a checkout switches branch. "
1792
"post_switch is called with a "
1793
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1062
# Introduced in 0.15:
1063
# invoked whenever the revision history has been set
1064
# with set_revision_history. The api signature is
1065
# (branch, revision_history), and the branch will
1068
# invoked after a push operation completes.
1069
# the api signature is
1071
# containing the members
1072
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1073
# where local is the local target branch or None, master is the target
1074
# master branch, and the rest should be self explanatory. The source
1075
# is read locked and the target branches write locked. Source will
1076
# be the local low-latency branch.
1077
self['post_push'] = []
1078
# invoked after a pull operation completes.
1079
# the api signature is
1081
# containing the members
1082
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1083
# where local is the local branch or None, master is the target
1084
# master branch, and the rest should be self explanatory. The source
1085
# is read locked and the target branches write locked. The local
1086
# branch is the low-latency branch.
1087
self['post_pull'] = []
1088
# invoked before a commit operation takes place.
1089
# the api signature is
1090
# (local, master, old_revno, old_revid, future_revno, future_revid,
1091
# tree_delta, future_tree).
1092
# old_revid is NULL_REVISION for the first commit to a branch
1093
# tree_delta is a TreeDelta object describing changes from the basis
1094
# revision, hooks MUST NOT modify this delta
1095
# future_tree is an in-memory tree obtained from
1096
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1097
self['pre_commit'] = []
1098
# invoked after a commit operation completes.
1099
# the api signature is
1100
# (local, master, old_revno, old_revid, new_revno, new_revid)
1101
# old_revid is NULL_REVISION for the first commit to a branch.
1102
self['post_commit'] = []
1103
# invoked after a uncommit operation completes.
1104
# the api signature is
1105
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1106
# local is the local branch or None, master is the target branch,
1107
# and an empty branch recieves new_revno of 0, new_revid of None.
1108
self['post_uncommit'] = []
1110
# Invoked before the tip of a branch changes.
1111
# the api signature is
1112
# (params) where params is a ChangeBranchTipParams with the members
1113
# (branch, old_revno, new_revno, old_revid, new_revid)
1114
self['pre_change_branch_tip'] = []
1116
# Invoked after the tip of a branch changes.
1117
# the api signature is
1118
# (params) where params is a ChangeBranchTipParams with the members
1119
# (branch, old_revno, new_revno, old_revid, new_revid)
1120
self['post_change_branch_tip'] = []
1797
1123
# install the default hooks into the Branch class.
1830
1156
def __eq__(self, other):
1831
1157
return self.__dict__ == other.__dict__
1833
1159
def __repr__(self):
1834
1160
return "<%s of %s from (%s, %s) to (%s, %s)>" % (
1835
self.__class__.__name__, self.branch,
1161
self.__class__.__name__, self.branch,
1836
1162
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1839
class BranchInitHookParams(object):
1840
"""Object holding parameters passed to *_branch_init hooks.
1842
There are 4 fields that hooks may wish to access:
1844
:ivar format: the branch format
1845
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1846
:ivar name: name of colocated branch, if any (or None)
1847
:ivar branch: the branch created
1849
Note that for lightweight checkouts, the bzrdir and format fields refer to
1850
the checkout, hence they are different from the corresponding fields in
1851
branch, which refer to the original branch.
1854
def __init__(self, format, a_bzrdir, name, branch):
1855
"""Create a group of BranchInitHook parameters.
1857
:param format: the branch format
1858
:param a_bzrdir: the BzrDir where the branch will be/has been
1860
:param name: name of colocated branch, if any (or None)
1861
:param branch: the branch created
1863
Note that for lightweight checkouts, the bzrdir and format fields refer
1864
to the checkout, hence they are different from the corresponding fields
1865
in branch, which refer to the original branch.
1867
self.format = format
1868
self.bzrdir = a_bzrdir
1870
self.branch = branch
1872
def __eq__(self, other):
1873
return self.__dict__ == other.__dict__
1877
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1879
return "<%s of format:%s bzrdir:%s>" % (
1880
self.__class__.__name__, self.branch,
1881
self.format, self.bzrdir)
1884
class SwitchHookParams(object):
1885
"""Object holding parameters passed to *_switch hooks.
1887
There are 4 fields that hooks may wish to access:
1889
:ivar control_dir: BzrDir of the checkout to change
1890
:ivar to_branch: branch that the checkout is to reference
1891
:ivar force: skip the check for local commits in a heavy checkout
1892
:ivar revision_id: revision ID to switch to (or None)
1895
def __init__(self, control_dir, to_branch, force, revision_id):
1896
"""Create a group of SwitchHook parameters.
1898
:param control_dir: BzrDir of the checkout to change
1899
:param to_branch: branch that the checkout is to reference
1900
:param force: skip the check for local commits in a heavy checkout
1901
:param revision_id: revision ID to switch to (or None)
1903
self.control_dir = control_dir
1904
self.to_branch = to_branch
1906
self.revision_id = revision_id
1908
def __eq__(self, other):
1909
return self.__dict__ == other.__dict__
1912
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1913
self.control_dir, self.to_branch,
1917
1165
class BzrBranchFormat4(BranchFormat):
1918
1166
"""Bzr branch format 4.
2057
1298
"""See BranchFormat.get_format_description()."""
2058
1299
return "Branch format 6"
2060
def initialize(self, a_bzrdir, name=None):
2061
"""Create a branch of this format in a_bzrdir."""
2062
utf8_files = [('last-revision', '0 null:\n'),
2063
('branch.conf', ''),
2066
return self._initialize_helper(a_bzrdir, utf8_files, name)
2068
def make_tags(self, branch):
2069
"""See bzrlib.branch.BranchFormat.make_tags()."""
2070
return BasicTags(branch)
2072
def supports_set_append_revisions_only(self):
2076
class BzrBranchFormat8(BranchFormatMetadir):
2077
"""Metadir format supporting storing locations of subtree branches."""
2079
def _branch_class(self):
2082
def get_format_string(self):
2083
"""See BranchFormat.get_format_string()."""
2084
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2086
def get_format_description(self):
2087
"""See BranchFormat.get_format_description()."""
2088
return "Branch format 8"
2090
def initialize(self, a_bzrdir, name=None):
2091
"""Create a branch of this format in a_bzrdir."""
2092
utf8_files = [('last-revision', '0 null:\n'),
2093
('branch.conf', ''),
2097
return self._initialize_helper(a_bzrdir, utf8_files, name)
2100
super(BzrBranchFormat8, self).__init__()
2101
self._matchingbzrdir.repository_format = \
2102
RepositoryFormatKnitPack5RichRoot()
2104
def make_tags(self, branch):
2105
"""See bzrlib.branch.BranchFormat.make_tags()."""
2106
return BasicTags(branch)
2108
def supports_set_append_revisions_only(self):
2111
def supports_stacking(self):
2114
supports_reference_locations = True
2117
class BzrBranchFormat7(BzrBranchFormat8):
1301
def initialize(self, a_bzrdir):
1302
"""Create a branch of this format in a_bzrdir."""
1303
utf8_files = [('last-revision', '0 null:\n'),
1304
('branch.conf', ''),
1307
return self._initialize_helper(a_bzrdir, utf8_files)
1310
class BzrBranchFormat7(BranchFormatMetadir):
2118
1311
"""Branch format with last-revision, tags, and a stacked location pointer.
2120
1313
The stacked location pointer is passed down to the repository and requires
2170
1366
def get_reference(self, a_bzrdir):
2171
1367
"""See BranchFormat.get_reference()."""
2172
1368
transport = a_bzrdir.get_branch_transport(None)
2173
return transport.get_bytes('location')
1369
return transport.get('location').read()
2175
1371
def set_reference(self, a_bzrdir, to_branch):
2176
1372
"""See BranchFormat.set_reference()."""
2177
1373
transport = a_bzrdir.get_branch_transport(None)
2178
1374
location = transport.put_bytes('location', to_branch.base)
2180
def initialize(self, a_bzrdir, name=None, target_branch=None):
1376
def initialize(self, a_bzrdir, target_branch=None):
2181
1377
"""Create a branch of this format in a_bzrdir."""
2182
1378
if target_branch is None:
2183
1379
# this format does not implement branch itself, thus the implicit
2184
1380
# creation contract must see it as uninitializable
2185
1381
raise errors.UninitializableFormat(self)
2186
mutter('creating branch reference in %s', a_bzrdir.user_url)
2187
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1382
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1383
branch_transport = a_bzrdir.get_branch_transport(self)
2188
1384
branch_transport.put_bytes('location',
2189
target_branch.bzrdir.user_url)
1385
target_branch.bzrdir.root_transport.base)
2190
1386
branch_transport.put_bytes('format', self.get_format_string())
2192
a_bzrdir, name, _found=True,
1388
a_bzrdir, _found=True,
2193
1389
possible_transports=[target_branch.bzrdir.root_transport])
2194
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2197
1391
def __init__(self):
2198
1392
super(BranchReferenceFormat, self).__init__()
2199
1393
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2200
self._matchingbzrdir.set_branch_format(self)
2202
1395
def _make_reference_clone_function(format, a_branch):
2203
1396
"""Create a clone() routine for a branch dynamically."""
2204
def clone(to_bzrdir, revision_id=None,
2205
repository_policy=None):
1397
def clone(to_bzrdir, revision_id=None):
2206
1398
"""See Branch.clone()."""
2207
return format.initialize(to_bzrdir, target_branch=a_branch)
1399
return format.initialize(to_bzrdir, a_branch)
2208
1400
# cannot obey revision_id limits when cloning a reference ...
2209
1401
# FIXME RBC 20060210 either nuke revision_id for clone, or
2210
1402
# emit some sort of warning/error to the caller ?!
2213
def open(self, a_bzrdir, name=None, _found=False, location=None,
2214
possible_transports=None, ignore_fallbacks=False):
1405
def open(self, a_bzrdir, _found=False, location=None,
1406
possible_transports=None):
2215
1407
"""Return the branch that the branch reference in a_bzrdir points at.
2217
:param a_bzrdir: A BzrDir that contains a branch.
2218
:param name: Name of colocated branch to open, if any
2219
:param _found: a private parameter, do not use it. It is used to
2220
indicate if format probing has already be done.
2221
:param ignore_fallbacks: when set, no fallback branches will be opened
2222
(if there are any). Default is to open fallbacks.
2223
:param location: The location of the referenced branch. If
2224
unspecified, this will be determined from the branch reference in
2226
:param possible_transports: An optional reusable transports list.
1409
_found is a private parameter, do not use it. It is used to indicate
1410
if format probing has already be done.
2229
format = BranchFormat.find_format(a_bzrdir, name=name)
1413
format = BranchFormat.find_format(a_bzrdir)
2230
1414
if format.__class__ != self.__class__:
2231
1415
raise AssertionError("wrong format %r found for %r" %
2232
1416
(format, self))
2251
network_format_registry = registry.FormatRegistry()
2252
"""Registry of formats indexed by their network name.
2254
The network name for a branch format is an identifier that can be used when
2255
referring to formats with smart server operations. See
2256
BranchFormat.network_name() for more detail.
2260
1434
# formats which have no format string are not discoverable
2261
1435
# and not independently creatable, so are not registered.
2262
1436
__format5 = BzrBranchFormat5()
2263
1437
__format6 = BzrBranchFormat6()
2264
1438
__format7 = BzrBranchFormat7()
2265
__format8 = BzrBranchFormat8()
2266
1439
BranchFormat.register_format(__format5)
2267
1440
BranchFormat.register_format(BranchReferenceFormat())
2268
1441
BranchFormat.register_format(__format6)
2269
1442
BranchFormat.register_format(__format7)
2270
BranchFormat.register_format(__format8)
2271
BranchFormat.set_default_format(__format7)
1443
BranchFormat.set_default_format(__format6)
2272
1444
_legacy_formats = [BzrBranchFormat4(),
2274
network_format_registry.register(
2275
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2278
class BranchWriteLockResult(LogicalLockResult):
2279
"""The result of write locking a branch.
2281
:ivar branch_token: The token obtained from the underlying branch lock, or
2283
:ivar unlock: A callable which will unlock the lock.
2286
def __init__(self, unlock, branch_token):
2287
LogicalLockResult.__init__(self, unlock)
2288
self.branch_token = branch_token
2291
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2295
class BzrBranch(Branch, _RelockDebugMixin):
1447
class BzrBranch(Branch):
2296
1448
"""A branch stored in the actual filesystem.
2298
1450
Note that it's "local" in the context of the filesystem; it doesn't
2299
1451
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2300
1452
it's writable, and can be accessed via the normal filesystem API.
2302
:ivar _transport: Transport for file operations on this branch's
1454
:ivar _transport: Transport for file operations on this branch's
2303
1455
control files, typically pointing to the .bzr/branch directory.
2304
1456
:ivar repository: Repository for this branch.
2305
:ivar base: The url of the base directory for this branch; the one
1457
:ivar base: The url of the base directory for this branch; the one
2306
1458
containing the .bzr directory.
2307
:ivar name: Optional colocated branch name as it exists in the control
2311
1461
def __init__(self, _format=None,
2312
_control_files=None, a_bzrdir=None, name=None,
2313
_repository=None, ignore_fallbacks=False):
1462
_control_files=None, a_bzrdir=None, _repository=None):
2314
1463
"""Create new branch object at a particular location."""
2315
1464
if a_bzrdir is None:
2316
1465
raise ValueError('a_bzrdir must be supplied')
2318
1467
self.bzrdir = a_bzrdir
2319
1468
self._base = self.bzrdir.transport.clone('..').base
2321
1469
# XXX: We should be able to just do
2322
1470
# self.base = self.bzrdir.root_transport.base
2323
1471
# but this does not quite work yet -- mbp 20080522
2345
1489
base = property(_get_base, doc="The URL for the root of this branch.")
2347
def _get_config(self):
2348
return TransportConfig(self._transport, 'branch.conf')
2350
1491
def is_locked(self):
2351
1492
return self.control_files.is_locked()
2353
1494
def lock_write(self, token=None):
2354
"""Lock the branch for write operations.
2356
:param token: A token to permit reacquiring a previously held and
2358
:return: A BranchWriteLockResult.
2360
if not self.is_locked():
2361
self._note_lock('w')
2362
# All-in-one needs to always unlock/lock.
2363
repo_control = getattr(self.repository, 'control_files', None)
2364
if self.control_files == repo_control or not self.is_locked():
2365
self.repository._warn_if_deprecated(self)
2366
self.repository.lock_write()
1495
repo_token = self.repository.lock_write()
2371
return BranchWriteLockResult(self.unlock,
2372
self.control_files.lock_write(token=token))
1497
token = self.control_files.lock_write(token=token)
2375
self.repository.unlock()
1499
self.repository.unlock()
2378
1503
def lock_read(self):
2379
"""Lock the branch for read operations.
2381
:return: A bzrlib.lock.LogicalLockResult.
2383
if not self.is_locked():
2384
self._note_lock('r')
2385
# All-in-one needs to always unlock/lock.
2386
repo_control = getattr(self.repository, 'control_files', None)
2387
if self.control_files == repo_control or not self.is_locked():
2388
self.repository._warn_if_deprecated(self)
2389
self.repository.lock_read()
1504
self.repository.lock_read()
2394
1506
self.control_files.lock_read()
2395
return LogicalLockResult(self.unlock)
2398
self.repository.unlock()
1508
self.repository.unlock()
2401
@only_raises(errors.LockNotHeld, errors.LockBroken)
2402
1511
def unlock(self):
1512
# TODO: test for failed two phase locks. This is known broken.
2404
1514
self.control_files.unlock()
2406
# All-in-one needs to always unlock/lock.
2407
repo_control = getattr(self.repository, 'control_files', None)
2408
if (self.control_files == repo_control or
2409
not self.control_files.is_locked()):
2410
self.repository.unlock()
2411
if not self.control_files.is_locked():
2412
# we just released the lock
2413
self._clear_cached_state()
1516
self.repository.unlock()
1517
if not self.control_files.is_locked():
1518
# we just released the lock
1519
self._clear_cached_state()
2415
1521
def peek_lock_mode(self):
2416
1522
if self.control_files._lock_count == 0:
2460
1566
if Branch.hooks['post_change_branch_tip']:
2461
1567
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2463
def _synchronize_history(self, destination, revision_id):
2464
"""Synchronize last revision and revision history between branches.
2466
This version is most efficient when the destination is also a
2467
BzrBranch5, but works for BzrBranch6 as long as the revision
2468
history is the true lefthand parent history, and all of the revisions
2469
are in the destination's repository. If not, set_revision_history
2472
:param destination: The branch to copy the history into
2473
:param revision_id: The revision-id to truncate history at. May
2474
be None to copy complete history.
2476
if not isinstance(destination._format, BzrBranchFormat5):
2477
super(BzrBranch, self)._synchronize_history(
2478
destination, revision_id)
1569
def _run_pre_change_branch_tip_hooks(self, new_revno, new_revid):
1570
"""Run the pre_change_branch_tip hooks."""
1571
hooks = Branch.hooks['pre_change_branch_tip']
2480
if revision_id == _mod_revision.NULL_REVISION:
2483
new_history = self.revision_history()
2484
if revision_id is not None and new_history != []:
1574
old_revno, old_revid = self.last_revision_info()
1575
params = ChangeBranchTipParams(
1576
self, old_revno, new_revno, old_revid, new_revid)
2486
new_history = new_history[:new_history.index(revision_id) + 1]
2488
rev = self.repository.get_revision(revision_id)
2489
new_history = rev.get_history(self.repository)[1:]
2490
destination.set_revision_history(new_history)
1580
except errors.TipChangeRejected:
1583
exc_info = sys.exc_info()
1584
hook_name = Branch.hooks.get_hook_name(hook)
1585
raise errors.HookFailed(
1586
'pre_change_branch_tip', hook_name, exc_info)
1588
def _run_post_change_branch_tip_hooks(self, old_revno, old_revid):
1589
"""Run the post_change_branch_tip hooks."""
1590
hooks = Branch.hooks['post_change_branch_tip']
1593
new_revno, new_revid = self.last_revision_info()
1594
params = ChangeBranchTipParams(
1595
self, old_revno, new_revno, old_revid, new_revid)
2492
1599
@needs_write_lock
2493
1600
def set_last_revision_info(self, revno, revision_id):
2494
1601
"""Set the last revision of this branch.
1725
def push(self, target, overwrite=False, stop_revision=None,
1726
_override_hook_source_branch=None):
1729
This is the basic concrete implementation of push()
1731
:param _override_hook_source_branch: If specified, run
1732
the hooks passing this Branch as the source, rather than self.
1733
This is for use of RemoteBranch, where push is delegated to the
1734
underlying vfs-based Branch.
1736
# TODO: Public option to disable running hooks - should be trivial but
1740
result = self._push_with_bound_branches(target, overwrite,
1742
_override_hook_source_branch=_override_hook_source_branch)
1747
def _push_with_bound_branches(self, target, overwrite,
1749
_override_hook_source_branch=None):
1750
"""Push from self into target, and into target's master if any.
1752
This is on the base BzrBranch class even though it doesn't support
1753
bound branches because the *target* might be bound.
1756
if _override_hook_source_branch:
1757
result.source_branch = _override_hook_source_branch
1758
for hook in Branch.hooks['post_push']:
1761
bound_location = target.get_bound_location()
1762
if bound_location and target.base != bound_location:
1763
# there is a master branch.
1765
# XXX: Why the second check? Is it even supported for a branch to
1766
# be bound to itself? -- mbp 20070507
1767
master_branch = target.get_master_branch()
1768
master_branch.lock_write()
1770
# push into the master from this branch.
1771
self._basic_push(master_branch, overwrite, stop_revision)
1772
# and push into the target branch from this. Note that we push from
1773
# this branch again, because its considered the highest bandwidth
1775
result = self._basic_push(target, overwrite, stop_revision)
1776
result.master_branch = master_branch
1777
result.local_branch = target
1781
master_branch.unlock()
1784
result = self._basic_push(target, overwrite, stop_revision)
1785
# TODO: Why set master_branch and local_branch if there's no
1786
# binding? Maybe cleaner to just leave them unset? -- mbp
1788
result.master_branch = target
1789
result.local_branch = None
2547
1793
def _basic_push(self, target, overwrite, stop_revision):
2548
1794
"""Basic implementation of push without bound branches or hooks.
2550
Must be called with source read locked and target write locked.
1796
Must be called with self read locked and target write locked.
2552
result = BranchPushResult()
1798
result = PushResult()
2553
1799
result.source_branch = self
2554
1800
result.target_branch = target
2555
1801
result.old_revno, result.old_revid = target.last_revision_info()
2556
self.update_references(target)
2557
if result.old_revid != self.last_revision():
2558
# We assume that during 'push' this repository is closer than
2560
graph = self.repository.get_graph(target.repository)
2561
target.update_revisions(self, stop_revision,
2562
overwrite=overwrite, graph=graph)
2563
if self._push_should_merge_tags():
2564
result.tag_conflicts = self.tags.merge_to(target.tags,
1803
# We assume that during 'push' this repository is closer than
1805
graph = self.repository.get_graph(target.repository)
1806
target.update_revisions(self, stop_revision, overwrite=overwrite,
1808
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2566
1809
result.new_revno, result.new_revid = target.last_revision_info()
1812
def get_parent(self):
1813
"""See Branch.get_parent."""
1814
parent = self._get_parent_location()
1817
# This is an old-format absolute path to a local branch
1818
# turn it into a url
1819
if parent.startswith('/'):
1820
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1822
return urlutils.join(self.base[:-1], parent)
1823
except errors.InvalidURLJoin, e:
1824
raise errors.InaccessibleParent(parent, self.base)
2569
1826
def get_stacked_on_url(self):
2570
raise errors.UnstackableBranchFormat(self._format, self.user_url)
1827
raise errors.UnstackableBranchFormat(self._format, self.base)
2572
1829
def set_push_location(self, location):
2573
1830
"""See Branch.set_push_location."""
2684
class BzrBranch8(BzrBranch5):
2685
"""A branch that stores tree-reference locations."""
1991
class BzrBranch7(BzrBranch5):
1992
"""A branch with support for a fallback repository."""
1994
def _get_fallback_repository(self, url):
1995
"""Get the repository we fallback to at url."""
1996
url = urlutils.join(self.base, url)
1997
return bzrdir.BzrDir.open(url).open_branch().repository
1999
def _activate_fallback_location(self, url):
2000
"""Activate the branch/repository from url as a fallback repository."""
2001
self.repository.add_fallback_repository(
2002
self._get_fallback_repository(url))
2687
2004
def _open_hook(self):
2688
if self._ignore_fallbacks:
2691
2006
url = self.get_stacked_on_url()
2692
2007
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2693
2008
errors.UnstackableBranchFormat):
2696
for hook in Branch.hooks['transform_fallback_location']:
2697
url = hook(self, url)
2699
hook_name = Branch.hooks.get_hook_name(hook)
2700
raise AssertionError(
2701
"'transform_fallback_location' hook %s returned "
2702
"None, not a URL." % hook_name)
2703
2011
self._activate_fallback_location(url)
2013
def _check_stackable_repo(self):
2014
if not self.repository._format.supports_external_lookups:
2015
raise errors.UnstackableRepositoryFormat(self.repository._format,
2016
self.repository.base)
2705
2018
def __init__(self, *args, **kwargs):
2706
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2707
super(BzrBranch8, self).__init__(*args, **kwargs)
2019
super(BzrBranch7, self).__init__(*args, **kwargs)
2708
2020
self._last_revision_info_cache = None
2709
self._reference_info = None
2021
self._partial_revision_history_cache = []
2711
2023
def _clear_cached_state(self):
2712
super(BzrBranch8, self)._clear_cached_state()
2024
super(BzrBranch7, self)._clear_cached_state()
2713
2025
self._last_revision_info_cache = None
2714
self._reference_info = None
2026
self._partial_revision_history_cache = []
2716
2028
def _last_revision_info(self):
2717
2029
revision_string = self._transport.get_bytes('last-revision')
2798
2127
"""Set the parent branch"""
2799
2128
return self._get_config_location('parent_location')
2802
def _set_all_reference_info(self, info_dict):
2803
"""Replace all reference info stored in a branch.
2805
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2808
writer = rio.RioWriter(s)
2809
for key, (tree_path, branch_location) in info_dict.iteritems():
2810
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2811
branch_location=branch_location)
2812
writer.write_stanza(stanza)
2813
self._transport.put_bytes('references', s.getvalue())
2814
self._reference_info = info_dict
2817
def _get_all_reference_info(self):
2818
"""Return all the reference info stored in a branch.
2820
:return: A dict of {file_id: (tree_path, branch_location)}
2822
if self._reference_info is not None:
2823
return self._reference_info
2824
rio_file = self._transport.get('references')
2826
stanzas = rio.read_stanzas(rio_file)
2827
info_dict = dict((s['file_id'], (s['tree_path'],
2828
s['branch_location'])) for s in stanzas)
2831
self._reference_info = info_dict
2834
def set_reference_info(self, file_id, tree_path, branch_location):
2835
"""Set the branch location to use for a tree reference.
2837
:param file_id: The file-id of the tree reference.
2838
:param tree_path: The path of the tree reference in the tree.
2839
:param branch_location: The location of the branch to retrieve tree
2842
info_dict = self._get_all_reference_info()
2843
info_dict[file_id] = (tree_path, branch_location)
2844
if None in (tree_path, branch_location):
2845
if tree_path is not None:
2846
raise ValueError('tree_path must be None when branch_location'
2848
if branch_location is not None:
2849
raise ValueError('branch_location must be None when tree_path'
2851
del info_dict[file_id]
2852
self._set_all_reference_info(info_dict)
2854
def get_reference_info(self, file_id):
2855
"""Get the tree_path and branch_location for a tree reference.
2857
:return: a tuple of (tree_path, branch_location)
2859
return self._get_all_reference_info().get(file_id, (None, None))
2861
def reference_parent(self, file_id, path, possible_transports=None):
2862
"""Return the parent branch for a tree-reference file_id.
2864
:param file_id: The file_id of the tree reference
2865
:param path: The path of the file_id in the tree
2866
:return: A branch associated with the file_id
2868
branch_location = self.get_reference_info(file_id)[1]
2869
if branch_location is None:
2870
return Branch.reference_parent(self, file_id, path,
2871
possible_transports)
2872
branch_location = urlutils.join(self.user_url, branch_location)
2873
return Branch.open(branch_location,
2874
possible_transports=possible_transports)
2876
2130
def set_push_location(self, location):
2877
2131
"""See Branch.set_push_location."""
2878
2132
self._set_config_location('push_location', location)
2912
2166
return self._get_bound_location(False)
2914
2168
def get_stacked_on_url(self):
2915
# you can always ask for the URL; but you might not be able to use it
2916
# if the repo can't support stacking.
2917
## self._check_stackable_repo()
2169
self._check_stackable_repo()
2918
2170
stacked_url = self._get_config_location('stacked_on_location')
2919
2171
if stacked_url is None:
2920
2172
raise errors.NotStacked(self)
2921
2173
return stacked_url
2175
def set_append_revisions_only(self, enabled):
2180
self.get_config().set_user_option('append_revisions_only', value,
2183
def set_stacked_on_url(self, url):
2184
self._check_stackable_repo()
2187
old_url = self.get_stacked_on_url()
2188
except (errors.NotStacked, errors.UnstackableBranchFormat,
2189
errors.UnstackableRepositoryFormat):
2192
# repositories don't offer an interface to remove fallback
2193
# repositories today; take the conceptually simpler option and just
2195
self.repository = self.bzrdir.find_repository()
2196
# for every revision reference the branch has, ensure it is pulled
2198
source_repository = self._get_fallback_repository(old_url)
2199
for revision_id in chain([self.last_revision()],
2200
self.tags.get_reverse_tag_dict()):
2201
self.repository.fetch(source_repository, revision_id,
2204
self._activate_fallback_location(url)
2205
# write this out after the repository is stacked to avoid setting a
2206
# stacked config that doesn't work.
2207
self._set_config_location('stacked_on_location', url)
2923
2209
def _get_append_revisions_only(self):
2924
return self.get_config(
2925
).get_user_option_as_bool('append_revisions_only')
2210
value = self.get_config().get_user_option('append_revisions_only')
2211
return value == 'True'
2213
def _synchronize_history(self, destination, revision_id):
2214
"""Synchronize last revision and revision history between branches.
2216
This version is most efficient when the destination is also a
2217
BzrBranch6, but works for BzrBranch5, as long as the destination's
2218
repository contains all the lefthand ancestors of the intended
2219
last_revision. If not, set_last_revision_info will fail.
2221
:param destination: The branch to copy the history into
2222
:param revision_id: The revision-id to truncate history at. May
2223
be None to copy complete history.
2225
source_revno, source_revision_id = self.last_revision_info()
2226
if revision_id is None:
2227
revno, revision_id = source_revno, source_revision_id
2228
elif source_revision_id == revision_id:
2229
# we know the revno without needing to walk all of history
2230
revno = source_revno
2232
# To figure out the revno for a random revision, we need to build
2233
# the revision history, and count its length.
2234
# We don't care about the order, just how long it is.
2235
# Alternatively, we could start at the current location, and count
2236
# backwards. But there is no guarantee that we will find it since
2237
# it may be a merged revision.
2238
revno = len(list(self.repository.iter_reverse_revision_history(
2240
destination.set_last_revision_info(revno, revision_id)
2242
def _make_tags(self):
2243
return BasicTags(self)
2927
2245
@needs_write_lock
2928
2246
def generate_revision_history(self, revision_id, last_rev=None,
3128
2426
branch._set_config_location('stacked_on_location', '')
3129
2427
# update target format
3130
2428
branch._transport.put_bytes('format', format.get_format_string())
3133
class Converter7to8(object):
3134
"""Perform an in-place upgrade of format 6 to format 7"""
3136
def convert(self, branch):
3137
format = BzrBranchFormat8()
3138
branch._transport.put_bytes('references', '')
3139
# update target format
3140
branch._transport.put_bytes('format', format.get_format_string())
3143
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3144
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3147
_run_with_write_locked_target will attempt to release the lock it acquires.
3149
If an exception is raised by callable, then that exception *will* be
3150
propagated, even if the unlock attempt raises its own error. Thus
3151
_run_with_write_locked_target should be preferred to simply doing::
3155
return callable(*args, **kwargs)
3160
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3161
# should share code?
3164
result = callable(*args, **kwargs)
3166
exc_info = sys.exc_info()
3170
raise exc_info[0], exc_info[1], exc_info[2]
3176
class InterBranch(InterObject):
3177
"""This class represents operations taking place between two branches.
3179
Its instances have methods like pull() and push() and contain
3180
references to the source and target repositories these operations
3181
can be carried out on.
3185
"""The available optimised InterBranch types."""
3188
def _get_branch_formats_to_test():
3189
"""Return a tuple with the Branch formats to use when testing."""
3190
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3192
def pull(self, overwrite=False, stop_revision=None,
3193
possible_transports=None, local=False):
3194
"""Mirror source into target branch.
3196
The target branch is considered to be 'local', having low latency.
3198
:returns: PullResult instance
3200
raise NotImplementedError(self.pull)
3202
def update_revisions(self, stop_revision=None, overwrite=False,
3204
"""Pull in new perfect-fit revisions.
3206
:param stop_revision: Updated until the given revision
3207
:param overwrite: Always set the branch pointer, rather than checking
3208
to see if it is a proper descendant.
3209
:param graph: A Graph object that can be used to query history
3210
information. This can be None.
3213
raise NotImplementedError(self.update_revisions)
3215
def push(self, overwrite=False, stop_revision=None,
3216
_override_hook_source_branch=None):
3217
"""Mirror the source branch into the target branch.
3219
The source branch is considered to be 'local', having low latency.
3221
raise NotImplementedError(self.push)
3224
class GenericInterBranch(InterBranch):
3225
"""InterBranch implementation that uses public Branch functions.
3229
def _get_branch_formats_to_test():
3230
return BranchFormat._default_format, BranchFormat._default_format
3232
def update_revisions(self, stop_revision=None, overwrite=False,
3234
"""See InterBranch.update_revisions()."""
3235
self.source.lock_read()
3237
other_revno, other_last_revision = self.source.last_revision_info()
3238
stop_revno = None # unknown
3239
if stop_revision is None:
3240
stop_revision = other_last_revision
3241
if _mod_revision.is_null(stop_revision):
3242
# if there are no commits, we're done.
3244
stop_revno = other_revno
3246
# what's the current last revision, before we fetch [and change it
3248
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3249
# we fetch here so that we don't process data twice in the common
3250
# case of having something to pull, and so that the check for
3251
# already merged can operate on the just fetched graph, which will
3252
# be cached in memory.
3253
self.target.fetch(self.source, stop_revision)
3254
# Check to see if one is an ancestor of the other
3257
graph = self.target.repository.get_graph()
3258
if self.target._check_if_descendant_or_diverged(
3259
stop_revision, last_rev, graph, self.source):
3260
# stop_revision is a descendant of last_rev, but we aren't
3261
# overwriting, so we're done.
3263
if stop_revno is None:
3265
graph = self.target.repository.get_graph()
3266
this_revno, this_last_revision = \
3267
self.target.last_revision_info()
3268
stop_revno = graph.find_distance_to_null(stop_revision,
3269
[(other_last_revision, other_revno),
3270
(this_last_revision, this_revno)])
3271
self.target.set_last_revision_info(stop_revno, stop_revision)
3273
self.source.unlock()
3275
def pull(self, overwrite=False, stop_revision=None,
3276
possible_transports=None, _hook_master=None, run_hooks=True,
3277
_override_hook_target=None, local=False):
3280
:param _hook_master: Private parameter - set the branch to
3281
be supplied as the master to pull hooks.
3282
:param run_hooks: Private parameter - if false, this branch
3283
is being called because it's the master of the primary branch,
3284
so it should not run its hooks.
3285
:param _override_hook_target: Private parameter - set the branch to be
3286
supplied as the target_branch to pull hooks.
3287
:param local: Only update the local branch, and not the bound branch.
3289
# This type of branch can't be bound.
3291
raise errors.LocalRequiresBoundBranch()
3292
result = PullResult()
3293
result.source_branch = self.source
3294
if _override_hook_target is None:
3295
result.target_branch = self.target
3297
result.target_branch = _override_hook_target
3298
self.source.lock_read()
3300
# We assume that during 'pull' the target repository is closer than
3302
self.source.update_references(self.target)
3303
graph = self.target.repository.get_graph(self.source.repository)
3304
# TODO: Branch formats should have a flag that indicates
3305
# that revno's are expensive, and pull() should honor that flag.
3307
result.old_revno, result.old_revid = \
3308
self.target.last_revision_info()
3309
self.target.update_revisions(self.source, stop_revision,
3310
overwrite=overwrite, graph=graph)
3311
# TODO: The old revid should be specified when merging tags,
3312
# so a tags implementation that versions tags can only
3313
# pull in the most recent changes. -- JRV20090506
3314
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3316
result.new_revno, result.new_revid = self.target.last_revision_info()
3318
result.master_branch = _hook_master
3319
result.local_branch = result.target_branch
3321
result.master_branch = result.target_branch
3322
result.local_branch = None
3324
for hook in Branch.hooks['post_pull']:
3327
self.source.unlock()
3330
def push(self, overwrite=False, stop_revision=None,
3331
_override_hook_source_branch=None):
3332
"""See InterBranch.push.
3334
This is the basic concrete implementation of push()
3336
:param _override_hook_source_branch: If specified, run
3337
the hooks passing this Branch as the source, rather than self.
3338
This is for use of RemoteBranch, where push is delegated to the
3339
underlying vfs-based Branch.
3341
# TODO: Public option to disable running hooks - should be trivial but
3343
self.source.lock_read()
3345
return _run_with_write_locked_target(
3346
self.target, self._push_with_bound_branches, overwrite,
3348
_override_hook_source_branch=_override_hook_source_branch)
3350
self.source.unlock()
3352
def _push_with_bound_branches(self, overwrite, stop_revision,
3353
_override_hook_source_branch=None):
3354
"""Push from source into target, and into target's master if any.
3357
if _override_hook_source_branch:
3358
result.source_branch = _override_hook_source_branch
3359
for hook in Branch.hooks['post_push']:
3362
bound_location = self.target.get_bound_location()
3363
if bound_location and self.target.base != bound_location:
3364
# there is a master branch.
3366
# XXX: Why the second check? Is it even supported for a branch to
3367
# be bound to itself? -- mbp 20070507
3368
master_branch = self.target.get_master_branch()
3369
master_branch.lock_write()
3371
# push into the master from the source branch.
3372
self.source._basic_push(master_branch, overwrite, stop_revision)
3373
# and push into the target branch from the source. Note that we
3374
# push from the source branch again, because its considered the
3375
# highest bandwidth repository.
3376
result = self.source._basic_push(self.target, overwrite,
3378
result.master_branch = master_branch
3379
result.local_branch = self.target
3383
master_branch.unlock()
3386
result = self.source._basic_push(self.target, overwrite,
3388
# TODO: Why set master_branch and local_branch if there's no
3389
# binding? Maybe cleaner to just leave them unset? -- mbp
3391
result.master_branch = self.target
3392
result.local_branch = None
3397
def is_compatible(self, source, target):
3398
# GenericBranch uses the public API, so always compatible
3402
class InterToBranch5(GenericInterBranch):
3405
def _get_branch_formats_to_test():
3406
return BranchFormat._default_format, BzrBranchFormat5()
3408
def pull(self, overwrite=False, stop_revision=None,
3409
possible_transports=None, run_hooks=True,
3410
_override_hook_target=None, local=False):
3411
"""Pull from source into self, updating my master if any.
3413
:param run_hooks: Private parameter - if false, this branch
3414
is being called because it's the master of the primary branch,
3415
so it should not run its hooks.
3417
bound_location = self.target.get_bound_location()
3418
if local and not bound_location:
3419
raise errors.LocalRequiresBoundBranch()
3420
master_branch = None
3421
if not local and bound_location and self.source.user_url != bound_location:
3422
# not pulling from master, so we need to update master.
3423
master_branch = self.target.get_master_branch(possible_transports)
3424
master_branch.lock_write()
3427
# pull from source into master.
3428
master_branch.pull(self.source, overwrite, stop_revision,
3430
return super(InterToBranch5, self).pull(overwrite,
3431
stop_revision, _hook_master=master_branch,
3432
run_hooks=run_hooks,
3433
_override_hook_target=_override_hook_target)
3436
master_branch.unlock()
3439
InterBranch.register_optimiser(GenericInterBranch)
3440
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
