/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/bzr/remote.py

  • Committer: Jelmer Vernooij
  • Date: 2019-09-21 19:49:11 UTC
  • mto: This revision was merged to the branch mainline in revision 7394.
  • Revision ID: jelmer@jelmer.uk-20190921194911-bxlcotmw2j003ex3
Port testr-run to Python3.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006-2012 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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
 
18
 
17
19
import bz2
 
20
import os
 
21
import re
 
22
import sys
 
23
import zlib
18
24
 
19
 
from bzrlib import (
 
25
from .. import (
20
26
    bencode,
21
27
    branch,
22
 
    bzrdir,
23
 
    config,
 
28
    bzr as _mod_bzr,
 
29
    config as _mod_config,
 
30
    controldir,
24
31
    debug,
25
32
    errors,
 
33
    gpg,
26
34
    graph,
27
35
    lock,
28
36
    lockdir,
29
 
    repository,
 
37
    osutils,
 
38
    registry,
30
39
    repository as _mod_repository,
31
 
    revision,
32
40
    revision as _mod_revision,
33
 
    static_tuple,
34
 
    symbol_versioning,
35
 
)
36
 
from bzrlib.branch import BranchReferenceFormat
37
 
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
38
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
39
 
from bzrlib.errors import (
 
41
    urlutils,
 
42
    )
 
43
from . import (
 
44
    branch as bzrbranch,
 
45
    bzrdir as _mod_bzrdir,
 
46
    inventory_delta,
 
47
    testament as _mod_testament,
 
48
    vf_repository,
 
49
    vf_search,
 
50
    )
 
51
from .branch import BranchReferenceFormat
 
52
from ..branch import BranchWriteLockResult
 
53
from ..decorators import only_raises
 
54
from ..errors import (
40
55
    NoSuchRevision,
41
56
    SmartProtocolError,
42
57
    )
43
 
from bzrlib.lockable_files import LockableFiles
44
 
from bzrlib.smart import client, vfs, repository as smart_repo
45
 
from bzrlib.revision import ensure_null, NULL_REVISION
46
 
from bzrlib.trace import mutter, note, warning
 
58
from ..i18n import gettext
 
59
from .inventory import Inventory
 
60
from .inventorytree import InventoryRevisionTree
 
61
from ..lockable_files import LockableFiles
 
62
from ..sixish import (
 
63
    get_unbound_function,
 
64
    map,
 
65
    text_type,
 
66
    viewitems,
 
67
    viewvalues,
 
68
    )
 
69
from .smart import client, vfs, repository as smart_repo
 
70
from .smart.client import _SmartClient
 
71
from ..revision import NULL_REVISION
 
72
from ..repository import RepositoryWriteLockResult, _LazyListJoin
 
73
from .serializer import format_registry as serializer_format_registry
 
74
from ..trace import mutter, note, warning, log_exception_quietly
 
75
from .versionedfile import FulltextContentFactory
 
76
 
 
77
 
 
78
_DEFAULT_SEARCH_DEPTH = 100
47
79
 
48
80
 
49
81
class _RpcHelper(object):
52
84
    def _call(self, method, *args, **err_context):
53
85
        try:
54
86
            return self._client.call(method, *args)
55
 
        except errors.ErrorFromSmartServer, err:
 
87
        except errors.ErrorFromSmartServer as err:
56
88
            self._translate_error(err, **err_context)
57
89
 
58
90
    def _call_expecting_body(self, method, *args, **err_context):
59
91
        try:
60
92
            return self._client.call_expecting_body(method, *args)
61
 
        except errors.ErrorFromSmartServer, err:
 
93
        except errors.ErrorFromSmartServer as err:
62
94
            self._translate_error(err, **err_context)
63
95
 
64
96
    def _call_with_body_bytes(self, method, args, body_bytes, **err_context):
65
97
        try:
66
98
            return self._client.call_with_body_bytes(method, args, body_bytes)
67
 
        except errors.ErrorFromSmartServer, err:
 
99
        except errors.ErrorFromSmartServer as err:
68
100
            self._translate_error(err, **err_context)
69
101
 
70
102
    def _call_with_body_bytes_expecting_body(self, method, args, body_bytes,
72
104
        try:
73
105
            return self._client.call_with_body_bytes_expecting_body(
74
106
                method, args, body_bytes)
75
 
        except errors.ErrorFromSmartServer, err:
 
107
        except errors.ErrorFromSmartServer as err:
76
108
            self._translate_error(err, **err_context)
77
109
 
78
110
 
79
111
def response_tuple_to_repo_format(response):
80
112
    """Convert a response tuple describing a repository format to a format."""
81
113
    format = RemoteRepositoryFormat()
82
 
    format._rich_root_data = (response[0] == 'yes')
83
 
    format._supports_tree_reference = (response[1] == 'yes')
84
 
    format._supports_external_lookups = (response[2] == 'yes')
 
114
    format._rich_root_data = (response[0] == b'yes')
 
115
    format._supports_tree_reference = (response[1] == b'yes')
 
116
    format._supports_external_lookups = (response[2] == b'yes')
85
117
    format._network_name = response[3]
86
118
    return format
87
119
 
88
120
 
89
 
# Note: RemoteBzrDirFormat is in bzrdir.py
90
 
 
91
 
class RemoteBzrDir(BzrDir, _RpcHelper):
 
121
# Note that RemoteBzrDirProber lives in breezy.bzrdir so breezy.bzr.remote
 
122
# does not have to be imported unless a remote format is involved.
 
123
 
 
124
class RemoteBzrDirFormat(_mod_bzrdir.BzrDirMetaFormat1):
 
125
    """Format representing bzrdirs accessed via a smart server"""
 
126
 
 
127
    supports_workingtrees = False
 
128
 
 
129
    colocated_branches = False
 
130
 
 
131
    def __init__(self):
 
132
        _mod_bzrdir.BzrDirMetaFormat1.__init__(self)
 
133
        # XXX: It's a bit ugly that the network name is here, because we'd
 
134
        # like to believe that format objects are stateless or at least
 
135
        # immutable,  However, we do at least avoid mutating the name after
 
136
        # it's returned.  See <https://bugs.launchpad.net/bzr/+bug/504102>
 
137
        self._network_name = None
 
138
 
 
139
    def __repr__(self):
 
140
        return "%s(_network_name=%r)" % (self.__class__.__name__,
 
141
                                         self._network_name)
 
142
 
 
143
    def get_format_description(self):
 
144
        if self._network_name:
 
145
            try:
 
146
                real_format = controldir.network_format_registry.get(
 
147
                    self._network_name)
 
148
            except KeyError:
 
149
                pass
 
150
            else:
 
151
                return 'Remote: ' + real_format.get_format_description()
 
152
        return 'bzr remote bzrdir'
 
153
 
 
154
    def get_format_string(self):
 
155
        raise NotImplementedError(self.get_format_string)
 
156
 
 
157
    def network_name(self):
 
158
        if self._network_name:
 
159
            return self._network_name
 
160
        else:
 
161
            raise AssertionError("No network name set.")
 
162
 
 
163
    def initialize_on_transport(self, transport):
 
164
        try:
 
165
            # hand off the request to the smart server
 
166
            client_medium = transport.get_smart_medium()
 
167
        except errors.NoSmartMedium:
 
168
            # TODO: lookup the local format from a server hint.
 
169
            local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
 
170
            return local_dir_format.initialize_on_transport(transport)
 
171
        client = _SmartClient(client_medium)
 
172
        path = client.remote_path_from_transport(transport)
 
173
        try:
 
174
            response = client.call(b'BzrDirFormat.initialize', path)
 
175
        except errors.ErrorFromSmartServer as err:
 
176
            _translate_error(err, path=path)
 
177
        if response[0] != b'ok':
 
178
            raise errors.SmartProtocolError(
 
179
                'unexpected response code %s' % (response,))
 
180
        format = RemoteBzrDirFormat()
 
181
        self._supply_sub_formats_to(format)
 
182
        return RemoteBzrDir(transport, format)
 
183
 
 
184
    def parse_NoneTrueFalse(self, arg):
 
185
        if not arg:
 
186
            return None
 
187
        if arg == b'False':
 
188
            return False
 
189
        if arg == b'True':
 
190
            return True
 
191
        raise AssertionError("invalid arg %r" % arg)
 
192
 
 
193
    def _serialize_NoneTrueFalse(self, arg):
 
194
        if arg is False:
 
195
            return b'False'
 
196
        if arg:
 
197
            return b'True'
 
198
        return b''
 
199
 
 
200
    def _serialize_NoneString(self, arg):
 
201
        return arg or b''
 
202
 
 
203
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
 
204
                                   create_prefix=False, force_new_repo=False, stacked_on=None,
 
205
                                   stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
 
206
                                   shared_repo=False):
 
207
        try:
 
208
            # hand off the request to the smart server
 
209
            client_medium = transport.get_smart_medium()
 
210
        except errors.NoSmartMedium:
 
211
            do_vfs = True
 
212
        else:
 
213
            # Decline to open it if the server doesn't support our required
 
214
            # version (3) so that the VFS-based transport will do it.
 
215
            if client_medium.should_probe():
 
216
                try:
 
217
                    server_version = client_medium.protocol_version()
 
218
                    if server_version != '2':
 
219
                        do_vfs = True
 
220
                    else:
 
221
                        do_vfs = False
 
222
                except errors.SmartProtocolError:
 
223
                    # Apparently there's no usable smart server there, even though
 
224
                    # the medium supports the smart protocol.
 
225
                    do_vfs = True
 
226
            else:
 
227
                do_vfs = False
 
228
        if not do_vfs:
 
229
            client = _SmartClient(client_medium)
 
230
            path = client.remote_path_from_transport(transport)
 
231
            if client_medium._is_remote_before((1, 16)):
 
232
                do_vfs = True
 
233
        if do_vfs:
 
234
            # TODO: lookup the local format from a server hint.
 
235
            local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
 
236
            self._supply_sub_formats_to(local_dir_format)
 
237
            return local_dir_format.initialize_on_transport_ex(transport,
 
238
                                                               use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
239
                                                               force_new_repo=force_new_repo, stacked_on=stacked_on,
 
240
                                                               stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
241
                                                               make_working_trees=make_working_trees, shared_repo=shared_repo,
 
242
                                                               vfs_only=True)
 
243
        return self._initialize_on_transport_ex_rpc(client, path, transport,
 
244
                                                    use_existing_dir, create_prefix, force_new_repo, stacked_on,
 
245
                                                    stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
 
246
 
 
247
    def _initialize_on_transport_ex_rpc(self, client, path, transport,
 
248
                                        use_existing_dir, create_prefix, force_new_repo, stacked_on,
 
249
                                        stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
 
250
        args = []
 
251
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
 
252
        args.append(self._serialize_NoneTrueFalse(create_prefix))
 
253
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
 
254
        args.append(self._serialize_NoneString(stacked_on))
 
255
        # stack_on_pwd is often/usually our transport
 
256
        if stack_on_pwd:
 
257
            try:
 
258
                stack_on_pwd = transport.relpath(stack_on_pwd).encode('utf-8')
 
259
                if not stack_on_pwd:
 
260
                    stack_on_pwd = b'.'
 
261
            except errors.PathNotChild:
 
262
                pass
 
263
        args.append(self._serialize_NoneString(stack_on_pwd))
 
264
        args.append(self._serialize_NoneString(repo_format_name))
 
265
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
 
266
        args.append(self._serialize_NoneTrueFalse(shared_repo))
 
267
        request_network_name = self._network_name or \
 
268
            _mod_bzrdir.BzrDirFormat.get_default_format().network_name()
 
269
        try:
 
270
            response = client.call(b'BzrDirFormat.initialize_ex_1.16',
 
271
                                   request_network_name, path, *args)
 
272
        except errors.UnknownSmartMethod:
 
273
            client._medium._remember_remote_is_before((1, 16))
 
274
            local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
 
275
            self._supply_sub_formats_to(local_dir_format)
 
276
            return local_dir_format.initialize_on_transport_ex(transport,
 
277
                                                               use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
278
                                                               force_new_repo=force_new_repo, stacked_on=stacked_on,
 
279
                                                               stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
280
                                                               make_working_trees=make_working_trees, shared_repo=shared_repo,
 
281
                                                               vfs_only=True)
 
282
        except errors.ErrorFromSmartServer as err:
 
283
            _translate_error(err, path=path.decode('utf-8'))
 
284
        repo_path = response[0]
 
285
        bzrdir_name = response[6]
 
286
        require_stacking = response[7]
 
287
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
 
288
        format = RemoteBzrDirFormat()
 
289
        format._network_name = bzrdir_name
 
290
        self._supply_sub_formats_to(format)
 
291
        bzrdir = RemoteBzrDir(transport, format, _client=client)
 
292
        if repo_path:
 
293
            repo_format = response_tuple_to_repo_format(response[1:])
 
294
            if repo_path == b'.':
 
295
                repo_path = b''
 
296
            repo_path = repo_path.decode('utf-8')
 
297
            if repo_path:
 
298
                repo_bzrdir_format = RemoteBzrDirFormat()
 
299
                repo_bzrdir_format._network_name = response[5]
 
300
                repo_bzr = RemoteBzrDir(transport.clone(repo_path),
 
301
                                        repo_bzrdir_format)
 
302
            else:
 
303
                repo_bzr = bzrdir
 
304
            final_stack = response[8] or None
 
305
            if final_stack:
 
306
                final_stack = final_stack.decode('utf-8')
 
307
            final_stack_pwd = response[9] or None
 
308
            if final_stack_pwd:
 
309
                final_stack_pwd = urlutils.join(
 
310
                    transport.base, final_stack_pwd.decode('utf-8'))
 
311
            remote_repo = RemoteRepository(repo_bzr, repo_format)
 
312
            if len(response) > 10:
 
313
                # Updated server verb that locks remotely.
 
314
                repo_lock_token = response[10] or None
 
315
                remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
 
316
                if repo_lock_token:
 
317
                    remote_repo.dont_leave_lock_in_place()
 
318
            else:
 
319
                remote_repo.lock_write()
 
320
            policy = _mod_bzrdir.UseExistingRepository(remote_repo,
 
321
                                                       final_stack, final_stack_pwd, require_stacking)
 
322
            policy.acquire_repository()
 
323
        else:
 
324
            remote_repo = None
 
325
            policy = None
 
326
        bzrdir._format.set_branch_format(self.get_branch_format())
 
327
        if require_stacking:
 
328
            # The repo has already been created, but we need to make sure that
 
329
            # we'll make a stackable branch.
 
330
            bzrdir._format.require_stacking(_skip_repo=True)
 
331
        return remote_repo, bzrdir, require_stacking, policy
 
332
 
 
333
    def _open(self, transport):
 
334
        return RemoteBzrDir(transport, self)
 
335
 
 
336
    def __eq__(self, other):
 
337
        if not isinstance(other, RemoteBzrDirFormat):
 
338
            return False
 
339
        return self.get_format_description() == other.get_format_description()
 
340
 
 
341
    def __return_repository_format(self):
 
342
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
 
343
        # repository format has been asked for, tell the RemoteRepositoryFormat
 
344
        # that it should use that for init() etc.
 
345
        result = RemoteRepositoryFormat()
 
346
        custom_format = getattr(self, '_repository_format', None)
 
347
        if custom_format:
 
348
            if isinstance(custom_format, RemoteRepositoryFormat):
 
349
                return custom_format
 
350
            else:
 
351
                # We will use the custom format to create repositories over the
 
352
                # wire; expose its details like rich_root_data for code to
 
353
                # query
 
354
                result._custom_format = custom_format
 
355
        return result
 
356
 
 
357
    def get_branch_format(self):
 
358
        result = _mod_bzrdir.BzrDirMetaFormat1.get_branch_format(self)
 
359
        if not isinstance(result, RemoteBranchFormat):
 
360
            new_result = RemoteBranchFormat()
 
361
            new_result._custom_format = result
 
362
            # cache the result
 
363
            self.set_branch_format(new_result)
 
364
            result = new_result
 
365
        return result
 
366
 
 
367
    repository_format = property(__return_repository_format,
 
368
                                 _mod_bzrdir.BzrDirMetaFormat1._set_repository_format)  # .im_func)
 
369
 
 
370
 
 
371
class RemoteControlStore(_mod_config.IniFileStore):
 
372
    """Control store which attempts to use HPSS calls to retrieve control store.
 
373
 
 
374
    Note that this is specific to bzr-based formats.
 
375
    """
 
376
 
 
377
    def __init__(self, bzrdir):
 
378
        super(RemoteControlStore, self).__init__()
 
379
        self.controldir = bzrdir
 
380
        self._real_store = None
 
381
 
 
382
    def lock_write(self, token=None):
 
383
        self._ensure_real()
 
384
        return self._real_store.lock_write(token)
 
385
 
 
386
    def unlock(self):
 
387
        self._ensure_real()
 
388
        return self._real_store.unlock()
 
389
 
 
390
    def save(self):
 
391
        with self.lock_write():
 
392
            # We need to be able to override the undecorated implementation
 
393
            self.save_without_locking()
 
394
 
 
395
    def save_without_locking(self):
 
396
        super(RemoteControlStore, self).save()
 
397
 
 
398
    def _ensure_real(self):
 
399
        self.controldir._ensure_real()
 
400
        if self._real_store is None:
 
401
            self._real_store = _mod_config.ControlStore(self.controldir)
 
402
 
 
403
    def external_url(self):
 
404
        return urlutils.join(self.branch.user_url, 'control.conf')
 
405
 
 
406
    def _load_content(self):
 
407
        medium = self.controldir._client._medium
 
408
        path = self.controldir._path_for_remote_call(self.controldir._client)
 
409
        try:
 
410
            response, handler = self.controldir._call_expecting_body(
 
411
                b'BzrDir.get_config_file', path)
 
412
        except errors.UnknownSmartMethod:
 
413
            self._ensure_real()
 
414
            return self._real_store._load_content()
 
415
        if len(response) and response[0] != b'ok':
 
416
            raise errors.UnexpectedSmartServerResponse(response)
 
417
        return handler.read_body_bytes()
 
418
 
 
419
    def _save_content(self, content):
 
420
        # FIXME JRV 2011-11-22: Ideally this should use a
 
421
        # HPSS call too, but at the moment it is not possible
 
422
        # to write lock control directories.
 
423
        self._ensure_real()
 
424
        return self._real_store._save_content(content)
 
425
 
 
426
 
 
427
class RemoteBzrDir(_mod_bzrdir.BzrDir, _RpcHelper):
92
428
    """Control directory on a remote server, accessed via bzr:// or similar."""
93
429
 
94
430
    def __init__(self, transport, format, _client=None, _force_probe=False):
97
433
        :param _client: Private parameter for testing. Disables probing and the
98
434
            use of a real bzrdir.
99
435
        """
100
 
        BzrDir.__init__(self, transport, format)
 
436
        _mod_bzrdir.BzrDir.__init__(self, transport, format)
101
437
        # this object holds a delegated bzrdir that uses file-level operations
102
438
        # to talk to the other side
103
439
        self._real_bzrdir = None
133
469
            self._rpc_open(path)
134
470
 
135
471
    def _rpc_open_2_1(self, path):
136
 
        response = self._call('BzrDir.open_2.1', path)
137
 
        if response == ('no',):
 
472
        response = self._call(b'BzrDir.open_2.1', path)
 
473
        if response == (b'no',):
138
474
            raise errors.NotBranchError(path=self.root_transport.base)
139
 
        elif response[0] == 'yes':
140
 
            if response[1] == 'yes':
 
475
        elif response[0] == b'yes':
 
476
            if response[1] == b'yes':
141
477
                self._has_working_tree = True
142
 
            elif response[1] == 'no':
 
478
            elif response[1] == b'no':
143
479
                self._has_working_tree = False
144
480
            else:
145
481
                raise errors.UnexpectedSmartServerResponse(response)
147
483
            raise errors.UnexpectedSmartServerResponse(response)
148
484
 
149
485
    def _rpc_open(self, path):
150
 
        response = self._call('BzrDir.open', path)
151
 
        if response not in [('yes',), ('no',)]:
 
486
        response = self._call(b'BzrDir.open', path)
 
487
        if response not in [(b'yes',), (b'no',)]:
152
488
            raise errors.UnexpectedSmartServerResponse(response)
153
 
        if response == ('no',):
 
489
        if response == (b'no',):
154
490
            raise errors.NotBranchError(path=self.root_transport.base)
155
491
 
156
492
    def _ensure_real(self):
162
498
            if 'hpssvfs' in debug.debug_flags:
163
499
                import traceback
164
500
                warning('VFS BzrDir access triggered\n%s',
165
 
                    ''.join(traceback.format_stack()))
166
 
            self._real_bzrdir = BzrDir.open_from_transport(
167
 
                self.root_transport, _server_formats=False)
 
501
                        ''.join(traceback.format_stack()))
 
502
            self._real_bzrdir = _mod_bzrdir.BzrDir.open_from_transport(
 
503
                self.root_transport, probers=[_mod_bzr.BzrProber])
168
504
            self._format._network_name = \
169
505
                self._real_bzrdir._format.network_name()
170
506
 
175
511
        # Prevent aliasing problems in the next_open_branch_result cache.
176
512
        # See create_branch for rationale.
177
513
        self._next_open_branch_result = None
178
 
        return BzrDir.break_lock(self)
 
514
        return _mod_bzrdir.BzrDir.break_lock(self)
 
515
 
 
516
    def _vfs_checkout_metadir(self):
 
517
        self._ensure_real()
 
518
        return self._real_bzrdir.checkout_metadir()
 
519
 
 
520
    def checkout_metadir(self):
 
521
        """Retrieve the controldir format to use for checkouts of this one.
 
522
        """
 
523
        medium = self._client._medium
 
524
        if medium._is_remote_before((2, 5)):
 
525
            return self._vfs_checkout_metadir()
 
526
        path = self._path_for_remote_call(self._client)
 
527
        try:
 
528
            response = self._client.call(b'BzrDir.checkout_metadir',
 
529
                                         path)
 
530
        except errors.UnknownSmartMethod:
 
531
            medium._remember_remote_is_before((2, 5))
 
532
            return self._vfs_checkout_metadir()
 
533
        if len(response) != 3:
 
534
            raise errors.UnexpectedSmartServerResponse(response)
 
535
        control_name, repo_name, branch_name = response
 
536
        try:
 
537
            format = controldir.network_format_registry.get(control_name)
 
538
        except KeyError:
 
539
            raise errors.UnknownFormatError(kind='control',
 
540
                                            format=control_name)
 
541
        if repo_name:
 
542
            try:
 
543
                repo_format = _mod_repository.network_format_registry.get(
 
544
                    repo_name)
 
545
            except KeyError:
 
546
                raise errors.UnknownFormatError(kind='repository',
 
547
                                                format=repo_name)
 
548
            format.repository_format = repo_format
 
549
        if branch_name:
 
550
            try:
 
551
                format.set_branch_format(
 
552
                    branch.network_format_registry.get(branch_name))
 
553
            except KeyError:
 
554
                raise errors.UnknownFormatError(kind='branch',
 
555
                                                format=branch_name)
 
556
        return format
179
557
 
180
558
    def _vfs_cloning_metadir(self, require_stacking=False):
181
559
        self._ensure_real()
186
564
        medium = self._client._medium
187
565
        if medium._is_remote_before((1, 13)):
188
566
            return self._vfs_cloning_metadir(require_stacking=require_stacking)
189
 
        verb = 'BzrDir.cloning_metadir'
 
567
        verb = b'BzrDir.cloning_metadir'
190
568
        if require_stacking:
191
 
            stacking = 'True'
 
569
            stacking = b'True'
192
570
        else:
193
 
            stacking = 'False'
 
571
            stacking = b'False'
194
572
        path = self._path_for_remote_call(self._client)
195
573
        try:
196
574
            response = self._call(verb, path, stacking)
197
575
        except errors.UnknownSmartMethod:
198
576
            medium._remember_remote_is_before((1, 13))
199
577
            return self._vfs_cloning_metadir(require_stacking=require_stacking)
200
 
        except errors.UnknownErrorFromSmartServer, err:
201
 
            if err.error_tuple != ('BranchReference',):
 
578
        except errors.UnknownErrorFromSmartServer as err:
 
579
            if err.error_tuple != (b'BranchReference',):
202
580
                raise
203
581
            # We need to resolve the branch reference to determine the
204
582
            # cloning_metadir.  This causes unnecessary RPCs to open the
205
583
            # referenced branch (and bzrdir, etc) but only when the caller
206
584
            # didn't already resolve the branch reference.
207
585
            referenced_branch = self.open_branch()
208
 
            return referenced_branch.bzrdir.cloning_metadir()
 
586
            return referenced_branch.controldir.cloning_metadir()
209
587
        if len(response) != 3:
210
588
            raise errors.UnexpectedSmartServerResponse(response)
211
589
        control_name, repo_name, branch_info = response
212
590
        if len(branch_info) != 2:
213
591
            raise errors.UnexpectedSmartServerResponse(response)
214
592
        branch_ref, branch_name = branch_info
215
 
        format = bzrdir.network_format_registry.get(control_name)
 
593
        try:
 
594
            format = controldir.network_format_registry.get(control_name)
 
595
        except KeyError:
 
596
            raise errors.UnknownFormatError(
 
597
                kind='control', format=control_name)
 
598
 
216
599
        if repo_name:
217
 
            format.repository_format = repository.network_format_registry.get(
218
 
                repo_name)
219
 
        if branch_ref == 'ref':
 
600
            try:
 
601
                format.repository_format = _mod_repository.network_format_registry.get(
 
602
                    repo_name)
 
603
            except KeyError:
 
604
                raise errors.UnknownFormatError(kind='repository',
 
605
                                                format=repo_name)
 
606
        if branch_ref == b'ref':
220
607
            # XXX: we need possible_transports here to avoid reopening the
221
608
            # connection to the referenced location
222
 
            ref_bzrdir = BzrDir.open(branch_name)
 
609
            ref_bzrdir = _mod_bzrdir.BzrDir.open(branch_name)
223
610
            branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
224
611
            format.set_branch_format(branch_format)
225
 
        elif branch_ref == 'branch':
 
612
        elif branch_ref == b'branch':
226
613
            if branch_name:
227
 
                format.set_branch_format(
228
 
                    branch.network_format_registry.get(branch_name))
 
614
                try:
 
615
                    branch_format = branch.network_format_registry.get(
 
616
                        branch_name)
 
617
                except KeyError:
 
618
                    raise errors.UnknownFormatError(kind='branch',
 
619
                                                    format=branch_name)
 
620
                format.set_branch_format(branch_format)
229
621
        else:
230
622
            raise errors.UnexpectedSmartServerResponse(response)
231
623
        return format
241
633
 
242
634
    def destroy_repository(self):
243
635
        """See BzrDir.destroy_repository"""
244
 
        self._ensure_real()
245
 
        self._real_bzrdir.destroy_repository()
 
636
        path = self._path_for_remote_call(self._client)
 
637
        try:
 
638
            response = self._call(b'BzrDir.destroy_repository', path)
 
639
        except errors.UnknownSmartMethod:
 
640
            self._ensure_real()
 
641
            self._real_bzrdir.destroy_repository()
 
642
            return
 
643
        if response[0] != b'ok':
 
644
            raise SmartProtocolError(
 
645
                'unexpected response code %s' % (response,))
246
646
 
247
 
    def create_branch(self, name=None):
 
647
    def create_branch(self, name=None, repository=None,
 
648
                      append_revisions_only=None):
 
649
        if name is None:
 
650
            name = self._get_selected_branch()
 
651
        if name != "":
 
652
            raise errors.NoColocatedBranchSupport(self)
248
653
        # as per meta1 formats - just delegate to the format object which may
249
654
        # be parameterised.
250
655
        real_branch = self._format.get_branch_format().initialize(self,
251
 
            name=name)
 
656
                                                                  name=name, repository=repository,
 
657
                                                                  append_revisions_only=append_revisions_only)
252
658
        if not isinstance(real_branch, RemoteBranch):
253
 
            result = RemoteBranch(self, self.find_repository(), real_branch,
254
 
                                  name=name)
 
659
            if not isinstance(repository, RemoteRepository):
 
660
                raise AssertionError(
 
661
                    'need a RemoteRepository to use with RemoteBranch, got %r'
 
662
                    % (repository,))
 
663
            result = RemoteBranch(self, repository, real_branch, name=name)
255
664
        else:
256
665
            result = real_branch
257
666
        # BzrDir.clone_on_transport() uses the result of create_branch but does
265
674
 
266
675
    def destroy_branch(self, name=None):
267
676
        """See BzrDir.destroy_branch"""
268
 
        self._ensure_real()
269
 
        self._real_bzrdir.destroy_branch(name=name)
 
677
        if name is None:
 
678
            name = self._get_selected_branch()
 
679
        if name != "":
 
680
            raise errors.NoColocatedBranchSupport(self)
 
681
        path = self._path_for_remote_call(self._client)
 
682
        try:
 
683
            if name != "":
 
684
                args = (name, )
 
685
            else:
 
686
                args = ()
 
687
            response = self._call(b'BzrDir.destroy_branch', path, *args)
 
688
        except errors.UnknownSmartMethod:
 
689
            self._ensure_real()
 
690
            self._real_bzrdir.destroy_branch(name=name)
 
691
            self._next_open_branch_result = None
 
692
            return
270
693
        self._next_open_branch_result = None
 
694
        if response[0] != b'ok':
 
695
            raise SmartProtocolError(
 
696
                'unexpected response code %s' % (response,))
271
697
 
272
 
    def create_workingtree(self, revision_id=None, from_branch=None):
 
698
    def create_workingtree(self, revision_id=None, from_branch=None,
 
699
                           accelerator_tree=None, hardlink=False):
273
700
        raise errors.NotLocalUrl(self.transport.base)
274
701
 
275
 
    def find_branch_format(self):
 
702
    def find_branch_format(self, name=None):
276
703
        """Find the branch 'format' for this bzrdir.
277
704
 
278
705
        This might be a synthetic object for e.g. RemoteBranch and SVN.
279
706
        """
280
 
        b = self.open_branch()
 
707
        b = self.open_branch(name=name)
281
708
        return b._format
282
709
 
283
 
    def get_branch_reference(self):
 
710
    def get_branches(self, possible_transports=None, ignore_fallbacks=False):
 
711
        path = self._path_for_remote_call(self._client)
 
712
        try:
 
713
            response, handler = self._call_expecting_body(
 
714
                b'BzrDir.get_branches', path)
 
715
        except errors.UnknownSmartMethod:
 
716
            self._ensure_real()
 
717
            return self._real_bzrdir.get_branches()
 
718
        if response[0] != b"success":
 
719
            raise errors.UnexpectedSmartServerResponse(response)
 
720
        body = bencode.bdecode(handler.read_body_bytes())
 
721
        ret = {}
 
722
        for name, value in viewitems(body):
 
723
            name = name.decode('utf-8')
 
724
            ret[name] = self._open_branch(name, value[0], value[1],
 
725
                                          possible_transports=possible_transports,
 
726
                                          ignore_fallbacks=ignore_fallbacks)
 
727
        return ret
 
728
 
 
729
    def set_branch_reference(self, target_branch, name=None):
 
730
        """See BzrDir.set_branch_reference()."""
 
731
        if name is None:
 
732
            name = self._get_selected_branch()
 
733
        if name != "":
 
734
            raise errors.NoColocatedBranchSupport(self)
 
735
        self._ensure_real()
 
736
        return self._real_bzrdir.set_branch_reference(target_branch, name=name)
 
737
 
 
738
    def get_branch_reference(self, name=None):
284
739
        """See BzrDir.get_branch_reference()."""
 
740
        if name is None:
 
741
            name = self._get_selected_branch()
 
742
        if name != "":
 
743
            raise errors.NoColocatedBranchSupport(self)
285
744
        response = self._get_branch_reference()
286
745
        if response[0] == 'ref':
287
 
            return response[1]
 
746
            return response[1].decode('utf-8')
288
747
        else:
289
748
            return None
290
749
 
291
750
    def _get_branch_reference(self):
 
751
        """Get branch reference information
 
752
 
 
753
        :return: Tuple with (kind, location_or_format)
 
754
            if kind == 'ref', then location_or_format contains a location
 
755
            otherwise, it contains a format name
 
756
        """
292
757
        path = self._path_for_remote_call(self._client)
293
758
        medium = self._client._medium
294
759
        candidate_calls = [
295
 
            ('BzrDir.open_branchV3', (2, 1)),
296
 
            ('BzrDir.open_branchV2', (1, 13)),
297
 
            ('BzrDir.open_branch', None),
 
760
            (b'BzrDir.open_branchV3', (2, 1)),
 
761
            (b'BzrDir.open_branchV2', (1, 13)),
 
762
            (b'BzrDir.open_branch', None),
298
763
            ]
299
764
        for verb, required_version in candidate_calls:
300
765
            if required_version and medium._is_remote_before(required_version):
307
772
                medium._remember_remote_is_before(required_version)
308
773
            else:
309
774
                break
310
 
        if verb == 'BzrDir.open_branch':
311
 
            if response[0] != 'ok':
 
775
        if verb == b'BzrDir.open_branch':
 
776
            if response[0] != b'ok':
312
777
                raise errors.UnexpectedSmartServerResponse(response)
313
 
            if response[1] != '':
 
778
            if response[1] != b'':
314
779
                return ('ref', response[1])
315
780
            else:
316
 
                return ('branch', '')
317
 
        if response[0] not in ('ref', 'branch'):
 
781
                return ('branch', b'')
 
782
        if response[0] not in (b'ref', b'branch'):
318
783
            raise errors.UnexpectedSmartServerResponse(response)
319
 
        return response
 
784
        return (response[0].decode('ascii'), response[1])
320
785
 
321
 
    def _get_tree_branch(self):
 
786
    def _get_tree_branch(self, name=None):
322
787
        """See BzrDir._get_tree_branch()."""
323
 
        return None, self.open_branch()
 
788
        return None, self.open_branch(name=name)
324
789
 
325
 
    def open_branch(self, name=None, unsupported=False,
326
 
                    ignore_fallbacks=False):
327
 
        if unsupported:
328
 
            raise NotImplementedError('unsupported flag support not implemented yet.')
329
 
        if self._next_open_branch_result is not None:
330
 
            # See create_branch for details.
331
 
            result = self._next_open_branch_result
332
 
            self._next_open_branch_result = None
333
 
            return result
334
 
        response = self._get_branch_reference()
335
 
        if response[0] == 'ref':
 
790
    def _open_branch(self, name, kind, location_or_format,
 
791
                     ignore_fallbacks=False, possible_transports=None):
 
792
        if kind == 'ref':
336
793
            # a branch reference, use the existing BranchReference logic.
337
794
            format = BranchReferenceFormat()
338
795
            return format.open(self, name=name, _found=True,
339
 
                location=response[1], ignore_fallbacks=ignore_fallbacks)
340
 
        branch_format_name = response[1]
 
796
                               location=location_or_format.decode('utf-8'),
 
797
                               ignore_fallbacks=ignore_fallbacks,
 
798
                               possible_transports=possible_transports)
 
799
        branch_format_name = location_or_format
341
800
        if not branch_format_name:
342
801
            branch_format_name = None
343
802
        format = RemoteBranchFormat(network_name=branch_format_name)
344
803
        return RemoteBranch(self, self.find_repository(), format=format,
345
 
            setup_stacking=not ignore_fallbacks, name=name)
 
804
                            setup_stacking=not ignore_fallbacks, name=name,
 
805
                            possible_transports=possible_transports)
 
806
 
 
807
    def open_branch(self, name=None, unsupported=False,
 
808
                    ignore_fallbacks=False, possible_transports=None):
 
809
        if name is None:
 
810
            name = self._get_selected_branch()
 
811
        if name != "":
 
812
            raise errors.NoColocatedBranchSupport(self)
 
813
        if unsupported:
 
814
            raise NotImplementedError(
 
815
                'unsupported flag support not implemented yet.')
 
816
        if self._next_open_branch_result is not None:
 
817
            # See create_branch for details.
 
818
            result = self._next_open_branch_result
 
819
            self._next_open_branch_result = None
 
820
            return result
 
821
        response = self._get_branch_reference()
 
822
        return self._open_branch(name, response[0], response[1],
 
823
                                 possible_transports=possible_transports,
 
824
                                 ignore_fallbacks=ignore_fallbacks)
346
825
 
347
826
    def _open_repo_v1(self, path):
348
 
        verb = 'BzrDir.find_repository'
 
827
        verb = b'BzrDir.find_repository'
349
828
        response = self._call(verb, path)
350
 
        if response[0] != 'ok':
 
829
        if response[0] != b'ok':
351
830
            raise errors.UnexpectedSmartServerResponse(response)
352
831
        # servers that only support the v1 method don't support external
353
832
        # references either.
354
833
        self._ensure_real()
355
834
        repo = self._real_bzrdir.open_repository()
356
 
        response = response + ('no', repo._format.network_name())
 
835
        response = response + (b'no', repo._format.network_name())
357
836
        return response, repo
358
837
 
359
838
    def _open_repo_v2(self, path):
360
 
        verb = 'BzrDir.find_repositoryV2'
 
839
        verb = b'BzrDir.find_repositoryV2'
361
840
        response = self._call(verb, path)
362
 
        if response[0] != 'ok':
 
841
        if response[0] != b'ok':
363
842
            raise errors.UnexpectedSmartServerResponse(response)
364
843
        self._ensure_real()
365
844
        repo = self._real_bzrdir.open_repository()
367
846
        return response, repo
368
847
 
369
848
    def _open_repo_v3(self, path):
370
 
        verb = 'BzrDir.find_repositoryV3'
 
849
        verb = b'BzrDir.find_repositoryV3'
371
850
        medium = self._client._medium
372
851
        if medium._is_remote_before((1, 13)):
373
852
            raise errors.UnknownSmartMethod(verb)
376
855
        except errors.UnknownSmartMethod:
377
856
            medium._remember_remote_is_before((1, 13))
378
857
            raise
379
 
        if response[0] != 'ok':
 
858
        if response[0] != b'ok':
380
859
            raise errors.UnexpectedSmartServerResponse(response)
381
860
        return response, None
382
861
 
384
863
        path = self._path_for_remote_call(self._client)
385
864
        response = None
386
865
        for probe in [self._open_repo_v3, self._open_repo_v2,
387
 
            self._open_repo_v1]:
 
866
                      self._open_repo_v1]:
388
867
            try:
389
868
                response, real_repo = probe(path)
390
869
                break
391
870
            except errors.UnknownSmartMethod:
392
871
                pass
393
872
        if response is None:
394
 
            raise errors.UnknownSmartMethod('BzrDir.find_repository{3,2,}')
395
 
        if response[0] != 'ok':
 
873
            raise errors.UnknownSmartMethod(b'BzrDir.find_repository{3,2,}')
 
874
        if response[0] != b'ok':
396
875
            raise errors.UnexpectedSmartServerResponse(response)
397
876
        if len(response) != 6:
398
 
            raise SmartProtocolError('incorrect response length %s' % (response,))
399
 
        if response[1] == '':
 
877
            raise SmartProtocolError(
 
878
                'incorrect response length %s' % (response,))
 
879
        if response[1] == b'':
400
880
            # repo is at this dir.
401
881
            format = response_tuple_to_repo_format(response[2:])
402
882
            # Used to support creating a real format instance when needed.
411
891
 
412
892
    def has_workingtree(self):
413
893
        if self._has_working_tree is None:
414
 
            self._ensure_real()
415
 
            self._has_working_tree = self._real_bzrdir.has_workingtree()
 
894
            path = self._path_for_remote_call(self._client)
 
895
            try:
 
896
                response = self._call(b'BzrDir.has_workingtree', path)
 
897
            except errors.UnknownSmartMethod:
 
898
                self._ensure_real()
 
899
                self._has_working_tree = self._real_bzrdir.has_workingtree()
 
900
            else:
 
901
                if response[0] not in (b'yes', b'no'):
 
902
                    raise SmartProtocolError(
 
903
                        'unexpected response code %s' % (response,))
 
904
                self._has_working_tree = (response[0] == b'yes')
416
905
        return self._has_working_tree
417
906
 
418
907
    def open_workingtree(self, recommend_upgrade=True):
423
912
 
424
913
    def _path_for_remote_call(self, client):
425
914
        """Return the path to be used for this bzrdir in a remote call."""
426
 
        return client.remote_path_from_transport(self.root_transport)
 
915
        remote_path = client.remote_path_from_transport(self.root_transport)
 
916
        if sys.version_info[0] == 3:
 
917
            remote_path = remote_path.decode('utf-8')
 
918
        base_url, segment_parameters = urlutils.split_segment_parameters_raw(
 
919
            remote_path)
 
920
        if sys.version_info[0] == 3:
 
921
            base_url = base_url.encode('utf-8')
 
922
        return base_url
427
923
 
428
924
    def get_branch_transport(self, branch_format, name=None):
429
925
        self._ensure_real()
441
937
        """Upgrading of remote bzrdirs is not supported yet."""
442
938
        return False
443
939
 
444
 
    def needs_format_conversion(self, format=None):
 
940
    def needs_format_conversion(self, format):
445
941
        """Upgrading of remote bzrdirs is not supported yet."""
446
 
        if format is None:
447
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
448
 
                % 'needs_format_conversion(format=None)')
449
942
        return False
450
943
 
451
 
    def clone(self, url, revision_id=None, force_new_repo=False,
452
 
              preserve_stacking=False):
453
 
        self._ensure_real()
454
 
        return self._real_bzrdir.clone(url, revision_id=revision_id,
455
 
            force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
456
 
 
457
944
    def _get_config(self):
458
945
        return RemoteBzrDirConfig(self)
459
946
 
460
 
 
461
 
class RemoteRepositoryFormat(repository.RepositoryFormat):
 
947
    def _get_config_store(self):
 
948
        return RemoteControlStore(self)
 
949
 
 
950
 
 
951
class RemoteInventoryTree(InventoryRevisionTree):
 
952
 
 
953
    def __init__(self, repository, inv, revision_id):
 
954
        super(RemoteInventoryTree, self).__init__(repository, inv, revision_id)
 
955
 
 
956
    def archive(self, format, name, root=None, subdir=None, force_mtime=None):
 
957
        ret = self._repository._revision_archive(
 
958
            self.get_revision_id(), format, name, root, subdir,
 
959
            force_mtime=force_mtime)
 
960
        if ret is None:
 
961
            return super(RemoteInventoryTree, self).archive(
 
962
                format, name, root, subdir, force_mtime=force_mtime)
 
963
        return ret
 
964
 
 
965
    def annotate_iter(self, path,
 
966
                      default_revision=_mod_revision.CURRENT_REVISION):
 
967
        """Return an iterator of revision_id, line tuples.
 
968
 
 
969
        For working trees (and mutable trees in general), the special
 
970
        revision_id 'current:' will be used for lines that are new in this
 
971
        tree, e.g. uncommitted changes.
 
972
        :param default_revision: For lines that don't match a basis, mark them
 
973
            with this revision id. Not all implementations will make use of
 
974
            this value.
 
975
        """
 
976
        ret = self._repository._annotate_file_revision(
 
977
            self.get_revision_id(), path, file_id=None,
 
978
            default_revision=default_revision)
 
979
        if ret is None:
 
980
            return super(RemoteInventoryTree, self).annotate_iter(
 
981
                path, default_revision=default_revision)
 
982
        return ret
 
983
 
 
984
 
 
985
class RemoteRepositoryFormat(vf_repository.VersionedFileRepositoryFormat):
462
986
    """Format for repositories accessed over a _SmartClient.
463
987
 
464
988
    Instances of this repository are represented by RemoteRepository
478
1002
        to obtain data like the network name.
479
1003
    """
480
1004
 
481
 
    _matchingbzrdir = RemoteBzrDirFormat()
 
1005
    _matchingcontroldir = RemoteBzrDirFormat()
 
1006
    supports_full_versioned_files = True
 
1007
    supports_leaving_lock = True
 
1008
    supports_overriding_transport = False
482
1009
 
483
1010
    def __init__(self):
484
 
        repository.RepositoryFormat.__init__(self)
 
1011
        _mod_repository.RepositoryFormat.__init__(self)
485
1012
        self._custom_format = None
486
1013
        self._network_name = None
487
1014
        self._creating_bzrdir = None
 
1015
        self._revision_graph_can_have_wrong_parents = None
488
1016
        self._supports_chks = None
489
1017
        self._supports_external_lookups = None
490
1018
        self._supports_tree_reference = None
 
1019
        self._supports_funky_characters = None
 
1020
        self._supports_nesting_repositories = None
491
1021
        self._rich_root_data = None
492
1022
 
493
1023
    def __repr__(self):
494
1024
        return "%s(_network_name=%r)" % (self.__class__.__name__,
495
 
            self._network_name)
 
1025
                                         self._network_name)
496
1026
 
497
1027
    @property
498
1028
    def fast_deltas(self):
522
1052
        return self._supports_external_lookups
523
1053
 
524
1054
    @property
 
1055
    def supports_funky_characters(self):
 
1056
        if self._supports_funky_characters is None:
 
1057
            self._ensure_real()
 
1058
            self._supports_funky_characters = \
 
1059
                self._custom_format.supports_funky_characters
 
1060
        return self._supports_funky_characters
 
1061
 
 
1062
    @property
 
1063
    def supports_nesting_repositories(self):
 
1064
        if self._supports_nesting_repositories is None:
 
1065
            self._ensure_real()
 
1066
            self._supports_nesting_repositories = \
 
1067
                self._custom_format.supports_nesting_repositories
 
1068
        return self._supports_nesting_repositories
 
1069
 
 
1070
    @property
525
1071
    def supports_tree_reference(self):
526
1072
        if self._supports_tree_reference is None:
527
1073
            self._ensure_real()
529
1075
                self._custom_format.supports_tree_reference
530
1076
        return self._supports_tree_reference
531
1077
 
532
 
    def _vfs_initialize(self, a_bzrdir, shared):
 
1078
    @property
 
1079
    def revision_graph_can_have_wrong_parents(self):
 
1080
        if self._revision_graph_can_have_wrong_parents is None:
 
1081
            self._ensure_real()
 
1082
            self._revision_graph_can_have_wrong_parents = \
 
1083
                self._custom_format.revision_graph_can_have_wrong_parents
 
1084
        return self._revision_graph_can_have_wrong_parents
 
1085
 
 
1086
    def _vfs_initialize(self, a_controldir, shared):
533
1087
        """Helper for common code in initialize."""
534
1088
        if self._custom_format:
535
1089
            # Custom format requested
536
 
            result = self._custom_format.initialize(a_bzrdir, shared=shared)
 
1090
            result = self._custom_format.initialize(
 
1091
                a_controldir, shared=shared)
537
1092
        elif self._creating_bzrdir is not None:
538
1093
            # Use the format that the repository we were created to back
539
1094
            # has.
540
1095
            prior_repo = self._creating_bzrdir.open_repository()
541
1096
            prior_repo._ensure_real()
542
1097
            result = prior_repo._real_repository._format.initialize(
543
 
                a_bzrdir, shared=shared)
 
1098
                a_controldir, shared=shared)
544
1099
        else:
545
1100
            # assume that a_bzr is a RemoteBzrDir but the smart server didn't
546
1101
            # support remote initialization.
547
1102
            # We delegate to a real object at this point (as RemoteBzrDir
548
1103
            # delegate to the repository format which would lead to infinite
549
 
            # recursion if we just called a_bzrdir.create_repository.
550
 
            a_bzrdir._ensure_real()
551
 
            result = a_bzrdir._real_bzrdir.create_repository(shared=shared)
 
1104
            # recursion if we just called a_controldir.create_repository.
 
1105
            a_controldir._ensure_real()
 
1106
            result = a_controldir._real_bzrdir.create_repository(shared=shared)
552
1107
        if not isinstance(result, RemoteRepository):
553
 
            return self.open(a_bzrdir)
 
1108
            return self.open(a_controldir)
554
1109
        else:
555
1110
            return result
556
1111
 
557
 
    def initialize(self, a_bzrdir, shared=False):
 
1112
    def initialize(self, a_controldir, shared=False):
558
1113
        # Being asked to create on a non RemoteBzrDir:
559
 
        if not isinstance(a_bzrdir, RemoteBzrDir):
560
 
            return self._vfs_initialize(a_bzrdir, shared)
561
 
        medium = a_bzrdir._client._medium
 
1114
        if not isinstance(a_controldir, RemoteBzrDir):
 
1115
            return self._vfs_initialize(a_controldir, shared)
 
1116
        medium = a_controldir._client._medium
562
1117
        if medium._is_remote_before((1, 13)):
563
 
            return self._vfs_initialize(a_bzrdir, shared)
 
1118
            return self._vfs_initialize(a_controldir, shared)
564
1119
        # Creating on a remote bzr dir.
565
1120
        # 1) get the network name to use.
566
1121
        if self._custom_format:
568
1123
        elif self._network_name:
569
1124
            network_name = self._network_name
570
1125
        else:
571
 
            # Select the current bzrlib default and ask for that.
572
 
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
 
1126
            # Select the current breezy default and ask for that.
 
1127
            reference_bzrdir_format = controldir.format_registry.get(
 
1128
                'default')()
573
1129
            reference_format = reference_bzrdir_format.repository_format
574
1130
            network_name = reference_format.network_name()
575
1131
        # 2) try direct creation via RPC
576
 
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
577
 
        verb = 'BzrDir.create_repository'
 
1132
        path = a_controldir._path_for_remote_call(a_controldir._client)
 
1133
        verb = b'BzrDir.create_repository'
578
1134
        if shared:
579
 
            shared_str = 'True'
 
1135
            shared_str = b'True'
580
1136
        else:
581
 
            shared_str = 'False'
 
1137
            shared_str = b'False'
582
1138
        try:
583
 
            response = a_bzrdir._call(verb, path, network_name, shared_str)
 
1139
            response = a_controldir._call(verb, path, network_name, shared_str)
584
1140
        except errors.UnknownSmartMethod:
585
1141
            # Fallback - use vfs methods
586
1142
            medium._remember_remote_is_before((1, 13))
587
 
            return self._vfs_initialize(a_bzrdir, shared)
 
1143
            return self._vfs_initialize(a_controldir, shared)
588
1144
        else:
589
1145
            # Turn the response into a RemoteRepository object.
590
1146
            format = response_tuple_to_repo_format(response[1:])
591
1147
            # Used to support creating a real format instance when needed.
592
 
            format._creating_bzrdir = a_bzrdir
593
 
            remote_repo = RemoteRepository(a_bzrdir, format)
 
1148
            format._creating_bzrdir = a_controldir
 
1149
            remote_repo = RemoteRepository(a_controldir, format)
594
1150
            format._creating_repo = remote_repo
595
1151
            return remote_repo
596
1152
 
597
 
    def open(self, a_bzrdir):
598
 
        if not isinstance(a_bzrdir, RemoteBzrDir):
599
 
            raise AssertionError('%r is not a RemoteBzrDir' % (a_bzrdir,))
600
 
        return a_bzrdir.open_repository()
 
1153
    def open(self, a_controldir):
 
1154
        if not isinstance(a_controldir, RemoteBzrDir):
 
1155
            raise AssertionError('%r is not a RemoteBzrDir' % (a_controldir,))
 
1156
        return a_controldir.open_repository()
601
1157
 
602
1158
    def _ensure_real(self):
603
1159
        if self._custom_format is None:
604
 
            self._custom_format = repository.network_format_registry.get(
605
 
                self._network_name)
 
1160
            try:
 
1161
                self._custom_format = _mod_repository.network_format_registry.get(
 
1162
                    self._network_name)
 
1163
            except KeyError:
 
1164
                raise errors.UnknownFormatError(kind='repository',
 
1165
                                                format=self._network_name)
606
1166
 
607
1167
    @property
608
1168
    def _fetch_order(self):
643
1203
        return self._custom_format._serializer
644
1204
 
645
1205
 
646
 
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
647
 
    bzrdir.ControlComponent):
 
1206
class RemoteRepository(_mod_repository.Repository, _RpcHelper,
 
1207
                       lock._RelockDebugMixin):
648
1208
    """Repository accessed over rpc.
649
1209
 
650
1210
    For the moment most operations are performed using local transport-backed
666
1226
            self._real_repository = real_repository
667
1227
        else:
668
1228
            self._real_repository = None
669
 
        self.bzrdir = remote_bzrdir
 
1229
        self.controldir = remote_bzrdir
670
1230
        if _client is None:
671
1231
            self._client = remote_bzrdir._client
672
1232
        else:
674
1234
        self._format = format
675
1235
        self._lock_mode = None
676
1236
        self._lock_token = None
 
1237
        self._write_group_tokens = None
677
1238
        self._lock_count = 0
678
1239
        self._leave_lock = False
679
1240
        # Cache of revision parents; misses are cached during read locks, and
689
1250
        self._reconcile_does_inventory_gc = False
690
1251
        self._reconcile_fixes_text_parents = False
691
1252
        self._reconcile_backsup_inventory = False
692
 
        self.base = self.bzrdir.transport.base
 
1253
        self.base = self.controldir.transport.base
693
1254
        # Additional places to query for data.
694
1255
        self._fallback_repositories = []
695
1256
 
696
1257
    @property
697
1258
    def user_transport(self):
698
 
        return self.bzrdir.user_transport
 
1259
        return self.controldir.user_transport
699
1260
 
700
1261
    @property
701
1262
    def control_transport(self):
702
1263
        # XXX: Normally you shouldn't directly get at the remote repository
703
1264
        # transport, but I'm not sure it's worth making this method
704
1265
        # optional -- mbp 2010-04-21
705
 
        return self.bzrdir.get_repository_transport(None)
706
 
        
 
1266
        return self.controldir.get_repository_transport(None)
 
1267
 
707
1268
    def __str__(self):
708
1269
        return "%s(%s)" % (self.__class__.__name__, self.base)
709
1270
 
719
1280
 
720
1281
        :param suppress_errors: see Repository.abort_write_group.
721
1282
        """
722
 
        self._ensure_real()
723
 
        return self._real_repository.abort_write_group(
724
 
            suppress_errors=suppress_errors)
 
1283
        if self._real_repository:
 
1284
            self._ensure_real()
 
1285
            return self._real_repository.abort_write_group(
 
1286
                suppress_errors=suppress_errors)
 
1287
        if not self.is_in_write_group():
 
1288
            if suppress_errors:
 
1289
                mutter('(suppressed) not in write group')
 
1290
                return
 
1291
            raise errors.BzrError("not in write group")
 
1292
        path = self.controldir._path_for_remote_call(self._client)
 
1293
        try:
 
1294
            response = self._call(b'Repository.abort_write_group', path,
 
1295
                                  self._lock_token,
 
1296
                                  [token.encode('utf-8') for token in self._write_group_tokens])
 
1297
        except Exception as exc:
 
1298
            self._write_group = None
 
1299
            if not suppress_errors:
 
1300
                raise
 
1301
            mutter('abort_write_group failed')
 
1302
            log_exception_quietly()
 
1303
            note(gettext('bzr: ERROR (ignored): %s'), exc)
 
1304
        else:
 
1305
            if response != (b'ok', ):
 
1306
                raise errors.UnexpectedSmartServerResponse(response)
 
1307
            self._write_group_tokens = None
725
1308
 
726
1309
    @property
727
1310
    def chk_bytes(self):
741
1324
        for older plugins that don't use e.g. the CommitBuilder
742
1325
        facility.
743
1326
        """
744
 
        self._ensure_real()
745
 
        return self._real_repository.commit_write_group()
 
1327
        if self._real_repository:
 
1328
            self._ensure_real()
 
1329
            return self._real_repository.commit_write_group()
 
1330
        if not self.is_in_write_group():
 
1331
            raise errors.BzrError("not in write group")
 
1332
        path = self.controldir._path_for_remote_call(self._client)
 
1333
        response = self._call(b'Repository.commit_write_group', path,
 
1334
                              self._lock_token, [token.encode('utf-8') for token in self._write_group_tokens])
 
1335
        if response != (b'ok', ):
 
1336
            raise errors.UnexpectedSmartServerResponse(response)
 
1337
        self._write_group_tokens = None
 
1338
        # Refresh data after writing to the repository.
 
1339
        self.refresh_data()
746
1340
 
747
1341
    def resume_write_group(self, tokens):
748
 
        self._ensure_real()
749
 
        return self._real_repository.resume_write_group(tokens)
 
1342
        if self._real_repository:
 
1343
            return self._real_repository.resume_write_group(tokens)
 
1344
        path = self.controldir._path_for_remote_call(self._client)
 
1345
        try:
 
1346
            response = self._call(b'Repository.check_write_group', path,
 
1347
                                  self._lock_token, [token.encode('utf-8') for token in tokens])
 
1348
        except errors.UnknownSmartMethod:
 
1349
            self._ensure_real()
 
1350
            return self._real_repository.resume_write_group(tokens)
 
1351
        if response != (b'ok', ):
 
1352
            raise errors.UnexpectedSmartServerResponse(response)
 
1353
        self._write_group_tokens = tokens
750
1354
 
751
1355
    def suspend_write_group(self):
752
 
        self._ensure_real()
753
 
        return self._real_repository.suspend_write_group()
 
1356
        if self._real_repository:
 
1357
            return self._real_repository.suspend_write_group()
 
1358
        ret = self._write_group_tokens or []
 
1359
        self._write_group_tokens = None
 
1360
        return ret
754
1361
 
755
1362
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
756
1363
        self._ensure_real()
764
1371
 
765
1372
    def get_rev_id_for_revno(self, revno, known_pair):
766
1373
        """See Repository.get_rev_id_for_revno."""
767
 
        path = self.bzrdir._path_for_remote_call(self._client)
 
1374
        path = self.controldir._path_for_remote_call(self._client)
768
1375
        try:
769
1376
            if self._client._medium._is_remote_before((1, 17)):
770
1377
                return self._get_rev_id_for_revno_vfs(revno, known_pair)
771
1378
            response = self._call(
772
 
                'Repository.get_rev_id_for_revno', path, revno, known_pair)
 
1379
                b'Repository.get_rev_id_for_revno', path, revno, known_pair)
773
1380
        except errors.UnknownSmartMethod:
774
1381
            self._client._medium._remember_remote_is_before((1, 17))
775
1382
            return self._get_rev_id_for_revno_vfs(revno, known_pair)
776
 
        if response[0] == 'ok':
 
1383
        except errors.UnknownErrorFromSmartServer as e:
 
1384
            # Older versions of Bazaar/Breezy (<< 3.0.0) would raise a
 
1385
            # ValueError instead of returning revno-outofbounds
 
1386
            if len(e.error_tuple) < 3:
 
1387
                raise
 
1388
            if e.error_tuple[:2] != (b'error', b'ValueError'):
 
1389
                raise
 
1390
            m = re.match(
 
1391
                br"requested revno \(([0-9]+)\) is later than given "
 
1392
                br"known revno \(([0-9]+)\)", e.error_tuple[2])
 
1393
            if not m:
 
1394
                raise
 
1395
            raise errors.RevnoOutOfBounds(
 
1396
                int(m.group(1)), (0, int(m.group(2))))
 
1397
        if response[0] == b'ok':
777
1398
            return True, response[1]
778
 
        elif response[0] == 'history-incomplete':
 
1399
        elif response[0] == b'history-incomplete':
779
1400
            known_pair = response[1:3]
780
1401
            for fallback in self._fallback_repositories:
781
 
                found, result = fallback.get_rev_id_for_revno(revno, known_pair)
 
1402
                found, result = fallback.get_rev_id_for_revno(
 
1403
                    revno, known_pair)
782
1404
                if found:
783
1405
                    return True, result
784
1406
                else:
805
1427
            if 'hpssvfs' in debug.debug_flags:
806
1428
                import traceback
807
1429
                warning('VFS Repository access triggered\n%s',
808
 
                    ''.join(traceback.format_stack()))
 
1430
                        ''.join(traceback.format_stack()))
809
1431
            self._unstacked_provider.missing_keys.clear()
810
 
            self.bzrdir._ensure_real()
 
1432
            self.controldir._ensure_real()
811
1433
            self._set_real_repository(
812
 
                self.bzrdir._real_bzrdir.open_repository())
 
1434
                self.controldir._real_bzrdir.open_repository())
