/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: Vincent Ladeuil
  • Date: 2008-09-11 19:36:38 UTC
  • mfrom: (3703 +trunk)
  • mto: (3705.1.1 trunk2)
  • mto: This revision was merged to the branch mainline in revision 3708.
  • Revision ID: v.ladeuil+lp@free.fr-20080911193638-wtjyc1kcmacc6t1f
merge bzr.dev

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
    debug,
 
25
    errors,
 
26
    graph,
 
27
    lockdir,
 
28
    repository,
 
29
    revision,
 
30
    symbol_versioning,
 
31
)
 
32
from bzrlib.branch import BranchReferenceFormat
 
33
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
 
34
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
35
from bzrlib.errors import (
 
36
    NoSuchRevision,
 
37
    SmartProtocolError,
 
38
    )
 
39
from bzrlib.lockable_files import LockableFiles
 
40
from bzrlib.smart import client, vfs
 
41
from bzrlib.revision import ensure_null, NULL_REVISION
 
42
from bzrlib.trace import mutter, note, warning
 
43
 
 
44
 
 
45
# Note: RemoteBzrDirFormat is in bzrdir.py
 
46
 
 
47
class RemoteBzrDir(BzrDir):
 
48
    """Control directory on a remote server, accessed via bzr:// or similar."""
 
49
 
 
50
    def __init__(self, transport, _client=None):
 
51
        """Construct a RemoteBzrDir.
 
52
 
 
53
        :param _client: Private parameter for testing. Disables probing and the
 
54
            use of a real bzrdir.
 
55
        """
 
56
        BzrDir.__init__(self, transport, RemoteBzrDirFormat())
 
57
        # this object holds a delegated bzrdir that uses file-level operations
 
58
        # to talk to the other side
 
59
        self._real_bzrdir = None
 
60
 
 
61
        if _client is None:
 
62
            medium = transport.get_smart_medium()
 
63
            self._client = client._SmartClient(medium)
 
64
        else:
 
65
            self._client = _client
 
66
            return
 
67
 
 
68
        path = self._path_for_remote_call(self._client)
 
69
        response = self._client.call('BzrDir.open', path)
 
70
        if response not in [('yes',), ('no',)]:
 
71
            raise errors.UnexpectedSmartServerResponse(response)
 
72
        if response == ('no',):
 
73
            raise errors.NotBranchError(path=transport.base)
 
74
 
 
75
    def _ensure_real(self):
 
76
        """Ensure that there is a _real_bzrdir set.
 
77
 
 
78
        Used before calls to self._real_bzrdir.
 
79
        """
 
80
        if not self._real_bzrdir:
 
81
            self._real_bzrdir = BzrDir.open_from_transport(
 
82
                self.root_transport, _server_formats=False)
 
83
 
 
84
    def cloning_metadir(self, stacked=False):
 
85
        self._ensure_real()
 
86
        return self._real_bzrdir.cloning_metadir(stacked)
 
87
 
 
88
    def _translate_error(self, err, **context):
 
89
        _translate_error(err, bzrdir=self, **context)
 
90
        
 
91
    def create_repository(self, shared=False):
 
92
        self._ensure_real()
 
93
        self._real_bzrdir.create_repository(shared=shared)
 
94
        return self.open_repository()
 
95
 
 
96
    def destroy_repository(self):
 
97
        """See BzrDir.destroy_repository"""
 
98
        self._ensure_real()
 
99
        self._real_bzrdir.destroy_repository()
 
100
 
 
101
    def create_branch(self):
 
102
        self._ensure_real()
 
103
        real_branch = self._real_bzrdir.create_branch()
 
104
        return RemoteBranch(self, self.find_repository(), real_branch)
 
105
 
 
106
    def destroy_branch(self):
 
107
        """See BzrDir.destroy_branch"""
 
108
        self._ensure_real()
 
109
        self._real_bzrdir.destroy_branch()
 
110
 
 
111
    def create_workingtree(self, revision_id=None, from_branch=None):
 
112
        raise errors.NotLocalUrl(self.transport.base)
 
113
 
 
114
    def find_branch_format(self):
 
115
        """Find the branch 'format' for this bzrdir.
 
116
 
 
117
        This might be a synthetic object for e.g. RemoteBranch and SVN.
 
118
        """
 
119
        b = self.open_branch()
 
120
        return b._format
 
121
 
 
122
    def get_branch_reference(self):
 
123
        """See BzrDir.get_branch_reference()."""
 
124
        path = self._path_for_remote_call(self._client)
 
125
        try:
 
126
            response = self._client.call('BzrDir.open_branch', path)
 
127
        except errors.ErrorFromSmartServer, err:
 
128
            self._translate_error(err)
 
129
        if response[0] == 'ok':
 
130
            if response[1] == '':
 
131
                # branch at this location.
 
132
                return None
 
133
            else:
 
134
                # a branch reference, use the existing BranchReference logic.
 
135
                return response[1]
 
136
        else:
 
137
            raise errors.UnexpectedSmartServerResponse(response)
 
138
 
 
139
    def _get_tree_branch(self):
 
140
        """See BzrDir._get_tree_branch()."""
 
141
        return None, self.open_branch()
 
142
 
 
143
    def open_branch(self, _unsupported=False):
 
144
        if _unsupported:
 
145
            raise NotImplementedError('unsupported flag support not implemented yet.')
 
146
        reference_url = self.get_branch_reference()
 
147
        if reference_url is None:
 
148
            # branch at this location.
 
149
            return RemoteBranch(self, self.find_repository())
 
150
        else:
 
151
            # a branch reference, use the existing BranchReference logic.
 
152
            format = BranchReferenceFormat()
 
153
            return format.open(self, _found=True, location=reference_url)
 
154
                
 
155
    def open_repository(self):
 
156
        path = self._path_for_remote_call(self._client)
 
157
        verb = 'BzrDir.find_repositoryV2'
 
158
        try:
 
159
            try:
 
160
                response = self._client.call(verb, path)
 
161
            except errors.UnknownSmartMethod:
 
162
                verb = 'BzrDir.find_repository'
 
163
                response = self._client.call(verb, path)
 
164
        except errors.ErrorFromSmartServer, err:
 
165
            self._translate_error(err)
 
166
        if response[0] != 'ok':
 
167
            raise errors.UnexpectedSmartServerResponse(response)
 
168
        if verb == 'BzrDir.find_repository':
 
169
            # servers that don't support the V2 method don't support external
 
170
            # references either.
 
171
            response = response + ('no', )
 
172
        if not (len(response) == 5):
 
173
            raise SmartProtocolError('incorrect response length %s' % (response,))
 
174
        if response[1] == '':
 
175
            format = RemoteRepositoryFormat()
 
176
            format.rich_root_data = (response[2] == 'yes')
 
177
            format.supports_tree_reference = (response[3] == 'yes')
 
178
            # No wire format to check this yet.
 
179
            format.supports_external_lookups = (response[4] == 'yes')
 
180
            # Used to support creating a real format instance when needed.
 
181
            format._creating_bzrdir = self
 
182
            return RemoteRepository(self, format)
 
183
        else:
 
184
            raise errors.NoRepositoryPresent(self)
 
185
 
 
186
    def open_workingtree(self, recommend_upgrade=True):
 
187
        self._ensure_real()
 
188
        if self._real_bzrdir.has_workingtree():
 
189
            raise errors.NotLocalUrl(self.root_transport)
 
190
        else:
 
191
            raise errors.NoWorkingTree(self.root_transport.base)
 
192
 
 
193
    def _path_for_remote_call(self, client):
 
194
        """Return the path to be used for this bzrdir in a remote call."""
 
195
        return client.remote_path_from_transport(self.root_transport)
 
196
 
 
197
    def get_branch_transport(self, branch_format):
 
198
        self._ensure_real()
 
199
        return self._real_bzrdir.get_branch_transport(branch_format)
 
200
 
 
201
    def get_repository_transport(self, repository_format):
 
202
        self._ensure_real()
 
203
        return self._real_bzrdir.get_repository_transport(repository_format)
 
204
 
 
205
    def get_workingtree_transport(self, workingtree_format):
 
206
        self._ensure_real()
 
207
        return self._real_bzrdir.get_workingtree_transport(workingtree_format)
 
208
 
 
209
    def can_convert_format(self):
 
210
        """Upgrading of remote bzrdirs is not supported yet."""
 
211
        return False
 
212
 
 
213
    def needs_format_conversion(self, format=None):
 
214
        """Upgrading of remote bzrdirs is not supported yet."""
 
215
        return False
 
216
 
 
217
    def clone(self, url, revision_id=None, force_new_repo=False,
 
218
              preserve_stacking=False):
 
219
        self._ensure_real()
 
