~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Jelmer Vernooij
  • Date: 2012-01-06 22:44:57 UTC
  • mfrom: (6436 +trunk)
  • mto: (6437.3.11 2.5)
  • mto: This revision was merged to the branch mainline in revision 6444.
  • Revision ID: jelmer@samba.org-20120106224457-re0pcy0fz31xob77
Merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
from __future__ import absolute_import
 
18
 
17
19
import bz2
 
20
import zlib
18
21
 
19
22
from bzrlib import (
20
23
    bencode,
21
24
    branch,
22
 
    bzrdir,
23
 
    config,
 
25
    bzrdir as _mod_bzrdir,
 
26
    config as _mod_config,
 
27
    controldir,
24
28
    debug,
25
29
    errors,
 
30
    gpg,
26
31
    graph,
 
32
    inventory_delta,
27
33
    lock,
28
34
    lockdir,
29
 
    repository,
 
35
    osutils,
 
36
    registry,
30
37
    repository as _mod_repository,
31
 
    revision,
32
38
    revision as _mod_revision,
33
39
    static_tuple,
34
40
    symbol_versioning,
35
 
)
36
 
from bzrlib.branch import BranchReferenceFormat
37
 
from bzrlib.bzrdir import BzrDir, RemoteBzrDirFormat
 
41
    testament as _mod_testament,
 
42
    urlutils,
 
43
    vf_repository,
 
44
    vf_search,
 
45
    )
 
46
from bzrlib.branch import BranchReferenceFormat, BranchWriteLockResult
38
47
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
39
48
from bzrlib.errors import (
40
49
    NoSuchRevision,
41
50
    SmartProtocolError,
42
51
    )
 
52
from bzrlib.i18n import gettext
 
53
from bzrlib.inventory import Inventory
43
54
from bzrlib.lockable_files import LockableFiles
44
55
from bzrlib.smart import client, vfs, repository as smart_repo
45
 
from bzrlib.revision import ensure_null, NULL_REVISION
46
 
from bzrlib.trace import mutter, note, warning
 
56
from bzrlib.smart.client import _SmartClient
 
57
from bzrlib.revision import NULL_REVISION
 
58
from bzrlib.revisiontree import InventoryRevisionTree
 
59
from bzrlib.repository import RepositoryWriteLockResult, _LazyListJoin
 
60
from bzrlib.serializer import format_registry as serializer_format_registry
 
61
from bzrlib.trace import mutter, note, warning, log_exception_quietly
 
62
from bzrlib.versionedfile import ChunkedContentFactory, FulltextContentFactory
 
63
 
 
64
 
 
65
_DEFAULT_SEARCH_DEPTH = 100
47
66
 
48
67
 
49
68
class _RpcHelper(object):
86
105
    return format
87
106
 
88
107
 
89
 
# Note: RemoteBzrDirFormat is in bzrdir.py
90
 
 
91
 
class RemoteBzrDir(BzrDir, _RpcHelper):
 
108
# Note that RemoteBzrDirProber lives in bzrlib.bzrdir so bzrlib.remote
 
109
# does not have to be imported unless a remote format is involved.
 
110
 
 
111
class RemoteBzrDirFormat(_mod_bzrdir.BzrDirMetaFormat1):
 
112
    """Format representing bzrdirs accessed via a smart server"""
 
113
 
 
114
    supports_workingtrees = False
 
115
 
 
116
    def __init__(self):
 
117
        _mod_bzrdir.BzrDirMetaFormat1.__init__(self)
 
118
        # XXX: It's a bit ugly that the network name is here, because we'd
 
119
        # like to believe that format objects are stateless or at least
 
120
        # immutable,  However, we do at least avoid mutating the name after
 
121
        # it's returned.  See <https://bugs.launchpad.net/bzr/+bug/504102>
 
122
        self._network_name = None
 
123
 
 
124
    def __repr__(self):
 
125
        return "%s(_network_name=%r)" % (self.__class__.__name__,
 
126
            self._network_name)
 
127
 
 
128
    def get_format_description(self):
 
129
        if self._network_name:
 
130
            try:
 
131
                real_format = controldir.network_format_registry.get(
 
132
                        self._network_name)
 
133
            except KeyError:
 
134
                pass
 
135
            else:
 
136
                return 'Remote: ' + real_format.get_format_description()
 
137
        return 'bzr remote bzrdir'
 
138
 
 
139
    def get_format_string(self):
 
140
        raise NotImplementedError(self.get_format_string)
 
141
 
 
142
    def network_name(self):
 
143
        if self._network_name:
 
144
            return self._network_name
 
145
        else:
 
146
            raise AssertionError("No network name set.")
 
147
 
 
148
    def initialize_on_transport(self, transport):
 
149
        try:
 
150
            # hand off the request to the smart server
 
151
            client_medium = transport.get_smart_medium()
 
152
        except errors.NoSmartMedium:
 
153
            # TODO: lookup the local format from a server hint.
 
154
            local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
 
155
            return local_dir_format.initialize_on_transport(transport)
 
156
        client = _SmartClient(client_medium)
 
157
        path = client.remote_path_from_transport(transport)
 
158
        try:
 
159
            response = client.call('BzrDirFormat.initialize', path)
 
160
        except errors.ErrorFromSmartServer, err:
 
161
            _translate_error(err, path=path)
 
162
        if response[0] != 'ok':
 
163
            raise errors.SmartProtocolError('unexpected response code %s' % (response,))
 
164
        format = RemoteBzrDirFormat()
 
165
        self._supply_sub_formats_to(format)
 
166
        return RemoteBzrDir(transport, format)
 
167
 
 
168
    def parse_NoneTrueFalse(self, arg):
 
169
        if not arg:
 
170
            return None
 
171
        if arg == 'False':
 
172
            return False
 
173
        if arg == 'True':
 
174
            return True
 
175
        raise AssertionError("invalid arg %r" % arg)
 
176
 
 
177
    def _serialize_NoneTrueFalse(self, arg):
 
178
        if arg is False:
 
179
            return 'False'
 
180
        if arg:
 
181
            return 'True'
 
182
        return ''
 
183
 
 
184
    def _serialize_NoneString(self, arg):
 
185
        return arg or ''
 
186
 
 
187
    def initialize_on_transport_ex(self, transport, use_existing_dir=False,
 
188
        create_prefix=False, force_new_repo=False, stacked_on=None,
 
189
        stack_on_pwd=None, repo_format_name=None, make_working_trees=None,
 
190
        shared_repo=False):
 
191
        try:
 
192
            # hand off the request to the smart server
 
193
            client_medium = transport.get_smart_medium()
 
194
        except errors.NoSmartMedium:
 
195
            do_vfs = True
 
196
        else:
 
197
            # Decline to open it if the server doesn't support our required
 
198
            # version (3) so that the VFS-based transport will do it.
 
199
            if client_medium.should_probe():
 
200
                try:
 
201
                    server_version = client_medium.protocol_version()
 
202
                    if server_version != '2':
 
203
                        do_vfs = True
 
204
                    else:
 
205
                        do_vfs = False
 
206
                except errors.SmartProtocolError:
 
207
                    # Apparently there's no usable smart server there, even though
 
208
                    # the medium supports the smart protocol.
 
209
                    do_vfs = True
 
210
            else:
 
211
                do_vfs = False
 
212
        if not do_vfs:
 
213
            client = _SmartClient(client_medium)
 
214
            path = client.remote_path_from_transport(transport)
 
215
            if client_medium._is_remote_before((1, 16)):
 
216
                do_vfs = True
 
217
        if do_vfs:
 
218
            # TODO: lookup the local format from a server hint.
 
219
            local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
 
220
            self._supply_sub_formats_to(local_dir_format)
 
221
            return local_dir_format.initialize_on_transport_ex(transport,
 
222
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
223
                force_new_repo=force_new_repo, stacked_on=stacked_on,
 
224
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
225
                make_working_trees=make_working_trees, shared_repo=shared_repo,
 
226
                vfs_only=True)
 
227
        return self._initialize_on_transport_ex_rpc(client, path, transport,
 
228
            use_existing_dir, create_prefix, force_new_repo, stacked_on,
 
229
            stack_on_pwd, repo_format_name, make_working_trees, shared_repo)
 
230
 
 
231
    def _initialize_on_transport_ex_rpc(self, client, path, transport,
 
232
        use_existing_dir, create_prefix, force_new_repo, stacked_on,
 
233
        stack_on_pwd, repo_format_name, make_working_trees, shared_repo):
 
234
        args = []
 
235
        args.append(self._serialize_NoneTrueFalse(use_existing_dir))
 
236
        args.append(self._serialize_NoneTrueFalse(create_prefix))
 
237
        args.append(self._serialize_NoneTrueFalse(force_new_repo))
 
238
        args.append(self._serialize_NoneString(stacked_on))
 
239
        # stack_on_pwd is often/usually our transport
 
240
        if stack_on_pwd:
 
241
            try:
 
242
                stack_on_pwd = transport.relpath(stack_on_pwd)
 
243
                if not stack_on_pwd:
 
244
                    stack_on_pwd = '.'
 
245
            except errors.PathNotChild:
 
246
                pass
 
247
        args.append(self._serialize_NoneString(stack_on_pwd))
 
248
        args.append(self._serialize_NoneString(repo_format_name))
 
249
        args.append(self._serialize_NoneTrueFalse(make_working_trees))
 
250
        args.append(self._serialize_NoneTrueFalse(shared_repo))
 
251
        request_network_name = self._network_name or \
 
252
            _mod_bzrdir.BzrDirFormat.get_default_format().network_name()
 
253
        try:
 
254
            response = client.call('BzrDirFormat.initialize_ex_1.16',
 
255
                request_network_name, path, *args)
 
256
        except errors.UnknownSmartMethod:
 
257
            client._medium._remember_remote_is_before((1,16))
 
258
            local_dir_format = _mod_bzrdir.BzrDirMetaFormat1()
 
259
            self._supply_sub_formats_to(local_dir_format)
 
260
            return local_dir_format.initialize_on_transport_ex(transport,
 
261
                use_existing_dir=use_existing_dir, create_prefix=create_prefix,
 
262
                force_new_repo=force_new_repo, stacked_on=stacked_on,
 
263
                stack_on_pwd=stack_on_pwd, repo_format_name=repo_format_name,
 
264
                make_working_trees=make_working_trees, shared_repo=shared_repo,
 
265
                vfs_only=True)
 
266
        except errors.ErrorFromSmartServer, err:
 
267
            _translate_error(err, path=path)
 
268
        repo_path = response[0]
 
269
        bzrdir_name = response[6]
 
270
        require_stacking = response[7]
 
271
        require_stacking = self.parse_NoneTrueFalse(require_stacking)
 
272
        format = RemoteBzrDirFormat()
 
273
        format._network_name = bzrdir_name
 
274
        self._supply_sub_formats_to(format)
 
275
        bzrdir = RemoteBzrDir(transport, format, _client=client)
 
276
        if repo_path:
 
277
            repo_format = response_tuple_to_repo_format(response[1:])
 
278
            if repo_path == '.':
 
279
                repo_path = ''
 
280
            if repo_path:
 
281
                repo_bzrdir_format = RemoteBzrDirFormat()
 
282
                repo_bzrdir_format._network_name = response[5]
 
283
                repo_bzr = RemoteBzrDir(transport.clone(repo_path),
 
284
                    repo_bzrdir_format)
 
285
            else:
 
286
                repo_bzr = bzrdir
 
287
            final_stack = response[8] or None
 
288
            final_stack_pwd = response[9] or None
 
289
            if final_stack_pwd:
 
290
                final_stack_pwd = urlutils.join(
 
291
                    transport.base, final_stack_pwd)
 
292
            remote_repo = RemoteRepository(repo_bzr, repo_format)
 
293
            if len(response) > 10:
 
294
                # Updated server verb that locks remotely.
 
295
                repo_lock_token = response[10] or None
 
296
                remote_repo.lock_write(repo_lock_token, _skip_rpc=True)
 
297
                if repo_lock_token:
 
298
                    remote_repo.dont_leave_lock_in_place()
 
299
            else:
 
300
                remote_repo.lock_write()
 
301
            policy = _mod_bzrdir.UseExistingRepository(remote_repo, final_stack,
 
302
                final_stack_pwd, require_stacking)
 
303
            policy.acquire_repository()
 
304
        else:
 
305
            remote_repo = None
 
306
            policy = None
 
307
        bzrdir._format.set_branch_format(self.get_branch_format())
 
308
        if require_stacking:
 
309
            # The repo has already been created, but we need to make sure that
 
310
            # we'll make a stackable branch.
 
311
            bzrdir._format.require_stacking(_skip_repo=True)
 
312
        return remote_repo, bzrdir, require_stacking, policy
 
313
 
 
314
    def _open(self, transport):
 
315
        return RemoteBzrDir(transport, self)
 
316
 
 
317
    def __eq__(self, other):
 
318
        if not isinstance(other, RemoteBzrDirFormat):
 
319
            return False
 
320
        return self.get_format_description() == other.get_format_description()
 
321
 
 
322
    def __return_repository_format(self):
 
323
        # Always return a RemoteRepositoryFormat object, but if a specific bzr
 
324
        # repository format has been asked for, tell the RemoteRepositoryFormat
 
325
        # that it should use that for init() etc.
 
326
        result = RemoteRepositoryFormat()
 
327
        custom_format = getattr(self, '_repository_format', None)
 
328
        if custom_format:
 
329
            if isinstance(custom_format, RemoteRepositoryFormat):
 
330
                return custom_format
 
331
            else:
 
332
                # We will use the custom format to create repositories over the
 
333
                # wire; expose its details like rich_root_data for code to
 
334
                # query
 
335
                result._custom_format = custom_format
 
336
        return result
 
337
 
 
338
    def get_branch_format(self):
 
339
        result = _mod_bzrdir.BzrDirMetaFormat1.get_branch_format(self)
 
340
        if not isinstance(result, RemoteBranchFormat):
 
341
            new_result = RemoteBranchFormat()
 
342
            new_result._custom_format = result
 
343
            # cache the result
 
344
            self.set_branch_format(new_result)
 
345
            result = new_result
 
346
        return result
 
347
 
 
348
    repository_format = property(__return_repository_format,
 
349
        _mod_bzrdir.BzrDirMetaFormat1._set_repository_format) #.im_func)
 
350
 
 
351
 
 
352
class RemoteControlStore(_mod_config.IniFileStore):
 
353
    """Control store which attempts to use HPSS calls to retrieve control store.
 
354
 
 
355
    Note that this is specific to bzr-based formats.
 
356
    """
 
357
 
 
358
    def __init__(self, bzrdir):
 
359
        super(RemoteControlStore, self).__init__()
 
360
        self.bzrdir = bzrdir
 
361
        self._real_store = None
 
362
 
 
363
    def lock_write(self, token=None):
 
364
        self._ensure_real()
 
365
        return self._real_store.lock_write(token)
 
366
 
 
367
    def unlock(self):
 
368
        self._ensure_real()
 
369
        return self._real_store.unlock()
 
370
 
 
371
    @needs_write_lock
 
372
    def save(self):
 
373
        # We need to be able to override the undecorated implementation
 
374
        self.save_without_locking()
 
375
 
 
376
    def save_without_locking(self):
 
