1
# Copyright (C) 2006, 2007, 2008, 2009 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
31
revision as _mod_revision,
34
from bzrlib.branch import BranchReferenceFormat
35
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
36
from bzrlib.decorators import needs_read_lock, needs_write_lock
37
from bzrlib.errors import (
41
from bzrlib.lockable_files import LockableFiles
42
from bzrlib.smart import client, vfs, repository as smart_repo
43
from bzrlib.revision import ensure_null, NULL_REVISION
44
from bzrlib.trace import mutter, note, warning
47
class _RpcHelper(object):
48
"""Mixin class that helps with issuing RPCs."""
50
def _call(self, method, *args, **err_context):
52
return self._client.call(method, *args)
53
except errors.ErrorFromSmartServer, err:
54
self._translate_error(err, **err_context)
56
def _call_expecting_body(self, method, *args, **err_context):
58
return self._client.call_expecting_body(method, *args)
59
except errors.ErrorFromSmartServer, err:
60
self._translate_error(err, **err_context)
62
def _call_with_body_bytes(self, method, args, body_bytes, **err_context):
64
return self._client.call_with_body_bytes(method, args, body_bytes)
65
except errors.ErrorFromSmartServer, err:
66
self._translate_error(err, **err_context)
68
def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
71
return self._client.call_with_body_bytes_expecting_body(
72
method, args, body_bytes)
73
except errors.ErrorFromSmartServer, err:
74
self._translate_error(err, **err_context)
77
def response_tuple_to_repo_format(response):
78
"""Convert a response tuple describing a repository format to a format."""
79
format = RemoteRepositoryFormat()
80
format._rich_root_data = (response[0] == 'yes')
81
format._supports_tree_reference = (response[1] == 'yes')
82
format._supports_external_lookups = (response[2] == 'yes')
83
format._network_name = response[3]
87
# Note: RemoteBzrDirFormat is in bzrdir.py
89
class RemoteBzrDir(BzrDir, _RpcHelper):
90
"""Control directory on a remote server, accessed via bzr:// or similar."""
92
def __init__(self, transport, format, _client=None):
93
"""Construct a RemoteBzrDir.
95
:param _client: Private parameter for testing. Disables probing and the
98
BzrDir.__init__(self, transport, format)
99
# this object holds a delegated bzrdir that uses file-level operations
100
# to talk to the other side
101
self._real_bzrdir = None
102
# 1-shot cache for the call pattern 'create_branch; open_branch' - see
103
# create_branch for details.
104
self._next_open_branch_result = None
107
medium = transport.get_smart_medium()
108
self._client = client._SmartClient(medium)
110
self._client = _client
113
path = self._path_for_remote_call(self._client)
114
response = self._call('BzrDir.open', path)
115
if response not in [('yes',), ('no',)]:
116
raise errors.UnexpectedSmartServerResponse(response)
117
if response == ('no',):
118
raise errors.NotBranchError(path=transport.base)
120
def _ensure_real(self):
121
"""Ensure that there is a _real_bzrdir set.
123
Used before calls to self._real_bzrdir.
125
if not self._real_bzrdir:
126
self._real_bzrdir = BzrDir.open_from_transport(
127
self.root_transport, _server_formats=False)
128
self._format._network_name = \
129
self._real_bzrdir._format.network_name()
131
def _translate_error(self, err, **context):
132
_translate_error(err, bzrdir=self, **context)
134
def break_lock(self):
135
# Prevent aliasing problems in the next_open_branch_result cache.
136
# See create_branch for rationale.
137
self._next_open_branch_result = None
138
return BzrDir.break_lock(self)
140
def _vfs_cloning_metadir(self, require_stacking=False):
142
return self._real_bzrdir.cloning_metadir(
143
require_stacking=require_stacking)
145
def cloning_metadir(self, require_stacking=False):
146
medium = self._client._medium
147
if medium._is_remote_before((1, 13)):
148
return self._vfs_cloning_metadir(require_stacking=require_stacking)
149
verb = 'BzrDir.cloning_metadir'
154
path = self._path_for_remote_call(self._client)
156
response = self._call(verb, path, stacking)
157
except errors.UnknownSmartMethod:
158
medium._remember_remote_is_before((1, 13))
159
return self._vfs_cloning_metadir(require_stacking=require_stacking)
160
except errors.UnknownErrorFromSmartServer, err:
161
if err.error_tuple != ('BranchReference',):
163
# We need to resolve the branch reference to determine the
164
# cloning_metadir. This causes unnecessary RPCs to open the
165
# referenced branch (and bzrdir, etc) but only when the caller
166
# didn't already resolve the branch reference.
167
referenced_branch = self.open_branch()
168
return referenced_branch.bzrdir.cloning_metadir()
169
if len(response) != 3:
170
raise errors.UnexpectedSmartServerResponse(response)
171
control_name, repo_name, branch_info = response
172
if len(branch_info) != 2:
173
raise errors.UnexpectedSmartServerResponse(response)
174
branch_ref, branch_name = branch_info
175
format = bzrdir.network_format_registry.get(control_name)
177
format.repository_format = repository.network_format_registry.get(
179
if branch_ref == 'ref':
180
# XXX: we need possible_transports here to avoid reopening the
181
# connection to the referenced location
182
ref_bzrdir = BzrDir.open(branch_name)
183
branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
184
format.set_branch_format(branch_format)
185
elif branch_ref == 'branch':
187
format.set_branch_format(
188
branch.network_format_registry.get(branch_name))
190
raise errors.UnexpectedSmartServerResponse(response)
193
def create_repository(self, shared=False):
194
# as per meta1 formats - just delegate to the format object which may
196
result = self._format.repository_format.initialize(self, shared)
197
if not isinstance(result, RemoteRepository):
198
return self.open_repository()
202
def destroy_repository(self):
203
"""See BzrDir.destroy_repository"""
205
self._real_bzrdir.destroy_repository()
207
def create_branch(self):
208
# as per meta1 formats - just delegate to the format object which may
210
real_branch = self._format.get_branch_format().initialize(self)
211
if not isinstance(real_branch, RemoteBranch):
212
result = RemoteBranch(self, self.find_repository(), real_branch)
215
# BzrDir.clone_on_transport() uses the result of create_branch but does
216
# not return it to its callers; we save approximately 8% of our round
217
# trips by handing the branch we created back to the first caller to
218
# open_branch rather than probing anew. Long term we need a API in
219
# bzrdir that doesn't discard result objects (like result_branch).
221
self._next_open_branch_result = result
224
def destroy_branch(self):
225
"""See BzrDir.destroy_branch"""
227
self._real_bzrdir.destroy_branch()
228
self._next_open_branch_result = None
230
def create_workingtree(self, revision_id=None, from_branch=None):
231
raise errors.NotLocalUrl(self.transport.base)
233
def find_branch_format(self):
234
"""Find the branch 'format' for this bzrdir.
236
This might be a synthetic object for e.g. RemoteBranch and SVN.
238
b = self.open_branch()
241
def get_branch_reference(self):
242
"""See BzrDir.get_branch_reference()."""
243
response = self._get_branch_reference()
244
if response[0] == 'ref':
249
def _get_branch_reference(self):
250
path = self._path_for_remote_call(self._client)
251
medium = self._client._medium
252
if not medium._is_remote_before((1, 13)):
254
response = self._call('BzrDir.open_branchV2', path)
255
if response[0] not in ('ref', 'branch'):
256
raise errors.UnexpectedSmartServerResponse(response)
258
except errors.UnknownSmartMethod:
259
medium._remember_remote_is_before((1, 13))
260
response = self._call('BzrDir.open_branch', path)
261
if response[0] != 'ok':
262
raise errors.UnexpectedSmartServerResponse(response)
263
if response[1] != '':
264
return ('ref', response[1])
266
return ('branch', '')
268
def _get_tree_branch(self):
269
"""See BzrDir._get_tree_branch()."""
270
return None, self.open_branch()
272
def open_branch(self, _unsupported=False, ignore_fallbacks=False):
274
raise NotImplementedError('unsupported flag support not implemented yet.')
275
if self._next_open_branch_result is not None:
276
# See create_branch for details.
277
result = self._next_open_branch_result
278
self._next_open_branch_result = None
280
response = self._get_branch_reference()
281
if response[0] == 'ref':
282
# a branch reference, use the existing BranchReference logic.
283
format = BranchReferenceFormat()
284
return format.open(self, _found=True, location=response[1],
285
ignore_fallbacks=ignore_fallbacks)
286
branch_format_name = response[1]
287
if not branch_format_name:
288
branch_format_name = None
289
format = RemoteBranchFormat(network_name=branch_format_name)
290
return RemoteBranch(self, self.find_repository(), format=format,
291
setup_stacking=not ignore_fallbacks)
293
def _open_repo_v1(self, path):
294
verb = 'BzrDir.find_repository'
295
response = self._call(verb, path)
296
if response[0] != 'ok':
297
raise errors.UnexpectedSmartServerResponse(response)
298
# servers that only support the v1 method don't support external
301
repo = self._real_bzrdir.open_repository()
302
response = response + ('no', repo._format.network_name())
303
return response, repo
305
def _open_repo_v2(self, path):
306
verb = 'BzrDir.find_repositoryV2'
307
response = self._call(verb, path)
308
if response[0] != 'ok':
309
raise errors.UnexpectedSmartServerResponse(response)
311
repo = self._real_bzrdir.open_repository()
312
response = response + (repo._format.network_name(),)
313
return response, repo
315
def _open_repo_v3(self, path):
316
verb = 'BzrDir.find_repositoryV3'
317
medium = self._client._medium
318
if medium._is_remote_before((1, 13)):
319
raise errors.UnknownSmartMethod(verb)
321
response = self._call(verb, path)
322
except errors.UnknownSmartMethod:
323
medium._remember_remote_is_before((1, 13))
325
if response[0] != 'ok':
326
raise errors.UnexpectedSmartServerResponse(response)
327
return response, None
329
def open_repository(self):
330
path = self._path_for_remote_call(self._client)
332
for probe in [self._open_repo_v3, self._open_repo_v2,
335
response, real_repo = probe(path)
337
except errors.UnknownSmartMethod:
340
raise errors.UnknownSmartMethod('BzrDir.find_repository{3,2,}')
341
if response[0] != 'ok':
342
raise errors.UnexpectedSmartServerResponse(response)
343
if len(response) != 6:
344
raise SmartProtocolError('incorrect response length %s' % (response,))
345
if response[1] == '':
346
# repo is at this dir.
347
format = response_tuple_to_repo_format(response[2:])
348
# Used to support creating a real format instance when needed.
349
format._creating_bzrdir = self
350
remote_repo = RemoteRepository(self, format)
351
format._creating_repo = remote_repo
352
if real_repo is not None:
353
remote_repo._set_real_repository(real_repo)
356
raise errors.NoRepositoryPresent(self)
358
def open_workingtree(self, recommend_upgrade=True):
360
if self._real_bzrdir.has_workingtree():
361
raise errors.NotLocalUrl(self.root_transport)
363
raise errors.NoWorkingTree(self.root_transport.base)
365
def _path_for_remote_call(self, client):
366
"""Return the path to be used for this bzrdir in a remote call."""
367
return client.remote_path_from_transport(self.root_transport)
369
def get_branch_transport(self, branch_format):
371
return self._real_bzrdir.get_branch_transport(branch_format)
373
def get_repository_transport(self, repository_format):
375
return self._real_bzrdir.get_repository_transport(repository_format)
377
def get_workingtree_transport(self, workingtree_format):
379
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
381
def can_convert_format(self):
382
"""Upgrading of remote bzrdirs is not supported yet."""
385
def needs_format_conversion(self, format=None):
386
"""Upgrading of remote bzrdirs is not supported yet."""
388
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
389
% 'needs_format_conversion(format=None)')
392
def clone(self, url, revision_id=None, force_new_repo=False,
393
preserve_stacking=False):
395
return self._real_bzrdir.clone(url, revision_id=revision_id,
396
force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
398
def _get_config(self):
399
return RemoteBzrDirConfig(self)
402
class RemoteRepositoryFormat(repository.RepositoryFormat):
403
"""Format for repositories accessed over a _SmartClient.
405
Instances of this repository are represented by RemoteRepository
408
The RemoteRepositoryFormat is parameterized during construction
409
to reflect the capabilities of the real, remote format. Specifically
410
the attributes rich_root_data and supports_tree_reference are set
411
on a per instance basis, and are not set (and should not be) at
414
:ivar _custom_format: If set, a specific concrete repository format that
415
will be used when initializing a repository with this
416
RemoteRepositoryFormat.
417
:ivar _creating_repo: If set, the repository object that this
418
RemoteRepositoryFormat was created for: it can be called into
419
to obtain data like the network name.
422
_matchingbzrdir = RemoteBzrDirFormat()
425
repository.RepositoryFormat.__init__(self)
426
self._custom_format = None
427
self._network_name = None
428
self._creating_bzrdir = None
429
self._supports_chks = None
430
self._supports_external_lookups = None
431
self._supports_tree_reference = None
432
self._rich_root_data = None
435
def fast_deltas(self):
437
return self._custom_format.fast_deltas
440
def rich_root_data(self):
441
if self._rich_root_data is None:
443
self._rich_root_data = self._custom_format.rich_root_data
444
return self._rich_root_data
447
def supports_chks(self):
448
if self._supports_chks is None:
450
self._supports_chks = self._custom_format.supports_chks
451
return self._supports_chks
454
def supports_external_lookups(self):
455
if self._supports_external_lookups is None:
457
self._supports_external_lookups = \
458
self._custom_format.supports_external_lookups
459
return self._supports_external_lookups
462
def supports_tree_reference(self):
463
if self._supports_tree_reference is None:
465
self._supports_tree_reference = \
466
self._custom_format.supports_tree_reference
467
return self._supports_tree_reference
469
def _vfs_initialize(self, a_bzrdir, shared):
470
"""Helper for common code in initialize."""
471
if self._custom_format:
472
# Custom format requested
473
result = self._custom_format.initialize(a_bzrdir, shared=shared)
474
elif self._creating_bzrdir is not None:
475
# Use the format that the repository we were created to back
477
prior_repo = self._creating_bzrdir.open_repository()
478
prior_repo._ensure_real()
479
result = prior_repo._real_repository._format.initialize(
480
a_bzrdir, shared=shared)
482
# assume that a_bzr is a RemoteBzrDir but the smart server didn't
483
# support remote initialization.
484
# We delegate to a real object at this point (as RemoteBzrDir
485
# delegate to the repository format which would lead to infinite
486
# recursion if we just called a_bzrdir.create_repository.
487
a_bzrdir._ensure_real()
488
result = a_bzrdir._real_bzrdir.create_repository(shared=shared)
489
if not isinstance(result, RemoteRepository):
490
return self.open(a_bzrdir)
494
def initialize(self, a_bzrdir, shared=False):
495
# Being asked to create on a non RemoteBzrDir:
496
if not isinstance(a_bzrdir, RemoteBzrDir):
497
return self._vfs_initialize(a_bzrdir, shared)
498
medium = a_bzrdir._client._medium
499
if medium._is_remote_before((1, 13)):
500
return self._vfs_initialize(a_bzrdir, shared)
501
# Creating on a remote bzr dir.
502
# 1) get the network name to use.
503
if self._custom_format:
504
network_name = self._custom_format.network_name()
505
elif self._network_name:
506
network_name = self._network_name
508
# Select the current bzrlib default and ask for that.
509
reference_bzrdir_format = bzrdir.format_registry.get('default')()
510
reference_format = reference_bzrdir_format.repository_format
511
network_name = reference_format.network_name()
512
# 2) try direct creation via RPC
513
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
514
verb = 'BzrDir.create_repository'
520
response = a_bzrdir._call(verb, path, network_name, shared_str)
521
except errors.UnknownSmartMethod:
522
# Fallback - use vfs methods
523
medium._remember_remote_is_before((1, 13))
524
return self._vfs_initialize(a_bzrdir, shared)
526
# Turn the response into a RemoteRepository object.
527
format = response_tuple_to_repo_format(response[1:])
528
# Used to support creating a real format instance when needed.
529
format._creating_bzrdir = a_bzrdir
530
remote_repo = RemoteRepository(a_bzrdir, format)
531
format._creating_repo = remote_repo
534
def open(self, a_bzrdir):
535
if not isinstance(a_bzrdir, RemoteBzrDir):
536
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
537
return a_bzrdir.open_repository()
539
def _ensure_real(self):
540
if self._custom_format is None:
541
self._custom_format = repository.network_format_registry.get(
545
def _fetch_order(self):
547
return self._custom_format._fetch_order
550
def _fetch_uses_deltas(self):
552
return self._custom_format._fetch_uses_deltas
555
def _fetch_reconcile(self):
557
return self._custom_format._fetch_reconcile
559
def get_format_description(self):
560
return 'bzr remote repository'
562
def __eq__(self, other):
563
return self.__class__ is other.__class__
565
def check_conversion_target(self, target_format):
566
if self.rich_root_data and not target_format.rich_root_data:
567
raise errors.BadConversionTarget(
568
'Does not support rich root data.', target_format)
569
if (self.supports_tree_reference and
570
not getattr(target_format, 'supports_tree_reference', False)):
571
raise errors.BadConversionTarget(
572
'Does not support nested trees', target_format)
574
def network_name(self):
575
if self._network_name:
576
return self._network_name
577
self._creating_repo._ensure_real()
578
return self._creating_repo._real_repository._format.network_name()
581
def pack_compresses(self):
583
return self._custom_format.pack_compresses
586
def _serializer(self):
588
return self._custom_format._serializer
591
class RemoteRepository(_RpcHelper):
592
"""Repository accessed over rpc.
594
For the moment most operations are performed using local transport-backed
598
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
599
"""Create a RemoteRepository instance.
601
:param remote_bzrdir: The bzrdir hosting this repository.
602
:param format: The RemoteFormat object to use.
603
:param real_repository: If not None, a local implementation of the
604
repository logic for the repository, usually accessing the data
606
:param _client: Private testing parameter - override the smart client
607
to be used by the repository.
610
self._real_repository = real_repository
612
self._real_repository = None
613
self.bzrdir = remote_bzrdir
615
self._client = remote_bzrdir._client
617
self._client = _client
618
self._format = format
619
self._lock_mode = None
620
self._lock_token = None
622
self._leave_lock = False
623
# Cache of revision parents; misses are cached during read locks, and
624
# write locks when no _real_repository has been set.
625
self._unstacked_provider = graph.CachingParentsProvider(
626
get_parent_map=self._get_parent_map_rpc)
627
self._unstacked_provider.disable_cache()
629
# These depend on the actual remote format, so force them off for
630
# maximum compatibility. XXX: In future these should depend on the
631
# remote repository instance, but this is irrelevant until we perform
632
# reconcile via an RPC call.
633
self._reconcile_does_inventory_gc = False
634
self._reconcile_fixes_text_parents = False
635
self._reconcile_backsup_inventory = False
636
self.base = self.bzrdir.transport.base
637
# Additional places to query for data.
638
self._fallback_repositories = []
641
return "%s(%s)" % (self.__class__.__name__, self.base)
645
def abort_write_group(self, suppress_errors=False):
646
"""Complete a write group on the decorated repository.
648
Smart methods perform operations in a single step so this API
649
is not really applicable except as a compatibility thunk
650
for older plugins that don't use e.g. the CommitBuilder
653
:param suppress_errors: see Repository.abort_write_group.
656
return self._real_repository.abort_write_group(
657
suppress_errors=suppress_errors)
661
"""Decorate the real repository for now.
663
In the long term a full blown network facility is needed to avoid
664
creating a real repository object locally.
667
return self._real_repository.chk_bytes
669
def commit_write_group(self):
670
"""Complete a write group on the decorated repository.
672
Smart methods perform operations in a single step so this API
673
is not really applicable except as a compatibility thunk
674
for older plugins that don't use e.g. the CommitBuilder
678
return self._real_repository.commit_write_group()
680
def resume_write_group(self, tokens):
682
return self._real_repository.resume_write_group(tokens)
684
def suspend_write_group(self):
686
return self._real_repository.suspend_write_group()
688
def get_missing_parent_inventories(self, check_for_missing_texts=True):
690
return self._real_repository.get_missing_parent_inventories(
691
check_for_missing_texts=check_for_missing_texts)
693
def _get_rev_id_for_revno_vfs(self, revno, known_pair):
695
return self._real_repository.get_rev_id_for_revno(
698
def get_rev_id_for_revno(self, revno, known_pair):
699
"""See Repository.get_rev_id_for_revno."""
700
path = self.bzrdir._path_for_remote_call(self._client)
702
if self._client._medium._is_remote_before((1, 17)):
703
return self._get_rev_id_for_revno_vfs(revno, known_pair)
704
response = self._call(
705
'Repository.get_rev_id_for_revno', path, revno, known_pair)
706
except errors.UnknownSmartMethod:
707
self._client._medium._remember_remote_is_before((1, 17))
708
return self._get_rev_id_for_revno_vfs(revno, known_pair)
709
if response[0] == 'ok':
710
return True, response[1]
711
elif response[0] == 'history-incomplete':
712
known_pair = response[1:3]
713
for fallback in self._fallback_repositories:
714
found, result = fallback.get_rev_id_for_revno(revno, known_pair)
719
# Not found in any fallbacks
720
return False, known_pair
722
raise errors.UnexpectedSmartServerResponse(response)
724
def _ensure_real(self):
725
"""Ensure that there is a _real_repository set.
727
Used before calls to self._real_repository.
729
Note that _ensure_real causes many roundtrips to the server which are
730
not desirable, and prevents the use of smart one-roundtrip RPC's to
731
perform complex operations (such as accessing parent data, streaming
732
revisions etc). Adding calls to _ensure_real should only be done when
733
bringing up new functionality, adding fallbacks for smart methods that
734
require a fallback path, and never to replace an existing smart method
735
invocation. If in doubt chat to the bzr network team.
737
if self._real_repository is None:
738
if 'hpssvfs' in debug.debug_flags:
740
warning('VFS Repository access triggered\n%s',
741
''.join(traceback.format_stack()))
742
self._unstacked_provider.missing_keys.clear()
743
self.bzrdir._ensure_real()
744
self._set_real_repository(
745
self.bzrdir._real_bzrdir.open_repository())
747
def _translate_error(self, err, **context):
748
self.bzrdir._translate_error(err, repository=self, **context)
750
def find_text_key_references(self):
751
"""Find the text key references within the repository.
753
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
754
revision_ids. Each altered file-ids has the exact revision_ids that
755
altered it listed explicitly.
756
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
757
to whether they were referred to by the inventory of the
758
revision_id that they contain. The inventory texts from all present
759
revision ids are assessed to generate this report.
762
return self._real_repository.find_text_key_references()
764
def _generate_text_key_index(self):
765
"""Generate a new text key index for the repository.
767
This is an expensive function that will take considerable time to run.
769
:return: A dict mapping (file_id, revision_id) tuples to a list of
770
parents, also (file_id, revision_id) tuples.
773
return self._real_repository._generate_text_key_index()
775
def _get_revision_graph(self, revision_id):
776
"""Private method for using with old (< 1.2) servers to fallback."""
777
if revision_id is None:
779
elif revision.is_null(revision_id):
782
path = self.bzrdir._path_for_remote_call(self._client)
783
response = self._call_expecting_body(
784
'Repository.get_revision_graph', path, revision_id)
785
response_tuple, response_handler = response
786
if response_tuple[0] != 'ok':
787
raise errors.UnexpectedSmartServerResponse(response_tuple)
788
coded = response_handler.read_body_bytes()
790
# no revisions in this repository!
792
lines = coded.split('\n')
795
d = tuple(line.split())
796
revision_graph[d[0]] = d[1:]
798
return revision_graph
801
"""See Repository._get_sink()."""
802
return RemoteStreamSink(self)
804
def _get_source(self, to_format):
805
"""Return a source for streaming from this repository."""
806
return RemoteStreamSource(self, to_format)
809
def has_revision(self, revision_id):
810
"""True if this repository has a copy of the revision."""
811
# Copy of bzrlib.repository.Repository.has_revision
812
return revision_id in self.has_revisions((revision_id,))
815
def has_revisions(self, revision_ids):
816
"""Probe to find out the presence of multiple revisions.
818
:param revision_ids: An iterable of revision_ids.
819
:return: A set of the revision_ids that were present.
821
# Copy of bzrlib.repository.Repository.has_revisions
822
parent_map = self.get_parent_map(revision_ids)
823
result = set(parent_map)
824
if _mod_revision.NULL_REVISION in revision_ids:
825
result.add(_mod_revision.NULL_REVISION)
828
def _has_same_fallbacks(self, other_repo):
829
"""Returns true if the repositories have the same fallbacks."""
830
# XXX: copied from Repository; it should be unified into a base class
831
# <https://bugs.edge.launchpad.net/bzr/+bug/401622>
832
my_fb = self._fallback_repositories
833
other_fb = other_repo._fallback_repositories
834
if len(my_fb) != len(other_fb):
836
for f, g in zip(my_fb, other_fb):
837
if not f.has_same_location(g):
841
def has_same_location(self, other):
842
# TODO: Move to RepositoryBase and unify with the regular Repository
843
# one; unfortunately the tests rely on slightly different behaviour at
844
# present -- mbp 20090710
845
return (self.__class__ is other.__class__ and
846
self.bzrdir.transport.base == other.bzrdir.transport.base)
848
def get_graph(self, other_repository=None):
849
"""Return the graph for this repository format"""
850
parents_provider = self._make_parents_provider(other_repository)
851
return graph.Graph(parents_provider)
853
def gather_stats(self, revid=None, committers=None):
854
"""See Repository.gather_stats()."""
855
path = self.bzrdir._path_for_remote_call(self._client)
856
# revid can be None to indicate no revisions, not just NULL_REVISION
857
if revid is None or revision.is_null(revid):
861
if committers is None or not committers:
862
fmt_committers = 'no'
864
fmt_committers = 'yes'
865
response_tuple, response_handler = self._call_expecting_body(
866
'Repository.gather_stats', path, fmt_revid, fmt_committers)
867
if response_tuple[0] != 'ok':
868
raise errors.UnexpectedSmartServerResponse(response_tuple)
870
body = response_handler.read_body_bytes()
872
for line in body.split('\n'):
875
key, val_text = line.split(':')
876
if key in ('revisions', 'size', 'committers'):
877
result[key] = int(val_text)
878
elif key in ('firstrev', 'latestrev'):
879
values = val_text.split(' ')[1:]
880
result[key] = (float(values[0]), long(values[1]))
884
def find_branches(self, using=False):
885
"""See Repository.find_branches()."""
886
# should be an API call to the server.
888
return self._real_repository.find_branches(using=using)
890
def get_physical_lock_status(self):
891
"""See Repository.get_physical_lock_status()."""
892
# should be an API call to the server.
894
return self._real_repository.get_physical_lock_status()
896
def is_in_write_group(self):
897
"""Return True if there is an open write group.
899
write groups are only applicable locally for the smart server..
901
if self._real_repository:
902
return self._real_repository.is_in_write_group()
905
return self._lock_count >= 1
908
"""See Repository.is_shared()."""
909
path = self.bzrdir._path_for_remote_call(self._client)
910
response = self._call('Repository.is_shared', path)
911
if response[0] not in ('yes', 'no'):
912
raise SmartProtocolError('unexpected response code %s' % (response,))
913
return response[0] == 'yes'
915
def is_write_locked(self):
916
return self._lock_mode == 'w'
919
# wrong eventually - want a local lock cache context
920
if not self._lock_mode:
921
self._lock_mode = 'r'
923
self._unstacked_provider.enable_cache(cache_misses=True)
924
if self._real_repository is not None:
925
self._real_repository.lock_read()
926
for repo in self._fallback_repositories:
929
self._lock_count += 1
931
def _remote_lock_write(self, token):
932
path = self.bzrdir._path_for_remote_call(self._client)
935
err_context = {'token': token}
936
response = self._call('Repository.lock_write', path, token,
938
if response[0] == 'ok':
942
raise errors.UnexpectedSmartServerResponse(response)
944
def lock_write(self, token=None, _skip_rpc=False):
945
if not self._lock_mode:
947
if self._lock_token is not None:
948
if token != self._lock_token:
949
raise errors.TokenMismatch(token, self._lock_token)
950
self._lock_token = token
952
self._lock_token = self._remote_lock_write(token)
953
# if self._lock_token is None, then this is something like packs or
954
# svn where we don't get to lock the repo, or a weave style repository
955
# where we cannot lock it over the wire and attempts to do so will
957
if self._real_repository is not None:
958
self._real_repository.lock_write(token=self._lock_token)
959
if token is not None:
960
self._leave_lock = True
962
self._leave_lock = False
963
self._lock_mode = 'w'
965
cache_misses = self._real_repository is None
966
self._unstacked_provider.enable_cache(cache_misses=cache_misses)
967
for repo in self._fallback_repositories:
968
# Writes don't affect fallback repos
970
elif self._lock_mode == 'r':
971
raise errors.ReadOnlyError(self)
973
self._lock_count += 1
974
return self._lock_token or None
976
def leave_lock_in_place(self):
977
if not self._lock_token:
978
raise NotImplementedError(self.leave_lock_in_place)
979
self._leave_lock = True
981
def dont_leave_lock_in_place(self):
982
if not self._lock_token:
983
raise NotImplementedError(self.dont_leave_lock_in_place)
984
self._leave_lock = False
986
def _set_real_repository(self, repository):
987
"""Set the _real_repository for this repository.
989
:param repository: The repository to fallback to for non-hpss
990
implemented operations.
992
if self._real_repository is not None:
993
# Replacing an already set real repository.
994
# We cannot do this [currently] if the repository is locked -
995
# synchronised state might be lost.
997
raise AssertionError('_real_repository is already set')
998
if isinstance(repository, RemoteRepository):
999
raise AssertionError()
1000
self._real_repository = repository
1001
# three code paths happen here:
1002
# 1) old servers, RemoteBranch.open() calls _ensure_real before setting
1003
# up stacking. In this case self._fallback_repositories is [], and the
1004
# real repo is already setup. Preserve the real repo and
1005
# RemoteRepository.add_fallback_repository will avoid adding
1007
# 2) new servers, RemoteBranch.open() sets up stacking, and when
1008
# ensure_real is triggered from a branch, the real repository to
1009
# set already has a matching list with separate instances, but
1010
# as they are also RemoteRepositories we don't worry about making the
1011
# lists be identical.
1012
# 3) new servers, RemoteRepository.ensure_real is triggered before
1013
# RemoteBranch.ensure real, in this case we get a repo with no fallbacks
1014
# and need to populate it.
1015
if (self._fallback_repositories and
1016
len(self._real_repository._fallback_repositories) !=
1017
len(self._fallback_repositories)):
1018
if len(self._real_repository._fallback_repositories):
1019
raise AssertionError(
1020
"cannot cleanly remove existing _fallback_repositories")
1021
for fb in self._fallback_repositories:
1022
self._real_repository.add_fallback_repository(fb)
1023
if self._lock_mode == 'w':
1024
# if we are already locked, the real repository must be able to
1025
# acquire the lock with our token.
1026
self._real_repository.lock_write(self._lock_token)
1027
elif self._lock_mode == 'r':
1028
self._real_repository.lock_read()
1030
def start_write_group(self):
1031
"""Start a write group on the decorated repository.
1033
Smart methods perform operations in a single step so this API
1034
is not really applicable except as a compatibility thunk
1035
for older plugins that don't use e.g. the CommitBuilder
1039
return self._real_repository.start_write_group()
1041
def _unlock(self, token):
1042
path = self.bzrdir._path_for_remote_call(self._client)
1044
# with no token the remote repository is not persistently locked.
1046
err_context = {'token': token}
1047
response = self._call('Repository.unlock', path, token,
1049
if response == ('ok',):
1052
raise errors.UnexpectedSmartServerResponse(response)
1055
if not self._lock_count:
1056
return lock.cant_unlock_not_held(self)
1057
self._lock_count -= 1
1058
if self._lock_count > 0:
1060
self._unstacked_provider.disable_cache()
1061
old_mode = self._lock_mode
1062
self._lock_mode = None
1064
# The real repository is responsible at present for raising an
1065
# exception if it's in an unfinished write group. However, it
1066
# normally will *not* actually remove the lock from disk - that's
1067
# done by the server on receiving the Repository.unlock call.
1068
# This is just to let the _real_repository stay up to date.
1069
if self._real_repository is not None:
1070
self._real_repository.unlock()
1072
# The rpc-level lock should be released even if there was a
1073
# problem releasing the vfs-based lock.
1075
# Only write-locked repositories need to make a remote method
1076
# call to perform the unlock.
1077
old_token = self._lock_token
1078
self._lock_token = None
1079
if not self._leave_lock:
1080
self._unlock(old_token)
1081
# Fallbacks are always 'lock_read()' so we don't pay attention to
1083
for repo in self._fallback_repositories:
1086
def break_lock(self):
1087
# should hand off to the network
1089
return self._real_repository.break_lock()
1091
def _get_tarball(self, compression):
1092
"""Return a TemporaryFile containing a repository tarball.
1094
Returns None if the server does not support sending tarballs.
1097
path = self.bzrdir._path_for_remote_call(self._client)
1099
response, protocol = self._call_expecting_body(
1100
'Repository.tarball', path, compression)
1101
except errors.UnknownSmartMethod:
1102
protocol.cancel_read_body()
1104
if response[0] == 'ok':
1105
# Extract the tarball and return it
1106
t = tempfile.NamedTemporaryFile()
1107
# TODO: rpc layer should read directly into it...
1108
t.write(protocol.read_body_bytes())
1111
raise errors.UnexpectedSmartServerResponse(response)
1113
def sprout(self, to_bzrdir, revision_id=None):
1114
# TODO: Option to control what format is created?
1116
dest_repo = self._real_repository._format.initialize(to_bzrdir,
1118
dest_repo.fetch(self, revision_id=revision_id)
1121
### These methods are just thin shims to the VFS object for now.
1123
def revision_tree(self, revision_id):
1125
return self._real_repository.revision_tree(revision_id)
1127
def get_serializer_format(self):
1129
return self._real_repository.get_serializer_format()
1131
def get_commit_builder(self, branch, parents, config, timestamp=None,
1132
timezone=None, committer=None, revprops=None,
1134
# FIXME: It ought to be possible to call this without immediately
1135
# triggering _ensure_real. For now it's the easiest thing to do.
1137
real_repo = self._real_repository
1138
builder = real_repo.get_commit_builder(branch, parents,
1139
config, timestamp=timestamp, timezone=timezone,
1140
committer=committer, revprops=revprops, revision_id=revision_id)
1143
def add_fallback_repository(self, repository):
1144
"""Add a repository to use for looking up data not held locally.
1146
:param repository: A repository.
1148
if not self._format.supports_external_lookups:
1149
raise errors.UnstackableRepositoryFormat(
1150
self._format.network_name(), self.base)
1151
# We need to accumulate additional repositories here, to pass them in
1154
if self.is_locked():
1155
# We will call fallback.unlock() when we transition to the unlocked
1156
# state, so always add a lock here. If a caller passes us a locked
1157
# repository, they are responsible for unlocking it later.
1158
repository.lock_read()
1159
self._fallback_repositories.append(repository)
1160
# If self._real_repository was parameterised already (e.g. because a
1161
# _real_branch had its get_stacked_on_url method called), then the
1162
# repository to be added may already be in the _real_repositories list.
1163
if self._real_repository is not None:
1164
fallback_locations = [repo.bzrdir.root_transport.base for repo in
1165
self._real_repository._fallback_repositories]
1166
if repository.bzrdir.root_transport.base not in fallback_locations:
1167
self._real_repository.add_fallback_repository(repository)
1169
def add_inventory(self, revid, inv, parents):
1171
return self._real_repository.add_inventory(revid, inv, parents)
1173
def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1176
return self._real_repository.add_inventory_by_delta(basis_revision_id,
1177
delta, new_revision_id, parents)
1179
def add_revision(self, rev_id, rev, inv=None, config=None):
1181
return self._real_repository.add_revision(
1182
rev_id, rev, inv=inv, config=config)
1185
def get_inventory(self, revision_id):
1187
return self._real_repository.get_inventory(revision_id)
1189
def iter_inventories(self, revision_ids, ordering='unordered'):
1191
return self._real_repository.iter_inventories(revision_ids, ordering)
1194
def get_revision(self, revision_id):
1196
return self._real_repository.get_revision(revision_id)
1198
def get_transaction(self):
1200
return self._real_repository.get_transaction()
1203
def clone(self, a_bzrdir, revision_id=None):
1205
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
1207
def make_working_trees(self):
1208
"""See Repository.make_working_trees"""
1210
return self._real_repository.make_working_trees()
1212
def refresh_data(self):
1213
"""Re-read any data needed to to synchronise with disk.
1215
This method is intended to be called after another repository instance
1216
(such as one used by a smart server) has inserted data into the
1217
repository. It may not be called during a write group, but may be
1218
called at any other time.
1220
if self.is_in_write_group():
1221
raise errors.InternalBzrError(
1222
"May not refresh_data while in a write group.")
1223
if self._real_repository is not None:
1224
self._real_repository.refresh_data()
1226
def revision_ids_to_search_result(self, result_set):
1227
"""Convert a set of revision ids to a graph SearchResult."""
1228
result_parents = set()
1229
for parents in self.get_graph().get_parent_map(
1230
result_set).itervalues():
1231
result_parents.update(parents)
1232
included_keys = result_set.intersection(result_parents)
1233
start_keys = result_set.difference(included_keys)
1234
exclude_keys = result_parents.difference(result_set)
1235
result = graph.SearchResult(start_keys, exclude_keys,
1236
len(result_set), result_set)
1240
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1241
"""Return the revision ids that other has that this does not.
1243
These are returned in topological order.
1245
revision_id: only return revision ids included by revision_id.
1247
return repository.InterRepository.get(
1248
other, self).search_missing_revision_ids(revision_id, find_ghosts)
1250
def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1252
# No base implementation to use as RemoteRepository is not a subclass
1253
# of Repository; so this is a copy of Repository.fetch().
1254
if fetch_spec is not None and revision_id is not None:
1255
raise AssertionError(
1256
"fetch_spec and revision_id are mutually exclusive.")
1257
if self.is_in_write_group():
1258
raise errors.InternalBzrError(
1259
"May not fetch while in a write group.")
1260
# fast path same-url fetch operations
1261
if (self.has_same_location(source)
1262
and fetch_spec is None
1263
and self._has_same_fallbacks(source)):
1264
# check that last_revision is in 'from' and then return a
1266
if (revision_id is not None and
1267
not revision.is_null(revision_id)):
1268
self.get_revision(revision_id)
1270
# if there is no specific appropriate InterRepository, this will get
1271
# the InterRepository base class, which raises an
1272
# IncompatibleRepositories when asked to fetch.
1273
inter = repository.InterRepository.get(source, self)
1274
return inter.fetch(revision_id=revision_id, pb=pb,
1275
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1277
def create_bundle(self, target, base, fileobj, format=None):
1279
self._real_repository.create_bundle(target, base, fileobj, format)
1282
def get_ancestry(self, revision_id, topo_sorted=True):
1284
return self._real_repository.get_ancestry(revision_id, topo_sorted)
1286
def fileids_altered_by_revision_ids(self, revision_ids):
1288
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
1290
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
1292
return self._real_repository._get_versioned_file_checker(
1293
revisions, revision_versions_cache)
1295
def iter_files_bytes(self, desired_files):
1296
"""See Repository.iter_file_bytes.
1299
return self._real_repository.iter_files_bytes(desired_files)
1301
def get_parent_map(self, revision_ids):
1302
"""See bzrlib.Graph.get_parent_map()."""
1303
return self._make_parents_provider().get_parent_map(revision_ids)
1305
def _get_parent_map_rpc(self, keys):
1306
"""Helper for get_parent_map that performs the RPC."""
1307
medium = self._client._medium
1308
if medium._is_remote_before((1, 2)):
1309
# We already found out that the server can't understand
1310
# Repository.get_parent_map requests, so just fetch the whole
1313
# Note that this reads the whole graph, when only some keys are
1314
# wanted. On this old server there's no way (?) to get them all
1315
# in one go, and the user probably will have seen a warning about
1316
# the server being old anyhow.
1317
rg = self._get_revision_graph(None)
1318
# There is an API discrepancy between get_parent_map and
1319
# get_revision_graph. Specifically, a "key:()" pair in
1320
# get_revision_graph just means a node has no parents. For
1321
# "get_parent_map" it means the node is a ghost. So fix up the
1322
# graph to correct this.
1323
# https://bugs.launchpad.net/bzr/+bug/214894
1324
# There is one other "bug" which is that ghosts in
1325
# get_revision_graph() are not returned at all. But we won't worry
1326
# about that for now.
1327
for node_id, parent_ids in rg.iteritems():
1328
if parent_ids == ():
1329
rg[node_id] = (NULL_REVISION,)
1330
rg[NULL_REVISION] = ()
1335
raise ValueError('get_parent_map(None) is not valid')
1336
if NULL_REVISION in keys:
1337
keys.discard(NULL_REVISION)
1338
found_parents = {NULL_REVISION:()}
1340
return found_parents
1343
# TODO(Needs analysis): We could assume that the keys being requested
1344
# from get_parent_map are in a breadth first search, so typically they
1345
# will all be depth N from some common parent, and we don't have to
1346
# have the server iterate from the root parent, but rather from the
1347
# keys we're searching; and just tell the server the keyspace we
1348
# already have; but this may be more traffic again.
1350
# Transform self._parents_map into a search request recipe.
1351
# TODO: Manage this incrementally to avoid covering the same path
1352
# repeatedly. (The server will have to on each request, but the less
1353
# work done the better).
1355
# Negative caching notes:
1356
# new server sends missing when a request including the revid
1357
# 'include-missing:' is present in the request.
1358
# missing keys are serialised as missing:X, and we then call
1359
# provider.note_missing(X) for-all X
1360
parents_map = self._unstacked_provider.get_cached_map()
1361
if parents_map is None:
1362
# Repository is not locked, so there's no cache.
1364
# start_set is all the keys in the cache
1365
start_set = set(parents_map)
1366
# result set is all the references to keys in the cache
1367
result_parents = set()
1368
for parents in parents_map.itervalues():
1369
result_parents.update(parents)
1370
stop_keys = result_parents.difference(start_set)
1371
# We don't need to send ghosts back to the server as a position to
1373
stop_keys.difference_update(self._unstacked_provider.missing_keys)
1374
key_count = len(parents_map)
1375
if (NULL_REVISION in result_parents
1376
and NULL_REVISION in self._unstacked_provider.missing_keys):
1377
# If we pruned NULL_REVISION from the stop_keys because it's also
1378
# in our cache of "missing" keys we need to increment our key count
1379
# by 1, because the reconsitituted SearchResult on the server will
1380
# still consider NULL_REVISION to be an included key.
1382
included_keys = start_set.intersection(result_parents)
1383
start_set.difference_update(included_keys)
1384
recipe = ('manual', start_set, stop_keys, key_count)
1385
body = self._serialise_search_recipe(recipe)
1386
path = self.bzrdir._path_for_remote_call(self._client)
1388
if type(key) is not str:
1390
"key %r not a plain string" % (key,))
1391
verb = 'Repository.get_parent_map'
1392
args = (path, 'include-missing:') + tuple(keys)
1394
response = self._call_with_body_bytes_expecting_body(
1396
except errors.UnknownSmartMethod:
1397
# Server does not support this method, so get the whole graph.
1398
# Worse, we have to force a disconnection, because the server now
1399
# doesn't realise it has a body on the wire to consume, so the
1400
# only way to recover is to abandon the connection.
1402
'Server is too old for fast get_parent_map, reconnecting. '
1403
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1405
# To avoid having to disconnect repeatedly, we keep track of the
1406
# fact the server doesn't understand remote methods added in 1.2.
1407
medium._remember_remote_is_before((1, 2))
1408
# Recurse just once and we should use the fallback code.
1409
return self._get_parent_map_rpc(keys)
1410
response_tuple, response_handler = response
1411
if response_tuple[0] not in ['ok']:
1412
response_handler.cancel_read_body()
1413
raise errors.UnexpectedSmartServerResponse(response_tuple)
1414
if response_tuple[0] == 'ok':
1415
coded = bz2.decompress(response_handler.read_body_bytes())
1417
# no revisions found
1419
lines = coded.split('\n')
1422
d = tuple(line.split())
1424
revision_graph[d[0]] = d[1:]
1427
if d[0].startswith('missing:'):
1429
self._unstacked_provider.note_missing_key(revid)
1431
# no parents - so give the Graph result
1433
revision_graph[d[0]] = (NULL_REVISION,)
1434
return revision_graph
1437
def get_signature_text(self, revision_id):
1439
return self._real_repository.get_signature_text(revision_id)
1442
def get_inventory_xml(self, revision_id):
1444
return self._real_repository.get_inventory_xml(revision_id)
1446
def deserialise_inventory(self, revision_id, xml):
1448
return self._real_repository.deserialise_inventory(revision_id, xml)
1450
def reconcile(self, other=None, thorough=False):
1452
return self._real_repository.reconcile(other=other, thorough=thorough)
1454
def all_revision_ids(self):
1456
return self._real_repository.all_revision_ids()
1459
def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1461
return self._real_repository.get_deltas_for_revisions(revisions,
1462
specific_fileids=specific_fileids)
1465
def get_revision_delta(self, revision_id, specific_fileids=None):
1467
return self._real_repository.get_revision_delta(revision_id,
1468
specific_fileids=specific_fileids)
1471
def revision_trees(self, revision_ids):
1473
return self._real_repository.revision_trees(revision_ids)
1476
def get_revision_reconcile(self, revision_id):
1478
return self._real_repository.get_revision_reconcile(revision_id)
1481
def check(self, revision_ids=None, callback_refs=None, check_repo=True):
1483
return self._real_repository.check(revision_ids=revision_ids,
1484
callback_refs=callback_refs, check_repo=check_repo)
1486
def copy_content_into(self, destination, revision_id=None):
1488
return self._real_repository.copy_content_into(
1489
destination, revision_id=revision_id)
1491
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
1492
# get a tarball of the remote repository, and copy from that into the
1494
from bzrlib import osutils
1496
# TODO: Maybe a progress bar while streaming the tarball?
1497
note("Copying repository content as tarball...")
1498
tar_file = self._get_tarball('bz2')
1499
if tar_file is None:
1501
destination = to_bzrdir.create_repository()
1503
tar = tarfile.open('repository', fileobj=tar_file,
1505
tmpdir = osutils.mkdtemp()
1507
_extract_tar(tar, tmpdir)
1508
tmp_bzrdir = BzrDir.open(tmpdir)
1509
tmp_repo = tmp_bzrdir.open_repository()
1510
tmp_repo.copy_content_into(destination, revision_id)
1512
osutils.rmtree(tmpdir)
1516
# TODO: Suggestion from john: using external tar is much faster than
1517
# python's tarfile library, but it may not work on windows.
1520
def inventories(self):
1521
"""Decorate the real repository for now.
1523
In the long term a full blown network facility is needed to
1524
avoid creating a real repository object locally.
1527
return self._real_repository.inventories
1530
def pack(self, hint=None):
1531
"""Compress the data within the repository.
1533
This is not currently implemented within the smart server.
1536
return self._real_repository.pack(hint=hint)
1539
def revisions(self):
1540
"""Decorate the real repository for now.
1542
In the short term this should become a real object to intercept graph
1545
In the long term a full blown network facility is needed.
1548
return self._real_repository.revisions
1550
def set_make_working_trees(self, new_value):
1552
new_value_str = "True"
1554
new_value_str = "False"
1555
path = self.bzrdir._path_for_remote_call(self._client)
1557
response = self._call(
1558
'Repository.set_make_working_trees', path, new_value_str)
1559
except errors.UnknownSmartMethod:
1561
self._real_repository.set_make_working_trees(new_value)
1563
if response[0] != 'ok':
1564
raise errors.UnexpectedSmartServerResponse(response)
1567
def signatures(self):
1568
"""Decorate the real repository for now.
1570
In the long term a full blown network facility is needed to avoid
1571
creating a real repository object locally.
1574
return self._real_repository.signatures
1577
def sign_revision(self, revision_id, gpg_strategy):
1579
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1583
"""Decorate the real repository for now.
1585
In the long term a full blown network facility is needed to avoid
1586
creating a real repository object locally.
1589
return self._real_repository.texts
1592
def get_revisions(self, revision_ids):
1594
return self._real_repository.get_revisions(revision_ids)
1596
def supports_rich_root(self):
1597
return self._format.rich_root_data
1599
def iter_reverse_revision_history(self, revision_id):
1601
return self._real_repository.iter_reverse_revision_history(revision_id)
1604
def _serializer(self):
1605
return self._format._serializer
1607
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1609
return self._real_repository.store_revision_signature(
1610
gpg_strategy, plaintext, revision_id)
1612
def add_signature_text(self, revision_id, signature):
1614
return self._real_repository.add_signature_text(revision_id, signature)
1616
def has_signature_for_revision_id(self, revision_id):
1618
return self._real_repository.has_signature_for_revision_id(revision_id)
1620
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1622
return self._real_repository.item_keys_introduced_by(revision_ids,
1623
_files_pb=_files_pb)
1625
def revision_graph_can_have_wrong_parents(self):
1626
# The answer depends on the remote repo format.
1628
return self._real_repository.revision_graph_can_have_wrong_parents()
1630
def _find_inconsistent_revision_parents(self, revisions_iterator=None):
1632
return self._real_repository._find_inconsistent_revision_parents(
1635
def _check_for_inconsistent_revision_parents(self):
1637
return self._real_repository._check_for_inconsistent_revision_parents()
1639
def _make_parents_provider(self, other=None):
1640
providers = [self._unstacked_provider]
1641
if other is not None:
1642
providers.insert(0, other)
1643
providers.extend(r._make_parents_provider() for r in
1644
self._fallback_repositories)
1645
return graph.StackedParentsProvider(providers)
1647
def _serialise_search_recipe(self, recipe):
1648
"""Serialise a graph search recipe.
1650
:param recipe: A search recipe (start, stop, count).
1651
:return: Serialised bytes.
1653
start_keys = ' '.join(recipe[1])
1654
stop_keys = ' '.join(recipe[2])
1655
count = str(recipe[3])
1656
return '\n'.join((start_keys, stop_keys, count))
1658
def _serialise_search_result(self, search_result):
1659
if isinstance(search_result, graph.PendingAncestryResult):
1660
parts = ['ancestry-of']
1661
parts.extend(search_result.heads)
1663
recipe = search_result.get_recipe()
1664
parts = [recipe[0], self._serialise_search_recipe(recipe)]
1665
return '\n'.join(parts)
1668
path = self.bzrdir._path_for_remote_call(self._client)
1670
response = self._call('PackRepository.autopack', path)
1671
except errors.UnknownSmartMethod:
1673
self._real_repository._pack_collection.autopack()
1676
if response[0] != 'ok':
1677
raise errors.UnexpectedSmartServerResponse(response)
1680
class RemoteStreamSink(repository.StreamSink):
1682
def _insert_real(self, stream, src_format, resume_tokens):
1683
self.target_repo._ensure_real()
1684
sink = self.target_repo._real_repository._get_sink()
1685
result = sink.insert_stream(stream, src_format, resume_tokens)
1687
self.target_repo.autopack()
1690
def insert_stream(self, stream, src_format, resume_tokens):
1691
target = self.target_repo
1692
target._unstacked_provider.missing_keys.clear()
1693
candidate_calls = [('Repository.insert_stream_1.18', (1, 18))]
1694
if target._lock_token:
1695
candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
1696
lock_args = (target._lock_token or '',)
1698
candidate_calls.append(('Repository.insert_stream', (1, 13)))
1700
client = target._client
1701
medium = client._medium
1702
path = target.bzrdir._path_for_remote_call(client)
1703
# Probe for the verb to use with an empty stream before sending the
1704
# real stream to it. We do this both to avoid the risk of sending a
1705
# large request that is then rejected, and because we don't want to
1706
# implement a way to buffer, rewind, or restart the stream.
1708
for verb, required_version in candidate_calls:
1709
if medium._is_remote_before(required_version):
1712
# We've already done the probing (and set _is_remote_before) on
1713
# a previous insert.
1716
byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1718
response = client.call_with_body_stream(
1719
(verb, path, '') + lock_args, byte_stream)
1720
except errors.UnknownSmartMethod:
1721
medium._remember_remote_is_before(required_version)
1727
return self._insert_real(stream, src_format, resume_tokens)
1728
self._last_inv_record = None
1729
self._last_substream = None
1730
if required_version < (1, 18):
1731
# Remote side doesn't support inventory deltas. Wrap the stream to
1732
# make sure we don't send any. If the stream contains inventory
1733
# deltas we'll interrupt the smart insert_stream request and
1735
stream = self._stop_stream_if_inventory_delta(stream)
1736
byte_stream = smart_repo._stream_to_byte_stream(
1738
resume_tokens = ' '.join(resume_tokens)
1739
response = client.call_with_body_stream(
1740
(verb, path, resume_tokens) + lock_args, byte_stream)
1741
if response[0][0] not in ('ok', 'missing-basis'):
1742
raise errors.UnexpectedSmartServerResponse(response)
1743
if self._last_substream is not None:
1744
# The stream included an inventory-delta record, but the remote
1745
# side isn't new enough to support them. So we need to send the
1746
# rest of the stream via VFS.
1747
return self._resume_stream_with_vfs(response, src_format)
1748
if response[0][0] == 'missing-basis':
1749
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1750
resume_tokens = tokens
1751
return resume_tokens, set(missing_keys)
1753
self.target_repo.refresh_data()
1756
def _resume_stream_with_vfs(self, response, src_format):
1757
"""Resume sending a stream via VFS, first resending the record and
1758
substream that couldn't be sent via an insert_stream verb.
1760
if response[0][0] == 'missing-basis':
1761
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1762
# Ignore missing_keys, we haven't finished inserting yet
1765
def resume_substream():
1766
# Yield the substream that was interrupted.
1767
for record in self._last_substream:
1769
self._last_substream = None
1770
def resume_stream():
1771
# Finish sending the interrupted substream
1772
yield ('inventory-deltas', resume_substream())
1773
# Then simply continue sending the rest of the stream.
1774
for substream_kind, substream in self._last_stream:
1775
yield substream_kind, substream
1776
return self._insert_real(resume_stream(), src_format, tokens)
1778
def _stop_stream_if_inventory_delta(self, stream):
1779
"""Normally this just lets the original stream pass-through unchanged.
1781
However if any 'inventory-deltas' substream occurs it will stop
1782
streaming, and store the interrupted substream and stream in
1783
self._last_substream and self._last_stream so that the stream can be
1784
resumed by _resume_stream_with_vfs.
1787
stream_iter = iter(stream)
1788
for substream_kind, substream in stream_iter:
1789
if substream_kind == 'inventory-deltas':
1790
self._last_substream = substream
1791
self._last_stream = stream_iter
1794
yield substream_kind, substream
1797
class RemoteStreamSource(repository.StreamSource):
1798
"""Stream data from a remote server."""
1800
def get_stream(self, search):
1801
if (self.from_repository._fallback_repositories and
1802
self.to_format._fetch_order == 'topological'):
1803
return self._real_stream(self.from_repository, search)
1806
repos = [self.from_repository]
1812
repos.extend(repo._fallback_repositories)
1813
sources.append(repo)
1814
return self.missing_parents_chain(search, sources)
1816
def get_stream_for_missing_keys(self, missing_keys):
1817
self.from_repository._ensure_real()
1818
real_repo = self.from_repository._real_repository
1819
real_source = real_repo._get_source(self.to_format)
1820
return real_source.get_stream_for_missing_keys(missing_keys)
1822
def _real_stream(self, repo, search):
1823
"""Get a stream for search from repo.
1825
This never called RemoteStreamSource.get_stream, and is a heler
1826
for RemoteStreamSource._get_stream to allow getting a stream
1827
reliably whether fallback back because of old servers or trying
1828
to stream from a non-RemoteRepository (which the stacked support
1831
source = repo._get_source(self.to_format)
1832
if isinstance(source, RemoteStreamSource):
1833
return repository.StreamSource.get_stream(source, search)
1834
return source.get_stream(search)
1836
def _get_stream(self, repo, search):
1837
"""Core worker to get a stream from repo for search.
1839
This is used by both get_stream and the stacking support logic. It
1840
deliberately gets a stream for repo which does not need to be
1841
self.from_repository. In the event that repo is not Remote, or
1842
cannot do a smart stream, a fallback is made to the generic
1843
repository._get_stream() interface, via self._real_stream.
1845
In the event of stacking, streams from _get_stream will not
1846
contain all the data for search - this is normal (see get_stream).
1848
:param repo: A repository.
1849
:param search: A search.
1851
# Fallbacks may be non-smart
1852
if not isinstance(repo, RemoteRepository):
1853
return self._real_stream(repo, search)
1854
client = repo._client
1855
medium = client._medium
1856
path = repo.bzrdir._path_for_remote_call(client)
1857
search_bytes = repo._serialise_search_result(search)
1858
args = (path, self.to_format.network_name())
1860
('Repository.get_stream_1.18', (1, 18)),
1861
('Repository.get_stream', (1, 13))]
1863
for verb, version in candidate_verbs:
1864
if medium._is_remote_before(version):
1867
response = repo._call_with_body_bytes_expecting_body(
1868
verb, args, search_bytes)
1869
except errors.UnknownSmartMethod:
1870
medium._remember_remote_is_before(version)
1872
response_tuple, response_handler = response
1876
return self._real_stream(repo, search)
1877
if response_tuple[0] != 'ok':
1878
raise errors.UnexpectedSmartServerResponse(response_tuple)
1879
byte_stream = response_handler.read_streamed_body()
1880
src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
1881
if src_format.network_name() != repo._format.network_name():
1882
raise AssertionError(
1883
"Mismatched RemoteRepository and stream src %r, %r" % (
1884
src_format.network_name(), repo._format.network_name()))
1887
def missing_parents_chain(self, search, sources):
1888
"""Chain multiple streams together to handle stacking.
1890
:param search: The overall search to satisfy with streams.
1891
:param sources: A list of Repository objects to query.
1893
self.serialiser = self.to_format._serializer
1894
self.seen_revs = set()
1895
self.referenced_revs = set()
1896
# If there are heads in the search, or the key count is > 0, we are not
1898
while not search.is_empty() and len(sources) > 1:
1899
source = sources.pop(0)
1900
stream = self._get_stream(source, search)
1901
for kind, substream in stream:
1902
if kind != 'revisions':
1903
yield kind, substream
1905
yield kind, self.missing_parents_rev_handler(substream)
1906
search = search.refine(self.seen_revs, self.referenced_revs)
1907
self.seen_revs = set()
1908
self.referenced_revs = set()
1909
if not search.is_empty():
1910
for kind, stream in self._get_stream(sources[0], search):
1913
def missing_parents_rev_handler(self, substream):
1914
for content in substream:
1915
revision_bytes = content.get_bytes_as('fulltext')
1916
revision = self.serialiser.read_revision_from_string(revision_bytes)
1917
self.seen_revs.add(content.key[-1])
1918
self.referenced_revs.update(revision.parent_ids)
1922
class RemoteBranchLockableFiles(LockableFiles):
1923
"""A 'LockableFiles' implementation that talks to a smart server.
1925
This is not a public interface class.
1928
def __init__(self, bzrdir, _client):
1929
self.bzrdir = bzrdir
1930
self._client = _client
1931
self._need_find_modes = True
1932
LockableFiles.__init__(
1933
self, bzrdir.get_branch_transport(None),
1934
'lock', lockdir.LockDir)
1936
def _find_modes(self):
1937
# RemoteBranches don't let the client set the mode of control files.
1938
self._dir_mode = None
1939
self._file_mode = None
1942
class RemoteBranchFormat(branch.BranchFormat):
1944
def __init__(self, network_name=None):
1945
super(RemoteBranchFormat, self).__init__()
1946
self._matchingbzrdir = RemoteBzrDirFormat()
1947
self._matchingbzrdir.set_branch_format(self)
1948
self._custom_format = None
1949
self._network_name = network_name
1951
def __eq__(self, other):
1952
return (isinstance(other, RemoteBranchFormat) and
1953
self.__dict__ == other.__dict__)
1955
def _ensure_real(self):
1956
if self._custom_format is None:
1957
self._custom_format = branch.network_format_registry.get(
1960
def get_format_description(self):
1961
return 'Remote BZR Branch'
1963
def network_name(self):
1964
return self._network_name
1966
def open(self, a_bzrdir, ignore_fallbacks=False):
1967
return a_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1969
def _vfs_initialize(self, a_bzrdir):
1970
# Initialisation when using a local bzrdir object, or a non-vfs init
1971
# method is not available on the server.
1972
# self._custom_format is always set - the start of initialize ensures
1974
if isinstance(a_bzrdir, RemoteBzrDir):
1975
a_bzrdir._ensure_real()
1976
result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
1978
# We assume the bzrdir is parameterised; it may not be.
1979
result = self._custom_format.initialize(a_bzrdir)
1980
if (isinstance(a_bzrdir, RemoteBzrDir) and
1981
not isinstance(result, RemoteBranch)):
1982
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
1985
def initialize(self, a_bzrdir):
1986
# 1) get the network name to use.
1987
if self._custom_format:
1988
network_name = self._custom_format.network_name()
1990
# Select the current bzrlib default and ask for that.
1991
reference_bzrdir_format = bzrdir.format_registry.get('default')()
1992
reference_format = reference_bzrdir_format.get_branch_format()
1993
self._custom_format = reference_format
1994
network_name = reference_format.network_name()
1995
# Being asked to create on a non RemoteBzrDir:
1996
if not isinstance(a_bzrdir, RemoteBzrDir):
1997
return self._vfs_initialize(a_bzrdir)
1998
medium = a_bzrdir._client._medium
1999
if medium._is_remote_before((1, 13)):
2000
return self._vfs_initialize(a_bzrdir)
2001
# Creating on a remote bzr dir.
2002
# 2) try direct creation via RPC
2003
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2004
verb = 'BzrDir.create_branch'
2006
response = a_bzrdir._call(verb, path, network_name)
2007
except errors.UnknownSmartMethod:
2008
# Fallback - use vfs methods
2009
medium._remember_remote_is_before((1, 13))
2010
return self._vfs_initialize(a_bzrdir)
2011
if response[0] != 'ok':
2012
raise errors.UnexpectedSmartServerResponse(response)
2013
# Turn the response into a RemoteRepository object.
2014
format = RemoteBranchFormat(network_name=response[1])
2015
repo_format = response_tuple_to_repo_format(response[3:])
2016
if response[2] == '':
2017
repo_bzrdir = a_bzrdir
2019
repo_bzrdir = RemoteBzrDir(
2020
a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
2022
remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2023
remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2024
format=format, setup_stacking=False)
2025
# XXX: We know this is a new branch, so it must have revno 0, revid
2026
# NULL_REVISION. Creating the branch locked would make this be unable
2027
# to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2028
remote_branch._last_revision_info_cache = 0, NULL_REVISION
2029
return remote_branch
2031
def make_tags(self, branch):
2033
return self._custom_format.make_tags(branch)
2035
def supports_tags(self):
2036
# Remote branches might support tags, but we won't know until we
2037
# access the real remote branch.
2039
return self._custom_format.supports_tags()
2041
def supports_stacking(self):
2043
return self._custom_format.supports_stacking()
2045
def supports_set_append_revisions_only(self):
2047
return self._custom_format.supports_set_append_revisions_only()
2050
class RemoteBranch(branch.Branch, _RpcHelper):
2051
"""Branch stored on a server accessed by HPSS RPC.
2053
At the moment most operations are mapped down to simple file operations.
2056
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2057
_client=None, format=None, setup_stacking=True):
2058
"""Create a RemoteBranch instance.
2060
:param real_branch: An optional local implementation of the branch
2061
format, usually accessing the data via the VFS.
2062
:param _client: Private parameter for testing.
2063
:param format: A RemoteBranchFormat object, None to create one
2064
automatically. If supplied it should have a network_name already
2066
:param setup_stacking: If True make an RPC call to determine the
2067
stacked (or not) status of the branch. If False assume the branch
2070
# We intentionally don't call the parent class's __init__, because it
2071
# will try to assign to self.tags, which is a property in this subclass.
2072
# And the parent's __init__ doesn't do much anyway.
2073
self.bzrdir = remote_bzrdir
2074
if _client is not None:
2075
self._client = _client
2077
self._client = remote_bzrdir._client
2078
self.repository = remote_repository
2079
if real_branch is not None:
2080
self._real_branch = real_branch
2081
# Give the remote repository the matching real repo.
2082
real_repo = self._real_branch.repository
2083
if isinstance(real_repo, RemoteRepository):
2084
real_repo._ensure_real()
2085
real_repo = real_repo._real_repository
2086
self.repository._set_real_repository(real_repo)
2087
# Give the branch the remote repository to let fast-pathing happen.
2088
self._real_branch.repository = self.repository
2090
self._real_branch = None
2091
# Fill out expected attributes of branch for bzrlib API users.
2092
self._clear_cached_state()
2093
self.base = self.bzrdir.root_transport.base
2094
self._control_files = None
2095
self._lock_mode = None
2096
self._lock_token = None
2097
self._repo_lock_token = None
2098
self._lock_count = 0
2099
self._leave_lock = False
2100
# Setup a format: note that we cannot call _ensure_real until all the
2101
# attributes above are set: This code cannot be moved higher up in this
2104
self._format = RemoteBranchFormat()
2105
if real_branch is not None:
2106
self._format._network_name = \
2107
self._real_branch._format.network_name()
2109
self._format = format
2110
if not self._format._network_name:
2111
# Did not get from open_branchV2 - old server.
2113
self._format._network_name = \
2114
self._real_branch._format.network_name()
2115
self.tags = self._format.make_tags(self)
2116
# The base class init is not called, so we duplicate this:
2117
hooks = branch.Branch.hooks['open']
2120
self._is_stacked = False
2122
self._setup_stacking()
2124
def _setup_stacking(self):
2125
# configure stacking into the remote repository, by reading it from
2128
fallback_url = self.get_stacked_on_url()
2129
except (errors.NotStacked, errors.UnstackableBranchFormat,
2130
errors.UnstackableRepositoryFormat), e:
2132
self._is_stacked = True
2133
self._activate_fallback_location(fallback_url)
2135
def _get_config(self):
2136
return RemoteBranchConfig(self)
2138
def _get_real_transport(self):
2139
# if we try vfs access, return the real branch's vfs transport
2141
return self._real_branch._transport
2143
_transport = property(_get_real_transport)
2146
return "%s(%s)" % (self.__class__.__name__, self.base)
2150
def _ensure_real(self):
2151
"""Ensure that there is a _real_branch set.
2153
Used before calls to self._real_branch.
2155
if self._real_branch is None:
2156
if not vfs.vfs_enabled():
2157
raise AssertionError('smart server vfs must be enabled '
2158
'to use vfs implementation')
2159
self.bzrdir._ensure_real()
2160
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
2161
if self.repository._real_repository is None:
2162
# Give the remote repository the matching real repo.
2163
real_repo = self._real_branch.repository
2164
if isinstance(real_repo, RemoteRepository):
2165
real_repo._ensure_real()
2166
real_repo = real_repo._real_repository
2167
self.repository._set_real_repository(real_repo)
2168
# Give the real branch the remote repository to let fast-pathing
2170
self._real_branch.repository = self.repository
2171
if self._lock_mode == 'r':
2172
self._real_branch.lock_read()
2173
elif self._lock_mode == 'w':
2174
self._real_branch.lock_write(token=self._lock_token)
2176
def _translate_error(self, err, **context):
2177
self.repository._translate_error(err, branch=self, **context)
2179
def _clear_cached_state(self):
2180
super(RemoteBranch, self)._clear_cached_state()
2181
if self._real_branch is not None:
2182
self._real_branch._clear_cached_state()
2184
def _clear_cached_state_of_remote_branch_only(self):
2185
"""Like _clear_cached_state, but doesn't clear the cache of
2188
This is useful when falling back to calling a method of
2189
self._real_branch that changes state. In that case the underlying
2190
branch changes, so we need to invalidate this RemoteBranch's cache of
2191
it. However, there's no need to invalidate the _real_branch's cache
2192
too, in fact doing so might harm performance.
2194
super(RemoteBranch, self)._clear_cached_state()
2197
def control_files(self):
2198
# Defer actually creating RemoteBranchLockableFiles until its needed,
2199
# because it triggers an _ensure_real that we otherwise might not need.
2200
if self._control_files is None:
2201
self._control_files = RemoteBranchLockableFiles(
2202
self.bzrdir, self._client)
2203
return self._control_files
2205
def _get_checkout_format(self):
2207
return self._real_branch._get_checkout_format()
2209
def get_physical_lock_status(self):
2210
"""See Branch.get_physical_lock_status()."""
2211
# should be an API call to the server, as branches must be lockable.
2213
return self._real_branch.get_physical_lock_status()
2215
def get_stacked_on_url(self):
2216
"""Get the URL this branch is stacked against.
2218
:raises NotStacked: If the branch is not stacked.
2219
:raises UnstackableBranchFormat: If the branch does not support
2221
:raises UnstackableRepositoryFormat: If the repository does not support
2225
# there may not be a repository yet, so we can't use
2226
# self._translate_error, so we can't use self._call either.
2227
response = self._client.call('Branch.get_stacked_on_url',
2228
self._remote_path())
2229
except errors.ErrorFromSmartServer, err:
2230
# there may not be a repository yet, so we can't call through
2231
# its _translate_error
2232
_translate_error(err, branch=self)
2233
except errors.UnknownSmartMethod, err:
2235
return self._real_branch.get_stacked_on_url()
2236
if response[0] != 'ok':
2237
raise errors.UnexpectedSmartServerResponse(response)
2240
def set_stacked_on_url(self, url):
2241
branch.Branch.set_stacked_on_url(self, url)
2243
self._is_stacked = False
2245
self._is_stacked = True
2247
def _vfs_get_tags_bytes(self):
2249
return self._real_branch._get_tags_bytes()
2251
def _get_tags_bytes(self):
2252
medium = self._client._medium
2253
if medium._is_remote_before((1, 13)):
2254
return self._vfs_get_tags_bytes()
2256
response = self._call('Branch.get_tags_bytes', self._remote_path())
2257
except errors.UnknownSmartMethod:
2258
medium._remember_remote_is_before((1, 13))
2259
return self._vfs_get_tags_bytes()
2262
def _vfs_set_tags_bytes(self, bytes):
2264
return self._real_branch._set_tags_bytes(bytes)
2266
def _set_tags_bytes(self, bytes):
2267
medium = self._client._medium
2268
if medium._is_remote_before((1, 18)):
2269
self._vfs_set_tags_bytes(bytes)
2272
self._remote_path(), self._lock_token, self._repo_lock_token)
2273
response = self._call_with_body_bytes(
2274
'Branch.set_tags_bytes', args, bytes)
2275
except errors.UnknownSmartMethod:
2276
medium._remember_remote_is_before((1, 18))
2277
self._vfs_set_tags_bytes(bytes)
2279
def lock_read(self):
2280
self.repository.lock_read()
2281
if not self._lock_mode:
2282
self._lock_mode = 'r'
2283
self._lock_count = 1
2284
if self._real_branch is not None:
2285
self._real_branch.lock_read()
2287
self._lock_count += 1
2289
def _remote_lock_write(self, token):
2291
branch_token = repo_token = ''
2293
branch_token = token
2294
repo_token = self.repository.lock_write()
2295
self.repository.unlock()
2296
err_context = {'token': token}
2297
response = self._call(
2298
'Branch.lock_write', self._remote_path(), branch_token,
2299
repo_token or '', **err_context)
2300
if response[0] != 'ok':
2301
raise errors.UnexpectedSmartServerResponse(response)
2302
ok, branch_token, repo_token = response
2303
return branch_token, repo_token
2305
def lock_write(self, token=None):
2306
if not self._lock_mode:
2307
# Lock the branch and repo in one remote call.
2308
remote_tokens = self._remote_lock_write(token)
2309
self._lock_token, self._repo_lock_token = remote_tokens
2310
if not self._lock_token:
2311
raise SmartProtocolError('Remote server did not return a token!')
2312
# Tell the self.repository object that it is locked.
2313
self.repository.lock_write(
2314
self._repo_lock_token, _skip_rpc=True)
2316
if self._real_branch is not None:
2317
self._real_branch.lock_write(token=self._lock_token)
2318
if token is not None:
2319
self._leave_lock = True
2321
self._leave_lock = False
2322
self._lock_mode = 'w'
2323
self._lock_count = 1
2324
elif self._lock_mode == 'r':
2325
raise errors.ReadOnlyTransaction
2327
if token is not None:
2328
# A token was given to lock_write, and we're relocking, so
2329
# check that the given token actually matches the one we
2331
if token != self._lock_token:
2332
raise errors.TokenMismatch(token, self._lock_token)
2333
self._lock_count += 1
2334
# Re-lock the repository too.
2335
self.repository.lock_write(self._repo_lock_token)
2336
return self._lock_token or None
2338
def _unlock(self, branch_token, repo_token):
2339
err_context = {'token': str((branch_token, repo_token))}
2340
response = self._call(
2341
'Branch.unlock', self._remote_path(), branch_token,
2342
repo_token or '', **err_context)
2343
if response == ('ok',):
2345
raise errors.UnexpectedSmartServerResponse(response)
2349
self._lock_count -= 1
2350
if not self._lock_count:
2351
self._clear_cached_state()
2352
mode = self._lock_mode
2353
self._lock_mode = None
2354
if self._real_branch is not None:
2355
if (not self._leave_lock and mode == 'w' and
2356
self._repo_lock_token):
2357
# If this RemoteBranch will remove the physical lock
2358
# for the repository, make sure the _real_branch
2359
# doesn't do it first. (Because the _real_branch's
2360
# repository is set to be the RemoteRepository.)
2361
self._real_branch.repository.leave_lock_in_place()
2362
self._real_branch.unlock()
2364
# Only write-locked branched need to make a remote method
2365
# call to perform the unlock.
2367
if not self._lock_token:
2368
raise AssertionError('Locked, but no token!')
2369
branch_token = self._lock_token
2370
repo_token = self._repo_lock_token
2371
self._lock_token = None
2372
self._repo_lock_token = None
2373
if not self._leave_lock:
2374
self._unlock(branch_token, repo_token)
2376
self.repository.unlock()
2378
def break_lock(self):
2380
return self._real_branch.break_lock()
2382
def leave_lock_in_place(self):
2383
if not self._lock_token:
2384
raise NotImplementedError(self.leave_lock_in_place)
2385
self._leave_lock = True
2387
def dont_leave_lock_in_place(self):
2388
if not self._lock_token:
2389
raise NotImplementedError(self.dont_leave_lock_in_place)
2390
self._leave_lock = False
2392
def get_rev_id(self, revno, history=None):
2394
return _mod_revision.NULL_REVISION
2395
last_revision_info = self.last_revision_info()
2396
ok, result = self.repository.get_rev_id_for_revno(
2397
revno, last_revision_info)
2400
missing_parent = result[1]
2401
# Either the revision named by the server is missing, or its parent
2402
# is. Call get_parent_map to determine which, so that we report a
2404
parent_map = self.repository.get_parent_map([missing_parent])
2405
if missing_parent in parent_map:
2406
missing_parent = parent_map[missing_parent]
2407
raise errors.RevisionNotPresent(missing_parent, self.repository)
2409
def _last_revision_info(self):
2410
response = self._call('Branch.last_revision_info', self._remote_path())
2411
if response[0] != 'ok':
2412
raise SmartProtocolError('unexpected response code %s' % (response,))
2413
revno = int(response[1])
2414
last_revision = response[2]
2415
return (revno, last_revision)
2417
def _gen_revision_history(self):
2418
"""See Branch._gen_revision_history()."""
2419
if self._is_stacked:
2421
return self._real_branch._gen_revision_history()
2422
response_tuple, response_handler = self._call_expecting_body(
2423
'Branch.revision_history', self._remote_path())
2424
if response_tuple[0] != 'ok':
2425
raise errors.UnexpectedSmartServerResponse(response_tuple)
2426
result = response_handler.read_body_bytes().split('\x00')
2431
def _remote_path(self):
2432
return self.bzrdir._path_for_remote_call(self._client)
2434
def _set_last_revision_descendant(self, revision_id, other_branch,
2435
allow_diverged=False, allow_overwrite_descendant=False):
2436
# This performs additional work to meet the hook contract; while its
2437
# undesirable, we have to synthesise the revno to call the hook, and
2438
# not calling the hook is worse as it means changes can't be prevented.
2439
# Having calculated this though, we can't just call into
2440
# set_last_revision_info as a simple call, because there is a set_rh
2441
# hook that some folk may still be using.
2442
old_revno, old_revid = self.last_revision_info()
2443
history = self._lefthand_history(revision_id)
2444
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2445
err_context = {'other_branch': other_branch}
2446
response = self._call('Branch.set_last_revision_ex',
2447
self._remote_path(), self._lock_token, self._repo_lock_token,
2448
revision_id, int(allow_diverged), int(allow_overwrite_descendant),
2450
self._clear_cached_state()
2451
if len(response) != 3 and response[0] != 'ok':
2452
raise errors.UnexpectedSmartServerResponse(response)
2453
new_revno, new_revision_id = response[1:]
2454
self._last_revision_info_cache = new_revno, new_revision_id
2455
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2456
if self._real_branch is not None:
2457
cache = new_revno, new_revision_id
2458
self._real_branch._last_revision_info_cache = cache
2460
def _set_last_revision(self, revision_id):
2461
old_revno, old_revid = self.last_revision_info()
2462
# This performs additional work to meet the hook contract; while its
2463
# undesirable, we have to synthesise the revno to call the hook, and
2464
# not calling the hook is worse as it means changes can't be prevented.
2465
# Having calculated this though, we can't just call into
2466
# set_last_revision_info as a simple call, because there is a set_rh
2467
# hook that some folk may still be using.
2468
history = self._lefthand_history(revision_id)
2469
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2470
self._clear_cached_state()
2471
response = self._call('Branch.set_last_revision',
2472
self._remote_path(), self._lock_token, self._repo_lock_token,
2474
if response != ('ok',):
2475
raise errors.UnexpectedSmartServerResponse(response)
2476
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2479
def set_revision_history(self, rev_history):
2480
# Send just the tip revision of the history; the server will generate
2481
# the full history from that. If the revision doesn't exist in this
2482
# branch, NoSuchRevision will be raised.
2483
if rev_history == []:
2486
rev_id = rev_history[-1]
2487
self._set_last_revision(rev_id)
2488
for hook in branch.Branch.hooks['set_rh']:
2489
hook(self, rev_history)
2490
self._cache_revision_history(rev_history)
2492
def _get_parent_location(self):
2493
medium = self._client._medium
2494
if medium._is_remote_before((1, 13)):
2495
return self._vfs_get_parent_location()
2497
response = self._call('Branch.get_parent', self._remote_path())
2498
except errors.UnknownSmartMethod:
2499
medium._remember_remote_is_before((1, 13))
2500
return self._vfs_get_parent_location()
2501
if len(response) != 1:
2502
raise errors.UnexpectedSmartServerResponse(response)
2503
parent_location = response[0]
2504
if parent_location == '':
2506
return parent_location
2508
def _vfs_get_parent_location(self):
2510
return self._real_branch._get_parent_location()
2512
def _set_parent_location(self, url):
2513
medium = self._client._medium
2514
if medium._is_remote_before((1, 15)):
2515
return self._vfs_set_parent_location(url)
2517
call_url = url or ''
2518
if type(call_url) is not str:
2519
raise AssertionError('url must be a str or None (%s)' % url)
2520
response = self._call('Branch.set_parent_location',
2521
self._remote_path(), self._lock_token, self._repo_lock_token,
2523
except errors.UnknownSmartMethod:
2524
medium._remember_remote_is_before((1, 15))
2525
return self._vfs_set_parent_location(url)
2527
raise errors.UnexpectedSmartServerResponse(response)
2529
def _vfs_set_parent_location(self, url):
2531
return self._real_branch._set_parent_location(url)
2534
def pull(self, source, overwrite=False, stop_revision=None,
2536
self._clear_cached_state_of_remote_branch_only()
2538
return self._real_branch.pull(
2539
source, overwrite=overwrite, stop_revision=stop_revision,
2540
_override_hook_target=self, **kwargs)
2543
def push(self, target, overwrite=False, stop_revision=None):
2545
return self._real_branch.push(
2546
target, overwrite=overwrite, stop_revision=stop_revision,
2547
_override_hook_source_branch=self)
2549
def is_locked(self):
2550
return self._lock_count >= 1
2553
def revision_id_to_revno(self, revision_id):
2555
return self._real_branch.revision_id_to_revno(revision_id)
2558
def set_last_revision_info(self, revno, revision_id):
2559
# XXX: These should be returned by the set_last_revision_info verb
2560
old_revno, old_revid = self.last_revision_info()
2561
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2562
revision_id = ensure_null(revision_id)
2564
response = self._call('Branch.set_last_revision_info',
2565
self._remote_path(), self._lock_token, self._repo_lock_token,
2566
str(revno), revision_id)
2567
except errors.UnknownSmartMethod:
2569
self._clear_cached_state_of_remote_branch_only()
2570
self._real_branch.set_last_revision_info(revno, revision_id)
2571
self._last_revision_info_cache = revno, revision_id
2573
if response == ('ok',):
2574
self._clear_cached_state()
2575
self._last_revision_info_cache = revno, revision_id
2576
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2577
# Update the _real_branch's cache too.
2578
if self._real_branch is not None:
2579
cache = self._last_revision_info_cache
2580
self._real_branch._last_revision_info_cache = cache
2582
raise errors.UnexpectedSmartServerResponse(response)
2585
def generate_revision_history(self, revision_id, last_rev=None,
2587
medium = self._client._medium
2588
if not medium._is_remote_before((1, 6)):
2589
# Use a smart method for 1.6 and above servers
2591
self._set_last_revision_descendant(revision_id, other_branch,
2592
allow_diverged=True, allow_overwrite_descendant=True)
2594
except errors.UnknownSmartMethod:
2595
medium._remember_remote_is_before((1, 6))
2596
self._clear_cached_state_of_remote_branch_only()
2597
self.set_revision_history(self._lefthand_history(revision_id,
2598
last_rev=last_rev,other_branch=other_branch))
2600
def set_push_location(self, location):
2602
return self._real_branch.set_push_location(location)
2605
class RemoteConfig(object):
2606
"""A Config that reads and writes from smart verbs.
2608
It is a low-level object that considers config data to be name/value pairs
2609
that may be associated with a section. Assigning meaning to the these
2610
values is done at higher levels like bzrlib.config.TreeConfig.
2613
def get_option(self, name, section=None, default=None):
2614
"""Return the value associated with a named option.
2616
:param name: The name of the value
2617
:param section: The section the option is in (if any)
2618
:param default: The value to return if the value is not set
2619
:return: The value or default value
2622
configobj = self._get_configobj()
2624
section_obj = configobj
2627
section_obj = configobj[section]
2630
return section_obj.get(name, default)
2631
except errors.UnknownSmartMethod:
2632
return self._vfs_get_option(name, section, default)
2634
def _response_to_configobj(self, response):
2635
if len(response[0]) and response[0][0] != 'ok':
2636
raise errors.UnexpectedSmartServerResponse(response)
2637
lines = response[1].read_body_bytes().splitlines()
2638
return config.ConfigObj(lines, encoding='utf-8')
2641
class RemoteBranchConfig(RemoteConfig):
2642
"""A RemoteConfig for Branches."""
2644
def __init__(self, branch):
2645
self._branch = branch
2647
def _get_configobj(self):
2648
path = self._branch._remote_path()
2649
response = self._branch._client.call_expecting_body(
2650
'Branch.get_config_file', path)
2651
return self._response_to_configobj(response)
2653
def set_option(self, value, name, section=None):
2654
"""Set the value associated with a named option.
2656
:param value: The value to set
2657
:param name: The name of the value to set
2658
:param section: The section the option is in (if any)
2660
medium = self._branch._client._medium
2661
if medium._is_remote_before((1, 14)):
2662
return self._vfs_set_option(value, name, section)
2664
path = self._branch._remote_path()
2665
response = self._branch._client.call('Branch.set_config_option',
2666
path, self._branch._lock_token, self._branch._repo_lock_token,
2667
value.encode('utf8'), name, section or '')
2668
except errors.UnknownSmartMethod:
2669
medium._remember_remote_is_before((1, 14))
2670
return self._vfs_set_option(value, name, section)
2672
raise errors.UnexpectedSmartServerResponse(response)
2674
def _real_object(self):
2675
self._branch._ensure_real()
2676
return self._branch._real_branch
2678
def _vfs_set_option(self, value, name, section=None):
2679
return self._real_object()._get_config().set_option(
2680
value, name, section)
2683
class RemoteBzrDirConfig(RemoteConfig):
2684
"""A RemoteConfig for BzrDirs."""
2686
def __init__(self, bzrdir):
2687
self._bzrdir = bzrdir
2689
def _get_configobj(self):
2690
medium = self._bzrdir._client._medium
2691
verb = 'BzrDir.get_config_file'
2692
if medium._is_remote_before((1, 15)):
2693
raise errors.UnknownSmartMethod(verb)
2694
path = self._bzrdir._path_for_remote_call(self._bzrdir._client)
2695
response = self._bzrdir._call_expecting_body(
2697
return self._response_to_configobj(response)
2699
def _vfs_get_option(self, name, section, default):
2700
return self._real_object()._get_config().get_option(
2701
name, section, default)
2703
def set_option(self, value, name, section=None):
2704
"""Set the value associated with a named option.
2706
:param value: The value to set
2707
:param name: The name of the value to set
2708
:param section: The section the option is in (if any)
2710
return self._real_object()._get_config().set_option(
2711
value, name, section)
2713
def _real_object(self):
2714
self._bzrdir._ensure_real()
2715
return self._bzrdir._real_bzrdir
2719
def _extract_tar(tar, to_dir):
2720
"""Extract all the contents of a tarfile object.
2722
A replacement for extractall, which is not present in python2.4
2725
tar.extract(tarinfo, to_dir)
2728
def _translate_error(err, **context):
2729
"""Translate an ErrorFromSmartServer into a more useful error.
2731
Possible context keys:
2739
If the error from the server doesn't match a known pattern, then
2740
UnknownErrorFromSmartServer is raised.
2744
return context[name]
2745
except KeyError, key_err:
2746
mutter('Missing key %r in context %r', key_err.args[0], context)
2749
"""Get the path from the context if present, otherwise use first error
2753
return context['path']
2754
except KeyError, key_err:
2756
return err.error_args[0]
2757
except IndexError, idx_err:
2759
'Missing key %r in context %r', key_err.args[0], context)
2762
if err.error_verb == 'NoSuchRevision':
2763
raise NoSuchRevision(find('branch'), err.error_args[0])
2764
elif err.error_verb == 'nosuchrevision':
2765
raise NoSuchRevision(find('repository'), err.error_args[0])
2766
elif err.error_tuple == ('nobranch',):
2767
raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2768
elif err.error_verb == 'norepository':
2769
raise errors.NoRepositoryPresent(find('bzrdir'))
2770
elif err.error_verb == 'LockContention':
2771
raise errors.LockContention('(remote lock)')
2772
elif err.error_verb == 'UnlockableTransport':
2773
raise errors.UnlockableTransport(find('bzrdir').root_transport)
2774
elif err.error_verb == 'LockFailed':
2775
raise errors.LockFailed(err.error_args[0], err.error_args[1])
2776
elif err.error_verb == 'TokenMismatch':
2777
raise errors.TokenMismatch(find('token'), '(remote token)')
2778
elif err.error_verb == 'Diverged':
2779
raise errors.DivergedBranches(find('branch'), find('other_branch'))
2780
elif err.error_verb == 'TipChangeRejected':
2781
raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
2782
elif err.error_verb == 'UnstackableBranchFormat':
2783
raise errors.UnstackableBranchFormat(*err.error_args)
2784
elif err.error_verb == 'UnstackableRepositoryFormat':
2785
raise errors.UnstackableRepositoryFormat(*err.error_args)
2786
elif err.error_verb == 'NotStacked':
2787
raise errors.NotStacked(branch=find('branch'))
2788
elif err.error_verb == 'PermissionDenied':
2790
if len(err.error_args) >= 2:
2791
extra = err.error_args[1]
2794
raise errors.PermissionDenied(path, extra=extra)
2795
elif err.error_verb == 'ReadError':
2797
raise errors.ReadError(path)
2798
elif err.error_verb == 'NoSuchFile':
2800
raise errors.NoSuchFile(path)
2801
elif err.error_verb == 'FileExists':
2802
raise errors.FileExists(err.error_args[0])
2803
elif err.error_verb == 'DirectoryNotEmpty':
2804
raise errors.DirectoryNotEmpty(err.error_args[0])
2805
elif err.error_verb == 'ShortReadvError':
2806
args = err.error_args
2807
raise errors.ShortReadvError(
2808
args[0], int(args[1]), int(args[2]), int(args[3]))
2809
elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
2810
encoding = str(err.error_args[0]) # encoding must always be a string
2811
val = err.error_args[1]
2812
start = int(err.error_args[2])
2813
end = int(err.error_args[3])
2814
reason = str(err.error_args[4]) # reason must always be a string
2815
if val.startswith('u:'):
2816
val = val[2:].decode('utf-8')
2817
elif val.startswith('s:'):
2818
val = val[2:].decode('base64')
2819
if err.error_verb == 'UnicodeDecodeError':
2820
raise UnicodeDecodeError(encoding, val, start, end, reason)
2821
elif err.error_verb == 'UnicodeEncodeError':
2822
raise UnicodeEncodeError(encoding, val, start, end, reason)
2823
elif err.error_verb == 'ReadOnlyError':
2824
raise errors.TransportNotPossible('readonly transport')
2825
raise errors.UnknownErrorFromSmartServer(err)
added
removed
bzrlib/remote.py