220
        return self._real_bzrdir.clone(url, revision_id=revision_id,
 
221
            force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
 
222
 
 
223
    def get_config(self):
 
224
        self._ensure_real()
 
225
        return self._real_bzrdir.get_config()
 
226
 
 
227
 
 
228
class RemoteRepositoryFormat(repository.RepositoryFormat):
 
229
    """Format for repositories accessed over a _SmartClient.
 
230
 
 
231
    Instances of this repository are represented by RemoteRepository
 
232
    instances.
 
233
 
 
234
    The RemoteRepositoryFormat is parameterized during construction
 
235
    to reflect the capabilities of the real, remote format. Specifically
 
236
    the attributes rich_root_data and supports_tree_reference are set
 
237
    on a per instance basis, and are not set (and should not be) at
 
238
    the class level.
 
239
    """
 
240
 
 
241
    _matchingbzrdir = RemoteBzrDirFormat()
 
242
 
 
243
    def initialize(self, a_bzrdir, shared=False):
 
244
        if not isinstance(a_bzrdir, RemoteBzrDir):
 
245
            prior_repo = self._creating_bzrdir.open_repository()
 
246
            prior_repo._ensure_real()
 
247
            return prior_repo._real_repository._format.initialize(
 
248
                a_bzrdir, shared=shared)
 
249
        return a_bzrdir.create_repository(shared=shared)
 
250
    
 
251
    def open(self, a_bzrdir):
 
252
        if not isinstance(a_bzrdir, RemoteBzrDir):
 
253
            raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
 
254
        return a_bzrdir.open_repository()
 
255
 
 
256
    def get_format_description(self):
 
257
        return 'bzr remote repository'
 
258
 
 
259
    def __eq__(self, other):
 
260
        return self.__class__ == other.__class__
 
261
 
 
262
    def check_conversion_target(self, target_format):
 
263
        if self.rich_root_data and not target_format.rich_root_data:
 
264
            raise errors.BadConversionTarget(
 
265
                'Does not support rich root data.', target_format)
 
266
        if (self.supports_tree_reference and
 
267
            not getattr(target_format, 'supports_tree_reference', False)):
 
268
            raise errors.BadConversionTarget(
 
269
                'Does not support nested trees', target_format)
 
270
 
 
271
 
 
272
class RemoteRepository(object):
 
273
    """Repository accessed over rpc.
 
274
 
 
275
    For the moment most operations are performed using local transport-backed
 
276
    Repository objects.
 
277
    """
 
278
 
 
279
    def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
 
280
        """Create a RemoteRepository instance.
 
281
        
 
282
        :param remote_bzrdir: The bzrdir hosting this repository.
 
283
        :param format: The RemoteFormat object to use.
 
284
        :param real_repository: If not None, a local implementation of the
 
285
            repository logic for the repository, usually accessing the data
 
286
            via the VFS.
 
287
        :param _client: Private testing parameter - override the smart client
 
288
            to be used by the repository.
 
289
        """
 
290
        if real_repository:
 
291
            self._real_repository = real_repository
 
292
        else:
 
293
            self._real_repository = None
 
294
        self.bzrdir = remote_bzrdir
 
295
        if _client is None:
 
296
            self._client = remote_bzrdir._client
 
297
        else:
 
298
            self._client = _client
 
299
        self._format = format
 
300
        self._lock_mode = None
 
301
        self._lock_token = None
 
302
        self._lock_count = 0
 
303
        self._leave_lock = False
 
304
        # A cache of looked up revision parent data; reset at unlock time.
 
305
        self._parents_map = None
 
306
        if 'hpss' in debug.debug_flags:
 
307
            self._requested_parents = None
 
308
        # For tests:
 
309
        # These depend on the actual remote format, so force them off for
 
310
        # maximum compatibility. XXX: In future these should depend on the
 
311
        # remote repository instance, but this is irrelevant until we perform
 
312
        # reconcile via an RPC call.
 
313
        self._reconcile_does_inventory_gc = False
 
314
        self._reconcile_fixes_text_parents = False
 
315
        self._reconcile_backsup_inventory = False
 
316
        self.base = self.bzrdir.transport.base
 
317
        # Additional places to query for data.
 
318
        self._fallback_repositories = []
 
319
 
 
320
    def __str__(self):
 
321
        return "%s(%s)" % (self.__class__.__name__, self.base)
 
322
 
 
323
    __repr__ = __str__
 
324
 
 
325
    def abort_write_group(self):
 
326
        """Complete a write group on the decorated repository.
 
327
        
 
328
        Smart methods peform operations in a single step so this api
 
329
        is not really applicable except as a compatibility thunk
 
330
        for older plugins that don't use e.g. the CommitBuilder
 
331
        facility.
 
332
        """
 
333
        self._ensure_real()
 
334
        return self._real_repository.abort_write_group()
 
335
 
 
336
    def commit_write_group(self):
 
337
        """Complete a write group on the decorated repository.
 
338
        
 
339
        Smart methods peform operations in a single step so this api
 
340
        is not really applicable except as a compatibility thunk
 
341
        for older plugins that don't use e.g. the CommitBuilder
 
342
        facility.
 
343
        """
 
344
        self._ensure_real()
 
345
        return self._real_repository.commit_write_group()
 
346
 
 
347
    def _ensure_real(self):
 
348
        """Ensure that there is a _real_repository set.
 
349
 
 
350
        Used before calls to self._real_repository.
 
351
        """
 
352
        if self._real_repository is None:
 
353
            self.bzrdir._ensure_real()
 
354
            self._set_real_repository(
 
355
                self.bzrdir._real_bzrdir.open_repository())
 
356
 
 
357
    def _translate_error(self, err, **context):
 
358
        self.bzrdir._translate_error(err, repository=self, **context)
 
359
 
 
360
    def find_text_key_references(self):
 
361
        """Find the text key references within the repository.
 
362
 
 
363
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
 
364
        revision_ids. Each altered file-ids has the exact revision_ids that
 
365
        altered it listed explicitly.
 
366
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
 
367
            to whether they were referred to by the inventory of the
 
368
            revision_id that they contain. The inventory texts from all present
 
369
            revision ids are assessed to generate this report.
 
370
        """
 
371
        self._ensure_real()
 
372
        return self._real_repository.find_text_key_references()
 
373
 
 
374
    def _generate_text_key_index(self):
 
375
        """Generate a new text key index for the repository.
 
376
 
 
377
        This is an expensive function that will take considerable time to run.
 
378
 
 
379
        :return: A dict mapping (file_id, revision_id) tuples to a list of
 
380
            parents, also (file_id, revision_id) tuples.
 
381
        """
 
382
        self._ensure_real()
 
383
        return self._real_repository._generate_text_key_index()
 
384
 
 
385
    @symbol_versioning.deprecated_method(symbol_versioning.one_four)
 
386
    def get_revision_graph(self, revision_id=None):
 
387
        """See Repository.get_revision_graph()."""
 
388
        return self._get_revision_graph(revision_id)
 
389
 
 
390
    def _get_revision_graph(self, revision_id):
 
391
        """Private method for using with old (< 1.2) servers to fallback."""
 
392
        if revision_id is None:
 
393
            revision_id = ''
 
394
        elif revision.is_null(revision_id):
 
395
            return {}
 
396
 
 
397
        path = self.bzrdir._path_for_remote_call(self._client)
 
398
        try:
 
399
            response = self._client.call_expecting_body(
 
400
                'Repository.get_revision_graph', path, revision_id)
 
401
        except errors.ErrorFromSmartServer, err:
 
402
            self._translate_error(err)
 
403
        response_tuple, response_handler = response
 
404
        if response_tuple[0] != 'ok':
 
405
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
406
        coded = response_handler.read_body_bytes()
 
407
        if coded == '':
 
408
            # no revisions in this repository!
 
409
            return {}
 
410
        lines = coded.split('\n')
 
411
        revision_graph = {}
 
412
        for line in lines:
 
413
            d = tuple(line.split())
 
414
            revision_graph[d[0]] = d[1:]
 
415
            
 
416
        return revision_graph
 
417
 
 
418
    def has_revision(self, revision_id):
 
419
        """See Repository.has_revision()."""
 
420
        if revision_id == NULL_REVISION:
 
421
            # The null revision is always present.
 
422
            return True
 
423
        path = self.bzrdir._path_for_remote_call(self._client)
 
424
        response = self._client.call(
 
425
            'Repository.has_revision', path, revision_id)
 
426
        if response[0] not in ('yes', 'no'):
 
427
            raise errors.UnexpectedSmartServerResponse(response)
 
428
        return response[0] == 'yes'
 
429
 
 
430
    def has_revisions(self, revision_ids):
 
431
        """See Repository.has_revisions()."""
 
432
        result = set()
 
433
        for revision_id in revision_ids:
 
434
            if self.has_revision(revision_id):
 
435
                result.add(revision_id)
 
436
        return result
 
437
 
 
438
    def has_same_location(self, other):
 
439
        return (self.__class__ == other.__class__ and
 
440
                self.bzrdir.transport.base == other.bzrdir.transport.base)
 
441
        
 
442
    def get_graph(self, other_repository=None):
 
443
        """Return the graph for this repository format"""
 
444
        parents_provider = self
 
445
        if (other_repository is not None and
 
446
            other_repository.bzrdir.transport.base !=
 
447
            self.bzrdir.transport.base):
 
448
            parents_provider = graph._StackedParentsProvider(
 
449
                [parents_provider, other_repository._make_parents_provider()])
 
450
        return graph.Graph(parents_provider)
 
451
 
 
452
    def gather_stats(self, revid=None, committers=None):
 
453
        """See Repository.gather_stats()."""
 
454
        path = self.bzrdir._path_for_remote_call(self._client)
 
455
        # revid can be None to indicate no revisions, not just NULL_REVISION
 
456
        if revid is None or revision.is_null(revid):
 
457
            fmt_revid = ''
 
458
        else:
 
459
            fmt_revid = revid
 
460
        if committers is None or not committers:
 
461
            fmt_committers = 'no'
 
462
        else:
 
463
            fmt_committers = 'yes'
 
464
        response_tuple, response_handler = self._client.call_expecting_body(
 
465
            'Repository.gather_stats', path, fmt_revid, fmt_committers)
 
466
        if response_tuple[0] != 'ok':
 
467
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
468
 
 
469
        body = response_handler.read_body_bytes()
 
470
        result = {}
 
471
        for line in body.split('\n'):
 
472
            if not line:
 
473
                continue
 
474
            key, val_text = line.split(':')
 
475
            if key in ('revisions', 'size', 'committers'):
 
476
                result[key] = int(val_text)
 
477
            elif key in ('firstrev', 'latestrev'):
 
478
                values = val_text.split(' ')[1:]
 
479
                result[key] = (float(values[0]), long(values[1]))
 
480
 
 
481
        return result
 
482
 
 
483
    def find_branches(self, using=False):
 
484
        """See Repository.find_branches()."""
 
485
        # should be an API call to the server.
 
486
        self._ensure_real()
 
487
        return self._real_repository.find_branches(using=using)
 
488
 
 
489
    def get_physical_lock_status(self):
 
490
        """See Repository.get_physical_lock_status()."""
 
491
        # should be an API call to the server.
 
492
        self._ensure_real()
 
493
        return self._real_repository.get_physical_lock_status()
 
494
 
 
495
    def is_in_write_group(self):
 
496
        """Return True if there is an open write group.
 
497
 
 
498
        write groups are only applicable locally for the smart server..
 
499
        """
 
500
        if self._real_repository:
 
501
            return self._real_repository.is_in_write_group()
 
502
 
 
503
    def is_locked(self):
 
504
        return self._lock_count >= 1
 
505
 
 
506
    def is_shared(self):
 
507
        """See Repository.is_shared()."""
 
508
        path = self.bzrdir._path_for_remote_call(self._client)
 
509
        response = self._client.call('Repository.is_shared', path)
 
510
        if response[0] not in ('yes', 'no'):
 
511
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
512
        return response[0] == 'yes'
 
513
 
 
514
    def is_write_locked(self):
 
515
        return self._lock_mode == 'w'
 
516
 
 
517
    def lock_read(self):
 
518
        # wrong eventually - want a local lock cache context
 
519
        if not self._lock_mode:
 
520
            self._lock_mode = 'r'
 
521
            self._lock_count = 1
 
522
            self._parents_map = {}
 
523
            if 'hpss' in debug.debug_flags:
 
524
                self._requested_parents = set()
 
525
            if self._real_repository is not None:
 
526
                self._real_repository.lock_read()
 
527
        else:
 
528
            self._lock_count += 1
 
529
 
 
530
    def _remote_lock_write(self, token):
 
531
        path = self.bzrdir._path_for_remote_call(self._client)
 
532
        if token is None:
 
533
            token = ''
 
534
        try:
 
535
            response = self._client.call('Repository.lock_write', path, token)
 
536
        except errors.ErrorFromSmartServer, err:
 
537
            self._translate_error(err, token=token)
 
538
 
 
539
        if response[0] == 'ok':
 
540
            ok, token = response
 
541
            return token
 
542
        else:
 
543
            raise errors.UnexpectedSmartServerResponse(response)
 
544
 
 
545
    def lock_write(self, token=None, _skip_rpc=False):
 
546
        if not self._lock_mode:
 
547
            if _skip_rpc:
 
548
                if self._lock_token is not None:
 
549
                    if token != self._lock_token:
 
550
                        raise errors.TokenMismatch(token, self._lock_token)
 
551
                self._lock_token = token
 
552
            else:
 
553
                self._lock_token = self._remote_lock_write(token)
 
554
            # if self._lock_token is None, then this is something like packs or
 
555
            # svn where we don't get to lock the repo, or a weave style repository
 
556
            # where we cannot lock it over the wire and attempts to do so will
 
557
            # fail.
 
558
            if self._real_repository is not None:
 
559
                self._real_repository.lock_write(token=self._lock_token)
 
560
            if token is not None:
 
561
                self._leave_lock = True
 
562
            else:
 
563
                self._leave_lock = False
 
564
            self._lock_mode = 'w'
 
565
            self._lock_count = 1
 
566
            self._parents_map = {}
 
567
            if 'hpss' in debug.debug_flags:
 
568
                self._requested_parents = set()
 
569
        elif self._lock_mode == 'r':
 
570
            raise errors.ReadOnlyError(self)
 
571
        else:
 
572
            self._lock_count += 1
 
573
        return self._lock_token or None
 
574
 
 
575
    def leave_lock_in_place(self):
 
576
        if not self._lock_token:
 
577
            raise NotImplementedError(self.leave_lock_in_place)
 
578
        self._leave_lock = True
 
579
 
 
580
    def dont_leave_lock_in_place(self):
 
581
        if not self._lock_token:
 
582
            raise NotImplementedError(self.dont_leave_lock_in_place)
 
583
        self._leave_lock = False
 
584
 
 
585
    def _set_real_repository(self, repository):
 
586
        """Set the _real_repository for this repository.
 
587
 
 
588
        :param repository: The repository to fallback to for non-hpss
 
589
            implemented operations.
 
590
        """
 
591
        if self._real_repository is not None:
 
592
            raise AssertionError('_real_repository is already set')
 
593
        if isinstance(repository, RemoteRepository):
 
594
            raise AssertionError()
 
595
        self._real_repository = repository
 
596
        if self._lock_mode == 'w':
 
597
            # if we are already locked, the real repository must be able to
 
598
            # acquire the lock with our token.
 
599
            self._real_repository.lock_write(self._lock_token)
 
600
        elif self._lock_mode == 'r':
 
601
            self._real_repository.lock_read()
 
602
 
 
603
    def start_write_group(self):
 
604
        """Start a write group on the decorated repository.
 
605
        
 
606
        Smart methods peform operations in a single step so this api
 
607
        is not really applicable except as a compatibility thunk
 
608
        for older plugins that don't use e.g. the CommitBuilder
 
609
        facility.
 
610
        """
 
611
        self._ensure_real()
 
612
        return self._real_repository.start_write_group()
 
613
 
 
614
    def _unlock(self, token):
 
615
        path = self.bzrdir._path_for_remote_call(self._client)
 
616
        if not token:
 
617
            # with no token the remote repository is not persistently locked.
 
618
            return
 
619
        try:
 
620
            response = self._client.call('Repository.unlock', path, token)
 
621
        except errors.ErrorFromSmartServer, err:
 
622
            self._translate_error(err, token=token)
 
623
        if response == ('ok',):
 
624
            return
 
625
        else:
 
626
            raise errors.UnexpectedSmartServerResponse(response)
 
627
 
 
628
    def unlock(self):
 
629
        self._lock_count -= 1
 
630
        if self._lock_count > 0:
 
631
            return
 
632
        self._parents_map = None
 
633
        if 'hpss' in debug.debug_flags:
 
634
            self._requested_parents = None
 
635
        old_mode = self._lock_mode
 
636
        self._lock_mode = None
 
637
        try:
 
638
            # The real repository is responsible at present for raising an
 
639
            # exception if it's in an unfinished write group.  However, it
 
640
            # normally will *not* actually remove the lock from disk - that's
 
641
            # done by the server on receiving the Repository.unlock call.
 
642
            # This is just to let the _real_repository stay up to date.
 
643
            if self._real_repository is not None:
 
644
                self._real_repository.unlock()
 
645
        finally:
 
646
            # The rpc-level lock should be released even if there was a
 
647
            # problem releasing the vfs-based lock.
 
648
            if old_mode == 'w':
 
649
                # Only write-locked repositories need to make a remote method
 
650
                # call to perfom the unlock.
 
651
                old_token = self._lock_token
 
652
                self._lock_token = None
 
653
                if not self._leave_lock:
 
654
                    self._unlock(old_token)
 
655
 
 
656
    def break_lock(self):
 
657
        # should hand off to the network
 
658
        self._ensure_real()
 
659
        return self._real_repository.break_lock()
 
660
 
 
661
    def _get_tarball(self, compression):
 
662
        """Return a TemporaryFile containing a repository tarball.
 
663
        
 
664
        Returns None if the server does not support sending tarballs.
 
665
        """
 
666
        import tempfile
 
667
        path = self.bzrdir._path_for_remote_call(self._client)
 
668
        try:
 
669
            response, protocol = self._client.call_expecting_body(
 
670
                'Repository.tarball', path, compression)
 
671
        except errors.UnknownSmartMethod:
 
672
            protocol.cancel_read_body()
 
673
            return None
 
674
        if response[0] == 'ok':
 
675
            # Extract the tarball and return it
 
676
            t = tempfile.NamedTemporaryFile()
 
677
            # TODO: rpc layer should read directly into it...
 
678
            t.write(protocol.read_body_bytes())
 
679
            t.seek(0)
 
680
            return t
 
681
        raise errors.UnexpectedSmartServerResponse(response)
 
682
 
 
683
    def sprout(self, to_bzrdir, revision_id=None):
 
684
        # TODO: Option to control what format is created?
 
685
        self._ensure_real()
 
686
        dest_repo = self._real_repository._format.initialize(to_bzrdir,
 
687
                                                             shared=False)
 
688
        dest_repo.fetch(self, revision_id=revision_id)
 
689
        return dest_repo
 
690
 
 
691
    ### These methods are just thin shims to the VFS object for now.
 
692
 
 
693
    def revision_tree(self, revision_id):
 
694
        self._ensure_real()
 
695
        return self._real_repository.revision_tree(revision_id)
 
696
 
 
697
    def get_serializer_format(self):
 
698
        self._ensure_real()
 
699
        return self._real_repository.get_serializer_format()
 
700
 
 
701
    def get_commit_builder(self, branch, parents, config, timestamp=None,
 
702
                           timezone=None, committer=None, revprops=None,
 
703
                           revision_id=None):
 
704
        # FIXME: It ought to be possible to call this without immediately
 
705
        # triggering _ensure_real.  For now it's the easiest thing to do.
 
706
        self._ensure_real()
 
707
        real_repo = self._real_repository
 
708
        builder = real_repo.get_commit_builder(branch, parents,
 
709
                config, timestamp=timestamp, timezone=timezone,
 
710
                committer=committer, revprops=revprops, revision_id=revision_id)
 
711
        return builder
 
712
 
 
713
    def add_fallback_repository(self, repository):
 
714
        """Add a repository to use for looking up data not held locally.
 
715
        
 
716
        :param repository: A repository.
 
717
        """
 
718
        if not self._format.supports_external_lookups:
 
719
            raise errors.UnstackableRepositoryFormat(self._format, self.base)
 
720
        # We need to accumulate additional repositories here, to pass them in
 
721
        # on various RPC's.
 
722
        self._fallback_repositories.append(repository)
 
723
 
 
724
    def add_inventory(self, revid, inv, parents):
 
725
        self._ensure_real()
 
726
        return self._real_repository.add_inventory(revid, inv, parents)
 
727
 
 
728
    def add_revision(self, rev_id, rev, inv=None, config=None):
 
729
        self._ensure_real()
 
730
        return self._real_repository.add_revision(
 
731
            rev_id, rev, inv=inv, config=config)
 
732
 
 
733
    @needs_read_lock
 
734
    def get_inventory(self, revision_id):
 
735
        self._ensure_real()
 
736
        return self._real_repository.get_inventory(revision_id)
 
737
 
 
738
    def iter_inventories(self, revision_ids):
 
739
        self._ensure_real()
 
740
        return self._real_repository.iter_inventories(revision_ids)
 
741
 
 
742
    @needs_read_lock
 
743
    def get_revision(self, revision_id):
 
744
        self._ensure_real()
 
745
        return self._real_repository.get_revision(revision_id)
 
746
 
 
747
    def get_transaction(self):
 
748
        self._ensure_real()
 
749
        return self._real_repository.get_transaction()
 
750
 
 
751
    @needs_read_lock
 
752
    def clone(self, a_bzrdir, revision_id=None):
 
753
        self._ensure_real()
 
754
        return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
 
755
 
 
756
    def make_working_trees(self):
 
757
        """See Repository.make_working_trees"""
 
758
        self._ensure_real()
 
759
        return self._real_repository.make_working_trees()
 
760
 
 
761
    def revision_ids_to_search_result(self, result_set):
 
762
        """Convert a set of revision ids to a graph SearchResult."""
 
763
        result_parents = set()
 
764
        for parents in self.get_graph().get_parent_map(
 
765
            result_set).itervalues():
 
766
            result_parents.update(parents)
 
767
        included_keys = result_set.intersection(result_parents)
 
768
        start_keys = result_set.difference(included_keys)
 
769
        exclude_keys = result_parents.difference(result_set)
 
770
        result = graph.SearchResult(start_keys, exclude_keys,
 
771
            len(result_set), result_set)
 
772
        return result
 
773
 
 
774
    @needs_read_lock
 
775
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
776
        """Return the revision ids that other has that this does not.
 
777
        
 
778
        These are returned in topological order.
 
779
 
 
780
        revision_id: only return revision ids included by revision_id.
 
781
        """
 
782
        return repository.InterRepository.get(
 
783
            other, self).search_missing_revision_ids(revision_id, find_ghosts)
 
784
 
 
785
    def fetch(self, source, revision_id=None, pb=None):
 
786
        if self.has_same_location(source):
 
787
            # check that last_revision is in 'from' and then return a
 
788
            # no-operation.
 
789
            if (revision_id is not None and
 
790
                not revision.is_null(revision_id)):
 
791
                self.get_revision(revision_id)
 
792
            return 0, []
 
793
        self._ensure_real()
 
794
        return self._real_repository.fetch(
 
795
            source, revision_id=revision_id, pb=pb)
 
796
 
 
797
    def create_bundle(self, target, base, fileobj, format=None):
 
798
        self._ensure_real()
 
799
        self._real_repository.create_bundle(target, base, fileobj, format)
 
800
 
 
801
    @needs_read_lock
 
802
    def get_ancestry(self, revision_id, topo_sorted=True):
 
803
        self._ensure_real()
 
804
        return self._real_repository.get_ancestry(revision_id, topo_sorted)
 
805
 
 
806
    def fileids_altered_by_revision_ids(self, revision_ids):
 
807
        self._ensure_real()
 
808
        return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
 
809
 
 
810
    def _get_versioned_file_checker(self, revisions, revision_versions_cache):
 
811
        self._ensure_real()
 
812
        return self._real_repository._get_versioned_file_checker(
 
813
            revisions, revision_versions_cache)
 
814
        
 
815
    def iter_files_bytes(self, desired_files):
 
816
        """See Repository.iter_file_bytes.
 
817
        """
 
818
        self._ensure_real()
 
819
        return self._real_repository.iter_files_bytes(desired_files)
 
820
 
 
821
    @property
 
822
    def _fetch_order(self):
 
823
        """Decorate the real repository for now.
 
824
 
 
825
        In the long term getting this back from the remote repository as part
 
826
        of open would be more efficient.
 
827
        """
 
828
        self._ensure_real()
 
829
        return self._real_repository._fetch_order
 
830
 
 
831
    @property
 
832
    def _fetch_uses_deltas(self):
 
833
        """Decorate the real repository for now.
 
834
 
 
835
        In the long term getting this back from the remote repository as part
 
836
        of open would be more efficient.
 
837
        """
 
838
        self._ensure_real()
 
839
        return self._real_repository._fetch_uses_deltas
 
840
 
 
841
    @property
 
842
    def _fetch_reconcile(self):
 
843
        """Decorate the real repository for now.
 
844
 
 
845
        In the long term getting this back from the remote repository as part
 
846
        of open would be more efficient.
 
847
        """
 
848
        self._ensure_real()
 
849
        return self._real_repository._fetch_reconcile
 
850
 
 
851
    def get_parent_map(self, keys):
 
852
        """See bzrlib.Graph.get_parent_map()."""
 
853
        # Hack to build up the caching logic.
 
854
        ancestry = self._parents_map
 
855
        if ancestry is None:
 
856
            # Repository is not locked, so there's no cache.
 
857
            missing_revisions = set(keys)
 
858
            ancestry = {}
 
859
        else:
 
860
            missing_revisions = set(key for key in keys if key not in ancestry)
 
861
        if missing_revisions:
 
862
            parent_map = self._get_parent_map(missing_revisions)
 
863
            if 'hpss' in debug.debug_flags:
 
864
                mutter('retransmitted revisions: %d of %d',
 
865
                        len(set(ancestry).intersection(parent_map)),
 
866
                        len(parent_map))
 
867
            ancestry.update(parent_map)
 
868
        present_keys = [k for k in keys if k in ancestry]
 
869
        if 'hpss' in debug.debug_flags:
 
870
            if self._requested_parents is not None and len(ancestry) != 0:
 
871
                self._requested_parents.update(present_keys)
 
872
                mutter('Current RemoteRepository graph hit rate: %d%%',
 
873
                    100.0 * len(self._requested_parents) / len(ancestry))
 
874
        return dict((k, ancestry[k]) for k in present_keys)
 
875
 
 
876
    def _get_parent_map(self, keys):
 
877
        """Helper for get_parent_map that performs the RPC."""
 
878
        medium = self._client._medium
 
879
        if medium._is_remote_before((1, 2)):
 
880
            # We already found out that the server can't understand
 
881
            # Repository.get_parent_map requests, so just fetch the whole
 
882
            # graph.
 
883
            # XXX: Note that this will issue a deprecation warning. This is ok
 
884
            # :- its because we're working with a deprecated server anyway, and
 
885
            # the user will almost certainly have seen a warning about the
 
886
            # server version already.
 
887
            rg = self.get_revision_graph()
 
888
            # There is an api discrepency between get_parent_map and
 
889
            # get_revision_graph. Specifically, a "key:()" pair in
 
890
            # get_revision_graph just means a node has no parents. For
 
891
            # "get_parent_map" it means the node is a ghost. So fix up the
 
892
            # graph to correct this.
 
893
            #   https://bugs.launchpad.net/bzr/+bug/214894
 
894
            # There is one other "bug" which is that ghosts in
 
895
            # get_revision_graph() are not returned at all. But we won't worry
 
896
            # about that for now.
 
897
            for node_id, parent_ids in rg.iteritems():
 
898
                if parent_ids == ():
 
899
                    rg[node_id] = (NULL_REVISION,)
 
900
            rg[NULL_REVISION] = ()
 
901
            return rg
 
902
 
 
903
        keys = set(keys)
 
904
        if None in keys:
 
905
            raise ValueError('get_parent_map(None) is not valid')
 
906
        if NULL_REVISION in keys:
 
907
            keys.discard(NULL_REVISION)
 
908
            found_parents = {NULL_REVISION:()}
 
909
            if not keys:
 
910
                return found_parents
 
911
        else:
 
912
            found_parents = {}
 
913
        # TODO(Needs analysis): We could assume that the keys being requested
 
914
        # from get_parent_map are in a breadth first search, so typically they
 
915
        # will all be depth N from some common parent, and we don't have to
 
916
        # have the server iterate from the root parent, but rather from the
 
917
        # keys we're searching; and just tell the server the keyspace we
 
918
        # already have; but this may be more traffic again.
 
919
 
 
920
        # Transform self._parents_map into a search request recipe.
 
921
        # TODO: Manage this incrementally to avoid covering the same path
 
922
        # repeatedly. (The server will have to on each request, but the less
 
923
        # work done the better).
 
924
        parents_map = self._parents_map
 
925
        if parents_map is None:
 
926
            # Repository is not locked, so there's no cache.
 
927
            parents_map = {}
 
928
        start_set = set(parents_map)
 
929
        result_parents = set()
 
930
        for parents in parents_map.itervalues():
 
931
            result_parents.update(parents)
 
932
        stop_keys = result_parents.difference(start_set)
 
933
        included_keys = start_set.intersection(result_parents)
 
934
        start_set.difference_update(included_keys)
 
935
        recipe = (start_set, stop_keys, len(parents_map))
 
936
        body = self._serialise_search_recipe(recipe)
 
937
        path = self.bzrdir._path_for_remote_call(self._client)
 
938
        for key in keys:
 
939
            if type(key) is not str:
 
940
                raise ValueError(
 
941
                    "key %r not a plain string" % (key,))
 
942
        verb = 'Repository.get_parent_map'
 
943
        args = (path,) + tuple(keys)
 
944
        try:
 
945
            response = self._client.call_with_body_bytes_expecting_body(
 
946
                verb, args, self._serialise_search_recipe(recipe))
 
947
        except errors.UnknownSmartMethod:
 
948
            # Server does not support this method, so get the whole graph.
 
949
            # Worse, we have to force a disconnection, because the server now
 
950
            # doesn't realise it has a body on the wire to consume, so the
 
951
            # only way to recover is to abandon the connection.
 
952
            warning(
 
953
                'Server is too old for fast get_parent_map, reconnecting.  '
 
954
                '(Upgrade the server to Bazaar 1.2 to avoid this)')
 
955
            medium.disconnect()
 
956
            # To avoid having to disconnect repeatedly, we keep track of the
 
957
            # fact the server doesn't understand remote methods added in 1.2.
 
958
            medium._remember_remote_is_before((1, 2))
 
959
            return self.get_revision_graph(None)
 
960
        response_tuple, response_handler = response
 
961
        if response_tuple[0] not in ['ok']:
 
962
            response_handler.cancel_read_body()
 
963
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
964
        if response_tuple[0] == 'ok':
 
965
            coded = bz2.decompress(response_handler.read_body_bytes())
 
966
            if coded == '':
 
967
                # no revisions found
 
968
                return {}
 
969
            lines = coded.split('\n')
 
970
            revision_graph = {}
 
971
            for line in lines:
 
972
                d = tuple(line.split())
 
973
                if len(d) > 1:
 
974
                    revision_graph[d[0]] = d[1:]
 
975
                else:
 
976
                    # No parents - so give the Graph result (NULL_REVISION,).
 
977
                    revision_graph[d[0]] = (NULL_REVISION,)
 
978
            return revision_graph
 
979
 
 
980
    @needs_read_lock
 
981
    def get_signature_text(self, revision_id):
 
982
        self._ensure_real()
 
983
        return self._real_repository.get_signature_text(revision_id)
 
984
 
 
985
    @needs_read_lock
 
986
    @symbol_versioning.deprecated_method(symbol_versioning.one_three)
 
987
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
988
        self._ensure_real()
 
989
        return self._real_repository.get_revision_graph_with_ghosts(
 
990
            revision_ids=revision_ids)
 
991
 
 
992
    @needs_read_lock
 
993
    def get_inventory_xml(self, revision_id):
 
994
        self._ensure_real()
 
995
        return self._real_repository.get_inventory_xml(revision_id)
 
996
 
 
997
    def deserialise_inventory(self, revision_id, xml):
 
998
        self._ensure_real()
 
999
        return self._real_repository.deserialise_inventory(revision_id, xml)
 
1000
 
 
1001
    def reconcile(self, other=None, thorough=False):
 
1002
        self._ensure_real()
 
1003
        return self._real_repository.reconcile(other=other, thorough=thorough)
 
1004
        
 
1005
    def all_revision_ids(self):
 
1006
        self._ensure_real()
 
1007
        return self._real_repository.all_revision_ids()
 
1008
    
 
1009
    @needs_read_lock
 
1010
    def get_deltas_for_revisions(self, revisions):
 
1011
        self._ensure_real()
 
1012
        return self._real_repository.get_deltas_for_revisions(revisions)
 
1013
 
 
1014
    @needs_read_lock
 
1015
    def get_revision_delta(self, revision_id):
 
1016
        self._ensure_real()
 
1017
        return self._real_repository.get_revision_delta(revision_id)
 
1018
 
 
1019
    @needs_read_lock
 
1020
    def revision_trees(self, revision_ids):
 
1021
        self._ensure_real()
 
1022
        return self._real_repository.revision_trees(revision_ids)
 
1023
 
 
1024
    @needs_read_lock
 
1025
    def get_revision_reconcile(self, revision_id):
 
1026
        self._ensure_real()
 
1027
        return self._real_repository.get_revision_reconcile(revision_id)
 
1028
 
 
1029
    @needs_read_lock
 
1030
    def check(self, revision_ids=None):
 
1031
        self._ensure_real()
 
1032
        return self._real_repository.check(revision_ids=revision_ids)
 
1033
 
 
1034
    def copy_content_into(self, destination, revision_id=None):
 
1035
        self._ensure_real()
 
1036
        return self._real_repository.copy_content_into(
 
1037
            destination, revision_id=revision_id)
 
1038
 
 
1039
    def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
 
1040
        # get a tarball of the remote repository, and copy from that into the
 
1041
        # destination
 
1042
        from bzrlib import osutils
 
1043
        import tarfile
 
1044
        # TODO: Maybe a progress bar while streaming the tarball?
 
1045
        note("Copying repository content as tarball...")
 
1046
        tar_file = self._get_tarball('bz2')
 
1047
        if tar_file is None:
 
1048
            return None
 
1049
        destination = to_bzrdir.create_repository()
 
1050
        try:
 
1051
            tar = tarfile.open('repository', fileobj=tar_file,
 
1052
                mode='r|bz2')
 
1053
            tmpdir = osutils.mkdtemp()
 
1054
            try:
 
1055
                _extract_tar(tar, tmpdir)
 
1056
                tmp_bzrdir = BzrDir.open(tmpdir)
 
1057
                tmp_repo = tmp_bzrdir.open_repository()
 
1058
                tmp_repo.copy_content_into(destination, revision_id)
 
1059
            finally:
 
1060
                osutils.rmtree(tmpdir)
 
1061
        finally:
 
1062
            tar_file.close()
 
1063
        return destination
 
1064
        # TODO: Suggestion from john: using external tar is much faster than
 
1065
        # python's tarfile library, but it may not work on windows.
 
1066
 
 
1067
    @property
 
1068
    def inventories(self):
 
1069
        """Decorate the real repository for now.
 
1070
 
 
1071
        In the long term a full blown network facility is needed to
 
1072
        avoid creating a real repository object locally.
 
1073
        """
 
1074
        self._ensure_real()
 
1075
        return self._real_repository.inventories
 
1076
 
 
1077
    @needs_write_lock
 
1078
    def pack(self):
 
1079
        """Compress the data within the repository.
 
1080
 
 
1081
        This is not currently implemented within the smart server.
 
1082
        """
 
1083
        self._ensure_real()
 
1084
        return self._real_repository.pack()
 
1085
 
 
1086
    @property
 
1087
    def revisions(self):
 
1088
        """Decorate the real repository for now.
 
1089
 
 
1090
        In the short term this should become a real object to intercept graph
 
1091
        lookups.
 
1092
 
 
1093
        In the long term a full blown network facility is needed.
 
1094
        """
 
1095
        self._ensure_real()
 
1096
        return self._real_repository.revisions
 
1097
 
 
1098
    def set_make_working_trees(self, new_value):
 
1099
        self._ensure_real()
 
1100
        self._real_repository.set_make_working_trees(new_value)
 
1101
 
 
1102
    @property
 
1103
    def signatures(self):
 
1104
        """Decorate the real repository for now.
 
1105
 
 
1106
        In the long term a full blown network facility is needed to avoid
 
1107
        creating a real repository object locally.
 
1108
        """
 
1109
        self._ensure_real()
 
1110
        return self._real_repository.signatures
 
1111
 
 
1112
    @needs_write_lock
 
1113
    def sign_revision(self, revision_id, gpg_strategy):
 
1114
        self._ensure_real()
 
1115
        return self._real_repository.sign_revision(revision_id, gpg_strategy)
 
1116
 
 
1117
    @property
 
1118
    def texts(self):
 
1119
        """Decorate the real repository for now.
 
1120
 
 
1121
        In the long term a full blown network facility is needed to avoid
 
1122
        creating a real repository object locally.
 
1123
        """
 
1124
        self._ensure_real()
 
1125
        return self._real_repository.texts
 
1126
 
 
1127
    @needs_read_lock
 
1128
    def get_revisions(self, revision_ids):
 
1129
        self._ensure_real()
 
1130
        return self._real_repository.get_revisions(revision_ids)
 
1131
 
 
1132
    def supports_rich_root(self):
 
1133
        self._ensure_real()
 
1134
        return self._real_repository.supports_rich_root()
 
1135
 
 
1136
    def iter_reverse_revision_history(self, revision_id):
 
1137
        self._ensure_real()
 
1138
        return self._real_repository.iter_reverse_revision_history(revision_id)
 
1139
 
 
1140
    @property
 
1141
    def _serializer(self):
 
1142
        self._ensure_real()
 
1143
        return self._real_repository._serializer
 
1144
 
 
1145
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
 
1146
        self._ensure_real()
 
1147
        return self._real_repository.store_revision_signature(
 
1148
            gpg_strategy, plaintext, revision_id)
 
1149
 
 
1150
    def add_signature_text(self, revision_id, signature):
 
1151
        self._ensure_real()
 
1152
        return self._real_repository.add_signature_text(revision_id, signature)
 
1153
 
 
1154
    def has_signature_for_revision_id(self, revision_id):
 
1155
        self._ensure_real()
 
1156
        return self._real_repository.has_signature_for_revision_id(revision_id)
 
1157
 
 
1158
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
 
1159
        self._ensure_real()
 
1160
        return self._real_repository.item_keys_introduced_by(revision_ids,
 
1161
            _files_pb=_files_pb)
 
1162
 
 
1163
    def revision_graph_can_have_wrong_parents(self):
 
1164
        # The answer depends on the remote repo format.
 
1165
        self._ensure_real()
 
1166
        return self._real_repository.revision_graph_can_have_wrong_parents()
 
1167
 
 
1168
    def _find_inconsistent_revision_parents(self):
 
1169
        self._ensure_real()
 
1170
        return self._real_repository._find_inconsistent_revision_parents()
 
1171
 
 
1172
    def _check_for_inconsistent_revision_parents(self):
 
1173
        self._ensure_real()
 
1174
        return self._real_repository._check_for_inconsistent_revision_parents()
 
1175
 
 
1176
    def _make_parents_provider(self):
 
1177
        return self
 
1178
 
 
1179
    def _serialise_search_recipe(self, recipe):
 
1180
        """Serialise a graph search recipe.
 
1181
 
 
1182
        :param recipe: A search recipe (start, stop, count).
 
1183
        :return: Serialised bytes.
 
1184
        """
 
1185
        start_keys = ' '.join(recipe[0])
 
1186
        stop_keys = ' '.join(recipe[1])
 
1187
        count = str(recipe[2])
 
1188
        return '\n'.join((start_keys, stop_keys, count))
 
1189
 
 
1190
 
 
1191
class RemoteBranchLockableFiles(LockableFiles):
 
1192
    """A 'LockableFiles' implementation that talks to a smart server.
 
1193
    
 
1194
    This is not a public interface class.
 
1195
    """
 
1196
 
 
1197
    def __init__(self, bzrdir, _client):
 
1198
        self.bzrdir = bzrdir
 
1199
        self._client = _client
 
1200
        self._need_find_modes = True
 
1201
        LockableFiles.__init__(
 
1202
            self, bzrdir.get_branch_transport(None),
 
1203
            'lock', lockdir.LockDir)
 
1204
 
 
1205
    def _find_modes(self):
 
1206
        # RemoteBranches don't let the client set the mode of control files.
 
1207
        self._dir_mode = None
 
1208
        self._file_mode = None
 
1209
 
 
1210
 
 
1211
class RemoteBranchFormat(branch.BranchFormat):
 
1212
 
 
1213
    def __eq__(self, other):
 
1214
        return (isinstance(other, RemoteBranchFormat) and 
 
1215
            self.__dict__ == other.__dict__)
 
1216
 
 
1217
    def get_format_description(self):
 
1218
        return 'Remote BZR Branch'
 
1219
 
 
1220
    def get_format_string(self):
 
1221
        return 'Remote BZR Branch'
 
1222
 
 
1223
    def open(self, a_bzrdir):
 
1224
        return a_bzrdir.open_branch()
 
1225
 
 
1226
    def initialize(self, a_bzrdir):
 
1227
        return a_bzrdir.create_branch()
 
1228
 
 
1229
    def supports_tags(self):
 
1230
        # Remote branches might support tags, but we won't know until we
 
1231
        # access the real remote branch.
 
1232
        return True
 
1233
 
 
1234
 
 
1235
class RemoteBranch(branch.Branch):
 
1236
    """Branch stored on a server accessed by HPSS RPC.
 
1237
 
 
1238
    At the moment most operations are mapped down to simple file operations.
 
1239
    """
 
1240
 
 
1241
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
 
1242
        _client=None):
 