813
1435
 
814
1436
    def _translate_error(self, err, **context):
815
 
        self.bzrdir._translate_error(err, repository=self, **context)
 
1437
        self.controldir._translate_error(err, repository=self, **context)
816
1438
 
817
1439
    def find_text_key_references(self):
818
1440
        """Find the text key references within the repository.
819
1441
 
820
 
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
821
 
        revision_ids. Each altered file-ids has the exact revision_ids that
822
 
        altered it listed explicitly.
823
1442
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
824
1443
            to whether they were referred to by the inventory of the
825
1444
            revision_id that they contain. The inventory texts from all present
842
1461
    def _get_revision_graph(self, revision_id):
843
1462
        """Private method for using with old (< 1.2) servers to fallback."""
844
1463
        if revision_id is None:
845
 
            revision_id = ''
846
 
        elif revision.is_null(revision_id):
 
1464
            revision_id = b''
 
1465
        elif _mod_revision.is_null(revision_id):
847
1466
            return {}
848
1467
 
849
 
        path = self.bzrdir._path_for_remote_call(self._client)
 
1468
        path = self.controldir._path_for_remote_call(self._client)
850
1469
        response = self._call_expecting_body(
851
 
            'Repository.get_revision_graph', path, revision_id)
 
1470
            b'Repository.get_revision_graph', path, revision_id)
852
1471
        response_tuple, response_handler = response
853
 
        if response_tuple[0] != 'ok':
 
1472
        if response_tuple[0] != b'ok':
854
1473
            raise errors.UnexpectedSmartServerResponse(response_tuple)
855
1474
        coded = response_handler.read_body_bytes()
856
 
        if coded == '':
 
1475
        if coded == b'':
857
1476
            # no revisions in this repository!
858
1477
            return {}
859
 
        lines = coded.split('\n')
 
1478
        lines = coded.split(b'\n')
860
1479
        revision_graph = {}
861
1480
        for line in lines:
862
1481
            d = tuple(line.split())
872
1491
        """Return a source for streaming from this repository."""
873
1492
        return RemoteStreamSource(self, to_format)
874
1493
 
875
 
    @needs_read_lock
 
1494
    def get_file_graph(self):
 
1495
        with self.lock_read():
 
1496
            return graph.Graph(self.texts)
 
1497
 
876
1498
    def has_revision(self, revision_id):
877
1499
        """True if this repository has a copy of the revision."""
878
 
        # Copy of bzrlib.repository.Repository.has_revision
879
 
        return revision_id in self.has_revisions((revision_id,))
 
1500
        # Copy of breezy.repository.Repository.has_revision
 
1501
        with self.lock_read():
 
1502
            return revision_id in self.has_revisions((revision_id,))
880
1503
 
881
 
    @needs_read_lock
882
1504
    def has_revisions(self, revision_ids):
883
1505
        """Probe to find out the presence of multiple revisions.
