468
395
"""Iterate over an inclusive range of sorted revisions."""
469
396
rev_iter = iter(merge_sorted_revisions)
470
397
if start_revision_id is not None:
471
for node in rev_iter:
472
rev_id = node.key[-1]
398
for rev_id, depth, revno, end_of_merge in rev_iter:
473
399
if rev_id != start_revision_id:
476
402
# The decision to include the start or not
477
403
# depends on the stop_rule if a stop is provided
478
# so pop this node back into the iterator
479
rev_iter = chain(iter([node]), rev_iter)
405
iter([(rev_id, depth, revno, end_of_merge)]),
481
408
if stop_revision_id is None:
483
for node in rev_iter:
484
rev_id = node.key[-1]
485
yield (rev_id, node.merge_depth, node.revno,
409
for rev_id, depth, revno, end_of_merge in rev_iter:
410
yield rev_id, depth, revno, end_of_merge
487
411
elif stop_rule == 'exclude':
488
for node in rev_iter:
489
rev_id = node.key[-1]
412
for rev_id, depth, revno, end_of_merge in rev_iter:
490
413
if rev_id == stop_revision_id:
492
yield (rev_id, node.merge_depth, node.revno,
415
yield rev_id, depth, revno, end_of_merge
494
416
elif stop_rule == 'include':
495
for node in rev_iter:
496
rev_id = node.key[-1]
497
yield (rev_id, node.merge_depth, node.revno,
417
for rev_id, depth, revno, end_of_merge in rev_iter:
418
yield rev_id, depth, revno, end_of_merge
499
419
if rev_id == stop_revision_id:
501
elif stop_rule == 'with-merges-without-common-ancestry':
502
# We want to exclude all revisions that are already part of the
503
# stop_revision_id ancestry.
504
graph = self.repository.get_graph()
505
ancestors = graph.find_unique_ancestors(start_revision_id,
507
for node in rev_iter:
508
rev_id = node.key[-1]
509
if rev_id not in ancestors:
511
yield (rev_id, node.merge_depth, node.revno,
513
421
elif stop_rule == 'with-merges':
514
422
stop_rev = self.repository.get_revision(stop_revision_id)
515
423
if stop_rev.parent_ids:
516
424
left_parent = stop_rev.parent_ids[0]
518
426
left_parent = _mod_revision.NULL_REVISION
519
# left_parent is the actual revision we want to stop logging at,
520
# since we want to show the merged revisions after the stop_rev too
521
reached_stop_revision_id = False
522
revision_id_whitelist = []
523
for node in rev_iter:
524
rev_id = node.key[-1]
427
for rev_id, depth, revno, end_of_merge in rev_iter:
525
428
if rev_id == left_parent:
526
# reached the left parent after the stop_revision
528
if (not reached_stop_revision_id or
529
rev_id in revision_id_whitelist):
530
yield (rev_id, node.merge_depth, node.revno,
532
if reached_stop_revision_id or rev_id == stop_revision_id:
533
# only do the merged revs of rev_id from now on
534
rev = self.repository.get_revision(rev_id)
536
reached_stop_revision_id = True
537
revision_id_whitelist.extend(rev.parent_ids)
430
yield rev_id, depth, revno, end_of_merge
539
432
raise ValueError('invalid stop_rule %r' % stop_rule)
541
def _filter_start_non_ancestors(self, rev_iter):
542
# If we started from a dotted revno, we want to consider it as a tip
543
# and don't want to yield revisions that are not part of its
544
# ancestry. Given the order guaranteed by the merge sort, we will see
545
# uninteresting descendants of the first parent of our tip before the
547
first = rev_iter.next()
548
(rev_id, merge_depth, revno, end_of_merge) = first
551
# We start at a mainline revision so by definition, all others
552
# revisions in rev_iter are ancestors
553
for node in rev_iter:
558
pmap = self.repository.get_parent_map([rev_id])
559
parents = pmap.get(rev_id, [])
561
whitelist.update(parents)
563
# If there is no parents, there is nothing of interest left
565
# FIXME: It's hard to test this scenario here as this code is never
566
# called in that case. -- vila 20100322
569
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
571
if rev_id in whitelist:
572
pmap = self.repository.get_parent_map([rev_id])
573
parents = pmap.get(rev_id, [])
574
whitelist.remove(rev_id)
575
whitelist.update(parents)
577
# We've reached the mainline, there is nothing left to
581
# A revision that is not part of the ancestry of our
584
yield (rev_id, merge_depth, revno, end_of_merge)
586
434
def leave_lock_in_place(self):
587
435
"""Tell this branch object not to release the physical lock when this
588
436
object is unlocked.
746
564
:raises UnstackableRepositoryFormat: If the repository does not support
749
if not self._format.supports_stacking():
750
raise errors.UnstackableBranchFormat(self._format, self.user_url)
751
# XXX: Changing from one fallback repository to another does not check
752
# that all the data you need is present in the new fallback.
753
# Possibly it should.
754
self._check_stackable_repo()
757
old_url = self.get_stacked_on_url()
758
except (errors.NotStacked, errors.UnstackableBranchFormat,
759
errors.UnstackableRepositoryFormat):
763
self._activate_fallback_location(url)
764
# write this out after the repository is stacked to avoid setting a
765
# stacked config that doesn't work.
766
self._set_config_location('stacked_on_location', url)
769
"""Change a branch to be unstacked, copying data as needed.
771
Don't call this directly, use set_stacked_on_url(None).
773
pb = ui.ui_factory.nested_progress_bar()
775
pb.update("Unstacking")
776
# The basic approach here is to fetch the tip of the branch,
777
# including all available ghosts, from the existing stacked
778
# repository into a new repository object without the fallbacks.
780
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
781
# correct for CHKMap repostiories
782
old_repository = self.repository
783
if len(old_repository._fallback_repositories) != 1:
784
raise AssertionError("can't cope with fallback repositories "
785
"of %r" % (self.repository,))
786
# unlock it, including unlocking the fallback
787
old_repository.unlock()
788
old_repository.lock_read()
790
# Repositories don't offer an interface to remove fallback
791
# repositories today; take the conceptually simpler option and just
792
# reopen it. We reopen it starting from the URL so that we
793
# get a separate connection for RemoteRepositories and can
794
# stream from one of them to the other. This does mean doing
795
# separate SSH connection setup, but unstacking is not a
796
# common operation so it's tolerable.
797
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
798
new_repository = new_bzrdir.find_repository()
799
self.repository = new_repository
800
if self.repository._fallback_repositories:
801
raise AssertionError("didn't expect %r to have "
802
"fallback_repositories"
803
% (self.repository,))
804
# this is not paired with an unlock because it's just restoring
805
# the previous state; the lock's released when set_stacked_on_url
807
self.repository.lock_write()
808
# XXX: If you unstack a branch while it has a working tree
809
# with a pending merge, the pending-merged revisions will no
810
# longer be present. You can (probably) revert and remerge.
812
# XXX: This only fetches up to the tip of the repository; it
813
# doesn't bring across any tags. That's fairly consistent
814
# with how branch works, but perhaps not ideal.
815
self.repository.fetch(old_repository,
816
revision_id=self.last_revision(),
819
old_repository.unlock()
823
def _set_tags_bytes(self, bytes):
824
"""Mirror method for _get_tags_bytes.
826
:seealso: Branch._get_tags_bytes.
828
return _run_with_write_locked_target(self, self._transport.put_bytes,
567
raise NotImplementedError(self.set_stacked_on_url)
831
569
def _cache_revision_history(self, rev_history):
832
570
"""Set the cached revision history to rev_history.
964
704
information. This can be None.
967
return InterBranch.get(other, self).update_revisions(stop_revision,
970
def import_last_revision_info(self, source_repo, revno, revid):
971
"""Set the last revision info, importing from another repo if necessary.
973
This is used by the bound branch code to upload a revision to
974
the master branch first before updating the tip of the local branch.
976
:param source_repo: Source repository to optionally fetch from
977
:param revno: Revision number of the new tip
978
:param revid: Revision id of the new tip
980
if not self.repository.has_same_location(source_repo):
981
self.repository.fetch(source_repo, revision_id=revid)
982
self.set_last_revision_info(revno, revid)
709
other_revno, other_last_revision = other.last_revision_info()
710
stop_revno = None # unknown
711
if stop_revision is None:
712
stop_revision = other_last_revision
713
if _mod_revision.is_null(stop_revision):
714
# if there are no commits, we're done.
716
stop_revno = other_revno
718
# what's the current last revision, before we fetch [and change it
720
last_rev = _mod_revision.ensure_null(self.last_revision())
721
# we fetch here so that we don't process data twice in the common
722
# case of having something to pull, and so that the check for
723
# already merged can operate on the just fetched graph, which will
724
# be cached in memory.
725
self.fetch(other, stop_revision)
726
# Check to see if one is an ancestor of the other
729
graph = self.repository.get_graph()
730
if self._check_if_descendant_or_diverged(
731
stop_revision, last_rev, graph, other):
732
# stop_revision is a descendant of last_rev, but we aren't
733
# overwriting, so we're done.
735
if stop_revno is None:
737
graph = self.repository.get_graph()
738
this_revno, this_last_revision = self.last_revision_info()
739
stop_revno = graph.find_distance_to_null(stop_revision,
740
[(other_last_revision, other_revno),
741
(this_last_revision, this_revno)])
742
self.set_last_revision_info(stop_revno, stop_revision)
984
746
def revision_id_to_revno(self, revision_id):
985
747
"""Given a revision id, return its revno"""
991
753
except ValueError:
992
754
raise errors.NoSuchRevision(self, revision_id)
995
756
def get_rev_id(self, revno, history=None):
996
757
"""Find the revision id of the specified revno."""
998
759
return _mod_revision.NULL_REVISION
999
last_revno, last_revid = self.last_revision_info()
1000
if revno == last_revno:
1002
if revno <= 0 or revno > last_revno:
761
history = self.revision_history()
762
if revno <= 0 or revno > len(history):
1003
763
raise errors.NoSuchRevision(self, revno)
1004
distance_from_last = last_revno - revno
1005
if len(self._partial_revision_history_cache) <= distance_from_last:
1006
self._extend_partial_history(distance_from_last)
1007
return self._partial_revision_history_cache[distance_from_last]
764
return history[revno - 1]
1010
766
def pull(self, source, overwrite=False, stop_revision=None,
1011
possible_transports=None, *args, **kwargs):
767
possible_transports=None, _override_hook_target=None):
1012
768
"""Mirror source into this branch.
1014
770
This branch is considered to be 'local', having low latency.
1016
772
:returns: PullResult instance
1018
return InterBranch.get(source, self).pull(overwrite=overwrite,
1019
stop_revision=stop_revision,
1020
possible_transports=possible_transports, *args, **kwargs)
774
raise NotImplementedError(self.pull)
1022
def push(self, target, overwrite=False, stop_revision=None, *args,
776
def push(self, target, overwrite=False, stop_revision=None):
1024
777
"""Mirror this branch into target.
1026
779
This branch is considered to be 'local', having low latency.
1028
return InterBranch.get(self, target).push(overwrite, stop_revision,
1031
def lossy_push(self, target, stop_revision=None):
1032
"""Push deltas into another branch.
1034
:note: This does not, like push, retain the revision ids from
1035
the source branch and will, rather than adding bzr-specific
1036
metadata, push only those semantics of the revision that can be
1037
natively represented by this branch' VCS.
1039
:param target: Target branch
1040
:param stop_revision: Revision to push, defaults to last revision.
1041
:return: BranchPushResult with an extra member revidmap:
1042
A dictionary mapping revision ids from the target branch
1043
to new revision ids in the target branch, for each
1044
revision that was pushed.
1046
inter = InterBranch.get(self, target)
1047
lossy_push = getattr(inter, "lossy_push", None)
1048
if lossy_push is None:
1049
raise errors.LossyPushToSameVCS(self, target)
1050
return lossy_push(stop_revision)
781
raise NotImplementedError(self.push)
1052
783
def basis_tree(self):
1053
784
"""Return `Tree` object for last revision."""
1302
995
Callers will typically also want to check the repository.
1304
:param refs: Calculated refs for this branch as specified by
1305
branch._get_check_refs()
1306
997
:return: A BranchCheckResult.
1308
result = BranchCheckResult(self)
999
mainline_parent_id = None
1309
1000
last_revno, last_revision_id = self.last_revision_info()
1310
actual_revno = refs[('lefthand-distance', last_revision_id)]
1311
if actual_revno != last_revno:
1312
result.errors.append(errors.BzrCheckError(
1313
'revno does not match len(mainline) %s != %s' % (
1314
last_revno, actual_revno)))
1315
# TODO: We should probably also check that self.revision_history
1316
# matches the repository for older branch formats.
1317
# If looking for the code that cross-checks repository parents against
1318
# the iter_reverse_revision_history output, that is now a repository
1001
real_rev_history = list(self.repository.iter_reverse_revision_history(
1003
real_rev_history.reverse()
1004
if len(real_rev_history) != last_revno:
1005
raise errors.BzrCheckError('revno does not match len(mainline)'
1006
' %s != %s' % (last_revno, len(real_rev_history)))
1007
# TODO: We should probably also check that real_rev_history actually
1008
# matches self.revision_history()
1009
for revision_id in real_rev_history:
1011
revision = self.repository.get_revision(revision_id)
1012
except errors.NoSuchRevision, e:
1013
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1015
# In general the first entry on the revision history has no parents.
1016
# But it's not illegal for it to have parents listed; this can happen
1017
# in imports from Arch when the parents weren't reachable.
1018
if mainline_parent_id is not None:
1019
if mainline_parent_id not in revision.parent_ids:
1020
raise errors.BzrCheckError("previous revision {%s} not listed among "
1022
% (mainline_parent_id, revision_id))
1023
mainline_parent_id = revision_id
1024
return BranchCheckResult(self)
1322
1026
def _get_checkout_format(self):
1323
1027
"""Return the most suitable metadir for a checkout of this branch.
1707
1329
Hooks.__init__(self)
1708
self.create_hook(HookPoint('set_rh',
1709
"Invoked whenever the revision history has been set via "
1710
"set_revision_history. The api signature is (branch, "
1711
"revision_history), and the branch will be write-locked. "
1712
"The set_rh hook can be expensive for bzr to trigger, a better "
1713
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1714
self.create_hook(HookPoint('open',
1715
"Called with the Branch object that has been opened after a "
1716
"branch is opened.", (1, 8), None))
1717
self.create_hook(HookPoint('post_push',
1718
"Called after a push operation completes. post_push is called "
1719
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1720
"bzr client.", (0, 15), None))
1721
self.create_hook(HookPoint('post_pull',
1722
"Called after a pull operation completes. post_pull is called "
1723
"with a bzrlib.branch.PullResult object and only runs in the "
1724
"bzr client.", (0, 15), None))
1725
self.create_hook(HookPoint('pre_commit',
1726
"Called after a commit is calculated but before it is is "
1727
"completed. pre_commit is called with (local, master, old_revno, "
1728
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1729
"). old_revid is NULL_REVISION for the first commit to a branch, "
1730
"tree_delta is a TreeDelta object describing changes from the "
1731
"basis revision. hooks MUST NOT modify this delta. "
1732
" future_tree is an in-memory tree obtained from "
1733
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1734
"tree.", (0,91), None))
1735
self.create_hook(HookPoint('post_commit',
1736
"Called in the bzr client after a commit has completed. "
1737
"post_commit is called with (local, master, old_revno, old_revid, "
1738
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1739
"commit to a branch.", (0, 15), None))
1740
self.create_hook(HookPoint('post_uncommit',
1741
"Called in the bzr client after an uncommit completes. "
1742
"post_uncommit is called with (local, master, old_revno, "
1743
"old_revid, new_revno, new_revid) where local is the local branch "
1744
"or None, master is the target branch, and an empty branch "
1745
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1746
self.create_hook(HookPoint('pre_change_branch_tip',
1747
"Called in bzr client and server before a change to the tip of a "
1748
"branch is made. pre_change_branch_tip is called with a "
1749
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1750
"commit, uncommit will all trigger this hook.", (1, 6), None))
1751
self.create_hook(HookPoint('post_change_branch_tip',
1752
"Called in bzr client and server after a change to the tip of a "
1753
"branch is made. post_change_branch_tip is called with a "
1754
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1755
"commit, uncommit will all trigger this hook.", (1, 4), None))
1756
self.create_hook(HookPoint('transform_fallback_location',
1757
"Called when a stacked branch is activating its fallback "
1758
"locations. transform_fallback_location is called with (branch, "
1759
"url), and should return a new url. Returning the same url "
1760
"allows it to be used as-is, returning a different one can be "
1761
"used to cause the branch to stack on a closer copy of that "
1762
"fallback_location. Note that the branch cannot have history "
1763
"accessing methods called on it during this hook because the "
1764
"fallback locations have not been activated. When there are "
1765
"multiple hooks installed for transform_fallback_location, "
1766
"all are called with the url returned from the previous hook."
1767
"The order is however undefined.", (1, 9), None))
1768
self.create_hook(HookPoint('automatic_tag_name',
1769
"Called to determine an automatic tag name for a revision."
1770
"automatic_tag_name is called with (branch, revision_id) and "
1771
"should return a tag name or None if no tag name could be "
1772
"determined. The first non-None tag name returned will be used.",
1774
self.create_hook(HookPoint('post_branch_init',
1775
"Called after new branch initialization completes. "
1776
"post_branch_init is called with a "
1777
"bzrlib.branch.BranchInitHookParams. "
1778
"Note that init, branch and checkout (both heavyweight and "
1779
"lightweight) will all trigger this hook.", (2, 2), None))
1780
self.create_hook(HookPoint('post_switch',
1781
"Called after a checkout switches branch. "
1782
"post_switch is called with a "
1783
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1330
# Introduced in 0.15:
1331
# invoked whenever the revision history has been set
1332
# with set_revision_history. The api signature is
1333
# (branch, revision_history), and the branch will
1336
# Invoked after a branch is opened. The api signature is (branch).
1338
# invoked after a push operation completes.
1339
# the api signature is
1341
# containing the members
1342
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1343
# where local is the local target branch or None, master is the target
1344
# master branch, and the rest should be self explanatory. The source
1345
# is read locked and the target branches write locked. Source will
1346
# be the local low-latency branch.
1347
self['post_push'] = []
1348
# invoked after a pull operation completes.
1349
# the api signature is
1351
# containing the members
1352
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1353
# where local is the local branch or None, master is the target
1354
# master branch, and the rest should be self explanatory. The source
1355
# is read locked and the target branches write locked. The local
1356
# branch is the low-latency branch.
1357
self['post_pull'] = []
1358
# invoked before a commit operation takes place.
1359
# the api signature is
1360
# (local, master, old_revno, old_revid, future_revno, future_revid,
1361
# tree_delta, future_tree).
1362
# old_revid is NULL_REVISION for the first commit to a branch
1363
# tree_delta is a TreeDelta object describing changes from the basis
1364
# revision, hooks MUST NOT modify this delta
1365
# future_tree is an in-memory tree obtained from
1366
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1367
self['pre_commit'] = []
1368
# invoked after a commit operation completes.
1369
# the api signature is
1370
# (local, master, old_revno, old_revid, new_revno, new_revid)
1371
# old_revid is NULL_REVISION for the first commit to a branch.
1372
self['post_commit'] = []
1373
# invoked after a uncommit operation completes.
1374
# the api signature is
1375
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1376
# local is the local branch or None, master is the target branch,
1377
# and an empty branch recieves new_revno of 0, new_revid of None.
1378
self['post_uncommit'] = []
1380
# Invoked before the tip of a branch changes.
1381
# the api signature is
1382
# (params) where params is a ChangeBranchTipParams with the members
1383
# (branch, old_revno, new_revno, old_revid, new_revid)
1384
self['pre_change_branch_tip'] = []
1386
# Invoked after the tip of a branch changes.
1387
# the api signature is
1388
# (params) where params is a ChangeBranchTipParams with the members
1389
# (branch, old_revno, new_revno, old_revid, new_revid)
1390
self['post_change_branch_tip'] = []
1392
# Invoked when a stacked branch activates its fallback locations and
1393
# allows the transformation of the url of said location.
1394
# the api signature is
1395
# (branch, url) where branch is the branch having its fallback
1396
# location activated and url is the url for the fallback location.
1397
# The hook should return a url.
1398
self['transform_fallback_location'] = []
1787
1401
# install the default hooks into the Branch class.
1826
1440
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1829
class BranchInitHookParams(object):
1830
"""Object holding parameters passed to *_branch_init hooks.
1832
There are 4 fields that hooks may wish to access:
1834
:ivar format: the branch format
1835
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1836
:ivar name: name of colocated branch, if any (or None)
1837
:ivar branch: the branch created
1839
Note that for lightweight checkouts, the bzrdir and format fields refer to
1840
the checkout, hence they are different from the corresponding fields in
1841
branch, which refer to the original branch.
1844
def __init__(self, format, a_bzrdir, name, branch):
1845
"""Create a group of BranchInitHook parameters.
1847
:param format: the branch format
1848
:param a_bzrdir: the BzrDir where the branch will be/has been
1850
:param name: name of colocated branch, if any (or None)
1851
:param branch: the branch created
1853
Note that for lightweight checkouts, the bzrdir and format fields refer
1854
to the checkout, hence they are different from the corresponding fields
1855
in branch, which refer to the original branch.
1857
self.format = format
1858
self.bzrdir = a_bzrdir
1860
self.branch = branch
1862
def __eq__(self, other):
1863
return self.__dict__ == other.__dict__
1867
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1869
return "<%s of format:%s bzrdir:%s>" % (
1870
self.__class__.__name__, self.branch,
1871
self.format, self.bzrdir)
1874
class SwitchHookParams(object):
1875
"""Object holding parameters passed to *_switch hooks.
1877
There are 4 fields that hooks may wish to access:
1879
:ivar control_dir: BzrDir of the checkout to change
1880
:ivar to_branch: branch that the checkout is to reference
1881
:ivar force: skip the check for local commits in a heavy checkout
1882
:ivar revision_id: revision ID to switch to (or None)
1885
def __init__(self, control_dir, to_branch, force, revision_id):
1886
"""Create a group of SwitchHook parameters.
1888
:param control_dir: BzrDir of the checkout to change
1889
:param to_branch: branch that the checkout is to reference
1890
:param force: skip the check for local commits in a heavy checkout
1891
:param revision_id: revision ID to switch to (or None)
1893
self.control_dir = control_dir
1894
self.to_branch = to_branch
1896
self.revision_id = revision_id
1898
def __eq__(self, other):
1899
return self.__dict__ == other.__dict__
1902
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1903
self.control_dir, self.to_branch,
1907
1443
class BzrBranchFormat4(BranchFormat):
1908
1444
"""Bzr branch format 4.
2047
1588
"""See BranchFormat.get_format_description()."""
2048
1589
return "Branch format 6"
2050
def initialize(self, a_bzrdir, name=None):
2051
"""Create a branch of this format in a_bzrdir."""
2052
utf8_files = [('last-revision', '0 null:\n'),
2053
('branch.conf', ''),
2056
return self._initialize_helper(a_bzrdir, utf8_files, name)
2058
def make_tags(self, branch):
2059
"""See bzrlib.branch.BranchFormat.make_tags()."""
2060
return BasicTags(branch)
2062
def supports_set_append_revisions_only(self):
2066
class BzrBranchFormat8(BranchFormatMetadir):
2067
"""Metadir format supporting storing locations of subtree branches."""
2069
def _branch_class(self):
2072
def get_format_string(self):
2073
"""See BranchFormat.get_format_string()."""
2074
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2076
def get_format_description(self):
2077
"""See BranchFormat.get_format_description()."""
2078
return "Branch format 8"
2080
def initialize(self, a_bzrdir, name=None):
2081
"""Create a branch of this format in a_bzrdir."""
2082
utf8_files = [('last-revision', '0 null:\n'),
2083
('branch.conf', ''),
2087
return self._initialize_helper(a_bzrdir, utf8_files, name)
2090
super(BzrBranchFormat8, self).__init__()
2091
self._matchingbzrdir.repository_format = \
2092
RepositoryFormatKnitPack5RichRoot()
2094
def make_tags(self, branch):
2095
"""See bzrlib.branch.BranchFormat.make_tags()."""
2096
return BasicTags(branch)
2098
def supports_set_append_revisions_only(self):
2101
def supports_stacking(self):
2104
supports_reference_locations = True
2107
class BzrBranchFormat7(BzrBranchFormat8):
1591
def initialize(self, a_bzrdir):
1592
"""Create a branch of this format in a_bzrdir."""
1593
utf8_files = [('last-revision', '0 null:\n'),
1594
('branch.conf', ''),
1597
return self._initialize_helper(a_bzrdir, utf8_files)
1600
class BzrBranchFormat7(BranchFormatMetadir):
2108
1601
"""Branch format with last-revision, tags, and a stacked location pointer.
2110
1603
The stacked location pointer is passed down to the repository and requires
2160
1656
def get_reference(self, a_bzrdir):
2161
1657
"""See BranchFormat.get_reference()."""
2162
1658
transport = a_bzrdir.get_branch_transport(None)
2163
return transport.get_bytes('location')
1659
return transport.get('location').read()
2165
1661
def set_reference(self, a_bzrdir, to_branch):
2166
1662
"""See BranchFormat.set_reference()."""
2167
1663
transport = a_bzrdir.get_branch_transport(None)
2168
1664
location = transport.put_bytes('location', to_branch.base)
2170
def initialize(self, a_bzrdir, name=None, target_branch=None):
1666
def initialize(self, a_bzrdir, target_branch=None):
2171
1667
"""Create a branch of this format in a_bzrdir."""
2172
1668
if target_branch is None:
2173
1669
# this format does not implement branch itself, thus the implicit
2174
1670
# creation contract must see it as uninitializable
2175
1671
raise errors.UninitializableFormat(self)
2176
mutter('creating branch reference in %s', a_bzrdir.user_url)
2177
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1672
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1673
branch_transport = a_bzrdir.get_branch_transport(self)
2178
1674
branch_transport.put_bytes('location',
2179
target_branch.bzrdir.user_url)
1675
target_branch.bzrdir.root_transport.base)
2180
1676
branch_transport.put_bytes('format', self.get_format_string())
2182
a_bzrdir, name, _found=True,
1678
a_bzrdir, _found=True,
2183
1679
possible_transports=[target_branch.bzrdir.root_transport])
2184
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2187
1681
def __init__(self):
2188
1682
super(BranchReferenceFormat, self).__init__()
2192
1686
def _make_reference_clone_function(format, a_branch):
2193
1687
"""Create a clone() routine for a branch dynamically."""
2194
def clone(to_bzrdir, revision_id=None,
2195
repository_policy=None):
1688
def clone(to_bzrdir, revision_id=None):
2196
1689
"""See Branch.clone()."""
2197
return format.initialize(to_bzrdir, target_branch=a_branch)
1690
return format.initialize(to_bzrdir, a_branch)
2198
1691
# cannot obey revision_id limits when cloning a reference ...
2199
1692
# FIXME RBC 20060210 either nuke revision_id for clone, or
2200
1693
# emit some sort of warning/error to the caller ?!
2203
def open(self, a_bzrdir, name=None, _found=False, location=None,
2204
possible_transports=None, ignore_fallbacks=False):
1696
def open(self, a_bzrdir, _found=False, location=None,
1697
possible_transports=None):
2205
1698
"""Return the branch that the branch reference in a_bzrdir points at.
2207
:param a_bzrdir: A BzrDir that contains a branch.
2208
:param name: Name of colocated branch to open, if any
2209
:param _found: a private parameter, do not use it. It is used to
2210
indicate if format probing has already be done.
2211
:param ignore_fallbacks: when set, no fallback branches will be opened
2212
(if there are any). Default is to open fallbacks.
2213
:param location: The location of the referenced branch. If
2214
unspecified, this will be determined from the branch reference in
2216
:param possible_transports: An optional reusable transports list.
1700
_found is a private parameter, do not use it. It is used to indicate
1701
if format probing has already be done.
2219
format = BranchFormat.find_format(a_bzrdir, name=name)
1704
format = BranchFormat.find_format(a_bzrdir)
2220
1705
if format.__class__ != self.__class__:
2221
1706
raise AssertionError("wrong format %r found for %r" %
2222
1707
(format, self))
2318
1792
base = property(_get_base, doc="The URL for the root of this branch.")
2320
def _get_config(self):
2321
return TransportConfig(self._transport, 'branch.conf')
2323
1794
def is_locked(self):
2324
1795
return self.control_files.is_locked()
2326
1797
def lock_write(self, token=None):
2327
if not self.is_locked():
2328
self._note_lock('w')
2329
# All-in-one needs to always unlock/lock.
2330
repo_control = getattr(self.repository, 'control_files', None)
2331
if self.control_files == repo_control or not self.is_locked():
2332
self.repository._warn_if_deprecated(self)
2333
self.repository.lock_write()
1798
repo_token = self.repository.lock_write()
2338
return self.control_files.lock_write(token=token)
1800
token = self.control_files.lock_write(token=token)
2341
self.repository.unlock()
1802
self.repository.unlock()
2344
1806
def lock_read(self):
2345
if not self.is_locked():
2346
self._note_lock('r')
2347
# All-in-one needs to always unlock/lock.
2348
repo_control = getattr(self.repository, 'control_files', None)
2349
if self.control_files == repo_control or not self.is_locked():
2350
self.repository._warn_if_deprecated(self)
2351
self.repository.lock_read()
1807
self.repository.lock_read()
2356
1809
self.control_files.lock_read()
2359
self.repository.unlock()
1811
self.repository.unlock()
2362
@only_raises(errors.LockNotHeld, errors.LockBroken)
2363
1814
def unlock(self):
1815
# TODO: test for failed two phase locks. This is known broken.
2365
1817
self.control_files.unlock()
2367
# All-in-one needs to always unlock/lock.
2368
repo_control = getattr(self.repository, 'control_files', None)
2369
if (self.control_files == repo_control or
2370
not self.control_files.is_locked()):
2371
self.repository.unlock()
2372
if not self.control_files.is_locked():
2373
# we just released the lock
2374
self._clear_cached_state()
1819
self.repository.unlock()
1820
if not self.control_files.is_locked():
1821
# we just released the lock
1822
self._clear_cached_state()
2376
1824
def peek_lock_mode(self):
2377
1825
if self.control_files._lock_count == 0:
2496
1944
"""See Branch.basis_tree."""
2497
1945
return self.repository.revision_tree(self.last_revision())
1948
def pull(self, source, overwrite=False, stop_revision=None,
1949
_hook_master=None, run_hooks=True, possible_transports=None,
1950
_override_hook_target=None):
1953
:param _hook_master: Private parameter - set the branch to
1954
be supplied as the master to pull hooks.
1955
:param run_hooks: Private parameter - if false, this branch
1956
is being called because it's the master of the primary branch,
1957
so it should not run its hooks.
1958
:param _override_hook_target: Private parameter - set the branch to be
1959
supplied as the target_branch to pull hooks.
1961
result = PullResult()
1962
result.source_branch = source
1963
if _override_hook_target is None:
1964
result.target_branch = self
1966
result.target_branch = _override_hook_target
1969
# We assume that during 'pull' the local repository is closer than
1971
graph = self.repository.get_graph(source.repository)
1972
result.old_revno, result.old_revid = self.last_revision_info()
1973
self.update_revisions(source, stop_revision, overwrite=overwrite,
1975
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1976
result.new_revno, result.new_revid = self.last_revision_info()
1978
result.master_branch = _hook_master
1979
result.local_branch = result.target_branch
1981
result.master_branch = result.target_branch
1982
result.local_branch = None
1984
for hook in Branch.hooks['post_pull']:
2499
1990
def _get_parent_location(self):
2500
1991
_locs = ['parent', 'pull', 'x-pull']
2501
1992
for l in _locs:
2000
def push(self, target, overwrite=False, stop_revision=None,
2001
_override_hook_source_branch=None):
2004
This is the basic concrete implementation of push()
2006
:param _override_hook_source_branch: If specified, run
2007
the hooks passing this Branch as the source, rather than self.
2008
This is for use of RemoteBranch, where push is delegated to the
2009
underlying vfs-based Branch.
2011
# TODO: Public option to disable running hooks - should be trivial but
2013
return _run_with_write_locked_target(
2014
target, self._push_with_bound_branches, target, overwrite,
2016
_override_hook_source_branch=_override_hook_source_branch)
2018
def _push_with_bound_branches(self, target, overwrite,
2020
_override_hook_source_branch=None):
2021
"""Push from self into target, and into target's master if any.
2023
This is on the base BzrBranch class even though it doesn't support
2024
bound branches because the *target* might be bound.
2027
if _override_hook_source_branch:
2028
result.source_branch = _override_hook_source_branch
2029
for hook in Branch.hooks['post_push']:
2032
bound_location = target.get_bound_location()
2033
if bound_location and target.base != bound_location:
2034
# there is a master branch.
2036
# XXX: Why the second check? Is it even supported for a branch to
2037
# be bound to itself? -- mbp 20070507
2038
master_branch = target.get_master_branch()
2039
master_branch.lock_write()
2041
# push into the master from this branch.
2042
self._basic_push(master_branch, overwrite, stop_revision)
2043
# and push into the target branch from this. Note that we push from
2044
# this branch again, because its considered the highest bandwidth
2046
result = self._basic_push(target, overwrite, stop_revision)
2047
result.master_branch = master_branch
2048
result.local_branch = target
2052
master_branch.unlock()
2055
result = self._basic_push(target, overwrite, stop_revision)
2056
# TODO: Why set master_branch and local_branch if there's no
2057
# binding? Maybe cleaner to just leave them unset? -- mbp
2059
result.master_branch = target
2060
result.local_branch = None
2508
2064
def _basic_push(self, target, overwrite, stop_revision):
2509
2065
"""Basic implementation of push without bound branches or hooks.
2511
Must be called with source read locked and target write locked.
2067
Must be called with self read locked and target write locked.
2513
result = BranchPushResult()
2069
result = PushResult()
2514
2070
result.source_branch = self
2515
2071
result.target_branch = target
2516
2072
result.old_revno, result.old_revid = target.last_revision_info()
2517
self.update_references(target)
2518
2073
if result.old_revid != self.last_revision():
2519
2074
# We assume that during 'push' this repository is closer than
2521
2076
graph = self.repository.get_graph(target.repository)
2522
target.update_revisions(self, stop_revision,
2523
overwrite=overwrite, graph=graph)
2077
target.update_revisions(self, stop_revision, overwrite=overwrite,
2524
2079
if self._push_should_merge_tags():
2525
result.tag_conflicts = self.tags.merge_to(target.tags,
2080
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2527
2081
result.new_revno, result.new_revid = target.last_revision_info()
2084
def get_parent(self):
2085
"""See Branch.get_parent."""
2086
parent = self._get_parent_location()
2089
# This is an old-format absolute path to a local branch
2090
# turn it into a url
2091
if parent.startswith('/'):
2092
parent = urlutils.local_path_to_url(parent.decode('utf8'))
2094
return urlutils.join(self.base[:-1], parent)
2095
except errors.InvalidURLJoin, e:
2096
raise errors.InaccessibleParent(parent, self.base)
2530
2098
def get_stacked_on_url(self):
2531
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2099
raise errors.UnstackableBranchFormat(self._format, self.base)
2533
2101
def set_push_location(self, location):
2534
2102
"""See Branch.set_push_location."""
2759
2420
"""Set the parent branch"""
2760
2421
return self._get_config_location('parent_location')
2763
def _set_all_reference_info(self, info_dict):
2764
"""Replace all reference info stored in a branch.
2766
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2769
writer = rio.RioWriter(s)
2770
for key, (tree_path, branch_location) in info_dict.iteritems():
2771
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2772
branch_location=branch_location)
2773
writer.write_stanza(stanza)
2774
self._transport.put_bytes('references', s.getvalue())
2775
self._reference_info = info_dict
2778
def _get_all_reference_info(self):
2779
"""Return all the reference info stored in a branch.
2781
:return: A dict of {file_id: (tree_path, branch_location)}
2783
if self._reference_info is not None:
2784
return self._reference_info
2785
rio_file = self._transport.get('references')
2787
stanzas = rio.read_stanzas(rio_file)
2788
info_dict = dict((s['file_id'], (s['tree_path'],
2789
s['branch_location'])) for s in stanzas)
2792
self._reference_info = info_dict
2795
def set_reference_info(self, file_id, tree_path, branch_location):
2796
"""Set the branch location to use for a tree reference.
2798
:param file_id: The file-id of the tree reference.
2799
:param tree_path: The path of the tree reference in the tree.
2800
:param branch_location: The location of the branch to retrieve tree
2803
info_dict = self._get_all_reference_info()
2804
info_dict[file_id] = (tree_path, branch_location)
2805
if None in (tree_path, branch_location):
2806
if tree_path is not None:
2807
raise ValueError('tree_path must be None when branch_location'
2809
if branch_location is not None:
2810
raise ValueError('branch_location must be None when tree_path'
2812
del info_dict[file_id]
2813
self._set_all_reference_info(info_dict)
2815
def get_reference_info(self, file_id):
2816
"""Get the tree_path and branch_location for a tree reference.
2818
:return: a tuple of (tree_path, branch_location)
2820
return self._get_all_reference_info().get(file_id, (None, None))
2822
def reference_parent(self, file_id, path, possible_transports=None):
2823
"""Return the parent branch for a tree-reference file_id.
2825
:param file_id: The file_id of the tree reference
2826
:param path: The path of the file_id in the tree
2827
:return: A branch associated with the file_id
2829
branch_location = self.get_reference_info(file_id)[1]
2830
if branch_location is None:
2831
return Branch.reference_parent(self, file_id, path,
2832
possible_transports)
2833
branch_location = urlutils.join(self.user_url, branch_location)
2834
return Branch.open(branch_location,
2835
possible_transports=possible_transports)
2837
2423
def set_push_location(self, location):
2838
2424
"""See Branch.set_push_location."""
2839
2425
self._set_config_location('push_location', location)
3133
2727
target.unlock()
3137
class InterBranch(InterObject):
3138
"""This class represents operations taking place between two branches.
3140
Its instances have methods like pull() and push() and contain
3141
references to the source and target repositories these operations
3142
can be carried out on.
3146
"""The available optimised InterBranch types."""
3149
def _get_branch_formats_to_test():
3150
"""Return a tuple with the Branch formats to use when testing."""
3151
raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3153
def pull(self, overwrite=False, stop_revision=None,
3154
possible_transports=None, local=False):
3155
"""Mirror source into target branch.
3157
The target branch is considered to be 'local', having low latency.
3159
:returns: PullResult instance
3161
raise NotImplementedError(self.pull)
3163
def update_revisions(self, stop_revision=None, overwrite=False,
3165
"""Pull in new perfect-fit revisions.
3167
:param stop_revision: Updated until the given revision
3168
:param overwrite: Always set the branch pointer, rather than checking
3169
to see if it is a proper descendant.
3170
:param graph: A Graph object that can be used to query history
3171
information. This can be None.
3174
raise NotImplementedError(self.update_revisions)
3176
def push(self, overwrite=False, stop_revision=None,
3177
_override_hook_source_branch=None):
3178
"""Mirror the source branch into the target branch.
3180
The source branch is considered to be 'local', having low latency.
3182
raise NotImplementedError(self.push)
3185
class GenericInterBranch(InterBranch):
3186
"""InterBranch implementation that uses public Branch functions.
3190
def _get_branch_formats_to_test():
3191
return BranchFormat._default_format, BranchFormat._default_format
3193
def update_revisions(self, stop_revision=None, overwrite=False,
3195
"""See InterBranch.update_revisions()."""
3196
self.source.lock_read()
3198
other_revno, other_last_revision = self.source.last_revision_info()
3199
stop_revno = None # unknown
3200
if stop_revision is None:
3201
stop_revision = other_last_revision
3202
if _mod_revision.is_null(stop_revision):
3203
# if there are no commits, we're done.
3205
stop_revno = other_revno
3207
# what's the current last revision, before we fetch [and change it
3209
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3210
# we fetch here so that we don't process data twice in the common
3211
# case of having something to pull, and so that the check for
3212
# already merged can operate on the just fetched graph, which will
3213
# be cached in memory.
3214
self.target.fetch(self.source, stop_revision)
3215
# Check to see if one is an ancestor of the other
3218
graph = self.target.repository.get_graph()
3219
if self.target._check_if_descendant_or_diverged(
3220
stop_revision, last_rev, graph, self.source):
3221
# stop_revision is a descendant of last_rev, but we aren't
3222
# overwriting, so we're done.
3224
if stop_revno is None:
3226
graph = self.target.repository.get_graph()
3227
this_revno, this_last_revision = \
3228
self.target.last_revision_info()
3229
stop_revno = graph.find_distance_to_null(stop_revision,
3230
[(other_last_revision, other_revno),
3231
(this_last_revision, this_revno)])
3232
self.target.set_last_revision_info(stop_revno, stop_revision)
3234
self.source.unlock()
3236
def pull(self, overwrite=False, stop_revision=None,
3237
possible_transports=None, _hook_master=None, run_hooks=True,
3238
_override_hook_target=None, local=False):
3241
:param _hook_master: Private parameter - set the branch to
3242
be supplied as the master to pull hooks.
3243
:param run_hooks: Private parameter - if false, this branch
3244
is being called because it's the master of the primary branch,
3245
so it should not run its hooks.
3246
:param _override_hook_target: Private parameter - set the branch to be
3247
supplied as the target_branch to pull hooks.
3248
:param local: Only update the local branch, and not the bound branch.
3250
# This type of branch can't be bound.
3252
raise errors.LocalRequiresBoundBranch()
3253
result = PullResult()
3254
result.source_branch = self.source
3255
if _override_hook_target is None:
3256
result.target_branch = self.target
3258
result.target_branch = _override_hook_target
3259
self.source.lock_read()
3261
# We assume that during 'pull' the target repository is closer than
3263
self.source.update_references(self.target)
3264
graph = self.target.repository.get_graph(self.source.repository)
3265
# TODO: Branch formats should have a flag that indicates
3266
# that revno's are expensive, and pull() should honor that flag.
3268
result.old_revno, result.old_revid = \
3269
self.target.last_revision_info()
3270
self.target.update_revisions(self.source, stop_revision,
3271
overwrite=overwrite, graph=graph)
3272
# TODO: The old revid should be specified when merging tags,
3273
# so a tags implementation that versions tags can only
3274
# pull in the most recent changes. -- JRV20090506
3275
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3277
result.new_revno, result.new_revid = self.target.last_revision_info()
3279
result.master_branch = _hook_master
3280
result.local_branch = result.target_branch
3282
result.master_branch = result.target_branch
3283
result.local_branch = None
3285
for hook in Branch.hooks['post_pull']:
3288
self.source.unlock()
3291
def push(self, overwrite=False, stop_revision=None,
3292
_override_hook_source_branch=None):
3293
"""See InterBranch.push.
3295
This is the basic concrete implementation of push()
3297
:param _override_hook_source_branch: If specified, run
3298
the hooks passing this Branch as the source, rather than self.
3299
This is for use of RemoteBranch, where push is delegated to the
3300
underlying vfs-based Branch.
3302
# TODO: Public option to disable running hooks - should be trivial but
3304
self.source.lock_read()
3306
return _run_with_write_locked_target(
3307
self.target, self._push_with_bound_branches, overwrite,
3309
_override_hook_source_branch=_override_hook_source_branch)
3311
self.source.unlock()
3313
def _push_with_bound_branches(self, overwrite, stop_revision,
3314
_override_hook_source_branch=None):
3315
"""Push from source into target, and into target's master if any.
3318
if _override_hook_source_branch:
3319
result.source_branch = _override_hook_source_branch
3320
for hook in Branch.hooks['post_push']:
3323
bound_location = self.target.get_bound_location()
3324
if bound_location and self.target.base != bound_location:
3325
# there is a master branch.
3327
# XXX: Why the second check? Is it even supported for a branch to
3328
# be bound to itself? -- mbp 20070507
3329
master_branch = self.target.get_master_branch()
3330
master_branch.lock_write()
3332
# push into the master from the source branch.
3333
self.source._basic_push(master_branch, overwrite, stop_revision)
3334
# and push into the target branch from the source. Note that we
3335
# push from the source branch again, because its considered the
3336
# highest bandwidth repository.
3337
result = self.source._basic_push(self.target, overwrite,
3339
result.master_branch = master_branch
3340
result.local_branch = self.target
3344
master_branch.unlock()
3347
result = self.source._basic_push(self.target, overwrite,
3349
# TODO: Why set master_branch and local_branch if there's no
3350
# binding? Maybe cleaner to just leave them unset? -- mbp
3352
result.master_branch = self.target
3353
result.local_branch = None
3358
def is_compatible(self, source, target):
3359
# GenericBranch uses the public API, so always compatible
3363
class InterToBranch5(GenericInterBranch):
3366
def _get_branch_formats_to_test():
3367
return BranchFormat._default_format, BzrBranchFormat5()
3369
def pull(self, overwrite=False, stop_revision=None,
3370
possible_transports=None, run_hooks=True,
3371
_override_hook_target=None, local=False):
3372
"""Pull from source into self, updating my master if any.
3374
:param run_hooks: Private parameter - if false, this branch
3375
is being called because it's the master of the primary branch,
3376
so it should not run its hooks.
3378
bound_location = self.target.get_bound_location()
3379
if local and not bound_location:
3380
raise errors.LocalRequiresBoundBranch()
3381
master_branch = None
3382
if not local and bound_location and self.source.user_url != bound_location:
3383
# not pulling from master, so we need to update master.
3384
master_branch = self.target.get_master_branch(possible_transports)
3385
master_branch.lock_write()
3388
# pull from source into master.
3389
master_branch.pull(self.source, overwrite, stop_revision,
3391
return super(InterToBranch5, self).pull(overwrite,
3392
stop_revision, _hook_master=master_branch,
3393
run_hooks=run_hooks,
3394
_override_hook_target=_override_hook_target)
3397
master_branch.unlock()
3400
InterBranch.register_optimiser(GenericInterBranch)
3401
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
