/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: Colin D Bennett
  • Date: 2009-02-12 16:57:39 UTC
  • mto: This revision was merged to the branch mainline in revision 4008.
  • Revision ID: colin@gibibit.com-20090212165739-02xv63odccfmxomw
Generate PDF version of the User Guide.

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