377
        super(RemoteControlStore, self).save()
 
378
 
 
379
    def _ensure_real(self):
 
380
        self.bzrdir._ensure_real()
 
381
        if self._real_store is None:
 
382
            self._real_store = _mod_config.ControlStore(self.bzrdir)
 
383
 
 
384
    def external_url(self):
 
385
        return self.bzrdir.user_url
 
386
 
 
387
    def _load_content(self):
 
388
        medium = self.bzrdir._client._medium
 
389
        path = self.bzrdir._path_for_remote_call(self.bzrdir._client)
 
390
        try:
 
391
            response, handler = self.bzrdir._call_expecting_body(
 
392
                'BzrDir.get_config_file', path)
 
393
        except errors.UnknownSmartMethod:
 
394
            self._ensure_real()
 
395
            return self._real_store._load_content()
 
396
        if len(response) and response[0] != 'ok':
 
397
            raise errors.UnexpectedSmartServerResponse(response)
 
398
        return handler.read_body_bytes()
 
399
 
 
400
    def _save_content(self, content):
 
401
        # FIXME JRV 2011-11-22: Ideally this should use a
 
402
        # HPSS call too, but at the moment it is not possible
 
403
        # to write lock control directories.
 
404
        self._ensure_real()
 
405
        return self._real_store._save_content(content)
 
406
 
 
407
 
 
408
class RemoteBzrDir(_mod_bzrdir.BzrDir, _RpcHelper):
92
409
    """Control directory on a remote server, accessed via bzr:// or similar."""
93
410
 
94
411
    def __init__(self, transport, format, _client=None, _force_probe=False):
97
414
        :param _client: Private parameter for testing. Disables probing and the
98
415
            use of a real bzrdir.
99
416
        """
100
 
        BzrDir.__init__(self, transport, format)
 
417
        _mod_bzrdir.BzrDir.__init__(self, transport, format)
101
418
        # this object holds a delegated bzrdir that uses file-level operations
102
419
        # to talk to the other side
103
420
        self._real_bzrdir = None
163
480
                import traceback
164
481
                warning('VFS BzrDir access triggered\n%s',
165
482
                    ''.join(traceback.format_stack()))
166
 
            self._real_bzrdir = BzrDir.open_from_transport(
167
 
                self.root_transport, _server_formats=False)
 
483
            self._real_bzrdir = _mod_bzrdir.BzrDir.open_from_transport(
 
484
                self.root_transport, probers=[_mod_bzrdir.BzrProber])
168
485
            self._format._network_name = \
169
486
                self._real_bzrdir._format.network_name()
170
487
 
175
492
        # Prevent aliasing problems in the next_open_branch_result cache.
176
493
        # See create_branch for rationale.
177
494
        self._next_open_branch_result = None
178
 
        return BzrDir.break_lock(self)
 
495
        return _mod_bzrdir.BzrDir.break_lock(self)
 
496
 
 
497
    def _vfs_checkout_metadir(self):
 
498
        self._ensure_real()
 
499
        return self._real_bzrdir.checkout_metadir()
 
500
 
 
501
    def checkout_metadir(self):
 
502
        """Retrieve the controldir format to use for checkouts of this one.
 
503
        """
 
504
        medium = self._client._medium
 
505
        if medium._is_remote_before((2, 5)):
 
506
            return self._vfs_checkout_metadir()
 
507
        path = self._path_for_remote_call(self._client)
 
508
        try:
 
509
            response = self._client.call('BzrDir.checkout_metadir',
 
510
                path)
 
511
        except errors.UnknownSmartMethod:
 
512
            medium._remember_remote_is_before((2, 5))
 
513
            return self._vfs_checkout_metadir()
 
514
        if len(response) != 3:
 
515
            raise errors.UnexpectedSmartServerResponse(response)
 
516
        control_name, repo_name, branch_name = response
 
517
        try:
 
518
            format = controldir.network_format_registry.get(control_name)
 
519
        except KeyError:
 
520
            raise errors.UnknownFormatError(kind='control',
 
521
                format=control_name)
 
522
        if repo_name:
 
523
            try:
 
524
                repo_format = _mod_repository.network_format_registry.get(
 
525
                    repo_name)
 
526
            except KeyError:
 
527
                raise errors.UnknownFormatError(kind='repository',
 
528
                    format=repo_name)
 
529
            format.repository_format = repo_format
 
530
        if branch_name:
 
531
            try:
 
532
                format.set_branch_format(
 
533
                    branch.network_format_registry.get(branch_name))
 
534
            except KeyError:
 
535
                raise errors.UnknownFormatError(kind='branch',
 
536
                    format=branch_name)
 
537
        return format
179
538
 
180
539
    def _vfs_cloning_metadir(self, require_stacking=False):
181
540
        self._ensure_real()
212
571
        if len(branch_info) != 2:
213
572
            raise errors.UnexpectedSmartServerResponse(response)
214
573
        branch_ref, branch_name = branch_info
215
 
        format = bzrdir.network_format_registry.get(control_name)
 
574
        try:
 
575
            format = controldir.network_format_registry.get(control_name)
 
576
        except KeyError:
 
577
            raise errors.UnknownFormatError(kind='control', format=control_name)
 
578
 
216
579
        if repo_name:
217
 
            format.repository_format = repository.network_format_registry.get(
218
 
                repo_name)
 
580
            try:
 
581
                format.repository_format = _mod_repository.network_format_registry.get(
 
582
                    repo_name)
 
583
            except KeyError:
 
584
                raise errors.UnknownFormatError(kind='repository',
 
585
                    format=repo_name)
219
586
        if branch_ref == 'ref':
220
587
            # XXX: we need possible_transports here to avoid reopening the
221
588
            # connection to the referenced location
222
 
            ref_bzrdir = BzrDir.open(branch_name)
 
589
            ref_bzrdir = _mod_bzrdir.BzrDir.open(branch_name)
223
590
            branch_format = ref_bzrdir.cloning_metadir().get_branch_format()
224
591
            format.set_branch_format(branch_format)
225
592
        elif branch_ref == 'branch':
226
593
            if branch_name:
227
 
                format.set_branch_format(
228
 
                    branch.network_format_registry.get(branch_name))
 
594
                try:
 
595
                    branch_format = branch.network_format_registry.get(
 
596
                        branch_name)
 
597
                except KeyError:
 
598
                    raise errors.UnknownFormatError(kind='branch',
 
599
                        format=branch_name)
 
600
                format.set_branch_format(branch_format)
229
601
        else:
230
602
            raise errors.UnexpectedSmartServerResponse(response)
231
603
        return format
241
613
 
242
614
    def destroy_repository(self):
243
615
        """See BzrDir.destroy_repository"""
244
 
        self._ensure_real()
245
 
        self._real_bzrdir.destroy_repository()
 
616
        path = self._path_for_remote_call(self._client)
 
617
        try:
 
618
            response = self._call('BzrDir.destroy_repository', path)
 
619
        except errors.UnknownSmartMethod:
 
620
            self._ensure_real()
 
621
            self._real_bzrdir.destroy_repository()
 
622
            return
 
623
        if response[0] != 'ok':
 
624
            raise SmartProtocolError('unexpected response code %s' % (response,))
246
625
 
247
 
    def create_branch(self, name=None):
 
626
    def create_branch(self, name=None, repository=None,
 
627
                      append_revisions_only=None):
248
628
        # as per meta1 formats - just delegate to the format object which may
249
629
        # be parameterised.
250
630
        real_branch = self._format.get_branch_format().initialize(self,
251
 
            name=name)
 
631
            name=name, repository=repository,
 
632
            append_revisions_only=append_revisions_only)
252
633
        if not isinstance(real_branch, RemoteBranch):
253
 
            result = RemoteBranch(self, self.find_repository(), real_branch,
254
 
                                  name=name)
 
634
            if not isinstance(repository, RemoteRepository):
 
635
                raise AssertionError(
 
636
                    'need a RemoteRepository to use with RemoteBranch, got %r'
 
637
                    % (repository,))
 
638
            result = RemoteBranch(self, repository, real_branch, name=name)
255
639
        else:
256
640
            result = real_branch
257
641
        # BzrDir.clone_on_transport() uses the result of create_branch but does
265
649
 
266
650
    def destroy_branch(self, name=None):
267
651
        """See BzrDir.destroy_branch"""
268
 
        self._ensure_real()
269
 
        self._real_bzrdir.destroy_branch(name=name)
 
652
        path = self._path_for_remote_call(self._client)
 
653
        try:
 
654
            if name is not None:
 
655
                args = (name, )
 
656
            else:
 
657
                args = ()
 
658
            response = self._call('BzrDir.destroy_branch', path, *args)
 
659
        except errors.UnknownSmartMethod:
 
660
            self._ensure_real()
 
661
            self._real_bzrdir.destroy_branch(name=name)
 
662
            self._next_open_branch_result = None
 
663
            return
270
664
        self._next_open_branch_result = None
 
665
        if response[0] != 'ok':
 
666
            raise SmartProtocolError('unexpected response code %s' % (response,))
271
667
 
272
 
    def create_workingtree(self, revision_id=None, from_branch=None):
 
668
    def create_workingtree(self, revision_id=None, from_branch=None,
 
669
        accelerator_tree=None, hardlink=False):
273
670
        raise errors.NotLocalUrl(self.transport.base)
274
671
 
275
 
    def find_branch_format(self):
 
672
    def find_branch_format(self, name=None):
276
673
        """Find the branch 'format' for this bzrdir.
277
674
 
278
675
        This might be a synthetic object for e.g. RemoteBranch and SVN.
279
676
        """
280
 
        b = self.open_branch()
 
677
        b = self.open_branch(name=name)
281
678
        return b._format
282
679
 
283
 
    def get_branch_reference(self):
 
680
    def get_branch_reference(self, name=None):
284
681
        """See BzrDir.get_branch_reference()."""
 
682
        if name is not None:
 
683
            # XXX JRV20100304: Support opening colocated branches
 
684
            raise errors.NoColocatedBranchSupport(self)
285
685
        response = self._get_branch_reference()
286
686
        if response[0] == 'ref':
287
687
            return response[1]
318
718
            raise errors.UnexpectedSmartServerResponse(response)
319
719
        return response
320
720
 
321
 
    def _get_tree_branch(self):
 
721
    def _get_tree_branch(self, name=None):
322
722
        """See BzrDir._get_tree_branch()."""
323
 
        return None, self.open_branch()
 
723
        return None, self.open_branch(name=name)
324
724
 
325
725
    def open_branch(self, name=None, unsupported=False,
326
 
                    ignore_fallbacks=False):
 
726
                    ignore_fallbacks=False, possible_transports=None):
327
727
        if unsupported:
328
728
            raise NotImplementedError('unsupported flag support not implemented yet.')
329
729
        if self._next_open_branch_result is not None:
336
736
            # a branch reference, use the existing BranchReference logic.
337
737
            format = BranchReferenceFormat()
338
738
            return format.open(self, name=name, _found=True,
339
 
                location=response[1], ignore_fallbacks=ignore_fallbacks)
 
739
                location=response[1], ignore_fallbacks=ignore_fallbacks,
 
740
                possible_transports=possible_transports)
340
741
        branch_format_name = response[1]
341
742
        if not branch_format_name:
342
743
            branch_format_name = None
343
744
        format = RemoteBranchFormat(network_name=branch_format_name)
344
745
        return RemoteBranch(self, self.find_repository(), format=format,
345
 
            setup_stacking=not ignore_fallbacks, name=name)
 
746
            setup_stacking=not ignore_fallbacks, name=name,
 
747
            possible_transports=possible_transports)
346
748
 
347
749
    def _open_repo_v1(self, path):
348
750
        verb = 'BzrDir.find_repository'
411
813
 
412
814
    def has_workingtree(self):
413
815
        if self._has_working_tree is None:
414
 
            self._ensure_real()
415
 
            self._has_working_tree = self._real_bzrdir.has_workingtree()
 
816
            path = self._path_for_remote_call(self._client)
 
817
            try:
 
818
                response = self._call('BzrDir.has_workingtree', path)
 
819
            except errors.UnknownSmartMethod:
 
820
                self._ensure_real()
 
821
                self._has_working_tree = self._real_bzrdir.has_workingtree()
 
822
            else:
 
823
                if response[0] not in ('yes', 'no'):
 
824
                    raise SmartProtocolError('unexpected response code %s' % (response,))
 
825
                self._has_working_tree = (response[0] == 'yes')
416
826
        return self._has_working_tree
417
827
 
418
828
    def open_workingtree(self, recommend_upgrade=True):
423
833
 
424
834
    def _path_for_remote_call(self, client):
425
835
        """Return the path to be used for this bzrdir in a remote call."""
426
 
        return client.remote_path_from_transport(self.root_transport)
 
836
        return urlutils.split_segment_parameters_raw(
 
837
            client.remote_path_from_transport(self.root_transport))[0]
427
838
 
428
839
    def get_branch_transport(self, branch_format, name=None):
429
840
        self._ensure_real()
441
852
        """Upgrading of remote bzrdirs is not supported yet."""
442
853
        return False
443
854
 
444
 
    def needs_format_conversion(self, format=None):
 
855
    def needs_format_conversion(self, format):
445
856
        """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
857
        return False
450
858
 
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
859
    def _get_config(self):
458
860
        return RemoteBzrDirConfig(self)
459
861
 
460
 
 
461
 
class RemoteRepositoryFormat(repository.RepositoryFormat):
 
862
    def _get_config_store(self):
 
863
        return RemoteControlStore(self)
 
864
 
 
865
 
 
866
class RemoteRepositoryFormat(vf_repository.VersionedFileRepositoryFormat):
462
867
    """Format for repositories accessed over a _SmartClient.
463
868
 
464
869
    Instances of this repository are represented by RemoteRepository
479
884
    """
480
885
 
481
886
    _matchingbzrdir = RemoteBzrDirFormat()
 
887
    supports_full_versioned_files = True
 
888
    supports_leaving_lock = True
482
889
 
483
890
    def __init__(self):
484
 
        repository.RepositoryFormat.__init__(self)
 
891
        _mod_repository.RepositoryFormat.__init__(self)
485
892
        self._custom_format = None
486
893
        self._network_name = None
487
894
        self._creating_bzrdir = None
 
895
        self._revision_graph_can_have_wrong_parents = None
488
896
        self._supports_chks = None
489
897
        self._supports_external_lookups = None
490
898
        self._supports_tree_reference = None
 
899
        self._supports_funky_characters = None
 
900
        self._supports_nesting_repositories = None
491
901
        self._rich_root_data = None
492
902
 
493
903
    def __repr__(self):
522
932
        return self._supports_external_lookups
523
933
 
524
934
    @property
 
935
    def supports_funky_characters(self):
 
936
        if self._supports_funky_characters is None:
 
937
            self._ensure_real()
 
938
            self._supports_funky_characters = \
 
939
                self._custom_format.supports_funky_characters
 
940
        return self._supports_funky_characters
 
941
 
 
942
    @property
 
943
    def supports_nesting_repositories(self):
 
944
        if self._supports_nesting_repositories is None:
 
945
            self._ensure_real()
 
946
            self._supports_nesting_repositories = \
 
947
                self._custom_format.supports_nesting_repositories
 
