121
113
if master is not None:
122
114
master.break_lock()
124
def _check_stackable_repo(self):
125
if not self.repository._format.supports_external_lookups:
126
raise errors.UnstackableRepositoryFormat(self.repository._format,
127
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
117
def open(base, _unsupported=False, possible_transports=None):
160
118
"""Open the branch rooted at base.
446
383
# start_revision_id.
447
384
if self._merge_sorted_revisions_cache is None:
448
385
last_revision = self.last_revision()
449
known_graph = self.repository.get_known_graph_ancestry(
451
self._merge_sorted_revisions_cache = known_graph.merge_sort(
386
graph = self.repository.get_graph()
387
parent_map = dict(((key, value) for key, value in
388
graph.iter_ancestry([last_revision]) if value is not None))
389
revision_graph = repository._strip_NULL_ghosts(parent_map)
390
revs = tsort.merge_sort(revision_graph, last_revision, None,
392
# Drop the sequence # before caching
393
self._merge_sorted_revisions_cache = [r[1:] for r in revs]
453
395
filtered = self._filter_merge_sorted_revisions(
454
396
self._merge_sorted_revisions_cache, start_revision_id,
455
397
stop_revision_id, stop_rule)
456
# Make sure we don't return revisions that are not part of the
457
# start_revision_id ancestry.
458
filtered = self._filter_start_non_ancestors(filtered)
459
398
if direction == 'reverse':
461
400
if direction == 'forward':
468
407
"""Iterate over an inclusive range of sorted revisions."""
469
408
rev_iter = iter(merge_sorted_revisions)
470
409
if start_revision_id is not None:
471
for node in rev_iter:
472
rev_id = node.key[-1]
410
for rev_id, depth, revno, end_of_merge in rev_iter:
473
411
if rev_id != start_revision_id:
476
414
# The decision to include the start or not
477
415
# depends on the stop_rule if a stop is provided
478
# so pop this node back into the iterator
479
rev_iter = chain(iter([node]), rev_iter)
417
iter([(rev_id, depth, revno, end_of_merge)]),
481
420
if stop_revision_id is None:
483
for node in rev_iter:
484
rev_id = node.key[-1]
485
yield (rev_id, node.merge_depth, node.revno,
421
for rev_id, depth, revno, end_of_merge in rev_iter:
422
yield rev_id, depth, revno, end_of_merge
487
423
elif stop_rule == 'exclude':
488
for node in rev_iter:
489
rev_id = node.key[-1]
424
for rev_id, depth, revno, end_of_merge in rev_iter:
490
425
if rev_id == stop_revision_id:
492
yield (rev_id, node.merge_depth, node.revno,
427
yield rev_id, depth, revno, end_of_merge
494
428
elif stop_rule == 'include':
495
for node in rev_iter:
496
rev_id = node.key[-1]
497
yield (rev_id, node.merge_depth, node.revno,
429
for rev_id, depth, revno, end_of_merge in rev_iter:
430
yield rev_id, depth, revno, end_of_merge
499
431
if rev_id == stop_revision_id:
501
elif stop_rule == 'with-merges-without-common-ancestry':
502
# We want to exclude all revisions that are already part of the
503
# stop_revision_id ancestry.
504
graph = self.repository.get_graph()
505
ancestors = graph.find_unique_ancestors(start_revision_id,
507
for node in rev_iter:
508
rev_id = node.key[-1]
509
if rev_id not in ancestors:
511
yield (rev_id, node.merge_depth, node.revno,
513
433
elif stop_rule == 'with-merges':
514
434
stop_rev = self.repository.get_revision(stop_revision_id)
515
435
if stop_rev.parent_ids:
516
436
left_parent = stop_rev.parent_ids[0]
518
438
left_parent = _mod_revision.NULL_REVISION
519
# left_parent is the actual revision we want to stop logging at,
520
# since we want to show the merged revisions after the stop_rev too
521
reached_stop_revision_id = False
522
revision_id_whitelist = []
523
for node in rev_iter:
524
rev_id = node.key[-1]
439
for rev_id, depth, revno, end_of_merge in rev_iter:
525
440
if rev_id == left_parent:
526
# reached the left parent after the stop_revision
528
if (not reached_stop_revision_id or
529
rev_id in revision_id_whitelist):
530
yield (rev_id, node.merge_depth, node.revno,
532
if reached_stop_revision_id or rev_id == stop_revision_id:
533
# only do the merged revs of rev_id from now on
534
rev = self.repository.get_revision(rev_id)
536
reached_stop_revision_id = True
537
revision_id_whitelist.extend(rev.parent_ids)
442
yield rev_id, depth, revno, end_of_merge
539
444
raise ValueError('invalid stop_rule %r' % stop_rule)
541
def _filter_start_non_ancestors(self, rev_iter):
542
# If we started from a dotted revno, we want to consider it as a tip
543
# and don't want to yield revisions that are not part of its
544
# ancestry. Given the order guaranteed by the merge sort, we will see
545
# uninteresting descendants of the first parent of our tip before the
547
first = rev_iter.next()
548
(rev_id, merge_depth, revno, end_of_merge) = first
551
# We start at a mainline revision so by definition, all others
552
# revisions in rev_iter are ancestors
553
for node in rev_iter:
558
pmap = self.repository.get_parent_map([rev_id])
559
parents = pmap.get(rev_id, [])
561
whitelist.update(parents)
563
# If there is no parents, there is nothing of interest left
565
# FIXME: It's hard to test this scenario here as this code is never
566
# called in that case. -- vila 20100322
569
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
571
if rev_id in whitelist:
572
pmap = self.repository.get_parent_map([rev_id])
573
parents = pmap.get(rev_id, [])
574
whitelist.remove(rev_id)
575
whitelist.update(parents)
577
# We've reached the mainline, there is nothing left to
581
# A revision that is not part of the ancestry of our
584
yield (rev_id, merge_depth, revno, end_of_merge)
586
446
def leave_lock_in_place(self):
587
447
"""Tell this branch object not to release the physical lock when this
588
448
object is unlocked.
746
569
:raises UnstackableRepositoryFormat: If the repository does not support
749
if not self._format.supports_stacking():
750
raise errors.UnstackableBranchFormat(self._format, self.user_url)
751
# XXX: Changing from one fallback repository to another does not check
752
# that all the data you need is present in the new fallback.
753
# Possibly it should.
754
self._check_stackable_repo()
757
old_url = self.get_stacked_on_url()
758
except (errors.NotStacked, errors.UnstackableBranchFormat,
759
errors.UnstackableRepositoryFormat):
763
self._activate_fallback_location(url)
764
# write this out after the repository is stacked to avoid setting a
765
# stacked config that doesn't work.
766
self._set_config_location('stacked_on_location', url)
769
"""Change a branch to be unstacked, copying data as needed.
771
Don't call this directly, use set_stacked_on_url(None).
773
pb = ui.ui_factory.nested_progress_bar()
775
pb.update("Unstacking")
776
# The basic approach here is to fetch the tip of the branch,
777
# including all available ghosts, from the existing stacked
778
# repository into a new repository object without the fallbacks.
780
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
781
# correct for CHKMap repostiories
782
old_repository = self.repository
783
if len(old_repository._fallback_repositories) != 1:
784
raise AssertionError("can't cope with fallback repositories "
785
"of %r" % (self.repository,))
786
# unlock it, including unlocking the fallback
787
old_repository.unlock()
788
old_repository.lock_read()
790
# Repositories don't offer an interface to remove fallback
791
# repositories today; take the conceptually simpler option and just
792
# reopen it. We reopen it starting from the URL so that we
793
# get a separate connection for RemoteRepositories and can
794
# stream from one of them to the other. This does mean doing
795
# separate SSH connection setup, but unstacking is not a
796
# common operation so it's tolerable.
797
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
798
new_repository = new_bzrdir.find_repository()
799
self.repository = new_repository
800
if self.repository._fallback_repositories:
801
raise AssertionError("didn't expect %r to have "
802
"fallback_repositories"
803
% (self.repository,))
804
# this is not paired with an unlock because it's just restoring
805
# the previous state; the lock's released when set_stacked_on_url
807
self.repository.lock_write()
808
# XXX: If you unstack a branch while it has a working tree
809
# with a pending merge, the pending-merged revisions will no
810
# longer be present. You can (probably) revert and remerge.
812
# XXX: This only fetches up to the tip of the repository; it
813
# doesn't bring across any tags. That's fairly consistent
814
# with how branch works, but perhaps not ideal.
815
self.repository.fetch(old_repository,
816
revision_id=self.last_revision(),
819
old_repository.unlock()
572
raise NotImplementedError(self.set_stacked_on_url)
823
574
def _set_tags_bytes(self, bytes):
824
575
"""Mirror method for _get_tags_bytes.
991
744
except ValueError:
992
745
raise errors.NoSuchRevision(self, revision_id)
995
747
def get_rev_id(self, revno, history=None):
996
748
"""Find the revision id of the specified revno."""
998
750
return _mod_revision.NULL_REVISION
999
last_revno, last_revid = self.last_revision_info()
1000
if revno == last_revno:
1002
if revno <= 0 or revno > last_revno:
752
history = self.revision_history()
753
if revno <= 0 or revno > len(history):
1003
754
raise errors.NoSuchRevision(self, revno)
1004
distance_from_last = last_revno - revno
1005
if len(self._partial_revision_history_cache) <= distance_from_last:
1006
self._extend_partial_history(distance_from_last)
1007
return self._partial_revision_history_cache[distance_from_last]
755
return history[revno - 1]
1010
757
def pull(self, source, overwrite=False, stop_revision=None,
1011
possible_transports=None, *args, **kwargs):
758
possible_transports=None, _override_hook_target=None):
1012
759
"""Mirror source into this branch.
1014
761
This branch is considered to be 'local', having low latency.
1016
763
:returns: PullResult instance
1018
return InterBranch.get(source, self).pull(overwrite=overwrite,
1019
stop_revision=stop_revision,
1020
possible_transports=possible_transports, *args, **kwargs)
765
raise NotImplementedError(self.pull)
1022
def push(self, target, overwrite=False, stop_revision=None, *args,
767
def push(self, target, overwrite=False, stop_revision=None):
1024
768
"""Mirror this branch into target.
1026
770
This branch is considered to be 'local', having low latency.
1028
return InterBranch.get(self, target).push(overwrite, stop_revision,
1031
def lossy_push(self, target, stop_revision=None):
1032
"""Push deltas into another branch.
1034
:note: This does not, like push, retain the revision ids from
1035
the source branch and will, rather than adding bzr-specific
1036
metadata, push only those semantics of the revision that can be
1037
natively represented by this branch' VCS.
1039
:param target: Target branch
1040
:param stop_revision: Revision to push, defaults to last revision.
1041
:return: BranchPushResult with an extra member revidmap:
1042
A dictionary mapping revision ids from the target branch
1043
to new revision ids in the target branch, for each
1044
revision that was pushed.
1046
inter = InterBranch.get(self, target)
1047
lossy_push = getattr(inter, "lossy_push", None)
1048
if lossy_push is None:
1049
raise errors.LossyPushToSameVCS(self, target)
1050
return lossy_push(stop_revision)
772
raise NotImplementedError(self.push)
1052
774
def basis_tree(self):
1053
775
"""Return `Tree` object for last revision."""
1245
963
source_revno, source_revision_id = self.last_revision_info()
1246
964
if revision_id is None:
1247
965
revno, revision_id = source_revno, source_revision_id
966
elif source_revision_id == revision_id:
967
# we know the revno without needing to walk all of history
1249
graph = self.repository.get_graph()
1251
revno = graph.find_distance_to_null(revision_id,
1252
[(source_revision_id, source_revno)])
1253
except errors.GhostRevisionsHaveNoRevno:
1254
# Default to 1, if we can't find anything else
970
# To figure out the revno for a random revision, we need to build
971
# the revision history, and count its length.
972
# We don't care about the order, just how long it is.
973
# Alternatively, we could start at the current location, and count
974
# backwards. But there is no guarantee that we will find it since
975
# it may be a merged revision.
976
revno = len(list(self.repository.iter_reverse_revision_history(
1256
978
destination.set_last_revision_info(revno, revision_id)
1258
980
@needs_read_lock
1302
1006
Callers will typically also want to check the repository.
1304
:param refs: Calculated refs for this branch as specified by
1305
branch._get_check_refs()
1306
1008
:return: A BranchCheckResult.
1308
result = BranchCheckResult(self)
1010
mainline_parent_id = None
1309
1011
last_revno, last_revision_id = self.last_revision_info()
1310
actual_revno = refs[('lefthand-distance', last_revision_id)]
1311
if actual_revno != last_revno:
1312
result.errors.append(errors.BzrCheckError(
1313
'revno does not match len(mainline) %s != %s' % (
1314
last_revno, actual_revno)))
1315
# TODO: We should probably also check that self.revision_history
1316
# matches the repository for older branch formats.
1317
# If looking for the code that cross-checks repository parents against
1318
# the iter_reverse_revision_history output, that is now a repository
1012
real_rev_history = list(self.repository.iter_reverse_revision_history(
1014
real_rev_history.reverse()
1015
if len(real_rev_history) != last_revno:
1016
raise errors.BzrCheckError('revno does not match len(mainline)'
1017
' %s != %s' % (last_revno, len(real_rev_history)))
1018
# TODO: We should probably also check that real_rev_history actually
1019
# matches self.revision_history()
1020
for revision_id in real_rev_history:
1022
revision = self.repository.get_revision(revision_id)
1023
except errors.NoSuchRevision, e:
1024
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1026
# In general the first entry on the revision history has no parents.
1027
# But it's not illegal for it to have parents listed; this can happen
1028
# in imports from Arch when the parents weren't reachable.
1029
if mainline_parent_id is not None:
1030
if mainline_parent_id not in revision.parent_ids:
1031
raise errors.BzrCheckError("previous revision {%s} not listed among "
1033
% (mainline_parent_id, revision_id))
1034
mainline_parent_id = revision_id
1035
return BranchCheckResult(self)
1322
1037
def _get_checkout_format(self):
1323
1038
"""Return the most suitable metadir for a checkout of this branch.
1335
1050
def create_clone_on_transport(self, to_transport, revision_id=None,
1336
stacked_on=None, create_prefix=False, use_existing_dir=False):
1337
1052
"""Create a clone of this branch and its bzrdir.
1339
1054
:param to_transport: The transport to clone onto.
1340
1055
:param revision_id: The revision id to use as tip in the new branch.
1341
1056
If None the tip is obtained from this branch.
1342
1057
:param stacked_on: An optional URL to stack the clone on.
1343
:param create_prefix: Create any missing directories leading up to
1345
:param use_existing_dir: Use an existing directory if one exists.
1347
1059
# XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1060
# clone call. Or something. 20090224 RBC/spiv.
1349
if revision_id is None:
1350
revision_id = self.last_revision()
1351
1061
dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
revision_id=revision_id, stacked_on=stacked_on,
1353
create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1062
revision_id=revision_id, stacked_on=stacked_on)
1354
1063
return dir_to.open_branch()
1356
1065
def create_checkout(self, to_location, revision_id=None,
1411
1119
reconciler.reconcile()
1412
1120
return reconciler
1414
def reference_parent(self, file_id, path, possible_transports=None):
1122
def reference_parent(self, file_id, path):
1415
1123
"""Return the parent branch for a tree-reference file_id
1416
1124
:param file_id: The file_id of the tree reference
1417
1125
:param path: The path of the file_id in the tree
1418
1126
:return: A branch associated with the file_id
1420
1128
# FIXME should provide multiple branches, based on config
1421
return Branch.open(self.bzrdir.root_transport.clone(path).base,
1422
possible_transports=possible_transports)
1129
return Branch.open(self.bzrdir.root_transport.clone(path).base)
1424
1131
def supports_tags(self):
1425
1132
return self._format.supports_tags()
1427
def automatic_tag_name(self, revision_id):
1428
"""Try to automatically find the tag name for a revision.
1430
:param revision_id: Revision id of the revision.
1431
:return: A tag name or None if no tag name could be determined.
1433
for hook in Branch.hooks['automatic_tag_name']:
1434
ret = hook(self, revision_id)
1439
1134
def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1441
1136
"""Ensure that revision_b is a descendant of revision_a.
1554
1247
"""Return the short format description for this format."""
1555
1248
raise NotImplementedError(self.get_format_description)
1557
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1558
hooks = Branch.hooks['post_branch_init']
1561
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1565
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1566
lock_type='metadir', set_format=True):
1250
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1567
1252
"""Initialize a branch in a bzrdir, with specified files
1569
1254
:param a_bzrdir: The bzrdir to initialize the branch in
1570
1255
:param utf8_files: The files to create as a list of
1571
1256
(filename, content) tuples
1572
:param name: Name of colocated branch to create, if any
1573
1257
:param set_format: If True, set the format with
1574
1258
self.get_format_string. (BzrBranch4 has its format set
1576
1260
:return: a branch in this format
1578
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1262
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1263
branch_transport = a_bzrdir.get_branch_transport(self)
1581
1265
'metadir': ('lock', lockdir.LockDir),
1582
1266
'branch4': ('branch-lock', lockable_files.TransportLock),
1765
1431
"multiple hooks installed for transform_fallback_location, "
1766
1432
"all are called with the url returned from the previous hook."
1767
1433
"The order is however undefined.", (1, 9), None))
1768
self.create_hook(HookPoint('automatic_tag_name',
1769
"Called to determine an automatic tag name for a revision."
1770
"automatic_tag_name is called with (branch, revision_id) and "
1771
"should return a tag name or None if no tag name could be "
1772
"determined. The first non-None tag name returned will be used.",
1774
self.create_hook(HookPoint('post_branch_init',
1775
"Called after new branch initialization completes. "
1776
"post_branch_init is called with a "
1777
"bzrlib.branch.BranchInitHookParams. "
1778
"Note that init, branch and checkout (both heavyweight and "
1779
"lightweight) will all trigger this hook.", (2, 2), None))
1780
self.create_hook(HookPoint('post_switch',
1781
"Called after a checkout switches branch. "
1782
"post_switch is called with a "
1783
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1787
1436
# install the default hooks into the Branch class.
1826
1475
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1829
class BranchInitHookParams(object):
1830
"""Object holding parameters passed to *_branch_init hooks.
1832
There are 4 fields that hooks may wish to access:
1834
:ivar format: the branch format
1835
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1836
:ivar name: name of colocated branch, if any (or None)
1837
:ivar branch: the branch created
1839
Note that for lightweight checkouts, the bzrdir and format fields refer to
1840
the checkout, hence they are different from the corresponding fields in
1841
branch, which refer to the original branch.
1844
def __init__(self, format, a_bzrdir, name, branch):
1845
"""Create a group of BranchInitHook parameters.
1847
:param format: the branch format
1848
:param a_bzrdir: the BzrDir where the branch will be/has been
1850
:param name: name of colocated branch, if any (or None)
1851
:param branch: the branch created
1853
Note that for lightweight checkouts, the bzrdir and format fields refer
1854
to the checkout, hence they are different from the corresponding fields
1855
in branch, which refer to the original branch.
1857
self.format = format
1858
self.bzrdir = a_bzrdir
1860
self.branch = branch
1862
def __eq__(self, other):
1863
return self.__dict__ == other.__dict__
1867
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1869
return "<%s of format:%s bzrdir:%s>" % (
1870
self.__class__.__name__, self.branch,
1871
self.format, self.bzrdir)
1874
class SwitchHookParams(object):
1875
"""Object holding parameters passed to *_switch hooks.
1877
There are 4 fields that hooks may wish to access:
1879
:ivar control_dir: BzrDir of the checkout to change
1880
:ivar to_branch: branch that the checkout is to reference
1881
:ivar force: skip the check for local commits in a heavy checkout
1882
:ivar revision_id: revision ID to switch to (or None)
1885
def __init__(self, control_dir, to_branch, force, revision_id):
1886
"""Create a group of SwitchHook parameters.
1888
:param control_dir: BzrDir of the checkout to change
1889
:param to_branch: branch that the checkout is to reference
1890
:param force: skip the check for local commits in a heavy checkout
1891
:param revision_id: revision ID to switch to (or None)
1893
self.control_dir = control_dir
1894
self.to_branch = to_branch
1896
self.revision_id = revision_id
1898
def __eq__(self, other):
1899
return self.__dict__ == other.__dict__
1902
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1903
self.control_dir, self.to_branch,
1907
1478
class BzrBranchFormat4(BranchFormat):
1908
1479
"""Bzr branch format 4.
1962
1532
return self.get_format_string()
1964
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1534
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1965
1535
"""See BranchFormat.open()."""
1967
format = BranchFormat.find_format(a_bzrdir, name=name)
1537
format = BranchFormat.find_format(a_bzrdir)
1968
1538
if format.__class__ != self.__class__:
1969
1539
raise AssertionError("wrong format %r found for %r" %
1970
1540
(format, self))
1971
transport = a_bzrdir.get_branch_transport(None, name=name)
1542
transport = a_bzrdir.get_branch_transport(None)
1973
1543
control_files = lockable_files.LockableFiles(transport, 'lock',
1974
1544
lockdir.LockDir)
1975
1545
return self._branch_class()(_format=self,
1976
1546
_control_files=control_files,
1978
1547
a_bzrdir=a_bzrdir,
1979
1548
_repository=a_bzrdir.find_repository(),
1980
1549
ignore_fallbacks=ignore_fallbacks)
1981
1550
except errors.NoSuchFile:
1982
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1551
raise errors.NotBranchError(path=transport.base)
1984
1553
def __init__(self):
1985
1554
super(BranchFormatMetadir, self).__init__()
2047
1616
"""See BranchFormat.get_format_description()."""
2048
1617
return "Branch format 6"
2050
def initialize(self, a_bzrdir, name=None):
2051
"""Create a branch of this format in a_bzrdir."""
2052
utf8_files = [('last-revision', '0 null:\n'),
2053
('branch.conf', ''),
2056
return self._initialize_helper(a_bzrdir, utf8_files, name)
2058
def make_tags(self, branch):
2059
"""See bzrlib.branch.BranchFormat.make_tags()."""
2060
return BasicTags(branch)
2062
def supports_set_append_revisions_only(self):
2066
class BzrBranchFormat8(BranchFormatMetadir):
2067
"""Metadir format supporting storing locations of subtree branches."""
2069
def _branch_class(self):
2072
def get_format_string(self):
2073
"""See BranchFormat.get_format_string()."""
2074
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2076
def get_format_description(self):
2077
"""See BranchFormat.get_format_description()."""
2078
return "Branch format 8"
2080
def initialize(self, a_bzrdir, name=None):
2081
"""Create a branch of this format in a_bzrdir."""
2082
utf8_files = [('last-revision', '0 null:\n'),
2083
('branch.conf', ''),
2087
return self._initialize_helper(a_bzrdir, utf8_files, name)
2090
super(BzrBranchFormat8, self).__init__()
2091
self._matchingbzrdir.repository_format = \
2092
RepositoryFormatKnitPack5RichRoot()
2094
def make_tags(self, branch):
2095
"""See bzrlib.branch.BranchFormat.make_tags()."""
2096
return BasicTags(branch)
2098
def supports_set_append_revisions_only(self):
2101
def supports_stacking(self):
2104
supports_reference_locations = True
2107
class BzrBranchFormat7(BzrBranchFormat8):
1619
def initialize(self, a_bzrdir):
1620
"""Create a branch of this format in a_bzrdir."""
1621
utf8_files = [('last-revision', '0 null:\n'),
1622
('branch.conf', ''),
1625
return self._initialize_helper(a_bzrdir, utf8_files)
1627
def make_tags(self, branch):
1628
"""See bzrlib.branch.BranchFormat.make_tags()."""
1629
return BasicTags(branch)
1633
class BzrBranchFormat7(BranchFormatMetadir):
2108
1634
"""Branch format with last-revision, tags, and a stacked location pointer.
2110
1636
The stacked location pointer is passed down to the repository and requires
2160
1693
def get_reference(self, a_bzrdir):
2161
1694
"""See BranchFormat.get_reference()."""
2162
1695
transport = a_bzrdir.get_branch_transport(None)
2163
return transport.get_bytes('location')
1696
return transport.get('location').read()
2165
1698
def set_reference(self, a_bzrdir, to_branch):
2166
1699
"""See BranchFormat.set_reference()."""
2167
1700
transport = a_bzrdir.get_branch_transport(None)
2168
1701
location = transport.put_bytes('location', to_branch.base)
2170
def initialize(self, a_bzrdir, name=None, target_branch=None):
1703
def initialize(self, a_bzrdir, target_branch=None):
2171
1704
"""Create a branch of this format in a_bzrdir."""
2172
1705
if target_branch is None:
2173
1706
# this format does not implement branch itself, thus the implicit
2174
1707
# creation contract must see it as uninitializable
2175
1708
raise errors.UninitializableFormat(self)
2176
mutter('creating branch reference in %s', a_bzrdir.user_url)
2177
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1709
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1710
branch_transport = a_bzrdir.get_branch_transport(self)
2178
1711
branch_transport.put_bytes('location',
2179
target_branch.bzrdir.user_url)
1712
target_branch.bzrdir.root_transport.base)
2180
1713
branch_transport.put_bytes('format', self.get_format_string())
2182
a_bzrdir, name, _found=True,
1715
a_bzrdir, _found=True,
2183
1716
possible_transports=[target_branch.bzrdir.root_transport])
2184
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2187
1718
def __init__(self):
2188
1719
super(BranchReferenceFormat, self).__init__()
2194
1725
def clone(to_bzrdir, revision_id=None,
2195
1726
repository_policy=None):
2196
1727
"""See Branch.clone()."""
2197
return format.initialize(to_bzrdir, target_branch=a_branch)
1728
return format.initialize(to_bzrdir, a_branch)
2198
1729
# cannot obey revision_id limits when cloning a reference ...
2199
1730
# FIXME RBC 20060210 either nuke revision_id for clone, or
2200
1731
# emit some sort of warning/error to the caller ?!
2203
def open(self, a_bzrdir, name=None, _found=False, location=None,
1734
def open(self, a_bzrdir, _found=False, location=None,
2204
1735
possible_transports=None, ignore_fallbacks=False):
2205
1736
"""Return the branch that the branch reference in a_bzrdir points at.
2207
1738
:param a_bzrdir: A BzrDir that contains a branch.
2208
:param name: Name of colocated branch to open, if any
2209
1739
:param _found: a private parameter, do not use it. It is used to
2210
1740
indicate if format probing has already be done.
2211
1741
:param ignore_fallbacks: when set, no fallback branches will be opened
2318
1838
base = property(_get_base, doc="The URL for the root of this branch.")
2320
def _get_config(self):
2321
return TransportConfig(self._transport, 'branch.conf')
2323
1840
def is_locked(self):
2324
1841
return self.control_files.is_locked()
2326
1843
def lock_write(self, token=None):
2327
if not self.is_locked():
2328
self._note_lock('w')
2329
# All-in-one needs to always unlock/lock.
2330
repo_control = getattr(self.repository, 'control_files', None)
2331
if self.control_files == repo_control or not self.is_locked():
2332
self.repository._warn_if_deprecated(self)
2333
self.repository.lock_write()
1844
repo_token = self.repository.lock_write()
2338
return self.control_files.lock_write(token=token)
1846
token = self.control_files.lock_write(token=token)
2341
self.repository.unlock()
1848
self.repository.unlock()
2344
1852
def lock_read(self):
2345
if not self.is_locked():
2346
self._note_lock('r')
2347
# All-in-one needs to always unlock/lock.
2348
repo_control = getattr(self.repository, 'control_files', None)
2349
if self.control_files == repo_control or not self.is_locked():
2350
self.repository._warn_if_deprecated(self)
2351
self.repository.lock_read()
1853
self.repository.lock_read()
2356
1855
self.control_files.lock_read()
2359
self.repository.unlock()
1857
self.repository.unlock()
2362
@only_raises(errors.LockNotHeld, errors.LockBroken)
2363
1860
def unlock(self):
1861
# TODO: test for failed two phase locks. This is known broken.
2365
1863
self.control_files.unlock()
2367
# All-in-one needs to always unlock/lock.
2368
repo_control = getattr(self.repository, 'control_files', None)
2369
if (self.control_files == repo_control or
2370
not self.control_files.is_locked()):
2371
self.repository.unlock()
2372
if not self.control_files.is_locked():
2373
# we just released the lock
2374
self._clear_cached_state()
1865
self.repository.unlock()
1866
if not self.control_files.is_locked():
1867
# we just released the lock
1868
self._clear_cached_state()
2376
1870
def peek_lock_mode(self):
2377
1871
if self.control_files._lock_count == 0:
2496
1990
"""See Branch.basis_tree."""
2497
1991
return self.repository.revision_tree(self.last_revision())
1994
def pull(self, source, overwrite=False, stop_revision=None,
1995
_hook_master=None, run_hooks=True, possible_transports=None,
1996
_override_hook_target=None):
1999
:param _hook_master: Private parameter - set the branch to
2000
be supplied as the master to pull hooks.
2001
:param run_hooks: Private parameter - if false, this branch
2002
is being called because it's the master of the primary branch,
2003
so it should not run its hooks.
2004
:param _override_hook_target: Private parameter - set the branch to be
2005
supplied as the target_branch to pull hooks.
2007
result = PullResult()
2008
result.source_branch = source
2009
if _override_hook_target is None:
2010
result.target_branch = self
2012
result.target_branch = _override_hook_target
2015
# We assume that during 'pull' the local repository is closer than
2017
graph = self.repository.get_graph(source.repository)
2018
result.old_revno, result.old_revid = self.last_revision_info()
2019
self.update_revisions(source, stop_revision, overwrite=overwrite,
2021
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
2022
result.new_revno, result.new_revid = self.last_revision_info()
2024
result.master_branch = _hook_master
2025
result.local_branch = result.target_branch
2027
result.master_branch = result.target_branch
2028
result.local_branch = None
2030
for hook in Branch.hooks['post_pull']:
2499
2036
def _get_parent_location(self):
2500
2037
_locs = ['parent', 'pull', 'x-pull']
2501
2038
for l in _locs:
2046
def push(self, target, overwrite=False, stop_revision=None,
2047
_override_hook_source_branch=None):
2050
This is the basic concrete implementation of push()
2052
:param _override_hook_source_branch: If specified, run
2053
the hooks passing this Branch as the source, rather than self.
2054
This is for use of RemoteBranch, where push is delegated to the
2055
underlying vfs-based Branch.
2057
# TODO: Public option to disable running hooks - should be trivial but
2059
return _run_with_write_locked_target(
2060
target, self._push_with_bound_branches, target, overwrite,
2062
_override_hook_source_branch=_override_hook_source_branch)
2064
def _push_with_bound_branches(self, target, overwrite,
2066
_override_hook_source_branch=None):
2067
"""Push from self into target, and into target's master if any.
2069
This is on the base BzrBranch class even though it doesn't support
2070
bound branches because the *target* might be bound.
2073
if _override_hook_source_branch:
2074
result.source_branch = _override_hook_source_branch
2075
for hook in Branch.hooks['post_push']:
2078
bound_location = target.get_bound_location()
2079
if bound_location and target.base != bound_location:
2080
# there is a master branch.
2082
# XXX: Why the second check? Is it even supported for a branch to
2083
# be bound to itself? -- mbp 20070507
2084
master_branch = target.get_master_branch()
2085
master_branch.lock_write()
2087
# push into the master from this branch.
2088
self._basic_push(master_branch, overwrite, stop_revision)
2089
# and push into the target branch from this. Note that we push from
2090
# this branch again, because its considered the highest bandwidth
2092
result = self._basic_push(target, overwrite, stop_revision)
2093
result.master_branch = master_branch
2094
result.local_branch = target
2098
master_branch.unlock()
2101
result = self._basic_push(target, overwrite, stop_revision)
2102
# TODO: Why set master_branch and local_branch if there's no
2103
# binding? Maybe cleaner to just leave them unset? -- mbp
2105
result.master_branch = target
2106
result.local_branch = None
2508
2110
def _basic_push(self, target, overwrite, stop_revision):
2509
2111
"""Basic implementation of push without bound branches or hooks.
2511
Must be called with source read locked and target write locked.
2113
Must be called with self read locked and target write locked.
2513
2115
result = BranchPushResult()
2514
2116
result.source_branch = self
2515
2117
result.target_branch = target
2516
2118
result.old_revno, result.old_revid = target.last_revision_info()
2517
self.update_references(target)
2518
2119
if result.old_revid != self.last_revision():
2519
2120
# We assume that during 'push' this repository is closer than
2521
2122
graph = self.repository.get_graph(target.repository)
2522
target.update_revisions(self, stop_revision,
2523
overwrite=overwrite, graph=graph)
2123
target.update_revisions(self, stop_revision, overwrite=overwrite,
2524
2125
if self._push_should_merge_tags():
2525
result.tag_conflicts = self.tags.merge_to(target.tags,
2126
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2527
2127
result.new_revno, result.new_revid = target.last_revision_info()
2530
2130
def get_stacked_on_url(self):
2531
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2131
raise errors.UnstackableBranchFormat(self._format, self.base)
2533
2133
def set_push_location(self, location):
2534
2134
"""See Branch.set_push_location."""
2550
2171
It has support for a master_branch which is the data for bound branches.
2175
def pull(self, source, overwrite=False, stop_revision=None,
2176
run_hooks=True, possible_transports=None,
2177
_override_hook_target=None):
2178
"""Pull from source into self, updating my master if any.
2180
:param run_hooks: Private parameter - if false, this branch
2181
is being called because it's the master of the primary branch,
2182
so it should not run its hooks.
2184
bound_location = self.get_bound_location()
2185
master_branch = None
2186
if bound_location and source.base != bound_location:
2187
# not pulling from master, so we need to update master.
2188
master_branch = self.get_master_branch(possible_transports)
2189
master_branch.lock_write()
2192
# pull from source into master.
2193
master_branch.pull(source, overwrite, stop_revision,
2195
return super(BzrBranch5, self).pull(source, overwrite,
2196
stop_revision, _hook_master=master_branch,
2197
run_hooks=run_hooks,
2198
_override_hook_target=_override_hook_target)
2201
master_branch.unlock()
2553
2203
def get_bound_location(self):
2555
2205
return self._transport.get_bytes('bound')[:-1]
2663
2325
"None, not a URL." % hook_name)
2664
2326
self._activate_fallback_location(url)
2328
def _check_stackable_repo(self):
2329
if not self.repository._format.supports_external_lookups:
2330
raise errors.UnstackableRepositoryFormat(self.repository._format,
2331
self.repository.base)
2666
2333
def __init__(self, *args, **kwargs):
2667
2334
self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2668
super(BzrBranch8, self).__init__(*args, **kwargs)
2335
super(BzrBranch7, self).__init__(*args, **kwargs)
2669
2336
self._last_revision_info_cache = None
2670
self._reference_info = None
2337
self._partial_revision_history_cache = []
2672
2339
def _clear_cached_state(self):
2673
super(BzrBranch8, self)._clear_cached_state()
2340
super(BzrBranch7, self)._clear_cached_state()
2674
2341
self._last_revision_info_cache = None
2675
self._reference_info = None
2342
self._partial_revision_history_cache = []
2677
2344
def _last_revision_info(self):
2678
2345
revision_string = self._transport.get_bytes('last-revision')
2733
2400
self._extend_partial_history(stop_index=last_revno-1)
2734
2401
return list(reversed(self._partial_revision_history_cache))
2403
def _extend_partial_history(self, stop_index=None, stop_revision=None):
2404
"""Extend the partial history to include a given index
2406
If a stop_index is supplied, stop when that index has been reached.
2407
If a stop_revision is supplied, stop when that revision is
2408
encountered. Otherwise, stop when the beginning of history is
2411
:param stop_index: The index which should be present. When it is
2412
present, history extension will stop.
2413
:param revision_id: The revision id which should be present. When
2414
it is encountered, history extension will stop.
2416
repo = self.repository
2417
if len(self._partial_revision_history_cache) == 0:
2418
iterator = repo.iter_reverse_revision_history(self.last_revision())
2420
start_revision = self._partial_revision_history_cache[-1]
2421
iterator = repo.iter_reverse_revision_history(start_revision)
2422
#skip the last revision in the list
2423
next_revision = iterator.next()
2424
for revision_id in iterator:
2425
self._partial_revision_history_cache.append(revision_id)
2426
if (stop_index is not None and
2427
len(self._partial_revision_history_cache) > stop_index):
2429
if revision_id == stop_revision:
2736
2432
def _write_revision_history(self, history):
2737
2433
"""Factored out of set_revision_history.
2759
2455
"""Set the parent branch"""
2760
2456
return self._get_config_location('parent_location')
2763
def _set_all_reference_info(self, info_dict):
2764
"""Replace all reference info stored in a branch.
2766
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2769
writer = rio.RioWriter(s)
2770
for key, (tree_path, branch_location) in info_dict.iteritems():
2771
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2772
branch_location=branch_location)
2773
writer.write_stanza(stanza)
2774
self._transport.put_bytes('references', s.getvalue())
2775
self._reference_info = info_dict
2778
def _get_all_reference_info(self):
2779
"""Return all the reference info stored in a branch.
2781
:return: A dict of {file_id: (tree_path, branch_location)}
2783
if self._reference_info is not None:
2784
return self._reference_info
2785
rio_file = self._transport.get('references')
2787
stanzas = rio.read_stanzas(rio_file)
2788
info_dict = dict((s['file_id'], (s['tree_path'],
2789
s['branch_location'])) for s in stanzas)
2792
self._reference_info = info_dict
2795
def set_reference_info(self, file_id, tree_path, branch_location):
2796
"""Set the branch location to use for a tree reference.
2798
:param file_id: The file-id of the tree reference.
2799
:param tree_path: The path of the tree reference in the tree.
2800
:param branch_location: The location of the branch to retrieve tree
2803
info_dict = self._get_all_reference_info()
2804
info_dict[file_id] = (tree_path, branch_location)
2805
if None in (tree_path, branch_location):
2806
if tree_path is not None:
2807
raise ValueError('tree_path must be None when branch_location'
2809
if branch_location is not None:
2810
raise ValueError('branch_location must be None when tree_path'
2812
del info_dict[file_id]
2813
self._set_all_reference_info(info_dict)
2815
def get_reference_info(self, file_id):
2816
"""Get the tree_path and branch_location for a tree reference.
2818
:return: a tuple of (tree_path, branch_location)
2820
return self._get_all_reference_info().get(file_id, (None, None))
2822
def reference_parent(self, file_id, path, possible_transports=None):
2823
"""Return the parent branch for a tree-reference file_id.
2825
:param file_id: The file_id of the tree reference
2826
:param path: The path of the file_id in the tree
2827
:return: A branch associated with the file_id
2829
branch_location = self.get_reference_info(file_id)[1]
2830
if branch_location is None:
2831
return Branch.reference_parent(self, file_id, path,
2832
possible_transports)
2833
branch_location = urlutils.join(self.user_url, branch_location)
2834
return Branch.open(branch_location,
2835
possible_transports=possible_transports)
2837
2458
def set_push_location(self, location):
2838
2459
"""See Branch.set_push_location."""
2839
2460
self._set_config_location('push_location', location)
2881
2502
raise errors.NotStacked(self)
2882
2503
return stacked_url
2505
def set_append_revisions_only(self, enabled):
2510
self.get_config().set_user_option('append_revisions_only', value,
2513
def set_stacked_on_url(self, url):
2514
self._check_stackable_repo()
2517
old_url = self.get_stacked_on_url()
2518
except (errors.NotStacked, errors.UnstackableBranchFormat,
2519
errors.UnstackableRepositoryFormat):
2522
# repositories don't offer an interface to remove fallback
2523
# repositories today; take the conceptually simpler option and just
2525
self.repository = self.bzrdir.find_repository()
2526
# for every revision reference the branch has, ensure it is pulled
2528
source_repository = self._get_fallback_repository(old_url)
2529
for revision_id in chain([self.last_revision()],
2530
self.tags.get_reverse_tag_dict()):
2531
self.repository.fetch(source_repository, revision_id,
2534
self._activate_fallback_location(url)
2535
# write this out after the repository is stacked to avoid setting a
2536
# stacked config that doesn't work.
2537
self._set_config_location('stacked_on_location', url)
2884
2539
def _get_append_revisions_only(self):
2885
return self.get_config(
2886
).get_user_option_as_bool('append_revisions_only')
2540
value = self.get_config().get_user_option('append_revisions_only')
2541
return value == 'True'
2888
2543
@needs_write_lock
2889
2544
def generate_revision_history(self, revision_id, last_rev=None,
3234
2849
self.source.unlock()
3236
def pull(self, overwrite=False, stop_revision=None,
3237
possible_transports=None, _hook_master=None, run_hooks=True,
3238
_override_hook_target=None, local=False):
3241
:param _hook_master: Private parameter - set the branch to
3242
be supplied as the master to pull hooks.
3243
:param run_hooks: Private parameter - if false, this branch
3244
is being called because it's the master of the primary branch,
3245
so it should not run its hooks.
3246
:param _override_hook_target: Private parameter - set the branch to be
3247
supplied as the target_branch to pull hooks.
3248
:param local: Only update the local branch, and not the bound branch.
3250
# This type of branch can't be bound.
3252
raise errors.LocalRequiresBoundBranch()
3253
result = PullResult()
3254
result.source_branch = self.source
3255
if _override_hook_target is None:
3256
result.target_branch = self.target
3258
result.target_branch = _override_hook_target
3259
self.source.lock_read()
3261
# We assume that during 'pull' the target repository is closer than
3263
self.source.update_references(self.target)
3264
graph = self.target.repository.get_graph(self.source.repository)
3265
# TODO: Branch formats should have a flag that indicates
3266
# that revno's are expensive, and pull() should honor that flag.
3268
result.old_revno, result.old_revid = \
3269
self.target.last_revision_info()
3270
self.target.update_revisions(self.source, stop_revision,
3271
overwrite=overwrite, graph=graph)
3272
# TODO: The old revid should be specified when merging tags,
3273
# so a tags implementation that versions tags can only
3274
# pull in the most recent changes. -- JRV20090506
3275
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3277
result.new_revno, result.new_revid = self.target.last_revision_info()
3279
result.master_branch = _hook_master
3280
result.local_branch = result.target_branch
3282
result.master_branch = result.target_branch
3283
result.local_branch = None
3285
for hook in Branch.hooks['post_pull']:
3288
self.source.unlock()
3291
def push(self, overwrite=False, stop_revision=None,
3292
_override_hook_source_branch=None):
3293
"""See InterBranch.push.
3295
This is the basic concrete implementation of push()
3297
:param _override_hook_source_branch: If specified, run
3298
the hooks passing this Branch as the source, rather than self.
3299
This is for use of RemoteBranch, where push is delegated to the
3300
underlying vfs-based Branch.
3302
# TODO: Public option to disable running hooks - should be trivial but
3304
self.source.lock_read()
3306
return _run_with_write_locked_target(
3307
self.target, self._push_with_bound_branches, overwrite,
3309
_override_hook_source_branch=_override_hook_source_branch)
3311
self.source.unlock()
3313
def _push_with_bound_branches(self, overwrite, stop_revision,
3314
_override_hook_source_branch=None):
3315
"""Push from source into target, and into target's master if any.
3318
if _override_hook_source_branch:
3319
result.source_branch = _override_hook_source_branch
3320
for hook in Branch.hooks['post_push']:
3323
bound_location = self.target.get_bound_location()
3324
if bound_location and self.target.base != bound_location:
3325
# there is a master branch.
3327
# XXX: Why the second check? Is it even supported for a branch to
3328
# be bound to itself? -- mbp 20070507
3329
master_branch = self.target.get_master_branch()
3330
master_branch.lock_write()
3332
# push into the master from the source branch.
3333
self.source._basic_push(master_branch, overwrite, stop_revision)
3334
# and push into the target branch from the source. Note that we
3335
# push from the source branch again, because its considered the
3336
# highest bandwidth repository.
3337
result = self.source._basic_push(self.target, overwrite,
3339
result.master_branch = master_branch
3340
result.local_branch = self.target
3344
master_branch.unlock()
3347
result = self.source._basic_push(self.target, overwrite,
3349
# TODO: Why set master_branch and local_branch if there's no
3350
# binding? Maybe cleaner to just leave them unset? -- mbp
3352
result.master_branch = self.target
3353
result.local_branch = None
3358
2852
def is_compatible(self, source, target):
3359
2853
# GenericBranch uses the public API, so always compatible
3363
class InterToBranch5(GenericInterBranch):
3366
def _get_branch_formats_to_test():
3367
return BranchFormat._default_format, BzrBranchFormat5()
3369
def pull(self, overwrite=False, stop_revision=None,
3370
possible_transports=None, run_hooks=True,
3371
_override_hook_target=None, local=False):
3372
"""Pull from source into self, updating my master if any.
3374
:param run_hooks: Private parameter - if false, this branch
3375
is being called because it's the master of the primary branch,
3376
so it should not run its hooks.
3378
bound_location = self.target.get_bound_location()
3379
if local and not bound_location:
3380
raise errors.LocalRequiresBoundBranch()
3381
master_branch = None
3382
if not local and bound_location and self.source.user_url != bound_location:
3383
# not pulling from master, so we need to update master.
3384
master_branch = self.target.get_master_branch(possible_transports)
3385
master_branch.lock_write()
3388
# pull from source into master.
3389
master_branch.pull(self.source, overwrite, stop_revision,
3391
return super(InterToBranch5, self).pull(overwrite,
3392
stop_revision, _hook_master=master_branch,
3393
run_hooks=run_hooks,
3394
_override_hook_target=_override_hook_target)
3397
master_branch.unlock()
3400
2857
InterBranch.register_optimiser(GenericInterBranch)
3401
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
