~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-13 14:16:53 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070813141653-3cbrp00xowq58zv1
Added mini tutorial

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2006, 2007 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
16
 
 
17
 
import bz2
 
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.
 
19
 
 
20
from cStringIO import StringIO
18
21
 
19
22
from bzrlib import (
20
 
    bencode,
21
23
    branch,
22
 
    bzrdir,
23
 
    config,
24
 
    debug,
25
24
    errors,
26
 
    graph,
27
 
    lock,
28
25
    lockdir,
29
26
    repository,
30
 
    revision,
31
 
    revision as _mod_revision,
32
 
    symbol_versioning,
33
27
)
34
 
from bzrlib.branch import BranchReferenceFormat
 
28
from bzrlib.branch import Branch, BranchReferenceFormat
35
29
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
 
30
from bzrlib.config import BranchConfig, TreeConfig
36
31
from bzrlib.decorators import needs_read_lock, needs_write_lock
37
 
from bzrlib.errors import (
38
 
    NoSuchRevision,
39
 
    SmartProtocolError,
40
 
    )
 
32
from bzrlib.errors import NoSuchRevision
41
33
from bzrlib.lockable_files import LockableFiles
42
 
from bzrlib.smart import client, vfs, repository as smart_repo
43
 
from bzrlib.revision import ensure_null, NULL_REVISION
44
 
from bzrlib.trace import mutter, note, warning
45
 
 
46
 
 
47
 
class _RpcHelper(object):
48
 
    """Mixin class that helps with issuing RPCs."""
49
 
 
50
 
    def _call(self, method, *args, **err_context):
51
 
        try:
52
 
            return self._client.call(method, *args)
53
 
        except errors.ErrorFromSmartServer, err:
54
 
            self._translate_error(err, **err_context)
55
 
 
56
 
    def _call_expecting_body(self, method, *args, **err_context):
57
 
        try:
58
 
            return self._client.call_expecting_body(method, *args)
59
 
        except errors.ErrorFromSmartServer, err:
60
 
            self._translate_error(err, **err_context)
61
 
 
62
 
    def _call_with_body_bytes(self, method, args, body_bytes, **err_context):
63
 
        try:
64
 
            return self._client.call_with_body_bytes(method, args, body_bytes)
65
 
        except errors.ErrorFromSmartServer, err:
66
 
            self._translate_error(err, **err_context)
67
 
 
68
 
    def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
69
 
                                             **err_context):
70
 
        try:
71
 
            return self._client.call_with_body_bytes_expecting_body(
72
 
                method, args, body_bytes)
73
 
        except errors.ErrorFromSmartServer, err:
74
 
            self._translate_error(err, **err_context)
75
 
 
76
 
 
77
 
def response_tuple_to_repo_format(response):
78
 
    """Convert a response tuple describing a repository format to a format."""
79
 
    format = RemoteRepositoryFormat()
80
 
    format._rich_root_data = (response[0] == 'yes')
81
 
    format._supports_tree_reference = (response[1] == 'yes')
82
 
    format._supports_external_lookups = (response[2] == 'yes')
83
 
    format._network_name = response[3]
84
 
    return format
85
 
 
 
34
from bzrlib.revision import NULL_REVISION
 
35
from bzrlib.smart import client, vfs
 
36
from bzrlib.trace import note
86
37
 
87
38
# Note: RemoteBzrDirFormat is in bzrdir.py
88
39
 
89
 
class RemoteBzrDir(BzrDir, _RpcHelper):
 
40
class RemoteBzrDir(BzrDir):
90
41
    """Control directory on a remote server, accessed via bzr:// or similar."""
91
42
 
92
 
    def __init__(self, transport, format, _client=None):
 
43
    def __init__(self, transport, _client=None):
93
44
        """Construct a RemoteBzrDir.
94
45
 
95
46
        :param _client: Private parameter for testing. Disables probing and the
96
47
            use of a real bzrdir.
97
48
        """
98
 
        BzrDir.__init__(self, transport, format)
 
49
        BzrDir.__init__(self, transport, RemoteBzrDirFormat())
99
50
        # this object holds a delegated bzrdir that uses file-level operations
100
51
        # to talk to the other side
101
52
        self._real_bzrdir = None
102
 
        # 1-shot cache for the call pattern 'create_branch; open_branch' - see
103
 
        # create_branch for details.
104
 
        self._next_open_branch_result = None
105
53
 
106
54
        if _client is None:
107
 
            medium = transport.get_smart_medium()
108
 
            self._client = client._SmartClient(medium)
 
55
            self._shared_medium = transport.get_shared_medium()
 
56
            self._client = client._SmartClient(self._shared_medium)
109
57
        else:
110
58
            self._client = _client
 
59
            self._shared_medium = None
111
60
            return
112
61
 
113
62
        path = self._path_for_remote_call(self._client)
114
 
        response = self._call('BzrDir.open', path)
 
63
        response = self._client.call('BzrDir.open', path)
115
64
        if response not in [('yes',), ('no',)]:
116
65
            raise errors.UnexpectedSmartServerResponse(response)
117
66
        if response == ('no',):
125
74
        if not self._real_bzrdir:
126
75
            self._real_bzrdir = BzrDir.open_from_transport(
127
76
                self.root_transport, _server_formats=False)
128
 
            self._format._network_name = \
129
 
                self._real_bzrdir._format.network_name()
130
 
 
131
 
    def _translate_error(self, err, **context):
132
 
        _translate_error(err, bzrdir=self, **context)
133
 
 
134
 
    def break_lock(self):
135
 
        # Prevent aliasing problems in the next_open_branch_result cache.
136
 
        # See create_branch for rationale.
137
 
        self._next_open_branch_result = None
138
 
        return BzrDir.break_lock(self)
139
 
 
140
 
    def _vfs_cloning_metadir(self, require_stacking=False):
141
 
        self._ensure_real()
142
 
        return self._real_bzrdir.cloning_metadir(
143
 
            require_stacking=require_stacking)
144
 
 
145
 
    def cloning_metadir(self, require_stacking=False):
146
 
        medium = self._client._medium
147
 
        if medium._is_remote_before((1, 13)):
148
 
            return self._vfs_cloning_metadir(require_stacking=require_stacking)
149
 
        verb = 'BzrDir.cloning_metadir'
150
 
        if require_stacking:
151
 
            stacking = 'True'
152
 
        else:
153
 
            stacking = 'False'
154
 
        path = self._path_for_remote_call(self._client)
155
 
        try:
156
 
            response = self._call(verb, path, stacking)
157
 
        except errors.UnknownSmartMethod:
158
 
            medium._remember_remote_is_before((1, 13))
159
 
            return self._vfs_cloning_metadir(require_stacking=require_stacking)
160
 
        except errors.UnknownErrorFromSmartServer, err:
161
 
            if err.error_tuple != ('BranchReference',):
162
 
                raise
163
 
            # We need to resolve the branch reference to determine the
164
 
            # cloning_metadir.  This causes unnecessary RPCs to open the
165
 
            # referenced branch (and bzrdir, etc) but only when the caller
166
 
            # didn't already resolve the branch reference.
167
 
            referenced_branch = self.open_branch()
168
 
            return referenced_branch.bzrdir.cloning_metadir()
169
 
        if len(response) != 3:
170
 
            raise errors.UnexpectedSmartServerResponse(response)
171
 
        control_name, repo_name, branch_info = response
172
 
        if len(branch_info) != 2:
173
 
            raise errors.UnexpectedSmartServerResponse(response)
174
 
        branch_ref, branch_name = branch_info
175
 
        format = bzrdir.network_format_registry.get(control_name)
176
 
        if repo_name:
177
 
            format.repository_format = repository.network_format_registry.get(
178
 
                repo_name)
179
 
        if branch_ref == 'ref':
180
 
            # XXX: we need possible_transports here to avoid reopening the
181
 
            # connection to the referenced location
182
 
            ref_bzrdir = BzrDir.open(branch_name)
183
 
            branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
184
 
            format.set_branch_format(branch_format)
185
 
        elif branch_ref == 'branch':
186
 
            if branch_name:
187
 
                format.set_branch_format(
188
 
                    branch.network_format_registry.get(branch_name))
189
 
        else:
190
 
            raise errors.UnexpectedSmartServerResponse(response)
191
 
        return format
192
77
 
193
78
    def create_repository(self, shared=False):
194
 
        # as per meta1 formats - just delegate to the format object which may
195
 
        # be parameterised.
196
 
        result = self._format.repository_format.initialize(self, shared)
197
 
        if not isinstance(result, RemoteRepository):
198
 
            return self.open_repository()
199
 
        else:
200
 
            return result
201
 
 
202
 
    def destroy_repository(self):
203
 
        """See BzrDir.destroy_repository"""
204
79
        self._ensure_real()
205
 
        self._real_bzrdir.destroy_repository()
 
80
        self._real_bzrdir.create_repository(shared=shared)
 
81
        return self.open_repository()
206
82
 
207
83
    def create_branch(self):
208
 
        # as per meta1 formats - just delegate to the format object which may
209
 
        # be parameterised.
210
 
        real_branch = self._format.get_branch_format().initialize(self)
211
 
        if not isinstance(real_branch, RemoteBranch):
212
 
            result = RemoteBranch(self, self.find_repository(), real_branch)
213
 
        else:
214
 
            result = real_branch
215
 
        # BzrDir.clone_on_transport() uses the result of create_branch but does
216
 
        # not return it to its callers; we save approximately 8% of our round
217
 
        # trips by handing the branch we created back to the first caller to
218
 
        # open_branch rather than probing anew. Long term we need a API in
219
 
        # bzrdir that doesn't discard result objects (like result_branch).
220
 
        # RBC 20090225
221
 
        self._next_open_branch_result = result
222
 
        return result
223
 
 
224
 
    def destroy_branch(self):
225
 
        """See BzrDir.destroy_branch"""
226
84
        self._ensure_real()
227
 
        self._real_bzrdir.destroy_branch()
228
 
        self._next_open_branch_result = None
 
85
        real_branch = self._real_bzrdir.create_branch()
 
86
        return RemoteBranch(self, self.find_repository(), real_branch)
229
87
 
230
 
    def create_workingtree(self, revision_id=None, from_branch=None):
 
88
    def create_workingtree(self, revision_id=None):
231
89
        raise errors.NotLocalUrl(self.transport.base)
232
90
 
233
91
    def find_branch_format(self):
240
98
 
241
99
    def get_branch_reference(self):
242
100
        """See BzrDir.get_branch_reference()."""
243
 
        response = self._get_branch_reference()
244
 
        if response[0] == 'ref':
245
 
            return response[1]
246
 
        else:
247
 
            return None
248
 
 
249
 
    def _get_branch_reference(self):
250
101
        path = self._path_for_remote_call(self._client)
251
 
        medium = self._client._medium
252
 
        if not medium._is_remote_before((1, 13)):
253
 
            try:
254
 
                response = self._call('BzrDir.open_branchV2', path)
255
 
                if response[0] not in ('ref', 'branch'):
256
 
                    raise errors.UnexpectedSmartServerResponse(response)
257
 
                return response
258
 
            except errors.UnknownSmartMethod:
259
 
                medium._remember_remote_is_before((1, 13))
260
 
        response = self._call('BzrDir.open_branch', path)
261
 
        if response[0] != 'ok':
 
102
        response = self._client.call('BzrDir.open_branch', path)
 
103
        if response[0] == 'ok':
 
104
            if response[1] == '':
 
105
                # branch at this location.
 
106
                return None
 
107
            else:
 
108
                # a branch reference, use the existing BranchReference logic.
 
109
                return response[1]
 
110
        elif response == ('nobranch',):
 
111
            raise errors.NotBranchError(path=self.root_transport.base)
 
112
        else:
262
113
            raise errors.UnexpectedSmartServerResponse(response)
263
 
        if response[1] != '':
264
 
            return ('ref', response[1])
 
114
 
 
115
    def open_branch(self, _unsupported=False):
 
116
        assert _unsupported == False, 'unsupported flag support not implemented yet.'
 
117
        reference_url = self.get_branch_reference()
 
118
        if reference_url is None:
 
119
            # branch at this location.
 
120
            return RemoteBranch(self, self.find_repository())
265
121
        else:
266
 
            return ('branch', '')
267
 
 
268
 
    def _get_tree_branch(self):
269
 
        """See BzrDir._get_tree_branch()."""
270
 
        return None, self.open_branch()
271
 
 
272
 
    def open_branch(self, _unsupported=False, ignore_fallbacks=False):
273
 
        if _unsupported:
274
 
            raise NotImplementedError('unsupported flag support not implemented yet.')
275
 
        if self._next_open_branch_result is not None:
276
 
            # See create_branch for details.
277
 
            result = self._next_open_branch_result
278
 
            self._next_open_branch_result = None
279
 
            return result
280
 
        response = self._get_branch_reference()
281
 
        if response[0] == 'ref':
282
122
            # a branch reference, use the existing BranchReference logic.
283
123
            format = BranchReferenceFormat()
284
 
            return format.open(self, _found=True, location=response[1],
285
 
                ignore_fallbacks=ignore_fallbacks)
286
 
        branch_format_name = response[1]
287
 
        if not branch_format_name:
288
 
            branch_format_name = None
289
 
        format = RemoteBranchFormat(network_name=branch_format_name)
290
 
        return RemoteBranch(self, self.find_repository(), format=format,
291
 
            setup_stacking=not ignore_fallbacks)
292
 
 
293
 
    def _open_repo_v1(self, path):
294
 
        verb = 'BzrDir.find_repository'
295
 
        response = self._call(verb, path)
296
 
        if response[0] != 'ok':
297
 
            raise errors.UnexpectedSmartServerResponse(response)
298
 
        # servers that only support the v1 method don't support external
299
 
        # references either.
300
 
        self._ensure_real()
301
 
        repo = self._real_bzrdir.open_repository()
302
 
        response = response + ('no', repo._format.network_name())
303
 
        return response, repo
304
 
 
305
 
    def _open_repo_v2(self, path):
306
 
        verb = 'BzrDir.find_repositoryV2'
307
 
        response = self._call(verb, path)
308
 
        if response[0] != 'ok':
309
 
            raise errors.UnexpectedSmartServerResponse(response)
310
 
        self._ensure_real()
311
 
        repo = self._real_bzrdir.open_repository()
312
 
        response = response + (repo._format.network_name(),)
313
 
        return response, repo
314
 
 
315
 
    def _open_repo_v3(self, path):
316
 
        verb = 'BzrDir.find_repositoryV3'
317
 
        medium = self._client._medium
318
 
        if medium._is_remote_before((1, 13)):
319
 
            raise errors.UnknownSmartMethod(verb)
320
 
        try:
321
 
            response = self._call(verb, path)
322
 
        except errors.UnknownSmartMethod:
323
 
            medium._remember_remote_is_before((1, 13))
324
 
            raise
325
 
        if response[0] != 'ok':
326
 
            raise errors.UnexpectedSmartServerResponse(response)
327
 
        return response, None
328
 
 
 
124
            return format.open(self, _found=True, location=reference_url)
 
125
                
329
126
    def open_repository(self):
330
127
        path = self._path_for_remote_call(self._client)
331
 
        response = None
332
 
        for probe in [self._open_repo_v3, self._open_repo_v2,
333
 
            self._open_repo_v1]:
334
 
            try:
335
 
                response, real_repo = probe(path)
336
 
                break
337
 
            except errors.UnknownSmartMethod:
338
 
                pass
339
 
        if response is None:
340
 
            raise errors.UnknownSmartMethod('BzrDir.find_repository{3,2,}')
341
 
        if response[0] != 'ok':
342
 
            raise errors.UnexpectedSmartServerResponse(response)
343
 
        if len(response) != 6:
344
 
            raise SmartProtocolError('incorrect response length %s' % (response,))
 
128
        response = self._client.call('BzrDir.find_repository', path)
 
129
        assert response[0] in ('ok', 'norepository'), \
 
130
            'unexpected response code %s' % (response,)
 
131
        if response[0] == 'norepository':
 
132
            raise errors.NoRepositoryPresent(self)
 
133
        assert len(response) == 4, 'incorrect response length %s' % (response,)
345
134
        if response[1] == '':
346
 
            # repo is at this dir.
347
 
            format = response_tuple_to_repo_format(response[2:])
348
 
            # Used to support creating a real format instance when needed.
349
 
            format._creating_bzrdir = self
350
 
            remote_repo = RemoteRepository(self, format)
351
 
            format._creating_repo = remote_repo
352
 
            if real_repo is not None:
353
 
                remote_repo._set_real_repository(real_repo)
354
 
            return remote_repo
 
135
            format = RemoteRepositoryFormat()
 
136
            format.rich_root_data = (response[2] == 'yes')
 
137
            format.supports_tree_reference = (response[3] == 'yes')
 
