/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/remote.py

  • Committer: Jelmer Vernooij
  • Date: 2012-01-18 17:46:57 UTC
  • mto: (6437.3.9 2.5)
  • mto: This revision was merged to the branch mainline in revision 6444.
  • Revision ID: jelmer@samba.org-20120118174657-ky8kr6dkhelqy07s
Update NEWS, tweak docstrings.

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 set_branch_reference(self, target_branch, name=None):
 
683
        """See BzrDir.set_branch_reference()."""
 
684
        self._ensure_real()
 
685
        return self._real_bzrdir.set_branch_reference(target_branch, name=name)
 
686
 
 
687
    def get_branch_reference(self, name=None):
284
688
        """See BzrDir.get_branch_reference()."""
 
689
        if name is not None:
 
690
            # XXX JRV20100304: Support opening colocated branches
 
691
            raise errors.NoColocatedBranchSupport(self)
285
692
        response = self._get_branch_reference()
286
693
        if response[0] == 'ref':
287
694
            return response[1]
318
725
            raise errors.UnexpectedSmartServerResponse(response)
319
726
        return response
320
727
 
321
 
    def _get_tree_branch(self):
 
728
    def _get_tree_branch(self, name=None):
322
729
        """See BzrDir._get_tree_branch()."""
323
 
        return None, self.open_branch()
 
730
        return None, self.open_branch(name=name)
324
731
 
325
732
    def open_branch(self, name=None, unsupported=False,
326
 
                    ignore_fallbacks=False):
 
733
                    ignore_fallbacks=False, possible_transports=None):
 
734
        if name is None:
 
735
            name = self._get_selected_branch()
327
736
        if unsupported:
328
737
            raise NotImplementedError('unsupported flag support not implemented yet.')
329
738
        if self._next_open_branch_result is not None:
336
745
            # a branch reference, use the existing BranchReference logic.
337
746
            format = BranchReferenceFormat()
338
747
            return format.open(self, name=name, _found=True,
339
 
                location=response[1], ignore_fallbacks=ignore_fallbacks)
 
748
                location=response[1], ignore_fallbacks=ignore_fallbacks,
 
749
                possible_transports=possible_transports)
340
750
        branch_format_name = response[1]
341
751
        if not branch_format_name:
342
752
            branch_format_name = None
343
753
        format = RemoteBranchFormat(network_name=branch_format_name)
344
754
        return RemoteBranch(self, self.find_repository(), format=format,
345
 
            setup_stacking=not ignore_fallbacks, name=name)
 
755
            setup_stacking=not ignore_fallbacks, name=name,
 
756
            possible_transports=possible_transports)
346
757
 
347
758
    def _open_repo_v1(self, path):
348
759
        verb = 'BzrDir.find_repository'
411
822
 
412
823
    def has_workingtree(self):
413
824
        if self._has_working_tree is None:
414
 
            self._ensure_real()
415
 
            self._has_working_tree = self._real_bzrdir.has_workingtree()
 
825
            path = self._path_for_remote_call(self._client)
 
826
            try:
 
827
                response = self._call('BzrDir.has_workingtree', path)
 
828
            except errors.UnknownSmartMethod:
 
829
                self._ensure_real()
 
830
                self._has_working_tree = self._real_bzrdir.has_workingtree()
 
831
            else:
 
832
                if response[0] not in ('yes', 'no'):
 
833
                    raise SmartProtocolError('unexpected response code %s' % (response,))
 
834
                self._has_working_tree = (response[0] == 'yes')
416
835
        return self._has_working_tree
417
836
 
418
837
    def open_workingtree(self, recommend_upgrade=True):
423
842
 
424
843
    def _path_for_remote_call(self, client):
425
844
        """Return the path to be used for this bzrdir in a remote call."""
426
 
        return client.remote_path_from_transport(self.root_transport)
 
845
        return urlutils.split_segment_parameters_raw(
 
846
            client.remote_path_from_transport(self.root_transport))[0]
427
847
 
428
848
    def get_branch_transport(self, branch_format, name=None):
429
849
        self._ensure_real()
441
861
        """Upgrading of remote bzrdirs is not supported yet."""
442
862
        return False
443
863
 
444
 
    def needs_format_conversion(self, format=None):
 
864
    def needs_format_conversion(self, format):
445
865
        """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
866
        return False
450
867
 
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
868
    def _get_config(self):
458
869
        return RemoteBzrDirConfig(self)
459
870
 
460
 
 
461
 
class RemoteRepositoryFormat(repository.RepositoryFormat):
 
871
    def _get_config_store(self):
 
872
        return RemoteControlStore(self)
 
873
 
 
874
 
 
875
class RemoteRepositoryFormat(vf_repository.VersionedFileRepositoryFormat):
462
876
    """Format for repositories accessed over a _SmartClient.
463
877
 
464
878
    Instances of this repository are represented by RemoteRepository
479
893
    """
480
894
 
481
895
    _matchingbzrdir = RemoteBzrDirFormat()
 
896
    supports_full_versioned_files = True
 
897
    supports_leaving_lock = True
482
898
 
483
899
    def __init__(self):
484
 
        repository.RepositoryFormat.__init__(self)
 
900
        _mod_repository.RepositoryFormat.__init__(self)
485
901
        self._custom_format = None
486
902
        self._network_name = None
487
903
        self._creating_bzrdir = None
 
904
        self._revision_graph_can_have_wrong_parents = None
488
905
        self._supports_chks = None
489
906
        self._supports_external_lookups = None
490
907
        self._supports_tree_reference = None
 
908
        self._supports_funky_characters = None
 
909
        self._supports_nesting_repositories = None
491
910
        self._rich_root_data = None
492
911
 
493
912
    def __repr__(self):
522
941
        return self._supports_external_lookups
523
942
 
524
943
    @property
 
944
    def supports_funky_characters(self):
 
945
        if self._supports_funky_characters is None:
 
946
            self._ensure_real()
 
947
            self._supports_funky_characters = \
 
948
                self._custom_format.supports_funky_characters
 
949
        return self._supports_funky_characters
 
950
 
 
951
    @property
 
952
    def supports_nesting_repositories(self):
 
953
        if self._supports_nesting_repositories is None:
 
954
            self._ensure_real()
 
955
            self._supports_nesting_repositories = \
 
956
                self._custom_format.supports_nesting_repositories
 
957
        return self._supports_nesting_repositories
 
958
 
 
959
    @property
525
960
    def supports_tree_reference(self):
526
961
        if self._supports_tree_reference is None:
527
962
            self._ensure_real()
529
964
                self._custom_format.supports_tree_reference
530
965
        return self._supports_tree_reference
531
966
 
 
967
    @property
 
968
    def revision_graph_can_have_wrong_parents(self):
 
969
        if self._revision_graph_can_have_wrong_parents is None:
 
970
            self._ensure_real()
 
971
            self._revision_graph_can_have_wrong_parents = \
 
972
                self._custom_format.revision_graph_can_have_wrong_parents
 
973
        return self._revision_graph_can_have_wrong_parents
 
974
 
532
975
    def _vfs_initialize(self, a_bzrdir, shared):
533
976
        """Helper for common code in initialize."""
534
977
        if self._custom_format:
569
1012
            network_name = self._network_name
570
1013
        else:
571
1014
            # Select the current bzrlib default and ask for that.
572
 
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
 
1015
            reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
573
1016
            reference_format = reference_bzrdir_format.repository_format
574
1017
            network_name = reference_format.network_name()
575
1018
        # 2) try direct creation via RPC
601
1044
 
602
1045
    def _ensure_real(self):
603
1046
        if self._custom_format is None:
604
 
            self._custom_format = repository.network_format_registry.get(
605
 
                self._network_name)
 
1047
            try:
 
1048
                self._custom_format = _mod_repository.network_format_registry.get(
 
1049
                    self._network_name)
 
1050
            except KeyError:
 
1051
                raise errors.UnknownFormatError(kind='repository',
 
1052
                    format=self._network_name)
606
1053
 
607
1054
    @property
608
1055
    def _fetch_order(self):
643
1090
        return self._custom_format._serializer
644
1091
 
645
1092
 
646
 
class RemoteRepository(_RpcHelper, lock._RelockDebugMixin,
647
 
    bzrdir.ControlComponent):
 
1093
class RemoteRepository(_mod_repository.Repository, _RpcHelper,
 
1094
        lock._RelockDebugMixin):
648
1095
    """Repository accessed over rpc.
649
1096
 
650
1097
    For the moment most operations are performed using local transport-backed
674
1121
        self._format = format
675
1122
        self._lock_mode = None
676
1123
        self._lock_token = None
 
1124
        self._write_group_tokens = None
677
1125
        self._lock_count = 0
678
1126
        self._leave_lock = False
679
1127
        # Cache of revision parents; misses are cached during read locks, and
703
1151
        # transport, but I'm not sure it's worth making this method
704
1152
        # optional -- mbp 2010-04-21
705
1153
        return self.bzrdir.get_repository_transport(None)
706
 
        
 
1154
 
707
1155
    def __str__(self):
708
1156
        return "%s(%s)" % (self.__class__.__name__, self.base)
709
1157
 
719
1167
 
720
1168
        :param suppress_errors: see Repository.abort_write_group.
721
1169
        """
722
 
        self._ensure_real()
723
 
        return self._real_repository.abort_write_group(
724
 
            suppress_errors=suppress_errors)
 
1170
        if self._real_repository:
 
1171
            self._ensure_real()
 
1172
            return self._real_repository.abort_write_group(
 
1173
                suppress_errors=suppress_errors)
 
1174
        if not self.is_in_write_group():
 
1175
            if suppress_errors:
 
1176
                mutter('(suppressed) not in write group')
 
1177
                return
 
1178
            raise errors.BzrError("not in write group")
 
1179
        path = self.bzrdir._path_for_remote_call(self._client)
 
1180
        try:
 
1181
            response = self._call('Repository.abort_write_group', path,
 
1182
                self._lock_token, self._write_group_tokens)
 
1183
        except Exception, exc:
 
1184
            self._write_group = None
 
1185
            if not suppress_errors:
 
1186
                raise
 
1187
            mutter('abort_write_group failed')
 
1188
            log_exception_quietly()
 
1189
            note(gettext('bzr: ERROR (ignored): %s'), exc)
 
1190
        else:
 
1191
            if response != ('ok', ):
 
1192
                raise errors.UnexpectedSmartServerResponse(response)
 
1193
            self._write_group_tokens = None
725
1194
 
726
1195
    @property
727
1196
    def chk_bytes(self):
741
1210
        for older plugins that don't use e.g. the CommitBuilder
742
1211
        facility.
743
1212
        """
744
 
        self._ensure_real()
745
 
        return self._real_repository.commit_write_group()
 
1213
        if self._real_repository:
 
1214
            self._ensure_real()
 
1215
            return self._real_repository.commit_write_group()
 
1216
        if not self.is_in_write_group():
 
1217
            raise errors.BzrError("not in write group")
 
1218
        path = self.bzrdir._path_for_remote_call(self._client)
 
1219
        response = self._call('Repository.commit_write_group', path,
 
1220
            self._lock_token, self._write_group_tokens)
 
1221
        if response != ('ok', ):
 
1222
            raise errors.UnexpectedSmartServerResponse(response)
 
1223
        self._write_group_tokens = None
 
1224
        # Refresh data after writing to the repository.
 
1225
        self.refresh_data()
746
1226
 
747
1227
    def resume_write_group(self, tokens):
748
 
        self._ensure_real()
749
 
        return self._real_repository.resume_write_group(tokens)
 
1228
        if self._real_repository:
 
1229
            return self._real_repository.resume_write_group(tokens)
 
1230
        path = self.bzrdir._path_for_remote_call(self._client)
 
1231
        try:
 
1232
            response = self._call('Repository.check_write_group', path,
 
1233
               self._lock_token, tokens)
 
1234
        except errors.UnknownSmartMethod:
 
1235
            self._ensure_real()
 
1236
            return self._real_repository.resume_write_group(tokens)
 
1237
        if response != ('ok', ):
 
1238
            raise errors.UnexpectedSmartServerResponse(response)
 
1239
        self._write_group_tokens = tokens
750
1240
 
751
1241
    def suspend_write_group(self):
752
 
        self._ensure_real()
753
 
        return self._real_repository.suspend_write_group()
 
1242
        if self._real_repository:
 
1243
            return self._real_repository.suspend_write_group()
 
1244
        ret = self._write_group_tokens or []
 
1245
        self._write_group_tokens = None
 
1246
        return ret
754
1247
 
755
1248
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
756
1249
        self._ensure_real()
