/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Andrew Bennetts
  • Date: 2009-03-06 02:21:00 UTC
  • mto: This revision was merged to the branch mainline in revision 4084.
  • Revision ID: andrew.bennetts@canonical.com-20090306022100-cb3sz5julsdhgrpa
Fix trivial bug in my trivial bug fix :)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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
 
16
 
 
17
# TODO: At some point, handle upgrades by just passing the whole request
 
18
# across to run on the server.
 
19
 
 
20
import bz2
 
21
 
 
22
from bzrlib import (
 
23
    branch,
 
24
    bzrdir,
 
25
    debug,
 
26
    errors,
 
27
    graph,
 
28
    lockdir,
 
29
    pack,
 
30
    repository,
 
31
    revision,
 
32
    symbol_versioning,
 
33
    urlutils,
 
34
)
 
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 (
 
39
    NoSuchRevision,
 
40
    SmartProtocolError,
 
41
    )
 
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
 
47
 
 
48
 
 
49
class _RpcHelper(object):
 
50
    """Mixin class that helps with issuing RPCs."""
 
51
 
 
52
    def _call(self, method, *args, **err_context):
 
53
        try:
 
54
            return self._client.call(method, *args)
 
55
        except errors.ErrorFromSmartServer, err:
 
56
            self._translate_error(err, **err_context)
 
57
 
 
58
    def _call_expecting_body(self, method, *args, **err_context):
 
59
        try:
 
60
            return self._client.call_expecting_body(method, *args)
 
61
        except errors.ErrorFromSmartServer, err:
 
62
            self._translate_error(err, **err_context)
 
63
 
 
64
    def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
 
65
                                             **err_context):
 
66
        try:
 
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)
 
71
 
 
72
 
 
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]
 
80
    return format
 
81
 
 
82
 
 
83
# Note: RemoteBzrDirFormat is in bzrdir.py
 
84
 
 
85
class RemoteBzrDir(BzrDir, _RpcHelper):
 
86
    """Control directory on a remote server, accessed via bzr:// or similar."""
 
87
 
 
88
    def __init__(self, transport, format, _client=None):
 
89
        """Construct a RemoteBzrDir.
 
90
 
 
91
        :param _client: Private parameter for testing. Disables probing and the
 
92
            use of a real bzrdir.
 
93
        """
 
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
 
101
 
 
102
        if _client is None:
 
103
            medium = transport.get_smart_medium()
 
104
            self._client = client._SmartClient(medium)
 
105
        else:
 
106
            self._client = _client
 
107
            return
 
108
 
 
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)
 
115
 
 
116
    def _ensure_real(self):
 
117
        """Ensure that there is a _real_bzrdir set.
 
118
 
 
119
        Used before calls to self._real_bzrdir.
 
120
        """
 
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()
 
126
 
 
127
    def _translate_error(self, err, **context):
 
128
        _translate_error(err, bzrdir=self, **context)
 
129
 
 
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)
 
135
 
 
136
    def _vfs_cloning_metadir(self, require_stacking=False):
 
137
        self._ensure_real()
 
138
        return self._real_bzrdir.cloning_metadir(
 
139
            require_stacking=require_stacking)
 
140
 
 
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'
 
146
        if require_stacking:
 
147
            stacking = 'True'
 
148
        else:
 
149
            stacking = 'False'
 
150
        path = self._path_for_remote_call(self._client)
 
151
        try:
 
152
            response = self._call(verb, path, stacking)
 
153
        except errors.UnknownSmartMethod:
 
154
            return self._vfs_cloning_metadir(require_stacking=require_stacking)
 
155
        if len(response) != 3:
 
156
            raise errors.UnexpectedSmartServerResponse(response)
 
157
        control_name, repo_name, branch_info = response
 
158
        if len(branch_info) != 2:
 
159
            raise errors.UnexpectedSmartServerResponse(response)
 
160
        branch_ref, branch_name = branch_info
 
161
        format = bzrdir.network_format_registry.get(control_name)
 
162
        if repo_name:
 
163
            format.repository_format = repository.network_format_registry.get(
 
164
                repo_name)
 
165
        if branch_ref == 'reference':
 
166
            # XXX: we need possible_transports here to avoid reopening the
 
167
            # connection to the referenced location
 
168
            ref_bzrdir = BzrDir.open(branch_name)
 
169
            branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
 
170
            format.set_branch_format(branch_format)
 
171
        elif branch_ref == 'direct':
 
172
            if branch_name:
 
173
                format.set_branch_format(
 
174
                    branch.network_format_registry.get(branch_name))
 
175
        else:
 
176
            raise errors.UnexpectedSmartServerResponse(response)
 
177
        return format
 
178
 
 
179
    def create_repository(self, shared=False):
 
180
        # as per meta1 formats - just delegate to the format object which may
 
181
        # be parameterised.
 
182
        result = self._format.repository_format.initialize(self, shared)
 
183
        if not isinstance(result, RemoteRepository):
 
184
            return self.open_repository()
 
185
        else:
 
186
            return result
 
187
 
 
188
    def destroy_repository(self):
 
189
        """See BzrDir.destroy_repository"""
 
190
        self._ensure_real()
 
191
        self._real_bzrdir.destroy_repository()
 
192
 
 
193
    def create_branch(self):
 
194
        # as per meta1 formats - just delegate to the format object which may
 
195
        # be parameterised.
 
196
        real_branch = self._format.get_branch_format().initialize(self)
 
197
        if not isinstance(real_branch, RemoteBranch):
 
198
            result = RemoteBranch(self, self.find_repository(), real_branch)
 
199
        else:
 
200
            result = real_branch
 
201
        # BzrDir.clone_on_transport() uses the result of create_branch but does
 
202
        # not return it to its callers; we save approximately 8% of our round
 
203
        # trips by handing the branch we created back to the first caller to
 
204
        # open_branch rather than probing anew. Long term we need a API in
 
205
        # bzrdir that doesn't discard result objects (like result_branch).
 
206
        # RBC 20090225
 
207
        self._next_open_branch_result = result
 
208
        return result
 
209
 
 
210
    def destroy_branch(self):
 
211
        """See BzrDir.destroy_branch"""
 
212
        self._ensure_real()
 
213
        self._real_bzrdir.destroy_branch()
 
214
        self._next_open_branch_result = None
 
215
 
 
216
    def create_workingtree(self, revision_id=None, from_branch=None):
 
217
        raise errors.NotLocalUrl(self.transport.base)
 
218
 
 
219
    def find_branch_format(self):
 
220
        """Find the branch 'format' for this bzrdir.
 
221
 
 
222
        This might be a synthetic object for e.g. RemoteBranch and SVN.
 
223
        """
 
224
        b = self.open_branch()
 
225
        return b._format
 
226
 
 
227
    def get_branch_reference(self):
 
228
        """See BzrDir.get_branch_reference()."""
 
229
        path = self._path_for_remote_call(self._client)
 
230
        response = self._call('BzrDir.open_branch', path)
 
231
        if response[0] == 'ok':
 
232
            if response[1] == '':
 
233
                # branch at this location.
 
234
                return None
 
235
            else:
 
236
                # a branch reference, use the existing BranchReference logic.
 
237
                return response[1]
 
238
        else:
 
239
            raise errors.UnexpectedSmartServerResponse(response)
 
240
 
 
241
    def _get_tree_branch(self):
 
242
        """See BzrDir._get_tree_branch()."""
 
243
        return None, self.open_branch()
 
244
 
 
245
    def open_branch(self, _unsupported=False):
 
246
        if _unsupported:
 
247
            raise NotImplementedError('unsupported flag support not implemented yet.')
 
248
        if self._next_open_branch_result is not None:
 
249
            # See create_branch for details.
 
250
            result = self._next_open_branch_result
 
251
            self._next_open_branch_result = None
 
252
            return result
 
253
        reference_url = self.get_branch_reference()
 
254
        if reference_url is None:
 
255
            # branch at this location.
 
256
            return RemoteBranch(self, self.find_repository())
 
257
        else:
 
258
            # a branch reference, use the existing BranchReference logic.
 
259
            format = BranchReferenceFormat()
 
260
            return format.open(self, _found=True, location=reference_url)
 
261
 
 
262
    def _open_repo_v1(self, path):
 
263
        verb = 'BzrDir.find_repository'
 
264
        response = self._call(verb, path)
 
265
        if response[0] != 'ok':
 
266
            raise errors.UnexpectedSmartServerResponse(response)
 
267
        # servers that only support the v1 method don't support external
 
268
        # references either.
 
269
        self._ensure_real()
 
270
        repo = self._real_bzrdir.open_repository()
 
271
        response = response + ('no', repo._format.network_name())
 
272
        return response, repo
 
273
 
 
274
    def _open_repo_v2(self, path):
 
275
        verb = 'BzrDir.find_repositoryV2'
 
276
        response = self._call(verb, path)
 
277
        if response[0] != 'ok':
 
278
            raise errors.UnexpectedSmartServerResponse(response)
 
279
        self._ensure_real()
 
280
        repo = self._real_bzrdir.open_repository()
 
281
        response = response + (repo._format.network_name(),)
 
282
        return response, repo
 
283
 
 
284
    def _open_repo_v3(self, path):
 
285
        verb = 'BzrDir.find_repositoryV3'
 
286
        medium = self._client._medium
 
287
        if medium._is_remote_before((1, 13)):
 
288
            raise errors.UnknownSmartMethod(verb)
 
289
        response = self._call(verb, path)
 
290
        if response[0] != 'ok':
 
291
            raise errors.UnexpectedSmartServerResponse(response)
 
292
        return response, None
 
293
 
 
294
    def open_repository(self):
 
295
        path = self._path_for_remote_call(self._client)
 
296
        response = None
 
297
        for probe in [self._open_repo_v3, self._open_repo_v2,
 
298
            self._open_repo_v1]:
 
299
            try:
 
300
                response, real_repo = probe(path)
 
301
                break
 
302
            except errors.UnknownSmartMethod:
 
303
                pass
 
304
        if response is None:
 
305
            raise errors.UnknownSmartMethod('BzrDir.find_repository{3,2,}')
 
306
        if response[0] != 'ok':
 
307
            raise errors.UnexpectedSmartServerResponse(response)
 
308
        if len(response) != 6:
 
309
            raise SmartProtocolError('incorrect response length %s' % (response,))
 
310
        if response[1] == '':
 
311
            # repo is at this dir.
 
312
            format = response_tuple_to_repo_format(response[2:])
 
313
            # Used to support creating a real format instance when needed.
 
314
            format._creating_bzrdir = self
 
315
            remote_repo = RemoteRepository(self, format)
 
316
            format._creating_repo = remote_repo
 
317
            if real_repo is not None:
 
318
                remote_repo._set_real_repository(real_repo)
 
319
            return remote_repo
 
320
        else:
 
321
            raise errors.NoRepositoryPresent(self)
 
322
 
 
323
    def open_workingtree(self, recommend_upgrade=True):
 
324
        self._ensure_real()
 
325
        if self._real_bzrdir.has_workingtree():
 
326
            raise errors.NotLocalUrl(self.root_transport)
 
327
        else:
 
328
            raise errors.NoWorkingTree(self.root_transport.base)
 
329
 
 
330
    def _path_for_remote_call(self, client):
 
331
        """Return the path to be used for this bzrdir in a remote call."""
 
332
        return client.remote_path_from_transport(self.root_transport)
 
333
 
 
334
    def get_branch_transport(self, branch_format):
 
335
        self._ensure_real()
 
336
        return self._real_bzrdir.get_branch_transport(branch_format)
 
337
 
 
338
    def get_repository_transport(self, repository_format):
 
339
        self._ensure_real()
 
340
        return self._real_bzrdir.get_repository_transport(repository_format)
 
341
 
 
342
    def get_workingtree_transport(self, workingtree_format):
 
343
        self._ensure_real()
 
344
        return self._real_bzrdir.get_workingtree_transport(workingtree_format)
 
345
 
 
346
    def can_convert_format(self):
 
347
        """Upgrading of remote bzrdirs is not supported yet."""
 
348
        return False
 
349
 
 
350
    def needs_format_conversion(self, format=None):
 
351
        """Upgrading of remote bzrdirs is not supported yet."""
 
352
        if format is None:
 
353
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
 
354
                % 'needs_format_conversion(format=None)')
 