884
1506
 
885
1507
        :param revision_ids: An iterable of revision_ids.
886
1508
        :return: A set of the revision_ids that were present.
887
1509
        """
888
 
        # Copy of bzrlib.repository.Repository.has_revisions
889
 
        parent_map = self.get_parent_map(revision_ids)
890
 
        result = set(parent_map)
891
 
        if _mod_revision.NULL_REVISION in revision_ids:
892
 
            result.add(_mod_revision.NULL_REVISION)
893
 
        return result
 
1510
        with self.lock_read():
 
1511
            # Copy of breezy.repository.Repository.has_revisions
 
1512
            parent_map = self.get_parent_map(revision_ids)
 
1513
            result = set(parent_map)
 
1514
            if _mod_revision.NULL_REVISION in revision_ids:
 
1515
                result.add(_mod_revision.NULL_REVISION)
 
1516
            return result
894
1517
 
895
1518
    def _has_same_fallbacks(self, other_repo):
896
1519
        """Returns true if the repositories have the same fallbacks."""
897
1520
        # XXX: copied from Repository; it should be unified into a base class
898
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401622>
 
1521
        # <https://bugs.launchpad.net/bzr/+bug/401622>
899
1522
        my_fb = self._fallback_repositories
900
1523
        other_fb = other_repo._fallback_repositories
901
1524
        if len(my_fb) != len(other_fb):
909
1532
        # TODO: Move to RepositoryBase and unify with the regular Repository
910
1533
        # one; unfortunately the tests rely on slightly different behaviour at
911
1534
        # present -- mbp 20090710
912
 
        return (self.__class__ is other.__class__ and
913
 
                self.bzrdir.transport.base == other.bzrdir.transport.base)
 
1535
        return (self.__class__ is other.__class__
 
1536
                and self.controldir.transport.base == other.controldir.transport.base)
914
1537
 
915
1538
    def get_graph(self, other_repository=None):
916
1539
        """Return the graph for this repository format"""
917
1540
        parents_provider = self._make_parents_provider(other_repository)
918
1541
        return graph.Graph(parents_provider)
919
1542
 
920
 
    @needs_read_lock
921
1543
    def get_known_graph_ancestry(self, revision_ids):
922
1544
        """Return the known graph for a set of revision ids and their ancestors.
923
1545
        """
924
 
        st = static_tuple.StaticTuple
925
 
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
926
 
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
927
 
        return graph.GraphThunkIdsToKeys(known_graph)
 
1546
        with self.lock_read():
 
1547
            revision_graph = dict(((key, value) for key, value in
 
1548
                                   self.get_graph().iter_ancestry(revision_ids) if value is not None))
 
1549
            revision_graph = _mod_repository._strip_NULL_ghosts(revision_graph)
 
1550
            return graph.KnownGraph(revision_graph)
928
1551
 
929
1552
    def gather_stats(self, revid=None, committers=None):
930
1553
        """See Repository.gather_stats()."""
931
 
        path = self.bzrdir._path_for_remote_call(self._client)
 
1554
        path = self.controldir._path_for_remote_call(self._client)
932
1555
        # revid can be None to indicate no revisions, not just NULL_REVISION
933
 
        if revid is None or revision.is_null(revid):
934
 
            fmt_revid = ''
 
1556
        if revid is None or _mod_revision.is_null(revid):
 
1557
            fmt_revid = b''
935
1558
        else:
936
1559
            fmt_revid = revid
937
1560
        if committers is None or not committers:
938
 
            fmt_committers = 'no'
 
1561
            fmt_committers = b'no'
939
1562
        else:
940
 
            fmt_committers = 'yes'
 
1563
            fmt_committers = b'yes'
941
1564
        response_tuple, response_handler = self._call_expecting_body(
942
 
            'Repository.gather_stats', path, fmt_revid, fmt_committers)
943
 
        if response_tuple[0] != 'ok':
 
1565
            b'Repository.gather_stats', path, fmt_revid, fmt_committers)
 
1566
        if response_tuple[0] != b'ok':
944
1567
            raise errors.UnexpectedSmartServerResponse(response_tuple)
945
1568
 
946
1569
        body = response_handler.read_body_bytes()
947
1570
        result = {}
948
 
        for line in body.split('\n'):
 
1571
        for line in body.split(b'\n'):
949
1572
            if not line:
950
1573
                continue
951
 
            key, val_text = line.split(':')
 
1574
            key, val_text = line.split(b':')
 
1575
            key = key.decode('ascii')
952
1576
            if key in ('revisions', 'size', 'committers'):
953
1577
                result[key] = int(val_text)
954
1578
            elif key in ('firstrev', 'latestrev'):
955
 
                values = val_text.split(' ')[1:]
956
 
                result[key] = (float(values[0]), long(values[1]))
 
1579
                values = val_text.split(b' ')[1:]
 
1580
                result[key] = (float(values[0]), int(values[1]))
957
1581
 
958
1582
        return result
959
1583
 
965
1589
 
966
1590
    def get_physical_lock_status(self):
967
1591
        """See Repository.get_physical_lock_status()."""
968
 
        # should be an API call to the server.
969
 
        self._ensure_real()
970
 
        return self._real_repository.get_physical_lock_status()
 
1592
        path = self.controldir._path_for_remote_call(self._client)
 
1593
        try:
 
1594
            response = self._call(b'Repository.get_physical_lock_status', path)
 
1595
        except errors.UnknownSmartMethod:
 
1596
            self._ensure_real()
 
1597
            return self._real_repository.get_physical_lock_status()
 
1598
        if response[0] not in (b'yes', b'no'):
 
1599
            raise errors.UnexpectedSmartServerResponse(response)
 
1600
        return (response[0] == b'yes')
971
1601
 
972
1602
    def is_in_write_group(self):
973
1603
        """Return True if there is an open write group.
974
1604
 
975
1605
        write groups are only applicable locally for the smart server..
976
1606
        """
 
1607
        if self._write_group_tokens is not None:
 
1608
            return True
977
1609
        if self._real_repository:
978
1610
            return self._real_repository.is_in_write_group()
979
1611
 
982
1614
 
983
1615
    def is_shared(self):
984
1616
        """See Repository.is_shared()."""
985
 
        path = self.bzrdir._path_for_remote_call(self._client)
986
 
        response = self._call('Repository.is_shared', path)
987
 
        if response[0] not in ('yes', 'no'):
988
 
            raise SmartProtocolError('unexpected response code %s' % (response,))
989
 
        return response[0] == 'yes'
 
1617
        path = self.controldir._path_for_remote_call(self._client)
 
1618
        response = self._call(b'Repository.is_shared', path)
 
1619
        if response[0] not in (b'yes', b'no'):
 
1620
            raise SmartProtocolError(
 
1621
                'unexpected response code %s' % (response,))
 
1622
        return response[0] == b'yes'
990
1623
 
991
1624
    def is_write_locked(self):
992
1625
        return self._lock_mode == 'w'
997
1630
        pass
998
1631
 
999
1632
    def lock_read(self):
 
1633
        """Lock the repository for read operations.
 
1634
 
 
1635
        :return: A breezy.lock.LogicalLockResult.
 
1636
        """
1000
1637
        # wrong eventually - want a local lock cache context
1001
1638
        if not self._lock_mode:
1002
1639
            self._note_lock('r')
1009
1646
                repo.lock_read()
1010
1647
        else:
1011
1648
            self._lock_count += 1
 
1649
        return lock.LogicalLockResult(self.unlock)
1012
1650
 
1013
1651
    def _remote_lock_write(self, token):
1014
 
        path = self.bzrdir._path_for_remote_call(self._client)
 
1652
        path = self.controldir._path_for_remote_call(self._client)
1015
1653
        if token is None:
1016
 
            token = ''
 
1654
            token = b''
1017
1655
        err_context = {'token': token}
1018
 
        response = self._call('Repository.lock_write', path, token,
 
1656
        response = self._call(b'Repository.lock_write', path, token,
1019
1657
                              **err_context)
1020
 
        if response[0] == 'ok':
 
1658
        if response[0] == b'ok':
1021
1659
            ok, token = response
1022
1660
            return token
1023
1661
        else:
1054
1692
            raise errors.ReadOnlyError(self)
1055
1693
        else:
1056
1694
            self._lock_count += 1
1057
 
        return self._lock_token or None
 
1695
        return RepositoryWriteLockResult(self.unlock, self._lock_token or None)
1058
1696
 
1059
1697
    def leave_lock_in_place(self):
1060
1698
        if not self._lock_token:
1095
1733
        # 3) new servers, RemoteRepository.ensure_real is triggered before
1096
1734
        # RemoteBranch.ensure real, in this case we get a repo with no fallbacks
1097
1735
        # and need to populate it.
1098
 
        if (self._fallback_repositories and
1099
 
            len(self._real_repository._fallback_repositories) !=
1100
 
            len(self._fallback_repositories)):
 
1736
        if (self._fallback_repositories
 
1737
            and len(self._real_repository._fallback_repositories)
 
1738
                != len(self._fallback_repositories)):
1101
1739
            if len(self._real_repository._fallback_repositories):
1102
1740
                raise AssertionError(
1103
1741
                    "cannot cleanly remove existing _fallback_repositories")
1109
1747
            self._real_repository.lock_write(self._lock_token)
1110
1748
        elif self._lock_mode == 'r':
1111
1749
            self._real_repository.lock_read()
 
1750
        if self._write_group_tokens is not None:
 
1751
            # if we are already in a write group, resume it
 
1752
            self._real_repository.resume_write_group(self._write_group_tokens)
 
1753
            self._write_group_tokens = None
1112
1754
 
1113
1755
    def start_write_group(self):
1114
1756
        """Start a write group on the decorated repository.
1118
1760
        for older plugins that don't use e.g. the CommitBuilder
1119
1761
        facility.
1120
1762
        """
1121
 
        self._ensure_real()
1122
 
        return self._real_repository.start_write_group()
 
1763
        if self._real_repository:
 
1764
            self._ensure_real()
 
1765
            return self._real_repository.start_write_group()
 
1766
        if not self.is_write_locked():
 
1767
            raise errors.NotWriteLocked(self)
 
1768
        if self._write_group_tokens is not None:
 
1769
            raise errors.BzrError('already in a write group')
 
1770
        path = self.controldir._path_for_remote_call(self._client)
 
1771
        try:
 
1772
            response = self._call(b'Repository.start_write_group', path,
 
1773
                                  self._lock_token)
 
1774
        except (errors.UnknownSmartMethod, errors.UnsuspendableWriteGroup):
 
1775
            self._ensure_real()
 
1776
            return self._real_repository.start_write_group()
 
1777
        if response[0] != b'ok':
 
1778
            raise errors.UnexpectedSmartServerResponse(response)
 
1779
        self._write_group_tokens = [
 
1780
            token.decode('utf-8') for token in response[1]]
1123
1781
 
1124
1782
    def _unlock(self, token):
1125
 
        path = self.bzrdir._path_for_remote_call(self._client)
 
1783
        path = self.controldir._path_for_remote_call(self._client)
1126
1784
        if not token:
1127
1785
            # with no token the remote repository is not persistently locked.
1128
1786
            return
1129
1787
        err_context = {'token': token}
1130
 
        response = self._call('Repository.unlock', path, token,
 
1788
        response = self._call(b'Repository.unlock', path, token,
1131
1789
                              **err_context)
1132
 
        if response == ('ok',):
 
1790
        if response == (b'ok',):
1133
1791
            return
1134
1792
        else:
1135
1793
            raise errors.UnexpectedSmartServerResponse(response)
1152
1810
            # This is just to let the _real_repository stay up to date.
1153
1811
            if self._real_repository is not None:
1154
1812
                self._real_repository.unlock()
 
1813
            elif self._write_group_tokens is not None:
 
1814
                self.abort_write_group()
1155
1815
        finally:
1156
1816
            # The rpc-level lock should be released even if there was a
1157
1817
            # problem releasing the vfs-based lock.
1169
1829
 
1170
1830
    def break_lock(self):
1171
1831
        # should hand off to the network
1172
 
        self._ensure_real()
1173
 
        return self._real_repository.break_lock()
 
1832
        path = self.controldir._path_for_remote_call(self._client)
 
1833
        try:
 
1834
            response = self._call(b"Repository.break_lock", path)
 
1835
        except errors.UnknownSmartMethod:
 
1836
            self._ensure_real()
 
1837
            return self._real_repository.break_lock()
 
1838
        if response != (b'ok',):
 
1839
            raise errors.UnexpectedSmartServerResponse(response)
1174
1840
 
1175
1841
    def _get_tarball(self, compression):
1176
1842
        """Return a TemporaryFile containing a repository tarball.
1178
1844
        Returns None if the server does not support sending tarballs.
1179
1845
        """
1180
1846
        import tempfile
1181
 
        path = self.bzrdir._path_for_remote_call(self._client)
 
1847
        path = self.controldir._path_for_remote_call(self._client)
1182
1848
        try:
1183
1849
            response, protocol = self._call_expecting_body(
1184
 
                'Repository.tarball', path, compression)
 
1850
                b'Repository.tarball', path, compression.encode('ascii'))
1185
1851
        except errors.UnknownSmartMethod:
1186
1852
            protocol.cancel_read_body()
1187
1853
            return None
1188
 
        if response[0] == 'ok':
 
1854
        if response[0] == b'ok':
1189
1855
            # Extract the tarball and return it
1190
1856
            t = tempfile.NamedTemporaryFile()
1191
1857
            # TODO: rpc layer should read directly into it...
1195
1861
        raise errors.UnexpectedSmartServerResponse(response)
1196
1862
 
1197
1863
    def sprout(self, to_bzrdir, revision_id=None):
1198
 
        # TODO: Option to control what format is created?
1199
 
        self._ensure_real()
1200
 
        dest_repo = self._real_repository._format.initialize(to_bzrdir,
1201
 
                                                             shared=False)
1202
 
        dest_repo.fetch(self, revision_id=revision_id)
 
1864
        """Create a descendent repository for new development.
 
1865
 
 
1866
        Unlike clone, this does not copy the settings of the repository.
 
1867
        """
 
1868
        with self.lock_read():
 
1869
            dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
 
1870
            dest_repo.fetch(self, revision_id=revision_id)
 
1871
            return dest_repo
 
1872
 
 
1873
    def _create_sprouting_repo(self, a_controldir, shared):
 
1874
        if not isinstance(a_controldir._format, self.controldir._format.__class__):
 
1875
            # use target default format.
 
1876
            dest_repo = a_controldir.create_repository()
 
1877
        else:
 
1878
            # Most control formats need the repository to be specifically
 
1879
            # created, but on some old all-in-one formats it's not needed
 
1880
            try:
 
1881
                dest_repo = self._format.initialize(
 
1882
                    a_controldir, shared=shared)
 
1883
            except errors.UninitializableFormat:
 
1884
                dest_repo = a_controldir.open_repository()
1203
1885
        return dest_repo
1204
1886
 
1205
 
    ### These methods are just thin shims to the VFS object for now.
 
1887
    # These methods are just thin shims to the VFS object for now.
1206
1888
 
1207
1889
    def revision_tree(self, revision_id):
1208
 
        self._ensure_real()
1209
 
        return self._real_repository.revision_tree(revision_id)
 
1890
        with self.lock_read():
 
1891
            revision_id = _mod_revision.ensure_null(revision_id)
 
1892
            if revision_id == _mod_revision.NULL_REVISION:
 
1893
                return InventoryRevisionTree(self,
 
1894
                                             Inventory(root_id=None), _mod_revision.NULL_REVISION)
 
1895
            else:
 
1896
                return list(self.revision_trees([revision_id]))[0]
1210
1897
 
1211
1898
    def get_serializer_format(self):
1212
 
        self._ensure_real()
1213
 
        return self._real_repository.get_serializer_format()
 
1899
        path = self.controldir._path_for_remote_call(self._client)
 
1900
        try:
 
1901
            response = self._call(b'VersionedFileRepository.get_serializer_format',
 
1902
                                  path)
 
1903
        except errors.UnknownSmartMethod:
 
1904
            self._ensure_real()
 
1905
            return self._real_repository.get_serializer_format()
 
1906
        if response[0] != b'ok':
 
1907
            raise errors.UnexpectedSmartServerResponse(response)
 
1908
        return response[1]
1214
1909
 
1215
1910
    def get_commit_builder(self, branch, parents, config, timestamp=None,
1216
1911
                           timezone=None, committer=None, revprops=None,
1217
 
                           revision_id=None):
1218
 
        # FIXME: It ought to be possible to call this without immediately
1219
 
        # triggering _ensure_real.  For now it's the easiest thing to do.
1220
 
        self._ensure_real()
1221
 
        real_repo = self._real_repository
1222
 
        builder = real_repo.get_commit_builder(branch, parents,
1223
 
                config, timestamp=timestamp, timezone=timezone,
1224
 
                committer=committer, revprops=revprops, revision_id=revision_id)
1225
 
        return builder
 
1912
                           revision_id=None, lossy=False):
 
1913
        """Obtain a CommitBuilder for this repository.
 
