58
71
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
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
######################################################################
74
class Branch(controldir.ControlComponent):
79
75
"""Branch holding a history of revisions.
82
Base directory/url of the branch.
84
hooks: An instance of BranchHooks.
78
Base directory/url of the branch; using control_url and
79
control_transport is more standardized.
80
:ivar hooks: An instance of BranchHooks.
81
:ivar _master_branch_cache: cached result of get_master_branch, see
86
84
# this is really an instance variable - FIXME move it there
90
def __init__(self, *ignored, **ignored_too):
89
def control_transport(self):
90
return self._transport
93
def user_transport(self):
94
return self.bzrdir.user_transport
96
def __init__(self, possible_transports=None):
91
97
self.tags = self._format.make_tags(self)
92
98
self._revision_history_cache = None
93
99
self._revision_id_to_revno_cache = None
94
100
self._partial_revision_id_to_revno_cache = {}
95
101
self._partial_revision_history_cache = []
102
self._tags_bytes = None
96
103
self._last_revision_info_cache = None
104
self._master_branch_cache = None
97
105
self._merge_sorted_revisions_cache = None
106
self._open_hook(possible_transports)
99
107
hooks = Branch.hooks['open']
100
108
for hook in hooks:
103
def _open_hook(self):
111
def _open_hook(self, possible_transports):
104
112
"""Called by init to allow simpler extension of the base class."""
106
def _activate_fallback_location(self, url):
114
def _activate_fallback_location(self, url, possible_transports):
107
115
"""Activate the branch/repository from url as a fallback repository."""
108
repo = self._get_fallback_repository(url)
116
for existing_fallback_repo in self.repository._fallback_repositories:
117
if existing_fallback_repo.user_url == url:
118
# This fallback is already configured. This probably only
119
# happens because ControlDir.sprout is a horrible mess. To avoid
120
# confusing _unstack we don't add this a second time.
121
mutter('duplicate activation of fallback %r on %r', url, self)
123
repo = self._get_fallback_repository(url, possible_transports)
109
124
if repo.has_same_location(self.repository):
110
raise errors.UnstackableLocationError(self.base, url)
125
raise errors.UnstackableLocationError(self.user_url, url)
111
126
self.repository.add_fallback_repository(repo)
113
128
def break_lock(self):
724
878
old_repository = self.repository
725
879
if len(old_repository._fallback_repositories) != 1:
726
880
raise AssertionError("can't cope with fallback repositories "
727
"of %r" % (self.repository,))
728
# unlock it, including unlocking the fallback
881
"of %r (fallbacks: %r)" % (old_repository,
882
old_repository._fallback_repositories))
883
# Open the new repository object.
884
# Repositories don't offer an interface to remove fallback
885
# repositories today; take the conceptually simpler option and just
886
# reopen it. We reopen it starting from the URL so that we
887
# get a separate connection for RemoteRepositories and can
888
# stream from one of them to the other. This does mean doing
889
# separate SSH connection setup, but unstacking is not a
890
# common operation so it's tolerable.
891
new_bzrdir = controldir.ControlDir.open(
892
self.bzrdir.root_transport.base)
893
new_repository = new_bzrdir.find_repository()
894
if new_repository._fallback_repositories:
895
raise AssertionError("didn't expect %r to have "
896
"fallback_repositories"
897
% (self.repository,))
898
# Replace self.repository with the new repository.
899
# Do our best to transfer the lock state (i.e. lock-tokens and
900
# lock count) of self.repository to the new repository.
901
lock_token = old_repository.lock_write().repository_token
902
self.repository = new_repository
903
if isinstance(self, remote.RemoteBranch):
904
# Remote branches can have a second reference to the old
905
# repository that need to be replaced.
906
if self._real_branch is not None:
907
self._real_branch.repository = new_repository
908
self.repository.lock_write(token=lock_token)
909
if lock_token is not None:
910
old_repository.leave_lock_in_place()
729
911
old_repository.unlock()
912
if lock_token is not None:
913
# XXX: self.repository.leave_lock_in_place() before this
914
# function will not be preserved. Fortunately that doesn't
915
# affect the current default format (2a), and would be a
916
# corner-case anyway.
917
# - Andrew Bennetts, 2010/06/30
918
self.repository.dont_leave_lock_in_place()
922
old_repository.unlock()
923
except errors.LockNotHeld:
926
if old_lock_count == 0:
927
raise AssertionError(
928
'old_repository should have been locked at least once.')
929
for i in range(old_lock_count-1):
930
self.repository.lock_write()
931
# Fetch from the old repository into the new.
730
932
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
749
self.repository.lock_write()
750
934
# XXX: If you unstack a branch while it has a working tree
751
935
# with a pending merge, the pending-merged revisions will no
752
936
# longer be present. You can (probably) revert and remerge.
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(),
938
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
939
except errors.TagsNotSupported:
940
tags_to_fetch = set()
941
fetch_spec = vf_search.NotInOtherForRevs(self.repository,
942
old_repository, required_ids=[self.last_revision()],
943
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
944
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
761
946
old_repository.unlock()
859
1055
:return: A tuple (revno, revision_id).
861
1057
if self._last_revision_info_cache is None:
862
self._last_revision_info_cache = self._last_revision_info()
1058
self._last_revision_info_cache = self._read_last_revision_info()
863
1059
return self._last_revision_info_cache
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,
1061
def _read_last_revision_info(self):
1062
raise NotImplementedError(self._read_last_revision_info)
1064
@deprecated_method(deprecated_in((2, 4, 0)))
912
1065
def import_last_revision_info(self, source_repo, revno, revid):
913
1066
"""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.
918
1068
:param source_repo: Source repository to optionally fetch from
919
1069
:param revno: Revision number of the new tip
920
1070
:param revid: Revision id of the new tip
1434
1607
return not (self == other)
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')
1610
@deprecated_method(deprecated_in((2, 4, 0)))
1449
1611
def get_default_format(klass):
1450
1612
"""Return the current default format."""
1451
return klass._default_format
1453
def get_reference(self, a_bzrdir):
1454
"""Get the target reference of the branch in a_bzrdir.
1613
return format_registry.get_default()
1616
@deprecated_method(deprecated_in((2, 4, 0)))
1617
def get_formats(klass):
1618
"""Get all the known formats.
1620
Warning: This triggers a load of all lazy registered formats: do not
1621
use except when that is desireed.
1623
return format_registry._get_all()
1625
def get_reference(self, controldir, name=None):
1626
"""Get the target reference of the branch in controldir.
1456
1628
format probing must have been completed before calling
1457
1629
this method - it is assumed that the format of the branch
1458
in a_bzrdir is correct.
1630
in controldir is correct.
1460
:param a_bzrdir: The bzrdir to get the branch data from.
1632
:param controldir: The controldir to get the branch data from.
1633
:param name: Name of the colocated branch to fetch
1461
1634
:return: None if the branch is not a reference branch.
1466
def set_reference(self, a_bzrdir, to_branch):
1467
"""Set the target reference of the branch in a_bzrdir.
1639
def set_reference(self, controldir, name, to_branch):
1640
"""Set the target reference of the branch in controldir.
1469
1642
format probing must have been completed before calling
1470
1643
this method - it is assumed that the format of the branch
1471
in a_bzrdir is correct.
1644
in controldir is correct.
1473
:param a_bzrdir: The bzrdir to set the branch reference for.
1646
:param controldir: The controldir to set the branch reference for.
1647
:param name: Name of colocated branch to set, None for default
1474
1648
:param to_branch: branch that the checkout is to reference
1476
1650
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)
1482
1652
def get_format_description(self):
1483
1653
"""Return the short format description for this format."""
1484
1654
raise NotImplementedError(self.get_format_description)
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
1656
def _run_post_branch_init_hooks(self, controldir, name, branch):
1657
hooks = Branch.hooks['post_branch_init']
1660
params = BranchInitHookParams(self, controldir, name, branch)
1664
def initialize(self, controldir, name=None, repository=None,
1665
append_revisions_only=None):
1666
"""Create a branch of this format in controldir.
1668
:param name: Name of the colocated branch to create.
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."""
1530
1670
raise NotImplementedError(self.initialize)
1532
1672
def is_supported(self):
1645
1831
"basis revision. hooks MUST NOT modify this delta. "
1646
1832
" future_tree is an in-memory tree obtained from "
1647
1833
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1648
"tree.", (0,91), None))
1649
self.create_hook(HookPoint('post_commit',
1835
self.add_hook('post_commit',
1650
1836
"Called in the bzr client after a commit has completed. "
1651
1837
"post_commit is called with (local, master, old_revno, old_revid, "
1652
1838
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1653
"commit to a branch.", (0, 15), None))
1654
self.create_hook(HookPoint('post_uncommit',
1839
"commit to a branch.", (0, 15))
1840
self.add_hook('post_uncommit',
1655
1841
"Called in the bzr client after an uncommit completes. "
1656
1842
"post_uncommit is called with (local, master, old_revno, "
1657
1843
"old_revid, new_revno, new_revid) where local is the local branch "
1658
1844
"or None, master is the target branch, and an empty branch "
1659
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1660
self.create_hook(HookPoint('pre_change_branch_tip',
1845
"receives new_revno of 0, new_revid of None.", (0, 15))
1846
self.add_hook('pre_change_branch_tip',
1661
1847
"Called in bzr client and server before a change to the tip of a "
1662
1848
"branch is made. pre_change_branch_tip is called with a "
1663
1849
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1664
"commit, uncommit will all trigger this hook.", (1, 6), None))
1665
self.create_hook(HookPoint('post_change_branch_tip',
1850
"commit, uncommit will all trigger this hook.", (1, 6))
1851
self.add_hook('post_change_branch_tip',
1666
1852
"Called in bzr client and server after a change to the tip of a "
1667
1853
"branch is made. post_change_branch_tip is called with a "
1668
1854
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1669
"commit, uncommit will all trigger this hook.", (1, 4), None))
1670
self.create_hook(HookPoint('transform_fallback_location',
1855
"commit, uncommit will all trigger this hook.", (1, 4))
1856
self.add_hook('transform_fallback_location',
1671
1857
"Called when a stacked branch is activating its fallback "
1672
1858
"locations. transform_fallback_location is called with (branch, "
1673
1859
"url), and should return a new url. Returning the same url "
1723
1926
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
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)
1929
class BranchInitHookParams(object):
1930
"""Object holding parameters passed to `*_branch_init` hooks.
1932
There are 4 fields that hooks may wish to access:
1934
:ivar format: the branch format
1935
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1936
:ivar name: name of colocated branch, if any (or None)
1937
:ivar branch: the branch created
1939
Note that for lightweight checkouts, the bzrdir and format fields refer to
1940
the checkout, hence they are different from the corresponding fields in
1941
branch, which refer to the original branch.
1944
def __init__(self, format, controldir, name, branch):
1945
"""Create a group of BranchInitHook parameters.
1947
:param format: the branch format
1948
:param controldir: the ControlDir where the branch will be/has been
1950
:param name: name of colocated branch, if any (or None)
1951
:param branch: the branch created
1953
Note that for lightweight checkouts, the bzrdir and format fields refer
1954
to the checkout, hence they are different from the corresponding fields
1955
in branch, which refer to the original branch.
1957
self.format = format
1958
self.bzrdir = controldir
1960
self.branch = branch
1962
def __eq__(self, other):
1963
return self.__dict__ == other.__dict__
1966
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1969
class SwitchHookParams(object):
1970
"""Object holding parameters passed to `*_switch` hooks.
1972
There are 4 fields that hooks may wish to access:
1974
:ivar control_dir: ControlDir of the checkout to change
1975
:ivar to_branch: branch that the checkout is to reference
1976
:ivar force: skip the check for local commits in a heavy checkout
1977
:ivar revision_id: revision ID to switch to (or None)
1980
def __init__(self, control_dir, to_branch, force, revision_id):
1981
"""Create a group of SwitchHook parameters.
1983
:param control_dir: ControlDir of the checkout to change
1984
:param to_branch: branch that the checkout is to reference
1985
:param force: skip the check for local commits in a heavy checkout
1986
:param revision_id: revision ID to switch to (or None)
1988
self.control_dir = control_dir
1989
self.to_branch = to_branch
1991
self.revision_id = revision_id
1993
def __eq__(self, other):
1994
return self.__dict__ == other.__dict__
1997
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1998
self.control_dir, self.to_branch,
2002
class BranchFormatMetadir(bzrdir.BzrDirMetaComponentFormat, BranchFormat):
2003
"""Base class for branch formats that live in meta directories.
1746
2006
def __init__(self):
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."""
2007
BranchFormat.__init__(self)
2008
bzrdir.BzrDirMetaComponentFormat.__init__(self)
2011
def find_format(klass, controldir, name=None):
2012
"""Return the format for the branch object in controldir."""
2014
transport = controldir.get_branch_transport(None, name=name)
2015
except errors.NoSuchFile:
2016
raise errors.NotBranchError(path=name, bzrdir=controldir)
2018
format_string = transport.get_bytes("format")
2019
except errors.NoSuchFile:
2020
raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
2021
return klass._find_format(format_registry, 'branch', format_string)
1771
2023
def _branch_class(self):
1772
2024
"""What class to instantiate on open calls."""
1773
2025
raise NotImplementedError(self._branch_class)
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.
2027
def _get_initial_config(self, append_revisions_only=None):
2028
if append_revisions_only:
2029
return "append_revisions_only = True\n"
2031
# Avoid writing anything if append_revisions_only is disabled,
2032
# as that is the default.
2035
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
2037
"""Initialize a branch in a bzrdir, with specified files
2039
:param a_bzrdir: The bzrdir to initialize the branch in
2040
:param utf8_files: The files to create as a list of
2041
(filename, content) tuples
2042
:param name: Name of colocated branch to create, if any
2043
:return: a branch in this format
1780
return self.get_format_string()
2045
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2046
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2047
control_files = lockable_files.LockableFiles(branch_transport,
2048
'lock', lockdir.LockDir)
2049
control_files.create_lock()
2050
control_files.lock_write()
2052
utf8_files += [('format', self.get_format_string())]
2053
for (filename, content) in utf8_files:
2054
branch_transport.put_bytes(
2056
mode=a_bzrdir._get_file_mode())
2058
control_files.unlock()
2059
branch = self.open(a_bzrdir, name, _found=True,
2060
found_repository=repository)
2061
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1782
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
2064
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2065
found_repository=None, possible_transports=None):
1783
2066
"""See BranchFormat.open()."""
1785
format = BranchFormat.find_format(a_bzrdir)
2068
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
1786
2069
if format.__class__ != self.__class__:
1787
2070
raise AssertionError("wrong format %r found for %r" %
1788
2071
(format, self))
2072
transport = a_bzrdir.get_branch_transport(None, name=name)
1790
transport = a_bzrdir.get_branch_transport(None)
1791
2074
control_files = lockable_files.LockableFiles(transport, 'lock',
1792
2075
lockdir.LockDir)
2076
if found_repository is None:
2077
found_repository = a_bzrdir.find_repository()
1793
2078
return self._branch_class()(_format=self,
1794
2079
_control_files=control_files,
1795
2081
a_bzrdir=a_bzrdir,
1796
_repository=a_bzrdir.find_repository(),
1797
ignore_fallbacks=ignore_fallbacks)
2082
_repository=found_repository,
2083
ignore_fallbacks=ignore_fallbacks,
2084
possible_transports=possible_transports)
1798
2085
except errors.NoSuchFile:
1799
2086
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1802
super(BranchFormatMetadir, self).__init__()
1803
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1804
self._matchingbzrdir.set_branch_format(self)
2089
def _matchingbzrdir(self):
2090
ret = bzrdir.BzrDirMetaFormat1()
2091
ret.set_branch_format(self)
1806
2094
def supports_tags(self):
2097
def supports_leaving_lock(self):
1810
2101
class BzrBranchFormat5(BranchFormatMetadir):
1811
2102
"""Bzr branch format 5.
1974
2281
"""See BranchFormat.get_format_description()."""
1975
2282
return "Checkout reference format 1"
1977
def get_reference(self, a_bzrdir):
2284
def get_reference(self, a_bzrdir, name=None):
1978
2285
"""See BranchFormat.get_reference()."""
1979
transport = a_bzrdir.get_branch_transport(None)
2286
transport = a_bzrdir.get_branch_transport(None, name=name)
1980
2287
return transport.get_bytes('location')
1982
def set_reference(self, a_bzrdir, to_branch):
2289
def set_reference(self, a_bzrdir, name, to_branch):
1983
2290
"""See BranchFormat.set_reference()."""
1984
transport = a_bzrdir.get_branch_transport(None)
2291
transport = a_bzrdir.get_branch_transport(None, name=name)
1985
2292
location = transport.put_bytes('location', to_branch.base)
1987
def initialize(self, a_bzrdir, target_branch=None):
2294
def initialize(self, a_bzrdir, name=None, target_branch=None,
2295
repository=None, append_revisions_only=None):
1988
2296
"""Create a branch of this format in a_bzrdir."""
1989
2297
if target_branch is None:
1990
2298
# this format does not implement branch itself, thus the implicit
1991
2299
# creation contract must see it as uninitializable
1992
2300
raise errors.UninitializableFormat(self)
1993
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1994
branch_transport = a_bzrdir.get_branch_transport(self)
2301
mutter('creating branch reference in %s', a_bzrdir.user_url)
2302
if a_bzrdir._format.fixed_components:
2303
raise errors.IncompatibleFormat(self, a_bzrdir._format)
2304
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1995
2305
branch_transport.put_bytes('location',
1996
target_branch.bzrdir.root_transport.base)
2306
target_branch.user_url)
1997
2307
branch_transport.put_bytes('format', self.get_format_string())
1999
a_bzrdir, _found=True,
2309
a_bzrdir, name, _found=True,
2000
2310
possible_transports=[target_branch.bzrdir.root_transport])
2003
super(BranchReferenceFormat, self).__init__()
2004
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2005
self._matchingbzrdir.set_branch_format(self)
2311
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2007
2314
def _make_reference_clone_function(format, a_branch):
2008
2315
"""Create a clone() routine for a branch dynamically."""
2009
2316
def clone(to_bzrdir, revision_id=None,
2010
2317
repository_policy=None):
2011
2318
"""See Branch.clone()."""
2012
return format.initialize(to_bzrdir, a_branch)
2319
return format.initialize(to_bzrdir, target_branch=a_branch)
2013
2320
# cannot obey revision_id limits when cloning a reference ...
2014
2321
# FIXME RBC 20060210 either nuke revision_id for clone, or
2015
2322
# emit some sort of warning/error to the caller ?!
2018
def open(self, a_bzrdir, _found=False, location=None,
2019
possible_transports=None, ignore_fallbacks=False):
2325
def open(self, a_bzrdir, name=None, _found=False, location=None,
2326
possible_transports=None, ignore_fallbacks=False,
2327
found_repository=None):
2020
2328
"""Return the branch that the branch reference in a_bzrdir points at.
2022
2330
:param a_bzrdir: A BzrDir that contains a branch.
2331
:param name: Name of colocated branch to open, if any
2023
2332
:param _found: a private parameter, do not use it. It is used to
2024
2333
indicate if format probing has already be done.
2025
2334
:param ignore_fallbacks: when set, no fallback branches will be opened
2193
2557
"""See Branch.print_file."""
2194
2558
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)
2259
2560
@needs_write_lock
2260
2561
def set_last_revision_info(self, revno, revision_id):
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
2562
if not revision_id or not isinstance(revision_id, basestring):
2563
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2271
2564
revision_id = _mod_revision.ensure_null(revision_id)
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))
2565
old_revno, old_revid = self.last_revision_info()
2566
if self.get_append_revisions_only():
2567
self._check_history_violation(revision_id)
2568
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2569
self._write_last_revision_info(revno, revision_id)
2570
self._clear_cached_state()
2571
self._last_revision_info_cache = revno, revision_id
2572
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2301
2574
def basis_tree(self):
2302
2575
"""See Branch.basis_tree."""
2451
class BzrBranch8(BzrBranch5):
2696
def _read_last_revision_info(self):
2697
revision_string = self._transport.get_bytes('last-revision')
2698
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2699
revision_id = cache_utf8.get_cached_utf8(revision_id)
2701
return revno, revision_id
2703
def _write_last_revision_info(self, revno, revision_id):
2704
"""Simply write out the revision id, with no checks.
2706
Use set_last_revision_info to perform this safely.
2708
Does not update the revision_history cache.
2710
revision_id = _mod_revision.ensure_null(revision_id)
2711
out_string = '%d %s\n' % (revno, revision_id)
2712
self._transport.put_bytes('last-revision', out_string,
2713
mode=self.bzrdir._get_file_mode())
2716
class FullHistoryBzrBranch(BzrBranch):
2717
"""Bzr branch which contains the full revision history."""
2720
def set_last_revision_info(self, revno, revision_id):
2721
if not revision_id or not isinstance(revision_id, basestring):
2722
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2723
revision_id = _mod_revision.ensure_null(revision_id)
2724
# this old format stores the full history, but this api doesn't
2725
# provide it, so we must generate, and might as well check it's
2727
history = self._lefthand_history(revision_id)
2728
if len(history) != revno:
2729
raise AssertionError('%d != %d' % (len(history), revno))
2730
self._set_revision_history(history)
2732
def _read_last_revision_info(self):
2733
rh = self._revision_history()
2736
return (revno, rh[-1])
2738
return (0, _mod_revision.NULL_REVISION)
2740
@deprecated_method(deprecated_in((2, 4, 0)))
2742
def set_revision_history(self, rev_history):
2743
"""See Branch.set_revision_history."""
2744
self._set_revision_history(rev_history)
2746
def _set_revision_history(self, rev_history):
2747
if 'evil' in debug.debug_flags:
2748
mutter_callsite(3, "set_revision_history scales with history.")
2749
check_not_reserved_id = _mod_revision.check_not_reserved_id
2750
for rev_id in rev_history:
2751
check_not_reserved_id(rev_id)
2752
if Branch.hooks['post_change_branch_tip']:
2753
# Don't calculate the last_revision_info() if there are no hooks
2755
old_revno, old_revid = self.last_revision_info()
2756
if len(rev_history) == 0:
2757
revid = _mod_revision.NULL_REVISION
2759
revid = rev_history[-1]
2760
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2761
self._write_revision_history(rev_history)
2762
self._clear_cached_state()
2763
self._cache_revision_history(rev_history)
2764
for hook in Branch.hooks['set_rh']:
2765
hook(self, rev_history)
2766
if Branch.hooks['post_change_branch_tip']:
2767
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2769
def _write_revision_history(self, history):
2770
"""Factored out of set_revision_history.
2772
This performs the actual writing to disk.
2773
It is intended to be called by set_revision_history."""
2774
self._transport.put_bytes(
2775
'revision-history', '\n'.join(history),
2776
mode=self.bzrdir._get_file_mode())
2778
def _gen_revision_history(self):
2779
history = self._transport.get_bytes('revision-history').split('\n')
2780
if history[-1:] == ['']:
2781
# There shouldn't be a trailing newline, but just in case.
2785
def _synchronize_history(self, destination, revision_id):
2786
if not isinstance(destination, FullHistoryBzrBranch):
2787
super(BzrBranch, self)._synchronize_history(
2788
destination, revision_id)
2790
if revision_id == _mod_revision.NULL_REVISION:
2793
new_history = self._revision_history()
2794
if revision_id is not None and new_history != []:
2796
new_history = new_history[:new_history.index(revision_id) + 1]
2798
rev = self.repository.get_revision(revision_id)
2799
new_history = rev.get_history(self.repository)[1:]
2800
destination._set_revision_history(new_history)
2803
def generate_revision_history(self, revision_id, last_rev=None,
2805
"""Create a new revision history that will finish with revision_id.
2807
:param revision_id: the new tip to use.
2808
:param last_rev: The previous last_revision. If not None, then this
2809
must be a ancestory of revision_id, or DivergedBranches is raised.
2810
:param other_branch: The other branch that DivergedBranches should
2811
raise with respect to.
2813
self._set_revision_history(self._lefthand_history(revision_id,
2814
last_rev, other_branch))
2817
class BzrBranch5(FullHistoryBzrBranch):
2818
"""A format 5 branch. This supports new features over plain branches.
2820
It has support for a master_branch which is the data for bound branches.
2824
class BzrBranch8(BzrBranch):
2452
2825
"""A branch that stores tree-reference locations."""
2454
def _open_hook(self):
2827
def _open_hook(self, possible_transports=None):
2455
2828
if self._ignore_fallbacks:
2830
if possible_transports is None:
2831
possible_transports = [self.bzrdir.root_transport]
2458
2833
url = self.get_stacked_on_url()
2459
2834
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2480
2856
self._last_revision_info_cache = None
2481
2857
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)
2528
2859
def _check_history_violation(self, revision_id):
2529
last_revision = _mod_revision.ensure_null(self.last_revision())
2860
current_revid = self.last_revision()
2861
last_revision = _mod_revision.ensure_null(current_revid)
2530
2862
if _mod_revision.is_null(last_revision):
2532
if last_revision not in self._lefthand_history(revision_id):
2533
raise errors.AppendRevisionsOnlyViolation(self.base)
2864
graph = self.repository.get_graph()
2865
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2866
if lh_ancestor == current_revid:
2868
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2535
2870
def _gen_revision_history(self):
2536
2871
"""Generate the revision history from last revision
2988
3293
raise NotImplementedError(self.push)
3296
def copy_content_into(self, revision_id=None):
3297
"""Copy the content of source into target
3299
revision_id: if not None, the revision history in the new branch will
3300
be truncated to end with revision_id.
3302
raise NotImplementedError(self.copy_content_into)
3305
def fetch(self, stop_revision=None, limit=None):
3308
:param stop_revision: Last revision to fetch
3309
:param limit: Optional rough limit of revisions to fetch
3311
raise NotImplementedError(self.fetch)
2991
3314
class GenericInterBranch(InterBranch):
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()."""
3315
"""InterBranch implementation that uses public Branch functions."""
3318
def is_compatible(klass, source, target):
3319
# GenericBranch uses the public API, so always compatible
3323
def _get_branch_formats_to_test(klass):
3324
return [(format_registry.get_default(), format_registry.get_default())]
3327
def unwrap_format(klass, format):
3328
if isinstance(format, remote.RemoteBranchFormat):
3329
format._ensure_real()
3330
return format._custom_format
3334
def copy_content_into(self, revision_id=None):
3335
"""Copy the content of source into target
3337
revision_id: if not None, the revision history in the new branch will
3338
be truncated to end with revision_id.
3340
self.source.update_references(self.target)
3341
self.source._synchronize_history(self.target, revision_id)
3343
parent = self.source.get_parent()
3344
except errors.InaccessibleParent, e:
3345
mutter('parent was not accessible to copy: %s', e)
3348
self.target.set_parent(parent)
3349
if self.source._push_should_merge_tags():
3350
self.source.tags.merge_to(self.target.tags)
3353
def fetch(self, stop_revision=None, limit=None):
3354
if self.target.base == self.source.base:
3002
3356
self.source.lock_read()
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)
3358
fetch_spec_factory = fetch.FetchSpecFactory()
3359
fetch_spec_factory.source_branch = self.source
3360
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3361
fetch_spec_factory.source_repo = self.source.repository
3362
fetch_spec_factory.target_repo = self.target.repository
3363
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3364
fetch_spec_factory.limit = limit
3365
fetch_spec = fetch_spec_factory.make_fetch_spec()
3366
return self.target.repository.fetch(self.source.repository,
3367
fetch_spec=fetch_spec)
3040
3369
self.source.unlock()
3372
def _update_revisions(self, stop_revision=None, overwrite=False,
3374
other_revno, other_last_revision = self.source.last_revision_info()
3375
stop_revno = None # unknown
3376
if stop_revision is None:
3377
stop_revision = other_last_revision
3378
if _mod_revision.is_null(stop_revision):
3379
# if there are no commits, we're done.
3381
stop_revno = other_revno
3383
# what's the current last revision, before we fetch [and change it
3385
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3386
# we fetch here so that we don't process data twice in the common
3387
# case of having something to pull, and so that the check for
3388
# already merged can operate on the just fetched graph, which will
3389
# be cached in memory.
3390
self.fetch(stop_revision=stop_revision)
3391
# Check to see if one is an ancestor of the other
3394
graph = self.target.repository.get_graph()
3395
if self.target._check_if_descendant_or_diverged(
3396
stop_revision, last_rev, graph, self.source):
3397
# stop_revision is a descendant of last_rev, but we aren't
3398
# overwriting, so we're done.
3400
if stop_revno is None:
3402
graph = self.target.repository.get_graph()
3403
this_revno, this_last_revision = \
3404
self.target.last_revision_info()
3405
stop_revno = graph.find_distance_to_null(stop_revision,
3406
[(other_last_revision, other_revno),
3407
(this_last_revision, this_revno)])
3408
self.target.set_last_revision_info(stop_revno, stop_revision)
3042
3411
def pull(self, overwrite=False, stop_revision=None,
3412
possible_transports=None, run_hooks=True,
3413
_override_hook_target=None, local=False):
3414
"""Pull from source into self, updating my master if any.
3416
:param run_hooks: Private parameter - if false, this branch
3417
is being called because it's the master of the primary branch,
3418
so it should not run its hooks.
3420
bound_location = self.target.get_bound_location()
3421
if local and not bound_location:
3422
raise errors.LocalRequiresBoundBranch()
3423
master_branch = None
3424
source_is_master = False
3426
# bound_location comes from a config file, some care has to be
3427
# taken to relate it to source.user_url
3428
normalized = urlutils.normalize_url(bound_location)
3430
relpath = self.source.user_transport.relpath(normalized)
3431
source_is_master = (relpath == '')
3432
except (errors.PathNotChild, errors.InvalidURL):
3433
source_is_master = False
3434
if not local and bound_location and not source_is_master:
3435
# not pulling from master, so we need to update master.
3436
master_branch = self.target.get_master_branch(possible_transports)
3437
master_branch.lock_write()
3440
# pull from source into master.
3441
master_branch.pull(self.source, overwrite, stop_revision,
3443
return self._pull(overwrite,
3444
stop_revision, _hook_master=master_branch,
3445
run_hooks=run_hooks,
3446
_override_hook_target=_override_hook_target,
3447
merge_tags_to_master=not source_is_master)
3450
master_branch.unlock()
3452
def push(self, overwrite=False, stop_revision=None, lossy=False,
3453
_override_hook_source_branch=None):
3454
"""See InterBranch.push.
3456
This is the basic concrete implementation of push()
3458
:param _override_hook_source_branch: If specified, run the hooks
3459
passing this Branch as the source, rather than self. This is for
3460
use of RemoteBranch, where push is delegated to the underlying
3464
raise errors.LossyPushToSameVCS(self.source, self.target)
3465
# TODO: Public option to disable running hooks - should be trivial but
3468
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3469
op.add_cleanup(self.source.lock_read().unlock)
3470
op.add_cleanup(self.target.lock_write().unlock)
3471
return op.run(overwrite, stop_revision,
3472
_override_hook_source_branch=_override_hook_source_branch)
3474
def _basic_push(self, overwrite, stop_revision):
3475
"""Basic implementation of push without bound branches or hooks.
3477
Must be called with source read locked and target write locked.
3479
result = BranchPushResult()
3480
result.source_branch = self.source
3481
result.target_branch = self.target
3482
result.old_revno, result.old_revid = self.target.last_revision_info()
3483
self.source.update_references(self.target)
3484
if result.old_revid != stop_revision:
3485
# We assume that during 'push' this repository is closer than
3487
graph = self.source.repository.get_graph(self.target.repository)
3488
self._update_revisions(stop_revision, overwrite=overwrite,
3490
if self.source._push_should_merge_tags():
3491
result.tag_updates, result.tag_conflicts = (
3492
self.source.tags.merge_to(self.target.tags, overwrite))
3493
result.new_revno, result.new_revid = self.target.last_revision_info()
3496
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3497
_override_hook_source_branch=None):
3498
"""Push from source into target, and into target's master if any.
3501
if _override_hook_source_branch:
3502
result.source_branch = _override_hook_source_branch
3503
for hook in Branch.hooks['post_push']:
3506
bound_location = self.target.get_bound_location()
3507
if bound_location and self.target.base != bound_location:
3508
# there is a master branch.
3510
# XXX: Why the second check? Is it even supported for a branch to
3511
# be bound to itself? -- mbp 20070507
3512
master_branch = self.target.get_master_branch()
3513
master_branch.lock_write()
3514
operation.add_cleanup(master_branch.unlock)
3515
# push into the master from the source branch.
3516
master_inter = InterBranch.get(self.source, master_branch)
3517
master_inter._basic_push(overwrite, stop_revision)
3518
# and push into the target branch from the source. Note that
3519
# we push from the source branch again, because it's considered
3520
# the highest bandwidth repository.
3521
result = self._basic_push(overwrite, stop_revision)
3522
result.master_branch = master_branch
3523
result.local_branch = self.target
3525
master_branch = None
3527
result = self._basic_push(overwrite, stop_revision)
3528
# TODO: Why set master_branch and local_branch if there's no
3529
# binding? Maybe cleaner to just leave them unset? -- mbp
3531
result.master_branch = self.target
3532
result.local_branch = None
3536
def _pull(self, overwrite=False, stop_revision=None,
3043
3537
possible_transports=None, _hook_master=None, run_hooks=True,
3044
_override_hook_target=None, local=False):
3538
_override_hook_target=None, local=False,
3539
merge_tags_to_master=True):
3045
3540
"""See Branch.pull.
3542
This function is the core worker, used by GenericInterBranch.pull to
3543
avoid duplication when pulling source->master and source->local.
3047
3545
:param _hook_master: Private parameter - set the branch to
3048
3546
be supplied as the master to pull hooks.
3049
3547
:param run_hooks: Private parameter - if false, this branch
3050
3548
is being called because it's the master of the primary branch,
3051
3549
so it should not run its hooks.
3550
is being called because it's the master of the primary branch,
3551
so it should not run its hooks.
3052
3552
:param _override_hook_target: Private parameter - set the branch to be
3053
3553
supplied as the target_branch to pull hooks.
3054
3554
:param local: Only update the local branch, and not the bound branch.
3094
3595
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()
3206
3599
InterBranch.register_optimiser(GenericInterBranch)
3207
InterBranch.register_optimiser(InterToBranch5)