355
        return False
 
356
 
 
357
    def clone(self, url, revision_id=None, force_new_repo=False,
 
358
              preserve_stacking=False):
 
359
        self._ensure_real()
 
360
        return self._real_bzrdir.clone(url, revision_id=revision_id,
 
361
            force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
 
362
 
 
363
    def get_config(self):
 
364
        self._ensure_real()
 
365
        return self._real_bzrdir.get_config()
 
366
 
 
367
 
 
368
class RemoteRepositoryFormat(repository.RepositoryFormat):
 
369
    """Format for repositories accessed over a _SmartClient.
 
370
 
 
371
    Instances of this repository are represented by RemoteRepository
 
372
    instances.
 
373
 
 
374
    The RemoteRepositoryFormat is parameterized during construction
 
375
    to reflect the capabilities of the real, remote format. Specifically
 
376
    the attributes rich_root_data and supports_tree_reference are set
 
377
    on a per instance basis, and are not set (and should not be) at
 
378
    the class level.
 
379
 
 
380
    :ivar _custom_format: If set, a specific concrete repository format that
 
381
        will be used when initializing a repository with this
 
382
        RemoteRepositoryFormat.
 
383
    :ivar _creating_repo: If set, the repository object that this
 
384
        RemoteRepositoryFormat was created for: it can be called into
 
385
        to obtain data like the network name.
 
386
    """
 
387
 
 
388
    _matchingbzrdir = RemoteBzrDirFormat()
 
389
 
 
390
    def __init__(self):
 
391
        repository.RepositoryFormat.__init__(self)
 
392
        self._custom_format = None
 
393
        self._network_name = None
 
394
        self._creating_bzrdir = None
 
395
 
 
396
    def _vfs_initialize(self, a_bzrdir, shared):
 
397
        """Helper for common code in initialize."""
 
398
        if self._custom_format:
 
399
            # Custom format requested
 
400
            result = self._custom_format.initialize(a_bzrdir, shared=shared)
 
401
        elif self._creating_bzrdir is not None:
 
402
            # Use the format that the repository we were created to back
 
403
            # has.
 
404
            prior_repo = self._creating_bzrdir.open_repository()
 
405
            prior_repo._ensure_real()
 
406
            result = prior_repo._real_repository._format.initialize(
 
407
                a_bzrdir, shared=shared)
 
408
        else:
 
409
            # assume that a_bzr is a RemoteBzrDir but the smart server didn't
 
410
            # support remote initialization.
 
411
            # We delegate to a real object at this point (as RemoteBzrDir
 
412
            # delegate to the repository format which would lead to infinite
 
413
            # recursion if we just called a_bzrdir.create_repository.
 
414
            a_bzrdir._ensure_real()
 
415
            result = a_bzrdir._real_bzrdir.create_repository(shared=shared)
 
416
        if not isinstance(result, RemoteRepository):
 
417
            return self.open(a_bzrdir)
 
418
        else:
 
419
            return result
 
420
 
 
421
    def initialize(self, a_bzrdir, shared=False):
 
422
        # Being asked to create on a non RemoteBzrDir:
 
423
        if not isinstance(a_bzrdir, RemoteBzrDir):
 
424
            return self._vfs_initialize(a_bzrdir, shared)
 
425
        medium = a_bzrdir._client._medium
 
426
        if medium._is_remote_before((1, 13)):
 
427
            return self._vfs_initialize(a_bzrdir, shared)
 
428
        # Creating on a remote bzr dir.
 
429
        # 1) get the network name to use.
 
430
        if self._custom_format:
 
431
            network_name = self._custom_format.network_name()
 
432
        else:
 
433
            # Select the current bzrlib default and ask for that.
 
434
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
 
435
            reference_format = reference_bzrdir_format.repository_format
 
436
            network_name = reference_format.network_name()
 
437
        # 2) try direct creation via RPC
 
438
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
 
439
        verb = 'BzrDir.create_repository'
 
440
        if shared:
 
441
            shared_str = 'True'
 
442
        else:
 
443
            shared_str = 'False'
 
444
        try:
 
445
            response = a_bzrdir._call(verb, path, network_name, shared_str)
 
446
        except errors.UnknownSmartMethod:
 
447
            # Fallback - use vfs methods
 
448
            return self._vfs_initialize(a_bzrdir, shared)
 
449
        else:
 
450
            # Turn the response into a RemoteRepository object.
 
451
            format = response_tuple_to_repo_format(response[1:])
 
452
            # Used to support creating a real format instance when needed.
 
453
            format._creating_bzrdir = a_bzrdir
 
454
            remote_repo = RemoteRepository(a_bzrdir, format)
 
455
            format._creating_repo = remote_repo
 
456
            return remote_repo
 
457
 
 
458
    def open(self, a_bzrdir):
 
459
        if not isinstance(a_bzrdir, RemoteBzrDir):
 
460
            raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
 
461
        return a_bzrdir.open_repository()
 
462
 
 
463
    def _ensure_real(self):
 
464
        if self._custom_format is None:
 
465
            self._custom_format = repository.network_format_registry.get(
 
466
                self._network_name)
 
467
 
 
468
    @property
 
469
    def _fetch_order(self):
 
470
        self._ensure_real()
 
471
        return self._custom_format._fetch_order
 
472
 
 
473
    @property
 
474
    def _fetch_uses_deltas(self):
 
475
        self._ensure_real()
 
476
        return self._custom_format._fetch_uses_deltas
 
477
 
 
478
    @property
 
479
    def _fetch_reconcile(self):
 
480
        self._ensure_real()
 
481
        return self._custom_format._fetch_reconcile
 
482
 
 
483
    def get_format_description(self):
 
484
        return 'bzr remote repository'
 
485
 
 
486
    def __eq__(self, other):
 
487
        return self.__class__ == other.__class__
 
488
 
 
489
    def check_conversion_target(self, target_format):
 
490
        if self.rich_root_data and not target_format.rich_root_data:
 
491
            raise errors.BadConversionTarget(
 
492
                'Does not support rich root data.', target_format)
 
493
        if (self.supports_tree_reference and
 
494
            not getattr(target_format, 'supports_tree_reference', False)):
 
495
            raise errors.BadConversionTarget(
 
496
                'Does not support nested trees', target_format)
 
497
 
 
498
    def network_name(self):
 
499
        if self._network_name:
 
500
            return self._network_name
 
501
        self._creating_repo._ensure_real()
 
502
        return self._creating_repo._real_repository._format.network_name()
 
503
 
 
504
    @property
 
505
    def _serializer(self):
 
506
        self._ensure_real()
 
507
        return self._custom_format._serializer
 
508
 
 
509
 
 
510
class RemoteRepository(_RpcHelper):
 
511
    """Repository accessed over rpc.
 
512
 
 
513
    For the moment most operations are performed using local transport-backed
 
514
    Repository objects.
 
515
    """
 
516
 
 
517
    def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
 
518
        """Create a RemoteRepository instance.
 
519
 
 
520
        :param remote_bzrdir: The bzrdir hosting this repository.
 
521
        :param format: The RemoteFormat object to use.
 
522
        :param real_repository: If not None, a local implementation of the
 
523
            repository logic for the repository, usually accessing the data
 
524
            via the VFS.
 
525
        :param _client: Private testing parameter - override the smart client
 
526
            to be used by the repository.
 
527
        """
 
528
        if real_repository:
 
529
            self._real_repository = real_repository
 
530
        else:
 
531
            self._real_repository = None
 
532
        self.bzrdir = remote_bzrdir
 
533
        if _client is None:
 
534
            self._client = remote_bzrdir._client
 
535
        else:
 
536
            self._client = _client
 
537
        self._format = format
 
538
        self._lock_mode = None
 
539
        self._lock_token = None
 
540
        self._lock_count = 0
 
541
        self._leave_lock = False
 
542
        self._unstacked_provider = graph.CachingParentsProvider(
 
543
            get_parent_map=self._get_parent_map_rpc)
 
544
        self._unstacked_provider.disable_cache()
 
545
        # For tests:
 
546
        # These depend on the actual remote format, so force them off for
 
547
        # maximum compatibility. XXX: In future these should depend on the
 
548
        # remote repository instance, but this is irrelevant until we perform
 
549
        # reconcile via an RPC call.
 
550
        self._reconcile_does_inventory_gc = False
 
551
        self._reconcile_fixes_text_parents = False
 
552
        self._reconcile_backsup_inventory = False
 
553
        self.base = self.bzrdir.transport.base
 
554
        # Additional places to query for data.
 
555
        self._fallback_repositories = []
 
556
 
 
557
    def __str__(self):
 
558
        return "%s(%s)" % (self.__class__.__name__, self.base)
 
559
 
 
560
    __repr__ = __str__
 
561
 
 
562
    def abort_write_group(self, suppress_errors=False):
 
563
        """Complete a write group on the decorated repository.
 
564
 
 
565
        Smart methods peform operations in a single step so this api
 
566
        is not really applicable except as a compatibility thunk
 
567
        for older plugins that don't use e.g. the CommitBuilder
 
568
        facility.
 
569
 
 
570
        :param suppress_errors: see Repository.abort_write_group.
 
571
        """
 
572
        self._ensure_real()
 
573
        return self._real_repository.abort_write_group(
 
574
            suppress_errors=suppress_errors)
 
575
 
 
576
    def commit_write_group(self):
 
577
        """Complete a write group on the decorated repository.
 
578
 
 
579
        Smart methods peform operations in a single step so this api
 
580
        is not really applicable except as a compatibility thunk
 
581
        for older plugins that don't use e.g. the CommitBuilder
 
582
        facility.
 
583
        """
 
584
        self._ensure_real()
 
585
        return self._real_repository.commit_write_group()
 
586
 
 
587
    def resume_write_group(self, tokens):
 
588
        self._ensure_real()
 
589
        return self._real_repository.resume_write_group(tokens)
 
590
 
 
591
    def suspend_write_group(self):
 
592
        self._ensure_real()
 
593
        return self._real_repository.suspend_write_group()
 
594
 
 
595
    def _ensure_real(self):
 
596
        """Ensure that there is a _real_repository set.
 
597
 
 
598
        Used before calls to self._real_repository.
 
599
        """
 
600
        if self._real_repository is None:
 
601
            self.bzrdir._ensure_real()
 
602
            self._set_real_repository(
 
603
                self.bzrdir._real_bzrdir.open_repository())
 
604
 
 
605
    def _translate_error(self, err, **context):
 
606
        self.bzrdir._translate_error(err, repository=self, **context)
 
607
 
 
608
    def find_text_key_references(self):
 
609
        """Find the text key references within the repository.
 
610
 
 
611
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
 
612
        revision_ids. Each altered file-ids has the exact revision_ids that
 
613
        altered it listed explicitly.
 
614
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
 
615
            to whether they were referred to by the inventory of the
 
616
            revision_id that they contain. The inventory texts from all present
 
617
            revision ids are assessed to generate this report.
 
618
        """
 
619
        self._ensure_real()
 
620
        return self._real_repository.find_text_key_references()
 
621
 
 
622
    def _generate_text_key_index(self):
 
623
        """Generate a new text key index for the repository.
 
624
 
 
625
        This is an expensive function that will take considerable time to run.
 
626
 
 
627
        :return: A dict mapping (file_id, revision_id) tuples to a list of
 
628
            parents, also (file_id, revision_id) tuples.
 
629
        """
 
630
        self._ensure_real()
 
631
        return self._real_repository._generate_text_key_index()
 
632
 
 
633
    @symbol_versioning.deprecated_method(symbol_versioning.one_four)
 
634
    def get_revision_graph(self, revision_id=None):
 
635
        """See Repository.get_revision_graph()."""
 
636
        return self._get_revision_graph(revision_id)
 
637
 
 
638
    def _get_revision_graph(self, revision_id):
 
639
        """Private method for using with old (< 1.2) servers to fallback."""
 
640
        if revision_id is None:
 
641
            revision_id = ''
 
642
        elif revision.is_null(revision_id):
 
643
            return {}
 
644
 
 
645
        path = self.bzrdir._path_for_remote_call(self._client)
 
646
        response = self._call_expecting_body(
 
647
            'Repository.get_revision_graph', path, revision_id)
 
648
        response_tuple, response_handler = response
 
649
        if response_tuple[0] != 'ok':
 
650
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
651
        coded = response_handler.read_body_bytes()
 
652
        if coded == '':
 
653
            # no revisions in this repository!
 
654
            return {}
 
655
        lines = coded.split('\n')
 
656
        revision_graph = {}
 
657
        for line in lines:
 
658
            d = tuple(line.split())
 
659
            revision_graph[d[0]] = d[1:]
 
660
 
 
661
        return revision_graph
 
662
 
 
663
    def _get_sink(self):
 
664
        """See Repository._get_sink()."""
 
665
        return RemoteStreamSink(self)
 
666
 
 
667
    def _get_source(self, to_format):
 
668
        """Return a source for streaming from this repository."""
 
669
        return RemoteStreamSource(self, to_format)
 
670
 
 
671
    def has_revision(self, revision_id):
 
672
        """See Repository.has_revision()."""
 
673
        if revision_id == NULL_REVISION:
 
674
            # The null revision is always present.
 
675
            return True
 
676
        path = self.bzrdir._path_for_remote_call(self._client)
 
677
        response = self._call('Repository.has_revision', path, revision_id)
 
678
        if response[0] not in ('yes', 'no'):
 
679
            raise errors.UnexpectedSmartServerResponse(response)
 
680
        if response[0] == 'yes':
 
681
            return True
 
682
        for fallback_repo in self._fallback_repositories:
 
683
            if fallback_repo.has_revision(revision_id):
 
684
                return True
 
685
        return False
 
686
 
 
687
    def has_revisions(self, revision_ids):
 
688
        """See Repository.has_revisions()."""
 
689
        # FIXME: This does many roundtrips, particularly when there are
 
690
        # fallback repositories.  -- mbp 20080905
 
691
        result = set()
 
692
        for revision_id in revision_ids:
 
693
            if self.has_revision(revision_id):
 
694
                result.add(revision_id)
 
695
        return result
 
696
 
 
697
    def has_same_location(self, other):
 
698
        return (self.__class__ == other.__class__ and
 
699
                self.bzrdir.transport.base == other.bzrdir.transport.base)
 
700
 
 
701
    def get_graph(self, other_repository=None):
 
702
        """Return the graph for this repository format"""
 
703
        parents_provider = self._make_parents_provider(other_repository)
 
704
        return graph.Graph(parents_provider)
 
705
 
 
706
    def gather_stats(self, revid=None, committers=None):
 
707
        """See Repository.gather_stats()."""
 
708
        path = self.bzrdir._path_for_remote_call(self._client)
 
709
        # revid can be None to indicate no revisions, not just NULL_REVISION
 
710
        if revid is None or revision.is_null(revid):
 
711
            fmt_revid = ''
 
712
        else:
 
713
            fmt_revid = revid
 
714
        if committers is None or not committers:
 
715
            fmt_committers = 'no'
 
716
        else:
 
717
            fmt_committers = 'yes'
 
718
        response_tuple, response_handler = self._call_expecting_body(
 
719
            'Repository.gather_stats', path, fmt_revid, fmt_committers)
 
720
        if response_tuple[0] != 'ok':
 
721
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
722
 
 
723
        body = response_handler.read_body_bytes()
 
724
        result = {}
 
725
        for line in body.split('\n'):
 
726
            if not line:
 
727
                continue
 
728
            key, val_text = line.split(':')
 
729
            if key in ('revisions', 'size', 'committers'):
 
730
                result[key] = int(val_text)
 
731
            elif key in ('firstrev', 'latestrev'):
 
732
                values = val_text.split(' ')[1:]
 
733
                result[key] = (float(values[0]), long(values[1]))
 
734
 
 
735
        return result
 
736
 
 
737
    def find_branches(self, using=False):
 
738
        """See Repository.find_branches()."""
 
739
        # should be an API call to the server.
 
740
        self._ensure_real()
 
741
        return self._real_repository.find_branches(using=using)
 
742
 
 
743
    def get_physical_lock_status(self):
 
744
        """See Repository.get_physical_lock_status()."""
 
745
        # should be an API call to the server.
 
746
        self._ensure_real()
 
747
        return self._real_repository.get_physical_lock_status()
 
748
 
 
749
    def is_in_write_group(self):
 
750
        """Return True if there is an open write group.
 
751
 
 
752
        write groups are only applicable locally for the smart server..
 
753
        """
 
754
        if self._real_repository:
 
755
            return self._real_repository.is_in_write_group()
 
756
 
 
757
    def is_locked(self):
 
758
        return self._lock_count >= 1
 
759
 
 
760
    def is_shared(self):
 
761
        """See Repository.is_shared()."""
 
762
        path = self.bzrdir._path_for_remote_call(self._client)
 
763
        response = self._call('Repository.is_shared', path)
 
764
        if response[0] not in ('yes', 'no'):
 
765
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
766
        return response[0] == 'yes'
 
767
 
 
768
    def is_write_locked(self):
 
769
        return self._lock_mode == 'w'
 
770
 
 
771
    def lock_read(self):
 
772
        # wrong eventually - want a local lock cache context
 
773
        if not self._lock_mode:
 
774
            self._lock_mode = 'r'
 
775
            self._lock_count = 1
 
776
            self._unstacked_provider.enable_cache(cache_misses=False)
 
777
            if self._real_repository is not None:
 
778
                self._real_repository.lock_read()
 
779
        else:
 
780
            self._lock_count += 1
 
781
 
 
782
    def _remote_lock_write(self, token):
 
783
        path = self.bzrdir._path_for_remote_call(self._client)
 
784
        if token is None:
 
785
            token = ''
 
786
        err_context = {'token': token}
 
787
        response = self._call('Repository.lock_write', path, token,
 
788
                              **err_context)
 
789
        if response[0] == 'ok':
 
790
            ok, token = response
 
791
            return token
 
792
        else:
 
793
            raise errors.UnexpectedSmartServerResponse(response)
 
794
 
 
795
    def lock_write(self, token=None, _skip_rpc=False):
 
796
        if not self._lock_mode:
 
797
            if _skip_rpc:
 
798
                if self._lock_token is not None:
 
799
                    if token != self._lock_token:
 
800
                        raise errors.TokenMismatch(token, self._lock_token)
 
801
                self._lock_token = token
 
802
            else:
 
803
                self._lock_token = self._remote_lock_write(token)
 
804
            # if self._lock_token is None, then this is something like packs or
 
805
            # svn where we don't get to lock the repo, or a weave style repository
 
806
            # where we cannot lock it over the wire and attempts to do so will
 
807
            # fail.
 
808
            if self._real_repository is not None:
 
809
                self._real_repository.lock_write(token=self._lock_token)
 
810
            if token is not None:
 
811
                self._leave_lock = True
 
812
            else:
 
813
                self._leave_lock = False
 
814
            self._lock_mode = 'w'
 
815
            self._lock_count = 1
 
816
            self._unstacked_provider.enable_cache(cache_misses=False)
 
817
        elif self._lock_mode == 'r':
 
818
            raise errors.ReadOnlyError(self)
 
819
        else:
 
820
            self._lock_count += 1
 
821
        return self._lock_token or None
 
822
 
 
823
    def leave_lock_in_place(self):
 
824
        if not self._lock_token:
 
825
            raise NotImplementedError(self.leave_lock_in_place)
 
826
        self._leave_lock = True
 
827
 
 
828
    def dont_leave_lock_in_place(self):
 
829
        if not self._lock_token:
 
830
            raise NotImplementedError(self.dont_leave_lock_in_place)
 
831
        self._leave_lock = False
 
832
 
 
833
    def _set_real_repository(self, repository):
 
834
        """Set the _real_repository for this repository.
 
835
 
 
836
        :param repository: The repository to fallback to for non-hpss
 
837
            implemented operations.
 
838
        """
 
839
        if self._real_repository is not None:
 
840
            # Replacing an already set real repository.
 
841
            # We cannot do this [currently] if the repository is locked -
 
842
            # synchronised state might be lost.
 
843
            if self.is_locked():
 
844
                raise AssertionError('_real_repository is already set')
 
845
        if isinstance(repository, RemoteRepository):
 
846
            raise AssertionError()
 
847
        self._real_repository = repository
 
848
        for fb in self._fallback_repositories:
 
849
            self._real_repository.add_fallback_repository(fb)
 
850
        if self._lock_mode == 'w':
 
851
            # if we are already locked, the real repository must be able to
 
852
            # acquire the lock with our token.
 
853
            self._real_repository.lock_write(self._lock_token)
 
854
        elif self._lock_mode == 'r':
 
855
            self._real_repository.lock_read()
 
856
 
 
857
    def start_write_group(self):
 
858
        """Start a write group on the decorated repository.
 
859
 
 
860
        Smart methods peform operations in a single step so this api
 
861
        is not really applicable except as a compatibility thunk
 
862
        for older plugins that don't use e.g. the CommitBuilder
 
863
        facility.
 
864
        """
 
865
        self._ensure_real()
 
866
        return self._real_repository.start_write_group()
 
867
 
 
868
    def _unlock(self, token):
 
869
        path = self.bzrdir._path_for_remote_call(self._client)
 
870
        if not token:
 
871
            # with no token the remote repository is not persistently locked.
 
872
            return
 
873
        err_context = {'token': token}
 
874
        response = self._call('Repository.unlock', path, token,
 
875
                              **err_context)
 
876
        if response == ('ok',):
 
877
            return
 
878
        else:
 
879
            raise errors.UnexpectedSmartServerResponse(response)
 
880
 
 
881
    def unlock(self):
 
882
        if not self._lock_count:
 
883
            raise errors.LockNotHeld(self)
 
884
        self._lock_count -= 1
 
885
        if self._lock_count > 0:
 
886
            return
 
887
        self._unstacked_provider.disable_cache()
 
888
        old_mode = self._lock_mode
 
889
        self._lock_mode = None
 
890
        try:
 
891
            # The real repository is responsible at present for raising an
 
892
            # exception if it's in an unfinished write group.  However, it
 
893
            # normally will *not* actually remove the lock from disk - that's
 
894
            # done by the server on receiving the Repository.unlock call.
 
895
            # This is just to let the _real_repository stay up to date.
 
896
            if self._real_repository is not None:
 
897
                self._real_repository.unlock()
 
898
        finally:
 
899
            # The rpc-level lock should be released even if there was a
 
900
            # problem releasing the vfs-based lock.
 
901
            if old_mode == 'w':
 
902
                # Only write-locked repositories need to make a remote method
 
903
                # call to perfom the unlock.
 
904
                old_token = self._lock_token
 
905
                self._lock_token = None
 
906
                if not self._leave_lock:
 
907
                    self._unlock(old_token)
 
908
 
 
909
    def break_lock(self):
 
910
        # should hand off to the network
 
911
        self._ensure_real()
 
912
        return self._real_repository.break_lock()
 
913
 
 
914
    def _get_tarball(self, compression):
 
915
        """Return a TemporaryFile containing a repository tarball.
 
916
 
 
917
        Returns None if the server does not support sending tarballs.
 
918
        """
 
919
        import tempfile
 
920
        path = self.bzrdir._path_for_remote_call(self._client)
 
921
        try:
 
922
            response, protocol = self._call_expecting_body(
 
923
                'Repository.tarball', path, compression)
 
924
        except errors.UnknownSmartMethod:
 
925
            protocol.cancel_read_body()
 
926
            return None
 
927
        if response[0] == 'ok':
 
928
            # Extract the tarball and return it
 
929
            t = tempfile.NamedTemporaryFile()
 
930
            # TODO: rpc layer should read directly into it...
 
931
            t.write(protocol.read_body_bytes())
 
932
            t.seek(0)
 
933
            return t
 
934
        raise errors.UnexpectedSmartServerResponse(response)
 
935
 
 
936
    def sprout(self, to_bzrdir, revision_id=None):
 
937
        # TODO: Option to control what format is created?
 
938
        self._ensure_real()
 
939
        dest_repo = self._real_repository._format.initialize(to_bzrdir,
 
940
                                                             shared=False)
 
941
        dest_repo.fetch(self, revision_id=revision_id)
 
942
        return dest_repo
 
943
 
 
944
    ### These methods are just thin shims to the VFS object for now.
 
945
 
 
946
    def revision_tree(self, revision_id):
 
947
        self._ensure_real()
 
948
        return self._real_repository.revision_tree(revision_id)
 
949
 
 
950
    def get_serializer_format(self):
 
951
        self._ensure_real()
 
952
        return self._real_repository.get_serializer_format()
 
953
 
 
954
    def get_commit_builder(self, branch, parents, config, timestamp=None,
 
955
                           timezone=None, committer=None, revprops=None,
 
956
                           revision_id=None):
 
957
        # FIXME: It ought to be possible to call this without immediately
 
958
        # triggering _ensure_real.  For now it's the easiest thing to do.
 
959
        self._ensure_real()
 
960
        real_repo = self._real_repository
 
961
        builder = real_repo.get_commit_builder(branch, parents,
 
962
                config, timestamp=timestamp, timezone=timezone,
 
963
                committer=committer, revprops=revprops, revision_id=revision_id)
 
964
        return builder
 
965
 
 
966
    def add_fallback_repository(self, repository):
 
967
        """Add a repository to use for looking up data not held locally.
 
968
 
 
969
        :param repository: A repository.
 
970
        """
 
971
        # XXX: At the moment the RemoteRepository will allow fallbacks
 
972
        # unconditionally - however, a _real_repository will usually exist,
 
973
        # and may raise an error if it's not accommodated by the underlying
 
974
        # format.  Eventually we should check when opening the repository
 
975
        # whether it's willing to allow them or not.
 
976
        #
 
977
        # We need to accumulate additional repositories here, to pass them in
 
978
        # on various RPC's.
 
979
        #
 
980
        self._fallback_repositories.append(repository)
 
981
        # If self._real_repository was parameterised already (e.g. because a
 
982
        # _real_branch had its get_stacked_on_url method called), then the
 
983
        # repository to be added may already be in the _real_repositories list.
 
984
        if self._real_repository is not None:
 
985
            if repository not in self._real_repository._fallback_repositories:
 
986
                self._real_repository.add_fallback_repository(repository)
 
987
        else:
 
988
            # They are also seen by the fallback repository.  If it doesn't
 
989
            # exist yet they'll be added then.  This implicitly copies them.
 
990
            self._ensure_real()
 
991
 
 
992
    def add_inventory(self, revid, inv, parents):
 
993
        self._ensure_real()
 
994
        return self._real_repository.add_inventory(revid, inv, parents)
 
995
 
 
996
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
 
997
                               parents):
 
