478
396
"""Iterate over an inclusive range of sorted revisions."""
479
397
rev_iter = iter(merge_sorted_revisions)
480
398
if start_revision_id is not None:
481
for node in rev_iter:
482
rev_id = node.key[-1]
399
for rev_id, depth, revno, end_of_merge in rev_iter:
483
400
if rev_id != start_revision_id:
486
403
# The decision to include the start or not
487
404
# depends on the stop_rule if a stop is provided
488
# so pop this node back into the iterator
489
rev_iter = chain(iter([node]), rev_iter)
406
iter([(rev_id, depth, revno, end_of_merge)]),
491
409
if stop_revision_id is None:
493
for node in rev_iter:
494
rev_id = node.key[-1]
495
yield (rev_id, node.merge_depth, node.revno,
410
for rev_id, depth, revno, end_of_merge in rev_iter:
411
yield rev_id, depth, revno, end_of_merge
497
412
elif stop_rule == 'exclude':
498
for node in rev_iter:
499
rev_id = node.key[-1]
413
for rev_id, depth, revno, end_of_merge in rev_iter:
500
414
if rev_id == stop_revision_id:
502
yield (rev_id, node.merge_depth, node.revno,
416
yield rev_id, depth, revno, end_of_merge
504
417
elif stop_rule == 'include':
505
for node in rev_iter:
506
rev_id = node.key[-1]
507
yield (rev_id, node.merge_depth, node.revno,
418
for rev_id, depth, revno, end_of_merge in rev_iter:
419
yield rev_id, depth, revno, end_of_merge
509
420
if rev_id == stop_revision_id:
511
elif stop_rule == 'with-merges-without-common-ancestry':
512
# We want to exclude all revisions that are already part of the
513
# stop_revision_id ancestry.
514
graph = self.repository.get_graph()
515
ancestors = graph.find_unique_ancestors(start_revision_id,
517
for node in rev_iter:
518
rev_id = node.key[-1]
519
if rev_id not in ancestors:
521
yield (rev_id, node.merge_depth, node.revno,
523
422
elif stop_rule == 'with-merges':
524
423
stop_rev = self.repository.get_revision(stop_revision_id)
525
424
if stop_rev.parent_ids:
526
425
left_parent = stop_rev.parent_ids[0]
528
427
left_parent = _mod_revision.NULL_REVISION
529
# left_parent is the actual revision we want to stop logging at,
530
# since we want to show the merged revisions after the stop_rev too
531
reached_stop_revision_id = False
532
revision_id_whitelist = []
533
for node in rev_iter:
534
rev_id = node.key[-1]
428
for rev_id, depth, revno, end_of_merge in rev_iter:
535
429
if rev_id == left_parent:
536
# reached the left parent after the stop_revision
538
if (not reached_stop_revision_id or
539
rev_id in revision_id_whitelist):
540
yield (rev_id, node.merge_depth, node.revno,
542
if reached_stop_revision_id or rev_id == stop_revision_id:
543
# only do the merged revs of rev_id from now on
544
rev = self.repository.get_revision(rev_id)
546
reached_stop_revision_id = True
547
revision_id_whitelist.extend(rev.parent_ids)
431
yield rev_id, depth, revno, end_of_merge
549
433
raise ValueError('invalid stop_rule %r' % stop_rule)
551
def _filter_start_non_ancestors(self, rev_iter):
552
# If we started from a dotted revno, we want to consider it as a tip
553
# and don't want to yield revisions that are not part of its
554
# ancestry. Given the order guaranteed by the merge sort, we will see
555
# uninteresting descendants of the first parent of our tip before the
557
first = rev_iter.next()
558
(rev_id, merge_depth, revno, end_of_merge) = first
561
# We start at a mainline revision so by definition, all others
562
# revisions in rev_iter are ancestors
563
for node in rev_iter:
568
pmap = self.repository.get_parent_map([rev_id])
569
parents = pmap.get(rev_id, [])
571
whitelist.update(parents)
573
# If there is no parents, there is nothing of interest left
575
# FIXME: It's hard to test this scenario here as this code is never
576
# called in that case. -- vila 20100322
579
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
581
if rev_id in whitelist:
582
pmap = self.repository.get_parent_map([rev_id])
583
parents = pmap.get(rev_id, [])
584
whitelist.remove(rev_id)
585
whitelist.update(parents)
587
# We've reached the mainline, there is nothing left to
591
# A revision that is not part of the ancestry of our
594
yield (rev_id, merge_depth, revno, end_of_merge)
596
435
def leave_lock_in_place(self):
597
436
"""Tell this branch object not to release the physical lock when this
598
437
object is unlocked.
756
563
:raises UnstackableRepositoryFormat: If the repository does not support
759
if not self._format.supports_stacking():
760
raise errors.UnstackableBranchFormat(self._format, self.user_url)
761
# XXX: Changing from one fallback repository to another does not check
762
# that all the data you need is present in the new fallback.
763
# Possibly it should.
764
self._check_stackable_repo()
767
old_url = self.get_stacked_on_url()
768
except (errors.NotStacked, errors.UnstackableBranchFormat,
769
errors.UnstackableRepositoryFormat):
773
self._activate_fallback_location(url)
774
# write this out after the repository is stacked to avoid setting a
775
# stacked config that doesn't work.
776
self._set_config_location('stacked_on_location', url)
779
"""Change a branch to be unstacked, copying data as needed.
781
Don't call this directly, use set_stacked_on_url(None).
783
pb = ui.ui_factory.nested_progress_bar()
785
pb.update("Unstacking")
786
# The basic approach here is to fetch the tip of the branch,
787
# including all available ghosts, from the existing stacked
788
# repository into a new repository object without the fallbacks.
790
# XXX: See <https://launchpad.net/bugs/397286> - this may not be
791
# correct for CHKMap repostiories
792
old_repository = self.repository
793
if len(old_repository._fallback_repositories) != 1:
794
raise AssertionError("can't cope with fallback repositories "
795
"of %r" % (self.repository,))
796
# unlock it, including unlocking the fallback
797
old_repository.unlock()
798
old_repository.lock_read()
800
# Repositories don't offer an interface to remove fallback
801
# repositories today; take the conceptually simpler option and just
802
# reopen it. We reopen it starting from the URL so that we
803
# get a separate connection for RemoteRepositories and can
804
# stream from one of them to the other. This does mean doing
805
# separate SSH connection setup, but unstacking is not a
806
# common operation so it's tolerable.
807
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
808
new_repository = new_bzrdir.find_repository()
809
self.repository = new_repository
810
if self.repository._fallback_repositories:
811
raise AssertionError("didn't expect %r to have "
812
"fallback_repositories"
813
% (self.repository,))
814
# this is not paired with an unlock because it's just restoring
815
# the previous state; the lock's released when set_stacked_on_url
817
self.repository.lock_write()
818
# XXX: If you unstack a branch while it has a working tree
819
# with a pending merge, the pending-merged revisions will no
820
# longer be present. You can (probably) revert and remerge.
822
# XXX: This only fetches up to the tip of the repository; it
823
# doesn't bring across any tags. That's fairly consistent
824
# with how branch works, but perhaps not ideal.
825
self.repository.fetch(old_repository,
826
revision_id=self.last_revision(),
829
old_repository.unlock()
833
def _set_tags_bytes(self, bytes):
834
"""Mirror method for _get_tags_bytes.
836
:seealso: Branch._get_tags_bytes.
838
return _run_with_write_locked_target(self, self._transport.put_bytes,
566
raise NotImplementedError(self.set_stacked_on_url)
841
568
def _cache_revision_history(self, rev_history):
842
569
"""Set the cached revision history to rev_history.
1001
730
except ValueError:
1002
731
raise errors.NoSuchRevision(self, revision_id)
1005
733
def get_rev_id(self, revno, history=None):
1006
734
"""Find the revision id of the specified revno."""
1008
736
return _mod_revision.NULL_REVISION
1009
last_revno, last_revid = self.last_revision_info()
1010
if revno == last_revno:
1012
if revno <= 0 or revno > last_revno:
738
history = self.revision_history()
739
if revno <= 0 or revno > len(history):
1013
740
raise errors.NoSuchRevision(self, revno)
1014
distance_from_last = last_revno - revno
1015
if len(self._partial_revision_history_cache) <= distance_from_last:
1016
self._extend_partial_history(distance_from_last)
1017
return self._partial_revision_history_cache[distance_from_last]
741
return history[revno - 1]
1020
743
def pull(self, source, overwrite=False, stop_revision=None,
1021
possible_transports=None, *args, **kwargs):
744
possible_transports=None, _override_hook_target=None):
1022
745
"""Mirror source into this branch.
1024
747
This branch is considered to be 'local', having low latency.
1026
749
:returns: PullResult instance
1028
return InterBranch.get(source, self).pull(overwrite=overwrite,
1029
stop_revision=stop_revision,
1030
possible_transports=possible_transports, *args, **kwargs)
751
raise NotImplementedError(self.pull)
1032
def push(self, target, overwrite=False, stop_revision=None, *args,
753
def push(self, target, overwrite=False, stop_revision=None):
1034
754
"""Mirror this branch into target.
1036
756
This branch is considered to be 'local', having low latency.
1038
return InterBranch.get(self, target).push(overwrite, stop_revision,
1041
def lossy_push(self, target, stop_revision=None):
1042
"""Push deltas into another branch.
1044
:note: This does not, like push, retain the revision ids from
1045
the source branch and will, rather than adding bzr-specific
1046
metadata, push only those semantics of the revision that can be
1047
natively represented by this branch' VCS.
1049
:param target: Target branch
1050
:param stop_revision: Revision to push, defaults to last revision.
1051
:return: BranchPushResult with an extra member revidmap:
1052
A dictionary mapping revision ids from the target branch
1053
to new revision ids in the target branch, for each
1054
revision that was pushed.
1056
inter = InterBranch.get(self, target)
1057
lossy_push = getattr(inter, "lossy_push", None)
1058
if lossy_push is None:
1059
raise errors.LossyPushToSameVCS(self, target)
1060
return lossy_push(stop_revision)
758
raise NotImplementedError(self.push)
1062
760
def basis_tree(self):
1063
761
"""Return `Tree` object for last revision."""
1312
992
Callers will typically also want to check the repository.
1314
:param refs: Calculated refs for this branch as specified by
1315
branch._get_check_refs()
1316
994
:return: A BranchCheckResult.
1318
result = BranchCheckResult(self)
996
mainline_parent_id = None
1319
997
last_revno, last_revision_id = self.last_revision_info()
1320
actual_revno = refs[('lefthand-distance', last_revision_id)]
1321
if actual_revno != last_revno:
1322
result.errors.append(errors.BzrCheckError(
1323
'revno does not match len(mainline) %s != %s' % (
1324
last_revno, actual_revno)))
1325
# TODO: We should probably also check that self.revision_history
1326
# matches the repository for older branch formats.
1327
# If looking for the code that cross-checks repository parents against
1328
# the iter_reverse_revision_history output, that is now a repository
998
real_rev_history = list(self.repository.iter_reverse_revision_history(
1000
real_rev_history.reverse()
1001
if len(real_rev_history) != last_revno:
1002
raise errors.BzrCheckError('revno does not match len(mainline)'
1003
' %s != %s' % (last_revno, len(real_rev_history)))
1004
# TODO: We should probably also check that real_rev_history actually
1005
# matches self.revision_history()
1006
for revision_id in real_rev_history:
1008
revision = self.repository.get_revision(revision_id)
1009
except errors.NoSuchRevision, e:
1010
raise errors.BzrCheckError("mainline revision {%s} not in repository"
1012
# In general the first entry on the revision history has no parents.
1013
# But it's not illegal for it to have parents listed; this can happen
1014
# in imports from Arch when the parents weren't reachable.
1015
if mainline_parent_id is not None:
1016
if mainline_parent_id not in revision.parent_ids:
1017
raise errors.BzrCheckError("previous revision {%s} not listed among "
1019
% (mainline_parent_id, revision_id))
1020
mainline_parent_id = revision_id
1021
return BranchCheckResult(self)
1332
1023
def _get_checkout_format(self):
1333
1024
"""Return the most suitable metadir for a checkout of this branch.
1568
1233
"""Return the short format description for this format."""
1569
1234
raise NotImplementedError(self.get_format_description)
1571
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1572
hooks = Branch.hooks['post_branch_init']
1575
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1579
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1580
lock_type='metadir', set_format=True):
1236
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1581
1238
"""Initialize a branch in a bzrdir, with specified files
1583
1240
:param a_bzrdir: The bzrdir to initialize the branch in
1584
1241
:param utf8_files: The files to create as a list of
1585
1242
(filename, content) tuples
1586
:param name: Name of colocated branch to create, if any
1587
1243
:param set_format: If True, set the format with
1588
1244
self.get_format_string. (BzrBranch4 has its format set
1590
1246
:return: a branch in this format
1592
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1593
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1248
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1249
branch_transport = a_bzrdir.get_branch_transport(self)
1595
1251
'metadir': ('lock', lockdir.LockDir),
1596
1252
'branch4': ('branch-lock', lockable_files.TransportLock),
1721
1342
Hooks.__init__(self)
1722
self.create_hook(HookPoint('set_rh',
1723
"Invoked whenever the revision history has been set via "
1724
"set_revision_history. The api signature is (branch, "
1725
"revision_history), and the branch will be write-locked. "
1726
"The set_rh hook can be expensive for bzr to trigger, a better "
1727
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1728
self.create_hook(HookPoint('open',
1729
"Called with the Branch object that has been opened after a "
1730
"branch is opened.", (1, 8), None))
1731
self.create_hook(HookPoint('post_push',
1732
"Called after a push operation completes. post_push is called "
1733
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1734
"bzr client.", (0, 15), None))
1735
self.create_hook(HookPoint('post_pull',
1736
"Called after a pull operation completes. post_pull is called "
1737
"with a bzrlib.branch.PullResult object and only runs in the "
1738
"bzr client.", (0, 15), None))
1739
self.create_hook(HookPoint('pre_commit',
1740
"Called after a commit is calculated but before it is is "
1741
"completed. pre_commit is called with (local, master, old_revno, "
1742
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1743
"). old_revid is NULL_REVISION for the first commit to a branch, "
1744
"tree_delta is a TreeDelta object describing changes from the "
1745
"basis revision. hooks MUST NOT modify this delta. "
1746
" future_tree is an in-memory tree obtained from "
1747
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1748
"tree.", (0,91), None))
1749
self.create_hook(HookPoint('post_commit',
1750
"Called in the bzr client after a commit has completed. "
1751
"post_commit is called with (local, master, old_revno, old_revid, "
1752
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1753
"commit to a branch.", (0, 15), None))
1754
self.create_hook(HookPoint('post_uncommit',
1755
"Called in the bzr client after an uncommit completes. "
1756
"post_uncommit is called with (local, master, old_revno, "
1757
"old_revid, new_revno, new_revid) where local is the local branch "
1758
"or None, master is the target branch, and an empty branch "
1759
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1760
self.create_hook(HookPoint('pre_change_branch_tip',
1761
"Called in bzr client and server before a change to the tip of a "
1762
"branch is made. pre_change_branch_tip is called with a "
1763
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1764
"commit, uncommit will all trigger this hook.", (1, 6), None))
1765
self.create_hook(HookPoint('post_change_branch_tip',
1766
"Called in bzr client and server after a change to the tip of a "
1767
"branch is made. post_change_branch_tip is called with a "
1768
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1769
"commit, uncommit will all trigger this hook.", (1, 4), None))
1770
self.create_hook(HookPoint('transform_fallback_location',
1771
"Called when a stacked branch is activating its fallback "
1772
"locations. transform_fallback_location is called with (branch, "
1773
"url), and should return a new url. Returning the same url "
1774
"allows it to be used as-is, returning a different one can be "
1775
"used to cause the branch to stack on a closer copy of that "
1776
"fallback_location. Note that the branch cannot have history "
1777
"accessing methods called on it during this hook because the "
1778
"fallback locations have not been activated. When there are "
1779
"multiple hooks installed for transform_fallback_location, "
1780
"all are called with the url returned from the previous hook."
1781
"The order is however undefined.", (1, 9), None))
1782
self.create_hook(HookPoint('automatic_tag_name',
1783
"Called to determine an automatic tag name for a revision."
1784
"automatic_tag_name is called with (branch, revision_id) and "
1785
"should return a tag name or None if no tag name could be "
1786
"determined. The first non-None tag name returned will be used.",
1788
self.create_hook(HookPoint('post_branch_init',
1789
"Called after new branch initialization completes. "
1790
"post_branch_init is called with a "
1791
"bzrlib.branch.BranchInitHookParams. "
1792
"Note that init, branch and checkout (both heavyweight and "
1793
"lightweight) will all trigger this hook.", (2, 2), None))
1794
self.create_hook(HookPoint('post_switch',
1795
"Called after a checkout switches branch. "
1796
"post_switch is called with a "
1797
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1343
# Introduced in 0.15:
1344
# invoked whenever the revision history has been set
1345
# with set_revision_history. The api signature is
1346
# (branch, revision_history), and the branch will
1349
# Invoked after a branch is opened. The api signature is (branch).
1351
# invoked after a push operation completes.
1352
# the api signature is
1354
# containing the members
1355
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1356
# where local is the local target branch or None, master is the target
1357
# master branch, and the rest should be self explanatory. The source
1358
# is read locked and the target branches write locked. Source will
1359
# be the local low-latency branch.
1360
self['post_push'] = []
1361
# invoked after a pull operation completes.
1362
# the api signature is
1364
# containing the members
1365
# (source, local, master, old_revno, old_revid, new_revno, new_revid)
1366
# where local is the local branch or None, master is the target
1367
# master branch, and the rest should be self explanatory. The source
1368
# is read locked and the target branches write locked. The local
1369
# branch is the low-latency branch.
1370
self['post_pull'] = []
1371
# invoked before a commit operation takes place.
1372
# the api signature is
1373
# (local, master, old_revno, old_revid, future_revno, future_revid,
1374
# tree_delta, future_tree).
1375
# old_revid is NULL_REVISION for the first commit to a branch
1376
# tree_delta is a TreeDelta object describing changes from the basis
1377
# revision, hooks MUST NOT modify this delta
1378
# future_tree is an in-memory tree obtained from
1379
# CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
1380
self['pre_commit'] = []
1381
# invoked after a commit operation completes.
1382
# the api signature is
1383
# (local, master, old_revno, old_revid, new_revno, new_revid)
1384
# old_revid is NULL_REVISION for the first commit to a branch.
1385
self['post_commit'] = []
1386
# invoked after a uncommit operation completes.
1387
# the api signature is
1388
# (local, master, old_revno, old_revid, new_revno, new_revid) where
1389
# local is the local branch or None, master is the target branch,
1390
# and an empty branch recieves new_revno of 0, new_revid of None.
1391
self['post_uncommit'] = []
1393
# Invoked before the tip of a branch changes.
1394
# the api signature is
1395
# (params) where params is a ChangeBranchTipParams with the members
1396
# (branch, old_revno, new_revno, old_revid, new_revid)
1397
self['pre_change_branch_tip'] = []
1399
# Invoked after the tip of a branch changes.
1400
# the api signature is
1401
# (params) where params is a ChangeBranchTipParams with the members
1402
# (branch, old_revno, new_revno, old_revid, new_revid)
1403
self['post_change_branch_tip'] = []
1405
# Invoked when a stacked branch activates its fallback locations and
1406
# allows the transformation of the url of said location.
1407
# the api signature is
1408
# (branch, url) where branch is the branch having its fallback
1409
# location activated and url is the url for the fallback location.
1410
# The hook should return a url.
1411
self['transform_fallback_location'] = []
1801
1414
# install the default hooks into the Branch class.
1840
1453
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1843
class BranchInitHookParams(object):
1844
"""Object holding parameters passed to *_branch_init hooks.
1846
There are 4 fields that hooks may wish to access:
1848
:ivar format: the branch format
1849
:ivar bzrdir: the BzrDir where the branch will be/has been initialized
1850
:ivar name: name of colocated branch, if any (or None)
1851
:ivar branch: the branch created
1853
Note that for lightweight checkouts, the bzrdir and format fields refer to
1854
the checkout, hence they are different from the corresponding fields in
1855
branch, which refer to the original branch.
1858
def __init__(self, format, a_bzrdir, name, branch):
1859
"""Create a group of BranchInitHook parameters.
1861
:param format: the branch format
1862
:param a_bzrdir: the BzrDir where the branch will be/has been
1864
:param name: name of colocated branch, if any (or None)
1865
:param branch: the branch created
1867
Note that for lightweight checkouts, the bzrdir and format fields refer
1868
to the checkout, hence they are different from the corresponding fields
1869
in branch, which refer to the original branch.
1871
self.format = format
1872
self.bzrdir = a_bzrdir
1874
self.branch = branch
1876
def __eq__(self, other):
1877
return self.__dict__ == other.__dict__
1881
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1883
return "<%s of format:%s bzrdir:%s>" % (
1884
self.__class__.__name__, self.branch,
1885
self.format, self.bzrdir)
1888
class SwitchHookParams(object):
1889
"""Object holding parameters passed to *_switch hooks.
1891
There are 4 fields that hooks may wish to access:
1893
:ivar control_dir: BzrDir of the checkout to change
1894
:ivar to_branch: branch that the checkout is to reference
1895
:ivar force: skip the check for local commits in a heavy checkout
1896
:ivar revision_id: revision ID to switch to (or None)
1899
def __init__(self, control_dir, to_branch, force, revision_id):
1900
"""Create a group of SwitchHook parameters.
1902
:param control_dir: BzrDir of the checkout to change
1903
:param to_branch: branch that the checkout is to reference
1904
:param force: skip the check for local commits in a heavy checkout
1905
:param revision_id: revision ID to switch to (or None)
1907
self.control_dir = control_dir
1908
self.to_branch = to_branch
1910
self.revision_id = revision_id
1912
def __eq__(self, other):
1913
return self.__dict__ == other.__dict__
1916
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1917
self.control_dir, self.to_branch,
1921
1456
class BzrBranchFormat4(BranchFormat):
1922
1457
"""Bzr branch format 4.
2061
1601
"""See BranchFormat.get_format_description()."""
2062
1602
return "Branch format 6"
2064
def initialize(self, a_bzrdir, name=None):
2065
"""Create a branch of this format in a_bzrdir."""
2066
utf8_files = [('last-revision', '0 null:\n'),
2067
('branch.conf', ''),
2070
return self._initialize_helper(a_bzrdir, utf8_files, name)
2072
def make_tags(self, branch):
2073
"""See bzrlib.branch.BranchFormat.make_tags()."""
2074
return BasicTags(branch)
2076
def supports_set_append_revisions_only(self):
2080
class BzrBranchFormat8(BranchFormatMetadir):
2081
"""Metadir format supporting storing locations of subtree branches."""
2083
def _branch_class(self):
2086
def get_format_string(self):
2087
"""See BranchFormat.get_format_string()."""
2088
return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2090
def get_format_description(self):
2091
"""See BranchFormat.get_format_description()."""
2092
return "Branch format 8"
2094
def initialize(self, a_bzrdir, name=None):
2095
"""Create a branch of this format in a_bzrdir."""
2096
utf8_files = [('last-revision', '0 null:\n'),
2097
('branch.conf', ''),
2101
return self._initialize_helper(a_bzrdir, utf8_files, name)
2104
super(BzrBranchFormat8, self).__init__()
2105
self._matchingbzrdir.repository_format = \
2106
RepositoryFormatKnitPack5RichRoot()
2108
def make_tags(self, branch):
2109
"""See bzrlib.branch.BranchFormat.make_tags()."""
2110
return BasicTags(branch)
2112
def supports_set_append_revisions_only(self):
2115
def supports_stacking(self):
2118
supports_reference_locations = True
2121
class BzrBranchFormat7(BzrBranchFormat8):
1604
def initialize(self, a_bzrdir):
1605
"""Create a branch of this format in a_bzrdir."""
1606
utf8_files = [('last-revision', '0 null:\n'),
1607
('branch.conf', ''),
1610
return self._initialize_helper(a_bzrdir, utf8_files)
1613
class BzrBranchFormat7(BranchFormatMetadir):
2122
1614
"""Branch format with last-revision, tags, and a stacked location pointer.
2124
1616
The stacked location pointer is passed down to the repository and requires
2171
1666
"""See BranchFormat.get_format_description()."""
2172
1667
return "Checkout reference format 1"
2174
def get_reference(self, a_bzrdir, name=None):
1669
def get_reference(self, a_bzrdir):
2175
1670
"""See BranchFormat.get_reference()."""
2176
transport = a_bzrdir.get_branch_transport(None, name=name)
2177
return transport.get_bytes('location')
1671
transport = a_bzrdir.get_branch_transport(None)
1672
return transport.get('location').read()
2179
def set_reference(self, a_bzrdir, name, to_branch):
1674
def set_reference(self, a_bzrdir, to_branch):
2180
1675
"""See BranchFormat.set_reference()."""
2181
transport = a_bzrdir.get_branch_transport(None, name=name)
1676
transport = a_bzrdir.get_branch_transport(None)
2182
1677
location = transport.put_bytes('location', to_branch.base)
2184
def initialize(self, a_bzrdir, name=None, target_branch=None):
1679
def initialize(self, a_bzrdir, target_branch=None):
2185
1680
"""Create a branch of this format in a_bzrdir."""
2186
1681
if target_branch is None:
2187
1682
# this format does not implement branch itself, thus the implicit
2188
1683
# creation contract must see it as uninitializable
2189
1684
raise errors.UninitializableFormat(self)
2190
mutter('creating branch reference in %s', a_bzrdir.user_url)
2191
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1685
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1686
branch_transport = a_bzrdir.get_branch_transport(self)
2192
1687
branch_transport.put_bytes('location',
2193
target_branch.bzrdir.user_url)
1688
target_branch.bzrdir.root_transport.base)
2194
1689
branch_transport.put_bytes('format', self.get_format_string())
2196
a_bzrdir, name, _found=True,
1691
a_bzrdir, _found=True,
2197
1692
possible_transports=[target_branch.bzrdir.root_transport])
2198
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2201
1694
def __init__(self):
2202
1695
super(BranchReferenceFormat, self).__init__()
2208
1701
def clone(to_bzrdir, revision_id=None,
2209
1702
repository_policy=None):
2210
1703
"""See Branch.clone()."""
2211
return format.initialize(to_bzrdir, target_branch=a_branch)
1704
return format.initialize(to_bzrdir, a_branch)
2212
1705
# cannot obey revision_id limits when cloning a reference ...
2213
1706
# FIXME RBC 20060210 either nuke revision_id for clone, or
2214
1707
# emit some sort of warning/error to the caller ?!
2217
def open(self, a_bzrdir, name=None, _found=False, location=None,
2218
possible_transports=None, ignore_fallbacks=False):
1710
def open(self, a_bzrdir, _found=False, location=None,
1711
possible_transports=None):
2219
1712
"""Return the branch that the branch reference in a_bzrdir points at.
2221
:param a_bzrdir: A BzrDir that contains a branch.
2222
:param name: Name of colocated branch to open, if any
2223
:param _found: a private parameter, do not use it. It is used to
2224
indicate if format probing has already be done.
2225
:param ignore_fallbacks: when set, no fallback branches will be opened
2226
(if there are any). Default is to open fallbacks.
2227
:param location: The location of the referenced branch. If
2228
unspecified, this will be determined from the branch reference in
2230
:param possible_transports: An optional reusable transports list.
1714
_found is a private parameter, do not use it. It is used to indicate
1715
if format probing has already be done.
2233
format = BranchFormat.find_format(a_bzrdir, name=name)
1718
format = BranchFormat.find_format(a_bzrdir)
2234
1719
if format.__class__ != self.__class__:
2235
1720
raise AssertionError("wrong format %r found for %r" %
2236
1721
(format, self))
2237
1722
if location is None:
2238
location = self.get_reference(a_bzrdir, name)
1723
location = self.get_reference(a_bzrdir)
2239
1724
real_bzrdir = bzrdir.BzrDir.open(
2240
1725
location, possible_transports=possible_transports)
2241
result = real_bzrdir.open_branch(name=name,
2242
ignore_fallbacks=ignore_fallbacks)
1726
result = real_bzrdir.open_branch()
2243
1727
# this changes the behaviour of result.clone to create a new reference
2244
1728
# rather than a copy of the content of the branch.
2245
1729
# I did not use a proxy object because that needs much more extensive
2349
1806
base = property(_get_base, doc="The URL for the root of this branch.")
2351
def _get_config(self):
2352
return TransportConfig(self._transport, 'branch.conf')
2354
1808
def is_locked(self):
2355
1809
return self.control_files.is_locked()
2357
1811
def lock_write(self, token=None):
2358
"""Lock the branch for write operations.
2360
:param token: A token to permit reacquiring a previously held and
2362
:return: A BranchWriteLockResult.
2364
if not self.is_locked():
2365
self._note_lock('w')
2366
# All-in-one needs to always unlock/lock.
2367
repo_control = getattr(self.repository, 'control_files', None)
2368
if self.control_files == repo_control or not self.is_locked():
2369
self.repository._warn_if_deprecated(self)
2370
self.repository.lock_write()
1812
repo_token = self.repository.lock_write()
2375
return BranchWriteLockResult(self.unlock,
2376
self.control_files.lock_write(token=token))
1814
token = self.control_files.lock_write(token=token)
2379
self.repository.unlock()
1816
self.repository.unlock()
2382
1820
def lock_read(self):
2383
"""Lock the branch for read operations.
2385
:return: A bzrlib.lock.LogicalLockResult.
2387
if not self.is_locked():
2388
self._note_lock('r')
2389
# All-in-one needs to always unlock/lock.
2390
repo_control = getattr(self.repository, 'control_files', None)
2391
if self.control_files == repo_control or not self.is_locked():
2392
self.repository._warn_if_deprecated(self)
2393
self.repository.lock_read()
1821
self.repository.lock_read()
2398
1823
self.control_files.lock_read()
2399
return LogicalLockResult(self.unlock)
2402
self.repository.unlock()
1825
self.repository.unlock()
2405
@only_raises(errors.LockNotHeld, errors.LockBroken)
2406
1828
def unlock(self):
1829
# TODO: test for failed two phase locks. This is known broken.
2408
1831
self.control_files.unlock()
2410
# All-in-one needs to always unlock/lock.
2411
repo_control = getattr(self.repository, 'control_files', None)
2412
if (self.control_files == repo_control or
2413
not self.control_files.is_locked()):
2414
self.repository.unlock()
2415
if not self.control_files.is_locked():
2416
# we just released the lock
2417
self._clear_cached_state()
1833
self.repository.unlock()
1834
if not self.control_files.is_locked():
1835
# we just released the lock
1836
self._clear_cached_state()
2419
1838
def peek_lock_mode(self):
2420
1839
if self.control_files._lock_count == 0:
2539
1958
"""See Branch.basis_tree."""
2540
1959
return self.repository.revision_tree(self.last_revision())
1962
def pull(self, source, overwrite=False, stop_revision=None,
1963
_hook_master=None, run_hooks=True, possible_transports=None,
1964
_override_hook_target=None):
1967
:param _hook_master: Private parameter - set the branch to
1968
be supplied as the master to pull hooks.
1969
:param run_hooks: Private parameter - if false, this branch
1970
is being called because it's the master of the primary branch,
1971
so it should not run its hooks.
1972
:param _override_hook_target: Private parameter - set the branch to be
1973
supplied as the target_branch to pull hooks.
1975
result = PullResult()
1976
result.source_branch = source
1977
if _override_hook_target is None:
1978
result.target_branch = self
1980
result.target_branch = _override_hook_target
1983
# We assume that during 'pull' the local repository is closer than
1985
graph = self.repository.get_graph(source.repository)
1986
result.old_revno, result.old_revid = self.last_revision_info()
1987
self.update_revisions(source, stop_revision, overwrite=overwrite,
1989
result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
1990
result.new_revno, result.new_revid = self.last_revision_info()
1992
result.master_branch = _hook_master
1993
result.local_branch = result.target_branch
1995
result.master_branch = result.target_branch
1996
result.local_branch = None
1998
for hook in Branch.hooks['post_pull']:
2542
2004
def _get_parent_location(self):
2543
2005
_locs = ['parent', 'pull', 'x-pull']
2544
2006
for l in _locs:
2014
def push(self, target, overwrite=False, stop_revision=None,
2015
_override_hook_source_branch=None):
2018
This is the basic concrete implementation of push()
2020
:param _override_hook_source_branch: If specified, run
2021
the hooks passing this Branch as the source, rather than self.
2022
This is for use of RemoteBranch, where push is delegated to the
2023
underlying vfs-based Branch.
2025
# TODO: Public option to disable running hooks - should be trivial but
2027
return _run_with_write_locked_target(
2028
target, self._push_with_bound_branches, target, overwrite,
2030
_override_hook_source_branch=_override_hook_source_branch)
2032
def _push_with_bound_branches(self, target, overwrite,
2034
_override_hook_source_branch=None):
2035
"""Push from self into target, and into target's master if any.
2037
This is on the base BzrBranch class even though it doesn't support
2038
bound branches because the *target* might be bound.
2041
if _override_hook_source_branch:
2042
result.source_branch = _override_hook_source_branch
2043
for hook in Branch.hooks['post_push']:
2046
bound_location = target.get_bound_location()
2047
if bound_location and target.base != bound_location:
2048
# there is a master branch.
2050
# XXX: Why the second check? Is it even supported for a branch to
2051
# be bound to itself? -- mbp 20070507
2052
master_branch = target.get_master_branch()
2053
master_branch.lock_write()
2055
# push into the master from this branch.
2056
self._basic_push(master_branch, overwrite, stop_revision)
2057
# and push into the target branch from this. Note that we push from
2058
# this branch again, because its considered the highest bandwidth
2060
result = self._basic_push(target, overwrite, stop_revision)
2061
result.master_branch = master_branch
2062
result.local_branch = target
2066
master_branch.unlock()
2069
result = self._basic_push(target, overwrite, stop_revision)
2070
# TODO: Why set master_branch and local_branch if there's no
2071
# binding? Maybe cleaner to just leave them unset? -- mbp
2073
result.master_branch = target
2074
result.local_branch = None
2551
2078
def _basic_push(self, target, overwrite, stop_revision):
2552
2079
"""Basic implementation of push without bound branches or hooks.
2554
Must be called with source read locked and target write locked.
2081
Must be called with self read locked and target write locked.
2556
result = BranchPushResult()
2083
result = PushResult()
2557
2084
result.source_branch = self
2558
2085
result.target_branch = target
2559
2086
result.old_revno, result.old_revid = target.last_revision_info()
2560
self.update_references(target)
2561
2087
if result.old_revid != self.last_revision():
2562
2088
# We assume that during 'push' this repository is closer than
2564
2090
graph = self.repository.get_graph(target.repository)
2565
target.update_revisions(self, stop_revision,
2566
overwrite=overwrite, graph=graph)
2091
target.update_revisions(self, stop_revision, overwrite=overwrite,
2567
2093
if self._push_should_merge_tags():
2568
result.tag_conflicts = self.tags.merge_to(target.tags,
2094
result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2570
2095
result.new_revno, result.new_revid = target.last_revision_info()
2573
2098
def get_stacked_on_url(self):
2574
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2099
raise errors.UnstackableBranchFormat(self._format, self.base)
2576
2101
def set_push_location(self, location):
2577
2102
"""See Branch.set_push_location."""
2802
2420
"""Set the parent branch"""
2803
2421
return self._get_config_location('parent_location')
2806
def _set_all_reference_info(self, info_dict):
2807
"""Replace all reference info stored in a branch.
2809
:param info_dict: A dict of {file_id: (tree_path, branch_location)}
2812
writer = rio.RioWriter(s)
2813
for key, (tree_path, branch_location) in info_dict.iteritems():
2814
stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2815
branch_location=branch_location)
2816
writer.write_stanza(stanza)
2817
self._transport.put_bytes('references', s.getvalue())
2818
self._reference_info = info_dict
2821
def _get_all_reference_info(self):
2822
"""Return all the reference info stored in a branch.
2824
:return: A dict of {file_id: (tree_path, branch_location)}
2826
if self._reference_info is not None:
2827
return self._reference_info
2828
rio_file = self._transport.get('references')
2830
stanzas = rio.read_stanzas(rio_file)
2831
info_dict = dict((s['file_id'], (s['tree_path'],
2832
s['branch_location'])) for s in stanzas)
2835
self._reference_info = info_dict
2838
def set_reference_info(self, file_id, tree_path, branch_location):
2839
"""Set the branch location to use for a tree reference.
2841
:param file_id: The file-id of the tree reference.
2842
:param tree_path: The path of the tree reference in the tree.
2843
:param branch_location: The location of the branch to retrieve tree
2846
info_dict = self._get_all_reference_info()
2847
info_dict[file_id] = (tree_path, branch_location)
2848
if None in (tree_path, branch_location):
2849
if tree_path is not None:
2850
raise ValueError('tree_path must be None when branch_location'
2852
if branch_location is not None:
2853
raise ValueError('branch_location must be None when tree_path'
2855
del info_dict[file_id]
2856
self._set_all_reference_info(info_dict)
2858
def get_reference_info(self, file_id):
2859
"""Get the tree_path and branch_location for a tree reference.
2861
:return: a tuple of (tree_path, branch_location)
2863
return self._get_all_reference_info().get(file_id, (None, None))
2865
def reference_parent(self, file_id, path, possible_transports=None):
2866
"""Return the parent branch for a tree-reference file_id.
2868
:param file_id: The file_id of the tree reference
2869
:param path: The path of the file_id in the tree
2870
:return: A branch associated with the file_id
2872
branch_location = self.get_reference_info(file_id)[1]
2873
if branch_location is None:
2874
return Branch.reference_parent(self, file_id, path,
2875
possible_transports)
2876
branch_location = urlutils.join(self.user_url, branch_location)
2877
return Branch.open(branch_location,
2878
possible_transports=possible_transports)
2880
2423
def set_push_location(self, location):
2881
2424
"""See Branch.set_push_location."""
2882
2425
self._set_config_location('push_location', location)
3277
2810
self.source.unlock()
3279
def pull(self, overwrite=False, stop_revision=None,
3280
possible_transports=None, _hook_master=None, run_hooks=True,
3281
_override_hook_target=None, local=False):
3284
:param _hook_master: Private parameter - set the branch to
3285
be supplied as the master to pull hooks.
3286
:param run_hooks: Private parameter - if false, this branch
3287
is being called because it's the master of the primary branch,
3288
so it should not run its hooks.
3289
:param _override_hook_target: Private parameter - set the branch to be
3290
supplied as the target_branch to pull hooks.
3291
:param local: Only update the local branch, and not the bound branch.
3293
# This type of branch can't be bound.
3295
raise errors.LocalRequiresBoundBranch()
3296
result = PullResult()
3297
result.source_branch = self.source
3298
if _override_hook_target is None:
3299
result.target_branch = self.target
3301
result.target_branch = _override_hook_target
3302
self.source.lock_read()
3304
# We assume that during 'pull' the target repository is closer than
3306
self.source.update_references(self.target)
3307
graph = self.target.repository.get_graph(self.source.repository)
3308
# TODO: Branch formats should have a flag that indicates
3309
# that revno's are expensive, and pull() should honor that flag.
3311
result.old_revno, result.old_revid = \
3312
self.target.last_revision_info()
3313
self.target.update_revisions(self.source, stop_revision,
3314
overwrite=overwrite, graph=graph)
3315
# TODO: The old revid should be specified when merging tags,
3316
# so a tags implementation that versions tags can only
3317
# pull in the most recent changes. -- JRV20090506
3318
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3320
result.new_revno, result.new_revid = self.target.last_revision_info()
3322
result.master_branch = _hook_master
3323
result.local_branch = result.target_branch
3325
result.master_branch = result.target_branch
3326
result.local_branch = None
3328
for hook in Branch.hooks['post_pull']:
3331
self.source.unlock()
3334
def push(self, overwrite=False, stop_revision=None,
3335
_override_hook_source_branch=None):
3336
"""See InterBranch.push.
3338
This is the basic concrete implementation of push()
3340
:param _override_hook_source_branch: If specified, run
3341
the hooks passing this Branch as the source, rather than self.
3342
This is for use of RemoteBranch, where push is delegated to the
3343
underlying vfs-based Branch.
3345
# TODO: Public option to disable running hooks - should be trivial but
3347
self.source.lock_read()
3349
return _run_with_write_locked_target(
3350
self.target, self._push_with_bound_branches, overwrite,
3352
_override_hook_source_branch=_override_hook_source_branch)
3354
self.source.unlock()
3356
def _push_with_bound_branches(self, overwrite, stop_revision,
3357
_override_hook_source_branch=None):
3358
"""Push from source into target, and into target's master if any.
3361
if _override_hook_source_branch:
3362
result.source_branch = _override_hook_source_branch
3363
for hook in Branch.hooks['post_push']:
3366
bound_location = self.target.get_bound_location()
3367
if bound_location and self.target.base != bound_location:
3368
# there is a master branch.
3370
# XXX: Why the second check? Is it even supported for a branch to
3371
# be bound to itself? -- mbp 20070507
3372
master_branch = self.target.get_master_branch()
3373
master_branch.lock_write()
3375
# push into the master from the source branch.
3376
self.source._basic_push(master_branch, overwrite, stop_revision)
3377
# and push into the target branch from the source. Note that we
3378
# push from the source branch again, because its considered the
3379
# highest bandwidth repository.
3380
result = self.source._basic_push(self.target, overwrite,
3382
result.master_branch = master_branch
3383
result.local_branch = self.target
3387
master_branch.unlock()
3390
result = self.source._basic_push(self.target, overwrite,
3392
# TODO: Why set master_branch and local_branch if there's no
3393
# binding? Maybe cleaner to just leave them unset? -- mbp
3395
result.master_branch = self.target
3396
result.local_branch = None
3401
2813
def is_compatible(self, source, target):
3402
2814
# GenericBranch uses the public API, so always compatible
3406
class InterToBranch5(GenericInterBranch):
3409
def _get_branch_formats_to_test():
3410
return BranchFormat._default_format, BzrBranchFormat5()
3412
def pull(self, overwrite=False, stop_revision=None,
3413
possible_transports=None, run_hooks=True,
3414
_override_hook_target=None, local=False):
3415
"""Pull from source into self, updating my master if any.
3417
:param run_hooks: Private parameter - if false, this branch
3418
is being called because it's the master of the primary branch,
3419
so it should not run its hooks.
3421
bound_location = self.target.get_bound_location()
3422
if local and not bound_location:
3423
raise errors.LocalRequiresBoundBranch()
3424
master_branch = None
3425
if not local and bound_location and self.source.user_url != bound_location:
3426
# not pulling from master, so we need to update master.
3427
master_branch = self.target.get_master_branch(possible_transports)
3428
master_branch.lock_write()
3431
# pull from source into master.
3432
master_branch.pull(self.source, overwrite, stop_revision,
3434
return super(InterToBranch5, self).pull(overwrite,
3435
stop_revision, _hook_master=master_branch,
3436
run_hooks=run_hooks,
3437
_override_hook_target=_override_hook_target)
3440
master_branch.unlock()
3443
2818
InterBranch.register_optimiser(GenericInterBranch)
3444
InterBranch.register_optimiser(InterToBranch5)
added
removed
bzrlib/branch.py
