~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Ian Clatworthy
  • Date: 2009-01-20 02:12:35 UTC
  • mfrom: (3943.3.4 bzr.multi-glob-rules)
  • mto: This revision was merged to the branch mainline in revision 3947.
  • Revision ID: ian.clatworthy@canonical.com-20090120021235-n8bd5kzz3s624aq5
Multi-glob rules (Marius Kruger)

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