~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Robert Collins
  • Date: 2009-08-25 21:09:17 UTC
  • mto: This revision was merged to the branch mainline in revision 4650.
  • Revision ID: robertc@robertcollins.net-20090825210917-dq2i8k6n4z63pneh
Support shelve and unshelve on windows - bug 305006.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2008, 2009 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., 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.
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
16
 
20
17
import bz2
21
18
 
22
19
from bzrlib import (
 
20
    bencode,
23
21
    branch,
 
22
    bzrdir,
 
23
    config,
24
24
    debug,
25
25
    errors,
26
26
    graph,
 
27
    lock,
27
28
    lockdir,
28
29
    repository,
29
30
    revision,
 
31
    revision as _mod_revision,
30
32
    symbol_versioning,
31
33
)
32
34
from bzrlib.branch import BranchReferenceFormat
37
39
    SmartProtocolError,
38
40
    )
39
41
from bzrlib.lockable_files import LockableFiles
40
 
from bzrlib.smart import client, vfs
 
42
from bzrlib.smart import client, vfs, repository as smart_repo
41
43
from bzrlib.revision import ensure_null, NULL_REVISION
42
44
from bzrlib.trace import mutter, note, warning
43
45
 
44
46
 
 
47
class _RpcHelper(object):
 
48
    """Mixin class that helps with issuing RPCs."""
 
49
 
 
50
    def _call(self, method, *args, **err_context):
 
51
        try:
 
52
            return self._client.call(method, *args)
 
53
        except errors.ErrorFromSmartServer, err:
 
54
            self._translate_error(err, **err_context)
 
55
 
 
56
    def _call_expecting_body(self, method, *args, **err_context):
 
57
        try:
 
58
            return self._client.call_expecting_body(method, *args)
 
59
        except errors.ErrorFromSmartServer, err:
 
60
            self._translate_error(err, **err_context)
 
61
 
 
62
    def _call_with_body_bytes(self, method, args, body_bytes, **err_context):
 
63
        try:
 
64
            return self._client.call_with_body_bytes(method, args, body_bytes)
 
65
        except errors.ErrorFromSmartServer, err:
 
66
            self._translate_error(err, **err_context)
 
67
 
 
68
    def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
 
69
                                             **err_context):
 
70
        try:
 
71
            return self._client.call_with_body_bytes_expecting_body(
 
72
                method, args, body_bytes)
 
73
        except errors.ErrorFromSmartServer, err:
 
74
            self._translate_error(err, **err_context)
 
75
 
 
76
 
 
77
def response_tuple_to_repo_format(response):
 
78
    """Convert a response tuple describing a repository format to a format."""
 
79
    format = RemoteRepositoryFormat()
 
80
    format._rich_root_data = (response[0] == 'yes')
 
81
    format._supports_tree_reference = (response[1] == 'yes')
 
82
    format._supports_external_lookups = (response[2] == 'yes')
 
83
    format._network_name = response[3]
 
84
    return format
 
85
 
 
86
 
45
87
# Note: RemoteBzrDirFormat is in bzrdir.py
46
88
 
47
 
class RemoteBzrDir(BzrDir):
 
89
class RemoteBzrDir(BzrDir, _RpcHelper):
48
90
    """Control directory on a remote server, accessed via bzr:// or similar."""
49
91
 
50
 
    def __init__(self, transport, _client=None):
 
92
    def __init__(self, transport, format, _client=None):
51
93
        """Construct a RemoteBzrDir.
52
94
 
53
95
        :param _client: Private parameter for testing. Disables probing and the
54
96
            use of a real bzrdir.
55
97
        """
56
 
        BzrDir.__init__(self, transport, RemoteBzrDirFormat())
 
98
        BzrDir.__init__(self, transport, format)
57
99
        # this object holds a delegated bzrdir that uses file-level operations
58
100
        # to talk to the other side
59
101
        self._real_bzrdir = None
 
102
        # 1-shot cache for the call pattern 'create_branch; open_branch' - see
 
103
        # create_branch for details.
 
104
        self._next_open_branch_result = None
60
105
 
61
106
        if _client is None:
62
107
            medium = transport.get_smart_medium()
66
111
            return
67
112
 
68
113
        path = self._path_for_remote_call(self._client)
69
 
        response = self._client.call('BzrDir.open', path)
 
114
        response = self._call('BzrDir.open', path)
70
115
        if response not in [('yes',), ('no',)]:
71
116
            raise errors.UnexpectedSmartServerResponse(response)
72
117
        if response == ('no',):
80
125
        if not self._real_bzrdir:
81
126
            self._real_bzrdir = BzrDir.open_from_transport(
82
127
                self.root_transport, _server_formats=False)
83
 
 
84
 
    def cloning_metadir(self, stacked=False):
85
 
        self._ensure_real()
86
 
        return self._real_bzrdir.cloning_metadir(stacked)
 
128
            self._format._network_name = \
 
129
                self._real_bzrdir._format.network_name()
87
130
 
88
131
    def _translate_error(self, err, **context):
89
132
        _translate_error(err, bzrdir=self, **context)
90
 
        
 
133
 
 
134
    def break_lock(self):
 
135
        # Prevent aliasing problems in the next_open_branch_result cache.
 
136
        # See create_branch for rationale.
 
137
        self._next_open_branch_result = None
 
138
        return BzrDir.break_lock(self)
 
139
 
 
140
    def _vfs_cloning_metadir(self, require_stacking=False):
 
141
        self._ensure_real()
 
142
        return self._real_bzrdir.cloning_metadir(
 
143
            require_stacking=require_stacking)
 
144
 
 
145
    def cloning_metadir(self, require_stacking=False):
 
146
        medium = self._client._medium
 
147
        if medium._is_remote_before((1, 13)):
 
148
            return self._vfs_cloning_metadir(require_stacking=require_stacking)
 
149
        verb = 'BzrDir.cloning_metadir'
 
150
        if require_stacking:
 
151
            stacking = 'True'
 
152
        else:
 
153
            stacking = 'False'
 
154
        path = self._path_for_remote_call(self._client)
 
155
        try:
 
156
            response = self._call(verb, path, stacking)
 
157
        except errors.UnknownSmartMethod:
 
158
            medium._remember_remote_is_before((1, 13))
 
159
            return self._vfs_cloning_metadir(require_stacking=require_stacking)
 
160
        except errors.UnknownErrorFromSmartServer, err:
 
161
            if err.error_tuple != ('BranchReference',):
 
162
                raise
 
163
            # We need to resolve the branch reference to determine the
 
164
            # cloning_metadir.  This causes unnecessary RPCs to open the
 
165
            # referenced branch (and bzrdir, etc) but only when the caller
 
166
            # didn't already resolve the branch reference.
 
167
            referenced_branch = self.open_branch()
 
168
            return referenced_branch.bzrdir.cloning_metadir()
 
169
        if len(response) != 3:
 
170
            raise errors.UnexpectedSmartServerResponse(response)
 
171
        control_name, repo_name, branch_info = response
 
172
        if len(branch_info) != 2:
 
173
            raise errors.UnexpectedSmartServerResponse(response)
 
174
        branch_ref, branch_name = branch_info
 
175
        format = bzrdir.network_format_registry.get(control_name)
 
176
        if repo_name:
 
177
            format.repository_format = repository.network_format_registry.get(
 
178
                repo_name)
 
179
        if branch_ref == 'ref':
 
180
            # XXX: we need possible_transports here to avoid reopening the
 
181
            # connection to the referenced location
 
182
            ref_bzrdir = BzrDir.open(branch_name)
 
183
            branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
 
184
            format.set_branch_format(branch_format)
 
185
        elif branch_ref == 'branch':
 
186
            if branch_name:
 
187
                format.set_branch_format(
 
188
                    branch.network_format_registry.get(branch_name))
 
189
        else:
 
190
            raise errors.UnexpectedSmartServerResponse(response)
 
191
        return format
 
192
 
91
193
    def create_repository(self, shared=False):
92
 
        self._ensure_real()
93
 
        self._real_bzrdir.create_repository(shared=shared)
94
 
        return self.open_repository()
 
194
        # as per meta1 formats - just delegate to the format object which may
 
195
        # be parameterised.
 
196
        result = self._format.repository_format.initialize(self, shared)
 
197
        if not isinstance(result, RemoteRepository):
 
198
            return self.open_repository()
 
199
        else:
 
200
            return result
95
201
 
96
202
    def destroy_repository(self):
97
203
        """See BzrDir.destroy_repository"""
99
205
        self._real_bzrdir.destroy_repository()
100
206
 
101
207
    def create_branch(self):
102
 
        self._ensure_real()
103
 
        real_branch = self._real_bzrdir.create_branch()
104
 
        return RemoteBranch(self, self.find_repository(), real_branch)
 
208
        # as per meta1 formats - just delegate to the format object which may
 
209
        # be parameterised.
 
210
        real_branch = self._format.get_branch_format().initialize(self)
 
211
        if not isinstance(real_branch, RemoteBranch):
 
212
            result = RemoteBranch(self, self.find_repository(), real_branch)
 
213
        else:
 
214
            result = real_branch
 
215
        # BzrDir.clone_on_transport() uses the result of create_branch but does
 
216
        # not return it to its callers; we save approximately 8% of our round
 
217
        # trips by handing the branch we created back to the first caller to
 
218
        # open_branch rather than probing anew. Long term we need a API in
 
219
        # bzrdir that doesn't discard result objects (like result_branch).
 
220
        # RBC 20090225
 
221
        self._next_open_branch_result = result
 
222
        return result
105
223
 
106
224
    def destroy_branch(self):
107
225
        """See BzrDir.destroy_branch"""
108
226
        self._ensure_real()
109
227
        self._real_bzrdir.destroy_branch()
 
228
        self._next_open_branch_result = None
110
229
 
111
230
    def create_workingtree(self, revision_id=None, from_branch=None):
112
231
        raise errors.NotLocalUrl(self.transport.base)
121
240
 
122
241
    def get_branch_reference(self):
123
242
        """See BzrDir.get_branch_reference()."""
 
243
        response = self._get_branch_reference()
 
244
        if response[0] == 'ref':
 
245
            return response[1]
 
246
        else:
 
247
            return None
 
248
 
 
249
    def _get_branch_reference(self):
124
250
        path = self._path_for_remote_call(self._client)
125
 
        try:
126
 
            response = self._client.call('BzrDir.open_branch', path)
127
 
        except errors.ErrorFromSmartServer, err:
128
 
            self._translate_error(err)
129
 
        if response[0] == 'ok':
130
 
            if response[1] == '':
131
 
                # branch at this location.
132
 
                return None
133
 
            else:
134
 
                # a branch reference, use the existing BranchReference logic.
135
 
                return response[1]
136
 
        else:
 
251
        medium = self._client._medium
 
252
        if not medium._is_remote_before((1, 13)):
 
253
            try:
 
254
                response = self._call('BzrDir.open_branchV2', path)
 
255
                if response[0] not in ('ref', 'branch'):
 
256
                    raise errors.UnexpectedSmartServerResponse(response)
 
257
                return response
 
258
            except errors.UnknownSmartMethod:
 
259
                medium._remember_remote_is_before((1, 13))
 
260
        response = self._call('BzrDir.open_branch', path)
 
261
        if response[0] != 'ok':
137
262
            raise errors.UnexpectedSmartServerResponse(response)
 
263
        if response[1] != '':
 
264
            return ('ref', response[1])
 
265
        else:
 
266
            return ('branch', '')
138
267
 
139
268
    def _get_tree_branch(self):
140
269
        """See BzrDir._get_tree_branch()."""
141
270
        return None, self.open_branch()
142
271
 
143
 
    def open_branch(self, _unsupported=False):
 
272
    def open_branch(self, _unsupported=False, ignore_fallbacks=False):
144
273
        if _unsupported:
145
274
            raise NotImplementedError('unsupported flag support not implemented yet.')
146
 
        reference_url = self.get_branch_reference()
147
 
        if reference_url is None:
148
 
            # branch at this location.
149
 
            return RemoteBranch(self, self.find_repository())
150
 
        else:
 
275
        if self._next_open_branch_result is not None:
 
276
            # See create_branch for details.
 
277
            result = self._next_open_branch_result
 
278
            self._next_open_branch_result = None
 
279
            return result
 
280
        response = self._get_branch_reference()
 
281
        if response[0] == 'ref':
151
282
            # a branch reference, use the existing BranchReference logic.
152
283
            format = BranchReferenceFormat()
153
 
            return format.open(self, _found=True, location=reference_url)
154
 
                
 
284
            return format.open(self, _found=True, location=response[1],
 
285
                ignore_fallbacks=ignore_fallbacks)
 
286
        branch_format_name = response[1]
 
287
        if not branch_format_name:
 
288
            branch_format_name = None
 
289
        format = RemoteBranchFormat(network_name=branch_format_name)
 
290
        return RemoteBranch(self, self.find_repository(), format=format,
 
291
            setup_stacking=not ignore_fallbacks)
 
292
 
 
293
    def _open_repo_v1(self, path):
 
294
        verb = 'BzrDir.find_repository'
 
295
        response = self._call(verb, path)
 
296
        if response[0] != 'ok':
 
297
            raise errors.UnexpectedSmartServerResponse(response)
 
298
        # servers that only support the v1 method don't support external
 
299
        # references either.
 
300
        self._ensure_real()
 
301
        repo = self._real_bzrdir.open_repository()
 
302
        response = response + ('no', repo._format.network_name())
 
303
        return response, repo
 
304
 
 
305
    def _open_repo_v2(self, path):
 
306
        verb = 'BzrDir.find_repositoryV2'
 
307
        response = self._call(verb, path)
 
308
        if response[0] != 'ok':
 
309
            raise errors.UnexpectedSmartServerResponse(response)
 
310
        self._ensure_real()
 
311
        repo = self._real_bzrdir.open_repository()
 
312
        response = response + (repo._format.network_name(),)
 
313
        return response, repo
 
314
 
 
315
    def _open_repo_v3(self, path):
 
316
        verb = 'BzrDir.find_repositoryV3'
 
317
        medium = self._client._medium
 
318
        if medium._is_remote_before((1, 13)):
 
319
            raise errors.UnknownSmartMethod(verb)
 
320
        try:
 
321
            response = self._call(verb, path)
 
322
        except errors.UnknownSmartMethod:
 
323
            medium._remember_remote_is_before((1, 13))
 
324
            raise
 
