/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Vincent Ladeuil
  • Date: 2008-09-11 19:36:38 UTC
  • mfrom: (3703 +trunk)
  • mto: (3705.1.1 trunk2)
  • mto: This revision was merged to the branch mainline in revision 3708.
  • Revision ID: v.ladeuil+lp@free.fr-20080911193638-wtjyc1kcmacc6t1f
merge bzr.dev

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