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):
879
724
old_repository = self.repository
880
725
if len(old_repository._fallback_repositories) != 1:
881
726
raise AssertionError("can't cope with fallback repositories "
882
"of %r (fallbacks: %r)" % (old_repository,
883
old_repository._fallback_repositories))
884
# Open the new repository object.
885
# Repositories don't offer an interface to remove fallback
886
# repositories today; take the conceptually simpler option and just
887
# reopen it. We reopen it starting from the URL so that we
888
# get a separate connection for RemoteRepositories and can
889
# stream from one of them to the other. This does mean doing
890
# separate SSH connection setup, but unstacking is not a
891
# common operation so it's tolerable.
892
new_bzrdir = controldir.ControlDir.open(
893
self.bzrdir.root_transport.base)
894
new_repository = new_bzrdir.find_repository()
895
if new_repository._fallback_repositories:
896
raise AssertionError("didn't expect %r to have "
897
"fallback_repositories"
898
% (self.repository,))
899
# Replace self.repository with the new repository.
900
# Do our best to transfer the lock state (i.e. lock-tokens and
901
# lock count) of self.repository to the new repository.
902
lock_token = old_repository.lock_write().repository_token
903
self.repository = new_repository
904
if isinstance(self, remote.RemoteBranch):
905
# Remote branches can have a second reference to the old
906
# repository that need to be replaced.
907
if self._real_branch is not None:
908
self._real_branch.repository = new_repository
909
self.repository.lock_write(token=lock_token)
910
if lock_token is not None:
911
old_repository.leave_lock_in_place()
727
"of %r" % (self.repository,))
728
# unlock it, including unlocking the fallback
912
729
old_repository.unlock()
913
if lock_token is not None:
914
# XXX: self.repository.leave_lock_in_place() before this
915
# function will not be preserved. Fortunately that doesn't
916
# affect the current default format (2a), and would be a
917
# corner-case anyway.
918
# - Andrew Bennetts, 2010/06/30
919
self.repository.dont_leave_lock_in_place()
923
old_repository.unlock()
924
except errors.LockNotHeld:
927
if old_lock_count == 0:
928
raise AssertionError(
929
'old_repository should have been locked at least once.')
930
for i in range(old_lock_count-1):
730
old_repository.lock_read()
732
# Repositories don't offer an interface to remove fallback
733
# repositories today; take the conceptually simpler option and just
734
# reopen it. We reopen it starting from the URL so that we
735
# get a separate connection for RemoteRepositories and can
736
# stream from one of them to the other. This does mean doing
737
# separate SSH connection setup, but unstacking is not a
738
# common operation so it's tolerable.
739
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
740
new_repository = new_bzrdir.find_repository()
741
self.repository = new_repository
742
if self.repository._fallback_repositories:
743
raise AssertionError("didn't expect %r to have "
744
"fallback_repositories"
745
% (self.repository,))
746
# this is not paired with an unlock because it's just restoring
747
# the previous state; the lock's released when set_stacked_on_url
931
749
self.repository.lock_write()
932
# Fetch from the old repository into the new.
933
old_repository.lock_read()
935
750
# XXX: If you unstack a branch while it has a working tree
936
751
# with a pending merge, the pending-merged revisions will no
937
752
# longer be present. You can (probably) revert and remerge.
939
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
940
except errors.TagsNotSupported:
941
tags_to_fetch = set()
942
fetch_spec = vf_search.NotInOtherForRevs(self.repository,
943
old_repository, required_ids=[self.last_revision()],
944
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
945
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
754
# XXX: This only fetches up to the tip of the repository; it
755
# doesn't bring across any tags. That's fairly consistent
756
# with how branch works, but perhaps not ideal.
757
self.repository.fetch(old_repository,
758
revision_id=self.last_revision(),
947
761
old_repository.unlock()
1056
859
:return: A tuple (revno, revision_id).
1058
861
if self._last_revision_info_cache is None:
1059
self._last_revision_info_cache = self._read_last_revision_info()
862
self._last_revision_info_cache = self._last_revision_info()
1060
863
return self._last_revision_info_cache
1062
def _read_last_revision_info(self):
1063
raise NotImplementedError(self._read_last_revision_info)
1065
@deprecated_method(deprecated_in((2, 4, 0)))
865
def _last_revision_info(self):
866
rh = self.revision_history()
869
return (revno, rh[-1])
871
return (0, _mod_revision.NULL_REVISION)
873
@deprecated_method(deprecated_in((1, 6, 0)))
874
def missing_revisions(self, other, stop_revision=None):
875
"""Return a list of new revisions that would perfectly fit.
877
If self and other have not diverged, return a list of the revisions
878
present in other, but missing from self.
880
self_history = self.revision_history()
881
self_len = len(self_history)
882
other_history = other.revision_history()
883
other_len = len(other_history)
884
common_index = min(self_len, other_len) -1
885
if common_index >= 0 and \
886
self_history[common_index] != other_history[common_index]:
887
raise errors.DivergedBranches(self, other)
889
if stop_revision is None:
890
stop_revision = other_len
892
if stop_revision > other_len:
893
raise errors.NoSuchRevision(self, stop_revision)
894
return other_history[self_len:stop_revision]
897
def update_revisions(self, other, stop_revision=None, overwrite=False,
899
"""Pull in new perfect-fit revisions.
901
:param other: Another Branch to pull from
902
:param stop_revision: Updated until the given revision
903
:param overwrite: Always set the branch pointer, rather than checking
904
to see if it is a proper descendant.
905
:param graph: A Graph object that can be used to query history
906
information. This can be None.
909
return InterBranch.get(other, self).update_revisions(stop_revision,
1066
912
def import_last_revision_info(self, source_repo, revno, revid):
1067
913
"""Set the last revision info, importing from another repo if necessary.
915
This is used by the bound branch code to upload a revision to
916
the master branch first before updating the tip of the local branch.
1069
918
:param source_repo: Source repository to optionally fetch from
1070
919
:param revno: Revision number of the new tip
1071
920
:param revid: Revision id of the new tip
1618
1434
return not (self == other)
1621
@deprecated_method(deprecated_in((2, 4, 0)))
1437
def find_format(klass, a_bzrdir):
1438
"""Return the format for the branch object in a_bzrdir."""
1440
transport = a_bzrdir.get_branch_transport(None)
1441
format_string = transport.get_bytes("format")
1442
return klass._formats[format_string]
1443
except errors.NoSuchFile:
1444
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1446
raise errors.UnknownFormatError(format=format_string, kind='branch')
1622
1449
def get_default_format(klass):
1623
1450
"""Return the current default format."""
1624
return format_registry.get_default()
1627
@deprecated_method(deprecated_in((2, 4, 0)))
1628
def get_formats(klass):
1629
"""Get all the known formats.
1631
Warning: This triggers a load of all lazy registered formats: do not
1632
use except when that is desireed.
1634
return format_registry._get_all()
1636
def get_reference(self, controldir, name=None):
1637
"""Get the target reference of the branch in controldir.
1451
return klass._default_format
1453
def get_reference(self, a_bzrdir):
1454
"""Get the target reference of the branch in a_bzrdir.
1639
1456
format probing must have been completed before calling
1640
1457
this method - it is assumed that the format of the branch
1641
in controldir is correct.
1458
in a_bzrdir is correct.
1643
:param controldir: The controldir to get the branch data from.
1644
:param name: Name of the colocated branch to fetch
1460
:param a_bzrdir: The bzrdir to get the branch data from.
1645
1461
:return: None if the branch is not a reference branch.
1650
def set_reference(self, controldir, name, to_branch):
1651
"""Set the target reference of the branch in controldir.
1466
def set_reference(self, a_bzrdir, to_branch):
1467
"""Set the target reference of the branch in a_bzrdir.
1653
1469
format probing must have been completed before calling
1654
1470
this method - it is assumed that the format of the branch
1655
in controldir is correct.
1471
in a_bzrdir is correct.
1657
:param controldir: The controldir to set the branch reference for.
1658
:param name: Name of colocated branch to set, None for default
1473
:param a_bzrdir: The bzrdir to set the branch reference for.
1659
1474
:param to_branch: branch that the checkout is to reference
1661
1476
raise NotImplementedError(self.set_reference)
1478
def get_format_string(self):
1479
"""Return the ASCII format string that identifies this format."""
1480
raise NotImplementedError(self.get_format_string)
1663
1482
def get_format_description(self):
1664
1483
"""Return the short format description for this format."""
1665
1484
raise NotImplementedError(self.get_format_description)
1667
def _run_post_branch_init_hooks(self, controldir, name, branch):
1668
hooks = Branch.hooks['post_branch_init']
1671
params = BranchInitHookParams(self, controldir, name, branch)
1675
def initialize(self, controldir, name=None, repository=None,
1676
append_revisions_only=None):
1677
"""Create a branch of this format in controldir.
1679
:param name: Name of the colocated branch to create.
1486
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1488
"""Initialize a branch in a bzrdir, with specified files
1490
:param a_bzrdir: The bzrdir to initialize the branch in
1491
:param utf8_files: The files to create as a list of
1492
(filename, content) tuples
1493
:param set_format: If True, set the format with
1494
self.get_format_string. (BzrBranch4 has its format set
1496
:return: a branch in this format
1498
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1499
branch_transport = a_bzrdir.get_branch_transport(self)
1501
'metadir': ('lock', lockdir.LockDir),
1502
'branch4': ('branch-lock', lockable_files.TransportLock),
1504
lock_name, lock_class = lock_map[lock_type]
1505
control_files = lockable_files.LockableFiles(branch_transport,
1506
lock_name, lock_class)
1507
control_files.create_lock()
1509
control_files.lock_write()
1510
except errors.LockContention:
1511
if lock_type != 'branch4':
1517
utf8_files += [('format', self.get_format_string())]
1519
for (filename, content) in utf8_files:
1520
branch_transport.put_bytes(
1522
mode=a_bzrdir._get_file_mode())
1525
control_files.unlock()
1526
return self.open(a_bzrdir, _found=True)
1528
def initialize(self, a_bzrdir):
1529
"""Create a branch of this format in a_bzrdir."""
1681
1530
raise NotImplementedError(self.initialize)
1683
1532
def is_supported(self):
1842
1645
"basis revision. hooks MUST NOT modify this delta. "
1843
1646
" future_tree is an in-memory tree obtained from "
1844
1647
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1846
self.add_hook('post_commit',
1648
"tree.", (0,91), None))
1649
self.create_hook(HookPoint('post_commit',
1847
1650
"Called in the bzr client after a commit has completed. "
1848
1651
"post_commit is called with (local, master, old_revno, old_revid, "
1849
1652
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1850
"commit to a branch.", (0, 15))
1851
self.add_hook('post_uncommit',
1653
"commit to a branch.", (0, 15), None))
1654
self.create_hook(HookPoint('post_uncommit',
1852
1655
"Called in the bzr client after an uncommit completes. "
1853
1656
"post_uncommit is called with (local, master, old_revno, "
1854
1657
"old_revid, new_revno, new_revid) where local is the local branch "
1855
1658
"or None, master is the target branch, and an empty branch "
1856
"receives new_revno of 0, new_revid of None.", (0, 15))
1857
self.add_hook('pre_change_branch_tip',
1659
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1660
self.create_hook(HookPoint('pre_change_branch_tip',
1858
1661
"Called in bzr client and server before a change to the tip of a "
1859
1662
"branch is made. pre_change_branch_tip is called with a "
1860
1663
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1861
"commit, uncommit will all trigger this hook.", (1, 6))
1862
self.add_hook('post_change_branch_tip',
1664
"commit, uncommit will all trigger this hook.", (1, 6), None))
1665
self.create_hook(HookPoint('post_change_branch_tip',
1863
1666
"Called in bzr client and server after a change to the tip of a "
1864
1667
"branch is made. post_change_branch_tip is called with a "
1865
1668
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1866
"commit, uncommit will all trigger this hook.", (1, 4))
1867
self.add_hook('transform_fallback_location',
1669
"commit, uncommit will all trigger this hook.", (1, 4), None))
1670
self.create_hook(HookPoint('transform_fallback_location',
1868
1671
"Called when a stacked branch is activating its fallback "
1869
1672
"locations. transform_fallback_location is called with (branch, "
1870
1673
"url), and should return a new url. Returning the same url "
1937
1723
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1940
class BranchInitHookParams(object):
1941
"""Object holding parameters passed to `*_branch_init` hooks.
1943
There are 4 fields that hooks may wish to access:
1945
:ivar format: the branch format
1946
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1947
:ivar name: name of colocated branch, if any (or None)
1948
:ivar branch: the branch created
1950
Note that for lightweight checkouts, the bzrdir and format fields refer to
1951
the checkout, hence they are different from the corresponding fields in
1952
branch, which refer to the original branch.
1955
def __init__(self, format, controldir, name, branch):
1956
"""Create a group of BranchInitHook parameters.
1958
:param format: the branch format
1959
:param controldir: the ControlDir where the branch will be/has been
1961
:param name: name of colocated branch, if any (or None)
1962
:param branch: the branch created
1964
Note that for lightweight checkouts, the bzrdir and format fields refer
1965
to the checkout, hence they are different from the corresponding fields
1966
in branch, which refer to the original branch.
1968
self.format = format
1969
self.bzrdir = controldir
1971
self.branch = branch
1973
def __eq__(self, other):
1974
return self.__dict__ == other.__dict__
1977
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1980
class SwitchHookParams(object):
1981
"""Object holding parameters passed to `*_switch` hooks.
1983
There are 4 fields that hooks may wish to access:
1985
:ivar control_dir: ControlDir of the checkout to change
1986
:ivar to_branch: branch that the checkout is to reference
1987
:ivar force: skip the check for local commits in a heavy checkout
1988
:ivar revision_id: revision ID to switch to (or None)
1991
def __init__(self, control_dir, to_branch, force, revision_id):
1992
"""Create a group of SwitchHook parameters.
1994
:param control_dir: ControlDir of the checkout to change
1995
:param to_branch: branch that the checkout is to reference
1996
:param force: skip the check for local commits in a heavy checkout
1997
:param revision_id: revision ID to switch to (or None)
1999
self.control_dir = control_dir
2000
self.to_branch = to_branch
2002
self.revision_id = revision_id
2004
def __eq__(self, other):
2005
return self.__dict__ == other.__dict__
2008
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
2009
self.control_dir, self.to_branch,
2013
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
2014
"""Base class for branch formats that live in meta directories.
1726
class BzrBranchFormat4(BranchFormat):
1727
"""Bzr branch format 4.
1730
- a revision-history file.
1731
- a branch-lock lock file [ to be shared with the bzrdir ]
1734
def get_format_description(self):
1735
"""See BranchFormat.get_format_description()."""
1736
return "Branch format 4"
1738
def initialize(self, a_bzrdir):
1739
"""Create a branch of this format in a_bzrdir."""
1740
utf8_files = [('revision-history', ''),
1741
('branch-name', ''),
1743
return self._initialize_helper(a_bzrdir, utf8_files,
1744
lock_type='branch4', set_format=False)
2017
1746
def __init__(self):
2018
BranchFormat.__init__(self)
2019
bzrdir.BzrFormat.__init__(self)
2022
def find_format(klass, controldir, name=None):
2023
"""Return the format for the branch object in controldir."""
2025
transport = controldir.get_branch_transport(None, name=name)
2026
except errors.NoSuchFile:
2027
raise errors.NotBranchError(path=name, bzrdir=controldir)
2029
format_string = transport.get_bytes("format")
2030
except errors.NoSuchFile:
2031
raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
2032
return klass._find_format(format_registry, 'branch', format_string)
1747
super(BzrBranchFormat4, self).__init__()
1748
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1750
def network_name(self):
1751
"""The network name for this format is the control dirs disk label."""
1752
return self._matchingbzrdir.get_format_string()
1754
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1755
"""See BranchFormat.open()."""
1757
# we are being called directly and must probe.
1758
raise NotImplementedError
1759
return BzrBranch(_format=self,
1760
_control_files=a_bzrdir._control_files,
1762
_repository=a_bzrdir.open_repository())
1765
return "Bazaar-NG branch format 4"
1768
class BranchFormatMetadir(BranchFormat):
1769
"""Common logic for meta-dir based branch formats."""
2034
1771
def _branch_class(self):
2035
1772
"""What class to instantiate on open calls."""
2036
1773
raise NotImplementedError(self._branch_class)
2038
def _get_initial_config(self, append_revisions_only=None):
2039
if append_revisions_only:
2040
return "append_revisions_only = True\n"
2042
# Avoid writing anything if append_revisions_only is disabled,
2043
# as that is the default.
2046
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
2048
"""Initialize a branch in a bzrdir, with specified files
2050
:param a_bzrdir: The bzrdir to initialize the branch in
2051
:param utf8_files: The files to create as a list of
2052
(filename, content) tuples
2053
:param name: Name of colocated branch to create, if any
2054
:return: a branch in this format
1775
def network_name(self):
1776
"""A simple byte string uniquely identifying this format for RPC calls.
1778
Metadir branch formats use their format string.
2057
name = a_bzrdir._get_selected_branch()
2058
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2059
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2060
control_files = lockable_files.LockableFiles(branch_transport,
2061
'lock', lockdir.LockDir)
2062
control_files.create_lock()
2063
control_files.lock_write()
2065
utf8_files += [('format', self.as_string())]
2066
for (filename, content) in utf8_files:
2067
branch_transport.put_bytes(
2069
mode=a_bzrdir._get_file_mode())
2071
control_files.unlock()
2072
branch = self.open(a_bzrdir, name, _found=True,
2073
found_repository=repository)
2074
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1780
return self.get_format_string()
2077
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2078
found_repository=None, possible_transports=None):
1782
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
2079
1783
"""See BranchFormat.open()."""
2081
name = a_bzrdir._get_selected_branch()
2083
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
1785
format = BranchFormat.find_format(a_bzrdir)
2084
1786
if format.__class__ != self.__class__:
2085
1787
raise AssertionError("wrong format %r found for %r" %
2086
1788
(format, self))
2087
transport = a_bzrdir.get_branch_transport(None, name=name)
1790
transport = a_bzrdir.get_branch_transport(None)
2089
1791
control_files = lockable_files.LockableFiles(transport, 'lock',
2090
1792
lockdir.LockDir)
2091
if found_repository is None:
2092
found_repository = a_bzrdir.find_repository()
2093
1793
return self._branch_class()(_format=self,
2094
1794
_control_files=control_files,
2096
1795
a_bzrdir=a_bzrdir,
2097
_repository=found_repository,
2098
ignore_fallbacks=ignore_fallbacks,
2099
possible_transports=possible_transports)
1796
_repository=a_bzrdir.find_repository(),
1797
ignore_fallbacks=ignore_fallbacks)
2100
1798
except errors.NoSuchFile:
2101
1799
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2104
def _matchingbzrdir(self):
2105
ret = bzrdir.BzrDirMetaFormat1()
2106
ret.set_branch_format(self)
1802
super(BranchFormatMetadir, self).__init__()
1803
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1804
self._matchingbzrdir.set_branch_format(self)
2109
1806
def supports_tags(self):
2112
def supports_leaving_lock(self):
2115
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
2117
BranchFormat.check_support_status(self,
2118
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
2120
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
2121
recommend_upgrade=recommend_upgrade, basedir=basedir)
2124
1810
class BzrBranchFormat5(BranchFormatMetadir):
2125
1811
"""Bzr branch format 5.
2304
1974
"""See BranchFormat.get_format_description()."""
2305
1975
return "Checkout reference format 1"
2307
def get_reference(self, a_bzrdir, name=None):
1977
def get_reference(self, a_bzrdir):
2308
1978
"""See BranchFormat.get_reference()."""
2309
transport = a_bzrdir.get_branch_transport(None, name=name)
1979
transport = a_bzrdir.get_branch_transport(None)
2310
1980
return transport.get_bytes('location')
2312
def set_reference(self, a_bzrdir, name, to_branch):
1982
def set_reference(self, a_bzrdir, to_branch):
2313
1983
"""See BranchFormat.set_reference()."""
2314
transport = a_bzrdir.get_branch_transport(None, name=name)
1984
transport = a_bzrdir.get_branch_transport(None)
2315
1985
location = transport.put_bytes('location', to_branch.base)
2317
def initialize(self, a_bzrdir, name=None, target_branch=None,
2318
repository=None, append_revisions_only=None):
1987
def initialize(self, a_bzrdir, target_branch=None):
2319
1988
"""Create a branch of this format in a_bzrdir."""
2320
1989
if target_branch is None:
2321
1990
# this format does not implement branch itself, thus the implicit
2322
1991
# creation contract must see it as uninitializable
2323
1992
raise errors.UninitializableFormat(self)
2324
mutter('creating branch reference in %s', a_bzrdir.user_url)
2325
if a_bzrdir._format.fixed_components:
2326
raise errors.IncompatibleFormat(self, a_bzrdir._format)
2328
name = a_bzrdir._get_selected_branch()
2329
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1993
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1994
branch_transport = a_bzrdir.get_branch_transport(self)
2330
1995
branch_transport.put_bytes('location',
2331
target_branch.user_url)
2332
branch_transport.put_bytes('format', self.as_string())
2333
branch = self.open(a_bzrdir, name, _found=True,
1996
target_branch.bzrdir.root_transport.base)
1997
branch_transport.put_bytes('format', self.get_format_string())
1999
a_bzrdir, _found=True,
2334
2000
possible_transports=[target_branch.bzrdir.root_transport])
2335
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2003
super(BranchReferenceFormat, self).__init__()
2004
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2005
self._matchingbzrdir.set_branch_format(self)
2338
2007
def _make_reference_clone_function(format, a_branch):
2339
2008
"""Create a clone() routine for a branch dynamically."""
2340
2009
def clone(to_bzrdir, revision_id=None,
2341
2010
repository_policy=None):
2342
2011
"""See Branch.clone()."""
2343
return format.initialize(to_bzrdir, target_branch=a_branch)
2012
return format.initialize(to_bzrdir, a_branch)
2344
2013
# cannot obey revision_id limits when cloning a reference ...
2345
2014
# FIXME RBC 20060210 either nuke revision_id for clone, or
2346
2015
# emit some sort of warning/error to the caller ?!
2349
def open(self, a_bzrdir, name=None, _found=False, location=None,
2350
possible_transports=None, ignore_fallbacks=False,
2351
found_repository=None):
2018
def open(self, a_bzrdir, _found=False, location=None,
2019
possible_transports=None, ignore_fallbacks=False):
2352
2020
"""Return the branch that the branch reference in a_bzrdir points at.
2354
2022
:param a_bzrdir: A BzrDir that contains a branch.
2355
:param name: Name of colocated branch to open, if any
2356
2023
:param _found: a private parameter, do not use it. It is used to
2357
2024
indicate if format probing has already be done.
2358
2025
:param ignore_fallbacks: when set, no fallback branches will be opened
2583
2193
"""See Branch.print_file."""
2584
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)
2586
2259
@needs_write_lock
2587
2260
def set_last_revision_info(self, revno, revision_id):
2588
if not revision_id or not isinstance(revision_id, basestring):
2589
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
2590
2271
revision_id = _mod_revision.ensure_null(revision_id)
2591
old_revno, old_revid = self.last_revision_info()
2592
if self.get_append_revisions_only():
2593
self._check_history_violation(revision_id)
2594
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2595
self._write_last_revision_info(revno, revision_id)
2596
self._clear_cached_state()
2597
self._last_revision_info_cache = revno, revision_id
2598
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))
2600
2301
def basis_tree(self):
2601
2302
"""See Branch.basis_tree."""
2722
def _read_last_revision_info(self):
2723
revision_string = self._transport.get_bytes('last-revision')
2724
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2725
revision_id = cache_utf8.get_cached_utf8(revision_id)
2727
return revno, revision_id
2729
def _write_last_revision_info(self, revno, revision_id):
2730
"""Simply write out the revision id, with no checks.
2732
Use set_last_revision_info to perform this safely.
2734
Does not update the revision_history cache.
2736
revision_id = _mod_revision.ensure_null(revision_id)
2737
out_string = '%d %s\n' % (revno, revision_id)
2738
self._transport.put_bytes('last-revision', out_string,
2739
mode=self.bzrdir._get_file_mode())
2742
def update_feature_flags(self, updated_flags):
2743
"""Update the feature flags for this branch.
2745
:param updated_flags: Dictionary mapping feature names to necessities
2746
A necessity can be None to indicate the feature should be removed
2748
self._format._update_feature_flags(updated_flags)
2749
self.control_transport.put_bytes('format', self._format.as_string())
2752
class FullHistoryBzrBranch(BzrBranch):
2753
"""Bzr branch which contains the full revision history."""
2756
def set_last_revision_info(self, revno, revision_id):
2757
if not revision_id or not isinstance(revision_id, basestring):
2758
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2759
revision_id = _mod_revision.ensure_null(revision_id)
2760
# this old format stores the full history, but this api doesn't
2761
# provide it, so we must generate, and might as well check it's
2763
history = self._lefthand_history(revision_id)
2764
if len(history) != revno:
2765
raise AssertionError('%d != %d' % (len(history), revno))
2766
self._set_revision_history(history)
2768
def _read_last_revision_info(self):
2769
rh = self._revision_history()
2772
return (revno, rh[-1])
2774
return (0, _mod_revision.NULL_REVISION)
2776
@deprecated_method(deprecated_in((2, 4, 0)))
2778
def set_revision_history(self, rev_history):
2779
"""See Branch.set_revision_history."""
2780
self._set_revision_history(rev_history)
2782
def _set_revision_history(self, rev_history):
2783
if 'evil' in debug.debug_flags:
2784
mutter_callsite(3, "set_revision_history scales with history.")
2785
check_not_reserved_id = _mod_revision.check_not_reserved_id
2786
for rev_id in rev_history:
2787
check_not_reserved_id(rev_id)
2788
if Branch.hooks['post_change_branch_tip']:
2789
# Don't calculate the last_revision_info() if there are no hooks
2791
old_revno, old_revid = self.last_revision_info()
2792
if len(rev_history) == 0:
2793
revid = _mod_revision.NULL_REVISION
2795
revid = rev_history[-1]
2796
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2797
self._write_revision_history(rev_history)
2798
self._clear_cached_state()
2799
self._cache_revision_history(rev_history)
2800
for hook in Branch.hooks['set_rh']:
2801
hook(self, rev_history)
2802
if Branch.hooks['post_change_branch_tip']:
2803
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2805
def _write_revision_history(self, history):
2806
"""Factored out of set_revision_history.
2808
This performs the actual writing to disk.
2809
It is intended to be called by set_revision_history."""
2810
self._transport.put_bytes(
2811
'revision-history', '\n'.join(history),
2812
mode=self.bzrdir._get_file_mode())
2814
def _gen_revision_history(self):
2815
history = self._transport.get_bytes('revision-history').split('\n')
2816
if history[-1:] == ['']:
2817
# There shouldn't be a trailing newline, but just in case.
2821
def _synchronize_history(self, destination, revision_id):
2822
if not isinstance(destination, FullHistoryBzrBranch):
2823
super(BzrBranch, self)._synchronize_history(
2824
destination, revision_id)
2826
if revision_id == _mod_revision.NULL_REVISION:
2829
new_history = self._revision_history()
2830
if revision_id is not None and new_history != []:
2832
new_history = new_history[:new_history.index(revision_id) + 1]
2834
rev = self.repository.get_revision(revision_id)
2835
new_history = rev.get_history(self.repository)[1:]
2836
destination._set_revision_history(new_history)
2839
def generate_revision_history(self, revision_id, last_rev=None,
2841
"""Create a new revision history that will finish with revision_id.
2843
:param revision_id: the new tip to use.
2844
:param last_rev: The previous last_revision. If not None, then this
2845
must be a ancestory of revision_id, or DivergedBranches is raised.
2846
:param other_branch: The other branch that DivergedBranches should
2847
raise with respect to.
2849
self._set_revision_history(self._lefthand_history(revision_id,
2850
last_rev, other_branch))
2853
class BzrBranch5(FullHistoryBzrBranch):
2854
"""A format 5 branch. This supports new features over plain branches.
2856
It has support for a master_branch which is the data for bound branches.
2860
class BzrBranch8(BzrBranch):
2451
class BzrBranch8(BzrBranch5):
2861
2452
"""A branch that stores tree-reference locations."""
2863
def _open_hook(self, possible_transports=None):
2454
def _open_hook(self):
2864
2455
if self._ignore_fallbacks:
2866
if possible_transports is None:
2867
possible_transports = [self.bzrdir.root_transport]
2869
2458
url = self.get_stacked_on_url()
2870
2459
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2892
2480
self._last_revision_info_cache = None
2893
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)
2895
2528
def _check_history_violation(self, revision_id):
2896
current_revid = self.last_revision()
2897
last_revision = _mod_revision.ensure_null(current_revid)
2529
last_revision = _mod_revision.ensure_null(self.last_revision())
2898
2530
if _mod_revision.is_null(last_revision):
2900
graph = self.repository.get_graph()
2901
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2902
if lh_ancestor == current_revid:
2904
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2532
if last_revision not in self._lefthand_history(revision_id):
2533
raise errors.AppendRevisionsOnlyViolation(self.base)
2906
2535
def _gen_revision_history(self):
2907
2536
"""Generate the revision history from last revision
3328
2988
raise NotImplementedError(self.push)
3331
def copy_content_into(self, revision_id=None):
3332
"""Copy the content of source into target
3334
revision_id: if not None, the revision history in the new branch will
3335
be truncated to end with revision_id.
3337
raise NotImplementedError(self.copy_content_into)
3340
def fetch(self, stop_revision=None, limit=None):
3343
:param stop_revision: Last revision to fetch
3344
:param limit: Optional rough limit of revisions to fetch
3346
raise NotImplementedError(self.fetch)
3349
2991
class GenericInterBranch(InterBranch):
3350
"""InterBranch implementation that uses public Branch functions."""
3353
def is_compatible(klass, source, target):
3354
# GenericBranch uses the public API, so always compatible
3358
def _get_branch_formats_to_test(klass):
3359
return [(format_registry.get_default(), format_registry.get_default())]
3362
def unwrap_format(klass, format):
3363
if isinstance(format, remote.RemoteBranchFormat):
3364
format._ensure_real()
3365
return format._custom_format
3369
def copy_content_into(self, revision_id=None):
3370
"""Copy the content of source into target
3372
revision_id: if not None, the revision history in the new branch will
3373
be truncated to end with revision_id.
3375
self.source.update_references(self.target)
3376
self.source._synchronize_history(self.target, revision_id)
3378
parent = self.source.get_parent()
3379
except errors.InaccessibleParent, e:
3380
mutter('parent was not accessible to copy: %s', e)
3383
self.target.set_parent(parent)
3384
if self.source._push_should_merge_tags():
3385
self.source.tags.merge_to(self.target.tags)
3388
def fetch(self, stop_revision=None, limit=None):
3389
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()."""
3391
3002
self.source.lock_read()
3393
fetch_spec_factory = fetch.FetchSpecFactory()
3394
fetch_spec_factory.source_branch = self.source
3395
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3396
fetch_spec_factory.source_repo = self.source.repository
3397
fetch_spec_factory.target_repo = self.target.repository
3398
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3399
fetch_spec_factory.limit = limit
3400
fetch_spec = fetch_spec_factory.make_fetch_spec()
3401
return self.target.repository.fetch(self.source.repository,
3402
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)
3404
3040
self.source.unlock()
3407
def _update_revisions(self, stop_revision=None, overwrite=False,
3409
other_revno, other_last_revision = self.source.last_revision_info()
3410
stop_revno = None # unknown
3411
if stop_revision is None:
3412
stop_revision = other_last_revision
3413
if _mod_revision.is_null(stop_revision):
3414
# if there are no commits, we're done.
3416
stop_revno = other_revno
3418
# what's the current last revision, before we fetch [and change it
3420
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3421
# we fetch here so that we don't process data twice in the common
3422
# case of having something to pull, and so that the check for
3423
# already merged can operate on the just fetched graph, which will
3424
# be cached in memory.
3425
self.fetch(stop_revision=stop_revision)
3426
# Check to see if one is an ancestor of the other
3429
graph = self.target.repository.get_graph()
3430
if self.target._check_if_descendant_or_diverged(
3431
stop_revision, last_rev, graph, self.source):
3432
# stop_revision is a descendant of last_rev, but we aren't
3433
# overwriting, so we're done.
3435
if stop_revno is None:
3437
graph = self.target.repository.get_graph()
3438
this_revno, this_last_revision = \
3439
self.target.last_revision_info()
3440
stop_revno = graph.find_distance_to_null(stop_revision,
3441
[(other_last_revision, other_revno),
3442
(this_last_revision, this_revno)])
3443
self.target.set_last_revision_info(stop_revno, stop_revision)
3446
3042
def pull(self, overwrite=False, stop_revision=None,
3447
possible_transports=None, run_hooks=True,
3448
_override_hook_target=None, local=False):
3449
"""Pull from source into self, updating my master if any.
3451
:param run_hooks: Private parameter - if false, this branch
3452
is being called because it's the master of the primary branch,
3453
so it should not run its hooks.
3455
bound_location = self.target.get_bound_location()
3456
if local and not bound_location:
3457
raise errors.LocalRequiresBoundBranch()
3458
master_branch = None
3459
source_is_master = False
3461
# bound_location comes from a config file, some care has to be
3462
# taken to relate it to source.user_url
3463
normalized = urlutils.normalize_url(bound_location)
3465
relpath = self.source.user_transport.relpath(normalized)
3466
source_is_master = (relpath == '')
3467
except (errors.PathNotChild, errors.InvalidURL):
3468
source_is_master = False
3469
if not local and bound_location and not source_is_master:
3470
# not pulling from master, so we need to update master.
3471
master_branch = self.target.get_master_branch(possible_transports)
3472
master_branch.lock_write()
3475
# pull from source into master.
3476
master_branch.pull(self.source, overwrite, stop_revision,
3478
return self._pull(overwrite,
3479
stop_revision, _hook_master=master_branch,
3480
run_hooks=run_hooks,
3481
_override_hook_target=_override_hook_target,
3482
merge_tags_to_master=not source_is_master)
3485
master_branch.unlock()
3487
def push(self, overwrite=False, stop_revision=None, lossy=False,
3488
_override_hook_source_branch=None):
3489
"""See InterBranch.push.
3491
This is the basic concrete implementation of push()
3493
:param _override_hook_source_branch: If specified, run the hooks
3494
passing this Branch as the source, rather than self. This is for
3495
use of RemoteBranch, where push is delegated to the underlying
3499
raise errors.LossyPushToSameVCS(self.source, self.target)
3500
# TODO: Public option to disable running hooks - should be trivial but
3503
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3504
op.add_cleanup(self.source.lock_read().unlock)
3505
op.add_cleanup(self.target.lock_write().unlock)
3506
return op.run(overwrite, stop_revision,
3507
_override_hook_source_branch=_override_hook_source_branch)
3509
def _basic_push(self, overwrite, stop_revision):
3510
"""Basic implementation of push without bound branches or hooks.
3512
Must be called with source read locked and target write locked.
3514
result = BranchPushResult()
3515
result.source_branch = self.source
3516
result.target_branch = self.target
3517
result.old_revno, result.old_revid = self.target.last_revision_info()
3518
self.source.update_references(self.target)
3519
if result.old_revid != stop_revision:
3520
# We assume that during 'push' this repository is closer than
3522
graph = self.source.repository.get_graph(self.target.repository)
3523
self._update_revisions(stop_revision, overwrite=overwrite,
3525
if self.source._push_should_merge_tags():
3526
result.tag_updates, result.tag_conflicts = (
3527
self.source.tags.merge_to(self.target.tags, overwrite))
3528
result.new_revno, result.new_revid = self.target.last_revision_info()
3531
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3532
_override_hook_source_branch=None):
3533
"""Push from source into target, and into target's master if any.
3536
if _override_hook_source_branch:
3537
result.source_branch = _override_hook_source_branch
3538
for hook in Branch.hooks['post_push']:
3541
bound_location = self.target.get_bound_location()
3542
if bound_location and self.target.base != bound_location:
3543
# there is a master branch.
3545
# XXX: Why the second check? Is it even supported for a branch to
3546
# be bound to itself? -- mbp 20070507
3547
master_branch = self.target.get_master_branch()
3548
master_branch.lock_write()
3549
operation.add_cleanup(master_branch.unlock)
3550
# push into the master from the source branch.
3551
master_inter = InterBranch.get(self.source, master_branch)
3552
master_inter._basic_push(overwrite, stop_revision)
3553
# and push into the target branch from the source. Note that
3554
# we push from the source branch again, because it's considered
3555
# the highest bandwidth repository.
3556
result = self._basic_push(overwrite, stop_revision)
3557
result.master_branch = master_branch
3558
result.local_branch = self.target
3560
master_branch = None
3562
result = self._basic_push(overwrite, stop_revision)
3563
# TODO: Why set master_branch and local_branch if there's no
3564
# binding? Maybe cleaner to just leave them unset? -- mbp
3566
result.master_branch = self.target
3567
result.local_branch = None
3571
def _pull(self, overwrite=False, stop_revision=None,
3572
3043
possible_transports=None, _hook_master=None, run_hooks=True,
3573
_override_hook_target=None, local=False,
3574
merge_tags_to_master=True):
3044
_override_hook_target=None, local=False):
3575
3045
"""See Branch.pull.
3577
This function is the core worker, used by GenericInterBranch.pull to
3578
avoid duplication when pulling source->master and source->local.
3580
3047
:param _hook_master: Private parameter - set the branch to
3581
3048
be supplied as the master to pull hooks.
3582
3049
:param run_hooks: Private parameter - if false, this branch
3583
3050
is being called because it's the master of the primary branch,
3584
3051
so it should not run its hooks.
3585
is being called because it's the master of the primary branch,
3586
so it should not run its hooks.
3587
3052
:param _override_hook_target: Private parameter - set the branch to be
3588
3053
supplied as the target_branch to pull hooks.
3589
3054
:param local: Only update the local branch, and not the bound branch.
3630
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()
3634
3206
InterBranch.register_optimiser(GenericInterBranch)
3207
InterBranch.register_optimiser(InterToBranch5)