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,
37
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
38
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
39
from bzrlib.errors import (
43
from bzrlib.lockable_files import LockableFiles
44
from bzrlib.smart import client, vfs, repository as smart_repo
45
from bzrlib.smart.client import _SmartClient
46
from bzrlib.revision import NULL_REVISION
47
from bzrlib.repository import RepositoryWriteLockResult, _LazyListJoin
48
from bzrlib.trace import mutter, note, warning
51
class _RpcHelper(object):
52
"""Mixin class that helps with issuing RPCs."""
54
def _call(self, method, *args, **err_context):
56
return self._client.call(method, *args)
57
except errors.ErrorFromSmartServer, err:
58
self._translate_error(err, **err_context)
60
def _call_expecting_body(self, method, *args, **err_context):
62
return self._client.call_expecting_body(method, *args)
63
except errors.ErrorFromSmartServer, err:
64
self._translate_error(err, **err_context)
66
def _call_with_body_bytes(self, method, args, body_bytes, **err_context):
68
return self._client.call_with_body_bytes(method, args, body_bytes)
69
except errors.ErrorFromSmartServer, err:
70
self._translate_error(err, **err_context)
72
def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
75
return self._client.call_with_body_bytes_expecting_body(
76
method, args, body_bytes)
77
except errors.ErrorFromSmartServer, err:
78
self._translate_error(err, **err_context)
81
def response_tuple_to_repo_format(response):
82
"""Convert a response tuple describing a repository format to a format."""
83
format = RemoteRepositoryFormat()
84
format._rich_root_data = (response[0] == 'yes')
85
format._supports_tree_reference = (response[1] == 'yes')
86
format._supports_external_lookups = (response[2] == 'yes')
87
format._network_name = response[3]
91
# Note that RemoteBzrDirProber lives in bzrlib.bzrdir so bzrlib.remote
92
# does not have to be imported unless a remote format is involved.
94
class RemoteBzrDirFormat(_mod_bzrdir.BzrDirMetaFormat1):
95
"""Format representing bzrdirs accessed via a smart server"""
97
supports_workingtrees = False
100
_mod_bzrdir.BzrDirMetaFormat1.__init__(self)
101
# XXX: It's a bit ugly that the network name is here, because we'd
102
# like to believe that format objects are stateless or at least
103
# immutable, However, we do at least avoid mutating the name after
104
# it's returned. See <https://bugs.launchpad.net/bzr/+bug/504102>
105
self._network_name = None
108
return "%s(_network_name=%r)" % (self.__class__.__name__,
111
def get_format_description(self):
112
if self._network_name:
113
real_format = controldir.network_format_registry.get(self._network_name)
114
return 'Remote: ' + real_format.get_format_description()
115
return 'bzr remote bzrdir'
117
def get_format_string(self):
118
raise NotImplementedError(self.get_format_string)
120
def network_name(self):
121
if self._network_name:
122
return self._network_name
124
raise AssertionError("No network name set.")
126
def initialize_on_transport(self, transport):
128
# hand off the request to the smart server
129
client_medium = transport.get_smart_medium()
130
except errors.NoSmartMedium:
131
# TODO: lookup the local format from a server hint.
132
local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
133
return local_dir_format.initialize_on_transport(transport)
134
client = _SmartClient(client_medium)
135
path = client.remote_path_from_transport(transport)
137
response = client.call('BzrDirFormat.initialize', path)
138
except errors.ErrorFromSmartServer, err:
139
_translate_error(err, path=path)
140
if response[0] != 'ok':
141
raise errors.SmartProtocolError('unexpected response code %s' % (response,))
142
format = RemoteBzrDirFormat()
143
self._supply_sub_formats_to(format)
144
return RemoteBzrDir(transport, format)
146
def parse_NoneTrueFalse(self, arg):
153
raise AssertionError("invalid arg %r" % arg)
155
def _serialize_NoneTrueFalse(self, arg):
162
def _serialize_NoneString(self, arg):
165
def initialize_on_transport_ex(self, transport, use_existing_dir=False,
166
create_prefix=False, force_new_repo=False, stacked_on=None,
167
stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
170
# hand off the request to the smart server
171
client_medium = transport.get_smart_medium()
172
except errors.NoSmartMedium:
175
# Decline to open it if the server doesn't support our required
176
# version (3) so that the VFS-based transport will do it.
177
if client_medium.should_probe():
179
server_version = client_medium.protocol_version()
180
if server_version != '2':
184
except errors.SmartProtocolError:
185
# Apparently there's no usable smart server there, even though
186
# the medium supports the smart protocol.
191
client = _SmartClient(client_medium)
192
path = client.remote_path_from_transport(transport)
193
if client_medium._is_remote_before((1, 16)):
196
# TODO: lookup the local format from a server hint.
197
local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
198
self._supply_sub_formats_to(local_dir_format)
199
return local_dir_format.initialize_on_transport_ex(transport,
200
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
201
force_new_repo=force_new_repo, stacked_on=stacked_on,
202
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
203
make_working_trees=make_working_trees, shared_repo=shared_repo,
205
return self._initialize_on_transport_ex_rpc(client, path, transport,
206
use_existing_dir, create_prefix, force_new_repo, stacked_on,
207
stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
209
def _initialize_on_transport_ex_rpc(self, client, path, transport,
210
use_existing_dir, create_prefix, force_new_repo, stacked_on,
211
stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
213
args.append(self._serialize_NoneTrueFalse(use_existing_dir))
214
args.append(self._serialize_NoneTrueFalse(create_prefix))
215
args.append(self._serialize_NoneTrueFalse(force_new_repo))
216
args.append(self._serialize_NoneString(stacked_on))
217
# stack_on_pwd is often/usually our transport
220
stack_on_pwd = transport.relpath(stack_on_pwd)
223
except errors.PathNotChild:
225
args.append(self._serialize_NoneString(stack_on_pwd))
226
args.append(self._serialize_NoneString(repo_format_name))
227
args.append(self._serialize_NoneTrueFalse(make_working_trees))
228
args.append(self._serialize_NoneTrueFalse(shared_repo))
229
request_network_name = self._network_name or \
230
_mod_bzrdir.BzrDirFormat.get_default_format().network_name()
232
response = client.call('BzrDirFormat.initialize_ex_1.16',
233
request_network_name, path, *args)
234
except errors.UnknownSmartMethod:
235
client._medium._remember_remote_is_before((1,16))
236
local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
237
self._supply_sub_formats_to(local_dir_format)
238
return local_dir_format.initialize_on_transport_ex(transport,
239
use_existing_dir=use_existing_dir, create_prefix=create_prefix,
240
force_new_repo=force_new_repo, stacked_on=stacked_on,
241
stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
242
make_working_trees=make_working_trees, shared_repo=shared_repo,
244
except errors.ErrorFromSmartServer, err:
245
_translate_error(err, path=path)
246
repo_path = response[0]
247
bzrdir_name = response[6]
248
require_stacking = response[7]
249
require_stacking = self.parse_NoneTrueFalse(require_stacking)
250
format = RemoteBzrDirFormat()
251
format._network_name = bzrdir_name
252
self._supply_sub_formats_to(format)
253
bzrdir = RemoteBzrDir(transport, format, _client=client)
255
repo_format = response_tuple_to_repo_format(response[1:])
259
repo_bzrdir_format = RemoteBzrDirFormat()
260
repo_bzrdir_format._network_name = response[5]
261
repo_bzr = RemoteBzrDir(transport.clone(repo_path),
265
final_stack = response[8] or None
266
final_stack_pwd = response[9] or None
268
final_stack_pwd = urlutils.join(
269
transport.base, final_stack_pwd)
270
remote_repo = RemoteRepository(repo_bzr, repo_format)
271
if len(response) > 10:
272
# Updated server verb that locks remotely.
273
repo_lock_token = response[10] or None
274
remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
276
remote_repo.dont_leave_lock_in_place()
278
remote_repo.lock_write()
279
policy = _mod_bzrdir.UseExistingRepository(remote_repo, final_stack,
280
final_stack_pwd, require_stacking)
281
policy.acquire_repository()
285
bzrdir._format.set_branch_format(self.get_branch_format())
287
# The repo has already been created, but we need to make sure that
288
# we'll make a stackable branch.
289
bzrdir._format.require_stacking(_skip_repo=True)
290
return remote_repo, bzrdir, require_stacking, policy
292
def _open(self, transport):
293
return RemoteBzrDir(transport, self)
295
def __eq__(self, other):
296
if not isinstance(other, RemoteBzrDirFormat):
298
return self.get_format_description() == other.get_format_description()
300
def __return_repository_format(self):
301
# Always return a RemoteRepositoryFormat object, but if a specific bzr
302
# repository format has been asked for, tell the RemoteRepositoryFormat
303
# that it should use that for init() etc.
304
result = RemoteRepositoryFormat()
305
custom_format = getattr(self, '_repository_format', None)
307
if isinstance(custom_format, RemoteRepositoryFormat):
310
# We will use the custom format to create repositories over the
311
# wire; expose its details like rich_root_data for code to
313
result._custom_format = custom_format
316
def get_branch_format(self):
317
result = _mod_bzrdir.BzrDirMetaFormat1.get_branch_format(self)
318
if not isinstance(result, RemoteBranchFormat):
319
new_result = RemoteBranchFormat()
320
new_result._custom_format = result
322
self.set_branch_format(new_result)
326
repository_format = property(__return_repository_format,
327
_mod_bzrdir.BzrDirMetaFormat1._set_repository_format) #.im_func)
330
class RemoteBzrDir(_mod_bzrdir.BzrDir, _RpcHelper):
331
"""Control directory on a remote server, accessed via bzr:// or similar."""
333
def __init__(self, transport, format, _client=None, _force_probe=False):
334
"""Construct a RemoteBzrDir.
336
:param _client: Private parameter for testing. Disables probing and the
337
use of a real bzrdir.
339
_mod_bzrdir.BzrDir.__init__(self, transport, format)
340
# this object holds a delegated bzrdir that uses file-level operations
341
# to talk to the other side
342
self._real_bzrdir = None
343
self._has_working_tree = None
344
# 1-shot cache for the call pattern 'create_branch; open_branch' - see
345
# create_branch for details.
346
self._next_open_branch_result = None
349
medium = transport.get_smart_medium()
350
self._client = client._SmartClient(medium)
352
self._client = _client
359
return '%s(%r)' % (self.__class__.__name__, self._client)
361
def _probe_bzrdir(self):
362
medium = self._client._medium
363
path = self._path_for_remote_call(self._client)
364
if medium._is_remote_before((2, 1)):
368
self._rpc_open_2_1(path)
370
except errors.UnknownSmartMethod:
371
medium._remember_remote_is_before((2, 1))
374
def _rpc_open_2_1(self, path):
375
response = self._call('BzrDir.open_2.1', path)
376
if response == ('no',):
377
raise errors.NotBranchError(path=self.root_transport.base)
378
elif response[0] == 'yes':
379
if response[1] == 'yes':
380
self._has_working_tree = True
381
elif response[1] == 'no':
382
self._has_working_tree = False
384
raise errors.UnexpectedSmartServerResponse(response)
386
raise errors.UnexpectedSmartServerResponse(response)
388
def _rpc_open(self, path):
389
response = self._call('BzrDir.open', path)
390
if response not in [('yes',), ('no',)]:
391
raise errors.UnexpectedSmartServerResponse(response)
392
if response == ('no',):
393
raise errors.NotBranchError(path=self.root_transport.base)
395
def _ensure_real(self):
396
"""Ensure that there is a _real_bzrdir set.
398
Used before calls to self._real_bzrdir.
400
if not self._real_bzrdir:
401
if 'hpssvfs' in debug.debug_flags:
403
warning('VFS BzrDir access triggered\n%s',
404
''.join(traceback.format_stack()))
405
self._real_bzrdir = _mod_bzrdir.BzrDir.open_from_transport(
406
self.root_transport, _server_formats=False)
407
self._format._network_name = \
408
self._real_bzrdir._format.network_name()
410
def _translate_error(self, err, **context):
411
_translate_error(err, bzrdir=self, **context)
413
def break_lock(self):
414
# Prevent aliasing problems in the next_open_branch_result cache.
415
# See create_branch for rationale.
416
self._next_open_branch_result = None
417
return _mod_bzrdir.BzrDir.break_lock(self)
419
def _vfs_cloning_metadir(self, require_stacking=False):
421
return self._real_bzrdir.cloning_metadir(
422
require_stacking=require_stacking)
424
def cloning_metadir(self, require_stacking=False):
425
medium = self._client._medium
426
if medium._is_remote_before((1, 13)):
427
return self._vfs_cloning_metadir(require_stacking=require_stacking)
428
verb = 'BzrDir.cloning_metadir'
433
path = self._path_for_remote_call(self._client)
435
response = self._call(verb, path, stacking)
436
except errors.UnknownSmartMethod:
437
medium._remember_remote_is_before((1, 13))
438
return self._vfs_cloning_metadir(require_stacking=require_stacking)
439
except errors.UnknownErrorFromSmartServer, err:
440
if err.error_tuple != ('BranchReference',):
442
# We need to resolve the branch reference to determine the
443
# cloning_metadir. This causes unnecessary RPCs to open the
444
# referenced branch (and bzrdir, etc) but only when the caller
445
# didn't already resolve the branch reference.
446
referenced_branch = self.open_branch()
447
return referenced_branch.bzrdir.cloning_metadir()
448
if len(response) != 3:
449
raise errors.UnexpectedSmartServerResponse(response)
450
control_name, repo_name, branch_info = response
451
if len(branch_info) != 2:
452
raise errors.UnexpectedSmartServerResponse(response)
453
branch_ref, branch_name = branch_info
454
format = controldir.network_format_registry.get(control_name)
456
format.repository_format = _mod_repository.network_format_registry.get(
458
if branch_ref == 'ref':
459
# XXX: we need possible_transports here to avoid reopening the
460
# connection to the referenced location
461
ref_bzrdir = _mod_bzrdir.BzrDir.open(branch_name)
462
branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
463
format.set_branch_format(branch_format)
464
elif branch_ref == 'branch':
466
format.set_branch_format(
467
branch.network_format_registry.get(branch_name))
469
raise errors.UnexpectedSmartServerResponse(response)
472
def create_repository(self, shared=False):
473
# as per meta1 formats - just delegate to the format object which may
475
result = self._format.repository_format.initialize(self, shared)
476
if not isinstance(result, RemoteRepository):
477
return self.open_repository()
481
def destroy_repository(self):
482
"""See BzrDir.destroy_repository"""
484
self._real_bzrdir.destroy_repository()
486
def create_branch(self, name=None, repository=None):
487
# as per meta1 formats - just delegate to the format object which may
489
real_branch = self._format.get_branch_format().initialize(self,
490
name=name, repository=repository)
491
if not isinstance(real_branch, RemoteBranch):
492
if not isinstance(repository, RemoteRepository):
493
raise AssertionError(
494
'need a RemoteRepository to use with RemoteBranch, got %r'
496
result = RemoteBranch(self, repository, real_branch, name=name)
499
# BzrDir.clone_on_transport() uses the result of create_branch but does
500
# not return it to its callers; we save approximately 8% of our round
501
# trips by handing the branch we created back to the first caller to
502
# open_branch rather than probing anew. Long term we need a API in
503
# bzrdir that doesn't discard result objects (like result_branch).
505
self._next_open_branch_result = result
508
def destroy_branch(self, name=None):
509
"""See BzrDir.destroy_branch"""
511
self._real_bzrdir.destroy_branch(name=name)
512
self._next_open_branch_result = None
514
def create_workingtree(self, revision_id=None, from_branch=None,
515
accelerator_tree=None, hardlink=False):
516
raise errors.NotLocalUrl(self.transport.base)
518
def find_branch_format(self, name=None):
519
"""Find the branch 'format' for this bzrdir.
521
This might be a synthetic object for e.g. RemoteBranch and SVN.
523
b = self.open_branch(name=name)
526
def get_branch_reference(self, name=None):
527
"""See BzrDir.get_branch_reference()."""
529
# XXX JRV20100304: Support opening colocated branches
530
raise errors.NoColocatedBranchSupport(self)
531
response = self._get_branch_reference()
532
if response[0] == 'ref':
537
def _get_branch_reference(self):
538
path = self._path_for_remote_call(self._client)
539
medium = self._client._medium
541
('BzrDir.open_branchV3', (2, 1)),
542
('BzrDir.open_branchV2', (1, 13)),
543
('BzrDir.open_branch', None),
545
for verb, required_version in candidate_calls:
546
if required_version and medium._is_remote_before(required_version):
549
response = self._call(verb, path)
550
except errors.UnknownSmartMethod:
551
if required_version is None:
553
medium._remember_remote_is_before(required_version)
556
if verb == 'BzrDir.open_branch':
557
if response[0] != 'ok':
558
raise errors.UnexpectedSmartServerResponse(response)
559
if response[1] != '':
560
return ('ref', response[1])
562
return ('branch', '')
563
if response[0] not in ('ref', 'branch'):
564
raise errors.UnexpectedSmartServerResponse(response)
567
def _get_tree_branch(self, name=None):
568
"""See BzrDir._get_tree_branch()."""
569
return None, self.open_branch(name=name)
571
def open_branch(self, name=None, unsupported=False,
572
ignore_fallbacks=False):
574
raise NotImplementedError('unsupported flag support not implemented yet.')
575
if self._next_open_branch_result is not None:
576
# See create_branch for details.
577
result = self._next_open_branch_result
578
self._next_open_branch_result = None
580
response = self._get_branch_reference()
581
if response[0] == 'ref':
582
# a branch reference, use the existing BranchReference logic.
583
format = BranchReferenceFormat()
584
return format.open(self, name=name, _found=True,
585
location=response[1], ignore_fallbacks=ignore_fallbacks)
586
branch_format_name = response[1]
587
if not branch_format_name:
588
branch_format_name = None
589
format = RemoteBranchFormat(network_name=branch_format_name)
590
return RemoteBranch(self, self.find_repository(), format=format,
591
setup_stacking=not ignore_fallbacks, name=name)
593
def _open_repo_v1(self, path):
594
verb = 'BzrDir.find_repository'
595
response = self._call(verb, path)
596
if response[0] != 'ok':
597
raise errors.UnexpectedSmartServerResponse(response)
598
# servers that only support the v1 method don't support external
601
repo = self._real_bzrdir.open_repository()
602
response = response + ('no', repo._format.network_name())
603
return response, repo
605
def _open_repo_v2(self, path):
606
verb = 'BzrDir.find_repositoryV2'
607
response = self._call(verb, path)
608
if response[0] != 'ok':
609
raise errors.UnexpectedSmartServerResponse(response)
611
repo = self._real_bzrdir.open_repository()
612
response = response + (repo._format.network_name(),)
613
return response, repo
615
def _open_repo_v3(self, path):
616
verb = 'BzrDir.find_repositoryV3'
617
medium = self._client._medium
618
if medium._is_remote_before((1, 13)):
619
raise errors.UnknownSmartMethod(verb)
621
response = self._call(verb, path)
622
except errors.UnknownSmartMethod:
623
medium._remember_remote_is_before((1, 13))
625
if response[0] != 'ok':
626
raise errors.UnexpectedSmartServerResponse(response)
627
return response, None
629
def open_repository(self):
630
path = self._path_for_remote_call(self._client)
632
for probe in [self._open_repo_v3, self._open_repo_v2,
635
response, real_repo = probe(path)
637
except errors.UnknownSmartMethod:
640
raise errors.UnknownSmartMethod('BzrDir.find_repository{3,2,}')
641
if response[0] != 'ok':
642
raise errors.UnexpectedSmartServerResponse(response)
643
if len(response) != 6:
644
raise SmartProtocolError('incorrect response length %s' % (response,))
645
if response[1] == '':
646
# repo is at this dir.
647
format = response_tuple_to_repo_format(response[2:])
648
# Used to support creating a real format instance when needed.
649
format._creating_bzrdir = self
650
remote_repo = RemoteRepository(self, format)
651
format._creating_repo = remote_repo
652
if real_repo is not None:
653
remote_repo._set_real_repository(real_repo)
656
raise errors.NoRepositoryPresent(self)
658
def has_workingtree(self):
659
if self._has_working_tree is None:
661
self._has_working_tree = self._real_bzrdir.has_workingtree()
662
return self._has_working_tree
664
def open_workingtree(self, recommend_upgrade=True):
665
if self.has_workingtree():
666
raise errors.NotLocalUrl(self.root_transport)
668
raise errors.NoWorkingTree(self.root_transport.base)
670
def _path_for_remote_call(self, client):
671
"""Return the path to be used for this bzrdir in a remote call."""
672
return client.remote_path_from_transport(self.root_transport)
674
def get_branch_transport(self, branch_format, name=None):
676
return self._real_bzrdir.get_branch_transport(branch_format, name=name)
678
def get_repository_transport(self, repository_format):
680
return self._real_bzrdir.get_repository_transport(repository_format)
682
def get_workingtree_transport(self, workingtree_format):
684
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
686
def can_convert_format(self):
687
"""Upgrading of remote bzrdirs is not supported yet."""
690
def needs_format_conversion(self, format):
691
"""Upgrading of remote bzrdirs is not supported yet."""
694
def clone(self, url, revision_id=None, force_new_repo=False,
695
preserve_stacking=False):
697
return self._real_bzrdir.clone(url, revision_id=revision_id,
698
force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
700
def _get_config(self):
701
return RemoteBzrDirConfig(self)
704
class RemoteRepositoryFormat(vf_repository.VersionedFileRepositoryFormat):
705
"""Format for repositories accessed over a _SmartClient.
707
Instances of this repository are represented by RemoteRepository
710
The RemoteRepositoryFormat is parameterized during construction
711
to reflect the capabilities of the real, remote format. Specifically
712
the attributes rich_root_data and supports_tree_reference are set
713
on a per instance basis, and are not set (and should not be) at
716
:ivar _custom_format: If set, a specific concrete repository format that
717
will be used when initializing a repository with this
718
RemoteRepositoryFormat.
719
:ivar _creating_repo: If set, the repository object that this
720
RemoteRepositoryFormat was created for: it can be called into
721
to obtain data like the network name.
724
_matchingbzrdir = RemoteBzrDirFormat()
725
supports_full_versioned_files = True
726
supports_leaving_lock = True
729
_mod_repository.RepositoryFormat.__init__(self)
730
self._custom_format = None
731
self._network_name = None
732
self._creating_bzrdir = None
733
self._revision_graph_can_have_wrong_parents = None
734
self._supports_chks = None
735
self._supports_external_lookups = None
736
self._supports_tree_reference = None
737
self._supports_funky_characters = None
738
self._rich_root_data = None
741
return "%s(_network_name=%r)" % (self.__class__.__name__,
745
def fast_deltas(self):
747
return self._custom_format.fast_deltas
750
def rich_root_data(self):
751
if self._rich_root_data is None:
753
self._rich_root_data = self._custom_format.rich_root_data
754
return self._rich_root_data
757
def supports_chks(self):
758
if self._supports_chks is None:
760
self._supports_chks = self._custom_format.supports_chks
761
return self._supports_chks
764
def supports_external_lookups(self):
765
if self._supports_external_lookups is None:
767
self._supports_external_lookups = \
768
self._custom_format.supports_external_lookups
769
return self._supports_external_lookups
772
def supports_funky_characters(self):
773
if self._supports_funky_characters is None:
775
self._supports_funky_characters = \
776
self._custom_format.supports_funky_characters
777
return self._supports_funky_characters
780
def supports_tree_reference(self):
781
if self._supports_tree_reference is None:
783
self._supports_tree_reference = \
784
self._custom_format.supports_tree_reference
785
return self._supports_tree_reference
788
def revision_graph_can_have_wrong_parents(self):
789
if self._revision_graph_can_have_wrong_parents is None:
791
self._revision_graph_can_have_wrong_parents = \
792
self._custom_format.revision_graph_can_have_wrong_parents
793
return self._revision_graph_can_have_wrong_parents
795
def _vfs_initialize(self, a_bzrdir, shared):
796
"""Helper for common code in initialize."""
797
if self._custom_format:
798
# Custom format requested
799
result = self._custom_format.initialize(a_bzrdir, shared=shared)
800
elif self._creating_bzrdir is not None:
801
# Use the format that the repository we were created to back
803
prior_repo = self._creating_bzrdir.open_repository()
804
prior_repo._ensure_real()
805
result = prior_repo._real_repository._format.initialize(
806
a_bzrdir, shared=shared)
808
# assume that a_bzr is a RemoteBzrDir but the smart server didn't
809
# support remote initialization.
810
# We delegate to a real object at this point (as RemoteBzrDir
811
# delegate to the repository format which would lead to infinite
812
# recursion if we just called a_bzrdir.create_repository.
813
a_bzrdir._ensure_real()
814
result = a_bzrdir._real_bzrdir.create_repository(shared=shared)
815
if not isinstance(result, RemoteRepository):
816
return self.open(a_bzrdir)
820
def initialize(self, a_bzrdir, shared=False):
821
# Being asked to create on a non RemoteBzrDir:
822
if not isinstance(a_bzrdir, RemoteBzrDir):
823
return self._vfs_initialize(a_bzrdir, shared)
824
medium = a_bzrdir._client._medium
825
if medium._is_remote_before((1, 13)):
826
return self._vfs_initialize(a_bzrdir, shared)
827
# Creating on a remote bzr dir.
828
# 1) get the network name to use.
829
if self._custom_format:
830
network_name = self._custom_format.network_name()
831
elif self._network_name:
832
network_name = self._network_name
834
# Select the current bzrlib default and ask for that.
835
reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
836
reference_format = reference_bzrdir_format.repository_format
837
network_name = reference_format.network_name()
838
# 2) try direct creation via RPC
839
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
840
verb = 'BzrDir.create_repository'
846
response = a_bzrdir._call(verb, path, network_name, shared_str)
847
except errors.UnknownSmartMethod:
848
# Fallback - use vfs methods
849
medium._remember_remote_is_before((1, 13))
850
return self._vfs_initialize(a_bzrdir, shared)
852
# Turn the response into a RemoteRepository object.
853
format = response_tuple_to_repo_format(response[1:])
854
# Used to support creating a real format instance when needed.
855
format._creating_bzrdir = a_bzrdir
856
remote_repo = RemoteRepository(a_bzrdir, format)
857
format._creating_repo = remote_repo
860
def open(self, a_bzrdir):
861
if not isinstance(a_bzrdir, RemoteBzrDir):
862
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
863
return a_bzrdir.open_repository()
865
def _ensure_real(self):
866
if self._custom_format is None:
867
self._custom_format = _mod_repository.network_format_registry.get(
871
def _fetch_order(self):
873
return self._custom_format._fetch_order
876
def _fetch_uses_deltas(self):
878
return self._custom_format._fetch_uses_deltas
881
def _fetch_reconcile(self):
883
return self._custom_format._fetch_reconcile
885
def get_format_description(self):
887
return 'Remote: ' + self._custom_format.get_format_description()
889
def __eq__(self, other):
890
return self.__class__ is other.__class__
892
def network_name(self):
893
if self._network_name:
894
return self._network_name
895
self._creating_repo._ensure_real()
896
return self._creating_repo._real_repository._format.network_name()
899
def pack_compresses(self):
901
return self._custom_format.pack_compresses
904
def _serializer(self):
906
return self._custom_format._serializer
909
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
910
controldir.ControlComponent):
911
"""Repository accessed over rpc.
913
For the moment most operations are performed using local transport-backed
917
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
918
"""Create a RemoteRepository instance.
920
:param remote_bzrdir: The bzrdir hosting this repository.
921
:param format: The RemoteFormat object to use.
922
:param real_repository: If not None, a local implementation of the
923
repository logic for the repository, usually accessing the data
925
:param _client: Private testing parameter - override the smart client
926
to be used by the repository.
929
self._real_repository = real_repository
931
self._real_repository = None
932
self.bzrdir = remote_bzrdir
934
self._client = remote_bzrdir._client
936
self._client = _client
937
self._format = format
938
self._lock_mode = None
939
self._lock_token = None
941
self._leave_lock = False
942
# Cache of revision parents; misses are cached during read locks, and
943
# write locks when no _real_repository has been set.
944
self._unstacked_provider = graph.CachingParentsProvider(
945
get_parent_map=self._get_parent_map_rpc)
946
self._unstacked_provider.disable_cache()
948
# These depend on the actual remote format, so force them off for
949
# maximum compatibility. XXX: In future these should depend on the
950
# remote repository instance, but this is irrelevant until we perform
951
# reconcile via an RPC call.
952
self._reconcile_does_inventory_gc = False
953
self._reconcile_fixes_text_parents = False
954
self._reconcile_backsup_inventory = False
955
self.base = self.bzrdir.transport.base
956
# Additional places to query for data.
957
self._fallback_repositories = []
960
def user_transport(self):
961
return self.bzrdir.user_transport
964
def control_transport(self):
965
# XXX: Normally you shouldn't directly get at the remote repository
966
# transport, but I'm not sure it's worth making this method
967
# optional -- mbp 2010-04-21
968
return self.bzrdir.get_repository_transport(None)
971
return "%s(%s)" % (self.__class__.__name__, self.base)
975
def abort_write_group(self, suppress_errors=False):
976
"""Complete a write group on the decorated repository.
978
Smart methods perform operations in a single step so this API
979
is not really applicable except as a compatibility thunk
980
for older plugins that don't use e.g. the CommitBuilder
983
:param suppress_errors: see Repository.abort_write_group.
986
return self._real_repository.abort_write_group(
987
suppress_errors=suppress_errors)
991
"""Decorate the real repository for now.
993
In the long term a full blown network facility is needed to avoid
994
creating a real repository object locally.
997
return self._real_repository.chk_bytes
999
def commit_write_group(self):
1000
"""Complete a write group on the decorated repository.
1002
Smart methods perform operations in a single step so this API
1003
is not really applicable except as a compatibility thunk
1004
for older plugins that don't use e.g. the CommitBuilder
1008
return self._real_repository.commit_write_group()
1010
def resume_write_group(self, tokens):
1012
return self._real_repository.resume_write_group(tokens)
1014
def suspend_write_group(self):
1016
return self._real_repository.suspend_write_group()
1018
def get_missing_parent_inventories(self, check_for_missing_texts=True):
1020
return self._real_repository.get_missing_parent_inventories(
1021
check_for_missing_texts=check_for_missing_texts)
1023
def _get_rev_id_for_revno_vfs(self, revno, known_pair):
1025
return self._real_repository.get_rev_id_for_revno(
1028
def get_rev_id_for_revno(self, revno, known_pair):
1029
"""See Repository.get_rev_id_for_revno."""
1030
path = self.bzrdir._path_for_remote_call(self._client)
1032
if self._client._medium._is_remote_before((1, 17)):
1033
return self._get_rev_id_for_revno_vfs(revno, known_pair)
1034
response = self._call(
1035
'Repository.get_rev_id_for_revno', path, revno, known_pair)
1036
except errors.UnknownSmartMethod:
1037
self._client._medium._remember_remote_is_before((1, 17))
1038
return self._get_rev_id_for_revno_vfs(revno, known_pair)
1039
if response[0] == 'ok':
1040
return True, response[1]
1041
elif response[0] == 'history-incomplete':
1042
known_pair = response[1:3]
1043
for fallback in self._fallback_repositories:
1044
found, result = fallback.get_rev_id_for_revno(revno, known_pair)
1049
# Not found in any fallbacks
1050
return False, known_pair
1052
raise errors.UnexpectedSmartServerResponse(response)
1054
def _ensure_real(self):
1055
"""Ensure that there is a _real_repository set.
1057
Used before calls to self._real_repository.
1059
Note that _ensure_real causes many roundtrips to the server which are
1060
not desirable, and prevents the use of smart one-roundtrip RPC's to
1061
perform complex operations (such as accessing parent data, streaming
1062
revisions etc). Adding calls to _ensure_real should only be done when
1063
bringing up new functionality, adding fallbacks for smart methods that
1064
require a fallback path, and never to replace an existing smart method
1065
invocation. If in doubt chat to the bzr network team.
1067
if self._real_repository is None:
1068
if 'hpssvfs' in debug.debug_flags:
1070
warning('VFS Repository access triggered\n%s',
1071
''.join(traceback.format_stack()))
1072
self._unstacked_provider.missing_keys.clear()
1073
self.bzrdir._ensure_real()
1074
self._set_real_repository(
1075
self.bzrdir._real_bzrdir.open_repository())
1077
def _translate_error(self, err, **context):
1078
self.bzrdir._translate_error(err, repository=self, **context)
1080
def find_text_key_references(self):
1081
"""Find the text key references within the repository.
1083
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
1084
to whether they were referred to by the inventory of the
1085
revision_id that they contain. The inventory texts from all present
1086
revision ids are assessed to generate this report.
1089
return self._real_repository.find_text_key_references()
1091
def _generate_text_key_index(self):
1092
"""Generate a new text key index for the repository.
1094
This is an expensive function that will take considerable time to run.
1096
:return: A dict mapping (file_id, revision_id) tuples to a list of
1097
parents, also (file_id, revision_id) tuples.
1100
return self._real_repository._generate_text_key_index()
1102
def _get_revision_graph(self, revision_id):
1103
"""Private method for using with old (< 1.2) servers to fallback."""
1104
if revision_id is None:
1106
elif _mod_revision.is_null(revision_id):
1109
path = self.bzrdir._path_for_remote_call(self._client)
1110
response = self._call_expecting_body(
1111
'Repository.get_revision_graph', path, revision_id)
1112
response_tuple, response_handler = response
1113
if response_tuple[0] != 'ok':
1114
raise errors.UnexpectedSmartServerResponse(response_tuple)
1115
coded = response_handler.read_body_bytes()
1117
# no revisions in this repository!
1119
lines = coded.split('\n')
1122
d = tuple(line.split())
1123
revision_graph[d[0]] = d[1:]
1125
return revision_graph
1127
def _get_sink(self):
1128
"""See Repository._get_sink()."""
1129
return RemoteStreamSink(self)
1131
def _get_source(self, to_format):
1132
"""Return a source for streaming from this repository."""
1133
return RemoteStreamSource(self, to_format)
1136
def get_file_graph(self):
1137
return graph.Graph(self.texts)
1140
def has_revision(self, revision_id):
1141
"""True if this repository has a copy of the revision."""
1142
# Copy of bzrlib.repository.Repository.has_revision
1143
return revision_id in self.has_revisions((revision_id,))
1146
def has_revisions(self, revision_ids):
1147
"""Probe to find out the presence of multiple revisions.
1149
:param revision_ids: An iterable of revision_ids.
1150
:return: A set of the revision_ids that were present.
1152
# Copy of bzrlib.repository.Repository.has_revisions
1153
parent_map = self.get_parent_map(revision_ids)
1154
result = set(parent_map)
1155
if _mod_revision.NULL_REVISION in revision_ids:
1156
result.add(_mod_revision.NULL_REVISION)
1159
def _has_same_fallbacks(self, other_repo):
1160
"""Returns true if the repositories have the same fallbacks."""
1161
# XXX: copied from Repository; it should be unified into a base class
1162
# <https://bugs.launchpad.net/bzr/+bug/401622>
1163
my_fb = self._fallback_repositories
1164
other_fb = other_repo._fallback_repositories
1165
if len(my_fb) != len(other_fb):
1167
for f, g in zip(my_fb, other_fb):
1168
if not f.has_same_location(g):
1172
def has_same_location(self, other):
1173
# TODO: Move to RepositoryBase and unify with the regular Repository
1174
# one; unfortunately the tests rely on slightly different behaviour at
1175
# present -- mbp 20090710
1176
return (self.__class__ is other.__class__ and
1177
self.bzrdir.transport.base == other.bzrdir.transport.base)
1179
def get_graph(self, other_repository=None):
1180
"""Return the graph for this repository format"""
1181
parents_provider = self._make_parents_provider(other_repository)
1182
return graph.Graph(parents_provider)
1185
def get_known_graph_ancestry(self, revision_ids):
1186
"""Return the known graph for a set of revision ids and their ancestors.
1188
st = static_tuple.StaticTuple
1189
revision_keys = [st(r_id).intern() for r_id in revision_ids]
1190
known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
1191
return graph.GraphThunkIdsToKeys(known_graph)
1193
def gather_stats(self, revid=None, committers=None):
1194
"""See Repository.gather_stats()."""
1195
path = self.bzrdir._path_for_remote_call(self._client)
1196
# revid can be None to indicate no revisions, not just NULL_REVISION
1197
if revid is None or _mod_revision.is_null(revid):
1201
if committers is None or not committers:
1202
fmt_committers = 'no'
1204
fmt_committers = 'yes'
1205
response_tuple, response_handler = self._call_expecting_body(
1206
'Repository.gather_stats', path, fmt_revid, fmt_committers)
1207
if response_tuple[0] != 'ok':
1208
raise errors.UnexpectedSmartServerResponse(response_tuple)
1210
body = response_handler.read_body_bytes()
1212
for line in body.split('\n'):
1215
key, val_text = line.split(':')
1216
if key in ('revisions', 'size', 'committers'):
1217
result[key] = int(val_text)
1218
elif key in ('firstrev', 'latestrev'):
1219
values = val_text.split(' ')[1:]
1220
result[key] = (float(values[0]), long(values[1]))
1224
def find_branches(self, using=False):
1225
"""See Repository.find_branches()."""
1226
# should be an API call to the server.
1228
return self._real_repository.find_branches(using=using)
1230
def get_physical_lock_status(self):
1231
"""See Repository.get_physical_lock_status()."""
1232
# should be an API call to the server.
1234
return self._real_repository.get_physical_lock_status()
1236
def is_in_write_group(self):
1237
"""Return True if there is an open write group.
1239
write groups are only applicable locally for the smart server..
1241
if self._real_repository:
1242
return self._real_repository.is_in_write_group()
1244
def is_locked(self):
1245
return self._lock_count >= 1
1247
def is_shared(self):
1248
"""See Repository.is_shared()."""
1249
path = self.bzrdir._path_for_remote_call(self._client)
1250
response = self._call('Repository.is_shared', path)
1251
if response[0] not in ('yes', 'no'):
1252
raise SmartProtocolError('unexpected response code %s' % (response,))
1253
return response[0] == 'yes'
1255
def is_write_locked(self):
1256
return self._lock_mode == 'w'
1258
def _warn_if_deprecated(self, branch=None):
1259
# If we have a real repository, the check will be done there, if we
1260
# don't the check will be done remotely.
1263
def lock_read(self):
1264
"""Lock the repository for read operations.
1266
:return: A bzrlib.lock.LogicalLockResult.
1268
# wrong eventually - want a local lock cache context
1269
if not self._lock_mode:
1270
self._note_lock('r')
1271
self._lock_mode = 'r'
1272
self._lock_count = 1
1273
self._unstacked_provider.enable_cache(cache_misses=True)
1274
if self._real_repository is not None:
1275
self._real_repository.lock_read()
1276
for repo in self._fallback_repositories:
1279
self._lock_count += 1
1280
return lock.LogicalLockResult(self.unlock)
1282
def _remote_lock_write(self, token):
1283
path = self.bzrdir._path_for_remote_call(self._client)
1286
err_context = {'token': token}
1287
response = self._call('Repository.lock_write', path, token,
1289
if response[0] == 'ok':
1290
ok, token = response
1293
raise errors.UnexpectedSmartServerResponse(response)
1295
def lock_write(self, token=None, _skip_rpc=False):
1296
if not self._lock_mode:
1297
self._note_lock('w')
1299
if self._lock_token is not None:
1300
if token != self._lock_token:
1301
raise errors.TokenMismatch(token, self._lock_token)
1302
self._lock_token = token
1304
self._lock_token = self._remote_lock_write(token)
1305
# if self._lock_token is None, then this is something like packs or
1306
# svn where we don't get to lock the repo, or a weave style repository
1307
# where we cannot lock it over the wire and attempts to do so will
1309
if self._real_repository is not None:
1310
self._real_repository.lock_write(token=self._lock_token)
1311
if token is not None:
1312
self._leave_lock = True
1314
self._leave_lock = False
1315
self._lock_mode = 'w'
1316
self._lock_count = 1
1317
cache_misses = self._real_repository is None
1318
self._unstacked_provider.enable_cache(cache_misses=cache_misses)
1319
for repo in self._fallback_repositories:
1320
# Writes don't affect fallback repos
1322
elif self._lock_mode == 'r':
1323
raise errors.ReadOnlyError(self)
1325
self._lock_count += 1
1326
return RepositoryWriteLockResult(self.unlock, self._lock_token or None)
1328
def leave_lock_in_place(self):
1329
if not self._lock_token:
1330
raise NotImplementedError(self.leave_lock_in_place)
1331
self._leave_lock = True
1333
def dont_leave_lock_in_place(self):
1334
if not self._lock_token:
1335
raise NotImplementedError(self.dont_leave_lock_in_place)
1336
self._leave_lock = False
1338
def _set_real_repository(self, repository):
1339
"""Set the _real_repository for this repository.
1341
:param repository: The repository to fallback to for non-hpss
1342
implemented operations.
1344
if self._real_repository is not None:
1345
# Replacing an already set real repository.
1346
# We cannot do this [currently] if the repository is locked -
1347
# synchronised state might be lost.
1348
if self.is_locked():
1349
raise AssertionError('_real_repository is already set')
1350
if isinstance(repository, RemoteRepository):
1351
raise AssertionError()
1352
self._real_repository = repository
1353
# three code paths happen here:
1354
# 1) old servers, RemoteBranch.open() calls _ensure_real before setting
1355
# up stacking. In this case self._fallback_repositories is [], and the
1356
# real repo is already setup. Preserve the real repo and
1357
# RemoteRepository.add_fallback_repository will avoid adding
1359
# 2) new servers, RemoteBranch.open() sets up stacking, and when
1360
# ensure_real is triggered from a branch, the real repository to
1361
# set already has a matching list with separate instances, but
1362
# as they are also RemoteRepositories we don't worry about making the
1363
# lists be identical.
1364
# 3) new servers, RemoteRepository.ensure_real is triggered before
1365
# RemoteBranch.ensure real, in this case we get a repo with no fallbacks
1366
# and need to populate it.
1367
if (self._fallback_repositories and
1368
len(self._real_repository._fallback_repositories) !=
1369
len(self._fallback_repositories)):
1370
if len(self._real_repository._fallback_repositories):
1371
raise AssertionError(
1372
"cannot cleanly remove existing _fallback_repositories")
1373
for fb in self._fallback_repositories:
1374
self._real_repository.add_fallback_repository(fb)
1375
if self._lock_mode == 'w':
1376
# if we are already locked, the real repository must be able to
1377
# acquire the lock with our token.
1378
self._real_repository.lock_write(self._lock_token)
1379
elif self._lock_mode == 'r':
1380
self._real_repository.lock_read()
1382
def start_write_group(self):
1383
"""Start a write group on the decorated repository.
1385
Smart methods perform operations in a single step so this API
1386
is not really applicable except as a compatibility thunk
1387
for older plugins that don't use e.g. the CommitBuilder
1391
return self._real_repository.start_write_group()
1393
def _unlock(self, token):
1394
path = self.bzrdir._path_for_remote_call(self._client)
1396
# with no token the remote repository is not persistently locked.
1398
err_context = {'token': token}
1399
response = self._call('Repository.unlock', path, token,
1401
if response == ('ok',):
1404
raise errors.UnexpectedSmartServerResponse(response)
1406
@only_raises(errors.LockNotHeld, errors.LockBroken)
1408
if not self._lock_count:
1409
return lock.cant_unlock_not_held(self)
1410
self._lock_count -= 1
1411
if self._lock_count > 0:
1413
self._unstacked_provider.disable_cache()
1414
old_mode = self._lock_mode
1415
self._lock_mode = None
1417
# The real repository is responsible at present for raising an
1418
# exception if it's in an unfinished write group. However, it
1419
# normally will *not* actually remove the lock from disk - that's
1420
# done by the server on receiving the Repository.unlock call.
1421
# This is just to let the _real_repository stay up to date.
1422
if self._real_repository is not None:
1423
self._real_repository.unlock()
1425
# The rpc-level lock should be released even if there was a
1426
# problem releasing the vfs-based lock.
1428
# Only write-locked repositories need to make a remote method
1429
# call to perform the unlock.
1430
old_token = self._lock_token
1431
self._lock_token = None
1432
if not self._leave_lock:
1433
self._unlock(old_token)
1434
# Fallbacks are always 'lock_read()' so we don't pay attention to
1436
for repo in self._fallback_repositories:
1439
def break_lock(self):
1440
# should hand off to the network
1442
return self._real_repository.break_lock()
1444
def _get_tarball(self, compression):
1445
"""Return a TemporaryFile containing a repository tarball.
1447
Returns None if the server does not support sending tarballs.
1450
path = self.bzrdir._path_for_remote_call(self._client)
1452
response, protocol = self._call_expecting_body(
1453
'Repository.tarball', path, compression)
1454
except errors.UnknownSmartMethod:
1455
protocol.cancel_read_body()
1457
if response[0] == 'ok':
1458
# Extract the tarball and return it
1459
t = tempfile.NamedTemporaryFile()
1460
# TODO: rpc layer should read directly into it...
1461
t.write(protocol.read_body_bytes())
1464
raise errors.UnexpectedSmartServerResponse(response)
1466
def sprout(self, to_bzrdir, revision_id=None):
1467
# TODO: Option to control what format is created?
1469
dest_repo = self._real_repository._format.initialize(to_bzrdir,
1471
dest_repo.fetch(self, revision_id=revision_id)
1474
### These methods are just thin shims to the VFS object for now.
1476
def revision_tree(self, revision_id):
1478
return self._real_repository.revision_tree(revision_id)
1480
def get_serializer_format(self):
1482
return self._real_repository.get_serializer_format()
1484
def get_commit_builder(self, branch, parents, config, timestamp=None,
1485
timezone=None, committer=None, revprops=None,
1486
revision_id=None, lossy=False):
1487
# FIXME: It ought to be possible to call this without immediately
1488
# triggering _ensure_real. For now it's the easiest thing to do.
1490
real_repo = self._real_repository
1491
builder = real_repo.get_commit_builder(branch, parents,
1492
config, timestamp=timestamp, timezone=timezone,
1493
committer=committer, revprops=revprops,
1494
revision_id=revision_id, lossy=lossy)
1497
def add_fallback_repository(self, repository):
1498
"""Add a repository to use for looking up data not held locally.
1500
:param repository: A repository.
1502
if not self._format.supports_external_lookups:
1503
raise errors.UnstackableRepositoryFormat(
1504
self._format.network_name(), self.base)
1505
# We need to accumulate additional repositories here, to pass them in
1508
# Make the check before we lock: this raises an exception.
1509
self._check_fallback_repository(repository)
1510
if self.is_locked():
1511
# We will call fallback.unlock() when we transition to the unlocked
1512
# state, so always add a lock here. If a caller passes us a locked
1513
# repository, they are responsible for unlocking it later.
1514
repository.lock_read()
1515
self._fallback_repositories.append(repository)
1516
# If self._real_repository was parameterised already (e.g. because a
1517
# _real_branch had its get_stacked_on_url method called), then the
1518
# repository to be added may already be in the _real_repositories list.
1519
if self._real_repository is not None:
1520
fallback_locations = [repo.user_url for repo in
1521
self._real_repository._fallback_repositories]
1522
if repository.user_url not in fallback_locations:
1523
self._real_repository.add_fallback_repository(repository)
1525
def _check_fallback_repository(self, repository):
1526
"""Check that this repository can fallback to repository safely.
1528
Raise an error if not.
1530
:param repository: A repository to fallback to.
1532
return _mod_repository.InterRepository._assert_same_model(
1535
def add_inventory(self, revid, inv, parents):
1537
return self._real_repository.add_inventory(revid, inv, parents)
1539
def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1540
parents, basis_inv=None, propagate_caches=False):
1542
return self._real_repository.add_inventory_by_delta(basis_revision_id,
1543
delta, new_revision_id, parents, basis_inv=basis_inv,
1544
propagate_caches=propagate_caches)
1546
def add_revision(self, rev_id, rev, inv=None, config=None):
1548
return self._real_repository.add_revision(
1549
rev_id, rev, inv=inv, config=config)
1552
def get_inventory(self, revision_id):
1554
return self._real_repository.get_inventory(revision_id)
1556
def iter_inventories(self, revision_ids, ordering=None):
1558
return self._real_repository.iter_inventories(revision_ids, ordering)
1561
def get_revision(self, revision_id):
1563
return self._real_repository.get_revision(revision_id)
1565
def get_transaction(self):
1567
return self._real_repository.get_transaction()
1570
def clone(self, a_bzrdir, revision_id=None):
1572
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
1574
def make_working_trees(self):
1575
"""See Repository.make_working_trees"""
1577
return self._real_repository.make_working_trees()
1579
def refresh_data(self):
1580
"""Re-read any data needed to synchronise with disk.
1582
This method is intended to be called after another repository instance
1583
(such as one used by a smart server) has inserted data into the
1584
repository. On all repositories this will work outside of write groups.
1585
Some repository formats (pack and newer for bzrlib native formats)
1586
support refresh_data inside write groups. If called inside a write
1587
group on a repository that does not support refreshing in a write group
1588
IsInWriteGroupError will be raised.
1590
if self._real_repository is not None:
1591
self._real_repository.refresh_data()
1593
def revision_ids_to_search_result(self, result_set):
1594
"""Convert a set of revision ids to a graph SearchResult."""
1595
result_parents = set()
1596
for parents in self.get_graph().get_parent_map(
1597
result_set).itervalues():
1598
result_parents.update(parents)
1599
included_keys = result_set.intersection(result_parents)
1600
start_keys = result_set.difference(included_keys)
1601
exclude_keys = result_parents.difference(result_set)
1602
result = graph.SearchResult(start_keys, exclude_keys,
1603
len(result_set), result_set)
1607
def search_missing_revision_ids(self, other,
1608
revision_id=symbol_versioning.DEPRECATED_PARAMETER,
1609
find_ghosts=True, revision_ids=None, if_present_ids=None,
1611
"""Return the revision ids that other has that this does not.
1613
These are returned in topological order.
1615
revision_id: only return revision ids included by revision_id.
1617
if symbol_versioning.deprecated_passed(revision_id):
1618
symbol_versioning.warn(
1619
'search_missing_revision_ids(revision_id=...) was '
1620
'deprecated in 2.4. Use revision_ids=[...] instead.',
1621
DeprecationWarning, stacklevel=2)
1622
if revision_ids is not None:
1623
raise AssertionError(
1624
'revision_ids is mutually exclusive with revision_id')
1625
if revision_id is not None:
1626
revision_ids = [revision_id]
1627
inter_repo = _mod_repository.InterRepository.get(other, self)
1628
return inter_repo.search_missing_revision_ids(
1629
find_ghosts=find_ghosts, revision_ids=revision_ids,
1630
if_present_ids=if_present_ids, limit=limit)
1632
def fetch(self, source, revision_id=None, find_ghosts=False,
1634
# No base implementation to use as RemoteRepository is not a subclass
1635
# of Repository; so this is a copy of Repository.fetch().
1636
if fetch_spec is not None and revision_id is not None:
1637
raise AssertionError(
1638
"fetch_spec and revision_id are mutually exclusive.")
1639
if self.is_in_write_group():
1640
raise errors.InternalBzrError(
1641
"May not fetch while in a write group.")
1642
# fast path same-url fetch operations
1643
if (self.has_same_location(source)
1644
and fetch_spec is None
1645
and self._has_same_fallbacks(source)):
1646
# check that last_revision is in 'from' and then return a
1648
if (revision_id is not None and
1649
not _mod_revision.is_null(revision_id)):
1650
self.get_revision(revision_id)
1652
# if there is no specific appropriate InterRepository, this will get
1653
# the InterRepository base class, which raises an
1654
# IncompatibleRepositories when asked to fetch.
1655
inter = _mod_repository.InterRepository.get(source, self)
1656
return inter.fetch(revision_id=revision_id,
1657
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1659
def create_bundle(self, target, base, fileobj, format=None):
1661
self._real_repository.create_bundle(target, base, fileobj, format)
1664
@symbol_versioning.deprecated_method(
1665
symbol_versioning.deprecated_in((2, 4, 0)))
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
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1980
def iter_reverse_revision_history(self, revision_id):
1982
return self._real_repository.iter_reverse_revision_history(revision_id)
1985
def _serializer(self):
1986
return self._format._serializer
1988
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1990
return self._real_repository.store_revision_signature(
1991
gpg_strategy, plaintext, revision_id)
1993
def add_signature_text(self, revision_id, signature):
1995
return self._real_repository.add_signature_text(revision_id, signature)
1997
def has_signature_for_revision_id(self, revision_id):
1999
return self._real_repository.has_signature_for_revision_id(revision_id)
2001
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
2003
return self._real_repository.item_keys_introduced_by(revision_ids,
2004
_files_pb=_files_pb)
2006
def _find_inconsistent_revision_parents(self, revisions_iterator=None):
2008
return self._real_repository._find_inconsistent_revision_parents(
2011
def _check_for_inconsistent_revision_parents(self):
2013
return self._real_repository._check_for_inconsistent_revision_parents()
2015
def _make_parents_provider(self, other=None):
2016
providers = [self._unstacked_provider]
2017
if other is not None:
2018
providers.insert(0, other)
2019
return graph.StackedParentsProvider(_LazyListJoin(
2020
providers, self._fallback_repositories))
2022
def _serialise_search_recipe(self, recipe):
2023
"""Serialise a graph search recipe.
2025
:param recipe: A search recipe (start, stop, count).
2026
:return: Serialised bytes.
2028
start_keys = ' '.join(recipe[1])
2029
stop_keys = ' '.join(recipe[2])
2030
count = str(recipe[3])
2031
return '\n'.join((start_keys, stop_keys, count))
2033
def _serialise_search_result(self, search_result):
2034
parts = search_result.get_network_struct()
2035
return '\n'.join(parts)
2038
path = self.bzrdir._path_for_remote_call(self._client)
2040
response = self._call('PackRepository.autopack', path)
2041
except errors.UnknownSmartMethod:
2043
self._real_repository._pack_collection.autopack()
2046
if response[0] != 'ok':
2047
raise errors.UnexpectedSmartServerResponse(response)
2050
class RemoteStreamSink(vf_repository.StreamSink):
2052
def _insert_real(self, stream, src_format, resume_tokens):
2053
self.target_repo._ensure_real()
2054
sink = self.target_repo._real_repository._get_sink()
2055
result = sink.insert_stream(stream, src_format, resume_tokens)
2057
self.target_repo.autopack()
2060
def insert_stream(self, stream, src_format, resume_tokens):
2061
target = self.target_repo
2062
target._unstacked_provider.missing_keys.clear()
2063
candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
2064
if target._lock_token:
2065
candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
2066
lock_args = (target._lock_token or '',)
2068
candidate_calls.append(('Repository.insert_stream', (1, 13)))
2070
client = target._client
2071
medium = client._medium
2072
path = target.bzrdir._path_for_remote_call(client)
2073
# Probe for the verb to use with an empty stream before sending the
2074
# real stream to it. We do this both to avoid the risk of sending a
2075
# large request that is then rejected, and because we don't want to
2076
# implement a way to buffer, rewind, or restart the stream.
2078
for verb, required_version in candidate_calls:
2079
if medium._is_remote_before(required_version):
2082
# We've already done the probing (and set _is_remote_before) on
2083
# a previous insert.
2086
byte_stream = smart_repo._stream_to_byte_stream([], src_format)
2088
response = client.call_with_body_stream(
2089
(verb, path, '') + lock_args, byte_stream)
2090
except errors.UnknownSmartMethod:
2091
medium._remember_remote_is_before(required_version)
2097
return self._insert_real(stream, src_format, resume_tokens)
2098
self._last_inv_record = None
2099
self._last_substream = None
2100
if required_version < (1, 19):
2101
# Remote side doesn't support inventory deltas. Wrap the stream to
2102
# make sure we don't send any. If the stream contains inventory
2103
# deltas we'll interrupt the smart insert_stream request and
2105
stream = self._stop_stream_if_inventory_delta(stream)
2106
byte_stream = smart_repo._stream_to_byte_stream(
2108
resume_tokens = ' '.join(resume_tokens)
2109
response = client.call_with_body_stream(
2110
(verb, path, resume_tokens) + lock_args, byte_stream)
2111
if response[0][0] not in ('ok', 'missing-basis'):
2112
raise errors.UnexpectedSmartServerResponse(response)
2113
if self._last_substream is not None:
2114
# The stream included an inventory-delta record, but the remote
2115
# side isn't new enough to support them. So we need to send the
2116
# rest of the stream via VFS.
2117
self.target_repo.refresh_data()
2118
return self._resume_stream_with_vfs(response, src_format)
2119
if response[0][0] == 'missing-basis':
2120
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
2121
resume_tokens = tokens
2122
return resume_tokens, set(missing_keys)
2124
self.target_repo.refresh_data()
2127
def _resume_stream_with_vfs(self, response, src_format):
2128
"""Resume sending a stream via VFS, first resending the record and
2129
substream that couldn't be sent via an insert_stream verb.
2131
if response[0][0] == 'missing-basis':
2132
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
2133
# Ignore missing_keys, we haven't finished inserting yet
2136
def resume_substream():
2137
# Yield the substream that was interrupted.
2138
for record in self._last_substream:
2140
self._last_substream = None
2141
def resume_stream():
2142
# Finish sending the interrupted substream
2143
yield ('inventory-deltas', resume_substream())
2144
# Then simply continue sending the rest of the stream.
2145
for substream_kind, substream in self._last_stream:
2146
yield substream_kind, substream
2147
return self._insert_real(resume_stream(), src_format, tokens)
2149
def _stop_stream_if_inventory_delta(self, stream):
2150
"""Normally this just lets the original stream pass-through unchanged.
2152
However if any 'inventory-deltas' substream occurs it will stop
2153
streaming, and store the interrupted substream and stream in
2154
self._last_substream and self._last_stream so that the stream can be
2155
resumed by _resume_stream_with_vfs.
2158
stream_iter = iter(stream)
2159
for substream_kind, substream in stream_iter:
2160
if substream_kind == 'inventory-deltas':
2161
self._last_substream = substream
2162
self._last_stream = stream_iter
2165
yield substream_kind, substream
2168
class RemoteStreamSource(vf_repository.StreamSource):
2169
"""Stream data from a remote server."""
2171
def get_stream(self, search):
2172
if (self.from_repository._fallback_repositories and
2173
self.to_format._fetch_order == 'topological'):
2174
return self._real_stream(self.from_repository, search)
2177
repos = [self.from_repository]
2183
repos.extend(repo._fallback_repositories)
2184
sources.append(repo)
2185
return self.missing_parents_chain(search, sources)
2187
def get_stream_for_missing_keys(self, missing_keys):
2188
self.from_repository._ensure_real()
2189
real_repo = self.from_repository._real_repository
2190
real_source = real_repo._get_source(self.to_format)
2191
return real_source.get_stream_for_missing_keys(missing_keys)
2193
def _real_stream(self, repo, search):
2194
"""Get a stream for search from repo.
2196
This never called RemoteStreamSource.get_stream, and is a heler
2197
for RemoteStreamSource._get_stream to allow getting a stream
2198
reliably whether fallback back because of old servers or trying
2199
to stream from a non-RemoteRepository (which the stacked support
2202
source = repo._get_source(self.to_format)
2203
if isinstance(source, RemoteStreamSource):
2205
source = repo._real_repository._get_source(self.to_format)
2206
return source.get_stream(search)
2208
def _get_stream(self, repo, search):
2209
"""Core worker to get a stream from repo for search.
2211
This is used by both get_stream and the stacking support logic. It
2212
deliberately gets a stream for repo which does not need to be
2213
self.from_repository. In the event that repo is not Remote, or
2214
cannot do a smart stream, a fallback is made to the generic
2215
repository._get_stream() interface, via self._real_stream.
2217
In the event of stacking, streams from _get_stream will not
2218
contain all the data for search - this is normal (see get_stream).
2220
:param repo: A repository.
2221
:param search: A search.
2223
# Fallbacks may be non-smart
2224
if not isinstance(repo, RemoteRepository):
2225
return self._real_stream(repo, search)
2226
client = repo._client
2227
medium = client._medium
2228
path = repo.bzrdir._path_for_remote_call(client)
2229
search_bytes = repo._serialise_search_result(search)
2230
args = (path, self.to_format.network_name())
2232
('Repository.get_stream_1.19', (1, 19)),
2233
('Repository.get_stream', (1, 13))]
2236
for verb, version in candidate_verbs:
2237
if medium._is_remote_before(version):
2240
response = repo._call_with_body_bytes_expecting_body(
2241
verb, args, search_bytes)
2242
except errors.UnknownSmartMethod:
2243
medium._remember_remote_is_before(version)
2244
except errors.UnknownErrorFromSmartServer, e:
2245
if isinstance(search, graph.EverythingResult):
2246
error_verb = e.error_from_smart_server.error_verb
2247
if error_verb == 'BadSearch':
2248
# Pre-2.4 servers don't support this sort of search.
2249
# XXX: perhaps falling back to VFS on BadSearch is a
2250
# good idea in general? It might provide a little bit
2251
# of protection against client-side bugs.
2252
medium._remember_remote_is_before((2, 4))
2256
response_tuple, response_handler = response
2260
return self._real_stream(repo, search)
2261
if response_tuple[0] != 'ok':
2262
raise errors.UnexpectedSmartServerResponse(response_tuple)
2263
byte_stream = response_handler.read_streamed_body()
2264
src_format, stream = smart_repo._byte_stream_to_stream(byte_stream,
2265
self._record_counter)
2266
if src_format.network_name() != repo._format.network_name():
2267
raise AssertionError(
2268
"Mismatched RemoteRepository and stream src %r, %r" % (
2269
src_format.network_name(), repo._format.network_name()))
2272
def missing_parents_chain(self, search, sources):
2273
"""Chain multiple streams together to handle stacking.
2275
:param search: The overall search to satisfy with streams.
2276
:param sources: A list of Repository objects to query.
2278
self.from_serialiser = self.from_repository._format._serializer
2279
self.seen_revs = set()
2280
self.referenced_revs = set()
2281
# If there are heads in the search, or the key count is > 0, we are not
2283
while not search.is_empty() and len(sources) > 1:
2284
source = sources.pop(0)
2285
stream = self._get_stream(source, search)
2286
for kind, substream in stream:
2287
if kind != 'revisions':
2288
yield kind, substream
2290
yield kind, self.missing_parents_rev_handler(substream)
2291
search = search.refine(self.seen_revs, self.referenced_revs)
2292
self.seen_revs = set()
2293
self.referenced_revs = set()
2294
if not search.is_empty():
2295
for kind, stream in self._get_stream(sources[0], search):
2298
def missing_parents_rev_handler(self, substream):
2299
for content in substream:
2300
revision_bytes = content.get_bytes_as('fulltext')
2301
revision = self.from_serialiser.read_revision_from_string(
2303
self.seen_revs.add(content.key[-1])
2304
self.referenced_revs.update(revision.parent_ids)
2308
class RemoteBranchLockableFiles(LockableFiles):
2309
"""A 'LockableFiles' implementation that talks to a smart server.
2311
This is not a public interface class.
2314
def __init__(self, bzrdir, _client):
2315
self.bzrdir = bzrdir
2316
self._client = _client
2317
self._need_find_modes = True
2318
LockableFiles.__init__(
2319
self, bzrdir.get_branch_transport(None),
2320
'lock', lockdir.LockDir)
2322
def _find_modes(self):
2323
# RemoteBranches don't let the client set the mode of control files.
2324
self._dir_mode = None
2325
self._file_mode = None
2328
class RemoteBranchFormat(branch.BranchFormat):
2330
def __init__(self, network_name=None):
2331
super(RemoteBranchFormat, self).__init__()
2332
self._matchingbzrdir = RemoteBzrDirFormat()
2333
self._matchingbzrdir.set_branch_format(self)
2334
self._custom_format = None
2335
self._network_name = network_name
2337
def __eq__(self, other):
2338
return (isinstance(other, RemoteBranchFormat) and
2339
self.__dict__ == other.__dict__)
2341
def _ensure_real(self):
2342
if self._custom_format is None:
2343
self._custom_format = branch.network_format_registry.get(
2346
def get_format_description(self):
2348
return 'Remote: ' + self._custom_format.get_format_description()
2350
def network_name(self):
2351
return self._network_name
2353
def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
2354
return a_bzrdir.open_branch(name=name,
2355
ignore_fallbacks=ignore_fallbacks)
2357
def _vfs_initialize(self, a_bzrdir, name):
2358
# Initialisation when using a local bzrdir object, or a non-vfs init
2359
# method is not available on the server.
2360
# self._custom_format is always set - the start of initialize ensures
2362
if isinstance(a_bzrdir, RemoteBzrDir):
2363
a_bzrdir._ensure_real()
2364
result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2367
# We assume the bzrdir is parameterised; it may not be.
2368
result = self._custom_format.initialize(a_bzrdir, name)
2369
if (isinstance(a_bzrdir, RemoteBzrDir) and
2370
not isinstance(result, RemoteBranch)):
2371
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2375
def initialize(self, a_bzrdir, name=None, repository=None):
2376
# 1) get the network name to use.
2377
if self._custom_format:
2378
network_name = self._custom_format.network_name()
2380
# Select the current bzrlib default and ask for that.
2381
reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
2382
reference_format = reference_bzrdir_format.get_branch_format()
2383
self._custom_format = reference_format
2384
network_name = reference_format.network_name()
2385
# Being asked to create on a non RemoteBzrDir:
2386
if not isinstance(a_bzrdir, RemoteBzrDir):
2387
return self._vfs_initialize(a_bzrdir, name=name)
2388
medium = a_bzrdir._client._medium
2389
if medium._is_remote_before((1, 13)):
2390
return self._vfs_initialize(a_bzrdir, name=name)
2391
# Creating on a remote bzr dir.
2392
# 2) try direct creation via RPC
2393
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2394
if name is not None:
2395
# XXX JRV20100304: Support creating colocated branches
2396
raise errors.NoColocatedBranchSupport(self)
2397
verb = 'BzrDir.create_branch'
2399
response = a_bzrdir._call(verb, path, network_name)
2400
except errors.UnknownSmartMethod:
2401
# Fallback - use vfs methods
2402
medium._remember_remote_is_before((1, 13))
2403
return self._vfs_initialize(a_bzrdir, name=name)
2404
if response[0] != 'ok':
2405
raise errors.UnexpectedSmartServerResponse(response)
2406
# Turn the response into a RemoteRepository object.
2407
format = RemoteBranchFormat(network_name=response[1])
2408
repo_format = response_tuple_to_repo_format(response[3:])
2409
repo_path = response[2]
2410
if repository is not None:
2411
remote_repo_url = urlutils.join(a_bzrdir.user_url, repo_path)
2412
url_diff = urlutils.relative_url(repository.user_url,
2415
raise AssertionError(
2416
'repository.user_url %r does not match URL from server '
2417
'response (%r + %r)'
2418
% (repository.user_url, a_bzrdir.user_url, repo_path))
2419
remote_repo = repository
2422
repo_bzrdir = a_bzrdir
2424
repo_bzrdir = RemoteBzrDir(
2425
a_bzrdir.root_transport.clone(repo_path), a_bzrdir._format,
2427
remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2428
remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2429
format=format, setup_stacking=False, name=name)
2430
# XXX: We know this is a new branch, so it must have revno 0, revid
2431
# NULL_REVISION. Creating the branch locked would make this be unable
2432
# to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2433
remote_branch._last_revision_info_cache = 0, NULL_REVISION
2434
return remote_branch
2436
def make_tags(self, branch):
2438
return self._custom_format.make_tags(branch)
2440
def supports_tags(self):
2441
# Remote branches might support tags, but we won't know until we
2442
# access the real remote branch.
2444
return self._custom_format.supports_tags()
2446
def supports_stacking(self):
2448
return self._custom_format.supports_stacking()
2450
def supports_set_append_revisions_only(self):
2452
return self._custom_format.supports_set_append_revisions_only()
2454
def _use_default_local_heads_to_fetch(self):
2455
# If the branch format is a metadir format *and* its heads_to_fetch
2456
# implementation is not overridden vs the base class, we can use the
2457
# base class logic rather than use the heads_to_fetch RPC. This is
2458
# usually cheaper in terms of net round trips, as the last-revision and
2459
# tags info fetched is cached and would be fetched anyway.
2461
if isinstance(self._custom_format, branch.BranchFormatMetadir):
2462
branch_class = self._custom_format._branch_class()
2463
heads_to_fetch_impl = branch_class.heads_to_fetch.im_func
2464
if heads_to_fetch_impl is branch.Branch.heads_to_fetch.im_func:
2468
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
2469
"""Branch stored on a server accessed by HPSS RPC.
2471
At the moment most operations are mapped down to simple file operations.
2474
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2475
_client=None, format=None, setup_stacking=True, name=None):
2476
"""Create a RemoteBranch instance.
2478
:param real_branch: An optional local implementation of the branch
2479
format, usually accessing the data via the VFS.
2480
:param _client: Private parameter for testing.
2481
:param format: A RemoteBranchFormat object, None to create one
2482
automatically. If supplied it should have a network_name already
2484
:param setup_stacking: If True make an RPC call to determine the
2485
stacked (or not) status of the branch. If False assume the branch
2487
:param name: Colocated branch name
2489
# We intentionally don't call the parent class's __init__, because it
2490
# will try to assign to self.tags, which is a property in this subclass.
2491
# And the parent's __init__ doesn't do much anyway.
2492
self.bzrdir = remote_bzrdir
2493
if _client is not None:
2494
self._client = _client
2496
self._client = remote_bzrdir._client
2497
self.repository = remote_repository
2498
if real_branch is not None:
2499
self._real_branch = real_branch
2500
# Give the remote repository the matching real repo.
2501
real_repo = self._real_branch.repository
2502
if isinstance(real_repo, RemoteRepository):
2503
real_repo._ensure_real()
2504
real_repo = real_repo._real_repository
2505
self.repository._set_real_repository(real_repo)
2506
# Give the branch the remote repository to let fast-pathing happen.
2507
self._real_branch.repository = self.repository
2509
self._real_branch = None
2510
# Fill out expected attributes of branch for bzrlib API users.
2511
self._clear_cached_state()
2512
# TODO: deprecate self.base in favor of user_url
2513
self.base = self.bzrdir.user_url
2515
self._control_files = None
2516
self._lock_mode = None
2517
self._lock_token = None
2518
self._repo_lock_token = None
2519
self._lock_count = 0
2520
self._leave_lock = False
2521
# Setup a format: note that we cannot call _ensure_real until all the
2522
# attributes above are set: This code cannot be moved higher up in this
2525
self._format = RemoteBranchFormat()
2526
if real_branch is not None:
2527
self._format._network_name = \
2528
self._real_branch._format.network_name()
2530
self._format = format
2531
# when we do _ensure_real we may need to pass ignore_fallbacks to the
2532
# branch.open_branch method.
2533
self._real_ignore_fallbacks = not setup_stacking
2534
if not self._format._network_name:
2535
# Did not get from open_branchV2 - old server.
2537
self._format._network_name = \
2538
self._real_branch._format.network_name()
2539
self.tags = self._format.make_tags(self)
2540
# The base class init is not called, so we duplicate this:
2541
hooks = branch.Branch.hooks['open']
2544
self._is_stacked = False
2546
self._setup_stacking()
2548
def _setup_stacking(self):
2549
# configure stacking into the remote repository, by reading it from
2552
fallback_url = self.get_stacked_on_url()
2553
except (errors.NotStacked, errors.UnstackableBranchFormat,
2554
errors.UnstackableRepositoryFormat), e:
2556
self._is_stacked = True
2557
self._activate_fallback_location(fallback_url)
2559
def _get_config(self):
2560
return RemoteBranchConfig(self)
2562
def _get_real_transport(self):
2563
# if we try vfs access, return the real branch's vfs transport
2565
return self._real_branch._transport
2567
_transport = property(_get_real_transport)
2570
return "%s(%s)" % (self.__class__.__name__, self.base)
2574
def _ensure_real(self):
2575
"""Ensure that there is a _real_branch set.
2577
Used before calls to self._real_branch.
2579
if self._real_branch is None:
2580
if not vfs.vfs_enabled():
2581
raise AssertionError('smart server vfs must be enabled '
2582
'to use vfs implementation')
2583
self.bzrdir._ensure_real()
2584
self._real_branch = self.bzrdir._real_bzrdir.open_branch(
2585
ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
2586
if self.repository._real_repository is None:
2587
# Give the remote repository the matching real repo.
2588
real_repo = self._real_branch.repository
2589
if isinstance(real_repo, RemoteRepository):
2590
real_repo._ensure_real()
2591
real_repo = real_repo._real_repository
2592
self.repository._set_real_repository(real_repo)
2593
# Give the real branch the remote repository to let fast-pathing
2595
self._real_branch.repository = self.repository
2596
if self._lock_mode == 'r':
2597
self._real_branch.lock_read()
2598
elif self._lock_mode == 'w':
2599
self._real_branch.lock_write(token=self._lock_token)
2601
def _translate_error(self, err, **context):
2602
self.repository._translate_error(err, branch=self, **context)
2604
def _clear_cached_state(self):
2605
super(RemoteBranch, self)._clear_cached_state()
2606
if self._real_branch is not None:
2607
self._real_branch._clear_cached_state()
2609
def _clear_cached_state_of_remote_branch_only(self):
2610
"""Like _clear_cached_state, but doesn't clear the cache of
2613
This is useful when falling back to calling a method of
2614
self._real_branch that changes state. In that case the underlying
2615
branch changes, so we need to invalidate this RemoteBranch's cache of
2616
it. However, there's no need to invalidate the _real_branch's cache
2617
too, in fact doing so might harm performance.
2619
super(RemoteBranch, self)._clear_cached_state()
2622
def control_files(self):
2623
# Defer actually creating RemoteBranchLockableFiles until its needed,
2624
# because it triggers an _ensure_real that we otherwise might not need.
2625
if self._control_files is None:
2626
self._control_files = RemoteBranchLockableFiles(
2627
self.bzrdir, self._client)
2628
return self._control_files
2630
def _get_checkout_format(self):
2632
return self._real_branch._get_checkout_format()
2634
def get_physical_lock_status(self):
2635
"""See Branch.get_physical_lock_status()."""
2636
# should be an API call to the server, as branches must be lockable.
2638
return self._real_branch.get_physical_lock_status()
2640
def get_stacked_on_url(self):
2641
"""Get the URL this branch is stacked against.
2643
:raises NotStacked: If the branch is not stacked.
2644
:raises UnstackableBranchFormat: If the branch does not support
2646
:raises UnstackableRepositoryFormat: If the repository does not support
2650
# there may not be a repository yet, so we can't use
2651
# self._translate_error, so we can't use self._call either.
2652
response = self._client.call('Branch.get_stacked_on_url',
2653
self._remote_path())
2654
except errors.ErrorFromSmartServer, err:
2655
# there may not be a repository yet, so we can't call through
2656
# its _translate_error
2657
_translate_error(err, branch=self)
2658
except errors.UnknownSmartMethod, err:
2660
return self._real_branch.get_stacked_on_url()
2661
if response[0] != 'ok':
2662
raise errors.UnexpectedSmartServerResponse(response)
2665
def set_stacked_on_url(self, url):
2666
branch.Branch.set_stacked_on_url(self, url)
2668
self._is_stacked = False
2670
self._is_stacked = True
2672
def _vfs_get_tags_bytes(self):
2674
return self._real_branch._get_tags_bytes()
2677
def _get_tags_bytes(self):
2678
if self._tags_bytes is None:
2679
self._tags_bytes = self._get_tags_bytes_via_hpss()
2680
return self._tags_bytes
2682
def _get_tags_bytes_via_hpss(self):
2683
medium = self._client._medium
2684
if medium._is_remote_before((1, 13)):
2685
return self._vfs_get_tags_bytes()
2687
response = self._call('Branch.get_tags_bytes', self._remote_path())
2688
except errors.UnknownSmartMethod:
2689
medium._remember_remote_is_before((1, 13))
2690
return self._vfs_get_tags_bytes()
2693
def _vfs_set_tags_bytes(self, bytes):
2695
return self._real_branch._set_tags_bytes(bytes)
2697
def _set_tags_bytes(self, bytes):
2698
if self.is_locked():
2699
self._tags_bytes = bytes
2700
medium = self._client._medium
2701
if medium._is_remote_before((1, 18)):
2702
self._vfs_set_tags_bytes(bytes)
2706
self._remote_path(), self._lock_token, self._repo_lock_token)
2707
response = self._call_with_body_bytes(
2708
'Branch.set_tags_bytes', args, bytes)
2709
except errors.UnknownSmartMethod:
2710
medium._remember_remote_is_before((1, 18))
2711
self._vfs_set_tags_bytes(bytes)
2713
def lock_read(self):
2714
"""Lock the branch for read operations.
2716
:return: A bzrlib.lock.LogicalLockResult.
2718
self.repository.lock_read()
2719
if not self._lock_mode:
2720
self._note_lock('r')
2721
self._lock_mode = 'r'
2722
self._lock_count = 1
2723
if self._real_branch is not None:
2724
self._real_branch.lock_read()
2726
self._lock_count += 1
2727
return lock.LogicalLockResult(self.unlock)
2729
def _remote_lock_write(self, token):
2731
branch_token = repo_token = ''
2733
branch_token = token
2734
repo_token = self.repository.lock_write().repository_token
2735
self.repository.unlock()
2736
err_context = {'token': token}
2738
response = self._call(
2739
'Branch.lock_write', self._remote_path(), branch_token,
2740
repo_token or '', **err_context)
2741
except errors.LockContention, e:
2742
# The LockContention from the server doesn't have any
2743
# information about the lock_url. We re-raise LockContention
2744
# with valid lock_url.
2745
raise errors.LockContention('(remote lock)',
2746
self.repository.base.split('.bzr/')[0])
2747
if response[0] != 'ok':
2748
raise errors.UnexpectedSmartServerResponse(response)
2749
ok, branch_token, repo_token = response
2750
return branch_token, repo_token
2752
def lock_write(self, token=None):
2753
if not self._lock_mode:
2754
self._note_lock('w')
2755
# Lock the branch and repo in one remote call.
2756
remote_tokens = self._remote_lock_write(token)
2757
self._lock_token, self._repo_lock_token = remote_tokens
2758
if not self._lock_token:
2759
raise SmartProtocolError('Remote server did not return a token!')
2760
# Tell the self.repository object that it is locked.
2761
self.repository.lock_write(
2762
self._repo_lock_token, _skip_rpc=True)
2764
if self._real_branch is not None:
2765
self._real_branch.lock_write(token=self._lock_token)
2766
if token is not None:
2767
self._leave_lock = True
2769
self._leave_lock = False
2770
self._lock_mode = 'w'
2771
self._lock_count = 1
2772
elif self._lock_mode == 'r':
2773
raise errors.ReadOnlyError(self)
2775
if token is not None:
2776
# A token was given to lock_write, and we're relocking, so
2777
# check that the given token actually matches the one we
2779
if token != self._lock_token:
2780
raise errors.TokenMismatch(token, self._lock_token)
2781
self._lock_count += 1
2782
# Re-lock the repository too.
2783
self.repository.lock_write(self._repo_lock_token)
2784
return BranchWriteLockResult(self.unlock, self._lock_token or None)
2786
def _unlock(self, branch_token, repo_token):
2787
err_context = {'token': str((branch_token, repo_token))}
2788
response = self._call(
2789
'Branch.unlock', self._remote_path(), branch_token,
2790
repo_token or '', **err_context)
2791
if response == ('ok',):
2793
raise errors.UnexpectedSmartServerResponse(response)
2795
@only_raises(errors.LockNotHeld, errors.LockBroken)
2798
self._lock_count -= 1
2799
if not self._lock_count:
2800
self._clear_cached_state()
2801
mode = self._lock_mode
2802
self._lock_mode = None
2803
if self._real_branch is not None:
2804
if (not self._leave_lock and mode == 'w' and
2805
self._repo_lock_token):
2806
# If this RemoteBranch will remove the physical lock
2807
# for the repository, make sure the _real_branch
2808
# doesn't do it first. (Because the _real_branch's
2809
# repository is set to be the RemoteRepository.)
2810
self._real_branch.repository.leave_lock_in_place()
2811
self._real_branch.unlock()
2813
# Only write-locked branched need to make a remote method
2814
# call to perform the unlock.
2816
if not self._lock_token:
2817
raise AssertionError('Locked, but no token!')
2818
branch_token = self._lock_token
2819
repo_token = self._repo_lock_token
2820
self._lock_token = None
2821
self._repo_lock_token = None
2822
if not self._leave_lock:
2823
self._unlock(branch_token, repo_token)
2825
self.repository.unlock()
2827
def break_lock(self):
2829
return self._real_branch.break_lock()
2831
def leave_lock_in_place(self):
2832
if not self._lock_token:
2833
raise NotImplementedError(self.leave_lock_in_place)
2834
self._leave_lock = True
2836
def dont_leave_lock_in_place(self):
2837
if not self._lock_token:
2838
raise NotImplementedError(self.dont_leave_lock_in_place)
2839
self._leave_lock = False
2842
def get_rev_id(self, revno, history=None):
2844
return _mod_revision.NULL_REVISION
2845
last_revision_info = self.last_revision_info()
2846
ok, result = self.repository.get_rev_id_for_revno(
2847
revno, last_revision_info)
2850
missing_parent = result[1]
2851
# Either the revision named by the server is missing, or its parent
2852
# is. Call get_parent_map to determine which, so that we report a
2854
parent_map = self.repository.get_parent_map([missing_parent])
2855
if missing_parent in parent_map:
2856
missing_parent = parent_map[missing_parent]
2857
raise errors.RevisionNotPresent(missing_parent, self.repository)
2859
def _read_last_revision_info(self):
2860
response = self._call('Branch.last_revision_info', self._remote_path())
2861
if response[0] != 'ok':
2862
raise SmartProtocolError('unexpected response code %s' % (response,))
2863
revno = int(response[1])
2864
last_revision = response[2]
2865
return (revno, last_revision)
2867
def _gen_revision_history(self):
2868
"""See Branch._gen_revision_history()."""
2869
if self._is_stacked:
2871
return self._real_branch._gen_revision_history()
2872
response_tuple, response_handler = self._call_expecting_body(
2873
'Branch.revision_history', self._remote_path())
2874
if response_tuple[0] != 'ok':
2875
raise errors.UnexpectedSmartServerResponse(response_tuple)
2876
result = response_handler.read_body_bytes().split('\x00')
2881
def _remote_path(self):
2882
return self.bzrdir._path_for_remote_call(self._client)
2884
def _set_last_revision_descendant(self, revision_id, other_branch,
2885
allow_diverged=False, allow_overwrite_descendant=False):
2886
# This performs additional work to meet the hook contract; while its
2887
# undesirable, we have to synthesise the revno to call the hook, and
2888
# not calling the hook is worse as it means changes can't be prevented.
2889
# Having calculated this though, we can't just call into
2890
# set_last_revision_info as a simple call, because there is a set_rh
2891
# hook that some folk may still be using.
2892
old_revno, old_revid = self.last_revision_info()
2893
history = self._lefthand_history(revision_id)
2894
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2895
err_context = {'other_branch': other_branch}
2896
response = self._call('Branch.set_last_revision_ex',
2897
self._remote_path(), self._lock_token, self._repo_lock_token,
2898
revision_id, int(allow_diverged), int(allow_overwrite_descendant),
2900
self._clear_cached_state()
2901
if len(response) != 3 and response[0] != 'ok':
2902
raise errors.UnexpectedSmartServerResponse(response)
2903
new_revno, new_revision_id = response[1:]
2904
self._last_revision_info_cache = new_revno, new_revision_id
2905
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2906
if self._real_branch is not None:
2907
cache = new_revno, new_revision_id
2908
self._real_branch._last_revision_info_cache = cache
2910
def _set_last_revision(self, revision_id):
2911
old_revno, old_revid = self.last_revision_info()
2912
# This performs additional work to meet the hook contract; while its
2913
# undesirable, we have to synthesise the revno to call the hook, and
2914
# not calling the hook is worse as it means changes can't be prevented.
2915
# Having calculated this though, we can't just call into
2916
# set_last_revision_info as a simple call, because there is a set_rh
2917
# hook that some folk may still be using.
2918
history = self._lefthand_history(revision_id)
2919
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2920
self._clear_cached_state()
2921
response = self._call('Branch.set_last_revision',
2922
self._remote_path(), self._lock_token, self._repo_lock_token,
2924
if response != ('ok',):
2925
raise errors.UnexpectedSmartServerResponse(response)
2926
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2928
@symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2930
def set_revision_history(self, rev_history):
2931
"""See Branch.set_revision_history."""
2932
self._set_revision_history(rev_history)
2935
def _set_revision_history(self, rev_history):
2936
# Send just the tip revision of the history; the server will generate
2937
# the full history from that. If the revision doesn't exist in this
2938
# branch, NoSuchRevision will be raised.
2939
if rev_history == []:
2942
rev_id = rev_history[-1]
2943
self._set_last_revision(rev_id)
2944
for hook in branch.Branch.hooks['set_rh']:
2945
hook(self, rev_history)
2946
self._cache_revision_history(rev_history)
2948
def _get_parent_location(self):
2949
medium = self._client._medium
2950
if medium._is_remote_before((1, 13)):
2951
return self._vfs_get_parent_location()
2953
response = self._call('Branch.get_parent', self._remote_path())
2954
except errors.UnknownSmartMethod:
2955
medium._remember_remote_is_before((1, 13))
2956
return self._vfs_get_parent_location()
2957
if len(response) != 1:
2958
raise errors.UnexpectedSmartServerResponse(response)
2959
parent_location = response[0]
2960
if parent_location == '':
2962
return parent_location
2964
def _vfs_get_parent_location(self):
2966
return self._real_branch._get_parent_location()
2968
def _set_parent_location(self, url):
2969
medium = self._client._medium
2970
if medium._is_remote_before((1, 15)):
2971
return self._vfs_set_parent_location(url)
2973
call_url = url or ''
2974
if type(call_url) is not str:
2975
raise AssertionError('url must be a str or None (%s)' % url)
2976
response = self._call('Branch.set_parent_location',
2977
self._remote_path(), self._lock_token, self._repo_lock_token,
2979
except errors.UnknownSmartMethod:
2980
medium._remember_remote_is_before((1, 15))
2981
return self._vfs_set_parent_location(url)
2983
raise errors.UnexpectedSmartServerResponse(response)
2985
def _vfs_set_parent_location(self, url):
2987
return self._real_branch._set_parent_location(url)
2990
def pull(self, source, overwrite=False, stop_revision=None,
2992
self._clear_cached_state_of_remote_branch_only()
2994
return self._real_branch.pull(
2995
source, overwrite=overwrite, stop_revision=stop_revision,
2996
_override_hook_target=self, **kwargs)
2999
def push(self, target, overwrite=False, stop_revision=None, lossy=False):
3001
return self._real_branch.push(
3002
target, overwrite=overwrite, stop_revision=stop_revision, lossy=lossy,
3003
_override_hook_source_branch=self)
3005
def is_locked(self):
3006
return self._lock_count >= 1
3009
def revision_id_to_revno(self, revision_id):
3011
return self._real_branch.revision_id_to_revno(revision_id)
3014
def set_last_revision_info(self, revno, revision_id):
3015
# XXX: These should be returned by the set_last_revision_info verb
3016
old_revno, old_revid = self.last_revision_info()
3017
self._run_pre_change_branch_tip_hooks(revno, revision_id)
3018
if not revision_id or not isinstance(revision_id, basestring):
3019
raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
3021
response = self._call('Branch.set_last_revision_info',
3022
self._remote_path(), self._lock_token, self._repo_lock_token,
3023
str(revno), revision_id)
3024
except errors.UnknownSmartMethod:
3026
self._clear_cached_state_of_remote_branch_only()
3027
self._real_branch.set_last_revision_info(revno, revision_id)
3028
self._last_revision_info_cache = revno, revision_id
3030
if response == ('ok',):
3031
self._clear_cached_state()
3032
self._last_revision_info_cache = revno, revision_id
3033
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
3034
# Update the _real_branch's cache too.
3035
if self._real_branch is not None:
3036
cache = self._last_revision_info_cache
3037
self._real_branch._last_revision_info_cache = cache
3039
raise errors.UnexpectedSmartServerResponse(response)
3042
def generate_revision_history(self, revision_id, last_rev=None,
3044
medium = self._client._medium
3045
if not medium._is_remote_before((1, 6)):
3046
# Use a smart method for 1.6 and above servers
3048
self._set_last_revision_descendant(revision_id, other_branch,
3049
allow_diverged=True, allow_overwrite_descendant=True)
3051
except errors.UnknownSmartMethod:
3052
medium._remember_remote_is_before((1, 6))
3053
self._clear_cached_state_of_remote_branch_only()
3054
self._set_revision_history(self._lefthand_history(revision_id,
3055
last_rev=last_rev,other_branch=other_branch))
3057
def set_push_location(self, location):
3059
return self._real_branch.set_push_location(location)
3061
def heads_to_fetch(self):
3062
if self._format._use_default_local_heads_to_fetch():
3063
# We recognise this format, and its heads-to-fetch implementation
3064
# is the default one (tip + tags). In this case it's cheaper to
3065
# just use the default implementation rather than a special RPC as
3066
# the tip and tags data is cached.
3067
return branch.Branch.heads_to_fetch(self)
3068
medium = self._client._medium
3069
if medium._is_remote_before((2, 4)):
3070
return self._vfs_heads_to_fetch()
3072
return self._rpc_heads_to_fetch()
3073
except errors.UnknownSmartMethod:
3074
medium._remember_remote_is_before((2, 4))
3075
return self._vfs_heads_to_fetch()
3077
def _rpc_heads_to_fetch(self):
3078
response = self._call('Branch.heads_to_fetch', self._remote_path())
3079
if len(response) != 2:
3080
raise errors.UnexpectedSmartServerResponse(response)
3081
must_fetch, if_present_fetch = response
3082
return set(must_fetch), set(if_present_fetch)
3084
def _vfs_heads_to_fetch(self):
3086
return self._real_branch.heads_to_fetch()
3089
class RemoteConfig(object):
3090
"""A Config that reads and writes from smart verbs.
3092
It is a low-level object that considers config data to be name/value pairs
3093
that may be associated with a section. Assigning meaning to the these
3094
values is done at higher levels like bzrlib.config.TreeConfig.
3097
def get_option(self, name, section=None, default=None):
3098
"""Return the value associated with a named option.
3100
:param name: The name of the value
3101
:param section: The section the option is in (if any)
3102
:param default: The value to return if the value is not set
3103
:return: The value or default value
3106
configobj = self._get_configobj()
3109
section_obj = configobj
3112
section_obj = configobj[section]
3115
if section_obj is None:
3118
value = section_obj.get(name, default)
3119
except errors.UnknownSmartMethod:
3120
value = self._vfs_get_option(name, section, default)
3121
for hook in config.OldConfigHooks['get']:
3122
hook(self, name, value)
3125
def _response_to_configobj(self, response):
3126
if len(response[0]) and response[0][0] != 'ok':
3127
raise errors.UnexpectedSmartServerResponse(response)
3128
lines = response[1].read_body_bytes().splitlines()
3129
conf = config.ConfigObj(lines, encoding='utf-8')
3130
for hook in config.OldConfigHooks['load']:
3135
class RemoteBranchConfig(RemoteConfig):
3136
"""A RemoteConfig for Branches."""
3138
def __init__(self, branch):
3139
self._branch = branch
3141
def _get_configobj(self):
3142
path = self._branch._remote_path()
3143
response = self._branch._client.call_expecting_body(
3144
'Branch.get_config_file', path)
3145
return self._response_to_configobj(response)
3147
def set_option(self, value, name, section=None):
3148
"""Set the value associated with a named option.
3150
:param value: The value to set
3151
:param name: The name of the value to set
3152
:param section: The section the option is in (if any)
3154
medium = self._branch._client._medium
3155
if medium._is_remote_before((1, 14)):
3156
return self._vfs_set_option(value, name, section)
3157
if isinstance(value, dict):
3158
if medium._is_remote_before((2, 2)):
3159
return self._vfs_set_option(value, name, section)
3160
return self._set_config_option_dict(value, name, section)
3162
return self._set_config_option(value, name, section)
3164
def _set_config_option(self, value, name, section):
3166
path = self._branch._remote_path()
3167
response = self._branch._client.call('Branch.set_config_option',
3168
path, self._branch._lock_token, self._branch._repo_lock_token,
3169
value.encode('utf8'), name, section or '')
3170
except errors.UnknownSmartMethod:
3171
medium = self._branch._client._medium
3172
medium._remember_remote_is_before((1, 14))
3173
return self._vfs_set_option(value, name, section)
3175
raise errors.UnexpectedSmartServerResponse(response)
3177
def _serialize_option_dict(self, option_dict):
3179
for key, value in option_dict.items():
3180
if isinstance(key, unicode):
3181
key = key.encode('utf8')
3182
if isinstance(value, unicode):
3183
value = value.encode('utf8')
3184
utf8_dict[key] = value
3185
return bencode.bencode(utf8_dict)
3187
def _set_config_option_dict(self, value, name, section):
3189
path = self._branch._remote_path()
3190
serialised_dict = self._serialize_option_dict(value)
3191
response = self._branch._client.call(
3192
'Branch.set_config_option_dict',
3193
path, self._branch._lock_token, self._branch._repo_lock_token,
3194
serialised_dict, name, section or '')
3195
except errors.UnknownSmartMethod:
3196
medium = self._branch._client._medium
3197
medium._remember_remote_is_before((2, 2))
3198
return self._vfs_set_option(value, name, section)
3200
raise errors.UnexpectedSmartServerResponse(response)
3202
def _real_object(self):
3203
self._branch._ensure_real()
3204
return self._branch._real_branch
3206
def _vfs_set_option(self, value, name, section=None):
3207
return self._real_object()._get_config().set_option(
3208
value, name, section)
3211
class RemoteBzrDirConfig(RemoteConfig):
3212
"""A RemoteConfig for BzrDirs."""
3214
def __init__(self, bzrdir):
3215
self._bzrdir = bzrdir
3217
def _get_configobj(self):
3218
medium = self._bzrdir._client._medium
3219
verb = 'BzrDir.get_config_file'
3220
if medium._is_remote_before((1, 15)):
3221
raise errors.UnknownSmartMethod(verb)
3222
path = self._bzrdir._path_for_remote_call(self._bzrdir._client)
3223
response = self._bzrdir._call_expecting_body(
3225
return self._response_to_configobj(response)
3227
def _vfs_get_option(self, name, section, default):
3228
return self._real_object()._get_config().get_option(
3229
name, section, default)
3231
def set_option(self, value, name, section=None):
3232
"""Set the value associated with a named option.
3234
:param value: The value to set
3235
:param name: The name of the value to set
3236
:param section: The section the option is in (if any)
3238
return self._real_object()._get_config().set_option(
3239
value, name, section)
3241
def _real_object(self):
3242
self._bzrdir._ensure_real()
3243
return self._bzrdir._real_bzrdir
3247
def _extract_tar(tar, to_dir):
3248
"""Extract all the contents of a tarfile object.
3250
A replacement for extractall, which is not present in python2.4
3253
tar.extract(tarinfo, to_dir)
3256
def _translate_error(err, **context):
3257
"""Translate an ErrorFromSmartServer into a more useful error.
3259
Possible context keys:
3267
If the error from the server doesn't match a known pattern, then
3268
UnknownErrorFromSmartServer is raised.
3272
return context[name]
3273
except KeyError, key_err:
3274
mutter('Missing key %r in context %r', key_err.args[0], context)
3277
"""Get the path from the context if present, otherwise use first error
3281
return context['path']
3282
except KeyError, key_err:
3284
return err.error_args[0]
3285
except IndexError, idx_err:
3287
'Missing key %r in context %r', key_err.args[0], context)
3290
if err.error_verb == 'NoSuchRevision':
3291
raise NoSuchRevision(find('branch'), err.error_args[0])
3292
elif err.error_verb == 'nosuchrevision':
3293
raise NoSuchRevision(find('repository'), err.error_args[0])
3294
elif err.error_verb == 'nobranch':
3295
if len(err.error_args) >= 1:
3296
extra = err.error_args[0]
3299
raise errors.NotBranchError(path=find('bzrdir').root_transport.base,
3301
elif err.error_verb == 'norepository':
3302
raise errors.NoRepositoryPresent(find('bzrdir'))
3303
elif err.error_verb == 'UnlockableTransport':
3304
raise errors.UnlockableTransport(find('bzrdir').root_transport)
3305
elif err.error_verb == 'TokenMismatch':
3306
raise errors.TokenMismatch(find('token'), '(remote token)')
3307
elif err.error_verb == 'Diverged':
3308
raise errors.DivergedBranches(find('branch'), find('other_branch'))
3309
elif err.error_verb == 'NotStacked':
3310
raise errors.NotStacked(branch=find('branch'))
3311
elif err.error_verb == 'PermissionDenied':
3313
if len(err.error_args) >= 2:
3314
extra = err.error_args[1]
3317
raise errors.PermissionDenied(path, extra=extra)
3318
elif err.error_verb == 'ReadError':
3320
raise errors.ReadError(path)
3321
elif err.error_verb == 'NoSuchFile':
3323
raise errors.NoSuchFile(path)
3324
_translate_error_without_context(err)
3327
def _translate_error_without_context(err):
3328
"""Translate any ErrorFromSmartServer values that don't require context"""
3329
if err.error_verb == 'IncompatibleRepositories':
3330
raise errors.IncompatibleRepositories(err.error_args[0],
3331
err.error_args[1], err.error_args[2])
3332
elif err.error_verb == 'LockContention':
3333
raise errors.LockContention('(remote lock)')
3334
elif err.error_verb == 'LockFailed':
3335
raise errors.LockFailed(err.error_args[0], err.error_args[1])
3336
elif err.error_verb == 'TipChangeRejected':
3337
raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
3338
elif err.error_verb == 'UnstackableBranchFormat':
3339
raise errors.UnstackableBranchFormat(*err.error_args)
3340
elif err.error_verb == 'UnstackableRepositoryFormat':
3341
raise errors.UnstackableRepositoryFormat(*err.error_args)
3342
elif err.error_verb == 'FileExists':
3343
raise errors.FileExists(err.error_args[0])
3344
elif err.error_verb == 'DirectoryNotEmpty':
3345
raise errors.DirectoryNotEmpty(err.error_args[0])
3346
elif err.error_verb == 'ShortReadvError':
3347
args = err.error_args
3348
raise errors.ShortReadvError(
3349
args[0], int(args[1]), int(args[2]), int(args[3]))
3350
elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
3351
encoding = str(err.error_args[0]) # encoding must always be a string
3352
val = err.error_args[1]
3353
start = int(err.error_args[2])
3354
end = int(err.error_args[3])
3355
reason = str(err.error_args[4]) # reason must always be a string
3356
if val.startswith('u:'):
3357
val = val[2:].decode('utf-8')
3358
elif val.startswith('s:'):
3359
val = val[2:].decode('base64')
3360
if err.error_verb == 'UnicodeDecodeError':
3361
raise UnicodeDecodeError(encoding, val, start, end, reason)
3362
elif err.error_verb == 'UnicodeEncodeError':
3363
raise UnicodeEncodeError(encoding, val, start, end, reason)
3364
elif err.error_verb == 'ReadOnlyError':
3365
raise errors.TransportNotPossible('readonly transport')
3366
elif err.error_verb == 'MemoryError':
3367
raise errors.BzrError("remote server out of memory\n"
3368
"Retry non-remotely, or contact the server admin for details.")
3369
raise errors.UnknownErrorFromSmartServer(err)
added
removed
bzrlib/remote.py