138
            return RemoteRepository(self, format)
355
139
        else:
356
140
            raise errors.NoRepositoryPresent(self)
357
141
 
384
168
 
385
169
    def needs_format_conversion(self, format=None):
386
170
        """Upgrading of remote bzrdirs is not supported yet."""
387
 
        if format is None:
388
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
389
 
                % 'needs_format_conversion(format=None)')
390
171
        return False
391
172
 
392
 
    def clone(self, url, revision_id=None, force_new_repo=False,
393
 
              preserve_stacking=False):
 
173
    def clone(self, url, revision_id=None, force_new_repo=False):
394
174
        self._ensure_real()
395
175
        return self._real_bzrdir.clone(url, revision_id=revision_id,
396
 
            force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
397
 
 
398
 
    def _get_config(self):
399
 
        return RemoteBzrDirConfig(self)
 
176
            force_new_repo=force_new_repo)
400
177
 
401
178
 
402
179
class RemoteRepositoryFormat(repository.RepositoryFormat):
405
182
    Instances of this repository are represented by RemoteRepository
406
183
    instances.
407
184
 
408
 
    The RemoteRepositoryFormat is parameterized during construction
 
185
    The RemoteRepositoryFormat is parameterised during construction
409
186
    to reflect the capabilities of the real, remote format. Specifically
410
187
    the attributes rich_root_data and supports_tree_reference are set
411
188
    on a per instance basis, and are not set (and should not be) at
412
189
    the class level.
413
 
 
414
 
    :ivar _custom_format: If set, a specific concrete repository format that
415
 
        will be used when initializing a repository with this
416
 
        RemoteRepositoryFormat.
417
 
    :ivar _creating_repo: If set, the repository object that this
418
 
        RemoteRepositoryFormat was created for: it can be called into
419
 
        to obtain data like the network name.
420
190
    """
421
191
 
422
 
    _matchingbzrdir = RemoteBzrDirFormat()
423
 
 
424
 
    def __init__(self):
425
 
        repository.RepositoryFormat.__init__(self)
426
 
        self._custom_format = None
427
 
        self._network_name = None
428
 
        self._creating_bzrdir = None
429
 
        self._supports_external_lookups = None
430
 
        self._supports_tree_reference = None
431
 
        self._rich_root_data = None
432
 
 
433
 
    @property
434
 
    def fast_deltas(self):
435
 
        self._ensure_real()
436
 
        return self._custom_format.fast_deltas
437
 
 
438
 
    @property
439
 
    def rich_root_data(self):
440
 
        if self._rich_root_data is None:
441
 
            self._ensure_real()
442
 
            self._rich_root_data = self._custom_format.rich_root_data
443
 
        return self._rich_root_data
444
 
 
445
 
    @property
446
 
    def supports_external_lookups(self):
447
 
        if self._supports_external_lookups is None:
448
 
            self._ensure_real()
449
 
            self._supports_external_lookups = \
450
 
                self._custom_format.supports_external_lookups
451
 
        return self._supports_external_lookups
452
 
 
453
 
    @property
454
 
    def supports_tree_reference(self):
455
 
        if self._supports_tree_reference is None:
456
 
            self._ensure_real()
457
 
            self._supports_tree_reference = \
458
 
                self._custom_format.supports_tree_reference
459
 
        return self._supports_tree_reference
460
 
 
461
 
    def _vfs_initialize(self, a_bzrdir, shared):
462
 
        """Helper for common code in initialize."""
463
 
        if self._custom_format:
464
 
            # Custom format requested
465
 
            result = self._custom_format.initialize(a_bzrdir, shared=shared)
466
 
        elif self._creating_bzrdir is not None:
467
 
            # Use the format that the repository we were created to back
468
 
            # has.
469
 
            prior_repo = self._creating_bzrdir.open_repository()
470
 
            prior_repo._ensure_real()
471
 
            result = prior_repo._real_repository._format.initialize(
472
 
                a_bzrdir, shared=shared)
473
 
        else:
474
 
            # assume that a_bzr is a RemoteBzrDir but the smart server didn't
475
 
            # support remote initialization.
476
 
            # We delegate to a real object at this point (as RemoteBzrDir
477
 
            # delegate to the repository format which would lead to infinite
478
 
            # recursion if we just called a_bzrdir.create_repository.
479
 
            a_bzrdir._ensure_real()
480
 
            result = a_bzrdir._real_bzrdir.create_repository(shared=shared)
481
 
        if not isinstance(result, RemoteRepository):
482
 
            return self.open(a_bzrdir)
483
 
        else:
484
 
            return result
 
192
    _matchingbzrdir = RemoteBzrDirFormat
485
193
 
486
194
    def initialize(self, a_bzrdir, shared=False):
487
 
        # Being asked to create on a non RemoteBzrDir:
488
 
        if not isinstance(a_bzrdir, RemoteBzrDir):
489
 
            return self._vfs_initialize(a_bzrdir, shared)
490
 
        medium = a_bzrdir._client._medium
491
 
        if medium._is_remote_before((1, 13)):
492
 
            return self._vfs_initialize(a_bzrdir, shared)
493
 
        # Creating on a remote bzr dir.
494
 
        # 1) get the network name to use.
495
 
        if self._custom_format:
496
 
            network_name = self._custom_format.network_name()
497
 
        elif self._network_name:
498
 
            network_name = self._network_name
499
 
        else:
500
 
            # Select the current bzrlib default and ask for that.
501
 
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
502
 
            reference_format = reference_bzrdir_format.repository_format
503
 
            network_name = reference_format.network_name()
504
 
        # 2) try direct creation via RPC
505
 
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
506
 
        verb = 'BzrDir.create_repository'
507
 
        if shared:
508
 
            shared_str = 'True'
509
 
        else:
510
 
            shared_str = 'False'
511
 
        try:
512
 
            response = a_bzrdir._call(verb, path, network_name, shared_str)
513
 
        except errors.UnknownSmartMethod:
514
 
            # Fallback - use vfs methods
515
 
            medium._remember_remote_is_before((1, 13))
516
 
            return self._vfs_initialize(a_bzrdir, shared)
517
 
        else:
518
 
            # Turn the response into a RemoteRepository object.
519
 
            format = response_tuple_to_repo_format(response[1:])
520
 
            # Used to support creating a real format instance when needed.
521
 
            format._creating_bzrdir = a_bzrdir
522
 
            remote_repo = RemoteRepository(a_bzrdir, format)
523
 
            format._creating_repo = remote_repo
524
 
            return remote_repo
525
 
 
 
195
        assert isinstance(a_bzrdir, RemoteBzrDir), \
 
196
            '%r is not a RemoteBzrDir' % (a_bzrdir,)
 
197
        return a_bzrdir.create_repository(shared=shared)
 
198
    
526
199
    def open(self, a_bzrdir):
527
 
        if not isinstance(a_bzrdir, RemoteBzrDir):
528
 
            raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
 
200
        assert isinstance(a_bzrdir, RemoteBzrDir)
529
201
        return a_bzrdir.open_repository()
530
202
 
531
 
    def _ensure_real(self):
532
 
        if self._custom_format is None:
533
 
            self._custom_format = repository.network_format_registry.get(
534
 
                self._network_name)
535
 
 
536
 
    @property
537
 
    def _fetch_order(self):
538
 
        self._ensure_real()
539
 
        return self._custom_format._fetch_order
540
 
 
541
 
    @property
542
 
    def _fetch_uses_deltas(self):
543
 
        self._ensure_real()
544
 
        return self._custom_format._fetch_uses_deltas
545
 
 
546
 
    @property
547
 
    def _fetch_reconcile(self):
548
 
        self._ensure_real()
549
 
        return self._custom_format._fetch_reconcile
550
 
 
551
203
    def get_format_description(self):
552
204
        return 'bzr remote repository'
553
205
 
554
206
    def __eq__(self, other):
555
 
        return self.__class__ is other.__class__
 
207
        return self.__class__ == other.__class__
556
208
 
557
209
    def check_conversion_target(self, target_format):
558
210
        if self.rich_root_data and not target_format.rich_root_data:
563
215
            raise errors.BadConversionTarget(
564
216
                'Does not support nested trees', target_format)
565
217
 
566
 
    def network_name(self):
567
 
        if self._network_name:
568
 
            return self._network_name
569
 
        self._creating_repo._ensure_real()
570
 
        return self._creating_repo._real_repository._format.network_name()
571
 
 
572
 
    @property
573
 
    def pack_compresses(self):
574
 
        self._ensure_real()
575
 
        return self._custom_format.pack_compresses
576
 
 
577
 
    @property
578
 
    def _serializer(self):
579
 
        self._ensure_real()
580
 
        return self._custom_format._serializer
581
 
 
582
 
 
583
 
class RemoteRepository(_RpcHelper):
 
218
 
 
219
class RemoteRepository(object):
584
220
    """Repository accessed over rpc.
585
221
 
586
222
    For the moment most operations are performed using local transport-backed
589
225
 
590
226
    def __init__(self, remote_bzrdir, format, real_repository=None, _client=None):
591
227
        """Create a RemoteRepository instance.
592
 
 
 
228
        
593
229
        :param remote_bzrdir: The bzrdir hosting this repository.
594
230
        :param format: The RemoteFormat object to use.
595
231
        :param real_repository: If not None, a local implementation of the
604
240
            self._real_repository = None
605
241
        self.bzrdir = remote_bzrdir
606
242
        if _client is None:
607
 
            self._client = remote_bzrdir._client
 
243
            self._client = client._SmartClient(self.bzrdir._shared_medium)
608
244
        else:
609
245
            self._client = _client
610
246
        self._format = format
612
248
        self._lock_token = None
613
249
        self._lock_count = 0
614
250
        self._leave_lock = False
615
 
        # Cache of revision parents; misses are cached during read locks, and
616
 
        # write locks when no _real_repository has been set.
617
 
        self._unstacked_provider = graph.CachingParentsProvider(
618
 
            get_parent_map=self._get_parent_map_rpc)
619
 
        self._unstacked_provider.disable_cache()
620
 
        # For tests:
621
 
        # These depend on the actual remote format, so force them off for
622
 
        # maximum compatibility. XXX: In future these should depend on the
623
 
        # remote repository instance, but this is irrelevant until we perform
624
 
        # reconcile via an RPC call.
625
 
        self._reconcile_does_inventory_gc = False
626
 
        self._reconcile_fixes_text_parents = False
627
 
        self._reconcile_backsup_inventory = False
628
 
        self.base = self.bzrdir.transport.base
629
 
        # Additional places to query for data.
630
 
        self._fallback_repositories = []
631
 
 
632
 
    def __str__(self):
633
 
        return "%s(%s)" % (self.__class__.__name__, self.base)
634
 
 
635
 
    __repr__ = __str__
636
 
 
637
 
    def abort_write_group(self, suppress_errors=False):
 
251
 
 
252
    def abort_write_group(self):
638
253
        """Complete a write group on the decorated repository.
639
 
 
640
 
        Smart methods perform operations in a single step so this API
 
254
        
 
255
        Smart methods peform operations in a single step so this api
641
256
        is not really applicable except as a compatibility thunk
642
257
        for older plugins that don't use e.g. the CommitBuilder
643
258
        facility.
644
 
 
645
 
        :param suppress_errors: see Repository.abort_write_group.
646
 
        """
647
 
        self._ensure_real()
648
 
        return self._real_repository.abort_write_group(
649
 
            suppress_errors=suppress_errors)
650
 
 
651
 
    @property
652
 
    def chk_bytes(self):
653
 
        """Decorate the real repository for now.
654
 
 
655
 
        In the long term a full blown network facility is needed to avoid
656
 
        creating a real repository object locally.
657
 
        """
658
 
        self._ensure_real()
659
 
        return self._real_repository.chk_bytes
 
259
        """
 
260
        self._ensure_real()
 
261
        return self._real_repository.abort_write_group()
660
262
 
661
263
    def commit_write_group(self):
662
264
        """Complete a write group on the decorated repository.
663
 
 
664
 
        Smart methods perform operations in a single step so this API
 
265
        
 
266
        Smart methods peform operations in a single step so this api
665
267
        is not really applicable except as a compatibility thunk
666
268
        for older plugins that don't use e.g. the CommitBuilder
667
269
        facility.
669
271
        self._ensure_real()
670
272
        return self._real_repository.commit_write_group()
671
273
 
672
 
    def resume_write_group(self, tokens):
673
 
        self._ensure_real()
674
 
        return self._real_repository.resume_write_group(tokens)
675
 
 
676
 
    def suspend_write_group(self):
677
 
        self._ensure_real()
678
 
        return self._real_repository.suspend_write_group()
679
 
 
680
 
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
681
 
        self._ensure_real()
682
 
        return self._real_repository.get_missing_parent_inventories(
683
 
            check_for_missing_texts=check_for_missing_texts)
684
 
 
685
 
    def _get_rev_id_for_revno_vfs(self, revno, known_pair):
686
 
        self._ensure_real()
687
 
        return self._real_repository.get_rev_id_for_revno(
688
 
            revno, known_pair)
689
 
 
690
 
    def get_rev_id_for_revno(self, revno, known_pair):
691
 
        """See Repository.get_rev_id_for_revno."""
692
 
        path = self.bzrdir._path_for_remote_call(self._client)
693
 
        try:
694
 
            if self._client._medium._is_remote_before((1, 17)):
695
 
                return self._get_rev_id_for_revno_vfs(revno, known_pair)
696
 
            response = self._call(
697
 
                'Repository.get_rev_id_for_revno', path, revno, known_pair)
698
 
        except errors.UnknownSmartMethod:
699
 
            self._client._medium._remember_remote_is_before((1, 17))
700
 
            return self._get_rev_id_for_revno_vfs(revno, known_pair)
701
 
        if response[0] == 'ok':
702
 
            return True, response[1]
703
 
        elif response[0] == 'history-incomplete':
704
 
            known_pair = response[1:3]
705
 
            for fallback in self._fallback_repositories:
706
 
                found, result = fallback.get_rev_id_for_revno(revno, known_pair)
707
 
                if found:
708
 
                    return True, result
709
 
                else:
710
 
                    known_pair = result
711
 
            # Not found in any fallbacks
712
 
            return False, known_pair
713
 
        else:
714
 
            raise errors.UnexpectedSmartServerResponse(response)
715
 
 
716
274
    def _ensure_real(self):
717
275
        """Ensure that there is a _real_repository set.
718
276
 
719
277
        Used before calls to self._real_repository.
720
 
 
721
 
        Note that _ensure_real causes many roundtrips to the server which are
722
 
        not desirable, and prevents the use of smart one-roundtrip RPC's to
723
 
        perform complex operations (such as accessing parent data, streaming
724
 
        revisions etc). Adding calls to _ensure_real should only be done when
725
 
        bringing up new functionality, adding fallbacks for smart methods that
726
 
        require a fallback path, and never to replace an existing smart method
727
 
        invocation. If in doubt chat to the bzr network team.
728
278
        """
729
 
        if self._real_repository is None:
730
 
            if 'hpssvfs' in debug.debug_flags:
731
 
                import traceback
732
 
                warning('VFS Repository access triggered\n%s',
733
 
                    ''.join(traceback.format_stack()))
734
 
            self._unstacked_provider.missing_keys.clear()
 
279
        if not self._real_repository:
735
280
            self.bzrdir._ensure_real()
736
 
            self._set_real_repository(
737
 
                self.bzrdir._real_bzrdir.open_repository())
738
 
 
739
 
    def _translate_error(self, err, **context):
740
 
        self.bzrdir._translate_error(err, repository=self, **context)
741
 
 
742
 
    def find_text_key_references(self):
743
 
        """Find the text key references within the repository.
744
 
 
745
 
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
746
 
        revision_ids. Each altered file-ids has the exact revision_ids that
747
 
        altered it listed explicitly.
748
 
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
749
 
            to whether they were referred to by the inventory of the
750
 
            revision_id that they contain. The inventory texts from all present
751
 
            revision ids are assessed to generate this report.
752
 
        """
753
 
        self._ensure_real()
754
 
        return self._real_repository.find_text_key_references()
755
 
 
756
 
    def _generate_text_key_index(self):
757
 
        """Generate a new text key index for the repository.
758
 
 
759
 
        This is an expensive function that will take considerable time to run.
760
 
 
761
 
        :return: A dict mapping (file_id, revision_id) tuples to a list of
762
 
            parents, also (file_id, revision_id) tuples.