948
        return self._supports_nesting_repositories
 
949
 
 
950
    @property
525
951
    def supports_tree_reference(self):
526
952
        if self._supports_tree_reference is None:
527
953
            self._ensure_real()
529
955
                self._custom_format.supports_tree_reference
530
956
        return self._supports_tree_reference
531
957
 
 
958
    @property
 
959
    def revision_graph_can_have_wrong_parents(self):
 
960
        if self._revision_graph_can_have_wrong_parents is None:
 
961
            self._ensure_real()
 
962
            self._revision_graph_can_have_wrong_parents = \
 
963
                self._custom_format.revision_graph_can_have_wrong_parents
 
964
        return self._revision_graph_can_have_wrong_parents
 
965
 
532
966
    def _vfs_initialize(self, a_bzrdir, shared):
533
967
        """Helper for common code in initialize."""
534
968
        if self._custom_format:
569
1003
            network_name = self._network_name
570
1004
        else:
571
1005
            # Select the current bzrlib default and ask for that.
572
 
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
 
1006
            reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
573
1007
            reference_format = reference_bzrdir_format.repository_format
574
1008
            network_name = reference_format.network_name()
575
1009
        # 2) try direct creation via RPC
601
1035
 
602
1036
    def _ensure_real(self):
603
1037
        if self._custom_format is None:
604
 
            self._custom_format = repository.network_format_registry.get(
605
 
                self._network_name)
 
1038
            try:
 
1039
                self._custom_format = _mod_repository.network_format_registry.get(
 
1040
                    self._network_name)
 
1041
            except KeyError:
 
1042
                raise errors.UnknownFormatError(kind='repository',
 
1043
                    format=self._network_name)
606
1044
 
607
1045
    @property
608
1046
    def _fetch_order(self):
643
1081
        return self._custom_format._serializer
644
1082
 
645
1083
 
646
 
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
647
 
    bzrdir.ControlComponent):
 
1084
class RemoteRepository(_mod_repository.Repository, _RpcHelper,
 
1085
        lock._RelockDebugMixin):
648
1086
    """Repository accessed over rpc.
649
1087
 
650
1088
    For the moment most operations are performed using local transport-backed
674
1112
        self._format = format
675
1113
        self._lock_mode = None
676
1114
        self._lock_token = None
 
1115
        self._write_group_tokens = None
677
1116
        self._lock_count = 0
678
1117
        self._leave_lock = False
679
1118
        # Cache of revision parents; misses are cached during read locks, and
703
1142
        # transport, but I'm not sure it's worth making this method
704
1143
        # optional -- mbp 2010-04-21
705
1144
        return self.bzrdir.get_repository_transport(None)
706
 
        
 
1145
 
707
1146
    def __str__(self):
708
1147
        return "%s(%s)" % (self.__class__.__name__, self.base)
709
1148
 
719
1158
 
720
1159
        :param suppress_errors: see Repository.abort_write_group.
721
1160
        """
722
 
        self._ensure_real()
723
 
        return self._real_repository.abort_write_group(
724
 
            suppress_errors=suppress_errors)
 
1161
        if self._real_repository:
 
1162
            self._ensure_real()
 
1163
            return self._real_repository.abort_write_group(
 
1164
                suppress_errors=suppress_errors)
 
1165
        if not self.is_in_write_group():
 
1166
            if suppress_errors:
 
1167
                mutter('(suppressed) not in write group')
 
1168
                return
 
1169
            raise errors.BzrError("not in write group")
 
1170
        path = self.bzrdir._path_for_remote_call(self._client)
 
1171
        try:
 
1172
            response = self._call('Repository.abort_write_group', path,
 
1173
                self._lock_token, self._write_group_tokens)
 
1174
        except Exception, exc:
 
1175
            self._write_group = None
 
1176
            if not suppress_errors:
 
1177
                raise
 
1178
            mutter('abort_write_group failed')
 
1179
            log_exception_quietly()
 
1180
            note(gettext('bzr: ERROR (ignored): %s'), exc)
 
1181
        else:
 
1182
            if response != ('ok', ):
 
1183
                raise errors.UnexpectedSmartServerResponse(response)
 
1184
            self._write_group_tokens = None
725
1185
 
726
1186
    @property
727
1187
    def chk_bytes(self):
741
1201
        for older plugins that don't use e.g. the CommitBuilder
742
1202
        facility.
743
1203
        """
744
 
        self._ensure_real()
745
 
        return self._real_repository.commit_write_group()
 
1204
        if self._real_repository:
 
1205
            self._ensure_real()
 
1206
            return self._real_repository.commit_write_group()
 
1207
        if not self.is_in_write_group():
 
1208
            raise errors.BzrError("not in write group")
 
1209
        path = self.bzrdir._path_for_remote_call(self._client)
 
1210
        response = self._call('Repository.commit_write_group', path,
 
1211
            self._lock_token, self._write_group_tokens)
 
1212
        if response != ('ok', ):
 
1213
            raise errors.UnexpectedSmartServerResponse(response)
 
1214
        self._write_group_tokens = None
 
1215
        # Refresh data after writing to the repository.
 
1216
        self.refresh_data()
746
1217
 
747
1218
    def resume_write_group(self, tokens):
748
 
        self._ensure_real()
749
 
        return self._real_repository.resume_write_group(tokens)
 
1219
        if self._real_repository:
 
1220
            return self._real_repository.resume_write_group(tokens)
 
1221
        path = self.bzrdir._path_for_remote_call(self._client)
 
1222
        try:
 
1223
            response = self._call('Repository.check_write_group', path,
 
1224
               self._lock_token, tokens)
 
1225
        except errors.UnknownSmartMethod:
 
1226
            self._ensure_real()
 
1227
            return self._real_repository.resume_write_group(tokens)
 
1228
        if response != ('ok', ):
 
1229
            raise errors.UnexpectedSmartServerResponse(response)
 
1230
        self._write_group_tokens = tokens
750
1231
 
751
1232
    def suspend_write_group(self):
752
 
        self._ensure_real()
753
 
        return self._real_repository.suspend_write_group()
 
1233
        if self._real_repository:
 
1234
            return self._real_repository.suspend_write_group()
 
1235
        ret = self._write_group_tokens or []
 
1236
        self._write_group_tokens = None
 
1237
        return ret
754
1238
 
755
1239
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
756
1240
        self._ensure_real()
817
1301
    def find_text_key_references(self):
818
1302
        """Find the text key references within the repository.
819
1303
 
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
1304
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
824
1305
            to whether they were referred to by the inventory of the
825
1306
            revision_id that they contain. The inventory texts from all present
843
1324
        """Private method for using with old (< 1.2) servers to fallback."""
844
1325
        if revision_id is None:
845
1326
            revision_id = ''
846
 
        elif revision.is_null(revision_id):
 
1327
        elif _mod_revision.is_null(revision_id):
847
1328
            return {}
848
1329
 
849
1330
        path = self.bzrdir._path_for_remote_call(self._client)
873
1354
        return RemoteStreamSource(self, to_format)
874
1355
 
875
1356
    @needs_read_lock
 
1357
    def get_file_graph(self):
 
1358
        return graph.Graph(self.texts)
 
1359
 
 
1360
    @needs_read_lock
876
1361
    def has_revision(self, revision_id):
877
1362
        """True if this repository has a copy of the revision."""
878
1363
        # Copy of bzrlib.repository.Repository.has_revision
895
1380
    def _has_same_fallbacks(self, other_repo):
896
1381
        """Returns true if the repositories have the same fallbacks."""
897
1382
        # XXX: copied from Repository; it should be unified into a base class
898
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401622>
 
1383
        # <https://bugs.launchpad.net/bzr/+bug/401622>
899
1384
        my_fb = self._fallback_repositories
900
1385
        other_fb = other_repo._fallback_repositories
901
1386
        if len(my_fb) != len(other_fb):
930
1415
        """See Repository.gather_stats()."""
931
1416
        path = self.bzrdir._path_for_remote_call(self._client)
932
1417
        # revid can be None to indicate no revisions, not just NULL_REVISION
933
 
        if revid is None or revision.is_null(revid):
 
1418
        if revid is None or _mod_revision.is_null(revid):
934
1419
            fmt_revid = ''
935
1420
        else:
936
1421
            fmt_revid = revid
965
1450
 
966
1451
    def get_physical_lock_status(self):
967
1452
        """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()
 
1453
        path = self.bzrdir._path_for_remote_call(self._client)
 
1454
        try:
 
1455
            response = self._call('Repository.get_physical_lock_status', path)
 
1456
        except errors.UnknownSmartMethod:
 
1457
            self._ensure_real()
 
1458
            return self._real_repository.get_physical_lock_status()
 
1459
        if response[0] not in ('yes', 'no'):
 
1460
            raise errors.UnexpectedSmartServerResponse(response)
 
1461
        return (response[0] == 'yes')
971
1462
 
972
1463
    def is_in_write_group(self):
973
1464
        """Return True if there is an open write group.
974
1465
 
975
1466
        write groups are only applicable locally for the smart server..
976
1467
        """
 
1468
        if self._write_group_tokens is not None:
 
1469
            return True
977
1470
        if self._real_repository:
978
1471
            return self._real_repository.is_in_write_group()
979
1472
 
997
1490
        pass
998
1491
 
999
1492
    def lock_read(self):
 
1493
        """Lock the repository for read operations.
 
1494
 
 
1495
        :return: A bzrlib.lock.LogicalLockResult.
 
1496
        """
1000
1497
        # wrong eventually - want a local lock cache context
1001
1498
        if not self._lock_mode:
1002
1499
            self._note_lock('r')
1009
1506
                repo.lock_read()
1010
1507
        else:
1011
1508
            self._lock_count += 1
 
1509
        return lock.LogicalLockResult(self.unlock)
1012
1510
 
1013
1511
    def _remote_lock_write(self, token):
1014
1512
        path = self.bzrdir._path_for_remote_call(self._client)
1054
1552
            raise errors.ReadOnlyError(self)
1055
1553
        else:
1056
1554
            self._lock_count += 1
1057
 
        return self._lock_token or None
 
1555
        return RepositoryWriteLockResult(self.unlock, self._lock_token or None)
1058
1556
 
1059
1557
    def leave_lock_in_place(self):
1060
1558
        if not self._lock_token:
1109
1607
            self._real_repository.lock_write(self._lock_token)
1110
1608
        elif self._lock_mode == 'r':
1111
1609
            self._real_repository.lock_read()
 
1610
        if self._write_group_tokens is not None:
 
1611
            # if we are already in a write group, resume it
 
1612
            self._real_repository.resume_write_group(self._write_group_tokens)
 
1613
            self._write_group_tokens = None
1112
1614
 
1113
1615
    def start_write_group(self):
1114
1616
        """Start a write group on the decorated repository.
1118
1620
        for older plugins that don't use e.g. the CommitBuilder
1119
1621
        facility.
1120
1622
        """
1121
 
        self._ensure_real()
1122
 
        return self._real_repository.start_write_group()
 
1623
        if self._real_repository:
 
1624
            self._ensure_real()
 
1625
            return self._real_repository.start_write_group()
 
1626
        if not self.is_write_locked():
 
1627
            raise errors.NotWriteLocked(self)
 
1628
        if self._write_group_tokens is not None:
 
1629
            raise errors.BzrError('already in a write group')
 
1630
        path = self.bzrdir._path_for_remote_call(self._client)
 
1631
        try:
 
1632
            response = self._call('Repository.start_write_group', path,
 
1633
                self._lock_token)
 
1634
        except (errors.UnknownSmartMethod, errors.UnsuspendableWriteGroup):
 
1635
            self._ensure_real()
 
1636
            return self._real_repository.start_write_group()
 
1637
        if response[0] != 'ok':
 
1638
            raise errors.UnexpectedSmartServerResponse(response)
 
1639
        self._write_group_tokens = response[1]
1123
1640
 
1124
1641
    def _unlock(self, token):
1125
1642
        path = self.bzrdir._path_for_remote_call(self._client)
1152
1669
            # This is just to let the _real_repository stay up to date.
1153
1670
            if self._real_repository is not None:
1154
1671
                self._real_repository.unlock()
 
1672
            elif self._write_group_tokens is not None:
 
1673
                self.abort_write_group()
1155
1674
        finally:
1156
1675
            # The rpc-level lock should be released even if there was a
1157
1676
            # problem releasing the vfs-based lock.
1169
1688
 
1170
1689
    def break_lock(self):
1171
1690
        # should hand off to the network
1172
 
        self._ensure_real()
1173
 
        return self._real_repository.break_lock()
 
1691
        path = self.bzrdir._path_for_remote_call(self._client)
 
1692
        try:
 
1693
            response = self._call("Repository.break_lock", path)
 
1694
        except errors.UnknownSmartMethod:
 
1695
            self._ensure_real()
 
1696
            return self._real_repository.break_lock()
 
1697
        if response != ('ok',):
 
1698
            raise errors.UnexpectedSmartServerResponse(response)
1174
1699
 
1175
1700
    def _get_tarball(self, compression):
1176
1701
        """Return a TemporaryFile containing a repository tarball.
1194
1719
            return t
1195
1720
        raise errors.UnexpectedSmartServerResponse(response)
1196
1721
 
 
1722
    @needs_read_lock
1197
1723
    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)
 
1724
        """Create a descendent repository for new development.
 
1725
 
 
1726
        Unlike clone, this does not copy the settings of the repository.
 
1727
        """
 
1728
        dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
1202
1729
        dest_repo.fetch(self, revision_id=revision_id)
1203
1730
        return dest_repo
1204
1731
 
 
1732
    def _create_sprouting_repo(self, a_bzrdir, shared):
 
1733
        if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
 
1734
            # use target default format.
 
1735
            dest_repo = a_bzrdir.create_repository()
 
1736
        else:
 
1737
            # Most control formats need the repository to be specifically
 
1738
            # created, but on some old all-in-one formats it's not needed
 
1739
            try:
 
1740
                dest_repo = self._format.initialize(a_bzrdir, shared=shared)
 
1741
            except errors.UninitializableFormat:
 
1742
                dest_repo = a_bzrdir.open_repository()
 
1743
        return dest_repo
 
1744
 
1205
1745
    ### These methods are just thin shims to the VFS object for now.
1206
1746
 
 
1747
    @needs_read_lock
1207
1748
    def revision_tree(self, revision_id):
1208
 
        self._ensure_real()
1209
 
        return self._real_repository.revision_tree(revision_id)
 
1749
        revision_id = _mod_revision.ensure_null(revision_id)
 
1750
        if revision_id == _mod_revision.NULL_REVISION:
 
1751
            return InventoryRevisionTree(self,
 
1752
                Inventory(root_id=None), _mod_revision.NULL_REVISION)
 
1753
        else:
 
1754
            return list(self.revision_trees([revision_id]))[0]
1210
1755
 
1211
1756
    def get_serializer_format(self):
1212
 
        self._ensure_real()
1213
 
        return self._real_repository.get_serializer_format()
 
1757
        path = self.bzrdir._path_for_remote_call(self._client)
 
1758
        try:
 
1759
            response = self._call('VersionedFileRepository.get_serializer_format',
 
1760
                path)
 
1761
        except errors.UnknownSmartMethod:
 
1762
            self._ensure_real()
 