325
        if response[0] != 'ok':
 
326
            raise errors.UnexpectedSmartServerResponse(response)
 
327
        return response, None
 
328
 
155
329
    def open_repository(self):
156
330
        path = self._path_for_remote_call(self._client)
157
 
        verb = 'BzrDir.find_repositoryV2'
158
 
        try:
 
331
        response = None
 
332
        for probe in [self._open_repo_v3, self._open_repo_v2,
 
333
            self._open_repo_v1]:
159
334
            try:
160
 
                response = self._client.call(verb, path)
 
335
                response, real_repo = probe(path)
 
336
                break
161
337
            except errors.UnknownSmartMethod:
162
 
                verb = 'BzrDir.find_repository'
163
 
                response = self._client.call(verb, path)
164
 
        except errors.ErrorFromSmartServer, err:
165
 
            self._translate_error(err)
 
338
                pass
 
339
        if response is None:
 
340
            raise errors.UnknownSmartMethod('BzrDir.find_repository{3,2,}')
166
341
        if response[0] != 'ok':
167
342
            raise errors.UnexpectedSmartServerResponse(response)
168
 
        if verb == 'BzrDir.find_repository':
169
 
            # servers that don't support the V2 method don't support external
170
 
            # references either.
171
 
            response = response + ('no', )
172
 
        if not (len(response) == 5):
 
343
        if len(response) != 6:
173
344
            raise SmartProtocolError('incorrect response length %s' % (response,))
174
345
        if response[1] == '':
175
 
            format = RemoteRepositoryFormat()
176
 
            format.rich_root_data = (response[2] == 'yes')
177
 
            format.supports_tree_reference = (response[3] == 'yes')
178
 
            # No wire format to check this yet.
179
 
            format.supports_external_lookups = (response[4] == 'yes')
 
346
            # repo is at this dir.
 
347
            format = response_tuple_to_repo_format(response[2:])
180
348
            # Used to support creating a real format instance when needed.
181
349
            format._creating_bzrdir = self
182
 
            return RemoteRepository(self, format)
 
350
            remote_repo = RemoteRepository(self, format)
 
351
            format._creating_repo = remote_repo
 
352
            if real_repo is not None:
 
353
                remote_repo._set_real_repository(real_repo)
 
354
            return remote_repo
183
355
        else:
184
356
            raise errors.NoRepositoryPresent(self)
185
357
 
212
384
 
213
385
    def needs_format_conversion(self, format=None):
214
386
        """Upgrading of remote bzrdirs is not supported yet."""
 
387
        if format is None:
 
388
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
 
389
                % 'needs_format_conversion(format=None)')
215
390
        return False
216
391
 
