126
123
raise errors.UnstackableRepositoryFormat(self.repository._format,
127
124
self.repository.base)
129
def _extend_partial_history(self, stop_index=None, stop_revision=None):
130
"""Extend the partial history to include a given index
132
If a stop_index is supplied, stop when that index has been reached.
133
If a stop_revision is supplied, stop when that revision is
134
encountered. Otherwise, stop when the beginning of history is
137
:param stop_index: The index which should be present. When it is
138
present, history extension will stop.
139
:param stop_revision: The revision id which should be present. When
140
it is encountered, history extension will stop.
142
if len(self._partial_revision_history_cache) == 0:
143
self._partial_revision_history_cache = [self.last_revision()]
144
repository._iter_for_revno(
145
self.repository, self._partial_revision_history_cache,
146
stop_index=stop_index, stop_revision=stop_revision)
147
if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
148
self._partial_revision_history_cache.pop()
150
def _get_check_refs(self):
151
"""Get the references needed for check().
155
revid = self.last_revision()
156
return [('revision-existence', revid), ('lefthand-distance', revid)]
159
127
def open(base, _unsupported=False, possible_transports=None):
160
128
"""Open the branch rooted at base.
456
412
# start_revision_id.
457
413
if self._merge_sorted_revisions_cache is None:
458
414
last_revision = self.last_revision()
459
known_graph = self.repository.get_known_graph_ancestry(
461
self._merge_sorted_revisions_cache = known_graph.merge_sort(
415
graph = self.repository.get_graph()
416
parent_map = dict(((key, value) for key, value in
417
graph.iter_ancestry([last_revision]) if value is not None))
418
revision_graph = repository._strip_NULL_ghosts(parent_map)
419
revs = tsort.merge_sort(revision_graph, last_revision, None,
421
# Drop the sequence # before caching
422
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
463
424
filtered = self._filter_merge_sorted_revisions(
464
425
self._merge_sorted_revisions_cache, start_revision_id,
465
426
stop_revision_id, stop_rule)
466
# Make sure we don't return revisions that are not part of the
467
# start_revision_id ancestry.
468
filtered = self._filter_start_non_ancestors(filtered)
469
427
if direction == 'reverse':
471
429
if direction == 'forward':
478
436
"""Iterate over an inclusive range of sorted revisions."""
479
437
rev_iter = iter(merge_sorted_revisions)
480
438
if start_revision_id is not None:
481
for node in rev_iter:
482
rev_id = node.key[-1]
439
for rev_id, depth, revno, end_of_merge in rev_iter:
483
440
if rev_id != start_revision_id:
486
443
# The decision to include the start or not
487
444
# depends on the stop_rule if a stop is provided
488
# so pop this node back into the iterator
489
rev_iter = chain(iter([node]), rev_iter)
446
iter([(rev_id, depth, revno, end_of_merge)]),
491
449
if stop_revision_id is None:
493
for node in rev_iter:
494
rev_id = node.key[-1]
495
yield (rev_id, node.merge_depth, node.revno,
450
for rev_id, depth, revno, end_of_merge in rev_iter:
451
yield rev_id, depth, revno, end_of_merge
497
452
elif stop_rule == 'exclude':
498
for node in rev_iter:
499
rev_id = node.key[-1]
453
for rev_id, depth, revno, end_of_merge in rev_iter:
500
454
if rev_id == stop_revision_id:
502
yield (rev_id, node.merge_depth, node.revno,
456
yield rev_id, depth, revno, end_of_merge
504
457
elif stop_rule == 'include':
505
for node in rev_iter:
506
rev_id = node.key[-1]
507
yield (rev_id, node.merge_depth, node.revno,
458
for rev_id, depth, revno, end_of_merge in rev_iter:
459
yield rev_id, depth, revno, end_of_merge
509
460
if rev_id == stop_revision_id:
511
elif stop_rule == 'with-merges-without-common-ancestry':
512
# We want to exclude all revisions that are already part of the
513
# stop_revision_id ancestry.
514
graph = self.repository.get_graph()
515
ancestors = graph.find_unique_ancestors(start_revision_id,
517
for node in rev_iter:
518
rev_id = node.key[-1]
519
if rev_id not in ancestors:
521
yield (rev_id, node.merge_depth, node.revno,
523
462
elif stop_rule == 'with-merges':
524
463
stop_rev = self.repository.get_revision(stop_revision_id)
525
464
if stop_rev.parent_ids:
526
465
left_parent = stop_rev.parent_ids[0]
528
467
left_parent = _mod_revision.NULL_REVISION
529
# left_parent is the actual revision we want to stop logging at,
530
# since we want to show the merged revisions after the stop_rev too
531
reached_stop_revision_id = False
532
revision_id_whitelist = []
533
for node in rev_iter:
534
rev_id = node.key[-1]
468
for rev_id, depth, revno, end_of_merge in rev_iter:
535
469
if rev_id == left_parent:
536
# reached the left parent after the stop_revision
538
if (not reached_stop_revision_id or
539
rev_id in revision_id_whitelist):
540
yield (rev_id, node.merge_depth, node.revno,
542
if reached_stop_revision_id or rev_id == stop_revision_id:
543
# only do the merged revs of rev_id from now on
544
rev = self.repository.get_revision(rev_id)
546
reached_stop_revision_id = True
547
revision_id_whitelist.extend(rev.parent_ids)
471
yield rev_id, depth, revno, end_of_merge
549
473
raise ValueError('invalid stop_rule %r' % stop_rule)
551
def _filter_start_non_ancestors(self, rev_iter):
552
# If we started from a dotted revno, we want to consider it as a tip
553
# and don't want to yield revisions that are not part of its
554
# ancestry. Given the order guaranteed by the merge sort, we will see
555
# uninteresting descendants of the first parent of our tip before the
557
first = rev_iter.next()
558
(rev_id, merge_depth, revno, end_of_merge) = first
561
# We start at a mainline revision so by definition, all others
562
# revisions in rev_iter are ancestors
563
for node in rev_iter:
568
pmap = self.repository.get_parent_map([rev_id])
569
parents = pmap.get(rev_id, [])
571
whitelist.update(parents)
573
# If there is no parents, there is nothing of interest left
575
# FIXME: It's hard to test this scenario here as this code is never
576
# called in that case. -- vila 20100322
579
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
581
if rev_id in whitelist:
582
pmap = self.repository.get_parent_map([rev_id])
583
parents = pmap.get(rev_id, [])
584
whitelist.remove(rev_id)
585
whitelist.update(parents)
587
# We've reached the mainline, there is nothing left to
591
# A revision that is not part of the ancestry of our
594
yield (rev_id, merge_depth, revno, end_of_merge)
596
475
def leave_lock_in_place(self):
597
476
"""Tell this branch object not to release the physical lock when this
598
477
object is unlocked.
768
607
except (errors.NotStacked, errors.UnstackableBranchFormat,
769
608
errors.UnstackableRepositoryFormat):
611
# repositories don't offer an interface to remove fallback
612
# repositories today; take the conceptually simpler option and just
614
self.repository = self.bzrdir.find_repository()
615
# for every revision reference the branch has, ensure it is pulled
617
source_repository = self._get_fallback_repository(old_url)
618
for revision_id in chain([self.last_revision()],
619
self.tags.get_reverse_tag_dict()):
620
self.repository.fetch(source_repository, revision_id,
773
623
self._activate_fallback_location(url)
774
624
# write this out after the repository is stacked to avoid setting a
775
625
# stacked config that doesn't work.
776
626
self._set_config_location('stacked_on_location', url)
779
"""Change a branch to be unstacked, copying data as needed.
781
Don't call this directly, use set_stacked_on_url(None).
783
pb = ui.ui_factory.nested_progress_bar()
785
pb.update("Unstacking")
786
# The basic approach here is to fetch the tip of the branch,
787
# including all available ghosts, from the existing stacked
788
# repository into a new repository object without the fallbacks.
790
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
791
# correct for CHKMap repostiories
792
old_repository = self.repository
793
if len(old_repository._fallback_repositories) != 1:
794
raise AssertionError("can't cope with fallback repositories "
795
"of %r" % (self.repository,))
796
# unlock it, including unlocking the fallback
797
old_repository.unlock()
798
old_repository.lock_read()
800
# Repositories don't offer an interface to remove fallback
801
# repositories today; take the conceptually simpler option and just
802
# reopen it. We reopen it starting from the URL so that we
803
# get a separate connection for RemoteRepositories and can
804
# stream from one of them to the other. This does mean doing
805
# separate SSH connection setup, but unstacking is not a
806
# common operation so it's tolerable.
807
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
808
new_repository = new_bzrdir.find_repository()
809
self.repository = new_repository
810
if self.repository._fallback_repositories:
811
raise AssertionError("didn't expect %r to have "
812
"fallback_repositories"
813
% (self.repository,))
814
# this is not paired with an unlock because it's just restoring
815
# the previous state; the lock's released when set_stacked_on_url
817
self.repository.lock_write()
818
# XXX: If you unstack a branch while it has a working tree
819
# with a pending merge, the pending-merged revisions will no
820
# longer be present. You can (probably) revert and remerge.
822
# XXX: This only fetches up to the tip of the repository; it
823
# doesn't bring across any tags. That's fairly consistent
824
# with how branch works, but perhaps not ideal.
825
self.repository.fetch(old_repository,
826
revision_id=self.last_revision(),
829
old_repository.unlock()
833
629
def _set_tags_bytes(self, bytes):
834
630
"""Mirror method for _get_tags_bytes.
1001
799
except ValueError:
1002
800
raise errors.NoSuchRevision(self, revision_id)
1005
802
def get_rev_id(self, revno, history=None):
1006
803
"""Find the revision id of the specified revno."""
1008
805
return _mod_revision.NULL_REVISION
1009
last_revno, last_revid = self.last_revision_info()
1010
if revno == last_revno:
1012
if revno <= 0 or revno > last_revno:
807
history = self.revision_history()
808
if revno <= 0 or revno > len(history):
1013
809
raise errors.NoSuchRevision(self, revno)
1014
distance_from_last = last_revno - revno
1015
if len(self._partial_revision_history_cache) <= distance_from_last:
1016
self._extend_partial_history(distance_from_last)
1017
return self._partial_revision_history_cache[distance_from_last]
810
return history[revno - 1]
1020
812
def pull(self, source, overwrite=False, stop_revision=None,
1021
possible_transports=None, *args, **kwargs):
813
possible_transports=None, _override_hook_target=None):
1022
814
"""Mirror source into this branch.
1024
816
This branch is considered to be 'local', having low latency.
1026
818
:returns: PullResult instance
1028
return InterBranch.get(source, self).pull(overwrite=overwrite,
1029
stop_revision=stop_revision,
1030
possible_transports=possible_transports, *args, **kwargs)
820
raise NotImplementedError(self.pull)
1032
def push(self, target, overwrite=False, stop_revision=None, *args,
822
def push(self, target, overwrite=False, stop_revision=None):
1034
823
"""Mirror this branch into target.
1036
825
This branch is considered to be 'local', having low latency.
1038
return InterBranch.get(self, target).push(overwrite, stop_revision,
1041
def lossy_push(self, target, stop_revision=None):
1042
"""Push deltas into another branch.
1044
:note: This does not, like push, retain the revision ids from
1045
the source branch and will, rather than adding bzr-specific
1046
metadata, push only those semantics of the revision that can be
1047
natively represented by this branch' VCS.
1049
:param target: Target branch
1050
:param stop_revision: Revision to push, defaults to last revision.
1051
:return: BranchPushResult with an extra member revidmap:
1052
A dictionary mapping revision ids from the target branch
1053
to new revision ids in the target branch, for each
1054
revision that was pushed.
1056
inter = InterBranch.get(self, target)
1057
lossy_push = getattr(inter, "lossy_push", None)
1058
if lossy_push is None:
1059
raise errors.LossyPushToSameVCS(self, target)
1060
return lossy_push(stop_revision)
827
raise NotImplementedError(self.push)
1062
829
def basis_tree(self):
1063
830
"""Return `Tree` object for last revision."""
1255
1018
source_revno, source_revision_id = self.last_revision_info()
1256
1019
if revision_id is None:
1257
1020
revno, revision_id = source_revno, source_revision_id
1021
elif source_revision_id == revision_id:
1022
# we know the revno without needing to walk all of history
1023
revno = source_revno
1259
graph = self.repository.get_graph()
1261
revno = graph.find_distance_to_null(revision_id,
1262
[(source_revision_id, source_revno)])
1263
except errors.GhostRevisionsHaveNoRevno:
1264
# Default to 1, if we can't find anything else
1025
# To figure out the revno for a random revision, we need to build
1026
# the revision history, and count its length.
1027
# We don't care about the order, just how long it is.
1028
# Alternatively, we could start at the current location, and count
1029
# backwards. But there is no guarantee that we will find it since
1030
# it may be a merged revision.
1031
revno = len(list(self.repository.iter_reverse_revision_history(
1266
1033
destination.set_last_revision_info(revno, revision_id)
1268
1035
@needs_read_lock
1312
1061
Callers will typically also want to check the repository.
1314
:param refs: Calculated refs for this branch as specified by
1315
branch._get_check_refs()
1316
1063
:return: A BranchCheckResult.
1318
result = BranchCheckResult(self)
1065
mainline_parent_id = None
1319
1066
last_revno, last_revision_id = self.last_revision_info()
1320
actual_revno = refs[('lefthand-distance', last_revision_id)]
1321
if actual_revno != last_revno:
1322
result.errors.append(errors.BzrCheckError(
1323
'revno does not match len(mainline) %s != %s' % (
1324
last_revno, actual_revno)))
1325
# TODO: We should probably also check that self.revision_history
1326
# matches the repository for older branch formats.
1327
# If looking for the code that cross-checks repository parents against
1328
# the iter_reverse_revision_history output, that is now a repository
1067
real_rev_history = list(self.repository.iter_reverse_revision_history(
1069
real_rev_history.reverse()
1070
if len(real_rev_history) != last_revno:
1071
raise errors.BzrCheckError('revno does not match len(mainline)'
1072
' %s != %s' % (last_revno, len(real_rev_history)))
1073
# TODO: We should probably also check that real_rev_history actually
1074
# matches self.revision_history()
1075
for revision_id in real_rev_history:
1077
revision = self.repository.get_revision(revision_id)
1078
except errors.NoSuchRevision, e:
1079
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1081
# In general the first entry on the revision history has no parents.
1082
# But it's not illegal for it to have parents listed; this can happen
1083
# in imports from Arch when the parents weren't reachable.
1084
if mainline_parent_id is not None:
1085
if mainline_parent_id not in revision.parent_ids:
1086
raise errors.BzrCheckError("previous revision {%s} not listed among "
1088
% (mainline_parent_id, revision_id))
1089
mainline_parent_id = revision_id
1090
return BranchCheckResult(self)
1332
1092
def _get_checkout_format(self):
1333
1093
"""Return the most suitable metadir for a checkout of this branch.
1345
1105
def create_clone_on_transport(self, to_transport, revision_id=None,
1346
stacked_on=None, create_prefix=False, use_existing_dir=False):
1347
1107
"""Create a clone of this branch and its bzrdir.
1349
1109
:param to_transport: The transport to clone onto.
1350
1110
:param revision_id: The revision id to use as tip in the new branch.
1351
1111
If None the tip is obtained from this branch.
1352
1112
:param stacked_on: An optional URL to stack the clone on.
1353
:param create_prefix: Create any missing directories leading up to
1355
:param use_existing_dir: Use an existing directory if one exists.
1357
1114
# XXX: Fix the bzrdir API to allow getting the branch back from the
1358
1115
# clone call. Or something. 20090224 RBC/spiv.
1359
# XXX: Should this perhaps clone colocated branches as well,
1360
# rather than just the default branch? 20100319 JRV
1361
if revision_id is None:
1362
revision_id = self.last_revision()
1363
1116
dir_to = self.bzrdir.clone_on_transport(to_transport,
1364
revision_id=revision_id, stacked_on=stacked_on,
1365
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1117
revision_id=revision_id, stacked_on=stacked_on)
1366
1118
return dir_to.open_branch()
1368
1120
def create_checkout(self, to_location, revision_id=None,
1423
1174
reconciler.reconcile()
1424
1175
return reconciler
1426
def reference_parent(self, file_id, path, possible_transports=None):
1177
def reference_parent(self, file_id, path):
1427
1178
"""Return the parent branch for a tree-reference file_id
1428
1179
:param file_id: The file_id of the tree reference
1429
1180
:param path: The path of the file_id in the tree
1430
1181
:return: A branch associated with the file_id
1432
1183
# FIXME should provide multiple branches, based on config
1433
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1434
possible_transports=possible_transports)
1184
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1436
1186
def supports_tags(self):
1437
1187
return self._format.supports_tags()
1439
def automatic_tag_name(self, revision_id):
1440
"""Try to automatically find the tag name for a revision.
1442
:param revision_id: Revision id of the revision.
1443
:return: A tag name or None if no tag name could be determined.
1445
for hook in Branch.hooks['automatic_tag_name']:
1446
ret = hook(self, revision_id)
1451
1189
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1453
1191
"""Ensure that revision_b is a descendant of revision_a.
1568
1302
"""Return the short format description for this format."""
1569
1303
raise NotImplementedError(self.get_format_description)
1571
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1572
hooks = Branch.hooks['post_branch_init']
1575
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1579
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1580
lock_type='metadir', set_format=True):
1305
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1581
1307
"""Initialize a branch in a bzrdir, with specified files
1583
1309
:param a_bzrdir: The bzrdir to initialize the branch in
1584
1310
:param utf8_files: The files to create as a list of
1585
1311
(filename, content) tuples
1586
:param name: Name of colocated branch to create, if any
1587
1312
:param set_format: If True, set the format with
1588
1313
self.get_format_string. (BzrBranch4 has its format set
1590
1315
:return: a branch in this format
1592
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1593
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1317
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1318
branch_transport = a_bzrdir.get_branch_transport(self)
1595
1320
'metadir': ('lock', lockdir.LockDir),
1596
1321
'branch4': ('branch-lock', lockable_files.TransportLock),
1779
1486
"multiple hooks installed for transform_fallback_location, "
1780
1487
"all are called with the url returned from the previous hook."
1781
1488
"The order is however undefined.", (1, 9), None))
1782
self.create_hook(HookPoint('automatic_tag_name',
1783
"Called to determine an automatic tag name for a revision."
1784
"automatic_tag_name is called with (branch, revision_id) and "
1785
"should return a tag name or None if no tag name could be "
1786
"determined. The first non-None tag name returned will be used.",
1788
self.create_hook(HookPoint('post_branch_init',
1789
"Called after new branch initialization completes. "
1790
"post_branch_init is called with a "
1791
"bzrlib.branch.BranchInitHookParams. "
1792
"Note that init, branch and checkout (both heavyweight and "
1793
"lightweight) will all trigger this hook.", (2, 2), None))
1794
self.create_hook(HookPoint('post_switch',
1795
"Called after a checkout switches branch. "
1796
"post_switch is called with a "
1797
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1801
1491
# install the default hooks into the Branch class.
1840
1530
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1843
class BranchInitHookParams(object):
1844
"""Object holding parameters passed to *_branch_init hooks.
1846
There are 4 fields that hooks may wish to access:
1848
:ivar format: the branch format
1849
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1850
:ivar name: name of colocated branch, if any (or None)
1851
:ivar branch: the branch created
1853
Note that for lightweight checkouts, the bzrdir and format fields refer to
1854
the checkout, hence they are different from the corresponding fields in
1855
branch, which refer to the original branch.
1858
def __init__(self, format, a_bzrdir, name, branch):
1859
"""Create a group of BranchInitHook parameters.
1861
:param format: the branch format
1862
:param a_bzrdir: the BzrDir where the branch will be/has been
1864
:param name: name of colocated branch, if any (or None)
1865
:param branch: the branch created
1867
Note that for lightweight checkouts, the bzrdir and format fields refer
1868
to the checkout, hence they are different from the corresponding fields
1869
in branch, which refer to the original branch.
1871
self.format = format
1872
self.bzrdir = a_bzrdir
1874
self.branch = branch
1876
def __eq__(self, other):
1877
return self.__dict__ == other.__dict__
1881
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1883
return "<%s of format:%s bzrdir:%s>" % (
1884
self.__class__.__name__, self.branch,
1885
self.format, self.bzrdir)
1888
class SwitchHookParams(object):
1889
"""Object holding parameters passed to *_switch hooks.
1891
There are 4 fields that hooks may wish to access:
1893
:ivar control_dir: BzrDir of the checkout to change
1894
:ivar to_branch: branch that the checkout is to reference
1895
:ivar force: skip the check for local commits in a heavy checkout
1896
:ivar revision_id: revision ID to switch to (or None)
1899
def __init__(self, control_dir, to_branch, force, revision_id):
1900
"""Create a group of SwitchHook parameters.
1902
:param control_dir: BzrDir of the checkout to change
1903
:param to_branch: branch that the checkout is to reference
1904
:param force: skip the check for local commits in a heavy checkout
1905
:param revision_id: revision ID to switch to (or None)
1907
self.control_dir = control_dir
1908
self.to_branch = to_branch
1910
self.revision_id = revision_id
1912
def __eq__(self, other):
1913
return self.__dict__ == other.__dict__
1916
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1917
self.control_dir, self.to_branch,
1921
1533
class BzrBranchFormat4(BranchFormat):
1922
1534
"""Bzr branch format 4.
1976
1587
return self.get_format_string()
1978
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1589
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1979
1590
"""See BranchFormat.open()."""
1981
format = BranchFormat.find_format(a_bzrdir, name=name)
1592
format = BranchFormat.find_format(a_bzrdir)
1982
1593
if format.__class__ != self.__class__:
1983
1594
raise AssertionError("wrong format %r found for %r" %
1984
1595
(format, self))
1985
transport = a_bzrdir.get_branch_transport(None, name=name)
1597
transport = a_bzrdir.get_branch_transport(None)
1987
1598
control_files = lockable_files.LockableFiles(transport, 'lock',
1988
1599
lockdir.LockDir)
1989
1600
return self._branch_class()(_format=self,
1990
1601
_control_files=control_files,
1992
1602
a_bzrdir=a_bzrdir,
1993
1603
_repository=a_bzrdir.find_repository(),
1994
1604
ignore_fallbacks=ignore_fallbacks)
1995
1605
except errors.NoSuchFile:
1996
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1606
raise errors.NotBranchError(path=transport.base)
1998
1608
def __init__(self):
1999
1609
super(BranchFormatMetadir, self).__init__()
2061
1671
"""See BranchFormat.get_format_description()."""
2062
1672
return "Branch format 6"
2064
def initialize(self, a_bzrdir, name=None):
2065
"""Create a branch of this format in a_bzrdir."""
2066
utf8_files = [('last-revision', '0 null:\n'),
2067
('branch.conf', ''),
2070
return self._initialize_helper(a_bzrdir, utf8_files, name)
2072
def make_tags(self, branch):
2073
"""See bzrlib.branch.BranchFormat.make_tags()."""
2074
return BasicTags(branch)
2076
def supports_set_append_revisions_only(self):
2080
class BzrBranchFormat8(BranchFormatMetadir):
2081
"""Metadir format supporting storing locations of subtree branches."""
2083
def _branch_class(self):
2086
def get_format_string(self):
2087
"""See BranchFormat.get_format_string()."""
2088
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2090
def get_format_description(self):
2091
"""See BranchFormat.get_format_description()."""
2092
return "Branch format 8"
2094
def initialize(self, a_bzrdir, name=None):
2095
"""Create a branch of this format in a_bzrdir."""
2096
utf8_files = [('last-revision', '0 null:\n'),
2097
('branch.conf', ''),
2101
return self._initialize_helper(a_bzrdir, utf8_files, name)
2104
super(BzrBranchFormat8, self).__init__()
2105
self._matchingbzrdir.repository_format = \
2106
RepositoryFormatKnitPack5RichRoot()
2108
def make_tags(self, branch):
2109
"""See bzrlib.branch.BranchFormat.make_tags()."""
2110
return BasicTags(branch)
2112
def supports_set_append_revisions_only(self):
2115
def supports_stacking(self):
2118
supports_reference_locations = True
2121
class BzrBranchFormat7(BzrBranchFormat8):
1674
def initialize(self, a_bzrdir):
1675
"""Create a branch of this format in a_bzrdir."""
1676
utf8_files = [('last-revision', '0 null:\n'),
1677
('branch.conf', ''),
1680
return self._initialize_helper(a_bzrdir, utf8_files)
1682
def make_tags(self, branch):
1683
"""See bzrlib.branch.BranchFormat.make_tags()."""
1684
return BasicTags(branch)
1688
class BzrBranchFormat7(BranchFormatMetadir):
2122
1689
"""Branch format with last-revision, tags, and a stacked location pointer.
2124
1691
The stacked location pointer is passed down to the repository and requires
2171
1745
"""See BranchFormat.get_format_description()."""
2172
1746
return "Checkout reference format 1"
2174
def get_reference(self, a_bzrdir, name=None):
1748
def get_reference(self, a_bzrdir):
2175
1749
"""See BranchFormat.get_reference()."""
2176
transport = a_bzrdir.get_branch_transport(None, name=name)
2177
return transport.get_bytes('location')
1750
transport = a_bzrdir.get_branch_transport(None)
1751
return transport.get('location').read()
2179
def set_reference(self, a_bzrdir, name, to_branch):
1753
def set_reference(self, a_bzrdir, to_branch):
2180
1754
"""See BranchFormat.set_reference()."""
2181
transport = a_bzrdir.get_branch_transport(None, name=name)
1755
transport = a_bzrdir.get_branch_transport(None)
2182
1756
location = transport.put_bytes('location', to_branch.base)
2184
def initialize(self, a_bzrdir, name=None, target_branch=None):
1758
def initialize(self, a_bzrdir, target_branch=None):
2185
1759
"""Create a branch of this format in a_bzrdir."""
2186
1760
if target_branch is None:
2187
1761
# this format does not implement branch itself, thus the implicit
2188
1762
# creation contract must see it as uninitializable
2189
1763
raise errors.UninitializableFormat(self)
2190
mutter('creating branch reference in %s', a_bzrdir.user_url)
2191
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1764
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1765
branch_transport = a_bzrdir.get_branch_transport(self)
2192
1766
branch_transport.put_bytes('location',
2193
target_branch.bzrdir.user_url)
1767
target_branch.bzrdir.root_transport.base)
2194
1768
branch_transport.put_bytes('format', self.get_format_string())
2196
a_bzrdir, name, _found=True,
1770
a_bzrdir, _found=True,
2197
1771
possible_transports=[target_branch.bzrdir.root_transport])
2198
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2201
1773
def __init__(self):
2202
1774
super(BranchReferenceFormat, self).__init__()
2208
1780
def clone(to_bzrdir, revision_id=None,
2209
1781
repository_policy=None):
2210
1782
"""See Branch.clone()."""
2211
return format.initialize(to_bzrdir, target_branch=a_branch)
1783
return format.initialize(to_bzrdir, a_branch)
2212
1784
# cannot obey revision_id limits when cloning a reference ...
2213
1785
# FIXME RBC 20060210 either nuke revision_id for clone, or
2214
1786
# emit some sort of warning/error to the caller ?!
2217
def open(self, a_bzrdir, name=None, _found=False, location=None,
1789
def open(self, a_bzrdir, _found=False, location=None,
2218
1790
possible_transports=None, ignore_fallbacks=False):
2219
1791
"""Return the branch that the branch reference in a_bzrdir points at.
2221
1793
:param a_bzrdir: A BzrDir that contains a branch.
2222
:param name: Name of colocated branch to open, if any
2223
1794
:param _found: a private parameter, do not use it. It is used to
2224
1795
indicate if format probing has already be done.
2225
1796
:param ignore_fallbacks: when set, no fallback branches will be opened
2266
1836
__format5 = BzrBranchFormat5()
2267
1837
__format6 = BzrBranchFormat6()
2268
1838
__format7 = BzrBranchFormat7()
2269
__format8 = BzrBranchFormat8()
2270
1839
BranchFormat.register_format(__format5)
2271
1840
BranchFormat.register_format(BranchReferenceFormat())
2272
1841
BranchFormat.register_format(__format6)
2273
1842
BranchFormat.register_format(__format7)
2274
BranchFormat.register_format(__format8)
2275
BranchFormat.set_default_format(__format7)
1843
BranchFormat.set_default_format(__format6)
2276
1844
_legacy_formats = [BzrBranchFormat4(),
2278
1846
network_format_registry.register(
2279
1847
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2282
class BranchWriteLockResult(LogicalLockResult):
2283
"""The result of write locking a branch.
2285
:ivar branch_token: The token obtained from the underlying branch lock, or
2287
:ivar unlock: A callable which will unlock the lock.
2290
def __init__(self, unlock, branch_token):
2291
LogicalLockResult.__init__(self, unlock)
2292
self.branch_token = branch_token
2295
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2299
class BzrBranch(Branch, _RelockDebugMixin):
1850
class BzrBranch(Branch):
2300
1851
"""A branch stored in the actual filesystem.
2302
1853
Note that it's "local" in the context of the filesystem; it doesn't
2355
1899
return self.control_files.is_locked()
2357
1901
def lock_write(self, token=None):
2358
"""Lock the branch for write operations.
2360
:param token: A token to permit reacquiring a previously held and
2362
:return: A BranchWriteLockResult.
2364
if not self.is_locked():
2365
self._note_lock('w')
2366
# All-in-one needs to always unlock/lock.
2367
repo_control = getattr(self.repository, 'control_files', None)
2368
if self.control_files == repo_control or not self.is_locked():
2369
self.repository._warn_if_deprecated(self)
2370
self.repository.lock_write()
1902
repo_token = self.repository.lock_write()
2375
return BranchWriteLockResult(self.unlock,
2376
self.control_files.lock_write(token=token))
1904
token = self.control_files.lock_write(token=token)
2379
self.repository.unlock()
1906
self.repository.unlock()
2382
1910
def lock_read(self):
2383
"""Lock the branch for read operations.
2385
:return: A bzrlib.lock.LogicalLockResult.
2387
if not self.is_locked():
2388
self._note_lock('r')
2389
# All-in-one needs to always unlock/lock.
2390
repo_control = getattr(self.repository, 'control_files', None)
2391
if self.control_files == repo_control or not self.is_locked():
2392
self.repository._warn_if_deprecated(self)
2393
self.repository.lock_read()
1911
self.repository.lock_read()
2398
1913
self.control_files.lock_read()
2399
return LogicalLockResult(self.unlock)
2402
self.repository.unlock()
1915
self.repository.unlock()
2405
@only_raises(errors.LockNotHeld, errors.LockBroken)
2406
1918
def unlock(self):
1919
# TODO: test for failed two phase locks. This is known broken.
2408
1921
self.control_files.unlock()
2410
# All-in-one needs to always unlock/lock.
2411
repo_control = getattr(self.repository, 'control_files', None)
2412
if (self.control_files == repo_control or
2413
not self.control_files.is_locked()):
2414
self.repository.unlock()
2415
if not self.control_files.is_locked():
2416
# we just released the lock
2417
self._clear_cached_state()
1923
self.repository.unlock()
1924
if not self.control_files.is_locked():
1925
# we just released the lock
1926
self._clear_cached_state()
2419
1928
def peek_lock_mode(self):
2420
1929
if self.control_files._lock_count == 0:
2539
2048
"""See Branch.basis_tree."""
2540
2049
return self.repository.revision_tree(self.last_revision())
2052
def pull(self, source, overwrite=False, stop_revision=None,
2053
_hook_master=None, run_hooks=True, possible_transports=None,
2054
_override_hook_target=None):
2057
:param _hook_master: Private parameter - set the branch to
2058
be supplied as the master to pull hooks.
2059
:param run_hooks: Private parameter - if false, this branch
2060
is being called because it's the master of the primary branch,
2061
so it should not run its hooks.
2062
:param _override_hook_target: Private parameter - set the branch to be
2063
supplied as the target_branch to pull hooks.
2065
result = PullResult()
2066
result.source_branch = source
2067
if _override_hook_target is None:
2068
result.target_branch = self
2070
result.target_branch = _override_hook_target
2073
# We assume that during 'pull' the local repository is closer than
2075
graph = self.repository.get_graph(source.repository)
2076
result.old_revno, result.old_revid = self.last_revision_info()
2077
self.update_revisions(source, stop_revision, overwrite=overwrite,
2079
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
2080
result.new_revno, result.new_revid = self.last_revision_info()
2082
result.master_branch = _hook_master
2083
result.local_branch = result.target_branch
2085
result.master_branch = result.target_branch
2086
result.local_branch = None
2088
for hook in Branch.hooks['post_pull']:
2542
2094
def _get_parent_location(self):
2543
2095
_locs = ['parent', 'pull', 'x-pull']
2544
2096
for l in _locs:
2104
def push(self, target, overwrite=False, stop_revision=None,
2105
_override_hook_source_branch=None):
2108
This is the basic concrete implementation of push()
2110
:param _override_hook_source_branch: If specified, run
2111
the hooks passing this Branch as the source, rather than self.
2112
This is for use of RemoteBranch, where push is delegated to the
2113
underlying vfs-based Branch.
2115
# TODO: Public option to disable running hooks - should be trivial but
2117
return _run_with_write_locked_target(
2118
target, self._push_with_bound_branches, target, overwrite,
2120
_override_hook_source_branch=_override_hook_source_branch)
2122
def _push_with_bound_branches(self, target, overwrite,
2124
_override_hook_source_branch=None):
2125
"""Push from self into target, and into target's master if any.
2127
This is on the base BzrBranch class even though it doesn't support
2128
bound branches because the *target* might be bound.
2131
if _override_hook_source_branch:
2132
result.source_branch = _override_hook_source_branch
2133
for hook in Branch.hooks['post_push']:
2136
bound_location = target.get_bound_location()
2137
if bound_location and target.base != bound_location:
2138
# there is a master branch.
2140
# XXX: Why the second check? Is it even supported for a branch to
2141
# be bound to itself? -- mbp 20070507
2142
master_branch = target.get_master_branch()
2143
master_branch.lock_write()
2145
# push into the master from this branch.
2146
self._basic_push(master_branch, overwrite, stop_revision)
2147
# and push into the target branch from this. Note that we push from
2148
# this branch again, because its considered the highest bandwidth
2150
result = self._basic_push(target, overwrite, stop_revision)
2151
result.master_branch = master_branch
2152
result.local_branch = target
2156
master_branch.unlock()
2159
result = self._basic_push(target, overwrite, stop_revision)
2160
# TODO: Why set master_branch and local_branch if there's no
2161
# binding? Maybe cleaner to just leave them unset? -- mbp
2163
result.master_branch = target
2164
result.local_branch = None
2551
2168
def _basic_push(self, target, overwrite, stop_revision):
2552
2169
"""Basic implementation of push without bound branches or hooks.
2554
Must be called with source read locked and target write locked.
2171
Must be called with self read locked and target write locked.
2556
2173
result = BranchPushResult()
2557
2174
result.source_branch = self
2558
2175
result.target_branch = target
2559
2176
result.old_revno, result.old_revid = target.last_revision_info()
2560
self.update_references(target)
2561
2177
if result.old_revid != self.last_revision():
2562
2178
# We assume that during 'push' this repository is closer than
2564
2180
graph = self.repository.get_graph(target.repository)
2565
target.update_revisions(self, stop_revision,
2566
overwrite=overwrite, graph=graph)
2181
target.update_revisions(self, stop_revision, overwrite=overwrite,
2567
2183
if self._push_should_merge_tags():
2568
result.tag_conflicts = self.tags.merge_to(target.tags,
2184
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2570
2185
result.new_revno, result.new_revid = target.last_revision_info()
2573
2188
def get_stacked_on_url(self):
2574
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2189
raise errors.UnstackableBranchFormat(self._format, self.base)
2576
2191
def set_push_location(self, location):
2577
2192
"""See Branch.set_push_location."""
2593
2226
It has support for a master_branch which is the data for bound branches.
2230
def pull(self, source, overwrite=False, stop_revision=None,
2231
run_hooks=True, possible_transports=None,
2232
_override_hook_target=None):
2233
"""Pull from source into self, updating my master if any.
2235
:param run_hooks: Private parameter - if false, this branch
2236
is being called because it's the master of the primary branch,
2237
so it should not run its hooks.
2239
bound_location = self.get_bound_location()
2240
master_branch = None
2241
if bound_location and source.base != bound_location:
2242
# not pulling from master, so we need to update master.
2243
master_branch = self.get_master_branch(possible_transports)
2244
master_branch.lock_write()
2247
# pull from source into master.
2248
master_branch.pull(source, overwrite, stop_revision,
2250
return super(BzrBranch5, self).pull(source, overwrite,
2251
stop_revision, _hook_master=master_branch,
2252
run_hooks=run_hooks,
2253
_override_hook_target=_override_hook_target)
2256
master_branch.unlock()
2596
2258
def get_bound_location(self):
2598
2260
return self._transport.get_bytes('bound')[:-1]
2776
2438
self._extend_partial_history(stop_index=last_revno-1)
2777
2439
return list(reversed(self._partial_revision_history_cache))
2441
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2442
"""Extend the partial history to include a given index
2444
If a stop_index is supplied, stop when that index has been reached.
2445
If a stop_revision is supplied, stop when that revision is
2446
encountered. Otherwise, stop when the beginning of history is
2449
:param stop_index: The index which should be present. When it is
2450
present, history extension will stop.
2451
:param revision_id: The revision id which should be present. When
2452
it is encountered, history extension will stop.
2454
repo = self.repository
2455
if len(self._partial_revision_history_cache) == 0:
2456
iterator = repo.iter_reverse_revision_history(self.last_revision())
2458
start_revision = self._partial_revision_history_cache[-1]
2459
iterator = repo.iter_reverse_revision_history(start_revision)
2460
#skip the last revision in the list
2461
next_revision = iterator.next()
2462
for revision_id in iterator:
2463
self._partial_revision_history_cache.append(revision_id)
2464
if (stop_index is not None and
2465
len(self._partial_revision_history_cache) > stop_index):
2467
if revision_id == stop_revision:
2779
2470
def _write_revision_history(self, history):
2780
2471
"""Factored out of set_revision_history.
2802
2493
"""Set the parent branch"""
2803
2494
return self._get_config_location('parent_location')
2806
def _set_all_reference_info(self, info_dict):
2807
"""Replace all reference info stored in a branch.
2809
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2812
writer = rio.RioWriter(s)
2813
for key, (tree_path, branch_location) in info_dict.iteritems():
2814
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2815
branch_location=branch_location)
2816
writer.write_stanza(stanza)
2817
self._transport.put_bytes('references', s.getvalue())
2818
self._reference_info = info_dict
2821
def _get_all_reference_info(self):
2822
"""Return all the reference info stored in a branch.
2824
:return: A dict of {file_id: (tree_path, branch_location)}
2826
if self._reference_info is not None:
2827
return self._reference_info
2828
rio_file = self._transport.get('references')
2830
stanzas = rio.read_stanzas(rio_file)
2831
info_dict = dict((s['file_id'], (s['tree_path'],
2832
s['branch_location'])) for s in stanzas)
2835
self._reference_info = info_dict
2838
def set_reference_info(self, file_id, tree_path, branch_location):
2839
"""Set the branch location to use for a tree reference.
2841
:param file_id: The file-id of the tree reference.
2842
:param tree_path: The path of the tree reference in the tree.
2843
:param branch_location: The location of the branch to retrieve tree
2846
info_dict = self._get_all_reference_info()
2847
info_dict[file_id] = (tree_path, branch_location)
2848
if None in (tree_path, branch_location):
2849
if tree_path is not None:
2850
raise ValueError('tree_path must be None when branch_location'
2852
if branch_location is not None:
2853
raise ValueError('branch_location must be None when tree_path'
2855
del info_dict[file_id]
2856
self._set_all_reference_info(info_dict)
2858
def get_reference_info(self, file_id):
2859
"""Get the tree_path and branch_location for a tree reference.
2861
:return: a tuple of (tree_path, branch_location)
2863
return self._get_all_reference_info().get(file_id, (None, None))
2865
def reference_parent(self, file_id, path, possible_transports=None):
2866
"""Return the parent branch for a tree-reference file_id.
2868
:param file_id: The file_id of the tree reference
2869
:param path: The path of the file_id in the tree
2870
:return: A branch associated with the file_id
2872
branch_location = self.get_reference_info(file_id)[1]
2873
if branch_location is None:
2874
return Branch.reference_parent(self, file_id, path,
2875
possible_transports)
2876
branch_location = urlutils.join(self.user_url, branch_location)
2877
return Branch.open(branch_location,
2878
possible_transports=possible_transports)
2880
2496
def set_push_location(self, location):
2881
2497
"""See Branch.set_push_location."""
2882
2498
self._set_config_location('push_location', location)
3277
2858
self.source.unlock()
3279
def pull(self, overwrite=False, stop_revision=None,
3280
possible_transports=None, _hook_master=None, run_hooks=True,
3281
_override_hook_target=None, local=False):
3284
:param _hook_master: Private parameter - set the branch to
3285
be supplied as the master to pull hooks.
3286
:param run_hooks: Private parameter - if false, this branch
3287
is being called because it's the master of the primary branch,
3288
so it should not run its hooks.
3289
:param _override_hook_target: Private parameter - set the branch to be
3290
supplied as the target_branch to pull hooks.
3291
:param local: Only update the local branch, and not the bound branch.
3293
# This type of branch can't be bound.
3295
raise errors.LocalRequiresBoundBranch()
3296
result = PullResult()
3297
result.source_branch = self.source
3298
if _override_hook_target is None:
3299
result.target_branch = self.target
3301
result.target_branch = _override_hook_target
3302
self.source.lock_read()
3304
# We assume that during 'pull' the target repository is closer than
3306
self.source.update_references(self.target)
3307
graph = self.target.repository.get_graph(self.source.repository)
3308
# TODO: Branch formats should have a flag that indicates
3309
# that revno's are expensive, and pull() should honor that flag.
3311
result.old_revno, result.old_revid = \
3312
self.target.last_revision_info()
3313
self.target.update_revisions(self.source, stop_revision,
3314
overwrite=overwrite, graph=graph)
3315
# TODO: The old revid should be specified when merging tags,
3316
# so a tags implementation that versions tags can only
3317
# pull in the most recent changes. -- JRV20090506
3318
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3320
result.new_revno, result.new_revid = self.target.last_revision_info()
3322
result.master_branch = _hook_master
3323
result.local_branch = result.target_branch
3325
result.master_branch = result.target_branch
3326
result.local_branch = None
3328
for hook in Branch.hooks['post_pull']:
3331
self.source.unlock()
3334
def push(self, overwrite=False, stop_revision=None,
3335
_override_hook_source_branch=None):
3336
"""See InterBranch.push.
3338
This is the basic concrete implementation of push()
3340
:param _override_hook_source_branch: If specified, run
3341
the hooks passing this Branch as the source, rather than self.
3342
This is for use of RemoteBranch, where push is delegated to the
3343
underlying vfs-based Branch.
3345
# TODO: Public option to disable running hooks - should be trivial but
3347
self.source.lock_read()
3349
return _run_with_write_locked_target(
3350
self.target, self._push_with_bound_branches, overwrite,
3352
_override_hook_source_branch=_override_hook_source_branch)
3354
self.source.unlock()
3356
def _push_with_bound_branches(self, overwrite, stop_revision,
3357
_override_hook_source_branch=None):
3358
"""Push from source into target, and into target's master if any.
3361
if _override_hook_source_branch:
3362
result.source_branch = _override_hook_source_branch
3363
for hook in Branch.hooks['post_push']:
3366
bound_location = self.target.get_bound_location()
3367
if bound_location and self.target.base != bound_location:
3368
# there is a master branch.
3370
# XXX: Why the second check? Is it even supported for a branch to
3371
# be bound to itself? -- mbp 20070507
3372
master_branch = self.target.get_master_branch()
3373
master_branch.lock_write()
3375
# push into the master from the source branch.
3376
self.source._basic_push(master_branch, overwrite, stop_revision)
3377
# and push into the target branch from the source. Note that we
3378
# push from the source branch again, because its considered the
3379
# highest bandwidth repository.
3380
result = self.source._basic_push(self.target, overwrite,
3382
result.master_branch = master_branch
3383
result.local_branch = self.target
3387
master_branch.unlock()
3390
result = self.source._basic_push(self.target, overwrite,
3392
# TODO: Why set master_branch and local_branch if there's no
3393
# binding? Maybe cleaner to just leave them unset? -- mbp
3395
result.master_branch = self.target
3396
result.local_branch = None
3401
2861
def is_compatible(self, source, target):
3402
2862
# GenericBranch uses the public API, so always compatible
3406
class InterToBranch5(GenericInterBranch):
3409
def _get_branch_formats_to_test():
3410
return BranchFormat._default_format, BzrBranchFormat5()
3412
def pull(self, overwrite=False, stop_revision=None,
3413
possible_transports=None, run_hooks=True,
3414
_override_hook_target=None, local=False):
3415
"""Pull from source into self, updating my master if any.
3417
:param run_hooks: Private parameter - if false, this branch
3418
is being called because it's the master of the primary branch,
3419
so it should not run its hooks.
3421
bound_location = self.target.get_bound_location()
3422
if local and not bound_location:
3423
raise errors.LocalRequiresBoundBranch()
3424
master_branch = None
3425
if not local and bound_location and self.source.user_url != bound_location:
3426
# not pulling from master, so we need to update master.
3427
master_branch = self.target.get_master_branch(possible_transports)
3428
master_branch.lock_write()
3431
# pull from source into master.
3432
master_branch.pull(self.source, overwrite, stop_revision,
3434
return super(InterToBranch5, self).pull(overwrite,
3435
stop_revision, _hook_master=master_branch,
3436
run_hooks=run_hooks,
3437
_override_hook_target=_override_hook_target)
3440
master_branch.unlock()
3443
2866
InterBranch.register_optimiser(GenericInterBranch)
3444
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
