/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Andrew Bennetts
  • Date: 2010-04-13 04:33:55 UTC
  • mfrom: (5147 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5149.
  • Revision ID: andrew.bennetts@canonical.com-20100413043355-lg3id0uwtju0k3zs
MergeĀ lp:bzr.

Show diffs side-by-side

added added

removed removed

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