/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: Ian Clatworthy
  • Date: 2009-03-17 06:18:30 UTC
  • mto: (4157.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 4158.
  • Revision ID: ian.clatworthy@canonical.com-20090317061830-9glppr51ggivnrgl
Show usage on --usage, not -h

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
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.
16
19
 
17
20
import bz2
18
21
 
19
22
from bzrlib import (
20
 
    bencode,
21
23
    branch,
22
24
    bzrdir,
23
 
    config,
24
25
    debug,
25
26
    errors,
26
27
    graph,
27
 
    lock,
28
28
    lockdir,
 
29
    pack,
29
30
    repository,
30
 
    repository as _mod_repository,
31
31
    revision,
32
 
    revision as _mod_revision,
33
 
    static_tuple,
34
32
    symbol_versioning,
 
33
    urlutils,
35
34
)
36
 
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
 
35
from bzrlib.branch import BranchReferenceFormat
37
36
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
38
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
37
from bzrlib.decorators import needs_read_lock, needs_write_lock
39
38
from bzrlib.errors import (
40
39
    NoSuchRevision,
41
40
    SmartProtocolError,
42
41
    )
43
42
from bzrlib.lockable_files import LockableFiles
44
 
from bzrlib.smart import client, vfs, repository as smart_repo
 
43
from bzrlib.smart import client, vfs
45
44
from bzrlib.revision import ensure_null, NULL_REVISION
46
 
from bzrlib.repository import RepositoryWriteLockResult
47
45
from bzrlib.trace import mutter, note, warning
 
46
from bzrlib.util import bencode
 
47
from bzrlib.versionedfile import record_to_fulltext_bytes
48
48
 
49
49
 
50
50
class _RpcHelper(object):
62
62
        except errors.ErrorFromSmartServer, err:
63
63
            self._translate_error(err, **err_context)
64
64
 
65
 
    def _call_with_body_bytes(self, method, args, body_bytes, **err_context):
66
 
        try:
67
 
            return self._client.call_with_body_bytes(method, args, body_bytes)
68
 
        except errors.ErrorFromSmartServer, err:
69
 
            self._translate_error(err, **err_context)
70
 
 
71
65
    def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
72
66
                                             **err_context):
73
67
        try:
80
74
def response_tuple_to_repo_format(response):
81
75
    """Convert a response tuple describing a repository format to a format."""
82
76
    format = RemoteRepositoryFormat()
83
 
    format._rich_root_data = (response[0] == 'yes')
84
 
    format._supports_tree_reference = (response[1] == 'yes')
85
 
    format._supports_external_lookups = (response[2] == 'yes')
 
77
    format.rich_root_data = (response[0] == 'yes')
 
78
    format.supports_tree_reference = (response[1] == 'yes')
 
79
    format.supports_external_lookups = (response[2] == 'yes')
86
80
    format._network_name = response[3]
87
81
    return format
88
82
 
92
86
class RemoteBzrDir(BzrDir, _RpcHelper):
93
87
    """Control directory on a remote server, accessed via bzr:// or similar."""
94
88
 
95
 
    def __init__(self, transport, format, _client=None, _force_probe=False):
 
89
    def __init__(self, transport, format, _client=None):
96
90
        """Construct a RemoteBzrDir.
97
91
 
98
92
        :param _client: Private parameter for testing. Disables probing and the
102
96
        # this object holds a delegated bzrdir that uses file-level operations
103
97
        # to talk to the other side
104
98
        self._real_bzrdir = None
105
 
        self._has_working_tree = None
106
99
        # 1-shot cache for the call pattern 'create_branch; open_branch' - see
107
100
        # create_branch for details.
108
101
        self._next_open_branch_result = None
112
105
            self._client = client._SmartClient(medium)
113
106
        else:
114
107
            self._client = _client
115
 
            if not _force_probe:
116
 
                return
117
 
 
118
 
        self._probe_bzrdir()
119
 
 
120
 
    def __repr__(self):
121
 
        return '%s(%r)' % (self.__class__.__name__, self._client)
122
 
 
123
 
    def _probe_bzrdir(self):
124
 
        medium = self._client._medium
 
108
            return
 
109
 
125
110
        path = self._path_for_remote_call(self._client)
126
 
        if medium._is_remote_before((2, 1)):
127
 
            self._rpc_open(path)
128
 
            return
129
 
        try:
130
 
            self._rpc_open_2_1(path)
131
 
            return
132
 
        except errors.UnknownSmartMethod:
133
 
            medium._remember_remote_is_before((2, 1))
134
 
            self._rpc_open(path)
135
 
 
136
 
    def _rpc_open_2_1(self, path):
137
 
        response = self._call('BzrDir.open_2.1', path)
138
 
        if response == ('no',):
139
 
            raise errors.NotBranchError(path=self.root_transport.base)
140
 
        elif response[0] == 'yes':
141
 
            if response[1] == 'yes':
142
 
                self._has_working_tree = True
143
 
            elif response[1] == 'no':
144
 
                self._has_working_tree = False
145
 
            else:
146
 
                raise errors.UnexpectedSmartServerResponse(response)
147
 
        else:
148
 
            raise errors.UnexpectedSmartServerResponse(response)
149
 
 
150
 
    def _rpc_open(self, path):
151
111
        response = self._call('BzrDir.open', path)
152
112
        if response not in [('yes',), ('no',)]:
153
113
            raise errors.UnexpectedSmartServerResponse(response)
154
114
        if response == ('no',):
155
 
            raise errors.NotBranchError(path=self.root_transport.base)
 
115
            raise errors.NotBranchError(path=transport.base)
156
116
 
157
117
    def _ensure_real(self):
158
118
        """Ensure that there is a _real_bzrdir set.
160
120
        Used before calls to self._real_bzrdir.