998
        self._ensure_real()
 
999
        return self._real_repository.add_inventory_by_delta(basis_revision_id,
 
1000
            delta, new_revision_id, parents)
 
1001
 
 
1002
    def add_revision(self, rev_id, rev, inv=None, config=None):
 
1003
        self._ensure_real()
 
1004
        return self._real_repository.add_revision(
 
1005
            rev_id, rev, inv=inv, config=config)
 
1006
 
 
1007
    @needs_read_lock
 
1008
    def get_inventory(self, revision_id):
 
1009
        self._ensure_real()
 
1010
        return self._real_repository.get_inventory(revision_id)
 
1011
 
 
1012
    def iter_inventories(self, revision_ids):
 
1013
        self._ensure_real()
 
1014
        return self._real_repository.iter_inventories(revision_ids)
 
1015
 
 
1016
    @needs_read_lock
 
1017
    def get_revision(self, revision_id):
 
1018
        self._ensure_real()
 
1019
        return self._real_repository.get_revision(revision_id)
 
1020
 
 
1021
    def get_transaction(self):
 
1022
        self._ensure_real()
 
1023
        return self._real_repository.get_transaction()
 
1024
 
 
1025
    @needs_read_lock
 
1026
    def clone(self, a_bzrdir, revision_id=None):
 
