303
189
raise NotImplementedError(self.get_physical_lock_status)
306
def dotted_revno_to_revision_id(self, revno, _cache_reverse=False):
307
"""Return the revision_id for a dotted revno.
309
:param revno: a tuple like (1,) or (1,1,2)
310
:param _cache_reverse: a private parameter enabling storage
311
of the reverse mapping in a top level cache. (This should
312
only be done in selective circumstances as we want to
313
avoid having the mapping cached multiple times.)
314
:return: the revision_id
315
:raises errors.NoSuchRevision: if the revno doesn't exist
317
rev_id = self._do_dotted_revno_to_revision_id(revno)
319
self._partial_revision_id_to_revno_cache[rev_id] = revno
322
def _do_dotted_revno_to_revision_id(self, revno):
323
"""Worker function for dotted_revno_to_revision_id.
325
Subclasses should override this if they wish to
326
provide a more efficient implementation.
329
return self.get_rev_id(revno[0])
330
revision_id_to_revno = self.get_revision_id_to_revno_map()
331
revision_ids = [revision_id for revision_id, this_revno
332
in revision_id_to_revno.iteritems()
333
if revno == this_revno]
334
if len(revision_ids) == 1:
335
return revision_ids[0]
337
revno_str = '.'.join(map(str, revno))
338
raise errors.NoSuchRevision(self, revno_str)
341
def revision_id_to_dotted_revno(self, revision_id):
342
"""Given a revision id, return its dotted revno.
344
:return: a tuple like (1,) or (400,1,3).
346
return self._do_revision_id_to_dotted_revno(revision_id)
348
def _do_revision_id_to_dotted_revno(self, revision_id):
349
"""Worker function for revision_id_to_revno."""
350
# Try the caches if they are loaded
351
result = self._partial_revision_id_to_revno_cache.get(revision_id)
352
if result is not None:
354
if self._revision_id_to_revno_cache:
355
result = self._revision_id_to_revno_cache.get(revision_id)
357
raise errors.NoSuchRevision(self, revision_id)
358
# Try the mainline as it's optimised
360
revno = self.revision_id_to_revno(revision_id)
362
except errors.NoSuchRevision:
363
# We need to load and use the full revno map after all
364
result = self.get_revision_id_to_revno_map().get(revision_id)
366
raise errors.NoSuchRevision(self, revision_id)
370
192
def get_revision_id_to_revno_map(self):
371
193
"""Return the revision_id => dotted revno map.
397
219
:return: A dictionary mapping revision_id => dotted revno.
221
last_revision = self.last_revision()
222
revision_graph = repository._old_get_graph(self.repository,
224
merge_sorted_revisions = tsort.merge_sort(
399
229
revision_id_to_revno = dict((rev_id, revno)
400
for rev_id, depth, revno, end_of_merge
401
in self.iter_merge_sorted_revisions())
230
for seq_num, rev_id, depth, revno, end_of_merge
231
in merge_sorted_revisions)
402
232
return revision_id_to_revno
405
def iter_merge_sorted_revisions(self, start_revision_id=None,
406
stop_revision_id=None, stop_rule='exclude', direction='reverse'):
407
"""Walk the revisions for a branch in merge sorted order.
409
Merge sorted order is the output from a merge-aware,
410
topological sort, i.e. all parents come before their
411
children going forward; the opposite for reverse.
413
:param start_revision_id: the revision_id to begin walking from.
414
If None, the branch tip is used.
415
:param stop_revision_id: the revision_id to terminate the walk
416
after. If None, the rest of history is included.
417
:param stop_rule: if stop_revision_id is not None, the precise rule
418
to use for termination:
419
* 'exclude' - leave the stop revision out of the result (default)
420
* 'include' - the stop revision is the last item in the result
421
* 'with-merges' - include the stop revision and all of its
422
merged revisions in the result
423
:param direction: either 'reverse' or 'forward':
424
* reverse means return the start_revision_id first, i.e.
425
start at the most recent revision and go backwards in history
426
* forward returns tuples in the opposite order to reverse.
427
Note in particular that forward does *not* do any intelligent
428
ordering w.r.t. depth as some clients of this API may like.
429
(If required, that ought to be done at higher layers.)
431
:return: an iterator over (revision_id, depth, revno, end_of_merge)
434
* revision_id: the unique id of the revision
435
* depth: How many levels of merging deep this node has been
437
* revno_sequence: This field provides a sequence of
438
revision numbers for all revisions. The format is:
439
(REVNO, BRANCHNUM, BRANCHREVNO). BRANCHNUM is the number of the
440
branch that the revno is on. From left to right the REVNO numbers
441
are the sequence numbers within that branch of the revision.
442
* end_of_merge: When True the next node (earlier in history) is
443
part of a different merge.
445
# Note: depth and revno values are in the context of the branch so
446
# we need the full graph to get stable numbers, regardless of the
448
if self._merge_sorted_revisions_cache is None:
449
last_revision = self.last_revision()
450
last_key = (last_revision,)
451
known_graph = self.repository.revisions.get_known_graph_ancestry(
453
self._merge_sorted_revisions_cache = known_graph.merge_sort(
455
filtered = self._filter_merge_sorted_revisions(
456
self._merge_sorted_revisions_cache, start_revision_id,
457
stop_revision_id, stop_rule)
458
if direction == 'reverse':
460
if direction == 'forward':
461
return reversed(list(filtered))
463
raise ValueError('invalid direction %r' % direction)
465
def _filter_merge_sorted_revisions(self, merge_sorted_revisions,
466
start_revision_id, stop_revision_id, stop_rule):
467
"""Iterate over an inclusive range of sorted revisions."""
468
rev_iter = iter(merge_sorted_revisions)
469
if start_revision_id is not None:
470
for node in rev_iter:
471
rev_id = node.key[-1]
472
if rev_id != start_revision_id:
475
# The decision to include the start or not
476
# depends on the stop_rule if a stop is provided
477
# so pop this node back into the iterator
478
rev_iter = chain(iter([node]), rev_iter)
480
if stop_revision_id is None:
482
for node in rev_iter:
483
rev_id = node.key[-1]
484
yield (rev_id, node.merge_depth, node.revno,
486
elif stop_rule == 'exclude':
487
for node in rev_iter:
488
rev_id = node.key[-1]
489
if rev_id == stop_revision_id:
491
yield (rev_id, node.merge_depth, node.revno,
493
elif stop_rule == 'include':
494
for node in rev_iter:
495
rev_id = node.key[-1]
496
yield (rev_id, node.merge_depth, node.revno,
498
if rev_id == stop_revision_id:
500
elif stop_rule == 'with-merges':
501
stop_rev = self.repository.get_revision(stop_revision_id)
502
if stop_rev.parent_ids:
503
left_parent = stop_rev.parent_ids[0]
505
left_parent = _mod_revision.NULL_REVISION
506
# left_parent is the actual revision we want to stop logging at,
507
# since we want to show the merged revisions after the stop_rev too
508
reached_stop_revision_id = False
509
revision_id_whitelist = []
510
for node in rev_iter:
511
rev_id = node.key[-1]
512
if rev_id == left_parent:
513
# reached the left parent after the stop_revision
515
if (not reached_stop_revision_id or
516
rev_id in revision_id_whitelist):
517
yield (rev_id, node.merge_depth, node.revno,
519
if reached_stop_revision_id or rev_id == stop_revision_id:
520
# only do the merged revs of rev_id from now on
521
rev = self.repository.get_revision(rev_id)
523
reached_stop_revision_id = True
524
revision_id_whitelist.extend(rev.parent_ids)
526
raise ValueError('invalid stop_rule %r' % stop_rule)
528
234
def leave_lock_in_place(self):
529
235
"""Tell this branch object not to release the physical lock when this
530
236
object is unlocked.
532
238
If lock_write doesn't return a token, then this method is not supported.
534
240
self.control_files.leave_in_place()
688
364
:raises UnstackableRepositoryFormat: If the repository does not support
691
if not self._format.supports_stacking():
692
raise errors.UnstackableBranchFormat(self._format, self.base)
693
# XXX: Changing from one fallback repository to another does not check
694
# that all the data you need is present in the new fallback.
695
# Possibly it should.
696
self._check_stackable_repo()
699
old_url = self.get_stacked_on_url()
700
except (errors.NotStacked, errors.UnstackableBranchFormat,
701
errors.UnstackableRepositoryFormat):
705
self._activate_fallback_location(url)
706
# write this out after the repository is stacked to avoid setting a
707
# stacked config that doesn't work.
708
self._set_config_location('stacked_on_location', url)
711
"""Change a branch to be unstacked, copying data as needed.
713
Don't call this directly, use set_stacked_on_url(None).
715
pb = ui.ui_factory.nested_progress_bar()
717
pb.update("Unstacking")
718
# The basic approach here is to fetch the tip of the branch,
719
# including all available ghosts, from the existing stacked
720
# repository into a new repository object without the fallbacks.
722
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
723
# correct for CHKMap repostiories
724
old_repository = self.repository
725
if len(old_repository._fallback_repositories) != 1:
726
raise AssertionError("can't cope with fallback repositories "
727
"of %r" % (self.repository,))
728
# unlock it, including unlocking the fallback
729
old_repository.unlock()
730
old_repository.lock_read()
732
# Repositories don't offer an interface to remove fallback
733
# repositories today; take the conceptually simpler option and just
734
# reopen it. We reopen it starting from the URL so that we
735
# get a separate connection for RemoteRepositories and can
736
# stream from one of them to the other. This does mean doing
737
# separate SSH connection setup, but unstacking is not a
738
# common operation so it's tolerable.
739
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
740
new_repository = new_bzrdir.find_repository()
741
self.repository = new_repository
742
if self.repository._fallback_repositories:
743
raise AssertionError("didn't expect %r to have "
744
"fallback_repositories"
745
% (self.repository,))
746
# this is not paired with an unlock because it's just restoring
747
# the previous state; the lock's released when set_stacked_on_url
749
self.repository.lock_write()
750
# XXX: If you unstack a branch while it has a working tree
751
# with a pending merge, the pending-merged revisions will no
752
# longer be present. You can (probably) revert and remerge.
754
# XXX: This only fetches up to the tip of the repository; it
755
# doesn't bring across any tags. That's fairly consistent
756
# with how branch works, but perhaps not ideal.
757
self.repository.fetch(old_repository,
758
revision_id=self.last_revision(),
761
old_repository.unlock()
765
def _set_tags_bytes(self, bytes):
766
"""Mirror method for _get_tags_bytes.
768
:seealso: Branch._get_tags_bytes.
770
return _run_with_write_locked_target(self, self._transport.put_bytes,
367
raise NotImplementedError(self.set_stacked_on_url)
773
369
def _cache_revision_history(self, rev_history):
774
370
"""Set the cached revision history to rev_history.
906
503
information. This can be None.
909
return InterBranch.get(other, self).update_revisions(stop_revision,
912
def import_last_revision_info(self, source_repo, revno, revid):
913
"""Set the last revision info, importing from another repo if necessary.
915
This is used by the bound branch code to upload a revision to
916
the master branch first before updating the tip of the local branch.
918
:param source_repo: Source repository to optionally fetch from
919
:param revno: Revision number of the new tip
920
:param revid: Revision id of the new tip
922
if not self.repository.has_same_location(source_repo):
923
self.repository.fetch(source_repo, revision_id=revid)
924
self.set_last_revision_info(revno, revid)
508
other_revno, other_last_revision = other.last_revision_info()
509
stop_revno = None # unknown
510
if stop_revision is None:
511
stop_revision = other_last_revision
512
if _mod_revision.is_null(stop_revision):
513
# if there are no commits, we're done.
515
stop_revno = other_revno
517
# what's the current last revision, before we fetch [and change it
519
last_rev = _mod_revision.ensure_null(self.last_revision())
520
# we fetch here so that we don't process data twice in the common
521
# case of having something to pull, and so that the check for
522
# already merged can operate on the just fetched graph, which will
523
# be cached in memory.
524
self.fetch(other, stop_revision)
525
# Check to see if one is an ancestor of the other
528
graph = self.repository.get_graph()
529
if self._check_if_descendant_or_diverged(
530
stop_revision, last_rev, graph, other):
531
# stop_revision is a descendant of last_rev, but we aren't
532
# overwriting, so we're done.
534
if stop_revno is None:
536
graph = self.repository.get_graph()
537
this_revno, this_last_revision = self.last_revision_info()
538
stop_revno = graph.find_distance_to_null(stop_revision,
539
[(other_last_revision, other_revno),
540
(this_last_revision, this_revno)])
541
self.set_last_revision_info(stop_revno, stop_revision)
926
545
def revision_id_to_revno(self, revision_id):
927
546
"""Given a revision id, return its revno"""
933
552
except ValueError:
934
553
raise errors.NoSuchRevision(self, revision_id)
937
555
def get_rev_id(self, revno, history=None):
938
556
"""Find the revision id of the specified revno."""
940
558
return _mod_revision.NULL_REVISION
941
last_revno, last_revid = self.last_revision_info()
942
if revno == last_revno:
944
if revno <= 0 or revno > last_revno:
560
history = self.revision_history()
561
if revno <= 0 or revno > len(history):
945
562
raise errors.NoSuchRevision(self, revno)
946
distance_from_last = last_revno - revno
947
if len(self._partial_revision_history_cache) <= distance_from_last:
948
self._extend_partial_history(distance_from_last)
949
return self._partial_revision_history_cache[distance_from_last]
563
return history[revno - 1]
952
565
def pull(self, source, overwrite=False, stop_revision=None,
953
possible_transports=None, *args, **kwargs):
566
possible_transports=None, _override_hook_target=None):
954
567
"""Mirror source into this branch.
956
569
This branch is considered to be 'local', having low latency.
958
571
:returns: PullResult instance
960
return InterBranch.get(source, self).pull(overwrite=overwrite,
961
stop_revision=stop_revision,
962
possible_transports=possible_transports, *args, **kwargs)
573
raise NotImplementedError(self.pull)
964
def push(self, target, overwrite=False, stop_revision=None, *args,
575
def push(self, target, overwrite=False, stop_revision=None):
966
576
"""Mirror this branch into target.
968
578
This branch is considered to be 'local', having low latency.
970
return InterBranch.get(self, target).push(overwrite, stop_revision,
973
def lossy_push(self, target, stop_revision=None):
974
"""Push deltas into another branch.
976
:note: This does not, like push, retain the revision ids from
977
the source branch and will, rather than adding bzr-specific
978
metadata, push only those semantics of the revision that can be
979
natively represented by this branch' VCS.
981
:param target: Target branch
982
:param stop_revision: Revision to push, defaults to last revision.
983
:return: BranchPushResult with an extra member revidmap:
984
A dictionary mapping revision ids from the target branch
985
to new revision ids in the target branch, for each
986
revision that was pushed.
988
inter = InterBranch.get(self, target)
989
lossy_push = getattr(inter, "lossy_push", None)
990
if lossy_push is None:
991
raise errors.LossyPushToSameVCS(self, target)
992
return lossy_push(stop_revision)
580
raise NotImplementedError(self.push)
994
582
def basis_tree(self):
995
583
"""Return `Tree` object for last revision."""
1215
752
destination.set_parent(parent)
1216
if self._push_should_merge_tags():
1217
self.tags.merge_to(destination.tags)
1219
def update_references(self, target):
1220
if not getattr(self._format, 'supports_reference_locations', False):
1222
reference_dict = self._get_all_reference_info()
1223
if len(reference_dict) == 0:
1225
old_base = self.base
1226
new_base = target.base
1227
target_reference_dict = target._get_all_reference_info()
1228
for file_id, (tree_path, branch_location) in (
1229
reference_dict.items()):
1230
branch_location = urlutils.rebase_url(branch_location,
1232
target_reference_dict.setdefault(
1233
file_id, (tree_path, branch_location))
1234
target._set_all_reference_info(target_reference_dict)
753
self.tags.merge_to(destination.tags)
1236
755
@needs_read_lock
1237
def check(self, refs):
1238
757
"""Check consistency of the branch.
1240
759
In particular this checks that revisions given in the revision-history
1241
do actually match up in the revision graph, and that they're all
760
do actually match up in the revision graph, and that they're all
1242
761
present in the repository.
1244
763
Callers will typically also want to check the repository.
1246
:param refs: Calculated refs for this branch as specified by
1247
branch._get_check_refs()
1248
765
:return: A BranchCheckResult.
1250
result = BranchCheckResult(self)
767
mainline_parent_id = None
1251
768
last_revno, last_revision_id = self.last_revision_info()
1252
actual_revno = refs[('lefthand-distance', last_revision_id)]
1253
if actual_revno != last_revno:
1254
result.errors.append(errors.BzrCheckError(
1255
'revno does not match len(mainline) %s != %s' % (
1256
last_revno, actual_revno)))
1257
# TODO: We should probably also check that self.revision_history
1258
# matches the repository for older branch formats.
1259
# If looking for the code that cross-checks repository parents against
1260
# the iter_reverse_revision_history output, that is now a repository
769
real_rev_history = list(self.repository.iter_reverse_revision_history(
771
real_rev_history.reverse()
772
if len(real_rev_history) != last_revno:
773
raise errors.BzrCheckError('revno does not match len(mainline)'
774
' %s != %s' % (last_revno, len(real_rev_history)))
775
# TODO: We should probably also check that real_rev_history actually
776
# matches self.revision_history()
777
for revision_id in real_rev_history:
779
revision = self.repository.get_revision(revision_id)
780
except errors.NoSuchRevision, e:
781
raise errors.BzrCheckError("mainline revision {%s} not in repository"
783
# In general the first entry on the revision history has no parents.
784
# But it's not illegal for it to have parents listed; this can happen
785
# in imports from Arch when the parents weren't reachable.
786
if mainline_parent_id is not None:
787
if mainline_parent_id not in revision.parent_ids:
788
raise errors.BzrCheckError("previous revision {%s} not listed among "
790
% (mainline_parent_id, revision_id))
791
mainline_parent_id = revision_id
792
return BranchCheckResult(self)
1264
794
def _get_checkout_format(self):
1265
795
"""Return the most suitable metadir for a checkout of this branch.
1533
1031
"""Is this format supported?
1535
1033
Supported formats can be initialized and opened.
1536
Unsupported formats may not support initialization or committing or
1034
Unsupported formats may not support initialization or committing or
1537
1035
some other features depending on the reason for not being supported.
1541
def make_tags(self, branch):
1542
"""Create a tags object for branch.
1544
This method is on BranchFormat, because BranchFormats are reflected
1545
over the wire via network_name(), whereas full Branch instances require
1546
multiple VFS method calls to operate at all.
1548
The default implementation returns a disabled-tags instance.
1550
Note that it is normal for branch to be a RemoteBranch when using tags
1553
return DisabledTags(branch)
1555
def network_name(self):
1556
"""A simple byte string uniquely identifying this format for RPC calls.
1558
MetaDir branch formats use their disk format string to identify the
1559
repository over the wire. All in one formats such as bzr < 0.8, and
1560
foreign formats like svn/git and hg should use some marker which is
1561
unique and immutable.
1563
raise NotImplementedError(self.network_name)
1565
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1039
def open(self, a_bzrdir, _found=False):
1566
1040
"""Return the branch object for a_bzrdir
1568
:param a_bzrdir: A BzrDir that contains a branch.
1569
:param _found: a private parameter, do not use it. It is used to
1570
indicate if format probing has already be done.
1571
:param ignore_fallbacks: when set, no fallback branches will be opened
1572
(if there are any). Default is to open fallbacks.
1042
_found is a private parameter, do not use it. It is used to indicate
1043
if format probing has already be done.
1574
1045
raise NotImplementedError(self.open)
1577
1048
def register_format(klass, format):
1578
"""Register a metadir format."""
1579
1049
klass._formats[format.get_format_string()] = format
1580
# Metadir formats have a network name of their format string, and get
1581
# registered as class factories.
1582
network_format_registry.register(format.get_format_string(), format.__class__)
1585
1052
def set_default_format(klass, format):
1586
1053
klass._default_format = format
1588
def supports_set_append_revisions_only(self):
1589
"""True if this format supports set_append_revisions_only."""
1592
1055
def supports_stacking(self):
1593
1056
"""True if this format records a stacked-on branch."""
1621
1084
Hooks.__init__(self)
1622
self.create_hook(HookPoint('set_rh',
1623
"Invoked whenever the revision history has been set via "
1624
"set_revision_history. The api signature is (branch, "
1625
"revision_history), and the branch will be write-locked. "
1626
"The set_rh hook can be expensive for bzr to trigger, a better "
1627
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1628
self.create_hook(HookPoint('open',
1629
"Called with the Branch object that has been opened after a "
1630
"branch is opened.", (1, 8), None))
1631
self.create_hook(HookPoint('post_push',
1632
"Called after a push operation completes. post_push is called "
1633
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1634
"bzr client.", (0, 15), None))
1635
self.create_hook(HookPoint('post_pull',
1636
"Called after a pull operation completes. post_pull is called "
1637
"with a bzrlib.branch.PullResult object and only runs in the "
1638
"bzr client.", (0, 15), None))
1639
self.create_hook(HookPoint('pre_commit',
1640
"Called after a commit is calculated but before it is is "
1641
"completed. pre_commit is called with (local, master, old_revno, "
1642
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1643
"). old_revid is NULL_REVISION for the first commit to a branch, "
1644
"tree_delta is a TreeDelta object describing changes from the "
1645
"basis revision. hooks MUST NOT modify this delta. "
1646
" future_tree is an in-memory tree obtained from "
1647
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1648
"tree.", (0,91), None))
1649
self.create_hook(HookPoint('post_commit',
1650
"Called in the bzr client after a commit has completed. "
1651
"post_commit is called with (local, master, old_revno, old_revid, "
1652
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1653
"commit to a branch.", (0, 15), None))
1654
self.create_hook(HookPoint('post_uncommit',
1655
"Called in the bzr client after an uncommit completes. "
1656
"post_uncommit is called with (local, master, old_revno, "
1657
"old_revid, new_revno, new_revid) where local is the local branch "
1658
"or None, master is the target branch, and an empty branch "
1659
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1660
self.create_hook(HookPoint('pre_change_branch_tip',
1661
"Called in bzr client and server before a change to the tip of a "
1662
"branch is made. pre_change_branch_tip is called with a "
1663
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1664
"commit, uncommit will all trigger this hook.", (1, 6), None))
1665
self.create_hook(HookPoint('post_change_branch_tip',
1666
"Called in bzr client and server after a change to the tip of a "
1667
"branch is made. post_change_branch_tip is called with a "
1668
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1669
"commit, uncommit will all trigger this hook.", (1, 4), None))
1670
self.create_hook(HookPoint('transform_fallback_location',
1671
"Called when a stacked branch is activating its fallback "
1672
"locations. transform_fallback_location is called with (branch, "
1673
"url), and should return a new url. Returning the same url "
1674
"allows it to be used as-is, returning a different one can be "
1675
"used to cause the branch to stack on a closer copy of that "
1676
"fallback_location. Note that the branch cannot have history "
1677
"accessing methods called on it during this hook because the "
1678
"fallback locations have not been activated. When there are "
1679
"multiple hooks installed for transform_fallback_location, "
1680
"all are called with the url returned from the previous hook."
1681
"The order is however undefined.", (1, 9), None))
1085
# Introduced in 0.15:
1086
# invoked whenever the revision history has been set
1087
# with set_revision_history. The api signature is
1088
# (branch, revision_history), and the branch will
1091
# Invoked after a branch is opened. The api signature is (branch).
1093
# invoked after a push operation completes.
1094
# the api signature is
1096
# containing the members
1097
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1098
# where local is the local target branch or None, master is the target
1099
# master branch, and the rest should be self explanatory. The source
1100
# is read locked and the target branches write locked. Source will
1101
# be the local low-latency branch.
1102
self['post_push'] = []
1103
# invoked after a pull operation completes.
1104
# the api signature is
1106
# containing the members
1107
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1108
# where local is the local branch or None, master is the target
1109
# master branch, and the rest should be self explanatory. The source
1110
# is read locked and the target branches write locked. The local
1111
# branch is the low-latency branch.
1112
self['post_pull'] = []
1113
# invoked before a commit operation takes place.
1114
# the api signature is
1115
# (local, master, old_revno, old_revid, future_revno, future_revid,
1116
# tree_delta, future_tree).
1117
# old_revid is NULL_REVISION for the first commit to a branch
1118
# tree_delta is a TreeDelta object describing changes from the basis
1119
# revision, hooks MUST NOT modify this delta
1120
# future_tree is an in-memory tree obtained from
1121
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1122
self['pre_commit'] = []
1123
# invoked after a commit operation completes.
1124
# the api signature is
1125
# (local, master, old_revno, old_revid, new_revno, new_revid)
1126
# old_revid is NULL_REVISION for the first commit to a branch.
1127
self['post_commit'] = []
1128
# invoked after a uncommit operation completes.
1129
# the api signature is
1130
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1131
# local is the local branch or None, master is the target branch,
1132
# and an empty branch recieves new_revno of 0, new_revid of None.
1133
self['post_uncommit'] = []
1135
# Invoked before the tip of a branch changes.
1136
# the api signature is
1137
# (params) where params is a ChangeBranchTipParams with the members
1138
# (branch, old_revno, new_revno, old_revid, new_revid)
1139
self['pre_change_branch_tip'] = []
1141
# Invoked after the tip of a branch changes.
1142
# the api signature is
1143
# (params) where params is a ChangeBranchTipParams with the members
1144
# (branch, old_revno, new_revno, old_revid, new_revid)
1145
self['post_change_branch_tip'] = []
1147
# Invoked when a stacked branch activates its fallback locations and
1148
# allows the transformation of the url of said location.
1149
# the api signature is
1150
# (branch, url) where branch is the branch having its fallback
1151
# location activated and url is the url for the fallback location.
1152
# The hook should return a url.
1153
self['transform_fallback_location'] = []
1684
1156
# install the default hooks into the Branch class.
2054
network_format_registry = registry.FormatRegistry()
2055
"""Registry of formats indexed by their network name.
2057
The network name for a branch format is an identifier that can be used when
2058
referring to formats with smart server operations. See
2059
BranchFormat.network_name() for more detail.
2063
1469
# formats which have no format string are not discoverable
2064
1470
# and not independently creatable, so are not registered.
2065
1471
__format5 = BzrBranchFormat5()
2066
1472
__format6 = BzrBranchFormat6()
2067
1473
__format7 = BzrBranchFormat7()
2068
__format8 = BzrBranchFormat8()
2069
1474
BranchFormat.register_format(__format5)
2070
1475
BranchFormat.register_format(BranchReferenceFormat())
2071
1476
BranchFormat.register_format(__format6)
2072
1477
BranchFormat.register_format(__format7)
2073
BranchFormat.register_format(__format8)
2074
BranchFormat.set_default_format(__format7)
1478
BranchFormat.set_default_format(__format6)
2075
1479
_legacy_formats = [BzrBranchFormat4(),
2077
network_format_registry.register(
2078
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2081
class BzrBranch(Branch, _RelockDebugMixin):
1482
class BzrBranch(Branch):
2082
1483
"""A branch stored in the actual filesystem.
2084
1485
Note that it's "local" in the context of the filesystem; it doesn't
2085
1486
really matter if it's on an nfs/smb/afs/coda/... share, as long as
2086
1487
it's writable, and can be accessed via the normal filesystem API.
2088
:ivar _transport: Transport for file operations on this branch's
1489
:ivar _transport: Transport for file operations on this branch's
2089
1490
control files, typically pointing to the .bzr/branch directory.
2090
1491
:ivar repository: Repository for this branch.
2091
:ivar base: The url of the base directory for this branch; the one
1492
:ivar base: The url of the base directory for this branch; the one
2092
1493
containing the .bzr directory.
2095
1496
def __init__(self, _format=None,
2096
_control_files=None, a_bzrdir=None, _repository=None,
2097
ignore_fallbacks=False):
1497
_control_files=None, a_bzrdir=None, _repository=None):
2098
1498
"""Create new branch object at a particular location."""
2099
1499
if a_bzrdir is None:
2100
1500
raise ValueError('a_bzrdir must be supplied')
2124
1524
base = property(_get_base, doc="The URL for the root of this branch.")
2126
def _get_config(self):
2127
return TransportConfig(self._transport, 'branch.conf')
2129
1526
def is_locked(self):
2130
1527
return self.control_files.is_locked()
2132
1529
def lock_write(self, token=None):
2133
if not self.is_locked():
2134
self._note_lock('w')
2135
# All-in-one needs to always unlock/lock.
2136
repo_control = getattr(self.repository, 'control_files', None)
2137
if self.control_files == repo_control or not self.is_locked():
2138
self.repository._warn_if_deprecated(self)
2139
self.repository.lock_write()
1530
repo_token = self.repository.lock_write()
2144
return self.control_files.lock_write(token=token)
1532
token = self.control_files.lock_write(token=token)
2147
self.repository.unlock()
1534
self.repository.unlock()
2150
1538
def lock_read(self):
2151
if not self.is_locked():
2152
self._note_lock('r')
2153
# All-in-one needs to always unlock/lock.
2154
repo_control = getattr(self.repository, 'control_files', None)
2155
if self.control_files == repo_control or not self.is_locked():
2156
self.repository._warn_if_deprecated(self)
2157
self.repository.lock_read()
1539
self.repository.lock_read()
2162
1541
self.control_files.lock_read()
2165
self.repository.unlock()
1543
self.repository.unlock()
2168
@only_raises(errors.LockNotHeld, errors.LockBroken)
2169
1546
def unlock(self):
1547
# TODO: test for failed two phase locks. This is known broken.
2171
1549
self.control_files.unlock()
2173
# All-in-one needs to always unlock/lock.
2174
repo_control = getattr(self.repository, 'control_files', None)
2175
if (self.control_files == repo_control or
2176
not self.control_files.is_locked()):
2177
self.repository.unlock()
2178
if not self.control_files.is_locked():
2179
# we just released the lock
2180
self._clear_cached_state()
1551
self.repository.unlock()
1552
if not self.control_files.is_locked():
1553
# we just released the lock
1554
self._clear_cached_state()
2182
1556
def peek_lock_mode(self):
2183
1557
if self.control_files._lock_count == 0:
2302
1733
"""See Branch.basis_tree."""
2303
1734
return self.repository.revision_tree(self.last_revision())
1737
def pull(self, source, overwrite=False, stop_revision=None,
1738
_hook_master=None, run_hooks=True, possible_transports=None,
1739
_override_hook_target=None):
1742
:param _hook_master: Private parameter - set the branch to
1743
be supplied as the master to pull hooks.
1744
:param run_hooks: Private parameter - if false, this branch
1745
is being called because it's the master of the primary branch,
1746
so it should not run its hooks.
1747
:param _override_hook_target: Private parameter - set the branch to be
1748
supplied as the target_branch to pull hooks.
1750
result = PullResult()
1751
result.source_branch = source
1752
if _override_hook_target is None:
1753
result.target_branch = self
1755
result.target_branch = _override_hook_target
1758
# We assume that during 'pull' the local repository is closer than
1760
graph = self.repository.get_graph(source.repository)
1761
result.old_revno, result.old_revid = self.last_revision_info()
1762
self.update_revisions(source, stop_revision, overwrite=overwrite,
1764
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1765
result.new_revno, result.new_revid = self.last_revision_info()
1767
result.master_branch = _hook_master
1768
result.local_branch = result.target_branch
1770
result.master_branch = result.target_branch
1771
result.local_branch = None
1773
for hook in Branch.hooks['post_pull']:
2305
1779
def _get_parent_location(self):
2306
1780
_locs = ['parent', 'pull', 'x-pull']
2307
1781
for l in _locs:
1789
def push(self, target, overwrite=False, stop_revision=None,
1790
_override_hook_source_branch=None):
1793
This is the basic concrete implementation of push()
1795
:param _override_hook_source_branch: If specified, run
1796
the hooks passing this Branch as the source, rather than self.
1797
This is for use of RemoteBranch, where push is delegated to the
1798
underlying vfs-based Branch.
1800
# TODO: Public option to disable running hooks - should be trivial but
1802
return _run_with_write_locked_target(
1803
target, self._push_with_bound_branches, target, overwrite,
1805
_override_hook_source_branch=_override_hook_source_branch)
1807
def _push_with_bound_branches(self, target, overwrite,
1809
_override_hook_source_branch=None):
1810
"""Push from self into target, and into target's master if any.
1812
This is on the base BzrBranch class even though it doesn't support
1813
bound branches because the *target* might be bound.
1816
if _override_hook_source_branch:
1817
result.source_branch = _override_hook_source_branch
1818
for hook in Branch.hooks['post_push']:
1821
bound_location = target.get_bound_location()
1822
if bound_location and target.base != bound_location:
1823
# there is a master branch.
1825
# XXX: Why the second check? Is it even supported for a branch to
1826
# be bound to itself? -- mbp 20070507
1827
master_branch = target.get_master_branch()
1828
master_branch.lock_write()
1830
# push into the master from this branch.
1831
self._basic_push(master_branch, overwrite, stop_revision)
1832
# and push into the target branch from this. Note that we push from
1833
# this branch again, because its considered the highest bandwidth
1835
result = self._basic_push(target, overwrite, stop_revision)
1836
result.master_branch = master_branch
1837
result.local_branch = target
1841
master_branch.unlock()
1844
result = self._basic_push(target, overwrite, stop_revision)
1845
# TODO: Why set master_branch and local_branch if there's no
1846
# binding? Maybe cleaner to just leave them unset? -- mbp
1848
result.master_branch = target
1849
result.local_branch = None
2314
1853
def _basic_push(self, target, overwrite, stop_revision):
2315
1854
"""Basic implementation of push without bound branches or hooks.
2317
Must be called with source read locked and target write locked.
1856
Must be called with self read locked and target write locked.
2319
result = BranchPushResult()
1858
result = PushResult()
2320
1859
result.source_branch = self
2321
1860
result.target_branch = target
2322
1861
result.old_revno, result.old_revid = target.last_revision_info()
2323
self.update_references(target)
2324
1862
if result.old_revid != self.last_revision():
2325
1863
# We assume that during 'push' this repository is closer than
2327
1865
graph = self.repository.get_graph(target.repository)
2328
target.update_revisions(self, stop_revision,
2329
overwrite=overwrite, graph=graph)
1866
target.update_revisions(self, stop_revision, overwrite=overwrite,
2330
1868
if self._push_should_merge_tags():
2331
result.tag_conflicts = self.tags.merge_to(target.tags,
1869
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2333
1870
result.new_revno, result.new_revid = target.last_revision_info()
1873
def _push_should_merge_tags(self):
1874
"""Should _basic_push merge this branch's tags into the target?
1876
The default implementation returns False if this branch has no tags,
1877
and True the rest of the time. Subclasses may override this.
1879
return self.tags.supports_tags() and self.tags.get_tag_dict()
1881
def get_parent(self):
1882
"""See Branch.get_parent."""
1883
parent = self._get_parent_location()
1886
# This is an old-format absolute path to a local branch
1887
# turn it into a url
1888
if parent.startswith('/'):
1889
parent = urlutils.local_path_to_url(parent.decode('utf8'))
1891
return urlutils.join(self.base[:-1], parent)
1892
except errors.InvalidURLJoin, e:
1893
raise errors.InaccessibleParent(parent, self.base)
2336
1895
def get_stacked_on_url(self):
2337
1896
raise errors.UnstackableBranchFormat(self._format, self.base)
2565
2215
"""Set the parent branch"""
2566
2216
return self._get_config_location('parent_location')
2569
def _set_all_reference_info(self, info_dict):
2570
"""Replace all reference info stored in a branch.
2572
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2575
writer = rio.RioWriter(s)
2576
for key, (tree_path, branch_location) in info_dict.iteritems():
2577
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2578
branch_location=branch_location)
2579
writer.write_stanza(stanza)
2580
self._transport.put_bytes('references', s.getvalue())
2581
self._reference_info = info_dict
2584
def _get_all_reference_info(self):
2585
"""Return all the reference info stored in a branch.
2587
:return: A dict of {file_id: (tree_path, branch_location)}
2589
if self._reference_info is not None:
2590
return self._reference_info
2591
rio_file = self._transport.get('references')
2593
stanzas = rio.read_stanzas(rio_file)
2594
info_dict = dict((s['file_id'], (s['tree_path'],
2595
s['branch_location'])) for s in stanzas)
2598
self._reference_info = info_dict
2601
def set_reference_info(self, file_id, tree_path, branch_location):
2602
"""Set the branch location to use for a tree reference.
2604
:param file_id: The file-id of the tree reference.
2605
:param tree_path: The path of the tree reference in the tree.
2606
:param branch_location: The location of the branch to retrieve tree
2609
info_dict = self._get_all_reference_info()
2610
info_dict[file_id] = (tree_path, branch_location)
2611
if None in (tree_path, branch_location):
2612
if tree_path is not None:
2613
raise ValueError('tree_path must be None when branch_location'
2615
if branch_location is not None:
2616
raise ValueError('branch_location must be None when tree_path'
2618
del info_dict[file_id]
2619
self._set_all_reference_info(info_dict)
2621
def get_reference_info(self, file_id):
2622
"""Get the tree_path and branch_location for a tree reference.
2624
:return: a tuple of (tree_path, branch_location)
2626
return self._get_all_reference_info().get(file_id, (None, None))
2628
def reference_parent(self, file_id, path, possible_transports=None):
2629
"""Return the parent branch for a tree-reference file_id.
2631
:param file_id: The file_id of the tree reference
2632
:param path: The path of the file_id in the tree
2633
:return: A branch associated with the file_id
2635
branch_location = self.get_reference_info(file_id)[1]
2636
if branch_location is None:
2637
return Branch.reference_parent(self, file_id, path,
2638
possible_transports)
2639
branch_location = urlutils.join(self.base, branch_location)
2640
return Branch.open(branch_location,
2641
possible_transports=possible_transports)
2643
2218
def set_push_location(self, location):
2644
2219
"""See Branch.set_push_location."""
2645
2220
self._set_config_location('push_location', location)
2939
2522
target.unlock()
2943
class InterBranch(InterObject):
2944
"""This class represents operations taking place between two branches.
2946
Its instances have methods like pull() and push() and contain
2947
references to the source and target repositories these operations
2948
can be carried out on.
2952
"""The available optimised InterBranch types."""
2955
def _get_branch_formats_to_test():
2956
"""Return a tuple with the Branch formats to use when testing."""
2957
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
2959
def pull(self, overwrite=False, stop_revision=None,
2960
possible_transports=None, local=False):
2961
"""Mirror source into target branch.
2963
The target branch is considered to be 'local', having low latency.
2965
:returns: PullResult instance
2967
raise NotImplementedError(self.pull)
2969
def update_revisions(self, stop_revision=None, overwrite=False,
2971
"""Pull in new perfect-fit revisions.
2973
:param stop_revision: Updated until the given revision
2974
:param overwrite: Always set the branch pointer, rather than checking
2975
to see if it is a proper descendant.
2976
:param graph: A Graph object that can be used to query history
2977
information. This can be None.
2980
raise NotImplementedError(self.update_revisions)
2982
def push(self, overwrite=False, stop_revision=None,
2983
_override_hook_source_branch=None):
2984
"""Mirror the source branch into the target branch.
2986
The source branch is considered to be 'local', having low latency.
2988
raise NotImplementedError(self.push)
2991
class GenericInterBranch(InterBranch):
2992
"""InterBranch implementation that uses public Branch functions.
2996
def _get_branch_formats_to_test():
2997
return BranchFormat._default_format, BranchFormat._default_format
2999
def update_revisions(self, stop_revision=None, overwrite=False,
3001
"""See InterBranch.update_revisions()."""
3002
self.source.lock_read()
3004
other_revno, other_last_revision = self.source.last_revision_info()
3005
stop_revno = None # unknown
3006
if stop_revision is None:
3007
stop_revision = other_last_revision
3008
if _mod_revision.is_null(stop_revision):
3009
# if there are no commits, we're done.
3011
stop_revno = other_revno
3013
# what's the current last revision, before we fetch [and change it
3015
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3016
# we fetch here so that we don't process data twice in the common
3017
# case of having something to pull, and so that the check for
3018
# already merged can operate on the just fetched graph, which will
3019
# be cached in memory.
3020
self.target.fetch(self.source, stop_revision)
3021
# Check to see if one is an ancestor of the other
3024
graph = self.target.repository.get_graph()
3025
if self.target._check_if_descendant_or_diverged(
3026
stop_revision, last_rev, graph, self.source):
3027
# stop_revision is a descendant of last_rev, but we aren't
3028
# overwriting, so we're done.
3030
if stop_revno is None:
3032
graph = self.target.repository.get_graph()
3033
this_revno, this_last_revision = \
3034
self.target.last_revision_info()
3035
stop_revno = graph.find_distance_to_null(stop_revision,
3036
[(other_last_revision, other_revno),
3037
(this_last_revision, this_revno)])
3038
self.target.set_last_revision_info(stop_revno, stop_revision)
3040
self.source.unlock()
3042
def pull(self, overwrite=False, stop_revision=None,
3043
possible_transports=None, _hook_master=None, run_hooks=True,
3044
_override_hook_target=None, local=False):
3047
:param _hook_master: Private parameter - set the branch to
3048
be supplied as the master to pull hooks.
3049
:param run_hooks: Private parameter - if false, this branch
3050
is being called because it's the master of the primary branch,
3051
so it should not run its hooks.
3052
:param _override_hook_target: Private parameter - set the branch to be
3053
supplied as the target_branch to pull hooks.
3054
:param local: Only update the local branch, and not the bound branch.
3056
# This type of branch can't be bound.
3058
raise errors.LocalRequiresBoundBranch()
3059
result = PullResult()
3060
result.source_branch = self.source
3061
if _override_hook_target is None:
3062
result.target_branch = self.target
3064
result.target_branch = _override_hook_target
3065
self.source.lock_read()
3067
# We assume that during 'pull' the target repository is closer than
3069
self.source.update_references(self.target)
3070
graph = self.target.repository.get_graph(self.source.repository)
3071
# TODO: Branch formats should have a flag that indicates
3072
# that revno's are expensive, and pull() should honor that flag.
3074
result.old_revno, result.old_revid = \
3075
self.target.last_revision_info()
3076
self.target.update_revisions(self.source, stop_revision,
3077
overwrite=overwrite, graph=graph)
3078
# TODO: The old revid should be specified when merging tags,
3079
# so a tags implementation that versions tags can only
3080
# pull in the most recent changes. -- JRV20090506
3081
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3083
result.new_revno, result.new_revid = self.target.last_revision_info()
3085
result.master_branch = _hook_master
3086
result.local_branch = result.target_branch
3088
result.master_branch = result.target_branch
3089
result.local_branch = None
3091
for hook in Branch.hooks['post_pull']:
3094
self.source.unlock()
3097
def push(self, overwrite=False, stop_revision=None,
3098
_override_hook_source_branch=None):
3099
"""See InterBranch.push.
3101
This is the basic concrete implementation of push()
3103
:param _override_hook_source_branch: If specified, run
3104
the hooks passing this Branch as the source, rather than self.
3105
This is for use of RemoteBranch, where push is delegated to the
3106
underlying vfs-based Branch.
3108
# TODO: Public option to disable running hooks - should be trivial but
3110
self.source.lock_read()
3112
return _run_with_write_locked_target(
3113
self.target, self._push_with_bound_branches, overwrite,
3115
_override_hook_source_branch=_override_hook_source_branch)
3117
self.source.unlock()
3119
def _push_with_bound_branches(self, overwrite, stop_revision,
3120
_override_hook_source_branch=None):
3121
"""Push from source into target, and into target's master if any.
3124
if _override_hook_source_branch:
3125
result.source_branch = _override_hook_source_branch
3126
for hook in Branch.hooks['post_push']:
3129
bound_location = self.target.get_bound_location()
3130
if bound_location and self.target.base != bound_location:
3131
# there is a master branch.
3133
# XXX: Why the second check? Is it even supported for a branch to
3134
# be bound to itself? -- mbp 20070507
3135
master_branch = self.target.get_master_branch()
3136
master_branch.lock_write()
3138
# push into the master from the source branch.
3139
self.source._basic_push(master_branch, overwrite, stop_revision)
3140
# and push into the target branch from the source. Note that we
3141
# push from the source branch again, because its considered the
3142
# highest bandwidth repository.
3143
result = self.source._basic_push(self.target, overwrite,
3145
result.master_branch = master_branch
3146
result.local_branch = self.target
3150
master_branch.unlock()
3153
result = self.source._basic_push(self.target, overwrite,
3155
# TODO: Why set master_branch and local_branch if there's no
3156
# binding? Maybe cleaner to just leave them unset? -- mbp
3158
result.master_branch = self.target
3159
result.local_branch = None
3164
def is_compatible(self, source, target):
3165
# GenericBranch uses the public API, so always compatible
3169
class InterToBranch5(GenericInterBranch):
3172
def _get_branch_formats_to_test():
3173
return BranchFormat._default_format, BzrBranchFormat5()
3175
def pull(self, overwrite=False, stop_revision=None,
3176
possible_transports=None, run_hooks=True,
3177
_override_hook_target=None, local=False):
3178
"""Pull from source into self, updating my master if any.
3180
:param run_hooks: Private parameter - if false, this branch
3181
is being called because it's the master of the primary branch,
3182
so it should not run its hooks.
3184
bound_location = self.target.get_bound_location()
3185
if local and not bound_location:
3186
raise errors.LocalRequiresBoundBranch()
3187
master_branch = None
3188
if not local and bound_location and self.source.base != bound_location:
3189
# not pulling from master, so we need to update master.
3190
master_branch = self.target.get_master_branch(possible_transports)
3191
master_branch.lock_write()
3194
# pull from source into master.
3195
master_branch.pull(self.source, overwrite, stop_revision,
3197
return super(InterToBranch5, self).pull(overwrite,
3198
stop_revision, _hook_master=master_branch,
3199
run_hooks=run_hooks,
3200
_override_hook_target=_override_hook_target)
3203
master_branch.unlock()
3206
InterBranch.register_optimiser(GenericInterBranch)
3207
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