1914
 
 
1915
        :param branch: Branch to commit to.
 
1916
        :param parents: Revision ids of the parents of the new revision.
 
1917
        :param config: Configuration to use.
 
1918
        :param timestamp: Optional timestamp recorded for commit.
 
1919
        :param timezone: Optional timezone for timestamp.
 
1920
        :param committer: Optional committer to set for commit.
 
1921
        :param revprops: Optional dictionary of revision properties.
 
1922
        :param revision_id: Optional revision id.
 
1923
        :param lossy: Whether to discard data that can not be natively
 
1924
            represented, when pushing to a foreign VCS
 
1925
        """
 
1926
        if self._fallback_repositories and not self._format.supports_chks:
 
1927
            raise errors.BzrError("Cannot commit directly to a stacked branch"
 
1928
                                  " in pre-2a formats. See "
 
1929
                                  "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
 
1930
        commit_builder_kls = vf_repository.VersionedFileCommitBuilder
 
1931
        result = commit_builder_kls(self, parents, config,
 
1932
                                    timestamp, timezone, committer, revprops, revision_id,
 
1933
                                    lossy)
 
1934
        self.start_write_group()
 
1935
        return result
1226
1936
 
1227
1937
    def add_fallback_repository(self, repository):
1228
1938
        """Add a repository to use for looking up data not held locally.
1235
1945
        # We need to accumulate additional repositories here, to pass them in
1236
1946
        # on various RPC's.
1237
1947
        #
 
1948
        # Make the check before we lock: this raises an exception.
 
1949
        self._check_fallback_repository(repository)
1238
1950
        if self.is_locked():
1239
1951
            # We will call fallback.unlock() when we transition to the unlocked
1240
1952
            # state, so always add a lock here. If a caller passes us a locked
1241
1953
            # repository, they are responsible for unlocking it later.
1242
1954
            repository.lock_read()
1243
 
        self._check_fallback_repository(repository)
1244
1955
        self._fallback_repositories.append(repository)
1245
1956
        # If self._real_repository was parameterised already (e.g. because a
1246
1957
        # _real_branch had its get_stacked_on_url method called), then the
1247
1958
        # repository to be added may already be in the _real_repositories list.
1248
1959
        if self._real_repository is not None:
1249
1960
            fallback_locations = [repo.user_url for repo in
1250
 
                self._real_repository._fallback_repositories]
 
1961
                                  self._real_repository._fallback_repositories]
1251
1962
            if repository.user_url not in fallback_locations:
1252
1963
                self._real_repository.add_fallback_repository(repository)
1253
1964
 
1266
1977
        return self._real_repository.add_inventory(revid, inv, parents)
1267
1978
 
1268
1979
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1269
 
            parents, basis_inv=None, propagate_caches=False):
 
1980
                               parents, basis_inv=None, propagate_caches=False):
1270
1981
        self._ensure_real()
1271
1982
        return self._real_repository.add_inventory_by_delta(basis_revision_id,
1272
 
            delta, new_revision_id, parents, basis_inv=basis_inv,
1273
 
            propagate_caches=propagate_caches)
1274
 
 
1275
 
    def add_revision(self, rev_id, rev, inv=None, config=None):
1276
 
        self._ensure_real()
1277
 
        return self._real_repository.add_revision(
1278
 
            rev_id, rev, inv=inv, config=config)
1279
 
 
1280
 
    @needs_read_lock
 
1983
                                                            delta, new_revision_id, parents, basis_inv=basis_inv,
 
1984
                                                            propagate_caches=propagate_caches)
 
1985
 
 
1986
    def add_revision(self, revision_id, rev, inv=None):
 
1987
        _mod_revision.check_not_reserved_id(revision_id)
 
1988
        key = (revision_id,)
 
1989
        # check inventory present
 
1990
        if not self.inventories.get_parent_map([key]):
 
1991
            if inv is None:
 
1992
                raise errors.WeaveRevisionNotPresent(revision_id,
 
1993
                                                     self.inventories)
 
1994
            else:
 
1995
                # yes, this is not suitable for adding with ghosts.
 
1996
                rev.inventory_sha1 = self.add_inventory(revision_id, inv,
 
1997
                                                        rev.parent_ids)
 
1998
        else:
 
1999
            rev.inventory_sha1 = self.inventories.get_sha1s([key])[key]
 
2000
        self._add_revision(rev)
 
2001
 
 
2002
    def _add_revision(self, rev):
 
2003
        if self._real_repository is not None:
 
2004
            return self._real_repository._add_revision(rev)
 
2005
        text = self._serializer.write_revision_to_string(rev)
 
2006
        key = (rev.revision_id,)
 
2007
        parents = tuple((parent,) for parent in rev.parent_ids)
 
2008
        self._write_group_tokens, missing_keys = self._get_sink().insert_stream(
 
2009
            [('revisions', [FulltextContentFactory(key, parents, None, text)])],
 
2010
            self._format, self._write_group_tokens)
 
2011
 
1281
2012
    def get_inventory(self, revision_id):
 
2013
        with self.lock_read():
 
2014
            return list(self.iter_inventories([revision_id]))[0]
 
2015
 
 
2016
    def _iter_inventories_rpc(self, revision_ids, ordering):
 
2017
        if ordering is None:
 
2018
            ordering = 'unordered'
 
2019
        path = self.controldir._path_for_remote_call(self._client)
 
2020
        body = b"\n".join(revision_ids)
 
2021
        response_tuple, response_handler = (
 
2022
            self._call_with_body_bytes_expecting_body(
 
2023
                b"VersionedFileRepository.get_inventories",
 
2024
                (path, ordering.encode('ascii')), body))
 
2025
        if response_tuple[0] != b"ok":
 
2026
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2027
        deserializer = inventory_delta.InventoryDeltaDeserializer()
 
2028
        byte_stream = response_handler.read_streamed_body()
 
2029
        decoded = smart_repo._byte_stream_to_stream(byte_stream)
 
2030
        if decoded is None:
 
2031
            # no results whatsoever
 
2032
            return
 
2033
        src_format, stream = decoded
 
2034
        if src_format.network_name() != self._format.network_name():
 
2035
            raise AssertionError(
 
2036
                "Mismatched RemoteRepository and stream src %r, %r" % (
 
2037
                    src_format.network_name(), self._format.network_name()))
 
2038
        # ignore the src format, it's not really relevant
 
2039
        prev_inv = Inventory(root_id=None,
 
2040
                             revision_id=_mod_revision.NULL_REVISION)
 
2041
        # there should be just one substream, with inventory deltas
 
2042
        try:
 
2043
            substream_kind, substream = next(stream)
 
2044
        except StopIteration:
 
2045
            return
 
2046
        if substream_kind != "inventory-deltas":
 
2047
            raise AssertionError(
 
2048
                "Unexpected stream %r received" % substream_kind)
 
2049
        for record in substream:
 
2050
            (parent_id, new_id, versioned_root, tree_references, invdelta) = (
 
2051
                deserializer.parse_text_bytes(record.get_bytes_as("fulltext")))
 
2052
            if parent_id != prev_inv.revision_id:
 
2053
                raise AssertionError("invalid base %r != %r" % (parent_id,
 
2054
                                                                prev_inv.revision_id))
 
2055
            inv = prev_inv.create_by_apply_delta(invdelta, new_id)
 
2056
            yield inv, inv.revision_id
 
2057
            prev_inv = inv
 
2058
 
 
2059
    def _iter_inventories_vfs(self, revision_ids, ordering=None):
1282
2060
        self._ensure_real()
1283
 
        return self._real_repository.get_inventory(revision_id)
 
2061
        return self._real_repository._iter_inventories(revision_ids, ordering)
1284
2062
 
1285
2063
    def iter_inventories(self, revision_ids, ordering=None):
1286
 
        self._ensure_real()
1287
 
        return self._real_repository.iter_inventories(revision_ids, ordering)
1288
 
 
1289
 
    @needs_read_lock
 
2064
        """Get many inventories by revision_ids.
 
2065
 
 
2066
        This will buffer some or all of the texts used in constructing the
 
2067
        inventories in memory, but will only parse a single inventory at a
 
2068
        time.
 
2069
 
 
2070
        :param revision_ids: The expected revision ids of the inventories.
 
2071
        :param ordering: optional ordering, e.g. 'topological'.  If not
 
2072
            specified, the order of revision_ids will be preserved (by
 
2073
            buffering if necessary).
 
2074
        :return: An iterator of inventories.
 
2075
        """
 
2076
        if ((None in revision_ids) or
 
2077
                (_mod_revision.NULL_REVISION in revision_ids)):
 
2078
            raise ValueError('cannot get null revision inventory')
 
2079
        for inv, revid in self._iter_inventories(revision_ids, ordering):
 
2080
            if inv is None:
 
2081
                raise errors.NoSuchRevision(self, revid)
 
2082
            yield inv
 
2083
 
 
2084
    def _iter_inventories(self, revision_ids, ordering=None):
 
2085
        if len(revision_ids) == 0:
 
2086
            return
 
2087
        missing = set(revision_ids)
 
2088
        if ordering is None:
 
2089
            order_as_requested = True
 
2090
            invs = {}
 
2091
            order = list(revision_ids)
 
2092
            order.reverse()
 
2093
            next_revid = order.pop()
 
2094
        else:
 
2095
            order_as_requested = False
 
2096
            if ordering != 'unordered' and self._fallback_repositories:
 
2097
                raise ValueError('unsupported ordering %r' % ordering)
 
2098
        iter_inv_fns = [self._iter_inventories_rpc] + [
 
2099
            fallback._iter_inventories for fallback in
 
2100
            self._fallback_repositories]
 
2101
        try:
 
2102
            for iter_inv in iter_inv_fns:
 
2103
                request = [revid for revid in revision_ids if revid in missing]
 
2104
                for inv, revid in iter_inv(request, ordering):
 
2105
                    if inv is None:
 
2106
                        continue
 
2107
                    missing.remove(inv.revision_id)
 
2108
                    if ordering != 'unordered':
 
2109
                        invs[revid] = inv
 
2110
                    else:
 
2111
                        yield inv, revid
 
2112
                if order_as_requested:
 
2113
                    # Yield as many results as we can while preserving order.
 
2114
                    while next_revid in invs:
 
2115
                        inv = invs.pop(next_revid)
 
2116
                        yield inv, inv.revision_id
 
2117
                        try:
 
2118
                            next_revid = order.pop()
 
2119
                        except IndexError:
 
2120
                            # We still want to fully consume the stream, just
 
2121
                            # in case it is not actually finished at this point
 
2122
                            next_revid = None
 
2123
                            break
 
2124
        except errors.UnknownSmartMethod:
 
2125
            for inv, revid in self._iter_inventories_vfs(revision_ids, ordering):
 
2126
                yield inv, revid
 
2127
            return
 
2128
        # Report missing
 
2129
        if order_as_requested:
 
2130
            if next_revid is not None:
 
2131
                yield None, next_revid
 
2132
            while order:
 
2133
                revid = order.pop()
 
2134
                yield invs.get(revid), revid
 
2135
        else:
 
2136
            while missing:
 
2137
                yield None, missing.pop()
 
2138
 
1290
2139
    def get_revision(self, revision_id):
1291
 
        self._ensure_real()
1292
 
        return self._real_repository.get_revision(revision_id)
 
2140
        with self.lock_read():
 
2141
            return self.get_revisions([revision_id])[0]
1293
2142
 
1294
2143
    def get_transaction(self):
1295
2144
        self._ensure_real()
1296
2145
        return self._real_repository.get_transaction()
1297
2146
 
1298
 
    @needs_read_lock
1299
 
    def clone(self, a_bzrdir, revision_id=None):
1300
 
        self._ensure_real()
1301
 
        return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
 
2147
    def clone(self, a_controldir, revision_id=None):
 
2148
        with self.lock_read():
 
2149
            dest_repo = self._create_sprouting_repo(
 
2150
                a_controldir, shared=self.is_shared())
 
2151
            self.copy_content_into(dest_repo, revision_id)
 
2152
            return dest_repo
1302
2153
 
1303
2154
    def make_working_trees(self):
1304
2155
        """See Repository.make_working_trees"""
1305
 
        self._ensure_real()
1306
 
        return self._real_repository.make_working_trees()
 
2156
        path = self.controldir._path_for_remote_call(self._client)
 
2157
        try:
 
2158
            response = self._call(b'Repository.make_working_trees', path)
 
2159
        except errors.UnknownSmartMethod:
 
2160
            self._ensure_real()
 
2161
            return self._real_repository.make_working_trees()
 
2162
        if response[0] not in (b'yes', b'no'):
 
2163
            raise SmartProtocolError(
 
2164
                'unexpected response code %s' % (response,))
 
2165
        return response[0] == b'yes'
1307
2166
 
1308
2167
    def refresh_data(self):
1309
 
        """Re-read any data needed to to synchronise with disk.
 
2168
        """Re-read any data needed to synchronise with disk.
1310
2169
 
1311
2170
        This method is intended to be called after another repository instance
1312
2171
        (such as one used by a smart server) has inserted data into the
1313
 
        repository. It may not be called during a write group, but may be
1314
 
        called at any other time.
 
2172
        repository. On all repositories this will work outside of write groups.
 
2173
        Some repository formats (pack and newer for breezy native formats)
 
2174
        support refresh_data inside write groups. If called inside a write
 
2175
        group on a repository that does not support refreshing in a write group
 
2176
        IsInWriteGroupError will be raised.
1315
2177
        """
1316
 
        if self.is_in_write_group():
1317
 
            raise errors.InternalBzrError(
1318
 
                "May not refresh_data while in a write group.")
1319
2178
        if self._real_repository is not None:
1320
2179
            self._real_repository.refresh_data()
 
2180
        # Refresh the parents cache for this object
 
2181
        self._unstacked_provider.disable_cache()
 
2182
        self._unstacked_provider.enable_cache()
1321
2183
 
1322
2184
    def revision_ids_to_search_result(self, result_set):
1323
2185
        """Convert a set of revision ids to a graph SearchResult."""
1324
2186
        result_parents = set()
1325
 
        for parents in self.get_graph().get_parent_map(
1326
 
            result_set).itervalues():
 
2187
        for parents in viewvalues(self.get_graph().get_parent_map(result_set)):
1327
2188
            result_parents.update(parents)
1328
2189
        included_keys = result_set.intersection(result_parents)
1329
2190
        start_keys = result_set.difference(included_keys)
1330
2191
        exclude_keys = result_parents.difference(result_set)
1331
 
        result = graph.SearchResult(start_keys, exclude_keys,
1332
 
            len(result_set), result_set)
 
2192
        result = vf_search.SearchResult(start_keys, exclude_keys,
 
2193
                                        len(result_set), result_set)
1333
2194
        return result
1334
2195
 
1335
 
    @needs_read_lock
1336
 
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
2196
    def search_missing_revision_ids(self, other,
 
2197
                                    find_ghosts=True, revision_ids=None, if_present_ids=None,
 
2198
                                    limit=None):
1337
2199
        """Return the revision ids that other has that this does not.
1338
2200
 
1339
2201
        These are returned in topological order.
1340
2202
 
1341
2203
        revision_id: only return revision ids included by revision_id.
1342
2204
        """
1343
 
        return repository.InterRepository.get(
1344
 
            other, self).search_missing_revision_ids(revision_id, find_ghosts)
 
2205
        with self.lock_read():
 
2206
            inter_repo = _mod_repository.InterRepository.get(other, self)
 
2207
            return inter_repo.search_missing_revision_ids(
 
2208
                find_ghosts=find_ghosts, revision_ids=revision_ids,
 
2209
                if_present_ids=if_present_ids, limit=limit)
1345
2210
 
1346
 
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
1347
 
            fetch_spec=None):
 
2211
    def fetch(self, source, revision_id=None, find_ghosts=False,
 
2212
              fetch_spec=None):
1348
2213
        # No base implementation to use as RemoteRepository is not a subclass
1349
2214
        # of Repository; so this is a copy of Repository.fetch().
1350
2215
        if fetch_spec is not None and revision_id is not None:
1354
2219
            raise errors.InternalBzrError(
1355
2220
                "May not fetch while in a write group.")
1356
2221
        # fast path same-url fetch operations
1357
 
        if (self.has_same_location(source)
1358
 
            and fetch_spec is None
1359
 
            and self._has_same_fallbacks(source)):
 
2222
        if (self.has_same_location(source) and
 
2223
            fetch_spec is None and
 
2224
                self._has_same_fallbacks(source)):
1360
2225
            # check that last_revision is in 'from' and then return a
1361
2226
            # no-operation.
1362
 
            if (revision_id is not None and
1363
 
                not revision.is_null(revision_id)):
 
2227
            if (revision_id is not None
 
2228
                    and not _mod_revision.is_null(revision_id)):
1364
2229
                self.get_revision(revision_id)
1365
2230
            return 0, []
1366
2231
        # if there is no specific appropriate InterRepository, this will get
1367
2232
        # the InterRepository base class, which raises an
1368
2233
        # IncompatibleRepositories when asked to fetch.
1369
 
        inter = repository.InterRepository.get(source, self)
1370
 
        return inter.fetch(revision_id=revision_id, pb=pb,
1371
 
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
 
2234
        inter = _mod_repository.InterRepository.get(source, self)
 
2235
        if (fetch_spec is not None
 
2236
                and not getattr(inter, "supports_fetch_spec", False)):
 
2237
            raise errors.UnsupportedOperation(
 
2238
                "fetch_spec not supported for %r" % inter)
 
2239
        return inter.fetch(revision_id=revision_id,
 
2240
                           find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1372
2241
 
1373
2242
    def create_bundle(self, target, base, fileobj, format=None):
1374
2243
        self._ensure_real()
1375
2244
        self._real_repository.create_bundle(target, base, fileobj, format)
1376
2245
 
1377
 
    @needs_read_lock
1378
 
    def get_ancestry(self, revision_id, topo_sorted=True):
1379
 
        self._ensure_real()
1380
 
        return self._real_repository.get_ancestry(revision_id, topo_sorted)
1381
 
 
1382
2246
    def fileids_altered_by_revision_ids(self, revision_ids):
1383
2247
        self._ensure_real()
1384
2248
        return self._real_repository.fileids_altered_by_revision_ids(revision_ids)
1388
2252
        return self._real_repository._get_versioned_file_checker(
1389
2253
            revisions, revision_versions_cache)
1390
2254
 
 
2255
    def _iter_files_bytes_rpc(self, desired_files, absent):
 
2256
        path = self.controldir._path_for_remote_call(self._client)
 
2257
        lines = []
 
2258
        identifiers = []
 
2259
        for (file_id, revid, identifier) in desired_files:
 
2260
            lines.append(b''.join([
 
2261
                osutils.safe_file_id(file_id),
 
2262
                b'\0',
 
2263
                osutils.safe_revision_id(revid)]))
 
2264
            identifiers.append(identifier)
 
2265
        (response_tuple, response_handler) = (
 
2266
            self._call_with_body_bytes_expecting_body(
 
2267
                b"Repository.iter_files_bytes", (path, ), b"\n".join(lines)))
 
2268
        if response_tuple != (b'ok', ):
 
2269
            response_handler.cancel_read_body()
 
2270
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2271
        byte_stream = response_handler.read_streamed_body()
 
2272
 
 
2273
        def decompress_stream(start, byte_stream, unused):
 
2274
            decompressor = zlib.decompressobj()
 
2275
            yield decompressor.decompress(start)
 
2276
            while decompressor.unused_data == b"":
 
2277
                try:
 
2278
                    data = next(byte_stream)
 
2279
                except StopIteration:
 
2280
                    break
 
2281
                yield decompressor.decompress(data)
 
2282
            yield decompressor.flush()
 
2283
            unused.append(decompressor.unused_data)
 
2284
        unused = b""
 
2285
        while True:
 
2286
            while b"\n" not in unused:
 
2287
                try:
 
2288
                    unused += next(byte_stream)
 
2289
                except StopIteration:
 
2290
                    return
 
2291
            header, rest = unused.split(b"\n", 1)
 
2292
            args = header.split(b"\0")
 
2293
            if args[0] == b"absent":
 
2294
                absent[identifiers[int(args[3])]] = (args[1], args[2])
 
2295
                unused = rest
 
2296
                continue
 
2297
            elif args[0] == b"ok":
 
2298
                idx = int(args[1])
 
2299
            else:
 
2300
                raise errors.UnexpectedSmartServerResponse(args)
 
2301
            unused_chunks = []
 
2302
            yield (identifiers[idx],
 
2303
                   decompress_stream(rest, byte_stream, unused_chunks))
 
2304
            unused = b"".join(unused_chunks)
 
2305
 
1391
2306
    def iter_files_bytes(self, desired_files):
1392
2307
        """See Repository.iter_file_bytes.