217
392
    def clone(self, url, revision_id=None, force_new_repo=False,
220
395
        return self._real_bzrdir.clone(url, revision_id=revision_id,
221
396
            force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
222
397
 
223
 
    def get_config(self):
224
 
        self._ensure_real()
225
 
        return self._real_bzrdir.get_config()
 
398
    def _get_config(self):
 
399
        return RemoteBzrDirConfig(self)
226
400
 
227
401
 
228
402
class RemoteRepositoryFormat(repository.RepositoryFormat):
236
410
    the attributes rich_root_data and supports_tree_reference are set
237
411
    on a per instance basis, and are not set (and should not be) at
238
412
    the class level.
 
413
 
 
414
    :ivar _custom_format: If set, a specific concrete repository format that
 
415
        will be used when initializing a repository with this
 
416
        RemoteRepositoryFormat.
 
417
    :ivar _creating_repo: If set, the repository object that this
 
418
        RemoteRepositoryFormat was created for: it can be called into
 
419
        to obtain data like the network name.
239
420
    """
240
421
 
241
422
    _matchingbzrdir = RemoteBzrDirFormat()
242
423
 
243
 
    def initialize(self, a_bzrdir, shared=False):
244
 
        if not isinstance(a_bzrdir, RemoteBzrDir):
 
424
    def __init__(self):
 
425
        repository.RepositoryFormat.__init__(self)
 
426
        self._custom_format = None
 
427
        self._network_name = None
 
428
        self._creating_bzrdir = None
 
429
        self._supports_chks = None
 
430
        self._supports_external_lookups = None
 
431
        self._supports_tree_reference = None
 
432
        self._rich_root_data = None
 
433
 
 
434
    def __repr__(self):
 
435
        return "%s(_network_name=%r)" % (self.__class__.__name__,
 
436
            self._network_name)
 
437
 
 
438
    @property
 
439
    def fast_deltas(self):
 
440
        self._ensure_real()
 
441
        return self._custom_format.fast_deltas
 
442
 
 
443
    @property
 
444
    def rich_root_data(self):
 
445
        if self._rich_root_data is None:
 
446
            self._ensure_real()
 
447
            self._rich_root_data = self._custom_format.rich_root_data
 
448
        return self._rich_root_data
 
449
 
 
450
    @property
 
451
    def supports_chks(self):
 
452
        if self._supports_chks is None:
 
453
            self._ensure_real()
 
454
            self._supports_chks = self._custom_format.supports_chks
 
455
        return self._supports_chks
 
456
 
 
457
    @property
 
458
    def supports_external_lookups(self):
 
459
        if self._supports_external_lookups is None:
 
460
            self._ensure_real()
 
461
            self._supports_external_lookups = \
 
462
                self._custom_format.supports_external_lookups
 
463
        return self._supports_external_lookups
 
464
 
 
465
    @property
 
466
    def supports_tree_reference(self):
 
467
        if self._supports_tree_reference is None:
 
468
            self._ensure_real()
 
469
            self._supports_tree_reference = \
 
470
                self._custom_format.supports_tree_reference
 
471
        return self._supports_tree_reference
 
472
 
 
473
    def _vfs_initialize(self, a_bzrdir, shared):
 
474
        """Helper for common code in initialize."""
 
475
        if self._custom_format:
 
476
            # Custom format requested
 
477
            result = self._custom_format.initialize(a_bzrdir, shared=shared)
 
478
        elif self._creating_bzrdir is not None:
 
479
            # Use the format that the repository we were created to back
 
480
            # has.
245
481
            prior_repo = self._creating_bzrdir.open_repository()
246
482
            prior_repo._ensure_real()
247
 
            return prior_repo._real_repository._format.initialize(
 
483
            result = prior_repo._real_repository._format.initialize(
248
484
                a_bzrdir, shared=shared)
249
 
        return a_bzrdir.create_repository(shared=shared)
250
 
    
 
485
        else:
 
486
            # assume that a_bzr is a RemoteBzrDir but the smart server didn't
 
487
            # support remote initialization.
 
488
            # We delegate to a real object at this point (as RemoteBzrDir
 
489
            # delegate to the repository format which would lead to infinite
 
490
            # recursion if we just called a_bzrdir.create_repository.
 
491
            a_bzrdir._ensure_real()
 
492
            result = a_bzrdir._real_bzrdir.create_repository(shared=shared)
 
493
        if not isinstance(result, RemoteRepository):
 
494
            return self.open(a_bzrdir)
 
495
        else:
 
496
            return result
 
497
 
 
498
    def initialize(self, a_bzrdir, shared=False):
 
499
        # Being asked to create on a non RemoteBzrDir:
 
500
        if not isinstance(a_bzrdir, RemoteBzrDir):
 
501
            return self._vfs_initialize(a_bzrdir, shared)
 
502
        medium = a_bzrdir._client._medium
 
503
        if medium._is_remote_before((1, 13)):
 
504
            return self._vfs_initialize(a_bzrdir, shared)
 
505
        # Creating on a remote bzr dir.
 
506
        # 1) get the network name to use.
 
507
        if self._custom_format:
 
508
            network_name = self._custom_format.network_name()
 
509
        elif self._network_name:
 
510
            network_name = self._network_name
 
511
        else:
 
512
            # Select the current bzrlib default and ask for that.
 
513
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
 
514
            reference_format = reference_bzrdir_format.repository_format
 
515
            network_name = reference_format.network_name()
 
516
        # 2) try direct creation via RPC
 
517
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
 
518
        verb = 'BzrDir.create_repository'
 
519
        if shared:
 
520
            shared_str = 'True'
 
521
        else:
 
522
            shared_str = 'False'
 
523
        try:
 
524
            response = a_bzrdir._call(verb, path, network_name, shared_str)
 
525
        except errors.UnknownSmartMethod:
 
526
            # Fallback - use vfs methods
 
527
            medium._remember_remote_is_before((1, 13))
 
528
            return self._vfs_initialize(a_bzrdir, shared)
 
529
        else:
 
530
            # Turn the response into a RemoteRepository object.
 
531
            format = response_tuple_to_repo_format(response[1:])
 
532
            # Used to support creating a real format instance when needed.
 
533
            format._creating_bzrdir = a_bzrdir
 
534
            remote_repo = RemoteRepository(a_bzrdir, format)
 
535
            format._creating_repo = remote_repo
 
536
            return remote_repo
 
537
 
251
538
    def open(self, a_bzrdir):
252
539
        if not isinstance(a_bzrdir, RemoteBzrDir):
253
540
            raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
254
541
        return a_bzrdir.open_repository()
255
542
 
 
543
    def _ensure_real(self):
 
544
        if self._custom_format is None:
 
545
            self._custom_format = repository.network_format_registry.get(
 
546
                self._network_name)
 
547
 
 
548
    @property
 
549
    def _fetch_order(self):
 
550
        self._ensure_real()
 
551
        return self._custom_format._fetch_order
 
552
 
 
553
    @property
 
554
    def _fetch_uses_deltas(self):
 
555
        self._ensure_real()
 
556
        return self._custom_format._fetch_uses_deltas
 
557
 
 
558
    @property
 
559
    def _fetch_reconcile(self):
 
560
        self._ensure_real()
 
561
        return self._custom_format._fetch_reconcile
 
562
 
256
563
    def get_format_description(self):
257
564
        return 'bzr remote repository'
258
565
 
259
566
    def __eq__(self, other):
260
 
        return self.__class__ == other.__class__
261
 
 
262
 
    def check_conversion_target(self, target_format):
263
 
        if self.rich_root_data and not target_format.rich_root_data:
264
 
            raise errors.BadConversionTarget(
265
 
                'Does not support rich root data.', target_format)
266
 
        if (self.supports_tree_reference and
267
 
            not getattr(target_format, 'supports_tree_reference', False)):
268
 
            raise errors.BadConversionTarget(
269
 
                'Does not support nested trees', target_format)
270
 
 
271
 
 
272
 
class RemoteRepository(object):
 
567
        return self.__class__ is other.__class__
 
568
 
 
569
    def network_name(self):
 
570
        if self._network_name:
 
571
            return self._network_name
 
572
        self._creating_repo._ensure_real()
 
573
        return self._creating_repo._real_repository._format.network_name()
 
574
 
 
575
    @property
 
576
    def pack_compresses(self):
 
577
        self._ensure_real()
 
578
        return self._custom_format.pack_compresses
 
579
 
 
580
    @property
 
581
    def _serializer(self):
 
582
        self._ensure_real()
 
583
        return self._custom_format._serializer
 
584
 
 
585
 
 
586
class RemoteRepository(_RpcHelper):
273
587
    """Repository accessed over rpc.
274
588
 
275
589
    For the moment most operations are performed using local transport-backed
278
592
 
279
593
    def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
280
594
        """Create a RemoteRepository instance.
281
 
        
 
595
 
282
596
        :param remote_bzrdir: The bzrdir hosting this repository.
283
597
        :param format: The RemoteFormat object to use.
284
598
        :param real_repository: If not None, a local implementation of the
301
615
        self._lock_token = None
302
616
        self._lock_count = 0
303
617
        self._leave_lock = False
304
 
        # A cache of looked up revision parent data; reset at unlock time.
305
 
        self._parents_map = None
306
 
        if 'hpss' in debug.debug_flags:
307
 
            self._requested_parents = None
 
618
        # Cache of revision parents; misses are cached during read locks, and
 
619
        # write locks when no _real_repository has been set.
 
620
        self._unstacked_provider = graph.CachingParentsProvider(
 
621
            get_parent_map=self._get_parent_map_rpc)
 
622
        self._unstacked_provider.disable_cache()
308
623
        # For tests:
309
624
        # These depend on the actual remote format, so force them off for
310
625
        # maximum compatibility. XXX: In future these should depend on the
322
637
 
323
638
    __repr__ = __str__
324
639
 
325
 
    def abort_write_group(self):
 
640
    def abort_write_group(self, suppress_errors=False):
326
641
        """Complete a write group on the decorated repository.
327
 
        
328
 
        Smart methods peform operations in a single step so this api
 
642
 
 
643
        Smart methods perform operations in a single step so this API
329
644
        is not really applicable except as a compatibility thunk
330
645
        for older plugins that don't use e.g. the CommitBuilder
331
646
        facility.
332
 
        """
333
 
        self._ensure_real()
334
 
        return self._real_repository.abort_write_group()
 
647
 
 
648
        :param suppress_errors: see Repository.abort_write_group.
 
649
        """
 
650
        self._ensure_real()
 
651
        return self._real_repository.abort_write_group(
 
652
            suppress_errors=suppress_errors)
 
653
 
 
654
    @property
 
655
    def chk_bytes(self):
 
656
        """Decorate the real repository for now.
 
657
 
 
658
        In the long term a full blown network facility is needed to avoid
 
659
        creating a real repository object locally.
 
660
        """
 
661
        self._ensure_real()
 
662
        return self._real_repository.chk_bytes
335
663
 
336
664
    def commit_write_group(self):
337
665
        """Complete a write group on the decorated repository.
338
 
        
339
 
        Smart methods peform operations in a single step so this api
 
666
 
 
667
        Smart methods perform operations in a single step so this API
340
668
        is not really applicable except as a compatibility thunk
341
669
        for older plugins that don't use e.g. the CommitBuilder
342
670
        facility.
344
672
        self._ensure_real()
345
673
        return self._real_repository.commit_write_group()
346
674
 
 
675
    def resume_write_group(self, tokens):
 
676
        self._ensure_real()
 
677
        return self._real_repository.resume_write_group(tokens)
 
678
 
 
679
    def suspend_write_group(self):
 
680
        self._ensure_real()
 
681
        return self._real_repository.suspend_write_group()
 
682
 
 
683
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
 
684
        self._ensure_real()
 
685
        return self._real_repository.get_missing_parent_inventories(
 
686
            check_for_missing_texts=check_for_missing_texts)
 
687
 
 
688
    def _get_rev_id_for_revno_vfs(self, revno, known_pair):
 
689
        self._ensure_real()
 
690
        return self._real_repository.get_rev_id_for_revno(
 
691
            revno, known_pair)
 
692
 
 
693
    def get_rev_id_for_revno(self, revno, known_pair):
 
694
        """See Repository.get_rev_id_for_revno."""
 
695
        path = self.bzrdir._path_for_remote_call(self._client)
 
696
        try:
 
697
            if self._client._medium._is_remote_before((1, 17)):
 
698
                return self._get_rev_id_for_revno_vfs(revno, known_pair)
 
699
            response = self._call(
 
700
                'Repository.get_rev_id_for_revno', path, revno, known_pair)
 
701
        except errors.UnknownSmartMethod:
 
702
            self._client._medium._remember_remote_is_before((1, 17))
 
703
            return self._get_rev_id_for_revno_vfs(revno, known_pair)
 
704
        if response[0] == 'ok':
 
705
            return True, response[1]
 
706
        elif response[0] == 'history-incomplete':
 
707
            known_pair = response[1:3]
 
708
            for fallback in self._fallback_repositories:
 
709
                found, result = fallback.get_rev_id_for_revno(revno, known_pair)
 
710
                if found:
 
711
                    return True, result
 
712
                else:
 
713
                    known_pair = result
 
714
            # Not found in any fallbacks
 
715
            return False, known_pair
 
716
        else:
 
717
            raise errors.UnexpectedSmartServerResponse(response)
 
718
 
347
719
    def _ensure_real(self):
348
720
        """Ensure that there is a _real_repository set.
349
721
 
350
722
        Used before calls to self._real_repository.
 
723
 
 
724
        Note that _ensure_real causes many roundtrips to the server which are
 
725
        not desirable, and prevents the use of smart one-roundtrip RPC's to
 
726
        perform complex operations (such as accessing parent data, streaming
 
727
        revisions etc). Adding calls to _ensure_real should only be done when
 
728
        bringing up new functionality, adding fallbacks for smart methods that
 
729
        require a fallback path, and never to replace an existing smart method
 
730
        invocation. If in doubt chat to the bzr network team.
351
731
        """
352
732
        if self._real_repository is None:
 
733
            if 'hpssvfs' in debug.debug_flags:
 
734
                import traceback
 
735
                warning('VFS Repository access triggered\n%s',
 
736
                    ''.join(traceback.format_stack()))
 
737
            self._unstacked_provider.missing_keys.clear()
353
738
            self.bzrdir._ensure_real()
354
739
            self._set_real_repository(
355
740
                self.bzrdir._real_bzrdir.open_repository())
382
767
        self._ensure_real()
383
768
        return self._real_repository._generate_text_key_index()
384
769
 
385
 
    @symbol_versioning.deprecated_method(symbol_versioning.one_four)
386
 
    def get_revision_graph(self, revision_id=None):
387
 
        """See Repository.get_revision_graph()."""
388
 
        return self._get_revision_graph(revision_id)
389
 
 
390
770
    def _get_revision_graph(self, revision_id):
391
771
        """Private method for using with old (< 1.2) servers to fallback."""
392
772
        if revision_id is None:
395
775
            return {}
396
776
 
397
777
        path = self.bzrdir._path_for_remote_call(self._client)
398
 
        try:
399
 
            response = self._client.call_expecting_body(
400
 
                'Repository.get_revision_graph', path, revision_id)
401
 
        except errors.ErrorFromSmartServer, err:
402
 
            self._translate_error(err)
 
778
        response = self._call_expecting_body(
 
779
            'Repository.get_revision_graph', path, revision_id)
403
780
        response_tuple, response_handler = response
404
781
        if response_tuple[0] != 'ok':
405
782
            raise errors.UnexpectedSmartServerResponse(response_tuple)
412
789
        for line in lines:
413
790
            d = tuple(line.split())
414
791
            revision_graph[d[0]] = d[1:]
415
 
            
 
792
 
416
793
        return revision_graph
417
794
 
 
795
    def _get_sink(self):
 
796
        """See Repository._get_sink()."""
 
797
        return RemoteStreamSink(self)
 
798
 
 
799
    def _get_source(self, to_format):
 
800
        """Return a source for streaming from this repository."""
 
801
        return RemoteStreamSource(self, to_format)
 
802
 
 
803
    @needs_read_lock
418
804
    def has_revision(self, revision_id):
419
 
        """See Repository.has_revision()."""
420
 
        if revision_id == NULL_REVISION:
421
 
            # The null revision is always present.
422
 
            return True
423
 
        path = self.bzrdir._path_for_remote_call(self._client)
424
 
        response = self._client.call(
425
 
            'Repository.has_revision', path, revision_id)
426
 
        if response[0] not in ('yes', 'no'):
427
 
            raise errors.UnexpectedSmartServerResponse(response)
428
 
        return response[0] == 'yes'
 
805
        """True if this repository has a copy of the revision."""
 
806
        # Copy of bzrlib.repository.Repository.has_revision
 
807
        return revision_id in self.has_revisions((revision_id,))
429
808
 
 
809
    @needs_read_lock
430
810
    def has_revisions(self, revision_ids):
431
 
        """See Repository.has_revisions()."""
432
 
        result = set()
433
 
        for revision_id in revision_ids:
434
 
            if self.has_revision(revision_id):
435
 
                result.add(revision_id)
 
811
        """Probe to find out the presence of multiple revisions.
 
812
 
 
813
        :param revision_ids: An iterable of revision_ids.
 
814
        :return: A set of the revision_ids that were present.
 
815
        """
 
816
        # Copy of bzrlib.repository.Repository.has_revisions
 
817
        parent_map = self.get_parent_map(revision_ids)
 
818
        result = set(parent_map)
 
819
        if _mod_revision.NULL_REVISION in revision_ids:
 
820
            result.add(_mod_revision.NULL_REVISION)
436
821
        return result
437
822
 
 
823
    def _has_same_fallbacks(self, other_repo):
 
824
        """Returns true if the repositories have the same fallbacks."""
 
825
        # XXX: copied from Repository; it should be unified into a base class
 
826
        # <https://bugs.edge.launchpad.net/bzr/+bug/401622>
 
827
        my_fb = self._fallback_repositories
 
828
        other_fb = other_repo._fallback_repositories
 
829
        if len(my_fb) != len(other_fb):
 
830
            return False
 
831
        for f, g in zip(my_fb, other_fb):
 
832
            if not f.has_same_location(g):
 
833
                return False
 
834
        return True
 
835
 
438
836
    def has_same_location(self, other):
439
 
        return (self.__class__ == other.__class__ and
 
837
        # TODO: Move to RepositoryBase and unify with the regular Repository
 
838
        # one; unfortunately the tests rely on slightly different behaviour at
 
839
        # present -- mbp 20090710
 
840
        return (self.__class__ is other.__class__ and
440
841
                self.bzrdir.transport.base == other.bzrdir.transport.base)
441
 
        
 
842
 
442
843
    def get_graph(self, other_repository=None):
443
844
        """Return the graph for this repository format"""
444
 
        parents_provider = self
445
 
        if (other_repository is not None and
446
 
            other_repository.bzrdir.transport.base !=
447
 
            self.bzrdir.transport.base):
448
 
            parents_provider = graph._StackedParentsProvider(
449
 
                [parents_provider, other_repository._make_parents_provider()])
 
845
        parents_provider = self._make_parents_provider(other_repository)
450
846
        return graph.Graph(parents_provider)
451
847
 
452
848
    def gather_stats(self, revid=None, committers=None):
461
857
            fmt_committers = 'no'
462
858
        else:
463
859
            fmt_committers = 'yes'
464
 
        response_tuple, response_handler = self._client.call_expecting_body(
 
860
        response_tuple, response_handler = self._call_expecting_body(
465
861
            'Repository.gather_stats', path, fmt_revid, fmt_committers)
466
862
        if response_tuple[0] != 'ok':
467
863
            raise errors.UnexpectedSmartServerResponse(response_tuple)
506
902
    def is_shared(self):
507
903
        """See Repository.is_shared()."""
508
904
        path = self.bzrdir._path_for_remote_call(self._client)
509
 
        response = self._client.call('Repository.is_shared', path)
 
905
        response = self._call('Repository.is_shared', path)
510
906
        if response[0] not in ('yes', 'no'):
511
907
            raise SmartProtocolError('unexpected response code %s' % (response,))
512
908
        return response[0] == 'yes'
519
915
        if not self._lock_mode:
520
916
            self._lock_mode = 'r'
521
917
            self._lock_count = 1
522
 
            self._parents_map = {}
523
 
            if 'hpss' in debug.debug_flags:
524
 
                self._requested_parents = set()
 
918
            self._unstacked_provider.enable_cache(cache_misses=True)
525
919
            if self._real_repository is not None:
526
920
                self._real_repository.lock_read()
 
921
            for repo in self._fallback_repositories:
 
922
                repo.lock_read()
527
923
        else:
528
924
            self._lock_count += 1
529
925
 
531
927
        path = self.bzrdir._path_for_remote_call(self._client)
532
928
        if token is None:
533
929
            token = ''
534
 
        try:
535
 
            response = self._client.call('Repository.lock_write', path, token)
536
 
        except errors.ErrorFromSmartServer, err:
537
 
            self._translate_error(err, token=token)
538
 
 
 
930
        err_context = {'token': token}
 
931
        response = self._call('Repository.lock_write', path, token,
 
932
                              **err_context)
539
933
        if response[0] == 'ok':
540
934
            ok, token = response
541
935
            return token
563
957
                self._leave_lock = False
564
958
            self._lock_mode = 'w'
565
959
            self._lock_count = 1
566
 
            self._parents_map = {}
567
 
            if 'hpss' in debug.debug_flags:
568
 
                self._requested_parents = set()
 
960
            cache_misses = self._real_repository is None
 
961
            self._unstacked_provider.enable_cache(cache_misses=cache_misses)
 
962
            for repo in self._fallback_repositories:
 
963
                # Writes don't affect fallback repos
 
964
                repo.lock_read()
569
965
        elif self._lock_mode == 'r':
570
966
            raise errors.ReadOnlyError(self)
571
967
        else:
589
985
            implemented operations.
590
986
        """
591
987
        if self._real_repository is not None:
592
 
            raise AssertionError('_real_repository is already set')
 
988
            # Replacing an already set real repository.
 
989
            # We cannot do this [currently] if the repository is locked -
 
990
            # synchronised state might be lost.
 
991
            if self.is_locked():
 
992
                raise AssertionError('_real_repository is already set')
593
993
        if isinstance(repository, RemoteRepository):
594
994
            raise AssertionError()
595
995
        self._real_repository = repository
 
996
        # three code paths happen here:
 
997
        # 1) old servers, RemoteBranch.open() calls _ensure_real before setting
 
998
        # up stacking. In this case self._fallback_repositories is [], and the
 
999
        # real repo is already setup. Preserve the real repo and
 
1000
        # RemoteRepository.add_fallback_repository will avoid adding
 
1001
        # duplicates.
 
1002
        # 2) new servers, RemoteBranch.open() sets up stacking, and when
 
1003
        # ensure_real is triggered from a branch, the real repository to
 
1004
        # set already has a matching list with separate instances, but
 
1005
        # as they are also RemoteRepositories we don't worry about making the
 
1006
        # lists be identical.
 
1007
        # 3) new servers, RemoteRepository.ensure_real is triggered before
 
1008
        # RemoteBranch.ensure real, in this case we get a repo with no fallbacks
 
1009
        # and need to populate it.
 
1010
        if (self._fallback_repositories and
 
1011
            len(self._real_repository._fallback_repositories) !=
 
1012
            len(self._fallback_repositories)):
 
1013
            if len(self._real_repository._fallback_repositories):
 
1014
                raise AssertionError(
 
1015
                    "cannot cleanly remove existing _fallback_repositories")
 
1016
        for fb in self._fallback_repositories:
 
1017
            self._real_repository.add_fallback_repository(fb)
596
1018
        if self._lock_mode == 'w':
597
1019
            # if we are already locked, the real repository must be able to
598
1020
            # acquire the lock with our token.
602
1024
 
603
1025
    def start_write_group(self):
604
1026
        """Start a write group on the decorated repository.
605
 
        
606
 
        Smart methods peform operations in a single step so this api
 
1027
 
 
1028
        Smart methods perform operations in a single step so this API
607
1029
        is not really applicable except as a compatibility thunk
608
1030
        for older plugins that don't use e.g. the CommitBuilder
609
1031
        facility.
616
1038
        if not token:
617
1039
            # with no token the remote repository is not persistently locked.
618
1040
            return
619
 
        try:
620
 
            response = self._client.call('Repository.unlock', path, token)
621
 
        except errors.ErrorFromSmartServer, err:
622
 
            self._translate_error(err, token=token)
 
1041
        err_context = {'token': token}
 
1042
        response = self._call('Repository.unlock', path, token,
 
1043
                              **err_context)
623
1044
        if response == ('ok',):
624
1045
            return
625
1046
        else:
626
1047
            raise errors.UnexpectedSmartServerResponse(response)
627
1048
 
628
1049
    def unlock(self):
 
1050
        if not self._lock_count:
 
1051
            return lock.cant_unlock_not_held(self)
629
1052
        self._lock_count -= 1
630
1053
        if self._lock_count > 0:
631
1054
            return
632
 
        self._parents_map = None
633
 
        if 'hpss' in debug.debug_flags:
634
 
            self._requested_parents = None
 
1055
        self._unstacked_provider.disable_cache()
635
1056
        old_mode = self._lock_mode
636
1057
        self._lock_mode = None
637
1058
        try:
647
1068
            # problem releasing the vfs-based lock.
648
1069
            if old_mode == 'w':
649
1070
                # Only write-locked repositories need to make a remote method
650
 
                # call to perfom the unlock.
 
1071
                # call to perform the unlock.
651
1072
                old_token = self._lock_token
652
1073
                self._lock_token = None
653
1074
                if not self._leave_lock:
654
1075
                    self._unlock(old_token)
 
1076
        # Fallbacks are always 'lock_read()' so we don't pay attention to
 
1077
        # self._leave_lock
 
1078
        for repo in self._fallback_repositories:
 
1079
            repo.unlock()
655
1080
 
656
1081
    def break_lock(self):
657
1082
        # should hand off to the network
660
1085
 
661
1086
    def _get_tarball(self, compression):
662
1087
        """Return a TemporaryFile containing a repository tarball.
663
 
        
 
1088
 
664
1089
        Returns None if the server does not support sending tarballs.
665
1090
        """
666
1091
        import tempfile
667
1092
        path = self.bzrdir._path_for_remote_call(self._client)
668
1093
        try:
669
 
            response, protocol = self._client.call_expecting_body(
 
1094
            response, protocol = self._call_expecting_body(
670
1095
                'Repository.tarball', path, compression)
671
1096
        except errors.UnknownSmartMethod:
672
1097
            protocol.cancel_read_body()
712
1137
 
713
1138
    def add_fallback_repository(self, repository):
714
1139
        """Add a repository to use for looking up data not held locally.
715
 
        
 
1140
 
716
1141
        :param repository: A repository.
717
1142
        """
718
1143
        if not self._format.supports_external_lookups:
719
 
            raise errors.UnstackableRepositoryFormat(self._format, self.base)
 
1144
            raise errors.UnstackableRepositoryFormat(
 
1145
                self._format.network_name(), self.base)
720
1146
        # We need to accumulate additional repositories here, to pass them in
721
1147
        # on various RPC's.
 
1148
        #
 
1149
        if self.is_locked():
 
1150
            # We will call fallback.unlock() when we transition to the unlocked
 
1151
            # state, so always add a lock here. If a caller passes us a locked
 
1152
            # repository, they are responsible for unlocking it later.
 
1153
            repository.lock_read()
722
1154
        self._fallback_repositories.append(repository)
 
1155
        # If self._real_repository was parameterised already (e.g. because a
 
1156
        # _real_branch had its get_stacked_on_url method called), then the
 
1157
        # repository to be added may already be in the _real_repositories list.
 
1158
        if self._real_repository is not None:
 
1159
            fallback_locations = [repo.bzrdir.root_transport.base for repo in
 
1160
                self._real_repository._fallback_repositories]
 
1161
            if repository.bzrdir.root_transport.base not in fallback_locations:
 
1162
                self._real_repository.add_fallback_repository(repository)
723
1163
 
724
1164
    def add_inventory(self, revid, inv, parents):
725
1165
        self._ensure_real()
726
1166
        return self._real_repository.add_inventory(revid, inv, parents)
727
1167
 
 
1168
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
 
1169
                               parents):
 
1170
        self._ensure_real()
 
1171
        return self._real_repository.add_inventory_by_delta(basis_revision_id,
 
1172
            delta, new_revision_id, parents)
 
1173
 
728
1174
    def add_revision(self, rev_id, rev, inv=None, config=None):
729
1175
        self._ensure_real()
730
1176
        return self._real_repository.add_revision(
735
1181
        self._ensure_real()
736
1182
        return self._real_repository.get_inventory(revision_id)
737
1183
 
738
 
    def iter_inventories(self, revision_ids):
 
1184
    def iter_inventories(self, revision_ids, ordering=None):
739
1185
        self._ensure_real()
740
 
        return self._real_repository.iter_inventories(revision_ids)
 
1186
        return self._real_repository.iter_inventories(revision_ids, ordering)
741
1187
 
742
1188
    @needs_read_lock
743
1189
    def get_revision(self, revision_id):
758
1204
        self._ensure_real()
759
1205
        return self._real_repository.make_working_trees()
760
1206
 
 
1207
    def refresh_data(self):
 
1208
        """Re-read any data needed to to synchronise with disk.
 
1209
 
 
1210
        This method is intended to be called after another repository instance
 
1211
        (such as one used by a smart server) has inserted data into the
 
1212
        repository. It may not be called during a write group, but may be
 
1213
        called at any other time.
 
1214
        """
 
1215
        if self.is_in_write_group():
 
1216
            raise errors.InternalBzrError(
 
1217
                "May not refresh_data while in a write group.")
 
1218
        if self._real_repository is not None:
 
1219
            self._real_repository.refresh_data()
 
1220
 
761
1221
    def revision_ids_to_search_result(self, result_set):
762
1222
        """Convert a set of revision ids to a graph SearchResult."""
763
1223
        result_parents = set()
774
1234
    @needs_read_lock
775
1235
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
776
1236
        """Return the revision ids that other has that this does not.
777
 
        
 
1237
 
778
1238
        These are returned in topological order.
779
1239
 
780
1240
        revision_id: only return revision ids included by revision_id.
782
1242
        return repository.InterRepository.get(
783
1243
            other, self).search_missing_revision_ids(revision_id, find_ghosts)
784
1244
 
785
 
    def fetch(self, source, revision_id=None, pb=None):
786
 
        if self.has_same_location(source):
 
1245
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
 
1246
            fetch_spec=None):
 
1247
        # No base implementation to use as RemoteRepository is not a subclass
 
1248
        # of Repository; so this is a copy of Repository.fetch().
 
1249
        if fetch_spec is not None and revision_id is not None:
 
1250
            raise AssertionError(
 
1251
                "fetch_spec and revision_id are mutually exclusive.")
 
1252
        if self.is_in_write_group():
 
1253
            raise errors.InternalBzrError(
 
1254
                "May not fetch while in a write group.")
 
1255
        # fast path same-url fetch operations
 
1256
        if (self.has_same_location(source)
 
1257
            and fetch_spec is None
 
1258
            and self._has_same_fallbacks(source)):
787
1259
            # check that last_revision is in 'from' and then return a
788
1260
            # no-operation.
789
1261
            if (revision_id is not None and
790
1262
                not revision.is_null(revision_id)):
791
1263
                self.get_revision(revision_id)
792
1264
            return 0, []
793
 
        self._ensure_real()
794
 
        return self._real_repository.fetch(
795
 
            source, revision_id=revision_id, pb=pb)
 
1265
        # if there is no specific appropriate InterRepository, this will get
 
1266
        # the InterRepository base class, which raises an
 
1267
        # IncompatibleRepositories when asked to fetch.
 
1268
        inter = repository.InterRepository.get(source, self)
 
1269
        return inter.fetch(revision_id=revision_id, pb=pb,
 
1270
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
796
1271
 
797
1272
    def create_bundle(self, target, base, fileobj, format=None):
798
1273
        self._ensure_real()
811
1286
        self._ensure_real()
812
1287
        return self._real_repository._get_versioned_file_checker(
813
1288
            revisions, revision_versions_cache)
814
 
        
 
1289
 
815
1290
    def iter_files_bytes(self, desired_files):
816
1291
        """See Repository.iter_file_bytes.
817
1292
        """
818
1293
        self._ensure_real()
819
1294
        return self._real_repository.iter_files_bytes(desired_files)
820
1295
 
821
 
    @property
822
 
    def _fetch_order(self):
823
 
        """Decorate the real repository for now.
824
 
 
825
 
        In the long term getting this back from the remote repository as part
826
 
        of open would be more efficient.
827
 
        """
828
 
        self._ensure_real()
829
 
        return self._real_repository._fetch_order
830
 
 
831
 
    @property
832
 
    def _fetch_uses_deltas(self):
833
 
        """Decorate the real repository for now.
834
 
 
835
 
        In the long term getting this back from the remote repository as part
836
 
        of open would be more efficient.
837
 
        """
838
 
        self._ensure_real()
839
 
        return self._real_repository._fetch_uses_deltas
840
 
 
841
 
    @property
842
 
    def _fetch_reconcile(self):
843
 
        """Decorate the real repository for now.
844
 
 
845
 
        In the long term getting this back from the remote repository as part
846
 
        of open would be more efficient.
847
 
        """
848
 
        self._ensure_real()
849
 
        return self._real_repository._fetch_reconcile
850
 
 
851
 
    def get_parent_map(self, keys):
 
1296
    def get_parent_map(self, revision_ids):
852
1297
        """See bzrlib.Graph.get_parent_map()."""
853
 
        # Hack to build up the caching logic.
854
 
        ancestry = self._parents_map
855
 
        if ancestry is None:
856
 
            # Repository is not locked, so there's no cache.
857
 
            missing_revisions = set(keys)
858
 
            ancestry = {}
859
 
        else:
860
 
            missing_revisions = set(key for key in keys if key not in ancestry)
861
 
        if missing_revisions:
862
 
            parent_map = self._get_parent_map(missing_revisions)
863
 
            if 'hpss' in debug.debug_flags:
864
 
                mutter('retransmitted revisions: %d of %d',
865
 
                        len(set(ancestry).intersection(parent_map)),
866
 
                        len(parent_map))
867
 
            ancestry.update(parent_map)
868
 
        present_keys = [k for k in keys if k in ancestry]
869
 
        if 'hpss' in debug.debug_flags:
870
 
            if self._requested_parents is not None and len(ancestry) != 0:
871
 
                self._requested_parents.update(present_keys)
872
 
                mutter('Current RemoteRepository graph hit rate: %d%%',
873
 
                    100.0 * len(self._requested_parents) / len(ancestry))
874
 
        return dict((k, ancestry[k]) for k in present_keys)
 
1298
        return self._make_parents_provider().get_parent_map(revision_ids)
875
1299
 
876
 
    def _get_parent_map(self, keys):
 
1300
    def _get_parent_map_rpc(self, keys):
877
1301
        """Helper for get_parent_map that performs the RPC."""
878
1302
        medium = self._client._medium
879
1303
        if medium._is_remote_before((1, 2)):
880
1304
            # We already found out that the server can't understand
881
1305
            # Repository.get_parent_map requests, so just fetch the whole
882
1306
            # graph.
883
 
            # XXX: Note that this will issue a deprecation warning. This is ok
884
 
            # :- its because we're working with a deprecated server anyway, and
885
 
            # the user will almost certainly have seen a warning about the
886
 
            # server version already.
887
 
            rg = self.get_revision_graph()
888
 
            # There is an api discrepency between get_parent_map and
 
1307
            #
 
1308
            # Note that this reads the whole graph, when only some keys are
 
1309
            # wanted.  On this old server there's no way (?) to get them all
 
1310
            # in one go, and the user probably will have seen a warning about
 
1311
            # the server being old anyhow.
 
1312
            rg = self._get_revision_graph(None)
 
1313
            # There is an API discrepancy between get_parent_map and
889
1314
            # get_revision_graph. Specifically, a "key:()" pair in
890
1315
            # get_revision_graph just means a node has no parents. For
891
1316
            # "get_parent_map" it means the node is a ghost. So fix up the
921
1346
        # TODO: Manage this incrementally to avoid covering the same path
922
1347
        # repeatedly. (The server will have to on each request, but the less
923
1348
        # work done the better).
924
 
        parents_map = self._parents_map
 
1349
        #
 
1350
        # Negative caching notes:
 
1351
        # new server sends missing when a request including the revid
 
1352
        # 'include-missing:' is present in the request.
 
1353
        # missing keys are serialised as missing:X, and we then call
 
1354
        # provider.note_missing(X) for-all X
 
1355
        parents_map = self._unstacked_provider.get_cached_map()
925
1356
        if parents_map is None:
926
1357
            # Repository is not locked, so there's no cache.
927
1358
            parents_map = {}
 
1359
        # start_set is all the keys in the cache
928
1360
        start_set = set(parents_map)
 
1361
        # result set is all the references to keys in the cache
929
1362
        result_parents = set()
930
1363
        for parents in parents_map.itervalues():
931
1364
            result_parents.update(parents)
932
1365
        stop_keys = result_parents.difference(start_set)
 
1366
        # We don't need to send ghosts back to the server as a position to
 
1367
        # stop either.
 
1368
        stop_keys.difference_update(self._unstacked_provider.missing_keys)
 
1369
        key_count = len(parents_map)
 
1370
        if (NULL_REVISION in result_parents
 
1371
            and NULL_REVISION in self._unstacked_provider.missing_keys):
 
1372
            # If we pruned NULL_REVISION from the stop_keys because it's also
 
1373
            # in our cache of "missing" keys we need to increment our key count
 
1374
            # by 1, because the reconsitituted SearchResult on the server will
 
1375
            # still consider NULL_REVISION to be an included key.
 
1376
            key_count += 1
933
1377
        included_keys = start_set.intersection(result_parents)
934
1378
        start_set.difference_update(included_keys)
935
 
        recipe = (start_set, stop_keys, len(parents_map))
 
1379
        recipe = ('manual', start_set, stop_keys, key_count)
936
1380
        body = self._serialise_search_recipe(recipe)
937
1381
        path = self.bzrdir._path_for_remote_call(self._client)
938
1382
        for key in keys:
940
1384
                raise ValueError(
941
1385
                    "key %r not a plain string" % (key,))
942
1386
        verb = 'Repository.get_parent_map'
943
 
        args = (path,) + tuple(keys)
 
1387
        args = (path, 'include-missing:') + tuple(keys)
944
1388
        try:
945
 
            response = self._client.call_with_body_bytes_expecting_body(
946
 
                verb, args, self._serialise_search_recipe(recipe))
 
1389
            response = self._call_with_body_bytes_expecting_body(
 
1390
                verb, args, body)
947
1391
        except errors.UnknownSmartMethod:
948
1392
            # Server does not support this method, so get the whole graph.
949
1393
            # Worse, we have to force a disconnection, because the server now
956
1400
            # To avoid having to disconnect repeatedly, we keep track of the
957
1401
            # fact the server doesn't understand remote methods added in 1.2.
958
1402
            medium._remember_remote_is_before((1, 2))
959
 
            return self.get_revision_graph(None)
 
1403
            # Recurse just once and we should use the fallback code.
 
1404
            return self._get_parent_map_rpc(keys)
960
1405
        response_tuple, response_handler = response
961
1406
        if response_tuple[0] not in ['ok']:
962
1407
            response_handler.cancel_read_body()
973
1418
                if len(d) > 1:
974
1419
                    revision_graph[d[0]] = d[1:]
975
1420
                else:
976
 
                    # No parents - so give the Graph result (NULL_REVISION,).
977
 
                    revision_graph[d[0]] = (NULL_REVISION,)
 
1421
                    # No parents:
 
1422
                    if d[0].startswith('missing:'):
 
1423
                        revid = d[0][8:]
 
1424
                        self._unstacked_provider.note_missing_key(revid)
 
1425
                    else:
 
1426
                        # no parents - so give the Graph result
 
1427
                        # (NULL_REVISION,).
 
1428
                        revision_graph[d[0]] = (NULL_REVISION,)
978
1429
            return revision_graph
979
1430
 
980
1431
    @needs_read_lock
983
1434
        return self._real_repository.get_signature_text(revision_id)
984
1435
 
985
1436
    @needs_read_lock
986
 
    @symbol_versioning.deprecated_method(symbol_versioning.one_three)
987
 
    def get_revision_graph_with_ghosts(self, revision_ids=None):
988
 
        self._ensure_real()
989
 
        return self._real_repository.get_revision_graph_with_ghosts(
990
 
            revision_ids=revision_ids)
991
 
 
992
 
    @needs_read_lock
993
1437
    def get_inventory_xml(self, revision_id):
994
1438
        self._ensure_real()
995
1439
        return self._real_repository.get_inventory_xml(revision_id)
1001
1445
    def reconcile(self, other=None, thorough=False):
1002
1446
        self._ensure_real()
1003
1447
        return self._real_repository.reconcile(other=other, thorough=thorough)
1004
 
        
 
1448
 
1005
1449
    def all_revision_ids(self):
1006
1450
        self._ensure_real()
1007
1451
        return self._real_repository.all_revision_ids()
1008
 
    
1009
 
    @needs_read_lock
1010
 
    def get_deltas_for_revisions(self, revisions):
1011
 
        self._ensure_real()
1012
 
        return self._real_repository.get_deltas_for_revisions(revisions)
1013
 
 
1014
 
    @needs_read_lock
1015
 
    def get_revision_delta(self, revision_id):
1016
 
        self._ensure_real()
1017
 
        return self._real_repository.get_revision_delta(revision_id)
 
1452
 
 
1453
    @needs_read_lock
 
1454
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
 
1455
        self._ensure_real()
 
1456
        return self._real_repository.get_deltas_for_revisions(revisions,
 
1457
            specific_fileids=specific_fileids)
 
1458
 
 
1459
    @needs_read_lock
 
1460
    def get_revision_delta(self, revision_id, specific_fileids=None):
 
1461
        self._ensure_real()
 
1462
        return self._real_repository.get_revision_delta(revision_id,
 
1463
            specific_fileids=specific_fileids)
1018
1464
 
1019
1465
    @needs_read_lock
1020
1466
    def revision_trees(self, revision_ids):
1027
1473
        return self._real_repository.get_revision_reconcile(revision_id)
1028
1474
 
1029
1475
    @needs_read_lock
1030
 
    def check(self, revision_ids=None):
 
1476
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
1031
1477
        self._ensure_real()
1032
 
        return self._real_repository.check(revision_ids=revision_ids)
 
1478
        return self._real_repository.check(revision_ids=revision_ids,
 
1479
            callback_refs=callback_refs, check_repo=check_repo)
1033
1480
 
1034
1481
    def copy_content_into(self, destination, revision_id=None):
1035
1482
        self._ensure_real()
1075
1522
        return self._real_repository.inventories
1076
1523
 
1077
1524
    @needs_write_lock
1078
 
    def pack(self):
 
1525
    def pack(self, hint=None):
1079
1526
        """Compress the data within the repository.
1080
1527
 
1081
1528
        This is not currently implemented within the smart server.
1082
1529
        """
1083
1530
        self._ensure_real()
1084
 
        return self._real_repository.pack()
 
1531
        return self._real_repository.pack(hint=hint)
1085
1532
 
1086
1533
    @property
1087
1534
    def revisions(self):
1096
1543
        return self._real_repository.revisions
1097
1544
 
1098
1545
    def set_make_working_trees(self, new_value):
1099
 
        self._ensure_real()
1100
 
        self._real_repository.set_make_working_trees(new_value)
 
1546
        if new_value:
 
1547
            new_value_str = "True"
 
1548
        else:
 
1549
            new_value_str = "False"
 
1550
        path = self.bzrdir._path_for_remote_call(self._client)
 
1551
        try:
 
1552
            response = self._call(
 
1553
                'Repository.set_make_working_trees', path, new_value_str)
 
1554
        except errors.UnknownSmartMethod:
 
1555
            self._ensure_real()
 
1556
            self._real_repository.set_make_working_trees(new_value)
 
1557
        else:
 
1558
            if response[0] != 'ok':
 
1559
                raise errors.UnexpectedSmartServerResponse(response)
1101
1560
 
1102
1561
    @property
1103
1562
    def signatures(self):
1130
1589
        return self._real_repository.get_revisions(revision_ids)
1131
1590
 
1132
1591
    def supports_rich_root(self):
1133
 
        self._ensure_real()
1134
 
        return self._real_repository.supports_rich_root()
 
1592
        return self._format.rich_root_data
1135
1593
 
1136
1594
    def iter_reverse_revision_history(self, revision_id):
1137
1595
        self._ensure_real()
1139
1597
 
1140
1598
    @property
1141
1599
    def _serializer(self):
1142
 
        self._ensure_real()
1143
 
        return self._real_repository._serializer
 
1600
        return self._format._serializer
1144
1601
 
1145
1602
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1146
1603
        self._ensure_real()
1165
1622
        self._ensure_real()
1166
1623
        return self._real_repository.revision_graph_can_have_wrong_parents()
1167
1624
 
1168
 
    def _find_inconsistent_revision_parents(self):
 
1625
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
1169
1626
        self._ensure_real()
1170
 
        return self._real_repository._find_inconsistent_revision_parents()
 
1627
        return self._real_repository._find_inconsistent_revision_parents(
 
1628
            revisions_iterator)
1171
1629
 
1172
1630
    def _check_for_inconsistent_revision_parents(self):
1173
1631
        self._ensure_real()
1174
1632
        return self._real_repository._check_for_inconsistent_revision_parents()
1175
1633
 
1176
 
    def _make_parents_provider(self):
1177
 
        return self
 
1634
    def _make_parents_provider(self, other=None):
 
1635
        providers = [self._unstacked_provider]
 
1636
        if other is not None:
 
1637
            providers.insert(0, other)
 
1638
        providers.extend(r._make_parents_provider() for r in
 
1639
                         self._fallback_repositories)
 
1640
        return graph.StackedParentsProvider(providers)
1178
1641
 
1179
1642
    def _serialise_search_recipe(self, recipe):
1180
1643
        """Serialise a graph search recipe.
1182
1645
        :param recipe: A search recipe (start, stop, count).
1183
1646
        :return: Serialised bytes.
1184
1647
        """
1185
 
        start_keys = ' '.join(recipe[0])
1186
 
        stop_keys = ' '.join(recipe[1])
1187
 
        count = str(recipe[2])
 
1648
        start_keys = ' '.join(recipe[1])
 
1649
        stop_keys = ' '.join(recipe[2])
 
1650
        count = str(recipe[3])
1188
1651
        return '\n'.join((start_keys, stop_keys, count))
1189
1652
 
 
1653
    def _serialise_search_result(self, search_result):
 
1654
        if isinstance(search_result, graph.PendingAncestryResult):
 
1655
            parts = ['ancestry-of']
 
1656
            parts.extend(search_result.heads)
 
1657
        else:
 
1658
            recipe = search_result.get_recipe()
 
1659
            parts = [recipe[0], self._serialise_search_recipe(recipe)]
 
1660
        return '\n'.join(parts)
 
1661
 
 
1662
    def autopack(self):
 
1663
        path = self.bzrdir._path_for_remote_call(self._client)
 
1664
        try:
 
1665
            response = self._call('PackRepository.autopack', path)
 
1666
        except errors.UnknownSmartMethod:
 
1667
            self._ensure_real()
 
1668
            self._real_repository._pack_collection.autopack()
 
1669
            return
 
1670
        self.refresh_data()
 
1671
        if response[0] != 'ok':
 
1672
            raise errors.UnexpectedSmartServerResponse(response)
 
1673
 
 
1674
 
 
1675
class RemoteStreamSink(repository.StreamSink):
 
1676
 
 
1677
    def _insert_real(self, stream, src_format, resume_tokens):
 
1678
        self.target_repo._ensure_real()
 
1679
        sink = self.target_repo._real_repository._get_sink()
 
1680
        result = sink.insert_stream(stream, src_format, resume_tokens)
 
1681
        if not result:
 
1682
            self.target_repo.autopack()
 
1683
        return result
 
1684
 
 
1685
    def insert_stream(self, stream, src_format, resume_tokens):
 
1686
        target = self.target_repo
 
1687
        target._unstacked_provider.missing_keys.clear()
 
1688
        candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
 
1689
        if target._lock_token:
 
1690
            candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
 
1691
            lock_args = (target._lock_token or '',)
 
1692
        else:
 
1693
            candidate_calls.append(('Repository.insert_stream', (1, 13)))
 
1694
            lock_args = ()
 
1695
        client = target._client
 
1696
        medium = client._medium
 
1697
        path = target.bzrdir._path_for_remote_call(client)
 
1698
        # Probe for the verb to use with an empty stream before sending the
 
1699
        # real stream to it.  We do this both to avoid the risk of sending a
 
1700
        # large request that is then rejected, and because we don't want to
 
1701
        # implement a way to buffer, rewind, or restart the stream.
 
1702
        found_verb = False
 
1703
        for verb, required_version in candidate_calls:
 
1704
            if medium._is_remote_before(required_version):
 
1705
                continue
 
1706
            if resume_tokens:
 
1707
                # We've already done the probing (and set _is_remote_before) on
 
1708
                # a previous insert.
 
1709
                found_verb = True
 
1710
                break
 
1711
            byte_stream = smart_repo._stream_to_byte_stream([], src_format)
 
1712
            try:
 
1713
                response = client.call_with_body_stream(
 
1714
                    (verb, path, '') + lock_args, byte_stream)
 
1715
            except errors.UnknownSmartMethod:
 
1716
                medium._remember_remote_is_before(required_version)
 
1717
            else:
 
1718
                found_verb = True
 
1719
                break
 
1720
        if not found_verb:
 
1721
            # Have to use VFS.
 
1722
            return self._insert_real(stream, src_format, resume_tokens)
 
1723
        self._last_inv_record = None
 
1724
        self._last_substream = None
 
1725
        if required_version < (1, 19):
 
1726
            # Remote side doesn't support inventory deltas.  Wrap the stream to
 
1727
            # make sure we don't send any.  If the stream contains inventory
 
1728
            # deltas we'll interrupt the smart insert_stream request and
 
1729
            # fallback to VFS.
 
1730
            stream = self._stop_stream_if_inventory_delta(stream)
 
1731
        byte_stream = smart_repo._stream_to_byte_stream(
 
1732
            stream, src_format)
 
1733
        resume_tokens = ' '.join(resume_tokens)
 
1734
        response = client.call_with_body_stream(
 
1735
            (verb, path, resume_tokens) + lock_args, byte_stream)
 
1736
        if response[0][0] not in ('ok', 'missing-basis'):
 
1737
            raise errors.UnexpectedSmartServerResponse(response)
 
1738
        if self._last_substream is not None:
 
1739
            # The stream included an inventory-delta record, but the remote
 
1740
            # side isn't new enough to support them.  So we need to send the
 
1741
            # rest of the stream via VFS.
 
1742
            return self._resume_stream_with_vfs(response, src_format)
 
1743
        if response[0][0] == 'missing-basis':
 
1744
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
 
1745
            resume_tokens = tokens
 
1746
            return resume_tokens, set(missing_keys)
 
1747
        else:
 
1748
            self.target_repo.refresh_data()
 
1749
            return [], set()
 
1750
 
 
1751
    def _resume_stream_with_vfs(self, response, src_format):
 
1752
        """Resume sending a stream via VFS, first resending the record and
 
1753
        substream that couldn't be sent via an insert_stream verb.
 
1754
        """
 
1755
        if response[0][0] == 'missing-basis':
 
1756
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
 
1757
            # Ignore missing_keys, we haven't finished inserting yet
 
1758
        else:
 
1759
            tokens = []
 
1760
        def resume_substream():
 
1761
            # Yield the substream that was interrupted.
 
1762
            for record in self._last_substream:
 
1763
                yield record
 
1764
            self._last_substream = None
 
1765
        def resume_stream():
 
1766
            # Finish sending the interrupted substream
 
1767
            yield ('inventory-deltas', resume_substream())
 
1768
            # Then simply continue sending the rest of the stream.
 
1769
            for substream_kind, substream in self._last_stream:
 
1770
                yield substream_kind, substream
 
1771
        return self._insert_real(resume_stream(), src_format, tokens)
 
1772
 
 
1773
    def _stop_stream_if_inventory_delta(self, stream):
 
1774
        """Normally this just lets the original stream pass-through unchanged.
 
1775
 
 
1776
        However if any 'inventory-deltas' substream occurs it will stop
 
1777
        streaming, and store the interrupted substream and stream in
 
1778
        self._last_substream and self._last_stream so that the stream can be
 
1779
        resumed by _resume_stream_with_vfs.
 
1780
        """
 
1781
                    
 
1782
        stream_iter = iter(stream)
 
1783
        for substream_kind, substream in stream_iter:
 
1784
            if substream_kind == 'inventory-deltas':
 
1785
                self._last_substream = substream
 
1786
                self._last_stream = stream_iter
 
1787
                return
 
1788
            else:
 
1789
                yield substream_kind, substream
 
1790
            
 
1791
 
 
1792
class RemoteStreamSource(repository.StreamSource):
 
1793
    """Stream data from a remote server."""
 
1794
 
 
1795
    def get_stream(self, search):
 
1796
        if (self.from_repository._fallback_repositories and
 
1797
            self.to_format._fetch_order == 'topological'):
 
1798
            return self._real_stream(self.from_repository, search)
 
1799
        sources = []
 
1800
        seen = set()
 
1801
        repos = [self.from_repository]
 
1802
        while repos:
 
1803
            repo = repos.pop(0)
 
1804
            if repo in seen:
 
1805
                continue
 
1806
            seen.add(repo)
 
1807
            repos.extend(repo._fallback_repositories)
 
1808
            sources.append(repo)
 
1809
        return self.missing_parents_chain(search, sources)
 
1810
 
 
1811
    def get_stream_for_missing_keys(self, missing_keys):
 
1812
        self.from_repository._ensure_real()
 
1813
        real_repo = self.from_repository._real_repository
 
1814
        real_source = real_repo._get_source(self.to_format)
 
1815
        return real_source.get_stream_for_missing_keys(missing_keys)
 
1816
 
 
1817
    def _real_stream(self, repo, search):
 
1818
        """Get a stream for search from repo.
 
1819
        
 
1820
        This never called RemoteStreamSource.get_stream, and is a heler
 
1821
        for RemoteStreamSource._get_stream to allow getting a stream 
 
1822
        reliably whether fallback back because of old servers or trying
 
1823
        to stream from a non-RemoteRepository (which the stacked support
 
1824
        code will do).
 
1825
        """
 
1826
        source = repo._get_source(self.to_format)
 
1827
        if isinstance(source, RemoteStreamSource):
 
1828
            repo._ensure_real()
 
1829
            source = repo._real_repository._get_source(self.to_format)
 
1830
        return source.get_stream(search)
 
1831
 
 
1832
    def _get_stream(self, repo, search):
 
1833
        """Core worker to get a stream from repo for search.
 
1834
 
 
1835
        This is used by both get_stream and the stacking support logic. It
 
1836
        deliberately gets a stream for repo which does not need to be
 
1837
        self.from_repository. In the event that repo is not Remote, or
 
1838
        cannot do a smart stream, a fallback is made to the generic
 
1839
        repository._get_stream() interface, via self._real_stream.
 
1840
 
 
1841
        In the event of stacking, streams from _get_stream will not
 
1842
        contain all the data for search - this is normal (see get_stream).
 
1843
 
 
1844
        :param repo: A repository.
 
1845
        :param search: A search.
 
1846
        """
 
1847
        # Fallbacks may be non-smart
 
1848
        if not isinstance(repo, RemoteRepository):
 
1849
            return self._real_stream(repo, search)
 
1850
        client = repo._client
 
1851
        medium = client._medium
 
1852
        path = repo.bzrdir._path_for_remote_call(client)
 
1853
        search_bytes = repo._serialise_search_result(search)
 
1854
        args = (path, self.to_format.network_name())
 
1855
        candidate_verbs = [
 
1856
            ('Repository.get_stream_1.19', (1, 19)),
 
1857
            ('Repository.get_stream', (1, 13))]
 
1858
        found_verb = False
 
1859
        for verb, version in candidate_verbs:
 
1860
            if medium._is_remote_before(version):
 
1861
                continue
 
1862
            try:
 
1863
                response = repo._call_with_body_bytes_expecting_body(
 
1864
                    verb, args, search_bytes)
 
1865
            except errors.UnknownSmartMethod:
 
1866
                medium._remember_remote_is_before(version)
 
1867
            else:
 
1868
                response_tuple, response_handler = response
 
1869
                found_verb = True
 
1870
                break
 
1871
        if not found_verb:
 
1872
            return self._real_stream(repo, search)
 
1873
        if response_tuple[0] != 'ok':
 
1874
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
1875
        byte_stream = response_handler.read_streamed_body()
 
1876
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
 
1877
        if src_format.network_name() != repo._format.network_name():
 
1878
            raise AssertionError(
 
1879
                "Mismatched RemoteRepository and stream src %r, %r" % (
 
1880
                src_format.network_name(), repo._format.network_name()))
 
1881
        return stream
 
1882
 
 
1883
    def missing_parents_chain(self, search, sources):
 
1884
        """Chain multiple streams together to handle stacking.
 
1885
 
 
1886
        :param search: The overall search to satisfy with streams.
 
1887
        :param sources: A list of Repository objects to query.
 
1888
        """
 
1889
        self.serialiser = self.to_format._serializer
 
1890
        self.seen_revs = set()
 
1891
        self.referenced_revs = set()
 
1892
        # If there are heads in the search, or the key count is > 0, we are not
 
1893
        # done.
 
1894
        while not search.is_empty() and len(sources) > 1:
 
1895
            source = sources.pop(0)
 
1896
            stream = self._get_stream(source, search)
 
1897
            for kind, substream in stream:
 
1898
                if kind != 'revisions':
 
1899
                    yield kind, substream
 
1900
                else:
 
1901
                    yield kind, self.missing_parents_rev_handler(substream)
 
1902
            search = search.refine(self.seen_revs, self.referenced_revs)
 
1903
            self.seen_revs = set()
 
1904
            self.referenced_revs = set()
 
1905
        if not search.is_empty():
 
1906
            for kind, stream in self._get_stream(sources[0], search):
 
1907
                yield kind, stream
 
1908
 
 
1909
    def missing_parents_rev_handler(self, substream):
 
1910
        for content in substream:
 
1911
            revision_bytes = content.get_bytes_as('fulltext')
 
1912
            revision = self.serialiser.read_revision_from_string(revision_bytes)
 
1913
            self.seen_revs.add(content.key[-1])
 
1914
            self.referenced_revs.update(revision.parent_ids)
 
1915
            yield content
 
1916
 
1190
1917
 
1191
1918
class RemoteBranchLockableFiles(LockableFiles):
1192
1919
    """A 'LockableFiles' implementation that talks to a smart server.
1193
 
    
 
1920
 
1194
1921
    This is not a public interface class.
1195
1922
    """
1196
1923
 
1210
1937
 
1211
1938
class RemoteBranchFormat(branch.BranchFormat):
1212
1939
 
 
1940
    def __init__(self, network_name=None):
 
1941
        super(RemoteBranchFormat, self).__init__()
 
1942
        self._matchingbzrdir = RemoteBzrDirFormat()
 
1943
        self._matchingbzrdir.set_branch_format(self)
 
1944
        self._custom_format = None
 
1945
        self._network_name = network_name
 
1946
 
1213
1947
    def __eq__(self, other):
1214
 
        return (isinstance(other, RemoteBranchFormat) and 
 
1948
        return (isinstance(other, RemoteBranchFormat) and
1215
1949
            self.__dict__ == other.__dict__)
1216
1950
 
 
1951
    def _ensure_real(self):
 
1952
        if self._custom_format is None:
 
1953
            self._custom_format = branch.network_format_registry.get(
 
1954
                self._network_name)
 
1955
 
1217
1956
    def get_format_description(self):
1218
1957
        return 'Remote BZR Branch'
1219
1958
 
1220
 
    def get_format_string(self):
1221
 
        return 'Remote BZR Branch'
1222
 
 
1223
 
    def open(self, a_bzrdir):
1224
 
        return a_bzrdir.open_branch()
 
1959
    def network_name(self):
 
1960
        return self._network_name
 
1961
 
 
1962
    def open(self, a_bzrdir, ignore_fallbacks=False):
 
1963
        return a_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
 
1964
 
 
1965
    def _vfs_initialize(self, a_bzrdir):
 
1966
        # Initialisation when using a local bzrdir object, or a non-vfs init
 
1967
        # method is not available on the server.
 
1968
        # self._custom_format is always set - the start of initialize ensures
 
1969
        # that.
 
1970
        if isinstance(a_bzrdir, RemoteBzrDir):
 
1971
            a_bzrdir._ensure_real()
 
1972
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
 
1973
        else:
 
1974
            # We assume the bzrdir is parameterised; it may not be.
 
1975
            result = self._custom_format.initialize(a_bzrdir)
 
1976
        if (isinstance(a_bzrdir, RemoteBzrDir) and
 
1977
            not isinstance(result, RemoteBranch)):
 
1978
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
 
1979
        return result
1225
1980
 
1226
1981
    def initialize(self, a_bzrdir):
1227
 
        return a_bzrdir.create_branch()
 
1982
        # 1) get the network name to use.
 
1983
        if self._custom_format:
 
1984
            network_name = self._custom_format.network_name()
 
1985
        else:
 
1986
            # Select the current bzrlib default and ask for that.
 
1987
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
 
1988
            reference_format = reference_bzrdir_format.get_branch_format()
 
1989
            self._custom_format = reference_format
 
1990
            network_name = reference_format.network_name()
 
1991
        # Being asked to create on a non RemoteBzrDir:
 
1992
        if not isinstance(a_bzrdir, RemoteBzrDir):
 
1993
            return self._vfs_initialize(a_bzrdir)
 
1994
        medium = a_bzrdir._client._medium
 
1995
        if medium._is_remote_before((1, 13)):
 
1996
            return self._vfs_initialize(a_bzrdir)
 
1997
        # Creating on a remote bzr dir.
 
1998
        # 2) try direct creation via RPC
 
1999
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
 
2000
        verb = 'BzrDir.create_branch'
 
2001
        try:
 
2002
            response = a_bzrdir._call(verb, path, network_name)
 
2003
        except errors.UnknownSmartMethod:
 
2004
            # Fallback - use vfs methods
 
2005
            medium._remember_remote_is_before((1, 13))
 
2006
            return self._vfs_initialize(a_bzrdir)
 
2007
        if response[0] != 'ok':
 
2008
            raise errors.UnexpectedSmartServerResponse(response)
 
2009
        # Turn the response into a RemoteRepository object.
 
2010
        format = RemoteBranchFormat(network_name=response[1])
 
2011
        repo_format = response_tuple_to_repo_format(response[3:])
 
2012
        if response[2] == '':
 
2013
            repo_bzrdir = a_bzrdir
 
2014
        else:
 
2015
            repo_bzrdir = RemoteBzrDir(
 
2016
                a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
 
2017
                a_bzrdir._client)
 
2018
        remote_repo = RemoteRepository(repo_bzrdir, repo_format)
 
2019
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
 
2020
            format=format, setup_stacking=False)
 
2021
        # XXX: We know this is a new branch, so it must have revno 0, revid
 
2022
        # NULL_REVISION. Creating the branch locked would make this be unable
 
2023
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
 
2024
        remote_branch._last_revision_info_cache = 0, NULL_REVISION
 
2025
        return remote_branch
 
2026
 
 
2027
    def make_tags(self, branch):
 
2028
        self._ensure_real()
 
2029
        return self._custom_format.make_tags(branch)
1228
2030
 
1229
2031
    def supports_tags(self):
1230
2032
        # Remote branches might support tags, but we won't know until we
1231
2033
        # access the real remote branch.
1232
 
        return True
1233
 
 
1234
 
 
1235
 
class RemoteBranch(branch.Branch):
 
2034
        self._ensure_real()
 
2035
        return self._custom_format.supports_tags()
 
2036
 
 
2037
    def supports_stacking(self):
 
2038
        self._ensure_real()
 
2039
        return self._custom_format.supports_stacking()
 
2040
 
 
2041
    def supports_set_append_revisions_only(self):
 
2042
        self._ensure_real()
 
2043
        return self._custom_format.supports_set_append_revisions_only()
 
2044
 
 
2045
 
 
2046
class RemoteBranch(branch.Branch, _RpcHelper):
1236
2047
    """Branch stored on a server accessed by HPSS RPC.
1237
2048
 
1238
2049
    At the moment most operations are mapped down to simple file operations.
1239
2050
    """
1240
2051
 
1241
2052
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1242
 
        _client=None):
 
2053
        _client=None, format=None, setup_stacking=True):
