73
58
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
76
class Branch(controldir.ControlComponent):
61
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
62
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
66
# TODO: Maybe include checks for common corruption of newlines, etc?
68
# TODO: Some operations like log might retrieve the same revisions
69
# repeatedly to calculate deltas. We could perhaps have a weakref
70
# cache in memory to make this faster. In general anything can be
71
# cached in memory between lock and unlock operations. .. nb thats
72
# what the transaction identity map provides
75
######################################################################
77
79
"""Branch holding a history of revisions.
80
Base directory/url of the branch; using control_url and
81
control_transport is more standardized.
82
:ivar hooks: An instance of BranchHooks.
83
:ivar _master_branch_cache: cached result of get_master_branch, see
82
Base directory/url of the branch.
84
hooks: An instance of BranchHooks.
86
86
# this is really an instance variable - FIXME move it there
91
def control_transport(self):
92
return self._transport
95
def user_transport(self):
96
return self.bzrdir.user_transport
98
def __init__(self, possible_transports=None):
90
def __init__(self, *ignored, **ignored_too):
99
91
self.tags = self._format.make_tags(self)
100
92
self._revision_history_cache = None
101
93
self._revision_id_to_revno_cache = None
102
94
self._partial_revision_id_to_revno_cache = {}
103
95
self._partial_revision_history_cache = []
104
self._tags_bytes = None
105
96
self._last_revision_info_cache = None
106
self._master_branch_cache = None
107
97
self._merge_sorted_revisions_cache = None
108
self._open_hook(possible_transports)
109
99
hooks = Branch.hooks['open']
110
100
for hook in hooks:
113
def _open_hook(self, possible_transports):
103
def _open_hook(self):
114
104
"""Called by init to allow simpler extension of the base class."""
116
def _activate_fallback_location(self, url, possible_transports):
106
def _activate_fallback_location(self, url):
117
107
"""Activate the branch/repository from url as a fallback repository."""
118
for existing_fallback_repo in self.repository._fallback_repositories:
119
if existing_fallback_repo.user_url == url:
120
# This fallback is already configured. This probably only
121
# happens because ControlDir.sprout is a horrible mess. To avoid
122
# confusing _unstack we don't add this a second time.
123
mutter('duplicate activation of fallback %r on %r', url, self)
125
repo = self._get_fallback_repository(url, possible_transports)
108
repo = self._get_fallback_repository(url)
126
109
if repo.has_same_location(self.repository):
127
raise errors.UnstackableLocationError(self.user_url, url)
110
raise errors.UnstackableLocationError(self.base, url)
128
111
self.repository.add_fallback_repository(repo)
130
113
def break_lock(self):
879
724
old_repository = self.repository
880
725
if len(old_repository._fallback_repositories) != 1:
881
726
raise AssertionError("can't cope with fallback repositories "
882
"of %r (fallbacks: %r)" % (old_repository,
883
old_repository._fallback_repositories))
884
# Open the new repository object.
885
# Repositories don't offer an interface to remove fallback
886
# repositories today; take the conceptually simpler option and just
887
# reopen it. We reopen it starting from the URL so that we
888
# get a separate connection for RemoteRepositories and can
889
# stream from one of them to the other. This does mean doing
890
# separate SSH connection setup, but unstacking is not a
891
# common operation so it's tolerable.
892
new_bzrdir = controldir.ControlDir.open(
893
self.bzrdir.root_transport.base)
894
new_repository = new_bzrdir.find_repository()
895
if new_repository._fallback_repositories:
896
raise AssertionError("didn't expect %r to have "
897
"fallback_repositories"
898
% (self.repository,))
899
# Replace self.repository with the new repository.
900
# Do our best to transfer the lock state (i.e. lock-tokens and
901
# lock count) of self.repository to the new repository.
902
lock_token = old_repository.lock_write().repository_token
903
self.repository = new_repository
904
if isinstance(self, remote.RemoteBranch):
905
# Remote branches can have a second reference to the old
906
# repository that need to be replaced.
907
if self._real_branch is not None:
908
self._real_branch.repository = new_repository
909
self.repository.lock_write(token=lock_token)
910
if lock_token is not None:
911
old_repository.leave_lock_in_place()
727
"of %r" % (self.repository,))
728
# unlock it, including unlocking the fallback
912
729
old_repository.unlock()
913
if lock_token is not None:
914
# XXX: self.repository.leave_lock_in_place() before this
915
# function will not be preserved. Fortunately that doesn't
916
# affect the current default format (2a), and would be a
917
# corner-case anyway.
918
# - Andrew Bennetts, 2010/06/30
919
self.repository.dont_leave_lock_in_place()
923
old_repository.unlock()
924
except errors.LockNotHeld:
927
if old_lock_count == 0:
928
raise AssertionError(
929
'old_repository should have been locked at least once.')
930
for i in range(old_lock_count-1):
730
old_repository.lock_read()
732
# Repositories don't offer an interface to remove fallback
733
# repositories today; take the conceptually simpler option and just
734
# reopen it. We reopen it starting from the URL so that we
735
# get a separate connection for RemoteRepositories and can
736
# stream from one of them to the other. This does mean doing
737
# separate SSH connection setup, but unstacking is not a
738
# common operation so it's tolerable.
739
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
740
new_repository = new_bzrdir.find_repository()
741
self.repository = new_repository
742
if self.repository._fallback_repositories:
743
raise AssertionError("didn't expect %r to have "
744
"fallback_repositories"
745
% (self.repository,))
746
# this is not paired with an unlock because it's just restoring
747
# the previous state; the lock's released when set_stacked_on_url
931
749
self.repository.lock_write()
932
# Fetch from the old repository into the new.
933
old_repository.lock_read()
935
750
# XXX: If you unstack a branch while it has a working tree
936
751
# with a pending merge, the pending-merged revisions will no
937
752
# longer be present. You can (probably) revert and remerge.
939
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
940
except errors.TagsNotSupported:
941
tags_to_fetch = set()
942
fetch_spec = vf_search.NotInOtherForRevs(self.repository,
943
old_repository, required_ids=[self.last_revision()],
944
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
945
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
754
# XXX: This only fetches up to the tip of the repository; it
755
# doesn't bring across any tags. That's fairly consistent
756
# with how branch works, but perhaps not ideal.
757
self.repository.fetch(old_repository,
758
revision_id=self.last_revision(),
947
761
old_repository.unlock()
1046
859
:return: A tuple (revno, revision_id).
1048
861
if self._last_revision_info_cache is None:
1049
self._last_revision_info_cache = self._read_last_revision_info()
862
self._last_revision_info_cache = self._last_revision_info()
1050
863
return self._last_revision_info_cache
1052
def _read_last_revision_info(self):
1053
raise NotImplementedError(self._read_last_revision_info)
1055
def import_last_revision_info_and_tags(self, source, revno, revid,
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,
912
def import_last_revision_info(self, source_repo, revno, revid):
1057
913
"""Set the last revision info, importing from another repo if necessary.
1059
915
This is used by the bound branch code to upload a revision to
1060
916
the master branch first before updating the tip of the local branch.
1061
Revisions referenced by source's tags are also transferred.
1063
:param source: Source branch to optionally fetch from
918
:param source_repo: Source repository to optionally fetch from
1064
919
:param revno: Revision number of the new tip
1065
920
:param revid: Revision id of the new tip
1066
:param lossy: Whether to discard metadata that can not be
1067
natively represented
1068
:return: Tuple with the new revision number and revision id
1069
(should only be different from the arguments when lossy=True)
1071
if not self.repository.has_same_location(source.repository):
1072
self.fetch(source, revid)
922
if not self.repository.has_same_location(source_repo):
923
self.repository.fetch(source_repo, revision_id=revid)
1073
924
self.set_last_revision_info(revno, revid)
1074
return (revno, revid)
1076
926
def revision_id_to_revno(self, revision_id):
1077
927
"""Given a revision id, return its revno"""
1078
928
if _mod_revision.is_null(revision_id):
1080
history = self._revision_history()
930
history = self.revision_history()
1082
932
return history.index(revision_id) + 1
1083
933
except ValueError:
1589
1432
object will be created every time regardless.
1435
_default_format = None
1436
"""The default format used for new branches."""
1439
"""The known formats."""
1441
can_set_append_revisions_only = True
1592
1443
def __eq__(self, other):
1593
1444
return self.__class__ is other.__class__
1595
1446
def __ne__(self, other):
1596
1447
return not (self == other)
1598
def get_reference(self, controldir, name=None):
1599
"""Get the target reference of the branch in controldir.
1450
def find_format(klass, a_bzrdir, name=None):
1451
"""Return the format for the branch object in a_bzrdir."""
1453
transport = a_bzrdir.get_branch_transport(None, name=name)
1454
format_string = transport.get_bytes("format")
1455
return klass._formats[format_string]
1456
except errors.NoSuchFile:
1457
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1459
raise errors.UnknownFormatError(format=format_string, kind='branch')
1462
def get_default_format(klass):
1463
"""Return the current default format."""
1464
return klass._default_format
1466
def get_reference(self, a_bzrdir):
1467
"""Get the target reference of the branch in a_bzrdir.
1601
1469
format probing must have been completed before calling
1602
1470
this method - it is assumed that the format of the branch
1603
in controldir is correct.
1471
in a_bzrdir is correct.
1605
:param controldir: The controldir to get the branch data from.
1606
:param name: Name of the colocated branch to fetch
1473
:param a_bzrdir: The bzrdir to get the branch data from.
1607
1474
:return: None if the branch is not a reference branch.
1612
def set_reference(self, controldir, name, to_branch):
1613
"""Set the target reference of the branch in controldir.
1479
def set_reference(self, a_bzrdir, to_branch):
1480
"""Set the target reference of the branch in a_bzrdir.
1615
1482
format probing must have been completed before calling
1616
1483
this method - it is assumed that the format of the branch
1617
in controldir is correct.
1484
in a_bzrdir is correct.
1619
:param controldir: The controldir to set the branch reference for.
1620
:param name: Name of colocated branch to set, None for default
1486
:param a_bzrdir: The bzrdir to set the branch reference for.
1621
1487
:param to_branch: branch that the checkout is to reference
1623
1489
raise NotImplementedError(self.set_reference)
1491
def get_format_string(self):
1492
"""Return the ASCII format string that identifies this format."""
1493
raise NotImplementedError(self.get_format_string)
1625
1495
def get_format_description(self):
1626
1496
"""Return the short format description for this format."""
1627
1497
raise NotImplementedError(self.get_format_description)
1629
def _run_post_branch_init_hooks(self, controldir, name, branch):
1630
hooks = Branch.hooks['post_branch_init']
1633
params = BranchInitHookParams(self, controldir, name, branch)
1637
def initialize(self, controldir, name=None, repository=None,
1638
append_revisions_only=None):
1639
"""Create a branch of this format in controldir.
1499
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1500
lock_type='metadir', set_format=True):
1501
"""Initialize a branch in a bzrdir, with specified files
1503
:param a_bzrdir: The bzrdir to initialize the branch in
1504
:param utf8_files: The files to create as a list of
1505
(filename, content) tuples
1506
:param name: Name of colocated branch to create, if any
1507
:param set_format: If True, set the format with
1508
self.get_format_string. (BzrBranch4 has its format set
1510
:return: a branch in this format
1512
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1513
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1515
'metadir': ('lock', lockdir.LockDir),
1516
'branch4': ('branch-lock', lockable_files.TransportLock),
1518
lock_name, lock_class = lock_map[lock_type]
1519
control_files = lockable_files.LockableFiles(branch_transport,
1520
lock_name, lock_class)
1521
control_files.create_lock()
1523
control_files.lock_write()
1524
except errors.LockContention:
1525
if lock_type != 'branch4':
1531
utf8_files += [('format', self.get_format_string())]
1533
for (filename, content) in utf8_files:
1534
branch_transport.put_bytes(
1536
mode=a_bzrdir._get_file_mode())
1539
control_files.unlock()
1540
return self.open(a_bzrdir, name, _found=True)
1542
def initialize(self, a_bzrdir, name=None):
1543
"""Create a branch of this format in a_bzrdir.
1641
1545
:param name: Name of the colocated branch to create.
1643
1547
raise NotImplementedError(self.initialize)
1778
1663
"basis revision. hooks MUST NOT modify this delta. "
1779
1664
" future_tree is an in-memory tree obtained from "
1780
1665
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1782
self.add_hook('post_commit',
1666
"tree.", (0,91), None))
1667
self.create_hook(HookPoint('post_commit',
1783
1668
"Called in the bzr client after a commit has completed. "
1784
1669
"post_commit is called with (local, master, old_revno, old_revid, "
1785
1670
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1786
"commit to a branch.", (0, 15))
1787
self.add_hook('post_uncommit',
1671
"commit to a branch.", (0, 15), None))
1672
self.create_hook(HookPoint('post_uncommit',
1788
1673
"Called in the bzr client after an uncommit completes. "
1789
1674
"post_uncommit is called with (local, master, old_revno, "
1790
1675
"old_revid, new_revno, new_revid) where local is the local branch "
1791
1676
"or None, master is the target branch, and an empty branch "
1792
"receives new_revno of 0, new_revid of None.", (0, 15))
1793
self.add_hook('pre_change_branch_tip',
1677
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1678
self.create_hook(HookPoint('pre_change_branch_tip',
1794
1679
"Called in bzr client and server before a change to the tip of a "
1795
1680
"branch is made. pre_change_branch_tip is called with a "
1796
1681
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1797
"commit, uncommit will all trigger this hook.", (1, 6))
1798
self.add_hook('post_change_branch_tip',
1682
"commit, uncommit will all trigger this hook.", (1, 6), None))
1683
self.create_hook(HookPoint('post_change_branch_tip',
1799
1684
"Called in bzr client and server after a change to the tip of a "
1800
1685
"branch is made. post_change_branch_tip is called with a "
1801
1686
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1802
"commit, uncommit will all trigger this hook.", (1, 4))
1803
self.add_hook('transform_fallback_location',
1687
"commit, uncommit will all trigger this hook.", (1, 4), None))
1688
self.create_hook(HookPoint('transform_fallback_location',
1804
1689
"Called when a stacked branch is activating its fallback "
1805
1690
"locations. transform_fallback_location is called with (branch, "
1806
1691
"url), and should return a new url. Returning the same url "
1873
1748
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1876
class BranchInitHookParams(object):
1877
"""Object holding parameters passed to `*_branch_init` hooks.
1879
There are 4 fields that hooks may wish to access:
1881
:ivar format: the branch format
1882
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1883
:ivar name: name of colocated branch, if any (or None)
1884
:ivar branch: the branch created
1886
Note that for lightweight checkouts, the bzrdir and format fields refer to
1887
the checkout, hence they are different from the corresponding fields in
1888
branch, which refer to the original branch.
1891
def __init__(self, format, controldir, name, branch):
1892
"""Create a group of BranchInitHook parameters.
1894
:param format: the branch format
1895
:param controldir: the ControlDir where the branch will be/has been
1897
:param name: name of colocated branch, if any (or None)
1898
:param branch: the branch created
1900
Note that for lightweight checkouts, the bzrdir and format fields refer
1901
to the checkout, hence they are different from the corresponding fields
1902
in branch, which refer to the original branch.
1904
self.format = format
1905
self.bzrdir = controldir
1907
self.branch = branch
1909
def __eq__(self, other):
1910
return self.__dict__ == other.__dict__
1913
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1916
class SwitchHookParams(object):
1917
"""Object holding parameters passed to `*_switch` hooks.
1919
There are 4 fields that hooks may wish to access:
1921
:ivar control_dir: ControlDir of the checkout to change
1922
:ivar to_branch: branch that the checkout is to reference
1923
:ivar force: skip the check for local commits in a heavy checkout
1924
:ivar revision_id: revision ID to switch to (or None)
1927
def __init__(self, control_dir, to_branch, force, revision_id):
1928
"""Create a group of SwitchHook parameters.
1930
:param control_dir: ControlDir of the checkout to change
1931
:param to_branch: branch that the checkout is to reference
1932
:param force: skip the check for local commits in a heavy checkout
1933
:param revision_id: revision ID to switch to (or None)
1935
self.control_dir = control_dir
1936
self.to_branch = to_branch
1938
self.revision_id = revision_id
1940
def __eq__(self, other):
1941
return self.__dict__ == other.__dict__
1944
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1945
self.control_dir, self.to_branch,
1949
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
1950
"""Base class for branch formats that live in meta directories.
1751
class BzrBranchFormat4(BranchFormat):
1752
"""Bzr branch format 4.
1755
- a revision-history file.
1756
- a branch-lock lock file [ to be shared with the bzrdir ]
1759
def get_format_description(self):
1760
"""See BranchFormat.get_format_description()."""
1761
return "Branch format 4"
1763
def initialize(self, a_bzrdir, name=None):
1764
"""Create a branch of this format in a_bzrdir."""
1765
utf8_files = [('revision-history', ''),
1766
('branch-name', ''),
1768
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1769
lock_type='branch4', set_format=False)
1953
1771
def __init__(self):
1954
BranchFormat.__init__(self)
1955
bzrdir.BzrFormat.__init__(self)
1958
def find_format(klass, controldir, name=None):
1959
"""Return the format for the branch object in controldir."""
1961
transport = controldir.get_branch_transport(None, name=name)
1962
except errors.NoSuchFile:
1963
raise errors.NotBranchError(path=name, bzrdir=controldir)
1965
format_string = transport.get_bytes("format")
1966
except errors.NoSuchFile:
1967
raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
1968
return klass._find_format(format_registry, 'branch', format_string)
1772
super(BzrBranchFormat4, self).__init__()
1773
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1775
def network_name(self):
1776
"""The network name for this format is the control dirs disk label."""
1777
return self._matchingbzrdir.get_format_string()
1779
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1780
"""See BranchFormat.open()."""
1782
# we are being called directly and must probe.
1783
raise NotImplementedError
1784
return BzrBranch(_format=self,
1785
_control_files=a_bzrdir._control_files,
1788
_repository=a_bzrdir.open_repository())
1791
return "Bazaar-NG branch format 4"
1794
class BranchFormatMetadir(BranchFormat):
1795
"""Common logic for meta-dir based branch formats."""
1970
1797
def _branch_class(self):
1971
1798
"""What class to instantiate on open calls."""
1972
1799
raise NotImplementedError(self._branch_class)
1974
def _get_initial_config(self, append_revisions_only=None):
1975
if append_revisions_only:
1976
return "append_revisions_only = True\n"
1978
# Avoid writing anything if append_revisions_only is disabled,
1979
# as that is the default.
1982
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1984
"""Initialize a branch in a control dir, with specified files
1986
:param a_bzrdir: The bzrdir to initialize the branch in
1987
:param utf8_files: The files to create as a list of
1988
(filename, content) tuples
1989
:param name: Name of colocated branch to create, if any
1990
:return: a branch in this format
1801
def network_name(self):
1802
"""A simple byte string uniquely identifying this format for RPC calls.
1804
Metadir branch formats use their format string.
1993
name = a_bzrdir._get_selected_branch()
1994
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1995
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1996
control_files = lockable_files.LockableFiles(branch_transport,
1997
'lock', lockdir.LockDir)
1998
control_files.create_lock()
1999
control_files.lock_write()
2001
utf8_files += [('format', self.as_string())]
2002
for (filename, content) in utf8_files:
2003
branch_transport.put_bytes(
2005
mode=a_bzrdir._get_file_mode())
2007
control_files.unlock()
2008
branch = self.open(a_bzrdir, name, _found=True,
2009
found_repository=repository)
2010
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1806
return self.get_format_string()
2013
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2014
found_repository=None, possible_transports=None):
1808
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
2015
1809
"""See BranchFormat.open()."""
2017
name = a_bzrdir._get_selected_branch()
2019
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
1811
format = BranchFormat.find_format(a_bzrdir, name=name)
2020
1812
if format.__class__ != self.__class__:
2021
1813
raise AssertionError("wrong format %r found for %r" %
2022
1814
(format, self))
2023
transport = a_bzrdir.get_branch_transport(None, name=name)
1816
transport = a_bzrdir.get_branch_transport(None, name=name)
2025
1817
control_files = lockable_files.LockableFiles(transport, 'lock',
2026
1818
lockdir.LockDir)
2027
if found_repository is None:
2028
found_repository = a_bzrdir.find_repository()
2029
1819
return self._branch_class()(_format=self,
2030
1820
_control_files=control_files,
2032
1822
a_bzrdir=a_bzrdir,
2033
_repository=found_repository,
2034
ignore_fallbacks=ignore_fallbacks,
2035
possible_transports=possible_transports)
1823
_repository=a_bzrdir.find_repository(),
1824
ignore_fallbacks=ignore_fallbacks)
2036
1825
except errors.NoSuchFile:
2037
1826
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2040
def _matchingbzrdir(self):
2041
ret = bzrdir.BzrDirMetaFormat1()
2042
ret.set_branch_format(self)
2045
def supports_tags(self):
2048
def supports_leaving_lock(self):
2051
def check_support_status(self, allow_unsupported, recommend_upgrade=True,
2053
BranchFormat.check_support_status(self,
2054
allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
2056
bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
2057
recommend_upgrade=recommend_upgrade, basedir=basedir)
1829
super(BranchFormatMetadir, self).__init__()
1830
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1831
self._matchingbzrdir.set_branch_format(self)
1833
def supports_tags(self):
1837
class BzrBranchFormat5(BranchFormatMetadir):
1838
"""Bzr branch format 5.
1841
- a revision-history file.
1843
- a lock dir guarding the branch itself
1844
- all of this stored in a branch/ subdirectory
1845
- works with shared repositories.
1847
This format is new in bzr 0.8.
1850
def _branch_class(self):
1853
def get_format_string(self):
1854
"""See BranchFormat.get_format_string()."""
1855
return "Bazaar-NG branch format 5\n"
1857
def get_format_description(self):
1858
"""See BranchFormat.get_format_description()."""
1859
return "Branch format 5"
1861
def initialize(self, a_bzrdir, name=None):
1862
"""Create a branch of this format in a_bzrdir."""
1863
utf8_files = [('revision-history', ''),
1864
('branch-name', ''),
1866
return self._initialize_helper(a_bzrdir, utf8_files, name)
1868
def supports_tags(self):
2060
1872
class BzrBranchFormat6(BranchFormatMetadir):
2201
2001
"""See BranchFormat.get_format_description()."""
2202
2002
return "Checkout reference format 1"
2204
def get_reference(self, a_bzrdir, name=None):
2004
def get_reference(self, a_bzrdir):
2205
2005
"""See BranchFormat.get_reference()."""
2206
transport = a_bzrdir.get_branch_transport(None, name=name)
2006
transport = a_bzrdir.get_branch_transport(None)
2207
2007
return transport.get_bytes('location')
2209
def set_reference(self, a_bzrdir, name, to_branch):
2009
def set_reference(self, a_bzrdir, to_branch):
2210
2010
"""See BranchFormat.set_reference()."""
2211
transport = a_bzrdir.get_branch_transport(None, name=name)
2011
transport = a_bzrdir.get_branch_transport(None)
2212
2012
location = transport.put_bytes('location', to_branch.base)
2214
def initialize(self, a_bzrdir, name=None, target_branch=None,
2215
repository=None, append_revisions_only=None):
2014
def initialize(self, a_bzrdir, name=None, target_branch=None):
2216
2015
"""Create a branch of this format in a_bzrdir."""
2217
2016
if target_branch is None:
2218
2017
# this format does not implement branch itself, thus the implicit
2219
2018
# creation contract must see it as uninitializable
2220
2019
raise errors.UninitializableFormat(self)
2221
mutter('creating branch reference in %s', a_bzrdir.user_url)
2222
if a_bzrdir._format.fixed_components:
2223
raise errors.IncompatibleFormat(self, a_bzrdir._format)
2225
name = a_bzrdir._get_selected_branch()
2020
mutter('creating branch reference in %s', a_bzrdir.transport.base)
2226
2021
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2227
2022
branch_transport.put_bytes('location',
2228
target_branch.user_url)
2229
branch_transport.put_bytes('format', self.as_string())
2230
branch = self.open(a_bzrdir, name, _found=True,
2023
target_branch.bzrdir.root_transport.base)
2024
branch_transport.put_bytes('format', self.get_format_string())
2026
a_bzrdir, name, _found=True,
2231
2027
possible_transports=[target_branch.bzrdir.root_transport])
2232
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2030
super(BranchReferenceFormat, self).__init__()
2031
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2032
self._matchingbzrdir.set_branch_format(self)
2235
2034
def _make_reference_clone_function(format, a_branch):
2236
2035
"""Create a clone() routine for a branch dynamically."""
2393
2159
base = property(_get_base, doc="The URL for the root of this branch.")
2396
def user_transport(self):
2397
return self._user_transport
2399
2161
def _get_config(self):
2400
return _mod_config.TransportConfig(self._transport, 'branch.conf')
2402
def _get_config_store(self):
2403
if self.conf_store is None:
2404
self.conf_store = _mod_config.BranchStore(self)
2405
return self.conf_store
2407
def _uncommitted_branch(self):
2408
"""Return the branch that may contain uncommitted changes."""
2409
master = self.get_master_branch()
2410
if master is not None:
2415
def store_uncommitted(self, creator):
2416
"""Store uncommitted changes from a ShelfCreator.
2418
:param creator: The ShelfCreator containing uncommitted changes, or
2419
None to delete any stored changes.
2420
:raises: ChangesAlreadyStored if the branch already has changes.
2422
branch = self._uncommitted_branch()
2424
branch._transport.delete('stored-transform')
2426
if branch._transport.has('stored-transform'):
2427
raise errors.ChangesAlreadyStored
2428
transform = StringIO()
2429
creator.write_shelf(transform)
2431
branch._transport.put_file('stored-transform', transform)
2433
def get_unshelver(self, tree):
2434
"""Return a shelf.Unshelver for this branch and tree.
2436
:param tree: The tree to use to construct the Unshelver.
2437
:return: an Unshelver or None if no changes are stored.
2439
branch = self._uncommitted_branch()
2441
transform = branch._transport.get('stored-transform')
2442
except errors.NoSuchFile:
2444
return shelf.Unshelver.from_tree_and_shelf(tree, transform)
2162
return TransportConfig(self._transport, 'branch.conf')
2446
2164
def is_locked(self):
2447
2165
return self.control_files.is_locked()
2449
2167
def lock_write(self, token=None):
2450
"""Lock the branch for write operations.
2452
:param token: A token to permit reacquiring a previously held and
2454
:return: A BranchWriteLockResult.
2456
2168
if not self.is_locked():
2457
2169
self._note_lock('w')
2170
# All-in-one needs to always unlock/lock.
2171
repo_control = getattr(self.repository, 'control_files', None)
2172
if self.control_files == repo_control or not self.is_locked():
2458
2173
self.repository._warn_if_deprecated(self)
2459
2174
self.repository.lock_write()
2460
2175
took_lock = True
2462
2177
took_lock = False
2464
return BranchWriteLockResult(self.unlock,
2465
self.control_files.lock_write(token=token))
2179
return self.control_files.lock_write(token=token)
2468
2182
self.repository.unlock()
2471
2185
def lock_read(self):
2472
"""Lock the branch for read operations.
2474
:return: A bzrlib.lock.LogicalLockResult.
2476
2186
if not self.is_locked():
2477
2187
self._note_lock('r')
2188
# All-in-one needs to always unlock/lock.
2189
repo_control = getattr(self.repository, 'control_files', None)
2190
if self.control_files == repo_control or not self.is_locked():
2478
2191
self.repository._warn_if_deprecated(self)
2479
2192
self.repository.lock_read()
2480
2193
took_lock = True
2514
2228
"""See Branch.print_file."""
2515
2229
return self.repository.print_file(file, revision_id)
2231
def _write_revision_history(self, history):
2232
"""Factored out of set_revision_history.
2234
This performs the actual writing to disk.
2235
It is intended to be called by BzrBranch5.set_revision_history."""
2236
self._transport.put_bytes(
2237
'revision-history', '\n'.join(history),
2238
mode=self.bzrdir._get_file_mode())
2241
def set_revision_history(self, rev_history):
2242
"""See Branch.set_revision_history."""
2243
if 'evil' in debug.debug_flags:
2244
mutter_callsite(3, "set_revision_history scales with history.")
2245
check_not_reserved_id = _mod_revision.check_not_reserved_id
2246
for rev_id in rev_history:
2247
check_not_reserved_id(rev_id)
2248
if Branch.hooks['post_change_branch_tip']:
2249
# Don't calculate the last_revision_info() if there are no hooks
2251
old_revno, old_revid = self.last_revision_info()
2252
if len(rev_history) == 0:
2253
revid = _mod_revision.NULL_REVISION
2255
revid = rev_history[-1]
2256
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2257
self._write_revision_history(rev_history)
2258
self._clear_cached_state()
2259
self._cache_revision_history(rev_history)
2260
for hook in Branch.hooks['set_rh']:
2261
hook(self, rev_history)
2262
if Branch.hooks['post_change_branch_tip']:
2263
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2265
def _synchronize_history(self, destination, revision_id):
2266
"""Synchronize last revision and revision history between branches.
2268
This version is most efficient when the destination is also a
2269
BzrBranch5, but works for BzrBranch6 as long as the revision
2270
history is the true lefthand parent history, and all of the revisions
2271
are in the destination's repository. If not, set_revision_history
2274
:param destination: The branch to copy the history into
2275
:param revision_id: The revision-id to truncate history at. May
2276
be None to copy complete history.
2278
if not isinstance(destination._format, BzrBranchFormat5):
2279
super(BzrBranch, self)._synchronize_history(
2280
destination, revision_id)
2282
if revision_id == _mod_revision.NULL_REVISION:
2285
new_history = self.revision_history()
2286
if revision_id is not None and new_history != []:
2288
new_history = new_history[:new_history.index(revision_id) + 1]
2290
rev = self.repository.get_revision(revision_id)
2291
new_history = rev.get_history(self.repository)[1:]
2292
destination.set_revision_history(new_history)
2517
2294
@needs_write_lock
2518
2295
def set_last_revision_info(self, revno, revision_id):
2519
if not revision_id or not isinstance(revision_id, basestring):
2520
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2296
"""Set the last revision of this branch.
2298
The caller is responsible for checking that the revno is correct
2299
for this revision id.
2301
It may be possible to set the branch last revision to an id not
2302
present in the repository. However, branches can also be
2303
configured to check constraints on history, in which case this may not
2521
2306
revision_id = _mod_revision.ensure_null(revision_id)
2522
old_revno, old_revid = self.last_revision_info()
2523
if self.get_append_revisions_only():
2524
self._check_history_violation(revision_id)
2525
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2526
self._write_last_revision_info(revno, revision_id)
2527
self._clear_cached_state()
2528
self._last_revision_info_cache = revno, revision_id
2529
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2307
# this old format stores the full history, but this api doesn't
2308
# provide it, so we must generate, and might as well check it's
2310
history = self._lefthand_history(revision_id)
2311
if len(history) != revno:
2312
raise AssertionError('%d != %d' % (len(history), revno))
2313
self.set_revision_history(history)
2315
def _gen_revision_history(self):
2316
history = self._transport.get_bytes('revision-history').split('\n')
2317
if history[-1:] == ['']:
2318
# There shouldn't be a trailing newline, but just in case.
2323
def generate_revision_history(self, revision_id, last_rev=None,
2325
"""Create a new revision history that will finish with revision_id.
2327
:param revision_id: the new tip to use.
2328
:param last_rev: The previous last_revision. If not None, then this
2329
must be a ancestory of revision_id, or DivergedBranches is raised.
2330
:param other_branch: The other branch that DivergedBranches should
2331
raise with respect to.
2333
self.set_revision_history(self._lefthand_history(revision_id,
2334
last_rev, other_branch))
2531
2336
def basis_tree(self):
2532
2337
"""See Branch.basis_tree."""
2715
2515
self._last_revision_info_cache = None
2716
2516
self._reference_info = None
2518
def _last_revision_info(self):
2519
revision_string = self._transport.get_bytes('last-revision')
2520
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2521
revision_id = cache_utf8.get_cached_utf8(revision_id)
2523
return revno, revision_id
2525
def _write_last_revision_info(self, revno, revision_id):
2526
"""Simply write out the revision id, with no checks.
2528
Use set_last_revision_info to perform this safely.
2530
Does not update the revision_history cache.
2531
Intended to be called by set_last_revision_info and
2532
_write_revision_history.
2534
revision_id = _mod_revision.ensure_null(revision_id)
2535
out_string = '%d %s\n' % (revno, revision_id)
2536
self._transport.put_bytes('last-revision', out_string,
2537
mode=self.bzrdir._get_file_mode())
2540
def set_last_revision_info(self, revno, revision_id):
2541
revision_id = _mod_revision.ensure_null(revision_id)
2542
old_revno, old_revid = self.last_revision_info()
2543
if self._get_append_revisions_only():
2544
self._check_history_violation(revision_id)
2545
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2546
self._write_last_revision_info(revno, revision_id)
2547
self._clear_cached_state()
2548
self._last_revision_info_cache = revno, revision_id
2549
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2551
def _synchronize_history(self, destination, revision_id):
2552
"""Synchronize last revision and revision history between branches.
2554
:see: Branch._synchronize_history
2556
# XXX: The base Branch has a fast implementation of this method based
2557
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2558
# that uses set_revision_history. This class inherits from BzrBranch5,
2559
# but wants the fast implementation, so it calls
2560
# Branch._synchronize_history directly.
2561
Branch._synchronize_history(self, destination, revision_id)
2718
2563
def _check_history_violation(self, revision_id):
2719
current_revid = self.last_revision()
2720
last_revision = _mod_revision.ensure_null(current_revid)
2564
last_revision = _mod_revision.ensure_null(self.last_revision())
2721
2565
if _mod_revision.is_null(last_revision):
2723
graph = self.repository.get_graph()
2724
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2725
if lh_ancestor == current_revid:
2727
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2567
if last_revision not in self._lefthand_history(revision_id):
2568
raise errors.AppendRevisionsOnlyViolation(self.base)
2729
2570
def _gen_revision_history(self):
2730
2571
"""Generate the revision history from last revision
3143
3023
raise NotImplementedError(self.push)
3146
def copy_content_into(self, revision_id=None):
3147
"""Copy the content of source into target
3149
revision_id: if not None, the revision history in the new branch will
3150
be truncated to end with revision_id.
3152
raise NotImplementedError(self.copy_content_into)
3155
def fetch(self, stop_revision=None, limit=None):
3158
:param stop_revision: Last revision to fetch
3159
:param limit: Optional rough limit of revisions to fetch
3161
raise NotImplementedError(self.fetch)
3164
def _fix_overwrite_type(overwrite):
3165
if isinstance(overwrite, bool):
3167
return ["history", "tags"]
3173
3026
class GenericInterBranch(InterBranch):
3174
"""InterBranch implementation that uses public Branch functions."""
3177
def is_compatible(klass, source, target):
3178
# GenericBranch uses the public API, so always compatible
3182
def _get_branch_formats_to_test(klass):
3183
return [(format_registry.get_default(), format_registry.get_default())]
3186
def unwrap_format(klass, format):
3187
if isinstance(format, remote.RemoteBranchFormat):
3188
format._ensure_real()
3189
return format._custom_format
3193
def copy_content_into(self, revision_id=None):
3194
"""Copy the content of source into target
3196
revision_id: if not None, the revision history in the new branch will
3197
be truncated to end with revision_id.
3199
self.source.update_references(self.target)
3200
self.source._synchronize_history(self.target, revision_id)
3202
parent = self.source.get_parent()
3203
except errors.InaccessibleParent, e:
3204
mutter('parent was not accessible to copy: %s', e)
3207
self.target.set_parent(parent)
3208
if self.source._push_should_merge_tags():
3209
self.source.tags.merge_to(self.target.tags)
3212
def fetch(self, stop_revision=None, limit=None):
3213
if self.target.base == self.source.base:
3027
"""InterBranch implementation that uses public Branch functions.
3031
def _get_branch_formats_to_test():
3032
return BranchFormat._default_format, BranchFormat._default_format
3034
def update_revisions(self, stop_revision=None, overwrite=False,
3036
"""See InterBranch.update_revisions()."""
3215
3037
self.source.lock_read()
3217
fetch_spec_factory = fetch.FetchSpecFactory()
3218
fetch_spec_factory.source_branch = self.source
3219
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3220
fetch_spec_factory.source_repo = self.source.repository
3221
fetch_spec_factory.target_repo = self.target.repository
3222
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3223
fetch_spec_factory.limit = limit
3224
fetch_spec = fetch_spec_factory.make_fetch_spec()
3225
return self.target.repository.fetch(self.source.repository,
3226
fetch_spec=fetch_spec)
3039
other_revno, other_last_revision = self.source.last_revision_info()
3040
stop_revno = None # unknown
3041
if stop_revision is None:
3042
stop_revision = other_last_revision
3043
if _mod_revision.is_null(stop_revision):
3044
# if there are no commits, we're done.
3046
stop_revno = other_revno
3048
# what's the current last revision, before we fetch [and change it
3050
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3051
# we fetch here so that we don't process data twice in the common
3052
# case of having something to pull, and so that the check for
3053
# already merged can operate on the just fetched graph, which will
3054
# be cached in memory.
3055
self.target.fetch(self.source, stop_revision)
3056
# Check to see if one is an ancestor of the other
3059
graph = self.target.repository.get_graph()
3060
if self.target._check_if_descendant_or_diverged(
3061
stop_revision, last_rev, graph, self.source):
3062
# stop_revision is a descendant of last_rev, but we aren't
3063
# overwriting, so we're done.
3065
if stop_revno is None:
3067
graph = self.target.repository.get_graph()
3068
this_revno, this_last_revision = \
3069
self.target.last_revision_info()
3070
stop_revno = graph.find_distance_to_null(stop_revision,
3071
[(other_last_revision, other_revno),
3072
(this_last_revision, this_revno)])
3073
self.target.set_last_revision_info(stop_revno, stop_revision)
3228
3075
self.source.unlock()
3231
def _update_revisions(self, stop_revision=None, overwrite=False,
3233
other_revno, other_last_revision = self.source.last_revision_info()
3234
stop_revno = None # unknown
3235
if stop_revision is None:
3236
stop_revision = other_last_revision
3237
if _mod_revision.is_null(stop_revision):
3238
# if there are no commits, we're done.
3240
stop_revno = other_revno
3242
# what's the current last revision, before we fetch [and change it
3244
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3245
# we fetch here so that we don't process data twice in the common
3246
# case of having something to pull, and so that the check for
3247
# already merged can operate on the just fetched graph, which will
3248
# be cached in memory.
3249
self.fetch(stop_revision=stop_revision)
3250
# Check to see if one is an ancestor of the other
3253
graph = self.target.repository.get_graph()
3254
if self.target._check_if_descendant_or_diverged(
3255
stop_revision, last_rev, graph, self.source):
3256
# stop_revision is a descendant of last_rev, but we aren't
3257
# overwriting, so we're done.
3259
if stop_revno is None:
3261
graph = self.target.repository.get_graph()
3262
this_revno, this_last_revision = \
3263
self.target.last_revision_info()
3264
stop_revno = graph.find_distance_to_null(stop_revision,
3265
[(other_last_revision, other_revno),
3266
(this_last_revision, this_revno)])
3267
self.target.set_last_revision_info(stop_revno, stop_revision)
3270
3077
def pull(self, overwrite=False, stop_revision=None,
3271
possible_transports=None, run_hooks=True,
3272
_override_hook_target=None, local=False):
3273
"""Pull from source into self, updating my master if any.
3275
:param run_hooks: Private parameter - if false, this branch
3276
is being called because it's the master of the primary branch,
3277
so it should not run its hooks.
3279
bound_location = self.target.get_bound_location()
3280
if local and not bound_location:
3281
raise errors.LocalRequiresBoundBranch()
3282
master_branch = None
3283
source_is_master = False
3285
# bound_location comes from a config file, some care has to be
3286
# taken to relate it to source.user_url
3287
normalized = urlutils.normalize_url(bound_location)
3289
relpath = self.source.user_transport.relpath(normalized)
3290
source_is_master = (relpath == '')
3291
except (errors.PathNotChild, errors.InvalidURL):
3292
source_is_master = False
3293
if not local and bound_location and not source_is_master:
3294
# not pulling from master, so we need to update master.
3295
master_branch = self.target.get_master_branch(possible_transports)
3296
master_branch.lock_write()
3299
# pull from source into master.
3300
master_branch.pull(self.source, overwrite, stop_revision,
3302
return self._pull(overwrite,
3303
stop_revision, _hook_master=master_branch,
3304
run_hooks=run_hooks,
3305
_override_hook_target=_override_hook_target,
3306
merge_tags_to_master=not source_is_master)
3309
master_branch.unlock()
3311
def push(self, overwrite=False, stop_revision=None, lossy=False,
3312
_override_hook_source_branch=None):
3313
"""See InterBranch.push.
3315
This is the basic concrete implementation of push()
3317
:param _override_hook_source_branch: If specified, run the hooks
3318
passing this Branch as the source, rather than self. This is for
3319
use of RemoteBranch, where push is delegated to the underlying
3323
raise errors.LossyPushToSameVCS(self.source, self.target)
3324
# TODO: Public option to disable running hooks - should be trivial but
3327
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3328
op.add_cleanup(self.source.lock_read().unlock)
3329
op.add_cleanup(self.target.lock_write().unlock)
3330
return op.run(overwrite, stop_revision,
3331
_override_hook_source_branch=_override_hook_source_branch)
3333
def _basic_push(self, overwrite, stop_revision):
3334
"""Basic implementation of push without bound branches or hooks.
3336
Must be called with source read locked and target write locked.
3338
result = BranchPushResult()
3339
result.source_branch = self.source
3340
result.target_branch = self.target
3341
result.old_revno, result.old_revid = self.target.last_revision_info()
3342
self.source.update_references(self.target)
3343
overwrite = _fix_overwrite_type(overwrite)
3344
if result.old_revid != stop_revision:
3345
# We assume that during 'push' this repository is closer than
3347
graph = self.source.repository.get_graph(self.target.repository)
3348
self._update_revisions(stop_revision,
3349
overwrite=("history" in overwrite),
3351
if self.source._push_should_merge_tags():
3352
result.tag_updates, result.tag_conflicts = (
3353
self.source.tags.merge_to(
3354
self.target.tags, "tags" in overwrite))
3355
result.new_revno, result.new_revid = self.target.last_revision_info()
3358
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3359
_override_hook_source_branch=None):
3360
"""Push from source into target, and into target's master if any.
3363
if _override_hook_source_branch:
3364
result.source_branch = _override_hook_source_branch
3365
for hook in Branch.hooks['post_push']:
3368
bound_location = self.target.get_bound_location()
3369
if bound_location and self.target.base != bound_location:
3370
# there is a master branch.
3372
# XXX: Why the second check? Is it even supported for a branch to
3373
# be bound to itself? -- mbp 20070507
3374
master_branch = self.target.get_master_branch()
3375
master_branch.lock_write()
3376
operation.add_cleanup(master_branch.unlock)
3377
# push into the master from the source branch.
3378
master_inter = InterBranch.get(self.source, master_branch)
3379
master_inter._basic_push(overwrite, stop_revision)
3380
# and push into the target branch from the source. Note that
3381
# we push from the source branch again, because it's considered
3382
# the highest bandwidth repository.
3383
result = self._basic_push(overwrite, stop_revision)
3384
result.master_branch = master_branch
3385
result.local_branch = self.target
3387
master_branch = None
3389
result = self._basic_push(overwrite, stop_revision)
3390
# TODO: Why set master_branch and local_branch if there's no
3391
# binding? Maybe cleaner to just leave them unset? -- mbp
3393
result.master_branch = self.target
3394
result.local_branch = None
3398
def _pull(self, overwrite=False, stop_revision=None,
3399
3078
possible_transports=None, _hook_master=None, run_hooks=True,
3400
_override_hook_target=None, local=False,
3401
merge_tags_to_master=True):
3079
_override_hook_target=None, local=False):
3402
3080
"""See Branch.pull.
3404
This function is the core worker, used by GenericInterBranch.pull to
3405
avoid duplication when pulling source->master and source->local.
3407
3082
:param _hook_master: Private parameter - set the branch to
3408
3083
be supplied as the master to pull hooks.
3409
3084
:param run_hooks: Private parameter - if false, this branch
3410
3085
is being called because it's the master of the primary branch,
3411
3086
so it should not run its hooks.
3412
is being called because it's the master of the primary branch,
3413
so it should not run its hooks.
3414
3087
:param _override_hook_target: Private parameter - set the branch to be
3415
3088
supplied as the target_branch to pull hooks.
3416
3089
:param local: Only update the local branch, and not the bound branch.
3460
3129
self.source.unlock()
3132
def push(self, overwrite=False, stop_revision=None,
3133
_override_hook_source_branch=None):
3134
"""See InterBranch.push.
3136
This is the basic concrete implementation of push()
3138
:param _override_hook_source_branch: If specified, run
3139
the hooks passing this Branch as the source, rather than self.
3140
This is for use of RemoteBranch, where push is delegated to the
3141
underlying vfs-based Branch.
3143
# TODO: Public option to disable running hooks - should be trivial but
3145
self.source.lock_read()
3147
return _run_with_write_locked_target(
3148
self.target, self._push_with_bound_branches, overwrite,
3150
_override_hook_source_branch=_override_hook_source_branch)
3152
self.source.unlock()
3154
def _push_with_bound_branches(self, overwrite, stop_revision,
3155
_override_hook_source_branch=None):
3156
"""Push from source into target, and into target's master if any.
3159
if _override_hook_source_branch:
3160
result.source_branch = _override_hook_source_branch
3161
for hook in Branch.hooks['post_push']:
3164
bound_location = self.target.get_bound_location()
3165
if bound_location and self.target.base != bound_location:
3166
# there is a master branch.
3168
# XXX: Why the second check? Is it even supported for a branch to
3169
# be bound to itself? -- mbp 20070507
3170
master_branch = self.target.get_master_branch()
3171
master_branch.lock_write()
3173
# push into the master from the source branch.
3174
self.source._basic_push(master_branch, overwrite, stop_revision)
3175
# and push into the target branch from the source. Note that we
3176
# push from the source branch again, because its considered the
3177
# highest bandwidth repository.
3178
result = self.source._basic_push(self.target, overwrite,
3180
result.master_branch = master_branch
3181
result.local_branch = self.target
3185
master_branch.unlock()
3188
result = self.source._basic_push(self.target, overwrite,
3190
# TODO: Why set master_branch and local_branch if there's no
3191
# binding? Maybe cleaner to just leave them unset? -- mbp
3193
result.master_branch = self.target
3194
result.local_branch = None
3199
def is_compatible(self, source, target):
3200
# GenericBranch uses the public API, so always compatible
3204
class InterToBranch5(GenericInterBranch):
3207
def _get_branch_formats_to_test():
3208
return BranchFormat._default_format, BzrBranchFormat5()
3210
def pull(self, overwrite=False, stop_revision=None,
3211
possible_transports=None, run_hooks=True,
3212
_override_hook_target=None, local=False):
3213
"""Pull from source into self, updating my master if any.
3215
:param run_hooks: Private parameter - if false, this branch
3216
is being called because it's the master of the primary branch,
3217
so it should not run its hooks.
3219
bound_location = self.target.get_bound_location()
3220
if local and not bound_location:
3221
raise errors.LocalRequiresBoundBranch()
3222
master_branch = None
3223
if not local and bound_location and self.source.base != bound_location:
3224
# not pulling from master, so we need to update master.
3225
master_branch = self.target.get_master_branch(possible_transports)
3226
master_branch.lock_write()
3229
# pull from source into master.
3230
master_branch.pull(self.source, overwrite, stop_revision,
3232
return super(InterToBranch5, self).pull(overwrite,
3233
stop_revision, _hook_master=master_branch,
3234
run_hooks=run_hooks,
3235
_override_hook_target=_override_hook_target)
3238
master_branch.unlock()
3464
3241
InterBranch.register_optimiser(GenericInterBranch)
3242
InterBranch.register_optimiser(InterToBranch5)