/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 11:26:37 UTC
  • mto: (4086.1.2 hpss-integration)
  • mto: This revision was merged to the branch mainline in revision 4087.
  • Revision ID: andrew.bennetts@canonical.com-20090306112637-y9oou60zuxu9c60h
Don't use PendingAncestrySearch when creating a stacked branch.

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
            fetch_spec=None):
 
1061
        if fetch_spec is not None and revision_id is not None:
 
1062
            raise AssertionError(
 
1063
                "fetch_spec and revision_id are mutually exclusive.")
 
1064
        # Not delegated to _real_repository so that InterRepository.get has a
 
1065
        # chance to find an InterRepository specialised for RemoteRepository.
 
1066
        if self.has_same_location(source) and fetch_spec is None:
 
1067
            # check that last_revision is in 'from' and then return a
 
1068
            # no-operation.
 
1069
            if (revision_id is not None and
 
1070
                not revision.is_null(revision_id)):
 
1071
                self.get_revision(revision_id)
 
1072
            return 0, []
 
1073
        inter = repository.InterRepository.get(source, self)
 
1074
        try:
 
1075
            return inter.fetch(revision_id=revision_id, pb=pb,
 
1076
                    find_ghosts=find_ghosts, fetch_spec=fetch_spec)
 
1077
        except NotImplementedError:
 
1078
            raise errors.IncompatibleRepositories(source, self)
 
1079
 
 
1080
    def create_bundle(self, target, base, fileobj, format=None):
 
1081
        self._ensure_real()
 
1082
        self._real_repository.create_bundle(target, base, fileobj, format)
 
1083
 
 
1084
    @needs_read_lock
 
1085
    def get_ancestry(self, revision_id, topo_sorted=True):
 
1086
        self._ensure_real()
 
1087
        return self._real_repository.get_ancestry(revision_id, topo_sorted)
 
1088
 
 
1089
    def fileids_altered_by_revision_ids(self, revision_ids):
 
1090
        self._ensure_real()
 
1091
        return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
 
1092
 
 
1093
    def _get_versioned_file_checker(self, revisions, revision_versions_cache):
 
1094
        self._ensure_real()
 
1095
        return self._real_repository._get_versioned_file_checker(
 
1096
            revisions, revision_versions_cache)
 
1097
 
 
1098
    def iter_files_bytes(self, desired_files):
 
1099
        """See Repository.iter_file_bytes.
 
1100
        """
 
1101
        self._ensure_real()
 
1102
        return self._real_repository.iter_files_bytes(desired_files)
 
1103
 
 
1104
    def get_parent_map(self, revision_ids):
 
1105
        """See bzrlib.Graph.get_parent_map()."""
 
1106
        return self._make_parents_provider().get_parent_map(revision_ids)
 
1107
 
 
1108
    def _get_parent_map_rpc(self, keys):
 
1109
        """Helper for get_parent_map that performs the RPC."""
 
1110
        medium = self._client._medium
 
1111
        if medium._is_remote_before((1, 2)):
 
1112
            # We already found out that the server can't understand
 
1113
            # Repository.get_parent_map requests, so just fetch the whole
 
1114
            # graph.
 
1115
            # XXX: Note that this will issue a deprecation warning. This is ok
 
1116
            # :- its because we're working with a deprecated server anyway, and
 
1117
            # the user will almost certainly have seen a warning about the
 
1118
            # server version already.
 
1119
            rg = self.get_revision_graph()
 
1120
            # There is an api discrepency between get_parent_map and
 
1121
            # get_revision_graph. Specifically, a "key:()" pair in
 
1122
            # get_revision_graph just means a node has no parents. For
 
1123
            # "get_parent_map" it means the node is a ghost. So fix up the
 
1124
            # graph to correct this.
 
1125
            #   https://bugs.launchpad.net/bzr/+bug/214894
 
1126
            # There is one other "bug" which is that ghosts in
 
1127
            # get_revision_graph() are not returned at all. But we won't worry
 
1128
            # about that for now.
 
1129
            for node_id, parent_ids in rg.iteritems():
 
1130
                if parent_ids == ():
 
1131
                    rg[node_id] = (NULL_REVISION,)
 
1132
            rg[NULL_REVISION] = ()
 
1133
            return rg
 
1134
 
 
1135
        keys = set(keys)
 
1136
        if None in keys:
 
1137
            raise ValueError('get_parent_map(None) is not valid')
 
1138
        if NULL_REVISION in keys:
 
1139
            keys.discard(NULL_REVISION)
 
1140
            found_parents = {NULL_REVISION:()}
 
1141
            if not keys:
 
1142
                return found_parents
 
1143
        else:
 
1144
            found_parents = {}
 
1145
        # TODO(Needs analysis): We could assume that the keys being requested
 
1146
        # from get_parent_map are in a breadth first search, so typically they
 
1147
        # will all be depth N from some common parent, and we don't have to
 
1148
        # have the server iterate from the root parent, but rather from the
 
1149
        # keys we're searching; and just tell the server the keyspace we
 
1150
        # already have; but this may be more traffic again.
 
1151
 
 
1152
        # Transform self._parents_map into a search request recipe.
 
1153
        # TODO: Manage this incrementally to avoid covering the same path
 
1154
        # repeatedly. (The server will have to on each request, but the less
 
1155
        # work done the better).
 
1156
        parents_map = self._unstacked_provider.get_cached_map()
 
1157
        if parents_map is None:
 
1158
            # Repository is not locked, so there's no cache.
 
1159
            parents_map = {}
 
1160
        start_set = set(parents_map)
 
1161
        result_parents = set()
 
1162
        for parents in parents_map.itervalues():
 
1163
            result_parents.update(parents)
 
1164
        stop_keys = result_parents.difference(start_set)
 
1165
        included_keys = start_set.intersection(result_parents)
 
1166
        start_set.difference_update(included_keys)
 
1167
        recipe = (start_set, stop_keys, len(parents_map))
 
1168
        body = self._serialise_search_recipe(recipe)
 
1169
        path = self.bzrdir._path_for_remote_call(self._client)
 
1170
        for key in keys:
 
1171
            if type(key) is not str:
 
1172
                raise ValueError(
 
1173
                    "key %r not a plain string" % (key,))
 
1174
        verb = 'Repository.get_parent_map'
 
1175
        args = (path,) + tuple(keys)
 
1176
        try:
 
1177
            response = self._call_with_body_bytes_expecting_body(
 
1178
                verb, args, body)
 
1179
        except errors.UnknownSmartMethod:
 
1180
            # Server does not support this method, so get the whole graph.
 
1181
            # Worse, we have to force a disconnection, because the server now
 
1182
            # doesn't realise it has a body on the wire to consume, so the
 
1183
            # only way to recover is to abandon the connection.
 
1184
            warning(
 
1185
                'Server is too old for fast get_parent_map, reconnecting.  '
 
1186
                '(Upgrade the server to Bazaar 1.2 to avoid this)')
 
1187
            medium.disconnect()
 
1188
            # To avoid having to disconnect repeatedly, we keep track of the
 
1189
            # fact the server doesn't understand remote methods added in 1.2.
 
1190
            medium._remember_remote_is_before((1, 2))
 
1191
            return self.get_revision_graph(None)
 
1192
        response_tuple, response_handler = response
 