1763
            return self._real_repository.get_serializer_format()
 
1764
        if response[0] != 'ok':
 
1765
            raise errors.UnexpectedSmartServerResponse(response)
 
1766
        return response[1]
1214
1767
 
1215
1768
    def get_commit_builder(self, branch, parents, config, timestamp=None,
1216
1769
                           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
 
1770
                           revision_id=None, lossy=False):
 
1771
        """Obtain a CommitBuilder for this repository.
 
1772
 
 
1773
        :param branch: Branch to commit to.
 
1774
        :param parents: Revision ids of the parents of the new revision.
 
1775
        :param config: Configuration to use.
 
1776
        :param timestamp: Optional timestamp recorded for commit.
 
1777
        :param timezone: Optional timezone for timestamp.
 
1778
        :param committer: Optional committer to set for commit.
 
1779
        :param revprops: Optional dictionary of revision properties.
 
1780
        :param revision_id: Optional revision id.
 
1781
        :param lossy: Whether to discard data that can not be natively
 
1782
            represented, when pushing to a foreign VCS
 
1783
        """
 
1784
        if self._fallback_repositories and not self._format.supports_chks:
 
1785
            raise errors.BzrError("Cannot commit directly to a stacked branch"
 
1786
                " in pre-2a formats. See "
 
1787
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
 
1788
        if self._format.rich_root_data:
 
1789
            commit_builder_kls = vf_repository.VersionedFileRootCommitBuilder
 
1790
        else:
 
1791
            commit_builder_kls = vf_repository.VersionedFileCommitBuilder
 
1792
        result = commit_builder_kls(self, parents, config,
 
1793
            timestamp, timezone, committer, revprops, revision_id,
 
1794
            lossy)
 
1795
        self.start_write_group()
 
1796
        return result
1226
1797
 
1227
1798
    def add_fallback_repository(self, repository):
1228
1799
        """Add a repository to use for looking up data not held locally.
1235
1806
        # We need to accumulate additional repositories here, to pass them in
1236
1807
        # on various RPC's.
1237
1808
        #
 
1809
        # Make the check before we lock: this raises an exception.
 
1810
        self._check_fallback_repository(repository)
1238
1811
        if self.is_locked():
1239
1812
            # We will call fallback.unlock() when we transition to the unlocked
1240
1813
            # state, so always add a lock here. If a caller passes us a locked
1241
1814
            # repository, they are responsible for unlocking it later.
1242
1815
            repository.lock_read()
1243
 
        self._check_fallback_repository(repository)
1244
1816
        self._fallback_repositories.append(repository)
1245
1817
        # If self._real_repository was parameterised already (e.g. because a
1246
1818
        # _real_branch had its get_stacked_on_url method called), then the
1272
1844
            delta, new_revision_id, parents, basis_inv=basis_inv,
1273
1845
            propagate_caches=propagate_caches)
1274
1846
 
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)
 
1847
    def add_revision(self, revision_id, rev, inv=None):
 
1848
        _mod_revision.check_not_reserved_id(revision_id)
 
1849
        key = (revision_id,)
 
1850
        # check inventory present
 
1851
        if not self.inventories.get_parent_map([key]):
 
1852
            if inv is None:
 
1853
                raise errors.WeaveRevisionNotPresent(revision_id,
 
1854
                                                     self.inventories)
 
1855
            else:
 
1856
                # yes, this is not suitable for adding with ghosts.
 
1857
                rev.inventory_sha1 = self.add_inventory(revision_id, inv,
 
1858
                                                        rev.parent_ids)
 
1859
        else:
 
1860
            rev.inventory_sha1 = self.inventories.get_sha1s([key])[key]
 
1861
        self._add_revision(rev)
 
1862
 
 
1863
    def _add_revision(self, rev):
 
1864
        if self._real_repository is not None:
 
1865
            return self._real_repository._add_revision(rev)
 
1866
        text = self._serializer.write_revision_to_string(rev)
 
1867
        key = (rev.revision_id,)
 
1868
        parents = tuple((parent,) for parent in rev.parent_ids)
 
1869
        self._write_group_tokens, missing_keys = self._get_sink().insert_stream(
 
1870
            [('revisions', [FulltextContentFactory(key, parents, None, text)])],
 
1871
            self._format, self._write_group_tokens)
1279
1872
 
1280
1873
    @needs_read_lock
1281
1874
    def get_inventory(self, revision_id):
 
1875
        return list(self.iter_inventories([revision_id]))[0]
 
1876
 
 
1877
    def _iter_inventories_rpc(self, revision_ids, ordering):
 
1878
        if ordering is None:
 
1879
            ordering = 'unordered'
 
1880
        path = self.bzrdir._path_for_remote_call(self._client)
 
1881
        body = "\n".join(revision_ids)
 
1882
        response_tuple, response_handler = (
 
1883
            self._call_with_body_bytes_expecting_body(
 
1884
                "VersionedFileRepository.get_inventories",
 
1885
                (path, ordering), body))
 
1886
        if response_tuple[0] != "ok":
 
1887
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
1888
        deserializer = inventory_delta.InventoryDeltaDeserializer()
 
1889
        byte_stream = response_handler.read_streamed_body()
 
1890
        decoded = smart_repo._byte_stream_to_stream(byte_stream)
 
1891
        if decoded is None:
 
1892
            # no results whatsoever
 
1893
            return
 
1894
        src_format, stream = decoded
 
1895
        if src_format.network_name() != self._format.network_name():
 
1896
            raise AssertionError(
 
1897
                "Mismatched RemoteRepository and stream src %r, %r" % (
 
1898
                src_format.network_name(), self._format.network_name()))
 
1899
        # ignore the src format, it's not really relevant
 
1900
        prev_inv = Inventory(root_id=None,
 
1901
            revision_id=_mod_revision.NULL_REVISION)
 
1902
        # there should be just one substream, with inventory deltas
 
1903
        substream_kind, substream = stream.next()
 
1904
        if substream_kind != "inventory-deltas":
 
1905
            raise AssertionError(
 
1906
                 "Unexpected stream %r received" % substream_kind)
 
1907
        for record in substream:
 
1908
            (parent_id, new_id, versioned_root, tree_references, invdelta) = (
 
1909
                deserializer.parse_text_bytes(record.get_bytes_as("fulltext")))
 
1910
            if parent_id != prev_inv.revision_id:
 
1911
                raise AssertionError("invalid base %r != %r" % (parent_id,
 
1912
                    prev_inv.revision_id))
 
1913
            inv = prev_inv.create_by_apply_delta(invdelta, new_id)
 
1914
            yield inv, inv.revision_id
 
1915
            prev_inv = inv
 
1916
 
 
1917
    def _iter_inventories_vfs(self, revision_ids, ordering=None):
1282
1918
        self._ensure_real()
1283
 
        return self._real_repository.get_inventory(revision_id)
 
1919
        return self._real_repository._iter_inventories(revision_ids, ordering)
1284
1920
 
1285
1921
    def iter_inventories(self, revision_ids, ordering=None):
1286
 
        self._ensure_real()
1287
 
        return self._real_repository.iter_inventories(revision_ids, ordering)
 
1922
        """Get many inventories by revision_ids.
 
1923
 
 
1924
        This will buffer some or all of the texts used in constructing the
 
1925
        inventories in memory, but will only parse a single inventory at a
 
1926
        time.
 
1927
 
 
1928
        :param revision_ids: The expected revision ids of the inventories.
 
1929
        :param ordering: optional ordering, e.g. 'topological'.  If not
 
1930
            specified, the order of revision_ids will be preserved (by
 
1931
            buffering if necessary).
 
1932
        :return: An iterator of inventories.
 
1933
        """
 
1934
        if ((None in revision_ids)
 
1935
            or (_mod_revision.NULL_REVISION in revision_ids)):
 
1936
            raise ValueError('cannot get null revision inventory')
 
1937
        for inv, revid in self._iter_inventories(revision_ids, ordering):
 
1938
            if inv is None:
 
1939
                raise errors.NoSuchRevision(self, revid)
 
1940
            yield inv
 
1941
 
 
1942
    def _iter_inventories(self, revision_ids, ordering=None):
 
1943
        if len(revision_ids) == 0:
 
1944
            return
 
1945
        missing = set(revision_ids)
 
1946
        if ordering is None:
 
1947
            order_as_requested = True
 
1948
            invs = {}
 
1949
            order = list(revision_ids)
 
1950
            order.reverse()
 
1951
            next_revid = order.pop()
 
1952
        else:
 
1953
            order_as_requested = False
 
1954
            if ordering != 'unordered' and self._fallback_repositories:
 
1955
                raise ValueError('unsupported ordering %r' % ordering)
 
1956
        iter_inv_fns = [self._iter_inventories_rpc] + [
 
1957
            fallback._iter_inventories for fallback in
 
1958
            self._fallback_repositories]
 
1959
        try:
 
1960
            for iter_inv in iter_inv_fns:
 
1961
                request = [revid for revid in revision_ids if revid in missing]
 
1962
                for inv, revid in iter_inv(request, ordering):
 
1963
                    if inv is None:
 
1964
                        continue
 
1965
                    missing.remove(inv.revision_id)
 
1966
                    if ordering != 'unordered':
 
1967
                        invs[revid] = inv
 
1968
                    else:
 
1969
                        yield inv, revid
 
1970
                if order_as_requested:
 
1971
                    # Yield as many results as we can while preserving order.
 
1972
                    while next_revid in invs:
 
1973
                        inv = invs.pop(next_revid)
 
1974
                        yield inv, inv.revision_id
 
1975
                        try:
 
1976
                            next_revid = order.pop()
 
1977
                        except IndexError:
 
1978
                            # We still want to fully consume the stream, just
 
1979
                            # in case it is not actually finished at this point
 
1980
                            next_revid = None
 
1981
                            break
 
1982
        except errors.UnknownSmartMethod:
 
1983
            for inv, revid in self._iter_inventories_vfs(revision_ids, ordering):
 
1984
                yield inv, revid
 
1985
            return
 
1986
        # Report missing
 
1987
        if order_as_requested:
 
1988
            if next_revid is not None:
 
1989
                yield None, next_revid
 
1990
            while order:
 
1991
                revid = order.pop()
 
1992
                yield invs.get(revid), revid
 
1993
        else:
 
1994
            while missing:
 
1995
                yield None, missing.pop()
1288
1996
 
1289
1997
    @needs_read_lock
1290
1998
    def get_revision(self, revision_id):
1291
 
        self._ensure_real()
1292
 
        return self._real_repository.get_revision(revision_id)
 
1999
        return self.get_revisions([revision_id])[0]
1293
2000
 
1294
2001
    def get_transaction(self):
1295
2002
        self._ensure_real()
1297
2004
 
1298
2005
    @needs_read_lock
1299
2006
    def clone(self, a_bzrdir, revision_id=None):
1300
 
        self._ensure_real()
1301
 
        return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
 
2007
        dest_repo = self._create_sprouting_repo(
 
2008
            a_bzrdir, shared=self.is_shared())
 
2009
        self.copy_content_into(dest_repo, revision_id)
 
2010
        return dest_repo
1302
2011
 
1303
2012
    def make_working_trees(self):
1304
2013
        """See Repository.make_working_trees"""
1305
 
        self._ensure_real()
1306
 
        return self._real_repository.make_working_trees()
 
2014
        path = self.bzrdir._path_for_remote_call(self._client)
 
2015
        try:
 
2016
            response = self._call('Repository.make_working_trees', path)
 
2017
        except errors.UnknownSmartMethod:
 
2018
            self._ensure_real()
 
2019
            return self._real_repository.make_working_trees()
 
2020
        if response[0] not in ('yes', 'no'):
 
2021
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
2022
        return response[0] == 'yes'
1307
2023
 
1308
2024
    def refresh_data(self):
1309
 
        """Re-read any data needed to to synchronise with disk.
 
2025
        """Re-read any data needed to synchronise with disk.
1310
2026
 
1311
2027
        This method is intended to be called after another repository instance
1312
2028
        (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.
 
2029
        repository. On all repositories this will work outside of write groups.
 
2030
        Some repository formats (pack and newer for bzrlib native formats)
 
2031
        support refresh_data inside write groups. If called inside a write
 
2032
        group on a repository that does not support refreshing in a write group
 
2033
        IsInWriteGroupError will be raised.
1315
2034
        """
1316
 
        if self.is_in_write_group():
1317
 
            raise errors.InternalBzrError(
1318
 
                "May not refresh_data while in a write group.")
1319
2035
        if self._real_repository is not None:
1320
2036
            self._real_repository.refresh_data()
 
2037
        # Refresh the parents cache for this object
 
2038
        self._unstacked_provider.disable_cache()
 
2039
        self._unstacked_provider.enable_cache()
1321
2040
 
1322
2041
    def revision_ids_to_search_result(self, result_set):
1323
2042
        """Convert a set of revision ids to a graph SearchResult."""
1328
2047
        included_keys = result_set.intersection(result_parents)
1329
2048
        start_keys = result_set.difference(included_keys)
1330
2049
        exclude_keys = result_parents.difference(result_set)
1331
 
        result = graph.SearchResult(start_keys, exclude_keys,
 
2050
        result = vf_search.SearchResult(start_keys, exclude_keys,
1332
2051
            len(result_set), result_set)
1333
2052
        return result
1334
2053
 
1335
2054
    @needs_read_lock
1336
 
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
2055
    def search_missing_revision_ids(self, other,
 
2056
            revision_id=symbol_versioning.DEPRECATED_PARAMETER,
 
2057
            find_ghosts=True, revision_ids=None, if_present_ids=None,
 
2058
            limit=None):
1337
2059
        """Return the revision ids that other has that this does not.
1338
2060
 
1339
2061
        These are returned in topological order.
1340
2062
 
1341
2063
        revision_id: only return revision ids included by revision_id.
1342
2064
        """
1343
 
        return repository.InterRepository.get(
1344
 
            other, self).search_missing_revision_ids(revision_id, find_ghosts)
 
2065
        if symbol_versioning.deprecated_passed(revision_id):
 
2066
            symbol_versioning.warn(
 
2067
                'search_missing_revision_ids(revision_id=...) was '
 
2068
                'deprecated in 2.4.  Use revision_ids=[...] instead.',
 
2069
                DeprecationWarning, stacklevel=2)
 
2070
            if revision_ids is not None:
 
2071
                raise AssertionError(
 
2072
                    'revision_ids is mutually exclusive with revision_id')
 
2073
            if revision_id is not None:
 
2074
                revision_ids = [revision_id]
 
2075
        inter_repo = _mod_repository.InterRepository.get(other, self)
 
2076
        return inter_repo.search_missing_revision_ids(
 
2077
            find_ghosts=find_ghosts, revision_ids=revision_ids,
 
2078
            if_present_ids=if_present_ids, limit=limit)
1345
2079
 
1346
 
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
 
2080
    def fetch(self, source, revision_id=None, find_ghosts=False,
1347
2081
            fetch_spec=None):
1348
2082
        # No base implementation to use as RemoteRepository is not a subclass
1349
2083
        # of Repository; so this is a copy of Repository.fetch().
1360
2094
            # check that last_revision is in 'from' and then return a
1361
2095
            # no-operation.
1362
2096
            if (revision_id is not None and
1363
 
                not revision.is_null(revision_id)):
 
2097
                not _mod_revision.is_null(revision_id)):
1364
2098
                self.get_revision(revision_id)
1365
2099
            return 0, []
1366
2100
        # if there is no specific appropriate InterRepository, this will get
1367
2101
        # the InterRepository base class, which raises an
1368
2102
        # IncompatibleRepositories when asked to fetch.
1369
 
        inter = repository.InterRepository.get(source, self)
1370
 
        return inter.fetch(revision_id=revision_id, pb=pb,
 
2103
        inter = _mod_repository.InterRepository.get(source, self)
 
2104
        if (fetch_spec is not None and
 
2105
            not getattr(inter, "supports_fetch_spec", False)):
 
2106
            raise errors.UnsupportedOperation(
 
2107
                "fetch_spec not supported for %r" % inter)
 
2108
        return inter.fetch(revision_id=revision_id,
1371
2109
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1372
2110
 
1373
2111
    def create_bundle(self, target, base, fileobj, format=None):
1375
2113
        self._real_repository.create_bundle(target, base, fileobj, format)
1376
2114
 
1377
2115
    @needs_read_lock
 
2116
    @symbol_versioning.deprecated_method(
 
2117
        symbol_versioning.deprecated_in((2, 4, 0)))
1378
2118
    def get_ancestry(self, revision_id, topo_sorted=True):
1379
2119
        self._ensure_real()
1380
2120
        return self._real_repository.get_ancestry(revision_id, topo_sorted)
1388
2128
        return self._real_repository._get_versioned_file_checker(
1389
2129
            revisions, revision_versions_cache)
1390
2130
 
 
2131
    def _iter_files_bytes_rpc(self, desired_files, absent):
 
2132
        path = self.bzrdir._path_for_remote_call(self._client)
 
2133
        lines = []
 
2134
        identifiers = []
 
2135
        for (file_id, revid, identifier) in desired_files:
 
2136
            lines.append("%s\0%s" % (
 
2137
                osutils.safe_file_id(file_id),
 
2138
                osutils.safe_revision_id(revid)))
 
2139
            identifiers.append(identifier)
 
2140
        (response_tuple, response_handler) = (
 
2141
            self._call_with_body_bytes_expecting_body(
 
2142
            "Repository.iter_files_bytes", (path, ), "\n".join(lines)))
 
2143
        if response_tuple != ('ok', ):
 
2144
            response_handler.cancel_read_body()
 
2145
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2146
        byte_stream = response_handler.read_streamed_body()
 
2147
        def decompress_stream(start, byte_stream, unused):
 
2148
            decompressor = zlib.decompressobj()
 
2149
            yield decompressor.decompress(start)
 
2150
            while decompressor.unused_data == "":
 
2151
                try:
 
2152
                    data = byte_stream.next()
 
2153
                except StopIteration:
 
2154
                    break
 
2155
                yield decompressor.decompress(data)
 
2156
            yield decompressor.flush()
 
2157
            unused.append(decompressor.unused_data)
 
2158
        unused = ""
 
2159
        while True:
 
2160
            while not "\n" in unused:
 
2161
                unused += byte_stream.next()
 
2162
            header, rest = unused.split("\n", 1)
 
2163
            args = header.split("\0")
 
2164
            if args[0] == "absent":
 
2165
                absent[identifiers[int(args[3])]] = (args[1], args[2])
 
2166
                unused = rest
 
2167
                continue
 
2168
            elif args[0] == "ok":
 
2169
                idx = int(args[1])
 
2170
            else:
 
2171
                raise errors.UnexpectedSmartServerResponse(args)
 
2172
            unused_chunks = []
 
2173
            yield (identifiers[idx],
 
2174
                decompress_stream(rest, byte_stream, unused_chunks))
 
2175
            unused = "".join(unused_chunks)
 
2176
 
1391
2177
    def iter_files_bytes(self, desired_files):
1392
2178
        """See Repository.iter_file_bytes.
1393
2179
        """
1394
 
        self._ensure_real()
1395
 
        return self._real_repository.iter_files_bytes(desired_files)
 
2180
        try:
 
2181
            absent = {}
 
2182
            for (identifier, bytes_iterator) in self._iter_files_bytes_rpc(
 
2183
                    desired_files, absent):
 
2184
                yield identifier, bytes_iterator
 
2185
            for fallback in self._fallback_repositories:
 
2186
                if not absent:
 
2187
                    break
 
2188
                desired_files = [(key[0], key[1], identifier) for
 
2189
                    (identifier, key) in absent.iteritems()]
 
2190
                for (identifier, bytes_iterator) in fallback.iter_files_bytes(desired_files):
 
2191
                    del absent[identifier]
 
2192
                    yield identifier, bytes_iterator
 
2193
            if absent:
 
2194
                # There may be more missing items, but raise an exception
 
2195
                # for just one.
 
2196
                missing_identifier = absent.keys()[0]
 
2197
                missing_key = absent[missing_identifier]
 
2198
                raise errors.RevisionNotPresent(revision_id=missing_key[1],
 
2199
                    file_id=missing_key[0])
 
2200
        except errors.UnknownSmartMethod:
 
2201
            self._ensure_real()
 
2202
            for (identifier, bytes_iterator) in (
 
2203
                self._real_repository.iter_files_bytes(desired_files)):
 
2204
                yield identifier, bytes_iterator
 
2205
 
 
2206
    def get_cached_parent_map(self, revision_ids):
 
2207
        """See bzrlib.CachingParentsProvider.get_cached_parent_map"""
 
2208
        return self._unstacked_provider.get_cached_parent_map(revision_ids)
1396
2209
 
1397
2210
    def get_parent_map(self, revision_ids):
1398
2211
        """See bzrlib.Graph.get_parent_map()."""
1457
2270
        if parents_map is None:
1458
2271
            # Repository is not locked, so there's no cache.
1459
2272
            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)
 
2273
        if _DEFAULT_SEARCH_DEPTH <= 0:
 
2274
            (start_set, stop_keys,
 
2275
             key_count) = vf_search.search_result_from_parent_map(
 
2276
                parents_map, self._unstacked_provider.missing_keys)
 
2277
        else:
 
2278
            (start_set, stop_keys,
 
2279
             key_count) = vf_search.limited_search_result_from_parent_map(
 
2280
                parents_map, self._unstacked_provider.missing_keys,
 
2281
                keys, depth=_DEFAULT_SEARCH_DEPTH)
1480
2282
        recipe = ('manual', start_set, stop_keys, key_count)
1481
2283
        body = self._serialise_search_recipe(recipe)
1482
2284
        path = self.bzrdir._path_for_remote_call(self._client)
1531
2333
 
1532
2334
    @needs_read_lock
1533
2335
    def get_signature_text(self, revision_id):
1534
 
        self._ensure_real()
1535
 
        return self._real_repository.get_signature_text(revision_id)
 
2336
        path = self.bzrdir._path_for_remote_call(self._client)
 
2337
        try:
 
2338
            response_tuple, response_handler = self._call_expecting_body(
 
2339
                'Repository.get_revision_signature_text', path, revision_id)
 
2340
        except errors.UnknownSmartMethod:
 
2341
            self._ensure_real()
 
2342
            return self._real_repository.get_signature_text(revision_id)
 
2343
        except errors.NoSuchRevision, err:
 
2344
            for fallback in self._fallback_repositories:
 
2345
                try:
 
2346
                    return fallback.get_signature_text(revision_id)
 
2347
                except errors.NoSuchRevision:
 
2348
                    pass
 
2349
            raise err
 
2350
        else:
 
2351
            if response_tuple[0] != 'ok':
 
2352
                raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2353
            return response_handler.read_body_bytes()
1536
2354
 
1537
2355
    @needs_read_lock
1538
2356
    def _get_inventory_xml(self, revision_id):
 
2357
        # This call is used by older working tree formats,
 
2358
        # which stored a serialized basis inventory.
1539
2359
        self._ensure_real()
1540
2360
        return self._real_repository._get_inventory_xml(revision_id)
1541
2361
 
 
2362
    @needs_write_lock
1542
2363
    def reconcile(self, other=None, thorough=False):
1543
 
        self._ensure_real()
1544
 
        return self._real_repository.reconcile(other=other, thorough=thorough)
 
2364
        from bzrlib.reconcile import RepoReconciler
 
2365
        path = self.bzrdir._path_for_remote_call(self._client)
 
2366
        try:
 
2367
            response, handler = self._call_expecting_body(
 
2368
                'Repository.reconcile', path, self._lock_token)
 
2369
        except (errors.UnknownSmartMethod, errors.TokenLockingNotSupported):
 
2370
            self._ensure_real()
 
2371
            return self._real_repository.reconcile(other=other, thorough=thorough)
 
2372
        if response != ('ok', ):
 
2373
            raise errors.UnexpectedSmartServerResponse(response)
 
2374
        body = handler.read_body_bytes()
 
2375
        result = RepoReconciler(self)
 
2376
        for line in body.split('\n'):
 
2377
            if not line:
 
2378
                continue
 
2379
            key, val_text = line.split(':')
 
2380
            if key == "garbage_inventories":
 
2381
                result.garbage_inventories = int(val_text)
 
2382
            elif key == "inconsistent_parents":
 
2383
                result.inconsistent_parents = int(val_text)
 
2384
            else:
 
2385
                mutter("unknown reconcile key %r" % key)
 
2386
        return result
1545
2387
 
1546
2388
    def all_revision_ids(self):
1547
 
        self._ensure_real()
1548
 
        return self._real_repository.all_revision_ids()
 
2389
        path = self.bzrdir._path_for_remote_call(self._client)
 
2390
        try:
 
2391
            response_tuple, response_handler = self._call_expecting_body(
 
2392
                "Repository.all_revision_ids", path)
 
2393
        except errors.UnknownSmartMethod:
 
2394
            self._ensure_real()
 
2395
            return self._real_repository.all_revision_ids()
 
2396
        if response_tuple != ("ok", ):
 
2397
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2398
        revids = set(response_handler.read_body_bytes().splitlines())
 
2399
        for fallback in self._fallback_repositories:
 
2400
            revids.update(set(fallback.all_revision_ids()))
 
2401
        return list(revids)
 
2402
 
 
2403
    def _filtered_revision_trees(self, revision_ids, file_ids):
 
2404
        """Return Tree for a revision on this branch with only some files.
 
2405
 
 
2406
        :param revision_ids: a sequence of revision-ids;
 
2407
          a revision-id may not be None or 'null:'
 
2408
        :param file_ids: if not None, the result is filtered
 
2409
          so that only those file-ids, their parents and their
 
2410
          children are included.
 
2411
        """
 
2412
        inventories = self.iter_inventories(revision_ids)
 
2413
        for inv in inventories:
 
2414
            # Should we introduce a FilteredRevisionTree class rather
 
2415
            # than pre-filter the inventory here?
 
2416
            filtered_inv = inv.filter(file_ids)
 
2417
            yield InventoryRevisionTree(self, filtered_inv, filtered_inv.revision_id)
1549
2418
 
1550
2419
    @needs_read_lock
1551
2420
    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)
 
2421
        medium = self._client._medium
 
2422
        if medium._is_remote_before((1, 2)):
 
2423
            self._ensure_real()
 
2424
            for delta in self._real_repository.get_deltas_for_revisions(
 
2425
                    revisions, specific_fileids):
 
2426
                yield delta
 
2427
            return
 
2428
        # Get the revision-ids of interest
 
2429
        required_trees = set()
 
2430
        for revision in revisions:
 
2431
            required_trees.add(revision.revision_id)
 
2432
            required_trees.update(revision.parent_ids[:1])
 
2433
 
 
2434
        # Get the matching filtered trees. Note that it's more
 
2435
        # efficient to pass filtered trees to changes_from() rather
 
2436
        # than doing the filtering afterwards. changes_from() could
 
2437
        # arguably do the filtering itself but it's path-based, not
 
2438
        # file-id based, so filtering before or afterwards is
 
2439
        # currently easier.
 
2440
        if specific_fileids is None:
 
2441
            trees = dict((t.get_revision_id(), t) for
 
2442
                t in self.revision_trees(required_trees))
 
2443
        else:
 
2444
            trees = dict((t.get_revision_id(), t) for
 
2445
                t in self._filtered_revision_trees(required_trees,
 
2446
                specific_fileids))
 
2447
 
 
2448
        # Calculate the deltas
 
2449
        for revision in revisions:
 
2450
            if not revision.parent_ids:
 
2451
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
 
2452
            else:
 
2453
                old_tree = trees[revision.parent_ids[0]]
 
2454
            yield trees[revision.revision_id].changes_from(old_tree)
1555
2455
 
1556
2456
    @needs_read_lock
1557
2457
    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)
 
