/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-19 12:08:42 UTC
  • mfrom: (6437.3.8 2.5)
  • mto: (6437.3.14 2.5)
  • mto: This revision was merged to the branch mainline in revision 6444.
  • Revision ID: jelmer@samba.org-20120119120842-xlq5ru2cqfcurnk9
MergeĀ lp:bzr/2.5.

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