1193
        if response_tuple[0] not in ['ok']:
 
1194
            response_handler.cancel_read_body()
 
1195
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
1196
        if response_tuple[0] == 'ok':
 
1197
            coded = bz2.decompress(response_handler.read_body_bytes())
 
1198
            if coded == '':
 
1199
                # no revisions found
 
1200
                return {}
 
1201
            lines = coded.split('\n')
 
1202
            revision_graph = {}
 
1203
            for line in lines:
 
1204
                d = tuple(line.split())
 
1205
                if len(d) > 1:
 
1206
                    revision_graph[d[0]] = d[1:]
 
1207
                else:
 
1208
                    # No parents - so give the Graph result (NULL_REVISION,).
 
1209
                    revision_graph[d[0]] = (NULL_REVISION,)
 
1210
            return revision_graph
 
1211
 
 
1212
    @needs_read_lock
 
1213
    def get_signature_text(self, revision_id):
 
1214
        self._ensure_real()
 
1215
        return self._real_repository.get_signature_text(revision_id)
 
1216
 
 
1217
    @needs_read_lock
 
1218
    @symbol_versioning.deprecated_method(symbol_versioning.one_three)
 
1219
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
1220
        self._ensure_real()
 
1221
        return self._real_repository.get_revision_graph_with_ghosts(
 
1222
            revision_ids=revision_ids)
 
1223
 
 
1224
    @needs_read_lock
 
1225
    def get_inventory_xml(self, revision_id):
 
1226
        self._ensure_real()
 
1227
        return self._real_repository.get_inventory_xml(revision_id)
 
1228
 
 
1229
    def deserialise_inventory(self, revision_id, xml):
 
1230
        self._ensure_real()
 
1231
        return self._real_repository.deserialise_inventory(revision_id, xml)
 
1232
 
 
1233
    def reconcile(self, other=None, thorough=False):
 
1234
        self._ensure_real()
 
1235
        return self._real_repository.reconcile(other=other, thorough=thorough)
 
1236
 
 
1237
    def all_revision_ids(self):
 
1238
        self._ensure_real()
 
1239
        return self._real_repository.all_revision_ids()
 
1240
 
 
1241
    @needs_read_lock
 
1242
    def get_deltas_for_revisions(self, revisions):
 
1243
        self._ensure_real()
 
1244
        return self._real_repository.get_deltas_for_revisions(revisions)
 
1245
 
 
1246
    @needs_read_lock
 
1247
    def get_revision_delta(self, revision_id):
 
1248
        self._ensure_real()
 
1249
        return self._real_repository.get_revision_delta(revision_id)
 
1250
 
 
1251
    @needs_read_lock
 
1252
    def revision_trees(self, revision_ids):
 
1253
        self._ensure_real()
 
1254
        return self._real_repository.revision_trees(revision_ids)
 
1255
 
 
1256
    @needs_read_lock
 
1257
    def get_revision_reconcile(self, revision_id):
 
1258
        self._ensure_real()
 
1259
        return self._real_repository.get_revision_reconcile(revision_id)
 
1260
 
 
1261
    @needs_read_lock
 
1262
    def check(self, revision_ids=None):
 
1263
        self._ensure_real()
 
1264
        return self._real_repository.check(revision_ids=revision_ids)
 
1265
 
 
1266
    def copy_content_into(self, destination, revision_id=None):
 
1267
        self._ensure_real()
 
1268
        return self._real_repository.copy_content_into(
 
1269
            destination, revision_id=revision_id)
 
1270
 
 
1271
    def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
 
1272
        # get a tarball of the remote repository, and copy from that into the
 
1273
        # destination
 
1274
        from bzrlib import osutils
 
1275
        import tarfile
 
1276
        # TODO: Maybe a progress bar while streaming the tarball?
 
1277
        note("Copying repository content as tarball...")
 
1278
        tar_file = self._get_tarball('bz2')
 
1279
        if tar_file is None:
 
1280
            return None
 
1281
        destination = to_bzrdir.create_repository()
 
1282
        try:
 
1283
            tar = tarfile.open('repository', fileobj=tar_file,
 
1284
                mode='r|bz2')
 
1285
            tmpdir = osutils.mkdtemp()
 
1286
            try:
 
1287
                _extract_tar(tar, tmpdir)
 
1288
                tmp_bzrdir = BzrDir.open(tmpdir)
 
1289
                tmp_repo = tmp_bzrdir.open_repository()
 
1290
                tmp_repo.copy_content_into(destination, revision_id)
 
1291
            finally:
 
1292
                osutils.rmtree(tmpdir)
 
1293
        finally:
 
1294
            tar_file.close()
 
1295
        return destination
 
1296
        # TODO: Suggestion from john: using external tar is much faster than
 
1297
        # python's tarfile library, but it may not work on windows.
 
1298
 
 
1299
    @property
 
1300
    def inventories(self):
 
1301
        """Decorate the real repository for now.
 
1302
 
 
1303
        In the long term a full blown network facility is needed to
 
1304
        avoid creating a real repository object locally.
 
1305
        """
 
1306
        self._ensure_real()
 
1307
        return self._real_repository.inventories
 
1308
 
 
1309
    @needs_write_lock
 
1310
    def pack(self):
 
1311
        """Compress the data within the repository.
 
1312
 
 
1313
        This is not currently implemented within the smart server.
 
1314
        """
 
1315
        self._ensure_real()
 
1316
        return self._real_repository.pack()
 
1317
 
 
1318
    @property
 
1319
    def revisions(self):
 
1320
        """Decorate the real repository for now.
 
1321
 
 
1322
        In the short term this should become a real object to intercept graph
 
1323
        lookups.
 
1324
 
 
1325
        In the long term a full blown network facility is needed.
 
1326
        """
 
1327
        self._ensure_real()
 
1328
        return self._real_repository.revisions
 
1329
 
 
1330
    def set_make_working_trees(self, new_value):
 
1331
        if new_value:
 
1332
            new_value_str = "True"
 
1333
        else:
 
1334
            new_value_str = "False"
 
1335
        path = self.bzrdir._path_for_remote_call(self._client)
 
1336
        try:
 
1337
            response = self._call(
 
1338
                'Repository.set_make_working_trees', path, new_value_str)
 
1339
        except errors.UnknownSmartMethod:
 
1340
            self._ensure_real()
 
1341
            self._real_repository.set_make_working_trees(new_value)
 
1342
        else:
 
1343
            if response[0] != 'ok':
 
1344
                raise errors.UnexpectedSmartServerResponse(response)
 
1345
 
 
1346
    @property
 
1347
    def signatures(self):
 
1348
        """Decorate the real repository for now.
 
1349
 
 
1350
        In the long term a full blown network facility is needed to avoid
 
1351
        creating a real repository object locally.
 
1352
        """
 
1353
        self._ensure_real()
 
1354
        return self._real_repository.signatures
 
1355
 
 
1356
    @needs_write_lock
 
1357
    def sign_revision(self, revision_id, gpg_strategy):
 
1358
        self._ensure_real()
 
1359
        return self._real_repository.sign_revision(revision_id, gpg_strategy)
 
1360
 
 
1361
    @property
 
1362
    def texts(self):
 