817
1310
    def find_text_key_references(self):
818
1311
        """Find the text key references within the repository.
819
1312
 
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
1313
        :return: A dictionary mapping text keys ((fileid, revision_id) tuples)
824
1314
            to whether they were referred to by the inventory of the
825
1315
            revision_id that they contain. The inventory texts from all present
843
1333
        """Private method for using with old (< 1.2) servers to fallback."""
844
1334
        if revision_id is None:
845
1335
            revision_id = ''
846
 
        elif revision.is_null(revision_id):
 
1336
        elif _mod_revision.is_null(revision_id):
847
1337
            return {}
848
1338
 
849
1339
        path = self.bzrdir._path_for_remote_call(self._client)
873
1363
        return RemoteStreamSource(self, to_format)
874
1364
 
875
1365
    @needs_read_lock
 
1366
    def get_file_graph(self):
 
1367
        return graph.Graph(self.texts)
 
1368
 
 
1369
    @needs_read_lock
876
1370
    def has_revision(self, revision_id):
877
1371
        """True if this repository has a copy of the revision."""
878
1372
        # Copy of bzrlib.repository.Repository.has_revision
895
1389
    def _has_same_fallbacks(self, other_repo):
896
1390
        """Returns true if the repositories have the same fallbacks."""
897
1391
        # XXX: copied from Repository; it should be unified into a base class
898
 
        # <https://bugs.edge.launchpad.net/bzr/+bug/401622>
 
1392
        # <https://bugs.launchpad.net/bzr/+bug/401622>
899
1393
        my_fb = self._fallback_repositories
900
1394
        other_fb = other_repo._fallback_repositories
901
1395
        if len(my_fb) != len(other_fb):
930
1424
        """See Repository.gather_stats()."""
931
1425
        path = self.bzrdir._path_for_remote_call(self._client)
932
1426
        # revid can be None to indicate no revisions, not just NULL_REVISION
933
 
        if revid is None or revision.is_null(revid):
 
1427
        if revid is None or _mod_revision.is_null(revid):
934
1428
            fmt_revid = ''
935
1429
        else:
936
1430
            fmt_revid = revid
965
1459
 
966
1460
    def get_physical_lock_status(self):
967
1461
        """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()
 
1462
        path = self.bzrdir._path_for_remote_call(self._client)
 
1463
        try:
 
1464
            response = self._call('Repository.get_physical_lock_status', path)
 
1465
        except errors.UnknownSmartMethod:
 
1466
            self._ensure_real()
 
1467
            return self._real_repository.get_physical_lock_status()
 
1468
        if response[0] not in ('yes', 'no'):
 
1469
            raise errors.UnexpectedSmartServerResponse(response)
 
1470
        return (response[0] == 'yes')
971
1471
 
972
1472
    def is_in_write_group(self):
973
1473
        """Return True if there is an open write group.
974
1474
 
975
1475
        write groups are only applicable locally for the smart server..
976
1476
        """
 
1477
        if self._write_group_tokens is not None:
 
1478
            return True
977
1479
        if self._real_repository:
978
1480
            return self._real_repository.is_in_write_group()
979
1481
 
997
1499
        pass
998
1500
 
999
1501
    def lock_read(self):
 
1502
        """Lock the repository for read operations.
 
1503
 
 
1504
        :return: A bzrlib.lock.LogicalLockResult.
 
1505
        """
1000
1506
        # wrong eventually - want a local lock cache context
1001
1507
        if not self._lock_mode:
1002
1508
            self._note_lock('r')
1009
1515
                repo.lock_read()
1010
1516
        else:
1011
1517
            self._lock_count += 1
 
1518
        return lock.LogicalLockResult(self.unlock)
1012
1519
 
1013
1520
    def _remote_lock_write(self, token):
1014
1521
        path = self.bzrdir._path_for_remote_call(self._client)
1054
1561
            raise errors.ReadOnlyError(self)
1055
1562
        else:
1056
1563
            self._lock_count += 1
1057
 
        return self._lock_token or None
 
1564
        return RepositoryWriteLockResult(self.unlock, self._lock_token or None)
1058
1565
 
1059
1566
    def leave_lock_in_place(self):
1060
1567
        if not self._lock_token:
1109
1616
            self._real_repository.lock_write(self._lock_token)
1110
1617
        elif self._lock_mode == 'r':
1111
1618
            self._real_repository.lock_read()
 
1619
        if self._write_group_tokens is not None:
 
1620
            # if we are already in a write group, resume it
 
1621
            self._real_repository.resume_write_group(self._write_group_tokens)
 
1622
            self._write_group_tokens = None
1112
1623
 
1113
1624
    def start_write_group(self):
1114
1625
        """Start a write group on the decorated repository.
1118
1629
        for older plugins that don't use e.g. the CommitBuilder
1119
1630
        facility.
1120
1631
        """
1121
 
        self._ensure_real()
1122
 
        return self._real_repository.start_write_group()
 
1632
        if self._real_repository:
 
1633
            self._ensure_real()
 
1634
            return self._real_repository.start_write_group()
 
1635
        if not self.is_write_locked():
 
1636
            raise errors.NotWriteLocked(self)
 
1637
        if self._write_group_tokens is not None:
 
1638
            raise errors.BzrError('already in a write group')
 
1639
        path = self.bzrdir._path_for_remote_call(self._client)
 
1640
        try:
 
1641
            response = self._call('Repository.start_write_group', path,
 
1642
                self._lock_token)
 
1643
        except (errors.UnknownSmartMethod, errors.UnsuspendableWriteGroup):
 
1644
            self._ensure_real()
 
1645
            return self._real_repository.start_write_group()
 
1646
        if response[0] != 'ok':
 
1647
            raise errors.UnexpectedSmartServerResponse(response)
 
1648
        self._write_group_tokens = response[1]
1123
1649
 
1124
1650
    def _unlock(self, token):
1125
1651
        path = self.bzrdir._path_for_remote_call(self._client)
1152
1678
            # This is just to let the _real_repository stay up to date.
1153
1679
            if self._real_repository is not None:
1154
1680
                self._real_repository.unlock()
 
1681
            elif self._write_group_tokens is not None:
 
1682
                self.abort_write_group()
1155
1683
        finally:
1156
1684
            # The rpc-level lock should be released even if there was a
1157
1685
            # problem releasing the vfs-based lock.
1169
1697
 
1170
1698
    def break_lock(self):
1171
1699
        # should hand off to the network
1172
 
        self._ensure_real()
1173
 
        return self._real_repository.break_lock()
 
1700
        path = self.bzrdir._path_for_remote_call(self._client)
 
1701
        try:
 
1702
            response = self._call("Repository.break_lock", path)
 
1703
        except errors.UnknownSmartMethod:
 
1704
            self._ensure_real()
 
1705
            return self._real_repository.break_lock()
 
1706
        if response != ('ok',):
 
1707
            raise errors.UnexpectedSmartServerResponse(response)
1174
1708
 
1175
1709
    def _get_tarball(self, compression):
1176
1710
        """Return a TemporaryFile containing a repository tarball.
1194
1728
            return t
1195
1729
        raise errors.UnexpectedSmartServerResponse(response)
1196
1730
 
 
1731
    @needs_read_lock
1197
1732
    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)
 
1733
        """Create a descendent repository for new development.
 
1734
 
 
1735
        Unlike clone, this does not copy the settings of the repository.
 
1736
        """
 
1737
        dest_repo = self._create_sprouting_repo(to_bzrdir, shared=False)
1202
1738
        dest_repo.fetch(self, revision_id=revision_id)
1203
1739
        return dest_repo
1204
1740
 
 
1741
    def _create_sprouting_repo(self, a_bzrdir, shared):
 
1742
        if not isinstance(a_bzrdir._format, self.bzrdir._format.__class__):
 
1743
            # use target default format.
 
1744
            dest_repo = a_bzrdir.create_repository()
 
1745
        else:
 
1746
            # Most control formats need the repository to be specifically
 
1747
            # created, but on some old all-in-one formats it's not needed
 
1748
            try:
 
1749
                dest_repo = self._format.initialize(a_bzrdir, shared=shared)
 
1750
            except errors.UninitializableFormat:
 
1751
                dest_repo = a_bzrdir.open_repository()
 
1752
        return dest_repo
 
1753
 
1205
1754
    ### These methods are just thin shims to the VFS object for now.
1206
1755
 
 
1756
    @needs_read_lock
1207
1757
    def revision_tree(self, revision_id):
1208
 
        self._ensure_real()
1209
 
        return self._real_repository.revision_tree(revision_id)
 
1758
        revision_id = _mod_revision.ensure_null(revision_id)
 
1759
        if revision_id == _mod_revision.NULL_REVISION:
 
1760
            return InventoryRevisionTree(self,
 
1761
                Inventory(root_id=None), _mod_revision.NULL_REVISION)
 
1762
        else:
 
1763
            return list(self.revision_trees([revision_id]))[0]
1210
1764
 
1211
1765
    def get_serializer_format(self):
1212
 
        self._ensure_real()
1213
 
        return self._real_repository.get_serializer_format()
 
1766
        path = self.bzrdir._path_for_remote_call(self._client)
 
1767
        try:
 
1768
            response = self._call('VersionedFileRepository.get_serializer_format',
 
1769
                path)
 
1770
        except errors.UnknownSmartMethod:
 
1771
            self._ensure_real()
 
1772
            return self._real_repository.get_serializer_format()
 
1773
        if response[0] != 'ok':
 
1774
            raise errors.UnexpectedSmartServerResponse(response)
 
1775
        return response[1]
1214
1776
 
1215
1777
    def get_commit_builder(self, branch, parents, config, timestamp=None,
1216
1778
                           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
 
1779
                           revision_id=None, lossy=False):
 
1780
        """Obtain a CommitBuilder for this repository.
 
1781
 
 
1782
        :param branch: Branch to commit to.
 
1783
        :param parents: Revision ids of the parents of the new revision.
 
1784
        :param config: Configuration to use.
 
1785
        :param timestamp: Optional timestamp recorded for commit.
 
1786
        :param timezone: Optional timezone for timestamp.
 
1787
        :param committer: Optional committer to set for commit.
 
1788
        :param revprops: Optional dictionary of revision properties.
 
1789
        :param revision_id: Optional revision id.
 
1790
        :param lossy: Whether to discard data that can not be natively
 
1791
            represented, when pushing to a foreign VCS
 
1792
        """
 
1793
        if self._fallback_repositories and not self._format.supports_chks:
 
1794
            raise errors.BzrError("Cannot commit directly to a stacked branch"
 
1795
                " in pre-2a formats. See "
 
1796
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
 
1797
        if self._format.rich_root_data:
 
1798
            commit_builder_kls = vf_repository.VersionedFileRootCommitBuilder
 
1799
        else:
 
1800
            commit_builder_kls = vf_repository.VersionedFileCommitBuilder
 
1801
        result = commit_builder_kls(self, parents, config,
 
1802
            timestamp, timezone, committer, revprops, revision_id,
 
1803
            lossy)
 
1804
        self.start_write_group()
 
1805
        return result
1226
1806
 
1227
1807
    def add_fallback_repository(self, repository):
1228
1808
        """Add a repository to use for looking up data not held locally.
1235
1815
        # We need to accumulate additional repositories here, to pass them in
1236
1816
        # on various RPC's.
1237
1817
        #
 
1818
        # Make the check before we lock: this raises an exception.
 
1819
        self._check_fallback_repository(repository)
1238
1820
        if self.is_locked():
1239
1821
            # We will call fallback.unlock() when we transition to the unlocked
1240
1822
            # state, so always add a lock here. If a caller passes us a locked
1241
1823
            # repository, they are responsible for unlocking it later.
1242
1824
            repository.lock_read()
1243
 
        self._check_fallback_repository(repository)
1244
1825
        self._fallback_repositories.append(repository)
1245
1826
        # If self._real_repository was parameterised already (e.g. because a
1246
1827
        # _real_branch had its get_stacked_on_url method called), then the
1272
1853
            delta, new_revision_id, parents, basis_inv=basis_inv,
1273
1854
            propagate_caches=propagate_caches)
1274
1855
 
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)
 
1856
    def add_revision(self, revision_id, rev, inv=None):
 
1857
        _mod_revision.check_not_reserved_id(revision_id)
 
1858
        key = (revision_id,)
 
1859
        # check inventory present
 
1860
        if not self.inventories.get_parent_map([key]):
 
1861
            if inv is None:
 
1862
                raise errors.WeaveRevisionNotPresent(revision_id,
 
1863
                                                     self.inventories)
 
1864
            else:
 
