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
return "%s(_network_name=%r)" % (self.__class__.__name__,
439
def fast_deltas(self):
441
return self._custom_format.fast_deltas
444
def rich_root_data(self):
445
if self._rich_root_data is None:
447
self._rich_root_data = self._custom_format.rich_root_data
448
return self._rich_root_data
451
def supports_chks(self):
452
if self._supports_chks is None:
454
self._supports_chks = self._custom_format.supports_chks
455
return self._supports_chks
458
def supports_external_lookups(self):
459
if self._supports_external_lookups is None:
461
self._supports_external_lookups = \
462
self._custom_format.supports_external_lookups
463
return self._supports_external_lookups
466
def supports_tree_reference(self):
467
if self._supports_tree_reference is None:
469
self._supports_tree_reference = \
470
self._custom_format.supports_tree_reference
471
return self._supports_tree_reference
473
def _vfs_initialize(self, a_bzrdir, shared):
474
"""Helper for common code in initialize."""
475
if self._custom_format:
476
# Custom format requested
477
result = self._custom_format.initialize(a_bzrdir, shared=shared)
478
elif self._creating_bzrdir is not None:
479
# Use the format that the repository we were created to back
481
prior_repo = self._creating_bzrdir.open_repository()
482
prior_repo._ensure_real()
483
result = prior_repo._real_repository._format.initialize(
484
a_bzrdir, shared=shared)
486
# assume that a_bzr is a RemoteBzrDir but the smart server didn't
487
# support remote initialization.
488
# We delegate to a real object at this point (as RemoteBzrDir
489
# delegate to the repository format which would lead to infinite
490
# recursion if we just called a_bzrdir.create_repository.
491
a_bzrdir._ensure_real()
492
result = a_bzrdir._real_bzrdir.create_repository(shared=shared)
493
if not isinstance(result, RemoteRepository):
494
return self.open(a_bzrdir)
498
def initialize(self, a_bzrdir, shared=False):
499
# Being asked to create on a non RemoteBzrDir:
500
if not isinstance(a_bzrdir, RemoteBzrDir):
501
return self._vfs_initialize(a_bzrdir, shared)
502
medium = a_bzrdir._client._medium
503
if medium._is_remote_before((1, 13)):
504
return self._vfs_initialize(a_bzrdir, shared)
505
# Creating on a remote bzr dir.
506
# 1) get the network name to use.
507
if self._custom_format:
508
network_name = self._custom_format.network_name()
509
elif self._network_name:
510
network_name = self._network_name
512
# Select the current bzrlib default and ask for that.
513
reference_bzrdir_format = bzrdir.format_registry.get('default')()
514
reference_format = reference_bzrdir_format.repository_format
515
network_name = reference_format.network_name()
516
# 2) try direct creation via RPC
517
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
518
verb = 'BzrDir.create_repository'
524
response = a_bzrdir._call(verb, path, network_name, shared_str)
525
except errors.UnknownSmartMethod:
526
# Fallback - use vfs methods
527
medium._remember_remote_is_before((1, 13))
528
return self._vfs_initialize(a_bzrdir, shared)
530
# Turn the response into a RemoteRepository object.
531
format = response_tuple_to_repo_format(response[1:])
532
# Used to support creating a real format instance when needed.
533
format._creating_bzrdir = a_bzrdir
534
remote_repo = RemoteRepository(a_bzrdir, format)
535
format._creating_repo = remote_repo
538
def open(self, a_bzrdir):
539
if not isinstance(a_bzrdir, RemoteBzrDir):
540
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
541
return a_bzrdir.open_repository()
543
def _ensure_real(self):
544
if self._custom_format is None:
545
self._custom_format = repository.network_format_registry.get(
549
def _fetch_order(self):
551
return self._custom_format._fetch_order
554
def _fetch_uses_deltas(self):
556
return self._custom_format._fetch_uses_deltas
559
def _fetch_reconcile(self):
561
return self._custom_format._fetch_reconcile
563
def get_format_description(self):
564
return 'bzr remote repository'
566
def __eq__(self, other):
567
return self.__class__ is other.__class__
569
def network_name(self):
570
if self._network_name:
571
return self._network_name
572
self._creating_repo._ensure_real()
573
return self._creating_repo._real_repository._format.network_name()
576
def pack_compresses(self):
578
return self._custom_format.pack_compresses
581
def _serializer(self):
583
return self._custom_format._serializer
586
class RemoteRepository(_RpcHelper):
587
"""Repository accessed over rpc.
589
For the moment most operations are performed using local transport-backed
593
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
594
"""Create a RemoteRepository instance.
596
:param remote_bzrdir: The bzrdir hosting this repository.
597
:param format: The RemoteFormat object to use.
598
:param real_repository: If not None, a local implementation of the
599
repository logic for the repository, usually accessing the data
601
:param _client: Private testing parameter - override the smart client
602
to be used by the repository.
605
self._real_repository = real_repository
607
self._real_repository = None
608
self.bzrdir = remote_bzrdir
610
self._client = remote_bzrdir._client
612
self._client = _client
613
self._format = format
614
self._lock_mode = None
615
self._lock_token = None
617
self._leave_lock = False
618
# Cache of revision parents; misses are cached during read locks, and
619
# write locks when no _real_repository has been set.
620
self._unstacked_provider = graph.CachingParentsProvider(
621
get_parent_map=self._get_parent_map_rpc)
622
self._unstacked_provider.disable_cache()
624
# These depend on the actual remote format, so force them off for
625
# maximum compatibility. XXX: In future these should depend on the
626
# remote repository instance, but this is irrelevant until we perform
627
# reconcile via an RPC call.
628
self._reconcile_does_inventory_gc = False
629
self._reconcile_fixes_text_parents = False
630
self._reconcile_backsup_inventory = False
631
self.base = self.bzrdir.transport.base
632
# Additional places to query for data.
633
self._fallback_repositories = []
636
return "%s(%s)" % (self.__class__.__name__, self.base)
640
def abort_write_group(self, suppress_errors=False):
641
"""Complete a write group on the decorated repository.
643
Smart methods perform operations in a single step so this API
644
is not really applicable except as a compatibility thunk
645
for older plugins that don't use e.g. the CommitBuilder
648
:param suppress_errors: see Repository.abort_write_group.
651
return self._real_repository.abort_write_group(
652
suppress_errors=suppress_errors)
656
"""Decorate the real repository for now.
658
In the long term a full blown network facility is needed to avoid
659
creating a real repository object locally.
662
return self._real_repository.chk_bytes
664
def commit_write_group(self):
665
"""Complete a write group on the decorated repository.
667
Smart methods perform operations in a single step so this API
668
is not really applicable except as a compatibility thunk
669
for older plugins that don't use e.g. the CommitBuilder
673
return self._real_repository.commit_write_group()
675
def resume_write_group(self, tokens):
677
return self._real_repository.resume_write_group(tokens)
679
def suspend_write_group(self):
681
return self._real_repository.suspend_write_group()
683
def get_missing_parent_inventories(self, check_for_missing_texts=True):
685
return self._real_repository.get_missing_parent_inventories(
686
check_for_missing_texts=check_for_missing_texts)
688
def _get_rev_id_for_revno_vfs(self, revno, known_pair):
690
return self._real_repository.get_rev_id_for_revno(
693
def get_rev_id_for_revno(self, revno, known_pair):
694
"""See Repository.get_rev_id_for_revno."""
695
path = self.bzrdir._path_for_remote_call(self._client)
697
if self._client._medium._is_remote_before((1, 17)):
698
return self._get_rev_id_for_revno_vfs(revno, known_pair)
699
response = self._call(
700
'Repository.get_rev_id_for_revno', path, revno, known_pair)
701
except errors.UnknownSmartMethod:
702
self._client._medium._remember_remote_is_before((1, 17))
703
return self._get_rev_id_for_revno_vfs(revno, known_pair)
704
if response[0] == 'ok':
705
return True, response[1]
706
elif response[0] == 'history-incomplete':
707
known_pair = response[1:3]
708
for fallback in self._fallback_repositories:
709
found, result = fallback.get_rev_id_for_revno(revno, known_pair)
714
# Not found in any fallbacks
715
return False, known_pair
717
raise errors.UnexpectedSmartServerResponse(response)
719
def _ensure_real(self):
720
"""Ensure that there is a _real_repository set.
722
Used before calls to self._real_repository.
724
Note that _ensure_real causes many roundtrips to the server which are
725
not desirable, and prevents the use of smart one-roundtrip RPC's to
726
perform complex operations (such as accessing parent data, streaming
727
revisions etc). Adding calls to _ensure_real should only be done when
728
bringing up new functionality, adding fallbacks for smart methods that
729
require a fallback path, and never to replace an existing smart method
730
invocation. If in doubt chat to the bzr network team.
732
if self._real_repository is None:
733
if 'hpssvfs' in debug.debug_flags:
735
warning('VFS Repository access triggered\n%s',
736
''.join(traceback.format_stack()))
737
self._unstacked_provider.missing_keys.clear()
738
self.bzrdir._ensure_real()
739
self._set_real_repository(
740
self.bzrdir._real_bzrdir.open_repository())
742
def _translate_error(self, err, **context):
743
self.bzrdir._translate_error(err, repository=self, **context)
745
def find_text_key_references(self):
746
"""Find the text key references within the repository.
748
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
749
revision_ids. Each altered file-ids has the exact revision_ids that
750
altered it listed explicitly.
751
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
752
to whether they were referred to by the inventory of the
753
revision_id that they contain. The inventory texts from all present
754
revision ids are assessed to generate this report.
757
return self._real_repository.find_text_key_references()
759
def _generate_text_key_index(self):
760
"""Generate a new text key index for the repository.
762
This is an expensive function that will take considerable time to run.
764
:return: A dict mapping (file_id, revision_id) tuples to a list of
765
parents, also (file_id, revision_id) tuples.
768
return self._real_repository._generate_text_key_index()
770
def _get_revision_graph(self, revision_id):
771
"""Private method for using with old (< 1.2) servers to fallback."""
772
if revision_id is None:
774
elif revision.is_null(revision_id):
777
path = self.bzrdir._path_for_remote_call(self._client)
778
response = self._call_expecting_body(
779
'Repository.get_revision_graph', path, revision_id)
780
response_tuple, response_handler = response
781
if response_tuple[0] != 'ok':
782
raise errors.UnexpectedSmartServerResponse(response_tuple)
783
coded = response_handler.read_body_bytes()
785
# no revisions in this repository!
787
lines = coded.split('\n')
790
d = tuple(line.split())
791
revision_graph[d[0]] = d[1:]
793
return revision_graph
796
"""See Repository._get_sink()."""
797
return RemoteStreamSink(self)
799
def _get_source(self, to_format):
800
"""Return a source for streaming from this repository."""
801
return RemoteStreamSource(self, to_format)
804
def has_revision(self, revision_id):
805
"""True if this repository has a copy of the revision."""
806
# Copy of bzrlib.repository.Repository.has_revision
807
return revision_id in self.has_revisions((revision_id,))
810
def has_revisions(self, revision_ids):
811
"""Probe to find out the presence of multiple revisions.
813
:param revision_ids: An iterable of revision_ids.
814
:return: A set of the revision_ids that were present.
816
# Copy of bzrlib.repository.Repository.has_revisions
817
parent_map = self.get_parent_map(revision_ids)
818
result = set(parent_map)
819
if _mod_revision.NULL_REVISION in revision_ids:
820
result.add(_mod_revision.NULL_REVISION)
823
def _has_same_fallbacks(self, other_repo):
824
"""Returns true if the repositories have the same fallbacks."""
825
# XXX: copied from Repository; it should be unified into a base class
826
# <https://bugs.edge.launchpad.net/bzr/+bug/401622>
827
my_fb = self._fallback_repositories
828
other_fb = other_repo._fallback_repositories
829
if len(my_fb) != len(other_fb):
831
for f, g in zip(my_fb, other_fb):
832
if not f.has_same_location(g):
836
def has_same_location(self, other):
837
# TODO: Move to RepositoryBase and unify with the regular Repository
838
# one; unfortunately the tests rely on slightly different behaviour at
839
# present -- mbp 20090710
840
return (self.__class__ is other.__class__ and
841
self.bzrdir.transport.base == other.bzrdir.transport.base)
843
def get_graph(self, other_repository=None):
844
"""Return the graph for this repository format"""
845
parents_provider = self._make_parents_provider(other_repository)
846
return graph.Graph(parents_provider)
848
def gather_stats(self, revid=None, committers=None):
849
"""See Repository.gather_stats()."""
850
path = self.bzrdir._path_for_remote_call(self._client)
851
# revid can be None to indicate no revisions, not just NULL_REVISION
852
if revid is None or revision.is_null(revid):
856
if committers is None or not committers:
857
fmt_committers = 'no'
859
fmt_committers = 'yes'
860
response_tuple, response_handler = self._call_expecting_body(
861
'Repository.gather_stats', path, fmt_revid, fmt_committers)
862
if response_tuple[0] != 'ok':
863
raise errors.UnexpectedSmartServerResponse(response_tuple)
865
body = response_handler.read_body_bytes()
867
for line in body.split('\n'):
870
key, val_text = line.split(':')
871
if key in ('revisions', 'size', 'committers'):
872
result[key] = int(val_text)
873
elif key in ('firstrev', 'latestrev'):
874
values = val_text.split(' ')[1:]
875
result[key] = (float(values[0]), long(values[1]))
879
def find_branches(self, using=False):
880
"""See Repository.find_branches()."""
881
# should be an API call to the server.
883
return self._real_repository.find_branches(using=using)
885
def get_physical_lock_status(self):
886
"""See Repository.get_physical_lock_status()."""
887
# should be an API call to the server.
889
return self._real_repository.get_physical_lock_status()
891
def is_in_write_group(self):
892
"""Return True if there is an open write group.
894
write groups are only applicable locally for the smart server..
896
if self._real_repository:
897
return self._real_repository.is_in_write_group()
900
return self._lock_count >= 1
903
"""See Repository.is_shared()."""
904
path = self.bzrdir._path_for_remote_call(self._client)
905
response = self._call('Repository.is_shared', path)
906
if response[0] not in ('yes', 'no'):
907
raise SmartProtocolError('unexpected response code %s' % (response,))
908
return response[0] == 'yes'
910
def is_write_locked(self):
911
return self._lock_mode == 'w'
914
# wrong eventually - want a local lock cache context
915
if not self._lock_mode:
916
self._lock_mode = 'r'
918
self._unstacked_provider.enable_cache(cache_misses=True)
919
if self._real_repository is not None:
920
self._real_repository.lock_read()
921
for repo in self._fallback_repositories:
924
self._lock_count += 1
926
def _remote_lock_write(self, token):
927
path = self.bzrdir._path_for_remote_call(self._client)
930
err_context = {'token': token}
931
response = self._call('Repository.lock_write', path, token,
933
if response[0] == 'ok':
937
raise errors.UnexpectedSmartServerResponse(response)
939
def lock_write(self, token=None, _skip_rpc=False):
940
if not self._lock_mode:
942
if self._lock_token is not None:
943
if token != self._lock_token:
944
raise errors.TokenMismatch(token, self._lock_token)
945
self._lock_token = token
947
self._lock_token = self._remote_lock_write(token)
948
# if self._lock_token is None, then this is something like packs or
949
# svn where we don't get to lock the repo, or a weave style repository
950
# where we cannot lock it over the wire and attempts to do so will
952
if self._real_repository is not None:
953
self._real_repository.lock_write(token=self._lock_token)
954
if token is not None:
955
self._leave_lock = True
957
self._leave_lock = False
958
self._lock_mode = 'w'
960
cache_misses = self._real_repository is None
961
self._unstacked_provider.enable_cache(cache_misses=cache_misses)
962
for repo in self._fallback_repositories:
963
# Writes don't affect fallback repos
965
elif self._lock_mode == 'r':
966
raise errors.ReadOnlyError(self)
968
self._lock_count += 1
969
return self._lock_token or None
971
def leave_lock_in_place(self):
972
if not self._lock_token:
973
raise NotImplementedError(self.leave_lock_in_place)
974
self._leave_lock = True
976
def dont_leave_lock_in_place(self):
977
if not self._lock_token:
978
raise NotImplementedError(self.dont_leave_lock_in_place)
979
self._leave_lock = False
981
def _set_real_repository(self, repository):
982
"""Set the _real_repository for this repository.
984
:param repository: The repository to fallback to for non-hpss
985
implemented operations.
987
if self._real_repository is not None:
988
# Replacing an already set real repository.
989
# We cannot do this [currently] if the repository is locked -
990
# synchronised state might be lost.
992
raise AssertionError('_real_repository is already set')
993
if isinstance(repository, RemoteRepository):
994
raise AssertionError()
995
self._real_repository = repository
996
# three code paths happen here:
997
# 1) old servers, RemoteBranch.open() calls _ensure_real before setting
998
# up stacking. In this case self._fallback_repositories is [], and the
999
# real repo is already setup. Preserve the real repo and
1000
# RemoteRepository.add_fallback_repository will avoid adding
1002
# 2) new servers, RemoteBranch.open() sets up stacking, and when
1003
# ensure_real is triggered from a branch, the real repository to
1004
# set already has a matching list with separate instances, but
1005
# as they are also RemoteRepositories we don't worry about making the
1006
# lists be identical.
1007
# 3) new servers, RemoteRepository.ensure_real is triggered before
1008
# RemoteBranch.ensure real, in this case we get a repo with no fallbacks
1009
# and need to populate it.
1010
if (self._fallback_repositories and
1011
len(self._real_repository._fallback_repositories) !=
1012
len(self._fallback_repositories)):
1013
if len(self._real_repository._fallback_repositories):
1014
raise AssertionError(
1015
"cannot cleanly remove existing _fallback_repositories")
1016
for fb in self._fallback_repositories:
1017
self._real_repository.add_fallback_repository(fb)
1018
if self._lock_mode == 'w':
1019
# if we are already locked, the real repository must be able to
1020
# acquire the lock with our token.
1021
self._real_repository.lock_write(self._lock_token)
1022
elif self._lock_mode == 'r':
1023
self._real_repository.lock_read()
1025
def start_write_group(self):
1026
"""Start a write group on the decorated repository.
1028
Smart methods perform operations in a single step so this API
1029
is not really applicable except as a compatibility thunk
1030
for older plugins that don't use e.g. the CommitBuilder
1034
return self._real_repository.start_write_group()
1036
def _unlock(self, token):
1037
path = self.bzrdir._path_for_remote_call(self._client)
1039
# with no token the remote repository is not persistently locked.
1041
err_context = {'token': token}
1042
response = self._call('Repository.unlock', path, token,
1044
if response == ('ok',):
1047
raise errors.UnexpectedSmartServerResponse(response)
1050
if not self._lock_count:
1051
return lock.cant_unlock_not_held(self)
1052
self._lock_count -= 1
1053
if self._lock_count > 0:
1055
self._unstacked_provider.disable_cache()
1056
old_mode = self._lock_mode
1057
self._lock_mode = None
1059
# The real repository is responsible at present for raising an
1060
# exception if it's in an unfinished write group. However, it
1061
# normally will *not* actually remove the lock from disk - that's
1062
# done by the server on receiving the Repository.unlock call.
1063
# This is just to let the _real_repository stay up to date.
1064
if self._real_repository is not None:
1065
self._real_repository.unlock()
1067
# The rpc-level lock should be released even if there was a
1068
# problem releasing the vfs-based lock.
1070
# Only write-locked repositories need to make a remote method
1071
# call to perform the unlock.
1072
old_token = self._lock_token
1073
self._lock_token = None
1074
if not self._leave_lock:
1075
self._unlock(old_token)
1076
# Fallbacks are always 'lock_read()' so we don't pay attention to
1078
for repo in self._fallback_repositories:
1081
def break_lock(self):
1082
# should hand off to the network
1084
return self._real_repository.break_lock()
1086
def _get_tarball(self, compression):
1087
"""Return a TemporaryFile containing a repository tarball.
1089
Returns None if the server does not support sending tarballs.
1092
path = self.bzrdir._path_for_remote_call(self._client)
1094
response, protocol = self._call_expecting_body(
1095
'Repository.tarball', path, compression)
1096
except errors.UnknownSmartMethod:
1097
protocol.cancel_read_body()
1099
if response[0] == 'ok':
1100
# Extract the tarball and return it
1101
t = tempfile.NamedTemporaryFile()
1102
# TODO: rpc layer should read directly into it...
1103
t.write(protocol.read_body_bytes())
1106
raise errors.UnexpectedSmartServerResponse(response)
1108
def sprout(self, to_bzrdir, revision_id=None):
1109
# TODO: Option to control what format is created?
1111
dest_repo = self._real_repository._format.initialize(to_bzrdir,
1113
dest_repo.fetch(self, revision_id=revision_id)
1116
### These methods are just thin shims to the VFS object for now.
1118
def revision_tree(self, revision_id):
1120
return self._real_repository.revision_tree(revision_id)
1122
def get_serializer_format(self):
1124
return self._real_repository.get_serializer_format()
1126
def get_commit_builder(self, branch, parents, config, timestamp=None,
1127
timezone=None, committer=None, revprops=None,
1129
# FIXME: It ought to be possible to call this without immediately
1130
# triggering _ensure_real. For now it's the easiest thing to do.
1132
real_repo = self._real_repository
1133
builder = real_repo.get_commit_builder(branch, parents,
1134
config, timestamp=timestamp, timezone=timezone,
1135
committer=committer, revprops=revprops, revision_id=revision_id)
1138
def add_fallback_repository(self, repository):
1139
"""Add a repository to use for looking up data not held locally.
1141
:param repository: A repository.
1143
if not self._format.supports_external_lookups:
1144
raise errors.UnstackableRepositoryFormat(
1145
self._format.network_name(), self.base)
1146
# We need to accumulate additional repositories here, to pass them in
1149
if self.is_locked():
1150
# We will call fallback.unlock() when we transition to the unlocked
1151
# state, so always add a lock here. If a caller passes us a locked
1152
# repository, they are responsible for unlocking it later.
1153
repository.lock_read()
1154
self._fallback_repositories.append(repository)
1155
# If self._real_repository was parameterised already (e.g. because a
1156
# _real_branch had its get_stacked_on_url method called), then the
1157
# repository to be added may already be in the _real_repositories list.
1158
if self._real_repository is not None:
1159
fallback_locations = [repo.bzrdir.root_transport.base for repo in
1160
self._real_repository._fallback_repositories]
1161
if repository.bzrdir.root_transport.base not in fallback_locations:
1162
self._real_repository.add_fallback_repository(repository)
1164
def add_inventory(self, revid, inv, parents):
1166
return self._real_repository.add_inventory(revid, inv, parents)
1168
def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1171
return self._real_repository.add_inventory_by_delta(basis_revision_id,
1172
delta, new_revision_id, parents)
1174
def add_revision(self, rev_id, rev, inv=None, config=None):
1176
return self._real_repository.add_revision(
1177
rev_id, rev, inv=inv, config=config)
1180
def get_inventory(self, revision_id):
1182
return self._real_repository.get_inventory(revision_id)
1184
def iter_inventories(self, revision_ids, ordering=None):
1186
return self._real_repository.iter_inventories(revision_ids, ordering)
1189
def get_revision(self, revision_id):
1191
return self._real_repository.get_revision(revision_id)
1193
def get_transaction(self):
1195
return self._real_repository.get_transaction()
1198
def clone(self, a_bzrdir, revision_id=None):
1200
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
1202
def make_working_trees(self):
1203
"""See Repository.make_working_trees"""
1205
return self._real_repository.make_working_trees()
1207
def refresh_data(self):
1208
"""Re-read any data needed to to synchronise with disk.
1210
This method is intended to be called after another repository instance
1211
(such as one used by a smart server) has inserted data into the
1212
repository. It may not be called during a write group, but may be
1213
called at any other time.
1215
if self.is_in_write_group():
1216
raise errors.InternalBzrError(
1217
"May not refresh_data while in a write group.")
1218
if self._real_repository is not None:
1219
self._real_repository.refresh_data()
1221
def revision_ids_to_search_result(self, result_set):
1222
"""Convert a set of revision ids to a graph SearchResult."""
1223
result_parents = set()
1224
for parents in self.get_graph().get_parent_map(
1225
result_set).itervalues():
1226
result_parents.update(parents)
1227
included_keys = result_set.intersection(result_parents)
1228
start_keys = result_set.difference(included_keys)
1229
exclude_keys = result_parents.difference(result_set)
1230
result = graph.SearchResult(start_keys, exclude_keys,
1231
len(result_set), result_set)
1235
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1236
"""Return the revision ids that other has that this does not.
1238
These are returned in topological order.
1240
revision_id: only return revision ids included by revision_id.
1242
return repository.InterRepository.get(
1243
other, self).search_missing_revision_ids(revision_id, find_ghosts)
1245
def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1247
# No base implementation to use as RemoteRepository is not a subclass
1248
# of Repository; so this is a copy of Repository.fetch().
1249
if fetch_spec is not None and revision_id is not None:
1250
raise AssertionError(
1251
"fetch_spec and revision_id are mutually exclusive.")
1252
if self.is_in_write_group():
1253
raise errors.InternalBzrError(
1254
"May not fetch while in a write group.")
1255
# fast path same-url fetch operations
1256
if (self.has_same_location(source)
1257
and fetch_spec is None
1258
and self._has_same_fallbacks(source)):
1259
# check that last_revision is in 'from' and then return a
1261
if (revision_id is not None and
1262
not revision.is_null(revision_id)):
1263
self.get_revision(revision_id)
1265
# if there is no specific appropriate InterRepository, this will get
1266
# the InterRepository base class, which raises an
1267
# IncompatibleRepositories when asked to fetch.
1268
inter = repository.InterRepository.get(source, self)
1269
return inter.fetch(revision_id=revision_id, pb=pb,
1270
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1272
def create_bundle(self, target, base, fileobj, format=None):
1274
self._real_repository.create_bundle(target, base, fileobj, format)
1277
def get_ancestry(self, revision_id, topo_sorted=True):
1279
return self._real_repository.get_ancestry(revision_id, topo_sorted)
1281
def fileids_altered_by_revision_ids(self, revision_ids):
1283
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
1285
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
1287
return self._real_repository._get_versioned_file_checker(
1288
revisions, revision_versions_cache)
1290
def iter_files_bytes(self, desired_files):
1291
"""See Repository.iter_file_bytes.
1294
return self._real_repository.iter_files_bytes(desired_files)
1296
def get_parent_map(self, revision_ids):
1297
"""See bzrlib.Graph.get_parent_map()."""
1298
return self._make_parents_provider().get_parent_map(revision_ids)
1300
def _get_parent_map_rpc(self, keys):
1301
"""Helper for get_parent_map that performs the RPC."""
1302
medium = self._client._medium
1303
if medium._is_remote_before((1, 2)):
1304
# We already found out that the server can't understand
1305
# Repository.get_parent_map requests, so just fetch the whole
1308
# Note that this reads the whole graph, when only some keys are
1309
# wanted. On this old server there's no way (?) to get them all
1310
# in one go, and the user probably will have seen a warning about
1311
# the server being old anyhow.
1312
rg = self._get_revision_graph(None)
1313
# There is an API discrepancy between get_parent_map and
1314
# get_revision_graph. Specifically, a "key:()" pair in
1315
# get_revision_graph just means a node has no parents. For
1316
# "get_parent_map" it means the node is a ghost. So fix up the
1317
# graph to correct this.
1318
# https://bugs.launchpad.net/bzr/+bug/214894
1319
# There is one other "bug" which is that ghosts in
1320
# get_revision_graph() are not returned at all. But we won't worry
1321
# about that for now.
1322
for node_id, parent_ids in rg.iteritems():
1323
if parent_ids == ():
1324
rg[node_id] = (NULL_REVISION,)
1325
rg[NULL_REVISION] = ()
1330
raise ValueError('get_parent_map(None) is not valid')
1331
if NULL_REVISION in keys:
1332
keys.discard(NULL_REVISION)
1333
found_parents = {NULL_REVISION:()}
1335
return found_parents
1338
# TODO(Needs analysis): We could assume that the keys being requested
1339
# from get_parent_map are in a breadth first search, so typically they
1340
# will all be depth N from some common parent, and we don't have to
1341
# have the server iterate from the root parent, but rather from the
1342
# keys we're searching; and just tell the server the keyspace we
1343
# already have; but this may be more traffic again.
1345
# Transform self._parents_map into a search request recipe.
1346
# TODO: Manage this incrementally to avoid covering the same path
1347
# repeatedly. (The server will have to on each request, but the less
1348
# work done the better).
1350
# Negative caching notes:
1351
# new server sends missing when a request including the revid
1352
# 'include-missing:' is present in the request.
1353
# missing keys are serialised as missing:X, and we then call
1354
# provider.note_missing(X) for-all X
1355
parents_map = self._unstacked_provider.get_cached_map()
1356
if parents_map is None:
1357
# Repository is not locked, so there's no cache.
1359
# start_set is all the keys in the cache
1360
start_set = set(parents_map)
1361
# result set is all the references to keys in the cache
1362
result_parents = set()
1363
for parents in parents_map.itervalues():
1364
result_parents.update(parents)
1365
stop_keys = result_parents.difference(start_set)
1366
# We don't need to send ghosts back to the server as a position to
1368
stop_keys.difference_update(self._unstacked_provider.missing_keys)
1369
key_count = len(parents_map)
1370
if (NULL_REVISION in result_parents
1371
and NULL_REVISION in self._unstacked_provider.missing_keys):
1372
# If we pruned NULL_REVISION from the stop_keys because it's also
1373
# in our cache of "missing" keys we need to increment our key count
1374
# by 1, because the reconsitituted SearchResult on the server will
1375
# still consider NULL_REVISION to be an included key.
1377
included_keys = start_set.intersection(result_parents)
1378
start_set.difference_update(included_keys)
1379
recipe = ('manual', start_set, stop_keys, key_count)
1380
body = self._serialise_search_recipe(recipe)
1381
path = self.bzrdir._path_for_remote_call(self._client)
1383
if type(key) is not str:
1385
"key %r not a plain string" % (key,))
1386
verb = 'Repository.get_parent_map'
1387
args = (path, 'include-missing:') + tuple(keys)
1389
response = self._call_with_body_bytes_expecting_body(
1391
except errors.UnknownSmartMethod:
1392
# Server does not support this method, so get the whole graph.
1393
# Worse, we have to force a disconnection, because the server now
1394
# doesn't realise it has a body on the wire to consume, so the
1395
# only way to recover is to abandon the connection.
1397
'Server is too old for fast get_parent_map, reconnecting. '
1398
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1400
# To avoid having to disconnect repeatedly, we keep track of the
1401
# fact the server doesn't understand remote methods added in 1.2.
1402
medium._remember_remote_is_before((1, 2))
1403
# Recurse just once and we should use the fallback code.
1404
return self._get_parent_map_rpc(keys)
1405
response_tuple, response_handler = response
1406
if response_tuple[0] not in ['ok']:
1407
response_handler.cancel_read_body()
1408
raise errors.UnexpectedSmartServerResponse(response_tuple)
1409
if response_tuple[0] == 'ok':
1410
coded = bz2.decompress(response_handler.read_body_bytes())
1412
# no revisions found
1414
lines = coded.split('\n')
1417
d = tuple(line.split())
1419
revision_graph[d[0]] = d[1:]
1422
if d[0].startswith('missing:'):
1424
self._unstacked_provider.note_missing_key(revid)
1426
# no parents - so give the Graph result
1428
revision_graph[d[0]] = (NULL_REVISION,)
1429
return revision_graph
1432
def get_signature_text(self, revision_id):
1434
return self._real_repository.get_signature_text(revision_id)
1437
def get_inventory_xml(self, revision_id):
1439
return self._real_repository.get_inventory_xml(revision_id)
1441
def deserialise_inventory(self, revision_id, xml):
1443
return self._real_repository.deserialise_inventory(revision_id, xml)
1445
def reconcile(self, other=None, thorough=False):
1447
return self._real_repository.reconcile(other=other, thorough=thorough)
1449
def all_revision_ids(self):
1451
return self._real_repository.all_revision_ids()
1454
def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1456
return self._real_repository.get_deltas_for_revisions(revisions,
1457
specific_fileids=specific_fileids)
1460
def get_revision_delta(self, revision_id, specific_fileids=None):
1462
return self._real_repository.get_revision_delta(revision_id,
1463
specific_fileids=specific_fileids)
1466
def revision_trees(self, revision_ids):
1468
return self._real_repository.revision_trees(revision_ids)
1471
def get_revision_reconcile(self, revision_id):
1473
return self._real_repository.get_revision_reconcile(revision_id)
1476
def check(self, revision_ids=None, callback_refs=None, check_repo=True):
1478
return self._real_repository.check(revision_ids=revision_ids,
1479
callback_refs=callback_refs, check_repo=check_repo)
1481
def copy_content_into(self, destination, revision_id=None):
1483
return self._real_repository.copy_content_into(
1484
destination, revision_id=revision_id)
1486
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
1487
# get a tarball of the remote repository, and copy from that into the
1489
from bzrlib import osutils
1491
# TODO: Maybe a progress bar while streaming the tarball?
1492
note("Copying repository content as tarball...")
1493
tar_file = self._get_tarball('bz2')
1494
if tar_file is None:
1496
destination = to_bzrdir.create_repository()
1498
tar = tarfile.open('repository', fileobj=tar_file,
1500
tmpdir = osutils.mkdtemp()
1502
_extract_tar(tar, tmpdir)
1503
tmp_bzrdir = BzrDir.open(tmpdir)
1504
tmp_repo = tmp_bzrdir.open_repository()
1505
tmp_repo.copy_content_into(destination, revision_id)
1507
osutils.rmtree(tmpdir)
1511
# TODO: Suggestion from john: using external tar is much faster than
1512
# python's tarfile library, but it may not work on windows.
1515
def inventories(self):
1516
"""Decorate the real repository for now.
1518
In the long term a full blown network facility is needed to
1519
avoid creating a real repository object locally.
1522
return self._real_repository.inventories
1525
def pack(self, hint=None):
1526
"""Compress the data within the repository.
1528
This is not currently implemented within the smart server.
1531
return self._real_repository.pack(hint=hint)
1534
def revisions(self):
1535
"""Decorate the real repository for now.
1537
In the short term this should become a real object to intercept graph
1540
In the long term a full blown network facility is needed.
1543
return self._real_repository.revisions
1545
def set_make_working_trees(self, new_value):
1547
new_value_str = "True"
1549
new_value_str = "False"
1550
path = self.bzrdir._path_for_remote_call(self._client)
1552
response = self._call(
1553
'Repository.set_make_working_trees', path, new_value_str)
1554
except errors.UnknownSmartMethod:
1556
self._real_repository.set_make_working_trees(new_value)
1558
if response[0] != 'ok':
1559
raise errors.UnexpectedSmartServerResponse(response)
1562
def signatures(self):
1563
"""Decorate the real repository for now.
1565
In the long term a full blown network facility is needed to avoid
1566
creating a real repository object locally.
1569
return self._real_repository.signatures
1572
def sign_revision(self, revision_id, gpg_strategy):
1574
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1578
"""Decorate the real repository for now.
1580
In the long term a full blown network facility is needed to avoid
1581
creating a real repository object locally.
1584
return self._real_repository.texts
1587
def get_revisions(self, revision_ids):
1589
return self._real_repository.get_revisions(revision_ids)
1591
def supports_rich_root(self):
1592
return self._format.rich_root_data
1594
def iter_reverse_revision_history(self, revision_id):
1596
return self._real_repository.iter_reverse_revision_history(revision_id)
1599
def _serializer(self):
1600
return self._format._serializer
1602
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1604
return self._real_repository.store_revision_signature(
1605
gpg_strategy, plaintext, revision_id)
1607
def add_signature_text(self, revision_id, signature):
1609
return self._real_repository.add_signature_text(revision_id, signature)
1611
def has_signature_for_revision_id(self, revision_id):
1613
return self._real_repository.has_signature_for_revision_id(revision_id)
1615
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1617
return self._real_repository.item_keys_introduced_by(revision_ids,
1618
_files_pb=_files_pb)
1620
def revision_graph_can_have_wrong_parents(self):
1621
# The answer depends on the remote repo format.
1623
return self._real_repository.revision_graph_can_have_wrong_parents()
1625
def _find_inconsistent_revision_parents(self, revisions_iterator=None):
1627
return self._real_repository._find_inconsistent_revision_parents(
1630
def _check_for_inconsistent_revision_parents(self):
1632
return self._real_repository._check_for_inconsistent_revision_parents()
1634
def _make_parents_provider(self, other=None):
1635
providers = [self._unstacked_provider]
1636
if other is not None:
1637
providers.insert(0, other)
1638
providers.extend(r._make_parents_provider() for r in
1639
self._fallback_repositories)
1640
return graph.StackedParentsProvider(providers)
1642
def _serialise_search_recipe(self, recipe):
1643
"""Serialise a graph search recipe.
1645
:param recipe: A search recipe (start, stop, count).
1646
:return: Serialised bytes.
1648
start_keys = ' '.join(recipe[1])
1649
stop_keys = ' '.join(recipe[2])
1650
count = str(recipe[3])
1651
return '\n'.join((start_keys, stop_keys, count))
1653
def _serialise_search_result(self, search_result):
1654
if isinstance(search_result, graph.PendingAncestryResult):
1655
parts = ['ancestry-of']
1656
parts.extend(search_result.heads)
1658
recipe = search_result.get_recipe()
1659
parts = [recipe[0], self._serialise_search_recipe(recipe)]
1660
return '\n'.join(parts)
1663
path = self.bzrdir._path_for_remote_call(self._client)
1665
response = self._call('PackRepository.autopack', path)
1666
except errors.UnknownSmartMethod:
1668
self._real_repository._pack_collection.autopack()
1671
if response[0] != 'ok':
1672
raise errors.UnexpectedSmartServerResponse(response)
1675
class RemoteStreamSink(repository.StreamSink):
1677
def _insert_real(self, stream, src_format, resume_tokens):
1678
self.target_repo._ensure_real()
1679
sink = self.target_repo._real_repository._get_sink()
1680
result = sink.insert_stream(stream, src_format, resume_tokens)
1682
self.target_repo.autopack()
1685
def insert_stream(self, stream, src_format, resume_tokens):
1686
target = self.target_repo
1687
target._unstacked_provider.missing_keys.clear()
1688
candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
1689
if target._lock_token:
1690
candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
1691
lock_args = (target._lock_token or '',)
1693
candidate_calls.append(('Repository.insert_stream', (1, 13)))
1695
client = target._client
1696
medium = client._medium
1697
path = target.bzrdir._path_for_remote_call(client)
1698
# Probe for the verb to use with an empty stream before sending the
1699
# real stream to it. We do this both to avoid the risk of sending a
1700
# large request that is then rejected, and because we don't want to
1701
# implement a way to buffer, rewind, or restart the stream.
1703
for verb, required_version in candidate_calls:
1704
if medium._is_remote_before(required_version):
1707
# We've already done the probing (and set _is_remote_before) on
1708
# a previous insert.
1711
byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1713
response = client.call_with_body_stream(
1714
(verb, path, '') + lock_args, byte_stream)
1715
except errors.UnknownSmartMethod:
1716
medium._remember_remote_is_before(required_version)
1722
return self._insert_real(stream, src_format, resume_tokens)
1723
self._last_inv_record = None
1724
self._last_substream = None
1725
if required_version < (1, 19):
1726
# Remote side doesn't support inventory deltas. Wrap the stream to
1727
# make sure we don't send any. If the stream contains inventory
1728
# deltas we'll interrupt the smart insert_stream request and
1730
stream = self._stop_stream_if_inventory_delta(stream)
1731
byte_stream = smart_repo._stream_to_byte_stream(
1733
resume_tokens = ' '.join(resume_tokens)
1734
response = client.call_with_body_stream(
1735
(verb, path, resume_tokens) + lock_args, byte_stream)
1736
if response[0][0] not in ('ok', 'missing-basis'):
1737
raise errors.UnexpectedSmartServerResponse(response)
1738
if self._last_substream is not None:
1739
# The stream included an inventory-delta record, but the remote
1740
# side isn't new enough to support them. So we need to send the
1741
# rest of the stream via VFS.
1742
self.target_repo.refresh_data()
1743
return self._resume_stream_with_vfs(response, src_format)
1744
if response[0][0] == 'missing-basis':
1745
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1746
resume_tokens = tokens
1747
return resume_tokens, set(missing_keys)
1749
self.target_repo.refresh_data()
1752
def _resume_stream_with_vfs(self, response, src_format):
1753
"""Resume sending a stream via VFS, first resending the record and
1754
substream that couldn't be sent via an insert_stream verb.
1756
if response[0][0] == 'missing-basis':
1757
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1758
# Ignore missing_keys, we haven't finished inserting yet
1761
def resume_substream():
1762
# Yield the substream that was interrupted.
1763
for record in self._last_substream:
1765
self._last_substream = None
1766
def resume_stream():
1767
# Finish sending the interrupted substream
1768
yield ('inventory-deltas', resume_substream())
1769
# Then simply continue sending the rest of the stream.
1770
for substream_kind, substream in self._last_stream:
1771
yield substream_kind, substream
1772
return self._insert_real(resume_stream(), src_format, tokens)
1774
def _stop_stream_if_inventory_delta(self, stream):
1775
"""Normally this just lets the original stream pass-through unchanged.
1777
However if any 'inventory-deltas' substream occurs it will stop
1778
streaming, and store the interrupted substream and stream in
1779
self._last_substream and self._last_stream so that the stream can be
1780
resumed by _resume_stream_with_vfs.
1783
stream_iter = iter(stream)
1784
for substream_kind, substream in stream_iter:
1785
if substream_kind == 'inventory-deltas':
1786
self._last_substream = substream
1787
self._last_stream = stream_iter
1790
yield substream_kind, substream
1793
class RemoteStreamSource(repository.StreamSource):
1794
"""Stream data from a remote server."""
1796
def get_stream(self, search):
1797
if (self.from_repository._fallback_repositories and
1798
self.to_format._fetch_order == 'topological'):
1799
return self._real_stream(self.from_repository, search)
1802
repos = [self.from_repository]
1808
repos.extend(repo._fallback_repositories)
1809
sources.append(repo)
1810
return self.missing_parents_chain(search, sources)
1812
def get_stream_for_missing_keys(self, missing_keys):
1813
self.from_repository._ensure_real()
1814
real_repo = self.from_repository._real_repository
1815
real_source = real_repo._get_source(self.to_format)
1816
return real_source.get_stream_for_missing_keys(missing_keys)
1818
def _real_stream(self, repo, search):
1819
"""Get a stream for search from repo.
1821
This never called RemoteStreamSource.get_stream, and is a heler
1822
for RemoteStreamSource._get_stream to allow getting a stream
1823
reliably whether fallback back because of old servers or trying
1824
to stream from a non-RemoteRepository (which the stacked support
1827
source = repo._get_source(self.to_format)
1828
if isinstance(source, RemoteStreamSource):
1830
source = repo._real_repository._get_source(self.to_format)
1831
return source.get_stream(search)
1833
def _get_stream(self, repo, search):
1834
"""Core worker to get a stream from repo for search.
1836
This is used by both get_stream and the stacking support logic. It
1837
deliberately gets a stream for repo which does not need to be
1838
self.from_repository. In the event that repo is not Remote, or
1839
cannot do a smart stream, a fallback is made to the generic
1840
repository._get_stream() interface, via self._real_stream.
1842
In the event of stacking, streams from _get_stream will not
1843
contain all the data for search - this is normal (see get_stream).
1845
:param repo: A repository.
1846
:param search: A search.
1848
# Fallbacks may be non-smart
1849
if not isinstance(repo, RemoteRepository):
1850
return self._real_stream(repo, search)
1851
client = repo._client
1852
medium = client._medium
1853
path = repo.bzrdir._path_for_remote_call(client)
1854
search_bytes = repo._serialise_search_result(search)
1855
args = (path, self.to_format.network_name())
1857
('Repository.get_stream_1.19', (1, 19)),
1858
('Repository.get_stream', (1, 13))]
1860
for verb, version in candidate_verbs:
1861
if medium._is_remote_before(version):
1864
response = repo._call_with_body_bytes_expecting_body(
1865
verb, args, search_bytes)
1866
except errors.UnknownSmartMethod:
1867
medium._remember_remote_is_before(version)
1869
response_tuple, response_handler = response
1873
return self._real_stream(repo, search)
1874
if response_tuple[0] != 'ok':
1875
raise errors.UnexpectedSmartServerResponse(response_tuple)
1876
byte_stream = response_handler.read_streamed_body()
1877
src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
1878
if src_format.network_name() != repo._format.network_name():
1879
raise AssertionError(
1880
"Mismatched RemoteRepository and stream src %r, %r" % (
1881
src_format.network_name(), repo._format.network_name()))
1884
def missing_parents_chain(self, search, sources):
1885
"""Chain multiple streams together to handle stacking.
1887
:param search: The overall search to satisfy with streams.
1888
:param sources: A list of Repository objects to query.
1890
self.serialiser = self.to_format._serializer
1891
self.seen_revs = set()
1892
self.referenced_revs = set()
1893
# If there are heads in the search, or the key count is > 0, we are not
1895
while not search.is_empty() and len(sources) > 1:
1896
source = sources.pop(0)
1897
stream = self._get_stream(source, search)
1898
for kind, substream in stream:
1899
if kind != 'revisions':
1900
yield kind, substream
1902
yield kind, self.missing_parents_rev_handler(substream)
1903
search = search.refine(self.seen_revs, self.referenced_revs)
1904
self.seen_revs = set()
1905
self.referenced_revs = set()
1906
if not search.is_empty():
1907
for kind, stream in self._get_stream(sources[0], search):
1910
def missing_parents_rev_handler(self, substream):
1911
for content in substream:
1912
revision_bytes = content.get_bytes_as('fulltext')
1913
revision = self.serialiser.read_revision_from_string(revision_bytes)
1914
self.seen_revs.add(content.key[-1])
1915
self.referenced_revs.update(revision.parent_ids)
1919
class RemoteBranchLockableFiles(LockableFiles):
1920
"""A 'LockableFiles' implementation that talks to a smart server.
1922
This is not a public interface class.
1925
def __init__(self, bzrdir, _client):
1926
self.bzrdir = bzrdir
1927
self._client = _client
1928
self._need_find_modes = True
1929
LockableFiles.__init__(
1930
self, bzrdir.get_branch_transport(None),
1931
'lock', lockdir.LockDir)
1933
def _find_modes(self):
1934
# RemoteBranches don't let the client set the mode of control files.
1935
self._dir_mode = None
1936
self._file_mode = None
1939
class RemoteBranchFormat(branch.BranchFormat):
1941
def __init__(self, network_name=None):
1942
super(RemoteBranchFormat, self).__init__()
1943
self._matchingbzrdir = RemoteBzrDirFormat()
1944
self._matchingbzrdir.set_branch_format(self)
1945
self._custom_format = None
1946
self._network_name = network_name
1948
def __eq__(self, other):
1949
return (isinstance(other, RemoteBranchFormat) and
1950
self.__dict__ == other.__dict__)
1952
def _ensure_real(self):
1953
if self._custom_format is None:
1954
self._custom_format = branch.network_format_registry.get(
1957
def get_format_description(self):
1958
return 'Remote BZR Branch'
1960
def network_name(self):
1961
return self._network_name
1963
def open(self, a_bzrdir, ignore_fallbacks=False):
1964
return a_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1966
def _vfs_initialize(self, a_bzrdir):
1967
# Initialisation when using a local bzrdir object, or a non-vfs init
1968
# method is not available on the server.
1969
# self._custom_format is always set - the start of initialize ensures
1971
if isinstance(a_bzrdir, RemoteBzrDir):
1972
a_bzrdir._ensure_real()
1973
result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
1975
# We assume the bzrdir is parameterised; it may not be.
1976
result = self._custom_format.initialize(a_bzrdir)
1977
if (isinstance(a_bzrdir, RemoteBzrDir) and
1978
not isinstance(result, RemoteBranch)):
1979
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
1982
def initialize(self, a_bzrdir):
1983
# 1) get the network name to use.
1984
if self._custom_format:
1985
network_name = self._custom_format.network_name()
1987
# Select the current bzrlib default and ask for that.
1988
reference_bzrdir_format = bzrdir.format_registry.get('default')()
1989
reference_format = reference_bzrdir_format.get_branch_format()
1990
self._custom_format = reference_format
1991
network_name = reference_format.network_name()
1992
# Being asked to create on a non RemoteBzrDir:
1993
if not isinstance(a_bzrdir, RemoteBzrDir):
1994
return self._vfs_initialize(a_bzrdir)
1995
medium = a_bzrdir._client._medium
1996
if medium._is_remote_before((1, 13)):
1997
return self._vfs_initialize(a_bzrdir)
1998
# Creating on a remote bzr dir.
1999
# 2) try direct creation via RPC
2000
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2001
verb = 'BzrDir.create_branch'
2003
response = a_bzrdir._call(verb, path, network_name)
2004
except errors.UnknownSmartMethod:
2005
# Fallback - use vfs methods
2006
medium._remember_remote_is_before((1, 13))
2007
return self._vfs_initialize(a_bzrdir)
2008
if response[0] != 'ok':
2009
raise errors.UnexpectedSmartServerResponse(response)
2010
# Turn the response into a RemoteRepository object.
2011
format = RemoteBranchFormat(network_name=response[1])
2012
repo_format = response_tuple_to_repo_format(response[3:])
2013
if response[2] == '':
2014
repo_bzrdir = a_bzrdir
2016
repo_bzrdir = RemoteBzrDir(
2017
a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
2019
remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2020
remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2021
format=format, setup_stacking=False)
2022
# XXX: We know this is a new branch, so it must have revno 0, revid
2023
# NULL_REVISION. Creating the branch locked would make this be unable
2024
# to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2025
remote_branch._last_revision_info_cache = 0, NULL_REVISION
2026
return remote_branch
2028
def make_tags(self, branch):
2030
return self._custom_format.make_tags(branch)
2032
def supports_tags(self):
2033
# Remote branches might support tags, but we won't know until we
2034
# access the real remote branch.
2036
return self._custom_format.supports_tags()
2038
def supports_stacking(self):
2040
return self._custom_format.supports_stacking()
2042
def supports_set_append_revisions_only(self):
2044
return self._custom_format.supports_set_append_revisions_only()
2047
class RemoteBranch(branch.Branch, _RpcHelper):
2048
"""Branch stored on a server accessed by HPSS RPC.
2050
At the moment most operations are mapped down to simple file operations.
2053
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2054
_client=None, format=None, setup_stacking=True):
2055
"""Create a RemoteBranch instance.
2057
:param real_branch: An optional local implementation of the branch
2058
format, usually accessing the data via the VFS.
2059
:param _client: Private parameter for testing.
2060
:param format: A RemoteBranchFormat object, None to create one
2061
automatically. If supplied it should have a network_name already
2063
:param setup_stacking: If True make an RPC call to determine the
2064
stacked (or not) status of the branch. If False assume the branch
2067
# We intentionally don't call the parent class's __init__, because it
2068
# will try to assign to self.tags, which is a property in this subclass.
2069
# And the parent's __init__ doesn't do much anyway.
2070
self.bzrdir = remote_bzrdir
2071
if _client is not None:
2072
self._client = _client
2074
self._client = remote_bzrdir._client
2075
self.repository = remote_repository
2076
if real_branch is not None:
2077
self._real_branch = real_branch
2078
# Give the remote repository the matching real repo.
2079
real_repo = self._real_branch.repository
2080
if isinstance(real_repo, RemoteRepository):
2081
real_repo._ensure_real()
2082
real_repo = real_repo._real_repository
2083
self.repository._set_real_repository(real_repo)
2084
# Give the branch the remote repository to let fast-pathing happen.
2085
self._real_branch.repository = self.repository
2087
self._real_branch = None
2088
# Fill out expected attributes of branch for bzrlib API users.
2089
self._clear_cached_state()
2090
self.base = self.bzrdir.root_transport.base
2091
self._control_files = None
2092
self._lock_mode = None
2093
self._lock_token = None
2094
self._repo_lock_token = None
2095
self._lock_count = 0
2096
self._leave_lock = False
2097
# Setup a format: note that we cannot call _ensure_real until all the
2098
# attributes above are set: This code cannot be moved higher up in this
2101
self._format = RemoteBranchFormat()
2102
if real_branch is not None:
2103
self._format._network_name = \
2104
self._real_branch._format.network_name()
2106
self._format = format
2107
# when we do _ensure_real we may need to pass ignore_fallbacks to the
2108
# branch.open_branch method.
2109
self._real_ignore_fallbacks = not setup_stacking
2110
if not self._format._network_name:
2111
# Did not get from open_branchV2 - old server.
2113
self._format._network_name = \
2114
self._real_branch._format.network_name()
2115
self.tags = self._format.make_tags(self)
2116
# The base class init is not called, so we duplicate this:
2117
hooks = branch.Branch.hooks['open']
2120
self._is_stacked = False
2122
self._setup_stacking()
2124
def _setup_stacking(self):
2125
# configure stacking into the remote repository, by reading it from
2128
fallback_url = self.get_stacked_on_url()
2129
except (errors.NotStacked, errors.UnstackableBranchFormat,
2130
errors.UnstackableRepositoryFormat), e:
2132
self._is_stacked = True
2133
self._activate_fallback_location(fallback_url)
2135
def _get_config(self):
2136
return RemoteBranchConfig(self)
2138
def _get_real_transport(self):
2139
# if we try vfs access, return the real branch's vfs transport
2141
return self._real_branch._transport
2143
_transport = property(_get_real_transport)
2146
return "%s(%s)" % (self.__class__.__name__, self.base)
2150
def _ensure_real(self):
2151
"""Ensure that there is a _real_branch set.
2153
Used before calls to self._real_branch.
2155
if self._real_branch is None:
2156
if not vfs.vfs_enabled():
2157
raise AssertionError('smart server vfs must be enabled '
2158
'to use vfs implementation')
2159
self.bzrdir._ensure_real()
2160
self._real_branch = self.bzrdir._real_bzrdir.open_branch(
2161
ignore_fallbacks=self._real_ignore_fallbacks)
2162
if self.repository._real_repository is None:
2163
# Give the remote repository the matching real repo.
2164
real_repo = self._real_branch.repository
2165
if isinstance(real_repo, RemoteRepository):
2166
real_repo._ensure_real()
2167
real_repo = real_repo._real_repository
2168
self.repository._set_real_repository(real_repo)
2169
# Give the real branch the remote repository to let fast-pathing
2171
self._real_branch.repository = self.repository
2172
if self._lock_mode == 'r':
2173
self._real_branch.lock_read()
2174
elif self._lock_mode == 'w':
2175
self._real_branch.lock_write(token=self._lock_token)
2177
def _translate_error(self, err, **context):
2178
self.repository._translate_error(err, branch=self, **context)
2180
def _clear_cached_state(self):
2181
super(RemoteBranch, self)._clear_cached_state()
2182
if self._real_branch is not None:
2183
self._real_branch._clear_cached_state()
2185
def _clear_cached_state_of_remote_branch_only(self):
2186
"""Like _clear_cached_state, but doesn't clear the cache of
2189
This is useful when falling back to calling a method of
2190
self._real_branch that changes state. In that case the underlying
2191
branch changes, so we need to invalidate this RemoteBranch's cache of
2192
it. However, there's no need to invalidate the _real_branch's cache
2193
too, in fact doing so might harm performance.
2195
super(RemoteBranch, self)._clear_cached_state()
2198
def control_files(self):
2199
# Defer actually creating RemoteBranchLockableFiles until its needed,
2200
# because it triggers an _ensure_real that we otherwise might not need.
2201
if self._control_files is None:
2202
self._control_files = RemoteBranchLockableFiles(
2203
self.bzrdir, self._client)
2204
return self._control_files
2206
def _get_checkout_format(self):
2208
return self._real_branch._get_checkout_format()
2210
def get_physical_lock_status(self):
2211
"""See Branch.get_physical_lock_status()."""
2212
# should be an API call to the server, as branches must be lockable.
2214
return self._real_branch.get_physical_lock_status()
2216
def get_stacked_on_url(self):
2217
"""Get the URL this branch is stacked against.
2219
:raises NotStacked: If the branch is not stacked.
2220
:raises UnstackableBranchFormat: If the branch does not support
2222
:raises UnstackableRepositoryFormat: If the repository does not support
2226
# there may not be a repository yet, so we can't use
2227
# self._translate_error, so we can't use self._call either.
2228
response = self._client.call('Branch.get_stacked_on_url',
2229
self._remote_path())
2230
except errors.ErrorFromSmartServer, err:
2231
# there may not be a repository yet, so we can't call through
2232
# its _translate_error
2233
_translate_error(err, branch=self)
2234
except errors.UnknownSmartMethod, err:
2236
return self._real_branch.get_stacked_on_url()
2237
if response[0] != 'ok':
2238
raise errors.UnexpectedSmartServerResponse(response)
2241
def set_stacked_on_url(self, url):
2242
branch.Branch.set_stacked_on_url(self, url)
2244
self._is_stacked = False
2246
self._is_stacked = True
2248
def _vfs_get_tags_bytes(self):
2250
return self._real_branch._get_tags_bytes()
2252
def _get_tags_bytes(self):
2253
medium = self._client._medium
2254
if medium._is_remote_before((1, 13)):
2255
return self._vfs_get_tags_bytes()
2257
response = self._call('Branch.get_tags_bytes', self._remote_path())
2258
except errors.UnknownSmartMethod:
2259
medium._remember_remote_is_before((1, 13))
2260
return self._vfs_get_tags_bytes()
2263
def _vfs_set_tags_bytes(self, bytes):
2265
return self._real_branch._set_tags_bytes(bytes)
2267
def _set_tags_bytes(self, bytes):
2268
medium = self._client._medium
2269
if medium._is_remote_before((1, 18)):
2270
self._vfs_set_tags_bytes(bytes)
2274
self._remote_path(), self._lock_token, self._repo_lock_token)
2275
response = self._call_with_body_bytes(
2276
'Branch.set_tags_bytes', args, bytes)
2277
except errors.UnknownSmartMethod:
2278
medium._remember_remote_is_before((1, 18))
2279
self._vfs_set_tags_bytes(bytes)
2281
def lock_read(self):
2282
self.repository.lock_read()
2283
if not self._lock_mode:
2284
self._lock_mode = 'r'
2285
self._lock_count = 1
2286
if self._real_branch is not None:
2287
self._real_branch.lock_read()
2289
self._lock_count += 1
2291
def _remote_lock_write(self, token):
2293
branch_token = repo_token = ''
2295
branch_token = token
2296
repo_token = self.repository.lock_write()
2297
self.repository.unlock()
2298
err_context = {'token': token}
2299
response = self._call(
2300
'Branch.lock_write', self._remote_path(), branch_token,
2301
repo_token or '', **err_context)
2302
if response[0] != 'ok':
2303
raise errors.UnexpectedSmartServerResponse(response)
2304
ok, branch_token, repo_token = response
2305
return branch_token, repo_token
2307
def lock_write(self, token=None):
2308
if not self._lock_mode:
2309
# Lock the branch and repo in one remote call.
2310
remote_tokens = self._remote_lock_write(token)
2311
self._lock_token, self._repo_lock_token = remote_tokens
2312
if not self._lock_token:
2313
raise SmartProtocolError('Remote server did not return a token!')
2314
# Tell the self.repository object that it is locked.
2315
self.repository.lock_write(
2316
self._repo_lock_token, _skip_rpc=True)
2318
if self._real_branch is not None:
2319
self._real_branch.lock_write(token=self._lock_token)
2320
if token is not None:
2321
self._leave_lock = True
2323
self._leave_lock = False
2324
self._lock_mode = 'w'
2325
self._lock_count = 1
2326
elif self._lock_mode == 'r':
2327
raise errors.ReadOnlyTransaction
2329
if token is not None:
2330
# A token was given to lock_write, and we're relocking, so
2331
# check that the given token actually matches the one we
2333
if token != self._lock_token:
2334
raise errors.TokenMismatch(token, self._lock_token)
2335
self._lock_count += 1
2336
# Re-lock the repository too.
2337
self.repository.lock_write(self._repo_lock_token)
2338
return self._lock_token or None
2340
def _unlock(self, branch_token, repo_token):
2341
err_context = {'token': str((branch_token, repo_token))}
2342
response = self._call(
2343
'Branch.unlock', self._remote_path(), branch_token,
2344
repo_token or '', **err_context)
2345
if response == ('ok',):
2347
raise errors.UnexpectedSmartServerResponse(response)
2351
self._lock_count -= 1
2352
if not self._lock_count:
2353
self._clear_cached_state()
2354
mode = self._lock_mode
2355
self._lock_mode = None
2356
if self._real_branch is not None:
2357
if (not self._leave_lock and mode == 'w' and
2358
self._repo_lock_token):
2359
# If this RemoteBranch will remove the physical lock
2360
# for the repository, make sure the _real_branch
2361
# doesn't do it first. (Because the _real_branch's
2362
# repository is set to be the RemoteRepository.)
2363
self._real_branch.repository.leave_lock_in_place()
2364
self._real_branch.unlock()
2366
# Only write-locked branched need to make a remote method
2367
# call to perform the unlock.
2369
if not self._lock_token:
2370
raise AssertionError('Locked, but no token!')
2371
branch_token = self._lock_token
2372
repo_token = self._repo_lock_token
2373
self._lock_token = None
2374
self._repo_lock_token = None
2375
if not self._leave_lock:
2376
self._unlock(branch_token, repo_token)
2378
self.repository.unlock()
2380
def break_lock(self):
2382
return self._real_branch.break_lock()
2384
def leave_lock_in_place(self):
2385
if not self._lock_token:
2386
raise NotImplementedError(self.leave_lock_in_place)
2387
self._leave_lock = True
2389
def dont_leave_lock_in_place(self):
2390
if not self._lock_token:
2391
raise NotImplementedError(self.dont_leave_lock_in_place)
2392
self._leave_lock = False
2394
def get_rev_id(self, revno, history=None):
2396
return _mod_revision.NULL_REVISION
2397
last_revision_info = self.last_revision_info()
2398
ok, result = self.repository.get_rev_id_for_revno(
2399
revno, last_revision_info)
2402
missing_parent = result[1]
2403
# Either the revision named by the server is missing, or its parent
2404
# is. Call get_parent_map to determine which, so that we report a
2406
parent_map = self.repository.get_parent_map([missing_parent])
2407
if missing_parent in parent_map:
2408
missing_parent = parent_map[missing_parent]
2409
raise errors.RevisionNotPresent(missing_parent, self.repository)
2411
def _last_revision_info(self):
2412
response = self._call('Branch.last_revision_info', self._remote_path())
2413
if response[0] != 'ok':
2414
raise SmartProtocolError('unexpected response code %s' % (response,))
2415
revno = int(response[1])
2416
last_revision = response[2]
2417
return (revno, last_revision)
2419
def _gen_revision_history(self):
2420
"""See Branch._gen_revision_history()."""
2421
if self._is_stacked:
2423
return self._real_branch._gen_revision_history()
2424
response_tuple, response_handler = self._call_expecting_body(
2425
'Branch.revision_history', self._remote_path())
2426
if response_tuple[0] != 'ok':
2427
raise errors.UnexpectedSmartServerResponse(response_tuple)
2428
result = response_handler.read_body_bytes().split('\x00')
2433
def _remote_path(self):
2434
return self.bzrdir._path_for_remote_call(self._client)
2436
def _set_last_revision_descendant(self, revision_id, other_branch,
2437
allow_diverged=False, allow_overwrite_descendant=False):
2438
# This performs additional work to meet the hook contract; while its
2439
# undesirable, we have to synthesise the revno to call the hook, and
2440
# not calling the hook is worse as it means changes can't be prevented.
2441
# Having calculated this though, we can't just call into
2442
# set_last_revision_info as a simple call, because there is a set_rh
2443
# hook that some folk may still be using.
2444
old_revno, old_revid = self.last_revision_info()
2445
history = self._lefthand_history(revision_id)
2446
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2447
err_context = {'other_branch': other_branch}
2448
response = self._call('Branch.set_last_revision_ex',
2449
self._remote_path(), self._lock_token, self._repo_lock_token,
2450
revision_id, int(allow_diverged), int(allow_overwrite_descendant),
2452
self._clear_cached_state()
2453
if len(response) != 3 and response[0] != 'ok':
2454
raise errors.UnexpectedSmartServerResponse(response)
2455
new_revno, new_revision_id = response[1:]
2456
self._last_revision_info_cache = new_revno, new_revision_id
2457
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2458
if self._real_branch is not None:
2459
cache = new_revno, new_revision_id
2460
self._real_branch._last_revision_info_cache = cache
2462
def _set_last_revision(self, revision_id):
2463
old_revno, old_revid = self.last_revision_info()
2464
# This performs additional work to meet the hook contract; while its
2465
# undesirable, we have to synthesise the revno to call the hook, and
2466
# not calling the hook is worse as it means changes can't be prevented.
2467
# Having calculated this though, we can't just call into
2468
# set_last_revision_info as a simple call, because there is a set_rh
2469
# hook that some folk may still be using.
2470
history = self._lefthand_history(revision_id)
2471
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2472
self._clear_cached_state()
2473
response = self._call('Branch.set_last_revision',
2474
self._remote_path(), self._lock_token, self._repo_lock_token,
2476
if response != ('ok',):
2477
raise errors.UnexpectedSmartServerResponse(response)
2478
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2481
def set_revision_history(self, rev_history):
2482
# Send just the tip revision of the history; the server will generate
2483
# the full history from that. If the revision doesn't exist in this
2484
# branch, NoSuchRevision will be raised.
2485
if rev_history == []:
2488
rev_id = rev_history[-1]
2489
self._set_last_revision(rev_id)
2490
for hook in branch.Branch.hooks['set_rh']:
2491
hook(self, rev_history)
2492
self._cache_revision_history(rev_history)
2494
def _get_parent_location(self):
2495
medium = self._client._medium
2496
if medium._is_remote_before((1, 13)):
2497
return self._vfs_get_parent_location()
2499
response = self._call('Branch.get_parent', self._remote_path())
2500
except errors.UnknownSmartMethod:
2501
medium._remember_remote_is_before((1, 13))
2502
return self._vfs_get_parent_location()
2503
if len(response) != 1:
2504
raise errors.UnexpectedSmartServerResponse(response)
2505
parent_location = response[0]
2506
if parent_location == '':
2508
return parent_location
2510
def _vfs_get_parent_location(self):
2512
return self._real_branch._get_parent_location()
2514
def _set_parent_location(self, url):
2515
medium = self._client._medium
2516
if medium._is_remote_before((1, 15)):
2517
return self._vfs_set_parent_location(url)
2519
call_url = url or ''
2520
if type(call_url) is not str:
2521
raise AssertionError('url must be a str or None (%s)' % url)
2522
response = self._call('Branch.set_parent_location',
2523
self._remote_path(), self._lock_token, self._repo_lock_token,
2525
except errors.UnknownSmartMethod:
2526
medium._remember_remote_is_before((1, 15))
2527
return self._vfs_set_parent_location(url)
2529
raise errors.UnexpectedSmartServerResponse(response)
2531
def _vfs_set_parent_location(self, url):
2533
return self._real_branch._set_parent_location(url)
2536
def pull(self, source, overwrite=False, stop_revision=None,
2538
self._clear_cached_state_of_remote_branch_only()
2540
return self._real_branch.pull(
2541
source, overwrite=overwrite, stop_revision=stop_revision,
2542
_override_hook_target=self, **kwargs)
2545
def push(self, target, overwrite=False, stop_revision=None):
2547
return self._real_branch.push(
2548
target, overwrite=overwrite, stop_revision=stop_revision,
2549
_override_hook_source_branch=self)
2551
def is_locked(self):
2552
return self._lock_count >= 1
2555
def revision_id_to_revno(self, revision_id):
2557
return self._real_branch.revision_id_to_revno(revision_id)
2560
def set_last_revision_info(self, revno, revision_id):
2561
# XXX: These should be returned by the set_last_revision_info verb
2562
old_revno, old_revid = self.last_revision_info()
2563
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2564
revision_id = ensure_null(revision_id)
2566
response = self._call('Branch.set_last_revision_info',
2567
self._remote_path(), self._lock_token, self._repo_lock_token,
2568
str(revno), revision_id)
2569
except errors.UnknownSmartMethod:
2571
self._clear_cached_state_of_remote_branch_only()
2572
self._real_branch.set_last_revision_info(revno, revision_id)
2573
self._last_revision_info_cache = revno, revision_id
2575
if response == ('ok',):
2576
self._clear_cached_state()
2577
self._last_revision_info_cache = revno, revision_id
2578
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2579
# Update the _real_branch's cache too.
2580
if self._real_branch is not None:
2581
cache = self._last_revision_info_cache
2582
self._real_branch._last_revision_info_cache = cache
2584
raise errors.UnexpectedSmartServerResponse(response)
2587
def generate_revision_history(self, revision_id, last_rev=None,
2589
medium = self._client._medium
2590
if not medium._is_remote_before((1, 6)):
2591
# Use a smart method for 1.6 and above servers
2593
self._set_last_revision_descendant(revision_id, other_branch,
2594
allow_diverged=True, allow_overwrite_descendant=True)
2596
except errors.UnknownSmartMethod:
2597
medium._remember_remote_is_before((1, 6))
2598
self._clear_cached_state_of_remote_branch_only()
2599
self.set_revision_history(self._lefthand_history(revision_id,
2600
last_rev=last_rev,other_branch=other_branch))
2602
def set_push_location(self, location):
2604
return self._real_branch.set_push_location(location)
2607
class RemoteConfig(object):
2608
"""A Config that reads and writes from smart verbs.
2610
It is a low-level object that considers config data to be name/value pairs
2611
that may be associated with a section. Assigning meaning to the these
2612
values is done at higher levels like bzrlib.config.TreeConfig.
2615
def get_option(self, name, section=None, default=None):
2616
"""Return the value associated with a named option.
2618
:param name: The name of the value
2619
:param section: The section the option is in (if any)
2620
:param default: The value to return if the value is not set
2621
:return: The value or default value
2624
configobj = self._get_configobj()
2626
section_obj = configobj
2629
section_obj = configobj[section]
2632
return section_obj.get(name, default)
2633
except errors.UnknownSmartMethod:
2634
return self._vfs_get_option(name, section, default)
2636
def _response_to_configobj(self, response):
2637
if len(response[0]) and response[0][0] != 'ok':
2638
raise errors.UnexpectedSmartServerResponse(response)
2639
lines = response[1].read_body_bytes().splitlines()
2640
return config.ConfigObj(lines, encoding='utf-8')
2643
class RemoteBranchConfig(RemoteConfig):
2644
"""A RemoteConfig for Branches."""
2646
def __init__(self, branch):
2647
self._branch = branch
2649
def _get_configobj(self):
2650
path = self._branch._remote_path()
2651
response = self._branch._client.call_expecting_body(
2652
'Branch.get_config_file', path)
2653
return self._response_to_configobj(response)
2655
def set_option(self, value, name, section=None):
2656
"""Set the value associated with a named option.
2658
:param value: The value to set
2659
:param name: The name of the value to set
2660
:param section: The section the option is in (if any)
2662
medium = self._branch._client._medium
2663
if medium._is_remote_before((1, 14)):
2664
return self._vfs_set_option(value, name, section)
2666
path = self._branch._remote_path()
2667
response = self._branch._client.call('Branch.set_config_option',
2668
path, self._branch._lock_token, self._branch._repo_lock_token,
2669
value.encode('utf8'), name, section or '')
2670
except errors.UnknownSmartMethod:
2671
medium._remember_remote_is_before((1, 14))
2672
return self._vfs_set_option(value, name, section)
2674
raise errors.UnexpectedSmartServerResponse(response)
2676
def _real_object(self):
2677
self._branch._ensure_real()
2678
return self._branch._real_branch
2680
def _vfs_set_option(self, value, name, section=None):
2681
return self._real_object()._get_config().set_option(
2682
value, name, section)
2685
class RemoteBzrDirConfig(RemoteConfig):
2686
"""A RemoteConfig for BzrDirs."""
2688
def __init__(self, bzrdir):
2689
self._bzrdir = bzrdir
2691
def _get_configobj(self):
2692
medium = self._bzrdir._client._medium
2693
verb = 'BzrDir.get_config_file'
2694
if medium._is_remote_before((1, 15)):
2695
raise errors.UnknownSmartMethod(verb)
2696
path = self._bzrdir._path_for_remote_call(self._bzrdir._client)
2697
response = self._bzrdir._call_expecting_body(
2699
return self._response_to_configobj(response)
2701
def _vfs_get_option(self, name, section, default):
2702
return self._real_object()._get_config().get_option(
2703
name, section, default)
2705
def set_option(self, value, name, section=None):
2706
"""Set the value associated with a named option.
2708
:param value: The value to set
2709
:param name: The name of the value to set
2710
:param section: The section the option is in (if any)
2712
return self._real_object()._get_config().set_option(
2713
value, name, section)
2715
def _real_object(self):
2716
self._bzrdir._ensure_real()
2717
return self._bzrdir._real_bzrdir
2721
def _extract_tar(tar, to_dir):
2722
"""Extract all the contents of a tarfile object.
2724
A replacement for extractall, which is not present in python2.4
2727
tar.extract(tarinfo, to_dir)
2730
def _translate_error(err, **context):
2731
"""Translate an ErrorFromSmartServer into a more useful error.
2733
Possible context keys:
2741
If the error from the server doesn't match a known pattern, then
2742
UnknownErrorFromSmartServer is raised.
2746
return context[name]
2747
except KeyError, key_err:
2748
mutter('Missing key %r in context %r', key_err.args[0], context)
2751
"""Get the path from the context if present, otherwise use first error
2755
return context['path']
2756
except KeyError, key_err:
2758
return err.error_args[0]
2759
except IndexError, idx_err:
2761
'Missing key %r in context %r', key_err.args[0], context)
2764
if err.error_verb == 'IncompatibleRepositories':
2765
raise errors.IncompatibleRepositories(err.error_args[0],
2766
err.error_args[1], err.error_args[2])
2767
elif err.error_verb == 'NoSuchRevision':
2768
raise NoSuchRevision(find('branch'), err.error_args[0])
2769
elif err.error_verb == 'nosuchrevision':
2770
raise NoSuchRevision(find('repository'), err.error_args[0])
2771
elif err.error_tuple == ('nobranch',):
2772
raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2773
elif err.error_verb == 'norepository':
2774
raise errors.NoRepositoryPresent(find('bzrdir'))
2775
elif err.error_verb == 'LockContention':
2776
raise errors.LockContention('(remote lock)')
2777
elif err.error_verb == 'UnlockableTransport':
2778
raise errors.UnlockableTransport(find('bzrdir').root_transport)
2779
elif err.error_verb == 'LockFailed':
2780
raise errors.LockFailed(err.error_args[0], err.error_args[1])
2781
elif err.error_verb == 'TokenMismatch':
2782
raise errors.TokenMismatch(find('token'), '(remote token)')
2783
elif err.error_verb == 'Diverged':
2784
raise errors.DivergedBranches(find('branch'), find('other_branch'))
2785
elif err.error_verb == 'TipChangeRejected':
2786
raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
2787
elif err.error_verb == 'UnstackableBranchFormat':
2788
raise errors.UnstackableBranchFormat(*err.error_args)
2789
elif err.error_verb == 'UnstackableRepositoryFormat':
2790
raise errors.UnstackableRepositoryFormat(*err.error_args)
2791
elif err.error_verb == 'NotStacked':
2792
raise errors.NotStacked(branch=find('branch'))
2793
elif err.error_verb == 'PermissionDenied':
2795
if len(err.error_args) >= 2:
2796
extra = err.error_args[1]
2799
raise errors.PermissionDenied(path, extra=extra)
2800
elif err.error_verb == 'ReadError':
2802
raise errors.ReadError(path)
2803
elif err.error_verb == 'NoSuchFile':
2805
raise errors.NoSuchFile(path)
2806
elif err.error_verb == 'FileExists':
2807
raise errors.FileExists(err.error_args[0])
2808
elif err.error_verb == 'DirectoryNotEmpty':
2809
raise errors.DirectoryNotEmpty(err.error_args[0])
2810
elif err.error_verb == 'ShortReadvError':
2811
args = err.error_args
2812
raise errors.ShortReadvError(
2813
args[0], int(args[1]), int(args[2]), int(args[3]))
2814
elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
2815
encoding = str(err.error_args[0]) # encoding must always be a string
2816
val = err.error_args[1]
2817
start = int(err.error_args[2])
2818
end = int(err.error_args[3])
2819
reason = str(err.error_args[4]) # reason must always be a string
2820
if val.startswith('u:'):
2821
val = val[2:].decode('utf-8')
2822
elif val.startswith('s:'):
2823
val = val[2:].decode('base64')
2824
if err.error_verb == 'UnicodeDecodeError':
2825
raise UnicodeDecodeError(encoding, val, start, end, reason)
2826
elif err.error_verb == 'UnicodeEncodeError':
2827
raise UnicodeEncodeError(encoding, val, start, end, reason)
2828
elif err.error_verb == 'ReadOnlyError':
2829
raise errors.TransportNotPossible('readonly transport')
2830
raise errors.UnknownErrorFromSmartServer(err)
added
removed
bzrlib/remote.py