1243
        """Create a RemoteBranch instance.
 
1244
 
 
1245
        :param real_branch: An optional local implementation of the branch
 
1246
            format, usually accessing the data via the VFS.
 
1247
        :param _client: Private parameter for testing.
 
1248
        """
 
1249
        # We intentionally don't call the parent class's __init__, because it
 
1250
        # will try to assign to self.tags, which is a property in this subclass.
 
1251
        # And the parent's __init__ doesn't do much anyway.
 
1252
        self._revision_id_to_revno_cache = None
 
1253
        self._revision_history_cache = None
 
1254
        self._last_revision_info_cache = None
 
1255
        self.bzrdir = remote_bzrdir
 
1256
        if _client is not None:
 
1257
            self._client = _client
 
1258
        else:
 
1259
            self._client = remote_bzrdir._client
 
1260
        self.repository = remote_repository
 
1261
        if real_branch is not None:
 
1262
            self._real_branch = real_branch
 
1263
            # Give the remote repository the matching real repo.
 
1264
            real_repo = self._real_branch.repository
 
1265
            if isinstance(real_repo, RemoteRepository):
 
1266
                real_repo._ensure_real()
 
1267
                real_repo = real_repo._real_repository
 
1268
            self.repository._set_real_repository(real_repo)
 
1269
            # Give the branch the remote repository to let fast-pathing happen.
 
