57
72
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
60
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
61
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
62
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
65
# TODO: Maybe include checks for common corruption of newlines, etc?
67
# TODO: Some operations like log might retrieve the same revisions
68
# repeatedly to calculate deltas. We could perhaps have a weakref
69
# cache in memory to make this faster. In general anything can be
70
# cached in memory between lock and unlock operations. .. nb thats
71
# what the transaction identity map provides
74
######################################################################
75
class Branch(controldir.ControlComponent):
78
76
"""Branch holding a history of revisions.
81
Base directory/url of the branch.
83
hooks: An instance of BranchHooks.
79
Base directory/url of the branch; using control_url and
80
control_transport is more standardized.
81
:ivar hooks: An instance of BranchHooks.
82
:ivar _master_branch_cache: cached result of get_master_branch, see
85
85
# this is really an instance variable - FIXME move it there
89
def __init__(self, *ignored, **ignored_too):
90
def control_transport(self):
91
return self._transport
94
def user_transport(self):
95
return self.bzrdir.user_transport
97
def __init__(self, possible_transports=None):
90
98
self.tags = self._format.make_tags(self)
91
99
self._revision_history_cache = None
92
100
self._revision_id_to_revno_cache = None
93
101
self._partial_revision_id_to_revno_cache = {}
94
102
self._partial_revision_history_cache = []
103
self._tags_bytes = None
95
104
self._last_revision_info_cache = None
105
self._master_branch_cache = None
96
106
self._merge_sorted_revisions_cache = None
107
self._open_hook(possible_transports)
98
108
hooks = Branch.hooks['open']
99
109
for hook in hooks:
102
def _open_hook(self):
112
def _open_hook(self, possible_transports):
103
113
"""Called by init to allow simpler extension of the base class."""
105
def _activate_fallback_location(self, url):
115
def _activate_fallback_location(self, url, possible_transports):
106
116
"""Activate the branch/repository from url as a fallback repository."""
107
repo = self._get_fallback_repository(url)
117
for existing_fallback_repo in self.repository._fallback_repositories:
118
if existing_fallback_repo.user_url == url:
119
# This fallback is already configured. This probably only
120
# happens because ControlDir.sprout is a horrible mess. To avoid
121
# confusing _unstack we don't add this a second time.
122
mutter('duplicate activation of fallback %r on %r', url, self)
124
repo = self._get_fallback_repository(url, possible_transports)
125
if repo.has_same_location(self.repository):
126
raise errors.UnstackableLocationError(self.user_url, url)
108
127
self.repository.add_fallback_repository(repo)
110
129
def break_lock(self):
460
526
"""Iterate over an inclusive range of sorted revisions."""
461
527
rev_iter = iter(merge_sorted_revisions)
462
528
if start_revision_id is not None:
463
for rev_id, depth, revno, end_of_merge in rev_iter:
529
for node in rev_iter:
464
531
if rev_id != start_revision_id:
467
534
# The decision to include the start or not
468
535
# depends on the stop_rule if a stop is provided
470
iter([(rev_id, depth, revno, end_of_merge)]),
536
# so pop this node back into the iterator
537
rev_iter = itertools.chain(iter([node]), rev_iter)
473
539
if stop_revision_id is None:
474
for rev_id, depth, revno, end_of_merge in rev_iter:
475
yield rev_id, depth, revno, end_of_merge
541
for node in rev_iter:
543
yield (rev_id, node.merge_depth, node.revno,
476
545
elif stop_rule == 'exclude':
477
for rev_id, depth, revno, end_of_merge in rev_iter:
546
for node in rev_iter:
478
548
if rev_id == stop_revision_id:
480
yield rev_id, depth, revno, end_of_merge
550
yield (rev_id, node.merge_depth, node.revno,
481
552
elif stop_rule == 'include':
482
for rev_id, depth, revno, end_of_merge in rev_iter:
483
yield rev_id, depth, revno, end_of_merge
553
for node in rev_iter:
555
yield (rev_id, node.merge_depth, node.revno,
484
557
if rev_id == stop_revision_id:
559
elif stop_rule == 'with-merges-without-common-ancestry':
560
# We want to exclude all revisions that are already part of the
561
# stop_revision_id ancestry.
562
graph = self.repository.get_graph()
563
ancestors = graph.find_unique_ancestors(start_revision_id,
565
for node in rev_iter:
567
if rev_id not in ancestors:
569
yield (rev_id, node.merge_depth, node.revno,
486
571
elif stop_rule == 'with-merges':
487
572
stop_rev = self.repository.get_revision(stop_revision_id)
488
573
if stop_rev.parent_ids:
489
574
left_parent = stop_rev.parent_ids[0]
491
576
left_parent = _mod_revision.NULL_REVISION
492
for rev_id, depth, revno, end_of_merge in rev_iter:
577
# left_parent is the actual revision we want to stop logging at,
578
# since we want to show the merged revisions after the stop_rev too
579
reached_stop_revision_id = False
580
revision_id_whitelist = []
581
for node in rev_iter:
493
583
if rev_id == left_parent:
584
# reached the left parent after the stop_revision
495
yield rev_id, depth, revno, end_of_merge
586
if (not reached_stop_revision_id or
587
rev_id in revision_id_whitelist):
588
yield (rev_id, node.merge_depth, node.revno,
590
if reached_stop_revision_id or rev_id == stop_revision_id:
591
# only do the merged revs of rev_id from now on
592
rev = self.repository.get_revision(rev_id)
594
reached_stop_revision_id = True
595
revision_id_whitelist.extend(rev.parent_ids)
497
597
raise ValueError('invalid stop_rule %r' % stop_rule)
599
def _filter_start_non_ancestors(self, rev_iter):
600
# If we started from a dotted revno, we want to consider it as a tip
601
# and don't want to yield revisions that are not part of its
602
# ancestry. Given the order guaranteed by the merge sort, we will see
603
# uninteresting descendants of the first parent of our tip before the
605
first = rev_iter.next()
606
(rev_id, merge_depth, revno, end_of_merge) = first
609
# We start at a mainline revision so by definition, all others
610
# revisions in rev_iter are ancestors
611
for node in rev_iter:
616
pmap = self.repository.get_parent_map([rev_id])
617
parents = pmap.get(rev_id, [])
619
whitelist.update(parents)
621
# If there is no parents, there is nothing of interest left
623
# FIXME: It's hard to test this scenario here as this code is never
624
# called in that case. -- vila 20100322
627
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
629
if rev_id in whitelist:
630
pmap = self.repository.get_parent_map([rev_id])
631
parents = pmap.get(rev_id, [])
632
whitelist.remove(rev_id)
633
whitelist.update(parents)
635
# We've reached the mainline, there is nothing left to
639
# A revision that is not part of the ancestry of our
642
yield (rev_id, merge_depth, revno, end_of_merge)
499
644
def leave_lock_in_place(self):
500
645
"""Tell this branch object not to release the physical lock when this
501
646
object is unlocked.
668
854
except (errors.NotStacked, errors.UnstackableBranchFormat,
669
855
errors.UnstackableRepositoryFormat):
672
# XXX: Lock correctness - should unlock our old repo if we were
674
# repositories don't offer an interface to remove fallback
675
# repositories today; take the conceptually simpler option and just
677
self.repository = self.bzrdir.find_repository()
678
self.repository.lock_write()
679
# for every revision reference the branch has, ensure it is pulled
681
source_repository = self._get_fallback_repository(old_url)
682
for revision_id in chain([self.last_revision()],
683
self.tags.get_reverse_tag_dict()):
684
self.repository.fetch(source_repository, revision_id,
687
self._activate_fallback_location(url)
859
self._activate_fallback_location(url,
860
possible_transports=[self.bzrdir.root_transport])
688
861
# write this out after the repository is stacked to avoid setting a
689
862
# stacked config that doesn't work.
690
863
self._set_config_location('stacked_on_location', url)
866
"""Change a branch to be unstacked, copying data as needed.
868
Don't call this directly, use set_stacked_on_url(None).
870
pb = ui.ui_factory.nested_progress_bar()
872
pb.update(gettext("Unstacking"))
873
# The basic approach here is to fetch the tip of the branch,
874
# including all available ghosts, from the existing stacked
875
# repository into a new repository object without the fallbacks.
877
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
878
# correct for CHKMap repostiories
879
old_repository = self.repository
880
if len(old_repository._fallback_repositories) != 1:
881
raise AssertionError("can't cope with fallback repositories "
882
"of %r (fallbacks: %r)" % (old_repository,
883
old_repository._fallback_repositories))
884
# Open the new repository object.
885
# Repositories don't offer an interface to remove fallback
886
# repositories today; take the conceptually simpler option and just
887
# reopen it. We reopen it starting from the URL so that we
888
# get a separate connection for RemoteRepositories and can
889
# stream from one of them to the other. This does mean doing
890
# separate SSH connection setup, but unstacking is not a
891
# common operation so it's tolerable.
892
new_bzrdir = controldir.ControlDir.open(
893
self.bzrdir.root_transport.base)
894
new_repository = new_bzrdir.find_repository()
895
if new_repository._fallback_repositories:
896
raise AssertionError("didn't expect %r to have "
897
"fallback_repositories"
898
% (self.repository,))
899
# Replace self.repository with the new repository.
900
# Do our best to transfer the lock state (i.e. lock-tokens and
901
# lock count) of self.repository to the new repository.
902
lock_token = old_repository.lock_write().repository_token
903
self.repository = new_repository
904
if isinstance(self, remote.RemoteBranch):
905
# Remote branches can have a second reference to the old
906
# repository that need to be replaced.
907
if self._real_branch is not None:
908
self._real_branch.repository = new_repository
909
self.repository.lock_write(token=lock_token)
910
if lock_token is not None:
911
old_repository.leave_lock_in_place()
912
old_repository.unlock()
913
if lock_token is not None:
914
# XXX: self.repository.leave_lock_in_place() before this
915
# function will not be preserved. Fortunately that doesn't
916
# affect the current default format (2a), and would be a
917
# corner-case anyway.
918
# - Andrew Bennetts, 2010/06/30
919
self.repository.dont_leave_lock_in_place()
923
old_repository.unlock()
924
except errors.LockNotHeld:
927
if old_lock_count == 0:
928
raise AssertionError(
929
'old_repository should have been locked at least once.')
930
for i in range(old_lock_count-1):
931
self.repository.lock_write()
932
# Fetch from the old repository into the new.
933
old_repository.lock_read()
935
# XXX: If you unstack a branch while it has a working tree
936
# with a pending merge, the pending-merged revisions will no
937
# longer be present. You can (probably) revert and remerge.
939
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
940
except errors.TagsNotSupported:
941
tags_to_fetch = set()
942
fetch_spec = vf_search.NotInOtherForRevs(self.repository,
943
old_repository, required_ids=[self.last_revision()],
944
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
945
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
947
old_repository.unlock()
693
951
def _set_tags_bytes(self, bytes):
694
952
"""Mirror method for _get_tags_bytes.
696
954
:seealso: Branch._get_tags_bytes.
698
return _run_with_write_locked_target(self, self._transport.put_bytes,
956
op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
957
op.add_cleanup(self.lock_write().unlock)
958
return op.run_simple(bytes)
960
def _set_tags_bytes_locked(self, bytes):
961
self._tags_bytes = bytes
962
return self._transport.put_bytes('tags', bytes)
701
964
def _cache_revision_history(self, rev_history):
702
965
"""Set the cached revision history to rev_history.
787
1056
:return: A tuple (revno, revision_id).
789
1058
if self._last_revision_info_cache is None:
790
self._last_revision_info_cache = self._last_revision_info()
1059
self._last_revision_info_cache = self._read_last_revision_info()
791
1060
return self._last_revision_info_cache
793
def _last_revision_info(self):
794
rh = self.revision_history()
797
return (revno, rh[-1])
799
return (0, _mod_revision.NULL_REVISION)
801
@deprecated_method(deprecated_in((1, 6, 0)))
802
def missing_revisions(self, other, stop_revision=None):
803
"""Return a list of new revisions that would perfectly fit.
805
If self and other have not diverged, return a list of the revisions
806
present in other, but missing from self.
808
self_history = self.revision_history()
809
self_len = len(self_history)
810
other_history = other.revision_history()
811
other_len = len(other_history)
812
common_index = min(self_len, other_len) -1
813
if common_index >= 0 and \
814
self_history[common_index] != other_history[common_index]:
815
raise errors.DivergedBranches(self, other)
817
if stop_revision is None:
818
stop_revision = other_len
820
if stop_revision > other_len:
821
raise errors.NoSuchRevision(self, stop_revision)
822
return other_history[self_len:stop_revision]
825
def update_revisions(self, other, stop_revision=None, overwrite=False,
827
"""Pull in new perfect-fit revisions.
829
:param other: Another Branch to pull from
830
:param stop_revision: Updated until the given revision
831
:param overwrite: Always set the branch pointer, rather than checking
832
to see if it is a proper descendant.
833
:param graph: A Graph object that can be used to query history
834
information. This can be None.
837
return InterBranch.get(other, self).update_revisions(stop_revision,
1062
def _read_last_revision_info(self):
1063
raise NotImplementedError(self._read_last_revision_info)
1065
@deprecated_method(deprecated_in((2, 4, 0)))
840
1066
def import_last_revision_info(self, source_repo, revno, revid):
841
1067
"""Set the last revision info, importing from another repo if necessary.
843
This is used by the bound branch code to upload a revision to
844
the master branch first before updating the tip of the local branch.
846
1069
:param source_repo: Source repository to optionally fetch from
847
1070
:param revno: Revision number of the new tip
848
1071
:param revid: Revision id of the new tip
1177
1387
Callers will typically also want to check the repository.
1389
:param refs: Calculated refs for this branch as specified by
1390
branch._get_check_refs()
1179
1391
:return: A BranchCheckResult.
1181
ret = BranchCheckResult(self)
1182
mainline_parent_id = None
1393
result = BranchCheckResult(self)
1183
1394
last_revno, last_revision_id = self.last_revision_info()
1184
real_rev_history = []
1186
for revid in self.repository.iter_reverse_revision_history(
1188
real_rev_history.append(revid)
1189
except errors.RevisionNotPresent:
1190
ret.ghosts_in_mainline = True
1192
ret.ghosts_in_mainline = False
1193
real_rev_history.reverse()
1194
if len(real_rev_history) != last_revno:
1195
raise errors.BzrCheckError('revno does not match len(mainline)'
1196
' %s != %s' % (last_revno, len(real_rev_history)))
1197
# TODO: We should probably also check that real_rev_history actually
1198
# matches self.revision_history()
1199
for revision_id in real_rev_history:
1201
revision = self.repository.get_revision(revision_id)
1202
except errors.NoSuchRevision, e:
1203
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1205
# In general the first entry on the revision history has no parents.
1206
# But it's not illegal for it to have parents listed; this can happen
1207
# in imports from Arch when the parents weren't reachable.
1208
if mainline_parent_id is not None:
1209
if mainline_parent_id not in revision.parent_ids:
1210
raise errors.BzrCheckError("previous revision {%s} not listed among "
1212
% (mainline_parent_id, revision_id))
1213
mainline_parent_id = revision_id
1395
actual_revno = refs[('lefthand-distance', last_revision_id)]
1396
if actual_revno != last_revno:
1397
result.errors.append(errors.BzrCheckError(
1398
'revno does not match len(mainline) %s != %s' % (
1399
last_revno, actual_revno)))
1400
# TODO: We should probably also check that self.revision_history
1401
# matches the repository for older branch formats.
1402
# If looking for the code that cross-checks repository parents against
1403
# the Graph.iter_lefthand_ancestry output, that is now a repository
1216
def _get_checkout_format(self):
1407
def _get_checkout_format(self, lightweight=False):
1217
1408
"""Return the most suitable metadir for a checkout of this branch.
1218
1409
Weaves are used if this branch's repository uses weaves.
1220
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1221
from bzrlib.repofmt import weaverepo
1222
format = bzrdir.BzrDirMetaFormat1()
1223
format.repository_format = weaverepo.RepositoryFormat7()
1225
format = self.repository.bzrdir.checkout_metadir()
1226
format.set_branch_format(self._format)
1411
format = self.repository.bzrdir.checkout_metadir()
1412
format.set_branch_format(self._format)
1229
1415
def create_clone_on_transport(self, to_transport, revision_id=None,
1230
stacked_on=None, create_prefix=False, use_existing_dir=False):
1416
stacked_on=None, create_prefix=False, use_existing_dir=False,
1231
1418
"""Create a clone of this branch and its bzrdir.
1233
1420
:param to_transport: The transport to clone onto.
1393
1618
return not (self == other)
1396
def find_format(klass, a_bzrdir):
1397
"""Return the format for the branch object in a_bzrdir."""
1399
transport = a_bzrdir.get_branch_transport(None)
1400
format_string = transport.get("format").read()
1401
return klass._formats[format_string]
1402
except errors.NoSuchFile:
1403
raise errors.NotBranchError(path=transport.base)
1405
raise errors.UnknownFormatError(format=format_string, kind='branch')
1621
@deprecated_method(deprecated_in((2, 4, 0)))
1408
1622
def get_default_format(klass):
1409
1623
"""Return the current default format."""
1410
return klass._default_format
1412
def get_reference(self, a_bzrdir):
1413
"""Get the target reference of the branch in a_bzrdir.
1624
return format_registry.get_default()
1627
@deprecated_method(deprecated_in((2, 4, 0)))
1628
def get_formats(klass):
1629
"""Get all the known formats.
1631
Warning: This triggers a load of all lazy registered formats: do not
1632
use except when that is desireed.
1634
return format_registry._get_all()
1636
def get_reference(self, controldir, name=None):
1637
"""Get the target reference of the branch in controldir.
1415
1639
format probing must have been completed before calling
1416
1640
this method - it is assumed that the format of the branch
1417
in a_bzrdir is correct.
1641
in controldir is correct.
1419
:param a_bzrdir: The bzrdir to get the branch data from.
1643
:param controldir: The controldir to get the branch data from.
1644
:param name: Name of the colocated branch to fetch
1420
1645
:return: None if the branch is not a reference branch.
1425
def set_reference(self, a_bzrdir, to_branch):
1426
"""Set the target reference of the branch in a_bzrdir.
1650
def set_reference(self, controldir, name, to_branch):
1651
"""Set the target reference of the branch in controldir.
1428
1653
format probing must have been completed before calling
1429
1654
this method - it is assumed that the format of the branch
1430
in a_bzrdir is correct.
1655
in controldir is correct.
1432
:param a_bzrdir: The bzrdir to set the branch reference for.
1657
:param controldir: The controldir to set the branch reference for.
1658
:param name: Name of colocated branch to set, None for default
1433
1659
:param to_branch: branch that the checkout is to reference
1435
1661
raise NotImplementedError(self.set_reference)
1437
def get_format_string(self):
1438
"""Return the ASCII format string that identifies this format."""
1439
raise NotImplementedError(self.get_format_string)
1441
1663
def get_format_description(self):
1442
1664
"""Return the short format description for this format."""
1443
1665
raise NotImplementedError(self.get_format_description)
1445
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1447
"""Initialize a branch in a bzrdir, with specified files
1449
:param a_bzrdir: The bzrdir to initialize the branch in
1450
:param utf8_files: The files to create as a list of
1451
(filename, content) tuples
1452
:param set_format: If True, set the format with
1453
self.get_format_string. (BzrBranch4 has its format set
1455
:return: a branch in this format
1667
def _run_post_branch_init_hooks(self, controldir, name, branch):
1668
hooks = Branch.hooks['post_branch_init']
1671
params = BranchInitHookParams(self, controldir, name, branch)
1675
def initialize(self, controldir, name=None, repository=None,
1676
append_revisions_only=None):
1677
"""Create a branch of this format in controldir.
1679
:param name: Name of the colocated branch to create.
1457
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1458
branch_transport = a_bzrdir.get_branch_transport(self)
1460
'metadir': ('lock', lockdir.LockDir),
1461
'branch4': ('branch-lock', lockable_files.TransportLock),
1463
lock_name, lock_class = lock_map[lock_type]
1464
control_files = lockable_files.LockableFiles(branch_transport,
1465
lock_name, lock_class)
1466
control_files.create_lock()
1468
control_files.lock_write()
1469
except errors.LockContention:
1470
if lock_type != 'branch4':
1476
utf8_files += [('format', self.get_format_string())]
1478
for (filename, content) in utf8_files:
1479
branch_transport.put_bytes(
1481
mode=a_bzrdir._get_file_mode())
1484
control_files.unlock()
1485
return self.open(a_bzrdir, _found=True)
1487
def initialize(self, a_bzrdir):
1488
"""Create a branch of this format in a_bzrdir."""
1489
1681
raise NotImplementedError(self.initialize)
1491
1683
def is_supported(self):
1604
1842
"basis revision. hooks MUST NOT modify this delta. "
1605
1843
" future_tree is an in-memory tree obtained from "
1606
1844
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1607
"tree.", (0,91), None))
1608
self.create_hook(HookPoint('post_commit',
1846
self.add_hook('post_commit',
1609
1847
"Called in the bzr client after a commit has completed. "
1610
1848
"post_commit is called with (local, master, old_revno, old_revid, "
1611
1849
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1612
"commit to a branch.", (0, 15), None))
1613
self.create_hook(HookPoint('post_uncommit',
1850
"commit to a branch.", (0, 15))
1851
self.add_hook('post_uncommit',
1614
1852
"Called in the bzr client after an uncommit completes. "
1615
1853
"post_uncommit is called with (local, master, old_revno, "
1616
1854
"old_revid, new_revno, new_revid) where local is the local branch "
1617
1855
"or None, master is the target branch, and an empty branch "
1618
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1619
self.create_hook(HookPoint('pre_change_branch_tip',
1856
"receives new_revno of 0, new_revid of None.", (0, 15))
1857
self.add_hook('pre_change_branch_tip',
1620
1858
"Called in bzr client and server before a change to the tip of a "
1621
1859
"branch is made. pre_change_branch_tip is called with a "
1622
1860
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1623
"commit, uncommit will all trigger this hook.", (1, 6), None))
1624
self.create_hook(HookPoint('post_change_branch_tip',
1861
"commit, uncommit will all trigger this hook.", (1, 6))
1862
self.add_hook('post_change_branch_tip',
1625
1863
"Called in bzr client and server after a change to the tip of a "
1626
1864
"branch is made. post_change_branch_tip is called with a "
1627
1865
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1628
"commit, uncommit will all trigger this hook.", (1, 4), None))
1629
self.create_hook(HookPoint('transform_fallback_location',
1866
"commit, uncommit will all trigger this hook.", (1, 4))
1867
self.add_hook('transform_fallback_location',
1630
1868
"Called when a stacked branch is activating its fallback "
1631
1869
"locations. transform_fallback_location is called with (branch, "
1632
1870
"url), and should return a new url. Returning the same url "
1682
1937
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1685
class BzrBranchFormat4(BranchFormat):
1686
"""Bzr branch format 4.
1689
- a revision-history file.
1690
- a branch-lock lock file [ to be shared with the bzrdir ]
1693
def get_format_description(self):
1694
"""See BranchFormat.get_format_description()."""
1695
return "Branch format 4"
1697
def initialize(self, a_bzrdir):
1698
"""Create a branch of this format in a_bzrdir."""
1699
utf8_files = [('revision-history', ''),
1700
('branch-name', ''),
1702
return self._initialize_helper(a_bzrdir, utf8_files,
1703
lock_type='branch4', set_format=False)
1940
class BranchInitHookParams(object):
1941
"""Object holding parameters passed to `*_branch_init` hooks.
1943
There are 4 fields that hooks may wish to access:
1945
:ivar format: the branch format
1946
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1947
:ivar name: name of colocated branch, if any (or None)
1948
:ivar branch: the branch created
1950
Note that for lightweight checkouts, the bzrdir and format fields refer to
1951
the checkout, hence they are different from the corresponding fields in
1952
branch, which refer to the original branch.
1955
def __init__(self, format, controldir, name, branch):
1956
"""Create a group of BranchInitHook parameters.
1958
:param format: the branch format
1959
:param controldir: the ControlDir where the branch will be/has been
1961
:param name: name of colocated branch, if any (or None)
1962
:param branch: the branch created
1964
Note that for lightweight checkouts, the bzrdir and format fields refer
1965
to the checkout, hence they are different from the corresponding fields
1966
in branch, which refer to the original branch.
1968
self.format = format
1969
self.bzrdir = controldir
1971
self.branch = branch
1973
def __eq__(self, other):
1974
return self.__dict__ == other.__dict__
1977
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1980
class SwitchHookParams(object):
1981
"""Object holding parameters passed to `*_switch` hooks.
1983
There are 4 fields that hooks may wish to access:
1985
:ivar control_dir: ControlDir of the checkout to change
1986
:ivar to_branch: branch that the checkout is to reference
1987
:ivar force: skip the check for local commits in a heavy checkout
1988
:ivar revision_id: revision ID to switch to (or None)
1991
def __init__(self, control_dir, to_branch, force, revision_id):
1992
"""Create a group of SwitchHook parameters.
1994
:param control_dir: ControlDir of the checkout to change
1995
:param to_branch: branch that the checkout is to reference
1996
:param force: skip the check for local commits in a heavy checkout
1997
:param revision_id: revision ID to switch to (or None)
1999
self.control_dir = control_dir
2000
self.to_branch = to_branch
2002
self.revision_id = revision_id
2004
def __eq__(self, other):
2005
return self.__dict__ == other.__dict__
2008
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
2009
self.control_dir, self.to_branch,
2013
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
2014
"""Base class for branch formats that live in meta directories.
1705
2017
def __init__(self):
1706
super(BzrBranchFormat4, self).__init__()
1707
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1709
def network_name(self):
1710
"""The network name for this format is the control dirs disk label."""
1711
return self._matchingbzrdir.get_format_string()
1713
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1714
"""See BranchFormat.open()."""
1716
# we are being called directly and must probe.
1717
raise NotImplementedError
1718
return BzrBranch(_format=self,
1719
_control_files=a_bzrdir._control_files,
1721
_repository=a_bzrdir.open_repository())
1724
return "Bazaar-NG branch format 4"
1727
class BranchFormatMetadir(BranchFormat):
1728
"""Common logic for meta-dir based branch formats."""
2018
BranchFormat.__init__(self)
2019
bzrdir.BzrFormat.__init__(self)
2022
def find_format(klass, controldir, name=None):
2023
"""Return the format for the branch object in controldir."""
2025
transport = controldir.get_branch_transport(None, name=name)
2026
except errors.NoSuchFile:
2027
raise errors.NotBranchError(path=name, bzrdir=controldir)
2029
format_string = transport.get_bytes("format")
2030
except errors.NoSuchFile:
2031
raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
2032
return klass._find_format(format_registry, 'branch', format_string)
1730
2034
def _branch_class(self):
1731
2035
"""What class to instantiate on open calls."""
1732
2036
raise NotImplementedError(self._branch_class)
1734
def network_name(self):
1735
"""A simple byte string uniquely identifying this format for RPC calls.
1737
Metadir branch formats use their format string.
2038
def _get_initial_config(self, append_revisions_only=None):
2039
if append_revisions_only:
2040
return "append_revisions_only = True\n"
2042
# Avoid writing anything if append_revisions_only is disabled,
2043
# as that is the default.
2046
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
2048
"""Initialize a branch in a bzrdir, with specified files
2050
:param a_bzrdir: The bzrdir to initialize the branch in
2051
:param utf8_files: The files to create as a list of
2052
(filename, content) tuples
2053
:param name: Name of colocated branch to create, if any
2054
:return: a branch in this format
1739
return self.get_format_string()
2057
name = a_bzrdir._get_selected_branch()
2058
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2059
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2060
control_files = lockable_files.LockableFiles(branch_transport,
2061
'lock', lockdir.LockDir)
2062
control_files.create_lock()
2063
control_files.lock_write()
2065
utf8_files += [('format', self.as_string())]
2066
for (filename, content) in utf8_files:
2067
branch_transport.put_bytes(
2069
mode=a_bzrdir._get_file_mode())
2071
control_files.unlock()
2072
branch = self.open(a_bzrdir, name, _found=True,
2073
found_repository=repository)
2074
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1741
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
2077
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2078
found_repository=None, possible_transports=None):
1742
2079
"""See BranchFormat.open()."""
2081
name = a_bzrdir._get_selected_branch()
1744
format = BranchFormat.find_format(a_bzrdir)
2083
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
1745
2084
if format.__class__ != self.__class__:
1746
2085
raise AssertionError("wrong format %r found for %r" %
1747
2086
(format, self))
2087
transport = a_bzrdir.get_branch_transport(None, name=name)
1749
transport = a_bzrdir.get_branch_transport(None)
1750
2089
control_files = lockable_files.LockableFiles(transport, 'lock',
1751
2090
lockdir.LockDir)
2091
if found_repository is None:
2092
found_repository = a_bzrdir.find_repository()
1752
2093
return self._branch_class()(_format=self,
1753
2094
_control_files=control_files,
1754
2096
a_bzrdir=a_bzrdir,
1755
_repository=a_bzrdir.find_repository(),
1756
ignore_fallbacks=ignore_fallbacks)
2097
_repository=found_repository,
2098
ignore_fallbacks=ignore_fallbacks,
2099
possible_transports=possible_transports)
1757
2100
except errors.NoSuchFile:
1758
raise errors.NotBranchError(path=transport.base)
2101
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1761
super(BranchFormatMetadir, self).__init__()
1762
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1763
self._matchingbzrdir.set_branch_format(self)
2104
def _matchingbzrdir(self):
2105
ret = bzrdir.BzrDirMetaFormat1()
2106
ret.set_branch_format(self)
1765
2109
def supports_tags(self):
2112
def supports_leaving_lock(self):
2115
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
2117
BranchFormat.check_support_status(self,
2118
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
2120
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
2121
recommend_upgrade=recommend_upgrade, basedir=basedir)
1769
2124
class BzrBranchFormat5(BranchFormatMetadir):
1770
2125
"""Bzr branch format 5.
1933
2304
"""See BranchFormat.get_format_description()."""
1934
2305
return "Checkout reference format 1"
1936
def get_reference(self, a_bzrdir):
2307
def get_reference(self, a_bzrdir, name=None):
1937
2308
"""See BranchFormat.get_reference()."""
1938
transport = a_bzrdir.get_branch_transport(None)
1939
return transport.get('location').read()
2309
transport = a_bzrdir.get_branch_transport(None, name=name)
2310
return transport.get_bytes('location')
1941
def set_reference(self, a_bzrdir, to_branch):
2312
def set_reference(self, a_bzrdir, name, to_branch):
1942
2313
"""See BranchFormat.set_reference()."""
1943
transport = a_bzrdir.get_branch_transport(None)
2314
transport = a_bzrdir.get_branch_transport(None, name=name)
1944
2315
location = transport.put_bytes('location', to_branch.base)
1946
def initialize(self, a_bzrdir, target_branch=None):
2317
def initialize(self, a_bzrdir, name=None, target_branch=None,
2318
repository=None, append_revisions_only=None):
1947
2319
"""Create a branch of this format in a_bzrdir."""
1948
2320
if target_branch is None:
1949
2321
# this format does not implement branch itself, thus the implicit
1950
2322
# creation contract must see it as uninitializable
1951
2323
raise errors.UninitializableFormat(self)
1952
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1953
branch_transport = a_bzrdir.get_branch_transport(self)
2324
mutter('creating branch reference in %s', a_bzrdir.user_url)
2325
if a_bzrdir._format.fixed_components:
2326
raise errors.IncompatibleFormat(self, a_bzrdir._format)
2328
name = a_bzrdir._get_selected_branch()
2329
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1954
2330
branch_transport.put_bytes('location',
1955
target_branch.bzrdir.root_transport.base)
1956
branch_transport.put_bytes('format', self.get_format_string())
1958
a_bzrdir, _found=True,
2331
target_branch.user_url)
2332
branch_transport.put_bytes('format', self.as_string())
2333
branch = self.open(a_bzrdir, name, _found=True,
1959
2334
possible_transports=[target_branch.bzrdir.root_transport])
1962
super(BranchReferenceFormat, self).__init__()
1963
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1964
self._matchingbzrdir.set_branch_format(self)
2335
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1966
2338
def _make_reference_clone_function(format, a_branch):
1967
2339
"""Create a clone() routine for a branch dynamically."""
1968
2340
def clone(to_bzrdir, revision_id=None,
1969
2341
repository_policy=None):
1970
2342
"""See Branch.clone()."""
1971
return format.initialize(to_bzrdir, a_branch)
2343
return format.initialize(to_bzrdir, target_branch=a_branch)
1972
2344
# cannot obey revision_id limits when cloning a reference ...
1973
2345
# FIXME RBC 20060210 either nuke revision_id for clone, or
1974
2346
# emit some sort of warning/error to the caller ?!
1977
def open(self, a_bzrdir, _found=False, location=None,
1978
possible_transports=None, ignore_fallbacks=False):
2349
def open(self, a_bzrdir, name=None, _found=False, location=None,
2350
possible_transports=None, ignore_fallbacks=False,
2351
found_repository=None):
1979
2352
"""Return the branch that the branch reference in a_bzrdir points at.
1981
2354
:param a_bzrdir: A BzrDir that contains a branch.
2355
:param name: Name of colocated branch to open, if any
1982
2356
:param _found: a private parameter, do not use it. It is used to
1983
2357
indicate if format probing has already be done.
1984
2358
:param ignore_fallbacks: when set, no fallback branches will be opened
2145
2583
"""See Branch.print_file."""
2146
2584
return self.repository.print_file(file, revision_id)
2148
def _write_revision_history(self, history):
2149
"""Factored out of set_revision_history.
2151
This performs the actual writing to disk.
2152
It is intended to be called by BzrBranch5.set_revision_history."""
2153
self._transport.put_bytes(
2154
'revision-history', '\n'.join(history),
2155
mode=self.bzrdir._get_file_mode())
2158
def set_revision_history(self, rev_history):
2159
"""See Branch.set_revision_history."""
2160
if 'evil' in debug.debug_flags:
2161
mutter_callsite(3, "set_revision_history scales with history.")
2162
check_not_reserved_id = _mod_revision.check_not_reserved_id
2163
for rev_id in rev_history:
2164
check_not_reserved_id(rev_id)
2165
if Branch.hooks['post_change_branch_tip']:
2166
# Don't calculate the last_revision_info() if there are no hooks
2168
old_revno, old_revid = self.last_revision_info()
2169
if len(rev_history) == 0:
2170
revid = _mod_revision.NULL_REVISION
2172
revid = rev_history[-1]
2173
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2174
self._write_revision_history(rev_history)
2175
self._clear_cached_state()
2176
self._cache_revision_history(rev_history)
2177
for hook in Branch.hooks['set_rh']:
2178
hook(self, rev_history)
2179
if Branch.hooks['post_change_branch_tip']:
2180
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2182
def _synchronize_history(self, destination, revision_id):
2183
"""Synchronize last revision and revision history between branches.
2185
This version is most efficient when the destination is also a
2186
BzrBranch5, but works for BzrBranch6 as long as the revision
2187
history is the true lefthand parent history, and all of the revisions
2188
are in the destination's repository. If not, set_revision_history
2191
:param destination: The branch to copy the history into
2192
:param revision_id: The revision-id to truncate history at. May
2193
be None to copy complete history.
2195
if not isinstance(destination._format, BzrBranchFormat5):
2196
super(BzrBranch, self)._synchronize_history(
2197
destination, revision_id)
2199
if revision_id == _mod_revision.NULL_REVISION:
2202
new_history = self.revision_history()
2203
if revision_id is not None and new_history != []:
2205
new_history = new_history[:new_history.index(revision_id) + 1]
2207
rev = self.repository.get_revision(revision_id)
2208
new_history = rev.get_history(self.repository)[1:]
2209
destination.set_revision_history(new_history)
2211
2586
@needs_write_lock
2212
2587
def set_last_revision_info(self, revno, revision_id):
2213
"""Set the last revision of this branch.
2215
The caller is responsible for checking that the revno is correct
2216
for this revision id.
2218
It may be possible to set the branch last revision to an id not
2219
present in the repository. However, branches can also be
2220
configured to check constraints on history, in which case this may not
2588
if not revision_id or not isinstance(revision_id, basestring):
2589
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2223
2590
revision_id = _mod_revision.ensure_null(revision_id)
2224
# this old format stores the full history, but this api doesn't
2225
# provide it, so we must generate, and might as well check it's
2227
history = self._lefthand_history(revision_id)
2228
if len(history) != revno:
2229
raise AssertionError('%d != %d' % (len(history), revno))
2230
self.set_revision_history(history)
2232
def _gen_revision_history(self):
2233
history = self._transport.get_bytes('revision-history').split('\n')
2234
if history[-1:] == ['']:
2235
# There shouldn't be a trailing newline, but just in case.
2240
def generate_revision_history(self, revision_id, last_rev=None,
2242
"""Create a new revision history that will finish with revision_id.
2244
:param revision_id: the new tip to use.
2245
:param last_rev: The previous last_revision. If not None, then this
2246
must be a ancestory of revision_id, or DivergedBranches is raised.
2247
:param other_branch: The other branch that DivergedBranches should
2248
raise with respect to.
2250
self.set_revision_history(self._lefthand_history(revision_id,
2251
last_rev, other_branch))
2591
old_revno, old_revid = self.last_revision_info()
2592
if self.get_append_revisions_only():
2593
self._check_history_violation(revision_id)
2594
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2595
self._write_last_revision_info(revno, revision_id)
2596
self._clear_cached_state()
2597
self._last_revision_info_cache = revno, revision_id
2598
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2253
2600
def basis_tree(self):
2254
2601
"""See Branch.basis_tree."""
2403
class BzrBranch8(BzrBranch5):
2722
def _read_last_revision_info(self):
2723
revision_string = self._transport.get_bytes('last-revision')
2724
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2725
revision_id = cache_utf8.get_cached_utf8(revision_id)
2727
return revno, revision_id
2729
def _write_last_revision_info(self, revno, revision_id):
2730
"""Simply write out the revision id, with no checks.
2732
Use set_last_revision_info to perform this safely.
2734
Does not update the revision_history cache.
2736
revision_id = _mod_revision.ensure_null(revision_id)
2737
out_string = '%d %s\n' % (revno, revision_id)
2738
self._transport.put_bytes('last-revision', out_string,
2739
mode=self.bzrdir._get_file_mode())
2742
def update_feature_flags(self, updated_flags):
2743
"""Update the feature flags for this branch.
2745
:param updated_flags: Dictionary mapping feature names to necessities
2746
A necessity can be None to indicate the feature should be removed
2748
self._format._update_feature_flags(updated_flags)
2749
self.control_transport.put_bytes('format', self._format.as_string())
2752
class FullHistoryBzrBranch(BzrBranch):
2753
"""Bzr branch which contains the full revision history."""
2756
def set_last_revision_info(self, revno, revision_id):
2757
if not revision_id or not isinstance(revision_id, basestring):
2758
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2759
revision_id = _mod_revision.ensure_null(revision_id)
2760
# this old format stores the full history, but this api doesn't
2761
# provide it, so we must generate, and might as well check it's
2763
history = self._lefthand_history(revision_id)
2764
if len(history) != revno:
2765
raise AssertionError('%d != %d' % (len(history), revno))
2766
self._set_revision_history(history)
2768
def _read_last_revision_info(self):
2769
rh = self._revision_history()
2772
return (revno, rh[-1])
2774
return (0, _mod_revision.NULL_REVISION)
2776
@deprecated_method(deprecated_in((2, 4, 0)))
2778
def set_revision_history(self, rev_history):
2779
"""See Branch.set_revision_history."""
2780
self._set_revision_history(rev_history)
2782
def _set_revision_history(self, rev_history):
2783
if 'evil' in debug.debug_flags:
2784
mutter_callsite(3, "set_revision_history scales with history.")
2785
check_not_reserved_id = _mod_revision.check_not_reserved_id
2786
for rev_id in rev_history:
2787
check_not_reserved_id(rev_id)
2788
if Branch.hooks['post_change_branch_tip']:
2789
# Don't calculate the last_revision_info() if there are no hooks
2791
old_revno, old_revid = self.last_revision_info()
2792
if len(rev_history) == 0:
2793
revid = _mod_revision.NULL_REVISION
2795
revid = rev_history[-1]
2796
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2797
self._write_revision_history(rev_history)
2798
self._clear_cached_state()
2799
self._cache_revision_history(rev_history)
2800
for hook in Branch.hooks['set_rh']:
2801
hook(self, rev_history)
2802
if Branch.hooks['post_change_branch_tip']:
2803
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2805
def _write_revision_history(self, history):
2806
"""Factored out of set_revision_history.
2808
This performs the actual writing to disk.
2809
It is intended to be called by set_revision_history."""
2810
self._transport.put_bytes(
2811
'revision-history', '\n'.join(history),
2812
mode=self.bzrdir._get_file_mode())
2814
def _gen_revision_history(self):
2815
history = self._transport.get_bytes('revision-history').split('\n')
2816
if history[-1:] == ['']:
2817
# There shouldn't be a trailing newline, but just in case.
2821
def _synchronize_history(self, destination, revision_id):
2822
if not isinstance(destination, FullHistoryBzrBranch):
2823
super(BzrBranch, self)._synchronize_history(
2824
destination, revision_id)
2826
if revision_id == _mod_revision.NULL_REVISION:
2829
new_history = self._revision_history()
2830
if revision_id is not None and new_history != []:
2832
new_history = new_history[:new_history.index(revision_id) + 1]
2834
rev = self.repository.get_revision(revision_id)
2835
new_history = rev.get_history(self.repository)[1:]
2836
destination._set_revision_history(new_history)
2839
def generate_revision_history(self, revision_id, last_rev=None,
2841
"""Create a new revision history that will finish with revision_id.
2843
:param revision_id: the new tip to use.
2844
:param last_rev: The previous last_revision. If not None, then this
2845
must be a ancestory of revision_id, or DivergedBranches is raised.
2846
:param other_branch: The other branch that DivergedBranches should
2847
raise with respect to.
2849
self._set_revision_history(self._lefthand_history(revision_id,
2850
last_rev, other_branch))
2853
class BzrBranch5(FullHistoryBzrBranch):
2854
"""A format 5 branch. This supports new features over plain branches.
2856
It has support for a master_branch which is the data for bound branches.
2860
class BzrBranch8(BzrBranch):
2404
2861
"""A branch that stores tree-reference locations."""
2406
def _open_hook(self):
2863
def _open_hook(self, possible_transports=None):
2407
2864
if self._ignore_fallbacks:
2866
if possible_transports is None:
2867
possible_transports = [self.bzrdir.root_transport]
2410
2869
url = self.get_stacked_on_url()
2411
2870
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2432
2892
self._last_revision_info_cache = None
2433
2893
self._reference_info = None
2435
def _last_revision_info(self):
2436
revision_string = self._transport.get_bytes('last-revision')
2437
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2438
revision_id = cache_utf8.get_cached_utf8(revision_id)
2440
return revno, revision_id
2442
def _write_last_revision_info(self, revno, revision_id):
2443
"""Simply write out the revision id, with no checks.
2445
Use set_last_revision_info to perform this safely.
2447
Does not update the revision_history cache.
2448
Intended to be called by set_last_revision_info and
2449
_write_revision_history.
2451
revision_id = _mod_revision.ensure_null(revision_id)
2452
out_string = '%d %s\n' % (revno, revision_id)
2453
self._transport.put_bytes('last-revision', out_string,
2454
mode=self.bzrdir._get_file_mode())
2457
def set_last_revision_info(self, revno, revision_id):
2458
revision_id = _mod_revision.ensure_null(revision_id)
2459
old_revno, old_revid = self.last_revision_info()
2460
if self._get_append_revisions_only():
2461
self._check_history_violation(revision_id)
2462
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2463
self._write_last_revision_info(revno, revision_id)
2464
self._clear_cached_state()
2465
self._last_revision_info_cache = revno, revision_id
2466
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2468
def _synchronize_history(self, destination, revision_id):
2469
"""Synchronize last revision and revision history between branches.
2471
:see: Branch._synchronize_history
2473
# XXX: The base Branch has a fast implementation of this method based
2474
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2475
# that uses set_revision_history. This class inherits from BzrBranch5,
2476
# but wants the fast implementation, so it calls
2477
# Branch._synchronize_history directly.
2478
Branch._synchronize_history(self, destination, revision_id)
2480
2895
def _check_history_violation(self, revision_id):
2481
last_revision = _mod_revision.ensure_null(self.last_revision())
2896
current_revid = self.last_revision()
2897
last_revision = _mod_revision.ensure_null(current_revid)
2482
2898
if _mod_revision.is_null(last_revision):
2484
if last_revision not in self._lefthand_history(revision_id):
2485
raise errors.AppendRevisionsOnlyViolation(self.base)
2900
graph = self.repository.get_graph()
2901
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2902
if lh_ancestor == current_revid:
2904
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2487
2906
def _gen_revision_history(self):
2488
2907
"""Generate the revision history from last revision
2941
3328
raise NotImplementedError(self.push)
3331
def copy_content_into(self, revision_id=None):
3332
"""Copy the content of source into target
3334
revision_id: if not None, the revision history in the new branch will
3335
be truncated to end with revision_id.
3337
raise NotImplementedError(self.copy_content_into)
3340
def fetch(self, stop_revision=None, limit=None):
3343
:param stop_revision: Last revision to fetch
3344
:param limit: Optional rough limit of revisions to fetch
3346
raise NotImplementedError(self.fetch)
2944
3349
class GenericInterBranch(InterBranch):
2945
"""InterBranch implementation that uses public Branch functions.
2949
def _get_branch_formats_to_test():
2950
return BranchFormat._default_format, BranchFormat._default_format
2952
def update_revisions(self, stop_revision=None, overwrite=False,
2954
"""See InterBranch.update_revisions()."""
3350
"""InterBranch implementation that uses public Branch functions."""
3353
def is_compatible(klass, source, target):
3354
# GenericBranch uses the public API, so always compatible
3358
def _get_branch_formats_to_test(klass):
3359
return [(format_registry.get_default(), format_registry.get_default())]
3362
def unwrap_format(klass, format):
3363
if isinstance(format, remote.RemoteBranchFormat):
3364
format._ensure_real()
3365
return format._custom_format
3369
def copy_content_into(self, revision_id=None):
3370
"""Copy the content of source into target
3372
revision_id: if not None, the revision history in the new branch will
3373
be truncated to end with revision_id.
3375
self.source.update_references(self.target)
3376
self.source._synchronize_history(self.target, revision_id)
3378
parent = self.source.get_parent()
3379
except errors.InaccessibleParent, e:
3380
mutter('parent was not accessible to copy: %s', e)
3383
self.target.set_parent(parent)
3384
if self.source._push_should_merge_tags():
3385
self.source.tags.merge_to(self.target.tags)
3388
def fetch(self, stop_revision=None, limit=None):
3389
if self.target.base == self.source.base:
2955
3391
self.source.lock_read()
2957
other_revno, other_last_revision = self.source.last_revision_info()
2958
stop_revno = None # unknown
2959
if stop_revision is None:
2960
stop_revision = other_last_revision
2961
if _mod_revision.is_null(stop_revision):
2962
# if there are no commits, we're done.
2964
stop_revno = other_revno
2966
# what's the current last revision, before we fetch [and change it
2968
last_rev = _mod_revision.ensure_null(self.target.last_revision())
2969
# we fetch here so that we don't process data twice in the common
2970
# case of having something to pull, and so that the check for
2971
# already merged can operate on the just fetched graph, which will
2972
# be cached in memory.
2973
self.target.fetch(self.source, stop_revision)
2974
# Check to see if one is an ancestor of the other
2977
graph = self.target.repository.get_graph()
2978
if self.target._check_if_descendant_or_diverged(
2979
stop_revision, last_rev, graph, self.source):
2980
# stop_revision is a descendant of last_rev, but we aren't
2981
# overwriting, so we're done.
2983
if stop_revno is None:
2985
graph = self.target.repository.get_graph()
2986
this_revno, this_last_revision = \
2987
self.target.last_revision_info()
2988
stop_revno = graph.find_distance_to_null(stop_revision,
2989
[(other_last_revision, other_revno),
2990
(this_last_revision, this_revno)])
2991
self.target.set_last_revision_info(stop_revno, stop_revision)
3393
fetch_spec_factory = fetch.FetchSpecFactory()
3394
fetch_spec_factory.source_branch = self.source
3395
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3396
fetch_spec_factory.source_repo = self.source.repository
3397
fetch_spec_factory.target_repo = self.target.repository
3398
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3399
fetch_spec_factory.limit = limit
3400
fetch_spec = fetch_spec_factory.make_fetch_spec()
3401
return self.target.repository.fetch(self.source.repository,
3402
fetch_spec=fetch_spec)
2993
3404
self.source.unlock()
3407
def _update_revisions(self, stop_revision=None, overwrite=False,
3409
other_revno, other_last_revision = self.source.last_revision_info()
3410
stop_revno = None # unknown
3411
if stop_revision is None:
3412
stop_revision = other_last_revision
3413
if _mod_revision.is_null(stop_revision):
3414
# if there are no commits, we're done.
3416
stop_revno = other_revno
3418
# what's the current last revision, before we fetch [and change it
3420
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3421
# we fetch here so that we don't process data twice in the common
3422
# case of having something to pull, and so that the check for
3423
# already merged can operate on the just fetched graph, which will
3424
# be cached in memory.
3425
self.fetch(stop_revision=stop_revision)
3426
# Check to see if one is an ancestor of the other
3429
graph = self.target.repository.get_graph()
3430
if self.target._check_if_descendant_or_diverged(
3431
stop_revision, last_rev, graph, self.source):
3432
# stop_revision is a descendant of last_rev, but we aren't
3433
# overwriting, so we're done.
3435
if stop_revno is None:
3437
graph = self.target.repository.get_graph()
3438
this_revno, this_last_revision = \
3439
self.target.last_revision_info()
3440
stop_revno = graph.find_distance_to_null(stop_revision,
3441
[(other_last_revision, other_revno),
3442
(this_last_revision, this_revno)])
3443
self.target.set_last_revision_info(stop_revno, stop_revision)
2995
3446
def pull(self, overwrite=False, stop_revision=None,
3447
possible_transports=None, run_hooks=True,
3448
_override_hook_target=None, local=False):
3449
"""Pull from source into self, updating my master if any.
3451
:param run_hooks: Private parameter - if false, this branch
3452
is being called because it's the master of the primary branch,
3453
so it should not run its hooks.
3455
bound_location = self.target.get_bound_location()
3456
if local and not bound_location:
3457
raise errors.LocalRequiresBoundBranch()
3458
master_branch = None
3459
source_is_master = False
3461
# bound_location comes from a config file, some care has to be
3462
# taken to relate it to source.user_url
3463
normalized = urlutils.normalize_url(bound_location)
3465
relpath = self.source.user_transport.relpath(normalized)
3466
source_is_master = (relpath == '')
3467
except (errors.PathNotChild, errors.InvalidURL):
3468
source_is_master = False
3469
if not local and bound_location and not source_is_master:
3470
# not pulling from master, so we need to update master.
3471
master_branch = self.target.get_master_branch(possible_transports)
3472
master_branch.lock_write()
3475
# pull from source into master.
3476
master_branch.pull(self.source, overwrite, stop_revision,
3478
return self._pull(overwrite,
3479
stop_revision, _hook_master=master_branch,
3480
run_hooks=run_hooks,
3481
_override_hook_target=_override_hook_target,
3482
merge_tags_to_master=not source_is_master)
3485
master_branch.unlock()
3487
def push(self, overwrite=False, stop_revision=None, lossy=False,
3488
_override_hook_source_branch=None):
3489
"""See InterBranch.push.
3491
This is the basic concrete implementation of push()
3493
:param _override_hook_source_branch: If specified, run the hooks
3494
passing this Branch as the source, rather than self. This is for
3495
use of RemoteBranch, where push is delegated to the underlying
3499
raise errors.LossyPushToSameVCS(self.source, self.target)
3500
# TODO: Public option to disable running hooks - should be trivial but
3503
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3504
op.add_cleanup(self.source.lock_read().unlock)
3505
op.add_cleanup(self.target.lock_write().unlock)
3506
return op.run(overwrite, stop_revision,
3507
_override_hook_source_branch=_override_hook_source_branch)
3509
def _basic_push(self, overwrite, stop_revision):
3510
"""Basic implementation of push without bound branches or hooks.
3512
Must be called with source read locked and target write locked.
3514
result = BranchPushResult()
3515
result.source_branch = self.source
3516
result.target_branch = self.target
3517
result.old_revno, result.old_revid = self.target.last_revision_info()
3518
self.source.update_references(self.target)
3519
if result.old_revid != stop_revision:
3520
# We assume that during 'push' this repository is closer than
3522
graph = self.source.repository.get_graph(self.target.repository)
3523
self._update_revisions(stop_revision, overwrite=overwrite,
3525
if self.source._push_should_merge_tags():
3526
result.tag_updates, result.tag_conflicts = (
3527
self.source.tags.merge_to(self.target.tags, overwrite))
3528
result.new_revno, result.new_revid = self.target.last_revision_info()
3531
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3532
_override_hook_source_branch=None):
3533
"""Push from source into target, and into target's master if any.
3536
if _override_hook_source_branch:
3537
result.source_branch = _override_hook_source_branch
3538
for hook in Branch.hooks['post_push']:
3541
bound_location = self.target.get_bound_location()
3542
if bound_location and self.target.base != bound_location:
3543
# there is a master branch.
3545
# XXX: Why the second check? Is it even supported for a branch to
3546
# be bound to itself? -- mbp 20070507
3547
master_branch = self.target.get_master_branch()
3548
master_branch.lock_write()
3549
operation.add_cleanup(master_branch.unlock)
3550
# push into the master from the source branch.
3551
master_inter = InterBranch.get(self.source, master_branch)
3552
master_inter._basic_push(overwrite, stop_revision)
3553
# and push into the target branch from the source. Note that
3554
# we push from the source branch again, because it's considered
3555
# the highest bandwidth repository.
3556
result = self._basic_push(overwrite, stop_revision)
3557
result.master_branch = master_branch
3558
result.local_branch = self.target
3560
master_branch = None
3562
result = self._basic_push(overwrite, stop_revision)
3563
# TODO: Why set master_branch and local_branch if there's no
3564
# binding? Maybe cleaner to just leave them unset? -- mbp
3566
result.master_branch = self.target
3567
result.local_branch = None
3571
def _pull(self, overwrite=False, stop_revision=None,
2996
3572
possible_transports=None, _hook_master=None, run_hooks=True,
2997
_override_hook_target=None, local=False):
3573
_override_hook_target=None, local=False,
3574
merge_tags_to_master=True):
2998
3575
"""See Branch.pull.
3577
This function is the core worker, used by GenericInterBranch.pull to
3578
avoid duplication when pulling source->master and source->local.
3000
3580
:param _hook_master: Private parameter - set the branch to
3001
3581
be supplied as the master to pull hooks.
3002
3582
:param run_hooks: Private parameter - if false, this branch
3003
3583
is being called because it's the master of the primary branch,
3004
3584
so it should not run its hooks.
3585
is being called because it's the master of the primary branch,
3586
so it should not run its hooks.
3005
3587
:param _override_hook_target: Private parameter - set the branch to be
3006
3588
supplied as the target_branch to pull hooks.
3007
3589
:param local: Only update the local branch, and not the bound branch.
3047
3630
self.source.unlock()
3050
def push(self, overwrite=False, stop_revision=None,
3051
_override_hook_source_branch=None):
3052
"""See InterBranch.push.
3054
This is the basic concrete implementation of push()
3056
:param _override_hook_source_branch: If specified, run
3057
the hooks passing this Branch as the source, rather than self.
3058
This is for use of RemoteBranch, where push is delegated to the
3059
underlying vfs-based Branch.
3061
# TODO: Public option to disable running hooks - should be trivial but
3063
self.source.lock_read()
3065
return _run_with_write_locked_target(
3066
self.target, self._push_with_bound_branches, overwrite,
3068
_override_hook_source_branch=_override_hook_source_branch)
3070
self.source.unlock()
3073
def _push_with_bound_branches(self, overwrite, stop_revision,
3074
_override_hook_source_branch=None):
3075
"""Push from source into target, and into target's master if any.
3078
if _override_hook_source_branch:
3079
result.source_branch = _override_hook_source_branch
3080
for hook in Branch.hooks['post_push']:
3083
bound_location = self.target.get_bound_location()
3084
if bound_location and self.target.base != bound_location:
3085
# there is a master branch.
3087
# XXX: Why the second check? Is it even supported for a branch to
3088
# be bound to itself? -- mbp 20070507
3089
master_branch = self.target.get_master_branch()
3090
master_branch.lock_write()
3092
# push into the master from the source branch.
3093
self.source._basic_push(master_branch, overwrite, stop_revision)
3094
# and push into the target branch from the source. Note that we
3095
# push from the source branch again, because its considered the
3096
# highest bandwidth repository.
3097
result = self.source._basic_push(self.target, overwrite,
3099
result.master_branch = master_branch
3100
result.local_branch = self.target
3104
master_branch.unlock()
3107
result = self.source._basic_push(self.target, overwrite,
3109
# TODO: Why set master_branch and local_branch if there's no
3110
# binding? Maybe cleaner to just leave them unset? -- mbp
3112
result.master_branch = self.target
3113
result.local_branch = None
3118
def is_compatible(self, source, target):
3119
# GenericBranch uses the public API, so always compatible
3123
class InterToBranch5(GenericInterBranch):
3126
def _get_branch_formats_to_test():
3127
return BranchFormat._default_format, BzrBranchFormat5()
3129
def pull(self, overwrite=False, stop_revision=None,
3130
possible_transports=None, run_hooks=True,
3131
_override_hook_target=None, local=False):
3132
"""Pull from source into self, updating my master if any.
3134
:param run_hooks: Private parameter - if false, this branch
3135
is being called because it's the master of the primary branch,
3136
so it should not run its hooks.
3138
bound_location = self.target.get_bound_location()
3139
if local and not bound_location:
3140
raise errors.LocalRequiresBoundBranch()
3141
master_branch = None
3142
if not local and bound_location and self.source.base != bound_location:
3143
# not pulling from master, so we need to update master.
3144
master_branch = self.target.get_master_branch(possible_transports)
3145
master_branch.lock_write()
3148
# pull from source into master.
3149
master_branch.pull(self.source, overwrite, stop_revision,
3151
return super(InterToBranch5, self).pull(overwrite,
3152
stop_revision, _hook_master=master_branch,
3153
run_hooks=run_hooks,
3154
_override_hook_target=_override_hook_target)
3157
master_branch.unlock()
3160
3634
InterBranch.register_optimiser(GenericInterBranch)
3161
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