1865
                # yes, this is not suitable for adding with ghosts.
 
1866
                rev.inventory_sha1 = self.add_inventory(revision_id, inv,
 
1867
                                                        rev.parent_ids)
 
1868
        else:
 
1869
            rev.inventory_sha1 = self.inventories.get_sha1s([key])[key]
 
1870
        self._add_revision(rev)
 
1871
 
 
1872
    def _add_revision(self, rev):
 
1873
        if self._real_repository is not None:
 
1874
            return self._real_repository._add_revision(rev)
 
1875
        text = self._serializer.write_revision_to_string(rev)
 
1876
        key = (rev.revision_id,)
 
1877
        parents = tuple((parent,) for parent in rev.parent_ids)
 
1878
        self._write_group_tokens, missing_keys = self._get_sink().insert_stream(
 
1879
            [('revisions', [FulltextContentFactory(key, parents, None, text)])],
 
1880
            self._format, self._write_group_tokens)
1279
1881
 
1280
1882
    @needs_read_lock
1281
1883
    def get_inventory(self, revision_id):
 
1884
        return list(self.iter_inventories([revision_id]))[0]
 
1885
 
 
1886
    def _iter_inventories_rpc(self, revision_ids, ordering):
 
1887
        if ordering is None:
 
1888
            ordering = 'unordered'
 
1889
        path = self.bzrdir._path_for_remote_call(self._client)
 
1890
        body = "\n".join(revision_ids)
 
1891
        response_tuple, response_handler = (
 
1892
            self._call_with_body_bytes_expecting_body(
 
1893
                "VersionedFileRepository.get_inventories",
 
1894
                (path, ordering), body))
 
1895
        if response_tuple[0] != "ok":
 
1896
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
1897
        deserializer = inventory_delta.InventoryDeltaDeserializer()
 
1898
        byte_stream = response_handler.read_streamed_body()
 
1899
        decoded = smart_repo._byte_stream_to_stream(byte_stream)
 
1900
        if decoded is None:
 
1901
            # no results whatsoever
 
1902
            return
 
1903
        src_format, stream = decoded
 
1904
        if src_format.network_name() != self._format.network_name():
 
1905
            raise AssertionError(
 
1906
                "Mismatched RemoteRepository and stream src %r, %r" % (
 
1907
                src_format.network_name(), self._format.network_name()))
 
1908
        # ignore the src format, it's not really relevant
 
1909
        prev_inv = Inventory(root_id=None,
 
1910
            revision_id=_mod_revision.NULL_REVISION)
 
1911
        # there should be just one substream, with inventory deltas
 
1912
        substream_kind, substream = stream.next()
 
1913
        if substream_kind != "inventory-deltas":
 
1914
            raise AssertionError(
 
1915
                 "Unexpected stream %r received" % substream_kind)
 
1916
        for record in substream:
 
1917
            (parent_id, new_id, versioned_root, tree_references, invdelta) = (
 
1918
                deserializer.parse_text_bytes(record.get_bytes_as("fulltext")))
 
1919
            if parent_id != prev_inv.revision_id:
 
1920
                raise AssertionError("invalid base %r != %r" % (parent_id,
 
1921
                    prev_inv.revision_id))
 
1922
            inv = prev_inv.create_by_apply_delta(invdelta, new_id)
 
1923
            yield inv, inv.revision_id
 
1924
            prev_inv = inv
 
1925
 
 
1926
    def _iter_inventories_vfs(self, revision_ids, ordering=None):
1282
1927
        self._ensure_real()
1283
 
        return self._real_repository.get_inventory(revision_id)
 
1928
        return self._real_repository._iter_inventories(revision_ids, ordering)
1284
1929
 
1285
1930
    def iter_inventories(self, revision_ids, ordering=None):
1286
 
        self._ensure_real()
1287
 
        return self._real_repository.iter_inventories(revision_ids, ordering)
 
1931
        """Get many inventories by revision_ids.
 
1932
 
 
1933
        This will buffer some or all of the texts used in constructing the
 
1934
        inventories in memory, but will only parse a single inventory at a
 
1935
        time.
 
1936
 
 
1937
        :param revision_ids: The expected revision ids of the inventories.
 
1938
        :param ordering: optional ordering, e.g. 'topological'.  If not
 
1939
            specified, the order of revision_ids will be preserved (by
 
1940
            buffering if necessary).
 
1941
        :return: An iterator of inventories.
 
1942
        """
 
1943
        if ((None in revision_ids)
 
1944
            or (_mod_revision.NULL_REVISION in revision_ids)):
 
1945
            raise ValueError('cannot get null revision inventory')
 
1946
        for inv, revid in self._iter_inventories(revision_ids, ordering):
 
1947
            if inv is None:
 
1948
                raise errors.NoSuchRevision(self, revid)
 
1949
            yield inv
 
1950
 
 
1951
    def _iter_inventories(self, revision_ids, ordering=None):
 
1952
        if len(revision_ids) == 0:
 
1953
            return
 
1954
        missing = set(revision_ids)
 
1955
        if ordering is None:
 
1956
            order_as_requested = True
 
1957
            invs = {}
 
1958
            order = list(revision_ids)
 
1959
            order.reverse()
 
1960
            next_revid = order.pop()
 
1961
        else:
 
1962
            order_as_requested = False
 
1963
            if ordering != 'unordered' and self._fallback_repositories:
 
1964
                raise ValueError('unsupported ordering %r' % ordering)
 
1965
        iter_inv_fns = [self._iter_inventories_rpc] + [
 
1966
            fallback._iter_inventories for fallback in
 
1967
            self._fallback_repositories]
 
1968
        try:
 
1969
            for iter_inv in iter_inv_fns:
 
1970
                request = [revid for revid in revision_ids if revid in missing]
 
1971
                for inv, revid in iter_inv(request, ordering):
 
1972
                    if inv is None:
 
1973
                        continue
 
1974
                    missing.remove(inv.revision_id)
 
1975
                    if ordering != 'unordered':
 
1976
                        invs[revid] = inv
 
1977
                    else:
 
1978
                        yield inv, revid
 
1979
                if order_as_requested:
 
1980
                    # Yield as many results as we can while preserving order.
 
1981
                    while next_revid in invs:
 
1982
                        inv = invs.pop(next_revid)
 
1983
                        yield inv, inv.revision_id
 
1984
                        try:
 
1985
                            next_revid = order.pop()
 
1986
                        except IndexError:
 
1987
                            # We still want to fully consume the stream, just
 
1988
                            # in case it is not actually finished at this point
 
1989
                            next_revid = None
 
1990
                            break
 
1991
        except errors.UnknownSmartMethod:
 
1992
            for inv, revid in self._iter_inventories_vfs(revision_ids, ordering):
 
1993
                yield inv, revid
 
1994
            return
 
1995
        # Report missing
 
1996
        if order_as_requested:
 
1997
            if next_revid is not None:
 
1998
                yield None, next_revid
 
1999
            while order:
 
2000
                revid = order.pop()
 
2001
                yield invs.get(revid), revid
 
2002
        else:
 
2003
            while missing:
 
2004
                yield None, missing.pop()
1288
2005
 
1289
2006
    @needs_read_lock
1290
2007
    def get_revision(self, revision_id):
1291
 
        self._ensure_real()
1292
 
        return self._real_repository.get_revision(revision_id)
 
2008
        return self.get_revisions([revision_id])[0]
1293
2009
 
1294
2010
    def get_transaction(self):
1295
2011
        self._ensure_real()
1297
2013
 
1298
2014
    @needs_read_lock
1299
2015
    def clone(self, a_bzrdir, revision_id=None):
1300
 
        self._ensure_real()
1301
 
        return self._real_repository.clone(a_bzrdir, revision_id=revision_id)
 
2016
        dest_repo = self._create_sprouting_repo(
 
2017
            a_bzrdir, shared=self.is_shared())
 
2018
        self.copy_content_into(dest_repo, revision_id)
 
2019
        return dest_repo
1302
2020
 
1303
2021
    def make_working_trees(self):
1304
2022
        """See Repository.make_working_trees"""
1305
 
        self._ensure_real()
1306
 
        return self._real_repository.make_working_trees()
 
2023
        path = self.bzrdir._path_for_remote_call(self._client)
 
2024
        try:
 
2025
            response = self._call('Repository.make_working_trees', path)
 
2026
        except errors.UnknownSmartMethod:
 
2027
            self._ensure_real()
 
2028
            return self._real_repository.make_working_trees()
 
2029
        if response[0] not in ('yes', 'no'):
 
2030
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
2031
        return response[0] == 'yes'
1307
2032
 
1308
2033
    def refresh_data(self):
1309
 
        """Re-read any data needed to to synchronise with disk.
 
2034
        """Re-read any data needed to synchronise with disk.
1310
2035
 
1311
2036
        This method is intended to be called after another repository instance