1027
        self._ensure_real()
 
1028
        return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
 
1029
 
 
1030
    def make_working_trees(self):
 
1031
        """See Repository.make_working_trees"""
 
1032
        self._ensure_real()
 
1033
        return self._real_repository.make_working_trees()
 
1034
 
 
1035
    def revision_ids_to_search_result(self, result_set):
 
1036
        """Convert a set of revision ids to a graph SearchResult."""
 
1037
        result_parents = set()
 
1038
        for parents in self.get_graph().get_parent_map(
 
1039
            result_set).itervalues():
 
1040
            result_parents.update(parents)
 
1041
        included_keys = result_set.intersection(result_parents)
 
1042
        start_keys = result_set.difference(included_keys)
 
1043
        exclude_keys = result_parents.difference(result_set)
 
1044
        result = graph.SearchResult(start_keys, exclude_keys,
 
1045
            len(result_set), result_set)
 
1046
        return result
 
1047
 
 
1048
    @needs_read_lock
 
1049
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
1050
        """Return the revision ids that other has that this does not.
 
1051
 
 
1052
        These are returned in topological order.
 
1053
 
 
1054
        revision_id: only return revision ids included by revision_id.
 
1055
        """
 
1056
        return repository.InterRepository.get(
 
1057
            other, self).search_missing_revision_ids(revision_id, find_ghosts)
 
1058
 
 
1059
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False):
 
1060
        # Not delegated to _real_repository so that InterRepository.get has a
 
1061
        # chance to find an InterRepository specialised for RemoteRepository.
 
1062
        if self.has_same_location(source):
 
1063
            # check that last_revision is in 'from' and then return a
 
1064
            # no-operation.
 
1065
            if (revision_id is not None and
 
1066
                not revision.is_null(revision_id)):
 
1067
                self.get_revision(revision_id)
 
1068
            return 0, []
 
1069
        inter = repository.InterRepository.get(source, self)
 
1070
        try:
 
1071
            return inter.fetch(revision_id=revision_id, pb=pb, find_ghosts=find_ghosts)
 
1072
        except NotImplementedError:
 
1073
            raise errors.IncompatibleRepositories(source, self)
 
1074
 
 
1075
    def create_bundle(self, target, base, fileobj, format=None):
 
1076
        self._ensure_real()
 
1077
        self._real_repository.create_bundle(target, base, fileobj, format)
 
1078
 
 
1079
    @needs_read_lock
 
1080
    def get_ancestry(self, revision_id, topo_sorted=True):
 
1081
        self._ensure_real()
 
1082
        return self._real_repository.get_ancestry(revision_id, topo_sorted)
 
1083
 
 
1084
    def fileids_altered_by_revision_ids(self, revision_ids):
 
1085
        self._ensure_real()
 
1086
        return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
 
1087
 
 
1088
    def _get_versioned_file_checker(self, revisions, revision_versions_cache):
 
1089
        self._ensure_real()
 
1090
        return self._real_repository._get_versioned_file_checker(
 
1091
            revisions, revision_versions_cache)
 
1092
 
 
1093
    def iter_files_bytes(self, desired_files):
 
1094
        """See Repository.iter_file_bytes.
 
1095
        """
 
1096
        self._ensure_real()
 
1097
        return self._real_repository.iter_files_bytes(desired_files)
 
1098
 
 
1099
    def get_parent_map(self, revision_ids):
 
1100
        """See bzrlib.Graph.get_parent_map()."""
 
1101
        return self._make_parents_provider().get_parent_map(revision_ids)
 
1102
 
 
1103
    def _get_parent_map_rpc(self, keys):
 
1104
        """Helper for get_parent_map that performs the RPC."""
 
1105
        medium = self._client._medium
 
1106
        if medium._is_remote_before((1, 2)):
 
1107
            # We already found out that the server can't understand
 
1108
            # Repository.get_parent_map requests, so just fetch the whole
 
1109
            # graph.
 
1110
            # XXX: Note that this will issue a deprecation warning. This is ok
 
1111
            # :- its because we're working with a deprecated server anyway, and
 
1112
            # the user will almost certainly have seen a warning about the
 
1113
            # server version already.
 
1114
            rg = self.get_revision_graph()
 
1115
            # There is an api discrepency between get_parent_map and
 
1116
            # get_revision_graph. Specifically, a "key:()" pair in
 
1117
            # get_revision_graph just means a node has no parents. For
 
1118
            # "get_parent_map" it means the node is a ghost. So fix up the
 
1119
            # graph to correct this.
 
1120
            #   https://bugs.launchpad.net/bzr/+bug/214894
 
1121
            # There is one other "bug" which is that ghosts in
 
1122
            # get_revision_graph() are not returned at all. But we won't worry
 
1123
            # about that for now.
 
1124
            for node_id, parent_ids in rg.iteritems():
 
1125
                if parent_ids == ():
 
1126
                    rg[node_id] = (NULL_REVISION,)
 
1127
            rg[NULL_REVISION] = ()
 
1128
            return rg
 
1129
 
 
1130
        keys = set(keys)
 
1131
        if None in keys:
 
1132
            raise ValueError('get_parent_map(None) is not valid')
 
1133
        if NULL_REVISION in keys:
 
1134
            keys.discard(NULL_REVISION)
 
1135
            found_parents = {NULL_REVISION:()}
 
1136
            if not keys:
 
1137
                return found_parents
 
1138
        else:
 
1139
            found_parents = {}
 
1140
        # TODO(Needs analysis): We could assume that the keys being requested
 
1141
        # from get_parent_map are in a breadth first search, so typically they
 
1142
        # will all be depth N from some common parent, and we don't have to
 
1143
        # have the server iterate from the root parent, but rather from the
 
1144
        # keys we're searching; and just tell the server the keyspace we
 
1145
        # already have; but this may be more traffic again.
 
1146
 
 
1147
        # Transform self._parents_map into a search request recipe.
 
1148
        # TODO: Manage this incrementally to avoid covering the same path
 
1149
        # repeatedly. (The server will have to on each request, but the less
 
1150
        # work done the better).
 
1151
        parents_map = self._unstacked_provider.get_cached_map()
 
1152
        if parents_map is None:
 
1153
            # Repository is not locked, so there's no cache.
 
1154
            parents_map = {}
 
1155
        start_set = set(parents_map)
 
1156
        result_parents = set()
 
1157
        for parents in parents_map.itervalues():
 
1158
            result_parents.update(parents)
 
1159
        stop_keys = result_parents.difference(start_set)
 
1160
        included_keys = start_set.intersection(result_parents)
 
1161
        start_set.difference_update(included_keys)
 
1162
        recipe = (start_set, stop_keys, len(parents_map))
 
1163
        body = self._serialise_search_recipe(recipe)
 
1164
        path = self.bzrdir._path_for_remote_call(self._client)
 
1165
        for key in keys:
 
1166
            if type(key) is not str:
 
1167
                raise ValueError(
 
1168
                    "key %r not a plain string" % (key,))
 
1169
        verb = 'Repository.get_parent_map'
 
1170
        args = (path,) + tuple(keys)
 
1171
        try:
 
1172
            response = self._call_with_body_bytes_expecting_body(
 
1173
                verb, args, body)
 
1174
        except errors.UnknownSmartMethod:
 
1175
            # Server does not support this method, so get the whole graph.
 
1176
            # Worse, we have to force a disconnection, because the server now
 
1177
            # doesn't realise it has a body on the wire to consume, so the
 
1178
            # only way to recover is to abandon the connection.
 
1179
            warning(
 
1180
                'Server is too old for fast get_parent_map, reconnecting.  '
 
1181
                '(Upgrade the server to Bazaar 1.2 to avoid this)')
 
1182
            medium.disconnect()
 
1183
            # To avoid having to disconnect repeatedly, we keep track of the
 
1184
            # fact the server doesn't understand remote methods added in 1.2.
 
1185
            medium._remember_remote_is_before((1, 2))
 
1186
            return self.get_revision_graph(None)
 
1187
        response_tuple, response_handler = response
 
1188
        if response_tuple[0] not in ['ok']:
 
1189
            response_handler.cancel_read_body()
 
1190
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
1191
        if response_tuple[0] == 'ok':
 
1192
            coded = bz2.decompress(response_handler.read_body_bytes())
 
1193
            if coded == '':
 
1194
                # no revisions found
 
1195
                return {}
 
1196
            lines = coded.split('\n')
 
1197
            revision_graph = {}
 
1198
            for line in lines:
 
1199
                d = tuple(line.split())
 
1200
                if len(d) > 1:
 
1201
                    revision_graph[d[0]] = d[1:]
 
1202
                else:
 
1203
                    # No parents - so give the Graph result (NULL_REVISION,).
 
1204
                    revision_graph[d[0]] = (NULL_REVISION,)
 