1270
            self._real_branch.repository = self.repository
 
1271
        else:
 
1272
            self._real_branch = None
 
1273
        # Fill out expected attributes of branch for bzrlib api users.
 
1274
        self._format = RemoteBranchFormat()
 
1275
        self.base = self.bzrdir.root_transport.base
 
1276
        self._control_files = None
 
1277
        self._lock_mode = None
 
1278
        self._lock_token = None
 
1279
        self._repo_lock_token = None
 
1280
        self._lock_count = 0
 
1281
        self._leave_lock = False
 
1282
 
 
1283
    def _get_real_transport(self):
 
1284
        # if we try vfs access, return the real branch's vfs transport
 
1285
        self._ensure_real()
 
1286
        return self._real_branch._transport
 
1287
 
 
1288
    _transport = property(_get_real_transport)
 
1289
 
 
1290
    def __str__(self):
 
1291
        return "%s(%s)" % (self.__class__.__name__, self.base)
 
1292
 
 
1293
    __repr__ = __str__
 
1294
 
 
1295
    def _ensure_real(self):
 
1296
        """Ensure that there is a _real_branch set.
 
1297
 
 
1298
        Used before calls to self._real_branch.
 
1299
        """
 
1300
        if self._real_branch is None:
 
1301
            if not vfs.vfs_enabled():
 