1312
2037
        (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.
 
2038
        repository. On all repositories this will work outside of write groups.
 
2039
        Some repository formats (pack and newer for bzrlib native formats)
 
2040
        support refresh_data inside write groups. If called inside a write
 
2041
        group on a repository that does not support refreshing in a write group
 
2042
        IsInWriteGroupError will be raised.
1315
2043
        """
1316
 
        if self.is_in_write_group():
1317
 
            raise errors.InternalBzrError(
1318
 
                "May not refresh_data while in a write group.")
1319
2044
        if self._real_repository is not None:
1320
2045
            self._real_repository.refresh_data()
 
2046
        # Refresh the parents cache for this object
 
2047
        self._unstacked_provider.disable_cache()
 
2048
        self._unstacked_provider.enable_cache()
1321
2049
 
1322
2050
    def revision_ids_to_search_result(self, result_set):
1323
2051
        """Convert a set of revision ids to a graph SearchResult."""
1328
2056
        included_keys = result_set.intersection(result_parents)
1329
2057
        start_keys = result_set.difference(included_keys)
1330
2058
        exclude_keys = result_parents.difference(result_set)
1331
 
        result = graph.SearchResult(start_keys, exclude_keys,
 
2059
        result = vf_search.SearchResult(start_keys, exclude_keys,
1332
2060
            len(result_set), result_set)
1333
2061
        return result
1334
2062
 
1335
2063
    @needs_read_lock
1336
 
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
 
2064
    def search_missing_revision_ids(self, other,
 
2065
            revision_id=symbol_versioning.DEPRECATED_PARAMETER,
 
2066
            find_ghosts=True, revision_ids=None, if_present_ids=None,
 
2067
            limit=None):
1337
2068
        """Return the revision ids that other has that this does not.
1338
2069
 
1339
2070
        These are returned in topological order.
1340
2071
 
1341
2072
        revision_id: only return revision ids included by revision_id.
1342
2073
        """
1343
 
        return repository.InterRepository.get(
1344
 
            other, self).search_missing_revision_ids(revision_id, find_ghosts)
 
2074
        if symbol_versioning.deprecated_passed(revision_id):
 
2075
            symbol_versioning.warn(
 
2076
                'search_missing_revision_ids(revision_id=...) was '
 
2077
                'deprecated in 2.4.  Use revision_ids=[...] instead.',
 
2078
                DeprecationWarning, stacklevel=2)
 
2079
            if revision_ids is not None:
 
2080
                raise AssertionError(
 
2081
                    'revision_ids is mutually exclusive with revision_id')
 
2082
            if revision_id is not None:
 
2083
                revision_ids = [revision_id]
 
2084
        inter_repo = _mod_repository.InterRepository.get(other, self)
 
2085
        return inter_repo.search_missing_revision_ids(
 
2086
            find_ghosts=find_ghosts, revision_ids=revision_ids,
 
2087
            if_present_ids=if_present_ids, limit=limit)
1345
2088
 
1346
 
    def fetch(self, source, revision_id=None, pb=None, find_ghosts=False,
 
2089
    def fetch(self, source, revision_id=None, find_ghosts=False,
1347
2090
            fetch_spec=None):
1348
2091
        # No base implementation to use as RemoteRepository is not a subclass
1349
2092
        # of Repository; so this is a copy of Repository.fetch().
1360
2103
            # check that last_revision is in 'from' and then return a
1361
2104
            # no-operation.
1362
2105
            if (revision_id is not None and
1363
 
                not revision.is_null(revision_id)):
 
2106
                not _mod_revision.is_null(revision_id)):
1364
2107
                self.get_revision(revision_id)
1365
2108
            return 0, []
1366
2109
        # if there is no specific appropriate InterRepository, this will get
1367
2110
        # the InterRepository base class, which raises an
1368
2111
        # IncompatibleRepositories when asked to fetch.
1369
 
        inter = repository.InterRepository.get(source, self)
1370
 
        return inter.fetch(revision_id=revision_id, pb=pb,
 
2112
        inter = _mod_repository.InterRepository.get(source, self)
 
2113
        if (fetch_spec is not None and
 
2114
            not getattr(inter, "supports_fetch_spec", False)):
 
2115
            raise errors.UnsupportedOperation(
 
2116
                "fetch_spec not supported for %r" % inter)
 
2117
        return inter.fetch(revision_id=revision_id,
1371
2118
            find_ghosts=find_ghosts, fetch_spec=fetch_spec)
1372
2119
 
1373
2120
    def create_bundle(self, target, base, fileobj, format=None):
1375
2122
        self._real_repository.create_bundle(target, base, fileobj, format)
1376
2123
 
1377
2124
    @needs_read_lock
 
2125
    @symbol_versioning.deprecated_method(
 
2126
        symbol_versioning.deprecated_in((2, 4, 0)))
1378
2127
    def get_ancestry(self, revision_id, topo_sorted=True):
1379
2128
        self._ensure_real()
1380
2129
        return self._real_repository.get_ancestry(revision_id, topo_sorted)
1388
2137
        return self._real_repository._get_versioned_file_checker(
1389
2138
            revisions, revision_versions_cache)
1390
2139
 
 
2140
    def _iter_files_bytes_rpc(self, desired_files, absent):
 
2141
        path = self.bzrdir._path_for_remote_call(self._client)
 
2142
        lines = []
 
2143
        identifiers = []
 
2144
        for (file_id, revid, identifier) in desired_files:
 
2145
            lines.append("%s\0%s" % (
 
2146
                osutils.safe_file_id(file_id),
 
2147
                osutils.safe_revision_id(revid)))
 
2148
            identifiers.append(identifier)
 
2149
        (response_tuple, response_handler) = (
 
2150
            self._call_with_body_bytes_expecting_body(
 
2151
            "Repository.iter_files_bytes", (path, ), "\n".join(lines)))
 
2152
        if response_tuple != ('ok', ):
 
2153
            response_handler.cancel_read_body()
 
2154
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2155
        byte_stream = response_handler.read_streamed_body()
 
2156
        def decompress_stream(start, byte_stream, unused):
 
2157
            decompressor = zlib.decompressobj()
 
2158
            yield decompressor.decompress(start)
 
2159
            while decompressor.unused_data == "":
 
2160
                try:
 
2161
                    data = byte_stream.next()
 
2162
                except StopIteration:
 
2163
                    break
 
2164
                yield decompressor.decompress(data)
 
2165
            yield decompressor.flush()
 
2166
            unused.append(decompressor.unused_data)
 
2167
        unused = ""
 
2168
        while True:
 
2169
            while not "\n" in unused:
 
2170
                unused += byte_stream.next()
 
2171
            header, rest = unused.split("\n", 1)
 
2172
            args = header.split("\0")
 
2173
            if args[0] == "absent":
 
2174
                absent[identifiers[int(args[3])]] = (args[1], args[2])
 
2175
                unused = rest
 
2176
                continue
 
2177
            elif args[0] == "ok":
 
2178
                idx = int(args[1])
 
2179
            else:
 
2180
                raise errors.UnexpectedSmartServerResponse(args)
 
2181
            unused_chunks = []
 
2182
            yield (identifiers[idx],
 
2183
                decompress_stream(rest, byte_stream, unused_chunks))
 
2184
            unused = "".join(unused_chunks)
 
2185
 
1391
2186
    def iter_files_bytes(self, desired_files):
1392
2187
        """See Repository.iter_file_bytes.
1393
2188
        """
1394
 
        self._ensure_real()
1395
 
        return self._real_repository.iter_files_bytes(desired_files)
 
2189
        try:
 
2190
            absent = {}
 
2191
            for (identifier, bytes_iterator) in self._iter_files_bytes_rpc(
 
2192
                    desired_files, absent):
 
2193
                yield identifier, bytes_iterator
 
2194
            for fallback in self._fallback_repositories:
 
2195
                if not absent:
 
2196
                    break
 
2197
                desired_files = [(key[0], key[1], identifier) for
 
2198
                    (identifier, key) in absent.iteritems()]
 
2199
                for (identifier, bytes_iterator) in fallback.iter_files_bytes(desired_files):
 
2200
                    del absent[identifier]
 
2201
                    yield identifier, bytes_iterator
 
2202
            if absent:
 
2203
                # There may be more missing items, but raise an exception
 
2204
                # for just one.
 
2205
                missing_identifier = absent.keys()[0]
 
2206
                missing_key = absent[missing_identifier]
 
2207
                raise errors.RevisionNotPresent(revision_id=missing_key[1],
 
2208
                    file_id=missing_key[0])
 
2209
        except errors.UnknownSmartMethod:
 
2210
            self._ensure_real()
 
2211
            for (identifier, bytes_iterator) in (
 
2212
                self._real_repository.iter_files_bytes(desired_files)):
 
2213
                yield identifier, bytes_iterator
 
2214
 
 
2215
    def get_cached_parent_map(self, revision_ids):
 
2216
        """See bzrlib.CachingParentsProvider.get_cached_parent_map"""
 
2217
        return self._unstacked_provider.get_cached_parent_map(revision_ids)
1396
2218
 
1397
2219
    def get_parent_map(self, revision_ids):
1398
2220
        """See bzrlib.Graph.get_parent_map()."""
1457
2279
        if parents_map is None:
1458
2280
            # Repository is not locked, so there's no cache.
1459
2281
            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)
 
2282
        if _DEFAULT_SEARCH_DEPTH <= 0:
 
2283
            (start_set, stop_keys,
 
2284
             key_count) = vf_search.search_result_from_parent_map(
 
2285
                parents_map, self._unstacked_provider.missing_keys)
 
2286
        else:
 
2287
            (start_set, stop_keys,
 
2288
             key_count) = vf_search.limited_search_result_from_parent_map(
 
2289
                parents_map, self._unstacked_provider.missing_keys,
 
2290
                keys, depth=_DEFAULT_SEARCH_DEPTH)
1480
2291
        recipe = ('manual', start_set, stop_keys, key_count)
1481
2292
        body = self._serialise_search_recipe(recipe)
1482
2293
        path = self.bzrdir._path_for_remote_call(self._client)
1531
2342
 
1532
2343
    @needs_read_lock
1533
2344
    def get_signature_text(self, revision_id):
1534
 
        self._ensure_real()
1535
 
        return self._real_repository.get_signature_text(revision_id)
 
2345
        path = self.bzrdir._path_for_remote_call(self._client)
 
2346
        try:
 
2347
            response_tuple, response_handler = self._call_expecting_body(
 
2348
                'Repository.get_revision_signature_text', path, revision_id)
 
2349
        except errors.UnknownSmartMethod:
 
2350
            self._ensure_real()
 
2351
            return self._real_repository.get_signature_text(revision_id)
 
2352
        except errors.NoSuchRevision, err:
 
2353
            for fallback in self._fallback_repositories:
 
2354
                try:
 
2355
                    return fallback.get_signature_text(revision_id)
 
2356
                except errors.NoSuchRevision:
 
2357
                    pass
 
2358
            raise err
 
2359
        else:
 
2360
            if response_tuple[0] != 'ok':
 
2361
                raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2362
            return response_handler.read_body_bytes()
1536
2363
 
1537
2364
    @needs_read_lock
1538
2365
    def _get_inventory_xml(self, revision_id):
 
2366
        # This call is used by older working tree formats,
 
2367
        # which stored a serialized basis inventory.
1539
2368
        self._ensure_real()
1540
2369
        return self._real_repository._get_inventory_xml(revision_id)
1541
2370
 
 
2371
    @needs_write_lock
1542
2372
    def reconcile(self, other=None, thorough=False):
1543
 
        self._ensure_real()
1544
 
        return self._real_repository.reconcile(other=other, thorough=thorough)
 
2373
        from bzrlib.reconcile import RepoReconciler
 
2374
        path = self.bzrdir._path_for_remote_call(self._client)
 
2375
        try:
 
2376
            response, handler = self._call_expecting_body(
 
2377
                'Repository.reconcile', path, self._lock_token)
 
2378
        except (errors.UnknownSmartMethod, errors.TokenLockingNotSupported):
 
2379
            self._ensure_real()
 
2380
            return self._real_repository.reconcile(other=other, thorough=thorough)
 
2381
        if response != ('ok', ):
 
2382
            raise errors.UnexpectedSmartServerResponse(response)
 
2383
        body = handler.read_body_bytes()
 
2384
        result = RepoReconciler(self)
 
2385
        for line in body.split('\n'):
 
2386
            if not line:
 
2387
                continue
 
2388
            key, val_text = line.split(':')
 
2389
            if key == "garbage_inventories":
 
2390
                result.garbage_inventories = int(val_text)
 
2391
            elif key == "inconsistent_parents":
 
2392
                result.inconsistent_parents = int(val_text)
 
2393
            else:
 
2394
                mutter("unknown reconcile key %r" % key)
 
2395
        return result
1545
2396
 
1546
2397
    def all_revision_ids(self):
1547
 
        self._ensure_real()
1548
 
        return self._real_repository.all_revision_ids()
 
2398
        path = self.bzrdir._path_for_remote_call(self._client)
 
2399
        try:
 
2400
            response_tuple, response_handler = self._call_expecting_body(
 
2401
                "Repository.all_revision_ids", path)
 
2402
        except errors.UnknownSmartMethod:
 
2403
            self._ensure_real()
 
2404
            return self._real_repository.all_revision_ids()
 
2405
        if response_tuple != ("ok", ):
 
2406
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2407
        revids = set(response_handler.read_body_bytes().splitlines())
 
2408
        for fallback in self._fallback_repositories:
 
2409
            revids.update(set(fallback.all_revision_ids()))
 
2410
        return list(revids)
 
2411
 
 
2412
    def _filtered_revision_trees(self, revision_ids, file_ids):
 
2413
        """Return Tree for a revision on this branch with only some files.
 
2414
 
 
2415
        :param revision_ids: a sequence of revision-ids;
 
2416
          a revision-id may not be None or 'null:'
 
2417
        :param file_ids: if not None, the result is filtered
 
2418
          so that only those file-ids, their parents and their
 
2419
          children are included.
 
2420
        """
 
2421
        inventories = self.iter_inventories(revision_ids)
 
2422
        for inv in inventories:
 
2423
            # Should we introduce a FilteredRevisionTree class rather
 
2424
            # than pre-filter the inventory here?
 
2425
            filtered_inv = inv.filter(file_ids)
 
2426
            yield InventoryRevisionTree(self, filtered_inv, filtered_inv.revision_id)
1549
2427
 
1550
2428
    @needs_read_lock
1551
2429
    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)
 
2430
        medium = self._client._medium
 
2431
        if medium._is_remote_before((1, 2)):
 
2432
            self._ensure_real()
 
2433
            for delta in self._real_repository.get_deltas_for_revisions(
 
2434
                    revisions, specific_fileids):
 
2435
                yield delta
 
2436
            return
 
2437
        # Get the revision-ids of interest
 
2438
        required_trees = set()
 
2439
        for revision in revisions:
 
2440
            required_trees.add(revision.revision_id)
 
2441
            required_trees.update(revision.parent_ids[:1])
 
2442
 
 
2443
        # Get the matching filtered trees. Note that it's more
 
2444
        # efficient to pass filtered trees to changes_from() rather
 
2445
        # than doing the filtering afterwards. changes_from() could
 
2446
        # arguably do the filtering itself but it's path-based, not
 
2447
        # file-id based, so filtering before or afterwards is
 
2448
        # currently easier.
 
2449
        if specific_fileids is None:
 
2450
            trees = dict((t.get_revision_id(), t) for
 
2451
                t in self.revision_trees(required_trees))
 
2452
        else:
 
2453
            trees = dict((t.get_revision_id(), t) for
 
2454
                t in self._filtered_revision_trees(required_trees,
 
2455
                specific_fileids))
 
2456
 
 
2457
        # Calculate the deltas
 
2458
        for revision in revisions:
 
2459
            if not revision.parent_ids:
 
2460
                old_tree = self.revision_tree(_mod_revision.NULL_REVISION)
 
2461
            else:
 
2462
                old_tree = trees[revision.parent_ids[0]]
 
2463
            yield trees[revision.revision_id].changes_from(old_tree)
1555
2464
 
1556
2465
    @needs_read_lock
1557
2466
    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)
 
2467
        r = self.get_revision(revision_id)
 
2468
        return list(self.get_deltas_for_revisions([r],
 
2469
            specific_fileids=specific_fileids))[0]
1561
2470
 
1562
2471
    @needs_read_lock
1563
2472
    def revision_trees(self, revision_ids):
1564
 
        self._ensure_real()
1565
 
        return self._real_repository.revision_trees(revision_ids)
 
2473
        inventories = self.iter_inventories(revision_ids)
 
2474
        for inv in inventories:
 
2475
            yield InventoryRevisionTree(self, inv, inv.revision_id)
1566
2476
 
1567
2477
    @needs_read_lock
1568
2478
    def get_revision_reconcile(self, revision_id):
1576
2486
            callback_refs=callback_refs, check_repo=check_repo)
1577
2487
 
1578
2488
    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)
 
2489
        """Make a complete copy of the content in self into destination.
 
2490
 
 
2491
        This is a destructive operation! Do not use it on existing
 
2492
        repositories.
 
2493
        """
 
2494
        interrepo = _mod_repository.InterRepository.get(self, destination)
 
2495
        return interrepo.copy_content(revision_id)
1582
2496
 
1583
2497
    def _copy_repository_tarball(self, to_bzrdir, revision_id=None):
1584
2498
        # get a tarball of the remote repository, and copy from that into the
1585
2499
        # destination
1586
 
        from bzrlib import osutils
1587
2500
        import tarfile
1588
2501
        # TODO: Maybe a progress bar while streaming the tarball?
1589
 
        note("Copying repository content as tarball...")
 
2502
        note(gettext("Copying repository content as tarball..."))
1590
2503
        tar_file = self._get_tarball('bz2')
1591
2504
        if tar_file is None:
1592
2505
            return None
1597
2510
            tmpdir = osutils.mkdtemp()
1598
2511
            try:
1599
2512
                _extract_tar(tar, tmpdir)
1600
 
                tmp_bzrdir = BzrDir.open(tmpdir)
 
2513
                tmp_bzrdir = _mod_bzrdir.BzrDir.open(tmpdir)
1601
2514
                tmp_repo = tmp_bzrdir.open_repository()
1602
2515
                tmp_repo.copy_content_into(destination, revision_id)
1603
2516
            finally:
1621
2534
    @needs_write_lock
1622
2535
    def pack(self, hint=None, clean_obsolete_packs=False):
1623
2536
        """Compress the data within the repository.
1624
 
 
1625
 
        This is not currently implemented within the smart server.
1626
2537
        """
1627
 
        self._ensure_real()
1628
 
        return self._real_repository.pack(hint=hint, clean_obsolete_packs=clean_obsolete_packs)
 
2538
        if hint is None:
 
2539
            body = ""
 
2540
        else:
 
2541
            body = "".join([l+"\n" for l in hint])
 
2542
        path = self.bzrdir._path_for_remote_call(self._client)
 
2543
        try:
 
2544
            response, handler = self._call_with_body_bytes_expecting_body(
 
2545
                'Repository.pack', (path, self._lock_token,
 
2546
                    str(clean_obsolete_packs)), body)
 
2547
        except errors.UnknownSmartMethod:
 
2548
            self._ensure_real()
 
2549
            return self._real_repository.pack(hint=hint,
 
2550
                clean_obsolete_packs=clean_obsolete_packs)
 
2551
        handler.cancel_read_body()
 
2552
        if response != ('ok', ):
 
2553
            raise errors.UnexpectedSmartServerResponse(response)
1629
2554
 
1630
2555
    @property
1631
2556
    def revisions(self):
1632
2557
        """Decorate the real repository for now.
1633
2558
 
1634
 
        In the short term this should become a real object to intercept graph
1635
 
        lookups.
1636
 
 
1637
2559
        In the long term a full blown network facility is needed.
1638
2560
        """
1639
2561
        self._ensure_real()
1667
2589
 
1668
2590
    @needs_write_lock
1669
2591
    def sign_revision(self, revision_id, gpg_strategy):
1670
 
        self._ensure_real()
1671
 
        return self._real_repository.sign_revision(revision_id, gpg_strategy)
 
2592
        testament = _mod_testament.Testament.from_revision(self, revision_id)
 
2593
        plaintext = testament.as_short_text()
 
2594
        self.store_revision_signature(gpg_strategy, plaintext, revision_id)
1672
2595
 
1673
2596
    @property
1674
2597
    def texts(self):
1680
2603
        self._ensure_real()
1681
2604
        return self._real_repository.texts
1682
2605
 
 
2606
    def _iter_revisions_rpc(self, revision_ids):
 
2607
        body = "\n".join(revision_ids)
 
2608
        path = self.bzrdir._path_for_remote_call(self._client)
 
2609
        response_tuple, response_handler = (
 
2610
            self._call_with_body_bytes_expecting_body(
 
2611
            "Repository.iter_revisions", (path, ), body))
 
2612
        if response_tuple[0] != "ok":
 
2613
            raise errors.UnexpectedSmartServerResponse(response_tuple)
 
2614
        serializer_format = response_tuple[1]
 
2615
        serializer = serializer_format_registry.get(serializer_format)
 
2616
        byte_stream = response_handler.read_streamed_body()
 
2617
        decompressor = zlib.decompressobj()
 
2618
        chunks = []
 
2619
        for bytes in byte_stream:
 
2620
            chunks.append(decompressor.decompress(bytes))
 
2621
            if decompressor.unused_data != "":
 
2622
                chunks.append(decompressor.flush())
 
2623
                yield serializer.read_revision_from_string("".join(chunks))
 
2624
                unused = decompressor.unused_data
 
2625
                decompressor = zlib.decompressobj()
 
2626
                chunks = [decompressor.decompress(unused)]
 
2627
        chunks.append(decompressor.flush())
 
2628
        text = "".join(chunks)
 
2629
        if text != "":
 
2630
            yield serializer.read_revision_from_string("".join(chunks))
 
2631
 
1683
2632
    @needs_read_lock
1684
2633
    def get_revisions(self, revision_ids):
1685
 
        self._ensure_real()
1686
 
        return self._real_repository.get_revisions(revision_ids)
 
2634
        if revision_ids is None:
 
2635
            revision_ids = self.all_revision_ids()
 
2636
        else:
 
2637
            for rev_id in revision_ids:
 
2638
                if not rev_id or not isinstance(rev_id, basestring):
 
2639
                    raise errors.InvalidRevisionId(
 
2640
                        revision_id=rev_id, branch=self)
 
2641
        try:
 
2642
            missing = set(revision_ids)
 
2643
            revs = {}
 
2644
            for rev in self._iter_revisions_rpc(revision_ids):
 
2645
                missing.remove(rev.revision_id)
 
2646
                revs[rev.revision_id] = rev
 
2647
        except errors.UnknownSmartMethod:
 
2648
            self._ensure_real()
 
2649
            return self._real_repository.get_revisions(revision_ids)
 
2650
        for fallback in self._fallback_repositories:
 
2651
            if not missing:
 
2652
                break
 
2653
            for revid in list(missing):
 
2654
                # XXX JRV 2011-11-20: It would be nice if there was a
 
2655
                # public method on Repository that could be used to query
 
2656
                # for revision objects *without* failing completely if one
 
2657
                # was missing. There is VersionedFileRepository._iter_revisions,
 
2658
                # but unfortunately that's private and not provided by
 
2659
                # all repository implementations.
 
2660
                try:
 
2661
                    revs[revid] = fallback.get_revision(revid)
 
2662
                except errors.NoSuchRevision:
 
2663
                    pass
 
2664
                else:
 
2665
                    missing.remove(revid)
 
2666
        if missing:
 
2667
            raise errors.NoSuchRevision(self, list(missing)[0])
 
2668
        return [revs[revid] for revid in revision_ids]
1687
2669
 
1688
2670
    def supports_rich_root(self):
1689
2671
        return self._format.rich_root_data
1690
2672
 
 
2673
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
1691
2674
    def iter_reverse_revision_history(self, revision_id):
1692
2675
        self._ensure_real()
1693
2676
        return self._real_repository.iter_reverse_revision_history(revision_id)
1696
2679
    def _serializer(self):
1697
2680
        return self._format._serializer
1698
2681
 
 
2682
    @needs_write_lock
1699
2683
    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)
 
2684
        signature = gpg_strategy.sign(plaintext)
 
2685
        self.add_signature_text(revision_id, signature)
1703
2686
 
1704
2687
    def add_signature_text(self, revision_id, signature):
1705
 
        self._ensure_real()
1706
 
        return self._real_repository.add_signature_text(revision_id, signature)
 
2688
        if self._real_repository:
 
2689
            # If there is a real repository the write group will
 
2690
            # be in the real repository as well, so use that:
 
2691
            self._ensure_real()
 
2692
            return self._real_repository.add_signature_text(
 
2693
                revision_id, signature)
 
2694
        path = self.bzrdir._path_for_remote_call(self._client)
 
2695
        response, handler = self._call_with_body_bytes_expecting_body(
 
2696
            'Repository.add_signature_text', (path, self._lock_token,
 
2697
                revision_id) + tuple(self._write_group_tokens), signature)
 
2698
        handler.cancel_read_body()
 
2699
        self.refresh_data()
 
2700
        if response[0] != 'ok':
 
2701
            raise errors.UnexpectedSmartServerResponse(response)
 
2702
        self._write_group_tokens = response[1:]
1707
2703
 
1708
2704
    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)
 
2705
        path = self.bzrdir._path_for_remote_call(self._client)
 
2706
        try:
 
2707
            response = self._call('Repository.has_signature_for_revision_id',
 
2708
                path, revision_id)
 
2709
        except errors.UnknownSmartMethod:
 
2710
            self._ensure_real()
 
2711
            return self._real_repository.has_signature_for_revision_id(
 
2712
                revision_id)
 
2713
        if response[0] not in ('yes', 'no'):
 
2714
            raise SmartProtocolError('unexpected response code %s' % (response,))
 
2715
        if response[0] == 'yes':
 
2716
            return True
 
2717
        for fallback in self._fallback_repositories:
 
2718
            if fallback.has_signature_for_revision_id(revision_id):
 
2719
                return True
 
2720
        return False
 
2721
 
 
2722
    @needs_read_lock
 
2723
    def verify_revision_signature(self, revision_id, gpg_strategy):
 
2724
        if not self.has_signature_for_revision_id(revision_id):
 
2725
            return gpg.SIGNATURE_NOT_SIGNED, None
 
2726
        signature = self.get_signature_text(revision_id)
 
2727
 
 
2728
        testament = _mod_testament.Testament.from_revision(self, revision_id)
 
2729
        plaintext = testament.as_short_text()
 
2730
 
 
2731
        return gpg_strategy.verify(signature, plaintext)
1711
2732
 
1712
2733
    def item_keys_introduced_by(self, revision_ids, _files_pb=None):
1713
2734
        self._ensure_real()
1714
2735
        return self._real_repository.item_keys_introduced_by(revision_ids,
1715
2736
            _files_pb=_files_pb)
1716
2737
 
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
2738
    def _find_inconsistent_revision_parents(self, revisions_iterator=None):
1723
2739
        self._ensure_real()
1724
2740
        return self._real_repository._find_inconsistent_revision_parents(
1732
2748
        providers = [self._unstacked_provider]
1733
2749
        if other is not None:
1734
2750
            providers.insert(0, other)
1735
 
        providers.extend(r._make_parents_provider() for r in
1736
 
                         self._fallback_repositories)
1737
 
        return graph.StackedParentsProvider(providers)
 
2751
        return graph.StackedParentsProvider(_LazyListJoin(
 
2752
            providers, self._fallback_repositories))
1738
2753
 
1739
2754
    def _serialise_search_recipe(self, recipe):
1740
2755
        """Serialise a graph search recipe.
1748
2763
        return '\n'.join((start_keys, stop_keys, count))
1749
2764
 
1750
2765
    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)]
 