161
121
        """
162
122
        if not self._real_bzrdir:
163
 
            if 'hpssvfs' in debug.debug_flags:
164
 
                import traceback
165
 
                warning('VFS BzrDir access triggered\n%s',
166
 
                    ''.join(traceback.format_stack()))
167
123
            self._real_bzrdir = BzrDir.open_from_transport(
168
124
                self.root_transport, _server_formats=False)
169
 
            self._format._network_name = \
170
 
                self._real_bzrdir._format.network_name()
171
125
 
172
126
    def _translate_error(self, err, **context):
173
127
        _translate_error(err, bzrdir=self, **context)
178
132
        self._next_open_branch_result = None
179
133
        return BzrDir.break_lock(self)
180
134
 
181
 
    def _vfs_cloning_metadir(self, require_stacking=False):
 
135
    def cloning_metadir(self, stacked=False):
182
136
        self._ensure_real()
183
 
        return self._real_bzrdir.cloning_metadir(
184
 
            require_stacking=require_stacking)
185
 
 
186
 
    def cloning_metadir(self, require_stacking=False):
187
 
        medium = self._client._medium
188
 
        if medium._is_remote_before((1, 13)):
189
 
            return self._vfs_cloning_metadir(require_stacking=require_stacking)
190
 
        verb = 'BzrDir.cloning_metadir'
191
 
        if require_stacking:
192
 
            stacking = 'True'
193
 
        else:
194
 
            stacking = 'False'
195
 
        path = self._path_for_remote_call(self._client)
196
 
        try:
197
 
            response = self._call(verb, path, stacking)
198
 
        except errors.UnknownSmartMethod:
199
 
            medium._remember_remote_is_before((1, 13))
200
 
            return self._vfs_cloning_metadir(require_stacking=require_stacking)
201
 
        except errors.UnknownErrorFromSmartServer, err:
202
 
            if err.error_tuple != ('BranchReference',):
203
 
                raise
204
 
            # We need to resolve the branch reference to determine the
205
 
            # cloning_metadir.  This causes unnecessary RPCs to open the
206
 
            # referenced branch (and bzrdir, etc) but only when the caller
207
 
            # didn't already resolve the branch reference.
208
 
            referenced_branch = self.open_branch()
209
 
            return referenced_branch.bzrdir.cloning_metadir()
210
 
        if len(response) != 3:
211
 
            raise errors.UnexpectedSmartServerResponse(response)
212
 
        control_name, repo_name, branch_info = response
213
 
        if len(branch_info) != 2:
214
 
            raise errors.UnexpectedSmartServerResponse(response)
215
 
        branch_ref, branch_name = branch_info
216
 
        format = bzrdir.network_format_registry.get(control_name)
217
 
        if repo_name:
218
 
            format.repository_format = repository.network_format_registry.get(
219
 
                repo_name)
220
 
        if branch_ref == 'ref':
221
 
            # XXX: we need possible_transports here to avoid reopening the
222
 
            # connection to the referenced location
223
 
            ref_bzrdir = BzrDir.open(branch_name)
224
 
            branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
225
 
            format.set_branch_format(branch_format)
226
 
        elif branch_ref == 'branch':
227
 
            if branch_name:
228
 
                format.set_branch_format(
229
 
                    branch.network_format_registry.get(branch_name))
230
 
        else:
231
 
            raise errors.UnexpectedSmartServerResponse(response)
232
 
        return format
 
137
        return self._real_bzrdir.cloning_metadir(stacked)
233
138
 
234
139
    def create_repository(self, shared=False):
235
140
        # as per meta1 formats - just delegate to the format object which may
245
150
        self._ensure_real()
246
151
        self._real_bzrdir.destroy_repository()
247
152
 
248
 
    def create_branch(self, name=None):
 
153
    def create_branch(self):
249
154
        # as per meta1 formats - just delegate to the format object which may
250
155
        # be parameterised.
251
 
        real_branch = self._format.get_branch_format().initialize(self,
252
 
            name=name)
 
156
        real_branch = self._format.get_branch_format().initialize(self)
253
157
        if not isinstance(real_branch, RemoteBranch):
254
 
            result = RemoteBranch(self, self.find_repository(), real_branch,
255
 
                                  name=name)
 
158
            result = RemoteBranch(self, self.find_repository(), real_branch)
256
159
        else:
257
160
            result = real_branch
258
161
        # BzrDir.clone_on_transport() uses the result of create_branch but does
264
167
        self._next_open_branch_result = result
265
168
        return result
266
169
 
267
 
    def destroy_branch(self, name=None):
 
170
    def destroy_branch(self):
268
171
        """See BzrDir.destroy_branch"""
269
172
        self._ensure_real()
270
 
        self._real_bzrdir.destroy_branch(name=name)
 
173
        self._real_bzrdir.destroy_branch()
271
174
        self._next_open_branch_result = None
272
175
 
273
176
    def create_workingtree(self, revision_id=None, from_branch=None):
283
186
 
284
187
    def get_branch_reference(self):
285
188
        """See BzrDir.get_branch_reference()."""
286
 
        response = self._get_branch_reference()
287
 
        if response[0] == 'ref':
288
 
            return response[1]
 
189
        path = self._path_for_remote_call(self._client)
 
190
        response = self._call('BzrDir.open_branch', path)
 
191
        if response[0] == 'ok':
 
192
            if response[1] == '':
 
193
                # branch at this location.
 
194
                return None
 
195
            else:
 
196
                # a branch reference, use the existing BranchReference logic.
 
197
                return response[1]
289
198
        else:
290
 
            return None
291
 
 
292
 
    def _get_branch_reference(self):
293
 
        path = self._path_for_remote_call(self._client)
294
 
        medium = self._client._medium
295
 
        candidate_calls = [
296
 
            ('BzrDir.open_branchV3', (2, 1)),
297
 
            ('BzrDir.open_branchV2', (1, 13)),
298
 
            ('BzrDir.open_branch', None),
299
 
            ]
300
 
        for verb, required_version in candidate_calls:
301
 
            if required_version and medium._is_remote_before(required_version):
302
 
                continue
303
 
            try:
304
 
                response = self._call(verb, path)
305
 
            except errors.UnknownSmartMethod:
306
 
                if required_version is None:
307
 
                    raise
308
 
                medium._remember_remote_is_before(required_version)
309
 
            else:
310
 
                break
311
 
        if verb == 'BzrDir.open_branch':
312
 
            if response[0] != 'ok':
313
 
                raise errors.UnexpectedSmartServerResponse(response)
314
 
            if response[1] != '':
315
 
                return ('ref', response[1])
316
 
            else:
317
 
                return ('branch', '')
318
 
        if response[0] not in ('ref', 'branch'):
319
199
            raise errors.UnexpectedSmartServerResponse(response)
320
 
        return response
321
200
 
322
201
    def _get_tree_branch(self):
323
202
        """See BzrDir._get_tree_branch()."""
324
203
        return None, self.open_branch()
325
204
 
326
 
    def open_branch(self, name=None, unsupported=False,
327
 
                    ignore_fallbacks=False):
328
 
        if unsupported:
 
205
    def open_branch(self, _unsupported=False):
 
206
        if _unsupported:
329
207
            raise NotImplementedError('unsupported flag support not implemented yet.')
330
208
        if self._next_open_branch_result is not None:
331
209
            # See create_branch for details.
332
210
            result = self._next_open_branch_result
333
211
            self._next_open_branch_result = None
334
212
            return result
335
 
        response = self._get_branch_reference()
336
 
        if response[0] == 'ref':
 
213
        reference_url = self.get_branch_reference()
 
214
        if reference_url is None:
 
215
            # branch at this location.
 
216
            return RemoteBranch(self, self.find_repository())
 
217
        else:
337
218
            # a branch reference, use the existing BranchReference logic.
338
219
            format = BranchReferenceFormat()
339
 
            return format.open(self, name=name, _found=True,
340
 
                location=response[1], ignore_fallbacks=ignore_fallbacks)
341
 
        branch_format_name = response[1]
342
 
        if not branch_format_name:
343
 
            branch_format_name = None
344
 
        format = RemoteBranchFormat(network_name=branch_format_name)
345
 
        return RemoteBranch(self, self.find_repository(), format=format,
346
 
            setup_stacking=not ignore_fallbacks, name=name)
347
 
 
348
 
    def _open_repo_v1(self, path):
349
 
        verb = 'BzrDir.find_repository'
350
 
        response = self._call(verb, path)
351
 
        if response[0] != 'ok':
352
 
            raise errors.UnexpectedSmartServerResponse(response)
353
 
        # servers that only support the v1 method don't support external
354
 
        # references either.
355
 
        self._ensure_real()
356
 
        repo = self._real_bzrdir.open_repository()
357
 
        response = response + ('no', repo._format.network_name())
358
 
        return response, repo
359
 
 
360
 
    def _open_repo_v2(self, path):
 
220
            return format.open(self, _found=True, location=reference_url)
 
221
 
 
222
    def open_repository(self):
 
223
        path = self._path_for_remote_call(self._client)
361
224
        verb = 'BzrDir.find_repositoryV2'
362
 
        response = self._call(verb, path)
363
 
        if response[0] != 'ok':
364
 
            raise errors.UnexpectedSmartServerResponse(response)
365
 
        self._ensure_real()
366
 
        repo = self._real_bzrdir.open_repository()
367
 
        response = response + (repo._format.network_name(),)
368
 
        return response, repo
369
 
 
370
 
    def _open_repo_v3(self, path):
371
 
        verb = 'BzrDir.find_repositoryV3'
372
 
        medium = self._client._medium
373
 
        if medium._is_remote_before((1, 13)):
374
 
            raise errors.UnknownSmartMethod(verb)
375
225
        try:
376
226
            response = self._call(verb, path)
377
227
        except errors.UnknownSmartMethod:
378
 
            medium._remember_remote_is_before((1, 13))
379
 
            raise
380
 
        if response[0] != 'ok':
381
 
            raise errors.UnexpectedSmartServerResponse(response)
382
 
        return response, None
383
 
 
384
 
    def open_repository(self):
385
 
        path = self._path_for_remote_call(self._client)
386
 
        response = None
387
 
        for probe in [self._open_repo_v3, self._open_repo_v2,
388
 
            self._open_repo_v1]:
389
 
            try:
390
 
                response, real_repo = probe(path)
391
 
                break
392
 
            except errors.UnknownSmartMethod:
393
 
                pass
394
 
        if response is None:
395
 
            raise errors.UnknownSmartMethod('BzrDir.find_repository{3,2,}')
396
 
        if response[0] != 'ok':
397
 
            raise errors.UnexpectedSmartServerResponse(response)
398
 
        if len(response) != 6:
 
228
            verb = 'BzrDir.find_repository'
 
229
            response = self._call(verb, path)
 
230
        if response[0] != 'ok':
 
231
            raise errors.UnexpectedSmartServerResponse(response)
 
232
        if verb == 'BzrDir.find_repository':
 
233
            # servers that don't support the V2 method don't support external
 
234
            # references either.
 
235
            response = response + ('no', )
 
236
        if not (len(response) == 5):
399
237
            raise SmartProtocolError('incorrect response length %s' % (response,))
400
238
        if response[1] == '':
401
 
            # repo is at this dir.
402
 
            format = response_tuple_to_repo_format(response[2:])
 
239
            format = RemoteRepositoryFormat()
 
240
            format.rich_root_data = (response[2] == 'yes')
 
241
            format.supports_tree_reference = (response[3] == 'yes')
 
242
            # No wire format to check this yet.
 
243
            format.supports_external_lookups = (response[4] == 'yes')
403
244
            # Used to support creating a real format instance when needed.
404
245
            format._creating_bzrdir = self
405
246
            remote_repo = RemoteRepository(self, format)
406
247
            format._creating_repo = remote_repo
407
 
            if real_repo is not None:
408
 
                remote_repo._set_real_repository(real_repo)
409
248
            return remote_repo
410
249
        else:
411
250
            raise errors.NoRepositoryPresent(self)
412
251
 
413
 
    def has_workingtree(self):
414
 
        if self._has_working_tree is None:
415
 
            self._ensure_real()
416
 
            self._has_working_tree = self._real_bzrdir.has_workingtree()
417
 
        return self._has_working_tree
418
 
 
419
252
    def open_workingtree(self, recommend_upgrade=True):
420
 
        if self.has_workingtree():
 
253
        self._ensure_real()
 
254
        if self._real_bzrdir.has_workingtree():
421
255
            raise errors.NotLocalUrl(self.root_transport)
422
256
        else:
423
257
            raise errors.NoWorkingTree(self.root_transport.base)
426
260
        """Return the path to be used for this bzrdir in a remote call."""
427
261
        return client.remote_path_from_transport(self.root_transport)
428
262
 
429
 
    def get_branch_transport(self, branch_format, name=None):
 
263
    def get_branch_transport(self, branch_format):
430
264
        self._ensure_real()
431
 
        return self._real_bzrdir.get_branch_transport(branch_format, name=name)
 
265
        return self._real_bzrdir.get_branch_transport(branch_format)
432
266
 
433
267
    def get_repository_transport(self, repository_format):
434
268
        self._ensure_real()
455
289
        return self._real_bzrdir.clone(url, revision_id=revision_id,
456
290
            force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
457
291
 
458
 
    def _get_config(self):
459
 
        return RemoteBzrDirConfig(self)
 
292
    def get_config(self):
 
293
        self._ensure_real()
 
294
        return self._real_bzrdir.get_config()
460
295
 
461
296
 
462
297
class RemoteRepositoryFormat(repository.RepositoryFormat):
486
321
        self._custom_format = None
487
322
        self._network_name = None
488
323
        self._creating_bzrdir = None
489
 
        self._supports_chks = None
490
 
        self._supports_external_lookups = None
491
 
        self._supports_tree_reference = None
492
 
        self._rich_root_data = None
493
 
 
494
 
    def __repr__(self):
495
 
        return "%s(_network_name=%r)" % (self.__class__.__name__,
496
 
            self._network_name)
497
 
 
498
 
    @property
499
 
    def fast_deltas(self):
500
 
        self._ensure_real()
501
 
        return self._custom_format.fast_deltas
502
 
 
503
 
    @property
504
 
    def rich_root_data(self):
505
 
        if self._rich_root_data is None:
506
 
            self._ensure_real()
507
 
            self._rich_root_data = self._custom_format.rich_root_data
508
 
        return self._rich_root_data
509
 
 
510
 
    @property
511
 
    def supports_chks(self):
512
 
        if self._supports_chks is None:
513
 
            self._ensure_real()
514
 
            self._supports_chks = self._custom_format.supports_chks
515
 
        return self._supports_chks
516
 
 
517
 
    @property
518
 
    def supports_external_lookups(self):
519
 
        if self._supports_external_lookups is None:
520
 
            self._ensure_real()
521
 
            self._supports_external_lookups = \
522
 
                self._custom_format.supports_external_lookups
523
 
        return self._supports_external_lookups
524
 
 
525
 
    @property
526
 
    def supports_tree_reference(self):
527
 
        if self._supports_tree_reference is None:
528
 
            self._ensure_real()
529
 
            self._supports_tree_reference = \
530
 
                self._custom_format.supports_tree_reference
531
 
        return self._supports_tree_reference
532
324
 
533
325
    def _vfs_initialize(self, a_bzrdir, shared):
534
326
        """Helper for common code in initialize."""
566
358
        # 1) get the network name to use.
567
359
        if self._custom_format:
568
360
            network_name = self._custom_format.network_name()
569
 
        elif self._network_name:
570
 
            network_name = self._network_name
571
361
        else:
572
362
            # Select the current bzrlib default and ask for that.
573
363
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
584
374
            response = a_bzrdir._call(verb, path, network_name, shared_str)
585
375
        except errors.UnknownSmartMethod:
586
376
            # Fallback - use vfs methods
587
 
            medium._remember_remote_is_before((1, 13))
588
377
            return self._vfs_initialize(a_bzrdir, shared)
589
378
        else:
590
379
            # Turn the response into a RemoteRepository object.
600
389
            raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
601
390
        return a_bzrdir.open_repository()
602
391
 
603
 
    def _ensure_real(self):
604
 
        if self._custom_format is None:
605
 
            self._custom_format = repository.network_format_registry.get(
606
 
                self._network_name)
607
 
 
608
 
    @property
609
 
    def _fetch_order(self):
610
 
        self._ensure_real()
611
 
        return self._custom_format._fetch_order
612
 
 
613
 
    @property
614
 
    def _fetch_uses_deltas(self):
615
 
        self._ensure_real()
616
 
        return self._custom_format._fetch_uses_deltas
617
 
 
618
 
    @property
619
 
    def _fetch_reconcile(self):
620
 
        self._ensure_real()
621
 
        return self._custom_format._fetch_reconcile
622
 
 
623
392
    def get_format_description(self):
624
 
        self._ensure_real()
625
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
393
        return 'bzr remote repository'
626
394
 
627
395
    def __eq__(self, other):
628
 
        return self.__class__ is other.__class__
 
396
        return self.__class__ == other.__class__
 
397
 
 
398
    def check_conversion_target(self, target_format):
 
399
        if self.rich_root_data and not target_format.rich_root_data:
 
400
            raise errors.BadConversionTarget(
 
401
                'Does not support rich root data.', target_format)
 
402
        if (self.supports_tree_reference and
 
403
            not getattr(target_format, 'supports_tree_reference', False)):
 
404
            raise errors.BadConversionTarget(
 
405
                'Does not support nested trees', target_format)
629
406
 
630
407
    def network_name(self):
631
408
        if self._network_name:
634
411
        return self._creating_repo._real_repository._format.network_name()
635
412
 
636
413
    @property
637
 
    def pack_compresses(self):
638
 
        self._ensure_real()
639
 
        return self._custom_format.pack_compresses
640
 
 
641
 
    @property
642
414
    def _serializer(self):
643
 
        self._ensure_real()
644
 
        return self._custom_format._serializer
645
 
 
646
 
 
647
 
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
648
 
    bzrdir.ControlComponent):
 
415
        if self._custom_format is not None:
 
416
            return self._custom_format._serializer
 
417
        elif self._network_name is not None:
 
418
            self._custom_format = repository.network_format_registry.get(
 
419
                self._network_name)
 
420
            return self._custom_format._serializer
 
421
        else:
 
422
            # We should only be getting asked for the serializer for
 
423
            # RemoteRepositoryFormat objects when the RemoteRepositoryFormat object
 
424
            # is a concrete instance for a RemoteRepository. In this case we know
 
425
            # the creating_repo and can use it to supply the serializer.
 
426
            self._creating_repo._ensure_real()
 
427
            return self._creating_repo._real_repository._format._serializer
 
428
 
 
429
 
 
430
class RemoteRepository(_RpcHelper):
649
431
    """Repository accessed over rpc.
650
432
 
651
433
    For the moment most operations are performed using local transport-backed
677
459
        self._lock_token = None
678
460
        self._lock_count = 0
679
461
        self._leave_lock = False
680
 
        # Cache of revision parents; misses are cached during read locks, and
681
 
        # write locks when no _real_repository has been set.
682
462
        self._unstacked_provider = graph.CachingParentsProvider(
683
463
            get_parent_map=self._get_parent_map_rpc)
684
464
        self._unstacked_provider.disable_cache()
694
474
        # Additional places to query for data.
