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
def repository_class(self):
593
return self._custom_format.repository_class
596
class RemoteRepository(_RpcHelper):
597
"""Repository accessed over rpc.
599
For the moment most operations are performed using local transport-backed
603
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
604
"""Create a RemoteRepository instance.
606
:param remote_bzrdir: The bzrdir hosting this repository.
607
:param format: The RemoteFormat object to use.
608
:param real_repository: If not None, a local implementation of the
609
repository logic for the repository, usually accessing the data
611
:param _client: Private testing parameter - override the smart client
612
to be used by the repository.
615
self._real_repository = real_repository
617
self._real_repository = None
618
self.bzrdir = remote_bzrdir
620
self._client = remote_bzrdir._client
622
self._client = _client
623
self._format = format
624
self._lock_mode = None
625
self._lock_token = None
627
self._leave_lock = False
628
# Cache of revision parents; misses are cached during read locks, and
629
# write locks when no _real_repository has been set.
630
self._unstacked_provider = graph.CachingParentsProvider(
631
get_parent_map=self._get_parent_map_rpc)
632
self._unstacked_provider.disable_cache()
634
# These depend on the actual remote format, so force them off for
635
# maximum compatibility. XXX: In future these should depend on the
636
# remote repository instance, but this is irrelevant until we perform
637
# reconcile via an RPC call.
638
self._reconcile_does_inventory_gc = False
639
self._reconcile_fixes_text_parents = False
640
self._reconcile_backsup_inventory = False
641
self.base = self.bzrdir.transport.base
642
# Additional places to query for data.
643
self._fallback_repositories = []
646
return "%s(%s)" % (self.__class__.__name__, self.base)
650
def abort_write_group(self, suppress_errors=False):
651
"""Complete a write group on the decorated repository.
653
Smart methods perform operations in a single step so this API
654
is not really applicable except as a compatibility thunk
655
for older plugins that don't use e.g. the CommitBuilder
658
:param suppress_errors: see Repository.abort_write_group.
661
return self._real_repository.abort_write_group(
662
suppress_errors=suppress_errors)
666
"""Decorate the real repository for now.
668
In the long term a full blown network facility is needed to avoid
669
creating a real repository object locally.
672
return self._real_repository.chk_bytes
674
def commit_write_group(self):
675
"""Complete a write group on the decorated repository.
677
Smart methods perform operations in a single step so this API
678
is not really applicable except as a compatibility thunk
679
for older plugins that don't use e.g. the CommitBuilder
683
return self._real_repository.commit_write_group()
685
def resume_write_group(self, tokens):
687
return self._real_repository.resume_write_group(tokens)
689
def suspend_write_group(self):
691
return self._real_repository.suspend_write_group()
693
def get_missing_parent_inventories(self, check_for_missing_texts=True):
695
return self._real_repository.get_missing_parent_inventories(
696
check_for_missing_texts=check_for_missing_texts)
698
def _get_rev_id_for_revno_vfs(self, revno, known_pair):
700
return self._real_repository.get_rev_id_for_revno(
703
def get_rev_id_for_revno(self, revno, known_pair):
704
"""See Repository.get_rev_id_for_revno."""
705
path = self.bzrdir._path_for_remote_call(self._client)
707
if self._client._medium._is_remote_before((1, 17)):
708
return self._get_rev_id_for_revno_vfs(revno, known_pair)
709
response = self._call(
710
'Repository.get_rev_id_for_revno', path, revno, known_pair)
711
except errors.UnknownSmartMethod:
712
self._client._medium._remember_remote_is_before((1, 17))
713
return self._get_rev_id_for_revno_vfs(revno, known_pair)
714
if response[0] == 'ok':
715
return True, response[1]
716
elif response[0] == 'history-incomplete':
717
known_pair = response[1:3]
718
for fallback in self._fallback_repositories:
719
found, result = fallback.get_rev_id_for_revno(revno, known_pair)
724
# Not found in any fallbacks
725
return False, known_pair
727
raise errors.UnexpectedSmartServerResponse(response)
729
def _ensure_real(self):
730
"""Ensure that there is a _real_repository set.
732
Used before calls to self._real_repository.
734
Note that _ensure_real causes many roundtrips to the server which are
735
not desirable, and prevents the use of smart one-roundtrip RPC's to
736
perform complex operations (such as accessing parent data, streaming
737
revisions etc). Adding calls to _ensure_real should only be done when
738
bringing up new functionality, adding fallbacks for smart methods that
739
require a fallback path, and never to replace an existing smart method
740
invocation. If in doubt chat to the bzr network team.
742
if self._real_repository is None:
743
if 'hpssvfs' in debug.debug_flags:
745
warning('VFS Repository access triggered\n%s',
746
''.join(traceback.format_stack()))
747
self._unstacked_provider.missing_keys.clear()
748
self.bzrdir._ensure_real()
749
self._set_real_repository(
750
self.bzrdir._real_bzrdir.open_repository())
752
def _translate_error(self, err, **context):
753
self.bzrdir._translate_error(err, repository=self, **context)
755
def find_text_key_references(self):
756
"""Find the text key references within the repository.
758
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
759
revision_ids. Each altered file-ids has the exact revision_ids that
760
altered it listed explicitly.
761
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
762
to whether they were referred to by the inventory of the
763
revision_id that they contain. The inventory texts from all present
764
revision ids are assessed to generate this report.
767
return self._real_repository.find_text_key_references()
769
def _generate_text_key_index(self):
770
"""Generate a new text key index for the repository.
772
This is an expensive function that will take considerable time to run.
774
:return: A dict mapping (file_id, revision_id) tuples to a list of
775
parents, also (file_id, revision_id) tuples.
778
return self._real_repository._generate_text_key_index()
780
def _get_revision_graph(self, revision_id):
781
"""Private method for using with old (< 1.2) servers to fallback."""
782
if revision_id is None:
784
elif revision.is_null(revision_id):
787
path = self.bzrdir._path_for_remote_call(self._client)
788
response = self._call_expecting_body(
789
'Repository.get_revision_graph', path, revision_id)
790
response_tuple, response_handler = response
791
if response_tuple[0] != 'ok':
792
raise errors.UnexpectedSmartServerResponse(response_tuple)
793
coded = response_handler.read_body_bytes()
795
# no revisions in this repository!
797
lines = coded.split('\n')
800
d = tuple(line.split())
801
revision_graph[d[0]] = d[1:]
803
return revision_graph
806
"""See Repository._get_sink()."""
807
return RemoteStreamSink(self)
809
def _get_source(self, to_format):
810
"""Return a source for streaming from this repository."""
811
return RemoteStreamSource(self, to_format)
814
def has_revision(self, revision_id):
815
"""True if this repository has a copy of the revision."""
816
# Copy of bzrlib.repository.Repository.has_revision
817
return revision_id in self.has_revisions((revision_id,))
820
def has_revisions(self, revision_ids):
821
"""Probe to find out the presence of multiple revisions.
823
:param revision_ids: An iterable of revision_ids.
824
:return: A set of the revision_ids that were present.
826
# Copy of bzrlib.repository.Repository.has_revisions
827
parent_map = self.get_parent_map(revision_ids)
828
result = set(parent_map)
829
if _mod_revision.NULL_REVISION in revision_ids:
830
result.add(_mod_revision.NULL_REVISION)
833
def _has_same_fallbacks(self, other_repo):
834
"""Returns true if the repositories have the same fallbacks."""
835
# XXX: copied from Repository; it should be unified into a base class
836
# <https://bugs.edge.launchpad.net/bzr/+bug/401622>
837
my_fb = self._fallback_repositories
838
other_fb = other_repo._fallback_repositories
839
if len(my_fb) != len(other_fb):
841
for f, g in zip(my_fb, other_fb):
842
if not f.has_same_location(g):
846
def has_same_location(self, other):
847
# TODO: Move to RepositoryBase and unify with the regular Repository
848
# one; unfortunately the tests rely on slightly different behaviour at
849
# present -- mbp 20090710
850
return (self.__class__ is other.__class__ and
851
self.bzrdir.transport.base == other.bzrdir.transport.base)
853
def get_graph(self, other_repository=None):
854
"""Return the graph for this repository format"""
855
parents_provider = self._make_parents_provider(other_repository)
856
return graph.Graph(parents_provider)
858
def gather_stats(self, revid=None, committers=None):
859
"""See Repository.gather_stats()."""
860
path = self.bzrdir._path_for_remote_call(self._client)
861
# revid can be None to indicate no revisions, not just NULL_REVISION
862
if revid is None or revision.is_null(revid):
866
if committers is None or not committers:
867
fmt_committers = 'no'
869
fmt_committers = 'yes'
870
response_tuple, response_handler = self._call_expecting_body(
871
'Repository.gather_stats', path, fmt_revid, fmt_committers)
872
if response_tuple[0] != 'ok':
873
raise errors.UnexpectedSmartServerResponse(response_tuple)
875
body = response_handler.read_body_bytes()
877
for line in body.split('\n'):
880
key, val_text = line.split(':')
881
if key in ('revisions', 'size', 'committers'):
882
result[key] = int(val_text)
883
elif key in ('firstrev', 'latestrev'):
884
values = val_text.split(' ')[1:]
885
result[key] = (float(values[0]), long(values[1]))
889
def find_branches(self, using=False):
890
"""See Repository.find_branches()."""
891
# should be an API call to the server.
893
return self._real_repository.find_branches(using=using)
895
def get_physical_lock_status(self):
896
"""See Repository.get_physical_lock_status()."""
897
# should be an API call to the server.
899
return self._real_repository.get_physical_lock_status()
901
def is_in_write_group(self):
902
"""Return True if there is an open write group.
904
write groups are only applicable locally for the smart server..
906
if self._real_repository:
907
return self._real_repository.is_in_write_group()
910
return self._lock_count >= 1
913
"""See Repository.is_shared()."""
914
path = self.bzrdir._path_for_remote_call(self._client)
915
response = self._call('Repository.is_shared', path)
916
if response[0] not in ('yes', 'no'):
917
raise SmartProtocolError('unexpected response code %s' % (response,))
918
return response[0] == 'yes'
920
def is_write_locked(self):
921
return self._lock_mode == 'w'
924
# wrong eventually - want a local lock cache context
925
if not self._lock_mode:
926
self._lock_mode = 'r'
928
self._unstacked_provider.enable_cache(cache_misses=True)
929
if self._real_repository is not None:
930
self._real_repository.lock_read()
931
for repo in self._fallback_repositories:
934
self._lock_count += 1
936
def _remote_lock_write(self, token):
937
path = self.bzrdir._path_for_remote_call(self._client)
940
err_context = {'token': token}
941
response = self._call('Repository.lock_write', path, token,
943
if response[0] == 'ok':
947
raise errors.UnexpectedSmartServerResponse(response)
949
def lock_write(self, token=None, _skip_rpc=False):
950
if not self._lock_mode:
952
if self._lock_token is not None:
953
if token != self._lock_token:
954
raise errors.TokenMismatch(token, self._lock_token)
955
self._lock_token = token
957
self._lock_token = self._remote_lock_write(token)
958
# if self._lock_token is None, then this is something like packs or
959
# svn where we don't get to lock the repo, or a weave style repository
960
# where we cannot lock it over the wire and attempts to do so will
962
if self._real_repository is not None:
963
self._real_repository.lock_write(token=self._lock_token)
964
if token is not None:
965
self._leave_lock = True
967
self._leave_lock = False
968
self._lock_mode = 'w'
970
cache_misses = self._real_repository is None
971
self._unstacked_provider.enable_cache(cache_misses=cache_misses)
972
for repo in self._fallback_repositories:
973
# Writes don't affect fallback repos
975
elif self._lock_mode == 'r':
976
raise errors.ReadOnlyError(self)
978
self._lock_count += 1
979
return self._lock_token or None
981
def leave_lock_in_place(self):
982
if not self._lock_token:
983
raise NotImplementedError(self.leave_lock_in_place)
984
self._leave_lock = True
986
def dont_leave_lock_in_place(self):
987
if not self._lock_token:
988
raise NotImplementedError(self.dont_leave_lock_in_place)
989
self._leave_lock = False
991
def _set_real_repository(self, repository):
992
"""Set the _real_repository for this repository.
994
:param repository: The repository to fallback to for non-hpss
995
implemented operations.
997
if self._real_repository is not None:
998
# Replacing an already set real repository.
999
# We cannot do this [currently] if the repository is locked -
1000
# synchronised state might be lost.
1001
if self.is_locked():
1002
raise AssertionError('_real_repository is already set')
1003
if isinstance(repository, RemoteRepository):
1004
raise AssertionError()
1005
self._real_repository = repository
1006
# three code paths happen here:
1007
# 1) old servers, RemoteBranch.open() calls _ensure_real before setting
1008
# up stacking. In this case self._fallback_repositories is [], and the
1009
# real repo is already setup. Preserve the real repo and
1010
# RemoteRepository.add_fallback_repository will avoid adding
1012
# 2) new servers, RemoteBranch.open() sets up stacking, and when
1013
# ensure_real is triggered from a branch, the real repository to
1014
# set already has a matching list with separate instances, but
1015
# as they are also RemoteRepositories we don't worry about making the
1016
# lists be identical.
1017
# 3) new servers, RemoteRepository.ensure_real is triggered before
1018
# RemoteBranch.ensure real, in this case we get a repo with no fallbacks
1019
# and need to populate it.
1020
if (self._fallback_repositories and
1021
len(self._real_repository._fallback_repositories) !=
1022
len(self._fallback_repositories)):
1023
if len(self._real_repository._fallback_repositories):
1024
raise AssertionError(
1025
"cannot cleanly remove existing _fallback_repositories")
1026
for fb in self._fallback_repositories:
1027
self._real_repository.add_fallback_repository(fb)
1028
if self._lock_mode == 'w':
1029
# if we are already locked, the real repository must be able to
1030
# acquire the lock with our token.
1031
self._real_repository.lock_write(self._lock_token)
1032
elif self._lock_mode == 'r':
1033
self._real_repository.lock_read()
1035
def start_write_group(self):
1036
"""Start a write group on the decorated repository.
1038
Smart methods perform operations in a single step so this API
1039
is not really applicable except as a compatibility thunk
1040
for older plugins that don't use e.g. the CommitBuilder
1044
return self._real_repository.start_write_group()
1046
def _unlock(self, token):
1047
path = self.bzrdir._path_for_remote_call(self._client)
1049
# with no token the remote repository is not persistently locked.
1051
err_context = {'token': token}
1052
response = self._call('Repository.unlock', path, token,
1054
if response == ('ok',):
1057
raise errors.UnexpectedSmartServerResponse(response)
1060
if not self._lock_count:
1061
return lock.cant_unlock_not_held(self)
1062
self._lock_count -= 1
1063
if self._lock_count > 0:
1065
self._unstacked_provider.disable_cache()
1066
old_mode = self._lock_mode
1067
self._lock_mode = None
1069
# The real repository is responsible at present for raising an
1070
# exception if it's in an unfinished write group. However, it
1071
# normally will *not* actually remove the lock from disk - that's
1072
# done by the server on receiving the Repository.unlock call.
1073
# This is just to let the _real_repository stay up to date.
1074
if self._real_repository is not None:
1075
self._real_repository.unlock()
1077
# The rpc-level lock should be released even if there was a
1078
# problem releasing the vfs-based lock.
1080
# Only write-locked repositories need to make a remote method
1081
# call to perform the unlock.
1082
old_token = self._lock_token
1083
self._lock_token = None
1084
if not self._leave_lock:
1085
self._unlock(old_token)
1086
# Fallbacks are always 'lock_read()' so we don't pay attention to
1088
for repo in self._fallback_repositories:
1091
def break_lock(self):
1092
# should hand off to the network
1094
return self._real_repository.break_lock()
1096
def _get_tarball(self, compression):
1097
"""Return a TemporaryFile containing a repository tarball.
1099
Returns None if the server does not support sending tarballs.
1102
path = self.bzrdir._path_for_remote_call(self._client)
1104
response, protocol = self._call_expecting_body(
1105
'Repository.tarball', path, compression)
1106
except errors.UnknownSmartMethod:
1107
protocol.cancel_read_body()
1109
if response[0] == 'ok':
1110
# Extract the tarball and return it
1111
t = tempfile.NamedTemporaryFile()
1112
# TODO: rpc layer should read directly into it...
1113
t.write(protocol.read_body_bytes())
1116
raise errors.UnexpectedSmartServerResponse(response)
1118
def sprout(self, to_bzrdir, revision_id=None):
1119
# TODO: Option to control what format is created?
1121
dest_repo = self._real_repository._format.initialize(to_bzrdir,
1123
dest_repo.fetch(self, revision_id=revision_id)
1126
### These methods are just thin shims to the VFS object for now.
1128
def revision_tree(self, revision_id):
1130
return self._real_repository.revision_tree(revision_id)
1132
def get_serializer_format(self):
1134
return self._real_repository.get_serializer_format()
1136
def get_commit_builder(self, branch, parents, config, timestamp=None,
1137
timezone=None, committer=None, revprops=None,
1139
# FIXME: It ought to be possible to call this without immediately
1140
# triggering _ensure_real. For now it's the easiest thing to do.
1142
real_repo = self._real_repository
1143
builder = real_repo.get_commit_builder(branch, parents,
1144
config, timestamp=timestamp, timezone=timezone,
1145
committer=committer, revprops=revprops, revision_id=revision_id)
1148
def add_fallback_repository(self, repository):
1149
"""Add a repository to use for looking up data not held locally.
1151
:param repository: A repository.
1153
if not self._format.supports_external_lookups:
1154
raise errors.UnstackableRepositoryFormat(
1155
self._format.network_name(), self.base)
1156
# We need to accumulate additional repositories here, to pass them in
1159
if self.is_locked():
1160
# We will call fallback.unlock() when we transition to the unlocked
1161
# state, so always add a lock here. If a caller passes us a locked
1162
# repository, they are responsible for unlocking it later.
1163
repository.lock_read()
1164
self._fallback_repositories.append(repository)
1165
# If self._real_repository was parameterised already (e.g. because a
1166
# _real_branch had its get_stacked_on_url method called), then the
1167
# repository to be added may already be in the _real_repositories list.
1168
if self._real_repository is not None:
1169
fallback_locations = [repo.bzrdir.root_transport.base for repo in
1170
self._real_repository._fallback_repositories]
1171
if repository.bzrdir.root_transport.base not in fallback_locations:
1172
self._real_repository.add_fallback_repository(repository)
1174
def add_inventory(self, revid, inv, parents):
1176
return self._real_repository.add_inventory(revid, inv, parents)
1178
def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1181
return self._real_repository.add_inventory_by_delta(basis_revision_id,
1182
delta, new_revision_id, parents)
1184
def add_revision(self, rev_id, rev, inv=None, config=None):
1186
return self._real_repository.add_revision(
1187
rev_id, rev, inv=inv, config=config)
1190
def get_inventory(self, revision_id):
1192
return self._real_repository.get_inventory(revision_id)
1194
def iter_inventories(self, revision_ids, ordering='unordered'):
1196
return self._real_repository.iter_inventories(revision_ids, ordering)
1199
def get_revision(self, revision_id):
1201
return self._real_repository.get_revision(revision_id)
1203
def get_transaction(self):
1205
return self._real_repository.get_transaction()
1208
def clone(self, a_bzrdir, revision_id=None):
1210
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
1212
def make_working_trees(self):
1213
"""See Repository.make_working_trees"""
1215
return self._real_repository.make_working_trees()
1217
def refresh_data(self):
1218
"""Re-read any data needed to to synchronise with disk.
1220
This method is intended to be called after another repository instance
1221
(such as one used by a smart server) has inserted data into the
1222
repository. It may not be called during a write group, but may be
1223
called at any other time.
1225
if self.is_in_write_group():
1226
raise errors.InternalBzrError(
1227
"May not refresh_data while in a write group.")
1228
if self._real_repository is not None:
1229
self._real_repository.refresh_data()
1231
def revision_ids_to_search_result(self, result_set):
1232
"""Convert a set of revision ids to a graph SearchResult."""
1233
result_parents = set()
1234
for parents in self.get_graph().get_parent_map(
1235
result_set).itervalues():
1236
result_parents.update(parents)
1237
included_keys = result_set.intersection(result_parents)
1238
start_keys = result_set.difference(included_keys)
1239
exclude_keys = result_parents.difference(result_set)
1240
result = graph.SearchResult(start_keys, exclude_keys,
1241
len(result_set), result_set)
1245
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1246
"""Return the revision ids that other has that this does not.
1248
These are returned in topological order.
1250
revision_id: only return revision ids included by revision_id.
1252
return repository.InterRepository.get(
1253
other, self).search_missing_revision_ids(revision_id, find_ghosts)
1255
def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1257
# No base implementation to use as RemoteRepository is not a subclass
1258
# of Repository; so this is a copy of Repository.fetch().
1259
if fetch_spec is not None and revision_id is not None:
1260
raise AssertionError(
1261
"fetch_spec and revision_id are mutually exclusive.")
1262
if self.is_in_write_group():
1263
raise errors.InternalBzrError(
1264
"May not fetch while in a write group.")
1265
# fast path same-url fetch operations
1266
if (self.has_same_location(source)
1267
and fetch_spec is None
1268
and self._has_same_fallbacks(source)):
1269
# check that last_revision is in 'from' and then return a
1271
if (revision_id is not None and
1272
not revision.is_null(revision_id)):
1273
self.get_revision(revision_id)
1275
# if there is no specific appropriate InterRepository, this will get
1276
# the InterRepository base class, which raises an
1277
# IncompatibleRepositories when asked to fetch.
1278
inter = repository.InterRepository.get(source, self)
1279
return inter.fetch(revision_id=revision_id, pb=pb,
1280
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1282
def create_bundle(self, target, base, fileobj, format=None):
1284
self._real_repository.create_bundle(target, base, fileobj, format)
1287
def get_ancestry(self, revision_id, topo_sorted=True):
1289
return self._real_repository.get_ancestry(revision_id, topo_sorted)
1291
def fileids_altered_by_revision_ids(self, revision_ids):
1293
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
1295
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
1297
return self._real_repository._get_versioned_file_checker(
1298
revisions, revision_versions_cache)
1300
def iter_files_bytes(self, desired_files):
1301
"""See Repository.iter_file_bytes.
1304
return self._real_repository.iter_files_bytes(desired_files)
1306
def get_parent_map(self, revision_ids):
1307
"""See bzrlib.Graph.get_parent_map()."""
1308
return self._make_parents_provider().get_parent_map(revision_ids)
1310
def _get_parent_map_rpc(self, keys):
1311
"""Helper for get_parent_map that performs the RPC."""
1312
medium = self._client._medium
1313
if medium._is_remote_before((1, 2)):
1314
# We already found out that the server can't understand
1315
# Repository.get_parent_map requests, so just fetch the whole
1318
# Note that this reads the whole graph, when only some keys are
1319
# wanted. On this old server there's no way (?) to get them all
1320
# in one go, and the user probably will have seen a warning about
1321
# the server being old anyhow.
1322
rg = self._get_revision_graph(None)
1323
# There is an API discrepancy between get_parent_map and
1324
# get_revision_graph. Specifically, a "key:()" pair in
1325
# get_revision_graph just means a node has no parents. For
1326
# "get_parent_map" it means the node is a ghost. So fix up the
1327
# graph to correct this.
1328
# https://bugs.launchpad.net/bzr/+bug/214894
1329
# There is one other "bug" which is that ghosts in
1330
# get_revision_graph() are not returned at all. But we won't worry
1331
# about that for now.
1332
for node_id, parent_ids in rg.iteritems():
1333
if parent_ids == ():
1334
rg[node_id] = (NULL_REVISION,)
1335
rg[NULL_REVISION] = ()
1340
raise ValueError('get_parent_map(None) is not valid')
1341
if NULL_REVISION in keys:
1342
keys.discard(NULL_REVISION)
1343
found_parents = {NULL_REVISION:()}
1345
return found_parents
1348
# TODO(Needs analysis): We could assume that the keys being requested
1349
# from get_parent_map are in a breadth first search, so typically they
1350
# will all be depth N from some common parent, and we don't have to
1351
# have the server iterate from the root parent, but rather from the
1352
# keys we're searching; and just tell the server the keyspace we
1353
# already have; but this may be more traffic again.
1355
# Transform self._parents_map into a search request recipe.
1356
# TODO: Manage this incrementally to avoid covering the same path
1357
# repeatedly. (The server will have to on each request, but the less
1358
# work done the better).
1360
# Negative caching notes:
1361
# new server sends missing when a request including the revid
1362
# 'include-missing:' is present in the request.
1363
# missing keys are serialised as missing:X, and we then call
1364
# provider.note_missing(X) for-all X
1365
parents_map = self._unstacked_provider.get_cached_map()
1366
if parents_map is None:
1367
# Repository is not locked, so there's no cache.
1369
# start_set is all the keys in the cache
1370
start_set = set(parents_map)
1371
# result set is all the references to keys in the cache
1372
result_parents = set()
1373
for parents in parents_map.itervalues():
1374
result_parents.update(parents)
1375
stop_keys = result_parents.difference(start_set)
1376
# We don't need to send ghosts back to the server as a position to
1378
stop_keys.difference_update(self._unstacked_provider.missing_keys)
1379
key_count = len(parents_map)
1380
if (NULL_REVISION in result_parents
1381
and NULL_REVISION in self._unstacked_provider.missing_keys):
1382
# If we pruned NULL_REVISION from the stop_keys because it's also
1383
# in our cache of "missing" keys we need to increment our key count
1384
# by 1, because the reconsitituted SearchResult on the server will
1385
# still consider NULL_REVISION to be an included key.
1387
included_keys = start_set.intersection(result_parents)
1388
start_set.difference_update(included_keys)
1389
recipe = ('manual', start_set, stop_keys, key_count)
1390
body = self._serialise_search_recipe(recipe)
1391
path = self.bzrdir._path_for_remote_call(self._client)
1393
if type(key) is not str:
1395
"key %r not a plain string" % (key,))
1396
verb = 'Repository.get_parent_map'
1397
args = (path, 'include-missing:') + tuple(keys)
1399
response = self._call_with_body_bytes_expecting_body(
1401
except errors.UnknownSmartMethod:
1402
# Server does not support this method, so get the whole graph.
1403
# Worse, we have to force a disconnection, because the server now
1404
# doesn't realise it has a body on the wire to consume, so the
1405
# only way to recover is to abandon the connection.
1407
'Server is too old for fast get_parent_map, reconnecting. '
1408
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1410
# To avoid having to disconnect repeatedly, we keep track of the
1411
# fact the server doesn't understand remote methods added in 1.2.
1412
medium._remember_remote_is_before((1, 2))
1413
# Recurse just once and we should use the fallback code.
1414
return self._get_parent_map_rpc(keys)
1415
response_tuple, response_handler = response
1416
if response_tuple[0] not in ['ok']:
1417
response_handler.cancel_read_body()
1418
raise errors.UnexpectedSmartServerResponse(response_tuple)
1419
if response_tuple[0] == 'ok':
1420
coded = bz2.decompress(response_handler.read_body_bytes())
1422
# no revisions found
1424
lines = coded.split('\n')
1427
d = tuple(line.split())
1429
revision_graph[d[0]] = d[1:]
1432
if d[0].startswith('missing:'):
1434
self._unstacked_provider.note_missing_key(revid)
1436
# no parents - so give the Graph result
1438
revision_graph[d[0]] = (NULL_REVISION,)
1439
return revision_graph
1442
def get_signature_text(self, revision_id):
1444
return self._real_repository.get_signature_text(revision_id)
1447
def get_inventory_xml(self, revision_id):
1449
return self._real_repository.get_inventory_xml(revision_id)
1451
def deserialise_inventory(self, revision_id, xml):
1453
return self._real_repository.deserialise_inventory(revision_id, xml)
1455
def reconcile(self, other=None, thorough=False):
1457
return self._real_repository.reconcile(other=other, thorough=thorough)
1459
def all_revision_ids(self):
1461
return self._real_repository.all_revision_ids()
1464
def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1466
return self._real_repository.get_deltas_for_revisions(revisions,
1467
specific_fileids=specific_fileids)
1470
def get_revision_delta(self, revision_id, specific_fileids=None):
1472
return self._real_repository.get_revision_delta(revision_id,
1473
specific_fileids=specific_fileids)
1476
def revision_trees(self, revision_ids):
1478
return self._real_repository.revision_trees(revision_ids)
1481
def get_revision_reconcile(self, revision_id):
1483
return self._real_repository.get_revision_reconcile(revision_id)
1486
def check(self, revision_ids=None):
1488
return self._real_repository.check(revision_ids=revision_ids)
1490
def copy_content_into(self, destination, revision_id=None):
1492
return self._real_repository.copy_content_into(
1493
destination, revision_id=revision_id)
1495
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
1496
# get a tarball of the remote repository, and copy from that into the
1498
from bzrlib import osutils
1500
# TODO: Maybe a progress bar while streaming the tarball?
1501
note("Copying repository content as tarball...")
1502
tar_file = self._get_tarball('bz2')
1503
if tar_file is None:
1505
destination = to_bzrdir.create_repository()
1507
tar = tarfile.open('repository', fileobj=tar_file,
1509
tmpdir = osutils.mkdtemp()
1511
_extract_tar(tar, tmpdir)
1512
tmp_bzrdir = BzrDir.open(tmpdir)
1513
tmp_repo = tmp_bzrdir.open_repository()
1514
tmp_repo.copy_content_into(destination, revision_id)
1516
osutils.rmtree(tmpdir)
1520
# TODO: Suggestion from john: using external tar is much faster than
1521
# python's tarfile library, but it may not work on windows.
1524
def inventories(self):
1525
"""Decorate the real repository for now.
1527
In the long term a full blown network facility is needed to
1528
avoid creating a real repository object locally.
1531
return self._real_repository.inventories
1534
def pack(self, hint=None):
1535
"""Compress the data within the repository.
1537
This is not currently implemented within the smart server.
1540
return self._real_repository.pack(hint=hint)
1543
def revisions(self):
1544
"""Decorate the real repository for now.
1546
In the short term this should become a real object to intercept graph
1549
In the long term a full blown network facility is needed.
1552
return self._real_repository.revisions
1554
def set_make_working_trees(self, new_value):
1556
new_value_str = "True"
1558
new_value_str = "False"
1559
path = self.bzrdir._path_for_remote_call(self._client)
1561
response = self._call(
1562
'Repository.set_make_working_trees', path, new_value_str)
1563
except errors.UnknownSmartMethod:
1565
self._real_repository.set_make_working_trees(new_value)
1567
if response[0] != 'ok':
1568
raise errors.UnexpectedSmartServerResponse(response)
1571
def signatures(self):
1572
"""Decorate the real repository for now.
1574
In the long term a full blown network facility is needed to avoid
1575
creating a real repository object locally.
1578
return self._real_repository.signatures
1581
def sign_revision(self, revision_id, gpg_strategy):
1583
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1587
"""Decorate the real repository for now.
1589
In the long term a full blown network facility is needed to avoid
1590
creating a real repository object locally.
1593
return self._real_repository.texts
1596
def get_revisions(self, revision_ids):
1598
return self._real_repository.get_revisions(revision_ids)
1600
def supports_rich_root(self):
1601
return self._format.rich_root_data
1603
def iter_reverse_revision_history(self, revision_id):
1605
return self._real_repository.iter_reverse_revision_history(revision_id)
1608
def _serializer(self):
1609
return self._format._serializer
1611
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1613
return self._real_repository.store_revision_signature(
1614
gpg_strategy, plaintext, revision_id)
1616
def add_signature_text(self, revision_id, signature):
1618
return self._real_repository.add_signature_text(revision_id, signature)
1620
def has_signature_for_revision_id(self, revision_id):
1622
return self._real_repository.has_signature_for_revision_id(revision_id)
1624
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1626
return self._real_repository.item_keys_introduced_by(revision_ids,
1627
_files_pb=_files_pb)
1629
def revision_graph_can_have_wrong_parents(self):
1630
# The answer depends on the remote repo format.
1632
return self._real_repository.revision_graph_can_have_wrong_parents()
1634
def _find_inconsistent_revision_parents(self):
1636
return self._real_repository._find_inconsistent_revision_parents()
1638
def _check_for_inconsistent_revision_parents(self):
1640
return self._real_repository._check_for_inconsistent_revision_parents()
1642
def _make_parents_provider(self, other=None):
1643
providers = [self._unstacked_provider]
1644
if other is not None:
1645
providers.insert(0, other)
1646
providers.extend(r._make_parents_provider() for r in
1647
self._fallback_repositories)
1648
return graph.StackedParentsProvider(providers)
1650
def _serialise_search_recipe(self, recipe):
1651
"""Serialise a graph search recipe.
1653
:param recipe: A search recipe (start, stop, count).
1654
:return: Serialised bytes.
1656
start_keys = ' '.join(recipe[1])
1657
stop_keys = ' '.join(recipe[2])
1658
count = str(recipe[3])
1659
return '\n'.join((start_keys, stop_keys, count))
1661
def _serialise_search_result(self, search_result):
1662
if isinstance(search_result, graph.PendingAncestryResult):
1663
parts = ['ancestry-of']
1664
parts.extend(search_result.heads)
1666
recipe = search_result.get_recipe()
1667
parts = [recipe[0], self._serialise_search_recipe(recipe)]
1668
return '\n'.join(parts)
1671
path = self.bzrdir._path_for_remote_call(self._client)
1673
response = self._call('PackRepository.autopack', path)
1674
except errors.UnknownSmartMethod:
1676
self._real_repository._pack_collection.autopack()
1679
if response[0] != 'ok':
1680
raise errors.UnexpectedSmartServerResponse(response)
1683
class RemoteStreamSink(repository.StreamSink):
1685
def __init__(self, target_repo):
1686
repository.StreamSink.__init__(self, target_repo)
1688
def _insert_real(self, stream, src_format, resume_tokens):
1689
self.target_repo._ensure_real()
1690
sink = self.target_repo._real_repository._get_sink()
1691
result = sink.insert_stream(stream, src_format, resume_tokens)
1693
self.target_repo.autopack()
1696
def insert_stream(self, stream, src_format, resume_tokens):
1697
target = self.target_repo
1698
target._unstacked_provider.missing_keys.clear()
1699
candidate_calls = [('Repository.insert_stream_1.18', (1, 18))]
1700
if target._lock_token:
1701
candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
1702
lock_args = (target._lock_token or '',)
1704
candidate_calls.append(('Repository.insert_stream', (1, 13)))
1706
client = target._client
1707
medium = client._medium
1708
path = target.bzrdir._path_for_remote_call(client)
1710
for verb, required_version in candidate_calls:
1711
if medium._is_remote_before(required_version):
1714
# We've already done the probing (and set _is_remote_before) on
1715
# a previous insert.
1718
byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1720
response = client.call_with_body_stream(
1721
(verb, path, '') + lock_args, byte_stream)
1722
except errors.UnknownSmartMethod:
1723
medium._remember_remote_is_before(required_version)
1729
return self._insert_real(stream, src_format, resume_tokens)
1730
self._last_inv_record = None
1731
self._last_substream = None
1732
if required_version < (1, 18):
1733
# Remote side doesn't support inventory deltas. Wrap the stream to
1734
# make sure we don't send any. If the stream contains inventory
1735
# deltas we'll interrupt the smart insert_stream request and
1737
stream = self._stop_stream_if_inventory_delta(stream)
1738
byte_stream = smart_repo._stream_to_byte_stream(
1740
resume_tokens = ' '.join(resume_tokens)
1741
response = client.call_with_body_stream(
1742
(verb, path, resume_tokens) + lock_args, byte_stream)
1743
if response[0][0] not in ('ok', 'missing-basis'):
1744
raise errors.UnexpectedSmartServerResponse(response)
1745
if self._last_inv_record is not None:
1746
# The stream included an inventory-delta record, but the remote
1747
# side isn't new enough to support them. So we need to send the
1748
# rest of the stream via VFS.
1749
return self._resume_stream_with_vfs(response, src_format)
1750
if response[0][0] == 'missing-basis':
1751
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1752
resume_tokens = tokens
1753
return resume_tokens, set(missing_keys)
1755
self.target_repo.refresh_data()
1758
def _resume_stream_with_vfs(self, response, src_format):
1759
"""Resume sending a stream via VFS, first resending the record and
1760
substream that couldn't be sent via an insert_stream verb.
1762
if response[0][0] == 'missing-basis':
1763
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1764
# Ignore missing_keys, we haven't finished inserting yet
1767
def resume_substream():
1768
# First yield the record we stopped at.
1769
yield self._last_inv_record
1770
self._last_inv_record = None
1771
# Then yield the rest of the substream that was interrupted.
1772
for record in self._last_substream:
1774
self._last_substream = None
1775
def resume_stream():
1776
# Finish sending the interrupted substream
1777
yield ('inventories', resume_substream())
1778
# Then simply continue sending the rest of the stream.
1779
for substream_kind, substream in self._last_stream:
1780
yield substream_kind, substream
1781
return self._insert_real(resume_stream(), src_format, tokens)
1783
def _stop_stream_if_inventory_delta(self, stream):
1784
"""Normally this just lets the original stream pass-through unchanged.
1786
However if any 'inventories' substream includes an inventory-delta
1787
record it will stop streaming, and store the interrupted record,
1788
substream and stream in self._last_inv_record, self._last_substream and
1789
self._last_stream so that the stream can be resumed by
1790
_resume_stream_with_vfs.
1792
def filter_inv_substream(inv_substream):
1793
substream_iter = iter(inv_substream)
1794
for record in substream_iter:
1795
if record.storage_kind == 'inventory-delta':
1796
self._last_inv_record = record
1797
self._last_substream = substream_iter
1802
stream_iter = iter(stream)
1803
for substream_kind, substream in stream_iter:
1804
if substream_kind == 'inventories':
1805
yield substream_kind, filter_inv_substream(substream)
1806
if self._last_inv_record is not None:
1807
self._last_stream = stream_iter
1810
yield substream_kind, substream
1813
class RemoteStreamSource(repository.StreamSource):
1814
"""Stream data from a remote server."""
1816
def get_stream(self, search):
1817
if (self.from_repository._fallback_repositories and
1818
self.to_format._fetch_order == 'topological'):
1819
return self._real_stream(self.from_repository, search)
1820
return self.missing_parents_chain(search, [self.from_repository] +
1821
self.from_repository._fallback_repositories)
1823
def get_stream_for_missing_keys(self, missing_keys):
1824
self.from_repository._ensure_real()
1825
real_repo = self.from_repository._real_repository
1826
real_source = real_repo._get_source(self.to_format)
1827
return real_source.get_stream_for_missing_keys(missing_keys)
1829
def _real_stream(self, repo, search):
1830
"""Get a stream for search from repo.
1832
This never called RemoteStreamSource.get_stream, and is a heler
1833
for RemoteStreamSource._get_stream to allow getting a stream
1834
reliably whether fallback back because of old servers or trying
1835
to stream from a non-RemoteRepository (which the stacked support
1838
source = repo._get_source(self.to_format)
1839
if isinstance(source, RemoteStreamSource):
1840
return repository.StreamSource.get_stream(source, search)
1841
return source.get_stream(search)
1843
def _get_stream(self, repo, search):
1844
"""Core worker to get a stream from repo for search.
1846
This is used by both get_stream and the stacking support logic. It
1847
deliberately gets a stream for repo which does not need to be
1848
self.from_repository. In the event that repo is not Remote, or
1849
cannot do a smart stream, a fallback is made to the generic
1850
repository._get_stream() interface, via self._real_stream.
1852
In the event of stacking, streams from _get_stream will not
1853
contain all the data for search - this is normal (see get_stream).
1855
:param repo: A repository.
1856
:param search: A search.
1858
# Fallbacks may be non-smart
1859
if not isinstance(repo, RemoteRepository):
1860
return self._real_stream(repo, search)
1861
client = repo._client
1862
medium = client._medium
1863
path = repo.bzrdir._path_for_remote_call(client)
1864
search_bytes = repo._serialise_search_result(search)
1865
args = (path, self.to_format.network_name())
1867
('Repository.get_stream_1.18', (1, 18)),
1868
('Repository.get_stream', (1, 13))]
1870
for verb, version in candidate_verbs:
1871
if medium._is_remote_before(version):
1874
response = repo._call_with_body_bytes_expecting_body(
1875
verb, args, search_bytes)
1876
except errors.UnknownSmartMethod:
1877
medium._remember_remote_is_before(version)
1879
response_tuple, response_handler = response
1883
return self._real_stream(repo, search)
1884
if response_tuple[0] != 'ok':
1885
raise errors.UnexpectedSmartServerResponse(response_tuple)
1886
byte_stream = response_handler.read_streamed_body()
1887
src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
1888
if src_format.network_name() != repo._format.network_name():
1889
raise AssertionError(
1890
"Mismatched RemoteRepository and stream src %r, %r" % (
1891
src_format.network_name(), repo._format.network_name()))
1894
def missing_parents_chain(self, search, sources):
1895
"""Chain multiple streams together to handle stacking.
1897
:param search: The overall search to satisfy with streams.
1898
:param sources: A list of Repository objects to query.
1900
self.serialiser = self.to_format._serializer
1901
self.seen_revs = set()
1902
self.referenced_revs = set()
1903
# If there are heads in the search, or the key count is > 0, we are not
1905
while not search.is_empty() and len(sources) > 1:
1906
source = sources.pop(0)
1907
stream = self._get_stream(source, search)
1908
for kind, substream in stream:
1909
if kind != 'revisions':
1910
yield kind, substream
1912
yield kind, self.missing_parents_rev_handler(substream)
1913
search = search.refine(self.seen_revs, self.referenced_revs)
1914
self.seen_revs = set()
1915
self.referenced_revs = set()
1916
if not search.is_empty():
1917
for kind, stream in self._get_stream(sources[0], search):
1920
def missing_parents_rev_handler(self, substream):
1921
for content in substream:
1922
revision_bytes = content.get_bytes_as('fulltext')
1923
revision = self.serialiser.read_revision_from_string(revision_bytes)
1924
self.seen_revs.add(content.key[-1])
1925
self.referenced_revs.update(revision.parent_ids)
1929
class RemoteBranchLockableFiles(LockableFiles):
1930
"""A 'LockableFiles' implementation that talks to a smart server.
1932
This is not a public interface class.
1935
def __init__(self, bzrdir, _client):
1936
self.bzrdir = bzrdir
1937
self._client = _client
1938
self._need_find_modes = True
1939
LockableFiles.__init__(
1940
self, bzrdir.get_branch_transport(None),
1941
'lock', lockdir.LockDir)
1943
def _find_modes(self):
1944
# RemoteBranches don't let the client set the mode of control files.
1945
self._dir_mode = None
1946
self._file_mode = None
1949
class RemoteBranchFormat(branch.BranchFormat):
1951
def __init__(self, network_name=None):
1952
super(RemoteBranchFormat, self).__init__()
1953
self._matchingbzrdir = RemoteBzrDirFormat()
1954
self._matchingbzrdir.set_branch_format(self)
1955
self._custom_format = None
1956
self._network_name = network_name
1958
def __eq__(self, other):
1959
return (isinstance(other, RemoteBranchFormat) and
1960
self.__dict__ == other.__dict__)
1962
def _ensure_real(self):
1963
if self._custom_format is None:
1964
self._custom_format = branch.network_format_registry.get(
1967
def get_format_description(self):
1968
return 'Remote BZR Branch'
1970
def network_name(self):
1971
return self._network_name
1973
def open(self, a_bzrdir, ignore_fallbacks=False):
1974
return a_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1976
def _vfs_initialize(self, a_bzrdir):
1977
# Initialisation when using a local bzrdir object, or a non-vfs init
1978
# method is not available on the server.
1979
# self._custom_format is always set - the start of initialize ensures
1981
if isinstance(a_bzrdir, RemoteBzrDir):
1982
a_bzrdir._ensure_real()
1983
result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
1985
# We assume the bzrdir is parameterised; it may not be.
1986
result = self._custom_format.initialize(a_bzrdir)
1987
if (isinstance(a_bzrdir, RemoteBzrDir) and
1988
not isinstance(result, RemoteBranch)):
1989
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
1992
def initialize(self, a_bzrdir):
1993
# 1) get the network name to use.
1994
if self._custom_format:
1995
network_name = self._custom_format.network_name()
1997
# Select the current bzrlib default and ask for that.
1998
reference_bzrdir_format = bzrdir.format_registry.get('default')()
1999
reference_format = reference_bzrdir_format.get_branch_format()
2000
self._custom_format = reference_format
2001
network_name = reference_format.network_name()
2002
# Being asked to create on a non RemoteBzrDir:
2003
if not isinstance(a_bzrdir, RemoteBzrDir):
2004
return self._vfs_initialize(a_bzrdir)
2005
medium = a_bzrdir._client._medium
2006
if medium._is_remote_before((1, 13)):
2007
return self._vfs_initialize(a_bzrdir)
2008
# Creating on a remote bzr dir.
2009
# 2) try direct creation via RPC
2010
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2011
verb = 'BzrDir.create_branch'
2013
response = a_bzrdir._call(verb, path, network_name)
2014
except errors.UnknownSmartMethod:
2015
# Fallback - use vfs methods
2016
medium._remember_remote_is_before((1, 13))
2017
return self._vfs_initialize(a_bzrdir)
2018
if response[0] != 'ok':
2019
raise errors.UnexpectedSmartServerResponse(response)
2020
# Turn the response into a RemoteRepository object.
2021
format = RemoteBranchFormat(network_name=response[1])
2022
repo_format = response_tuple_to_repo_format(response[3:])
2023
if response[2] == '':
2024
repo_bzrdir = a_bzrdir
2026
repo_bzrdir = RemoteBzrDir(
2027
a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
2029
remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2030
remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2031
format=format, setup_stacking=False)
2032
# XXX: We know this is a new branch, so it must have revno 0, revid
2033
# NULL_REVISION. Creating the branch locked would make this be unable
2034
# to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2035
remote_branch._last_revision_info_cache = 0, NULL_REVISION
2036
return remote_branch
2038
def make_tags(self, branch):
2040
return self._custom_format.make_tags(branch)
2042
def supports_tags(self):
2043
# Remote branches might support tags, but we won't know until we
2044
# access the real remote branch.
2046
return self._custom_format.supports_tags()
2048
def supports_stacking(self):
2050
return self._custom_format.supports_stacking()
2052
def supports_set_append_revisions_only(self):
2054
return self._custom_format.supports_set_append_revisions_only()
2057
class RemoteBranch(branch.Branch, _RpcHelper):
2058
"""Branch stored on a server accessed by HPSS RPC.
2060
At the moment most operations are mapped down to simple file operations.
2063
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2064
_client=None, format=None, setup_stacking=True):
2065
"""Create a RemoteBranch instance.
2067
:param real_branch: An optional local implementation of the branch
2068
format, usually accessing the data via the VFS.
2069
:param _client: Private parameter for testing.
2070
:param format: A RemoteBranchFormat object, None to create one
2071
automatically. If supplied it should have a network_name already
2073
:param setup_stacking: If True make an RPC call to determine the
2074
stacked (or not) status of the branch. If False assume the branch
2077
# We intentionally don't call the parent class's __init__, because it
2078
# will try to assign to self.tags, which is a property in this subclass.
2079
# And the parent's __init__ doesn't do much anyway.
2080
self.bzrdir = remote_bzrdir
2081
if _client is not None:
2082
self._client = _client
2084
self._client = remote_bzrdir._client
2085
self.repository = remote_repository
2086
if real_branch is not None:
2087
self._real_branch = real_branch
2088
# Give the remote repository the matching real repo.
2089
real_repo = self._real_branch.repository
2090
if isinstance(real_repo, RemoteRepository):
2091
real_repo._ensure_real()
2092
real_repo = real_repo._real_repository
2093
self.repository._set_real_repository(real_repo)
2094
# Give the branch the remote repository to let fast-pathing happen.
2095
self._real_branch.repository = self.repository
2097
self._real_branch = None
2098
# Fill out expected attributes of branch for bzrlib API users.
2099
self._clear_cached_state()
2100
self.base = self.bzrdir.root_transport.base
2101
self._control_files = None
2102
self._lock_mode = None
2103
self._lock_token = None
2104
self._repo_lock_token = None
2105
self._lock_count = 0
2106
self._leave_lock = False
2107
# Setup a format: note that we cannot call _ensure_real until all the
2108
# attributes above are set: This code cannot be moved higher up in this
2111
self._format = RemoteBranchFormat()
2112
if real_branch is not None:
2113
self._format._network_name = \
2114
self._real_branch._format.network_name()
2116
self._format = format
2117
if not self._format._network_name:
2118
# Did not get from open_branchV2 - old server.
2120
self._format._network_name = \
2121
self._real_branch._format.network_name()
2122
self.tags = self._format.make_tags(self)
2123
# The base class init is not called, so we duplicate this:
2124
hooks = branch.Branch.hooks['open']
2127
self._is_stacked = False
2129
self._setup_stacking()
2131
def _setup_stacking(self):
2132
# configure stacking into the remote repository, by reading it from
2135
fallback_url = self.get_stacked_on_url()
2136
except (errors.NotStacked, errors.UnstackableBranchFormat,
2137
errors.UnstackableRepositoryFormat), e:
2139
self._is_stacked = True
2140
self._activate_fallback_location(fallback_url)
2142
def _get_config(self):
2143
return RemoteBranchConfig(self)
2145
def _get_real_transport(self):
2146
# if we try vfs access, return the real branch's vfs transport
2148
return self._real_branch._transport
2150
_transport = property(_get_real_transport)
2153
return "%s(%s)" % (self.__class__.__name__, self.base)
2157
def _ensure_real(self):
2158
"""Ensure that there is a _real_branch set.
2160
Used before calls to self._real_branch.
2162
if self._real_branch is None:
2163
if not vfs.vfs_enabled():
2164
raise AssertionError('smart server vfs must be enabled '
2165
'to use vfs implementation')
2166
self.bzrdir._ensure_real()
2167
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
2168
if self.repository._real_repository is None:
2169
# Give the remote repository the matching real repo.
2170
real_repo = self._real_branch.repository
2171
if isinstance(real_repo, RemoteRepository):
2172
real_repo._ensure_real()
2173
real_repo = real_repo._real_repository
2174
self.repository._set_real_repository(real_repo)
2175
# Give the real branch the remote repository to let fast-pathing
2177
self._real_branch.repository = self.repository
2178
if self._lock_mode == 'r':
2179
self._real_branch.lock_read()
2180
elif self._lock_mode == 'w':
2181
self._real_branch.lock_write(token=self._lock_token)
2183
def _translate_error(self, err, **context):
2184
self.repository._translate_error(err, branch=self, **context)
2186
def _clear_cached_state(self):
2187
super(RemoteBranch, self)._clear_cached_state()
2188
if self._real_branch is not None:
2189
self._real_branch._clear_cached_state()
2191
def _clear_cached_state_of_remote_branch_only(self):
2192
"""Like _clear_cached_state, but doesn't clear the cache of
2195
This is useful when falling back to calling a method of
2196
self._real_branch that changes state. In that case the underlying
2197
branch changes, so we need to invalidate this RemoteBranch's cache of
2198
it. However, there's no need to invalidate the _real_branch's cache
2199
too, in fact doing so might harm performance.
2201
super(RemoteBranch, self)._clear_cached_state()
2204
def control_files(self):
2205
# Defer actually creating RemoteBranchLockableFiles until its needed,
2206
# because it triggers an _ensure_real that we otherwise might not need.
2207
if self._control_files is None:
2208
self._control_files = RemoteBranchLockableFiles(
2209
self.bzrdir, self._client)
2210
return self._control_files
2212
def _get_checkout_format(self):
2214
return self._real_branch._get_checkout_format()
2216
def get_physical_lock_status(self):
2217
"""See Branch.get_physical_lock_status()."""
2218
# should be an API call to the server, as branches must be lockable.
2220
return self._real_branch.get_physical_lock_status()
2222
def get_stacked_on_url(self):
2223
"""Get the URL this branch is stacked against.
2225
:raises NotStacked: If the branch is not stacked.
2226
:raises UnstackableBranchFormat: If the branch does not support
2228
:raises UnstackableRepositoryFormat: If the repository does not support
2232
# there may not be a repository yet, so we can't use
2233
# self._translate_error, so we can't use self._call either.
2234
response = self._client.call('Branch.get_stacked_on_url',
2235
self._remote_path())
2236
except errors.ErrorFromSmartServer, err:
2237
# there may not be a repository yet, so we can't call through
2238
# its _translate_error
2239
_translate_error(err, branch=self)
2240
except errors.UnknownSmartMethod, err:
2242
return self._real_branch.get_stacked_on_url()
2243
if response[0] != 'ok':
2244
raise errors.UnexpectedSmartServerResponse(response)
2247
def set_stacked_on_url(self, url):
2248
branch.Branch.set_stacked_on_url(self, url)
2250
self._is_stacked = False
2252
self._is_stacked = True
2254
def _vfs_get_tags_bytes(self):
2256
return self._real_branch._get_tags_bytes()
2258
def _get_tags_bytes(self):
2259
medium = self._client._medium
2260
if medium._is_remote_before((1, 13)):
2261
return self._vfs_get_tags_bytes()
2263
response = self._call('Branch.get_tags_bytes', self._remote_path())
2264
except errors.UnknownSmartMethod:
2265
medium._remember_remote_is_before((1, 13))
2266
return self._vfs_get_tags_bytes()
2269
def _vfs_set_tags_bytes(self, bytes):
2271
return self._real_branch._set_tags_bytes(bytes)
2273
def _set_tags_bytes(self, bytes):
2274
medium = self._client._medium
2275
if medium._is_remote_before((1, 18)):
2276
self._vfs_set_tags_bytes(bytes)
2279
self._remote_path(), self._lock_token, self._repo_lock_token)
2280
response = self._call_with_body_bytes(
2281
'Branch.set_tags_bytes', args, bytes)
2282
except errors.UnknownSmartMethod:
2283
medium._remember_remote_is_before((1, 18))
2284
self._vfs_set_tags_bytes(bytes)
2286
def lock_read(self):
2287
self.repository.lock_read()
2288
if not self._lock_mode:
2289
self._lock_mode = 'r'
2290
self._lock_count = 1
2291
if self._real_branch is not None:
2292
self._real_branch.lock_read()
2294
self._lock_count += 1
2296
def _remote_lock_write(self, token):
2298
branch_token = repo_token = ''
2300
branch_token = token
2301
repo_token = self.repository.lock_write()
2302
self.repository.unlock()
2303
err_context = {'token': token}
2304
response = self._call(
2305
'Branch.lock_write', self._remote_path(), branch_token,
2306
repo_token or '', **err_context)
2307
if response[0] != 'ok':
2308
raise errors.UnexpectedSmartServerResponse(response)
2309
ok, branch_token, repo_token = response
2310
return branch_token, repo_token
2312
def lock_write(self, token=None):
2313
if not self._lock_mode:
2314
# Lock the branch and repo in one remote call.
2315
remote_tokens = self._remote_lock_write(token)
2316
self._lock_token, self._repo_lock_token = remote_tokens
2317
if not self._lock_token:
2318
raise SmartProtocolError('Remote server did not return a token!')
2319
# Tell the self.repository object that it is locked.
2320
self.repository.lock_write(
2321
self._repo_lock_token, _skip_rpc=True)
2323
if self._real_branch is not None:
2324
self._real_branch.lock_write(token=self._lock_token)
2325
if token is not None:
2326
self._leave_lock = True
2328
self._leave_lock = False
2329
self._lock_mode = 'w'
2330
self._lock_count = 1
2331
elif self._lock_mode == 'r':
2332
raise errors.ReadOnlyTransaction
2334
if token is not None:
2335
# A token was given to lock_write, and we're relocking, so
2336
# check that the given token actually matches the one we
2338
if token != self._lock_token:
2339
raise errors.TokenMismatch(token, self._lock_token)
2340
self._lock_count += 1
2341
# Re-lock the repository too.
2342
self.repository.lock_write(self._repo_lock_token)
2343
return self._lock_token or None
2345
def _unlock(self, branch_token, repo_token):
2346
err_context = {'token': str((branch_token, repo_token))}
2347
response = self._call(
2348
'Branch.unlock', self._remote_path(), branch_token,
2349
repo_token or '', **err_context)
2350
if response == ('ok',):
2352
raise errors.UnexpectedSmartServerResponse(response)
2356
self._lock_count -= 1
2357
if not self._lock_count:
2358
self._clear_cached_state()
2359
mode = self._lock_mode
2360
self._lock_mode = None
2361
if self._real_branch is not None:
2362
if (not self._leave_lock and mode == 'w' and
2363
self._repo_lock_token):
2364
# If this RemoteBranch will remove the physical lock
2365
# for the repository, make sure the _real_branch
2366
# doesn't do it first. (Because the _real_branch's
2367
# repository is set to be the RemoteRepository.)
2368
self._real_branch.repository.leave_lock_in_place()
2369
self._real_branch.unlock()
2371
# Only write-locked branched need to make a remote method
2372
# call to perform the unlock.
2374
if not self._lock_token:
2375
raise AssertionError('Locked, but no token!')
2376
branch_token = self._lock_token
2377
repo_token = self._repo_lock_token
2378
self._lock_token = None
2379
self._repo_lock_token = None
2380
if not self._leave_lock:
2381
self._unlock(branch_token, repo_token)
2383
self.repository.unlock()
2385
def break_lock(self):
2387
return self._real_branch.break_lock()
2389
def leave_lock_in_place(self):
2390
if not self._lock_token:
2391
raise NotImplementedError(self.leave_lock_in_place)
2392
self._leave_lock = True
2394
def dont_leave_lock_in_place(self):
2395
if not self._lock_token:
2396
raise NotImplementedError(self.dont_leave_lock_in_place)
2397
self._leave_lock = False
2399
def get_rev_id(self, revno, history=None):
2401
return _mod_revision.NULL_REVISION
2402
last_revision_info = self.last_revision_info()
2403
ok, result = self.repository.get_rev_id_for_revno(
2404
revno, last_revision_info)
2407
missing_parent = result[1]
2408
# Either the revision named by the server is missing, or its parent
2409
# is. Call get_parent_map to determine which, so that we report a
2411
parent_map = self.repository.get_parent_map([missing_parent])
2412
if missing_parent in parent_map:
2413
missing_parent = parent_map[missing_parent]
2414
raise errors.RevisionNotPresent(missing_parent, self.repository)
2416
def _last_revision_info(self):
2417
response = self._call('Branch.last_revision_info', self._remote_path())
2418
if response[0] != 'ok':
2419
raise SmartProtocolError('unexpected response code %s' % (response,))
2420
revno = int(response[1])
2421
last_revision = response[2]
2422
return (revno, last_revision)
2424
def _gen_revision_history(self):
2425
"""See Branch._gen_revision_history()."""
2426
if self._is_stacked:
2428
return self._real_branch._gen_revision_history()
2429
response_tuple, response_handler = self._call_expecting_body(
2430
'Branch.revision_history', self._remote_path())
2431
if response_tuple[0] != 'ok':
2432
raise errors.UnexpectedSmartServerResponse(response_tuple)
2433
result = response_handler.read_body_bytes().split('\x00')
2438
def _remote_path(self):
2439
return self.bzrdir._path_for_remote_call(self._client)
2441
def _set_last_revision_descendant(self, revision_id, other_branch,
2442
allow_diverged=False, allow_overwrite_descendant=False):
2443
# This performs additional work to meet the hook contract; while its
2444
# undesirable, we have to synthesise the revno to call the hook, and
2445
# not calling the hook is worse as it means changes can't be prevented.
2446
# Having calculated this though, we can't just call into
2447
# set_last_revision_info as a simple call, because there is a set_rh
2448
# hook that some folk may still be using.
2449
old_revno, old_revid = self.last_revision_info()
2450
history = self._lefthand_history(revision_id)
2451
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2452
err_context = {'other_branch': other_branch}
2453
response = self._call('Branch.set_last_revision_ex',
2454
self._remote_path(), self._lock_token, self._repo_lock_token,
2455
revision_id, int(allow_diverged), int(allow_overwrite_descendant),
2457
self._clear_cached_state()
2458
if len(response) != 3 and response[0] != 'ok':
2459
raise errors.UnexpectedSmartServerResponse(response)
2460
new_revno, new_revision_id = response[1:]
2461
self._last_revision_info_cache = new_revno, new_revision_id
2462
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2463
if self._real_branch is not None:
2464
cache = new_revno, new_revision_id
2465
self._real_branch._last_revision_info_cache = cache
2467
def _set_last_revision(self, revision_id):
2468
old_revno, old_revid = self.last_revision_info()
2469
# This performs additional work to meet the hook contract; while its
2470
# undesirable, we have to synthesise the revno to call the hook, and
2471
# not calling the hook is worse as it means changes can't be prevented.
2472
# Having calculated this though, we can't just call into
2473
# set_last_revision_info as a simple call, because there is a set_rh
2474
# hook that some folk may still be using.
2475
history = self._lefthand_history(revision_id)
2476
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2477
self._clear_cached_state()
2478
response = self._call('Branch.set_last_revision',
2479
self._remote_path(), self._lock_token, self._repo_lock_token,
2481
if response != ('ok',):
2482
raise errors.UnexpectedSmartServerResponse(response)
2483
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2486
def set_revision_history(self, rev_history):
2487
# Send just the tip revision of the history; the server will generate
2488
# the full history from that. If the revision doesn't exist in this
2489
# branch, NoSuchRevision will be raised.
2490
if rev_history == []:
2493
rev_id = rev_history[-1]
2494
self._set_last_revision(rev_id)
2495
for hook in branch.Branch.hooks['set_rh']:
2496
hook(self, rev_history)
2497
self._cache_revision_history(rev_history)
2499
def _get_parent_location(self):
2500
medium = self._client._medium
2501
if medium._is_remote_before((1, 13)):
2502
return self._vfs_get_parent_location()
2504
response = self._call('Branch.get_parent', self._remote_path())
2505
except errors.UnknownSmartMethod:
2506
medium._remember_remote_is_before((1, 13))
2507
return self._vfs_get_parent_location()
2508
if len(response) != 1:
2509
raise errors.UnexpectedSmartServerResponse(response)
2510
parent_location = response[0]
2511
if parent_location == '':
2513
return parent_location
2515
def _vfs_get_parent_location(self):
2517
return self._real_branch._get_parent_location()
2519
def _set_parent_location(self, url):
2520
medium = self._client._medium
2521
if medium._is_remote_before((1, 15)):
2522
return self._vfs_set_parent_location(url)
2524
call_url = url or ''
2525
if type(call_url) is not str:
2526
raise AssertionError('url must be a str or None (%s)' % url)
2527
response = self._call('Branch.set_parent_location',
2528
self._remote_path(), self._lock_token, self._repo_lock_token,
2530
except errors.UnknownSmartMethod:
2531
medium._remember_remote_is_before((1, 15))
2532
return self._vfs_set_parent_location(url)
2534
raise errors.UnexpectedSmartServerResponse(response)
2536
def _vfs_set_parent_location(self, url):
2538
return self._real_branch._set_parent_location(url)
2541
def pull(self, source, overwrite=False, stop_revision=None,
2543
self._clear_cached_state_of_remote_branch_only()
2545
return self._real_branch.pull(
2546
source, overwrite=overwrite, stop_revision=stop_revision,
2547
_override_hook_target=self, **kwargs)
2550
def push(self, target, overwrite=False, stop_revision=None):
2552
return self._real_branch.push(
2553
target, overwrite=overwrite, stop_revision=stop_revision,
2554
_override_hook_source_branch=self)
2556
def is_locked(self):
2557
return self._lock_count >= 1
2560
def revision_id_to_revno(self, revision_id):
2562
return self._real_branch.revision_id_to_revno(revision_id)
2565
def set_last_revision_info(self, revno, revision_id):
2566
# XXX: These should be returned by the set_last_revision_info verb
2567
old_revno, old_revid = self.last_revision_info()
2568
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2569
revision_id = ensure_null(revision_id)
2571
response = self._call('Branch.set_last_revision_info',
2572
self._remote_path(), self._lock_token, self._repo_lock_token,
2573
str(revno), revision_id)
2574
except errors.UnknownSmartMethod:
2576
self._clear_cached_state_of_remote_branch_only()
2577
self._real_branch.set_last_revision_info(revno, revision_id)
2578
self._last_revision_info_cache = revno, revision_id
2580
if response == ('ok',):
2581
self._clear_cached_state()
2582
self._last_revision_info_cache = revno, revision_id
2583
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2584
# Update the _real_branch's cache too.
2585
if self._real_branch is not None:
2586
cache = self._last_revision_info_cache
2587
self._real_branch._last_revision_info_cache = cache
2589
raise errors.UnexpectedSmartServerResponse(response)
2592
def generate_revision_history(self, revision_id, last_rev=None,
2594
medium = self._client._medium
2595
if not medium._is_remote_before((1, 6)):
2596
# Use a smart method for 1.6 and above servers
2598
self._set_last_revision_descendant(revision_id, other_branch,
2599
allow_diverged=True, allow_overwrite_descendant=True)
2601
except errors.UnknownSmartMethod:
2602
medium._remember_remote_is_before((1, 6))
2603
self._clear_cached_state_of_remote_branch_only()
2604
self.set_revision_history(self._lefthand_history(revision_id,
2605
last_rev=last_rev,other_branch=other_branch))
2607
def set_push_location(self, location):
2609
return self._real_branch.set_push_location(location)
2612
class RemoteConfig(object):
2613
"""A Config that reads and writes from smart verbs.
2615
It is a low-level object that considers config data to be name/value pairs
2616
that may be associated with a section. Assigning meaning to the these
2617
values is done at higher levels like bzrlib.config.TreeConfig.
2620
def get_option(self, name, section=None, default=None):
2621
"""Return the value associated with a named option.
2623
:param name: The name of the value
2624
:param section: The section the option is in (if any)
2625
:param default: The value to return if the value is not set
2626
:return: The value or default value
2629
configobj = self._get_configobj()
2631
section_obj = configobj
2634
section_obj = configobj[section]
2637
return section_obj.get(name, default)
2638
except errors.UnknownSmartMethod:
2639
return self._vfs_get_option(name, section, default)
2641
def _response_to_configobj(self, response):
2642
if len(response[0]) and response[0][0] != 'ok':
2643
raise errors.UnexpectedSmartServerResponse(response)
2644
lines = response[1].read_body_bytes().splitlines()
2645
return config.ConfigObj(lines, encoding='utf-8')
2648
class RemoteBranchConfig(RemoteConfig):
2649
"""A RemoteConfig for Branches."""
2651
def __init__(self, branch):
2652
self._branch = branch
2654
def _get_configobj(self):
2655
path = self._branch._remote_path()
2656
response = self._branch._client.call_expecting_body(
2657
'Branch.get_config_file', path)
2658
return self._response_to_configobj(response)
2660
def set_option(self, value, name, section=None):
2661
"""Set the value associated with a named option.
2663
:param value: The value to set
2664
:param name: The name of the value to set
2665
:param section: The section the option is in (if any)
2667
medium = self._branch._client._medium
2668
if medium._is_remote_before((1, 14)):
2669
return self._vfs_set_option(value, name, section)
2671
path = self._branch._remote_path()
2672
response = self._branch._client.call('Branch.set_config_option',
2673
path, self._branch._lock_token, self._branch._repo_lock_token,
2674
value.encode('utf8'), name, section or '')
2675
except errors.UnknownSmartMethod:
2676
medium._remember_remote_is_before((1, 14))
2677
return self._vfs_set_option(value, name, section)
2679
raise errors.UnexpectedSmartServerResponse(response)
2681
def _real_object(self):
2682
self._branch._ensure_real()
2683
return self._branch._real_branch
2685
def _vfs_set_option(self, value, name, section=None):
2686
return self._real_object()._get_config().set_option(
2687
value, name, section)
2690
class RemoteBzrDirConfig(RemoteConfig):
2691
"""A RemoteConfig for BzrDirs."""
2693
def __init__(self, bzrdir):
2694
self._bzrdir = bzrdir
2696
def _get_configobj(self):
2697
medium = self._bzrdir._client._medium
2698
verb = 'BzrDir.get_config_file'
2699
if medium._is_remote_before((1, 15)):
2700
raise errors.UnknownSmartMethod(verb)
2701
path = self._bzrdir._path_for_remote_call(self._bzrdir._client)
2702
response = self._bzrdir._call_expecting_body(
2704
return self._response_to_configobj(response)
2706
def _vfs_get_option(self, name, section, default):
2707
return self._real_object()._get_config().get_option(
2708
name, section, default)
2710
def set_option(self, value, name, section=None):
2711
"""Set the value associated with a named option.
2713
:param value: The value to set
2714
:param name: The name of the value to set
2715
:param section: The section the option is in (if any)
2717
return self._real_object()._get_config().set_option(
2718
value, name, section)
2720
def _real_object(self):
2721
self._bzrdir._ensure_real()
2722
return self._bzrdir._real_bzrdir
2726
def _extract_tar(tar, to_dir):
2727
"""Extract all the contents of a tarfile object.
2729
A replacement for extractall, which is not present in python2.4
2732
tar.extract(tarinfo, to_dir)
2735
def _translate_error(err, **context):
2736
"""Translate an ErrorFromSmartServer into a more useful error.
2738
Possible context keys:
2746
If the error from the server doesn't match a known pattern, then
2747
UnknownErrorFromSmartServer is raised.
2751
return context[name]
2752
except KeyError, key_err:
2753
mutter('Missing key %r in context %r', key_err.args[0], context)
2756
"""Get the path from the context if present, otherwise use first error
2760
return context['path']
2761
except KeyError, key_err:
2763
return err.error_args[0]
2764
except IndexError, idx_err:
2766
'Missing key %r in context %r', key_err.args[0], context)
2769
if err.error_verb == 'NoSuchRevision':
2770
raise NoSuchRevision(find('branch'), err.error_args[0])
2771
elif err.error_verb == 'nosuchrevision':
2772
raise NoSuchRevision(find('repository'), err.error_args[0])
2773
elif err.error_tuple == ('nobranch',):
2774
raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2775
elif err.error_verb == 'norepository':
2776
raise errors.NoRepositoryPresent(find('bzrdir'))
2777
elif err.error_verb == 'LockContention':
2778
raise errors.LockContention('(remote lock)')
2779
elif err.error_verb == 'UnlockableTransport':
2780
raise errors.UnlockableTransport(find('bzrdir').root_transport)
2781
elif err.error_verb == 'LockFailed':
2782
raise errors.LockFailed(err.error_args[0], err.error_args[1])
2783
elif err.error_verb == 'TokenMismatch':
2784
raise errors.TokenMismatch(find('token'), '(remote token)')
2785
elif err.error_verb == 'Diverged':
2786
raise errors.DivergedBranches(find('branch'), find('other_branch'))
2787
elif err.error_verb == 'TipChangeRejected':
2788
raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
2789
elif err.error_verb == 'UnstackableBranchFormat':
2790
raise errors.UnstackableBranchFormat(*err.error_args)
2791
elif err.error_verb == 'UnstackableRepositoryFormat':
2792
raise errors.UnstackableRepositoryFormat(*err.error_args)
2793
elif err.error_verb == 'NotStacked':
2794
raise errors.NotStacked(branch=find('branch'))
2795
elif err.error_verb == 'PermissionDenied':
2797
if len(err.error_args) >= 2:
2798
extra = err.error_args[1]
2801
raise errors.PermissionDenied(path, extra=extra)
2802
elif err.error_verb == 'ReadError':
2804
raise errors.ReadError(path)
2805
elif err.error_verb == 'NoSuchFile':
2807
raise errors.NoSuchFile(path)
2808
elif err.error_verb == 'FileExists':
2809
raise errors.FileExists(err.error_args[0])
2810
elif err.error_verb == 'DirectoryNotEmpty':
2811
raise errors.DirectoryNotEmpty(err.error_args[0])
2812
elif err.error_verb == 'ShortReadvError':
2813
args = err.error_args
2814
raise errors.ShortReadvError(
2815
args[0], int(args[1]), int(args[2]), int(args[3]))
2816
elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
2817
encoding = str(err.error_args[0]) # encoding must always be a string
2818
val = err.error_args[1]
2819
start = int(err.error_args[2])
2820
end = int(err.error_args[3])
2821
reason = str(err.error_args[4]) # reason must always be a string
2822
if val.startswith('u:'):
2823
val = val[2:].decode('utf-8')
2824
elif val.startswith('s:'):
2825
val = val[2:].decode('base64')
2826
if err.error_verb == 'UnicodeDecodeError':
2827
raise UnicodeDecodeError(encoding, val, start, end, reason)
2828
elif err.error_verb == 'UnicodeEncodeError':
2829
raise UnicodeEncodeError(encoding, val, start, end, reason)
2830
elif err.error_verb == 'ReadOnlyError':
2831
raise errors.TransportNotPossible('readonly transport')
2832
raise errors.UnknownErrorFromSmartServer(err)
added
removed
bzrlib/remote.py
