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
625
except (errors.NotStacked, errors.UnstackableBranchFormat,
770
626
errors.UnstackableRepositoryFormat):
629
# repositories don't offer an interface to remove fallback
630
# repositories today; take the conceptually simpler option and just
632
self.repository = self.bzrdir.find_repository()
633
# for every revision reference the branch has, ensure it is pulled
635
source_repository = self._get_fallback_repository(old_url)
636
for revision_id in chain([self.last_revision()],
637
self.tags.get_reverse_tag_dict()):
638
self.repository.fetch(source_repository, revision_id,
774
641
self._activate_fallback_location(url)
775
642
# write this out after the repository is stacked to avoid setting a
776
643
# stacked config that doesn't work.
777
644
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
647
def _set_tags_bytes(self, bytes):
835
648
"""Mirror method for _get_tags_bytes.
1002
817
except ValueError:
1003
818
raise errors.NoSuchRevision(self, revision_id)
1006
820
def get_rev_id(self, revno, history=None):
1007
821
"""Find the revision id of the specified revno."""
1009
823
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:
825
history = self.revision_history()
826
if revno <= 0 or revno > len(history):
1014
827
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]
828
return history[revno - 1]
1021
830
def pull(self, source, overwrite=False, stop_revision=None,
1022
possible_transports=None, *args, **kwargs):
831
possible_transports=None, _override_hook_target=None):
1023
832
"""Mirror source into this branch.
1025
834
This branch is considered to be 'local', having low latency.
1027
836
:returns: PullResult instance
1029
return InterBranch.get(source, self).pull(overwrite=overwrite,
1030
stop_revision=stop_revision,
1031
possible_transports=possible_transports, *args, **kwargs)
838
raise NotImplementedError(self.pull)
1033
def push(self, target, overwrite=False, stop_revision=None, *args,
840
def push(self, target, overwrite=False, stop_revision=None):
1035
841
"""Mirror this branch into target.
1037
843
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)
845
raise NotImplementedError(self.push)
1063
847
def basis_tree(self):
1064
848
"""Return `Tree` object for last revision."""
1256
1033
source_revno, source_revision_id = self.last_revision_info()
1257
1034
if revision_id is None:
1258
1035
revno, revision_id = source_revno, source_revision_id
1036
elif source_revision_id == revision_id:
1037
# we know the revno without needing to walk all of history
1038
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
1040
# To figure out the revno for a random revision, we need to build
1041
# the revision history, and count its length.
1042
# We don't care about the order, just how long it is.
1043
# Alternatively, we could start at the current location, and count
1044
# backwards. But there is no guarantee that we will find it since
1045
# it may be a merged revision.
1046
revno = len(list(self.repository.iter_reverse_revision_history(
1267
1048
destination.set_last_revision_info(revno, revision_id)
1269
1050
@needs_read_lock
1313
1076
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
1078
:return: A BranchCheckResult.
1319
result = BranchCheckResult(self)
1080
mainline_parent_id = None
1320
1081
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
1082
real_rev_history = list(self.repository.iter_reverse_revision_history(
1084
real_rev_history.reverse()
1085
if len(real_rev_history) != last_revno:
1086
raise errors.BzrCheckError('revno does not match len(mainline)'
1087
' %s != %s' % (last_revno, len(real_rev_history)))
1088
# TODO: We should probably also check that real_rev_history actually
1089
# matches self.revision_history()
1090
for revision_id in real_rev_history:
1092
revision = self.repository.get_revision(revision_id)
1093
except errors.NoSuchRevision, e:
1094
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1096
# In general the first entry on the revision history has no parents.
1097
# But it's not illegal for it to have parents listed; this can happen
1098
# in imports from Arch when the parents weren't reachable.
1099
if mainline_parent_id is not None:
1100
if mainline_parent_id not in revision.parent_ids:
1101
raise errors.BzrCheckError("previous revision {%s} not listed among "
1103
% (mainline_parent_id, revision_id))
1104
mainline_parent_id = revision_id
1105
return BranchCheckResult(self)
1333
1107
def _get_checkout_format(self):
1334
1108
"""Return the most suitable metadir for a checkout of this branch.
1346
1120
def create_clone_on_transport(self, to_transport, revision_id=None,
1347
stacked_on=None, create_prefix=False, use_existing_dir=False):
1348
1122
"""Create a clone of this branch and its bzrdir.
1350
1124
:param to_transport: The transport to clone onto.
1351
1125
:param revision_id: The revision id to use as tip in the new branch.
1352
1126
If None the tip is obtained from this branch.
1353
1127
: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
1129
# XXX: Fix the bzrdir API to allow getting the branch back from the
1359
1130
# clone call. Or something. 20090224 RBC/spiv.
1360
if revision_id is None:
1361
revision_id = self.last_revision()
1362
1131
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)
1132
revision_id=revision_id, stacked_on=stacked_on)
1365
1133
return dir_to.open_branch()
1367
1135
def create_checkout(self, to_location, revision_id=None,
1422
1189
reconciler.reconcile()
1423
1190
return reconciler
1425
def reference_parent(self, file_id, path, possible_transports=None):
1192
def reference_parent(self, file_id, path):
1426
1193
"""Return the parent branch for a tree-reference file_id
1427
1194
:param file_id: The file_id of the tree reference
1428
1195
:param path: The path of the file_id in the tree
1429
1196
:return: A branch associated with the file_id
1431
1198
# FIXME should provide multiple branches, based on config
1432
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1433
possible_transports=possible_transports)
1199
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1435
1201
def supports_tags(self):
1436
1202
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
1204
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1452
1206
"""Ensure that revision_b is a descendant of revision_a.
1565
1317
"""Return the short format description for this format."""
1566
1318
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):
1320
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1578
1322
"""Initialize a branch in a bzrdir, with specified files
1580
1324
:param a_bzrdir: The bzrdir to initialize the branch in
1581
1325
:param utf8_files: The files to create as a list of
1582
1326
(filename, content) tuples
1583
:param name: Name of colocated branch to create, if any
1584
1327
:param set_format: If True, set the format with
1585
1328
self.get_format_string. (BzrBranch4 has its format set
1587
1330
: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)
1332
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1333
branch_transport = a_bzrdir.get_branch_transport(self)
1592
1335
'metadir': ('lock', lockdir.LockDir),
1593
1336
'branch4': ('branch-lock', lockable_files.TransportLock),
1776
1501
"multiple hooks installed for transform_fallback_location, "
1777
1502
"all are called with the url returned from the previous hook."
1778
1503
"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
1506
# install the default hooks into the Branch class.
1837
1545
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
1548
class BzrBranchFormat4(BranchFormat):
1919
1549
"""Bzr branch format 4.
1973
1602
return self.get_format_string()
1975
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1604
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1976
1605
"""See BranchFormat.open()."""
1978
format = BranchFormat.find_format(a_bzrdir, name=name)
1607
format = BranchFormat.find_format(a_bzrdir)
1979
1608
if format.__class__ != self.__class__:
1980
1609
raise AssertionError("wrong format %r found for %r" %
1981
1610
(format, self))
1982
transport = a_bzrdir.get_branch_transport(None, name=name)
1612
transport = a_bzrdir.get_branch_transport(None)
1984
1613
control_files = lockable_files.LockableFiles(transport, 'lock',
1985
1614
lockdir.LockDir)
1986
1615
return self._branch_class()(_format=self,
1987
1616
_control_files=control_files,
1989
1617
a_bzrdir=a_bzrdir,
1990
1618
_repository=a_bzrdir.find_repository(),
1991
1619
ignore_fallbacks=ignore_fallbacks)
1992
1620
except errors.NoSuchFile:
1993
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1621
raise errors.NotBranchError(path=transport.base)
1995
1623
def __init__(self):
1996
1624
super(BranchFormatMetadir, self).__init__()
2058
1686
"""See BranchFormat.get_format_description()."""
2059
1687
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):
1689
def initialize(self, a_bzrdir):
1690
"""Create a branch of this format in a_bzrdir."""
1691
utf8_files = [('last-revision', '0 null:\n'),
1692
('branch.conf', ''),
1695
return self._initialize_helper(a_bzrdir, utf8_files)
1697
def make_tags(self, branch):
1698
"""See bzrlib.branch.BranchFormat.make_tags()."""
1699
return BasicTags(branch)
1703
class BzrBranchFormat7(BranchFormatMetadir):
2119
1704
"""Branch format with last-revision, tags, and a stacked location pointer.
2121
1706
The stacked location pointer is passed down to the repository and requires
2171
1763
def get_reference(self, a_bzrdir):
2172
1764
"""See BranchFormat.get_reference()."""
2173
1765
transport = a_bzrdir.get_branch_transport(None)
2174
return transport.get_bytes('location')
1766
return transport.get('location').read()
2176
1768
def set_reference(self, a_bzrdir, to_branch):
2177
1769
"""See BranchFormat.set_reference()."""
2178
1770
transport = a_bzrdir.get_branch_transport(None)
2179
1771
location = transport.put_bytes('location', to_branch.base)
2181
def initialize(self, a_bzrdir, name=None, target_branch=None):
1773
def initialize(self, a_bzrdir, target_branch=None):
2182
1774
"""Create a branch of this format in a_bzrdir."""
2183
1775
if target_branch is None:
2184
1776
# this format does not implement branch itself, thus the implicit
2185
1777
# creation contract must see it as uninitializable
2186
1778
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)
1779
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1780
branch_transport = a_bzrdir.get_branch_transport(self)
2189
1781
branch_transport.put_bytes('location',
2190
target_branch.bzrdir.user_url)
1782
target_branch.bzrdir.root_transport.base)
2191
1783
branch_transport.put_bytes('format', self.get_format_string())
2193
a_bzrdir, name, _found=True,
1785
a_bzrdir, _found=True,
2194
1786
possible_transports=[target_branch.bzrdir.root_transport])
2195
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2198
1788
def __init__(self):
2199
1789
super(BranchReferenceFormat, self).__init__()
2205
1795
def clone(to_bzrdir, revision_id=None,
2206
1796
repository_policy=None):
2207
1797
"""See Branch.clone()."""
2208
return format.initialize(to_bzrdir, target_branch=a_branch)
1798
return format.initialize(to_bzrdir, a_branch)
2209
1799
# cannot obey revision_id limits when cloning a reference ...
2210
1800
# FIXME RBC 20060210 either nuke revision_id for clone, or
2211
1801
# emit some sort of warning/error to the caller ?!
2214
def open(self, a_bzrdir, name=None, _found=False, location=None,
1804
def open(self, a_bzrdir, _found=False, location=None,
2215
1805
possible_transports=None, ignore_fallbacks=False):
2216
1806
"""Return the branch that the branch reference in a_bzrdir points at.
2218
1808
:param a_bzrdir: A BzrDir that contains a branch.
2219
:param name: Name of colocated branch to open, if any
2220
1809
:param _found: a private parameter, do not use it. It is used to
2221
1810
indicate if format probing has already be done.
2222
1811
:param ignore_fallbacks: when set, no fallback branches will be opened
2263
1851
__format5 = BzrBranchFormat5()
2264
1852
__format6 = BzrBranchFormat6()
2265
1853
__format7 = BzrBranchFormat7()
2266
__format8 = BzrBranchFormat8()
2267
1854
BranchFormat.register_format(__format5)
2268
1855
BranchFormat.register_format(BranchReferenceFormat())
2269
1856
BranchFormat.register_format(__format6)
2270
1857
BranchFormat.register_format(__format7)
2271
BranchFormat.register_format(__format8)
2272
BranchFormat.set_default_format(__format7)
1858
BranchFormat.set_default_format(__format6)
2273
1859
_legacy_formats = [BzrBranchFormat4(),
2275
1861
network_format_registry.register(
2276
1862
_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
class BzrBranch(Branch, _RelockDebugMixin):
1865
class BzrBranch(Branch):
2293
1866
"""A branch stored in the actual filesystem.
2295
1868
Note that it's "local" in the context of the filesystem; it doesn't
2348
1914
return self.control_files.is_locked()
2350
1916
def lock_write(self, token=None):
2351
"""Lock the branch for write operations.
2353
:param token: A token to permit reacquiring a previously held and
2355
:return: A BranchWriteLockResult.
2357
if not self.is_locked():
2358
self._note_lock('w')
2359
# All-in-one needs to always unlock/lock.
2360
repo_control = getattr(self.repository, 'control_files', None)
2361
if self.control_files == repo_control or not self.is_locked():
2362
self.repository._warn_if_deprecated(self)
2363
self.repository.lock_write()
1917
repo_token = self.repository.lock_write()
2368
return BranchWriteLockResult(self.unlock,
2369
self.control_files.lock_write(token=token))
1919
token = self.control_files.lock_write(token=token)
2372
self.repository.unlock()
1921
self.repository.unlock()
2375
1925
def lock_read(self):
2376
"""Lock the branch for read operations.
2378
:return: An object with an unlock method which will release the lock
2381
if not self.is_locked():
2382
self._note_lock('r')
2383
# All-in-one needs to always unlock/lock.
2384
repo_control = getattr(self.repository, 'control_files', None)
2385
if self.control_files == repo_control or not self.is_locked():
2386
self.repository._warn_if_deprecated(self)
2387
self.repository.lock_read()
1926
self.repository.lock_read()
2392
1928
self.control_files.lock_read()
2396
self.repository.unlock()
1930
self.repository.unlock()
2399
@only_raises(errors.LockNotHeld, errors.LockBroken)
2400
1933
def unlock(self):
1934
# TODO: test for failed two phase locks. This is known broken.
2402
1936
self.control_files.unlock()
2404
# All-in-one needs to always unlock/lock.
2405
repo_control = getattr(self.repository, 'control_files', None)
2406
if (self.control_files == repo_control or
2407
not self.control_files.is_locked()):
2408
self.repository.unlock()
2409
if not self.control_files.is_locked():
2410
# we just released the lock
2411
self._clear_cached_state()
1938
self.repository.unlock()
1939
if not self.control_files.is_locked():
1940
# we just released the lock
1941
self._clear_cached_state()
2413
1943
def peek_lock_mode(self):
2414
1944
if self.control_files._lock_count == 0:
2533
2063
"""See Branch.basis_tree."""
2534
2064
return self.repository.revision_tree(self.last_revision())
2067
def pull(self, source, overwrite=False, stop_revision=None,
2068
_hook_master=None, run_hooks=True, possible_transports=None,
2069
_override_hook_target=None):
2072
:param _hook_master: Private parameter - set the branch to
2073
be supplied as the master to pull hooks.
2074
:param run_hooks: Private parameter - if false, this branch
2075
is being called because it's the master of the primary branch,
2076
so it should not run its hooks.
2077
:param _override_hook_target: Private parameter - set the branch to be
2078
supplied as the target_branch to pull hooks.
2080
result = PullResult()
2081
result.source_branch = source
2082
if _override_hook_target is None:
2083
result.target_branch = self
2085
result.target_branch = _override_hook_target
2088
# We assume that during 'pull' the local repository is closer than
2090
graph = self.repository.get_graph(source.repository)
2091
result.old_revno, result.old_revid = self.last_revision_info()
2092
self.update_revisions(source, stop_revision, overwrite=overwrite,
2094
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
2095
result.new_revno, result.new_revid = self.last_revision_info()
2097
result.master_branch = _hook_master
2098
result.local_branch = result.target_branch
2100
result.master_branch = result.target_branch
2101
result.local_branch = None
2103
for hook in Branch.hooks['post_pull']:
2536
2109
def _get_parent_location(self):
2537
2110
_locs = ['parent', 'pull', 'x-pull']
2538
2111
for l in _locs:
2119
def push(self, target, overwrite=False, stop_revision=None,
2120
_override_hook_source_branch=None):
2123
This is the basic concrete implementation of push()
2125
:param _override_hook_source_branch: If specified, run
2126
the hooks passing this Branch as the source, rather than self.
2127
This is for use of RemoteBranch, where push is delegated to the
2128
underlying vfs-based Branch.
2130
# TODO: Public option to disable running hooks - should be trivial but
2132
return _run_with_write_locked_target(
2133
target, self._push_with_bound_branches, target, overwrite,
2135
_override_hook_source_branch=_override_hook_source_branch)
2137
def _push_with_bound_branches(self, target, overwrite,
2139
_override_hook_source_branch=None):
2140
"""Push from self into target, and into target's master if any.
2142
This is on the base BzrBranch class even though it doesn't support
2143
bound branches because the *target* might be bound.
2146
if _override_hook_source_branch:
2147
result.source_branch = _override_hook_source_branch
2148
for hook in Branch.hooks['post_push']:
2151
bound_location = target.get_bound_location()
2152
if bound_location and target.base != bound_location:
2153
# there is a master branch.
2155
# XXX: Why the second check? Is it even supported for a branch to
2156
# be bound to itself? -- mbp 20070507
2157
master_branch = target.get_master_branch()
2158
master_branch.lock_write()
2160
# push into the master from this branch.
2161
self._basic_push(master_branch, overwrite, stop_revision)
2162
# and push into the target branch from this. Note that we push from
2163
# this branch again, because its considered the highest bandwidth
2165
result = self._basic_push(target, overwrite, stop_revision)
2166
result.master_branch = master_branch
2167
result.local_branch = target
2171
master_branch.unlock()
2174
result = self._basic_push(target, overwrite, stop_revision)
2175
# TODO: Why set master_branch and local_branch if there's no
2176
# binding? Maybe cleaner to just leave them unset? -- mbp
2178
result.master_branch = target
2179
result.local_branch = None
2545
2183
def _basic_push(self, target, overwrite, stop_revision):
2546
2184
"""Basic implementation of push without bound branches or hooks.
2548
Must be called with source read locked and target write locked.
2186
Must be called with self read locked and target write locked.
2550
2188
result = BranchPushResult()
2551
2189
result.source_branch = self
2552
2190
result.target_branch = target
2553
2191
result.old_revno, result.old_revid = target.last_revision_info()
2554
self.update_references(target)
2555
2192
if result.old_revid != self.last_revision():
2556
2193
# We assume that during 'push' this repository is closer than
2558
2195
graph = self.repository.get_graph(target.repository)
2559
target.update_revisions(self, stop_revision,
2560
overwrite=overwrite, graph=graph)
2196
target.update_revisions(self, stop_revision, overwrite=overwrite,
2561
2198
if self._push_should_merge_tags():
2562
result.tag_conflicts = self.tags.merge_to(target.tags,
2199
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2564
2200
result.new_revno, result.new_revid = target.last_revision_info()
2567
2203
def get_stacked_on_url(self):
2568
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2204
raise errors.UnstackableBranchFormat(self._format, self.base)
2570
2206
def set_push_location(self, location):
2571
2207
"""See Branch.set_push_location."""
2587
2223
It has support for a master_branch which is the data for bound branches.
2227
def pull(self, source, overwrite=False, stop_revision=None,
2228
run_hooks=True, possible_transports=None,
2229
_override_hook_target=None):
2230
"""Pull from source into self, updating my master if any.
2232
:param run_hooks: Private parameter - if false, this branch
2233
is being called because it's the master of the primary branch,
2234
so it should not run its hooks.
2236
bound_location = self.get_bound_location()
2237
master_branch = None
2238
if bound_location and source.base != bound_location:
2239
# not pulling from master, so we need to update master.
2240
master_branch = self.get_master_branch(possible_transports)
2241
master_branch.lock_write()
2244
# pull from source into master.
2245
master_branch.pull(source, overwrite, stop_revision,
2247
return super(BzrBranch5, self).pull(source, overwrite,
2248
stop_revision, _hook_master=master_branch,
2249
run_hooks=run_hooks,
2250
_override_hook_target=_override_hook_target)
2253
master_branch.unlock()
2590
2255
def get_bound_location(self):
2592
2257
return self._transport.get_bytes('bound')[:-1]
2770
2435
self._extend_partial_history(stop_index=last_revno-1)
2771
2436
return list(reversed(self._partial_revision_history_cache))
2438
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2439
"""Extend the partial history to include a given index
2441
If a stop_index is supplied, stop when that index has been reached.
2442
If a stop_revision is supplied, stop when that revision is
2443
encountered. Otherwise, stop when the beginning of history is
2446
:param stop_index: The index which should be present. When it is
2447
present, history extension will stop.
2448
:param revision_id: The revision id which should be present. When
2449
it is encountered, history extension will stop.
2451
repo = self.repository
2452
if len(self._partial_revision_history_cache) == 0:
2453
iterator = repo.iter_reverse_revision_history(self.last_revision())
2455
start_revision = self._partial_revision_history_cache[-1]
2456
iterator = repo.iter_reverse_revision_history(start_revision)
2457
#skip the last revision in the list
2458
next_revision = iterator.next()
2459
for revision_id in iterator:
2460
self._partial_revision_history_cache.append(revision_id)
2461
if (stop_index is not None and
2462
len(self._partial_revision_history_cache) > stop_index):
2464
if revision_id == stop_revision:
2773
2467
def _write_revision_history(self, history):
2774
2468
"""Factored out of set_revision_history.
2796
2490
"""Set the parent branch"""
2797
2491
return self._get_config_location('parent_location')
2800
def _set_all_reference_info(self, info_dict):
2801
"""Replace all reference info stored in a branch.
2803
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2806
writer = rio.RioWriter(s)
2807
for key, (tree_path, branch_location) in info_dict.iteritems():
2808
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2809
branch_location=branch_location)
2810
writer.write_stanza(stanza)
2811
self._transport.put_bytes('references', s.getvalue())
2812
self._reference_info = info_dict
2815
def _get_all_reference_info(self):
2816
"""Return all the reference info stored in a branch.
2818
:return: A dict of {file_id: (tree_path, branch_location)}
2820
if self._reference_info is not None:
2821
return self._reference_info
2822
rio_file = self._transport.get('references')
2824
stanzas = rio.read_stanzas(rio_file)
2825
info_dict = dict((s['file_id'], (s['tree_path'],
2826
s['branch_location'])) for s in stanzas)
2829
self._reference_info = info_dict
2832
def set_reference_info(self, file_id, tree_path, branch_location):
2833
"""Set the branch location to use for a tree reference.
2835
:param file_id: The file-id of the tree reference.
2836
:param tree_path: The path of the tree reference in the tree.
2837
:param branch_location: The location of the branch to retrieve tree
2840
info_dict = self._get_all_reference_info()
2841
info_dict[file_id] = (tree_path, branch_location)
2842
if None in (tree_path, branch_location):
2843
if tree_path is not None:
2844
raise ValueError('tree_path must be None when branch_location'
2846
if branch_location is not None:
2847
raise ValueError('branch_location must be None when tree_path'
2849
del info_dict[file_id]
2850
self._set_all_reference_info(info_dict)
2852
def get_reference_info(self, file_id):
2853
"""Get the tree_path and branch_location for a tree reference.
2855
:return: a tuple of (tree_path, branch_location)
2857
return self._get_all_reference_info().get(file_id, (None, None))
2859
def reference_parent(self, file_id, path, possible_transports=None):
2860
"""Return the parent branch for a tree-reference file_id.
2862
:param file_id: The file_id of the tree reference
2863
:param path: The path of the file_id in the tree
2864
:return: A branch associated with the file_id
2866
branch_location = self.get_reference_info(file_id)[1]
2867
if branch_location is None:
2868
return Branch.reference_parent(self, file_id, path,
2869
possible_transports)
2870
branch_location = urlutils.join(self.user_url, branch_location)
2871
return Branch.open(branch_location,
2872
possible_transports=possible_transports)
2874
2493
def set_push_location(self, location):
2875
2494
"""See Branch.set_push_location."""
2876
2495
self._set_config_location('push_location', location)
3271
2855
self.source.unlock()
3273
def pull(self, overwrite=False, stop_revision=None,
3274
possible_transports=None, _hook_master=None, run_hooks=True,
3275
_override_hook_target=None, local=False):
3278
:param _hook_master: Private parameter - set the branch to
3279
be supplied as the master to pull hooks.
3280
:param run_hooks: Private parameter - if false, this branch
3281
is being called because it's the master of the primary branch,
3282
so it should not run its hooks.
3283
:param _override_hook_target: Private parameter - set the branch to be
3284
supplied as the target_branch to pull hooks.
3285
:param local: Only update the local branch, and not the bound branch.
3287
# This type of branch can't be bound.
3289
raise errors.LocalRequiresBoundBranch()
3290
result = PullResult()
3291
result.source_branch = self.source
3292
if _override_hook_target is None:
3293
result.target_branch = self.target
3295
result.target_branch = _override_hook_target
3296
self.source.lock_read()
3298
# We assume that during 'pull' the target repository is closer than
3300
self.source.update_references(self.target)
3301
graph = self.target.repository.get_graph(self.source.repository)
3302
# TODO: Branch formats should have a flag that indicates
3303
# that revno's are expensive, and pull() should honor that flag.
3305
result.old_revno, result.old_revid = \
3306
self.target.last_revision_info()
3307
self.target.update_revisions(self.source, stop_revision,
3308
overwrite=overwrite, graph=graph)
3309
# TODO: The old revid should be specified when merging tags,
3310
# so a tags implementation that versions tags can only
3311
# pull in the most recent changes. -- JRV20090506
3312
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3314
result.new_revno, result.new_revid = self.target.last_revision_info()
3316
result.master_branch = _hook_master
3317
result.local_branch = result.target_branch
3319
result.master_branch = result.target_branch
3320
result.local_branch = None
3322
for hook in Branch.hooks['post_pull']:
3325
self.source.unlock()
3328
def push(self, overwrite=False, stop_revision=None,
3329
_override_hook_source_branch=None):
3330
"""See InterBranch.push.
3332
This is the basic concrete implementation of push()
3334
:param _override_hook_source_branch: If specified, run
3335
the hooks passing this Branch as the source, rather than self.
3336
This is for use of RemoteBranch, where push is delegated to the
3337
underlying vfs-based Branch.
3339
# TODO: Public option to disable running hooks - should be trivial but
3341
self.source.lock_read()
3343
return _run_with_write_locked_target(
3344
self.target, self._push_with_bound_branches, overwrite,
3346
_override_hook_source_branch=_override_hook_source_branch)
3348
self.source.unlock()
3350
def _push_with_bound_branches(self, overwrite, stop_revision,
3351
_override_hook_source_branch=None):
3352
"""Push from source into target, and into target's master if any.
3355
if _override_hook_source_branch:
3356
result.source_branch = _override_hook_source_branch
3357
for hook in Branch.hooks['post_push']:
3360
bound_location = self.target.get_bound_location()
3361
if bound_location and self.target.base != bound_location:
3362
# there is a master branch.
3364
# XXX: Why the second check? Is it even supported for a branch to
3365
# be bound to itself? -- mbp 20070507
3366
master_branch = self.target.get_master_branch()
3367
master_branch.lock_write()
3369
# push into the master from the source branch.
3370
self.source._basic_push(master_branch, overwrite, stop_revision)
3371
# and push into the target branch from the source. Note that we
3372
# push from the source branch again, because its considered the
3373
# highest bandwidth repository.
3374
result = self.source._basic_push(self.target, overwrite,
3376
result.master_branch = master_branch
3377
result.local_branch = self.target
3381
master_branch.unlock()
3384
result = self.source._basic_push(self.target, overwrite,
3386
# TODO: Why set master_branch and local_branch if there's no
3387
# binding? Maybe cleaner to just leave them unset? -- mbp
3389
result.master_branch = self.target
3390
result.local_branch = None
3395
2858
def is_compatible(self, source, target):
3396
2859
# GenericBranch uses the public API, so always compatible
3400
class InterToBranch5(GenericInterBranch):
3403
def _get_branch_formats_to_test():
3404
return BranchFormat._default_format, BzrBranchFormat5()
3406
def pull(self, overwrite=False, stop_revision=None,
3407
possible_transports=None, run_hooks=True,
3408
_override_hook_target=None, local=False):
3409
"""Pull from source into self, updating my master if any.
3411
:param run_hooks: Private parameter - if false, this branch
3412
is being called because it's the master of the primary branch,
3413
so it should not run its hooks.
3415
bound_location = self.target.get_bound_location()
3416
if local and not bound_location:
3417
raise errors.LocalRequiresBoundBranch()
3418
master_branch = None
3419
if not local and bound_location and self.source.user_url != bound_location:
3420
# not pulling from master, so we need to update master.
3421
master_branch = self.target.get_master_branch(possible_transports)
3422
master_branch.lock_write()
3425
# pull from source into master.
3426
master_branch.pull(self.source, overwrite, stop_revision,
3428
return super(InterToBranch5, self).pull(overwrite,
3429
stop_revision, _hook_master=master_branch,
3430
run_hooks=run_hooks,
3431
_override_hook_target=_override_hook_target)
3434
master_branch.unlock()
3437
2863
InterBranch.register_optimiser(GenericInterBranch)
3438
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