1393
2308
        """
1394
 
        self._ensure_real()
1395
 
        return self._real_repository.iter_files_bytes(desired_files)
 
2309
        try:
 
2310
            absent = {}
 
2311
            for (identifier, bytes_iterator) in self._iter_files_bytes_rpc(
 
2312
                    desired_files, absent):
 
2313
                yield identifier, bytes_iterator
 
2314
            for fallback in self._fallback_repositories:
 
2315
                if not absent:
 
2316
                    break
 
2317
                desired_files = [(key[0], key[1], identifier)
 
2318
                                 for identifier, key in viewitems(absent)]
 
2319
                for (identifier, bytes_iterator) in fallback.iter_files_bytes(desired_files):
 
2320
                    del absent[identifier]
 
2321
                    yield identifier, bytes_iterator
 
2322
            if absent:
 
2323
                # There may be more missing items, but raise an exception
 
2324
                # for just one.
 
2325
                missing_identifier = next(iter(absent))
 
2326
                missing_key = absent[missing_identifier]
 
2327
                raise errors.RevisionNotPresent(revision_id=missing_key[1],
 
2328
                                                file_id=missing_key[0])
 
2329
        except errors.UnknownSmartMethod:
 
2330
            self._ensure_real()
 
2331
            for (identifier, bytes_iterator) in (
 
2332
                    self._real_repository.iter_files_bytes(desired_files)):
 
2333
                yield identifier, bytes_iterator
 
2334
 
 
2335
    def get_cached_parent_map(self, revision_ids):
 
2336
        """See breezy.CachingParentsProvider.get_cached_parent_map"""
 
2337
        return self._unstacked_provider.get_cached_parent_map(revision_ids)
1396
2338
 
1397
2339
    def get_parent_map(self, revision_ids):
1398
 
        """See bzrlib.Graph.get_parent_map()."""
 
2340
        """See breezy.Graph.get_parent_map()."""
1399
2341
        return self._make_parents_provider().get_parent_map(revision_ids)
1400
2342
 
1401
2343
    def _get_parent_map_rpc(self, keys):
1420
2362
            # There is one other "bug" which is that ghosts in
1421
2363
            # get_revision_graph() are not returned at all. But we won't worry
1422
2364
            # about that for now.
1423
 
            for node_id, parent_ids in rg.iteritems():
 
2365
            for node_id, parent_ids in viewitems(rg):
1424
2366
                if parent_ids == ():
1425
2367
                    rg[node_id] = (NULL_REVISION,)
1426
2368
            rg[NULL_REVISION] = ()
1431
2373
            raise ValueError('get_parent_map(None) is not valid')
1432
2374
        if NULL_REVISION in keys:
1433
2375
            keys.discard(NULL_REVISION)
1434
 
            found_parents = {NULL_REVISION:()}
 
2376
            found_parents = {NULL_REVISION: ()}
1435
2377
            if not keys:
1436
2378
                return found_parents
1437
2379
        else:
1457
2399
        if parents_map is None:
1458
2400
            # Repository is not locked, so there's no cache.
1459
2401
            parents_map = {}
1460
 
        # start_set is all the keys in the cache
1461
 
        start_set = set(parents_map)
1462
 
        # result set is all the references to keys in the cache
1463
 
        result_parents = set()
1464
 
        for parents in parents_map.itervalues():
1465
 
            result_parents.update(parents)
1466
 
        stop_keys = result_parents.difference(start_set)
1467
 
        # We don't need to send ghosts back to the server as a position to
1468
 
        # stop either.
1469
 
        stop_keys.difference_update(self._unstacked_provider.missing_keys)
1470
 
        key_count = len(parents_map)
1471
 
        if (NULL_REVISION in result_parents
1472
 
            and NULL_REVISION in self._unstacked_provider.missing_keys):
1473
 
            # If we pruned NULL_REVISION from the stop_keys because it's also
1474
 
            # in our cache of "missing" keys we need to increment our key count
1475
 
            # by 1, because the reconsitituted SearchResult on the server will
1476
 
            # still consider NULL_REVISION to be an included key.
1477
 
            key_count += 1
1478
 
        included_keys = start_set.intersection(result_parents)
1479
 
        start_set.difference_update(included_keys)
 
2402
        if _DEFAULT_SEARCH_DEPTH <= 0:
 
2403
            (start_set, stop_keys,
 
2404
             key_count) = vf_search.search_result_from_parent_map(
 
2405
                parents_map, self._unstacked_provider.missing_keys)
 
2406
        else:
 
2407
            (start_set, stop_keys,
 
2408
             key_count) = vf_search.limited_search_result_from_parent_map(
 
2409
                parents_map, self._unstacked_provider.missing_keys,
 
2410
                keys, depth=_DEFAULT_SEARCH_DEPTH)
1480
2411
        recipe = ('manual', start_set, stop_keys, key_count)
1481
2412
        body = self._serialise_search_recipe(recipe)
1482
 
        path = self.bzrdir._path_for_remote_call(self._client)
 
2413
        path = self.controldir._path_for_remote_call(self._client)
1483
2414
        for key in keys:
1484
 
            if type(key) is not str:
 
2415
            if not isinstance(key, bytes):
1485
2416
                raise ValueError(
1486
 
                    "key %r not a plain string" % (key,))
1487
 
        verb = 'Repository.get_parent_map'
1488
 
        args = (path, 'include-missing:') + tuple(keys)
 
2417
                    "key %r not a bytes string" % (key,))
 
2418
        verb = b'Repository.get_parent_map'
 
2419
        args = (path, b'include-missing:') + tuple(keys)
1489
2420
        try:
1490
2421
            response = self._call_with_body_bytes_expecting_body(
1491
2422
                verb, args, body)
1504
2435
            # Recurse just once and we should use the fallback code.
1505
2436
            return self._get_parent_map_rpc(keys)
1506
2437
        response_tuple, response_handler = response
1507
 
        if response_tuple[0] not in ['ok']:
 
2438
        if response_tuple[0] not in [b'ok']:
1508
2439
            response_handler.cancel_read_body()
1509
2440
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1510
 
        if response_tuple[0] == 'ok':
 
2441
        if response_tuple[0] == b'ok':
1511
2442
            coded = bz2.decompress(response_handler.read_body_bytes())
1512
 
            if coded == '':
 
2443
            if coded == b'':
1513
2444
                # no revisions found
1514
2445
                return {}
1515
 
            lines = coded.split('\n')
 
2446
            lines = coded.split(b'\n')
1516
2447
            revision_graph = {}
1517
2448
            for line in lines:
1518
2449
                d = tuple(line.split())
1520
2451
                    revision_graph[d[0]] = d[1:]
1521
2452
                else:
1522
2453
                    # No parents:
1523
 
                    if d[0].startswith('missing:'):
 
2454
                    if d[0].startswith(b'missing:'):
1524
2455
                        revid = d[0][8:]
1525
2456
                        self._unstacked_provider.note_missing_key(revid)
1526
2457
                    else:
1529
2460
                        revision_graph[d[0]] = (NULL_REVISION,)
1530
2461
            return revision_graph
1531
2462
 
1532
 
    @needs_read_lock
1533
2463
    def get_signature_text(self, revision_id):
1534
 
        self._ensure_real()
1535
 
        return self._real_repository.get_signature_text(revision_id)
 
2464
        with self.lock_read():
 
2465
            path = self.controldir._path_for_remote_call(self._client)
 
2466
            try:
 
2467
                response_tuple, response_handler = self._call_expecting_body(
 
2468
                    b'Repository.get_revision_signature_text', path, revision_id)
 
2469
            except errors.UnknownSmartMethod:
 
2470
                self._ensure_real()
 
2471
                return self._real_repository.get_signature_text(revision_id)
 
2472
            except errors.NoSuchRevision as err:
 
2473
                for fallback in self._fallback_repositories:
 
2474
                    try:
 
2475
                        return fallback.get_signature_text(revision_id)
 
2476
                    except errors.NoSuchRevision:
 
2477
                        pass
 
2478
                raise err
 
2479
            else:
 
2480
                if response_tuple[0] != b'ok':
 
2481
                    raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2482
                return response_handler.read_body_bytes()
1536
2483
 
1537
 
    @needs_read_lock
1538
2484
    def _get_inventory_xml(self, revision_id):
1539
 
        self._ensure_real()
1540
 
        return self._real_repository._get_inventory_xml(revision_id)
 
2485
        with self.lock_read():
 
2486
            # This call is used by older working tree formats,
 
2487
            # which stored a serialized basis inventory.
 
2488
            self._ensure_real()
 
2489
            return self._real_repository._get_inventory_xml(revision_id)
1541
2490
 
1542
2491
    def reconcile(self, other=None, thorough=False):
1543
 
        self._ensure_real()
1544
 
        return self._real_repository.reconcile(other=other, thorough=thorough)
 
2492
        from ..reconcile import ReconcileResult
 
2493
        with self.lock_write():
 
2494
            path = self.controldir._path_for_remote_call(self._client)
 
2495
            try:
 
2496
                response, handler = self._call_expecting_body(
 
2497
                    b'Repository.reconcile', path, self._lock_token)
 
2498
            except (errors.UnknownSmartMethod, errors.TokenLockingNotSupported):
 
2499
                self._ensure_real()
 
2500
                return self._real_repository.reconcile(other=other, thorough=thorough)
 
2501
            if response != (b'ok', ):
 
2502
                raise errors.UnexpectedSmartServerResponse(response)
 
2503
            body = handler.read_body_bytes()
 
2504
            result = ReconcileResult()
 
2505
            result.garbage_inventories = None
 
2506
            result.inconsistent_parents = None
 
2507
            result.aborted = None
 
2508
            for line in body.split(b'\n'):
 
2509
                if not line:
 
2510
                    continue
 
2511
                key, val_text = line.split(b':')
 
2512
                if key == b"garbage_inventories":
 
2513
                    result.garbage_inventories = int(val_text)
 
2514
                elif key == b"inconsistent_parents":
 
2515
                    result.inconsistent_parents = int(val_text)
 
2516
                else:
 
2517
                    mutter("unknown reconcile key %r" % key)
 
2518
            return result
1545
2519
 
1546
2520
    def all_revision_ids(self):
1547
 
        self._ensure_real()
1548
 
        return self._real_repository.all_revision_ids()
1549
 
 
1550
 
    @needs_read_lock
 
2521
        path = self.controldir._path_for_remote_call(self._client)
 
2522
        try:
 
2523
            response_tuple, response_handler = self._call_expecting_body(
 
2524
                b"Repository.all_revision_ids", path)
 
2525
        except errors.UnknownSmartMethod:
 
2526
            self._ensure_real()
 
2527
            return self._real_repository.all_revision_ids()
 
2528
        if response_tuple != (b"ok", ):
 
2529
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2530
        revids = set(response_handler.read_body_bytes().splitlines())
 
2531
        for fallback in self._fallback_repositories:
 
2532
            revids.update(set(fallback.all_revision_ids()))
 
2533
        return list(revids)
 
2534
 
 
2535
    def _filtered_revision_trees(self, revision_ids, file_ids):
 
2536
        """Return Tree for a revision on this branch with only some files.
 
2537
 
 
2538
        :param revision_ids: a sequence of revision-ids;
 
2539
          a revision-id may not be None or b'null:'
 
2540
        :param file_ids: if not None, the result is filtered
 
2541
          so that only those file-ids, their parents and their
 
2542
          children are included.
 
2543
        """
 
2544
        inventories = self.iter_inventories(revision_ids)
 
2545
        for inv in inventories:
 
2546
            # Should we introduce a FilteredRevisionTree class rather
 
2547
            # than pre-filter the inventory here?
 
2548
            filtered_inv = inv.filter(file_ids)
 
2549
            yield InventoryRevisionTree(self, filtered_inv, filtered_inv.revision_id)
 
2550
 
1551
2551
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1552
 
        self._ensure_real()
1553
 
        return self._real_repository.get_deltas_for_revisions(revisions,
1554
 
            specific_fileids=specific_fileids)
1555
 
 
1556
 
    @needs_read_lock
1557
 
    def get_revision_delta(self, revision_id, specific_fileids=None):
1558
 
        self._ensure_real()
1559
 
        return self._real_repository.get_revision_delta(revision_id,
1560
 
            specific_fileids=specific_fileids)
1561
 
 
1562
 
    @needs_read_lock
 
2552
        with self.lock_read():
 
2553
            medium = self._client._medium
 
2554
            if medium._is_remote_before((1, 2)):
 
2555
                self._ensure_real()
 
2556
                for delta in self._real_repository.get_deltas_for_revisions(
 
2557
                        revisions, specific_fileids):
 
2558
                    yield delta
 
2559
                return
 
2560
            # Get the revision-ids of interest
 
2561
            required_trees = set()
 
2562
            for revision in revisions:
 
2563
                required_trees.add(revision.revision_id)
 
2564
                required_trees.update(revision.parent_ids[:1])
 
2565
 
 
2566
            # Get the matching filtered trees. Note that it's more
 
2567
            # efficient to pass filtered trees to changes_from() rather
 
2568
            # than doing the filtering afterwards. changes_from() could
 
2569
            # arguably do the filtering itself but it's path-based, not
 
2570
            # file-id based, so filtering before or afterwards is
 
2571
            # currently easier.
 
2572
            if specific_fileids is None:
 
2573
                trees = dict((t.get_revision_id(), t) for
 
2574
                             t in self.revision_trees(required_trees))
 
2575
            else:
 
2576
                trees = dict((t.get_revision_id(), t) for
 
2577
                             t in self._filtered_revision_trees(required_trees,
 
2578
                                                                specific_fileids))
 
2579
 
 
2580
            # Calculate the deltas
 
2581
            for revision in revisions:
 
2582
                if not revision.parent_ids:
 
2583
                    old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
 
2584
                else:
 
2585
                    old_tree = trees[revision.parent_ids[0]]
 
2586
                yield trees[revision.revision_id].changes_from(old_tree)
 
2587
 
 
2588
    def get_revision_delta(self, revision_id):
 
2589
        with self.lock_read():
 
2590
            r = self.get_revision(revision_id)
 
2591
            return list(self.get_deltas_for_revisions([r]))[0]
 
2592
 
1563
2593
    def revision_trees(self, revision_ids):
1564
 
        self._ensure_real()
1565
 
        return self._real_repository.revision_trees(revision_ids)
 
2594
        with self.lock_read():
 
2595
            inventories = self.iter_inventories(revision_ids)
 
2596
            for inv in inventories:
 
2597
                yield RemoteInventoryTree(self, inv, inv.revision_id)
1566
2598
 
1567
 
    @needs_read_lock
1568
2599
    def get_revision_reconcile(self, revision_id):
1569
 
        self._ensure_real()
1570
 
        return self._real_repository.get_revision_reconcile(revision_id)
 
2600
        with self.lock_read():
 
2601
            self._ensure_real()
 
2602
            return self._real_repository.get_revision_reconcile(revision_id)
1571
2603
 
1572
 
    @needs_read_lock
1573
2604
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
1574
 
        self._ensure_real()
1575
 
        return self._real_repository.check(revision_ids=revision_ids,
1576
 
            callback_refs=callback_refs, check_repo=check_repo)
 
2605
        with self.lock_read():
 
2606
            self._ensure_real()
 
2607
            return self._real_repository.check(revision_ids=revision_ids,
 
2608
                                               callback_refs=callback_refs, check_repo=check_repo)
1577
2609
 
1578
2610
    def copy_content_into(self, destination, revision_id=None):
1579
 
        self._ensure_real()
1580
 
        return self._real_repository.copy_content_into(
1581
 
            destination, revision_id=revision_id)
 
2611
        """Make a complete copy of the content in self into destination.
 
2612
 
 
2613
        This is a destructive operation! Do not use it on existing
 
2614
        repositories.
 
2615
        """
 
2616
        interrepo = _mod_repository.InterRepository.get(self, destination)
 
2617
        return interrepo.copy_content(revision_id)
1582
2618
 
1583
2619
    def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
1584
2620
        # get a tarball of the remote repository, and copy from that into the
1585
2621
        # destination
1586
 
        from bzrlib import osutils
1587
2622
        import tarfile
1588
2623
        # TODO: Maybe a progress bar while streaming the tarball?
1589
 
        note("Copying repository content as tarball...")
 
2624
        note(gettext("Copying repository content as tarball..."))
1590
2625
        tar_file = self._get_tarball('bz2')
1591
2626
        if tar_file is None:
1592
2627
            return None
1593
2628
        destination = to_bzrdir.create_repository()
1594
2629
        try:
1595
2630
            tar = tarfile.open('repository', fileobj=tar_file,
1596
 
                mode='r|bz2')
 
2631
                               mode='r|bz2')
1597
2632
            tmpdir = osutils.mkdtemp()
1598
2633
            try:
1599
 
                _extract_tar(tar, tmpdir)
1600
 
                tmp_bzrdir = BzrDir.open(tmpdir)
 
2634
                tar.extractall(tmpdir)
 
2635
                tmp_bzrdir = _mod_bzrdir.BzrDir.open(tmpdir)
1601
2636
                tmp_repo = tmp_bzrdir.open_repository()
1602
2637
                tmp_repo.copy_content_into(destination, revision_id)
1603
2638
            finally:
1618
2653
        self._ensure_real()
1619
2654
        return self._real_repository.inventories
1620
2655
 
1621
 
    @needs_write_lock
1622
2656
    def pack(self, hint=None, clean_obsolete_packs=False):
1623
2657
        """Compress the data within the repository.
1624
 
 
1625
 
        This is not currently implemented within the smart server.
1626
2658
        """
1627
 
        self._ensure_real()
1628
 
        return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
 
2659
        if hint is None:
 
2660
            body = b""
 
2661
        else:
 
2662
            body = b"".join([l.encode('ascii') + b"\n" for l in hint])
 
2663
        with self.lock_write():
 
2664
            path = self.controldir._path_for_remote_call(self._client)
 
2665
            try:
 
2666
                response, handler = self._call_with_body_bytes_expecting_body(
 
2667
                    b'Repository.pack', (path, self._lock_token,
 
2668
                                         str(clean_obsolete_packs).encode('ascii')), body)
 
2669
            except errors.UnknownSmartMethod:
 
2670
                self._ensure_real()
 
2671
                return self._real_repository.pack(hint=hint,
 
2672
                                                  clean_obsolete_packs=clean_obsolete_packs)
 
2673
            handler.cancel_read_body()
 
2674
            if response != (b'ok', ):
 
2675
                raise errors.UnexpectedSmartServerResponse(response)
1629
2676
 
1630
2677
    @property
1631
2678
    def revisions(self):
1632
2679
        """Decorate the real repository for now.
1633
2680
 
1634
 
        In the short term this should become a real object to intercept graph
1635
 
        lookups.
1636
 
 
1637
2681
        In the long term a full blown network facility is needed.
1638
2682
        """
1639
2683
        self._ensure_real()
1641
2685
 
1642
2686
    def set_make_working_trees(self, new_value):
1643
2687
        if new_value:
1644
 
            new_value_str = "True"
 
2688
            new_value_str = b"True"
1645
2689
        else:
1646
 
            new_value_str = "False"
1647
 
        path = self.bzrdir._path_for_remote_call(self._client)
 
2690
            new_value_str = b"False"
 
2691
        path = self.controldir._path_for_remote_call(self._client)
1648
2692
        try:
1649
2693
            response = self._call(
1650
 
                'Repository.set_make_working_trees', path, new_value_str)
 
2694
                b'Repository.set_make_working_trees', path, new_value_str)
1651
2695
        except errors.UnknownSmartMethod:
1652
2696
            self._ensure_real()
1653
2697
            self._real_repository.set_make_working_trees(new_value)
1654
2698
        else:
1655
 
            if response[0] != 'ok':
 
2699
            if response[0] != b'ok':
1656
2700
                raise errors.UnexpectedSmartServerResponse(response)
1657
2701
 
1658
2702
    @property
1665
2709
        self._ensure_real()
1666
2710
        return self._real_repository.signatures
1667
2711
 
1668
 
    @needs_write_lock
1669
2712
    def sign_revision(self, revision_id, gpg_strategy):
1670
 
        self._ensure_real()
1671
 
        return self._real_repository.sign_revision(revision_id, gpg_strategy)
 
2713
        with self.lock_write():
 
2714
            testament = _mod_testament.Testament.from_revision(
 
2715
                self, revision_id)
 
2716
            plaintext = testament.as_short_text()
 
2717
            self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1672
2718
 
1673
2719
    @property
1674
2720
    def texts(self):
1680
2726
        self._ensure_real()
1681
2727
        return self._real_repository.texts
1682
2728
 
1683
 
    @needs_read_lock
1684
 
    def get_revisions(self, revision_ids):
1685
 
        self._ensure_real()
1686
 
        return self._real_repository.get_revisions(revision_ids)
 
2729
    def _iter_revisions_rpc(self, revision_ids):
 
2730
        body = b"\n".join(revision_ids)
 
2731
        path = self.controldir._path_for_remote_call(self._client)
 
2732
        response_tuple, response_handler = (
 
2733
            self._call_with_body_bytes_expecting_body(
 
2734
                b"Repository.iter_revisions", (path, ), body))
 
2735
        if response_tuple[0] != b"ok":
 
2736
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2737
        serializer_format = response_tuple[1].decode('ascii')
 
2738
        serializer = serializer_format_registry.get(serializer_format)
 
2739
        byte_stream = response_handler.read_streamed_body()
 
2740
        decompressor = zlib.decompressobj()
 
2741
        chunks = []
 
2742
        for bytes in byte_stream:
 
2743
            chunks.append(decompressor.decompress(bytes))
 
2744
            if decompressor.unused_data != b"":
 
2745
                chunks.append(decompressor.flush())
 
2746
                yield serializer.read_revision_from_string(b"".join(chunks))
 
2747
                unused = decompressor.unused_data
 
2748
                decompressor = zlib.decompressobj()
 
2749
                chunks = [decompressor.decompress(unused)]
 
2750
        chunks.append(decompressor.flush())
 
2751
        text = b"".join(chunks)
 
2752
        if text != b"":
 
2753
            yield serializer.read_revision_from_string(b"".join(chunks))
 
2754
 
 
2755
    def iter_revisions(self, revision_ids):
 
2756
        for rev_id in revision_ids:
 
2757
            if not rev_id or not isinstance(rev_id, bytes):
 
2758
                raise errors.InvalidRevisionId(
 
2759
                    revision_id=rev_id, branch=self)
 
2760
        with self.lock_read():
 
2761
            try:
 
2762
                missing = set(revision_ids)
 
2763
                for rev in self._iter_revisions_rpc(revision_ids):
 
2764
                    missing.remove(rev.revision_id)
 
2765
                    yield (rev.revision_id, rev)
 
2766
                for fallback in self._fallback_repositories:
 
2767
                    if not missing:
 
2768
                        break
 
2769
                    for (revid, rev) in fallback.iter_revisions(missing):
 
2770
                        if rev is not None:
 
2771
                            yield (revid, rev)
 
2772
                            missing.remove(revid)
 
2773
                for revid in missing:
 
2774
                    yield (revid, None)
 
2775
            except errors.UnknownSmartMethod:
 
2776
                self._ensure_real()
 
2777
                for entry in self._real_repository.iter_revisions(revision_ids):
 
2778
                    yield entry
1687
2779
 
1688
2780
    def supports_rich_root(self):
1689
2781
        return self._format.rich_root_data
1690
2782
 
1691
 
    def iter_reverse_revision_history(self, revision_id):
1692
 
        self._ensure_real()
1693
 
        return self._real_repository.iter_reverse_revision_history(revision_id)
1694
 
 
1695
2783
    @property
1696
2784
    def _serializer(self):
1697
2785
        return self._format._serializer
1698
2786
 
1699
2787
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1700
 
        self._ensure_real()
1701
 
        return self._real_repository.store_revision_signature(
1702
 
            gpg_strategy, plaintext, revision_id)
 
2788
        with self.lock_write():
 
2789
            signature = gpg_strategy.sign(plaintext, gpg.MODE_CLEAR)
 
2790
            self.add_signature_text(revision_id, signature)
1703
2791
 
1704
2792
    def add_signature_text(self, revision_id, signature):
1705
 
        self._ensure_real()
1706
 
        return self._real_repository.add_signature_text(revision_id, signature)
 
2793
        if self._real_repository:
 
2794
            # If there is a real repository the write group will
 
2795
            # be in the real repository as well, so use that:
 
2796
            self._ensure_real()
 
2797
            return self._real_repository.add_signature_text(
 
2798
                revision_id, signature)
 
2799
        path = self.controldir._path_for_remote_call(self._client)
 
2800
        response, handler = self._call_with_body_bytes_expecting_body(
 
2801
            b'Repository.add_signature_text', (path, self._lock_token,
 
2802
                                               revision_id) +
 
2803
            tuple([token.encode('utf-8')
 
2804
                   for token in self._write_group_tokens]),
 
2805
            signature)
 
2806
        handler.cancel_read_body()
 
2807
        self.refresh_data()
 
2808
        if response[0] != b'ok':
 
2809
            raise errors.UnexpectedSmartServerResponse(response)
 
2810
        self._write_group_tokens = [token.decode(
 
2811
            'utf-8') for token in response[1:]]
1707
2812
 
1708
2813
    def has_signature_for_revision_id(self, revision_id):
1709
 
        self._ensure_real()
1710
 
        return self._real_repository.has_signature_for_revision_id(revision_id)
 
2814
        path = self.controldir._path_for_remote_call(self._client)
 
2815
        try:
 
2816
            response = self._call(b'Repository.has_signature_for_revision_id',
 
2817
                                  path, revision_id)
 
2818
        except errors.UnknownSmartMethod:
 
2819
            self._ensure_real()
 
2820
            return self._real_repository.has_signature_for_revision_id(
 
2821
                revision_id)
 
2822
        if response[0] not in (b'yes', b'no'):
 
2823
            raise SmartProtocolError(
 
2824
                'unexpected response code %s' % (response,))
 
2825
        if response[0] == b'yes':
 
2826
            return True
 
2827
        for fallback in self._fallback_repositories:
 
2828
            if fallback.has_signature_for_revision_id(revision_id):
 
2829
                return True
 
2830
        return False
 
2831
 
 
2832
    def verify_revision_signature(self, revision_id, gpg_strategy):
 
2833
        with self.lock_read():
 
2834
            if not self.has_signature_for_revision_id(revision_id):
 
2835
                return gpg.SIGNATURE_NOT_SIGNED, None
 
2836
            signature = self.get_signature_text(revision_id)
 
2837
 
 
2838
            testament = _mod_testament.Testament.from_revision(
 
2839
                self, revision_id)
 
2840
 
 
2841
            (status, key, signed_plaintext) = gpg_strategy.verify(signature)
 
2842
            if testament.as_short_text() != signed_plaintext:
 
2843
                return gpg.SIGNATURE_NOT_VALID, None
 
2844
            return (status, key)
1711
2845
 
1712
2846
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1713
2847
        self._ensure_real()
1714
2848
        return self._real_repository.item_keys_introduced_by(revision_ids,
1715
 
            _files_pb=_files_pb)
1716
 
 
1717
 
    def revision_graph_can_have_wrong_parents(self):
1718
 
        # The answer depends on the remote repo format.
1719
 
        self._ensure_real()
1720
 
        return self._real_repository.revision_graph_can_have_wrong_parents()
 
2849
                                                             _files_pb=_files_pb)
1721
2850
 
1722
2851
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
1723
2852
        self._ensure_real()
1732
2861
        providers = [self._unstacked_provider]
1733
2862
        if other is not None:
1734
2863
            providers.insert(0, other)
1735
 
        providers.extend(r._make_parents_provider() for r in
1736
 
                         self._fallback_repositories)
1737
 
        return graph.StackedParentsProvider(providers)
 
2864
        return graph.StackedParentsProvider(_LazyListJoin(
 
2865
            providers, self._fallback_repositories))
1738
2866
 
1739
2867
    def _serialise_search_recipe(self, recipe):
1740
2868
        """Serialise a graph search recipe.
1742
2870
        :param recipe: A search recipe (start, stop, count).
1743
2871
        :return: Serialised bytes.
