89
# Note: RemoteBzrDirFormat is in bzrdir.py
91
class RemoteBzrDir(BzrDir, _RpcHelper):
97
# Note that RemoteBzrDirProber lives in bzrlib.bzrdir so bzrlib.remote
98
# does not have to be imported unless a remote format is involved.
100
class RemoteBzrDirFormat(_mod_bzrdir.BzrDirMetaFormat1):
101
"""Format representing bzrdirs accessed via a smart server"""
103
supports_workingtrees = False
106
_mod_bzrdir.BzrDirMetaFormat1.__init__(self)
107
# XXX: It's a bit ugly that the network name is here, because we'd
108
# like to believe that format objects are stateless or at least
109
# immutable, However, we do at least avoid mutating the name after
110
# it's returned. See <https://bugs.launchpad.net/bzr/+bug/504102>
111
self._network_name = None
114
return "%s(_network_name=%r)" % (self.__class__.__name__,
117
def get_format_description(self):
118
if self._network_name:
119
real_format = controldir.network_format_registry.get(self._network_name)
120
return 'Remote: ' + real_format.get_format_description()
121
return 'bzr remote bzrdir'
123
def get_format_string(self):
124
raise NotImplementedError(self.get_format_string)
126
def network_name(self):
127
if self._network_name:
128
return self._network_name
130
raise AssertionError("No network name set.")
132
def initialize_on_transport(self, transport):
134
# hand off the request to the smart server
135
client_medium = transport.get_smart_medium()
136
except errors.NoSmartMedium:
137
# TODO: lookup the local format from a server hint.
138
local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
139
return local_dir_format.initialize_on_transport(transport)
140
client = _SmartClient(client_medium)
141
path = client.remote_path_from_transport(transport)
143
response = client.call('BzrDirFormat.initialize', path)
144
except errors.ErrorFromSmartServer, err:
145
_translate_error(err, path=path)
146
if response[0] != 'ok':
147
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
148
format = RemoteBzrDirFormat()
149
self._supply_sub_formats_to(format)
150
return RemoteBzrDir(transport, format)
152
def parse_NoneTrueFalse(self, arg):
159
raise AssertionError("invalid arg %r" % arg)
161
def _serialize_NoneTrueFalse(self, arg):
168
def _serialize_NoneString(self, arg):
171
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
172
create_prefix=False, force_new_repo=False, stacked_on=None,
173
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
176
# hand off the request to the smart server
177
client_medium = transport.get_smart_medium()
178
except errors.NoSmartMedium:
181
# Decline to open it if the server doesn't support our required
182
# version (3) so that the VFS-based transport will do it.
183
if client_medium.should_probe():
185
server_version = client_medium.protocol_version()
186
if server_version != '2':
190
except errors.SmartProtocolError:
191
# Apparently there's no usable smart server there, even though
192
# the medium supports the smart protocol.
197
client = _SmartClient(client_medium)
198
path = client.remote_path_from_transport(transport)
199
if client_medium._is_remote_before((1, 16)):
202
# TODO: lookup the local format from a server hint.
203
local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
204
self._supply_sub_formats_to(local_dir_format)
205
return local_dir_format.initialize_on_transport_ex(transport,
206
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
207
force_new_repo=force_new_repo, stacked_on=stacked_on,
208
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
209
make_working_trees=make_working_trees, shared_repo=shared_repo,
211
return self._initialize_on_transport_ex_rpc(client, path, transport,
212
use_existing_dir, create_prefix, force_new_repo, stacked_on,
213
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
215
def _initialize_on_transport_ex_rpc(self, client, path, transport,
216
use_existing_dir, create_prefix, force_new_repo, stacked_on,
217
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
219
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
220
args.append(self._serialize_NoneTrueFalse(create_prefix))
221
args.append(self._serialize_NoneTrueFalse(force_new_repo))
222
args.append(self._serialize_NoneString(stacked_on))
223
# stack_on_pwd is often/usually our transport
226
stack_on_pwd = transport.relpath(stack_on_pwd)
229
except errors.PathNotChild:
231
args.append(self._serialize_NoneString(stack_on_pwd))
232
args.append(self._serialize_NoneString(repo_format_name))
233
args.append(self._serialize_NoneTrueFalse(make_working_trees))
234
args.append(self._serialize_NoneTrueFalse(shared_repo))
235
request_network_name = self._network_name or \
236
_mod_bzrdir.BzrDirFormat.get_default_format().network_name()
238
response = client.call('BzrDirFormat.initialize_ex_1.16',
239
request_network_name, path, *args)
240
except errors.UnknownSmartMethod:
241
client._medium._remember_remote_is_before((1,16))
242
local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
243
self._supply_sub_formats_to(local_dir_format)
244
return local_dir_format.initialize_on_transport_ex(transport,
245
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
246
force_new_repo=force_new_repo, stacked_on=stacked_on,
247
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
248
make_working_trees=make_working_trees, shared_repo=shared_repo,
250
except errors.ErrorFromSmartServer, err:
251
_translate_error(err, path=path)
252
repo_path = response[0]
253
bzrdir_name = response[6]
254
require_stacking = response[7]
255
require_stacking = self.parse_NoneTrueFalse(require_stacking)
256
format = RemoteBzrDirFormat()
257
format._network_name = bzrdir_name
258
self._supply_sub_formats_to(format)
259
bzrdir = RemoteBzrDir(transport, format, _client=client)
261
repo_format = response_tuple_to_repo_format(response[1:])
265
repo_bzrdir_format = RemoteBzrDirFormat()
266
repo_bzrdir_format._network_name = response[5]
267
repo_bzr = RemoteBzrDir(transport.clone(repo_path),
271
final_stack = response[8] or None
272
final_stack_pwd = response[9] or None
274
final_stack_pwd = urlutils.join(
275
transport.base, final_stack_pwd)
276
remote_repo = RemoteRepository(repo_bzr, repo_format)
277
if len(response) > 10:
278
# Updated server verb that locks remotely.
279
repo_lock_token = response[10] or None
280
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
282
remote_repo.dont_leave_lock_in_place()
284
remote_repo.lock_write()
285
policy = _mod_bzrdir.UseExistingRepository(remote_repo, final_stack,
286
final_stack_pwd, require_stacking)
287
policy.acquire_repository()
291
bzrdir._format.set_branch_format(self.get_branch_format())
293
# The repo has already been created, but we need to make sure that
294
# we'll make a stackable branch.
295
bzrdir._format.require_stacking(_skip_repo=True)
296
return remote_repo, bzrdir, require_stacking, policy
298
def _open(self, transport):
299
return RemoteBzrDir(transport, self)
301
def __eq__(self, other):
302
if not isinstance(other, RemoteBzrDirFormat):
304
return self.get_format_description() == other.get_format_description()
306
def __return_repository_format(self):
307
# Always return a RemoteRepositoryFormat object, but if a specific bzr
308
# repository format has been asked for, tell the RemoteRepositoryFormat
309
# that it should use that for init() etc.
310
result = RemoteRepositoryFormat()
311
custom_format = getattr(self, '_repository_format', None)
313
if isinstance(custom_format, RemoteRepositoryFormat):
316
# We will use the custom format to create repositories over the
317
# wire; expose its details like rich_root_data for code to
319
result._custom_format = custom_format
322
def get_branch_format(self):
323
result = _mod_bzrdir.BzrDirMetaFormat1.get_branch_format(self)
324
if not isinstance(result, RemoteBranchFormat):
325
new_result = RemoteBranchFormat()
326
new_result._custom_format = result
328
self.set_branch_format(new_result)
332
repository_format = property(__return_repository_format,
333
_mod_bzrdir.BzrDirMetaFormat1._set_repository_format) #.im_func)
336
class RemoteControlStore(config.IniFileStore):
337
"""Control store which attempts to use HPSS calls to retrieve control store.
339
Note that this is specific to bzr-based formats.
342
def __init__(self, bzrdir):
343
super(RemoteControlStore, self).__init__()
345
self._real_store = None
347
def lock_write(self, token=None):
349
return self._real_store.lock_write(token)
353
return self._real_store.unlock()
357
# We need to be able to override the undecorated implementation
358
self.save_without_locking()
360
def save_without_locking(self):
361
super(RemoteControlStore, self).save()
363
def _ensure_real(self):
364
self.bzrdir._ensure_real()
365
if self._real_store is None:
366
self._real_store = config.ControlStore(self.bzrdir)
368
def external_url(self):
369
return self.bzrdir.user_url
371
def _load_content(self):
372
medium = self.bzrdir._client._medium
373
path = self.bzrdir._path_for_remote_call(self.bzrdir._client)
375
response, handler = self.bzrdir._call_expecting_body(
376
'BzrDir.get_config_file', path)
377
except errors.UnknownSmartMethod:
379
return self._real_store._load_content()
380
if len(response) and response[0] != 'ok':
381
raise errors.UnexpectedSmartServerResponse(response)
382
return handler.read_body_bytes()
384
def _save_content(self, content):
385
# FIXME JRV 2011-11-22: Ideally this should use a
386
# HPSS call too, but at the moment it is not possible
387
# to write lock control directories.
389
return self._real_store._save_content(content)
392
class RemoteBzrDir(_mod_bzrdir.BzrDir, _RpcHelper):
92
393
"""Control directory on a remote server, accessed via bzr:// or similar."""
94
395
def __init__(self, transport, format, _client=None, _force_probe=False):
2071
2487
if isinstance(a_bzrdir, RemoteBzrDir):
2072
2488
a_bzrdir._ensure_real()
2073
2489
result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2490
name, append_revisions_only=append_revisions_only)
2076
2492
# We assume the bzrdir is parameterised; it may not be.
2077
result = self._custom_format.initialize(a_bzrdir, name)
2493
result = self._custom_format.initialize(a_bzrdir, name,
2494
append_revisions_only=append_revisions_only)
2078
2495
if (isinstance(a_bzrdir, RemoteBzrDir) and
2079
2496
not isinstance(result, RemoteBranch)):
2080
2497
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2084
def initialize(self, a_bzrdir, name=None):
2501
def initialize(self, a_bzrdir, name=None, repository=None,
2502
append_revisions_only=None):
2085
2503
# 1) get the network name to use.
2086
2504
if self._custom_format:
2087
2505
network_name = self._custom_format.network_name()
2089
2507
# Select the current bzrlib default and ask for that.
2090
reference_bzrdir_format = bzrdir.format_registry.get('default')()
2508
reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
2091
2509
reference_format = reference_bzrdir_format.get_branch_format()
2092
2510
self._custom_format = reference_format
2093
2511
network_name = reference_format.network_name()
2094
2512
# Being asked to create on a non RemoteBzrDir:
2095
2513
if not isinstance(a_bzrdir, RemoteBzrDir):
2096
return self._vfs_initialize(a_bzrdir, name=name)
2514
return self._vfs_initialize(a_bzrdir, name=name,
2515
append_revisions_only=append_revisions_only)
2097
2516
medium = a_bzrdir._client._medium
2098
2517
if medium._is_remote_before((1, 13)):
2099
return self._vfs_initialize(a_bzrdir, name=name)
2518
return self._vfs_initialize(a_bzrdir, name=name,
2519
append_revisions_only=append_revisions_only)
2100
2520
# Creating on a remote bzr dir.
2101
2521
# 2) try direct creation via RPC
2102
2522
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2148
2583
self._ensure_real()
2149
2584
return self._custom_format.supports_set_append_revisions_only()
2586
def _use_default_local_heads_to_fetch(self):
2587
# If the branch format is a metadir format *and* its heads_to_fetch
2588
# implementation is not overridden vs the base class, we can use the
2589
# base class logic rather than use the heads_to_fetch RPC. This is
2590
# usually cheaper in terms of net round trips, as the last-revision and
2591
# tags info fetched is cached and would be fetched anyway.
2593
if isinstance(self._custom_format, branch.BranchFormatMetadir):
2594
branch_class = self._custom_format._branch_class()
2595
heads_to_fetch_impl = branch_class.heads_to_fetch.im_func
2596
if heads_to_fetch_impl is branch.Branch.heads_to_fetch.im_func:
2601
class RemoteBranchStore(config.IniFileStore):
2602
"""Branch store which attempts to use HPSS calls to retrieve branch store.
2604
Note that this is specific to bzr-based formats.
2607
def __init__(self, branch):
2608
super(RemoteBranchStore, self).__init__()
2609
self.branch = branch
2611
self._real_store = None
2613
def lock_write(self, token=None):
2614
return self.branch.lock_write(token)
2617
return self.branch.unlock()
2621
# We need to be able to override the undecorated implementation
2622
self.save_without_locking()
2624
def save_without_locking(self):
2625
super(RemoteBranchStore, self).save()
2627
def external_url(self):
2628
return self.branch.user_url
2630
def _load_content(self):
2631
path = self.branch._remote_path()
2633
response, handler = self.branch._call_expecting_body(
2634
'Branch.get_config_file', path)
2635
except errors.UnknownSmartMethod:
2637
return self._real_store._load_content()
2638
if len(response) and response[0] != 'ok':
2639
raise errors.UnexpectedSmartServerResponse(response)
2640
return handler.read_body_bytes()
2642
def _save_content(self, content):
2643
path = self.branch._remote_path()
2645
response, handler = self.branch._call_with_body_bytes_expecting_body(
2646
'Branch.put_config_file', (path,
2647
self.branch._lock_token, self.branch._repo_lock_token),
2649
except errors.UnknownSmartMethod:
2651
return self._real_store._save_content(content)
2652
handler.cancel_read_body()
2653
if response != ('ok', ):
2654
raise errors.UnexpectedSmartServerResponse(response)
2656
def _ensure_real(self):
2657
self.branch._ensure_real()
2658
if self._real_store is None:
2659
self._real_store = config.BranchStore(self.branch)
2152
2662
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
2153
2663
"""Branch stored on a server accessed by HPSS RPC.
2774
3358
medium = self._branch._client._medium
2775
3359
if medium._is_remote_before((1, 14)):
2776
3360
return self._vfs_set_option(value, name, section)
3361
if isinstance(value, dict):
3362
if medium._is_remote_before((2, 2)):
3363
return self._vfs_set_option(value, name, section)
3364
return self._set_config_option_dict(value, name, section)
3366
return self._set_config_option(value, name, section)
3368
def _set_config_option(self, value, name, section):
2778
3370
path = self._branch._remote_path()
2779
3371
response = self._branch._client.call('Branch.set_config_option',
2780
3372
path, self._branch._lock_token, self._branch._repo_lock_token,
2781
3373
value.encode('utf8'), name, section or '')
2782
3374
except errors.UnknownSmartMethod:
3375
medium = self._branch._client._medium
2783
3376
medium._remember_remote_is_before((1, 14))
2784
3377
return self._vfs_set_option(value, name, section)
2785
3378
if response != ():
2786
3379
raise errors.UnexpectedSmartServerResponse(response)
3381
def _serialize_option_dict(self, option_dict):
3383
for key, value in option_dict.items():
3384
if isinstance(key, unicode):
3385
key = key.encode('utf8')
3386
if isinstance(value, unicode):
3387
value = value.encode('utf8')
3388
utf8_dict[key] = value
3389
return bencode.bencode(utf8_dict)
3391
def _set_config_option_dict(self, value, name, section):
3393
path = self._branch._remote_path()
3394
serialised_dict = self._serialize_option_dict(value)
3395
response = self._branch._client.call(
3396
'Branch.set_config_option_dict',
3397
path, self._branch._lock_token, self._branch._repo_lock_token,
3398
serialised_dict, name, section or '')
3399
except errors.UnknownSmartMethod:
3400
medium = self._branch._client._medium
3401
medium._remember_remote_is_before((2, 2))
3402
return self._vfs_set_option(value, name, section)
3404
raise errors.UnexpectedSmartServerResponse(response)
2788
3406
def _real_object(self):
2789
3407
self._branch._ensure_real()
2790
3408
return self._branch._real_branch