1363
        """Decorate the real repository for now.
 
1364
 
 
1365
        In the long term a full blown network facility is needed to avoid
 
1366
        creating a real repository object locally.
 
1367
        """
 
1368
        self._ensure_real()
 
1369
        return self._real_repository.texts
 
1370
 
 
1371
    @needs_read_lock
 
1372
    def get_revisions(self, revision_ids):
 
1373
        self._ensure_real()
 
1374
        return self._real_repository.get_revisions(revision_ids)
 
1375
 
 
1376
    def supports_rich_root(self):
 
1377
        return self._format.rich_root_data
 
1378
 
 
1379
    def iter_reverse_revision_history(self, revision_id):
 
1380
        self._ensure_real()
 
1381
        return self._real_repository.iter_reverse_revision_history(revision_id)
 
1382
 
 
1383
    @property
 
1384
    def _serializer(self):
 
1385
        return self._format._serializer
 
1386
 
 
1387
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
 
1388
        self._ensure_real()
 
1389
        return self._real_repository.store_revision_signature(
 
1390
            gpg_strategy, plaintext, revision_id)
 
1391
 
 
1392
    def add_signature_text(self, revision_id, signature):
 
1393
        self._ensure_real()
 
1394
        return self._real_repository.add_signature_text(revision_id, signature)
 
1395
 
 
1396
    def has_signature_for_revision_id(self, revision_id):
 
1397
        self._ensure_real()
 
1398
        return self._real_repository.has_signature_for_revision_id(revision_id)
 
1399
 
 
1400
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
 
1401
        self._ensure_real()
 
1402
        return self._real_repository.item_keys_introduced_by(revision_ids,
 
1403
            _files_pb=_files_pb)
 
1404
 
 
1405
    def revision_graph_can_have_wrong_parents(self):
 
1406
        # The answer depends on the remote repo format.
 
1407
        self._ensure_real()
 
1408
        return self._real_repository.revision_graph_can_have_wrong_parents()
 
1409
 
 
1410
    def _find_inconsistent_revision_parents(self):
 
1411
        self._ensure_real()
 
1412
        return self._real_repository._find_inconsistent_revision_parents()
 
1413
 
 
1414
    def _check_for_inconsistent_revision_parents(self):
 
1415
        self._ensure_real()
 
1416
        return self._real_repository._check_for_inconsistent_revision_parents()
 
1417
 
 
1418
    def _make_parents_provider(self, other=None):
 
1419
        providers = [self._unstacked_provider]
 
1420
        if other is not None:
 
1421
            providers.insert(0, other)
 
1422
        providers.extend(r._make_parents_provider() for r in
 
1423
                         self._fallback_repositories)
 
1424
        return graph._StackedParentsProvider(providers)
 
1425
 
 
1426
    def _serialise_search_recipe(self, recipe):
 
1427
        """Serialise a graph search recipe.
 
1428
 
 
1429
        :param recipe: A search recipe (start, stop, count).
 
1430
        :return: Serialised bytes.
 
1431
        """
 
1432
        start_keys = ' '.join(recipe[0])
 
1433
        stop_keys = ' '.join(recipe[1])
 
1434
        count = str(recipe[2])
 
1435
        return '\n'.join((start_keys, stop_keys, count))
 
1436
 
 
1437
    def _serialise_search_result(self, search_result):
 
1438
        if isinstance(search_result, graph.PendingAncestryResult):
 
1439
            parts = ['ancestry-of']
 
1440
            parts.extend(search_result.heads)
 
1441
        else:
 
1442
            recipe = search_result.get_recipe()
 
1443
            parts = ['search', self._serialise_search_recipe(recipe)]
 
1444
        return '\n'.join(parts)
 
1445
 
 
1446
    def autopack(self):
 
1447
        path = self.bzrdir._path_for_remote_call(self._client)
 
1448
        try:
 
1449
            response = self._call('PackRepository.autopack', path)
 
1450
        except errors.UnknownSmartMethod:
 
1451
            self._ensure_real()
 
1452
            self._real_repository._pack_collection.autopack()
 
1453
            return
 
1454
        if self._real_repository is not None:
 
1455
            # Reset the real repository's cache of pack names.
 
1456
            # XXX: At some point we may be able to skip this and just rely on
 
1457
            # the automatic retry logic to do the right thing, but for now we
 
1458
            # err on the side of being correct rather than being optimal.
 
1459
            self._real_repository._pack_collection.reload_pack_names()
 
1460
        if response[0] != 'ok':
 
1461
            raise errors.UnexpectedSmartServerResponse(response)
 
1462
 
 
1463
 
 
1464
class RemoteStreamSink(repository.StreamSink):
 
1465
 
 
1466
    def _insert_real(self, stream, src_format, resume_tokens):
 
1467
        self.target_repo._ensure_real()
 
1468
        sink = self.target_repo._real_repository._get_sink()
 
1469
        result = sink.insert_stream(stream, src_format, resume_tokens)
 
1470
        if not result:
 
1471
            self.target_repo.autopack()
 
1472
        return result
 
1473
 
 
1474
    def insert_stream(self, stream, src_format, resume_tokens):
 
1475
        repo = self.target_repo
 
1476
        client = repo._client
 
1477
        medium = client._medium
 
1478
        if medium._is_remote_before((1, 13)):
 
1479
            # No possible way this can work.
 
1480
            return self._insert_real(stream, src_format, resume_tokens)
 
1481
        path = repo.bzrdir._path_for_remote_call(client)
 
1482
        if not resume_tokens:
 
1483
            # XXX: Ugly but important for correctness, *will* be fixed during
 
1484
            # 1.13 cycle. Pushing a stream that is interrupted results in a
 
1485
            # fallback to the _real_repositories sink *with a partial stream*.
 
1486
            # Thats bad because we insert less data than bzr expected. To avoid
 
1487
            # this we do a trial push to make sure the verb is accessible, and
 
1488
            # do not fallback when actually pushing the stream. A cleanup patch
 
1489
            # is going to look at rewinding/restarting the stream/partial
 
1490
            # buffering etc.
 
1491
            byte_stream = smart_repo._stream_to_byte_stream([], src_format)
 
1492
            try:
 
1493
                response = client.call_with_body_stream(
 
1494
                    ('Repository.insert_stream', path, ''), byte_stream)
 
1495
            except errors.UnknownSmartMethod:
 
1496
                medium._remember_remote_is_before((1,13))
 
1497
                return self._insert_real(stream, src_format, resume_tokens)
 
1498
        byte_stream = smart_repo._stream_to_byte_stream(
 
1499
            stream, src_format)
 
1500
        resume_tokens = ' '.join(resume_tokens)
 
1501
        response = client.call_with_body_stream(
 
1502
            ('Repository.insert_stream', path, resume_tokens), byte_stream)
 
1503
        if response[0][0] not in ('ok', 'missing-basis'):
 
1504
            raise errors.UnexpectedSmartServerResponse(response)
 
1505
        if response[0][0] == 'missing-basis':
 
1506
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
 
1507
            resume_tokens = tokens
 
1508
            return resume_tokens, missing_keys
 
1509
        else:
 
1510
            if self.target_repo._real_repository is not None:
 
1511
                collection = getattr(self.target_repo._real_repository,
 
1512
                    '_pack_collection', None)
 
1513
                if collection is not None:
 
1514
                    collection.reload_pack_names()
 
