91
# Note that RemoteBzrDirProber lives in bzrlib.bzrdir so bzrlib.remote
92
# does not have to be imported unless a remote format is involved.
94
class RemoteBzrDirFormat(_mod_bzrdir.BzrDirMetaFormat1):
95
"""Format representing bzrdirs accessed via a smart server"""
97
supports_workingtrees = False
100
_mod_bzrdir.BzrDirMetaFormat1.__init__(self)
101
# XXX: It's a bit ugly that the network name is here, because we'd
102
# like to believe that format objects are stateless or at least
103
# immutable, However, we do at least avoid mutating the name after
104
# it's returned. See <https://bugs.launchpad.net/bzr/+bug/504102>
105
self._network_name = None
108
return "%s(_network_name=%r)" % (self.__class__.__name__,
111
def get_format_description(self):
112
if self._network_name:
113
real_format = controldir.network_format_registry.get(self._network_name)
114
return 'Remote: ' + real_format.get_format_description()
115
return 'bzr remote bzrdir'
117
def get_format_string(self):
118
raise NotImplementedError(self.get_format_string)
120
def network_name(self):
121
if self._network_name:
122
return self._network_name
124
raise AssertionError("No network name set.")
126
def initialize_on_transport(self, transport):
128
# hand off the request to the smart server
129
client_medium = transport.get_smart_medium()
130
except errors.NoSmartMedium:
131
# TODO: lookup the local format from a server hint.
132
local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
133
return local_dir_format.initialize_on_transport(transport)
134
client = _SmartClient(client_medium)
135
path = client.remote_path_from_transport(transport)
137
response = client.call('BzrDirFormat.initialize', path)
138
except errors.ErrorFromSmartServer, err:
139
_translate_error(err, path=path)
140
if response[0] != 'ok':
141
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
142
format = RemoteBzrDirFormat()
143
self._supply_sub_formats_to(format)
144
return RemoteBzrDir(transport, format)
146
def parse_NoneTrueFalse(self, arg):
153
raise AssertionError("invalid arg %r" % arg)
155
def _serialize_NoneTrueFalse(self, arg):
162
def _serialize_NoneString(self, arg):
165
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
166
create_prefix=False, force_new_repo=False, stacked_on=None,
167
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
170
# hand off the request to the smart server
171
client_medium = transport.get_smart_medium()
172
except errors.NoSmartMedium:
175
# Decline to open it if the server doesn't support our required
176
# version (3) so that the VFS-based transport will do it.
177
if client_medium.should_probe():
179
server_version = client_medium.protocol_version()
180
if server_version != '2':
184
except errors.SmartProtocolError:
185
# Apparently there's no usable smart server there, even though
186
# the medium supports the smart protocol.
191
client = _SmartClient(client_medium)
192
path = client.remote_path_from_transport(transport)
193
if client_medium._is_remote_before((1, 16)):
196
# TODO: lookup the local format from a server hint.
197
local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
198
self._supply_sub_formats_to(local_dir_format)
199
return local_dir_format.initialize_on_transport_ex(transport,
200
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
201
force_new_repo=force_new_repo, stacked_on=stacked_on,
202
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
203
make_working_trees=make_working_trees, shared_repo=shared_repo,
205
return self._initialize_on_transport_ex_rpc(client, path, transport,
206
use_existing_dir, create_prefix, force_new_repo, stacked_on,
207
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
209
def _initialize_on_transport_ex_rpc(self, client, path, transport,
210
use_existing_dir, create_prefix, force_new_repo, stacked_on,
211
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
213
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
214
args.append(self._serialize_NoneTrueFalse(create_prefix))
215
args.append(self._serialize_NoneTrueFalse(force_new_repo))
216
args.append(self._serialize_NoneString(stacked_on))
217
# stack_on_pwd is often/usually our transport
220
stack_on_pwd = transport.relpath(stack_on_pwd)
223
except errors.PathNotChild:
225
args.append(self._serialize_NoneString(stack_on_pwd))
226
args.append(self._serialize_NoneString(repo_format_name))
227
args.append(self._serialize_NoneTrueFalse(make_working_trees))
228
args.append(self._serialize_NoneTrueFalse(shared_repo))
229
request_network_name = self._network_name or \
230
_mod_bzrdir.BzrDirFormat.get_default_format().network_name()
232
response = client.call('BzrDirFormat.initialize_ex_1.16',
233
request_network_name, path, *args)
234
except errors.UnknownSmartMethod:
235
client._medium._remember_remote_is_before((1,16))
236
local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
237
self._supply_sub_formats_to(local_dir_format)
238
return local_dir_format.initialize_on_transport_ex(transport,
239
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
240
force_new_repo=force_new_repo, stacked_on=stacked_on,
241
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
242
make_working_trees=make_working_trees, shared_repo=shared_repo,
244
except errors.ErrorFromSmartServer, err:
245
_translate_error(err, path=path)
246
repo_path = response[0]
247
bzrdir_name = response[6]
248
require_stacking = response[7]
249
require_stacking = self.parse_NoneTrueFalse(require_stacking)
250
format = RemoteBzrDirFormat()
251
format._network_name = bzrdir_name
252
self._supply_sub_formats_to(format)
253
bzrdir = RemoteBzrDir(transport, format, _client=client)
255
repo_format = response_tuple_to_repo_format(response[1:])
259
repo_bzrdir_format = RemoteBzrDirFormat()
260
repo_bzrdir_format._network_name = response[5]
261
repo_bzr = RemoteBzrDir(transport.clone(repo_path),
265
final_stack = response[8] or None
266
final_stack_pwd = response[9] or None
268
final_stack_pwd = urlutils.join(
269
transport.base, final_stack_pwd)
270
remote_repo = RemoteRepository(repo_bzr, repo_format)
271
if len(response) > 10:
272
# Updated server verb that locks remotely.
273
repo_lock_token = response[10] or None
274
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
276
remote_repo.dont_leave_lock_in_place()
278
remote_repo.lock_write()
279
policy = _mod_bzrdir.UseExistingRepository(remote_repo, final_stack,
280
final_stack_pwd, require_stacking)
281
policy.acquire_repository()
285
bzrdir._format.set_branch_format(self.get_branch_format())
287
# The repo has already been created, but we need to make sure that
288
# we'll make a stackable branch.
289
bzrdir._format.require_stacking(_skip_repo=True)
290
return remote_repo, bzrdir, require_stacking, policy
292
def _open(self, transport):
293
return RemoteBzrDir(transport, self)
295
def __eq__(self, other):
296
if not isinstance(other, RemoteBzrDirFormat):
298
return self.get_format_description() == other.get_format_description()
300
def __return_repository_format(self):
301
# Always return a RemoteRepositoryFormat object, but if a specific bzr
302
# repository format has been asked for, tell the RemoteRepositoryFormat
303
# that it should use that for init() etc.
304
result = RemoteRepositoryFormat()
305
custom_format = getattr(self, '_repository_format', None)
307
if isinstance(custom_format, RemoteRepositoryFormat):
310
# We will use the custom format to create repositories over the
311
# wire; expose its details like rich_root_data for code to
313
result._custom_format = custom_format
316
def get_branch_format(self):
317
result = _mod_bzrdir.BzrDirMetaFormat1.get_branch_format(self)
318
if not isinstance(result, RemoteBranchFormat):
319
new_result = RemoteBranchFormat()
320
new_result._custom_format = result
322
self.set_branch_format(new_result)
326
repository_format = property(__return_repository_format,
327
_mod_bzrdir.BzrDirMetaFormat1._set_repository_format) #.im_func)
330
class RemoteBzrDir(_mod_bzrdir.BzrDir, _RpcHelper):
87
# Note: RemoteBzrDirFormat is in bzrdir.py
89
class RemoteBzrDir(BzrDir, _RpcHelper):
331
90
"""Control directory on a remote server, accessed via bzr:// or similar."""
333
def __init__(self, transport, format, _client=None, _force_probe=False):
92
def __init__(self, transport, format, _client=None):
334
93
"""Construct a RemoteBzrDir.
336
95
:param _client: Private parameter for testing. Disables probing and the
337
96
use of a real bzrdir.
339
_mod_bzrdir.BzrDir.__init__(self, transport, format)
98
BzrDir.__init__(self, transport, format)
340
99
# this object holds a delegated bzrdir that uses file-level operations
341
100
# to talk to the other side
342
101
self._real_bzrdir = None
343
self._has_working_tree = None
344
102
# 1-shot cache for the call pattern 'create_branch; open_branch' - see
345
103
# create_branch for details.
346
104
self._next_open_branch_result = None
537
249
def _get_branch_reference(self):
538
250
path = self._path_for_remote_call(self._client)
539
251
medium = self._client._medium
541
('BzrDir.open_branchV3', (2, 1)),
542
('BzrDir.open_branchV2', (1, 13)),
543
('BzrDir.open_branch', None),
545
for verb, required_version in candidate_calls:
546
if required_version and medium._is_remote_before(required_version):
252
if not medium._is_remote_before((1, 13)):
549
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)
550
258
except errors.UnknownSmartMethod:
551
if required_version is None:
553
medium._remember_remote_is_before(required_version)
556
if verb == 'BzrDir.open_branch':
557
if response[0] != 'ok':
558
raise errors.UnexpectedSmartServerResponse(response)
559
if response[1] != '':
560
return ('ref', response[1])
562
return ('branch', '')
563
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':
564
262
raise errors.UnexpectedSmartServerResponse(response)
263
if response[1] != '':
264
return ('ref', response[1])
266
return ('branch', '')
567
def _get_tree_branch(self, name=None):
268
def _get_tree_branch(self):
568
269
"""See BzrDir._get_tree_branch()."""
569
return None, self.open_branch(name=name)
270
return None, self.open_branch()
571
def open_branch(self, name=None, unsupported=False,
572
ignore_fallbacks=False):
272
def open_branch(self, _unsupported=False, ignore_fallbacks=False):
574
274
raise NotImplementedError('unsupported flag support not implemented yet.')
575
275
if self._next_open_branch_result is not None:
576
276
# See create_branch for details.
1511
1151
# state, so always add a lock here. If a caller passes us a locked
1512
1152
# repository, they are responsible for unlocking it later.
1513
1153
repository.lock_read()
1514
self._check_fallback_repository(repository)
1515
1154
self._fallback_repositories.append(repository)
1516
1155
# If self._real_repository was parameterised already (e.g. because a
1517
1156
# _real_branch had its get_stacked_on_url method called), then the
1518
1157
# repository to be added may already be in the _real_repositories list.
1519
1158
if self._real_repository is not None:
1520
fallback_locations = [repo.user_url for repo in
1159
fallback_locations = [repo.bzrdir.root_transport.base for repo in
1521
1160
self._real_repository._fallback_repositories]
1522
if repository.user_url not in fallback_locations:
1161
if repository.bzrdir.root_transport.base not in fallback_locations:
1523
1162
self._real_repository.add_fallback_repository(repository)
1525
def _check_fallback_repository(self, repository):
1526
"""Check that this repository can fallback to repository safely.
1528
Raise an error if not.
1530
:param repository: A repository to fallback to.
1532
return _mod_repository.InterRepository._assert_same_model(
1535
1164
def add_inventory(self, revid, inv, parents):
1536
1165
self._ensure_real()
1537
1166
return self._real_repository.add_inventory(revid, inv, parents)
1539
1168
def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1540
parents, basis_inv=None, propagate_caches=False):
1541
1170
self._ensure_real()
1542
1171
return self._real_repository.add_inventory_by_delta(basis_revision_id,
1543
delta, new_revision_id, parents, basis_inv=basis_inv,
1544
propagate_caches=propagate_caches)
1172
delta, new_revision_id, parents)
1546
1174
def add_revision(self, rev_id, rev, inv=None, config=None):
1547
1175
self._ensure_real()
2344
1956
self._network_name)
2346
1958
def get_format_description(self):
2348
return 'Remote: ' + self._custom_format.get_format_description()
1959
return 'Remote BZR Branch'
2350
1961
def network_name(self):
2351
1962
return self._network_name
2353
def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
2354
return a_bzrdir.open_branch(name=name,
2355
ignore_fallbacks=ignore_fallbacks)
1964
def open(self, a_bzrdir, ignore_fallbacks=False):
1965
return a_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2357
def _vfs_initialize(self, a_bzrdir, name):
1967
def _vfs_initialize(self, a_bzrdir):
2358
1968
# Initialisation when using a local bzrdir object, or a non-vfs init
2359
1969
# method is not available on the server.
2360
1970
# self._custom_format is always set - the start of initialize ensures
2362
1972
if isinstance(a_bzrdir, RemoteBzrDir):
2363
1973
a_bzrdir._ensure_real()
2364
result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
1974
result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
2367
1976
# We assume the bzrdir is parameterised; it may not be.
2368
result = self._custom_format.initialize(a_bzrdir, name)
1977
result = self._custom_format.initialize(a_bzrdir)
2369
1978
if (isinstance(a_bzrdir, RemoteBzrDir) and
2370
1979
not isinstance(result, RemoteBranch)):
2371
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
1980
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
2375
def initialize(self, a_bzrdir, name=None, repository=None):
1983
def initialize(self, a_bzrdir):
2376
1984
# 1) get the network name to use.
2377
1985
if self._custom_format:
2378
1986
network_name = self._custom_format.network_name()
2380
1988
# Select the current bzrlib default and ask for that.
2381
reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
1989
reference_bzrdir_format = bzrdir.format_registry.get('default')()
2382
1990
reference_format = reference_bzrdir_format.get_branch_format()
2383
1991
self._custom_format = reference_format
2384
1992
network_name = reference_format.network_name()
2385
1993
# Being asked to create on a non RemoteBzrDir:
2386
1994
if not isinstance(a_bzrdir, RemoteBzrDir):
2387
return self._vfs_initialize(a_bzrdir, name=name)
1995
return self._vfs_initialize(a_bzrdir)
2388
1996
medium = a_bzrdir._client._medium
2389
1997
if medium._is_remote_before((1, 13)):
2390
return self._vfs_initialize(a_bzrdir, name=name)
1998
return self._vfs_initialize(a_bzrdir)
2391
1999
# Creating on a remote bzr dir.
2392
2000
# 2) try direct creation via RPC
2393
2001
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2394
if name is not None:
2395
# XXX JRV20100304: Support creating colocated branches
2396
raise errors.NoColocatedBranchSupport(self)
2397
2002
verb = 'BzrDir.create_branch'
2399
2004
response = a_bzrdir._call(verb, path, network_name)
2400
2005
except errors.UnknownSmartMethod:
2401
2006
# Fallback - use vfs methods
2402
2007
medium._remember_remote_is_before((1, 13))
2403
return self._vfs_initialize(a_bzrdir, name=name)
2008
return self._vfs_initialize(a_bzrdir)
2404
2009
if response[0] != 'ok':
2405
2010
raise errors.UnexpectedSmartServerResponse(response)
2406
2011
# Turn the response into a RemoteRepository object.
2407
2012
format = RemoteBranchFormat(network_name=response[1])
2408
2013
repo_format = response_tuple_to_repo_format(response[3:])
2409
repo_path = response[2]
2410
if repository is not None:
2411
remote_repo_url = urlutils.join(a_bzrdir.user_url, repo_path)
2412
url_diff = urlutils.relative_url(repository.user_url,
2415
raise AssertionError(
2416
'repository.user_url %r does not match URL from server '
2417
'response (%r + %r)'
2418
% (repository.user_url, a_bzrdir.user_url, repo_path))
2419
remote_repo = repository
2014
if response[2] == '':
2015
repo_bzrdir = a_bzrdir
2422
repo_bzrdir = a_bzrdir
2424
repo_bzrdir = RemoteBzrDir(
2425
a_bzrdir.root_transport.clone(repo_path), a_bzrdir._format,
2427
remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2017
repo_bzrdir = RemoteBzrDir(
2018
a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
2020
remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2428
2021
remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2429
format=format, setup_stacking=False, name=name)
2022
format=format, setup_stacking=False)
2430
2023
# XXX: We know this is a new branch, so it must have revno 0, revid
2431
2024
# NULL_REVISION. Creating the branch locked would make this be unable
2432
2025
# to be wrong; here its simply very unlikely to be wrong. RBC 20090225
3154
2664
medium = self._branch._client._medium
3155
2665
if medium._is_remote_before((1, 14)):
3156
2666
return self._vfs_set_option(value, name, section)
3157
if isinstance(value, dict):
3158
if medium._is_remote_before((2, 2)):
3159
return self._vfs_set_option(value, name, section)
3160
return self._set_config_option_dict(value, name, section)
3162
return self._set_config_option(value, name, section)
3164
def _set_config_option(self, value, name, section):
3166
2668
path = self._branch._remote_path()
3167
2669
response = self._branch._client.call('Branch.set_config_option',
3168
2670
path, self._branch._lock_token, self._branch._repo_lock_token,
3169
2671
value.encode('utf8'), name, section or '')
3170
2672
except errors.UnknownSmartMethod:
3171
medium = self._branch._client._medium
3172
2673
medium._remember_remote_is_before((1, 14))
3173
2674
return self._vfs_set_option(value, name, section)
3174
2675
if response != ():
3175
2676
raise errors.UnexpectedSmartServerResponse(response)
3177
def _serialize_option_dict(self, option_dict):
3179
for key, value in option_dict.items():
3180
if isinstance(key, unicode):
3181
key = key.encode('utf8')
3182
if isinstance(value, unicode):
3183
value = value.encode('utf8')
3184
utf8_dict[key] = value
3185
return bencode.bencode(utf8_dict)
3187
def _set_config_option_dict(self, value, name, section):
3189
path = self._branch._remote_path()
3190
serialised_dict = self._serialize_option_dict(value)
3191
response = self._branch._client.call(
3192
'Branch.set_config_option_dict',
3193
path, self._branch._lock_token, self._branch._repo_lock_token,
3194
serialised_dict, name, section or '')
3195
except errors.UnknownSmartMethod:
3196
medium = self._branch._client._medium
3197
medium._remember_remote_is_before((2, 2))
3198
return self._vfs_set_option(value, name, section)
3200
raise errors.UnexpectedSmartServerResponse(response)
3202
2678
def _real_object(self):
3203
2679
self._branch._ensure_real()
3204
2680
return self._branch._real_branch
3287
2763
'Missing key %r in context %r', key_err.args[0], context)
3290
if err.error_verb == 'NoSuchRevision':
2766
if err.error_verb == 'IncompatibleRepositories':
2767
raise errors.IncompatibleRepositories(err.error_args[0],
2768
err.error_args[1], err.error_args[2])
2769
elif err.error_verb == 'NoSuchRevision':
3291
2770
raise NoSuchRevision(find('branch'), err.error_args[0])
3292
2771
elif err.error_verb == 'nosuchrevision':
3293
2772
raise NoSuchRevision(find('repository'), err.error_args[0])
3294
elif err.error_verb == 'nobranch':
3295
if len(err.error_args) >= 1:
3296
extra = err.error_args[0]
3299
raise errors.NotBranchError(path=find('bzrdir').root_transport.base,
2773
elif err.error_tuple == ('nobranch',):
2774
raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
3301
2775
elif err.error_verb == 'norepository':
3302
2776
raise errors.NoRepositoryPresent(find('bzrdir'))
2777
elif err.error_verb == 'LockContention':
2778
raise errors.LockContention('(remote lock)')
3303
2779
elif err.error_verb == 'UnlockableTransport':
3304
2780
raise errors.UnlockableTransport(find('bzrdir').root_transport)
2781
elif err.error_verb == 'LockFailed':
2782
raise errors.LockFailed(err.error_args[0], err.error_args[1])
3305
2783
elif err.error_verb == 'TokenMismatch':
3306
2784
raise errors.TokenMismatch(find('token'), '(remote token)')
3307
2785
elif err.error_verb == 'Diverged':
3308
2786
raise errors.DivergedBranches(find('branch'), find('other_branch'))
2787
elif err.error_verb == 'TipChangeRejected':
2788
raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
2789
elif err.error_verb == 'UnstackableBranchFormat':
2790
raise errors.UnstackableBranchFormat(*err.error_args)
2791
elif err.error_verb == 'UnstackableRepositoryFormat':
2792
raise errors.UnstackableRepositoryFormat(*err.error_args)
3309
2793
elif err.error_verb == 'NotStacked':
3310
2794
raise errors.NotStacked(branch=find('branch'))
3311
2795
elif err.error_verb == 'PermissionDenied':