/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Jelmer Vernooij
  • Date: 2012-01-06 22:06:36 UTC
  • mto: (6437.3.14 2.5)
  • mto: This revision was merged to the branch mainline in revision 6444.
  • Revision ID: jelmer@samba.org-20120106220636-1emawdzrqy3n6n63
Add HPSS call for BzrDir.get_branches.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2010 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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
 
18
 
17
19
import bz2
 
20
import zlib
18
21
 
19
22
from bzrlib import (
20
23
    bencode,
21
24
    branch,
22
 
    bzrdir,
23
 
    config,
 
25
    bzrdir as _mod_bzrdir,
 
26
    config as _mod_config,
 
27
    controldir,
24
28
    debug,
25
29
    errors,
 
30
    gpg,
26
31
    graph,
 
32
    inventory_delta,
27
33
    lock,
28
34
    lockdir,
29
 
    repository,
 
35
    osutils,
 
36
    registry,
30
37
    repository as _mod_repository,
31
 
    revision,
32
38
    revision as _mod_revision,
33
39
    static_tuple,
34
40
    symbol_versioning,
35
 
)
36
 
from bzrlib.branch import BranchReferenceFormat
37
 
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
 
41
    testament as _mod_testament,
 
42
    urlutils,
 
43
    vf_repository,
 
44
    vf_search,
 
45
    )
 
46
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
38
47
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
39
48
from bzrlib.errors import (
40
49
    NoSuchRevision,
41
50
    SmartProtocolError,
42
51
    )
 
52
from bzrlib.i18n import gettext
 
53
from bzrlib.inventory import Inventory
43
54
from bzrlib.lockable_files import LockableFiles
44
55
from bzrlib.smart import client, vfs, repository as smart_repo
45
 
from bzrlib.revision import ensure_null, NULL_REVISION
46
 
from bzrlib.trace import mutter, note, warning
 
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
47
66
 
48
67
 
49
68
class _RpcHelper(object):
86
105
    return format
87
106
 
88
107
 
89
 
# Note: RemoteBzrDirFormat is in bzrdir.py
90
 
 
91
 
class RemoteBzrDir(BzrDir, _RpcHelper):
 
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):
92
409
    """Control directory on a remote server, accessed via bzr:// or similar."""
93
410
 
94
411
    def __init__(self, transport, format, _client=None, _force_probe=False):
97
414
        :param _client: Private parameter for testing. Disables probing and the
98
415
            use of a real bzrdir.
99
416
        """
100
 
        BzrDir.__init__(self, transport, format)
 
417
        _mod_bzrdir.BzrDir.__init__(self, transport, format)
101
418
        # this object holds a delegated bzrdir that uses file-level operations
102
419
        # to talk to the other side
103
420
        self._real_bzrdir = None
163
480
                import traceback
164
481
                warning('VFS BzrDir access triggered\n%s',
165
482
                    ''.join(traceback.format_stack()))
166
 
            self._real_bzrdir = BzrDir.open_from_transport(
167
 
                self.root_transport, _server_formats=False)
 
483
            self._real_bzrdir = _mod_bzrdir.BzrDir.open_from_transport(
 
484
                self.root_transport, probers=[_mod_bzrdir.BzrProber])
168
485
            self._format._network_name = \
169
486
                self._real_bzrdir._format.network_name()
170
487
 
175
492
        # Prevent aliasing problems in the next_open_branch_result cache.
176
493
        # See create_branch for rationale.
177
494
        self._next_open_branch_result = None
178
 
        return BzrDir.break_lock(self)
 
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
179
538
 
180
539
    def _vfs_cloning_metadir(self, require_stacking=False):
181
540
        self._ensure_real()
212
571
        if len(branch_info) != 2:
213
572
            raise errors.UnexpectedSmartServerResponse(response)
214
573
        branch_ref, branch_name = branch_info
215
 
        format = bzrdir.network_format_registry.get(control_name)
 
574
        try:
 
575
            format = controldir.network_format_registry.get(control_name)
 
576
        except KeyError:
 
577
            raise errors.UnknownFormatError(kind='control', format=control_name)
 
578
 
216
579
        if repo_name:
217
 
            format.repository_format = repository.network_format_registry.get(
218
 
                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)
219
586
        if branch_ref == 'ref':
220
587
            # XXX: we need possible_transports here to avoid reopening the
221
588
            # connection to the referenced location
222
 
            ref_bzrdir = BzrDir.open(branch_name)
 
589
            ref_bzrdir = _mod_bzrdir.BzrDir.open(branch_name)
223
590
            branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
224
591
            format.set_branch_format(branch_format)
225
592
        elif branch_ref == 'branch':
226
593
            if branch_name:
227
 
                format.set_branch_format(
228
 
                    branch.network_format_registry.get(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)
229
601
        else:
230
602
            raise errors.UnexpectedSmartServerResponse(response)
231
603
        return format
241
613
 
242
614
    def destroy_repository(self):
243
615
        """See BzrDir.destroy_repository"""
244
 
        self._ensure_real()
245
 
        self._real_bzrdir.destroy_repository()
 
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,))
246
625
 
247
 
    def create_branch(self, name=None):
 
626
    def create_branch(self, name=None, repository=None,
 
627
                      append_revisions_only=None):
248
628
        # as per meta1 formats - just delegate to the format object which may
249
629
        # be parameterised.
250
630
        real_branch = self._format.get_branch_format().initialize(self,
251
 
            name=name)
 
631
            name=name, repository=repository,
 
632
            append_revisions_only=append_revisions_only)
252
633
        if not isinstance(real_branch, RemoteBranch):
253
 
            result = RemoteBranch(self, self.find_repository(), real_branch,
254
 
                                  name=name)
 
634
            if not isinstance(repository, RemoteRepository):
 
635
                raise AssertionError(
 
636
                    'need a RemoteRepository to use with RemoteBranch, got %r'
 
637
                    % (repository,))
 
638
            result = RemoteBranch(self, repository, real_branch, name=name)
255
639
        else:
256
640
            result = real_branch
257
641
        # BzrDir.clone_on_transport() uses the result of create_branch but does
265
649
 
266
650
    def destroy_branch(self, name=None):
267
651
        """See BzrDir.destroy_branch"""
268
 
        self._ensure_real()
269
 
        self._real_bzrdir.destroy_branch(name=name)
 
652
        path = self._path_for_remote_call(self._client)
 
653
        try:
 
654
            if name is not None:
 
655
                args = (name, )
 
656
            else:
 
657
                args = ()
 
658
            response = self._call('BzrDir.destroy_branch', path, *args)
 
659
        except errors.UnknownSmartMethod:
 
660
            self._ensure_real()
 
661
            self._real_bzrdir.destroy_branch(name=name)
 
662
            self._next_open_branch_result = None
 
663
            return
270
664
        self._next_open_branch_result = None
 
665
        if response[0] != 'ok':
 
666
            raise SmartProtocolError('unexpected response code %s' % (response,))
271
667
 
272
 
    def create_workingtree(self, revision_id=None, from_branch=None):
 
668
    def create_workingtree(self, revision_id=None, from_branch=None,
 
669
        accelerator_tree=None, hardlink=False):
273
670
        raise errors.NotLocalUrl(self.transport.base)
274
671
 
275
 
    def find_branch_format(self):
 
672
    def find_branch_format(self, name=None):
276
673
        """Find the branch 'format' for this bzrdir.
277
674
 
278
675
        This might be a synthetic object for e.g. RemoteBranch and SVN.
279
676
        """
280
 
        b = self.open_branch()
 
677
        b = self.open_branch(name=name)
281
678
        return b._format
282
679
 
283
 
    def get_branch_reference(self):
 
680
    def get_branches(self, possible_transports=None, ignore_fallbacks=False):
 
681
        path = self._path_for_remote_call(self._client)
 
682
        try:
 
683
            response, handler = self._call_expecting_body(
 
684
                'BzrDir.get_branches', path)
 
685
        except errors.UnknownSmartMethod:
 
686
            self._ensure_real()
 
687
            return self._real_bzrdir.get_branches()
 
688
        if response[0] != "success":
 
689
            raise errors.UnexpectedSmartServerResponse(response)
 
690
        body = bencode.bdecode(handler.read_body_bytes())
 
691
        ret = {}
 
692
        for (name, value) in body.iteritems():
 
693
            ret[name] = self._open_branch(name, value[0], value[1],
 
694
                possible_transports=possible_transports,
 
695
                ignore_fallbacks=ignore_fallbacks)
 
696
        return ret
 
697
 
 
698
    def get_branch_reference(self, name=None):
284
699
        """See BzrDir.get_branch_reference()."""
 
700
        if name is not None:
 
701
            # XXX JRV20100304: Support opening colocated branches
 
702
            raise errors.NoColocatedBranchSupport(self)
285
703
        response = self._get_branch_reference()
286
704
        if response[0] == 'ref':
287
705
            return response[1]
318
736
            raise errors.UnexpectedSmartServerResponse(response)
319
737
        return response
320
738
 
321
 
    def _get_tree_branch(self):
 
739
    def _get_tree_branch(self, name=None):
322
740
        """See BzrDir._get_tree_branch()."""
323
 
        return None, self.open_branch()
 
741
        return None, self.open_branch(name=name)
324
742
 
325
 
    def open_branch(self, name=None, unsupported=False,
326
 
                    ignore_fallbacks=False):
327
 
        if unsupported:
328
 
            raise NotImplementedError('unsupported flag support not implemented yet.')
329
 
        if self._next_open_branch_result is not None:
330
 
            # See create_branch for details.
331
 
            result = self._next_open_branch_result
332
 
            self._next_open_branch_result = None
333
 
            return result
334
 
        response = self._get_branch_reference()
335
 
        if response[0] == 'ref':
 
743
    def _open_branch(self, name, kind, location_or_format,
 
744
                     ignore_fallbacks=False, possible_transports=None):
 
745
        if kind == 'ref':
336
746
            # a branch reference, use the existing BranchReference logic.
337
747
            format = BranchReferenceFormat()
338
748
            return format.open(self, name=name, _found=True,
339
 
                location=response[1], ignore_fallbacks=ignore_fallbacks)
340
 
        branch_format_name = response[1]
 
749
                location=location_or_format, ignore_fallbacks=ignore_fallbacks,
 
750
                possible_transports=possible_transports)
 
751
        branch_format_name = location_or_format
341
752
        if not branch_format_name:
342
753
            branch_format_name = None
343
754
        format = RemoteBranchFormat(network_name=branch_format_name)
344
755
        return RemoteBranch(self, self.find_repository(), format=format,
345
 
            setup_stacking=not ignore_fallbacks, name=name)
 
756
            setup_stacking=not ignore_fallbacks, name=name,
 
757
            possible_transports=possible_transports)
 
758
 
 
759
    def open_branch(self, name=None, unsupported=False,
 
760
                    ignore_fallbacks=False, possible_transports=None):
 
761
        if unsupported:
 
762
            raise NotImplementedError('unsupported flag support not implemented yet.')
 
763
        if self._next_open_branch_result is not None:
 
764
            # See create_branch for details.
 
765
            result = self._next_open_branch_result
 
766
            self._next_open_branch_result = None
 
767
            return result
 
768
        response = self._get_branch_reference()
 
769
        return self._open_branch(name, response[0], response[1],
 
770
            possible_transports=possible_transports,
 
771
            ignore_fallbacks=ignore_fallbacks)
346
772
 
347
773
    def _open_repo_v1(self, path):
348
774
        verb = 'BzrDir.find_repository'
411
837
 
412
838
    def has_workingtree(self):
413
839
        if self._has_working_tree is None:
414
 
            self._ensure_real()
415
 
            self._has_working_tree = self._real_bzrdir.has_workingtree()
 
840
            path = self._path_for_remote_call(self._client)
 
841
            try:
 
842
                response = self._call('BzrDir.has_workingtree', path)
 
843
            except errors.UnknownSmartMethod:
 
844
                self._ensure_real()
 
845
                self._has_working_tree = self._real_bzrdir.has_workingtree()
 
846
            else:
 
847
                if response[0] not in ('yes', 'no'):
 
848
                    raise SmartProtocolError('unexpected response code %s' % (response,))
 
849
                self._has_working_tree = (response[0] == 'yes')
416
850
        return self._has_working_tree
417
851
 
418
852
    def open_workingtree(self, recommend_upgrade=True):
423
857
 
424
858
    def _path_for_remote_call(self, client):
425
859
        """Return the path to be used for this bzrdir in a remote call."""
426
 
        return client.remote_path_from_transport(self.root_transport)
 
860
        return urlutils.split_segment_parameters_raw(
 
861
            client.remote_path_from_transport(self.root_transport))[0]
427
862
 
428
863
    def get_branch_transport(self, branch_format, name=None):
429
864
        self._ensure_real()
441
876
        """Upgrading of remote bzrdirs is not supported yet."""
442
877
        return False
443
878
 
444
 
    def needs_format_conversion(self, format=None):
 
879
    def needs_format_conversion(self, format):
445
880
        """Upgrading of remote bzrdirs is not supported yet."""
446
 
        if format is None:
447
 
            symbol_versioning.warn(symbol_versioning.deprecated_in((1, 13, 0))
448
 
                % 'needs_format_conversion(format=None)')
449
881
        return False
450
882
 
451
 
    def clone(self, url, revision_id=None, force_new_repo=False,
452
 
              preserve_stacking=False):
453
 
        self._ensure_real()
454
 
        return self._real_bzrdir.clone(url, revision_id=revision_id,
455
 
            force_new_repo=force_new_repo, preserve_stacking=preserve_stacking)
456
 
 
457
883
    def _get_config(self):
458
884
        return RemoteBzrDirConfig(self)
459
885
 
460
 
 
461
 
class RemoteRepositoryFormat(repository.RepositoryFormat):
 
886
    def _get_config_store(self):
 
887
        return RemoteControlStore(self)
 
888
 
 
889
 
 
890
class RemoteRepositoryFormat(vf_repository.VersionedFileRepositoryFormat):
462
891
    """Format for repositories accessed over a _SmartClient.
463
892
 
464
893
    Instances of this repository are represented by RemoteRepository