1205
            return revision_graph
 
1206
 
 
1207
    @needs_read_lock
 
1208
    def get_signature_text(self, revision_id):
 
1209
        self._ensure_real()
 
1210
        return self._real_repository.get_signature_text(revision_id)
 
1211
 
 
1212
    @needs_read_lock
 
1213
    @symbol_versioning.deprecated_method(symbol_versioning.one_three)
 
1214
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
1215
        self._ensure_real()
 
1216
        return self._real_repository.get_revision_graph_with_ghosts(
 
1217
            revision_ids=revision_ids)
 
1218
 
 
1219
    @needs_read_lock
 
1220
    def get_inventory_xml(self, revision_id):
 
1221
        self._ensure_real()
 
1222
        return self._real_repository.get_inventory_xml(revision_id)
 
1223
 
 
1224
    def deserialise_inventory(self, revision_id, xml):
 
1225
        self._ensure_real()
 
1226
        return self._real_repository.deserialise_inventory(revision_id, xml)
 
1227
 
 
1228
    def reconcile(self, other=None, thorough=False):
 
1229
        self._ensure_real()
 
1230
        return self._real_repository.reconcile(other=other, thorough=thorough)
 
1231
 
 
1232
    def all_revision_ids(self):
 
1233
        self._ensure_real()
 
1234
        return self._real_repository.all_revision_ids()
 
1235
 
 
1236
    @needs_read_lock
 
1237
    def get_deltas_for_revisions(self, revisions):
 
1238
        self._ensure_real()
 
1239
        return self._real_repository.get_deltas_for_revisions(revisions)
 
1240
 
 
1241
    @needs_read_lock
 
1242
    def get_revision_delta(self, revision_id):
 
1243
        self._ensure_real()
 
1244
        return self._real_repository.get_revision_delta(revision_id)
 
1245
 
 
1246
    @needs_read_lock
 
1247
    def revision_trees(self, revision_ids):
 
1248
        self._ensure_real()
 
1249
        return self._real_repository.revision_trees(revision_ids)
 
1250
 
 
1251
    @needs_read_lock
 
1252
    def get_revision_reconcile(self, revision_id):
 
1253
        self._ensure_real()
 
1254
        return self._real_repository.get_revision_reconcile(revision_id)
 
1255
 
 
1256
    @needs_read_lock
 
1257
    def check(self, revision_ids=None):
 
1258
        self._ensure_real()
 
1259
        return self._real_repository.check(revision_ids=revision_ids)
 
1260
 
 
1261
    def copy_content_into(self, destination, revision_id=None):
 
1262
        self._ensure_real()
 
1263
        return self._real_repository.copy_content_into(
 
1264
            destination, revision_id=revision_id)
 
1265
 
 
1266
    def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
 
1267
        # get a tarball of the remote repository, and copy from that into the
 
1268
        # destination
 
1269
        from bzrlib import osutils
 
1270
        import tarfile
 
1271
        # TODO: Maybe a progress bar while streaming the tarball?
 
1272
        note("Copying repository content as tarball...")
 
1273
        tar_file = self._get_tarball('bz2')
 
1274
        if tar_file is None:
 
1275
            return None
 
1276
        destination = to_bzrdir.create_repository()
 
1277
        try:
 
1278
            tar = tarfile.open('repository', fileobj=tar_file,
 
1279
                mode='r|bz2')
 
1280
            tmpdir = osutils.mkdtemp()
 
1281
            try:
 
1282
                _extract_tar(tar, tmpdir)
 
1283
                tmp_bzrdir = BzrDir.open(tmpdir)
 
1284
                tmp_repo = tmp_bzrdir.open_repository()
 
1285
                tmp_repo.copy_content_into(destination, revision_id)
 
1286
            finally:
 
1287
                osutils.rmtree(tmpdir)
 
1288
        finally:
 
1289
            tar_file.close()
 
1290
        return destination
 
1291
        # TODO: Suggestion from john: using external tar is much faster than
 
1292
        # python's tarfile library, but it may not work on windows.
 
1293
 
 
1294
    @property
 
1295
    def inventories(self):
 
1296
        """Decorate the real repository for now.
 
1297
 
 
1298
        In the long term a full blown network facility is needed to
 
1299
        avoid creating a real repository object locally.
 
1300
        """
 
1301
        self._ensure_real()
 
1302
        return self._real_repository.inventories
 
1303
 
 
1304
    @needs_write_lock
 
1305
    def pack(self):
 
1306
        """Compress the data within the repository.
 
1307
 
 
1308
        This is not currently implemented within the smart server.
 
1309
        """
 
1310
        self._ensure_real()
 
1311
        return self._real_repository.pack()
 
1312
 
 
1313
    @property
 
1314
    def revisions(self):
 
1315
        """Decorate the real repository for now.
 
1316
 
 
1317
        In the short term this should become a real object to intercept graph
 
1318
        lookups.
 
1319
 
 
1320
        In the long term a full blown network facility is needed.
 
1321
        """
 
1322
        self._ensure_real()
 
1323
        return self._real_repository.revisions
 
1324
 
 
1325
    def set_make_working_trees(self, new_value):
 
1326
        if new_value:
 
1327
            new_value_str = "True"
 
1328
        else:
 
1329
            new_value_str = "False"
 
1330
        path = self.bzrdir._path_for_remote_call(self._client)
 
1331
        try:
 
1332
            response = self._call(
 
1333
                'Repository.set_make_working_trees', path, new_value_str)
 
1334
        except errors.UnknownSmartMethod:
 
1335
            self._ensure_real()
 
1336
            self._real_repository.set_make_working_trees(new_value)
 
1337
        else:
 
1338
            if response[0] != 'ok':
 
1339
                raise errors.UnexpectedSmartServerResponse(response)
 
1340
 
 
1341
    @property
 
1342
    def signatures(self):
 
1343
        """Decorate the real repository for now.
 
1344
 
 
1345
        In the long term a full blown network facility is needed to avoid
 
1346
        creating a real repository object locally.
 
1347
        """
 
1348
        self._ensure_real()
 
1349
        return self._real_repository.signatures
 
1350
 
 
1351
    @needs_write_lock
 
1352
    def sign_revision(self, revision_id, gpg_strategy):
 
1353
        self._ensure_real()
 
1354
        return self._real_repository.sign_revision(revision_id, gpg_strategy)
 
1355
 
 
1356
    @property
 
1357
    def texts(self):
 
1358
        """Decorate the real repository for now.
 
1359
 
 
1360
        In the long term a full blown network facility is needed to avoid
 
1361
        creating a real repository object locally.
 
1362
        """
 
1363
        self._ensure_real()
 
1364
        return self._real_repository.texts
 
1365
 
 
1366
    @needs_read_lock
 
1367
    def get_revisions(self, revision_ids):
 
1368
        self._ensure_real()
 
1369
        return self._real_repository.get_revisions(revision_ids)
 
1370
 
 
1371
    def supports_rich_root(self):
 
1372
        return self._format.rich_root_data
 
1373
 
 
1374
    def iter_reverse_revision_history(self, revision_id):
 
1375
        self._ensure_real()
 
1376
        return self._real_repository.iter_reverse_revision_history(revision_id)
 
1377
 
 
1378
    @property
 
1379
    def _serializer(self):
 
1380
        return self._format._serializer
 
1381
 
 
1382
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
 
1383
        self._ensure_real()
 
1384
        return self._real_repository.store_revision_signature(
 
1385
            gpg_strategy, plaintext, revision_id)
 
1386
 
 
1387
    def add_signature_text(self, revision_id, signature):
 
1388
        self._ensure_real()
 
1389
        return self._real_repository.add_signature_text(revision_id, signature)
 
1390
 
 
1391
    def has_signature_for_revision_id(self, revision_id):
 
1392
        self._ensure_real()
 
1393
        return self._real_repository.has_signature_for_revision_id(revision_id)
 
1394
 
 
1395
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
 
1396
        self._ensure_real()
 
1397
        return self._real_repository.item_keys_introduced_by(revision_ids,
 
1398
            _files_pb=_files_pb)
 
1399
 
 
1400
    def revision_graph_can_have_wrong_parents(self):
 
1401
        # The answer depends on the remote repo format.
 
1402
        self._ensure_real()
 
1403
        return self._real_repository.revision_graph_can_have_wrong_parents()
 
1404
 
 
1405
    def _find_inconsistent_revision_parents(self):
 
1406
        self._ensure_real()
 
1407
        return self._real_repository._find_inconsistent_revision_parents()
 
1408
 
 
1409
    def _check_for_inconsistent_revision_parents(self):
 
1410
        self._ensure_real()
 
1411
        return self._real_repository._check_for_inconsistent_revision_parents()
 
1412
 
 
1413
    def _make_parents_provider(self, other=None):
 
1414
        providers = [self._unstacked_provider]
 
1415
        if other is not None:
 
1416
            providers.insert(0, other)
 
1417
        providers.extend(r._make_parents_provider() for r in
 
1418
                         self._fallback_repositories)
 
1419
        return graph._StackedParentsProvider(providers)
 
1420
 
 
1421
    def _serialise_search_recipe(self, recipe):
 
1422
        """Serialise a graph search recipe.
 
1423
 
 
1424
        :param recipe: A search recipe (start, stop, count).
 
1425
        :return: Serialised bytes.
 
1426
        """
 
1427
        start_keys = ' '.join(recipe[0])
 
1428
        stop_keys = ' '.join(recipe[1])
 
1429
        count = str(recipe[2])
 
1430
        return '\n'.join((start_keys, stop_keys, count))
 
1431
 
 
1432
    def autopack(self):
 
1433
        path = self.bzrdir._path_for_remote_call(self._client)
 
1434
        try:
 
1435
            response = self._call('PackRepository.autopack', path)
 
1436
        except errors.UnknownSmartMethod:
 
1437
            self._ensure_real()
 
1438
            self._real_repository._pack_collection.autopack()
 
1439
            return
 
1440
        if self._real_repository is not None:
 
1441
            # Reset the real repository's cache of pack names.
 
1442
            # XXX: At some point we may be able to skip this and just rely on
 
1443
            # the automatic retry logic to do the right thing, but for now we
 
1444
            # err on the side of being correct rather than being optimal.
 
1445
            self._real_repository._pack_collection.reload_pack_names()
 
1446
        if response[0] != 'ok':
 
1447
            raise errors.UnexpectedSmartServerResponse(response)
 
1448
 
 
1449
 
 
1450
class RemoteStreamSink(repository.StreamSink):
 
1451
 
 
1452
    def _insert_real(self, stream, src_format, resume_tokens):
 
1453
        self.target_repo._ensure_real()
 
1454
        sink = self.target_repo._real_repository._get_sink()
 
1455
        result = sink.insert_stream(stream, src_format, resume_tokens)
 
1456
        if not result:
 
1457
            self.target_repo.autopack()
 
1458
        return result
 
1459
 
 
1460
    def insert_stream(self, stream, src_format, resume_tokens):
 
1461
        repo = self.target_repo
 
1462
        client = repo._client
 
1463
        medium = client._medium
 
1464
        if medium._is_remote_before((1, 13)):
 
1465
            # No possible way this can work.
 
1466
            return self._insert_real(stream, src_format, resume_tokens)
 
1467
        path = repo.bzrdir._path_for_remote_call(client)
 
1468
        if not resume_tokens:
 
1469
            # XXX: Ugly but important for correctness, *will* be fixed during
 
1470
            # 1.13 cycle. Pushing a stream that is interrupted results in a
 
1471
            # fallback to the _real_repositories sink *with a partial stream*.
 
1472
            # Thats bad because we insert less data than bzr expected. To avoid
 
1473
            # this we do a trial push to make sure the verb is accessible, and
 
1474
            # do not fallback when actually pushing the stream. A cleanup patch
 
1475
            # is going to look at rewinding/restarting the stream/partial
 
1476
            # buffering etc.
 
1477
            byte_stream = smart_repo._stream_to_byte_stream([], src_format)
 
1478
            try:
 
1479
                response = client.call_with_body_stream(
 
1480
                    ('Repository.insert_stream', path, ''), byte_stream)
 
1481
            except errors.UnknownSmartMethod:
 
1482
                medium._remember_remote_is_before((1,13))
 
1483
                return self._insert_real(stream, src_format, resume_tokens)
 
