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
30
repository as _mod_repository,
32
revision as _mod_revision,
36
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
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.
20
from cStringIO import StringIO
22
from bzrlib import branch, errors, lockdir, repository
23
from bzrlib.branch import BranchReferenceFormat
37
24
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
38
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
39
from bzrlib.errors import (
25
from bzrlib.config import BranchConfig, TreeConfig
26
from bzrlib.decorators import needs_read_lock, needs_write_lock
27
from bzrlib.errors import NoSuchRevision
43
28
from bzrlib.lockable_files import LockableFiles
44
from bzrlib.smart import client, vfs, repository as smart_repo
45
from bzrlib.revision import ensure_null, NULL_REVISION
46
from bzrlib.repository import RepositoryWriteLockResult
47
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]
29
from bzrlib.revision import NULL_REVISION
30
from bzrlib.smart import client, vfs
31
from bzrlib.trace import note
90
33
# Note: RemoteBzrDirFormat is in bzrdir.py
92
class RemoteBzrDir(BzrDir, _RpcHelper):
35
class RemoteBzrDir(BzrDir):
93
36
"""Control directory on a remote server, accessed via bzr:// or similar."""
95
def __init__(self, transport, format, _client=None, _force_probe=False):
38
def __init__(self, transport, _client=None):
96
39
"""Construct a RemoteBzrDir.
98
41
:param _client: Private parameter for testing. Disables probing and the
99
42
use of a real bzrdir.
101
BzrDir.__init__(self, transport, format)
44
BzrDir.__init__(self, transport, RemoteBzrDirFormat())
102
45
# this object holds a delegated bzrdir that uses file-level operations
103
46
# to talk to the other side
104
47
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
49
if _client is None:
111
medium = transport.get_smart_medium()
112
self._client = client._SmartClient(medium)
50
self._medium = transport.get_smart_client()
51
self._client = client._SmartClient(self._medium)
114
53
self._client = _client
121
return '%s(%r)' % (self.__class__.__name__, self._client)
123
def _probe_bzrdir(self):
124
medium = self._client._medium
125
57
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)
58
response = self._client.call('BzrDir.open', path)
152
59
if response not in [('yes',), ('no',)]:
153
60
raise errors.UnexpectedSmartServerResponse(response)
154
61
if response == ('no',):
155
raise errors.NotBranchError(path=self.root_transport.base)
62
raise errors.NotBranchError(path=transport.base)
157
64
def _ensure_real(self):
158
65
"""Ensure that there is a _real_bzrdir set.
160
67
Used before calls to self._real_bzrdir.
162
69
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
70
self._real_bzrdir = BzrDir.open_from_transport(
168
71
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
73
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()
243
def destroy_repository(self):
244
"""See BzrDir.destroy_repository"""
246
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
267
def destroy_branch(self, name=None):
268
"""See BzrDir.destroy_branch"""
270
self._real_bzrdir.destroy_branch(name=name)
271
self._next_open_branch_result = None
273
def create_workingtree(self, revision_id=None, from_branch=None):
75
self._real_bzrdir.create_repository(shared=shared)
76
return self.open_repository()
78
def create_branch(self):
80
real_branch = self._real_bzrdir.create_branch()
81
return RemoteBranch(self, self.find_repository(), real_branch)
83
def create_workingtree(self, revision_id=None):
274
84
raise errors.NotLocalUrl(self.transport.base)
276
def find_branch_format(self, name=None):
86
def find_branch_format(self):
277
87
"""Find the branch 'format' for this bzrdir.
279
89
This might be a synthetic object for e.g. RemoteBranch and SVN.
281
b = self.open_branch(name=name)
91
b = self.open_branch()
284
def get_branch_reference(self, name=None):
94
def get_branch_reference(self):
285
95
"""See BzrDir.get_branch_reference()."""
287
# XXX JRV20100304: Support opening colocated branches
288
raise errors.NoColocatedBranchSupport(self)
289
response = self._get_branch_reference()
290
if response[0] == 'ref':
295
def _get_branch_reference(self):
296
96
path = self._path_for_remote_call(self._client)
297
medium = self._client._medium
299
('BzrDir.open_branchV3', (2, 1)),
300
('BzrDir.open_branchV2', (1, 13)),
301
('BzrDir.open_branch', None),
303
for verb, required_version in candidate_calls:
304
if required_version and medium._is_remote_before(required_version):
307
response = self._call(verb, path)
308
except errors.UnknownSmartMethod:
309
if required_version is None:
311
medium._remember_remote_is_before(required_version)
314
if verb == 'BzrDir.open_branch':
315
if response[0] != 'ok':
316
raise errors.UnexpectedSmartServerResponse(response)
317
if response[1] != '':
318
return ('ref', response[1])
320
return ('branch', '')
321
if response[0] not in ('ref', 'branch'):
322
raise errors.UnexpectedSmartServerResponse(response)
325
def _get_tree_branch(self, name=None):
326
"""See BzrDir._get_tree_branch()."""
327
return None, self.open_branch(name=name)
329
def open_branch(self, name=None, unsupported=False,
330
ignore_fallbacks=False):
332
raise NotImplementedError('unsupported flag support not implemented yet.')
333
if self._next_open_branch_result is not None:
334
# See create_branch for details.
335
result = self._next_open_branch_result
336
self._next_open_branch_result = None
338
response = self._get_branch_reference()
339
if response[0] == 'ref':
97
response = self._client.call('BzrDir.open_branch', path)
98
if response[0] == 'ok':
100
# branch at this location.
103
# a branch reference, use the existing BranchReference logic.
105
elif response == ('nobranch',):
106
raise errors.NotBranchError(path=self.root_transport.base)
108
assert False, 'unexpected response code %r' % (response,)
110
def open_branch(self, _unsupported=False):
111
assert _unsupported == False, 'unsupported flag support not implemented yet.'
112
reference_url = self.get_branch_reference()
113
if reference_url is None:
114
# branch at this location.
115
return RemoteBranch(self, self.find_repository())
340
117
# a branch reference, use the existing BranchReference logic.
341
118
format = BranchReferenceFormat()
342
return format.open(self, name=name, _found=True,
343
location=response[1], ignore_fallbacks=ignore_fallbacks)
344
branch_format_name = response[1]
345
if not branch_format_name:
346
branch_format_name = None
347
format = RemoteBranchFormat(network_name=branch_format_name)
348
return RemoteBranch(self, self.find_repository(), format=format,
349
setup_stacking=not ignore_fallbacks, name=name)
351
def _open_repo_v1(self, path):
352
verb = 'BzrDir.find_repository'
353
response = self._call(verb, path)
354
if response[0] != 'ok':
355
raise errors.UnexpectedSmartServerResponse(response)
356
# servers that only support the v1 method don't support external
359
repo = self._real_bzrdir.open_repository()
360
response = response + ('no', repo._format.network_name())
361
return response, repo
363
def _open_repo_v2(self, path):
364
verb = 'BzrDir.find_repositoryV2'
365
response = self._call(verb, path)
366
if response[0] != 'ok':
367
raise errors.UnexpectedSmartServerResponse(response)
369
repo = self._real_bzrdir.open_repository()
370
response = response + (repo._format.network_name(),)
371
return response, repo
373
def _open_repo_v3(self, path):
374
verb = 'BzrDir.find_repositoryV3'
375
medium = self._client._medium
376
if medium._is_remote_before((1, 13)):
377
raise errors.UnknownSmartMethod(verb)
379
response = self._call(verb, path)
380
except errors.UnknownSmartMethod:
381
medium._remember_remote_is_before((1, 13))
383
if response[0] != 'ok':
384
raise errors.UnexpectedSmartServerResponse(response)
385
return response, None
119
return format.open(self, _found=True, location=reference_url)
387
121
def open_repository(self):
388
122
path = self._path_for_remote_call(self._client)
390
for probe in [self._open_repo_v3, self._open_repo_v2,
393
response, real_repo = probe(path)
395
except errors.UnknownSmartMethod:
398
raise errors.UnknownSmartMethod('BzrDir.find_repository{3,2,}')
399
if response[0] != 'ok':
400
raise errors.UnexpectedSmartServerResponse(response)
401
if len(response) != 6:
402
raise SmartProtocolError('incorrect response length %s' % (response,))
123
response = self._client.call('BzrDir.find_repository', path)
124
assert response[0] in ('ok', 'norepository'), \
125
'unexpected response code %s' % (response,)
126
if response[0] == 'norepository':
127
raise errors.NoRepositoryPresent(self)
128
assert len(response) == 4, 'incorrect response length %s' % (response,)
403
129
if response[1] == '':
404
# repo is at this dir.
405
format = response_tuple_to_repo_format(response[2:])
406
# Used to support creating a real format instance when needed.
407
format._creating_bzrdir = self
408
remote_repo = RemoteRepository(self, format)
409
format._creating_repo = remote_repo
410
if real_repo is not None:
411
remote_repo._set_real_repository(real_repo)
130
format = RemoteRepositoryFormat()
131
format.rich_root_data = (response[2] == 'yes')
132
format.supports_tree_reference = (response[3] == 'yes')
133
return RemoteRepository(self, format)
414
135
raise errors.NoRepositoryPresent(self)
416
def has_workingtree(self):
417
if self._has_working_tree is None:
419
self._has_working_tree = self._real_bzrdir.has_workingtree()
420
return self._has_working_tree
422
137
def open_workingtree(self, recommend_upgrade=True):
423
if self.has_workingtree():
139
if self._real_bzrdir.has_workingtree():
424
140
raise errors.NotLocalUrl(self.root_transport)
426
142
raise errors.NoWorkingTree(self.root_transport.base)
468
177
Instances of this repository are represented by RemoteRepository
471
The RemoteRepositoryFormat is parameterized during construction
180
The RemoteRepositoryFormat is parameterised during construction
472
181
to reflect the capabilities of the real, remote format. Specifically
473
182
the attributes rich_root_data and supports_tree_reference are set
474
183
on a per instance basis, and are not set (and should not be) at
477
:ivar _custom_format: If set, a specific concrete repository format that
478
will be used when initializing a repository with this
479
RemoteRepositoryFormat.
480
:ivar _creating_repo: If set, the repository object that this
481
RemoteRepositoryFormat was created for: it can be called into
482
to obtain data like the network name.
485
_matchingbzrdir = RemoteBzrDirFormat()
488
repository.RepositoryFormat.__init__(self)
489
self._custom_format = None
490
self._network_name = None
491
self._creating_bzrdir = None
492
self._supports_chks = None
493
self._supports_external_lookups = None
494
self._supports_tree_reference = None
495
self._rich_root_data = None
498
return "%s(_network_name=%r)" % (self.__class__.__name__,
502
def fast_deltas(self):
504
return self._custom_format.fast_deltas
507
def rich_root_data(self):
508
if self._rich_root_data is None:
510
self._rich_root_data = self._custom_format.rich_root_data
511
return self._rich_root_data
514
def supports_chks(self):
515
if self._supports_chks is None:
517
self._supports_chks = self._custom_format.supports_chks
518
return self._supports_chks
521
def supports_external_lookups(self):
522
if self._supports_external_lookups is None:
524
self._supports_external_lookups = \
525
self._custom_format.supports_external_lookups
526
return self._supports_external_lookups
529
def supports_tree_reference(self):
530
if self._supports_tree_reference is None:
532
self._supports_tree_reference = \
533
self._custom_format.supports_tree_reference
534
return self._supports_tree_reference
536
def _vfs_initialize(self, a_bzrdir, shared):
537
"""Helper for common code in initialize."""
538
if self._custom_format:
539
# Custom format requested
540
result = self._custom_format.initialize(a_bzrdir, shared=shared)
541
elif self._creating_bzrdir is not None:
542
# Use the format that the repository we were created to back
544
prior_repo = self._creating_bzrdir.open_repository()
545
prior_repo._ensure_real()
546
result = prior_repo._real_repository._format.initialize(
547
a_bzrdir, shared=shared)
549
# assume that a_bzr is a RemoteBzrDir but the smart server didn't
550
# support remote initialization.
551
# We delegate to a real object at this point (as RemoteBzrDir
552
# delegate to the repository format which would lead to infinite
553
# recursion if we just called a_bzrdir.create_repository.
554
a_bzrdir._ensure_real()
555
result = a_bzrdir._real_bzrdir.create_repository(shared=shared)
556
if not isinstance(result, RemoteRepository):
557
return self.open(a_bzrdir)
187
_matchingbzrdir = RemoteBzrDirFormat
561
189
def initialize(self, a_bzrdir, shared=False):
562
# Being asked to create on a non RemoteBzrDir:
563
if not isinstance(a_bzrdir, RemoteBzrDir):
564
return self._vfs_initialize(a_bzrdir, shared)
565
medium = a_bzrdir._client._medium
566
if medium._is_remote_before((1, 13)):
567
return self._vfs_initialize(a_bzrdir, shared)
568
# Creating on a remote bzr dir.
569
# 1) get the network name to use.
570
if self._custom_format:
571
network_name = self._custom_format.network_name()
572
elif self._network_name:
573
network_name = self._network_name
575
# Select the current bzrlib default and ask for that.
576
reference_bzrdir_format = bzrdir.format_registry.get('default')()
577
reference_format = reference_bzrdir_format.repository_format
578
network_name = reference_format.network_name()
579
# 2) try direct creation via RPC
580
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
581
verb = 'BzrDir.create_repository'
587
response = a_bzrdir._call(verb, path, network_name, shared_str)
588
except errors.UnknownSmartMethod:
589
# Fallback - use vfs methods
590
medium._remember_remote_is_before((1, 13))
591
return self._vfs_initialize(a_bzrdir, shared)
593
# Turn the response into a RemoteRepository object.
594
format = response_tuple_to_repo_format(response[1:])
595
# Used to support creating a real format instance when needed.
596
format._creating_bzrdir = a_bzrdir
597
remote_repo = RemoteRepository(a_bzrdir, format)
598
format._creating_repo = remote_repo
190
assert isinstance(a_bzrdir, RemoteBzrDir), \
191
'%r is not a RemoteBzrDir' % (a_bzrdir,)
192
return a_bzrdir.create_repository(shared=shared)
601
194
def open(self, a_bzrdir):
602
if not isinstance(a_bzrdir, RemoteBzrDir):
603
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
195
assert isinstance(a_bzrdir, RemoteBzrDir)
604
196
return a_bzrdir.open_repository()
606
def _ensure_real(self):
607
if self._custom_format is None:
608
self._custom_format = repository.network_format_registry.get(
612
def _fetch_order(self):
614
return self._custom_format._fetch_order
617
def _fetch_uses_deltas(self):
619
return self._custom_format._fetch_uses_deltas
622
def _fetch_reconcile(self):
624
return self._custom_format._fetch_reconcile
626
198
def get_format_description(self):
628
return 'Remote: ' + self._custom_format.get_format_description()
199
return 'bzr remote repository'
630
201
def __eq__(self, other):
631
return self.__class__ is other.__class__
633
def network_name(self):
634
if self._network_name:
635
return self._network_name
636
self._creating_repo._ensure_real()
637
return self._creating_repo._real_repository._format.network_name()
640
def pack_compresses(self):
642
return self._custom_format.pack_compresses
645
def _serializer(self):
647
return self._custom_format._serializer
650
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
651
bzrdir.ControlComponent):
202
return self.__class__ == other.__class__
204
def check_conversion_target(self, target_format):
205
if self.rich_root_data and not target_format.rich_root_data:
206
raise errors.BadConversionTarget(
207
'Does not support rich root data.', target_format)
208
if (self.supports_tree_reference and
209
not getattr(target_format, 'supports_tree_reference', False)):
210
raise errors.BadConversionTarget(
211
'Does not support nested trees', target_format)
214
class RemoteRepository(object):
652
215
"""Repository accessed over rpc.
654
217
For the moment most operations are performed using local transport-backed
680
243
self._lock_token = None
681
244
self._lock_count = 0
682
245
self._leave_lock = False
683
# Cache of revision parents; misses are cached during read locks, and
684
# write locks when no _real_repository has been set.
685
self._unstacked_provider = graph.CachingParentsProvider(
686
get_parent_map=self._get_parent_map_rpc)
687
self._unstacked_provider.disable_cache()
689
# These depend on the actual remote format, so force them off for
690
# maximum compatibility. XXX: In future these should depend on the
691
# remote repository instance, but this is irrelevant until we perform
692
# reconcile via an RPC call.
693
self._reconcile_does_inventory_gc = False
694
self._reconcile_fixes_text_parents = False
695
self._reconcile_backsup_inventory = False
696
self.base = self.bzrdir.transport.base
697
# Additional places to query for data.
698
self._fallback_repositories = []
701
def user_transport(self):
702
return self.bzrdir.user_transport
705
def control_transport(self):
706
# XXX: Normally you shouldn't directly get at the remote repository
707
# transport, but I'm not sure it's worth making this method
708
# optional -- mbp 2010-04-21
709
return self.bzrdir.get_repository_transport(None)
712
return "%s(%s)" % (self.__class__.__name__, self.base)
716
def abort_write_group(self, suppress_errors=False):
717
"""Complete a write group on the decorated repository.
719
Smart methods perform operations in a single step so this API
720
is not really applicable except as a compatibility thunk
721
for older plugins that don't use e.g. the CommitBuilder
724
:param suppress_errors: see Repository.abort_write_group.
727
return self._real_repository.abort_write_group(
728
suppress_errors=suppress_errors)
732
"""Decorate the real repository for now.
734
In the long term a full blown network facility is needed to avoid
735
creating a real repository object locally.
738
return self._real_repository.chk_bytes
740
def commit_write_group(self):
741
"""Complete a write group on the decorated repository.
743
Smart methods perform operations in a single step so this API
744
is not really applicable except as a compatibility thunk
745
for older plugins that don't use e.g. the CommitBuilder
749
return self._real_repository.commit_write_group()
751
def resume_write_group(self, tokens):
753
return self._real_repository.resume_write_group(tokens)
755
def suspend_write_group(self):
757
return self._real_repository.suspend_write_group()
759
def get_missing_parent_inventories(self, check_for_missing_texts=True):
761
return self._real_repository.get_missing_parent_inventories(
762
check_for_missing_texts=check_for_missing_texts)
764
def _get_rev_id_for_revno_vfs(self, revno, known_pair):
766
return self._real_repository.get_rev_id_for_revno(
769
def get_rev_id_for_revno(self, revno, known_pair):
770
"""See Repository.get_rev_id_for_revno."""
771
path = self.bzrdir._path_for_remote_call(self._client)
773
if self._client._medium._is_remote_before((1, 17)):
774
return self._get_rev_id_for_revno_vfs(revno, known_pair)
775
response = self._call(
776
'Repository.get_rev_id_for_revno', path, revno, known_pair)
777
except errors.UnknownSmartMethod:
778
self._client._medium._remember_remote_is_before((1, 17))
779
return self._get_rev_id_for_revno_vfs(revno, known_pair)
780
if response[0] == 'ok':
781
return True, response[1]
782
elif response[0] == 'history-incomplete':
783
known_pair = response[1:3]
784
for fallback in self._fallback_repositories:
785
found, result = fallback.get_rev_id_for_revno(revno, known_pair)
790
# Not found in any fallbacks
791
return False, known_pair
793
raise errors.UnexpectedSmartServerResponse(response)
795
247
def _ensure_real(self):
796
248
"""Ensure that there is a _real_repository set.
798
250
Used before calls to self._real_repository.
800
Note that _ensure_real causes many roundtrips to the server which are
801
not desirable, and prevents the use of smart one-roundtrip RPC's to
802
perform complex operations (such as accessing parent data, streaming
803
revisions etc). Adding calls to _ensure_real should only be done when
804
bringing up new functionality, adding fallbacks for smart methods that
805
require a fallback path, and never to replace an existing smart method
806
invocation. If in doubt chat to the bzr network team.
808
if self._real_repository is None:
809
if 'hpssvfs' in debug.debug_flags:
811
warning('VFS Repository access triggered\n%s',
812
''.join(traceback.format_stack()))
813
self._unstacked_provider.missing_keys.clear()
252
if not self._real_repository:
814
253
self.bzrdir._ensure_real()
815
self._set_real_repository(
816
self.bzrdir._real_bzrdir.open_repository())
818
def _translate_error(self, err, **context):
819
self.bzrdir._translate_error(err, repository=self, **context)
821
def find_text_key_references(self):
822
"""Find the text key references within the repository.
824
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
825
revision_ids. Each altered file-ids has the exact revision_ids that
826
altered it listed explicitly.
827
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
828
to whether they were referred to by the inventory of the
829
revision_id that they contain. The inventory texts from all present
830
revision ids are assessed to generate this report.
833
return self._real_repository.find_text_key_references()
835
def _generate_text_key_index(self):
836
"""Generate a new text key index for the repository.
838
This is an expensive function that will take considerable time to run.
840
:return: A dict mapping (file_id, revision_id) tuples to a list of
841
parents, also (file_id, revision_id) tuples.
844
return self._real_repository._generate_text_key_index()
846
def _get_revision_graph(self, revision_id):
847
"""Private method for using with old (< 1.2) servers to fallback."""
254
#self._real_repository = self.bzrdir._real_bzrdir.open_repository()
255
self._set_real_repository(self.bzrdir._real_bzrdir.open_repository())
257
def get_revision_graph(self, revision_id=None):
258
"""See Repository.get_revision_graph()."""
848
259
if revision_id is None:
850
elif revision.is_null(revision_id):
261
elif revision_id == NULL_REVISION:
853
264
path = self.bzrdir._path_for_remote_call(self._client)
854
response = self._call_expecting_body(
265
assert type(revision_id) is str
266
response = self._client.call_expecting_body(
855
267
'Repository.get_revision_graph', path, revision_id)
856
response_tuple, response_handler = response
857
if response_tuple[0] != 'ok':
858
raise errors.UnexpectedSmartServerResponse(response_tuple)
859
coded = response_handler.read_body_bytes()
861
# no revisions in this repository!
863
lines = coded.split('\n')
866
d = tuple(line.split())
867
revision_graph[d[0]] = d[1:]
869
return revision_graph
872
"""See Repository._get_sink()."""
873
return RemoteStreamSink(self)
875
def _get_source(self, to_format):
876
"""Return a source for streaming from this repository."""
877
return RemoteStreamSource(self, to_format)
268
if response[0][0] not in ['ok', 'nosuchrevision']:
269
raise errors.UnexpectedSmartServerResponse(response[0])
270
if response[0][0] == 'ok':
271
coded = response[1].read_body_bytes()
273
# no revisions in this repository!
275
lines = coded.split('\n')
278
d = list(line.split())
279
revision_graph[d[0]] = d[1:]
281
return revision_graph
283
response_body = response[1].read_body_bytes()
284
assert response_body == ''
285
raise NoSuchRevision(self, revision_id)
880
287
def has_revision(self, revision_id):
881
"""True if this repository has a copy of the revision."""
882
# Copy of bzrlib.repository.Repository.has_revision
883
return revision_id in self.has_revisions((revision_id,))
886
def has_revisions(self, revision_ids):
887
"""Probe to find out the presence of multiple revisions.
889
:param revision_ids: An iterable of revision_ids.
890
:return: A set of the revision_ids that were present.
892
# Copy of bzrlib.repository.Repository.has_revisions
893
parent_map = self.get_parent_map(revision_ids)
894
result = set(parent_map)
895
if _mod_revision.NULL_REVISION in revision_ids:
896
result.add(_mod_revision.NULL_REVISION)
899
def _has_same_fallbacks(self, other_repo):
900
"""Returns true if the repositories have the same fallbacks."""
901
# XXX: copied from Repository; it should be unified into a base class
902
# <https://bugs.launchpad.net/bzr/+bug/401622>
903
my_fb = self._fallback_repositories
904
other_fb = other_repo._fallback_repositories
905
if len(my_fb) != len(other_fb):
907
for f, g in zip(my_fb, other_fb):
908
if not f.has_same_location(g):
912
def has_same_location(self, other):
913
# TODO: Move to RepositoryBase and unify with the regular Repository
914
# one; unfortunately the tests rely on slightly different behaviour at
915
# present -- mbp 20090710
916
return (self.__class__ is other.__class__ and
917
self.bzrdir.transport.base == other.bzrdir.transport.base)
919
def get_graph(self, other_repository=None):
920
"""Return the graph for this repository format"""
921
parents_provider = self._make_parents_provider(other_repository)
922
return graph.Graph(parents_provider)
925
def get_known_graph_ancestry(self, revision_ids):
926
"""Return the known graph for a set of revision ids and their ancestors.
928
st = static_tuple.StaticTuple
929
revision_keys = [st(r_id).intern() for r_id in revision_ids]
930
known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
931
return graph.GraphThunkIdsToKeys(known_graph)
288
"""See Repository.has_revision()."""
289
if revision_id is None:
290
# The null revision is always present.
292
path = self.bzrdir._path_for_remote_call(self._client)
293
response = self._client.call('Repository.has_revision', path, revision_id)
294
assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
295
return response[0] == 'yes'
933
297
def gather_stats(self, revid=None, committers=None):
934
298
"""See Repository.gather_stats()."""
935
299
path = self.bzrdir._path_for_remote_call(self._client)
936
# revid can be None to indicate no revisions, not just NULL_REVISION
937
if revid is None or revision.is_null(revid):
300
if revid in (None, NULL_REVISION):
940
303
fmt_revid = revid
1310
510
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
1312
512
def make_working_trees(self):
1313
"""See Repository.make_working_trees"""
1315
return self._real_repository.make_working_trees()
1317
def refresh_data(self):
1318
"""Re-read any data needed to synchronise with disk.
1320
This method is intended to be called after another repository instance
1321
(such as one used by a smart server) has inserted data into the
1322
repository. On all repositories this will work outside of write groups.
1323
Some repository formats (pack and newer for bzrlib native formats)
1324
support refresh_data inside write groups. If called inside a write
1325
group on a repository that does not support refreshing in a write group
1326
IsInWriteGroupError will be raised.
1328
if self._real_repository is not None:
1329
self._real_repository.refresh_data()
1331
def revision_ids_to_search_result(self, result_set):
1332
"""Convert a set of revision ids to a graph SearchResult."""
1333
result_parents = set()
1334
for parents in self.get_graph().get_parent_map(
1335
result_set).itervalues():
1336
result_parents.update(parents)
1337
included_keys = result_set.intersection(result_parents)
1338
start_keys = result_set.difference(included_keys)
1339
exclude_keys = result_parents.difference(result_set)
1340
result = graph.SearchResult(start_keys, exclude_keys,
1341
len(result_set), result_set)
1345
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1346
"""Return the revision ids that other has that this does not.
1348
These are returned in topological order.
1350
revision_id: only return revision ids included by revision_id.
1352
return repository.InterRepository.get(
1353
other, self).search_missing_revision_ids(revision_id, find_ghosts)
1355
def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1357
# No base implementation to use as RemoteRepository is not a subclass
1358
# of Repository; so this is a copy of Repository.fetch().
1359
if fetch_spec is not None and revision_id is not None:
1360
raise AssertionError(
1361
"fetch_spec and revision_id are mutually exclusive.")
1362
if self.is_in_write_group():
1363
raise errors.InternalBzrError(
1364
"May not fetch while in a write group.")
1365
# fast path same-url fetch operations
1366
if (self.has_same_location(source)
1367
and fetch_spec is None
1368
and self._has_same_fallbacks(source)):
1369
# check that last_revision is in 'from' and then return a
1371
if (revision_id is not None and
1372
not revision.is_null(revision_id)):
1373
self.get_revision(revision_id)
1375
# if there is no specific appropriate InterRepository, this will get
1376
# the InterRepository base class, which raises an
1377
# IncompatibleRepositories when asked to fetch.
1378
inter = repository.InterRepository.get(source, self)
1379
return inter.fetch(revision_id=revision_id, pb=pb,
1380
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1382
def create_bundle(self, target, base, fileobj, format=None):
1384
self._real_repository.create_bundle(target, base, fileobj, format)
1387
def get_ancestry(self, revision_id, topo_sorted=True):
1389
return self._real_repository.get_ancestry(revision_id, topo_sorted)
513
"""RemoteRepositories never create working trees by default."""
516
def fetch(self, source, revision_id=None, pb=None):
518
return self._real_repository.fetch(
519
source, revision_id=revision_id, pb=pb)
522
def control_weaves(self):
524
return self._real_repository.control_weaves
527
def get_ancestry(self, revision_id):
529
return self._real_repository.get_ancestry(revision_id)
532
def get_inventory_weave(self):
534
return self._real_repository.get_inventory_weave()
1391
536
def fileids_altered_by_revision_ids(self, revision_ids):
1392
537
self._ensure_real()
1393
538
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
1395
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
1397
return self._real_repository._get_versioned_file_checker(
1398
revisions, revision_versions_cache)
1400
def iter_files_bytes(self, desired_files):
1401
"""See Repository.iter_file_bytes.
1404
return self._real_repository.iter_files_bytes(desired_files)
1406
def get_parent_map(self, revision_ids):
1407
"""See bzrlib.Graph.get_parent_map()."""
1408
return self._make_parents_provider().get_parent_map(revision_ids)
1410
def _get_parent_map_rpc(self, keys):
1411
"""Helper for get_parent_map that performs the RPC."""
1412
medium = self._client._medium
1413
if medium._is_remote_before((1, 2)):
1414
# We already found out that the server can't understand
1415
# Repository.get_parent_map requests, so just fetch the whole
1418
# Note that this reads the whole graph, when only some keys are
1419
# wanted. On this old server there's no way (?) to get them all
1420
# in one go, and the user probably will have seen a warning about
1421
# the server being old anyhow.
1422
rg = self._get_revision_graph(None)
1423
# There is an API discrepancy between get_parent_map and
1424
# get_revision_graph. Specifically, a "key:()" pair in
1425
# get_revision_graph just means a node has no parents. For
1426
# "get_parent_map" it means the node is a ghost. So fix up the
1427
# graph to correct this.
1428
# https://bugs.launchpad.net/bzr/+bug/214894
1429
# There is one other "bug" which is that ghosts in
1430
# get_revision_graph() are not returned at all. But we won't worry
1431
# about that for now.
1432
for node_id, parent_ids in rg.iteritems():
1433
if parent_ids == ():
1434
rg[node_id] = (NULL_REVISION,)
1435
rg[NULL_REVISION] = ()
1440
raise ValueError('get_parent_map(None) is not valid')
1441
if NULL_REVISION in keys:
1442
keys.discard(NULL_REVISION)
1443
found_parents = {NULL_REVISION:()}
1445
return found_parents
1448
# TODO(Needs analysis): We could assume that the keys being requested
1449
# from get_parent_map are in a breadth first search, so typically they
1450
# will all be depth N from some common parent, and we don't have to
1451
# have the server iterate from the root parent, but rather from the
1452
# keys we're searching; and just tell the server the keyspace we
1453
# already have; but this may be more traffic again.
1455
# Transform self._parents_map into a search request recipe.
1456
# TODO: Manage this incrementally to avoid covering the same path
1457
# repeatedly. (The server will have to on each request, but the less
1458
# work done the better).
1460
# Negative caching notes:
1461
# new server sends missing when a request including the revid
1462
# 'include-missing:' is present in the request.
1463
# missing keys are serialised as missing:X, and we then call
1464
# provider.note_missing(X) for-all X
1465
parents_map = self._unstacked_provider.get_cached_map()
1466
if parents_map is None:
1467
# Repository is not locked, so there's no cache.
1469
# start_set is all the keys in the cache
1470
start_set = set(parents_map)
1471
# result set is all the references to keys in the cache
1472
result_parents = set()
1473
for parents in parents_map.itervalues():
1474
result_parents.update(parents)
1475
stop_keys = result_parents.difference(start_set)
1476
# We don't need to send ghosts back to the server as a position to
1478
stop_keys.difference_update(self._unstacked_provider.missing_keys)
1479
key_count = len(parents_map)
1480
if (NULL_REVISION in result_parents
1481
and NULL_REVISION in self._unstacked_provider.missing_keys):
1482
# If we pruned NULL_REVISION from the stop_keys because it's also
1483
# in our cache of "missing" keys we need to increment our key count
1484
# by 1, because the reconsitituted SearchResult on the server will
1485
# still consider NULL_REVISION to be an included key.
1487
included_keys = start_set.intersection(result_parents)
1488
start_set.difference_update(included_keys)
1489
recipe = ('manual', start_set, stop_keys, key_count)
1490
body = self._serialise_search_recipe(recipe)
1491
path = self.bzrdir._path_for_remote_call(self._client)
1493
if type(key) is not str:
1495
"key %r not a plain string" % (key,))
1496
verb = 'Repository.get_parent_map'
1497
args = (path, 'include-missing:') + tuple(keys)
1499
response = self._call_with_body_bytes_expecting_body(
1501
except errors.UnknownSmartMethod:
1502
# Server does not support this method, so get the whole graph.
1503
# Worse, we have to force a disconnection, because the server now
1504
# doesn't realise it has a body on the wire to consume, so the
1505
# only way to recover is to abandon the connection.
1507
'Server is too old for fast get_parent_map, reconnecting. '
1508
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1510
# To avoid having to disconnect repeatedly, we keep track of the
1511
# fact the server doesn't understand remote methods added in 1.2.
1512
medium._remember_remote_is_before((1, 2))
1513
# Recurse just once and we should use the fallback code.
1514
return self._get_parent_map_rpc(keys)
1515
response_tuple, response_handler = response
1516
if response_tuple[0] not in ['ok']:
1517
response_handler.cancel_read_body()
1518
raise errors.UnexpectedSmartServerResponse(response_tuple)
1519
if response_tuple[0] == 'ok':
1520
coded = bz2.decompress(response_handler.read_body_bytes())
1522
# no revisions found
1524
lines = coded.split('\n')
1527
d = tuple(line.split())
1529
revision_graph[d[0]] = d[1:]
1532
if d[0].startswith('missing:'):
1534
self._unstacked_provider.note_missing_key(revid)
1536
# no parents - so give the Graph result
1538
revision_graph[d[0]] = (NULL_REVISION,)
1539
return revision_graph
1541
540
@needs_read_lock
1542
541
def get_signature_text(self, revision_id):
1543
542
self._ensure_real()
1544
543
return self._real_repository.get_signature_text(revision_id)
1546
545
@needs_read_lock
1547
def _get_inventory_xml(self, revision_id):
1549
return self._real_repository._get_inventory_xml(revision_id)
546
def get_revision_graph_with_ghosts(self, revision_ids=None):
548
return self._real_repository.get_revision_graph_with_ghosts(
549
revision_ids=revision_ids)
552
def get_inventory_xml(self, revision_id):
554
return self._real_repository.get_inventory_xml(revision_id)
556
def deserialise_inventory(self, revision_id, xml):
558
return self._real_repository.deserialise_inventory(revision_id, xml)
1551
560
def reconcile(self, other=None, thorough=False):
1552
561
self._ensure_real()
1553
562
return self._real_repository.reconcile(other=other, thorough=thorough)
1555
564
def all_revision_ids(self):
1556
565
self._ensure_real()
1557
566
return self._real_repository.all_revision_ids()
1560
def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1562
return self._real_repository.get_deltas_for_revisions(revisions,
1563
specific_fileids=specific_fileids)
1566
def get_revision_delta(self, revision_id, specific_fileids=None):
1568
return self._real_repository.get_revision_delta(revision_id,
1569
specific_fileids=specific_fileids)
569
def get_deltas_for_revisions(self, revisions):
571
return self._real_repository.get_deltas_for_revisions(revisions)
574
def get_revision_delta(self, revision_id):
576
return self._real_repository.get_revision_delta(revision_id)
1571
578
@needs_read_lock
1572
579
def revision_trees(self, revision_ids):
1705
649
def _serializer(self):
1706
return self._format._serializer
651
return self._real_repository._serializer
1708
653
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1709
654
self._ensure_real()
1710
655
return self._real_repository.store_revision_signature(
1711
656
gpg_strategy, plaintext, revision_id)
1713
def add_signature_text(self, revision_id, signature):
1715
return self._real_repository.add_signature_text(revision_id, signature)
1717
658
def has_signature_for_revision_id(self, revision_id):
1718
659
self._ensure_real()
1719
660
return self._real_repository.has_signature_for_revision_id(revision_id)
1721
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1723
return self._real_repository.item_keys_introduced_by(revision_ids,
1724
_files_pb=_files_pb)
1726
def revision_graph_can_have_wrong_parents(self):
1727
# The answer depends on the remote repo format.
1729
return self._real_repository.revision_graph_can_have_wrong_parents()
1731
def _find_inconsistent_revision_parents(self, revisions_iterator=None):
1733
return self._real_repository._find_inconsistent_revision_parents(
1736
def _check_for_inconsistent_revision_parents(self):
1738
return self._real_repository._check_for_inconsistent_revision_parents()
1740
def _make_parents_provider(self, other=None):
1741
providers = [self._unstacked_provider]
1742
if other is not None:
1743
providers.insert(0, other)
1744
providers.extend(r._make_parents_provider() for r in
1745
self._fallback_repositories)
1746
return graph.StackedParentsProvider(providers)
1748
def _serialise_search_recipe(self, recipe):
1749
"""Serialise a graph search recipe.
1751
:param recipe: A search recipe (start, stop, count).
1752
:return: Serialised bytes.
1754
start_keys = ' '.join(recipe[1])
1755
stop_keys = ' '.join(recipe[2])
1756
count = str(recipe[3])
1757
return '\n'.join((start_keys, stop_keys, count))
1759
def _serialise_search_result(self, search_result):
1760
if isinstance(search_result, graph.PendingAncestryResult):
1761
parts = ['ancestry-of']
1762
parts.extend(search_result.heads)
1764
recipe = search_result.get_recipe()
1765
parts = [recipe[0], self._serialise_search_recipe(recipe)]
1766
return '\n'.join(parts)
1769
path = self.bzrdir._path_for_remote_call(self._client)
1771
response = self._call('PackRepository.autopack', path)
1772
except errors.UnknownSmartMethod:
1774
self._real_repository._pack_collection.autopack()
1777
if response[0] != 'ok':
1778
raise errors.UnexpectedSmartServerResponse(response)
1781
class RemoteStreamSink(repository.StreamSink):
1783
def _insert_real(self, stream, src_format, resume_tokens):
1784
self.target_repo._ensure_real()
1785
sink = self.target_repo._real_repository._get_sink()
1786
result = sink.insert_stream(stream, src_format, resume_tokens)
1788
self.target_repo.autopack()
1791
def insert_stream(self, stream, src_format, resume_tokens):
1792
target = self.target_repo
1793
target._unstacked_provider.missing_keys.clear()
1794
candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
1795
if target._lock_token:
1796
candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
1797
lock_args = (target._lock_token or '',)
1799
candidate_calls.append(('Repository.insert_stream', (1, 13)))
1801
client = target._client
1802
medium = client._medium
1803
path = target.bzrdir._path_for_remote_call(client)
1804
# Probe for the verb to use with an empty stream before sending the
1805
# real stream to it. We do this both to avoid the risk of sending a
1806
# large request that is then rejected, and because we don't want to
1807
# implement a way to buffer, rewind, or restart the stream.
1809
for verb, required_version in candidate_calls:
1810
if medium._is_remote_before(required_version):
1813
# We've already done the probing (and set _is_remote_before) on
1814
# a previous insert.
1817
byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1819
response = client.call_with_body_stream(
1820
(verb, path, '') + lock_args, byte_stream)
1821
except errors.UnknownSmartMethod:
1822
medium._remember_remote_is_before(required_version)
1828
return self._insert_real(stream, src_format, resume_tokens)
1829
self._last_inv_record = None
1830
self._last_substream = None
1831
if required_version < (1, 19):
1832
# Remote side doesn't support inventory deltas. Wrap the stream to
1833
# make sure we don't send any. If the stream contains inventory
1834
# deltas we'll interrupt the smart insert_stream request and
1836
stream = self._stop_stream_if_inventory_delta(stream)
1837
byte_stream = smart_repo._stream_to_byte_stream(
1839
resume_tokens = ' '.join(resume_tokens)
1840
response = client.call_with_body_stream(
1841
(verb, path, resume_tokens) + lock_args, byte_stream)
1842
if response[0][0] not in ('ok', 'missing-basis'):
1843
raise errors.UnexpectedSmartServerResponse(response)
1844
if self._last_substream is not None:
1845
# The stream included an inventory-delta record, but the remote
1846
# side isn't new enough to support them. So we need to send the
1847
# rest of the stream via VFS.
1848
self.target_repo.refresh_data()
1849
return self._resume_stream_with_vfs(response, src_format)
1850
if response[0][0] == 'missing-basis':
1851
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1852
resume_tokens = tokens
1853
return resume_tokens, set(missing_keys)
1855
self.target_repo.refresh_data()
1858
def _resume_stream_with_vfs(self, response, src_format):
1859
"""Resume sending a stream via VFS, first resending the record and
1860
substream that couldn't be sent via an insert_stream verb.
1862
if response[0][0] == 'missing-basis':
1863
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1864
# Ignore missing_keys, we haven't finished inserting yet
1867
def resume_substream():
1868
# Yield the substream that was interrupted.
1869
for record in self._last_substream:
1871
self._last_substream = None
1872
def resume_stream():
1873
# Finish sending the interrupted substream
1874
yield ('inventory-deltas', resume_substream())
1875
# Then simply continue sending the rest of the stream.
1876
for substream_kind, substream in self._last_stream:
1877
yield substream_kind, substream
1878
return self._insert_real(resume_stream(), src_format, tokens)
1880
def _stop_stream_if_inventory_delta(self, stream):
1881
"""Normally this just lets the original stream pass-through unchanged.
1883
However if any 'inventory-deltas' substream occurs it will stop
1884
streaming, and store the interrupted substream and stream in
1885
self._last_substream and self._last_stream so that the stream can be
1886
resumed by _resume_stream_with_vfs.
1889
stream_iter = iter(stream)
1890
for substream_kind, substream in stream_iter:
1891
if substream_kind == 'inventory-deltas':
1892
self._last_substream = substream
1893
self._last_stream = stream_iter
1896
yield substream_kind, substream
1899
class RemoteStreamSource(repository.StreamSource):
1900
"""Stream data from a remote server."""
1902
def get_stream(self, search):
1903
if (self.from_repository._fallback_repositories and
1904
self.to_format._fetch_order == 'topological'):
1905
return self._real_stream(self.from_repository, search)
1908
repos = [self.from_repository]
1914
repos.extend(repo._fallback_repositories)
1915
sources.append(repo)
1916
return self.missing_parents_chain(search, sources)
1918
def get_stream_for_missing_keys(self, missing_keys):
1919
self.from_repository._ensure_real()
1920
real_repo = self.from_repository._real_repository
1921
real_source = real_repo._get_source(self.to_format)
1922
return real_source.get_stream_for_missing_keys(missing_keys)
1924
def _real_stream(self, repo, search):
1925
"""Get a stream for search from repo.
1927
This never called RemoteStreamSource.get_stream, and is a heler
1928
for RemoteStreamSource._get_stream to allow getting a stream
1929
reliably whether fallback back because of old servers or trying
1930
to stream from a non-RemoteRepository (which the stacked support
1933
source = repo._get_source(self.to_format)
1934
if isinstance(source, RemoteStreamSource):
1936
source = repo._real_repository._get_source(self.to_format)
1937
return source.get_stream(search)
1939
def _get_stream(self, repo, search):
1940
"""Core worker to get a stream from repo for search.
1942
This is used by both get_stream and the stacking support logic. It
1943
deliberately gets a stream for repo which does not need to be
1944
self.from_repository. In the event that repo is not Remote, or
1945
cannot do a smart stream, a fallback is made to the generic
1946
repository._get_stream() interface, via self._real_stream.
1948
In the event of stacking, streams from _get_stream will not
1949
contain all the data for search - this is normal (see get_stream).
1951
:param repo: A repository.
1952
:param search: A search.
1954
# Fallbacks may be non-smart
1955
if not isinstance(repo, RemoteRepository):
1956
return self._real_stream(repo, search)
1957
client = repo._client
1958
medium = client._medium
1959
path = repo.bzrdir._path_for_remote_call(client)
1960
search_bytes = repo._serialise_search_result(search)
1961
args = (path, self.to_format.network_name())
1963
('Repository.get_stream_1.19', (1, 19)),
1964
('Repository.get_stream', (1, 13))]
1966
for verb, version in candidate_verbs:
1967
if medium._is_remote_before(version):
1970
response = repo._call_with_body_bytes_expecting_body(
1971
verb, args, search_bytes)
1972
except errors.UnknownSmartMethod:
1973
medium._remember_remote_is_before(version)
1975
response_tuple, response_handler = response
1979
return self._real_stream(repo, search)
1980
if response_tuple[0] != 'ok':
1981
raise errors.UnexpectedSmartServerResponse(response_tuple)
1982
byte_stream = response_handler.read_streamed_body()
1983
src_format, stream = smart_repo._byte_stream_to_stream(byte_stream,
1984
self._record_counter)
1985
if src_format.network_name() != repo._format.network_name():
1986
raise AssertionError(
1987
"Mismatched RemoteRepository and stream src %r, %r" % (
1988
src_format.network_name(), repo._format.network_name()))
1991
def missing_parents_chain(self, search, sources):
1992
"""Chain multiple streams together to handle stacking.
1994
:param search: The overall search to satisfy with streams.
1995
:param sources: A list of Repository objects to query.
1997
self.from_serialiser = self.from_repository._format._serializer
1998
self.seen_revs = set()
1999
self.referenced_revs = set()
2000
# If there are heads in the search, or the key count is > 0, we are not
2002
while not search.is_empty() and len(sources) > 1:
2003
source = sources.pop(0)
2004
stream = self._get_stream(source, search)
2005
for kind, substream in stream:
2006
if kind != 'revisions':
2007
yield kind, substream
2009
yield kind, self.missing_parents_rev_handler(substream)
2010
search = search.refine(self.seen_revs, self.referenced_revs)
2011
self.seen_revs = set()
2012
self.referenced_revs = set()
2013
if not search.is_empty():
2014
for kind, stream in self._get_stream(sources[0], search):
2017
def missing_parents_rev_handler(self, substream):
2018
for content in substream:
2019
revision_bytes = content.get_bytes_as('fulltext')
2020
revision = self.from_serialiser.read_revision_from_string(
2022
self.seen_revs.add(content.key[-1])
2023
self.referenced_revs.update(revision.parent_ids)
2027
663
class RemoteBranchLockableFiles(LockableFiles):
2028
664
"""A 'LockableFiles' implementation that talks to a smart server.
2030
666
This is not a public interface class.
2043
679
self._dir_mode = None
2044
680
self._file_mode = None
683
"""'get' a remote path as per the LockableFiles interface.
685
:param path: the file to 'get'. If this is 'branch.conf', we do not
686
just retrieve a file, instead we ask the smart server to generate
687
a configuration for us - which is retrieved as an INI file.
689
if path == 'branch.conf':
690
path = self.bzrdir._path_for_remote_call(self._client)
691
response = self._client.call_expecting_body(
692
'Branch.get_config_file', path)
693
assert response[0][0] == 'ok', \
694
'unexpected response code %s' % (response[0],)
695
return StringIO(response[1].read_body_bytes())
698
return LockableFiles.get(self, path)
2047
701
class RemoteBranchFormat(branch.BranchFormat):
2049
def __init__(self, network_name=None):
2050
super(RemoteBranchFormat, self).__init__()
2051
self._matchingbzrdir = RemoteBzrDirFormat()
2052
self._matchingbzrdir.set_branch_format(self)
2053
self._custom_format = None
2054
self._network_name = network_name
2056
703
def __eq__(self, other):
2057
return (isinstance(other, RemoteBranchFormat) and
704
return (isinstance(other, RemoteBranchFormat) and
2058
705
self.__dict__ == other.__dict__)
2060
def _ensure_real(self):
2061
if self._custom_format is None:
2062
self._custom_format = branch.network_format_registry.get(
2065
707
def get_format_description(self):
2067
return 'Remote: ' + self._custom_format.get_format_description()
2069
def network_name(self):
2070
return self._network_name
2072
def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
2073
return a_bzrdir.open_branch(name=name,
2074
ignore_fallbacks=ignore_fallbacks)
2076
def _vfs_initialize(self, a_bzrdir, name):
2077
# Initialisation when using a local bzrdir object, or a non-vfs init
2078
# method is not available on the server.
2079
# self._custom_format is always set - the start of initialize ensures
2081
if isinstance(a_bzrdir, RemoteBzrDir):
2082
a_bzrdir._ensure_real()
2083
result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2086
# We assume the bzrdir is parameterised; it may not be.
2087
result = self._custom_format.initialize(a_bzrdir, name)
2088
if (isinstance(a_bzrdir, RemoteBzrDir) and
2089
not isinstance(result, RemoteBranch)):
2090
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2094
def initialize(self, a_bzrdir, name=None):
2095
# 1) get the network name to use.
2096
if self._custom_format:
2097
network_name = self._custom_format.network_name()
2099
# Select the current bzrlib default and ask for that.
2100
reference_bzrdir_format = bzrdir.format_registry.get('default')()
2101
reference_format = reference_bzrdir_format.get_branch_format()
2102
self._custom_format = reference_format
2103
network_name = reference_format.network_name()
2104
# Being asked to create on a non RemoteBzrDir:
2105
if not isinstance(a_bzrdir, RemoteBzrDir):
2106
return self._vfs_initialize(a_bzrdir, name=name)
2107
medium = a_bzrdir._client._medium
2108
if medium._is_remote_before((1, 13)):
2109
return self._vfs_initialize(a_bzrdir, name=name)
2110
# Creating on a remote bzr dir.
2111
# 2) try direct creation via RPC
2112
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2113
if name is not None:
2114
# XXX JRV20100304: Support creating colocated branches
2115
raise errors.NoColocatedBranchSupport(self)
2116
verb = 'BzrDir.create_branch'
2118
response = a_bzrdir._call(verb, path, network_name)
2119
except errors.UnknownSmartMethod:
2120
# Fallback - use vfs methods
2121
medium._remember_remote_is_before((1, 13))
2122
return self._vfs_initialize(a_bzrdir, name=name)
2123
if response[0] != 'ok':
2124
raise errors.UnexpectedSmartServerResponse(response)
2125
# Turn the response into a RemoteRepository object.
2126
format = RemoteBranchFormat(network_name=response[1])
2127
repo_format = response_tuple_to_repo_format(response[3:])
2128
if response[2] == '':
2129
repo_bzrdir = a_bzrdir
2131
repo_bzrdir = RemoteBzrDir(
2132
a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
2134
remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2135
remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2136
format=format, setup_stacking=False, name=name)
2137
# XXX: We know this is a new branch, so it must have revno 0, revid
2138
# NULL_REVISION. Creating the branch locked would make this be unable
2139
# to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2140
remote_branch._last_revision_info_cache = 0, NULL_REVISION
2141
return remote_branch
2143
def make_tags(self, branch):
2145
return self._custom_format.make_tags(branch)
2147
def supports_tags(self):
2148
# Remote branches might support tags, but we won't know until we
2149
# access the real remote branch.
2151
return self._custom_format.supports_tags()
2153
def supports_stacking(self):
2155
return self._custom_format.supports_stacking()
2157
def supports_set_append_revisions_only(self):
2159
return self._custom_format.supports_set_append_revisions_only()
2162
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
708
return 'Remote BZR Branch'
710
def get_format_string(self):
711
return 'Remote BZR Branch'
713
def open(self, a_bzrdir):
714
assert isinstance(a_bzrdir, RemoteBzrDir)
715
return a_bzrdir.open_branch()
717
def initialize(self, a_bzrdir):
718
assert isinstance(a_bzrdir, RemoteBzrDir)
719
return a_bzrdir.create_branch()
722
class RemoteBranch(branch.Branch):
2163
723
"""Branch stored on a server accessed by HPSS RPC.
2165
725
At the moment most operations are mapped down to simple file operations.
2168
728
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2169
_client=None, format=None, setup_stacking=True, name=None):
2170
730
"""Create a RemoteBranch instance.
2172
732
:param real_branch: An optional local implementation of the branch
2173
733
format, usually accessing the data via the VFS.
2174
734
:param _client: Private parameter for testing.
2175
:param format: A RemoteBranchFormat object, None to create one
2176
automatically. If supplied it should have a network_name already
2178
:param setup_stacking: If True make an RPC call to determine the
2179
stacked (or not) status of the branch. If False assume the branch
2181
:param name: Colocated branch name
2183
736
# We intentionally don't call the parent class's __init__, because it
2184
737
# will try to assign to self.tags, which is a property in this subclass.
2185
738
# And the parent's __init__ doesn't do much anyway.
739
self._revision_history_cache = None
2186
740
self.bzrdir = remote_bzrdir
2187
741
if _client is not None:
2188
742
self._client = _client
2190
self._client = remote_bzrdir._client
744
self._client = client._SmartClient(self.bzrdir._medium)
2191
745
self.repository = remote_repository
2192
746
if real_branch is not None:
2193
747
self._real_branch = real_branch
2331
804
self._ensure_real()
2332
805
return self._real_branch.get_physical_lock_status()
2334
def get_stacked_on_url(self):
2335
"""Get the URL this branch is stacked against.
2337
:raises NotStacked: If the branch is not stacked.
2338
:raises UnstackableBranchFormat: If the branch does not support
2340
:raises UnstackableRepositoryFormat: If the repository does not support
2344
# there may not be a repository yet, so we can't use
2345
# self._translate_error, so we can't use self._call either.
2346
response = self._client.call('Branch.get_stacked_on_url',
2347
self._remote_path())
2348
except errors.ErrorFromSmartServer, err:
2349
# there may not be a repository yet, so we can't call through
2350
# its _translate_error
2351
_translate_error(err, branch=self)
2352
except errors.UnknownSmartMethod, err:
2354
return self._real_branch.get_stacked_on_url()
2355
if response[0] != 'ok':
2356
raise errors.UnexpectedSmartServerResponse(response)
2359
def set_stacked_on_url(self, url):
2360
branch.Branch.set_stacked_on_url(self, url)
2362
self._is_stacked = False
2364
self._is_stacked = True
2366
def _vfs_get_tags_bytes(self):
2368
return self._real_branch._get_tags_bytes()
2370
def _get_tags_bytes(self):
2371
medium = self._client._medium
2372
if medium._is_remote_before((1, 13)):
2373
return self._vfs_get_tags_bytes()
2375
response = self._call('Branch.get_tags_bytes', self._remote_path())
2376
except errors.UnknownSmartMethod:
2377
medium._remember_remote_is_before((1, 13))
2378
return self._vfs_get_tags_bytes()
2381
def _vfs_set_tags_bytes(self, bytes):
2383
return self._real_branch._set_tags_bytes(bytes)
2385
def _set_tags_bytes(self, bytes):
2386
medium = self._client._medium
2387
if medium._is_remote_before((1, 18)):
2388
self._vfs_set_tags_bytes(bytes)
2392
self._remote_path(), self._lock_token, self._repo_lock_token)
2393
response = self._call_with_body_bytes(
2394
'Branch.set_tags_bytes', args, bytes)
2395
except errors.UnknownSmartMethod:
2396
medium._remember_remote_is_before((1, 18))
2397
self._vfs_set_tags_bytes(bytes)
2399
807
def lock_read(self):
2400
"""Lock the branch for read operations.
2402
:return: A bzrlib.lock.LogicalLockResult.
2404
self.repository.lock_read()
2405
808
if not self._lock_mode:
2406
self._note_lock('r')
2407
809
self._lock_mode = 'r'
2408
810
self._lock_count = 1
2409
811
if self._real_branch is not None:
2410
812
self._real_branch.lock_read()
2412
814
self._lock_count += 1
2413
return lock.LogicalLockResult(self.unlock)
2415
816
def _remote_lock_write(self, token):
2416
817
if token is None:
2417
818
branch_token = repo_token = ''
2419
820
branch_token = token
2420
repo_token = self.repository.lock_write().repository_token
821
repo_token = self.repository.lock_write()
2421
822
self.repository.unlock()
2422
err_context = {'token': token}
2423
response = self._call(
2424
'Branch.lock_write', self._remote_path(), branch_token,
2425
repo_token or '', **err_context)
2426
if response[0] != 'ok':
2427
raise errors.UnexpectedSmartServerResponse(response)
2428
ok, branch_token, repo_token = response
2429
return branch_token, repo_token
823
path = self.bzrdir._path_for_remote_call(self._client)
824
response = self._client.call('Branch.lock_write', path, branch_token,
826
if response[0] == 'ok':
827
ok, branch_token, repo_token = response
828
return branch_token, repo_token
829
elif response[0] == 'LockContention':
830
raise errors.LockContention('(remote lock)')
831
elif response[0] == 'TokenMismatch':
832
raise errors.TokenMismatch(token, '(remote token)')
833
elif response[0] == 'UnlockableTransport':
834
raise errors.UnlockableTransport(self.bzrdir.root_transport)
835
elif response[0] == 'ReadOnlyError':
836
raise errors.ReadOnlyError(self)
838
assert False, 'unexpected response code %r' % (response,)
2431
840
def lock_write(self, token=None):
2432
841
if not self._lock_mode:
2433
self._note_lock('w')
2434
# Lock the branch and repo in one remote call.
2435
842
remote_tokens = self._remote_lock_write(token)
2436
843
self._lock_token, self._repo_lock_token = remote_tokens
2437
if not self._lock_token:
2438
raise SmartProtocolError('Remote server did not return a token!')
2439
# Tell the self.repository object that it is locked.
2440
self.repository.lock_write(
2441
self._repo_lock_token, _skip_rpc=True)
844
assert self._lock_token, 'Remote server did not return a token!'
845
# TODO: We really, really, really don't want to call _ensure_real
846
# here, but it's the easiest way to ensure coherency between the
847
# state of the RemoteBranch and RemoteRepository objects and the
848
# physical locks. If we don't materialise the real objects here,
849
# then getting everything in the right state later is complex, so
850
# for now we just do it the lazy way.
851
# -- Andrew Bennetts, 2007-02-22.
2443
853
if self._real_branch is not None:
2444
self._real_branch.lock_write(token=self._lock_token)
854
self._real_branch.repository.lock_write(
855
token=self._repo_lock_token)
857
self._real_branch.lock_write(token=self._lock_token)
859
self._real_branch.repository.unlock()
2445
860
if token is not None:
2446
861
self._leave_lock = True
863
# XXX: this case seems to be unreachable; token cannot be None.
2448
864
self._leave_lock = False
2449
865
self._lock_mode = 'w'
2450
866
self._lock_count = 1
2451
867
elif self._lock_mode == 'r':
2452
raise errors.ReadOnlyError(self)
868
raise errors.ReadOnlyTransaction
2454
870
if token is not None:
2455
# A token was given to lock_write, and we're relocking, so
2456
# check that the given token actually matches the one we
871
# A token was given to lock_write, and we're relocking, so check
872
# that the given token actually matches the one we already have.
2458
873
if token != self._lock_token:
2459
874
raise errors.TokenMismatch(token, self._lock_token)
2460
875
self._lock_count += 1
2461
# Re-lock the repository too.
2462
self.repository.lock_write(self._repo_lock_token)
2463
return BranchWriteLockResult(self.unlock, self._lock_token or None)
876
return self._lock_token
2465
878
def _unlock(self, branch_token, repo_token):
2466
err_context = {'token': str((branch_token, repo_token))}
2467
response = self._call(
2468
'Branch.unlock', self._remote_path(), branch_token,
2469
repo_token or '', **err_context)
879
path = self.bzrdir._path_for_remote_call(self._client)
880
response = self._client.call('Branch.unlock', path, branch_token,
2470
882
if response == ('ok',):
2472
raise errors.UnexpectedSmartServerResponse(response)
884
elif response[0] == 'TokenMismatch':
885
raise errors.TokenMismatch(
886
str((branch_token, repo_token)), '(remote tokens)')
888
assert False, 'unexpected response code %s' % (response,)
2474
@only_raises(errors.LockNotHeld, errors.LockBroken)
2475
890
def unlock(self):
2477
self._lock_count -= 1
2478
if not self._lock_count:
2479
self._clear_cached_state()
2480
mode = self._lock_mode
2481
self._lock_mode = None
2482
if self._real_branch is not None:
2483
if (not self._leave_lock and mode == 'w' and
2484
self._repo_lock_token):
2485
# If this RemoteBranch will remove the physical lock
2486
# for the repository, make sure the _real_branch
2487
# doesn't do it first. (Because the _real_branch's
2488
# repository is set to be the RemoteRepository.)
2489
self._real_branch.repository.leave_lock_in_place()
2490
self._real_branch.unlock()
2492
# Only write-locked branched need to make a remote method
2493
# call to perform the unlock.
2495
if not self._lock_token:
2496
raise AssertionError('Locked, but no token!')
2497
branch_token = self._lock_token
2498
repo_token = self._repo_lock_token
2499
self._lock_token = None
2500
self._repo_lock_token = None
891
self._lock_count -= 1
892
if not self._lock_count:
893
self._clear_cached_state()
894
mode = self._lock_mode
895
self._lock_mode = None
896
if self._real_branch is not None:
2501
897
if not self._leave_lock:
2502
self._unlock(branch_token, repo_token)
2504
self.repository.unlock()
898
# If this RemoteBranch will remove the physical lock for the
899
# repository, make sure the _real_branch doesn't do it
900
# first. (Because the _real_branch's repository is set to
901
# be the RemoteRepository.)
902
self._real_branch.repository.leave_lock_in_place()
903
self._real_branch.unlock()
905
# Only write-locked branched need to make a remote method call
906
# to perfom the unlock.
908
assert self._lock_token, 'Locked, but no token!'
909
branch_token = self._lock_token
910
repo_token = self._repo_lock_token
911
self._lock_token = None
912
self._repo_lock_token = None
913
if not self._leave_lock:
914
self._unlock(branch_token, repo_token)
2506
916
def break_lock(self):
2507
917
self._ensure_real()
2508
918
return self._real_branch.break_lock()
2510
920
def leave_lock_in_place(self):
2511
if not self._lock_token:
2512
raise NotImplementedError(self.leave_lock_in_place)
2513
921
self._leave_lock = True
2515
923
def dont_leave_lock_in_place(self):
2516
if not self._lock_token:
2517
raise NotImplementedError(self.dont_leave_lock_in_place)
2518
924
self._leave_lock = False
2521
def get_rev_id(self, revno, history=None):
2523
return _mod_revision.NULL_REVISION
2524
last_revision_info = self.last_revision_info()
2525
ok, result = self.repository.get_rev_id_for_revno(
2526
revno, last_revision_info)
2529
missing_parent = result[1]
2530
# Either the revision named by the server is missing, or its parent
2531
# is. Call get_parent_map to determine which, so that we report a
2533
parent_map = self.repository.get_parent_map([missing_parent])
2534
if missing_parent in parent_map:
2535
missing_parent = parent_map[missing_parent]
2536
raise errors.RevisionNotPresent(missing_parent, self.repository)
2538
def _last_revision_info(self):
2539
response = self._call('Branch.last_revision_info', self._remote_path())
2540
if response[0] != 'ok':
2541
raise SmartProtocolError('unexpected response code %s' % (response,))
926
def last_revision_info(self):
927
"""See Branch.last_revision_info()."""
928
path = self.bzrdir._path_for_remote_call(self._client)
929
response = self._client.call('Branch.last_revision_info', path)
930
assert response[0] == 'ok', 'unexpected response code %s' % (response,)
2542
931
revno = int(response[1])
2543
932
last_revision = response[2]
2544
933
return (revno, last_revision)
2546
935
def _gen_revision_history(self):
2547
936
"""See Branch._gen_revision_history()."""
2548
if self._is_stacked:
2550
return self._real_branch._gen_revision_history()
2551
response_tuple, response_handler = self._call_expecting_body(
2552
'Branch.revision_history', self._remote_path())
2553
if response_tuple[0] != 'ok':
2554
raise errors.UnexpectedSmartServerResponse(response_tuple)
2555
result = response_handler.read_body_bytes().split('\x00')
937
path = self.bzrdir._path_for_remote_call(self._client)
938
response = self._client.call_expecting_body(
939
'Branch.revision_history', path)
940
assert response[0][0] == 'ok', ('unexpected response code %s'
942
result = response[1].read_body_bytes().split('\x00')
2556
943
if result == ['']:
2560
def _remote_path(self):
2561
return self.bzrdir._path_for_remote_call(self._client)
2563
def _set_last_revision_descendant(self, revision_id, other_branch,
2564
allow_diverged=False, allow_overwrite_descendant=False):
2565
# This performs additional work to meet the hook contract; while its
2566
# undesirable, we have to synthesise the revno to call the hook, and
2567
# not calling the hook is worse as it means changes can't be prevented.
2568
# Having calculated this though, we can't just call into
2569
# set_last_revision_info as a simple call, because there is a set_rh
2570
# hook that some folk may still be using.
2571
old_revno, old_revid = self.last_revision_info()
2572
history = self._lefthand_history(revision_id)
2573
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2574
err_context = {'other_branch': other_branch}
2575
response = self._call('Branch.set_last_revision_ex',
2576
self._remote_path(), self._lock_token, self._repo_lock_token,
2577
revision_id, int(allow_diverged), int(allow_overwrite_descendant),
2579
self._clear_cached_state()
2580
if len(response) != 3 and response[0] != 'ok':
2581
raise errors.UnexpectedSmartServerResponse(response)
2582
new_revno, new_revision_id = response[1:]
2583
self._last_revision_info_cache = new_revno, new_revision_id
2584
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2585
if self._real_branch is not None:
2586
cache = new_revno, new_revision_id
2587
self._real_branch._last_revision_info_cache = cache
2589
def _set_last_revision(self, revision_id):
2590
old_revno, old_revid = self.last_revision_info()
2591
# This performs additional work to meet the hook contract; while its
2592
# undesirable, we have to synthesise the revno to call the hook, and
2593
# not calling the hook is worse as it means changes can't be prevented.
2594
# Having calculated this though, we can't just call into
2595
# set_last_revision_info as a simple call, because there is a set_rh
2596
# hook that some folk may still be using.
2597
history = self._lefthand_history(revision_id)
2598
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2599
self._clear_cached_state()
2600
response = self._call('Branch.set_last_revision',
2601
self._remote_path(), self._lock_token, self._repo_lock_token,
2603
if response != ('ok',):
2604
raise errors.UnexpectedSmartServerResponse(response)
2605
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2607
947
@needs_write_lock
2608
948
def set_revision_history(self, rev_history):
2609
949
# Send just the tip revision of the history; the server will generate
2610
950
# the full history from that. If the revision doesn't exist in this
2611
951
# branch, NoSuchRevision will be raised.
952
path = self.bzrdir._path_for_remote_call(self._client)
2612
953
if rev_history == []:
2613
954
rev_id = 'null:'
2615
956
rev_id = rev_history[-1]
2616
self._set_last_revision(rev_id)
2617
for hook in branch.Branch.hooks['set_rh']:
2618
hook(self, rev_history)
957
self._clear_cached_state()
958
response = self._client.call('Branch.set_last_revision',
959
path, self._lock_token, self._repo_lock_token, rev_id)
960
if response[0] == 'NoSuchRevision':
961
raise NoSuchRevision(self, rev_id)
963
assert response == ('ok',), (
964
'unexpected response code %r' % (response,))
2619
965
self._cache_revision_history(rev_history)
2621
def _get_parent_location(self):
2622
medium = self._client._medium
2623
if medium._is_remote_before((1, 13)):
2624
return self._vfs_get_parent_location()
2626
response = self._call('Branch.get_parent', self._remote_path())
2627
except errors.UnknownSmartMethod:
2628
medium._remember_remote_is_before((1, 13))
2629
return self._vfs_get_parent_location()
2630
if len(response) != 1:
2631
raise errors.UnexpectedSmartServerResponse(response)
2632
parent_location = response[0]
2633
if parent_location == '':
2635
return parent_location
2637
def _vfs_get_parent_location(self):
2639
return self._real_branch._get_parent_location()
2641
def _set_parent_location(self, url):
2642
medium = self._client._medium
2643
if medium._is_remote_before((1, 15)):
2644
return self._vfs_set_parent_location(url)
2646
call_url = url or ''
2647
if type(call_url) is not str:
2648
raise AssertionError('url must be a str or None (%s)' % url)
2649
response = self._call('Branch.set_parent_location',
2650
self._remote_path(), self._lock_token, self._repo_lock_token,
2652
except errors.UnknownSmartMethod:
2653
medium._remember_remote_is_before((1, 15))
2654
return self._vfs_set_parent_location(url)
2656
raise errors.UnexpectedSmartServerResponse(response)
2658
def _vfs_set_parent_location(self, url):
2660
return self._real_branch._set_parent_location(url)
2663
def pull(self, source, overwrite=False, stop_revision=None,
2665
self._clear_cached_state_of_remote_branch_only()
2667
return self._real_branch.pull(
2668
source, overwrite=overwrite, stop_revision=stop_revision,
2669
_override_hook_target=self, **kwargs)
967
def get_parent(self):
969
return self._real_branch.get_parent()
971
def set_parent(self, url):
973
return self._real_branch.set_parent(url)
975
def get_config(self):
976
return RemoteBranchConfig(self)
978
def sprout(self, to_bzrdir, revision_id=None):
979
# Like Branch.sprout, except that it sprouts a branch in the default
980
# format, because RemoteBranches can't be created at arbitrary URLs.
981
# XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
982
# to_bzrdir.create_branch...
983
result = branch.BranchFormat.get_default_format().initialize(to_bzrdir)
984
self.copy_content_into(result, revision_id=revision_id)
985
result.set_parent(self.bzrdir.root_transport.base)
989
def append_revision(self, *revision_ids):
991
return self._real_branch.append_revision(*revision_ids)
994
def pull(self, source, overwrite=False, stop_revision=None):
996
self._real_branch.pull(
997
source, overwrite=overwrite, stop_revision=stop_revision)
2671
999
@needs_read_lock
2672
1000
def push(self, target, overwrite=False, stop_revision=None):
2673
1001
self._ensure_real()
2674
1002
return self._real_branch.push(
2675
target, overwrite=overwrite, stop_revision=stop_revision,
2676
_override_hook_source_branch=self)
1003
target, overwrite=overwrite, stop_revision=stop_revision)
2678
1005
def is_locked(self):
2679
1006
return self._lock_count >= 1
2682
def revision_id_to_revno(self, revision_id):
2684
return self._real_branch.revision_id_to_revno(revision_id)
2687
1008
def set_last_revision_info(self, revno, revision_id):
2688
# XXX: These should be returned by the set_last_revision_info verb
2689
old_revno, old_revid = self.last_revision_info()
2690
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2691
revision_id = ensure_null(revision_id)
2693
response = self._call('Branch.set_last_revision_info',
2694
self._remote_path(), self._lock_token, self._repo_lock_token,
2695
str(revno), revision_id)
2696
except errors.UnknownSmartMethod:
2698
self._clear_cached_state_of_remote_branch_only()
2699
self._real_branch.set_last_revision_info(revno, revision_id)
2700
self._last_revision_info_cache = revno, revision_id
2702
if response == ('ok',):
2703
self._clear_cached_state()
2704
self._last_revision_info_cache = revno, revision_id
2705
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2706
# Update the _real_branch's cache too.
2707
if self._real_branch is not None:
2708
cache = self._last_revision_info_cache
2709
self._real_branch._last_revision_info_cache = cache
2711
raise errors.UnexpectedSmartServerResponse(response)
1010
self._clear_cached_state()
1011
return self._real_branch.set_last_revision_info(revno, revision_id)
2714
1013
def generate_revision_history(self, revision_id, last_rev=None,
2715
1014
other_branch=None):
2716
medium = self._client._medium
2717
if not medium._is_remote_before((1, 6)):
2718
# Use a smart method for 1.6 and above servers
2720
self._set_last_revision_descendant(revision_id, other_branch,
2721
allow_diverged=True, allow_overwrite_descendant=True)
2723
except errors.UnknownSmartMethod:
2724
medium._remember_remote_is_before((1, 6))
2725
self._clear_cached_state_of_remote_branch_only()
2726
self.set_revision_history(self._lefthand_history(revision_id,
2727
last_rev=last_rev,other_branch=other_branch))
1016
return self._real_branch.generate_revision_history(
1017
revision_id, last_rev=last_rev, other_branch=other_branch)
1022
return self._real_branch.tags
2729
1024
def set_push_location(self, location):
2730
1025
self._ensure_real()
2731
1026
return self._real_branch.set_push_location(location)
2734
class RemoteConfig(object):
2735
"""A Config that reads and writes from smart verbs.
2737
It is a low-level object that considers config data to be name/value pairs
2738
that may be associated with a section. Assigning meaning to the these
2739
values is done at higher levels like bzrlib.config.TreeConfig.
2742
def get_option(self, name, section=None, default=None):
2743
"""Return the value associated with a named option.
2745
:param name: The name of the value
2746
:param section: The section the option is in (if any)
2747
:param default: The value to return if the value is not set
2748
:return: The value or default value
2751
configobj = self._get_configobj()
2753
section_obj = configobj
2756
section_obj = configobj[section]
2759
return section_obj.get(name, default)
2760
except errors.UnknownSmartMethod:
2761
return self._vfs_get_option(name, section, default)
2763
def _response_to_configobj(self, response):
2764
if len(response[0]) and response[0][0] != 'ok':
2765
raise errors.UnexpectedSmartServerResponse(response)
2766
lines = response[1].read_body_bytes().splitlines()
2767
return config.ConfigObj(lines, encoding='utf-8')
2770
class RemoteBranchConfig(RemoteConfig):
2771
"""A RemoteConfig for Branches."""
2773
def __init__(self, branch):
2774
self._branch = branch
2776
def _get_configobj(self):
2777
path = self._branch._remote_path()
2778
response = self._branch._client.call_expecting_body(
2779
'Branch.get_config_file', path)
2780
return self._response_to_configobj(response)
2782
def set_option(self, value, name, section=None):
2783
"""Set the value associated with a named option.
2785
:param value: The value to set
2786
:param name: The name of the value to set
2787
:param section: The section the option is in (if any)
2789
medium = self._branch._client._medium
2790
if medium._is_remote_before((1, 14)):
2791
return self._vfs_set_option(value, name, section)
2792
if isinstance(value, dict):
2793
if medium._is_remote_before((2, 2)):
2794
return self._vfs_set_option(value, name, section)
2795
return self._set_config_option_dict(value, name, section)
2797
return self._set_config_option(value, name, section)
2799
def _set_config_option(self, value, name, section):
2801
path = self._branch._remote_path()
2802
response = self._branch._client.call('Branch.set_config_option',
2803
path, self._branch._lock_token, self._branch._repo_lock_token,
2804
value.encode('utf8'), name, section or '')
2805
except errors.UnknownSmartMethod:
2806
medium = self._branch._client._medium
2807
medium._remember_remote_is_before((1, 14))
2808
return self._vfs_set_option(value, name, section)
2810
raise errors.UnexpectedSmartServerResponse(response)
2812
def _serialize_option_dict(self, option_dict):
2814
for key, value in option_dict.items():
2815
if isinstance(key, unicode):
2816
key = key.encode('utf8')
2817
if isinstance(value, unicode):
2818
value = value.encode('utf8')
2819
utf8_dict[key] = value
2820
return bencode.bencode(utf8_dict)
2822
def _set_config_option_dict(self, value, name, section):
2824
path = self._branch._remote_path()
2825
serialised_dict = self._serialize_option_dict(value)
2826
response = self._branch._client.call(
2827
'Branch.set_config_option_dict',
2828
path, self._branch._lock_token, self._branch._repo_lock_token,
2829
serialised_dict, name, section or '')
2830
except errors.UnknownSmartMethod:
2831
medium = self._branch._client._medium
2832
medium._remember_remote_is_before((2, 2))
2833
return self._vfs_set_option(value, name, section)
2835
raise errors.UnexpectedSmartServerResponse(response)
2837
def _real_object(self):
2838
self._branch._ensure_real()
2839
return self._branch._real_branch
2841
def _vfs_set_option(self, value, name, section=None):
2842
return self._real_object()._get_config().set_option(
2843
value, name, section)
2846
class RemoteBzrDirConfig(RemoteConfig):
2847
"""A RemoteConfig for BzrDirs."""
2849
def __init__(self, bzrdir):
2850
self._bzrdir = bzrdir
2852
def _get_configobj(self):
2853
medium = self._bzrdir._client._medium
2854
verb = 'BzrDir.get_config_file'
2855
if medium._is_remote_before((1, 15)):
2856
raise errors.UnknownSmartMethod(verb)
2857
path = self._bzrdir._path_for_remote_call(self._bzrdir._client)
2858
response = self._bzrdir._call_expecting_body(
2860
return self._response_to_configobj(response)
2862
def _vfs_get_option(self, name, section, default):
2863
return self._real_object()._get_config().get_option(
2864
name, section, default)
2866
def set_option(self, value, name, section=None):
2867
"""Set the value associated with a named option.
2869
:param value: The value to set
2870
:param name: The name of the value to set
2871
:param section: The section the option is in (if any)
2873
return self._real_object()._get_config().set_option(
2874
value, name, section)
2876
def _real_object(self):
2877
self._bzrdir._ensure_real()
2878
return self._bzrdir._real_bzrdir
1028
def update_revisions(self, other, stop_revision=None):
1030
return self._real_branch.update_revisions(
1031
other, stop_revision=stop_revision)
1034
class RemoteBranchConfig(BranchConfig):
1037
self.branch._ensure_real()
1038
return self.branch._real_branch.get_config().username()
1040
def _get_branch_data_config(self):
1041
self.branch._ensure_real()
1042
if self._branch_data_config is None:
1043
self._branch_data_config = TreeConfig(self.branch._real_branch)
1044
return self._branch_data_config
2882
1047
def _extract_tar(tar, to_dir):
added
removed
bzrlib/remote.py