1302
                raise AssertionError('smart server vfs must be enabled '
 
1303
                    'to use vfs implementation')
 
1304
            self.bzrdir._ensure_real()
 
1305
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
 
1306
            if self.repository._real_repository is None:
 
1307
                # Give the remote repository the matching real repo.
 
1308
                real_repo = self._real_branch.repository
 
1309
                if isinstance(real_repo, RemoteRepository):
 
1310
                    real_repo._ensure_real()
 
1311
                    real_repo = real_repo._real_repository
 
1312
                self.repository._set_real_repository(real_repo)
 
1313
            # Give the real branch the remote repository to let fast-pathing
 
1314
            # happen.
 
1315
            self._real_branch.repository = self.repository
 
1316
            if self._lock_mode == 'r':
 
1317
                self._real_branch.lock_read()
 
1318
            elif self._lock_mode == 'w':
 
1319
                self._real_branch.lock_write(token=self._lock_token)
 
1320
 
 
1321
    def _translate_error(self, err, **context):
 
1322
        self.repository._translate_error(err, branch=self, **context)
 
1323
 
 
1324
    def _clear_cached_state(self):
 
1325
        super(RemoteBranch, self)._clear_cached_state()
 
1326
        if self._real_branch is not None:
 
1327
            self._real_branch._clear_cached_state()
 
