~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Jelmer Vernooij
  • Date: 2012-01-27 19:05:43 UTC
  • mto: This revision was merged to the branch mainline in revision 6450.
  • Revision ID: jelmer@samba.org-20120127190543-vk350mv4a0c7aug2
Fix weave test.

Show diffs side-by-side

added added

removed removed

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