58
72
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
######################################################################
75
class Branch(controldir.ControlComponent):
79
76
"""Branch holding a history of revisions.
82
Base directory/url of the branch.
84
hooks: An instance of BranchHooks.
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
86
85
# this is really an instance variable - FIXME move it there
90
def __init__(self, *ignored, **ignored_too):
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):
91
98
self.tags = self._format.make_tags(self)
92
99
self._revision_history_cache = None
93
100
self._revision_id_to_revno_cache = None
94
101
self._partial_revision_id_to_revno_cache = {}
95
102
self._partial_revision_history_cache = []
103
self._tags_bytes = None
96
104
self._last_revision_info_cache = None
105
self._master_branch_cache = None
97
106
self._merge_sorted_revisions_cache = None
107
self._open_hook(possible_transports)
99
108
hooks = Branch.hooks['open']
100
109
for hook in hooks:
103
def _open_hook(self):
112
def _open_hook(self, possible_transports):
104
113
"""Called by init to allow simpler extension of the base class."""
106
def _activate_fallback_location(self, url):
115
def _activate_fallback_location(self, url, possible_transports):
107
116
"""Activate the branch/repository from url as a fallback repository."""
108
repo = self._get_fallback_repository(url)
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)
109
125
if repo.has_same_location(self.repository):
110
raise errors.UnstackableLocationError(self.base, url)
126
raise errors.UnstackableLocationError(self.user_url, url)
111
127
self.repository.add_fallback_repository(repo)
113
129
def break_lock(self):
724
879
old_repository = self.repository
725
880
if len(old_repository._fallback_repositories) != 1:
726
881
raise AssertionError("can't cope with fallback repositories "
727
"of %r" % (self.repository,))
728
# unlock it, including unlocking the fallback
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()
729
912
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):
931
self.repository.lock_write()
932
# Fetch from the old repository into the new.
730
933
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
935
# XXX: If you unstack a branch while it has a working tree
751
936
# with a pending merge, the pending-merged revisions will no
752
937
# 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(),
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)
761
947
old_repository.unlock()
859
1056
:return: A tuple (revno, revision_id).
861
1058
if self._last_revision_info_cache is None:
862
self._last_revision_info_cache = self._last_revision_info()
1059
self._last_revision_info_cache = self._read_last_revision_info()
863
1060
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,
1062
def _read_last_revision_info(self):
1063
raise NotImplementedError(self._read_last_revision_info)
1065
@deprecated_method(deprecated_in((2, 4, 0)))
912
1066
def import_last_revision_info(self, source_repo, revno, revid):
913
1067
"""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
1069
:param source_repo: Source repository to optionally fetch from
919
1070
:param revno: Revision number of the new tip
920
1071
:param revid: Revision id of the new tip
1434
1614
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')
1617
@deprecated_method(deprecated_in((2, 4, 0)))
1449
1618
def get_default_format(klass):
1450
1619
"""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.
1620
return format_registry.get_default()
1623
@deprecated_method(deprecated_in((2, 4, 0)))
1624
def get_formats(klass):
1625
"""Get all the known formats.
1627
Warning: This triggers a load of all lazy registered formats: do not
1628
use except when that is desireed.
1630
return format_registry._get_all()
1632
def get_reference(self, controldir, name=None):
1633
"""Get the target reference of the branch in controldir.
1456
1635
format probing must have been completed before calling
1457
1636
this method - it is assumed that the format of the branch
1458
in a_bzrdir is correct.
1637
in controldir is correct.
1460
:param a_bzrdir: The bzrdir to get the branch data from.
1639
:param controldir: The controldir to get the branch data from.
1640
:param name: Name of the colocated branch to fetch
1461
1641
: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.
1646
def set_reference(self, controldir, name, to_branch):
1647
"""Set the target reference of the branch in controldir.
1469
1649
format probing must have been completed before calling
1470
1650
this method - it is assumed that the format of the branch
1471
in a_bzrdir is correct.
1651
in controldir is correct.
1473
:param a_bzrdir: The bzrdir to set the branch reference for.
1653
:param controldir: The controldir to set the branch reference for.
1654
:param name: Name of colocated branch to set, None for default
1474
1655
:param to_branch: branch that the checkout is to reference
1476
1657
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
1659
def get_format_description(self):
1483
1660
"""Return the short format description for this format."""
1484
1661
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
1663
def _run_post_branch_init_hooks(self, controldir, name, branch):
1664
hooks = Branch.hooks['post_branch_init']
1667
params = BranchInitHookParams(self, controldir, name, branch)
1671
def initialize(self, controldir, name=None, repository=None,
1672
append_revisions_only=None):
1673
"""Create a branch of this format in controldir.
1675
: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
1677
raise NotImplementedError(self.initialize)
1532
1679
def is_supported(self):
1645
1838
"basis revision. hooks MUST NOT modify this delta. "
1646
1839
" future_tree is an in-memory tree obtained from "
1647
1840
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1648
"tree.", (0,91), None))
1649
self.create_hook(HookPoint('post_commit',
1842
self.add_hook('post_commit',
1650
1843
"Called in the bzr client after a commit has completed. "
1651
1844
"post_commit is called with (local, master, old_revno, old_revid, "
1652
1845
"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',
1846
"commit to a branch.", (0, 15))
1847
self.add_hook('post_uncommit',
1655
1848
"Called in the bzr client after an uncommit completes. "
1656
1849
"post_uncommit is called with (local, master, old_revno, "
1657
1850
"old_revid, new_revno, new_revid) where local is the local branch "
1658
1851
"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',
1852
"receives new_revno of 0, new_revid of None.", (0, 15))
1853
self.add_hook('pre_change_branch_tip',
1661
1854
"Called in bzr client and server before a change to the tip of a "
1662
1855
"branch is made. pre_change_branch_tip is called with a "
1663
1856
"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',
1857
"commit, uncommit will all trigger this hook.", (1, 6))
1858
self.add_hook('post_change_branch_tip',
1666
1859
"Called in bzr client and server after a change to the tip of a "
1667
1860
"branch is made. post_change_branch_tip is called with a "
1668
1861
"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',
1862
"commit, uncommit will all trigger this hook.", (1, 4))
1863
self.add_hook('transform_fallback_location',
1671
1864
"Called when a stacked branch is activating its fallback "
1672
1865
"locations. transform_fallback_location is called with (branch, "
1673
1866
"url), and should return a new url. Returning the same url "
1723
1933
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)
1936
class BranchInitHookParams(object):
1937
"""Object holding parameters passed to `*_branch_init` hooks.
1939
There are 4 fields that hooks may wish to access:
1941
:ivar format: the branch format
1942
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1943
:ivar name: name of colocated branch, if any (or None)
1944
:ivar branch: the branch created
1946
Note that for lightweight checkouts, the bzrdir and format fields refer to
1947
the checkout, hence they are different from the corresponding fields in
1948
branch, which refer to the original branch.
1951
def __init__(self, format, controldir, name, branch):
1952
"""Create a group of BranchInitHook parameters.
1954
:param format: the branch format
1955
:param controldir: the ControlDir where the branch will be/has been
1957
:param name: name of colocated branch, if any (or None)
1958
:param branch: the branch created
1960
Note that for lightweight checkouts, the bzrdir and format fields refer
1961
to the checkout, hence they are different from the corresponding fields
1962
in branch, which refer to the original branch.
1964
self.format = format
1965
self.bzrdir = controldir
1967
self.branch = branch
1969
def __eq__(self, other):
1970
return self.__dict__ == other.__dict__
1973
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1976
class SwitchHookParams(object):
1977
"""Object holding parameters passed to `*_switch` hooks.
1979
There are 4 fields that hooks may wish to access:
1981
:ivar control_dir: ControlDir of the checkout to change
1982
:ivar to_branch: branch that the checkout is to reference
1983
:ivar force: skip the check for local commits in a heavy checkout
1984
:ivar revision_id: revision ID to switch to (or None)
1987
def __init__(self, control_dir, to_branch, force, revision_id):
1988
"""Create a group of SwitchHook parameters.
1990
:param control_dir: ControlDir of the checkout to change
1991
:param to_branch: branch that the checkout is to reference
1992
:param force: skip the check for local commits in a heavy checkout
1993
:param revision_id: revision ID to switch to (or None)
1995
self.control_dir = control_dir
1996
self.to_branch = to_branch
1998
self.revision_id = revision_id
2000
def __eq__(self, other):
2001
return self.__dict__ == other.__dict__
2004
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
2005
self.control_dir, self.to_branch,
2009
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
2010
"""Base class for branch formats that live in meta directories.
1746
2013
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."""
2014
BranchFormat.__init__(self)
2015
bzrdir.BzrFormat.__init__(self)
2018
def find_format(klass, controldir, name=None):
2019
"""Return the format for the branch object in controldir."""
2021
transport = controldir.get_branch_transport(None, name=name)
2022
except errors.NoSuchFile:
2023
raise errors.NotBranchError(path=name, bzrdir=controldir)
2025
format_string = transport.get_bytes("format")
2026
except errors.NoSuchFile:
2027
raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
2028
return klass._find_format(format_registry, 'branch', format_string)
1771
2030
def _branch_class(self):
1772
2031
"""What class to instantiate on open calls."""
1773
2032
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.
2034
def _get_initial_config(self, append_revisions_only=None):
2035
if append_revisions_only:
2036
return "append_revisions_only = True\n"
2038
# Avoid writing anything if append_revisions_only is disabled,
2039
# as that is the default.
2042
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
2044
"""Initialize a branch in a bzrdir, with specified files
2046
:param a_bzrdir: The bzrdir to initialize the branch in
2047
:param utf8_files: The files to create as a list of
2048
(filename, content) tuples
2049
:param name: Name of colocated branch to create, if any
2050
:return: a branch in this format
1780
return self.get_format_string()
2053
name = a_bzrdir._get_selected_branch()
2054
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2055
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2056
control_files = lockable_files.LockableFiles(branch_transport,
2057
'lock', lockdir.LockDir)
2058
control_files.create_lock()
2059
control_files.lock_write()
2061
utf8_files += [('format', self.as_string())]
2062
for (filename, content) in utf8_files:
2063
branch_transport.put_bytes(
2065
mode=a_bzrdir._get_file_mode())
2067
control_files.unlock()
2068
branch = self.open(a_bzrdir, name, _found=True,
2069
found_repository=repository)
2070
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1782
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
2073
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2074
found_repository=None, possible_transports=None):
1783
2075
"""See BranchFormat.open()."""
2077
name = a_bzrdir._get_selected_branch()
1785
format = BranchFormat.find_format(a_bzrdir)
2079
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
1786
2080
if format.__class__ != self.__class__:
1787
2081
raise AssertionError("wrong format %r found for %r" %
1788
2082
(format, self))
2083
transport = a_bzrdir.get_branch_transport(None, name=name)
1790
transport = a_bzrdir.get_branch_transport(None)
1791
2085
control_files = lockable_files.LockableFiles(transport, 'lock',
1792
2086
lockdir.LockDir)
2087
if found_repository is None:
2088
found_repository = a_bzrdir.find_repository()
1793
2089
return self._branch_class()(_format=self,
1794
2090
_control_files=control_files,
1795
2092
a_bzrdir=a_bzrdir,
1796
_repository=a_bzrdir.find_repository(),
1797
ignore_fallbacks=ignore_fallbacks)
2093
_repository=found_repository,
2094
ignore_fallbacks=ignore_fallbacks,
2095
possible_transports=possible_transports)
1798
2096
except errors.NoSuchFile:
1799
2097
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)
2100
def _matchingbzrdir(self):
2101
ret = bzrdir.BzrDirMetaFormat1()
2102
ret.set_branch_format(self)
1806
2105
def supports_tags(self):
2108
def supports_leaving_lock(self):
2111
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
2113
BranchFormat.check_support_status(self,
2114
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
2116
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
2117
recommend_upgrade=recommend_upgrade, basedir=basedir)
1810
2120
class BzrBranchFormat5(BranchFormatMetadir):
1811
2121
"""Bzr branch format 5.
1974
2300
"""See BranchFormat.get_format_description()."""
1975
2301
return "Checkout reference format 1"
1977
def get_reference(self, a_bzrdir):
2303
def get_reference(self, a_bzrdir, name=None):
1978
2304
"""See BranchFormat.get_reference()."""
1979
transport = a_bzrdir.get_branch_transport(None)
2305
transport = a_bzrdir.get_branch_transport(None, name=name)
1980
2306
return transport.get_bytes('location')
1982
def set_reference(self, a_bzrdir, to_branch):
2308
def set_reference(self, a_bzrdir, name, to_branch):
1983
2309
"""See BranchFormat.set_reference()."""
1984
transport = a_bzrdir.get_branch_transport(None)
2310
transport = a_bzrdir.get_branch_transport(None, name=name)
1985
2311
location = transport.put_bytes('location', to_branch.base)
1987
def initialize(self, a_bzrdir, target_branch=None):
2313
def initialize(self, a_bzrdir, name=None, target_branch=None,
2314
repository=None, append_revisions_only=None):
1988
2315
"""Create a branch of this format in a_bzrdir."""
1989
2316
if target_branch is None:
1990
2317
# this format does not implement branch itself, thus the implicit
1991
2318
# creation contract must see it as uninitializable
1992
2319
raise errors.UninitializableFormat(self)
1993
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1994
branch_transport = a_bzrdir.get_branch_transport(self)
2320
mutter('creating branch reference in %s', a_bzrdir.user_url)
2321
if a_bzrdir._format.fixed_components:
2322
raise errors.IncompatibleFormat(self, a_bzrdir._format)
2324
name = a_bzrdir._get_selected_branch()
2325
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1995
2326
branch_transport.put_bytes('location',
1996
target_branch.bzrdir.root_transport.base)
1997
branch_transport.put_bytes('format', self.get_format_string())
1999
a_bzrdir, _found=True,
2327
target_branch.user_url)
2328
branch_transport.put_bytes('format', self.as_string())
2329
branch = self.open(a_bzrdir, name, _found=True,
2000
2330
possible_transports=[target_branch.bzrdir.root_transport])
2003
super(BranchReferenceFormat, self).__init__()
2004
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2005
self._matchingbzrdir.set_branch_format(self)
2331
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2007
2334
def _make_reference_clone_function(format, a_branch):
2008
2335
"""Create a clone() routine for a branch dynamically."""
2009
2336
def clone(to_bzrdir, revision_id=None,
2010
2337
repository_policy=None):
2011
2338
"""See Branch.clone()."""
2012
return format.initialize(to_bzrdir, a_branch)
2339
return format.initialize(to_bzrdir, target_branch=a_branch)
2013
2340
# cannot obey revision_id limits when cloning a reference ...
2014
2341
# FIXME RBC 20060210 either nuke revision_id for clone, or
2015
2342
# 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):
2345
def open(self, a_bzrdir, name=None, _found=False, location=None,
2346
possible_transports=None, ignore_fallbacks=False,
2347
found_repository=None):
2020
2348
"""Return the branch that the branch reference in a_bzrdir points at.
2022
2350
:param a_bzrdir: A BzrDir that contains a branch.
2351
:param name: Name of colocated branch to open, if any
2023
2352
:param _found: a private parameter, do not use it. It is used to
2024
2353
indicate if format probing has already be done.
2025
2354
:param ignore_fallbacks: when set, no fallback branches will be opened
2193
2579
"""See Branch.print_file."""
2194
2580
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
2582
@needs_write_lock
2260
2583
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
2584
if not revision_id or not isinstance(revision_id, basestring):
2585
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2271
2586
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))
2587
old_revno, old_revid = self.last_revision_info()
2588
if self.get_append_revisions_only():
2589
self._check_history_violation(revision_id)
2590
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2591
self._write_last_revision_info(revno, revision_id)
2592
self._clear_cached_state()
2593
self._last_revision_info_cache = revno, revision_id
2594
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2301
2596
def basis_tree(self):
2302
2597
"""See Branch.basis_tree."""
2451
class BzrBranch8(BzrBranch5):
2718
def _read_last_revision_info(self):
2719
revision_string = self._transport.get_bytes('last-revision')
2720
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2721
revision_id = cache_utf8.get_cached_utf8(revision_id)
2723
return revno, revision_id
2725
def _write_last_revision_info(self, revno, revision_id):
2726
"""Simply write out the revision id, with no checks.
2728
Use set_last_revision_info to perform this safely.
2730
Does not update the revision_history cache.
2732
revision_id = _mod_revision.ensure_null(revision_id)
2733
out_string = '%d %s\n' % (revno, revision_id)
2734
self._transport.put_bytes('last-revision', out_string,
2735
mode=self.bzrdir._get_file_mode())
2738
def update_feature_flags(self, updated_flags):
2739
"""Update the feature flags for this branch.
2741
:param updated_flags: Dictionary mapping feature names to necessities
2742
A necessity can be None to indicate the feature should be removed
2744
self._format._update_feature_flags(updated_flags)
2745
self.control_transport.put_bytes('format', self._format.as_string())
2748
class FullHistoryBzrBranch(BzrBranch):
2749
"""Bzr branch which contains the full revision history."""
2752
def set_last_revision_info(self, revno, revision_id):
2753
if not revision_id or not isinstance(revision_id, basestring):
2754
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2755
revision_id = _mod_revision.ensure_null(revision_id)
2756
# this old format stores the full history, but this api doesn't
2757
# provide it, so we must generate, and might as well check it's
2759
history = self._lefthand_history(revision_id)
2760
if len(history) != revno:
2761
raise AssertionError('%d != %d' % (len(history), revno))
2762
self._set_revision_history(history)
2764
def _read_last_revision_info(self):
2765
rh = self._revision_history()
2768
return (revno, rh[-1])
2770
return (0, _mod_revision.NULL_REVISION)
2772
@deprecated_method(deprecated_in((2, 4, 0)))
2774
def set_revision_history(self, rev_history):
2775
"""See Branch.set_revision_history."""
2776
self._set_revision_history(rev_history)
2778
def _set_revision_history(self, rev_history):
2779
if 'evil' in debug.debug_flags:
2780
mutter_callsite(3, "set_revision_history scales with history.")
2781
check_not_reserved_id = _mod_revision.check_not_reserved_id
2782
for rev_id in rev_history:
2783
check_not_reserved_id(rev_id)
2784
if Branch.hooks['post_change_branch_tip']:
2785
# Don't calculate the last_revision_info() if there are no hooks
2787
old_revno, old_revid = self.last_revision_info()
2788
if len(rev_history) == 0:
2789
revid = _mod_revision.NULL_REVISION
2791
revid = rev_history[-1]
2792
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2793
self._write_revision_history(rev_history)
2794
self._clear_cached_state()
2795
self._cache_revision_history(rev_history)
2796
for hook in Branch.hooks['set_rh']:
2797
hook(self, rev_history)
2798
if Branch.hooks['post_change_branch_tip']:
2799
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2801
def _write_revision_history(self, history):
2802
"""Factored out of set_revision_history.
2804
This performs the actual writing to disk.
2805
It is intended to be called by set_revision_history."""
2806
self._transport.put_bytes(
2807
'revision-history', '\n'.join(history),
2808
mode=self.bzrdir._get_file_mode())
2810
def _gen_revision_history(self):
2811
history = self._transport.get_bytes('revision-history').split('\n')
2812
if history[-1:] == ['']:
2813
# There shouldn't be a trailing newline, but just in case.
2817
def _synchronize_history(self, destination, revision_id):
2818
if not isinstance(destination, FullHistoryBzrBranch):
2819
super(BzrBranch, self)._synchronize_history(
2820
destination, revision_id)
2822
if revision_id == _mod_revision.NULL_REVISION:
2825
new_history = self._revision_history()
2826
if revision_id is not None and new_history != []:
2828
new_history = new_history[:new_history.index(revision_id) + 1]
2830
rev = self.repository.get_revision(revision_id)
2831
new_history = rev.get_history(self.repository)[1:]
2832
destination._set_revision_history(new_history)
2835
def generate_revision_history(self, revision_id, last_rev=None,
2837
"""Create a new revision history that will finish with revision_id.
2839
:param revision_id: the new tip to use.
2840
:param last_rev: The previous last_revision. If not None, then this
2841
must be a ancestory of revision_id, or DivergedBranches is raised.
2842
:param other_branch: The other branch that DivergedBranches should
2843
raise with respect to.
2845
self._set_revision_history(self._lefthand_history(revision_id,
2846
last_rev, other_branch))
2849
class BzrBranch5(FullHistoryBzrBranch):
2850
"""A format 5 branch. This supports new features over plain branches.
2852
It has support for a master_branch which is the data for bound branches.
2856
class BzrBranch8(BzrBranch):
2452
2857
"""A branch that stores tree-reference locations."""
2454
def _open_hook(self):
2859
def _open_hook(self, possible_transports=None):
2455
2860
if self._ignore_fallbacks:
2862
if possible_transports is None:
2863
possible_transports = [self.bzrdir.root_transport]
2458
2865
url = self.get_stacked_on_url()
2459
2866
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2480
2888
self._last_revision_info_cache = None
2481
2889
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
2891
def _check_history_violation(self, revision_id):
2529
last_revision = _mod_revision.ensure_null(self.last_revision())
2892
current_revid = self.last_revision()
2893
last_revision = _mod_revision.ensure_null(current_revid)
2530
2894
if _mod_revision.is_null(last_revision):
2532
if last_revision not in self._lefthand_history(revision_id):
2533
raise errors.AppendRevisionsOnlyViolation(self.base)
2896
graph = self.repository.get_graph()
2897
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2898
if lh_ancestor == current_revid:
2900
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2535
2902
def _gen_revision_history(self):
2536
2903
"""Generate the revision history from last revision
2988
3324
raise NotImplementedError(self.push)
3327
def copy_content_into(self, revision_id=None):
3328
"""Copy the content of source into target
3330
revision_id: if not None, the revision history in the new branch will
3331
be truncated to end with revision_id.
3333
raise NotImplementedError(self.copy_content_into)
3336
def fetch(self, stop_revision=None, limit=None):
3339
:param stop_revision: Last revision to fetch
3340
:param limit: Optional rough limit of revisions to fetch
3342
raise NotImplementedError(self.fetch)
2991
3345
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()."""
3346
"""InterBranch implementation that uses public Branch functions."""
3349
def is_compatible(klass, source, target):
3350
# GenericBranch uses the public API, so always compatible
3354
def _get_branch_formats_to_test(klass):
3355
return [(format_registry.get_default(), format_registry.get_default())]
3358
def unwrap_format(klass, format):
3359
if isinstance(format, remote.RemoteBranchFormat):
3360
format._ensure_real()
3361
return format._custom_format
3365
def copy_content_into(self, revision_id=None):
3366
"""Copy the content of source into target
3368
revision_id: if not None, the revision history in the new branch will
3369
be truncated to end with revision_id.
3371
self.source.update_references(self.target)
3372
self.source._synchronize_history(self.target, revision_id)
3374
parent = self.source.get_parent()
3375
except errors.InaccessibleParent, e:
3376
mutter('parent was not accessible to copy: %s', e)
3379
self.target.set_parent(parent)
3380
if self.source._push_should_merge_tags():
3381
self.source.tags.merge_to(self.target.tags)
3384
def fetch(self, stop_revision=None, limit=None):
3385
if self.target.base == self.source.base:
3002
3387
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)
3389
fetch_spec_factory = fetch.FetchSpecFactory()
3390
fetch_spec_factory.source_branch = self.source
3391
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3392
fetch_spec_factory.source_repo = self.source.repository
3393
fetch_spec_factory.target_repo = self.target.repository
3394
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3395
fetch_spec_factory.limit = limit
3396
fetch_spec = fetch_spec_factory.make_fetch_spec()
3397
return self.target.repository.fetch(self.source.repository,
3398
fetch_spec=fetch_spec)
3040
3400
self.source.unlock()
3403
def _update_revisions(self, stop_revision=None, overwrite=False,
3405
other_revno, other_last_revision = self.source.last_revision_info()
3406
stop_revno = None # unknown
3407
if stop_revision is None:
3408
stop_revision = other_last_revision
3409
if _mod_revision.is_null(stop_revision):
3410
# if there are no commits, we're done.
3412
stop_revno = other_revno
3414
# what's the current last revision, before we fetch [and change it
3416
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3417
# we fetch here so that we don't process data twice in the common
3418
# case of having something to pull, and so that the check for
3419
# already merged can operate on the just fetched graph, which will
3420
# be cached in memory.
3421
self.fetch(stop_revision=stop_revision)
3422
# Check to see if one is an ancestor of the other
3425
graph = self.target.repository.get_graph()
3426
if self.target._check_if_descendant_or_diverged(
3427
stop_revision, last_rev, graph, self.source):
3428
# stop_revision is a descendant of last_rev, but we aren't
3429
# overwriting, so we're done.
3431
if stop_revno is None:
3433
graph = self.target.repository.get_graph()
3434
this_revno, this_last_revision = \
3435
self.target.last_revision_info()
3436
stop_revno = graph.find_distance_to_null(stop_revision,
3437
[(other_last_revision, other_revno),
3438
(this_last_revision, this_revno)])
3439
self.target.set_last_revision_info(stop_revno, stop_revision)
3042
3442
def pull(self, overwrite=False, stop_revision=None,
3443
possible_transports=None, run_hooks=True,
3444
_override_hook_target=None, local=False):
3445
"""Pull from source into self, updating my master if any.
3447
:param run_hooks: Private parameter - if false, this branch
3448
is being called because it's the master of the primary branch,
3449
so it should not run its hooks.
3451
bound_location = self.target.get_bound_location()
3452
if local and not bound_location:
3453
raise errors.LocalRequiresBoundBranch()
3454
master_branch = None
3455
source_is_master = False
3457
# bound_location comes from a config file, some care has to be
3458
# taken to relate it to source.user_url
3459
normalized = urlutils.normalize_url(bound_location)
3461
relpath = self.source.user_transport.relpath(normalized)
3462
source_is_master = (relpath == '')
3463
except (errors.PathNotChild, errors.InvalidURL):
3464
source_is_master = False
3465
if not local and bound_location and not source_is_master:
3466
# not pulling from master, so we need to update master.
3467
master_branch = self.target.get_master_branch(possible_transports)
3468
master_branch.lock_write()
3471
# pull from source into master.
3472
master_branch.pull(self.source, overwrite, stop_revision,
3474
return self._pull(overwrite,
3475
stop_revision, _hook_master=master_branch,
3476
run_hooks=run_hooks,
3477
_override_hook_target=_override_hook_target,
3478
merge_tags_to_master=not source_is_master)
3481
master_branch.unlock()
3483
def push(self, overwrite=False, stop_revision=None, lossy=False,
3484
_override_hook_source_branch=None):
3485
"""See InterBranch.push.
3487
This is the basic concrete implementation of push()
3489
:param _override_hook_source_branch: If specified, run the hooks
3490
passing this Branch as the source, rather than self. This is for
3491
use of RemoteBranch, where push is delegated to the underlying
3495
raise errors.LossyPushToSameVCS(self.source, self.target)
3496
# TODO: Public option to disable running hooks - should be trivial but
3499
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3500
op.add_cleanup(self.source.lock_read().unlock)
3501
op.add_cleanup(self.target.lock_write().unlock)
3502
return op.run(overwrite, stop_revision,
3503
_override_hook_source_branch=_override_hook_source_branch)
3505
def _basic_push(self, overwrite, stop_revision):
3506
"""Basic implementation of push without bound branches or hooks.
3508
Must be called with source read locked and target write locked.
3510
result = BranchPushResult()
3511
result.source_branch = self.source
3512
result.target_branch = self.target
3513
result.old_revno, result.old_revid = self.target.last_revision_info()
3514
self.source.update_references(self.target)
3515
if result.old_revid != stop_revision:
3516
# We assume that during 'push' this repository is closer than
3518
graph = self.source.repository.get_graph(self.target.repository)
3519
self._update_revisions(stop_revision, overwrite=overwrite,
3521
if self.source._push_should_merge_tags():
3522
result.tag_updates, result.tag_conflicts = (
3523
self.source.tags.merge_to(self.target.tags, overwrite))
3524
result.new_revno, result.new_revid = self.target.last_revision_info()
3527
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3528
_override_hook_source_branch=None):
3529
"""Push from source into target, and into target's master if any.
3532
if _override_hook_source_branch:
3533
result.source_branch = _override_hook_source_branch
3534
for hook in Branch.hooks['post_push']:
3537
bound_location = self.target.get_bound_location()
3538
if bound_location and self.target.base != bound_location:
3539
# there is a master branch.
3541
# XXX: Why the second check? Is it even supported for a branch to
3542
# be bound to itself? -- mbp 20070507
3543
master_branch = self.target.get_master_branch()
3544
master_branch.lock_write()
3545
operation.add_cleanup(master_branch.unlock)
3546
# push into the master from the source branch.
3547
master_inter = InterBranch.get(self.source, master_branch)
3548
master_inter._basic_push(overwrite, stop_revision)
3549
# and push into the target branch from the source. Note that
3550
# we push from the source branch again, because it's considered
3551
# the highest bandwidth repository.
3552
result = self._basic_push(overwrite, stop_revision)
3553
result.master_branch = master_branch
3554
result.local_branch = self.target
3556
master_branch = None
3558
result = self._basic_push(overwrite, stop_revision)
3559
# TODO: Why set master_branch and local_branch if there's no
3560
# binding? Maybe cleaner to just leave them unset? -- mbp
3562
result.master_branch = self.target
3563
result.local_branch = None
3567
def _pull(self, overwrite=False, stop_revision=None,
3043
3568
possible_transports=None, _hook_master=None, run_hooks=True,
3044
_override_hook_target=None, local=False):
3569
_override_hook_target=None, local=False,
3570
merge_tags_to_master=True):
3045
3571
"""See Branch.pull.
3573
This function is the core worker, used by GenericInterBranch.pull to
3574
avoid duplication when pulling source->master and source->local.
3047
3576
:param _hook_master: Private parameter - set the branch to
3048
3577
be supplied as the master to pull hooks.
3049
3578
:param run_hooks: Private parameter - if false, this branch
3050
3579
is being called because it's the master of the primary branch,
3051
3580
so it should not run its hooks.
3581
is being called because it's the master of the primary branch,
3582
so it should not run its hooks.
3052
3583
:param _override_hook_target: Private parameter - set the branch to be
3053
3584
supplied as the target_branch to pull hooks.
3054
3585
:param local: Only update the local branch, and not the bound branch.
3094
3626
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
3630
InterBranch.register_optimiser(GenericInterBranch)
3207
InterBranch.register_optimiser(InterToBranch5)