695
475
        self._fallback_repositories = []
696
476
 
697
 
    @property
698
 
    def user_transport(self):
699
 
        return self.bzrdir.user_transport
700
 
 
701
 
    @property
702
 
    def control_transport(self):
703
 
        # XXX: Normally you shouldn't directly get at the remote repository
704
 
        # transport, but I'm not sure it's worth making this method
705
 
        # optional -- mbp 2010-04-21
706
 
        return self.bzrdir.get_repository_transport(None)
707
 
        
708
477
    def __str__(self):
709
478
        return "%s(%s)" % (self.__class__.__name__, self.base)
710
479
 
713
482
    def abort_write_group(self, suppress_errors=False):
714
483
        """Complete a write group on the decorated repository.
715
484
 
716
 
        Smart methods perform operations in a single step so this API
 
485
        Smart methods peform operations in a single step so this api
717
486
        is not really applicable except as a compatibility thunk
718
487
        for older plugins that don't use e.g. the CommitBuilder
719
488
        facility.
724
493
        return self._real_repository.abort_write_group(
725
494
            suppress_errors=suppress_errors)
726
495
 
727
 
    @property
728
 
    def chk_bytes(self):
729
 
        """Decorate the real repository for now.
730
 
 
731
 
        In the long term a full blown network facility is needed to avoid
732
 
        creating a real repository object locally.
733
 
        """
734
 
        self._ensure_real()
735
 
        return self._real_repository.chk_bytes
736
 
 
737
496
    def commit_write_group(self):
738
497
        """Complete a write group on the decorated repository.
739
498
 
740
 
        Smart methods perform operations in a single step so this API
 
499
        Smart methods peform operations in a single step so this api
741
500
        is not really applicable except as a compatibility thunk
742
501
        for older plugins that don't use e.g. the CommitBuilder
743
502
        facility.
753
512
        self._ensure_real()
754
513
        return self._real_repository.suspend_write_group()
755
514
 
756
 
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
757
 
        self._ensure_real()
758
 
        return self._real_repository.get_missing_parent_inventories(
759
 
            check_for_missing_texts=check_for_missing_texts)
760
 
 
761
 
    def _get_rev_id_for_revno_vfs(self, revno, known_pair):
762
 
        self._ensure_real()
763
 
        return self._real_repository.get_rev_id_for_revno(
764
 
            revno, known_pair)
765
 
 
766
 
    def get_rev_id_for_revno(self, revno, known_pair):
767
 
        """See Repository.get_rev_id_for_revno."""
768
 
        path = self.bzrdir._path_for_remote_call(self._client)
769
 
        try:
770
 
            if self._client._medium._is_remote_before((1, 17)):
771
 
                return self._get_rev_id_for_revno_vfs(revno, known_pair)
772
 
            response = self._call(
773
 
                'Repository.get_rev_id_for_revno', path, revno, known_pair)
774
 
        except errors.UnknownSmartMethod:
775
 
            self._client._medium._remember_remote_is_before((1, 17))
776
 
            return self._get_rev_id_for_revno_vfs(revno, known_pair)
777
 
        if response[0] == 'ok':
778
 
            return True, response[1]
779
 
        elif response[0] == 'history-incomplete':
780
 
            known_pair = response[1:3]
781
 
            for fallback in self._fallback_repositories:
782
 
                found, result = fallback.get_rev_id_for_revno(revno, known_pair)
783
 
                if found:
784
 
                    return True, result
785
 
                else:
786
 
                    known_pair = result
787
 
            # Not found in any fallbacks
788
 
            return False, known_pair
789
 
        else:
790
 
            raise errors.UnexpectedSmartServerResponse(response)
791
 
 
792
515
    def _ensure_real(self):
793
516
        """Ensure that there is a _real_repository set.
794
517
 
795
518
        Used before calls to self._real_repository.
796
 
 
797
 
        Note that _ensure_real causes many roundtrips to the server which are
798
 
        not desirable, and prevents the use of smart one-roundtrip RPC's to
799
 
        perform complex operations (such as accessing parent data, streaming
800
 
        revisions etc). Adding calls to _ensure_real should only be done when
801
 
        bringing up new functionality, adding fallbacks for smart methods that
802
 
        require a fallback path, and never to replace an existing smart method
803
 
        invocation. If in doubt chat to the bzr network team.
804
519
        """
805
520
        if self._real_repository is None:
806
 
            if 'hpssvfs' in debug.debug_flags:
807
 
                import traceback
808
 
                warning('VFS Repository access triggered\n%s',
809
 
                    ''.join(traceback.format_stack()))
810
 
            self._unstacked_provider.missing_keys.clear()
811
521
            self.bzrdir._ensure_real()
812
522
            self._set_real_repository(
813
523
                self.bzrdir._real_bzrdir.open_repository())
840
550
        self._ensure_real()
841
551
        return self._real_repository._generate_text_key_index()
842
552
 
 
553
    @symbol_versioning.deprecated_method(symbol_versioning.one_four)
 
554
    def get_revision_graph(self, revision_id=None):
 
555
        """See Repository.get_revision_graph()."""
 
556
        return self._get_revision_graph(revision_id)
 
557
 
843
558
    def _get_revision_graph(self, revision_id):
844
559
        """Private method for using with old (< 1.2) servers to fallback."""
845
560
        if revision_id is None:
869
584
        """See Repository._get_sink()."""
870
585
        return RemoteStreamSink(self)
871
586
 
872
 
    def _get_source(self, to_format):
873
 
        """Return a source for streaming from this repository."""
874
 
        return RemoteStreamSource(self, to_format)
875
 
 
876
 
    @needs_read_lock
877
587
    def has_revision(self, revision_id):
878
 
        """True if this repository has a copy of the revision."""
879
 
        # Copy of bzrlib.repository.Repository.has_revision
880
 
        return revision_id in self.has_revisions((revision_id,))
 
588
        """See Repository.has_revision()."""
 
589
        if revision_id == NULL_REVISION:
 
590
            # The null revision is always present.
 
591
            return True
 
592
        path = self.bzrdir._path_for_remote_call(self._client)
 
593
        response = self._call('Repository.has_revision', path, revision_id)
 
594
        if response[0] not in ('yes', 'no'):
 
595
            raise errors.UnexpectedSmartServerResponse(response)
 
596
        if response[0] == 'yes':
 
597
            return True
 
598
        for fallback_repo in self._fallback_repositories:
 
599
            if fallback_repo.has_revision(revision_id):
 
600
                return True
 
601
        return False
881
602
 
882
 
    @needs_read_lock
883
603
    def has_revisions(self, revision_ids):
884
 
        """Probe to find out the presence of multiple revisions.
885
 
 
886
 
        :param revision_ids: An iterable of revision_ids.
887
 
        :return: A set of the revision_ids that were present.
888
 
        """
889
 
        # Copy of bzrlib.repository.Repository.has_revisions
890
 
        parent_map = self.get_parent_map(revision_ids)
891
 
        result = set(parent_map)
892
 
        if _mod_revision.NULL_REVISION in revision_ids:
893
 
            result.add(_mod_revision.NULL_REVISION)
 
604
        """See Repository.has_revisions()."""
 
605
        # FIXME: This does many roundtrips, particularly when there are
 
606
        # fallback repositories.  -- mbp 20080905
 
607
        result = set()
 
608
        for revision_id in revision_ids:
 
609
            if self.has_revision(revision_id):
 
610
                result.add(revision_id)
894
611
        return result
895
612
 
896
 
    def _has_same_fallbacks(self, other_repo):
897
 
        """Returns true if the repositories have the same fallbacks."""
898
 
        # XXX: copied from Repository; it should be unified into a base class
899
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401622>
900
 
        my_fb = self._fallback_repositories
901
 
        other_fb = other_repo._fallback_repositories
902
 
        if len(my_fb) != len(other_fb):
903
 
            return False
904
 
        for f, g in zip(my_fb, other_fb):
905
 
            if not f.has_same_location(g):
906
 
                return False
907
 
        return True
908
 
 
909
613
    def has_same_location(self, other):
910
 
        # TODO: Move to RepositoryBase and unify with the regular Repository
911
 
        # one; unfortunately the tests rely on slightly different behaviour at
912
 
        # present -- mbp 20090710