1484
        byte_stream = smart_repo._stream_to_byte_stream(
 
1485
            stream, src_format)
 
1486
        resume_tokens = ' '.join(resume_tokens)
 
1487
        response = client.call_with_body_stream(
 
1488
            ('Repository.insert_stream', path, resume_tokens), byte_stream)
 
1489
        if response[0][0] not in ('ok', 'missing-basis'):
 
1490
            raise errors.UnexpectedSmartServerResponse(response)
 
1491
        if response[0][0] == 'missing-basis':
 
1492
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
 
1493
            resume_tokens = tokens
 
1494
            return resume_tokens, missing_keys
 
1495
        else:
 
1496
            if self.target_repo._real_repository is not None:
 
1497
                collection = getattr(self.target_repo._real_repository,
 
1498
                    '_pack_collection', None)
 
1499
                if collection is not None:
 
1500
                    collection.reload_pack_names()
 
1501
            return [], set()
 
1502
 
 
1503
 
 
1504
class RemoteStreamSource(repository.StreamSource):
 
1505
    """Stream data from a remote server."""
 
1506
 
 
1507
    def get_stream(self, search):
 
1508
        # streaming with fallback repositories is not well defined yet: The
 
1509
        # remote repository cannot see the fallback repositories, and thus
 
1510
        # cannot satisfy the entire search in the general case. Likewise the
 
1511
        # fallback repositories cannot reify the search to determine what they
 
1512
        # should send. It likely needs a return value in the stream listing the
 
1513
        # edge of the search to resume from in fallback repositories.
 
1514
        if self.from_repository._fallback_repositories:
 
1515
            return repository.StreamSource.get_stream(self, search)
 
1516
        repo = self.from_repository
 
1517
        client = repo._client
 
1518
        medium = client._medium
 
1519
        if medium._is_remote_before((1, 13)):
 
1520
            # No possible way this can work.
 
1521
            return repository.StreamSource.get_stream(self, search)
 
1522
        path = repo.bzrdir._path_for_remote_call(client)
 
1523
        try:
 
1524
            recipe = repo._serialise_search_recipe(search._recipe)
 
1525
            response = repo._call_with_body_bytes_expecting_body(
 
1526
                'Repository.get_stream',
 
1527
                (path, self.to_format.network_name()), recipe)
 
1528
            response_tuple, response_handler = response
 
1529
        except errors.UnknownSmartMethod:
 
1530
            medium._remember_remote_is_before((1,13))
 
1531
            return repository.StreamSource.get_stream(self, search)
 
1532
        if response_tuple[0] != 'ok':
 
1533
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
1534
        byte_stream = response_handler.read_streamed_body()
 
1535
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
 
1536
        if src_format.network_name() != repo._format.network_name():
 
1537
            raise AssertionError(
 
1538
                "Mismatched RemoteRepository and stream src %r, %r" % (
 
1539
                src_format.network_name(), repo._format.network_name()))
 
1540
        return stream
 
1541
 
 
1542
 
 
1543
class RemoteBranchLockableFiles(LockableFiles):
 
1544
    """A 'LockableFiles' implementation that talks to a smart server.
 
1545
 
 
1546
    This is not a public interface class.
 
1547
    """
 
1548
 
 
1549
    def __init__(self, bzrdir, _client):
 
1550
        self.bzrdir = bzrdir
 
1551
        self._client = _client
 
1552
        self._need_find_modes = True
 
1553
        LockableFiles.__init__(
 
1554
            self, bzrdir.get_branch_transport(None),
 
1555
            'lock', lockdir.LockDir)
 
1556
 
 
1557
    def _find_modes(self):
 
1558
        # RemoteBranches don't let the client set the mode of control files.
 
1559
        self._dir_mode = None
 
1560
        self._file_mode = None
 
1561
 
 
1562
 
 
1563
class RemoteBranchFormat(branch.BranchFormat):
 
1564
 
 
1565
    def __init__(self):
 
1566
        super(RemoteBranchFormat, self).__init__()
 
1567
        self._matchingbzrdir = RemoteBzrDirFormat()
 
1568
        self._matchingbzrdir.set_branch_format(self)
 
1569
        self._custom_format = None
 
1570
 
 
1571
    def __eq__(self, other):
 
1572
        return (isinstance(other, RemoteBranchFormat) and
 
1573
            self.__dict__ == other.__dict__)
 
1574
 
 
1575
    def get_format_description(self):
 
1576
        return 'Remote BZR Branch'
 
1577
 
 
1578
    def network_name(self):
 
1579
        return self._network_name
 
1580
 
 
1581
    def open(self, a_bzrdir):
 
1582
        return a_bzrdir.open_branch()
 
1583
 
 
1584
    def _vfs_initialize(self, a_bzrdir):
 
1585
        # Initialisation when using a local bzrdir object, or a non-vfs init
 
1586
        # method is not available on the server.
 
1587
        # self._custom_format is always set - the start of initialize ensures
 
1588
        # that.
 
1589
        if isinstance(a_bzrdir, RemoteBzrDir):
 
1590
            a_bzrdir._ensure_real()
 
1591
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
 
1592
        else:
 
1593
            # We assume the bzrdir is parameterised; it may not be.
 
1594
            result = self._custom_format.initialize(a_bzrdir)
 
1595
        if (isinstance(a_bzrdir, RemoteBzrDir) and
 
1596
            not isinstance(result, RemoteBranch)):
 
1597
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
 
1598
        return result
 
1599
 
 
1600
    def initialize(self, a_bzrdir):
 
1601
        # 1) get the network name to use.
 
1602
        if self._custom_format:
 
1603
            network_name = self._custom_format.network_name()
 
1604
        else:
 
1605
            # Select the current bzrlib default and ask for that.
 
1606
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
 
1607
            reference_format = reference_bzrdir_format.get_branch_format()
 
1608
            self._custom_format = reference_format
 
1609
            network_name = reference_format.network_name()
 
1610
        # Being asked to create on a non RemoteBzrDir:
 
1611
        if not isinstance(a_bzrdir, RemoteBzrDir):
 
1612
            return self._vfs_initialize(a_bzrdir)
 
1613
        medium = a_bzrdir._client._medium
 
1614
        if medium._is_remote_before((1, 13)):
 
1615
            return self._vfs_initialize(a_bzrdir)
 
1616
        # Creating on a remote bzr dir.
 
1617
        # 2) try direct creation via RPC
 
1618
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
 
1619
        verb = 'BzrDir.create_branch'
 
1620
        try:
 
1621
            response = a_bzrdir._call(verb, path, network_name)
 
1622
        except errors.UnknownSmartMethod:
 
1623
            # Fallback - use vfs methods
 
1624
            return self._vfs_initialize(a_bzrdir)
 
1625
        if response[0] != 'ok':
 
1626
            raise errors.UnexpectedSmartServerResponse(response)
 
1627
        # Turn the response into a RemoteRepository object.
 
1628
        format = RemoteBranchFormat()
 
1629
        format._network_name = response[1]
 
1630
        repo_format = response_tuple_to_repo_format(response[3:])
 
1631
        if response[2] == '':
 
1632
            repo_bzrdir = a_bzrdir
 
1633
        else:
 
1634
            repo_bzrdir = RemoteBzrDir(
 
1635
                a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
 
1636
                a_bzrdir._client)
 
1637
        remote_repo = RemoteRepository(repo_bzrdir, repo_format)
 
1638
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
 
1639
            format=format, setup_stacking=False)
 
1640
        # XXX: We know this is a new branch, so it must have revno 0, revid
 
1641
        # NULL_REVISION. Creating the branch locked would make this be unable
 
1642
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
 
1643
        remote_branch._last_revision_info_cache = 0, NULL_REVISION
 
1644
        return remote_branch
 
1645
 
 
1646
    def supports_tags(self):
 
1647
        # Remote branches might support tags, but we won't know until we
 
1648
        # access the real remote branch.
 
1649
        return True
 
1650
 
 
1651
 
 
1652
class RemoteBranch(branch.Branch, _RpcHelper):
 
1653
    """Branch stored on a server accessed by HPSS RPC.
 
1654
 
 
1655
    At the moment most operations are mapped down to simple file operations.
 
1656
    """
 
1657
 
 
1658
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
 
1659
        _client=None, format=None, setup_stacking=True):
 
1660
        """Create a RemoteBranch instance.
 
1661
 
 
1662
        :param real_branch: An optional local implementation of the branch
 
1663
            format, usually accessing the data via the VFS.
 
1664
        :param _client: Private parameter for testing.
 
1665
        :param format: A RemoteBranchFormat object, None to create one
 
1666
            automatically. If supplied it should have a network_name already
 
1667
            supplied.
 
1668
        :param setup_stacking: If True make an RPC call to determine the
 
1669
            stacked (or not) status of the branch. If False assume the branch
 
1670
            is not stacked.
 
1671
        """
 
1672
        # We intentionally don't call the parent class's __init__, because it
 
1673
        # will try to assign to self.tags, which is a property in this subclass.
 
1674
        # And the parent's __init__ doesn't do much anyway.
 
1675
        self._revision_id_to_revno_cache = None
 
1676
        self._partial_revision_id_to_revno_cache = {}
 
1677
        self._revision_history_cache = None
 
1678
        self._last_revision_info_cache = None
 
1679
        self._merge_sorted_revisions_cache = None
 
1680
        self.bzrdir = remote_bzrdir
 
1681
        if _client is not None:
 
1682
            self._client = _client
 
1683
        else:
 
1684
            self._client = remote_bzrdir._client
 
1685
        self.repository = remote_repository
 
1686
        if real_branch is not None:
 
1687
            self._real_branch = real_branch
 
1688
            # Give the remote repository the matching real repo.
 
1689
            real_repo = self._real_branch.repository
 
1690
            if isinstance(real_repo, RemoteRepository):
 
1691
                real_repo._ensure_real()
 
1692
                real_repo = real_repo._real_repository
 
1693
            self.repository._set_real_repository(real_repo)
 
1694
            # Give the branch the remote repository to let fast-pathing happen.
 
1695
            self._real_branch.repository = self.repository
 
1696
        else:
 
1697
            self._real_branch = None
 
1698
        # Fill out expected attributes of branch for bzrlib api users.
 
1699
        self.base = self.bzrdir.root_transport.base
 
1700
        self._control_files = None
 
1701
        self._lock_mode = None
 
1702
        self._lock_token = None
 
1703
        self._repo_lock_token = None
 
1704
        self._lock_count = 0
 
1705
        self._leave_lock = False
 
1706
        # Setup a format: note that we cannot call _ensure_real until all the
 
1707
        # attributes above are set: This code cannot be moved higher up in this
 
1708
        # function.
 
1709
        if format is None:
 
1710
            self._format = RemoteBranchFormat()
 
1711
            if real_branch is not None:
 
1712
                self._format._network_name = \
 
1713
                    self._real_branch._format.network_name()
 
1714
            #else:
 
1715
            #    # XXX: Need to get this from BzrDir.open_branch's return value.
 
1716
            #    self._ensure_real()
 
1717
            #    self._format._network_name = \
 
1718
            #        self._real_branch._format.network_name()
 
1719
        else:
 
1720
            self._format = format
 
1721
        # The base class init is not called, so we duplicate this:
 
1722
        hooks = branch.Branch.hooks['open']
 
1723
        for hook in hooks:
 
1724
            hook(self)
 
1725
        if setup_stacking:
 
1726
            self._setup_stacking()
 
1727
 
 
1728
    def _setup_stacking(self):
 
1729
        # configure stacking into the remote repository, by reading it from
 
1730
        # the vfs branch.
 
1731
        try:
 
1732
            fallback_url = self.get_stacked_on_url()
 
1733
        except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1734
            errors.UnstackableRepositoryFormat), e:
 
1735
            return
 
1736
        # it's relative to this branch...
 
1737
        fallback_url = urlutils.join(self.base, fallback_url)
 
1738
        transports = [self.bzrdir.root_transport]
 
1739
        if self._real_branch is not None:
 
1740
            # The real repository is setup already:
 
1741
            transports.append(self._real_branch._transport)
 
1742
            self.repository.add_fallback_repository(
 
1743
                self.repository._real_repository._fallback_repositories[0])
 
1744
        else:
 
1745
            stacked_on = branch.Branch.open(fallback_url,
 
1746
                                            possible_transports=transports)
 
