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
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
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,
43
41
from bzrlib.lockable_files import LockableFiles
44
42
from bzrlib.smart import client, vfs, repository as smart_repo
45
43
from bzrlib.revision import ensure_null, NULL_REVISION
46
from bzrlib.repository import RepositoryWriteLockResult
47
44
from bzrlib.trace import mutter, note, warning
92
89
class RemoteBzrDir(BzrDir, _RpcHelper):
93
90
"""Control directory on a remote server, accessed via bzr:// or similar."""
95
def __init__(self, transport, format, _client=None, _force_probe=False):
92
def __init__(self, transport, format, _client=None):
96
93
"""Construct a RemoteBzrDir.
98
95
:param _client: Private parameter for testing. Disables probing and the
102
99
# this object holds a delegated bzrdir that uses file-level operations
103
100
# to talk to the other side
104
101
self._real_bzrdir = None
105
self._has_working_tree = None
106
102
# 1-shot cache for the call pattern 'create_branch; open_branch' - see
107
103
# create_branch for details.
108
104
self._next_open_branch_result = None
112
108
self._client = client._SmartClient(medium)
114
110
self._client = _client
121
return '%s(%r)' % (self.__class__.__name__, self._client)
123
def _probe_bzrdir(self):
124
medium = self._client._medium
125
113
path = self._path_for_remote_call(self._client)
126
if medium._is_remote_before((2, 1)):
130
self._rpc_open_2_1(path)
132
except errors.UnknownSmartMethod:
133
medium._remember_remote_is_before((2, 1))
136
def _rpc_open_2_1(self, path):
137
response = self._call('BzrDir.open_2.1', path)
138
if response == ('no',):
139
raise errors.NotBranchError(path=self.root_transport.base)
140
elif response[0] == 'yes':
141
if response[1] == 'yes':
142
self._has_working_tree = True
143
elif response[1] == 'no':
144
self._has_working_tree = False
146
raise errors.UnexpectedSmartServerResponse(response)
148
raise errors.UnexpectedSmartServerResponse(response)
150
def _rpc_open(self, path):
151
114
response = self._call('BzrDir.open', path)
152
115
if response not in [('yes',), ('no',)]:
153
116
raise errors.UnexpectedSmartServerResponse(response)
154
117
if response == ('no',):
155
raise errors.NotBranchError(path=self.root_transport.base)
118
raise errors.NotBranchError(path=transport.base)
157
120
def _ensure_real(self):
158
121
"""Ensure that there is a _real_bzrdir set.
160
123
Used before calls to self._real_bzrdir.
162
125
if not self._real_bzrdir:
163
if 'hpssvfs' in debug.debug_flags:
165
warning('VFS BzrDir access triggered\n%s',
166
''.join(traceback.format_stack()))
167
126
self._real_bzrdir = BzrDir.open_from_transport(
168
127
self.root_transport, _server_formats=False)
169
128
self._format._network_name = \
245
204
self._ensure_real()
246
205
self._real_bzrdir.destroy_repository()
248
def create_branch(self, name=None):
207
def create_branch(self):
249
208
# as per meta1 formats - just delegate to the format object which may
250
209
# be parameterised.
251
real_branch = self._format.get_branch_format().initialize(self,
210
real_branch = self._format.get_branch_format().initialize(self)
253
211
if not isinstance(real_branch, RemoteBranch):
254
result = RemoteBranch(self, self.find_repository(), real_branch,
212
result = RemoteBranch(self, self.find_repository(), real_branch)
257
214
result = real_branch
258
215
# BzrDir.clone_on_transport() uses the result of create_branch but does
264
221
self._next_open_branch_result = result
267
def destroy_branch(self, name=None):
224
def destroy_branch(self):
268
225
"""See BzrDir.destroy_branch"""
269
226
self._ensure_real()
270
self._real_bzrdir.destroy_branch(name=name)
227
self._real_bzrdir.destroy_branch()
271
228
self._next_open_branch_result = None
273
230
def create_workingtree(self, revision_id=None, from_branch=None):
292
249
def _get_branch_reference(self):
293
250
path = self._path_for_remote_call(self._client)
294
251
medium = self._client._medium
296
('BzrDir.open_branchV3', (2, 1)),
297
('BzrDir.open_branchV2', (1, 13)),
298
('BzrDir.open_branch', None),
300
for verb, required_version in candidate_calls:
301
if required_version and medium._is_remote_before(required_version):
252
if not medium._is_remote_before((1, 13)):
304
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)
305
258
except errors.UnknownSmartMethod:
306
if required_version is None:
308
medium._remember_remote_is_before(required_version)
311
if verb == 'BzrDir.open_branch':
312
if response[0] != 'ok':
313
raise errors.UnexpectedSmartServerResponse(response)
314
if response[1] != '':
315
return ('ref', response[1])
317
return ('branch', '')
318
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':
319
262
raise errors.UnexpectedSmartServerResponse(response)
263
if response[1] != '':
264
return ('ref', response[1])
266
return ('branch', '')
322
268
def _get_tree_branch(self):
323
269
"""See BzrDir._get_tree_branch()."""
324
270
return None, self.open_branch()
326
def open_branch(self, name=None, unsupported=False,
327
ignore_fallbacks=False):
272
def open_branch(self, _unsupported=False, ignore_fallbacks=False):
329
274
raise NotImplementedError('unsupported flag support not implemented yet.')
330
275
if self._next_open_branch_result is not None:
331
276
# See create_branch for details.
336
281
if response[0] == 'ref':
337
282
# a branch reference, use the existing BranchReference logic.
338
283
format = BranchReferenceFormat()
339
return format.open(self, name=name, _found=True,
340
location=response[1], ignore_fallbacks=ignore_fallbacks)
284
return format.open(self, _found=True, location=response[1],
285
ignore_fallbacks=ignore_fallbacks)
341
286
branch_format_name = response[1]
342
287
if not branch_format_name:
343
288
branch_format_name = None
344
289
format = RemoteBranchFormat(network_name=branch_format_name)
345
290
return RemoteBranch(self, self.find_repository(), format=format,
346
setup_stacking=not ignore_fallbacks, name=name)
291
setup_stacking=not ignore_fallbacks)
348
293
def _open_repo_v1(self, path):
349
294
verb = 'BzrDir.find_repository'
411
356
raise errors.NoRepositoryPresent(self)
413
def has_workingtree(self):
414
if self._has_working_tree is None:
416
self._has_working_tree = self._real_bzrdir.has_workingtree()
417
return self._has_working_tree
419
358
def open_workingtree(self, recommend_upgrade=True):
420
if self.has_workingtree():
360
if self._real_bzrdir.has_workingtree():
421
361
raise errors.NotLocalUrl(self.root_transport)
423
363
raise errors.NoWorkingTree(self.root_transport.base)
426
366
"""Return the path to be used for this bzrdir in a remote call."""
427
367
return client.remote_path_from_transport(self.root_transport)
429
def get_branch_transport(self, branch_format, name=None):
369
def get_branch_transport(self, branch_format):
430
370
self._ensure_real()
431
return self._real_bzrdir.get_branch_transport(branch_format, name=name)
371
return self._real_bzrdir.get_branch_transport(branch_format)
433
373
def get_repository_transport(self, repository_format):
434
374
self._ensure_real()
644
583
return self._custom_format._serializer
647
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
648
bzrdir.ControlComponent):
586
class RemoteRepository(_RpcHelper):
649
587
"""Repository accessed over rpc.
651
589
For the moment most operations are performed using local transport-backed
694
632
# Additional places to query for data.
695
633
self._fallback_repositories = []
698
def user_transport(self):
699
return self.bzrdir.user_transport
702
def control_transport(self):
703
# XXX: Normally you shouldn't directly get at the remote repository
704
# transport, but I'm not sure it's worth making this method
705
# optional -- mbp 2010-04-21
706
return self.bzrdir.get_repository_transport(None)
708
635
def __str__(self):
709
636
return "%s(%s)" % (self.__class__.__name__, self.base)
918
845
parents_provider = self._make_parents_provider(other_repository)
919
846
return graph.Graph(parents_provider)
922
def get_known_graph_ancestry(self, revision_ids):
923
"""Return the known graph for a set of revision ids and their ancestors.
925
st = static_tuple.StaticTuple
926
revision_keys = [st(r_id).intern() for r_id in revision_ids]
927
known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
928
return graph.GraphThunkIdsToKeys(known_graph)
930
848
def gather_stats(self, revid=None, committers=None):
931
849
"""See Repository.gather_stats()."""
932
850
path = self.bzrdir._path_for_remote_call(self._client)
992
910
def is_write_locked(self):
993
911
return self._lock_mode == 'w'
995
def _warn_if_deprecated(self, branch=None):
996
# If we have a real repository, the check will be done there, if we
997
# don't the check will be done remotely.
1000
913
def lock_read(self):
1001
"""Lock the repository for read operations.
1003
:return: An object with an unlock method which will release the lock
1006
914
# wrong eventually - want a local lock cache context
1007
915
if not self._lock_mode:
1008
self._note_lock('r')
1009
916
self._lock_mode = 'r'
1010
917
self._lock_count = 1
1011
918
self._unstacked_provider.enable_cache(cache_misses=True)
1247
1151
# state, so always add a lock here. If a caller passes us a locked
1248
1152
# repository, they are responsible for unlocking it later.
1249
1153
repository.lock_read()
1250
self._check_fallback_repository(repository)
1251
1154
self._fallback_repositories.append(repository)
1252
1155
# If self._real_repository was parameterised already (e.g. because a
1253
1156
# _real_branch had its get_stacked_on_url method called), then the
1254
1157
# repository to be added may already be in the _real_repositories list.
1255
1158
if self._real_repository is not None:
1256
fallback_locations = [repo.user_url for repo in
1159
fallback_locations = [repo.bzrdir.root_transport.base for repo in
1257
1160
self._real_repository._fallback_repositories]
1258
if repository.user_url not in fallback_locations:
1161
if repository.bzrdir.root_transport.base not in fallback_locations:
1259
1162
self._real_repository.add_fallback_repository(repository)
1261
def _check_fallback_repository(self, repository):
1262
"""Check that this repository can fallback to repository safely.
1264
Raise an error if not.
1266
:param repository: A repository to fallback to.
1268
return _mod_repository.InterRepository._assert_same_model(
1271
1164
def add_inventory(self, revid, inv, parents):
1272
1165
self._ensure_real()
1273
1166
return self._real_repository.add_inventory(revid, inv, parents)
1275
1168
def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1276
parents, basis_inv=None, propagate_caches=False):
1277
1170
self._ensure_real()
1278
1171
return self._real_repository.add_inventory_by_delta(basis_revision_id,
1279
delta, new_revision_id, parents, basis_inv=basis_inv,
1280
propagate_caches=propagate_caches)
1172
delta, new_revision_id, parents)
1282
1174
def add_revision(self, rev_id, rev, inv=None, config=None):
1283
1175
self._ensure_real()
1542
1434
return self._real_repository.get_signature_text(revision_id)
1544
1436
@needs_read_lock
1545
def _get_inventory_xml(self, revision_id):
1547
return self._real_repository._get_inventory_xml(revision_id)
1437
def get_inventory_xml(self, revision_id):
1439
return self._real_repository.get_inventory_xml(revision_id)
1441
def deserialise_inventory(self, revision_id, xml):
1443
return self._real_repository.deserialise_inventory(revision_id, xml)
1549
1445
def reconcile(self, other=None, thorough=False):
1550
1446
self._ensure_real()
1626
1522
return self._real_repository.inventories
1628
1524
@needs_write_lock
1629
def pack(self, hint=None, clean_obsolete_packs=False):
1525
def pack(self, hint=None):
1630
1526
"""Compress the data within the repository.
1632
1528
This is not currently implemented within the smart server.
1634
1530
self._ensure_real()
1635
return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
1531
return self._real_repository.pack(hint=hint)
1638
1534
def revisions(self):
1843
1739
# The stream included an inventory-delta record, but the remote
1844
1740
# side isn't new enough to support them. So we need to send the
1845
1741
# rest of the stream via VFS.
1846
self.target_repo.refresh_data()
1847
1742
return self._resume_stream_with_vfs(response, src_format)
1848
1743
if response[0][0] == 'missing-basis':
1849
1744
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1991
1886
:param search: The overall search to satisfy with streams.
1992
1887
:param sources: A list of Repository objects to query.
1994
self.from_serialiser = self.from_repository._format._serializer
1889
self.serialiser = self.to_format._serializer
1995
1890
self.seen_revs = set()
1996
1891
self.referenced_revs = set()
1997
1892
# If there are heads in the search, or the key count is > 0, we are not
2014
1909
def missing_parents_rev_handler(self, substream):
2015
1910
for content in substream:
2016
1911
revision_bytes = content.get_bytes_as('fulltext')
2017
revision = self.from_serialiser.read_revision_from_string(
1912
revision = self.serialiser.read_revision_from_string(revision_bytes)
2019
1913
self.seen_revs.add(content.key[-1])
2020
1914
self.referenced_revs.update(revision.parent_ids)
2060
1954
self._network_name)
2062
1956
def get_format_description(self):
2064
return 'Remote: ' + self._custom_format.get_format_description()
1957
return 'Remote BZR Branch'
2066
1959
def network_name(self):
2067
1960
return self._network_name
2069
def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
2070
return a_bzrdir.open_branch(name=name,
2071
ignore_fallbacks=ignore_fallbacks)
1962
def open(self, a_bzrdir, ignore_fallbacks=False):
1963
return a_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2073
def _vfs_initialize(self, a_bzrdir, name):
1965
def _vfs_initialize(self, a_bzrdir):
2074
1966
# Initialisation when using a local bzrdir object, or a non-vfs init
2075
1967
# method is not available on the server.
2076
1968
# self._custom_format is always set - the start of initialize ensures
2078
1970
if isinstance(a_bzrdir, RemoteBzrDir):
2079
1971
a_bzrdir._ensure_real()
2080
result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
1972
result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
2083
1974
# We assume the bzrdir is parameterised; it may not be.
2084
result = self._custom_format.initialize(a_bzrdir, name)
1975
result = self._custom_format.initialize(a_bzrdir)
2085
1976
if (isinstance(a_bzrdir, RemoteBzrDir) and
2086
1977
not isinstance(result, RemoteBranch)):
2087
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
1978
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
2091
def initialize(self, a_bzrdir, name=None):
1981
def initialize(self, a_bzrdir):
2092
1982
# 1) get the network name to use.
2093
1983
if self._custom_format:
2094
1984
network_name = self._custom_format.network_name()
2100
1990
network_name = reference_format.network_name()
2101
1991
# Being asked to create on a non RemoteBzrDir:
2102
1992
if not isinstance(a_bzrdir, RemoteBzrDir):
2103
return self._vfs_initialize(a_bzrdir, name=name)
1993
return self._vfs_initialize(a_bzrdir)
2104
1994
medium = a_bzrdir._client._medium
2105
1995
if medium._is_remote_before((1, 13)):
2106
return self._vfs_initialize(a_bzrdir, name=name)
1996
return self._vfs_initialize(a_bzrdir)
2107
1997
# Creating on a remote bzr dir.
2108
1998
# 2) try direct creation via RPC
2109
1999
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2110
if name is not None:
2111
# XXX JRV20100304: Support creating colocated branches
2112
raise errors.NoColocatedBranchSupport(self)
2113
2000
verb = 'BzrDir.create_branch'
2115
2002
response = a_bzrdir._call(verb, path, network_name)
2116
2003
except errors.UnknownSmartMethod:
2117
2004
# Fallback - use vfs methods
2118
2005
medium._remember_remote_is_before((1, 13))
2119
return self._vfs_initialize(a_bzrdir, name=name)
2006
return self._vfs_initialize(a_bzrdir)
2120
2007
if response[0] != 'ok':
2121
2008
raise errors.UnexpectedSmartServerResponse(response)
2122
2009
# Turn the response into a RemoteRepository object.
2130
2017
a_bzrdir._client)
2131
2018
remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2132
2019
remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2133
format=format, setup_stacking=False, name=name)
2020
format=format, setup_stacking=False)
2134
2021
# XXX: We know this is a new branch, so it must have revno 0, revid
2135
2022
# NULL_REVISION. Creating the branch locked would make this be unable
2136
2023
# to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2156
2043
return self._custom_format.supports_set_append_revisions_only()
2159
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
2046
class RemoteBranch(branch.Branch, _RpcHelper):
2160
2047
"""Branch stored on a server accessed by HPSS RPC.
2162
2049
At the moment most operations are mapped down to simple file operations.
2165
2052
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2166
_client=None, format=None, setup_stacking=True, name=None):
2053
_client=None, format=None, setup_stacking=True):
2167
2054
"""Create a RemoteBranch instance.
2169
2056
:param real_branch: An optional local implementation of the branch
2175
2062
:param setup_stacking: If True make an RPC call to determine the
2176
2063
stacked (or not) status of the branch. If False assume the branch
2177
2064
is not stacked.
2178
:param name: Colocated branch name
2180
2066
# We intentionally don't call the parent class's __init__, because it
2181
2067
# will try to assign to self.tags, which is a property in this subclass.
2200
2086
self._real_branch = None
2201
2087
# Fill out expected attributes of branch for bzrlib API users.
2202
2088
self._clear_cached_state()
2203
# TODO: deprecate self.base in favor of user_url
2204
self.base = self.bzrdir.user_url
2089
self.base = self.bzrdir.root_transport.base
2206
2090
self._control_files = None
2207
2091
self._lock_mode = None
2208
2092
self._lock_token = None
2273
2157
'to use vfs implementation')
2274
2158
self.bzrdir._ensure_real()
2275
2159
self._real_branch = self.bzrdir._real_bzrdir.open_branch(
2276
ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
2160
ignore_fallbacks=self._real_ignore_fallbacks)
2277
2161
if self.repository._real_repository is None:
2278
2162
# Give the remote repository the matching real repo.
2279
2163
real_repo = self._real_branch.repository
2383
2267
medium = self._client._medium
2384
2268
if medium._is_remote_before((1, 18)):
2385
2269
self._vfs_set_tags_bytes(bytes)
2389
2272
self._remote_path(), self._lock_token, self._repo_lock_token)
2394
2277
self._vfs_set_tags_bytes(bytes)
2396
2279
def lock_read(self):
2397
"""Lock the branch for read operations.
2399
:return: An object with an unlock method which will release the lock
2402
2280
self.repository.lock_read()
2403
2281
if not self._lock_mode:
2404
self._note_lock('r')
2405
2282
self._lock_mode = 'r'
2406
2283
self._lock_count = 1
2407
2284
if self._real_branch is not None:
2408
2285
self._real_branch.lock_read()
2410
2287
self._lock_count += 1
2413
2289
def _remote_lock_write(self, token):
2414
2290
if token is None:
2415
2291
branch_token = repo_token = ''
2417
2293
branch_token = token
2418
repo_token = self.repository.lock_write().repository_token
2294
repo_token = self.repository.lock_write()
2419
2295
self.repository.unlock()
2420
2296
err_context = {'token': token}
2421
2297
response = self._call(
2458
2333
self._lock_count += 1
2459
2334
# Re-lock the repository too.
2460
2335
self.repository.lock_write(self._repo_lock_token)
2461
return BranchWriteLockResult(self.unlock, self._lock_token or None)
2336
return self._lock_token or None
2463
2338
def _unlock(self, branch_token, repo_token):
2464
2339
err_context = {'token': str((branch_token, repo_token))}
2893
2766
raise NoSuchRevision(find('branch'), err.error_args[0])
2894
2767
elif err.error_verb == 'nosuchrevision':
2895
2768
raise NoSuchRevision(find('repository'), err.error_args[0])
2896
elif err.error_verb == 'nobranch':
2897
if len(err.error_args) >= 1:
2898
extra = err.error_args[0]
2901
raise errors.NotBranchError(path=find('bzrdir').root_transport.base,
2769
elif err.error_tuple == ('nobranch',):
2770
raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2903
2771
elif err.error_verb == 'norepository':
2904
2772
raise errors.NoRepositoryPresent(find('bzrdir'))
2905
2773
elif err.error_verb == 'LockContention':
added
removed
bzrlib/remote.py