1328
 
 
1329
    def _clear_cached_state_of_remote_branch_only(self):
 
1330
        """Like _clear_cached_state, but doesn't clear the cache of
 
1331
        self._real_branch.
 
1332
 
 
1333
        This is useful when falling back to calling a method of
 
1334
        self._real_branch that changes state.  In that case the underlying
 
1335
        branch changes, so we need to invalidate this RemoteBranch's cache of
 
1336
        it.  However, there's no need to invalidate the _real_branch's cache
 
1337
        too, in fact doing so might harm performance.
 
1338
        """
 
1339
        super(RemoteBranch, self)._clear_cached_state()
 
1340
        
 
1341
    @property
 
1342
    def control_files(self):
 
1343
        # Defer actually creating RemoteBranchLockableFiles until its needed,
 
1344
        # because it triggers an _ensure_real that we otherwise might not need.
 
1345
        if self._control_files is None:
 
1346
            self._control_files = RemoteBranchLockableFiles(
 
1347
                self.bzrdir, self._client)
 
1348
        return self._control_files
 
1349
 
 
1350
    def _get_checkout_format(self):
 
1351
        self._ensure_real()
 
1352
        return self._real_branch._get_checkout_format()
 
1353
 
 
1354
    def get_physical_lock_status(self):
 
