13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
# TODO: At some point, handle upgrades by just passing the whole request
18
# across to run on the server.
21
from cStringIO import StringIO
19
23
from bzrlib import (
30
repository as _mod_repository,
32
revision as _mod_revision,
36
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
33
from bzrlib.branch import BranchReferenceFormat
37
34
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
38
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
39
from bzrlib.errors import (
35
from bzrlib.config import BranchConfig, TreeConfig
36
from bzrlib.decorators import needs_read_lock, needs_write_lock
37
from bzrlib.errors import NoSuchRevision
38
from bzrlib.lockable_files import LockableFiles
39
from bzrlib.pack import ContainerPushParser
40
from bzrlib.smart import client, vfs
41
from bzrlib.symbol_versioning import (
43
from bzrlib.lockable_files import LockableFiles
44
from bzrlib.smart import client, vfs, repository as smart_repo
45
from bzrlib.revision import ensure_null, NULL_REVISION
46
from bzrlib.repository import RepositoryWriteLockResult
45
from bzrlib.revision import NULL_REVISION
47
46
from bzrlib.trace import mutter, note, warning
50
class _RpcHelper(object):
51
"""Mixin class that helps with issuing RPCs."""
53
def _call(self, method, *args, **err_context):
55
return self._client.call(method, *args)
56
except errors.ErrorFromSmartServer, err:
57
self._translate_error(err, **err_context)
59
def _call_expecting_body(self, method, *args, **err_context):
61
return self._client.call_expecting_body(method, *args)
62
except errors.ErrorFromSmartServer, err:
63
self._translate_error(err, **err_context)
65
def _call_with_body_bytes(self, method, args, body_bytes, **err_context):
67
return self._client.call_with_body_bytes(method, args, body_bytes)
68
except errors.ErrorFromSmartServer, err:
69
self._translate_error(err, **err_context)
71
def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
74
return self._client.call_with_body_bytes_expecting_body(
75
method, args, body_bytes)
76
except errors.ErrorFromSmartServer, err:
77
self._translate_error(err, **err_context)
80
def response_tuple_to_repo_format(response):
81
"""Convert a response tuple describing a repository format to a format."""
82
format = RemoteRepositoryFormat()
83
format._rich_root_data = (response[0] == 'yes')
84
format._supports_tree_reference = (response[1] == 'yes')
85
format._supports_external_lookups = (response[2] == 'yes')
86
format._network_name = response[3]
90
48
# Note: RemoteBzrDirFormat is in bzrdir.py
92
class RemoteBzrDir(BzrDir, _RpcHelper):
50
class RemoteBzrDir(BzrDir):
93
51
"""Control directory on a remote server, accessed via bzr:// or similar."""
95
def __init__(self, transport, format, _client=None, _force_probe=False):
53
def __init__(self, transport, _client=None):
96
54
"""Construct a RemoteBzrDir.
98
56
:param _client: Private parameter for testing. Disables probing and the
99
57
use of a real bzrdir.
101
BzrDir.__init__(self, transport, format)
59
BzrDir.__init__(self, transport, RemoteBzrDirFormat())
102
60
# this object holds a delegated bzrdir that uses file-level operations
103
61
# to talk to the other side
104
62
self._real_bzrdir = None
105
self._has_working_tree = None
106
# 1-shot cache for the call pattern 'create_branch; open_branch' - see
107
# create_branch for details.
108
self._next_open_branch_result = None
110
64
if _client is None:
111
65
medium = transport.get_smart_medium()
112
self._client = client._SmartClient(medium)
66
self._client = client._SmartClient(medium, transport.base)
114
68
self._client = _client
121
return '%s(%r)' % (self.__class__.__name__, self._client)
123
def _probe_bzrdir(self):
124
medium = self._client._medium
125
71
path = self._path_for_remote_call(self._client)
126
if medium._is_remote_before((2, 1)):
130
self._rpc_open_2_1(path)
132
except errors.UnknownSmartMethod:
133
medium._remember_remote_is_before((2, 1))
136
def _rpc_open_2_1(self, path):
137
response = self._call('BzrDir.open_2.1', path)
138
if response == ('no',):
139
raise errors.NotBranchError(path=self.root_transport.base)
140
elif response[0] == 'yes':
141
if response[1] == 'yes':
142
self._has_working_tree = True
143
elif response[1] == 'no':
144
self._has_working_tree = False
146
raise errors.UnexpectedSmartServerResponse(response)
148
raise errors.UnexpectedSmartServerResponse(response)
150
def _rpc_open(self, path):
151
response = self._call('BzrDir.open', path)
72
response = self._client.call('BzrDir.open', path)
152
73
if response not in [('yes',), ('no',)]:
153
74
raise errors.UnexpectedSmartServerResponse(response)
154
75
if response == ('no',):
155
raise errors.NotBranchError(path=self.root_transport.base)
76
raise errors.NotBranchError(path=transport.base)
157
78
def _ensure_real(self):
158
79
"""Ensure that there is a _real_bzrdir set.
160
81
Used before calls to self._real_bzrdir.
162
83
if not self._real_bzrdir:
163
if 'hpssvfs' in debug.debug_flags:
165
warning('VFS BzrDir access triggered\n%s',
166
''.join(traceback.format_stack()))
167
84
self._real_bzrdir = BzrDir.open_from_transport(
168
85
self.root_transport, _server_formats=False)
169
self._format._network_name = \
170
self._real_bzrdir._format.network_name()
172
def _translate_error(self, err, **context):
173
_translate_error(err, bzrdir=self, **context)
175
def break_lock(self):
176
# Prevent aliasing problems in the next_open_branch_result cache.
177
# See create_branch for rationale.
178
self._next_open_branch_result = None
179
return BzrDir.break_lock(self)
181
def _vfs_cloning_metadir(self, require_stacking=False):
183
return self._real_bzrdir.cloning_metadir(
184
require_stacking=require_stacking)
186
def cloning_metadir(self, require_stacking=False):
187
medium = self._client._medium
188
if medium._is_remote_before((1, 13)):
189
return self._vfs_cloning_metadir(require_stacking=require_stacking)
190
verb = 'BzrDir.cloning_metadir'
195
path = self._path_for_remote_call(self._client)
197
response = self._call(verb, path, stacking)
198
except errors.UnknownSmartMethod:
199
medium._remember_remote_is_before((1, 13))
200
return self._vfs_cloning_metadir(require_stacking=require_stacking)
201
except errors.UnknownErrorFromSmartServer, err:
202
if err.error_tuple != ('BranchReference',):
204
# We need to resolve the branch reference to determine the
205
# cloning_metadir. This causes unnecessary RPCs to open the
206
# referenced branch (and bzrdir, etc) but only when the caller
207
# didn't already resolve the branch reference.
208
referenced_branch = self.open_branch()
209
return referenced_branch.bzrdir.cloning_metadir()
210
if len(response) != 3:
211
raise errors.UnexpectedSmartServerResponse(response)
212
control_name, repo_name, branch_info = response
213
if len(branch_info) != 2:
214
raise errors.UnexpectedSmartServerResponse(response)
215
branch_ref, branch_name = branch_info
216
format = bzrdir.network_format_registry.get(control_name)
218
format.repository_format = repository.network_format_registry.get(
220
if branch_ref == 'ref':
221
# XXX: we need possible_transports here to avoid reopening the
222
# connection to the referenced location
223
ref_bzrdir = BzrDir.open(branch_name)
224
branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
225
format.set_branch_format(branch_format)
226
elif branch_ref == 'branch':
228
format.set_branch_format(
229
branch.network_format_registry.get(branch_name))
231
raise errors.UnexpectedSmartServerResponse(response)
234
87
def create_repository(self, shared=False):
235
# as per meta1 formats - just delegate to the format object which may
237
result = self._format.repository_format.initialize(self, shared)
238
if not isinstance(result, RemoteRepository):
239
return self.open_repository()
89
self._real_bzrdir.create_repository(shared=shared)
90
return self.open_repository()
243
92
def destroy_repository(self):
244
93
"""See BzrDir.destroy_repository"""
245
94
self._ensure_real()
246
95
self._real_bzrdir.destroy_repository()
248
def create_branch(self, name=None):
249
# as per meta1 formats - just delegate to the format object which may
251
real_branch = self._format.get_branch_format().initialize(self,
253
if not isinstance(real_branch, RemoteBranch):
254
result = RemoteBranch(self, self.find_repository(), real_branch,
258
# BzrDir.clone_on_transport() uses the result of create_branch but does
259
# not return it to its callers; we save approximately 8% of our round
260
# trips by handing the branch we created back to the first caller to
261
# open_branch rather than probing anew. Long term we need a API in
262
# bzrdir that doesn't discard result objects (like result_branch).
264
self._next_open_branch_result = result
97
def create_branch(self):
99
real_branch = self._real_bzrdir.create_branch()
100
return RemoteBranch(self, self.find_repository(), real_branch)
267
def destroy_branch(self, name=None):
102
def destroy_branch(self):
268
103
"""See BzrDir.destroy_branch"""
269
104
self._ensure_real()
270
self._real_bzrdir.destroy_branch(name=name)
271
self._next_open_branch_result = None
105
self._real_bzrdir.destroy_branch()
273
107
def create_workingtree(self, revision_id=None, from_branch=None):
274
108
raise errors.NotLocalUrl(self.transport.base)
276
def find_branch_format(self, name=None):
110
def find_branch_format(self):
277
111
"""Find the branch 'format' for this bzrdir.
279
113
This might be a synthetic object for e.g. RemoteBranch and SVN.
281
b = self.open_branch(name=name)
115
b = self.open_branch()
284
def get_branch_reference(self, name=None):
118
def get_branch_reference(self):
285
119
"""See BzrDir.get_branch_reference()."""
287
# XXX JRV20100304: Support opening colocated branches
288
raise errors.NoColocatedBranchSupport(self)
289
response = self._get_branch_reference()
290
if response[0] == 'ref':
120
path = self._path_for_remote_call(self._client)
121
response = self._client.call('BzrDir.open_branch', path)
122
if response[0] == 'ok':
123
if response[1] == '':
124
# branch at this location.
127
# a branch reference, use the existing BranchReference logic.
129
elif response == ('nobranch',):
130
raise errors.NotBranchError(path=self.root_transport.base)
295
def _get_branch_reference(self):
296
path = self._path_for_remote_call(self._client)
297
medium = self._client._medium
299
('BzrDir.open_branchV3', (2, 1)),
300
('BzrDir.open_branchV2', (1, 13)),
301
('BzrDir.open_branch', None),
303
for verb, required_version in candidate_calls:
304
if required_version and medium._is_remote_before(required_version):
307
response = self._call(verb, path)
308
except errors.UnknownSmartMethod:
309
if required_version is None:
311
medium._remember_remote_is_before(required_version)
314
if verb == 'BzrDir.open_branch':
315
if response[0] != 'ok':
316
raise errors.UnexpectedSmartServerResponse(response)
317
if response[1] != '':
318
return ('ref', response[1])
320
return ('branch', '')
321
if response[0] not in ('ref', 'branch'):
322
132
raise errors.UnexpectedSmartServerResponse(response)
325
def _get_tree_branch(self, name=None):
134
def _get_tree_branch(self):
326
135
"""See BzrDir._get_tree_branch()."""
327
return None, self.open_branch(name=name)
136
return None, self.open_branch()
329
def open_branch(self, name=None, unsupported=False,
330
ignore_fallbacks=False):
332
raise NotImplementedError('unsupported flag support not implemented yet.')
333
if self._next_open_branch_result is not None:
334
# See create_branch for details.
335
result = self._next_open_branch_result
336
self._next_open_branch_result = None
338
response = self._get_branch_reference()
339
if response[0] == 'ref':
138
def open_branch(self, _unsupported=False):
139
assert _unsupported == False, 'unsupported flag support not implemented yet.'
140
reference_url = self.get_branch_reference()
141
if reference_url is None:
142
# branch at this location.
143
return RemoteBranch(self, self.find_repository())
340
145
# a branch reference, use the existing BranchReference logic.
341
146
format = BranchReferenceFormat()
342
return format.open(self, name=name, _found=True,
343
location=response[1], ignore_fallbacks=ignore_fallbacks)
344
branch_format_name = response[1]
345
if not branch_format_name:
346
branch_format_name = None
347
format = RemoteBranchFormat(network_name=branch_format_name)
348
return RemoteBranch(self, self.find_repository(), format=format,
349
setup_stacking=not ignore_fallbacks, name=name)
351
def _open_repo_v1(self, path):
352
verb = 'BzrDir.find_repository'
353
response = self._call(verb, path)
354
if response[0] != 'ok':
355
raise errors.UnexpectedSmartServerResponse(response)
356
# servers that only support the v1 method don't support external
359
repo = self._real_bzrdir.open_repository()
360
response = response + ('no', repo._format.network_name())
361
return response, repo
363
def _open_repo_v2(self, path):
147
return format.open(self, _found=True, location=reference_url)
149
def open_repository(self):
150
path = self._path_for_remote_call(self._client)
364
151
verb = 'BzrDir.find_repositoryV2'
365
response = self._call(verb, path)
366
if response[0] != 'ok':
367
raise errors.UnexpectedSmartServerResponse(response)
369
repo = self._real_bzrdir.open_repository()
370
response = response + (repo._format.network_name(),)
371
return response, repo
373
def _open_repo_v3(self, path):
374
verb = 'BzrDir.find_repositoryV3'
375
medium = self._client._medium
376
if medium._is_remote_before((1, 13)):
377
raise errors.UnknownSmartMethod(verb)
379
response = self._call(verb, path)
380
except errors.UnknownSmartMethod:
381
medium._remember_remote_is_before((1, 13))
383
if response[0] != 'ok':
384
raise errors.UnexpectedSmartServerResponse(response)
385
return response, None
387
def open_repository(self):
388
path = self._path_for_remote_call(self._client)
390
for probe in [self._open_repo_v3, self._open_repo_v2,
393
response, real_repo = probe(path)
395
except errors.UnknownSmartMethod:
398
raise errors.UnknownSmartMethod('BzrDir.find_repository{3,2,}')
399
if response[0] != 'ok':
400
raise errors.UnexpectedSmartServerResponse(response)
401
if len(response) != 6:
402
raise SmartProtocolError('incorrect response length %s' % (response,))
152
response = self._client.call(verb, path)
153
if (response == ('error', "Generic bzr smart protocol error: "
154
"bad request '%s'" % verb) or
155
response == ('error', "Generic bzr smart protocol error: "
156
"bad request u'%s'" % verb)):
157
verb = 'BzrDir.find_repository'
158
response = self._client.call(verb, path)
159
assert response[0] in ('ok', 'norepository'), \
160
'unexpected response code %s' % (response,)
161
if response[0] == 'norepository':
162
raise errors.NoRepositoryPresent(self)
163
if verb == 'BzrDir.find_repository':
164
# servers that don't support the V2 method don't support external
166
response = response + ('no', )
167
assert len(response) == 5, 'incorrect response length %s' % (response,)
403
168
if response[1] == '':
404
# repo is at this dir.
405
format = response_tuple_to_repo_format(response[2:])
406
# Used to support creating a real format instance when needed.
407
format._creating_bzrdir = self
408
remote_repo = RemoteRepository(self, format)
409
format._creating_repo = remote_repo
410
if real_repo is not None:
411
remote_repo._set_real_repository(real_repo)
169
format = RemoteRepositoryFormat()
170
format.rich_root_data = (response[2] == 'yes')
171
format.supports_tree_reference = (response[3] == 'yes')
172
# No wire format to check this yet.
173
format.supports_external_lookups = (response[4] == 'yes')
174
return RemoteRepository(self, format)
414
176
raise errors.NoRepositoryPresent(self)
416
def has_workingtree(self):
417
if self._has_working_tree is None:
419
self._has_working_tree = self._real_bzrdir.has_workingtree()
420
return self._has_working_tree
422
178
def open_workingtree(self, recommend_upgrade=True):
423
if self.has_workingtree():
180
if self._real_bzrdir.has_workingtree():
424
181
raise errors.NotLocalUrl(self.root_transport)
426
183
raise errors.NoWorkingTree(self.root_transport.base)
473
223
the attributes rich_root_data and supports_tree_reference are set
474
224
on a per instance basis, and are not set (and should not be) at
477
:ivar _custom_format: If set, a specific concrete repository format that
478
will be used when initializing a repository with this
479
RemoteRepositoryFormat.
480
:ivar _creating_repo: If set, the repository object that this
481
RemoteRepositoryFormat was created for: it can be called into
482
to obtain data like the network name.
485
_matchingbzrdir = RemoteBzrDirFormat()
488
repository.RepositoryFormat.__init__(self)
489
self._custom_format = None
490
self._network_name = None
491
self._creating_bzrdir = None
492
self._supports_chks = None
493
self._supports_external_lookups = None
494
self._supports_tree_reference = None
495
self._rich_root_data = None
498
return "%s(_network_name=%r)" % (self.__class__.__name__,
502
def fast_deltas(self):
504
return self._custom_format.fast_deltas
507
def rich_root_data(self):
508
if self._rich_root_data is None:
510
self._rich_root_data = self._custom_format.rich_root_data
511
return self._rich_root_data
514
def supports_chks(self):
515
if self._supports_chks is None:
517
self._supports_chks = self._custom_format.supports_chks
518
return self._supports_chks
521
def supports_external_lookups(self):
522
if self._supports_external_lookups is None:
524
self._supports_external_lookups = \
525
self._custom_format.supports_external_lookups
526
return self._supports_external_lookups
529
def supports_tree_reference(self):
530
if self._supports_tree_reference is None:
532
self._supports_tree_reference = \
533
self._custom_format.supports_tree_reference
534
return self._supports_tree_reference
536
def _vfs_initialize(self, a_bzrdir, shared):
537
"""Helper for common code in initialize."""
538
if self._custom_format:
539
# Custom format requested
540
result = self._custom_format.initialize(a_bzrdir, shared=shared)
541
elif self._creating_bzrdir is not None:
542
# Use the format that the repository we were created to back
544
prior_repo = self._creating_bzrdir.open_repository()
545
prior_repo._ensure_real()
546
result = prior_repo._real_repository._format.initialize(
547
a_bzrdir, shared=shared)
549
# assume that a_bzr is a RemoteBzrDir but the smart server didn't
550
# support remote initialization.
551
# We delegate to a real object at this point (as RemoteBzrDir
552
# delegate to the repository format which would lead to infinite
553
# recursion if we just called a_bzrdir.create_repository.
554
a_bzrdir._ensure_real()
555
result = a_bzrdir._real_bzrdir.create_repository(shared=shared)
556
if not isinstance(result, RemoteRepository):
557
return self.open(a_bzrdir)
228
_matchingbzrdir = RemoteBzrDirFormat
561
230
def initialize(self, a_bzrdir, shared=False):
562
# Being asked to create on a non RemoteBzrDir:
563
if not isinstance(a_bzrdir, RemoteBzrDir):
564
return self._vfs_initialize(a_bzrdir, shared)
565
medium = a_bzrdir._client._medium
566
if medium._is_remote_before((1, 13)):
567
return self._vfs_initialize(a_bzrdir, shared)
568
# Creating on a remote bzr dir.
569
# 1) get the network name to use.
570
if self._custom_format:
571
network_name = self._custom_format.network_name()
572
elif self._network_name:
573
network_name = self._network_name
575
# Select the current bzrlib default and ask for that.
576
reference_bzrdir_format = bzrdir.format_registry.get('default')()
577
reference_format = reference_bzrdir_format.repository_format
578
network_name = reference_format.network_name()
579
# 2) try direct creation via RPC
580
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
581
verb = 'BzrDir.create_repository'
587
response = a_bzrdir._call(verb, path, network_name, shared_str)
588
except errors.UnknownSmartMethod:
589
# Fallback - use vfs methods
590
medium._remember_remote_is_before((1, 13))
591
return self._vfs_initialize(a_bzrdir, shared)
593
# Turn the response into a RemoteRepository object.
594
format = response_tuple_to_repo_format(response[1:])
595
# Used to support creating a real format instance when needed.
596
format._creating_bzrdir = a_bzrdir
597
remote_repo = RemoteRepository(a_bzrdir, format)
598
format._creating_repo = remote_repo
231
assert isinstance(a_bzrdir, RemoteBzrDir), \
232
'%r is not a RemoteBzrDir' % (a_bzrdir,)
233
return a_bzrdir.create_repository(shared=shared)
601
235
def open(self, a_bzrdir):
602
if not isinstance(a_bzrdir, RemoteBzrDir):
603
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
236
assert isinstance(a_bzrdir, RemoteBzrDir)
604
237
return a_bzrdir.open_repository()
606
def _ensure_real(self):
607
if self._custom_format is None:
608
self._custom_format = repository.network_format_registry.get(
612
def _fetch_order(self):
614
return self._custom_format._fetch_order
617
def _fetch_uses_deltas(self):
619
return self._custom_format._fetch_uses_deltas
622
def _fetch_reconcile(self):
624
return self._custom_format._fetch_reconcile
626
239
def get_format_description(self):
628
return 'Remote: ' + self._custom_format.get_format_description()
240
return 'bzr remote repository'
630
242
def __eq__(self, other):
631
return self.__class__ is other.__class__
633
def network_name(self):
634
if self._network_name:
635
return self._network_name
636
self._creating_repo._ensure_real()
637
return self._creating_repo._real_repository._format.network_name()
640
def pack_compresses(self):
642
return self._custom_format.pack_compresses
645
def _serializer(self):
647
return self._custom_format._serializer
650
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
651
bzrdir.ControlComponent):
243
return self.__class__ == other.__class__
245
def check_conversion_target(self, target_format):
246
if self.rich_root_data and not target_format.rich_root_data:
247
raise errors.BadConversionTarget(
248
'Does not support rich root data.', target_format)
249
if (self.supports_tree_reference and
250
not getattr(target_format, 'supports_tree_reference', False)):
251
raise errors.BadConversionTarget(
252
'Does not support nested trees', target_format)
255
class RemoteRepository(object):
652
256
"""Repository accessed over rpc.
654
258
For the moment most operations are performed using local transport-backed
748
325
self._ensure_real()
749
326
return self._real_repository.commit_write_group()
751
def resume_write_group(self, tokens):
753
return self._real_repository.resume_write_group(tokens)
755
def suspend_write_group(self):
757
return self._real_repository.suspend_write_group()
759
def get_missing_parent_inventories(self, check_for_missing_texts=True):
761
return self._real_repository.get_missing_parent_inventories(
762
check_for_missing_texts=check_for_missing_texts)
764
def _get_rev_id_for_revno_vfs(self, revno, known_pair):
766
return self._real_repository.get_rev_id_for_revno(
769
def get_rev_id_for_revno(self, revno, known_pair):
770
"""See Repository.get_rev_id_for_revno."""
771
path = self.bzrdir._path_for_remote_call(self._client)
773
if self._client._medium._is_remote_before((1, 17)):
774
return self._get_rev_id_for_revno_vfs(revno, known_pair)
775
response = self._call(
776
'Repository.get_rev_id_for_revno', path, revno, known_pair)
777
except errors.UnknownSmartMethod:
778
self._client._medium._remember_remote_is_before((1, 17))
779
return self._get_rev_id_for_revno_vfs(revno, known_pair)
780
if response[0] == 'ok':
781
return True, response[1]
782
elif response[0] == 'history-incomplete':
783
known_pair = response[1:3]
784
for fallback in self._fallback_repositories:
785
found, result = fallback.get_rev_id_for_revno(revno, known_pair)
790
# Not found in any fallbacks
791
return False, known_pair
793
raise errors.UnexpectedSmartServerResponse(response)
795
328
def _ensure_real(self):
796
329
"""Ensure that there is a _real_repository set.
798
331
Used before calls to self._real_repository.
800
Note that _ensure_real causes many roundtrips to the server which are
801
not desirable, and prevents the use of smart one-roundtrip RPC's to
802
perform complex operations (such as accessing parent data, streaming
803
revisions etc). Adding calls to _ensure_real should only be done when
804
bringing up new functionality, adding fallbacks for smart methods that
805
require a fallback path, and never to replace an existing smart method
806
invocation. If in doubt chat to the bzr network team.
808
if self._real_repository is None:
809
if 'hpssvfs' in debug.debug_flags:
811
warning('VFS Repository access triggered\n%s',
812
''.join(traceback.format_stack()))
813
self._unstacked_provider.missing_keys.clear()
333
if not self._real_repository:
814
334
self.bzrdir._ensure_real()
815
self._set_real_repository(
816
self.bzrdir._real_bzrdir.open_repository())
818
def _translate_error(self, err, **context):
819
self.bzrdir._translate_error(err, repository=self, **context)
335
#self._real_repository = self.bzrdir._real_bzrdir.open_repository()
336
self._set_real_repository(self.bzrdir._real_bzrdir.open_repository())
821
338
def find_text_key_references(self):
822
339
"""Find the text key references within the repository.
853
375
path = self.bzrdir._path_for_remote_call(self._client)
854
response = self._call_expecting_body(
376
assert type(revision_id) is str
377
response = self._client.call_expecting_body(
855
378
'Repository.get_revision_graph', path, revision_id)
856
response_tuple, response_handler = response
857
if response_tuple[0] != 'ok':
858
raise errors.UnexpectedSmartServerResponse(response_tuple)
859
coded = response_handler.read_body_bytes()
861
# no revisions in this repository!
863
lines = coded.split('\n')
866
d = tuple(line.split())
867
revision_graph[d[0]] = d[1:]
869
return revision_graph
872
"""See Repository._get_sink()."""
873
return RemoteStreamSink(self)
875
def _get_source(self, to_format):
876
"""Return a source for streaming from this repository."""
877
return RemoteStreamSource(self, to_format)
379
if response[0][0] not in ['ok', 'nosuchrevision']:
380
raise errors.UnexpectedSmartServerResponse(response[0])
381
if response[0][0] == 'ok':
382
coded = response[1].read_body_bytes()
384
# no revisions in this repository!
386
lines = coded.split('\n')
389
d = tuple(line.split())
390
revision_graph[d[0]] = d[1:]
392
return revision_graph
394
response_body = response[1].read_body_bytes()
395
assert response_body == ''
396
raise NoSuchRevision(self, revision_id)
880
398
def has_revision(self, revision_id):
881
"""True if this repository has a copy of the revision."""
882
# Copy of bzrlib.repository.Repository.has_revision
883
return revision_id in self.has_revisions((revision_id,))
399
"""See Repository.has_revision()."""
400
if revision_id == NULL_REVISION:
401
# The null revision is always present.
403
path = self.bzrdir._path_for_remote_call(self._client)
404
response = self._client.call('Repository.has_revision', path, revision_id)
405
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
406
return response[0] == 'yes'
886
408
def has_revisions(self, revision_ids):
887
"""Probe to find out the presence of multiple revisions.
889
:param revision_ids: An iterable of revision_ids.
890
:return: A set of the revision_ids that were present.
892
# Copy of bzrlib.repository.Repository.has_revisions
893
parent_map = self.get_parent_map(revision_ids)
894
result = set(parent_map)
895
if _mod_revision.NULL_REVISION in revision_ids:
896
result.add(_mod_revision.NULL_REVISION)
409
"""See Repository.has_revisions()."""
411
for revision_id in revision_ids:
412
if self.has_revision(revision_id):
413
result.add(revision_id)
899
def _has_same_fallbacks(self, other_repo):
900
"""Returns true if the repositories have the same fallbacks."""
901
# XXX: copied from Repository; it should be unified into a base class
902
# <https://bugs.launchpad.net/bzr/+bug/401622>
903
my_fb = self._fallback_repositories
904
other_fb = other_repo._fallback_repositories
905
if len(my_fb) != len(other_fb):
907
for f, g in zip(my_fb, other_fb):
908
if not f.has_same_location(g):
912
416
def has_same_location(self, other):
913
# TODO: Move to RepositoryBase and unify with the regular Repository
914
# one; unfortunately the tests rely on slightly different behaviour at
915
# present -- mbp 20090710
916
return (self.__class__ is other.__class__ and
417
return (self.__class__ == other.__class__ and
917
418
self.bzrdir.transport.base == other.bzrdir.transport.base)
919
420
def get_graph(self, other_repository=None):
920
421
"""Return the graph for this repository format"""
921
parents_provider = self._make_parents_provider(other_repository)
422
parents_provider = self
423
if (other_repository is not None and
424
other_repository.bzrdir.transport.base !=
425
self.bzrdir.transport.base):
426
parents_provider = graph._StackedParentsProvider(
427
[parents_provider, other_repository._make_parents_provider()])
922
428
return graph.Graph(parents_provider)
925
def get_known_graph_ancestry(self, revision_ids):
926
"""Return the known graph for a set of revision ids and their ancestors.
928
st = static_tuple.StaticTuple
929
revision_keys = [st(r_id).intern() for r_id in revision_ids]
930
known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
931
return graph.GraphThunkIdsToKeys(known_graph)
933
430
def gather_stats(self, revid=None, committers=None):
934
431
"""See Repository.gather_stats()."""
935
432
path = self.bzrdir._path_for_remote_call(self._client)
987
484
def is_shared(self):
988
485
"""See Repository.is_shared()."""
989
486
path = self.bzrdir._path_for_remote_call(self._client)
990
response = self._call('Repository.is_shared', path)
991
if response[0] not in ('yes', 'no'):
992
raise SmartProtocolError('unexpected response code %s' % (response,))
487
response = self._client.call('Repository.is_shared', path)
488
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
993
489
return response[0] == 'yes'
995
491
def is_write_locked(self):
996
492
return self._lock_mode == 'w'
998
def _warn_if_deprecated(self, branch=None):
999
# If we have a real repository, the check will be done there, if we
1000
# don't the check will be done remotely.
1003
494
def lock_read(self):
1004
"""Lock the repository for read operations.
1006
:return: A bzrlib.lock.LogicalLockResult.
1008
495
# wrong eventually - want a local lock cache context
1009
496
if not self._lock_mode:
1010
self._note_lock('r')
1011
497
self._lock_mode = 'r'
1012
498
self._lock_count = 1
1013
self._unstacked_provider.enable_cache(cache_misses=True)
499
self._parents_map = {}
500
if 'hpss' in debug.debug_flags:
501
self._requested_parents = set()
1014
502
if self._real_repository is not None:
1015
503
self._real_repository.lock_read()
1016
for repo in self._fallback_repositories:
1019
505
self._lock_count += 1
1020
return lock.LogicalLockResult(self.unlock)
1022
507
def _remote_lock_write(self, token):
1023
508
path = self.bzrdir._path_for_remote_call(self._client)
1024
509
if token is None:
1026
err_context = {'token': token}
1027
response = self._call('Repository.lock_write', path, token,
511
response = self._client.call('Repository.lock_write', path, token)
1029
512
if response[0] == 'ok':
1030
513
ok, token = response
515
elif response[0] == 'LockContention':
516
raise errors.LockContention('(remote lock)')
517
elif response[0] == 'UnlockableTransport':
518
raise errors.UnlockableTransport(self.bzrdir.root_transport)
519
elif response[0] == 'LockFailed':
520
raise errors.LockFailed(response[1], response[2])
1033
522
raise errors.UnexpectedSmartServerResponse(response)
1035
def lock_write(self, token=None, _skip_rpc=False):
524
def lock_write(self, token=None):
1036
525
if not self._lock_mode:
1037
self._note_lock('w')
1039
if self._lock_token is not None:
1040
if token != self._lock_token:
1041
raise errors.TokenMismatch(token, self._lock_token)
1042
self._lock_token = token
1044
self._lock_token = self._remote_lock_write(token)
526
self._lock_token = self._remote_lock_write(token)
1045
527
# if self._lock_token is None, then this is something like packs or
1046
528
# svn where we don't get to lock the repo, or a weave style repository
1047
529
# where we cannot lock it over the wire and attempts to do so will
1227
675
# FIXME: It ought to be possible to call this without immediately
1228
676
# triggering _ensure_real. For now it's the easiest thing to do.
1229
677
self._ensure_real()
1230
real_repo = self._real_repository
1231
builder = real_repo.get_commit_builder(branch, parents,
678
builder = self._real_repository.get_commit_builder(branch, parents,
1232
679
config, timestamp=timestamp, timezone=timezone,
1233
680
committer=committer, revprops=revprops, revision_id=revision_id)
1236
def add_fallback_repository(self, repository):
1237
"""Add a repository to use for looking up data not held locally.
1239
:param repository: A repository.
1241
if not self._format.supports_external_lookups:
1242
raise errors.UnstackableRepositoryFormat(
1243
self._format.network_name(), self.base)
1244
# We need to accumulate additional repositories here, to pass them in
1247
if self.is_locked():
1248
# We will call fallback.unlock() when we transition to the unlocked
1249
# state, so always add a lock here. If a caller passes us a locked
1250
# repository, they are responsible for unlocking it later.
1251
repository.lock_read()
1252
self._check_fallback_repository(repository)
1253
self._fallback_repositories.append(repository)
1254
# If self._real_repository was parameterised already (e.g. because a
1255
# _real_branch had its get_stacked_on_url method called), then the
1256
# repository to be added may already be in the _real_repositories list.
1257
if self._real_repository is not None:
1258
fallback_locations = [repo.user_url for repo in
1259
self._real_repository._fallback_repositories]
1260
if repository.user_url not in fallback_locations:
1261
self._real_repository.add_fallback_repository(repository)
1263
def _check_fallback_repository(self, repository):
1264
"""Check that this repository can fallback to repository safely.
1266
Raise an error if not.
1268
:param repository: A repository to fallback to.
1270
return _mod_repository.InterRepository._assert_same_model(
1273
683
def add_inventory(self, revid, inv, parents):
1274
684
self._ensure_real()
1275
685
return self._real_repository.add_inventory(revid, inv, parents)
1277
def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1278
parents, basis_inv=None, propagate_caches=False):
1280
return self._real_repository.add_inventory_by_delta(basis_revision_id,
1281
delta, new_revision_id, parents, basis_inv=basis_inv,
1282
propagate_caches=propagate_caches)
1284
687
def add_revision(self, rev_id, rev, inv=None, config=None):
1285
688
self._ensure_real()
1286
689
return self._real_repository.add_revision(
1352
745
return repository.InterRepository.get(
1353
746
other, self).search_missing_revision_ids(revision_id, find_ghosts)
1355
def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1357
# No base implementation to use as RemoteRepository is not a subclass
1358
# of Repository; so this is a copy of Repository.fetch().
1359
if fetch_spec is not None and revision_id is not None:
1360
raise AssertionError(
1361
"fetch_spec and revision_id are mutually exclusive.")
1362
if self.is_in_write_group():
1363
raise errors.InternalBzrError(
1364
"May not fetch while in a write group.")
1365
# fast path same-url fetch operations
1366
if (self.has_same_location(source)
1367
and fetch_spec is None
1368
and self._has_same_fallbacks(source)):
748
def fetch(self, source, revision_id=None, pb=None):
749
if self.has_same_location(source):
1369
750
# check that last_revision is in 'from' and then return a
1371
752
if (revision_id is not None and
1372
753
not revision.is_null(revision_id)):
1373
754
self.get_revision(revision_id)
1375
# if there is no specific appropriate InterRepository, this will get
1376
# the InterRepository base class, which raises an
1377
# IncompatibleRepositories when asked to fetch.
1378
inter = repository.InterRepository.get(source, self)
1379
return inter.fetch(revision_id=revision_id, pb=pb,
1380
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
757
return self._real_repository.fetch(
758
source, revision_id=revision_id, pb=pb)
1382
760
def create_bundle(self, target, base, fileobj, format=None):
1383
761
self._ensure_real()
1384
762
self._real_repository.create_bundle(target, base, fileobj, format)
765
def control_weaves(self):
767
return self._real_repository.control_weaves
1386
769
@needs_read_lock
1387
770
def get_ancestry(self, revision_id, topo_sorted=True):
1388
771
self._ensure_real()
1389
772
return self._real_repository.get_ancestry(revision_id, topo_sorted)
775
def get_inventory_weave(self):
777
return self._real_repository.get_inventory_weave()
1391
779
def fileids_altered_by_revision_ids(self, revision_ids):
1392
780
self._ensure_real()
1393
781
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
1396
784
self._ensure_real()
1397
785
return self._real_repository._get_versioned_file_checker(
1398
786
revisions, revision_versions_cache)
1400
788
def iter_files_bytes(self, desired_files):
1401
789
"""See Repository.iter_file_bytes.
1403
791
self._ensure_real()
1404
792
return self._real_repository.iter_files_bytes(desired_files)
1406
def get_parent_map(self, revision_ids):
794
def get_parent_map(self, keys):
1407
795
"""See bzrlib.Graph.get_parent_map()."""
1408
return self._make_parents_provider().get_parent_map(revision_ids)
1410
def _get_parent_map_rpc(self, keys):
796
# Hack to build up the caching logic.
797
ancestry = self._parents_map
799
# Repository is not locked, so there's no cache.
800
missing_revisions = set(keys)
803
missing_revisions = set(key for key in keys if key not in ancestry)
804
if missing_revisions:
805
parent_map = self._get_parent_map(missing_revisions)
806
if 'hpss' in debug.debug_flags:
807
mutter('retransmitted revisions: %d of %d',
808
len(set(ancestry).intersection(parent_map)),
810
ancestry.update(parent_map)
811
present_keys = [k for k in keys if k in ancestry]
812
if 'hpss' in debug.debug_flags:
813
self._requested_parents.update(present_keys)
814
mutter('Current RemoteRepository graph hit rate: %d%%',
815
100.0 * len(self._requested_parents) / len(ancestry))
816
return dict((k, ancestry[k]) for k in present_keys)
818
def _response_is_unknown_method(self, response, verb):
819
"""Return True if response is an unknonwn method response to verb.
821
:param response: The response from a smart client call_expecting_body
823
:param verb: The verb used in that call.
824
:return: True if an unknown method was encountered.
826
# This might live better on
827
# bzrlib.smart.protocol.SmartClientRequestProtocolOne
828
if (response[0] == ('error', "Generic bzr smart protocol error: "
829
"bad request '%s'" % verb) or
830
response[0] == ('error', "Generic bzr smart protocol error: "
831
"bad request u'%s'" % verb)):
832
response[1].cancel_read_body()
836
def _get_parent_map(self, keys):
1411
837
"""Helper for get_parent_map that performs the RPC."""
1412
838
medium = self._client._medium
1413
if medium._is_remote_before((1, 2)):
839
if not medium._remote_is_at_least_1_2:
1414
840
# We already found out that the server can't understand
1415
841
# Repository.get_parent_map requests, so just fetch the whole
1418
# Note that this reads the whole graph, when only some keys are
1419
# wanted. On this old server there's no way (?) to get them all
1420
# in one go, and the user probably will have seen a warning about
1421
# the server being old anyhow.
1422
rg = self._get_revision_graph(None)
1423
# There is an API discrepancy between get_parent_map and
1424
# get_revision_graph. Specifically, a "key:()" pair in
1425
# get_revision_graph just means a node has no parents. For
1426
# "get_parent_map" it means the node is a ghost. So fix up the
1427
# graph to correct this.
1428
# https://bugs.launchpad.net/bzr/+bug/214894
1429
# There is one other "bug" which is that ghosts in
1430
# get_revision_graph() are not returned at all. But we won't worry
1431
# about that for now.
1432
for node_id, parent_ids in rg.iteritems():
1433
if parent_ids == ():
1434
rg[node_id] = (NULL_REVISION,)
1435
rg[NULL_REVISION] = ()
843
# XXX: Note that this will issue a deprecation warning. This is ok
844
# :- its because we're working with a deprecated server anyway, and
845
# the user will almost certainly have seen a warning about the
846
# server version already.
847
return self.get_revision_graph()
1438
849
keys = set(keys)
1440
raise ValueError('get_parent_map(None) is not valid')
1441
850
if NULL_REVISION in keys:
1442
851
keys.discard(NULL_REVISION)
1443
852
found_parents = {NULL_REVISION:()}
1456
865
# TODO: Manage this incrementally to avoid covering the same path
1457
866
# repeatedly. (The server will have to on each request, but the less
1458
867
# work done the better).
1460
# Negative caching notes:
1461
# new server sends missing when a request including the revid
1462
# 'include-missing:' is present in the request.
1463
# missing keys are serialised as missing:X, and we then call
1464
# provider.note_missing(X) for-all X
1465
parents_map = self._unstacked_provider.get_cached_map()
868
parents_map = self._parents_map
1466
869
if parents_map is None:
1467
870
# Repository is not locked, so there's no cache.
1468
871
parents_map = {}
1469
# start_set is all the keys in the cache
1470
872
start_set = set(parents_map)
1471
# result set is all the references to keys in the cache
1472
873
result_parents = set()
1473
874
for parents in parents_map.itervalues():
1474
875
result_parents.update(parents)
1475
876
stop_keys = result_parents.difference(start_set)
1476
# We don't need to send ghosts back to the server as a position to
1478
stop_keys.difference_update(self._unstacked_provider.missing_keys)
1479
key_count = len(parents_map)
1480
if (NULL_REVISION in result_parents
1481
and NULL_REVISION in self._unstacked_provider.missing_keys):
1482
# If we pruned NULL_REVISION from the stop_keys because it's also
1483
# in our cache of "missing" keys we need to increment our key count
1484
# by 1, because the reconsitituted SearchResult on the server will
1485
# still consider NULL_REVISION to be an included key.
1487
877
included_keys = start_set.intersection(result_parents)
1488
878
start_set.difference_update(included_keys)
1489
recipe = ('manual', start_set, stop_keys, key_count)
879
recipe = (start_set, stop_keys, len(parents_map))
1490
880
body = self._serialise_search_recipe(recipe)
1491
881
path = self.bzrdir._path_for_remote_call(self._client)
1492
882
for key in keys:
1493
if type(key) is not str:
1495
"key %r not a plain string" % (key,))
883
assert type(key) is str
1496
884
verb = 'Repository.get_parent_map'
1497
args = (path, 'include-missing:') + tuple(keys)
1499
response = self._call_with_body_bytes_expecting_body(
1501
except errors.UnknownSmartMethod:
885
args = (path,) + tuple(keys)
886
response = self._client.call_with_body_bytes_expecting_body(
887
verb, args, self._serialise_search_recipe(recipe))
888
if self._response_is_unknown_method(response, verb):
1502
889
# Server does not support this method, so get the whole graph.
1503
890
# Worse, we have to force a disconnection, because the server now
1504
891
# doesn't realise it has a body on the wire to consume, so the
1718
1053
self._ensure_real()
1719
1054
return self._real_repository.has_signature_for_revision_id(revision_id)
1056
def get_data_stream_for_search(self, search):
1057
medium = self._client._medium
1058
if not medium._remote_is_at_least_1_2:
1060
return self._real_repository.get_data_stream_for_search(search)
1061
REQUEST_NAME = 'Repository.stream_revisions_chunked'
1062
path = self.bzrdir._path_for_remote_call(self._client)
1063
body = self._serialise_search_recipe(search.get_recipe())
1064
response, protocol = self._client.call_with_body_bytes_expecting_body(
1065
REQUEST_NAME, (path,), body)
1067
if self._response_is_unknown_method((response, protocol), REQUEST_NAME):
1068
# Server does not support this method, so fall back to VFS.
1069
# Worse, we have to force a disconnection, because the server now
1070
# doesn't realise it has a body on the wire to consume, so the
1071
# only way to recover is to abandon the connection.
1073
'Server is too old for streaming pull, reconnecting. '
1074
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1076
# To avoid having to disconnect repeatedly, we keep track of the
1077
# fact the server doesn't understand this remote method.
1078
medium._remote_is_at_least_1_2 = False
1080
return self._real_repository.get_data_stream_for_search(search)
1082
if response == ('ok',):
1083
return self._deserialise_stream(protocol)
1084
if response == ('NoSuchRevision', ):
1085
# We cannot easily identify the revision that is missing in this
1086
# situation without doing much more network IO. For now, bail.
1087
raise NoSuchRevision(self, "unknown")
1089
raise errors.UnexpectedSmartServerResponse(response)
1091
def _deserialise_stream(self, protocol):
1092
stream = protocol.read_streamed_body()
1093
container_parser = ContainerPushParser()
1094
for bytes in stream:
1095
container_parser.accept_bytes(bytes)
1096
records = container_parser.read_pending_records()
1097
for record_names, record_bytes in records:
1098
if len(record_names) != 1:
1099
# These records should have only one name, and that name
1100
# should be a one-element tuple.
1101
raise errors.SmartProtocolError(
1102
'Repository data stream had invalid record name %r'
1104
name_tuple = record_names[0]
1105
yield name_tuple, record_bytes
1107
def insert_data_stream(self, stream):
1109
self._real_repository.insert_data_stream(stream)
1721
1111
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1722
1112
self._ensure_real()
1723
1113
return self._real_repository.item_keys_introduced_by(revision_ids,
1751
1135
:param recipe: A search recipe (start, stop, count).
1752
1136
:return: Serialised bytes.
1754
start_keys = ' '.join(recipe[1])
1755
stop_keys = ' '.join(recipe[2])
1756
count = str(recipe[3])
1138
start_keys = ' '.join(recipe[0])
1139
stop_keys = ' '.join(recipe[1])
1140
count = str(recipe[2])
1757
1141
return '\n'.join((start_keys, stop_keys, count))
1759
def _serialise_search_result(self, search_result):
1760
if isinstance(search_result, graph.PendingAncestryResult):
1761
parts = ['ancestry-of']
1762
parts.extend(search_result.heads)
1764
recipe = search_result.get_recipe()
1765
parts = [recipe[0], self._serialise_search_recipe(recipe)]
1766
return '\n'.join(parts)
1769
path = self.bzrdir._path_for_remote_call(self._client)
1771
response = self._call('PackRepository.autopack', path)
1772
except errors.UnknownSmartMethod:
1774
self._real_repository._pack_collection.autopack()
1777
if response[0] != 'ok':
1778
raise errors.UnexpectedSmartServerResponse(response)
1781
class RemoteStreamSink(repository.StreamSink):
1783
def _insert_real(self, stream, src_format, resume_tokens):
1784
self.target_repo._ensure_real()
1785
sink = self.target_repo._real_repository._get_sink()
1786
result = sink.insert_stream(stream, src_format, resume_tokens)
1788
self.target_repo.autopack()
1791
def insert_stream(self, stream, src_format, resume_tokens):
1792
target = self.target_repo
1793
target._unstacked_provider.missing_keys.clear()
1794
candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
1795
if target._lock_token:
1796
candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
1797
lock_args = (target._lock_token or '',)
1799
candidate_calls.append(('Repository.insert_stream', (1, 13)))
1801
client = target._client
1802
medium = client._medium
1803
path = target.bzrdir._path_for_remote_call(client)
1804
# Probe for the verb to use with an empty stream before sending the
1805
# real stream to it. We do this both to avoid the risk of sending a
1806
# large request that is then rejected, and because we don't want to
1807
# implement a way to buffer, rewind, or restart the stream.
1809
for verb, required_version in candidate_calls:
1810
if medium._is_remote_before(required_version):
1813
# We've already done the probing (and set _is_remote_before) on
1814
# a previous insert.
1817
byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1819
response = client.call_with_body_stream(
1820
(verb, path, '') + lock_args, byte_stream)
1821
except errors.UnknownSmartMethod:
1822
medium._remember_remote_is_before(required_version)
1828
return self._insert_real(stream, src_format, resume_tokens)
1829
self._last_inv_record = None
1830
self._last_substream = None
1831
if required_version < (1, 19):
1832
# Remote side doesn't support inventory deltas. Wrap the stream to
1833
# make sure we don't send any. If the stream contains inventory
1834
# deltas we'll interrupt the smart insert_stream request and
1836
stream = self._stop_stream_if_inventory_delta(stream)
1837
byte_stream = smart_repo._stream_to_byte_stream(
1839
resume_tokens = ' '.join(resume_tokens)
1840
response = client.call_with_body_stream(
1841
(verb, path, resume_tokens) + lock_args, byte_stream)
1842
if response[0][0] not in ('ok', 'missing-basis'):
1843
raise errors.UnexpectedSmartServerResponse(response)
1844
if self._last_substream is not None:
1845
# The stream included an inventory-delta record, but the remote
1846
# side isn't new enough to support them. So we need to send the
1847
# rest of the stream via VFS.
1848
self.target_repo.refresh_data()
1849
return self._resume_stream_with_vfs(response, src_format)
1850
if response[0][0] == 'missing-basis':
1851
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1852
resume_tokens = tokens
1853
return resume_tokens, set(missing_keys)
1855
self.target_repo.refresh_data()
1858
def _resume_stream_with_vfs(self, response, src_format):
1859
"""Resume sending a stream via VFS, first resending the record and
1860
substream that couldn't be sent via an insert_stream verb.
1862
if response[0][0] == 'missing-basis':
1863
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1864
# Ignore missing_keys, we haven't finished inserting yet
1867
def resume_substream():
1868
# Yield the substream that was interrupted.
1869
for record in self._last_substream:
1871
self._last_substream = None
1872
def resume_stream():
1873
# Finish sending the interrupted substream
1874
yield ('inventory-deltas', resume_substream())
1875
# Then simply continue sending the rest of the stream.
1876
for substream_kind, substream in self._last_stream:
1877
yield substream_kind, substream
1878
return self._insert_real(resume_stream(), src_format, tokens)
1880
def _stop_stream_if_inventory_delta(self, stream):
1881
"""Normally this just lets the original stream pass-through unchanged.
1883
However if any 'inventory-deltas' substream occurs it will stop
1884
streaming, and store the interrupted substream and stream in
1885
self._last_substream and self._last_stream so that the stream can be
1886
resumed by _resume_stream_with_vfs.
1889
stream_iter = iter(stream)
1890
for substream_kind, substream in stream_iter:
1891
if substream_kind == 'inventory-deltas':
1892
self._last_substream = substream
1893
self._last_stream = stream_iter
1896
yield substream_kind, substream
1899
class RemoteStreamSource(repository.StreamSource):
1900
"""Stream data from a remote server."""
1902
def get_stream(self, search):
1903
if (self.from_repository._fallback_repositories and
1904
self.to_format._fetch_order == 'topological'):
1905
return self._real_stream(self.from_repository, search)
1908
repos = [self.from_repository]
1914
repos.extend(repo._fallback_repositories)
1915
sources.append(repo)
1916
return self.missing_parents_chain(search, sources)
1918
def get_stream_for_missing_keys(self, missing_keys):
1919
self.from_repository._ensure_real()
1920
real_repo = self.from_repository._real_repository
1921
real_source = real_repo._get_source(self.to_format)
1922
return real_source.get_stream_for_missing_keys(missing_keys)
1924
def _real_stream(self, repo, search):
1925
"""Get a stream for search from repo.
1927
This never called RemoteStreamSource.get_stream, and is a heler
1928
for RemoteStreamSource._get_stream to allow getting a stream
1929
reliably whether fallback back because of old servers or trying
1930
to stream from a non-RemoteRepository (which the stacked support
1933
source = repo._get_source(self.to_format)
1934
if isinstance(source, RemoteStreamSource):
1936
source = repo._real_repository._get_source(self.to_format)
1937
return source.get_stream(search)
1939
def _get_stream(self, repo, search):
1940
"""Core worker to get a stream from repo for search.
1942
This is used by both get_stream and the stacking support logic. It
1943
deliberately gets a stream for repo which does not need to be
1944
self.from_repository. In the event that repo is not Remote, or
1945
cannot do a smart stream, a fallback is made to the generic
1946
repository._get_stream() interface, via self._real_stream.
1948
In the event of stacking, streams from _get_stream will not
1949
contain all the data for search - this is normal (see get_stream).
1951
:param repo: A repository.
1952
:param search: A search.
1954
# Fallbacks may be non-smart
1955
if not isinstance(repo, RemoteRepository):
1956
return self._real_stream(repo, search)
1957
client = repo._client
1958
medium = client._medium
1959
path = repo.bzrdir._path_for_remote_call(client)
1960
search_bytes = repo._serialise_search_result(search)
1961
args = (path, self.to_format.network_name())
1963
('Repository.get_stream_1.19', (1, 19)),
1964
('Repository.get_stream', (1, 13))]
1966
for verb, version in candidate_verbs:
1967
if medium._is_remote_before(version):
1970
response = repo._call_with_body_bytes_expecting_body(
1971
verb, args, search_bytes)
1972
except errors.UnknownSmartMethod:
1973
medium._remember_remote_is_before(version)
1975
response_tuple, response_handler = response
1979
return self._real_stream(repo, search)
1980
if response_tuple[0] != 'ok':
1981
raise errors.UnexpectedSmartServerResponse(response_tuple)
1982
byte_stream = response_handler.read_streamed_body()
1983
src_format, stream = smart_repo._byte_stream_to_stream(byte_stream,
1984
self._record_counter)
1985
if src_format.network_name() != repo._format.network_name():
1986
raise AssertionError(
1987
"Mismatched RemoteRepository and stream src %r, %r" % (
1988
src_format.network_name(), repo._format.network_name()))
1991
def missing_parents_chain(self, search, sources):
1992
"""Chain multiple streams together to handle stacking.
1994
:param search: The overall search to satisfy with streams.
1995
:param sources: A list of Repository objects to query.
1997
self.from_serialiser = self.from_repository._format._serializer
1998
self.seen_revs = set()
1999
self.referenced_revs = set()
2000
# If there are heads in the search, or the key count is > 0, we are not
2002
while not search.is_empty() and len(sources) > 1:
2003
source = sources.pop(0)
2004
stream = self._get_stream(source, search)
2005
for kind, substream in stream:
2006
if kind != 'revisions':
2007
yield kind, substream
2009
yield kind, self.missing_parents_rev_handler(substream)
2010
search = search.refine(self.seen_revs, self.referenced_revs)
2011
self.seen_revs = set()
2012
self.referenced_revs = set()
2013
if not search.is_empty():
2014
for kind, stream in self._get_stream(sources[0], search):
2017
def missing_parents_rev_handler(self, substream):
2018
for content in substream:
2019
revision_bytes = content.get_bytes_as('fulltext')
2020
revision = self.from_serialiser.read_revision_from_string(
2022
self.seen_revs.add(content.key[-1])
2023
self.referenced_revs.update(revision.parent_ids)
2027
1144
class RemoteBranchLockableFiles(LockableFiles):
2028
1145
"""A 'LockableFiles' implementation that talks to a smart server.
2030
1147
This is not a public interface class.
2043
1160
self._dir_mode = None
2044
1161
self._file_mode = None
1163
def get(self, path):
1164
"""'get' a remote path as per the LockableFiles interface.
1166
:param path: the file to 'get'. If this is 'branch.conf', we do not
1167
just retrieve a file, instead we ask the smart server to generate
1168
a configuration for us - which is retrieved as an INI file.
1170
if path == 'branch.conf':
1171
path = self.bzrdir._path_for_remote_call(self._client)
1172
response = self._client.call_expecting_body(
1173
'Branch.get_config_file', path)
1174
assert response[0][0] == 'ok', \
1175
'unexpected response code %s' % (response[0],)
1176
return StringIO(response[1].read_body_bytes())
1179
return LockableFiles.get(self, path)
2047
1182
class RemoteBranchFormat(branch.BranchFormat):
2049
def __init__(self, network_name=None):
2050
super(RemoteBranchFormat, self).__init__()
2051
self._matchingbzrdir = RemoteBzrDirFormat()
2052
self._matchingbzrdir.set_branch_format(self)
2053
self._custom_format = None
2054
self._network_name = network_name
2056
1184
def __eq__(self, other):
2057
return (isinstance(other, RemoteBranchFormat) and
1185
return (isinstance(other, RemoteBranchFormat) and
2058
1186
self.__dict__ == other.__dict__)
2060
def _ensure_real(self):
2061
if self._custom_format is None:
2062
self._custom_format = branch.network_format_registry.get(
2065
1188
def get_format_description(self):
2067
return 'Remote: ' + self._custom_format.get_format_description()
2069
def network_name(self):
2070
return self._network_name
2072
def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
2073
return a_bzrdir.open_branch(name=name,
2074
ignore_fallbacks=ignore_fallbacks)
2076
def _vfs_initialize(self, a_bzrdir, name):
2077
# Initialisation when using a local bzrdir object, or a non-vfs init
2078
# method is not available on the server.
2079
# self._custom_format is always set - the start of initialize ensures
2081
if isinstance(a_bzrdir, RemoteBzrDir):
2082
a_bzrdir._ensure_real()
2083
result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2086
# We assume the bzrdir is parameterised; it may not be.
2087
result = self._custom_format.initialize(a_bzrdir, name)
2088
if (isinstance(a_bzrdir, RemoteBzrDir) and
2089
not isinstance(result, RemoteBranch)):
2090
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2094
def initialize(self, a_bzrdir, name=None):
2095
# 1) get the network name to use.
2096
if self._custom_format:
2097
network_name = self._custom_format.network_name()
2099
# Select the current bzrlib default and ask for that.
2100
reference_bzrdir_format = bzrdir.format_registry.get('default')()
2101
reference_format = reference_bzrdir_format.get_branch_format()
2102
self._custom_format = reference_format
2103
network_name = reference_format.network_name()
2104
# Being asked to create on a non RemoteBzrDir:
2105
if not isinstance(a_bzrdir, RemoteBzrDir):
2106
return self._vfs_initialize(a_bzrdir, name=name)
2107
medium = a_bzrdir._client._medium
2108
if medium._is_remote_before((1, 13)):
2109
return self._vfs_initialize(a_bzrdir, name=name)
2110
# Creating on a remote bzr dir.
2111
# 2) try direct creation via RPC
2112
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2113
if name is not None:
2114
# XXX JRV20100304: Support creating colocated branches
2115
raise errors.NoColocatedBranchSupport(self)
2116
verb = 'BzrDir.create_branch'
2118
response = a_bzrdir._call(verb, path, network_name)
2119
except errors.UnknownSmartMethod:
2120
# Fallback - use vfs methods
2121
medium._remember_remote_is_before((1, 13))
2122
return self._vfs_initialize(a_bzrdir, name=name)
2123
if response[0] != 'ok':
2124
raise errors.UnexpectedSmartServerResponse(response)
2125
# Turn the response into a RemoteRepository object.
2126
format = RemoteBranchFormat(network_name=response[1])
2127
repo_format = response_tuple_to_repo_format(response[3:])
2128
if response[2] == '':
2129
repo_bzrdir = a_bzrdir
2131
repo_bzrdir = RemoteBzrDir(
2132
a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
2134
remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2135
remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2136
format=format, setup_stacking=False, name=name)
2137
# XXX: We know this is a new branch, so it must have revno 0, revid
2138
# NULL_REVISION. Creating the branch locked would make this be unable
2139
# to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2140
remote_branch._last_revision_info_cache = 0, NULL_REVISION
2141
return remote_branch
2143
def make_tags(self, branch):
2145
return self._custom_format.make_tags(branch)
1189
return 'Remote BZR Branch'
1191
def get_format_string(self):
1192
return 'Remote BZR Branch'
1194
def open(self, a_bzrdir):
1195
assert isinstance(a_bzrdir, RemoteBzrDir)
1196
return a_bzrdir.open_branch()
1198
def initialize(self, a_bzrdir):
1199
assert isinstance(a_bzrdir, RemoteBzrDir)
1200
return a_bzrdir.create_branch()
2147
1202
def supports_tags(self):
2148
1203
# Remote branches might support tags, but we won't know until we
2149
1204
# access the real remote branch.
2151
return self._custom_format.supports_tags()
2153
def supports_stacking(self):
2155
return self._custom_format.supports_stacking()
2157
def supports_set_append_revisions_only(self):
2159
return self._custom_format.supports_set_append_revisions_only()
2162
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
1208
class RemoteBranch(branch.Branch):
2163
1209
"""Branch stored on a server accessed by HPSS RPC.
2165
1211
At the moment most operations are mapped down to simple file operations.
2168
1214
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2169
_client=None, format=None, setup_stacking=True, name=None):
2170
1216
"""Create a RemoteBranch instance.
2172
1218
:param real_branch: An optional local implementation of the branch
2173
1219
format, usually accessing the data via the VFS.
2174
1220
:param _client: Private parameter for testing.
2175
:param format: A RemoteBranchFormat object, None to create one
2176
automatically. If supplied it should have a network_name already
2178
:param setup_stacking: If True make an RPC call to determine the
2179
stacked (or not) status of the branch. If False assume the branch
2181
:param name: Colocated branch name
2183
1222
# We intentionally don't call the parent class's __init__, because it
2184
1223
# will try to assign to self.tags, which is a property in this subclass.
2185
1224
# And the parent's __init__ doesn't do much anyway.
1225
self._revision_id_to_revno_cache = None
1226
self._revision_history_cache = None
2186
1227
self.bzrdir = remote_bzrdir
2187
1228
if _client is not None:
2188
1229
self._client = _client
2271
1262
Used before calls to self._real_branch.
2273
if self._real_branch is None:
2274
if not vfs.vfs_enabled():
2275
raise AssertionError('smart server vfs must be enabled '
2276
'to use vfs implementation')
1264
if not self._real_branch:
1265
assert vfs.vfs_enabled()
2277
1266
self.bzrdir._ensure_real()
2278
self._real_branch = self.bzrdir._real_bzrdir.open_branch(
2279
ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
2280
if self.repository._real_repository is None:
2281
# Give the remote repository the matching real repo.
2282
real_repo = self._real_branch.repository
2283
if isinstance(real_repo, RemoteRepository):
2284
real_repo._ensure_real()
2285
real_repo = real_repo._real_repository
2286
self.repository._set_real_repository(real_repo)
2287
# Give the real branch the remote repository to let fast-pathing
1267
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1268
# Give the remote repository the matching real repo.
1269
real_repo = self._real_branch.repository
1270
if isinstance(real_repo, RemoteRepository):
1271
real_repo._ensure_real()
1272
real_repo = real_repo._real_repository
1273
self.repository._set_real_repository(real_repo)
1274
# Give the branch the remote repository to let fast-pathing happen.
2289
1275
self._real_branch.repository = self.repository
1276
# XXX: deal with _lock_mode == 'w'
2290
1277
if self._lock_mode == 'r':
2291
1278
self._real_branch.lock_read()
2292
elif self._lock_mode == 'w':
2293
self._real_branch.lock_write(token=self._lock_token)
2295
def _translate_error(self, err, **context):
2296
self.repository._translate_error(err, branch=self, **context)
2298
def _clear_cached_state(self):
2299
super(RemoteBranch, self)._clear_cached_state()
2300
if self._real_branch is not None:
2301
self._real_branch._clear_cached_state()
2303
def _clear_cached_state_of_remote_branch_only(self):
2304
"""Like _clear_cached_state, but doesn't clear the cache of
2307
This is useful when falling back to calling a method of
2308
self._real_branch that changes state. In that case the underlying
2309
branch changes, so we need to invalidate this RemoteBranch's cache of
2310
it. However, there's no need to invalidate the _real_branch's cache
2311
too, in fact doing so might harm performance.
2313
super(RemoteBranch, self)._clear_cached_state()
2316
1281
def control_files(self):
2331
1296
self._ensure_real()
2332
1297
return self._real_branch.get_physical_lock_status()
2334
def get_stacked_on_url(self):
2335
"""Get the URL this branch is stacked against.
2337
:raises NotStacked: If the branch is not stacked.
2338
:raises UnstackableBranchFormat: If the branch does not support
2340
:raises UnstackableRepositoryFormat: If the repository does not support
2344
# there may not be a repository yet, so we can't use
2345
# self._translate_error, so we can't use self._call either.
2346
response = self._client.call('Branch.get_stacked_on_url',
2347
self._remote_path())
2348
except errors.ErrorFromSmartServer, err:
2349
# there may not be a repository yet, so we can't call through
2350
# its _translate_error
2351
_translate_error(err, branch=self)
2352
except errors.UnknownSmartMethod, err:
2354
return self._real_branch.get_stacked_on_url()
2355
if response[0] != 'ok':
2356
raise errors.UnexpectedSmartServerResponse(response)
2359
def set_stacked_on_url(self, url):
2360
branch.Branch.set_stacked_on_url(self, url)
2362
self._is_stacked = False
2364
self._is_stacked = True
2366
def _vfs_get_tags_bytes(self):
2368
return self._real_branch._get_tags_bytes()
2370
def _get_tags_bytes(self):
2371
medium = self._client._medium
2372
if medium._is_remote_before((1, 13)):
2373
return self._vfs_get_tags_bytes()
2375
response = self._call('Branch.get_tags_bytes', self._remote_path())
2376
except errors.UnknownSmartMethod:
2377
medium._remember_remote_is_before((1, 13))
2378
return self._vfs_get_tags_bytes()
2381
def _vfs_set_tags_bytes(self, bytes):
2383
return self._real_branch._set_tags_bytes(bytes)
2385
def _set_tags_bytes(self, bytes):
2386
medium = self._client._medium
2387
if medium._is_remote_before((1, 18)):
2388
self._vfs_set_tags_bytes(bytes)
2392
self._remote_path(), self._lock_token, self._repo_lock_token)
2393
response = self._call_with_body_bytes(
2394
'Branch.set_tags_bytes', args, bytes)
2395
except errors.UnknownSmartMethod:
2396
medium._remember_remote_is_before((1, 18))
2397
self._vfs_set_tags_bytes(bytes)
2399
1299
def lock_read(self):
2400
"""Lock the branch for read operations.
2402
:return: A bzrlib.lock.LogicalLockResult.
2404
self.repository.lock_read()
2405
1300
if not self._lock_mode:
2406
self._note_lock('r')
2407
1301
self._lock_mode = 'r'
2408
1302
self._lock_count = 1
2409
1303
if self._real_branch is not None:
2410
1304
self._real_branch.lock_read()
2412
1306
self._lock_count += 1
2413
return lock.LogicalLockResult(self.unlock)
2415
1308
def _remote_lock_write(self, token):
2416
1309
if token is None:
2417
1310
branch_token = repo_token = ''
2419
1312
branch_token = token
2420
repo_token = self.repository.lock_write().repository_token
1313
repo_token = self.repository.lock_write()
2421
1314
self.repository.unlock()
2422
err_context = {'token': token}
2423
response = self._call(
2424
'Branch.lock_write', self._remote_path(), branch_token,
2425
repo_token or '', **err_context)
2426
if response[0] != 'ok':
1315
path = self.bzrdir._path_for_remote_call(self._client)
1316
response = self._client.call('Branch.lock_write', path, branch_token,
1318
if response[0] == 'ok':
1319
ok, branch_token, repo_token = response
1320
return branch_token, repo_token
1321
elif response[0] == 'LockContention':
1322
raise errors.LockContention('(remote lock)')
1323
elif response[0] == 'TokenMismatch':
1324
raise errors.TokenMismatch(token, '(remote token)')
1325
elif response[0] == 'UnlockableTransport':
1326
raise errors.UnlockableTransport(self.bzrdir.root_transport)
1327
elif response[0] == 'ReadOnlyError':
1328
raise errors.ReadOnlyError(self)
1329
elif response[0] == 'LockFailed':
1330
raise errors.LockFailed(response[1], response[2])
2427
1332
raise errors.UnexpectedSmartServerResponse(response)
2428
ok, branch_token, repo_token = response
2429
return branch_token, repo_token
2431
1334
def lock_write(self, token=None):
2432
1335
if not self._lock_mode:
2433
self._note_lock('w')
2434
# Lock the branch and repo in one remote call.
2435
1336
remote_tokens = self._remote_lock_write(token)
2436
1337
self._lock_token, self._repo_lock_token = remote_tokens
2437
if not self._lock_token:
2438
raise SmartProtocolError('Remote server did not return a token!')
2439
# Tell the self.repository object that it is locked.
2440
self.repository.lock_write(
2441
self._repo_lock_token, _skip_rpc=True)
1338
assert self._lock_token, 'Remote server did not return a token!'
1339
# TODO: We really, really, really don't want to call _ensure_real
1340
# here, but it's the easiest way to ensure coherency between the
1341
# state of the RemoteBranch and RemoteRepository objects and the
1342
# physical locks. If we don't materialise the real objects here,
1343
# then getting everything in the right state later is complex, so
1344
# for now we just do it the lazy way.
1345
# -- Andrew Bennetts, 2007-02-22.
2443
1347
if self._real_branch is not None:
2444
self._real_branch.lock_write(token=self._lock_token)
1348
self._real_branch.repository.lock_write(
1349
token=self._repo_lock_token)
1351
self._real_branch.lock_write(token=self._lock_token)
1353
self._real_branch.repository.unlock()
2445
1354
if token is not None:
2446
1355
self._leave_lock = True
1357
# XXX: this case seems to be unreachable; token cannot be None.
2448
1358
self._leave_lock = False
2449
1359
self._lock_mode = 'w'
2450
1360
self._lock_count = 1
2451
1361
elif self._lock_mode == 'r':
2452
raise errors.ReadOnlyError(self)
1362
raise errors.ReadOnlyTransaction
2454
1364
if token is not None:
2455
# A token was given to lock_write, and we're relocking, so
2456
# check that the given token actually matches the one we
1365
# A token was given to lock_write, and we're relocking, so check
1366
# that the given token actually matches the one we already have.
2458
1367
if token != self._lock_token:
2459
1368
raise errors.TokenMismatch(token, self._lock_token)
2460
1369
self._lock_count += 1
2461
# Re-lock the repository too.
2462
self.repository.lock_write(self._repo_lock_token)
2463
return BranchWriteLockResult(self.unlock, self._lock_token or None)
1370
return self._lock_token or None
2465
1372
def _unlock(self, branch_token, repo_token):
2466
err_context = {'token': str((branch_token, repo_token))}
2467
response = self._call(
2468
'Branch.unlock', self._remote_path(), branch_token,
2469
repo_token or '', **err_context)
1373
path = self.bzrdir._path_for_remote_call(self._client)
1374
response = self._client.call('Branch.unlock', path, branch_token,
2470
1376
if response == ('ok',):
2472
raise errors.UnexpectedSmartServerResponse(response)
1378
elif response[0] == 'TokenMismatch':
1379
raise errors.TokenMismatch(
1380
str((branch_token, repo_token)), '(remote tokens)')
1382
raise errors.UnexpectedSmartServerResponse(response)
2474
@only_raises(errors.LockNotHeld, errors.LockBroken)
2475
1384
def unlock(self):
2477
self._lock_count -= 1
2478
if not self._lock_count:
2479
self._clear_cached_state()
2480
mode = self._lock_mode
2481
self._lock_mode = None
2482
if self._real_branch is not None:
2483
if (not self._leave_lock and mode == 'w' and
2484
self._repo_lock_token):
2485
# If this RemoteBranch will remove the physical lock
2486
# for the repository, make sure the _real_branch
2487
# doesn't do it first. (Because the _real_branch's
2488
# repository is set to be the RemoteRepository.)
2489
self._real_branch.repository.leave_lock_in_place()
2490
self._real_branch.unlock()
2492
# Only write-locked branched need to make a remote method
2493
# call to perform the unlock.
2495
if not self._lock_token:
2496
raise AssertionError('Locked, but no token!')
2497
branch_token = self._lock_token
2498
repo_token = self._repo_lock_token
2499
self._lock_token = None
2500
self._repo_lock_token = None
2501
if not self._leave_lock:
2502
self._unlock(branch_token, repo_token)
2504
self.repository.unlock()
1385
self._lock_count -= 1
1386
if not self._lock_count:
1387
self._clear_cached_state()
1388
mode = self._lock_mode
1389
self._lock_mode = None
1390
if self._real_branch is not None:
1391
if (not self._leave_lock and mode == 'w' and
1392
self._repo_lock_token):
1393
# If this RemoteBranch will remove the physical lock for the
1394
# repository, make sure the _real_branch doesn't do it
1395
# first. (Because the _real_branch's repository is set to
1396
# be the RemoteRepository.)
1397
self._real_branch.repository.leave_lock_in_place()
1398
self._real_branch.unlock()
1400
# Only write-locked branched need to make a remote method call
1401
# to perfom the unlock.
1403
assert self._lock_token, 'Locked, but no token!'
1404
branch_token = self._lock_token
1405
repo_token = self._repo_lock_token
1406
self._lock_token = None
1407
self._repo_lock_token = None
1408
if not self._leave_lock:
1409
self._unlock(branch_token, repo_token)
2506
1411
def break_lock(self):
2507
1412
self._ensure_real()
2517
1422
raise NotImplementedError(self.dont_leave_lock_in_place)
2518
1423
self._leave_lock = False
2521
def get_rev_id(self, revno, history=None):
2523
return _mod_revision.NULL_REVISION
2524
last_revision_info = self.last_revision_info()
2525
ok, result = self.repository.get_rev_id_for_revno(
2526
revno, last_revision_info)
2529
missing_parent = result[1]
2530
# Either the revision named by the server is missing, or its parent
2531
# is. Call get_parent_map to determine which, so that we report a
2533
parent_map = self.repository.get_parent_map([missing_parent])
2534
if missing_parent in parent_map:
2535
missing_parent = parent_map[missing_parent]
2536
raise errors.RevisionNotPresent(missing_parent, self.repository)
2538
def _last_revision_info(self):
2539
response = self._call('Branch.last_revision_info', self._remote_path())
2540
if response[0] != 'ok':
2541
raise SmartProtocolError('unexpected response code %s' % (response,))
1425
def last_revision_info(self):
1426
"""See Branch.last_revision_info()."""
1427
path = self.bzrdir._path_for_remote_call(self._client)
1428
response = self._client.call('Branch.last_revision_info', path)
1429
assert response[0] == 'ok', 'unexpected response code %s' % (response,)
2542
1430
revno = int(response[1])
2543
1431
last_revision = response[2]
2544
1432
return (revno, last_revision)
2546
1434
def _gen_revision_history(self):
2547
1435
"""See Branch._gen_revision_history()."""
2548
if self._is_stacked:
2550
return self._real_branch._gen_revision_history()
2551
response_tuple, response_handler = self._call_expecting_body(
2552
'Branch.revision_history', self._remote_path())
2553
if response_tuple[0] != 'ok':
2554
raise errors.UnexpectedSmartServerResponse(response_tuple)
2555
result = response_handler.read_body_bytes().split('\x00')
1436
path = self.bzrdir._path_for_remote_call(self._client)
1437
response = self._client.call_expecting_body(
1438
'Branch.revision_history', path)
1439
assert response[0][0] == 'ok', ('unexpected response code %s'
1441
result = response[1].read_body_bytes().split('\x00')
2556
1442
if result == ['']:
2560
def _remote_path(self):
2561
return self.bzrdir._path_for_remote_call(self._client)
2563
def _set_last_revision_descendant(self, revision_id, other_branch,
2564
allow_diverged=False, allow_overwrite_descendant=False):
2565
# This performs additional work to meet the hook contract; while its
2566
# undesirable, we have to synthesise the revno to call the hook, and
2567
# not calling the hook is worse as it means changes can't be prevented.
2568
# Having calculated this though, we can't just call into
2569
# set_last_revision_info as a simple call, because there is a set_rh
2570
# hook that some folk may still be using.
2571
old_revno, old_revid = self.last_revision_info()
2572
history = self._lefthand_history(revision_id)
2573
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2574
err_context = {'other_branch': other_branch}
2575
response = self._call('Branch.set_last_revision_ex',
2576
self._remote_path(), self._lock_token, self._repo_lock_token,
2577
revision_id, int(allow_diverged), int(allow_overwrite_descendant),
2579
self._clear_cached_state()
2580
if len(response) != 3 and response[0] != 'ok':
2581
raise errors.UnexpectedSmartServerResponse(response)
2582
new_revno, new_revision_id = response[1:]
2583
self._last_revision_info_cache = new_revno, new_revision_id
2584
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2585
if self._real_branch is not None:
2586
cache = new_revno, new_revision_id
2587
self._real_branch._last_revision_info_cache = cache
2589
def _set_last_revision(self, revision_id):
2590
old_revno, old_revid = self.last_revision_info()
2591
# This performs additional work to meet the hook contract; while its
2592
# undesirable, we have to synthesise the revno to call the hook, and
2593
# not calling the hook is worse as it means changes can't be prevented.
2594
# Having calculated this though, we can't just call into
2595
# set_last_revision_info as a simple call, because there is a set_rh
2596
# hook that some folk may still be using.
2597
history = self._lefthand_history(revision_id)
2598
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2599
self._clear_cached_state()
2600
response = self._call('Branch.set_last_revision',
2601
self._remote_path(), self._lock_token, self._repo_lock_token,
2603
if response != ('ok',):
2604
raise errors.UnexpectedSmartServerResponse(response)
2605
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2607
1446
@needs_write_lock
2608
1447
def set_revision_history(self, rev_history):
2609
1448
# Send just the tip revision of the history; the server will generate
2610
1449
# the full history from that. If the revision doesn't exist in this
2611
1450
# branch, NoSuchRevision will be raised.
1451
path = self.bzrdir._path_for_remote_call(self._client)
2612
1452
if rev_history == []:
2613
1453
rev_id = 'null:'
2615
1455
rev_id = rev_history[-1]
2616
self._set_last_revision(rev_id)
2617
for hook in branch.Branch.hooks['set_rh']:
2618
hook(self, rev_history)
1456
self._clear_cached_state()
1457
response = self._client.call('Branch.set_last_revision',
1458
path, self._lock_token, self._repo_lock_token, rev_id)
1459
if response[0] == 'NoSuchRevision':
1460
raise NoSuchRevision(self, rev_id)
1462
assert response == ('ok',), (
1463
'unexpected response code %r' % (response,))
2619
1464
self._cache_revision_history(rev_history)
2621
def _get_parent_location(self):
2622
medium = self._client._medium
2623
if medium._is_remote_before((1, 13)):
2624
return self._vfs_get_parent_location()
2626
response = self._call('Branch.get_parent', self._remote_path())
2627
except errors.UnknownSmartMethod:
2628
medium._remember_remote_is_before((1, 13))
2629
return self._vfs_get_parent_location()
2630
if len(response) != 1:
2631
raise errors.UnexpectedSmartServerResponse(response)
2632
parent_location = response[0]
2633
if parent_location == '':
2635
return parent_location
2637
def _vfs_get_parent_location(self):
2639
return self._real_branch._get_parent_location()
2641
def _set_parent_location(self, url):
2642
medium = self._client._medium
2643
if medium._is_remote_before((1, 15)):
2644
return self._vfs_set_parent_location(url)
2646
call_url = url or ''
2647
if type(call_url) is not str:
2648
raise AssertionError('url must be a str or None (%s)' % url)
2649
response = self._call('Branch.set_parent_location',
2650
self._remote_path(), self._lock_token, self._repo_lock_token,
2652
except errors.UnknownSmartMethod:
2653
medium._remember_remote_is_before((1, 15))
2654
return self._vfs_set_parent_location(url)
2656
raise errors.UnexpectedSmartServerResponse(response)
2658
def _vfs_set_parent_location(self, url):
2660
return self._real_branch._set_parent_location(url)
1466
def get_parent(self):
1468
return self._real_branch.get_parent()
1470
def set_parent(self, url):
1472
return self._real_branch.set_parent(url)
1474
def get_config(self):
1475
return RemoteBranchConfig(self)
1477
def sprout(self, to_bzrdir, revision_id=None):
1478
# Like Branch.sprout, except that it sprouts a branch in the default
1479
# format, because RemoteBranches can't be created at arbitrary URLs.
1480
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1481
# to_bzrdir.create_branch...
1483
result = self._real_branch._format.initialize(to_bzrdir)
1484
self.copy_content_into(result, revision_id=revision_id)
1485
result.set_parent(self.bzrdir.root_transport.base)
2662
1488
@needs_write_lock
2663
1489
def pull(self, source, overwrite=False, stop_revision=None,
2665
self._clear_cached_state_of_remote_branch_only()
1491
# FIXME: This asks the real branch to run the hooks, which means
1492
# they're called with the wrong target branch parameter.
1493
# The test suite specifically allows this at present but it should be
1494
# fixed. It should get a _override_hook_target branch,
1495
# as push does. -- mbp 20070405
2666
1496
self._ensure_real()
2667
return self._real_branch.pull(
1497
self._real_branch.pull(
2668
1498
source, overwrite=overwrite, stop_revision=stop_revision,
2669
_override_hook_target=self, **kwargs)
2671
1501
@needs_read_lock
2672
1502
def push(self, target, overwrite=False, stop_revision=None):
2678
1508
def is_locked(self):
2679
1509
return self._lock_count >= 1
2682
def revision_id_to_revno(self, revision_id):
2684
return self._real_branch.revision_id_to_revno(revision_id)
2687
1511
def set_last_revision_info(self, revno, revision_id):
2688
# XXX: These should be returned by the set_last_revision_info verb
2689
old_revno, old_revid = self.last_revision_info()
2690
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2691
revision_id = ensure_null(revision_id)
2693
response = self._call('Branch.set_last_revision_info',
2694
self._remote_path(), self._lock_token, self._repo_lock_token,
2695
str(revno), revision_id)
2696
except errors.UnknownSmartMethod:
2698
self._clear_cached_state_of_remote_branch_only()
2699
self._real_branch.set_last_revision_info(revno, revision_id)
2700
self._last_revision_info_cache = revno, revision_id
2702
if response == ('ok',):
2703
self._clear_cached_state()
2704
self._last_revision_info_cache = revno, revision_id
2705
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2706
# Update the _real_branch's cache too.
2707
if self._real_branch is not None:
2708
cache = self._last_revision_info_cache
2709
self._real_branch._last_revision_info_cache = cache
2711
raise errors.UnexpectedSmartServerResponse(response)
1513
self._clear_cached_state()
1514
return self._real_branch.set_last_revision_info(revno, revision_id)
2714
1516
def generate_revision_history(self, revision_id, last_rev=None,
2715
1517
other_branch=None):
2716
medium = self._client._medium
2717
if not medium._is_remote_before((1, 6)):
2718
# Use a smart method for 1.6 and above servers
2720
self._set_last_revision_descendant(revision_id, other_branch,
2721
allow_diverged=True, allow_overwrite_descendant=True)
2723
except errors.UnknownSmartMethod:
2724
medium._remember_remote_is_before((1, 6))
2725
self._clear_cached_state_of_remote_branch_only()
2726
self.set_revision_history(self._lefthand_history(revision_id,
2727
last_rev=last_rev,other_branch=other_branch))
1519
return self._real_branch.generate_revision_history(
1520
revision_id, last_rev=last_rev, other_branch=other_branch)
1525
return self._real_branch.tags
2729
1527
def set_push_location(self, location):
2730
1528
self._ensure_real()
2731
1529
return self._real_branch.set_push_location(location)
2734
class RemoteConfig(object):
2735
"""A Config that reads and writes from smart verbs.
2737
It is a low-level object that considers config data to be name/value pairs
2738
that may be associated with a section. Assigning meaning to the these
2739
values is done at higher levels like bzrlib.config.TreeConfig.
2742
def get_option(self, name, section=None, default=None):
2743
"""Return the value associated with a named option.
2745
:param name: The name of the value
2746
:param section: The section the option is in (if any)
2747
:param default: The value to return if the value is not set
2748
:return: The value or default value
2751
configobj = self._get_configobj()
2753
section_obj = configobj
2756
section_obj = configobj[section]
2759
return section_obj.get(name, default)
2760
except errors.UnknownSmartMethod:
2761
return self._vfs_get_option(name, section, default)
2763
def _response_to_configobj(self, response):
2764
if len(response[0]) and response[0][0] != 'ok':
2765
raise errors.UnexpectedSmartServerResponse(response)
2766
lines = response[1].read_body_bytes().splitlines()
2767
return config.ConfigObj(lines, encoding='utf-8')
2770
class RemoteBranchConfig(RemoteConfig):
2771
"""A RemoteConfig for Branches."""
2773
def __init__(self, branch):
2774
self._branch = branch
2776
def _get_configobj(self):
2777
path = self._branch._remote_path()
2778
response = self._branch._client.call_expecting_body(
2779
'Branch.get_config_file', path)
2780
return self._response_to_configobj(response)
2782
def set_option(self, value, name, section=None):
2783
"""Set the value associated with a named option.
2785
:param value: The value to set
2786
:param name: The name of the value to set
2787
:param section: The section the option is in (if any)
2789
medium = self._branch._client._medium
2790
if medium._is_remote_before((1, 14)):
2791
return self._vfs_set_option(value, name, section)
2792
if isinstance(value, dict):
2793
if medium._is_remote_before((2, 2)):
2794
return self._vfs_set_option(value, name, section)
2795
return self._set_config_option_dict(value, name, section)
2797
return self._set_config_option(value, name, section)
2799
def _set_config_option(self, value, name, section):
2801
path = self._branch._remote_path()
2802
response = self._branch._client.call('Branch.set_config_option',
2803
path, self._branch._lock_token, self._branch._repo_lock_token,
2804
value.encode('utf8'), name, section or '')
2805
except errors.UnknownSmartMethod:
2806
medium = self._branch._client._medium
2807
medium._remember_remote_is_before((1, 14))
2808
return self._vfs_set_option(value, name, section)
2810
raise errors.UnexpectedSmartServerResponse(response)
2812
def _serialize_option_dict(self, option_dict):
2814
for key, value in option_dict.items():
2815
if isinstance(key, unicode):
2816
key = key.encode('utf8')
2817
if isinstance(value, unicode):
2818
value = value.encode('utf8')
2819
utf8_dict[key] = value
2820
return bencode.bencode(utf8_dict)
2822
def _set_config_option_dict(self, value, name, section):
2824
path = self._branch._remote_path()
2825
serialised_dict = self._serialize_option_dict(value)
2826
response = self._branch._client.call(
2827
'Branch.set_config_option_dict',
2828
path, self._branch._lock_token, self._branch._repo_lock_token,
2829
serialised_dict, name, section or '')
2830
except errors.UnknownSmartMethod:
2831
medium = self._branch._client._medium
2832
medium._remember_remote_is_before((2, 2))
2833
return self._vfs_set_option(value, name, section)
2835
raise errors.UnexpectedSmartServerResponse(response)
2837
def _real_object(self):
2838
self._branch._ensure_real()
2839
return self._branch._real_branch
2841
def _vfs_set_option(self, value, name, section=None):
2842
return self._real_object()._get_config().set_option(
2843
value, name, section)
2846
class RemoteBzrDirConfig(RemoteConfig):
2847
"""A RemoteConfig for BzrDirs."""
2849
def __init__(self, bzrdir):
2850
self._bzrdir = bzrdir
2852
def _get_configobj(self):
2853
medium = self._bzrdir._client._medium
2854
verb = 'BzrDir.get_config_file'
2855
if medium._is_remote_before((1, 15)):
2856
raise errors.UnknownSmartMethod(verb)
2857
path = self._bzrdir._path_for_remote_call(self._bzrdir._client)
2858
response = self._bzrdir._call_expecting_body(
2860
return self._response_to_configobj(response)
2862
def _vfs_get_option(self, name, section, default):
2863
return self._real_object()._get_config().get_option(
2864
name, section, default)
2866
def set_option(self, value, name, section=None):
2867
"""Set the value associated with a named option.
2869
:param value: The value to set
2870
:param name: The name of the value to set
2871
:param section: The section the option is in (if any)
2873
return self._real_object()._get_config().set_option(
2874
value, name, section)
2876
def _real_object(self):
2877
self._bzrdir._ensure_real()
2878
return self._bzrdir._real_bzrdir
1531
def update_revisions(self, other, stop_revision=None, overwrite=False):
1533
return self._real_branch.update_revisions(
1534
other, stop_revision=stop_revision, overwrite=overwrite)
1537
class RemoteBranchConfig(BranchConfig):
1540
self.branch._ensure_real()
1541
return self.branch._real_branch.get_config().username()
1543
def _get_branch_data_config(self):
1544
self.branch._ensure_real()
1545
if self._branch_data_config is None:
1546
self._branch_data_config = TreeConfig(self.branch._real_branch)
1547
return self._branch_data_config
2882
1550
def _extract_tar(tar, to_dir):
2887
1555
for tarinfo in tar:
2888
1556
tar.extract(tarinfo, to_dir)
2891
def _translate_error(err, **context):
2892
"""Translate an ErrorFromSmartServer into a more useful error.
2894
Possible context keys:
2902
If the error from the server doesn't match a known pattern, then
2903
UnknownErrorFromSmartServer is raised.
2907
return context[name]
2908
except KeyError, key_err:
2909
mutter('Missing key %r in context %r', key_err.args[0], context)
2912
"""Get the path from the context if present, otherwise use first error
2916
return context['path']
2917
except KeyError, key_err:
2919
return err.error_args[0]
2920
except IndexError, idx_err:
2922
'Missing key %r in context %r', key_err.args[0], context)
2925
if err.error_verb == 'IncompatibleRepositories':
2926
raise errors.IncompatibleRepositories(err.error_args[0],
2927
err.error_args[1], err.error_args[2])
2928
elif err.error_verb == 'NoSuchRevision':
2929
raise NoSuchRevision(find('branch'), err.error_args[0])
2930
elif err.error_verb == 'nosuchrevision':
2931
raise NoSuchRevision(find('repository'), err.error_args[0])
2932
elif err.error_verb == 'nobranch':
2933
if len(err.error_args) >= 1:
2934
extra = err.error_args[0]
2937
raise errors.NotBranchError(path=find('bzrdir').root_transport.base,
2939
elif err.error_verb == 'norepository':
2940
raise errors.NoRepositoryPresent(find('bzrdir'))
2941
elif err.error_verb == 'LockContention':
2942
raise errors.LockContention('(remote lock)')
2943
elif err.error_verb == 'UnlockableTransport':
2944
raise errors.UnlockableTransport(find('bzrdir').root_transport)
2945
elif err.error_verb == 'LockFailed':
2946
raise errors.LockFailed(err.error_args[0], err.error_args[1])
2947
elif err.error_verb == 'TokenMismatch':
2948
raise errors.TokenMismatch(find('token'), '(remote token)')
2949
elif err.error_verb == 'Diverged':
2950
raise errors.DivergedBranches(find('branch'), find('other_branch'))
2951
elif err.error_verb == 'TipChangeRejected':
2952
raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
2953
elif err.error_verb == 'UnstackableBranchFormat':
2954
raise errors.UnstackableBranchFormat(*err.error_args)
2955
elif err.error_verb == 'UnstackableRepositoryFormat':
2956
raise errors.UnstackableRepositoryFormat(*err.error_args)
2957
elif err.error_verb == 'NotStacked':
2958
raise errors.NotStacked(branch=find('branch'))
2959
elif err.error_verb == 'PermissionDenied':
2961
if len(err.error_args) >= 2:
2962
extra = err.error_args[1]
2965
raise errors.PermissionDenied(path, extra=extra)
2966
elif err.error_verb == 'ReadError':
2968
raise errors.ReadError(path)
2969
elif err.error_verb == 'NoSuchFile':
2971
raise errors.NoSuchFile(path)
2972
elif err.error_verb == 'FileExists':
2973
raise errors.FileExists(err.error_args[0])
2974
elif err.error_verb == 'DirectoryNotEmpty':
2975
raise errors.DirectoryNotEmpty(err.error_args[0])
2976
elif err.error_verb == 'ShortReadvError':
2977
args = err.error_args
2978
raise errors.ShortReadvError(
2979
args[0], int(args[1]), int(args[2]), int(args[3]))
2980
elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
2981
encoding = str(err.error_args[0]) # encoding must always be a string
2982
val = err.error_args[1]
2983
start = int(err.error_args[2])
2984
end = int(err.error_args[3])
2985
reason = str(err.error_args[4]) # reason must always be a string
2986
if val.startswith('u:'):
2987
val = val[2:].decode('utf-8')
2988
elif val.startswith('s:'):
2989
val = val[2:].decode('base64')
2990
if err.error_verb == 'UnicodeDecodeError':
2991
raise UnicodeDecodeError(encoding, val, start, end, reason)
2992
elif err.error_verb == 'UnicodeEncodeError':
2993
raise UnicodeEncodeError(encoding, val, start, end, reason)
2994
elif err.error_verb == 'ReadOnlyError':
2995
raise errors.TransportNotPossible('readonly transport')
2996
raise errors.UnknownErrorFromSmartServer(err)
added
removed
bzrlib/remote.py