479
908
    """
480
909
 
481
910
    _matchingbzrdir = RemoteBzrDirFormat()
 
911
    supports_full_versioned_files = True
 
912
    supports_leaving_lock = True
482
913
 
483
914
    def __init__(self):
484
 
        repository.RepositoryFormat.__init__(self)
 
915
        _mod_repository.RepositoryFormat.__init__(self)
485
916
        self._custom_format = None
486
917
        self._network_name = None
487
918
        self._creating_bzrdir = None
 
919
        self._revision_graph_can_have_wrong_parents = None
488
920
        self._supports_chks = None
489
921
        self._supports_external_lookups = None
490
922
        self._supports_tree_reference = None
 
923
        self._supports_funky_characters = None
 
924
        self._supports_nesting_repositories = None
491
925
        self._rich_root_data = None
492
926
 
493
927
    def __repr__(self):
522
956
        return self._supports_external_lookups
523
957
 
524
958
    @property
 
959
    def supports_funky_characters(self):
 
960
        if self._supports_funky_characters is None:
 
961
            self._ensure_real()
 
962
            self._supports_funky_characters = \
 
963
                self._custom_format.supports_funky_characters
 
964
        return self._supports_funky_characters
 
965
 
 
966
    @property
 
967
    def supports_nesting_repositories(self):
 
968
        if self._supports_nesting_repositories is None:
 
969
            self._ensure_real()
 
970
            self._supports_nesting_repositories = \
 
971
                self._custom_format.supports_nesting_repositories
 
972
        return self._supports_nesting_repositories
 
973
 
 
974
    @property
525
975
    def supports_tree_reference(self):
526
976
        if self._supports_tree_reference is None:
527
977
            self._ensure_real()
529
979
                self._custom_format.supports_tree_reference
530
980
        return self._supports_tree_reference
531
981
 
 
982
    @property
 
983
    def revision_graph_can_have_wrong_parents(self):
 
984
        if self._revision_graph_can_have_wrong_parents is None:
 
985
            self._ensure_real()
 
986
            self._revision_graph_can_have_wrong_parents = \
 
987
                self._custom_format.revision_graph_can_have_wrong_parents
 
988
        return self._revision_graph_can_have_wrong_parents
 
989
 
532
990
    def _vfs_initialize(self, a_bzrdir, shared):
533
991
        """Helper for common code in initialize."""
534
992
        if self._custom_format:
569
1027
            network_name = self._network_name
570
1028
        else:
571
1029
            # Select the current bzrlib default and ask for that.
572
 
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
 
1030
            reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
573
1031
            reference_format = reference_bzrdir_format.repository_format
574
1032
            network_name = reference_format.network_name()
575
1033
        # 2) try direct creation via RPC
601
1059
 
602
1060
    def _ensure_real(self):
603
1061
        if self._custom_format is None:
604
 
            self._custom_format = repository.network_format_registry.get(
605
 
                self._network_name)
 
1062
            try:
 
1063
                self._custom_format = _mod_repository.network_format_registry.get(
 
1064
                    self._network_name)
 
1065
            except KeyError:
 
1066
                raise errors.UnknownFormatError(kind='repository',
 
1067
                    format=self._network_name)
606
1068
 
607
1069
    @property
608
1070
    def _fetch_order(self):
643
1105
        return self._custom_format._serializer
644
1106
 
645
1107
 
646
 
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
647
 
    bzrdir.ControlComponent):
 
1108
class RemoteRepository(_mod_repository.Repository, _RpcHelper,
 
1109
        lock._RelockDebugMixin):
648
1110
    """Repository accessed over rpc.
649
1111
 
650
1112
    For the moment most operations are performed using local transport-backed
674
1136
        self._format = format
675
1137
        self._lock_mode = None
676
1138
        self._lock_token = None
 
1139
        self._write_group_tokens = None
677
1140
        self._lock_count = 0
678
1141
        self._leave_lock = False
679
1142
        # Cache of revision parents; misses are cached during read locks, and
703
1166
        # transport, but I'm not sure it's worth making this method
704
1167
        # optional -- mbp 2010-04-21
705
1168
        return self.bzrdir.get_repository_transport(None)
706
 
        
 
1169
 
707
1170
    def __str__(self):
708
1171
        return "%s(%s)" % (self.__class__.__name__, self.base)
709
1172
 
719
1182
 
720
1183
        :param suppress_errors: see Repository.abort_write_group.
721
1184
        """
722
 
        self._ensure_real()
723
 
        return self._real_repository.abort_write_group(
724
 
            suppress_errors=suppress_errors)
 
1185
        if self._real_repository:
 
1186
            self._ensure_real()
 
1187
            return self._real_repository.abort_write_group(
 
1188
                suppress_errors=suppress_errors)
 
1189
        if not self.is_in_write_group():
 
1190
            if suppress_errors:
 
1191
                mutter('(suppressed) not in write group')
 
1192
                return
 
1193
            raise errors.BzrError("not in write group")
 
1194
        path = self.bzrdir._path_for_remote_call(self._client)
 
1195
        try:
 
1196
            response = self._call('Repository.abort_write_group', path,
 
1197
                self._lock_token, self._write_group_tokens)
 
1198
        except Exception, exc:
 
1199
            self._write_group = None
 
1200
            if not suppress_errors:
 
1201
                raise
 
1202
            mutter('abort_write_group failed')
 
1203
            log_exception_quietly()
 
1204
            note(gettext('bzr: ERROR (ignored): %s'), exc)
 
1205
        else:
 
1206
            if response != ('ok', ):
 
1207
                raise errors.UnexpectedSmartServerResponse(response)
 
1208
            self._write_group_tokens = None
725
1209
 
726
1210
    @property
727
1211
    def chk_bytes(self):
741
1225
        for older plugins that don't use e.g. the CommitBuilder
742
1226
        facility.
743
1227
        """
744
 
        self._ensure_real()
745
 
        return self._real_repository.commit_write_group()
 
1228
        if self._real_repository:
 
1229
            self._ensure_real()
 
1230
            return self._real_repository.commit_write_group()
 
1231
        if not self.is_in_write_group():
 
1232
            raise errors.BzrError("not in write group")
 
1233
        path = self.bzrdir._path_for_remote_call(self._client)
 
1234
        response = self._call('Repository.commit_write_group', path,
 
1235
            self._lock_token, self._write_group_tokens)
 
1236
        if response != ('ok', ):
 
1237
            raise errors.UnexpectedSmartServerResponse(response)
 
1238
        self._write_group_tokens = None
 
1239
        # Refresh data after writing to the repository.
 
1240
        self.refresh_data()
746
1241
 
747
1242
    def resume_write_group(self, tokens):
748
 
        self._ensure_real()
749
 
        return self._real_repository.resume_write_group(tokens)
 
1243
        if self._real_repository:
 
1244
            return self._real_repository.resume_write_group(tokens)
 
1245
        path = self.bzrdir._path_for_remote_call(self._client)
 
1246
        try:
 
1247
            response = self._call('Repository.check_write_group', path,
 
1248
               self._lock_token, tokens)
 
1249
        except errors.UnknownSmartMethod:
 
1250
            self._ensure_real()
 
1251
            return self._real_repository.resume_write_group(tokens)
 
1252
        if response != ('ok', ):
 
1253
            raise errors.UnexpectedSmartServerResponse(response)
 
1254
        self._write_group_tokens = tokens
750
1255
 
751
1256
    def suspend_write_group(self):
752
 
        self._ensure_real()
753
 
        return self._real_repository.suspend_write_group()
 
1257
        if self._real_repository:
 
1258
            return self._real_repository.suspend_write_group()
 
1259
        ret = self._write_group_tokens or []
 
1260
        self._write_group_tokens = None
 
1261
        return ret
754
1262
 
755
1263
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
756
1264
        self._ensure_real()
817
1325
    def find_text_key_references(self):
818
1326
        """Find the text key references within the repository.
819
1327
 
820
 
        :return: a dictionary mapping (file_id, revision_id) tuples to altered file-ids to an iterable of
821
 
        revision_ids. Each altered file-ids has the exact revision_ids that
822
 
        altered it listed explicitly.
823
1328
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
824
1329
            to whether they were referred to by the inventory of the
825
1330
            revision_id that they contain. The inventory texts from all present
843
1348
        """Private method for using with old (< 1.2) servers to fallback."""
844
1349
        if revision_id is None:
845
1350
            revision_id = ''
846
 
        elif revision.is_null(revision_id):
 
1351
        elif _mod_revision.is_null(revision_id):
847
1352
            return {}
848
1353
 
849
1354
        path = self.bzrdir._path_for_remote_call(self._client)
873
1378
        return RemoteStreamSource(self, to_format)
874
1379
 
875
1380
    @needs_read_lock
 
1381
    def get_file_graph(self):
 
1382
        return graph.Graph(self.texts)
 
1383
 
 
1384
    @needs_read_lock
876
1385
    def has_revision(self, revision_id):
877
1386
        """True if this repository has a copy of the revision."""
878
1387
        # Copy of bzrlib.repository.Repository.has_revision
895
1404
    def _has_same_fallbacks(self, other_repo):
896
1405
        """Returns true if the repositories have the same fallbacks."""
897
1406
        # XXX: copied from Repository; it should be unified into a base class
898
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401622>
 
1407
        # <https://bugs.launchpad.net/bzr/+bug/401622>
899
1408
        my_fb = self._fallback_repositories
900
1409
        other_fb = other_repo._fallback_repositories
901
1410
        if len(my_fb) != len(other_fb):
930
1439
        """See Repository.gather_stats()."""
931
1440
        path = self.bzrdir._path_for_remote_call(self._client)
932
1441
        # revid can be None to indicate no revisions, not just NULL_REVISION
933
 
        if revid is None or revision.is_null(revid):
 
1442
        if revid is None or _mod_revision.is_null(revid):
934
1443
            fmt_revid = ''
935
1444
        else:
936
1445
            fmt_revid = revid
965
1474
 
966
1475
    def get_physical_lock_status(self):
967
1476
        """See Repository.get_physical_lock_status()."""
968
 
        # should be an API call to the server.
969
 
        self._ensure_real()
970
 
        return self._real_repository.get_physical_lock_status()
 
1477
        path = self.bzrdir._path_for_remote_call(self._client)
 
1478
        try:
 
1479
            response = self._call('Repository.get_physical_lock_status', path)
 
1480
        except errors.UnknownSmartMethod:
 
1481
            self._ensure_real()
 
1482
            return self._real_repository.get_physical_lock_status()
 
1483
        if response[0] not in ('yes', 'no'):
 
1484
            raise errors.UnexpectedSmartServerResponse(response)
 
1485
        return (response[0] == 'yes')
971
1486
 
972
1487
    def is_in_write_group(self):
973
1488
        """Return True if there is an open write group.
974
1489
 
975
1490
        write groups are only applicable locally for the smart server..
976
1491
        """
 
1492
        if self._write_group_tokens is not None:
 
1493
            return True
977
1494
        if self._real_repository:
978
1495
            return self._real_repository.is_in_write_group()
979
1496
 
997
1514
        pass
998
1515
 
999
1516
    def lock_read(self):
 
1517
        """Lock the repository for read operations.
 
1518
 
 
1519
        :return: A bzrlib.lock.LogicalLockResult.
 
1520
        """
1000
1521
        # wrong eventually - want a local lock cache context
1001
1522
        if not self._lock_mode:
1002
1523
            self._note_lock('r')
1009
1530
                repo.lock_read()
1010
1531
        else:
1011
1532
            self._lock_count += 1
 
1533
        return lock.LogicalLockResult(self.unlock)
1012
1534
 
1013
1535
    def _remote_lock_write(self, token):
1014
1536
        path = self.bzrdir._path_for_remote_call(self._client)
1054
1576
            raise errors.ReadOnlyError(self)
1055
1577
        else:
1056
1578
            self._lock_count += 1
1057
 
        return self._lock_token or None
 
1579
        return RepositoryWriteLockResult(self.unlock, self._lock_token or None)
1058
1580
 
1059
1581
    def leave_lock_in_place(self):
1060
1582
        if not self._lock_token:
1109
1631
            self._real_repository.lock_write(self._lock_token)
1110
1632
        elif self._lock_mode == 'r':
1111
1633
            self._real_repository.lock_read()
 
1634
        if self._write_group_tokens is not None:
 
1635
            # if we are already in a write group, resume it
 
1636
            self._real_repository.resume_write_group(self._write_group_tokens)
 
1637
            self._write_group_tokens = None
1112
1638
 
1113
1639
    def start_write_group(self):
1114
1640
        """Start a write group on the decorated repository.
1118
1644
        for older plugins that don't use e.g. the CommitBuilder
1119
1645
        facility.
1120
1646
        """
1121
 
        self._ensure_real()
1122
 
        return self._real_repository.start_write_group()
 
1647
        if self._real_repository:
 
1648
            self._ensure_real()
 
1649
            return self._real_repository.start_write_group()
 
1650
        if not self.is_write_locked():
 
1651
            raise errors.NotWriteLocked(self)
 
1652
        if self._write_group_tokens is not None:
 
1653
            raise errors.BzrError('already in a write group')
 
1654
        path = self.bzrdir._path_for_remote_call(self._client)
 
1655
        try:
 
1656
            response = self._call('Repository.start_write_group', path,
 
1657
                self._lock_token)
 
1658
        except (errors.UnknownSmartMethod, errors.UnsuspendableWriteGroup):
 
1659
            self._ensure_real()
 
1660
            return self._real_repository.start_write_group()
 
1661
        if response[0] != 'ok':
 
1662
            raise errors.UnexpectedSmartServerResponse(response)
 
1663
        self._write_group_tokens = response[1]
1123
1664
 
1124
1665
    def _unlock(self, token):
1125
1666
        path = self.bzrdir._path_for_remote_call(self._client)
1152
1693
            # This is just to let the _real_repository stay up to date.
1153
1694
            if self._real_repository is not None:
1154
1695
                self._real_repository.unlock()
 
1696
            elif self._write_group_tokens is not None:
 
1697
                self.abort_write_group()
1155
1698
        finally:
1156
1699
            # The rpc-level lock should be released even if there was a
1157
1700
            # problem releasing the vfs-based lock.
1169
1712
 
1170
1713
    def break_lock(self):
1171
1714
        # should hand off to the network
1172
 
        self._ensure_real()
1173
 
        return self._real_repository.break_lock()
 
1715
        path = self.bzrdir._path_for_remote_call(self._client)
 
1716
        try:
 
1717
            response = self._call("Repository.break_lock", path)
 
1718
        except errors.UnknownSmartMethod:
 
1719
            self._ensure_real()
 
1720
            return self._real_repository.break_lock()
 
1721
        if response != ('ok',):
 
1722
            raise errors.UnexpectedSmartServerResponse(response)
1174
1723
 
1175
1724
    def _get_tarball(self, compression):
1176
1725
        """Return a TemporaryFile containing a repository tarball.
