1
# Copyright (C) 2006, 2007, 2008 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
# TODO: At some point, handle upgrades by just passing the whole request
18
# across to run on the server.
35
from bzrlib.branch import BranchReferenceFormat
36
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
37
from bzrlib.decorators import needs_read_lock, needs_write_lock
38
from bzrlib.errors import (
42
from bzrlib.lockable_files import LockableFiles
43
from bzrlib.smart import client, vfs, repository as smart_repo
44
from bzrlib.revision import ensure_null, NULL_REVISION
45
from bzrlib.trace import mutter, note, warning
46
from bzrlib.util import bencode
49
class _RpcHelper(object):
50
"""Mixin class that helps with issuing RPCs."""
52
def _call(self, method, *args, **err_context):
54
return self._client.call(method, *args)
55
except errors.ErrorFromSmartServer, err:
56
self._translate_error(err, **err_context)
58
def _call_expecting_body(self, method, *args, **err_context):
60
return self._client.call_expecting_body(method, *args)
61
except errors.ErrorFromSmartServer, err:
62
self._translate_error(err, **err_context)
64
def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
67
return self._client.call_with_body_bytes_expecting_body(
68
method, args, body_bytes)
69
except errors.ErrorFromSmartServer, err:
70
self._translate_error(err, **err_context)
73
def response_tuple_to_repo_format(response):
74
"""Convert a response tuple describing a repository format to a format."""
75
format = RemoteRepositoryFormat()
76
format._rich_root_data = (response[0] == 'yes')
77
format._supports_tree_reference = (response[1] == 'yes')
78
format._supports_external_lookups = (response[2] == 'yes')
79
format._network_name = response[3]
83
# Note: RemoteBzrDirFormat is in bzrdir.py
85
class RemoteBzrDir(BzrDir, _RpcHelper):
86
"""Control directory on a remote server, accessed via bzr:// or similar."""
88
def __init__(self, transport, format, _client=None):
89
"""Construct a RemoteBzrDir.
91
:param _client: Private parameter for testing. Disables probing and the
94
BzrDir.__init__(self, transport, format)
95
# this object holds a delegated bzrdir that uses file-level operations
96
# to talk to the other side
97
self._real_bzrdir = None
98
# 1-shot cache for the call pattern 'create_branch; open_branch' - see
99
# create_branch for details.
100
self._next_open_branch_result = None
103
medium = transport.get_smart_medium()
104
self._client = client._SmartClient(medium)
106
self._client = _client
109
path = self._path_for_remote_call(self._client)
110
response = self._call('BzrDir.open', path)
111
if response not in [('yes',), ('no',)]:
112
raise errors.UnexpectedSmartServerResponse(response)
113
if response == ('no',):
114
raise errors.NotBranchError(path=transport.base)
116
def _ensure_real(self):
117
"""Ensure that there is a _real_bzrdir set.
119
Used before calls to self._real_bzrdir.
121
if not self._real_bzrdir:
122
self._real_bzrdir = BzrDir.open_from_transport(
123
self.root_transport, _server_formats=False)
124
self._format._network_name = \
125
self._real_bzrdir._format.network_name()
127
def _translate_error(self, err, **context):
128
_translate_error(err, bzrdir=self, **context)
130
def break_lock(self):
131
# Prevent aliasing problems in the next_open_branch_result cache.
132
# See create_branch for rationale.
133
self._next_open_branch_result = None
134
return BzrDir.break_lock(self)
136
def _vfs_cloning_metadir(self, require_stacking=False):
138
return self._real_bzrdir.cloning_metadir(
139
require_stacking=require_stacking)
141
def cloning_metadir(self, require_stacking=False):
142
medium = self._client._medium
143
if medium._is_remote_before((1, 13)):
144
return self._vfs_cloning_metadir(require_stacking=require_stacking)
145
verb = 'BzrDir.cloning_metadir'
150
path = self._path_for_remote_call(self._client)
152
response = self._call(verb, path, stacking)
153
except errors.UnknownSmartMethod:
154
medium._remember_remote_is_before((1, 13))
155
return self._vfs_cloning_metadir(require_stacking=require_stacking)
156
if len(response) != 3:
157
raise errors.UnexpectedSmartServerResponse(response)
158
control_name, repo_name, branch_info = response
159
if len(branch_info) != 2:
160
raise errors.UnexpectedSmartServerResponse(response)
161
branch_ref, branch_name = branch_info
162
format = bzrdir.network_format_registry.get(control_name)
164
format.repository_format = repository.network_format_registry.get(
166
if branch_ref == 'ref':
167
# XXX: we need possible_transports here to avoid reopening the
168
# connection to the referenced location
169
ref_bzrdir = BzrDir.open(branch_name)
170
branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
171
format.set_branch_format(branch_format)
172
elif branch_ref == 'branch':
174
format.set_branch_format(
175
branch.network_format_registry.get(branch_name))
177
raise errors.UnexpectedSmartServerResponse(response)
180
def create_repository(self, shared=False):
181
# as per meta1 formats - just delegate to the format object which may
183
result = self._format.repository_format.initialize(self, shared)
184
if not isinstance(result, RemoteRepository):
185
return self.open_repository()
189
def destroy_repository(self):
190
"""See BzrDir.destroy_repository"""
192
self._real_bzrdir.destroy_repository()
194
def create_branch(self):
195
# as per meta1 formats - just delegate to the format object which may
197
real_branch = self._format.get_branch_format().initialize(self)
198
if not isinstance(real_branch, RemoteBranch):
199
result = RemoteBranch(self, self.find_repository(), real_branch)
202
# BzrDir.clone_on_transport() uses the result of create_branch but does
203
# not return it to its callers; we save approximately 8% of our round
204
# trips by handing the branch we created back to the first caller to
205
# open_branch rather than probing anew. Long term we need a API in
206
# bzrdir that doesn't discard result objects (like result_branch).
208
self._next_open_branch_result = result
211
def destroy_branch(self):
212
"""See BzrDir.destroy_branch"""
214
self._real_bzrdir.destroy_branch()
215
self._next_open_branch_result = None
217
def create_workingtree(self, revision_id=None, from_branch=None):
218
raise errors.NotLocalUrl(self.transport.base)
220
def find_branch_format(self):
221
"""Find the branch 'format' for this bzrdir.
223
This might be a synthetic object for e.g. RemoteBranch and SVN.
225
b = self.open_branch()
228
def get_branch_reference(self):
229
"""See BzrDir.get_branch_reference()."""
230
response = self._get_branch_reference()
231
if response[0] == 'ref':
236
def _get_branch_reference(self):
237
path = self._path_for_remote_call(self._client)
238
medium = self._client._medium
239
if not medium._is_remote_before((1, 13)):
241
response = self._call('BzrDir.open_branchV2', path)
242
if response[0] not in ('ref', 'branch'):
243
raise errors.UnexpectedSmartServerResponse(response)
245
except errors.UnknownSmartMethod:
246
medium._remember_remote_is_before((1, 13))
247
response = self._call('BzrDir.open_branch', path)
248
if response[0] != 'ok':
249
raise errors.UnexpectedSmartServerResponse(response)
250
if response[1] != '':
251
return ('ref', response[1])
253
return ('branch', '')
255
def _get_tree_branch(self):
256
"""See BzrDir._get_tree_branch()."""
257
return None, self.open_branch()
259
def open_branch(self, _unsupported=False):
261
raise NotImplementedError('unsupported flag support not implemented yet.')
262
if self._next_open_branch_result is not None:
263
# See create_branch for details.
264
result = self._next_open_branch_result
265
self._next_open_branch_result = None
267
response = self._get_branch_reference()
268
if response[0] == 'ref':
269
# a branch reference, use the existing BranchReference logic.
270
format = BranchReferenceFormat()
271
return format.open(self, _found=True, location=response[1])
272
branch_format_name = response[1]
273
if not branch_format_name:
274
branch_format_name = None
275
format = RemoteBranchFormat(network_name=branch_format_name)
276
return RemoteBranch(self, self.find_repository(), format=format)
278
def _open_repo_v1(self, path):
279
verb = 'BzrDir.find_repository'
280
response = self._call(verb, path)
281
if response[0] != 'ok':
282
raise errors.UnexpectedSmartServerResponse(response)
283
# servers that only support the v1 method don't support external
286
repo = self._real_bzrdir.open_repository()
287
response = response + ('no', repo._format.network_name())
288
return response, repo
290
def _open_repo_v2(self, path):
291
verb = 'BzrDir.find_repositoryV2'
292
response = self._call(verb, path)
293
if response[0] != 'ok':
294
raise errors.UnexpectedSmartServerResponse(response)
296
repo = self._real_bzrdir.open_repository()
297
response = response + (repo._format.network_name(),)
298
return response, repo
300
def _open_repo_v3(self, path):
301
verb = 'BzrDir.find_repositoryV3'
302
medium = self._client._medium
303
if medium._is_remote_before((1, 13)):
304
raise errors.UnknownSmartMethod(verb)
306
response = self._call(verb, path)
307
except errors.UnknownSmartMethod:
308
medium._remember_remote_is_before((1, 13))
310
if response[0] != 'ok':
311
raise errors.UnexpectedSmartServerResponse(response)
312
return response, None
314
def open_repository(self):
315
path = self._path_for_remote_call(self._client)
317
for probe in [self._open_repo_v3, self._open_repo_v2,
320
response, real_repo = probe(path)
322
except errors.UnknownSmartMethod:
325
raise errors.UnknownSmartMethod('BzrDir.find_repository{3,2,}')
326
if response[0] != 'ok':
327
raise errors.UnexpectedSmartServerResponse(response)
328
if len(response) != 6:
329
raise SmartProtocolError('incorrect response length %s' % (response,))
330
if response[1] == '':
331
# repo is at this dir.
332
format = response_tuple_to_repo_format(response[2:])
333
# Used to support creating a real format instance when needed.
334
format._creating_bzrdir = self
335
remote_repo = RemoteRepository(self, format)
336
format._creating_repo = remote_repo
337
if real_repo is not None:
338
remote_repo._set_real_repository(real_repo)
341
raise errors.NoRepositoryPresent(self)
343
def open_workingtree(self, recommend_upgrade=True):
345
if self._real_bzrdir.has_workingtree():
346
raise errors.NotLocalUrl(self.root_transport)
348
raise errors.NoWorkingTree(self.root_transport.base)
350
def _path_for_remote_call(self, client):
351
"""Return the path to be used for this bzrdir in a remote call."""
352
return client.remote_path_from_transport(self.root_transport)
354
def get_branch_transport(self, branch_format):
356
return self._real_bzrdir.get_branch_transport(branch_format)
358
def get_repository_transport(self, repository_format):
360
return self._real_bzrdir.get_repository_transport(repository_format)
362
def get_workingtree_transport(self, workingtree_format):
364
return self._real_bzrdir.get_workingtree_transport(workingtree_format)
366
def can_convert_format(self):
367
"""Upgrading of remote bzrdirs is not supported yet."""
370
def needs_format_conversion(self, format=None):
371
"""Upgrading of remote bzrdirs is not supported yet."""
373
symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
374
% 'needs_format_conversion(format=None)')
377
def clone(self, url, revision_id=None, force_new_repo=False,
378
preserve_stacking=False):
380
return self._real_bzrdir.clone(url, revision_id=revision_id,
381
force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
383
def get_config(self):
385
return self._real_bzrdir.get_config()
388
class RemoteRepositoryFormat(repository.RepositoryFormat):
389
"""Format for repositories accessed over a _SmartClient.
391
Instances of this repository are represented by RemoteRepository
394
The RemoteRepositoryFormat is parameterized during construction
395
to reflect the capabilities of the real, remote format. Specifically
396
the attributes rich_root_data and supports_tree_reference are set
397
on a per instance basis, and are not set (and should not be) at
400
:ivar _custom_format: If set, a specific concrete repository format that
401
will be used when initializing a repository with this
402
RemoteRepositoryFormat.
403
:ivar _creating_repo: If set, the repository object that this
404
RemoteRepositoryFormat was created for: it can be called into
405
to obtain data like the network name.
408
_matchingbzrdir = RemoteBzrDirFormat()
411
repository.RepositoryFormat.__init__(self)
412
self._custom_format = None
413
self._network_name = None
414
self._creating_bzrdir = None
415
self._supports_external_lookups = None
416
self._supports_tree_reference = None
417
self._rich_root_data = None
420
def rich_root_data(self):
421
if self._rich_root_data is None:
423
self._rich_root_data = self._custom_format.rich_root_data
424
return self._rich_root_data
427
def supports_external_lookups(self):
428
if self._supports_external_lookups is None:
430
self._supports_external_lookups = \
431
self._custom_format.supports_external_lookups
432
return self._supports_external_lookups
435
def supports_tree_reference(self):
436
if self._supports_tree_reference is None:
438
self._supports_tree_reference = \
439
self._custom_format.supports_tree_reference
440
return self._supports_tree_reference
442
def _vfs_initialize(self, a_bzrdir, shared):
443
"""Helper for common code in initialize."""
444
if self._custom_format:
445
# Custom format requested
446
result = self._custom_format.initialize(a_bzrdir, shared=shared)
447
elif self._creating_bzrdir is not None:
448
# Use the format that the repository we were created to back
450
prior_repo = self._creating_bzrdir.open_repository()
451
prior_repo._ensure_real()
452
result = prior_repo._real_repository._format.initialize(
453
a_bzrdir, shared=shared)
455
# assume that a_bzr is a RemoteBzrDir but the smart server didn't
456
# support remote initialization.
457
# We delegate to a real object at this point (as RemoteBzrDir
458
# delegate to the repository format which would lead to infinite
459
# recursion if we just called a_bzrdir.create_repository.
460
a_bzrdir._ensure_real()
461
result = a_bzrdir._real_bzrdir.create_repository(shared=shared)
462
if not isinstance(result, RemoteRepository):
463
return self.open(a_bzrdir)
467
def initialize(self, a_bzrdir, shared=False):
468
# Being asked to create on a non RemoteBzrDir:
469
if not isinstance(a_bzrdir, RemoteBzrDir):
470
return self._vfs_initialize(a_bzrdir, shared)
471
medium = a_bzrdir._client._medium
472
if medium._is_remote_before((1, 13)):
473
return self._vfs_initialize(a_bzrdir, shared)
474
# Creating on a remote bzr dir.
475
# 1) get the network name to use.
476
if self._custom_format:
477
network_name = self._custom_format.network_name()
479
# Select the current bzrlib default and ask for that.
480
reference_bzrdir_format = bzrdir.format_registry.get('default')()
481
reference_format = reference_bzrdir_format.repository_format
482
network_name = reference_format.network_name()
483
# 2) try direct creation via RPC
484
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
485
verb = 'BzrDir.create_repository'
491
response = a_bzrdir._call(verb, path, network_name, shared_str)
492
except errors.UnknownSmartMethod:
493
# Fallback - use vfs methods
494
medium._remember_remote_is_before((1, 13))
495
return self._vfs_initialize(a_bzrdir, shared)
497
# Turn the response into a RemoteRepository object.
498
format = response_tuple_to_repo_format(response[1:])
499
# Used to support creating a real format instance when needed.
500
format._creating_bzrdir = a_bzrdir
501
remote_repo = RemoteRepository(a_bzrdir, format)
502
format._creating_repo = remote_repo
505
def open(self, a_bzrdir):
506
if not isinstance(a_bzrdir, RemoteBzrDir):
507
raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
508
return a_bzrdir.open_repository()
510
def _ensure_real(self):
511
if self._custom_format is None:
512
self._custom_format = repository.network_format_registry.get(
516
def _fetch_order(self):
518
return self._custom_format._fetch_order
521
def _fetch_uses_deltas(self):
523
return self._custom_format._fetch_uses_deltas
526
def _fetch_reconcile(self):
528
return self._custom_format._fetch_reconcile
530
def get_format_description(self):
531
return 'bzr remote repository'
533
def __eq__(self, other):
534
return self.__class__ is other.__class__
536
def check_conversion_target(self, target_format):
537
if self.rich_root_data and not target_format.rich_root_data:
538
raise errors.BadConversionTarget(
539
'Does not support rich root data.', target_format)
540
if (self.supports_tree_reference and
541
not getattr(target_format, 'supports_tree_reference', False)):
542
raise errors.BadConversionTarget(
543
'Does not support nested trees', target_format)
545
def network_name(self):
546
if self._network_name:
547
return self._network_name
548
self._creating_repo._ensure_real()
549
return self._creating_repo._real_repository._format.network_name()
552
def _serializer(self):
554
return self._custom_format._serializer
557
class RemoteRepository(_RpcHelper):
558
"""Repository accessed over rpc.
560
For the moment most operations are performed using local transport-backed
564
def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
565
"""Create a RemoteRepository instance.
567
:param remote_bzrdir: The bzrdir hosting this repository.
568
:param format: The RemoteFormat object to use.
569
:param real_repository: If not None, a local implementation of the
570
repository logic for the repository, usually accessing the data
572
:param _client: Private testing parameter - override the smart client
573
to be used by the repository.
576
self._real_repository = real_repository
578
self._real_repository = None
579
self.bzrdir = remote_bzrdir
581
self._client = remote_bzrdir._client
583
self._client = _client
584
self._format = format
585
self._lock_mode = None
586
self._lock_token = None
588
self._leave_lock = False
589
self._unstacked_provider = graph.CachingParentsProvider(
590
get_parent_map=self._get_parent_map_rpc)
591
self._unstacked_provider.disable_cache()
593
# These depend on the actual remote format, so force them off for
594
# maximum compatibility. XXX: In future these should depend on the
595
# remote repository instance, but this is irrelevant until we perform
596
# reconcile via an RPC call.
597
self._reconcile_does_inventory_gc = False
598
self._reconcile_fixes_text_parents = False
599
self._reconcile_backsup_inventory = False
600
self.base = self.bzrdir.transport.base
601
# Additional places to query for data.
602
self._fallback_repositories = []
605
return "%s(%s)" % (self.__class__.__name__, self.base)
609
def abort_write_group(self, suppress_errors=False):
610
"""Complete a write group on the decorated repository.
612
Smart methods peform operations in a single step so this api
613
is not really applicable except as a compatibility thunk
614
for older plugins that don't use e.g. the CommitBuilder
617
:param suppress_errors: see Repository.abort_write_group.
620
return self._real_repository.abort_write_group(
621
suppress_errors=suppress_errors)
623
def commit_write_group(self):
624
"""Complete a write group on the decorated repository.
626
Smart methods peform operations in a single step so this api
627
is not really applicable except as a compatibility thunk
628
for older plugins that don't use e.g. the CommitBuilder
632
return self._real_repository.commit_write_group()
634
def resume_write_group(self, tokens):
636
return self._real_repository.resume_write_group(tokens)
638
def suspend_write_group(self):
640
return self._real_repository.suspend_write_group()
642
def _ensure_real(self):
643
"""Ensure that there is a _real_repository set.
645
Used before calls to self._real_repository.
647
if self._real_repository is None:
648
self.bzrdir._ensure_real()
649
self._set_real_repository(
650
self.bzrdir._real_bzrdir.open_repository())
652
def _translate_error(self, err, **context):
653
self.bzrdir._translate_error(err, repository=self, **context)
655
def find_text_key_references(self):
656
"""Find the text key references within the repository.
658
:return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
659
revision_ids. Each altered file-ids has the exact revision_ids that
660
altered it listed explicitly.
661
:return: A dictionary mapping text keys ((fileid, revision_id) tuples)
662
to whether they were referred to by the inventory of the
663
revision_id that they contain. The inventory texts from all present
664
revision ids are assessed to generate this report.
667
return self._real_repository.find_text_key_references()
669
def _generate_text_key_index(self):
670
"""Generate a new text key index for the repository.
672
This is an expensive function that will take considerable time to run.
674
:return: A dict mapping (file_id, revision_id) tuples to a list of
675
parents, also (file_id, revision_id) tuples.
678
return self._real_repository._generate_text_key_index()
680
@symbol_versioning.deprecated_method(symbol_versioning.one_four)
681
def get_revision_graph(self, revision_id=None):
682
"""See Repository.get_revision_graph()."""
683
return self._get_revision_graph(revision_id)
685
def _get_revision_graph(self, revision_id):
686
"""Private method for using with old (< 1.2) servers to fallback."""
687
if revision_id is None:
689
elif revision.is_null(revision_id):
692
path = self.bzrdir._path_for_remote_call(self._client)
693
response = self._call_expecting_body(
694
'Repository.get_revision_graph', path, revision_id)
695
response_tuple, response_handler = response
696
if response_tuple[0] != 'ok':
697
raise errors.UnexpectedSmartServerResponse(response_tuple)
698
coded = response_handler.read_body_bytes()
700
# no revisions in this repository!
702
lines = coded.split('\n')
705
d = tuple(line.split())
706
revision_graph[d[0]] = d[1:]
708
return revision_graph
711
"""See Repository._get_sink()."""
712
return RemoteStreamSink(self)
714
def _get_source(self, to_format):
715
"""Return a source for streaming from this repository."""
716
return RemoteStreamSource(self, to_format)
718
def has_revision(self, revision_id):
719
"""See Repository.has_revision()."""
720
if revision_id == NULL_REVISION:
721
# The null revision is always present.
723
path = self.bzrdir._path_for_remote_call(self._client)
724
response = self._call('Repository.has_revision', path, revision_id)
725
if response[0] not in ('yes', 'no'):
726
raise errors.UnexpectedSmartServerResponse(response)
727
if response[0] == 'yes':
729
for fallback_repo in self._fallback_repositories:
730
if fallback_repo.has_revision(revision_id):
734
def has_revisions(self, revision_ids):
735
"""See Repository.has_revisions()."""
736
# FIXME: This does many roundtrips, particularly when there are
737
# fallback repositories. -- mbp 20080905
739
for revision_id in revision_ids:
740
if self.has_revision(revision_id):
741
result.add(revision_id)
744
def has_same_location(self, other):
745
return (self.__class__ is other.__class__ and
746
self.bzrdir.transport.base == other.bzrdir.transport.base)
748
def get_graph(self, other_repository=None):
749
"""Return the graph for this repository format"""
750
parents_provider = self._make_parents_provider(other_repository)
751
return graph.Graph(parents_provider)
753
def gather_stats(self, revid=None, committers=None):
754
"""See Repository.gather_stats()."""
755
path = self.bzrdir._path_for_remote_call(self._client)
756
# revid can be None to indicate no revisions, not just NULL_REVISION
757
if revid is None or revision.is_null(revid):
761
if committers is None or not committers:
762
fmt_committers = 'no'
764
fmt_committers = 'yes'
765
response_tuple, response_handler = self._call_expecting_body(
766
'Repository.gather_stats', path, fmt_revid, fmt_committers)
767
if response_tuple[0] != 'ok':
768
raise errors.UnexpectedSmartServerResponse(response_tuple)
770
body = response_handler.read_body_bytes()
772
for line in body.split('\n'):
775
key, val_text = line.split(':')
776
if key in ('revisions', 'size', 'committers'):
777
result[key] = int(val_text)
778
elif key in ('firstrev', 'latestrev'):
779
values = val_text.split(' ')[1:]
780
result[key] = (float(values[0]), long(values[1]))
784
def find_branches(self, using=False):
785
"""See Repository.find_branches()."""
786
# should be an API call to the server.
788
return self._real_repository.find_branches(using=using)
790
def get_physical_lock_status(self):
791
"""See Repository.get_physical_lock_status()."""
792
# should be an API call to the server.
794
return self._real_repository.get_physical_lock_status()
796
def is_in_write_group(self):
797
"""Return True if there is an open write group.
799
write groups are only applicable locally for the smart server..
801
if self._real_repository:
802
return self._real_repository.is_in_write_group()
805
return self._lock_count >= 1
808
"""See Repository.is_shared()."""
809
path = self.bzrdir._path_for_remote_call(self._client)
810
response = self._call('Repository.is_shared', path)
811
if response[0] not in ('yes', 'no'):
812
raise SmartProtocolError('unexpected response code %s' % (response,))
813
return response[0] == 'yes'
815
def is_write_locked(self):
816
return self._lock_mode == 'w'
819
# wrong eventually - want a local lock cache context
820
if not self._lock_mode:
821
self._lock_mode = 'r'
823
self._unstacked_provider.enable_cache(cache_misses=False)
824
if self._real_repository is not None:
825
self._real_repository.lock_read()
827
self._lock_count += 1
829
def _remote_lock_write(self, token):
830
path = self.bzrdir._path_for_remote_call(self._client)
833
err_context = {'token': token}
834
response = self._call('Repository.lock_write', path, token,
836
if response[0] == 'ok':
840
raise errors.UnexpectedSmartServerResponse(response)
842
def lock_write(self, token=None, _skip_rpc=False):
843
if not self._lock_mode:
845
if self._lock_token is not None:
846
if token != self._lock_token:
847
raise errors.TokenMismatch(token, self._lock_token)
848
self._lock_token = token
850
self._lock_token = self._remote_lock_write(token)
851
# if self._lock_token is None, then this is something like packs or
852
# svn where we don't get to lock the repo, or a weave style repository
853
# where we cannot lock it over the wire and attempts to do so will
855
if self._real_repository is not None:
856
self._real_repository.lock_write(token=self._lock_token)
857
if token is not None:
858
self._leave_lock = True
860
self._leave_lock = False
861
self._lock_mode = 'w'
863
self._unstacked_provider.enable_cache(cache_misses=False)
864
elif self._lock_mode == 'r':
865
raise errors.ReadOnlyError(self)
867
self._lock_count += 1
868
return self._lock_token or None
870
def leave_lock_in_place(self):
871
if not self._lock_token:
872
raise NotImplementedError(self.leave_lock_in_place)
873
self._leave_lock = True
875
def dont_leave_lock_in_place(self):
876
if not self._lock_token:
877
raise NotImplementedError(self.dont_leave_lock_in_place)
878
self._leave_lock = False
880
def _set_real_repository(self, repository):
881
"""Set the _real_repository for this repository.
883
:param repository: The repository to fallback to for non-hpss
884
implemented operations.
886
if self._real_repository is not None:
887
# Replacing an already set real repository.
888
# We cannot do this [currently] if the repository is locked -
889
# synchronised state might be lost.
891
raise AssertionError('_real_repository is already set')
892
if isinstance(repository, RemoteRepository):
893
raise AssertionError()
894
self._real_repository = repository
895
# If the _real_repository has _fallback_repositories, clear them out,
896
# because we want it to have the same set as this repository. This is
897
# reasonable to do because the fallbacks we clear here are from a
898
# "real" branch, and we're about to replace them with the equivalents
899
# from a RemoteBranch.
900
self._real_repository._fallback_repositories = []
901
for fb in self._fallback_repositories:
902
self._real_repository.add_fallback_repository(fb)
903
if self._lock_mode == 'w':
904
# if we are already locked, the real repository must be able to
905
# acquire the lock with our token.
906
self._real_repository.lock_write(self._lock_token)
907
elif self._lock_mode == 'r':
908
self._real_repository.lock_read()
910
def start_write_group(self):
911
"""Start a write group on the decorated repository.
913
Smart methods peform operations in a single step so this api
914
is not really applicable except as a compatibility thunk
915
for older plugins that don't use e.g. the CommitBuilder
919
return self._real_repository.start_write_group()
921
def _unlock(self, token):
922
path = self.bzrdir._path_for_remote_call(self._client)
924
# with no token the remote repository is not persistently locked.
926
err_context = {'token': token}
927
response = self._call('Repository.unlock', path, token,
929
if response == ('ok',):
932
raise errors.UnexpectedSmartServerResponse(response)
935
if not self._lock_count:
936
raise errors.LockNotHeld(self)
937
self._lock_count -= 1
938
if self._lock_count > 0:
940
self._unstacked_provider.disable_cache()
941
old_mode = self._lock_mode
942
self._lock_mode = None
944
# The real repository is responsible at present for raising an
945
# exception if it's in an unfinished write group. However, it
946
# normally will *not* actually remove the lock from disk - that's
947
# done by the server on receiving the Repository.unlock call.
948
# This is just to let the _real_repository stay up to date.
949
if self._real_repository is not None:
950
self._real_repository.unlock()
952
# The rpc-level lock should be released even if there was a
953
# problem releasing the vfs-based lock.
955
# Only write-locked repositories need to make a remote method
956
# call to perfom the unlock.
957
old_token = self._lock_token
958
self._lock_token = None
959
if not self._leave_lock:
960
self._unlock(old_token)
962
def break_lock(self):
963
# should hand off to the network
965
return self._real_repository.break_lock()
967
def _get_tarball(self, compression):
968
"""Return a TemporaryFile containing a repository tarball.
970
Returns None if the server does not support sending tarballs.
973
path = self.bzrdir._path_for_remote_call(self._client)
975
response, protocol = self._call_expecting_body(
976
'Repository.tarball', path, compression)
977
except errors.UnknownSmartMethod:
978
protocol.cancel_read_body()
980
if response[0] == 'ok':
981
# Extract the tarball and return it
982
t = tempfile.NamedTemporaryFile()
983
# TODO: rpc layer should read directly into it...
984
t.write(protocol.read_body_bytes())
987
raise errors.UnexpectedSmartServerResponse(response)
989
def sprout(self, to_bzrdir, revision_id=None):
990
# TODO: Option to control what format is created?
992
dest_repo = self._real_repository._format.initialize(to_bzrdir,
994
dest_repo.fetch(self, revision_id=revision_id)
997
### These methods are just thin shims to the VFS object for now.
999
def revision_tree(self, revision_id):
1001
return self._real_repository.revision_tree(revision_id)
1003
def get_serializer_format(self):
1005
return self._real_repository.get_serializer_format()
1007
def get_commit_builder(self, branch, parents, config, timestamp=None,
1008
timezone=None, committer=None, revprops=None,
1010
# FIXME: It ought to be possible to call this without immediately
1011
# triggering _ensure_real. For now it's the easiest thing to do.
1013
real_repo = self._real_repository
1014
builder = real_repo.get_commit_builder(branch, parents,
1015
config, timestamp=timestamp, timezone=timezone,
1016
committer=committer, revprops=revprops, revision_id=revision_id)
1019
def add_fallback_repository(self, repository):
1020
"""Add a repository to use for looking up data not held locally.
1022
:param repository: A repository.
1024
if not self._format.supports_external_lookups:
1025
raise errors.UnstackableRepositoryFormat(
1026
self._format.network_name(), self.base)
1027
# We need to accumulate additional repositories here, to pass them in
1030
self._fallback_repositories.append(repository)
1031
# If self._real_repository was parameterised already (e.g. because a
1032
# _real_branch had its get_stacked_on_url method called), then the
1033
# repository to be added may already be in the _real_repositories list.
1034
if self._real_repository is not None:
1035
if repository not in self._real_repository._fallback_repositories:
1036
self._real_repository.add_fallback_repository(repository)
1038
# They are also seen by the fallback repository. If it doesn't
1039
# exist yet they'll be added then. This implicitly copies them.
1042
def add_inventory(self, revid, inv, parents):
1044
return self._real_repository.add_inventory(revid, inv, parents)
1046
def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1049
return self._real_repository.add_inventory_by_delta(basis_revision_id,
1050
delta, new_revision_id, parents)
1052
def add_revision(self, rev_id, rev, inv=None, config=None):
1054
return self._real_repository.add_revision(
1055
rev_id, rev, inv=inv, config=config)
1058
def get_inventory(self, revision_id):
1060
return self._real_repository.get_inventory(revision_id)
1062
def iter_inventories(self, revision_ids):
1064
return self._real_repository.iter_inventories(revision_ids)
1067
def get_revision(self, revision_id):
1069
return self._real_repository.get_revision(revision_id)
1071
def get_transaction(self):
1073
return self._real_repository.get_transaction()
1076
def clone(self, a_bzrdir, revision_id=None):
1078
return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
1080
def make_working_trees(self):
1081
"""See Repository.make_working_trees"""
1083
return self._real_repository.make_working_trees()
1085
def revision_ids_to_search_result(self, result_set):
1086
"""Convert a set of revision ids to a graph SearchResult."""
1087
result_parents = set()
1088
for parents in self.get_graph().get_parent_map(
1089
result_set).itervalues():
1090
result_parents.update(parents)
1091
included_keys = result_set.intersection(result_parents)
1092
start_keys = result_set.difference(included_keys)
1093
exclude_keys = result_parents.difference(result_set)
1094
result = graph.SearchResult(start_keys, exclude_keys,
1095
len(result_set), result_set)
1099
def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1100
"""Return the revision ids that other has that this does not.
1102
These are returned in topological order.
1104
revision_id: only return revision ids included by revision_id.
1106
return repository.InterRepository.get(
1107
other, self).search_missing_revision_ids(revision_id, find_ghosts)
1109
def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1111
if fetch_spec is not None and revision_id is not None:
1112
raise AssertionError(
1113
"fetch_spec and revision_id are mutually exclusive.")
1114
# Not delegated to _real_repository so that InterRepository.get has a
1115
# chance to find an InterRepository specialised for RemoteRepository.
1116
if self.has_same_location(source) and fetch_spec is None:
1117
# check that last_revision is in 'from' and then return a
1119
if (revision_id is not None and
1120
not revision.is_null(revision_id)):
1121
self.get_revision(revision_id)
1123
inter = repository.InterRepository.get(source, self)
1125
return inter.fetch(revision_id=revision_id, pb=pb,
1126
find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1127
except NotImplementedError:
1128
raise errors.IncompatibleRepositories(source, self)
1130
def create_bundle(self, target, base, fileobj, format=None):
1132
self._real_repository.create_bundle(target, base, fileobj, format)
1135
def get_ancestry(self, revision_id, topo_sorted=True):
1137
return self._real_repository.get_ancestry(revision_id, topo_sorted)
1139
def fileids_altered_by_revision_ids(self, revision_ids):
1141
return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
1143
def _get_versioned_file_checker(self, revisions, revision_versions_cache):
1145
return self._real_repository._get_versioned_file_checker(
1146
revisions, revision_versions_cache)
1148
def iter_files_bytes(self, desired_files):
1149
"""See Repository.iter_file_bytes.
1152
return self._real_repository.iter_files_bytes(desired_files)
1154
def get_parent_map(self, revision_ids):
1155
"""See bzrlib.Graph.get_parent_map()."""
1156
return self._make_parents_provider().get_parent_map(revision_ids)
1158
def _get_parent_map_rpc(self, keys):
1159
"""Helper for get_parent_map that performs the RPC."""
1160
medium = self._client._medium
1161
if medium._is_remote_before((1, 2)):
1162
# We already found out that the server can't understand
1163
# Repository.get_parent_map requests, so just fetch the whole
1165
# XXX: Note that this will issue a deprecation warning. This is ok
1166
# :- its because we're working with a deprecated server anyway, and
1167
# the user will almost certainly have seen a warning about the
1168
# server version already.
1169
rg = self.get_revision_graph()
1170
# There is an api discrepency between get_parent_map and
1171
# get_revision_graph. Specifically, a "key:()" pair in
1172
# get_revision_graph just means a node has no parents. For
1173
# "get_parent_map" it means the node is a ghost. So fix up the
1174
# graph to correct this.
1175
# https://bugs.launchpad.net/bzr/+bug/214894
1176
# There is one other "bug" which is that ghosts in
1177
# get_revision_graph() are not returned at all. But we won't worry
1178
# about that for now.
1179
for node_id, parent_ids in rg.iteritems():
1180
if parent_ids == ():
1181
rg[node_id] = (NULL_REVISION,)
1182
rg[NULL_REVISION] = ()
1187
raise ValueError('get_parent_map(None) is not valid')
1188
if NULL_REVISION in keys:
1189
keys.discard(NULL_REVISION)
1190
found_parents = {NULL_REVISION:()}
1192
return found_parents
1195
# TODO(Needs analysis): We could assume that the keys being requested
1196
# from get_parent_map are in a breadth first search, so typically they
1197
# will all be depth N from some common parent, and we don't have to
1198
# have the server iterate from the root parent, but rather from the
1199
# keys we're searching; and just tell the server the keyspace we
1200
# already have; but this may be more traffic again.
1202
# Transform self._parents_map into a search request recipe.
1203
# TODO: Manage this incrementally to avoid covering the same path
1204
# repeatedly. (The server will have to on each request, but the less
1205
# work done the better).
1206
parents_map = self._unstacked_provider.get_cached_map()
1207
if parents_map is None:
1208
# Repository is not locked, so there's no cache.
1210
start_set = set(parents_map)
1211
result_parents = set()
1212
for parents in parents_map.itervalues():
1213
result_parents.update(parents)
1214
stop_keys = result_parents.difference(start_set)
1215
included_keys = start_set.intersection(result_parents)
1216
start_set.difference_update(included_keys)
1217
recipe = (start_set, stop_keys, len(parents_map))
1218
body = self._serialise_search_recipe(recipe)
1219
path = self.bzrdir._path_for_remote_call(self._client)
1221
if type(key) is not str:
1223
"key %r not a plain string" % (key,))
1224
verb = 'Repository.get_parent_map'
1225
args = (path,) + tuple(keys)
1227
response = self._call_with_body_bytes_expecting_body(
1229
except errors.UnknownSmartMethod:
1230
# Server does not support this method, so get the whole graph.
1231
# Worse, we have to force a disconnection, because the server now
1232
# doesn't realise it has a body on the wire to consume, so the
1233
# only way to recover is to abandon the connection.
1235
'Server is too old for fast get_parent_map, reconnecting. '
1236
'(Upgrade the server to Bazaar 1.2 to avoid this)')
1238
# To avoid having to disconnect repeatedly, we keep track of the
1239
# fact the server doesn't understand remote methods added in 1.2.
1240
medium._remember_remote_is_before((1, 2))
1241
return self.get_revision_graph(None)
1242
response_tuple, response_handler = response
1243
if response_tuple[0] not in ['ok']:
1244
response_handler.cancel_read_body()
1245
raise errors.UnexpectedSmartServerResponse(response_tuple)
1246
if response_tuple[0] == 'ok':
1247
coded = bz2.decompress(response_handler.read_body_bytes())
1249
# no revisions found
1251
lines = coded.split('\n')
1254
d = tuple(line.split())
1256
revision_graph[d[0]] = d[1:]
1258
# No parents - so give the Graph result (NULL_REVISION,).
1259
revision_graph[d[0]] = (NULL_REVISION,)
1260
return revision_graph
1263
def get_signature_text(self, revision_id):
1265
return self._real_repository.get_signature_text(revision_id)
1268
@symbol_versioning.deprecated_method(symbol_versioning.one_three)
1269
def get_revision_graph_with_ghosts(self, revision_ids=None):
1271
return self._real_repository.get_revision_graph_with_ghosts(
1272
revision_ids=revision_ids)
1275
def get_inventory_xml(self, revision_id):
1277
return self._real_repository.get_inventory_xml(revision_id)
1279
def deserialise_inventory(self, revision_id, xml):
1281
return self._real_repository.deserialise_inventory(revision_id, xml)
1283
def reconcile(self, other=None, thorough=False):
1285
return self._real_repository.reconcile(other=other, thorough=thorough)
1287
def all_revision_ids(self):
1289
return self._real_repository.all_revision_ids()
1292
def get_deltas_for_revisions(self, revisions):
1294
return self._real_repository.get_deltas_for_revisions(revisions)
1297
def get_revision_delta(self, revision_id):
1299
return self._real_repository.get_revision_delta(revision_id)
1302
def revision_trees(self, revision_ids):
1304
return self._real_repository.revision_trees(revision_ids)
1307
def get_revision_reconcile(self, revision_id):
1309
return self._real_repository.get_revision_reconcile(revision_id)
1312
def check(self, revision_ids=None):
1314
return self._real_repository.check(revision_ids=revision_ids)
1316
def copy_content_into(self, destination, revision_id=None):
1318
return self._real_repository.copy_content_into(
1319
destination, revision_id=revision_id)
1321
def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
1322
# get a tarball of the remote repository, and copy from that into the
1324
from bzrlib import osutils
1326
# TODO: Maybe a progress bar while streaming the tarball?
1327
note("Copying repository content as tarball...")
1328
tar_file = self._get_tarball('bz2')
1329
if tar_file is None:
1331
destination = to_bzrdir.create_repository()
1333
tar = tarfile.open('repository', fileobj=tar_file,
1335
tmpdir = osutils.mkdtemp()
1337
_extract_tar(tar, tmpdir)
1338
tmp_bzrdir = BzrDir.open(tmpdir)
1339
tmp_repo = tmp_bzrdir.open_repository()
1340
tmp_repo.copy_content_into(destination, revision_id)
1342
osutils.rmtree(tmpdir)
1346
# TODO: Suggestion from john: using external tar is much faster than
1347
# python's tarfile library, but it may not work on windows.
1350
def inventories(self):
1351
"""Decorate the real repository for now.
1353
In the long term a full blown network facility is needed to
1354
avoid creating a real repository object locally.
1357
return self._real_repository.inventories
1361
"""Compress the data within the repository.
1363
This is not currently implemented within the smart server.
1366
return self._real_repository.pack()
1369
def revisions(self):
1370
"""Decorate the real repository for now.
1372
In the short term this should become a real object to intercept graph
1375
In the long term a full blown network facility is needed.
1378
return self._real_repository.revisions
1380
def set_make_working_trees(self, new_value):
1382
new_value_str = "True"
1384
new_value_str = "False"
1385
path = self.bzrdir._path_for_remote_call(self._client)
1387
response = self._call(
1388
'Repository.set_make_working_trees', path, new_value_str)
1389
except errors.UnknownSmartMethod:
1391
self._real_repository.set_make_working_trees(new_value)
1393
if response[0] != 'ok':
1394
raise errors.UnexpectedSmartServerResponse(response)
1397
def signatures(self):
1398
"""Decorate the real repository for now.
1400
In the long term a full blown network facility is needed to avoid
1401
creating a real repository object locally.
1404
return self._real_repository.signatures
1407
def sign_revision(self, revision_id, gpg_strategy):
1409
return self._real_repository.sign_revision(revision_id, gpg_strategy)
1413
"""Decorate the real repository for now.
1415
In the long term a full blown network facility is needed to avoid
1416
creating a real repository object locally.
1419
return self._real_repository.texts
1422
def get_revisions(self, revision_ids):
1424
return self._real_repository.get_revisions(revision_ids)
1426
def supports_rich_root(self):
1427
return self._format.rich_root_data
1429
def iter_reverse_revision_history(self, revision_id):
1431
return self._real_repository.iter_reverse_revision_history(revision_id)
1434
def _serializer(self):
1435
return self._format._serializer
1437
def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1439
return self._real_repository.store_revision_signature(
1440
gpg_strategy, plaintext, revision_id)
1442
def add_signature_text(self, revision_id, signature):
1444
return self._real_repository.add_signature_text(revision_id, signature)
1446
def has_signature_for_revision_id(self, revision_id):
1448
return self._real_repository.has_signature_for_revision_id(revision_id)
1450
def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1452
return self._real_repository.item_keys_introduced_by(revision_ids,
1453
_files_pb=_files_pb)
1455
def revision_graph_can_have_wrong_parents(self):
1456
# The answer depends on the remote repo format.
1458
return self._real_repository.revision_graph_can_have_wrong_parents()
1460
def _find_inconsistent_revision_parents(self):
1462
return self._real_repository._find_inconsistent_revision_parents()
1464
def _check_for_inconsistent_revision_parents(self):
1466
return self._real_repository._check_for_inconsistent_revision_parents()
1468
def _make_parents_provider(self, other=None):
1469
providers = [self._unstacked_provider]
1470
if other is not None:
1471
providers.insert(0, other)
1472
providers.extend(r._make_parents_provider() for r in
1473
self._fallback_repositories)
1474
return graph._StackedParentsProvider(providers)
1476
def _serialise_search_recipe(self, recipe):
1477
"""Serialise a graph search recipe.
1479
:param recipe: A search recipe (start, stop, count).
1480
:return: Serialised bytes.
1482
start_keys = ' '.join(recipe[0])
1483
stop_keys = ' '.join(recipe[1])
1484
count = str(recipe[2])
1485
return '\n'.join((start_keys, stop_keys, count))
1487
def _serialise_search_result(self, search_result):
1488
if isinstance(search_result, graph.PendingAncestryResult):
1489
parts = ['ancestry-of']
1490
parts.extend(search_result.heads)
1492
recipe = search_result.get_recipe()
1493
parts = ['search', self._serialise_search_recipe(recipe)]
1494
return '\n'.join(parts)
1497
path = self.bzrdir._path_for_remote_call(self._client)
1499
response = self._call('PackRepository.autopack', path)
1500
except errors.UnknownSmartMethod:
1502
self._real_repository._pack_collection.autopack()
1504
if self._real_repository is not None:
1505
# Reset the real repository's cache of pack names.
1506
# XXX: At some point we may be able to skip this and just rely on
1507
# the automatic retry logic to do the right thing, but for now we
1508
# err on the side of being correct rather than being optimal.
1509
self._real_repository._pack_collection.reload_pack_names()
1510
if response[0] != 'ok':
1511
raise errors.UnexpectedSmartServerResponse(response)
1514
class RemoteStreamSink(repository.StreamSink):
1516
def _insert_real(self, stream, src_format, resume_tokens):
1517
self.target_repo._ensure_real()
1518
sink = self.target_repo._real_repository._get_sink()
1519
result = sink.insert_stream(stream, src_format, resume_tokens)
1521
self.target_repo.autopack()
1524
def insert_stream(self, stream, src_format, resume_tokens):
1525
repo = self.target_repo
1526
client = repo._client
1527
medium = client._medium
1528
if medium._is_remote_before((1, 13)):
1529
# No possible way this can work.
1530
return self._insert_real(stream, src_format, resume_tokens)
1531
path = repo.bzrdir._path_for_remote_call(client)
1532
if not resume_tokens:
1533
# XXX: Ugly but important for correctness, *will* be fixed during
1534
# 1.13 cycle. Pushing a stream that is interrupted results in a
1535
# fallback to the _real_repositories sink *with a partial stream*.
1536
# Thats bad because we insert less data than bzr expected. To avoid
1537
# this we do a trial push to make sure the verb is accessible, and
1538
# do not fallback when actually pushing the stream. A cleanup patch
1539
# is going to look at rewinding/restarting the stream/partial
1541
byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1543
response = client.call_with_body_stream(
1544
('Repository.insert_stream', path, ''), byte_stream)
1545
except errors.UnknownSmartMethod:
1546
medium._remember_remote_is_before((1,13))
1547
return self._insert_real(stream, src_format, resume_tokens)
1548
byte_stream = smart_repo._stream_to_byte_stream(
1550
resume_tokens = ' '.join(resume_tokens)
1551
response = client.call_with_body_stream(
1552
('Repository.insert_stream', path, resume_tokens), byte_stream)
1553
if response[0][0] not in ('ok', 'missing-basis'):
1554
raise errors.UnexpectedSmartServerResponse(response)
1555
if response[0][0] == 'missing-basis':
1556
tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1557
resume_tokens = tokens
1558
return resume_tokens, missing_keys
1560
if self.target_repo._real_repository is not None:
1561
collection = getattr(self.target_repo._real_repository,
1562
'_pack_collection', None)
1563
if collection is not None:
1564
collection.reload_pack_names()
1568
class RemoteStreamSource(repository.StreamSource):
1569
"""Stream data from a remote server."""
1571
def get_stream(self, search):
1572
# streaming with fallback repositories is not well defined yet: The
1573
# remote repository cannot see the fallback repositories, and thus
1574
# cannot satisfy the entire search in the general case. Likewise the
1575
# fallback repositories cannot reify the search to determine what they
1576
# should send. It likely needs a return value in the stream listing the
1577
# edge of the search to resume from in fallback repositories.
1578
if self.from_repository._fallback_repositories:
1579
return repository.StreamSource.get_stream(self, search)
1580
repo = self.from_repository
1581
client = repo._client
1582
medium = client._medium
1583
if medium._is_remote_before((1, 13)):
1584
# No possible way this can work.
1585
return repository.StreamSource.get_stream(self, search)
1586
path = repo.bzrdir._path_for_remote_call(client)
1588
search_bytes = repo._serialise_search_result(search)
1589
response = repo._call_with_body_bytes_expecting_body(
1590
'Repository.get_stream',
1591
(path, self.to_format.network_name()), search_bytes)
1592
response_tuple, response_handler = response
1593
except errors.UnknownSmartMethod:
1594
medium._remember_remote_is_before((1,13))
1595
return repository.StreamSource.get_stream(self, search)
1596
if response_tuple[0] != 'ok':
1597
raise errors.UnexpectedSmartServerResponse(response_tuple)
1598
byte_stream = response_handler.read_streamed_body()
1599
src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
1600
if src_format.network_name() != repo._format.network_name():
1601
raise AssertionError(
1602
"Mismatched RemoteRepository and stream src %r, %r" % (
1603
src_format.network_name(), repo._format.network_name()))
1607
class RemoteBranchLockableFiles(LockableFiles):
1608
"""A 'LockableFiles' implementation that talks to a smart server.
1610
This is not a public interface class.
1613
def __init__(self, bzrdir, _client):
1614
self.bzrdir = bzrdir
1615
self._client = _client
1616
self._need_find_modes = True
1617
LockableFiles.__init__(
1618
self, bzrdir.get_branch_transport(None),
1619
'lock', lockdir.LockDir)
1621
def _find_modes(self):
1622
# RemoteBranches don't let the client set the mode of control files.
1623
self._dir_mode = None
1624
self._file_mode = None
1627
class RemoteBranchFormat(branch.BranchFormat):
1629
def __init__(self, network_name=None):
1630
super(RemoteBranchFormat, self).__init__()
1631
self._matchingbzrdir = RemoteBzrDirFormat()
1632
self._matchingbzrdir.set_branch_format(self)
1633
self._custom_format = None
1634
self._network_name = network_name
1636
def __eq__(self, other):
1637
return (isinstance(other, RemoteBranchFormat) and
1638
self.__dict__ == other.__dict__)
1640
def _ensure_real(self):
1641
if self._custom_format is None:
1642
self._custom_format = branch.network_format_registry.get(
1645
def get_format_description(self):
1646
return 'Remote BZR Branch'
1648
def network_name(self):
1649
return self._network_name
1651
def open(self, a_bzrdir):
1652
return a_bzrdir.open_branch()
1654
def _vfs_initialize(self, a_bzrdir):
1655
# Initialisation when using a local bzrdir object, or a non-vfs init
1656
# method is not available on the server.
1657
# self._custom_format is always set - the start of initialize ensures
1659
if isinstance(a_bzrdir, RemoteBzrDir):
1660
a_bzrdir._ensure_real()
1661
result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
1663
# We assume the bzrdir is parameterised; it may not be.
1664
result = self._custom_format.initialize(a_bzrdir)
1665
if (isinstance(a_bzrdir, RemoteBzrDir) and
1666
not isinstance(result, RemoteBranch)):
1667
result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
1670
def initialize(self, a_bzrdir):
1671
# 1) get the network name to use.
1672
if self._custom_format:
1673
network_name = self._custom_format.network_name()
1675
# Select the current bzrlib default and ask for that.
1676
reference_bzrdir_format = bzrdir.format_registry.get('default')()
1677
reference_format = reference_bzrdir_format.get_branch_format()
1678
self._custom_format = reference_format
1679
network_name = reference_format.network_name()
1680
# Being asked to create on a non RemoteBzrDir:
1681
if not isinstance(a_bzrdir, RemoteBzrDir):
1682
return self._vfs_initialize(a_bzrdir)
1683
medium = a_bzrdir._client._medium
1684
if medium._is_remote_before((1, 13)):
1685
return self._vfs_initialize(a_bzrdir)
1686
# Creating on a remote bzr dir.
1687
# 2) try direct creation via RPC
1688
path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
1689
verb = 'BzrDir.create_branch'
1691
response = a_bzrdir._call(verb, path, network_name)
1692
except errors.UnknownSmartMethod:
1693
# Fallback - use vfs methods
1694
medium._remember_remote_is_before((1, 13))
1695
return self._vfs_initialize(a_bzrdir)
1696
if response[0] != 'ok':
1697
raise errors.UnexpectedSmartServerResponse(response)
1698
# Turn the response into a RemoteRepository object.
1699
format = RemoteBranchFormat(network_name=response[1])
1700
repo_format = response_tuple_to_repo_format(response[3:])
1701
if response[2] == '':
1702
repo_bzrdir = a_bzrdir
1704
repo_bzrdir = RemoteBzrDir(
1705
a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
1707
remote_repo = RemoteRepository(repo_bzrdir, repo_format)
1708
remote_branch = RemoteBranch(a_bzrdir, remote_repo,
1709
format=format, setup_stacking=False)
1710
# XXX: We know this is a new branch, so it must have revno 0, revid
1711
# NULL_REVISION. Creating the branch locked would make this be unable
1712
# to be wrong; here its simply very unlikely to be wrong. RBC 20090225
1713
remote_branch._last_revision_info_cache = 0, NULL_REVISION
1714
return remote_branch
1716
def make_tags(self, branch):
1718
return self._custom_format.make_tags(branch)
1720
def supports_tags(self):
1721
# Remote branches might support tags, but we won't know until we
1722
# access the real remote branch.
1724
return self._custom_format.supports_tags()
1726
def supports_stacking(self):
1728
return self._custom_format.supports_stacking()
1731
class RemoteBranch(branch.Branch, _RpcHelper):
1732
"""Branch stored on a server accessed by HPSS RPC.
1734
At the moment most operations are mapped down to simple file operations.
1737
def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1738
_client=None, format=None, setup_stacking=True):
1739
"""Create a RemoteBranch instance.
1741
:param real_branch: An optional local implementation of the branch
1742
format, usually accessing the data via the VFS.
1743
:param _client: Private parameter for testing.
1744
:param format: A RemoteBranchFormat object, None to create one
1745
automatically. If supplied it should have a network_name already
1747
:param setup_stacking: If True make an RPC call to determine the
1748
stacked (or not) status of the branch. If False assume the branch
1751
# We intentionally don't call the parent class's __init__, because it
1752
# will try to assign to self.tags, which is a property in this subclass.
1753
# And the parent's __init__ doesn't do much anyway.
1754
self._revision_id_to_revno_cache = None
1755
self._partial_revision_id_to_revno_cache = {}
1756
self._revision_history_cache = None
1757
self._last_revision_info_cache = None
1758
self._merge_sorted_revisions_cache = None
1759
self.bzrdir = remote_bzrdir
1760
if _client is not None:
1761
self._client = _client
1763
self._client = remote_bzrdir._client
1764
self.repository = remote_repository
1765
if real_branch is not None:
1766
self._real_branch = real_branch
1767
# Give the remote repository the matching real repo.
1768
real_repo = self._real_branch.repository
1769
if isinstance(real_repo, RemoteRepository):
1770
real_repo._ensure_real()
1771
real_repo = real_repo._real_repository
1772
self.repository._set_real_repository(real_repo)
1773
# Give the branch the remote repository to let fast-pathing happen.
1774
self._real_branch.repository = self.repository
1776
self._real_branch = None
1777
# Fill out expected attributes of branch for bzrlib api users.
1778
self.base = self.bzrdir.root_transport.base
1779
self._control_files = None
1780
self._lock_mode = None
1781
self._lock_token = None
1782
self._repo_lock_token = None
1783
self._lock_count = 0
1784
self._leave_lock = False
1785
# Setup a format: note that we cannot call _ensure_real until all the
1786
# attributes above are set: This code cannot be moved higher up in this
1789
self._format = RemoteBranchFormat()
1790
if real_branch is not None:
1791
self._format._network_name = \
1792
self._real_branch._format.network_name()
1794
self._format = format
1795
if not self._format._network_name:
1796
# Did not get from open_branchV2 - old server.
1798
self._format._network_name = \
1799
self._real_branch._format.network_name()
1800
self.tags = self._format.make_tags(self)
1801
# The base class init is not called, so we duplicate this:
1802
hooks = branch.Branch.hooks['open']
1806
self._setup_stacking()
1808
def _setup_stacking(self):
1809
# configure stacking into the remote repository, by reading it from
1812
fallback_url = self.get_stacked_on_url()
1813
except (errors.NotStacked, errors.UnstackableBranchFormat,
1814
errors.UnstackableRepositoryFormat), e:
1816
# it's relative to this branch...
1817
fallback_url = urlutils.join(self.base, fallback_url)
1818
transports = [self.bzrdir.root_transport]
1819
stacked_on = branch.Branch.open(fallback_url,
1820
possible_transports=transports)
1821
self.repository.add_fallback_repository(stacked_on.repository)
1823
def _get_real_transport(self):
1824
# if we try vfs access, return the real branch's vfs transport
1826
return self._real_branch._transport
1828
_transport = property(_get_real_transport)
1831
return "%s(%s)" % (self.__class__.__name__, self.base)
1835
def _ensure_real(self):
1836
"""Ensure that there is a _real_branch set.
1838
Used before calls to self._real_branch.
1840
if self._real_branch is None:
1841
if not vfs.vfs_enabled():
1842
raise AssertionError('smart server vfs must be enabled '
1843
'to use vfs implementation')
1844
self.bzrdir._ensure_real()
1845
self._real_branch = self.bzrdir._real_bzrdir.open_branch()
1846
if self.repository._real_repository is None:
1847
# Give the remote repository the matching real repo.
1848
real_repo = self._real_branch.repository
1849
if isinstance(real_repo, RemoteRepository):
1850
real_repo._ensure_real()
1851
real_repo = real_repo._real_repository
1852
self.repository._set_real_repository(real_repo)
1853
# Give the real branch the remote repository to let fast-pathing
1855
self._real_branch.repository = self.repository
1856
if self._lock_mode == 'r':
1857
self._real_branch.lock_read()
1858
elif self._lock_mode == 'w':
1859
self._real_branch.lock_write(token=self._lock_token)
1861
def _translate_error(self, err, **context):
1862
self.repository._translate_error(err, branch=self, **context)
1864
def _clear_cached_state(self):
1865
super(RemoteBranch, self)._clear_cached_state()
1866
if self._real_branch is not None:
1867
self._real_branch._clear_cached_state()
1869
def _clear_cached_state_of_remote_branch_only(self):
1870
"""Like _clear_cached_state, but doesn't clear the cache of
1873
This is useful when falling back to calling a method of
1874
self._real_branch that changes state. In that case the underlying
1875
branch changes, so we need to invalidate this RemoteBranch's cache of
1876
it. However, there's no need to invalidate the _real_branch's cache
1877
too, in fact doing so might harm performance.
1879
super(RemoteBranch, self)._clear_cached_state()
1882
def control_files(self):
1883
# Defer actually creating RemoteBranchLockableFiles until its needed,
1884
# because it triggers an _ensure_real that we otherwise might not need.
1885
if self._control_files is None:
1886
self._control_files = RemoteBranchLockableFiles(
1887
self.bzrdir, self._client)
1888
return self._control_files
1890
def _get_checkout_format(self):
1892
return self._real_branch._get_checkout_format()
1894
def get_physical_lock_status(self):
1895
"""See Branch.get_physical_lock_status()."""
1896
# should be an API call to the server, as branches must be lockable.
1898
return self._real_branch.get_physical_lock_status()
1900
def get_stacked_on_url(self):
1901
"""Get the URL this branch is stacked against.
1903
:raises NotStacked: If the branch is not stacked.
1904
:raises UnstackableBranchFormat: If the branch does not support
1906
:raises UnstackableRepositoryFormat: If the repository does not support
1910
# there may not be a repository yet, so we can't use
1911
# self._translate_error, so we can't use self._call either.
1912
response = self._client.call('Branch.get_stacked_on_url',
1913
self._remote_path())
1914
except errors.ErrorFromSmartServer, err:
1915
# there may not be a repository yet, so we can't call through
1916
# its _translate_error
1917
_translate_error(err, branch=self)
1918
except errors.UnknownSmartMethod, err:
1920
return self._real_branch.get_stacked_on_url()
1921
if response[0] != 'ok':
1922
raise errors.UnexpectedSmartServerResponse(response)
1925
def _vfs_get_tags_bytes(self):
1927
return self._real_branch._get_tags_bytes()
1929
def _get_tags_bytes(self):
1930
medium = self._client._medium
1931
if medium._is_remote_before((1, 13)):
1932
return self._vfs_get_tags_bytes()
1934
response = self._call('Branch.get_tags_bytes', self._remote_path())
1935
except errors.UnknownSmartMethod:
1936
medium._remember_remote_is_before((1, 13))
1937
return self._vfs_get_tags_bytes()
1940
def lock_read(self):
1941
self.repository.lock_read()
1942
if not self._lock_mode:
1943
self._lock_mode = 'r'
1944
self._lock_count = 1
1945
if self._real_branch is not None:
1946
self._real_branch.lock_read()
1948
self._lock_count += 1
1950
def _remote_lock_write(self, token):
1952
branch_token = repo_token = ''
1954
branch_token = token
1955
repo_token = self.repository.lock_write()
1956
self.repository.unlock()
1957
err_context = {'token': token}
1958
response = self._call(
1959
'Branch.lock_write', self._remote_path(), branch_token,
1960
repo_token or '', **err_context)
1961
if response[0] != 'ok':
1962
raise errors.UnexpectedSmartServerResponse(response)
1963
ok, branch_token, repo_token = response
1964
return branch_token, repo_token
1966
def lock_write(self, token=None):
1967
if not self._lock_mode:
1968
# Lock the branch and repo in one remote call.
1969
remote_tokens = self._remote_lock_write(token)
1970
self._lock_token, self._repo_lock_token = remote_tokens
1971
if not self._lock_token:
1972
raise SmartProtocolError('Remote server did not return a token!')
1973
# Tell the self.repository object that it is locked.
1974
self.repository.lock_write(
1975
self._repo_lock_token, _skip_rpc=True)
1977
if self._real_branch is not None:
1978
self._real_branch.lock_write(token=self._lock_token)
1979
if token is not None:
1980
self._leave_lock = True
1982
self._leave_lock = False
1983
self._lock_mode = 'w'
1984
self._lock_count = 1
1985
elif self._lock_mode == 'r':
1986
raise errors.ReadOnlyTransaction
1988
if token is not None:
1989
# A token was given to lock_write, and we're relocking, so
1990
# check that the given token actually matches the one we
1992
if token != self._lock_token:
1993
raise errors.TokenMismatch(token, self._lock_token)
1994
self._lock_count += 1
1995
# Re-lock the repository too.
1996
self.repository.lock_write(self._repo_lock_token)
1997
return self._lock_token or None
1999
def _set_tags_bytes(self, bytes):
2001
return self._real_branch._set_tags_bytes(bytes)
2003
def _unlock(self, branch_token, repo_token):
2004
err_context = {'token': str((branch_token, repo_token))}
2005
response = self._call(
2006
'Branch.unlock', self._remote_path(), branch_token,
2007
repo_token or '', **err_context)
2008
if response == ('ok',):
2010
raise errors.UnexpectedSmartServerResponse(response)
2014
self._lock_count -= 1
2015
if not self._lock_count:
2016
self._clear_cached_state()
2017
mode = self._lock_mode
2018
self._lock_mode = None
2019
if self._real_branch is not None:
2020
if (not self._leave_lock and mode == 'w' and
2021
self._repo_lock_token):
2022
# If this RemoteBranch will remove the physical lock
2023
# for the repository, make sure the _real_branch
2024
# doesn't do it first. (Because the _real_branch's
2025
# repository is set to be the RemoteRepository.)
2026
self._real_branch.repository.leave_lock_in_place()
2027
self._real_branch.unlock()
2029
# Only write-locked branched need to make a remote method
2030
# call to perfom the unlock.
2032
if not self._lock_token:
2033
raise AssertionError('Locked, but no token!')
2034
branch_token = self._lock_token
2035
repo_token = self._repo_lock_token
2036
self._lock_token = None
2037
self._repo_lock_token = None
2038
if not self._leave_lock:
2039
self._unlock(branch_token, repo_token)
2041
self.repository.unlock()
2043
def break_lock(self):
2045
return self._real_branch.break_lock()
2047
def leave_lock_in_place(self):
2048
if not self._lock_token:
2049
raise NotImplementedError(self.leave_lock_in_place)
2050
self._leave_lock = True
2052
def dont_leave_lock_in_place(self):
2053
if not self._lock_token:
2054
raise NotImplementedError(self.dont_leave_lock_in_place)
2055
self._leave_lock = False
2057
def _last_revision_info(self):
2058
response = self._call('Branch.last_revision_info', self._remote_path())
2059
if response[0] != 'ok':
2060
raise SmartProtocolError('unexpected response code %s' % (response,))
2061
revno = int(response[1])
2062
last_revision = response[2]
2063
return (revno, last_revision)
2065
def _gen_revision_history(self):
2066
"""See Branch._gen_revision_history()."""
2067
response_tuple, response_handler = self._call_expecting_body(
2068
'Branch.revision_history', self._remote_path())
2069
if response_tuple[0] != 'ok':
2070
raise errors.UnexpectedSmartServerResponse(response_tuple)
2071
result = response_handler.read_body_bytes().split('\x00')
2076
def _remote_path(self):
2077
return self.bzrdir._path_for_remote_call(self._client)
2079
def _set_last_revision_descendant(self, revision_id, other_branch,
2080
allow_diverged=False, allow_overwrite_descendant=False):
2081
# This performs additional work to meet the hook contract; while its
2082
# undesirable, we have to synthesise the revno to call the hook, and
2083
# not calling the hook is worse as it means changes can't be prevented.
2084
# Having calculated this though, we can't just call into
2085
# set_last_revision_info as a simple call, because there is a set_rh
2086
# hook that some folk may still be using.
2087
old_revno, old_revid = self.last_revision_info()
2088
history = self._lefthand_history(revision_id)
2089
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2090
err_context = {'other_branch': other_branch}
2091
response = self._call('Branch.set_last_revision_ex',
2092
self._remote_path(), self._lock_token, self._repo_lock_token,
2093
revision_id, int(allow_diverged), int(allow_overwrite_descendant),
2095
self._clear_cached_state()
2096
if len(response) != 3 and response[0] != 'ok':
2097
raise errors.UnexpectedSmartServerResponse(response)
2098
new_revno, new_revision_id = response[1:]
2099
self._last_revision_info_cache = new_revno, new_revision_id
2100
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2101
if self._real_branch is not None:
2102
cache = new_revno, new_revision_id
2103
self._real_branch._last_revision_info_cache = cache
2105
def _set_last_revision(self, revision_id):
2106
old_revno, old_revid = self.last_revision_info()
2107
# This performs additional work to meet the hook contract; while its
2108
# undesirable, we have to synthesise the revno to call the hook, and
2109
# not calling the hook is worse as it means changes can't be prevented.
2110
# Having calculated this though, we can't just call into
2111
# set_last_revision_info as a simple call, because there is a set_rh
2112
# hook that some folk may still be using.
2113
history = self._lefthand_history(revision_id)
2114
self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2115
self._clear_cached_state()
2116
response = self._call('Branch.set_last_revision',
2117
self._remote_path(), self._lock_token, self._repo_lock_token,
2119
if response != ('ok',):
2120
raise errors.UnexpectedSmartServerResponse(response)
2121
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2124
def set_revision_history(self, rev_history):
2125
# Send just the tip revision of the history; the server will generate
2126
# the full history from that. If the revision doesn't exist in this
2127
# branch, NoSuchRevision will be raised.
2128
if rev_history == []:
2131
rev_id = rev_history[-1]
2132
self._set_last_revision(rev_id)
2133
for hook in branch.Branch.hooks['set_rh']:
2134
hook(self, rev_history)
2135
self._cache_revision_history(rev_history)
2137
def _get_parent_location(self):
2138
medium = self._client._medium
2139
if medium._is_remote_before((1, 13)):
2140
return self._vfs_get_parent_location()
2142
response = self._call('Branch.get_parent', self._remote_path())
2143
except errors.UnknownSmartMethod:
2144
medium._remember_remote_is_before((1, 13))
2145
return self._vfs_get_parent_location()
2146
if len(response) != 1:
2147
raise errors.UnexpectedSmartServerResponse(response)
2148
parent_location = response[0]
2149
if parent_location == '':
2151
return parent_location
2153
def _vfs_get_parent_location(self):
2155
return self._real_branch._get_parent_location()
2157
def set_parent(self, url):
2159
return self._real_branch.set_parent(url)
2161
def _set_parent_location(self, url):
2162
# Used by tests, to poke bad urls into branch configurations
2164
self.set_parent(url)
2167
return self._real_branch._set_parent_location(url)
2169
def set_stacked_on_url(self, stacked_location):
2170
"""Set the URL this branch is stacked against.
2172
:raises UnstackableBranchFormat: If the branch does not support
2174
:raises UnstackableRepositoryFormat: If the repository does not support
2178
return self._real_branch.set_stacked_on_url(stacked_location)
2181
def pull(self, source, overwrite=False, stop_revision=None,
2183
self._clear_cached_state_of_remote_branch_only()
2185
return self._real_branch.pull(
2186
source, overwrite=overwrite, stop_revision=stop_revision,
2187
_override_hook_target=self, **kwargs)
2190
def push(self, target, overwrite=False, stop_revision=None):
2192
return self._real_branch.push(
2193
target, overwrite=overwrite, stop_revision=stop_revision,
2194
_override_hook_source_branch=self)
2196
def is_locked(self):
2197
return self._lock_count >= 1
2200
def revision_id_to_revno(self, revision_id):
2202
return self._real_branch.revision_id_to_revno(revision_id)
2205
def set_last_revision_info(self, revno, revision_id):
2206
# XXX: These should be returned by the set_last_revision_info verb
2207
old_revno, old_revid = self.last_revision_info()
2208
self._run_pre_change_branch_tip_hooks(revno, revision_id)
2209
revision_id = ensure_null(revision_id)
2211
response = self._call('Branch.set_last_revision_info',
2212
self._remote_path(), self._lock_token, self._repo_lock_token,
2213
str(revno), revision_id)
2214
except errors.UnknownSmartMethod:
2216
self._clear_cached_state_of_remote_branch_only()
2217
self._real_branch.set_last_revision_info(revno, revision_id)
2218
self._last_revision_info_cache = revno, revision_id
2220
if response == ('ok',):
2221
self._clear_cached_state()
2222
self._last_revision_info_cache = revno, revision_id
2223
self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2224
# Update the _real_branch's cache too.
2225
if self._real_branch is not None:
2226
cache = self._last_revision_info_cache
2227
self._real_branch._last_revision_info_cache = cache
2229
raise errors.UnexpectedSmartServerResponse(response)
2232
def generate_revision_history(self, revision_id, last_rev=None,
2234
medium = self._client._medium
2235
if not medium._is_remote_before((1, 6)):
2236
# Use a smart method for 1.6 and above servers
2238
self._set_last_revision_descendant(revision_id, other_branch,
2239
allow_diverged=True, allow_overwrite_descendant=True)
2241
except errors.UnknownSmartMethod:
2242
medium._remember_remote_is_before((1, 6))
2243
self._clear_cached_state_of_remote_branch_only()
2244
self.set_revision_history(self._lefthand_history(revision_id,
2245
last_rev=last_rev,other_branch=other_branch))
2247
def set_push_location(self, location):
2249
return self._real_branch.set_push_location(location)
2252
def _extract_tar(tar, to_dir):
2253
"""Extract all the contents of a tarfile object.
2255
A replacement for extractall, which is not present in python2.4
2258
tar.extract(tarinfo, to_dir)
2261
def _translate_error(err, **context):
2262
"""Translate an ErrorFromSmartServer into a more useful error.
2264
Possible context keys:
2272
If the error from the server doesn't match a known pattern, then
2273
UnknownErrorFromSmartServer is raised.
2277
return context[name]
2278
except KeyError, key_err:
2279
mutter('Missing key %r in context %r', key_err.args[0], context)
2282
"""Get the path from the context if present, otherwise use first error
2286
return context['path']
2287
except KeyError, key_err:
2289
return err.error_args[0]
2290
except IndexError, idx_err:
2292
'Missing key %r in context %r', key_err.args[0], context)
2295
if err.error_verb == 'NoSuchRevision':
2296
raise NoSuchRevision(find('branch'), err.error_args[0])
2297
elif err.error_verb == 'nosuchrevision':
2298
raise NoSuchRevision(find('repository'), err.error_args[0])
2299
elif err.error_tuple == ('nobranch',):
2300
raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2301
elif err.error_verb == 'norepository':
2302
raise errors.NoRepositoryPresent(find('bzrdir'))
2303
elif err.error_verb == 'LockContention':
2304
raise errors.LockContention('(remote lock)')
2305
elif err.error_verb == 'UnlockableTransport':
2306
raise errors.UnlockableTransport(find('bzrdir').root_transport)
2307
elif err.error_verb == 'LockFailed':
2308
raise errors.LockFailed(err.error_args[0], err.error_args[1])
2309
elif err.error_verb == 'TokenMismatch':
2310
raise errors.TokenMismatch(find('token'), '(remote token)')
2311
elif err.error_verb == 'Diverged':
2312
raise errors.DivergedBranches(find('branch'), find('other_branch'))
2313
elif err.error_verb == 'TipChangeRejected':
2314
raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
2315
elif err.error_verb == 'UnstackableBranchFormat':
2316
raise errors.UnstackableBranchFormat(*err.error_args)
2317
elif err.error_verb == 'UnstackableRepositoryFormat':
2318
raise errors.UnstackableRepositoryFormat(*err.error_args)
2319
elif err.error_verb == 'NotStacked':
2320
raise errors.NotStacked(branch=find('branch'))
2321
elif err.error_verb == 'PermissionDenied':
2323
if len(err.error_args) >= 2:
2324
extra = err.error_args[1]
2327
raise errors.PermissionDenied(path, extra=extra)
2328
elif err.error_verb == 'ReadError':
2330
raise errors.ReadError(path)
2331
elif err.error_verb == 'NoSuchFile':
2333
raise errors.NoSuchFile(path)
2334
elif err.error_verb == 'FileExists':
2335
raise errors.FileExists(err.error_args[0])
2336
elif err.error_verb == 'DirectoryNotEmpty':
2337
raise errors.DirectoryNotEmpty(err.error_args[0])
2338
elif err.error_verb == 'ShortReadvError':
2339
args = err.error_args
2340
raise errors.ShortReadvError(
2341
args[0], int(args[1]), int(args[2]), int(args[3]))
2342
elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
2343
encoding = str(err.error_args[0]) # encoding must always be a string
2344
val = err.error_args[1]
2345
start = int(err.error_args[2])
2346
end = int(err.error_args[3])
2347
reason = str(err.error_args[4]) # reason must always be a string
2348
if val.startswith('u:'):
2349
val = val[2:].decode('utf-8')
2350
elif val.startswith('s:'):
2351
val = val[2:].decode('base64')
2352
if err.error_verb == 'UnicodeDecodeError':
2353
raise UnicodeDecodeError(encoding, val, start, end, reason)
2354
elif err.error_verb == 'UnicodeEncodeError':
2355
raise UnicodeEncodeError(encoding, val, start, end, reason)
2356
elif err.error_verb == 'ReadOnlyError':
2357
raise errors.TransportNotPossible('readonly transport')
2358
raise errors.UnknownErrorFromSmartServer(err)