2458
        r = self.get_revision(revision_id)
 
2459
        return list(self.get_deltas_for_revisions([r],
 
2460
            specific_fileids=specific_fileids))[0]
1561
2461
 
1562
2462
    @needs_read_lock
1563
2463
    def revision_trees(self, revision_ids):
1564
 
        self._ensure_real()
1565
 
        return self._real_repository.revision_trees(revision_ids)
 
2464
        inventories = self.iter_inventories(revision_ids)
 
2465
        for inv in inventories:
 
2466
            yield InventoryRevisionTree(self, inv, inv.revision_id)
1566
2467
 
1567
2468
    @needs_read_lock
1568
2469
    def get_revision_reconcile(self, revision_id):
1576
2477
            callback_refs=callback_refs, check_repo=check_repo)
1577
2478
 
1578
2479
    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)
 
2480
        """Make a complete copy of the content in self into destination.
 
2481
 
 
2482
        This is a destructive operation! Do not use it on existing
 
2483
        repositories.
 
2484
        """
 
2485
        interrepo = _mod_repository.InterRepository.get(self, destination)
 
2486
        return interrepo.copy_content(revision_id)
1582
2487
 
1583
2488
    def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
1584
2489
        # get a tarball of the remote repository, and copy from that into the
1585
2490
        # destination
1586
 
        from bzrlib import osutils
1587
2491
        import tarfile
1588
2492
        # TODO: Maybe a progress bar while streaming the tarball?
1589
 
        note("Copying repository content as tarball...")
 
2493
        note(gettext("Copying repository content as tarball..."))
1590
2494
        tar_file = self._get_tarball('bz2')
1591
2495
        if tar_file is None:
1592
2496
            return None
1597
2501
            tmpdir = osutils.mkdtemp()
1598
2502
            try:
1599
2503
                _extract_tar(tar, tmpdir)
1600
 
                tmp_bzrdir = BzrDir.open(tmpdir)
 
2504
                tmp_bzrdir = _mod_bzrdir.BzrDir.open(tmpdir)
1601
2505
                tmp_repo = tmp_bzrdir.open_repository()
1602
2506
                tmp_repo.copy_content_into(destination, revision_id)
1603
2507
            finally:
1621
2525
    @needs_write_lock
1622
2526
    def pack(self, hint=None, clean_obsolete_packs=False):
1623
2527
        """Compress the data within the repository.
1624
 
 
1625
 
        This is not currently implemented within the smart server.
1626
2528
        """
1627
 
        self._ensure_real()
1628
 
        return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
 
2529
        if hint is None:
 
2530
            body = ""
 
2531
        else:
 
2532
            body = "".join([l+"\n" for l in hint])
 
