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_external_lookups = None
430
self._supports_tree_reference = None
431
self._rich_root_data = None
434
def fast_deltas(self):
436
return self._custom_format.fast_deltas
439
def rich_root_data(self):
440
if self._rich_root_data is None:
442
self._rich_root_data = self._custom_format.rich_root_data
443
return self._rich_root_data
446
def supports_external_lookups(self):
447
if self._supports_external_lookups is None:
449
self._supports_external_lookups = \
450
self._custom_format.supports_external_lookups
451
return self._supports_external_lookups
454
def supports_tree_reference(self):
455
if self._supports_tree_reference is None:
457
self._supports_tree_reference = \
458
self._custom_format.supports_tree_reference
459
return self._supports_tree_reference
461
def _vfs_initialize(self, a_bzrdir, shared):
462
"""Helper for common code in initialize."""
463
if self._custom_format:
464
# Custom format requested
465
result = self._custom_format.initialize(a_bzrdir, shared=shared)
466
elif self._creating_bzrdir is not None:
467
# Use the format that the repository we were created to back
469
prior_repo = self._creating_bzrdir.open_repository()
470
prior_repo._ensure_real()
471
result = prior_repo._real_repository._format.initialize(
472
a_bzrdir, shared=shared)
474
# assume that a_bzr is a RemoteBzrDir but the smart server didn't
475
# support remote initialization.
476
# We delegate to a real object at this point (as RemoteBzrDir
477
# delegate to the repository format which would lead to infinite
478
# recursion if we just called a_bzrdir.create_repository.
479
a_bzrdir._ensure_real()
480
result = a_bzrdir._real_bzrdir.create_repository(shared=shared)
481
if not isinstance(result, RemoteRepository):
482
return self.open(a_bzrdir)
486
def initialize(self, a_bzrdir, shared=False):
487
# Being asked to create on a non RemoteBzrDir:
488
if not isinstance(a_bzrdir, RemoteBzrDir):
489
return self._vfs_initialize(a_bzrdir, shared)
490
medium = a_bzrdir._client._medium
491
if medium._is_remote_before((1, 13)):
492
return self._vfs_initialize(a_bzrdir, shared)
493
# Creating on a remote bzr dir.
494
# 1) get the network name to use.
495
if self._custom_format:
496
network_name = self._custom_format.network_name()
497
elif self._network_name:
498
network_name = self._network_name
500
# Select the current bzrlib default and ask for that.
501
reference_bzrdir_format = bzrdir.format_registry.get('default')()
502
reference_format = reference_bzrdir_format.repository_format
503
network_name = reference_format.network_name()
504
# 2) try direct creation via RPC
505
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
506
verb = 'BzrDir.create_repository'
512
response = a_bzrdir._call(verb, path, network_name, shared_str)
513
except errors.UnknownSmartMethod:
514
# Fallback - use vfs methods
515
medium._remember_remote_is_before((1, 13))
516
return self._vfs_initialize(a_bzrdir, shared)
518
# Turn the response into a RemoteRepository object.
519
format = response_tuple_to_repo_format(response[1:])
520
# Used to support creating a real format instance when needed.
521
format._creating_bzrdir = a_bzrdir
522
remote_repo = RemoteRepository(a_bzrdir, format)
523
format._creating_repo = remote_repo
526
def open(self, a_bzrdir):
527
if not isinstance(a_bzrdir, RemoteBzrDir):
528
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
529
return a_bzrdir.open_repository()
531
def _ensure_real(self):
532
if self._custom_format is None:
533
self._custom_format = repository.network_format_registry.get(
537
def _fetch_order(self):
539
return self._custom_format._fetch_order
542
def _fetch_uses_deltas(self):
544
return self._custom_format._fetch_uses_deltas
547
def _fetch_reconcile(self):
549
return self._custom_format._fetch_reconcile
551
def get_format_description(self):
552
return 'bzr remote repository'
554
def __eq__(self, other):
555
return self.__class__ is other.__class__
557
def check_conversion_target(self, target_format):
558
if self.rich_root_data and not target_format.rich_root_data:
559
raise errors.BadConversionTarget(
560
'Does not support rich root data.', target_format)
561
if (self.supports_tree_reference and
562
not getattr(target_format, 'supports_tree_reference', False)):
563
raise errors.BadConversionTarget(
564
'Does not support nested trees', target_format)
566
def network_name(self):
567
if self._network_name:
568
return self._network_name
569
self._creating_repo._ensure_real()
570
return self._creating_repo._real_repository._format.network_name()
573
def pack_compresses(self):
575
return self._custom_format.pack_compresses
578
def _serializer(self):
580
return self._custom_format._serializer
583
class RemoteRepository(_RpcHelper):
584
"""Repository accessed over rpc.
586
For the moment most operations are performed using local transport-backed
590
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
591
"""Create a RemoteRepository instance.
593
:param remote_bzrdir: The bzrdir hosting this repository.
594
:param format: The RemoteFormat object to use.
595
:param real_repository: If not None, a local implementation of the
596
repository logic for the repository, usually accessing the data
598
:param _client: Private testing parameter - override the smart client
599
to be used by the repository.
602
self._real_repository = real_repository
604
self._real_repository = None
605
self.bzrdir = remote_bzrdir
607
self._client = remote_bzrdir._client
609
self._client = _client
610
self._format = format
611
self._lock_mode = None
612
self._lock_token = None
614
self._leave_lock = False
615
# Cache of revision parents; misses are cached during read locks, and
616
# write locks when no _real_repository has been set.
617
self._unstacked_provider = graph.CachingParentsProvider(
618
get_parent_map=self._get_parent_map_rpc)
619
self._unstacked_provider.disable_cache()
621
# These depend on the actual remote format, so force them off for
622
# maximum compatibility. XXX: In future these should depend on the
623
# remote repository instance, but this is irrelevant until we perform
624
# reconcile via an RPC call.
625
self._reconcile_does_inventory_gc = False
626
self._reconcile_fixes_text_parents = False
627
self._reconcile_backsup_inventory = False
628
self.base = self.bzrdir.transport.base
629
# Additional places to query for data.
630
self._fallback_repositories = []
633
return "%s(%s)" % (self.__class__.__name__, self.base)
637
def abort_write_group(self, suppress_errors=False):
638
"""Complete a write group on the decorated repository.
640
Smart methods perform operations in a single step so this API
641
is not really applicable except as a compatibility thunk
642
for older plugins that don't use e.g. the CommitBuilder
645
:param suppress_errors: see Repository.abort_write_group.
648
return self._real_repository.abort_write_group(
649
suppress_errors=suppress_errors)
653
"""Decorate the real repository for now.
655
In the long term a full blown network facility is needed to avoid
656
creating a real repository object locally.
659
return self._real_repository.chk_bytes
661
def commit_write_group(self):
662
"""Complete a write group on the decorated repository.
664
Smart methods perform operations in a single step so this API
665
is not really applicable except as a compatibility thunk
666
for older plugins that don't use e.g. the CommitBuilder
670
return self._real_repository.commit_write_group()
672
def resume_write_group(self, tokens):
674
return self._real_repository.resume_write_group(tokens)
676
def suspend_write_group(self):
678
return self._real_repository.suspend_write_group()
680
def get_missing_parent_inventories(self, check_for_missing_texts=True):
682
return self._real_repository.get_missing_parent_inventories(
683
check_for_missing_texts=check_for_missing_texts)
685
def _get_rev_id_for_revno_vfs(self, revno, known_pair):
687
return self._real_repository.get_rev_id_for_revno(
690
def get_rev_id_for_revno(self, revno, known_pair):
691
"""See Repository.get_rev_id_for_revno."""
692
path = self.bzrdir._path_for_remote_call(self._client)
694
if self._client._medium._is_remote_before((1, 17)):
695
return self._get_rev_id_for_revno_vfs(revno, known_pair)
696
response = self._call(
697
'Repository.get_rev_id_for_revno', path, revno, known_pair)
698
except errors.UnknownSmartMethod:
699
self._client._medium._remember_remote_is_before((1, 17))
700
return self._get_rev_id_for_revno_vfs(revno, known_pair)
701
if response[0] == 'ok':
702
return True, response[1]
703
elif response[0] == 'history-incomplete':
704
known_pair = response[1:3]
705
for fallback in self._fallback_repositories:
706
found, result = fallback.get_rev_id_for_revno(revno, known_pair)
711
# Not found in any fallbacks
712
return False, known_pair
714
raise errors.UnexpectedSmartServerResponse(response)
716
def _ensure_real(self):
717
"""Ensure that there is a _real_repository set.
719
Used before calls to self._real_repository.
721
Note that _ensure_real causes many roundtrips to the server which are
722
not desirable, and prevents the use of smart one-roundtrip RPC's to
723
perform complex operations (such as accessing parent data, streaming
724
revisions etc). Adding calls to _ensure_real should only be done when
725
bringing up new functionality, adding fallbacks for smart methods that
726
require a fallback path, and never to replace an existing smart method
727
invocation. If in doubt chat to the bzr network team.
729
if self._real_repository is None:
730
if 'hpssvfs' in debug.debug_flags:
732
warning('VFS Repository access triggered\n%s',
733
''.join(traceback.format_stack()))
734
self._unstacked_provider.missing_keys.clear()
735
self.bzrdir._ensure_real()
736
self._set_real_repository(
737
self.bzrdir._real_bzrdir.open_repository())
739
def _translate_error(self, err, **context):
740
self.bzrdir._translate_error(err, repository=self, **context)
742
def find_text_key_references(self):
743
"""Find the text key references within the repository.
745
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
746
revision_ids. Each altered file-ids has the exact revision_ids that
747
altered it listed explicitly.
748
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
749
to whether they were referred to by the inventory of the
750
revision_id that they contain. The inventory texts from all present
751
revision ids are assessed to generate this report.
754
return self._real_repository.find_text_key_references()
756
def _generate_text_key_index(self):
757
"""Generate a new text key index for the repository.
759
This is an expensive function that will take considerable time to run.
761
:return: A dict mapping (file_id, revision_id) tuples to a list of
762
parents, also (file_id, revision_id) tuples.
765
return self._real_repository._generate_text_key_index()
767
def _get_revision_graph(self, revision_id):
768
"""Private method for using with old (< 1.2) servers to fallback."""
769
if revision_id is None:
771
elif revision.is_null(revision_id):
774
path = self.bzrdir._path_for_remote_call(self._client)
775
response = self._call_expecting_body(
776
'Repository.get_revision_graph', path, revision_id)
777
response_tuple, response_handler = response
778
if response_tuple[0] != 'ok':
779
raise errors.UnexpectedSmartServerResponse(response_tuple)
780
coded = response_handler.read_body_bytes()
782
# no revisions in this repository!
784
lines = coded.split('\n')
787
d = tuple(line.split())
788
revision_graph[d[0]] = d[1:]
790
return revision_graph
793
"""See Repository._get_sink()."""
794
return RemoteStreamSink(self)
796
def _get_source(self, to_format):
797
"""Return a source for streaming from this repository."""
798
return RemoteStreamSource(self, to_format)
801
def has_revision(self, revision_id):
802
"""True if this repository has a copy of the revision."""
803
# Copy of bzrlib.repository.Repository.has_revision
804
return revision_id in self.has_revisions((revision_id,))
807
def has_revisions(self, revision_ids):
808
"""Probe to find out the presence of multiple revisions.
810
:param revision_ids: An iterable of revision_ids.
811
:return: A set of the revision_ids that were present.
813
# Copy of bzrlib.repository.Repository.has_revisions
814
parent_map = self.get_parent_map(revision_ids)
815
result = set(parent_map)
816
if _mod_revision.NULL_REVISION in revision_ids:
817
result.add(_mod_revision.NULL_REVISION)
820
def _has_same_fallbacks(self, other_repo):
821
"""Returns true if the repositories have the same fallbacks."""
822
# XXX: copied from Repository; it should be unified into a base class
823
# <https://bugs.edge.launchpad.net/bzr/+bug/401622>
824
my_fb = self._fallback_repositories
825
other_fb = other_repo._fallback_repositories
826
if len(my_fb) != len(other_fb):
828
for f, g in zip(my_fb, other_fb):
829
if not f.has_same_location(g):
833
def has_same_location(self, other):
834
# TODO: Move to RepositoryBase and unify with the regular Repository
835
# one; unfortunately the tests rely on slightly different behaviour at
836
# present -- mbp 20090710
837
return (self.__class__ is other.__class__ and
838
self.bzrdir.transport.base == other.bzrdir.transport.base)
840
def get_graph(self, other_repository=None):
841
"""Return the graph for this repository format"""
842
parents_provider = self._make_parents_provider(other_repository)
843
return graph.Graph(parents_provider)
845
def gather_stats(self, revid=None, committers=None):
846
"""See Repository.gather_stats()."""
847
path = self.bzrdir._path_for_remote_call(self._client)
848
# revid can be None to indicate no revisions, not just NULL_REVISION
849
if revid is None or revision.is_null(revid):
853
if committers is None or not committers:
854
fmt_committers = 'no'
856
fmt_committers = 'yes'
857
response_tuple, response_handler = self._call_expecting_body(
858
'Repository.gather_stats', path, fmt_revid, fmt_committers)
859
if response_tuple[0] != 'ok':
860
raise errors.UnexpectedSmartServerResponse(response_tuple)
862
body = response_handler.read_body_bytes()
864
for line in body.split('\n'):
867
key, val_text = line.split(':')
868
if key in ('revisions', 'size', 'committers'):
869
result[key] = int(val_text)
870
elif key in ('firstrev', 'latestrev'):
871
values = val_text.split(' ')[1:]
872
result[key] = (float(values[0]), long(values[1]))
876
def find_branches(self, using=False):
877
"""See Repository.find_branches()."""
878
# should be an API call to the server.
880
return self._real_repository.find_branches(using=using)
882
def get_physical_lock_status(self):
883
"""See Repository.get_physical_lock_status()."""
884
# should be an API call to the server.
886
return self._real_repository.get_physical_lock_status()
888
def is_in_write_group(self):
889
"""Return True if there is an open write group.
891
write groups are only applicable locally for the smart server..
893
if self._real_repository:
894
return self._real_repository.is_in_write_group()
897
return self._lock_count >= 1
900
"""See Repository.is_shared()."""
901
path = self.bzrdir._path_for_remote_call(self._client)
902
response = self._call('Repository.is_shared', path)
903
if response[0] not in ('yes', 'no'):
904
raise SmartProtocolError('unexpected response code %s' % (response,))
905
return response[0] == 'yes'
907
def is_write_locked(self):
908
return self._lock_mode == 'w'
911
# wrong eventually - want a local lock cache context
912
if not self._lock_mode:
913
self._lock_mode = 'r'
915
self._unstacked_provider.enable_cache(cache_misses=True)
916
if self._real_repository is not None:
917
self._real_repository.lock_read()
918
for repo in self._fallback_repositories:
921
self._lock_count += 1
923
def _remote_lock_write(self, token):
924
path = self.bzrdir._path_for_remote_call(self._client)
927
err_context = {'token': token}
928
response = self._call('Repository.lock_write', path, token,
930
if response[0] == 'ok':
934
raise errors.UnexpectedSmartServerResponse(response)
936
def lock_write(self, token=None, _skip_rpc=False):
937
if not self._lock_mode:
939
if self._lock_token is not None:
940
if token != self._lock_token:
941
raise errors.TokenMismatch(token, self._lock_token)
942
self._lock_token = token
944
self._lock_token = self._remote_lock_write(token)
945
# if self._lock_token is None, then this is something like packs or
946
# svn where we don't get to lock the repo, or a weave style repository
947
# where we cannot lock it over the wire and attempts to do so will
949
if self._real_repository is not None:
950
self._real_repository.lock_write(token=self._lock_token)
951
if token is not None:
952
self._leave_lock = True
954
self._leave_lock = False
955
self._lock_mode = 'w'
957
cache_misses = self._real_repository is None
958
self._unstacked_provider.enable_cache(cache_misses=cache_misses)
959
for repo in self._fallback_repositories:
960
# Writes don't affect fallback repos
962
elif self._lock_mode == 'r':
963
raise errors.ReadOnlyError(self)
965
self._lock_count += 1
966
return self._lock_token or None
968
def leave_lock_in_place(self):
969
if not self._lock_token:
970
raise NotImplementedError(self.leave_lock_in_place)
971
self._leave_lock = True
973
def dont_leave_lock_in_place(self):
974
if not self._lock_token:
975
raise NotImplementedError(self.dont_leave_lock_in_place)
976
self._leave_lock = False
978
def _set_real_repository(self, repository):
979
"""Set the _real_repository for this repository.
981
:param repository: The repository to fallback to for non-hpss
982
implemented operations.
984
if self._real_repository is not None:
985
# Replacing an already set real repository.
986
# We cannot do this [currently] if the repository is locked -
987
# synchronised state might be lost.
989
raise AssertionError('_real_repository is already set')
990
if isinstance(repository, RemoteRepository):
991
raise AssertionError()
992
self._real_repository = repository
993
# three code paths happen here:
994
# 1) old servers, RemoteBranch.open() calls _ensure_real before setting
995
# up stacking. In this case self._fallback_repositories is [], and the
996
# real repo is already setup. Preserve the real repo and
997
# RemoteRepository.add_fallback_repository will avoid adding
999
# 2) new servers, RemoteBranch.open() sets up stacking, and when
1000
# ensure_real is triggered from a branch, the real repository to
1001
# set already has a matching list with separate instances, but
1002
# as they are also RemoteRepositories we don't worry about making the
1003
# lists be identical.
1004
# 3) new servers, RemoteRepository.ensure_real is triggered before
1005
# RemoteBranch.ensure real, in this case we get a repo with no fallbacks
1006
# and need to populate it.
1007
if (self._fallback_repositories and
1008
len(self._real_repository._fallback_repositories) !=
1009
len(self._fallback_repositories)):
1010
if len(self._real_repository._fallback_repositories):
1011
raise AssertionError(
1012
"cannot cleanly remove existing _fallback_repositories")
1013
for fb in self._fallback_repositories:
1014
self._real_repository.add_fallback_repository(fb)
1015
if self._lock_mode == 'w':
1016
# if we are already locked, the real repository must be able to
1017
# acquire the lock with our token.
1018
self._real_repository.lock_write(self._lock_token)
1019
elif self._lock_mode == 'r':
1020
self._real_repository.lock_read()
1022
def start_write_group(self):
1023
"""Start a write group on the decorated repository.
1025
Smart methods perform operations in a single step so this API
1026
is not really applicable except as a compatibility thunk
1027
for older plugins that don't use e.g. the CommitBuilder
1031
return self._real_repository.start_write_group()
1033
def _unlock(self, token):
1034
path = self.bzrdir._path_for_remote_call(self._client)
1036
# with no token the remote repository is not persistently locked.
1038
err_context = {'token': token}
1039
response = self._call('Repository.unlock', path, token,
1041
if response == ('ok',):
1044
raise errors.UnexpectedSmartServerResponse(response)
1047
if not self._lock_count:
1048
return lock.cant_unlock_not_held(self)
1049
self._lock_count -= 1
1050
if self._lock_count > 0:
1052
self._unstacked_provider.disable_cache()
1053
old_mode = self._lock_mode
1054
self._lock_mode = None
1056
# The real repository is responsible at present for raising an
1057
# exception if it's in an unfinished write group. However, it
1058
# normally will *not* actually remove the lock from disk - that's
1059
# done by the server on receiving the Repository.unlock call.
1060
# This is just to let the _real_repository stay up to date.
1061
if self._real_repository is not None:
1062
self._real_repository.unlock()
1064
# The rpc-level lock should be released even if there was a
1065
# problem releasing the vfs-based lock.
1067
# Only write-locked repositories need to make a remote method
1068
# call to perform the unlock.
1069
old_token = self._lock_token
1070
self._lock_token = None
1071
if not self._leave_lock:
1072
self._unlock(old_token)
1073
# Fallbacks are always 'lock_read()' so we don't pay attention to
1075
for repo in self._fallback_repositories:
1078
def break_lock(self):
1079
# should hand off to the network
1081
return self._real_repository.break_lock()
1083
def _get_tarball(self, compression):
1084
"""Return a TemporaryFile containing a repository tarball.
1086
Returns None if the server does not support sending tarballs.
1089
path = self.bzrdir._path_for_remote_call(self._client)
1091
response, protocol = self._call_expecting_body(
1092
'Repository.tarball', path, compression)
1093
except errors.UnknownSmartMethod:
1094
protocol.cancel_read_body()
1096
if response[0] == 'ok':
1097
# Extract the tarball and return it
1098
t = tempfile.NamedTemporaryFile()
1099
# TODO: rpc layer should read directly into it...
1100
t.write(protocol.read_body_bytes())
1103
raise errors.UnexpectedSmartServerResponse(response)
1105
def sprout(self, to_bzrdir, revision_id=None):
1106
# TODO: Option to control what format is created?
1108
dest_repo = self._real_repository._format.initialize(to_bzrdir,
1110
dest_repo.fetch(self, revision_id=revision_id)
1113
### These methods are just thin shims to the VFS object for now.
1115
def revision_tree(self, revision_id):
1117
return self._real_repository.revision_tree(revision_id)
1119
def get_serializer_format(self):
1121
return self._real_repository.get_serializer_format()
1123
def get_commit_builder(self, branch, parents, config, timestamp=None,
1124
timezone=None, committer=None, revprops=None,
1126
# FIXME: It ought to be possible to call this without immediately
1127
# triggering _ensure_real. For now it's the easiest thing to do.
1129
real_repo = self._real_repository
1130
builder = real_repo.get_commit_builder(branch, parents,
1131
config, timestamp=timestamp, timezone=timezone,
1132
committer=committer, revprops=revprops, revision_id=revision_id)
1135
def add_fallback_repository(self, repository):
1136
"""Add a repository to use for looking up data not held locally.
1138
:param repository: A repository.
1140
if not self._format.supports_external_lookups:
1141
raise errors.UnstackableRepositoryFormat(
1142
self._format.network_name(), self.base)
1143
# We need to accumulate additional repositories here, to pass them in
1146
if self.is_locked():
1147
# We will call fallback.unlock() when we transition to the unlocked
1148
# state, so always add a lock here. If a caller passes us a locked
1149
# repository, they are responsible for unlocking it later.
1150
repository.lock_read()
1151
self._fallback_repositories.append(repository)
1152
# If self._real_repository was parameterised already (e.g. because a
1153
# _real_branch had its get_stacked_on_url method called), then the
1154
# repository to be added may already be in the _real_repositories list.
1155
if self._real_repository is not None:
1156
fallback_locations = [repo.bzrdir.root_transport.base for repo in
1157
self._real_repository._fallback_repositories]
1158
if repository.bzrdir.root_transport.base not in fallback_locations:
1159
self._real_repository.add_fallback_repository(repository)
1161
def add_inventory(self, revid, inv, parents):
1163
return self._real_repository.add_inventory(revid, inv, parents)
1165
def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1168
return self._real_repository.add_inventory_by_delta(basis_revision_id,
1169
delta, new_revision_id, parents)
1171
def add_revision(self, rev_id, rev, inv=None, config=None):
1173
return self._real_repository.add_revision(
1174
rev_id, rev, inv=inv, config=config)
1177
def get_inventory(self, revision_id):
1179
return self._real_repository.get_inventory(revision_id)
1181
def iter_inventories(self, revision_ids):
1183
return self._real_repository.iter_inventories(revision_ids)
1186
def get_revision(self, revision_id):
1188
return self._real_repository.get_revision(revision_id)
1190
def get_transaction(self):
1192
return self._real_repository.get_transaction()
1195
def clone(self, a_bzrdir, revision_id=None):
1197
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
1199
def make_working_trees(self):
1200
"""See Repository.make_working_trees"""
1202
return self._real_repository.make_working_trees()
1204
def refresh_data(self):
1205
"""Re-read any data needed to to synchronise with disk.
1207
This method is intended to be called after another repository instance
1208
(such as one used by a smart server) has inserted data into the
1209
repository. It may not be called during a write group, but may be
1210
called at any other time.
1212
if self.is_in_write_group():
1213
raise errors.InternalBzrError(
1214
"May not refresh_data while in a write group.")
1215
if self._real_repository is not None:
1216
self._real_repository.refresh_data()
1218
def revision_ids_to_search_result(self, result_set):
1219
"""Convert a set of revision ids to a graph SearchResult."""
1220
result_parents = set()
1221
for parents in self.get_graph().get_parent_map(
1222
result_set).itervalues():
1223
result_parents.update(parents)
1224
included_keys = result_set.intersection(result_parents)
1225
start_keys = result_set.difference(included_keys)
1226
exclude_keys = result_parents.difference(result_set)
1227
result = graph.SearchResult(start_keys, exclude_keys,
1228
len(result_set), result_set)
1232
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1233
"""Return the revision ids that other has that this does not.
1235
These are returned in topological order.
1237
revision_id: only return revision ids included by revision_id.
1239
return repository.InterRepository.get(
1240
other, self).search_missing_revision_ids(revision_id, find_ghosts)
1242
def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1244
# No base implementation to use as RemoteRepository is not a subclass
1245
# of Repository; so this is a copy of Repository.fetch().
1246
if fetch_spec is not None and revision_id is not None:
1247
raise AssertionError(
1248
"fetch_spec and revision_id are mutually exclusive.")
1249
if self.is_in_write_group():
1250
raise errors.InternalBzrError(
1251
"May not fetch while in a write group.")
1252
# fast path same-url fetch operations
1253
if (self.has_same_location(source)
1254
and fetch_spec is None
1255
and self._has_same_fallbacks(source)):
1256
# check that last_revision is in 'from' and then return a
1258
if (revision_id is not None and
1259
not revision.is_null(revision_id)):
1260
self.get_revision(revision_id)
1262
# if there is no specific appropriate InterRepository, this will get
1263
# the InterRepository base class, which raises an
1264
# IncompatibleRepositories when asked to fetch.
1265
inter = repository.InterRepository.get(source, self)
1266
return inter.fetch(revision_id=revision_id, pb=pb,
1267
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1269
def create_bundle(self, target, base, fileobj, format=None):
1271
self._real_repository.create_bundle(target, base, fileobj, format)
1274
def get_ancestry(self, revision_id, topo_sorted=True):
1276
return self._real_repository.get_ancestry(revision_id, topo_sorted)
1278
def fileids_altered_by_revision_ids(self, revision_ids):
1280
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
1282
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
1284
return self._real_repository._get_versioned_file_checker(
1285
revisions, revision_versions_cache)
1287
def iter_files_bytes(self, desired_files):
1288
"""See Repository.iter_file_bytes.
1291
return self._real_repository.iter_files_bytes(desired_files)
1293
def get_parent_map(self, revision_ids):
1294
"""See bzrlib.Graph.get_parent_map()."""
1295
return self._make_parents_provider().get_parent_map(revision_ids)
1297
def _get_parent_map_rpc(self, keys):
1298
"""Helper for get_parent_map that performs the RPC."""
1299
medium = self._client._medium
1300
if medium._is_remote_before((1, 2)):
1301
# We already found out that the server can't understand
1302
# Repository.get_parent_map requests, so just fetch the whole
1305
# Note that this reads the whole graph, when only some keys are
1306
# wanted. On this old server there's no way (?) to get them all
1307
# in one go, and the user probably will have seen a warning about
1308
# the server being old anyhow.
1309
rg = self._get_revision_graph(None)
1310
# There is an API discrepancy between get_parent_map and
1311
# get_revision_graph. Specifically, a "key:()" pair in
1312
# get_revision_graph just means a node has no parents. For
1313
# "get_parent_map" it means the node is a ghost. So fix up the
1314
# graph to correct this.
1315
# https://bugs.launchpad.net/bzr/+bug/214894
1316
# There is one other "bug" which is that ghosts in
1317
# get_revision_graph() are not returned at all. But we won't worry
1318
# about that for now.
1319
for node_id, parent_ids in rg.iteritems():
1320
if parent_ids == ():
1321
rg[node_id] = (NULL_REVISION,)
1322
rg[NULL_REVISION] = ()
1327
raise ValueError('get_parent_map(None) is not valid')
1328
if NULL_REVISION in keys:
1329
keys.discard(NULL_REVISION)
1330
found_parents = {NULL_REVISION:()}
1332
return found_parents
1335
# TODO(Needs analysis): We could assume that the keys being requested
1336
# from get_parent_map are in a breadth first search, so typically they
1337
# will all be depth N from some common parent, and we don't have to
1338
# have the server iterate from the root parent, but rather from the
1339
# keys we're searching; and just tell the server the keyspace we
1340
# already have; but this may be more traffic again.
1342
# Transform self._parents_map into a search request recipe.
1343
# TODO: Manage this incrementally to avoid covering the same path
1344
# repeatedly. (The server will have to on each request, but the less
1345
# work done the better).
1347
# Negative caching notes:
1348
# new server sends missing when a request including the revid
1349
# 'include-missing:' is present in the request.
1350
# missing keys are serialised as missing:X, and we then call
1351
# provider.note_missing(X) for-all X
1352
parents_map = self._unstacked_provider.get_cached_map()
1353
if parents_map is None:
1354
# Repository is not locked, so there's no cache.
1356
# start_set is all the keys in the cache
1357
start_set = set(parents_map)
1358
# result set is all the references to keys in the cache
1359
result_parents = set()
1360
for parents in parents_map.itervalues():
1361
result_parents.update(parents)
1362
stop_keys = result_parents.difference(start_set)
1363
# We don't need to send ghosts back to the server as a position to
1365
stop_keys.difference_update(self._unstacked_provider.missing_keys)
1366
key_count = len(parents_map)
1367
if (NULL_REVISION in result_parents
1368
and NULL_REVISION in self._unstacked_provider.missing_keys):
1369
# If we pruned NULL_REVISION from the stop_keys because it's also
1370
# in our cache of "missing" keys we need to increment our key count
1371
# by 1, because the reconsitituted SearchResult on the server will
1372
# still consider NULL_REVISION to be an included key.
1374
included_keys = start_set.intersection(result_parents)
1375
start_set.difference_update(included_keys)
1376
recipe = ('manual', start_set, stop_keys, key_count)
1377
body = self._serialise_search_recipe(recipe)
1378
path = self.bzrdir._path_for_remote_call(self._client)
1380
if type(key) is not str:
1382
"key %r not a plain string" % (key,))
1383
verb = 'Repository.get_parent_map'
1384
args = (path, 'include-missing:') + tuple(keys)
1386
response = self._call_with_body_bytes_expecting_body(
1388
except errors.UnknownSmartMethod:
1389
# Server does not support this method, so get the whole graph.
1390
# Worse, we have to force a disconnection, because the server now
1391
# doesn't realise it has a body on the wire to consume, so the
1392
# only way to recover is to abandon the connection.
1394
'Server is too old for fast get_parent_map, reconnecting. '
1395
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1397
# To avoid having to disconnect repeatedly, we keep track of the
1398
# fact the server doesn't understand remote methods added in 1.2.
1399
medium._remember_remote_is_before((1, 2))
1400
# Recurse just once and we should use the fallback code.
1401
return self._get_parent_map_rpc(keys)
1402
response_tuple, response_handler = response
1403
if response_tuple[0] not in ['ok']:
1404
response_handler.cancel_read_body()
1405
raise errors.UnexpectedSmartServerResponse(response_tuple)
1406
if response_tuple[0] == 'ok':
1407
coded = bz2.decompress(response_handler.read_body_bytes())
1409
# no revisions found
1411
lines = coded.split('\n')
1414
d = tuple(line.split())
1416
revision_graph[d[0]] = d[1:]
1419
if d[0].startswith('missing:'):
1421
self._unstacked_provider.note_missing_key(revid)
1423
# no parents - so give the Graph result
1425
revision_graph[d[0]] = (NULL_REVISION,)
1426
return revision_graph
1429
def get_signature_text(self, revision_id):
1431
return self._real_repository.get_signature_text(revision_id)
1434
def get_inventory_xml(self, revision_id):
1436
return self._real_repository.get_inventory_xml(revision_id)
1438
def deserialise_inventory(self, revision_id, xml):
1440
return self._real_repository.deserialise_inventory(revision_id, xml)
1442
def reconcile(self, other=None, thorough=False):
1444
return self._real_repository.reconcile(other=other, thorough=thorough)
1446
def all_revision_ids(self):
1448
return self._real_repository.all_revision_ids()
1451
def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1453
return self._real_repository.get_deltas_for_revisions(revisions,
1454
specific_fileids=specific_fileids)
1457
def get_revision_delta(self, revision_id, specific_fileids=None):
1459
return self._real_repository.get_revision_delta(revision_id,
1460
specific_fileids=specific_fileids)
1463
def revision_trees(self, revision_ids):
1465
return self._real_repository.revision_trees(revision_ids)
1468
def get_revision_reconcile(self, revision_id):
1470
return self._real_repository.get_revision_reconcile(revision_id)
1473
def check(self, revision_ids=None):
1475
return self._real_repository.check(revision_ids=revision_ids)
1477
def copy_content_into(self, destination, revision_id=None):
1479
return self._real_repository.copy_content_into(
1480
destination, revision_id=revision_id)
1482
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
1483
# get a tarball of the remote repository, and copy from that into the
1485
from bzrlib import osutils
1487
# TODO: Maybe a progress bar while streaming the tarball?
1488
note("Copying repository content as tarball...")
1489
tar_file = self._get_tarball('bz2')
1490
if tar_file is None:
1492
destination = to_bzrdir.create_repository()
1494
tar = tarfile.open('repository', fileobj=tar_file,
1496
tmpdir = osutils.mkdtemp()
1498
_extract_tar(tar, tmpdir)
1499
tmp_bzrdir = BzrDir.open(tmpdir)
1500
tmp_repo = tmp_bzrdir.open_repository()
1501
tmp_repo.copy_content_into(destination, revision_id)
1503
osutils.rmtree(tmpdir)
1507
# TODO: Suggestion from john: using external tar is much faster than
1508
# python's tarfile library, but it may not work on windows.
1511
def inventories(self):
1512
"""Decorate the real repository for now.
1514
In the long term a full blown network facility is needed to
1515
avoid creating a real repository object locally.
1518
return self._real_repository.inventories
1521
def pack(self, hint=None):
1522
"""Compress the data within the repository.
1524
This is not currently implemented within the smart server.
1527
return self._real_repository.pack(hint=hint)
1530
def revisions(self):
1531
"""Decorate the real repository for now.
1533
In the short term this should become a real object to intercept graph
1536
In the long term a full blown network facility is needed.
1539
return self._real_repository.revisions
1541
def set_make_working_trees(self, new_value):
1543
new_value_str = "True"
1545
new_value_str = "False"
1546
path = self.bzrdir._path_for_remote_call(self._client)
1548
response = self._call(
1549
'Repository.set_make_working_trees', path, new_value_str)
1550
except errors.UnknownSmartMethod:
1552
self._real_repository.set_make_working_trees(new_value)
1554
if response[0] != 'ok':
1555
raise errors.UnexpectedSmartServerResponse(response)
1558
def signatures(self):
1559
"""Decorate the real repository for now.
1561
In the long term a full blown network facility is needed to avoid
1562
creating a real repository object locally.
1565
return self._real_repository.signatures
1568
def sign_revision(self, revision_id, gpg_strategy):
1570
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1574
"""Decorate the real repository for now.
1576
In the long term a full blown network facility is needed to avoid
1577
creating a real repository object locally.
1580
return self._real_repository.texts
1583
def get_revisions(self, revision_ids):
1585
return self._real_repository.get_revisions(revision_ids)
1587
def supports_rich_root(self):
1588
return self._format.rich_root_data
1590
def iter_reverse_revision_history(self, revision_id):
1592
return self._real_repository.iter_reverse_revision_history(revision_id)
1595
def _serializer(self):
1596
return self._format._serializer
1598
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1600
return self._real_repository.store_revision_signature(
1601
gpg_strategy, plaintext, revision_id)
1603
def add_signature_text(self, revision_id, signature):
1605
return self._real_repository.add_signature_text(revision_id, signature)
1607
def has_signature_for_revision_id(self, revision_id):
1609
return self._real_repository.has_signature_for_revision_id(revision_id)
1611
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1613
return self._real_repository.item_keys_introduced_by(revision_ids,
1614
_files_pb=_files_pb)
1616
def revision_graph_can_have_wrong_parents(self):
1617
# The answer depends on the remote repo format.
1619
return self._real_repository.revision_graph_can_have_wrong_parents()
1621
def _find_inconsistent_revision_parents(self):
1623
return self._real_repository._find_inconsistent_revision_parents()
1625
def _check_for_inconsistent_revision_parents(self):
1627
return self._real_repository._check_for_inconsistent_revision_parents()
1629
def _make_parents_provider(self, other=None):
1630
providers = [self._unstacked_provider]
1631
if other is not None:
1632
providers.insert(0, other)
1633
providers.extend(r._make_parents_provider() for r in
1634
self._fallback_repositories)
1635
return graph.StackedParentsProvider(providers)
1637
def _serialise_search_recipe(self, recipe):
1638
"""Serialise a graph search recipe.
1640
:param recipe: A search recipe (start, stop, count).
1641
:return: Serialised bytes.
1643
start_keys = ' '.join(recipe[1])
1644
stop_keys = ' '.join(recipe[2])
1645
count = str(recipe[3])
1646
return '\n'.join((start_keys, stop_keys, count))
1648
def _serialise_search_result(self, search_result):
1649
if isinstance(search_result, graph.PendingAncestryResult):
1650
parts = ['ancestry-of']
1651
parts.extend(search_result.heads)
1653
recipe = search_result.get_recipe()
1654
parts = [recipe[0], self._serialise_search_recipe(recipe)]
1655
return '\n'.join(parts)
1658
path = self.bzrdir._path_for_remote_call(self._client)
1660
response = self._call('PackRepository.autopack', path)
1661
except errors.UnknownSmartMethod:
1663
self._real_repository._pack_collection.autopack()
1666
if response[0] != 'ok':
1667
raise errors.UnexpectedSmartServerResponse(response)
1670
class RemoteStreamSink(repository.StreamSink):
1672
def _insert_real(self, stream, src_format, resume_tokens):
1673
self.target_repo._ensure_real()
1674
sink = self.target_repo._real_repository._get_sink()
1675
result = sink.insert_stream(stream, src_format, resume_tokens)
1677
self.target_repo.autopack()
1680
def insert_stream(self, stream, src_format, resume_tokens):
1681
target = self.target_repo
1682
target._unstacked_provider.missing_keys.clear()
1683
if target._lock_token:
1684
verb = 'Repository.insert_stream_locked'
1685
extra_args = (target._lock_token or '',)
1686
required_version = (1, 14)
1688
verb = 'Repository.insert_stream'
1690
required_version = (1, 13)
1691
client = target._client
1692
medium = client._medium
1693
if medium._is_remote_before(required_version):
1694
# No possible way this can work.
1695
return self._insert_real(stream, src_format, resume_tokens)
1696
path = target.bzrdir._path_for_remote_call(client)
1697
if not resume_tokens:
1698
# XXX: Ugly but important for correctness, *will* be fixed during
1699
# 1.13 cycle. Pushing a stream that is interrupted results in a
1700
# fallback to the _real_repositories sink *with a partial stream*.
1701
# Thats bad because we insert less data than bzr expected. To avoid
1702
# this we do a trial push to make sure the verb is accessible, and
1703
# do not fallback when actually pushing the stream. A cleanup patch
1704
# is going to look at rewinding/restarting the stream/partial
1706
byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1708
response = client.call_with_body_stream(
1709
(verb, path, '') + extra_args, byte_stream)
1710
except errors.UnknownSmartMethod:
1711
medium._remember_remote_is_before(required_version)
1712
return self._insert_real(stream, src_format, resume_tokens)
1713
byte_stream = smart_repo._stream_to_byte_stream(
1715
resume_tokens = ' '.join(resume_tokens)
1716
response = client.call_with_body_stream(
1717
(verb, path, resume_tokens) + extra_args, byte_stream)
1718
if response[0][0] not in ('ok', 'missing-basis'):
1719
raise errors.UnexpectedSmartServerResponse(response)
1720
if response[0][0] == 'missing-basis':
1721
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1722
resume_tokens = tokens
1723
return resume_tokens, set(missing_keys)
1725
self.target_repo.refresh_data()
1729
class RemoteStreamSource(repository.StreamSource):
1730
"""Stream data from a remote server."""
1732
def get_stream(self, search):
1733
if (self.from_repository._fallback_repositories and
1734
self.to_format._fetch_order == 'topological'):
1735
return self._real_stream(self.from_repository, search)
1738
repos = [self.from_repository]
1744
repos.extend(repo._fallback_repositories)
1745
sources.append(repo)
1746
return self.missing_parents_chain(search, sources)
1748
def _real_stream(self, repo, search):
1749
"""Get a stream for search from repo.
1751
This never called RemoteStreamSource.get_stream, and is a heler
1752
for RemoteStreamSource._get_stream to allow getting a stream
1753
reliably whether fallback back because of old servers or trying
1754
to stream from a non-RemoteRepository (which the stacked support
1757
source = repo._get_source(self.to_format)
1758
if isinstance(source, RemoteStreamSource):
1759
return repository.StreamSource.get_stream(source, search)
1760
return source.get_stream(search)
1762
def _get_stream(self, repo, search):
1763
"""Core worker to get a stream from repo for search.
1765
This is used by both get_stream and the stacking support logic. It
1766
deliberately gets a stream for repo which does not need to be
1767
self.from_repository. In the event that repo is not Remote, or
1768
cannot do a smart stream, a fallback is made to the generic
1769
repository._get_stream() interface, via self._real_stream.
1771
In the event of stacking, streams from _get_stream will not
1772
contain all the data for search - this is normal (see get_stream).
1774
:param repo: A repository.
1775
:param search: A search.
1777
# Fallbacks may be non-smart
1778
if not isinstance(repo, RemoteRepository):
1779
return self._real_stream(repo, search)
1780
client = repo._client
1781
medium = client._medium
1782
if medium._is_remote_before((1, 13)):
1783
# streaming was added in 1.13
1784
return self._real_stream(repo, search)
1785
path = repo.bzrdir._path_for_remote_call(client)
1787
search_bytes = repo._serialise_search_result(search)
1788
response = repo._call_with_body_bytes_expecting_body(
1789
'Repository.get_stream',
1790
(path, self.to_format.network_name()), search_bytes)
1791
response_tuple, response_handler = response
1792
except errors.UnknownSmartMethod:
1793
medium._remember_remote_is_before((1,13))
1794
return self._real_stream(repo, search)
1795
if response_tuple[0] != 'ok':
1796
raise errors.UnexpectedSmartServerResponse(response_tuple)
1797
byte_stream = response_handler.read_streamed_body()
1798
src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
1799
if src_format.network_name() != repo._format.network_name():
1800
raise AssertionError(
1801
"Mismatched RemoteRepository and stream src %r, %r" % (
1802
src_format.network_name(), repo._format.network_name()))
1805
def missing_parents_chain(self, search, sources):
1806
"""Chain multiple streams together to handle stacking.
1808
:param search: The overall search to satisfy with streams.
1809
:param sources: A list of Repository objects to query.
1811
self.serialiser = self.to_format._serializer
1812
self.seen_revs = set()
1813
self.referenced_revs = set()
1814
# If there are heads in the search, or the key count is > 0, we are not
1816
while not search.is_empty() and len(sources) > 1:
1817
source = sources.pop(0)
1818
stream = self._get_stream(source, search)
1819
for kind, substream in stream:
1820
if kind != 'revisions':
1821
yield kind, substream
1823
yield kind, self.missing_parents_rev_handler(substream)
1824
search = search.refine(self.seen_revs, self.referenced_revs)
1825
self.seen_revs = set()
1826
self.referenced_revs = set()
1827
if not search.is_empty():
1828
for kind, stream in self._get_stream(sources[0], search):
1831
def missing_parents_rev_handler(self, substream):
1832
for content in substream:
1833
revision_bytes = content.get_bytes_as('fulltext')
1834
revision = self.serialiser.read_revision_from_string(revision_bytes)
1835
self.seen_revs.add(content.key[-1])
1836
self.referenced_revs.update(revision.parent_ids)
1840
class RemoteBranchLockableFiles(LockableFiles):
1841
"""A 'LockableFiles' implementation that talks to a smart server.
1843
This is not a public interface class.
1846
def __init__(self, bzrdir, _client):
1847
self.bzrdir = bzrdir
1848
self._client = _client
1849
self._need_find_modes = True
1850
LockableFiles.__init__(
1851
self, bzrdir.get_branch_transport(None),
1852
'lock', lockdir.LockDir)
1854
def _find_modes(self):
1855
# RemoteBranches don't let the client set the mode of control files.
1856
self._dir_mode = None
1857
self._file_mode = None
1860
class RemoteBranchFormat(branch.BranchFormat):
1862
def __init__(self, network_name=None):
1863
super(RemoteBranchFormat, self).__init__()
1864
self._matchingbzrdir = RemoteBzrDirFormat()
1865
self._matchingbzrdir.set_branch_format(self)
1866
self._custom_format = None
1867
self._network_name = network_name
1869
def __eq__(self, other):
1870
return (isinstance(other, RemoteBranchFormat) and
1871
self.__dict__ == other.__dict__)
1873
def _ensure_real(self):
1874
if self._custom_format is None:
1875
self._custom_format = branch.network_format_registry.get(
1878
def get_format_description(self):
1879
return 'Remote BZR Branch'
1881
def network_name(self):
1882
return self._network_name
1884
def open(self, a_bzrdir, ignore_fallbacks=False):
1885
return a_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1887
def _vfs_initialize(self, a_bzrdir):
1888
# Initialisation when using a local bzrdir object, or a non-vfs init
1889
# method is not available on the server.
1890
# self._custom_format is always set - the start of initialize ensures
1892
if isinstance(a_bzrdir, RemoteBzrDir):
1893
a_bzrdir._ensure_real()
1894
result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
1896
# We assume the bzrdir is parameterised; it may not be.
1897
result = self._custom_format.initialize(a_bzrdir)
1898
if (isinstance(a_bzrdir, RemoteBzrDir) and
1899
not isinstance(result, RemoteBranch)):
1900
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
1903
def initialize(self, a_bzrdir):
1904
# 1) get the network name to use.
1905
if self._custom_format:
1906
network_name = self._custom_format.network_name()
1908
# Select the current bzrlib default and ask for that.
1909
reference_bzrdir_format = bzrdir.format_registry.get('default')()
1910
reference_format = reference_bzrdir_format.get_branch_format()
1911
self._custom_format = reference_format
1912
network_name = reference_format.network_name()
1913
# Being asked to create on a non RemoteBzrDir:
1914
if not isinstance(a_bzrdir, RemoteBzrDir):
1915
return self._vfs_initialize(a_bzrdir)
1916
medium = a_bzrdir._client._medium
1917
if medium._is_remote_before((1, 13)):
1918
return self._vfs_initialize(a_bzrdir)
1919
# Creating on a remote bzr dir.
1920
# 2) try direct creation via RPC
1921
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
1922
verb = 'BzrDir.create_branch'
1924
response = a_bzrdir._call(verb, path, network_name)
1925
except errors.UnknownSmartMethod:
1926
# Fallback - use vfs methods
1927
medium._remember_remote_is_before((1, 13))
1928
return self._vfs_initialize(a_bzrdir)
1929
if response[0] != 'ok':
1930
raise errors.UnexpectedSmartServerResponse(response)
1931
# Turn the response into a RemoteRepository object.
1932
format = RemoteBranchFormat(network_name=response[1])
1933
repo_format = response_tuple_to_repo_format(response[3:])
1934
if response[2] == '':
1935
repo_bzrdir = a_bzrdir
1937
repo_bzrdir = RemoteBzrDir(
1938
a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
1940
remote_repo = RemoteRepository(repo_bzrdir, repo_format)
1941
remote_branch = RemoteBranch(a_bzrdir, remote_repo,
1942
format=format, setup_stacking=False)
1943
# XXX: We know this is a new branch, so it must have revno 0, revid
1944
# NULL_REVISION. Creating the branch locked would make this be unable
1945
# to be wrong; here its simply very unlikely to be wrong. RBC 20090225
1946
remote_branch._last_revision_info_cache = 0, NULL_REVISION
1947
return remote_branch
1949
def make_tags(self, branch):
1951
return self._custom_format.make_tags(branch)
1953
def supports_tags(self):
1954
# Remote branches might support tags, but we won't know until we
1955
# access the real remote branch.
1957
return self._custom_format.supports_tags()
1959
def supports_stacking(self):
1961
return self._custom_format.supports_stacking()
1963
def supports_set_append_revisions_only(self):
1965
return self._custom_format.supports_set_append_revisions_only()
1968
class RemoteBranch(branch.Branch, _RpcHelper):
1969
"""Branch stored on a server accessed by HPSS RPC.
1971
At the moment most operations are mapped down to simple file operations.
1974
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1975
_client=None, format=None, setup_stacking=True):
1976
"""Create a RemoteBranch instance.
1978
:param real_branch: An optional local implementation of the branch
1979
format, usually accessing the data via the VFS.
1980
:param _client: Private parameter for testing.
1981
:param format: A RemoteBranchFormat object, None to create one
1982
automatically. If supplied it should have a network_name already
1984
:param setup_stacking: If True make an RPC call to determine the
1985
stacked (or not) status of the branch. If False assume the branch
1988
# We intentionally don't call the parent class's __init__, because it
1989
# will try to assign to self.tags, which is a property in this subclass.
1990
# And the parent's __init__ doesn't do much anyway.
1991
self.bzrdir = remote_bzrdir
1992
if _client is not None:
1993
self._client = _client
1995
self._client = remote_bzrdir._client
1996
self.repository = remote_repository
1997
if real_branch is not None:
1998
self._real_branch = real_branch
1999
# Give the remote repository the matching real repo.
2000
real_repo = self._real_branch.repository
2001
if isinstance(real_repo, RemoteRepository):
2002
real_repo._ensure_real()
2003
real_repo = real_repo._real_repository
2004
self.repository._set_real_repository(real_repo)
2005
# Give the branch the remote repository to let fast-pathing happen.
2006
self._real_branch.repository = self.repository
2008
self._real_branch = None
2009
# Fill out expected attributes of branch for bzrlib API users.
2010
self._clear_cached_state()
2011
self.base = self.bzrdir.root_transport.base
2012
self._control_files = None
2013
self._lock_mode = None
2014
self._lock_token = None
2015
self._repo_lock_token = None
2016
self._lock_count = 0
2017
self._leave_lock = False
2018
# Setup a format: note that we cannot call _ensure_real until all the
2019
# attributes above are set: This code cannot be moved higher up in this
2022
self._format = RemoteBranchFormat()
2023
if real_branch is not None:
2024
self._format._network_name = \
2025
self._real_branch._format.network_name()
2027
self._format = format
2028
if not self._format._network_name:
2029
# Did not get from open_branchV2 - old server.
2031
self._format._network_name = \
2032
self._real_branch._format.network_name()
2033
self.tags = self._format.make_tags(self)
2034
# The base class init is not called, so we duplicate this:
2035
hooks = branch.Branch.hooks['open']
2038
self._is_stacked = False
2040
self._setup_stacking()
2042
def _setup_stacking(self):
2043
# configure stacking into the remote repository, by reading it from
2046
fallback_url = self.get_stacked_on_url()
2047
except (errors.NotStacked, errors.UnstackableBranchFormat,
2048
errors.UnstackableRepositoryFormat), e:
2050
self._is_stacked = True
2051
self._activate_fallback_location(fallback_url)
2053
def _get_config(self):
2054
return RemoteBranchConfig(self)
2056
def _get_real_transport(self):
2057
# if we try vfs access, return the real branch's vfs transport
2059
return self._real_branch._transport
2061
_transport = property(_get_real_transport)
2064
return "%s(%s)" % (self.__class__.__name__, self.base)
2068
def _ensure_real(self):
2069
"""Ensure that there is a _real_branch set.
2071
Used before calls to self._real_branch.
2073
if self._real_branch is None:
2074
if not vfs.vfs_enabled():
2075
raise AssertionError('smart server vfs must be enabled '
2076
'to use vfs implementation')
2077
self.bzrdir._ensure_real()
2078
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
2079
if self.repository._real_repository is None:
2080
# Give the remote repository the matching real repo.
2081
real_repo = self._real_branch.repository
2082
if isinstance(real_repo, RemoteRepository):
2083
real_repo._ensure_real()
2084
real_repo = real_repo._real_repository
2085
self.repository._set_real_repository(real_repo)
2086
# Give the real branch the remote repository to let fast-pathing
2088
self._real_branch.repository = self.repository
2089
if self._lock_mode == 'r':
2090
self._real_branch.lock_read()
2091
elif self._lock_mode == 'w':
2092
self._real_branch.lock_write(token=self._lock_token)
2094
def _translate_error(self, err, **context):
2095
self.repository._translate_error(err, branch=self, **context)
2097
def _clear_cached_state(self):
2098
super(RemoteBranch, self)._clear_cached_state()
2099
if self._real_branch is not None:
2100
self._real_branch._clear_cached_state()
2102
def _clear_cached_state_of_remote_branch_only(self):
2103
"""Like _clear_cached_state, but doesn't clear the cache of
2106
This is useful when falling back to calling a method of
2107
self._real_branch that changes state. In that case the underlying
2108
branch changes, so we need to invalidate this RemoteBranch's cache of
2109
it. However, there's no need to invalidate the _real_branch's cache
2110
too, in fact doing so might harm performance.
2112
super(RemoteBranch, self)._clear_cached_state()
2115
def control_files(self):
2116
# Defer actually creating RemoteBranchLockableFiles until its needed,
2117
# because it triggers an _ensure_real that we otherwise might not need.
2118
if self._control_files is None:
2119
self._control_files = RemoteBranchLockableFiles(
2120
self.bzrdir, self._client)
2121
return self._control_files
2123
def _get_checkout_format(self):
2125
return self._real_branch._get_checkout_format()
2127
def get_physical_lock_status(self):
2128
"""See Branch.get_physical_lock_status()."""
2129
# should be an API call to the server, as branches must be lockable.
2131
return self._real_branch.get_physical_lock_status()
2133
def get_stacked_on_url(self):
2134
"""Get the URL this branch is stacked against.
2136
:raises NotStacked: If the branch is not stacked.
2137
:raises UnstackableBranchFormat: If the branch does not support
2139
:raises UnstackableRepositoryFormat: If the repository does not support
2143
# there may not be a repository yet, so we can't use
2144
# self._translate_error, so we can't use self._call either.
2145
response = self._client.call('Branch.get_stacked_on_url',
2146
self._remote_path())
2147
except errors.ErrorFromSmartServer, err:
2148
# there may not be a repository yet, so we can't call through
2149
# its _translate_error
2150
_translate_error(err, branch=self)
2151
except errors.UnknownSmartMethod, err:
2153
return self._real_branch.get_stacked_on_url()
2154
if response[0] != 'ok':
2155
raise errors.UnexpectedSmartServerResponse(response)
2158
def set_stacked_on_url(self, url):
2159
branch.Branch.set_stacked_on_url(self, url)
2161
self._is_stacked = False
2163
self._is_stacked = True
2165
def _vfs_get_tags_bytes(self):
2167
return self._real_branch._get_tags_bytes()
2169
def _get_tags_bytes(self):
2170
medium = self._client._medium
2171
if medium._is_remote_before((1, 13)):
2172
return self._vfs_get_tags_bytes()
2174
response = self._call('Branch.get_tags_bytes', self._remote_path())
2175
except errors.UnknownSmartMethod:
2176
medium._remember_remote_is_before((1, 13))
2177
return self._vfs_get_tags_bytes()
2180
def _vfs_set_tags_bytes(self, bytes):
2182
return self._real_branch._set_tags_bytes(bytes)
2184
def _set_tags_bytes(self, bytes):
2185
medium = self._client._medium
2186
if medium._is_remote_before((1, 18)):
2187
self._vfs_set_tags_bytes(bytes)
2190
self._remote_path(), self._lock_token, self._repo_lock_token)
2191
response = self._call_with_body_bytes(
2192
'Branch.set_tags_bytes', args, bytes)
2193
except errors.UnknownSmartMethod:
2194
medium._remember_remote_is_before((1, 18))
2195
self._vfs_set_tags_bytes(bytes)
2197
def lock_read(self):
2198
self.repository.lock_read()
2199
if not self._lock_mode:
2200
self._lock_mode = 'r'
2201
self._lock_count = 1
2202
if self._real_branch is not None:
2203
self._real_branch.lock_read()
2205
self._lock_count += 1
2207
def _remote_lock_write(self, token):
2209
branch_token = repo_token = ''
2211
branch_token = token
2212
repo_token = self.repository.lock_write()
2213
self.repository.unlock()
2214
err_context = {'token': token}
2215
response = self._call(
2216
'Branch.lock_write', self._remote_path(), branch_token,
2217
repo_token or '', **err_context)
2218
if response[0] != 'ok':
2219
raise errors.UnexpectedSmartServerResponse(response)
2220
ok, branch_token, repo_token = response
2221
return branch_token, repo_token
2223
def lock_write(self, token=None):
2224
if not self._lock_mode:
2225
# Lock the branch and repo in one remote call.
2226
remote_tokens = self._remote_lock_write(token)
2227
self._lock_token, self._repo_lock_token = remote_tokens
2228
if not self._lock_token:
2229
raise SmartProtocolError('Remote server did not return a token!')
2230
# Tell the self.repository object that it is locked.
2231
self.repository.lock_write(
2232
self._repo_lock_token, _skip_rpc=True)
2234
if self._real_branch is not None:
2235
self._real_branch.lock_write(token=self._lock_token)
2236
if token is not None:
2237
self._leave_lock = True
2239
self._leave_lock = False
2240
self._lock_mode = 'w'
2241
self._lock_count = 1
2242
elif self._lock_mode == 'r':
2243
raise errors.ReadOnlyTransaction
2245
if token is not None:
2246
# A token was given to lock_write, and we're relocking, so
2247
# check that the given token actually matches the one we
2249
if token != self._lock_token:
2250
raise errors.TokenMismatch(token, self._lock_token)
2251
self._lock_count += 1
2252
# Re-lock the repository too.
2253
self.repository.lock_write(self._repo_lock_token)
2254
return self._lock_token or None
2256
def _unlock(self, branch_token, repo_token):
2257
err_context = {'token': str((branch_token, repo_token))}
2258
response = self._call(
2259
'Branch.unlock', self._remote_path(), branch_token,
2260
repo_token or '', **err_context)
2261
if response == ('ok',):
2263
raise errors.UnexpectedSmartServerResponse(response)
2267
self._lock_count -= 1
2268
if not self._lock_count:
2269
self._clear_cached_state()
2270
mode = self._lock_mode
2271
self._lock_mode = None
2272
if self._real_branch is not None:
2273
if (not self._leave_lock and mode == 'w' and
2274
self._repo_lock_token):
2275
# If this RemoteBranch will remove the physical lock
2276
# for the repository, make sure the _real_branch
2277
# doesn't do it first. (Because the _real_branch's
2278
# repository is set to be the RemoteRepository.)
2279
self._real_branch.repository.leave_lock_in_place()
2280
self._real_branch.unlock()
2282
# Only write-locked branched need to make a remote method
2283
# call to perform the unlock.
2285
if not self._lock_token:
2286
raise AssertionError('Locked, but no token!')
2287
branch_token = self._lock_token
2288
repo_token = self._repo_lock_token
2289
self._lock_token = None
2290
self._repo_lock_token = None
2291
if not self._leave_lock:
2292
self._unlock(branch_token, repo_token)
2294
self.repository.unlock()
2296
def break_lock(self):
2298
return self._real_branch.break_lock()
2300
def leave_lock_in_place(self):
2301
if not self._lock_token:
2302
raise NotImplementedError(self.leave_lock_in_place)
2303
self._leave_lock = True
2305
def dont_leave_lock_in_place(self):
2306
if not self._lock_token:
2307
raise NotImplementedError(self.dont_leave_lock_in_place)
2308
self._leave_lock = False
2310
def get_rev_id(self, revno, history=None):
2312
return _mod_revision.NULL_REVISION
2313
last_revision_info = self.last_revision_info()
2314
ok, result = self.repository.get_rev_id_for_revno(
2315
revno, last_revision_info)
2318
missing_parent = result[1]
2319
# Either the revision named by the server is missing, or its parent
2320
# is. Call get_parent_map to determine which, so that we report a
2322
parent_map = self.repository.get_parent_map([missing_parent])
2323
if missing_parent in parent_map:
2324
missing_parent = parent_map[missing_parent]
2325
raise errors.RevisionNotPresent(missing_parent, self.repository)
2327
def _last_revision_info(self):
2328
response = self._call('Branch.last_revision_info', self._remote_path())
2329
if response[0] != 'ok':
2330
raise SmartProtocolError('unexpected response code %s' % (response,))
2331
revno = int(response[1])
2332
last_revision = response[2]
2333
return (revno, last_revision)
2335
def _gen_revision_history(self):
2336
"""See Branch._gen_revision_history()."""
2337
if self._is_stacked:
2339
return self._real_branch._gen_revision_history()
2340
response_tuple, response_handler = self._call_expecting_body(
2341
'Branch.revision_history', self._remote_path())
2342
if response_tuple[0] != 'ok':
2343
raise errors.UnexpectedSmartServerResponse(response_tuple)
2344
result = response_handler.read_body_bytes().split('\x00')
2349
def _remote_path(self):
2350
return self.bzrdir._path_for_remote_call(self._client)
2352
def _set_last_revision_descendant(self, revision_id, other_branch,
2353
allow_diverged=False, allow_overwrite_descendant=False):
2354
# This performs additional work to meet the hook contract; while its
2355
# undesirable, we have to synthesise the revno to call the hook, and
2356
# not calling the hook is worse as it means changes can't be prevented.
2357
# Having calculated this though, we can't just call into
2358
# set_last_revision_info as a simple call, because there is a set_rh
2359
# hook that some folk may still be using.
2360
old_revno, old_revid = self.last_revision_info()
2361
history = self._lefthand_history(revision_id)
2362
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2363
err_context = {'other_branch': other_branch}
2364
response = self._call('Branch.set_last_revision_ex',
2365
self._remote_path(), self._lock_token, self._repo_lock_token,
2366
revision_id, int(allow_diverged), int(allow_overwrite_descendant),
2368
self._clear_cached_state()
2369
if len(response) != 3 and response[0] != 'ok':
2370
raise errors.UnexpectedSmartServerResponse(response)
2371
new_revno, new_revision_id = response[1:]
2372
self._last_revision_info_cache = new_revno, new_revision_id
2373
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2374
if self._real_branch is not None:
2375
cache = new_revno, new_revision_id
2376
self._real_branch._last_revision_info_cache = cache
2378
def _set_last_revision(self, revision_id):
2379
old_revno, old_revid = self.last_revision_info()
2380
# This performs additional work to meet the hook contract; while its
2381
# undesirable, we have to synthesise the revno to call the hook, and
2382
# not calling the hook is worse as it means changes can't be prevented.
2383
# Having calculated this though, we can't just call into
2384
# set_last_revision_info as a simple call, because there is a set_rh
2385
# hook that some folk may still be using.
2386
history = self._lefthand_history(revision_id)
2387
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2388
self._clear_cached_state()
2389
response = self._call('Branch.set_last_revision',
2390
self._remote_path(), self._lock_token, self._repo_lock_token,
2392
if response != ('ok',):
2393
raise errors.UnexpectedSmartServerResponse(response)
2394
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2397
def set_revision_history(self, rev_history):
2398
# Send just the tip revision of the history; the server will generate
2399
# the full history from that. If the revision doesn't exist in this
2400
# branch, NoSuchRevision will be raised.
2401
if rev_history == []:
2404
rev_id = rev_history[-1]
2405
self._set_last_revision(rev_id)
2406
for hook in branch.Branch.hooks['set_rh']:
2407
hook(self, rev_history)
2408
self._cache_revision_history(rev_history)
2410
def _get_parent_location(self):
2411
medium = self._client._medium
2412
if medium._is_remote_before((1, 13)):
2413
return self._vfs_get_parent_location()
2415
response = self._call('Branch.get_parent', self._remote_path())
2416
except errors.UnknownSmartMethod:
2417
medium._remember_remote_is_before((1, 13))
2418
return self._vfs_get_parent_location()
2419
if len(response) != 1:
2420
raise errors.UnexpectedSmartServerResponse(response)
2421
parent_location = response[0]
2422
if parent_location == '':
2424
return parent_location
2426
def _vfs_get_parent_location(self):
2428
return self._real_branch._get_parent_location()
2430
def _set_parent_location(self, url):
2431
medium = self._client._medium
2432
if medium._is_remote_before((1, 15)):
2433
return self._vfs_set_parent_location(url)
2435
call_url = url or ''
2436
if type(call_url) is not str:
2437
raise AssertionError('url must be a str or None (%s)' % url)
2438
response = self._call('Branch.set_parent_location',
2439
self._remote_path(), self._lock_token, self._repo_lock_token,
2441
except errors.UnknownSmartMethod:
2442
medium._remember_remote_is_before((1, 15))
2443
return self._vfs_set_parent_location(url)
2445
raise errors.UnexpectedSmartServerResponse(response)
2447
def _vfs_set_parent_location(self, url):
2449
return self._real_branch._set_parent_location(url)
2452
def pull(self, source, overwrite=False, stop_revision=None,
2454
self._clear_cached_state_of_remote_branch_only()
2456
return self._real_branch.pull(
2457
source, overwrite=overwrite, stop_revision=stop_revision,
2458
_override_hook_target=self, **kwargs)
2461
def push(self, target, overwrite=False, stop_revision=None):
2463
return self._real_branch.push(
2464
target, overwrite=overwrite, stop_revision=stop_revision,
2465
_override_hook_source_branch=self)
2467
def is_locked(self):
2468
return self._lock_count >= 1
2471
def revision_id_to_revno(self, revision_id):
2473
return self._real_branch.revision_id_to_revno(revision_id)
2476
def set_last_revision_info(self, revno, revision_id):
2477
# XXX: These should be returned by the set_last_revision_info verb
2478
old_revno, old_revid = self.last_revision_info()
2479
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2480
revision_id = ensure_null(revision_id)
2482
response = self._call('Branch.set_last_revision_info',
2483
self._remote_path(), self._lock_token, self._repo_lock_token,
2484
str(revno), revision_id)
2485
except errors.UnknownSmartMethod:
2487
self._clear_cached_state_of_remote_branch_only()
2488
self._real_branch.set_last_revision_info(revno, revision_id)
2489
self._last_revision_info_cache = revno, revision_id
2491
if response == ('ok',):
2492
self._clear_cached_state()
2493
self._last_revision_info_cache = revno, revision_id
2494
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2495
# Update the _real_branch's cache too.
2496
if self._real_branch is not None:
2497
cache = self._last_revision_info_cache
2498
self._real_branch._last_revision_info_cache = cache
2500
raise errors.UnexpectedSmartServerResponse(response)
2503
def generate_revision_history(self, revision_id, last_rev=None,
2505
medium = self._client._medium
2506
if not medium._is_remote_before((1, 6)):
2507
# Use a smart method for 1.6 and above servers
2509
self._set_last_revision_descendant(revision_id, other_branch,
2510
allow_diverged=True, allow_overwrite_descendant=True)
2512
except errors.UnknownSmartMethod:
2513
medium._remember_remote_is_before((1, 6))
2514
self._clear_cached_state_of_remote_branch_only()
2515
self.set_revision_history(self._lefthand_history(revision_id,
2516
last_rev=last_rev,other_branch=other_branch))
2518
def set_push_location(self, location):
2520
return self._real_branch.set_push_location(location)
2523
class RemoteConfig(object):
2524
"""A Config that reads and writes from smart verbs.
2526
It is a low-level object that considers config data to be name/value pairs
2527
that may be associated with a section. Assigning meaning to the these
2528
values is done at higher levels like bzrlib.config.TreeConfig.
2531
def get_option(self, name, section=None, default=None):
2532
"""Return the value associated with a named option.
2534
:param name: The name of the value
2535
:param section: The section the option is in (if any)
2536
:param default: The value to return if the value is not set
2537
:return: The value or default value
2540
configobj = self._get_configobj()
2542
section_obj = configobj
2545
section_obj = configobj[section]
2548
return section_obj.get(name, default)
2549
except errors.UnknownSmartMethod:
2550
return self._vfs_get_option(name, section, default)
2552
def _response_to_configobj(self, response):
2553
if len(response[0]) and response[0][0] != 'ok':
2554
raise errors.UnexpectedSmartServerResponse(response)
2555
lines = response[1].read_body_bytes().splitlines()
2556
return config.ConfigObj(lines, encoding='utf-8')
2559
class RemoteBranchConfig(RemoteConfig):
2560
"""A RemoteConfig for Branches."""
2562
def __init__(self, branch):
2563
self._branch = branch
2565
def _get_configobj(self):
2566
path = self._branch._remote_path()
2567
response = self._branch._client.call_expecting_body(
2568
'Branch.get_config_file', path)
2569
return self._response_to_configobj(response)
2571
def set_option(self, value, name, section=None):
2572
"""Set the value associated with a named option.
2574
:param value: The value to set
2575
:param name: The name of the value to set
2576
:param section: The section the option is in (if any)
2578
medium = self._branch._client._medium
2579
if medium._is_remote_before((1, 14)):
2580
return self._vfs_set_option(value, name, section)
2582
path = self._branch._remote_path()
2583
response = self._branch._client.call('Branch.set_config_option',
2584
path, self._branch._lock_token, self._branch._repo_lock_token,
2585
value.encode('utf8'), name, section or '')
2586
except errors.UnknownSmartMethod:
2587
medium._remember_remote_is_before((1, 14))
2588
return self._vfs_set_option(value, name, section)
2590
raise errors.UnexpectedSmartServerResponse(response)
2592
def _real_object(self):
2593
self._branch._ensure_real()
2594
return self._branch._real_branch
2596
def _vfs_set_option(self, value, name, section=None):
2597
return self._real_object()._get_config().set_option(
2598
value, name, section)
2601
class RemoteBzrDirConfig(RemoteConfig):
2602
"""A RemoteConfig for BzrDirs."""
2604
def __init__(self, bzrdir):
2605
self._bzrdir = bzrdir
2607
def _get_configobj(self):
2608
medium = self._bzrdir._client._medium
2609
verb = 'BzrDir.get_config_file'
2610
if medium._is_remote_before((1, 15)):
2611
raise errors.UnknownSmartMethod(verb)
2612
path = self._bzrdir._path_for_remote_call(self._bzrdir._client)
2613
response = self._bzrdir._call_expecting_body(
2615
return self._response_to_configobj(response)
2617
def _vfs_get_option(self, name, section, default):
2618
return self._real_object()._get_config().get_option(
2619
name, section, default)
2621
def set_option(self, value, name, section=None):
2622
"""Set the value associated with a named option.
2624
:param value: The value to set
2625
:param name: The name of the value to set
2626
:param section: The section the option is in (if any)
2628
return self._real_object()._get_config().set_option(
2629
value, name, section)
2631
def _real_object(self):
2632
self._bzrdir._ensure_real()
2633
return self._bzrdir._real_bzrdir
2637
def _extract_tar(tar, to_dir):
2638
"""Extract all the contents of a tarfile object.
2640
A replacement for extractall, which is not present in python2.4
2643
tar.extract(tarinfo, to_dir)
2646
def _translate_error(err, **context):
2647
"""Translate an ErrorFromSmartServer into a more useful error.
2649
Possible context keys:
2657
If the error from the server doesn't match a known pattern, then
2658
UnknownErrorFromSmartServer is raised.
2662
return context[name]
2663
except KeyError, key_err:
2664
mutter('Missing key %r in context %r', key_err.args[0], context)
2667
"""Get the path from the context if present, otherwise use first error
2671
return context['path']
2672
except KeyError, key_err:
2674
return err.error_args[0]
2675
except IndexError, idx_err:
2677
'Missing key %r in context %r', key_err.args[0], context)
2680
if err.error_verb == 'NoSuchRevision':
2681
raise NoSuchRevision(find('branch'), err.error_args[0])
2682
elif err.error_verb == 'nosuchrevision':
2683
raise NoSuchRevision(find('repository'), err.error_args[0])
2684
elif err.error_tuple == ('nobranch',):
2685
raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2686
elif err.error_verb == 'norepository':
2687
raise errors.NoRepositoryPresent(find('bzrdir'))
2688
elif err.error_verb == 'LockContention':
2689
raise errors.LockContention('(remote lock)')
2690
elif err.error_verb == 'UnlockableTransport':
2691
raise errors.UnlockableTransport(find('bzrdir').root_transport)
2692
elif err.error_verb == 'LockFailed':
2693
raise errors.LockFailed(err.error_args[0], err.error_args[1])
2694
elif err.error_verb == 'TokenMismatch':
2695
raise errors.TokenMismatch(find('token'), '(remote token)')
2696
elif err.error_verb == 'Diverged':
2697
raise errors.DivergedBranches(find('branch'), find('other_branch'))
2698
elif err.error_verb == 'TipChangeRejected':
2699
raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
2700
elif err.error_verb == 'UnstackableBranchFormat':
2701
raise errors.UnstackableBranchFormat(*err.error_args)
2702
elif err.error_verb == 'UnstackableRepositoryFormat':
2703
raise errors.UnstackableRepositoryFormat(*err.error_args)
2704
elif err.error_verb == 'NotStacked':
2705
raise errors.NotStacked(branch=find('branch'))
2706
elif err.error_verb == 'PermissionDenied':
2708
if len(err.error_args) >= 2:
2709
extra = err.error_args[1]
2712
raise errors.PermissionDenied(path, extra=extra)
2713
elif err.error_verb == 'ReadError':
2715
raise errors.ReadError(path)
2716
elif err.error_verb == 'NoSuchFile':
2718
raise errors.NoSuchFile(path)
2719
elif err.error_verb == 'FileExists':
2720
raise errors.FileExists(err.error_args[0])
2721
elif err.error_verb == 'DirectoryNotEmpty':
2722
raise errors.DirectoryNotEmpty(err.error_args[0])
2723
elif err.error_verb == 'ShortReadvError':
2724
args = err.error_args
2725
raise errors.ShortReadvError(
2726
args[0], int(args[1]), int(args[2]), int(args[3]))
2727
elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
2728
encoding = str(err.error_args[0]) # encoding must always be a string
2729
val = err.error_args[1]
2730
start = int(err.error_args[2])
2731
end = int(err.error_args[3])
2732
reason = str(err.error_args[4]) # reason must always be a string
2733
if val.startswith('u:'):
2734
val = val[2:].decode('utf-8')
2735
elif val.startswith('s:'):
2736
val = val[2:].decode('base64')
2737
if err.error_verb == 'UnicodeDecodeError':
2738
raise UnicodeDecodeError(encoding, val, start, end, reason)
2739
elif err.error_verb == 'UnicodeEncodeError':
2740
raise UnicodeEncodeError(encoding, val, start, end, reason)
2741
elif err.error_verb == 'ReadOnlyError':
2742
raise errors.TransportNotPossible('readonly transport')
2743
raise errors.UnknownErrorFromSmartServer(err)
added
removed
bzrlib/remote.py