763
 
        """
764
 
        self._ensure_real()
765
 
        return self._real_repository._generate_text_key_index()
766
 
 
767
 
    def _get_revision_graph(self, revision_id):
768
 
        """Private method for using with old (< 1.2) servers to fallback."""
 
281
            #self._real_repository = self.bzrdir._real_bzrdir.open_repository()
 
282
            self._set_real_repository(self.bzrdir._real_bzrdir.open_repository())
 
283
 
 
284
    def get_revision_graph(self, revision_id=None):
 
285
        """See Repository.get_revision_graph()."""
769
286
        if revision_id is None:
770
287
            revision_id = ''
771
 
        elif revision.is_null(revision_id):
 
288
        elif revision_id == NULL_REVISION:
772
289
            return {}
773
290
 
774
291
        path = self.bzrdir._path_for_remote_call(self._client)
775
 
        response = self._call_expecting_body(
 
292
        assert type(revision_id) is str
 
293
        response = self._client.call_expecting_body(
776
294
            'Repository.get_revision_graph', path, revision_id)
777
 
        response_tuple, response_handler = response
778
 
        if response_tuple[0] != 'ok':
779
 
            raise errors.UnexpectedSmartServerResponse(response_tuple)
780
 
        coded = response_handler.read_body_bytes()
781
 
        if coded == '':
782
 
            # no revisions in this repository!
783
 
            return {}
784
 
        lines = coded.split('\n')
785
 
        revision_graph = {}
786
 
        for line in lines:
787
 
            d = tuple(line.split())
788
 
            revision_graph[d[0]] = d[1:]
789
 
 
790
 
        return revision_graph
791
 
 
792
 
    def _get_sink(self):
793
 
        """See Repository._get_sink()."""
794
 
        return RemoteStreamSink(self)
795
 
 
796
 
    def _get_source(self, to_format):
797
 
        """Return a source for streaming from this repository."""
798
 
        return RemoteStreamSource(self, to_format)
799
 
 
800
 
    @needs_read_lock
 
295
        if response[0][0] not in ['ok', 'nosuchrevision']:
 
296
            raise errors.UnexpectedSmartServerResponse(response[0])
 
297
        if response[0][0] == 'ok':
 
298
            coded = response[1].read_body_bytes()
 
299
            if coded == '':
 
300
                # no revisions in this repository!
 
301
                return {}
 
302
            lines = coded.split('\n')
 
303
            revision_graph = {}
 
304
            for line in lines:
 
305
                d = tuple(line.split())
 
306
                revision_graph[d[0]] = d[1:]
 
307
                
 
308
            return revision_graph
 
309
        else:
 
310
            response_body = response[1].read_body_bytes()
 
311
            assert response_body == ''
 
312
            raise NoSuchRevision(self, revision_id)
 
313
 
801
314
    def has_revision(self, revision_id):
802
 
        """True if this repository has a copy of the revision."""
803
 
        # Copy of bzrlib.repository.Repository.has_revision
804
 
        return revision_id in self.has_revisions((revision_id,))
805
 
 
806
 
    @needs_read_lock
807
 
    def has_revisions(self, revision_ids):
808
 
        """Probe to find out the presence of multiple revisions.
809
 
 
810
 
        :param revision_ids: An iterable of revision_ids.
811
 
        :return: A set of the revision_ids that were present.
812
 
        """
813
 
        # Copy of bzrlib.repository.Repository.has_revisions
814
 
        parent_map = self.get_parent_map(revision_ids)
815
 
        result = set(parent_map)
816
 
        if _mod_revision.NULL_REVISION in revision_ids:
817
 
            result.add(_mod_revision.NULL_REVISION)
818
 
        return result
819
 
 
820
 
    def _has_same_fallbacks(self, other_repo):
821
 
        """Returns true if the repositories have the same fallbacks."""
822
 
        # XXX: copied from Repository; it should be unified into a base class
823
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401622>
824
 
        my_fb = self._fallback_repositories
825
 
        other_fb = other_repo._fallback_repositories
826
 
        if len(my_fb) != len(other_fb):
827
 
            return False
828
 
        for f, g in zip(my_fb, other_fb):
829
 
            if not f.has_same_location(g):
830
 
                return False
831
 
        return True
 
315
        """See Repository.has_revision()."""
 
316
        if revision_id is None:
 
317
            # The null revision is always present.
 
318
            return True
 
319
        path = self.bzrdir._path_for_remote_call(self._client)
 
320
        response = self._client.call('Repository.has_revision', path, revision_id)
 
321
        assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
 
322
        return response[0] == 'yes'
832
323
 
833
324
    def has_same_location(self, other):
834
 
        # TODO: Move to RepositoryBase and unify with the regular Repository
835
 
        # one; unfortunately the tests rely on slightly different behaviour at
836
 
        # present -- mbp 20090710
837
 
        return (self.__class__ is other.__class__ and
 
325
        return (self.__class__ == other.__class__ and
838
326
                self.bzrdir.transport.base == other.bzrdir.transport.base)
839
 
 
 
327
        
840
328
    def get_graph(self, other_repository=None):
841
329
        """Return the graph for this repository format"""
842
 
        parents_provider = self._make_parents_provider(other_repository)
843
 
        return graph.Graph(parents_provider)
 
330
        return self._real_repository.get_graph(other_repository)
844
331
 
845
332
    def gather_stats(self, revid=None, committers=None):
846
333
        """See Repository.gather_stats()."""
847
334
        path = self.bzrdir._path_for_remote_call(self._client)
848
 
        # revid can be None to indicate no revisions, not just NULL_REVISION
849
 
        if revid is None or revision.is_null(revid):
 
335
        if revid in (None, NULL_REVISION):
850
336
            fmt_revid = ''
851
337
        else:
852
338
            fmt_revid = revid
854
340
            fmt_committers = 'no'
855
341
        else:
856
342
            fmt_committers = 'yes'
857
 
        response_tuple, response_handler = self._call_expecting_body(
 
343
        response = self._client.call_expecting_body(
858
344
            'Repository.gather_stats', path, fmt_revid, fmt_committers)
859
 
        if response_tuple[0] != 'ok':
860
 
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
345
        assert response[0][0] == 'ok', \
 
346
            'unexpected response code %s' % (response[0],)
861
347
 
862
 
        body = response_handler.read_body_bytes()
 
348
        body = response[1].read_body_bytes()
863
349
        result = {}
864
350
        for line in body.split('\n'):
865
351
            if not line:
873
359
 
874
360
        return result
875
361
 
876
 
    def find_branches(self, using=False):
877
 
        """See Repository.find_branches()."""
878
 
        # should be an API call to the server.
879
 
        self._ensure_real()
880
 
        return self._real_repository.find_branches(using=using)
881
 
 
882
362
    def get_physical_lock_status(self):
883
363
        """See Repository.get_physical_lock_status()."""
884
 
        # should be an API call to the server.
885
 
        self._ensure_real()
886
 
        return self._real_repository.get_physical_lock_status()
 
364
        return False
887
365
 
888
366
    def is_in_write_group(self):
889
367
        """Return True if there is an open write group.
899
377
    def is_shared(self):
900
378
        """See Repository.is_shared()."""
901
379
        path = self.bzrdir._path_for_remote_call(self._client)
902
 
        response = self._call('Repository.is_shared', path)
903
 
        if response[0] not in ('yes', 'no'):
904
 
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
380
        response = self._client.call('Repository.is_shared', path)
 
381
        assert response[0] in ('yes', 'no'), 'unexpected response code %s' % (response,)
905
382
        return response[0] == 'yes'
906
383
 
907
 
    def is_write_locked(self):
908
 
        return self._lock_mode == 'w'
909
 
 
910
384
    def lock_read(self):
911
385
        # wrong eventually - want a local lock cache context
912
386
        if not self._lock_mode:
913
387
            self._lock_mode = 'r'
914
388
            self._lock_count = 1
915
 
            self._unstacked_provider.enable_cache(cache_misses=True)
916
389
            if self._real_repository is not None:
917
390
                self._real_repository.lock_read()
918
 
            for repo in self._fallback_repositories:
919
 
                repo.lock_read()
920
391
        else:
921
392
            self._lock_count += 1
922
393
 
924
395
        path = self.bzrdir._path_for_remote_call(self._client)
925
396
        if token is None:
926
397
            token = ''
927
 
        err_context = {'token': token}
928
 
        response = self._call('Repository.lock_write', path, token,
929
 
                              **err_context)
 
398
        response = self._client.call('Repository.lock_write', path, token)
930
399
        if response[0] == 'ok':
931
400
            ok, token = response
932
401
            return token
 
402
        elif response[0] == 'LockContention':
 
403
            raise errors.LockContention('(remote lock)')
 
404
        elif response[0] == 'UnlockableTransport':
 
405
            raise errors.UnlockableTransport(self.bzrdir.root_transport)
933
406
        else:
934
407
            raise errors.UnexpectedSmartServerResponse(response)
935
408
 
936
 
    def lock_write(self, token=None, _skip_rpc=False):
 
409
    def lock_write(self, token=None):
937
410
        if not self._lock_mode:
938
 
            if _skip_rpc:
939
 
                if self._lock_token is not None:
940
 
                    if token != self._lock_token:
941
 
                        raise errors.TokenMismatch(token, self._lock_token)
942
 
                self._lock_token = token
943
 
            else:
944
 
                self._lock_token = self._remote_lock_write(token)
945
 
            # if self._lock_token is None, then this is something like packs or
946
 
            # svn where we don't get to lock the repo, or a weave style repository
947
 
            # where we cannot lock it over the wire and attempts to do so will
948
 
            # fail.
 
411
            self._lock_token = self._remote_lock_write(token)
 
412
            assert self._lock_token, 'Remote server did not return a token!'
949
413
            if self._real_repository is not None:
950
414
                self._real_repository.lock_write(token=self._lock_token)
951
415
            if token is not None:
954
418
                self._leave_lock = False
955
419
            self._lock_mode = 'w'
956
420
            self._lock_count = 1
957
 
            cache_misses = self._real_repository is None
958
 
            self._unstacked_provider.enable_cache(cache_misses=cache_misses)
959
 
            for repo in self._fallback_repositories:
960
 
                # Writes don't affect fallback repos
961
 
                repo.lock_read()
962
421
        elif self._lock_mode == 'r':
963
422
            raise errors.ReadOnlyError(self)
964
423
        else:
965
424
            self._lock_count += 1
966
 
        return self._lock_token or None
 
425
        return self._lock_token
967
426
 
968
427
    def leave_lock_in_place(self):
969
 
        if not self._lock_token:
970
 
            raise NotImplementedError(self.leave_lock_in_place)
971
428
        self._leave_lock = True
972
429
 
973
430
    def dont_leave_lock_in_place(self):
974
 
        if not self._lock_token:
975
 
            raise NotImplementedError(self.dont_leave_lock_in_place)
976
431
        self._leave_lock = False
977
432
 
978
433
    def _set_real_repository(self, repository):
981
436
        :param repository: The repository to fallback to for non-hpss
982
437
            implemented operations.
983
438
        """
984
 
        if self._real_repository is not None:
985
 
            # Replacing an already set real repository.
986
 
            # We cannot do this [currently] if the repository is locked -
987
 
            # synchronised state might be lost.
988
 
            if self.is_locked():
989
 
                raise AssertionError('_real_repository is already set')
990
 
        if isinstance(repository, RemoteRepository):
991
 
            raise AssertionError()
 
439
        assert not isinstance(repository, RemoteRepository)
992
440
        self._real_repository = repository
993
 
        # three code paths happen here:
994
 
        # 1) old servers, RemoteBranch.open() calls _ensure_real before setting
995
 
        # up stacking. In this case self._fallback_repositories is [], and the
996
 
        # real repo is already setup. Preserve the real repo and
997
 
        # RemoteRepository.add_fallback_repository will avoid adding
998
 
        # duplicates.
999
 
        # 2) new servers, RemoteBranch.open() sets up stacking, and when
1000
 
        # ensure_real is triggered from a branch, the real repository to
1001
 
        # set already has a matching list with separate instances, but
1002
 
        # as they are also RemoteRepositories we don't worry about making the
1003
 
        # lists be identical.
1004
 
        # 3) new servers, RemoteRepository.ensure_real is triggered before
1005
 
        # RemoteBranch.ensure real, in this case we get a repo with no fallbacks
1006
 
        # and need to populate it.
1007
 
        if (self._fallback_repositories and
1008
 
            len(self._real_repository._fallback_repositories) !=
1009
 
            len(self._fallback_repositories)):
1010
 
            if len(self._real_repository._fallback_repositories):
1011
 
                raise AssertionError(
1012
 
                    "cannot cleanly remove existing _fallback_repositories")
1013
 
        for fb in self._fallback_repositories:
1014
 
            self._real_repository.add_fallback_repository(fb)
1015
441
        if self._lock_mode == 'w':
1016
442
            # if we are already locked, the real repository must be able to
1017
443
            # acquire the lock with our token.
1021
447
 
1022
448
    def start_write_group(self):
1023
449
        """Start a write group on the decorated repository.
1024
 
 
1025
 
        Smart methods perform operations in a single step so this API
 
450
        
 
451
        Smart methods peform operations in a single step so this api
1026
452
        is not really applicable except as a compatibility thunk
1027
453
        for older plugins that don't use e.g. the CommitBuilder
1028
454
        facility.
1032
458
 
1033
459
    def _unlock(self, token):
1034
460
        path = self.bzrdir._path_for_remote_call(self._client)
1035
 
        if not token:
1036
 
            # with no token the remote repository is not persistently locked.
1037
 
            return
1038
 
        err_context = {'token': token}
1039
 
        response = self._call('Repository.unlock', path, token,
1040
 
                              **err_context)
 
461
        response = self._client.call('Repository.unlock', path, token)
1041
462
        if response == ('ok',):
1042
463
            return
 
464
        elif response[0] == 'TokenMismatch':
 
465
            raise errors.TokenMismatch(token, '(remote token)')
1043
466
        else:
1044
467
            raise errors.UnexpectedSmartServerResponse(response)
1045
468
 
1046
469
    def unlock(self):
 
470
        if self._lock_count == 1 and self._lock_mode == 'w':
 
471
            # don't unlock if inside a write group.
 
472
            if self.is_in_write_group():
 
473
                raise errors.BzrError(
 
474
                    'Must end write groups before releasing write locks.')
 
475
        self._lock_count -= 1
1047
476
        if not self._lock_count:
1048
 
            return lock.cant_unlock_not_held(self)
1049
 
        self._lock_count -= 1
1050
 
        if self._lock_count > 0:
1051
 
            return
1052
 
        self._unstacked_provider.disable_cache()
1053
 
        old_mode = self._lock_mode
1054
 
        self._lock_mode = None
1055
 
        try:
1056
 
            # The real repository is responsible at present for raising an
1057
 
            # exception if it's in an unfinished write group.  However, it
1058
 
            # normally will *not* actually remove the lock from disk - that's
1059
 
            # done by the server on receiving the Repository.unlock call.
1060
 
            # This is just to let the _real_repository stay up to date.
 
477
            mode = self._lock_mode
 
478
            self._lock_mode = None
1061
479
            if self._real_repository is not None:
1062
480
                self._real_repository.unlock()
1063
 
        finally:
1064
 
            # The rpc-level lock should be released even if there was a
1065
 
            # problem releasing the vfs-based lock.
1066
 
            if old_mode == 'w':
 
481
            if mode != 'w':
1067
482
                # Only write-locked repositories need to make a remote method
1068
 
                # call to perform the unlock.
1069
 
                old_token = self._lock_token
1070
 
                self._lock_token = None
1071
 
                if not self._leave_lock:
1072
 
                    self._unlock(old_token)
1073
 
        # Fallbacks are always 'lock_read()' so we don't pay attention to
1074
 
        # self._leave_lock
1075
 
        for repo in self._fallback_repositories:
1076
 
            repo.unlock()
 
483
                # call to perfom the unlock.
 
484
                return
 
485
            assert self._lock_token, 'Locked, but no token!'
 
486
            token = self._lock_token
 
487
            self._lock_token = None
 
488
            if not self._leave_lock:
 
489
                self._unlock(token)
1077
490
 
1078
491
    def break_lock(self):
1079
492
        # should hand off to the network
1081
494
        return self._real_repository.break_lock()
1082
495
 
1083
496
    def _get_tarball(self, compression):
1084
 
        """Return a TemporaryFile containing a repository tarball.
1085
 
 
1086
 
        Returns None if the server does not support sending tarballs.
1087
 
        """
 
497
        """Return a TemporaryFile containing a repository tarball"""
1088
498
        import tempfile
1089
499
        path = self.bzrdir._path_for_remote_call(self._client)
1090
 
        try:
1091
 
            response, protocol = self._call_expecting_body(
1092
 
                'Repository.tarball', path, compression)
1093
 
        except errors.UnknownSmartMethod:
1094
 
            protocol.cancel_read_body()
1095
 
            return None
 
500
        response, protocol = self._client.call_expecting_body(
 
501
            'Repository.tarball', path, compression)
 
502
        assert response[0] in ('ok', 'failure'), \
 
503
            'unexpected response code %s' % (response,)
