~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-02-26 03:15:58 UTC
  • mfrom: (4050.1.3 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20090226031558-1ubr618vdn4r5f07
(robertc) Fix race condition with branch hooks during cloning when
        the new branch is stacked. (Robert Collins)

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