1243
2054
        """Create a RemoteBranch instance.
1244
2055
 
1245
2056
        :param real_branch: An optional local implementation of the branch
1246
2057
            format, usually accessing the data via the VFS.
1247
2058
        :param _client: Private parameter for testing.
 
2059
        :param format: A RemoteBranchFormat object, None to create one
 
2060
            automatically. If supplied it should have a network_name already
 
2061
            supplied.
 
2062
        :param setup_stacking: If True make an RPC call to determine the
 
2063
            stacked (or not) status of the branch. If False assume the branch
 
2064
            is not stacked.
1248
2065
        """
1249
2066
        # We intentionally don't call the parent class's __init__, because it
1250
2067
        # will try to assign to self.tags, which is a property in this subclass.
1251
2068
        # And the parent's __init__ doesn't do much anyway.
1252
 
        self._revision_id_to_revno_cache = None
1253
 
        self._revision_history_cache = None
1254
 
        self._last_revision_info_cache = None
1255
2069
        self.bzrdir = remote_bzrdir
1256
2070
        if _client is not None:
1257
2071
            self._client = _client
1270
2084
            self._real_branch.repository = self.repository
1271
2085
        else:
1272
2086
            self._real_branch = None
1273
 
        # Fill out expected attributes of branch for bzrlib api users.