1096
504
        if response[0] == 'ok':
1097
505
            # Extract the tarball and return it
1098
506
            t = tempfile.NamedTemporaryFile()
1100
508
            t.write(protocol.read_body_bytes())
1101
509
            t.seek(0)
1102
510
            return t
1103
 
        raise errors.UnexpectedSmartServerResponse(response)
 
511
        else:
 
512
            raise errors.SmartServerError(error_code=response)
1104
513
 
1105
514
    def sprout(self, to_bzrdir, revision_id=None):
1106
515
        # TODO: Option to control what format is created?
1107
 
        self._ensure_real()
1108
 
        dest_repo = self._real_repository._format.initialize(to_bzrdir,
1109
 
                                                             shared=False)
1110
 
        dest_repo.fetch(self, revision_id=revision_id)
1111
 
        return dest_repo
 
516
        to_repo = to_bzrdir.create_repository()
 
517
        self._copy_repository_tarball(to_repo, revision_id)
 
518
        return to_repo
1112
519
 
1113
520
    ### These methods are just thin shims to the VFS object for now.
1114
521
 
1126
533
        # FIXME: It ought to be possible to call this without immediately
1127
534
        # triggering _ensure_real.  For now it's the easiest thing to do.
1128
535
        self._ensure_real()
1129
 
        real_repo = self._real_repository
1130
 
        builder = real_repo.get_commit_builder(branch, parents,
 
536
        builder = self._real_repository.get_commit_builder(branch, parents,
1131
537
                config, timestamp=timestamp, timezone=timezone,
1132
538
                committer=committer, revprops=revprops, revision_id=revision_id)
 
539
        # Make the builder use this RemoteRepository rather than the real one.
 
540
        builder.repository = self
1133
541
        return builder
1134
542
 
1135
 
    def add_fallback_repository(self, repository):
1136
 
        """Add a repository to use for looking up data not held locally.
1137
 
 
1138
 
        :param repository: A repository.
1139
 
        """
1140
 
        if not self._format.supports_external_lookups:
1141
 
            raise errors.UnstackableRepositoryFormat(
1142
 
                self._format.network_name(), self.base)
1143
 
        # We need to accumulate additional repositories here, to pass them in
1144
 
        # on various RPC's.
1145
 
        #
1146
 
        if self.is_locked():
1147
 
            # We will call fallback.unlock() when we transition to the unlocked
1148
 
            # state, so always add a lock here. If a caller passes us a locked
1149
 
            # repository, they are responsible for unlocking it later.
1150
 
            repository.lock_read()
1151
 
        self._fallback_repositories.append(repository)
1152
 
        # If self._real_repository was parameterised already (e.g. because a
1153
 
        # _real_branch had its get_stacked_on_url method called), then the
1154
 
        # repository to be added may already be in the _real_repositories list.
1155
 
        if self._real_repository is not None:
1156
 
            fallback_locations = [repo.bzrdir.root_transport.base for repo in
1157
 
                self._real_repository._fallback_repositories]
1158
 
            if repository.bzrdir.root_transport.base not in fallback_locations:
1159
 
                self._real_repository.add_fallback_repository(repository)
1160
 
 
 
543
    @needs_write_lock
1161
544
    def add_inventory(self, revid, inv, parents):
1162
545
        self._ensure_real()
1163
546
        return self._real_repository.add_inventory(revid, inv, parents)
1164
547
 
1165
 
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1166
 
                               parents):
1167
 
        self._ensure_real()
1168
 
        return self._real_repository.add_inventory_by_delta(basis_revision_id,
1169
 
            delta, new_revision_id, parents)
1170
 
 
 
548
    @needs_write_lock
1171
549
    def add_revision(self, rev_id, rev, inv=None, config=None):
1172
550
        self._ensure_real()
1173
551
        return self._real_repository.add_revision(
1178
556
        self._ensure_real()
1179
557
        return self._real_repository.get_inventory(revision_id)
1180
558
 
1181
 
    def iter_inventories(self, revision_ids):
1182
 
        self._ensure_real()
1183
 
        return self._real_repository.iter_inventories(revision_ids)
1184
 
 
1185
559
    @needs_read_lock
1186
560
    def get_revision(self, revision_id):
1187
561
        self._ensure_real()
1188
562
        return self._real_repository.get_revision(revision_id)
1189
563
 
 
564
    @property
 
565
    def weave_store(self):
 
566
        self._ensure_real()
 
567
        return self._real_repository.weave_store
 
568
 
1190
569
    def get_transaction(self):
1191
570
        self._ensure_real()
1192
571
        return self._real_repository.get_transaction()
1197
576
        return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
1198
577
 
1199
578
    def make_working_trees(self):
1200
 
        """See Repository.make_working_trees"""
 
579
        """RemoteRepositories never create working trees by default."""
 
580
        return False
 
581
 
 
582
    def fetch(self, source, revision_id=None, pb=None):
1201
583
        self._ensure_real()
1202
 
        return self._real_repository.make_working_trees()
1203
 
 
1204
 
    def refresh_data(self):
1205
 
        """Re-read any data needed to to synchronise with disk.
1206
 
 
1207
 
        This method is intended to be called after another repository instance
1208
 
        (such as one used by a smart server) has inserted data into the
1209
 
        repository. It may not be called during a write group, but may be
1210
 
        called at any other time.
1211
 
        """
1212
 
        if self.is_in_write_group():
1213
 
            raise errors.InternalBzrError(
1214
 
                "May not refresh_data while in a write group.")
1215
 
        if self._real_repository is not None:
1216
 
            self._real_repository.refresh_data()
1217
 
 
1218
 
    def revision_ids_to_search_result(self, result_set):
1219
 
        """Convert a set of revision ids to a graph SearchResult."""
1220
 
        result_parents = set()
1221
 
        for parents in self.get_graph().get_parent_map(
1222
 
            result_set).itervalues():
1223
 
            result_parents.update(parents)
1224
 
        included_keys = result_set.intersection(result_parents)
1225
 
        start_keys = result_set.difference(included_keys)
1226
 
        exclude_keys = result_parents.difference(result_set)
1227
 
        result = graph.SearchResult(start_keys, exclude_keys,
1228
 
            len(result_set), result_set)
1229
 
        return result
1230
 
 
1231
 
    @needs_read_lock
1232
 
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1233
 
        """Return the revision ids that other has that this does not.
1234
 
 
1235
 
        These are returned in topological order.
1236
 
 
1237
 
        revision_id: only return revision ids included by revision_id.
1238
 
        """
1239
 
        return repository.InterRepository.get(
1240
 
            other, self).search_missing_revision_ids(revision_id, find_ghosts)
1241
 
 
1242
 
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1243
 
            fetch_spec=None):
1244
 
        # No base implementation to use as RemoteRepository is not a subclass
1245
 
        # of Repository; so this is a copy of Repository.fetch().
1246
 
        if fetch_spec is not None and revision_id is not None:
1247
 
            raise AssertionError(
1248
 
                "fetch_spec and revision_id are mutually exclusive.")
1249
 
        if self.is_in_write_group():
1250
 
            raise errors.InternalBzrError(
1251
 
                "May not fetch while in a write group.")
1252
 
        # fast path same-url fetch operations
1253
 
        if (self.has_same_location(source)
1254
 
            and fetch_spec is None
1255
 
            and self._has_same_fallbacks(source)):
1256
 
            # check that last_revision is in 'from' and then return a
1257
 
            # no-operation.
1258
 
            if (revision_id is not None and
1259
 
                not revision.is_null(revision_id)):
1260
 
                self.get_revision(revision_id)
1261
 
            return 0, []
1262
 
        # if there is no specific appropriate InterRepository, this will get
1263
 
        # the InterRepository base class, which raises an
1264
 
        # IncompatibleRepositories when asked to fetch.
1265
 
        inter = repository.InterRepository.get(source, self)
