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.
 
 
33
from bzrlib.branch import BranchReferenceFormat
 
 
34
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
 
 
35
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
 
36
from bzrlib.errors import (
 
 
40
from bzrlib.lockable_files import LockableFiles
 
 
41
from bzrlib.smart import client, vfs
 
 
42
from bzrlib.revision import ensure_null, NULL_REVISION
 
 
43
from bzrlib.trace import mutter, note, warning
 
 
46
class _RpcHelper(object):
 
 
47
    """Mixin class that helps with issuing RPCs."""
 
 
49
    def _call(self, method, *args, **err_context):
 
 
51
            return self._client.call(method, *args)
 
 
52
        except errors.ErrorFromSmartServer, err:
 
 
53
            self._translate_error(err, **err_context)
 
 
55
    def _call_expecting_body(self, method, *args, **err_context):
 
 
57
            return self._client.call_expecting_body(method, *args)
 
 
58
        except errors.ErrorFromSmartServer, err:
 
 
59
            self._translate_error(err, **err_context)
 
 
61
    def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
 
 
64
            return self._client.call_with_body_bytes_expecting_body(
 
 
65
                method, args, body_bytes)
 
 
66
        except errors.ErrorFromSmartServer, err:
 
 
67
            self._translate_error(err, **err_context)
 
 
69
# Note: RemoteBzrDirFormat is in bzrdir.py
 
 
71
class RemoteBzrDir(BzrDir, _RpcHelper):
 
 
72
    """Control directory on a remote server, accessed via bzr:// or similar."""
 
 
74
    def __init__(self, transport, _client=None):
 
 
75
        """Construct a RemoteBzrDir.
 
 
77
        :param _client: Private parameter for testing. Disables probing and the
 
 
80
        BzrDir.__init__(self, transport, RemoteBzrDirFormat())
 
 
81
        # this object holds a delegated bzrdir that uses file-level operations
 
 
82
        # to talk to the other side
 
 
83
        self._real_bzrdir = None
 
 
86
            medium = transport.get_smart_medium()
 
 
87
            self._client = client._SmartClient(medium)
 
 
89
            self._client = _client
 
 
92
        path = self._path_for_remote_call(self._client)
 
 
93
        response = self._call('BzrDir.open', path)
 
 
94
        if response not in [('yes',), ('no',)]:
 
 
95
            raise errors.UnexpectedSmartServerResponse(response)
 
 
96
        if response == ('no',):
 
 
97
            raise errors.NotBranchError(path=transport.base)
 
 
99
    def _ensure_real(self):
 
 
100
        """Ensure that there is a _real_bzrdir set.
 
 
102
        Used before calls to self._real_bzrdir.
 
 
104
        if not self._real_bzrdir:
 
 
105
            self._real_bzrdir = BzrDir.open_from_transport(
 
 
106
                self.root_transport, _server_formats=False)
 
 
108
    def _translate_error(self, err, **context):
 
 
109
        _translate_error(err, bzrdir=self, **context)
 
 
111
    def cloning_metadir(self, stacked=False):
 
 
113
        return self._real_bzrdir.cloning_metadir(stacked)
 
 
115
    def create_repository(self, shared=False):
 
 
117
        self._real_bzrdir.create_repository(shared=shared)
 
 
118
        return self.open_repository()
 
 
120
    def destroy_repository(self):
 
 
121
        """See BzrDir.destroy_repository"""
 
 
123
        self._real_bzrdir.destroy_repository()
 
 
125
    def create_branch(self):
 
 
127
        real_branch = self._real_bzrdir.create_branch()
 
 
128
        return RemoteBranch(self, self.find_repository(), real_branch)
 
 
130
    def destroy_branch(self):
 
 
131
        """See BzrDir.destroy_branch"""
 
 
133
        self._real_bzrdir.destroy_branch()
 
 
135
    def create_workingtree(self, revision_id=None, from_branch=None):
 
 
136
        raise errors.NotLocalUrl(self.transport.base)
 
 
138
    def find_branch_format(self):
 
 
139
        """Find the branch 'format' for this bzrdir.
 
 
141
        This might be a synthetic object for e.g. RemoteBranch and SVN.
 
 
143
        b = self.open_branch()
 
 
146
    def get_branch_reference(self):
 
 
147
        """See BzrDir.get_branch_reference()."""
 
 
148
        path = self._path_for_remote_call(self._client)
 
 
149
        response = self._call('BzrDir.open_branch', path)
 
 
150
        if response[0] == 'ok':
 
 
151
            if response[1] == '':
 
 
152
                # branch at this location.
 
 
155
                # a branch reference, use the existing BranchReference logic.
 
 
158
            raise errors.UnexpectedSmartServerResponse(response)
 
 
160
    def _get_tree_branch(self):
 
 
161
        """See BzrDir._get_tree_branch()."""
 
 
162
        return None, self.open_branch()
 
 
164
    def open_branch(self, _unsupported=False):
 
 
166
            raise NotImplementedError('unsupported flag support not implemented yet.')
 
 
167
        reference_url = self.get_branch_reference()
 
 
168
        if reference_url is None:
 
 
169
            # branch at this location.
 
 
170
            return RemoteBranch(self, self.find_repository())
 
 
172
            # a branch reference, use the existing BranchReference logic.
 
 
173
            format = BranchReferenceFormat()
 
 
174
            return format.open(self, _found=True, location=reference_url)
 
 
176
    def open_repository(self):
 
 
177
        path = self._path_for_remote_call(self._client)
 
 
178
        verb = 'BzrDir.find_repositoryV2'
 
 
180
            response = self._call(verb, path)
 
 
181
        except errors.UnknownSmartMethod:
 
 
182
            verb = 'BzrDir.find_repository'
 
 
183
            response = self._call(verb, path)
 
 
184
        if response[0] != 'ok':
 
 
185
            raise errors.UnexpectedSmartServerResponse(response)
 
 
186
        if verb == 'BzrDir.find_repository':
 
 
187
            # servers that don't support the V2 method don't support external
 
 
189
            response = response + ('no', )
 
 
190
        if not (len(response) == 5):
 
 
191
            raise SmartProtocolError('incorrect response length %s' % (response,))
 
 
192
        if response[1] == '':
 
 
193
            format = RemoteRepositoryFormat()
 
 
194
            format.rich_root_data = (response[2] == 'yes')
 
 
195
            format.supports_tree_reference = (response[3] == 'yes')
 
 
196
            # No wire format to check this yet.
 
 
197
            format.supports_external_lookups = (response[4] == 'yes')
 
 
198
            # Used to support creating a real format instance when needed.
 
 
199
            format._creating_bzrdir = self
 
 
200
            return RemoteRepository(self, format)
 
 
202
            raise errors.NoRepositoryPresent(self)
 
 
204
    def open_workingtree(self, recommend_upgrade=True):
 
 
206
        if self._real_bzrdir.has_workingtree():
 
 
207
            raise errors.NotLocalUrl(self.root_transport)
 
 
209
            raise errors.NoWorkingTree(self.root_transport.base)
 
 
211
    def _path_for_remote_call(self, client):
 
 
212
        """Return the path to be used for this bzrdir in a remote call."""
 
 
213
        return client.remote_path_from_transport(self.root_transport)
 
 
215
    def get_branch_transport(self, branch_format):
 
 
217
        return self._real_bzrdir.get_branch_transport(branch_format)
 
 
219
    def get_repository_transport(self, repository_format):
 
 
221
        return self._real_bzrdir.get_repository_transport(repository_format)
 
 
223
    def get_workingtree_transport(self, workingtree_format):
 
 
225
        return self._real_bzrdir.get_workingtree_transport(workingtree_format)
 
 
227
    def can_convert_format(self):
 
 
228
        """Upgrading of remote bzrdirs is not supported yet."""
 
 
231
    def needs_format_conversion(self, format=None):
 
 
232
        """Upgrading of remote bzrdirs is not supported yet."""
 
 
235
    def clone(self, url, revision_id=None, force_new_repo=False,
 
 
236
              preserve_stacking=False):
 
 
238
        return self._real_bzrdir.clone(url, revision_id=revision_id,
 
 
239
            force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
 
 
241
    def get_config(self):
 
 
243
        return self._real_bzrdir.get_config()
 
 
246
class RemoteRepositoryFormat(repository.RepositoryFormat):
 
 
247
    """Format for repositories accessed over a _SmartClient.
 
 
249
    Instances of this repository are represented by RemoteRepository
 
 
252
    The RemoteRepositoryFormat is parameterized during construction
 
 
253
    to reflect the capabilities of the real, remote format. Specifically
 
 
254
    the attributes rich_root_data and supports_tree_reference are set
 
 
255
    on a per instance basis, and are not set (and should not be) at
 
 
259
    _matchingbzrdir = RemoteBzrDirFormat()
 
 
261
    def initialize(self, a_bzrdir, shared=False):
 
 
262
        if not isinstance(a_bzrdir, RemoteBzrDir):
 
 
263
            prior_repo = self._creating_bzrdir.open_repository()
 
 
264
            prior_repo._ensure_real()
 
 
265
            return prior_repo._real_repository._format.initialize(
 
 
266
                a_bzrdir, shared=shared)
 
 
267
        return a_bzrdir.create_repository(shared=shared)
 
 
269
    def open(self, a_bzrdir):
 
 
270
        if not isinstance(a_bzrdir, RemoteBzrDir):
 
 
271
            raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
 
 
272
        return a_bzrdir.open_repository()
 
 
274
    def get_format_description(self):
 
 
275
        return 'bzr remote repository'
 
 
277
    def __eq__(self, other):
 
 
278
        return self.__class__ == other.__class__
 
 
280
    def check_conversion_target(self, target_format):
 
 
281
        if self.rich_root_data and not target_format.rich_root_data:
 
 
282
            raise errors.BadConversionTarget(
 
 
283
                'Does not support rich root data.', target_format)
 
 
284
        if (self.supports_tree_reference and
 
 
285
            not getattr(target_format, 'supports_tree_reference', False)):
 
 
286
            raise errors.BadConversionTarget(
 
 
287
                'Does not support nested trees', target_format)
 
 
290
class _UnstackedParentsProvider(object):
 
 
291
    """ParentsProvider for RemoteRepository that ignores stacking."""
 
 
293
    def __init__(self, remote_repository):
 
 
294
        self._remote_repository = remote_repository
 
 
296
    def get_parent_map(self, revision_ids):
 
 
297
        """See RemoteRepository.get_parent_map."""
 
 
298
        return self._remote_repository._get_parent_map(revision_ids)
 
 
301
class RemoteRepository(_RpcHelper):
 
 
302
    """Repository accessed over rpc.
 
 
304
    For the moment most operations are performed using local transport-backed
 
 
308
    def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
 
 
309
        """Create a RemoteRepository instance.
 
 
311
        :param remote_bzrdir: The bzrdir hosting this repository.
 
 
312
        :param format: The RemoteFormat object to use.
 
 
313
        :param real_repository: If not None, a local implementation of the
 
 
314
            repository logic for the repository, usually accessing the data
 
 
316
        :param _client: Private testing parameter - override the smart client
 
 
317
            to be used by the repository.
 
 
320
            self._real_repository = real_repository
 
 
322
            self._real_repository = None
 
 
323
        self.bzrdir = remote_bzrdir
 
 
325
            self._client = remote_bzrdir._client
 
 
327
            self._client = _client
 
 
328
        self._format = format
 
 
329
        self._lock_mode = None
 
 
330
        self._lock_token = None
 
 
332
        self._leave_lock = False
 
 
333
        # A cache of looked up revision parent data; reset at unlock time.
 
 
334
        self._parents_map = None
 
 
335
        if 'hpss' in debug.debug_flags:
 
 
336
            self._requested_parents = None
 
 
338
        # These depend on the actual remote format, so force them off for
 
 
339
        # maximum compatibility. XXX: In future these should depend on the
 
 
340
        # remote repository instance, but this is irrelevant until we perform
 
 
341
        # reconcile via an RPC call.
 
 
342
        self._reconcile_does_inventory_gc = False
 
 
343
        self._reconcile_fixes_text_parents = False
 
 
344
        self._reconcile_backsup_inventory = False
 
 
345
        self.base = self.bzrdir.transport.base
 
 
346
        # Additional places to query for data.
 
 
347
        self._fallback_repositories = []
 
 
350
        return "%s(%s)" % (self.__class__.__name__, self.base)
 
 
354
    def abort_write_group(self, suppress_errors=False):
 
 
355
        """Complete a write group on the decorated repository.
 
 
357
        Smart methods peform operations in a single step so this api
 
 
358
        is not really applicable except as a compatibility thunk
 
 
359
        for older plugins that don't use e.g. the CommitBuilder
 
 
362
        :param suppress_errors: see Repository.abort_write_group.
 
 
365
        return self._real_repository.abort_write_group(
 
 
366
            suppress_errors=suppress_errors)
 
 
368
    def commit_write_group(self):
 
 
369
        """Complete a write group on the decorated repository.
 
 
371
        Smart methods peform operations in a single step so this api
 
 
372
        is not really applicable except as a compatibility thunk
 
 
373
        for older plugins that don't use e.g. the CommitBuilder
 
 
377
        return self._real_repository.commit_write_group()
 
 
379
    def _ensure_real(self):
 
 
380
        """Ensure that there is a _real_repository set.
 
 
382
        Used before calls to self._real_repository.
 
 
384
        if self._real_repository is None:
 
 
385
            self.bzrdir._ensure_real()
 
 
386
            self._set_real_repository(
 
 
387
                self.bzrdir._real_bzrdir.open_repository())
 
 
389
    def _translate_error(self, err, **context):
 
 
390
        self.bzrdir._translate_error(err, repository=self, **context)
 
 
392
    def find_text_key_references(self):
 
 
393
        """Find the text key references within the repository.
 
 
395
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
 
 
396
        revision_ids. Each altered file-ids has the exact revision_ids that
 
 
397
        altered it listed explicitly.
 
 
398
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
 
 
399
            to whether they were referred to by the inventory of the
 
 
400
            revision_id that they contain. The inventory texts from all present
 
 
401
            revision ids are assessed to generate this report.
 
 
404
        return self._real_repository.find_text_key_references()
 
 
406
    def _generate_text_key_index(self):
 
 
407
        """Generate a new text key index for the repository.
 
 
409
        This is an expensive function that will take considerable time to run.
 
 
411
        :return: A dict mapping (file_id, revision_id) tuples to a list of
 
 
412
            parents, also (file_id, revision_id) tuples.
 
 
415
        return self._real_repository._generate_text_key_index()
 
 
417
    @symbol_versioning.deprecated_method(symbol_versioning.one_four)
 
 
418
    def get_revision_graph(self, revision_id=None):
 
 
419
        """See Repository.get_revision_graph()."""
 
 
420
        return self._get_revision_graph(revision_id)
 
 
422
    def _get_revision_graph(self, revision_id):
 
 
423
        """Private method for using with old (< 1.2) servers to fallback."""
 
 
424
        if revision_id is None:
 
 
426
        elif revision.is_null(revision_id):
 
 
429
        path = self.bzrdir._path_for_remote_call(self._client)
 
 
430
        response = self._call_expecting_body(
 
 
431
            'Repository.get_revision_graph', path, revision_id)
 
 
432
        response_tuple, response_handler = response
 
 
433
        if response_tuple[0] != 'ok':
 
 
434
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
 
435
        coded = response_handler.read_body_bytes()
 
 
437
            # no revisions in this repository!
 
 
439
        lines = coded.split('\n')
 
 
442
            d = tuple(line.split())
 
 
443
            revision_graph[d[0]] = d[1:]
 
 
445
        return revision_graph
 
 
447
    def has_revision(self, revision_id):
 
 
448
        """See Repository.has_revision()."""
 
 
449
        if revision_id == NULL_REVISION:
 
 
450
            # The null revision is always present.
 
 
452
        path = self.bzrdir._path_for_remote_call(self._client)
 
 
453
        response = self._call('Repository.has_revision', path, revision_id)
 
 
454
        if response[0] not in ('yes', 'no'):
 
 
455
            raise errors.UnexpectedSmartServerResponse(response)
 
 
456
        if response[0] == 'yes':
 
 
458
        for fallback_repo in self._fallback_repositories:
 
 
459
            if fallback_repo.has_revision(revision_id):
 
 
463
    def has_revisions(self, revision_ids):
 
 
464
        """See Repository.has_revisions()."""
 
 
465
        # FIXME: This does many roundtrips, particularly when there are
 
 
466
        # fallback repositories.  -- mbp 20080905
 
 
468
        for revision_id in revision_ids:
 
 
469
            if self.has_revision(revision_id):
 
 
470
                result.add(revision_id)
 
 
473
    def has_same_location(self, other):
 
 
474
        return (self.__class__ == other.__class__ and
 
 
475
                self.bzrdir.transport.base == other.bzrdir.transport.base)
 
 
477
    def get_graph(self, other_repository=None):
 
 
478
        """Return the graph for this repository format"""
 
 
479
        parents_provider = self._make_parents_provider()
 
 
480
        if (other_repository is not None and
 
 
481
            other_repository.bzrdir.transport.base !=
 
 
482
            self.bzrdir.transport.base):
 
 
483
            parents_provider = graph._StackedParentsProvider(
 
 
484
                [parents_provider, other_repository._make_parents_provider()])
 
 
485
        return graph.Graph(parents_provider)
 
 
487
    def gather_stats(self, revid=None, committers=None):
 
 
488
        """See Repository.gather_stats()."""
 
 
489
        path = self.bzrdir._path_for_remote_call(self._client)
 
 
490
        # revid can be None to indicate no revisions, not just NULL_REVISION
 
 
491
        if revid is None or revision.is_null(revid):
 
 
495
        if committers is None or not committers:
 
 
496
            fmt_committers = 'no'
 
 
498
            fmt_committers = 'yes'
 
 
499
        response_tuple, response_handler = self._call_expecting_body(
 
 
500
            'Repository.gather_stats', path, fmt_revid, fmt_committers)
 
 
501
        if response_tuple[0] != 'ok':
 
 
502
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
 
504
        body = response_handler.read_body_bytes()
 
 
506
        for line in body.split('\n'):
 
 
509
            key, val_text = line.split(':')
 
 
510
            if key in ('revisions', 'size', 'committers'):
 
 
511
                result[key] = int(val_text)
 
 
512
            elif key in ('firstrev', 'latestrev'):
 
 
513
                values = val_text.split(' ')[1:]
 
 
514
                result[key] = (float(values[0]), long(values[1]))
 
 
518
    def find_branches(self, using=False):
 
 
519
        """See Repository.find_branches()."""
 
 
520
        # should be an API call to the server.
 
 
522
        return self._real_repository.find_branches(using=using)
 
 
524
    def get_physical_lock_status(self):
 
 
525
        """See Repository.get_physical_lock_status()."""
 
 
526
        # should be an API call to the server.
 
 
528
        return self._real_repository.get_physical_lock_status()
 
 
530
    def is_in_write_group(self):
 
 
531
        """Return True if there is an open write group.
 
 
533
        write groups are only applicable locally for the smart server..
 
 
535
        if self._real_repository:
 
 
536
            return self._real_repository.is_in_write_group()
 
 
539
        return self._lock_count >= 1
 
 
542
        """See Repository.is_shared()."""
 
 
543
        path = self.bzrdir._path_for_remote_call(self._client)
 
 
544
        response = self._call('Repository.is_shared', path)
 
 
545
        if response[0] not in ('yes', 'no'):
 
 
546
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
 
547
        return response[0] == 'yes'
 
 
549
    def is_write_locked(self):
 
 
550
        return self._lock_mode == 'w'
 
 
553
        # wrong eventually - want a local lock cache context
 
 
554
        if not self._lock_mode:
 
 
555
            self._lock_mode = 'r'
 
 
557
            self._parents_map = {}
 
 
558
            if 'hpss' in debug.debug_flags:
 
 
559
                self._requested_parents = set()
 
 
560
            if self._real_repository is not None:
 
 
561
                self._real_repository.lock_read()
 
 
563
            self._lock_count += 1
 
 
565
    def _remote_lock_write(self, token):
 
 
566
        path = self.bzrdir._path_for_remote_call(self._client)
 
 
569
        err_context = {'token': token}
 
 
570
        response = self._call('Repository.lock_write', path, token,
 
 
572
        if response[0] == 'ok':
 
 
576
            raise errors.UnexpectedSmartServerResponse(response)
 
 
578
    def lock_write(self, token=None, _skip_rpc=False):
 
 
579
        if not self._lock_mode:
 
 
581
                if self._lock_token is not None:
 
 
582
                    if token != self._lock_token:
 
 
583
                        raise errors.TokenMismatch(token, self._lock_token)
 
 
584
                self._lock_token = token
 
 
586
                self._lock_token = self._remote_lock_write(token)
 
 
587
            # if self._lock_token is None, then this is something like packs or
 
 
588
            # svn where we don't get to lock the repo, or a weave style repository
 
 
589
            # where we cannot lock it over the wire and attempts to do so will
 
 
591
            if self._real_repository is not None:
 
 
592
                self._real_repository.lock_write(token=self._lock_token)
 
 
593
            if token is not None:
 
 
594
                self._leave_lock = True
 
 
596
                self._leave_lock = False
 
 
597
            self._lock_mode = 'w'
 
 
599
            self._parents_map = {}
 
 
600
            if 'hpss' in debug.debug_flags:
 
 
601
                self._requested_parents = set()
 
 
602
        elif self._lock_mode == 'r':
 
 
603
            raise errors.ReadOnlyError(self)
 
 
605
            self._lock_count += 1
 
 
606
        return self._lock_token or None
 
 
608
    def leave_lock_in_place(self):
 
 
609
        if not self._lock_token:
 
 
610
            raise NotImplementedError(self.leave_lock_in_place)
 
 
611
        self._leave_lock = True
 
 
613
    def dont_leave_lock_in_place(self):
 
 
614
        if not self._lock_token:
 
 
615
            raise NotImplementedError(self.dont_leave_lock_in_place)
 
 
616
        self._leave_lock = False
 
 
618
    def _set_real_repository(self, repository):
 
 
619
        """Set the _real_repository for this repository.
 
 
621
        :param repository: The repository to fallback to for non-hpss
 
 
622
            implemented operations.
 
 
624
        if self._real_repository is not None:
 
 
625
            raise AssertionError('_real_repository is already set')
 
 
626
        if isinstance(repository, RemoteRepository):
 
 
627
            raise AssertionError()
 
 
628
        self._real_repository = repository
 
 
629
        for fb in self._fallback_repositories:
 
 
630
            self._real_repository.add_fallback_repository(fb)
 
 
631
        if self._lock_mode == 'w':
 
 
632
            # if we are already locked, the real repository must be able to
 
 
633
            # acquire the lock with our token.
 
 
634
            self._real_repository.lock_write(self._lock_token)
 
 
635
        elif self._lock_mode == 'r':
 
 
636
            self._real_repository.lock_read()
 
 
638
    def start_write_group(self):
 
 
639
        """Start a write group on the decorated repository.
 
 
641
        Smart methods peform operations in a single step so this api
 
 
642
        is not really applicable except as a compatibility thunk
 
 
643
        for older plugins that don't use e.g. the CommitBuilder
 
 
647
        return self._real_repository.start_write_group()
 
 
649
    def _unlock(self, token):
 
 
650
        path = self.bzrdir._path_for_remote_call(self._client)
 
 
652
            # with no token the remote repository is not persistently locked.
 
 
654
        err_context = {'token': token}
 
 
655
        response = self._call('Repository.unlock', path, token,
 
 
657
        if response == ('ok',):
 
 
660
            raise errors.UnexpectedSmartServerResponse(response)
 
 
663
        self._lock_count -= 1
 
 
664
        if self._lock_count > 0:
 
 
666
        self._parents_map = None
 
 
667
        if 'hpss' in debug.debug_flags:
 
 
668
            self._requested_parents = None
 
 
669
        old_mode = self._lock_mode
 
 
670
        self._lock_mode = None
 
 
672
            # The real repository is responsible at present for raising an
 
 
673
            # exception if it's in an unfinished write group.  However, it
 
 
674
            # normally will *not* actually remove the lock from disk - that's
 
 
675
            # done by the server on receiving the Repository.unlock call.
 
 
676
            # This is just to let the _real_repository stay up to date.
 
 
677
            if self._real_repository is not None:
 
 
678
                self._real_repository.unlock()
 
 
680
            # The rpc-level lock should be released even if there was a
 
 
681
            # problem releasing the vfs-based lock.
 
 
683
                # Only write-locked repositories need to make a remote method
 
 
684
                # call to perfom the unlock.
 
 
685
                old_token = self._lock_token
 
 
686
                self._lock_token = None
 
 
687
                if not self._leave_lock:
 
 
688
                    self._unlock(old_token)
 
 
690
    def break_lock(self):
 
 
691
        # should hand off to the network
 
 
693
        return self._real_repository.break_lock()
 
 
695
    def _get_tarball(self, compression):
 
 
696
        """Return a TemporaryFile containing a repository tarball.
 
 
698
        Returns None if the server does not support sending tarballs.
 
 
701
        path = self.bzrdir._path_for_remote_call(self._client)
 
 
703
            response, protocol = self._call_expecting_body(
 
 
704
                'Repository.tarball', path, compression)
 
 
705
        except errors.UnknownSmartMethod:
 
 
706
            protocol.cancel_read_body()
 
 
708
        if response[0] == 'ok':
 
 
709
            # Extract the tarball and return it
 
 
710
            t = tempfile.NamedTemporaryFile()
 
 
711
            # TODO: rpc layer should read directly into it...
 
 
712
            t.write(protocol.read_body_bytes())
 
 
715
        raise errors.UnexpectedSmartServerResponse(response)
 
 
717
    def sprout(self, to_bzrdir, revision_id=None):
 
 
718
        # TODO: Option to control what format is created?
 
 
720
        dest_repo = self._real_repository._format.initialize(to_bzrdir,
 
 
722
        dest_repo.fetch(self, revision_id=revision_id)
 
 
725
    ### These methods are just thin shims to the VFS object for now.
 
 
727
    def revision_tree(self, revision_id):
 
 
729
        return self._real_repository.revision_tree(revision_id)
 
 
731
    def get_serializer_format(self):
 
 
733
        return self._real_repository.get_serializer_format()
 
 
735
    def get_commit_builder(self, branch, parents, config, timestamp=None,
 
 
736
                           timezone=None, committer=None, revprops=None,
 
 
738
        # FIXME: It ought to be possible to call this without immediately
 
 
739
        # triggering _ensure_real.  For now it's the easiest thing to do.
 
 
741
        real_repo = self._real_repository
 
 
742
        builder = real_repo.get_commit_builder(branch, parents,
 
 
743
                config, timestamp=timestamp, timezone=timezone,
 
 
744
                committer=committer, revprops=revprops, revision_id=revision_id)
 
 
747
    def add_fallback_repository(self, repository):
 
 
748
        """Add a repository to use for looking up data not held locally.
 
 
750
        :param repository: A repository.
 
 
752
        # XXX: At the moment the RemoteRepository will allow fallbacks
 
 
753
        # unconditionally - however, a _real_repository will usually exist,
 
 
754
        # and may raise an error if it's not accommodated by the underlying
 
 
755
        # format.  Eventually we should check when opening the repository
 
 
756
        # whether it's willing to allow them or not.
 
 
758
        # We need to accumulate additional repositories here, to pass them in
 
 
760
        self._fallback_repositories.append(repository)
 
 
761
        # They are also seen by the fallback repository.  If it doesn't exist
 
 
762
        # yet they'll be added then.  This implicitly copies them.
 
 
765
    def add_inventory(self, revid, inv, parents):
 
 
767
        return self._real_repository.add_inventory(revid, inv, parents)
 
 
769
    def add_revision(self, rev_id, rev, inv=None, config=None):
 
 
771
        return self._real_repository.add_revision(
 
 
772
            rev_id, rev, inv=inv, config=config)
 
 
775
    def get_inventory(self, revision_id):
 
 
777
        return self._real_repository.get_inventory(revision_id)
 
 
779
    def iter_inventories(self, revision_ids):
 
 
781
        return self._real_repository.iter_inventories(revision_ids)
 
 
784
    def get_revision(self, revision_id):
 
 
786
        return self._real_repository.get_revision(revision_id)
 
 
788
    def get_transaction(self):
 
 
790
        return self._real_repository.get_transaction()
 
 
793
    def clone(self, a_bzrdir, revision_id=None):
 
 
795
        return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
 
 
797
    def make_working_trees(self):
 
 
798
        """See Repository.make_working_trees"""
 
 
800
        return self._real_repository.make_working_trees()
 
 
802
    def revision_ids_to_search_result(self, result_set):
 
 
803
        """Convert a set of revision ids to a graph SearchResult."""
 
 
804
        result_parents = set()
 
 
805
        for parents in self.get_graph().get_parent_map(
 
 
806
            result_set).itervalues():
 
 
807
            result_parents.update(parents)
 
 
808
        included_keys = result_set.intersection(result_parents)
 
 
809
        start_keys = result_set.difference(included_keys)
 
 
810
        exclude_keys = result_parents.difference(result_set)
 
 
811
        result = graph.SearchResult(start_keys, exclude_keys,
 
 
812
            len(result_set), result_set)
 
 
816
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
 
817
        """Return the revision ids that other has that this does not.
 
 
819
        These are returned in topological order.
 
 
821
        revision_id: only return revision ids included by revision_id.
 
 
823
        return repository.InterRepository.get(
 
 
824
            other, self).search_missing_revision_ids(revision_id, find_ghosts)
 
 
826
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False):
 
 
827
        # Not delegated to _real_repository so that InterRepository.get has a
 
 
828
        # chance to find an InterRepository specialised for RemoteRepository.
 
 
829
        if self.has_same_location(source):
 
 
830
            # check that last_revision is in 'from' and then return a
 
 
832
            if (revision_id is not None and
 
 
833
                not revision.is_null(revision_id)):
 
 
834
                self.get_revision(revision_id)
 
 
836
        inter = repository.InterRepository.get(source, self)
 
 
838
            return inter.fetch(revision_id=revision_id, pb=pb, find_ghosts=find_ghosts)
 
 
839
        except NotImplementedError:
 
 
840
            raise errors.IncompatibleRepositories(source, self)
 
 
842
    def create_bundle(self, target, base, fileobj, format=None):
 
 
844
        self._real_repository.create_bundle(target, base, fileobj, format)
 
 
847
    def get_ancestry(self, revision_id, topo_sorted=True):
 
 
849
        return self._real_repository.get_ancestry(revision_id, topo_sorted)
 
 
851
    def fileids_altered_by_revision_ids(self, revision_ids):
 
 
853
        return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
 
 
855
    def _get_versioned_file_checker(self, revisions, revision_versions_cache):
 
 
857
        return self._real_repository._get_versioned_file_checker(
 
 
858
            revisions, revision_versions_cache)
 
 
860
    def iter_files_bytes(self, desired_files):
 
 
861
        """See Repository.iter_file_bytes.
 
 
864
        return self._real_repository.iter_files_bytes(desired_files)
 
 
867
    def _fetch_order(self):
 
 
868
        """Decorate the real repository for now.
 
 
870
        In the long term getting this back from the remote repository as part
 
 
871
        of open would be more efficient.
 
 
874
        return self._real_repository._fetch_order
 
 
877
    def _fetch_uses_deltas(self):
 
 
878
        """Decorate the real repository for now.
 
 
880
        In the long term getting this back from the remote repository as part
 
 
881
        of open would be more efficient.
 
 
884
        return self._real_repository._fetch_uses_deltas
 
 
887
    def _fetch_reconcile(self):
 
 
888
        """Decorate the real repository for now.
 
 
890
        In the long term getting this back from the remote repository as part
 
 
891
        of open would be more efficient.
 
 
894
        return self._real_repository._fetch_reconcile
 
 
896
    def get_parent_map(self, revision_ids):
 
 
897
        """See bzrlib.Graph.get_parent_map()."""
 
 
898
        return self._make_parents_provider().get_parent_map(revision_ids)
 
 
900
    def _get_parent_map(self, keys):
 
 
901
        """Implementation of get_parent_map() that ignores fallbacks."""
 
 
902
        # Hack to build up the caching logic.
 
 
903
        ancestry = self._parents_map
 
 
905
            # Repository is not locked, so there's no cache.
 
 
906
            missing_revisions = set(keys)
 
 
909
            missing_revisions = set(key for key in keys if key not in ancestry)
 
 
910
        if missing_revisions:
 
 
911
            parent_map = self._get_parent_map_rpc(missing_revisions)
 
 
912
            if 'hpss' in debug.debug_flags:
 
 
913
                mutter('retransmitted revisions: %d of %d',
 
 
914
                        len(set(ancestry).intersection(parent_map)),
 
 
916
            ancestry.update(parent_map)
 
 
917
        present_keys = [k for k in keys if k in ancestry]
 
 
918
        if 'hpss' in debug.debug_flags:
 
 
919
            if self._requested_parents is not None and len(ancestry) != 0:
 
 
920
                self._requested_parents.update(present_keys)
 
 
921
                mutter('Current RemoteRepository graph hit rate: %d%%',
 
 
922
                    100.0 * len(self._requested_parents) / len(ancestry))
 
 
923
        return dict((k, ancestry[k]) for k in present_keys)
 
 
925
    def _get_parent_map_rpc(self, keys):
 
 
926
        """Helper for get_parent_map that performs the RPC."""
 
 
927
        medium = self._client._medium
 
 
928
        if medium._is_remote_before((1, 2)):
 
 
929
            # We already found out that the server can't understand
 
 
930
            # Repository.get_parent_map requests, so just fetch the whole
 
 
932
            # XXX: Note that this will issue a deprecation warning. This is ok
 
 
933
            # :- its because we're working with a deprecated server anyway, and
 
 
934
            # the user will almost certainly have seen a warning about the
 
 
935
            # server version already.
 
 
936
            rg = self.get_revision_graph()
 
 
937
            # There is an api discrepency between get_parent_map and
 
 
938
            # get_revision_graph. Specifically, a "key:()" pair in
 
 
939
            # get_revision_graph just means a node has no parents. For
 
 
940
            # "get_parent_map" it means the node is a ghost. So fix up the
 
 
941
            # graph to correct this.
 
 
942
            #   https://bugs.launchpad.net/bzr/+bug/214894
 
 
943
            # There is one other "bug" which is that ghosts in
 
 
944
            # get_revision_graph() are not returned at all. But we won't worry
 
 
945
            # about that for now.
 
 
946
            for node_id, parent_ids in rg.iteritems():
 
 
948
                    rg[node_id] = (NULL_REVISION,)
 
 
949
            rg[NULL_REVISION] = ()
 
 
954
            raise ValueError('get_parent_map(None) is not valid')
 
 
955
        if NULL_REVISION in keys:
 
 
956
            keys.discard(NULL_REVISION)
 
 
957
            found_parents = {NULL_REVISION:()}
 
 
962
        # TODO(Needs analysis): We could assume that the keys being requested
 
 
963
        # from get_parent_map are in a breadth first search, so typically they
 
 
964
        # will all be depth N from some common parent, and we don't have to
 
 
965
        # have the server iterate from the root parent, but rather from the
 
 
966
        # keys we're searching; and just tell the server the keyspace we
 
 
967
        # already have; but this may be more traffic again.
 
 
969
        # Transform self._parents_map into a search request recipe.
 
 
970
        # TODO: Manage this incrementally to avoid covering the same path
 
 
971
        # repeatedly. (The server will have to on each request, but the less
 
 
972
        # work done the better).
 
 
973
        parents_map = self._parents_map
 
 
974
        if parents_map is None:
 
 
975
            # Repository is not locked, so there's no cache.
 
 
977
        start_set = set(parents_map)
 
 
978
        result_parents = set()
 
 
979
        for parents in parents_map.itervalues():
 
 
980
            result_parents.update(parents)
 
 
981
        stop_keys = result_parents.difference(start_set)
 
 
982
        included_keys = start_set.intersection(result_parents)
 
 
983
        start_set.difference_update(included_keys)
 
 
984
        recipe = (start_set, stop_keys, len(parents_map))
 
 
985
        body = self._serialise_search_recipe(recipe)
 
 
986
        path = self.bzrdir._path_for_remote_call(self._client)
 
 
988
            if type(key) is not str:
 
 
990
                    "key %r not a plain string" % (key,))
 
 
991
        verb = 'Repository.get_parent_map'
 
 
992
        args = (path,) + tuple(keys)
 
 
994
            response = self._call_with_body_bytes_expecting_body(
 
 
996
        except errors.UnknownSmartMethod:
 
 
997
            # Server does not support this method, so get the whole graph.
 
 
998
            # Worse, we have to force a disconnection, because the server now
 
 
999
            # doesn't realise it has a body on the wire to consume, so the
 
 
1000
            # only way to recover is to abandon the connection.
 
 
1002
                'Server is too old for fast get_parent_map, reconnecting.  '
 
 
1003
                '(Upgrade the server to Bazaar 1.2 to avoid this)')
 
 
1005
            # To avoid having to disconnect repeatedly, we keep track of the
 
 
1006
            # fact the server doesn't understand remote methods added in 1.2.
 
 
1007
            medium._remember_remote_is_before((1, 2))
 
 
1008
            return self.get_revision_graph(None)
 
 
1009
        response_tuple, response_handler = response
 
 
1010
        if response_tuple[0] not in ['ok']:
 
 
1011
            response_handler.cancel_read_body()
 
 
1012
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
 
1013
        if response_tuple[0] == 'ok':
 
 
1014
            coded = bz2.decompress(response_handler.read_body_bytes())
 
 
1016
                # no revisions found
 
 
1018
            lines = coded.split('\n')
 
 
1021
                d = tuple(line.split())
 
 
1023
                    revision_graph[d[0]] = d[1:]
 
 
1025
                    # No parents - so give the Graph result (NULL_REVISION,).
 
 
1026
                    revision_graph[d[0]] = (NULL_REVISION,)
 
 
1027
            return revision_graph
 
 
1030
    def get_signature_text(self, revision_id):
 
 
1032
        return self._real_repository.get_signature_text(revision_id)
 
 
1035
    @symbol_versioning.deprecated_method(symbol_versioning.one_three)
 
 
1036
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
 
1038
        return self._real_repository.get_revision_graph_with_ghosts(
 
 
1039
            revision_ids=revision_ids)
 
 
1042
    def get_inventory_xml(self, revision_id):
 
 
1044
        return self._real_repository.get_inventory_xml(revision_id)
 
 
1046
    def deserialise_inventory(self, revision_id, xml):
 
 
1048
        return self._real_repository.deserialise_inventory(revision_id, xml)
 
 
1050
    def reconcile(self, other=None, thorough=False):
 
 
1052
        return self._real_repository.reconcile(other=other, thorough=thorough)
 
 
1054
    def all_revision_ids(self):
 
 
1056
        return self._real_repository.all_revision_ids()
 
 
1059
    def get_deltas_for_revisions(self, revisions):
 
 
1061
        return self._real_repository.get_deltas_for_revisions(revisions)
 
 
1064
    def get_revision_delta(self, revision_id):
 
 
1066
        return self._real_repository.get_revision_delta(revision_id)
 
 
1069
    def revision_trees(self, revision_ids):
 
 
1071
        return self._real_repository.revision_trees(revision_ids)
 
 
1074
    def get_revision_reconcile(self, revision_id):
 
 
1076
        return self._real_repository.get_revision_reconcile(revision_id)
 
 
1079
    def check(self, revision_ids=None):
 
 
1081
        return self._real_repository.check(revision_ids=revision_ids)
 
 
1083
    def copy_content_into(self, destination, revision_id=None):
 
 
1085
        return self._real_repository.copy_content_into(
 
 
1086
            destination, revision_id=revision_id)
 
 
1088
    def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
 
 
1089
        # get a tarball of the remote repository, and copy from that into the
 
 
1091
        from bzrlib import osutils
 
 
1093
        # TODO: Maybe a progress bar while streaming the tarball?
 
 
1094
        note("Copying repository content as tarball...")
 
 
1095
        tar_file = self._get_tarball('bz2')
 
 
1096
        if tar_file is None:
 
 
1098
        destination = to_bzrdir.create_repository()
 
 
1100
            tar = tarfile.open('repository', fileobj=tar_file,
 
 
1102
            tmpdir = osutils.mkdtemp()
 
 
1104
                _extract_tar(tar, tmpdir)
 
 
1105
                tmp_bzrdir = BzrDir.open(tmpdir)
 
 
1106
                tmp_repo = tmp_bzrdir.open_repository()
 
 
1107
                tmp_repo.copy_content_into(destination, revision_id)
 
 
1109
                osutils.rmtree(tmpdir)
 
 
1113
        # TODO: Suggestion from john: using external tar is much faster than
 
 
1114
        # python's tarfile library, but it may not work on windows.
 
 
1117
    def inventories(self):
 
 
1118
        """Decorate the real repository for now.
 
 
1120
        In the long term a full blown network facility is needed to
 
 
1121
        avoid creating a real repository object locally.
 
 
1124
        return self._real_repository.inventories
 
 
1128
        """Compress the data within the repository.
 
 
1130
        This is not currently implemented within the smart server.
 
 
1133
        return self._real_repository.pack()
 
 
1136
    def revisions(self):
 
 
1137
        """Decorate the real repository for now.
 
 
1139
        In the short term this should become a real object to intercept graph
 
 
1142
        In the long term a full blown network facility is needed.
 
 
1145
        return self._real_repository.revisions
 
 
1147
    def set_make_working_trees(self, new_value):
 
 
1149
        self._real_repository.set_make_working_trees(new_value)
 
 
1152
    def signatures(self):
 
 
1153
        """Decorate the real repository for now.
 
 
1155
        In the long term a full blown network facility is needed to avoid
 
 
1156
        creating a real repository object locally.
 
 
1159
        return self._real_repository.signatures
 
 
1162
    def sign_revision(self, revision_id, gpg_strategy):
 
 
1164
        return self._real_repository.sign_revision(revision_id, gpg_strategy)
 
 
1168
        """Decorate the real repository for now.
 
 
1170
        In the long term a full blown network facility is needed to avoid
 
 
1171
        creating a real repository object locally.
 
 
1174
        return self._real_repository.texts
 
 
1177
    def get_revisions(self, revision_ids):
 
 
1179
        return self._real_repository.get_revisions(revision_ids)
 
 
1181
    def supports_rich_root(self):
 
 
1183
        return self._real_repository.supports_rich_root()
 
 
1185
    def iter_reverse_revision_history(self, revision_id):
 
 
1187
        return self._real_repository.iter_reverse_revision_history(revision_id)
 
 
1190
    def _serializer(self):
 
 
1192
        return self._real_repository._serializer
 
 
1194
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
 
 
1196
        return self._real_repository.store_revision_signature(
 
 
1197
            gpg_strategy, plaintext, revision_id)
 
 
1199
    def add_signature_text(self, revision_id, signature):
 
 
1201
        return self._real_repository.add_signature_text(revision_id, signature)
 
 
1203
    def has_signature_for_revision_id(self, revision_id):
 
 
1205
        return self._real_repository.has_signature_for_revision_id(revision_id)
 
 
1207
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
 
 
1209
        return self._real_repository.item_keys_introduced_by(revision_ids,
 
 
1210
            _files_pb=_files_pb)
 
 
1212
    def revision_graph_can_have_wrong_parents(self):
 
 
1213
        # The answer depends on the remote repo format.
 
 
1215
        return self._real_repository.revision_graph_can_have_wrong_parents()
 
 
1217
    def _find_inconsistent_revision_parents(self):
 
 
1219
        return self._real_repository._find_inconsistent_revision_parents()
 
 
1221
    def _check_for_inconsistent_revision_parents(self):
 
 
1223
        return self._real_repository._check_for_inconsistent_revision_parents()
 
 
1225
    def _make_parents_provider(self):
 
 
1226
        providers = [_UnstackedParentsProvider(self)]
 
 
1227
        providers.extend(r._make_parents_provider() for r in
 
 
1228
                         self._fallback_repositories)
 
 
1229
        return graph._StackedParentsProvider(providers)
 
 
1231
    def _serialise_search_recipe(self, recipe):
 
 
1232
        """Serialise a graph search recipe.
 
 
1234
        :param recipe: A search recipe (start, stop, count).
 
 
1235
        :return: Serialised bytes.
 
 
1237
        start_keys = ' '.join(recipe[0])
 
 
1238
        stop_keys = ' '.join(recipe[1])
 
 
1239
        count = str(recipe[2])
 
 
1240
        return '\n'.join((start_keys, stop_keys, count))
 
 
1243
        path = self.bzrdir._path_for_remote_call(self._client)
 
 
1245
            response = self._call('PackRepository.autopack', path)
 
 
1246
        except errors.UnknownSmartMethod:
 
 
1248
            self._real_repository._pack_collection.autopack()
 
 
1250
        if self._real_repository is not None:
 
 
1251
            # Reset the real repository's cache of pack names.
 
 
1252
            # XXX: At some point we may be able to skip this and just rely on
 
 
1253
            # the automatic retry logic to do the right thing, but for now we
 
 
1254
            # err on the side of being correct rather than being optimal.
 
 
1255
            self._real_repository._pack_collection.reload_pack_names()
 
 
1256
        if response[0] != 'ok':
 
 
1257
            raise errors.UnexpectedSmartServerResponse(response)
 
 
1260
class RemoteBranchLockableFiles(LockableFiles):
 
 
1261
    """A 'LockableFiles' implementation that talks to a smart server.
 
 
1263
    This is not a public interface class.
 
 
1266
    def __init__(self, bzrdir, _client):
 
 
1267
        self.bzrdir = bzrdir
 
 
1268
        self._client = _client
 
 
1269
        self._need_find_modes = True
 
 
1270
        LockableFiles.__init__(
 
 
1271
            self, bzrdir.get_branch_transport(None),
 
 
1272
            'lock', lockdir.LockDir)
 
 
1274
    def _find_modes(self):
 
 
1275
        # RemoteBranches don't let the client set the mode of control files.
 
 
1276
        self._dir_mode = None
 
 
1277
        self._file_mode = None
 
 
1280
class RemoteBranchFormat(branch.BranchFormat):
 
 
1282
    def __eq__(self, other):
 
 
1283
        return (isinstance(other, RemoteBranchFormat) and 
 
 
1284
            self.__dict__ == other.__dict__)
 
 
1286
    def get_format_description(self):
 
 
1287
        return 'Remote BZR Branch'
 
 
1289
    def get_format_string(self):
 
 
1290
        return 'Remote BZR Branch'
 
 
1292
    def open(self, a_bzrdir):
 
 
1293
        return a_bzrdir.open_branch()
 
 
1295
    def initialize(self, a_bzrdir):
 
 
1296
        return a_bzrdir.create_branch()
 
 
1298
    def supports_tags(self):
 
 
1299
        # Remote branches might support tags, but we won't know until we
 
 
1300
        # access the real remote branch.
 
 
1304
class RemoteBranch(branch.Branch, _RpcHelper):
 
 
1305
    """Branch stored on a server accessed by HPSS RPC.
 
 
1307
    At the moment most operations are mapped down to simple file operations.
 
 
1310
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
 
 
1312
        """Create a RemoteBranch instance.
 
 
1314
        :param real_branch: An optional local implementation of the branch
 
 
1315
            format, usually accessing the data via the VFS.
 
 
1316
        :param _client: Private parameter for testing.
 
 
1318
        # We intentionally don't call the parent class's __init__, because it
 
 
1319
        # will try to assign to self.tags, which is a property in this subclass.
 
 
1320
        # And the parent's __init__ doesn't do much anyway.
 
 
1321
        self._revision_id_to_revno_cache = None
 
 
1322
        self._revision_history_cache = None
 
 
1323
        self._last_revision_info_cache = None
 
 
1324
        self.bzrdir = remote_bzrdir
 
 
1325
        if _client is not None:
 
 
1326
            self._client = _client
 
 
1328
            self._client = remote_bzrdir._client
 
 
1329
        self.repository = remote_repository
 
 
1330
        if real_branch is not None:
 
 
1331
            self._real_branch = real_branch
 
 
1332
            # Give the remote repository the matching real repo.
 
 
1333
            real_repo = self._real_branch.repository
 
 
1334
            if isinstance(real_repo, RemoteRepository):
 
 
1335
                real_repo._ensure_real()
 
 
1336
                real_repo = real_repo._real_repository
 
 
1337
            self.repository._set_real_repository(real_repo)
 
 
1338
            # Give the branch the remote repository to let fast-pathing happen.
 
 
1339
            self._real_branch.repository = self.repository
 
 
1341
            self._real_branch = None
 
 
1342
        # Fill out expected attributes of branch for bzrlib api users.
 
 
1343
        self._format = RemoteBranchFormat()
 
 
1344
        self.base = self.bzrdir.root_transport.base
 
 
1345
        self._control_files = None
 
 
1346
        self._lock_mode = None
 
 
1347
        self._lock_token = None
 
 
1348
        self._repo_lock_token = None
 
 
1349
        self._lock_count = 0
 
 
1350
        self._leave_lock = False
 
 
1351
        # The base class init is not called, so we duplicate this:
 
 
1352
        hooks = branch.Branch.hooks['open']
 
 
1355
        self._setup_stacking()
 
 
1357
    def _setup_stacking(self):
 
 
1358
        # configure stacking into the remote repository, by reading it from
 
 
1361
            fallback_url = self.get_stacked_on_url()
 
 
1362
        except (errors.NotStacked, errors.UnstackableBranchFormat,
 
 
1363
            errors.UnstackableRepositoryFormat), e:
 
 
1365
        # it's relative to this branch...
 
 
1366
        fallback_url = urlutils.join(self.base, fallback_url)
 
 
1367
        transports = [self.bzrdir.root_transport]
 
 
1368
        if self._real_branch is not None:
 
 
1369
            transports.append(self._real_branch._transport)
 
 
1370
        stacked_on = branch.Branch.open(fallback_url,
 
 
1371
                                        possible_transports=transports)
 
 
1372
        self.repository.add_fallback_repository(stacked_on.repository)
 
 
1374
    def _get_real_transport(self):
 
 
1375
        # if we try vfs access, return the real branch's vfs transport
 
 
1377
        return self._real_branch._transport
 
 
1379
    _transport = property(_get_real_transport)
 
 
1382
        return "%s(%s)" % (self.__class__.__name__, self.base)
 
 
1386
    def _ensure_real(self):
 
 
1387
        """Ensure that there is a _real_branch set.
 
 
1389
        Used before calls to self._real_branch.
 
 
1391
        if self._real_branch is None:
 
 
1392
            if not vfs.vfs_enabled():
 
 
1393
                raise AssertionError('smart server vfs must be enabled '
 
 
1394
                    'to use vfs implementation')
 
 
1395
            self.bzrdir._ensure_real()
 
 
1396
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
 
 
1397
            if self.repository._real_repository is None:
 
 
1398
                # Give the remote repository the matching real repo.
 
 
1399
                real_repo = self._real_branch.repository
 
 
1400
                if isinstance(real_repo, RemoteRepository):
 
 
1401
                    real_repo._ensure_real()
 
 
1402
                    real_repo = real_repo._real_repository
 
 
1403
                self.repository._set_real_repository(real_repo)
 
 
1404
            # Give the real branch the remote repository to let fast-pathing
 
 
1406
            self._real_branch.repository = self.repository
 
 
1407
            if self._lock_mode == 'r':
 
 
1408
                self._real_branch.lock_read()
 
 
1409
            elif self._lock_mode == 'w':
 
 
1410
                self._real_branch.lock_write(token=self._lock_token)
 
 
1412
    def _translate_error(self, err, **context):
 
 
1413
        self.repository._translate_error(err, branch=self, **context)
 
 
1415
    def _clear_cached_state(self):
 
 
1416
        super(RemoteBranch, self)._clear_cached_state()
 
 
1417
        if self._real_branch is not None:
 
 
1418
            self._real_branch._clear_cached_state()
 
 
1420
    def _clear_cached_state_of_remote_branch_only(self):
 
 
1421
        """Like _clear_cached_state, but doesn't clear the cache of
 
 
1424
        This is useful when falling back to calling a method of
 
 
1425
        self._real_branch that changes state.  In that case the underlying
 
 
1426
        branch changes, so we need to invalidate this RemoteBranch's cache of
 
 
1427
        it.  However, there's no need to invalidate the _real_branch's cache
 
 
1428
        too, in fact doing so might harm performance.
 
 
1430
        super(RemoteBranch, self)._clear_cached_state()
 
 
1433
    def control_files(self):
 
 
1434
        # Defer actually creating RemoteBranchLockableFiles until its needed,
 
 
1435
        # because it triggers an _ensure_real that we otherwise might not need.
 
 
1436
        if self._control_files is None:
 
 
1437
            self._control_files = RemoteBranchLockableFiles(
 
 
1438
                self.bzrdir, self._client)
 
 
1439
        return self._control_files
 
 
1441
    def _get_checkout_format(self):
 
 
1443
        return self._real_branch._get_checkout_format()
 
 
1445
    def get_physical_lock_status(self):
 
 
1446
        """See Branch.get_physical_lock_status()."""
 
 
1447
        # should be an API call to the server, as branches must be lockable.
 
 
1449
        return self._real_branch.get_physical_lock_status()
 
 
1451
    def get_stacked_on_url(self):
 
 
1452
        """Get the URL this branch is stacked against.
 
 
1454
        :raises NotStacked: If the branch is not stacked.
 
 
1455
        :raises UnstackableBranchFormat: If the branch does not support
 
 
1457
        :raises UnstackableRepositoryFormat: If the repository does not support
 
 
1461
            # there may not be a repository yet, so we can't use
 
 
1462
            # self._translate_error, so we can't use self._call either.
 
 
1463
            response = self._client.call('Branch.get_stacked_on_url',
 
 
1464
                self._remote_path())
 
 
1465
        except errors.ErrorFromSmartServer, err:
 
 
1466
            # there may not be a repository yet, so we can't call through
 
 
1467
            # its _translate_error
 
 
1468
            _translate_error(err, branch=self)
 
 
1469
        except errors.UnknownSmartMethod, err:
 
 
1471
            return self._real_branch.get_stacked_on_url()
 
 
1472
        if response[0] != 'ok':
 
 
1473
            raise errors.UnexpectedSmartServerResponse(response)
 
 
1476
    def lock_read(self):
 
 
1477
        self.repository.lock_read()
 
 
1478
        if not self._lock_mode:
 
 
1479
            self._lock_mode = 'r'
 
 
1480
            self._lock_count = 1
 
 
1481
            if self._real_branch is not None:
 
 
1482
                self._real_branch.lock_read()
 
 
1484
            self._lock_count += 1
 
 
1486
    def _remote_lock_write(self, token):
 
 
1488
            branch_token = repo_token = ''
 
 
1490
            branch_token = token
 
 
1491
            repo_token = self.repository.lock_write()
 
 
1492
            self.repository.unlock()
 
 
1493
        err_context = {'token': token}
 
 
1494
        response = self._call(
 
 
1495
            'Branch.lock_write', self._remote_path(), branch_token,
 
 
1496
            repo_token or '', **err_context)
 
 
1497
        if response[0] != 'ok':
 
 
1498
            raise errors.UnexpectedSmartServerResponse(response)
 
 
1499
        ok, branch_token, repo_token = response
 
 
1500
        return branch_token, repo_token
 
 
1502
    def lock_write(self, token=None):
 
 
1503
        if not self._lock_mode:
 
 
1504
            # Lock the branch and repo in one remote call.
 
 
1505
            remote_tokens = self._remote_lock_write(token)
 
 
1506
            self._lock_token, self._repo_lock_token = remote_tokens
 
 
1507
            if not self._lock_token:
 
 
1508
                raise SmartProtocolError('Remote server did not return a token!')
 
 
1509
            # Tell the self.repository object that it is locked.
 
 
1510
            self.repository.lock_write(
 
 
1511
                self._repo_lock_token, _skip_rpc=True)
 
 
1513
            if self._real_branch is not None:
 
 
1514
                self._real_branch.lock_write(token=self._lock_token)
 
 
1515
            if token is not None:
 
 
1516
                self._leave_lock = True
 
 
1518
                self._leave_lock = False
 
 
1519
            self._lock_mode = 'w'
 
 
1520
            self._lock_count = 1
 
 
1521
        elif self._lock_mode == 'r':
 
 
1522
            raise errors.ReadOnlyTransaction
 
 
1524
            if token is not None:
 
 
1525
                # A token was given to lock_write, and we're relocking, so
 
 
1526
                # check that the given token actually matches the one we
 
 
1528
                if token != self._lock_token:
 
 
1529
                    raise errors.TokenMismatch(token, self._lock_token)
 
 
1530
            self._lock_count += 1
 
 
1531
            # Re-lock the repository too.
 
 
1532
            self.repository.lock_write(self._repo_lock_token)
 
 
1533
        return self._lock_token or None
 
 
1535
    def _unlock(self, branch_token, repo_token):
 
 
1536
        err_context = {'token': str((branch_token, repo_token))}
 
 
1537
        response = self._call(
 
 
1538
            'Branch.unlock', self._remote_path(), branch_token,
 
 
1539
            repo_token or '', **err_context)
 
 
1540
        if response == ('ok',):
 
 
1542
        raise errors.UnexpectedSmartServerResponse(response)
 
 
1546
            self._lock_count -= 1
 
 
1547
            if not self._lock_count:
 
 
1548
                self._clear_cached_state()
 
 
1549
                mode = self._lock_mode
 
 
1550
                self._lock_mode = None
 
 
1551
                if self._real_branch is not None:
 
 
1552
                    if (not self._leave_lock and mode == 'w' and
 
 
1553
                        self._repo_lock_token):
 
 
1554
                        # If this RemoteBranch will remove the physical lock
 
 
1555
                        # for the repository, make sure the _real_branch
 
 
1556
                        # doesn't do it first.  (Because the _real_branch's
 
 
1557
                        # repository is set to be the RemoteRepository.)
 
 
1558
                        self._real_branch.repository.leave_lock_in_place()
 
 
1559
                    self._real_branch.unlock()
 
 
1561
                    # Only write-locked branched need to make a remote method
 
 
1562
                    # call to perfom the unlock.
 
 
1564
                if not self._lock_token:
 
 
1565
                    raise AssertionError('Locked, but no token!')
 
 
1566
                branch_token = self._lock_token
 
 
1567
                repo_token = self._repo_lock_token
 
 
1568
                self._lock_token = None
 
 
1569
                self._repo_lock_token = None
 
 
1570
                if not self._leave_lock:
 
 
1571
                    self._unlock(branch_token, repo_token)
 
 
1573
            self.repository.unlock()
 
 
1575
    def break_lock(self):
 
 
1577
        return self._real_branch.break_lock()
 
 
1579
    def leave_lock_in_place(self):
 
 
1580
        if not self._lock_token:
 
 
1581
            raise NotImplementedError(self.leave_lock_in_place)
 
 
1582
        self._leave_lock = True
 
 
1584
    def dont_leave_lock_in_place(self):
 
 
1585
        if not self._lock_token:
 
 
1586
            raise NotImplementedError(self.dont_leave_lock_in_place)
 
 
1587
        self._leave_lock = False
 
 
1589
    def _last_revision_info(self):
 
 
1590
        response = self._call('Branch.last_revision_info', self._remote_path())
 
 
1591
        if response[0] != 'ok':
 
 
1592
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
 
1593
        revno = int(response[1])
 
 
1594
        last_revision = response[2]
 
 
1595
        return (revno, last_revision)
 
 
1597
    def _gen_revision_history(self):
 
 
1598
        """See Branch._gen_revision_history()."""
 
 
1599
        response_tuple, response_handler = self._call_expecting_body(
 
 
1600
            'Branch.revision_history', self._remote_path())
 
 
1601
        if response_tuple[0] != 'ok':
 
 
1602
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
 
1603
        result = response_handler.read_body_bytes().split('\x00')
 
 
1608
    def _remote_path(self):
 
 
1609
        return self.bzrdir._path_for_remote_call(self._client)
 
 
1611
    def _set_last_revision_descendant(self, revision_id, other_branch,
 
 
1612
            allow_diverged=False, allow_overwrite_descendant=False):
 
 
1613
        err_context = {'other_branch': other_branch}
 
 
1614
        response = self._call('Branch.set_last_revision_ex',
 
 
1615
            self._remote_path(), self._lock_token, self._repo_lock_token,
 
 
1616
            revision_id, int(allow_diverged), int(allow_overwrite_descendant),
 
 
1618
        self._clear_cached_state()
 
 
1619
        if len(response) != 3 and response[0] != 'ok':
 
 
1620
            raise errors.UnexpectedSmartServerResponse(response)
 
 
1621
        new_revno, new_revision_id = response[1:]
 
 
1622
        self._last_revision_info_cache = new_revno, new_revision_id
 
 
1623
        if self._real_branch is not None:
 
 
1624
            cache = new_revno, new_revision_id
 
 
1625
            self._real_branch._last_revision_info_cache = cache
 
 
1627
    def _set_last_revision(self, revision_id):
 
 
1628
        self._clear_cached_state()
 
 
1629
        response = self._call('Branch.set_last_revision',
 
 
1630
            self._remote_path(), self._lock_token, self._repo_lock_token,
 
 
1632
        if response != ('ok',):
 
 
1633
            raise errors.UnexpectedSmartServerResponse(response)
 
 
1636
    def set_revision_history(self, rev_history):
 
 
1637
        # Send just the tip revision of the history; the server will generate
 
 
1638
        # the full history from that.  If the revision doesn't exist in this
 
 
1639
        # branch, NoSuchRevision will be raised.
 
 
1640
        if rev_history == []:
 
 
1643
            rev_id = rev_history[-1]
 
 
1644
        self._set_last_revision(rev_id)
 
 
1645
        self._cache_revision_history(rev_history)
 
 
1647
    def get_parent(self):
 
 
1649
        return self._real_branch.get_parent()
 
 
1651
    def set_parent(self, url):
 
 
1653
        return self._real_branch.set_parent(url)
 
 
1655
    def set_stacked_on_url(self, stacked_location):
 
 
1656
        """Set the URL this branch is stacked against.
 
 
1658
        :raises UnstackableBranchFormat: If the branch does not support
 
 
1660
        :raises UnstackableRepositoryFormat: If the repository does not support
 
 
1664
        return self._real_branch.set_stacked_on_url(stacked_location)
 
 
1666
    def sprout(self, to_bzrdir, revision_id=None):
 
 
1667
        branch_format = to_bzrdir._format._branch_format
 
 
1668
        if (branch_format is None or
 
 
1669
            isinstance(branch_format, RemoteBranchFormat)):
 
 
1670
            # The to_bzrdir specifies RemoteBranchFormat (or no format, which
 
 
1671
            # implies the same thing), but RemoteBranches can't be created at
 
 
1672
            # arbitrary URLs.  So create a branch in the same format as
 
 
1673
            # _real_branch instead.
 
 
1674
            # XXX: if to_bzrdir is a RemoteBzrDir, this should perhaps do
 
 
1675
            # to_bzrdir.create_branch to create a RemoteBranch after all...
 
 
1677
            result = self._real_branch._format.initialize(to_bzrdir)
 
 
1678
            self.copy_content_into(result, revision_id=revision_id)
 
 
1679
            result.set_parent(self.bzrdir.root_transport.base)
 
 
1681
            result = branch.Branch.sprout(
 
 
1682
                self, to_bzrdir, revision_id=revision_id)
 
 
1686
    def pull(self, source, overwrite=False, stop_revision=None,
 
 
1688
        self._clear_cached_state_of_remote_branch_only()
 
 
1690
        return self._real_branch.pull(
 
 
1691
            source, overwrite=overwrite, stop_revision=stop_revision,
 
 
1692
            _override_hook_target=self, **kwargs)
 
 
1695
    def push(self, target, overwrite=False, stop_revision=None):
 
 
1697
        return self._real_branch.push(
 
 
1698
            target, overwrite=overwrite, stop_revision=stop_revision,
 
 
1699
            _override_hook_source_branch=self)
 
 
1701
    def is_locked(self):
 
 
1702
        return self._lock_count >= 1
 
 
1705
    def revision_id_to_revno(self, revision_id):
 
 
1707
        return self._real_branch.revision_id_to_revno(revision_id)
 
 
1710
    def set_last_revision_info(self, revno, revision_id):
 
 
1711
        revision_id = ensure_null(revision_id)
 
 
1713
            response = self._call('Branch.set_last_revision_info',
 
 
1714
                self._remote_path(), self._lock_token, self._repo_lock_token,
 
 
1715
                str(revno), revision_id)
 
 
1716
        except errors.UnknownSmartMethod:
 
 
1718
            self._clear_cached_state_of_remote_branch_only()
 
 
1719
            self._real_branch.set_last_revision_info(revno, revision_id)
 
 
1720
            self._last_revision_info_cache = revno, revision_id
 
 
1722
        if response == ('ok',):
 
 
1723
            self._clear_cached_state()
 
 
1724
            self._last_revision_info_cache = revno, revision_id
 
 
1725
            # Update the _real_branch's cache too.
 
 
1726
            if self._real_branch is not None:
 
 
1727
                cache = self._last_revision_info_cache
 
 
1728
                self._real_branch._last_revision_info_cache = cache
 
 
1730
            raise errors.UnexpectedSmartServerResponse(response)
 
 
1733
    def generate_revision_history(self, revision_id, last_rev=None,
 
 
1735
        medium = self._client._medium
 
 
1736
        if not medium._is_remote_before((1, 6)):
 
 
1738
                self._set_last_revision_descendant(revision_id, other_branch,
 
 
1739
                    allow_diverged=True, allow_overwrite_descendant=True)
 
 
1741
            except errors.UnknownSmartMethod:
 
 
1742
                medium._remember_remote_is_before((1, 6))
 
 
1743
        self._clear_cached_state_of_remote_branch_only()
 
 
1745
        self._real_branch.generate_revision_history(
 
 
1746
            revision_id, last_rev=last_rev, other_branch=other_branch)
 
 
1751
        return self._real_branch.tags
 
 
1753
    def set_push_location(self, location):
 
 
1755
        return self._real_branch.set_push_location(location)
 
 
1758
    def update_revisions(self, other, stop_revision=None, overwrite=False,
 
 
1760
        """See Branch.update_revisions."""
 
 
1763
            if stop_revision is None:
 
 
1764
                stop_revision = other.last_revision()
 
 
1765
                if revision.is_null(stop_revision):
 
 
1766
                    # if there are no commits, we're done.
 
 
1768
            self.fetch(other, stop_revision)
 
 
1771
                # Just unconditionally set the new revision.  We don't care if
 
 
1772
                # the branches have diverged.
 
 
1773
                self._set_last_revision(stop_revision)
 
 
1775
                medium = self._client._medium
 
 
1776
                if not medium._is_remote_before((1, 6)):
 
 
1778
                        self._set_last_revision_descendant(stop_revision, other)
 
 
1780
                    except errors.UnknownSmartMethod:
 
 
1781
                        medium._remember_remote_is_before((1, 6))
 
 
1782
                # Fallback for pre-1.6 servers: check for divergence
 
 
1783
                # client-side, then do _set_last_revision.
 
 
1784
                last_rev = revision.ensure_null(self.last_revision())
 
 
1786
                    graph = self.repository.get_graph()
 
 
1787
                if self._check_if_descendant_or_diverged(
 
 
1788
                        stop_revision, last_rev, graph, other):
 
 
1789
                    # stop_revision is a descendant of last_rev, but we aren't
 
 
1790
                    # overwriting, so we're done.
 
 
1792
                self._set_last_revision(stop_revision)
 
 
1797
def _extract_tar(tar, to_dir):
 
 
1798
    """Extract all the contents of a tarfile object.
 
 
1800
    A replacement for extractall, which is not present in python2.4
 
 
1803
        tar.extract(tarinfo, to_dir)
 
 
1806
def _translate_error(err, **context):
 
 
1807
    """Translate an ErrorFromSmartServer into a more useful error.
 
 
1809
    Possible context keys:
 
 
1817
    If the error from the server doesn't match a known pattern, then
 
 
1818
    UnknownErrorFromSmartServer is raised.
 
 
1822
            return context[name]
 
 
1823
        except KeyError, key_err:
 
 
1824
            mutter('Missing key %r in context %r', key_err.args[0], context)
 
 
1827
        """Get the path from the context if present, otherwise use first error
 
 
1831
            return context['path']
 
 
1832
        except KeyError, key_err:
 
 
1834
                return err.error_args[0]
 
 
1835
            except IndexError, idx_err:
 
 
1837
                    'Missing key %r in context %r', key_err.args[0], context)
 
 
1840
    if err.error_verb == 'NoSuchRevision':
 
 
1841
        raise NoSuchRevision(find('branch'), err.error_args[0])
 
 
1842
    elif err.error_verb == 'nosuchrevision':
 
 
1843
        raise NoSuchRevision(find('repository'), err.error_args[0])
 
 
1844
    elif err.error_tuple == ('nobranch',):
 
 
1845
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
 
 
1846
    elif err.error_verb == 'norepository':
 
 
1847
        raise errors.NoRepositoryPresent(find('bzrdir'))
 
 
1848
    elif err.error_verb == 'LockContention':
 
 
1849
        raise errors.LockContention('(remote lock)')
 
 
1850
    elif err.error_verb == 'UnlockableTransport':
 
 
1851
        raise errors.UnlockableTransport(find('bzrdir').root_transport)
 
 
1852
    elif err.error_verb == 'LockFailed':
 
 
1853
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
 
 
1854
    elif err.error_verb == 'TokenMismatch':
 
 
1855
        raise errors.TokenMismatch(find('token'), '(remote token)')
 
 
1856
    elif err.error_verb == 'Diverged':
 
 
1857
        raise errors.DivergedBranches(find('branch'), find('other_branch'))
 
 
1858
    elif err.error_verb == 'TipChangeRejected':
 
 
1859
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
 
 
1860
    elif err.error_verb == 'UnstackableBranchFormat':
 
 
1861
        raise errors.UnstackableBranchFormat(*err.error_args)
 
 
1862
    elif err.error_verb == 'UnstackableRepositoryFormat':
 
 
1863
        raise errors.UnstackableRepositoryFormat(*err.error_args)
 
 
1864
    elif err.error_verb == 'NotStacked':
 
 
1865
        raise errors.NotStacked(branch=find('branch'))
 
 
1866
    elif err.error_verb == 'PermissionDenied':
 
 
1868
        if len(err.error_args) >= 2:
 
 
1869
            extra = err.error_args[1]
 
 
1872
        raise errors.PermissionDenied(path, extra=extra)
 
 
1873
    elif err.error_verb == 'ReadError':
 
 
1875
        raise errors.ReadError(path)
 
 
1876
    elif err.error_verb == 'NoSuchFile':
 
 
1878
        raise errors.NoSuchFile(path)
 
 
1879
    elif err.error_verb == 'FileExists':
 
 
1880
        raise errors.FileExists(err.error_args[0])
 
 
1881
    elif err.error_verb == 'DirectoryNotEmpty':
 
 
1882
        raise errors.DirectoryNotEmpty(err.error_args[0])
 
 
1883
    elif err.error_verb == 'ShortReadvError':
 
 
1884
        args = err.error_args
 
 
1885
        raise errors.ShortReadvError(
 
 
1886
            args[0], int(args[1]), int(args[2]), int(args[3]))
 
 
1887
    elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
 
 
1888
        encoding = str(err.error_args[0]) # encoding must always be a string
 
 
1889
        val = err.error_args[1]
 
 
1890
        start = int(err.error_args[2])
 
 
1891
        end = int(err.error_args[3])
 
 
1892
        reason = str(err.error_args[4]) # reason must always be a string
 
 
1893
        if val.startswith('u:'):
 
 
1894
            val = val[2:].decode('utf-8')
 
 
1895
        elif val.startswith('s:'):
 
 
1896
            val = val[2:].decode('base64')
 
 
1897
        if err.error_verb == 'UnicodeDecodeError':
 
 
1898
            raise UnicodeDecodeError(encoding, val, start, end, reason)
 
 
1899
        elif err.error_verb == 'UnicodeEncodeError':
 
 
1900
            raise UnicodeEncodeError(encoding, val, start, end, reason)
 
 
1901
    elif err.error_verb == 'ReadOnlyError':
 
 
1902
        raise errors.TransportNotPossible('readonly transport')
 
 
1903
    raise errors.UnknownErrorFromSmartServer(err)