1
# Copyright (C) 2006-2010 Canonical Ltd
1
# Copyright (C) 2006, 2007, 2008, 2009 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
30
repository as _mod_repository,
32
31
revision as _mod_revision,
36
34
from bzrlib.branch import BranchReferenceFormat
37
35
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
38
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
36
from bzrlib.decorators import needs_read_lock, needs_write_lock
39
37
from bzrlib.errors import (
41
39
SmartProtocolError,
91
89
class RemoteBzrDir(BzrDir, _RpcHelper):
92
90
"""Control directory on a remote server, accessed via bzr:// or similar."""
94
def __init__(self, transport, format, _client=None, _force_probe=False):
92
def __init__(self, transport, format, _client=None):
95
93
"""Construct a RemoteBzrDir.
97
95
:param _client: Private parameter for testing. Disables probing and the
101
99
# this object holds a delegated bzrdir that uses file-level operations
102
100
# to talk to the other side
103
101
self._real_bzrdir = None
104
self._has_working_tree = None
105
102
# 1-shot cache for the call pattern 'create_branch; open_branch' - see
106
103
# create_branch for details.
107
104
self._next_open_branch_result = None
111
108
self._client = client._SmartClient(medium)
113
110
self._client = _client
120
return '%s(%r)' % (self.__class__.__name__, self._client)
122
def _probe_bzrdir(self):
123
medium = self._client._medium
124
113
path = self._path_for_remote_call(self._client)
125
if medium._is_remote_before((2, 1)):
129
self._rpc_open_2_1(path)
131
except errors.UnknownSmartMethod:
132
medium._remember_remote_is_before((2, 1))
135
def _rpc_open_2_1(self, path):
136
response = self._call('BzrDir.open_2.1', path)
137
if response == ('no',):
138
raise errors.NotBranchError(path=self.root_transport.base)
139
elif response[0] == 'yes':
140
if response[1] == 'yes':
141
self._has_working_tree = True
142
elif response[1] == 'no':
143
self._has_working_tree = False
145
raise errors.UnexpectedSmartServerResponse(response)
147
raise errors.UnexpectedSmartServerResponse(response)
149
def _rpc_open(self, path):
150
114
response = self._call('BzrDir.open', path)
151
115
if response not in [('yes',), ('no',)]:
152
116
raise errors.UnexpectedSmartServerResponse(response)
153
117
if response == ('no',):
154
raise errors.NotBranchError(path=self.root_transport.base)
118
raise errors.NotBranchError(path=transport.base)
156
120
def _ensure_real(self):
157
121
"""Ensure that there is a _real_bzrdir set.
159
123
Used before calls to self._real_bzrdir.
161
125
if not self._real_bzrdir:
162
if 'hpssvfs' in debug.debug_flags:
164
warning('VFS BzrDir access triggered\n%s',
165
''.join(traceback.format_stack()))
166
126
self._real_bzrdir = BzrDir.open_from_transport(
167
127
self.root_transport, _server_formats=False)
168
128
self._format._network_name = \
244
204
self._ensure_real()
245
205
self._real_bzrdir.destroy_repository()
247
def create_branch(self, name=None):
207
def create_branch(self):
248
208
# as per meta1 formats - just delegate to the format object which may
249
209
# be parameterised.
250
real_branch = self._format.get_branch_format().initialize(self,
210
real_branch = self._format.get_branch_format().initialize(self)
252
211
if not isinstance(real_branch, RemoteBranch):
253
result = RemoteBranch(self, self.find_repository(), real_branch,
212
result = RemoteBranch(self, self.find_repository(), real_branch)
256
214
result = real_branch
257
215
# BzrDir.clone_on_transport() uses the result of create_branch but does
263
221
self._next_open_branch_result = result
266
def destroy_branch(self, name=None):
224
def destroy_branch(self):
267
225
"""See BzrDir.destroy_branch"""
268
226
self._ensure_real()
269
self._real_bzrdir.destroy_branch(name=name)
227
self._real_bzrdir.destroy_branch()
270
228
self._next_open_branch_result = None
272
230
def create_workingtree(self, revision_id=None, from_branch=None):
291
249
def _get_branch_reference(self):
292
250
path = self._path_for_remote_call(self._client)
293
251
medium = self._client._medium
295
('BzrDir.open_branchV3', (2, 1)),
296
('BzrDir.open_branchV2', (1, 13)),
297
('BzrDir.open_branch', None),
299
for verb, required_version in candidate_calls:
300
if required_version and medium._is_remote_before(required_version):
252
if not medium._is_remote_before((1, 13)):
303
response = self._call(verb, path)
254
response = self._call('BzrDir.open_branchV2', path)
255
if response[0] not in ('ref', 'branch'):
256
raise errors.UnexpectedSmartServerResponse(response)
304
258
except errors.UnknownSmartMethod:
305
if required_version is None:
307
medium._remember_remote_is_before(required_version)
310
if verb == 'BzrDir.open_branch':
311
if response[0] != 'ok':
312
raise errors.UnexpectedSmartServerResponse(response)
313
if response[1] != '':
314
return ('ref', response[1])
316
return ('branch', '')
317
if response[0] not in ('ref', 'branch'):
259
medium._remember_remote_is_before((1, 13))
260
response = self._call('BzrDir.open_branch', path)
261
if response[0] != 'ok':
318
262
raise errors.UnexpectedSmartServerResponse(response)
263
if response[1] != '':
264
return ('ref', response[1])
266
return ('branch', '')
321
268
def _get_tree_branch(self):
322
269
"""See BzrDir._get_tree_branch()."""
323
270
return None, self.open_branch()
325
def open_branch(self, name=None, unsupported=False,
326
ignore_fallbacks=False):
272
def open_branch(self, _unsupported=False, ignore_fallbacks=False):
328
274
raise NotImplementedError('unsupported flag support not implemented yet.')
329
275
if self._next_open_branch_result is not None:
330
276
# See create_branch for details.
335
281
if response[0] == 'ref':
336
282
# a branch reference, use the existing BranchReference logic.
337
283
format = BranchReferenceFormat()
338
return format.open(self, name=name, _found=True,
339
location=response[1], ignore_fallbacks=ignore_fallbacks)
284
return format.open(self, _found=True, location=response[1],
285
ignore_fallbacks=ignore_fallbacks)
340
286
branch_format_name = response[1]
341
287
if not branch_format_name:
342
288
branch_format_name = None
343
289
format = RemoteBranchFormat(network_name=branch_format_name)
344
290
return RemoteBranch(self, self.find_repository(), format=format,
345
setup_stacking=not ignore_fallbacks, name=name)
291
setup_stacking=not ignore_fallbacks)
347
293
def _open_repo_v1(self, path):
348
294
verb = 'BzrDir.find_repository'
410
356
raise errors.NoRepositoryPresent(self)
412
def has_workingtree(self):
413
if self._has_working_tree is None:
415
self._has_working_tree = self._real_bzrdir.has_workingtree()
416
return self._has_working_tree
418
358
def open_workingtree(self, recommend_upgrade=True):
419
if self.has_workingtree():
360
if self._real_bzrdir.has_workingtree():
420
361
raise errors.NotLocalUrl(self.root_transport)
422
363
raise errors.NoWorkingTree(self.root_transport.base)
425
366
"""Return the path to be used for this bzrdir in a remote call."""
426
367
return client.remote_path_from_transport(self.root_transport)
428
def get_branch_transport(self, branch_format, name=None):
369
def get_branch_transport(self, branch_format):
429
370
self._ensure_real()
430
return self._real_bzrdir.get_branch_transport(branch_format, name=name)
371
return self._real_bzrdir.get_branch_transport(branch_format)
432
373
def get_repository_transport(self, repository_format):
433
374
self._ensure_real()
620
557
return self._custom_format._fetch_reconcile
622
559
def get_format_description(self):
624
return 'Remote: ' + self._custom_format.get_format_description()
560
return 'bzr remote repository'
626
562
def __eq__(self, other):
627
563
return self.__class__ is other.__class__
565
def check_conversion_target(self, target_format):
566
if self.rich_root_data and not target_format.rich_root_data:
567
raise errors.BadConversionTarget(
568
'Does not support rich root data.', target_format)
569
if (self.supports_tree_reference and
570
not getattr(target_format, 'supports_tree_reference', False)):
571
raise errors.BadConversionTarget(
572
'Does not support nested trees', target_format)
629
574
def network_name(self):
630
575
if self._network_name:
631
576
return self._network_name
643
588
return self._custom_format._serializer
646
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
647
bzrdir.ControlComponent):
591
class RemoteRepository(_RpcHelper):
648
592
"""Repository accessed over rpc.
650
594
For the moment most operations are performed using local transport-backed
693
637
# Additional places to query for data.
694
638
self._fallback_repositories = []
697
def user_transport(self):
698
return self.bzrdir.user_transport
701
def control_transport(self):
702
# XXX: Normally you shouldn't directly get at the remote repository
703
# transport, but I'm not sure it's worth making this method
704
# optional -- mbp 2010-04-21
705
return self.bzrdir.get_repository_transport(None)
707
640
def __str__(self):
708
641
return "%s(%s)" % (self.__class__.__name__, self.base)
917
850
parents_provider = self._make_parents_provider(other_repository)
918
851
return graph.Graph(parents_provider)
921
def get_known_graph_ancestry(self, revision_ids):
922
"""Return the known graph for a set of revision ids and their ancestors.
924
st = static_tuple.StaticTuple
925
revision_keys = [st(r_id).intern() for r_id in revision_ids]
926
known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
927
return graph.GraphThunkIdsToKeys(known_graph)
929
853
def gather_stats(self, revid=None, committers=None):
930
854
"""See Repository.gather_stats()."""
931
855
path = self.bzrdir._path_for_remote_call(self._client)
991
915
def is_write_locked(self):
992
916
return self._lock_mode == 'w'
994
def _warn_if_deprecated(self, branch=None):
995
# If we have a real repository, the check will be done there, if we
996
# don't the check will be done remotely.
999
918
def lock_read(self):
1000
919
# wrong eventually - want a local lock cache context
1001
920
if not self._lock_mode:
1002
self._note_lock('r')
1003
921
self._lock_mode = 'r'
1004
922
self._lock_count = 1
1005
923
self._unstacked_provider.enable_cache(cache_misses=True)
1240
1156
# state, so always add a lock here. If a caller passes us a locked
1241
1157
# repository, they are responsible for unlocking it later.
1242
1158
repository.lock_read()
1243
self._check_fallback_repository(repository)
1244
1159
self._fallback_repositories.append(repository)
1245
1160
# If self._real_repository was parameterised already (e.g. because a
1246
1161
# _real_branch had its get_stacked_on_url method called), then the
1247
1162
# repository to be added may already be in the _real_repositories list.
1248
1163
if self._real_repository is not None:
1249
fallback_locations = [repo.user_url for repo in
1164
fallback_locations = [repo.bzrdir.root_transport.base for repo in
1250
1165
self._real_repository._fallback_repositories]
1251
if repository.user_url not in fallback_locations:
1166
if repository.bzrdir.root_transport.base not in fallback_locations:
1252
1167
self._real_repository.add_fallback_repository(repository)
1254
def _check_fallback_repository(self, repository):
1255
"""Check that this repository can fallback to repository safely.
1257
Raise an error if not.
1259
:param repository: A repository to fallback to.
1261
return _mod_repository.InterRepository._assert_same_model(
1264
1169
def add_inventory(self, revid, inv, parents):
1265
1170
self._ensure_real()
1266
1171
return self._real_repository.add_inventory(revid, inv, parents)
1268
1173
def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1269
parents, basis_inv=None, propagate_caches=False):
1270
1175
self._ensure_real()
1271
1176
return self._real_repository.add_inventory_by_delta(basis_revision_id,
1272
delta, new_revision_id, parents, basis_inv=basis_inv,
1273
propagate_caches=propagate_caches)
1177
delta, new_revision_id, parents)
1275
1179
def add_revision(self, rev_id, rev, inv=None, config=None):
1276
1180
self._ensure_real()
1282
1186
self._ensure_real()
1283
1187
return self._real_repository.get_inventory(revision_id)
1285
def iter_inventories(self, revision_ids, ordering=None):
1189
def iter_inventories(self, revision_ids, ordering='unordered'):
1286
1190
self._ensure_real()
1287
1191
return self._real_repository.iter_inventories(revision_ids, ordering)
1535
1439
return self._real_repository.get_signature_text(revision_id)
1537
1441
@needs_read_lock
1538
def _get_inventory_xml(self, revision_id):
1540
return self._real_repository._get_inventory_xml(revision_id)
1442
def get_inventory_xml(self, revision_id):
1444
return self._real_repository.get_inventory_xml(revision_id)
1446
def deserialise_inventory(self, revision_id, xml):
1448
return self._real_repository.deserialise_inventory(revision_id, xml)
1542
1450
def reconcile(self, other=None, thorough=False):
1543
1451
self._ensure_real()
1619
1527
return self._real_repository.inventories
1621
1529
@needs_write_lock
1622
def pack(self, hint=None, clean_obsolete_packs=False):
1530
def pack(self, hint=None):
1623
1531
"""Compress the data within the repository.
1625
1533
This is not currently implemented within the smart server.
1627
1535
self._ensure_real()
1628
return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
1536
return self._real_repository.pack(hint=hint)
1631
1539
def revisions(self):
1782
1690
def insert_stream(self, stream, src_format, resume_tokens):
1783
1691
target = self.target_repo
1784
1692
target._unstacked_provider.missing_keys.clear()
1785
candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
1693
candidate_calls = [('Repository.insert_stream_1.18', (1, 18))]
1786
1694
if target._lock_token:
1787
1695
candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
1788
1696
lock_args = (target._lock_token or '',)
1819
1727
return self._insert_real(stream, src_format, resume_tokens)
1820
1728
self._last_inv_record = None
1821
1729
self._last_substream = None
1822
if required_version < (1, 19):
1730
if required_version < (1, 18):
1823
1731
# Remote side doesn't support inventory deltas. Wrap the stream to
1824
1732
# make sure we don't send any. If the stream contains inventory
1825
1733
# deltas we'll interrupt the smart insert_stream request and
1836
1744
# The stream included an inventory-delta record, but the remote
1837
1745
# side isn't new enough to support them. So we need to send the
1838
1746
# rest of the stream via VFS.
1839
self.target_repo.refresh_data()
1840
1747
return self._resume_stream_with_vfs(response, src_format)
1841
1748
if response[0][0] == 'missing-basis':
1842
1749
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1924
1831
source = repo._get_source(self.to_format)
1925
1832
if isinstance(source, RemoteStreamSource):
1927
source = repo._real_repository._get_source(self.to_format)
1833
return repository.StreamSource.get_stream(source, search)
1928
1834
return source.get_stream(search)
1930
1836
def _get_stream(self, repo, search):
1951
1857
search_bytes = repo._serialise_search_result(search)
1952
1858
args = (path, self.to_format.network_name())
1953
1859
candidate_verbs = [
1954
('Repository.get_stream_1.19', (1, 19)),
1860
('Repository.get_stream_1.18', (1, 18)),
1955
1861
('Repository.get_stream', (1, 13))]
1956
1862
found_verb = False
1957
1863
for verb, version in candidate_verbs:
1984
1890
:param search: The overall search to satisfy with streams.
1985
1891
:param sources: A list of Repository objects to query.
1987
self.from_serialiser = self.from_repository._format._serializer
1893
self.serialiser = self.to_format._serializer
1988
1894
self.seen_revs = set()
1989
1895
self.referenced_revs = set()
1990
1896
# If there are heads in the search, or the key count is > 0, we are not
2007
1913
def missing_parents_rev_handler(self, substream):
2008
1914
for content in substream:
2009
1915
revision_bytes = content.get_bytes_as('fulltext')
2010
revision = self.from_serialiser.read_revision_from_string(
1916
revision = self.serialiser.read_revision_from_string(revision_bytes)
2012
1917
self.seen_revs.add(content.key[-1])
2013
1918
self.referenced_revs.update(revision.parent_ids)
2053
1958
self._network_name)
2055
1960
def get_format_description(self):
2057
return 'Remote: ' + self._custom_format.get_format_description()
1961
return 'Remote BZR Branch'
2059
1963
def network_name(self):
2060
1964
return self._network_name
2062
def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
2063
return a_bzrdir.open_branch(name=name,
2064
ignore_fallbacks=ignore_fallbacks)
1966
def open(self, a_bzrdir, ignore_fallbacks=False):
1967
return a_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2066
def _vfs_initialize(self, a_bzrdir, name):
1969
def _vfs_initialize(self, a_bzrdir):
2067
1970
# Initialisation when using a local bzrdir object, or a non-vfs init
2068
1971
# method is not available on the server.
2069
1972
# self._custom_format is always set - the start of initialize ensures
2071
1974
if isinstance(a_bzrdir, RemoteBzrDir):
2072
1975
a_bzrdir._ensure_real()
2073
result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
1976
result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
2076
1978
# We assume the bzrdir is parameterised; it may not be.
2077
result = self._custom_format.initialize(a_bzrdir, name)
1979
result = self._custom_format.initialize(a_bzrdir)
2078
1980
if (isinstance(a_bzrdir, RemoteBzrDir) and
2079
1981
not isinstance(result, RemoteBranch)):
2080
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
1982
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
2084
def initialize(self, a_bzrdir, name=None):
1985
def initialize(self, a_bzrdir):
2085
1986
# 1) get the network name to use.
2086
1987
if self._custom_format:
2087
1988
network_name = self._custom_format.network_name()
2093
1994
network_name = reference_format.network_name()
2094
1995
# Being asked to create on a non RemoteBzrDir:
2095
1996
if not isinstance(a_bzrdir, RemoteBzrDir):
2096
return self._vfs_initialize(a_bzrdir, name=name)
1997
return self._vfs_initialize(a_bzrdir)
2097
1998
medium = a_bzrdir._client._medium
2098
1999
if medium._is_remote_before((1, 13)):
2099
return self._vfs_initialize(a_bzrdir, name=name)
2000
return self._vfs_initialize(a_bzrdir)
2100
2001
# Creating on a remote bzr dir.
2101
2002
# 2) try direct creation via RPC
2102
2003
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2103
if name is not None:
2104
# XXX JRV20100304: Support creating colocated branches
2105
raise errors.NoColocatedBranchSupport(self)
2106
2004
verb = 'BzrDir.create_branch'
2108
2006
response = a_bzrdir._call(verb, path, network_name)
2109
2007
except errors.UnknownSmartMethod:
2110
2008
# Fallback - use vfs methods
2111
2009
medium._remember_remote_is_before((1, 13))
2112
return self._vfs_initialize(a_bzrdir, name=name)
2010
return self._vfs_initialize(a_bzrdir)
2113
2011
if response[0] != 'ok':
2114
2012
raise errors.UnexpectedSmartServerResponse(response)
2115
2013
# Turn the response into a RemoteRepository object.
2123
2021
a_bzrdir._client)
2124
2022
remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2125
2023
remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2126
format=format, setup_stacking=False, name=name)
2024
format=format, setup_stacking=False)
2127
2025
# XXX: We know this is a new branch, so it must have revno 0, revid
2128
2026
# NULL_REVISION. Creating the branch locked would make this be unable
2129
2027
# to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2149
2047
return self._custom_format.supports_set_append_revisions_only()
2152
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
2050
class RemoteBranch(branch.Branch, _RpcHelper):
2153
2051
"""Branch stored on a server accessed by HPSS RPC.
2155
2053
At the moment most operations are mapped down to simple file operations.
2158
2056
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2159
_client=None, format=None, setup_stacking=True, name=None):
2057
_client=None, format=None, setup_stacking=True):
2160
2058
"""Create a RemoteBranch instance.
2162
2060
:param real_branch: An optional local implementation of the branch
2168
2066
:param setup_stacking: If True make an RPC call to determine the
2169
2067
stacked (or not) status of the branch. If False assume the branch
2170
2068
is not stacked.
2171
:param name: Colocated branch name
2173
2070
# We intentionally don't call the parent class's __init__, because it
2174
2071
# will try to assign to self.tags, which is a property in this subclass.
2193
2090
self._real_branch = None
2194
2091
# Fill out expected attributes of branch for bzrlib API users.
2195
2092
self._clear_cached_state()
2196
# TODO: deprecate self.base in favor of user_url
2197
self.base = self.bzrdir.user_url
2093
self.base = self.bzrdir.root_transport.base
2199
2094
self._control_files = None
2200
2095
self._lock_mode = None
2201
2096
self._lock_token = None
2212
2107
self._real_branch._format.network_name()
2214
2109
self._format = format
2215
# when we do _ensure_real we may need to pass ignore_fallbacks to the
2216
# branch.open_branch method.
2217
self._real_ignore_fallbacks = not setup_stacking
2218
2110
if not self._format._network_name:
2219
2111
# Did not get from open_branchV2 - old server.
2220
2112
self._ensure_real()
2265
2157
raise AssertionError('smart server vfs must be enabled '
2266
2158
'to use vfs implementation')
2267
2159
self.bzrdir._ensure_real()
2268
self._real_branch = self.bzrdir._real_bzrdir.open_branch(
2269
ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
2160
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
2270
2161
if self.repository._real_repository is None:
2271
2162
# Give the remote repository the matching real repo.
2272
2163
real_repo = self._real_branch.repository
2376
2267
medium = self._client._medium
2377
2268
if medium._is_remote_before((1, 18)):
2378
2269
self._vfs_set_tags_bytes(bytes)
2382
2272
self._remote_path(), self._lock_token, self._repo_lock_token)
2873
2759
'Missing key %r in context %r', key_err.args[0], context)
2876
if err.error_verb == 'IncompatibleRepositories':
2877
raise errors.IncompatibleRepositories(err.error_args[0],
2878
err.error_args[1], err.error_args[2])
2879
elif err.error_verb == 'NoSuchRevision':
2762
if err.error_verb == 'NoSuchRevision':
2880
2763
raise NoSuchRevision(find('branch'), err.error_args[0])
2881
2764
elif err.error_verb == 'nosuchrevision':
2882
2765
raise NoSuchRevision(find('repository'), err.error_args[0])
2883
elif err.error_verb == 'nobranch':
2884
if len(err.error_args) >= 1:
2885
extra = err.error_args[0]
2888
raise errors.NotBranchError(path=find('bzrdir').root_transport.base,
2766
elif err.error_tuple == ('nobranch',):
2767
raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2890
2768
elif err.error_verb == 'norepository':
2891
2769
raise errors.NoRepositoryPresent(find('bzrdir'))
2892
2770
elif err.error_verb == 'LockContention':
added
removed
bzrlib/remote.py