1194
1743
            return t
1195
1744
        raise errors.UnexpectedSmartServerResponse(response)
1196
1745
 
 
1746
    @needs_read_lock
1197
1747
    def sprout(self, to_bzrdir, revision_id=None):
1198
 
        # TODO: Option to control what format is created?
1199
 
        self._ensure_real()
1200
 
        dest_repo = self._real_repository._format.initialize(to_bzrdir,
1201
 
                                                             shared=False)
 
1748
        """Create a descendent repository for new development.
 
1749
 
 
1750
        Unlike clone, this does not copy the settings of the repository.
 
1751
        """
 
1752
        dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
1202
1753
        dest_repo.fetch(self, revision_id=revision_id)
1203
1754
        return dest_repo
1204
1755
 
 
1756
    def _create_sprouting_repo(self, a_bzrdir, shared):
 
1757
        if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
 
1758
            # use target default format.
 
1759
            dest_repo = a_bzrdir.create_repository()
 
1760
        else:
 
1761
            # Most control formats need the repository to be specifically
 
1762
            # created, but on some old all-in-one formats it's not needed
 
1763
            try:
 
1764
                dest_repo = self._format.initialize(a_bzrdir, shared=shared)
 
1765
            except errors.UninitializableFormat:
 
1766
                dest_repo = a_bzrdir.open_repository()
 
1767
        return dest_repo
 
1768
 
1205
1769
    ### These methods are just thin shims to the VFS object for now.
1206
1770
 
 
1771
    @needs_read_lock
1207
1772
    def revision_tree(self, revision_id):
1208
 
        self._ensure_real()
1209
 
        return self._real_repository.revision_tree(revision_id)
 
1773
        revision_id = _mod_revision.ensure_null(revision_id)
 
1774
        if revision_id == _mod_revision.NULL_REVISION:
 
1775
            return InventoryRevisionTree(self,
 
1776
                Inventory(root_id=None), _mod_revision.NULL_REVISION)
 
1777
        else:
 
1778
            return list(self.revision_trees([revision_id]))[0]
1210
1779
 
1211
1780
    def get_serializer_format(self):
1212
 
        self._ensure_real()
1213
 
        return self._real_repository.get_serializer_format()
 
1781
        path = self.bzrdir._path_for_remote_call(self._client)
 
1782
        try:
 
1783
            response = self._call('VersionedFileRepository.get_serializer_format',
 
1784
                path)
 
1785
        except errors.UnknownSmartMethod:
 
1786
            self._ensure_real()
 
1787
            return self._real_repository.get_serializer_format()
 
1788
        if response[0] != 'ok':
 
1789
            raise errors.UnexpectedSmartServerResponse(response)
 
1790
        return response[1]
1214
1791
 
1215
1792
    def get_commit_builder(self, branch, parents, config, timestamp=None,
1216
1793
                           timezone=None, committer=None, revprops=None,
1217
 
                           revision_id=None):
1218
 
        # FIXME: It ought to be possible to call this without immediately
1219
 
        # triggering _ensure_real.  For now it's the easiest thing to do.
1220
 
        self._ensure_real()
1221
 
        real_repo = self._real_repository
1222
 
        builder = real_repo.get_commit_builder(branch, parents,
1223
 
                config, timestamp=timestamp, timezone=timezone,
1224
 
                committer=committer, revprops=revprops, revision_id=revision_id)
1225
 
        return builder
 
1794
                           revision_id=None, lossy=False):
 
1795
        """Obtain a CommitBuilder for this repository.
 
1796
 
 
1797
        :param branch: Branch to commit to.
 
1798
        :param parents: Revision ids of the parents of the new revision.
 
1799
        :param config: Configuration to use.
 
1800
        :param timestamp: Optional timestamp recorded for commit.
 
1801
        :param timezone: Optional timezone for timestamp.
 
1802
        :param committer: Optional committer to set for commit.
 
1803
        :param revprops: Optional dictionary of revision properties.
 
1804
        :param revision_id: Optional revision id.
 
1805
        :param lossy: Whether to discard data that can not be natively
 
1806
            represented, when pushing to a foreign VCS
 
1807
        """
 
1808
        if self._fallback_repositories and not self._format.supports_chks:
 