2766
        parts = search_result.get_network_struct()
1757
2767
        return '\n'.join(parts)
1758
2768
 
1759
2769
    def autopack(self):
1769
2779
            raise errors.UnexpectedSmartServerResponse(response)
1770
2780
 
1771
2781
 
1772
 
class RemoteStreamSink(repository.StreamSink):
 
2782
class RemoteStreamSink(vf_repository.StreamSink):
1773
2783
 
1774
2784
    def _insert_real(self, stream, src_format, resume_tokens):
1775
2785
        self.target_repo._ensure_real()
1876
2886
        self._last_substream and self._last_stream so that the stream can be
1877
2887
        resumed by _resume_stream_with_vfs.
1878
2888
        """
1879
 
                    
 
2889
 
1880
2890
        stream_iter = iter(stream)
1881
2891
        for substream_kind, substream in stream_iter:
1882
2892
            if substream_kind == 'inventory-deltas':
1885
2895
                return
1886
2896
            else:
1887
2897
                yield substream_kind, substream
1888
 
            
1889
 
 
1890
 
class RemoteStreamSource(repository.StreamSource):
 
2898
 
 
2899
 
 
2900
class RemoteStreamSource(vf_repository.StreamSource):
1891
2901
    """Stream data from a remote server."""
1892
2902
 
1893
2903
    def get_stream(self, search):
1914
2924
 
1915
2925
    def _real_stream(self, repo, search):
1916
2926
        """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 
 