1747
            self.repository.add_fallback_repository(stacked_on.repository)
 
1748
 
 
1749
    def _get_real_transport(self):
 
1750
        # if we try vfs access, return the real branch's vfs transport
 
1751
        self._ensure_real()
 
1752
        return self._real_branch._transport
 
1753
 
 
1754
    _transport = property(_get_real_transport)
 
1755
 
 
1756
    def __str__(self):
 
1757
        return "%s(%s)" % (self.__class__.__name__, self.base)
 
1758
 
 
1759
    __repr__ = __str__
 
1760
 
 
1761
    def _ensure_real(self):
 
1762
        """Ensure that there is a _real_branch set.
 
1763
 
 
1764
        Used before calls to self._real_branch.
 
1765
        """
 
1766
        if self._real_branch is None:
 
1767
            if not vfs.vfs_enabled():
 
1768
                raise AssertionError('smart server vfs must be enabled '
 
1769
                    'to use vfs implementation')
 
1770
            self.bzrdir._ensure_real()
 
1771
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
 
1772
            if self.repository._real_repository is None:
 
1773
                # Give the remote repository the matching real repo.
 
1774
                real_repo = self._real_branch.repository
 
1775
                if isinstance(real_repo, RemoteRepository):
 
1776
                    real_repo._ensure_real()
 
1777
                    real_repo = real_repo._real_repository
 
1778
                self.repository._set_real_repository(real_repo)
 
1779
            # Give the real branch the remote repository to let fast-pathing
 
1780
            # happen.
 
1781
            self._real_branch.repository = self.repository
 
1782
            if self._lock_mode == 'r':
 
1783
                self._real_branch.lock_read()
 
1784
            elif self._lock_mode == 'w':
 
1785
                self._real_branch.lock_write(token=self._lock_token)
 
1786
 
 
1787
    def _translate_error(self, err, **context):
 
1788
        self.repository._translate_error(err, branch=self, **context)
 
1789
 
 
1790
    def _clear_cached_state(self):
 
1791
        super(RemoteBranch, self)._clear_cached_state()
 
1792
        if self._real_branch is not None:
 
1793
            self._real_branch._clear_cached_state()
 
1794
 
 
1795
    def _clear_cached_state_of_remote_branch_only(self):
 
1796
        """Like _clear_cached_state, but doesn't clear the cache of
 
1797
        self._real_branch.
 
1798
 
 
1799
        This is useful when falling back to calling a method of
 
1800
        self._real_branch that changes state.  In that case the underlying
 
1801
        branch changes, so we need to invalidate this RemoteBranch's cache of
 
1802
        it.  However, there's no need to invalidate the _real_branch's cache
 
1803
        too, in fact doing so might harm performance.
 
1804
        """
 
1805
        super(RemoteBranch, self)._clear_cached_state()
 
1806
 
 
1807
    @property
 
1808
    def control_files(self):
 
1809
        # Defer actually creating RemoteBranchLockableFiles until its needed,
 
1810
        # because it triggers an _ensure_real that we otherwise might not need.
 
1811
        if self._control_files is None:
 
1812
            self._control_files = RemoteBranchLockableFiles(
 
1813
                self.bzrdir, self._client)
 
1814
        return self._control_files
 
1815
 
 
1816
    def _get_checkout_format(self):
 
1817
        self._ensure_real()
 
1818
        return self._real_branch._get_checkout_format()
 
1819
 
 
1820
    def get_physical_lock_status(self):
 
1821
        """See Branch.get_physical_lock_status()."""
 
1822
        # should be an API call to the server, as branches must be lockable.
 
1823
        self._ensure_real()
 
1824
        return self._real_branch.get_physical_lock_status()
 
1825
 
 
1826
    def get_stacked_on_url(self):
 
1827
        """Get the URL this branch is stacked against.
 
1828
 
 
1829
        :raises NotStacked: If the branch is not stacked.
 
1830
        :raises UnstackableBranchFormat: If the branch does not support
 
1831
            stacking.
 
1832
        :raises UnstackableRepositoryFormat: If the repository does not support
 
1833
            stacking.
 
1834
        """
 
1835
        try:
 
1836
            # there may not be a repository yet, so we can't use
 
1837
            # self._translate_error, so we can't use self._call either.
 
1838
            response = self._client.call('Branch.get_stacked_on_url',
 
1839
                self._remote_path())
 
1840
        except errors.ErrorFromSmartServer, err:
 
1841
            # there may not be a repository yet, so we can't call through
 
1842
            # its _translate_error
 
1843
            _translate_error(err, branch=self)
 
1844
        except errors.UnknownSmartMethod, err:
 
1845
            self._ensure_real()
 
1846
            return self._real_branch.get_stacked_on_url()
 
1847
        if response[0] != 'ok':
 
1848
            raise errors.UnexpectedSmartServerResponse(response)
 
1849
        return response[1]
 
1850
 
 
1851
    def lock_read(self):
 
1852
        self.repository.lock_read()
 
1853
        if not self._lock_mode:
 
1854
            self._lock_mode = 'r'
 
1855
            self._lock_count = 1
 
1856
            if self._real_branch is not None:
 
1857
                self._real_branch.lock_read()
 
1858
        else:
 
1859
            self._lock_count += 1
 
1860
 
 
1861
    def _remote_lock_write(self, token):
 
1862
        if token is None:
 
1863
            branch_token = repo_token = ''
 
1864
        else:
 
1865
            branch_token = token
 
1866
            repo_token = self.repository.lock_write()
 
1867
            self.repository.unlock()
 
1868
        err_context = {'token': token}
 
1869
        response = self._call(
 
1870
            'Branch.lock_write', self._remote_path(), branch_token,
 
1871
            repo_token or '', **err_context)
 
1872
        if response[0] != 'ok':
 
1873
            raise errors.UnexpectedSmartServerResponse(response)
 
1874
        ok, branch_token, repo_token = response
 
1875
        return branch_token, repo_token
 
1876
 
 
1877
    def lock_write(self, token=None):
 
1878
        if not self._lock_mode:
 
1879
            # Lock the branch and repo in one remote call.
 
1880
            remote_tokens = self._remote_lock_write(token)
 
1881
            self._lock_token, self._repo_lock_token = remote_tokens
 
1882
            if not self._lock_token:
 
1883
                raise SmartProtocolError('Remote server did not return a token!')
 
1884
            # Tell the self.repository object that it is locked.
 
1885
            self.repository.lock_write(
 
1886
                self._repo_lock_token, _skip_rpc=True)
 
1887
 
 
1888
            if self._real_branch is not None:
 
1889
                self._real_branch.lock_write(token=self._lock_token)
 
1890
            if token is not None:
 
1891
                self._leave_lock = True
 
1892
            else:
 
1893
                self._leave_lock = False
 
1894
            self._lock_mode = 'w'
 
1895
            self._lock_count = 1
 
1896
        elif self._lock_mode == 'r':
 
1897
            raise errors.ReadOnlyTransaction
 
1898
        else:
 
1899
            if token is not None:
 
1900
                # A token was given to lock_write, and we're relocking, so
 
1901
                # check that the given token actually matches the one we
 
1902
                # already have.
 
1903
                if token != self._lock_token:
 
1904
                    raise errors.TokenMismatch(token, self._lock_token)
 
1905
            self._lock_count += 1
 
1906
            # Re-lock the repository too.
 
1907
            self.repository.lock_write(self._repo_lock_token)
 
1908
        return self._lock_token or None
 
1909
 
 
1910
    def _unlock(self, branch_token, repo_token):
 
1911
        err_context = {'token': str((branch_token, repo_token))}
 
1912
        response = self._call(
 
1913
            'Branch.unlock', self._remote_path(), branch_token,
 
1914
            repo_token or '', **err_context)
 
1915
        if response == ('ok',):
 
1916
            return
 
1917
        raise errors.UnexpectedSmartServerResponse(response)
 
1918
 
 
1919
    def unlock(self):
 
1920
        try:
 
1921
            self._lock_count -= 1
 
1922
            if not self._lock_count:
 
1923
                self._clear_cached_state()
 
1924
                mode = self._lock_mode
 
1925
                self._lock_mode = None
 
1926
                if self._real_branch is not None:
 
1927
                    if (not self._leave_lock and mode == 'w' and
 
1928
                        self._repo_lock_token):
 
1929
                        # If this RemoteBranch will remove the physical lock
 
1930
                        # for the repository, make sure the _real_branch
 
1931
                        # doesn't do it first.  (Because the _real_branch's
 
1932
                        # repository is set to be the RemoteRepository.)
 
1933
                        self._real_branch.repository.leave_lock_in_place()
 
1934
                    self._real_branch.unlock()
 
1935
                if mode != 'w':
 
1936
                    # Only write-locked branched need to make a remote method
 
1937
                    # call to perfom the unlock.
 
1938
                    return
 
1939
                if not self._lock_token:
 
1940
                    raise AssertionError('Locked, but no token!')
 
1941
                branch_token = self._lock_token
 
1942
                repo_token = self._repo_lock_token
 
1943
                self._lock_token = None
 
1944
                self._repo_lock_token = None
 
1945
                if not self._leave_lock:
 
1946
                    self._unlock(branch_token, repo_token)
 
1947
        finally:
 
1948
            self.repository.unlock()
 
1949
 
 
1950
    def break_lock(self):
 
1951
        self._ensure_real()
 
1952
        return self._real_branch.break_lock()
 
1953
 
 
1954
    def leave_lock_in_place(self):
 
1955
        if not self._lock_token:
 
1956
            raise NotImplementedError(self.leave_lock_in_place)
 
1957
        self._leave_lock = True
 
1958
 
 
1959
    def dont_leave_lock_in_place(self):
 
1960
        if not self._lock_token:
 
1961
            raise NotImplementedError(self.dont_leave_lock_in_place)
 
1962
        self._leave_lock = False
 
1963
 
 
1964
    def _last_revision_info(self):
 
1965
        response = self._call('Branch.last_revision_info', self._remote_path())
 
1966
        if response[0] != 'ok':
 
1967
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
1968
        revno = int(response[1])
 
1969
        last_revision = response[2]
 
1970
        return (revno, last_revision)
 
1971
 
 
1972
    def _gen_revision_history(self):
 
1973
        """See Branch._gen_revision_history()."""
 
1974
        response_tuple, response_handler = self._call_expecting_body(
 
1975
            'Branch.revision_history', self._remote_path())
 
1976
        if response_tuple[0] != 'ok':
 
1977
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
1978
        result = response_handler.read_body_bytes().split('\x00')
 
1979
        if result == ['']:
 
1980
            return []
 
1981
        return result
 
1982
 
 
1983
    def _remote_path(self):
 
1984
        return self.bzrdir._path_for_remote_call(self._client)
 
1985
 
 
1986
    def _set_last_revision_descendant(self, revision_id, other_branch,
 
1987
            allow_diverged=False, allow_overwrite_descendant=False):
 
1988
        # This performs additional work to meet the hook contract; while its
 
1989
        # undesirable, we have to synthesise the revno to call the hook, and
 
1990
        # not calling the hook is worse as it means changes can't be prevented.
 
1991
        # Having calculated this though, we can't just call into
 
1992
        # set_last_revision_info as a simple call, because there is a set_rh
 
1993
        # hook that some folk may still be using.
 
1994
        old_revno, old_revid = self.last_revision_info()
 
1995
        history = self._lefthand_history(revision_id)
 
1996
        self._run_pre_change_branch_tip_hooks(len(history), revision_id)
 
1997
        err_context = {'other_branch': other_branch}
 
1998
        response = self._call('Branch.set_last_revision_ex',
 
1999
            self._remote_path(), self._lock_token, self._repo_lock_token,
 
2000
            revision_id, int(allow_diverged), int(allow_overwrite_descendant),
 
2001
            **err_context)
 
2002
        self._clear_cached_state()
 
2003
        if len(response) != 3 and response[0] != 'ok':
 
2004
            raise errors.UnexpectedSmartServerResponse(response)
 
2005
        new_revno, new_revision_id = response[1:]
 
2006
        self._last_revision_info_cache = new_revno, new_revision_id
 
2007
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2008
        if self._real_branch is not None:
 
2009
            cache = new_revno, new_revision_id
 
2010
            self._real_branch._last_revision_info_cache = cache
 