1809
            raise errors.BzrError("Cannot commit directly to a stacked branch"
 
1810
                " in pre-2a formats. See "
 
1811
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
 
1812
        if self._format.rich_root_data:
 
1813
            commit_builder_kls = vf_repository.VersionedFileRootCommitBuilder
 
1814
        else:
 
1815
            commit_builder_kls = vf_repository.VersionedFileCommitBuilder
 
1816
        result = commit_builder_kls(self, parents, config,
 
1817
            timestamp, timezone, committer, revprops, revision_id,
 
1818
            lossy)
 
1819
        self.start_write_group()
 
1820
        return result
1226
1821
 
1227
1822
    def add_fallback_repository(self, repository):
1228
1823
        """Add a repository to use for looking up data not held locally.
1235
1830
        # We need to accumulate additional repositories here, to pass them in
1236
1831
        # on various RPC's.
1237
1832
        #
 
1833
        # Make the check before we lock: this raises an exception.
 
1834
        self._check_fallback_repository(repository)
1238
1835
        if self.is_locked():
1239
1836
            # We will call fallback.unlock() when we transition to the unlocked
1240
1837
            # state, so always add a lock here. If a caller passes us a locked
1241
1838
            # repository, they are responsible for unlocking it later.
1242
1839
            repository.lock_read()
1243
 
        self._check_fallback_repository(repository)
1244
1840
        self._fallback_repositories.append(repository)
1245
1841
        # If self._real_repository was parameterised already (e.g. because a
1246
1842
        # _real_branch had its get_stacked_on_url method called), then the
1272
1868
            delta, new_revision_id, parents, basis_inv=basis_inv,
1273
1869
            propagate_caches=propagate_caches)
1274
1870
 
1275
 
    def add_revision(self, rev_id, rev, inv=None, config=None):
1276
 
        self._ensure_real()
1277
 
        return self._real_repository.add_revision(
1278
 
            rev_id, rev, inv=inv, config=config)
 
1871
    def add_revision(self, revision_id, rev, inv=None):
 
1872
        _mod_revision.check_not_reserved_id(revision_id)
 
1873
        key = (revision_id,)
 
1874
        # check inventory present
 
1875
        if not self.inventories.get_parent_map([key]):
 
1876
            if inv is None:
 
1877
                raise errors.WeaveRevisionNotPresent(revision_id,
 
1878
                                                     self.inventories)
 
1879
            else:
 
1880
                # yes, this is not suitable for adding with ghosts.
 
1881
                rev.inventory_sha1 = self.add_inventory(revision_id, inv,
 
1882
                                                        rev.parent_ids)
 
1883
        else:
 
1884
            rev.inventory_sha1 = self.inventories.get_sha1s([key])[key]
 
1885
        self._add_revision(rev)
 
1886
 
 
1887
    def _add_revision(self, rev):
 
1888
        if self._real_repository is not None:
 
1889
            return self._real_repository._add_revision(rev)
 
1890
        text = self._serializer.write_revision_to_string(rev)
 
1891
        key = (rev.revision_id,)
 
1892
        parents = tuple((parent,) for parent in rev.parent_ids)
 
1893
        self._write_group_tokens, missing_keys = self._get_sink().insert_stream(
 
1894
            [('revisions', [FulltextContentFactory(key, parents, None, text)])],
 
1895
            self._format, self._write_group_tokens)
1279
1896
 
1280
1897
    @needs_read_lock
1281
1898
    def get_inventory(self, revision_id):
 
1899
        return list(self.iter_inventories([revision_id]))[0]
 
1900
 
 
1901
    def _iter_inventories_rpc(self, revision_ids, ordering):
 
1902
        if ordering is None:
 
1903
            ordering = 'unordered'
 
1904
        path = self.bzrdir._path_for_remote_call(self._client)
 
1905
        body = "\n".join(revision_ids)
 
1906
        response_tuple, response_handler = (
 
1907
            self._call_with_body_bytes_expecting_body(
 
1908
                "VersionedFileRepository.get_inventories",
 
1909
                (path, ordering), body))
 
1910
        if response_tuple[0] != "ok":
 
1911
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
1912
        deserializer = inventory_delta.InventoryDeltaDeserializer()
 
1913
        byte_stream = response_handler.read_streamed_body()
 
1914
        decoded = smart_repo._byte_stream_to_stream(byte_stream)
 
1915
        if decoded is None:
 
1916
            # no results whatsoever
 
1917
            return
 
1918
        src_format, stream = decoded
 
1919
        if src_format.network_name() != self._format.network_name():
 
1920
            raise AssertionError(
 
1921
                "Mismatched RemoteRepository and stream src %r, %r" % (
 
1922
                src_format.network_name(), self._format.network_name()))
 
1923
        # ignore the src format, it's not really relevant
 
1924
        prev_inv = Inventory(root_id=None,
 
1925
            revision_id=_mod_revision.NULL_REVISION)
 
1926
        # there should be just one substream, with inventory deltas
 
1927
        substream_kind, substream = stream.next()
 
1928
        if substream_kind != "inventory-deltas":
 
1929
            raise AssertionError(
 
1930
                 "Unexpected stream %r received" % substream_kind)
 
1931
        for record in substream:
 
1932
            (parent_id, new_id, versioned_root, tree_references, invdelta) = (
 
1933
                deserializer.parse_text_bytes(record.get_bytes_as("fulltext")))
 
1934
            if parent_id != prev_inv.revision_id:
 
1935
                raise AssertionError("invalid base %r != %r" % (parent_id,
 
1936
                    prev_inv.revision_id))
 
1937
            inv = prev_inv.create_by_apply_delta(invdelta, new_id)
 
1938
            yield inv, inv.revision_id
 
1939
            prev_inv = inv
 
1940
 
 
1941
    def _iter_inventories_vfs(self, revision_ids, ordering=None):
1282
1942
        self._ensure_real()
1283
 
        return self._real_repository.get_inventory(revision_id)
 
1943
        return self._real_repository._iter_inventories(revision_ids, ordering)
1284
1944
 
1285
1945
    def iter_inventories(self, revision_ids, ordering=None):
1286
 
        self._ensure_real()
1287
 
        return self._real_repository.iter_inventories(revision_ids, ordering)
 
1946
        """Get many inventories by revision_ids.
 
1947
 
 
1948
        This will buffer some or all of the texts used in constructing the
 
1949
        inventories in memory, but will only parse a single inventory at a
 
1950
        time.
 
1951
 
 
1952
        :param revision_ids: The expected revision ids of the inventories.
 
1953
        :param ordering: optional ordering, e.g. 'topological'.  If not
 
1954
            specified, the order of revision_ids will be preserved (by
 
1955
            buffering if necessary).
 
1956
        :return: An iterator of inventories.
 
1957
        """
 
1958
        if ((None in revision_ids)
 
1959
            or (_mod_revision.NULL_REVISION in revision_ids)):
 
1960
            raise ValueError('cannot get null revision inventory')
 
1961
        for inv, revid in self._iter_inventories(revision_ids, ordering):
 
1962
            if inv is None:
 
1963
                raise errors.NoSuchRevision(self, revid)
 
1964
            yield inv
 
1965
 
 
1966
    def _iter_inventories(self, revision_ids, ordering=None):
 
1967
        if len(revision_ids) == 0:
 
1968
            return
 
1969
        missing = set(revision_ids)
 
1970
        if ordering is None:
 
1971
            order_as_requested = True
 
1972
            invs = {}
 
1973
            order = list(revision_ids)
 
1974
            order.reverse()
 
1975
            next_revid = order.pop()
 
1976
        else:
 
1977
            order_as_requested = False
 
1978
            if ordering != 'unordered' and self._fallback_repositories:
 
1979
                raise ValueError('unsupported ordering %r' % ordering)
 
1980
        iter_inv_fns = [self._iter_inventories_rpc] + [
 
1981
            fallback._iter_inventories for fallback in
 
1982
            self._fallback_repositories]
 
1983
        try:
 
1984
            for iter_inv in iter_inv_fns:
 
1985
                request = [revid for revid in revision_ids if revid in missing]
 
1986
                for inv, revid in iter_inv(request, ordering):
 
1987
                    if inv is None:
 
1988
                        continue
 
1989
                    missing.remove(inv.revision_id)
 
1990
                    if ordering != 'unordered':
 
1991
                        invs[revid] = inv
 
1992
                    else:
 
1993
                        yield inv, revid
 
1994
                if order_as_requested:
 
1995
                    # Yield as many results as we can while preserving order.
 
1996
                    while next_revid in invs:
 
1997
                        inv = invs.pop(next_revid)
 
1998
                        yield inv, inv.revision_id
 
1999
                        try:
 
2000
                            next_revid = order.pop()
 
2001
                        except IndexError:
 
2002
                            # We still want to fully consume the stream, just
 
2003
                            # in case it is not actually finished at this point
 
2004
                            next_revid = None
 
2005
                            break
 
2006
        except errors.UnknownSmartMethod:
 
2007
            for inv, revid in self._iter_inventories_vfs(revision_ids, ordering):
 
2008
                yield inv, revid
 
2009
            return
 
2010
        # Report missing
 
2011
        if order_as_requested:
 
2012
            if next_revid is not None:
 
2013
                yield None, next_revid
 
2014
            while order:
 
2015
                revid = order.pop()
 
2016
                yield invs.get(revid), revid
 
2017
        else:
 
2018
            while missing:
 
2019
                yield None, missing.pop()
1288
2020
 
1289
2021
    @needs_read_lock
1290
2022
    def get_revision(self, revision_id):
1291
 
        self._ensure_real()
1292
 
        return self._real_repository.get_revision(revision_id)
 
2023
        return self.get_revisions([revision_id])[0]
1293
2024
 
1294
2025
    def get_transaction(self):
1295
2026
        self._ensure_real()
1297
2028
 
1298
2029
    @needs_read_lock
1299
2030
    def clone(self, a_bzrdir, revision_id=None):
1300
 
        self._ensure_real()
1301
 
        return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
 
2031
        dest_repo = self._create_sprouting_repo(
 
2032
            a_bzrdir, shared=self.is_shared())
 
2033
        self.copy_content_into(dest_repo, revision_id)
 
2034
        return dest_repo
1302
2035
 
1303
2036
    def make_working_trees(self):
1304
2037
        """See Repository.make_working_trees"""
1305
 
        self._ensure_real()
1306
 
        return self._real_repository.make_working_trees()
 
2038
        path = self.bzrdir._path_for_remote_call(self._client)
 
2039
        try:
 
2040
            response = self._call('Repository.make_working_trees', path)
 
2041
        except errors.UnknownSmartMethod:
 
2042
            self._ensure_real()
 
2043
            return self._real_repository.make_working_trees()
 
2044
        if response[0] not in ('yes', 'no'):
 
2045
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
2046
        return response[0] == 'yes'
1307
2047
 
1308
2048
    def refresh_data(self):
1309
 
        """Re-read any data needed to to synchronise with disk.
 
2049
        """Re-read any data needed to synchronise with disk.
1310
2050
 
1311
2051
        This method is intended to be called after another repository instance
1312
2052
        (such as one used by a smart server) has inserted data into the
1313
 
        repository. It may not be called during a write group, but may be
1314
 
        called at any other time.
 
2053
        repository. On all repositories this will work outside of write groups.
 
2054
        Some repository formats (pack and newer for bzrlib native formats)
 
2055
        support refresh_data inside write groups. If called inside a write
 
2056
        group on a repository that does not support refreshing in a write group
 
2057
        IsInWriteGroupError will be raised.
1315
2058
        """
1316
 
        if self.is_in_write_group():
1317
 
            raise errors.InternalBzrError(
1318
 
                "May not refresh_data while in a write group.")
1319
2059
        if self._real_repository is not None:
1320
2060
            self._real_repository.refresh_data()
 
2061
        # Refresh the parents cache for this object
 
2062
        self._unstacked_provider.disable_cache()
 
2063
        self._unstacked_provider.enable_cache()
1321
2064
 
1322
2065
    def revision_ids_to_search_result(self, result_set):
1323
2066
        """Convert a set of revision ids to a graph SearchResult."""
1328
2071
        included_keys = result_set.intersection(result_parents)
1329
2072
        start_keys = result_set.difference(included_keys)
1330
2073
        exclude_keys = result_parents.difference(result_set)
1331
 
        result = graph.SearchResult(start_keys, exclude_keys,
 
2074
        result = vf_search.SearchResult(start_keys, exclude_keys,
1332
2075
            len(result_set), result_set)
1333
2076
        return result
1334
2077
 
1335
2078
    @needs_read_lock
1336
 
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
2079
    def search_missing_revision_ids(self, other,
 
2080
            revision_id=symbol_versioning.DEPRECATED_PARAMETER,
 
2081
            find_ghosts=True, revision_ids=None, if_present_ids=None,
 
2082
            limit=None):
1337
2083
        """Return the revision ids that other has that this does not.
1338
2084
 
1339
2085
        These are returned in topological order.
1340
2086
 
1341
2087
        revision_id: only return revision ids included by revision_id.
1342
2088
        """
1343
 
        return repository.InterRepository.get(
1344
 
            other, self).search_missing_revision_ids(revision_id, find_ghosts)
 
2089
        if symbol_versioning.deprecated_passed(revision_id):
 
2090
            symbol_versioning.warn(
 
2091
                'search_missing_revision_ids(revision_id=...) was '
 
2092
                'deprecated in 2.4.  Use revision_ids=[...] instead.',
 
2093
                DeprecationWarning, stacklevel=2)
 
2094
            if revision_ids is not None:
 
2095
                raise AssertionError(
 
2096
                    'revision_ids is mutually exclusive with revision_id')
 
2097
            if revision_id is not None:
 
2098
                revision_ids = [revision_id]
 
2099
        inter_repo = _mod_repository.InterRepository.get(other, self)
 
2100
        return inter_repo.search_missing_revision_ids(
 
2101
            find_ghosts=find_ghosts, revision_ids=revision_ids,
 
2102
            if_present_ids=if_present_ids, limit=limit)
1345
2103
 
1346
 
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
 
2104
    def fetch(self, source, revision_id=None, find_ghosts=False,
1347
2105
            fetch_spec=None):
1348
2106
        # No base implementation to use as RemoteRepository is not a subclass
1349
2107
        # of Repository; so this is a copy of Repository.fetch().
1360
2118
            # check that last_revision is in 'from' and then return a
1361
2119
            # no-operation.
1362
2120
            if (revision_id is not None and
1363
 
                not revision.is_null(revision_id)):
 
2121
                not _mod_revision.is_null(revision_id)):
1364
2122
                self.get_revision(revision_id)
1365
2123
            return 0, []
1366
2124
        # if there is no specific appropriate InterRepository, this will get
1367
2125
        # the InterRepository base class, which raises an
1368
2126
        # IncompatibleRepositories when asked to fetch.
1369
 
        inter = repository.InterRepository.get(source, self)
1370
 
        return inter.fetch(revision_id=revision_id, pb=pb,
 
2127
        inter = _mod_repository.InterRepository.get(source, self)
 
2128
        if (fetch_spec is not None and
 
2129
            not getattr(inter, "supports_fetch_spec", False)):
 
2130
            raise errors.UnsupportedOperation(
 
2131
                "fetch_spec not supported for %r" % inter)
 
2132
        return inter.fetch(revision_id=revision_id,
1371
2133
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1372
2134
 
1373
2135
    def create_bundle(self, target, base, fileobj, format=None):
1375
2137
        self._real_repository.create_bundle(target, base, fileobj, format)
1376
2138
 
1377
2139
    @needs_read_lock
 
2140
    @symbol_versioning.deprecated_method(
 
2141
        symbol_versioning.deprecated_in((2, 4, 0)))
1378
2142
    def get_ancestry(self, revision_id, topo_sorted=True):
1379
2143
        self._ensure_real()
1380
2144
        return self._real_repository.get_ancestry(revision_id, topo_sorted)
1388
2152
        return self._real_repository._get_versioned_file_checker(
1389
2153
            revisions, revision_versions_cache)
1390
2154
 
 
2155
    def _iter_files_bytes_rpc(self, desired_files, absent):
 
2156
        path = self.bzrdir._path_for_remote_call(self._client)
 
2157
        lines = []
 
2158
        identifiers = []
 
2159
        for (file_id, revid, identifier) in desired_files:
 
2160
            lines.append("%s\0%s" % (
 
2161
                osutils.safe_file_id(file_id),
 
2162
                osutils.safe_revision_id(revid)))
 
2163
            identifiers.append(identifier)
 
2164
        (response_tuple, response_handler) = (
 
2165
            self._call_with_body_bytes_expecting_body(
 
2166
            "Repository.iter_files_bytes", (path, ), "\n".join(lines)))
 
2167
        if response_tuple != ('ok', ):
 
2168
            response_handler.cancel_read_body()
 
2169
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2170
        byte_stream = response_handler.read_streamed_body()
 
2171
        def decompress_stream(start, byte_stream, unused):
 
2172
            decompressor = zlib.decompressobj()
 
2173
            yield decompressor.decompress(start)
 
2174
            while decompressor.unused_data == "":
 
2175
                try:
 
2176
                    data = byte_stream.next()
 
2177
                except StopIteration:
 
2178
                    break
 
2179
                yield decompressor.decompress(data)
 
2180
            yield decompressor.flush()
 
2181
            unused.append(decompressor.unused_data)
 
2182
        unused = ""
 
2183
        while True:
 
2184
            while not "\n" in unused:
 
2185
                unused += byte_stream.next()
 
2186
            header, rest = unused.split("\n", 1)
 
2187
            args = header.split("\0")
 
2188
            if args[0] == "absent":
 
2189
                absent[identifiers[int(args[3])]] = (args[1], args[2])
 
2190
                unused = rest
 
2191
                continue
 
2192
            elif args[0] == "ok":
 
2193
                idx = int(args[1])
 
2194
            else:
 
2195
                raise errors.UnexpectedSmartServerResponse(args)
 
2196
            unused_chunks = []
 
2197
            yield (identifiers[idx],
 
2198
                decompress_stream(rest, byte_stream, unused_chunks))
 
2199
            unused = "".join(unused_chunks)
 
2200
 
1391
2201
    def iter_files_bytes(self, desired_files):
1392
2202
        """See Repository.iter_file_bytes.
1393
2203
        """
1394
 
        self._ensure_real()
1395
 
        return self._real_repository.iter_files_bytes(desired_files)
 
2204
        try:
 
2205
            absent = {}
 
2206
            for (identifier, bytes_iterator) in self._iter_files_bytes_rpc(
 
2207
                    desired_files, absent):
 
2208
                yield identifier, bytes_iterator
 
2209
            for fallback in self._fallback_repositories:
 
2210
                if not absent:
 
2211
                    break
 
2212
                desired_files = [(key[0], key[1], identifier) for
 
2213
                    (identifier, key) in absent.iteritems()]
 
2214
                for (identifier, bytes_iterator) in fallback.iter_files_bytes(desired_files):
 
2215
                    del absent[identifier]
 
2216
                    yield identifier, bytes_iterator
 
2217
            if absent:
 
2218
                # There may be more missing items, but raise an exception
 
2219
                # for just one.
 
2220
                missing_identifier = absent.keys()[0]
 
2221
                missing_key = absent[missing_identifier]
 
2222
                raise errors.RevisionNotPresent(revision_id=missing_key[1],
 
2223
                    file_id=missing_key[0])
 
2224
        except errors.UnknownSmartMethod:
 
2225
            self._ensure_real()
 
2226
            for (identifier, bytes_iterator) in (
 
2227
                self._real_repository.iter_files_bytes(desired_files)):
 
2228
                yield identifier, bytes_iterator
 
2229
 
 
2230
    def get_cached_parent_map(self, revision_ids):
 
2231
        """See bzrlib.CachingParentsProvider.get_cached_parent_map"""
 
2232
        return self._unstacked_provider.get_cached_parent_map(revision_ids)
1396
2233
 
1397
2234
    def get_parent_map(self, revision_ids):
1398
2235
        """See bzrlib.Graph.get_parent_map()."""
1457
2294
        if parents_map is None:
1458
2295
            # Repository is not locked, so there's no cache.
1459
2296
            parents_map = {}
1460
 
        # start_set is all the keys in the cache
1461
 
        start_set = set(parents_map)
1462
 
        # result set is all the references to keys in the cache
1463
 
        result_parents = set()
1464
 
        for parents in parents_map.itervalues():
1465
 
            result_parents.update(parents)
1466
 
        stop_keys = result_parents.difference(start_set)
1467
 
        # We don't need to send ghosts back to the server as a position to
1468
 
        # stop either.
1469
 
        stop_keys.difference_update(self._unstacked_provider.missing_keys)
1470
 
        key_count = len(parents_map)
1471
 
        if (NULL_REVISION in result_parents
1472
 
            and NULL_REVISION in self._unstacked_provider.missing_keys):
1473
 
            # If we pruned NULL_REVISION from the stop_keys because it's also
1474
 
            # in our cache of "missing" keys we need to increment our key count
1475
 
            # by 1, because the reconsitituted SearchResult on the server will
1476
 
            # still consider NULL_REVISION to be an included key.
1477
 
            key_count += 1
1478
 
        included_keys = start_set.intersection(result_parents)
1479
 
        start_set.difference_update(included_keys)
 
2297
        if _DEFAULT_SEARCH_DEPTH <= 0:
 
2298
            (start_set, stop_keys,
 
2299
             key_count) = vf_search.search_result_from_parent_map(
 
2300
                parents_map, self._unstacked_provider.missing_keys)
 
2301
        else:
 
2302
            (start_set, stop_keys,
 
2303
             key_count) = vf_search.limited_search_result_from_parent_map(
 
2304
                parents_map, self._unstacked_provider.missing_keys,
 
2305
                keys, depth=_DEFAULT_SEARCH_DEPTH)
1480
2306
        recipe = ('manual', start_set, stop_keys, key_count)
1481
2307
        body = self._serialise_search_recipe(recipe)
1482
2308
        path = self.bzrdir._path_for_remote_call(self._client)
1531
2357
 
1532
2358
    @needs_read_lock
1533
2359
    def get_signature_text(self, revision_id):
1534
 
        self._ensure_real()
1535
 
        return self._real_repository.get_signature_text(revision_id)
 
2360
        path = self.bzrdir._path_for_remote_call(self._client)
 
2361
        try:
 
2362
            response_tuple, response_handler = self._call_expecting_body(
 
2363
                'Repository.get_revision_signature_text', path, revision_id)
 
2364
        except errors.UnknownSmartMethod:
 
2365
            self._ensure_real()
 
2366
            return self._real_repository.get_signature_text(revision_id)
 
2367
        except errors.NoSuchRevision, err:
 
2368
            for fallback in self._fallback_repositories:
 
2369
                try:
 
2370
                    return fallback.get_signature_text(revision_id)
 
2371
                except errors.NoSuchRevision:
 
2372
                    pass
 
2373
            raise err
 
2374
        else:
 
2375
            if response_tuple[0] != 'ok':
 
2376
                raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2377
            return response_handler.read_body_bytes()
1536
2378
 
1537
2379
    @needs_read_lock
1538
2380
    def _get_inventory_xml(self, revision_id):
 
2381
        # This call is used by older working tree formats,
 
2382
        # which stored a serialized basis inventory.
1539
2383
        self._ensure_real()
1540
2384
        return self._real_repository._get_inventory_xml(revision_id)
1541
2385
 
 
2386
    @needs_write_lock
1542
2387
    def reconcile(self, other=None, thorough=False):
1543
 
        self._ensure_real()
1544
 
        return self._real_repository.reconcile(other=other, thorough=thorough)
 
2388
        from bzrlib.reconcile import RepoReconciler
 
2389
        path = self.bzrdir._path_for_remote_call(self._client)
 
2390
        try:
 
2391
            response, handler = self._call_expecting_body(
 
2392
                'Repository.reconcile', path, self._lock_token)
 
2393
        except (errors.UnknownSmartMethod, errors.TokenLockingNotSupported):
 
2394
            self._ensure_real()
 
2395
            return self._real_repository.reconcile(other=other, thorough=thorough)
 
2396
        if response != ('ok', ):
 
2397
            raise errors.UnexpectedSmartServerResponse(response)
 
2398
        body = handler.read_body_bytes()
 
2399
        result = RepoReconciler(self)
 
2400
        for line in body.split('\n'):
 
2401
            if not line:
 
2402
                continue
 
2403
            key, val_text = line.split(':')
 
2404
            if key == "garbage_inventories":
 
2405
                result.garbage_inventories = int(val_text)
 
2406
            elif key == "inconsistent_parents":
 
2407
                result.inconsistent_parents = int(val_text)
 
2408
            else:
 
2409
                mutter("unknown reconcile key %r" % key)
 
2410
        return result
1545
2411
 
1546
2412
    def all_revision_ids(self):
1547
 
        self._ensure_real()
1548
 
        return self._real_repository.all_revision_ids()
 
2413
        path = self.bzrdir._path_for_remote_call(self._client)
 
2414
        try:
 
2415
            response_tuple, response_handler = self._call_expecting_body(
 
2416
                "Repository.all_revision_ids", path)
 
2417
        except errors.UnknownSmartMethod:
 
2418
            self._ensure_real()
 
2419
            return self._real_repository.all_revision_ids()
 
2420
        if response_tuple != ("ok", ):
 
2421
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2422
        revids = set(response_handler.read_body_bytes().splitlines())
 
2423
        for fallback in self._fallback_repositories:
 
2424
            revids.update(set(fallback.all_revision_ids()))
 
2425
        return list(revids)
 
2426
 
 
2427
    def _filtered_revision_trees(self, revision_ids, file_ids):
 
2428
        """Return Tree for a revision on this branch with only some files.
 
2429
 
 
2430
        :param revision_ids: a sequence of revision-ids;
 
2431
          a revision-id may not be None or 'null:'
 
2432
        :param file_ids: if not None, the result is filtered
 
2433
          so that only those file-ids, their parents and their
 
2434
          children are included.
 
2435
        """
 
2436
        inventories = self.iter_inventories(revision_ids)
 
2437
        for inv in inventories:
 
2438
            # Should we introduce a FilteredRevisionTree class rather
 
2439
            # than pre-filter the inventory here?
 
2440
            filtered_inv = inv.filter(file_ids)
 
2441
            yield InventoryRevisionTree(self, filtered_inv, filtered_inv.revision_id)
1549
2442
 
1550
2443
    @needs_read_lock
1551
2444
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1552
 
        self._ensure_real()
1553
 
        return self._real_repository.get_deltas_for_revisions(revisions,
1554
 
            specific_fileids=specific_fileids)
 
2445
        medium = self._client._medium
 
2446
        if medium._is_remote_before((1, 2)):
 
2447
            self._ensure_real()
 
2448
            for delta in self._real_repository.get_deltas_for_revisions(
 
2449
                    revisions, specific_fileids):
 
2450
                yield delta
 
2451
            return
 
2452
        # Get the revision-ids of interest
 
2453
        required_trees = set()
 
2454
        for revision in revisions:
 
2455
            required_trees.add(revision.revision_id)
 
2456
            required_trees.update(revision.parent_ids[:1])
 
2457
 
 
2458
        # Get the matching filtered trees. Note that it's more
 
2459
        # efficient to pass filtered trees to changes_from() rather
 
2460
        # than doing the filtering afterwards. changes_from() could
 
2461
        # arguably do the filtering itself but it's path-based, not
 
2462
        # file-id based, so filtering before or afterwards is
 
2463
        # currently easier.
 
2464
        if specific_fileids is None:
 
2465
            trees = dict((t.get_revision_id(), t) for
 
2466
                t in self.revision_trees(required_trees))
 
2467
        else:
 
2468
            trees = dict((t.get_revision_id(), t) for
 
2469
                t in self._filtered_revision_trees(required_trees,
 
2470
                specific_fileids))
 
2471
 
 
2472
        # Calculate the deltas
 
2473
        for revision in revisions:
 
2474
            if not revision.parent_ids:
 
2475
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
 
2476
            else:
 
2477
                old_tree = trees[revision.parent_ids[0]]
 
2478
            yield trees[revision.revision_id].changes_from(old_tree)
1555
2479
 
1556
2480
    @needs_read_lock
1557
2481
    def get_revision_delta(self, revision_id, specific_fileids=None):
1558
 
        self._ensure_real()
1559
 
        return self._real_repository.get_revision_delta(revision_id,
1560
 
            specific_fileids=specific_fileids)
 
2482
        r = self.get_revision(revision_id)
 
2483
        return list(self.get_deltas_for_revisions([r],
 
2484
            specific_fileids=specific_fileids))[0]
1561
2485
 
1562
2486
    @needs_read_lock
1563
2487
    def revision_trees(self, revision_ids):
1564
 
        self._ensure_real()
1565
 
        return self._real_repository.revision_trees(revision_ids)
 
2488
        inventories = self.iter_inventories(revision_ids)
 
2489
        for inv in inventories:
 
2490
            yield InventoryRevisionTree(self, inv, inv.revision_id)
1566
2491
 
1567
2492
    @needs_read_lock
1568
2493
    def get_revision_reconcile(self, revision_id):
1576
2501
            callback_refs=callback_refs, check_repo=check_repo)
1577
2502
 
1578
2503
    def copy_content_into(self, destination, revision_id=None):
1579
 
        self._ensure_real()
1580
 
        return self._real_repository.copy_content_into(
1581
 
            destination, revision_id=revision_id)
 
2504
        """Make a complete copy of the content in self into destination.
 
2505
 
 
2506
        This is a destructive operation! Do not use it on existing
 
2507
        repositories.
 
2508
        """
 
2509
        interrepo = _mod_repository.InterRepository.get(self, destination)
 
2510
        return interrepo.copy_content(revision_id)
1582
2511
 
1583
2512
    def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
1584
2513
        # get a tarball of the remote repository, and copy from that into the
1585
2514
        # destination
1586
 
        from bzrlib import osutils
1587
2515
        import tarfile
1588
2516
        # TODO: Maybe a progress bar while streaming the tarball?
1589
 
        note("Copying repository content as tarball...")
 
2517
        note(gettext("Copying repository content as tarball..."))
1590
2518
        tar_file = self._get_tarball('bz2')
1591
2519
        if tar_file is None:
1592
2520
            return None
1597
2525
            tmpdir = osutils.mkdtemp()
1598
2526
            try:
1599
2527
                _extract_tar(tar, tmpdir)
1600
 
                tmp_bzrdir = BzrDir.open(tmpdir)
 
2528
                tmp_bzrdir = _mod_bzrdir.BzrDir.open(tmpdir)
1601
2529
                tmp_repo = tmp_bzrdir.open_repository()
1602
2530
                tmp_repo.copy_content_into(destination, revision_id)
1603
2531
            finally:
1621
2549
    @needs_write_lock
1622
2550
    def pack(self, hint=None, clean_obsolete_packs=False):
1623
2551
        """Compress the data within the repository.
1624
 
 
1625
 
        This is not currently implemented within the smart server.
1626
2552
        """
1627
 
        self._ensure_real()
1628
 
        return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
 
2553
        if hint is None:
 
2554
            body = ""
 
2555
        else:
 
2556
            body = "".join([l+"\n" for l in hint])
 
2557
        path = self.bzrdir._path_for_remote_call(self._client)
 
2558
        try:
 
2559
            response, handler = self._call_with_body_bytes_expecting_body(
 
2560
                'Repository.pack', (path, self._lock_token,
 
2561
                    str(clean_obsolete_packs)), body)
 
2562
        except errors.UnknownSmartMethod:
 
2563
            self._ensure_real()
 
2564
            return self._real_repository.pack(hint=hint,
 
2565
                clean_obsolete_packs=clean_obsolete_packs)
 
2566
        handler.cancel_read_body()
 
2567
        if response != ('ok', ):
 
2568
            raise errors.UnexpectedSmartServerResponse(response)
1629
2569
 
1630
2570
    @property
1631
2571
    def revisions(self):
1632
2572
        """Decorate the real repository for now.
1633
2573
 
1634
 
        In the short term this should become a real object to intercept graph
1635
 
        lookups.
1636
 
 
1637
2574
        In the long term a full blown network facility is needed.
1638
2575
        """
1639
2576
        self._ensure_real()
1667
2604
 
1668
2605
    @needs_write_lock
1669
2606
    def sign_revision(self, revision_id, gpg_strategy):
1670
 
        self._ensure_real()
1671
 
        return self._real_repository.sign_revision(revision_id, gpg_strategy)
 
2607
        testament = _mod_testament.Testament.from_revision(self, revision_id)
 
2608
        plaintext = testament.as_short_text()
 
2609
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1672
2610
 
1673
2611
    @property
1674
2612
    def texts(self):
1680
2618
        self._ensure_real()
1681
2619
        return self._real_repository.texts
1682
2620
 
 
2621
    def _iter_revisions_rpc(self, revision_ids):
 
2622
        body = "\n".join(revision_ids)
 
2623
        path = self.bzrdir._path_for_remote_call(self._client)
 
2624
        response_tuple, response_handler = (
 
2625
            self._call_with_body_bytes_expecting_body(
 
2626
            "Repository.iter_revisions", (path, ), body))
 
2627
        if response_tuple[0] != "ok":
 
2628
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2629
        serializer_format = response_tuple[1]
 
2630
        serializer = serializer_format_registry.get(serializer_format)
 
2631
        byte_stream = response_handler.read_streamed_body()
 
2632
        decompressor = zlib.decompressobj()
 
2633
        chunks = []
 
2634
        for bytes in byte_stream:
 
2635
            chunks.append(decompressor.decompress(bytes))
 
2636
            if decompressor.unused_data != "":
 
2637
                chunks.append(decompressor.flush())
 
2638
                yield serializer.read_revision_from_string("".join(chunks))
 
2639
                unused = decompressor.unused_data
 
2640
                decompressor = zlib.decompressobj()
 
2641
                chunks = [decompressor.decompress(unused)]
 
2642
        chunks.append(decompressor.flush())
 
2643
        text = "".join(chunks)
 
2644
        if text != "":
 
2645
            yield serializer.read_revision_from_string("".join(chunks))
 
2646
 
1683
2647
    @needs_read_lock
1684
2648
    def get_revisions(self, revision_ids):
1685
 
        self._ensure_real()
1686
 
        return self._real_repository.get_revisions(revision_ids)
 
2649
        if revision_ids is None:
 
2650
            revision_ids = self.all_revision_ids()
 
2651
        else:
 
2652
            for rev_id in revision_ids:
 
2653
                if not rev_id or not isinstance(rev_id, basestring):
 
2654
                    raise errors.InvalidRevisionId(
 
2655
                        revision_id=rev_id, branch=self)
 
2656
        try:
 
2657
            missing = set(revision_ids)
 
2658
            revs = {}
 
2659
            for rev in self._iter_revisions_rpc(revision_ids):
 
2660
                missing.remove(rev.revision_id)
 
2661
                revs[rev.revision_id] = rev
 
2662
        except errors.UnknownSmartMethod:
 
2663
            self._ensure_real()
 
2664
            return self._real_repository.get_revisions(revision_ids)
 
2665
        for fallback in self._fallback_repositories:
 
2666
            if not missing:
 
2667
                break
 
2668
            for revid in list(missing):
 
2669
                # XXX JRV 2011-11-20: It would be nice if there was a
 
2670
                # public method on Repository that could be used to query
 
2671
                # for revision objects *without* failing completely if one
 
2672
                # was missing. There is VersionedFileRepository._iter_revisions,
 
2673
                # but unfortunately that's private and not provided by
 
2674
                # all repository implementations.
 
2675
                try:
 
2676
                    revs[revid] = fallback.get_revision(revid)
 
2677
                except errors.NoSuchRevision:
 
2678
                    pass
 
2679
                else:
 
2680
                    missing.remove(revid)
 
2681
        if missing:
 
2682
            raise errors.NoSuchRevision(self, list(missing)[0])
 
2683
        return [revs[revid] for revid in revision_ids]
1687
2684
 
1688
2685
    def supports_rich_root(self):
1689
2686
        return self._format.rich_root_data
1690
2687
 
 
2688
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1691
2689
    def iter_reverse_revision_history(self, revision_id):
1692
2690
        self._ensure_real()
1693
2691
        return self._real_repository.iter_reverse_revision_history(revision_id)
1696
2694
    def _serializer(self):
1697
2695
        return self._format._serializer
1698
2696
 
 
2697
    @needs_write_lock
1699
2698
    def store_revision_signature(self, gpg_strategy, plaintext, revision_id):
1700
 
        self._ensure_real()
1701
 
        return self._real_repository.store_revision_signature(
1702
 
            gpg_strategy, plaintext, revision_id)
 
2699
        signature = gpg_strategy.sign(plaintext)
 
2700
        self.add_signature_text(revision_id, signature)
1703
2701
 
1704
2702
    def add_signature_text(self, revision_id, signature):
1705
 
        self._ensure_real()
1706
 
        return self._real_repository.add_signature_text(revision_id, signature)
 
2703
        if self._real_repository:
 
2704
            # If there is a real repository the write group will
 
2705
            # be in the real repository as well, so use that:
 
2706
            self._ensure_real()
 
2707
            return self._real_repository.add_signature_text(
 
2708
                revision_id, signature)
 
2709
        path = self.bzrdir._path_for_remote_call(self._client)
 
2710
        response, handler = self._call_with_body_bytes_expecting_body(
 
2711
            'Repository.add_signature_text', (path, self._lock_token,
 
2712
                revision_id) + tuple(self._write_group_tokens), signature)
 
2713
        handler.cancel_read_body()
 
2714
        self.refresh_data()
 
2715
        if response[0] != 'ok':
 
2716
            raise errors.UnexpectedSmartServerResponse(response)
 
2717
        self._write_group_tokens = response[1:]
1707
2718
 
1708
2719
    def has_signature_for_revision_id(self, revision_id):
1709
 
        self._ensure_real()
1710
 
        return self._real_repository.has_signature_for_revision_id(revision_id)
 
2720
        path = self.bzrdir._path_for_remote_call(self._client)
 
2721
        try:
 
2722
            response = self._call('Repository.has_signature_for_revision_id',
 
2723
                path, revision_id)
 
2724
        except errors.UnknownSmartMethod:
 
2725
            self._ensure_real()
 
2726
            return self._real_repository.has_signature_for_revision_id(
 
2727
                revision_id)
 
2728
        if response[0] not in ('yes', 'no'):
 
2729
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
2730
        if response[0] == 'yes':
 
2731
            return True
 
2732
        for fallback in self._fallback_repositories:
 
2733
            if fallback.has_signature_for_revision_id(revision_id):
 
2734
                return True
 
2735
        return False
 
2736
 
 
2737
    @needs_read_lock
 
2738
    def verify_revision_signature(self, revision_id, gpg_strategy):
 
2739
        if not self.has_signature_for_revision_id(revision_id):
 
2740
            return gpg.SIGNATURE_NOT_SIGNED, None
 
2741
        signature = self.get_signature_text(revision_id)
 
2742
 
 
2743
        testament = _mod_testament.Testament.from_revision(self, revision_id)
 
2744
        plaintext = testament.as_short_text()
 
2745
 
 
2746
        return gpg_strategy.verify(signature, plaintext)
1711
2747
 
1712
2748
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1713
2749
        self._ensure_real()
1714
2750
        return self._real_repository.item_keys_introduced_by(revision_ids,
1715
2751
            _files_pb=_files_pb)
1716
2752
 
1717
 
    def revision_graph_can_have_wrong_parents(self):
1718
 
        # The answer depends on the remote repo format.
1719
 
        self._ensure_real()
1720
 
        return self._real_repository.revision_graph_can_have_wrong_parents()
1721
 
 
1722
2753
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
1723
2754
        self._ensure_real()
1724
2755
        return self._real_repository._find_inconsistent_revision_parents(
1732
2763
        providers = [self._unstacked_provider]
1733
2764
        if other is not None:
1734
2765
            providers.insert(0, other)
1735
 
        providers.extend(r._make_parents_provider() for r in
1736
 
                         self._fallback_repositories)
1737
 
        return graph.StackedParentsProvider(providers)
 
2766
        return graph.StackedParentsProvider(_LazyListJoin(
 
2767
            providers, self._fallback_repositories))
1738
2768
 
1739
2769
    def _serialise_search_recipe(self, recipe):
1740
2770
        """Serialise a graph search recipe.
1748
2778
        return '\n'.join((start_keys, stop_keys, count))
1749
2779
 
1750
2780
    def _serialise_search_result(self, search_result):
1751
 
        if isinstance(search_result, graph.PendingAncestryResult):
1752
 
            parts = ['ancestry-of']
1753
 
            parts.extend(search_result.heads)
1754
 
        else:
1755
 
            recipe = search_result.get_recipe()
1756
 
            parts = [recipe[0], self._serialise_search_recipe(recipe)]
 
2781
        parts = search_result.get_network_struct()
1757
2782
        return '\n'.join(parts)
1758
2783
 
1759
2784
    def autopack(self):
1769
2794
            raise errors.UnexpectedSmartServerResponse(response)
1770
2795
 
1771
2796
 
1772
 
class RemoteStreamSink(repository.StreamSink):
 
2797
class RemoteStreamSink(vf_repository.StreamSink):
1773
2798
 
1774
2799
    def _insert_real(self, stream, src_format, resume_tokens):
1775
2800
        self.target_repo._ensure_real()
1876
2901
        self._last_substream and self._last_stream so that the stream can be
1877
2902
        resumed by _resume_stream_with_vfs.
1878
2903
        """
1879
 
                    
 
2904
 
1880
2905
        stream_iter = iter(stream)
1881
2906
        for substream_kind, substream in stream_iter:
1882
2907
            if substream_kind == 'inventory-deltas':
1885
2910
                return
1886
2911
            else:
1887
2912
                yield substream_kind, substream
1888
 
            
1889
 
 
1890
 
class RemoteStreamSource(repository.StreamSource):
 
2913
 
 
2914
 
 
2915
class RemoteStreamSource(vf_repository.StreamSource):
1891
2916
    """Stream data from a remote server."""
1892
2917
 
1893
2918
    def get_stream(self, search):
1914
2939
 
1915
2940
    def _real_stream(self, repo, search):
1916
2941
        """Get a stream for search from repo.
1917
 
        
1918
 
        This never called RemoteStreamSource.get_stream, and is a heler
1919
 
        for RemoteStreamSource._get_stream to allow getting a stream 
 
2942
 
 
2943
        This never called RemoteStreamSource.get_stream, and is a helper
 
2944
        for RemoteStreamSource._get_stream to allow getting a stream
1920
2945
        reliably whether fallback back because of old servers or trying
1921
2946
        to stream from a non-RemoteRepository (which the stacked support
1922
2947
        code will do).
1953
2978
        candidate_verbs = [
1954
2979
            ('Repository.get_stream_1.19', (1, 19)),
1955
2980
            ('Repository.get_stream', (1, 13))]
 
2981
 
1956
2982
        found_verb = False
1957
2983
        for verb, version in candidate_verbs:
1958
2984
            if medium._is_remote_before(version):
1962
2988
                    verb, args, search_bytes)
1963
2989
            except errors.UnknownSmartMethod:
1964
2990
                medium._remember_remote_is_before(version)
 
2991
            except errors.UnknownErrorFromSmartServer, e:
 
2992
                if isinstance(search, vf_search.EverythingResult):
 
2993
                    error_verb = e.error_from_smart_server.error_verb
 
2994
                    if error_verb == 'BadSearch':
 
2995
                        # Pre-2.4 servers don't support this sort of search.
 
2996
                        # XXX: perhaps falling back to VFS on BadSearch is a
 
2997
                        # good idea in general?  It might provide a little bit
 
2998
                        # of protection against client-side bugs.
 
2999
                        medium._remember_remote_is_before((2, 4))
 
3000
                        break
 
3001
                raise
1965
3002
            else:
1966
3003
                response_tuple, response_handler = response
1967
3004
                found_verb = True
1971
3008
        if response_tuple[0] != 'ok':
1972
3009
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1973
3010
        byte_stream = response_handler.read_streamed_body()
1974
 
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
 
3011
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream,
 
3012
            self._record_counter)
1975
3013
        if src_format.network_name() != repo._format.network_name():
1976
3014
            raise AssertionError(
1977
3015
                "Mismatched RemoteRepository and stream src %r, %r" % (
2049
3087
 
2050
3088
    def _ensure_real(self):
2051
3089
        if self._custom_format is None:
2052
 
            self._custom_format = branch.network_format_registry.get(
2053
 
                self._network_name)
 
3090
            try:
 
3091
                self._custom_format = branch.network_format_registry.get(
 
3092
                    self._network_name)
 
3093
            except KeyError:
 
3094
                raise errors.UnknownFormatError(kind='branch',
 
3095
                    format=self._network_name)
2054
3096
 
2055
3097
    def get_format_description(self):
2056
3098
        self._ensure_real()
2063
3105
        return a_bzrdir.open_branch(name=name, 
2064
3106
            ignore_fallbacks=ignore_fallbacks)
2065
3107
 
2066
 
    def _vfs_initialize(self, a_bzrdir, name):
 
3108
    def _vfs_initialize(self, a_bzrdir, name, append_revisions_only):
2067
3109
        # Initialisation when using a local bzrdir object, or a non-vfs init
2068
3110
        # method is not available on the server.
2069
3111
        # self._custom_format is always set - the start of initialize ensures
2071
3113
        if isinstance(a_bzrdir, RemoteBzrDir):
2072
3114
            a_bzrdir._ensure_real()
2073
3115
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2074
 
                name)
 
3116
                name, append_revisions_only=append_revisions_only)
2075
3117
        else:
2076
3118
            # We assume the bzrdir is parameterised; it may not be.
2077
 
            result = self._custom_format.initialize(a_bzrdir, name)
 
3119
            result = self._custom_format.initialize(a_bzrdir, name,
 
3120
                append_revisions_only=append_revisions_only)
2078
3121
        if (isinstance(a_bzrdir, RemoteBzrDir) and
2079
3122
            not isinstance(result, RemoteBranch)):
2080
3123
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2081
3124
                                  name=name)
2082
3125
        return result
2083
3126
 
2084
 
    def initialize(self, a_bzrdir, name=None):
 
3127
    def initialize(self, a_bzrdir, name=None, repository=None,
 
3128
                   append_revisions_only=None):
2085
3129
        # 1) get the network name to use.
2086
3130
        if self._custom_format:
2087
3131
            network_name = self._custom_format.network_name()
2088
3132
        else:
2089
3133
            # Select the current bzrlib default and ask for that.
2090
 
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
 
3134
            reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
2091
3135
            reference_format = reference_bzrdir_format.get_branch_format()
2092
3136
            self._custom_format = reference_format
2093
3137
            network_name = reference_format.network_name()
2094
3138
        # Being asked to create on a non RemoteBzrDir:
2095
3139
        if not isinstance(a_bzrdir, RemoteBzrDir):
2096
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
3140
            return self._vfs_initialize(a_bzrdir, name=name,
 
3141
                append_revisions_only=append_revisions_only)
2097
3142
        medium = a_bzrdir._client._medium
2098
3143
        if medium._is_remote_before((1, 13)):
2099
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
3144
            return self._vfs_initialize(a_bzrdir, name=name,
 
3145
                append_revisions_only=append_revisions_only)
2100
3146
        # Creating on a remote bzr dir.
2101
3147
        # 2) try direct creation via RPC
2102
3148
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2109
3155
        except errors.UnknownSmartMethod:
2110
3156
            # Fallback - use vfs methods
2111
3157
            medium._remember_remote_is_before((1, 13))
2112
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
3158
            return self._vfs_initialize(a_bzrdir, name=name,
 
3159
                    append_revisions_only=append_revisions_only)
2113
3160
        if response[0] != 'ok':
2114
3161
            raise errors.UnexpectedSmartServerResponse(response)
2115
3162
        # Turn the response into a RemoteRepository object.
2116
3163
        format = RemoteBranchFormat(network_name=response[1])
2117
3164
        repo_format = response_tuple_to_repo_format(response[3:])
2118
 
        if response[2] == '':
2119
 
            repo_bzrdir = a_bzrdir
 
3165
        repo_path = response[2]
 
3166
        if repository is not None:
 
3167
            remote_repo_url = urlutils.join(a_bzrdir.user_url, repo_path)
 
3168
            url_diff = urlutils.relative_url(repository.user_url,
 
3169
                    remote_repo_url)
 
3170
            if url_diff != '.':
 
3171
                raise AssertionError(
 
3172
                    'repository.user_url %r does not match URL from server '
 
3173
                    'response (%r + %r)'
 
3174
                    % (repository.user_url, a_bzrdir.user_url, repo_path))
 
3175
            remote_repo = repository
2120
3176
        else:
2121
 
            repo_bzrdir = RemoteBzrDir(
2122
 
                a_bzrdir.root_transport.clone(response[2]), a_bzrdir._format,
2123
 
                a_bzrdir._client)
2124
 
        remote_repo = RemoteRepository(repo_bzrdir, repo_format)
 
3177
            if repo_path == '':
 
3178
                repo_bzrdir = a_bzrdir
 
3179
            else:
 
3180
                repo_bzrdir = RemoteBzrDir(
 
3181
                    a_bzrdir.root_transport.clone(repo_path), a_bzrdir._format,
 
3182
                    a_bzrdir._client)
 
3183
            remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2125
3184
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2126
3185
            format=format, setup_stacking=False, name=name)
 
3186
        if append_revisions_only:
 
3187
            remote_branch.set_append_revisions_only(append_revisions_only)
2127
3188
        # XXX: We know this is a new branch, so it must have revno 0, revid
2128
3189
        # NULL_REVISION. Creating the branch locked would make this be unable
2129
3190
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2148
3209
        self._ensure_real()
2149
3210
        return self._custom_format.supports_set_append_revisions_only()
2150
3211
 
 
3212
    def _use_default_local_heads_to_fetch(self):
 
3213
        # If the branch format is a metadir format *and* its heads_to_fetch
 
3214
        # implementation is not overridden vs the base class, we can use the
 
3215
        # base class logic rather than use the heads_to_fetch RPC.  This is
 
3216
        # usually cheaper in terms of net round trips, as the last-revision and
 
3217
        # tags info fetched is cached and would be fetched anyway.
 
3218
        self._ensure_real()
 
3219
        if isinstance(self._custom_format, branch.BranchFormatMetadir):
 
3220
            branch_class = self._custom_format._branch_class()
 
3221
            heads_to_fetch_impl = branch_class.heads_to_fetch.im_func
 
3222
            if heads_to_fetch_impl is branch.Branch.heads_to_fetch.im_func:
 
3223
                return True
 
3224
        return False
 
3225
 
 
3226
 
 
3227
class RemoteBranchStore(_mod_config.IniFileStore):
 
3228
    """Branch store which attempts to use HPSS calls to retrieve branch store.
 
3229
 
 
3230
    Note that this is specific to bzr-based formats.
 
3231
    """
 
3232
 
 
3233
    def __init__(self, branch):
 
3234
        super(RemoteBranchStore, self).__init__()
 
3235
        self.branch = branch
 
3236
        self.id = "branch"
 
3237
        self._real_store = None
 
3238
 
 
3239
    def lock_write(self, token=None):
 
3240
        return self.branch.lock_write(token)
 
3241
 
 
3242
    def unlock(self):
 
3243
        return self.branch.unlock()
 
3244
 
 
3245
    @needs_write_lock
 
3246
    def save(self):
 
3247
        # We need to be able to override the undecorated implementation
 
3248
        self.save_without_locking()
 
3249
 
 
3250
    def save_without_locking(self):
 
3251
        super(RemoteBranchStore, self).save()
 
3252
 
 
3253
    def external_url(self):
 
3254
        return self.branch.user_url
 
3255
 
 
3256
    def _load_content(self):
 
3257
        path = self.branch._remote_path()
 
3258
        try:
 
3259
            response, handler = self.branch._call_expecting_body(
 
3260
                'Branch.get_config_file', path)
 
3261
        except errors.UnknownSmartMethod:
 
3262
            self._ensure_real()
 
3263
            return self._real_store._load_content()
 
3264
        if len(response) and response[0] != 'ok':
 
3265
            raise errors.UnexpectedSmartServerResponse(response)
 
3266
        return handler.read_body_bytes()
 
3267
 
 
3268
    def _save_content(self, content):
 
3269
        path = self.branch._remote_path()
 
3270
        try:
 
3271
            response, handler = self.branch._call_with_body_bytes_expecting_body(
 
3272
                'Branch.put_config_file', (path,
 
3273
                    self.branch._lock_token, self.branch._repo_lock_token),
 
3274
                content)
 
3275
        except errors.UnknownSmartMethod:
 
3276
            self._ensure_real()
 
3277
            return self._real_store._save_content(content)
 
3278
        handler.cancel_read_body()
 
3279
        if response != ('ok', ):
 
3280
            raise errors.UnexpectedSmartServerResponse(response)
 
3281
 
 
3282
    def _ensure_real(self):
 
3283
        self.branch._ensure_real()
 
3284
        if self._real_store is None:
 
3285
            self._real_store = _mod_config.BranchStore(self.branch)
 
3286
 
2151
3287
 
2152
3288
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
2153
3289
    """Branch stored on a server accessed by HPSS RPC.
2156
3292
    """
2157
3293
 
2158
3294
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2159
 
        _client=None, format=None, setup_stacking=True, name=None):
 
3295
        _client=None, format=None, setup_stacking=True, name=None,
 
3296
        possible_transports=None):
2160
3297
        """Create a RemoteBranch instance.
2161
3298
 
2162
3299
        :param real_branch: An optional local implementation of the branch
2227
3364
            hook(self)
2228
3365
        self._is_stacked = False
2229
3366
        if setup_stacking:
2230
 
            self._setup_stacking()
 
3367
            self._setup_stacking(possible_transports)
2231
3368
 
2232
 
    def _setup_stacking(self):
 
3369
    def _setup_stacking(self, possible_transports):
2233
3370
        # configure stacking into the remote repository, by reading it from
2234
3371
        # the vfs branch.
2235
3372
        try:
2238
3375
            errors.UnstackableRepositoryFormat), e:
2239
3376
            return
2240
3377
        self._is_stacked = True
2241
 
        self._activate_fallback_location(fallback_url)
 
3378
        if possible_transports is None:
 
3379
            possible_transports = []
 
3380
        else:
 
3381
            possible_transports = list(possible_transports)
 
3382
        possible_transports.append(self.bzrdir.root_transport)
 
3383
        self._activate_fallback_location(fallback_url,
 
3384
            possible_transports=possible_transports)
2242
3385
 
2243
3386
    def _get_config(self):
2244
3387
        return RemoteBranchConfig(self)
2245
3388
 
 
3389
    def _get_config_store(self):
 
3390
        return RemoteBranchStore(self)
 
3391
 
2246
3392
    def _get_real_transport(self):
2247
3393
        # if we try vfs access, return the real branch's vfs transport
2248
3394
        self._ensure_real()
2311
3457
                self.bzrdir, self._client)
2312
3458
        return self._control_files
2313
3459
 
2314
 
    def _get_checkout_format(self):
2315
 
        self._ensure_real()
2316
 
        return self._real_branch._get_checkout_format()
2317
 
 
2318
3460
    def get_physical_lock_status(self):
2319
3461
        """See Branch.get_physical_lock_status()."""
2320
 
        # should be an API call to the server, as branches must be lockable.
2321
 
        self._ensure_real()
2322
 
        return self._real_branch.get_physical_lock_status()
 
3462
        try:
 
3463
            response = self._client.call('Branch.get_physical_lock_status',
 
3464
                self._remote_path())
 
3465
        except errors.UnknownSmartMethod:
 
3466
            self._ensure_real()
 
3467
            return self._real_branch.get_physical_lock_status()
 
3468
        if response[0] not in ('yes', 'no'):
 
3469
            raise errors.UnexpectedSmartServerResponse(response)
 
3470
        return (response[0] == 'yes')
2323
3471
 
2324
3472
    def get_stacked_on_url(self):
2325
3473
        """Get the URL this branch is stacked against.
2352
3500
            self._is_stacked = False
2353
3501
        else:
2354
3502
            self._is_stacked = True
2355
 
        
 
3503
 
2356
3504
    def _vfs_get_tags_bytes(self):
2357
3505
        self._ensure_real()
2358
3506
        return self._real_branch._get_tags_bytes()
2359
3507
 
 
3508
    @needs_read_lock
2360
3509
    def _get_tags_bytes(self):
 
3510
        if self._tags_bytes is None:
 
3511
            self._tags_bytes = self._get_tags_bytes_via_hpss()
 
3512
        return self._tags_bytes
 
3513
 
 
3514
    def _get_tags_bytes_via_hpss(self):
2361
3515
        medium = self._client._medium
2362
3516
        if medium._is_remote_before((1, 13)):
2363
3517
            return self._vfs_get_tags_bytes()
2373
3527
        return self._real_branch._set_tags_bytes(bytes)
2374
3528
 
2375
3529
    def _set_tags_bytes(self, bytes):
 
3530
        if self.is_locked():
 
3531
            self._tags_bytes = bytes
2376
3532
        medium = self._client._medium
2377
3533
        if medium._is_remote_before((1, 18)):
2378
3534
            self._vfs_set_tags_bytes(bytes)
2387
3543
            self._vfs_set_tags_bytes(bytes)
2388
3544
 
2389
3545
    def lock_read(self):
 
3546
        """Lock the branch for read operations.
 
3547
 
 
3548
        :return: A bzrlib.lock.LogicalLockResult.
 
3549
        """
2390
3550
        self.repository.lock_read()
2391
3551
        if not self._lock_mode:
2392
3552
            self._note_lock('r')
2396
3556
                self._real_branch.lock_read()
2397
3557
        else:
2398
3558
            self._lock_count += 1
 
3559
        return lock.LogicalLockResult(self.unlock)
2399
3560
 
2400
3561
    def _remote_lock_write(self, token):
2401
3562
        if token is None:
2402
3563
            branch_token = repo_token = ''
2403
3564
        else:
2404
3565
            branch_token = token
2405
 
            repo_token = self.repository.lock_write()
 
3566
            repo_token = self.repository.lock_write().repository_token
2406
3567
            self.repository.unlock()
2407
3568
        err_context = {'token': token}
2408
 
        response = self._call(
2409
 
            'Branch.lock_write', self._remote_path(), branch_token,
2410
 
            repo_token or '', **err_context)
 
3569
        try:
 
3570
            response = self._call(
 
3571
                'Branch.lock_write', self._remote_path(), branch_token,
 
3572
                repo_token or '', **err_context)
 
3573
        except errors.LockContention, e:
 
3574
            # The LockContention from the server doesn't have any
 
3575
            # information about the lock_url. We re-raise LockContention
 
3576
            # with valid lock_url.
 
3577
            raise errors.LockContention('(remote lock)',
 
3578
                self.repository.base.split('.bzr/')[0])
2411
3579
        if response[0] != 'ok':
2412
3580
            raise errors.UnexpectedSmartServerResponse(response)
2413
3581
        ok, branch_token, repo_token = response
2434
3602
            self._lock_mode = 'w'
2435
3603
            self._lock_count = 1
2436
3604
        elif self._lock_mode == 'r':
2437
 
            raise errors.ReadOnlyTransaction
 
3605
            raise errors.ReadOnlyError(self)
2438
3606
        else:
2439
3607
            if token is not None:
2440
3608
                # A token was given to lock_write, and we're relocking, so
2445
3613
            self._lock_count += 1
2446
3614
            # Re-lock the repository too.
2447
3615
            self.repository.lock_write(self._repo_lock_token)
2448
 
        return self._lock_token or None
 
3616
        return BranchWriteLockResult(self.unlock, self._lock_token or None)
2449
3617
 
2450
3618
    def _unlock(self, branch_token, repo_token):
2451
3619
        err_context = {'token': str((branch_token, repo_token))}
2489
3657
            self.repository.unlock()
2490
3658
 
2491
3659
    def break_lock(self):
2492
 
        self._ensure_real()
2493
 
        return self._real_branch.break_lock()
 
3660
        try:
 
3661
            response = self._call(
 
3662
                'Branch.break_lock', self._remote_path())
 
3663
        except errors.UnknownSmartMethod:
 
3664
            self._ensure_real()
 
3665
            return self._real_branch.break_lock()
 
3666
        if response != ('ok',):
 
3667
            raise errors.UnexpectedSmartServerResponse(response)
2494
3668
 
2495
3669
    def leave_lock_in_place(self):
2496
3670
        if not self._lock_token:
2520
3694
            missing_parent = parent_map[missing_parent]
2521
3695
        raise errors.RevisionNotPresent(missing_parent, self.repository)
2522
3696
 
2523
 
    def _last_revision_info(self):
 
3697
    def _read_last_revision_info(self):
2524
3698
        response = self._call('Branch.last_revision_info', self._remote_path())
2525
3699
        if response[0] != 'ok':
2526
3700
            raise SmartProtocolError('unexpected response code %s' % (response,))
2589
3763
            raise errors.UnexpectedSmartServerResponse(response)
2590
3764
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2591
3765
 
 
3766
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2592
3767
    @needs_write_lock
2593
3768
    def set_revision_history(self, rev_history):
 
3769
        """See Branch.set_revision_history."""
 
3770
        self._set_revision_history(rev_history)
 
3771
 
 
3772
    @needs_write_lock
 
3773
    def _set_revision_history(self, rev_history):
2594
3774
        # Send just the tip revision of the history; the server will generate
2595
3775
        # the full history from that.  If the revision doesn't exist in this
2596
3776
        # branch, NoSuchRevision will be raised.
2654
3834
            _override_hook_target=self, **kwargs)
2655
3835
 
2656
3836
    @needs_read_lock
2657
 
    def push(self, target, overwrite=False, stop_revision=None):
 
3837
    def push(self, target, overwrite=False, stop_revision=None, lossy=False):
2658
3838
        self._ensure_real()
2659
3839
        return self._real_branch.push(
2660
 
            target, overwrite=overwrite, stop_revision=stop_revision,
 
3840
            target, overwrite=overwrite, stop_revision=stop_revision, lossy=lossy,
2661
3841
            _override_hook_source_branch=self)
2662
3842
 
2663
3843
    def is_locked(self):
2664
3844
        return self._lock_count >= 1
2665
3845
 
2666
3846
    @needs_read_lock
 
3847
    def revision_id_to_dotted_revno(self, revision_id):
 
3848
        """Given a revision id, return its dotted revno.
 
3849
 
 
3850
        :return: a tuple like (1,) or (400,1,3).
 
3851
        """
 
3852
        try:
 
3853
            response = self._call('Branch.revision_id_to_revno',
 
3854
                self._remote_path(), revision_id)
 
3855
        except errors.UnknownSmartMethod:
 
3856
            self._ensure_real()
 
3857
            return self._real_branch.revision_id_to_dotted_revno(revision_id)
 
3858
        if response[0] == 'ok':
 
3859
            return tuple([int(x) for x in response[1:]])
 
3860
        else:
 
3861
            raise errors.UnexpectedSmartServerResponse(response)
 
3862
 
 
3863
    @needs_read_lock
2667
3864
    def revision_id_to_revno(self, revision_id):
2668
 
        self._ensure_real()
2669
 
        return self._real_branch.revision_id_to_revno(revision_id)
 
3865
        """Given a revision id on the branch mainline, return its revno.
 
3866
 
 
3867
        :return: an integer
 
3868
        """
 
3869
        try:
 
3870
            response = self._call('Branch.revision_id_to_revno',
 
3871
                self._remote_path(), revision_id)
 
3872
        except errors.UnknownSmartMethod:
 
3873
            self._ensure_real()
 
3874
            return self._real_branch.revision_id_to_revno(revision_id)
 
3875
        if response[0] == 'ok':
 
3876
            if len(response) == 2:
 
3877
                return int(response[1])
 
3878
            raise NoSuchRevision(self, revision_id)
 
3879
        else:
 
3880
            raise errors.UnexpectedSmartServerResponse(response)
2670
3881
 
2671
3882
    @needs_write_lock
2672
3883
    def set_last_revision_info(self, revno, revision_id):
2673
3884
        # XXX: These should be returned by the set_last_revision_info verb
2674
3885
        old_revno, old_revid = self.last_revision_info()
2675
3886
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2676
 
        revision_id = ensure_null(revision_id)
 
3887
        if not revision_id or not isinstance(revision_id, basestring):
 
3888
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2677
3889
        try:
2678
3890
            response = self._call('Branch.set_last_revision_info',
2679
3891
                self._remote_path(), self._lock_token, self._repo_lock_token,
2708
3920
            except errors.UnknownSmartMethod:
2709
3921
                medium._remember_remote_is_before((1, 6))
2710
3922
        self._clear_cached_state_of_remote_branch_only()
2711
 
        self.set_revision_history(self._lefthand_history(revision_id,
 
3923
        self._set_revision_history(self._lefthand_history(revision_id,
2712
3924
            last_rev=last_rev,other_branch=other_branch))
2713
3925
 
2714
3926
    def set_push_location(self, location):
2715
3927
        self._ensure_real()
2716
3928
        return self._real_branch.set_push_location(location)
2717
3929
 
 
3930
    def heads_to_fetch(self):
 
3931
        if self._format._use_default_local_heads_to_fetch():
 
3932
            # We recognise this format, and its heads-to-fetch implementation
 
3933
            # is the default one (tip + tags).  In this case it's cheaper to
 
3934
            # just use the default implementation rather than a special RPC as
 
3935
            # the tip and tags data is cached.
 
3936
            return branch.Branch.heads_to_fetch(self)
 
3937
        medium = self._client._medium
 
3938
        if medium._is_remote_before((2, 4)):
 
3939
            return self._vfs_heads_to_fetch()
 
3940
        try:
 
3941
            return self._rpc_heads_to_fetch()
 
3942
        except errors.UnknownSmartMethod:
 
3943
            medium._remember_remote_is_before((2, 4))
 
3944
            return self._vfs_heads_to_fetch()
 
3945
 
 
3946
    def _rpc_heads_to_fetch(self):
 
3947
        response = self._call('Branch.heads_to_fetch', self._remote_path())
 
3948
        if len(response) != 2:
 
3949
            raise errors.UnexpectedSmartServerResponse(response)
 
3950
        must_fetch, if_present_fetch = response
 
3951
        return set(must_fetch), set(if_present_fetch)
 
3952
 
 
3953
    def _vfs_heads_to_fetch(self):
 
3954
        self._ensure_real()
 
3955
        return self._real_branch.heads_to_fetch()
 
3956
 
2718
3957
 
2719
3958
class RemoteConfig(object):
2720
3959
    """A Config that reads and writes from smart verbs.
2734
3973
        """
2735
3974
        try:
2736
3975
            configobj = self._get_configobj()
 
3976
            section_obj = None
2737
3977
            if section is None:
2738
3978
                section_obj = configobj
2739
3979
            else:
2740
3980
                try:
2741
3981
                    section_obj = configobj[section]
2742
3982
                except KeyError:
2743
 
                    return default
2744
 
            return section_obj.get(name, default)
 
3983
                    pass
 
3984
            if section_obj is None:
 
3985
                value = default
 
3986
            else:
 
3987
                value = section_obj.get(name, default)
2745
3988
        except errors.UnknownSmartMethod:
2746
 
            return self._vfs_get_option(name, section, default)
 
3989
            value = self._vfs_get_option(name, section, default)
 
3990
        for hook in _mod_config.OldConfigHooks['get']:
 
3991
            hook(self, name, value)
 
3992
        return value
2747
3993
 
2748
3994
    def _response_to_configobj(self, response):
2749
3995
        if len(response[0]) and response[0][0] != 'ok':
2750
3996
            raise errors.UnexpectedSmartServerResponse(response)
2751
3997
        lines = response[1].read_body_bytes().splitlines()
2752
 
        return config.ConfigObj(lines, encoding='utf-8')
 
3998
        conf = _mod_config.ConfigObj(lines, encoding='utf-8')
 
3999
        for hook in _mod_config.OldConfigHooks['load']:
 
4000
            hook(self)
 
4001
        return conf
2753
4002
 
2754
4003
 
2755
4004
class RemoteBranchConfig(RemoteConfig):
2774
4023
        medium = self._branch._client._medium
2775
4024
        if medium._is_remote_before((1, 14)):
2776
4025
            return self._vfs_set_option(value, name, section)
 
4026
        if isinstance(value, dict):
 
4027
            if medium._is_remote_before((2, 2)):
 
4028
                return self._vfs_set_option(value, name, section)
 
4029
            return self._set_config_option_dict(value, name, section)
 
4030
        else:
 
4031
            return self._set_config_option(value, name, section)
 
4032
 
 
4033
    def _set_config_option(self, value, name, section):
2777
4034
        try:
2778
4035
            path = self._branch._remote_path()
2779
4036
            response = self._branch._client.call('Branch.set_config_option',
2780
4037
                path, self._branch._lock_token, self._branch._repo_lock_token,
2781
4038
                value.encode('utf8'), name, section or '')
2782
4039
        except errors.UnknownSmartMethod:
 
4040
            medium = self._branch._client._medium
2783
4041
            medium._remember_remote_is_before((1, 14))
2784
4042
            return self._vfs_set_option(value, name, section)
2785
4043
        if response != ():
2786
4044
            raise errors.UnexpectedSmartServerResponse(response)
2787
4045
 
 
4046
    def _serialize_option_dict(self, option_dict):
 
4047
        utf8_dict = {}
 
4048
        for key, value in option_dict.items():
 
4049
            if isinstance(key, unicode):
 
4050
                key = key.encode('utf8')
 
4051
            if isinstance(value, unicode):
 
4052
                value = value.encode('utf8')
 
4053
            utf8_dict[key] = value
 
4054
        return bencode.bencode(utf8_dict)
 
4055
 
 
4056
    def _set_config_option_dict(self, value, name, section):
 
4057
        try:
 
4058
            path = self._branch._remote_path()
 
4059
            serialised_dict = self._serialize_option_dict(value)
 
4060
            response = self._branch._client.call(
 
4061
                'Branch.set_config_option_dict',
 
4062
                path, self._branch._lock_token, self._branch._repo_lock_token,
 
4063
                serialised_dict, name, section or '')
 
4064
        except errors.UnknownSmartMethod:
 
4065
            medium = self._branch._client._medium
 
4066
            medium._remember_remote_is_before((2, 2))
 
4067
            return self._vfs_set_option(value, name, section)
 
4068
        if response != ():
 
4069
            raise errors.UnexpectedSmartServerResponse(response)
 
4070
 
2788
4071
    def _real_object(self):
2789
4072
        self._branch._ensure_real()
2790
4073
        return self._branch._real_branch
2829
4112
        return self._bzrdir._real_bzrdir
2830
4113
 
2831
4114
 
2832
 
 
2833
4115
def _extract_tar(tar, to_dir):
2834
4116
    """Extract all the contents of a tarfile object.
2835
4117
 
2839
4121
        tar.extract(tarinfo, to_dir)
2840
4122
 
2841
4123
 
 
4124
error_translators = registry.Registry()
 
4125
no_context_error_translators = registry.Registry()
 
4126
 
 
4127
 
2842
4128
def _translate_error(err, **context):
2843
4129
    """Translate an ErrorFromSmartServer into a more useful error.
2844
4130
 
2873
4159
                    'Missing key %r in context %r', key_err.args[0], context)
2874
4160
                raise err
2875
4161
 
2876
 
    if err.error_verb == 'IncompatibleRepositories':
2877
 
        raise errors.IncompatibleRepositories(err.error_args[0],
2878
 
            err.error_args[1], err.error_args[2])
2879
 
    elif err.error_verb == 'NoSuchRevision':
2880
 
        raise NoSuchRevision(find('branch'), err.error_args[0])
2881
 
    elif err.error_verb == 'nosuchrevision':
2882
 
        raise NoSuchRevision(find('repository'), err.error_args[0])
2883
 
    elif err.error_verb == 'nobranch':
2884
 
        if len(err.error_args) >= 1:
2885
 
            extra = err.error_args[0]
2886
 
        else:
2887
 
            extra = None
2888
 
        raise errors.NotBranchError(path=find('bzrdir').root_transport.base,
2889
 
            detail=extra)
2890
 
    elif err.error_verb == 'norepository':
2891
 
        raise errors.NoRepositoryPresent(find('bzrdir'))
2892
 
    elif err.error_verb == 'LockContention':
2893
 
        raise errors.LockContention('(remote lock)')
2894
 
    elif err.error_verb == 'UnlockableTransport':
2895
 
        raise errors.UnlockableTransport(find('bzrdir').root_transport)
2896
 
    elif err.error_verb == 'LockFailed':
2897
 
        raise errors.LockFailed(err.error_args[0], err.error_args[1])
2898
 
    elif err.error_verb == 'TokenMismatch':
2899
 
        raise errors.TokenMismatch(find('token'), '(remote token)')
2900
 
    elif err.error_verb == 'Diverged':
2901
 
        raise errors.DivergedBranches(find('branch'), find('other_branch'))
2902
 
    elif err.error_verb == 'TipChangeRejected':
2903
 
        raise errors.TipChangeRejected(err.error_args[0].decode('utf8'))
2904
 
    elif err.error_verb == 'UnstackableBranchFormat':
2905
 
        raise errors.UnstackableBranchFormat(*err.error_args)
2906
 
    elif err.error_verb == 'UnstackableRepositoryFormat':
2907
 
        raise errors.UnstackableRepositoryFormat(*err.error_args)
2908
 
    elif err.error_verb == 'NotStacked':
2909
 
        raise errors.NotStacked(branch=find('branch'))
2910
 
    elif err.error_verb == 'PermissionDenied':
2911
 
        path = get_path()
2912
 
        if len(err.error_args) >= 2:
2913
 
            extra = err.error_args[1]
2914
 
        else:
2915
 
            extra = None
2916
 
        raise errors.PermissionDenied(path, extra=extra)
2917
 
    elif err.error_verb == 'ReadError':
2918
 
        path = get_path()
2919
 
        raise errors.ReadError(path)
2920
 
    elif err.error_verb == 'NoSuchFile':
2921
 
        path = get_path()
2922
 
        raise errors.NoSuchFile(path)
2923
 
    elif err.error_verb == 'FileExists':
2924
 
        raise errors.FileExists(err.error_args[0])
2925
 
    elif err.error_verb == 'DirectoryNotEmpty':
2926
 
        raise errors.DirectoryNotEmpty(err.error_args[0])
2927
 
    elif err.error_verb == 'ShortReadvError':
2928
 
        args = err.error_args
2929
 
        raise errors.ShortReadvError(
2930
 
            args[0], int(args[1]), int(args[2]), int(args[3]))
2931
 
    elif err.error_verb in ('UnicodeEncodeError', 'UnicodeDecodeError'):
 
4162
    try:
 
4163
        translator = error_translators.get(err.error_verb)
 
4164
    except KeyError:
 
4165
        pass
 
4166
    else:
 
4167
        raise translator(err, find, get_path)
 
4168
    try:
 
4169
        translator = no_context_error_translators.get(err.error_verb)
 
4170
    except KeyError:
 
4171
        raise errors.UnknownErrorFromSmartServer(err)
 
4172
    else:
 
4173
        raise translator(err)
 
4174
 
 
4175
 
 
4176
error_translators.register('NoSuchRevision',
 
4177
    lambda err, find, get_path: NoSuchRevision(
 
4178
        find('branch'), err.error_args[0]))
 
4179
error_translators.register('nosuchrevision',
 
4180
    lambda err, find, get_path: NoSuchRevision(
 
4181
        find('repository'), err.error_args[0]))
 
4182
 
 
4183
def _translate_nobranch_error(err, find, get_path):
 
4184
    if len(err.error_args) >= 1:
 
4185
        extra = err.error_args[0]
 
4186
    else:
 
4187
        extra = None
 
4188
    return errors.NotBranchError(path=find('bzrdir').root_transport.base,
 
4189
        detail=extra)
 
4190
 
 
4191
error_translators.register('nobranch', _translate_nobranch_error)
 
4192
error_translators.register('norepository',
 
4193
    lambda err, find, get_path: errors.NoRepositoryPresent(
 
4194
        find('bzrdir')))
 
4195
error_translators.register('UnlockableTransport',
 
4196
    lambda err, find, get_path: errors.UnlockableTransport(
 
4197
        find('bzrdir').root_transport))
 
4198
error_translators.register('TokenMismatch',
 
4199
    lambda err, find, get_path: errors.TokenMismatch(
 
4200
        find('token'), '(remote token)'))
 
4201
error_translators.register('Diverged',
 
4202
    lambda err, find, get_path: errors.DivergedBranches(
 
4203
        find('branch'), find('other_branch')))
 
4204
error_translators.register('NotStacked',
 
4205
    lambda err, find, get_path: errors.NotStacked(branch=find('branch')))
 
4206
 
 
4207
def _translate_PermissionDenied(err, find, get_path):
 
4208
    path = get_path()
 
4209
    if len(err.error_args) >= 2:
 
4210
        extra = err.error_args[1]
 
4211
    else:
 
4212
        extra = None
 
4213
    return errors.PermissionDenied(path, extra=extra)
 
4214
 
 
4215
error_translators.register('PermissionDenied', _translate_PermissionDenied)
 
4216
error_translators.register('ReadError',
 
4217
    lambda err, find, get_path: errors.ReadError(get_path()))
 
4218
error_translators.register('NoSuchFile',
 
4219
    lambda err, find, get_path: errors.NoSuchFile(get_path()))
 
4220
error_translators.register('TokenLockingNotSupported',
 
4221
    lambda err, find, get_path: errors.TokenLockingNotSupported(
 
4222
        find('repository')))
 
4223
error_translators.register('UnsuspendableWriteGroup',
 
4224
    lambda err, find, get_path: errors.UnsuspendableWriteGroup(
 
4225
        repository=find('repository')))
 
4226
error_translators.register('UnresumableWriteGroup',
 
4227
    lambda err, find, get_path: errors.UnresumableWriteGroup(
 
4228
        repository=find('repository'), write_groups=err.error_args[0],
 
4229
        reason=err.error_args[1]))
 
4230
no_context_error_translators.register('IncompatibleRepositories',
 
4231
    lambda err: errors.IncompatibleRepositories(
 
4232
        err.error_args[0], err.error_args[1], err.error_args[2]))
 
4233
no_context_error_translators.register('LockContention',
 
4234
    lambda err: errors.LockContention('(remote lock)'))
 
4235
no_context_error_translators.register('LockFailed',
 
4236
    lambda err: errors.LockFailed(err.error_args[0], err.error_args[1]))
 
4237
no_context_error_translators.register('TipChangeRejected',
 
4238
    lambda err: errors.TipChangeRejected(err.error_args[0].decode('utf8')))
 
4239
no_context_error_translators.register('UnstackableBranchFormat',
 
4240
    lambda err: errors.UnstackableBranchFormat(*err.error_args))
 
4241
no_context_error_translators.register('UnstackableRepositoryFormat',
 
4242
    lambda err: errors.UnstackableRepositoryFormat(*err.error_args))
 
4243
no_context_error_translators.register('FileExists',
 
4244
    lambda err: errors.FileExists(err.error_args[0]))
 
4245
no_context_error_translators.register('DirectoryNotEmpty',
 
4246
    lambda err: errors.DirectoryNotEmpty(err.error_args[0]))
 
4247
 
 
4248
def _translate_short_readv_error(err):
 
4249
    args = err.error_args
 
4250
    return errors.ShortReadvError(args[0], int(args[1]), int(args[2]),
 
4251
        int(args[3]))
 
4252
 
 
4253
no_context_error_translators.register('ShortReadvError',
 
4254
    _translate_short_readv_error)
 
4255
 
 
4256
def _translate_unicode_error(err):
2932
4257
        encoding = str(err.error_args[0]) # encoding must always be a string
2933
4258
        val = err.error_args[1]
2934
4259
        start = int(err.error_args[2])
2942
4267
            raise UnicodeDecodeError(encoding, val, start, end, reason)
2943
4268
        elif err.error_verb == 'UnicodeEncodeError':
2944
4269
            raise UnicodeEncodeError(encoding, val, start, end, reason)
2945
 
    elif err.error_verb == 'ReadOnlyError':
2946
 
        raise errors.TransportNotPossible('readonly transport')
2947
 
    raise errors.UnknownErrorFromSmartServer(err)
 
4270
 
 
4271
no_context_error_translators.register('UnicodeEncodeError',
 
4272
    _translate_unicode_error)
 
4273
no_context_error_translators.register('UnicodeDecodeError',
 
4274
    _translate_unicode_error)
 
4275
no_context_error_translators.register('ReadOnlyError',
 
4276
    lambda err: errors.TransportNotPossible('readonly transport'))
 
4277
no_context_error_translators.register('MemoryError',
 
4278
    lambda err: errors.BzrError("remote server out of memory\n"
 
4279
        "Retry non-remotely, or contact the server admin for details."))
 
4280
no_context_error_translators.register('RevisionNotPresent',
 
4281
    lambda err: errors.RevisionNotPresent(err.error_args[0], err.error_args[1]))
 
4282
 
 
4283
no_context_error_translators.register('BzrCheckError',
 
4284
    lambda err: errors.BzrCheckError(msg=err.error_args[0]))
 
4285