1515
            return [], set()
 
1516
 
 
1517
 
 
1518
class RemoteStreamSource(repository.StreamSource):
 
1519
    """Stream data from a remote server."""
 
1520
 
 
1521
    def get_stream(self, search):
 
1522
        # streaming with fallback repositories is not well defined yet: The
 
1523
        # remote repository cannot see the fallback repositories, and thus
 
1524
        # cannot satisfy the entire search in the general case. Likewise the
 
1525
        # fallback repositories cannot reify the search to determine what they
 
1526
        # should send. It likely needs a return value in the stream listing the
 
1527
        # edge of the search to resume from in fallback repositories.
 
1528
        if self.from_repository._fallback_repositories:
 
1529
            return repository.StreamSource.get_stream(self, search)
 
1530
        repo = self.from_repository
 
1531
        client = repo._client
 
1532
        medium = client._medium
 
1533
        if medium._is_remote_before((1, 13)):
 
1534
            # No possible way this can work.
 
1535
            return repository.StreamSource.get_stream(self, search)
 
1536
        path = repo.bzrdir._path_for_remote_call(client)
 
1537
        try:
 
1538
            search_bytes = repo._serialise_search_result(search)
 
1539
            response = repo._call_with_body_bytes_expecting_body(
 
1540
                'Repository.get_stream',
 
1541
                (path, self.to_format.network_name()), search_bytes)
 
1542
            response_tuple, response_handler = response
 
1543
        except errors.UnknownSmartMethod:
 
1544
            medium._remember_remote_is_before((1,13))
 
1545
            return repository.StreamSource.get_stream(self, search)
 
1546
        if response_tuple[0] != 'ok':
 
1547
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
1548
        byte_stream = response_handler.read_streamed_body()
 
1549
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
 
1550
        if src_format.network_name() != repo._format.network_name():
 
1551
            raise AssertionError(
 
1552
                "Mismatched RemoteRepository and stream src %r, %r" % (
 
1553
                src_format.network_name(), repo._format.network_name()))
 
1554
        return stream
 
1555
 
 
1556
 
 
1557
class RemoteBranchLockableFiles(LockableFiles):
 
1558
    """A 'LockableFiles' implementation that talks to a smart server.
 
1559
 
 
1560
    This is not a public interface class.
 
1561
    """
 
1562
 
 
1563
    def __init__(self, bzrdir, _client):
 
1564
        self.bzrdir = bzrdir
 
1565
        self._client = _client
 
1566
        self._need_find_modes = True
 
1567
        LockableFiles.__init__(
 
1568
            self, bzrdir.get_branch_transport(None),
 
1569
            'lock', lockdir.LockDir)
 
1570
 
 
1571
    def _find_modes(self):
 
1572
        # RemoteBranches don't let the client set the mode of control files.
 
1573
        self._dir_mode = None
 
1574
        self._file_mode = None
 
1575
 
 
1576
 
 
1577
class RemoteBranchFormat(branch.BranchFormat):
 
1578
 
 
1579
    def __init__(self):
 
1580
        super(RemoteBranchFormat, self).__init__()
 
1581
        self._matchingbzrdir = RemoteBzrDirFormat()
 
1582
        self._matchingbzrdir.set_branch_format(self)
 
1583
        self._custom_format = None
 
1584
 
 
1585
    def __eq__(self, other):
 
1586
        return (isinstance(other, RemoteBranchFormat) and
 
1587
            self.__dict__ == other.__dict__)
 
1588
 
 
1589
    def get_format_description(self):
 
1590
        return 'Remote BZR Branch'
 
1591
 
 
1592
    def network_name(self):
 
1593
        return self._network_name
 
1594
 
 
1595
    def open(self, a_bzrdir):
 
1596
        return a_bzrdir.open_branch()
 
1597
 
 
1598
    def _vfs_initialize(self, a_bzrdir):
 
1599
        # Initialisation when using a local bzrdir object, or a non-vfs init
 
1600
        # method is not available on the server.
 
1601
        # self._custom_format is always set - the start of initialize ensures
 
1602
        # that.
 
1603
        if isinstance(a_bzrdir, RemoteBzrDir):
 
1604
            a_bzrdir._ensure_real()
 
1605
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
 
1606
        else:
 
1607
            # We assume the bzrdir is parameterised; it may not be.
 
1608
            result = self._custom_format.initialize(a_bzrdir)
 
1609
        if (isinstance(a_bzrdir, RemoteBzrDir) and
 
1610
            not isinstance(result, RemoteBranch)):
 
1611
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
 
1612
        return result
 
1613
 
 
1614
    def initialize(self, a_bzrdir):
 
1615
        # 1) get the network name to use.
 
1616
        if self._custom_format:
 
1617
            network_name = self._custom_format.network_name()
 
1618
        else:
 
1619
            # Select the current bzrlib default and ask for that.
 
1620
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
 
1621
            reference_format = reference_bzrdir_format.get_branch_format()
 
1622
            self._custom_format = reference_format
 
1623
            network_name = reference_format.network_name()
 
1624
        # Being asked to create on a non RemoteBzrDir:
 
1625
        if not isinstance(a_bzrdir, RemoteBzrDir):
 
1626
            return self._vfs_initialize(a_bzrdir)
 
1627
        medium = a_bzrdir._client._medium
 
1628
        if medium._is_remote_before((1, 13)):
 
1629
            return self._vfs_initialize(a_bzrdir)
 
1630
        # Creating on a remote bzr dir.
 
1631
        # 2) try direct creation via RPC
 
1632
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
 
1633
        verb = 'BzrDir.create_branch'
 
1634
        try:
 
1635
            response = a_bzrdir._call(verb, path, network_name)
 
1636
        except errors.UnknownSmartMethod:
 
1637
            # Fallback - use vfs methods
 
1638
            return self._vfs_initialize(a_bzrdir)
 
1639
        if response[0] != 'ok':
 
1640
            raise errors.UnexpectedSmartServerResponse(response)
 
1641
        # Turn the response into a RemoteRepository object.
 
1642
        format = RemoteBranchFormat()
 
1643
        format._network_name = response[1]
 
1644
        repo_format = response_tuple_to_repo_format(response[3:])
 
1645
        if response[2] == '':
 
1646
            repo_bzrdir = a_bzrdir
 
1647
        else:
 
1648
            repo_bzrdir = RemoteBzrDir(
 
1649
                a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
 
1650
                a_bzrdir._client)
 
1651
        remote_repo = RemoteRepository(repo_bzrdir, repo_format)
 
1652
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
 
1653
            format=format, setup_stacking=False)
 
1654
        # XXX: We know this is a new branch, so it must have revno 0, revid
 
1655
        # NULL_REVISION. Creating the branch locked would make this be unable
 
1656
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
 
1657
        remote_branch._last_revision_info_cache = 0, NULL_REVISION
 
1658
        return remote_branch
 
1659
 
 
1660
    def supports_tags(self):
 
1661
        # Remote branches might support tags, but we won't know until we
 
1662
        # access the real remote branch.
 
1663
        return True
 
1664
 
 
1665
 
 
1666
class RemoteBranch(branch.Branch, _RpcHelper):
 
1667
    """Branch stored on a server accessed by HPSS RPC.
 
1668
 
 
1669
    At the moment most operations are mapped down to simple file operations.
 
1670
    """
 