2011
 
 
2012
    def _set_last_revision(self, revision_id):
 
2013
        old_revno, old_revid = self.last_revision_info()
 
2014
        # This performs additional work to meet the hook contract; while its
 
2015
        # undesirable, we have to synthesise the revno to call the hook, and
 
2016
        # not calling the hook is worse as it means changes can't be prevented.
 
2017
        # Having calculated this though, we can't just call into
 
2018
        # set_last_revision_info as a simple call, because there is a set_rh
 
2019
        # hook that some folk may still be using.
 
2020
        history = self._lefthand_history(revision_id)
 
2021
        self._run_pre_change_branch_tip_hooks(len(history), revision_id)
 
2022
        self._clear_cached_state()
 
2023
        response = self._call('Branch.set_last_revision',
 
2024
            self._remote_path(), self._lock_token, self._repo_lock_token,
 
2025
            revision_id)
 
2026
        if response != ('ok',):
 
2027
            raise errors.UnexpectedSmartServerResponse(response)
 
2028
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2029
 
 
2030
    @needs_write_lock
 
2031
    def set_revision_history(self, rev_history):
 
2032
        # Send just the tip revision of the history; the server will generate
 
2033
        # the full history from that.  If the revision doesn't exist in this
 
2034
        # branch, NoSuchRevision will be raised.
 
2035
        if rev_history == []:
 
2036
            rev_id = 'null:'
 
2037
        else:
 
2038
            rev_id = rev_history[-1]
 
2039
        self._set_last_revision(rev_id)
 
2040
        for hook in branch.Branch.hooks['set_rh']:
 
2041
            hook(self, rev_history)
 
2042
        self._cache_revision_history(rev_history)
 
2043
 
 
2044
    def _get_parent_location(self):
 
2045
        medium = self._client._medium
 
2046
        if medium._is_remote_before((1, 13)):
 
2047
            return self._vfs_get_parent_location()
 
2048
        try:
 
2049
            response = self._call('Branch.get_parent', self._remote_path())
 
2050
        except errors.UnknownSmartMethod:
 
2051
            return self._vfs_get_parent_location()
 
2052
        if len(response) != 1:
 
2053
            raise errors.UnexpectedSmartServerResponse(response)
 
2054
        parent_location = response[0]
 
2055
        if parent_location == '':
 
2056
            return None
 
2057
        return parent_location
 
2058
 
 
2059
    def _vfs_get_parent_location(self):
 
2060
        self._ensure_real()
 
2061
        return self._real_branch._get_parent_location()
 
2062
 
 
2063
    def set_parent(self, url):
 
2064
        self._ensure_real()
 
2065
        return self._real_branch.set_parent(url)
 
2066
 
 
2067
    def _set_parent_location(self, url):
 
2068
        # Used by tests, to poke bad urls into branch configurations
 
2069
        if url is None:
 
2070
            self.set_parent(url)
 
2071
        else:
 
2072
            self._ensure_real()
 
2073
            return self._real_branch._set_parent_location(url)
 
2074
 
 
2075
    def set_stacked_on_url(self, stacked_location):
 
2076
        """Set the URL this branch is stacked against.
 
2077
 
 
2078
        :raises UnstackableBranchFormat: If the branch does not support
 
2079
            stacking.
 
2080
        :raises UnstackableRepositoryFormat: If the repository does not support
 
2081
            stacking.
 
2082
        """
 
2083
        self._ensure_real()
 
2084
        return self._real_branch.set_stacked_on_url(stacked_location)
 
2085
 
 
2086
    @needs_write_lock
 
2087
    def pull(self, source, overwrite=False, stop_revision=None,
 
2088
             **kwargs):
 
2089
        self._clear_cached_state_of_remote_branch_only()
 
2090
        self._ensure_real()
 
2091
        return self._real_branch.pull(
 
2092
            source, overwrite=overwrite, stop_revision=stop_revision,
 
2093
            _override_hook_target=self, **kwargs)
 
2094
 
 
2095
    @needs_read_lock
 
2096
    def push(self, target, overwrite=False, stop_revision=None):
 
2097
        self._ensure_real()
 
2098
        return self._real_branch.push(
 
2099
            target, overwrite=overwrite, stop_revision=stop_revision,
 
2100
            _override_hook_source_branch=self)
 
2101
 
 
2102
    def is_locked(self):
 
2103
        return self._lock_count >= 1
 
2104
 
 
2105
    @needs_read_lock
 
2106
    def revision_id_to_revno(self, revision_id):
 
2107
        self._ensure_real()
 
2108
        return self._real_branch.revision_id_to_revno(revision_id)
 
2109
 
 
2110
    @needs_write_lock
 
2111
    def set_last_revision_info(self, revno, revision_id):
 
2112
        # XXX: These should be returned by the set_last_revision_info verb
 
2113
        old_revno, old_revid = self.last_revision_info()
 
2114
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2115
        revision_id = ensure_null(revision_id)
 
2116
        try:
 
2117
            response = self._call('Branch.set_last_revision_info',
 
2118
                self._remote_path(), self._lock_token, self._repo_lock_token,
 
2119
                str(revno), revision_id)
 
2120
        except errors.UnknownSmartMethod:
 
2121
            self._ensure_real()
 
2122
            self._clear_cached_state_of_remote_branch_only()
 
2123
            self._real_branch.set_last_revision_info(revno, revision_id)
 
2124
            self._last_revision_info_cache = revno, revision_id
 
2125
            return
 
2126
        if response == ('ok',):
 
2127
            self._clear_cached_state()
 
2128
            self._last_revision_info_cache = revno, revision_id
 
2129
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2130
            # Update the _real_branch's cache too.
 
2131
            if self._real_branch is not None:
 
2132
                cache = self._last_revision_info_cache
 
2133
                self._real_branch._last_revision_info_cache = cache
 
2134
        else:
 
2135
            raise errors.UnexpectedSmartServerResponse(response)
 
2136
 
 
2137
    @needs_write_lock
 
2138
    def generate_revision_history(self, revision_id, last_rev=None,
 
2139
                                  other_branch=None):
 
2140
        medium = self._client._medium
 
2141
        if not medium._is_remote_before((1, 6)):
 
2142
            # Use a smart method for 1.6 and above servers
 
2143
            try:
 
2144
                self._set_last_revision_descendant(revision_id, other_branch,
 
2145
                    allow_diverged=True, allow_overwrite_descendant=True)
 
2146
                return
 
2147
            except errors.UnknownSmartMethod:
 
2148
                medium._remember_remote_is_before((1, 6))
 
2149
        self._clear_cached_state_of_remote_branch_only()
 
2150
        self.set_revision_history(self._lefthand_history(revision_id,
 
2151
            last_rev=last_rev,other_branch=other_branch))
 
2152
 
 
2153
    @property
 
2154
    def tags(self):
 
2155
        self._ensure_real()
 
2156
        return self._real_branch.tags
 
2157
 
 
2158
    def set_push_location(self, location):
 
2159
        self._ensure_real()
 
2160
        return self._real_branch.set_push_location(location)
 
2161
 
 
2162
 
 
2163
def _extract_tar(tar, to_dir):
 
2164
    """Extract all the contents of a tarfile object.
 
2165
 
 
2166
    A replacement for extractall, which is not present in python2.4
 
2167
    """
 
2168
    for tarinfo in tar:
 
2169
        tar.extract(tarinfo, to_dir)
 
2170
 
 
2171
 
 
2172
def _translate_error(err, **context):
 
2173
    """Translate an ErrorFromSmartServer into a more useful error.
 
2174
 
 
2175
    Possible context keys:
 
2176
      - branch
 
2177
      - repository
 
2178
      - bzrdir
 
2179
      - token
 
2180
      - other_branch
 
2181
      - path
 
2182
 
 
2183
    If the error from the server doesn't match a known pattern, then
 
2184
    UnknownErrorFromSmartServer is raised.
 
2185
    """
 
2186
    def find(name):
 
2187
        try:
 
2188
            return context[name]
 
2189
        except KeyError, key_err:
 
2190
            mutter('Missing key %r in context %r', key_err.args[0], context)
 
2191
            raise err
 
2192
    def get_path():
 
2193
        """Get the path from the context if present, otherwise use first error
 
2194
        arg.
 
2195
        """
 
2196
        try:
 
2197
            return context['path']
 
2198
        except KeyError, key_err:
 
2199
            try:
 
2200
                return err.error_args[0]
 
2201
            except IndexError, idx_err:
 
2202
                mutter(
 
2203
                    'Missing key %r in context %r', key_err.args[0], context)
 
2204
                raise err
 
2205
 
 
2206
    if err.error_verb == 'NoSuchRevision':
 
2207
        raise NoSuchRevision(find('branch'), err.error_args[0])
 
2208
    elif err.error_verb == 'nosuchrevision':
 
2209
        raise NoSuchRevision(find('repository'), err.error_args[0])
 
2210
    elif err.error_tuple == ('nobranch',):
 
2211
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
 
2212
    elif err.error_verb == 'norepository':
 
2213
        raise errors.NoRepositoryPresent(find('bzrdir'))
 
2214
    elif err.error_verb == 'LockContention':
 
2215
        raise errors.LockContention('(remote lock)')
 
2216
    elif err.error_verb == 'UnlockableTransport':
 
2217
        raise errors.UnlockableTransport(find('bzrdir').root_transport)
 
2218
    elif err.error_verb == 'LockFailed':
 
2219
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
 
2220
    elif err.error_verb == 'TokenMismatch':
 
2221
        raise errors.TokenMismatch(find('token'), '(remote token)')
 
2222
    elif err.error_verb == 'Diverged':
 
2223
        raise errors.DivergedBranches(find('branch'), find('other_branch'))
 
2224
    elif err.error_verb == 'TipChangeRejected':
 
2225
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
 
2226
    elif err.error_verb == 'UnstackableBranchFormat':
 
2227
        raise errors.UnstackableBranchFormat(*err.error_args)
 
2228
    elif err.error_verb == 'UnstackableRepositoryFormat':
 
2229
        raise errors.UnstackableRepositoryFormat(*err.error_args)
 
2230
    elif err.error_verb == 'NotStacked':
 
2231
        raise errors.NotStacked(branch=find('branch'))
 
2232
    elif err.error_verb == 'PermissionDenied':
 
2233
        path = get_path()
 
2234
        if len(err.error_args) >= 2:
 
2235
            extra = err.error_args[1]
 
2236
        else:
 
2237
            extra = None
 
2238
        raise errors.PermissionDenied(path, extra=extra)
 
2239
    elif err.error_verb == 'ReadError':
 
2240
        path = get_path()
 
2241
        raise errors.ReadError(path)
 
2242
    elif err.error_verb == 'NoSuchFile':
 
2243
        path = get_path()
 
2244
        raise errors.NoSuchFile(path)
 
2245
    elif err.error_verb == 'FileExists':
 
2246
        raise errors.FileExists(err.error_args[0])
 
2247
    elif err.error_verb == 'DirectoryNotEmpty':
 
2248
        raise errors.DirectoryNotEmpty(err.error_args[0])
 
2249
    elif err.error_verb == 'ShortReadvError':
 
2250
        args = err.error_args
 
2251
        raise errors.ShortReadvError(
 
2252
            args[0], int(args[1]), int(args[2]), int(args[3]))
 
2253
    elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
 
2254
        encoding = str(err.error_args[0]) # encoding must always be a string
 
2255
        val = err.error_args[1]
 
2256
        start = int(err.error_args[2])
 
2257
        end = int(err.error_args[3])
 
2258
        reason = str(err.error_args[4]) # reason must always be a string
 
2259
        if val.startswith('u:'):
 
2260
            val = val[2:].decode('utf-8')
 
2261
        elif val.startswith('s:'):
 
2262
            val = val[2:].decode('base64')
 
2263
        if err.error_verb == 'UnicodeDecodeError':
 
2264
            raise UnicodeDecodeError(encoding, val, start, end, reason)
 
2265
        elif err.error_verb == 'UnicodeEncodeError':
 
2266
            raise UnicodeEncodeError(encoding, val, start, end, reason)
 
2267
    elif err.error_verb == 'ReadOnlyError':
 
2268
        raise errors.TransportNotPossible('readonly transport')
 
2269
    raise errors.UnknownErrorFromSmartServer(err)