1744
2872
        """
1745
 
        start_keys = ' '.join(recipe[1])
1746
 
        stop_keys = ' '.join(recipe[2])
1747
 
        count = str(recipe[3])
1748
 
        return '\n'.join((start_keys, stop_keys, count))
 
2873
        start_keys = b' '.join(recipe[1])
 
2874
        stop_keys = b' '.join(recipe[2])
 
2875
        count = str(recipe[3]).encode('ascii')
 
2876
        return b'\n'.join((start_keys, stop_keys, count))
1749
2877
 
1750
2878
    def _serialise_search_result(self, search_result):
1751
 
        if isinstance(search_result, graph.PendingAncestryResult):
1752
 
            parts = ['ancestry-of']
1753
 
            parts.extend(search_result.heads)
1754
 
        else:
1755
 
            recipe = search_result.get_recipe()
1756
 
            parts = [recipe[0], self._serialise_search_recipe(recipe)]
1757
 
        return '\n'.join(parts)
 
2879
        parts = search_result.get_network_struct()
 
2880
        return b'\n'.join(parts)
1758
2881
 
1759
2882
    def autopack(self):
1760
 
        path = self.bzrdir._path_for_remote_call(self._client)
 
2883
        path = self.controldir._path_for_remote_call(self._client)
1761
2884
        try:
1762
 
            response = self._call('PackRepository.autopack', path)
 
2885
            response = self._call(b'PackRepository.autopack', path)
1763
2886
        except errors.UnknownSmartMethod:
1764
2887
            self._ensure_real()
1765
2888
            self._real_repository._pack_collection.autopack()
1766
2889
            return
1767
2890
        self.refresh_data()
1768
 
        if response[0] != 'ok':
1769
 
            raise errors.UnexpectedSmartServerResponse(response)
1770
 
 
1771
 
 
1772
 
class RemoteStreamSink(repository.StreamSink):
 
2891
        if response[0] != b'ok':
 
2892
            raise errors.UnexpectedSmartServerResponse(response)
 
2893
 
 
2894
    def _revision_archive(self, revision_id, format, name, root, subdir,
 
2895
                          force_mtime=None):
 
2896
        path = self.controldir._path_for_remote_call(self._client)
 
2897
        format = format or ''
 
2898
        root = root or ''
 
2899
        subdir = subdir or ''
 
2900
        force_mtime = int(force_mtime) if force_mtime is not None else None
 
2901
        try:
 
2902
            response, protocol = self._call_expecting_body(
 
2903
                b'Repository.revision_archive', path,
 
2904
                revision_id,
 
2905
                format.encode('ascii'),
 
2906
                os.path.basename(name).encode('utf-8'),
 
2907
                root.encode('utf-8'),
 
2908
                subdir.encode('utf-8'),
 
2909
                force_mtime)
 
2910
        except errors.UnknownSmartMethod:
 
2911
            return None
 
2912
        if response[0] == b'ok':
 
2913
            return iter([protocol.read_body_bytes()])
 
2914
        raise errors.UnexpectedSmartServerResponse(response)
 
2915
 
 
2916
    def _annotate_file_revision(self, revid, tree_path, file_id, default_revision):
 
2917
        path = self.controldir._path_for_remote_call(self._client)
 
2918
        tree_path = tree_path.encode('utf-8')
 
2919
        file_id = file_id or b''
 
2920
        default_revision = default_revision or b''
 
2921
        try:
 
2922
            response, handler = self._call_expecting_body(
 
2923
                b'Repository.annotate_file_revision', path,
 
2924
                revid, tree_path, file_id, default_revision)
 
2925
        except errors.UnknownSmartMethod:
 
2926
            return None
 
2927
        if response[0] != b'ok':
 
2928
            raise errors.UnexpectedSmartServerResponse(response)
 
2929
        return map(tuple, bencode.bdecode(handler.read_body_bytes()))
 
2930
 
 
2931
 
 
2932
class RemoteStreamSink(vf_repository.StreamSink):
1773
2933
 
1774
2934
    def _insert_real(self, stream, src_format, resume_tokens):
1775
2935
        self.target_repo._ensure_real()
1779
2939
            self.target_repo.autopack()
1780
2940
        return result
1781
2941
 
 
2942
    def insert_missing_keys(self, source, missing_keys):
 
2943
        if (isinstance(source, RemoteStreamSource)
 
2944
                and source.from_repository._client._medium == self.target_repo._client._medium):
 
2945
            # Streaming from and to the same medium is tricky, since we don't support
 
2946
            # more than one concurrent request. For now, just force VFS.
 
2947
            stream = source._get_real_stream_for_missing_keys(missing_keys)
 
2948
        else:
 
2949
            stream = source.get_stream_for_missing_keys(missing_keys)
 
2950
        return self.insert_stream_without_locking(stream,
 
2951
                                                  self.target_repo._format)
 
2952
 
1782
2953
    def insert_stream(self, stream, src_format, resume_tokens):
1783
2954
        target = self.target_repo
1784
2955
        target._unstacked_provider.missing_keys.clear()
1785
 
        candidate_calls = [('Repository.insert_stream_1.19', (1, 19))]
 
2956
        candidate_calls = [(b'Repository.insert_stream_1.19', (1, 19))]
1786
2957
        if target._lock_token:
1787
 
            candidate_calls.append(('Repository.insert_stream_locked', (1, 14)))
1788
 
            lock_args = (target._lock_token or '',)
 
2958
            candidate_calls.append(
 
2959
                (b'Repository.insert_stream_locked', (1, 14)))
 
2960
            lock_args = (target._lock_token or b'',)
1789
2961
        else:
1790
 
            candidate_calls.append(('Repository.insert_stream', (1, 13)))
 
2962
            candidate_calls.append((b'Repository.insert_stream', (1, 13)))
1791
2963
            lock_args = ()
1792
2964
        client = target._client
1793
2965
        medium = client._medium
1794
 
        path = target.bzrdir._path_for_remote_call(client)
 
2966
        path = target.controldir._path_for_remote_call(client)
1795
2967
        # Probe for the verb to use with an empty stream before sending the
1796
2968
        # real stream to it.  We do this both to avoid the risk of sending a
1797
2969
        # large request that is then rejected, and because we don't want to
1808
2980
            byte_stream = smart_repo._stream_to_byte_stream([], src_format)
1809
2981
            try:
1810
2982
                response = client.call_with_body_stream(
1811
 
                    (verb, path, '') + lock_args, byte_stream)
 
2983
                    (verb, path, b'') + lock_args, byte_stream)
1812
2984
            except errors.UnknownSmartMethod:
1813
2985
                medium._remember_remote_is_before(required_version)
1814
2986
            else:
1827
2999
            stream = self._stop_stream_if_inventory_delta(stream)
1828
3000
        byte_stream = smart_repo._stream_to_byte_stream(
1829
3001
            stream, src_format)
1830
 
        resume_tokens = ' '.join(resume_tokens)
 
3002
        resume_tokens = b' '.join([token.encode('utf-8')
 
3003
                                   for token in resume_tokens])
1831
3004
        response = client.call_with_body_stream(
1832
3005
            (verb, path, resume_tokens) + lock_args, byte_stream)
1833
 
        if response[0][0] not in ('ok', 'missing-basis'):
 
3006
        if response[0][0] not in (b'ok', b'missing-basis'):
1834
3007
            raise errors.UnexpectedSmartServerResponse(response)
1835
3008
        if self._last_substream is not None:
1836
3009
            # The stream included an inventory-delta record, but the remote
1838
3011
            # rest of the stream via VFS.
1839
3012
            self.target_repo.refresh_data()
1840
3013
            return self._resume_stream_with_vfs(response, src_format)
1841
 
        if response[0][0] == 'missing-basis':
 
3014
        if response[0][0] == b'missing-basis':
1842
3015
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
1843
 
            resume_tokens = tokens
1844
 
            return resume_tokens, set(missing_keys)
 
3016
            resume_tokens = [token.decode('utf-8') for token in tokens]
 
3017
            return resume_tokens, set((entry[0].decode('utf-8'), ) + entry[1:] for entry in missing_keys)
1845
3018
        else:
1846
3019
            self.target_repo.refresh_data()
1847
3020
            return [], set()
1850
3023
        """Resume sending a stream via VFS, first resending the record and
1851
3024
        substream that couldn't be sent via an insert_stream verb.
1852
3025
        """
1853
 
        if response[0][0] == 'missing-basis':
 
3026
        if response[0][0] == b'missing-basis':
1854
3027
            tokens, missing_keys = bencode.bdecode_as_tuple(response[0][1])
 
3028
            tokens = [token.decode('utf-8') for token in tokens]
1855
3029
            # Ignore missing_keys, we haven't finished inserting yet
1856
3030
        else:
1857
3031
            tokens = []
 
3032
 
1858
3033
        def resume_substream():
1859
3034
            # Yield the substream that was interrupted.
1860
3035
            for record in self._last_substream:
1861
3036
                yield record
1862
3037
            self._last_substream = None
 
3038
 
1863
3039
        def resume_stream():
1864
3040
            # Finish sending the interrupted substream
1865
3041
            yield ('inventory-deltas', resume_substream())
1876
3052
        self._last_substream and self._last_stream so that the stream can be
1877
3053
        resumed by _resume_stream_with_vfs.
1878
3054
        """
1879
 
                    
 
3055
 
1880
3056
        stream_iter = iter(stream)
1881
3057
        for substream_kind, substream in stream_iter:
1882
3058
            if substream_kind == 'inventory-deltas':
1885
3061
                return
1886
3062
            else:
1887
3063
                yield substream_kind, substream
1888
 
            
1889
 
 
1890
 
class RemoteStreamSource(repository.StreamSource):
 
3064
 
 
3065
 
 
3066
class RemoteStreamSource(vf_repository.StreamSource):
1891
3067
    """Stream data from a remote server."""
1892
3068
 
1893
3069
    def get_stream(self, search):
1894
 
        if (self.from_repository._fallback_repositories and
1895
 
            self.to_format._fetch_order == 'topological'):
 
3070
        if (self.from_repository._fallback_repositories
 
3071
                and self.to_format._fetch_order == 'topological'):
1896
3072
            return self._real_stream(self.from_repository, search)
1897
3073
        sources = []
1898
3074
        seen = set()
1906
3082
            sources.append(repo)
1907
3083
        return self.missing_parents_chain(search, sources)
1908
3084
 
1909
 
    def get_stream_for_missing_keys(self, missing_keys):
 
3085
    def _get_real_stream_for_missing_keys(self, missing_keys):
1910
3086
        self.from_repository._ensure_real()
1911
3087
        real_repo = self.from_repository._real_repository
1912
3088
        real_source = real_repo._get_source(self.to_format)
1913
3089
        return real_source.get_stream_for_missing_keys(missing_keys)
1914
3090
 
 
3091
    def get_stream_for_missing_keys(self, missing_keys):
 
3092
        if not isinstance(self.from_repository, RemoteRepository):
 
3093
            return self._get_real_stream_for_missing_keys(missing_keys)
 
3094
        client = self.from_repository._client
 
3095
        medium = client._medium
 
3096
        if medium._is_remote_before((3, 0)):
 
3097
            return self._get_real_stream_for_missing_keys(missing_keys)
 
3098
        path = self.from_repository.controldir._path_for_remote_call(client)
 
3099
        args = (path, self.to_format.network_name())
 
3100
        search_bytes = b'\n'.join(
 
3101
            [b'%s\t%s' % (key[0].encode('utf-8'), key[1]) for key in missing_keys])
 
3102
        try:
 
3103
            response, handler = self.from_repository._call_with_body_bytes_expecting_body(
 
3104
                b'Repository.get_stream_for_missing_keys', args, search_bytes)
 
3105
        except (errors.UnknownSmartMethod, errors.UnknownFormatError):
 
3106
            return self._get_real_stream_for_missing_keys(missing_keys)
 
3107
        if response[0] != b'ok':
 
3108
            raise errors.UnexpectedSmartServerResponse(response)
 
3109
        byte_stream = handler.read_streamed_body()
 
3110
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream,
 
3111
                                                               self._record_counter)
 
3112
        if src_format.network_name() != self.from_repository._format.network_name():
 
3113
            raise AssertionError(
 
3114
                "Mismatched RemoteRepository and stream src %r, %r" % (
 
3115
                    src_format.network_name(), repo._format.network_name()))
 
3116
        return stream
 
3117
 
1915
3118
    def _real_stream(self, repo, search):
1916
3119
        """Get a stream for search from repo.
1917
 
        
1918
 
        This never called RemoteStreamSource.get_stream, and is a heler
1919
 
        for RemoteStreamSource._get_stream to allow getting a stream 
 
3120
 
 
3121
        This never called RemoteStreamSource.get_stream, and is a helper
 
3122
        for RemoteStreamSource._get_stream to allow getting a stream
1920
3123
        reliably whether fallback back because of old servers or trying
1921
3124
        to stream from a non-RemoteRepository (which the stacked support
1922
3125
        code will do).
1947
3150
            return self._real_stream(repo, search)
1948
3151
        client = repo._client
1949
3152
        medium = client._medium
1950
 
        path = repo.bzrdir._path_for_remote_call(client)
 
3153
        path = repo.controldir._path_for_remote_call(client)
1951
3154
        search_bytes = repo._serialise_search_result(search)
1952
3155
        args = (path, self.to_format.network_name())
1953
3156
        candidate_verbs = [
1954
 
            ('Repository.get_stream_1.19', (1, 19)),
1955
 
            ('Repository.get_stream', (1, 13))]
 
3157
            (b'Repository.get_stream_1.19', (1, 19)),
 
3158
            (b'Repository.get_stream', (1, 13))]
 
3159
 
1956
3160
        found_verb = False
1957
3161
        for verb, version in candidate_verbs:
1958
3162
            if medium._is_remote_before(version):
1962
3166
                    verb, args, search_bytes)
1963
3167
            except errors.UnknownSmartMethod:
1964
3168
                medium._remember_remote_is_before(version)
 
3169
            except errors.UnknownErrorFromSmartServer as e:
 
3170
                if isinstance(search, vf_search.EverythingResult):
 
3171
                    error_verb = e.error_from_smart_server.error_verb
 
3172
                    if error_verb == b'BadSearch':
 
3173
                        # Pre-2.4 servers don't support this sort of search.
 
3174
                        # XXX: perhaps falling back to VFS on BadSearch is a
 
3175
                        # good idea in general?  It might provide a little bit
 
3176
                        # of protection against client-side bugs.
 
3177
                        medium._remember_remote_is_before((2, 4))
 
3178
                        break
 
3179
                raise
1965
3180
            else:
1966
3181
                response_tuple, response_handler = response
1967
3182
                found_verb = True
1968
3183
                break
1969
3184
        if not found_verb:
1970
3185
            return self._real_stream(repo, search)
1971
 
        if response_tuple[0] != 'ok':
 
3186
        if response_tuple[0] != b'ok':
1972
3187
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1973
3188
        byte_stream = response_handler.read_streamed_body()
1974
 
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
 
3189
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream,
 
3190
                                                               self._record_counter)
1975
3191
        if src_format.network_name() != repo._format.network_name():
1976
3192
            raise AssertionError(
1977
3193
                "Mismatched RemoteRepository and stream src %r, %r" % (
1978
 
                src_format.network_name(), repo._format.network_name()))
 
3194
                    src_format.network_name(), repo._format.network_name()))
1979
3195
        return stream
1980
3196
 
1981
3197
    def missing_parents_chain(self, search, sources):
2021
3237
    """
2022
3238
 
2023
3239
    def __init__(self, bzrdir, _client):
2024
 
        self.bzrdir = bzrdir
 
3240
        self.controldir = bzrdir
2025
3241
        self._client = _client
2026
3242
        self._need_find_modes = True
2027
3243
        LockableFiles.__init__(
2038
3254
 
2039
3255
    def __init__(self, network_name=None):
2040
3256
        super(RemoteBranchFormat, self).__init__()
2041
 
        self._matchingbzrdir = RemoteBzrDirFormat()
2042
 
        self._matchingbzrdir.set_branch_format(self)
 
3257
        self._matchingcontroldir = RemoteBzrDirFormat()
 
3258
        self._matchingcontroldir.set_branch_format(self)
2043
3259
        self._custom_format = None
2044
3260
        self._network_name = network_name
2045
3261
 
2046
3262
    def __eq__(self, other):
2047
 
        return (isinstance(other, RemoteBranchFormat) and
2048
 
            self.__dict__ == other.__dict__)
 
3263
        return (isinstance(other, RemoteBranchFormat)
 
3264
                and self.__dict__ == other.__dict__)
2049
3265
 
2050
3266
    def _ensure_real(self):
2051
3267
        if self._custom_format is None:
2052
 
            self._custom_format = branch.network_format_registry.get(
2053
 
                self._network_name)
 
3268
            try:
 
3269
                self._custom_format = branch.network_format_registry.get(
 
3270
                    self._network_name)
 
3271
            except KeyError:
 
3272
                raise errors.UnknownFormatError(kind='branch',
 
3273
                                                format=self._network_name)
2054
3274
 
2055
3275
    def get_format_description(self):
2056
3276
        self._ensure_real()
2059
3279
    def network_name(self):
2060
3280
        return self._network_name
2061
3281
 
2062
 
    def open(self, a_bzrdir, name=None, ignore_fallbacks=False):
2063
 
        return a_bzrdir.open_branch(name=name, 
2064
 
            ignore_fallbacks=ignore_fallbacks)
 
3282
    def open(self, a_controldir, name=None, ignore_fallbacks=False):
 
3283
        return a_controldir.open_branch(name=name,
 
3284
                                        ignore_fallbacks=ignore_fallbacks)
2065
3285
 
2066
 
    def _vfs_initialize(self, a_bzrdir, name):
 
3286
    def _vfs_initialize(self, a_controldir, name, append_revisions_only,
 
3287
                        repository=None):
2067
3288
        # Initialisation when using a local bzrdir object, or a non-vfs init
2068
3289
        # method is not available on the server.
2069
3290
        # self._custom_format is always set - the start of initialize ensures
2070
3291
        # that.
2071
 
        if isinstance(a_bzrdir, RemoteBzrDir):
2072
 
            a_bzrdir._ensure_real()
2073
 
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2074
 
                name)
 
3292
        if isinstance(a_controldir, RemoteBzrDir):
 
3293
            a_controldir._ensure_real()
 
3294
            result = self._custom_format.initialize(a_controldir._real_bzrdir,
 
3295
                                                    name=name, append_revisions_only=append_revisions_only,
 
3296
                                                    repository=repository)
2075
3297
        else:
2076
3298
            # We assume the bzrdir is parameterised; it may not be.
2077
 
            result = self._custom_format.initialize(a_bzrdir, name)
2078
 
        if (isinstance(a_bzrdir, RemoteBzrDir) and
2079
 
            not isinstance(result, RemoteBranch)):
2080
 
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
 
3299
            result = self._custom_format.initialize(a_controldir, name=name,
 
3300
                                                    append_revisions_only=append_revisions_only,
 
3301
                                                    repository=repository)
 
3302
        if (isinstance(a_controldir, RemoteBzrDir)
 
3303
                and not isinstance(result, RemoteBranch)):
 
3304
            result = RemoteBranch(a_controldir, a_controldir.find_repository(), result,
2081
3305
                                  name=name)
2082
3306
        return result
2083
3307
 
2084
 
    def initialize(self, a_bzrdir, name=None):
 
3308
    def initialize(self, a_controldir, name=None, repository=None,
 
3309
                   append_revisions_only=None):
 
3310
        if name is None:
 
3311
            name = a_controldir._get_selected_branch()
2085
3312
        # 1) get the network name to use.
2086
3313
        if self._custom_format:
2087
3314
            network_name = self._custom_format.network_name()
2088
3315
        else:
2089
 
            # Select the current bzrlib default and ask for that.
2090
 
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
 
3316
            # Select the current breezy default and ask for that.
 
3317
            reference_bzrdir_format = controldir.format_registry.get(
 
3318
                'default')()
2091
3319
            reference_format = reference_bzrdir_format.get_branch_format()
2092
3320
            self._custom_format = reference_format
2093
3321
            network_name = reference_format.network_name()
2094
3322
        # Being asked to create on a non RemoteBzrDir:
2095
 
        if not isinstance(a_bzrdir, RemoteBzrDir):
2096
 
            return self._vfs_initialize(a_bzrdir, name=name)
2097
 
        medium = a_bzrdir._client._medium
 
3323
        if not isinstance(a_controldir, RemoteBzrDir):
 
3324
            return self._vfs_initialize(a_controldir, name=name,
 
3325
                                        append_revisions_only=append_revisions_only,
 
3326
                                        repository=repository)
 
3327
        medium = a_controldir._client._medium
2098
3328
        if medium._is_remote_before((1, 13)):
2099
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
3329
            return self._vfs_initialize(a_controldir, name=name,
 
3330
                                        append_revisions_only=append_revisions_only,
 
3331
                                        repository=repository)
2100
3332
        # Creating on a remote bzr dir.
2101
3333
        # 2) try direct creation via RPC
2102
 
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2103
 
        if name is not None:
 
3334
        path = a_controldir._path_for_remote_call(a_controldir._client)
 
3335
        if name != "":
2104
3336
            # XXX JRV20100304: Support creating colocated branches
2105
3337
            raise errors.NoColocatedBranchSupport(self)
2106
 
        verb = 'BzrDir.create_branch'
 
3338
        verb = b'BzrDir.create_branch'
2107
3339
        try:
2108
 
            response = a_bzrdir._call(verb, path, network_name)
 
3340
            response = a_controldir._call(verb, path, network_name)
2109
3341
        except errors.UnknownSmartMethod:
2110
3342
            # Fallback - use vfs methods
2111
3343
            medium._remember_remote_is_before((1, 13))
2112
 
            return self._vfs_initialize(a_bzrdir, name=name)
2113
 
        if response[0] != 'ok':
 
3344
            return self._vfs_initialize(a_controldir, name=name,
 
3345
                                        append_revisions_only=append_revisions_only,
 
3346
                                        repository=repository)
 
3347
        if response[0] != b'ok':
2114
3348
            raise errors.UnexpectedSmartServerResponse(response)
2115
3349
        # Turn the response into a RemoteRepository object.
2116
3350
        format = RemoteBranchFormat(network_name=response[1])
2117
3351
        repo_format = response_tuple_to_repo_format(response[3:])
2118
 
        if response[2] == '':
2119
 
            repo_bzrdir = a_bzrdir
 
3352
        repo_path = response[2].decode('utf-8')
 
3353
        if repository is not None:
 
3354
            remote_repo_url = urlutils.join(a_controldir.user_url, repo_path)
 
3355
            url_diff = urlutils.relative_url(repository.user_url,
 
3356
                                             remote_repo_url)
 
3357
            if url_diff != '.':
 
3358
                raise AssertionError(
 
3359
                    'repository.user_url %r does not match URL from server '
 
3360
                    'response (%r + %r)'
 
3361
                    % (repository.user_url, a_controldir.user_url, repo_path))
 
3362
            remote_repo = repository
2120
3363
        else:
2121
 
            repo_bzrdir = RemoteBzrDir(
2122
 
                a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
2123
 
                a_bzrdir._client)
2124
 
        remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2125
 
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2126
 
            format=format, setup_stacking=False, name=name)
 
3364
            if repo_path == '':
 
3365
                repo_bzrdir = a_controldir
 
3366
            else:
 
3367
                repo_bzrdir = RemoteBzrDir(
 
3368
                    a_controldir.root_transport.clone(
 
3369
                        repo_path), a_controldir._format,
 
3370
                    a_controldir._client)
 
3371
            remote_repo = RemoteRepository(repo_bzrdir, repo_format)
 
3372
        remote_branch = RemoteBranch(a_controldir, remote_repo,
 
3373
                                     format=format, setup_stacking=False, name=name)
 
3374
        if append_revisions_only:
 
3375
            remote_branch.set_append_revisions_only(append_revisions_only)
2127
3376
        # XXX: We know this is a new branch, so it must have revno 0, revid
2128
3377
        # NULL_REVISION. Creating the branch locked would make this be unable
2129
3378
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2148
3397
        self._ensure_real()
2149
3398
        return self._custom_format.supports_set_append_revisions_only()
2150
3399
 
 
3400
    def stores_revno(self):
 
3401
        return True
 
3402
 
 
3403
    def _use_default_local_heads_to_fetch(self):
 
3404
        # If the branch format is a metadir format *and* its heads_to_fetch
 
3405
        # implementation is not overridden vs the base class, we can use the
 
3406
        # base class logic rather than use the heads_to_fetch RPC.  This is
 
3407
        # usually cheaper in terms of net round trips, as the last-revision and
 
3408
        # tags info fetched is cached and would be fetched anyway.
 
3409
        self._ensure_real()
 
3410
        if isinstance(self._custom_format, bzrbranch.BranchFormatMetadir):
 
3411
            branch_class = self._custom_format._branch_class()
 
3412
            heads_to_fetch_impl = get_unbound_function(
 
3413
                branch_class.heads_to_fetch)
 
3414
            if heads_to_fetch_impl is get_unbound_function(branch.Branch.heads_to_fetch):
 
3415
                return True
 
3416
        return False
 
3417
 
 
3418
 
 
3419
class RemoteBranchStore(_mod_config.IniFileStore):
 
3420
    """Branch store which attempts to use HPSS calls to retrieve branch store.
 
3421
 
 
3422
    Note that this is specific to bzr-based formats.
 
3423
    """
 
3424
 
 
3425
    def __init__(self, branch):
 
3426
        super(RemoteBranchStore, self).__init__()
 
3427
        self.branch = branch
 
3428
        self.id = "branch"
 
3429
        self._real_store = None
 
3430
 
 
3431
    def external_url(self):
 
3432
        return urlutils.join(self.branch.user_url, 'branch.conf')
 
3433
 
 
3434
    def _load_content(self):
 
3435
        path = self.branch._remote_path()
 
3436
        try:
 
3437
            response, handler = self.branch._call_expecting_body(
 
3438
                b'Branch.get_config_file', path)
 
3439
        except errors.UnknownSmartMethod:
 
3440
            self._ensure_real()
 
3441
            return self._real_store._load_content()
 
3442
        if len(response) and response[0] != b'ok':
 
3443
            raise errors.UnexpectedSmartServerResponse(response)
 
3444
        return handler.read_body_bytes()
 
3445
 
 
3446
    def _save_content(self, content):
 
3447
        path = self.branch._remote_path()
 
3448
        try:
 
3449
            response, handler = self.branch._call_with_body_bytes_expecting_body(
 
3450
                b'Branch.put_config_file', (path,
 
3451
                                            self.branch._lock_token, self.branch._repo_lock_token),
 
3452
                content)
 
3453
        except errors.UnknownSmartMethod:
 
3454
            self._ensure_real()
 
3455
            return self._real_store._save_content(content)
 
3456
        handler.cancel_read_body()
 
3457
        if response != (b'ok', ):
 
3458
            raise errors.UnexpectedSmartServerResponse(response)
 
3459
 
 
3460
    def _ensure_real(self):
 
3461
        self.branch._ensure_real()
 
3462
        if self._real_store is None:
 
3463
            self._real_store = _mod_config.BranchStore(self.branch)
 
3464
 
2151
3465
 
2152
3466
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
2153
3467
    """Branch stored on a server accessed by HPSS RPC.
2156
3470
    """
2157
3471
 
2158
3472
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2159
 
        _client=None, format=None, setup_stacking=True, name=None):
 
3473
                 _client=None, format=None, setup_stacking=True, name=None,
 
3474
                 possible_transports=None):