2533
        path = self.bzrdir._path_for_remote_call(self._client)
 
2534
        try:
 
2535
            response, handler = self._call_with_body_bytes_expecting_body(
 
2536
                'Repository.pack', (path, self._lock_token,
 
2537
                    str(clean_obsolete_packs)), body)
 
2538
        except errors.UnknownSmartMethod:
 
2539
            self._ensure_real()
 
2540
            return self._real_repository.pack(hint=hint,
 
2541
                clean_obsolete_packs=clean_obsolete_packs)
 
2542
        handler.cancel_read_body()
 
2543
        if response != ('ok', ):
 
2544
            raise errors.UnexpectedSmartServerResponse(response)
1629
2545
 
1630
2546
    @property
1631
2547
    def revisions(self):
1632
2548
        """Decorate the real repository for now.
1633
2549
 
1634
 
        In the short term this should become a real object to intercept graph
1635
 
        lookups.
1636
 
 
1637
2550
        In the long term a full blown network facility is needed.
1638
2551
        """
1639
2552
        self._ensure_real()
1667
2580
 
1668
2581
    @needs_write_lock
1669
2582
    def sign_revision(self, revision_id, gpg_strategy):
1670
 
        self._ensure_real()
1671
 
        return self._real_repository.sign_revision(revision_id, gpg_strategy)
 
2583
        testament = _mod_testament.Testament.from_revision(self, revision_id)
 
2584
        plaintext = testament.as_short_text()
 
2585
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1672
2586
 
1673
2587
    @property
1674
2588
    def texts(self):
1680
2594
        self._ensure_real()
1681
2595
        return self._real_repository.texts
1682
2596
 
 
2597
    def _iter_revisions_rpc(self, revision_ids):
 
2598
        body = "\n".join(revision_ids)
 
2599
        path = self.bzrdir._path_for_remote_call(self._client)
 
2600
        response_tuple, response_handler = (
 
2601
            self._call_with_body_bytes_expecting_body(
 
2602
            "Repository.iter_revisions", (path, ), body))
 
2603
        if response_tuple[0] != "ok":
 
2604
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2605
        serializer_format = response_tuple[1]
 
2606
        serializer = serializer_format_registry.get(serializer_format)
 
2607
        byte_stream = response_handler.read_streamed_body()
 
2608
        decompressor = zlib.decompressobj()
 
2609
        chunks = []
 
2610
        for bytes in byte_stream:
 
2611
            chunks.append(decompressor.decompress(bytes))
 
2612
            if decompressor.unused_data != "":
 
2613
                chunks.append(decompressor.flush())
 
2614
                yield serializer.read_revision_from_string("".join(chunks))
 
2615
                unused = decompressor.unused_data
 
2616
                decompressor = zlib.decompressobj()
 
2617
                chunks = [decompressor.decompress(unused)]
 
2618
        chunks.append(decompressor.flush())
 
2619
        text = "".join(chunks)
 
2620
        if text != "":
 
2621
            yield serializer.read_revision_from_string("".join(chunks))
 
2622
 
1683
2623
    @needs_read_lock
1684
2624
    def get_revisions(self, revision_ids):
1685
 
        self._ensure_real()
1686
 
        return self._real_repository.get_revisions(revision_ids)
 
2625
        if revision_ids is None:
 
2626
            revision_ids = self.all_revision_ids()
 
2627
        else:
 
2628
            for rev_id in revision_ids:
 
2629
                if not rev_id or not isinstance(rev_id, basestring):
 
2630
                    raise errors.InvalidRevisionId(
 
2631
                        revision_id=rev_id, branch=self)
 
2632
        try:
 
2633
            missing = set(revision_ids)
 
2634
            revs = {}
 
2635
            for rev in self._iter_revisions_rpc(revision_ids):
 
2636
                missing.remove(rev.revision_id)
 
2637
                revs[rev.revision_id] = rev
 
2638
        except errors.UnknownSmartMethod:
 
2639
            self._ensure_real()
 
2640
            return self._real_repository.get_revisions(revision_ids)
 
2641
        for fallback in self._fallback_repositories:
 
2642
            if not missing:
 
2643
                break
 
2644
            for revid in list(missing):
 
2645
                # XXX JRV 2011-11-20: It would be nice if there was a
 
2646
                # public method on Repository that could be used to query
 
2647
                # for revision objects *without* failing completely if one
 
2648
                # was missing. There is VersionedFileRepository._iter_revisions,
 
2649
                # but unfortunately that's private and not provided by
 
2650
                # all repository implementations.
 
2651
                try:
 
2652
                    revs[revid] = fallback.get_revision(revid)
 
2653
                except errors.NoSuchRevision:
 
2654
                    pass
 
2655
                else:
 
2656
                    missing.remove(revid)
 
2657
        if missing:
 
2658
            raise errors.NoSuchRevision(self, list(missing)[0])
 
2659
        return [revs[revid] for revid in revision_ids]
1687
2660
 
1688
2661
    def supports_rich_root(self):
1689
2662
        return self._format.rich_root_data
1690
2663
 
 
2664
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1691
2665
    def iter_reverse_revision_history(self, revision_id):
1692
2666
        self._ensure_real()
1693
2667
        return self._real_repository.iter_reverse_revision_history(revision_id)
1696
2670
    def _serializer(self):
1697
2671
        return self._format._serializer
1698
2672
 
 
2673
    @needs_write_lock
1699
2674
    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)
 
2675
        signature = gpg_strategy.sign(plaintext)
 
2676
        self.add_signature_text(revision_id, signature)
1703
2677
 
1704
2678
    def add_signature_text(self, revision_id, signature):
1705
 
        self._ensure_real()
1706
 
        return self._real_repository.add_signature_text(revision_id, signature)
 
2679
        if self._real_repository:
 
2680
            # If there is a real repository the write group will
 
2681
            # be in the real repository as well, so use that:
 
2682
            self._ensure_real()
 
2683
            return self._real_repository.add_signature_text(
 
2684
                revision_id, signature)
 
2685
        path = self.bzrdir._path_for_remote_call(self._client)
 
2686
        response, handler = self._call_with_body_bytes_expecting_body(
 
2687
            'Repository.add_signature_text', (path, self._lock_token,
 
2688
                revision_id) + tuple(self._write_group_tokens), signature)
 
2689
        handler.cancel_read_body()
 
2690
        self.refresh_data()
 
2691
        if response[0] != 'ok':
 
2692
            raise errors.UnexpectedSmartServerResponse(response)
 
2693
        self._write_group_tokens = response[1:]
1707
2694
 
1708
2695
    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)
 
2696
        path = self.bzrdir._path_for_remote_call(self._client)
 
2697
        try:
 
2698
            response = self._call('Repository.has_signature_for_revision_id',
 
2699
                path, revision_id)
 
2700
        except errors.UnknownSmartMethod:
 
2701
            self._ensure_real()
 
2702
            return self._real_repository.has_signature_for_revision_id(
 
2703
                revision_id)
 
2704
        if response[0] not in ('yes', 'no'):
 
2705
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
2706
        if response[0] == 'yes':
 
2707
            return True
 
2708
        for fallback in self._fallback_repositories:
 
2709
            if fallback.has_signature_for_revision_id(revision_id):
 
2710
                return True
 
2711
        return False
 
2712
 
 
2713
    @needs_read_lock
 
2714
    def verify_revision_signature(self, revision_id, gpg_strategy):
 
2715
        if not self.has_signature_for_revision_id(revision_id):
 
2716
            return gpg.SIGNATURE_NOT_SIGNED, None
 
2717
        signature = self.get_signature_text(revision_id)
 
2718
 
 
2719
        testament = _mod_testament.Testament.from_revision(self, revision_id)
 
2720
        plaintext = testament.as_short_text()
 
2721
 
 
2722
        return gpg_strategy.verify(signature, plaintext)
1711
2723
 
1712
2724
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1713
2725
        self._ensure_real()
1714
2726
        return self._real_repository.item_keys_introduced_by(revision_ids,
1715
2727
            _files_pb=_files_pb)
1716
2728
 
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
2729
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
1723
2730
        self._ensure_real()
1724
2731
        return self._real_repository._find_inconsistent_revision_parents(
1732
2739
        providers = [self._unstacked_provider]
1733
2740
        if other is not None:
1734
2741
            providers.insert(0, other)
1735
 
        providers.extend(r._make_parents_provider() for r in
1736
 
                         self._fallback_repositories)
1737
 
        return graph.StackedParentsProvider(providers)
 
2742
        return graph.StackedParentsProvider(_LazyListJoin(
 
2743
            providers, self._fallback_repositories))
1738
2744
 
1739
2745
    def _serialise_search_recipe(self, recipe):
1740
2746
        """Serialise a graph search recipe.
1748
2754
        return '\n'.join((start_keys, stop_keys, count))
1749
2755
 
1750
2756
    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)]
 
2757
        parts = search_result.get_network_struct()
1757
2758
        return '\n'.join(parts)
1758
2759
 
1759
2760
    def autopack(self):
1769
2770
            raise errors.UnexpectedSmartServerResponse(response)
1770
2771
 
1771
2772
 
1772
 
class RemoteStreamSink(repository.StreamSink):
 
2773
class RemoteStreamSink(vf_repository.StreamSink):
1773
2774
 
1774
2775
    def _insert_real(self, stream, src_format, resume_tokens):
1775
2776
        self.target_repo._ensure_real()
1876
2877
        self._last_substream and self._last_stream so that the stream can be
1877
2878
        resumed by _resume_stream_with_vfs.
1878
2879
        """
1879
 
                    
 
2880
 
1880
2881
        stream_iter = iter(stream)
1881
2882
        for substream_kind, substream in stream_iter:
1882
2883
            if substream_kind == 'inventory-deltas':
1885
2886
                return
1886
2887
            else:
1887
2888
                yield substream_kind, substream
1888
 
            
1889
 
 
1890
 
class RemoteStreamSource(repository.StreamSource):
 
2889
 
 
2890
 
 
2891
class RemoteStreamSource(vf_repository.StreamSource):
1891
2892
    """Stream data from a remote server."""
1892
2893
 
1893
2894
    def get_stream(self, search):
1914
2915
 
1915
2916
    def _real_stream(self, repo, search):
1916
2917
        """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 
 
2918
 
 
2919
        This never called RemoteStreamSource.get_stream, and is a helper
 
2920
        for RemoteStreamSource._get_stream to allow getting a stream
1920
2921
        reliably whether fallback back because of old servers or trying
1921
2922
        to stream from a non-RemoteRepository (which the stacked support
1922
2923
        code will do).
1953
2954
        candidate_verbs = [
1954
2955
            ('Repository.get_stream_1.19', (1, 19)),
1955
2956
            ('Repository.get_stream', (1, 13))]
 
2957
 
1956
2958
        found_verb = False
1957
2959
        for verb, version in candidate_verbs:
1958
2960
            if medium._is_remote_before(version):
1962
2964
                    verb, args, search_bytes)
1963
2965
            except errors.UnknownSmartMethod:
1964
2966
                medium._remember_remote_is_before(version)
 
2967
            except errors.UnknownErrorFromSmartServer, e:
 
2968
                if isinstance(search, vf_search.EverythingResult):
 
2969
                    error_verb = e.error_from_smart_server.error_verb
 
2970
                    if error_verb == 'BadSearch':
 
2971
                        # Pre-2.4 servers don't support this sort of search.
 
2972
                        # XXX: perhaps falling back to VFS on BadSearch is a
 
2973
                        # good idea in general?  It might provide a little bit
 
2974
                        # of protection against client-side bugs.
 
2975
                        medium._remember_remote_is_before((2, 4))
 
2976
                        break
 
2977
                raise
1965
2978
            else:
1966
2979
                response_tuple, response_handler = response
1967
2980
                found_verb = True
1971
2984
        if response_tuple[0] != 'ok':
1972
2985
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1973
2986
        byte_stream = response_handler.read_streamed_body()
1974
 
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
 
2987
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream,
 
2988
            self._record_counter)
1975
2989
        if src_format.network_name() != repo._format.network_name():
1976
2990
            raise AssertionError(
1977
2991
                "Mismatched RemoteRepository and stream src %r, %r" % (
2049
3063
 
2050
3064
    def _ensure_real(self):
2051
3065
        if self._custom_format is None:
2052
 
            self._custom_format = branch.network_format_registry.get(
2053
 
                self._network_name)
 
3066
            try:
 
3067
                self._custom_format = branch.network_format_registry.get(
 
3068
                    self._network_name)
 
3069
            except KeyError:
 
3070
                raise errors.UnknownFormatError(kind='branch',
 
3071
                    format=self._network_name)
2054
3072
 
2055
3073
    def get_format_description(self):
2056
3074
        self._ensure_real()
2063
3081
        return a_bzrdir.open_branch(name=name, 
2064
3082
            ignore_fallbacks=ignore_fallbacks)
2065
3083
 
2066
 
    def _vfs_initialize(self, a_bzrdir, name):
 
3084
    def _vfs_initialize(self, a_bzrdir, name, append_revisions_only):
2067
3085
        # Initialisation when using a local bzrdir object, or a non-vfs init
2068
3086
        # method is not available on the server.
2069
3087
        # self._custom_format is always set - the start of initialize ensures
2071
3089
        if isinstance(a_bzrdir, RemoteBzrDir):
2072
3090
            a_bzrdir._ensure_real()
2073
3091
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2074
 
                name)
 
3092
                name, append_revisions_only=append_revisions_only)
2075
3093
        else:
2076
3094
            # We assume the bzrdir is parameterised; it may not be.
2077
 
            result = self._custom_format.initialize(a_bzrdir, name)
 
3095
            result = self._custom_format.initialize(a_bzrdir, name,
 
3096
                append_revisions_only=append_revisions_only)
2078
3097
        if (isinstance(a_bzrdir, RemoteBzrDir) and
2079
3098
            not isinstance(result, RemoteBranch)):
2080
3099
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2081
3100
                                  name=name)
2082
3101
        return result
2083
3102
 
2084
 
    def initialize(self, a_bzrdir, name=None):
 
3103
    def initialize(self, a_bzrdir, name=None, repository=None,
 
3104
                   append_revisions_only=None):
2085
3105
        # 1) get the network name to use.
2086
3106
        if self._custom_format:
2087
3107
            network_name = self._custom_format.network_name()
2088
3108
        else:
2089
3109
            # Select the current bzrlib default and ask for that.
2090
 
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
 
3110
            reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
2091
3111
            reference_format = reference_bzrdir_format.get_branch_format()
2092
3112
            self._custom_format = reference_format
2093
3113
            network_name = reference_format.network_name()
2094
3114
        # Being asked to create on a non RemoteBzrDir:
2095
3115
        if not isinstance(a_bzrdir, RemoteBzrDir):
2096
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
3116
            return self._vfs_initialize(a_bzrdir, name=name,
 
3117
                append_revisions_only=append_revisions_only)
2097
3118
        medium = a_bzrdir._client._medium
2098
3119
        if medium._is_remote_before((1, 13)):
2099
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
3120
            return self._vfs_initialize(a_bzrdir, name=name,
 
3121
                append_revisions_only=append_revisions_only)
2100
3122
        # Creating on a remote bzr dir.
2101
3123
        # 2) try direct creation via RPC
2102
3124
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2109
3131
        except errors.UnknownSmartMethod:
2110
3132
            # Fallback - use vfs methods
2111
3133
            medium._remember_remote_is_before((1, 13))
2112
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
3134
            return self._vfs_initialize(a_bzrdir, name=name,
 
3135
                    append_revisions_only=append_revisions_only)
2113
3136
        if response[0] != 'ok':
2114
3137
            raise errors.UnexpectedSmartServerResponse(response)
2115
3138
        # Turn the response into a RemoteRepository object.
2116
3139
        format = RemoteBranchFormat(network_name=response[1])
2117
3140
        repo_format = response_tuple_to_repo_format(response[3:])
2118
 
        if response[2] == '':
2119
 
            repo_bzrdir = a_bzrdir
 
3141
        repo_path = response[2]
 
3142
        if repository is not None:
 
3143
            remote_repo_url = urlutils.join(a_bzrdir.user_url, repo_path)
 
3144
            url_diff = urlutils.relative_url(repository.user_url,
 
3145
                    remote_repo_url)
 
3146
            if url_diff != '.':
 
3147
                raise AssertionError(
 
3148
                    'repository.user_url %r does not match URL from server '
 
3149
                    'response (%r + %r)'
 
3150
                    % (repository.user_url, a_bzrdir.user_url, repo_path))
 
3151
            remote_repo = repository
2120
3152
        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)
 
3153
            if repo_path == '':
 
3154
                repo_bzrdir = a_bzrdir
 
3155
            else:
 
3156
                repo_bzrdir = RemoteBzrDir(
 
3157
                    a_bzrdir.root_transport.clone(repo_path), a_bzrdir._format,
 
3158
                    a_bzrdir._client)
 
3159
            remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2125
3160
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2126
3161
            format=format, setup_stacking=False, name=name)
 
3162
        if append_revisions_only:
 
3163
            remote_branch.set_append_revisions_only(append_revisions_only)
2127
3164
        # XXX: We know this is a new branch, so it must have revno 0, revid
2128
3165
        # NULL_REVISION. Creating the branch locked would make this be unable
2129
3166
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2148
3185
        self._ensure_real()
2149
3186
        return self._custom_format.supports_set_append_revisions_only()
2150
3187
 
 
3188
    def _use_default_local_heads_to_fetch(self):
 
3189
        # If the branch format is a metadir format *and* its heads_to_fetch
 
3190
        # implementation is not overridden vs the base class, we can use the
 
3191
        # base class logic rather than use the heads_to_fetch RPC.  This is
 
3192
        # usually cheaper in terms of net round trips, as the last-revision and
 
3193
        # tags info fetched is cached and would be fetched anyway.
 
3194
        self._ensure_real()
 
3195
        if isinstance(self._custom_format, branch.BranchFormatMetadir):
 
3196
            branch_class = self._custom_format._branch_class()
 
3197
            heads_to_fetch_impl = branch_class.heads_to_fetch.im_func
 
3198
            if heads_to_fetch_impl is branch.Branch.heads_to_fetch.im_func:
 
3199
                return True
 
3200
        return False
 
3201
 
 
3202
 
 
3203
class RemoteBranchStore(_mod_config.IniFileStore):
 
3204
    """Branch store which attempts to use HPSS calls to retrieve branch store.
 
3205
 
 
3206
    Note that this is specific to bzr-based formats.
 
3207
    """
 
3208
 
 
3209
    def __init__(self, branch):
 
3210
        super(RemoteBranchStore, self).__init__()
 
3211
        self.branch = branch
 
3212
        self.id = "branch"
 
3213
        self._real_store = None
 
3214
 
 
3215
    def lock_write(self, token=None):
 
3216
        return self.branch.lock_write(token)
 
3217
 
 
3218
    def unlock(self):
 
3219
        return self.branch.unlock()
 
3220
 
 
3221
    @needs_write_lock
 
3222
    def save(self):
 
3223
        # We need to be able to override the undecorated implementation
 
3224
        self.save_without_locking()
 
3225
 
 
3226
    def save_without_locking(self):
 
3227
        super(RemoteBranchStore, self).save()
 
3228
 
 
3229
    def external_url(self):
 
3230
        return self.branch.user_url
 
3231
 
 
3232
    def _load_content(self):
 
3233
        path = self.branch._remote_path()
 
3234
        try:
 
3235
            response, handler = self.branch._call_expecting_body(
 
3236
                'Branch.get_config_file', path)
 
3237
        except errors.UnknownSmartMethod:
 
3238
            self._ensure_real()
 
3239
            return self._real_store._load_content()
 
3240
        if len(response) and response[0] != 'ok':
 
3241
            raise errors.UnexpectedSmartServerResponse(response)
 
3242
        return handler.read_body_bytes()
 
3243
 
 
3244
    def _save_content(self, content):
 
3245
        path = self.branch._remote_path()
 
3246
        try:
 
3247
            response, handler = self.branch._call_with_body_bytes_expecting_body(
 
3248
                'Branch.put_config_file', (path,
 
3249
                    self.branch._lock_token, self.branch._repo_lock_token),
 
3250
                content)
 
3251
        except errors.UnknownSmartMethod:
 
3252
            self._ensure_real()
 
3253
            return self._real_store._save_content(content)
 
3254
        handler.cancel_read_body()
 
3255
        if response != ('ok', ):
 
3256
            raise errors.UnexpectedSmartServerResponse(response)
 
3257
 
 
3258
    def _ensure_real(self):
 
3259
        self.branch._ensure_real()
 
3260
        if self._real_store is None:
 
3261
            self._real_store = _mod_config.BranchStore(self.branch)
 
3262
 
2151
3263
 
2152
3264
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
2153
3265
    """Branch stored on a server accessed by HPSS RPC.
2156
3268
    """
2157
3269
 
2158
3270
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2159
 
        _client=None, format=None, setup_stacking=True, name=None):
 
3271
        _client=None, format=None, setup_stacking=True, name=None,
 
3272
        possible_transports=None):
2160
3273
        """Create a RemoteBranch instance.
2161
3274
 
2162
3275
        :param real_branch: An optional local implementation of the branch
2227
3340
            hook(self)
2228
3341
        self._is_stacked = False
2229
3342
        if setup_stacking:
2230
 
            self._setup_stacking()
 
3343
            self._setup_stacking(possible_transports)
2231
3344
 
2232
 
    def _setup_stacking(self):
 
3345
    def _setup_stacking(self, possible_transports):
2233
3346
        # configure stacking into the remote repository, by reading it from
2234
3347
        # the vfs branch.
2235
3348
        try:
2238
3351
            errors.UnstackableRepositoryFormat), e:
2239
3352
            return
2240
3353
        self._is_stacked = True
2241
 
        self._activate_fallback_location(fallback_url)
 
3354
        if possible_transports is None:
 
3355
            possible_transports = []
 
3356
        else:
 
3357
            possible_transports = list(possible_transports)
 
3358
        possible_transports.append(self.bzrdir.root_transport)
 
3359
        self._activate_fallback_location(fallback_url,
 
3360
            possible_transports=possible_transports)
2242
3361
 
2243
3362
    def _get_config(self):
2244
3363
        return RemoteBranchConfig(self)
2245
3364
 
 
3365
    def _get_config_store(self):
 
3366
        return RemoteBranchStore(self)
 
3367
 
2246
3368
    def _get_real_transport(self):
2247
3369
        # if we try vfs access, return the real branch's vfs transport
2248
3370
        self._ensure_real()
2311
3433
                self.bzrdir, self._client)
2312
3434
        return self._control_files
2313
3435
 
2314
 
    def _get_checkout_format(self):
2315
 
        self._ensure_real()
2316
 
        return self._real_branch._get_checkout_format()
2317
 
 
2318
3436
    def get_physical_lock_status(self):
2319
3437
        """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()
 
3438
        try:
 
3439
            response = self._client.call('Branch.get_physical_lock_status',
 
3440
                self._remote_path())
 
3441
        except errors.UnknownSmartMethod:
 
3442
            self._ensure_real()
 
3443
            return self._real_branch.get_physical_lock_status()
 
3444
        if response[0] not in ('yes', 'no'):
 
3445
            raise errors.UnexpectedSmartServerResponse(response)
 
3446
        return (response[0] == 'yes')
2323
3447
 
2324
3448
    def get_stacked_on_url(self):
2325
3449
        """Get the URL this branch is stacked against.
2352
3476
            self._is_stacked = False
2353
3477
        else:
2354
3478
            self._is_stacked = True
2355
 
        
 
3479
 
2356
3480
    def _vfs_get_tags_bytes(self):
2357
3481
        self._ensure_real()
2358
3482
        return self._real_branch._get_tags_bytes()
2359
3483
 
 
3484
    @needs_read_lock
2360
3485
    def _get_tags_bytes(self):
 
3486
        if self._tags_bytes is None:
 
3487
            self._tags_bytes = self._get_tags_bytes_via_hpss()
 
3488
        return self._tags_bytes
 
3489
 
 
3490
    def _get_tags_bytes_via_hpss(self):
2361
3491
        medium = self._client._medium
2362
3492
        if medium._is_remote_before((1, 13)):
2363
3493
            return self._vfs_get_tags_bytes()
2373
3503
        return self._real_branch._set_tags_bytes(bytes)
2374
3504
 
2375
3505
    def _set_tags_bytes(self, bytes):
 
3506
        if self.is_locked():
 
3507
            self._tags_bytes = bytes
2376
3508
        medium = self._client._medium
2377
3509
        if medium._is_remote_before((1, 18)):
2378
3510
            self._vfs_set_tags_bytes(bytes)
2387
3519
            self._vfs_set_tags_bytes(bytes)
2388
3520
 
2389
3521
    def lock_read(self):
 
3522
        """Lock the branch for read operations.
 
3523
 
 
3524
        :return: A bzrlib.lock.LogicalLockResult.
 
3525
        """
2390
3526
        self.repository.lock_read()
2391
3527
        if not self._lock_mode:
2392
3528
            self._note_lock('r')
2396
3532
                self._real_branch.lock_read()
2397
3533
        else:
2398
3534
            self._lock_count += 1
 
3535
        return lock.LogicalLockResult(self.unlock)
2399
3536
 
2400
3537
    def _remote_lock_write(self, token):
2401
3538
        if token is None:
2402
3539
            branch_token = repo_token = ''
2403
3540
        else:
2404
3541
            branch_token = token
2405
 
            repo_token = self.repository.lock_write()
 
3542
            repo_token = self.repository.lock_write().repository_token
2406
3543
            self.repository.unlock()
2407
3544
        err_context = {'token': token}
2408
 
        response = self._call(
2409
 
            'Branch.lock_write', self._remote_path(), branch_token,
2410
 
            repo_token or '', **err_context)
 
3545
        try:
 
3546
            response = self._call(
 
3547
                'Branch.lock_write', self._remote_path(), branch_token,
 
3548
                repo_token or '', **err_context)
 
3549
        except errors.LockContention, e:
 
3550
            # The LockContention from the server doesn't have any
 
3551
            # information about the lock_url. We re-raise LockContention
 
3552
            # with valid lock_url.
 
3553
            raise errors.LockContention('(remote lock)',
 
3554
                self.repository.base.split('.bzr/')[0])
2411
3555
        if response[0] != 'ok':
2412
3556
            raise errors.UnexpectedSmartServerResponse(response)
2413
3557
        ok, branch_token, repo_token = response
2434
3578
            self._lock_mode = 'w'
2435
3579
            self._lock_count = 1
2436
3580
        elif self._lock_mode == 'r':
2437
 
            raise errors.ReadOnlyTransaction
 
3581
            raise errors.ReadOnlyError(self)
2438
3582
        else:
2439
3583
            if token is not None:
2440
3584
                # A token was given to lock_write, and we're relocking, so
2445
3589
            self._lock_count += 1
2446
3590
            # Re-lock the repository too.
2447
3591
            self.repository.lock_write(self._repo_lock_token)
2448
 
        return self._lock_token or None
 
3592
        return BranchWriteLockResult(self.unlock, self._lock_token or None)
2449
3593
 
2450
3594
    def _unlock(self, branch_token, repo_token):
2451
3595
        err_context = {'token': str((branch_token, repo_token))}
2489
3633
            self.repository.unlock()
2490
3634
 
2491
3635
    def break_lock(self):
2492
 
        self._ensure_real()
2493
 
        return self._real_branch.break_lock()
 
3636
        try:
 
3637
            response = self._call(
 
3638
                'Branch.break_lock', self._remote_path())
 
3639
        except errors.UnknownSmartMethod:
 
3640
            self._ensure_real()
 
3641
            return self._real_branch.break_lock()
 
3642
        if response != ('ok',):
 
3643
            raise errors.UnexpectedSmartServerResponse(response)
2494
3644
 
2495
3645
    def leave_lock_in_place(self):
2496
3646
        if not self._lock_token:
2520
3670
            missing_parent = parent_map[missing_parent]
2521
3671
        raise errors.RevisionNotPresent(missing_parent, self.repository)
2522
3672
 
2523
 
    def _last_revision_info(self):
 
3673
    def _read_last_revision_info(self):
2524
3674
        response = self._call('Branch.last_revision_info', self._remote_path())
2525
3675
        if response[0] != 'ok':
2526
3676
            raise SmartProtocolError('unexpected response code %s' % (response,))
2589
3739
            raise errors.UnexpectedSmartServerResponse(response)
2590
3740
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2591
3741
 
 
3742
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2592
3743
    @needs_write_lock
2593
3744
    def set_revision_history(self, rev_history):
 
3745
        """See Branch.set_revision_history."""
 
3746
        self._set_revision_history(rev_history)
 
3747
 
 
3748
    @needs_write_lock
 
3749
    def _set_revision_history(self, rev_history):
2594
3750
        # Send just the tip revision of the history; the server will generate
2595
3751
        # the full history from that.  If the revision doesn't exist in this
2596
3752
        # branch, NoSuchRevision will be raised.
2654
3810
            _override_hook_target=self, **kwargs)
2655
3811
 
2656
3812
    @needs_read_lock
2657
 
    def push(self, target, overwrite=False, stop_revision=None):
 
3813
    def push(self, target, overwrite=False, stop_revision=None, lossy=False):
2658
3814
        self._ensure_real()
2659
3815
        return self._real_branch.push(
2660
 
            target, overwrite=overwrite, stop_revision=stop_revision,
 
3816
            target, overwrite=overwrite, stop_revision=stop_revision, lossy=lossy,
2661
3817
            _override_hook_source_branch=self)
2662
3818
 
2663
3819
    def is_locked(self):
2664
3820
        return self._lock_count >= 1
2665
3821
 
2666
3822
    @needs_read_lock
 
3823
    def revision_id_to_dotted_revno(self, revision_id):
 
3824
        """Given a revision id, return its dotted revno.
 
3825
 
 
3826
        :return: a tuple like (1,) or (400,1,3).
 
3827
        """
 
3828
        try:
 
3829
            response = self._call('Branch.revision_id_to_revno',
 
3830
                self._remote_path(), revision_id)
 
3831
        except errors.UnknownSmartMethod:
 
3832
            self._ensure_real()
 
3833
            return self._real_branch.revision_id_to_dotted_revno(revision_id)
 