1671
 
 
1672
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
 
1673
        _client=None, format=None, setup_stacking=True):
 
1674
        """Create a RemoteBranch instance.
 
1675
 
 
1676
        :param real_branch: An optional local implementation of the branch
 
1677
            format, usually accessing the data via the VFS.
 
1678
        :param _client: Private parameter for testing.
 
1679
        :param format: A RemoteBranchFormat object, None to create one
 
1680
            automatically. If supplied it should have a network_name already
 
1681
            supplied.
 
1682
        :param setup_stacking: If True make an RPC call to determine the
 
1683
            stacked (or not) status of the branch. If False assume the branch
 
1684
            is not stacked.
 
1685
        """
 
1686
        # We intentionally don't call the parent class's __init__, because it
 
1687
        # will try to assign to self.tags, which is a property in this subclass.
 
1688
        # And the parent's __init__ doesn't do much anyway.
 
1689
        self._revision_id_to_revno_cache = None
 
1690
        self._partial_revision_id_to_revno_cache = {}
 
1691
        self._revision_history_cache = None
 
1692
        self._last_revision_info_cache = None
 
1693
        self._merge_sorted_revisions_cache = None
 
1694
        self.bzrdir = remote_bzrdir
 
1695
        if _client is not None:
 
1696
            self._client = _client
 
1697
        else:
 
1698
            self._client = remote_bzrdir._client
 
1699
        self.repository = remote_repository
 
1700
        if real_branch is not None:
 
1701
            self._real_branch = real_branch
 
1702
            # Give the remote repository the matching real repo.
 
1703
            real_repo = self._real_branch.repository
 
1704
            if isinstance(real_repo, RemoteRepository):
 
1705
                real_repo._ensure_real()
 
1706
                real_repo = real_repo._real_repository
 
1707
            self.repository._set_real_repository(real_repo)
 
1708
            # Give the branch the remote repository to let fast-pathing happen.
 
1709
            self._real_branch.repository = self.repository
 
1710
        else:
 
1711
            self._real_branch = None
 
1712
        # Fill out expected attributes of branch for bzrlib api users.
 
1713
        self.base = self.bzrdir.root_transport.base
 
1714
        self._control_files = None
 
1715
        self._lock_mode = None
 
1716
        self._lock_token = None
 
1717
        self._repo_lock_token = None
 
1718
        self._lock_count = 0
 
1719
        self._leave_lock = False
 
1720
        # Setup a format: note that we cannot call _ensure_real until all the
 
1721
        # attributes above are set: This code cannot be moved higher up in this
 
1722
        # function.
 
1723
        if format is None:
 
1724
            self._format = RemoteBranchFormat()
 
1725
            if real_branch is not None:
 
1726
                self._format._network_name = \
 
1727
                    self._real_branch._format.network_name()
 
1728
            #else:
 
1729
            #    # XXX: Need to get this from BzrDir.open_branch's return value.
 
1730
            #    self._ensure_real()
 
1731
            #    self._format._network_name = \
 
1732
            #        self._real_branch._format.network_name()
 
1733
        else:
 
1734
            self._format = format
 
1735
        # The base class init is not called, so we duplicate this:
 
1736
        hooks = branch.Branch.hooks['open']
 
1737
        for hook in hooks:
 
1738
            hook(self)
 
1739
        if setup_stacking:
 
1740
            self._setup_stacking()
 
1741
 
 
1742
    def _setup_stacking(self):
 
1743
        # configure stacking into the remote repository, by reading it from
 
1744
        # the vfs branch.
 
1745
        try:
 
1746
            fallback_url = self.get_stacked_on_url()
 
1747
        except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1748
            errors.UnstackableRepositoryFormat), e:
 
1749
            return
 
1750
        # it's relative to this branch...
 
1751
        fallback_url = urlutils.join(self.base, fallback_url)
 
1752
        transports = [self.bzrdir.root_transport]
 
1753
        if self._real_branch is not None:
 
1754
            # The real repository is setup already:
 
1755
            transports.append(self._real_branch._transport)
 
1756
            self.repository.add_fallback_repository(
 
1757
                self.repository._real_repository._fallback_repositories[0])
 
1758
        else:
 
1759
            stacked_on = branch.Branch.open(fallback_url,
 
1760
                                            possible_transports=transports)
 
1761
            self.repository.add_fallback_repository(stacked_on.repository)
 
1762
 
 
1763
    def _get_real_transport(self):
 
1764
        # if we try vfs access, return the real branch's vfs transport
 
1765
        self._ensure_real()
 
1766
        return self._real_branch._transport
 
1767
 
 
1768
    _transport = property(_get_real_transport)
 
1769
 
 
1770
    def __str__(self):
 
1771
        return "%s(%s)" % (self.__class__.__name__, self.base)
 
1772
 
 
1773
    __repr__ = __str__
 
1774
 
 
1775
    def _ensure_real(self):
 
1776
        """Ensure that there is a _real_branch set.
 
1777
 
 
1778
        Used before calls to self._real_branch.
 
1779
        """
 
1780
        if self._real_branch is None:
 
1781
            if not vfs.vfs_enabled():
 
1782
                raise AssertionError('smart server vfs must be enabled '
 
1783
                    'to use vfs implementation')
 
1784
            self.bzrdir._ensure_real()
 
1785
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
 
1786
            if self.repository._real_repository is None:
 
1787
                # Give the remote repository the matching real repo.
 
1788
                real_repo = self._real_branch.repository
 
1789
                if isinstance(real_repo, RemoteRepository):
 
1790
                    real_repo._ensure_real()
 
1791
                    real_repo = real_repo._real_repository
 
1792
                self.repository._set_real_repository(real_repo)
 
1793
            # Give the real branch the remote repository to let fast-pathing
 
1794
            # happen.
 
1795
            self._real_branch.repository = self.repository
 
1796
            if self._lock_mode == 'r':
 
1797
                self._real_branch.lock_read()
 
1798
            elif self._lock_mode == 'w':
 
1799
                self._real_branch.lock_write(token=self._lock_token)
 
1800
 
 
1801
    def _translate_error(self, err, **context):
 
1802
        self.repository._translate_error(err, branch=self, **context)
 
1803
 
 
1804
    def _clear_cached_state(self):
 
1805
        super(RemoteBranch, self)._clear_cached_state()
 
1806
        if self._real_branch is not None:
 
1807
            self._real_branch._clear_cached_state()
 
1808
 
 
1809
    def _clear_cached_state_of_remote_branch_only(self):
 
1810
        """Like _clear_cached_state, but doesn't clear the cache of
 
1811
        self._real_branch.
 
1812
 
 
1813
        This is useful when falling back to calling a method of
 
1814
        self._real_branch that changes state.  In that case the underlying
 
1815
        branch changes, so we need to invalidate this RemoteBranch's cache of
 
1816
        it.  However, there's no need to invalidate the _real_branch's cache
 
1817
        too, in fact doing so might harm performance.
 
1818
        """
 
1819
        super(RemoteBranch, self)._clear_cached_state()
 
1820
 
 
1821
    @property
 
1822
    def control_files(self):
 
1823
        # Defer actually creating RemoteBranchLockableFiles until its needed,
 
1824
        # because it triggers an _ensure_real that we otherwise might not need.
 
