782
879
old_repository = self.repository
783
880
if len(old_repository._fallback_repositories) != 1:
784
881
raise AssertionError("can't cope with fallback repositories "
785
"of %r" % (self.repository,))
786
# unlock it, including unlocking the fallback
882
"of %r (fallbacks: %r)" % (old_repository,
883
old_repository._fallback_repositories))
884
# Open the new repository object.
885
# Repositories don't offer an interface to remove fallback
886
# repositories today; take the conceptually simpler option and just
887
# reopen it. We reopen it starting from the URL so that we
888
# get a separate connection for RemoteRepositories and can
889
# stream from one of them to the other. This does mean doing
890
# separate SSH connection setup, but unstacking is not a
891
# common operation so it's tolerable.
892
new_bzrdir = controldir.ControlDir.open(
893
self.bzrdir.root_transport.base)
894
new_repository = new_bzrdir.find_repository()
895
if new_repository._fallback_repositories:
896
raise AssertionError("didn't expect %r to have "
897
"fallback_repositories"
898
% (self.repository,))
899
# Replace self.repository with the new repository.
900
# Do our best to transfer the lock state (i.e. lock-tokens and
901
# lock count) of self.repository to the new repository.
902
lock_token = old_repository.lock_write().repository_token
903
self.repository = new_repository
904
if isinstance(self, remote.RemoteBranch):
905
# Remote branches can have a second reference to the old
906
# repository that need to be replaced.
907
if self._real_branch is not None:
908
self._real_branch.repository = new_repository
909
self.repository.lock_write(token=lock_token)
910
if lock_token is not None:
911
old_repository.leave_lock_in_place()
787
912
old_repository.unlock()
913
if lock_token is not None:
914
# XXX: self.repository.leave_lock_in_place() before this
915
# function will not be preserved. Fortunately that doesn't
916
# affect the current default format (2a), and would be a
917
# corner-case anyway.
918
# - Andrew Bennetts, 2010/06/30
919
self.repository.dont_leave_lock_in_place()
923
old_repository.unlock()
924
except errors.LockNotHeld:
927
if old_lock_count == 0:
928
raise AssertionError(
929
'old_repository should have been locked at least once.')
930
for i in range(old_lock_count-1):
931
self.repository.lock_write()
932
# Fetch from the old repository into the new.
788
933
old_repository.lock_read()
790
# Repositories don't offer an interface to remove fallback
791
# repositories today; take the conceptually simpler option and just
792
# reopen it. We reopen it starting from the URL so that we
793
# get a separate connection for RemoteRepositories and can
794
# stream from one of them to the other. This does mean doing
795
# separate SSH connection setup, but unstacking is not a
796
# common operation so it's tolerable.
797
new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
798
new_repository = new_bzrdir.find_repository()
799
self.repository = new_repository
800
if self.repository._fallback_repositories:
801
raise AssertionError("didn't expect %r to have "
802
"fallback_repositories"
803
% (self.repository,))
804
# this is not paired with an unlock because it's just restoring
805
# the previous state; the lock's released when set_stacked_on_url
807
self.repository.lock_write()
808
935
# XXX: If you unstack a branch while it has a working tree
809
936
# with a pending merge, the pending-merged revisions will no
810
937
# longer be present. You can (probably) revert and remerge.
812
# XXX: This only fetches up to the tip of the repository; it
813
# doesn't bring across any tags. That's fairly consistent
814
# with how branch works, but perhaps not ideal.
815
self.repository.fetch(old_repository,
816
revision_id=self.last_revision(),
939
tags_to_fetch = set(self.tags.get_reverse_tag_dict())
940
except errors.TagsNotSupported:
941
tags_to_fetch = set()
942
fetch_spec = vf_search.NotInOtherForRevs(self.repository,
943
old_repository, required_ids=[self.last_revision()],
944
if_present_ids=tags_to_fetch, find_ghosts=True).execute()
945
self.repository.fetch(old_repository, fetch_spec=fetch_spec)
819
947
old_repository.unlock()
917
1056
:return: A tuple (revno, revision_id).
919
1058
if self._last_revision_info_cache is None:
920
self._last_revision_info_cache = self._last_revision_info()
1059
self._last_revision_info_cache = self._read_last_revision_info()
921
1060
return self._last_revision_info_cache
923
def _last_revision_info(self):
924
rh = self.revision_history()
927
return (revno, rh[-1])
929
return (0, _mod_revision.NULL_REVISION)
931
@deprecated_method(deprecated_in((1, 6, 0)))
932
def missing_revisions(self, other, stop_revision=None):
933
"""Return a list of new revisions that would perfectly fit.
935
If self and other have not diverged, return a list of the revisions
936
present in other, but missing from self.
938
self_history = self.revision_history()
939
self_len = len(self_history)
940
other_history = other.revision_history()
941
other_len = len(other_history)
942
common_index = min(self_len, other_len) -1
943
if common_index >= 0 and \
944
self_history[common_index] != other_history[common_index]:
945
raise errors.DivergedBranches(self, other)
947
if stop_revision is None:
948
stop_revision = other_len
950
if stop_revision > other_len:
951
raise errors.NoSuchRevision(self, stop_revision)
952
return other_history[self_len:stop_revision]
955
def update_revisions(self, other, stop_revision=None, overwrite=False,
957
"""Pull in new perfect-fit revisions.
959
:param other: Another Branch to pull from
960
:param stop_revision: Updated until the given revision
961
:param overwrite: Always set the branch pointer, rather than checking
962
to see if it is a proper descendant.
963
:param graph: A Graph object that can be used to query history
964
information. This can be None.
967
return InterBranch.get(other, self).update_revisions(stop_revision,
1062
def _read_last_revision_info(self):
1063
raise NotImplementedError(self._read_last_revision_info)
1065
@deprecated_method(deprecated_in((2, 4, 0)))
970
1066
def import_last_revision_info(self, source_repo, revno, revid):
971
1067
"""Set the last revision info, importing from another repo if necessary.
973
This is used by the bound branch code to upload a revision to
974
the master branch first before updating the tip of the local branch.
976
1069
:param source_repo: Source repository to optionally fetch from
977
1070
:param revno: Revision number of the new tip
978
1071
:param revid: Revision id of the new tip
1505
1605
return not (self == other)
1508
def find_format(klass, a_bzrdir, name=None):
1509
"""Return the format for the branch object in a_bzrdir."""
1511
transport = a_bzrdir.get_branch_transport(None, name=name)
1512
format_string = transport.get_bytes("format")
1513
return klass._formats[format_string]
1514
except errors.NoSuchFile:
1515
raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1517
raise errors.UnknownFormatError(format=format_string, kind='branch')
1608
@deprecated_method(deprecated_in((2, 4, 0)))
1520
1609
def get_default_format(klass):
1521
1610
"""Return the current default format."""
1522
return klass._default_format
1524
def get_reference(self, a_bzrdir):
1525
"""Get the target reference of the branch in a_bzrdir.
1611
return format_registry.get_default()
1614
@deprecated_method(deprecated_in((2, 4, 0)))
1615
def get_formats(klass):
1616
"""Get all the known formats.
1618
Warning: This triggers a load of all lazy registered formats: do not
1619
use except when that is desireed.
1621
return format_registry._get_all()
1623
def get_reference(self, controldir, name=None):
1624
"""Get the target reference of the branch in controldir.
1527
1626
format probing must have been completed before calling
1528
1627
this method - it is assumed that the format of the branch
1529
in a_bzrdir is correct.
1628
in controldir is correct.
1531
:param a_bzrdir: The bzrdir to get the branch data from.
1630
:param controldir: The controldir to get the branch data from.
1631
:param name: Name of the colocated branch to fetch
1532
1632
:return: None if the branch is not a reference branch.
1537
def set_reference(self, a_bzrdir, to_branch):
1538
"""Set the target reference of the branch in a_bzrdir.
1637
def set_reference(self, controldir, name, to_branch):
1638
"""Set the target reference of the branch in controldir.
1540
1640
format probing must have been completed before calling
1541
1641
this method - it is assumed that the format of the branch
1542
in a_bzrdir is correct.
1642
in controldir is correct.
1544
:param a_bzrdir: The bzrdir to set the branch reference for.
1644
:param controldir: The controldir to set the branch reference for.
1645
:param name: Name of colocated branch to set, None for default
1545
1646
:param to_branch: branch that the checkout is to reference
1547
1648
raise NotImplementedError(self.set_reference)
1549
def get_format_string(self):
1550
"""Return the ASCII format string that identifies this format."""
1551
raise NotImplementedError(self.get_format_string)
1553
1650
def get_format_description(self):
1554
1651
"""Return the short format description for this format."""
1555
1652
raise NotImplementedError(self.get_format_description)
1557
def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1654
def _run_post_branch_init_hooks(self, controldir, name, branch):
1558
1655
hooks = Branch.hooks['post_branch_init']
1561
params = BranchInitHookParams(self, a_bzrdir, name, branch)
1658
params = BranchInitHookParams(self, controldir, name, branch)
1562
1659
for hook in hooks:
1565
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1566
lock_type='metadir', set_format=True):
1567
"""Initialize a branch in a bzrdir, with specified files
1569
:param a_bzrdir: The bzrdir to initialize the branch in
1570
:param utf8_files: The files to create as a list of
1571
(filename, content) tuples
1572
:param name: Name of colocated branch to create, if any
1573
:param set_format: If True, set the format with
1574
self.get_format_string. (BzrBranch4 has its format set
1576
:return: a branch in this format
1578
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1581
'metadir': ('lock', lockdir.LockDir),
1582
'branch4': ('branch-lock', lockable_files.TransportLock),
1584
lock_name, lock_class = lock_map[lock_type]
1585
control_files = lockable_files.LockableFiles(branch_transport,
1586
lock_name, lock_class)
1587
control_files.create_lock()
1589
control_files.lock_write()
1590
except errors.LockContention:
1591
if lock_type != 'branch4':
1597
utf8_files += [('format', self.get_format_string())]
1599
for (filename, content) in utf8_files:
1600
branch_transport.put_bytes(
1602
mode=a_bzrdir._get_file_mode())
1605
control_files.unlock()
1606
branch = self.open(a_bzrdir, name, _found=True)
1607
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1610
def initialize(self, a_bzrdir, name=None):
1611
"""Create a branch of this format in a_bzrdir.
1662
def initialize(self, controldir, name=None, repository=None,
1663
append_revisions_only=None):
1664
"""Create a branch of this format in controldir.
1613
1666
:param name: Name of the colocated branch to create.
1615
1668
raise NotImplementedError(self.initialize)
1731
1829
"basis revision. hooks MUST NOT modify this delta. "
1732
1830
" future_tree is an in-memory tree obtained from "
1733
1831
"CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1734
"tree.", (0,91), None))
1735
self.create_hook(HookPoint('post_commit',
1833
self.add_hook('post_commit',
1736
1834
"Called in the bzr client after a commit has completed. "
1737
1835
"post_commit is called with (local, master, old_revno, old_revid, "
1738
1836
"new_revno, new_revid). old_revid is NULL_REVISION for the first "
1739
"commit to a branch.", (0, 15), None))
1740
self.create_hook(HookPoint('post_uncommit',
1837
"commit to a branch.", (0, 15))
1838
self.add_hook('post_uncommit',
1741
1839
"Called in the bzr client after an uncommit completes. "
1742
1840
"post_uncommit is called with (local, master, old_revno, "
1743
1841
"old_revid, new_revno, new_revid) where local is the local branch "
1744
1842
"or None, master is the target branch, and an empty branch "
1745
"receives new_revno of 0, new_revid of None.", (0, 15), None))
1746
self.create_hook(HookPoint('pre_change_branch_tip',
1843
"receives new_revno of 0, new_revid of None.", (0, 15))
1844
self.add_hook('pre_change_branch_tip',
1747
1845
"Called in bzr client and server before a change to the tip of a "
1748
1846
"branch is made. pre_change_branch_tip is called with a "
1749
1847
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1750
"commit, uncommit will all trigger this hook.", (1, 6), None))
1751
self.create_hook(HookPoint('post_change_branch_tip',
1848
"commit, uncommit will all trigger this hook.", (1, 6))
1849
self.add_hook('post_change_branch_tip',
1752
1850
"Called in bzr client and server after a change to the tip of a "
1753
1851
"branch is made. post_change_branch_tip is called with a "
1754
1852
"bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1755
"commit, uncommit will all trigger this hook.", (1, 4), None))
1756
self.create_hook(HookPoint('transform_fallback_location',
1853
"commit, uncommit will all trigger this hook.", (1, 4))
1854
self.add_hook('transform_fallback_location',
1757
1855
"Called when a stacked branch is activating its fallback "
1758
1856
"locations. transform_fallback_location is called with (branch, "
1759
1857
"url), and should return a new url. Returning the same url "
1904
1997
self.revision_id)
1907
class BzrBranchFormat4(BranchFormat):
1908
"""Bzr branch format 4.
1911
- a revision-history file.
1912
- a branch-lock lock file [ to be shared with the bzrdir ]
2000
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
2001
"""Base class for branch formats that live in meta directories.
1915
def get_format_description(self):
1916
"""See BranchFormat.get_format_description()."""
1917
return "Branch format 4"
1919
def initialize(self, a_bzrdir, name=None):
1920
"""Create a branch of this format in a_bzrdir."""
1921
utf8_files = [('revision-history', ''),
1922
('branch-name', ''),
1924
return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1925
lock_type='branch4', set_format=False)
1927
2004
def __init__(self):
1928
super(BzrBranchFormat4, self).__init__()
1929
self._matchingbzrdir = bzrdir.BzrDirFormat6()
1931
def network_name(self):
1932
"""The network name for this format is the control dirs disk label."""
1933
return self._matchingbzrdir.get_format_string()
1935
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1936
"""See BranchFormat.open()."""
1938
# we are being called directly and must probe.
1939
raise NotImplementedError
1940
return BzrBranch(_format=self,
1941
_control_files=a_bzrdir._control_files,
1944
_repository=a_bzrdir.open_repository())
1947
return "Bazaar-NG branch format 4"
1950
class BranchFormatMetadir(BranchFormat):
1951
"""Common logic for meta-dir based branch formats."""
2005
BranchFormat.__init__(self)
2006
bzrdir.BzrFormat.__init__(self)
2009
def find_format(klass, controldir, name=None):
2010
"""Return the format for the branch object in controldir."""
2012
transport = controldir.get_branch_transport(None, name=name)
2013
except errors.NoSuchFile:
2014
raise errors.NotBranchError(path=name, bzrdir=controldir)
2016
format_string = transport.get_bytes("format")
2017
except errors.NoSuchFile:
2018
raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
2019
return klass._find_format(format_registry, 'branch', format_string)
1953
2021
def _branch_class(self):
1954
2022
"""What class to instantiate on open calls."""
1955
2023
raise NotImplementedError(self._branch_class)
1957
def network_name(self):
1958
"""A simple byte string uniquely identifying this format for RPC calls.
1960
Metadir branch formats use their format string.
2025
def _get_initial_config(self, append_revisions_only=None):
2026
if append_revisions_only:
2027
return "append_revisions_only = True\n"
2029
# Avoid writing anything if append_revisions_only is disabled,
2030
# as that is the default.
2033
def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
2035
"""Initialize a branch in a bzrdir, with specified files
2037
:param a_bzrdir: The bzrdir to initialize the branch in
2038
:param utf8_files: The files to create as a list of
2039
(filename, content) tuples
2040
:param name: Name of colocated branch to create, if any
2041
:return: a branch in this format
1962
return self.get_format_string()
2043
mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2044
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2045
control_files = lockable_files.LockableFiles(branch_transport,
2046
'lock', lockdir.LockDir)
2047
control_files.create_lock()
2048
control_files.lock_write()
2050
utf8_files += [('format', self.as_string())]
2051
for (filename, content) in utf8_files:
2052
branch_transport.put_bytes(
2054
mode=a_bzrdir._get_file_mode())
2056
control_files.unlock()
2057
branch = self.open(a_bzrdir, name, _found=True,
2058
found_repository=repository)
2059
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1964
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
2062
def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2063
found_repository=None, possible_transports=None):
1965
2064
"""See BranchFormat.open()."""
1967
format = BranchFormat.find_format(a_bzrdir, name=name)
2066
format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
1968
2067
if format.__class__ != self.__class__:
1969
2068
raise AssertionError("wrong format %r found for %r" %
1970
2069
(format, self))
2157
2287
"""See BranchFormat.get_format_description()."""
2158
2288
return "Checkout reference format 1"
2160
def get_reference(self, a_bzrdir):
2290
def get_reference(self, a_bzrdir, name=None):
2161
2291
"""See BranchFormat.get_reference()."""
2162
transport = a_bzrdir.get_branch_transport(None)
2292
transport = a_bzrdir.get_branch_transport(None, name=name)
2163
2293
return transport.get_bytes('location')
2165
def set_reference(self, a_bzrdir, to_branch):
2295
def set_reference(self, a_bzrdir, name, to_branch):
2166
2296
"""See BranchFormat.set_reference()."""
2167
transport = a_bzrdir.get_branch_transport(None)
2297
transport = a_bzrdir.get_branch_transport(None, name=name)
2168
2298
location = transport.put_bytes('location', to_branch.base)
2170
def initialize(self, a_bzrdir, name=None, target_branch=None):
2300
def initialize(self, a_bzrdir, name=None, target_branch=None,
2301
repository=None, append_revisions_only=None):
2171
2302
"""Create a branch of this format in a_bzrdir."""
2172
2303
if target_branch is None:
2173
2304
# this format does not implement branch itself, thus the implicit
2174
2305
# creation contract must see it as uninitializable
2175
2306
raise errors.UninitializableFormat(self)
2176
2307
mutter('creating branch reference in %s', a_bzrdir.user_url)
2308
if a_bzrdir._format.fixed_components:
2309
raise errors.IncompatibleFormat(self, a_bzrdir._format)
2177
2310
branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2178
2311
branch_transport.put_bytes('location',
2179
target_branch.bzrdir.user_url)
2180
branch_transport.put_bytes('format', self.get_format_string())
2312
target_branch.user_url)
2313
branch_transport.put_bytes('format', self.as_string())
2181
2314
branch = self.open(
2182
2315
a_bzrdir, name, _found=True,
2183
2316
possible_transports=[target_branch.bzrdir.root_transport])
2184
2317
self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2188
super(BranchReferenceFormat, self).__init__()
2189
self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2190
self._matchingbzrdir.set_branch_format(self)
2192
2320
def _make_reference_clone_function(format, a_branch):
2193
2321
"""Create a clone() routine for a branch dynamically."""
2194
2322
def clone(to_bzrdir, revision_id=None,
2387
2563
"""See Branch.print_file."""
2388
2564
return self.repository.print_file(file, revision_id)
2390
def _write_revision_history(self, history):
2391
"""Factored out of set_revision_history.
2393
This performs the actual writing to disk.
2394
It is intended to be called by BzrBranch5.set_revision_history."""
2395
self._transport.put_bytes(
2396
'revision-history', '\n'.join(history),
2397
mode=self.bzrdir._get_file_mode())
2400
def set_revision_history(self, rev_history):
2401
"""See Branch.set_revision_history."""
2402
if 'evil' in debug.debug_flags:
2403
mutter_callsite(3, "set_revision_history scales with history.")
2404
check_not_reserved_id = _mod_revision.check_not_reserved_id
2405
for rev_id in rev_history:
2406
check_not_reserved_id(rev_id)
2407
if Branch.hooks['post_change_branch_tip']:
2408
# Don't calculate the last_revision_info() if there are no hooks
2410
old_revno, old_revid = self.last_revision_info()
2411
if len(rev_history) == 0:
2412
revid = _mod_revision.NULL_REVISION
2414
revid = rev_history[-1]
2415
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2416
self._write_revision_history(rev_history)
2417
self._clear_cached_state()
2418
self._cache_revision_history(rev_history)
2419
for hook in Branch.hooks['set_rh']:
2420
hook(self, rev_history)
2421
if Branch.hooks['post_change_branch_tip']:
2422
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2424
def _synchronize_history(self, destination, revision_id):
2425
"""Synchronize last revision and revision history between branches.
2427
This version is most efficient when the destination is also a
2428
BzrBranch5, but works for BzrBranch6 as long as the revision
2429
history is the true lefthand parent history, and all of the revisions
2430
are in the destination's repository. If not, set_revision_history
2433
:param destination: The branch to copy the history into
2434
:param revision_id: The revision-id to truncate history at. May
2435
be None to copy complete history.
2437
if not isinstance(destination._format, BzrBranchFormat5):
2438
super(BzrBranch, self)._synchronize_history(
2439
destination, revision_id)
2441
if revision_id == _mod_revision.NULL_REVISION:
2444
new_history = self.revision_history()
2445
if revision_id is not None and new_history != []:
2447
new_history = new_history[:new_history.index(revision_id) + 1]
2449
rev = self.repository.get_revision(revision_id)
2450
new_history = rev.get_history(self.repository)[1:]
2451
destination.set_revision_history(new_history)
2453
2566
@needs_write_lock
2454
2567
def set_last_revision_info(self, revno, revision_id):
2455
"""Set the last revision of this branch.
2457
The caller is responsible for checking that the revno is correct
2458
for this revision id.
2460
It may be possible to set the branch last revision to an id not
2461
present in the repository. However, branches can also be
2462
configured to check constraints on history, in which case this may not
2568
if not revision_id or not isinstance(revision_id, basestring):
2569
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2465
2570
revision_id = _mod_revision.ensure_null(revision_id)
2466
# this old format stores the full history, but this api doesn't
2467
# provide it, so we must generate, and might as well check it's
2469
history = self._lefthand_history(revision_id)
2470
if len(history) != revno:
2471
raise AssertionError('%d != %d' % (len(history), revno))
2472
self.set_revision_history(history)
2474
def _gen_revision_history(self):
2475
history = self._transport.get_bytes('revision-history').split('\n')
2476
if history[-1:] == ['']:
2477
# There shouldn't be a trailing newline, but just in case.
2482
def generate_revision_history(self, revision_id, last_rev=None,
2484
"""Create a new revision history that will finish with revision_id.
2486
:param revision_id: the new tip to use.
2487
:param last_rev: The previous last_revision. If not None, then this
2488
must be a ancestory of revision_id, or DivergedBranches is raised.
2489
:param other_branch: The other branch that DivergedBranches should
2490
raise with respect to.
2492
self.set_revision_history(self._lefthand_history(revision_id,
2493
last_rev, other_branch))
2571
old_revno, old_revid = self.last_revision_info()
2572
if self.get_append_revisions_only():
2573
self._check_history_violation(revision_id)
2574
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2575
self._write_last_revision_info(revno, revision_id)
2576
self._clear_cached_state()
2577
self._last_revision_info_cache = revno, revision_id
2578
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2495
2580
def basis_tree(self):
2496
2581
"""See Branch.basis_tree."""
2645
class BzrBranch8(BzrBranch5):
2702
def _read_last_revision_info(self):
2703
revision_string = self._transport.get_bytes('last-revision')
2704
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2705
revision_id = cache_utf8.get_cached_utf8(revision_id)
2707
return revno, revision_id
2709
def _write_last_revision_info(self, revno, revision_id):
2710
"""Simply write out the revision id, with no checks.
2712
Use set_last_revision_info to perform this safely.
2714
Does not update the revision_history cache.
2716
revision_id = _mod_revision.ensure_null(revision_id)
2717
out_string = '%d %s\n' % (revno, revision_id)
2718
self._transport.put_bytes('last-revision', out_string,
2719
mode=self.bzrdir._get_file_mode())
2722
def update_feature_flags(self, updated_flags):
2723
"""Update the feature flags for this branch.
2725
:param updated_flags: Dictionary mapping feature names to necessities
2726
A necessity can be None to indicate the feature should be removed
2728
self._format._update_feature_flags(updated_flags)
2729
self.control_transport.put_bytes('format', self._format.as_string())
2732
class FullHistoryBzrBranch(BzrBranch):
2733
"""Bzr branch which contains the full revision history."""
2736
def set_last_revision_info(self, revno, revision_id):
2737
if not revision_id or not isinstance(revision_id, basestring):
2738
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2739
revision_id = _mod_revision.ensure_null(revision_id)
2740
# this old format stores the full history, but this api doesn't
2741
# provide it, so we must generate, and might as well check it's
2743
history = self._lefthand_history(revision_id)
2744
if len(history) != revno:
2745
raise AssertionError('%d != %d' % (len(history), revno))
2746
self._set_revision_history(history)
2748
def _read_last_revision_info(self):
2749
rh = self._revision_history()
2752
return (revno, rh[-1])
2754
return (0, _mod_revision.NULL_REVISION)
2756
@deprecated_method(deprecated_in((2, 4, 0)))
2758
def set_revision_history(self, rev_history):
2759
"""See Branch.set_revision_history."""
2760
self._set_revision_history(rev_history)
2762
def _set_revision_history(self, rev_history):
2763
if 'evil' in debug.debug_flags:
2764
mutter_callsite(3, "set_revision_history scales with history.")
2765
check_not_reserved_id = _mod_revision.check_not_reserved_id
2766
for rev_id in rev_history:
2767
check_not_reserved_id(rev_id)
2768
if Branch.hooks['post_change_branch_tip']:
2769
# Don't calculate the last_revision_info() if there are no hooks
2771
old_revno, old_revid = self.last_revision_info()
2772
if len(rev_history) == 0:
2773
revid = _mod_revision.NULL_REVISION
2775
revid = rev_history[-1]
2776
self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2777
self._write_revision_history(rev_history)
2778
self._clear_cached_state()
2779
self._cache_revision_history(rev_history)
2780
for hook in Branch.hooks['set_rh']:
2781
hook(self, rev_history)
2782
if Branch.hooks['post_change_branch_tip']:
2783
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2785
def _write_revision_history(self, history):
2786
"""Factored out of set_revision_history.
2788
This performs the actual writing to disk.
2789
It is intended to be called by set_revision_history."""
2790
self._transport.put_bytes(
2791
'revision-history', '\n'.join(history),
2792
mode=self.bzrdir._get_file_mode())
2794
def _gen_revision_history(self):
2795
history = self._transport.get_bytes('revision-history').split('\n')
2796
if history[-1:] == ['']:
2797
# There shouldn't be a trailing newline, but just in case.
2801
def _synchronize_history(self, destination, revision_id):
2802
if not isinstance(destination, FullHistoryBzrBranch):
2803
super(BzrBranch, self)._synchronize_history(
2804
destination, revision_id)
2806
if revision_id == _mod_revision.NULL_REVISION:
2809
new_history = self._revision_history()
2810
if revision_id is not None and new_history != []:
2812
new_history = new_history[:new_history.index(revision_id) + 1]
2814
rev = self.repository.get_revision(revision_id)
2815
new_history = rev.get_history(self.repository)[1:]
2816
destination._set_revision_history(new_history)
2819
def generate_revision_history(self, revision_id, last_rev=None,
2821
"""Create a new revision history that will finish with revision_id.
2823
:param revision_id: the new tip to use.
2824
:param last_rev: The previous last_revision. If not None, then this
2825
must be a ancestory of revision_id, or DivergedBranches is raised.
2826
:param other_branch: The other branch that DivergedBranches should
2827
raise with respect to.
2829
self._set_revision_history(self._lefthand_history(revision_id,
2830
last_rev, other_branch))
2833
class BzrBranch5(FullHistoryBzrBranch):
2834
"""A format 5 branch. This supports new features over plain branches.
2836
It has support for a master_branch which is the data for bound branches.
2840
class BzrBranch8(BzrBranch):
2646
2841
"""A branch that stores tree-reference locations."""
2648
def _open_hook(self):
2843
def _open_hook(self, possible_transports=None):
2649
2844
if self._ignore_fallbacks:
2846
if possible_transports is None:
2847
possible_transports = [self.bzrdir.root_transport]
2652
2849
url = self.get_stacked_on_url()
2653
2850
except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2674
2872
self._last_revision_info_cache = None
2675
2873
self._reference_info = None
2677
def _last_revision_info(self):
2678
revision_string = self._transport.get_bytes('last-revision')
2679
revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2680
revision_id = cache_utf8.get_cached_utf8(revision_id)
2682
return revno, revision_id
2684
def _write_last_revision_info(self, revno, revision_id):
2685
"""Simply write out the revision id, with no checks.
2687
Use set_last_revision_info to perform this safely.
2689
Does not update the revision_history cache.
2690
Intended to be called by set_last_revision_info and
2691
_write_revision_history.
2693
revision_id = _mod_revision.ensure_null(revision_id)
2694
out_string = '%d %s\n' % (revno, revision_id)
2695
self._transport.put_bytes('last-revision', out_string,
2696
mode=self.bzrdir._get_file_mode())
2699
def set_last_revision_info(self, revno, revision_id):
2700
revision_id = _mod_revision.ensure_null(revision_id)
2701
old_revno, old_revid = self.last_revision_info()
2702
if self._get_append_revisions_only():
2703
self._check_history_violation(revision_id)
2704
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2705
self._write_last_revision_info(revno, revision_id)
2706
self._clear_cached_state()
2707
self._last_revision_info_cache = revno, revision_id
2708
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2710
def _synchronize_history(self, destination, revision_id):
2711
"""Synchronize last revision and revision history between branches.
2713
:see: Branch._synchronize_history
2715
# XXX: The base Branch has a fast implementation of this method based
2716
# on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2717
# that uses set_revision_history. This class inherits from BzrBranch5,
2718
# but wants the fast implementation, so it calls
2719
# Branch._synchronize_history directly.
2720
Branch._synchronize_history(self, destination, revision_id)
2722
2875
def _check_history_violation(self, revision_id):
2723
last_revision = _mod_revision.ensure_null(self.last_revision())
2876
current_revid = self.last_revision()
2877
last_revision = _mod_revision.ensure_null(current_revid)
2724
2878
if _mod_revision.is_null(last_revision):
2726
if last_revision not in self._lefthand_history(revision_id):
2727
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2880
graph = self.repository.get_graph()
2881
for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2882
if lh_ancestor == current_revid:
2884
raise errors.AppendRevisionsOnlyViolation(self.user_url)
2729
2886
def _gen_revision_history(self):
2730
2887
"""Generate the revision history from last revision
3182
3308
raise NotImplementedError(self.push)
3311
def copy_content_into(self, revision_id=None):
3312
"""Copy the content of source into target
3314
revision_id: if not None, the revision history in the new branch will
3315
be truncated to end with revision_id.
3317
raise NotImplementedError(self.copy_content_into)
3320
def fetch(self, stop_revision=None, limit=None):
3323
:param stop_revision: Last revision to fetch
3324
:param limit: Optional rough limit of revisions to fetch
3326
raise NotImplementedError(self.fetch)
3185
3329
class GenericInterBranch(InterBranch):
3186
"""InterBranch implementation that uses public Branch functions.
3190
def _get_branch_formats_to_test():
3191
return BranchFormat._default_format, BranchFormat._default_format
3193
def update_revisions(self, stop_revision=None, overwrite=False,
3195
"""See InterBranch.update_revisions()."""
3330
"""InterBranch implementation that uses public Branch functions."""
3333
def is_compatible(klass, source, target):
3334
# GenericBranch uses the public API, so always compatible
3338
def _get_branch_formats_to_test(klass):
3339
return [(format_registry.get_default(), format_registry.get_default())]
3342
def unwrap_format(klass, format):
3343
if isinstance(format, remote.RemoteBranchFormat):
3344
format._ensure_real()
3345
return format._custom_format
3349
def copy_content_into(self, revision_id=None):
3350
"""Copy the content of source into target
3352
revision_id: if not None, the revision history in the new branch will
3353
be truncated to end with revision_id.
3355
self.source.update_references(self.target)
3356
self.source._synchronize_history(self.target, revision_id)
3358
parent = self.source.get_parent()
3359
except errors.InaccessibleParent, e:
3360
mutter('parent was not accessible to copy: %s', e)
3363
self.target.set_parent(parent)
3364
if self.source._push_should_merge_tags():
3365
self.source.tags.merge_to(self.target.tags)
3368
def fetch(self, stop_revision=None, limit=None):
3369
if self.target.base == self.source.base:
3196
3371
self.source.lock_read()
3198
other_revno, other_last_revision = self.source.last_revision_info()
3199
stop_revno = None # unknown
3200
if stop_revision is None:
3201
stop_revision = other_last_revision
3202
if _mod_revision.is_null(stop_revision):
3203
# if there are no commits, we're done.
3205
stop_revno = other_revno
3207
# what's the current last revision, before we fetch [and change it
3209
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3210
# we fetch here so that we don't process data twice in the common
3211
# case of having something to pull, and so that the check for
3212
# already merged can operate on the just fetched graph, which will
3213
# be cached in memory.
3214
self.target.fetch(self.source, stop_revision)
3215
# Check to see if one is an ancestor of the other
3218
graph = self.target.repository.get_graph()
3219
if self.target._check_if_descendant_or_diverged(
3220
stop_revision, last_rev, graph, self.source):
3221
# stop_revision is a descendant of last_rev, but we aren't
3222
# overwriting, so we're done.
3224
if stop_revno is None:
3226
graph = self.target.repository.get_graph()
3227
this_revno, this_last_revision = \
3228
self.target.last_revision_info()
3229
stop_revno = graph.find_distance_to_null(stop_revision,
3230
[(other_last_revision, other_revno),
3231
(this_last_revision, this_revno)])
3232
self.target.set_last_revision_info(stop_revno, stop_revision)
3373
fetch_spec_factory = fetch.FetchSpecFactory()
3374
fetch_spec_factory.source_branch = self.source
3375
fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3376
fetch_spec_factory.source_repo = self.source.repository
3377
fetch_spec_factory.target_repo = self.target.repository
3378
fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3379
fetch_spec_factory.limit = limit
3380
fetch_spec = fetch_spec_factory.make_fetch_spec()
3381
return self.target.repository.fetch(self.source.repository,
3382
fetch_spec=fetch_spec)
3234
3384
self.source.unlock()
3387
def _update_revisions(self, stop_revision=None, overwrite=False,
3389
other_revno, other_last_revision = self.source.last_revision_info()
3390
stop_revno = None # unknown
3391
if stop_revision is None:
3392
stop_revision = other_last_revision
3393
if _mod_revision.is_null(stop_revision):
3394
# if there are no commits, we're done.
3396
stop_revno = other_revno
3398
# what's the current last revision, before we fetch [and change it
3400
last_rev = _mod_revision.ensure_null(self.target.last_revision())
3401
# we fetch here so that we don't process data twice in the common
3402
# case of having something to pull, and so that the check for
3403
# already merged can operate on the just fetched graph, which will
3404
# be cached in memory.
3405
self.fetch(stop_revision=stop_revision)
3406
# Check to see if one is an ancestor of the other
3409
graph = self.target.repository.get_graph()
3410
if self.target._check_if_descendant_or_diverged(
3411
stop_revision, last_rev, graph, self.source):
3412
# stop_revision is a descendant of last_rev, but we aren't
3413
# overwriting, so we're done.
3415
if stop_revno is None:
3417
graph = self.target.repository.get_graph()
3418
this_revno, this_last_revision = \
3419
self.target.last_revision_info()
3420
stop_revno = graph.find_distance_to_null(stop_revision,
3421
[(other_last_revision, other_revno),
3422
(this_last_revision, this_revno)])
3423
self.target.set_last_revision_info(stop_revno, stop_revision)
3236
3426
def pull(self, overwrite=False, stop_revision=None,
3427
possible_transports=None, run_hooks=True,
3428
_override_hook_target=None, local=False):
3429
"""Pull from source into self, updating my master if any.
3431
:param run_hooks: Private parameter - if false, this branch
3432
is being called because it's the master of the primary branch,
3433
so it should not run its hooks.
3435
bound_location = self.target.get_bound_location()
3436
if local and not bound_location:
3437
raise errors.LocalRequiresBoundBranch()
3438
master_branch = None
3439
source_is_master = False
3441
# bound_location comes from a config file, some care has to be
3442
# taken to relate it to source.user_url
3443
normalized = urlutils.normalize_url(bound_location)
3445
relpath = self.source.user_transport.relpath(normalized)
3446
source_is_master = (relpath == '')
3447
except (errors.PathNotChild, errors.InvalidURL):
3448
source_is_master = False
3449
if not local and bound_location and not source_is_master:
3450
# not pulling from master, so we need to update master.
3451
master_branch = self.target.get_master_branch(possible_transports)
3452
master_branch.lock_write()
3455
# pull from source into master.
3456
master_branch.pull(self.source, overwrite, stop_revision,
3458
return self._pull(overwrite,
3459
stop_revision, _hook_master=master_branch,
3460
run_hooks=run_hooks,
3461
_override_hook_target=_override_hook_target,
3462
merge_tags_to_master=not source_is_master)
3465
master_branch.unlock()
3467
def push(self, overwrite=False, stop_revision=None, lossy=False,
3468
_override_hook_source_branch=None):
3469
"""See InterBranch.push.
3471
This is the basic concrete implementation of push()
3473
:param _override_hook_source_branch: If specified, run the hooks
3474
passing this Branch as the source, rather than self. This is for
3475
use of RemoteBranch, where push is delegated to the underlying
3479
raise errors.LossyPushToSameVCS(self.source, self.target)
3480
# TODO: Public option to disable running hooks - should be trivial but
3483
op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3484
op.add_cleanup(self.source.lock_read().unlock)
3485
op.add_cleanup(self.target.lock_write().unlock)
3486
return op.run(overwrite, stop_revision,
3487
_override_hook_source_branch=_override_hook_source_branch)
3489
def _basic_push(self, overwrite, stop_revision):
3490
"""Basic implementation of push without bound branches or hooks.
3492
Must be called with source read locked and target write locked.
3494
result = BranchPushResult()
3495
result.source_branch = self.source
3496
result.target_branch = self.target
3497
result.old_revno, result.old_revid = self.target.last_revision_info()
3498
self.source.update_references(self.target)
3499
if result.old_revid != stop_revision:
3500
# We assume that during 'push' this repository is closer than
3502
graph = self.source.repository.get_graph(self.target.repository)
3503
self._update_revisions(stop_revision, overwrite=overwrite,
3505
if self.source._push_should_merge_tags():
3506
result.tag_updates, result.tag_conflicts = (
3507
self.source.tags.merge_to(self.target.tags, overwrite))
3508
result.new_revno, result.new_revid = self.target.last_revision_info()
3511
def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3512
_override_hook_source_branch=None):
3513
"""Push from source into target, and into target's master if any.
3516
if _override_hook_source_branch:
3517
result.source_branch = _override_hook_source_branch
3518
for hook in Branch.hooks['post_push']:
3521
bound_location = self.target.get_bound_location()
3522
if bound_location and self.target.base != bound_location:
3523
# there is a master branch.
3525
# XXX: Why the second check? Is it even supported for a branch to
3526
# be bound to itself? -- mbp 20070507
3527
master_branch = self.target.get_master_branch()
3528
master_branch.lock_write()
3529
operation.add_cleanup(master_branch.unlock)
3530
# push into the master from the source branch.
3531
master_inter = InterBranch.get(self.source, master_branch)
3532
master_inter._basic_push(overwrite, stop_revision)
3533
# and push into the target branch from the source. Note that
3534
# we push from the source branch again, because it's considered
3535
# the highest bandwidth repository.
3536
result = self._basic_push(overwrite, stop_revision)
3537
result.master_branch = master_branch
3538
result.local_branch = self.target
3540
master_branch = None
3542
result = self._basic_push(overwrite, stop_revision)
3543
# TODO: Why set master_branch and local_branch if there's no
3544
# binding? Maybe cleaner to just leave them unset? -- mbp
3546
result.master_branch = self.target
3547
result.local_branch = None
3551
def _pull(self, overwrite=False, stop_revision=None,
3237
3552
possible_transports=None, _hook_master=None, run_hooks=True,
3238
_override_hook_target=None, local=False):
3553
_override_hook_target=None, local=False,
3554
merge_tags_to_master=True):
3239
3555
"""See Branch.pull.
3557
This function is the core worker, used by GenericInterBranch.pull to
3558
avoid duplication when pulling source->master and source->local.
3241
3560
:param _hook_master: Private parameter - set the branch to
3242
3561
be supplied as the master to pull hooks.
3243
3562
:param run_hooks: Private parameter - if false, this branch
3244
3563
is being called because it's the master of the primary branch,
3245
3564
so it should not run its hooks.
3565
is being called because it's the master of the primary branch,
3566
so it should not run its hooks.
3246
3567
:param _override_hook_target: Private parameter - set the branch to be
3247
3568
supplied as the target_branch to pull hooks.
3248
3569
:param local: Only update the local branch, and not the bound branch.
3288
3610
self.source.unlock()
3291
def push(self, overwrite=False, stop_revision=None,
3292
_override_hook_source_branch=None):
3293
"""See InterBranch.push.
3295
This is the basic concrete implementation of push()
3297
:param _override_hook_source_branch: If specified, run
3298
the hooks passing this Branch as the source, rather than self.
3299
This is for use of RemoteBranch, where push is delegated to the
3300
underlying vfs-based Branch.
3302
# TODO: Public option to disable running hooks - should be trivial but
3304
self.source.lock_read()
3306
return _run_with_write_locked_target(
3307
self.target, self._push_with_bound_branches, overwrite,
3309
_override_hook_source_branch=_override_hook_source_branch)
3311
self.source.unlock()
3313
def _push_with_bound_branches(self, overwrite, stop_revision,
3314
_override_hook_source_branch=None):
3315
"""Push from source into target, and into target's master if any.
3318
if _override_hook_source_branch:
3319
result.source_branch = _override_hook_source_branch
3320
for hook in Branch.hooks['post_push']:
3323
bound_location = self.target.get_bound_location()
3324
if bound_location and self.target.base != bound_location:
3325
# there is a master branch.
3327
# XXX: Why the second check? Is it even supported for a branch to
3328
# be bound to itself? -- mbp 20070507
3329
master_branch = self.target.get_master_branch()
3330
master_branch.lock_write()
3332
# push into the master from the source branch.
3333
self.source._basic_push(master_branch, overwrite, stop_revision)
3334
# and push into the target branch from the source. Note that we
3335
# push from the source branch again, because its considered the
3336
# highest bandwidth repository.
3337
result = self.source._basic_push(self.target, overwrite,
3339
result.master_branch = master_branch
3340
result.local_branch = self.target
3344
master_branch.unlock()
3347
result = self.source._basic_push(self.target, overwrite,
3349
# TODO: Why set master_branch and local_branch if there's no
3350
# binding? Maybe cleaner to just leave them unset? -- mbp
3352
result.master_branch = self.target
3353
result.local_branch = None
3358
def is_compatible(self, source, target):
3359
# GenericBranch uses the public API, so always compatible
3363
class InterToBranch5(GenericInterBranch):
3366
def _get_branch_formats_to_test():
3367
return BranchFormat._default_format, BzrBranchFormat5()
3369
def pull(self, overwrite=False, stop_revision=None,
3370
possible_transports=None, run_hooks=True,
3371
_override_hook_target=None, local=False):
3372
"""Pull from source into self, updating my master if any.
3374
:param run_hooks: Private parameter - if false, this branch
3375
is being called because it's the master of the primary branch,
3376
so it should not run its hooks.
3378
bound_location = self.target.get_bound_location()
3379
if local and not bound_location:
3380
raise errors.LocalRequiresBoundBranch()
3381
master_branch = None
3382
if not local and bound_location and self.source.user_url != bound_location:
3383
# not pulling from master, so we need to update master.
3384
master_branch = self.target.get_master_branch(possible_transports)
3385
master_branch.lock_write()
3388
# pull from source into master.
3389
master_branch.pull(self.source, overwrite, stop_revision,
3391
return super(InterToBranch5, self).pull(overwrite,
3392
stop_revision, _hook_master=master_branch,
3393
run_hooks=run_hooks,
3394
_override_hook_target=_override_hook_target)
3397
master_branch.unlock()
3400
3614
InterBranch.register_optimiser(GenericInterBranch)
3401
InterBranch.register_optimiser(InterToBranch5)