~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Andrew Bennetts
  • Date: 2008-10-30 01:05:59 UTC
  • mto: This revision was merged to the branch mainline in revision 3813.
  • Revision ID: andrew.bennetts@canonical.com-20081030010559-tumoefnsmhg4snxo
Add contrib/bzr_ssh_path_limiter.

Show diffs side-by-side

added added

removed removed

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