14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
18
from cStringIO import StringIO
21
21
from bzrlib.lazy_import import lazy_import
22
22
lazy_import(globals(), """
23
from itertools import chain
24
24
from bzrlib import (
29
config as _mod_config,
38
revision as _mod_revision,
27
config as _mod_config,
34
revision as _mod_revision,
42
from bzrlib.config import BranchConfig, TransportConfig
43
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
44
from bzrlib.tag import (
45
from bzrlib.i18n import gettext, ngettext
51
from bzrlib.decorators import (
56
from bzrlib.hooks import Hooks
50
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
51
from bzrlib.hooks import HookPoint, Hooks
57
52
from bzrlib.inter import InterObject
58
53
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
59
54
from bzrlib import registry
516
487
rev_iter = iter(merge_sorted_revisions)
517
488
if start_revision_id is not None:
518
489
for node in rev_iter:
490
rev_id = node.key[-1]
520
491
if rev_id != start_revision_id:
523
494
# The decision to include the start or not
524
495
# depends on the stop_rule if a stop is provided
525
496
# so pop this node back into the iterator
526
rev_iter = itertools.chain(iter([node]), rev_iter)
497
rev_iter = chain(iter([node]), rev_iter)
528
499
if stop_revision_id is None:
529
500
# Yield everything
530
501
for node in rev_iter:
502
rev_id = node.key[-1]
532
503
yield (rev_id, node.merge_depth, node.revno,
533
504
node.end_of_merge)
534
505
elif stop_rule == 'exclude':
535
506
for node in rev_iter:
507
rev_id = node.key[-1]
537
508
if rev_id == stop_revision_id:
539
510
yield (rev_id, node.merge_depth, node.revno,
540
511
node.end_of_merge)
541
512
elif stop_rule == 'include':
542
513
for node in rev_iter:
514
rev_id = node.key[-1]
544
515
yield (rev_id, node.merge_depth, node.revno,
545
516
node.end_of_merge)
546
517
if rev_id == stop_revision_id:
681
644
raise errors.UnsupportedOperation(self.get_reference_info, self)
683
646
@needs_write_lock
684
def fetch(self, from_branch, last_revision=None, limit=None):
647
def fetch(self, from_branch, last_revision=None, pb=None):
685
648
"""Copy revisions from from_branch into this branch.
687
650
:param from_branch: Where to copy from.
688
651
:param last_revision: What revision to stop at (None for at the end
690
:param limit: Optional rough limit of revisions to fetch
653
:param pb: An optional progress bar to use.
693
return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
656
if self.base == from_branch.base:
659
symbol_versioning.warn(
660
symbol_versioning.deprecated_in((1, 14, 0))
661
% "pb parameter to fetch()")
662
from_branch.lock_read()
664
if last_revision is None:
665
last_revision = from_branch.last_revision()
666
last_revision = _mod_revision.ensure_null(last_revision)
667
return self.repository.fetch(from_branch.repository,
668
revision_id=last_revision,
695
673
def get_bound_location(self):
696
674
"""Return the URL of the branch we are bound to.
761
734
"""Print `file` to stdout."""
762
735
raise NotImplementedError(self.print_file)
764
@deprecated_method(deprecated_in((2, 4, 0)))
765
737
def set_revision_history(self, rev_history):
766
"""See Branch.set_revision_history."""
767
self._set_revision_history(rev_history)
770
def _set_revision_history(self, rev_history):
771
if len(rev_history) == 0:
772
revid = _mod_revision.NULL_REVISION
774
revid = rev_history[-1]
775
if rev_history != self._lefthand_history(revid):
776
raise errors.NotLefthandHistory(rev_history)
777
self.set_last_revision_info(len(rev_history), revid)
778
self._cache_revision_history(rev_history)
779
for hook in Branch.hooks['set_rh']:
780
hook(self, rev_history)
783
def set_last_revision_info(self, revno, revision_id):
784
"""Set the last revision of this branch.
786
The caller is responsible for checking that the revno is correct
787
for this revision id.
789
It may be possible to set the branch last revision to an id not
790
present in the repository. However, branches can also be
791
configured to check constraints on history, in which case this may not
794
raise NotImplementedError(self.set_last_revision_info)
797
def generate_revision_history(self, revision_id, last_rev=None,
799
"""See Branch.generate_revision_history"""
800
graph = self.repository.get_graph()
801
(last_revno, last_revid) = self.last_revision_info()
802
known_revision_ids = [
803
(last_revid, last_revno),
804
(_mod_revision.NULL_REVISION, 0),
806
if last_rev is not None:
807
if not graph.is_ancestor(last_rev, revision_id):
808
# our previous tip is not merged into stop_revision
809
raise errors.DivergedBranches(self, other_branch)
810
revno = graph.find_distance_to_null(revision_id, known_revision_ids)
811
self.set_last_revision_info(revno, revision_id)
738
raise NotImplementedError(self.set_revision_history)
813
740
@needs_write_lock
814
741
def set_parent(self, url):
929
854
# XXX: If you unstack a branch while it has a working tree
930
855
# with a pending merge, the pending-merged revisions will no
931
856
# longer be present. You can (probably) revert and remerge.
933
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
934
except errors.TagsNotSupported:
935
tags_to_fetch = set()
936
fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
937
old_repository, required_ids=[self.last_revision()],
938
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
939
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
858
# XXX: This only fetches up to the tip of the repository; it
859
# doesn't bring across any tags. That's fairly consistent
860
# with how branch works, but perhaps not ideal.
861
self.repository.fetch(old_repository,
862
revision_id=self.last_revision(),
941
865
old_repository.unlock()
1050
963
:return: A tuple (revno, revision_id).
1052
965
if self._last_revision_info_cache is None:
1053
self._last_revision_info_cache = self._read_last_revision_info()
966
self._last_revision_info_cache = self._last_revision_info()
1054
967
return self._last_revision_info_cache
1056
def _read_last_revision_info(self):
1057
raise NotImplementedError(self._read_last_revision_info)
1059
@deprecated_method(deprecated_in((2, 4, 0)))
969
def _last_revision_info(self):
970
rh = self.revision_history()
973
return (revno, rh[-1])
975
return (0, _mod_revision.NULL_REVISION)
977
@deprecated_method(deprecated_in((1, 6, 0)))
978
def missing_revisions(self, other, stop_revision=None):
979
"""Return a list of new revisions that would perfectly fit.
981
If self and other have not diverged, return a list of the revisions
982
present in other, but missing from self.
984
self_history = self.revision_history()
985
self_len = len(self_history)
986
other_history = other.revision_history()
987
other_len = len(other_history)
988
common_index = min(self_len, other_len) -1
989
if common_index >= 0 and \
990
self_history[common_index] != other_history[common_index]:
991
raise errors.DivergedBranches(self, other)
993
if stop_revision is None:
994
stop_revision = other_len
996
if stop_revision > other_len:
997
raise errors.NoSuchRevision(self, stop_revision)
998
return other_history[self_len:stop_revision]
1000
def update_revisions(self, other, stop_revision=None, overwrite=False,
1002
"""Pull in new perfect-fit revisions.
1004
:param other: Another Branch to pull from
1005
:param stop_revision: Updated until the given revision
1006
:param overwrite: Always set the branch pointer, rather than checking
1007
to see if it is a proper descendant.
1008
:param graph: A Graph object that can be used to query history
1009
information. This can be None.
1012
return InterBranch.get(other, self).update_revisions(stop_revision,
1060
1015
def import_last_revision_info(self, source_repo, revno, revid):
1061
1016
"""Set the last revision info, importing from another repo if necessary.
1018
This is used by the bound branch code to upload a revision to
1019
the master branch first before updating the tip of the local branch.
1063
1021
:param source_repo: Source repository to optionally fetch from
1064
1022
:param revno: Revision number of the new tip
1065
1023
:param revid: Revision id of the new tip
1068
1026
self.repository.fetch(source_repo, revision_id=revid)
1069
1027
self.set_last_revision_info(revno, revid)
1071
def import_last_revision_info_and_tags(self, source, revno, revid,
1073
"""Set the last revision info, importing from another repo if necessary.
1075
This is used by the bound branch code to upload a revision to
1076
the master branch first before updating the tip of the local branch.
1077
Revisions referenced by source's tags are also transferred.
1079
:param source: Source branch to optionally fetch from
1080
:param revno: Revision number of the new tip
1081
:param revid: Revision id of the new tip
1082
:param lossy: Whether to discard metadata that can not be
1083
natively represented
1084
:return: Tuple with the new revision number and revision id
1085
(should only be different from the arguments when lossy=True)
1087
if not self.repository.has_same_location(source.repository):
1088
self.fetch(source, revid)
1089
self.set_last_revision_info(revno, revid)
1090
return (revno, revid)
1092
1029
def revision_id_to_revno(self, revision_id):
1093
1030
"""Given a revision id, return its revno"""
1094
1031
if _mod_revision.is_null(revision_id):
1096
history = self._revision_history()
1033
history = self.revision_history()
1098
1035
return history.index(revision_id) + 1
1099
1036
except ValueError:
1126
1063
stop_revision=stop_revision,
1127
1064
possible_transports=possible_transports, *args, **kwargs)
1129
def push(self, target, overwrite=False, stop_revision=None, lossy=False,
1066
def push(self, target, overwrite=False, stop_revision=None, *args,
1131
1068
"""Mirror this branch into target.
1133
1070
This branch is considered to be 'local', having low latency.
1135
1072
return InterBranch.get(self, target).push(overwrite, stop_revision,
1136
lossy, *args, **kwargs)
1075
def lossy_push(self, target, stop_revision=None):
1076
"""Push deltas into another branch.
1078
:note: This does not, like push, retain the revision ids from
1079
the source branch and will, rather than adding bzr-specific
1080
metadata, push only those semantics of the revision that can be
1081
natively represented by this branch' VCS.
1083
:param target: Target branch
1084
:param stop_revision: Revision to push, defaults to last revision.
1085
:return: BranchPushResult with an extra member revidmap:
1086
A dictionary mapping revision ids from the target branch
1087
to new revision ids in the target branch, for each
1088
revision that was pushed.
1090
inter = InterBranch.get(self, target)
1091
lossy_push = getattr(inter, "lossy_push", None)
1092
if lossy_push is None:
1093
raise errors.LossyPushToSameVCS(self, target)
1094
return lossy_push(stop_revision)
1138
1096
def basis_tree(self):
1139
1097
"""Return `Tree` object for last revision."""
1396
1349
# TODO: We should probably also check that self.revision_history
1397
1350
# matches the repository for older branch formats.
1398
1351
# If looking for the code that cross-checks repository parents against
1399
# the Graph.iter_lefthand_ancestry output, that is now a repository
1352
# the iter_reverse_revision_history output, that is now a repository
1400
1353
# specific check.
1403
def _get_checkout_format(self, lightweight=False):
1356
def _get_checkout_format(self):
1404
1357
"""Return the most suitable metadir for a checkout of this branch.
1405
1358
Weaves are used if this branch's repository uses weaves.
1407
format = self.repository.bzrdir.checkout_metadir()
1408
format.set_branch_format(self._format)
1360
if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1361
from bzrlib.repofmt import weaverepo
1362
format = bzrdir.BzrDirMetaFormat1()
1363
format.repository_format = weaverepo.RepositoryFormat7()
1365
format = self.repository.bzrdir.checkout_metadir()
1366
format.set_branch_format(self._format)
1411
1369
def create_clone_on_transport(self, to_transport, revision_id=None,
1412
stacked_on=None, create_prefix=False, use_existing_dir=False,
1370
stacked_on=None, create_prefix=False, use_existing_dir=False):
1414
1371
"""Create a clone of this branch and its bzrdir.
1416
1373
:param to_transport: The transport to clone onto.
1552
1508
raise AssertionError("invalid heads: %r" % (heads,))
1554
def heads_to_fetch(self):
1555
"""Return the heads that must and that should be fetched to copy this
1556
branch into another repo.
1558
:returns: a 2-tuple of (must_fetch, if_present_fetch). must_fetch is a
1559
set of heads that must be fetched. if_present_fetch is a set of
1560
heads that must be fetched if present, but no error is necessary if
1561
they are not present.
1563
# For bzr native formats must_fetch is just the tip, and if_present_fetch
1565
must_fetch = set([self.last_revision()])
1566
if_present_fetch = set()
1567
c = self.get_config()
1568
include_tags = c.get_user_option_as_bool('branch.fetch_tags',
1572
if_present_fetch = set(self.tags.get_reverse_tag_dict())
1573
except errors.TagsNotSupported:
1575
must_fetch.discard(_mod_revision.NULL_REVISION)
1576
if_present_fetch.discard(_mod_revision.NULL_REVISION)
1577
return must_fetch, if_present_fetch
1580
class BranchFormat(controldir.ControlComponentFormat):
1511
class BranchFormat(object):
1581
1512
"""An encapsulation of the initialization and open routines for a format.
1583
1514
Formats provide three things:
1602
1541
return not (self == other)
1605
def find_format(klass, controldir, name=None):
1606
"""Return the format for the branch object in controldir."""
1544
def find_format(klass, a_bzrdir, name=None):
1545
"""Return the format for the branch object in a_bzrdir."""
1608
transport = controldir.get_branch_transport(None, name=name)
1547
transport = a_bzrdir.get_branch_transport(None, name=name)
1609
1548
format_string = transport.get_bytes("format")
1610
return format_registry.get(format_string)
1549
format = klass._formats[format_string]
1550
if isinstance(format, MetaDirBranchFormatFactory):
1611
1553
except errors.NoSuchFile:
1612
raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
1554
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1613
1555
except KeyError:
1614
1556
raise errors.UnknownFormatError(format=format_string, kind='branch')
1617
@deprecated_method(deprecated_in((2, 4, 0)))
1618
1559
def get_default_format(klass):
1619
1560
"""Return the current default format."""
1620
return format_registry.get_default()
1561
return klass._default_format
1623
@deprecated_method(deprecated_in((2, 4, 0)))
1624
1564
def get_formats(klass):
1625
1565
"""Get all the known formats.
1627
1567
Warning: This triggers a load of all lazy registered formats: do not
1628
1568
use except when that is desireed.
1630
return format_registry._get_all()
1571
for fmt in klass._formats.values():
1572
if isinstance(fmt, MetaDirBranchFormatFactory):
1632
def get_reference(self, controldir, name=None):
1633
"""Get the target reference of the branch in controldir.
1577
def get_reference(self, a_bzrdir, name=None):
1578
"""Get the target reference of the branch in a_bzrdir.
1635
1580
format probing must have been completed before calling
1636
1581
this method - it is assumed that the format of the branch
1637
in controldir is correct.
1582
in a_bzrdir is correct.
1639
:param controldir: The controldir to get the branch data from.
1584
:param a_bzrdir: The bzrdir to get the branch data from.
1640
1585
:param name: Name of the colocated branch to fetch
1641
1586
:return: None if the branch is not a reference branch.
1646
def set_reference(self, controldir, name, to_branch):
1647
"""Set the target reference of the branch in controldir.
1591
def set_reference(self, a_bzrdir, name, to_branch):
1592
"""Set the target reference of the branch in a_bzrdir.
1649
1594
format probing must have been completed before calling
1650
1595
this method - it is assumed that the format of the branch
1651
in controldir is correct.
1596
in a_bzrdir is correct.
1653
:param controldir: The controldir to set the branch reference for.
1598
:param a_bzrdir: The bzrdir to set the branch reference for.
1654
1599
:param name: Name of colocated branch to set, None for default
1655
1600
:param to_branch: branch that the checkout is to reference
1664
1609
"""Return the short format description for this format."""
1665
1610
raise NotImplementedError(self.get_format_description)
1667
def _run_post_branch_init_hooks(self, controldir, name, branch):
1612
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1668
1613
hooks = Branch.hooks['post_branch_init']
1671
params = BranchInitHookParams(self, controldir, name, branch)
1616
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1672
1617
for hook in hooks:
1675
def initialize(self, controldir, name=None, repository=None,
1676
append_revisions_only=None):
1677
"""Create a branch of this format in controldir.
1620
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1621
lock_type='metadir', set_format=True):
1622
"""Initialize a branch in a bzrdir, with specified files
1624
:param a_bzrdir: The bzrdir to initialize the branch in
1625
:param utf8_files: The files to create as a list of
1626
(filename, content) tuples
1627
:param name: Name of colocated branch to create, if any
1628
:param set_format: If True, set the format with
1629
self.get_format_string. (BzrBranch4 has its format set
1631
:return: a branch in this format
1633
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1634
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1636
'metadir': ('lock', lockdir.LockDir),
1637
'branch4': ('branch-lock', lockable_files.TransportLock),
1639
lock_name, lock_class = lock_map[lock_type]
1640
control_files = lockable_files.LockableFiles(branch_transport,
1641
lock_name, lock_class)
1642
control_files.create_lock()
1644
control_files.lock_write()
1645
except errors.LockContention:
1646
if lock_type != 'branch4':
1652
utf8_files += [('format', self.get_format_string())]
1654
for (filename, content) in utf8_files:
1655
branch_transport.put_bytes(
1657
mode=a_bzrdir._get_file_mode())
1660
control_files.unlock()
1661
branch = self.open(a_bzrdir, name, _found=True)
1662
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1665
def initialize(self, a_bzrdir, name=None):
1666
"""Create a branch of this format in a_bzrdir.
1679
1668
:param name: Name of the colocated branch to create.
1681
1670
raise NotImplementedError(self.initialize)
1727
1715
raise NotImplementedError(self.open)
1730
@deprecated_method(deprecated_in((2, 4, 0)))
1731
1718
def register_format(klass, format):
1732
1719
"""Register a metadir format.
1734
1721
See MetaDirBranchFormatFactory for the ability to register a format
1735
1722
without loading the code the format needs until it is actually used.
1737
format_registry.register(format)
1724
klass._formats[format.get_format_string()] = format
1725
# Metadir formats have a network name of their format string, and get
1726
# registered as factories.
1727
if isinstance(format, MetaDirBranchFormatFactory):
1728
network_format_registry.register(format.get_format_string(), format)
1730
network_format_registry.register(format.get_format_string(),
1740
@deprecated_method(deprecated_in((2, 4, 0)))
1741
1734
def set_default_format(klass, format):
1742
format_registry.set_default(format)
1735
klass._default_format = format
1744
1737
def supports_set_append_revisions_only(self):
1745
1738
"""True if this format supports set_append_revisions_only."""
1815
1795
These are all empty initially, because by default nothing should get
1818
Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1819
self.add_hook('set_rh',
1798
Hooks.__init__(self)
1799
self.create_hook(HookPoint('set_rh',
1820
1800
"Invoked whenever the revision history has been set via "
1821
1801
"set_revision_history. The api signature is (branch, "
1822
1802
"revision_history), and the branch will be write-locked. "
1823
1803
"The set_rh hook can be expensive for bzr to trigger, a better "
1824
"hook to use is Branch.post_change_branch_tip.", (0, 15))
1825
self.add_hook('open',
1804
"hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1805
self.create_hook(HookPoint('open',
1826
1806
"Called with the Branch object that has been opened after a "
1827
"branch is opened.", (1, 8))
1828
self.add_hook('post_push',
1807
"branch is opened.", (1, 8), None))
1808
self.create_hook(HookPoint('post_push',
1829
1809
"Called after a push operation completes. post_push is called "
1830
1810
"with a bzrlib.branch.BranchPushResult object and only runs in the "
1831
"bzr client.", (0, 15))
1832
self.add_hook('post_pull',
1811
"bzr client.", (0, 15), None))
1812
self.create_hook(HookPoint('post_pull',
1833
1813
"Called after a pull operation completes. post_pull is called "
1834
1814
"with a bzrlib.branch.PullResult object and only runs in the "
1835
"bzr client.", (0, 15))
1836
self.add_hook('pre_commit',
1837
"Called after a commit is calculated but before it is "
1815
"bzr client.", (0, 15), None))
1816
self.create_hook(HookPoint('pre_commit',
1817
"Called after a commit is calculated but before it is is "
1838
1818
"completed. pre_commit is called with (local, master, old_revno, "
1839
1819
"old_revid, future_revno, future_revid, tree_delta, future_tree"
1840
1820
"). old_revid is NULL_REVISION for the first commit to a branch, "
1842
1822
"basis revision. hooks MUST NOT modify this delta. "
1843
1823
" future_tree is an in-memory tree obtained from "
1844
1824
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1846
self.add_hook('post_commit',
1825
"tree.", (0,91), None))
1826
self.create_hook(HookPoint('post_commit',
1847
1827
"Called in the bzr client after a commit has completed. "
1848
1828
"post_commit is called with (local, master, old_revno, old_revid, "
1849
1829
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1850
"commit to a branch.", (0, 15))
1851
self.add_hook('post_uncommit',
1830
"commit to a branch.", (0, 15), None))
1831
self.create_hook(HookPoint('post_uncommit',
1852
1832
"Called in the bzr client after an uncommit completes. "
1853
1833
"post_uncommit is called with (local, master, old_revno, "
1854
1834
"old_revid, new_revno, new_revid) where local is the local branch "
1855
1835
"or None, master is the target branch, and an empty branch "
1856
"receives new_revno of 0, new_revid of None.", (0, 15))
1857
self.add_hook('pre_change_branch_tip',
1836
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1837
self.create_hook(HookPoint('pre_change_branch_tip',
1858
1838
"Called in bzr client and server before a change to the tip of a "
1859
1839
"branch is made. pre_change_branch_tip is called with a "
1860
1840
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1861
"commit, uncommit will all trigger this hook.", (1, 6))
1862
self.add_hook('post_change_branch_tip',
1841
"commit, uncommit will all trigger this hook.", (1, 6), None))
1842
self.create_hook(HookPoint('post_change_branch_tip',
1863
1843
"Called in bzr client and server after a change to the tip of a "
1864
1844
"branch is made. post_change_branch_tip is called with a "
1865
1845
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1866
"commit, uncommit will all trigger this hook.", (1, 4))
1867
self.add_hook('transform_fallback_location',
1846
"commit, uncommit will all trigger this hook.", (1, 4), None))
1847
self.create_hook(HookPoint('transform_fallback_location',
1868
1848
"Called when a stacked branch is activating its fallback "
1869
1849
"locations. transform_fallback_location is called with (branch, "
1870
1850
"url), and should return a new url. Returning the same url "
1875
1855
"fallback locations have not been activated. When there are "
1876
1856
"multiple hooks installed for transform_fallback_location, "
1877
1857
"all are called with the url returned from the previous hook."
1878
"The order is however undefined.", (1, 9))
1879
self.add_hook('automatic_tag_name',
1880
"Called to determine an automatic tag name for a revision. "
1858
"The order is however undefined.", (1, 9), None))
1859
self.create_hook(HookPoint('automatic_tag_name',
1860
"Called to determine an automatic tag name for a revision."
1881
1861
"automatic_tag_name is called with (branch, revision_id) and "
1882
1862
"should return a tag name or None if no tag name could be "
1883
1863
"determined. The first non-None tag name returned will be used.",
1885
self.add_hook('post_branch_init',
1865
self.create_hook(HookPoint('post_branch_init',
1886
1866
"Called after new branch initialization completes. "
1887
1867
"post_branch_init is called with a "
1888
1868
"bzrlib.branch.BranchInitHookParams. "
1889
1869
"Note that init, branch and checkout (both heavyweight and "
1890
"lightweight) will all trigger this hook.", (2, 2))
1891
self.add_hook('post_switch',
1870
"lightweight) will all trigger this hook.", (2, 2), None))
1871
self.create_hook(HookPoint('post_switch',
1892
1872
"Called after a checkout switches branch. "
1893
1873
"post_switch is called with a "
1894
"bzrlib.branch.SwitchHookParams.", (2, 2))
1874
"bzrlib.branch.SwitchHookParams.", (2, 2), None))
1974
1954
return self.__dict__ == other.__dict__
1976
1956
def __repr__(self):
1977
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1958
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1960
return "<%s of format:%s bzrdir:%s>" % (
1961
self.__class__.__name__, self.branch,
1962
self.format, self.bzrdir)
1980
1965
class SwitchHookParams(object):
1981
"""Object holding parameters passed to `*_switch` hooks.
1966
"""Object holding parameters passed to *_switch hooks.
1983
1968
There are 4 fields that hooks may wish to access:
1985
:ivar control_dir: ControlDir of the checkout to change
1970
:ivar control_dir: BzrDir of the checkout to change
1986
1971
:ivar to_branch: branch that the checkout is to reference
1987
1972
:ivar force: skip the check for local commits in a heavy checkout
1988
1973
:ivar revision_id: revision ID to switch to (or None)
2010
1995
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"
2013
2041
class BranchFormatMetadir(BranchFormat):
2014
2042
"""Common logic for meta-dir based branch formats."""
2017
2045
"""What class to instantiate on open calls."""
2018
2046
raise NotImplementedError(self._branch_class)
2020
def _get_initial_config(self, append_revisions_only=None):
2021
if append_revisions_only:
2022
return "append_revisions_only = True\n"
2024
# Avoid writing anything if append_revisions_only is disabled,
2025
# as that is the default.
2028
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
2030
"""Initialize a branch in a bzrdir, with specified files
2032
:param a_bzrdir: The bzrdir to initialize the branch in
2033
:param utf8_files: The files to create as a list of
2034
(filename, content) tuples
2035
:param name: Name of colocated branch to create, if any
2036
:return: a branch in this format
2038
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2039
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2040
control_files = lockable_files.LockableFiles(branch_transport,
2041
'lock', lockdir.LockDir)
2042
control_files.create_lock()
2043
control_files.lock_write()
2045
utf8_files += [('format', self.get_format_string())]
2046
for (filename, content) in utf8_files:
2047
branch_transport.put_bytes(
2049
mode=a_bzrdir._get_file_mode())
2051
control_files.unlock()
2052
branch = self.open(a_bzrdir, name, _found=True,
2053
found_repository=repository)
2054
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2057
2048
def network_name(self):
2058
2049
"""A simple byte string uniquely identifying this format for RPC calls.
2074
2064
control_files = lockable_files.LockableFiles(transport, 'lock',
2075
2065
lockdir.LockDir)
2076
if found_repository is None:
2077
found_repository = a_bzrdir.find_repository()
2078
2066
return self._branch_class()(_format=self,
2079
2067
_control_files=control_files,
2081
2069
a_bzrdir=a_bzrdir,
2082
_repository=found_repository,
2070
_repository=a_bzrdir.find_repository(),
2083
2071
ignore_fallbacks=ignore_fallbacks)
2084
2072
except errors.NoSuchFile:
2085
2073
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2088
def _matchingbzrdir(self):
2089
ret = bzrdir.BzrDirMetaFormat1()
2090
ret.set_branch_format(self)
2076
super(BranchFormatMetadir, self).__init__()
2077
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2078
self._matchingbzrdir.set_branch_format(self)
2093
2080
def supports_tags(self):
2096
def supports_leaving_lock(self):
2100
2084
class BzrBranchFormat5(BranchFormatMetadir):
2101
2085
"""Bzr branch format 5.
2157
2138
"""See BranchFormat.get_format_description()."""
2158
2139
return "Branch format 6"
2160
def initialize(self, a_bzrdir, name=None, repository=None,
2161
append_revisions_only=None):
2141
def initialize(self, a_bzrdir, name=None):
2162
2142
"""Create a branch of this format in a_bzrdir."""
2163
2143
utf8_files = [('last-revision', '0 null:\n'),
2165
self._get_initial_config(append_revisions_only)),
2144
('branch.conf', ''),
2168
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2147
return self._initialize_helper(a_bzrdir, utf8_files, name)
2170
2149
def make_tags(self, branch):
2171
2150
"""See bzrlib.branch.BranchFormat.make_tags()."""
2172
return _mod_tag.BasicTags(branch)
2151
return BasicTags(branch)
2174
2153
def supports_set_append_revisions_only(self):
2189
2168
"""See BranchFormat.get_format_description()."""
2190
2169
return "Branch format 8"
2192
def initialize(self, a_bzrdir, name=None, repository=None,
2193
append_revisions_only=None):
2171
def initialize(self, a_bzrdir, name=None):
2194
2172
"""Create a branch of this format in a_bzrdir."""
2195
2173
utf8_files = [('last-revision', '0 null:\n'),
2197
self._get_initial_config(append_revisions_only)),
2174
('branch.conf', ''),
2199
2176
('references', '')
2201
return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2178
return self._initialize_helper(a_bzrdir, utf8_files, name)
2181
super(BzrBranchFormat8, self).__init__()
2182
self._matchingbzrdir.repository_format = \
2183
RepositoryFormatKnitPack5RichRoot()
2203
2185
def make_tags(self, branch):
2204
2186
"""See bzrlib.branch.BranchFormat.make_tags()."""
2205
return _mod_tag.BasicTags(branch)
2187
return BasicTags(branch)
2207
2189
def supports_set_append_revisions_only(self):
2285
2258
transport = a_bzrdir.get_branch_transport(None, name=name)
2286
2259
location = transport.put_bytes('location', to_branch.base)
2288
def initialize(self, a_bzrdir, name=None, target_branch=None,
2289
repository=None, append_revisions_only=None):
2261
def initialize(self, a_bzrdir, name=None, target_branch=None):
2290
2262
"""Create a branch of this format in a_bzrdir."""
2291
2263
if target_branch is None:
2292
2264
# this format does not implement branch itself, thus the implicit
2293
2265
# creation contract must see it as uninitializable
2294
2266
raise errors.UninitializableFormat(self)
2295
2267
mutter('creating branch reference in %s', a_bzrdir.user_url)
2296
if a_bzrdir._format.fixed_components:
2297
raise errors.IncompatibleFormat(self, a_bzrdir._format)
2298
2268
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2299
2269
branch_transport.put_bytes('location',
2300
2270
target_branch.bzrdir.user_url)
2386
2344
__format6 = BzrBranchFormat6()
2387
2345
__format7 = BzrBranchFormat7()
2388
2346
__format8 = BzrBranchFormat8()
2389
format_registry.register(__format5)
2390
format_registry.register(BranchReferenceFormat())
2391
format_registry.register(__format6)
2392
format_registry.register(__format7)
2393
format_registry.register(__format8)
2394
format_registry.set_default(__format7)
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__)
2397
2359
class BranchWriteLockResult(LogicalLockResult):
2545
2507
"""See Branch.print_file."""
2546
2508
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)
2548
2573
@needs_write_lock
2549
2574
def set_last_revision_info(self, revno, revision_id):
2550
if not revision_id or not isinstance(revision_id, basestring):
2551
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
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
2552
2585
revision_id = _mod_revision.ensure_null(revision_id)
2553
old_revno, old_revid = self.last_revision_info()
2554
if self.get_append_revisions_only():
2555
self._check_history_violation(revision_id)
2556
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2557
self._write_last_revision_info(revno, revision_id)
2558
self._clear_cached_state()
2559
self._last_revision_info_cache = revno, revision_id
2560
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
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))
2562
2615
def basis_tree(self):
2563
2616
"""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()
2575
2650
def get_stacked_on_url(self):
2576
2651
raise errors.UnstackableBranchFormat(self._format, self.user_url)
2588
2663
self._transport.put_bytes('parent', url + '\n',
2589
2664
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(
2591
2700
@needs_write_lock
2593
"""If bound, unbind"""
2594
return self.set_bound_location(None)
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:
2596
2716
@needs_write_lock
2597
2717
def bind(self, other):
2619
2739
# history around
2620
2740
self.set_bound_location(other.base)
2622
def get_bound_location(self):
2624
return self._transport.get_bytes('bound')[:-1]
2625
except errors.NoSuchFile:
2629
def get_master_branch(self, possible_transports=None):
2630
"""Return the branch we are bound to.
2632
:return: Either a Branch, or None
2634
if self._master_branch_cache is None:
2635
self._master_branch_cache = self._get_master_branch(
2636
possible_transports)
2637
return self._master_branch_cache
2639
def _get_master_branch(self, possible_transports):
2640
bound_loc = self.get_bound_location()
2644
return Branch.open(bound_loc,
2645
possible_transports=possible_transports)
2646
except (errors.NotBranchError, errors.ConnectionError), e:
2647
raise errors.BoundBranchConnectionFailure(
2650
2742
@needs_write_lock
2651
def set_bound_location(self, location):
2652
"""Set the target where this branch is bound to.
2654
:param location: URL to the target branch
2656
self._master_branch_cache = None
2658
self._transport.put_bytes('bound', location+'\n',
2659
mode=self.bzrdir._get_file_mode())
2662
self._transport.delete('bound')
2663
except errors.NoSuchFile:
2744
"""If bound, unbind"""
2745
return self.set_bound_location(None)
2667
2747
@needs_write_lock
2668
2748
def update(self, possible_transports=None):
2684
def _read_last_revision_info(self):
2685
revision_string = self._transport.get_bytes('last-revision')
2686
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2687
revision_id = cache_utf8.get_cached_utf8(revision_id)
2689
return revno, revision_id
2691
def _write_last_revision_info(self, revno, revision_id):
2692
"""Simply write out the revision id, with no checks.
2694
Use set_last_revision_info to perform this safely.
2696
Does not update the revision_history cache.
2698
revision_id = _mod_revision.ensure_null(revision_id)
2699
out_string = '%d %s\n' % (revno, revision_id)
2700
self._transport.put_bytes('last-revision', out_string,
2701
mode=self.bzrdir._get_file_mode())
2704
class FullHistoryBzrBranch(BzrBranch):
2705
"""Bzr branch which contains the full revision history."""
2708
def set_last_revision_info(self, revno, revision_id):
2709
if not revision_id or not isinstance(revision_id, basestring):
2710
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2711
revision_id = _mod_revision.ensure_null(revision_id)
2712
# this old format stores the full history, but this api doesn't
2713
# provide it, so we must generate, and might as well check it's
2715
history = self._lefthand_history(revision_id)
2716
if len(history) != revno:
2717
raise AssertionError('%d != %d' % (len(history), revno))
2718
self._set_revision_history(history)
2720
def _read_last_revision_info(self):
2721
rh = self._revision_history()
2724
return (revno, rh[-1])
2726
return (0, _mod_revision.NULL_REVISION)
2728
@deprecated_method(deprecated_in((2, 4, 0)))
2730
def set_revision_history(self, rev_history):
2731
"""See Branch.set_revision_history."""
2732
self._set_revision_history(rev_history)
2734
def _set_revision_history(self, rev_history):
2735
if 'evil' in debug.debug_flags:
2736
mutter_callsite(3, "set_revision_history scales with history.")
2737
check_not_reserved_id = _mod_revision.check_not_reserved_id
2738
for rev_id in rev_history:
2739
check_not_reserved_id(rev_id)
2740
if Branch.hooks['post_change_branch_tip']:
2741
# Don't calculate the last_revision_info() if there are no hooks
2743
old_revno, old_revid = self.last_revision_info()
2744
if len(rev_history) == 0:
2745
revid = _mod_revision.NULL_REVISION
2747
revid = rev_history[-1]
2748
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2749
self._write_revision_history(rev_history)
2750
self._clear_cached_state()
2751
self._cache_revision_history(rev_history)
2752
for hook in Branch.hooks['set_rh']:
2753
hook(self, rev_history)
2754
if Branch.hooks['post_change_branch_tip']:
2755
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2757
def _write_revision_history(self, history):
2758
"""Factored out of set_revision_history.
2760
This performs the actual writing to disk.
2761
It is intended to be called by set_revision_history."""
2762
self._transport.put_bytes(
2763
'revision-history', '\n'.join(history),
2764
mode=self.bzrdir._get_file_mode())
2766
def _gen_revision_history(self):
2767
history = self._transport.get_bytes('revision-history').split('\n')
2768
if history[-1:] == ['']:
2769
# There shouldn't be a trailing newline, but just in case.
2773
def _synchronize_history(self, destination, revision_id):
2774
if not isinstance(destination, FullHistoryBzrBranch):
2775
super(BzrBranch, self)._synchronize_history(
2776
destination, revision_id)
2778
if revision_id == _mod_revision.NULL_REVISION:
2781
new_history = self._revision_history()
2782
if revision_id is not None and new_history != []:
2784
new_history = new_history[:new_history.index(revision_id) + 1]
2786
rev = self.repository.get_revision(revision_id)
2787
new_history = rev.get_history(self.repository)[1:]
2788
destination._set_revision_history(new_history)
2791
def generate_revision_history(self, revision_id, last_rev=None,
2793
"""Create a new revision history that will finish with revision_id.
2795
:param revision_id: the new tip to use.
2796
:param last_rev: The previous last_revision. If not None, then this
2797
must be a ancestory of revision_id, or DivergedBranches is raised.
2798
:param other_branch: The other branch that DivergedBranches should
2799
raise with respect to.
2801
self._set_revision_history(self._lefthand_history(revision_id,
2802
last_rev, other_branch))
2805
class BzrBranch5(FullHistoryBzrBranch):
2806
"""A format 5 branch. This supports new features over plain branches.
2808
It has support for a master_branch which is the data for bound branches.
2812
class BzrBranch8(BzrBranch):
2765
class BzrBranch8(BzrBranch5):
2813
2766
"""A branch that stores tree-reference locations."""
2815
2768
def _open_hook(self):
2841
2794
self._last_revision_info_cache = None
2842
2795
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)
2844
2842
def _check_history_violation(self, revision_id):
2845
current_revid = self.last_revision()
2846
last_revision = _mod_revision.ensure_null(current_revid)
2843
last_revision = _mod_revision.ensure_null(self.last_revision())
2847
2844
if _mod_revision.is_null(last_revision):
2849
graph = self.repository.get_graph()
2850
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2851
if lh_ancestor == current_revid:
2853
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2846
if last_revision not in self._lefthand_history(revision_id):
2847
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2855
2849
def _gen_revision_history(self):
2856
2850
"""Generate the revision history from last revision
2987
2996
# you can always ask for the URL; but you might not be able to use it
2988
2997
# if the repo can't support stacking.
2989
2998
## self._check_stackable_repo()
2990
# stacked_on_location is only ever defined in branch.conf, so don't
2991
# waste effort reading the whole stack of config files.
2992
config = self.get_config()._get_branch_data_config()
2993
stacked_url = self._get_config_location('stacked_on_location',
2999
stacked_url = self._get_config_location('stacked_on_location')
2995
3000
if stacked_url is None:
2996
3001
raise errors.NotStacked(self)
2997
3002
return stacked_url
3004
def _get_append_revisions_only(self):
3005
return self.get_config(
3006
).get_user_option_as_bool('append_revisions_only')
3009
def generate_revision_history(self, revision_id, last_rev=None,
3011
"""See BzrBranch5.generate_revision_history"""
3012
history = self._lefthand_history(revision_id, last_rev, other_branch)
3013
revno = len(history)
3014
self.set_last_revision_info(revno, revision_id)
2999
3016
@needs_read_lock
3000
3017
def get_rev_id(self, revno, history=None):
3001
3018
"""Find the revision id of the specified revno."""
3087
3101
:ivar local_branch: target branch if there is a Master, else None
3088
3102
:ivar target_branch: Target/destination branch object. (write locked)
3089
3103
:ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3090
:ivar tag_updates: A dict with new tags, see BasicTags.merge_to
3093
@deprecated_method(deprecated_in((2, 3, 0)))
3094
3106
def __int__(self):
3095
"""Return the relative change in revno.
3097
:deprecated: Use `new_revno` and `old_revno` instead.
3107
# DEPRECATED: pull used to return the change in revno
3099
3108
return self.new_revno - self.old_revno
3101
3110
def report(self, to_file):
3102
tag_conflicts = getattr(self, "tag_conflicts", None)
3103
tag_updates = getattr(self, "tag_updates", None)
3104
3111
if not is_quiet():
3105
if self.old_revid != self.new_revid:
3112
if self.old_revid == self.new_revid:
3113
to_file.write('No revisions to pull.\n')
3106
3115
to_file.write('Now on revision %d.\n' % self.new_revno)
3108
to_file.write('%d tag(s) updated.\n' % len(tag_updates))
3109
if self.old_revid == self.new_revid and not tag_updates:
3110
if not tag_conflicts:
3111
to_file.write('No revisions or tags to pull.\n')
3113
to_file.write('No revisions to pull.\n')
3114
3116
self._show_tag_conficts(to_file)
3133
3135
target, otherwise it will be None.
3136
@deprecated_method(deprecated_in((2, 3, 0)))
3137
3138
def __int__(self):
3138
"""Return the relative change in revno.
3140
:deprecated: Use `new_revno` and `old_revno` instead.
3139
# DEPRECATED: push used to return the change in revno
3142
3140
return self.new_revno - self.old_revno
3144
3142
def report(self, to_file):
3145
# TODO: This function gets passed a to_file, but then
3146
# ignores it and calls note() instead. This is also
3147
# inconsistent with PullResult(), which writes to stdout.
3148
# -- JRV20110901, bug #838853
3149
tag_conflicts = getattr(self, "tag_conflicts", None)
3150
tag_updates = getattr(self, "tag_updates", None)
3152
if self.old_revid != self.new_revid:
3153
note(gettext('Pushed up to revision %d.') % self.new_revno)
3155
note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
3156
if self.old_revid == self.new_revid and not tag_updates:
3157
if not tag_conflicts:
3158
note(gettext('No new revisions or tags to push.'))
3160
note(gettext('No new revisions to push.'))
3143
"""Write a human-readable description of the result."""
3144
if self.old_revid == self.new_revid:
3145
note('No new revisions to push.')
3147
note('Pushed up to revision %d.' % self.new_revno)
3161
3148
self._show_tag_conficts(to_file)
3234
3221
branch._transport.put_bytes('format', format.get_format_string())
3224
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3225
"""Run ``callable(*args, **kwargs)``, write-locking target for the
3228
_run_with_write_locked_target will attempt to release the lock it acquires.
3230
If an exception is raised by callable, then that exception *will* be
3231
propagated, even if the unlock attempt raises its own error. Thus
3232
_run_with_write_locked_target should be preferred to simply doing::
3236
return callable(*args, **kwargs)
3241
# This is very similar to bzrlib.decorators.needs_write_lock. Perhaps they
3242
# should share code?
3245
result = callable(*args, **kwargs)
3247
exc_info = sys.exc_info()
3251
raise exc_info[0], exc_info[1], exc_info[2]
3237
3257
class InterBranch(InterObject):
3238
3258
"""This class represents operations taking place between two branches.
3267
3287
raise NotImplementedError(self.pull)
3269
3289
@needs_write_lock
3270
def push(self, overwrite=False, stop_revision=None, lossy=False,
3290
def update_revisions(self, stop_revision=None, overwrite=False,
3292
"""Pull in new perfect-fit revisions.
3294
:param stop_revision: Updated until the given revision
3295
:param overwrite: Always set the branch pointer, rather than checking
3296
to see if it is a proper descendant.
3297
:param graph: A Graph object that can be used to query history
3298
information. This can be None.
3301
raise NotImplementedError(self.update_revisions)
3304
def push(self, overwrite=False, stop_revision=None,
3271
3305
_override_hook_source_branch=None):
3272
3306
"""Mirror the source branch into the target branch.
3333
3358
self.source.tags.merge_to(self.target.tags)
3335
3360
@needs_write_lock
3336
def fetch(self, stop_revision=None, limit=None):
3337
if self.target.base == self.source.base:
3339
self.source.lock_read()
3341
fetch_spec_factory = fetch.FetchSpecFactory()
3342
fetch_spec_factory.source_branch = self.source
3343
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3344
fetch_spec_factory.source_repo = self.source.repository
3345
fetch_spec_factory.target_repo = self.target.repository
3346
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3347
fetch_spec_factory.limit = limit
3348
fetch_spec = fetch_spec_factory.make_fetch_spec()
3349
return self.target.repository.fetch(self.source.repository,
3350
fetch_spec=fetch_spec)
3352
self.source.unlock()
3355
def _update_revisions(self, stop_revision=None, overwrite=False,
3361
def update_revisions(self, stop_revision=None, overwrite=False,
3363
"""See InterBranch.update_revisions()."""
3357
3364
other_revno, other_last_revision = self.source.last_revision_info()
3358
3365
stop_revno = None # unknown
3359
3366
if stop_revision is None:
3426
3423
return self._pull(overwrite,
3427
3424
stop_revision, _hook_master=master_branch,
3428
3425
run_hooks=run_hooks,
3429
_override_hook_target=_override_hook_target,
3430
merge_tags_to_master=not source_is_master)
3426
_override_hook_target=_override_hook_target)
3432
3428
if master_branch:
3433
3429
master_branch.unlock()
3435
def push(self, overwrite=False, stop_revision=None, lossy=False,
3431
def push(self, overwrite=False, stop_revision=None,
3436
3432
_override_hook_source_branch=None):
3437
3433
"""See InterBranch.push.
3439
3435
This is the basic concrete implementation of push()
3441
:param _override_hook_source_branch: If specified, run the hooks
3442
passing this Branch as the source, rather than self. This is for
3443
use of RemoteBranch, where push is delegated to the underlying
3437
:param _override_hook_source_branch: If specified, run
3438
the hooks passing this Branch as the source, rather than self.
3439
This is for use of RemoteBranch, where push is delegated to the
3440
underlying vfs-based Branch.
3447
raise errors.LossyPushToSameVCS(self.source, self.target)
3448
3442
# TODO: Public option to disable running hooks - should be trivial but
3451
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3452
op.add_cleanup(self.source.lock_read().unlock)
3453
op.add_cleanup(self.target.lock_write().unlock)
3454
return op.run(overwrite, stop_revision,
3455
_override_hook_source_branch=_override_hook_source_branch)
3457
def _basic_push(self, overwrite, stop_revision):
3458
"""Basic implementation of push without bound branches or hooks.
3460
Must be called with source read locked and target write locked.
3462
result = BranchPushResult()
3463
result.source_branch = self.source
3464
result.target_branch = self.target
3465
result.old_revno, result.old_revid = self.target.last_revision_info()
3466
self.source.update_references(self.target)
3467
if result.old_revid != stop_revision:
3468
# We assume that during 'push' this repository is closer than
3470
graph = self.source.repository.get_graph(self.target.repository)
3471
self._update_revisions(stop_revision, overwrite=overwrite,
3473
if self.source._push_should_merge_tags():
3474
result.tag_updates, result.tag_conflicts = (
3475
self.source.tags.merge_to(self.target.tags, overwrite))
3476
result.new_revno, result.new_revid = self.target.last_revision_info()
3479
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3444
self.source.lock_read()
3446
return _run_with_write_locked_target(
3447
self.target, self._push_with_bound_branches, overwrite,
3449
_override_hook_source_branch=_override_hook_source_branch)
3451
self.source.unlock()
3453
def _push_with_bound_branches(self, overwrite, stop_revision,
3480
3454
_override_hook_source_branch=None):
3481
3455
"""Push from source into target, and into target's master if any.
3494
3468
# be bound to itself? -- mbp 20070507
3495
3469
master_branch = self.target.get_master_branch()
3496
3470
master_branch.lock_write()
3497
operation.add_cleanup(master_branch.unlock)
3498
# push into the master from the source branch.
3499
master_inter = InterBranch.get(self.source, master_branch)
3500
master_inter._basic_push(overwrite, stop_revision)
3501
# and push into the target branch from the source. Note that
3502
# we push from the source branch again, because it's considered
3503
# the highest bandwidth repository.
3504
result = self._basic_push(overwrite, stop_revision)
3505
result.master_branch = master_branch
3506
result.local_branch = self.target
3472
# push into the master from the source branch.
3473
self.source._basic_push(master_branch, overwrite, stop_revision)
3474
# and push into the target branch from the source. Note that we
3475
# push from the source branch again, because its considered the
3476
# highest bandwidth repository.
3477
result = self.source._basic_push(self.target, overwrite,
3479
result.master_branch = master_branch
3480
result.local_branch = self.target
3484
master_branch.unlock()
3508
master_branch = None
3509
3486
# no master branch
3510
result = self._basic_push(overwrite, stop_revision)
3487
result = self.source._basic_push(self.target, overwrite,
3511
3489
# TODO: Why set master_branch and local_branch if there's no
3512
3490
# binding? Maybe cleaner to just leave them unset? -- mbp
3514
3492
result.master_branch = self.target
3515
3493
result.local_branch = None
3519
3497
def _pull(self, overwrite=False, stop_revision=None,
3520
3498
possible_transports=None, _hook_master=None, run_hooks=True,
3521
_override_hook_target=None, local=False,
3522
merge_tags_to_master=True):
3499
_override_hook_target=None, local=False):
3523
3500
"""See Branch.pull.
3525
3502
This function is the core worker, used by GenericInterBranch.pull to
3556
3531
# -- JRV20090506
3557
3532
result.old_revno, result.old_revid = \
3558
3533
self.target.last_revision_info()
3559
self._update_revisions(stop_revision, overwrite=overwrite,
3534
self.target.update_revisions(self.source, stop_revision,
3535
overwrite=overwrite, graph=graph)
3561
3536
# TODO: The old revid should be specified when merging tags,
3562
3537
# so a tags implementation that versions tags can only
3563
3538
# pull in the most recent changes. -- JRV20090506
3564
result.tag_updates, result.tag_conflicts = (
3565
self.source.tags.merge_to(self.target.tags, overwrite,
3566
ignore_master=not merge_tags_to_master))
3539
result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3567
3541
result.new_revno, result.new_revid = self.target.last_revision_info()
3568
3542
if _hook_master:
3569
3543
result.master_branch = _hook_master
added
removed
bzrlib/branch.py