1825
        if self._control_files is None:
 
1826
            self._control_files = RemoteBranchLockableFiles(
 
1827
                self.bzrdir, self._client)
 
1828
        return self._control_files
 
1829
 
 
1830
    def _get_checkout_format(self):
 
1831
        self._ensure_real()
 
1832
        return self._real_branch._get_checkout_format()
 
1833
 
 
1834
    def get_physical_lock_status(self):
 
1835
        """See Branch.get_physical_lock_status()."""
 
1836
        # should be an API call to the server, as branches must be lockable.
 
1837
        self._ensure_real()
 
1838
        return self._real_branch.get_physical_lock_status()
 
1839
 
 
1840
    def get_stacked_on_url(self):
 
1841
        """Get the URL this branch is stacked against.
 
1842
 
 
1843
        :raises NotStacked: If the branch is not stacked.
 
1844
        :raises UnstackableBranchFormat: If the branch does not support
 
1845
            stacking.
 
1846
        :raises UnstackableRepositoryFormat: If the repository does not support
 
1847
            stacking.
 
1848
        """
 
1849
        try:
 
1850
            # there may not be a repository yet, so we can't use
 
1851
            # self._translate_error, so we can't use self._call either.
 
1852
            response = self._client.call('Branch.get_stacked_on_url',
 
1853
                self._remote_path())
 
1854
        except errors.ErrorFromSmartServer, err:
 
1855
            # there may not be a repository yet, so we can't call through
 
1856
            # its _translate_error
 
1857
            _translate_error(err, branch=self)
 
1858
        except errors.UnknownSmartMethod, err:
 
1859
            self._ensure_real()
 
1860
            return self._real_branch.get_stacked_on_url()
 
1861
        if response[0] != 'ok':
 
1862
            raise errors.UnexpectedSmartServerResponse(response)
 
1863
        return response[1]
 
1864
 
 
1865
    def lock_read(self):
 
1866
        self.repository.lock_read()
 
1867
        if not self._lock_mode:
 
1868
            self._lock_mode = 'r'
 
1869
            self._lock_count = 1
 
1870
            if self._real_branch is not None:
 
1871
                self._real_branch.lock_read()
 
1872
        else:
 
1873
            self._lock_count += 1
 
1874
 
 
1875
    def _remote_lock_write(self, token):
 
1876
        if token is None:
 
1877
            branch_token = repo_token = ''
 
1878
        else:
 
1879
            branch_token = token
 
1880
            repo_token = self.repository.lock_write()
 
1881
            self.repository.unlock()
 
1882
        err_context = {'token': token}
 
1883
        response = self._call(
 
1884
            'Branch.lock_write', self._remote_path(), branch_token,
 
1885
            repo_token or '', **err_context)
 
1886
        if response[0] != 'ok':
 
1887
            raise errors.UnexpectedSmartServerResponse(response)
 
1888
        ok, branch_token, repo_token = response
 
1889
        return branch_token, repo_token
 
1890
 
 
1891
    def lock_write(self, token=None):
 
1892
        if not self._lock_mode:
 
1893
            # Lock the branch and repo in one remote call.
 
1894
            remote_tokens = self._remote_lock_write(token)
 
1895
            self._lock_token, self._repo_lock_token = remote_tokens
 
1896
            if not self._lock_token:
 
1897
                raise SmartProtocolError('Remote server did not return a token!')
 
1898
            # Tell the self.repository object that it is locked.
 
1899
            self.repository.lock_write(
 
1900
                self._repo_lock_token, _skip_rpc=True)
 
1901
 
 
1902
            if self._real_branch is not None:
 
1903
                self._real_branch.lock_write(token=self._lock_token)
 
1904
            if token is not None:
 
1905
                self._leave_lock = True
 
1906
            else:
 
1907
                self._leave_lock = False
 
1908
            self._lock_mode = 'w'
 
1909
            self._lock_count = 1
 
1910
        elif self._lock_mode == 'r':
 
1911
            raise errors.ReadOnlyTransaction
 
1912
        else:
 
1913
            if token is not None:
 
1914
                # A token was given to lock_write, and we're relocking, so
 
1915
                # check that the given token actually matches the one we
 
1916
                # already have.
 
1917
                if token != self._lock_token:
 
1918
                    raise errors.TokenMismatch(token, self._lock_token)
 
1919
            self._lock_count += 1
 
1920
            # Re-lock the repository too.
 
1921
            self.repository.lock_write(self._repo_lock_token)
 
1922
        return self._lock_token or None
 
1923
 
 
1924
    def _unlock(self, branch_token, repo_token):
 
1925
        err_context = {'token': str((branch_token, repo_token))}
 
1926
        response = self._call(
 
1927
            'Branch.unlock', self._remote_path(), branch_token,
 
1928
            repo_token or '', **err_context)
 
1929
        if response == ('ok',):
 
1930
            return
 
1931
        raise errors.UnexpectedSmartServerResponse(response)
 
1932
 
 
1933
    def unlock(self):
 
1934
        try:
 
1935
            self._lock_count -= 1
 
1936
            if not self._lock_count:
 
1937
                self._clear_cached_state()
 
1938
                mode = self._lock_mode
 
1939
                self._lock_mode = None
 
1940
                if self._real_branch is not None:
 
1941
                    if (not self._leave_lock and mode == 'w' and
 
1942
                        self._repo_lock_token):
 
1943
                        # If this RemoteBranch will remove the physical lock
 
1944
                        # for the repository, make sure the _real_branch
 
1945
                        # doesn't do it first.  (Because the _real_branch's
 
1946
                        # repository is set to be the RemoteRepository.)
 
1947
                        self._real_branch.repository.leave_lock_in_place()
 
1948
                    self._real_branch.unlock()
 
1949
                if mode != 'w':
 
1950
                    # Only write-locked branched need to make a remote method
 
1951
                    # call to perfom the unlock.
 
1952
                    return
 
1953
                if not self._lock_token:
 
1954
                    raise AssertionError('Locked, but no token!')
 
1955
                branch_token = self._lock_token
 
1956
                repo_token = self._repo_lock_token
 
1957
                self._lock_token = None
 
1958
                self._repo_lock_token = None
 
1959
                if not self._leave_lock:
 
1960
                    self._unlock(branch_token, repo_token)
 
1961
        finally:
 
1962
            self.repository.unlock()
 
1963
 
 
1964
    def break_lock(self):
 
1965
        self._ensure_real()
 
1966
        return self._real_branch.break_lock()
 
1967
 
 
1968
    def leave_lock_in_place(self):
 
1969
        if not self._lock_token:
 
1970
            raise NotImplementedError(self.leave_lock_in_place)
 
1971
        self._leave_lock = True
 
1972
 
 
1973
    def dont_leave_lock_in_place(self):
 
1974
        if not self._lock_token:
 
1975
            raise NotImplementedError(self.dont_leave_lock_in_place)
 
1976
        self._leave_lock = False
 
1977
 
 
1978
    def _last_revision_info(self):
 
1979
        response = self._call('Branch.last_revision_info', self._remote_path())
 
1980
        if response[0] != 'ok':
 
1981
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
1982
        revno = int(response[1])
 
1983
        last_revision = response[2]
 
1984
        return (revno, last_revision)
 
