512
442
"""Iterate over an inclusive range of sorted revisions."""
513
443
rev_iter = iter(merge_sorted_revisions)
514
444
if start_revision_id is not None:
515
for node in rev_iter:
445
for rev_id, depth, revno, end_of_merge in rev_iter:
517
446
if rev_id != start_revision_id:
520
449
# The decision to include the start or not
521
450
# depends on the stop_rule if a stop is provided
522
# so pop this node back into the iterator
523
rev_iter = chain(iter([node]), rev_iter)
452
iter([(rev_id, depth, revno, end_of_merge)]),
525
455
if stop_revision_id is None:
527
for node in rev_iter:
529
yield (rev_id, node.merge_depth, node.revno,
456
for rev_id, depth, revno, end_of_merge in rev_iter:
457
yield rev_id, depth, revno, end_of_merge
531
458
elif stop_rule == 'exclude':
532
for node in rev_iter:
459
for rev_id, depth, revno, end_of_merge in rev_iter:
534
460
if rev_id == stop_revision_id:
536
yield (rev_id, node.merge_depth, node.revno,
462
yield rev_id, depth, revno, end_of_merge
538
463
elif stop_rule == 'include':
539
for node in rev_iter:
541
yield (rev_id, node.merge_depth, node.revno,
464
for rev_id, depth, revno, end_of_merge in rev_iter:
465
yield rev_id, depth, revno, end_of_merge
543
466
if rev_id == stop_revision_id:
545
elif stop_rule == 'with-merges-without-common-ancestry':
546
# We want to exclude all revisions that are already part of the
547
# stop_revision_id ancestry.
548
graph = self.repository.get_graph()
549
ancestors = graph.find_unique_ancestors(start_revision_id,
551
for node in rev_iter:
553
if rev_id not in ancestors:
555
yield (rev_id, node.merge_depth, node.revno,
557
468
elif stop_rule == 'with-merges':
558
469
stop_rev = self.repository.get_revision(stop_revision_id)
559
470
if stop_rev.parent_ids:
560
471
left_parent = stop_rev.parent_ids[0]
562
473
left_parent = _mod_revision.NULL_REVISION
563
# left_parent is the actual revision we want to stop logging at,
564
# since we want to show the merged revisions after the stop_rev too
565
reached_stop_revision_id = False
566
revision_id_whitelist = []
567
for node in rev_iter:
474
for rev_id, depth, revno, end_of_merge in rev_iter:
569
475
if rev_id == left_parent:
570
# reached the left parent after the stop_revision
572
if (not reached_stop_revision_id or
573
rev_id in revision_id_whitelist):
574
yield (rev_id, node.merge_depth, node.revno,
576
if reached_stop_revision_id or rev_id == stop_revision_id:
577
# only do the merged revs of rev_id from now on
578
rev = self.repository.get_revision(rev_id)
580
reached_stop_revision_id = True
581
revision_id_whitelist.extend(rev.parent_ids)
477
yield rev_id, depth, revno, end_of_merge
583
479
raise ValueError('invalid stop_rule %r' % stop_rule)
585
def _filter_start_non_ancestors(self, rev_iter):
586
# If we started from a dotted revno, we want to consider it as a tip
587
# and don't want to yield revisions that are not part of its
588
# ancestry. Given the order guaranteed by the merge sort, we will see
589
# uninteresting descendants of the first parent of our tip before the
591
first = rev_iter.next()
592
(rev_id, merge_depth, revno, end_of_merge) = first
595
# We start at a mainline revision so by definition, all others
596
# revisions in rev_iter are ancestors
597
for node in rev_iter:
602
pmap = self.repository.get_parent_map([rev_id])
603
parents = pmap.get(rev_id, [])
605
whitelist.update(parents)
607
# If there is no parents, there is nothing of interest left
609
# FIXME: It's hard to test this scenario here as this code is never
610
# called in that case. -- vila 20100322
613
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
615
if rev_id in whitelist:
616
pmap = self.repository.get_parent_map([rev_id])
617
parents = pmap.get(rev_id, [])
618
whitelist.remove(rev_id)
619
whitelist.update(parents)
621
# We've reached the mainline, there is nothing left to
625
# A revision that is not part of the ancestry of our
628
yield (rev_id, merge_depth, revno, end_of_merge)
630
481
def leave_lock_in_place(self):
631
482
"""Tell this branch object not to release the physical lock when this
632
483
object is unlocked.
835
640
except (errors.NotStacked, errors.UnstackableBranchFormat,
836
641
errors.UnstackableRepositoryFormat):
644
# XXX: Lock correctness - should unlock our old repo if we were
646
# repositories don't offer an interface to remove fallback
647
# repositories today; take the conceptually simpler option and just
649
self.repository = self.bzrdir.find_repository()
650
self.repository.lock_write()
651
# for every revision reference the branch has, ensure it is pulled
653
source_repository = self._get_fallback_repository(old_url)
654
for revision_id in chain([self.last_revision()],
655
self.tags.get_reverse_tag_dict()):
656
self.repository.fetch(source_repository, revision_id,
840
self._activate_fallback_location(url)
659
self._activate_fallback_location(url, 'write')
841
660
# write this out after the repository is stacked to avoid setting a
842
661
# stacked config that doesn't work.
843
662
self._set_config_location('stacked_on_location', url)
846
"""Change a branch to be unstacked, copying data as needed.
848
Don't call this directly, use set_stacked_on_url(None).
850
pb = ui.ui_factory.nested_progress_bar()
852
pb.update("Unstacking")
853
# The basic approach here is to fetch the tip of the branch,
854
# including all available ghosts, from the existing stacked
855
# repository into a new repository object without the fallbacks.
857
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
858
# correct for CHKMap repostiories
859
old_repository = self.repository
860
if len(old_repository._fallback_repositories) != 1:
861
raise AssertionError("can't cope with fallback repositories "
862
"of %r (fallbacks: %r)" % (old_repository,
863
old_repository._fallback_repositories))
864
# Open the new repository object.
865
# Repositories don't offer an interface to remove fallback
866
# repositories today; take the conceptually simpler option and just
867
# reopen it. We reopen it starting from the URL so that we
868
# get a separate connection for RemoteRepositories and can
869
# stream from one of them to the other. This does mean doing
870
# separate SSH connection setup, but unstacking is not a
871
# common operation so it's tolerable.
872
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
873
new_repository = new_bzrdir.find_repository()
874
if new_repository._fallback_repositories:
875
raise AssertionError("didn't expect %r to have "
876
"fallback_repositories"
877
% (self.repository,))
878
# Replace self.repository with the new repository.
879
# Do our best to transfer the lock state (i.e. lock-tokens and
880
# lock count) of self.repository to the new repository.
881
lock_token = old_repository.lock_write().repository_token
882
self.repository = new_repository
883
if isinstance(self, remote.RemoteBranch):
884
# Remote branches can have a second reference to the old
885
# repository that need to be replaced.
886
if self._real_branch is not None:
887
self._real_branch.repository = new_repository
888
self.repository.lock_write(token=lock_token)
889
if lock_token is not None:
890
old_repository.leave_lock_in_place()
891
old_repository.unlock()
892
if lock_token is not None:
893
# XXX: self.repository.leave_lock_in_place() before this
894
# function will not be preserved. Fortunately that doesn't
895
# affect the current default format (2a), and would be a
896
# corner-case anyway.
897
# - Andrew Bennetts, 2010/06/30
898
self.repository.dont_leave_lock_in_place()
902
old_repository.unlock()
903
except errors.LockNotHeld:
906
if old_lock_count == 0:
907
raise AssertionError(
908
'old_repository should have been locked at least once.')
909
for i in range(old_lock_count-1):
910
self.repository.lock_write()
911
# Fetch from the old repository into the new.
912
old_repository.lock_read()
914
# XXX: If you unstack a branch while it has a working tree
915
# with a pending merge, the pending-merged revisions will no
916
# longer be present. You can (probably) revert and remerge.
918
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
919
except errors.TagsNotSupported:
920
tags_to_fetch = set()
921
fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
922
old_repository, required_ids=[self.last_revision()],
923
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
924
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
926
old_repository.unlock()
930
665
def _set_tags_bytes(self, bytes):
931
666
"""Mirror method for _get_tags_bytes.
933
668
:seealso: Branch._get_tags_bytes.
935
op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
936
op.add_cleanup(self.lock_write().unlock)
937
return op.run_simple(bytes)
939
def _set_tags_bytes_locked(self, bytes):
940
self._tags_bytes = bytes
941
return self._transport.put_bytes('tags', bytes)
670
return _run_with_write_locked_target(self, self._transport.put_bytes,
943
673
def _cache_revision_history(self, rev_history):
944
674
"""Set the cached revision history to rev_history.
1364
1120
Callers will typically also want to check the repository.
1366
:param refs: Calculated refs for this branch as specified by
1367
branch._get_check_refs()
1368
1122
:return: A BranchCheckResult.
1370
result = BranchCheckResult(self)
1124
mainline_parent_id = None
1371
1125
last_revno, last_revision_id = self.last_revision_info()
1372
actual_revno = refs[('lefthand-distance', last_revision_id)]
1373
if actual_revno != last_revno:
1374
result.errors.append(errors.BzrCheckError(
1375
'revno does not match len(mainline) %s != %s' % (
1376
last_revno, actual_revno)))
1377
# TODO: We should probably also check that self.revision_history
1378
# matches the repository for older branch formats.
1379
# If looking for the code that cross-checks repository parents against
1380
# the iter_reverse_revision_history output, that is now a repository
1126
real_rev_history = list(self.repository.iter_reverse_revision_history(
1128
real_rev_history.reverse()
1129
if len(real_rev_history) != last_revno:
1130
raise errors.BzrCheckError('revno does not match len(mainline)'
1131
' %s != %s' % (last_revno, len(real_rev_history)))
1132
# TODO: We should probably also check that real_rev_history actually
1133
# matches self.revision_history()
1134
for revision_id in real_rev_history:
1136
revision = self.repository.get_revision(revision_id)
1137
except errors.NoSuchRevision, e:
1138
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1140
# In general the first entry on the revision history has no parents.
1141
# But it's not illegal for it to have parents listed; this can happen
1142
# in imports from Arch when the parents weren't reachable.
1143
if mainline_parent_id is not None:
1144
if mainline_parent_id not in revision.parent_ids:
1145
raise errors.BzrCheckError("previous revision {%s} not listed among "
1147
% (mainline_parent_id, revision_id))
1148
mainline_parent_id = revision_id
1149
return BranchCheckResult(self)
1384
1151
def _get_checkout_format(self):
1385
1152
"""Return the most suitable metadir for a checkout of this branch.
1386
1153
Weaves are used if this branch's repository uses weaves.
1388
format = self.repository.bzrdir.checkout_metadir()
1389
format.set_branch_format(self._format)
1155
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1156
from bzrlib.repofmt import weaverepo
1157
format = bzrdir.BzrDirMetaFormat1()
1158
format.repository_format = weaverepo.RepositoryFormat7()
1160
format = self.repository.bzrdir.checkout_metadir()
1161
format.set_branch_format(self._format)
1392
1164
def create_clone_on_transport(self, to_transport, revision_id=None,
1393
stacked_on=None, create_prefix=False, use_existing_dir=False,
1165
stacked_on=None, create_prefix=False, use_existing_dir=False):
1395
1166
"""Create a clone of this branch and its bzrdir.
1397
1168
:param to_transport: The transport to clone onto.
1812
1525
"basis revision. hooks MUST NOT modify this delta. "
1813
1526
" future_tree is an in-memory tree obtained from "
1814
1527
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1816
self.add_hook('post_commit',
1528
"tree.", (0,91), None))
1529
self.create_hook(HookPoint('post_commit',
1817
1530
"Called in the bzr client after a commit has completed. "
1818
1531
"post_commit is called with (local, master, old_revno, old_revid, "
1819
1532
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1820
"commit to a branch.", (0, 15))
1821
self.add_hook('post_uncommit',
1533
"commit to a branch.", (0, 15), None))
1534
self.create_hook(HookPoint('post_uncommit',
1822
1535
"Called in the bzr client after an uncommit completes. "
1823
1536
"post_uncommit is called with (local, master, old_revno, "
1824
1537
"old_revid, new_revno, new_revid) where local is the local branch "
1825
1538
"or None, master is the target branch, and an empty branch "
1826
"receives new_revno of 0, new_revid of None.", (0, 15))
1827
self.add_hook('pre_change_branch_tip',
1539
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1540
self.create_hook(HookPoint('pre_change_branch_tip',
1828
1541
"Called in bzr client and server before a change to the tip of a "
1829
1542
"branch is made. pre_change_branch_tip is called with a "
1830
1543
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1831
"commit, uncommit will all trigger this hook.", (1, 6))
1832
self.add_hook('post_change_branch_tip',
1544
"commit, uncommit will all trigger this hook.", (1, 6), None))
1545
self.create_hook(HookPoint('post_change_branch_tip',
1833
1546
"Called in bzr client and server after a change to the tip of a "
1834
1547
"branch is made. post_change_branch_tip is called with a "
1835
1548
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1836
"commit, uncommit will all trigger this hook.", (1, 4))
1837
self.add_hook('transform_fallback_location',
1549
"commit, uncommit will all trigger this hook.", (1, 4), None))
1550
self.create_hook(HookPoint('transform_fallback_location',
1838
1551
"Called when a stacked branch is activating its fallback "
1839
1552
"locations. transform_fallback_location is called with (branch, "
1840
1553
"url), and should return a new url. Returning the same url "
1907
1603
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1910
class BranchInitHookParams(object):
1911
"""Object holding parameters passed to `*_branch_init` hooks.
1913
There are 4 fields that hooks may wish to access:
1915
:ivar format: the branch format
1916
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1917
:ivar name: name of colocated branch, if any (or None)
1918
:ivar branch: the branch created
1920
Note that for lightweight checkouts, the bzrdir and format fields refer to
1921
the checkout, hence they are different from the corresponding fields in
1922
branch, which refer to the original branch.
1925
def __init__(self, format, a_bzrdir, name, branch):
1926
"""Create a group of BranchInitHook parameters.
1928
:param format: the branch format
1929
:param a_bzrdir: the BzrDir where the branch will be/has been
1931
:param name: name of colocated branch, if any (or None)
1932
:param branch: the branch created
1934
Note that for lightweight checkouts, the bzrdir and format fields refer
1935
to the checkout, hence they are different from the corresponding fields
1936
in branch, which refer to the original branch.
1938
self.format = format
1939
self.bzrdir = a_bzrdir
1941
self.branch = branch
1943
def __eq__(self, other):
1944
return self.__dict__ == other.__dict__
1947
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1950
class SwitchHookParams(object):
1951
"""Object holding parameters passed to `*_switch` hooks.
1953
There are 4 fields that hooks may wish to access:
1955
:ivar control_dir: BzrDir of the checkout to change
1956
:ivar to_branch: branch that the checkout is to reference
1957
:ivar force: skip the check for local commits in a heavy checkout
1958
:ivar revision_id: revision ID to switch to (or None)
1961
def __init__(self, control_dir, to_branch, force, revision_id):
1962
"""Create a group of SwitchHook parameters.
1964
:param control_dir: BzrDir of the checkout to change
1965
:param to_branch: branch that the checkout is to reference
1966
:param force: skip the check for local commits in a heavy checkout
1967
:param revision_id: revision ID to switch to (or None)
1969
self.control_dir = control_dir
1970
self.to_branch = to_branch
1972
self.revision_id = revision_id
1974
def __eq__(self, other):
1975
return self.__dict__ == other.__dict__
1978
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1979
self.control_dir, self.to_branch,
1606
class BzrBranchFormat4(BranchFormat):
1607
"""Bzr branch format 4.
1610
- a revision-history file.
1611
- a branch-lock lock file [ to be shared with the bzrdir ]
1614
def get_format_description(self):
1615
"""See BranchFormat.get_format_description()."""
1616
return "Branch format 4"
1618
def initialize(self, a_bzrdir):
1619
"""Create a branch of this format in a_bzrdir."""
1620
utf8_files = [('revision-history', ''),
1621
('branch-name', ''),
1623
return self._initialize_helper(a_bzrdir, utf8_files,
1624
lock_type='branch4', set_format=False)
1627
super(BzrBranchFormat4, self).__init__()
1628
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1630
def network_name(self):
1631
"""The network name for this format is the control dirs disk label."""
1632
return self._matchingbzrdir.get_format_string()
1634
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1635
"""See BranchFormat.open()."""
1637
# we are being called directly and must probe.
1638
raise NotImplementedError
1639
return BzrBranch(_format=self,
1640
_control_files=a_bzrdir._control_files,
1642
_repository=a_bzrdir.open_repository())
1645
return "Bazaar-NG branch format 4"
1983
1648
class BranchFormatMetadir(BranchFormat):
2500
2058
"""See Branch.print_file."""
2501
2059
return self.repository.print_file(file, revision_id)
2061
def _write_revision_history(self, history):
2062
"""Factored out of set_revision_history.
2064
This performs the actual writing to disk.
2065
It is intended to be called by BzrBranch5.set_revision_history."""
2066
self._transport.put_bytes(
2067
'revision-history', '\n'.join(history),
2068
mode=self.bzrdir._get_file_mode())
2071
def set_revision_history(self, rev_history):
2072
"""See Branch.set_revision_history."""
2073
if 'evil' in debug.debug_flags:
2074
mutter_callsite(3, "set_revision_history scales with history.")
2075
check_not_reserved_id = _mod_revision.check_not_reserved_id
2076
for rev_id in rev_history:
2077
check_not_reserved_id(rev_id)
2078
if Branch.hooks['post_change_branch_tip']:
2079
# Don't calculate the last_revision_info() if there are no hooks
2081
old_revno, old_revid = self.last_revision_info()
2082
if len(rev_history) == 0:
2083
revid = _mod_revision.NULL_REVISION
2085
revid = rev_history[-1]
2086
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2087
self._write_revision_history(rev_history)
2088
self._clear_cached_state()
2089
self._cache_revision_history(rev_history)
2090
for hook in Branch.hooks['set_rh']:
2091
hook(self, rev_history)
2092
if Branch.hooks['post_change_branch_tip']:
2093
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2095
def _synchronize_history(self, destination, revision_id):
2096
"""Synchronize last revision and revision history between branches.
2098
This version is most efficient when the destination is also a
2099
BzrBranch5, but works for BzrBranch6 as long as the revision
2100
history is the true lefthand parent history, and all of the revisions
2101
are in the destination's repository. If not, set_revision_history
2104
:param destination: The branch to copy the history into
2105
:param revision_id: The revision-id to truncate history at. May
2106
be None to copy complete history.
2108
if not isinstance(destination._format, BzrBranchFormat5):
2109
super(BzrBranch, self)._synchronize_history(
2110
destination, revision_id)
2112
if revision_id == _mod_revision.NULL_REVISION:
2115
new_history = self.revision_history()
2116
if revision_id is not None and new_history != []:
2118
new_history = new_history[:new_history.index(revision_id) + 1]
2120
rev = self.repository.get_revision(revision_id)
2121
new_history = rev.get_history(self.repository)[1:]
2122
destination.set_revision_history(new_history)
2503
2124
@needs_write_lock
2504
2125
def set_last_revision_info(self, revno, revision_id):
2505
if not revision_id or not isinstance(revision_id, basestring):
2506
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2126
"""Set the last revision of this branch.
2128
The caller is responsible for checking that the revno is correct
2129
for this revision id.
2131
It may be possible to set the branch last revision to an id not
2132
present in the repository. However, branches can also be
2133
configured to check constraints on history, in which case this may not
2507
2136
revision_id = _mod_revision.ensure_null(revision_id)
2508
old_revno, old_revid = self.last_revision_info()
2509
if self._get_append_revisions_only():
2510
self._check_history_violation(revision_id)
2511
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2512
self._write_last_revision_info(revno, revision_id)
2513
self._clear_cached_state()
2514
self._last_revision_info_cache = revno, revision_id
2515
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2137
# this old format stores the full history, but this api doesn't
2138
# provide it, so we must generate, and might as well check it's
2140
history = self._lefthand_history(revision_id)
2141
if len(history) != revno:
2142
raise AssertionError('%d != %d' % (len(history), revno))
2143
self.set_revision_history(history)
2145
def _gen_revision_history(self):
2146
history = self._transport.get_bytes('revision-history').split('\n')
2147
if history[-1:] == ['']:
2148
# There shouldn't be a trailing newline, but just in case.
2153
def generate_revision_history(self, revision_id, last_rev=None,
2155
"""Create a new revision history that will finish with revision_id.
2157
:param revision_id: the new tip to use.
2158
:param last_rev: The previous last_revision. If not None, then this
2159
must be a ancestory of revision_id, or DivergedBranches is raised.
2160
:param other_branch: The other branch that DivergedBranches should
2161
raise with respect to.
2163
self.set_revision_history(self._lefthand_history(revision_id,
2164
last_rev, other_branch))
2517
2166
def basis_tree(self):
2518
2167
"""See Branch.basis_tree."""
2519
2168
return self.repository.revision_tree(self.last_revision())
2171
def pull(self, source, overwrite=False, stop_revision=None,
2172
_hook_master=None, run_hooks=True, possible_transports=None,
2173
_override_hook_target=None):
2176
:param _hook_master: Private parameter - set the branch to
2177
be supplied as the master to pull hooks.
2178
:param run_hooks: Private parameter - if false, this branch
2179
is being called because it's the master of the primary branch,
2180
so it should not run its hooks.
2181
:param _override_hook_target: Private parameter - set the branch to be
2182
supplied as the target_branch to pull hooks.
2184
result = PullResult()
2185
result.source_branch = source
2186
if _override_hook_target is None:
2187
result.target_branch = self
2189
result.target_branch = _override_hook_target
2192
# We assume that during 'pull' the local repository is closer than
2194
source.update_references(self)
2195
graph = self.repository.get_graph(source.repository)
2196
result.old_revno, result.old_revid = self.last_revision_info()
2197
self.update_revisions(source, stop_revision, overwrite=overwrite,
2199
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
2200
result.new_revno, result.new_revid = self.last_revision_info()
2202
result.master_branch = _hook_master
2203
result.local_branch = result.target_branch
2205
result.master_branch = result.target_branch
2206
result.local_branch = None
2208
for hook in Branch.hooks['post_pull']:
2521
2214
def _get_parent_location(self):
2522
2215
_locs = ['parent', 'pull', 'x-pull']
2523
2216
for l in _locs:
2224
def push(self, target, overwrite=False, stop_revision=None,
2225
_override_hook_source_branch=None):
2228
This is the basic concrete implementation of push()
2230
:param _override_hook_source_branch: If specified, run
2231
the hooks passing this Branch as the source, rather than self.
2232
This is for use of RemoteBranch, where push is delegated to the
2233
underlying vfs-based Branch.
2235
# TODO: Public option to disable running hooks - should be trivial but
2237
return _run_with_write_locked_target(
2238
target, self._push_with_bound_branches, target, overwrite,
2240
_override_hook_source_branch=_override_hook_source_branch)
2242
def _push_with_bound_branches(self, target, overwrite,
2244
_override_hook_source_branch=None):
2245
"""Push from self into target, and into target's master if any.
2247
This is on the base BzrBranch class even though it doesn't support
2248
bound branches because the *target* might be bound.
2251
if _override_hook_source_branch:
2252
result.source_branch = _override_hook_source_branch
2253
for hook in Branch.hooks['post_push']:
2256
bound_location = target.get_bound_location()
2257
if bound_location and target.base != bound_location:
2258
# there is a master branch.
2260
# XXX: Why the second check? Is it even supported for a branch to
2261
# be bound to itself? -- mbp 20070507
2262
master_branch = target.get_master_branch()
2263
master_branch.lock_write()
2265
# push into the master from this branch.
2266
self._basic_push(master_branch, overwrite, stop_revision)
2267
# and push into the target branch from this. Note that we push from
2268
# this branch again, because its considered the highest bandwidth
2270
result = self._basic_push(target, overwrite, stop_revision)
2271
result.master_branch = master_branch
2272
result.local_branch = target
2276
master_branch.unlock()
2279
result = self._basic_push(target, overwrite, stop_revision)
2280
# TODO: Why set master_branch and local_branch if there's no
2281
# binding? Maybe cleaner to just leave them unset? -- mbp
2283
result.master_branch = target
2284
result.local_branch = None
2288
def _basic_push(self, target, overwrite, stop_revision):
2289
"""Basic implementation of push without bound branches or hooks.
2291
Must be called with self read locked and target write locked.
2293
result = BranchPushResult()
2294
result.source_branch = self
2295
result.target_branch = target
2296
result.old_revno, result.old_revid = target.last_revision_info()
2297
self.update_references(target)
2298
if result.old_revid != self.last_revision():
2299
# We assume that during 'push' this repository is closer than
2301
graph = self.repository.get_graph(target.repository)
2302
target.update_revisions(self, stop_revision, overwrite=overwrite,
2304
if self._push_should_merge_tags():
2305
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2306
result.new_revno, result.new_revid = target.last_revision_info()
2530
2309
def get_stacked_on_url(self):
2531
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2310
raise errors.UnstackableBranchFormat(self._format, self.base)
2533
2312
def set_push_location(self, location):
2534
2313
"""See Branch.set_push_location."""
2639
def _read_last_revision_info(self):
2640
revision_string = self._transport.get_bytes('last-revision')
2641
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2642
revision_id = cache_utf8.get_cached_utf8(revision_id)
2644
return revno, revision_id
2646
def _write_last_revision_info(self, revno, revision_id):
2647
"""Simply write out the revision id, with no checks.
2649
Use set_last_revision_info to perform this safely.
2651
Does not update the revision_history cache.
2653
revision_id = _mod_revision.ensure_null(revision_id)
2654
out_string = '%d %s\n' % (revno, revision_id)
2655
self._transport.put_bytes('last-revision', out_string,
2656
mode=self.bzrdir._get_file_mode())
2659
class FullHistoryBzrBranch(BzrBranch):
2660
"""Bzr branch which contains the full revision history."""
2663
def set_last_revision_info(self, revno, revision_id):
2664
if not revision_id or not isinstance(revision_id, basestring):
2665
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2666
revision_id = _mod_revision.ensure_null(revision_id)
2667
# this old format stores the full history, but this api doesn't
2668
# provide it, so we must generate, and might as well check it's
2670
history = self._lefthand_history(revision_id)
2671
if len(history) != revno:
2672
raise AssertionError('%d != %d' % (len(history), revno))
2673
self._set_revision_history(history)
2675
def _read_last_revision_info(self):
2676
rh = self.revision_history()
2679
return (revno, rh[-1])
2681
return (0, _mod_revision.NULL_REVISION)
2683
@deprecated_method(deprecated_in((2, 4, 0)))
2685
def set_revision_history(self, rev_history):
2686
"""See Branch.set_revision_history."""
2687
self._set_revision_history(rev_history)
2689
def _set_revision_history(self, rev_history):
2690
if 'evil' in debug.debug_flags:
2691
mutter_callsite(3, "set_revision_history scales with history.")
2692
check_not_reserved_id = _mod_revision.check_not_reserved_id
2693
for rev_id in rev_history:
2694
check_not_reserved_id(rev_id)
2695
if Branch.hooks['post_change_branch_tip']:
2696
# Don't calculate the last_revision_info() if there are no hooks
2698
old_revno, old_revid = self.last_revision_info()
2699
if len(rev_history) == 0:
2700
revid = _mod_revision.NULL_REVISION
2702
revid = rev_history[-1]
2703
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2704
self._write_revision_history(rev_history)
2705
self._clear_cached_state()
2706
self._cache_revision_history(rev_history)
2707
for hook in Branch.hooks['set_rh']:
2708
hook(self, rev_history)
2709
if Branch.hooks['post_change_branch_tip']:
2710
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2712
def _write_revision_history(self, history):
2713
"""Factored out of set_revision_history.
2715
This performs the actual writing to disk.
2716
It is intended to be called by set_revision_history."""
2717
self._transport.put_bytes(
2718
'revision-history', '\n'.join(history),
2719
mode=self.bzrdir._get_file_mode())
2721
def _gen_revision_history(self):
2722
history = self._transport.get_bytes('revision-history').split('\n')
2723
if history[-1:] == ['']:
2724
# There shouldn't be a trailing newline, but just in case.
2728
def _synchronize_history(self, destination, revision_id):
2729
if not isinstance(destination, FullHistoryBzrBranch):
2730
super(BzrBranch, self)._synchronize_history(
2731
destination, revision_id)
2733
if revision_id == _mod_revision.NULL_REVISION:
2736
new_history = self.revision_history()
2737
if revision_id is not None and new_history != []:
2739
new_history = new_history[:new_history.index(revision_id) + 1]
2741
rev = self.repository.get_revision(revision_id)
2742
new_history = rev.get_history(self.repository)[1:]
2743
destination._set_revision_history(new_history)
2746
def generate_revision_history(self, revision_id, last_rev=None,
2748
"""Create a new revision history that will finish with revision_id.
2750
:param revision_id: the new tip to use.
2751
:param last_rev: The previous last_revision. If not None, then this
2752
must be a ancestory of revision_id, or DivergedBranches is raised.
2753
:param other_branch: The other branch that DivergedBranches should
2754
raise with respect to.
2756
self._set_revision_history(self._lefthand_history(revision_id,
2757
last_rev, other_branch))
2760
class BzrBranch5(FullHistoryBzrBranch):
2761
"""A format 5 branch. This supports new features over plain branches.
2763
It has support for a master_branch which is the data for bound branches.
2767
class BzrBranch8(BzrBranch):
2453
class BzrBranch8(BzrBranch5):
2768
2454
"""A branch that stores tree-reference locations."""
2770
2456
def _open_hook(self):
2783
2469
raise AssertionError(
2784
2470
"'transform_fallback_location' hook %s returned "
2785
2471
"None, not a URL." % hook_name)
2786
self._activate_fallback_location(url)
2472
self._activate_fallback_location(url, None)
2788
2474
def __init__(self, *args, **kwargs):
2789
2475
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2790
2476
super(BzrBranch8, self).__init__(*args, **kwargs)
2791
2477
self._last_revision_info_cache = None
2478
self._partial_revision_history_cache = []
2792
2479
self._reference_info = None
2794
2481
def _clear_cached_state(self):
2795
2482
super(BzrBranch8, self)._clear_cached_state()
2796
2483
self._last_revision_info_cache = None
2484
self._partial_revision_history_cache = []
2797
2485
self._reference_info = None
2487
def _last_revision_info(self):
2488
revision_string = self._transport.get_bytes('last-revision')
2489
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2490
revision_id = cache_utf8.get_cached_utf8(revision_id)
2492
return revno, revision_id
2494
def _write_last_revision_info(self, revno, revision_id):
2495
"""Simply write out the revision id, with no checks.
2497
Use set_last_revision_info to perform this safely.
2499
Does not update the revision_history cache.
2500
Intended to be called by set_last_revision_info and
2501
_write_revision_history.
2503
revision_id = _mod_revision.ensure_null(revision_id)
2504
out_string = '%d %s\n' % (revno, revision_id)
2505
self._transport.put_bytes('last-revision', out_string,
2506
mode=self.bzrdir._get_file_mode())
2509
def set_last_revision_info(self, revno, revision_id):
2510
revision_id = _mod_revision.ensure_null(revision_id)
2511
old_revno, old_revid = self.last_revision_info()
2512
if self._get_append_revisions_only():
2513
self._check_history_violation(revision_id)
2514
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2515
self._write_last_revision_info(revno, revision_id)
2516
self._clear_cached_state()
2517
self._last_revision_info_cache = revno, revision_id
2518
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2520
def _synchronize_history(self, destination, revision_id):
2521
"""Synchronize last revision and revision history between branches.
2523
:see: Branch._synchronize_history
2525
# XXX: The base Branch has a fast implementation of this method based
2526
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2527
# that uses set_revision_history. This class inherits from BzrBranch5,
2528
# but wants the fast implementation, so it calls
2529
# Branch._synchronize_history directly.
2530
Branch._synchronize_history(self, destination, revision_id)
2799
2532
def _check_history_violation(self, revision_id):
2800
current_revid = self.last_revision()
2801
last_revision = _mod_revision.ensure_null(current_revid)
2533
last_revision = _mod_revision.ensure_null(self.last_revision())
2802
2534
if _mod_revision.is_null(last_revision):
2804
graph = self.repository.get_graph()
2805
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2806
if lh_ancestor == current_revid:
2808
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2536
if last_revision not in self._lefthand_history(revision_id):
2537
raise errors.AppendRevisionsOnlyViolation(self.base)
2810
2539
def _gen_revision_history(self):
2811
2540
"""Generate the revision history from last revision
3185
2990
_optimisers = []
3186
2991
"""The available optimised InterBranch types."""
3189
def _get_branch_formats_to_test(klass):
3190
"""Return an iterable of format tuples for testing.
3192
:return: An iterable of (from_format, to_format) to use when testing
3193
this InterBranch class. Each InterBranch class should define this
3196
raise NotImplementedError(klass._get_branch_formats_to_test)
3199
def pull(self, overwrite=False, stop_revision=None,
3200
possible_transports=None, local=False):
3201
"""Mirror source into target branch.
3203
The target branch is considered to be 'local', having low latency.
3205
:returns: PullResult instance
3207
raise NotImplementedError(self.pull)
3210
def push(self, overwrite=False, stop_revision=None, lossy=False,
3211
_override_hook_source_branch=None):
3212
"""Mirror the source branch into the target branch.
3214
The source branch is considered to be 'local', having low latency.
3216
raise NotImplementedError(self.push)
3219
def copy_content_into(self, revision_id=None):
3220
"""Copy the content of source into target
3222
revision_id: if not None, the revision history in the new branch will
3223
be truncated to end with revision_id.
3225
raise NotImplementedError(self.copy_content_into)
3228
def fetch(self, stop_revision=None, limit=None):
3231
:param stop_revision: Last revision to fetch
3232
:param limit: Optional rough limit of revisions to fetch
3234
raise NotImplementedError(self.fetch)
2994
def _get_branch_formats_to_test():
2995
"""Return a tuple with the Branch formats to use when testing."""
2996
raise NotImplementedError(self._get_branch_formats_to_test)
2998
def update_revisions(self, stop_revision=None, overwrite=False,
3000
"""Pull in new perfect-fit revisions.
3002
:param stop_revision: Updated until the given revision
3003
:param overwrite: Always set the branch pointer, rather than checking
3004
to see if it is a proper descendant.
3005
:param graph: A Graph object that can be used to query history
3006
information. This can be None.
3009
raise NotImplementedError(self.update_revisions)
3237
3012
class GenericInterBranch(InterBranch):
3238
"""InterBranch implementation that uses public Branch functions."""
3013
"""InterBranch implementation that uses public Branch functions.
3017
def _get_branch_formats_to_test():
3018
return BranchFormat._default_format, BranchFormat._default_format
3020
def update_revisions(self, stop_revision=None, overwrite=False,
3022
"""See InterBranch.update_revisions()."""
3023
self.source.lock_read()
3025
other_revno, other_last_revision = self.source.last_revision_info()
3026
stop_revno = None # unknown
3027
if stop_revision is None:
3028
stop_revision = other_last_revision
3029
if _mod_revision.is_null(stop_revision):
3030
# if there are no commits, we're done.
3032
stop_revno = other_revno
3034
# what's the current last revision, before we fetch [and change it
3036
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3037
# we fetch here so that we don't process data twice in the common
3038
# case of having something to pull, and so that the check for
3039
# already merged can operate on the just fetched graph, which will
3040
# be cached in memory.
3041
self.target.fetch(self.source, stop_revision)
3042
# Check to see if one is an ancestor of the other
3045
graph = self.target.repository.get_graph()
3046
if self.target._check_if_descendant_or_diverged(
3047
stop_revision, last_rev, graph, self.source):
3048
# stop_revision is a descendant of last_rev, but we aren't
3049
# overwriting, so we're done.
3051
if stop_revno is None:
3053
graph = self.target.repository.get_graph()
3054
this_revno, this_last_revision = \
3055
self.target.last_revision_info()
3056
stop_revno = graph.find_distance_to_null(stop_revision,
3057
[(other_last_revision, other_revno),
3058
(this_last_revision, this_revno)])
3059
self.target.set_last_revision_info(stop_revno, stop_revision)
3061
self.source.unlock()
3241
def is_compatible(klass, source, target):
3064
def is_compatible(self, source, target):
3242
3065
# GenericBranch uses the public API, so always compatible
3246
def _get_branch_formats_to_test(klass):
3247
return [(format_registry.get_default(), format_registry.get_default())]
3250
def unwrap_format(klass, format):
3251
if isinstance(format, remote.RemoteBranchFormat):
3252
format._ensure_real()
3253
return format._custom_format
3257
def copy_content_into(self, revision_id=None):
3258
"""Copy the content of source into target
3260
revision_id: if not None, the revision history in the new branch will
3261
be truncated to end with revision_id.
3263
self.source.update_references(self.target)
3264
self.source._synchronize_history(self.target, revision_id)
3266
parent = self.source.get_parent()
3267
except errors.InaccessibleParent, e:
3268
mutter('parent was not accessible to copy: %s', e)
3271
self.target.set_parent(parent)
3272
if self.source._push_should_merge_tags():
3273
self.source.tags.merge_to(self.target.tags)
3276
def fetch(self, stop_revision=None, limit=None):
3277
if self.target.base == self.source.base:
3279
self.source.lock_read()
3281
fetch_spec_factory = fetch.FetchSpecFactory()
3282
fetch_spec_factory.source_branch = self.source
3283
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3284
fetch_spec_factory.source_repo = self.source.repository
3285
fetch_spec_factory.target_repo = self.target.repository
3286
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3287
fetch_spec_factory.limit = limit
3288
fetch_spec = fetch_spec_factory.make_fetch_spec()
3289
return self.target.repository.fetch(self.source.repository,
3290
fetch_spec=fetch_spec)
3292
self.source.unlock()
3295
def _update_revisions(self, stop_revision=None, overwrite=False,
3297
other_revno, other_last_revision = self.source.last_revision_info()
3298
stop_revno = None # unknown
3299
if stop_revision is None:
3300
stop_revision = other_last_revision
3301
if _mod_revision.is_null(stop_revision):
3302
# if there are no commits, we're done.
3304
stop_revno = other_revno
3306
# what's the current last revision, before we fetch [and change it
3308
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3309
# we fetch here so that we don't process data twice in the common
3310
# case of having something to pull, and so that the check for
3311
# already merged can operate on the just fetched graph, which will
3312
# be cached in memory.
3313
self.fetch(stop_revision=stop_revision)
3314
# Check to see if one is an ancestor of the other
3317
graph = self.target.repository.get_graph()
3318
if self.target._check_if_descendant_or_diverged(
3319
stop_revision, last_rev, graph, self.source):
3320
# stop_revision is a descendant of last_rev, but we aren't
3321
# overwriting, so we're done.
3323
if stop_revno is None:
3325
graph = self.target.repository.get_graph()
3326
this_revno, this_last_revision = \
3327
self.target.last_revision_info()
3328
stop_revno = graph.find_distance_to_null(stop_revision,
3329
[(other_last_revision, other_revno),
3330
(this_last_revision, this_revno)])
3331
self.target.set_last_revision_info(stop_revno, stop_revision)
3334
def pull(self, overwrite=False, stop_revision=None,
3335
possible_transports=None, run_hooks=True,
3336
_override_hook_target=None, local=False):
3337
"""Pull from source into self, updating my master if any.
3339
:param run_hooks: Private parameter - if false, this branch
3340
is being called because it's the master of the primary branch,
3341
so it should not run its hooks.
3343
bound_location = self.target.get_bound_location()
3344
if local and not bound_location:
3345
raise errors.LocalRequiresBoundBranch()
3346
master_branch = None
3347
source_is_master = (self.source.user_url == bound_location)
3348
if not local and bound_location and not source_is_master:
3349
# not pulling from master, so we need to update master.
3350
master_branch = self.target.get_master_branch(possible_transports)
3351
master_branch.lock_write()
3354
# pull from source into master.
3355
master_branch.pull(self.source, overwrite, stop_revision,
3357
return self._pull(overwrite,
3358
stop_revision, _hook_master=master_branch,
3359
run_hooks=run_hooks,
3360
_override_hook_target=_override_hook_target,
3361
merge_tags_to_master=not source_is_master)
3364
master_branch.unlock()
3366
def push(self, overwrite=False, stop_revision=None, lossy=False,
3367
_override_hook_source_branch=None):
3368
"""See InterBranch.push.
3370
This is the basic concrete implementation of push()
3372
:param _override_hook_source_branch: If specified, run the hooks
3373
passing this Branch as the source, rather than self. This is for
3374
use of RemoteBranch, where push is delegated to the underlying
3378
raise errors.LossyPushToSameVCS(self.source, self.target)
3379
# TODO: Public option to disable running hooks - should be trivial but
3382
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3383
op.add_cleanup(self.source.lock_read().unlock)
3384
op.add_cleanup(self.target.lock_write().unlock)
3385
return op.run(overwrite, stop_revision,
3386
_override_hook_source_branch=_override_hook_source_branch)
3388
def _basic_push(self, overwrite, stop_revision):
3389
"""Basic implementation of push without bound branches or hooks.
3391
Must be called with source read locked and target write locked.
3393
result = BranchPushResult()
3394
result.source_branch = self.source
3395
result.target_branch = self.target
3396
result.old_revno, result.old_revid = self.target.last_revision_info()
3397
self.source.update_references(self.target)
3398
if result.old_revid != stop_revision:
3399
# We assume that during 'push' this repository is closer than
3401
graph = self.source.repository.get_graph(self.target.repository)
3402
self._update_revisions(stop_revision, overwrite=overwrite,
3404
if self.source._push_should_merge_tags():
3405
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3407
result.new_revno, result.new_revid = self.target.last_revision_info()
3410
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3411
_override_hook_source_branch=None):
3412
"""Push from source into target, and into target's master if any.
3415
if _override_hook_source_branch:
3416
result.source_branch = _override_hook_source_branch
3417
for hook in Branch.hooks['post_push']:
3420
bound_location = self.target.get_bound_location()
3421
if bound_location and self.target.base != bound_location:
3422
# there is a master branch.
3424
# XXX: Why the second check? Is it even supported for a branch to
3425
# be bound to itself? -- mbp 20070507
3426
master_branch = self.target.get_master_branch()
3427
master_branch.lock_write()
3428
operation.add_cleanup(master_branch.unlock)
3429
# push into the master from the source branch.
3430
master_inter = InterBranch.get(self.source, master_branch)
3431
master_inter._basic_push(overwrite, stop_revision)
3432
# and push into the target branch from the source. Note that
3433
# we push from the source branch again, because it's considered
3434
# the highest bandwidth repository.
3435
result = self._basic_push(overwrite, stop_revision)
3436
result.master_branch = master_branch
3437
result.local_branch = self.target
3439
master_branch = None
3441
result = self._basic_push(overwrite, stop_revision)
3442
# TODO: Why set master_branch and local_branch if there's no
3443
# binding? Maybe cleaner to just leave them unset? -- mbp
3445
result.master_branch = self.target
3446
result.local_branch = None
3450
def _pull(self, overwrite=False, stop_revision=None,
3451
possible_transports=None, _hook_master=None, run_hooks=True,
3452
_override_hook_target=None, local=False,
3453
merge_tags_to_master=True):
3456
This function is the core worker, used by GenericInterBranch.pull to
3457
avoid duplication when pulling source->master and source->local.
3459
:param _hook_master: Private parameter - set the branch to
3460
be supplied as the master to pull hooks.
3461
:param run_hooks: Private parameter - if false, this branch
3462
is being called because it's the master of the primary branch,
3463
so it should not run its hooks.
3464
is being called because it's the master of the primary branch,
3465
so it should not run its hooks.
3466
:param _override_hook_target: Private parameter - set the branch to be
3467
supplied as the target_branch to pull hooks.
3468
:param local: Only update the local branch, and not the bound branch.
3470
# This type of branch can't be bound.
3472
raise errors.LocalRequiresBoundBranch()
3473
result = PullResult()
3474
result.source_branch = self.source
3475
if _override_hook_target is None:
3476
result.target_branch = self.target
3478
result.target_branch = _override_hook_target
3479
self.source.lock_read()
3481
# We assume that during 'pull' the target repository is closer than
3483
self.source.update_references(self.target)
3484
graph = self.target.repository.get_graph(self.source.repository)
3485
# TODO: Branch formats should have a flag that indicates
3486
# that revno's are expensive, and pull() should honor that flag.
3488
result.old_revno, result.old_revid = \
3489
self.target.last_revision_info()
3490
self._update_revisions(stop_revision, overwrite=overwrite,
3492
# TODO: The old revid should be specified when merging tags,
3493
# so a tags implementation that versions tags can only
3494
# pull in the most recent changes. -- JRV20090506
3495
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3496
overwrite, ignore_master=not merge_tags_to_master)
3497
result.new_revno, result.new_revid = self.target.last_revision_info()
3499
result.master_branch = _hook_master
3500
result.local_branch = result.target_branch
3502
result.master_branch = result.target_branch
3503
result.local_branch = None
3505
for hook in Branch.hooks['post_pull']:
3508
self.source.unlock()
3512
3069
InterBranch.register_optimiser(GenericInterBranch)
added
removed
bzrlib/branch.py
