/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Vincent Ladeuil
  • Date: 2012-01-17 17:22:36 UTC
  • mto: (6437.3.6 2.5)
  • mto: This revision was merged to the branch mainline in revision 6441.
  • Revision ID: v.ladeuil+lp@free.fr-20120117172236-1wohkfo0tfihn4r5
Fix wrong url in admin guide

Show diffs side-by-side

added added

removed removed

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