1274
 
        self._format = RemoteBranchFormat()
 
2087
        # Fill out expected attributes of branch for bzrlib API users.
 
2088
        self._clear_cached_state()
1275
2089
        self.base = self.bzrdir.root_transport.base
1276
2090
        self._control_files = None
1277
2091
        self._lock_mode = None
1279
2093
        self._repo_lock_token = None
1280
2094
        self._lock_count = 0
1281
2095
        self._leave_lock = False
 
2096
        # Setup a format: note that we cannot call _ensure_real until all the
 
2097
        # attributes above are set: This code cannot be moved higher up in this
 
2098
        # function.
 
2099
        if format is None:
 
2100
            self._format = RemoteBranchFormat()
 
2101
            if real_branch is not None:
 
2102
                self._format._network_name = \
 
2103
                    self._real_branch._format.network_name()
 
2104
        else:
 
2105
            self._format = format
 
2106
        # when we do _ensure_real we may need to pass ignore_fallbacks to the
 
2107
        # branch.open_branch method.
 
2108
        self._real_ignore_fallbacks = not setup_stacking
 
2109
        if not self._format._network_name:
 
2110
            # Did not get from open_branchV2 - old server.
 
2111
            self._ensure_real()
 
2112
            self._format._network_name = \
 
2113
                self._real_branch._format.network_name()
 