913
 
        return (self.__class__ is other.__class__ and
 
614
        return (self.__class__ == other.__class__ and
914
615
                self.bzrdir.transport.base == other.bzrdir.transport.base)
915
616
 
916
617
    def get_graph(self, other_repository=None):
918
619
        parents_provider = self._make_parents_provider(other_repository)
919
620
        return graph.Graph(parents_provider)
920
621
 
921
 
    @needs_read_lock
922
 
    def get_known_graph_ancestry(self, revision_ids):
923
 
        """Return the known graph for a set of revision ids and their ancestors.
924
 
        """
925
 
        st = static_tuple.StaticTuple
926
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
927
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
928
 
        return graph.GraphThunkIdsToKeys(known_graph)
929
 
 
930
622
    def gather_stats(self, revid=None, committers=None):
931
623
        """See Repository.gather_stats()."""
932
624
        path = self.bzrdir._path_for_remote_call(self._client)
992
684
    def is_write_locked(self):
993
685
        return self._lock_mode == 'w'
994
686
 
995
 
    def _warn_if_deprecated(self, branch=None):
996
 
        # If we have a real repository, the check will be done there, if we
997
 
        # don't the check will be done remotely.
998
 
        pass
999
 
 
1000
687
    def lock_read(self):
1001
 
        """Lock the repository for read operations.
1002
 
 
1003
 
        :return: An object with an unlock method which will release the lock
1004
 
            obtained.
1005
 
        """
1006
688
        # wrong eventually - want a local lock cache context
1007
689
        if not self._lock_mode:
1008
 
            self._note_lock('r')
1009
690
            self._lock_mode = 'r'
1010
691
            self._lock_count = 1
1011
 
            self._unstacked_provider.enable_cache(cache_misses=True)
 
692
            self._unstacked_provider.enable_cache(cache_misses=False)
1012
693
            if self._real_repository is not None:
1013
694
                self._real_repository.lock_read()
1014
 
            for repo in self._fallback_repositories:
1015
 
                repo.lock_read()
1016
695
        else:
1017
696
            self._lock_count += 1
1018
 
        return self
1019
697
 
1020
698
    def _remote_lock_write(self, token):
1021
699
        path = self.bzrdir._path_for_remote_call(self._client)
1032
710
 
1033
711
    def lock_write(self, token=None, _skip_rpc=False):
1034
712
        if not self._lock_mode:
1035
 
            self._note_lock('w')
1036
713
            if _skip_rpc:
1037
714
                if self._lock_token is not None:
1038
715
                    if token != self._lock_token:
1052
729
                self._leave_lock = False
1053
730
            self._lock_mode = 'w'
1054
731
            self._lock_count = 1
1055
 
            cache_misses = self._real_repository is None
1056
 
            self._unstacked_provider.enable_cache(cache_misses=cache_misses)
1057
 
            for repo in self._fallback_repositories:
1058
 
                # Writes don't affect fallback repos
1059
 
                repo.lock_read()
 
732
            self._unstacked_provider.enable_cache(cache_misses=False)
1060
733
        elif self._lock_mode == 'r':
1061
734
            raise errors.ReadOnlyError(self)
1062
735
        else:
1063
736
            self._lock_count += 1
1064
 
        return RepositoryWriteLockResult(self.unlock, self._lock_token or None)
 
737
        return self._lock_token or None
1065
738
 
1066
739
    def leave_lock_in_place(self):
1067
740
        if not self._lock_token:
1080
753
            implemented operations.
1081
754
        """
1082
755
        if self._real_repository is not None:
1083
 
            # Replacing an already set real repository.
1084
 
            # We cannot do this [currently] if the repository is locked -
1085
 
            # synchronised state might be lost.
1086
 
            if self.is_locked():
1087
 
                raise AssertionError('_real_repository is already set')
 
756
            raise AssertionError('_real_repository is already set')
1088
757
        if isinstance(repository, RemoteRepository):
1089
758
            raise AssertionError()
1090
759
        self._real_repository = repository
1091
 
        # three code paths happen here:
1092
 
        # 1) old servers, RemoteBranch.open() calls _ensure_real before setting
1093
 
        # up stacking. In this case self._fallback_repositories is [], and the
1094
 
        # real repo is already setup. Preserve the real repo and
1095
 
        # RemoteRepository.add_fallback_repository will avoid adding
1096
 
        # duplicates.
1097
 
        # 2) new servers, RemoteBranch.open() sets up stacking, and when
1098
 
        # ensure_real is triggered from a branch, the real repository to
1099
 
        # set already has a matching list with separate instances, but
1100
 
        # as they are also RemoteRepositories we don't worry about making the
1101
 
        # lists be identical.
1102
 
        # 3) new servers, RemoteRepository.ensure_real is triggered before
1103
 
        # RemoteBranch.ensure real, in this case we get a repo with no fallbacks
1104
 
        # and need to populate it.
1105
 
        if (self._fallback_repositories and
1106
 
            len(self._real_repository._fallback_repositories) !=
1107
 
            len(self._fallback_repositories)):
1108
 
            if len(self._real_repository._fallback_repositories):
1109
 
                raise AssertionError(
1110
 
                    "cannot cleanly remove existing _fallback_repositories")
1111
760
        for fb in self._fallback_repositories:
1112
761
            self._real_repository.add_fallback_repository(fb)
1113
762
        if self._lock_mode == 'w':
1120
769
    def start_write_group(self):
1121
770
        """Start a write group on the decorated repository.
1122
771
 
1123
 
        Smart methods perform operations in a single step so this API
 
772
        Smart methods peform operations in a single step so this api
1124
773
        is not really applicable except as a compatibility thunk
1125
774
        for older plugins that don't use e.g. the CommitBuilder
1126
775
        facility.
1141
790
        else:
1142
791
            raise errors.UnexpectedSmartServerResponse(response)
1143
792
 
1144
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1145
793
    def unlock(self):
1146
794
        if not self._lock_count:
1147
 
            return lock.cant_unlock_not_held(self)
 
795
            raise errors.LockNotHeld(self)
1148
796
        self._lock_count -= 1
1149
797
        if self._lock_count > 0:
1150
798
            return
1164
812
            # problem releasing the vfs-based lock.
1165
813
            if old_mode == 'w':
1166
814
                # Only write-locked repositories need to make a remote method
1167
 
                # call to perform the unlock.
 
815
                # call to perfom the unlock.
1168
816
                old_token = self._lock_token
1169
817
                self._lock_token = None
1170
818
                if not self._leave_lock:
1171
819
                    self._unlock(old_token)
1172
 
        # Fallbacks are always 'lock_read()' so we don't pay attention to
1173
 
        # self._leave_lock
1174
 
        for repo in self._fallback_repositories:
1175
 
            repo.unlock()
1176
820
 
1177
821
    def break_lock(self):
1178
822
        # should hand off to the network
1236
880
 
1237
881
        :param repository: A repository.
1238
882
        """
1239
 
        if not self._format.supports_external_lookups:
1240
 
            raise errors.UnstackableRepositoryFormat(
1241
 
                self._format.network_name(), self.base)
 
883
        # XXX: At the moment the RemoteRepository will allow fallbacks
 
884
        # unconditionally - however, a _real_repository will usually exist,
 
885
        # and may raise an error if it's not accommodated by the underlying
 
886
        # format.  Eventually we should check when opening the repository
 
887
        # whether it's willing to allow them or not.
 
888
        #
1242
889
        # We need to accumulate additional repositories here, to pass them in
1243
890
        # on various RPC's.
1244
891
        #
1245
 
        if self.is_locked():
1246
 
            # We will call fallback.unlock() when we transition to the unlocked
1247
 
            # state, so always add a lock here. If a caller passes us a locked
1248
 
            # repository, they are responsible for unlocking it later.
1249
 
            repository.lock_read()
1250
 
        self._check_fallback_repository(repository)
1251
892
        self._fallback_repositories.append(repository)
1252
893
        # If self._real_repository was parameterised already (e.g. because a
1253
894
        # _real_branch had its get_stacked_on_url method called), then the
1254
895
        # repository to be added may already be in the _real_repositories list.
1255
896
        if self._real_repository is not None:
1256
 
            fallback_locations = [repo.user_url for repo in
1257
 
                self._real_repository._fallback_repositories]
1258
 
            if repository.user_url not in fallback_locations:
 
897
            if repository not in self._real_repository._fallback_repositories:
1259
898
                self._real_repository.add_fallback_repository(repository)
1260
 
 
1261
 
    def _check_fallback_repository(self, repository):
1262
 
        """Check that this repository can fallback to repository safely.
1263
 
 
1264
 
        Raise an error if not.
1265
 
 
1266
 
        :param repository: A repository to fallback to.
1267
 
        """
1268
 
        return _mod_repository.InterRepository._assert_same_model(
1269
 
            self, repository)
 
899
        else:
 
900
            # They are also seen by the fallback repository.  If it doesn't
 
901
            # exist yet they'll be added then.  This implicitly copies them.
 
902
            self._ensure_real()
1270
903
 
1271
904
    def add_inventory(self, revid, inv, parents):
1272
905
        self._ensure_real()
1273
906
        return self._real_repository.add_inventory(revid, inv, parents)
1274
907
 
1275
908
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1276
 
            parents, basis_inv=None, propagate_caches=False):
 
909
                               parents):
1277
910
        self._ensure_real()
1278
911
        return self._real_repository.add_inventory_by_delta(basis_revision_id,
1279
 
            delta, new_revision_id, parents, basis_inv=basis_inv,
1280
 
            propagate_caches=propagate_caches)
 
912
            delta, new_revision_id, parents)
1281
913
 
1282
914
    def add_revision(self, rev_id, rev, inv=None, config=None):
1283
915
        self._ensure_real()
1289
921
        self._ensure_real()
1290
922
        return self._real_repository.get_inventory(revision_id)
1291
923
 
1292
 
    def iter_inventories(self, revision_ids, ordering=None):
 
924
    def iter_inventories(self, revision_ids):
1293
925
        self._ensure_real()
1294
 
        return self._real_repository.iter_inventories(revision_ids, ordering)
 
926
        return self._real_repository.iter_inventories(revision_ids)
1295
927
 
1296
928
    @needs_read_lock
1297
929
    def get_revision(self, revision_id):
1312
944
        self._ensure_real()
1313
945
        return self._real_repository.make_working_trees()
1314
946
 
1315
 
    def refresh_data(self):
1316
 
        """Re-read any data needed to to synchronise with disk.
1317
 
 
1318
 
        This method is intended to be called after another repository instance
1319
 
        (such as one used by a smart server) has inserted data into the
1320
 
        repository. It may not be called during a write group, but may be
1321
 
        called at any other time.
1322
 
        """
1323
 
        if self.is_in_write_group():
1324
 
            raise errors.InternalBzrError(
1325
 
                "May not refresh_data while in a write group.")
1326
 
        if self._real_repository is not None:
1327
 
            self._real_repository.refresh_data()
1328
 
 
1329
947
    def revision_ids_to_search_result(self, result_set):
1330
948
        """Convert a set of revision ids to a graph SearchResult."""
1331
949
        result_parents = set()
1350
968
        return repository.InterRepository.get(
1351
969
            other, self).search_missing_revision_ids(revision_id, find_ghosts)
1352
970
 
1353
 
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1354
 
            fetch_spec=None):
1355
 
        # No base implementation to use as RemoteRepository is not a subclass
1356
 
        # of Repository; so this is a copy of Repository.fetch().
1357
 
        if fetch_spec is not None and revision_id is not None:
1358
 
            raise AssertionError(
1359
 
                "fetch_spec and revision_id are mutually exclusive.")
1360
 
        if self.is_in_write_group():
1361
 
            raise errors.InternalBzrError(
1362
 
                "May not fetch while in a write group.")
1363
 
        # fast path same-url fetch operations
1364
 
        if (self.has_same_location(source)
1365
 
            and fetch_spec is None
1366
 
            and self._has_same_fallbacks(source)):
 
971
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False):
 
972
        # Not delegated to _real_repository so that InterRepository.get has a
 
973
        # chance to find an InterRepository specialised for RemoteRepository.
 
974
        if self.has_same_location(source):
1367
975
            # check that last_revision is in 'from' and then return a
1368
976
            # no-operation.
1369
977
            if (revision_id is not None and
1370
978
                not revision.is_null(revision_id)):
1371
979
                self.get_revision(revision_id)
1372
980
            return 0, []
1373
 
        # if there is no specific appropriate InterRepository, this will get
1374
 
        # the InterRepository base class, which raises an
1375
 
        # IncompatibleRepositories when asked to fetch.
1376
981
        inter = repository.InterRepository.get(source, self)
1377
 
        return inter.fetch(revision_id=revision_id, pb=pb,
1378
 
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
 
982
        try:
 
983
            return inter.fetch(revision_id=revision_id, pb=pb, find_ghosts=find_ghosts)
 
984
        except NotImplementedError:
 
985
            raise errors.IncompatibleRepositories(source, self)
1379
986
 
1380
987
    def create_bundle(self, target, base, fileobj, format=None):
1381
988
        self._ensure_real()
1401
1008
        self._ensure_real()
1402
1009
        return self._real_repository.iter_files_bytes(desired_files)
1403
1010
 
 
1011
    @property
 
1012
    def _fetch_order(self):
 
1013
        """Decorate the real repository for now.
 
1014
 
 
1015
        In the long term getting this back from the remote repository as part
 
1016
        of open would be more efficient.
 
1017
        """
 
1018
        self._ensure_real()
 
1019
        return self._real_repository._fetch_order
 
1020
 
 
1021
    @property
 
1022
    def _fetch_uses_deltas(self):
 
1023
        """Decorate the real repository for now.
 
1024
 
 
1025
        In the long term getting this back from the remote repository as part
 
1026
        of open would be more efficient.
 
1027
        """
 
1028
        self._ensure_real()
 
1029
        return self._real_repository._fetch_uses_deltas
 
1030
 
 
1031
    @property
 
1032
    def _fetch_reconcile(self):
 
1033
        """Decorate the real repository for now.
 
1034
 
 
1035
        In the long term getting this back from the remote repository as part
 
1036
        of open would be more efficient.
 
1037
        """
 
1038
        self._ensure_real()
 
1039
        return self._real_repository._fetch_reconcile
 
1040
 
1404
1041
    def get_parent_map(self, revision_ids):
1405
1042
        """See bzrlib.Graph.get_parent_map()."""
1406
1043
        return self._make_parents_provider().get_parent_map(revision_ids)
1412
1049
            # We already found out that the server can't understand
1413
1050
            # Repository.get_parent_map requests, so just fetch the whole
1414
1051
            # graph.
1415
 
            #
1416
 
            # Note that this reads the whole graph, when only some keys are
1417
 
            # wanted.  On this old server there's no way (?) to get them all
1418
 
            # in one go, and the user probably will have seen a warning about
1419
 
            # the server being old anyhow.
1420
 
            rg = self._get_revision_graph(None)
1421
 
            # There is an API discrepancy between get_parent_map and
 
1052
            # XXX: Note that this will issue a deprecation warning. This is ok
 
1053
            # :- its because we're working with a deprecated server anyway, and
 
1054
            # the user will almost certainly have seen a warning about the
 
1055
            # server version already.
 
1056
            rg = self.get_revision_graph()
 
1057
            # There is an api discrepency between get_parent_map and
1422
1058
            # get_revision_graph. Specifically, a "key:()" pair in
1423
1059
            # get_revision_graph just means a node has no parents. For
1424
1060
            # "get_parent_map" it means the node is a ghost. So fix up the
1454
1090
        # TODO: Manage this incrementally to avoid covering the same path
1455
1091
        # repeatedly. (The server will have to on each request, but the less
1456
1092
        # work done the better).
1457
 
        #
1458
 
        # Negative caching notes:
1459
 
        # new server sends missing when a request including the revid
1460
 
        # 'include-missing:' is present in the request.
1461
 
        # missing keys are serialised as missing:X, and we then call
1462
 
        # provider.note_missing(X) for-all X
1463
1093
        parents_map = self._unstacked_provider.get_cached_map()
1464
1094
        if parents_map is None:
1465
1095
            # Repository is not locked, so there's no cache.
1466
1096
            parents_map = {}
1467
 
        # start_set is all the keys in the cache
1468
1097
        start_set = set(parents_map)
1469
 
        # result set is all the references to keys in the cache
1470
1098
        result_parents = set()
1471
1099
        for parents in parents_map.itervalues():
1472
1100
            result_parents.update(parents)
1473
1101
        stop_keys = result_parents.difference(start_set)
1474
 
        # We don't need to send ghosts back to the server as a position to
1475
 
        # stop either.
1476
 
        stop_keys.difference_update(self._unstacked_provider.missing_keys)
1477
 
        key_count = len(parents_map)
1478
 
        if (NULL_REVISION in result_parents
1479
 
            and NULL_REVISION in self._unstacked_provider.missing_keys):
1480
 
            # If we pruned NULL_REVISION from the stop_keys because it's also
1481
 
            # in our cache of "missing" keys we need to increment our key count
1482
 
            # by 1, because the reconsitituted SearchResult on the server will
1483
 
            # still consider NULL_REVISION to be an included key.
1484
 
            key_count += 1
1485
1102
        included_keys = start_set.intersection(result_parents)
1486
1103
        start_set.difference_update(included_keys)
1487
 
        recipe = ('manual', start_set, stop_keys, key_count)
 
1104
        recipe = (start_set, stop_keys, len(parents_map))
1488
1105
        body = self._serialise_search_recipe(recipe)
1489
1106
        path = self.bzrdir._path_for_remote_call(self._client)
1490
1107
        for key in keys:
1492
1109
                raise ValueError(
1493
1110
                    "key %r not a plain string" % (key,))
1494
1111
        verb = 'Repository.get_parent_map'
1495
 
        args = (path, 'include-missing:') + tuple(keys)
 
1112
        args = (path,) + tuple(keys)
1496
1113
        try:
1497
1114
            response = self._call_with_body_bytes_expecting_body(
1498
1115
                verb, args, body)
1508
1125
            # To avoid having to disconnect repeatedly, we keep track of the
1509
1126
            # fact the server doesn't understand remote methods added in 1.2.
1510
1127
            medium._remember_remote_is_before((1, 2))
1511
 
            # Recurse just once and we should use the fallback code.
1512
 
            return self._get_parent_map_rpc(keys)
 
1128
            return self.get_revision_graph(None)
1513
1129
        response_tuple, response_handler = response
1514
1130
        if response_tuple[0] not in ['ok']:
1515
1131
            response_handler.cancel_read_body()
1526
1142
                if len(d) > 1:
1527
1143
                    revision_graph[d[0]] = d[1:]
1528
1144
                else:
1529
 
                    # No parents:
1530
 
                    if d[0].startswith('missing:'):
1531
 
                        revid = d[0][8:]
1532
 
                        self._unstacked_provider.note_missing_key(revid)
1533
 
                    else:
1534
 
                        # no parents - so give the Graph result
1535
 
                        # (NULL_REVISION,).
1536
 
                        revision_graph[d[0]] = (NULL_REVISION,)
 
1145
                    # No parents - so give the Graph result (NULL_REVISION,).
 
1146
                    revision_graph[d[0]] = (NULL_REVISION,)
1537
1147
            return revision_graph
1538
1148
 
1539
1149
    @needs_read_lock
1542
1152
        return self._real_repository.get_signature_text(revision_id)
1543
1153
 
1544
1154
    @needs_read_lock
1545
 
    def _get_inventory_xml(self, revision_id):
1546
 
        self._ensure_real()
1547
 
        return self._real_repository._get_inventory_xml(revision_id)
 
1155
    @symbol_versioning.deprecated_method(symbol_versioning.one_three)
 
1156
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
1157
        self._ensure_real()
 
1158
        return self._real_repository.get_revision_graph_with_ghosts(
 
1159
            revision_ids=revision_ids)
 
1160
 
 
1161
    @needs_read_lock
 
1162
    def get_inventory_xml(self, revision_id):
 
1163
        self._ensure_real()
 
1164
        return self._real_repository.get_inventory_xml(revision_id)
 
1165
 
 
1166
    def deserialise_inventory(self, revision_id, xml):
 
1167
        self._ensure_real()
 
1168
        return self._real_repository.deserialise_inventory(revision_id, xml)
1548
1169
 
1549
1170
    def reconcile(self, other=None, thorough=False):
1550
1171
        self._ensure_real()
1555
1176
        return self._real_repository.all_revision_ids()
1556
1177
 
1557
1178
    @needs_read_lock
1558
 
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
 
1179
    def get_deltas_for_revisions(self, revisions):
1559
1180
        self._ensure_real()
1560
 
        return self._real_repository.get_deltas_for_revisions(revisions,
1561
 
            specific_fileids=specific_fileids)
 
1181
        return self._real_repository.get_deltas_for_revisions(revisions)
1562
1182
 
1563
1183
    @needs_read_lock
1564
 
    def get_revision_delta(self, revision_id, specific_fileids=None):
 
1184
    def get_revision_delta(self, revision_id):
1565
1185
        self._ensure_real()
1566
 
        return self._real_repository.get_revision_delta(revision_id,
1567
 
            specific_fileids=specific_fileids)
 
1186
        return self._real_repository.get_revision_delta(revision_id)
1568
1187
 
1569
1188
    @needs_read_lock
1570
1189
    def revision_trees(self, revision_ids):
1577
1196
        return self._real_repository.get_revision_reconcile(revision_id)
1578
1197
 
1579
1198
    @needs_read_lock
1580
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
1199
    def check(self, revision_ids=None):
1581
1200
        self._ensure_real()
1582
 
        return self._real_repository.check(revision_ids=revision_ids,
1583
 
            callback_refs=callback_refs, check_repo=check_repo)
 
1201
        return self._real_repository.check(revision_ids=revision_ids)
1584
1202
 
1585
1203
    def copy_content_into(self, destination, revision_id=None):
1586
1204
        self._ensure_real()
1626
1244
        return self._real_repository.inventories
1627
1245
 
1628
1246
    @needs_write_lock
1629
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
1247
    def pack(self):
1630
1248
        """Compress the data within the repository.
1631
1249
 
1632
1250
        This is not currently implemented within the smart server.
1633
1251
        """
1634
1252
        self._ensure_real()
1635
 
        return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
 
1253
        return self._real_repository.pack()
1636
1254
 
1637
1255
    @property
1638
1256
    def revisions(self):
1693
1311
        return self._real_repository.get_revisions(revision_ids)
1694
1312
 
1695
1313
    def supports_rich_root(self):
1696
 
        return self._format.rich_root_data
 
1314
        self._ensure_real()
 
1315
        return self._real_repository.supports_rich_root()
1697
1316
 
1698
1317
    def iter_reverse_revision_history(self, revision_id):
1699
1318
        self._ensure_real()
1701
1320
 
1702
1321
    @property
1703
1322
    def _serializer(self):
1704
 
        return self._format._serializer
 
1323
        self._ensure_real()
 
1324
        return self._real_repository._serializer
1705
1325
 
1706
1326
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1707
1327
        self._ensure_real()
1726
1346
        self._ensure_real()
1727
1347
        return self._real_repository.revision_graph_can_have_wrong_parents()
1728
1348
 
1729
 
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
 
1349
    def _find_inconsistent_revision_parents(self):
1730
1350
        self._ensure_real()
1731
 
        return self._real_repository._find_inconsistent_revision_parents(
1732
 
            revisions_iterator)
 
1351
        return self._real_repository._find_inconsistent_revision_parents()
1733
1352
 
1734
1353
    def _check_for_inconsistent_revision_parents(self):
1735
1354
        self._ensure_real()
1741
1360
            providers.insert(0, other)
1742
1361
        providers.extend(r._make_parents_provider() for r in
1743
1362
                         self._fallback_repositories)
1744
 
        return graph.StackedParentsProvider(providers)
 
1363
        return graph._StackedParentsProvider(providers)
1745
1364
 
1746
1365
    def _serialise_search_recipe(self, recipe):
1747
1366
        """Serialise a graph search recipe.
1749
1368
        :param recipe: A search recipe (start, stop, count).
1750
1369
        :return: Serialised bytes.
1751
1370
        """
1752
 
        start_keys = ' '.join(recipe[1])
1753
 
        stop_keys = ' '.join(recipe[2])
1754
 
        count = str(recipe[3])
 
1371
        start_keys = ' '.join(recipe[0])
 
1372
        stop_keys = ' '.join(recipe[1])
 
1373
        count = str(recipe[2])
1755
1374
        return '\n'.join((start_keys, stop_keys, count))
1756
1375
 
1757
 
    def _serialise_search_result(self, search_result):
1758
 
        if isinstance(search_result, graph.PendingAncestryResult):
1759
 
            parts = ['ancestry-of']
1760
 
            parts.extend(search_result.heads)
1761
 
        else:
1762
 
            recipe = search_result.get_recipe()
1763
 
            parts = [recipe[0], self._serialise_search_recipe(recipe)]
1764
 
        return '\n'.join(parts)
1765
 
 
1766
1376
    def autopack(self):
1767
1377
        path = self.bzrdir._path_for_remote_call(self._client)
1768
1378
        try:
1771
1381
            self._ensure_real()
1772
1382
            self._real_repository._pack_collection.autopack()
1773
1383
            return
1774
 
        self.refresh_data()
 
1384
        if self._real_repository is not None:
 
1385
            # Reset the real repository's cache of pack names.
 
1386
            # XXX: At some point we may be able to skip this and just rely on
 
1387
            # the automatic retry logic to do the right thing, but for now we
 
1388
            # err on the side of being correct rather than being optimal.
 
1389
            self._real_repository._pack_collection.reload_pack_names()
1775
1390
        if response[0] != 'ok':
1776
1391
            raise errors.UnexpectedSmartServerResponse(response)
1777
1392
 
1778
1393
 
1779
1394
class RemoteStreamSink(repository.StreamSink):
1780
1395
 
 
1396
    def __init__(self, target_repo):
 
1397
        repository.StreamSink.__init__(self, target_repo)
 
1398
 
1781
1399
    def _insert_real(self, stream, src_format, resume_tokens):
1782
1400
        self.target_repo._ensure_real()
1783
1401
        sink = self.target_repo._real_repository._get_sink()
1787
1405
        return result
1788
1406
 
1789
1407
    def insert_stream(self, stream, src_format, resume_tokens):
1790
 
        target = self.target_repo
1791
 
        target._unstacked_provider.missing_keys.clear()
1792
 
        candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
1793
 
        if target._lock_token:
1794
 
            candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
1795
 
            lock_args = (target._lock_token or '',)
1796
 
        else:
1797
 
            candidate_calls.append(('Repository.insert_stream', (1, 13)))
1798
 
            lock_args = ()
1799
 
        client = target._client
 
1408
        repo = self.target_repo
 
1409
        client = repo._client
1800
1410
        medium = client._medium
1801
 
        path = target.bzrdir._path_for_remote_call(client)
1802
 
        # Probe for the verb to use with an empty stream before sending the
1803
 
        # real stream to it.  We do this both to avoid the risk of sending a
1804
 
        # large request that is then rejected, and because we don't want to
1805
 
        # implement a way to buffer, rewind, or restart the stream.
1806
 
        found_verb = False
1807
 
        for verb, required_version in candidate_calls:
1808
 
            if medium._is_remote_before(required_version):
1809
 
                continue
1810
 
            if resume_tokens:
1811
 
                # We've already done the probing (and set _is_remote_before) on
1812
 
                # a previous insert.
1813
 
                found_verb = True
1814
 
                break
1815
 
            byte_stream = smart_repo._stream_to_byte_stream([], src_format)
 
1411
        if medium._is_remote_before((1, 13)):
 
1412
            # No possible way this can work.
 
1413
            return self._insert_real(stream, src_format, resume_tokens)
 
1414
        path = repo.bzrdir._path_for_remote_call(client)
 
1415
        if not resume_tokens:
 
1416
            # XXX: Ugly but important for correctness, *will* be fixed during
 
1417
            # 1.13 cycle. Pushing a stream that is interrupted results in a
 
1418
            # fallback to the _real_repositories sink *with a partial stream*.
 
1419
            # Thats bad because we insert less data than bzr expected. To avoid
 
1420
            # this we do a trial push to make sure the verb is accessible, and
 
1421
            # do not fallback when actually pushing the stream. A cleanup patch
 
1422
            # is going to look at rewinding/restarting the stream/partial
 
1423
            # buffering etc.
 
1424
            byte_stream = self._stream_to_byte_stream([], src_format)
1816
1425
            try:
1817
1426
                response = client.call_with_body_stream(
1818
 
                    (verb, path, '') + lock_args, byte_stream)
 
1427
                    ('Repository.insert_stream', path, ''), byte_stream)
1819
1428
            except errors.UnknownSmartMethod:
1820
 
                medium._remember_remote_is_before(required_version)
1821
 
            else:
1822
 
                found_verb = True
1823
 
                break
1824
 
        if not found_verb:
1825
 
            # Have to use VFS.
1826
 
            return self._insert_real(stream, src_format, resume_tokens)
1827
 
        self._last_inv_record = None
1828
 
        self._last_substream = None
1829
 
        if required_version < (1, 19):
1830
 
            # Remote side doesn't support inventory deltas.  Wrap the stream to
1831
 
            # make sure we don't send any.  If the stream contains inventory
1832
 
            # deltas we'll interrupt the smart insert_stream request and
1833
 
            # fallback to VFS.
1834
 
            stream = self._stop_stream_if_inventory_delta(stream)
1835
 
        byte_stream = smart_repo._stream_to_byte_stream(
1836
 
            stream, src_format)
 
1429
                medium._remember_remote_is_before((1,13))
 
1430
                return self._insert_real(stream, src_format, resume_tokens)
 
1431
        byte_stream = self._stream_to_byte_stream(stream, src_format)
1837
1432
        resume_tokens = ' '.join(resume_tokens)
1838
1433
        response = client.call_with_body_stream(
1839
 
            (verb, path, resume_tokens) + lock_args, byte_stream)
 
1434
            ('Repository.insert_stream', path, resume_tokens), byte_stream)
1840
1435
        if response[0][0] not in ('ok', 'missing-basis'):
1841
1436
            raise errors.UnexpectedSmartServerResponse(response)
1842
 
        if self._last_substream is not None:
1843
 
            # The stream included an inventory-delta record, but the remote
1844
 
            # side isn't new enough to support them.  So we need to send the
1845
 
            # rest of the stream via VFS.
1846
 
            self.target_repo.refresh_data()
1847
 
            return self._resume_stream_with_vfs(response, src_format)
1848
1437
        if response[0][0] == 'missing-basis':
1849
1438
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1850
1439
            resume_tokens = tokens
1851
 
            return resume_tokens, set(missing_keys)
 
1440
            return resume_tokens, missing_keys
1852
1441
        else:
1853
 
            self.target_repo.refresh_data()
 
1442
            if self.target_repo._real_repository is not None:
 
1443
                collection = getattr(self.target_repo._real_repository,
 
1444
                    '_pack_collection', None)
 
1445
                if collection is not None:
 
1446
                    collection.reload_pack_names()
1854
1447
            return [], set()
1855
1448
 
1856
 
    def _resume_stream_with_vfs(self, response, src_format):
1857
 
        """Resume sending a stream via VFS, first resending the record and
1858
 
        substream that couldn't be sent via an insert_stream verb.
1859
 
        """
1860
 
        if response[0][0] == 'missing-basis':
1861
 
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1862
 
            # Ignore missing_keys, we haven't finished inserting yet
1863
 
        else:
1864
 
            tokens = []
1865
 
        def resume_substream():
1866
 
            # Yield the substream that was interrupted.
1867
 
            for record in self._last_substream:
1868
 
                yield record
1869
 
            self._last_substream = None
1870
 
        def resume_stream():
1871
 
            # Finish sending the interrupted substream
1872
 
            yield ('inventory-deltas', resume_substream())
1873
 
            # Then simply continue sending the rest of the stream.
1874
 
            for substream_kind, substream in self._last_stream:
1875
 
                yield substream_kind, substream
1876
 
        return self._insert_real(resume_stream(), src_format, tokens)
1877
 
 
1878
 
    def _stop_stream_if_inventory_delta(self, stream):
1879
 
        """Normally this just lets the original stream pass-through unchanged.
1880
 
 
1881
 
        However if any 'inventory-deltas' substream occurs it will stop
1882
 
        streaming, and store the interrupted substream and stream in
1883
 
        self._last_substream and self._last_stream so that the stream can be
1884
 
        resumed by _resume_stream_with_vfs.
1885
 
        """
1886
 
                    
1887
 
        stream_iter = iter(stream)
1888
 
        for substream_kind, substream in stream_iter:
1889
 
            if substream_kind == 'inventory-deltas':
1890
 
                self._last_substream = substream
1891
 
                self._last_stream = stream_iter
1892
 
                return
1893
 
            else:
1894
 
                yield substream_kind, substream
1895
 
            
1896
 
 
1897
 
class RemoteStreamSource(repository.StreamSource):
1898
 
    """Stream data from a remote server."""
1899
 
 
1900
 
    def get_stream(self, search):
1901
 
        if (self.from_repository._fallback_repositories and
1902
 
            self.to_format._fetch_order == 'topological'):
1903
 
            return self._real_stream(self.from_repository, search)
1904
 
        sources = []
1905
 
        seen = set()
1906
 
        repos = [self.from_repository]
1907
 
        while repos:
1908
 
            repo = repos.pop(0)
1909
 
            if repo in seen:
1910
 
                continue
1911
 
            seen.add(repo)
1912
 
            repos.extend(repo._fallback_repositories)
1913
 
            sources.append(repo)
1914
 
        return self.missing_parents_chain(search, sources)
1915
 
 
1916
 
    def get_stream_for_missing_keys(self, missing_keys):
1917
 
        self.from_repository._ensure_real()
1918
 
        real_repo = self.from_repository._real_repository
1919
 
        real_source = real_repo._get_source(self.to_format)
1920
 
        return real_source.get_stream_for_missing_keys(missing_keys)
1921
 
 
1922
 
    def _real_stream(self, repo, search):
1923
 
        """Get a stream for search from repo.
1924
 
        
1925
 
        This never called RemoteStreamSource.get_stream, and is a heler
1926
 
        for RemoteStreamSource._get_stream to allow getting a stream 
1927
 
        reliably whether fallback back because of old servers or trying
1928
 
        to stream from a non-RemoteRepository (which the stacked support
1929
 
        code will do).
1930
 
        """
1931
 
        source = repo._get_source(self.to_format)
1932
 
        if isinstance(source, RemoteStreamSource):
1933
 
            repo._ensure_real()
1934
 
            source = repo._real_repository._get_source(self.to_format)
1935
 
        return source.get_stream(search)
1936
 
 
1937
 
    def _get_stream(self, repo, search):
1938
 
        """Core worker to get a stream from repo for search.
1939
 
 
1940
 
        This is used by both get_stream and the stacking support logic. It
1941
 
        deliberately gets a stream for repo which does not need to be
1942
 
        self.from_repository. In the event that repo is not Remote, or
1943
 
        cannot do a smart stream, a fallback is made to the generic
1944
 
        repository._get_stream() interface, via self._real_stream.
1945
 
 
1946
 
        In the event of stacking, streams from _get_stream will not
1947
 
        contain all the data for search - this is normal (see get_stream).
1948
 
 
1949
 
        :param repo: A repository.
1950
 
        :param search: A search.
1951
 
        """
1952
 
        # Fallbacks may be non-smart
1953
 
        if not isinstance(repo, RemoteRepository):
1954
 
            return self._real_stream(repo, search)
1955
 
        client = repo._client
1956
 
        medium = client._medium
1957
 
        path = repo.bzrdir._path_for_remote_call(client)
1958
 
        search_bytes = repo._serialise_search_result(search)
1959
 
        args = (path, self.to_format.network_name())
1960
 
        candidate_verbs = [
1961
 
            ('Repository.get_stream_1.19', (1, 19)),
1962
 
            ('Repository.get_stream', (1, 13))]
1963
 
        found_verb = False
1964
 
        for verb, version in candidate_verbs:
1965
 
            if medium._is_remote_before(version):
1966
 
                continue
 
1449
    def _stream_to_byte_stream(self, stream, src_format):
 
1450
        bytes = []
 
1451
        pack_writer = pack.ContainerWriter(bytes.append)
 
1452
        pack_writer.begin()
 
1453
        pack_writer.add_bytes_record(src_format.network_name(), '')
 
1454
        adapters = {}
 
1455
        def get_adapter(adapter_key):
1967
1456
            try:
1968
 
                response = repo._call_with_body_bytes_expecting_body(
1969
 
                    verb, args, search_bytes)
1970
 
            except errors.UnknownSmartMethod:
1971
 
                medium._remember_remote_is_before(version)
1972
 
            else:
1973
 
                response_tuple, response_handler = response
1974
 
                found_verb = True
1975
 
                break
1976
 
        if not found_verb:
1977
 
            return self._real_stream(repo, search)
1978
 
        if response_tuple[0] != 'ok':
1979
 
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1980
 
        byte_stream = response_handler.read_streamed_body()
1981
 
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
1982
 
        if src_format.network_name() != repo._format.network_name():
1983
 
            raise AssertionError(
1984
 
                "Mismatched RemoteRepository and stream src %r, %r" % (
1985
 
                src_format.network_name(), repo._format.network_name()))
1986
 
        return stream
1987
 
 
1988
 
    def missing_parents_chain(self, search, sources):
1989
 
        """Chain multiple streams together to handle stacking.
1990
 
 
1991
 
        :param search: The overall search to satisfy with streams.
1992
 
        :param sources: A list of Repository objects to query.
1993
 
        """
1994
 
        self.from_serialiser = self.from_repository._format._serializer
1995
 
        self.seen_revs = set()
1996
 
        self.referenced_revs = set()
1997
 
        # If there are heads in the search, or the key count is > 0, we are not
1998
 
        # done.
1999
 
        while not search.is_empty() and len(sources) > 1:
2000
 
            source = sources.pop(0)
2001
 
            stream = self._get_stream(source, search)
2002
 
            for kind, substream in stream:
2003
 
                if kind != 'revisions':
2004
 
                    yield kind, substream
 
1457
                return adapters[adapter_key]
 
1458
            except KeyError:
 
1459
                adapter_factory = adapter_registry.get(adapter_key)
 
1460
                adapter = adapter_factory(self)
 
1461
                adapters[adapter_key] = adapter
 
1462
                return adapter
 
1463
        for substream_type, substream in stream:
 
1464
            for record in substream:
 
1465
                if record.storage_kind in ('chunked', 'fulltext'):
 
1466
                    serialised = record_to_fulltext_bytes(record)
2005
1467
                else:
2006
 
                    yield kind, self.missing_parents_rev_handler(substream)
2007
 
            search = search.refine(self.seen_revs, self.referenced_revs)
2008
 
            self.seen_revs = set()
2009
 
            self.referenced_revs = set()
2010
 
        if not search.is_empty():
2011
 
            for kind, stream in self._get_stream(sources[0], search):
2012
 
                yield kind, stream
2013
 
 
2014
 
    def missing_parents_rev_handler(self, substream):
2015
 
        for content in substream:
2016
 
            revision_bytes = content.get_bytes_as('fulltext')
2017
 
            revision = self.from_serialiser.read_revision_from_string(
2018
 
                revision_bytes)
2019
 
            self.seen_revs.add(content.key[-1])
2020
 
            self.referenced_revs.update(revision.parent_ids)
2021
 
            yield content
 
1468
                    serialised = record.get_bytes_as(record.storage_kind)
 
1469
                pack_writer.add_bytes_record(serialised, [(substream_type,)])
 
1470
                for b in bytes:
 
1471
                    yield b
 
1472
                del bytes[:]
 
1473
        pack_writer.end()
 
1474
        for b in bytes:
 
1475
            yield b
2022
1476
 
2023
1477
 
2024
1478
class RemoteBranchLockableFiles(LockableFiles):
2043
1497
 
2044
1498
class RemoteBranchFormat(branch.BranchFormat):
2045
1499
 
2046
 
    def __init__(self, network_name=None):
 
1500
    def __init__(self):
2047
1501
        super(RemoteBranchFormat, self).__init__()
2048
1502
        self._matchingbzrdir = RemoteBzrDirFormat()
2049
1503
        self._matchingbzrdir.set_branch_format(self)
2050
1504
        self._custom_format = None
2051
 
        self._network_name = network_name
2052
1505
 
2053
1506
    def __eq__(self, other):
2054
1507
        return (isinstance(other, RemoteBranchFormat) and
2055
1508
            self.__dict__ == other.__dict__)
2056
1509
 
2057
 
    def _ensure_real(self):
2058
 
        if self._custom_format is None:
2059
 
            self._custom_format = branch.network_format_registry.get(
2060
 
                self._network_name)
2061
 
 
2062
1510
    def get_format_description(self):
2063
 
        self._ensure_real()
2064
 
        return 'Remote: ' + self._custom_format.get_format_description()
 
1511
        return 'Remote BZR Branch'
2065
1512
 
2066
1513
    def network_name(self):
2067
1514
        return self._network_name
2068
1515
 
2069
 
    def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
2070
 
        return a_bzrdir.open_branch(name=name, 
2071
 
            ignore_fallbacks=ignore_fallbacks)
 
1516
    def open(self, a_bzrdir):
 
1517
        return a_bzrdir.open_branch()
2072
1518
 
2073
 
    def _vfs_initialize(self, a_bzrdir, name):
 
1519
    def _vfs_initialize(self, a_bzrdir):
2074
1520
        # Initialisation when using a local bzrdir object, or a non-vfs init
2075
1521
        # method is not available on the server.
2076
1522
        # self._custom_format is always set - the start of initialize ensures
2077
1523
        # that.
2078
1524
        if isinstance(a_bzrdir, RemoteBzrDir):
2079
1525
            a_bzrdir._ensure_real()
2080
 
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2081
 
                name)
 
1526
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
2082
1527
        else:
2083
1528
            # We assume the bzrdir is parameterised; it may not be.
2084
 
            result = self._custom_format.initialize(a_bzrdir, name)
 
1529
            result = self._custom_format.initialize(a_bzrdir)
2085
1530
        if (isinstance(a_bzrdir, RemoteBzrDir) and
2086
1531
            not isinstance(result, RemoteBranch)):
2087
 
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2088
 
                                  name=name)
 
1532
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
2089
1533
        return result
2090
1534
 
2091
 
    def initialize(self, a_bzrdir, name=None):
 
1535
    def initialize(self, a_bzrdir):
2092
1536
        # 1) get the network name to use.
2093
1537
        if self._custom_format:
2094
1538
            network_name = self._custom_format.network_name()
2100
1544
            network_name = reference_format.network_name()
2101
1545
        # Being asked to create on a non RemoteBzrDir:
2102
1546
        if not isinstance(a_bzrdir, RemoteBzrDir):
2103
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1547
            return self._vfs_initialize(a_bzrdir)
2104
1548
        medium = a_bzrdir._client._medium
2105
1549
        if medium._is_remote_before((1, 13)):
2106
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1550
            return self._vfs_initialize(a_bzrdir)
2107
1551
        # Creating on a remote bzr dir.
2108
1552
        # 2) try direct creation via RPC
2109
1553
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2110
 
        if name is not None:
2111
 
            # XXX JRV20100304: Support creating colocated branches
2112
 
            raise errors.NoColocatedBranchSupport(self)
2113
1554
        verb = 'BzrDir.create_branch'
2114
1555
        try:
2115
1556
            response = a_bzrdir._call(verb, path, network_name)
2116
1557
        except errors.UnknownSmartMethod:
2117
1558
            # Fallback - use vfs methods
2118
 
            medium._remember_remote_is_before((1, 13))
2119
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
1559
            return self._vfs_initialize(a_bzrdir)
2120
1560
        if response[0] != 'ok':
2121
1561
            raise errors.UnexpectedSmartServerResponse(response)
2122
1562
        # Turn the response into a RemoteRepository object.
2123
 
        format = RemoteBranchFormat(network_name=response[1])
 
1563
        format = RemoteBranchFormat()
 
1564
        format._network_name = response[1]
2124
1565
        repo_format = response_tuple_to_repo_format(response[3:])
2125
1566
        if response[2] == '':
2126
1567
            repo_bzrdir = a_bzrdir
2130
1571
                a_bzrdir._client)
2131
1572
        remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2132
1573
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2133
 
            format=format, setup_stacking=False, name=name)
 
1574
            format=format, setup_stacking=False)
2134
1575
        # XXX: We know this is a new branch, so it must have revno 0, revid
2135
1576
        # NULL_REVISION. Creating the branch locked would make this be unable
2136
1577
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2137
1578
        remote_branch._last_revision_info_cache = 0, NULL_REVISION
2138
1579
        return remote_branch
2139
1580
 
2140
 
    def make_tags(self, branch):
2141
 
        self._ensure_real()
2142
 
        return self._custom_format.make_tags(branch)
2143
 
 
2144
1581
    def supports_tags(self):
2145
1582
        # Remote branches might support tags, but we won't know until we
2146
1583
        # access the real remote branch.
2147
 
        self._ensure_real()
2148
 
        return self._custom_format.supports_tags()
2149
 
 
2150
 
    def supports_stacking(self):
2151
 
        self._ensure_real()
2152
 
        return self._custom_format.supports_stacking()
2153
 
 
2154
 
    def supports_set_append_revisions_only(self):
2155
 
        self._ensure_real()
2156
 
        return self._custom_format.supports_set_append_revisions_only()
2157
 
 
2158
 
 
2159
 
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
 
1584
        return True
 
1585
 
 
1586
 
 
1587
class RemoteBranch(branch.Branch, _RpcHelper):
2160
1588
    """Branch stored on a server accessed by HPSS RPC.
2161
1589
 
2162
1590
    At the moment most operations are mapped down to simple file operations.
2163
1591
    """
2164
1592
 
2165
1593
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2166
 
        _client=None, format=None, setup_stacking=True, name=None):
 
1594
        _client=None, format=None, setup_stacking=True):
2167
1595
        """Create a RemoteBranch instance.
2168
1596
 
2169
1597
        :param real_branch: An optional local implementation of the branch
2175
1603
        :param setup_stacking: If True make an RPC call to determine the
2176
1604
            stacked (or not) status of the branch. If False assume the branch
2177
1605
            is not stacked.
2178
 
        :param name: Colocated branch name
2179
1606
        """
2180
1607
        # We intentionally don't call the parent class's __init__, because it
2181
1608
        # will try to assign to self.tags, which is a property in this subclass.
2182
1609
        # And the parent's __init__ doesn't do much anyway.
 
1610
        self._revision_id_to_revno_cache = None
 
1611
        self._partial_revision_id_to_revno_cache = {}
 
1612
        self._revision_history_cache = None
 
1613
        self._last_revision_info_cache = None
 
1614
        self._merge_sorted_revisions_cache = None
2183
1615
        self.bzrdir = remote_bzrdir
2184
1616
        if _client is not None:
2185
1617
            self._client = _client
2198
1630
            self._real_branch.repository = self.repository
2199
1631
        else:
2200
1632
            self._real_branch = None
2201
 
        # Fill out expected attributes of branch for bzrlib API users.
2202
 
        self._clear_cached_state()
2203
 
        # TODO: deprecate self.base in favor of user_url
2204
 
        self.base = self.bzrdir.user_url
2205
 
        self._name = name
 
1633
        # Fill out expected attributes of branch for bzrlib api users.
 
1634
        self.base = self.bzrdir.root_transport.base
2206
1635
        self._control_files = None
2207
1636
        self._lock_mode = None
2208
1637
        self._lock_token = None
2217
1646
            if real_branch is not None:
2218
1647
                self._format._network_name = \
2219
1648
                    self._real_branch._format.network_name()
 
1649
            #else:
 
1650
            #    # XXX: Need to get this from BzrDir.open_branch's return value.
 
1651
            #    self._ensure_real()
 
1652
            #    self._format._network_name = \
 
1653
            #        self._real_branch._format.network_name()
2220
1654
        else:
2221
1655
            self._format = format
2222
 
        # when we do _ensure_real we may need to pass ignore_fallbacks to the
2223
 
        # branch.open_branch method.
2224
 
        self._real_ignore_fallbacks = not setup_stacking
2225
 
        if not self._format._network_name:
2226
 
            # Did not get from open_branchV2 - old server.
2227
 
            self._ensure_real()
2228
 
            self._format._network_name = \
2229
 
                self._real_branch._format.network_name()
2230
 
        self.tags = self._format.make_tags(self)
2231
1656
        # The base class init is not called, so we duplicate this:
2232
1657
        hooks = branch.Branch.hooks['open']
2233
1658
        for hook in hooks:
2234
1659
            hook(self)
2235
 
        self._is_stacked = False
2236
1660
        if setup_stacking:
2237
1661
            self._setup_stacking()
2238
1662
 
2244
1668
        except (errors.NotStacked, errors.UnstackableBranchFormat,
2245
1669
            errors.UnstackableRepositoryFormat), e:
2246
1670
            return
2247
 
        self._is_stacked = True
2248
 
        self._activate_fallback_location(fallback_url)
2249
 
 
2250
 
    def _get_config(self):
2251
 
        return RemoteBranchConfig(self)
 
1671
        # it's relative to this branch...
 
1672
        fallback_url = urlutils.join(self.base, fallback_url)
 
1673
        transports = [self.bzrdir.root_transport]
 
1674
        if self._real_branch is not None:
 
1675
            # The real repository is setup already:
 
1676
            transports.append(self._real_branch._transport)
 
1677
            self.repository.add_fallback_repository(
 
1678
                self.repository._real_repository._fallback_repositories[0])
 
1679
        else:
 
1680
            stacked_on = branch.Branch.open(fallback_url,
 
1681
                                            possible_transports=transports)
 
1682
            self.repository.add_fallback_repository(stacked_on.repository)
2252
1683
 
2253
1684
    def _get_real_transport(self):
2254
1685
        # if we try vfs access, return the real branch's vfs transport
2272
1703
                raise AssertionError('smart server vfs must be enabled '
2273
1704
                    'to use vfs implementation')
2274
1705
            self.bzrdir._ensure_real()
2275
 
            self._real_branch = self.bzrdir._real_bzrdir.open_branch(
2276
 
                ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
 
1706
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
2277
1707
            if self.repository._real_repository is None:
2278
1708
                # Give the remote repository the matching real repo.
2279
1709
                real_repo = self._real_branch.repository
2353
1783
            raise errors.UnexpectedSmartServerResponse(response)
2354
1784
        return response[1]
2355
1785
 
2356
 
    def set_stacked_on_url(self, url):
2357
 
        branch.Branch.set_stacked_on_url(self, url)
2358
 
        if not url:
2359
 
            self._is_stacked = False
2360
 
        else:
2361
 
            self._is_stacked = True
2362
 
        
2363
 
    def _vfs_get_tags_bytes(self):
2364
 
        self._ensure_real()
2365
 
        return self._real_branch._get_tags_bytes()
2366
 
 
2367
 
    def _get_tags_bytes(self):
2368
 
        medium = self._client._medium
2369
 
        if medium._is_remote_before((1, 13)):
2370
 
            return self._vfs_get_tags_bytes()
2371
 
        try:
2372
 
            response = self._call('Branch.get_tags_bytes', self._remote_path())
2373
 
        except errors.UnknownSmartMethod:
2374
 
            medium._remember_remote_is_before((1, 13))
2375
 
            return self._vfs_get_tags_bytes()
2376
 
        return response[0]
2377
 
 
2378
 
    def _vfs_set_tags_bytes(self, bytes):
2379
 
        self._ensure_real()
2380
 
        return self._real_branch._set_tags_bytes(bytes)
2381
 
 
2382
 
    def _set_tags_bytes(self, bytes):
2383
 
        medium = self._client._medium
2384
 
        if medium._is_remote_before((1, 18)):
2385
 
            self._vfs_set_tags_bytes(bytes)
2386
 
            return
2387
 
        try:
2388
 
            args = (
2389
 
                self._remote_path(), self._lock_token, self._repo_lock_token)
2390
 
            response = self._call_with_body_bytes(
2391
 
                'Branch.set_tags_bytes', args, bytes)
2392
 
        except errors.UnknownSmartMethod:
2393
 
            medium._remember_remote_is_before((1, 18))
2394
 
            self._vfs_set_tags_bytes(bytes)
2395
 
 
2396
1786
    def lock_read(self):
2397
 
        """Lock the branch for read operations.
2398
 
 
2399
 
        :return: An object with an unlock method which will release the lock
2400
 
            obtained.
2401
 
        """
2402
1787
        self.repository.lock_read()
2403
1788
        if not self._lock_mode:
2404
 
            self._note_lock('r')
2405
1789
            self._lock_mode = 'r'
2406
1790
            self._lock_count = 1
2407
1791
            if self._real_branch is not None:
2408
1792
                self._real_branch.lock_read()
2409
1793
        else:
2410
1794
            self._lock_count += 1
2411
 
        return self
2412
1795
 
2413
1796
    def _remote_lock_write(self, token):
2414
1797
        if token is None:
2415
1798
            branch_token = repo_token = ''
2416
1799
        else:
2417
1800
            branch_token = token
2418
 
            repo_token = self.repository.lock_write().repository_token
 
1801
            repo_token = self.repository.lock_write()
2419
1802
            self.repository.unlock()
2420
1803
        err_context = {'token': token}
2421
1804
        response = self._call(
2428
1811
 
2429
1812
    def lock_write(self, token=None):
2430
1813
        if not self._lock_mode:
2431
 
            self._note_lock('w')
2432
1814
            # Lock the branch and repo in one remote call.
2433
1815
            remote_tokens = self._remote_lock_write(token)
2434
1816
            self._lock_token, self._repo_lock_token = remote_tokens
2458
1840
            self._lock_count += 1
2459
1841
            # Re-lock the repository too.
2460
1842
            self.repository.lock_write(self._repo_lock_token)
2461
 
        return BranchWriteLockResult(self.unlock, self._lock_token or None)
 
1843
        return self._lock_token or None
2462
1844
 
2463
1845
    def _unlock(self, branch_token, repo_token):
2464
1846
        err_context = {'token': str((branch_token, repo_token))}
2469
1851
            return
2470
1852
        raise errors.UnexpectedSmartServerResponse(response)
2471
1853
 
2472
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2473
1854
    def unlock(self):
2474
1855
        try:
2475
1856
            self._lock_count -= 1
2488
1869
                    self._real_branch.unlock()
2489
1870
                if mode != 'w':
2490
1871
                    # Only write-locked branched need to make a remote method
2491
 
                    # call to perform the unlock.
 
1872
                    # call to perfom the unlock.
2492
1873
                    return
2493
1874
                if not self._lock_token:
2494
1875
                    raise AssertionError('Locked, but no token!')
2515
1896
            raise NotImplementedError(self.dont_leave_lock_in_place)
2516
1897
        self._leave_lock = False
2517
1898
 
2518
 
    @needs_read_lock
2519
 
    def get_rev_id(self, revno, history=None):
2520
 
        if revno == 0:
2521
 
            return _mod_revision.NULL_REVISION
2522
 
        last_revision_info = self.last_revision_info()
2523
 
        ok, result = self.repository.get_rev_id_for_revno(
2524
 
            revno, last_revision_info)
2525
 
        if ok:
2526
 
            return result
2527
 
        missing_parent = result[1]
2528
 
        # Either the revision named by the server is missing, or its parent
2529
 
        # is.  Call get_parent_map to determine which, so that we report a
2530
 
        # useful error.
2531
 
        parent_map = self.repository.get_parent_map([missing_parent])
2532
 
        if missing_parent in parent_map:
2533
 
            missing_parent = parent_map[missing_parent]
2534
 
        raise errors.RevisionNotPresent(missing_parent, self.repository)
2535
 
 
2536
1899
    def _last_revision_info(self):
2537
1900
        response = self._call('Branch.last_revision_info', self._remote_path())
2538
1901
        if response[0] != 'ok':
2543
1906
 
2544
1907
    def _gen_revision_history(self):
2545
1908
        """See Branch._gen_revision_history()."""
2546
 
        if self._is_stacked:
2547
 
            self._ensure_real()
2548
 
            return self._real_branch._gen_revision_history()
2549
1909
        response_tuple, response_handler = self._call_expecting_body(
2550
1910
            'Branch.revision_history', self._remote_path())
2551
1911
        if response_tuple[0] != 'ok':
2616
1976
            hook(self, rev_history)
2617
1977
        self._cache_revision_history(rev_history)
2618
1978
 
 
1979
    def get_parent(self):
 
1980
        self._ensure_real()
 
1981
        return self._real_branch.get_parent()
 
1982
 
2619
1983
    def _get_parent_location(self):
2620
 
        medium = self._client._medium
2621
 
        if medium._is_remote_before((1, 13)):
2622
 
            return self._vfs_get_parent_location()
2623
 
        try:
2624
 
            response = self._call('Branch.get_parent', self._remote_path())
2625
 
        except errors.UnknownSmartMethod:
2626
 
            medium._remember_remote_is_before((1, 13))
2627
 
            return self._vfs_get_parent_location()
2628
 
        if len(response) != 1:
2629
 
            raise errors.UnexpectedSmartServerResponse(response)
2630
 
        parent_location = response[0]
2631
 
        if parent_location == '':
2632
 
            return None
2633
 
        return parent_location
2634
 
 
2635
 
    def _vfs_get_parent_location(self):
 
1984
        # Used by tests, when checking normalisation of given vs stored paths.
2636
1985
        self._ensure_real()
2637
1986
        return self._real_branch._get_parent_location()
2638
1987
 
 
1988
    def set_parent(self, url):
 
1989
        self._ensure_real()
 
1990
        return self._real_branch.set_parent(url)
 
1991
 
2639
1992
    def _set_parent_location(self, url):
2640
 
        medium = self._client._medium
2641
 
        if medium._is_remote_before((1, 15)):
2642
 
            return self._vfs_set_parent_location(url)
2643
 
        try:
2644
 
            call_url = url or ''
2645
 
            if type(call_url) is not str:
2646
 
                raise AssertionError('url must be a str or None (%s)' % url)
2647
 
            response = self._call('Branch.set_parent_location',
2648
 
                self._remote_path(), self._lock_token, self._repo_lock_token,
2649
 
                call_url)
2650
 
        except errors.UnknownSmartMethod:
2651
 
            medium._remember_remote_is_before((1, 15))
2652
 
            return self._vfs_set_parent_location(url)
2653
 
        if response != ():
2654
 
            raise errors.UnexpectedSmartServerResponse(response)
2655
 
 
2656
 
    def _vfs_set_parent_location(self, url):
 
1993
        # Used by tests, to poke bad urls into branch configurations
 
1994
        if url is None:
 
1995
            self.set_parent(url)
 
1996
        else:
 
1997
            self._ensure_real()
 
1998
            return self._real_branch._set_parent_location(url)
 
1999
 
 
2000
    def set_stacked_on_url(self, stacked_location):
 
2001
        """Set the URL this branch is stacked against.
 
2002
 
 
2003
        :raises UnstackableBranchFormat: If the branch does not support
 
2004
            stacking.
 
2005
        :raises UnstackableRepositoryFormat: If the repository does not support
 
2006
            stacking.
 
2007
        """
2657
2008
        self._ensure_real()
2658
 
        return self._real_branch._set_parent_location(url)
 
2009
        return self._real_branch.set_stacked_on_url(stacked_location)
2659
2010
 
2660
2011
    @needs_write_lock
2661
2012
    def pull(self, source, overwrite=False, stop_revision=None,
2724
2075
        self.set_revision_history(self._lefthand_history(revision_id,
2725
2076
            last_rev=last_rev,other_branch=other_branch))
2726
2077
 
 
2078
    @property
 
2079
    def tags(self):
 
2080
        self._ensure_real()
 
2081
        return self._real_branch.tags
 
2082
 
2727
2083
    def set_push_location(self, location):
2728
2084
        self._ensure_real()
2729
2085
        return self._real_branch.set_push_location(location)
2730
2086
 
2731
2087
 
2732
 
class RemoteConfig(object):
2733
 
    """A Config that reads and writes from smart verbs.
2734
 
 
2735
 
    It is a low-level object that considers config data to be name/value pairs
2736
 
    that may be associated with a section. Assigning meaning to the these
2737
 
    values is done at higher levels like bzrlib.config.TreeConfig.
2738
 
    """
2739
 
 
2740
 
    def get_option(self, name, section=None, default=None):
2741
 
        """Return the value associated with a named option.
2742
 
 
2743
 
        :param name: The name of the value
2744
 
        :param section: The section the option is in (if any)
2745
 
        :param default: The value to return if the value is not set
2746
 
        :return: The value or default value
2747
 
        """
2748
 
        try:
2749
 
            configobj = self._get_configobj()
2750
 
            if section is None:
2751
 
                section_obj = configobj
2752
 
            else:
2753
 
                try:
2754
 
                    section_obj = configobj[section]
2755
 
                except KeyError:
2756
 
                    return default
2757
 
            return section_obj.get(name, default)
2758
 
        except errors.UnknownSmartMethod:
2759
 
            return self._vfs_get_option(name, section, default)
2760
 
 
2761
 
    def _response_to_configobj(self, response):
2762
 
        if len(response[0]) and response[0][0] != 'ok':
2763
 
            raise errors.UnexpectedSmartServerResponse(response)
2764
 
        lines = response[1].read_body_bytes().splitlines()
2765
 
        return config.ConfigObj(lines, encoding='utf-8')
2766
 
 
2767
 
 
2768
 
class RemoteBranchConfig(RemoteConfig):
2769
 
    """A RemoteConfig for Branches."""
2770
 
 
2771
 
    def __init__(self, branch):
2772
 
        self._branch = branch
2773
 
 
2774
 
    def _get_configobj(self):
2775
 
        path = self._branch._remote_path()
2776
 
        response = self._branch._client.call_expecting_body(
2777
 
            'Branch.get_config_file', path)
2778
 
        return self._response_to_configobj(response)
2779
 
 
2780
 
    def set_option(self, value, name, section=None):
2781
 
        """Set the value associated with a named option.
2782
 
 
2783
 
        :param value: The value to set
2784
 
        :param name: The name of the value to set
2785
 
        :param section: The section the option is in (if any)
2786
 
        """
2787
 
        medium = self._branch._client._medium
2788
 
        if medium._is_remote_before((1, 14)):
2789
 
            return self._vfs_set_option(value, name, section)
2790
 
        try:
2791
 
            path = self._branch._remote_path()
2792
 
            response = self._branch._client.call('Branch.set_config_option',
2793
 
                path, self._branch._lock_token, self._branch._repo_lock_token,
2794
 
                value.encode('utf8'), name, section or '')
2795
 
        except errors.UnknownSmartMethod:
2796
 
            medium._remember_remote_is_before((1, 14))
2797
 
            return self._vfs_set_option(value, name, section)
2798
 
        if response != ():
2799
 
            raise errors.UnexpectedSmartServerResponse(response)
2800
 
 
2801
 
    def _real_object(self):
2802
 
        self._branch._ensure_real()
2803
 
        return self._branch._real_branch
2804
 
 
2805
 
    def _vfs_set_option(self, value, name, section=None):
2806
 
        return self._real_object()._get_config().set_option(
2807
 
            value, name, section)
2808
 
 
2809
 
 
2810
 
class RemoteBzrDirConfig(RemoteConfig):
2811
 
    """A RemoteConfig for BzrDirs."""
2812
 
 
2813
 
    def __init__(self, bzrdir):
2814
 
        self._bzrdir = bzrdir
2815
 
 
2816
 
    def _get_configobj(self):
2817
 
        medium = self._bzrdir._client._medium
2818
 
        verb = 'BzrDir.get_config_file'
2819
 
        if medium._is_remote_before((1, 15)):
2820
 
            raise errors.UnknownSmartMethod(verb)
2821
 
        path = self._bzrdir._path_for_remote_call(self._bzrdir._client)
2822
 
        response = self._bzrdir._call_expecting_body(
2823
 
            verb, path)
2824
 
        return self._response_to_configobj(response)
2825
 
 
2826
 
    def _vfs_get_option(self, name, section, default):
2827
 
        return self._real_object()._get_config().get_option(
2828
 
            name, section, default)
2829
 
 
2830
 
    def set_option(self, value, name, section=None):
2831
 
        """Set the value associated with a named option.
2832
 
 
2833
 
        :param value: The value to set
2834
 
        :param name: The name of the value to set
2835
 
        :param section: The section the option is in (if any)
2836
 
        """
2837
 
        return self._real_object()._get_config().set_option(
2838
 
            value, name, section)
2839
 
 
2840
 
    def _real_object(self):
2841
 
        self._bzrdir._ensure_real()
2842
 
        return self._bzrdir._real_bzrdir
2843
 
 
2844
 
 
2845
 
 
2846
2088
def _extract_tar(tar, to_dir):
2847
2089
    """Extract all the contents of a tarfile object.
2848
2090
 
2886
2128
                    'Missing key %r in context %r', key_err.args[0], context)
2887
2129
                raise err
2888
2130
 
2889
 
    if err.error_verb == 'IncompatibleRepositories':
2890
 
        raise errors.IncompatibleRepositories(err.error_args[0],
2891
 
            err.error_args[1], err.error_args[2])
2892
 
    elif err.error_verb == 'NoSuchRevision':
 
2131
    if err.error_verb == 'NoSuchRevision':
2893
2132
        raise NoSuchRevision(find('branch'), err.error_args[0])
2894
2133
    elif err.error_verb == 'nosuchrevision':
2895
2134
        raise NoSuchRevision(find('repository'), err.error_args[0])
2896
 
    elif err.error_verb == 'nobranch':
2897
 
        if len(err.error_args) >= 1:
2898
 
            extra = err.error_args[0]
2899
 
        else:
2900
 
            extra = None
2901
 
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base,
2902
 
            detail=extra)
 
2135
    elif err.error_tuple == ('nobranch',):
 
2136
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2903
2137
    elif err.error_verb == 'norepository':
2904
2138
        raise errors.NoRepositoryPresent(find('bzrdir'))
2905
2139
    elif err.error_verb == 'LockContention':