13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
# TODO: At some point, handle upgrades by just passing the whole request
18
# across to run on the server.
21
from cStringIO import StringIO
19
23
from bzrlib import (
22
bzrdir as _mod_bzrdir,
30
repository as _mod_repository,
31
revision as _mod_revision,
37
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
38
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
33
from bzrlib.branch import BranchReferenceFormat
34
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
35
from bzrlib.config import BranchConfig, TreeConfig
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
from bzrlib.smart import client, vfs, repository as smart_repo
45
from bzrlib.smart.client import _SmartClient
46
from bzrlib.revision import NULL_REVISION
47
from bzrlib.repository import RepositoryWriteLockResult, _LazyListJoin
42
from bzrlib.pack import ContainerPushParser
43
from bzrlib.smart import client, vfs
44
from bzrlib.symbol_versioning import (
48
from bzrlib.revision import ensure_null, NULL_REVISION
48
49
from bzrlib.trace import mutter, note, warning
51
class _RpcHelper(object):
52
"""Mixin class that helps with issuing RPCs."""
54
def _call(self, method, *args, **err_context):
56
return self._client.call(method, *args)
57
except errors.ErrorFromSmartServer, err:
58
self._translate_error(err, **err_context)
60
def _call_expecting_body(self, method, *args, **err_context):
62
return self._client.call_expecting_body(method, *args)
63
except errors.ErrorFromSmartServer, err:
64
self._translate_error(err, **err_context)
66
def _call_with_body_bytes(self, method, args, body_bytes, **err_context):
68
return self._client.call_with_body_bytes(method, args, body_bytes)
69
except errors.ErrorFromSmartServer, err:
70
self._translate_error(err, **err_context)
72
def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
75
return self._client.call_with_body_bytes_expecting_body(
76
method, args, body_bytes)
77
except errors.ErrorFromSmartServer, err:
78
self._translate_error(err, **err_context)
81
def response_tuple_to_repo_format(response):
82
"""Convert a response tuple describing a repository format to a format."""
83
format = RemoteRepositoryFormat()
84
format._rich_root_data = (response[0] == 'yes')
85
format._supports_tree_reference = (response[1] == 'yes')
86
format._supports_external_lookups = (response[2] == 'yes')
87
format._network_name = response[3]
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):
52
# Note: RemoteBzrDirFormat is in bzrdir.py
54
class RemoteBzrDir(BzrDir):
331
55
"""Control directory on a remote server, accessed via bzr:// or similar."""
333
def __init__(self, transport, format, _client=None, _force_probe=False):
57
def __init__(self, transport, _client=None):
334
58
"""Construct a RemoteBzrDir.
336
60
:param _client: Private parameter for testing. Disables probing and the
337
61
use of a real bzrdir.
339
_mod_bzrdir.BzrDir.__init__(self, transport, format)
63
BzrDir.__init__(self, transport, RemoteBzrDirFormat())
340
64
# this object holds a delegated bzrdir that uses file-level operations
341
65
# to talk to the other side
342
66
self._real_bzrdir = None
343
self._has_working_tree = None
344
# 1-shot cache for the call pattern 'create_branch; open_branch' - see
345
# create_branch for details.
346
self._next_open_branch_result = None
348
68
if _client is None:
349
69
medium = transport.get_smart_medium()
350
70
self._client = client._SmartClient(medium)
352
72
self._client = _client
359
return '%s(%r)' % (self.__class__.__name__, self._client)
361
def _probe_bzrdir(self):
362
medium = self._client._medium
363
75
path = self._path_for_remote_call(self._client)
364
if medium._is_remote_before((2, 1)):
368
self._rpc_open_2_1(path)
370
except errors.UnknownSmartMethod:
371
medium._remember_remote_is_before((2, 1))
374
def _rpc_open_2_1(self, path):
375
response = self._call('BzrDir.open_2.1', path)
376
if response == ('no',):
377
raise errors.NotBranchError(path=self.root_transport.base)
378
elif response[0] == 'yes':
379
if response[1] == 'yes':
380
self._has_working_tree = True
381
elif response[1] == 'no':
382
self._has_working_tree = False
384
raise errors.UnexpectedSmartServerResponse(response)
386
raise errors.UnexpectedSmartServerResponse(response)
388
def _rpc_open(self, path):
389
response = self._call('BzrDir.open', path)
76
response = self._client.call('BzrDir.open', path)
390
77
if response not in [('yes',), ('no',)]:
391
78
raise errors.UnexpectedSmartServerResponse(response)
392
79
if response == ('no',):
393
raise errors.NotBranchError(path=self.root_transport.base)
80
raise errors.NotBranchError(path=transport.base)
395
82
def _ensure_real(self):
396
83
"""Ensure that there is a _real_bzrdir set.
398
85
Used before calls to self._real_bzrdir.
400
87
if not self._real_bzrdir:
401
if 'hpssvfs' in debug.debug_flags:
403
warning('VFS BzrDir access triggered\n%s',
404
''.join(traceback.format_stack()))
405
self._real_bzrdir = _mod_bzrdir.BzrDir.open_from_transport(
88
self._real_bzrdir = BzrDir.open_from_transport(
406
89
self.root_transport, _server_formats=False)
407
self._format._network_name = \
408
self._real_bzrdir._format.network_name()
91
def cloning_metadir(self):
93
return self._real_bzrdir.cloning_metadir()
410
95
def _translate_error(self, err, **context):
411
96
_translate_error(err, bzrdir=self, **context)
413
def break_lock(self):
414
# Prevent aliasing problems in the next_open_branch_result cache.
415
# See create_branch for rationale.
416
self._next_open_branch_result = None
417
return _mod_bzrdir.BzrDir.break_lock(self)
419
def _vfs_cloning_metadir(self, require_stacking=False):
421
return self._real_bzrdir.cloning_metadir(
422
require_stacking=require_stacking)
424
def cloning_metadir(self, require_stacking=False):
425
medium = self._client._medium
426
if medium._is_remote_before((1, 13)):
427
return self._vfs_cloning_metadir(require_stacking=require_stacking)
428
verb = 'BzrDir.cloning_metadir'
433
path = self._path_for_remote_call(self._client)
435
response = self._call(verb, path, stacking)
436
except errors.UnknownSmartMethod:
437
medium._remember_remote_is_before((1, 13))
438
return self._vfs_cloning_metadir(require_stacking=require_stacking)
439
except errors.UnknownErrorFromSmartServer, err:
440
if err.error_tuple != ('BranchReference',):
442
# We need to resolve the branch reference to determine the
443
# cloning_metadir. This causes unnecessary RPCs to open the
444
# referenced branch (and bzrdir, etc) but only when the caller
445
# didn't already resolve the branch reference.
446
referenced_branch = self.open_branch()
447
return referenced_branch.bzrdir.cloning_metadir()
448
if len(response) != 3:
449
raise errors.UnexpectedSmartServerResponse(response)
450
control_name, repo_name, branch_info = response
451
if len(branch_info) != 2:
452
raise errors.UnexpectedSmartServerResponse(response)
453
branch_ref, branch_name = branch_info
454
format = controldir.network_format_registry.get(control_name)
456
format.repository_format = _mod_repository.network_format_registry.get(
458
if branch_ref == 'ref':
459
# XXX: we need possible_transports here to avoid reopening the
460
# connection to the referenced location
461
ref_bzrdir = _mod_bzrdir.BzrDir.open(branch_name)
462
branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
463
format.set_branch_format(branch_format)
464
elif branch_ref == 'branch':
466
format.set_branch_format(
467
branch.network_format_registry.get(branch_name))
469
raise errors.UnexpectedSmartServerResponse(response)
472
98
def create_repository(self, shared=False):
473
# as per meta1 formats - just delegate to the format object which may
475
result = self._format.repository_format.initialize(self, shared)
476
if not isinstance(result, RemoteRepository):
477
return self.open_repository()
100
self._real_bzrdir.create_repository(shared=shared)
101
return self.open_repository()
481
103
def destroy_repository(self):
482
104
"""See BzrDir.destroy_repository"""
483
105
self._ensure_real()
484
106
self._real_bzrdir.destroy_repository()
486
def create_branch(self, name=None, repository=None):
487
# as per meta1 formats - just delegate to the format object which may
489
real_branch = self._format.get_branch_format().initialize(self,
490
name=name, repository=repository)
491
if not isinstance(real_branch, RemoteBranch):
492
if not isinstance(repository, RemoteRepository):
493
raise AssertionError(
494
'need a RemoteRepository to use with RemoteBranch, got %r'
496
result = RemoteBranch(self, repository, real_branch, name=name)
499
# BzrDir.clone_on_transport() uses the result of create_branch but does
500
# not return it to its callers; we save approximately 8% of our round
501
# trips by handing the branch we created back to the first caller to
502
# open_branch rather than probing anew. Long term we need a API in
503
# bzrdir that doesn't discard result objects (like result_branch).
505
self._next_open_branch_result = result
108
def create_branch(self):
110
real_branch = self._real_bzrdir.create_branch()
111
return RemoteBranch(self, self.find_repository(), real_branch)
508
def destroy_branch(self, name=None):
113
def destroy_branch(self):
509
114
"""See BzrDir.destroy_branch"""
510
115
self._ensure_real()
511
self._real_bzrdir.destroy_branch(name=name)
512
self._next_open_branch_result = None
116
self._real_bzrdir.destroy_branch()
514
def create_workingtree(self, revision_id=None, from_branch=None,
515
accelerator_tree=None, hardlink=False):
118
def create_workingtree(self, revision_id=None, from_branch=None):
516
119
raise errors.NotLocalUrl(self.transport.base)
518
def find_branch_format(self, name=None):
121
def find_branch_format(self):
519
122
"""Find the branch 'format' for this bzrdir.
521
124
This might be a synthetic object for e.g. RemoteBranch and SVN.
523
b = self.open_branch(name=name)
126
b = self.open_branch()
526
def get_branch_reference(self, name=None):
129
def get_branch_reference(self):
527
130
"""See BzrDir.get_branch_reference()."""
529
# XXX JRV20100304: Support opening colocated branches
530
raise errors.NoColocatedBranchSupport(self)
531
response = self._get_branch_reference()
532
if response[0] == 'ref':
131
path = self._path_for_remote_call(self._client)
133
response = self._client.call('BzrDir.open_branch', path)
134
except errors.ErrorFromSmartServer, err:
135
self._translate_error(err)
136
if response[0] == 'ok':
137
if response[1] == '':
138
# branch at this location.
141
# a branch reference, use the existing BranchReference logic.
537
def _get_branch_reference(self):
538
path = self._path_for_remote_call(self._client)
539
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):
549
response = self._call(verb, path)
550
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'):
564
144
raise errors.UnexpectedSmartServerResponse(response)
567
def _get_tree_branch(self, name=None):
146
def _get_tree_branch(self):
568
147
"""See BzrDir._get_tree_branch()."""
569
return None, self.open_branch(name=name)
148
return None, self.open_branch()
571
def open_branch(self, name=None, unsupported=False,
572
ignore_fallbacks=False):
150
def open_branch(self, _unsupported=False):
574
152
raise NotImplementedError('unsupported flag support not implemented yet.')
575
if self._next_open_branch_result is not None:
576
# See create_branch for details.
577
result = self._next_open_branch_result
578
self._next_open_branch_result = None
580
response = self._get_branch_reference()
581
if response[0] == 'ref':
153
reference_url = self.get_branch_reference()
154
if reference_url is None:
155
# branch at this location.
156
return RemoteBranch(self, self.find_repository())
582
158
# a branch reference, use the existing BranchReference logic.
583
159
format = BranchReferenceFormat()
584
return format.open(self, name=name, _found=True,
585
location=response[1], ignore_fallbacks=ignore_fallbacks)
586
branch_format_name = response[1]
587
if not branch_format_name:
588
branch_format_name = None
589
format = RemoteBranchFormat(network_name=branch_format_name)
590
return RemoteBranch(self, self.find_repository(), format=format,
591
setup_stacking=not ignore_fallbacks, name=name)
593
def _open_repo_v1(self, path):
594
verb = 'BzrDir.find_repository'
595
response = self._call(verb, path)
596
if response[0] != 'ok':
597
raise errors.UnexpectedSmartServerResponse(response)
598
# servers that only support the v1 method don't support external
601
repo = self._real_bzrdir.open_repository()
602
response = response + ('no', repo._format.network_name())
603
return response, repo
605
def _open_repo_v2(self, path):
160
return format.open(self, _found=True, location=reference_url)
162
def open_repository(self):
163
path = self._path_for_remote_call(self._client)
606
164
verb = 'BzrDir.find_repositoryV2'
607
response = self._call(verb, path)
608
if response[0] != 'ok':
609
raise errors.UnexpectedSmartServerResponse(response)
611
repo = self._real_bzrdir.open_repository()
612
response = response + (repo._format.network_name(),)
613
return response, repo
615
def _open_repo_v3(self, path):
616
verb = 'BzrDir.find_repositoryV3'
617
medium = self._client._medium
618
if medium._is_remote_before((1, 13)):
619
raise errors.UnknownSmartMethod(verb)
621
response = self._call(verb, path)
622
except errors.UnknownSmartMethod:
623
medium._remember_remote_is_before((1, 13))
625
if response[0] != 'ok':
626
raise errors.UnexpectedSmartServerResponse(response)
627
return response, None
629
def open_repository(self):
630
path = self._path_for_remote_call(self._client)
632
for probe in [self._open_repo_v3, self._open_repo_v2,
635
response, real_repo = probe(path)
167
response = self._client.call(verb, path)
637
168
except errors.UnknownSmartMethod:
640
raise errors.UnknownSmartMethod('BzrDir.find_repository{3,2,}')
169
verb = 'BzrDir.find_repository'
170
response = self._client.call(verb, path)
171
except errors.ErrorFromSmartServer, err:
172
self._translate_error(err)
641
173
if response[0] != 'ok':
642
174
raise errors.UnexpectedSmartServerResponse(response)
643
if len(response) != 6:
175
if verb == 'BzrDir.find_repository':
176
# servers that don't support the V2 method don't support external
178
response = response + ('no', )
179
if not (len(response) == 5):
644
180
raise SmartProtocolError('incorrect response length %s' % (response,))
645
181
if response[1] == '':
646
# repo is at this dir.
647
format = response_tuple_to_repo_format(response[2:])
182
format = RemoteRepositoryFormat()
183
format.rich_root_data = (response[2] == 'yes')
184
format.supports_tree_reference = (response[3] == 'yes')
185
# No wire format to check this yet.
186
format.supports_external_lookups = (response[4] == 'yes')
648
187
# Used to support creating a real format instance when needed.
649
188
format._creating_bzrdir = self
650
remote_repo = RemoteRepository(self, format)
651
format._creating_repo = remote_repo
652
if real_repo is not None:
653
remote_repo._set_real_repository(real_repo)
189
return RemoteRepository(self, format)
656
191
raise errors.NoRepositoryPresent(self)
658
def has_workingtree(self):
659
if self._has_working_tree is None:
661
self._has_working_tree = self._real_bzrdir.has_workingtree()
662
return self._has_working_tree
664
193
def open_workingtree(self, recommend_upgrade=True):
665
if self.has_workingtree():
195
if self._real_bzrdir.has_workingtree():
666
196
raise errors.NotLocalUrl(self.root_transport)
668
198
raise errors.NoWorkingTree(self.root_transport.base)
670
200
def _path_for_remote_call(self, client):
671
201
"""Return the path to be used for this bzrdir in a remote call."""
672
return urlutils.split_segment_parameters_raw(
673
client.remote_path_from_transport(self.root_transport))[0]
202
return client.remote_path_from_transport(self.root_transport)
675
def get_branch_transport(self, branch_format, name=None):
204
def get_branch_transport(self, branch_format):
676
205
self._ensure_real()
677
return self._real_bzrdir.get_branch_transport(branch_format, name=name)
206
return self._real_bzrdir.get_branch_transport(branch_format)
679
208
def get_repository_transport(self, repository_format):
680
209
self._ensure_real()
713
243
the attributes rich_root_data and supports_tree_reference are set
714
244
on a per instance basis, and are not set (and should not be) at
717
:ivar _custom_format: If set, a specific concrete repository format that
718
will be used when initializing a repository with this
719
RemoteRepositoryFormat.
720
:ivar _creating_repo: If set, the repository object that this
721
RemoteRepositoryFormat was created for: it can be called into
722
to obtain data like the network name.
725
248
_matchingbzrdir = RemoteBzrDirFormat()
726
supports_full_versioned_files = True
727
supports_leaving_lock = True
730
_mod_repository.RepositoryFormat.__init__(self)
731
self._custom_format = None
732
self._network_name = None
733
self._creating_bzrdir = None
734
self._revision_graph_can_have_wrong_parents = None
735
self._supports_chks = None
736
self._supports_external_lookups = None
737
self._supports_tree_reference = None
738
self._supports_funky_characters = None
739
self._rich_root_data = None
742
return "%s(_network_name=%r)" % (self.__class__.__name__,
746
def fast_deltas(self):
748
return self._custom_format.fast_deltas
751
def rich_root_data(self):
752
if self._rich_root_data is None:
754
self._rich_root_data = self._custom_format.rich_root_data
755
return self._rich_root_data
758
def supports_chks(self):
759
if self._supports_chks is None:
761
self._supports_chks = self._custom_format.supports_chks
762
return self._supports_chks
765
def supports_external_lookups(self):
766
if self._supports_external_lookups is None:
768
self._supports_external_lookups = \
769
self._custom_format.supports_external_lookups
770
return self._supports_external_lookups
773
def supports_funky_characters(self):
774
if self._supports_funky_characters is None:
776
self._supports_funky_characters = \
777
self._custom_format.supports_funky_characters
778
return self._supports_funky_characters
781
def supports_tree_reference(self):
782
if self._supports_tree_reference is None:
784
self._supports_tree_reference = \
785
self._custom_format.supports_tree_reference
786
return self._supports_tree_reference
789
def revision_graph_can_have_wrong_parents(self):
790
if self._revision_graph_can_have_wrong_parents is None:
792
self._revision_graph_can_have_wrong_parents = \
793
self._custom_format.revision_graph_can_have_wrong_parents
794
return self._revision_graph_can_have_wrong_parents
796
def _vfs_initialize(self, a_bzrdir, shared):
797
"""Helper for common code in initialize."""
798
if self._custom_format:
799
# Custom format requested
800
result = self._custom_format.initialize(a_bzrdir, shared=shared)
801
elif self._creating_bzrdir is not None:
802
# Use the format that the repository we were created to back
250
def initialize(self, a_bzrdir, shared=False):
251
if not isinstance(a_bzrdir, RemoteBzrDir):
804
252
prior_repo = self._creating_bzrdir.open_repository()
805
253
prior_repo._ensure_real()
806
result = prior_repo._real_repository._format.initialize(
254
return prior_repo._real_repository._format.initialize(
807
255
a_bzrdir, shared=shared)
809
# assume that a_bzr is a RemoteBzrDir but the smart server didn't
810
# support remote initialization.
811
# We delegate to a real object at this point (as RemoteBzrDir
812
# delegate to the repository format which would lead to infinite
813
# recursion if we just called a_bzrdir.create_repository.
814
a_bzrdir._ensure_real()
815
result = a_bzrdir._real_bzrdir.create_repository(shared=shared)
816
if not isinstance(result, RemoteRepository):
817
return self.open(a_bzrdir)
821
def initialize(self, a_bzrdir, shared=False):
822
# Being asked to create on a non RemoteBzrDir:
823
if not isinstance(a_bzrdir, RemoteBzrDir):
824
return self._vfs_initialize(a_bzrdir, shared)
825
medium = a_bzrdir._client._medium
826
if medium._is_remote_before((1, 13)):
827
return self._vfs_initialize(a_bzrdir, shared)
828
# Creating on a remote bzr dir.
829
# 1) get the network name to use.
830
if self._custom_format:
831
network_name = self._custom_format.network_name()
832
elif self._network_name:
833
network_name = self._network_name
835
# Select the current bzrlib default and ask for that.
836
reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
837
reference_format = reference_bzrdir_format.repository_format
838
network_name = reference_format.network_name()
839
# 2) try direct creation via RPC
840
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
841
verb = 'BzrDir.create_repository'
847
response = a_bzrdir._call(verb, path, network_name, shared_str)
848
except errors.UnknownSmartMethod:
849
# Fallback - use vfs methods
850
medium._remember_remote_is_before((1, 13))
851
return self._vfs_initialize(a_bzrdir, shared)
853
# Turn the response into a RemoteRepository object.
854
format = response_tuple_to_repo_format(response[1:])
855
# Used to support creating a real format instance when needed.
856
format._creating_bzrdir = a_bzrdir
857
remote_repo = RemoteRepository(a_bzrdir, format)
858
format._creating_repo = remote_repo
256
return a_bzrdir.create_repository(shared=shared)
861
258
def open(self, a_bzrdir):
862
259
if not isinstance(a_bzrdir, RemoteBzrDir):
863
260
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
864
261
return a_bzrdir.open_repository()
866
def _ensure_real(self):
867
if self._custom_format is None:
868
self._custom_format = _mod_repository.network_format_registry.get(
872
def _fetch_order(self):
874
return self._custom_format._fetch_order
877
def _fetch_uses_deltas(self):
879
return self._custom_format._fetch_uses_deltas
882
def _fetch_reconcile(self):
884
return self._custom_format._fetch_reconcile
886
263
def get_format_description(self):
888
return 'Remote: ' + self._custom_format.get_format_description()
264
return 'bzr remote repository'
890
266
def __eq__(self, other):
891
return self.__class__ is other.__class__
893
def network_name(self):
894
if self._network_name:
895
return self._network_name
896
self._creating_repo._ensure_real()
897
return self._creating_repo._real_repository._format.network_name()
900
def pack_compresses(self):
902
return self._custom_format.pack_compresses
905
def _serializer(self):
907
return self._custom_format._serializer
910
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
911
controldir.ControlComponent):
267
return self.__class__ == other.__class__
269
def check_conversion_target(self, target_format):
270
if self.rich_root_data and not target_format.rich_root_data:
271
raise errors.BadConversionTarget(
272
'Does not support rich root data.', target_format)
273
if (self.supports_tree_reference and
274
not getattr(target_format, 'supports_tree_reference', False)):
275
raise errors.BadConversionTarget(
276
'Does not support nested trees', target_format)
279
class RemoteRepository(object):
912
280
"""Repository accessed over rpc.
914
282
For the moment most operations are performed using local transport-backed
1122
419
for line in lines:
1123
420
d = tuple(line.split())
1124
421
revision_graph[d[0]] = d[1:]
1126
423
return revision_graph
1128
def _get_sink(self):
1129
"""See Repository._get_sink()."""
1130
return RemoteStreamSink(self)
1132
def _get_source(self, to_format):
1133
"""Return a source for streaming from this repository."""
1134
return RemoteStreamSource(self, to_format)
1137
def get_file_graph(self):
1138
return graph.Graph(self.texts)
1141
425
def has_revision(self, revision_id):
1142
"""True if this repository has a copy of the revision."""
1143
# Copy of bzrlib.repository.Repository.has_revision
1144
return revision_id in self.has_revisions((revision_id,))
426
"""See Repository.has_revision()."""
427
if revision_id == NULL_REVISION:
428
# The null revision is always present.
430
path = self.bzrdir._path_for_remote_call(self._client)
431
response = self._client.call(
432
'Repository.has_revision', path, revision_id)
433
if response[0] not in ('yes', 'no'):
434
raise errors.UnexpectedSmartServerResponse(response)
435
return response[0] == 'yes'
1147
437
def has_revisions(self, revision_ids):
1148
"""Probe to find out the presence of multiple revisions.
1150
:param revision_ids: An iterable of revision_ids.
1151
:return: A set of the revision_ids that were present.
1153
# Copy of bzrlib.repository.Repository.has_revisions
1154
parent_map = self.get_parent_map(revision_ids)
1155
result = set(parent_map)
1156
if _mod_revision.NULL_REVISION in revision_ids:
1157
result.add(_mod_revision.NULL_REVISION)
438
"""See Repository.has_revisions()."""
440
for revision_id in revision_ids:
441
if self.has_revision(revision_id):
442
result.add(revision_id)
1160
def _has_same_fallbacks(self, other_repo):
1161
"""Returns true if the repositories have the same fallbacks."""
1162
# XXX: copied from Repository; it should be unified into a base class
1163
# <https://bugs.launchpad.net/bzr/+bug/401622>
1164
my_fb = self._fallback_repositories
1165
other_fb = other_repo._fallback_repositories
1166
if len(my_fb) != len(other_fb):
1168
for f, g in zip(my_fb, other_fb):
1169
if not f.has_same_location(g):
1173
445
def has_same_location(self, other):
1174
# TODO: Move to RepositoryBase and unify with the regular Repository
1175
# one; unfortunately the tests rely on slightly different behaviour at
1176
# present -- mbp 20090710
1177
return (self.__class__ is other.__class__ and
446
return (self.__class__ == other.__class__ and
1178
447
self.bzrdir.transport.base == other.bzrdir.transport.base)
1180
449
def get_graph(self, other_repository=None):
1181
450
"""Return the graph for this repository format"""
1182
parents_provider = self._make_parents_provider(other_repository)
451
parents_provider = self
452
if (other_repository is not None and
453
other_repository.bzrdir.transport.base !=
454
self.bzrdir.transport.base):
455
parents_provider = graph._StackedParentsProvider(
456
[parents_provider, other_repository._make_parents_provider()])
1183
457
return graph.Graph(parents_provider)
1186
def get_known_graph_ancestry(self, revision_ids):
1187
"""Return the known graph for a set of revision ids and their ancestors.
1189
st = static_tuple.StaticTuple
1190
revision_keys = [st(r_id).intern() for r_id in revision_ids]
1191
known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
1192
return graph.GraphThunkIdsToKeys(known_graph)
1194
459
def gather_stats(self, revid=None, committers=None):
1195
460
"""See Repository.gather_stats()."""
1196
461
path = self.bzrdir._path_for_remote_call(self._client)
1197
462
# revid can be None to indicate no revisions, not just NULL_REVISION
1198
if revid is None or _mod_revision.is_null(revid):
463
if revid is None or revision.is_null(revid):
1201
466
fmt_revid = revid
1485
700
def get_commit_builder(self, branch, parents, config, timestamp=None,
1486
701
timezone=None, committer=None, revprops=None,
1487
revision_id=None, lossy=False):
1488
703
# FIXME: It ought to be possible to call this without immediately
1489
704
# triggering _ensure_real. For now it's the easiest thing to do.
1490
705
self._ensure_real()
1491
real_repo = self._real_repository
1492
builder = real_repo.get_commit_builder(branch, parents,
706
builder = self._real_repository.get_commit_builder(branch, parents,
1493
707
config, timestamp=timestamp, timezone=timezone,
1494
committer=committer, revprops=revprops,
1495
revision_id=revision_id, lossy=lossy)
708
committer=committer, revprops=revprops, revision_id=revision_id)
1498
711
def add_fallback_repository(self, repository):
1499
712
"""Add a repository to use for looking up data not held locally.
1501
714
:param repository: A repository.
1503
716
if not self._format.supports_external_lookups:
1504
raise errors.UnstackableRepositoryFormat(
1505
self._format.network_name(), self.base)
717
raise errors.UnstackableRepositoryFormat(self._format, self.base)
1506
718
# We need to accumulate additional repositories here, to pass them in
1507
719
# on various RPC's.
1509
if self.is_locked():
1510
# We will call fallback.unlock() when we transition to the unlocked
1511
# state, so always add a lock here. If a caller passes us a locked
1512
# repository, they are responsible for unlocking it later.
1513
repository.lock_read()
1514
self._check_fallback_repository(repository)
1515
720
self._fallback_repositories.append(repository)
1516
# If self._real_repository was parameterised already (e.g. because a
1517
# _real_branch had its get_stacked_on_url method called), then the
1518
# repository to be added may already be in the _real_repositories list.
1519
if self._real_repository is not None:
1520
fallback_locations = [repo.user_url for repo in
1521
self._real_repository._fallback_repositories]
1522
if repository.user_url not in fallback_locations:
1523
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
722
def add_inventory(self, revid, inv, parents):
1536
723
self._ensure_real()
1537
724
return self._real_repository.add_inventory(revid, inv, parents)
1539
def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1540
parents, basis_inv=None, propagate_caches=False):
1542
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)
1546
726
def add_revision(self, rev_id, rev, inv=None, config=None):
1547
727
self._ensure_real()
1548
728
return self._real_repository.add_revision(
1606
772
@needs_read_lock
1607
def search_missing_revision_ids(self, other,
1608
revision_id=symbol_versioning.DEPRECATED_PARAMETER,
1609
find_ghosts=True, revision_ids=None, if_present_ids=None,
773
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1611
774
"""Return the revision ids that other has that this does not.
1613
776
These are returned in topological order.
1615
778
revision_id: only return revision ids included by revision_id.
1617
if symbol_versioning.deprecated_passed(revision_id):
1618
symbol_versioning.warn(
1619
'search_missing_revision_ids(revision_id=...) was '
1620
'deprecated in 2.4. Use revision_ids=[...] instead.',
1621
DeprecationWarning, stacklevel=2)
1622
if revision_ids is not None:
1623
raise AssertionError(
1624
'revision_ids is mutually exclusive with revision_id')
1625
if revision_id is not None:
1626
revision_ids = [revision_id]
1627
inter_repo = _mod_repository.InterRepository.get(other, self)
1628
return inter_repo.search_missing_revision_ids(
1629
find_ghosts=find_ghosts, revision_ids=revision_ids,
1630
if_present_ids=if_present_ids, limit=limit)
780
return repository.InterRepository.get(
781
other, self).search_missing_revision_ids(revision_id, find_ghosts)
1632
def fetch(self, source, revision_id=None, find_ghosts=False,
1634
# No base implementation to use as RemoteRepository is not a subclass
1635
# of Repository; so this is a copy of Repository.fetch().
1636
if fetch_spec is not None and revision_id is not None:
1637
raise AssertionError(
1638
"fetch_spec and revision_id are mutually exclusive.")
1639
if self.is_in_write_group():
1640
raise errors.InternalBzrError(
1641
"May not fetch while in a write group.")
1642
# fast path same-url fetch operations
1643
if (self.has_same_location(source)
1644
and fetch_spec is None
1645
and self._has_same_fallbacks(source)):
783
def fetch(self, source, revision_id=None, pb=None):
784
if self.has_same_location(source):
1646
785
# check that last_revision is in 'from' and then return a
1648
787
if (revision_id is not None and
1649
not _mod_revision.is_null(revision_id)):
788
not revision.is_null(revision_id)):
1650
789
self.get_revision(revision_id)
1652
# if there is no specific appropriate InterRepository, this will get
1653
# the InterRepository base class, which raises an
1654
# IncompatibleRepositories when asked to fetch.
1655
inter = _mod_repository.InterRepository.get(source, self)
1656
return inter.fetch(revision_id=revision_id,
1657
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
792
return self._real_repository.fetch(
793
source, revision_id=revision_id, pb=pb)
1659
795
def create_bundle(self, target, base, fileobj, format=None):
1660
796
self._ensure_real()
1661
797
self._real_repository.create_bundle(target, base, fileobj, format)
1663
799
@needs_read_lock
1664
@symbol_versioning.deprecated_method(
1665
symbol_versioning.deprecated_in((2, 4, 0)))
1666
800
def get_ancestry(self, revision_id, topo_sorted=True):
1667
801
self._ensure_real()
1668
802
return self._real_repository.get_ancestry(revision_id, topo_sorted)
1675
809
self._ensure_real()
1676
810
return self._real_repository._get_versioned_file_checker(
1677
811
revisions, revision_versions_cache)
1679
813
def iter_files_bytes(self, desired_files):
1680
814
"""See Repository.iter_file_bytes.
1682
816
self._ensure_real()
1683
817
return self._real_repository.iter_files_bytes(desired_files)
1685
def get_parent_map(self, revision_ids):
820
def _fetch_order(self):
821
"""Decorate the real repository for now.
823
In the long term getting this back from the remote repository as part
824
of open would be more efficient.
827
return self._real_repository._fetch_order
830
def _fetch_uses_deltas(self):
831
"""Decorate the real repository for now.
833
In the long term getting this back from the remote repository as part
834
of open would be more efficient.
837
return self._real_repository._fetch_uses_deltas
840
def _fetch_reconcile(self):
841
"""Decorate the real repository for now.
843
In the long term getting this back from the remote repository as part
844
of open would be more efficient.
847
return self._real_repository._fetch_reconcile
849
def get_parent_map(self, keys):
1686
850
"""See bzrlib.Graph.get_parent_map()."""
1687
return self._make_parents_provider().get_parent_map(revision_ids)
851
# Hack to build up the caching logic.
852
ancestry = self._parents_map
854
# Repository is not locked, so there's no cache.
855
missing_revisions = set(keys)
858
missing_revisions = set(key for key in keys if key not in ancestry)
859
if missing_revisions:
860
parent_map = self._get_parent_map(missing_revisions)
861
if 'hpss' in debug.debug_flags:
862
mutter('retransmitted revisions: %d of %d',
863
len(set(ancestry).intersection(parent_map)),
865
ancestry.update(parent_map)
866
present_keys = [k for k in keys if k in ancestry]
867
if 'hpss' in debug.debug_flags:
868
if self._requested_parents is not None and len(ancestry) != 0:
869
self._requested_parents.update(present_keys)
870
mutter('Current RemoteRepository graph hit rate: %d%%',
871
100.0 * len(self._requested_parents) / len(ancestry))
872
return dict((k, ancestry[k]) for k in present_keys)
1689
def _get_parent_map_rpc(self, keys):
874
def _get_parent_map(self, keys):
1690
875
"""Helper for get_parent_map that performs the RPC."""
1691
876
medium = self._client._medium
1692
877
if medium._is_remote_before((1, 2)):
1693
878
# We already found out that the server can't understand
1694
879
# Repository.get_parent_map requests, so just fetch the whole
1697
# Note that this reads the whole graph, when only some keys are
1698
# wanted. On this old server there's no way (?) to get them all
1699
# in one go, and the user probably will have seen a warning about
1700
# the server being old anyhow.
1701
rg = self._get_revision_graph(None)
1702
# There is an API discrepancy between get_parent_map and
881
# XXX: Note that this will issue a deprecation warning. This is ok
882
# :- its because we're working with a deprecated server anyway, and
883
# the user will almost certainly have seen a warning about the
884
# server version already.
885
rg = self.get_revision_graph()
886
# There is an api discrepency between get_parent_map and
1703
887
# get_revision_graph. Specifically, a "key:()" pair in
1704
888
# get_revision_graph just means a node has no parents. For
1705
889
# "get_parent_map" it means the node is a ghost. So fix up the
2025
1181
:param recipe: A search recipe (start, stop, count).
2026
1182
:return: Serialised bytes.
2028
start_keys = ' '.join(recipe[1])
2029
stop_keys = ' '.join(recipe[2])
2030
count = str(recipe[3])
1184
start_keys = ' '.join(recipe[0])
1185
stop_keys = ' '.join(recipe[1])
1186
count = str(recipe[2])
2031
1187
return '\n'.join((start_keys, stop_keys, count))
2033
def _serialise_search_result(self, search_result):
2034
parts = search_result.get_network_struct()
2035
return '\n'.join(parts)
2038
path = self.bzrdir._path_for_remote_call(self._client)
2040
response = self._call('PackRepository.autopack', path)
2041
except errors.UnknownSmartMethod:
2043
self._real_repository._pack_collection.autopack()
2046
if response[0] != 'ok':
2047
raise errors.UnexpectedSmartServerResponse(response)
2050
class RemoteStreamSink(vf_repository.StreamSink):
2052
def _insert_real(self, stream, src_format, resume_tokens):
2053
self.target_repo._ensure_real()
2054
sink = self.target_repo._real_repository._get_sink()
2055
result = sink.insert_stream(stream, src_format, resume_tokens)
2057
self.target_repo.autopack()
2060
def insert_stream(self, stream, src_format, resume_tokens):
2061
target = self.target_repo
2062
target._unstacked_provider.missing_keys.clear()
2063
candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
2064
if target._lock_token:
2065
candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
2066
lock_args = (target._lock_token or '',)
2068
candidate_calls.append(('Repository.insert_stream', (1, 13)))
2070
client = target._client
2071
medium = client._medium
2072
path = target.bzrdir._path_for_remote_call(client)
2073
# Probe for the verb to use with an empty stream before sending the
2074
# real stream to it. We do this both to avoid the risk of sending a
2075
# large request that is then rejected, and because we don't want to
2076
# implement a way to buffer, rewind, or restart the stream.
2078
for verb, required_version in candidate_calls:
2079
if medium._is_remote_before(required_version):
2082
# We've already done the probing (and set _is_remote_before) on
2083
# a previous insert.
2086
byte_stream = smart_repo._stream_to_byte_stream([], src_format)
2088
response = client.call_with_body_stream(
2089
(verb, path, '') + lock_args, byte_stream)
2090
except errors.UnknownSmartMethod:
2091
medium._remember_remote_is_before(required_version)
2097
return self._insert_real(stream, src_format, resume_tokens)
2098
self._last_inv_record = None
2099
self._last_substream = None
2100
if required_version < (1, 19):
2101
# Remote side doesn't support inventory deltas. Wrap the stream to
2102
# make sure we don't send any. If the stream contains inventory
2103
# deltas we'll interrupt the smart insert_stream request and
2105
stream = self._stop_stream_if_inventory_delta(stream)
2106
byte_stream = smart_repo._stream_to_byte_stream(
2108
resume_tokens = ' '.join(resume_tokens)
2109
response = client.call_with_body_stream(
2110
(verb, path, resume_tokens) + lock_args, byte_stream)
2111
if response[0][0] not in ('ok', 'missing-basis'):
2112
raise errors.UnexpectedSmartServerResponse(response)
2113
if self._last_substream is not None:
2114
# The stream included an inventory-delta record, but the remote
2115
# side isn't new enough to support them. So we need to send the
2116
# rest of the stream via VFS.
2117
self.target_repo.refresh_data()
2118
return self._resume_stream_with_vfs(response, src_format)
2119
if response[0][0] == 'missing-basis':
2120
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
2121
resume_tokens = tokens
2122
return resume_tokens, set(missing_keys)
2124
self.target_repo.refresh_data()
2127
def _resume_stream_with_vfs(self, response, src_format):
2128
"""Resume sending a stream via VFS, first resending the record and
2129
substream that couldn't be sent via an insert_stream verb.
2131
if response[0][0] == 'missing-basis':
2132
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
2133
# Ignore missing_keys, we haven't finished inserting yet
2136
def resume_substream():
2137
# Yield the substream that was interrupted.
2138
for record in self._last_substream:
2140
self._last_substream = None
2141
def resume_stream():
2142
# Finish sending the interrupted substream
2143
yield ('inventory-deltas', resume_substream())
2144
# Then simply continue sending the rest of the stream.
2145
for substream_kind, substream in self._last_stream:
2146
yield substream_kind, substream
2147
return self._insert_real(resume_stream(), src_format, tokens)
2149
def _stop_stream_if_inventory_delta(self, stream):
2150
"""Normally this just lets the original stream pass-through unchanged.
2152
However if any 'inventory-deltas' substream occurs it will stop
2153
streaming, and store the interrupted substream and stream in
2154
self._last_substream and self._last_stream so that the stream can be
2155
resumed by _resume_stream_with_vfs.
2158
stream_iter = iter(stream)
2159
for substream_kind, substream in stream_iter:
2160
if substream_kind == 'inventory-deltas':
2161
self._last_substream = substream
2162
self._last_stream = stream_iter
2165
yield substream_kind, substream
2168
class RemoteStreamSource(vf_repository.StreamSource):
2169
"""Stream data from a remote server."""
2171
def get_stream(self, search):
2172
if (self.from_repository._fallback_repositories and
2173
self.to_format._fetch_order == 'topological'):
2174
return self._real_stream(self.from_repository, search)
2177
repos = [self.from_repository]
2183
repos.extend(repo._fallback_repositories)
2184
sources.append(repo)
2185
return self.missing_parents_chain(search, sources)
2187
def get_stream_for_missing_keys(self, missing_keys):
2188
self.from_repository._ensure_real()
2189
real_repo = self.from_repository._real_repository
2190
real_source = real_repo._get_source(self.to_format)
2191
return real_source.get_stream_for_missing_keys(missing_keys)
2193
def _real_stream(self, repo, search):
2194
"""Get a stream for search from repo.
2196
This never called RemoteStreamSource.get_stream, and is a heler
2197
for RemoteStreamSource._get_stream to allow getting a stream
2198
reliably whether fallback back because of old servers or trying
2199
to stream from a non-RemoteRepository (which the stacked support
2202
source = repo._get_source(self.to_format)
2203
if isinstance(source, RemoteStreamSource):
2205
source = repo._real_repository._get_source(self.to_format)
2206
return source.get_stream(search)
2208
def _get_stream(self, repo, search):
2209
"""Core worker to get a stream from repo for search.
2211
This is used by both get_stream and the stacking support logic. It
2212
deliberately gets a stream for repo which does not need to be
2213
self.from_repository. In the event that repo is not Remote, or
2214
cannot do a smart stream, a fallback is made to the generic
2215
repository._get_stream() interface, via self._real_stream.
2217
In the event of stacking, streams from _get_stream will not
2218
contain all the data for search - this is normal (see get_stream).
2220
:param repo: A repository.
2221
:param search: A search.
2223
# Fallbacks may be non-smart
2224
if not isinstance(repo, RemoteRepository):
2225
return self._real_stream(repo, search)
2226
client = repo._client
2227
medium = client._medium
2228
path = repo.bzrdir._path_for_remote_call(client)
2229
search_bytes = repo._serialise_search_result(search)
2230
args = (path, self.to_format.network_name())
2232
('Repository.get_stream_1.19', (1, 19)),
2233
('Repository.get_stream', (1, 13))]
2236
for verb, version in candidate_verbs:
2237
if medium._is_remote_before(version):
2240
response = repo._call_with_body_bytes_expecting_body(
2241
verb, args, search_bytes)
2242
except errors.UnknownSmartMethod:
2243
medium._remember_remote_is_before(version)
2244
except errors.UnknownErrorFromSmartServer, e:
2245
if isinstance(search, graph.EverythingResult):
2246
error_verb = e.error_from_smart_server.error_verb
2247
if error_verb == 'BadSearch':
2248
# Pre-2.4 servers don't support this sort of search.
2249
# XXX: perhaps falling back to VFS on BadSearch is a
2250
# good idea in general? It might provide a little bit
2251
# of protection against client-side bugs.
2252
medium._remember_remote_is_before((2, 4))
2256
response_tuple, response_handler = response
2260
return self._real_stream(repo, search)
2261
if response_tuple[0] != 'ok':
2262
raise errors.UnexpectedSmartServerResponse(response_tuple)
2263
byte_stream = response_handler.read_streamed_body()
2264
src_format, stream = smart_repo._byte_stream_to_stream(byte_stream,
2265
self._record_counter)
2266
if src_format.network_name() != repo._format.network_name():
2267
raise AssertionError(
2268
"Mismatched RemoteRepository and stream src %r, %r" % (
2269
src_format.network_name(), repo._format.network_name()))
2272
def missing_parents_chain(self, search, sources):
2273
"""Chain multiple streams together to handle stacking.
2275
:param search: The overall search to satisfy with streams.
2276
:param sources: A list of Repository objects to query.
2278
self.from_serialiser = self.from_repository._format._serializer
2279
self.seen_revs = set()
2280
self.referenced_revs = set()
2281
# If there are heads in the search, or the key count is > 0, we are not
2283
while not search.is_empty() and len(sources) > 1:
2284
source = sources.pop(0)
2285
stream = self._get_stream(source, search)
2286
for kind, substream in stream:
2287
if kind != 'revisions':
2288
yield kind, substream
2290
yield kind, self.missing_parents_rev_handler(substream)
2291
search = search.refine(self.seen_revs, self.referenced_revs)
2292
self.seen_revs = set()
2293
self.referenced_revs = set()
2294
if not search.is_empty():
2295
for kind, stream in self._get_stream(sources[0], search):
2298
def missing_parents_rev_handler(self, substream):
2299
for content in substream:
2300
revision_bytes = content.get_bytes_as('fulltext')
2301
revision = self.from_serialiser.read_revision_from_string(
2303
self.seen_revs.add(content.key[-1])
2304
self.referenced_revs.update(revision.parent_ids)
2308
1190
class RemoteBranchLockableFiles(LockableFiles):
2309
1191
"""A 'LockableFiles' implementation that talks to a smart server.
2311
1193
This is not a public interface class.
2328
1210
class RemoteBranchFormat(branch.BranchFormat):
2330
def __init__(self, network_name=None):
2331
super(RemoteBranchFormat, self).__init__()
2332
self._matchingbzrdir = RemoteBzrDirFormat()
2333
self._matchingbzrdir.set_branch_format(self)
2334
self._custom_format = None
2335
self._network_name = network_name
2337
1212
def __eq__(self, other):
2338
return (isinstance(other, RemoteBranchFormat) and
1213
return (isinstance(other, RemoteBranchFormat) and
2339
1214
self.__dict__ == other.__dict__)
2341
def _ensure_real(self):
2342
if self._custom_format is None:
2343
self._custom_format = branch.network_format_registry.get(
2346
1216
def get_format_description(self):
2348
return 'Remote: ' + self._custom_format.get_format_description()
2350
def network_name(self):
2351
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)
2357
def _vfs_initialize(self, a_bzrdir, name):
2358
# Initialisation when using a local bzrdir object, or a non-vfs init
2359
# method is not available on the server.
2360
# self._custom_format is always set - the start of initialize ensures
2362
if isinstance(a_bzrdir, RemoteBzrDir):
2363
a_bzrdir._ensure_real()
2364
result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2367
# We assume the bzrdir is parameterised; it may not be.
2368
result = self._custom_format.initialize(a_bzrdir, name)
2369
if (isinstance(a_bzrdir, RemoteBzrDir) and
2370
not isinstance(result, RemoteBranch)):
2371
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2375
def initialize(self, a_bzrdir, name=None, repository=None):
2376
# 1) get the network name to use.
2377
if self._custom_format:
2378
network_name = self._custom_format.network_name()
2380
# Select the current bzrlib default and ask for that.
2381
reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
2382
reference_format = reference_bzrdir_format.get_branch_format()
2383
self._custom_format = reference_format
2384
network_name = reference_format.network_name()
2385
# Being asked to create on a non RemoteBzrDir:
2386
if not isinstance(a_bzrdir, RemoteBzrDir):
2387
return self._vfs_initialize(a_bzrdir, name=name)
2388
medium = a_bzrdir._client._medium
2389
if medium._is_remote_before((1, 13)):
2390
return self._vfs_initialize(a_bzrdir, name=name)
2391
# Creating on a remote bzr dir.
2392
# 2) try direct creation via RPC
2393
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
verb = 'BzrDir.create_branch'
2399
response = a_bzrdir._call(verb, path, network_name)
2400
except errors.UnknownSmartMethod:
2401
# Fallback - use vfs methods
2402
medium._remember_remote_is_before((1, 13))
2403
return self._vfs_initialize(a_bzrdir, name=name)
2404
if response[0] != 'ok':
2405
raise errors.UnexpectedSmartServerResponse(response)
2406
# Turn the response into a RemoteRepository object.
2407
format = RemoteBranchFormat(network_name=response[1])
2408
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
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)
2428
remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2429
format=format, setup_stacking=False, name=name)
2430
# XXX: We know this is a new branch, so it must have revno 0, revid
2431
# NULL_REVISION. Creating the branch locked would make this be unable
2432
# to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2433
remote_branch._last_revision_info_cache = 0, NULL_REVISION
2434
return remote_branch
2436
def make_tags(self, branch):
2438
return self._custom_format.make_tags(branch)
1217
return 'Remote BZR Branch'
1219
def get_format_string(self):
1220
return 'Remote BZR Branch'
1222
def open(self, a_bzrdir):
1223
return a_bzrdir.open_branch()
1225
def initialize(self, a_bzrdir):
1226
return a_bzrdir.create_branch()
2440
1228
def supports_tags(self):
2441
1229
# Remote branches might support tags, but we won't know until we
2442
1230
# access the real remote branch.
2444
return self._custom_format.supports_tags()
2446
def supports_stacking(self):
2448
return self._custom_format.supports_stacking()
2450
def supports_set_append_revisions_only(self):
2452
return self._custom_format.supports_set_append_revisions_only()
2454
def _use_default_local_heads_to_fetch(self):
2455
# If the branch format is a metadir format *and* its heads_to_fetch
2456
# implementation is not overridden vs the base class, we can use the
2457
# base class logic rather than use the heads_to_fetch RPC. This is
2458
# usually cheaper in terms of net round trips, as the last-revision and
2459
# tags info fetched is cached and would be fetched anyway.
2461
if isinstance(self._custom_format, branch.BranchFormatMetadir):
2462
branch_class = self._custom_format._branch_class()
2463
heads_to_fetch_impl = branch_class.heads_to_fetch.im_func
2464
if heads_to_fetch_impl is branch.Branch.heads_to_fetch.im_func:
2468
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
1234
class RemoteBranch(branch.Branch):
2469
1235
"""Branch stored on a server accessed by HPSS RPC.
2471
1237
At the moment most operations are mapped down to simple file operations.
2474
1240
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2475
_client=None, format=None, setup_stacking=True, name=None):
2476
1242
"""Create a RemoteBranch instance.
2478
1244
:param real_branch: An optional local implementation of the branch
2479
1245
format, usually accessing the data via the VFS.
2480
1246
:param _client: Private parameter for testing.
2481
:param format: A RemoteBranchFormat object, None to create one
2482
automatically. If supplied it should have a network_name already
2484
:param setup_stacking: If True make an RPC call to determine the
2485
stacked (or not) status of the branch. If False assume the branch
2487
:param name: Colocated branch name
2489
1248
# We intentionally don't call the parent class's __init__, because it
2490
1249
# will try to assign to self.tags, which is a property in this subclass.
2491
1250
# And the parent's __init__ doesn't do much anyway.
1251
self._revision_id_to_revno_cache = None
1252
self._revision_history_cache = None
1253
self._last_revision_info_cache = None
2492
1254
self.bzrdir = remote_bzrdir
2493
1255
if _client is not None:
2494
1256
self._client = _client
2646
1362
:raises UnstackableRepositoryFormat: If the repository does not support
2650
# there may not be a repository yet, so we can't use
2651
# self._translate_error, so we can't use self._call either.
2652
response = self._client.call('Branch.get_stacked_on_url',
2653
self._remote_path())
2654
except errors.ErrorFromSmartServer, err:
2655
# there may not be a repository yet, so we can't call through
2656
# its _translate_error
2657
_translate_error(err, branch=self)
2658
except errors.UnknownSmartMethod, err:
2660
return self._real_branch.get_stacked_on_url()
2661
if response[0] != 'ok':
2662
raise errors.UnexpectedSmartServerResponse(response)
2665
def set_stacked_on_url(self, url):
2666
branch.Branch.set_stacked_on_url(self, url)
2668
self._is_stacked = False
2670
self._is_stacked = True
2672
def _vfs_get_tags_bytes(self):
2674
return self._real_branch._get_tags_bytes()
2677
def _get_tags_bytes(self):
2678
if self._tags_bytes is None:
2679
self._tags_bytes = self._get_tags_bytes_via_hpss()
2680
return self._tags_bytes
2682
def _get_tags_bytes_via_hpss(self):
2683
medium = self._client._medium
2684
if medium._is_remote_before((1, 13)):
2685
return self._vfs_get_tags_bytes()
2687
response = self._call('Branch.get_tags_bytes', self._remote_path())
2688
except errors.UnknownSmartMethod:
2689
medium._remember_remote_is_before((1, 13))
2690
return self._vfs_get_tags_bytes()
2693
def _vfs_set_tags_bytes(self, bytes):
2695
return self._real_branch._set_tags_bytes(bytes)
2697
def _set_tags_bytes(self, bytes):
2698
if self.is_locked():
2699
self._tags_bytes = bytes
2700
medium = self._client._medium
2701
if medium._is_remote_before((1, 18)):
2702
self._vfs_set_tags_bytes(bytes)
2706
self._remote_path(), self._lock_token, self._repo_lock_token)
2707
response = self._call_with_body_bytes(
2708
'Branch.set_tags_bytes', args, bytes)
2709
except errors.UnknownSmartMethod:
2710
medium._remember_remote_is_before((1, 18))
2711
self._vfs_set_tags_bytes(bytes)
1366
return self._real_branch.get_stacked_on_url()
2713
1368
def lock_read(self):
2714
"""Lock the branch for read operations.
2716
:return: A bzrlib.lock.LogicalLockResult.
2718
self.repository.lock_read()
2719
1369
if not self._lock_mode:
2720
self._note_lock('r')
2721
1370
self._lock_mode = 'r'
2722
1371
self._lock_count = 1
2723
1372
if self._real_branch is not None:
2724
1373
self._real_branch.lock_read()
2726
1375
self._lock_count += 1
2727
return lock.LogicalLockResult(self.unlock)
2729
1377
def _remote_lock_write(self, token):
2730
1378
if token is None:
2731
1379
branch_token = repo_token = ''
2733
1381
branch_token = token
2734
repo_token = self.repository.lock_write().repository_token
1382
repo_token = self.repository.lock_write()
2735
1383
self.repository.unlock()
2736
err_context = {'token': token}
1384
path = self.bzrdir._path_for_remote_call(self._client)
2738
response = self._call(
2739
'Branch.lock_write', self._remote_path(), branch_token,
2740
repo_token or '', **err_context)
2741
except errors.LockContention, e:
2742
# The LockContention from the server doesn't have any
2743
# information about the lock_url. We re-raise LockContention
2744
# with valid lock_url.
2745
raise errors.LockContention('(remote lock)',
2746
self.repository.base.split('.bzr/')[0])
1386
response = self._client.call(
1387
'Branch.lock_write', path, branch_token, repo_token or '')
1388
except errors.ErrorFromSmartServer, err:
1389
self._translate_error(err, token=token)
2747
1390
if response[0] != 'ok':
2748
1391
raise errors.UnexpectedSmartServerResponse(response)
2749
1392
ok, branch_token, repo_token = response
2750
1393
return branch_token, repo_token
2752
1395
def lock_write(self, token=None):
2753
1396
if not self._lock_mode:
2754
self._note_lock('w')
2755
# Lock the branch and repo in one remote call.
2756
1397
remote_tokens = self._remote_lock_write(token)
2757
1398
self._lock_token, self._repo_lock_token = remote_tokens
2758
1399
if not self._lock_token:
2759
1400
raise SmartProtocolError('Remote server did not return a token!')
2760
# Tell the self.repository object that it is locked.
2761
self.repository.lock_write(
2762
self._repo_lock_token, _skip_rpc=True)
1401
# TODO: We really, really, really don't want to call _ensure_real
1402
# here, but it's the easiest way to ensure coherency between the
1403
# state of the RemoteBranch and RemoteRepository objects and the
1404
# physical locks. If we don't materialise the real objects here,
1405
# then getting everything in the right state later is complex, so
1406
# for now we just do it the lazy way.
1407
# -- Andrew Bennetts, 2007-02-22.
2764
1409
if self._real_branch is not None:
2765
self._real_branch.lock_write(token=self._lock_token)
1410
self._real_branch.repository.lock_write(
1411
token=self._repo_lock_token)
1413
self._real_branch.lock_write(token=self._lock_token)
1415
self._real_branch.repository.unlock()
2766
1416
if token is not None:
2767
1417
self._leave_lock = True
1419
# XXX: this case seems to be unreachable; token cannot be None.
2769
1420
self._leave_lock = False
2770
1421
self._lock_mode = 'w'
2771
1422
self._lock_count = 1
2772
1423
elif self._lock_mode == 'r':
2773
raise errors.ReadOnlyError(self)
1424
raise errors.ReadOnlyTransaction
2775
1426
if token is not None:
2776
# A token was given to lock_write, and we're relocking, so
2777
# check that the given token actually matches the one we
1427
# A token was given to lock_write, and we're relocking, so check
1428
# that the given token actually matches the one we already have.
2779
1429
if token != self._lock_token:
2780
1430
raise errors.TokenMismatch(token, self._lock_token)
2781
1431
self._lock_count += 1
2782
# Re-lock the repository too.
2783
self.repository.lock_write(self._repo_lock_token)
2784
return BranchWriteLockResult(self.unlock, self._lock_token or None)
1432
return self._lock_token or None
2786
1434
def _unlock(self, branch_token, repo_token):
2787
err_context = {'token': str((branch_token, repo_token))}
2788
response = self._call(
2789
'Branch.unlock', self._remote_path(), branch_token,
2790
repo_token or '', **err_context)
1435
path = self.bzrdir._path_for_remote_call(self._client)
1437
response = self._client.call('Branch.unlock', path, branch_token,
1439
except errors.ErrorFromSmartServer, err:
1440
self._translate_error(err, token=str((branch_token, repo_token)))
2791
1441
if response == ('ok',):
2793
1443
raise errors.UnexpectedSmartServerResponse(response)
2795
@only_raises(errors.LockNotHeld, errors.LockBroken)
2796
1445
def unlock(self):
2798
self._lock_count -= 1
2799
if not self._lock_count:
2800
self._clear_cached_state()
2801
mode = self._lock_mode
2802
self._lock_mode = None
2803
if self._real_branch is not None:
2804
if (not self._leave_lock and mode == 'w' and
2805
self._repo_lock_token):
2806
# If this RemoteBranch will remove the physical lock
2807
# for the repository, make sure the _real_branch
2808
# doesn't do it first. (Because the _real_branch's
2809
# repository is set to be the RemoteRepository.)
2810
self._real_branch.repository.leave_lock_in_place()
2811
self._real_branch.unlock()
2813
# Only write-locked branched need to make a remote method
2814
# call to perform the unlock.
2816
if not self._lock_token:
2817
raise AssertionError('Locked, but no token!')
2818
branch_token = self._lock_token
2819
repo_token = self._repo_lock_token
2820
self._lock_token = None
2821
self._repo_lock_token = None
2822
if not self._leave_lock:
2823
self._unlock(branch_token, repo_token)
2825
self.repository.unlock()
1446
self._lock_count -= 1
1447
if not self._lock_count:
1448
self._clear_cached_state()
1449
mode = self._lock_mode
1450
self._lock_mode = None
1451
if self._real_branch is not None:
1452
if (not self._leave_lock and mode == 'w' and
1453
self._repo_lock_token):
1454
# If this RemoteBranch will remove the physical lock for the
1455
# repository, make sure the _real_branch doesn't do it
1456
# first. (Because the _real_branch's repository is set to
1457
# be the RemoteRepository.)
1458
self._real_branch.repository.leave_lock_in_place()
1459
self._real_branch.unlock()
1461
# Only write-locked branched need to make a remote method call
1462
# to perfom the unlock.
1464
if not self._lock_token:
1465
raise AssertionError('Locked, but no token!')
1466
branch_token = self._lock_token
1467
repo_token = self._repo_lock_token
1468
self._lock_token = None
1469
self._repo_lock_token = None
1470
if not self._leave_lock:
1471
self._unlock(branch_token, repo_token)
2827
1473
def break_lock(self):
2828
1474
self._ensure_real()
2881
def _remote_path(self):
2882
return self.bzrdir._path_for_remote_call(self._client)
2884
1508
def _set_last_revision_descendant(self, revision_id, other_branch,
2885
1509
allow_diverged=False, allow_overwrite_descendant=False):
2886
# This performs additional work to meet the hook contract; while its
2887
# undesirable, we have to synthesise the revno to call the hook, and
2888
# not calling the hook is worse as it means changes can't be prevented.
2889
# Having calculated this though, we can't just call into
2890
# set_last_revision_info as a simple call, because there is a set_rh
2891
# hook that some folk may still be using.
2892
old_revno, old_revid = self.last_revision_info()
2893
history = self._lefthand_history(revision_id)
2894
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2895
err_context = {'other_branch': other_branch}
2896
response = self._call('Branch.set_last_revision_ex',
2897
self._remote_path(), self._lock_token, self._repo_lock_token,
2898
revision_id, int(allow_diverged), int(allow_overwrite_descendant),
1510
path = self.bzrdir._path_for_remote_call(self._client)
1512
response = self._client.call('Branch.set_last_revision_ex',
1513
path, self._lock_token, self._repo_lock_token, revision_id,
1514
int(allow_diverged), int(allow_overwrite_descendant))
1515
except errors.ErrorFromSmartServer, err:
1516
self._translate_error(err, other_branch=other_branch)
2900
1517
self._clear_cached_state()
2901
1518
if len(response) != 3 and response[0] != 'ok':
2902
1519
raise errors.UnexpectedSmartServerResponse(response)
2903
1520
new_revno, new_revision_id = response[1:]
2904
1521
self._last_revision_info_cache = new_revno, new_revision_id
2905
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2906
if self._real_branch is not None:
2907
cache = new_revno, new_revision_id
2908
self._real_branch._last_revision_info_cache = cache
1522
self._real_branch._last_revision_info_cache = new_revno, new_revision_id
2910
1524
def _set_last_revision(self, revision_id):
2911
old_revno, old_revid = self.last_revision_info()
2912
# This performs additional work to meet the hook contract; while its
2913
# undesirable, we have to synthesise the revno to call the hook, and
2914
# not calling the hook is worse as it means changes can't be prevented.
2915
# Having calculated this though, we can't just call into
2916
# set_last_revision_info as a simple call, because there is a set_rh
2917
# hook that some folk may still be using.
2918
history = self._lefthand_history(revision_id)
2919
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
1525
path = self.bzrdir._path_for_remote_call(self._client)
2920
1526
self._clear_cached_state()
2921
response = self._call('Branch.set_last_revision',
2922
self._remote_path(), self._lock_token, self._repo_lock_token,
1528
response = self._client.call('Branch.set_last_revision',
1529
path, self._lock_token, self._repo_lock_token, revision_id)
1530
except errors.ErrorFromSmartServer, err:
1531
self._translate_error(err)
2924
1532
if response != ('ok',):
2925
1533
raise errors.UnexpectedSmartServerResponse(response)
2926
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2928
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2929
1535
@needs_write_lock
2930
1536
def set_revision_history(self, rev_history):
2931
"""See Branch.set_revision_history."""
2932
self._set_revision_history(rev_history)
2935
def _set_revision_history(self, rev_history):
2936
1537
# Send just the tip revision of the history; the server will generate
2937
1538
# the full history from that. If the revision doesn't exist in this
2938
1539
# branch, NoSuchRevision will be raised.
3051
1635
except errors.UnknownSmartMethod:
3052
1636
medium._remember_remote_is_before((1, 6))
3053
1637
self._clear_cached_state_of_remote_branch_only()
3054
self._set_revision_history(self._lefthand_history(revision_id,
3055
last_rev=last_rev,other_branch=other_branch))
1639
self._real_branch.generate_revision_history(
1640
revision_id, last_rev=last_rev, other_branch=other_branch)
1645
return self._real_branch.tags
3057
1647
def set_push_location(self, location):
3058
1648
self._ensure_real()
3059
1649
return self._real_branch.set_push_location(location)
3061
def heads_to_fetch(self):
3062
if self._format._use_default_local_heads_to_fetch():
3063
# We recognise this format, and its heads-to-fetch implementation
3064
# is the default one (tip + tags). In this case it's cheaper to
3065
# just use the default implementation rather than a special RPC as
3066
# the tip and tags data is cached.
3067
return branch.Branch.heads_to_fetch(self)
3068
medium = self._client._medium
3069
if medium._is_remote_before((2, 4)):
3070
return self._vfs_heads_to_fetch()
3072
return self._rpc_heads_to_fetch()
3073
except errors.UnknownSmartMethod:
3074
medium._remember_remote_is_before((2, 4))
3075
return self._vfs_heads_to_fetch()
3077
def _rpc_heads_to_fetch(self):
3078
response = self._call('Branch.heads_to_fetch', self._remote_path())
3079
if len(response) != 2:
3080
raise errors.UnexpectedSmartServerResponse(response)
3081
must_fetch, if_present_fetch = response
3082
return set(must_fetch), set(if_present_fetch)
3084
def _vfs_heads_to_fetch(self):
3086
return self._real_branch.heads_to_fetch()
3089
class RemoteConfig(object):
3090
"""A Config that reads and writes from smart verbs.
3092
It is a low-level object that considers config data to be name/value pairs
3093
that may be associated with a section. Assigning meaning to the these
3094
values is done at higher levels like bzrlib.config.TreeConfig.
3097
def get_option(self, name, section=None, default=None):
3098
"""Return the value associated with a named option.
3100
:param name: The name of the value
3101
:param section: The section the option is in (if any)
3102
:param default: The value to return if the value is not set
3103
:return: The value or default value
3106
configobj = self._get_configobj()
3109
section_obj = configobj
3112
section_obj = configobj[section]
3115
if section_obj is None:
3118
value = section_obj.get(name, default)
3119
except errors.UnknownSmartMethod:
3120
value = self._vfs_get_option(name, section, default)
3121
for hook in config.OldConfigHooks['get']:
3122
hook(self, name, value)
3125
def _response_to_configobj(self, response):
3126
if len(response[0]) and response[0][0] != 'ok':
3127
raise errors.UnexpectedSmartServerResponse(response)
3128
lines = response[1].read_body_bytes().splitlines()
3129
conf = config.ConfigObj(lines, encoding='utf-8')
3130
for hook in config.OldConfigHooks['load']:
3135
class RemoteBranchConfig(RemoteConfig):
3136
"""A RemoteConfig for Branches."""
3138
def __init__(self, branch):
3139
self._branch = branch
3141
def _get_configobj(self):
3142
path = self._branch._remote_path()
3143
response = self._branch._client.call_expecting_body(
3144
'Branch.get_config_file', path)
3145
return self._response_to_configobj(response)
3147
def set_option(self, value, name, section=None):
3148
"""Set the value associated with a named option.
3150
:param value: The value to set
3151
:param name: The name of the value to set
3152
:param section: The section the option is in (if any)
3154
medium = self._branch._client._medium
3155
if medium._is_remote_before((1, 14)):
3156
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
path = self._branch._remote_path()
3167
response = self._branch._client.call('Branch.set_config_option',
3168
path, self._branch._lock_token, self._branch._repo_lock_token,
3169
value.encode('utf8'), name, section or '')
3170
except errors.UnknownSmartMethod:
3171
medium = self._branch._client._medium
3172
medium._remember_remote_is_before((1, 14))
3173
return self._vfs_set_option(value, name, section)
3175
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
def _real_object(self):
3203
self._branch._ensure_real()
3204
return self._branch._real_branch
3206
def _vfs_set_option(self, value, name, section=None):
3207
return self._real_object()._get_config().set_option(
3208
value, name, section)
3211
class RemoteBzrDirConfig(RemoteConfig):
3212
"""A RemoteConfig for BzrDirs."""
3214
def __init__(self, bzrdir):
3215
self._bzrdir = bzrdir
3217
def _get_configobj(self):
3218
medium = self._bzrdir._client._medium
3219
verb = 'BzrDir.get_config_file'
3220
if medium._is_remote_before((1, 15)):
3221
raise errors.UnknownSmartMethod(verb)
3222
path = self._bzrdir._path_for_remote_call(self._bzrdir._client)
3223
response = self._bzrdir._call_expecting_body(
3225
return self._response_to_configobj(response)
3227
def _vfs_get_option(self, name, section, default):
3228
return self._real_object()._get_config().get_option(
3229
name, section, default)
3231
def set_option(self, value, name, section=None):
3232
"""Set the value associated with a named option.
3234
:param value: The value to set
3235
:param name: The name of the value to set
3236
:param section: The section the option is in (if any)
3238
return self._real_object()._get_config().set_option(
3239
value, name, section)
3241
def _real_object(self):
3242
self._bzrdir._ensure_real()
3243
return self._bzrdir._real_bzrdir
1652
def update_revisions(self, other, stop_revision=None, overwrite=False,
1654
"""See Branch.update_revisions."""
1657
if stop_revision is None:
1658
stop_revision = other.last_revision()
1659
if revision.is_null(stop_revision):
1660
# if there are no commits, we're done.
1662
self.fetch(other, stop_revision)
1665
# Just unconditionally set the new revision. We don't care if
1666
# the branches have diverged.
1667
self._set_last_revision(stop_revision)
1669
medium = self._client._medium
1670
if not medium._is_remote_before((1, 6)):
1672
self._set_last_revision_descendant(stop_revision, other)
1674
except errors.UnknownSmartMethod:
1675
medium._remember_remote_is_before((1, 6))
1676
# Fallback for pre-1.6 servers: check for divergence
1677
# client-side, then do _set_last_revision.
1678
last_rev = revision.ensure_null(self.last_revision())
1680
graph = self.repository.get_graph()
1681
if self._check_if_descendant_or_diverged(
1682
stop_revision, last_rev, graph, other):
1683
# stop_revision is a descendant of last_rev, but we aren't
1684
# overwriting, so we're done.
1686
self._set_last_revision(stop_revision)
3247
1691
def _extract_tar(tar, to_dir):
3267
If the error from the server doesn't match a known pattern, then
3268
UnknownErrorFromSmartServer is raised.
3270
1710
def find(name):
3272
1712
return context[name]
3273
except KeyError, key_err:
3274
mutter('Missing key %r in context %r', key_err.args[0], context)
1713
except KeyError, keyErr:
1714
mutter('Missing key %r in context %r', keyErr.args[0], context)
3277
"""Get the path from the context if present, otherwise use first error
3281
return context['path']
3282
except KeyError, key_err:
3284
return err.error_args[0]
3285
except IndexError, idx_err:
3287
'Missing key %r in context %r', key_err.args[0], context)
3290
1716
if err.error_verb == 'NoSuchRevision':
3291
1717
raise NoSuchRevision(find('branch'), err.error_args[0])
3292
1718
elif err.error_verb == 'nosuchrevision':
3293
1719
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,
1720
elif err.error_tuple == ('nobranch',):
1721
raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
3301
1722
elif err.error_verb == 'norepository':
3302
1723
raise errors.NoRepositoryPresent(find('bzrdir'))
1724
elif err.error_verb == 'LockContention':
1725
raise errors.LockContention('(remote lock)')
3303
1726
elif err.error_verb == 'UnlockableTransport':
3304
1727
raise errors.UnlockableTransport(find('bzrdir').root_transport)
1728
elif err.error_verb == 'LockFailed':
1729
raise errors.LockFailed(err.error_args[0], err.error_args[1])
3305
1730
elif err.error_verb == 'TokenMismatch':
3306
1731
raise errors.TokenMismatch(find('token'), '(remote token)')
3307
1732
elif err.error_verb == 'Diverged':
3308
1733
raise errors.DivergedBranches(find('branch'), find('other_branch'))
3309
elif err.error_verb == 'NotStacked':
3310
raise errors.NotStacked(branch=find('branch'))
3311
elif err.error_verb == 'PermissionDenied':
3313
if len(err.error_args) >= 2:
3314
extra = err.error_args[1]
3317
raise errors.PermissionDenied(path, extra=extra)
3318
elif err.error_verb == 'ReadError':
3320
raise errors.ReadError(path)
3321
elif err.error_verb == 'NoSuchFile':
3323
raise errors.NoSuchFile(path)
3324
_translate_error_without_context(err)
3327
def _translate_error_without_context(err):
3328
"""Translate any ErrorFromSmartServer values that don't require context"""
3329
if err.error_verb == 'IncompatibleRepositories':
3330
raise errors.IncompatibleRepositories(err.error_args[0],
3331
err.error_args[1], err.error_args[2])
3332
elif err.error_verb == 'LockContention':
3333
raise errors.LockContention('(remote lock)')
3334
elif err.error_verb == 'LockFailed':
3335
raise errors.LockFailed(err.error_args[0], err.error_args[1])
3336
1734
elif err.error_verb == 'TipChangeRejected':
3337
1735
raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
3338
elif err.error_verb == 'UnstackableBranchFormat':
3339
raise errors.UnstackableBranchFormat(*err.error_args)
3340
elif err.error_verb == 'UnstackableRepositoryFormat':
3341
raise errors.UnstackableRepositoryFormat(*err.error_args)
3342
elif err.error_verb == 'FileExists':
3343
raise errors.FileExists(err.error_args[0])
3344
elif err.error_verb == 'DirectoryNotEmpty':
3345
raise errors.DirectoryNotEmpty(err.error_args[0])
3346
elif err.error_verb == 'ShortReadvError':
3347
args = err.error_args
3348
raise errors.ShortReadvError(
3349
args[0], int(args[1]), int(args[2]), int(args[3]))
3350
elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
3351
encoding = str(err.error_args[0]) # encoding must always be a string
3352
val = err.error_args[1]
3353
start = int(err.error_args[2])
3354
end = int(err.error_args[3])
3355
reason = str(err.error_args[4]) # reason must always be a string
3356
if val.startswith('u:'):
3357
val = val[2:].decode('utf-8')
3358
elif val.startswith('s:'):
3359
val = val[2:].decode('base64')
3360
if err.error_verb == 'UnicodeDecodeError':
3361
raise UnicodeDecodeError(encoding, val, start, end, reason)
3362
elif err.error_verb == 'UnicodeEncodeError':
3363
raise UnicodeEncodeError(encoding, val, start, end, reason)
3364
elif err.error_verb == 'ReadOnlyError':
3365
raise errors.TransportNotPossible('readonly transport')
3366
elif err.error_verb == 'MemoryError':
3367
raise errors.BzrError("remote server out of memory\n"
3368
"Retry non-remotely, or contact the server admin for details.")
3369
raise errors.UnknownErrorFromSmartServer(err)
added
removed
bzrlib/remote.py