1985
 
 
1986
    def _gen_revision_history(self):
 
1987
        """See Branch._gen_revision_history()."""
 
1988
        response_tuple, response_handler = self._call_expecting_body(
 
1989
            'Branch.revision_history', self._remote_path())
 
1990
        if response_tuple[0] != 'ok':
 
1991
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
1992
        result = response_handler.read_body_bytes().split('\x00')
 
1993
        if result == ['']:
 
1994
            return []
 
1995
        return result
 
1996
 
 
1997
    def _remote_path(self):
 
1998
        return self.bzrdir._path_for_remote_call(self._client)
 
1999
 
 
2000
    def _set_last_revision_descendant(self, revision_id, other_branch,
 
2001
            allow_diverged=False, allow_overwrite_descendant=False):
 
2002
        # This performs additional work to meet the hook contract; while its
 
2003
        # undesirable, we have to synthesise the revno to call the hook, and
 
2004
        # not calling the hook is worse as it means changes can't be prevented.
 
2005
        # Having calculated this though, we can't just call into
 
2006
        # set_last_revision_info as a simple call, because there is a set_rh
 
2007
        # hook that some folk may still be using.
 
2008
        old_revno, old_revid = self.last_revision_info()
 
2009
        history = self._lefthand_history(revision_id)
 
2010
        self._run_pre_change_branch_tip_hooks(len(history), revision_id)
 
2011
        err_context = {'other_branch': other_branch}
 
2012
        response = self._call('Branch.set_last_revision_ex',
 
2013
            self._remote_path(), self._lock_token, self._repo_lock_token,
 
2014
            revision_id, int(allow_diverged), int(allow_overwrite_descendant),
 
2015
            **err_context)
 
2016
        self._clear_cached_state()
 
2017
        if len(response) != 3 and response[0] != 'ok':
 
2018
            raise errors.UnexpectedSmartServerResponse(response)
 
2019
        new_revno, new_revision_id = response[1:]
 
2020
        self._last_revision_info_cache = new_revno, new_revision_id
 
2021
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2022
        if self._real_branch is not None:
 
2023
            cache = new_revno, new_revision_id
 
2024
            self._real_branch._last_revision_info_cache = cache
 
2025
 
 
2026
    def _set_last_revision(self, revision_id):
 
2027
        old_revno, old_revid = self.last_revision_info()
 
2028
        # This performs additional work to meet the hook contract; while its
 
2029
        # undesirable, we have to synthesise the revno to call the hook, and
 
2030
        # not calling the hook is worse as it means changes can't be prevented.
 
2031
        # Having calculated this though, we can't just call into
 
2032
        # set_last_revision_info as a simple call, because there is a set_rh
 
2033
        # hook that some folk may still be using.
 
2034
        history = self._lefthand_history(revision_id)
 
2035
        self._run_pre_change_branch_tip_hooks(len(history), revision_id)
 
2036
        self._clear_cached_state()
 
2037
        response = self._call('Branch.set_last_revision',
 
2038
            self._remote_path(), self._lock_token, self._repo_lock_token,
 
2039
            revision_id)
 
2040
        if response != ('ok',):
 
2041
            raise errors.UnexpectedSmartServerResponse(response)
 
2042
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2043
 
 
2044
    @needs_write_lock
 
2045
    def set_revision_history(self, rev_history):
 
2046
        # Send just the tip revision of the history; the server will generate
 
2047
        # the full history from that.  If the revision doesn't exist in this
 
2048
        # branch, NoSuchRevision will be raised.
 
2049
        if rev_history == []:
 
2050
            rev_id = 'null:'
 
2051
        else:
 
2052
            rev_id = rev_history[-1]
 
2053
        self._set_last_revision(rev_id)
 
2054
        for hook in branch.Branch.hooks['set_rh']:
 
2055
            hook(self, rev_history)
 
2056
        self._cache_revision_history(rev_history)
 
2057
 
 
2058
    def _get_parent_location(self):
 
2059
        medium = self._client._medium
 
2060
        if medium._is_remote_before((1, 13)):
 
2061
            return self._vfs_get_parent_location()
 
2062
        try:
 
2063
            response = self._call('Branch.get_parent', self._remote_path())
 
2064
        except errors.UnknownSmartMethod:
 
2065
            return self._vfs_get_parent_location()
 
2066
        if len(response) != 1:
 
2067
            raise errors.UnexpectedSmartServerResponse(response)
 
2068
        parent_location = response[0]
 
2069
        if parent_location == '':
 
2070
            return None
 
2071
        return parent_location
 
2072
 
 
2073
    def _vfs_get_parent_location(self):
 
2074
        self._ensure_real()
 
2075
        return self._real_branch._get_parent_location()
 
2076
 
 
2077
    def set_parent(self, url):
 
2078
        self._ensure_real()
 
2079
        return self._real_branch.set_parent(url)
 
2080
 
 
2081
    def _set_parent_location(self, url):
 
2082
        # Used by tests, to poke bad urls into branch configurations
 
2083
        if url is None:
 
2084
            self.set_parent(url)
 
2085
        else:
 
2086
            self._ensure_real()
 
2087
            return self._real_branch._set_parent_location(url)
 
2088
 
 
2089
    def set_stacked_on_url(self, stacked_location):
 
2090
        """Set the URL this branch is stacked against.
 
2091
 
 
2092
        :raises UnstackableBranchFormat: If the branch does not support
 
2093
            stacking.
 
2094
        :raises UnstackableRepositoryFormat: If the repository does not support
 
2095
            stacking.
 
2096
        """
 
2097
        self._ensure_real()
 
2098
        return self._real_branch.set_stacked_on_url(stacked_location)
 
2099
 
 
2100
    @needs_write_lock
 
2101
    def pull(self, source, overwrite=False, stop_revision=None,
 
2102
             **kwargs):
 
2103
        self._clear_cached_state_of_remote_branch_only()
 
2104
        self._ensure_real()
 
2105
        return self._real_branch.pull(
 
2106
            source, overwrite=overwrite, stop_revision=stop_revision,
 
2107
            _override_hook_target=self, **kwargs)
 
2108
 
 
2109
    @needs_read_lock
 
2110
    def push(self, target, overwrite=False, stop_revision=None):
 
2111
        self._ensure_real()
 
2112
        return self._real_branch.push(
 
2113
            target, overwrite=overwrite, stop_revision=stop_revision,
 
2114
            _override_hook_source_branch=self)
 
2115
 
 
2116
    def is_locked(self):
 
2117
        return self._lock_count >= 1
 
2118
 
 
2119
    @needs_read_lock
 
2120
    def revision_id_to_revno(self, revision_id):
 
2121
        self._ensure_real()
 
2122
        return self._real_branch.revision_id_to_revno(revision_id)
 
2123
 
 
2124
    @needs_write_lock
 
2125
    def set_last_revision_info(self, revno, revision_id):
 
2126
        # XXX: These should be returned by the set_last_revision_info verb
 
2127
        old_revno, old_revid = self.last_revision_info()
 
2128
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2129
        revision_id = ensure_null(revision_id)
 
2130
        try:
 
2131
            response = self._call('Branch.set_last_revision_info',
 
2132
                self._remote_path(), self._lock_token, self._repo_lock_token,
 
2133
                str(revno), revision_id)
 
2134
        except errors.UnknownSmartMethod:
 