2927
 
 
2928
        This never called RemoteStreamSource.get_stream, and is a helper
 
2929
        for RemoteStreamSource._get_stream to allow getting a stream
1920
2930
        reliably whether fallback back because of old servers or trying
1921
2931
        to stream from a non-RemoteRepository (which the stacked support
1922
2932
        code will do).
1953
2963
        candidate_verbs = [
1954
2964
            ('Repository.get_stream_1.19', (1, 19)),
1955
2965
            ('Repository.get_stream', (1, 13))]
 
2966
 
1956
2967
        found_verb = False
1957
2968
        for verb, version in candidate_verbs:
1958
2969
            if medium._is_remote_before(version):
1962
2973
                    verb, args, search_bytes)
1963
2974
            except errors.UnknownSmartMethod:
1964
2975
                medium._remember_remote_is_before(version)
 
2976
            except errors.UnknownErrorFromSmartServer, e:
 
2977
                if isinstance(search, vf_search.EverythingResult):
 
2978
                    error_verb = e.error_from_smart_server.error_verb
 
2979
                    if error_verb == 'BadSearch':
 
2980
                        # Pre-2.4 servers don't support this sort of search.
 
2981
                        # XXX: perhaps falling back to VFS on BadSearch is a
 
2982
                        # good idea in general?  It might provide a little bit
 
2983
                        # of protection against client-side bugs.
 
2984
                        medium._remember_remote_is_before((2, 4))
 
2985
                        break
 
2986
                raise
1965
2987
            else:
1966
2988
                response_tuple, response_handler = response
1967
2989
                found_verb = True
1971
2993
        if response_tuple[0] != 'ok':
1972
2994
            raise errors.UnexpectedSmartServerResponse(response_tuple)
1973
2995
        byte_stream = response_handler.read_streamed_body()
1974
 
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream)
 
2996
        src_format, stream = smart_repo._byte_stream_to_stream(byte_stream,
 
2997
            self._record_counter)
1975
2998
        if src_format.network_name() != repo._format.network_name():
1976
2999
            raise AssertionError(
1977
3000
                "Mismatched RemoteRepository and stream src %r, %r" % (
2049
3072
 
2050
3073
    def _ensure_real(self):
2051
3074
        if self._custom_format is None:
2052
 
            self._custom_format = branch.network_format_registry.get(
2053
 
                self._network_name)
 
3075
            try:
 
3076
                self._custom_format = branch.network_format_registry.get(
 
3077
                    self._network_name)
 
3078
            except KeyError:
 
3079
                raise errors.UnknownFormatError(kind='branch',
 
3080
                    format=self._network_name)
2054
3081
 
2055
3082
    def get_format_description(self):
2056
3083
        self._ensure_real()
2063
3090
        return a_bzrdir.open_branch(name=name, 
2064
3091
            ignore_fallbacks=ignore_fallbacks)
2065
3092
 
2066
 
    def _vfs_initialize(self, a_bzrdir, name):
 
3093
    def _vfs_initialize(self, a_bzrdir, name, append_revisions_only):
2067
3094
        # Initialisation when using a local bzrdir object, or a non-vfs init
2068
3095
        # method is not available on the server.
2069
3096
        # self._custom_format is always set - the start of initialize ensures
2071
3098
        if isinstance(a_bzrdir, RemoteBzrDir):
2072
3099
            a_bzrdir._ensure_real()
2073
3100
            result = self._custom_format.initialize(a_bzrdir._real_bzrdir,
2074
 
                name)
 
3101
                name, append_revisions_only=append_revisions_only)
2075
3102
        else:
2076
3103
            # We assume the bzrdir is parameterised; it may not be.
2077
 
            result = self._custom_format.initialize(a_bzrdir, name)
 
3104
            result = self._custom_format.initialize(a_bzrdir, name,
 
3105
                append_revisions_only=append_revisions_only)
2078
3106
        if (isinstance(a_bzrdir, RemoteBzrDir) and
2079
3107
            not isinstance(result, RemoteBranch)):
2080
3108
            result = RemoteBranch(a_bzrdir, a_bzrdir.find_repository(), result,
2081
3109
                                  name=name)
2082
3110
        return result
2083
3111
 
2084
 
    def initialize(self, a_bzrdir, name=None):
 
3112
    def initialize(self, a_bzrdir, name=None, repository=None,
 
3113
                   append_revisions_only=None):
 
3114
        if name is None:
 
3115
            name = a_bzrdir._get_selected_branch()
2085
3116
        # 1) get the network name to use.
2086
3117
        if self._custom_format:
2087
3118
            network_name = self._custom_format.network_name()
2088
3119
        else:
2089
3120
            # Select the current bzrlib default and ask for that.
2090
 
            reference_bzrdir_format = bzrdir.format_registry.get('default')()
 
3121
            reference_bzrdir_format = _mod_bzrdir.format_registry.get('default')()
2091
3122
            reference_format = reference_bzrdir_format.get_branch_format()
2092
3123
            self._custom_format = reference_format
2093
3124
            network_name = reference_format.network_name()
2094
3125
        # Being asked to create on a non RemoteBzrDir:
2095
3126
        if not isinstance(a_bzrdir, RemoteBzrDir):
2096
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
3127
            return self._vfs_initialize(a_bzrdir, name=name,
 
3128
                append_revisions_only=append_revisions_only)
2097
3129
        medium = a_bzrdir._client._medium
2098
3130
        if medium._is_remote_before((1, 13)):
2099
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
3131
            return self._vfs_initialize(a_bzrdir, name=name,
 
3132
                append_revisions_only=append_revisions_only)
2100
3133
        # Creating on a remote bzr dir.
2101
3134
        # 2) try direct creation via RPC
2102
3135
        path = a_bzrdir._path_for_remote_call(a_bzrdir._client)
2103
 
        if name is not None:
 
3136
        if name != "":
2104
3137
            # XXX JRV20100304: Support creating colocated branches
2105
3138
            raise errors.NoColocatedBranchSupport(self)
2106
3139
        verb = 'BzrDir.create_branch'
2109
3142
        except errors.UnknownSmartMethod:
2110
3143
            # Fallback - use vfs methods
2111
3144
            medium._remember_remote_is_before((1, 13))
2112
 
            return self._vfs_initialize(a_bzrdir, name=name)
 
3145
            return self._vfs_initialize(a_bzrdir, name=name,
 
3146
                    append_revisions_only=append_revisions_only)
2113
3147
        if response[0] != 'ok':
2114
3148
            raise errors.UnexpectedSmartServerResponse(response)
2115
3149
        # Turn the response into a RemoteRepository object.
2116
3150
        format = RemoteBranchFormat(network_name=response[1])
2117
3151
        repo_format = response_tuple_to_repo_format(response[3:])
2118
 
        if response[2] == '':
2119
 
            repo_bzrdir = a_bzrdir
 
3152
        repo_path = response[2]
 
3153
        if repository is not None:
 
3154
            remote_repo_url = urlutils.join(a_bzrdir.user_url, repo_path)
 
3155
            url_diff = urlutils.relative_url(repository.user_url,
 
3156
                    remote_repo_url)
 
3157
            if url_diff != '.':
 
3158
                raise AssertionError(
 
3159
                    'repository.user_url %r does not match URL from server '
 
3160
                    'response (%r + %r)'
 
3161
                    % (repository.user_url, a_bzrdir.user_url, repo_path))
 
3162
            remote_repo = repository
2120
3163
        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)
 
3164
            if repo_path == '':
 
3165
                repo_bzrdir = a_bzrdir
 
3166
            else:
 
3167
                repo_bzrdir = RemoteBzrDir(
 
3168
                    a_bzrdir.root_transport.clone(repo_path), a_bzrdir._format,
 
3169
                    a_bzrdir._client)
 
3170
            remote_repo = RemoteRepository(repo_bzrdir, repo_format)
2125
3171
        remote_branch = RemoteBranch(a_bzrdir, remote_repo,
2126
3172
            format=format, setup_stacking=False, name=name)
 
3173
        if append_revisions_only:
 
3174
            remote_branch.set_append_revisions_only(append_revisions_only)
2127
3175
        # XXX: We know this is a new branch, so it must have revno 0, revid
2128
3176
        # NULL_REVISION. Creating the branch locked would make this be unable
2129
3177
        # to be wrong; here its simply very unlikely to be wrong. RBC 20090225
2148
3196
        self._ensure_real()
2149
3197
        return self._custom_format.supports_set_append_revisions_only()
2150
3198
 
 
3199
    def _use_default_local_heads_to_fetch(self):
 
3200
        # If the branch format is a metadir format *and* its heads_to_fetch
 
3201
        # implementation is not overridden vs the base class, we can use the
 
3202
        # base class logic rather than use the heads_to_fetch RPC.  This is
 
3203
        # usually cheaper in terms of net round trips, as the last-revision and
 
3204
        # tags info fetched is cached and would be fetched anyway.
 
3205
        self._ensure_real()
 
3206
        if isinstance(self._custom_format, branch.BranchFormatMetadir):
 
3207
            branch_class = self._custom_format._branch_class()
 
3208
            heads_to_fetch_impl = branch_class.heads_to_fetch.im_func
 
3209
            if heads_to_fetch_impl is branch.Branch.heads_to_fetch.im_func:
 
3210
                return True
 
3211
        return False
 
3212
 
 
3213
 
 
3214
class RemoteBranchStore(_mod_config.IniFileStore):
 
3215
    """Branch store which attempts to use HPSS calls to retrieve branch store.
 
3216
 
 
3217
    Note that this is specific to bzr-based formats.
 
3218
    """
 
3219
 
 
3220
    def __init__(self, branch):
 
3221
        super(RemoteBranchStore, self).__init__()
 
3222
        self.branch = branch
 
3223
        self.id = "branch"
 
3224
        self._real_store = None
 
3225
 
 
3226
    def lock_write(self, token=None):
 
3227
        return self.branch.lock_write(token)
 
3228
 
 
3229
    def unlock(self):
 
3230
        return self.branch.unlock()
 
3231
 
 
3232
    @needs_write_lock
 
3233
    def save(self):
 
3234
        # We need to be able to override the undecorated implementation
 
3235
        self.save_without_locking()
 
3236
 
 
3237
    def save_without_locking(self):
 
3238
        super(RemoteBranchStore, self).save()
 
3239
 
 
3240
    def external_url(self):
 
3241
        return self.branch.user_url
 
3242
 
 
3243
    def _load_content(self):
 
3244
        path = self.branch._remote_path()
 
3245
        try:
 
3246
            response, handler = self.branch._call_expecting_body(
 
3247
                'Branch.get_config_file', path)
 
3248
        except errors.UnknownSmartMethod:
 
3249
            self._ensure_real()
 
3250
            return self._real_store._load_content()
 
3251
        if len(response) and response[0] != 'ok':
 
3252
            raise errors.UnexpectedSmartServerResponse(response)
 
3253
        return handler.read_body_bytes()
 
3254
 
 
3255
    def _save_content(self, content):
 
3256
        path = self.branch._remote_path()
 
3257
        try:
 
3258
            response, handler = self.branch._call_with_body_bytes_expecting_body(
 
3259
                'Branch.put_config_file', (path,
 
3260
                    self.branch._lock_token, self.branch._repo_lock_token),
 
3261
                content)
 
3262
        except errors.UnknownSmartMethod:
 
3263
            self._ensure_real()
 
3264
            return self._real_store._save_content(content)
 
3265
        handler.cancel_read_body()
 
3266
        if response != ('ok', ):
 
3267
            raise errors.UnexpectedSmartServerResponse(response)
 
3268
 
 
3269
    def _ensure_real(self):
 
3270
        self.branch._ensure_real()
 
3271
        if self._real_store is None:
 
3272
            self._real_store = _mod_config.BranchStore(self.branch)
 
3273
 
2151
3274
 
