72
58
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
75
class Branch(controldir.ControlComponent):
61
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
62
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
66
# TODO: Maybe include checks for common corruption of newlines, etc?
68
# TODO: Some operations like log might retrieve the same revisions
69
# repeatedly to calculate deltas. We could perhaps have a weakref
70
# cache in memory to make this faster. In general anything can be
71
# cached in memory between lock and unlock operations. .. nb thats
72
# what the transaction identity map provides
75
######################################################################
76
79
"""Branch holding a history of revisions.
79
Base directory/url of the branch; using control_url and
80
control_transport is more standardized.
81
:ivar hooks: An instance of BranchHooks.
82
:ivar _master_branch_cache: cached result of get_master_branch, see
82
Base directory/url of the branch.
84
hooks: An instance of BranchHooks.
85
86
# this is really an instance variable - FIXME move it there
90
def control_transport(self):
91
return self._transport
94
def user_transport(self):
95
return self.bzrdir.user_transport
97
def __init__(self, possible_transports=None):
90
def __init__(self, *ignored, **ignored_too):
98
91
self.tags = self._format.make_tags(self)
99
92
self._revision_history_cache = None
100
93
self._revision_id_to_revno_cache = None
101
94
self._partial_revision_id_to_revno_cache = {}
102
95
self._partial_revision_history_cache = []
103
self._tags_bytes = None
104
96
self._last_revision_info_cache = None
105
self._master_branch_cache = None
106
97
self._merge_sorted_revisions_cache = None
107
self._open_hook(possible_transports)
108
99
hooks = Branch.hooks['open']
109
100
for hook in hooks:
112
def _open_hook(self, possible_transports):
103
def _open_hook(self):
113
104
"""Called by init to allow simpler extension of the base class."""
115
def _activate_fallback_location(self, url, possible_transports):
106
def _activate_fallback_location(self, url):
116
107
"""Activate the branch/repository from url as a fallback repository."""
117
for existing_fallback_repo in self.repository._fallback_repositories:
118
if existing_fallback_repo.user_url == url:
119
# This fallback is already configured. This probably only
120
# happens because ControlDir.sprout is a horrible mess. To avoid
121
# confusing _unstack we don't add this a second time.
122
mutter('duplicate activation of fallback %r on %r', url, self)
124
repo = self._get_fallback_repository(url, possible_transports)
108
repo = self._get_fallback_repository(url)
125
109
if repo.has_same_location(self.repository):
126
raise errors.UnstackableLocationError(self.user_url, url)
110
raise errors.UnstackableLocationError(self.base, url)
127
111
self.repository.add_fallback_repository(repo)
129
113
def break_lock(self):
527
468
rev_iter = iter(merge_sorted_revisions)
528
469
if start_revision_id is not None:
529
470
for node in rev_iter:
471
rev_id = node.key[-1]
531
472
if rev_id != start_revision_id:
534
475
# The decision to include the start or not
535
476
# depends on the stop_rule if a stop is provided
536
477
# so pop this node back into the iterator
537
rev_iter = itertools.chain(iter([node]), rev_iter)
478
rev_iter = chain(iter([node]), rev_iter)
539
480
if stop_revision_id is None:
540
481
# Yield everything
541
482
for node in rev_iter:
483
rev_id = node.key[-1]
543
484
yield (rev_id, node.merge_depth, node.revno,
544
485
node.end_of_merge)
545
486
elif stop_rule == 'exclude':
546
487
for node in rev_iter:
488
rev_id = node.key[-1]
548
489
if rev_id == stop_revision_id:
550
491
yield (rev_id, node.merge_depth, node.revno,
551
492
node.end_of_merge)
552
493
elif stop_rule == 'include':
553
494
for node in rev_iter:
495
rev_id = node.key[-1]
555
496
yield (rev_id, node.merge_depth, node.revno,
556
497
node.end_of_merge)
557
498
if rev_id == stop_revision_id:
559
elif stop_rule == 'with-merges-without-common-ancestry':
560
# We want to exclude all revisions that are already part of the
561
# stop_revision_id ancestry.
562
graph = self.repository.get_graph()
563
ancestors = graph.find_unique_ancestors(start_revision_id,
565
for node in rev_iter:
567
if rev_id not in ancestors:
569
yield (rev_id, node.merge_depth, node.revno,
571
500
elif stop_rule == 'with-merges':
572
501
stop_rev = self.repository.get_revision(stop_revision_id)
573
502
if stop_rev.parent_ids:
574
503
left_parent = stop_rev.parent_ids[0]
576
505
left_parent = _mod_revision.NULL_REVISION
577
# left_parent is the actual revision we want to stop logging at,
578
# since we want to show the merged revisions after the stop_rev too
579
reached_stop_revision_id = False
580
revision_id_whitelist = []
581
506
for node in rev_iter:
507
rev_id = node.key[-1]
583
508
if rev_id == left_parent:
584
# reached the left parent after the stop_revision
586
if (not reached_stop_revision_id or
587
rev_id in revision_id_whitelist):
588
yield (rev_id, node.merge_depth, node.revno,
510
yield (rev_id, node.merge_depth, node.revno,
589
511
node.end_of_merge)
590
if reached_stop_revision_id or rev_id == stop_revision_id:
591
# only do the merged revs of rev_id from now on
592
rev = self.repository.get_revision(rev_id)
594
reached_stop_revision_id = True
595
revision_id_whitelist.extend(rev.parent_ids)
597
513
raise ValueError('invalid stop_rule %r' % stop_rule)
599
def _filter_start_non_ancestors(self, rev_iter):
600
# If we started from a dotted revno, we want to consider it as a tip
601
# and don't want to yield revisions that are not part of its
602
# ancestry. Given the order guaranteed by the merge sort, we will see
603
# uninteresting descendants of the first parent of our tip before the
605
first = rev_iter.next()
606
(rev_id, merge_depth, revno, end_of_merge) = first
609
# We start at a mainline revision so by definition, all others
610
# revisions in rev_iter are ancestors
611
for node in rev_iter:
616
pmap = self.repository.get_parent_map([rev_id])
617
parents = pmap.get(rev_id, [])
619
whitelist.update(parents)
621
# If there is no parents, there is nothing of interest left
623
# FIXME: It's hard to test this scenario here as this code is never
624
# called in that case. -- vila 20100322
627
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
629
if rev_id in whitelist:
630
pmap = self.repository.get_parent_map([rev_id])
631
parents = pmap.get(rev_id, [])
632
whitelist.remove(rev_id)
633
whitelist.update(parents)
635
# We've reached the mainline, there is nothing left to
639
# A revision that is not part of the ancestry of our
642
yield (rev_id, merge_depth, revno, end_of_merge)
644
515
def leave_lock_in_place(self):
645
516
"""Tell this branch object not to release the physical lock when this
646
517
object is unlocked.
861
711
old_repository = self.repository
862
712
if len(old_repository._fallback_repositories) != 1:
863
713
raise AssertionError("can't cope with fallback repositories "
864
"of %r (fallbacks: %r)" % (old_repository,
865
old_repository._fallback_repositories))
866
# Open the new repository object.
867
# Repositories don't offer an interface to remove fallback
868
# repositories today; take the conceptually simpler option and just
869
# reopen it. We reopen it starting from the URL so that we
870
# get a separate connection for RemoteRepositories and can
871
# stream from one of them to the other. This does mean doing
872
# separate SSH connection setup, but unstacking is not a
873
# common operation so it's tolerable.
874
new_bzrdir = controldir.ControlDir.open(
875
self.bzrdir.root_transport.base)
876
new_repository = new_bzrdir.find_repository()
877
if new_repository._fallback_repositories:
878
raise AssertionError("didn't expect %r to have "
879
"fallback_repositories"
880
% (self.repository,))
881
# Replace self.repository with the new repository.
882
# Do our best to transfer the lock state (i.e. lock-tokens and
883
# lock count) of self.repository to the new repository.
884
lock_token = old_repository.lock_write().repository_token
885
self.repository = new_repository
886
if isinstance(self, remote.RemoteBranch):
887
# Remote branches can have a second reference to the old
888
# repository that need to be replaced.
889
if self._real_branch is not None:
890
self._real_branch.repository = new_repository
891
self.repository.lock_write(token=lock_token)
892
if lock_token is not None:
893
old_repository.leave_lock_in_place()
714
"of %r" % (self.repository,))
715
# unlock it, including unlocking the fallback
894
716
old_repository.unlock()
895
if lock_token is not None:
896
# XXX: self.repository.leave_lock_in_place() before this
897
# function will not be preserved. Fortunately that doesn't
898
# affect the current default format (2a), and would be a
899
# corner-case anyway.
900
# - Andrew Bennetts, 2010/06/30
901
self.repository.dont_leave_lock_in_place()
905
old_repository.unlock()
906
except errors.LockNotHeld:
909
if old_lock_count == 0:
910
raise AssertionError(
911
'old_repository should have been locked at least once.')
912
for i in range(old_lock_count-1):
717
old_repository.lock_read()
719
# Repositories don't offer an interface to remove fallback
720
# repositories today; take the conceptually simpler option and just
721
# reopen it. We reopen it starting from the URL so that we
722
# get a separate connection for RemoteRepositories and can
723
# stream from one of them to the other. This does mean doing
724
# separate SSH connection setup, but unstacking is not a
725
# common operation so it's tolerable.
726
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
727
new_repository = new_bzrdir.find_repository()
728
self.repository = new_repository
729
if self.repository._fallback_repositories:
730
raise AssertionError("didn't expect %r to have "
731
"fallback_repositories"
732
% (self.repository,))
733
# this is not paired with an unlock because it's just restoring
734
# the previous state; the lock's released when set_stacked_on_url
913
736
self.repository.lock_write()
914
# Fetch from the old repository into the new.
915
old_repository.lock_read()
917
737
# XXX: If you unstack a branch while it has a working tree
918
738
# with a pending merge, the pending-merged revisions will no
919
739
# longer be present. You can (probably) revert and remerge.
921
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
922
except errors.TagsNotSupported:
923
tags_to_fetch = set()
924
fetch_spec = vf_search.NotInOtherForRevs(self.repository,
925
old_repository, required_ids=[self.last_revision()],
926
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
927
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
741
# XXX: This only fetches up to the tip of the repository; it
742
# doesn't bring across any tags. That's fairly consistent
743
# with how branch works, but perhaps not ideal.
744
self.repository.fetch(old_repository,
745
revision_id=self.last_revision(),
929
748
old_repository.unlock()
1028
846
:return: A tuple (revno, revision_id).
1030
848
if self._last_revision_info_cache is None:
1031
self._last_revision_info_cache = self._read_last_revision_info()
849
self._last_revision_info_cache = self._last_revision_info()
1032
850
return self._last_revision_info_cache
1034
def _read_last_revision_info(self):
1035
raise NotImplementedError(self._read_last_revision_info)
1037
@deprecated_method(deprecated_in((2, 4, 0)))
852
def _last_revision_info(self):
853
rh = self.revision_history()
856
return (revno, rh[-1])
858
return (0, _mod_revision.NULL_REVISION)
860
@deprecated_method(deprecated_in((1, 6, 0)))
861
def missing_revisions(self, other, stop_revision=None):
862
"""Return a list of new revisions that would perfectly fit.
864
If self and other have not diverged, return a list of the revisions
865
present in other, but missing from self.
867
self_history = self.revision_history()
868
self_len = len(self_history)
869
other_history = other.revision_history()
870
other_len = len(other_history)
871
common_index = min(self_len, other_len) -1
872
if common_index >= 0 and \
873
self_history[common_index] != other_history[common_index]:
874
raise errors.DivergedBranches(self, other)
876
if stop_revision is None:
877
stop_revision = other_len
879
if stop_revision > other_len:
880
raise errors.NoSuchRevision(self, stop_revision)
881
return other_history[self_len:stop_revision]
884
def update_revisions(self, other, stop_revision=None, overwrite=False,
886
"""Pull in new perfect-fit revisions.
888
:param other: Another Branch to pull from
889
:param stop_revision: Updated until the given revision
890
:param overwrite: Always set the branch pointer, rather than checking
891
to see if it is a proper descendant.
892
:param graph: A Graph object that can be used to query history
893
information. This can be None.
896
return InterBranch.get(other, self).update_revisions(stop_revision,
1038
899
def import_last_revision_info(self, source_repo, revno, revid):
1039
900
"""Set the last revision info, importing from another repo if necessary.
902
This is used by the bound branch code to upload a revision to
903
the master branch first before updating the tip of the local branch.
1041
905
:param source_repo: Source repository to optionally fetch from
1042
906
:param revno: Revision number of the new tip
1043
907
:param revid: Revision id of the new tip
1583
1421
object will be created every time regardless.
1424
_default_format = None
1425
"""The default format used for new branches."""
1428
"""The known formats."""
1430
can_set_append_revisions_only = True
1586
1432
def __eq__(self, other):
1587
1433
return self.__class__ is other.__class__
1589
1435
def __ne__(self, other):
1590
1436
return not (self == other)
1592
def get_reference(self, controldir, name=None):
1593
"""Get the target reference of the branch in controldir.
1439
def find_format(klass, a_bzrdir):
1440
"""Return the format for the branch object in a_bzrdir."""
1442
transport = a_bzrdir.get_branch_transport(None)
1443
format_string = transport.get("format").read()
1444
return klass._formats[format_string]
1445
except errors.NoSuchFile:
1446
raise errors.NotBranchError(path=transport.base)
1448
raise errors.UnknownFormatError(format=format_string, kind='branch')
1451
def get_default_format(klass):
1452
"""Return the current default format."""
1453
return klass._default_format
1455
def get_reference(self, a_bzrdir):
1456
"""Get the target reference of the branch in a_bzrdir.
1595
1458
format probing must have been completed before calling
1596
1459
this method - it is assumed that the format of the branch
1597
in controldir is correct.
1460
in a_bzrdir is correct.
1599
:param controldir: The controldir to get the branch data from.
1600
:param name: Name of the colocated branch to fetch
1462
:param a_bzrdir: The bzrdir to get the branch data from.
1601
1463
:return: None if the branch is not a reference branch.
1606
def set_reference(self, controldir, name, to_branch):
1607
"""Set the target reference of the branch in controldir.
1468
def set_reference(self, a_bzrdir, to_branch):
1469
"""Set the target reference of the branch in a_bzrdir.
1609
1471
format probing must have been completed before calling
1610
1472
this method - it is assumed that the format of the branch
1611
in controldir is correct.
1473
in a_bzrdir is correct.
1613
:param controldir: The controldir to set the branch reference for.
1614
:param name: Name of colocated branch to set, None for default
1475
:param a_bzrdir: The bzrdir to set the branch reference for.
1615
1476
:param to_branch: branch that the checkout is to reference
1617
1478
raise NotImplementedError(self.set_reference)
1480
def get_format_string(self):
1481
"""Return the ASCII format string that identifies this format."""
1482
raise NotImplementedError(self.get_format_string)
1619
1484
def get_format_description(self):
1620
1485
"""Return the short format description for this format."""
1621
1486
raise NotImplementedError(self.get_format_description)
1623
def _run_post_branch_init_hooks(self, controldir, name, branch):
1624
hooks = Branch.hooks['post_branch_init']
1627
params = BranchInitHookParams(self, controldir, name, branch)
1631
def initialize(self, controldir, name=None, repository=None,
1632
append_revisions_only=None):
1633
"""Create a branch of this format in controldir.
1635
:param name: Name of the colocated branch to create.
1488
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1490
"""Initialize a branch in a bzrdir, with specified files
1492
:param a_bzrdir: The bzrdir to initialize the branch in
1493
:param utf8_files: The files to create as a list of
1494
(filename, content) tuples
1495
:param set_format: If True, set the format with
1496
self.get_format_string. (BzrBranch4 has its format set
1498
:return: a branch in this format
1500
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1501
branch_transport = a_bzrdir.get_branch_transport(self)
1503
'metadir': ('lock', lockdir.LockDir),
1504
'branch4': ('branch-lock', lockable_files.TransportLock),
1506
lock_name, lock_class = lock_map[lock_type]
1507
control_files = lockable_files.LockableFiles(branch_transport,
1508
lock_name, lock_class)
1509
control_files.create_lock()
1511
control_files.lock_write()
1512
except errors.LockContention:
1513
if lock_type != 'branch4':
1519
utf8_files += [('format', self.get_format_string())]
1521
for (filename, content) in utf8_files:
1522
branch_transport.put_bytes(
1524
mode=a_bzrdir._get_file_mode())
1527
control_files.unlock()
1528
return self.open(a_bzrdir, _found=True)
1530
def initialize(self, a_bzrdir):
1531
"""Create a branch of this format in a_bzrdir."""
1637
1532
raise NotImplementedError(self.initialize)
1639
1534
def is_supported(self):
1777
1647
"basis revision. hooks MUST NOT modify this delta. "
1778
1648
" future_tree is an in-memory tree obtained from "
1779
1649
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1781
self.add_hook('post_commit',
1650
"tree.", (0,91), None))
1651
self.create_hook(HookPoint('post_commit',
1782
1652
"Called in the bzr client after a commit has completed. "
1783
1653
"post_commit is called with (local, master, old_revno, old_revid, "
1784
1654
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1785
"commit to a branch.", (0, 15))
1786
self.add_hook('post_uncommit',
1655
"commit to a branch.", (0, 15), None))
1656
self.create_hook(HookPoint('post_uncommit',
1787
1657
"Called in the bzr client after an uncommit completes. "
1788
1658
"post_uncommit is called with (local, master, old_revno, "
1789
1659
"old_revid, new_revno, new_revid) where local is the local branch "
1790
1660
"or None, master is the target branch, and an empty branch "
1791
"receives new_revno of 0, new_revid of None.", (0, 15))
1792
self.add_hook('pre_change_branch_tip',
1661
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1662
self.create_hook(HookPoint('pre_change_branch_tip',
1793
1663
"Called in bzr client and server before a change to the tip of a "
1794
1664
"branch is made. pre_change_branch_tip is called with a "
1795
1665
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1796
"commit, uncommit will all trigger this hook.", (1, 6))
1797
self.add_hook('post_change_branch_tip',
1666
"commit, uncommit will all trigger this hook.", (1, 6), None))
1667
self.create_hook(HookPoint('post_change_branch_tip',
1798
1668
"Called in bzr client and server after a change to the tip of a "
1799
1669
"branch is made. post_change_branch_tip is called with a "
1800
1670
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1801
"commit, uncommit will all trigger this hook.", (1, 4))
1802
self.add_hook('transform_fallback_location',
1671
"commit, uncommit will all trigger this hook.", (1, 4), None))
1672
self.create_hook(HookPoint('transform_fallback_location',
1803
1673
"Called when a stacked branch is activating its fallback "
1804
1674
"locations. transform_fallback_location is called with (branch, "
1805
1675
"url), and should return a new url. Returning the same url "
1872
1725
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1875
class BranchInitHookParams(object):
1876
"""Object holding parameters passed to `*_branch_init` hooks.
1878
There are 4 fields that hooks may wish to access:
1880
:ivar format: the branch format
1881
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1882
:ivar name: name of colocated branch, if any (or None)
1883
:ivar branch: the branch created
1885
Note that for lightweight checkouts, the bzrdir and format fields refer to
1886
the checkout, hence they are different from the corresponding fields in
1887
branch, which refer to the original branch.
1890
def __init__(self, format, controldir, name, branch):
1891
"""Create a group of BranchInitHook parameters.
1893
:param format: the branch format
1894
:param controldir: the ControlDir where the branch will be/has been
1896
:param name: name of colocated branch, if any (or None)
1897
:param branch: the branch created
1899
Note that for lightweight checkouts, the bzrdir and format fields refer
1900
to the checkout, hence they are different from the corresponding fields
1901
in branch, which refer to the original branch.
1903
self.format = format
1904
self.bzrdir = controldir
1906
self.branch = branch
1908
def __eq__(self, other):
1909
return self.__dict__ == other.__dict__
1912
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1915
class SwitchHookParams(object):
1916
"""Object holding parameters passed to `*_switch` hooks.
1918
There are 4 fields that hooks may wish to access:
1920
:ivar control_dir: ControlDir of the checkout to change
1921
:ivar to_branch: branch that the checkout is to reference
1922
:ivar force: skip the check for local commits in a heavy checkout
1923
:ivar revision_id: revision ID to switch to (or None)
1926
def __init__(self, control_dir, to_branch, force, revision_id):
1927
"""Create a group of SwitchHook parameters.
1929
:param control_dir: ControlDir of the checkout to change
1930
:param to_branch: branch that the checkout is to reference
1931
:param force: skip the check for local commits in a heavy checkout
1932
:param revision_id: revision ID to switch to (or None)
1934
self.control_dir = control_dir
1935
self.to_branch = to_branch
1937
self.revision_id = revision_id
1939
def __eq__(self, other):
1940
return self.__dict__ == other.__dict__
1943
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1944
self.control_dir, self.to_branch,
1948
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
1949
"""Base class for branch formats that live in meta directories.
1728
class BzrBranchFormat4(BranchFormat):
1729
"""Bzr branch format 4.
1732
- a revision-history file.
1733
- a branch-lock lock file [ to be shared with the bzrdir ]
1736
def get_format_description(self):
1737
"""See BranchFormat.get_format_description()."""
1738
return "Branch format 4"
1740
def initialize(self, a_bzrdir):
1741
"""Create a branch of this format in a_bzrdir."""
1742
utf8_files = [('revision-history', ''),
1743
('branch-name', ''),
1745
return self._initialize_helper(a_bzrdir, utf8_files,
1746
lock_type='branch4', set_format=False)
1952
1748
def __init__(self):
1953
BranchFormat.__init__(self)
1954
bzrdir.BzrFormat.__init__(self)
1957
def find_format(klass, controldir, name=None):
1958
"""Return the format for the branch object in controldir."""
1960
transport = controldir.get_branch_transport(None, name=name)
1961
except errors.NoSuchFile:
1962
raise errors.NotBranchError(path=name, bzrdir=controldir)
1964
format_string = transport.get_bytes("format")
1965
except errors.NoSuchFile:
1966
raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
1967
return klass._find_format(format_registry, 'branch', format_string)
1749
super(BzrBranchFormat4, self).__init__()
1750
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1752
def network_name(self):
1753
"""The network name for this format is the control dirs disk label."""
1754
return self._matchingbzrdir.get_format_string()
1756
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1757
"""See BranchFormat.open()."""
1759
# we are being called directly and must probe.
1760
raise NotImplementedError
1761
return BzrBranch(_format=self,
1762
_control_files=a_bzrdir._control_files,
1764
_repository=a_bzrdir.open_repository())
1767
return "Bazaar-NG branch format 4"
1770
class BranchFormatMetadir(BranchFormat):
1771
"""Common logic for meta-dir based branch formats."""
1969
1773
def _branch_class(self):
1970
1774
"""What class to instantiate on open calls."""
1971
1775
raise NotImplementedError(self._branch_class)
1973
def _get_initial_config(self, append_revisions_only=None):
1974
if append_revisions_only:
1975
return "append_revisions_only = True\n"
1977
# Avoid writing anything if append_revisions_only is disabled,
1978
# as that is the default.
1981
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1983
"""Initialize a branch in a control dir, with specified files
1985
:param a_bzrdir: The bzrdir to initialize the branch in
1986
:param utf8_files: The files to create as a list of
1987
(filename, content) tuples
1988
:param name: Name of colocated branch to create, if any
1989
:return: a branch in this format
1777
def network_name(self):
1778
"""A simple byte string uniquely identifying this format for RPC calls.
1780
Metadir branch formats use their format string.
1992
name = a_bzrdir._get_selected_branch()
1993
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1994
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1995
control_files = lockable_files.LockableFiles(branch_transport,
1996
'lock', lockdir.LockDir)
1997
control_files.create_lock()
1998
control_files.lock_write()
2000
utf8_files += [('format', self.as_string())]
2001
for (filename, content) in utf8_files:
2002
branch_transport.put_bytes(
2004
mode=a_bzrdir._get_file_mode())
2006
control_files.unlock()
2007
branch = self.open(a_bzrdir, name, _found=True,
2008
found_repository=repository)
2009
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1782
return self.get_format_string()
2012
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2013
found_repository=None, possible_transports=None):
1784
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
2014
1785
"""See BranchFormat.open()."""
2016
name = a_bzrdir._get_selected_branch()
2018
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
1787
format = BranchFormat.find_format(a_bzrdir)
2019
1788
if format.__class__ != self.__class__:
2020
1789
raise AssertionError("wrong format %r found for %r" %
2021
1790
(format, self))
2022
transport = a_bzrdir.get_branch_transport(None, name=name)
1792
transport = a_bzrdir.get_branch_transport(None)
2024
1793
control_files = lockable_files.LockableFiles(transport, 'lock',
2025
1794
lockdir.LockDir)
2026
if found_repository is None:
2027
found_repository = a_bzrdir.find_repository()
2028
1795
return self._branch_class()(_format=self,
2029
1796
_control_files=control_files,
2031
1797
a_bzrdir=a_bzrdir,
2032
_repository=found_repository,
2033
ignore_fallbacks=ignore_fallbacks,
2034
possible_transports=possible_transports)
1798
_repository=a_bzrdir.find_repository(),
1799
ignore_fallbacks=ignore_fallbacks)
2035
1800
except errors.NoSuchFile:
2036
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1801
raise errors.NotBranchError(path=transport.base)
2039
def _matchingbzrdir(self):
2040
ret = bzrdir.BzrDirMetaFormat1()
2041
ret.set_branch_format(self)
1804
super(BranchFormatMetadir, self).__init__()
1805
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1806
self._matchingbzrdir.set_branch_format(self)
2044
1808
def supports_tags(self):
2047
def supports_leaving_lock(self):
2050
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
2052
BranchFormat.check_support_status(self,
2053
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
2055
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
2056
recommend_upgrade=recommend_upgrade, basedir=basedir)
2059
1812
class BzrBranchFormat5(BranchFormatMetadir):
2060
1813
"""Bzr branch format 5.
2239
1976
"""See BranchFormat.get_format_description()."""
2240
1977
return "Checkout reference format 1"
2242
def get_reference(self, a_bzrdir, name=None):
1979
def get_reference(self, a_bzrdir):
2243
1980
"""See BranchFormat.get_reference()."""
2244
transport = a_bzrdir.get_branch_transport(None, name=name)
2245
return transport.get_bytes('location')
1981
transport = a_bzrdir.get_branch_transport(None)
1982
return transport.get('location').read()
2247
def set_reference(self, a_bzrdir, name, to_branch):
1984
def set_reference(self, a_bzrdir, to_branch):
2248
1985
"""See BranchFormat.set_reference()."""
2249
transport = a_bzrdir.get_branch_transport(None, name=name)
1986
transport = a_bzrdir.get_branch_transport(None)
2250
1987
location = transport.put_bytes('location', to_branch.base)
2252
def initialize(self, a_bzrdir, name=None, target_branch=None,
2253
repository=None, append_revisions_only=None):
1989
def initialize(self, a_bzrdir, target_branch=None):
2254
1990
"""Create a branch of this format in a_bzrdir."""
2255
1991
if target_branch is None:
2256
1992
# this format does not implement branch itself, thus the implicit
2257
1993
# creation contract must see it as uninitializable
2258
1994
raise errors.UninitializableFormat(self)
2259
mutter('creating branch reference in %s', a_bzrdir.user_url)
2260
if a_bzrdir._format.fixed_components:
2261
raise errors.IncompatibleFormat(self, a_bzrdir._format)
2263
name = a_bzrdir._get_selected_branch()
2264
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1995
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1996
branch_transport = a_bzrdir.get_branch_transport(self)
2265
1997
branch_transport.put_bytes('location',
2266
target_branch.user_url)
2267
branch_transport.put_bytes('format', self.as_string())
2268
branch = self.open(a_bzrdir, name, _found=True,
1998
target_branch.bzrdir.root_transport.base)
1999
branch_transport.put_bytes('format', self.get_format_string())
2001
a_bzrdir, _found=True,
2269
2002
possible_transports=[target_branch.bzrdir.root_transport])
2270
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2005
super(BranchReferenceFormat, self).__init__()
2006
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2007
self._matchingbzrdir.set_branch_format(self)
2273
2009
def _make_reference_clone_function(format, a_branch):
2274
2010
"""Create a clone() routine for a branch dynamically."""
2275
2011
def clone(to_bzrdir, revision_id=None,
2276
2012
repository_policy=None):
2277
2013
"""See Branch.clone()."""
2278
return format.initialize(to_bzrdir, target_branch=a_branch)
2014
return format.initialize(to_bzrdir, a_branch)
2279
2015
# cannot obey revision_id limits when cloning a reference ...
2280
2016
# FIXME RBC 20060210 either nuke revision_id for clone, or
2281
2017
# emit some sort of warning/error to the caller ?!
2284
def open(self, a_bzrdir, name=None, _found=False, location=None,
2285
possible_transports=None, ignore_fallbacks=False,
2286
found_repository=None):
2020
def open(self, a_bzrdir, _found=False, location=None,
2021
possible_transports=None, ignore_fallbacks=False):
2287
2022
"""Return the branch that the branch reference in a_bzrdir points at.
2289
2024
:param a_bzrdir: A BzrDir that contains a branch.
2290
:param name: Name of colocated branch to open, if any
2291
2025
:param _found: a private parameter, do not use it. It is used to
2292
2026
indicate if format probing has already be done.
2293
2027
:param ignore_fallbacks: when set, no fallback branches will be opened
2523
2193
"""See Branch.print_file."""
2524
2194
return self.repository.print_file(file, revision_id)
2196
def _write_revision_history(self, history):
2197
"""Factored out of set_revision_history.
2199
This performs the actual writing to disk.
2200
It is intended to be called by BzrBranch5.set_revision_history."""
2201
self._transport.put_bytes(
2202
'revision-history', '\n'.join(history),
2203
mode=self.bzrdir._get_file_mode())
2206
def set_revision_history(self, rev_history):
2207
"""See Branch.set_revision_history."""
2208
if 'evil' in debug.debug_flags:
2209
mutter_callsite(3, "set_revision_history scales with history.")
2210
check_not_reserved_id = _mod_revision.check_not_reserved_id
2211
for rev_id in rev_history:
2212
check_not_reserved_id(rev_id)
2213
if Branch.hooks['post_change_branch_tip']:
2214
# Don't calculate the last_revision_info() if there are no hooks
2216
old_revno, old_revid = self.last_revision_info()
2217
if len(rev_history) == 0:
2218
revid = _mod_revision.NULL_REVISION
2220
revid = rev_history[-1]
2221
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2222
self._write_revision_history(rev_history)
2223
self._clear_cached_state()
2224
self._cache_revision_history(rev_history)
2225
for hook in Branch.hooks['set_rh']:
2226
hook(self, rev_history)
2227
if Branch.hooks['post_change_branch_tip']:
2228
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2230
def _synchronize_history(self, destination, revision_id):
2231
"""Synchronize last revision and revision history between branches.
2233
This version is most efficient when the destination is also a
2234
BzrBranch5, but works for BzrBranch6 as long as the revision
2235
history is the true lefthand parent history, and all of the revisions
2236
are in the destination's repository. If not, set_revision_history
2239
:param destination: The branch to copy the history into
2240
:param revision_id: The revision-id to truncate history at. May
2241
be None to copy complete history.
2243
if not isinstance(destination._format, BzrBranchFormat5):
2244
super(BzrBranch, self)._synchronize_history(
2245
destination, revision_id)
2247
if revision_id == _mod_revision.NULL_REVISION:
2250
new_history = self.revision_history()
2251
if revision_id is not None and new_history != []:
2253
new_history = new_history[:new_history.index(revision_id) + 1]
2255
rev = self.repository.get_revision(revision_id)
2256
new_history = rev.get_history(self.repository)[1:]
2257
destination.set_revision_history(new_history)
2526
2259
@needs_write_lock
2527
2260
def set_last_revision_info(self, revno, revision_id):
2528
if not revision_id or not isinstance(revision_id, basestring):
2529
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2261
"""Set the last revision of this branch.
2263
The caller is responsible for checking that the revno is correct
2264
for this revision id.
2266
It may be possible to set the branch last revision to an id not
2267
present in the repository. However, branches can also be
2268
configured to check constraints on history, in which case this may not
2530
2271
revision_id = _mod_revision.ensure_null(revision_id)
2531
old_revno, old_revid = self.last_revision_info()
2532
if self.get_append_revisions_only():
2533
self._check_history_violation(revision_id)
2534
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2535
self._write_last_revision_info(revno, revision_id)
2536
self._clear_cached_state()
2537
self._last_revision_info_cache = revno, revision_id
2538
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2272
# this old format stores the full history, but this api doesn't
2273
# provide it, so we must generate, and might as well check it's
2275
history = self._lefthand_history(revision_id)
2276
if len(history) != revno:
2277
raise AssertionError('%d != %d' % (len(history), revno))
2278
self.set_revision_history(history)
2280
def _gen_revision_history(self):
2281
history = self._transport.get_bytes('revision-history').split('\n')
2282
if history[-1:] == ['']:
2283
# There shouldn't be a trailing newline, but just in case.
2288
def generate_revision_history(self, revision_id, last_rev=None,
2290
"""Create a new revision history that will finish with revision_id.
2292
:param revision_id: the new tip to use.
2293
:param last_rev: The previous last_revision. If not None, then this
2294
must be a ancestory of revision_id, or DivergedBranches is raised.
2295
:param other_branch: The other branch that DivergedBranches should
2296
raise with respect to.
2298
self.set_revision_history(self._lefthand_history(revision_id,
2299
last_rev, other_branch))
2540
2301
def basis_tree(self):
2541
2302
"""See Branch.basis_tree."""
2662
def _read_last_revision_info(self):
2663
revision_string = self._transport.get_bytes('last-revision')
2664
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2665
revision_id = cache_utf8.get_cached_utf8(revision_id)
2667
return revno, revision_id
2669
def _write_last_revision_info(self, revno, revision_id):
2670
"""Simply write out the revision id, with no checks.
2672
Use set_last_revision_info to perform this safely.
2674
Does not update the revision_history cache.
2676
revision_id = _mod_revision.ensure_null(revision_id)
2677
out_string = '%d %s\n' % (revno, revision_id)
2678
self._transport.put_bytes('last-revision', out_string,
2679
mode=self.bzrdir._get_file_mode())
2682
def update_feature_flags(self, updated_flags):
2683
"""Update the feature flags for this branch.
2685
:param updated_flags: Dictionary mapping feature names to necessities
2686
A necessity can be None to indicate the feature should be removed
2688
self._format._update_feature_flags(updated_flags)
2689
self.control_transport.put_bytes('format', self._format.as_string())
2692
class FullHistoryBzrBranch(BzrBranch):
2693
"""Bzr branch which contains the full revision history."""
2696
def set_last_revision_info(self, revno, revision_id):
2697
if not revision_id or not isinstance(revision_id, basestring):
2698
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2699
revision_id = _mod_revision.ensure_null(revision_id)
2700
# this old format stores the full history, but this api doesn't
2701
# provide it, so we must generate, and might as well check it's
2703
history = self._lefthand_history(revision_id)
2704
if len(history) != revno:
2705
raise AssertionError('%d != %d' % (len(history), revno))
2706
self._set_revision_history(history)
2708
def _read_last_revision_info(self):
2709
rh = self._revision_history()
2712
return (revno, rh[-1])
2714
return (0, _mod_revision.NULL_REVISION)
2716
def _set_revision_history(self, rev_history):
2717
if 'evil' in debug.debug_flags:
2718
mutter_callsite(3, "set_revision_history scales with history.")
2719
check_not_reserved_id = _mod_revision.check_not_reserved_id
2720
for rev_id in rev_history:
2721
check_not_reserved_id(rev_id)
2722
if Branch.hooks['post_change_branch_tip']:
2723
# Don't calculate the last_revision_info() if there are no hooks
2725
old_revno, old_revid = self.last_revision_info()
2726
if len(rev_history) == 0:
2727
revid = _mod_revision.NULL_REVISION
2729
revid = rev_history[-1]
2730
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2731
self._write_revision_history(rev_history)
2732
self._clear_cached_state()
2733
self._cache_revision_history(rev_history)
2734
if Branch.hooks['post_change_branch_tip']:
2735
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2737
def _write_revision_history(self, history):
2738
"""Factored out of set_revision_history.
2740
This performs the actual writing to disk.
2741
It is intended to be called by set_revision_history."""
2742
self._transport.put_bytes(
2743
'revision-history', '\n'.join(history),
2744
mode=self.bzrdir._get_file_mode())
2746
def _gen_revision_history(self):
2747
history = self._transport.get_bytes('revision-history').split('\n')
2748
if history[-1:] == ['']:
2749
# There shouldn't be a trailing newline, but just in case.
2753
def _synchronize_history(self, destination, revision_id):
2754
if not isinstance(destination, FullHistoryBzrBranch):
2755
super(BzrBranch, self)._synchronize_history(
2756
destination, revision_id)
2758
if revision_id == _mod_revision.NULL_REVISION:
2761
new_history = self._revision_history()
2762
if revision_id is not None and new_history != []:
2764
new_history = new_history[:new_history.index(revision_id) + 1]
2766
rev = self.repository.get_revision(revision_id)
2767
new_history = rev.get_history(self.repository)[1:]
2768
destination._set_revision_history(new_history)
2771
def generate_revision_history(self, revision_id, last_rev=None,
2773
"""Create a new revision history that will finish with revision_id.
2775
:param revision_id: the new tip to use.
2776
:param last_rev: The previous last_revision. If not None, then this
2777
must be a ancestory of revision_id, or DivergedBranches is raised.
2778
:param other_branch: The other branch that DivergedBranches should
2779
raise with respect to.
2781
self._set_revision_history(self._lefthand_history(revision_id,
2782
last_rev, other_branch))
2785
class BzrBranch5(FullHistoryBzrBranch):
2786
"""A format 5 branch. This supports new features over plain branches.
2788
It has support for a master_branch which is the data for bound branches.
2792
class BzrBranch8(BzrBranch):
2451
class BzrBranch8(BzrBranch5):
2793
2452
"""A branch that stores tree-reference locations."""
2795
def _open_hook(self, possible_transports=None):
2454
def _open_hook(self):
2796
2455
if self._ignore_fallbacks:
2798
if possible_transports is None:
2799
possible_transports = [self.bzrdir.root_transport]
2801
2458
url = self.get_stacked_on_url()
2802
2459
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2824
2480
self._last_revision_info_cache = None
2825
2481
self._reference_info = None
2483
def _last_revision_info(self):
2484
revision_string = self._transport.get_bytes('last-revision')
2485
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2486
revision_id = cache_utf8.get_cached_utf8(revision_id)
2488
return revno, revision_id
2490
def _write_last_revision_info(self, revno, revision_id):
2491
"""Simply write out the revision id, with no checks.
2493
Use set_last_revision_info to perform this safely.
2495
Does not update the revision_history cache.
2496
Intended to be called by set_last_revision_info and
2497
_write_revision_history.
2499
revision_id = _mod_revision.ensure_null(revision_id)
2500
out_string = '%d %s\n' % (revno, revision_id)
2501
self._transport.put_bytes('last-revision', out_string,
2502
mode=self.bzrdir._get_file_mode())
2505
def set_last_revision_info(self, revno, revision_id):
2506
revision_id = _mod_revision.ensure_null(revision_id)
2507
old_revno, old_revid = self.last_revision_info()
2508
if self._get_append_revisions_only():
2509
self._check_history_violation(revision_id)
2510
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2511
self._write_last_revision_info(revno, revision_id)
2512
self._clear_cached_state()
2513
self._last_revision_info_cache = revno, revision_id
2514
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2516
def _synchronize_history(self, destination, revision_id):
2517
"""Synchronize last revision and revision history between branches.
2519
:see: Branch._synchronize_history
2521
# XXX: The base Branch has a fast implementation of this method based
2522
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2523
# that uses set_revision_history. This class inherits from BzrBranch5,
2524
# but wants the fast implementation, so it calls
2525
# Branch._synchronize_history directly.
2526
Branch._synchronize_history(self, destination, revision_id)
2827
2528
def _check_history_violation(self, revision_id):
2828
current_revid = self.last_revision()
2829
last_revision = _mod_revision.ensure_null(current_revid)
2529
last_revision = _mod_revision.ensure_null(self.last_revision())
2830
2530
if _mod_revision.is_null(last_revision):
2832
graph = self.repository.get_graph()
2833
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2834
if lh_ancestor == current_revid:
2836
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2532
if last_revision not in self._lefthand_history(revision_id):
2533
raise errors.AppendRevisionsOnlyViolation(self.base)
2838
2535
def _gen_revision_history(self):
2839
2536
"""Generate the revision history from last revision
3252
2988
raise NotImplementedError(self.push)
3255
def copy_content_into(self, revision_id=None):
3256
"""Copy the content of source into target
3258
revision_id: if not None, the revision history in the new branch will
3259
be truncated to end with revision_id.
3261
raise NotImplementedError(self.copy_content_into)
3264
def fetch(self, stop_revision=None, limit=None):
3267
:param stop_revision: Last revision to fetch
3268
:param limit: Optional rough limit of revisions to fetch
3270
raise NotImplementedError(self.fetch)
3273
def _fix_overwrite_type(overwrite):
3274
if isinstance(overwrite, bool):
3276
return ["history", "tags"]
3282
2991
class GenericInterBranch(InterBranch):
3283
"""InterBranch implementation that uses public Branch functions."""
3286
def is_compatible(klass, source, target):
3287
# GenericBranch uses the public API, so always compatible
3291
def _get_branch_formats_to_test(klass):
3292
return [(format_registry.get_default(), format_registry.get_default())]
3295
def unwrap_format(klass, format):
3296
if isinstance(format, remote.RemoteBranchFormat):
3297
format._ensure_real()
3298
return format._custom_format
3302
def copy_content_into(self, revision_id=None):
3303
"""Copy the content of source into target
3305
revision_id: if not None, the revision history in the new branch will
3306
be truncated to end with revision_id.
3308
self.source.update_references(self.target)
3309
self.source._synchronize_history(self.target, revision_id)
3311
parent = self.source.get_parent()
3312
except errors.InaccessibleParent, e:
3313
mutter('parent was not accessible to copy: %s', e)
3316
self.target.set_parent(parent)
3317
if self.source._push_should_merge_tags():
3318
self.source.tags.merge_to(self.target.tags)
3321
def fetch(self, stop_revision=None, limit=None):
3322
if self.target.base == self.source.base:
2992
"""InterBranch implementation that uses public Branch functions.
2996
def _get_branch_formats_to_test():
2997
return BranchFormat._default_format, BranchFormat._default_format
2999
def update_revisions(self, stop_revision=None, overwrite=False,
3001
"""See InterBranch.update_revisions()."""
3324
3002
self.source.lock_read()
3326
fetch_spec_factory = fetch.FetchSpecFactory()
3327
fetch_spec_factory.source_branch = self.source
3328
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3329
fetch_spec_factory.source_repo = self.source.repository
3330
fetch_spec_factory.target_repo = self.target.repository
3331
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3332
fetch_spec_factory.limit = limit
3333
fetch_spec = fetch_spec_factory.make_fetch_spec()
3334
return self.target.repository.fetch(self.source.repository,
3335
fetch_spec=fetch_spec)
3004
other_revno, other_last_revision = self.source.last_revision_info()
3005
stop_revno = None # unknown
3006
if stop_revision is None:
3007
stop_revision = other_last_revision
3008
if _mod_revision.is_null(stop_revision):
3009
# if there are no commits, we're done.
3011
stop_revno = other_revno
3013
# what's the current last revision, before we fetch [and change it
3015
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3016
# we fetch here so that we don't process data twice in the common
3017
# case of having something to pull, and so that the check for
3018
# already merged can operate on the just fetched graph, which will
3019
# be cached in memory.
3020
self.target.fetch(self.source, stop_revision)
3021
# Check to see if one is an ancestor of the other
3024
graph = self.target.repository.get_graph()
3025
if self.target._check_if_descendant_or_diverged(
3026
stop_revision, last_rev, graph, self.source):
3027
# stop_revision is a descendant of last_rev, but we aren't
3028
# overwriting, so we're done.
3030
if stop_revno is None:
3032
graph = self.target.repository.get_graph()
3033
this_revno, this_last_revision = \
3034
self.target.last_revision_info()
3035
stop_revno = graph.find_distance_to_null(stop_revision,
3036
[(other_last_revision, other_revno),
3037
(this_last_revision, this_revno)])
3038
self.target.set_last_revision_info(stop_revno, stop_revision)
3337
3040
self.source.unlock()
3340
def _update_revisions(self, stop_revision=None, overwrite=False,
3342
other_revno, other_last_revision = self.source.last_revision_info()
3343
stop_revno = None # unknown
3344
if stop_revision is None:
3345
stop_revision = other_last_revision
3346
if _mod_revision.is_null(stop_revision):
3347
# if there are no commits, we're done.
3349
stop_revno = other_revno
3351
# what's the current last revision, before we fetch [and change it
3353
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3354
# we fetch here so that we don't process data twice in the common
3355
# case of having something to pull, and so that the check for
3356
# already merged can operate on the just fetched graph, which will
3357
# be cached in memory.
3358
self.fetch(stop_revision=stop_revision)
3359
# Check to see if one is an ancestor of the other
3362
graph = self.target.repository.get_graph()
3363
if self.target._check_if_descendant_or_diverged(
3364
stop_revision, last_rev, graph, self.source):
3365
# stop_revision is a descendant of last_rev, but we aren't
3366
# overwriting, so we're done.
3368
if stop_revno is None:
3370
graph = self.target.repository.get_graph()
3371
this_revno, this_last_revision = \
3372
self.target.last_revision_info()
3373
stop_revno = graph.find_distance_to_null(stop_revision,
3374
[(other_last_revision, other_revno),
3375
(this_last_revision, this_revno)])
3376
self.target.set_last_revision_info(stop_revno, stop_revision)
3379
3042
def pull(self, overwrite=False, stop_revision=None,
3380
possible_transports=None, run_hooks=True,
3381
_override_hook_target=None, local=False):
3382
"""Pull from source into self, updating my master if any.
3384
:param run_hooks: Private parameter - if false, this branch
3385
is being called because it's the master of the primary branch,
3386
so it should not run its hooks.
3388
bound_location = self.target.get_bound_location()
3389
if local and not bound_location:
3390
raise errors.LocalRequiresBoundBranch()
3391
master_branch = None
3392
source_is_master = False
3394
# bound_location comes from a config file, some care has to be
3395
# taken to relate it to source.user_url
3396
normalized = urlutils.normalize_url(bound_location)
3398
relpath = self.source.user_transport.relpath(normalized)
3399
source_is_master = (relpath == '')
3400
except (errors.PathNotChild, errors.InvalidURL):
3401
source_is_master = False
3402
if not local and bound_location and not source_is_master:
3403
# not pulling from master, so we need to update master.
3404
master_branch = self.target.get_master_branch(possible_transports)
3405
master_branch.lock_write()
3408
# pull from source into master.
3409
master_branch.pull(self.source, overwrite, stop_revision,
3411
return self._pull(overwrite,
3412
stop_revision, _hook_master=master_branch,
3413
run_hooks=run_hooks,
3414
_override_hook_target=_override_hook_target,
3415
merge_tags_to_master=not source_is_master)
3418
master_branch.unlock()
3420
def push(self, overwrite=False, stop_revision=None, lossy=False,
3421
_override_hook_source_branch=None):
3422
"""See InterBranch.push.
3424
This is the basic concrete implementation of push()
3426
:param _override_hook_source_branch: If specified, run the hooks
3427
passing this Branch as the source, rather than self. This is for
3428
use of RemoteBranch, where push is delegated to the underlying
3432
raise errors.LossyPushToSameVCS(self.source, self.target)
3433
# TODO: Public option to disable running hooks - should be trivial but
3436
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3437
op.add_cleanup(self.source.lock_read().unlock)
3438
op.add_cleanup(self.target.lock_write().unlock)
3439
return op.run(overwrite, stop_revision,
3440
_override_hook_source_branch=_override_hook_source_branch)
3442
def _basic_push(self, overwrite, stop_revision):
3443
"""Basic implementation of push without bound branches or hooks.
3445
Must be called with source read locked and target write locked.
3447
result = BranchPushResult()
3448
result.source_branch = self.source
3449
result.target_branch = self.target
3450
result.old_revno, result.old_revid = self.target.last_revision_info()
3451
self.source.update_references(self.target)
3452
overwrite = _fix_overwrite_type(overwrite)
3453
if result.old_revid != stop_revision:
3454
# We assume that during 'push' this repository is closer than
3456
graph = self.source.repository.get_graph(self.target.repository)
3457
self._update_revisions(stop_revision,
3458
overwrite=("history" in overwrite),
3460
if self.source._push_should_merge_tags():
3461
result.tag_updates, result.tag_conflicts = (
3462
self.source.tags.merge_to(
3463
self.target.tags, "tags" in overwrite))
3464
result.new_revno, result.new_revid = self.target.last_revision_info()
3467
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3468
_override_hook_source_branch=None):
3469
"""Push from source into target, and into target's master if any.
3472
if _override_hook_source_branch:
3473
result.source_branch = _override_hook_source_branch
3474
for hook in Branch.hooks['post_push']:
3477
bound_location = self.target.get_bound_location()
3478
if bound_location and self.target.base != bound_location:
3479
# there is a master branch.
3481
# XXX: Why the second check? Is it even supported for a branch to
3482
# be bound to itself? -- mbp 20070507
3483
master_branch = self.target.get_master_branch()
3484
master_branch.lock_write()
3485
operation.add_cleanup(master_branch.unlock)
3486
# push into the master from the source branch.
3487
master_inter = InterBranch.get(self.source, master_branch)
3488
master_inter._basic_push(overwrite, stop_revision)
3489
# and push into the target branch from the source. Note that
3490
# we push from the source branch again, because it's considered
3491
# the highest bandwidth repository.
3492
result = self._basic_push(overwrite, stop_revision)
3493
result.master_branch = master_branch
3494
result.local_branch = self.target
3496
master_branch = None
3498
result = self._basic_push(overwrite, stop_revision)
3499
# TODO: Why set master_branch and local_branch if there's no
3500
# binding? Maybe cleaner to just leave them unset? -- mbp
3502
result.master_branch = self.target
3503
result.local_branch = None
3507
def _pull(self, overwrite=False, stop_revision=None,
3508
3043
possible_transports=None, _hook_master=None, run_hooks=True,
3509
_override_hook_target=None, local=False,
3510
merge_tags_to_master=True):
3044
_override_hook_target=None, local=False):
3511
3045
"""See Branch.pull.
3513
This function is the core worker, used by GenericInterBranch.pull to
3514
avoid duplication when pulling source->master and source->local.
3516
3047
:param _hook_master: Private parameter - set the branch to
3517
3048
be supplied as the master to pull hooks.
3518
3049
:param run_hooks: Private parameter - if false, this branch
3519
3050
is being called because it's the master of the primary branch,
3520
3051
so it should not run its hooks.
3521
is being called because it's the master of the primary branch,
3522
so it should not run its hooks.
3523
3052
:param _override_hook_target: Private parameter - set the branch to be
3524
3053
supplied as the target_branch to pull hooks.
3525
3054
:param local: Only update the local branch, and not the bound branch.
3569
3094
self.source.unlock()
3097
def push(self, overwrite=False, stop_revision=None,
3098
_override_hook_source_branch=None):
3099
"""See InterBranch.push.
3101
This is the basic concrete implementation of push()
3103
:param _override_hook_source_branch: If specified, run
3104
the hooks passing this Branch as the source, rather than self.
3105
This is for use of RemoteBranch, where push is delegated to the
3106
underlying vfs-based Branch.
3108
# TODO: Public option to disable running hooks - should be trivial but
3110
self.source.lock_read()
3112
return _run_with_write_locked_target(
3113
self.target, self._push_with_bound_branches, overwrite,
3115
_override_hook_source_branch=_override_hook_source_branch)
3117
self.source.unlock()
3119
def _push_with_bound_branches(self, overwrite, stop_revision,
3120
_override_hook_source_branch=None):
3121
"""Push from source into target, and into target's master if any.
3124
if _override_hook_source_branch:
3125
result.source_branch = _override_hook_source_branch
3126
for hook in Branch.hooks['post_push']:
3129
bound_location = self.target.get_bound_location()
3130
if bound_location and self.target.base != bound_location:
3131
# there is a master branch.
3133
# XXX: Why the second check? Is it even supported for a branch to
3134
# be bound to itself? -- mbp 20070507
3135
master_branch = self.target.get_master_branch()
3136
master_branch.lock_write()
3138
# push into the master from the source branch.
3139
self.source._basic_push(master_branch, overwrite, stop_revision)
3140
# and push into the target branch from the source. Note that we
3141
# push from the source branch again, because its considered the
3142
# highest bandwidth repository.
3143
result = self.source._basic_push(self.target, overwrite,
3145
result.master_branch = master_branch
3146
result.local_branch = self.target
3150
master_branch.unlock()
3153
result = self.source._basic_push(self.target, overwrite,
3155
# TODO: Why set master_branch and local_branch if there's no
3156
# binding? Maybe cleaner to just leave them unset? -- mbp
3158
result.master_branch = self.target
3159
result.local_branch = None
3164
def is_compatible(self, source, target):
3165
# GenericBranch uses the public API, so always compatible
3169
class InterToBranch5(GenericInterBranch):
3172
def _get_branch_formats_to_test():
3173
return BranchFormat._default_format, BzrBranchFormat5()
3175
def pull(self, overwrite=False, stop_revision=None,
3176
possible_transports=None, run_hooks=True,
3177
_override_hook_target=None, local=False):
3178
"""Pull from source into self, updating my master if any.
3180
:param run_hooks: Private parameter - if false, this branch
3181
is being called because it's the master of the primary branch,
3182
so it should not run its hooks.
3184
bound_location = self.target.get_bound_location()
3185
if local and not bound_location:
3186
raise errors.LocalRequiresBoundBranch()
3187
master_branch = None
3188
if not local and bound_location and self.source.base != bound_location:
3189
# not pulling from master, so we need to update master.
3190
master_branch = self.target.get_master_branch(possible_transports)
3191
master_branch.lock_write()
3194
# pull from source into master.
3195
master_branch.pull(self.source, overwrite, stop_revision,
3197
return super(InterToBranch5, self).pull(overwrite,
3198
stop_revision, _hook_master=master_branch,
3199
run_hooks=run_hooks,
3200
_override_hook_target=_override_hook_target)
3203
master_branch.unlock()
3573
3206
InterBranch.register_optimiser(GenericInterBranch)
3207
InterBranch.register_optimiser(InterToBranch5)