2160
3475
        """Create a RemoteBranch instance.
2161
3476
 
2162
3477
        :param real_branch: An optional local implementation of the branch
2173
3488
        # We intentionally don't call the parent class's __init__, because it
2174
3489
        # will try to assign to self.tags, which is a property in this subclass.
2175
3490
        # And the parent's __init__ doesn't do much anyway.
2176
 
        self.bzrdir = remote_bzrdir
 
3491
        self.controldir = remote_bzrdir
 
3492
        self.name = name
2177
3493
        if _client is not None:
2178
3494
            self._client = _client
2179
3495
        else:
2191
3507
            self._real_branch.repository = self.repository
2192
3508
        else:
2193
3509
            self._real_branch = None
2194
 
        # Fill out expected attributes of branch for bzrlib API users.
 
3510
        # Fill out expected attributes of branch for breezy API users.
2195
3511
        self._clear_cached_state()
2196
3512
        # TODO: deprecate self.base in favor of user_url
2197
 
        self.base = self.bzrdir.user_url
 
3513
        self.base = self.controldir.user_url
2198
3514
        self._name = name
2199
3515
        self._control_files = None
2200
3516
        self._lock_mode = None
2202
3518
        self._repo_lock_token = None
2203
3519
        self._lock_count = 0
2204
3520
        self._leave_lock = False
 
3521
        self.conf_store = None
2205
3522
        # Setup a format: note that we cannot call _ensure_real until all the
2206
3523
        # attributes above are set: This code cannot be moved higher up in this
2207
3524
        # function.
2227
3544
            hook(self)
2228
3545
        self._is_stacked = False
2229
3546
        if setup_stacking:
2230
 
            self._setup_stacking()
 
3547
            self._setup_stacking(possible_transports)
2231
3548
 
2232
 
    def _setup_stacking(self):
 
3549
    def _setup_stacking(self, possible_transports):
2233
3550
        # configure stacking into the remote repository, by reading it from
2234
3551
        # the vfs branch.
2235
3552
        try:
2236
3553
            fallback_url = self.get_stacked_on_url()
2237
 
        except (errors.NotStacked, errors.UnstackableBranchFormat,
2238
 
            errors.UnstackableRepositoryFormat), e:
 
3554
        except (errors.NotStacked, branch.UnstackableBranchFormat,
 
3555
                errors.UnstackableRepositoryFormat) as e:
2239
3556
            return
2240
3557
        self._is_stacked = True
2241
 
        self._activate_fallback_location(fallback_url)
 
3558
        if possible_transports is None:
 
3559
            possible_transports = []
 
3560
        else:
 
3561
            possible_transports = list(possible_transports)
 
3562
        possible_transports.append(self.controldir.root_transport)
 
3563
        self._activate_fallback_location(fallback_url,
 
3564
                                         possible_transports=possible_transports)
2242
3565
 
2243
3566
    def _get_config(self):
2244
3567
        return RemoteBranchConfig(self)
2245
3568
 
 
3569
    def _get_config_store(self):
 
3570
        if self.conf_store is None:
 
3571
            self.conf_store = RemoteBranchStore(self)
 
3572
        return self.conf_store
 
3573
 
 
3574
    def store_uncommitted(self, creator):
 
3575
        self._ensure_real()
 
3576
        return self._real_branch.store_uncommitted(creator)
 
3577
 
 
3578
    def get_unshelver(self, tree):
 
3579
        self._ensure_real()
 
3580
        return self._real_branch.get_unshelver(tree)
 
3581
 
2246
3582
    def _get_real_transport(self):
2247
3583
        # if we try vfs access, return the real branch's vfs transport
2248
3584
        self._ensure_real()
2263
3599
        if self._real_branch is None:
2264
3600
            if not vfs.vfs_enabled():
2265
3601
                raise AssertionError('smart server vfs must be enabled '
2266
 
                    'to use vfs implementation')
2267
 
            self.bzrdir._ensure_real()
2268
 
            self._real_branch = self.bzrdir._real_bzrdir.open_branch(
 
3602
                                     'to use vfs implementation')
 
3603
            self.controldir._ensure_real()
 
3604
            self._real_branch = self.controldir._real_bzrdir.open_branch(
2269
3605
                ignore_fallbacks=self._real_ignore_fallbacks, name=self._name)
 
3606
            # The remote branch and the real branch shares the same store. If
 
3607
            # we don't, there will always be cases where one of the stores
 
3608
            # doesn't see an update made on the other.
 
3609
            self._real_branch.conf_store = self.conf_store
2270
3610
            if self.repository._real_repository is None:
2271
3611
                # Give the remote repository the matching real repo.
2272
3612
                real_repo = self._real_branch.repository
2287
3627
 
2288
3628
    def _clear_cached_state(self):
2289
3629
        super(RemoteBranch, self)._clear_cached_state()
 
3630
        self._tags_bytes = None
2290
3631
        if self._real_branch is not None:
2291
3632
            self._real_branch._clear_cached_state()
2292
3633
 
2308
3649
        # because it triggers an _ensure_real that we otherwise might not need.
2309
3650
        if self._control_files is None:
2310
3651
            self._control_files = RemoteBranchLockableFiles(
2311
 
                self.bzrdir, self._client)
 
3652
                self.controldir, self._client)
2312
3653
        return self._control_files
2313
3654
 
2314
 
    def _get_checkout_format(self):
2315
 
        self._ensure_real()
2316
 
        return self._real_branch._get_checkout_format()
2317
 
 
2318
3655
    def get_physical_lock_status(self):
2319
3656
        """See Branch.get_physical_lock_status()."""
2320
 
        # should be an API call to the server, as branches must be lockable.
2321
 
        self._ensure_real()
2322
 
        return self._real_branch.get_physical_lock_status()
 
3657
        try:
 
3658
            response = self._client.call(b'Branch.get_physical_lock_status',
 
3659
                                         self._remote_path())
 
3660
        except errors.UnknownSmartMethod:
 
3661
            self._ensure_real()
 
3662
            return self._real_branch.get_physical_lock_status()
 
3663
        if response[0] not in (b'yes', b'no'):
 
3664
            raise errors.UnexpectedSmartServerResponse(response)
 
3665
        return (response[0] == b'yes')
2323
3666
 
2324
3667
    def get_stacked_on_url(self):
2325
3668
        """Get the URL this branch is stacked against.
2333
3676
        try:
2334
3677
            # there may not be a repository yet, so we can't use
2335
3678
            # self._translate_error, so we can't use self._call either.
2336
 
            response = self._client.call('Branch.get_stacked_on_url',
2337
 
                self._remote_path())
2338
 
        except errors.ErrorFromSmartServer, err:
 
3679
            response = self._client.call(b'Branch.get_stacked_on_url',
 
3680
                                         self._remote_path())
 
3681
        except errors.ErrorFromSmartServer as err:
2339
3682
            # there may not be a repository yet, so we can't call through
2340
3683
            # its _translate_error
2341
3684
            _translate_error(err, branch=self)
2342
 
        except errors.UnknownSmartMethod, err:
 
3685
        except errors.UnknownSmartMethod as err:
2343
3686
            self._ensure_real()
2344
3687
            return self._real_branch.get_stacked_on_url()
2345
 
        if response[0] != 'ok':
 
3688
        if response[0] != b'ok':
2346
3689
            raise errors.UnexpectedSmartServerResponse(response)
 
3690
        if sys.version_info[0] == 3:
 
3691
            return response[1].decode('utf-8')
2347
3692
        return response[1]
2348
3693
 
2349
3694
    def set_stacked_on_url(self, url):
2350
3695
        branch.Branch.set_stacked_on_url(self, url)
 
3696
        # We need the stacked_on_url to be visible both locally (to not query
 
3697
        # it repeatedly) and remotely (so smart verbs can get it server side)
 
3698
        # Without the following line,
 
3699
        # breezy.tests.per_branch.test_create_clone.TestCreateClone
 
3700
        # .test_create_clone_on_transport_stacked_hooks_get_stacked_branch
 
3701
        # fails for remote branches -- vila 2012-01-04
 
3702
        self.conf_store.save_changes()
2351
3703
        if not url:
2352
3704
            self._is_stacked = False
2353
3705
        else:
2354
3706
            self._is_stacked = True
2355
 
        
 
3707
 
2356
3708
    def _vfs_get_tags_bytes(self):
2357
3709
        self._ensure_real()
2358
3710
        return self._real_branch._get_tags_bytes()
2359
3711
 
2360
3712
    def _get_tags_bytes(self):
 
3713
        with self.lock_read():
 
3714
            if self._tags_bytes is None:
 
3715
                self._tags_bytes = self._get_tags_bytes_via_hpss()
 
3716
            return self._tags_bytes
 
3717
 
 
3718
    def _get_tags_bytes_via_hpss(self):
2361
3719
        medium = self._client._medium
2362
3720
        if medium._is_remote_before((1, 13)):
2363
3721
            return self._vfs_get_tags_bytes()
2364
3722
        try:
2365
 
            response = self._call('Branch.get_tags_bytes', self._remote_path())
 
3723
            response = self._call(
 
3724
                b'Branch.get_tags_bytes', self._remote_path())
2366
3725
        except errors.UnknownSmartMethod:
2367
3726
            medium._remember_remote_is_before((1, 13))
2368
3727
            return self._vfs_get_tags_bytes()
2373
3732
        return self._real_branch._set_tags_bytes(bytes)
2374
3733
 
2375
3734
    def _set_tags_bytes(self, bytes):
 
3735
        if self.is_locked():
 
3736
            self._tags_bytes = bytes
2376
3737
        medium = self._client._medium
2377
3738
        if medium._is_remote_before((1, 18)):
2378
3739
            self._vfs_set_tags_bytes(bytes)
2381
3742
            args = (
2382
3743
                self._remote_path(), self._lock_token, self._repo_lock_token)
2383
3744
            response = self._call_with_body_bytes(
2384
 
                'Branch.set_tags_bytes', args, bytes)
 
3745
                b'Branch.set_tags_bytes', args, bytes)
2385
3746
        except errors.UnknownSmartMethod:
2386
3747
            medium._remember_remote_is_before((1, 18))
2387
3748
            self._vfs_set_tags_bytes(bytes)
2388
3749
 
2389
3750
    def lock_read(self):
 
3751
        """Lock the branch for read operations.
 
3752
 
 
3753
        :return: A breezy.lock.LogicalLockResult.
 
3754
        """
2390
3755
        self.repository.lock_read()
2391
3756
        if not self._lock_mode:
2392
3757
            self._note_lock('r')
2396
3761
                self._real_branch.lock_read()
2397
3762
        else:
2398
3763
            self._lock_count += 1
 
3764
        return lock.LogicalLockResult(self.unlock)
2399
3765
 
2400
3766
    def _remote_lock_write(self, token):
2401
3767
        if token is None:
2402
 
            branch_token = repo_token = ''
 
3768
            branch_token = repo_token = b''
2403
3769
        else:
2404
3770
            branch_token = token
2405
 
            repo_token = self.repository.lock_write()
 
3771
            repo_token = self.repository.lock_write().repository_token
2406
3772
            self.repository.unlock()
2407
3773
        err_context = {'token': token}
2408
 
        response = self._call(
2409
 
            'Branch.lock_write', self._remote_path(), branch_token,
2410
 
            repo_token or '', **err_context)
2411
 
        if response[0] != 'ok':
 
3774
        try:
 
3775
            response = self._call(
 
3776
                b'Branch.lock_write', self._remote_path(), branch_token,
 
3777
                repo_token or b'', **err_context)
 
3778
        except errors.LockContention as e:
 
3779
            # The LockContention from the server doesn't have any
 
3780
            # information about the lock_url. We re-raise LockContention
 
3781
            # with valid lock_url.
 
3782
            raise errors.LockContention('(remote lock)',
 
3783
                                        self.repository.base.split('.bzr/')[0])
 
3784
        if response[0] != b'ok':
2412
3785
            raise errors.UnexpectedSmartServerResponse(response)
2413
3786
        ok, branch_token, repo_token = response
2414
3787
        return branch_token, repo_token
2420
3793
            remote_tokens = self._remote_lock_write(token)
2421
3794
            self._lock_token, self._repo_lock_token = remote_tokens
2422
3795
            if not self._lock_token:
2423
 
                raise SmartProtocolError('Remote server did not return a token!')
 
3796
                raise SmartProtocolError(
 
3797
                    'Remote server did not return a token!')
2424
3798
            # Tell the self.repository object that it is locked.
2425
3799
            self.repository.lock_write(
2426
3800
                self._repo_lock_token, _skip_rpc=True)
2434
3808
            self._lock_mode = 'w'
2435
3809
            self._lock_count = 1
2436
3810
        elif self._lock_mode == 'r':
2437
 
            raise errors.ReadOnlyTransaction
 
3811
            raise errors.ReadOnlyError(self)
2438
3812
        else:
2439
3813
            if token is not None:
2440
3814
                # A token was given to lock_write, and we're relocking, so
2445
3819
            self._lock_count += 1
2446
3820
            # Re-lock the repository too.
2447
3821
            self.repository.lock_write(self._repo_lock_token)
2448
 
        return self._lock_token or None
 
3822
        return BranchWriteLockResult(self.unlock, self._lock_token or None)
2449
3823
 
2450
3824
    def _unlock(self, branch_token, repo_token):
2451
3825
        err_context = {'token': str((branch_token, repo_token))}
2452
3826
        response = self._call(
2453
 
            'Branch.unlock', self._remote_path(), branch_token,
2454
 
            repo_token or '', **err_context)
2455
 
        if response == ('ok',):
 
3827
            b'Branch.unlock', self._remote_path(), branch_token,
 
3828
            repo_token or b'', **err_context)
 
3829
        if response == (b'ok',):
2456
3830
            return
2457
3831
        raise errors.UnexpectedSmartServerResponse(response)
2458
3832
 
2461
3835
        try:
2462
3836
            self._lock_count -= 1
2463
3837
            if not self._lock_count:
 
3838
                if self.conf_store is not None:
 
3839
                    self.conf_store.save_changes()
2464
3840
                self._clear_cached_state()
2465
3841
                mode = self._lock_mode
2466
3842
                self._lock_mode = None
2467
3843
                if self._real_branch is not None:
2468
 
                    if (not self._leave_lock and mode == 'w' and
2469
 
                        self._repo_lock_token):
 
3844
                    if (not self._leave_lock and mode == 'w'
 
3845
                            and self._repo_lock_token):
2470
3846
                        # If this RemoteBranch will remove the physical lock
2471
3847
                        # for the repository, make sure the _real_branch
2472
3848
                        # doesn't do it first.  (Because the _real_branch's
2489
3865
            self.repository.unlock()
2490
3866
 
2491
3867
    def break_lock(self):
2492
 
        self._ensure_real()
2493
 
        return self._real_branch.break_lock()
 
3868
        try:
 
3869
            response = self._call(
 
3870
                b'Branch.break_lock', self._remote_path())
 
3871
        except errors.UnknownSmartMethod:
 
3872
            self._ensure_real()
 
3873
            return self._real_branch.break_lock()
 
3874
        if response != (b'ok',):
 
3875
            raise errors.UnexpectedSmartServerResponse(response)
2494
3876
 
2495
3877
    def leave_lock_in_place(self):
2496
3878
        if not self._lock_token:
2502
3884
            raise NotImplementedError(self.dont_leave_lock_in_place)
2503
3885
        self._leave_lock = False
2504
3886
 
2505
 
    @needs_read_lock
2506
3887
    def get_rev_id(self, revno, history=None):
2507
3888
        if revno == 0:
2508
3889
            return _mod_revision.NULL_REVISION
2509
 
        last_revision_info = self.last_revision_info()
2510
 
        ok, result = self.repository.get_rev_id_for_revno(
2511
 
            revno, last_revision_info)
2512
 
        if ok:
2513
 
            return result
2514
 
        missing_parent = result[1]
2515
 
        # Either the revision named by the server is missing, or its parent
2516
 
        # is.  Call get_parent_map to determine which, so that we report a
2517
 
        # useful error.
2518
 
        parent_map = self.repository.get_parent_map([missing_parent])
2519
 
        if missing_parent in parent_map:
2520
 
            missing_parent = parent_map[missing_parent]
2521
 
        raise errors.RevisionNotPresent(missing_parent, self.repository)
 
3890
        with self.lock_read():
 
3891
            last_revision_info = self.last_revision_info()
 
3892
            if revno < 0:
 
3893
                raise errors.RevnoOutOfBounds(
 
3894
                    revno, (0, last_revision_info[0]))
 
3895
            ok, result = self.repository.get_rev_id_for_revno(
 
3896
                revno, last_revision_info)
 
3897
            if ok:
 
3898
                return result
 
3899
            missing_parent = result[1]
 
3900
            # Either the revision named by the server is missing, or its parent
 
3901
            # is.  Call get_parent_map to determine which, so that we report a
 
3902
            # useful error.
 
3903
            parent_map = self.repository.get_parent_map([missing_parent])
 
3904
            if missing_parent in parent_map:
 
3905
                missing_parent = parent_map[missing_parent]
 
3906
            raise errors.NoSuchRevision(self, missing_parent)
2522
3907
 
2523
 
    def _last_revision_info(self):
2524
 
        response = self._call('Branch.last_revision_info', self._remote_path())
2525
 
        if response[0] != 'ok':
2526
 
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
3908
    def _read_last_revision_info(self):
 
3909
        response = self._call(
 
3910
            b'Branch.last_revision_info', self._remote_path())
 
3911
        if response[0] != b'ok':
 
3912
            raise SmartProtocolError(
 
3913
                'unexpected response code %s' % (response,))
2527
3914
        revno = int(response[1])
2528
3915
        last_revision = response[2]
2529
3916
        return (revno, last_revision)
2534
3921
            self._ensure_real()
2535
3922
            return self._real_branch._gen_revision_history()
2536
3923
        response_tuple, response_handler = self._call_expecting_body(
2537
 
            'Branch.revision_history', self._remote_path())
2538
 
        if response_tuple[0] != 'ok':
 
3924
            b'Branch.revision_history', self._remote_path())
 
3925
        if response_tuple[0] != b'ok':
2539
3926
            raise errors.UnexpectedSmartServerResponse(response_tuple)
2540
 
        result = response_handler.read_body_bytes().split('\x00')
 
3927
        result = response_handler.read_body_bytes().split(b'\x00')
2541
3928
        if result == ['']:
2542
3929
            return []
2543
3930
        return result
2544
3931
 
2545
3932
    def _remote_path(self):
2546
 
        return self.bzrdir._path_for_remote_call(self._client)
 
3933
        return self.controldir._path_for_remote_call(self._client)
2547
3934
 
2548
3935
    def _set_last_revision_descendant(self, revision_id, other_branch,
2549
 
            allow_diverged=False, allow_overwrite_descendant=False):
 
3936
                                      allow_diverged=False, allow_overwrite_descendant=False):
2550
3937
        # This performs additional work to meet the hook contract; while its
2551
3938
        # undesirable, we have to synthesise the revno to call the hook, and
2552
3939
        # not calling the hook is worse as it means changes can't be prevented.
2557
3944
        history = self._lefthand_history(revision_id)
2558
3945
        self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2559
3946
        err_context = {'other_branch': other_branch}
2560
 
        response = self._call('Branch.set_last_revision_ex',
2561
 
            self._remote_path(), self._lock_token, self._repo_lock_token,
2562
 
            revision_id, int(allow_diverged), int(allow_overwrite_descendant),
2563
 
            **err_context)
 
3947
        response = self._call(b'Branch.set_last_revision_ex',
 
3948
                              self._remote_path(), self._lock_token, self._repo_lock_token,
 
3949
                              revision_id, int(allow_diverged), int(
 
3950
                                  allow_overwrite_descendant),
 
3951
                              **err_context)
2564
3952
        self._clear_cached_state()
2565
 
        if len(response) != 3 and response[0] != 'ok':
 
3953
        if len(response) != 3 and response[0] != b'ok':
2566
3954
            raise errors.UnexpectedSmartServerResponse(response)
2567
3955
        new_revno, new_revision_id = response[1:]
2568
3956
        self._last_revision_info_cache = new_revno, new_revision_id
2582
3970
        history = self._lefthand_history(revision_id)
2583
3971
        self._run_pre_change_branch_tip_hooks(len(history), revision_id)
2584
3972
        self._clear_cached_state()
2585
 
        response = self._call('Branch.set_last_revision',
2586
 
            self._remote_path(), self._lock_token, self._repo_lock_token,
2587
 
            revision_id)
2588
 
        if response != ('ok',):
 
3973
        response = self._call(b'Branch.set_last_revision',
 
3974
                              self._remote_path(), self._lock_token, self._repo_lock_token,
 
3975
                              revision_id)
 
3976
        if response != (b'ok',):
2589
3977
            raise errors.UnexpectedSmartServerResponse(response)
2590
3978
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2591
3979
 
2592
 
    @needs_write_lock
2593
 
    def set_revision_history(self, rev_history):
2594
 
        # Send just the tip revision of the history; the server will generate
2595
 
        # the full history from that.  If the revision doesn't exist in this
2596
 
        # branch, NoSuchRevision will be raised.
2597
 
        if rev_history == []:
2598
 
            rev_id = 'null:'
2599
 
        else:
2600
 
            rev_id = rev_history[-1]
2601
 
        self._set_last_revision(rev_id)
2602
 
        for hook in branch.Branch.hooks['set_rh']:
2603
 
            hook(self, rev_history)
2604
 
        self._cache_revision_history(rev_history)
2605
 
 
2606
3980
    def _get_parent_location(self):
2607
3981
        medium = self._client._medium
2608
3982
        if medium._is_remote_before((1, 13)):
2609
3983
            return self._vfs_get_parent_location()
2610
3984
        try:
2611
 
            response = self._call('Branch.get_parent', self._remote_path())
 
3985
            response = self._call(b'Branch.get_parent', self._remote_path())
2612
3986
        except errors.UnknownSmartMethod:
2613
3987
            medium._remember_remote_is_before((1, 13))
2614
3988
            return self._vfs_get_parent_location()
2615
3989
        if len(response) != 1:
2616
3990
            raise errors.UnexpectedSmartServerResponse(response)
2617
3991
        parent_location = response[0]
2618
 
        if parent_location == '':
 
3992
        if parent_location == b'':
2619
3993
            return None
2620
 
        return parent_location
 
3994
        return parent_location.decode('utf-8')
2621
3995
 
2622
3996
    def _vfs_get_parent_location(self):
2623
3997
        self._ensure_real()
2628
4002
        if medium._is_remote_before((1, 15)):
2629
4003
            return self._vfs_set_parent_location(url)
2630
4004
        try:
2631
 
            call_url = url or ''
2632
 
            if type(call_url) is not str:
2633
 
                raise AssertionError('url must be a str or None (%s)' % url)
2634
 
            response = self._call('Branch.set_parent_location',
2635
 
                self._remote_path(), self._lock_token, self._repo_lock_token,
2636
 
                call_url)
 
4005
            call_url = url or u''
 
4006
            if isinstance(call_url, text_type):
 
4007
                call_url = call_url.encode('utf-8')
 
4008
            response = self._call(b'Branch.set_parent_location',
 
4009
                                  self._remote_path(), self._lock_token, self._repo_lock_token,
 
4010
                                  call_url)
2637
4011
        except errors.UnknownSmartMethod:
2638
4012
            medium._remember_remote_is_before((1, 15))
2639
4013
            return self._vfs_set_parent_location(url)
2644
4018
        self._ensure_real()
2645
4019
        return self._real_branch._set_parent_location(url)
2646
4020
 
2647
 
    @needs_write_lock
2648
4021
    def pull(self, source, overwrite=False, stop_revision=None,
2649
4022
             **kwargs):
2650
 
        self._clear_cached_state_of_remote_branch_only()
2651
 
        self._ensure_real()
2652
 
        return self._real_branch.pull(
2653
 
            source, overwrite=overwrite, stop_revision=stop_revision,
2654
 
            _override_hook_target=self, **kwargs)
2655
 
 
2656
 
    @needs_read_lock
2657
 
    def push(self, target, overwrite=False, stop_revision=None):
2658
 
        self._ensure_real()
2659
 
        return self._real_branch.push(
2660
 
            target, overwrite=overwrite, stop_revision=stop_revision,
2661
 
            _override_hook_source_branch=self)
 
4023
        with self.lock_write():
 
4024
            self._clear_cached_state_of_remote_branch_only()
 
4025
            self._ensure_real()
 
4026
            return self._real_branch.pull(
 
4027
                source, overwrite=overwrite, stop_revision=stop_revision,
 
4028
                _override_hook_target=self, **kwargs)
 
4029
 
 
4030
    def push(self, target, overwrite=False, stop_revision=None, lossy=False):
 
4031
        with self.lock_read():
 
4032
            self._ensure_real()
 
4033
            return self._real_branch.push(
 
4034
                target, overwrite=overwrite, stop_revision=stop_revision, lossy=lossy,
 
4035
                _override_hook_source_branch=self)
 
4036
 
 
4037
    def peek_lock_mode(self):
 
4038
        return self._lock_mode
2662
4039
 
2663
4040
    def is_locked(self):
2664
4041
        return self._lock_count >= 1
2665
4042
 
2666
 
    @needs_read_lock
 
4043
    def revision_id_to_dotted_revno(self, revision_id):
 
4044
        """Given a revision id, return its dotted revno.
 
4045
 
 
4046
        :return: a tuple like (1,) or (400,1,3).
 
4047
        """
 
4048
        with self.lock_read():
 
4049
            try:
 
4050
                response = self._call(b'Branch.revision_id_to_revno',
 
4051
                                      self._remote_path(), revision_id)
 
4052
            except errors.UnknownSmartMethod:
 
4053
                self._ensure_real()
 
4054
                return self._real_branch.revision_id_to_dotted_revno(revision_id)
 
4055
            except errors.UnknownErrorFromSmartServer as e:
 
4056
                # Deal with older versions of bzr/brz that didn't explicitly
 
4057
                # wrap GhostRevisionsHaveNoRevno.
 
4058
                if e.error_tuple[1] == b'GhostRevisionsHaveNoRevno':
 
4059
                    (revid, ghost_revid) = re.findall(b"{([^}]+)}", e.error_tuple[2])
 
4060
                    raise errors.GhostRevisionsHaveNoRevno(
 
4061
                        revid, ghost_revid)
 
4062
                raise
 
4063
            if response[0] == b'ok':
 
4064
                return tuple([int(x) for x in response[1:]])
 
4065
            else:
 
4066
                raise errors.UnexpectedSmartServerResponse(response)
 
4067
 
2667
4068
    def revision_id_to_revno(self, revision_id):
2668
 
        self._ensure_real()
2669
 
        return self._real_branch.revision_id_to_revno(revision_id)
2670
 
 
2671
 
    @needs_write_lock
 
4069
        """Given a revision id on the branch mainline, return its revno.
 
4070
 
 
4071
        :return: an integer
 
4072
        """
 
4073
        with self.lock_read():
 
4074
            try:
 
4075
                response = self._call(b'Branch.revision_id_to_revno',
 
4076
                                      self._remote_path(), revision_id)
 
4077
            except errors.UnknownSmartMethod:
 
4078
                self._ensure_real()
 
4079
                return self._real_branch.revision_id_to_revno(revision_id)
 
4080
            if response[0] == b'ok':
 
4081
                if len(response) == 2:
 
4082
                    return int(response[1])
 
4083
                raise NoSuchRevision(self, revision_id)
 
4084
            else:
 
4085
                raise errors.UnexpectedSmartServerResponse(response)
 
4086
 
2672
4087
    def set_last_revision_info(self, revno, revision_id):
2673
 
        # XXX: These should be returned by the set_last_revision_info verb
2674
 
        old_revno, old_revid = self.last_revision_info()
2675
 
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2676
 
        revision_id = ensure_null(revision_id)
2677
 
        try:
2678
 
            response = self._call('Branch.set_last_revision_info',
2679
 
                self._remote_path(), self._lock_token, self._repo_lock_token,
2680
 
                str(revno), revision_id)
2681
 
        except errors.UnknownSmartMethod:
2682
 
            self._ensure_real()
2683
 
            self._clear_cached_state_of_remote_branch_only()
2684
 
            self._real_branch.set_last_revision_info(revno, revision_id)
2685
 
            self._last_revision_info_cache = revno, revision_id
2686
 
            return
2687
 
        if response == ('ok',):
2688
 
            self._clear_cached_state()
2689
 
            self._last_revision_info_cache = revno, revision_id
2690
 
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2691
 
            # Update the _real_branch's cache too.
2692
 
            if self._real_branch is not None:
2693
 
                cache = self._last_revision_info_cache
2694
 
                self._real_branch._last_revision_info_cache = cache
2695
 
        else:
2696
 
            raise errors.UnexpectedSmartServerResponse(response)
 
4088
        with self.lock_write():
 
4089
            # XXX: These should be returned by the set_last_revision_info verb
 
4090
            old_revno, old_revid = self.last_revision_info()
 
4091
            self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
4092
            if not revision_id or not isinstance(revision_id, bytes):
 
4093
                raise errors.InvalidRevisionId(
 
4094
                    revision_id=revision_id, branch=self)
 
4095
            try:
 
4096
                response = self._call(b'Branch.set_last_revision_info',
 
4097
                                      self._remote_path(), self._lock_token, self._repo_lock_token,
 
4098
                                      str(revno).encode('ascii'), revision_id)
 
4099
            except errors.UnknownSmartMethod:
 
4100
                self._ensure_real()
 
4101
                self._clear_cached_state_of_remote_branch_only()
 
4102
                self._real_branch.set_last_revision_info(revno, revision_id)
 
4103
                self._last_revision_info_cache = revno, revision_id
 
4104
                return
 
4105
            if response == (b'ok',):
 
4106
                self._clear_cached_state()
 
4107
                self._last_revision_info_cache = revno, revision_id
 
4108
                self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
4109
                # Update the _real_branch's cache too.
 
4110
                if self._real_branch is not None:
 
4111
                    cache = self._last_revision_info_cache
 
4112
                    self._real_branch._last_revision_info_cache = cache
 
4113
            else:
 
4114
                raise errors.UnexpectedSmartServerResponse(response)
2697
4115
 
2698
 
    @needs_write_lock
2699
4116
    def generate_revision_history(self, revision_id, last_rev=None,
2700
4117
                                  other_branch=None):
2701
 
        medium = self._client._medium
2702
 
        if not medium._is_remote_before((1, 6)):
2703
 
            # Use a smart method for 1.6 and above servers
2704
 
            try:
2705
 
                self._set_last_revision_descendant(revision_id, other_branch,
2706
 
                    allow_diverged=True, allow_overwrite_descendant=True)
2707
 
                return
2708
 
            except errors.UnknownSmartMethod:
2709
 
                medium._remember_remote_is_before((1, 6))
2710
 
        self._clear_cached_state_of_remote_branch_only()
2711
 
        self.set_revision_history(self._lefthand_history(revision_id,
2712
 
            last_rev=last_rev,other_branch=other_branch))
 
4118
        with self.lock_write():
 
4119
            medium = self._client._medium
 
4120
            if not medium._is_remote_before((1, 6)):
 
4121
                # Use a smart method for 1.6 and above servers
 
4122
                try:
 
4123
                    self._set_last_revision_descendant(revision_id, other_branch,
 
4124
                                                       allow_diverged=True, allow_overwrite_descendant=True)
 
4125
                    return
 
4126
                except errors.UnknownSmartMethod:
 
4127
                    medium._remember_remote_is_before((1, 6))
 
4128
            self._clear_cached_state_of_remote_branch_only()
 
4129
            graph = self.repository.get_graph()
 
4130
            (last_revno, last_revid) = self.last_revision_info()
 
4131
            known_revision_ids = [
 
4132
                (last_revid, last_revno),
 
4133
                (_mod_revision.NULL_REVISION, 0),
 
4134
                ]
 
4135
            if last_rev is not None:
 
4136
                if not graph.is_ancestor(last_rev, revision_id):
 
4137
                    # our previous tip is not merged into stop_revision
 
4138
                    raise errors.DivergedBranches(self, other_branch)
 
4139
            revno = graph.find_distance_to_null(
 
4140
                revision_id, known_revision_ids)
 
4141
            self.set_last_revision_info(revno, revision_id)
2713
4142
 
2714
4143
    def set_push_location(self, location):
 
4144
        self._set_config_location('push_location', location)
 
4145
 
 
4146
    def heads_to_fetch(self):
 
4147
        if self._format._use_default_local_heads_to_fetch():
 
4148
            # We recognise this format, and its heads-to-fetch implementation
 
4149
            # is the default one (tip + tags).  In this case it's cheaper to
 
4150
            # just use the default implementation rather than a special RPC as
 
4151
            # the tip and tags data is cached.
 
4152
            return branch.Branch.heads_to_fetch(self)
 
4153
        medium = self._client._medium
 
4154
        if medium._is_remote_before((2, 4)):
 
4155
            return self._vfs_heads_to_fetch()
 
4156
        try:
 
4157
            return self._rpc_heads_to_fetch()
 
4158
        except errors.UnknownSmartMethod:
 
4159
            medium._remember_remote_is_before((2, 4))
 
4160
            return self._vfs_heads_to_fetch()
 
4161
 
 
4162
    def _rpc_heads_to_fetch(self):
 
4163
        response = self._call(b'Branch.heads_to_fetch', self._remote_path())
 
4164
        if len(response) != 2:
 
4165
            raise errors.UnexpectedSmartServerResponse(response)
 
4166
        must_fetch, if_present_fetch = response
 
4167
        return set(must_fetch), set(if_present_fetch)
 
4168
 
 
4169
    def _vfs_heads_to_fetch(self):
2715
4170
        self._ensure_real()
2716
 
        return self._real_branch.set_push_location(location)
 
4171
        return self._real_branch.heads_to_fetch()
 
4172
 
 
4173
    def reconcile(self, thorough=True):
 
4174
        """Make sure the data stored in this branch is consistent."""
 
4175
        from .reconcile import BranchReconciler
 
4176
        with self.lock_write():
 
4177
            reconciler = BranchReconciler(self, thorough=thorough)
 
4178
            return reconciler.reconcile()
2717
4179
 
2718
4180
 
2719
4181
class RemoteConfig(object):
2721
4183
 
2722
4184
    It is a low-level object that considers config data to be name/value pairs
2723
4185
    that may be associated with a section. Assigning meaning to the these
2724
 
    values is done at higher levels like bzrlib.config.TreeConfig.
 
4186
    values is done at higher levels like breezy.config.TreeConfig.
2725
4187
    """
2726
4188
 
2727
4189
    def get_option(self, name, section=None, default=None):
2734
4196
        """
2735
4197
        try:
2736
4198
            configobj = self._get_configobj()
 
4199
            section_obj = None
2737
4200
            if section is None:
2738
4201
                section_obj = configobj
2739
4202
            else:
2740
4203
                try:
2741
4204
                    section_obj = configobj[section]
2742
4205
                except KeyError:
2743
 
                    return default
2744
 
            return section_obj.get(name, default)
 
4206
                    pass
 
4207
            if section_obj is None:
 
4208
                value = default
 
4209
            else:
 
4210
                value = section_obj.get(name, default)
2745
4211
        except errors.UnknownSmartMethod:
2746
 
            return self._vfs_get_option(name, section, default)
 
4212
            value = self._vfs_get_option(name, section, default)
 
4213
        for hook in _mod_config.OldConfigHooks['get']:
 
4214
            hook(self, name, value)
 
4215
        return value
2747
4216
 
2748
4217
    def _response_to_configobj(self, response):
2749
 
        if len(response[0]) and response[0][0] != 'ok':
 
4218
        if len(response[0]) and response[0][0] != b'ok':
2750
4219
            raise errors.UnexpectedSmartServerResponse(response)
2751
4220
        lines = response[1].read_body_bytes().splitlines()
2752
 
        return config.ConfigObj(lines, encoding='utf-8')
 
4221
        conf = _mod_config.ConfigObj(lines, encoding='utf-8')
 
4222
        for hook in _mod_config.OldConfigHooks['load']:
 
4223
            hook(self)
 
4224
        return conf
2753
4225
 
2754
4226
 
2755
4227
class RemoteBranchConfig(RemoteConfig):
2761
4233
    def _get_configobj(self):
2762
4234
        path = self._branch._remote_path()
2763
4235
        response = self._branch._client.call_expecting_body(
2764
 
            'Branch.get_config_file', path)
 
4236
            b'Branch.get_config_file', path)
2765
4237
        return self._response_to_configobj(response)
2766
4238
 
2767
4239
    def set_option(self, value, name, section=None):
2774
4246
        medium = self._branch._client._medium
2775
4247
        if medium._is_remote_before((1, 14)):
2776
4248
            return self._vfs_set_option(value, name, section)
2777
 
        try:
2778
 
            path = self._branch._remote_path()
2779
 
            response = self._branch._client.call('Branch.set_config_option',
 
4249
        if isinstance(value, dict):
 
4250
            if medium._is_remote_before((2, 2)):
 
4251
                return self._vfs_set_option(value, name, section)
 
4252
            return self._set_config_option_dict(value, name, section)
 
4253
        else:
 
4254
            return self._set_config_option(value, name, section)
 
4255
 
 
4256
    def _set_config_option(self, value, name, section):
 
4257
        if isinstance(value, (bool, int)):
 
4258
            value = str(value)
 
4259
        elif isinstance(value, (text_type, str)):
 
4260
            pass
 
4261
        else:
 
4262
            raise TypeError(value)
 
4263
        try:
 
4264
            path = self._branch._remote_path()
 
4265
            response = self._branch._client.call(b'Branch.set_config_option',
 
4266
                                                 path, self._branch._lock_token, self._branch._repo_lock_token,
 
4267
                                                 value.encode('utf-8'), name.encode('utf-8'),
 
4268
                                                 (section or '').encode('utf-8'))
 
4269
        except errors.UnknownSmartMethod:
 
4270
            medium = self._branch._client._medium
 
4271
            medium._remember_remote_is_before((1, 14))
 
4272
            return self._vfs_set_option(value, name, section)
 
4273
        if response != ():
 
4274
            raise errors.UnexpectedSmartServerResponse(response)
 
4275
 
 
4276
    def _serialize_option_dict(self, option_dict):
 
4277
        utf8_dict = {}
 
4278
        for key, value in option_dict.items():
 
4279
            if isinstance(key, text_type):
 
4280
                key = key.encode('utf8')
 
4281
            if isinstance(value, text_type):
 
4282
                value = value.encode('utf8')
 
4283
            utf8_dict[key] = value
 
4284
        return bencode.bencode(utf8_dict)
 
4285
 
 
4286
    def _set_config_option_dict(self, value, name, section):
 
4287
        try:
 
4288
            path = self._branch._remote_path()
 
4289
            serialised_dict = self._serialize_option_dict(value)
 
4290
            response = self._branch._client.call(
 
4291
                b'Branch.set_config_option_dict',
2780
4292
                path, self._branch._lock_token, self._branch._repo_lock_token,
2781
 
                value.encode('utf8'), name, section or '')
 
4293
                serialised_dict, name.encode('utf-8'), (section or '').encode('utf-8'))
2782
4294
        except errors.UnknownSmartMethod:
2783
 
            medium._remember_remote_is_before((1, 14))
 
4295
            medium = self._branch._client._medium
 
4296
            medium._remember_remote_is_before((2, 2))
2784
4297
            return self._vfs_set_option(value, name, section)
2785
4298
        if response != ():
2786
4299
            raise errors.UnexpectedSmartServerResponse(response)
2802
4315
 
2803
4316
    def _get_configobj(self):
2804
4317
        medium = self._bzrdir._client._medium
2805
 
        verb = 'BzrDir.get_config_file'
 
4318
        verb = b'BzrDir.get_config_file'
2806
4319
        if medium._is_remote_before((1, 15)):
2807
4320
            raise errors.UnknownSmartMethod(verb)
2808
4321
        path = self._bzrdir._path_for_remote_call(self._bzrdir._client)
2829
4342
        return self._bzrdir._real_bzrdir
2830
4343
 
2831
4344
 
2832
 
 
2833
 
def _extract_tar(tar, to_dir):
2834
 
    """Extract all the contents of a tarfile object.
2835
 
 
2836
 
    A replacement for extractall, which is not present in python2.4
2837
 
    """
2838
 
    for tarinfo in tar:
2839
 
        tar.extract(tarinfo, to_dir)
 
4345
error_translators = registry.Registry()
 
4346
no_context_error_translators = registry.Registry()
2840
4347
 
2841
4348
 
2842
4349
def _translate_error(err, **context):
2856
4363
    def find(name):
2857
4364
        try:
2858
4365
            return context[name]
2859
 
        except KeyError, key_err:
2860
 
            mutter('Missing key %r in context %r', key_err.args[0], context)
 
4366
        except KeyError:
 
4367
            mutter('Missing key \'%s\' in context %r', name, context)
2861
4368
            raise err
 
4369
 
2862
4370
    def get_path():
2863
4371
        """Get the path from the context if present, otherwise use first error
2864
4372
        arg.
2865
4373
        """
2866
4374
        try:
2867
4375
            return context['path']
2868
 
        except KeyError, key_err:
 
4376
        except KeyError:
2869
4377
            try:
2870
 
                return err.error_args[0]
2871
 
            except IndexError, idx_err:
2872
 
                mutter(
2873
 
                    'Missing key %r in context %r', key_err.args[0], context)
 
4378
                return err.error_args[0].decode('utf-8')
 
4379
            except IndexError:
 
4380
                mutter('Missing key \'path\' in context %r', context)
2874
4381
                raise err
2875
 
 
2876
 
    if err.error_verb == 'IncompatibleRepositories':
2877
 
        raise errors.IncompatibleRepositories(err.error_args[0],
2878
 
            err.error_args[1], err.error_args[2])
2879
 
    elif err.error_verb == 'NoSuchRevision':
2880
 
        raise NoSuchRevision(find('branch'), err.error_args[0])
2881
 
    elif err.error_verb == 'nosuchrevision':
2882
 
        raise NoSuchRevision(find('repository'), err.error_args[0])
2883
 
    elif err.error_verb == 'nobranch':
2884
 
        if len(err.error_args) >= 1:
2885
 
            extra = err.error_args[0]
2886
 
        else:
2887
 
            extra = None
2888
 
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base,
2889
 
            detail=extra)
2890
 
    elif err.error_verb == 'norepository':
2891
 
        raise errors.NoRepositoryPresent(find('bzrdir'))
2892
 
    elif err.error_verb == 'LockContention':
2893
 
        raise errors.LockContention('(remote lock)')
2894
 
    elif err.error_verb == 'UnlockableTransport':
2895
 
        raise errors.UnlockableTransport(find('bzrdir').root_transport)
2896
 
    elif err.error_verb == 'LockFailed':
2897
 
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
2898
 
    elif err.error_verb == 'TokenMismatch':
2899
 
        raise errors.TokenMismatch(find('token'), '(remote token)')
2900
 
    elif err.error_verb == 'Diverged':
2901
 
        raise errors.DivergedBranches(find('branch'), find('other_branch'))
2902
 
    elif err.error_verb == 'TipChangeRejected':
2903
 
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
2904
 
    elif err.error_verb == 'UnstackableBranchFormat':
2905
 
        raise errors.UnstackableBranchFormat(*err.error_args)
2906
 
    elif err.error_verb == 'UnstackableRepositoryFormat':
2907
 
        raise errors.UnstackableRepositoryFormat(*err.error_args)
2908
 
    elif err.error_verb == 'NotStacked':
2909
 
        raise errors.NotStacked(branch=find('branch'))
2910
 
    elif err.error_verb == 'PermissionDenied':
2911
 
        path = get_path()
2912
 
        if len(err.error_args) >= 2:
2913
 
            extra = err.error_args[1]
2914
 
        else:
2915
 
            extra = None
2916
 
        raise errors.PermissionDenied(path, extra=extra)
2917
 
    elif err.error_verb == 'ReadError':
2918
 
        path = get_path()
2919
 
        raise errors.ReadError(path)
2920
 
    elif err.error_verb == 'NoSuchFile':
2921
 
        path = get_path()
2922
 
        raise errors.NoSuchFile(path)
2923
 
    elif err.error_verb == 'FileExists':
2924
 
        raise errors.FileExists(err.error_args[0])
2925
 
    elif err.error_verb == 'DirectoryNotEmpty':
2926
 
        raise errors.DirectoryNotEmpty(err.error_args[0])
2927
 
    elif err.error_verb == 'ShortReadvError':
2928
 
        args = err.error_args
2929
 
        raise errors.ShortReadvError(
2930
 
            args[0], int(args[1]), int(args[2]), int(args[3]))
2931
 
    elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
2932
 
        encoding = str(err.error_args[0]) # encoding must always be a string
2933
 
        val = err.error_args[1]
2934
 
        start = int(err.error_args[2])
2935
 
        end = int(err.error_args[3])
2936
 
        reason = str(err.error_args[4]) # reason must always be a string
2937
 
        if val.startswith('u:'):
2938
 
            val = val[2:].decode('utf-8')
2939
 
        elif val.startswith('s:'):
2940
 
            val = val[2:].decode('base64')
2941
 
        if err.error_verb == 'UnicodeDecodeError':
2942
 
            raise UnicodeDecodeError(encoding, val, start, end, reason)
2943
 
        elif err.error_verb == 'UnicodeEncodeError':
2944
 
            raise UnicodeEncodeError(encoding, val, start, end, reason)
2945
 
    elif err.error_verb == 'ReadOnlyError':
2946
 
        raise errors.TransportNotPossible('readonly transport')
2947
 
    raise errors.UnknownErrorFromSmartServer(err)
 
4382
    if not isinstance(err.error_verb, bytes):
 
4383
        raise TypeError(err.error_verb)
 
4384
    try:
 
4385
        translator = error_translators.get(err.error_verb)
 
4386
    except KeyError:
 
4387
        pass
 
4388
    else:
 
4389
        raise translator(err, find, get_path)
 
4390
    try:
 
4391
        translator = no_context_error_translators.get(err.error_verb)
 
4392
    except KeyError:
 
4393
        raise errors.UnknownErrorFromSmartServer(err)
 
4394
    else:
 
4395
        raise translator(err)
 
4396
 
 
4397
 
 
4398
error_translators.register(b'NoSuchRevision',
 
4399
                           lambda err, find, get_path: NoSuchRevision(
 
4400
                               find('branch'), err.error_args[0]))
 
4401
error_translators.register(b'nosuchrevision',
 
4402
                           lambda err, find, get_path: NoSuchRevision(
 
4403
                               find('repository'), err.error_args[0]))
 
4404
error_translators.register(
 
4405
    b'revno-outofbounds',
 
4406
    lambda err, find, get_path: errors.RevnoOutOfBounds(
 
4407
        err.error_args[0], (err.error_args[1], err.error_args[2])))
 
4408
 
 
4409
 
 
4410
def _translate_nobranch_error(err, find, get_path):
 
4411
    if len(err.error_args) >= 1:
 
4412
        extra = err.error_args[0].decode('utf-8')
 
4413
    else:
 
4414
        extra = None
 
4415
    return errors.NotBranchError(path=find('bzrdir').root_transport.base,
 
4416
                                 detail=extra)
 
4417
 
 
4418
 
 
4419
error_translators.register(b'nobranch', _translate_nobranch_error)
 
4420
error_translators.register(b'norepository',
 
4421
                           lambda err, find, get_path: errors.NoRepositoryPresent(
 
4422
                               find('bzrdir')))
 
4423
error_translators.register(b'UnlockableTransport',
 
4424
                           lambda err, find, get_path: errors.UnlockableTransport(
 
4425
                               find('bzrdir').root_transport))
 
4426
error_translators.register(b'TokenMismatch',
 
4427
                           lambda err, find, get_path: errors.TokenMismatch(
 
4428
                               find('token'), '(remote token)'))
 
4429
error_translators.register(b'Diverged',
 
4430
                           lambda err, find, get_path: errors.DivergedBranches(
 
4431
                               find('branch'), find('other_branch')))
 
4432
error_translators.register(b'NotStacked',
 
4433
                           lambda err, find, get_path: errors.NotStacked(branch=find('branch')))
 
4434
 
 
4435
 
 
4436
def _translate_PermissionDenied(err, find, get_path):
 
4437
    path = get_path()
 
4438
    if len(err.error_args) >= 2:
 
4439
        extra = err.error_args[1].decode('utf-8')
 
4440
    else:
 
4441
        extra = None
 
4442
    return errors.PermissionDenied(path, extra=extra)
 
4443
 
 
4444
 
 
4445
error_translators.register(b'PermissionDenied', _translate_PermissionDenied)
 
4446
error_translators.register(b'ReadError',
 
4447
                           lambda err, find, get_path: errors.ReadError(get_path()))
 
4448
error_translators.register(b'NoSuchFile',
 
4449
                           lambda err, find, get_path: errors.NoSuchFile(get_path()))
 
4450
error_translators.register(b'TokenLockingNotSupported',
 
4451
                           lambda err, find, get_path: errors.TokenLockingNotSupported(
 
4452
                               find('repository')))
 
4453
error_translators.register(b'UnsuspendableWriteGroup',
 
4454
                           lambda err, find, get_path: errors.UnsuspendableWriteGroup(
 
4455
                               repository=find('repository')))
 
4456
error_translators.register(b'UnresumableWriteGroup',
 
4457
                           lambda err, find, get_path: errors.UnresumableWriteGroup(
 
4458
                               repository=find('repository'), write_groups=err.error_args[0],
 
4459
                               reason=err.error_args[1]))
 
4460
no_context_error_translators.register(b'GhostRevisionsHaveNoRevno',
 
4461
                                      lambda err: errors.GhostRevisionsHaveNoRevno(*err.error_args))
 
4462
no_context_error_translators.register(b'IncompatibleRepositories',
 
4463
                                      lambda err: errors.IncompatibleRepositories(
 
4464
                                          err.error_args[0].decode('utf-8'), err.error_args[1].decode('utf-8'), err.error_args[2].decode('utf-8')))
 
4465
no_context_error_translators.register(b'LockContention',
 
4466
                                      lambda err: errors.LockContention('(remote lock)'))
 
4467
no_context_error_translators.register(b'LockFailed',
 
4468
                                      lambda err: errors.LockFailed(err.error_args[0].decode('utf-8'), err.error_args[1].decode('utf-8')))
 
4469
no_context_error_translators.register(b'TipChangeRejected',
 
4470
                                      lambda err: errors.TipChangeRejected(err.error_args[0].decode('utf8')))
 
4471
no_context_error_translators.register(b'UnstackableBranchFormat',
 
4472
                                      lambda err: branch.UnstackableBranchFormat(*err.error_args))
 
4473
no_context_error_translators.register(b'UnstackableRepositoryFormat',
 
4474
                                      lambda err: errors.UnstackableRepositoryFormat(*err.error_args))
 
4475
no_context_error_translators.register(b'FileExists',
 
4476
                                      lambda err: errors.FileExists(err.error_args[0].decode('utf-8')))
 
4477
no_context_error_translators.register(b'DirectoryNotEmpty',
 
4478
                                      lambda err: errors.DirectoryNotEmpty(err.error_args[0].decode('utf-8')))
 
4479
no_context_error_translators.register(b'UnknownFormat',
 
4480
                                      lambda err: errors.UnknownFormatError(
 
4481
                                          err.error_args[0].decode('ascii'), err.error_args[0].decode('ascii')))
 
4482
no_context_error_translators.register(b'InvalidURL',
 
4483
                                      lambda err: urlutils.InvalidURL(
 
4484
                                          err.error_args[0].decode('utf-8'), err.error_args[1].decode('ascii')))
 
4485
 
 
4486
 
 
4487
def _translate_short_readv_error(err):
 
4488
    args = err.error_args
 
4489
    return errors.ShortReadvError(
 
4490
        args[0].decode('utf-8'),
 
4491
        int(args[1].decode('ascii')), int(args[2].decode('ascii')),
 
4492
        int(args[3].decode('ascii')))
 
4493
 
 
4494
 
 
4495
no_context_error_translators.register(b'ShortReadvError',
 
4496
                                      _translate_short_readv_error)
 
4497
 
 
4498
 
 
4499
def _translate_unicode_error(err):
 
4500
    encoding = err.error_args[0].decode('ascii')
 
4501
    val = err.error_args[1].decode('utf-8')
 
4502
    start = int(err.error_args[2].decode('ascii'))
 
4503
    end = int(err.error_args[3].decode('ascii'))
 
4504
    reason = err.error_args[4].decode('utf-8')
 
4505
    if val.startswith('u:'):
 
4506
        val = val[2:].decode('utf-8')
 
4507
    elif val.startswith('s:'):
 
4508
        val = val[2:].decode('base64')
 
4509
    if err.error_verb == 'UnicodeDecodeError':
 
4510
        raise UnicodeDecodeError(encoding, val, start, end, reason)
 
4511
    elif err.error_verb == 'UnicodeEncodeError':
 
4512
        raise UnicodeEncodeError(encoding, val, start, end, reason)
 
4513
 
 
4514
 
 
4515
no_context_error_translators.register(b'UnicodeEncodeError',
 
4516
                                      _translate_unicode_error)
 
4517
no_context_error_translators.register(b'UnicodeDecodeError',
 
4518
                                      _translate_unicode_error)
 
4519
no_context_error_translators.register(b'ReadOnlyError',
 
4520
                                      lambda err: errors.TransportNotPossible('readonly transport'))
 
4521
no_context_error_translators.register(b'MemoryError',
 
4522
                                      lambda err: errors.BzrError("remote server out of memory\n"
 
4523
                                                                  "Retry non-remotely, or contact the server admin for details."))
 
4524
no_context_error_translators.register(b'RevisionNotPresent',
 
4525
                                      lambda err: errors.RevisionNotPresent(err.error_args[0].decode('utf-8'), err.error_args[1].decode('utf-8')))
 
4526
 
 
4527
no_context_error_translators.register(b'BzrCheckError',
 
4528
                                      lambda err: errors.BzrCheckError(msg=err.error_args[0].decode('utf-8')))