57
73
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
######################################################################
76
class Branch(controldir.ControlComponent):
78
77
"""Branch holding a history of revisions.
81
Base directory/url of the branch.
83
hooks: An instance of BranchHooks.
80
Base directory/url of the branch; using control_url and
81
control_transport is more standardized.
82
:ivar hooks: An instance of BranchHooks.
83
:ivar _master_branch_cache: cached result of get_master_branch, see
85
86
# this is really an instance variable - FIXME move it there
89
def __init__(self, *ignored, **ignored_too):
91
def control_transport(self):
92
return self._transport
95
def user_transport(self):
96
return self.bzrdir.user_transport
98
def __init__(self, possible_transports=None):
90
99
self.tags = self._format.make_tags(self)
91
100
self._revision_history_cache = None
92
101
self._revision_id_to_revno_cache = None
93
102
self._partial_revision_id_to_revno_cache = {}
94
103
self._partial_revision_history_cache = []
104
self._tags_bytes = None
95
105
self._last_revision_info_cache = None
106
self._master_branch_cache = None
96
107
self._merge_sorted_revisions_cache = None
108
self._open_hook(possible_transports)
98
109
hooks = Branch.hooks['open']
99
110
for hook in hooks:
102
def _open_hook(self):
113
def _open_hook(self, possible_transports):
103
114
"""Called by init to allow simpler extension of the base class."""
105
def _activate_fallback_location(self, url):
116
def _activate_fallback_location(self, url, possible_transports):
106
117
"""Activate the branch/repository from url as a fallback repository."""
107
repo = self._get_fallback_repository(url)
118
for existing_fallback_repo in self.repository._fallback_repositories:
119
if existing_fallback_repo.user_url == url:
120
# This fallback is already configured. This probably only
121
# happens because ControlDir.sprout is a horrible mess. To avoid
122
# confusing _unstack we don't add this a second time.
123
mutter('duplicate activation of fallback %r on %r', url, self)
125
repo = self._get_fallback_repository(url, possible_transports)
126
if repo.has_same_location(self.repository):
127
raise errors.UnstackableLocationError(self.user_url, url)
108
128
self.repository.add_fallback_repository(repo)
110
130
def break_lock(self):
460
544
"""Iterate over an inclusive range of sorted revisions."""
461
545
rev_iter = iter(merge_sorted_revisions)
462
546
if start_revision_id is not None:
463
for rev_id, depth, revno, end_of_merge in rev_iter:
547
for node in rev_iter:
464
549
if rev_id != start_revision_id:
467
552
# The decision to include the start or not
468
553
# depends on the stop_rule if a stop is provided
470
iter([(rev_id, depth, revno, end_of_merge)]),
554
# so pop this node back into the iterator
555
rev_iter = itertools.chain(iter([node]), rev_iter)
473
557
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
559
for node in rev_iter:
561
yield (rev_id, node.merge_depth, node.revno,
476
563
elif stop_rule == 'exclude':
477
for rev_id, depth, revno, end_of_merge in rev_iter:
564
for node in rev_iter:
478
566
if rev_id == stop_revision_id:
480
yield rev_id, depth, revno, end_of_merge
568
yield (rev_id, node.merge_depth, node.revno,
481
570
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
571
for node in rev_iter:
573
yield (rev_id, node.merge_depth, node.revno,
484
575
if rev_id == stop_revision_id:
577
elif stop_rule == 'with-merges-without-common-ancestry':
578
# We want to exclude all revisions that are already part of the
579
# stop_revision_id ancestry.
580
graph = self.repository.get_graph()
581
ancestors = graph.find_unique_ancestors(start_revision_id,
583
for node in rev_iter:
585
if rev_id not in ancestors:
587
yield (rev_id, node.merge_depth, node.revno,
486
589
elif stop_rule == 'with-merges':
487
590
stop_rev = self.repository.get_revision(stop_revision_id)
488
591
if stop_rev.parent_ids:
489
592
left_parent = stop_rev.parent_ids[0]
491
594
left_parent = _mod_revision.NULL_REVISION
492
for rev_id, depth, revno, end_of_merge in rev_iter:
595
# left_parent is the actual revision we want to stop logging at,
596
# since we want to show the merged revisions after the stop_rev too
597
reached_stop_revision_id = False
598
revision_id_whitelist = []
599
for node in rev_iter:
493
601
if rev_id == left_parent:
602
# reached the left parent after the stop_revision
495
yield rev_id, depth, revno, end_of_merge
604
if (not reached_stop_revision_id or
605
rev_id in revision_id_whitelist):
606
yield (rev_id, node.merge_depth, node.revno,
608
if reached_stop_revision_id or rev_id == stop_revision_id:
609
# only do the merged revs of rev_id from now on
610
rev = self.repository.get_revision(rev_id)
612
reached_stop_revision_id = True
613
revision_id_whitelist.extend(rev.parent_ids)
497
615
raise ValueError('invalid stop_rule %r' % stop_rule)
617
def _filter_start_non_ancestors(self, rev_iter):
618
# If we started from a dotted revno, we want to consider it as a tip
619
# and don't want to yield revisions that are not part of its
620
# ancestry. Given the order guaranteed by the merge sort, we will see
621
# uninteresting descendants of the first parent of our tip before the
623
first = rev_iter.next()
624
(rev_id, merge_depth, revno, end_of_merge) = first
627
# We start at a mainline revision so by definition, all others
628
# revisions in rev_iter are ancestors
629
for node in rev_iter:
634
pmap = self.repository.get_parent_map([rev_id])
635
parents = pmap.get(rev_id, [])
637
whitelist.update(parents)
639
# If there is no parents, there is nothing of interest left
641
# FIXME: It's hard to test this scenario here as this code is never
642
# called in that case. -- vila 20100322
645
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
647
if rev_id in whitelist:
648
pmap = self.repository.get_parent_map([rev_id])
649
parents = pmap.get(rev_id, [])
650
whitelist.remove(rev_id)
651
whitelist.update(parents)
653
# We've reached the mainline, there is nothing left to
657
# A revision that is not part of the ancestry of our
660
yield (rev_id, merge_depth, revno, end_of_merge)
499
662
def leave_lock_in_place(self):
500
663
"""Tell this branch object not to release the physical lock when this
501
664
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
1046
:return: A tuple (revno, revision_id).
789
1048
if self._last_revision_info_cache is None:
790
self._last_revision_info_cache = self._last_revision_info()
1049
self._last_revision_info_cache = self._read_last_revision_info()
791
1050
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,
840
def import_last_revision_info(self, source_repo, revno, revid):
1052
def _read_last_revision_info(self):
1053
raise NotImplementedError(self._read_last_revision_info)
1055
def import_last_revision_info_and_tags(self, source, revno, revid,
841
1057
"""Set the last revision info, importing from another repo if necessary.
843
1059
This is used by the bound branch code to upload a revision to
844
1060
the master branch first before updating the tip of the local branch.
1061
Revisions referenced by source's tags are also transferred.
846
:param source_repo: Source repository to optionally fetch from
1063
:param source: Source branch to optionally fetch from
847
1064
:param revno: Revision number of the new tip
848
1065
:param revid: Revision id of the new tip
1066
:param lossy: Whether to discard metadata that can not be
1067
natively represented
1068
:return: Tuple with the new revision number and revision id
1069
(should only be different from the arguments when lossy=True)
850
if not self.repository.has_same_location(source_repo):
851
self.repository.fetch(source_repo, revision_id=revid)
1071
if not self.repository.has_same_location(source.repository):
1072
self.fetch(source, revid)
852
1073
self.set_last_revision_info(revno, revid)
1074
return (revno, revid)
854
1076
def revision_id_to_revno(self, revision_id):
855
1077
"""Given a revision id, return its revno"""
856
1078
if _mod_revision.is_null(revision_id):
858
history = self.revision_history()
1080
history = self._revision_history()
860
1082
return history.index(revision_id) + 1
861
1083
except ValueError:
1177
1365
Callers will typically also want to check the repository.
1367
:param refs: Calculated refs for this branch as specified by
1368
branch._get_check_refs()
1179
1369
:return: A BranchCheckResult.
1181
ret = BranchCheckResult(self)
1182
mainline_parent_id = None
1371
result = BranchCheckResult(self)
1183
1372
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
1373
actual_revno = refs[('lefthand-distance', last_revision_id)]
1374
if actual_revno != last_revno:
1375
result.errors.append(errors.BzrCheckError(
1376
'revno does not match len(mainline) %s != %s' % (
1377
last_revno, actual_revno)))
1378
# TODO: We should probably also check that self.revision_history
1379
# matches the repository for older branch formats.
1380
# If looking for the code that cross-checks repository parents against
1381
# the Graph.iter_lefthand_ancestry output, that is now a repository
1216
def _get_checkout_format(self):
1385
def _get_checkout_format(self, lightweight=False):
1217
1386
"""Return the most suitable metadir for a checkout of this branch.
1218
1387
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)
1389
format = self.repository.bzrdir.checkout_metadir()
1390
format.set_branch_format(self._format)
1229
1393
def create_clone_on_transport(self, to_transport, revision_id=None,
1230
stacked_on=None, create_prefix=False, use_existing_dir=False):
1394
stacked_on=None, create_prefix=False, use_existing_dir=False,
1231
1396
"""Create a clone of this branch and its bzrdir.
1233
1398
:param to_transport: The transport to clone onto.
1378
1589
object will be created every time regardless.
1381
_default_format = None
1382
"""The default format used for new branches."""
1385
"""The known formats."""
1387
can_set_append_revisions_only = True
1389
1592
def __eq__(self, other):
1390
1593
return self.__class__ is other.__class__
1392
1595
def __ne__(self, other):
1393
1596
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')
1408
def get_default_format(klass):
1409
"""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.
1598
def get_reference(self, controldir, name=None):
1599
"""Get the target reference of the branch in controldir.
1415
1601
format probing must have been completed before calling
1416
1602
this method - it is assumed that the format of the branch
1417
in a_bzrdir is correct.
1603
in controldir is correct.
1419
:param a_bzrdir: The bzrdir to get the branch data from.
1605
:param controldir: The controldir to get the branch data from.
1606
:param name: Name of the colocated branch to fetch
1420
1607
: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.
1612
def set_reference(self, controldir, name, to_branch):
1613
"""Set the target reference of the branch in controldir.
1428
1615
format probing must have been completed before calling
1429
1616
this method - it is assumed that the format of the branch
1430
in a_bzrdir is correct.
1617
in controldir is correct.
1432
:param a_bzrdir: The bzrdir to set the branch reference for.
1619
:param controldir: The controldir to set the branch reference for.
1620
:param name: Name of colocated branch to set, None for default
1433
1621
:param to_branch: branch that the checkout is to reference
1435
1623
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
1625
def get_format_description(self):
1442
1626
"""Return the short format description for this format."""
1443
1627
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
1629
def _run_post_branch_init_hooks(self, controldir, name, branch):
1630
hooks = Branch.hooks['post_branch_init']
1633
params = BranchInitHookParams(self, controldir, name, branch)
1637
def initialize(self, controldir, name=None, repository=None,
1638
append_revisions_only=None):
1639
"""Create a branch of this format in controldir.
1641
: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
1643
raise NotImplementedError(self.initialize)
1491
1645
def is_supported(self):
1604
1778
"basis revision. hooks MUST NOT modify this delta. "
1605
1779
" future_tree is an in-memory tree obtained from "
1606
1780
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1607
"tree.", (0,91), None))
1608
self.create_hook(HookPoint('post_commit',
1782
self.add_hook('post_commit',
1609
1783
"Called in the bzr client after a commit has completed. "
1610
1784
"post_commit is called with (local, master, old_revno, old_revid, "
1611
1785
"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',
1786
"commit to a branch.", (0, 15))
1787
self.add_hook('post_uncommit',
1614
1788
"Called in the bzr client after an uncommit completes. "
1615
1789
"post_uncommit is called with (local, master, old_revno, "
1616
1790
"old_revid, new_revno, new_revid) where local is the local branch "
1617
1791
"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',
1792
"receives new_revno of 0, new_revid of None.", (0, 15))
1793
self.add_hook('pre_change_branch_tip',
1620
1794
"Called in bzr client and server before a change to the tip of a "
1621
1795
"branch is made. pre_change_branch_tip is called with a "
1622
1796
"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',
1797
"commit, uncommit will all trigger this hook.", (1, 6))
1798
self.add_hook('post_change_branch_tip',
1625
1799
"Called in bzr client and server after a change to the tip of a "
1626
1800
"branch is made. post_change_branch_tip is called with a "
1627
1801
"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',
1802
"commit, uncommit will all trigger this hook.", (1, 4))
1803
self.add_hook('transform_fallback_location',
1630
1804
"Called when a stacked branch is activating its fallback "
1631
1805
"locations. transform_fallback_location is called with (branch, "
1632
1806
"url), and should return a new url. Returning the same url "
1682
1873
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)
1876
class BranchInitHookParams(object):
1877
"""Object holding parameters passed to `*_branch_init` hooks.
1879
There are 4 fields that hooks may wish to access:
1881
:ivar format: the branch format
1882
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1883
:ivar name: name of colocated branch, if any (or None)
1884
:ivar branch: the branch created
1886
Note that for lightweight checkouts, the bzrdir and format fields refer to
1887
the checkout, hence they are different from the corresponding fields in
1888
branch, which refer to the original branch.
1891
def __init__(self, format, controldir, name, branch):
1892
"""Create a group of BranchInitHook parameters.
1894
:param format: the branch format
1895
:param controldir: the ControlDir where the branch will be/has been
1897
:param name: name of colocated branch, if any (or None)
1898
:param branch: the branch created
1900
Note that for lightweight checkouts, the bzrdir and format fields refer
1901
to the checkout, hence they are different from the corresponding fields
1902
in branch, which refer to the original branch.
1904
self.format = format
1905
self.bzrdir = controldir
1907
self.branch = branch
1909
def __eq__(self, other):
1910
return self.__dict__ == other.__dict__
1913
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1916
class SwitchHookParams(object):
1917
"""Object holding parameters passed to `*_switch` hooks.
1919
There are 4 fields that hooks may wish to access:
1921
:ivar control_dir: ControlDir of the checkout to change
1922
:ivar to_branch: branch that the checkout is to reference
1923
:ivar force: skip the check for local commits in a heavy checkout
1924
:ivar revision_id: revision ID to switch to (or None)
1927
def __init__(self, control_dir, to_branch, force, revision_id):
1928
"""Create a group of SwitchHook parameters.
1930
:param control_dir: ControlDir of the checkout to change
1931
:param to_branch: branch that the checkout is to reference
1932
:param force: skip the check for local commits in a heavy checkout
1933
:param revision_id: revision ID to switch to (or None)
1935
self.control_dir = control_dir
1936
self.to_branch = to_branch
1938
self.revision_id = revision_id
1940
def __eq__(self, other):
1941
return self.__dict__ == other.__dict__
1944
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1945
self.control_dir, self.to_branch,
1949
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
1950
"""Base class for branch formats that live in meta directories.
1705
1953
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."""
1954
BranchFormat.__init__(self)
1955
bzrdir.BzrFormat.__init__(self)
1958
def find_format(klass, controldir, name=None):
1959
"""Return the format for the branch object in controldir."""
1961
transport = controldir.get_branch_transport(None, name=name)
1962
except errors.NoSuchFile:
1963
raise errors.NotBranchError(path=name, bzrdir=controldir)
1965
format_string = transport.get_bytes("format")
1966
except errors.NoSuchFile:
1967
raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
1968
return klass._find_format(format_registry, 'branch', format_string)
1730
1970
def _branch_class(self):
1731
1971
"""What class to instantiate on open calls."""
1732
1972
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.
1974
def _get_initial_config(self, append_revisions_only=None):
1975
if append_revisions_only:
1976
return "append_revisions_only = True\n"
1978
# Avoid writing anything if append_revisions_only is disabled,
1979
# as that is the default.
1982
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1984
"""Initialize a branch in a control dir, with specified files
1986
:param a_bzrdir: The bzrdir to initialize the branch in
1987
:param utf8_files: The files to create as a list of
1988
(filename, content) tuples
1989
:param name: Name of colocated branch to create, if any
1990
:return: a branch in this format
1739
return self.get_format_string()
1993
name = a_bzrdir._get_selected_branch()
1994
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1995
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1996
control_files = lockable_files.LockableFiles(branch_transport,
1997
'lock', lockdir.LockDir)
1998
control_files.create_lock()
1999
control_files.lock_write()
2001
utf8_files += [('format', self.as_string())]
2002
for (filename, content) in utf8_files:
2003
branch_transport.put_bytes(
2005
mode=a_bzrdir._get_file_mode())
2007
control_files.unlock()
2008
branch = self.open(a_bzrdir, name, _found=True,
2009
found_repository=repository)
2010
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1741
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
2013
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2014
found_repository=None, possible_transports=None):
1742
2015
"""See BranchFormat.open()."""
2017
name = a_bzrdir._get_selected_branch()
1744
format = BranchFormat.find_format(a_bzrdir)
2019
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
1745
2020
if format.__class__ != self.__class__:
1746
2021
raise AssertionError("wrong format %r found for %r" %
1747
2022
(format, self))
2023
transport = a_bzrdir.get_branch_transport(None, name=name)
1749
transport = a_bzrdir.get_branch_transport(None)
1750
2025
control_files = lockable_files.LockableFiles(transport, 'lock',
1751
2026
lockdir.LockDir)
2027
if found_repository is None:
2028
found_repository = a_bzrdir.find_repository()
1752
2029
return self._branch_class()(_format=self,
1753
2030
_control_files=control_files,
1754
2032
a_bzrdir=a_bzrdir,
1755
_repository=a_bzrdir.find_repository(),
1756
ignore_fallbacks=ignore_fallbacks)
2033
_repository=found_repository,
2034
ignore_fallbacks=ignore_fallbacks,
2035
possible_transports=possible_transports)
1757
2036
except errors.NoSuchFile:
1758
raise errors.NotBranchError(path=transport.base)
1761
super(BranchFormatMetadir, self).__init__()
1762
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1763
self._matchingbzrdir.set_branch_format(self)
1765
def supports_tags(self):
1769
class BzrBranchFormat5(BranchFormatMetadir):
1770
"""Bzr branch format 5.
1773
- a revision-history file.
1775
- a lock dir guarding the branch itself
1776
- all of this stored in a branch/ subdirectory
1777
- works with shared repositories.
1779
This format is new in bzr 0.8.
1782
def _branch_class(self):
1785
def get_format_string(self):
1786
"""See BranchFormat.get_format_string()."""
1787
return "Bazaar-NG branch format 5\n"
1789
def get_format_description(self):
1790
"""See BranchFormat.get_format_description()."""
1791
return "Branch format 5"
1793
def initialize(self, a_bzrdir):
1794
"""Create a branch of this format in a_bzrdir."""
1795
utf8_files = [('revision-history', ''),
1796
('branch-name', ''),
1798
return self._initialize_helper(a_bzrdir, utf8_files)
1800
def supports_tags(self):
2037
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2040
def _matchingbzrdir(self):
2041
ret = bzrdir.BzrDirMetaFormat1()
2042
ret.set_branch_format(self)
2045
def supports_tags(self):
2048
def supports_leaving_lock(self):
2051
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
2053
BranchFormat.check_support_status(self,
2054
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
2056
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
2057
recommend_upgrade=recommend_upgrade, basedir=basedir)
1804
2060
class BzrBranchFormat6(BranchFormatMetadir):
1933
2201
"""See BranchFormat.get_format_description()."""
1934
2202
return "Checkout reference format 1"
1936
def get_reference(self, a_bzrdir):
2204
def get_reference(self, a_bzrdir, name=None):
1937
2205
"""See BranchFormat.get_reference()."""
1938
transport = a_bzrdir.get_branch_transport(None)
1939
return transport.get('location').read()
2206
transport = a_bzrdir.get_branch_transport(None, name=name)
2207
return transport.get_bytes('location')
1941
def set_reference(self, a_bzrdir, to_branch):
2209
def set_reference(self, a_bzrdir, name, to_branch):
1942
2210
"""See BranchFormat.set_reference()."""
1943
transport = a_bzrdir.get_branch_transport(None)
2211
transport = a_bzrdir.get_branch_transport(None, name=name)
1944
2212
location = transport.put_bytes('location', to_branch.base)
1946
def initialize(self, a_bzrdir, target_branch=None):
2214
def initialize(self, a_bzrdir, name=None, target_branch=None,
2215
repository=None, append_revisions_only=None):
1947
2216
"""Create a branch of this format in a_bzrdir."""
1948
2217
if target_branch is None:
1949
2218
# this format does not implement branch itself, thus the implicit
1950
2219
# creation contract must see it as uninitializable
1951
2220
raise errors.UninitializableFormat(self)
1952
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1953
branch_transport = a_bzrdir.get_branch_transport(self)
2221
mutter('creating branch reference in %s', a_bzrdir.user_url)
2222
if a_bzrdir._format.fixed_components:
2223
raise errors.IncompatibleFormat(self, a_bzrdir._format)
2225
name = a_bzrdir._get_selected_branch()
2226
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1954
2227
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,
2228
target_branch.user_url)
2229
branch_transport.put_bytes('format', self.as_string())
2230
branch = self.open(a_bzrdir, name, _found=True,
1959
2231
possible_transports=[target_branch.bzrdir.root_transport])
1962
super(BranchReferenceFormat, self).__init__()
1963
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1964
self._matchingbzrdir.set_branch_format(self)
2232
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1966
2235
def _make_reference_clone_function(format, a_branch):
1967
2236
"""Create a clone() routine for a branch dynamically."""
1968
2237
def clone(to_bzrdir, revision_id=None,
1969
2238
repository_policy=None):
1970
2239
"""See Branch.clone()."""
1971
return format.initialize(to_bzrdir, a_branch)
2240
return format.initialize(to_bzrdir, target_branch=a_branch)
1972
2241
# cannot obey revision_id limits when cloning a reference ...
1973
2242
# FIXME RBC 20060210 either nuke revision_id for clone, or
1974
2243
# 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):
2246
def open(self, a_bzrdir, name=None, _found=False, location=None,
2247
possible_transports=None, ignore_fallbacks=False,
2248
found_repository=None):
1979
2249
"""Return the branch that the branch reference in a_bzrdir points at.
1981
2251
:param a_bzrdir: A BzrDir that contains a branch.
2252
:param name: Name of colocated branch to open, if any
1982
2253
:param _found: a private parameter, do not use it. It is used to
1983
2254
indicate if format probing has already be done.
1984
2255
:param ignore_fallbacks: when set, no fallback branches will be opened
2083
2393
base = property(_get_base, doc="The URL for the root of this branch.")
2396
def user_transport(self):
2397
return self._user_transport
2085
2399
def _get_config(self):
2086
return TransportConfig(self._transport, 'branch.conf')
2400
return _mod_config.TransportConfig(self._transport, 'branch.conf')
2402
def _get_config_store(self):
2403
if self.conf_store is None:
2404
self.conf_store = _mod_config.BranchStore(self)
2405
return self.conf_store
2407
def _uncommitted_branch(self):
2408
"""Return the branch that may contain uncommitted changes."""
2409
master = self.get_master_branch()
2410
if master is not None:
2415
def store_uncommitted(self, creator):
2416
"""Store uncommitted changes from a ShelfCreator.
2418
:param creator: The ShelfCreator containing uncommitted changes, or
2419
None to delete any stored changes.
2420
:raises: ChangesAlreadyStored if the branch already has changes.
2422
branch = self._uncommitted_branch()
2424
branch._transport.delete('stored-transform')
2426
if branch._transport.has('stored-transform'):
2427
raise errors.ChangesAlreadyStored
2428
transform = StringIO()
2429
creator.write_shelf(transform)
2431
branch._transport.put_file('stored-transform', transform)
2433
def get_unshelver(self, tree):
2434
"""Return a shelf.Unshelver for this branch and tree.
2436
:param tree: The tree to use to construct the Unshelver.
2437
:return: an Unshelver or None if no changes are stored.
2439
branch = self._uncommitted_branch()
2441
transform = branch._transport.get('stored-transform')
2442
except errors.NoSuchFile:
2444
return shelf.Unshelver.from_tree_and_shelf(tree, transform)
2088
2446
def is_locked(self):
2089
2447
return self.control_files.is_locked()
2091
2449
def lock_write(self, token=None):
2092
# All-in-one needs to always unlock/lock.
2093
repo_control = getattr(self.repository, 'control_files', None)
2094
if self.control_files == repo_control or not self.is_locked():
2450
"""Lock the branch for write operations.
2452
:param token: A token to permit reacquiring a previously held and
2454
:return: A BranchWriteLockResult.
2456
if not self.is_locked():
2457
self._note_lock('w')
2458
self.repository._warn_if_deprecated(self)
2095
2459
self.repository.lock_write()
2096
2460
took_lock = True
2098
2462
took_lock = False
2100
return self.control_files.lock_write(token=token)
2464
return BranchWriteLockResult(self.unlock,
2465
self.control_files.lock_write(token=token))
2103
2468
self.repository.unlock()
2106
2471
def lock_read(self):
2107
# All-in-one needs to always unlock/lock.
2108
repo_control = getattr(self.repository, 'control_files', None)
2109
if self.control_files == repo_control or not self.is_locked():
2472
"""Lock the branch for read operations.
2474
:return: A bzrlib.lock.LogicalLockResult.
2476
if not self.is_locked():
2477
self._note_lock('r')
2478
self.repository._warn_if_deprecated(self)
2110
2479
self.repository.lock_read()
2111
2480
took_lock = True
2113
2482
took_lock = False
2115
2484
self.control_files.lock_read()
2485
return LogicalLockResult(self.unlock)
2118
2488
self.repository.unlock()
2491
@only_raises(errors.LockNotHeld, errors.LockBroken)
2121
2492
def unlock(self):
2493
if self.control_files._lock_count == 1 and self.conf_store is not None:
2494
self.conf_store.save_changes()
2123
2496
self.control_files.unlock()
2125
# All-in-one needs to always unlock/lock.
2126
repo_control = getattr(self.repository, 'control_files', None)
2127
if (self.control_files == repo_control or
2128
not self.control_files.is_locked()):
2129
self.repository.unlock()
2130
2498
if not self.control_files.is_locked():
2499
self.repository.unlock()
2131
2500
# we just released the lock
2132
2501
self._clear_cached_state()
2145
2514
"""See Branch.print_file."""
2146
2515
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
2517
@needs_write_lock
2212
2518
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
2519
if not revision_id or not isinstance(revision_id, basestring):
2520
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2223
2521
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))
2522
old_revno, old_revid = self.last_revision_info()
2523
if self.get_append_revisions_only():
2524
self._check_history_violation(revision_id)
2525
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2526
self._write_last_revision_info(revno, revision_id)
2527
self._clear_cached_state()
2528
self._last_revision_info_cache = revno, revision_id
2529
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2253
2531
def basis_tree(self):
2254
2532
"""See Branch.basis_tree."""
2432
2715
self._last_revision_info_cache = None
2433
2716
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
2718
def _check_history_violation(self, revision_id):
2481
last_revision = _mod_revision.ensure_null(self.last_revision())
2719
current_revid = self.last_revision()
2720
last_revision = _mod_revision.ensure_null(current_revid)
2482
2721
if _mod_revision.is_null(last_revision):
2484
if last_revision not in self._lefthand_history(revision_id):
2485
raise errors.AppendRevisionsOnlyViolation(self.base)
2723
graph = self.repository.get_graph()
2724
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2725
if lh_ancestor == current_revid:
2727
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2487
2729
def _gen_revision_history(self):
2488
2730
"""Generate the revision history from last revision
2941
3143
raise NotImplementedError(self.push)
3146
def copy_content_into(self, revision_id=None):
3147
"""Copy the content of source into target
3149
revision_id: if not None, the revision history in the new branch will
3150
be truncated to end with revision_id.
3152
raise NotImplementedError(self.copy_content_into)
3155
def fetch(self, stop_revision=None, limit=None):
3158
:param stop_revision: Last revision to fetch
3159
:param limit: Optional rough limit of revisions to fetch
3161
raise NotImplementedError(self.fetch)
3164
def _fix_overwrite_type(overwrite):
3165
if isinstance(overwrite, bool):
3167
return ["history", "tags"]
2944
3173
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()."""
3174
"""InterBranch implementation that uses public Branch functions."""
3177
def is_compatible(klass, source, target):
3178
# GenericBranch uses the public API, so always compatible
3182
def _get_branch_formats_to_test(klass):
3183
return [(format_registry.get_default(), format_registry.get_default())]
3186
def unwrap_format(klass, format):
3187
if isinstance(format, remote.RemoteBranchFormat):
3188
format._ensure_real()
3189
return format._custom_format
3193
def copy_content_into(self, revision_id=None):
3194
"""Copy the content of source into target
3196
revision_id: if not None, the revision history in the new branch will
3197
be truncated to end with revision_id.
3199
self.source.update_references(self.target)
3200
self.source._synchronize_history(self.target, revision_id)
3202
parent = self.source.get_parent()
3203
except errors.InaccessibleParent, e:
3204
mutter('parent was not accessible to copy: %s', e)
3207
self.target.set_parent(parent)
3208
if self.source._push_should_merge_tags():
3209
self.source.tags.merge_to(self.target.tags)
3212
def fetch(self, stop_revision=None, limit=None):
3213
if self.target.base == self.source.base:
2955
3215
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)
3217
fetch_spec_factory = fetch.FetchSpecFactory()
3218
fetch_spec_factory.source_branch = self.source
3219
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3220
fetch_spec_factory.source_repo = self.source.repository
3221
fetch_spec_factory.target_repo = self.target.repository
3222
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3223
fetch_spec_factory.limit = limit
3224
fetch_spec = fetch_spec_factory.make_fetch_spec()
3225
return self.target.repository.fetch(self.source.repository,
3226
fetch_spec=fetch_spec)
2993
3228
self.source.unlock()
3231
def _update_revisions(self, stop_revision=None, overwrite=False,
3233
other_revno, other_last_revision = self.source.last_revision_info()
3234
stop_revno = None # unknown
3235
if stop_revision is None:
3236
stop_revision = other_last_revision
3237
if _mod_revision.is_null(stop_revision):
3238
# if there are no commits, we're done.
3240
stop_revno = other_revno
3242
# what's the current last revision, before we fetch [and change it
3244
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3245
# we fetch here so that we don't process data twice in the common
3246
# case of having something to pull, and so that the check for
3247
# already merged can operate on the just fetched graph, which will
3248
# be cached in memory.
3249
self.fetch(stop_revision=stop_revision)
3250
# Check to see if one is an ancestor of the other
3253
graph = self.target.repository.get_graph()
3254
if self.target._check_if_descendant_or_diverged(
3255
stop_revision, last_rev, graph, self.source):
3256
# stop_revision is a descendant of last_rev, but we aren't
3257
# overwriting, so we're done.
3259
if stop_revno is None:
3261
graph = self.target.repository.get_graph()
3262
this_revno, this_last_revision = \
3263
self.target.last_revision_info()
3264
stop_revno = graph.find_distance_to_null(stop_revision,
3265
[(other_last_revision, other_revno),
3266
(this_last_revision, this_revno)])
3267
self.target.set_last_revision_info(stop_revno, stop_revision)
2995
3270
def pull(self, overwrite=False, stop_revision=None,
3271
possible_transports=None, run_hooks=True,
3272
_override_hook_target=None, local=False):
3273
"""Pull from source into self, updating my master if any.
3275
:param run_hooks: Private parameter - if false, this branch
3276
is being called because it's the master of the primary branch,
3277
so it should not run its hooks.
3279
bound_location = self.target.get_bound_location()
3280
if local and not bound_location:
3281
raise errors.LocalRequiresBoundBranch()
3282
master_branch = None
3283
source_is_master = False
3285
# bound_location comes from a config file, some care has to be
3286
# taken to relate it to source.user_url
3287
normalized = urlutils.normalize_url(bound_location)
3289
relpath = self.source.user_transport.relpath(normalized)
3290
source_is_master = (relpath == '')
3291
except (errors.PathNotChild, errors.InvalidURL):
3292
source_is_master = False
3293
if not local and bound_location and not source_is_master:
3294
# not pulling from master, so we need to update master.
3295
master_branch = self.target.get_master_branch(possible_transports)
3296
master_branch.lock_write()
3299
# pull from source into master.
3300
master_branch.pull(self.source, overwrite, stop_revision,
3302
return self._pull(overwrite,
3303
stop_revision, _hook_master=master_branch,
3304
run_hooks=run_hooks,
3305
_override_hook_target=_override_hook_target,
3306
merge_tags_to_master=not source_is_master)
3309
master_branch.unlock()
3311
def push(self, overwrite=False, stop_revision=None, lossy=False,
3312
_override_hook_source_branch=None):
3313
"""See InterBranch.push.
3315
This is the basic concrete implementation of push()
3317
:param _override_hook_source_branch: If specified, run the hooks
3318
passing this Branch as the source, rather than self. This is for
3319
use of RemoteBranch, where push is delegated to the underlying
3323
raise errors.LossyPushToSameVCS(self.source, self.target)
3324
# TODO: Public option to disable running hooks - should be trivial but
3327
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3328
op.add_cleanup(self.source.lock_read().unlock)
3329
op.add_cleanup(self.target.lock_write().unlock)
3330
return op.run(overwrite, stop_revision,
3331
_override_hook_source_branch=_override_hook_source_branch)
3333
def _basic_push(self, overwrite, stop_revision):
3334
"""Basic implementation of push without bound branches or hooks.
3336
Must be called with source read locked and target write locked.
3338
result = BranchPushResult()
3339
result.source_branch = self.source
3340
result.target_branch = self.target
3341
result.old_revno, result.old_revid = self.target.last_revision_info()
3342
self.source.update_references(self.target)
3343
overwrite = _fix_overwrite_type(overwrite)
3344
if result.old_revid != stop_revision:
3345
# We assume that during 'push' this repository is closer than
3347
graph = self.source.repository.get_graph(self.target.repository)
3348
self._update_revisions(stop_revision,
3349
overwrite=("history" in overwrite),
3351
if self.source._push_should_merge_tags():
3352
result.tag_updates, result.tag_conflicts = (
3353
self.source.tags.merge_to(
3354
self.target.tags, "tags" in overwrite))
3355
result.new_revno, result.new_revid = self.target.last_revision_info()
3358
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3359
_override_hook_source_branch=None):
3360
"""Push from source into target, and into target's master if any.
3363
if _override_hook_source_branch:
3364
result.source_branch = _override_hook_source_branch
3365
for hook in Branch.hooks['post_push']:
3368
bound_location = self.target.get_bound_location()
3369
if bound_location and self.target.base != bound_location:
3370
# there is a master branch.
3372
# XXX: Why the second check? Is it even supported for a branch to
3373
# be bound to itself? -- mbp 20070507
3374
master_branch = self.target.get_master_branch()
3375
master_branch.lock_write()
3376
operation.add_cleanup(master_branch.unlock)
3377
# push into the master from the source branch.
3378
master_inter = InterBranch.get(self.source, master_branch)
3379
master_inter._basic_push(overwrite, stop_revision)
3380
# and push into the target branch from the source. Note that
3381
# we push from the source branch again, because it's considered
3382
# the highest bandwidth repository.
3383
result = self._basic_push(overwrite, stop_revision)
3384
result.master_branch = master_branch
3385
result.local_branch = self.target
3387
master_branch = None
3389
result = self._basic_push(overwrite, stop_revision)
3390
# TODO: Why set master_branch and local_branch if there's no
3391
# binding? Maybe cleaner to just leave them unset? -- mbp
3393
result.master_branch = self.target
3394
result.local_branch = None
3398
def _pull(self, overwrite=False, stop_revision=None,
2996
3399
possible_transports=None, _hook_master=None, run_hooks=True,
2997
_override_hook_target=None, local=False):
3400
_override_hook_target=None, local=False,
3401
merge_tags_to_master=True):
2998
3402
"""See Branch.pull.
3404
This function is the core worker, used by GenericInterBranch.pull to
3405
avoid duplication when pulling source->master and source->local.
3000
3407
:param _hook_master: Private parameter - set the branch to
3001
3408
be supplied as the master to pull hooks.
3002
3409
:param run_hooks: Private parameter - if false, this branch
3003
3410
is being called because it's the master of the primary branch,
3004
3411
so it should not run its hooks.
3412
is being called because it's the master of the primary branch,
3413
so it should not run its hooks.
3005
3414
:param _override_hook_target: Private parameter - set the branch to be
3006
3415
supplied as the target_branch to pull hooks.
3007
3416
:param local: Only update the local branch, and not the bound branch.
3047
3460
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
3464
InterBranch.register_optimiser(GenericInterBranch)
3161
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