1266
 
        return inter.fetch(revision_id=revision_id, pb=pb,
1267
 
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
 
584
        return self._real_repository.fetch(
 
585
            source, revision_id=revision_id, pb=pb)
1268
586
 
1269
587
    def create_bundle(self, target, base, fileobj, format=None):
1270
588
        self._ensure_real()
1271
589
        self._real_repository.create_bundle(target, base, fileobj, format)
1272
590
 
 
591
    @property
 
592
    def control_weaves(self):
 
593
        self._ensure_real()
 
594
        return self._real_repository.control_weaves
 
595
 
1273
596
    @needs_read_lock
1274
597
    def get_ancestry(self, revision_id, topo_sorted=True):
1275
598
        self._ensure_real()
1276
599
        return self._real_repository.get_ancestry(revision_id, topo_sorted)
1277
600
 
 
601
    @needs_read_lock
 
602
    def get_inventory_weave(self):
 
603
        self._ensure_real()
 
604
        return self._real_repository.get_inventory_weave()
 
605
 
1278
606
    def fileids_altered_by_revision_ids(self, revision_ids):
1279
607
        self._ensure_real()
1280
608
        return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
1281
609
 
1282
 
    def _get_versioned_file_checker(self, revisions, revision_versions_cache):
1283
 
        self._ensure_real()
1284
 
        return self._real_repository._get_versioned_file_checker(
1285
 
            revisions, revision_versions_cache)
1286
 
 
1287
 
    def iter_files_bytes(self, desired_files):
1288
 
        """See Repository.iter_file_bytes.
1289
 
        """
1290
 
        self._ensure_real()
1291
 
        return self._real_repository.iter_files_bytes(desired_files)
1292
 
 
1293
 
    def get_parent_map(self, revision_ids):
1294
 
        """See bzrlib.Graph.get_parent_map()."""
1295
 
        return self._make_parents_provider().get_parent_map(revision_ids)
1296
 
 
1297
 
    def _get_parent_map_rpc(self, keys):
1298
 
        """Helper for get_parent_map that performs the RPC."""
1299
 
        medium = self._client._medium
1300
 
        if medium._is_remote_before((1, 2)):
1301
 
            # We already found out that the server can't understand
1302
 
            # Repository.get_parent_map requests, so just fetch the whole
1303
 
            # graph.
1304
 
            #
1305
 
            # Note that this reads the whole graph, when only some keys are
1306
 
            # wanted.  On this old server there's no way (?) to get them all
1307
 
            # in one go, and the user probably will have seen a warning about
1308
 
            # the server being old anyhow.
1309
 
            rg = self._get_revision_graph(None)
1310
 
            # There is an API discrepancy between get_parent_map and
1311
 
            # get_revision_graph. Specifically, a "key:()" pair in
1312
 
            # get_revision_graph just means a node has no parents. For
1313
 
            # "get_parent_map" it means the node is a ghost. So fix up the
1314
 
            # graph to correct this.
1315
 
            #   https://bugs.launchpad.net/bzr/+bug/214894
1316
 
            # There is one other "bug" which is that ghosts in
1317
 
            # get_revision_graph() are not returned at all. But we won't worry
1318
 
            # about that for now.
1319
 
            for node_id, parent_ids in rg.iteritems():
1320
 
                if parent_ids == ():
1321
 
                    rg[node_id] = (NULL_REVISION,)
1322
 
            rg[NULL_REVISION] = ()
1323
 
            return rg
1324
 
 
1325
 
        keys = set(keys)
1326
 
        if None in keys:
1327
 
            raise ValueError('get_parent_map(None) is not valid')
1328
 
        if NULL_REVISION in keys:
1329
 
            keys.discard(NULL_REVISION)
1330
 
            found_parents = {NULL_REVISION:()}
1331
 
            if not keys:
1332
 
                return found_parents
1333
 
        else:
1334
 
            found_parents = {}
1335
 
        # TODO(Needs analysis): We could assume that the keys being requested
1336
 
        # from get_parent_map are in a breadth first search, so typically they
1337
 
        # will all be depth N from some common parent, and we don't have to
1338
 
        # have the server iterate from the root parent, but rather from the
1339
 
        # keys we're searching; and just tell the server the keyspace we
1340
 
        # already have; but this may be more traffic again.
1341
 
 
1342
 
        # Transform self._parents_map into a search request recipe.
1343
 
        # TODO: Manage this incrementally to avoid covering the same path
1344
 
        # repeatedly. (The server will have to on each request, but the less
1345
 
        # work done the better).
1346
 
        #
1347
 
        # Negative caching notes:
1348
 
        # new server sends missing when a request including the revid
1349
 
        # 'include-missing:' is present in the request.
1350
 
        # missing keys are serialised as missing:X, and we then call
1351
 
        # provider.note_missing(X) for-all X
1352
 
        parents_map = self._unstacked_provider.get_cached_map()
1353
 
        if parents_map is None:
1354
 
            # Repository is not locked, so there's no cache.
1355
 
            parents_map = {}
1356
 
        # start_set is all the keys in the cache
1357
 
        start_set = set(parents_map)
1358
 
        # result set is all the references to keys in the cache
1359
 
        result_parents = set()
1360
 
        for parents in parents_map.itervalues():
1361
 
            result_parents.update(parents)
1362
 
        stop_keys = result_parents.difference(start_set)
1363
 
        # We don't need to send ghosts back to the server as a position to
1364
 
        # stop either.
1365
 
        stop_keys.difference_update(self._unstacked_provider.missing_keys)
1366
 
        key_count = len(parents_map)
1367
 
        if (NULL_REVISION in result_parents
1368
 
            and NULL_REVISION in self._unstacked_provider.missing_keys):
1369
 
            # If we pruned NULL_REVISION from the stop_keys because it's also
1370
 
            # in our cache of "missing" keys we need to increment our key count
1371
 
            # by 1, because the reconsitituted SearchResult on the server will
1372
 
            # still consider NULL_REVISION to be an included key.
1373
 
            key_count += 1
1374
 
        included_keys = start_set.intersection(result_parents)
1375
 
        start_set.difference_update(included_keys)
1376
 
        recipe = ('manual', start_set, stop_keys, key_count)
1377
 
        body = self._serialise_search_recipe(recipe)
1378
 
        path = self.bzrdir._path_for_remote_call(self._client)
1379
 
        for key in keys:
1380
 
            if type(key) is not str:
1381
 
                raise ValueError(
1382
 
                    "key %r not a plain string" % (key,))
1383
 
        verb = 'Repository.get_parent_map'
1384
 
        args = (path, 'include-missing:') + tuple(keys)
1385
 
        try:
1386
 
            response = self._call_with_body_bytes_expecting_body(
1387
 
                verb, args, body)
1388
 
        except errors.UnknownSmartMethod:
1389
 
            # Server does not support this method, so get the whole graph.
1390
 
            # Worse, we have to force a disconnection, because the server now
1391
 
            # doesn't realise it has a body on the wire to consume, so the
1392
 
            # only way to recover is to abandon the connection.
1393
 
            warning(
1394
 
                'Server is too old for fast get_parent_map, reconnecting.  '
1395
 
                '(Upgrade the server to Bazaar 1.2 to avoid this)')
1396
 
            medium.disconnect()
1397
 
            # To avoid having to disconnect repeatedly, we keep track of the
1398
 
            # fact the server doesn't understand remote methods added in 1.2.
1399
 
            medium._remember_remote_is_before((1, 2))
1400
 
            # Recurse just once and we should use the fallback code.
1401
 
            return self._get_parent_map_rpc(keys)
1402
 
        response_tuple, response_handler = response
1403
 
        if response_tuple[0] not in ['ok']:
1404
 
            response_handler.cancel_read_body()
1405
 
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1406
 
        if response_tuple[0] == 'ok':
1407
 
            coded = bz2.decompress(response_handler.read_body_bytes())
1408
 
            if coded == '':
1409
 
                # no revisions found
1410
 
                return {}
1411
 
            lines = coded.split('\n')
1412
 
            revision_graph = {}
1413
 
            for line in lines:
1414
 
                d = tuple(line.split())
1415
 
                if len(d) > 1:
1416
 
                    revision_graph[d[0]] = d[1:]
1417
 
                else:
1418
 
                    # No parents:
1419
 
                    if d[0].startswith('missing:'):
1420
 
                        revid = d[0][8:]
1421
 
                        self._unstacked_provider.note_missing_key(revid)
1422
 
                    else:
1423
 
                        # no parents - so give the Graph result
1424
 
                        # (NULL_REVISION,).
1425
 
                        revision_graph[d[0]] = (NULL_REVISION,)
1426
 
            return revision_graph
1427
 
 
1428
610
    @needs_read_lock
1429
611
    def get_signature_text(self, revision_id):
1430
612
        self._ensure_real()
1431
613
        return self._real_repository.get_signature_text(revision_id)
1432
614
 
1433
615
    @needs_read_lock
 
616
    def get_revision_graph_with_ghosts(self, revision_ids=None):
 
617
        self._ensure_real()
 
618
        return self._real_repository.get_revision_graph_with_ghosts(
 
619
            revision_ids=revision_ids)
 
620
 
 
621
    @needs_read_lock
1434
622
    def get_inventory_xml(self, revision_id):
1435
623
        self._ensure_real()
1436
624
        return self._real_repository.get_inventory_xml(revision_id)
1442
630
    def reconcile(self, other=None, thorough=False):
1443
631
        self._ensure_real()
1444
632
        return self._real_repository.reconcile(other=other, thorough=thorough)
1445
 
 
 
633
        
1446
634
    def all_revision_ids(self):
1447
635
        self._ensure_real()
1448
636
        return self._real_repository.all_revision_ids()
1449
 
 
1450
 
    @needs_read_lock
1451
 
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1452
 
        self._ensure_real()
1453
 
        return self._real_repository.get_deltas_for_revisions(revisions,
1454
 
            specific_fileids=specific_fileids)
1455
 
 
1456
 
    @needs_read_lock
1457
 
    def get_revision_delta(self, revision_id, specific_fileids=None):
1458
 
        self._ensure_real()
1459
 
        return self._real_repository.get_revision_delta(revision_id,
1460
 
            specific_fileids=specific_fileids)
 
637
    
 
638
    @needs_read_lock
 
639
    def get_deltas_for_revisions(self, revisions):
 
640
        self._ensure_real()
 
641
        return self._real_repository.get_deltas_for_revisions(revisions)
 
642
 
 
643
    @needs_read_lock
 
644
    def get_revision_delta(self, revision_id):
 
645
        self._ensure_real()
 
646
        return self._real_repository.get_revision_delta(revision_id)
1461
647
 
1462
648
    @needs_read_lock
1463
649
    def revision_trees(self, revision_ids):
1470
656
        return self._real_repository.get_revision_reconcile(revision_id)
1471
657
 
1472
658
    @needs_read_lock
1473
 
    def check(self, revision_ids=None):
 
659
    def check(self, revision_ids):
1474
660
        self._ensure_real()
1475
 
        return self._real_repository.check(revision_ids=revision_ids)
 
661
        return self._real_repository.check(revision_ids)
1476
662
 
1477
663
    def copy_content_into(self, destination, revision_id=None):
1478
664
        self._ensure_real()
1479
665
        return self._real_repository.copy_content_into(
1480
666
            destination, revision_id=revision_id)
1481
667
 
1482
 
    def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
 
668
    def _copy_repository_tarball(self, destination, revision_id=None):
1483
669
        # get a tarball of the remote repository, and copy from that into the
1484
670
        # destination
1485
671
        from bzrlib import osutils
1486
672
        import tarfile
 
673
        import tempfile
 
674
        from StringIO import StringIO
1487
675
        # TODO: Maybe a progress bar while streaming the tarball?
1488
676
        note("Copying repository content as tarball...")
1489
677
        tar_file = self._get_tarball('bz2')
1490
 
        if tar_file is None:
1491
 
            return None
1492
 
        destination = to_bzrdir.create_repository()
1493
678
        try:
1494
679
            tar = tarfile.open('repository', fileobj=tar_file,
1495
680
                mode='r|bz2')
1496
 
            tmpdir = osutils.mkdtemp()
 
681
            tmpdir = tempfile.mkdtemp()
1497
682
            try:
1498
683
                _extract_tar(tar, tmpdir)
1499
684
                tmp_bzrdir = BzrDir.open(tmpdir)
1503
688
                osutils.rmtree(tmpdir)
1504
689
        finally:
1505
690
            tar_file.close()
1506
 
        return destination
 
691
        # TODO: if the server doesn't support this operation, maybe do it the
 
692
        # slow way using the _real_repository?
 
693
        #
1507
694
        # TODO: Suggestion from john: using external tar is much faster than
1508
695
        # python's tarfile library, but it may not work on windows.
1509
696
 
1510
 
    @property
1511
 
    def inventories(self):
1512
 
        """Decorate the real repository for now.
1513
 
 
1514
 
        In the long term a full blown network facility is needed to
1515
 
        avoid creating a real repository object locally.
1516
 
        """
1517
 
        self._ensure_real()
1518
 
        return self._real_repository.inventories
1519
 
 
1520
697
    @needs_write_lock
1521
 
    def pack(self, hint=None):
 
698
    def pack(self):
1522
699
        """Compress the data within the repository.
1523
700
 
1524
701
        This is not currently implemented within the smart server.
1525
702
        """
1526
703
        self._ensure_real()
1527
 
        return self._real_repository.pack(hint=hint)
1528
 
 
1529
 
    @property
1530
 
    def revisions(self):
1531
 
        """Decorate the real repository for now.
1532
 
 
1533
 
        In the short term this should become a real object to intercept graph
1534
 
        lookups.
1535
 
 
1536
 
        In the long term a full blown network facility is needed.
1537
 
        """
1538
 
        self._ensure_real()
1539
 
        return self._real_repository.revisions
 
704
        return self._real_repository.pack()
1540
705
 
1541
706
    def set_make_working_trees(self, new_value):
1542
 
        if new_value:
1543
 
            new_value_str = "True"
1544
 
        else:
1545
 
            new_value_str = "False"
1546
 
        path = self.bzrdir._path_for_remote_call(self._client)
1547
 
        try:
1548
 
            response = self._call(
1549
 
                'Repository.set_make_working_trees', path, new_value_str)
1550
 
        except errors.UnknownSmartMethod:
1551
 
            self._ensure_real()
1552
 
            self._real_repository.set_make_working_trees(new_value)
1553
 
        else:
1554
 
            if response[0] != 'ok':
1555
 
                raise errors.UnexpectedSmartServerResponse(response)
1556
 
 
1557
 
    @property
1558
 
    def signatures(self):
1559
 
        """Decorate the real repository for now.
1560
 
 
1561
 
        In the long term a full blown network facility is needed to avoid
1562
 
        creating a real repository object locally.
1563
 
        """
1564
 
        self._ensure_real()
1565
 
        return self._real_repository.signatures
 
707
        raise NotImplementedError(self.set_make_working_trees)
1566
708
 
1567
709
    @needs_write_lock
1568
710
    def sign_revision(self, revision_id, gpg_strategy):
1569
711
        self._ensure_real()
1570
712
        return self._real_repository.sign_revision(revision_id, gpg_strategy)
1571
713
 
1572
 
    @property
1573
 
    def texts(self):
1574
 
        """Decorate the real repository for now.
1575
 
 
1576
 
        In the long term a full blown network facility is needed to avoid
1577
 
        creating a real repository object locally.
1578
 
        """
1579
 
        self._ensure_real()
1580
 
        return self._real_repository.texts
1581
 
 
1582
714
    @needs_read_lock
1583
715
    def get_revisions(self, revision_ids):
1584
716
        self._ensure_real()
1585
717
        return self._real_repository.get_revisions(revision_ids)
1586
718
 
1587
719
    def supports_rich_root(self):
1588
 
        return self._format.rich_root_data
 
720
        self._ensure_real()
 
721
        return self._real_repository.supports_rich_root()
1589
722
 
1590
723
    def iter_reverse_revision_history(self, revision_id):
1591
724
        self._ensure_real()
1593
726
 
1594
727
    @property
1595
728
    def _serializer(self):
1596
 
        return self._format._serializer
 
729
        self._ensure_real()
 
730
        return self._real_repository._serializer
1597
731
 
1598
732
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1599
733
        self._ensure_real()
1600
734
        return self._real_repository.store_revision_signature(
1601
735
            gpg_strategy, plaintext, revision_id)
1602
736
 
1603
 
    def add_signature_text(self, revision_id, signature):
1604
 
        self._ensure_real()
1605
 
        return self._real_repository.add_signature_text(revision_id, signature)
1606
 
 
1607
737
    def has_signature_for_revision_id(self, revision_id):
1608
738
        self._ensure_real()
1609
739
        return self._real_repository.has_signature_for_revision_id(revision_id)
1610
740
 
1611
 
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1612
 
        self._ensure_real()
1613
 
        return self._real_repository.item_keys_introduced_by(revision_ids,
1614
 
            _files_pb=_files_pb)
1615
 
 
1616
 
    def revision_graph_can_have_wrong_parents(self):
1617
 
        # The answer depends on the remote repo format.
1618
 
        self._ensure_real()
1619
 
        return self._real_repository.revision_graph_can_have_wrong_parents()
1620
 
 
1621
 
    def _find_inconsistent_revision_parents(self):
1622
 
        self._ensure_real()
1623
 
        return self._real_repository._find_inconsistent_revision_parents()
1624
 
 
1625
 
    def _check_for_inconsistent_revision_parents(self):
1626
 
        self._ensure_real()
1627
 
        return self._real_repository._check_for_inconsistent_revision_parents()
1628
 
 
1629
 
    def _make_parents_provider(self, other=None):
1630
 
        providers = [self._unstacked_provider]
1631
 
        if other is not None:
1632
 
            providers.insert(0, other)
1633
 
        providers.extend(r._make_parents_provider() for r in
1634
 
                         self._fallback_repositories)
1635
 
        return graph.StackedParentsProvider(providers)
1636
 
 
1637
 
    def _serialise_search_recipe(self, recipe):
1638
 
        """Serialise a graph search recipe.
1639
 
 
1640
 
        :param recipe: A search recipe (start, stop, count).
1641
 
        :return: Serialised bytes.
1642
 
        """
1643
 
        start_keys = ' '.join(recipe[1])
1644
 
        stop_keys = ' '.join(recipe[2])
1645
 
        count = str(recipe[3])
1646
 
        return '\n'.join((start_keys, stop_keys, count))
1647
 
 
1648
 
    def _serialise_search_result(self, search_result):
1649
 
        if isinstance(search_result, graph.PendingAncestryResult):
1650
 
            parts = ['ancestry-of']
1651
 
            parts.extend(search_result.heads)
1652
 
        else:
1653
 
            recipe = search_result.get_recipe()
1654
 
            parts = [recipe[0], self._serialise_search_recipe(recipe)]
1655
 
        return '\n'.join(parts)
1656
 
 
1657
 
    def autopack(self):
1658
 
        path = self.bzrdir._path_for_remote_call(self._client)
1659
 
        try:
1660
 
            response = self._call('PackRepository.autopack', path)
1661
 
        except errors.UnknownSmartMethod:
1662
 
            self._ensure_real()
1663
 
            self._real_repository._pack_collection.autopack()
1664
 
            return
1665
 
        self.refresh_data()
1666
 
        if response[0] != 'ok':
1667
 
            raise errors.UnexpectedSmartServerResponse(response)
1668
 
 
1669
 
 
1670
 
class RemoteStreamSink(repository.StreamSink):
1671
 
 
1672
 
    def _insert_real(self, stream, src_format, resume_tokens):
1673
 
        self.target_repo._ensure_real()
1674
 
        sink = self.target_repo._real_repository._get_sink()
1675
 
        result = sink.insert_stream(stream, src_format, resume_tokens)
1676
 
        if not result:
1677
 
            self.target_repo.autopack()
1678
 
        return result
1679
 
 
1680
 
    def insert_stream(self, stream, src_format, resume_tokens):
1681
 
        target = self.target_repo
1682
 
        target._unstacked_provider.missing_keys.clear()
1683
 
        if target._lock_token:
1684
 
            verb = 'Repository.insert_stream_locked'
1685
 
            extra_args = (target._lock_token or '',)
1686
 
            required_version = (1, 14)
1687
 
        else:
1688
 
            verb = 'Repository.insert_stream'
1689
 
            extra_args = ()
1690
 
            required_version = (1, 13)
1691
 
        client = target._client
1692
 
        medium = client._medium
1693
 
        if medium._is_remote_before(required_version):
1694
 
            # No possible way this can work.
1695
 
            return self._insert_real(stream, src_format, resume_tokens)
1696
 
        path = target.bzrdir._path_for_remote_call(client)
1697
 
        if not resume_tokens:
1698
 
            # XXX: Ugly but important for correctness, *will* be fixed during
1699
 
            # 1.13 cycle. Pushing a stream that is interrupted results in a
1700
 
            # fallback to the _real_repositories sink *with a partial stream*.
1701
 
            # Thats bad because we insert less data than bzr expected. To avoid
1702
 
            # this we do a trial push to make sure the verb is accessible, and
1703
 
            # do not fallback when actually pushing the stream. A cleanup patch
1704
 
            # is going to look at rewinding/restarting the stream/partial
1705
 
            # buffering etc.
1706
 
            byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1707
 
            try:
1708
 
                response = client.call_with_body_stream(
1709
 
                    (verb, path, '') + extra_args, byte_stream)
1710
 
            except errors.UnknownSmartMethod:
1711
 
                medium._remember_remote_is_before(required_version)
1712
 
                return self._insert_real(stream, src_format, resume_tokens)
1713
 
        byte_stream = smart_repo._stream_to_byte_stream(
1714
 
            stream, src_format)
1715
 
        resume_tokens = ' '.join(resume_tokens)
1716
 
        response = client.call_with_body_stream(
1717
 
            (verb, path, resume_tokens) + extra_args, byte_stream)
1718
 
        if response[0][0] not in ('ok', 'missing-basis'):
1719
 
            raise errors.UnexpectedSmartServerResponse(response)
1720
 
        if response[0][0] == 'missing-basis':
1721
 
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1722
 
            resume_tokens = tokens
1723
 
            return resume_tokens, set(missing_keys)
1724
 
        else:
1725
 
            self.target_repo.refresh_data()
1726
 
            return [], set()
1727
 
 
1728
 
 
1729
 
class RemoteStreamSource(repository.StreamSource):
1730
 
    """Stream data from a remote server."""
1731
 
 
1732
 
    def get_stream(self, search):
1733
 
        if (self.from_repository._fallback_repositories and
1734
 
            self.to_format._fetch_order == 'topological'):
1735
 
            return self._real_stream(self.from_repository, search)
1736
 
        return self.missing_parents_chain(search, [self.from_repository] +
1737
 
            self.from_repository._fallback_repositories)
1738
 
 
1739
 
    def _real_stream(self, repo, search):
1740
 
        """Get a stream for search from repo.
1741
 
        
1742
 
        This never called RemoteStreamSource.get_stream, and is a heler
1743
 
        for RemoteStreamSource._get_stream to allow getting a stream 
1744
 
        reliably whether fallback back because of old servers or trying
1745
 
        to stream from a non-RemoteRepository (which the stacked support
1746
 
        code will do).
1747
 
        """
1748
 
        source = repo._get_source(self.to_format)
1749
 
        if isinstance(source, RemoteStreamSource):
1750
 
            return repository.StreamSource.get_stream(source, search)
1751
 
        return source.get_stream(search)
1752
 
 
1753
 
    def _get_stream(self, repo, search):
1754
 
        """Core worker to get a stream from repo for search.
1755
 
 
1756
 
        This is used by both get_stream and the stacking support logic. It
1757
 
        deliberately gets a stream for repo which does not need to be
1758
 
        self.from_repository. In the event that repo is not Remote, or
1759
 
        cannot do a smart stream, a fallback is made to the generic
1760
 
        repository._get_stream() interface, via self._real_stream.
1761
 
 
1762
 
        In the event of stacking, streams from _get_stream will not
1763
 
        contain all the data for search - this is normal (see get_stream).
1764
 
 
1765
 
        :param repo: A repository.
1766
 
        :param search: A search.
1767
 
        """
1768
 
        # Fallbacks may be non-smart
1769
 
        if not isinstance(repo, RemoteRepository):
1770
 
            return self._real_stream(repo, search)
1771
 
        client = repo._client
1772
 
        medium = client._medium
1773
 
        if medium._is_remote_before((1, 13)):
1774
 
            # streaming was added in 1.13
1775
 
            return self._real_stream(repo, search)
1776
 
        path = repo.bzrdir._path_for_remote_call(client)
1777
 
        try:
1778
 
            search_bytes = repo._serialise_search_result(search)
1779
 
            response = repo._call_with_body_bytes_expecting_body(
1780
 
                'Repository.get_stream',
1781
 
                (path, self.to_format.network_name()), search_bytes)
1782
 
            response_tuple, response_handler = response
1783
 
        except errors.UnknownSmartMethod:
1784
 
            medium._remember_remote_is_before((1,13))
1785
 
            return self._real_stream(repo, search)
1786
 
        if response_tuple[0] != 'ok':
1787
 
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1788
 
        byte_stream = response_handler.read_streamed_body()
1789
 
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
1790
 
        if src_format.network_name() != repo._format.network_name():
1791
 
            raise AssertionError(
1792
 
                "Mismatched RemoteRepository and stream src %r, %r" % (
1793
 
                src_format.network_name(), repo._format.network_name()))
1794
 
        return stream
1795
 
 
1796
 
    def missing_parents_chain(self, search, sources):
1797
 
        """Chain multiple streams together to handle stacking.
1798
 
 
1799
 
        :param search: The overall search to satisfy with streams.
1800
 
        :param sources: A list of Repository objects to query.
1801
 
        """
1802
 
        self.serialiser = self.to_format._serializer
1803
 
        self.seen_revs = set()
1804
 
        self.referenced_revs = set()
1805
 
        # If there are heads in the search, or the key count is > 0, we are not
1806
 
        # done.
1807
 
        while not search.is_empty() and len(sources) > 1:
1808
 
            source = sources.pop(0)
1809
 
            stream = self._get_stream(source, search)
1810
 
            for kind, substream in stream:
1811
 
                if kind != 'revisions':
1812
 
                    yield kind, substream
1813
 
                else:
1814
 
                    yield kind, self.missing_parents_rev_handler(substream)
1815
 
            search = search.refine(self.seen_revs, self.referenced_revs)
1816
 
            self.seen_revs = set()
1817
 
            self.referenced_revs = set()
1818
 
        if not search.is_empty():
1819
 
            for kind, stream in self._get_stream(sources[0], search):
1820
 
                yield kind, stream
1821
 
 
1822
 
    def missing_parents_rev_handler(self, substream):
1823
 
        for content in substream:
1824
 
            revision_bytes = content.get_bytes_as('fulltext')
1825
 
            revision = self.serialiser.read_revision_from_string(revision_bytes)
1826
 
            self.seen_revs.add(content.key[-1])
1827
 
            self.referenced_revs.update(revision.parent_ids)
1828
 
            yield content
1829
 
 
1830
741
 
1831
742
class RemoteBranchLockableFiles(LockableFiles):
1832
743
    """A 'LockableFiles' implementation that talks to a smart server.
1833
 
 
 
744
    
1834
745
    This is not a public interface class.
1835
746
    """
1836
747
 
1847
758
        self._dir_mode = None
1848
759
        self._file_mode = None
1849
760
 
 
761
    def get(self, path):
 
762
        """'get' a remote path as per the LockableFiles interface.
 
763
 
 
764
        :param path: the file to 'get'. If this is 'branch.conf', we do not
 
765
             just retrieve a file, instead we ask the smart server to generate
 
766
             a configuration for us - which is retrieved as an INI file.
 
767
        """
 
768
        if path == 'branch.conf':
 
769
            path = self.bzrdir._path_for_remote_call(self._client)
 
770
            response = self._client.call_expecting_body(
 
771
                'Branch.get_config_file', path)
 
772
            assert response[0][0] == 'ok', \
 
773
                'unexpected response code %s' % (response[0],)
 
774
            return StringIO(response[1].read_body_bytes())
 
775
        else:
 
776
            # VFS fallback.
 
777
            return LockableFiles.get(self, path)
 
778
 
1850
779
 
1851
780
class RemoteBranchFormat(branch.BranchFormat):
1852
781
 
1853
 
    def __init__(self, network_name=None):
1854
 
        super(RemoteBranchFormat, self).__init__()
1855
 
        self._matchingbzrdir = RemoteBzrDirFormat()
1856
 
        self._matchingbzrdir.set_branch_format(self)
1857
 
        self._custom_format = None
1858
 
        self._network_name = network_name
1859
 
 
1860
782
    def __eq__(self, other):
1861
 
        return (isinstance(other, RemoteBranchFormat) and
 
783
        return (isinstance(other, RemoteBranchFormat) and 
1862
784
            self.__dict__ == other.__dict__)
1863
785
 
1864
 
    def _ensure_real(self):
1865
 
        if self._custom_format is None:
1866
 
            self._custom_format = branch.network_format_registry.get(
1867
 
                self._network_name)
1868
 
 
1869
786
    def get_format_description(self):
1870
787
        return 'Remote BZR Branch'
1871
788
 
1872
 
    def network_name(self):
1873
 
        return self._network_name
1874
 
 
1875
 
    def open(self, a_bzrdir, ignore_fallbacks=False):
1876
 
        return a_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
1877
 
 
1878
 
    def _vfs_initialize(self, a_bzrdir):
1879
 
        # Initialisation when using a local bzrdir object, or a non-vfs init
1880
 
        # method is not available on the server.
1881
 
        # self._custom_format is always set - the start of initialize ensures
1882
 
        # that.
1883
 
        if isinstance(a_bzrdir, RemoteBzrDir):
1884
 
            a_bzrdir._ensure_real()
1885
 
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir)
1886
 
        else:
1887
 
            # We assume the bzrdir is parameterised; it may not be.
1888
 
            result = self._custom_format.initialize(a_bzrdir)
1889
 
        if (isinstance(a_bzrdir, RemoteBzrDir) and
1890
 
            not isinstance(result, RemoteBranch)):
1891
 
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result)
1892
 
        return result
 
