649
670
raise errors.UnsupportedOperation(self.get_reference_info, self)
651
672
@needs_write_lock
652
def fetch(self, from_branch, last_revision=None, pb=None):
673
def fetch(self, from_branch, last_revision=None, limit=None):
653
674
"""Copy revisions from from_branch into this branch.
655
676
:param from_branch: Where to copy from.
656
677
:param last_revision: What revision to stop at (None for at the end
658
:param pb: An optional progress bar to use.
679
:param limit: Optional rough limit of revisions to fetch
661
if self.base == from_branch.base:
664
symbol_versioning.warn(
665
symbol_versioning.deprecated_in((1, 14, 0))
666
% "pb parameter to fetch()")
667
from_branch.lock_read()
669
if last_revision is None:
670
last_revision = from_branch.last_revision()
671
last_revision = _mod_revision.ensure_null(last_revision)
672
return self.repository.fetch(from_branch.repository,
673
revision_id=last_revision,
682
return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
678
684
def get_bound_location(self):
679
685
"""Return the URL of the branch we are bound to.
739
748
"""Print `file` to stdout."""
740
749
raise NotImplementedError(self.print_file)
751
@deprecated_method(deprecated_in((2, 4, 0)))
742
752
def set_revision_history(self, rev_history):
743
raise NotImplementedError(self.set_revision_history)
753
"""See Branch.set_revision_history."""
754
self._set_revision_history(rev_history)
757
def _set_revision_history(self, rev_history):
758
if len(rev_history) == 0:
759
revid = _mod_revision.NULL_REVISION
761
revid = rev_history[-1]
762
if rev_history != self._lefthand_history(revid):
763
raise errors.NotLefthandHistory(rev_history)
764
self.set_last_revision_info(len(rev_history), revid)
765
self._cache_revision_history(rev_history)
766
for hook in Branch.hooks['set_rh']:
767
hook(self, rev_history)
770
def set_last_revision_info(self, revno, revision_id):
771
"""Set the last revision of this branch.
773
The caller is responsible for checking that the revno is correct
774
for this revision id.
776
It may be possible to set the branch last revision to an id not
777
present in the repository. However, branches can also be
778
configured to check constraints on history, in which case this may not
781
raise NotImplementedError(self.set_last_revision_info)
784
def generate_revision_history(self, revision_id, last_rev=None,
786
"""See Branch.generate_revision_history"""
787
graph = self.repository.get_graph()
788
known_revision_ids = [
789
self.last_revision_info(),
790
(_mod_revision.NULL_REVISION, 0),
792
if last_rev is not None:
793
if not graph.is_ancestor(last_rev, revision_id):
794
# our previous tip is not merged into stop_revision
795
raise errors.DivergedBranches(self, other_branch)
796
revno = graph.find_distance_to_null(revision_id, known_revision_ids)
797
self.set_last_revision_info(revno, revision_id)
745
799
@needs_write_lock
746
800
def set_parent(self, url):
859
914
# XXX: If you unstack a branch while it has a working tree
860
915
# with a pending merge, the pending-merged revisions will no
861
916
# longer be present. You can (probably) revert and remerge.
863
# XXX: This only fetches up to the tip of the repository; it
864
# doesn't bring across any tags. That's fairly consistent
865
# with how branch works, but perhaps not ideal.
866
self.repository.fetch(old_repository,
867
revision_id=self.last_revision(),
918
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
919
except errors.TagsNotSupported:
920
tags_to_fetch = set()
921
fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
922
old_repository, required_ids=[self.last_revision()],
923
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
924
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
870
926
old_repository.unlock()
968
1031
:return: A tuple (revno, revision_id).
970
1033
if self._last_revision_info_cache is None:
971
self._last_revision_info_cache = self._last_revision_info()
1034
self._last_revision_info_cache = self._read_last_revision_info()
972
1035
return self._last_revision_info_cache
974
def _last_revision_info(self):
975
rh = self.revision_history()
978
return (revno, rh[-1])
980
return (0, _mod_revision.NULL_REVISION)
982
@deprecated_method(deprecated_in((1, 6, 0)))
983
def missing_revisions(self, other, stop_revision=None):
984
"""Return a list of new revisions that would perfectly fit.
986
If self and other have not diverged, return a list of the revisions
987
present in other, but missing from self.
989
self_history = self.revision_history()
990
self_len = len(self_history)
991
other_history = other.revision_history()
992
other_len = len(other_history)
993
common_index = min(self_len, other_len) -1
994
if common_index >= 0 and \
995
self_history[common_index] != other_history[common_index]:
996
raise errors.DivergedBranches(self, other)
998
if stop_revision is None:
999
stop_revision = other_len
1001
if stop_revision > other_len:
1002
raise errors.NoSuchRevision(self, stop_revision)
1003
return other_history[self_len:stop_revision]
1005
def update_revisions(self, other, stop_revision=None, overwrite=False,
1007
"""Pull in new perfect-fit revisions.
1009
:param other: Another Branch to pull from
1010
:param stop_revision: Updated until the given revision
1011
:param overwrite: Always set the branch pointer, rather than checking
1012
to see if it is a proper descendant.
1013
:param graph: A Graph object that can be used to query history
1014
information. This can be None.
1017
return InterBranch.get(other, self).update_revisions(stop_revision,
1037
def _read_last_revision_info(self):
1038
raise NotImplementedError(self._read_last_revision_info)
1040
@deprecated_method(deprecated_in((2, 4, 0)))
1020
1041
def import_last_revision_info(self, source_repo, revno, revid):
1021
1042
"""Set the last revision info, importing from another repo if necessary.
1023
This is used by the bound branch code to upload a revision to
1024
the master branch first before updating the tip of the local branch.
1026
1044
:param source_repo: Source repository to optionally fetch from
1027
1045
:param revno: Revision number of the new tip
1028
1046
:param revid: Revision id of the new tip
1031
1049
self.repository.fetch(source_repo, revision_id=revid)
1032
1050
self.set_last_revision_info(revno, revid)
1052
def import_last_revision_info_and_tags(self, source, revno, revid,
1054
"""Set the last revision info, importing from another repo if necessary.
1056
This is used by the bound branch code to upload a revision to
1057
the master branch first before updating the tip of the local branch.
1058
Revisions referenced by source's tags are also transferred.
1060
:param source: Source branch to optionally fetch from
1061
:param revno: Revision number of the new tip
1062
:param revid: Revision id of the new tip
1063
:param lossy: Whether to discard metadata that can not be
1064
natively represented
1065
:return: Tuple with the new revision number and revision id
1066
(should only be different from the arguments when lossy=True)
1068
if not self.repository.has_same_location(source.repository):
1069
self.fetch(source, revid)
1070
self.set_last_revision_info(revno, revid)
1071
return (revno, revid)
1034
1073
def revision_id_to_revno(self, revision_id):
1035
1074
"""Given a revision id, return its revno"""
1036
1075
if _mod_revision.is_null(revision_id):
1068
1107
stop_revision=stop_revision,
1069
1108
possible_transports=possible_transports, *args, **kwargs)
1071
def push(self, target, overwrite=False, stop_revision=None, *args,
1110
def push(self, target, overwrite=False, stop_revision=None, lossy=False,
1073
1112
"""Mirror this branch into target.
1075
1114
This branch is considered to be 'local', having low latency.
1077
1116
return InterBranch.get(self, target).push(overwrite, stop_revision,
1080
def lossy_push(self, target, stop_revision=None):
1081
"""Push deltas into another branch.
1083
:note: This does not, like push, retain the revision ids from
1084
the source branch and will, rather than adding bzr-specific
1085
metadata, push only those semantics of the revision that can be
1086
natively represented by this branch' VCS.
1088
:param target: Target branch
1089
:param stop_revision: Revision to push, defaults to last revision.
1090
:return: BranchPushResult with an extra member revidmap:
1091
A dictionary mapping revision ids from the target branch
1092
to new revision ids in the target branch, for each
1093
revision that was pushed.
1095
inter = InterBranch.get(self, target)
1096
lossy_push = getattr(inter, "lossy_push", None)
1097
if lossy_push is None:
1098
raise errors.LossyPushToSameVCS(self, target)
1099
return lossy_push(stop_revision)
1117
lossy, *args, **kwargs)
1101
1119
def basis_tree(self):
1102
1120
"""Return `Tree` object for last revision."""
1362
1385
"""Return the most suitable metadir for a checkout of this branch.
1363
1386
Weaves are used if this branch's repository uses weaves.
1365
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1366
from bzrlib.repofmt import weaverepo
1367
format = bzrdir.BzrDirMetaFormat1()
1368
format.repository_format = weaverepo.RepositoryFormat7()
1370
format = self.repository.bzrdir.checkout_metadir()
1371
format.set_branch_format(self._format)
1388
format = self.repository.bzrdir.checkout_metadir()
1389
format.set_branch_format(self._format)
1374
1392
def create_clone_on_transport(self, to_transport, revision_id=None,
1375
stacked_on=None, create_prefix=False, use_existing_dir=False):
1393
stacked_on=None, create_prefix=False, use_existing_dir=False,
1376
1395
"""Create a clone of this branch and its bzrdir.
1378
1397
:param to_transport: The transport to clone onto.
1513
1534
raise AssertionError("invalid heads: %r" % (heads,))
1516
class BranchFormat(object):
1536
def heads_to_fetch(self):
1537
"""Return the heads that must and that should be fetched to copy this
1538
branch into another repo.
1540
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1541
set of heads that must be fetched. if_present_fetch is a set of
1542
heads that must be fetched if present, but no error is necessary if
1543
they are not present.
1545
# For bzr native formats must_fetch is just the tip, and if_present_fetch
1547
must_fetch = set([self.last_revision()])
1549
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1550
except errors.TagsNotSupported:
1551
if_present_fetch = set()
1552
must_fetch.discard(_mod_revision.NULL_REVISION)
1553
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1554
return must_fetch, if_present_fetch
1557
class BranchFormat(controldir.ControlComponentFormat):
1517
1558
"""An encapsulation of the initialization and open routines for a format.
1519
1560
Formats provide three things:
1552
1587
transport = a_bzrdir.get_branch_transport(None, name=name)
1553
1588
format_string = transport.get_bytes("format")
1554
format = klass._formats[format_string]
1555
if isinstance(format, MetaDirBranchFormatFactory):
1589
return format_registry.get(format_string)
1558
1590
except errors.NoSuchFile:
1559
1591
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1560
1592
except KeyError:
1561
1593
raise errors.UnknownFormatError(format=format_string, kind='branch')
1596
@deprecated_method(deprecated_in((2, 4, 0)))
1564
1597
def get_default_format(klass):
1565
1598
"""Return the current default format."""
1566
return klass._default_format
1599
return format_registry.get_default()
1602
@deprecated_method(deprecated_in((2, 4, 0)))
1569
1603
def get_formats(klass):
1570
1604
"""Get all the known formats.
1572
1606
Warning: This triggers a load of all lazy registered formats: do not
1573
1607
use except when that is desireed.
1576
for fmt in klass._formats.values():
1577
if isinstance(fmt, MetaDirBranchFormatFactory):
1609
return format_registry._get_all()
1582
1611
def get_reference(self, a_bzrdir, name=None):
1583
1612
"""Get the target reference of the branch in a_bzrdir.
1622
1651
for hook in hooks:
1625
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1626
lock_type='metadir', set_format=True):
1627
"""Initialize a branch in a bzrdir, with specified files
1629
:param a_bzrdir: The bzrdir to initialize the branch in
1630
:param utf8_files: The files to create as a list of
1631
(filename, content) tuples
1632
:param name: Name of colocated branch to create, if any
1633
:param set_format: If True, set the format with
1634
self.get_format_string. (BzrBranch4 has its format set
1636
:return: a branch in this format
1638
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1639
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1641
'metadir': ('lock', lockdir.LockDir),
1642
'branch4': ('branch-lock', lockable_files.TransportLock),
1644
lock_name, lock_class = lock_map[lock_type]
1645
control_files = lockable_files.LockableFiles(branch_transport,
1646
lock_name, lock_class)
1647
control_files.create_lock()
1649
control_files.lock_write()
1650
except errors.LockContention:
1651
if lock_type != 'branch4':
1657
utf8_files += [('format', self.get_format_string())]
1659
for (filename, content) in utf8_files:
1660
branch_transport.put_bytes(
1662
mode=a_bzrdir._get_file_mode())
1665
control_files.unlock()
1666
branch = self.open(a_bzrdir, name, _found=True)
1667
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1670
def initialize(self, a_bzrdir, name=None):
1654
def initialize(self, a_bzrdir, name=None, repository=None):
1671
1655
"""Create a branch of this format in a_bzrdir.
1673
1657
:param name: Name of the colocated branch to create.
1720
1705
raise NotImplementedError(self.open)
1708
@deprecated_method(deprecated_in((2, 4, 0)))
1723
1709
def register_format(klass, format):
1724
1710
"""Register a metadir format.
1726
1712
See MetaDirBranchFormatFactory for the ability to register a format
1727
1713
without loading the code the format needs until it is actually used.
1729
klass._formats[format.get_format_string()] = format
1730
# Metadir formats have a network name of their format string, and get
1731
# registered as factories.
1732
if isinstance(format, MetaDirBranchFormatFactory):
1733
network_format_registry.register(format.get_format_string(), format)
1735
network_format_registry.register(format.get_format_string(),
1715
format_registry.register(format)
1718
@deprecated_method(deprecated_in((2, 4, 0)))
1739
1719
def set_default_format(klass, format):
1740
klass._default_format = format
1720
format_registry.set_default(format)
1742
1722
def supports_set_append_revisions_only(self):
1743
1723
"""True if this format supports set_append_revisions_only."""
1800
1785
These are all empty initially, because by default nothing should get
1803
Hooks.__init__(self)
1804
self.create_hook(HookPoint('set_rh',
1788
Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1789
self.add_hook('set_rh',
1805
1790
"Invoked whenever the revision history has been set via "
1806
1791
"set_revision_history. The api signature is (branch, "
1807
1792
"revision_history), and the branch will be write-locked. "
1808
1793
"The set_rh hook can be expensive for bzr to trigger, a better "
1809
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1810
self.create_hook(HookPoint('open',
1794
"hook to use is Branch.post_change_branch_tip.", (0, 15))
1795
self.add_hook('open',
1811
1796
"Called with the Branch object that has been opened after a "
1812
"branch is opened.", (1, 8), None))
1813
self.create_hook(HookPoint('post_push',
1797
"branch is opened.", (1, 8))
1798
self.add_hook('post_push',
1814
1799
"Called after a push operation completes. post_push is called "
1815
1800
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1816
"bzr client.", (0, 15), None))
1817
self.create_hook(HookPoint('post_pull',
1801
"bzr client.", (0, 15))
1802
self.add_hook('post_pull',
1818
1803
"Called after a pull operation completes. post_pull is called "
1819
1804
"with a bzrlib.branch.PullResult object and only runs in the "
1820
"bzr client.", (0, 15), None))
1821
self.create_hook(HookPoint('pre_commit',
1805
"bzr client.", (0, 15))
1806
self.add_hook('pre_commit',
1822
1807
"Called after a commit is calculated but before it is "
1823
1808
"completed. pre_commit is called with (local, master, old_revno, "
1824
1809
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1827
1812
"basis revision. hooks MUST NOT modify this delta. "
1828
1813
" future_tree is an in-memory tree obtained from "
1829
1814
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1830
"tree.", (0,91), None))
1831
self.create_hook(HookPoint('post_commit',
1816
self.add_hook('post_commit',
1832
1817
"Called in the bzr client after a commit has completed. "
1833
1818
"post_commit is called with (local, master, old_revno, old_revid, "
1834
1819
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1835
"commit to a branch.", (0, 15), None))
1836
self.create_hook(HookPoint('post_uncommit',
1820
"commit to a branch.", (0, 15))
1821
self.add_hook('post_uncommit',
1837
1822
"Called in the bzr client after an uncommit completes. "
1838
1823
"post_uncommit is called with (local, master, old_revno, "
1839
1824
"old_revid, new_revno, new_revid) where local is the local branch "
1840
1825
"or None, master is the target branch, and an empty branch "
1841
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1842
self.create_hook(HookPoint('pre_change_branch_tip',
1826
"receives new_revno of 0, new_revid of None.", (0, 15))
1827
self.add_hook('pre_change_branch_tip',
1843
1828
"Called in bzr client and server before a change to the tip of a "
1844
1829
"branch is made. pre_change_branch_tip is called with a "
1845
1830
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1846
"commit, uncommit will all trigger this hook.", (1, 6), None))
1847
self.create_hook(HookPoint('post_change_branch_tip',
1831
"commit, uncommit will all trigger this hook.", (1, 6))
1832
self.add_hook('post_change_branch_tip',
1848
1833
"Called in bzr client and server after a change to the tip of a "
1849
1834
"branch is made. post_change_branch_tip is called with a "
1850
1835
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1851
"commit, uncommit will all trigger this hook.", (1, 4), None))
1852
self.create_hook(HookPoint('transform_fallback_location',
1836
"commit, uncommit will all trigger this hook.", (1, 4))
1837
self.add_hook('transform_fallback_location',
1853
1838
"Called when a stacked branch is activating its fallback "
1854
1839
"locations. transform_fallback_location is called with (branch, "
1855
1840
"url), and should return a new url. Returning the same url "
1860
1845
"fallback locations have not been activated. When there are "
1861
1846
"multiple hooks installed for transform_fallback_location, "
1862
1847
"all are called with the url returned from the previous hook."
1863
"The order is however undefined.", (1, 9), None))
1864
self.create_hook(HookPoint('automatic_tag_name',
1848
"The order is however undefined.", (1, 9))
1849
self.add_hook('automatic_tag_name',
1865
1850
"Called to determine an automatic tag name for a revision. "
1866
1851
"automatic_tag_name is called with (branch, revision_id) and "
1867
1852
"should return a tag name or None if no tag name could be "
1868
1853
"determined. The first non-None tag name returned will be used.",
1870
self.create_hook(HookPoint('post_branch_init',
1855
self.add_hook('post_branch_init',
1871
1856
"Called after new branch initialization completes. "
1872
1857
"post_branch_init is called with a "
1873
1858
"bzrlib.branch.BranchInitHookParams. "
1874
1859
"Note that init, branch and checkout (both heavyweight and "
1875
"lightweight) will all trigger this hook.", (2, 2), None))
1876
self.create_hook(HookPoint('post_switch',
1860
"lightweight) will all trigger this hook.", (2, 2))
1861
self.add_hook('post_switch',
1877
1862
"Called after a checkout switches branch. "
1878
1863
"post_switch is called with a "
1879
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1864
"bzrlib.branch.SwitchHookParams.", (2, 2))
1995
1980
self.revision_id)
1998
class BzrBranchFormat4(BranchFormat):
1999
"""Bzr branch format 4.
2002
- a revision-history file.
2003
- a branch-lock lock file [ to be shared with the bzrdir ]
2006
def get_format_description(self):
2007
"""See BranchFormat.get_format_description()."""
2008
return "Branch format 4"
2010
def initialize(self, a_bzrdir, name=None):
2011
"""Create a branch of this format in a_bzrdir."""
2012
utf8_files = [('revision-history', ''),
2013
('branch-name', ''),
2015
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
2016
lock_type='branch4', set_format=False)
2019
super(BzrBranchFormat4, self).__init__()
2020
self._matchingbzrdir = bzrdir.BzrDirFormat6()
2022
def network_name(self):
2023
"""The network name for this format is the control dirs disk label."""
2024
return self._matchingbzrdir.get_format_string()
2026
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
2027
"""See BranchFormat.open()."""
2029
# we are being called directly and must probe.
2030
raise NotImplementedError
2031
return BzrBranch(_format=self,
2032
_control_files=a_bzrdir._control_files,
2035
_repository=a_bzrdir.open_repository())
2038
return "Bazaar-NG branch format 4"
2041
1983
class BranchFormatMetadir(BranchFormat):
2042
1984
"""Common logic for meta-dir based branch formats."""
2045
1987
"""What class to instantiate on open calls."""
2046
1988
raise NotImplementedError(self._branch_class)
1990
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1992
"""Initialize a branch in a bzrdir, with specified files
1994
:param a_bzrdir: The bzrdir to initialize the branch in
1995
:param utf8_files: The files to create as a list of
1996
(filename, content) tuples
1997
:param name: Name of colocated branch to create, if any
1998
:return: a branch in this format
2000
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2001
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2002
control_files = lockable_files.LockableFiles(branch_transport,
2003
'lock', lockdir.LockDir)
2004
control_files.create_lock()
2005
control_files.lock_write()
2007
utf8_files += [('format', self.get_format_string())]
2008
for (filename, content) in utf8_files:
2009
branch_transport.put_bytes(
2011
mode=a_bzrdir._get_file_mode())
2013
control_files.unlock()
2014
branch = self.open(a_bzrdir, name, _found=True,
2015
found_repository=repository)
2016
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2048
2019
def network_name(self):
2049
2020
"""A simple byte string uniquely identifying this format for RPC calls.
2168
2145
"""See BranchFormat.get_format_description()."""
2169
2146
return "Branch format 8"
2171
def initialize(self, a_bzrdir, name=None):
2148
def initialize(self, a_bzrdir, name=None, repository=None):
2172
2149
"""Create a branch of this format in a_bzrdir."""
2173
2150
utf8_files = [('last-revision', '0 null:\n'),
2174
2151
('branch.conf', ''),
2176
2153
('references', '')
2178
return self._initialize_helper(a_bzrdir, utf8_files, name)
2181
super(BzrBranchFormat8, self).__init__()
2182
self._matchingbzrdir.repository_format = \
2183
RepositoryFormatKnitPack5RichRoot()
2155
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2185
2157
def make_tags(self, branch):
2186
2158
"""See bzrlib.branch.BranchFormat.make_tags()."""
2344
2341
__format6 = BzrBranchFormat6()
2345
2342
__format7 = BzrBranchFormat7()
2346
2343
__format8 = BzrBranchFormat8()
2347
BranchFormat.register_format(__format5)
2348
BranchFormat.register_format(BranchReferenceFormat())
2349
BranchFormat.register_format(__format6)
2350
BranchFormat.register_format(__format7)
2351
BranchFormat.register_format(__format8)
2352
BranchFormat.set_default_format(__format7)
2353
_legacy_formats = [BzrBranchFormat4(),
2355
network_format_registry.register(
2356
_legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2344
format_registry.register(__format5)
2345
format_registry.register(BranchReferenceFormat())
2346
format_registry.register(__format6)
2347
format_registry.register(__format7)
2348
format_registry.register(__format8)
2349
format_registry.set_default(__format7)
2359
2352
class BranchWriteLockResult(LogicalLockResult):
2507
2500
"""See Branch.print_file."""
2508
2501
return self.repository.print_file(file, revision_id)
2510
def _write_revision_history(self, history):
2511
"""Factored out of set_revision_history.
2513
This performs the actual writing to disk.
2514
It is intended to be called by BzrBranch5.set_revision_history."""
2515
self._transport.put_bytes(
2516
'revision-history', '\n'.join(history),
2517
mode=self.bzrdir._get_file_mode())
2520
def set_revision_history(self, rev_history):
2521
"""See Branch.set_revision_history."""
2522
if 'evil' in debug.debug_flags:
2523
mutter_callsite(3, "set_revision_history scales with history.")
2524
check_not_reserved_id = _mod_revision.check_not_reserved_id
2525
for rev_id in rev_history:
2526
check_not_reserved_id(rev_id)
2527
if Branch.hooks['post_change_branch_tip']:
2528
# Don't calculate the last_revision_info() if there are no hooks
2530
old_revno, old_revid = self.last_revision_info()
2531
if len(rev_history) == 0:
2532
revid = _mod_revision.NULL_REVISION
2534
revid = rev_history[-1]
2535
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2536
self._write_revision_history(rev_history)
2537
self._clear_cached_state()
2538
self._cache_revision_history(rev_history)
2539
for hook in Branch.hooks['set_rh']:
2540
hook(self, rev_history)
2541
if Branch.hooks['post_change_branch_tip']:
2542
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2544
def _synchronize_history(self, destination, revision_id):
2545
"""Synchronize last revision and revision history between branches.
2547
This version is most efficient when the destination is also a
2548
BzrBranch5, but works for BzrBranch6 as long as the revision
2549
history is the true lefthand parent history, and all of the revisions
2550
are in the destination's repository. If not, set_revision_history
2553
:param destination: The branch to copy the history into
2554
:param revision_id: The revision-id to truncate history at. May
2555
be None to copy complete history.
2557
if not isinstance(destination._format, BzrBranchFormat5):
2558
super(BzrBranch, self)._synchronize_history(
2559
destination, revision_id)
2561
if revision_id == _mod_revision.NULL_REVISION:
2564
new_history = self.revision_history()
2565
if revision_id is not None and new_history != []:
2567
new_history = new_history[:new_history.index(revision_id) + 1]
2569
rev = self.repository.get_revision(revision_id)
2570
new_history = rev.get_history(self.repository)[1:]
2571
destination.set_revision_history(new_history)
2573
2503
@needs_write_lock
2574
2504
def set_last_revision_info(self, revno, revision_id):
2575
"""Set the last revision of this branch.
2577
The caller is responsible for checking that the revno is correct
2578
for this revision id.
2580
It may be possible to set the branch last revision to an id not
2581
present in the repository. However, branches can also be
2582
configured to check constraints on history, in which case this may not
2505
if not revision_id or not isinstance(revision_id, basestring):
2506
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2585
2507
revision_id = _mod_revision.ensure_null(revision_id)
2586
# this old format stores the full history, but this api doesn't
2587
# provide it, so we must generate, and might as well check it's
2589
history = self._lefthand_history(revision_id)
2590
if len(history) != revno:
2591
raise AssertionError('%d != %d' % (len(history), revno))
2592
self.set_revision_history(history)
2594
def _gen_revision_history(self):
2595
history = self._transport.get_bytes('revision-history').split('\n')
2596
if history[-1:] == ['']:
2597
# There shouldn't be a trailing newline, but just in case.
2602
def generate_revision_history(self, revision_id, last_rev=None,
2604
"""Create a new revision history that will finish with revision_id.
2606
:param revision_id: the new tip to use.
2607
:param last_rev: The previous last_revision. If not None, then this
2608
must be a ancestory of revision_id, or DivergedBranches is raised.
2609
:param other_branch: The other branch that DivergedBranches should
2610
raise with respect to.
2612
self.set_revision_history(self._lefthand_history(revision_id,
2613
last_rev, other_branch))
2508
old_revno, old_revid = self.last_revision_info()
2509
if self._get_append_revisions_only():
2510
self._check_history_violation(revision_id)
2511
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2512
self._write_last_revision_info(revno, revision_id)
2513
self._clear_cached_state()
2514
self._last_revision_info_cache = revno, revision_id
2515
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2615
2517
def basis_tree(self):
2616
2518
"""See Branch.basis_tree."""
2628
def _basic_push(self, target, overwrite, stop_revision):
2629
"""Basic implementation of push without bound branches or hooks.
2631
Must be called with source read locked and target write locked.
2633
result = BranchPushResult()
2634
result.source_branch = self
2635
result.target_branch = target
2636
result.old_revno, result.old_revid = target.last_revision_info()
2637
self.update_references(target)
2638
if result.old_revid != self.last_revision():
2639
# We assume that during 'push' this repository is closer than
2641
graph = self.repository.get_graph(target.repository)
2642
target.update_revisions(self, stop_revision,
2643
overwrite=overwrite, graph=graph)
2644
if self._push_should_merge_tags():
2645
result.tag_conflicts = self.tags.merge_to(target.tags,
2647
result.new_revno, result.new_revid = target.last_revision_info()
2650
2530
def get_stacked_on_url(self):
2651
2531
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2663
2543
self._transport.put_bytes('parent', url + '\n',
2664
2544
mode=self.bzrdir._get_file_mode())
2667
class BzrBranch5(BzrBranch):
2668
"""A format 5 branch. This supports new features over plain branches.
2670
It has support for a master_branch which is the data for bound branches.
2673
def get_bound_location(self):
2675
return self._transport.get_bytes('bound')[:-1]
2676
except errors.NoSuchFile:
2680
def get_master_branch(self, possible_transports=None):
2681
"""Return the branch we are bound to.
2683
:return: Either a Branch, or None
2685
This could memoise the branch, but if thats done
2686
it must be revalidated on each new lock.
2687
So for now we just don't memoise it.
2688
# RBC 20060304 review this decision.
2690
bound_loc = self.get_bound_location()
2694
return Branch.open(bound_loc,
2695
possible_transports=possible_transports)
2696
except (errors.NotBranchError, errors.ConnectionError), e:
2697
raise errors.BoundBranchConnectionFailure(
2700
2546
@needs_write_lock
2701
def set_bound_location(self, location):
2702
"""Set the target where this branch is bound to.
2704
:param location: URL to the target branch
2707
self._transport.put_bytes('bound', location+'\n',
2708
mode=self.bzrdir._get_file_mode())
2711
self._transport.delete('bound')
2712
except errors.NoSuchFile:
2548
"""If bound, unbind"""
2549
return self.set_bound_location(None)
2716
2551
@needs_write_lock
2717
2552
def bind(self, other):
2739
2574
# history around
2740
2575
self.set_bound_location(other.base)
2577
def get_bound_location(self):
2579
return self._transport.get_bytes('bound')[:-1]
2580
except errors.NoSuchFile:
2584
def get_master_branch(self, possible_transports=None):
2585
"""Return the branch we are bound to.
2587
:return: Either a Branch, or None
2589
if self._master_branch_cache is None:
2590
self._master_branch_cache = self._get_master_branch(
2591
possible_transports)
2592
return self._master_branch_cache
2594
def _get_master_branch(self, possible_transports):
2595
bound_loc = self.get_bound_location()
2599
return Branch.open(bound_loc,
2600
possible_transports=possible_transports)
2601
except (errors.NotBranchError, errors.ConnectionError), e:
2602
raise errors.BoundBranchConnectionFailure(
2742
2605
@needs_write_lock
2744
"""If bound, unbind"""
2745
return self.set_bound_location(None)
2606
def set_bound_location(self, location):
2607
"""Set the target where this branch is bound to.
2609
:param location: URL to the target branch
2611
self._master_branch_cache = None
2613
self._transport.put_bytes('bound', location+'\n',
2614
mode=self.bzrdir._get_file_mode())
2617
self._transport.delete('bound')
2618
except errors.NoSuchFile:
2747
2622
@needs_write_lock
2748
2623
def update(self, possible_transports=None):
2765
class BzrBranch8(BzrBranch5):
2639
def _read_last_revision_info(self):
2640
revision_string = self._transport.get_bytes('last-revision')
2641
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2642
revision_id = cache_utf8.get_cached_utf8(revision_id)
2644
return revno, revision_id
2646
def _write_last_revision_info(self, revno, revision_id):
2647
"""Simply write out the revision id, with no checks.
2649
Use set_last_revision_info to perform this safely.
2651
Does not update the revision_history cache.
2653
revision_id = _mod_revision.ensure_null(revision_id)
2654
out_string = '%d %s\n' % (revno, revision_id)
2655
self._transport.put_bytes('last-revision', out_string,
2656
mode=self.bzrdir._get_file_mode())
2659
class FullHistoryBzrBranch(BzrBranch):
2660
"""Bzr branch which contains the full revision history."""
2663
def set_last_revision_info(self, revno, revision_id):
2664
if not revision_id or not isinstance(revision_id, basestring):
2665
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2666
revision_id = _mod_revision.ensure_null(revision_id)
2667
# this old format stores the full history, but this api doesn't
2668
# provide it, so we must generate, and might as well check it's
2670
history = self._lefthand_history(revision_id)
2671
if len(history) != revno:
2672
raise AssertionError('%d != %d' % (len(history), revno))
2673
self._set_revision_history(history)
2675
def _read_last_revision_info(self):
2676
rh = self.revision_history()
2679
return (revno, rh[-1])
2681
return (0, _mod_revision.NULL_REVISION)
2683
@deprecated_method(deprecated_in((2, 4, 0)))
2685
def set_revision_history(self, rev_history):
2686
"""See Branch.set_revision_history."""
2687
self._set_revision_history(rev_history)
2689
def _set_revision_history(self, rev_history):
2690
if 'evil' in debug.debug_flags:
2691
mutter_callsite(3, "set_revision_history scales with history.")
2692
check_not_reserved_id = _mod_revision.check_not_reserved_id
2693
for rev_id in rev_history:
2694
check_not_reserved_id(rev_id)
2695
if Branch.hooks['post_change_branch_tip']:
2696
# Don't calculate the last_revision_info() if there are no hooks
2698
old_revno, old_revid = self.last_revision_info()
2699
if len(rev_history) == 0:
2700
revid = _mod_revision.NULL_REVISION
2702
revid = rev_history[-1]
2703
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2704
self._write_revision_history(rev_history)
2705
self._clear_cached_state()
2706
self._cache_revision_history(rev_history)
2707
for hook in Branch.hooks['set_rh']:
2708
hook(self, rev_history)
2709
if Branch.hooks['post_change_branch_tip']:
2710
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2712
def _write_revision_history(self, history):
2713
"""Factored out of set_revision_history.
2715
This performs the actual writing to disk.
2716
It is intended to be called by set_revision_history."""
2717
self._transport.put_bytes(
2718
'revision-history', '\n'.join(history),
2719
mode=self.bzrdir._get_file_mode())
2721
def _gen_revision_history(self):
2722
history = self._transport.get_bytes('revision-history').split('\n')
2723
if history[-1:] == ['']:
2724
# There shouldn't be a trailing newline, but just in case.
2728
def _synchronize_history(self, destination, revision_id):
2729
if not isinstance(destination, FullHistoryBzrBranch):
2730
super(BzrBranch, self)._synchronize_history(
2731
destination, revision_id)
2733
if revision_id == _mod_revision.NULL_REVISION:
2736
new_history = self.revision_history()
2737
if revision_id is not None and new_history != []:
2739
new_history = new_history[:new_history.index(revision_id) + 1]
2741
rev = self.repository.get_revision(revision_id)
2742
new_history = rev.get_history(self.repository)[1:]
2743
destination._set_revision_history(new_history)
2746
def generate_revision_history(self, revision_id, last_rev=None,
2748
"""Create a new revision history that will finish with revision_id.
2750
:param revision_id: the new tip to use.
2751
:param last_rev: The previous last_revision. If not None, then this
2752
must be a ancestory of revision_id, or DivergedBranches is raised.
2753
:param other_branch: The other branch that DivergedBranches should
2754
raise with respect to.
2756
self._set_revision_history(self._lefthand_history(revision_id,
2757
last_rev, other_branch))
2760
class BzrBranch5(FullHistoryBzrBranch):
2761
"""A format 5 branch. This supports new features over plain branches.
2763
It has support for a master_branch which is the data for bound branches.
2767
class BzrBranch8(BzrBranch):
2766
2768
"""A branch that stores tree-reference locations."""
2768
2770
def _open_hook(self):
2794
2796
self._last_revision_info_cache = None
2795
2797
self._reference_info = None
2797
def _last_revision_info(self):
2798
revision_string = self._transport.get_bytes('last-revision')
2799
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2800
revision_id = cache_utf8.get_cached_utf8(revision_id)
2802
return revno, revision_id
2804
def _write_last_revision_info(self, revno, revision_id):
2805
"""Simply write out the revision id, with no checks.
2807
Use set_last_revision_info to perform this safely.
2809
Does not update the revision_history cache.
2810
Intended to be called by set_last_revision_info and
2811
_write_revision_history.
2813
revision_id = _mod_revision.ensure_null(revision_id)
2814
out_string = '%d %s\n' % (revno, revision_id)
2815
self._transport.put_bytes('last-revision', out_string,
2816
mode=self.bzrdir._get_file_mode())
2819
def set_last_revision_info(self, revno, revision_id):
2820
revision_id = _mod_revision.ensure_null(revision_id)
2821
old_revno, old_revid = self.last_revision_info()
2822
if self._get_append_revisions_only():
2823
self._check_history_violation(revision_id)
2824
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2825
self._write_last_revision_info(revno, revision_id)
2826
self._clear_cached_state()
2827
self._last_revision_info_cache = revno, revision_id
2828
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2830
def _synchronize_history(self, destination, revision_id):
2831
"""Synchronize last revision and revision history between branches.
2833
:see: Branch._synchronize_history
2835
# XXX: The base Branch has a fast implementation of this method based
2836
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2837
# that uses set_revision_history. This class inherits from BzrBranch5,
2838
# but wants the fast implementation, so it calls
2839
# Branch._synchronize_history directly.
2840
Branch._synchronize_history(self, destination, revision_id)
2842
2799
def _check_history_violation(self, revision_id):
2843
last_revision = _mod_revision.ensure_null(self.last_revision())
2800
current_revid = self.last_revision()
2801
last_revision = _mod_revision.ensure_null(current_revid)
2844
2802
if _mod_revision.is_null(last_revision):
2846
if last_revision not in self._lefthand_history(revision_id):
2847
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2804
graph = self.repository.get_graph()
2805
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2806
if lh_ancestor == current_revid:
2808
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2849
2810
def _gen_revision_history(self):
2850
2811
"""Generate the revision history from last revision
3229
3174
branch._transport.put_bytes('format', format.get_format_string())
3232
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3233
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3236
_run_with_write_locked_target will attempt to release the lock it acquires.
3238
If an exception is raised by callable, then that exception *will* be
3239
propagated, even if the unlock attempt raises its own error. Thus
3240
_run_with_write_locked_target should be preferred to simply doing::
3244
return callable(*args, **kwargs)
3249
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3250
# should share code?
3253
result = callable(*args, **kwargs)
3255
exc_info = sys.exc_info()
3259
raise exc_info[0], exc_info[1], exc_info[2]
3265
3177
class InterBranch(InterObject):
3266
3178
"""This class represents operations taking place between two branches.
3295
3207
raise NotImplementedError(self.pull)
3297
3209
@needs_write_lock
3298
def update_revisions(self, stop_revision=None, overwrite=False,
3300
"""Pull in new perfect-fit revisions.
3302
:param stop_revision: Updated until the given revision
3303
:param overwrite: Always set the branch pointer, rather than checking
3304
to see if it is a proper descendant.
3305
:param graph: A Graph object that can be used to query history
3306
information. This can be None.
3309
raise NotImplementedError(self.update_revisions)
3312
def push(self, overwrite=False, stop_revision=None,
3210
def push(self, overwrite=False, stop_revision=None, lossy=False,
3313
3211
_override_hook_source_branch=None):
3314
3212
"""Mirror the source branch into the target branch.
3366
3273
self.source.tags.merge_to(self.target.tags)
3368
3275
@needs_write_lock
3369
def update_revisions(self, stop_revision=None, overwrite=False,
3371
"""See InterBranch.update_revisions()."""
3276
def fetch(self, stop_revision=None, limit=None):
3277
if self.target.base == self.source.base:
3279
self.source.lock_read()
3281
fetch_spec_factory = fetch.FetchSpecFactory()
3282
fetch_spec_factory.source_branch = self.source
3283
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3284
fetch_spec_factory.source_repo = self.source.repository
3285
fetch_spec_factory.target_repo = self.target.repository
3286
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3287
fetch_spec_factory.limit = limit
3288
fetch_spec = fetch_spec_factory.make_fetch_spec()
3289
return self.target.repository.fetch(self.source.repository,
3290
fetch_spec=fetch_spec)
3292
self.source.unlock()
3295
def _update_revisions(self, stop_revision=None, overwrite=False,
3372
3297
other_revno, other_last_revision = self.source.last_revision_info()
3373
3298
stop_revno = None # unknown
3374
3299
if stop_revision is None:
3431
3357
return self._pull(overwrite,
3432
3358
stop_revision, _hook_master=master_branch,
3433
3359
run_hooks=run_hooks,
3434
_override_hook_target=_override_hook_target)
3360
_override_hook_target=_override_hook_target,
3361
merge_tags_to_master=not source_is_master)
3436
3363
if master_branch:
3437
3364
master_branch.unlock()
3439
def push(self, overwrite=False, stop_revision=None,
3366
def push(self, overwrite=False, stop_revision=None, lossy=False,
3440
3367
_override_hook_source_branch=None):
3441
3368
"""See InterBranch.push.
3443
3370
This is the basic concrete implementation of push()
3445
:param _override_hook_source_branch: If specified, run
3446
the hooks passing this Branch as the source, rather than self.
3447
This is for use of RemoteBranch, where push is delegated to the
3448
underlying vfs-based Branch.
3372
:param _override_hook_source_branch: If specified, run the hooks
3373
passing this Branch as the source, rather than self. This is for
3374
use of RemoteBranch, where push is delegated to the underlying
3378
raise errors.LossyPushToSameVCS(self.source, self.target)
3450
3379
# TODO: Public option to disable running hooks - should be trivial but
3452
self.source.lock_read()
3454
return _run_with_write_locked_target(
3455
self.target, self._push_with_bound_branches, overwrite,
3457
_override_hook_source_branch=_override_hook_source_branch)
3459
self.source.unlock()
3461
def _push_with_bound_branches(self, overwrite, stop_revision,
3382
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3383
op.add_cleanup(self.source.lock_read().unlock)
3384
op.add_cleanup(self.target.lock_write().unlock)
3385
return op.run(overwrite, stop_revision,
3386
_override_hook_source_branch=_override_hook_source_branch)
3388
def _basic_push(self, overwrite, stop_revision):
3389
"""Basic implementation of push without bound branches or hooks.
3391
Must be called with source read locked and target write locked.
3393
result = BranchPushResult()
3394
result.source_branch = self.source
3395
result.target_branch = self.target
3396
result.old_revno, result.old_revid = self.target.last_revision_info()
3397
self.source.update_references(self.target)
3398
if result.old_revid != stop_revision:
3399
# We assume that during 'push' this repository is closer than
3401
graph = self.source.repository.get_graph(self.target.repository)
3402
self._update_revisions(stop_revision, overwrite=overwrite,
3404
if self.source._push_should_merge_tags():
3405
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3407
result.new_revno, result.new_revid = self.target.last_revision_info()
3410
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3462
3411
_override_hook_source_branch=None):
3463
3412
"""Push from source into target, and into target's master if any.
3476
3425
# be bound to itself? -- mbp 20070507
3477
3426
master_branch = self.target.get_master_branch()
3478
3427
master_branch.lock_write()
3480
# push into the master from the source branch.
3481
self.source._basic_push(master_branch, overwrite, stop_revision)
3482
# and push into the target branch from the source. Note that we
3483
# push from the source branch again, because it's considered the
3484
# highest bandwidth repository.
3485
result = self.source._basic_push(self.target, overwrite,
3487
result.master_branch = master_branch
3488
result.local_branch = self.target
3492
master_branch.unlock()
3428
operation.add_cleanup(master_branch.unlock)
3429
# push into the master from the source branch.
3430
master_inter = InterBranch.get(self.source, master_branch)
3431
master_inter._basic_push(overwrite, stop_revision)
3432
# and push into the target branch from the source. Note that
3433
# we push from the source branch again, because it's considered
3434
# the highest bandwidth repository.
3435
result = self._basic_push(overwrite, stop_revision)
3436
result.master_branch = master_branch
3437
result.local_branch = self.target
3439
master_branch = None
3494
3440
# no master branch
3495
result = self.source._basic_push(self.target, overwrite,
3441
result = self._basic_push(overwrite, stop_revision)
3497
3442
# TODO: Why set master_branch and local_branch if there's no
3498
3443
# binding? Maybe cleaner to just leave them unset? -- mbp
3500
3445
result.master_branch = self.target
3501
3446
result.local_branch = None
3505
3450
def _pull(self, overwrite=False, stop_revision=None,
3506
3451
possible_transports=None, _hook_master=None, run_hooks=True,
3507
_override_hook_target=None, local=False):
3452
_override_hook_target=None, local=False,
3453
merge_tags_to_master=True):
3508
3454
"""See Branch.pull.
3510
3456
This function is the core worker, used by GenericInterBranch.pull to
added
removed
bzrlib/branch.py