2114
        self.tags = self._format.make_tags(self)
 
2115
        # The base class init is not called, so we duplicate this:
 
2116
        hooks = branch.Branch.hooks['open']
 
2117
        for hook in hooks:
 
2118
            hook(self)
 
2119
        self._is_stacked = False
 
2120
        if setup_stacking:
 
2121
            self._setup_stacking()
 
2122
 
 
2123
    def _setup_stacking(self):
 
2124
        # configure stacking into the remote repository, by reading it from
 
2125
        # the vfs branch.
 
2126
        try:
 
2127
            fallback_url = self.get_stacked_on_url()
 
2128
        except (errors.NotStacked, errors.UnstackableBranchFormat,
 
2129
            errors.UnstackableRepositoryFormat), e:
 
2130
            return
 
2131
        self._is_stacked = True
 
2132
        self._activate_fallback_location(fallback_url)
 
2133
 
 
2134
    def _get_config(self):
 
2135
        return RemoteBranchConfig(self)
1282
2136
 
1283
2137
    def _get_real_transport(self):
1284
2138
        # if we try vfs access, return the real branch's vfs transport
1302
2156
                raise AssertionError('smart server vfs must be enabled '
1303
2157
                    'to use vfs implementation')
1304
2158
            self.bzrdir._ensure_real()
