/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Jelmer Vernooij
  • Date: 2009-02-25 02:05:35 UTC
  • mto: This revision was merged to the branch mainline in revision 4053.
  • Revision ID: jelmer@samba.org-20090225020535-qw7udfz9ploqzosn
Add tests for InterBranch.

Show diffs side-by-side

added added

removed removed

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