1355
        """See Branch.get_physical_lock_status()."""
 
1356
        # should be an API call to the server, as branches must be lockable.
 
1357
        self._ensure_real()
 
1358
        return self._real_branch.get_physical_lock_status()
 
1359
 
 
1360
    def get_stacked_on_url(self):
 
1361
        """Get the URL this branch is stacked against.
 
1362
 
 
1363
        :raises NotStacked: If the branch is not stacked.
 
1364
        :raises UnstackableBranchFormat: If the branch does not support
 
1365
            stacking.
 
1366
        :raises UnstackableRepositoryFormat: If the repository does not support
 
1367
            stacking.
 
1368
        """
 
1369
        self._ensure_real()
 
1370
        return self._real_branch.get_stacked_on_url()
 
1371
 
 
1372
    def lock_read(self):
 
1373
        self.repository.lock_read()
 
1374
        if not self._lock_mode:
 
1375
            self._lock_mode = 'r'
 
1376
            self._lock_count = 1
 
1377
            if self._real_branch is not None:
 
1378
                self._real_branch.lock_read()
 
1379
        else:
 
1380
            self._lock_count += 1
 
1381
 
 
1382
    def _remote_lock_write(self, token):
 
1383
        if token is None:
 
1384
            branch_token = repo_token = ''
 
1385
        else:
 
1386
            branch_token = token
 
1387
            repo_token = self.repository.lock_write()
 
1388
            self.repository.unlock()
 
1389
        path = self.bzrdir._path_for_remote_call(self._client)
 
1390
        try:
 
1391
            response = self._client.call(
 
1392
                'Branch.lock_write', path, branch_token, repo_token or '')
 
1393
        except errors.ErrorFromSmartServer, err:
 
1394
            self._translate_error(err, token=token)
 
1395
        if response[0] != 'ok':
 
1396
            raise errors.UnexpectedSmartServerResponse(response)
 
1397
        ok, branch_token, repo_token = response
 
1398
        return branch_token, repo_token
 
1399
            
 
1400
    def lock_write(self, token=None):
 
1401
        if not self._lock_mode:
 
1402
            # Lock the branch and repo in one remote call.
 
1403
            remote_tokens = self._remote_lock_write(token)
 
1404
            self._lock_token, self._repo_lock_token = remote_tokens
 
1405
            if not self._lock_token:
 
1406
                raise SmartProtocolError('Remote server did not return a token!')
 
1407
            # Tell the self.repository object that it is locked.
 
1408
            self.repository.lock_write(
 
1409
                self._repo_lock_token, _skip_rpc=True)
 
1410
 
 
1411
            if self._real_branch is not None:
 
1412
                self._real_branch.lock_write(token=self._lock_token)
 
1413
            if token is not None:
 
1414
                self._leave_lock = True
 
1415
            else:
 
1416
                self._leave_lock = False
 
1417
            self._lock_mode = 'w'
 
1418
            self._lock_count = 1
 
1419
        elif self._lock_mode == 'r':
 
1420
            raise errors.ReadOnlyTransaction
 
1421
        else:
 
1422
            if token is not None:
 
1423
                # A token was given to lock_write, and we're relocking, so
 
1424
                # check that the given token actually matches the one we
 
1425
                # already have.
 
1426
                if token != self._lock_token:
 
1427
                    raise errors.TokenMismatch(token, self._lock_token)
 
1428
            self._lock_count += 1
 
1429
            # Re-lock the repository too.
 
1430
            self.repository.lock_write(self._repo_lock_token)
 
1431
        return self._lock_token or None
 
1432
 
 
1433
    def _unlock(self, branch_token, repo_token):
 
1434
        path = self.bzrdir._path_for_remote_call(self._client)
 
1435
        try:
 
1436
            response = self._client.call('Branch.unlock', path, branch_token,
 
1437
                                         repo_token or '')
 
1438
        except errors.ErrorFromSmartServer, err:
 
1439
            self._translate_error(err, token=str((branch_token, repo_token)))
 
1440
        if response == ('ok',):
 
1441
            return
 
1442
        raise errors.UnexpectedSmartServerResponse(response)
 
1443
 
 
1444
    def unlock(self):
 
1445
        try:
 
1446
            self._lock_count -= 1
 
1447
            if not self._lock_count:
 
1448
                self._clear_cached_state()
 
1449
                mode = self._lock_mode
 
1450
                self._lock_mode = None
 
1451
                if self._real_branch is not None:
 
1452
                    if (not self._leave_lock and mode == 'w' and
 
1453
                        self._repo_lock_token):
 
1454
                        # If this RemoteBranch will remove the physical lock
 
1455
                        # for the repository, make sure the _real_branch
 
1456
                        # doesn't do it first.  (Because the _real_branch's
 
1457
                        # repository is set to be the RemoteRepository.)
 
1458
                        self._real_branch.repository.leave_lock_in_place()
 
1459
                    self._real_branch.unlock()
 
1460
                if mode != 'w':
 
1461
                    # Only write-locked branched need to make a remote method
 
1462
                    # call to perfom the unlock.
 
1463
                    return
 
1464
                if not self._lock_token:
 
1465
                    raise AssertionError('Locked, but no token!')
 
1466
                branch_token = self._lock_token
 
1467
                repo_token = self._repo_lock_token
 
1468
                self._lock_token = None
 
1469
                self._repo_lock_token = None
 
1470
                if not self._leave_lock:
 
1471
                    self._unlock(branch_token, repo_token)
 
1472
        finally:
 
1473
            self.repository.unlock()
 
1474
 
 
1475
    def break_lock(self):
 
1476
        self._ensure_real()
 
1477
        return self._real_branch.break_lock()
 
1478
 
 
1479
    def leave_lock_in_place(self):
 
1480
        if not self._lock_token:
 
1481
            raise NotImplementedError(self.leave_lock_in_place)
 
1482
        self._leave_lock = True
 
1483
 
 
1484
    def dont_leave_lock_in_place(self):
 
1485
        if not self._lock_token:
 
1486
            raise NotImplementedError(self.dont_leave_lock_in_place)
 
1487
        self._leave_lock = False
 
1488
 
 
1489
    def _last_revision_info(self):
 
1490
        path = self.bzrdir._path_for_remote_call(self._client)
 
1491
        response = self._client.call('Branch.last_revision_info', path)
 
1492
        if response[0] != 'ok':
 
1493
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
1494
        revno = int(response[1])
 
1495
        last_revision = response[2]
 
1496
        return (revno, last_revision)
 
1497
 
 
1498
    def _gen_revision_history(self):
 
1499
        """See Branch._gen_revision_history()."""
 
1500
        path = self.bzrdir._path_for_remote_call(self._client)
 
1501
        response_tuple, response_handler = self._client.call_expecting_body(
 
1502
            'Branch.revision_history', path)
 
1503
        if response_tuple[0] != 'ok':
 
1504
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
1505
        result = response_handler.read_body_bytes().split('\x00')
 
1506
        if result == ['']:
 
1507
            return []
 
1508
        return result
 
1509
 
 
1510
    def _set_last_revision_descendant(self, revision_id, other_branch,
 
1511
            allow_diverged=False, allow_overwrite_descendant=False):
 
1512
        path = self.bzrdir._path_for_remote_call(self._client)
 
1513
        try:
 
1514
            response = self._client.call('Branch.set_last_revision_ex',
 
1515
                path, self._lock_token, self._repo_lock_token, revision_id,
 
1516
                int(allow_diverged), int(allow_overwrite_descendant))
 
1517
        except errors.ErrorFromSmartServer, err:
 
1518
            self._translate_error(err, other_branch=other_branch)
 
1519
        self._clear_cached_state()
 
1520
        if len(response) != 3 and response[0] != 'ok':
 
1521
            raise errors.UnexpectedSmartServerResponse(response)
 
1522
        new_revno, new_revision_id = response[1:]
 
1523
        self._last_revision_info_cache = new_revno, new_revision_id
 
1524
        if self._real_branch is not None:
 
1525
            cache = new_revno, new_revision_id
 
1526
            self._real_branch._last_revision_info_cache = cache
 
1527
 
 
1528
    def _set_last_revision(self, revision_id):
 
1529
        path = self.bzrdir._path_for_remote_call(self._client)
 
1530
        self._clear_cached_state()
 
1531
        try:
 
1532
            response = self._client.call('Branch.set_last_revision',
 
1533
                path, self._lock_token, self._repo_lock_token, revision_id)
 
1534
        except errors.ErrorFromSmartServer, err:
 
1535
            self._translate_error(err)
 
1536
        if response != ('ok',):
 
1537
            raise errors.UnexpectedSmartServerResponse(response)
 
1538
 
 
1539
    @needs_write_lock
 
1540
    def set_revision_history(self, rev_history):
 
1541
        # Send just the tip revision of the history; the server will generate
 