1305
 
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
 
2159
            self._real_branch = self.bzrdir._real_bzrdir.open_branch(
 
2160
                ignore_fallbacks=self._real_ignore_fallbacks)
1306
2161
            if self.repository._real_repository is None:
1307
2162
                # Give the remote repository the matching real repo.
1308
2163
                real_repo = self._real_branch.repository
1337
2192
        too, in fact doing so might harm performance.
1338
2193
        """
1339
2194
        super(RemoteBranch, self)._clear_cached_state()
1340
 
        
 
2195
 
1341
2196
    @property
1342
2197
    def control_files(self):
1343
2198
        # Defer actually creating RemoteBranchLockableFiles until its needed,
1366
2221
        :raises UnstackableRepositoryFormat: If the repository does not support
1367
2222
            stacking.
1368
2223
        """
1369
 
        self._ensure_real()
1370
 
        return self._real_branch.get_stacked_on_url()
 
2224
        try:
 
2225
            # there may not be a repository yet, so we can't use
 
2226
            # self._translate_error, so we can't use self._call either.
 
2227
            response = self._client.call('Branch.get_stacked_on_url',
 
2228
                self._remote_path())
 
2229
        except errors.ErrorFromSmartServer, err:
 
2230
            # there may not be a repository yet, so we can't call through
 
2231
            # its _translate_error
 
2232
            _translate_error(err, branch=self)
 
2233
        except errors.UnknownSmartMethod, err:
 
2234
            self._ensure_real()
 
2235
            return self._real_branch.get_stacked_on_url()
 
2236
        if response[0] != 'ok':
 
2237
            raise errors.UnexpectedSmartServerResponse(response)
 
2238
        return response[1]
 
2239
 
 
2240
    def set_stacked_on_url(self, url):
 
2241
        branch.Branch.set_stacked_on_url(self, url)
 
2242
        if not url:
 
2243
            self._is_stacked = False
 
2244
        else:
 
2245
            self._is_stacked = True
 
2246
        
 
2247
    def _vfs_get_tags_bytes(self):
 
2248
        self._ensure_real()
 
2249
        return self._real_branch._get_tags_bytes()
 
2250
 
 
2251
    def _get_tags_bytes(self):
 
2252
        medium = self._client._medium
 
2253
        if medium._is_remote_before((1, 13)):
 
2254
            return self._vfs_get_tags_bytes()
 
2255
        try:
 
2256
            response = self._call('Branch.get_tags_bytes', self._remote_path())
 
2257
        except errors.UnknownSmartMethod:
 
2258
            medium._remember_remote_is_before((1, 13))
 
2259
            return self._vfs_get_tags_bytes()
 
2260
        return response[0]
 
2261
 
 
2262
    def _vfs_set_tags_bytes(self, bytes):
 
2263
        self._ensure_real()
 
2264
        return self._real_branch._set_tags_bytes(bytes)
 
2265
 
 
2266
    def _set_tags_bytes(self, bytes):
 
2267
        medium = self._client._medium
 
2268
        if medium._is_remote_before((1, 18)):
 
2269
            self._vfs_set_tags_bytes(bytes)
 
2270
        try:
 
2271
            args = (
 
2272
                self._remote_path(), self._lock_token, self._repo_lock_token)
 
2273
            response = self._call_with_body_bytes(
 
2274
                'Branch.set_tags_bytes', args, bytes)
 
2275
        except errors.UnknownSmartMethod:
 
2276
            medium._remember_remote_is_before((1, 18))
 
2277
            self._vfs_set_tags_bytes(bytes)
1371
2278
 
1372
2279
    def lock_read(self):
1373
2280
        self.repository.lock_read()
1386
2293
            branch_token = token
1387
2294
            repo_token = self.repository.lock_write()
1388
2295
            self.repository.unlock()
1389
 
        path = self.bzrdir._path_for_remote_call(self._client)
1390
 
        try:
1391
 
            response = self._client.call(
1392
 
                'Branch.lock_write', path, branch_token, repo_token or '')
1393
 
        except errors.ErrorFromSmartServer, err:
1394
 
            self._translate_error(err, token=token)
 
2296
        err_context = {'token': token}
 
2297
        response = self._call(
 
2298
            'Branch.lock_write', self._remote_path(), branch_token,
 
2299
            repo_token or '', **err_context)
1395
2300
        if response[0] != 'ok':
1396
2301
            raise errors.UnexpectedSmartServerResponse(response)
1397
2302
        ok, branch_token, repo_token = response
1398
2303
        return branch_token, repo_token
1399
 
            
 
2304
 
1400
2305
    def lock_write(self, token=None):
1401
2306
        if not self._lock_mode:
1402
2307
            # Lock the branch and repo in one remote call.
1431
2336
        return self._lock_token or None
1432
2337
 
1433
2338
    def _unlock(self, branch_token, repo_token):
1434
 
        path = self.bzrdir._path_for_remote_call(self._client)
1435
 
        try:
1436
 
            response = self._client.call('Branch.unlock', path, branch_token,
1437
 
                                         repo_token or '')
1438
 
        except errors.ErrorFromSmartServer, err:
1439
 
            self._translate_error(err, token=str((branch_token, repo_token)))
 
2339
        err_context = {'token': str((branch_token, repo_token))}
 
2340
        response = self._call(
 
2341
            'Branch.unlock', self._remote_path(), branch_token,
 
2342
            repo_token or '', **err_context)
1440
2343
        if response == ('ok',):
1441
2344
            return
1442
2345
        raise errors.UnexpectedSmartServerResponse(response)
1459
2362
                    self._real_branch.unlock()
1460
2363
                if mode != 'w':
1461
2364
                    # Only write-locked branched need to make a remote method
1462
 
                    # call to perfom the unlock.
 
2365
                    # call to perform the unlock.
1463
2366
                    return
1464
2367
                if not self._lock_token:
1465
2368
                    raise AssertionError('Locked, but no token!')
1486
2389
            raise NotImplementedError(self.dont_leave_lock_in_place)
1487
2390
        self._leave_lock = False
1488
2391
 
 
2392
    def get_rev_id(self, revno, history=None):
 
2393
        if revno == 0:
 
2394
            return _mod_revision.NULL_REVISION
 
2395
        last_revision_info = self.last_revision_info()
 
2396
        ok, result = self.repository.get_rev_id_for_revno(
 
2397
            revno, last_revision_info)
 
2398
        if ok:
 
2399
            return result
 
2400
        missing_parent = result[1]
 
2401
        # Either the revision named by the server is missing, or its parent
 
2402
        # is.  Call get_parent_map to determine which, so that we report a
 
2403
        # useful error.
 
2404
        parent_map = self.repository.get_parent_map([missing_parent])
 
2405
        if missing_parent in parent_map:
 
2406
            missing_parent = parent_map[missing_parent]
 
2407
        raise errors.RevisionNotPresent(missing_parent, self.repository)
 
2408
 
1489
2409
    def _last_revision_info(self):
1490
 
        path = self.bzrdir._path_for_remote_call(self._client)
1491
 
        response = self._client.call('Branch.last_revision_info', path)
 
2410
        response = self._call('Branch.last_revision_info', self._remote_path())
1492
2411
        if response[0] != 'ok':
1493
2412
            raise SmartProtocolError('unexpected response code %s' % (response,))
1494
2413
        revno = int(response[1])
1497
2416
 
1498
2417
    def _gen_revision_history(self):
1499
2418
        """See Branch._gen_revision_history()."""
1500
 
        path = self.bzrdir._path_for_remote_call(self._client)
1501
 
        response_tuple, response_handler = self._client.call_expecting_body(
1502
 
            'Branch.revision_history', path)
 
2419
        if self._is_stacked:
 
2420
            self._ensure_real()
 
2421
            return self._real_branch._gen_revision_history()
 
2422
        response_tuple, response_handler = self._call_expecting_body(
 
2423
            'Branch.revision_history', self._remote_path())
1503
2424
        if response_tuple[0] != 'ok':
1504
2425
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1505
2426
        result = response_handler.read_body_bytes().split('\x00')
1507
2428
            return []
1508
2429
        return result
1509
2430
 
 
2431
    def _remote_path(self):
 
2432
        return self.bzrdir._path_for_remote_call(self._client)
 
2433
 
1510
2434
    def _set_last_revision_descendant(self, revision_id, other_branch,
1511
2435
            allow_diverged=False, allow_overwrite_descendant=False):
1512
 
        path = self.bzrdir._path_for_remote_call(self._client)
1513
 
        try:
1514
 
            response = self._client.call('Branch.set_last_revision_ex',
1515
 
                path, self._lock_token, self._repo_lock_token, revision_id,
1516
 
                int(allow_diverged), int(allow_overwrite_descendant))
1517
 
        except errors.ErrorFromSmartServer, err:
1518
 
            self._translate_error(err, other_branch=other_branch)
 
2436
        # This performs additional work to meet the hook contract; while its
 
2437
        # undesirable, we have to synthesise the revno to call the hook, and
 
2438
        # not calling the hook is worse as it means changes can't be prevented.
 
2439
        # Having calculated this though, we can't just call into
 
2440
        # set_last_revision_info as a simple call, because there is a set_rh
 
2441
        # hook that some folk may still be using.
 
2442
        old_revno, old_revid = self.last_revision_info()
 
2443
        history = self._lefthand_history(revision_id)
 
2444
        self._run_pre_change_branch_tip_hooks(len(history), revision_id)
 
2445
        err_context = {'other_branch': other_branch}
 
2446
        response = self._call('Branch.set_last_revision_ex',
 
2447
            self._remote_path(), self._lock_token, self._repo_lock_token,
 
2448
            revision_id, int(allow_diverged), int(allow_overwrite_descendant),
 
2449
            **err_context)
1519
2450
        self._clear_cached_state()
1520
2451
        if len(response) != 3 and response[0] != 'ok':
1521
2452
            raise errors.UnexpectedSmartServerResponse(response)
1522
2453
        new_revno, new_revision_id = response[1:]
1523
2454
        self._last_revision_info_cache = new_revno, new_revision_id
 
2455
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1524
2456
        if self._real_branch is not None:
1525
2457
            cache = new_revno, new_revision_id
1526
2458
            self._real_branch._last_revision_info_cache = cache
1527
2459
 
1528
2460
    def _set_last_revision(self, revision_id):
1529
 
        path = self.bzrdir._path_for_remote_call(self._client)
 
2461
        old_revno, old_revid = self.last_revision_info()
 
2462
        # This performs additional work to meet the hook contract; while its
 
2463
        # undesirable, we have to synthesise the revno to call the hook, and
 
2464
        # not calling the hook is worse as it means changes can't be prevented.
 
2465
        # Having calculated this though, we can't just call into
 
2466
        # set_last_revision_info as a simple call, because there is a set_rh
 
2467
        # hook that some folk may still be using.
 
2468
        history = self._lefthand_history(revision_id)
 
2469
        self._run_pre_change_branch_tip_hooks(len(history), revision_id)
1530
2470
        self._clear_cached_state()
1531
 
        try:
1532
 
            response = self._client.call('Branch.set_last_revision',
1533
 
                path, self._lock_token, self._repo_lock_token, revision_id)
1534
 
        except errors.ErrorFromSmartServer, err:
1535
 
            self._translate_error(err)
 
2471
        response = self._call('Branch.set_last_revision',
 
2472
            self._remote_path(), self._lock_token, self._repo_lock_token,
 
2473
            revision_id)
1536
2474
        if response != ('ok',):
1537
2475
            raise errors.UnexpectedSmartServerResponse(response)
 
2476
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1538
2477
 
1539
2478
    @needs_write_lock
1540
2479
    def set_revision_history(self, rev_history):
1546
2485
        else:
1547
2486
            rev_id = rev_history[-1]
1548
2487
        self._set_last_revision(rev_id)
 
2488
        for hook in branch.Branch.hooks['set_rh']:
 
2489
            hook(self, rev_history)
1549
2490
        self._cache_revision_history(rev_history)
1550
2491
 
1551
 
    def get_parent(self):
1552
 
        self._ensure_real()
1553
 
        return self._real_branch.get_parent()
1554
 
        
1555
 
    def set_parent(self, url):
1556
 
        self._ensure_real()
1557
 
        return self._real_branch.set_parent(url)
1558
 
        
1559
 
    def set_stacked_on_url(self, stacked_location):
1560
 
        """Set the URL this branch is stacked against.
1561
 
 
1562
 
        :raises UnstackableBranchFormat: If the branch does not support
1563
 
            stacking.
1564
 
        :raises UnstackableRepositoryFormat: If the repository does not support
1565
 
            stacking.
1566
 
        """
1567
 
        self._ensure_real()
1568
 
        return self._real_branch.set_stacked_on_url(stacked_location)
1569
 
 
1570
 
    def sprout(self, to_bzrdir, revision_id=None):
1571
 
        # Like Branch.sprout, except that it sprouts a branch in the default
1572
 
        # format, because RemoteBranches can't be created at arbitrary URLs.
1573
 
        # XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
1574
 
        # to_bzrdir.create_branch...
1575
 
        self._ensure_real()
1576
 
        result = self._real_branch._format.initialize(to_bzrdir)
1577
 
        self.copy_content_into(result, revision_id=revision_id)
1578
 
        result.set_parent(self.bzrdir.root_transport.base)
1579
 
        return result
 
2492
    def _get_parent_location(self):
 
2493
        medium = self._client._medium
 
2494
        if medium._is_remote_before((1, 13)):
 
2495
            return self._vfs_get_parent_location()
 
2496
        try:
 
2497
            response = self._call('Branch.get_parent', self._remote_path())
 
2498
        except errors.UnknownSmartMethod:
 
2499
            medium._remember_remote_is_before((1, 13))
 
2500
            return self._vfs_get_parent_location()
 
2501
        if len(response) != 1:
 
2502
            raise errors.UnexpectedSmartServerResponse(response)
 
2503
        parent_location = response[0]
 
2504
        if parent_location == '':
 
2505
            return None
 
2506
        return parent_location
 
2507
 
 
2508
    def _vfs_get_parent_location(self):
 
2509
        self._ensure_real()
 
2510
        return self._real_branch._get_parent_location()
 
2511
 
 
2512
    def _set_parent_location(self, url):
 
2513
        medium = self._client._medium
 