2135
            self._ensure_real()
 
2136
            self._clear_cached_state_of_remote_branch_only()
 
2137
            self._real_branch.set_last_revision_info(revno, revision_id)
 
2138
            self._last_revision_info_cache = revno, revision_id
 
2139
            return
 
2140
        if response == ('ok',):
 
2141
            self._clear_cached_state()
 
2142
            self._last_revision_info_cache = revno, revision_id
 
2143
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2144
            # Update the _real_branch's cache too.
 
2145
            if self._real_branch is not None:
 
2146
                cache = self._last_revision_info_cache
 
2147
                self._real_branch._last_revision_info_cache = cache
 
2148
        else:
 
2149
            raise errors.UnexpectedSmartServerResponse(response)
 
2150
 
 
2151
    @needs_write_lock
 
2152
    def generate_revision_history(self, revision_id, last_rev=None,
 
2153
                                  other_branch=None):
 
2154
        medium = self._client._medium
 
2155
        if not medium._is_remote_before((1, 6)):
 
2156
            # Use a smart method for 1.6 and above servers
 
2157
            try:
 
2158
                self._set_last_revision_descendant(revision_id, other_branch,
 
2159
                    allow_diverged=True, allow_overwrite_descendant=True)
 
2160
                return
 
2161
            except errors.UnknownSmartMethod:
 
2162
                medium._remember_remote_is_before((1, 6))
 
2163
        self._clear_cached_state_of_remote_branch_only()
 
2164
        self.set_revision_history(self._lefthand_history(revision_id,
 
2165
            last_rev=last_rev,other_branch=other_branch))
 
2166
 
 
2167
    @property
 
2168
    def tags(self):
 
2169
        self._ensure_real()
 
2170
        return self._real_branch.tags
 
2171
 
 
2172
    def set_push_location(self, location):
 
2173
        self._ensure_real()
 
2174
        return self._real_branch.set_push_location(location)
 
2175
 
 
2176
 
 
2177
def _extract_tar(tar, to_dir):
 
2178
    """Extract all the contents of a tarfile object.
 
2179
 
 
2180
    A replacement for extractall, which is not present in python2.4
 
2181
    """
 
2182
    for tarinfo in tar:
 
2183
        tar.extract(tarinfo, to_dir)
 
2184
 
 
2185
 
 
2186
def _translate_error(err, **context):
 
2187
    """Translate an ErrorFromSmartServer into a more useful error.
 
2188
 
 
2189
    Possible context keys:
 
2190
      - branch
 
2191
      - repository
 
2192
      - bzrdir
 
2193
      - token
 
2194
      - other_branch
 
2195
      - path
 
2196
 
 
2197
    If the error from the server doesn't match a known pattern, then
 
2198
    UnknownErrorFromSmartServer is raised.
 
2199
    """
 
2200
    def find(name):
 
2201
        try:
 
2202
            return context[name]
 
2203
        except KeyError, key_err:
 
2204
            mutter('Missing key %r in context %r', key_err.args[0], context)
 
2205
            raise err
 
2206
    def get_path():
 
2207
        """Get the path from the context if present, otherwise use first error
 
2208
        arg.
 
2209
        """
 
2210
        try:
 
2211
            return context['path']
 
2212
        except KeyError, key_err:
 
2213
            try:
 
2214
                return err.error_args[0]
 
2215
            except IndexError, idx_err:
 
2216
                mutter(
 
2217
                    'Missing key %r in context %r', key_err.args[0], context)
 
2218
                raise err
 
2219
 
 
2220
    if err.error_verb == 'NoSuchRevision':
 
2221
        raise NoSuchRevision(find('branch'), err.error_args[0])
 
2222
    elif err.error_verb == 'nosuchrevision':
 
2223
        raise NoSuchRevision(find('repository'), err.error_args[0])
 
2224
    elif err.error_tuple == ('nobranch',):
 
2225
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
 
2226
    elif err.error_verb == 'norepository':
 
2227
        raise errors.NoRepositoryPresent(find('bzrdir'))
 
2228
    elif err.error_verb == 'LockContention':
 
2229
        raise errors.LockContention('(remote lock)')
 
2230
    elif err.error_verb == 'UnlockableTransport':
 
2231
        raise errors.UnlockableTransport(find('bzrdir').root_transport)
 
2232
    elif err.error_verb == 'LockFailed':
 
2233
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
 
2234
    elif err.error_verb == 'TokenMismatch':
 
2235
        raise errors.TokenMismatch(find('token'), '(remote token)')
 
2236
    elif err.error_verb == 'Diverged':
 
2237
        raise errors.DivergedBranches(find('branch'), find('other_branch'))
 
2238
    elif err.error_verb == 'TipChangeRejected':
 
2239
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
 
2240
    elif err.error_verb == 'UnstackableBranchFormat':
 
2241
        raise errors.UnstackableBranchFormat(*err.error_args)
 
2242
    elif err.error_verb == 'UnstackableRepositoryFormat':
 
2243
        raise errors.UnstackableRepositoryFormat(*err.error_args)
 
2244
    elif err.error_verb == 'NotStacked':
 
2245
        raise errors.NotStacked(branch=find('branch'))
 
2246
    elif err.error_verb == 'PermissionDenied':
 
2247
        path = get_path()
 
2248
        if len(err.error_args) >= 2:
 
2249
            extra = err.error_args[1]
 
2250
        else:
 
2251
            extra = None
 
2252
        raise errors.PermissionDenied(path, extra=extra)
 
2253
    elif err.error_verb == 'ReadError':
 
2254
        path = get_path()
 
2255
        raise errors.ReadError(path)
 
2256
    elif err.error_verb == 'NoSuchFile':
 
2257
        path = get_path()
 
2258
        raise errors.NoSuchFile(path)
 
2259
    elif err.error_verb == 'FileExists':
 
2260
        raise errors.FileExists(err.error_args[0])
 
2261
    elif err.error_verb == 'DirectoryNotEmpty':
 
2262
        raise errors.DirectoryNotEmpty(err.error_args[0])
 
2263
    elif err.error_verb == 'ShortReadvError':
 
2264
        args = err.error_args
 
2265
        raise errors.ShortReadvError(
 
2266
            args[0], int(args[1]), int(args[2]), int(args[3]))
 
2267
    elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
 
2268
        encoding = str(err.error_args[0]) # encoding must always be a string
 
2269
        val = err.error_args[1]
 
2270
        start = int(err.error_args[2])
 
2271
        end = int(err.error_args[3])
 
2272
        reason = str(err.error_args[4]) # reason must always be a string
 
2273
        if val.startswith('u:'):
 
2274
            val = val[2:].decode('utf-8')
 
2275
        elif val.startswith('s:'):
 
2276
            val = val[2:].decode('base64')
 
2277
        if err.error_verb == 'UnicodeDecodeError':
 
2278
            raise UnicodeDecodeError(encoding, val, start, end, reason)
 
2279
        elif err.error_verb == 'UnicodeEncodeError':
 
2280
            raise UnicodeEncodeError(encoding, val, start, end, reason)
 
2281
    elif err.error_verb == 'ReadOnlyError':
 
2282
        raise errors.TransportNotPossible('readonly transport')
 
2283
    raise errors.UnknownErrorFromSmartServer(err)