789
    def get_format_string(self):
 
790
        return 'Remote BZR Branch'
 
791
 
 
792
    def open(self, a_bzrdir):
 
793
        assert isinstance(a_bzrdir, RemoteBzrDir)
 
794
        return a_bzrdir.open_branch()
1893
795
 
1894
796
    def initialize(self, a_bzrdir):
1895
 
        # 1) get the network name to use.
1896
 
        if self._custom_format:
1897
 
            network_name = self._custom_format.network_name()
1898
 
        else:
1899
 
            # Select the current bzrlib default and ask for that.
1900
 
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
1901
 
            reference_format = reference_bzrdir_format.get_branch_format()
1902
 
            self._custom_format = reference_format
1903
 
            network_name = reference_format.network_name()
1904
 
        # Being asked to create on a non RemoteBzrDir:
1905
 
        if not isinstance(a_bzrdir, RemoteBzrDir):
1906
 
            return self._vfs_initialize(a_bzrdir)
1907
 
        medium = a_bzrdir._client._medium
1908
 
        if medium._is_remote_before((1, 13)):
1909
 
            return self._vfs_initialize(a_bzrdir)
1910
 
        # Creating on a remote bzr dir.
1911
 
        # 2) try direct creation via RPC
1912
 
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
1913
 
        verb = 'BzrDir.create_branch'
1914
 
        try:
1915
 
            response = a_bzrdir._call(verb, path, network_name)
1916
 
        except errors.UnknownSmartMethod:
1917
 
            # Fallback - use vfs methods
1918
 
            medium._remember_remote_is_before((1, 13))
1919
 
            return self._vfs_initialize(a_bzrdir)
1920
 
        if response[0] != 'ok':
1921
 
            raise errors.UnexpectedSmartServerResponse(response)
1922
 
        # Turn the response into a RemoteRepository object.
1923
 
        format = RemoteBranchFormat(network_name=response[1])
1924
 
        repo_format = response_tuple_to_repo_format(response[3:])
1925
 
        if response[2] == '':
1926
 
            repo_bzrdir = a_bzrdir
1927
 
        else:
1928
 
            repo_bzrdir = RemoteBzrDir(
1929
 
                a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
1930
 
                a_bzrdir._client)
1931
 
        remote_repo = RemoteRepository(repo_bzrdir, repo_format)
1932
 
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
1933
 
            format=format, setup_stacking=False)
1934
 
        # XXX: We know this is a new branch, so it must have revno 0, revid
1935
 
        # NULL_REVISION. Creating the branch locked would make this be unable
1936
 
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
1937
 
        remote_branch._last_revision_info_cache = 0, NULL_REVISION
1938
 
        return remote_branch
1939
 
 
1940
 
    def make_tags(self, branch):
1941
 
        self._ensure_real()
1942
 
        return self._custom_format.make_tags(branch)
1943
 
 
1944
 
    def supports_tags(self):
1945
 
        # Remote branches might support tags, but we won't know until we
1946
 
        # access the real remote branch.
1947
 
        self._ensure_real()
1948
 
        return self._custom_format.supports_tags()
1949
 
 
1950
 
    def supports_stacking(self):
1951
 
        self._ensure_real()
1952
 
        return self._custom_format.supports_stacking()
1953
 
 
1954
 
    def supports_set_append_revisions_only(self):
1955
 
        self._ensure_real()
1956
 
        return self._custom_format.supports_set_append_revisions_only()
1957
 
 
1958
 
 
1959
 
class RemoteBranch(branch.Branch, _RpcHelper):
 
797
        assert isinstance(a_bzrdir, RemoteBzrDir)
 
798
        return a_bzrdir.create_branch()
 
799
 
 
800
 
 
801
class RemoteBranch(branch.Branch):
1960
802
    """Branch stored on a server accessed by HPSS RPC.
1961
803
 
1962
804
    At the moment most operations are mapped down to simple file operations.
1963
805
    """
1964
806
 
1965
807
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
1966
 
        _client=None, format=None, setup_stacking=True):
 
808
        _client=None):
1967
809
        """Create a RemoteBranch instance.
1968
810
 
1969
811
        :param real_branch: An optional local implementation of the branch
1970
812
            format, usually accessing the data via the VFS.
1971
813
        :param _client: Private parameter for testing.
1972
 
        :param format: A RemoteBranchFormat object, None to create one
1973
 
            automatically. If supplied it should have a network_name already
1974
 
            supplied.
1975
 
        :param setup_stacking: If True make an RPC call to determine the
1976
 
            stacked (or not) status of the branch. If False assume the branch
1977
 
            is not stacked.
1978
814
        """
1979
815
        # We intentionally don't call the parent class's __init__, because it
1980
816
        # will try to assign to self.tags, which is a property in this subclass.
1981
817
        # And the parent's __init__ doesn't do much anyway.
 
818
        self._revision_history_cache = None
1982
819
        self.bzrdir = remote_bzrdir
1983
820
        if _client is not None:
1984
821
            self._client = _client
1985
822
        else:
1986
 
            self._client = remote_bzrdir._client
 
823
            self._client = client._SmartClient(self.bzrdir._shared_medium)
1987
824
        self.repository = remote_repository
1988
825
        if real_branch is not None:
1989
826
            self._real_branch = real_branch
1997
834
            self._real_branch.repository = self.repository
1998
835
        else:
1999
836
            self._real_branch = None
2000
 
        # Fill out expected attributes of branch for bzrlib API users.
2001
 
        self._clear_cached_state()
 
837
        # Fill out expected attributes of branch for bzrlib api users.
 
838
        self._format = RemoteBranchFormat()
2002
839
        self.base = self.bzrdir.root_transport.base
2003
840
        self._control_files = None
2004
841
        self._lock_mode = None
2005
842
        self._lock_token = None
2006
 
        self._repo_lock_token = None
2007
843
        self._lock_count = 0
2008
844
        self._leave_lock = False
2009
 
        # Setup a format: note that we cannot call _ensure_real until all the
2010
 
        # attributes above are set: This code cannot be moved higher up in this
2011
 
        # function.
2012
 
        if format is None:
2013
 
            self._format = RemoteBranchFormat()
2014
 
            if real_branch is not None:
2015
 
                self._format._network_name = \
2016
 
                    self._real_branch._format.network_name()
2017
 
        else:
2018
 
            self._format = format
2019
 
        if not self._format._network_name:
2020
 
            # Did not get from open_branchV2 - old server.
2021
 
            self._ensure_real()
2022
 
            self._format._network_name = \
2023
 
                self._real_branch._format.network_name()
2024
 
        self.tags = self._format.make_tags(self)
2025
 
        # The base class init is not called, so we duplicate this:
2026
 
        hooks = branch.Branch.hooks['open']
2027
 
        for hook in hooks:
2028
 
            hook(self)
2029
 
        self._is_stacked = False
2030
 
        if setup_stacking:
2031
 
            self._setup_stacking()
2032
 
 
2033
 
    def _setup_stacking(self):
2034
 
        # configure stacking into the remote repository, by reading it from
2035
 
        # the vfs branch.
2036
 
        try:
2037
 
            fallback_url = self.get_stacked_on_url()
2038
 
        except (errors.NotStacked, errors.UnstackableBranchFormat,
2039
 
            errors.UnstackableRepositoryFormat), e:
2040
 
            return
2041
 
        self._is_stacked = True
2042
 
        self._activate_fallback_location(fallback_url)
2043
 
 
2044
 
    def _get_config(self):
2045
 
        return RemoteBranchConfig(self)
2046
 
 
2047
 
    def _get_real_transport(self):
2048
 
        # if we try vfs access, return the real branch's vfs transport
2049
 
        self._ensure_real()
2050
 
        return self._real_branch._transport
2051
 
 
2052
 
    _transport = property(_get_real_transport)
2053
845
 
2054
846
    def __str__(self):
2055
847
        return "%s(%s)" % (self.__class__.__name__, self.base)
2061
853
 
2062
854
        Used before calls to self._real_branch.
2063
855
        """
2064
 
        if self._real_branch is None:
2065
 
            if not vfs.vfs_enabled():
2066
 
                raise AssertionError('smart server vfs must be enabled '
2067
 
                    'to use vfs implementation')
 
856
        if not self._real_branch:
 
857
            assert vfs.vfs_enabled()
2068
858
            self.bzrdir._ensure_real()
2069
859
            self._real_branch = self.bzrdir._real_bzrdir.open_branch()
2070
 
            if self.repository._real_repository is None:
2071
 
                # Give the remote repository the matching real repo.
2072
 
                real_repo = self._real_branch.repository
2073
 
                if isinstance(real_repo, RemoteRepository):
2074
 
                    real_repo._ensure_real()
2075
 
                    real_repo = real_repo._real_repository
2076
 
                self.repository._set_real_repository(real_repo)
2077
 
            # Give the real branch the remote repository to let fast-pathing
2078
 
            # happen.
 
860
            # Give the remote repository the matching real repo.
 
861
            real_repo = self._real_branch.repository
 
862
            if isinstance(real_repo, RemoteRepository):
 
863
                real_repo._ensure_real()
 
864
                real_repo = real_repo._real_repository
 
865
            self.repository._set_real_repository(real_repo)
 
866
            # Give the branch the remote repository to let fast-pathing happen.
2079
867
            self._real_branch.repository = self.repository
 
868
            # XXX: deal with _lock_mode == 'w'
2080
869
            if self._lock_mode == 'r':
2081
870
                self._real_branch.lock_read()
2082
 
            elif self._lock_mode == 'w':
2083
 
                self._real_branch.lock_write(token=self._lock_token)
2084
 
 
2085
 
    def _translate_error(self, err, **context):
2086
 
        self.repository._translate_error(err, branch=self, **context)
2087
 
 
2088
 
    def _clear_cached_state(self):
2089
 
        super(RemoteBranch, self)._clear_cached_state()
2090
 
        if self._real_branch is not None:
2091
 
            self._real_branch._clear_cached_state()
2092
 
 
2093
 
    def _clear_cached_state_of_remote_branch_only(self):
2094
 
        """Like _clear_cached_state, but doesn't clear the cache of
2095
 
        self._real_branch.
2096
 
 
2097
 
        This is useful when falling back to calling a method of
2098
 
        self._real_branch that changes state.  In that case the underlying
2099
 
        branch changes, so we need to invalidate this RemoteBranch's cache of
2100
 
        it.  However, there's no need to invalidate the _real_branch's cache
2101
 
        too, in fact doing so might harm performance.
2102
 
        """
2103
 
        super(RemoteBranch, self)._clear_cached_state()
2104
871
 
2105
872
    @property
2106
873
    def control_files(self):
2121
888
        self._ensure_real()
2122
889
        return self._real_branch.get_physical_lock_status()
2123
890
 
2124
 
    def get_stacked_on_url(self):
2125
 
        """Get the URL this branch is stacked against.
2126
 
 
2127
 
        :raises NotStacked: If the branch is not stacked.
2128
 
        :raises UnstackableBranchFormat: If the branch does not support
2129
 
            stacking.
2130
 
        :raises UnstackableRepositoryFormat: If the repository does not support
2131
 
            stacking.