1542
        # the full history from that.  If the revision doesn't exist in this
 
1543
        # branch, NoSuchRevision will be raised.
 
1544
        if rev_history == []:
 
1545
            rev_id = 'null:'
 
1546
        else:
 
1547
            rev_id = rev_history[-1]
 
1548
        self._set_last_revision(rev_id)
 
1549
        self._cache_revision_history(rev_history)
 
1550
 
 
1551
    def get_parent(self):
 
1552
        self._ensure_real()
 
1553
        return self._real_branch.get_parent()
 
1554
        
 
1555
    def set_parent(self, url):
 
1556
        self._ensure_real()
 
1557
        return self._real_branch.set_parent(url)
 
1558
        
 
1559
    def set_stacked_on_url(self, stacked_location):
 
1560
        """Set the URL this branch is stacked against.
 
1561
 
 
1562
        :raises UnstackableBranchFormat: If the branch does not support
 
1563
            stacking.
 
1564
        :raises UnstackableRepositoryFormat: If the repository does not support
 
1565
            stacking.
 
1566
        """
 
1567
        self._ensure_real()
 
1568
        return self._real_branch.set_stacked_on_url(stacked_location)
 
1569
 
 
1570
    def sprout(self, to_bzrdir, revision_id=None):
 
1571
        # Like Branch.sprout, except that it sprouts a branch in the default
 
1572
        # format, because RemoteBranches can't be created at arbitrary URLs.
 
1573
        # XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
 
1574
        # to_bzrdir.create_branch...
 
1575
        self._ensure_real()
 
1576
        result = self._real_branch._format.initialize(to_bzrdir)
 
1577
        self.copy_content_into(result, revision_id=revision_id)
 
1578
        result.set_parent(self.bzrdir.root_transport.base)
 
1579
        return result
 
1580
 
 
1581
    @needs_write_lock
 
1582
    def pull(self, source, overwrite=False, stop_revision=None,
 
1583
             **kwargs):
 
1584
        self._clear_cached_state_of_remote_branch_only()
 
1585
        self._ensure_real()
 
1586
        return self._real_branch.pull(
 
1587
            source, overwrite=overwrite, stop_revision=stop_revision,
 
1588
            _override_hook_target=self, **kwargs)
 
1589
 
 
1590
    @needs_read_lock
 
1591
    def push(self, target, overwrite=False, stop_revision=None):
 
1592
        self._ensure_real()
 
1593
        return self._real_branch.push(
 
1594
            target, overwrite=overwrite, stop_revision=stop_revision,
 
1595
            _override_hook_source_branch=self)
 
1596
 
 
1597
    def is_locked(self):
 
1598
        return self._lock_count >= 1
 
1599
 
 
1600
    @needs_read_lock
 
1601
    def revision_id_to_revno(self, revision_id):
 
1602
        self._ensure_real()
 
1603
        return self._real_branch.revision_id_to_revno(revision_id)
 
1604
 
 
1605
    @needs_write_lock
 
1606
    def set_last_revision_info(self, revno, revision_id):
 
1607
        revision_id = ensure_null(revision_id)
 
1608
        path = self.bzrdir._path_for_remote_call(self._client)
 
1609
        try:
 
1610
            response = self._client.call('Branch.set_last_revision_info',
 
1611
                path, self._lock_token, self._repo_lock_token, str(revno), revision_id)
 
1612
        except errors.UnknownSmartMethod:
 
1613
            self._ensure_real()
 
1614
            self._clear_cached_state_of_remote_branch_only()
 
1615
            self._real_branch.set_last_revision_info(revno, revision_id)
 
1616
            self._last_revision_info_cache = revno, revision_id
 
1617
            return
 
1618
        except errors.ErrorFromSmartServer, err:
 
1619
            self._translate_error(err)
 
1620
        if response == ('ok',):
 
1621
            self._clear_cached_state()
 
1622
            self._last_revision_info_cache = revno, revision_id
 
1623
            # Update the _real_branch's cache too.
 
1624
            if self._real_branch is not None:
 
1625
                cache = self._last_revision_info_cache
 
1626
                self._real_branch._last_revision_info_cache = cache
 
1627
        else:
 
1628
            raise errors.UnexpectedSmartServerResponse(response)
 
1629
 
 
1630
    @needs_write_lock
 
1631
    def generate_revision_history(self, revision_id, last_rev=None,
 
1632
                                  other_branch=None):
 
1633
        medium = self._client._medium
 
1634
        if not medium._is_remote_before((1, 6)):
 
1635
            try:
 
1636
                self._set_last_revision_descendant(revision_id, other_branch,
 
1637
                    allow_diverged=True, allow_overwrite_descendant=True)
 
1638
                return
 
1639
            except errors.UnknownSmartMethod:
 
1640
                medium._remember_remote_is_before((1, 6))
 
1641
        self._clear_cached_state_of_remote_branch_only()
 
1642
        self._ensure_real()
 
1643
        self._real_branch.generate_revision_history(
 
1644
            revision_id, last_rev=last_rev, other_branch=other_branch)
 
1645
 
 
1646
    @property
 
1647
    def tags(self):
 
1648
        self._ensure_real()
 
1649
        return self._real_branch.tags
 
1650
 
 
1651
    def set_push_location(self, location):
 
1652
        self._ensure_real()
 
1653
        return self._real_branch.set_push_location(location)
 
1654
 
 
1655
    @needs_write_lock
 
1656
    def update_revisions(self, other, stop_revision=None, overwrite=False,
 
1657
                         graph=None):
 
1658
        """See Branch.update_revisions."""
 
1659
        other.lock_read()
 
1660
        try:
 
1661
            if stop_revision is None:
 
1662
                stop_revision = other.last_revision()
 
1663
                if revision.is_null(stop_revision):
 
1664
                    # if there are no commits, we're done.
 
1665
                    return
 
1666
            self.fetch(other, stop_revision)
 
1667
 
 
1668
            if overwrite:
 
1669
                # Just unconditionally set the new revision.  We don't care if
 
1670
                # the branches have diverged.
 
1671
                self._set_last_revision(stop_revision)
 
1672
            else:
 
1673
                medium = self._client._medium
 
1674
                if not medium._is_remote_before((1, 6)):
 
1675
                    try:
 
1676
                        self._set_last_revision_descendant(stop_revision, other)
 
1677
                        return
 
1678
                    except errors.UnknownSmartMethod:
 
1679
                        medium._remember_remote_is_before((1, 6))
 
1680
                # Fallback for pre-1.6 servers: check for divergence
 
1681
                # client-side, then do _set_last_revision.
 
1682
                last_rev = revision.ensure_null(self.last_revision())
 
1683
                if graph is None:
 
1684
                    graph = self.repository.get_graph()
 
1685
                if self._check_if_descendant_or_diverged(
 
1686
                        stop_revision, last_rev, graph, other):
 
1687
                    # stop_revision is a descendant of last_rev, but we aren't
 
1688
                    # overwriting, so we're done.
 
1689
                    return
 
1690
                self._set_last_revision(stop_revision)
 
1691
        finally:
 
1692
            other.unlock()
 
1693
 
 
1694
 
 
1695
def _extract_tar(tar, to_dir):
 
1696
    """Extract all the contents of a tarfile object.
 
1697
 
 
1698
    A replacement for extractall, which is not present in python2.4
 
1699
    """
 
1700
    for tarinfo in tar:
 
1701
        tar.extract(tarinfo, to_dir)
 
1702
 
 
1703
 
 
1704
def _translate_error(err, **context):
 
1705
    """Translate an ErrorFromSmartServer into a more useful error.
 
1706
 
 
1707
    Possible context keys:
 
1708
      - branch
 
1709
      - repository
 
1710
      - bzrdir
 
1711
      - token
 
1712
      - other_branch
 
1713
 
 
1714
    If the error from the server doesn't match a known pattern, then
 
1715
    UnknownErrorFromSmartServer is raised.
 
1716
    """
 
1717
    def find(name):
 
1718
        try:
 
1719
            return context[name]
 
1720
        except KeyError, keyErr:
 
1721
            mutter('Missing key %r in context %r', keyErr.args[0], context)
 
1722
            raise err
 
1723
    if err.error_verb == 'NoSuchRevision':
 
1724
        raise NoSuchRevision(find('branch'), err.error_args[0])
 
1725
    elif err.error_verb == 'nosuchrevision':
 
1726
        raise NoSuchRevision(find('repository'), err.error_args[0])
 
1727
    elif err.error_tuple == ('nobranch',):
 
1728
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
 
1729
    elif err.error_verb == 'norepository':
 
1730
        raise errors.NoRepositoryPresent(find('bzrdir'))
 
1731
    elif err.error_verb == 'LockContention':
 
1732
        raise errors.LockContention('(remote lock)')
 
1733
    elif err.error_verb == 'UnlockableTransport':
 
1734
        raise errors.UnlockableTransport(find('bzrdir').root_transport)
 
1735
    elif err.error_verb == 'LockFailed':
 
1736
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
 
1737
    elif err.error_verb == 'TokenMismatch':
 
1738
        raise errors.TokenMismatch(find('token'), '(remote token)')
 
1739
    elif err.error_verb == 'Diverged':
 
1740
        raise errors.DivergedBranches(find('branch'), find('other_branch'))
 
1741
    elif err.error_verb == 'TipChangeRejected':
 
1742
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
 
1743
    raise errors.UnknownErrorFromSmartServer(err)
 
1744