71
58
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
74
class Branch(controldir.ControlComponent):
61
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
62
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
66
# TODO: Maybe include checks for common corruption of newlines, etc?
68
# TODO: Some operations like log might retrieve the same revisions
69
# repeatedly to calculate deltas. We could perhaps have a weakref
70
# cache in memory to make this faster. In general anything can be
71
# cached in memory between lock and unlock operations. .. nb thats
72
# what the transaction identity map provides
75
######################################################################
75
79
"""Branch holding a history of revisions.
78
Base directory/url of the branch; using control_url and
79
control_transport is more standardized.
80
:ivar hooks: An instance of BranchHooks.
81
:ivar _master_branch_cache: cached result of get_master_branch, see
82
Base directory/url of the branch.
84
hooks: An instance of BranchHooks.
84
86
# this is really an instance variable - FIXME move it there
89
def control_transport(self):
90
return self._transport
93
def user_transport(self):
94
return self.bzrdir.user_transport
96
def __init__(self, possible_transports=None):
90
def __init__(self, *ignored, **ignored_too):
97
91
self.tags = self._format.make_tags(self)
98
92
self._revision_history_cache = None
99
93
self._revision_id_to_revno_cache = None
100
94
self._partial_revision_id_to_revno_cache = {}
101
95
self._partial_revision_history_cache = []
102
self._tags_bytes = None
103
96
self._last_revision_info_cache = None
104
self._master_branch_cache = None
105
97
self._merge_sorted_revisions_cache = None
106
self._open_hook(possible_transports)
107
99
hooks = Branch.hooks['open']
108
100
for hook in hooks:
111
def _open_hook(self, possible_transports):
103
def _open_hook(self):
112
104
"""Called by init to allow simpler extension of the base class."""
114
def _activate_fallback_location(self, url, possible_transports):
106
def _activate_fallback_location(self, url):
115
107
"""Activate the branch/repository from url as a fallback repository."""
116
for existing_fallback_repo in self.repository._fallback_repositories:
117
if existing_fallback_repo.user_url == url:
118
# This fallback is already configured. This probably only
119
# happens because ControlDir.sprout is a horrible mess. To avoid
120
# confusing _unstack we don't add this a second time.
121
mutter('duplicate activation of fallback %r on %r', url, self)
123
repo = self._get_fallback_repository(url, possible_transports)
108
repo = self._get_fallback_repository(url)
124
109
if repo.has_same_location(self.repository):
125
raise errors.UnstackableLocationError(self.user_url, url)
110
raise errors.UnstackableLocationError(self.base, url)
126
111
self.repository.add_fallback_repository(repo)
128
113
def break_lock(self):
526
468
rev_iter = iter(merge_sorted_revisions)
527
469
if start_revision_id is not None:
528
470
for node in rev_iter:
471
rev_id = node.key[-1]
530
472
if rev_id != start_revision_id:
533
475
# The decision to include the start or not
534
476
# depends on the stop_rule if a stop is provided
535
477
# so pop this node back into the iterator
536
rev_iter = itertools.chain(iter([node]), rev_iter)
478
rev_iter = chain(iter([node]), rev_iter)
538
480
if stop_revision_id is None:
539
481
# Yield everything
540
482
for node in rev_iter:
483
rev_id = node.key[-1]
542
484
yield (rev_id, node.merge_depth, node.revno,
543
485
node.end_of_merge)
544
486
elif stop_rule == 'exclude':
545
487
for node in rev_iter:
488
rev_id = node.key[-1]
547
489
if rev_id == stop_revision_id:
549
491
yield (rev_id, node.merge_depth, node.revno,
550
492
node.end_of_merge)
551
493
elif stop_rule == 'include':
552
494
for node in rev_iter:
495
rev_id = node.key[-1]
554
496
yield (rev_id, node.merge_depth, node.revno,
555
497
node.end_of_merge)
556
498
if rev_id == stop_revision_id:
558
elif stop_rule == 'with-merges-without-common-ancestry':
559
# We want to exclude all revisions that are already part of the
560
# stop_revision_id ancestry.
561
graph = self.repository.get_graph()
562
ancestors = graph.find_unique_ancestors(start_revision_id,
564
for node in rev_iter:
566
if rev_id not in ancestors:
568
yield (rev_id, node.merge_depth, node.revno,
570
500
elif stop_rule == 'with-merges':
571
501
stop_rev = self.repository.get_revision(stop_revision_id)
572
502
if stop_rev.parent_ids:
573
503
left_parent = stop_rev.parent_ids[0]
575
505
left_parent = _mod_revision.NULL_REVISION
576
# left_parent is the actual revision we want to stop logging at,
577
# since we want to show the merged revisions after the stop_rev too
578
reached_stop_revision_id = False
579
revision_id_whitelist = []
580
506
for node in rev_iter:
507
rev_id = node.key[-1]
582
508
if rev_id == left_parent:
583
# reached the left parent after the stop_revision
585
if (not reached_stop_revision_id or
586
rev_id in revision_id_whitelist):
587
yield (rev_id, node.merge_depth, node.revno,
510
yield (rev_id, node.merge_depth, node.revno,
588
511
node.end_of_merge)
589
if reached_stop_revision_id or rev_id == stop_revision_id:
590
# only do the merged revs of rev_id from now on
591
rev = self.repository.get_revision(rev_id)
593
reached_stop_revision_id = True
594
revision_id_whitelist.extend(rev.parent_ids)
596
513
raise ValueError('invalid stop_rule %r' % stop_rule)
598
def _filter_start_non_ancestors(self, rev_iter):
599
# If we started from a dotted revno, we want to consider it as a tip
600
# and don't want to yield revisions that are not part of its
601
# ancestry. Given the order guaranteed by the merge sort, we will see
602
# uninteresting descendants of the first parent of our tip before the
604
first = rev_iter.next()
605
(rev_id, merge_depth, revno, end_of_merge) = first
608
# We start at a mainline revision so by definition, all others
609
# revisions in rev_iter are ancestors
610
for node in rev_iter:
615
pmap = self.repository.get_parent_map([rev_id])
616
parents = pmap.get(rev_id, [])
618
whitelist.update(parents)
620
# If there is no parents, there is nothing of interest left
622
# FIXME: It's hard to test this scenario here as this code is never
623
# called in that case. -- vila 20100322
626
for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
628
if rev_id in whitelist:
629
pmap = self.repository.get_parent_map([rev_id])
630
parents = pmap.get(rev_id, [])
631
whitelist.remove(rev_id)
632
whitelist.update(parents)
634
# We've reached the mainline, there is nothing left to
638
# A revision that is not part of the ancestry of our
641
yield (rev_id, merge_depth, revno, end_of_merge)
643
515
def leave_lock_in_place(self):
644
516
"""Tell this branch object not to release the physical lock when this
645
517
object is unlocked.
878
711
old_repository = self.repository
879
712
if len(old_repository._fallback_repositories) != 1:
880
713
raise AssertionError("can't cope with fallback repositories "
881
"of %r (fallbacks: %r)" % (old_repository,
882
old_repository._fallback_repositories))
883
# Open the new repository object.
884
# Repositories don't offer an interface to remove fallback
885
# repositories today; take the conceptually simpler option and just
886
# reopen it. We reopen it starting from the URL so that we
887
# get a separate connection for RemoteRepositories and can
888
# stream from one of them to the other. This does mean doing
889
# separate SSH connection setup, but unstacking is not a
890
# common operation so it's tolerable.
891
new_bzrdir = controldir.ControlDir.open(
892
self.bzrdir.root_transport.base)
893
new_repository = new_bzrdir.find_repository()
894
if new_repository._fallback_repositories:
895
raise AssertionError("didn't expect %r to have "
896
"fallback_repositories"
897
% (self.repository,))
898
# Replace self.repository with the new repository.
899
# Do our best to transfer the lock state (i.e. lock-tokens and
900
# lock count) of self.repository to the new repository.
901
lock_token = old_repository.lock_write().repository_token
902
self.repository = new_repository
903
if isinstance(self, remote.RemoteBranch):
904
# Remote branches can have a second reference to the old
905
# repository that need to be replaced.
906
if self._real_branch is not None:
907
self._real_branch.repository = new_repository
908
self.repository.lock_write(token=lock_token)
909
if lock_token is not None:
910
old_repository.leave_lock_in_place()
714
"of %r" % (self.repository,))
715
# unlock it, including unlocking the fallback
911
716
old_repository.unlock()
912
if lock_token is not None:
913
# XXX: self.repository.leave_lock_in_place() before this
914
# function will not be preserved. Fortunately that doesn't
915
# affect the current default format (2a), and would be a
916
# corner-case anyway.
917
# - Andrew Bennetts, 2010/06/30
918
self.repository.dont_leave_lock_in_place()
922
old_repository.unlock()
923
except errors.LockNotHeld:
926
if old_lock_count == 0:
927
raise AssertionError(
928
'old_repository should have been locked at least once.')
929
for i in range(old_lock_count-1):
717
old_repository.lock_read()
719
# Repositories don't offer an interface to remove fallback
720
# repositories today; take the conceptually simpler option and just
721
# reopen it. We reopen it starting from the URL so that we
722
# get a separate connection for RemoteRepositories and can
723
# stream from one of them to the other. This does mean doing
724
# separate SSH connection setup, but unstacking is not a
725
# common operation so it's tolerable.
726
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
727
new_repository = new_bzrdir.find_repository()
728
self.repository = new_repository
729
if self.repository._fallback_repositories:
730
raise AssertionError("didn't expect %r to have "
731
"fallback_repositories"
732
% (self.repository,))
733
# this is not paired with an unlock because it's just restoring
734
# the previous state; the lock's released when set_stacked_on_url
930
736
self.repository.lock_write()
931
# Fetch from the old repository into the new.
932
old_repository.lock_read()
934
737
# XXX: If you unstack a branch while it has a working tree
935
738
# with a pending merge, the pending-merged revisions will no
936
739
# longer be present. You can (probably) revert and remerge.
938
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
939
except errors.TagsNotSupported:
940
tags_to_fetch = set()
941
fetch_spec = vf_search.NotInOtherForRevs(self.repository,
942
old_repository, required_ids=[self.last_revision()],
943
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
944
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
741
# XXX: This only fetches up to the tip of the repository; it
742
# doesn't bring across any tags. That's fairly consistent
743
# with how branch works, but perhaps not ideal.
744
self.repository.fetch(old_repository,
745
revision_id=self.last_revision(),
946
748
old_repository.unlock()
1055
846
:return: A tuple (revno, revision_id).
1057
848
if self._last_revision_info_cache is None:
1058
self._last_revision_info_cache = self._read_last_revision_info()
849
self._last_revision_info_cache = self._last_revision_info()
1059
850
return self._last_revision_info_cache
1061
def _read_last_revision_info(self):
1062
raise NotImplementedError(self._read_last_revision_info)
1064
@deprecated_method(deprecated_in((2, 4, 0)))
852
def _last_revision_info(self):
853
rh = self.revision_history()
856
return (revno, rh[-1])
858
return (0, _mod_revision.NULL_REVISION)
860
@deprecated_method(deprecated_in((1, 6, 0)))
861
def missing_revisions(self, other, stop_revision=None):
862
"""Return a list of new revisions that would perfectly fit.
864
If self and other have not diverged, return a list of the revisions
865
present in other, but missing from self.
867
self_history = self.revision_history()
868
self_len = len(self_history)
869
other_history = other.revision_history()
870
other_len = len(other_history)
871
common_index = min(self_len, other_len) -1
872
if common_index >= 0 and \
873
self_history[common_index] != other_history[common_index]:
874
raise errors.DivergedBranches(self, other)
876
if stop_revision is None:
877
stop_revision = other_len
879
if stop_revision > other_len:
880
raise errors.NoSuchRevision(self, stop_revision)
881
return other_history[self_len:stop_revision]
884
def update_revisions(self, other, stop_revision=None, overwrite=False,
886
"""Pull in new perfect-fit revisions.
888
:param other: Another Branch to pull from
889
:param stop_revision: Updated until the given revision
890
:param overwrite: Always set the branch pointer, rather than checking
891
to see if it is a proper descendant.
892
:param graph: A Graph object that can be used to query history
893
information. This can be None.
896
return InterBranch.get(other, self).update_revisions(stop_revision,
1065
899
def import_last_revision_info(self, source_repo, revno, revid):
1066
900
"""Set the last revision info, importing from another repo if necessary.
902
This is used by the bound branch code to upload a revision to
903
the master branch first before updating the tip of the local branch.
1068
905
:param source_repo: Source repository to optionally fetch from
1069
906
:param revno: Revision number of the new tip
1070
907
:param revid: Revision id of the new tip
1607
1429
return not (self == other)
1610
@deprecated_method(deprecated_in((2, 4, 0)))
1432
def find_format(klass, a_bzrdir):
1433
"""Return the format for the branch object in a_bzrdir."""
1435
transport = a_bzrdir.get_branch_transport(None)
1436
format_string = transport.get_bytes("format")
1437
return klass._formats[format_string]
1438
except errors.NoSuchFile:
1439
raise errors.NotBranchError(path=transport.base)
1441
raise errors.UnknownFormatError(format=format_string, kind='branch')
1611
1444
def get_default_format(klass):
1612
1445
"""Return the current default format."""
1613
return format_registry.get_default()
1616
@deprecated_method(deprecated_in((2, 4, 0)))
1617
def get_formats(klass):
1618
"""Get all the known formats.
1620
Warning: This triggers a load of all lazy registered formats: do not
1621
use except when that is desireed.
1623
return format_registry._get_all()
1625
def get_reference(self, controldir, name=None):
1626
"""Get the target reference of the branch in controldir.
1446
return klass._default_format
1448
def get_reference(self, a_bzrdir):
1449
"""Get the target reference of the branch in a_bzrdir.
1628
1451
format probing must have been completed before calling
1629
1452
this method - it is assumed that the format of the branch
1630
in controldir is correct.
1453
in a_bzrdir is correct.
1632
:param controldir: The controldir to get the branch data from.
1633
:param name: Name of the colocated branch to fetch
1455
:param a_bzrdir: The bzrdir to get the branch data from.
1634
1456
:return: None if the branch is not a reference branch.
1639
def set_reference(self, controldir, name, to_branch):
1640
"""Set the target reference of the branch in controldir.
1461
def set_reference(self, a_bzrdir, to_branch):
1462
"""Set the target reference of the branch in a_bzrdir.
1642
1464
format probing must have been completed before calling
1643
1465
this method - it is assumed that the format of the branch
1644
in controldir is correct.
1466
in a_bzrdir is correct.
1646
:param controldir: The controldir to set the branch reference for.
1647
:param name: Name of colocated branch to set, None for default
1468
:param a_bzrdir: The bzrdir to set the branch reference for.
1648
1469
:param to_branch: branch that the checkout is to reference
1650
1471
raise NotImplementedError(self.set_reference)
1473
def get_format_string(self):
1474
"""Return the ASCII format string that identifies this format."""
1475
raise NotImplementedError(self.get_format_string)
1652
1477
def get_format_description(self):
1653
1478
"""Return the short format description for this format."""
1654
1479
raise NotImplementedError(self.get_format_description)
1656
def _run_post_branch_init_hooks(self, controldir, name, branch):
1657
hooks = Branch.hooks['post_branch_init']
1660
params = BranchInitHookParams(self, controldir, name, branch)
1664
def initialize(self, controldir, name=None, repository=None,
1665
append_revisions_only=None):
1666
"""Create a branch of this format in controldir.
1668
:param name: Name of the colocated branch to create.
1481
def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1483
"""Initialize a branch in a bzrdir, with specified files
1485
:param a_bzrdir: The bzrdir to initialize the branch in
1486
:param utf8_files: The files to create as a list of
1487
(filename, content) tuples
1488
:param set_format: If True, set the format with
1489
self.get_format_string. (BzrBranch4 has its format set
1491
:return: a branch in this format
1493
mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1494
branch_transport = a_bzrdir.get_branch_transport(self)
1496
'metadir': ('lock', lockdir.LockDir),
1497
'branch4': ('branch-lock', lockable_files.TransportLock),
1499
lock_name, lock_class = lock_map[lock_type]
1500
control_files = lockable_files.LockableFiles(branch_transport,
1501
lock_name, lock_class)
1502
control_files.create_lock()
1504
control_files.lock_write()
1505
except errors.LockContention:
1506
if lock_type != 'branch4':
1512
utf8_files += [('format', self.get_format_string())]
1514
for (filename, content) in utf8_files:
1515
branch_transport.put_bytes(
1517
mode=a_bzrdir._get_file_mode())
1520
control_files.unlock()
1521
return self.open(a_bzrdir, _found=True)
1523
def initialize(self, a_bzrdir):
1524
"""Create a branch of this format in a_bzrdir."""
1670
1525
raise NotImplementedError(self.initialize)
1672
1527
def is_supported(self):
1831
1640
"basis revision. hooks MUST NOT modify this delta. "
1832
1641
" future_tree is an in-memory tree obtained from "
1833
1642
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1835
self.add_hook('post_commit',
1643
"tree.", (0,91), None))
1644
self.create_hook(HookPoint('post_commit',
1836
1645
"Called in the bzr client after a commit has completed. "
1837
1646
"post_commit is called with (local, master, old_revno, old_revid, "
1838
1647
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1839
"commit to a branch.", (0, 15))
1840
self.add_hook('post_uncommit',
1648
"commit to a branch.", (0, 15), None))
1649
self.create_hook(HookPoint('post_uncommit',
1841
1650
"Called in the bzr client after an uncommit completes. "
1842
1651
"post_uncommit is called with (local, master, old_revno, "
1843
1652
"old_revid, new_revno, new_revid) where local is the local branch "
1844
1653
"or None, master is the target branch, and an empty branch "
1845
"receives new_revno of 0, new_revid of None.", (0, 15))
1846
self.add_hook('pre_change_branch_tip',
1654
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1655
self.create_hook(HookPoint('pre_change_branch_tip',
1847
1656
"Called in bzr client and server before a change to the tip of a "
1848
1657
"branch is made. pre_change_branch_tip is called with a "
1849
1658
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1850
"commit, uncommit will all trigger this hook.", (1, 6))
1851
self.add_hook('post_change_branch_tip',
1659
"commit, uncommit will all trigger this hook.", (1, 6), None))
1660
self.create_hook(HookPoint('post_change_branch_tip',
1852
1661
"Called in bzr client and server after a change to the tip of a "
1853
1662
"branch is made. post_change_branch_tip is called with a "
1854
1663
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1855
"commit, uncommit will all trigger this hook.", (1, 4))
1856
self.add_hook('transform_fallback_location',
1664
"commit, uncommit will all trigger this hook.", (1, 4), None))
1665
self.create_hook(HookPoint('transform_fallback_location',
1857
1666
"Called when a stacked branch is activating its fallback "
1858
1667
"locations. transform_fallback_location is called with (branch, "
1859
1668
"url), and should return a new url. Returning the same url "
1926
1718
self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1929
class BranchInitHookParams(object):
1930
"""Object holding parameters passed to `*_branch_init` hooks.
1932
There are 4 fields that hooks may wish to access:
1934
:ivar format: the branch format
1935
:ivar bzrdir: the ControlDir where the branch will be/has been initialized
1936
:ivar name: name of colocated branch, if any (or None)
1937
:ivar branch: the branch created
1939
Note that for lightweight checkouts, the bzrdir and format fields refer to
1940
the checkout, hence they are different from the corresponding fields in
1941
branch, which refer to the original branch.
1944
def __init__(self, format, controldir, name, branch):
1945
"""Create a group of BranchInitHook parameters.
1947
:param format: the branch format
1948
:param controldir: the ControlDir where the branch will be/has been
1950
:param name: name of colocated branch, if any (or None)
1951
:param branch: the branch created
1953
Note that for lightweight checkouts, the bzrdir and format fields refer
1954
to the checkout, hence they are different from the corresponding fields
1955
in branch, which refer to the original branch.
1957
self.format = format
1958
self.bzrdir = controldir
1960
self.branch = branch
1962
def __eq__(self, other):
1963
return self.__dict__ == other.__dict__
1966
return "<%s of %s>" % (self.__class__.__name__, self.branch)
1969
class SwitchHookParams(object):
1970
"""Object holding parameters passed to `*_switch` hooks.
1972
There are 4 fields that hooks may wish to access:
1974
:ivar control_dir: ControlDir of the checkout to change
1975
:ivar to_branch: branch that the checkout is to reference
1976
:ivar force: skip the check for local commits in a heavy checkout
1977
:ivar revision_id: revision ID to switch to (or None)
1980
def __init__(self, control_dir, to_branch, force, revision_id):
1981
"""Create a group of SwitchHook parameters.
1983
:param control_dir: ControlDir of the checkout to change
1984
:param to_branch: branch that the checkout is to reference
1985
:param force: skip the check for local commits in a heavy checkout
1986
:param revision_id: revision ID to switch to (or None)
1988
self.control_dir = control_dir
1989
self.to_branch = to_branch
1991
self.revision_id = revision_id
1993
def __eq__(self, other):
1994
return self.__dict__ == other.__dict__
1997
return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1998
self.control_dir, self.to_branch,
2002
class BranchFormatMetadir(bzrdir.BzrDirMetaComponentFormat, BranchFormat):
2003
"""Base class for branch formats that live in meta directories.
1721
class BzrBranchFormat4(BranchFormat):
1722
"""Bzr branch format 4.
1725
- a revision-history file.
1726
- a branch-lock lock file [ to be shared with the bzrdir ]
1729
def get_format_description(self):
1730
"""See BranchFormat.get_format_description()."""
1731
return "Branch format 4"
1733
def initialize(self, a_bzrdir):
1734
"""Create a branch of this format in a_bzrdir."""
1735
utf8_files = [('revision-history', ''),
1736
('branch-name', ''),
1738
return self._initialize_helper(a_bzrdir, utf8_files,
1739
lock_type='branch4', set_format=False)
2006
1741
def __init__(self):
2007
BranchFormat.__init__(self)
2008
bzrdir.BzrDirMetaComponentFormat.__init__(self)
2011
def find_format(klass, controldir, name=None):
2012
"""Return the format for the branch object in controldir."""
2014
transport = controldir.get_branch_transport(None, name=name)
2015
except errors.NoSuchFile:
2016
raise errors.NotBranchError(path=name, bzrdir=controldir)
2018
format_string = transport.get_bytes("format")
2019
except errors.NoSuchFile:
2020
raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
2021
return klass._find_format(format_registry, 'branch', format_string)
1742
super(BzrBranchFormat4, self).__init__()
1743
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1745
def network_name(self):
1746
"""The network name for this format is the control dirs disk label."""
1747
return self._matchingbzrdir.get_format_string()
1749
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1750
"""See BranchFormat.open()."""
1752
# we are being called directly and must probe.
1753
raise NotImplementedError
1754
return BzrBranch(_format=self,
1755
_control_files=a_bzrdir._control_files,
1757
_repository=a_bzrdir.open_repository())
1760
return "Bazaar-NG branch format 4"
1763
class BranchFormatMetadir(BranchFormat):
1764
"""Common logic for meta-dir based branch formats."""
2023
1766
def _branch_class(self):
2024
1767
"""What class to instantiate on open calls."""
2025
1768
raise NotImplementedError(self._branch_class)
2027
def _get_initial_config(self, append_revisions_only=None):
2028
if append_revisions_only:
2029
return "append_revisions_only = True\n"
2031
# Avoid writing anything if append_revisions_only is disabled,
2032
# as that is the default.
2035
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
2037
"""Initialize a branch in a bzrdir, with specified files
2039
:param a_bzrdir: The bzrdir to initialize the branch in
2040
:param utf8_files: The files to create as a list of
2041
(filename, content) tuples
2042
:param name: Name of colocated branch to create, if any
2043
:return: a branch in this format
1770
def network_name(self):
1771
"""A simple byte string uniquely identifying this format for RPC calls.
1773
Metadir branch formats use their format string.
2045
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2046
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2047
control_files = lockable_files.LockableFiles(branch_transport,
2048
'lock', lockdir.LockDir)
2049
control_files.create_lock()
2050
control_files.lock_write()
2052
utf8_files += [('format', self.get_format_string())]
2053
for (filename, content) in utf8_files:
2054
branch_transport.put_bytes(
2056
mode=a_bzrdir._get_file_mode())
2058
control_files.unlock()
2059
branch = self.open(a_bzrdir, name, _found=True,
2060
found_repository=repository)
2061
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1775
return self.get_format_string()
2064
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2065
found_repository=None, possible_transports=None):
1777
def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
2066
1778
"""See BranchFormat.open()."""
2068
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
1780
format = BranchFormat.find_format(a_bzrdir)
2069
1781
if format.__class__ != self.__class__:
2070
1782
raise AssertionError("wrong format %r found for %r" %
2071
1783
(format, self))
2072
transport = a_bzrdir.get_branch_transport(None, name=name)
1785
transport = a_bzrdir.get_branch_transport(None)
2074
1786
control_files = lockable_files.LockableFiles(transport, 'lock',
2075
1787
lockdir.LockDir)
2076
if found_repository is None:
2077
found_repository = a_bzrdir.find_repository()
2078
1788
return self._branch_class()(_format=self,
2079
1789
_control_files=control_files,
2081
1790
a_bzrdir=a_bzrdir,
2082
_repository=found_repository,
2083
ignore_fallbacks=ignore_fallbacks,
2084
possible_transports=possible_transports)
1791
_repository=a_bzrdir.find_repository(),
1792
ignore_fallbacks=ignore_fallbacks)
2085
1793
except errors.NoSuchFile:
2086
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1794
raise errors.NotBranchError(path=transport.base)
2089
def _matchingbzrdir(self):
2090
ret = bzrdir.BzrDirMetaFormat1()
2091
ret.set_branch_format(self)
1797
super(BranchFormatMetadir, self).__init__()
1798
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1799
self._matchingbzrdir.set_branch_format(self)
2094
1801
def supports_tags(self):
2097
def supports_leaving_lock(self):
2101
1805
class BzrBranchFormat5(BranchFormatMetadir):
2102
1806
"""Bzr branch format 5.
2281
1969
"""See BranchFormat.get_format_description()."""
2282
1970
return "Checkout reference format 1"
2284
def get_reference(self, a_bzrdir, name=None):
1972
def get_reference(self, a_bzrdir):
2285
1973
"""See BranchFormat.get_reference()."""
2286
transport = a_bzrdir.get_branch_transport(None, name=name)
1974
transport = a_bzrdir.get_branch_transport(None)
2287
1975
return transport.get_bytes('location')
2289
def set_reference(self, a_bzrdir, name, to_branch):
1977
def set_reference(self, a_bzrdir, to_branch):
2290
1978
"""See BranchFormat.set_reference()."""
2291
transport = a_bzrdir.get_branch_transport(None, name=name)
1979
transport = a_bzrdir.get_branch_transport(None)
2292
1980
location = transport.put_bytes('location', to_branch.base)
2294
def initialize(self, a_bzrdir, name=None, target_branch=None,
2295
repository=None, append_revisions_only=None):
1982
def initialize(self, a_bzrdir, target_branch=None):
2296
1983
"""Create a branch of this format in a_bzrdir."""
2297
1984
if target_branch is None:
2298
1985
# this format does not implement branch itself, thus the implicit
2299
1986
# creation contract must see it as uninitializable
2300
1987
raise errors.UninitializableFormat(self)
2301
mutter('creating branch reference in %s', a_bzrdir.user_url)
2302
if a_bzrdir._format.fixed_components:
2303
raise errors.IncompatibleFormat(self, a_bzrdir._format)
2304
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1988
mutter('creating branch reference in %s', a_bzrdir.transport.base)
1989
branch_transport = a_bzrdir.get_branch_transport(self)
2305
1990
branch_transport.put_bytes('location',
2306
target_branch.user_url)
1991
target_branch.bzrdir.root_transport.base)
2307
1992
branch_transport.put_bytes('format', self.get_format_string())
2309
a_bzrdir, name, _found=True,
1994
a_bzrdir, _found=True,
2310
1995
possible_transports=[target_branch.bzrdir.root_transport])
2311
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1998
super(BranchReferenceFormat, self).__init__()
1999
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2000
self._matchingbzrdir.set_branch_format(self)
2314
2002
def _make_reference_clone_function(format, a_branch):
2315
2003
"""Create a clone() routine for a branch dynamically."""
2316
2004
def clone(to_bzrdir, revision_id=None,
2317
2005
repository_policy=None):
2318
2006
"""See Branch.clone()."""
2319
return format.initialize(to_bzrdir, target_branch=a_branch)
2007
return format.initialize(to_bzrdir, a_branch)
2320
2008
# cannot obey revision_id limits when cloning a reference ...
2321
2009
# FIXME RBC 20060210 either nuke revision_id for clone, or
2322
2010
# emit some sort of warning/error to the caller ?!
2325
def open(self, a_bzrdir, name=None, _found=False, location=None,
2326
possible_transports=None, ignore_fallbacks=False,
2327
found_repository=None):
2013
def open(self, a_bzrdir, _found=False, location=None,
2014
possible_transports=None, ignore_fallbacks=False):
2328
2015
"""Return the branch that the branch reference in a_bzrdir points at.
2330
2017
:param a_bzrdir: A BzrDir that contains a branch.
2331
:param name: Name of colocated branch to open, if any
2332
2018
:param _found: a private parameter, do not use it. It is used to
2333
2019
indicate if format probing has already be done.
2334
2020
:param ignore_fallbacks: when set, no fallback branches will be opened
2557
2186
"""See Branch.print_file."""
2558
2187
return self.repository.print_file(file, revision_id)
2189
def _write_revision_history(self, history):
2190
"""Factored out of set_revision_history.
2192
This performs the actual writing to disk.
2193
It is intended to be called by BzrBranch5.set_revision_history."""
2194
self._transport.put_bytes(
2195
'revision-history', '\n'.join(history),
2196
mode=self.bzrdir._get_file_mode())
2199
def set_revision_history(self, rev_history):
2200
"""See Branch.set_revision_history."""
2201
if 'evil' in debug.debug_flags:
2202
mutter_callsite(3, "set_revision_history scales with history.")
2203
check_not_reserved_id = _mod_revision.check_not_reserved_id
2204
for rev_id in rev_history:
2205
check_not_reserved_id(rev_id)
2206
if Branch.hooks['post_change_branch_tip']:
2207
# Don't calculate the last_revision_info() if there are no hooks
2209
old_revno, old_revid = self.last_revision_info()
2210
if len(rev_history) == 0:
2211
revid = _mod_revision.NULL_REVISION
2213
revid = rev_history[-1]
2214
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2215
self._write_revision_history(rev_history)
2216
self._clear_cached_state()
2217
self._cache_revision_history(rev_history)
2218
for hook in Branch.hooks['set_rh']:
2219
hook(self, rev_history)
2220
if Branch.hooks['post_change_branch_tip']:
2221
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2223
def _synchronize_history(self, destination, revision_id):
2224
"""Synchronize last revision and revision history between branches.
2226
This version is most efficient when the destination is also a
2227
BzrBranch5, but works for BzrBranch6 as long as the revision
2228
history is the true lefthand parent history, and all of the revisions
2229
are in the destination's repository. If not, set_revision_history
2232
:param destination: The branch to copy the history into
2233
:param revision_id: The revision-id to truncate history at. May
2234
be None to copy complete history.
2236
if not isinstance(destination._format, BzrBranchFormat5):
2237
super(BzrBranch, self)._synchronize_history(
2238
destination, revision_id)
2240
if revision_id == _mod_revision.NULL_REVISION:
2243
new_history = self.revision_history()
2244
if revision_id is not None and new_history != []:
2246
new_history = new_history[:new_history.index(revision_id) + 1]
2248
rev = self.repository.get_revision(revision_id)
2249
new_history = rev.get_history(self.repository)[1:]
2250
destination.set_revision_history(new_history)
2560
2252
@needs_write_lock
2561
2253
def set_last_revision_info(self, revno, revision_id):
2562
if not revision_id or not isinstance(revision_id, basestring):
2563
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2254
"""Set the last revision of this branch.
2256
The caller is responsible for checking that the revno is correct
2257
for this revision id.
2259
It may be possible to set the branch last revision to an id not
2260
present in the repository. However, branches can also be
2261
configured to check constraints on history, in which case this may not
2564
2264
revision_id = _mod_revision.ensure_null(revision_id)
2565
old_revno, old_revid = self.last_revision_info()
2566
if self.get_append_revisions_only():
2567
self._check_history_violation(revision_id)
2568
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2569
self._write_last_revision_info(revno, revision_id)
2570
self._clear_cached_state()
2571
self._last_revision_info_cache = revno, revision_id
2572
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2265
# this old format stores the full history, but this api doesn't
2266
# provide it, so we must generate, and might as well check it's
2268
history = self._lefthand_history(revision_id)
2269
if len(history) != revno:
2270
raise AssertionError('%d != %d' % (len(history), revno))
2271
self.set_revision_history(history)
2273
def _gen_revision_history(self):
2274
history = self._transport.get_bytes('revision-history').split('\n')
2275
if history[-1:] == ['']:
2276
# There shouldn't be a trailing newline, but just in case.
2281
def generate_revision_history(self, revision_id, last_rev=None,
2283
"""Create a new revision history that will finish with revision_id.
2285
:param revision_id: the new tip to use.
2286
:param last_rev: The previous last_revision. If not None, then this
2287
must be a ancestory of revision_id, or DivergedBranches is raised.
2288
:param other_branch: The other branch that DivergedBranches should
2289
raise with respect to.
2291
self.set_revision_history(self._lefthand_history(revision_id,
2292
last_rev, other_branch))
2574
2294
def basis_tree(self):
2575
2295
"""See Branch.basis_tree."""
2696
def _read_last_revision_info(self):
2697
revision_string = self._transport.get_bytes('last-revision')
2698
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2699
revision_id = cache_utf8.get_cached_utf8(revision_id)
2701
return revno, revision_id
2703
def _write_last_revision_info(self, revno, revision_id):
2704
"""Simply write out the revision id, with no checks.
2706
Use set_last_revision_info to perform this safely.
2708
Does not update the revision_history cache.
2710
revision_id = _mod_revision.ensure_null(revision_id)
2711
out_string = '%d %s\n' % (revno, revision_id)
2712
self._transport.put_bytes('last-revision', out_string,
2713
mode=self.bzrdir._get_file_mode())
2716
class FullHistoryBzrBranch(BzrBranch):
2717
"""Bzr branch which contains the full revision history."""
2720
def set_last_revision_info(self, revno, revision_id):
2721
if not revision_id or not isinstance(revision_id, basestring):
2722
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2723
revision_id = _mod_revision.ensure_null(revision_id)
2724
# this old format stores the full history, but this api doesn't
2725
# provide it, so we must generate, and might as well check it's
2727
history = self._lefthand_history(revision_id)
2728
if len(history) != revno:
2729
raise AssertionError('%d != %d' % (len(history), revno))
2730
self._set_revision_history(history)
2732
def _read_last_revision_info(self):
2733
rh = self._revision_history()
2736
return (revno, rh[-1])
2738
return (0, _mod_revision.NULL_REVISION)
2740
@deprecated_method(deprecated_in((2, 4, 0)))
2742
def set_revision_history(self, rev_history):
2743
"""See Branch.set_revision_history."""
2744
self._set_revision_history(rev_history)
2746
def _set_revision_history(self, rev_history):
2747
if 'evil' in debug.debug_flags:
2748
mutter_callsite(3, "set_revision_history scales with history.")
2749
check_not_reserved_id = _mod_revision.check_not_reserved_id
2750
for rev_id in rev_history:
2751
check_not_reserved_id(rev_id)
2752
if Branch.hooks['post_change_branch_tip']:
2753
# Don't calculate the last_revision_info() if there are no hooks
2755
old_revno, old_revid = self.last_revision_info()
2756
if len(rev_history) == 0:
2757
revid = _mod_revision.NULL_REVISION
2759
revid = rev_history[-1]
2760
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2761
self._write_revision_history(rev_history)
2762
self._clear_cached_state()
2763
self._cache_revision_history(rev_history)
2764
for hook in Branch.hooks['set_rh']:
2765
hook(self, rev_history)
2766
if Branch.hooks['post_change_branch_tip']:
2767
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2769
def _write_revision_history(self, history):
2770
"""Factored out of set_revision_history.
2772
This performs the actual writing to disk.
2773
It is intended to be called by set_revision_history."""
2774
self._transport.put_bytes(
2775
'revision-history', '\n'.join(history),
2776
mode=self.bzrdir._get_file_mode())
2778
def _gen_revision_history(self):
2779
history = self._transport.get_bytes('revision-history').split('\n')
2780
if history[-1:] == ['']:
2781
# There shouldn't be a trailing newline, but just in case.
2785
def _synchronize_history(self, destination, revision_id):
2786
if not isinstance(destination, FullHistoryBzrBranch):
2787
super(BzrBranch, self)._synchronize_history(
2788
destination, revision_id)
2790
if revision_id == _mod_revision.NULL_REVISION:
2793
new_history = self._revision_history()
2794
if revision_id is not None and new_history != []:
2796
new_history = new_history[:new_history.index(revision_id) + 1]
2798
rev = self.repository.get_revision(revision_id)
2799
new_history = rev.get_history(self.repository)[1:]
2800
destination._set_revision_history(new_history)
2803
def generate_revision_history(self, revision_id, last_rev=None,
2805
"""Create a new revision history that will finish with revision_id.
2807
:param revision_id: the new tip to use.
2808
:param last_rev: The previous last_revision. If not None, then this
2809
must be a ancestory of revision_id, or DivergedBranches is raised.
2810
:param other_branch: The other branch that DivergedBranches should
2811
raise with respect to.
2813
self._set_revision_history(self._lefthand_history(revision_id,
2814
last_rev, other_branch))
2817
class BzrBranch5(FullHistoryBzrBranch):
2818
"""A format 5 branch. This supports new features over plain branches.
2820
It has support for a master_branch which is the data for bound branches.
2824
class BzrBranch8(BzrBranch):
2444
class BzrBranch8(BzrBranch5):
2825
2445
"""A branch that stores tree-reference locations."""
2827
def _open_hook(self, possible_transports=None):
2447
def _open_hook(self):
2828
2448
if self._ignore_fallbacks:
2830
if possible_transports is None:
2831
possible_transports = [self.bzrdir.root_transport]
2833
2451
url = self.get_stacked_on_url()
2834
2452
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2856
2473
self._last_revision_info_cache = None
2857
2474
self._reference_info = None
2476
def _last_revision_info(self):
2477
revision_string = self._transport.get_bytes('last-revision')
2478
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2479
revision_id = cache_utf8.get_cached_utf8(revision_id)
2481
return revno, revision_id
2483
def _write_last_revision_info(self, revno, revision_id):
2484
"""Simply write out the revision id, with no checks.
2486
Use set_last_revision_info to perform this safely.
2488
Does not update the revision_history cache.
2489
Intended to be called by set_last_revision_info and
2490
_write_revision_history.
2492
revision_id = _mod_revision.ensure_null(revision_id)
2493
out_string = '%d %s\n' % (revno, revision_id)
2494
self._transport.put_bytes('last-revision', out_string,
2495
mode=self.bzrdir._get_file_mode())
2498
def set_last_revision_info(self, revno, revision_id):
2499
revision_id = _mod_revision.ensure_null(revision_id)
2500
old_revno, old_revid = self.last_revision_info()
2501
if self._get_append_revisions_only():
2502
self._check_history_violation(revision_id)
2503
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2504
self._write_last_revision_info(revno, revision_id)
2505
self._clear_cached_state()
2506
self._last_revision_info_cache = revno, revision_id
2507
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2509
def _synchronize_history(self, destination, revision_id):
2510
"""Synchronize last revision and revision history between branches.
2512
:see: Branch._synchronize_history
2514
# XXX: The base Branch has a fast implementation of this method based
2515
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2516
# that uses set_revision_history. This class inherits from BzrBranch5,
2517
# but wants the fast implementation, so it calls
2518
# Branch._synchronize_history directly.
2519
Branch._synchronize_history(self, destination, revision_id)
2859
2521
def _check_history_violation(self, revision_id):
2860
current_revid = self.last_revision()
2861
last_revision = _mod_revision.ensure_null(current_revid)
2522
last_revision = _mod_revision.ensure_null(self.last_revision())
2862
2523
if _mod_revision.is_null(last_revision):
2864
graph = self.repository.get_graph()
2865
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2866
if lh_ancestor == current_revid:
2868
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2525
if last_revision not in self._lefthand_history(revision_id):
2526
raise errors.AppendRevisionsOnlyViolation(self.base)
2870
2528
def _gen_revision_history(self):
2871
2529
"""Generate the revision history from last revision
3293
2981
raise NotImplementedError(self.push)
3296
def copy_content_into(self, revision_id=None):
3297
"""Copy the content of source into target
3299
revision_id: if not None, the revision history in the new branch will
3300
be truncated to end with revision_id.
3302
raise NotImplementedError(self.copy_content_into)
3305
def fetch(self, stop_revision=None, limit=None):
3308
:param stop_revision: Last revision to fetch
3309
:param limit: Optional rough limit of revisions to fetch
3311
raise NotImplementedError(self.fetch)
3314
2984
class GenericInterBranch(InterBranch):
3315
"""InterBranch implementation that uses public Branch functions."""
3318
def is_compatible(klass, source, target):
3319
# GenericBranch uses the public API, so always compatible
3323
def _get_branch_formats_to_test(klass):
3324
return [(format_registry.get_default(), format_registry.get_default())]
3327
def unwrap_format(klass, format):
3328
if isinstance(format, remote.RemoteBranchFormat):
3329
format._ensure_real()
3330
return format._custom_format
3334
def copy_content_into(self, revision_id=None):
3335
"""Copy the content of source into target
3337
revision_id: if not None, the revision history in the new branch will
3338
be truncated to end with revision_id.
3340
self.source.update_references(self.target)
3341
self.source._synchronize_history(self.target, revision_id)
3343
parent = self.source.get_parent()
3344
except errors.InaccessibleParent, e:
3345
mutter('parent was not accessible to copy: %s', e)
3348
self.target.set_parent(parent)
3349
if self.source._push_should_merge_tags():
3350
self.source.tags.merge_to(self.target.tags)
3353
def fetch(self, stop_revision=None, limit=None):
3354
if self.target.base == self.source.base:
2985
"""InterBranch implementation that uses public Branch functions.
2989
def _get_branch_formats_to_test():
2990
return BranchFormat._default_format, BranchFormat._default_format
2992
def update_revisions(self, stop_revision=None, overwrite=False,
2994
"""See InterBranch.update_revisions()."""
3356
2995
self.source.lock_read()
3358
fetch_spec_factory = fetch.FetchSpecFactory()
3359
fetch_spec_factory.source_branch = self.source
3360
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3361
fetch_spec_factory.source_repo = self.source.repository
3362
fetch_spec_factory.target_repo = self.target.repository
3363
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3364
fetch_spec_factory.limit = limit
3365
fetch_spec = fetch_spec_factory.make_fetch_spec()
3366
return self.target.repository.fetch(self.source.repository,
3367
fetch_spec=fetch_spec)
2997
other_revno, other_last_revision = self.source.last_revision_info()
2998
stop_revno = None # unknown
2999
if stop_revision is None:
3000
stop_revision = other_last_revision
3001
if _mod_revision.is_null(stop_revision):
3002
# if there are no commits, we're done.
3004
stop_revno = other_revno
3006
# what's the current last revision, before we fetch [and change it
3008
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3009
# we fetch here so that we don't process data twice in the common
3010
# case of having something to pull, and so that the check for
3011
# already merged can operate on the just fetched graph, which will
3012
# be cached in memory.
3013
self.target.fetch(self.source, stop_revision)
3014
# Check to see if one is an ancestor of the other
3017
graph = self.target.repository.get_graph()
3018
if self.target._check_if_descendant_or_diverged(
3019
stop_revision, last_rev, graph, self.source):
3020
# stop_revision is a descendant of last_rev, but we aren't
3021
# overwriting, so we're done.
3023
if stop_revno is None:
3025
graph = self.target.repository.get_graph()
3026
this_revno, this_last_revision = \
3027
self.target.last_revision_info()
3028
stop_revno = graph.find_distance_to_null(stop_revision,
3029
[(other_last_revision, other_revno),
3030
(this_last_revision, this_revno)])
3031
self.target.set_last_revision_info(stop_revno, stop_revision)
3369
3033
self.source.unlock()
3372
def _update_revisions(self, stop_revision=None, overwrite=False,
3374
other_revno, other_last_revision = self.source.last_revision_info()
3375
stop_revno = None # unknown
3376
if stop_revision is None:
3377
stop_revision = other_last_revision
3378
if _mod_revision.is_null(stop_revision):
3379
# if there are no commits, we're done.
3381
stop_revno = other_revno
3383
# what's the current last revision, before we fetch [and change it
3385
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3386
# we fetch here so that we don't process data twice in the common
3387
# case of having something to pull, and so that the check for
3388
# already merged can operate on the just fetched graph, which will
3389
# be cached in memory.
3390
self.fetch(stop_revision=stop_revision)
3391
# Check to see if one is an ancestor of the other
3394
graph = self.target.repository.get_graph()
3395
if self.target._check_if_descendant_or_diverged(
3396
stop_revision, last_rev, graph, self.source):
3397
# stop_revision is a descendant of last_rev, but we aren't
3398
# overwriting, so we're done.
3400
if stop_revno is None:
3402
graph = self.target.repository.get_graph()
3403
this_revno, this_last_revision = \
3404
self.target.last_revision_info()
3405
stop_revno = graph.find_distance_to_null(stop_revision,
3406
[(other_last_revision, other_revno),
3407
(this_last_revision, this_revno)])
3408
self.target.set_last_revision_info(stop_revno, stop_revision)
3411
3035
def pull(self, overwrite=False, stop_revision=None,
3412
possible_transports=None, run_hooks=True,
3413
_override_hook_target=None, local=False):
3414
"""Pull from source into self, updating my master if any.
3416
:param run_hooks: Private parameter - if false, this branch
3417
is being called because it's the master of the primary branch,
3418
so it should not run its hooks.
3420
bound_location = self.target.get_bound_location()
3421
if local and not bound_location:
3422
raise errors.LocalRequiresBoundBranch()
3423
master_branch = None
3424
source_is_master = False
3426
# bound_location comes from a config file, some care has to be
3427
# taken to relate it to source.user_url
3428
normalized = urlutils.normalize_url(bound_location)
3430
relpath = self.source.user_transport.relpath(normalized)
3431
source_is_master = (relpath == '')
3432
except (errors.PathNotChild, errors.InvalidURL):
3433
source_is_master = False
3434
if not local and bound_location and not source_is_master:
3435
# not pulling from master, so we need to update master.
3436
master_branch = self.target.get_master_branch(possible_transports)
3437
master_branch.lock_write()
3440
# pull from source into master.
3441
master_branch.pull(self.source, overwrite, stop_revision,
3443
return self._pull(overwrite,
3444
stop_revision, _hook_master=master_branch,
3445
run_hooks=run_hooks,
3446
_override_hook_target=_override_hook_target,
3447
merge_tags_to_master=not source_is_master)
3450
master_branch.unlock()
3452
def push(self, overwrite=False, stop_revision=None, lossy=False,
3453
_override_hook_source_branch=None):
3454
"""See InterBranch.push.
3456
This is the basic concrete implementation of push()
3458
:param _override_hook_source_branch: If specified, run the hooks
3459
passing this Branch as the source, rather than self. This is for
3460
use of RemoteBranch, where push is delegated to the underlying
3464
raise errors.LossyPushToSameVCS(self.source, self.target)
3465
# TODO: Public option to disable running hooks - should be trivial but
3468
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3469
op.add_cleanup(self.source.lock_read().unlock)
3470
op.add_cleanup(self.target.lock_write().unlock)
3471
return op.run(overwrite, stop_revision,
3472
_override_hook_source_branch=_override_hook_source_branch)
3474
def _basic_push(self, overwrite, stop_revision):
3475
"""Basic implementation of push without bound branches or hooks.
3477
Must be called with source read locked and target write locked.
3479
result = BranchPushResult()
3480
result.source_branch = self.source
3481
result.target_branch = self.target
3482
result.old_revno, result.old_revid = self.target.last_revision_info()
3483
self.source.update_references(self.target)
3484
if result.old_revid != stop_revision:
3485
# We assume that during 'push' this repository is closer than
3487
graph = self.source.repository.get_graph(self.target.repository)
3488
self._update_revisions(stop_revision, overwrite=overwrite,
3490
if self.source._push_should_merge_tags():
3491
result.tag_updates, result.tag_conflicts = (
3492
self.source.tags.merge_to(self.target.tags, overwrite))
3493
result.new_revno, result.new_revid = self.target.last_revision_info()
3496
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3497
_override_hook_source_branch=None):
3498
"""Push from source into target, and into target's master if any.
3501
if _override_hook_source_branch:
3502
result.source_branch = _override_hook_source_branch
3503
for hook in Branch.hooks['post_push']:
3506
bound_location = self.target.get_bound_location()
3507
if bound_location and self.target.base != bound_location:
3508
# there is a master branch.
3510
# XXX: Why the second check? Is it even supported for a branch to
3511
# be bound to itself? -- mbp 20070507
3512
master_branch = self.target.get_master_branch()
3513
master_branch.lock_write()
3514
operation.add_cleanup(master_branch.unlock)
3515
# push into the master from the source branch.
3516
master_inter = InterBranch.get(self.source, master_branch)
3517
master_inter._basic_push(overwrite, stop_revision)
3518
# and push into the target branch from the source. Note that
3519
# we push from the source branch again, because it's considered
3520
# the highest bandwidth repository.
3521
result = self._basic_push(overwrite, stop_revision)
3522
result.master_branch = master_branch
3523
result.local_branch = self.target
3525
master_branch = None
3527
result = self._basic_push(overwrite, stop_revision)
3528
# TODO: Why set master_branch and local_branch if there's no
3529
# binding? Maybe cleaner to just leave them unset? -- mbp
3531
result.master_branch = self.target
3532
result.local_branch = None
3536
def _pull(self, overwrite=False, stop_revision=None,
3537
3036
possible_transports=None, _hook_master=None, run_hooks=True,
3538
_override_hook_target=None, local=False,
3539
merge_tags_to_master=True):
3037
_override_hook_target=None, local=False):
3540
3038
"""See Branch.pull.
3542
This function is the core worker, used by GenericInterBranch.pull to
3543
avoid duplication when pulling source->master and source->local.
3545
3040
:param _hook_master: Private parameter - set the branch to
3546
3041
be supplied as the master to pull hooks.
3547
3042
:param run_hooks: Private parameter - if false, this branch
3548
3043
is being called because it's the master of the primary branch,
3549
3044
so it should not run its hooks.
3550
is being called because it's the master of the primary branch,
3551
so it should not run its hooks.
3552
3045
:param _override_hook_target: Private parameter - set the branch to be
3553
3046
supplied as the target_branch to pull hooks.
3554
3047
:param local: Only update the local branch, and not the bound branch.
3595
3087
self.source.unlock()
3090
def push(self, overwrite=False, stop_revision=None,
3091
_override_hook_source_branch=None):
3092
"""See InterBranch.push.
3094
This is the basic concrete implementation of push()
3096
:param _override_hook_source_branch: If specified, run
3097
the hooks passing this Branch as the source, rather than self.
3098
This is for use of RemoteBranch, where push is delegated to the
3099
underlying vfs-based Branch.
3101
# TODO: Public option to disable running hooks - should be trivial but
3103
self.source.lock_read()
3105
return _run_with_write_locked_target(
3106
self.target, self._push_with_bound_branches, overwrite,
3108
_override_hook_source_branch=_override_hook_source_branch)
3110
self.source.unlock()
3112
def _push_with_bound_branches(self, overwrite, stop_revision,
3113
_override_hook_source_branch=None):
3114
"""Push from source into target, and into target's master if any.
3117
if _override_hook_source_branch:
3118
result.source_branch = _override_hook_source_branch
3119
for hook in Branch.hooks['post_push']:
3122
bound_location = self.target.get_bound_location()
3123
if bound_location and self.target.base != bound_location:
3124
# there is a master branch.
3126
# XXX: Why the second check? Is it even supported for a branch to
3127
# be bound to itself? -- mbp 20070507
3128
master_branch = self.target.get_master_branch()
3129
master_branch.lock_write()
3131
# push into the master from the source branch.
3132
self.source._basic_push(master_branch, overwrite, stop_revision)
3133
# and push into the target branch from the source. Note that we
3134
# push from the source branch again, because its considered the
3135
# highest bandwidth repository.
3136
result = self.source._basic_push(self.target, overwrite,
3138
result.master_branch = master_branch
3139
result.local_branch = self.target
3143
master_branch.unlock()
3146
result = self.source._basic_push(self.target, overwrite,
3148
# TODO: Why set master_branch and local_branch if there's no
3149
# binding? Maybe cleaner to just leave them unset? -- mbp
3151
result.master_branch = self.target
3152
result.local_branch = None
3157
def is_compatible(self, source, target):
3158
# GenericBranch uses the public API, so always compatible
3162
class InterToBranch5(GenericInterBranch):
3165
def _get_branch_formats_to_test():
3166
return BranchFormat._default_format, BzrBranchFormat5()
3168
def pull(self, overwrite=False, stop_revision=None,
3169
possible_transports=None, run_hooks=True,
3170
_override_hook_target=None, local=False):
3171
"""Pull from source into self, updating my master if any.
3173
:param run_hooks: Private parameter - if false, this branch
3174
is being called because it's the master of the primary branch,
3175
so it should not run its hooks.
3177
bound_location = self.target.get_bound_location()
3178
if local and not bound_location:
3179
raise errors.LocalRequiresBoundBranch()
3180
master_branch = None
3181
if not local and bound_location and self.source.base != bound_location:
3182
# not pulling from master, so we need to update master.
3183
master_branch = self.target.get_master_branch(possible_transports)
3184
master_branch.lock_write()
3187
# pull from source into master.
3188
master_branch.pull(self.source, overwrite, stop_revision,
3190
return super(InterToBranch5, self).pull(overwrite,
3191
stop_revision, _hook_master=master_branch,
3192
run_hooks=run_hooks,
3193
_override_hook_target=_override_hook_target)
3196
master_branch.unlock()
3599
3199
InterBranch.register_optimiser(GenericInterBranch)
3200
InterBranch.register_optimiser(InterToBranch5)