1
# Copyright (C) 2006-2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
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
22
bzrdir as _mod_bzrdir,
30
repository as _mod_repository,
31
revision as _mod_revision,
38
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
39
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
40
from bzrlib.errors import (
44
from bzrlib.lockable_files import LockableFiles
45
from bzrlib.smart import client, vfs, repository as smart_repo
46
from bzrlib.smart.client import _SmartClient
47
from bzrlib.revision import NULL_REVISION
48
from bzrlib.repository import RepositoryWriteLockResult, _LazyListJoin
49
from bzrlib.trace import mutter, note, warning
52
class _RpcHelper(object):
53
"""Mixin class that helps with issuing RPCs."""
55
def _call(self, method, *args, **err_context):
57
return self._client.call(method, *args)
58
except errors.ErrorFromSmartServer, err:
59
self._translate_error(err, **err_context)
61
def _call_expecting_body(self, method, *args, **err_context):
63
return self._client.call_expecting_body(method, *args)
64
except errors.ErrorFromSmartServer, err:
65
self._translate_error(err, **err_context)
67
def _call_with_body_bytes(self, method, args, body_bytes, **err_context):
69
return self._client.call_with_body_bytes(method, args, body_bytes)
70
except errors.ErrorFromSmartServer, err:
71
self._translate_error(err, **err_context)
73
def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
76
return self._client.call_with_body_bytes_expecting_body(
77
method, args, body_bytes)
78
except errors.ErrorFromSmartServer, err:
79
self._translate_error(err, **err_context)
82
def response_tuple_to_repo_format(response):
83
"""Convert a response tuple describing a repository format to a format."""
84
format = RemoteRepositoryFormat()
85
format._rich_root_data = (response[0] == 'yes')
86
format._supports_tree_reference = (response[1] == 'yes')
87
format._supports_external_lookups = (response[2] == 'yes')
88
format._network_name = response[3]
92
# Note that RemoteBzrDirProber lives in bzrlib.bzrdir so bzrlib.remote
93
# does not have to be imported unless a remote format is involved.
95
class RemoteBzrDirFormat(_mod_bzrdir.BzrDirMetaFormat1):
96
"""Format representing bzrdirs accessed via a smart server"""
98
supports_workingtrees = False
101
_mod_bzrdir.BzrDirMetaFormat1.__init__(self)
102
# XXX: It's a bit ugly that the network name is here, because we'd
103
# like to believe that format objects are stateless or at least
104
# immutable, However, we do at least avoid mutating the name after
105
# it's returned. See <https://bugs.launchpad.net/bzr/+bug/504102>
106
self._network_name = None
109
return "%s(_network_name=%r)" % (self.__class__.__name__,
112
def get_format_description(self):
113
if self._network_name:
114
real_format = controldir.network_format_registry.get(self._network_name)
115
return 'Remote: ' + real_format.get_format_description()
116
return 'bzr remote bzrdir'
118
def get_format_string(self):
119
raise NotImplementedError(self.get_format_string)
121
def network_name(self):
122
if self._network_name:
123
return self._network_name
125
raise AssertionError("No network name set.")
127
def initialize_on_transport(self, transport):
129
# hand off the request to the smart server
130
client_medium = transport.get_smart_medium()
131
except errors.NoSmartMedium:
132
# TODO: lookup the local format from a server hint.
133
local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
134
return local_dir_format.initialize_on_transport(transport)
135
client = _SmartClient(client_medium)
136
path = client.remote_path_from_transport(transport)
138
response = client.call('BzrDirFormat.initialize', path)
139
except errors.ErrorFromSmartServer, err:
140
_translate_error(err, path=path)
141
if response[0] != 'ok':
142
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
143
format = RemoteBzrDirFormat()
144
self._supply_sub_formats_to(format)
145
return RemoteBzrDir(transport, format)
147
def parse_NoneTrueFalse(self, arg):
154
raise AssertionError("invalid arg %r" % arg)
156
def _serialize_NoneTrueFalse(self, arg):
163
def _serialize_NoneString(self, arg):
166
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
167
create_prefix=False, force_new_repo=False, stacked_on=None,
168
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
171
# hand off the request to the smart server
172
client_medium = transport.get_smart_medium()
173
except errors.NoSmartMedium:
176
# Decline to open it if the server doesn't support our required
177
# version (3) so that the VFS-based transport will do it.
178
if client_medium.should_probe():
180
server_version = client_medium.protocol_version()
181
if server_version != '2':
185
except errors.SmartProtocolError:
186
# Apparently there's no usable smart server there, even though
187
# the medium supports the smart protocol.
192
client = _SmartClient(client_medium)
193
path = client.remote_path_from_transport(transport)
194
if client_medium._is_remote_before((1, 16)):
197
# TODO: lookup the local format from a server hint.
198
local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
199
self._supply_sub_formats_to(local_dir_format)
200
return local_dir_format.initialize_on_transport_ex(transport,
201
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
202
force_new_repo=force_new_repo, stacked_on=stacked_on,
203
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
204
make_working_trees=make_working_trees, shared_repo=shared_repo,
206
return self._initialize_on_transport_ex_rpc(client, path, transport,
207
use_existing_dir, create_prefix, force_new_repo, stacked_on,
208
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
210
def _initialize_on_transport_ex_rpc(self, client, path, transport,
211
use_existing_dir, create_prefix, force_new_repo, stacked_on,
212
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
214
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
215
args.append(self._serialize_NoneTrueFalse(create_prefix))
216
args.append(self._serialize_NoneTrueFalse(force_new_repo))
217
args.append(self._serialize_NoneString(stacked_on))
218
# stack_on_pwd is often/usually our transport
221
stack_on_pwd = transport.relpath(stack_on_pwd)
224
except errors.PathNotChild:
226
args.append(self._serialize_NoneString(stack_on_pwd))
227
args.append(self._serialize_NoneString(repo_format_name))
228
args.append(self._serialize_NoneTrueFalse(make_working_trees))
229
args.append(self._serialize_NoneTrueFalse(shared_repo))
230
request_network_name = self._network_name or \
231
_mod_bzrdir.BzrDirFormat.get_default_format().network_name()
233
response = client.call('BzrDirFormat.initialize_ex_1.16',
234
request_network_name, path, *args)
235
except errors.UnknownSmartMethod:
236
client._medium._remember_remote_is_before((1,16))
237
local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
238
self._supply_sub_formats_to(local_dir_format)
239
return local_dir_format.initialize_on_transport_ex(transport,
240
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
241
force_new_repo=force_new_repo, stacked_on=stacked_on,
242
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
243
make_working_trees=make_working_trees, shared_repo=shared_repo,
245
except errors.ErrorFromSmartServer, err:
246
_translate_error(err, path=path)
247
repo_path = response[0]
248
bzrdir_name = response[6]
249
require_stacking = response[7]
250
require_stacking = self.parse_NoneTrueFalse(require_stacking)
251
format = RemoteBzrDirFormat()
252
format._network_name = bzrdir_name
253
self._supply_sub_formats_to(format)
254
bzrdir = RemoteBzrDir(transport, format, _client=client)
256
repo_format = response_tuple_to_repo_format(response[1:])
260
repo_bzrdir_format = RemoteBzrDirFormat()
261
repo_bzrdir_format._network_name = response[5]
262
repo_bzr = RemoteBzrDir(transport.clone(repo_path),
266
final_stack = response[8] or None
267
final_stack_pwd = response[9] or None
269
final_stack_pwd = urlutils.join(
270
transport.base, final_stack_pwd)
271
remote_repo = RemoteRepository(repo_bzr, repo_format)
272
if len(response) > 10:
273
# Updated server verb that locks remotely.
274
repo_lock_token = response[10] or None
275
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
277
remote_repo.dont_leave_lock_in_place()
279
remote_repo.lock_write()
280
policy = _mod_bzrdir.UseExistingRepository(remote_repo, final_stack,
281
final_stack_pwd, require_stacking)
282
policy.acquire_repository()
286
bzrdir._format.set_branch_format(self.get_branch_format())
288
# The repo has already been created, but we need to make sure that
289
# we'll make a stackable branch.
290
bzrdir._format.require_stacking(_skip_repo=True)
291
return remote_repo, bzrdir, require_stacking, policy
293
def _open(self, transport):
294
return RemoteBzrDir(transport, self)
296
def __eq__(self, other):
297
if not isinstance(other, RemoteBzrDirFormat):
299
return self.get_format_description() == other.get_format_description()
301
def __return_repository_format(self):
302
# Always return a RemoteRepositoryFormat object, but if a specific bzr
303
# repository format has been asked for, tell the RemoteRepositoryFormat
304
# that it should use that for init() etc.
305
result = RemoteRepositoryFormat()
306
custom_format = getattr(self, '_repository_format', None)
308
if isinstance(custom_format, RemoteRepositoryFormat):
311
# We will use the custom format to create repositories over the
312
# wire; expose its details like rich_root_data for code to
314
result._custom_format = custom_format
317
def get_branch_format(self):
318
result = _mod_bzrdir.BzrDirMetaFormat1.get_branch_format(self)
319
if not isinstance(result, RemoteBranchFormat):
320
new_result = RemoteBranchFormat()
321
new_result._custom_format = result
323
self.set_branch_format(new_result)
327
repository_format = property(__return_repository_format,
328
_mod_bzrdir.BzrDirMetaFormat1._set_repository_format) #.im_func)
331
class RemoteBzrDir(_mod_bzrdir.BzrDir, _RpcHelper):
332
"""Control directory on a remote server, accessed via bzr:// or similar."""
334
def __init__(self, transport, format, _client=None, _force_probe=False):
335
"""Construct a RemoteBzrDir.
337
:param _client: Private parameter for testing. Disables probing and the
338
use of a real bzrdir.
340
_mod_bzrdir.BzrDir.__init__(self, transport, format)
341
# this object holds a delegated bzrdir that uses file-level operations
342
# to talk to the other side
343
self._real_bzrdir = None
344
self._has_working_tree = None
345
# 1-shot cache for the call pattern 'create_branch; open_branch' - see
346
# create_branch for details.
347
self._next_open_branch_result = None
350
medium = transport.get_smart_medium()
351
self._client = client._SmartClient(medium)
353
self._client = _client
360
return '%s(%r)' % (self.__class__.__name__, self._client)
362
def _probe_bzrdir(self):
363
medium = self._client._medium
364
path = self._path_for_remote_call(self._client)
365
if medium._is_remote_before((2, 1)):
369
self._rpc_open_2_1(path)
371
except errors.UnknownSmartMethod:
372
medium._remember_remote_is_before((2, 1))
375
def _rpc_open_2_1(self, path):
376
response = self._call('BzrDir.open_2.1', path)
377
if response == ('no',):
378
raise errors.NotBranchError(path=self.root_transport.base)
379
elif response[0] == 'yes':
380
if response[1] == 'yes':
381
self._has_working_tree = True
382
elif response[1] == 'no':
383
self._has_working_tree = False
385
raise errors.UnexpectedSmartServerResponse(response)
387
raise errors.UnexpectedSmartServerResponse(response)
389
def _rpc_open(self, path):
390
response = self._call('BzrDir.open', path)
391
if response not in [('yes',), ('no',)]:
392
raise errors.UnexpectedSmartServerResponse(response)
393
if response == ('no',):
394
raise errors.NotBranchError(path=self.root_transport.base)
396
def _ensure_real(self):
397
"""Ensure that there is a _real_bzrdir set.
399
Used before calls to self._real_bzrdir.
401
if not self._real_bzrdir:
402
if 'hpssvfs' in debug.debug_flags:
404
warning('VFS BzrDir access triggered\n%s',
405
''.join(traceback.format_stack()))
406
self._real_bzrdir = _mod_bzrdir.BzrDir.open_from_transport(
407
self.root_transport, _server_formats=False)
408
self._format._network_name = \
409
self._real_bzrdir._format.network_name()
411
def _translate_error(self, err, **context):
412
_translate_error(err, bzrdir=self, **context)
414
def break_lock(self):
415
# Prevent aliasing problems in the next_open_branch_result cache.
416
# See create_branch for rationale.
417
self._next_open_branch_result = None
418
return _mod_bzrdir.BzrDir.break_lock(self)
420
def _vfs_cloning_metadir(self, require_stacking=False):
422
return self._real_bzrdir.cloning_metadir(
423
require_stacking=require_stacking)
425
def cloning_metadir(self, require_stacking=False):
426
medium = self._client._medium
427
if medium._is_remote_before((1, 13)):
428
return self._vfs_cloning_metadir(require_stacking=require_stacking)
429
verb = 'BzrDir.cloning_metadir'
434
path = self._path_for_remote_call(self._client)
436
response = self._call(verb, path, stacking)
437
except errors.UnknownSmartMethod:
438
medium._remember_remote_is_before((1, 13))
439
return self._vfs_cloning_metadir(require_stacking=require_stacking)
440
except errors.UnknownErrorFromSmartServer, err:
441
if err.error_tuple != ('BranchReference',):
443
# We need to resolve the branch reference to determine the
444
# cloning_metadir. This causes unnecessary RPCs to open the
445
# referenced branch (and bzrdir, etc) but only when the caller
446
# didn't already resolve the branch reference.
447
referenced_branch = self.open_branch()
448
return referenced_branch.bzrdir.cloning_metadir()
449
if len(response) != 3:
450
raise errors.UnexpectedSmartServerResponse(response)
451
control_name, repo_name, branch_info = response
452
if len(branch_info) != 2:
453
raise errors.UnexpectedSmartServerResponse(response)
454
branch_ref, branch_name = branch_info
455
format = controldir.network_format_registry.get(control_name)
457
format.repository_format = _mod_repository.network_format_registry.get(
459
if branch_ref == 'ref':
460
# XXX: we need possible_transports here to avoid reopening the
461
# connection to the referenced location
462
ref_bzrdir = _mod_bzrdir.BzrDir.open(branch_name)
463
branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
464
format.set_branch_format(branch_format)
465
elif branch_ref == 'branch':
467
format.set_branch_format(
468
branch.network_format_registry.get(branch_name))
470
raise errors.UnexpectedSmartServerResponse(response)
473
def create_repository(self, shared=False):
474
# as per meta1 formats - just delegate to the format object which may
476
result = self._format.repository_format.initialize(self, shared)
477
if not isinstance(result, RemoteRepository):
478
return self.open_repository()
482
def destroy_repository(self):
483
"""See BzrDir.destroy_repository"""
485
self._real_bzrdir.destroy_repository()
487
def create_branch(self, name=None, repository=None):
488
# as per meta1 formats - just delegate to the format object which may
490
real_branch = self._format.get_branch_format().initialize(self,
491
name=name, repository=repository)
492
if not isinstance(real_branch, RemoteBranch):
493
if not isinstance(repository, RemoteRepository):
494
raise AssertionError(
495
'need a RemoteRepository to use with RemoteBranch, got %r'
497
result = RemoteBranch(self, repository, real_branch, name=name)
500
# BzrDir.clone_on_transport() uses the result of create_branch but does
501
# not return it to its callers; we save approximately 8% of our round
502
# trips by handing the branch we created back to the first caller to
503
# open_branch rather than probing anew. Long term we need a API in
504
# bzrdir that doesn't discard result objects (like result_branch).
506
self._next_open_branch_result = result
509
def destroy_branch(self, name=None):
510
"""See BzrDir.destroy_branch"""
512
self._real_bzrdir.destroy_branch(name=name)
513
self._next_open_branch_result = None
515
def create_workingtree(self, revision_id=None, from_branch=None,
516
accelerator_tree=None, hardlink=False):
517
raise errors.NotLocalUrl(self.transport.base)
519
def find_branch_format(self, name=None):
520
"""Find the branch 'format' for this bzrdir.
522
This might be a synthetic object for e.g. RemoteBranch and SVN.
524
b = self.open_branch(name=name)
527
def get_branch_reference(self, name=None):
528
"""See BzrDir.get_branch_reference()."""
530
# XXX JRV20100304: Support opening colocated branches
531
raise errors.NoColocatedBranchSupport(self)
532
response = self._get_branch_reference()
533
if response[0] == 'ref':
538
def _get_branch_reference(self):
539
path = self._path_for_remote_call(self._client)
540
medium = self._client._medium
542
('BzrDir.open_branchV3', (2, 1)),
543
('BzrDir.open_branchV2', (1, 13)),
544
('BzrDir.open_branch', None),
546
for verb, required_version in candidate_calls:
547
if required_version and medium._is_remote_before(required_version):
550
response = self._call(verb, path)
551
except errors.UnknownSmartMethod:
552
if required_version is None:
554
medium._remember_remote_is_before(required_version)
557
if verb == 'BzrDir.open_branch':
558
if response[0] != 'ok':
559
raise errors.UnexpectedSmartServerResponse(response)
560
if response[1] != '':
561
return ('ref', response[1])
563
return ('branch', '')
564
if response[0] not in ('ref', 'branch'):
565
raise errors.UnexpectedSmartServerResponse(response)
568
def _get_tree_branch(self, name=None):
569
"""See BzrDir._get_tree_branch()."""
570
return None, self.open_branch(name=name)
572
def open_branch(self, name=None, unsupported=False,
573
ignore_fallbacks=False):
575
raise NotImplementedError('unsupported flag support not implemented yet.')
576
if self._next_open_branch_result is not None:
577
# See create_branch for details.
578
result = self._next_open_branch_result
579
self._next_open_branch_result = None
581
response = self._get_branch_reference()
582
if response[0] == 'ref':
583
# a branch reference, use the existing BranchReference logic.
584
format = BranchReferenceFormat()
585
return format.open(self, name=name, _found=True,
586
location=response[1], ignore_fallbacks=ignore_fallbacks)
587
branch_format_name = response[1]
588
if not branch_format_name:
589
branch_format_name = None
590
format = RemoteBranchFormat(network_name=branch_format_name)
591
return RemoteBranch(self, self.find_repository(), format=format,
592
setup_stacking=not ignore_fallbacks, name=name)
594
def _open_repo_v1(self, path):
595
verb = 'BzrDir.find_repository'
596
response = self._call(verb, path)
597
if response[0] != 'ok':
598
raise errors.UnexpectedSmartServerResponse(response)
599
# servers that only support the v1 method don't support external
602
repo = self._real_bzrdir.open_repository()
603
response = response + ('no', repo._format.network_name())
604
return response, repo
606
def _open_repo_v2(self, path):
607
verb = 'BzrDir.find_repositoryV2'
608
response = self._call(verb, path)
609
if response[0] != 'ok':
610
raise errors.UnexpectedSmartServerResponse(response)
612
repo = self._real_bzrdir.open_repository()
613
response = response + (repo._format.network_name(),)
614
return response, repo
616
def _open_repo_v3(self, path):
617
verb = 'BzrDir.find_repositoryV3'
618
medium = self._client._medium
619
if medium._is_remote_before((1, 13)):
620
raise errors.UnknownSmartMethod(verb)
622
response = self._call(verb, path)
623
except errors.UnknownSmartMethod:
624
medium._remember_remote_is_before((1, 13))
626
if response[0] != 'ok':
627
raise errors.UnexpectedSmartServerResponse(response)
628
return response, None
630
def open_repository(self):
631
path = self._path_for_remote_call(self._client)
633
for probe in [self._open_repo_v3, self._open_repo_v2,
636
response, real_repo = probe(path)
638
except errors.UnknownSmartMethod:
641
raise errors.UnknownSmartMethod('BzrDir.find_repository{3,2,}')
642
if response[0] != 'ok':
643
raise errors.UnexpectedSmartServerResponse(response)
644
if len(response) != 6:
645
raise SmartProtocolError('incorrect response length %s' % (response,))
646
if response[1] == '':
647
# repo is at this dir.
648
format = response_tuple_to_repo_format(response[2:])
649
# Used to support creating a real format instance when needed.
650
format._creating_bzrdir = self
651
remote_repo = RemoteRepository(self, format)
652
format._creating_repo = remote_repo
653
if real_repo is not None:
654
remote_repo._set_real_repository(real_repo)
657
raise errors.NoRepositoryPresent(self)
659
def has_workingtree(self):
660
if self._has_working_tree is None:
662
self._has_working_tree = self._real_bzrdir.has_workingtree()
663
return self._has_working_tree
665
def open_workingtree(self, recommend_upgrade=True):
666
if self.has_workingtree():
667
raise errors.NotLocalUrl(self.root_transport)
669
raise errors.NoWorkingTree(self.root_transport.base)
671
def _path_for_remote_call(self, client):
672
"""Return the path to be used for this bzrdir in a remote call."""
673
return client.remote_path_from_transport(self.root_transport)
675
def get_branch_transport(self, branch_format, name=None):
677
return self._real_bzrdir.get_branch_transport(branch_format, name=name)
679
def get_repository_transport(self, repository_format):
681
return self._real_bzrdir.get_repository_transport(repository_format)
683
def get_workingtree_transport(self, workingtree_format):
685
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
687
def can_convert_format(self):
688
"""Upgrading of remote bzrdirs is not supported yet."""
691
def needs_format_conversion(self, format):
692
"""Upgrading of remote bzrdirs is not supported yet."""
695
def clone(self, url, revision_id=None, force_new_repo=False,
696
preserve_stacking=False):
698
return self._real_bzrdir.clone(url, revision_id=revision_id,
699
force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
701
def _get_config(self):
702
return RemoteBzrDirConfig(self)
705
class RemoteRepositoryFormat(vf_repository.VersionedFileRepositoryFormat):
706
"""Format for repositories accessed over a _SmartClient.
708
Instances of this repository are represented by RemoteRepository
711
The RemoteRepositoryFormat is parameterized during construction
712
to reflect the capabilities of the real, remote format. Specifically
713
the attributes rich_root_data and supports_tree_reference are set
714
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
_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
804
prior_repo = self._creating_bzrdir.open_repository()
805
prior_repo._ensure_real()
806
result = prior_repo._real_repository._format.initialize(
807
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
861
def open(self, a_bzrdir):
862
if not isinstance(a_bzrdir, RemoteBzrDir):
863
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
864
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
def get_format_description(self):
888
return 'Remote: ' + self._custom_format.get_format_description()
890
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):
912
"""Repository accessed over rpc.
914
For the moment most operations are performed using local transport-backed
918
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
919
"""Create a RemoteRepository instance.
921
:param remote_bzrdir: The bzrdir hosting this repository.
922
:param format: The RemoteFormat object to use.
923
:param real_repository: If not None, a local implementation of the
924
repository logic for the repository, usually accessing the data
926
:param _client: Private testing parameter - override the smart client
927
to be used by the repository.
930
self._real_repository = real_repository
932
self._real_repository = None
933
self.bzrdir = remote_bzrdir
935
self._client = remote_bzrdir._client
937
self._client = _client
938
self._format = format
939
self._lock_mode = None
940
self._lock_token = None
942
self._leave_lock = False
943
# Cache of revision parents; misses are cached during read locks, and
944
# write locks when no _real_repository has been set.
945
self._unstacked_provider = graph.CachingParentsProvider(
946
get_parent_map=self._get_parent_map_rpc)
947
self._unstacked_provider.disable_cache()
949
# These depend on the actual remote format, so force them off for
950
# maximum compatibility. XXX: In future these should depend on the
951
# remote repository instance, but this is irrelevant until we perform
952
# reconcile via an RPC call.
953
self._reconcile_does_inventory_gc = False
954
self._reconcile_fixes_text_parents = False
955
self._reconcile_backsup_inventory = False
956
self.base = self.bzrdir.transport.base
957
# Additional places to query for data.
958
self._fallback_repositories = []
961
def user_transport(self):
962
return self.bzrdir.user_transport
965
def control_transport(self):
966
# XXX: Normally you shouldn't directly get at the remote repository
967
# transport, but I'm not sure it's worth making this method
968
# optional -- mbp 2010-04-21
969
return self.bzrdir.get_repository_transport(None)
972
return "%s(%s)" % (self.__class__.__name__, self.base)
976
def abort_write_group(self, suppress_errors=False):
977
"""Complete a write group on the decorated repository.
979
Smart methods perform operations in a single step so this API
980
is not really applicable except as a compatibility thunk
981
for older plugins that don't use e.g. the CommitBuilder
984
:param suppress_errors: see Repository.abort_write_group.
987
return self._real_repository.abort_write_group(
988
suppress_errors=suppress_errors)
992
"""Decorate the real repository for now.
994
In the long term a full blown network facility is needed to avoid
995
creating a real repository object locally.
998
return self._real_repository.chk_bytes
1000
def commit_write_group(self):
1001
"""Complete a write group on the decorated repository.
1003
Smart methods perform operations in a single step so this API
1004
is not really applicable except as a compatibility thunk
1005
for older plugins that don't use e.g. the CommitBuilder
1009
return self._real_repository.commit_write_group()
1011
def resume_write_group(self, tokens):
1013
return self._real_repository.resume_write_group(tokens)
1015
def suspend_write_group(self):
1017
return self._real_repository.suspend_write_group()
1019
def get_missing_parent_inventories(self, check_for_missing_texts=True):
1021
return self._real_repository.get_missing_parent_inventories(
1022
check_for_missing_texts=check_for_missing_texts)
1024
def _get_rev_id_for_revno_vfs(self, revno, known_pair):
1026
return self._real_repository.get_rev_id_for_revno(
1029
def get_rev_id_for_revno(self, revno, known_pair):
1030
"""See Repository.get_rev_id_for_revno."""
1031
path = self.bzrdir._path_for_remote_call(self._client)
1033
if self._client._medium._is_remote_before((1, 17)):
1034
return self._get_rev_id_for_revno_vfs(revno, known_pair)
1035
response = self._call(
1036
'Repository.get_rev_id_for_revno', path, revno, known_pair)
1037
except errors.UnknownSmartMethod:
1038
self._client._medium._remember_remote_is_before((1, 17))
1039
return self._get_rev_id_for_revno_vfs(revno, known_pair)
1040
if response[0] == 'ok':
1041
return True, response[1]
1042
elif response[0] == 'history-incomplete':
1043
known_pair = response[1:3]
1044
for fallback in self._fallback_repositories:
1045
found, result = fallback.get_rev_id_for_revno(revno, known_pair)
1050
# Not found in any fallbacks
1051
return False, known_pair
1053
raise errors.UnexpectedSmartServerResponse(response)
1055
def _ensure_real(self):
1056
"""Ensure that there is a _real_repository set.
1058
Used before calls to self._real_repository.
1060
Note that _ensure_real causes many roundtrips to the server which are
1061
not desirable, and prevents the use of smart one-roundtrip RPC's to
1062
perform complex operations (such as accessing parent data, streaming
1063
revisions etc). Adding calls to _ensure_real should only be done when
1064
bringing up new functionality, adding fallbacks for smart methods that
1065
require a fallback path, and never to replace an existing smart method
1066
invocation. If in doubt chat to the bzr network team.
1068
if self._real_repository is None:
1069
if 'hpssvfs' in debug.debug_flags:
1071
warning('VFS Repository access triggered\n%s',
1072
''.join(traceback.format_stack()))
1073
self._unstacked_provider.missing_keys.clear()
1074
self.bzrdir._ensure_real()
1075
self._set_real_repository(
1076
self.bzrdir._real_bzrdir.open_repository())
1078
def _translate_error(self, err, **context):
1079
self.bzrdir._translate_error(err, repository=self, **context)
1081
def find_text_key_references(self):
1082
"""Find the text key references within the repository.
1084
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
1085
revision_ids. Each altered file-ids has the exact revision_ids that
1086
altered it listed explicitly.
1087
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
1088
to whether they were referred to by the inventory of the
1089
revision_id that they contain. The inventory texts from all present
1090
revision ids are assessed to generate this report.
1093
return self._real_repository.find_text_key_references()
1095
def _generate_text_key_index(self):
1096
"""Generate a new text key index for the repository.
1098
This is an expensive function that will take considerable time to run.
1100
:return: A dict mapping (file_id, revision_id) tuples to a list of
1101
parents, also (file_id, revision_id) tuples.
1104
return self._real_repository._generate_text_key_index()
1106
def _get_revision_graph(self, revision_id):
1107
"""Private method for using with old (< 1.2) servers to fallback."""
1108
if revision_id is None:
1110
elif _mod_revision.is_null(revision_id):
1113
path = self.bzrdir._path_for_remote_call(self._client)
1114
response = self._call_expecting_body(
1115
'Repository.get_revision_graph', path, revision_id)
1116
response_tuple, response_handler = response
1117
if response_tuple[0] != 'ok':
1118
raise errors.UnexpectedSmartServerResponse(response_tuple)
1119
coded = response_handler.read_body_bytes()
1121
# no revisions in this repository!
1123
lines = coded.split('\n')
1126
d = tuple(line.split())
1127
revision_graph[d[0]] = d[1:]
1129
return revision_graph
1131
def _get_sink(self):
1132
"""See Repository._get_sink()."""
1133
return RemoteStreamSink(self)
1135
def _get_source(self, to_format):
1136
"""Return a source for streaming from this repository."""
1137
return RemoteStreamSource(self, to_format)
1140
def get_file_graph(self):
1141
return graph.Graph(self.texts)
1144
def has_revision(self, revision_id):
1145
"""True if this repository has a copy of the revision."""
1146
# Copy of bzrlib.repository.Repository.has_revision
1147
return revision_id in self.has_revisions((revision_id,))
1150
def has_revisions(self, revision_ids):
1151
"""Probe to find out the presence of multiple revisions.
1153
:param revision_ids: An iterable of revision_ids.
1154
:return: A set of the revision_ids that were present.
1156
# Copy of bzrlib.repository.Repository.has_revisions
1157
parent_map = self.get_parent_map(revision_ids)
1158
result = set(parent_map)
1159
if _mod_revision.NULL_REVISION in revision_ids:
1160
result.add(_mod_revision.NULL_REVISION)
1163
def _has_same_fallbacks(self, other_repo):
1164
"""Returns true if the repositories have the same fallbacks."""
1165
# XXX: copied from Repository; it should be unified into a base class
1166
# <https://bugs.launchpad.net/bzr/+bug/401622>
1167
my_fb = self._fallback_repositories
1168
other_fb = other_repo._fallback_repositories
1169
if len(my_fb) != len(other_fb):
1171
for f, g in zip(my_fb, other_fb):
1172
if not f.has_same_location(g):
1176
def has_same_location(self, other):
1177
# TODO: Move to RepositoryBase and unify with the regular Repository
1178
# one; unfortunately the tests rely on slightly different behaviour at
1179
# present -- mbp 20090710
1180
return (self.__class__ is other.__class__ and
1181
self.bzrdir.transport.base == other.bzrdir.transport.base)
1183
def get_graph(self, other_repository=None):
1184
"""Return the graph for this repository format"""
1185
parents_provider = self._make_parents_provider(other_repository)
1186
return graph.Graph(parents_provider)
1189
def get_known_graph_ancestry(self, revision_ids):
1190
"""Return the known graph for a set of revision ids and their ancestors.
1192
st = static_tuple.StaticTuple
1193
revision_keys = [st(r_id).intern() for r_id in revision_ids]
1194
known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
1195
return graph.GraphThunkIdsToKeys(known_graph)
1197
def gather_stats(self, revid=None, committers=None):
1198
"""See Repository.gather_stats()."""
1199
path = self.bzrdir._path_for_remote_call(self._client)
1200
# revid can be None to indicate no revisions, not just NULL_REVISION
1201
if revid is None or _mod_revision.is_null(revid):
1205
if committers is None or not committers:
1206
fmt_committers = 'no'
1208
fmt_committers = 'yes'
1209
response_tuple, response_handler = self._call_expecting_body(
1210
'Repository.gather_stats', path, fmt_revid, fmt_committers)
1211
if response_tuple[0] != 'ok':
1212
raise errors.UnexpectedSmartServerResponse(response_tuple)
1214
body = response_handler.read_body_bytes()
1216
for line in body.split('\n'):
1219
key, val_text = line.split(':')
1220
if key in ('revisions', 'size', 'committers'):
1221
result[key] = int(val_text)
1222
elif key in ('firstrev', 'latestrev'):
1223
values = val_text.split(' ')[1:]
1224
result[key] = (float(values[0]), long(values[1]))
1228
def find_branches(self, using=False):
1229
"""See Repository.find_branches()."""
1230
# should be an API call to the server.
1232
return self._real_repository.find_branches(using=using)
1234
def get_physical_lock_status(self):
1235
"""See Repository.get_physical_lock_status()."""
1236
# should be an API call to the server.
1238
return self._real_repository.get_physical_lock_status()
1240
def is_in_write_group(self):
1241
"""Return True if there is an open write group.
1243
write groups are only applicable locally for the smart server..
1245
if self._real_repository:
1246
return self._real_repository.is_in_write_group()
1248
def is_locked(self):
1249
return self._lock_count >= 1
1251
def is_shared(self):
1252
"""See Repository.is_shared()."""
1253
path = self.bzrdir._path_for_remote_call(self._client)
1254
response = self._call('Repository.is_shared', path)
1255
if response[0] not in ('yes', 'no'):
1256
raise SmartProtocolError('unexpected response code %s' % (response,))
1257
return response[0] == 'yes'
1259
def is_write_locked(self):
1260
return self._lock_mode == 'w'
1262
def _warn_if_deprecated(self, branch=None):
1263
# If we have a real repository, the check will be done there, if we
1264
# don't the check will be done remotely.
1267
def lock_read(self):
1268
"""Lock the repository for read operations.
1270
:return: A bzrlib.lock.LogicalLockResult.
1272
# wrong eventually - want a local lock cache context
1273
if not self._lock_mode:
1274
self._note_lock('r')
1275
self._lock_mode = 'r'
1276
self._lock_count = 1
1277
self._unstacked_provider.enable_cache(cache_misses=True)
1278
if self._real_repository is not None:
1279
self._real_repository.lock_read()
1280
for repo in self._fallback_repositories:
1283
self._lock_count += 1
1284
return lock.LogicalLockResult(self.unlock)
1286
def _remote_lock_write(self, token):
1287
path = self.bzrdir._path_for_remote_call(self._client)
1290
err_context = {'token': token}
1291
response = self._call('Repository.lock_write', path, token,
1293
if response[0] == 'ok':
1294
ok, token = response
1297
raise errors.UnexpectedSmartServerResponse(response)
1299
def lock_write(self, token=None, _skip_rpc=False):
1300
if not self._lock_mode:
1301
self._note_lock('w')
1303
if self._lock_token is not None:
1304
if token != self._lock_token:
1305
raise errors.TokenMismatch(token, self._lock_token)
1306
self._lock_token = token
1308
self._lock_token = self._remote_lock_write(token)
1309
# if self._lock_token is None, then this is something like packs or
1310
# svn where we don't get to lock the repo, or a weave style repository
1311
# where we cannot lock it over the wire and attempts to do so will
1313
if self._real_repository is not None:
1314
self._real_repository.lock_write(token=self._lock_token)
1315
if token is not None:
1316
self._leave_lock = True
1318
self._leave_lock = False
1319
self._lock_mode = 'w'
1320
self._lock_count = 1
1321
cache_misses = self._real_repository is None
1322
self._unstacked_provider.enable_cache(cache_misses=cache_misses)
1323
for repo in self._fallback_repositories:
1324
# Writes don't affect fallback repos
1326
elif self._lock_mode == 'r':
1327
raise errors.ReadOnlyError(self)
1329
self._lock_count += 1
1330
return RepositoryWriteLockResult(self.unlock, self._lock_token or None)
1332
def leave_lock_in_place(self):
1333
if not self._lock_token:
1334
raise NotImplementedError(self.leave_lock_in_place)
1335
self._leave_lock = True
1337
def dont_leave_lock_in_place(self):
1338
if not self._lock_token:
1339
raise NotImplementedError(self.dont_leave_lock_in_place)
1340
self._leave_lock = False
1342
def _set_real_repository(self, repository):
1343
"""Set the _real_repository for this repository.
1345
:param repository: The repository to fallback to for non-hpss
1346
implemented operations.
1348
if self._real_repository is not None:
1349
# Replacing an already set real repository.
1350
# We cannot do this [currently] if the repository is locked -
1351
# synchronised state might be lost.
1352
if self.is_locked():
1353
raise AssertionError('_real_repository is already set')
1354
if isinstance(repository, RemoteRepository):
1355
raise AssertionError()
1356
self._real_repository = repository
1357
# three code paths happen here:
1358
# 1) old servers, RemoteBranch.open() calls _ensure_real before setting
1359
# up stacking. In this case self._fallback_repositories is [], and the
1360
# real repo is already setup. Preserve the real repo and
1361
# RemoteRepository.add_fallback_repository will avoid adding
1363
# 2) new servers, RemoteBranch.open() sets up stacking, and when
1364
# ensure_real is triggered from a branch, the real repository to
1365
# set already has a matching list with separate instances, but
1366
# as they are also RemoteRepositories we don't worry about making the
1367
# lists be identical.
1368
# 3) new servers, RemoteRepository.ensure_real is triggered before
1369
# RemoteBranch.ensure real, in this case we get a repo with no fallbacks
1370
# and need to populate it.
1371
if (self._fallback_repositories and
1372
len(self._real_repository._fallback_repositories) !=
1373
len(self._fallback_repositories)):
1374
if len(self._real_repository._fallback_repositories):
1375
raise AssertionError(
1376
"cannot cleanly remove existing _fallback_repositories")
1377
for fb in self._fallback_repositories:
1378
self._real_repository.add_fallback_repository(fb)
1379
if self._lock_mode == 'w':
1380
# if we are already locked, the real repository must be able to
1381
# acquire the lock with our token.
1382
self._real_repository.lock_write(self._lock_token)
1383
elif self._lock_mode == 'r':
1384
self._real_repository.lock_read()
1386
def start_write_group(self):
1387
"""Start a write group on the decorated repository.
1389
Smart methods perform operations in a single step so this API
1390
is not really applicable except as a compatibility thunk
1391
for older plugins that don't use e.g. the CommitBuilder
1395
return self._real_repository.start_write_group()
1397
def _unlock(self, token):
1398
path = self.bzrdir._path_for_remote_call(self._client)
1400
# with no token the remote repository is not persistently locked.
1402
err_context = {'token': token}
1403
response = self._call('Repository.unlock', path, token,
1405
if response == ('ok',):
1408
raise errors.UnexpectedSmartServerResponse(response)
1410
@only_raises(errors.LockNotHeld, errors.LockBroken)
1412
if not self._lock_count:
1413
return lock.cant_unlock_not_held(self)
1414
self._lock_count -= 1
1415
if self._lock_count > 0:
1417
self._unstacked_provider.disable_cache()
1418
old_mode = self._lock_mode
1419
self._lock_mode = None
1421
# The real repository is responsible at present for raising an
1422
# exception if it's in an unfinished write group. However, it
1423
# normally will *not* actually remove the lock from disk - that's
1424
# done by the server on receiving the Repository.unlock call.
1425
# This is just to let the _real_repository stay up to date.
1426
if self._real_repository is not None:
1427
self._real_repository.unlock()
1429
# The rpc-level lock should be released even if there was a
1430
# problem releasing the vfs-based lock.
1432
# Only write-locked repositories need to make a remote method
1433
# call to perform the unlock.
1434
old_token = self._lock_token
1435
self._lock_token = None
1436
if not self._leave_lock:
1437
self._unlock(old_token)
1438
# Fallbacks are always 'lock_read()' so we don't pay attention to
1440
for repo in self._fallback_repositories:
1443
def break_lock(self):
1444
# should hand off to the network
1446
return self._real_repository.break_lock()
1448
def _get_tarball(self, compression):
1449
"""Return a TemporaryFile containing a repository tarball.
1451
Returns None if the server does not support sending tarballs.
1454
path = self.bzrdir._path_for_remote_call(self._client)
1456
response, protocol = self._call_expecting_body(
1457
'Repository.tarball', path, compression)
1458
except errors.UnknownSmartMethod:
1459
protocol.cancel_read_body()
1461
if response[0] == 'ok':
1462
# Extract the tarball and return it
1463
t = tempfile.NamedTemporaryFile()
1464
# TODO: rpc layer should read directly into it...
1465
t.write(protocol.read_body_bytes())
1468
raise errors.UnexpectedSmartServerResponse(response)
1470
def sprout(self, to_bzrdir, revision_id=None):
1471
# TODO: Option to control what format is created?
1473
dest_repo = self._real_repository._format.initialize(to_bzrdir,
1475
dest_repo.fetch(self, revision_id=revision_id)
1478
### These methods are just thin shims to the VFS object for now.
1480
def revision_tree(self, revision_id):
1482
return self._real_repository.revision_tree(revision_id)
1484
def get_serializer_format(self):
1486
return self._real_repository.get_serializer_format()
1488
def get_commit_builder(self, branch, parents, config, timestamp=None,
1489
timezone=None, committer=None, revprops=None,
1490
revision_id=None, lossy=False):
1491
# FIXME: It ought to be possible to call this without immediately
1492
# triggering _ensure_real. For now it's the easiest thing to do.
1494
real_repo = self._real_repository
1495
builder = real_repo.get_commit_builder(branch, parents,
1496
config, timestamp=timestamp, timezone=timezone,
1497
committer=committer, revprops=revprops,
1498
revision_id=revision_id, lossy=lossy)
1501
def add_fallback_repository(self, repository):
1502
"""Add a repository to use for looking up data not held locally.
1504
:param repository: A repository.
1506
if not self._format.supports_external_lookups:
1507
raise errors.UnstackableRepositoryFormat(
1508
self._format.network_name(), self.base)
1509
# We need to accumulate additional repositories here, to pass them in
1512
if self.is_locked():
1513
# We will call fallback.unlock() when we transition to the unlocked
1514
# state, so always add a lock here. If a caller passes us a locked
1515
# repository, they are responsible for unlocking it later.
1516
repository.lock_read()
1517
self._check_fallback_repository(repository)
1518
self._fallback_repositories.append(repository)
1519
# If self._real_repository was parameterised already (e.g. because a
1520
# _real_branch had its get_stacked_on_url method called), then the
1521
# repository to be added may already be in the _real_repositories list.
1522
if self._real_repository is not None:
1523
fallback_locations = [repo.user_url for repo in
1524
self._real_repository._fallback_repositories]
1525
if repository.user_url not in fallback_locations:
1526
self._real_repository.add_fallback_repository(repository)
1528
def _check_fallback_repository(self, repository):
1529
"""Check that this repository can fallback to repository safely.
1531
Raise an error if not.
1533
:param repository: A repository to fallback to.
1535
return _mod_repository.InterRepository._assert_same_model(
1538
def add_inventory(self, revid, inv, parents):
1540
return self._real_repository.add_inventory(revid, inv, parents)
1542
def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1543
parents, basis_inv=None, propagate_caches=False):
1545
return self._real_repository.add_inventory_by_delta(basis_revision_id,
1546
delta, new_revision_id, parents, basis_inv=basis_inv,
1547
propagate_caches=propagate_caches)
1549
def add_revision(self, rev_id, rev, inv=None, config=None):
1551
return self._real_repository.add_revision(
1552
rev_id, rev, inv=inv, config=config)
1555
def get_inventory(self, revision_id):
1557
return self._real_repository.get_inventory(revision_id)
1559
def iter_inventories(self, revision_ids, ordering=None):
1561
return self._real_repository.iter_inventories(revision_ids, ordering)
1564
def get_revision(self, revision_id):
1566
return self._real_repository.get_revision(revision_id)
1568
def get_transaction(self):
1570
return self._real_repository.get_transaction()
1573
def clone(self, a_bzrdir, revision_id=None):
1575
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
1577
def make_working_trees(self):
1578
"""See Repository.make_working_trees"""
1580
return self._real_repository.make_working_trees()
1582
def refresh_data(self):
1583
"""Re-read any data needed to synchronise with disk.
1585
This method is intended to be called after another repository instance
1586
(such as one used by a smart server) has inserted data into the
1587
repository. On all repositories this will work outside of write groups.
1588
Some repository formats (pack and newer for bzrlib native formats)
1589
support refresh_data inside write groups. If called inside a write
1590
group on a repository that does not support refreshing in a write group
1591
IsInWriteGroupError will be raised.
1593
if self._real_repository is not None:
1594
self._real_repository.refresh_data()
1596
def revision_ids_to_search_result(self, result_set):
1597
"""Convert a set of revision ids to a graph SearchResult."""
1598
result_parents = set()
1599
for parents in self.get_graph().get_parent_map(
1600
result_set).itervalues():
1601
result_parents.update(parents)
1602
included_keys = result_set.intersection(result_parents)
1603
start_keys = result_set.difference(included_keys)
1604
exclude_keys = result_parents.difference(result_set)
1605
result = graph.SearchResult(start_keys, exclude_keys,
1606
len(result_set), result_set)
1610
def search_missing_revision_ids(self, other,
1611
revision_id=symbol_versioning.DEPRECATED_PARAMETER,
1612
find_ghosts=True, revision_ids=None, if_present_ids=None):
1613
"""Return the revision ids that other has that this does not.
1615
These are returned in topological order.
1617
revision_id: only return revision ids included by revision_id.
1619
if symbol_versioning.deprecated_passed(revision_id):
1620
symbol_versioning.warn(
1621
'search_missing_revision_ids(revision_id=...) was '
1622
'deprecated in 2.4. Use revision_ids=[...] instead.',
1623
DeprecationWarning, stacklevel=2)
1624
if revision_ids is not None:
1625
raise AssertionError(
1626
'revision_ids is mutually exclusive with revision_id')
1627
if revision_id is not None:
1628
revision_ids = [revision_id]
1629
inter_repo = _mod_repository.InterRepository.get(other, self)
1630
return inter_repo.search_missing_revision_ids(
1631
find_ghosts=find_ghosts, revision_ids=revision_ids,
1632
if_present_ids=if_present_ids)
1634
def fetch(self, source, revision_id=None, find_ghosts=False,
1636
# No base implementation to use as RemoteRepository is not a subclass
1637
# of Repository; so this is a copy of Repository.fetch().
1638
if fetch_spec is not None and revision_id is not None:
1639
raise AssertionError(
1640
"fetch_spec and revision_id are mutually exclusive.")
1641
if self.is_in_write_group():
1642
raise errors.InternalBzrError(
1643
"May not fetch while in a write group.")
1644
# fast path same-url fetch operations
1645
if (self.has_same_location(source)
1646
and fetch_spec is None
1647
and self._has_same_fallbacks(source)):
1648
# check that last_revision is in 'from' and then return a
1650
if (revision_id is not None and
1651
not _mod_revision.is_null(revision_id)):
1652
self.get_revision(revision_id)
1654
# if there is no specific appropriate InterRepository, this will get
1655
# the InterRepository base class, which raises an
1656
# IncompatibleRepositories when asked to fetch.
1657
inter = _mod_repository.InterRepository.get(source, self)
1658
return inter.fetch(revision_id=revision_id,
1659
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1661
def create_bundle(self, target, base, fileobj, format=None):
1663
self._real_repository.create_bundle(target, base, fileobj, format)
1666
def get_ancestry(self, revision_id, topo_sorted=True):
1668
return self._real_repository.get_ancestry(revision_id, topo_sorted)
1670
def fileids_altered_by_revision_ids(self, revision_ids):
1672
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
1674
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
1676
return self._real_repository._get_versioned_file_checker(
1677
revisions, revision_versions_cache)
1679
def iter_files_bytes(self, desired_files):
1680
"""See Repository.iter_file_bytes.
1683
return self._real_repository.iter_files_bytes(desired_files)
1685
def get_parent_map(self, revision_ids):
1686
"""See bzrlib.Graph.get_parent_map()."""
1687
return self._make_parents_provider().get_parent_map(revision_ids)
1689
def _get_parent_map_rpc(self, keys):
1690
"""Helper for get_parent_map that performs the RPC."""
1691
medium = self._client._medium
1692
if medium._is_remote_before((1, 2)):
1693
# We already found out that the server can't understand
1694
# 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
1703
# get_revision_graph. Specifically, a "key:()" pair in
1704
# get_revision_graph just means a node has no parents. For
1705
# "get_parent_map" it means the node is a ghost. So fix up the
1706
# graph to correct this.
1707
# https://bugs.launchpad.net/bzr/+bug/214894
1708
# There is one other "bug" which is that ghosts in
1709
# get_revision_graph() are not returned at all. But we won't worry
1710
# about that for now.
1711
for node_id, parent_ids in rg.iteritems():
1712
if parent_ids == ():
1713
rg[node_id] = (NULL_REVISION,)
1714
rg[NULL_REVISION] = ()
1719
raise ValueError('get_parent_map(None) is not valid')
1720
if NULL_REVISION in keys:
1721
keys.discard(NULL_REVISION)
1722
found_parents = {NULL_REVISION:()}
1724
return found_parents
1727
# TODO(Needs analysis): We could assume that the keys being requested
1728
# from get_parent_map are in a breadth first search, so typically they
1729
# will all be depth N from some common parent, and we don't have to
1730
# have the server iterate from the root parent, but rather from the
1731
# keys we're searching; and just tell the server the keyspace we
1732
# already have; but this may be more traffic again.
1734
# Transform self._parents_map into a search request recipe.
1735
# TODO: Manage this incrementally to avoid covering the same path
1736
# repeatedly. (The server will have to on each request, but the less
1737
# work done the better).
1739
# Negative caching notes:
1740
# new server sends missing when a request including the revid
1741
# 'include-missing:' is present in the request.
1742
# missing keys are serialised as missing:X, and we then call
1743
# provider.note_missing(X) for-all X
1744
parents_map = self._unstacked_provider.get_cached_map()
1745
if parents_map is None:
1746
# Repository is not locked, so there's no cache.
1748
# start_set is all the keys in the cache
1749
start_set = set(parents_map)
1750
# result set is all the references to keys in the cache
1751
result_parents = set()
1752
for parents in parents_map.itervalues():
1753
result_parents.update(parents)
1754
stop_keys = result_parents.difference(start_set)
1755
# We don't need to send ghosts back to the server as a position to
1757
stop_keys.difference_update(self._unstacked_provider.missing_keys)
1758
key_count = len(parents_map)
1759
if (NULL_REVISION in result_parents
1760
and NULL_REVISION in self._unstacked_provider.missing_keys):
1761
# If we pruned NULL_REVISION from the stop_keys because it's also
1762
# in our cache of "missing" keys we need to increment our key count
1763
# by 1, because the reconsitituted SearchResult on the server will
1764
# still consider NULL_REVISION to be an included key.
1766
included_keys = start_set.intersection(result_parents)
1767
start_set.difference_update(included_keys)
1768
recipe = ('manual', start_set, stop_keys, key_count)
1769
body = self._serialise_search_recipe(recipe)
1770
path = self.bzrdir._path_for_remote_call(self._client)
1772
if type(key) is not str:
1774
"key %r not a plain string" % (key,))
1775
verb = 'Repository.get_parent_map'
1776
args = (path, 'include-missing:') + tuple(keys)
1778
response = self._call_with_body_bytes_expecting_body(
1780
except errors.UnknownSmartMethod:
1781
# Server does not support this method, so get the whole graph.
1782
# Worse, we have to force a disconnection, because the server now
1783
# doesn't realise it has a body on the wire to consume, so the
1784
# only way to recover is to abandon the connection.
1786
'Server is too old for fast get_parent_map, reconnecting. '
1787
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1789
# To avoid having to disconnect repeatedly, we keep track of the
1790
# fact the server doesn't understand remote methods added in 1.2.
1791
medium._remember_remote_is_before((1, 2))
1792
# Recurse just once and we should use the fallback code.
1793
return self._get_parent_map_rpc(keys)
1794
response_tuple, response_handler = response
1795
if response_tuple[0] not in ['ok']:
1796
response_handler.cancel_read_body()
1797
raise errors.UnexpectedSmartServerResponse(response_tuple)
1798
if response_tuple[0] == 'ok':
1799
coded = bz2.decompress(response_handler.read_body_bytes())
1801
# no revisions found
1803
lines = coded.split('\n')
1806
d = tuple(line.split())
1808
revision_graph[d[0]] = d[1:]
1811
if d[0].startswith('missing:'):
1813
self._unstacked_provider.note_missing_key(revid)
1815
# no parents - so give the Graph result
1817
revision_graph[d[0]] = (NULL_REVISION,)
1818
return revision_graph
1821
def get_signature_text(self, revision_id):
1823
return self._real_repository.get_signature_text(revision_id)
1826
def _get_inventory_xml(self, revision_id):
1828
return self._real_repository._get_inventory_xml(revision_id)
1830
def reconcile(self, other=None, thorough=False):
1832
return self._real_repository.reconcile(other=other, thorough=thorough)
1834
def all_revision_ids(self):
1836
return self._real_repository.all_revision_ids()
1839
def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1841
return self._real_repository.get_deltas_for_revisions(revisions,
1842
specific_fileids=specific_fileids)
1845
def get_revision_delta(self, revision_id, specific_fileids=None):
1847
return self._real_repository.get_revision_delta(revision_id,
1848
specific_fileids=specific_fileids)
1851
def revision_trees(self, revision_ids):
1853
return self._real_repository.revision_trees(revision_ids)
1856
def get_revision_reconcile(self, revision_id):
1858
return self._real_repository.get_revision_reconcile(revision_id)
1861
def check(self, revision_ids=None, callback_refs=None, check_repo=True):
1863
return self._real_repository.check(revision_ids=revision_ids,
1864
callback_refs=callback_refs, check_repo=check_repo)
1866
def copy_content_into(self, destination, revision_id=None):
1868
return self._real_repository.copy_content_into(
1869
destination, revision_id=revision_id)
1871
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
1872
# get a tarball of the remote repository, and copy from that into the
1874
from bzrlib import osutils
1876
# TODO: Maybe a progress bar while streaming the tarball?
1877
note("Copying repository content as tarball...")
1878
tar_file = self._get_tarball('bz2')
1879
if tar_file is None:
1881
destination = to_bzrdir.create_repository()
1883
tar = tarfile.open('repository', fileobj=tar_file,
1885
tmpdir = osutils.mkdtemp()
1887
_extract_tar(tar, tmpdir)
1888
tmp_bzrdir = _mod_bzrdir.BzrDir.open(tmpdir)
1889
tmp_repo = tmp_bzrdir.open_repository()
1890
tmp_repo.copy_content_into(destination, revision_id)
1892
osutils.rmtree(tmpdir)
1896
# TODO: Suggestion from john: using external tar is much faster than
1897
# python's tarfile library, but it may not work on windows.
1900
def inventories(self):
1901
"""Decorate the real repository for now.
1903
In the long term a full blown network facility is needed to
1904
avoid creating a real repository object locally.
1907
return self._real_repository.inventories
1910
def pack(self, hint=None, clean_obsolete_packs=False):
1911
"""Compress the data within the repository.
1913
This is not currently implemented within the smart server.
1916
return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
1919
def revisions(self):
1920
"""Decorate the real repository for now.
1922
In the short term this should become a real object to intercept graph
1925
In the long term a full blown network facility is needed.
1928
return self._real_repository.revisions
1930
def set_make_working_trees(self, new_value):
1932
new_value_str = "True"
1934
new_value_str = "False"
1935
path = self.bzrdir._path_for_remote_call(self._client)
1937
response = self._call(
1938
'Repository.set_make_working_trees', path, new_value_str)
1939
except errors.UnknownSmartMethod:
1941
self._real_repository.set_make_working_trees(new_value)
1943
if response[0] != 'ok':
1944
raise errors.UnexpectedSmartServerResponse(response)
1947
def signatures(self):
1948
"""Decorate the real repository for now.
1950
In the long term a full blown network facility is needed to avoid
1951
creating a real repository object locally.
1954
return self._real_repository.signatures
1957
def sign_revision(self, revision_id, gpg_strategy):
1959
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1963
"""Decorate the real repository for now.
1965
In the long term a full blown network facility is needed to avoid
1966
creating a real repository object locally.
1969
return self._real_repository.texts
1972
def get_revisions(self, revision_ids):
1974
return self._real_repository.get_revisions(revision_ids)
1976
def supports_rich_root(self):
1977
return self._format.rich_root_data
1979
def iter_reverse_revision_history(self, revision_id):
1981
return self._real_repository.iter_reverse_revision_history(revision_id)
1984
def _serializer(self):
1985
return self._format._serializer
1987
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1989
return self._real_repository.store_revision_signature(
1990
gpg_strategy, plaintext, revision_id)
1992
def add_signature_text(self, revision_id, signature):
1994
return self._real_repository.add_signature_text(revision_id, signature)
1996
def has_signature_for_revision_id(self, revision_id):
1998
return self._real_repository.has_signature_for_revision_id(revision_id)
2000
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
2002
return self._real_repository.item_keys_introduced_by(revision_ids,
2003
_files_pb=_files_pb)
2005
def _find_inconsistent_revision_parents(self, revisions_iterator=None):
2007
return self._real_repository._find_inconsistent_revision_parents(
2010
def _check_for_inconsistent_revision_parents(self):
2012
return self._real_repository._check_for_inconsistent_revision_parents()
2014
def _make_parents_provider(self, other=None):
2015
providers = [self._unstacked_provider]
2016
if other is not None:
2017
providers.insert(0, other)
2018
return graph.StackedParentsProvider(_LazyListJoin(
2019
providers, self._fallback_repositories))
2021
def _serialise_search_recipe(self, recipe):
2022
"""Serialise a graph search recipe.
2024
:param recipe: A search recipe (start, stop, count).
2025
:return: Serialised bytes.
2027
start_keys = ' '.join(recipe[1])
2028
stop_keys = ' '.join(recipe[2])
2029
count = str(recipe[3])
2030
return '\n'.join((start_keys, stop_keys, count))
2032
def _serialise_search_result(self, search_result):
2033
parts = search_result.get_network_struct()
2034
return '\n'.join(parts)
2037
path = self.bzrdir._path_for_remote_call(self._client)
2039
response = self._call('PackRepository.autopack', path)
2040
except errors.UnknownSmartMethod:
2042
self._real_repository._pack_collection.autopack()
2045
if response[0] != 'ok':
2046
raise errors.UnexpectedSmartServerResponse(response)
2049
class RemoteStreamSink(vf_repository.StreamSink):
2051
def _insert_real(self, stream, src_format, resume_tokens):
2052
self.target_repo._ensure_real()
2053
sink = self.target_repo._real_repository._get_sink()
2054
result = sink.insert_stream(stream, src_format, resume_tokens)
2056
self.target_repo.autopack()
2059
def insert_stream(self, stream, src_format, resume_tokens):
2060
target = self.target_repo
2061
target._unstacked_provider.missing_keys.clear()
2062
candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
2063
if target._lock_token:
2064
candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
2065
lock_args = (target._lock_token or '',)
2067
candidate_calls.append(('Repository.insert_stream', (1, 13)))
2069
client = target._client
2070
medium = client._medium
2071
path = target.bzrdir._path_for_remote_call(client)
2072
# Probe for the verb to use with an empty stream before sending the
2073
# real stream to it. We do this both to avoid the risk of sending a
2074
# large request that is then rejected, and because we don't want to
2075
# implement a way to buffer, rewind, or restart the stream.
2077
for verb, required_version in candidate_calls:
2078
if medium._is_remote_before(required_version):
2081
# We've already done the probing (and set _is_remote_before) on
2082
# a previous insert.
2085
byte_stream = smart_repo._stream_to_byte_stream([], src_format)
2087
response = client.call_with_body_stream(
2088
(verb, path, '') + lock_args, byte_stream)
2089
except errors.UnknownSmartMethod:
2090
medium._remember_remote_is_before(required_version)
2096
return self._insert_real(stream, src_format, resume_tokens)
2097
self._last_inv_record = None
2098
self._last_substream = None
2099
if required_version < (1, 19):
2100
# Remote side doesn't support inventory deltas. Wrap the stream to
2101
# make sure we don't send any. If the stream contains inventory
2102
# deltas we'll interrupt the smart insert_stream request and
2104
stream = self._stop_stream_if_inventory_delta(stream)
2105
byte_stream = smart_repo._stream_to_byte_stream(
2107
resume_tokens = ' '.join(resume_tokens)
2108
response = client.call_with_body_stream(
2109
(verb, path, resume_tokens) + lock_args, byte_stream)
2110
if response[0][0] not in ('ok', 'missing-basis'):
2111
raise errors.UnexpectedSmartServerResponse(response)
2112
if self._last_substream is not None:
2113
# The stream included an inventory-delta record, but the remote
2114
# side isn't new enough to support them. So we need to send the
2115
# rest of the stream via VFS.
2116
self.target_repo.refresh_data()
2117
return self._resume_stream_with_vfs(response, src_format)
2118
if response[0][0] == 'missing-basis':
2119
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
2120
resume_tokens = tokens
2121
return resume_tokens, set(missing_keys)
2123
self.target_repo.refresh_data()
2126
def _resume_stream_with_vfs(self, response, src_format):
2127
"""Resume sending a stream via VFS, first resending the record and
2128
substream that couldn't be sent via an insert_stream verb.
2130
if response[0][0] == 'missing-basis':
2131
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
2132
# Ignore missing_keys, we haven't finished inserting yet
2135
def resume_substream():
2136
# Yield the substream that was interrupted.
2137
for record in self._last_substream:
2139
self._last_substream = None
2140
def resume_stream():
2141
# Finish sending the interrupted substream
2142
yield ('inventory-deltas', resume_substream())
2143
# Then simply continue sending the rest of the stream.
2144
for substream_kind, substream in self._last_stream:
2145
yield substream_kind, substream
2146
return self._insert_real(resume_stream(), src_format, tokens)
2148
def _stop_stream_if_inventory_delta(self, stream):
2149
"""Normally this just lets the original stream pass-through unchanged.
2151
However if any 'inventory-deltas' substream occurs it will stop
2152
streaming, and store the interrupted substream and stream in
2153
self._last_substream and self._last_stream so that the stream can be
2154
resumed by _resume_stream_with_vfs.
2157
stream_iter = iter(stream)
2158
for substream_kind, substream in stream_iter:
2159
if substream_kind == 'inventory-deltas':
2160
self._last_substream = substream
2161
self._last_stream = stream_iter
2164
yield substream_kind, substream
2167
class RemoteStreamSource(vf_repository.StreamSource):
2168
"""Stream data from a remote server."""
2170
def get_stream(self, search):
2171
if (self.from_repository._fallback_repositories and
2172
self.to_format._fetch_order == 'topological'):
2173
return self._real_stream(self.from_repository, search)
2176
repos = [self.from_repository]
2182
repos.extend(repo._fallback_repositories)
2183
sources.append(repo)
2184
return self.missing_parents_chain(search, sources)
2186
def get_stream_for_missing_keys(self, missing_keys):
2187
self.from_repository._ensure_real()
2188
real_repo = self.from_repository._real_repository
2189
real_source = real_repo._get_source(self.to_format)
2190
return real_source.get_stream_for_missing_keys(missing_keys)
2192
def _real_stream(self, repo, search):
2193
"""Get a stream for search from repo.
2195
This never called RemoteStreamSource.get_stream, and is a heler
2196
for RemoteStreamSource._get_stream to allow getting a stream
2197
reliably whether fallback back because of old servers or trying
2198
to stream from a non-RemoteRepository (which the stacked support
2201
source = repo._get_source(self.to_format)
2202
if isinstance(source, RemoteStreamSource):
2204
source = repo._real_repository._get_source(self.to_format)
2205
return source.get_stream(search)
2207
def _get_stream(self, repo, search):
2208
"""Core worker to get a stream from repo for search.
2210
This is used by both get_stream and the stacking support logic. It
2211
deliberately gets a stream for repo which does not need to be
2212
self.from_repository. In the event that repo is not Remote, or
2213
cannot do a smart stream, a fallback is made to the generic
2214
repository._get_stream() interface, via self._real_stream.
2216
In the event of stacking, streams from _get_stream will not
2217
contain all the data for search - this is normal (see get_stream).
2219
:param repo: A repository.
2220
:param search: A search.
2222
# Fallbacks may be non-smart
2223
if not isinstance(repo, RemoteRepository):
2224
return self._real_stream(repo, search)
2225
client = repo._client
2226
medium = client._medium
2227
path = repo.bzrdir._path_for_remote_call(client)
2228
search_bytes = repo._serialise_search_result(search)
2229
args = (path, self.to_format.network_name())
2231
('Repository.get_stream_1.19', (1, 19)),
2232
('Repository.get_stream', (1, 13))]
2235
for verb, version in candidate_verbs:
2236
if medium._is_remote_before(version):
2239
response = repo._call_with_body_bytes_expecting_body(
2240
verb, args, search_bytes)
2241
except errors.UnknownSmartMethod:
2242
medium._remember_remote_is_before(version)
2243
except errors.UnknownErrorFromSmartServer, e:
2244
if isinstance(search, graph.EverythingResult):
2245
error_verb = e.error_from_smart_server.error_verb
2246
if error_verb == 'BadSearch':
2247
# Pre-2.4 servers don't support this sort of search.
2248
# XXX: perhaps falling back to VFS on BadSearch is a
2249
# good idea in general? It might provide a little bit
2250
# of protection against client-side bugs.
2251
medium._remember_remote_is_before((2, 4))
2255
response_tuple, response_handler = response
2259
return self._real_stream(repo, search)
2260
if response_tuple[0] != 'ok':
2261
raise errors.UnexpectedSmartServerResponse(response_tuple)
2262
byte_stream = response_handler.read_streamed_body()
2263
src_format, stream = smart_repo._byte_stream_to_stream(byte_stream,
2264
self._record_counter)
2265
if src_format.network_name() != repo._format.network_name():
2266
raise AssertionError(
2267
"Mismatched RemoteRepository and stream src %r, %r" % (
2268
src_format.network_name(), repo._format.network_name()))
2271
def missing_parents_chain(self, search, sources):
2272
"""Chain multiple streams together to handle stacking.
2274
:param search: The overall search to satisfy with streams.
2275
:param sources: A list of Repository objects to query.
2277
self.from_serialiser = self.from_repository._format._serializer
2278
self.seen_revs = set()
2279
self.referenced_revs = set()
2280
# If there are heads in the search, or the key count is > 0, we are not
2282
while not search.is_empty() and len(sources) > 1:
2283
source = sources.pop(0)
2284
stream = self._get_stream(source, search)
2285
for kind, substream in stream:
2286
if kind != 'revisions':
2287
yield kind, substream
2289
yield kind, self.missing_parents_rev_handler(substream)
2290
search = search.refine(self.seen_revs, self.referenced_revs)
2291
self.seen_revs = set()
2292
self.referenced_revs = set()
2293
if not search.is_empty():
2294
for kind, stream in self._get_stream(sources[0], search):
2297
def missing_parents_rev_handler(self, substream):
2298
for content in substream:
2299
revision_bytes = content.get_bytes_as('fulltext')
2300
revision = self.from_serialiser.read_revision_from_string(
2302
self.seen_revs.add(content.key[-1])
2303
self.referenced_revs.update(revision.parent_ids)
2307
class RemoteBranchLockableFiles(LockableFiles):
2308
"""A 'LockableFiles' implementation that talks to a smart server.
2310
This is not a public interface class.
2313
def __init__(self, bzrdir, _client):
2314
self.bzrdir = bzrdir
2315
self._client = _client
2316
self._need_find_modes = True
2317
LockableFiles.__init__(
2318
self, bzrdir.get_branch_transport(None),
2319
'lock', lockdir.LockDir)
2321
def _find_modes(self):
2322
# RemoteBranches don't let the client set the mode of control files.
2323
self._dir_mode = None
2324
self._file_mode = None
2327
class RemoteBranchFormat(branch.BranchFormat):
2329
def __init__(self, network_name=None):
2330
super(RemoteBranchFormat, self).__init__()
2331
self._matchingbzrdir = RemoteBzrDirFormat()
2332
self._matchingbzrdir.set_branch_format(self)
2333
self._custom_format = None
2334
self._network_name = network_name
2336
def __eq__(self, other):
2337
return (isinstance(other, RemoteBranchFormat) and
2338
self.__dict__ == other.__dict__)
2340
def _ensure_real(self):
2341
if self._custom_format is None:
2342
self._custom_format = branch.network_format_registry.get(
2345
def get_format_description(self):
2347
return 'Remote: ' + self._custom_format.get_format_description()
2349
def network_name(self):
2350
return self._network_name
2352
def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
2353
return a_bzrdir.open_branch(name=name,
2354
ignore_fallbacks=ignore_fallbacks)
2356
def _vfs_initialize(self, a_bzrdir, name):
2357
# Initialisation when using a local bzrdir object, or a non-vfs init
2358
# method is not available on the server.
2359
# self._custom_format is always set - the start of initialize ensures
2361
if isinstance(a_bzrdir, RemoteBzrDir):
2362
a_bzrdir._ensure_real()
2363
result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2366
# We assume the bzrdir is parameterised; it may not be.
2367
result = self._custom_format.initialize(a_bzrdir, name)
2368
if (isinstance(a_bzrdir, RemoteBzrDir) and
2369
not isinstance(result, RemoteBranch)):
2370
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2374
def initialize(self, a_bzrdir, name=None, repository=None):
2375
# 1) get the network name to use.
2376
if self._custom_format:
2377
network_name = self._custom_format.network_name()
2379
# Select the current bzrlib default and ask for that.
2380
reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
2381
reference_format = reference_bzrdir_format.get_branch_format()
2382
self._custom_format = reference_format
2383
network_name = reference_format.network_name()
2384
# Being asked to create on a non RemoteBzrDir:
2385
if not isinstance(a_bzrdir, RemoteBzrDir):
2386
return self._vfs_initialize(a_bzrdir, name=name)
2387
medium = a_bzrdir._client._medium
2388
if medium._is_remote_before((1, 13)):
2389
return self._vfs_initialize(a_bzrdir, name=name)
2390
# Creating on a remote bzr dir.
2391
# 2) try direct creation via RPC
2392
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2393
if name is not None:
2394
# XXX JRV20100304: Support creating colocated branches
2395
raise errors.NoColocatedBranchSupport(self)
2396
verb = 'BzrDir.create_branch'
2398
response = a_bzrdir._call(verb, path, network_name)
2399
except errors.UnknownSmartMethod:
2400
# Fallback - use vfs methods
2401
medium._remember_remote_is_before((1, 13))
2402
return self._vfs_initialize(a_bzrdir, name=name)
2403
if response[0] != 'ok':
2404
raise errors.UnexpectedSmartServerResponse(response)
2405
# Turn the response into a RemoteRepository object.
2406
format = RemoteBranchFormat(network_name=response[1])
2407
repo_format = response_tuple_to_repo_format(response[3:])
2408
repo_path = response[2]
2409
if repository is not None:
2410
remote_repo_url = urlutils.join(a_bzrdir.user_url, repo_path)
2411
url_diff = urlutils.relative_url(repository.user_url,
2414
raise AssertionError(
2415
'repository.user_url %r does not match URL from server '
2416
'response (%r + %r)'
2417
% (repository.user_url, a_bzrdir.user_url, repo_path))
2418
remote_repo = repository
2421
repo_bzrdir = a_bzrdir
2423
repo_bzrdir = RemoteBzrDir(
2424
a_bzrdir.root_transport.clone(repo_path), a_bzrdir._format,
2426
remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2427
remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2428
format=format, setup_stacking=False, name=name)
2429
# XXX: We know this is a new branch, so it must have revno 0, revid
2430
# NULL_REVISION. Creating the branch locked would make this be unable
2431
# to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2432
remote_branch._last_revision_info_cache = 0, NULL_REVISION
2433
return remote_branch
2435
def make_tags(self, branch):
2437
return self._custom_format.make_tags(branch)
2439
def supports_tags(self):
2440
# Remote branches might support tags, but we won't know until we
2441
# access the real remote branch.
2443
return self._custom_format.supports_tags()
2445
def supports_stacking(self):
2447
return self._custom_format.supports_stacking()
2449
def supports_set_append_revisions_only(self):
2451
return self._custom_format.supports_set_append_revisions_only()
2453
def _use_default_local_heads_to_fetch(self):
2454
# If the branch format is a metadir format *and* its heads_to_fetch
2455
# implementation is not overridden vs the base class, we can use the
2456
# base class logic rather than use the heads_to_fetch RPC. This is
2457
# usually cheaper in terms of net round trips, as the last-revision and
2458
# tags info fetched is cached and would be fetched anyway.
2460
if isinstance(self._custom_format, branch.BranchFormatMetadir):
2461
branch_class = self._custom_format._branch_class()
2462
heads_to_fetch_impl = branch_class.heads_to_fetch.im_func
2463
if heads_to_fetch_impl is branch.Branch.heads_to_fetch.im_func:
2467
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
2468
"""Branch stored on a server accessed by HPSS RPC.
2470
At the moment most operations are mapped down to simple file operations.
2473
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2474
_client=None, format=None, setup_stacking=True, name=None):
2475
"""Create a RemoteBranch instance.
2477
:param real_branch: An optional local implementation of the branch
2478
format, usually accessing the data via the VFS.
2479
:param _client: Private parameter for testing.
2480
:param format: A RemoteBranchFormat object, None to create one
2481
automatically. If supplied it should have a network_name already
2483
:param setup_stacking: If True make an RPC call to determine the
2484
stacked (or not) status of the branch. If False assume the branch
2486
:param name: Colocated branch name
2488
# We intentionally don't call the parent class's __init__, because it
2489
# will try to assign to self.tags, which is a property in this subclass.
2490
# And the parent's __init__ doesn't do much anyway.
2491
self.bzrdir = remote_bzrdir
2492
if _client is not None:
2493
self._client = _client
2495
self._client = remote_bzrdir._client
2496
self.repository = remote_repository
2497
if real_branch is not None:
2498
self._real_branch = real_branch
2499
# Give the remote repository the matching real repo.
2500
real_repo = self._real_branch.repository
2501
if isinstance(real_repo, RemoteRepository):
2502
real_repo._ensure_real()
2503
real_repo = real_repo._real_repository
2504
self.repository._set_real_repository(real_repo)
2505
# Give the branch the remote repository to let fast-pathing happen.
2506
self._real_branch.repository = self.repository
2508
self._real_branch = None
2509
# Fill out expected attributes of branch for bzrlib API users.
2510
self._clear_cached_state()
2511
# TODO: deprecate self.base in favor of user_url
2512
self.base = self.bzrdir.user_url
2514
self._control_files = None
2515
self._lock_mode = None
2516
self._lock_token = None
2517
self._repo_lock_token = None
2518
self._lock_count = 0
2519
self._leave_lock = False
2520
# Setup a format: note that we cannot call _ensure_real until all the
2521
# attributes above are set: This code cannot be moved higher up in this
2524
self._format = RemoteBranchFormat()
2525
if real_branch is not None:
2526
self._format._network_name = \
2527
self._real_branch._format.network_name()
2529
self._format = format
2530
# when we do _ensure_real we may need to pass ignore_fallbacks to the
2531
# branch.open_branch method.
2532
self._real_ignore_fallbacks = not setup_stacking
2533
if not self._format._network_name:
2534
# Did not get from open_branchV2 - old server.
2536
self._format._network_name = \
2537
self._real_branch._format.network_name()
2538
self.tags = self._format.make_tags(self)
2539
# The base class init is not called, so we duplicate this:
2540
hooks = branch.Branch.hooks['open']
2543
self._is_stacked = False
2545
self._setup_stacking()
2547
def _setup_stacking(self):
2548
# configure stacking into the remote repository, by reading it from
2551
fallback_url = self.get_stacked_on_url()
2552
except (errors.NotStacked, errors.UnstackableBranchFormat,
2553
errors.UnstackableRepositoryFormat), e:
2555
self._is_stacked = True
2556
self._activate_fallback_location(fallback_url)
2558
def _get_config(self):
2559
return RemoteBranchConfig(self)
2561
def _get_real_transport(self):
2562
# if we try vfs access, return the real branch's vfs transport
2564
return self._real_branch._transport
2566
_transport = property(_get_real_transport)
2569
return "%s(%s)" % (self.__class__.__name__, self.base)
2573
def _ensure_real(self):
2574
"""Ensure that there is a _real_branch set.
2576
Used before calls to self._real_branch.
2578
if self._real_branch is None:
2579
if not vfs.vfs_enabled():
2580
raise AssertionError('smart server vfs must be enabled '
2581
'to use vfs implementation')
2582
self.bzrdir._ensure_real()
2583
self._real_branch = self.bzrdir._real_bzrdir.open_branch(
2584
ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
2585
if self.repository._real_repository is None:
2586
# Give the remote repository the matching real repo.
2587
real_repo = self._real_branch.repository
2588
if isinstance(real_repo, RemoteRepository):
2589
real_repo._ensure_real()
2590
real_repo = real_repo._real_repository
2591
self.repository._set_real_repository(real_repo)
2592
# Give the real branch the remote repository to let fast-pathing
2594
self._real_branch.repository = self.repository
2595
if self._lock_mode == 'r':
2596
self._real_branch.lock_read()
2597
elif self._lock_mode == 'w':
2598
self._real_branch.lock_write(token=self._lock_token)
2600
def _translate_error(self, err, **context):
2601
self.repository._translate_error(err, branch=self, **context)
2603
def _clear_cached_state(self):
2604
super(RemoteBranch, self)._clear_cached_state()
2605
if self._real_branch is not None:
2606
self._real_branch._clear_cached_state()
2608
def _clear_cached_state_of_remote_branch_only(self):
2609
"""Like _clear_cached_state, but doesn't clear the cache of
2612
This is useful when falling back to calling a method of
2613
self._real_branch that changes state. In that case the underlying
2614
branch changes, so we need to invalidate this RemoteBranch's cache of
2615
it. However, there's no need to invalidate the _real_branch's cache
2616
too, in fact doing so might harm performance.
2618
super(RemoteBranch, self)._clear_cached_state()
2621
def control_files(self):
2622
# Defer actually creating RemoteBranchLockableFiles until its needed,
2623
# because it triggers an _ensure_real that we otherwise might not need.
2624
if self._control_files is None:
2625
self._control_files = RemoteBranchLockableFiles(
2626
self.bzrdir, self._client)
2627
return self._control_files
2629
def _get_checkout_format(self):
2631
return self._real_branch._get_checkout_format()
2633
def get_physical_lock_status(self):
2634
"""See Branch.get_physical_lock_status()."""
2635
# should be an API call to the server, as branches must be lockable.
2637
return self._real_branch.get_physical_lock_status()
2639
def get_stacked_on_url(self):
2640
"""Get the URL this branch is stacked against.
2642
:raises NotStacked: If the branch is not stacked.
2643
:raises UnstackableBranchFormat: If the branch does not support
2645
:raises UnstackableRepositoryFormat: If the repository does not support
2649
# there may not be a repository yet, so we can't use
2650
# self._translate_error, so we can't use self._call either.
2651
response = self._client.call('Branch.get_stacked_on_url',
2652
self._remote_path())
2653
except errors.ErrorFromSmartServer, err:
2654
# there may not be a repository yet, so we can't call through
2655
# its _translate_error
2656
_translate_error(err, branch=self)
2657
except errors.UnknownSmartMethod, err:
2659
return self._real_branch.get_stacked_on_url()
2660
if response[0] != 'ok':
2661
raise errors.UnexpectedSmartServerResponse(response)
2664
def set_stacked_on_url(self, url):
2665
branch.Branch.set_stacked_on_url(self, url)
2667
self._is_stacked = False
2669
self._is_stacked = True
2671
def _vfs_get_tags_bytes(self):
2673
return self._real_branch._get_tags_bytes()
2676
def _get_tags_bytes(self):
2677
if self._tags_bytes is None:
2678
self._tags_bytes = self._get_tags_bytes_via_hpss()
2679
return self._tags_bytes
2681
def _get_tags_bytes_via_hpss(self):
2682
medium = self._client._medium
2683
if medium._is_remote_before((1, 13)):
2684
return self._vfs_get_tags_bytes()
2686
response = self._call('Branch.get_tags_bytes', self._remote_path())
2687
except errors.UnknownSmartMethod:
2688
medium._remember_remote_is_before((1, 13))
2689
return self._vfs_get_tags_bytes()
2692
def _vfs_set_tags_bytes(self, bytes):
2694
return self._real_branch._set_tags_bytes(bytes)
2696
def _set_tags_bytes(self, bytes):
2697
if self.is_locked():
2698
self._tags_bytes = bytes
2699
medium = self._client._medium
2700
if medium._is_remote_before((1, 18)):
2701
self._vfs_set_tags_bytes(bytes)
2705
self._remote_path(), self._lock_token, self._repo_lock_token)
2706
response = self._call_with_body_bytes(
2707
'Branch.set_tags_bytes', args, bytes)
2708
except errors.UnknownSmartMethod:
2709
medium._remember_remote_is_before((1, 18))
2710
self._vfs_set_tags_bytes(bytes)
2712
def lock_read(self):
2713
"""Lock the branch for read operations.
2715
:return: A bzrlib.lock.LogicalLockResult.
2717
self.repository.lock_read()
2718
if not self._lock_mode:
2719
self._note_lock('r')
2720
self._lock_mode = 'r'
2721
self._lock_count = 1
2722
if self._real_branch is not None:
2723
self._real_branch.lock_read()
2725
self._lock_count += 1
2726
return lock.LogicalLockResult(self.unlock)
2728
def _remote_lock_write(self, token):
2730
branch_token = repo_token = ''
2732
branch_token = token
2733
repo_token = self.repository.lock_write().repository_token
2734
self.repository.unlock()
2735
err_context = {'token': token}
2737
response = self._call(
2738
'Branch.lock_write', self._remote_path(), branch_token,
2739
repo_token or '', **err_context)
2740
except errors.LockContention, e:
2741
# The LockContention from the server doesn't have any
2742
# information about the lock_url. We re-raise LockContention
2743
# with valid lock_url.
2744
raise errors.LockContention('(remote lock)',
2745
self.repository.base.split('.bzr/')[0])
2746
if response[0] != 'ok':
2747
raise errors.UnexpectedSmartServerResponse(response)
2748
ok, branch_token, repo_token = response
2749
return branch_token, repo_token
2751
def lock_write(self, token=None):
2752
if not self._lock_mode:
2753
self._note_lock('w')
2754
# Lock the branch and repo in one remote call.
2755
remote_tokens = self._remote_lock_write(token)
2756
self._lock_token, self._repo_lock_token = remote_tokens
2757
if not self._lock_token:
2758
raise SmartProtocolError('Remote server did not return a token!')
2759
# Tell the self.repository object that it is locked.
2760
self.repository.lock_write(
2761
self._repo_lock_token, _skip_rpc=True)
2763
if self._real_branch is not None:
2764
self._real_branch.lock_write(token=self._lock_token)
2765
if token is not None:
2766
self._leave_lock = True
2768
self._leave_lock = False
2769
self._lock_mode = 'w'
2770
self._lock_count = 1
2771
elif self._lock_mode == 'r':
2772
raise errors.ReadOnlyError(self)
2774
if token is not None:
2775
# A token was given to lock_write, and we're relocking, so
2776
# check that the given token actually matches the one we
2778
if token != self._lock_token:
2779
raise errors.TokenMismatch(token, self._lock_token)
2780
self._lock_count += 1
2781
# Re-lock the repository too.
2782
self.repository.lock_write(self._repo_lock_token)
2783
return BranchWriteLockResult(self.unlock, self._lock_token or None)
2785
def _unlock(self, branch_token, repo_token):
2786
err_context = {'token': str((branch_token, repo_token))}
2787
response = self._call(
2788
'Branch.unlock', self._remote_path(), branch_token,
2789
repo_token or '', **err_context)
2790
if response == ('ok',):
2792
raise errors.UnexpectedSmartServerResponse(response)
2794
@only_raises(errors.LockNotHeld, errors.LockBroken)
2797
self._lock_count -= 1
2798
if not self._lock_count:
2799
self._clear_cached_state()
2800
mode = self._lock_mode
2801
self._lock_mode = None
2802
if self._real_branch is not None:
2803
if (not self._leave_lock and mode == 'w' and
2804
self._repo_lock_token):
2805
# If this RemoteBranch will remove the physical lock
2806
# for the repository, make sure the _real_branch
2807
# doesn't do it first. (Because the _real_branch's
2808
# repository is set to be the RemoteRepository.)
2809
self._real_branch.repository.leave_lock_in_place()
2810
self._real_branch.unlock()
2812
# Only write-locked branched need to make a remote method
2813
# call to perform the unlock.
2815
if not self._lock_token:
2816
raise AssertionError('Locked, but no token!')
2817
branch_token = self._lock_token
2818
repo_token = self._repo_lock_token
2819
self._lock_token = None
2820
self._repo_lock_token = None
2821
if not self._leave_lock:
2822
self._unlock(branch_token, repo_token)
2824
self.repository.unlock()
2826
def break_lock(self):
2828
return self._real_branch.break_lock()
2830
def leave_lock_in_place(self):
2831
if not self._lock_token:
2832
raise NotImplementedError(self.leave_lock_in_place)
2833
self._leave_lock = True
2835
def dont_leave_lock_in_place(self):
2836
if not self._lock_token:
2837
raise NotImplementedError(self.dont_leave_lock_in_place)
2838
self._leave_lock = False
2841
def get_rev_id(self, revno, history=None):
2843
return _mod_revision.NULL_REVISION
2844
last_revision_info = self.last_revision_info()
2845
ok, result = self.repository.get_rev_id_for_revno(
2846
revno, last_revision_info)
2849
missing_parent = result[1]
2850
# Either the revision named by the server is missing, or its parent
2851
# is. Call get_parent_map to determine which, so that we report a
2853
parent_map = self.repository.get_parent_map([missing_parent])
2854
if missing_parent in parent_map:
2855
missing_parent = parent_map[missing_parent]
2856
raise errors.RevisionNotPresent(missing_parent, self.repository)
2858
def _read_last_revision_info(self):
2859
response = self._call('Branch.last_revision_info', self._remote_path())
2860
if response[0] != 'ok':
2861
raise SmartProtocolError('unexpected response code %s' % (response,))
2862
revno = int(response[1])
2863
last_revision = response[2]
2864
return (revno, last_revision)
2866
def _gen_revision_history(self):
2867
"""See Branch._gen_revision_history()."""
2868
if self._is_stacked:
2870
return self._real_branch._gen_revision_history()
2871
response_tuple, response_handler = self._call_expecting_body(
2872
'Branch.revision_history', self._remote_path())
2873
if response_tuple[0] != 'ok':
2874
raise errors.UnexpectedSmartServerResponse(response_tuple)
2875
result = response_handler.read_body_bytes().split('\x00')
2880
def _remote_path(self):
2881
return self.bzrdir._path_for_remote_call(self._client)
2883
def _set_last_revision_descendant(self, revision_id, other_branch,
2884
allow_diverged=False, allow_overwrite_descendant=False):
2885
# This performs additional work to meet the hook contract; while its
2886
# undesirable, we have to synthesise the revno to call the hook, and
2887
# not calling the hook is worse as it means changes can't be prevented.
2888
# Having calculated this though, we can't just call into
2889
# set_last_revision_info as a simple call, because there is a set_rh
2890
# hook that some folk may still be using.
2891
old_revno, old_revid = self.last_revision_info()
2892
history = self._lefthand_history(revision_id)
2893
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2894
err_context = {'other_branch': other_branch}
2895
response = self._call('Branch.set_last_revision_ex',
2896
self._remote_path(), self._lock_token, self._repo_lock_token,
2897
revision_id, int(allow_diverged), int(allow_overwrite_descendant),
2899
self._clear_cached_state()
2900
if len(response) != 3 and response[0] != 'ok':
2901
raise errors.UnexpectedSmartServerResponse(response)
2902
new_revno, new_revision_id = response[1:]
2903
self._last_revision_info_cache = new_revno, new_revision_id
2904
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2905
if self._real_branch is not None:
2906
cache = new_revno, new_revision_id
2907
self._real_branch._last_revision_info_cache = cache
2909
def _set_last_revision(self, revision_id):
2910
old_revno, old_revid = self.last_revision_info()
2911
# This performs additional work to meet the hook contract; while its
2912
# undesirable, we have to synthesise the revno to call the hook, and
2913
# not calling the hook is worse as it means changes can't be prevented.
2914
# Having calculated this though, we can't just call into
2915
# set_last_revision_info as a simple call, because there is a set_rh
2916
# hook that some folk may still be using.
2917
history = self._lefthand_history(revision_id)
2918
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2919
self._clear_cached_state()
2920
response = self._call('Branch.set_last_revision',
2921
self._remote_path(), self._lock_token, self._repo_lock_token,
2923
if response != ('ok',):
2924
raise errors.UnexpectedSmartServerResponse(response)
2925
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2927
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2929
def set_revision_history(self, rev_history):
2930
"""See Branch.set_revision_history."""
2931
self._set_revision_history(rev_history)
2934
def _set_revision_history(self, rev_history):
2935
# Send just the tip revision of the history; the server will generate
2936
# the full history from that. If the revision doesn't exist in this
2937
# branch, NoSuchRevision will be raised.
2938
if rev_history == []:
2941
rev_id = rev_history[-1]
2942
self._set_last_revision(rev_id)
2943
for hook in branch.Branch.hooks['set_rh']:
2944
hook(self, rev_history)
2945
self._cache_revision_history(rev_history)
2947
def _get_parent_location(self):
2948
medium = self._client._medium
2949
if medium._is_remote_before((1, 13)):
2950
return self._vfs_get_parent_location()
2952
response = self._call('Branch.get_parent', self._remote_path())
2953
except errors.UnknownSmartMethod:
2954
medium._remember_remote_is_before((1, 13))
2955
return self._vfs_get_parent_location()
2956
if len(response) != 1:
2957
raise errors.UnexpectedSmartServerResponse(response)
2958
parent_location = response[0]
2959
if parent_location == '':
2961
return parent_location
2963
def _vfs_get_parent_location(self):
2965
return self._real_branch._get_parent_location()
2967
def _set_parent_location(self, url):
2968
medium = self._client._medium
2969
if medium._is_remote_before((1, 15)):
2970
return self._vfs_set_parent_location(url)
2972
call_url = url or ''
2973
if type(call_url) is not str:
2974
raise AssertionError('url must be a str or None (%s)' % url)
2975
response = self._call('Branch.set_parent_location',
2976
self._remote_path(), self._lock_token, self._repo_lock_token,
2978
except errors.UnknownSmartMethod:
2979
medium._remember_remote_is_before((1, 15))
2980
return self._vfs_set_parent_location(url)
2982
raise errors.UnexpectedSmartServerResponse(response)
2984
def _vfs_set_parent_location(self, url):
2986
return self._real_branch._set_parent_location(url)
2989
def pull(self, source, overwrite=False, stop_revision=None,
2991
self._clear_cached_state_of_remote_branch_only()
2993
return self._real_branch.pull(
2994
source, overwrite=overwrite, stop_revision=stop_revision,
2995
_override_hook_target=self, **kwargs)
2998
def push(self, target, overwrite=False, stop_revision=None, lossy=False):
3000
return self._real_branch.push(
3001
target, overwrite=overwrite, stop_revision=stop_revision, lossy=lossy,
3002
_override_hook_source_branch=self)
3004
def is_locked(self):
3005
return self._lock_count >= 1
3008
def revision_id_to_revno(self, revision_id):
3010
return self._real_branch.revision_id_to_revno(revision_id)
3013
def set_last_revision_info(self, revno, revision_id):
3014
# XXX: These should be returned by the set_last_revision_info verb
3015
old_revno, old_revid = self.last_revision_info()
3016
self._run_pre_change_branch_tip_hooks(revno, revision_id)
3017
if not revision_id or not isinstance(revision_id, basestring):
3018
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
3020
response = self._call('Branch.set_last_revision_info',
3021
self._remote_path(), self._lock_token, self._repo_lock_token,
3022
str(revno), revision_id)
3023
except errors.UnknownSmartMethod:
3025
self._clear_cached_state_of_remote_branch_only()
3026
self._real_branch.set_last_revision_info(revno, revision_id)
3027
self._last_revision_info_cache = revno, revision_id
3029
if response == ('ok',):
3030
self._clear_cached_state()
3031
self._last_revision_info_cache = revno, revision_id
3032
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
3033
# Update the _real_branch's cache too.
3034
if self._real_branch is not None:
3035
cache = self._last_revision_info_cache
3036
self._real_branch._last_revision_info_cache = cache
3038
raise errors.UnexpectedSmartServerResponse(response)
3041
def generate_revision_history(self, revision_id, last_rev=None,
3043
medium = self._client._medium
3044
if not medium._is_remote_before((1, 6)):
3045
# Use a smart method for 1.6 and above servers
3047
self._set_last_revision_descendant(revision_id, other_branch,
3048
allow_diverged=True, allow_overwrite_descendant=True)
3050
except errors.UnknownSmartMethod:
3051
medium._remember_remote_is_before((1, 6))
3052
self._clear_cached_state_of_remote_branch_only()
3053
self._set_revision_history(self._lefthand_history(revision_id,
3054
last_rev=last_rev,other_branch=other_branch))
3056
def set_push_location(self, location):
3058
return self._real_branch.set_push_location(location)
3060
def heads_to_fetch(self):
3061
if self._format._use_default_local_heads_to_fetch():
3062
# We recognise this format, and its heads-to-fetch implementation
3063
# is the default one (tip + tags). In this case it's cheaper to
3064
# just use the default implementation rather than a special RPC as
3065
# the tip and tags data is cached.
3066
return branch.Branch.heads_to_fetch(self)
3067
medium = self._client._medium
3068
if medium._is_remote_before((2, 4)):
3069
return self._vfs_heads_to_fetch()
3071
return self._rpc_heads_to_fetch()
3072
except errors.UnknownSmartMethod:
3073
medium._remember_remote_is_before((2, 4))
3074
return self._vfs_heads_to_fetch()
3076
def _rpc_heads_to_fetch(self):
3077
response = self._call('Branch.heads_to_fetch', self._remote_path())
3078
if len(response) != 2:
3079
raise errors.UnexpectedSmartServerResponse(response)
3080
must_fetch, if_present_fetch = response
3081
return set(must_fetch), set(if_present_fetch)
3083
def _vfs_heads_to_fetch(self):
3085
return self._real_branch.heads_to_fetch()
3088
class RemoteConfig(object):
3089
"""A Config that reads and writes from smart verbs.
3091
It is a low-level object that considers config data to be name/value pairs
3092
that may be associated with a section. Assigning meaning to the these
3093
values is done at higher levels like bzrlib.config.TreeConfig.
3096
def get_option(self, name, section=None, default=None):
3097
"""Return the value associated with a named option.
3099
:param name: The name of the value
3100
:param section: The section the option is in (if any)
3101
:param default: The value to return if the value is not set
3102
:return: The value or default value
3105
configobj = self._get_configobj()
3107
section_obj = configobj
3110
section_obj = configobj[section]
3113
return section_obj.get(name, default)
3114
except errors.UnknownSmartMethod:
3115
return self._vfs_get_option(name, section, default)
3117
def _response_to_configobj(self, response):
3118
if len(response[0]) and response[0][0] != 'ok':
3119
raise errors.UnexpectedSmartServerResponse(response)
3120
lines = response[1].read_body_bytes().splitlines()
3121
return config.ConfigObj(lines, encoding='utf-8')
3124
class RemoteBranchConfig(RemoteConfig):
3125
"""A RemoteConfig for Branches."""
3127
def __init__(self, branch):
3128
self._branch = branch
3130
def _get_configobj(self):
3131
path = self._branch._remote_path()
3132
response = self._branch._client.call_expecting_body(
3133
'Branch.get_config_file', path)
3134
return self._response_to_configobj(response)
3136
def set_option(self, value, name, section=None):
3137
"""Set the value associated with a named option.
3139
:param value: The value to set
3140
:param name: The name of the value to set
3141
:param section: The section the option is in (if any)
3143
medium = self._branch._client._medium
3144
if medium._is_remote_before((1, 14)):
3145
return self._vfs_set_option(value, name, section)
3146
if isinstance(value, dict):
3147
if medium._is_remote_before((2, 2)):
3148
return self._vfs_set_option(value, name, section)
3149
return self._set_config_option_dict(value, name, section)
3151
return self._set_config_option(value, name, section)
3153
def _set_config_option(self, value, name, section):
3155
path = self._branch._remote_path()
3156
response = self._branch._client.call('Branch.set_config_option',
3157
path, self._branch._lock_token, self._branch._repo_lock_token,
3158
value.encode('utf8'), name, section or '')
3159
except errors.UnknownSmartMethod:
3160
medium = self._branch._client._medium
3161
medium._remember_remote_is_before((1, 14))
3162
return self._vfs_set_option(value, name, section)
3164
raise errors.UnexpectedSmartServerResponse(response)
3166
def _serialize_option_dict(self, option_dict):
3168
for key, value in option_dict.items():
3169
if isinstance(key, unicode):
3170
key = key.encode('utf8')
3171
if isinstance(value, unicode):
3172
value = value.encode('utf8')
3173
utf8_dict[key] = value
3174
return bencode.bencode(utf8_dict)
3176
def _set_config_option_dict(self, value, name, section):
3178
path = self._branch._remote_path()
3179
serialised_dict = self._serialize_option_dict(value)
3180
response = self._branch._client.call(
3181
'Branch.set_config_option_dict',
3182
path, self._branch._lock_token, self._branch._repo_lock_token,
3183
serialised_dict, name, section or '')
3184
except errors.UnknownSmartMethod:
3185
medium = self._branch._client._medium
3186
medium._remember_remote_is_before((2, 2))
3187
return self._vfs_set_option(value, name, section)
3189
raise errors.UnexpectedSmartServerResponse(response)
3191
def _real_object(self):
3192
self._branch._ensure_real()
3193
return self._branch._real_branch
3195
def _vfs_set_option(self, value, name, section=None):
3196
return self._real_object()._get_config().set_option(
3197
value, name, section)
3200
class RemoteBzrDirConfig(RemoteConfig):
3201
"""A RemoteConfig for BzrDirs."""
3203
def __init__(self, bzrdir):
3204
self._bzrdir = bzrdir
3206
def _get_configobj(self):
3207
medium = self._bzrdir._client._medium
3208
verb = 'BzrDir.get_config_file'
3209
if medium._is_remote_before((1, 15)):
3210
raise errors.UnknownSmartMethod(verb)
3211
path = self._bzrdir._path_for_remote_call(self._bzrdir._client)
3212
response = self._bzrdir._call_expecting_body(
3214
return self._response_to_configobj(response)
3216
def _vfs_get_option(self, name, section, default):
3217
return self._real_object()._get_config().get_option(
3218
name, section, default)
3220
def set_option(self, value, name, section=None):
3221
"""Set the value associated with a named option.
3223
:param value: The value to set
3224
:param name: The name of the value to set
3225
:param section: The section the option is in (if any)
3227
return self._real_object()._get_config().set_option(
3228
value, name, section)
3230
def _real_object(self):
3231
self._bzrdir._ensure_real()
3232
return self._bzrdir._real_bzrdir
3236
def _extract_tar(tar, to_dir):
3237
"""Extract all the contents of a tarfile object.
3239
A replacement for extractall, which is not present in python2.4
3242
tar.extract(tarinfo, to_dir)
3245
def _translate_error(err, **context):
3246
"""Translate an ErrorFromSmartServer into a more useful error.
3248
Possible context keys:
3256
If the error from the server doesn't match a known pattern, then
3257
UnknownErrorFromSmartServer is raised.
3261
return context[name]
3262
except KeyError, key_err:
3263
mutter('Missing key %r in context %r', key_err.args[0], context)
3266
"""Get the path from the context if present, otherwise use first error
3270
return context['path']
3271
except KeyError, key_err:
3273
return err.error_args[0]
3274
except IndexError, idx_err:
3276
'Missing key %r in context %r', key_err.args[0], context)
3279
if err.error_verb == 'NoSuchRevision':
3280
raise NoSuchRevision(find('branch'), err.error_args[0])
3281
elif err.error_verb == 'nosuchrevision':
3282
raise NoSuchRevision(find('repository'), err.error_args[0])
3283
elif err.error_verb == 'nobranch':
3284
if len(err.error_args) >= 1:
3285
extra = err.error_args[0]
3288
raise errors.NotBranchError(path=find('bzrdir').root_transport.base,
3290
elif err.error_verb == 'norepository':
3291
raise errors.NoRepositoryPresent(find('bzrdir'))
3292
elif err.error_verb == 'UnlockableTransport':
3293
raise errors.UnlockableTransport(find('bzrdir').root_transport)
3294
elif err.error_verb == 'TokenMismatch':
3295
raise errors.TokenMismatch(find('token'), '(remote token)')
3296
elif err.error_verb == 'Diverged':
3297
raise errors.DivergedBranches(find('branch'), find('other_branch'))
3298
elif err.error_verb == 'NotStacked':
3299
raise errors.NotStacked(branch=find('branch'))
3300
elif err.error_verb == 'PermissionDenied':
3302
if len(err.error_args) >= 2:
3303
extra = err.error_args[1]
3306
raise errors.PermissionDenied(path, extra=extra)
3307
elif err.error_verb == 'ReadError':
3309
raise errors.ReadError(path)
3310
elif err.error_verb == 'NoSuchFile':
3312
raise errors.NoSuchFile(path)
3313
_translate_error_without_context(err)
3316
def _translate_error_without_context(err):
3317
"""Translate any ErrorFromSmartServer values that don't require context"""
3318
if err.error_verb == 'IncompatibleRepositories':
3319
raise errors.IncompatibleRepositories(err.error_args[0],
3320
err.error_args[1], err.error_args[2])
3321
elif err.error_verb == 'LockContention':
3322
raise errors.LockContention('(remote lock)')
3323
elif err.error_verb == 'LockFailed':
3324
raise errors.LockFailed(err.error_args[0], err.error_args[1])
3325
elif err.error_verb == 'TipChangeRejected':
3326
raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
3327
elif err.error_verb == 'UnstackableBranchFormat':
3328
raise errors.UnstackableBranchFormat(*err.error_args)
3329
elif err.error_verb == 'UnstackableRepositoryFormat':
3330
raise errors.UnstackableRepositoryFormat(*err.error_args)
3331
elif err.error_verb == 'FileExists':
3332
raise errors.FileExists(err.error_args[0])
3333
elif err.error_verb == 'DirectoryNotEmpty':
3334
raise errors.DirectoryNotEmpty(err.error_args[0])
3335
elif err.error_verb == 'ShortReadvError':
3336
args = err.error_args
3337
raise errors.ShortReadvError(
3338
args[0], int(args[1]), int(args[2]), int(args[3]))
3339
elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
3340
encoding = str(err.error_args[0]) # encoding must always be a string
3341
val = err.error_args[1]
3342
start = int(err.error_args[2])
3343
end = int(err.error_args[3])
3344
reason = str(err.error_args[4]) # reason must always be a string
3345
if val.startswith('u:'):
3346
val = val[2:].decode('utf-8')
3347
elif val.startswith('s:'):
3348
val = val[2:].decode('base64')
3349
if err.error_verb == 'UnicodeDecodeError':
3350
raise UnicodeDecodeError(encoding, val, start, end, reason)
3351
elif err.error_verb == 'UnicodeEncodeError':
3352
raise UnicodeEncodeError(encoding, val, start, end, reason)
3353
elif err.error_verb == 'ReadOnlyError':
3354
raise errors.TransportNotPossible('readonly transport')
3355
elif err.error_verb == 'MemoryError':
3356
raise errors.BzrError("remote server out of memory\n"
3357
"Retry non-remotely, or contact the server admin for details.")
3358
raise errors.UnknownErrorFromSmartServer(err)
added
removed
bzrlib/remote.py