2152
3275
class RemoteBranch(branch.Branch, _RpcHelper, lock._RelockDebugMixin):
2153
3276
    """Branch stored on a server accessed by HPSS RPC.
2156
3279
    """
2157
3280
 
2158
3281
    def __init__(self, remote_bzrdir, remote_repository, real_branch=None,
2159
 
        _client=None, format=None, setup_stacking=True, name=None):
 
3282
        _client=None, format=None, setup_stacking=True, name=None,
 
3283
        possible_transports=None):
2160
3284
        """Create a RemoteBranch instance.
2161
3285
 
2162
3286
        :param real_branch: An optional local implementation of the branch
2227
3351
            hook(self)
2228
3352
        self._is_stacked = False
2229
3353
        if setup_stacking:
2230
 
            self._setup_stacking()
 
3354
            self._setup_stacking(possible_transports)
2231
3355
 
2232
 
    def _setup_stacking(self):
 
3356
    def _setup_stacking(self, possible_transports):
2233
3357
        # configure stacking into the remote repository, by reading it from
2234
3358
        # the vfs branch.
2235
3359
        try:
2238
3362
            errors.UnstackableRepositoryFormat), e:
2239
3363
            return
2240
3364
        self._is_stacked = True
2241
 
        self._activate_fallback_location(fallback_url)
 
3365
        if possible_transports is None:
 
3366
            possible_transports = []
 
3367
        else:
 
3368
            possible_transports = list(possible_transports)
 
3369
        possible_transports.append(self.bzrdir.root_transport)
 
3370
        self._activate_fallback_location(fallback_url,
 
3371
            possible_transports=possible_transports)
2242
3372
 
2243
3373
    def _get_config(self):
2244
3374
        return RemoteBranchConfig(self)
2245
3375
 
 
3376
    def _get_config_store(self):
 
3377
        return RemoteBranchStore(self)
 
3378
 
2246
3379
    def _get_real_transport(self):
2247
3380
        # if we try vfs access, return the real branch's vfs transport
2248
3381
        self._ensure_real()
2311
3444
                self.bzrdir, self._client)
2312
3445
        return self._control_files
2313
3446
 
2314
 
    def _get_checkout_format(self):
2315
 
        self._ensure_real()
2316
 
        return self._real_branch._get_checkout_format()
2317
 
 
2318
3447
    def get_physical_lock_status(self):
2319
3448
        """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()
 
3449
        try:
 
3450
            response = self._client.call('Branch.get_physical_lock_status',
 
3451
                self._remote_path())
 
3452
        except errors.UnknownSmartMethod:
 
3453
            self._ensure_real()
 
3454
            return self._real_branch.get_physical_lock_status()
 
3455
        if response[0] not in ('yes', 'no'):
 
3456
            raise errors.UnexpectedSmartServerResponse(response)
 
3457
        return (response[0] == 'yes')
2323
3458
 
2324
3459
    def get_stacked_on_url(self):
2325
3460
        """Get the URL this branch is stacked against.
2352
3487
            self._is_stacked = False
2353
3488
        else:
2354
3489
            self._is_stacked = True
2355
 
        
 
3490
 
2356
3491
    def _vfs_get_tags_bytes(self):
2357
3492
        self._ensure_real()
2358
3493
        return self._real_branch._get_tags_bytes()
2359
3494
 
 
3495
    @needs_read_lock
2360
3496
    def _get_tags_bytes(self):
 
3497
        if self._tags_bytes is None:
 
3498
            self._tags_bytes = self._get_tags_bytes_via_hpss()
 
3499
        return self._tags_bytes
 
3500
 
 
3501
    def _get_tags_bytes_via_hpss(self):
2361
3502
        medium = self._client._medium
2362
3503
        if medium._is_remote_before((1, 13)):
2363
3504
            return self._vfs_get_tags_bytes()
2373
3514
        return self._real_branch._set_tags_bytes(bytes)
2374
3515
 
2375
3516
    def _set_tags_bytes(self, bytes):
 
3517
        if self.is_locked():
 
3518
            self._tags_bytes = bytes
2376
3519
        medium = self._client._medium
2377
3520
        if medium._is_remote_before((1, 18)):
2378
3521
            self._vfs_set_tags_bytes(bytes)
2387
3530
            self._vfs_set_tags_bytes(bytes)
2388
3531
 
2389
3532
    def lock_read(self):
 
3533
        """Lock the branch for read operations.
 
3534
 
 
3535
        :return: A bzrlib.lock.LogicalLockResult.
 
3536
        """
2390
3537
        self.repository.lock_read()
2391
3538
        if not self._lock_mode:
2392
3539
            self._note_lock('r')
2396
3543
                self._real_branch.lock_read()
2397
3544
        else:
2398
3545
            self._lock_count += 1
 
3546
        return lock.LogicalLockResult(self.unlock)
2399
3547
 
2400
3548
    def _remote_lock_write(self, token):
2401
3549
        if token is None:
2402
3550
            branch_token = repo_token = ''
2403
3551
        else:
2404
3552
            branch_token = token
2405
 
            repo_token = self.repository.lock_write()
 
3553
            repo_token = self.repository.lock_write().repository_token
2406
3554
            self.repository.unlock()
2407
3555
        err_context = {'token': token}
2408
 
        response = self._call(
2409
 
            'Branch.lock_write', self._remote_path(), branch_token,
2410
 
            repo_token or '', **err_context)
 
3556
        try:
 
3557
            response = self._call(
 
3558
                'Branch.lock_write', self._remote_path(), branch_token,
 
3559
                repo_token or '', **err_context)
 
3560
        except errors.LockContention, e:
 
3561
            # The LockContention from the server doesn't have any
 
3562
            # information about the lock_url. We re-raise LockContention
 
3563
            # with valid lock_url.
 
3564
            raise errors.LockContention('(remote lock)',
 
3565
                self.repository.base.split('.bzr/')[0])
2411
3566
        if response[0] != 'ok':
2412
3567
            raise errors.UnexpectedSmartServerResponse(response)
2413
3568
        ok, branch_token, repo_token = response
2434
3589
            self._lock_mode = 'w'
2435
3590
            self._lock_count = 1
2436
3591
        elif self._lock_mode == 'r':
2437
 
            raise errors.ReadOnlyTransaction
 
3592
            raise errors.ReadOnlyError(self)
2438
3593
        else:
2439
3594
            if token is not None:
2440
3595
                # A token was given to lock_write, and we're relocking, so
2445
3600
            self._lock_count += 1
2446
3601
            # Re-lock the repository too.
2447
3602
            self.repository.lock_write(self._repo_lock_token)
2448
 
        return self._lock_token or None
 
3603
        return BranchWriteLockResult(self.unlock, self._lock_token or None)
2449
3604
 
2450
3605
    def _unlock(self, branch_token, repo_token):
2451
3606
        err_context = {'token': str((branch_token, repo_token))}
2489
3644
            self.repository.unlock()
2490
3645
 
2491
3646
    def break_lock(self):
2492
 
        self._ensure_real()
2493
 
        return self._real_branch.break_lock()
 
3647
        try:
 
3648
            response = self._call(
 
3649
                'Branch.break_lock', self._remote_path())
 
3650
        except errors.UnknownSmartMethod:
 
3651
            self._ensure_real()
 
3652
            return self._real_branch.break_lock()
 
3653
        if response != ('ok',):
 
3654
            raise errors.UnexpectedSmartServerResponse(response)
2494
3655
 
2495
3656
    def leave_lock_in_place(self):
2496
3657
        if not self._lock_token:
2520
3681
            missing_parent = parent_map[missing_parent]
2521
3682
        raise errors.RevisionNotPresent(missing_parent, self.repository)
2522
3683
 
2523
 
    def _last_revision_info(self):
 
3684
    def _read_last_revision_info(self):
2524
3685
        response = self._call('Branch.last_revision_info', self._remote_path())
2525
3686
        if response[0] != 'ok':
2526
3687
            raise SmartProtocolError('unexpected response code %s' % (response,))
2589
3750
            raise errors.UnexpectedSmartServerResponse(response)
2590
3751
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2591
3752
 
 
3753
    @symbol_versioning.deprecated_method(symbol_versioning.deprecated_in((2, 4, 0)))
2592
3754
    @needs_write_lock
2593
3755
    def set_revision_history(self, rev_history):
 
3756
        """See Branch.set_revision_history."""
 
3757
        self._set_revision_history(rev_history)
 
3758
 
 
3759
    @needs_write_lock
 
3760
    def _set_revision_history(self, rev_history):
2594
3761
        # Send just the tip revision of the history; the server will generate
2595
3762
        # the full history from that.  If the revision doesn't exist in this
2596
3763
        # branch, NoSuchRevision will be raised.
2654
3821
            _override_hook_target=self, **kwargs)
2655
3822
 
2656
3823
    @needs_read_lock
2657
 
    def push(self, target, overwrite=False, stop_revision=None):
 
3824
    def push(self, target, overwrite=False, stop_revision=None, lossy=False):
2658
3825
        self._ensure_real()
2659
3826
        return self._real_branch.push(
2660
 
            target, overwrite=overwrite, stop_revision=stop_revision,
 
3827
            target, overwrite=overwrite, stop_revision=stop_revision, lossy=lossy,
2661
3828
            _override_hook_source_branch=self)
2662
3829
 
2663
3830
    def is_locked(self):
2664
3831
        return self._lock_count >= 1
2665
3832
 
2666
3833
    @needs_read_lock
 
3834
    def revision_id_to_dotted_revno(self, revision_id):
 
3835
        """Given a revision id, return its dotted revno.
 
3836
 
 
3837
        :return: a tuple like (1,) or (400,1,3).
 
3838
        """
 
3839
        try:
 
3840
            response = self._call('Branch.revision_id_to_revno',
 
3841
                self._remote_path(), revision_id)
 
3842
        except errors.UnknownSmartMethod:
 
3843
            self._ensure_real()
 
3844
            return self._real_branch.revision_id_to_dotted_revno(revision_id)
 
3845
        if response[0] == 'ok':
 
3846
            return tuple([int(x) for x in response[1:]])
 
3847
        else:
 
3848
            raise errors.UnexpectedSmartServerResponse(response)
 
3849
 
 
3850
    @needs_read_lock
2667
3851
    def revision_id_to_revno(self, revision_id):
2668
 
        self._ensure_real()
2669
 
        return self._real_branch.revision_id_to_revno(revision_id)
 
3852
        """Given a revision id on the branch mainline, return its revno.
 
3853
 
 
3854
        :return: an integer
 
3855
        """
 
3856
        try:
 
3857
            response = self._call('Branch.revision_id_to_revno',
 
3858
                self._remote_path(), revision_id)
 
3859
        except errors.UnknownSmartMethod:
 
3860
            self._ensure_real()
 
3861
            return self._real_branch.revision_id_to_revno(revision_id)
 
3862
        if response[0] == 'ok':
 
3863
            if len(response) == 2:
 
3864
                return int(response[1])
 
3865
            raise NoSuchRevision(self, revision_id)
 
3866
        else:
 
3867
            raise errors.UnexpectedSmartServerResponse(response)
2670
3868
 
2671
3869
    @needs_write_lock
2672
3870
    def set_last_revision_info(self, revno, revision_id):
2673
3871
        # XXX: These should be returned by the set_last_revision_info verb
2674
3872
        old_revno, old_revid = self.last_revision_info()
2675
3873
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2676
 
        revision_id = ensure_null(revision_id)
 
3874
        if not revision_id or not isinstance(revision_id, basestring):
 
3875
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2677
3876
        try:
2678
3877
            response = self._call('Branch.set_last_revision_info',
2679
3878
                self._remote_path(), self._lock_token, self._repo_lock_token,
2708
3907
            except errors.UnknownSmartMethod:
2709
3908
                medium._remember_remote_is_before((1, 6))
2710
3909
        self._clear_cached_state_of_remote_branch_only()
2711
 
        self.set_revision_history(self._lefthand_history(revision_id,
 
3910
        self._set_revision_history(self._lefthand_history(revision_id,
2712
3911
            last_rev=last_rev,other_branch=other_branch))
2713
3912
 
2714
3913
    def set_push_location(self, location):
2715
3914
        self._ensure_real()
2716
3915
        return self._real_branch.set_push_location(location)
2717
3916
 
 
3917
    def heads_to_fetch(self):
 
3918
        if self._format._use_default_local_heads_to_fetch():
 
3919
            # We recognise this format, and its heads-to-fetch implementation
 
3920
            # is the default one (tip + tags).  In this case it's cheaper to
 
3921
            # just use the default implementation rather than a special RPC as
 
3922
            # the tip and tags data is cached.
 
3923
            return branch.Branch.heads_to_fetch(self)
 
3924
        medium = self._client._medium
 
3925
        if medium._is_remote_before((2, 4)):
 
3926
            return self._vfs_heads_to_fetch()
 
3927
        try:
 
3928
            return self._rpc_heads_to_fetch()
 
3929
        except errors.UnknownSmartMethod:
 
3930
            medium._remember_remote_is_before((2, 4))
 
3931
            return self._vfs_heads_to_fetch()
 
3932
 
 
3933
    def _rpc_heads_to_fetch(self):
 
3934
        response = self._call('Branch.heads_to_fetch', self._remote_path())
 
3935
        if len(response) != 2:
 
3936
            raise errors.UnexpectedSmartServerResponse(response)
 
3937
        must_fetch, if_present_fetch = response
 
3938
        return set(must_fetch), set(if_present_fetch)
 
3939
 
 
3940
    def _vfs_heads_to_fetch(self):
 
3941
        self._ensure_real()
 
3942
        return self._real_branch.heads_to_fetch()
 
3943
 
2718
3944
 
2719
3945
class RemoteConfig(object):
2720
3946
    """A Config that reads and writes from smart verbs.