2514
        if medium._is_remote_before((1, 15)):
 
2515
            return self._vfs_set_parent_location(url)
 
2516
        try:
 
2517
            call_url = url or ''
 
2518
            if type(call_url) is not str:
 
2519
                raise AssertionError('url must be a str or None (%s)' % url)
 
2520
            response = self._call('Branch.set_parent_location',
 
2521
                self._remote_path(), self._lock_token, self._repo_lock_token,
 
2522
                call_url)
 
2523
        except errors.UnknownSmartMethod:
 
2524
            medium._remember_remote_is_before((1, 15))
 
2525
            return self._vfs_set_parent_location(url)
 
2526
        if response != ():
 
2527
            raise errors.UnexpectedSmartServerResponse(response)
 
2528
 
 
2529
    def _vfs_set_parent_location(self, url):
 
2530
        self._ensure_real()
 
2531
        return self._real_branch._set_parent_location(url)
1580
2532
 
1581
2533
    @needs_write_lock
1582
2534
    def pull(self, source, overwrite=False, stop_revision=None,
1604
2556
 
1605
2557
    @needs_write_lock
1606
2558
    def set_last_revision_info(self, revno, revision_id):
 
2559
        # XXX: These should be returned by the set_last_revision_info verb
 
2560
        old_revno, old_revid = self.last_revision_info()
 
2561
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
1607
2562
        revision_id = ensure_null(revision_id)
1608
 
        path = self.bzrdir._path_for_remote_call(self._client)
1609
2563
        try:
1610
 
            response = self._client.call('Branch.set_last_revision_info',
1611
 
                path, self._lock_token, self._repo_lock_token, str(revno), revision_id)
 
2564
            response = self._call('Branch.set_last_revision_info',
 
2565
                self._remote_path(), self._lock_token, self._repo_lock_token,
 
2566
                str(revno), revision_id)
1612
2567
        except errors.UnknownSmartMethod:
1613
2568
            self._ensure_real()
1614
2569
            self._clear_cached_state_of_remote_branch_only()
1615
2570
            self._real_branch.set_last_revision_info(revno, revision_id)
1616
2571
            self._last_revision_info_cache = revno, revision_id
1617
2572
            return
1618
 
        except errors.ErrorFromSmartServer, err:
1619
 
            self._translate_error(err)
1620
2573
        if response == ('ok',):
1621
2574
            self._clear_cached_state()
1622
2575
            self._last_revision_info_cache = revno, revision_id
 
2576
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
1623
2577
            # Update the _real_branch's cache too.
1624
2578
            if self._real_branch is not None:
1625
2579
                cache = self._last_revision_info_cache
1632
2586
                                  other_branch=None):
1633
2587
        medium = self._client._medium
1634
2588
        if not medium._is_remote_before((1, 6)):
 
2589
            # Use a smart method for 1.6 and above servers
1635
2590
            try:
1636
2591
                self._set_last_revision_descendant(revision_id, other_branch,
1637
2592
                    allow_diverged=True, allow_overwrite_descendant=True)
1639
2594
            except errors.UnknownSmartMethod:
1640
2595
                medium._remember_remote_is_before((1, 6))
1641
2596
        self._clear_cached_state_of_remote_branch_only()
1642
 
        self._ensure_real()
1643
 
        self._real_branch.generate_revision_history(
1644
 
            revision_id, last_rev=last_rev, other_branch=other_branch)
1645
 
 
1646
 
    @property
1647
 
    def tags(self):
1648
 
        self._ensure_real()
1649
 
        return self._real_branch.tags
 
2597
        self.set_revision_history(self._lefthand_history(revision_id,
 
2598
            last_rev=last_rev,other_branch=other_branch))
1650
2599
 
1651
2600
    def set_push_location(self, location):
1652
2601
        self._ensure_real()
1653
2602
        return self._real_branch.set_push_location(location)
1654
2603
 
1655
 
    @needs_write_lock
1656
 
    def update_revisions(self, other, stop_revision=None, overwrite=False,
1657
 
                         graph=None):
1658
 
        """See Branch.update_revisions."""
1659
 
        other.lock_read()
 
2604
 
 
2605
class RemoteConfig(object):
 
2606
    """A Config that reads and writes from smart verbs.
 
2607
 
 
2608
    It is a low-level object that considers config data to be name/value pairs
 
2609
    that may be associated with a section. Assigning meaning to the these
 
2610
    values is done at higher levels like bzrlib.config.TreeConfig.
 
2611
    """
 
2612
 
 
2613
    def get_option(self, name, section=None, default=None):
 
2614
        """Return the value associated with a named option.
 
2615
 
 
2616
        :param name: The name of the value
 
2617
        :param section: The section the option is in (if any)
 
2618
        :param default: The value to return if the value is not set
 
2619
        :return: The value or default value
 
2620
        """
1660
2621
        try:
1661
 
            if stop_revision is None:
1662
 
                stop_revision = other.last_revision()
1663
 
                if revision.is_null(stop_revision):
1664
 
                    # if there are no commits, we're done.
1665
 
                    return
1666
 
            self.fetch(other, stop_revision)
1667
 
 
1668
 
            if overwrite:
1669
 
                # Just unconditionally set the new revision.  We don't care if
1670
 
                # the branches have diverged.
1671
 
                self._set_last_revision(stop_revision)
 
2622
            configobj = self._get_configobj()
 
2623
            if section is None:
 
2624
                section_obj = configobj
1672
2625
            else:
1673
 
                medium = self._client._medium
1674
 
                if not medium._is_remote_before((1, 6)):
1675
 
                    try:
1676
 
                        self._set_last_revision_descendant(stop_revision, other)
1677
 
                        return
1678
 
                    except errors.UnknownSmartMethod:
1679
 
                        medium._remember_remote_is_before((1, 6))
1680
 
                # Fallback for pre-1.6 servers: check for divergence
1681
 
                # client-side, then do _set_last_revision.
1682
 
                last_rev = revision.ensure_null(self.last_revision())
1683
 
                if graph is None:
1684
 
                    graph = self.repository.get_graph()
1685
 
                if self._check_if_descendant_or_diverged(
1686
 
                        stop_revision, last_rev, graph, other):
1687
 
                    # stop_revision is a descendant of last_rev, but we aren't
1688
 
                    # overwriting, so we're done.
1689
 
                    return
1690
 
                self._set_last_revision(stop_revision)
1691
 
        finally:
1692
 
            other.unlock()
 
2626
                try:
 
2627
                    section_obj = configobj[section]
 
2628
                except KeyError:
 
2629
                    return default
 
2630
            return section_obj.get(name, default)
 
2631
        except errors.UnknownSmartMethod:
 
2632
            return self._vfs_get_option(name, section, default)
 
2633
 
 
2634
    def _response_to_configobj(self, response):
 
2635
        if len(response[0]) and response[0][0] != 'ok':
 
2636
            raise errors.UnexpectedSmartServerResponse(response)
 
2637
        lines = response[1].read_body_bytes().splitlines()
 
2638
        return config.ConfigObj(lines, encoding='utf-8')
 
2639
 
 
2640
 
 
2641
class RemoteBranchConfig(RemoteConfig):
 
2642
    """A RemoteConfig for Branches."""
 
2643
 
 
2644
    def __init__(self, branch):
 
2645
        self._branch = branch
 
2646
 
 
2647
    def _get_configobj(self):
 
2648
        path = self._branch._remote_path()
 
2649
        response = self._branch._client.call_expecting_body(
 
2650
            'Branch.get_config_file', path)
 
2651
        return self._response_to_configobj(response)
 
2652
 
 
2653
    def set_option(self, value, name, section=None):
 
2654
        """Set the value associated with a named option.
 
2655
 
 
2656
        :param value: The value to set
 
2657
        :param name: The name of the value to set
 
2658
        :param section: The section the option is in (if any)
 
2659
        """
 
2660
        medium = self._branch._client._medium
 
2661
        if medium._is_remote_before((1, 14)):
 
2662
            return self._vfs_set_option(value, name, section)
 
2663
        try:
 
2664
            path = self._branch._remote_path()
 
2665
            response = self._branch._client.call('Branch.set_config_option',
 
2666
                path, self._branch._lock_token, self._branch._repo_lock_token,
 
2667
                value.encode('utf8'), name, section or '')
 
2668
        except errors.UnknownSmartMethod:
 
2669
            medium._remember_remote_is_before((1, 14))
 
2670
            return self._vfs_set_option(value, name, section)
 
2671
        if response != ():
 
2672
            raise errors.UnexpectedSmartServerResponse(response)
 
2673
 
 
2674
    def _real_object(self):
 
2675
        self._branch._ensure_real()
 
2676
        return self._branch._real_branch
 
2677
 
 
2678
    def _vfs_set_option(self, value, name, section=None):
 
2679
        return self._real_object()._get_config().set_option(
 
2680
            value, name, section)
 
2681
 
 
2682
 
 
2683
class RemoteBzrDirConfig(RemoteConfig):
 
2684
    """A RemoteConfig for BzrDirs."""
 
2685
 
 
2686
    def __init__(self, bzrdir):
 
2687
        self._bzrdir = bzrdir
 
2688
 
 
2689
    def _get_configobj(self):
 
2690
        medium = self._bzrdir._client._medium
 
2691
        verb = 'BzrDir.get_config_file'
 
2692
        if medium._is_remote_before((1, 15)):
 
2693
            raise errors.UnknownSmartMethod(verb)
 
2694
        path = self._bzrdir._path_for_remote_call(self._bzrdir._client)
 
2695
        response = self._bzrdir._call_expecting_body(
 
2696
            verb, path)
 
2697
        return self._response_to_configobj(response)
 
2698
 
 
2699
    def _vfs_get_option(self, name, section, default):
 
2700
        return self._real_object()._get_config().get_option(
 
2701
            name, section, default)
 
2702
 
 
2703
    def set_option(self, value, name, section=None):
 
2704
        """Set the value associated with a named option.
 
2705
 
 
2706
        :param value: The value to set
 
2707
        :param name: The name of the value to set
 
2708
        :param section: The section the option is in (if any)
 
2709
        """
 
2710
        return self._real_object()._get_config().set_option(
 
2711
            value, name, section)
 
2712
 
 
2713
    def _real_object(self):
 
2714
        self._bzrdir._ensure_real()
 
2715
        return self._bzrdir._real_bzrdir
 
2716
 
1693
2717
 
1694
2718
 
1695
2719
def _extract_tar(tar, to_dir):
1710
2734
      - bzrdir
1711
2735
      - token
1712
2736
      - other_branch
 
2737
      - path
1713
2738
 
1714
2739
    If the error from the server doesn't match a known pattern, then
1715
2740
    UnknownErrorFromSmartServer is raised.
1717
2742
    def find(name):
1718
2743
        try:
1719
2744
            return context[name]
1720
 
        except KeyError, keyErr:
1721
 
            mutter('Missing key %r in context %r', keyErr.args[0], context)
 
2745
        except KeyError, key_err:
 
2746
            mutter('Missing key %r in context %r', key_err.args[0], context)
1722
2747
            raise err
 
2748
    def get_path():
 
2749
        """Get the path from the context if present, otherwise use first error
 
2750
        arg.
 
2751
        """
 
2752
        try:
 
2753
            return context['path']
 
2754
        except KeyError, key_err:
 
2755
            try:
 
2756
                return err.error_args[0]
 
2757
            except IndexError, idx_err:
 
2758
                mutter(
 
2759
                    'Missing key %r in context %r', key_err.args[0], context)
 
2760
                raise err
 
2761
 
1723
2762
    if err.error_verb == 'NoSuchRevision':
1724
2763
        raise NoSuchRevision(find('branch'), err.error_args[0])
1725
2764
    elif err.error_verb == 'nosuchrevision':
1740
2779
        raise errors.DivergedBranches(find('branch'), find('other_branch'))
1741
2780
    elif err.error_verb == 'TipChangeRejected':
1742
2781
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
 
2782
    elif err.error_verb == 'UnstackableBranchFormat':
 
2783
        raise errors.UnstackableBranchFormat(*err.error_args)
 
2784
    elif err.error_verb == 'UnstackableRepositoryFormat':
 
2785
        raise errors.UnstackableRepositoryFormat(*err.error_args)
 
2786
    elif err.error_verb == 'NotStacked':
 
2787
        raise errors.NotStacked(branch=find('branch'))
 
2788
    elif err.error_verb == 'PermissionDenied':
 
2789
        path = get_path()
 
2790
        if len(err.error_args) >= 2:
 
2791
            extra = err.error_args[1]
 
2792
        else:
 
2793
            extra = None
 
2794
        raise errors.PermissionDenied(path, extra=extra)
 
2795
    elif err.error_verb == 'ReadError':
 
2796
        path = get_path()
 
2797
        raise errors.ReadError(path)
 
2798
    elif err.error_verb == 'NoSuchFile':
 
2799
        path = get_path()
 
2800
        raise errors.NoSuchFile(path)
 
2801
    elif err.error_verb == 'FileExists':
 
2802
        raise errors.FileExists(err.error_args[0])
 
2803
    elif err.error_verb == 'DirectoryNotEmpty':
 
2804
        raise errors.DirectoryNotEmpty(err.error_args[0])
 
2805
    elif err.error_verb == 'ShortReadvError':
 
2806
        args = err.error_args
 
2807
        raise errors.ShortReadvError(
 
2808
            args[0], int(args[1]), int(args[2]), int(args[3]))
 
2809
    elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
 
2810
        encoding = str(err.error_args[0]) # encoding must always be a string
 
2811
        val = err.error_args[1]
 
2812
        start = int(err.error_args[2])
 
2813
        end = int(err.error_args[3])
 
2814
        reason = str(err.error_args[4]) # reason must always be a string
 
2815
        if val.startswith('u:'):
 
2816
            val = val[2:].decode('utf-8')
 
2817
        elif val.startswith('s:'):
 
2818
            val = val[2:].decode('base64')
 
2819
        if err.error_verb == 'UnicodeDecodeError':
 
2820
            raise UnicodeDecodeError(encoding, val, start, end, reason)
 
2821
        elif err.error_verb == 'UnicodeEncodeError':
 
2822
            raise UnicodeEncodeError(encoding, val, start, end, reason)
 
2823
    elif err.error_verb == 'ReadOnlyError':
 
2824
        raise errors.TransportNotPossible('readonly transport')
1743
2825
    raise errors.UnknownErrorFromSmartServer(err)
1744