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.
457
412
# start_revision_id.
458
413
if self._merge_sorted_revisions_cache is None:
459
414
last_revision = self.last_revision()
460
known_graph = self.repository.get_known_graph_ancestry(
462
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]
464
424
filtered = self._filter_merge_sorted_revisions(
465
425
self._merge_sorted_revisions_cache, start_revision_id,
466
426
stop_revision_id, stop_rule)
467
# Make sure we don't return revisions that are not part of the
468
# start_revision_id ancestry.
469
filtered = self._filter_start_non_ancestors(filtered)
470
427
if direction == 'reverse':
472
429
if direction == 'forward':
479
436
"""Iterate over an inclusive range of sorted revisions."""
480
437
rev_iter = iter(merge_sorted_revisions)
481
438
if start_revision_id is not None:
482
for node in rev_iter:
483
rev_id = node.key[-1]
439
for rev_id, depth, revno, end_of_merge in rev_iter:
484
440
if rev_id != start_revision_id:
487
443
# The decision to include the start or not
488
444
# depends on the stop_rule if a stop is provided
489
# so pop this node back into the iterator
490
rev_iter = chain(iter([node]), rev_iter)
446
iter([(rev_id, depth, revno, end_of_merge)]),
492
449
if stop_revision_id is None:
494
for node in rev_iter:
495
rev_id = node.key[-1]
496
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
498
452
elif stop_rule == 'exclude':
499
for node in rev_iter:
500
rev_id = node.key[-1]
453
for rev_id, depth, revno, end_of_merge in rev_iter:
501
454
if rev_id == stop_revision_id:
503
yield (rev_id, node.merge_depth, node.revno,
456
yield rev_id, depth, revno, end_of_merge
505
457
elif stop_rule == 'include':
506
for node in rev_iter:
507
rev_id = node.key[-1]
508
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
510
460
if rev_id == stop_revision_id:
512
elif stop_rule == 'with-merges-without-common-ancestry':
513
# We want to exclude all revisions that are already part of the
514
# stop_revision_id ancestry.
515
graph = self.repository.get_graph()
516
ancestors = graph.find_unique_ancestors(start_revision_id,
518
for node in rev_iter:
519
rev_id = node.key[-1]
520
if rev_id not in ancestors:
522
yield (rev_id, node.merge_depth, node.revno,
524
462
elif stop_rule == 'with-merges':
525
463
stop_rev = self.repository.get_revision(stop_revision_id)
526
464
if stop_rev.parent_ids:
527
465
left_parent = stop_rev.parent_ids[0]
529
467
left_parent = _mod_revision.NULL_REVISION
530
# left_parent is the actual revision we want to stop logging at,
531
# since we want to show the merged revisions after the stop_rev too
532
reached_stop_revision_id = False
533
revision_id_whitelist = []
534
for node in rev_iter:
535
rev_id = node.key[-1]
468
for rev_id, depth, revno, end_of_merge in rev_iter:
536
469
if rev_id == left_parent:
537
# reached the left parent after the stop_revision
539
if (not reached_stop_revision_id or
540
rev_id in revision_id_whitelist):
541
yield (rev_id, node.merge_depth, node.revno,
543
if reached_stop_revision_id or rev_id == stop_revision_id:
544
# only do the merged revs of rev_id from now on
545
rev = self.repository.get_revision(rev_id)
547
reached_stop_revision_id = True
548
revision_id_whitelist.extend(rev.parent_ids)
471
yield rev_id, depth, revno, end_of_merge
550
473
raise ValueError('invalid stop_rule %r' % stop_rule)
552
def _filter_start_non_ancestors(self, rev_iter):
553
# If we started from a dotted revno, we want to consider it as a tip
554
# and don't want to yield revisions that are not part of its
555
# ancestry. Given the order guaranteed by the merge sort, we will see
556
# uninteresting descendants of the first parent of our tip before the
558
first = rev_iter.next()
559
(rev_id, merge_depth, revno, end_of_merge) = first
562
# We start at a mainline revision so by definition, all others
563
# revisions in rev_iter are ancestors
564
for node in rev_iter:
569
pmap = self.repository.get_parent_map([rev_id])
570
parents = pmap.get(rev_id, [])
572
whitelist.update(parents)
574
# If there is no parents, there is nothing of interest left
576
# FIXME: It's hard to test this scenario here as this code is never
577
# called in that case. -- vila 20100322
580
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
582
if rev_id in whitelist:
583
pmap = self.repository.get_parent_map([rev_id])
584
parents = pmap.get(rev_id, [])
585
whitelist.remove(rev_id)
586
whitelist.update(parents)
588
# We've reached the mainline, there is nothing left to
592
# A revision that is not part of the ancestry of our
595
yield (rev_id, merge_depth, revno, end_of_merge)
597
475
def leave_lock_in_place(self):
598
476
"""Tell this branch object not to release the physical lock when this
599
477
object is unlocked.
769
607
except (errors.NotStacked, errors.UnstackableBranchFormat,
770
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,
774
623
self._activate_fallback_location(url)
775
624
# write this out after the repository is stacked to avoid setting a
776
625
# stacked config that doesn't work.
777
626
self._set_config_location('stacked_on_location', url)
780
"""Change a branch to be unstacked, copying data as needed.
782
Don't call this directly, use set_stacked_on_url(None).
784
pb = ui.ui_factory.nested_progress_bar()
786
pb.update("Unstacking")
787
# The basic approach here is to fetch the tip of the branch,
788
# including all available ghosts, from the existing stacked
789
# repository into a new repository object without the fallbacks.
791
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
792
# correct for CHKMap repostiories
793
old_repository = self.repository
794
if len(old_repository._fallback_repositories) != 1:
795
raise AssertionError("can't cope with fallback repositories "
796
"of %r" % (self.repository,))
797
# unlock it, including unlocking the fallback
798
old_repository.unlock()
799
old_repository.lock_read()
801
# Repositories don't offer an interface to remove fallback
802
# repositories today; take the conceptually simpler option and just
803
# reopen it. We reopen it starting from the URL so that we
804
# get a separate connection for RemoteRepositories and can
805
# stream from one of them to the other. This does mean doing
806
# separate SSH connection setup, but unstacking is not a
807
# common operation so it's tolerable.
808
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
809
new_repository = new_bzrdir.find_repository()
810
self.repository = new_repository
811
if self.repository._fallback_repositories:
812
raise AssertionError("didn't expect %r to have "
813
"fallback_repositories"
814
% (self.repository,))
815
# this is not paired with an unlock because it's just restoring
816
# the previous state; the lock's released when set_stacked_on_url
818
self.repository.lock_write()
819
# XXX: If you unstack a branch while it has a working tree
820
# with a pending merge, the pending-merged revisions will no
821
# longer be present. You can (probably) revert and remerge.
823
# XXX: This only fetches up to the tip of the repository; it
824
# doesn't bring across any tags. That's fairly consistent
825
# with how branch works, but perhaps not ideal.
826
self.repository.fetch(old_repository,
827
revision_id=self.last_revision(),
830
old_repository.unlock()
834
629
def _set_tags_bytes(self, bytes):
835
630
"""Mirror method for _get_tags_bytes.
1002
799
except ValueError:
1003
800
raise errors.NoSuchRevision(self, revision_id)
1006
802
def get_rev_id(self, revno, history=None):
1007
803
"""Find the revision id of the specified revno."""
1009
805
return _mod_revision.NULL_REVISION
1010
last_revno, last_revid = self.last_revision_info()
1011
if revno == last_revno:
1013
if revno <= 0 or revno > last_revno:
807
history = self.revision_history()
808
if revno <= 0 or revno > len(history):
1014
809
raise errors.NoSuchRevision(self, revno)
1015
distance_from_last = last_revno - revno
1016
if len(self._partial_revision_history_cache) <= distance_from_last:
1017
self._extend_partial_history(distance_from_last)
1018
return self._partial_revision_history_cache[distance_from_last]
810
return history[revno - 1]
1021
812
def pull(self, source, overwrite=False, stop_revision=None,
1022
possible_transports=None, *args, **kwargs):
813
possible_transports=None, _override_hook_target=None):
1023
814
"""Mirror source into this branch.
1025
816
This branch is considered to be 'local', having low latency.
1027
818
:returns: PullResult instance
1029
return InterBranch.get(source, self).pull(overwrite=overwrite,
1030
stop_revision=stop_revision,
1031
possible_transports=possible_transports, *args, **kwargs)
820
raise NotImplementedError(self.pull)
1033
def push(self, target, overwrite=False, stop_revision=None, *args,
822
def push(self, target, overwrite=False, stop_revision=None):
1035
823
"""Mirror this branch into target.
1037
825
This branch is considered to be 'local', having low latency.
1039
return InterBranch.get(self, target).push(overwrite, stop_revision,
1042
def lossy_push(self, target, stop_revision=None):
1043
"""Push deltas into another branch.
1045
:note: This does not, like push, retain the revision ids from
1046
the source branch and will, rather than adding bzr-specific
1047
metadata, push only those semantics of the revision that can be
1048
natively represented by this branch' VCS.
1050
:param target: Target branch
1051
:param stop_revision: Revision to push, defaults to last revision.
1052
:return: BranchPushResult with an extra member revidmap:
1053
A dictionary mapping revision ids from the target branch
1054
to new revision ids in the target branch, for each
1055
revision that was pushed.
1057
inter = InterBranch.get(self, target)
1058
lossy_push = getattr(inter, "lossy_push", None)
1059
if lossy_push is None:
1060
raise errors.LossyPushToSameVCS(self, target)
1061
return lossy_push(stop_revision)
827
raise NotImplementedError(self.push)
1063
829
def basis_tree(self):
1064
830
"""Return `Tree` object for last revision."""
1256
1018
source_revno, source_revision_id = self.last_revision_info()
1257
1019
if revision_id is None:
1258
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
1260
graph = self.repository.get_graph()
1262
revno = graph.find_distance_to_null(revision_id,
1263
[(source_revision_id, source_revno)])
1264
except errors.GhostRevisionsHaveNoRevno:
1265
# 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(
1267
1033
destination.set_last_revision_info(revno, revision_id)
1269
1035
@needs_read_lock
1313
1061
Callers will typically also want to check the repository.
1315
:param refs: Calculated refs for this branch as specified by
1316
branch._get_check_refs()
1317
1063
:return: A BranchCheckResult.
1319
result = BranchCheckResult(self)
1065
mainline_parent_id = None
1320
1066
last_revno, last_revision_id = self.last_revision_info()
1321
actual_revno = refs[('lefthand-distance', last_revision_id)]
1322
if actual_revno != last_revno:
1323
result.errors.append(errors.BzrCheckError(
1324
'revno does not match len(mainline) %s != %s' % (
1325
last_revno, actual_revno)))
1326
# TODO: We should probably also check that self.revision_history
1327
# matches the repository for older branch formats.
1328
# If looking for the code that cross-checks repository parents against
1329
# 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)
1333
1092
def _get_checkout_format(self):
1334
1093
"""Return the most suitable metadir for a checkout of this branch.
1346
1105
def create_clone_on_transport(self, to_transport, revision_id=None,
1347
stacked_on=None, create_prefix=False, use_existing_dir=False):
1348
1107
"""Create a clone of this branch and its bzrdir.
1350
1109
:param to_transport: The transport to clone onto.
1351
1110
:param revision_id: The revision id to use as tip in the new branch.
1352
1111
If None the tip is obtained from this branch.
1353
1112
:param stacked_on: An optional URL to stack the clone on.
1354
:param create_prefix: Create any missing directories leading up to
1356
:param use_existing_dir: Use an existing directory if one exists.
1358
1114
# XXX: Fix the bzrdir API to allow getting the branch back from the
1359
1115
# clone call. Or something. 20090224 RBC/spiv.
1360
if revision_id is None:
1361
revision_id = self.last_revision()
1362
1116
dir_to = self.bzrdir.clone_on_transport(to_transport,
1363
revision_id=revision_id, stacked_on=stacked_on,
1364
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1117
revision_id=revision_id, stacked_on=stacked_on)
1365
1118
return dir_to.open_branch()
1367
1120
def create_checkout(self, to_location, revision_id=None,
1422
1174
reconciler.reconcile()
1423
1175
return reconciler
1425
def reference_parent(self, file_id, path, possible_transports=None):
1177
def reference_parent(self, file_id, path):
1426
1178
"""Return the parent branch for a tree-reference file_id
1427
1179
:param file_id: The file_id of the tree reference
1428
1180
:param path: The path of the file_id in the tree
1429
1181
:return: A branch associated with the file_id
1431
1183
# FIXME should provide multiple branches, based on config
1432
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1433
possible_transports=possible_transports)
1184
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1435
1186
def supports_tags(self):
1436
1187
return self._format.supports_tags()
1438
def automatic_tag_name(self, revision_id):
1439
"""Try to automatically find the tag name for a revision.
1441
:param revision_id: Revision id of the revision.
1442
:return: A tag name or None if no tag name could be determined.
1444
for hook in Branch.hooks['automatic_tag_name']:
1445
ret = hook(self, revision_id)
1450
1189
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1452
1191
"""Ensure that revision_b is a descendant of revision_a.
1565
1302
"""Return the short format description for this format."""
1566
1303
raise NotImplementedError(self.get_format_description)
1568
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1569
hooks = Branch.hooks['post_branch_init']
1572
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1576
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1577
lock_type='metadir', set_format=True):
1305
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1578
1307
"""Initialize a branch in a bzrdir, with specified files
1580
1309
:param a_bzrdir: The bzrdir to initialize the branch in
1581
1310
:param utf8_files: The files to create as a list of
1582
1311
(filename, content) tuples
1583
:param name: Name of colocated branch to create, if any
1584
1312
:param set_format: If True, set the format with
1585
1313
self.get_format_string. (BzrBranch4 has its format set
1587
1315
:return: a branch in this format
1589
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1590
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)
1592
1320
'metadir': ('lock', lockdir.LockDir),
1593
1321
'branch4': ('branch-lock', lockable_files.TransportLock),
1776
1486
"multiple hooks installed for transform_fallback_location, "
1777
1487
"all are called with the url returned from the previous hook."
1778
1488
"The order is however undefined.", (1, 9), None))
1779
self.create_hook(HookPoint('automatic_tag_name',
1780
"Called to determine an automatic tag name for a revision."
1781
"automatic_tag_name is called with (branch, revision_id) and "
1782
"should return a tag name or None if no tag name could be "
1783
"determined. The first non-None tag name returned will be used.",
1785
self.create_hook(HookPoint('post_branch_init',
1786
"Called after new branch initialization completes. "
1787
"post_branch_init is called with a "
1788
"bzrlib.branch.BranchInitHookParams. "
1789
"Note that init, branch and checkout (both heavyweight and "
1790
"lightweight) will all trigger this hook.", (2, 2), None))
1791
self.create_hook(HookPoint('post_switch',
1792
"Called after a checkout switches branch. "
1793
"post_switch is called with a "
1794
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1798
1491
# install the default hooks into the Branch class.
1837
1530
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1840
class BranchInitHookParams(object):
1841
"""Object holding parameters passed to *_branch_init hooks.
1843
There are 4 fields that hooks may wish to access:
1845
:ivar format: the branch format
1846
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1847
:ivar name: name of colocated branch, if any (or None)
1848
:ivar branch: the branch created
1850
Note that for lightweight checkouts, the bzrdir and format fields refer to
1851
the checkout, hence they are different from the corresponding fields in
1852
branch, which refer to the original branch.
1855
def __init__(self, format, a_bzrdir, name, branch):
1856
"""Create a group of BranchInitHook parameters.
1858
:param format: the branch format
1859
:param a_bzrdir: the BzrDir where the branch will be/has been
1861
:param name: name of colocated branch, if any (or None)
1862
:param branch: the branch created
1864
Note that for lightweight checkouts, the bzrdir and format fields refer
1865
to the checkout, hence they are different from the corresponding fields
1866
in branch, which refer to the original branch.
1868
self.format = format
1869
self.bzrdir = a_bzrdir
1871
self.branch = branch
1873
def __eq__(self, other):
1874
return self.__dict__ == other.__dict__
1878
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1880
return "<%s of format:%s bzrdir:%s>" % (
1881
self.__class__.__name__, self.branch,
1882
self.format, self.bzrdir)
1885
class SwitchHookParams(object):
1886
"""Object holding parameters passed to *_switch hooks.
1888
There are 4 fields that hooks may wish to access:
1890
:ivar control_dir: BzrDir of the checkout to change
1891
:ivar to_branch: branch that the checkout is to reference
1892
:ivar force: skip the check for local commits in a heavy checkout
1893
:ivar revision_id: revision ID to switch to (or None)
1896
def __init__(self, control_dir, to_branch, force, revision_id):
1897
"""Create a group of SwitchHook parameters.
1899
:param control_dir: BzrDir of the checkout to change
1900
:param to_branch: branch that the checkout is to reference
1901
:param force: skip the check for local commits in a heavy checkout
1902
:param revision_id: revision ID to switch to (or None)
1904
self.control_dir = control_dir
1905
self.to_branch = to_branch
1907
self.revision_id = revision_id
1909
def __eq__(self, other):
1910
return self.__dict__ == other.__dict__
1913
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1914
self.control_dir, self.to_branch,
1918
1533
class BzrBranchFormat4(BranchFormat):
1919
1534
"""Bzr branch format 4.
1973
1587
return self.get_format_string()
1975
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1589
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1976
1590
"""See BranchFormat.open()."""
1978
format = BranchFormat.find_format(a_bzrdir, name=name)
1592
format = BranchFormat.find_format(a_bzrdir)
1979
1593
if format.__class__ != self.__class__:
1980
1594
raise AssertionError("wrong format %r found for %r" %
1981
1595
(format, self))
1982
transport = a_bzrdir.get_branch_transport(None, name=name)
1597
transport = a_bzrdir.get_branch_transport(None)
1984
1598
control_files = lockable_files.LockableFiles(transport, 'lock',
1985
1599
lockdir.LockDir)
1986
1600
return self._branch_class()(_format=self,
1987
1601
_control_files=control_files,
1989
1602
a_bzrdir=a_bzrdir,
1990
1603
_repository=a_bzrdir.find_repository(),
1991
1604
ignore_fallbacks=ignore_fallbacks)
1992
1605
except errors.NoSuchFile:
1993
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1606
raise errors.NotBranchError(path=transport.base)
1995
1608
def __init__(self):
1996
1609
super(BranchFormatMetadir, self).__init__()
2058
1671
"""See BranchFormat.get_format_description()."""
2059
1672
return "Branch format 6"
2061
def initialize(self, a_bzrdir, name=None):
2062
"""Create a branch of this format in a_bzrdir."""
2063
utf8_files = [('last-revision', '0 null:\n'),
2064
('branch.conf', ''),
2067
return self._initialize_helper(a_bzrdir, utf8_files, name)
2069
def make_tags(self, branch):
2070
"""See bzrlib.branch.BranchFormat.make_tags()."""
2071
return BasicTags(branch)
2073
def supports_set_append_revisions_only(self):
2077
class BzrBranchFormat8(BranchFormatMetadir):
2078
"""Metadir format supporting storing locations of subtree branches."""
2080
def _branch_class(self):
2083
def get_format_string(self):
2084
"""See BranchFormat.get_format_string()."""
2085
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2087
def get_format_description(self):
2088
"""See BranchFormat.get_format_description()."""
2089
return "Branch format 8"
2091
def initialize(self, a_bzrdir, name=None):
2092
"""Create a branch of this format in a_bzrdir."""
2093
utf8_files = [('last-revision', '0 null:\n'),
2094
('branch.conf', ''),
2098
return self._initialize_helper(a_bzrdir, utf8_files, name)
2101
super(BzrBranchFormat8, self).__init__()
2102
self._matchingbzrdir.repository_format = \
2103
RepositoryFormatKnitPack5RichRoot()
2105
def make_tags(self, branch):
2106
"""See bzrlib.branch.BranchFormat.make_tags()."""
2107
return BasicTags(branch)
2109
def supports_set_append_revisions_only(self):
2112
def supports_stacking(self):
2115
supports_reference_locations = True
2118
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):
2119
1689
"""Branch format with last-revision, tags, and a stacked location pointer.
2121
1691
The stacked location pointer is passed down to the repository and requires
2171
1748
def get_reference(self, a_bzrdir):
2172
1749
"""See BranchFormat.get_reference()."""
2173
1750
transport = a_bzrdir.get_branch_transport(None)
2174
return transport.get_bytes('location')
1751
return transport.get('location').read()
2176
1753
def set_reference(self, a_bzrdir, to_branch):
2177
1754
"""See BranchFormat.set_reference()."""
2178
1755
transport = a_bzrdir.get_branch_transport(None)
2179
1756
location = transport.put_bytes('location', to_branch.base)
2181
def initialize(self, a_bzrdir, name=None, target_branch=None):
1758
def initialize(self, a_bzrdir, target_branch=None):
2182
1759
"""Create a branch of this format in a_bzrdir."""
2183
1760
if target_branch is None:
2184
1761
# this format does not implement branch itself, thus the implicit
2185
1762
# creation contract must see it as uninitializable
2186
1763
raise errors.UninitializableFormat(self)
2187
mutter('creating branch reference in %s', a_bzrdir.user_url)
2188
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)
2189
1766
branch_transport.put_bytes('location',
2190
target_branch.bzrdir.user_url)
1767
target_branch.bzrdir.root_transport.base)
2191
1768
branch_transport.put_bytes('format', self.get_format_string())
2193
a_bzrdir, name, _found=True,
1770
a_bzrdir, _found=True,
2194
1771
possible_transports=[target_branch.bzrdir.root_transport])
2195
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2198
1773
def __init__(self):
2199
1774
super(BranchReferenceFormat, self).__init__()
2205
1780
def clone(to_bzrdir, revision_id=None,
2206
1781
repository_policy=None):
2207
1782
"""See Branch.clone()."""
2208
return format.initialize(to_bzrdir, target_branch=a_branch)
1783
return format.initialize(to_bzrdir, a_branch)
2209
1784
# cannot obey revision_id limits when cloning a reference ...
2210
1785
# FIXME RBC 20060210 either nuke revision_id for clone, or
2211
1786
# emit some sort of warning/error to the caller ?!
2214
def open(self, a_bzrdir, name=None, _found=False, location=None,
1789
def open(self, a_bzrdir, _found=False, location=None,
2215
1790
possible_transports=None, ignore_fallbacks=False):
2216
1791
"""Return the branch that the branch reference in a_bzrdir points at.
2218
1793
:param a_bzrdir: A BzrDir that contains a branch.
2219
:param name: Name of colocated branch to open, if any
2220
1794
:param _found: a private parameter, do not use it. It is used to
2221
1795
indicate if format probing has already be done.
2222
1796
:param ignore_fallbacks: when set, no fallback branches will be opened
2263
1836
__format5 = BzrBranchFormat5()
2264
1837
__format6 = BzrBranchFormat6()
2265
1838
__format7 = BzrBranchFormat7()
2266
__format8 = BzrBranchFormat8()
2267
1839
BranchFormat.register_format(__format5)
2268
1840
BranchFormat.register_format(BranchReferenceFormat())
2269
1841
BranchFormat.register_format(__format6)
2270
1842
BranchFormat.register_format(__format7)
2271
BranchFormat.register_format(__format8)
2272
BranchFormat.set_default_format(__format7)
1843
BranchFormat.set_default_format(__format6)
2273
1844
_legacy_formats = [BzrBranchFormat4(),
2275
1846
network_format_registry.register(
2276
1847
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2279
class BranchWriteLockResult(object):
2280
"""The result of write locking a branch.
2282
:ivar branch_token: The token obtained from the underlying branch lock, or
2284
:ivar unlock: A callable which will unlock the lock.
2287
def __init__(self, unlock, branch_token):
2288
self.branch_token = branch_token
2289
self.unlock = unlock
2292
return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2296
class BzrBranch(Branch, _RelockDebugMixin):
1850
class BzrBranch(Branch):
2297
1851
"""A branch stored in the actual filesystem.
2299
1853
Note that it's "local" in the context of the filesystem; it doesn't
2352
1899
return self.control_files.is_locked()
2354
1901
def lock_write(self, token=None):
2355
"""Lock the branch for write operations.
2357
:param token: A token to permit reacquiring a previously held and
2359
:return: A BranchWriteLockResult.
2361
if not self.is_locked():
2362
self._note_lock('w')
2363
# All-in-one needs to always unlock/lock.
2364
repo_control = getattr(self.repository, 'control_files', None)
2365
if self.control_files == repo_control or not self.is_locked():
2366
self.repository._warn_if_deprecated(self)
2367
self.repository.lock_write()
1902
repo_token = self.repository.lock_write()
2372
return BranchWriteLockResult(self.unlock,
2373
self.control_files.lock_write(token=token))
1904
token = self.control_files.lock_write(token=token)
2376
self.repository.unlock()
1906
self.repository.unlock()
2379
1910
def lock_read(self):
2380
"""Lock the branch for read operations.
2382
:return: An object with an unlock method which will release the lock
2385
if not self.is_locked():
2386
self._note_lock('r')
2387
# All-in-one needs to always unlock/lock.
2388
repo_control = getattr(self.repository, 'control_files', None)
2389
if self.control_files == repo_control or not self.is_locked():
2390
self.repository._warn_if_deprecated(self)
2391
self.repository.lock_read()
1911
self.repository.lock_read()
2396
1913
self.control_files.lock_read()
2400
self.repository.unlock()
1915
self.repository.unlock()
2403
@only_raises(errors.LockNotHeld, errors.LockBroken)
2404
1918
def unlock(self):
1919
# TODO: test for failed two phase locks. This is known broken.
2406
1921
self.control_files.unlock()
2408
# All-in-one needs to always unlock/lock.
2409
repo_control = getattr(self.repository, 'control_files', None)
2410
if (self.control_files == repo_control or
2411
not self.control_files.is_locked()):
2412
self.repository.unlock()
2413
if not self.control_files.is_locked():
2414
# we just released the lock
2415
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()
2417
1928
def peek_lock_mode(self):
2418
1929
if self.control_files._lock_count == 0:
2537
2048
"""See Branch.basis_tree."""
2538
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']:
2540
2094
def _get_parent_location(self):
2541
2095
_locs = ['parent', 'pull', 'x-pull']
2542
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
2549
2168
def _basic_push(self, target, overwrite, stop_revision):
2550
2169
"""Basic implementation of push without bound branches or hooks.
2552
Must be called with source read locked and target write locked.
2171
Must be called with self read locked and target write locked.
2554
2173
result = BranchPushResult()
2555
2174
result.source_branch = self
2556
2175
result.target_branch = target
2557
2176
result.old_revno, result.old_revid = target.last_revision_info()
2558
self.update_references(target)
2559
2177
if result.old_revid != self.last_revision():
2560
2178
# We assume that during 'push' this repository is closer than
2562
2180
graph = self.repository.get_graph(target.repository)
2563
target.update_revisions(self, stop_revision,
2564
overwrite=overwrite, graph=graph)
2181
target.update_revisions(self, stop_revision, overwrite=overwrite,
2565
2183
if self._push_should_merge_tags():
2566
result.tag_conflicts = self.tags.merge_to(target.tags,
2184
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2568
2185
result.new_revno, result.new_revid = target.last_revision_info()
2571
2188
def get_stacked_on_url(self):
2572
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2189
raise errors.UnstackableBranchFormat(self._format, self.base)
2574
2191
def set_push_location(self, location):
2575
2192
"""See Branch.set_push_location."""
2591
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()
2594
2258
def get_bound_location(self):
2596
2260
return self._transport.get_bytes('bound')[:-1]
2774
2438
self._extend_partial_history(stop_index=last_revno-1)
2775
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:
2777
2470
def _write_revision_history(self, history):
2778
2471
"""Factored out of set_revision_history.
2800
2493
"""Set the parent branch"""
2801
2494
return self._get_config_location('parent_location')
2804
def _set_all_reference_info(self, info_dict):
2805
"""Replace all reference info stored in a branch.
2807
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2810
writer = rio.RioWriter(s)
2811
for key, (tree_path, branch_location) in info_dict.iteritems():
2812
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2813
branch_location=branch_location)
2814
writer.write_stanza(stanza)
2815
self._transport.put_bytes('references', s.getvalue())
2816
self._reference_info = info_dict
2819
def _get_all_reference_info(self):
2820
"""Return all the reference info stored in a branch.
2822
:return: A dict of {file_id: (tree_path, branch_location)}
2824
if self._reference_info is not None:
2825
return self._reference_info
2826
rio_file = self._transport.get('references')
2828
stanzas = rio.read_stanzas(rio_file)
2829
info_dict = dict((s['file_id'], (s['tree_path'],
2830
s['branch_location'])) for s in stanzas)
2833
self._reference_info = info_dict
2836
def set_reference_info(self, file_id, tree_path, branch_location):
2837
"""Set the branch location to use for a tree reference.
2839
:param file_id: The file-id of the tree reference.
2840
:param tree_path: The path of the tree reference in the tree.
2841
:param branch_location: The location of the branch to retrieve tree
2844
info_dict = self._get_all_reference_info()
2845
info_dict[file_id] = (tree_path, branch_location)
2846
if None in (tree_path, branch_location):
2847
if tree_path is not None:
2848
raise ValueError('tree_path must be None when branch_location'
2850
if branch_location is not None:
2851
raise ValueError('branch_location must be None when tree_path'
2853
del info_dict[file_id]
2854
self._set_all_reference_info(info_dict)
2856
def get_reference_info(self, file_id):
2857
"""Get the tree_path and branch_location for a tree reference.
2859
:return: a tuple of (tree_path, branch_location)
2861
return self._get_all_reference_info().get(file_id, (None, None))
2863
def reference_parent(self, file_id, path, possible_transports=None):
2864
"""Return the parent branch for a tree-reference file_id.
2866
:param file_id: The file_id of the tree reference
2867
:param path: The path of the file_id in the tree
2868
:return: A branch associated with the file_id
2870
branch_location = self.get_reference_info(file_id)[1]
2871
if branch_location is None:
2872
return Branch.reference_parent(self, file_id, path,
2873
possible_transports)
2874
branch_location = urlutils.join(self.user_url, branch_location)
2875
return Branch.open(branch_location,
2876
possible_transports=possible_transports)
2878
2496
def set_push_location(self, location):
2879
2497
"""See Branch.set_push_location."""
2880
2498
self._set_config_location('push_location', location)
3275
2858
self.source.unlock()
3277
def pull(self, overwrite=False, stop_revision=None,
3278
possible_transports=None, _hook_master=None, run_hooks=True,
3279
_override_hook_target=None, local=False):
3282
:param _hook_master: Private parameter - set the branch to
3283
be supplied as the master to pull hooks.
3284
:param run_hooks: Private parameter - if false, this branch
3285
is being called because it's the master of the primary branch,
3286
so it should not run its hooks.
3287
:param _override_hook_target: Private parameter - set the branch to be
3288
supplied as the target_branch to pull hooks.
3289
:param local: Only update the local branch, and not the bound branch.
3291
# This type of branch can't be bound.
3293
raise errors.LocalRequiresBoundBranch()
3294
result = PullResult()
3295
result.source_branch = self.source
3296
if _override_hook_target is None:
3297
result.target_branch = self.target
3299
result.target_branch = _override_hook_target
3300
self.source.lock_read()
3302
# We assume that during 'pull' the target repository is closer than
3304
self.source.update_references(self.target)
3305
graph = self.target.repository.get_graph(self.source.repository)
3306
# TODO: Branch formats should have a flag that indicates
3307
# that revno's are expensive, and pull() should honor that flag.
3309
result.old_revno, result.old_revid = \
3310
self.target.last_revision_info()
3311
self.target.update_revisions(self.source, stop_revision,
3312
overwrite=overwrite, graph=graph)
3313
# TODO: The old revid should be specified when merging tags,
3314
# so a tags implementation that versions tags can only
3315
# pull in the most recent changes. -- JRV20090506
3316
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3318
result.new_revno, result.new_revid = self.target.last_revision_info()
3320
result.master_branch = _hook_master
3321
result.local_branch = result.target_branch
3323
result.master_branch = result.target_branch
3324
result.local_branch = None
3326
for hook in Branch.hooks['post_pull']:
3329
self.source.unlock()
3332
def push(self, overwrite=False, stop_revision=None,
3333
_override_hook_source_branch=None):
3334
"""See InterBranch.push.
3336
This is the basic concrete implementation of push()
3338
:param _override_hook_source_branch: If specified, run
3339
the hooks passing this Branch as the source, rather than self.
3340
This is for use of RemoteBranch, where push is delegated to the
3341
underlying vfs-based Branch.
3343
# TODO: Public option to disable running hooks - should be trivial but
3345
self.source.lock_read()
3347
return _run_with_write_locked_target(
3348
self.target, self._push_with_bound_branches, overwrite,
3350
_override_hook_source_branch=_override_hook_source_branch)
3352
self.source.unlock()
3354
def _push_with_bound_branches(self, overwrite, stop_revision,
3355
_override_hook_source_branch=None):
3356
"""Push from source into target, and into target's master if any.
3359
if _override_hook_source_branch:
3360
result.source_branch = _override_hook_source_branch
3361
for hook in Branch.hooks['post_push']:
3364
bound_location = self.target.get_bound_location()
3365
if bound_location and self.target.base != bound_location:
3366
# there is a master branch.
3368
# XXX: Why the second check? Is it even supported for a branch to
3369
# be bound to itself? -- mbp 20070507
3370
master_branch = self.target.get_master_branch()
3371
master_branch.lock_write()
3373
# push into the master from the source branch.
3374
self.source._basic_push(master_branch, overwrite, stop_revision)
3375
# and push into the target branch from the source. Note that we
3376
# push from the source branch again, because its considered the
3377
# highest bandwidth repository.
3378
result = self.source._basic_push(self.target, overwrite,
3380
result.master_branch = master_branch
3381
result.local_branch = self.target
3385
master_branch.unlock()
3388
result = self.source._basic_push(self.target, overwrite,
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
3399
2861
def is_compatible(self, source, target):
3400
2862
# GenericBranch uses the public API, so always compatible
3404
class InterToBranch5(GenericInterBranch):
3407
def _get_branch_formats_to_test():
3408
return BranchFormat._default_format, BzrBranchFormat5()
3410
def pull(self, overwrite=False, stop_revision=None,
3411
possible_transports=None, run_hooks=True,
3412
_override_hook_target=None, local=False):
3413
"""Pull from source into self, updating my master if any.
3415
:param run_hooks: Private parameter - if false, this branch
3416
is being called because it's the master of the primary branch,
3417
so it should not run its hooks.
3419
bound_location = self.target.get_bound_location()
3420
if local and not bound_location:
3421
raise errors.LocalRequiresBoundBranch()
3422
master_branch = None
3423
if not local and bound_location and self.source.user_url != bound_location:
3424
# not pulling from master, so we need to update master.
3425
master_branch = self.target.get_master_branch(possible_transports)
3426
master_branch.lock_write()
3429
# pull from source into master.
3430
master_branch.pull(self.source, overwrite, stop_revision,
3432
return super(InterToBranch5, self).pull(overwrite,
3433
stop_revision, _hook_master=master_branch,
3434
run_hooks=run_hooks,
3435
_override_hook_target=_override_hook_target)
3438
master_branch.unlock()
3441
2866
InterBranch.register_optimiser(GenericInterBranch)
3442
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