2734
3960
        """
2735
3961
        try:
2736
3962
            configobj = self._get_configobj()
 
3963
            section_obj = None
2737
3964
            if section is None:
2738
3965
                section_obj = configobj
2739
3966
            else:
2740
3967
                try:
2741
3968
                    section_obj = configobj[section]
2742
3969
                except KeyError:
2743
 
                    return default
2744
 
            return section_obj.get(name, default)
 
3970
                    pass
 
3971
            if section_obj is None:
 
3972
                value = default
 
3973
            else:
 
3974
                value = section_obj.get(name, default)
2745
3975
        except errors.UnknownSmartMethod:
2746
 
            return self._vfs_get_option(name, section, default)
 
3976
            value = self._vfs_get_option(name, section, default)
 
3977
        for hook in _mod_config.OldConfigHooks['get']:
 
3978
            hook(self, name, value)
 
3979
        return value
2747
3980
 
2748
3981
    def _response_to_configobj(self, response):
2749
3982
        if len(response[0]) and response[0][0] != 'ok':
2750
3983
            raise errors.UnexpectedSmartServerResponse(response)
2751
3984
        lines = response[1].read_body_bytes().splitlines()
2752
 
        return config.ConfigObj(lines, encoding='utf-8')
 
3985
        conf = _mod_config.ConfigObj(lines, encoding='utf-8')
 
3986
        for hook in _mod_config.OldConfigHooks['load']:
 
3987
            hook(self)
 
3988
        return conf
2753
3989
 
2754
3990
 
2755
3991
class RemoteBranchConfig(RemoteConfig):
2774
4010
        medium = self._branch._client._medium
2775
4011
        if medium._is_remote_before((1, 14)):
2776
4012
            return self._vfs_set_option(value, name, section)
 
4013
        if isinstance(value, dict):
 
4014
            if medium._is_remote_before((2, 2)):
 
4015
                return self._vfs_set_option(value, name, section)
 
4016
            return self._set_config_option_dict(value, name, section)
 
4017
        else:
 
4018
            return self._set_config_option(value, name, section)
 
4019
 
 
4020
    def _set_config_option(self, value, name, section):
2777
4021
        try:
2778
4022
            path = self._branch._remote_path()
2779
4023
            response = self._branch._client.call('Branch.set_config_option',
2780
4024
                path, self._branch._lock_token, self._branch._repo_lock_token,
2781
4025
                value.encode('utf8'), name, section or '')
2782
4026
        except errors.UnknownSmartMethod:
 
4027
            medium = self._branch._client._medium
2783
4028
            medium._remember_remote_is_before((1, 14))
2784
4029
            return self._vfs_set_option(value, name, section)
2785
4030
        if response != ():
2786
4031
            raise errors.UnexpectedSmartServerResponse(response)
2787
4032
 
 
4033
    def _serialize_option_dict(self, option_dict):
 
4034
        utf8_dict = {}
 
4035
        for key, value in option_dict.items():
 
4036
            if isinstance(key, unicode):
 
4037
                key = key.encode('utf8')
 
4038
            if isinstance(value, unicode):
 
4039
                value = value.encode('utf8')
 
4040
            utf8_dict[key] = value
 
4041
        return bencode.bencode(utf8_dict)
 
4042
 
 
4043
    def _set_config_option_dict(self, value, name, section):
 
4044
        try:
 
4045
            path = self._branch._remote_path()
 
4046
            serialised_dict = self._serialize_option_dict(value)
 
4047
            response = self._branch._client.call(
 
4048
                'Branch.set_config_option_dict',
 
4049
                path, self._branch._lock_token, self._branch._repo_lock_token,
 
4050
                serialised_dict, name, section or '')
 
4051
        except errors.UnknownSmartMethod:
 
4052
            medium = self._branch._client._medium
 
4053
            medium._remember_remote_is_before((2, 2))
 
4054
            return self._vfs_set_option(value, name, section)
 
4055
        if response != ():
 
4056
            raise errors.UnexpectedSmartServerResponse(response)
 
4057
 
2788
4058
    def _real_object(self):
2789
4059
        self._branch._ensure_real()
2790
4060
        return self._branch._real_branch
2829
4099
        return self._bzrdir._real_bzrdir
2830
4100
 
2831
4101
 
2832
 
 
2833
4102
def _extract_tar(tar, to_dir):
2834
4103
    """Extract all the contents of a tarfile object.
2835
4104
 
2839
4108
        tar.extract(tarinfo, to_dir)
2840
4109
 
2841
4110
 
 
4111
error_translators = registry.Registry()
 
4112
no_context_error_translators = registry.Registry()
 
4113
 
 
4114
 
2842
4115
def _translate_error(err, **context):
2843
4116
    """Translate an ErrorFromSmartServer into a more useful error.
2844
4117
 
2873
4146
                    'Missing key %r in context %r', key_err.args[0], context)
2874
4147
                raise err
2875
4148
 
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'):
 
4149
    try:
 
4150
        translator = error_translators.get(err.error_verb)
 
4151
    except KeyError:
 
4152
        pass
 
4153
    else:
 
4154
        raise translator(err, find, get_path)
 
4155
    try:
 
4156
        translator = no_context_error_translators.get(err.error_verb)
 
4157
    except KeyError:
 
4158
        raise errors.UnknownErrorFromSmartServer(err)
 
4159
    else:
 
4160
        raise translator(err)
 
4161
 
 
4162
 
 
4163
error_translators.register('NoSuchRevision',
 
4164
    lambda err, find, get_path: NoSuchRevision(
 
4165
        find('branch'), err.error_args[0]))
 
4166
error_translators.register('nosuchrevision',
 
4167
    lambda err, find, get_path: NoSuchRevision(
 
4168
        find('repository'), err.error_args[0]))
 
4169
 
 
4170
def _translate_nobranch_error(err, find, get_path):
 
4171
    if len(err.error_args) >= 1:
 
4172
        extra = err.error_args[0]
 
4173
    else:
 
4174
        extra = None
 
4175
    return errors.NotBranchError(path=find('bzrdir').root_transport.base,
 
4176
        detail=extra)
 
4177
 
 
4178
error_translators.register('nobranch', _translate_nobranch_error)
 
4179
error_translators.register('norepository',
 
4180
    lambda err, find, get_path: errors.NoRepositoryPresent(
 
4181
        find('bzrdir')))
 
4182
error_translators.register('UnlockableTransport',
 
4183
    lambda err, find, get_path: errors.UnlockableTransport(
 
4184
        find('bzrdir').root_transport))
 
4185
error_translators.register('TokenMismatch',
 
4186
    lambda err, find, get_path: errors.TokenMismatch(
 
4187
        find('token'), '(remote token)'))
 
4188
error_translators.register('Diverged',
 
4189
    lambda err, find, get_path: errors.DivergedBranches(
 
4190
        find('branch'), find('other_branch')))
 
4191
error_translators.register('NotStacked',
 
4192
    lambda err, find, get_path: errors.NotStacked(branch=find('branch')))
 
4193
 
 
4194
def _translate_PermissionDenied(err, find, get_path):
 
4195
    path = get_path()
 
4196
    if len(err.error_args) >= 2:
 
4197
        extra = err.error_args[1]
 
4198
    else:
 
4199
        extra = None
 
4200
    return errors.PermissionDenied(path, extra=extra)
 
4201
 
 
4202
error_translators.register('PermissionDenied', _translate_PermissionDenied)
 
4203
error_translators.register('ReadError',
 
4204
    lambda err, find, get_path: errors.ReadError(get_path()))
 
4205
error_translators.register('NoSuchFile',
 
4206
    lambda err, find, get_path: errors.NoSuchFile(get_path()))
 
4207
error_translators.register('TokenLockingNotSupported',
 
4208
    lambda err, find, get_path: errors.TokenLockingNotSupported(
 
4209
        find('repository')))
 
4210
error_translators.register('UnsuspendableWriteGroup',
 
4211
    lambda err, find, get_path: errors.UnsuspendableWriteGroup(
 
4212
        repository=find('repository')))
 
4213
error_translators.register('UnresumableWriteGroup',
 
4214
    lambda err, find, get_path: errors.UnresumableWriteGroup(
 
4215
        repository=find('repository'), write_groups=err.error_args[0],
 
4216
        reason=err.error_args[1]))
 
4217
no_context_error_translators.register('IncompatibleRepositories',
 
4218
    lambda err: errors.IncompatibleRepositories(
 
4219
        err.error_args[0], err.error_args[1], err.error_args[2]))
 
4220
no_context_error_translators.register('LockContention',
 
4221
    lambda err: errors.LockContention('(remote lock)'))
 
4222
no_context_error_translators.register('LockFailed',
 
4223
    lambda err: errors.LockFailed(err.error_args[0], err.error_args[1]))
 
4224
no_context_error_translators.register('TipChangeRejected',
 
4225
    lambda err: errors.TipChangeRejected(err.error_args[0].decode('utf8')))
 
4226
no_context_error_translators.register('UnstackableBranchFormat',
 
4227
    lambda err: errors.UnstackableBranchFormat(*err.error_args))
 
4228
no_context_error_translators.register('UnstackableRepositoryFormat',
 
4229
    lambda err: errors.UnstackableRepositoryFormat(*err.error_args))
 
4230
no_context_error_translators.register('FileExists',
 
4231
    lambda err: errors.FileExists(err.error_args[0]))
 
4232
no_context_error_translators.register('DirectoryNotEmpty',
 
4233
    lambda err: errors.DirectoryNotEmpty(err.error_args[0]))
 
4234
 
 
4235
def _translate_short_readv_error(err):
 
4236
    args = err.error_args
 
4237
    return errors.ShortReadvError(args[0], int(args[1]), int(args[2]),
 
4238
        int(args[3]))
 
4239
 
 
4240
no_context_error_translators.register('ShortReadvError',
 
4241
    _translate_short_readv_error)
 
4242
 
 
4243
def _translate_unicode_error(err):
2932
4244
        encoding = str(err.error_args[0]) # encoding must always be a string
2933
4245
        val = err.error_args[1]
2934
4246
        start = int(err.error_args[2])
2942
4254
            raise UnicodeDecodeError(encoding, val, start, end, reason)
2943
4255
        elif err.error_verb == 'UnicodeEncodeError':
2944
4256
            raise UnicodeEncodeError(encoding, val, start, end, reason)
2945
 
    elif err.error_verb == 'ReadOnlyError':
2946
 
        raise errors.TransportNotPossible('readonly transport')
2947
 
    raise errors.UnknownErrorFromSmartServer(err)
 
4257
 
 
4258
no_context_error_translators.register('UnicodeEncodeError',
 
4259
    _translate_unicode_error)
 
4260
no_context_error_translators.register('UnicodeDecodeError',
 
4261
    _translate_unicode_error)
 
4262
no_context_error_translators.register('ReadOnlyError',
 
4263
    lambda err: errors.TransportNotPossible('readonly transport'))
 
4264
no_context_error_translators.register('MemoryError',
 
4265
    lambda err: errors.BzrError("remote server out of memory\n"
 
4266
        "Retry non-remotely, or contact the server admin for details."))
 
4267
no_context_error_translators.register('RevisionNotPresent',
 
4268
    lambda err: errors.RevisionNotPresent(err.error_args[0], err.error_args[1]))
 
4269
 
 
4270
no_context_error_translators.register('BzrCheckError',
 
4271
    lambda err: errors.BzrCheckError(msg=err.error_args[0]))
 
4272