2132
 
        """
2133
 
        try:
2134
 
            # there may not be a repository yet, so we can't use
2135
 
            # self._translate_error, so we can't use self._call either.
2136
 
            response = self._client.call('Branch.get_stacked_on_url',
2137
 
                self._remote_path())
2138
 
        except errors.ErrorFromSmartServer, err:
2139
 
            # there may not be a repository yet, so we can't call through
2140
 
            # its _translate_error
2141
 
            _translate_error(err, branch=self)
2142
 
        except errors.UnknownSmartMethod, err:
2143
 
            self._ensure_real()
2144
 
            return self._real_branch.get_stacked_on_url()
2145
 
        if response[0] != 'ok':
2146
 
            raise errors.UnexpectedSmartServerResponse(response)
2147
 
        return response[1]
2148
 
 
2149
 
    def set_stacked_on_url(self, url):
2150
 
        branch.Branch.set_stacked_on_url(self, url)
2151
 
        if not url:
2152
 
            self._is_stacked = False
2153
 
        else:
2154
 
            self._is_stacked = True
2155
 
        
2156
 
    def _vfs_get_tags_bytes(self):
2157
 
        self._ensure_real()
2158
 
        return self._real_branch._get_tags_bytes()
2159
 
 
2160
 
    def _get_tags_bytes(self):
2161
 
        medium = self._client._medium
2162
 
        if medium._is_remote_before((1, 13)):
2163
 
            return self._vfs_get_tags_bytes()
2164
 
        try:
2165
 
            response = self._call('Branch.get_tags_bytes', self._remote_path())
2166
 
        except errors.UnknownSmartMethod:
2167
 
            medium._remember_remote_is_before((1, 13))
2168
 
            return self._vfs_get_tags_bytes()
2169
 
        return response[0]
2170
 
 
2171
 
    def _vfs_set_tags_bytes(self, bytes):
2172
 
        self._ensure_real()
2173
 
        return self._real_branch._set_tags_bytes(bytes)
2174
 
 
2175
 
    def _set_tags_bytes(self, bytes):
2176
 
        medium = self._client._medium
2177
 
        if medium._is_remote_before((1, 18)):
2178
 
            self._vfs_set_tags_bytes(bytes)
2179
 
        try:
2180
 
            args = (
2181
 
                self._remote_path(), self._lock_token, self._repo_lock_token)
2182
 
            response = self._call_with_body_bytes(
2183
 
                'Branch.set_tags_bytes', args, bytes)
2184
 
        except errors.UnknownSmartMethod:
2185
 
            medium._remember_remote_is_before((1, 18))
2186
 
            self._vfs_set_tags_bytes(bytes)
2187
 
 
2188
891
    def lock_read(self):
2189
 
        self.repository.lock_read()
2190
892
        if not self._lock_mode:
2191
893
            self._lock_mode = 'r'
2192
894
            self._lock_count = 1
2202
904
            branch_token = token
2203
905
            repo_token = self.repository.lock_write()
2204
906
            self.repository.unlock()
2205
 
        err_context = {'token': token}
2206
 
        response = self._call(
2207
 
            'Branch.lock_write', self._remote_path(), branch_token,
2208
 
            repo_token or '', **err_context)
2209
 
        if response[0] != 'ok':
 
907
        path = self.bzrdir._path_for_remote_call(self._client)
 
908
        response = self._client.call('Branch.lock_write', path, branch_token,
 
909
                                     repo_token)
 
910
        if response[0] == 'ok':
 
911
            ok, branch_token, repo_token = response
 
912
            return branch_token, repo_token
 
913
        elif response[0] == 'LockContention':
 
914
            raise errors.LockContention('(remote lock)')
 
915
        elif response[0] == 'TokenMismatch':
 
916
            raise errors.TokenMismatch(token, '(remote token)')
 
917
        elif response[0] == 'UnlockableTransport':
 
918
            raise errors.UnlockableTransport(self.bzrdir.root_transport)
 
919
        elif response[0] == 'ReadOnlyError':
 
920
            raise errors.ReadOnlyError(self)
 
921
        else:
2210
922
            raise errors.UnexpectedSmartServerResponse(response)
2211
 
        ok, branch_token, repo_token = response
2212
 
        return branch_token, repo_token
2213
 
 
 
923
            
2214
924
    def lock_write(self, token=None):
2215
925
        if not self._lock_mode:
2216
 
            # Lock the branch and repo in one remote call.
2217
926
            remote_tokens = self._remote_lock_write(token)
2218
927
            self._lock_token, self._repo_lock_token = remote_tokens
2219
 
            if not self._lock_token:
2220
 
                raise SmartProtocolError('Remote server did not return a token!')
2221
 
            # Tell the self.repository object that it is locked.
2222
 
            self.repository.lock_write(
2223
 
                self._repo_lock_token, _skip_rpc=True)
2224
 
 
 
928
            assert self._lock_token, 'Remote server did not return a token!'
 
929
            # TODO: We really, really, really don't want to call _ensure_real
 
930
            # here, but it's the easiest way to ensure coherency between the
 
931
            # state of the RemoteBranch and RemoteRepository objects and the
 
932
            # physical locks.  If we don't materialise the real objects here,
 
933
            # then getting everything in the right state later is complex, so
 
934
            # for now we just do it the lazy way.
 
935
            #   -- Andrew Bennetts, 2007-02-22.
 
936
            self._ensure_real()
2225
937
            if self._real_branch is not None:
2226
 
                self._real_branch.lock_write(token=self._lock_token)
 
938
                self._real_branch.repository.lock_write(
 
939
                    token=self._repo_lock_token)
 
940
                try:
 
941
                    self._real_branch.lock_write(token=self._lock_token)
 
942
                finally:
 
943
                    self._real_branch.repository.unlock()
2227
944
            if token is not None:
2228
945
                self._leave_lock = True
2229
946
            else:
 
947
                # XXX: this case seems to be unreachable; token cannot be None.
2230
948
                self._leave_lock = False
2231
949
            self._lock_mode = 'w'
2232
950
            self._lock_count = 1
2234
952
            raise errors.ReadOnlyTransaction
2235
953
        else:
2236
954
            if token is not None:
2237
 
                # A token was given to lock_write, and we're relocking, so
2238
 
                # check that the given token actually matches the one we
2239
 
                # already have.
 
955
                # A token was given to lock_write, and we're relocking, so check
 
956
                # that the given token actually matches the one we already have.
2240
957
                if token != self._lock_token:
2241
958
                    raise errors.TokenMismatch(token, self._lock_token)
2242
959
            self._lock_count += 1
2243
 
            # Re-lock the repository too.
2244
 
            self.repository.lock_write(self._repo_lock_token)
2245
 
        return self._lock_token or None
 
960
        return self._lock_token
2246
961
 
2247
962
    def _unlock(self, branch_token, repo_token):
2248
 
        err_context = {'token': str((branch_token, repo_token))}
2249
 
        response = self._call(
2250
 
            'Branch.unlock', self._remote_path(), branch_token,
2251
 
            repo_token or '', **err_context)
 
963
        path = self.bzrdir._path_for_remote_call(self._client)
 
964
        response = self._client.call('Branch.unlock', path, branch_token,
 
965
                                     repo_token)
2252
966
        if response == ('ok',):
2253
967
            return
2254
 
        raise errors.UnexpectedSmartServerResponse(response)
 
968
        elif response[0] == 'TokenMismatch':
 
969
            raise errors.TokenMismatch(
 
970
                str((branch_token, repo_token)), '(remote tokens)')
 
971
        else:
 
972
            raise errors.UnexpectedSmartServerResponse(response)
2255
973
 
2256
974
    def unlock(self):
2257
 
        try:
2258
 
            self._lock_count -= 1
2259
 
            if not self._lock_count:
2260
 
                self._clear_cached_state()
2261
 
                mode = self._lock_mode
2262
 
                self._lock_mode = None
2263
 
                if self._real_branch is not None:
2264
 
                    if (not self._leave_lock and mode == 'w' and
2265
 
                        self._repo_lock_token):
2266
 
                        # If this RemoteBranch will remove the physical lock
2267
 
                        # for the repository, make sure the _real_branch
2268
 
                        # doesn't do it first.  (Because the _real_branch's
2269
 
                        # repository is set to be the RemoteRepository.)
2270
 
                        self._real_branch.repository.leave_lock_in_place()
2271
 
                    self._real_branch.unlock()
2272
 
                if mode != 'w':
2273
 
                    # Only write-locked branched need to make a remote method
2274
 
                    # call to perform the unlock.
2275
 
                    return
2276
 
                if not self._lock_token:
2277
 
                    raise AssertionError('Locked, but no token!')
2278
 
                branch_token = self._lock_token
2279
 
                repo_token = self._repo_lock_token
2280
 
                self._lock_token = None
2281
 
                self._repo_lock_token = None
 
975
        self._lock_count -= 1
 
976
        if not self._lock_count:
 
977
            self._clear_cached_state()
 
978
            mode = self._lock_mode
 
979
            self._lock_mode = None
 
980
            if self._real_branch is not None:
2282
981
                if not self._leave_lock:
2283
 
                    self._unlock(branch_token, repo_token)
2284
 
        finally:
2285
 
            self.repository.unlock()
 
982
                    # If this RemoteBranch will remove the physical lock for the
 
983
                    # repository, make sure the _real_branch doesn't do it
 
984
                    # first.  (Because the _real_branch's repository is set to
 
985
                    # be the RemoteRepository.)
 
986
                    self._real_branch.repository.leave_lock_in_place()
 
987
                self._real_branch.unlock()
 
988
            if mode != 'w':
 
989
                # Only write-locked branched need to make a remote method call
 
990
                # to perfom the unlock.
 
991
                return
 
992
            assert self._lock_token, 'Locked, but no token!'
 
993
            branch_token = self._lock_token
 
994
            repo_token = self._repo_lock_token
 
995
            self._lock_token = None
 
996
            self._repo_lock_token = None
 
997
            if not self._leave_lock:
 
998
                self._unlock(branch_token, repo_token)
2286
999
 
2287
1000
    def break_lock(self):
2288
1001
        self._ensure_real()
2289
1002
        return self._real_branch.break_lock()
2290
1003
 
2291
1004
    def leave_lock_in_place(self):
2292
 
        if not self._lock_token:
2293
 
            raise NotImplementedError(self.leave_lock_in_place)
2294
1005
        self._leave_lock = True
2295
1006
 
2296
1007
    def dont_leave_lock_in_place(self):
2297
 
        if not self._lock_token:
2298
 
            raise NotImplementedError(self.dont_leave_lock_in_place)
2299
1008
        self._leave_lock = False
2300
1009
 
2301
 
    def get_rev_id(self, revno, history=None):
2302
 
        if revno == 0:
2303
 
            return _mod_revision.NULL_REVISION
2304
 
        last_revision_info = self.last_revision_info()
2305
 
        ok, result = self.repository.get_rev_id_for_revno(
2306
 
            revno, last_revision_info)
2307
 
        if ok:
2308
 
            return result
2309
 
        missing_parent = result[1]
2310
 
        # Either the revision named by the server is missing, or its parent
2311
 
        # is.  Call get_parent_map to determine which, so that we report a
2312
 
        # useful error.
2313
 
        parent_map = self.repository.get_parent_map([missing_parent])
2314
 
        if missing_parent in parent_map:
2315
 
            missing_parent = parent_map[missing_parent]
2316
 
        raise errors.RevisionNotPresent(missing_parent, self.repository)
2317
 
 
2318
 
    def _last_revision_info(self):
2319
 
        response = self._call('Branch.last_revision_info', self._remote_path())
2320
 
        if response[0] != 'ok':
2321
 
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
1010
    def last_revision_info(self):
 
1011
        """See Branch.last_revision_info()."""
 
1012
        path = self.bzrdir._path_for_remote_call(self._client)
 
1013
        response = self._client.call('Branch.last_revision_info', path)
 
1014
        assert response[0] == 'ok', 'unexpected response code %s' % (response,)
2322
1015
        revno = int(response[1])
2323
1016
        last_revision = response[2]
2324
1017
        return (revno, last_revision)
2325
1018
 
2326
1019
    def _gen_revision_history(self):
2327
1020
        """See Branch._gen_revision_history()."""
2328
 
        if self._is_stacked:
2329
 
            self._ensure_real()
2330
 
            return self._real_branch._gen_revision_history()
2331
 
        response_tuple, response_handler = self._call_expecting_body(
2332
 
            'Branch.revision_history', self._remote_path())
2333
 
        if response_tuple[0] != 'ok':
2334
 
            raise errors.UnexpectedSmartServerResponse(response_tuple)
2335
 
        result = response_handler.read_body_bytes().split('\x00')
 
1021
        path = self.bzrdir._path_for_remote_call(self._client)
 
1022
        response = self._client.call_expecting_body(
 
1023
            'Branch.revision_history', path)
 
1024
        assert response[0][0] == 'ok', ('unexpected response code %s'
 
1025
                                        % (response[0],))
 
1026
        result = response[1].read_body_bytes().split('\x00')
2336
1027
        if result == ['']:
2337
1028
            return []
2338
1029
        return result
2339
1030
 
2340
 
    def _remote_path(self):
2341
 
        return self.bzrdir._path_for_remote_call(self._client)
2342
 
 
2343
 
    def _set_last_revision_descendant(self, revision_id, other_branch,
2344
 
            allow_diverged=False, allow_overwrite_descendant=False):
2345
 
        # This performs additional work to meet the hook contract; while its
2346
 
        # undesirable, we have to synthesise the revno to call the hook, and
2347
 
        # not calling the hook is worse as it means changes can't be prevented.
2348
 
        # Having calculated this though, we can't just call into
2349
 
        # set_last_revision_info as a simple call, because there is a set_rh
2350
 
        # hook that some folk may still be using.
2351
 
        old_revno, old_revid = self.last_revision_info()
2352
 
        history = self._lefthand_history(revision_id)
2353
 
        self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2354
 
        err_context = {'other_branch': other_branch}
2355
 
        response = self._call('Branch.set_last_revision_ex',
2356
 
            self._remote_path(), self._lock_token, self._repo_lock_token,
2357
 
            revision_id, int(allow_diverged), int(allow_overwrite_descendant),
2358
 
            **err_context)
2359
 
        self._clear_cached_state()
2360
 
        if len(response) != 3 and response[0] != 'ok':
2361
 
            raise errors.UnexpectedSmartServerResponse(response)
2362
 
        new_revno, new_revision_id = response[1:]
2363
 
        self._last_revision_info_cache = new_revno, new_revision_id
2364
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2365
 
        if self._real_branch is not None:
2366
 
            cache = new_revno, new_revision_id
2367
 
            self._real_branch._last_revision_info_cache = cache
2368
 
 
2369
 
    def _set_last_revision(self, revision_id):
2370
 
        old_revno, old_revid = self.last_revision_info()
2371
 
        # This performs additional work to meet the hook contract; while its
2372
 
        # undesirable, we have to synthesise the revno to call the hook, and
2373
 
        # not calling the hook is worse as it means changes can't be prevented.
2374
 
        # Having calculated this though, we can't just call into
2375
 
        # set_last_revision_info as a simple call, because there is a set_rh
2376
 
        # hook that some folk may still be using.
2377
 
        history = self._lefthand_history(revision_id)
2378
 
        self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2379
 
        self._clear_cached_state()
2380
 
        response = self._call('Branch.set_last_revision',
2381
 
            self._remote_path(), self._lock_token, self._repo_lock_token,
2382
 
            revision_id)
2383
 
        if response != ('ok',):
2384
 
            raise errors.UnexpectedSmartServerResponse(response)
2385
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2386
 
 
2387
1031
    @needs_write_lock
2388
1032
    def set_revision_history(self, rev_history):
2389
1033
        # Send just the tip revision of the history; the server will generate
2390
1034
        # the full history from that.  If the revision doesn't exist in this
2391
1035
        # branch, NoSuchRevision will be raised.
 
1036
        path = self.bzrdir._path_for_remote_call(self._client)
2392
1037
        if rev_history == []:
2393
1038
            rev_id = 'null:'
2394
1039
        else:
2395
1040
            rev_id = rev_history[-1]
2396
 
        self._set_last_revision(rev_id)
2397
 
        for hook in branch.Branch.hooks['set_rh']:
2398
 
            hook(self, rev_history)
 
1041
        self._clear_cached_state()
 
1042
        response = self._client.call('Branch.set_last_revision',
 
1043
            path, self._lock_token, self._repo_lock_token, rev_id)
 
1044
        if response[0] == 'NoSuchRevision':
 
1045
            raise NoSuchRevision(self, rev_id)
 
1046
        else:
 
1047
            assert response == ('ok',), (
 
1048
                'unexpected response code %r' % (response,))
2399
1049
        self._cache_revision_history(rev_history)
2400
1050
 
2401
 
    def _get_parent_location(self):
2402
 
        medium = self._client._medium
2403
 
        if medium._is_remote_before((1, 13)):
2404
 
            return self._vfs_get_parent_location()
2405
 
        try:
2406
 
            response = self._call('Branch.get_parent', self._remote_path())
2407
 
        except errors.UnknownSmartMethod:
2408
 
            medium._remember_remote_is_before((1, 13))
2409
 
            return self._vfs_get_parent_location()
2410
 
        if len(response) != 1:
2411
 
            raise errors.UnexpectedSmartServerResponse(response)
2412
 
        parent_location = response[0]
2413
 
        if parent_location == '':
2414
 
            return None
2415
 
        return parent_location
2416
 
 
2417
 
    def _vfs_get_parent_location(self):
2418
 
        self._ensure_real()
2419
 
        return self._real_branch._get_parent_location()
2420
 
 
2421
 
    def _set_parent_location(self, url):
2422
 
        medium = self._client._medium
2423
 
        if medium._is_remote_before((1, 15)):
2424
 
            return self._vfs_set_parent_location(url)
2425
 
        try:
2426
 
            call_url = url or ''
2427
 
            if type(call_url) is not str:
2428
 
                raise AssertionError('url must be a str or None (%s)' % url)
2429
 
            response = self._call('Branch.set_parent_location',
2430
 
                self._remote_path(), self._lock_token, self._repo_lock_token,
2431
 
                call_url)
2432
 
        except errors.UnknownSmartMethod:
2433
 
            medium._remember_remote_is_before((1, 15))
2434
 
            return self._vfs_set_parent_location(url)
2435
 
        if response != ():
2436
 
            raise errors.UnexpectedSmartServerResponse(response)
2437
 
 
2438
 
    def _vfs_set_parent_location(self, url):
2439
 
        self._ensure_real()
2440
 
        return self._real_branch._set_parent_location(url)
 
1051
    def get_parent(self):
 
1052
        self._ensure_real()
 
1053
        return self._real_branch.get_parent()
 
1054
        
 
1055
    def set_parent(self, url):
 
1056
        self._ensure_real()
 
1057
        return self._real_branch.set_parent(url)
 
1058
        
 
1059
    def get_config(self):
 
1060
        return RemoteBranchConfig(self)
 
1061
 
 
1062
    def sprout(self, to_bzrdir, revision_id=None):
 
1063
        # Like Branch.sprout, except that it sprouts a branch in the default
 
1064
        # format, because RemoteBranches can't be created at arbitrary URLs.
 
1065
        # XXX: if to_bzrdir is a RemoteBranch, this should perhaps do
 
1066
        # to_bzrdir.create_branch...
 
1067
        result = branch.BranchFormat.get_default_format().initialize(to_bzrdir)
 
1068
        self.copy_content_into(result, revision_id=revision_id)
 
1069
        result.set_parent(self.bzrdir.root_transport.base)
 
1070
        return result
 
1071
 
 
1072
    @needs_write_lock
 
1073
    def append_revision(self, *revision_ids):
 
1074
        self._ensure_real()
 
1075
        return self._real_branch.append_revision(*revision_ids)
2441
1076
 
2442
1077
    @needs_write_lock
2443
1078
    def pull(self, source, overwrite=False, stop_revision=None,
2444
1079
             **kwargs):
2445
 
        self._clear_cached_state_of_remote_branch_only()
 
1080
        # FIXME: This asks the real branch to run the hooks, which means
 
1081
        # they're called with the wrong target branch parameter. 
 
1082
        # The test suite specifically allows this at present but it should be
 
1083
        # fixed.  It should get a _override_hook_target branch,
 
1084
        # as push does.  -- mbp 20070405
2446
1085
        self._ensure_real()
2447
 
        return self._real_branch.pull(
 
1086
        self._real_branch.pull(
2448
1087
            source, overwrite=overwrite, stop_revision=stop_revision,
2449
 
            _override_hook_target=self, **kwargs)
 
1088
            **kwargs)
2450
1089
 
2451
1090
    @needs_read_lock
2452
1091
    def push(self, target, overwrite=False, stop_revision=None):
2458
1097
    def is_locked(self):
2459
1098
        return self._lock_count >= 1
2460
1099
 
2461
 
    @needs_read_lock
2462
 
    def revision_id_to_revno(self, revision_id):
2463
 
        self._ensure_real()
2464
 
        return self._real_branch.revision_id_to_revno(revision_id)
2465
 
 
2466
 
    @needs_write_lock
2467
1100
    def set_last_revision_info(self, revno, revision_id):
2468
 
        # XXX: These should be returned by the set_last_revision_info verb
2469
 
        old_revno, old_revid = self.last_revision_info()
2470
 
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2471
 
        revision_id = ensure_null(revision_id)
2472
 
        try:
2473
 
            response = self._call('Branch.set_last_revision_info',
2474
 
                self._remote_path(), self._lock_token, self._repo_lock_token,
2475
 
                str(revno), revision_id)
2476
 
        except errors.UnknownSmartMethod:
2477
 
            self._ensure_real()
2478
 
            self._clear_cached_state_of_remote_branch_only()
2479
 
            self._real_branch.set_last_revision_info(revno, revision_id)
2480
 
            self._last_revision_info_cache = revno, revision_id
2481
 
            return
2482
 
        if response == ('ok',):
2483
 
            self._clear_cached_state()
2484
 
            self._last_revision_info_cache = revno, revision_id
2485
 
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2486
 
            # Update the _real_branch's cache too.
2487
 
            if self._real_branch is not None:
2488
 
                cache = self._last_revision_info_cache
2489
 
                self._real_branch._last_revision_info_cache = cache
2490
 
        else:
2491
 
            raise errors.UnexpectedSmartServerResponse(response)
 
1101
        self._ensure_real()
 
1102
        self._clear_cached_state()
 
1103
        return self._real_branch.set_last_revision_info(revno, revision_id)
2492
1104
 
2493
 
    @needs_write_lock
2494
1105
    def generate_revision_history(self, revision_id, last_rev=None,
2495
1106
                                  other_branch=None):
2496
 
        medium = self._client._medium
2497
 
        if not medium._is_remote_before((1, 6)):
2498
 
            # Use a smart method for 1.6 and above servers
2499
 
            try:
2500
 
                self._set_last_revision_descendant(revision_id, other_branch,
2501
 
                    allow_diverged=True, allow_overwrite_descendant=True)
2502
 
                return
2503
 
            except errors.UnknownSmartMethod:
2504
 
                medium._remember_remote_is_before((1, 6))
2505
 
        self._clear_cached_state_of_remote_branch_only()
2506
 
        self.set_revision_history(self._lefthand_history(revision_id,
2507
 
            last_rev=last_rev,other_branch=other_branch))
 
1107
        self._ensure_real()
 
1108
        return self._real_branch.generate_revision_history(
 
1109
            revision_id, last_rev=last_rev, other_branch=other_branch)
 
1110
 
 
1111
    @property
 
1112
    def tags(self):
 
1113
        self._ensure_real()
 
1114
        return self._real_branch.tags
2508
1115
 
2509
1116
    def set_push_location(self, location):
2510
1117
        self._ensure_real()
2511
1118
        return self._real_branch.set_push_location(location)
2512
1119
 
2513
 
 
2514
 
class RemoteConfig(object):
2515
 
    """A Config that reads and writes from smart verbs.
