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 (
31
repository as _mod_repository,
33
revision as _mod_revision,
37
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
33
from bzrlib.branch import BranchReferenceFormat
38
34
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
39
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
40
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 (
44
from bzrlib.lockable_files import LockableFiles
45
from bzrlib.smart import client, vfs, repository as smart_repo
46
from bzrlib.revision import ensure_null, NULL_REVISION
47
from bzrlib.repository import RepositoryWriteLockResult
45
from bzrlib.revision import NULL_REVISION
48
46
from bzrlib.trace import mutter, note, warning
51
class _RpcHelper(object):
52
"""Mixin class that helps with issuing RPCs."""
54
def _call(self, method, *args, **err_context):
56
return self._client.call(method, *args)
57
except errors.ErrorFromSmartServer, err:
58
self._translate_error(err, **err_context)
60
def _call_expecting_body(self, method, *args, **err_context):
62
return self._client.call_expecting_body(method, *args)
63
except errors.ErrorFromSmartServer, err:
64
self._translate_error(err, **err_context)
66
def _call_with_body_bytes(self, method, args, body_bytes, **err_context):
68
return self._client.call_with_body_bytes(method, args, body_bytes)
69
except errors.ErrorFromSmartServer, err:
70
self._translate_error(err, **err_context)
72
def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
75
return self._client.call_with_body_bytes_expecting_body(
76
method, args, body_bytes)
77
except errors.ErrorFromSmartServer, err:
78
self._translate_error(err, **err_context)
81
def response_tuple_to_repo_format(response):
82
"""Convert a response tuple describing a repository format to a format."""
83
format = RemoteRepositoryFormat()
84
format._rich_root_data = (response[0] == 'yes')
85
format._supports_tree_reference = (response[1] == 'yes')
86
format._supports_external_lookups = (response[2] == 'yes')
87
format._network_name = response[3]
91
48
# Note: RemoteBzrDirFormat is in bzrdir.py
93
class RemoteBzrDir(BzrDir, _RpcHelper):
50
class RemoteBzrDir(BzrDir):
94
51
"""Control directory on a remote server, accessed via bzr:// or similar."""
96
def __init__(self, transport, format, _client=None, _force_probe=False):
53
def __init__(self, transport, _client=None):
97
54
"""Construct a RemoteBzrDir.
99
56
:param _client: Private parameter for testing. Disables probing and the
100
57
use of a real bzrdir.
102
BzrDir.__init__(self, transport, format)
59
BzrDir.__init__(self, transport, RemoteBzrDirFormat())
103
60
# this object holds a delegated bzrdir that uses file-level operations
104
61
# to talk to the other side
105
62
self._real_bzrdir = None
106
self._has_working_tree = None
107
# 1-shot cache for the call pattern 'create_branch; open_branch' - see
108
# create_branch for details.
109
self._next_open_branch_result = None
111
64
if _client is None:
112
65
medium = transport.get_smart_medium()
113
self._client = client._SmartClient(medium)
66
self._client = client._SmartClient(medium, transport.base)
115
68
self._client = _client
122
return '%s(%r)' % (self.__class__.__name__, self._client)
124
def _probe_bzrdir(self):
125
medium = self._client._medium
126
71
path = self._path_for_remote_call(self._client)
127
if medium._is_remote_before((2, 1)):
131
self._rpc_open_2_1(path)
133
except errors.UnknownSmartMethod:
134
medium._remember_remote_is_before((2, 1))
137
def _rpc_open_2_1(self, path):
138
response = self._call('BzrDir.open_2.1', path)
139
if response == ('no',):
140
raise errors.NotBranchError(path=self.root_transport.base)
141
elif response[0] == 'yes':
142
if response[1] == 'yes':
143
self._has_working_tree = True
144
elif response[1] == 'no':
145
self._has_working_tree = False
147
raise errors.UnexpectedSmartServerResponse(response)
149
raise errors.UnexpectedSmartServerResponse(response)
151
def _rpc_open(self, path):
152
response = self._call('BzrDir.open', path)
72
response = self._client.call('BzrDir.open', path)
153
73
if response not in [('yes',), ('no',)]:
154
74
raise errors.UnexpectedSmartServerResponse(response)
155
75
if response == ('no',):
156
raise errors.NotBranchError(path=self.root_transport.base)
76
raise errors.NotBranchError(path=transport.base)
158
78
def _ensure_real(self):
159
79
"""Ensure that there is a _real_bzrdir set.
161
81
Used before calls to self._real_bzrdir.
163
83
if not self._real_bzrdir:
164
if 'hpssvfs' in debug.debug_flags:
166
warning('VFS BzrDir access triggered\n%s',
167
''.join(traceback.format_stack()))
168
84
self._real_bzrdir = BzrDir.open_from_transport(
169
85
self.root_transport, _server_formats=False)
170
self._format._network_name = \
171
self._real_bzrdir._format.network_name()
173
def _translate_error(self, err, **context):
174
_translate_error(err, bzrdir=self, **context)
176
def break_lock(self):
177
# Prevent aliasing problems in the next_open_branch_result cache.
178
# See create_branch for rationale.
179
self._next_open_branch_result = None
180
return BzrDir.break_lock(self)
182
def _vfs_cloning_metadir(self, require_stacking=False):
184
return self._real_bzrdir.cloning_metadir(
185
require_stacking=require_stacking)
187
def cloning_metadir(self, require_stacking=False):
188
medium = self._client._medium
189
if medium._is_remote_before((1, 13)):
190
return self._vfs_cloning_metadir(require_stacking=require_stacking)
191
verb = 'BzrDir.cloning_metadir'
196
path = self._path_for_remote_call(self._client)
198
response = self._call(verb, path, stacking)
199
except errors.UnknownSmartMethod:
200
medium._remember_remote_is_before((1, 13))
201
return self._vfs_cloning_metadir(require_stacking=require_stacking)
202
except errors.UnknownErrorFromSmartServer, err:
203
if err.error_tuple != ('BranchReference',):
205
# We need to resolve the branch reference to determine the
206
# cloning_metadir. This causes unnecessary RPCs to open the
207
# referenced branch (and bzrdir, etc) but only when the caller
208
# didn't already resolve the branch reference.
209
referenced_branch = self.open_branch()
210
return referenced_branch.bzrdir.cloning_metadir()
211
if len(response) != 3:
212
raise errors.UnexpectedSmartServerResponse(response)
213
control_name, repo_name, branch_info = response
214
if len(branch_info) != 2:
215
raise errors.UnexpectedSmartServerResponse(response)
216
branch_ref, branch_name = branch_info
217
format = bzrdir.network_format_registry.get(control_name)
219
format.repository_format = repository.network_format_registry.get(
221
if branch_ref == 'ref':
222
# XXX: we need possible_transports here to avoid reopening the
223
# connection to the referenced location
224
ref_bzrdir = BzrDir.open(branch_name)
225
branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
226
format.set_branch_format(branch_format)
227
elif branch_ref == 'branch':
229
format.set_branch_format(
230
branch.network_format_registry.get(branch_name))
232
raise errors.UnexpectedSmartServerResponse(response)
235
87
def create_repository(self, shared=False):
236
# as per meta1 formats - just delegate to the format object which may
238
result = self._format.repository_format.initialize(self, shared)
239
if not isinstance(result, RemoteRepository):
240
return self.open_repository()
89
self._real_bzrdir.create_repository(shared=shared)
90
return self.open_repository()
244
92
def destroy_repository(self):
245
93
"""See BzrDir.destroy_repository"""
246
94
self._ensure_real()
247
95
self._real_bzrdir.destroy_repository()
249
def create_branch(self, name=None):
250
# as per meta1 formats - just delegate to the format object which may
252
real_branch = self._format.get_branch_format().initialize(self,
254
if not isinstance(real_branch, RemoteBranch):
255
result = RemoteBranch(self, self.find_repository(), real_branch,
259
# BzrDir.clone_on_transport() uses the result of create_branch but does
260
# not return it to its callers; we save approximately 8% of our round
261
# trips by handing the branch we created back to the first caller to
262
# open_branch rather than probing anew. Long term we need a API in
263
# bzrdir that doesn't discard result objects (like result_branch).
265
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)
268
def destroy_branch(self, name=None):
102
def destroy_branch(self):
269
103
"""See BzrDir.destroy_branch"""
270
104
self._ensure_real()
271
self._real_bzrdir.destroy_branch(name=name)
272
self._next_open_branch_result = None
105
self._real_bzrdir.destroy_branch()
274
107
def create_workingtree(self, revision_id=None, from_branch=None):
275
108
raise errors.NotLocalUrl(self.transport.base)
277
def find_branch_format(self, name=None):
110
def find_branch_format(self):
278
111
"""Find the branch 'format' for this bzrdir.
280
113
This might be a synthetic object for e.g. RemoteBranch and SVN.
282
b = self.open_branch(name=name)
115
b = self.open_branch()
285
def get_branch_reference(self, name=None):
118
def get_branch_reference(self):
286
119
"""See BzrDir.get_branch_reference()."""
288
# XXX JRV20100304: Support opening colocated branches
289
raise errors.NoColocatedBranchSupport(self)
290
response = self._get_branch_reference()
291
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)
296
def _get_branch_reference(self):
297
path = self._path_for_remote_call(self._client)
298
medium = self._client._medium
300
('BzrDir.open_branchV3', (2, 1)),
301
('BzrDir.open_branchV2', (1, 13)),
302
('BzrDir.open_branch', None),
304
for verb, required_version in candidate_calls:
305
if required_version and medium._is_remote_before(required_version):
308
response = self._call(verb, path)
309
except errors.UnknownSmartMethod:
310
if required_version is None:
312
medium._remember_remote_is_before(required_version)
315
if verb == 'BzrDir.open_branch':
316
if response[0] != 'ok':
317
raise errors.UnexpectedSmartServerResponse(response)
318
if response[1] != '':
319
return ('ref', response[1])
321
return ('branch', '')
322
if response[0] not in ('ref', 'branch'):
323
132
raise errors.UnexpectedSmartServerResponse(response)
326
def _get_tree_branch(self, name=None):
134
def _get_tree_branch(self):
327
135
"""See BzrDir._get_tree_branch()."""
328
return None, self.open_branch(name=name)
136
return None, self.open_branch()
330
def open_branch(self, name=None, unsupported=False,
331
ignore_fallbacks=False):
333
raise NotImplementedError('unsupported flag support not implemented yet.')
334
if self._next_open_branch_result is not None:
335
# See create_branch for details.
336
result = self._next_open_branch_result
337
self._next_open_branch_result = None
339
response = self._get_branch_reference()
340
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())
341
145
# a branch reference, use the existing BranchReference logic.
342
146
format = BranchReferenceFormat()
343
return format.open(self, name=name, _found=True,
344
location=response[1], ignore_fallbacks=ignore_fallbacks)
345
branch_format_name = response[1]
346
if not branch_format_name:
347
branch_format_name = None
348
format = RemoteBranchFormat(network_name=branch_format_name)
349
return RemoteBranch(self, self.find_repository(), format=format,
350
setup_stacking=not ignore_fallbacks, name=name)
352
def _open_repo_v1(self, path):
353
verb = 'BzrDir.find_repository'
354
response = self._call(verb, path)
355
if response[0] != 'ok':
356
raise errors.UnexpectedSmartServerResponse(response)
357
# servers that only support the v1 method don't support external
360
repo = self._real_bzrdir.open_repository()
361
response = response + ('no', repo._format.network_name())
362
return response, repo
364
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)
365
151
verb = 'BzrDir.find_repositoryV2'
366
response = self._call(verb, path)
367
if response[0] != 'ok':
368
raise errors.UnexpectedSmartServerResponse(response)
370
repo = self._real_bzrdir.open_repository()
371
response = response + (repo._format.network_name(),)
372
return response, repo
374
def _open_repo_v3(self, path):
375
verb = 'BzrDir.find_repositoryV3'
376
medium = self._client._medium
377
if medium._is_remote_before((1, 13)):
378
raise errors.UnknownSmartMethod(verb)
380
response = self._call(verb, path)
381
except errors.UnknownSmartMethod:
382
medium._remember_remote_is_before((1, 13))
384
if response[0] != 'ok':
385
raise errors.UnexpectedSmartServerResponse(response)
386
return response, None
388
def open_repository(self):
389
path = self._path_for_remote_call(self._client)
391
for probe in [self._open_repo_v3, self._open_repo_v2,
394
response, real_repo = probe(path)
396
except errors.UnknownSmartMethod:
399
raise errors.UnknownSmartMethod('BzrDir.find_repository{3,2,}')
400
if response[0] != 'ok':
401
raise errors.UnexpectedSmartServerResponse(response)
402
if len(response) != 6:
403
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,)
404
168
if response[1] == '':
405
# repo is at this dir.
406
format = response_tuple_to_repo_format(response[2:])
407
# Used to support creating a real format instance when needed.
408
format._creating_bzrdir = self
409
remote_repo = RemoteRepository(self, format)
410
format._creating_repo = remote_repo
411
if real_repo is not None:
412
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)
415
176
raise errors.NoRepositoryPresent(self)
417
def has_workingtree(self):
418
if self._has_working_tree is None:
420
self._has_working_tree = self._real_bzrdir.has_workingtree()
421
return self._has_working_tree
423
178
def open_workingtree(self, recommend_upgrade=True):
424
if self.has_workingtree():
180
if self._real_bzrdir.has_workingtree():
425
181
raise errors.NotLocalUrl(self.root_transport)
427
183
raise errors.NoWorkingTree(self.root_transport.base)
474
223
the attributes rich_root_data and supports_tree_reference are set
475
224
on a per instance basis, and are not set (and should not be) at
478
:ivar _custom_format: If set, a specific concrete repository format that
479
will be used when initializing a repository with this
480
RemoteRepositoryFormat.
481
:ivar _creating_repo: If set, the repository object that this
482
RemoteRepositoryFormat was created for: it can be called into
483
to obtain data like the network name.
486
_matchingbzrdir = RemoteBzrDirFormat()
489
repository.RepositoryFormat.__init__(self)
490
self._custom_format = None
491
self._network_name = None
492
self._creating_bzrdir = None
493
self._supports_chks = None
494
self._supports_external_lookups = None
495
self._supports_tree_reference = None
496
self._rich_root_data = None
499
return "%s(_network_name=%r)" % (self.__class__.__name__,
503
def fast_deltas(self):
505
return self._custom_format.fast_deltas
508
def rich_root_data(self):
509
if self._rich_root_data is None:
511
self._rich_root_data = self._custom_format.rich_root_data
512
return self._rich_root_data
515
def supports_chks(self):
516
if self._supports_chks is None:
518
self._supports_chks = self._custom_format.supports_chks
519
return self._supports_chks
522
def supports_external_lookups(self):
523
if self._supports_external_lookups is None:
525
self._supports_external_lookups = \
526
self._custom_format.supports_external_lookups
527
return self._supports_external_lookups
530
def supports_tree_reference(self):
531
if self._supports_tree_reference is None:
533
self._supports_tree_reference = \
534
self._custom_format.supports_tree_reference
535
return self._supports_tree_reference
537
def _vfs_initialize(self, a_bzrdir, shared):
538
"""Helper for common code in initialize."""
539
if self._custom_format:
540
# Custom format requested
541
result = self._custom_format.initialize(a_bzrdir, shared=shared)
542
elif self._creating_bzrdir is not None:
543
# Use the format that the repository we were created to back
545
prior_repo = self._creating_bzrdir.open_repository()
546
prior_repo._ensure_real()
547
result = prior_repo._real_repository._format.initialize(
548
a_bzrdir, shared=shared)
550
# assume that a_bzr is a RemoteBzrDir but the smart server didn't
551
# support remote initialization.
552
# We delegate to a real object at this point (as RemoteBzrDir
553
# delegate to the repository format which would lead to infinite
554
# recursion if we just called a_bzrdir.create_repository.
555
a_bzrdir._ensure_real()
556
result = a_bzrdir._real_bzrdir.create_repository(shared=shared)
557
if not isinstance(result, RemoteRepository):
558
return self.open(a_bzrdir)
228
_matchingbzrdir = RemoteBzrDirFormat
562
230
def initialize(self, a_bzrdir, shared=False):
563
# Being asked to create on a non RemoteBzrDir:
564
if not isinstance(a_bzrdir, RemoteBzrDir):
565
return self._vfs_initialize(a_bzrdir, shared)
566
medium = a_bzrdir._client._medium
567
if medium._is_remote_before((1, 13)):
568
return self._vfs_initialize(a_bzrdir, shared)
569
# Creating on a remote bzr dir.
570
# 1) get the network name to use.
571
if self._custom_format:
572
network_name = self._custom_format.network_name()
573
elif self._network_name:
574
network_name = self._network_name
576
# Select the current bzrlib default and ask for that.
577
reference_bzrdir_format = bzrdir.format_registry.get('default')()
578
reference_format = reference_bzrdir_format.repository_format
579
network_name = reference_format.network_name()
580
# 2) try direct creation via RPC
581
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
582
verb = 'BzrDir.create_repository'
588
response = a_bzrdir._call(verb, path, network_name, shared_str)
589
except errors.UnknownSmartMethod:
590
# Fallback - use vfs methods
591
medium._remember_remote_is_before((1, 13))
592
return self._vfs_initialize(a_bzrdir, shared)
594
# Turn the response into a RemoteRepository object.
595
format = response_tuple_to_repo_format(response[1:])
596
# Used to support creating a real format instance when needed.
597
format._creating_bzrdir = a_bzrdir
598
remote_repo = RemoteRepository(a_bzrdir, format)
599
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)
602
235
def open(self, a_bzrdir):
603
if not isinstance(a_bzrdir, RemoteBzrDir):
604
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
236
assert isinstance(a_bzrdir, RemoteBzrDir)
605
237
return a_bzrdir.open_repository()
607
def _ensure_real(self):
608
if self._custom_format is None:
609
self._custom_format = repository.network_format_registry.get(
613
def _fetch_order(self):
615
return self._custom_format._fetch_order
618
def _fetch_uses_deltas(self):
620
return self._custom_format._fetch_uses_deltas
623
def _fetch_reconcile(self):
625
return self._custom_format._fetch_reconcile
627
239
def get_format_description(self):
629
return 'Remote: ' + self._custom_format.get_format_description()
240
return 'bzr remote repository'
631
242
def __eq__(self, other):
632
return self.__class__ is other.__class__
634
def network_name(self):
635
if self._network_name:
636
return self._network_name
637
self._creating_repo._ensure_real()
638
return self._creating_repo._real_repository._format.network_name()
641
def pack_compresses(self):
643
return self._custom_format.pack_compresses
646
def _serializer(self):
648
return self._custom_format._serializer
651
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
652
controldir.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):
653
256
"""Repository accessed over rpc.
655
258
For the moment most operations are performed using local transport-backed
749
325
self._ensure_real()
750
326
return self._real_repository.commit_write_group()
752
def resume_write_group(self, tokens):
754
return self._real_repository.resume_write_group(tokens)
756
def suspend_write_group(self):
758
return self._real_repository.suspend_write_group()
760
def get_missing_parent_inventories(self, check_for_missing_texts=True):
762
return self._real_repository.get_missing_parent_inventories(
763
check_for_missing_texts=check_for_missing_texts)
765
def _get_rev_id_for_revno_vfs(self, revno, known_pair):
767
return self._real_repository.get_rev_id_for_revno(
770
def get_rev_id_for_revno(self, revno, known_pair):
771
"""See Repository.get_rev_id_for_revno."""
772
path = self.bzrdir._path_for_remote_call(self._client)
774
if self._client._medium._is_remote_before((1, 17)):
775
return self._get_rev_id_for_revno_vfs(revno, known_pair)
776
response = self._call(
777
'Repository.get_rev_id_for_revno', path, revno, known_pair)
778
except errors.UnknownSmartMethod:
779
self._client._medium._remember_remote_is_before((1, 17))
780
return self._get_rev_id_for_revno_vfs(revno, known_pair)
781
if response[0] == 'ok':
782
return True, response[1]
783
elif response[0] == 'history-incomplete':
784
known_pair = response[1:3]
785
for fallback in self._fallback_repositories:
786
found, result = fallback.get_rev_id_for_revno(revno, known_pair)
791
# Not found in any fallbacks
792
return False, known_pair
794
raise errors.UnexpectedSmartServerResponse(response)
796
328
def _ensure_real(self):
797
329
"""Ensure that there is a _real_repository set.
799
331
Used before calls to self._real_repository.
801
Note that _ensure_real causes many roundtrips to the server which are
802
not desirable, and prevents the use of smart one-roundtrip RPC's to
803
perform complex operations (such as accessing parent data, streaming
804
revisions etc). Adding calls to _ensure_real should only be done when
805
bringing up new functionality, adding fallbacks for smart methods that
806
require a fallback path, and never to replace an existing smart method
807
invocation. If in doubt chat to the bzr network team.
809
if self._real_repository is None:
810
if 'hpssvfs' in debug.debug_flags:
812
warning('VFS Repository access triggered\n%s',
813
''.join(traceback.format_stack()))
814
self._unstacked_provider.missing_keys.clear()
333
if not self._real_repository:
815
334
self.bzrdir._ensure_real()
816
self._set_real_repository(
817
self.bzrdir._real_bzrdir.open_repository())
819
def _translate_error(self, err, **context):
820
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())
822
338
def find_text_key_references(self):
823
339
"""Find the text key references within the repository.
854
375
path = self.bzrdir._path_for_remote_call(self._client)
855
response = self._call_expecting_body(
376
assert type(revision_id) is str
377
response = self._client.call_expecting_body(
856
378
'Repository.get_revision_graph', path, revision_id)
857
response_tuple, response_handler = response
858
if response_tuple[0] != 'ok':
859
raise errors.UnexpectedSmartServerResponse(response_tuple)
860
coded = response_handler.read_body_bytes()
862
# no revisions in this repository!
864
lines = coded.split('\n')
867
d = tuple(line.split())
868
revision_graph[d[0]] = d[1:]
870
return revision_graph
873
"""See Repository._get_sink()."""
874
return RemoteStreamSink(self)
876
def _get_source(self, to_format):
877
"""Return a source for streaming from this repository."""
878
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)
881
398
def has_revision(self, revision_id):
882
"""True if this repository has a copy of the revision."""
883
# Copy of bzrlib.repository.Repository.has_revision
884
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'
887
408
def has_revisions(self, revision_ids):
888
"""Probe to find out the presence of multiple revisions.
890
:param revision_ids: An iterable of revision_ids.
891
:return: A set of the revision_ids that were present.
893
# Copy of bzrlib.repository.Repository.has_revisions
894
parent_map = self.get_parent_map(revision_ids)
895
result = set(parent_map)
896
if _mod_revision.NULL_REVISION in revision_ids:
897
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)
900
def _has_same_fallbacks(self, other_repo):
901
"""Returns true if the repositories have the same fallbacks."""
902
# XXX: copied from Repository; it should be unified into a base class
903
# <https://bugs.launchpad.net/bzr/+bug/401622>
904
my_fb = self._fallback_repositories
905
other_fb = other_repo._fallback_repositories
906
if len(my_fb) != len(other_fb):
908
for f, g in zip(my_fb, other_fb):
909
if not f.has_same_location(g):
913
416
def has_same_location(self, other):
914
# TODO: Move to RepositoryBase and unify with the regular Repository
915
# one; unfortunately the tests rely on slightly different behaviour at
916
# present -- mbp 20090710
917
return (self.__class__ is other.__class__ and
417
return (self.__class__ == other.__class__ and
918
418
self.bzrdir.transport.base == other.bzrdir.transport.base)
920
420
def get_graph(self, other_repository=None):
921
421
"""Return the graph for this repository format"""
922
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()])
923
428
return graph.Graph(parents_provider)
926
def get_known_graph_ancestry(self, revision_ids):
927
"""Return the known graph for a set of revision ids and their ancestors.
929
st = static_tuple.StaticTuple
930
revision_keys = [st(r_id).intern() for r_id in revision_ids]
931
known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
932
return graph.GraphThunkIdsToKeys(known_graph)
934
430
def gather_stats(self, revid=None, committers=None):
935
431
"""See Repository.gather_stats()."""
936
432
path = self.bzrdir._path_for_remote_call(self._client)
988
484
def is_shared(self):
989
485
"""See Repository.is_shared()."""
990
486
path = self.bzrdir._path_for_remote_call(self._client)
991
response = self._call('Repository.is_shared', path)
992
if response[0] not in ('yes', 'no'):
993
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,)
994
489
return response[0] == 'yes'
996
491
def is_write_locked(self):
997
492
return self._lock_mode == 'w'
999
def _warn_if_deprecated(self, branch=None):
1000
# If we have a real repository, the check will be done there, if we
1001
# don't the check will be done remotely.
1004
494
def lock_read(self):
1005
"""Lock the repository for read operations.
1007
:return: A bzrlib.lock.LogicalLockResult.
1009
495
# wrong eventually - want a local lock cache context
1010
496
if not self._lock_mode:
1011
self._note_lock('r')
1012
497
self._lock_mode = 'r'
1013
498
self._lock_count = 1
1014
self._unstacked_provider.enable_cache(cache_misses=True)
499
self._parents_map = {}
500
if 'hpss' in debug.debug_flags:
501
self._requested_parents = set()
1015
502
if self._real_repository is not None:
1016
503
self._real_repository.lock_read()
1017
for repo in self._fallback_repositories:
1020
505
self._lock_count += 1
1021
return lock.LogicalLockResult(self.unlock)
1023
507
def _remote_lock_write(self, token):
1024
508
path = self.bzrdir._path_for_remote_call(self._client)
1025
509
if token is None:
1027
err_context = {'token': token}
1028
response = self._call('Repository.lock_write', path, token,
511
response = self._client.call('Repository.lock_write', path, token)
1030
512
if response[0] == 'ok':
1031
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])
1034
522
raise errors.UnexpectedSmartServerResponse(response)
1036
def lock_write(self, token=None, _skip_rpc=False):
524
def lock_write(self, token=None):
1037
525
if not self._lock_mode:
1038
self._note_lock('w')
1040
if self._lock_token is not None:
1041
if token != self._lock_token:
1042
raise errors.TokenMismatch(token, self._lock_token)
1043
self._lock_token = token
1045
self._lock_token = self._remote_lock_write(token)
526
self._lock_token = self._remote_lock_write(token)
1046
527
# if self._lock_token is None, then this is something like packs or
1047
528
# svn where we don't get to lock the repo, or a weave style repository
1048
529
# where we cannot lock it over the wire and attempts to do so will
1228
675
# FIXME: It ought to be possible to call this without immediately
1229
676
# triggering _ensure_real. For now it's the easiest thing to do.
1230
677
self._ensure_real()
1231
real_repo = self._real_repository
1232
builder = real_repo.get_commit_builder(branch, parents,
678
builder = self._real_repository.get_commit_builder(branch, parents,
1233
679
config, timestamp=timestamp, timezone=timezone,
1234
680
committer=committer, revprops=revprops, revision_id=revision_id)
1237
def add_fallback_repository(self, repository):
1238
"""Add a repository to use for looking up data not held locally.
1240
:param repository: A repository.
1242
if not self._format.supports_external_lookups:
1243
raise errors.UnstackableRepositoryFormat(
1244
self._format.network_name(), self.base)
1245
# We need to accumulate additional repositories here, to pass them in
1248
if self.is_locked():
1249
# We will call fallback.unlock() when we transition to the unlocked
1250
# state, so always add a lock here. If a caller passes us a locked
1251
# repository, they are responsible for unlocking it later.
1252
repository.lock_read()
1253
self._check_fallback_repository(repository)
1254
self._fallback_repositories.append(repository)
1255
# If self._real_repository was parameterised already (e.g. because a
1256
# _real_branch had its get_stacked_on_url method called), then the
1257
# repository to be added may already be in the _real_repositories list.
1258
if self._real_repository is not None:
1259
fallback_locations = [repo.user_url for repo in
1260
self._real_repository._fallback_repositories]
1261
if repository.user_url not in fallback_locations:
1262
self._real_repository.add_fallback_repository(repository)
1264
def _check_fallback_repository(self, repository):
1265
"""Check that this repository can fallback to repository safely.
1267
Raise an error if not.
1269
:param repository: A repository to fallback to.
1271
return _mod_repository.InterRepository._assert_same_model(
1274
683
def add_inventory(self, revid, inv, parents):
1275
684
self._ensure_real()
1276
685
return self._real_repository.add_inventory(revid, inv, parents)
1278
def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1279
parents, basis_inv=None, propagate_caches=False):
1281
return self._real_repository.add_inventory_by_delta(basis_revision_id,
1282
delta, new_revision_id, parents, basis_inv=basis_inv,
1283
propagate_caches=propagate_caches)
1285
687
def add_revision(self, rev_id, rev, inv=None, config=None):
1286
688
self._ensure_real()
1287
689
return self._real_repository.add_revision(
1353
745
return repository.InterRepository.get(
1354
746
other, self).search_missing_revision_ids(revision_id, find_ghosts)
1356
def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1358
# No base implementation to use as RemoteRepository is not a subclass
1359
# of Repository; so this is a copy of Repository.fetch().
1360
if fetch_spec is not None and revision_id is not None:
1361
raise AssertionError(
1362
"fetch_spec and revision_id are mutually exclusive.")
1363
if self.is_in_write_group():
1364
raise errors.InternalBzrError(
1365
"May not fetch while in a write group.")
1366
# fast path same-url fetch operations
1367
if (self.has_same_location(source)
1368
and fetch_spec is None
1369
and self._has_same_fallbacks(source)):
748
def fetch(self, source, revision_id=None, pb=None):
749
if self.has_same_location(source):
1370
750
# check that last_revision is in 'from' and then return a
1372
752
if (revision_id is not None and
1373
753
not revision.is_null(revision_id)):
1374
754
self.get_revision(revision_id)
1376
# if there is no specific appropriate InterRepository, this will get
1377
# the InterRepository base class, which raises an
1378
# IncompatibleRepositories when asked to fetch.
1379
inter = repository.InterRepository.get(source, self)
1380
return inter.fetch(revision_id=revision_id, pb=pb,
1381
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
757
return self._real_repository.fetch(
758
source, revision_id=revision_id, pb=pb)
1383
760
def create_bundle(self, target, base, fileobj, format=None):
1384
761
self._ensure_real()
1385
762
self._real_repository.create_bundle(target, base, fileobj, format)
765
def control_weaves(self):
767
return self._real_repository.control_weaves
1387
769
@needs_read_lock
1388
770
def get_ancestry(self, revision_id, topo_sorted=True):
1389
771
self._ensure_real()
1390
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()
1392
779
def fileids_altered_by_revision_ids(self, revision_ids):
1393
780
self._ensure_real()
1394
781
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
1397
784
self._ensure_real()
1398
785
return self._real_repository._get_versioned_file_checker(
1399
786
revisions, revision_versions_cache)
1401
788
def iter_files_bytes(self, desired_files):
1402
789
"""See Repository.iter_file_bytes.
1404
791
self._ensure_real()
1405
792
return self._real_repository.iter_files_bytes(desired_files)
1407
def get_parent_map(self, revision_ids):
794
def get_parent_map(self, keys):
1408
795
"""See bzrlib.Graph.get_parent_map()."""
1409
return self._make_parents_provider().get_parent_map(revision_ids)
1411
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):
1412
837
"""Helper for get_parent_map that performs the RPC."""
1413
838
medium = self._client._medium
1414
if medium._is_remote_before((1, 2)):
839
if not medium._remote_is_at_least_1_2:
1415
840
# We already found out that the server can't understand
1416
841
# Repository.get_parent_map requests, so just fetch the whole
1419
# Note that this reads the whole graph, when only some keys are
1420
# wanted. On this old server there's no way (?) to get them all
1421
# in one go, and the user probably will have seen a warning about
1422
# the server being old anyhow.
1423
rg = self._get_revision_graph(None)
1424
# There is an API discrepancy between get_parent_map and
1425
# get_revision_graph. Specifically, a "key:()" pair in
1426
# get_revision_graph just means a node has no parents. For
1427
# "get_parent_map" it means the node is a ghost. So fix up the
1428
# graph to correct this.
1429
# https://bugs.launchpad.net/bzr/+bug/214894
1430
# There is one other "bug" which is that ghosts in
1431
# get_revision_graph() are not returned at all. But we won't worry
1432
# about that for now.
1433
for node_id, parent_ids in rg.iteritems():
1434
if parent_ids == ():
1435
rg[node_id] = (NULL_REVISION,)
1436
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()
1439
849
keys = set(keys)
1441
raise ValueError('get_parent_map(None) is not valid')
1442
850
if NULL_REVISION in keys:
1443
851
keys.discard(NULL_REVISION)
1444
852
found_parents = {NULL_REVISION:()}
1457
865
# TODO: Manage this incrementally to avoid covering the same path
1458
866
# repeatedly. (The server will have to on each request, but the less
1459
867
# work done the better).
1461
# Negative caching notes:
1462
# new server sends missing when a request including the revid
1463
# 'include-missing:' is present in the request.
1464
# missing keys are serialised as missing:X, and we then call
1465
# provider.note_missing(X) for-all X
1466
parents_map = self._unstacked_provider.get_cached_map()
868
parents_map = self._parents_map
1467
869
if parents_map is None:
1468
870
# Repository is not locked, so there's no cache.
1469
871
parents_map = {}
1470
# start_set is all the keys in the cache
1471
872
start_set = set(parents_map)
1472
# result set is all the references to keys in the cache
1473
873
result_parents = set()
1474
874
for parents in parents_map.itervalues():
1475
875
result_parents.update(parents)
1476
876
stop_keys = result_parents.difference(start_set)
1477
# We don't need to send ghosts back to the server as a position to
1479
stop_keys.difference_update(self._unstacked_provider.missing_keys)
1480
key_count = len(parents_map)
1481
if (NULL_REVISION in result_parents
1482
and NULL_REVISION in self._unstacked_provider.missing_keys):
1483
# If we pruned NULL_REVISION from the stop_keys because it's also
1484
# in our cache of "missing" keys we need to increment our key count
1485
# by 1, because the reconsitituted SearchResult on the server will
1486
# still consider NULL_REVISION to be an included key.
1488
877
included_keys = start_set.intersection(result_parents)
1489
878
start_set.difference_update(included_keys)
1490
recipe = ('manual', start_set, stop_keys, key_count)
879
recipe = (start_set, stop_keys, len(parents_map))
1491
880
body = self._serialise_search_recipe(recipe)
1492
881
path = self.bzrdir._path_for_remote_call(self._client)
1493
882
for key in keys:
1494
if type(key) is not str:
1496
"key %r not a plain string" % (key,))
883
assert type(key) is str
1497
884
verb = 'Repository.get_parent_map'
1498
args = (path, 'include-missing:') + tuple(keys)
1500
response = self._call_with_body_bytes_expecting_body(
1502
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):
1503
889
# Server does not support this method, so get the whole graph.
1504
890
# Worse, we have to force a disconnection, because the server now
1505
891
# doesn't realise it has a body on the wire to consume, so the
1719
1053
self._ensure_real()
1720
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)
1722
1111
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1723
1112
self._ensure_real()
1724
1113
return self._real_repository.item_keys_introduced_by(revision_ids,
1752
1135
:param recipe: A search recipe (start, stop, count).
1753
1136
:return: Serialised bytes.
1755
start_keys = ' '.join(recipe[1])
1756
stop_keys = ' '.join(recipe[2])
1757
count = str(recipe[3])
1138
start_keys = ' '.join(recipe[0])
1139
stop_keys = ' '.join(recipe[1])
1140
count = str(recipe[2])
1758
1141
return '\n'.join((start_keys, stop_keys, count))
1760
def _serialise_search_result(self, search_result):
1761
if isinstance(search_result, graph.PendingAncestryResult):
1762
parts = ['ancestry-of']
1763
parts.extend(search_result.heads)
1765
recipe = search_result.get_recipe()
1766
parts = [recipe[0], self._serialise_search_recipe(recipe)]
1767
return '\n'.join(parts)
1770
path = self.bzrdir._path_for_remote_call(self._client)
1772
response = self._call('PackRepository.autopack', path)
1773
except errors.UnknownSmartMethod:
1775
self._real_repository._pack_collection.autopack()
1778
if response[0] != 'ok':
1779
raise errors.UnexpectedSmartServerResponse(response)
1782
class RemoteStreamSink(repository.StreamSink):
1784
def _insert_real(self, stream, src_format, resume_tokens):
1785
self.target_repo._ensure_real()
1786
sink = self.target_repo._real_repository._get_sink()
1787
result = sink.insert_stream(stream, src_format, resume_tokens)
1789
self.target_repo.autopack()
1792
def insert_stream(self, stream, src_format, resume_tokens):
1793
target = self.target_repo
1794
target._unstacked_provider.missing_keys.clear()
1795
candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
1796
if target._lock_token:
1797
candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
1798
lock_args = (target._lock_token or '',)
1800
candidate_calls.append(('Repository.insert_stream', (1, 13)))
1802
client = target._client
1803
medium = client._medium
1804
path = target.bzrdir._path_for_remote_call(client)
1805
# Probe for the verb to use with an empty stream before sending the
1806
# real stream to it. We do this both to avoid the risk of sending a
1807
# large request that is then rejected, and because we don't want to
1808
# implement a way to buffer, rewind, or restart the stream.
1810
for verb, required_version in candidate_calls:
1811
if medium._is_remote_before(required_version):
1814
# We've already done the probing (and set _is_remote_before) on
1815
# a previous insert.
1818
byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1820
response = client.call_with_body_stream(
1821
(verb, path, '') + lock_args, byte_stream)
1822
except errors.UnknownSmartMethod:
1823
medium._remember_remote_is_before(required_version)
1829
return self._insert_real(stream, src_format, resume_tokens)
1830
self._last_inv_record = None
1831
self._last_substream = None
1832
if required_version < (1, 19):
1833
# Remote side doesn't support inventory deltas. Wrap the stream to
1834
# make sure we don't send any. If the stream contains inventory
1835
# deltas we'll interrupt the smart insert_stream request and
1837
stream = self._stop_stream_if_inventory_delta(stream)
1838
byte_stream = smart_repo._stream_to_byte_stream(
1840
resume_tokens = ' '.join(resume_tokens)
1841
response = client.call_with_body_stream(
1842
(verb, path, resume_tokens) + lock_args, byte_stream)
1843
if response[0][0] not in ('ok', 'missing-basis'):
1844
raise errors.UnexpectedSmartServerResponse(response)
1845
if self._last_substream is not None:
1846
# The stream included an inventory-delta record, but the remote
1847
# side isn't new enough to support them. So we need to send the
1848
# rest of the stream via VFS.
1849
self.target_repo.refresh_data()
1850
return self._resume_stream_with_vfs(response, src_format)
1851
if response[0][0] == 'missing-basis':
1852
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1853
resume_tokens = tokens
1854
return resume_tokens, set(missing_keys)
1856
self.target_repo.refresh_data()
1859
def _resume_stream_with_vfs(self, response, src_format):
1860
"""Resume sending a stream via VFS, first resending the record and
1861
substream that couldn't be sent via an insert_stream verb.
1863
if response[0][0] == 'missing-basis':
1864
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1865
# Ignore missing_keys, we haven't finished inserting yet
1868
def resume_substream():
1869
# Yield the substream that was interrupted.
1870
for record in self._last_substream:
1872
self._last_substream = None
1873
def resume_stream():
1874
# Finish sending the interrupted substream
1875
yield ('inventory-deltas', resume_substream())
1876
# Then simply continue sending the rest of the stream.
1877
for substream_kind, substream in self._last_stream:
1878
yield substream_kind, substream
1879
return self._insert_real(resume_stream(), src_format, tokens)
1881
def _stop_stream_if_inventory_delta(self, stream):
1882
"""Normally this just lets the original stream pass-through unchanged.
1884
However if any 'inventory-deltas' substream occurs it will stop
1885
streaming, and store the interrupted substream and stream in
1886
self._last_substream and self._last_stream so that the stream can be
1887
resumed by _resume_stream_with_vfs.
1890
stream_iter = iter(stream)
1891
for substream_kind, substream in stream_iter:
1892
if substream_kind == 'inventory-deltas':
1893
self._last_substream = substream
1894
self._last_stream = stream_iter
1897
yield substream_kind, substream
1900
class RemoteStreamSource(repository.StreamSource):
1901
"""Stream data from a remote server."""
1903
def get_stream(self, search):
1904
if (self.from_repository._fallback_repositories and
1905
self.to_format._fetch_order == 'topological'):
1906
return self._real_stream(self.from_repository, search)
1909
repos = [self.from_repository]
1915
repos.extend(repo._fallback_repositories)
1916
sources.append(repo)
1917
return self.missing_parents_chain(search, sources)
1919
def get_stream_for_missing_keys(self, missing_keys):
1920
self.from_repository._ensure_real()
1921
real_repo = self.from_repository._real_repository
1922
real_source = real_repo._get_source(self.to_format)
1923
return real_source.get_stream_for_missing_keys(missing_keys)
1925
def _real_stream(self, repo, search):
1926
"""Get a stream for search from repo.
1928
This never called RemoteStreamSource.get_stream, and is a heler
1929
for RemoteStreamSource._get_stream to allow getting a stream
1930
reliably whether fallback back because of old servers or trying
1931
to stream from a non-RemoteRepository (which the stacked support
1934
source = repo._get_source(self.to_format)
1935
if isinstance(source, RemoteStreamSource):
1937
source = repo._real_repository._get_source(self.to_format)
1938
return source.get_stream(search)
1940
def _get_stream(self, repo, search):
1941
"""Core worker to get a stream from repo for search.
1943
This is used by both get_stream and the stacking support logic. It
1944
deliberately gets a stream for repo which does not need to be
1945
self.from_repository. In the event that repo is not Remote, or
1946
cannot do a smart stream, a fallback is made to the generic
1947
repository._get_stream() interface, via self._real_stream.
1949
In the event of stacking, streams from _get_stream will not
1950
contain all the data for search - this is normal (see get_stream).
1952
:param repo: A repository.
1953
:param search: A search.
1955
# Fallbacks may be non-smart
1956
if not isinstance(repo, RemoteRepository):
1957
return self._real_stream(repo, search)
1958
client = repo._client
1959
medium = client._medium
1960
path = repo.bzrdir._path_for_remote_call(client)
1961
search_bytes = repo._serialise_search_result(search)
1962
args = (path, self.to_format.network_name())
1964
('Repository.get_stream_1.19', (1, 19)),
1965
('Repository.get_stream', (1, 13))]
1967
for verb, version in candidate_verbs:
1968
if medium._is_remote_before(version):
1971
response = repo._call_with_body_bytes_expecting_body(
1972
verb, args, search_bytes)
1973
except errors.UnknownSmartMethod:
1974
medium._remember_remote_is_before(version)
1976
response_tuple, response_handler = response
1980
return self._real_stream(repo, search)
1981
if response_tuple[0] != 'ok':
1982
raise errors.UnexpectedSmartServerResponse(response_tuple)
1983
byte_stream = response_handler.read_streamed_body()
1984
src_format, stream = smart_repo._byte_stream_to_stream(byte_stream,
1985
self._record_counter)
1986
if src_format.network_name() != repo._format.network_name():
1987
raise AssertionError(
1988
"Mismatched RemoteRepository and stream src %r, %r" % (
1989
src_format.network_name(), repo._format.network_name()))
1992
def missing_parents_chain(self, search, sources):
1993
"""Chain multiple streams together to handle stacking.
1995
:param search: The overall search to satisfy with streams.
1996
:param sources: A list of Repository objects to query.
1998
self.from_serialiser = self.from_repository._format._serializer
1999
self.seen_revs = set()
2000
self.referenced_revs = set()
2001
# If there are heads in the search, or the key count is > 0, we are not
2003
while not search.is_empty() and len(sources) > 1:
2004
source = sources.pop(0)
2005
stream = self._get_stream(source, search)
2006
for kind, substream in stream:
2007
if kind != 'revisions':
2008
yield kind, substream
2010
yield kind, self.missing_parents_rev_handler(substream)
2011
search = search.refine(self.seen_revs, self.referenced_revs)
2012
self.seen_revs = set()
2013
self.referenced_revs = set()
2014
if not search.is_empty():
2015
for kind, stream in self._get_stream(sources[0], search):
2018
def missing_parents_rev_handler(self, substream):
2019
for content in substream:
2020
revision_bytes = content.get_bytes_as('fulltext')
2021
revision = self.from_serialiser.read_revision_from_string(
2023
self.seen_revs.add(content.key[-1])
2024
self.referenced_revs.update(revision.parent_ids)
2028
1144
class RemoteBranchLockableFiles(LockableFiles):
2029
1145
"""A 'LockableFiles' implementation that talks to a smart server.
2031
1147
This is not a public interface class.
2044
1160
self._dir_mode = None
2045
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)
2048
1182
class RemoteBranchFormat(branch.BranchFormat):
2050
def __init__(self, network_name=None):
2051
super(RemoteBranchFormat, self).__init__()
2052
self._matchingbzrdir = RemoteBzrDirFormat()
2053
self._matchingbzrdir.set_branch_format(self)
2054
self._custom_format = None
2055
self._network_name = network_name
2057
1184
def __eq__(self, other):
2058
return (isinstance(other, RemoteBranchFormat) and
1185
return (isinstance(other, RemoteBranchFormat) and
2059
1186
self.__dict__ == other.__dict__)
2061
def _ensure_real(self):
2062
if self._custom_format is None:
2063
self._custom_format = branch.network_format_registry.get(
2066
1188
def get_format_description(self):
2068
return 'Remote: ' + self._custom_format.get_format_description()
2070
def network_name(self):
2071
return self._network_name
2073
def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
2074
return a_bzrdir.open_branch(name=name,
2075
ignore_fallbacks=ignore_fallbacks)
2077
def _vfs_initialize(self, a_bzrdir, name):
2078
# Initialisation when using a local bzrdir object, or a non-vfs init
2079
# method is not available on the server.
2080
# self._custom_format is always set - the start of initialize ensures
2082
if isinstance(a_bzrdir, RemoteBzrDir):
2083
a_bzrdir._ensure_real()
2084
result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2087
# We assume the bzrdir is parameterised; it may not be.
2088
result = self._custom_format.initialize(a_bzrdir, name)
2089
if (isinstance(a_bzrdir, RemoteBzrDir) and
2090
not isinstance(result, RemoteBranch)):
2091
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2095
def initialize(self, a_bzrdir, name=None):
2096
# 1) get the network name to use.
2097
if self._custom_format:
2098
network_name = self._custom_format.network_name()
2100
# Select the current bzrlib default and ask for that.
2101
reference_bzrdir_format = bzrdir.format_registry.get('default')()
2102
reference_format = reference_bzrdir_format.get_branch_format()
2103
self._custom_format = reference_format
2104
network_name = reference_format.network_name()
2105
# Being asked to create on a non RemoteBzrDir:
2106
if not isinstance(a_bzrdir, RemoteBzrDir):
2107
return self._vfs_initialize(a_bzrdir, name=name)
2108
medium = a_bzrdir._client._medium
2109
if medium._is_remote_before((1, 13)):
2110
return self._vfs_initialize(a_bzrdir, name=name)
2111
# Creating on a remote bzr dir.
2112
# 2) try direct creation via RPC
2113
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2114
if name is not None:
2115
# XXX JRV20100304: Support creating colocated branches
2116
raise errors.NoColocatedBranchSupport(self)
2117
verb = 'BzrDir.create_branch'
2119
response = a_bzrdir._call(verb, path, network_name)
2120
except errors.UnknownSmartMethod:
2121
# Fallback - use vfs methods
2122
medium._remember_remote_is_before((1, 13))
2123
return self._vfs_initialize(a_bzrdir, name=name)
2124
if response[0] != 'ok':
2125
raise errors.UnexpectedSmartServerResponse(response)
2126
# Turn the response into a RemoteRepository object.
2127
format = RemoteBranchFormat(network_name=response[1])
2128
repo_format = response_tuple_to_repo_format(response[3:])
2129
if response[2] == '':
2130
repo_bzrdir = a_bzrdir
2132
repo_bzrdir = RemoteBzrDir(
2133
a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
2135
remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2136
remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2137
format=format, setup_stacking=False, name=name)
2138
# XXX: We know this is a new branch, so it must have revno 0, revid
2139
# NULL_REVISION. Creating the branch locked would make this be unable
2140
# to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2141
remote_branch._last_revision_info_cache = 0, NULL_REVISION
2142
return remote_branch
2144
def make_tags(self, branch):
2146
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()
2148
1202
def supports_tags(self):
2149
1203
# Remote branches might support tags, but we won't know until we
2150
1204
# access the real remote branch.
2152
return self._custom_format.supports_tags()
2154
def supports_stacking(self):
2156
return self._custom_format.supports_stacking()
2158
def supports_set_append_revisions_only(self):
2160
return self._custom_format.supports_set_append_revisions_only()
2163
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
1208
class RemoteBranch(branch.Branch):
2164
1209
"""Branch stored on a server accessed by HPSS RPC.
2166
1211
At the moment most operations are mapped down to simple file operations.
2169
1214
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2170
_client=None, format=None, setup_stacking=True, name=None):
2171
1216
"""Create a RemoteBranch instance.
2173
1218
:param real_branch: An optional local implementation of the branch
2174
1219
format, usually accessing the data via the VFS.
2175
1220
:param _client: Private parameter for testing.
2176
:param format: A RemoteBranchFormat object, None to create one
2177
automatically. If supplied it should have a network_name already
2179
:param setup_stacking: If True make an RPC call to determine the
2180
stacked (or not) status of the branch. If False assume the branch
2182
:param name: Colocated branch name
2184
1222
# We intentionally don't call the parent class's __init__, because it
2185
1223
# will try to assign to self.tags, which is a property in this subclass.
2186
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
2187
1227
self.bzrdir = remote_bzrdir
2188
1228
if _client is not None:
2189
1229
self._client = _client
2272
1262
Used before calls to self._real_branch.
2274
if self._real_branch is None:
2275
if not vfs.vfs_enabled():
2276
raise AssertionError('smart server vfs must be enabled '
2277
'to use vfs implementation')
1264
if not self._real_branch:
1265
assert vfs.vfs_enabled()
2278
1266
self.bzrdir._ensure_real()
2279
self._real_branch = self.bzrdir._real_bzrdir.open_branch(
2280
ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
2281
if self.repository._real_repository is None:
2282
# Give the remote repository the matching real repo.
2283
real_repo = self._real_branch.repository
2284
if isinstance(real_repo, RemoteRepository):
2285
real_repo._ensure_real()
2286
real_repo = real_repo._real_repository
2287
self.repository._set_real_repository(real_repo)
2288
# 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.
2290
1275
self._real_branch.repository = self.repository
1276
# XXX: deal with _lock_mode == 'w'
2291
1277
if self._lock_mode == 'r':
2292
1278
self._real_branch.lock_read()
2293
elif self._lock_mode == 'w':
2294
self._real_branch.lock_write(token=self._lock_token)
2296
def _translate_error(self, err, **context):
2297
self.repository._translate_error(err, branch=self, **context)
2299
def _clear_cached_state(self):
2300
super(RemoteBranch, self)._clear_cached_state()
2301
if self._real_branch is not None:
2302
self._real_branch._clear_cached_state()
2304
def _clear_cached_state_of_remote_branch_only(self):
2305
"""Like _clear_cached_state, but doesn't clear the cache of
2308
This is useful when falling back to calling a method of
2309
self._real_branch that changes state. In that case the underlying
2310
branch changes, so we need to invalidate this RemoteBranch's cache of
2311
it. However, there's no need to invalidate the _real_branch's cache
2312
too, in fact doing so might harm performance.
2314
super(RemoteBranch, self)._clear_cached_state()
2317
1281
def control_files(self):
2332
1296
self._ensure_real()
2333
1297
return self._real_branch.get_physical_lock_status()
2335
def get_stacked_on_url(self):
2336
"""Get the URL this branch is stacked against.
2338
:raises NotStacked: If the branch is not stacked.
2339
:raises UnstackableBranchFormat: If the branch does not support
2341
:raises UnstackableRepositoryFormat: If the repository does not support
2345
# there may not be a repository yet, so we can't use
2346
# self._translate_error, so we can't use self._call either.
2347
response = self._client.call('Branch.get_stacked_on_url',
2348
self._remote_path())
2349
except errors.ErrorFromSmartServer, err:
2350
# there may not be a repository yet, so we can't call through
2351
# its _translate_error
2352
_translate_error(err, branch=self)
2353
except errors.UnknownSmartMethod, err:
2355
return self._real_branch.get_stacked_on_url()
2356
if response[0] != 'ok':
2357
raise errors.UnexpectedSmartServerResponse(response)
2360
def set_stacked_on_url(self, url):
2361
branch.Branch.set_stacked_on_url(self, url)
2363
self._is_stacked = False
2365
self._is_stacked = True
2367
def _vfs_get_tags_bytes(self):
2369
return self._real_branch._get_tags_bytes()
2371
def _get_tags_bytes(self):
2372
medium = self._client._medium
2373
if medium._is_remote_before((1, 13)):
2374
return self._vfs_get_tags_bytes()
2376
response = self._call('Branch.get_tags_bytes', self._remote_path())
2377
except errors.UnknownSmartMethod:
2378
medium._remember_remote_is_before((1, 13))
2379
return self._vfs_get_tags_bytes()
2382
def _vfs_set_tags_bytes(self, bytes):
2384
return self._real_branch._set_tags_bytes(bytes)
2386
def _set_tags_bytes(self, bytes):
2387
medium = self._client._medium
2388
if medium._is_remote_before((1, 18)):
2389
self._vfs_set_tags_bytes(bytes)
2393
self._remote_path(), self._lock_token, self._repo_lock_token)
2394
response = self._call_with_body_bytes(
2395
'Branch.set_tags_bytes', args, bytes)
2396
except errors.UnknownSmartMethod:
2397
medium._remember_remote_is_before((1, 18))
2398
self._vfs_set_tags_bytes(bytes)
2400
1299
def lock_read(self):
2401
"""Lock the branch for read operations.
2403
:return: A bzrlib.lock.LogicalLockResult.
2405
self.repository.lock_read()
2406
1300
if not self._lock_mode:
2407
self._note_lock('r')
2408
1301
self._lock_mode = 'r'
2409
1302
self._lock_count = 1
2410
1303
if self._real_branch is not None:
2411
1304
self._real_branch.lock_read()
2413
1306
self._lock_count += 1
2414
return lock.LogicalLockResult(self.unlock)
2416
1308
def _remote_lock_write(self, token):
2417
1309
if token is None:
2418
1310
branch_token = repo_token = ''
2420
1312
branch_token = token
2421
repo_token = self.repository.lock_write().repository_token
1313
repo_token = self.repository.lock_write()
2422
1314
self.repository.unlock()
2423
err_context = {'token': token}
2425
response = self._call(
2426
'Branch.lock_write', self._remote_path(), branch_token,
2427
repo_token or '', **err_context)
2428
except errors.LockContention, e:
2429
# The LockContention from the server doesn't have any
2430
# information about the lock_url. We re-raise LockContention
2431
# with valid lock_url.
2432
raise errors.LockContention('(remote lock)',
2433
self.repository.base.split('.bzr/')[0])
2434
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])
2435
1332
raise errors.UnexpectedSmartServerResponse(response)
2436
ok, branch_token, repo_token = response
2437
return branch_token, repo_token
2439
1334
def lock_write(self, token=None):
2440
1335
if not self._lock_mode:
2441
self._note_lock('w')
2442
# Lock the branch and repo in one remote call.
2443
1336
remote_tokens = self._remote_lock_write(token)
2444
1337
self._lock_token, self._repo_lock_token = remote_tokens
2445
if not self._lock_token:
2446
raise SmartProtocolError('Remote server did not return a token!')
2447
# Tell the self.repository object that it is locked.
2448
self.repository.lock_write(
2449
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.
2451
1347
if self._real_branch is not None:
2452
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()
2453
1354
if token is not None:
2454
1355
self._leave_lock = True
1357
# XXX: this case seems to be unreachable; token cannot be None.
2456
1358
self._leave_lock = False
2457
1359
self._lock_mode = 'w'
2458
1360
self._lock_count = 1
2459
1361
elif self._lock_mode == 'r':
2460
raise errors.ReadOnlyError(self)
1362
raise errors.ReadOnlyTransaction
2462
1364
if token is not None:
2463
# A token was given to lock_write, and we're relocking, so
2464
# 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.
2466
1367
if token != self._lock_token:
2467
1368
raise errors.TokenMismatch(token, self._lock_token)
2468
1369
self._lock_count += 1
2469
# Re-lock the repository too.
2470
self.repository.lock_write(self._repo_lock_token)
2471
return BranchWriteLockResult(self.unlock, self._lock_token or None)
1370
return self._lock_token or None
2473
1372
def _unlock(self, branch_token, repo_token):
2474
err_context = {'token': str((branch_token, repo_token))}
2475
response = self._call(
2476
'Branch.unlock', self._remote_path(), branch_token,
2477
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,
2478
1376
if response == ('ok',):
2480
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)
2482
@only_raises(errors.LockNotHeld, errors.LockBroken)
2483
1384
def unlock(self):
2485
self._lock_count -= 1
2486
if not self._lock_count:
2487
self._clear_cached_state()
2488
mode = self._lock_mode
2489
self._lock_mode = None
2490
if self._real_branch is not None:
2491
if (not self._leave_lock and mode == 'w' and
2492
self._repo_lock_token):
2493
# If this RemoteBranch will remove the physical lock
2494
# for the repository, make sure the _real_branch
2495
# doesn't do it first. (Because the _real_branch's
2496
# repository is set to be the RemoteRepository.)
2497
self._real_branch.repository.leave_lock_in_place()
2498
self._real_branch.unlock()
2500
# Only write-locked branched need to make a remote method
2501
# call to perform the unlock.
2503
if not self._lock_token:
2504
raise AssertionError('Locked, but no token!')
2505
branch_token = self._lock_token
2506
repo_token = self._repo_lock_token
2507
self._lock_token = None
2508
self._repo_lock_token = None
2509
if not self._leave_lock:
2510
self._unlock(branch_token, repo_token)
2512
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)
2514
1411
def break_lock(self):
2515
1412
self._ensure_real()
2525
1422
raise NotImplementedError(self.dont_leave_lock_in_place)
2526
1423
self._leave_lock = False
2529
def get_rev_id(self, revno, history=None):
2531
return _mod_revision.NULL_REVISION
2532
last_revision_info = self.last_revision_info()
2533
ok, result = self.repository.get_rev_id_for_revno(
2534
revno, last_revision_info)
2537
missing_parent = result[1]
2538
# Either the revision named by the server is missing, or its parent
2539
# is. Call get_parent_map to determine which, so that we report a
2541
parent_map = self.repository.get_parent_map([missing_parent])
2542
if missing_parent in parent_map:
2543
missing_parent = parent_map[missing_parent]
2544
raise errors.RevisionNotPresent(missing_parent, self.repository)
2546
def _last_revision_info(self):
2547
response = self._call('Branch.last_revision_info', self._remote_path())
2548
if response[0] != 'ok':
2549
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,)
2550
1430
revno = int(response[1])
2551
1431
last_revision = response[2]
2552
1432
return (revno, last_revision)
2554
1434
def _gen_revision_history(self):
2555
1435
"""See Branch._gen_revision_history()."""
2556
if self._is_stacked:
2558
return self._real_branch._gen_revision_history()
2559
response_tuple, response_handler = self._call_expecting_body(
2560
'Branch.revision_history', self._remote_path())
2561
if response_tuple[0] != 'ok':
2562
raise errors.UnexpectedSmartServerResponse(response_tuple)
2563
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')
2564
1442
if result == ['']:
2568
def _remote_path(self):
2569
return self.bzrdir._path_for_remote_call(self._client)
2571
def _set_last_revision_descendant(self, revision_id, other_branch,
2572
allow_diverged=False, allow_overwrite_descendant=False):
2573
# This performs additional work to meet the hook contract; while its
2574
# undesirable, we have to synthesise the revno to call the hook, and
2575
# not calling the hook is worse as it means changes can't be prevented.
2576
# Having calculated this though, we can't just call into
2577
# set_last_revision_info as a simple call, because there is a set_rh
2578
# hook that some folk may still be using.
2579
old_revno, old_revid = self.last_revision_info()
2580
history = self._lefthand_history(revision_id)
2581
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2582
err_context = {'other_branch': other_branch}
2583
response = self._call('Branch.set_last_revision_ex',
2584
self._remote_path(), self._lock_token, self._repo_lock_token,
2585
revision_id, int(allow_diverged), int(allow_overwrite_descendant),
2587
self._clear_cached_state()
2588
if len(response) != 3 and response[0] != 'ok':
2589
raise errors.UnexpectedSmartServerResponse(response)
2590
new_revno, new_revision_id = response[1:]
2591
self._last_revision_info_cache = new_revno, new_revision_id
2592
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2593
if self._real_branch is not None:
2594
cache = new_revno, new_revision_id
2595
self._real_branch._last_revision_info_cache = cache
2597
def _set_last_revision(self, revision_id):
2598
old_revno, old_revid = self.last_revision_info()
2599
# This performs additional work to meet the hook contract; while its
2600
# undesirable, we have to synthesise the revno to call the hook, and
2601
# not calling the hook is worse as it means changes can't be prevented.
2602
# Having calculated this though, we can't just call into
2603
# set_last_revision_info as a simple call, because there is a set_rh
2604
# hook that some folk may still be using.
2605
history = self._lefthand_history(revision_id)
2606
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2607
self._clear_cached_state()
2608
response = self._call('Branch.set_last_revision',
2609
self._remote_path(), self._lock_token, self._repo_lock_token,
2611
if response != ('ok',):
2612
raise errors.UnexpectedSmartServerResponse(response)
2613
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2615
1446
@needs_write_lock
2616
1447
def set_revision_history(self, rev_history):
2617
1448
# Send just the tip revision of the history; the server will generate
2618
1449
# the full history from that. If the revision doesn't exist in this
2619
1450
# branch, NoSuchRevision will be raised.
1451
path = self.bzrdir._path_for_remote_call(self._client)
2620
1452
if rev_history == []:
2621
1453
rev_id = 'null:'
2623
1455
rev_id = rev_history[-1]
2624
self._set_last_revision(rev_id)
2625
for hook in branch.Branch.hooks['set_rh']:
2626
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,))
2627
1464
self._cache_revision_history(rev_history)
2629
def _get_parent_location(self):
2630
medium = self._client._medium
2631
if medium._is_remote_before((1, 13)):
2632
return self._vfs_get_parent_location()
2634
response = self._call('Branch.get_parent', self._remote_path())
2635
except errors.UnknownSmartMethod:
2636
medium._remember_remote_is_before((1, 13))
2637
return self._vfs_get_parent_location()
2638
if len(response) != 1:
2639
raise errors.UnexpectedSmartServerResponse(response)
2640
parent_location = response[0]
2641
if parent_location == '':
2643
return parent_location
2645
def _vfs_get_parent_location(self):
2647
return self._real_branch._get_parent_location()
2649
def _set_parent_location(self, url):
2650
medium = self._client._medium
2651
if medium._is_remote_before((1, 15)):
2652
return self._vfs_set_parent_location(url)
2654
call_url = url or ''
2655
if type(call_url) is not str:
2656
raise AssertionError('url must be a str or None (%s)' % url)
2657
response = self._call('Branch.set_parent_location',
2658
self._remote_path(), self._lock_token, self._repo_lock_token,
2660
except errors.UnknownSmartMethod:
2661
medium._remember_remote_is_before((1, 15))
2662
return self._vfs_set_parent_location(url)
2664
raise errors.UnexpectedSmartServerResponse(response)
2666
def _vfs_set_parent_location(self, url):
2668
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)
2670
1488
@needs_write_lock
2671
1489
def pull(self, source, overwrite=False, stop_revision=None,
2673
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
2674
1496
self._ensure_real()
2675
return self._real_branch.pull(
1497
self._real_branch.pull(
2676
1498
source, overwrite=overwrite, stop_revision=stop_revision,
2677
_override_hook_target=self, **kwargs)
2679
1501
@needs_read_lock
2680
1502
def push(self, target, overwrite=False, stop_revision=None):
2686
1508
def is_locked(self):
2687
1509
return self._lock_count >= 1
2690
def revision_id_to_revno(self, revision_id):
2692
return self._real_branch.revision_id_to_revno(revision_id)
2695
1511
def set_last_revision_info(self, revno, revision_id):
2696
# XXX: These should be returned by the set_last_revision_info verb
2697
old_revno, old_revid = self.last_revision_info()
2698
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2699
revision_id = ensure_null(revision_id)
2701
response = self._call('Branch.set_last_revision_info',
2702
self._remote_path(), self._lock_token, self._repo_lock_token,
2703
str(revno), revision_id)
2704
except errors.UnknownSmartMethod:
2706
self._clear_cached_state_of_remote_branch_only()
2707
self._real_branch.set_last_revision_info(revno, revision_id)
2708
self._last_revision_info_cache = revno, revision_id
2710
if response == ('ok',):
2711
self._clear_cached_state()
2712
self._last_revision_info_cache = revno, revision_id
2713
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2714
# Update the _real_branch's cache too.
2715
if self._real_branch is not None:
2716
cache = self._last_revision_info_cache
2717
self._real_branch._last_revision_info_cache = cache
2719
raise errors.UnexpectedSmartServerResponse(response)
1513
self._clear_cached_state()
1514
return self._real_branch.set_last_revision_info(revno, revision_id)
2722
1516
def generate_revision_history(self, revision_id, last_rev=None,
2723
1517
other_branch=None):
2724
medium = self._client._medium
2725
if not medium._is_remote_before((1, 6)):
2726
# Use a smart method for 1.6 and above servers
2728
self._set_last_revision_descendant(revision_id, other_branch,
2729
allow_diverged=True, allow_overwrite_descendant=True)
2731
except errors.UnknownSmartMethod:
2732
medium._remember_remote_is_before((1, 6))
2733
self._clear_cached_state_of_remote_branch_only()
2734
self.set_revision_history(self._lefthand_history(revision_id,
2735
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
2737
1527
def set_push_location(self, location):
2738
1528
self._ensure_real()
2739
1529
return self._real_branch.set_push_location(location)
2742
class RemoteConfig(object):
2743
"""A Config that reads and writes from smart verbs.
2745
It is a low-level object that considers config data to be name/value pairs
2746
that may be associated with a section. Assigning meaning to the these
2747
values is done at higher levels like bzrlib.config.TreeConfig.
2750
def get_option(self, name, section=None, default=None):
2751
"""Return the value associated with a named option.
2753
:param name: The name of the value
2754
:param section: The section the option is in (if any)
2755
:param default: The value to return if the value is not set
2756
:return: The value or default value
2759
configobj = self._get_configobj()
2761
section_obj = configobj
2764
section_obj = configobj[section]
2767
return section_obj.get(name, default)
2768
except errors.UnknownSmartMethod:
2769
return self._vfs_get_option(name, section, default)
2771
def _response_to_configobj(self, response):
2772
if len(response[0]) and response[0][0] != 'ok':
2773
raise errors.UnexpectedSmartServerResponse(response)
2774
lines = response[1].read_body_bytes().splitlines()
2775
return config.ConfigObj(lines, encoding='utf-8')
2778
class RemoteBranchConfig(RemoteConfig):
2779
"""A RemoteConfig for Branches."""
2781
def __init__(self, branch):
2782
self._branch = branch
2784
def _get_configobj(self):
2785
path = self._branch._remote_path()
2786
response = self._branch._client.call_expecting_body(
2787
'Branch.get_config_file', path)
2788
return self._response_to_configobj(response)
2790
def set_option(self, value, name, section=None):
2791
"""Set the value associated with a named option.
2793
:param value: The value to set
2794
:param name: The name of the value to set
2795
:param section: The section the option is in (if any)
2797
medium = self._branch._client._medium
2798
if medium._is_remote_before((1, 14)):
2799
return self._vfs_set_option(value, name, section)
2800
if isinstance(value, dict):
2801
if medium._is_remote_before((2, 2)):
2802
return self._vfs_set_option(value, name, section)
2803
return self._set_config_option_dict(value, name, section)
2805
return self._set_config_option(value, name, section)
2807
def _set_config_option(self, value, name, section):
2809
path = self._branch._remote_path()
2810
response = self._branch._client.call('Branch.set_config_option',
2811
path, self._branch._lock_token, self._branch._repo_lock_token,
2812
value.encode('utf8'), name, section or '')
2813
except errors.UnknownSmartMethod:
2814
medium = self._branch._client._medium
2815
medium._remember_remote_is_before((1, 14))
2816
return self._vfs_set_option(value, name, section)
2818
raise errors.UnexpectedSmartServerResponse(response)
2820
def _serialize_option_dict(self, option_dict):
2822
for key, value in option_dict.items():
2823
if isinstance(key, unicode):
2824
key = key.encode('utf8')
2825
if isinstance(value, unicode):
2826
value = value.encode('utf8')
2827
utf8_dict[key] = value
2828
return bencode.bencode(utf8_dict)
2830
def _set_config_option_dict(self, value, name, section):
2832
path = self._branch._remote_path()
2833
serialised_dict = self._serialize_option_dict(value)
2834
response = self._branch._client.call(
2835
'Branch.set_config_option_dict',
2836
path, self._branch._lock_token, self._branch._repo_lock_token,
2837
serialised_dict, name, section or '')
2838
except errors.UnknownSmartMethod:
2839
medium = self._branch._client._medium
2840
medium._remember_remote_is_before((2, 2))
2841
return self._vfs_set_option(value, name, section)
2843
raise errors.UnexpectedSmartServerResponse(response)
2845
def _real_object(self):
2846
self._branch._ensure_real()
2847
return self._branch._real_branch
2849
def _vfs_set_option(self, value, name, section=None):
2850
return self._real_object()._get_config().set_option(
2851
value, name, section)
2854
class RemoteBzrDirConfig(RemoteConfig):
2855
"""A RemoteConfig for BzrDirs."""
2857
def __init__(self, bzrdir):
2858
self._bzrdir = bzrdir
2860
def _get_configobj(self):
2861
medium = self._bzrdir._client._medium
2862
verb = 'BzrDir.get_config_file'
2863
if medium._is_remote_before((1, 15)):
2864
raise errors.UnknownSmartMethod(verb)
2865
path = self._bzrdir._path_for_remote_call(self._bzrdir._client)
2866
response = self._bzrdir._call_expecting_body(
2868
return self._response_to_configobj(response)
2870
def _vfs_get_option(self, name, section, default):
2871
return self._real_object()._get_config().get_option(
2872
name, section, default)
2874
def set_option(self, value, name, section=None):
2875
"""Set the value associated with a named option.
2877
:param value: The value to set
2878
:param name: The name of the value to set
2879
:param section: The section the option is in (if any)
2881
return self._real_object()._get_config().set_option(
2882
value, name, section)
2884
def _real_object(self):
2885
self._bzrdir._ensure_real()
2886
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
2890
1550
def _extract_tar(tar, to_dir):
2895
1555
for tarinfo in tar:
2896
1556
tar.extract(tarinfo, to_dir)
2899
def _translate_error(err, **context):
2900
"""Translate an ErrorFromSmartServer into a more useful error.
2902
Possible context keys:
2910
If the error from the server doesn't match a known pattern, then
2911
UnknownErrorFromSmartServer is raised.
2915
return context[name]
2916
except KeyError, key_err:
2917
mutter('Missing key %r in context %r', key_err.args[0], context)
2920
"""Get the path from the context if present, otherwise use first error
2924
return context['path']
2925
except KeyError, key_err:
2927
return err.error_args[0]
2928
except IndexError, idx_err:
2930
'Missing key %r in context %r', key_err.args[0], context)
2933
if err.error_verb == 'IncompatibleRepositories':
2934
raise errors.IncompatibleRepositories(err.error_args[0],
2935
err.error_args[1], err.error_args[2])
2936
elif err.error_verb == 'NoSuchRevision':
2937
raise NoSuchRevision(find('branch'), err.error_args[0])
2938
elif err.error_verb == 'nosuchrevision':
2939
raise NoSuchRevision(find('repository'), err.error_args[0])
2940
elif err.error_verb == 'nobranch':
2941
if len(err.error_args) >= 1:
2942
extra = err.error_args[0]
2945
raise errors.NotBranchError(path=find('bzrdir').root_transport.base,
2947
elif err.error_verb == 'norepository':
2948
raise errors.NoRepositoryPresent(find('bzrdir'))
2949
elif err.error_verb == 'LockContention':
2950
raise errors.LockContention('(remote lock)')
2951
elif err.error_verb == 'UnlockableTransport':
2952
raise errors.UnlockableTransport(find('bzrdir').root_transport)
2953
elif err.error_verb == 'LockFailed':
2954
raise errors.LockFailed(err.error_args[0], err.error_args[1])
2955
elif err.error_verb == 'TokenMismatch':
2956
raise errors.TokenMismatch(find('token'), '(remote token)')
2957
elif err.error_verb == 'Diverged':
2958
raise errors.DivergedBranches(find('branch'), find('other_branch'))
2959
elif err.error_verb == 'TipChangeRejected':
2960
raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
2961
elif err.error_verb == 'UnstackableBranchFormat':
2962
raise errors.UnstackableBranchFormat(*err.error_args)
2963
elif err.error_verb == 'UnstackableRepositoryFormat':
2964
raise errors.UnstackableRepositoryFormat(*err.error_args)
2965
elif err.error_verb == 'NotStacked':
2966
raise errors.NotStacked(branch=find('branch'))
2967
elif err.error_verb == 'PermissionDenied':
2969
if len(err.error_args) >= 2:
2970
extra = err.error_args[1]
2973
raise errors.PermissionDenied(path, extra=extra)
2974
elif err.error_verb == 'ReadError':
2976
raise errors.ReadError(path)
2977
elif err.error_verb == 'NoSuchFile':
2979
raise errors.NoSuchFile(path)
2980
elif err.error_verb == 'FileExists':
2981
raise errors.FileExists(err.error_args[0])
2982
elif err.error_verb == 'DirectoryNotEmpty':
2983
raise errors.DirectoryNotEmpty(err.error_args[0])
2984
elif err.error_verb == 'ShortReadvError':
2985
args = err.error_args
2986
raise errors.ShortReadvError(
2987
args[0], int(args[1]), int(args[2]), int(args[3]))
2988
elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
2989
encoding = str(err.error_args[0]) # encoding must always be a string
2990
val = err.error_args[1]
2991
start = int(err.error_args[2])
2992
end = int(err.error_args[3])
2993
reason = str(err.error_args[4]) # reason must always be a string
2994
if val.startswith('u:'):
2995
val = val[2:].decode('utf-8')
2996
elif val.startswith('s:'):
2997
val = val[2:].decode('base64')
2998
if err.error_verb == 'UnicodeDecodeError':
2999
raise UnicodeDecodeError(encoding, val, start, end, reason)
3000
elif err.error_verb == 'UnicodeEncodeError':
3001
raise UnicodeEncodeError(encoding, val, start, end, reason)
3002
elif err.error_verb == 'ReadOnlyError':
3003
raise errors.TransportNotPossible('readonly transport')
3004
raise errors.UnknownErrorFromSmartServer(err)
added
removed
bzrlib/remote.py
