479
396
"""Iterate over an inclusive range of sorted revisions."""
480
397
rev_iter = iter(merge_sorted_revisions)
481
398
if start_revision_id is not None:
482
for node in rev_iter:
483
rev_id = node.key[-1]
399
for rev_id, depth, revno, end_of_merge in rev_iter:
484
400
if rev_id != start_revision_id:
487
403
# The decision to include the start or not
488
404
# 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)
406
iter([(rev_id, depth, revno, end_of_merge)]),
492
409
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,
410
for rev_id, depth, revno, end_of_merge in rev_iter:
411
yield rev_id, depth, revno, end_of_merge
498
412
elif stop_rule == 'exclude':
499
for node in rev_iter:
500
rev_id = node.key[-1]
413
for rev_id, depth, revno, end_of_merge in rev_iter:
501
414
if rev_id == stop_revision_id:
503
yield (rev_id, node.merge_depth, node.revno,
416
yield rev_id, depth, revno, end_of_merge
505
417
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,
418
for rev_id, depth, revno, end_of_merge in rev_iter:
419
yield rev_id, depth, revno, end_of_merge
510
420
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
422
elif stop_rule == 'with-merges':
525
423
stop_rev = self.repository.get_revision(stop_revision_id)
526
424
if stop_rev.parent_ids:
527
425
left_parent = stop_rev.parent_ids[0]
529
427
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]
428
for rev_id, depth, revno, end_of_merge in rev_iter:
536
429
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)
431
yield rev_id, depth, revno, end_of_merge
550
433
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
435
def leave_lock_in_place(self):
598
436
"""Tell this branch object not to release the physical lock when this
599
437
object is unlocked.
757
565
:raises UnstackableRepositoryFormat: If the repository does not support
760
if not self._format.supports_stacking():
761
raise errors.UnstackableBranchFormat(self._format, self.user_url)
762
# XXX: Changing from one fallback repository to another does not check
763
# that all the data you need is present in the new fallback.
764
# Possibly it should.
765
self._check_stackable_repo()
768
old_url = self.get_stacked_on_url()
769
except (errors.NotStacked, errors.UnstackableBranchFormat,
770
errors.UnstackableRepositoryFormat):
774
self._activate_fallback_location(url)
775
# write this out after the repository is stacked to avoid setting a
776
# stacked config that doesn't work.
777
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
def _set_tags_bytes(self, bytes):
835
"""Mirror method for _get_tags_bytes.
837
:seealso: Branch._get_tags_bytes.
839
return _run_with_write_locked_target(self, self._transport.put_bytes,
568
raise NotImplementedError(self.set_stacked_on_url)
842
570
def _cache_revision_history(self, rev_history):
843
571
"""Set the cached revision history to rev_history.
1002
718
except ValueError:
1003
719
raise errors.NoSuchRevision(self, revision_id)
1006
721
def get_rev_id(self, revno, history=None):
1007
722
"""Find the revision id of the specified revno."""
1009
724
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:
726
history = self.revision_history()
727
if revno <= 0 or revno > len(history):
1014
728
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]
729
return history[revno - 1]
1021
731
def pull(self, source, overwrite=False, stop_revision=None,
1022
possible_transports=None, *args, **kwargs):
732
possible_transports=None, _override_hook_target=None):
1023
733
"""Mirror source into this branch.
1025
735
This branch is considered to be 'local', having low latency.
1027
737
:returns: PullResult instance
1029
return InterBranch.get(source, self).pull(overwrite=overwrite,
1030
stop_revision=stop_revision,
1031
possible_transports=possible_transports, *args, **kwargs)
739
raise NotImplementedError(self.pull)
1033
def push(self, target, overwrite=False, stop_revision=None, *args,
741
def push(self, target, overwrite=False, stop_revision=None):
1035
742
"""Mirror this branch into target.
1037
744
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)
746
raise NotImplementedError(self.push)
1063
748
def basis_tree(self):
1064
749
"""Return `Tree` object for last revision."""
1313
965
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
967
:return: A BranchCheckResult.
1319
result = BranchCheckResult(self)
969
mainline_parent_id = None
1320
970
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
971
real_rev_history = list(self.repository.iter_reverse_revision_history(
973
real_rev_history.reverse()
974
if len(real_rev_history) != last_revno:
975
raise errors.BzrCheckError('revno does not match len(mainline)'
976
' %s != %s' % (last_revno, len(real_rev_history)))
977
# TODO: We should probably also check that real_rev_history actually
978
# matches self.revision_history()
979
for revision_id in real_rev_history:
981
revision = self.repository.get_revision(revision_id)
982
except errors.NoSuchRevision, e:
983
raise errors.BzrCheckError("mainline revision {%s} not in repository"
985
# In general the first entry on the revision history has no parents.
986
# But it's not illegal for it to have parents listed; this can happen
987
# in imports from Arch when the parents weren't reachable.
988
if mainline_parent_id is not None:
989
if mainline_parent_id not in revision.parent_ids:
990
raise errors.BzrCheckError("previous revision {%s} not listed among "
992
% (mainline_parent_id, revision_id))
993
mainline_parent_id = revision_id
994
return BranchCheckResult(self)
1333
996
def _get_checkout_format(self):
1334
997
"""Return the most suitable metadir for a checkout of this branch.
1565
1206
"""Return the short format description for this format."""
1566
1207
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):
1209
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1578
1211
"""Initialize a branch in a bzrdir, with specified files
1580
1213
:param a_bzrdir: The bzrdir to initialize the branch in
1581
1214
:param utf8_files: The files to create as a list of
1582
1215
(filename, content) tuples
1583
:param name: Name of colocated branch to create, if any
1584
1216
:param set_format: If True, set the format with
1585
1217
self.get_format_string. (BzrBranch4 has its format set
1587
1219
: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)
1221
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1222
branch_transport = a_bzrdir.get_branch_transport(self)
1592
1224
'metadir': ('lock', lockdir.LockDir),
1593
1225
'branch4': ('branch-lock', lockable_files.TransportLock),
1718
1314
Hooks.__init__(self)
1719
self.create_hook(HookPoint('set_rh',
1720
"Invoked whenever the revision history has been set via "
1721
"set_revision_history. The api signature is (branch, "
1722
"revision_history), and the branch will be write-locked. "
1723
"The set_rh hook can be expensive for bzr to trigger, a better "
1724
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1725
self.create_hook(HookPoint('open',
1726
"Called with the Branch object that has been opened after a "
1727
"branch is opened.", (1, 8), None))
1728
self.create_hook(HookPoint('post_push',
1729
"Called after a push operation completes. post_push is called "
1730
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1731
"bzr client.", (0, 15), None))
1732
self.create_hook(HookPoint('post_pull',
1733
"Called after a pull operation completes. post_pull is called "
1734
"with a bzrlib.branch.PullResult object and only runs in the "
1735
"bzr client.", (0, 15), None))
1736
self.create_hook(HookPoint('pre_commit',
1737
"Called after a commit is calculated but before it is is "
1738
"completed. pre_commit is called with (local, master, old_revno, "
1739
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1740
"). old_revid is NULL_REVISION for the first commit to a branch, "
1741
"tree_delta is a TreeDelta object describing changes from the "
1742
"basis revision. hooks MUST NOT modify this delta. "
1743
" future_tree is an in-memory tree obtained from "
1744
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1745
"tree.", (0,91), None))
1746
self.create_hook(HookPoint('post_commit',
1747
"Called in the bzr client after a commit has completed. "
1748
"post_commit is called with (local, master, old_revno, old_revid, "
1749
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1750
"commit to a branch.", (0, 15), None))
1751
self.create_hook(HookPoint('post_uncommit',
1752
"Called in the bzr client after an uncommit completes. "
1753
"post_uncommit is called with (local, master, old_revno, "
1754
"old_revid, new_revno, new_revid) where local is the local branch "
1755
"or None, master is the target branch, and an empty branch "
1756
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1757
self.create_hook(HookPoint('pre_change_branch_tip',
1758
"Called in bzr client and server before a change to the tip of a "
1759
"branch is made. pre_change_branch_tip is called with a "
1760
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1761
"commit, uncommit will all trigger this hook.", (1, 6), None))
1762
self.create_hook(HookPoint('post_change_branch_tip',
1763
"Called in bzr client and server after a change to the tip of a "
1764
"branch is made. post_change_branch_tip is called with a "
1765
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1766
"commit, uncommit will all trigger this hook.", (1, 4), None))
1767
self.create_hook(HookPoint('transform_fallback_location',
1768
"Called when a stacked branch is activating its fallback "
1769
"locations. transform_fallback_location is called with (branch, "
1770
"url), and should return a new url. Returning the same url "
1771
"allows it to be used as-is, returning a different one can be "
1772
"used to cause the branch to stack on a closer copy of that "
1773
"fallback_location. Note that the branch cannot have history "
1774
"accessing methods called on it during this hook because the "
1775
"fallback locations have not been activated. When there are "
1776
"multiple hooks installed for transform_fallback_location, "
1777
"all are called with the url returned from the previous hook."
1778
"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))
1315
# Introduced in 0.15:
1316
# invoked whenever the revision history has been set
1317
# with set_revision_history. The api signature is
1318
# (branch, revision_history), and the branch will
1321
# Invoked after a branch is opened. The api signature is (branch).
1323
# invoked after a push operation completes.
1324
# the api signature is
1326
# containing the members
1327
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1328
# where local is the local target branch or None, master is the target
1329
# master branch, and the rest should be self explanatory. The source
1330
# is read locked and the target branches write locked. Source will
1331
# be the local low-latency branch.
1332
self['post_push'] = []
1333
# invoked after a pull operation completes.
1334
# the api signature is
1336
# containing the members
1337
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1338
# where local is the local branch or None, master is the target
1339
# master branch, and the rest should be self explanatory. The source
1340
# is read locked and the target branches write locked. The local
1341
# branch is the low-latency branch.
1342
self['post_pull'] = []
1343
# invoked before a commit operation takes place.
1344
# the api signature is
1345
# (local, master, old_revno, old_revid, future_revno, future_revid,
1346
# tree_delta, future_tree).
1347
# old_revid is NULL_REVISION for the first commit to a branch
1348
# tree_delta is a TreeDelta object describing changes from the basis
1349
# revision, hooks MUST NOT modify this delta
1350
# future_tree is an in-memory tree obtained from
1351
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1352
self['pre_commit'] = []
1353
# invoked after a commit operation completes.
1354
# the api signature is
1355
# (local, master, old_revno, old_revid, new_revno, new_revid)
1356
# old_revid is NULL_REVISION for the first commit to a branch.
1357
self['post_commit'] = []
1358
# invoked after a uncommit operation completes.
1359
# the api signature is
1360
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1361
# local is the local branch or None, master is the target branch,
1362
# and an empty branch recieves new_revno of 0, new_revid of None.
1363
self['post_uncommit'] = []
1365
# Invoked before the tip of a branch changes.
1366
# the api signature is
1367
# (params) where params is a ChangeBranchTipParams with the members
1368
# (branch, old_revno, new_revno, old_revid, new_revid)
1369
self['pre_change_branch_tip'] = []
1371
# Invoked after the tip of a branch changes.
1372
# the api signature is
1373
# (params) where params is a ChangeBranchTipParams with the members
1374
# (branch, old_revno, new_revno, old_revid, new_revid)
1375
self['post_change_branch_tip'] = []
1377
# Invoked when a stacked branch activates its fallback locations and
1378
# allows the transformation of the url of said location.
1379
# the api signature is
1380
# (branch, url) where branch is the branch having its fallback
1381
# location activated and url is the url for the fallback location.
1382
# The hook should return a url.
1383
self['transform_fallback_location'] = []
1798
1386
# install the default hooks into the Branch class.
1837
1425
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
1428
class BzrBranchFormat4(BranchFormat):
1919
1429
"""Bzr branch format 4.
2058
1573
"""See BranchFormat.get_format_description()."""
2059
1574
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):
1576
def initialize(self, a_bzrdir):
1577
"""Create a branch of this format in a_bzrdir."""
1578
utf8_files = [('last-revision', '0 null:\n'),
1579
('branch.conf', ''),
1582
return self._initialize_helper(a_bzrdir, utf8_files)
1585
class BzrBranchFormat7(BranchFormatMetadir):
2119
1586
"""Branch format with last-revision, tags, and a stacked location pointer.
2121
1588
The stacked location pointer is passed down to the repository and requires
2171
1641
def get_reference(self, a_bzrdir):
2172
1642
"""See BranchFormat.get_reference()."""
2173
1643
transport = a_bzrdir.get_branch_transport(None)
2174
return transport.get_bytes('location')
1644
return transport.get('location').read()
2176
1646
def set_reference(self, a_bzrdir, to_branch):
2177
1647
"""See BranchFormat.set_reference()."""
2178
1648
transport = a_bzrdir.get_branch_transport(None)
2179
1649
location = transport.put_bytes('location', to_branch.base)
2181
def initialize(self, a_bzrdir, name=None, target_branch=None):
1651
def initialize(self, a_bzrdir, target_branch=None):
2182
1652
"""Create a branch of this format in a_bzrdir."""
2183
1653
if target_branch is None:
2184
1654
# this format does not implement branch itself, thus the implicit
2185
1655
# creation contract must see it as uninitializable
2186
1656
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)
1657
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1658
branch_transport = a_bzrdir.get_branch_transport(self)
2189
1659
branch_transport.put_bytes('location',
2190
target_branch.bzrdir.user_url)
1660
target_branch.bzrdir.root_transport.base)
2191
1661
branch_transport.put_bytes('format', self.get_format_string())
2193
a_bzrdir, name, _found=True,
1663
a_bzrdir, _found=True,
2194
1664
possible_transports=[target_branch.bzrdir.root_transport])
2195
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2198
1666
def __init__(self):
2199
1667
super(BranchReferenceFormat, self).__init__()
2205
1673
def clone(to_bzrdir, revision_id=None,
2206
1674
repository_policy=None):
2207
1675
"""See Branch.clone()."""
2208
return format.initialize(to_bzrdir, target_branch=a_branch)
1676
return format.initialize(to_bzrdir, a_branch)
2209
1677
# cannot obey revision_id limits when cloning a reference ...
2210
1678
# FIXME RBC 20060210 either nuke revision_id for clone, or
2211
1679
# emit some sort of warning/error to the caller ?!
2214
def open(self, a_bzrdir, name=None, _found=False, location=None,
2215
possible_transports=None, ignore_fallbacks=False):
1682
def open(self, a_bzrdir, _found=False, location=None,
1683
possible_transports=None):
2216
1684
"""Return the branch that the branch reference in a_bzrdir points at.
2218
:param a_bzrdir: A BzrDir that contains a branch.
2219
:param name: Name of colocated branch to open, if any
2220
:param _found: a private parameter, do not use it. It is used to
2221
indicate if format probing has already be done.
2222
:param ignore_fallbacks: when set, no fallback branches will be opened
2223
(if there are any). Default is to open fallbacks.
2224
:param location: The location of the referenced branch. If
2225
unspecified, this will be determined from the branch reference in
2227
:param possible_transports: An optional reusable transports list.
1686
_found is a private parameter, do not use it. It is used to indicate
1687
if format probing has already be done.
2230
format = BranchFormat.find_format(a_bzrdir, name=name)
1690
format = BranchFormat.find_format(a_bzrdir)
2231
1691
if format.__class__ != self.__class__:
2232
1692
raise AssertionError("wrong format %r found for %r" %
2233
1693
(format, self))
2342
1778
base = property(_get_base, doc="The URL for the root of this branch.")
2344
def _get_config(self):
2345
return TransportConfig(self._transport, 'branch.conf')
2347
1780
def is_locked(self):
2348
1781
return self.control_files.is_locked()
2350
1783
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()
1784
repo_token = self.repository.lock_write()
2368
return BranchWriteLockResult(self.unlock,
2369
self.control_files.lock_write(token=token))
1786
token = self.control_files.lock_write(token=token)
2372
self.repository.unlock()
1788
self.repository.unlock()
2375
1792
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()
1793
self.repository.lock_read()
2392
1795
self.control_files.lock_read()
2396
self.repository.unlock()
1797
self.repository.unlock()
2399
@only_raises(errors.LockNotHeld, errors.LockBroken)
2400
1800
def unlock(self):
1801
# TODO: test for failed two phase locks. This is known broken.
2402
1803
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()
1805
self.repository.unlock()
1806
if not self.control_files.is_locked():
1807
# we just released the lock
1808
self._clear_cached_state()
2413
1810
def peek_lock_mode(self):
2414
1811
if self.control_files._lock_count == 0:
2533
1930
"""See Branch.basis_tree."""
2534
1931
return self.repository.revision_tree(self.last_revision())
1934
def pull(self, source, overwrite=False, stop_revision=None,
1935
_hook_master=None, run_hooks=True, possible_transports=None,
1936
_override_hook_target=None):
1939
:param _hook_master: Private parameter - set the branch to
1940
be supplied as the master to pull hooks.
1941
:param run_hooks: Private parameter - if false, this branch
1942
is being called because it's the master of the primary branch,
1943
so it should not run its hooks.
1944
:param _override_hook_target: Private parameter - set the branch to be
1945
supplied as the target_branch to pull hooks.
1947
result = PullResult()
1948
result.source_branch = source
1949
if _override_hook_target is None:
1950
result.target_branch = self
1952
result.target_branch = _override_hook_target
1955
# We assume that during 'pull' the local repository is closer than
1957
graph = self.repository.get_graph(source.repository)
1958
result.old_revno, result.old_revid = self.last_revision_info()
1959
self.update_revisions(source, stop_revision, overwrite=overwrite,
1961
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1962
result.new_revno, result.new_revid = self.last_revision_info()
1964
result.master_branch = _hook_master
1965
result.local_branch = result.target_branch
1967
result.master_branch = result.target_branch
1968
result.local_branch = None
1970
for hook in Branch.hooks['post_pull']:
2536
1976
def _get_parent_location(self):
2537
1977
_locs = ['parent', 'pull', 'x-pull']
2538
1978
for l in _locs:
1986
def push(self, target, overwrite=False, stop_revision=None,
1987
_override_hook_source_branch=None):
1990
This is the basic concrete implementation of push()
1992
:param _override_hook_source_branch: If specified, run
1993
the hooks passing this Branch as the source, rather than self.
1994
This is for use of RemoteBranch, where push is delegated to the
1995
underlying vfs-based Branch.
1997
# TODO: Public option to disable running hooks - should be trivial but
1999
return _run_with_write_locked_target(
2000
target, self._push_with_bound_branches, target, overwrite,
2002
_override_hook_source_branch=_override_hook_source_branch)
2004
def _push_with_bound_branches(self, target, overwrite,
2006
_override_hook_source_branch=None):
2007
"""Push from self into target, and into target's master if any.
2009
This is on the base BzrBranch class even though it doesn't support
2010
bound branches because the *target* might be bound.
2013
if _override_hook_source_branch:
2014
result.source_branch = _override_hook_source_branch
2015
for hook in Branch.hooks['post_push']:
2018
bound_location = target.get_bound_location()
2019
if bound_location and target.base != bound_location:
2020
# there is a master branch.
2022
# XXX: Why the second check? Is it even supported for a branch to
2023
# be bound to itself? -- mbp 20070507
2024
master_branch = target.get_master_branch()
2025
master_branch.lock_write()
2027
# push into the master from this branch.
2028
self._basic_push(master_branch, overwrite, stop_revision)
2029
# and push into the target branch from this. Note that we push from
2030
# this branch again, because its considered the highest bandwidth
2032
result = self._basic_push(target, overwrite, stop_revision)
2033
result.master_branch = master_branch
2034
result.local_branch = target
2038
master_branch.unlock()
2041
result = self._basic_push(target, overwrite, stop_revision)
2042
# TODO: Why set master_branch and local_branch if there's no
2043
# binding? Maybe cleaner to just leave them unset? -- mbp
2045
result.master_branch = target
2046
result.local_branch = None
2545
2050
def _basic_push(self, target, overwrite, stop_revision):
2546
2051
"""Basic implementation of push without bound branches or hooks.
2548
Must be called with source read locked and target write locked.
2053
Must be called with self read locked and target write locked.
2550
result = BranchPushResult()
2055
result = PushResult()
2551
2056
result.source_branch = self
2552
2057
result.target_branch = target
2553
2058
result.old_revno, result.old_revid = target.last_revision_info()
2554
self.update_references(target)
2555
2059
if result.old_revid != self.last_revision():
2556
2060
# We assume that during 'push' this repository is closer than
2558
2062
graph = self.repository.get_graph(target.repository)
2559
target.update_revisions(self, stop_revision,
2560
overwrite=overwrite, graph=graph)
2063
target.update_revisions(self, stop_revision, overwrite=overwrite,
2561
2065
if self._push_should_merge_tags():
2562
result.tag_conflicts = self.tags.merge_to(target.tags,
2066
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2564
2067
result.new_revno, result.new_revid = target.last_revision_info()
2070
def get_parent(self):
2071
"""See Branch.get_parent."""
2072
parent = self._get_parent_location()
2075
# This is an old-format absolute path to a local branch
2076
# turn it into a url
2077
if parent.startswith('/'):
2078
parent = urlutils.local_path_to_url(parent.decode('utf8'))
2080
return urlutils.join(self.base[:-1], parent)
2081
except errors.InvalidURLJoin, e:
2082
raise errors.InaccessibleParent(parent, self.base)
2567
2084
def get_stacked_on_url(self):
2568
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2085
raise errors.UnstackableBranchFormat(self._format, self.base)
2570
2087
def set_push_location(self, location):
2571
2088
"""See Branch.set_push_location."""
2796
2406
"""Set the parent branch"""
2797
2407
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
2409
def set_push_location(self, location):
2875
2410
"""See Branch.set_push_location."""
2876
2411
self._set_config_location('push_location', location)
3271
2796
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
2799
def is_compatible(self, source, target):
3396
2800
# 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
2804
InterBranch.register_optimiser(GenericInterBranch)
3438
InterBranch.register_optimiser(InterToBranch5)