3834
        if response[0] == 'ok':
 
3835
            return tuple([int(x) for x in response[1:]])
 
3836
        else:
 
3837
            raise errors.UnexpectedSmartServerResponse(response)
 
3838
 
 
3839
    @needs_read_lock
2667
3840
    def revision_id_to_revno(self, revision_id):
2668
 
        self._ensure_real()
2669
 
        return self._real_branch.revision_id_to_revno(revision_id)
 
3841
        """Given a revision id on the branch mainline, return its revno.
 
3842
 
 
3843
        :return: an integer
 
3844
        """
 
3845
        try:
 
3846
            response = self._call('Branch.revision_id_to_revno',
 
3847
                self._remote_path(), revision_id)
 
3848
        except errors.UnknownSmartMethod:
 
3849
            self._ensure_real()
 
3850
            return self._real_branch.revision_id_to_revno(revision_id)
 
3851
        if response[0] == 'ok':
 
3852
            if len(response) == 2:
 
3853
                return int(response[1])
 
3854
            raise NoSuchRevision(self, revision_id)
 
3855
        else:
 
3856
            raise errors.UnexpectedSmartServerResponse(response)
2670
3857
 
2671
3858
    @needs_write_lock
2672
3859
    def set_last_revision_info(self, revno, revision_id):
2673
3860
        # XXX: These should be returned by the set_last_revision_info verb
2674
3861
        old_revno, old_revid = self.last_revision_info()
2675
3862
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2676
 
        revision_id = ensure_null(revision_id)
 
3863
        if not revision_id or not isinstance(revision_id, basestring):
 
3864
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2677
3865
        try:
2678
3866
            response = self._call('Branch.set_last_revision_info',
2679
3867
                self._remote_path(), self._lock_token, self._repo_lock_token,
2708
3896
            except errors.UnknownSmartMethod:
2709
3897
                medium._remember_remote_is_before((1, 6))
2710
3898
        self._clear_cached_state_of_remote_branch_only()
2711
 
        self.set_revision_history(self._lefthand_history(revision_id,
 
3899
        self._set_revision_history(self._lefthand_history(revision_id,
2712
3900
            last_rev=last_rev,other_branch=other_branch))
2713
3901
 
2714
3902
    def set_push_location(self, location):
2715
3903
        self._ensure_real()
2716
3904
        return self._real_branch.set_push_location(location)
2717
3905
 
 
3906
    def heads_to_fetch(self):
 
3907
        if self._format._use_default_local_heads_to_fetch():
 
3908
            # We recognise this format, and its heads-to-fetch implementation
 
3909
            # is the default one (tip + tags).  In this case it's cheaper to
 
3910
            # just use the default implementation rather than a special RPC as
 
3911
            # the tip and tags data is cached.
 
3912
            return branch.Branch.heads_to_fetch(self)
 
3913
        medium = self._client._medium
 
3914
        if medium._is_remote_before((2, 4)):
 
3915
            return self._vfs_heads_to_fetch()
 
3916
        try:
 
3917
            return self._rpc_heads_to_fetch()
 
3918
        except errors.UnknownSmartMethod:
 
3919
            medium._remember_remote_is_before((2, 4))
 
3920
            return self._vfs_heads_to_fetch()
 
3921
 
 
3922
    def _rpc_heads_to_fetch(self):
 
3923
        response = self._call('Branch.heads_to_fetch', self._remote_path())
 
3924
        if len(response) != 2:
 
3925
            raise errors.UnexpectedSmartServerResponse(response)
 
3926
        must_fetch, if_present_fetch = response
 
3927
        return set(must_fetch), set(if_present_fetch)
 
3928
 
 
3929
    def _vfs_heads_to_fetch(self):
 
3930
        self._ensure_real()
 
3931
        return self._real_branch.heads_to_fetch()
 
3932
 
2718
3933
 
2719
3934
class RemoteConfig(object):
2720
3935
    """A Config that reads and writes from smart verbs.
2734
3949
        """
2735
3950
        try:
2736
3951
            configobj = self._get_configobj()
 
3952
            section_obj = None
2737
3953
            if section is None:
2738
3954
                section_obj = configobj
2739
3955
            else:
2740
3956
                try:
2741
3957
                    section_obj = configobj[section]
2742
3958
                except KeyError:
2743
 
                    return default
2744
 
            return section_obj.get(name, default)
 
3959
                    pass
 
3960
            if section_obj is None:
 
3961
                value = default
 
3962
            else:
 
3963
                value = section_obj.get(name, default)
2745
3964
        except errors.UnknownSmartMethod:
2746
 
            return self._vfs_get_option(name, section, default)
 
3965
            value = self._vfs_get_option(name, section, default)
 
3966
        for hook in _mod_config.OldConfigHooks['get']:
 
3967
            hook(self, name, value)
 
3968
        return value
2747
3969
 
2748
3970
    def _response_to_configobj(self, response):
2749
3971
        if len(response[0]) and response[0][0] != 'ok':
2750
3972
            raise errors.UnexpectedSmartServerResponse(response)
2751
3973
        lines = response[1].read_body_bytes().splitlines()
2752
 
        return config.ConfigObj(lines, encoding='utf-8')
 
3974
        conf = _mod_config.ConfigObj(lines, encoding='utf-8')
 
3975
        for hook in _mod_config.OldConfigHooks['load']:
 
3976
            hook(self)
 
3977
        return conf
2753
3978
 
2754
3979
 
2755
3980
class RemoteBranchConfig(RemoteConfig):
2774
3999
        medium = self._branch._client._medium
2775
4000
        if medium._is_remote_before((1, 14)):
2776
4001
            return self._vfs_set_option(value, name, section)
 
4002
        if isinstance(value, dict):
 
4003
            if medium._is_remote_before((2, 2)):
 
4004
                return self._vfs_set_option(value, name, section)
 
4005
            return self._set_config_option_dict(value, name, section)
 
4006
        else:
 
4007
            return self._set_config_option(value, name, section)
 
4008
 
 
4009
    def _set_config_option(self, value, name, section):
2777
4010
        try:
2778
4011
            path = self._branch._remote_path()
2779
4012
            response = self._branch._client.call('Branch.set_config_option',
2780
4013
                path, self._branch._lock_token, self._branch._repo_lock_token,
2781
4014
                value.encode('utf8'), name, section or '')
2782
4015
        except errors.UnknownSmartMethod:
 
4016
            medium = self._branch._client._medium
2783
4017
            medium._remember_remote_is_before((1, 14))
2784
4018
            return self._vfs_set_option(value, name, section)
2785
4019
        if response != ():
2786
4020
            raise errors.UnexpectedSmartServerResponse(response)
2787
4021
 
 
4022
    def _serialize_option_dict(self, option_dict):
 
4023
        utf8_dict = {}
 
4024
        for key, value in option_dict.items():
 
4025
            if isinstance(key, unicode):
 
4026
                key = key.encode('utf8')
 
4027
            if isinstance(value, unicode):
 
4028
                value = value.encode('utf8')
 
4029
            utf8_dict[key] = value
 
4030
        return bencode.bencode(utf8_dict)
 
4031
 
 
4032
    def _set_config_option_dict(self, value, name, section):
 
4033
        try:
 
4034
            path = self._branch._remote_path()
 
4035
            serialised_dict = self._serialize_option_dict(value)
 
4036
            response = self._branch._client.call(
 
4037
                'Branch.set_config_option_dict',
 
4038
                path, self._branch._lock_token, self._branch._repo_lock_token,
 
4039
                serialised_dict, name, section or '')
 
4040
        except errors.UnknownSmartMethod:
 
4041
            medium = self._branch._client._medium
 
4042
            medium._remember_remote_is_before((2, 2))
 
4043
            return self._vfs_set_option(value, name, section)
 
4044
        if response != ():
 
4045
            raise errors.UnexpectedSmartServerResponse(response)
 
4046
 
2788
4047
    def _real_object(self):
2789
4048
        self._branch._ensure_real()
2790
4049
        return self._branch._real_branch
2829
4088
        return self._bzrdir._real_bzrdir
2830
4089
 
2831
4090
 
2832
 
 
2833
4091
def _extract_tar(tar, to_dir):
2834
4092
    """Extract all the contents of a tarfile object.
2835
4093
 
2839
4097
        tar.extract(tarinfo, to_dir)
2840
4098
 
2841
4099
 
 
4100
error_translators = registry.Registry()
 
4101
no_context_error_translators = registry.Registry()
 
4102
 
 
4103
 
2842
4104
def _translate_error(err, **context):
2843
4105
    """Translate an ErrorFromSmartServer into a more useful error.
2844
4106
 
2873
4135
                    'Missing key %r in context %r', key_err.args[0], context)
2874
4136
                raise err
2875
4137
 
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'):
 
4138
    try:
 
4139
        translator = error_translators.get(err.error_verb)
 
4140
    except KeyError:
 
4141
        pass
 
4142
    else:
 
4143
        raise translator(err, find, get_path)
 
4144
    try:
 
4145
        translator = no_context_error_translators.get(err.error_verb)
 
4146
    except KeyError:
 
4147
        raise errors.UnknownErrorFromSmartServer(err)
 
4148
    else:
 
4149
        raise translator(err)
 
4150
 
 
4151
 
 
4152
error_translators.register('NoSuchRevision',
 
4153
    lambda err, find, get_path: NoSuchRevision(
 
4154
        find('branch'), err.error_args[0]))
 
4155
error_translators.register('nosuchrevision',
 
4156
    lambda err, find, get_path: NoSuchRevision(
 
4157
        find('repository'), err.error_args[0]))
 
4158
 
 
4159
def _translate_nobranch_error(err, find, get_path):
 
4160
    if len(err.error_args) >= 1:
 
4161
        extra = err.error_args[0]
 
4162
    else:
 
4163
        extra = None
 
4164
    return errors.NotBranchError(path=find('bzrdir').root_transport.base,
 
4165
        detail=extra)
 
4166
 
 
4167
error_translators.register('nobranch', _translate_nobranch_error)
 
4168
error_translators.register('norepository',
 
4169
    lambda err, find, get_path: errors.NoRepositoryPresent(
 
4170
        find('bzrdir')))
 
4171
error_translators.register('UnlockableTransport',
 
4172
    lambda err, find, get_path: errors.UnlockableTransport(
 
4173
        find('bzrdir').root_transport))
 
4174
error_translators.register('TokenMismatch',
 
4175
    lambda err, find, get_path: errors.TokenMismatch(
 
4176
        find('token'), '(remote token)'))
 
4177
error_translators.register('Diverged',
 
4178
    lambda err, find, get_path: errors.DivergedBranches(
 
4179
        find('branch'), find('other_branch')))
 
4180
error_translators.register('NotStacked',
 
4181
    lambda err, find, get_path: errors.NotStacked(branch=find('branch')))
 
4182
 
 
4183
def _translate_PermissionDenied(err, find, get_path):
 
4184
    path = get_path()
 
4185
    if len(err.error_args) >= 2:
 
4186
        extra = err.error_args[1]
 
4187
    else:
 
4188
        extra = None
 
4189
    return errors.PermissionDenied(path, extra=extra)
 
4190
 
 
4191
error_translators.register('PermissionDenied', _translate_PermissionDenied)
 
4192
error_translators.register('ReadError',
 
4193
    lambda err, find, get_path: errors.ReadError(get_path()))
 
4194
error_translators.register('NoSuchFile',
 
4195
    lambda err, find, get_path: errors.NoSuchFile(get_path()))
 
4196
error_translators.register('TokenLockingNotSupported',
 
4197
    lambda err, find, get_path: errors.TokenLockingNotSupported(
 
4198
        find('repository')))
 
4199
error_translators.register('UnsuspendableWriteGroup',
 
4200
    lambda err, find, get_path: errors.UnsuspendableWriteGroup(
 
4201
        repository=find('repository')))
 
4202
error_translators.register('UnresumableWriteGroup',
 
4203
    lambda err, find, get_path: errors.UnresumableWriteGroup(
 
4204
        repository=find('repository'), write_groups=err.error_args[0],
 
4205
        reason=err.error_args[1]))
 
4206
no_context_error_translators.register('IncompatibleRepositories',
 
4207
    lambda err: errors.IncompatibleRepositories(
 
4208
        err.error_args[0], err.error_args[1], err.error_args[2]))
 
4209
no_context_error_translators.register('LockContention',
 
4210
    lambda err: errors.LockContention('(remote lock)'))
 
4211
no_context_error_translators.register('LockFailed',
 
4212
    lambda err: errors.LockFailed(err.error_args[0], err.error_args[1]))
 
4213
no_context_error_translators.register('TipChangeRejected',
 
4214
    lambda err: errors.TipChangeRejected(err.error_args[0].decode('utf8')))
 
4215
no_context_error_translators.register('UnstackableBranchFormat',
 
4216
    lambda err: errors.UnstackableBranchFormat(*err.error_args))
 
4217
no_context_error_translators.register('UnstackableRepositoryFormat',
 
4218
    lambda err: errors.UnstackableRepositoryFormat(*err.error_args))
 
4219
no_context_error_translators.register('FileExists',
 
4220
    lambda err: errors.FileExists(err.error_args[0]))
 
4221
no_context_error_translators.register('DirectoryNotEmpty',
 
4222
    lambda err: errors.DirectoryNotEmpty(err.error_args[0]))
 
4223
 
 
4224
def _translate_short_readv_error(err):
 
4225
    args = err.error_args
 
4226
    return errors.ShortReadvError(args[0], int(args[1]), int(args[2]),
 
4227
        int(args[3]))
 
4228
 
 
4229
no_context_error_translators.register('ShortReadvError',
 
4230
    _translate_short_readv_error)
 
4231
 
 
4232
def _translate_unicode_error(err):
2932
4233
        encoding = str(err.error_args[0]) # encoding must always be a string
2933
4234
        val = err.error_args[1]
2934
4235
        start = int(err.error_args[2])
2942
4243
            raise UnicodeDecodeError(encoding, val, start, end, reason)
2943
4244
        elif err.error_verb == 'UnicodeEncodeError':
2944
4245
            raise UnicodeEncodeError(encoding, val, start, end, reason)
2945
 
    elif err.error_verb == 'ReadOnlyError':
2946
 
        raise errors.TransportNotPossible('readonly transport')
2947
 
    raise errors.UnknownErrorFromSmartServer(err)
 
4246
 
 
4247
no_context_error_translators.register('UnicodeEncodeError',
 
4248
    _translate_unicode_error)
 
4249
no_context_error_translators.register('UnicodeDecodeError',
 
4250
    _translate_unicode_error)
 
4251
no_context_error_translators.register('ReadOnlyError',
 
4252
    lambda err: errors.TransportNotPossible('readonly transport'))
 
4253
no_context_error_translators.register('MemoryError',
 
4254
    lambda err: errors.BzrError("remote server out of memory\n"
 
4255
        "Retry non-remotely, or contact the server admin for details."))
 
4256
no_context_error_translators.register('RevisionNotPresent',
 
4257
    lambda err: errors.RevisionNotPresent(err.error_args[0], err.error_args[1]))
 
4258
 
 
4259
no_context_error_translators.register('BzrCheckError',
 
4260
    lambda err: errors.BzrCheckError(msg=err.error_args[0]))
 
4261