13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
# TODO: At some point, handle upgrades by just passing the whole request
18
# across to run on the server.
21
from cStringIO import StringIO
19
23
from bzrlib import (
30
repository as _mod_repository,
32
revision as _mod_revision,
36
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
33
from bzrlib.branch import BranchReferenceFormat
37
34
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
38
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
35
from bzrlib.config import BranchConfig, TreeConfig
36
from bzrlib.decorators import needs_read_lock, needs_write_lock
39
37
from bzrlib.errors import (
41
39
SmartProtocolError,
43
41
from bzrlib.lockable_files import LockableFiles
44
from bzrlib.smart import client, vfs, repository as smart_repo
42
from bzrlib.pack import ContainerPushParser
43
from bzrlib.smart import client, vfs
45
44
from bzrlib.revision import ensure_null, NULL_REVISION
46
from bzrlib.repository import RepositoryWriteLockResult
47
45
from bzrlib.trace import mutter, note, warning
50
class _RpcHelper(object):
51
"""Mixin class that helps with issuing RPCs."""
53
def _call(self, method, *args, **err_context):
55
return self._client.call(method, *args)
56
except errors.ErrorFromSmartServer, err:
57
self._translate_error(err, **err_context)
59
def _call_expecting_body(self, method, *args, **err_context):
61
return self._client.call_expecting_body(method, *args)
62
except errors.ErrorFromSmartServer, err:
63
self._translate_error(err, **err_context)
65
def _call_with_body_bytes(self, method, args, body_bytes, **err_context):
67
return self._client.call_with_body_bytes(method, args, body_bytes)
68
except errors.ErrorFromSmartServer, err:
69
self._translate_error(err, **err_context)
71
def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
74
return self._client.call_with_body_bytes_expecting_body(
75
method, args, body_bytes)
76
except errors.ErrorFromSmartServer, err:
77
self._translate_error(err, **err_context)
80
def response_tuple_to_repo_format(response):
81
"""Convert a response tuple describing a repository format to a format."""
82
format = RemoteRepositoryFormat()
83
format._rich_root_data = (response[0] == 'yes')
84
format._supports_tree_reference = (response[1] == 'yes')
85
format._supports_external_lookups = (response[2] == 'yes')
86
format._network_name = response[3]
90
47
# Note: RemoteBzrDirFormat is in bzrdir.py
92
class RemoteBzrDir(BzrDir, _RpcHelper):
49
class RemoteBzrDir(BzrDir):
93
50
"""Control directory on a remote server, accessed via bzr:// or similar."""
95
def __init__(self, transport, format, _client=None, _force_probe=False):
52
def __init__(self, transport, _client=None):
96
53
"""Construct a RemoteBzrDir.
98
55
:param _client: Private parameter for testing. Disables probing and the
99
56
use of a real bzrdir.
101
BzrDir.__init__(self, transport, format)
58
BzrDir.__init__(self, transport, RemoteBzrDirFormat())
102
59
# this object holds a delegated bzrdir that uses file-level operations
103
60
# to talk to the other side
104
61
self._real_bzrdir = None
105
self._has_working_tree = None
106
# 1-shot cache for the call pattern 'create_branch; open_branch' - see
107
# create_branch for details.
108
self._next_open_branch_result = None
110
63
if _client is None:
111
64
medium = transport.get_smart_medium()
112
self._client = client._SmartClient(medium)
65
self._client = client._SmartClient(medium, transport.base)
114
67
self._client = _client
121
return '%s(%r)' % (self.__class__.__name__, self._client)
123
def _probe_bzrdir(self):
124
medium = self._client._medium
125
70
path = self._path_for_remote_call(self._client)
126
if medium._is_remote_before((2, 1)):
130
self._rpc_open_2_1(path)
132
except errors.UnknownSmartMethod:
133
medium._remember_remote_is_before((2, 1))
136
def _rpc_open_2_1(self, path):
137
response = self._call('BzrDir.open_2.1', path)
138
if response == ('no',):
139
raise errors.NotBranchError(path=self.root_transport.base)
140
elif response[0] == 'yes':
141
if response[1] == 'yes':
142
self._has_working_tree = True
143
elif response[1] == 'no':
144
self._has_working_tree = False
146
raise errors.UnexpectedSmartServerResponse(response)
148
raise errors.UnexpectedSmartServerResponse(response)
150
def _rpc_open(self, path):
151
response = self._call('BzrDir.open', path)
71
response = self._client.call('BzrDir.open', path)
152
72
if response not in [('yes',), ('no',)]:
153
73
raise errors.UnexpectedSmartServerResponse(response)
154
74
if response == ('no',):
155
raise errors.NotBranchError(path=self.root_transport.base)
75
raise errors.NotBranchError(path=transport.base)
157
77
def _ensure_real(self):
158
78
"""Ensure that there is a _real_bzrdir set.
160
80
Used before calls to self._real_bzrdir.
162
82
if not self._real_bzrdir:
163
if 'hpssvfs' in debug.debug_flags:
165
warning('VFS BzrDir access triggered\n%s',
166
''.join(traceback.format_stack()))
167
83
self._real_bzrdir = BzrDir.open_from_transport(
168
84
self.root_transport, _server_formats=False)
169
self._format._network_name = \
170
self._real_bzrdir._format.network_name()
172
def _translate_error(self, err, **context):
173
_translate_error(err, bzrdir=self, **context)
175
def break_lock(self):
176
# Prevent aliasing problems in the next_open_branch_result cache.
177
# See create_branch for rationale.
178
self._next_open_branch_result = None
179
return BzrDir.break_lock(self)
181
def _vfs_cloning_metadir(self, require_stacking=False):
183
return self._real_bzrdir.cloning_metadir(
184
require_stacking=require_stacking)
186
def cloning_metadir(self, require_stacking=False):
187
medium = self._client._medium
188
if medium._is_remote_before((1, 13)):
189
return self._vfs_cloning_metadir(require_stacking=require_stacking)
190
verb = 'BzrDir.cloning_metadir'
195
path = self._path_for_remote_call(self._client)
197
response = self._call(verb, path, stacking)
198
except errors.UnknownSmartMethod:
199
medium._remember_remote_is_before((1, 13))
200
return self._vfs_cloning_metadir(require_stacking=require_stacking)
201
except errors.UnknownErrorFromSmartServer, err:
202
if err.error_tuple != ('BranchReference',):
204
# We need to resolve the branch reference to determine the
205
# cloning_metadir. This causes unnecessary RPCs to open the
206
# referenced branch (and bzrdir, etc) but only when the caller
207
# didn't already resolve the branch reference.
208
referenced_branch = self.open_branch()
209
return referenced_branch.bzrdir.cloning_metadir()
210
if len(response) != 3:
211
raise errors.UnexpectedSmartServerResponse(response)
212
control_name, repo_name, branch_info = response
213
if len(branch_info) != 2:
214
raise errors.UnexpectedSmartServerResponse(response)
215
branch_ref, branch_name = branch_info
216
format = bzrdir.network_format_registry.get(control_name)
218
format.repository_format = repository.network_format_registry.get(
220
if branch_ref == 'ref':
221
# XXX: we need possible_transports here to avoid reopening the
222
# connection to the referenced location
223
ref_bzrdir = BzrDir.open(branch_name)
224
branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
225
format.set_branch_format(branch_format)
226
elif branch_ref == 'branch':
228
format.set_branch_format(
229
branch.network_format_registry.get(branch_name))
231
raise errors.UnexpectedSmartServerResponse(response)
234
86
def create_repository(self, shared=False):
235
# as per meta1 formats - just delegate to the format object which may
237
result = self._format.repository_format.initialize(self, shared)
238
if not isinstance(result, RemoteRepository):
239
return self.open_repository()
88
self._real_bzrdir.create_repository(shared=shared)
89
return self.open_repository()
243
91
def destroy_repository(self):
244
92
"""See BzrDir.destroy_repository"""
245
93
self._ensure_real()
246
94
self._real_bzrdir.destroy_repository()
248
def create_branch(self, name=None):
249
# as per meta1 formats - just delegate to the format object which may
251
real_branch = self._format.get_branch_format().initialize(self,
253
if not isinstance(real_branch, RemoteBranch):
254
result = RemoteBranch(self, self.find_repository(), real_branch,
258
# BzrDir.clone_on_transport() uses the result of create_branch but does
259
# not return it to its callers; we save approximately 8% of our round
260
# trips by handing the branch we created back to the first caller to
261
# open_branch rather than probing anew. Long term we need a API in
262
# bzrdir that doesn't discard result objects (like result_branch).
264
self._next_open_branch_result = result
96
def create_branch(self):
98
real_branch = self._real_bzrdir.create_branch()
99
return RemoteBranch(self, self.find_repository(), real_branch)
267
def destroy_branch(self, name=None):
101
def destroy_branch(self):
268
102
"""See BzrDir.destroy_branch"""
269
103
self._ensure_real()
270
self._real_bzrdir.destroy_branch(name=name)
271
self._next_open_branch_result = None
104
self._real_bzrdir.destroy_branch()
273
106
def create_workingtree(self, revision_id=None, from_branch=None):
274
107
raise errors.NotLocalUrl(self.transport.base)
284
117
def get_branch_reference(self):
285
118
"""See BzrDir.get_branch_reference()."""
286
response = self._get_branch_reference()
287
if response[0] == 'ref':
119
path = self._path_for_remote_call(self._client)
121
response = self._client.call('BzrDir.open_branch', path)
122
except errors.ErrorFromSmartServer, err:
123
if err.error_tuple == ('nobranch',):
124
raise errors.NotBranchError(path=self.root_transport.base)
126
if response[0] == 'ok':
127
if response[1] == '':
128
# branch at this location.
131
# a branch reference, use the existing BranchReference logic.
292
def _get_branch_reference(self):
293
path = self._path_for_remote_call(self._client)
294
medium = self._client._medium
296
('BzrDir.open_branchV3', (2, 1)),
297
('BzrDir.open_branchV2', (1, 13)),
298
('BzrDir.open_branch', None),
300
for verb, required_version in candidate_calls:
301
if required_version and medium._is_remote_before(required_version):
304
response = self._call(verb, path)
305
except errors.UnknownSmartMethod:
306
if required_version is None:
308
medium._remember_remote_is_before(required_version)
311
if verb == 'BzrDir.open_branch':
312
if response[0] != 'ok':
313
raise errors.UnexpectedSmartServerResponse(response)
314
if response[1] != '':
315
return ('ref', response[1])
317
return ('branch', '')
318
if response[0] not in ('ref', 'branch'):
319
134
raise errors.UnexpectedSmartServerResponse(response)
322
136
def _get_tree_branch(self):
323
137
"""See BzrDir._get_tree_branch()."""
324
138
return None, self.open_branch()
326
def open_branch(self, name=None, unsupported=False,
327
ignore_fallbacks=False):
140
def open_branch(self, _unsupported=False):
329
142
raise NotImplementedError('unsupported flag support not implemented yet.')
330
if self._next_open_branch_result is not None:
331
# See create_branch for details.
332
result = self._next_open_branch_result
333
self._next_open_branch_result = None
335
response = self._get_branch_reference()
336
if response[0] == 'ref':
143
reference_url = self.get_branch_reference()
144
if reference_url is None:
145
# branch at this location.
146
return RemoteBranch(self, self.find_repository())
337
148
# a branch reference, use the existing BranchReference logic.
338
149
format = BranchReferenceFormat()
339
return format.open(self, name=name, _found=True,
340
location=response[1], ignore_fallbacks=ignore_fallbacks)
341
branch_format_name = response[1]
342
if not branch_format_name:
343
branch_format_name = None
344
format = RemoteBranchFormat(network_name=branch_format_name)
345
return RemoteBranch(self, self.find_repository(), format=format,
346
setup_stacking=not ignore_fallbacks, name=name)
348
def _open_repo_v1(self, path):
349
verb = 'BzrDir.find_repository'
350
response = self._call(verb, path)
351
if response[0] != 'ok':
352
raise errors.UnexpectedSmartServerResponse(response)
353
# servers that only support the v1 method don't support external
356
repo = self._real_bzrdir.open_repository()
357
response = response + ('no', repo._format.network_name())
358
return response, repo
360
def _open_repo_v2(self, path):
150
return format.open(self, _found=True, location=reference_url)
152
def open_repository(self):
153
path = self._path_for_remote_call(self._client)
361
154
verb = 'BzrDir.find_repositoryV2'
362
response = self._call(verb, path)
363
if response[0] != 'ok':
364
raise errors.UnexpectedSmartServerResponse(response)
366
repo = self._real_bzrdir.open_repository()
367
response = response + (repo._format.network_name(),)
368
return response, repo
370
def _open_repo_v3(self, path):
371
verb = 'BzrDir.find_repositoryV3'
372
medium = self._client._medium
373
if medium._is_remote_before((1, 13)):
374
raise errors.UnknownSmartMethod(verb)
376
response = self._call(verb, path)
377
except errors.UnknownSmartMethod:
378
medium._remember_remote_is_before((1, 13))
380
if response[0] != 'ok':
381
raise errors.UnexpectedSmartServerResponse(response)
382
return response, None
384
def open_repository(self):
385
path = self._path_for_remote_call(self._client)
387
for probe in [self._open_repo_v3, self._open_repo_v2,
390
response, real_repo = probe(path)
157
response = self._client.call(verb, path)
392
158
except errors.UnknownSmartMethod:
395
raise errors.UnknownSmartMethod('BzrDir.find_repository{3,2,}')
159
verb = 'BzrDir.find_repository'
160
response = self._client.call(verb, path)
161
except errors.ErrorFromSmartServer, err:
162
if err.error_verb == 'norepository':
163
raise errors.NoRepositoryPresent(self)
396
165
if response[0] != 'ok':
397
166
raise errors.UnexpectedSmartServerResponse(response)
398
if len(response) != 6:
167
if verb == 'BzrDir.find_repository':
168
# servers that don't support the V2 method don't support external
170
response = response + ('no', )
171
if not (len(response) == 5):
399
172
raise SmartProtocolError('incorrect response length %s' % (response,))
400
173
if response[1] == '':
401
# repo is at this dir.
402
format = response_tuple_to_repo_format(response[2:])
403
# Used to support creating a real format instance when needed.
404
format._creating_bzrdir = self
405
remote_repo = RemoteRepository(self, format)
406
format._creating_repo = remote_repo
407
if real_repo is not None:
408
remote_repo._set_real_repository(real_repo)
174
format = RemoteRepositoryFormat()
175
format.rich_root_data = (response[2] == 'yes')
176
format.supports_tree_reference = (response[3] == 'yes')
177
# No wire format to check this yet.
178
format.supports_external_lookups = (response[4] == 'yes')
179
return RemoteRepository(self, format)
411
181
raise errors.NoRepositoryPresent(self)
413
def has_workingtree(self):
414
if self._has_working_tree is None:
416
self._has_working_tree = self._real_bzrdir.has_workingtree()
417
return self._has_working_tree
419
183
def open_workingtree(self, recommend_upgrade=True):
420
if self.has_workingtree():
185
if self._real_bzrdir.has_workingtree():
421
186
raise errors.NotLocalUrl(self.root_transport)
423
188
raise errors.NoWorkingTree(self.root_transport.base)
470
228
the attributes rich_root_data and supports_tree_reference are set
471
229
on a per instance basis, and are not set (and should not be) at
474
:ivar _custom_format: If set, a specific concrete repository format that
475
will be used when initializing a repository with this
476
RemoteRepositoryFormat.
477
:ivar _creating_repo: If set, the repository object that this
478
RemoteRepositoryFormat was created for: it can be called into
479
to obtain data like the network name.
482
_matchingbzrdir = RemoteBzrDirFormat()
485
repository.RepositoryFormat.__init__(self)
486
self._custom_format = None
487
self._network_name = None
488
self._creating_bzrdir = None
489
self._supports_chks = None
490
self._supports_external_lookups = None
491
self._supports_tree_reference = None
492
self._rich_root_data = None
495
return "%s(_network_name=%r)" % (self.__class__.__name__,
499
def fast_deltas(self):
501
return self._custom_format.fast_deltas
504
def rich_root_data(self):
505
if self._rich_root_data is None:
507
self._rich_root_data = self._custom_format.rich_root_data
508
return self._rich_root_data
511
def supports_chks(self):
512
if self._supports_chks is None:
514
self._supports_chks = self._custom_format.supports_chks
515
return self._supports_chks
518
def supports_external_lookups(self):
519
if self._supports_external_lookups is None:
521
self._supports_external_lookups = \
522
self._custom_format.supports_external_lookups
523
return self._supports_external_lookups
526
def supports_tree_reference(self):
527
if self._supports_tree_reference is None:
529
self._supports_tree_reference = \
530
self._custom_format.supports_tree_reference
531
return self._supports_tree_reference
533
def _vfs_initialize(self, a_bzrdir, shared):
534
"""Helper for common code in initialize."""
535
if self._custom_format:
536
# Custom format requested
537
result = self._custom_format.initialize(a_bzrdir, shared=shared)
538
elif self._creating_bzrdir is not None:
539
# Use the format that the repository we were created to back
541
prior_repo = self._creating_bzrdir.open_repository()
542
prior_repo._ensure_real()
543
result = prior_repo._real_repository._format.initialize(
544
a_bzrdir, shared=shared)
546
# assume that a_bzr is a RemoteBzrDir but the smart server didn't
547
# support remote initialization.
548
# We delegate to a real object at this point (as RemoteBzrDir
549
# delegate to the repository format which would lead to infinite
550
# recursion if we just called a_bzrdir.create_repository.
551
a_bzrdir._ensure_real()
552
result = a_bzrdir._real_bzrdir.create_repository(shared=shared)
553
if not isinstance(result, RemoteRepository):
554
return self.open(a_bzrdir)
233
_matchingbzrdir = RemoteBzrDirFormat
558
235
def initialize(self, a_bzrdir, shared=False):
559
# Being asked to create on a non RemoteBzrDir:
560
236
if not isinstance(a_bzrdir, RemoteBzrDir):
561
return self._vfs_initialize(a_bzrdir, shared)
562
medium = a_bzrdir._client._medium
563
if medium._is_remote_before((1, 13)):
564
return self._vfs_initialize(a_bzrdir, shared)
565
# Creating on a remote bzr dir.
566
# 1) get the network name to use.
567
if self._custom_format:
568
network_name = self._custom_format.network_name()
569
elif self._network_name:
570
network_name = self._network_name
572
# Select the current bzrlib default and ask for that.
573
reference_bzrdir_format = bzrdir.format_registry.get('default')()
574
reference_format = reference_bzrdir_format.repository_format
575
network_name = reference_format.network_name()
576
# 2) try direct creation via RPC
577
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
578
verb = 'BzrDir.create_repository'
584
response = a_bzrdir._call(verb, path, network_name, shared_str)
585
except errors.UnknownSmartMethod:
586
# Fallback - use vfs methods
587
medium._remember_remote_is_before((1, 13))
588
return self._vfs_initialize(a_bzrdir, shared)
590
# Turn the response into a RemoteRepository object.
591
format = response_tuple_to_repo_format(response[1:])
592
# Used to support creating a real format instance when needed.
593
format._creating_bzrdir = a_bzrdir
594
remote_repo = RemoteRepository(a_bzrdir, format)
595
format._creating_repo = remote_repo
237
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
238
return a_bzrdir.create_repository(shared=shared)
598
240
def open(self, a_bzrdir):
599
241
if not isinstance(a_bzrdir, RemoteBzrDir):
600
242
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
601
243
return a_bzrdir.open_repository()
603
def _ensure_real(self):
604
if self._custom_format is None:
605
self._custom_format = repository.network_format_registry.get(
609
def _fetch_order(self):
611
return self._custom_format._fetch_order
614
def _fetch_uses_deltas(self):
616
return self._custom_format._fetch_uses_deltas
619
def _fetch_reconcile(self):
621
return self._custom_format._fetch_reconcile
623
245
def get_format_description(self):
625
return 'Remote: ' + self._custom_format.get_format_description()
246
return 'bzr remote repository'
627
248
def __eq__(self, other):
628
return self.__class__ is other.__class__
630
def network_name(self):
631
if self._network_name:
632
return self._network_name
633
self._creating_repo._ensure_real()
634
return self._creating_repo._real_repository._format.network_name()
637
def pack_compresses(self):
639
return self._custom_format.pack_compresses
642
def _serializer(self):
644
return self._custom_format._serializer
647
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
648
bzrdir.ControlComponent):
249
return self.__class__ == other.__class__
251
def check_conversion_target(self, target_format):
252
if self.rich_root_data and not target_format.rich_root_data:
253
raise errors.BadConversionTarget(
254
'Does not support rich root data.', target_format)
255
if (self.supports_tree_reference and
256
not getattr(target_format, 'supports_tree_reference', False)):
257
raise errors.BadConversionTarget(
258
'Does not support nested trees', target_format)
261
class RemoteRepository(object):
649
262
"""Repository accessed over rpc.
651
264
For the moment most operations are performed using local transport-backed
745
331
self._ensure_real()
746
332
return self._real_repository.commit_write_group()
748
def resume_write_group(self, tokens):
750
return self._real_repository.resume_write_group(tokens)
752
def suspend_write_group(self):
754
return self._real_repository.suspend_write_group()
756
def get_missing_parent_inventories(self, check_for_missing_texts=True):
758
return self._real_repository.get_missing_parent_inventories(
759
check_for_missing_texts=check_for_missing_texts)
761
def _get_rev_id_for_revno_vfs(self, revno, known_pair):
763
return self._real_repository.get_rev_id_for_revno(
766
def get_rev_id_for_revno(self, revno, known_pair):
767
"""See Repository.get_rev_id_for_revno."""
768
path = self.bzrdir._path_for_remote_call(self._client)
770
if self._client._medium._is_remote_before((1, 17)):
771
return self._get_rev_id_for_revno_vfs(revno, known_pair)
772
response = self._call(
773
'Repository.get_rev_id_for_revno', path, revno, known_pair)
774
except errors.UnknownSmartMethod:
775
self._client._medium._remember_remote_is_before((1, 17))
776
return self._get_rev_id_for_revno_vfs(revno, known_pair)
777
if response[0] == 'ok':
778
return True, response[1]
779
elif response[0] == 'history-incomplete':
780
known_pair = response[1:3]
781
for fallback in self._fallback_repositories:
782
found, result = fallback.get_rev_id_for_revno(revno, known_pair)
787
# Not found in any fallbacks
788
return False, known_pair
790
raise errors.UnexpectedSmartServerResponse(response)
792
334
def _ensure_real(self):
793
335
"""Ensure that there is a _real_repository set.
795
337
Used before calls to self._real_repository.
797
Note that _ensure_real causes many roundtrips to the server which are
798
not desirable, and prevents the use of smart one-roundtrip RPC's to
799
perform complex operations (such as accessing parent data, streaming
800
revisions etc). Adding calls to _ensure_real should only be done when
801
bringing up new functionality, adding fallbacks for smart methods that
802
require a fallback path, and never to replace an existing smart method
803
invocation. If in doubt chat to the bzr network team.
805
if self._real_repository is None:
806
if 'hpssvfs' in debug.debug_flags:
808
warning('VFS Repository access triggered\n%s',
809
''.join(traceback.format_stack()))
810
self._unstacked_provider.missing_keys.clear()
339
if not self._real_repository:
811
340
self.bzrdir._ensure_real()
812
self._set_real_repository(
813
self.bzrdir._real_bzrdir.open_repository())
815
def _translate_error(self, err, **context):
816
self.bzrdir._translate_error(err, repository=self, **context)
341
#self._real_repository = self.bzrdir._real_bzrdir.open_repository()
342
self._set_real_repository(self.bzrdir._real_bzrdir.open_repository())
818
344
def find_text_key_references(self):
819
345
"""Find the text key references within the repository.
862
398
for line in lines:
863
399
d = tuple(line.split())
864
400
revision_graph[d[0]] = d[1:]
866
402
return revision_graph
869
"""See Repository._get_sink()."""
870
return RemoteStreamSink(self)
872
def _get_source(self, to_format):
873
"""Return a source for streaming from this repository."""
874
return RemoteStreamSource(self, to_format)
877
404
def has_revision(self, revision_id):
878
"""True if this repository has a copy of the revision."""
879
# Copy of bzrlib.repository.Repository.has_revision
880
return revision_id in self.has_revisions((revision_id,))
405
"""See Repository.has_revision()."""
406
if revision_id == NULL_REVISION:
407
# The null revision is always present.
409
path = self.bzrdir._path_for_remote_call(self._client)
410
response = self._client.call(
411
'Repository.has_revision', path, revision_id)
412
if response[0] not in ('yes', 'no'):
413
raise errors.UnexpectedSmartServerResponse(response)
414
return response[0] == 'yes'
883
416
def has_revisions(self, revision_ids):
884
"""Probe to find out the presence of multiple revisions.
886
:param revision_ids: An iterable of revision_ids.
887
:return: A set of the revision_ids that were present.
889
# Copy of bzrlib.repository.Repository.has_revisions
890
parent_map = self.get_parent_map(revision_ids)
891
result = set(parent_map)
892
if _mod_revision.NULL_REVISION in revision_ids:
893
result.add(_mod_revision.NULL_REVISION)
417
"""See Repository.has_revisions()."""
419
for revision_id in revision_ids:
420
if self.has_revision(revision_id):
421
result.add(revision_id)
896
def _has_same_fallbacks(self, other_repo):
897
"""Returns true if the repositories have the same fallbacks."""
898
# XXX: copied from Repository; it should be unified into a base class
899
# <https://bugs.edge.launchpad.net/bzr/+bug/401622>
900
my_fb = self._fallback_repositories
901
other_fb = other_repo._fallback_repositories
902
if len(my_fb) != len(other_fb):
904
for f, g in zip(my_fb, other_fb):
905
if not f.has_same_location(g):
909
424
def has_same_location(self, other):
910
# TODO: Move to RepositoryBase and unify with the regular Repository
911
# one; unfortunately the tests rely on slightly different behaviour at
912
# present -- mbp 20090710
913
return (self.__class__ is other.__class__ and
425
return (self.__class__ == other.__class__ and
914
426
self.bzrdir.transport.base == other.bzrdir.transport.base)
916
428
def get_graph(self, other_repository=None):
917
429
"""Return the graph for this repository format"""
918
parents_provider = self._make_parents_provider(other_repository)
430
parents_provider = self
431
if (other_repository is not None and
432
other_repository.bzrdir.transport.base !=
433
self.bzrdir.transport.base):
434
parents_provider = graph._StackedParentsProvider(
435
[parents_provider, other_repository._make_parents_provider()])
919
436
return graph.Graph(parents_provider)
922
def get_known_graph_ancestry(self, revision_ids):
923
"""Return the known graph for a set of revision ids and their ancestors.
925
st = static_tuple.StaticTuple
926
revision_keys = [st(r_id).intern() for r_id in revision_ids]
927
known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
928
return graph.GraphThunkIdsToKeys(known_graph)
930
438
def gather_stats(self, revid=None, committers=None):
931
439
"""See Repository.gather_stats()."""
932
440
path = self.bzrdir._path_for_remote_call(self._client)
992
500
def is_write_locked(self):
993
501
return self._lock_mode == 'w'
995
def _warn_if_deprecated(self, branch=None):
996
# If we have a real repository, the check will be done there, if we
997
# don't the check will be done remotely.
1000
503
def lock_read(self):
1001
"""Lock the repository for read operations.
1003
:return: A bzrlib.lock.LogicalLockResult.
1005
504
# wrong eventually - want a local lock cache context
1006
505
if not self._lock_mode:
1007
self._note_lock('r')
1008
506
self._lock_mode = 'r'
1009
507
self._lock_count = 1
1010
self._unstacked_provider.enable_cache(cache_misses=True)
508
self._parents_map = {}
509
if 'hpss' in debug.debug_flags:
510
self._requested_parents = set()
1011
511
if self._real_repository is not None:
1012
512
self._real_repository.lock_read()
1013
for repo in self._fallback_repositories:
1016
514
self._lock_count += 1
1017
return lock.LogicalLockResult(self.unlock)
1019
516
def _remote_lock_write(self, token):
1020
517
path = self.bzrdir._path_for_remote_call(self._client)
1021
518
if token is None:
1023
err_context = {'token': token}
1024
response = self._call('Repository.lock_write', path, token,
521
response = self._client.call('Repository.lock_write', path, token)
522
except errors.ErrorFromSmartServer, err:
523
if err.error_verb == 'LockContention':
524
raise errors.LockContention('(remote lock)')
525
elif err.error_verb == 'UnlockableTransport':
526
raise errors.UnlockableTransport(self.bzrdir.root_transport)
527
elif err.error_verb == 'LockFailed':
528
raise errors.LockFailed(err.error_args[0], err.error_args[1])
1026
531
if response[0] == 'ok':
1027
532
ok, token = response
1030
535
raise errors.UnexpectedSmartServerResponse(response)
1032
def lock_write(self, token=None, _skip_rpc=False):
537
def lock_write(self, token=None):
1033
538
if not self._lock_mode:
1034
self._note_lock('w')
1036
if self._lock_token is not None:
1037
if token != self._lock_token:
1038
raise errors.TokenMismatch(token, self._lock_token)
1039
self._lock_token = token
1041
self._lock_token = self._remote_lock_write(token)
539
self._lock_token = self._remote_lock_write(token)
1042
540
# if self._lock_token is None, then this is something like packs or
1043
541
# svn where we don't get to lock the repo, or a weave style repository
1044
542
# where we cannot lock it over the wire and attempts to do so will
1224
690
# FIXME: It ought to be possible to call this without immediately
1225
691
# triggering _ensure_real. For now it's the easiest thing to do.
1226
692
self._ensure_real()
1227
real_repo = self._real_repository
1228
builder = real_repo.get_commit_builder(branch, parents,
693
builder = self._real_repository.get_commit_builder(branch, parents,
1229
694
config, timestamp=timestamp, timezone=timezone,
1230
695
committer=committer, revprops=revprops, revision_id=revision_id)
1233
def add_fallback_repository(self, repository):
1234
"""Add a repository to use for looking up data not held locally.
1236
:param repository: A repository.
1238
if not self._format.supports_external_lookups:
1239
raise errors.UnstackableRepositoryFormat(
1240
self._format.network_name(), self.base)
1241
# We need to accumulate additional repositories here, to pass them in
1244
if self.is_locked():
1245
# We will call fallback.unlock() when we transition to the unlocked
1246
# state, so always add a lock here. If a caller passes us a locked
1247
# repository, they are responsible for unlocking it later.
1248
repository.lock_read()
1249
self._check_fallback_repository(repository)
1250
self._fallback_repositories.append(repository)
1251
# If self._real_repository was parameterised already (e.g. because a
1252
# _real_branch had its get_stacked_on_url method called), then the
1253
# repository to be added may already be in the _real_repositories list.
1254
if self._real_repository is not None:
1255
fallback_locations = [repo.user_url for repo in
1256
self._real_repository._fallback_repositories]
1257
if repository.user_url not in fallback_locations:
1258
self._real_repository.add_fallback_repository(repository)
1260
def _check_fallback_repository(self, repository):
1261
"""Check that this repository can fallback to repository safely.
1263
Raise an error if not.
1265
:param repository: A repository to fallback to.
1267
return _mod_repository.InterRepository._assert_same_model(
1270
698
def add_inventory(self, revid, inv, parents):
1271
699
self._ensure_real()
1272
700
return self._real_repository.add_inventory(revid, inv, parents)
1274
def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1275
parents, basis_inv=None, propagate_caches=False):
1277
return self._real_repository.add_inventory_by_delta(basis_revision_id,
1278
delta, new_revision_id, parents, basis_inv=basis_inv,
1279
propagate_caches=propagate_caches)
1281
702
def add_revision(self, rev_id, rev, inv=None, config=None):
1282
703
self._ensure_real()
1283
704
return self._real_repository.add_revision(
1349
761
return repository.InterRepository.get(
1350
762
other, self).search_missing_revision_ids(revision_id, find_ghosts)
1352
def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1354
# No base implementation to use as RemoteRepository is not a subclass
1355
# of Repository; so this is a copy of Repository.fetch().
1356
if fetch_spec is not None and revision_id is not None:
1357
raise AssertionError(
1358
"fetch_spec and revision_id are mutually exclusive.")
1359
if self.is_in_write_group():
1360
raise errors.InternalBzrError(
1361
"May not fetch while in a write group.")
1362
# fast path same-url fetch operations
1363
if (self.has_same_location(source)
1364
and fetch_spec is None
1365
and self._has_same_fallbacks(source)):
764
def fetch(self, source, revision_id=None, pb=None):
765
if self.has_same_location(source):
1366
766
# check that last_revision is in 'from' and then return a
1368
768
if (revision_id is not None and
1369
769
not revision.is_null(revision_id)):
1370
770
self.get_revision(revision_id)
1372
# if there is no specific appropriate InterRepository, this will get
1373
# the InterRepository base class, which raises an
1374
# IncompatibleRepositories when asked to fetch.
1375
inter = repository.InterRepository.get(source, self)
1376
return inter.fetch(revision_id=revision_id, pb=pb,
1377
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
773
return self._real_repository.fetch(
774
source, revision_id=revision_id, pb=pb)
1379
776
def create_bundle(self, target, base, fileobj, format=None):
1380
777
self._ensure_real()
1381
778
self._real_repository.create_bundle(target, base, fileobj, format)
781
def control_weaves(self):
783
return self._real_repository.control_weaves
1383
785
@needs_read_lock
1384
786
def get_ancestry(self, revision_id, topo_sorted=True):
1385
787
self._ensure_real()
1386
788
return self._real_repository.get_ancestry(revision_id, topo_sorted)
791
def get_inventory_weave(self):
793
return self._real_repository.get_inventory_weave()
1388
795
def fileids_altered_by_revision_ids(self, revision_ids):
1389
796
self._ensure_real()
1390
797
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
1393
800
self._ensure_real()
1394
801
return self._real_repository._get_versioned_file_checker(
1395
802
revisions, revision_versions_cache)
1397
804
def iter_files_bytes(self, desired_files):
1398
805
"""See Repository.iter_file_bytes.
1400
807
self._ensure_real()
1401
808
return self._real_repository.iter_files_bytes(desired_files)
1403
def get_parent_map(self, revision_ids):
810
def get_parent_map(self, keys):
1404
811
"""See bzrlib.Graph.get_parent_map()."""
1405
return self._make_parents_provider().get_parent_map(revision_ids)
812
# Hack to build up the caching logic.
813
ancestry = self._parents_map
815
# Repository is not locked, so there's no cache.
816
missing_revisions = set(keys)
819
missing_revisions = set(key for key in keys if key not in ancestry)
820
if missing_revisions:
821
parent_map = self._get_parent_map(missing_revisions)
822
if 'hpss' in debug.debug_flags:
823
mutter('retransmitted revisions: %d of %d',
824
len(set(ancestry).intersection(parent_map)),
826
ancestry.update(parent_map)
827
present_keys = [k for k in keys if k in ancestry]
828
if 'hpss' in debug.debug_flags:
829
if self._requested_parents is not None and len(ancestry) != 0:
830
self._requested_parents.update(present_keys)
831
mutter('Current RemoteRepository graph hit rate: %d%%',
832
100.0 * len(self._requested_parents) / len(ancestry))
833
return dict((k, ancestry[k]) for k in present_keys)
1407
def _get_parent_map_rpc(self, keys):
835
def _get_parent_map(self, keys):
1408
836
"""Helper for get_parent_map that performs the RPC."""
1409
837
medium = self._client._medium
1410
if medium._is_remote_before((1, 2)):
838
if not medium._remote_is_at_least_1_2:
1411
839
# We already found out that the server can't understand
1412
840
# Repository.get_parent_map requests, so just fetch the whole
1415
# Note that this reads the whole graph, when only some keys are
1416
# wanted. On this old server there's no way (?) to get them all
1417
# in one go, and the user probably will have seen a warning about
1418
# the server being old anyhow.
1419
rg = self._get_revision_graph(None)
1420
# There is an API discrepancy between get_parent_map and
842
# XXX: Note that this will issue a deprecation warning. This is ok
843
# :- its because we're working with a deprecated server anyway, and
844
# the user will almost certainly have seen a warning about the
845
# server version already.
846
rg = self.get_revision_graph()
847
# There is an api discrepency between get_parent_map and
1421
848
# get_revision_graph. Specifically, a "key:()" pair in
1422
849
# get_revision_graph just means a node has no parents. For
1423
850
# "get_parent_map" it means the node is a ghost. So fix up the
1614
1022
# TODO: Suggestion from john: using external tar is much faster than
1615
1023
# python's tarfile library, but it may not work on windows.
1618
def inventories(self):
1619
"""Decorate the real repository for now.
1621
In the long term a full blown network facility is needed to
1622
avoid creating a real repository object locally.
1625
return self._real_repository.inventories
1627
1025
@needs_write_lock
1628
def pack(self, hint=None, clean_obsolete_packs=False):
1629
1027
"""Compress the data within the repository.
1631
1029
This is not currently implemented within the smart server.
1633
1031
self._ensure_real()
1634
return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
1637
def revisions(self):
1638
"""Decorate the real repository for now.
1640
In the short term this should become a real object to intercept graph
1643
In the long term a full blown network facility is needed.
1646
return self._real_repository.revisions
1032
return self._real_repository.pack()
1648
1034
def set_make_working_trees(self, new_value):
1650
new_value_str = "True"
1652
new_value_str = "False"
1653
path = self.bzrdir._path_for_remote_call(self._client)
1655
response = self._call(
1656
'Repository.set_make_working_trees', path, new_value_str)
1657
except errors.UnknownSmartMethod:
1659
self._real_repository.set_make_working_trees(new_value)
1661
if response[0] != 'ok':
1662
raise errors.UnexpectedSmartServerResponse(response)
1665
def signatures(self):
1666
"""Decorate the real repository for now.
1668
In the long term a full blown network facility is needed to avoid
1669
creating a real repository object locally.
1671
1035
self._ensure_real()
1672
return self._real_repository.signatures
1036
self._real_repository.set_make_working_trees(new_value)
1674
1038
@needs_write_lock
1675
1039
def sign_revision(self, revision_id, gpg_strategy):
1676
1040
self._ensure_real()
1677
1041
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1681
"""Decorate the real repository for now.
1683
In the long term a full blown network facility is needed to avoid
1684
creating a real repository object locally.
1687
return self._real_repository.texts
1689
1043
@needs_read_lock
1690
1044
def get_revisions(self, revision_ids):
1691
1045
self._ensure_real()
1692
1046
return self._real_repository.get_revisions(revision_ids)
1694
1048
def supports_rich_root(self):
1695
return self._format.rich_root_data
1050
return self._real_repository.supports_rich_root()
1697
1052
def iter_reverse_revision_history(self, revision_id):
1698
1053
self._ensure_real()
1715
1071
self._ensure_real()
1716
1072
return self._real_repository.has_signature_for_revision_id(revision_id)
1074
def get_data_stream_for_search(self, search):
1075
medium = self._client._medium
1076
if not medium._remote_is_at_least_1_2:
1078
return self._real_repository.get_data_stream_for_search(search)
1079
REQUEST_NAME = 'Repository.stream_revisions_chunked'
1080
path = self.bzrdir._path_for_remote_call(self._client)
1081
body = self._serialise_search_recipe(search.get_recipe())
1083
result = self._client.call_with_body_bytes_expecting_body(
1084
REQUEST_NAME, (path,), body)
1085
response, protocol = result
1086
except errors.UnknownSmartMethod:
1087
# Server does not support this method, so fall back to VFS.
1088
# Worse, we have to force a disconnection, because the server now
1089
# doesn't realise it has a body on the wire to consume, so the
1090
# only way to recover is to abandon the connection.
1092
'Server is too old for streaming pull, reconnecting. '
1093
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1095
# To avoid having to disconnect repeatedly, we keep track of the
1096
# fact the server doesn't understand this remote method.
1097
medium._remote_is_at_least_1_2 = False
1099
return self._real_repository.get_data_stream_for_search(search)
1101
if response == ('ok',):
1102
return self._deserialise_stream(protocol)
1103
if response == ('NoSuchRevision', ):
1104
# We cannot easily identify the revision that is missing in this
1105
# situation without doing much more network IO. For now, bail.
1106
raise NoSuchRevision(self, "unknown")
1108
raise errors.UnexpectedSmartServerResponse(response)
1110
def _deserialise_stream(self, protocol):
1111
stream = protocol.read_streamed_body()
1112
container_parser = ContainerPushParser()
1113
for bytes in stream:
1114
container_parser.accept_bytes(bytes)
1115
records = container_parser.read_pending_records()
1116
for record_names, record_bytes in records:
1117
if len(record_names) != 1:
1118
# These records should have only one name, and that name
1119
# should be a one-element tuple.
1120
raise errors.SmartProtocolError(
1121
'Repository data stream had invalid record name %r'
1123
name_tuple = record_names[0]
1124
yield name_tuple, record_bytes
1126
def insert_data_stream(self, stream):
1128
self._real_repository.insert_data_stream(stream)
1718
1130
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1719
1131
self._ensure_real()
1720
1132
return self._real_repository.item_keys_introduced_by(revision_ids,
1748
1154
:param recipe: A search recipe (start, stop, count).
1749
1155
:return: Serialised bytes.
1751
start_keys = ' '.join(recipe[1])
1752
stop_keys = ' '.join(recipe[2])
1753
count = str(recipe[3])
1157
start_keys = ' '.join(recipe[0])
1158
stop_keys = ' '.join(recipe[1])
1159
count = str(recipe[2])
1754
1160
return '\n'.join((start_keys, stop_keys, count))
1756
def _serialise_search_result(self, search_result):
1757
if isinstance(search_result, graph.PendingAncestryResult):
1758
parts = ['ancestry-of']
1759
parts.extend(search_result.heads)
1761
recipe = search_result.get_recipe()
1762
parts = [recipe[0], self._serialise_search_recipe(recipe)]
1763
return '\n'.join(parts)
1766
path = self.bzrdir._path_for_remote_call(self._client)
1768
response = self._call('PackRepository.autopack', path)
1769
except errors.UnknownSmartMethod:
1771
self._real_repository._pack_collection.autopack()
1774
if response[0] != 'ok':
1775
raise errors.UnexpectedSmartServerResponse(response)
1778
class RemoteStreamSink(repository.StreamSink):
1780
def _insert_real(self, stream, src_format, resume_tokens):
1781
self.target_repo._ensure_real()
1782
sink = self.target_repo._real_repository._get_sink()
1783
result = sink.insert_stream(stream, src_format, resume_tokens)
1785
self.target_repo.autopack()
1788
def insert_stream(self, stream, src_format, resume_tokens):
1789
target = self.target_repo
1790
target._unstacked_provider.missing_keys.clear()
1791
candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
1792
if target._lock_token:
1793
candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
1794
lock_args = (target._lock_token or '',)
1796
candidate_calls.append(('Repository.insert_stream', (1, 13)))
1798
client = target._client
1799
medium = client._medium
1800
path = target.bzrdir._path_for_remote_call(client)
1801
# Probe for the verb to use with an empty stream before sending the
1802
# real stream to it. We do this both to avoid the risk of sending a
1803
# large request that is then rejected, and because we don't want to
1804
# implement a way to buffer, rewind, or restart the stream.
1806
for verb, required_version in candidate_calls:
1807
if medium._is_remote_before(required_version):
1810
# We've already done the probing (and set _is_remote_before) on
1811
# a previous insert.
1814
byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1816
response = client.call_with_body_stream(
1817
(verb, path, '') + lock_args, byte_stream)
1818
except errors.UnknownSmartMethod:
1819
medium._remember_remote_is_before(required_version)
1825
return self._insert_real(stream, src_format, resume_tokens)
1826
self._last_inv_record = None
1827
self._last_substream = None
1828
if required_version < (1, 19):
1829
# Remote side doesn't support inventory deltas. Wrap the stream to
1830
# make sure we don't send any. If the stream contains inventory
1831
# deltas we'll interrupt the smart insert_stream request and
1833
stream = self._stop_stream_if_inventory_delta(stream)
1834
byte_stream = smart_repo._stream_to_byte_stream(
1836
resume_tokens = ' '.join(resume_tokens)
1837
response = client.call_with_body_stream(
1838
(verb, path, resume_tokens) + lock_args, byte_stream)
1839
if response[0][0] not in ('ok', 'missing-basis'):
1840
raise errors.UnexpectedSmartServerResponse(response)
1841
if self._last_substream is not None:
1842
# The stream included an inventory-delta record, but the remote
1843
# side isn't new enough to support them. So we need to send the
1844
# rest of the stream via VFS.
1845
self.target_repo.refresh_data()
1846
return self._resume_stream_with_vfs(response, src_format)
1847
if response[0][0] == 'missing-basis':
1848
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1849
resume_tokens = tokens
1850
return resume_tokens, set(missing_keys)
1852
self.target_repo.refresh_data()
1855
def _resume_stream_with_vfs(self, response, src_format):
1856
"""Resume sending a stream via VFS, first resending the record and
1857
substream that couldn't be sent via an insert_stream verb.
1859
if response[0][0] == 'missing-basis':
1860
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1861
# Ignore missing_keys, we haven't finished inserting yet
1864
def resume_substream():
1865
# Yield the substream that was interrupted.
1866
for record in self._last_substream:
1868
self._last_substream = None
1869
def resume_stream():
1870
# Finish sending the interrupted substream
1871
yield ('inventory-deltas', resume_substream())
1872
# Then simply continue sending the rest of the stream.
1873
for substream_kind, substream in self._last_stream:
1874
yield substream_kind, substream
1875
return self._insert_real(resume_stream(), src_format, tokens)
1877
def _stop_stream_if_inventory_delta(self, stream):
1878
"""Normally this just lets the original stream pass-through unchanged.
1880
However if any 'inventory-deltas' substream occurs it will stop
1881
streaming, and store the interrupted substream and stream in
1882
self._last_substream and self._last_stream so that the stream can be
1883
resumed by _resume_stream_with_vfs.
1886
stream_iter = iter(stream)
1887
for substream_kind, substream in stream_iter:
1888
if substream_kind == 'inventory-deltas':
1889
self._last_substream = substream
1890
self._last_stream = stream_iter
1893
yield substream_kind, substream
1896
class RemoteStreamSource(repository.StreamSource):
1897
"""Stream data from a remote server."""
1899
def get_stream(self, search):
1900
if (self.from_repository._fallback_repositories and
1901
self.to_format._fetch_order == 'topological'):
1902
return self._real_stream(self.from_repository, search)
1905
repos = [self.from_repository]
1911
repos.extend(repo._fallback_repositories)
1912
sources.append(repo)
1913
return self.missing_parents_chain(search, sources)
1915
def get_stream_for_missing_keys(self, missing_keys):
1916
self.from_repository._ensure_real()
1917
real_repo = self.from_repository._real_repository
1918
real_source = real_repo._get_source(self.to_format)
1919
return real_source.get_stream_for_missing_keys(missing_keys)
1921
def _real_stream(self, repo, search):
1922
"""Get a stream for search from repo.
1924
This never called RemoteStreamSource.get_stream, and is a heler
1925
for RemoteStreamSource._get_stream to allow getting a stream
1926
reliably whether fallback back because of old servers or trying
1927
to stream from a non-RemoteRepository (which the stacked support
1930
source = repo._get_source(self.to_format)
1931
if isinstance(source, RemoteStreamSource):
1933
source = repo._real_repository._get_source(self.to_format)
1934
return source.get_stream(search)
1936
def _get_stream(self, repo, search):
1937
"""Core worker to get a stream from repo for search.
1939
This is used by both get_stream and the stacking support logic. It
1940
deliberately gets a stream for repo which does not need to be
1941
self.from_repository. In the event that repo is not Remote, or
1942
cannot do a smart stream, a fallback is made to the generic
1943
repository._get_stream() interface, via self._real_stream.
1945
In the event of stacking, streams from _get_stream will not
1946
contain all the data for search - this is normal (see get_stream).
1948
:param repo: A repository.
1949
:param search: A search.
1951
# Fallbacks may be non-smart
1952
if not isinstance(repo, RemoteRepository):
1953
return self._real_stream(repo, search)
1954
client = repo._client
1955
medium = client._medium
1956
path = repo.bzrdir._path_for_remote_call(client)
1957
search_bytes = repo._serialise_search_result(search)
1958
args = (path, self.to_format.network_name())
1960
('Repository.get_stream_1.19', (1, 19)),
1961
('Repository.get_stream', (1, 13))]
1963
for verb, version in candidate_verbs:
1964
if medium._is_remote_before(version):
1967
response = repo._call_with_body_bytes_expecting_body(
1968
verb, args, search_bytes)
1969
except errors.UnknownSmartMethod:
1970
medium._remember_remote_is_before(version)
1972
response_tuple, response_handler = response
1976
return self._real_stream(repo, search)
1977
if response_tuple[0] != 'ok':
1978
raise errors.UnexpectedSmartServerResponse(response_tuple)
1979
byte_stream = response_handler.read_streamed_body()
1980
src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
1981
if src_format.network_name() != repo._format.network_name():
1982
raise AssertionError(
1983
"Mismatched RemoteRepository and stream src %r, %r" % (
1984
src_format.network_name(), repo._format.network_name()))
1987
def missing_parents_chain(self, search, sources):
1988
"""Chain multiple streams together to handle stacking.
1990
:param search: The overall search to satisfy with streams.
1991
:param sources: A list of Repository objects to query.
1993
self.from_serialiser = self.from_repository._format._serializer
1994
self.seen_revs = set()
1995
self.referenced_revs = set()
1996
# If there are heads in the search, or the key count is > 0, we are not
1998
while not search.is_empty() and len(sources) > 1:
1999
source = sources.pop(0)
2000
stream = self._get_stream(source, search)
2001
for kind, substream in stream:
2002
if kind != 'revisions':
2003
yield kind, substream
2005
yield kind, self.missing_parents_rev_handler(substream)
2006
search = search.refine(self.seen_revs, self.referenced_revs)
2007
self.seen_revs = set()
2008
self.referenced_revs = set()
2009
if not search.is_empty():
2010
for kind, stream in self._get_stream(sources[0], search):
2013
def missing_parents_rev_handler(self, substream):
2014
for content in substream:
2015
revision_bytes = content.get_bytes_as('fulltext')
2016
revision = self.from_serialiser.read_revision_from_string(
2018
self.seen_revs.add(content.key[-1])
2019
self.referenced_revs.update(revision.parent_ids)
2023
1163
class RemoteBranchLockableFiles(LockableFiles):
2024
1164
"""A 'LockableFiles' implementation that talks to a smart server.
2026
1166
This is not a public interface class.
2043
1183
class RemoteBranchFormat(branch.BranchFormat):
2045
def __init__(self, network_name=None):
2046
super(RemoteBranchFormat, self).__init__()
2047
self._matchingbzrdir = RemoteBzrDirFormat()
2048
self._matchingbzrdir.set_branch_format(self)
2049
self._custom_format = None
2050
self._network_name = network_name
2052
1185
def __eq__(self, other):
2053
return (isinstance(other, RemoteBranchFormat) and
1186
return (isinstance(other, RemoteBranchFormat) and
2054
1187
self.__dict__ == other.__dict__)
2056
def _ensure_real(self):
2057
if self._custom_format is None:
2058
self._custom_format = branch.network_format_registry.get(
2061
1189
def get_format_description(self):
2063
return 'Remote: ' + self._custom_format.get_format_description()
2065
def network_name(self):
2066
return self._network_name
2068
def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
2069
return a_bzrdir.open_branch(name=name,
2070
ignore_fallbacks=ignore_fallbacks)
2072
def _vfs_initialize(self, a_bzrdir, name):
2073
# Initialisation when using a local bzrdir object, or a non-vfs init
2074
# method is not available on the server.
2075
# self._custom_format is always set - the start of initialize ensures
2077
if isinstance(a_bzrdir, RemoteBzrDir):
2078
a_bzrdir._ensure_real()
2079
result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2082
# We assume the bzrdir is parameterised; it may not be.
2083
result = self._custom_format.initialize(a_bzrdir, name)
2084
if (isinstance(a_bzrdir, RemoteBzrDir) and
2085
not isinstance(result, RemoteBranch)):
2086
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2090
def initialize(self, a_bzrdir, name=None):
2091
# 1) get the network name to use.
2092
if self._custom_format:
2093
network_name = self._custom_format.network_name()
2095
# Select the current bzrlib default and ask for that.
2096
reference_bzrdir_format = bzrdir.format_registry.get('default')()
2097
reference_format = reference_bzrdir_format.get_branch_format()
2098
self._custom_format = reference_format
2099
network_name = reference_format.network_name()
2100
# Being asked to create on a non RemoteBzrDir:
2101
if not isinstance(a_bzrdir, RemoteBzrDir):
2102
return self._vfs_initialize(a_bzrdir, name=name)
2103
medium = a_bzrdir._client._medium
2104
if medium._is_remote_before((1, 13)):
2105
return self._vfs_initialize(a_bzrdir, name=name)
2106
# Creating on a remote bzr dir.
2107
# 2) try direct creation via RPC
2108
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2109
if name is not None:
2110
# XXX JRV20100304: Support creating colocated branches
2111
raise errors.NoColocatedBranchSupport(self)
2112
verb = 'BzrDir.create_branch'
2114
response = a_bzrdir._call(verb, path, network_name)
2115
except errors.UnknownSmartMethod:
2116
# Fallback - use vfs methods
2117
medium._remember_remote_is_before((1, 13))
2118
return self._vfs_initialize(a_bzrdir, name=name)
2119
if response[0] != 'ok':
2120
raise errors.UnexpectedSmartServerResponse(response)
2121
# Turn the response into a RemoteRepository object.
2122
format = RemoteBranchFormat(network_name=response[1])
2123
repo_format = response_tuple_to_repo_format(response[3:])
2124
if response[2] == '':
2125
repo_bzrdir = a_bzrdir
2127
repo_bzrdir = RemoteBzrDir(
2128
a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
2130
remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2131
remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2132
format=format, setup_stacking=False, name=name)
2133
# XXX: We know this is a new branch, so it must have revno 0, revid
2134
# NULL_REVISION. Creating the branch locked would make this be unable
2135
# to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2136
remote_branch._last_revision_info_cache = 0, NULL_REVISION
2137
return remote_branch
2139
def make_tags(self, branch):
2141
return self._custom_format.make_tags(branch)
1190
return 'Remote BZR Branch'
1192
def get_format_string(self):
1193
return 'Remote BZR Branch'
1195
def open(self, a_bzrdir):
1196
return a_bzrdir.open_branch()
1198
def initialize(self, a_bzrdir):
1199
return a_bzrdir.create_branch()
2143
1201
def supports_tags(self):
2144
1202
# Remote branches might support tags, but we won't know until we
2145
1203
# access the real remote branch.
2147
return self._custom_format.supports_tags()
2149
def supports_stacking(self):
2151
return self._custom_format.supports_stacking()
2153
def supports_set_append_revisions_only(self):
2155
return self._custom_format.supports_set_append_revisions_only()
2158
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
1207
class RemoteBranch(branch.Branch):
2159
1208
"""Branch stored on a server accessed by HPSS RPC.
2161
1210
At the moment most operations are mapped down to simple file operations.
2164
1213
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2165
_client=None, format=None, setup_stacking=True, name=None):
2166
1215
"""Create a RemoteBranch instance.
2168
1217
:param real_branch: An optional local implementation of the branch
2169
1218
format, usually accessing the data via the VFS.
2170
1219
:param _client: Private parameter for testing.
2171
:param format: A RemoteBranchFormat object, None to create one
2172
automatically. If supplied it should have a network_name already
2174
:param setup_stacking: If True make an RPC call to determine the
2175
stacked (or not) status of the branch. If False assume the branch
2177
:param name: Colocated branch name
2179
1221
# We intentionally don't call the parent class's __init__, because it
2180
1222
# will try to assign to self.tags, which is a property in this subclass.
2181
1223
# And the parent's __init__ doesn't do much anyway.
1224
self._revision_id_to_revno_cache = None
1225
self._revision_history_cache = None
2182
1226
self.bzrdir = remote_bzrdir
2183
1227
if _client is not None:
2184
1228
self._client = _client
2197
1241
self._real_branch.repository = self.repository
2199
1243
self._real_branch = None
2200
# Fill out expected attributes of branch for bzrlib API users.
2201
self._clear_cached_state()
2202
# TODO: deprecate self.base in favor of user_url
2203
self.base = self.bzrdir.user_url
1244
# Fill out expected attributes of branch for bzrlib api users.
1245
self._format = RemoteBranchFormat()
1246
self.base = self.bzrdir.root_transport.base
2205
1247
self._control_files = None
2206
1248
self._lock_mode = None
2207
1249
self._lock_token = None
2208
1250
self._repo_lock_token = None
2209
1251
self._lock_count = 0
2210
1252
self._leave_lock = False
2211
# Setup a format: note that we cannot call _ensure_real until all the
2212
# attributes above are set: This code cannot be moved higher up in this
2215
self._format = RemoteBranchFormat()
2216
if real_branch is not None:
2217
self._format._network_name = \
2218
self._real_branch._format.network_name()
2220
self._format = format
2221
# when we do _ensure_real we may need to pass ignore_fallbacks to the
2222
# branch.open_branch method.
2223
self._real_ignore_fallbacks = not setup_stacking
2224
if not self._format._network_name:
2225
# Did not get from open_branchV2 - old server.
2227
self._format._network_name = \
2228
self._real_branch._format.network_name()
2229
self.tags = self._format.make_tags(self)
2230
# The base class init is not called, so we duplicate this:
2231
hooks = branch.Branch.hooks['open']
2234
self._is_stacked = False
2236
self._setup_stacking()
2238
def _setup_stacking(self):
2239
# configure stacking into the remote repository, by reading it from
2242
fallback_url = self.get_stacked_on_url()
2243
except (errors.NotStacked, errors.UnstackableBranchFormat,
2244
errors.UnstackableRepositoryFormat), e:
2246
self._is_stacked = True
2247
self._activate_fallback_location(fallback_url)
2249
def _get_config(self):
2250
return RemoteBranchConfig(self)
2252
def _get_real_transport(self):
2253
# if we try vfs access, return the real branch's vfs transport
2255
return self._real_branch._transport
2257
_transport = property(_get_real_transport)
2259
1254
def __str__(self):
2260
1255
return "%s(%s)" % (self.__class__.__name__, self.base)
2267
1262
Used before calls to self._real_branch.
2269
if self._real_branch is None:
1264
if not self._real_branch:
2270
1265
if not vfs.vfs_enabled():
2271
1266
raise AssertionError('smart server vfs must be enabled '
2272
1267
'to use vfs implementation')
2273
1268
self.bzrdir._ensure_real()
2274
self._real_branch = self.bzrdir._real_bzrdir.open_branch(
2275
ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
2276
if self.repository._real_repository is None:
2277
# Give the remote repository the matching real repo.
2278
real_repo = self._real_branch.repository
2279
if isinstance(real_repo, RemoteRepository):
2280
real_repo._ensure_real()
2281
real_repo = real_repo._real_repository
2282
self.repository._set_real_repository(real_repo)
2283
# Give the real branch the remote repository to let fast-pathing
1269
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1270
# Give the remote repository the matching real repo.
1271
real_repo = self._real_branch.repository
1272
if isinstance(real_repo, RemoteRepository):
1273
real_repo._ensure_real()
1274
real_repo = real_repo._real_repository
1275
self.repository._set_real_repository(real_repo)
1276
# Give the branch the remote repository to let fast-pathing happen.
2285
1277
self._real_branch.repository = self.repository
1278
# XXX: deal with _lock_mode == 'w'
2286
1279
if self._lock_mode == 'r':
2287
1280
self._real_branch.lock_read()
2288
elif self._lock_mode == 'w':
2289
self._real_branch.lock_write(token=self._lock_token)
2291
def _translate_error(self, err, **context):
2292
self.repository._translate_error(err, branch=self, **context)
2294
def _clear_cached_state(self):
2295
super(RemoteBranch, self)._clear_cached_state()
2296
if self._real_branch is not None:
2297
self._real_branch._clear_cached_state()
2299
def _clear_cached_state_of_remote_branch_only(self):
2300
"""Like _clear_cached_state, but doesn't clear the cache of
2303
This is useful when falling back to calling a method of
2304
self._real_branch that changes state. In that case the underlying
2305
branch changes, so we need to invalidate this RemoteBranch's cache of
2306
it. However, there's no need to invalidate the _real_branch's cache
2307
too, in fact doing so might harm performance.
2309
super(RemoteBranch, self)._clear_cached_state()
2312
1283
def control_files(self):
2327
1298
self._ensure_real()
2328
1299
return self._real_branch.get_physical_lock_status()
2330
def get_stacked_on_url(self):
2331
"""Get the URL this branch is stacked against.
2333
:raises NotStacked: If the branch is not stacked.
2334
:raises UnstackableBranchFormat: If the branch does not support
2336
:raises UnstackableRepositoryFormat: If the repository does not support
2340
# there may not be a repository yet, so we can't use
2341
# self._translate_error, so we can't use self._call either.
2342
response = self._client.call('Branch.get_stacked_on_url',
2343
self._remote_path())
2344
except errors.ErrorFromSmartServer, err:
2345
# there may not be a repository yet, so we can't call through
2346
# its _translate_error
2347
_translate_error(err, branch=self)
2348
except errors.UnknownSmartMethod, err:
2350
return self._real_branch.get_stacked_on_url()
2351
if response[0] != 'ok':
2352
raise errors.UnexpectedSmartServerResponse(response)
2355
def set_stacked_on_url(self, url):
2356
branch.Branch.set_stacked_on_url(self, url)
2358
self._is_stacked = False
2360
self._is_stacked = True
2362
def _vfs_get_tags_bytes(self):
2364
return self._real_branch._get_tags_bytes()
2366
def _get_tags_bytes(self):
2367
medium = self._client._medium
2368
if medium._is_remote_before((1, 13)):
2369
return self._vfs_get_tags_bytes()
2371
response = self._call('Branch.get_tags_bytes', self._remote_path())
2372
except errors.UnknownSmartMethod:
2373
medium._remember_remote_is_before((1, 13))
2374
return self._vfs_get_tags_bytes()
2377
def _vfs_set_tags_bytes(self, bytes):
2379
return self._real_branch._set_tags_bytes(bytes)
2381
def _set_tags_bytes(self, bytes):
2382
medium = self._client._medium
2383
if medium._is_remote_before((1, 18)):
2384
self._vfs_set_tags_bytes(bytes)
2388
self._remote_path(), self._lock_token, self._repo_lock_token)
2389
response = self._call_with_body_bytes(
2390
'Branch.set_tags_bytes', args, bytes)
2391
except errors.UnknownSmartMethod:
2392
medium._remember_remote_is_before((1, 18))
2393
self._vfs_set_tags_bytes(bytes)
2395
1301
def lock_read(self):
2396
"""Lock the branch for read operations.
2398
:return: A bzrlib.lock.LogicalLockResult.
2400
self.repository.lock_read()
2401
1302
if not self._lock_mode:
2402
self._note_lock('r')
2403
1303
self._lock_mode = 'r'
2404
1304
self._lock_count = 1
2405
1305
if self._real_branch is not None:
2406
1306
self._real_branch.lock_read()
2408
1308
self._lock_count += 1
2409
return lock.LogicalLockResult(self.unlock)
2411
1310
def _remote_lock_write(self, token):
2412
1311
if token is None:
2413
1312
branch_token = repo_token = ''
2415
1314
branch_token = token
2416
repo_token = self.repository.lock_write().repository_token
1315
repo_token = self.repository.lock_write()
2417
1316
self.repository.unlock()
2418
err_context = {'token': token}
2419
response = self._call(
2420
'Branch.lock_write', self._remote_path(), branch_token,
2421
repo_token or '', **err_context)
1317
path = self.bzrdir._path_for_remote_call(self._client)
1319
response = self._client.call(
1320
'Branch.lock_write', path, branch_token, repo_token or '')
1321
except errors.ErrorFromSmartServer, err:
1322
if err.error_verb == 'LockContention':
1323
raise errors.LockContention('(remote lock)')
1324
elif err.error_verb == 'TokenMismatch':
1325
raise errors.TokenMismatch(token, '(remote token)')
1326
elif err.error_verb == 'UnlockableTransport':
1327
raise errors.UnlockableTransport(self.bzrdir.root_transport)
1328
elif err.error_verb == 'ReadOnlyError':
1329
raise errors.ReadOnlyError(self)
1330
elif err.error_verb == 'LockFailed':
1331
raise errors.LockFailed(err.error_args[0], err.error_args[1])
2422
1333
if response[0] != 'ok':
2423
1334
raise errors.UnexpectedSmartServerResponse(response)
2424
1335
ok, branch_token, repo_token = response
2425
1336
return branch_token, repo_token
2427
1338
def lock_write(self, token=None):
2428
1339
if not self._lock_mode:
2429
self._note_lock('w')
2430
# Lock the branch and repo in one remote call.
2431
1340
remote_tokens = self._remote_lock_write(token)
2432
1341
self._lock_token, self._repo_lock_token = remote_tokens
2433
1342
if not self._lock_token:
2434
1343
raise SmartProtocolError('Remote server did not return a token!')
2435
# Tell the self.repository object that it is locked.
2436
self.repository.lock_write(
2437
self._repo_lock_token, _skip_rpc=True)
1344
# TODO: We really, really, really don't want to call _ensure_real
1345
# here, but it's the easiest way to ensure coherency between the
1346
# state of the RemoteBranch and RemoteRepository objects and the
1347
# physical locks. If we don't materialise the real objects here,
1348
# then getting everything in the right state later is complex, so
1349
# for now we just do it the lazy way.
1350
# -- Andrew Bennetts, 2007-02-22.
2439
1352
if self._real_branch is not None:
2440
self._real_branch.lock_write(token=self._lock_token)
1353
self._real_branch.repository.lock_write(
1354
token=self._repo_lock_token)
1356
self._real_branch.lock_write(token=self._lock_token)
1358
self._real_branch.repository.unlock()
2441
1359
if token is not None:
2442
1360
self._leave_lock = True
1362
# XXX: this case seems to be unreachable; token cannot be None.
2444
1363
self._leave_lock = False
2445
1364
self._lock_mode = 'w'
2446
1365
self._lock_count = 1
2448
1367
raise errors.ReadOnlyTransaction
2450
1369
if token is not None:
2451
# A token was given to lock_write, and we're relocking, so
2452
# check that the given token actually matches the one we
1370
# A token was given to lock_write, and we're relocking, so check
1371
# that the given token actually matches the one we already have.
2454
1372
if token != self._lock_token:
2455
1373
raise errors.TokenMismatch(token, self._lock_token)
2456
1374
self._lock_count += 1
2457
# Re-lock the repository too.
2458
self.repository.lock_write(self._repo_lock_token)
2459
return BranchWriteLockResult(self.unlock, self._lock_token or None)
1375
return self._lock_token or None
2461
1377
def _unlock(self, branch_token, repo_token):
2462
err_context = {'token': str((branch_token, repo_token))}
2463
response = self._call(
2464
'Branch.unlock', self._remote_path(), branch_token,
2465
repo_token or '', **err_context)
1378
path = self.bzrdir._path_for_remote_call(self._client)
1380
response = self._client.call('Branch.unlock', path, branch_token,
1382
except errors.ErrorFromSmartServer, err:
1383
if err.error_verb == 'TokenMismatch':
1384
raise errors.TokenMismatch(
1385
str((branch_token, repo_token)), '(remote tokens)')
2466
1387
if response == ('ok',):
2468
1389
raise errors.UnexpectedSmartServerResponse(response)
2470
@only_raises(errors.LockNotHeld, errors.LockBroken)
2471
1391
def unlock(self):
2473
self._lock_count -= 1
2474
if not self._lock_count:
2475
self._clear_cached_state()
2476
mode = self._lock_mode
2477
self._lock_mode = None
2478
if self._real_branch is not None:
2479
if (not self._leave_lock and mode == 'w' and
2480
self._repo_lock_token):
2481
# If this RemoteBranch will remove the physical lock
2482
# for the repository, make sure the _real_branch
2483
# doesn't do it first. (Because the _real_branch's
2484
# repository is set to be the RemoteRepository.)
2485
self._real_branch.repository.leave_lock_in_place()
2486
self._real_branch.unlock()
2488
# Only write-locked branched need to make a remote method
2489
# call to perform the unlock.
2491
if not self._lock_token:
2492
raise AssertionError('Locked, but no token!')
2493
branch_token = self._lock_token
2494
repo_token = self._repo_lock_token
2495
self._lock_token = None
2496
self._repo_lock_token = None
2497
if not self._leave_lock:
2498
self._unlock(branch_token, repo_token)
2500
self.repository.unlock()
1392
self._lock_count -= 1
1393
if not self._lock_count:
1394
self._clear_cached_state()
1395
mode = self._lock_mode
1396
self._lock_mode = None
1397
if self._real_branch is not None:
1398
if (not self._leave_lock and mode == 'w' and
1399
self._repo_lock_token):
1400
# If this RemoteBranch will remove the physical lock for the
1401
# repository, make sure the _real_branch doesn't do it
1402
# first. (Because the _real_branch's repository is set to
1403
# be the RemoteRepository.)
1404
self._real_branch.repository.leave_lock_in_place()
1405
self._real_branch.unlock()
1407
# Only write-locked branched need to make a remote method call
1408
# to perfom the unlock.
1410
if not self._lock_token:
1411
raise AssertionError('Locked, but no token!')
1412
branch_token = self._lock_token
1413
repo_token = self._repo_lock_token
1414
self._lock_token = None
1415
self._repo_lock_token = None
1416
if not self._leave_lock:
1417
self._unlock(branch_token, repo_token)
2502
1419
def break_lock(self):
2503
1420
self._ensure_real()
2542
1443
def _gen_revision_history(self):
2543
1444
"""See Branch._gen_revision_history()."""
2544
if self._is_stacked:
2546
return self._real_branch._gen_revision_history()
2547
response_tuple, response_handler = self._call_expecting_body(
2548
'Branch.revision_history', self._remote_path())
1445
path = self.bzrdir._path_for_remote_call(self._client)
1446
response_tuple, response_handler = self._client.call_expecting_body(
1447
'Branch.revision_history', path)
2549
1448
if response_tuple[0] != 'ok':
2550
raise errors.UnexpectedSmartServerResponse(response_tuple)
1449
raise UnexpectedSmartServerResponse(response_tuple)
2551
1450
result = response_handler.read_body_bytes().split('\x00')
2552
1451
if result == ['']:
2556
def _remote_path(self):
2557
return self.bzrdir._path_for_remote_call(self._client)
2559
def _set_last_revision_descendant(self, revision_id, other_branch,
2560
allow_diverged=False, allow_overwrite_descendant=False):
2561
# This performs additional work to meet the hook contract; while its
2562
# undesirable, we have to synthesise the revno to call the hook, and
2563
# not calling the hook is worse as it means changes can't be prevented.
2564
# Having calculated this though, we can't just call into
2565
# set_last_revision_info as a simple call, because there is a set_rh
2566
# hook that some folk may still be using.
2567
old_revno, old_revid = self.last_revision_info()
2568
history = self._lefthand_history(revision_id)
2569
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2570
err_context = {'other_branch': other_branch}
2571
response = self._call('Branch.set_last_revision_ex',
2572
self._remote_path(), self._lock_token, self._repo_lock_token,
2573
revision_id, int(allow_diverged), int(allow_overwrite_descendant),
2575
self._clear_cached_state()
2576
if len(response) != 3 and response[0] != 'ok':
2577
raise errors.UnexpectedSmartServerResponse(response)
2578
new_revno, new_revision_id = response[1:]
2579
self._last_revision_info_cache = new_revno, new_revision_id
2580
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2581
if self._real_branch is not None:
2582
cache = new_revno, new_revision_id
2583
self._real_branch._last_revision_info_cache = cache
2585
def _set_last_revision(self, revision_id):
2586
old_revno, old_revid = self.last_revision_info()
2587
# This performs additional work to meet the hook contract; while its
2588
# undesirable, we have to synthesise the revno to call the hook, and
2589
# not calling the hook is worse as it means changes can't be prevented.
2590
# Having calculated this though, we can't just call into
2591
# set_last_revision_info as a simple call, because there is a set_rh
2592
# hook that some folk may still be using.
2593
history = self._lefthand_history(revision_id)
2594
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2595
self._clear_cached_state()
2596
response = self._call('Branch.set_last_revision',
2597
self._remote_path(), self._lock_token, self._repo_lock_token,
2599
if response != ('ok',):
2600
raise errors.UnexpectedSmartServerResponse(response)
2601
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2603
1455
@needs_write_lock
2604
1456
def set_revision_history(self, rev_history):
2605
1457
# Send just the tip revision of the history; the server will generate
2606
1458
# the full history from that. If the revision doesn't exist in this
2607
1459
# branch, NoSuchRevision will be raised.
1460
path = self.bzrdir._path_for_remote_call(self._client)
2608
1461
if rev_history == []:
2609
1462
rev_id = 'null:'
2611
1464
rev_id = rev_history[-1]
2612
self._set_last_revision(rev_id)
2613
for hook in branch.Branch.hooks['set_rh']:
2614
hook(self, rev_history)
1465
self._clear_cached_state()
1467
response = self._client.call('Branch.set_last_revision',
1468
path, self._lock_token, self._repo_lock_token, rev_id)
1469
except errors.ErrorFromSmartServer, err:
1470
if err.error_verb == 'NoSuchRevision':
1471
raise NoSuchRevision(self, rev_id)
1473
if response != ('ok',):
1474
raise errors.UnexpectedSmartServerResponse(response)
2615
1475
self._cache_revision_history(rev_history)
2617
def _get_parent_location(self):
2618
medium = self._client._medium
2619
if medium._is_remote_before((1, 13)):
2620
return self._vfs_get_parent_location()
2622
response = self._call('Branch.get_parent', self._remote_path())
2623
except errors.UnknownSmartMethod:
2624
medium._remember_remote_is_before((1, 13))
2625
return self._vfs_get_parent_location()
2626
if len(response) != 1:
2627
raise errors.UnexpectedSmartServerResponse(response)
2628
parent_location = response[0]
2629
if parent_location == '':
2631
return parent_location
2633
def _vfs_get_parent_location(self):
2635
return self._real_branch._get_parent_location()
2637
def _set_parent_location(self, url):
2638
medium = self._client._medium
2639
if medium._is_remote_before((1, 15)):
2640
return self._vfs_set_parent_location(url)
2642
call_url = url or ''
2643
if type(call_url) is not str:
2644
raise AssertionError('url must be a str or None (%s)' % url)
2645
response = self._call('Branch.set_parent_location',
2646
self._remote_path(), self._lock_token, self._repo_lock_token,
2648
except errors.UnknownSmartMethod:
2649
medium._remember_remote_is_before((1, 15))
2650
return self._vfs_set_parent_location(url)
2652
raise errors.UnexpectedSmartServerResponse(response)
2654
def _vfs_set_parent_location(self, url):
2656
return self._real_branch._set_parent_location(url)
1477
def get_parent(self):
1479
return self._real_branch.get_parent()
1481
def set_parent(self, url):
1483
return self._real_branch.set_parent(url)
1485
def sprout(self, to_bzrdir, revision_id=None):
1486
# Like Branch.sprout, except that it sprouts a branch in the default
1487
# format, because RemoteBranches can't be created at arbitrary URLs.
1488
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1489
# to_bzrdir.create_branch...
1491
result = self._real_branch._format.initialize(to_bzrdir)
1492
self.copy_content_into(result, revision_id=revision_id)
1493
result.set_parent(self.bzrdir.root_transport.base)
2658
1496
@needs_write_lock
2659
1497
def pull(self, source, overwrite=False, stop_revision=None,
2661
self._clear_cached_state_of_remote_branch_only()
1499
# FIXME: This asks the real branch to run the hooks, which means
1500
# they're called with the wrong target branch parameter.
1501
# The test suite specifically allows this at present but it should be
1502
# fixed. It should get a _override_hook_target branch,
1503
# as push does. -- mbp 20070405
2662
1504
self._ensure_real()
2663
return self._real_branch.pull(
1505
self._real_branch.pull(
2664
1506
source, overwrite=overwrite, stop_revision=stop_revision,
2665
_override_hook_target=self, **kwargs)
2667
1509
@needs_read_lock
2668
1510
def push(self, target, overwrite=False, stop_revision=None):
2674
1516
def is_locked(self):
2675
1517
return self._lock_count >= 1
2678
def revision_id_to_revno(self, revision_id):
2680
return self._real_branch.revision_id_to_revno(revision_id)
2682
1519
@needs_write_lock
2683
1520
def set_last_revision_info(self, revno, revision_id):
2684
# XXX: These should be returned by the set_last_revision_info verb
2685
old_revno, old_revid = self.last_revision_info()
2686
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2687
1521
revision_id = ensure_null(revision_id)
1522
path = self.bzrdir._path_for_remote_call(self._client)
2689
response = self._call('Branch.set_last_revision_info',
2690
self._remote_path(), self._lock_token, self._repo_lock_token,
2691
str(revno), revision_id)
1524
response = self._client.call('Branch.set_last_revision_info',
1525
path, self._lock_token, self._repo_lock_token, str(revno), revision_id)
2692
1526
except errors.UnknownSmartMethod:
2693
1527
self._ensure_real()
2694
self._clear_cached_state_of_remote_branch_only()
2695
self._real_branch.set_last_revision_info(revno, revision_id)
2696
self._last_revision_info_cache = revno, revision_id
1528
self._clear_cached_state()
1529
return self._real_branch.set_last_revision_info(revno, revision_id)
1530
except errors.ErrorFromSmartServer, err:
1531
if err.error_verb == 'NoSuchRevision':
1532
raise NoSuchRevision(self, err.error_args[0])
2698
1534
if response == ('ok',):
2699
1535
self._clear_cached_state()
2700
self._last_revision_info_cache = revno, revision_id
2701
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2702
# Update the _real_branch's cache too.
2703
if self._real_branch is not None:
2704
cache = self._last_revision_info_cache
2705
self._real_branch._last_revision_info_cache = cache
2707
1537
raise errors.UnexpectedSmartServerResponse(response)
2710
1539
def generate_revision_history(self, revision_id, last_rev=None,
2711
1540
other_branch=None):
2712
medium = self._client._medium
2713
if not medium._is_remote_before((1, 6)):
2714
# Use a smart method for 1.6 and above servers
2716
self._set_last_revision_descendant(revision_id, other_branch,
2717
allow_diverged=True, allow_overwrite_descendant=True)
2719
except errors.UnknownSmartMethod:
2720
medium._remember_remote_is_before((1, 6))
2721
self._clear_cached_state_of_remote_branch_only()
2722
self.set_revision_history(self._lefthand_history(revision_id,
2723
last_rev=last_rev,other_branch=other_branch))
1542
return self._real_branch.generate_revision_history(
1543
revision_id, last_rev=last_rev, other_branch=other_branch)
1548
return self._real_branch.tags
2725
1550
def set_push_location(self, location):
2726
1551
self._ensure_real()
2727
1552
return self._real_branch.set_push_location(location)
2730
class RemoteConfig(object):
2731
"""A Config that reads and writes from smart verbs.
2733
It is a low-level object that considers config data to be name/value pairs
2734
that may be associated with a section. Assigning meaning to the these
2735
values is done at higher levels like bzrlib.config.TreeConfig.
2738
def get_option(self, name, section=None, default=None):
2739
"""Return the value associated with a named option.
2741
:param name: The name of the value
2742
:param section: The section the option is in (if any)
2743
:param default: The value to return if the value is not set
2744
:return: The value or default value
2747
configobj = self._get_configobj()
2749
section_obj = configobj
2752
section_obj = configobj[section]
2755
return section_obj.get(name, default)
2756
except errors.UnknownSmartMethod:
2757
return self._vfs_get_option(name, section, default)
2759
def _response_to_configobj(self, response):
2760
if len(response[0]) and response[0][0] != 'ok':
2761
raise errors.UnexpectedSmartServerResponse(response)
2762
lines = response[1].read_body_bytes().splitlines()
2763
return config.ConfigObj(lines, encoding='utf-8')
2766
class RemoteBranchConfig(RemoteConfig):
2767
"""A RemoteConfig for Branches."""
2769
def __init__(self, branch):
2770
self._branch = branch
2772
def _get_configobj(self):
2773
path = self._branch._remote_path()
2774
response = self._branch._client.call_expecting_body(
2775
'Branch.get_config_file', path)
2776
return self._response_to_configobj(response)
2778
def set_option(self, value, name, section=None):
2779
"""Set the value associated with a named option.
2781
:param value: The value to set
2782
:param name: The name of the value to set
2783
:param section: The section the option is in (if any)
2785
medium = self._branch._client._medium
2786
if medium._is_remote_before((1, 14)):
2787
return self._vfs_set_option(value, name, section)
2789
path = self._branch._remote_path()
2790
response = self._branch._client.call('Branch.set_config_option',
2791
path, self._branch._lock_token, self._branch._repo_lock_token,
2792
value.encode('utf8'), name, section or '')
2793
except errors.UnknownSmartMethod:
2794
medium._remember_remote_is_before((1, 14))
2795
return self._vfs_set_option(value, name, section)
2797
raise errors.UnexpectedSmartServerResponse(response)
2799
def _real_object(self):
2800
self._branch._ensure_real()
2801
return self._branch._real_branch
2803
def _vfs_set_option(self, value, name, section=None):
2804
return self._real_object()._get_config().set_option(
2805
value, name, section)
2808
class RemoteBzrDirConfig(RemoteConfig):
2809
"""A RemoteConfig for BzrDirs."""
2811
def __init__(self, bzrdir):
2812
self._bzrdir = bzrdir
2814
def _get_configobj(self):
2815
medium = self._bzrdir._client._medium
2816
verb = 'BzrDir.get_config_file'
2817
if medium._is_remote_before((1, 15)):
2818
raise errors.UnknownSmartMethod(verb)
2819
path = self._bzrdir._path_for_remote_call(self._bzrdir._client)
2820
response = self._bzrdir._call_expecting_body(
2822
return self._response_to_configobj(response)
2824
def _vfs_get_option(self, name, section, default):
2825
return self._real_object()._get_config().get_option(
2826
name, section, default)
2828
def set_option(self, value, name, section=None):
2829
"""Set the value associated with a named option.
2831
:param value: The value to set
2832
:param name: The name of the value to set
2833
:param section: The section the option is in (if any)
2835
return self._real_object()._get_config().set_option(
2836
value, name, section)
2838
def _real_object(self):
2839
self._bzrdir._ensure_real()
2840
return self._bzrdir._real_bzrdir
1554
def update_revisions(self, other, stop_revision=None, overwrite=False):
1556
return self._real_branch.update_revisions(
1557
other, stop_revision=stop_revision, overwrite=overwrite)
2844
1560
def _extract_tar(tar, to_dir):
2849
1565
for tarinfo in tar:
2850
1566
tar.extract(tarinfo, to_dir)
2853
def _translate_error(err, **context):
2854
"""Translate an ErrorFromSmartServer into a more useful error.
2856
Possible context keys:
2864
If the error from the server doesn't match a known pattern, then
2865
UnknownErrorFromSmartServer is raised.
2869
return context[name]
2870
except KeyError, key_err:
2871
mutter('Missing key %r in context %r', key_err.args[0], context)
2874
"""Get the path from the context if present, otherwise use first error
2878
return context['path']
2879
except KeyError, key_err:
2881
return err.error_args[0]
2882
except IndexError, idx_err:
2884
'Missing key %r in context %r', key_err.args[0], context)
2887
if err.error_verb == 'IncompatibleRepositories':
2888
raise errors.IncompatibleRepositories(err.error_args[0],
2889
err.error_args[1], err.error_args[2])
2890
elif err.error_verb == 'NoSuchRevision':
2891
raise NoSuchRevision(find('branch'), err.error_args[0])
2892
elif err.error_verb == 'nosuchrevision':
2893
raise NoSuchRevision(find('repository'), err.error_args[0])
2894
elif err.error_verb == 'nobranch':
2895
if len(err.error_args) >= 1:
2896
extra = err.error_args[0]
2899
raise errors.NotBranchError(path=find('bzrdir').root_transport.base,
2901
elif err.error_verb == 'norepository':
2902
raise errors.NoRepositoryPresent(find('bzrdir'))
2903
elif err.error_verb == 'LockContention':
2904
raise errors.LockContention('(remote lock)')
2905
elif err.error_verb == 'UnlockableTransport':
2906
raise errors.UnlockableTransport(find('bzrdir').root_transport)
2907
elif err.error_verb == 'LockFailed':
2908
raise errors.LockFailed(err.error_args[0], err.error_args[1])
2909
elif err.error_verb == 'TokenMismatch':
2910
raise errors.TokenMismatch(find('token'), '(remote token)')
2911
elif err.error_verb == 'Diverged':
2912
raise errors.DivergedBranches(find('branch'), find('other_branch'))
2913
elif err.error_verb == 'TipChangeRejected':
2914
raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
2915
elif err.error_verb == 'UnstackableBranchFormat':
2916
raise errors.UnstackableBranchFormat(*err.error_args)
2917
elif err.error_verb == 'UnstackableRepositoryFormat':
2918
raise errors.UnstackableRepositoryFormat(*err.error_args)
2919
elif err.error_verb == 'NotStacked':
2920
raise errors.NotStacked(branch=find('branch'))
2921
elif err.error_verb == 'PermissionDenied':
2923
if len(err.error_args) >= 2:
2924
extra = err.error_args[1]
2927
raise errors.PermissionDenied(path, extra=extra)
2928
elif err.error_verb == 'ReadError':
2930
raise errors.ReadError(path)
2931
elif err.error_verb == 'NoSuchFile':
2933
raise errors.NoSuchFile(path)
2934
elif err.error_verb == 'FileExists':
2935
raise errors.FileExists(err.error_args[0])
2936
elif err.error_verb == 'DirectoryNotEmpty':
2937
raise errors.DirectoryNotEmpty(err.error_args[0])
2938
elif err.error_verb == 'ShortReadvError':
2939
args = err.error_args
2940
raise errors.ShortReadvError(
2941
args[0], int(args[1]), int(args[2]), int(args[3]))
2942
elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
2943
encoding = str(err.error_args[0]) # encoding must always be a string
2944
val = err.error_args[1]
2945
start = int(err.error_args[2])
2946
end = int(err.error_args[3])
2947
reason = str(err.error_args[4]) # reason must always be a string
2948
if val.startswith('u:'):
2949
val = val[2:].decode('utf-8')
2950
elif val.startswith('s:'):
2951
val = val[2:].decode('base64')
2952
if err.error_verb == 'UnicodeDecodeError':
2953
raise UnicodeDecodeError(encoding, val, start, end, reason)
2954
elif err.error_verb == 'UnicodeEncodeError':
2955
raise UnicodeEncodeError(encoding, val, start, end, reason)
2956
elif err.error_verb == 'ReadOnlyError':
2957
raise errors.TransportNotPossible('readonly transport')
2958
raise errors.UnknownErrorFromSmartServer(err)
added
removed
bzrlib/remote.py