2516
 
 
2517
 
    It is a low-level object that considers config data to be name/value pairs
2518
 
    that may be associated with a section. Assigning meaning to the these
2519
 
    values is done at higher levels like bzrlib.config.TreeConfig.
2520
 
    """
2521
 
 
2522
 
    def get_option(self, name, section=None, default=None):
2523
 
        """Return the value associated with a named option.
2524
 
 
2525
 
        :param name: The name of the value
2526
 
        :param section: The section the option is in (if any)
2527
 
        :param default: The value to return if the value is not set
2528
 
        :return: The value or default value
2529
 
        """
2530
 
        try:
2531
 
            configobj = self._get_configobj()
2532
 
            if section is None:
2533
 
                section_obj = configobj
2534
 
            else:
2535
 
                try:
2536
 
                    section_obj = configobj[section]
2537
 
                except KeyError:
2538
 
                    return default
2539
 
            return section_obj.get(name, default)
2540
 
        except errors.UnknownSmartMethod:
2541
 
            return self._vfs_get_option(name, section, default)
2542
 
 
2543
 
    def _response_to_configobj(self, response):
2544
 
        if len(response[0]) and response[0][0] != 'ok':
2545
 
            raise errors.UnexpectedSmartServerResponse(response)
2546
 
        lines = response[1].read_body_bytes().splitlines()
2547
 
        return config.ConfigObj(lines, encoding='utf-8')
2548
 
 
2549
 
 
2550
 
class RemoteBranchConfig(RemoteConfig):
2551
 
    """A RemoteConfig for Branches."""
2552
 
 
2553
 
    def __init__(self, branch):
2554
 
        self._branch = branch
2555
 
 
2556
 
    def _get_configobj(self):
2557
 
        path = self._branch._remote_path()
2558
 
        response = self._branch._client.call_expecting_body(
2559
 
            'Branch.get_config_file', path)
2560
 
        return self._response_to_configobj(response)
2561
 
 
2562
 
    def set_option(self, value, name, section=None):
2563
 
        """Set the value associated with a named option.
2564
 
 
2565
 
        :param value: The value to set
2566
 
        :param name: The name of the value to set
2567
 
        :param section: The section the option is in (if any)
2568
 
        """
2569
 
        medium = self._branch._client._medium
2570
 
        if medium._is_remote_before((1, 14)):
2571
 
            return self._vfs_set_option(value, name, section)
2572
 
        try:
2573
 
            path = self._branch._remote_path()
2574
 
            response = self._branch._client.call('Branch.set_config_option',
2575
 
                path, self._branch._lock_token, self._branch._repo_lock_token,
2576
 
                value.encode('utf8'), name, section or '')
2577
 
        except errors.UnknownSmartMethod:
2578
 
            medium._remember_remote_is_before((1, 14))
2579
 
            return self._vfs_set_option(value, name, section)
2580
 
        if response != ():
2581
 
            raise errors.UnexpectedSmartServerResponse(response)
2582
 
 
2583
 
    def _real_object(self):
2584
 
        self._branch._ensure_real()
2585
 
        return self._branch._real_branch
2586
 
 
2587
 
    def _vfs_set_option(self, value, name, section=None):
2588
 
        return self._real_object()._get_config().set_option(
2589
 
            value, name, section)
2590
 
 
2591
 
 
2592
 
class RemoteBzrDirConfig(RemoteConfig):
2593
 
    """A RemoteConfig for BzrDirs."""
2594
 
 
2595
 
    def __init__(self, bzrdir):
2596
 
        self._bzrdir = bzrdir
2597
 
 
2598
 
    def _get_configobj(self):
2599
 
        medium = self._bzrdir._client._medium
2600
 
        verb = 'BzrDir.get_config_file'
2601
 
        if medium._is_remote_before((1, 15)):
2602
 
            raise errors.UnknownSmartMethod(verb)
2603
 
        path = self._bzrdir._path_for_remote_call(self._bzrdir._client)
2604
 
        response = self._bzrdir._call_expecting_body(
2605
 
            verb, path)
2606
 
        return self._response_to_configobj(response)
2607
 
 
2608
 
    def _vfs_get_option(self, name, section, default):
2609
 
        return self._real_object()._get_config().get_option(
2610
 
            name, section, default)
2611
 
 
2612
 
    def set_option(self, value, name, section=None):
2613
 
        """Set the value associated with a named option.
2614
 
 
2615
 
        :param value: The value to set
2616
 
        :param name: The name of the value to set
2617
 
        :param section: The section the option is in (if any)
2618
 
        """
2619
 
        return self._real_object()._get_config().set_option(
2620
 
            value, name, section)
2621
 
 
2622
 
    def _real_object(self):
2623
 
        self._bzrdir._ensure_real()
2624
 
        return self._bzrdir._real_bzrdir
2625
 
 
 
1120
    def update_revisions(self, other, stop_revision=None):
 
1121
        self._ensure_real()
 
1122
        return self._real_branch.update_revisions(
 
1123
            other, stop_revision=stop_revision)
 
1124
 
 
1125
 
 
1126
class RemoteBranchConfig(BranchConfig):
 
1127
 
 
1128
    def username(self):
 
1129
        self.branch._ensure_real()
 
1130
        return self.branch._real_branch.get_config().username()
 
1131
 
 
1132
    def _get_branch_data_config(self):
 
1133
        self.branch._ensure_real()
 
1134
        if self._branch_data_config is None:
 
1135
            self._branch_data_config = TreeConfig(self.branch._real_branch)
 
1136
        return self._branch_data_config
2626
1137
 
2627
1138
 
2628
1139
def _extract_tar(tar, to_dir):
2632
1143
    """
2633
1144
    for tarinfo in tar:
2634
1145
        tar.extract(tarinfo, to_dir)
2635
 
 
2636
 
 
2637
 
def _translate_error(err, **context):
2638
 
    """Translate an ErrorFromSmartServer into a more useful error.
2639
 
 
2640
 
    Possible context keys:
2641
 
      - branch
2642
 
      - repository
2643
 
      - bzrdir
2644
 
      - token
2645
 
      - other_branch
2646
 
      - path
2647
 
 
2648
 
    If the error from the server doesn't match a known pattern, then
2649
 
    UnknownErrorFromSmartServer is raised.
2650
 
    """
2651
 
    def find(name):
2652
 
        try:
2653
 
            return context[name]
2654
 
        except KeyError, key_err:
2655
 
            mutter('Missing key %r in context %r', key_err.args[0], context)
2656
 
            raise err
2657
 
    def get_path():
2658
 
        """Get the path from the context if present, otherwise use first error
2659
 
        arg.
2660
 
        """
2661
 
        try:
2662
 
            return context['path']
2663
 
        except KeyError, key_err:
2664
 
            try:
2665
 
                return err.error_args[0]
2666
 
            except IndexError, idx_err:
2667
 
                mutter(
2668
 
                    'Missing key %r in context %r', key_err.args[0], context)
2669
 
                raise err
2670
 
 
2671
 
    if err.error_verb == 'NoSuchRevision':
2672
 
        raise NoSuchRevision(find('branch'), err.error_args[0])
2673
 
    elif err.error_verb == 'nosuchrevision':
2674
 
        raise NoSuchRevision(find('repository'), err.error_args[0])
2675
 
    elif err.error_tuple == ('nobranch',):
2676
 
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base)
2677
 
    elif err.error_verb == 'norepository':
2678
 
        raise errors.NoRepositoryPresent(find('bzrdir'))
2679
 
    elif err.error_verb == 'LockContention':
2680
 
        raise errors.LockContention('(remote lock)')
2681
 
    elif err.error_verb == 'UnlockableTransport':
2682
 
        raise errors.UnlockableTransport(find('bzrdir').root_transport)
2683
 
    elif err.error_verb == 'LockFailed':
2684
 
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
2685
 
    elif err.error_verb == 'TokenMismatch':
2686
 
        raise errors.TokenMismatch(find('token'), '(remote token)')
2687
 
    elif err.error_verb == 'Diverged':
2688
 
        raise errors.DivergedBranches(find('branch'), find('other_branch'))
2689
 
    elif err.error_verb == 'TipChangeRejected':
2690
 
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
2691
 
    elif err.error_verb == 'UnstackableBranchFormat':
2692
 
        raise errors.UnstackableBranchFormat(*err.error_args)
2693
 
    elif err.error_verb == 'UnstackableRepositoryFormat':
2694
 
        raise errors.UnstackableRepositoryFormat(*err.error_args)
2695
 
    elif err.error_verb == 'NotStacked':
2696
 
        raise errors.NotStacked(branch=find('branch'))
2697
 
    elif err.error_verb == 'PermissionDenied':
2698
 
        path = get_path()
2699
 
        if len(err.error_args) >= 2:
2700
 
            extra = err.error_args[1]
2701
 
        else:
2702
 
            extra = None
2703
 
        raise errors.PermissionDenied(path, extra=extra)
2704
 
    elif err.error_verb == 'ReadError':
2705
 
        path = get_path()
2706
 
        raise errors.ReadError(path)
2707
 
    elif err.error_verb == 'NoSuchFile':
2708
 
        path = get_path()
2709
 
        raise errors.NoSuchFile(path)
2710
 
    elif err.error_verb == 'FileExists':
2711
 
        raise errors.FileExists(err.error_args[0])
2712
 
    elif err.error_verb == 'DirectoryNotEmpty':
2713
 
        raise errors.DirectoryNotEmpty(err.error_args[0])
2714
 
    elif err.error_verb == 'ShortReadvError':
2715
 
        args = err.error_args
2716
 
        raise errors.ShortReadvError(
2717
 
            args[0], int(args[1]), int(args[2]), int(args[3]))
2718
 
    elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
2719
 
        encoding = str(err.error_args[0]) # encoding must always be a string
2720
 
        val = err.error_args[1]
2721
 
        start = int(err.error_args[2])
2722
 
        end = int(err.error_args[3])
2723
 
        reason = str(err.error_args[4]) # reason must always be a string
2724
 
        if val.startswith('u:'):
2725
 
            val = val[2:].decode('utf-8')
2726
 
        elif val.startswith('s:'):
2727
 
            val = val[2:].decode('base64')
2728
 
        if err.error_verb == 'UnicodeDecodeError':
2729
 
            raise UnicodeDecodeError(encoding, val, start, end, reason)
2730
 
        elif err.error_verb == 'UnicodeEncodeError':
2731
 
            raise UnicodeEncodeError(encoding, val, start, end, reason)
2732
 
    elif err.error_verb == 'ReadOnlyError':
2733
 
        raise errors.TransportNotPossible('readonly transport')
2734
 
    raise errors.UnknownErrorFromSmartServer(err)